docs/ResponseObjectApi.md in fastly-5.3.1 vs docs/ResponseObjectApi.md in fastly-6.0.0

- old
+ new

@@ -8,15 +8,56 @@ ## Methods | Method | HTTP request | Description | | ------ | ------------ | ----------- | +| [**create_response_object**](ResponseObjectApi.md#create_response_object) | **POST** /service/{service_id}/version/{version_id}/response_object | Create a Response object | | [**delete_response_object**](ResponseObjectApi.md#delete_response_object) | **DELETE** /service/{service_id}/version/{version_id}/response_object/{response_object_name} | Delete a Response Object | | [**get_response_object**](ResponseObjectApi.md#get_response_object) | **GET** /service/{service_id}/version/{version_id}/response_object/{response_object_name} | Get a Response object | | [**list_response_objects**](ResponseObjectApi.md#list_response_objects) | **GET** /service/{service_id}/version/{version_id}/response_object | List Response objects | +| [**update_response_object**](ResponseObjectApi.md#update_response_object) | **PUT** /service/{service_id}/version/{version_id}/response_object/{response_object_name} | Update a Response object | +## `create_response_object()` + +```ruby +create_response_object(opts): <ResponseObjectResponse> # Create a Response object +``` + +Creates a new Response Object. + +### Examples + +```ruby +api_instance = Fastly::ResponseObjectApi.new +opts = { + service_id: 'service_id_example', # String | Alphanumeric string identifying the service. + version_id: 56, # Integer | Integer identifying a service version. +} + +begin + # Create a Response object + result = api_instance.create_response_object(opts) + p result +rescue Fastly::ApiError => e + puts "Error when calling ResponseObjectApi->create_response_object: #{e}" +end +``` + +### Options + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **service_id** | **String** | Alphanumeric string identifying the service. | | +| **version_id** | **Integer** | Integer identifying a service version. | | + +### Return type + +[**ResponseObjectResponse**](ResponseObjectResponse.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to README]](../../README.md) ## `delete_response_object()` ```ruby delete_response_object(opts): <InlineResponse200> # Delete a Response Object ``` @@ -131,8 +172,49 @@ | **version_id** | **Integer** | Integer identifying a service version. | | ### Return type [**Array&lt;ResponseObjectResponse&gt;**](ResponseObjectResponse.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to README]](../../README.md) +## `update_response_object()` + +```ruby +update_response_object(opts): <ResponseObjectResponse> # Update a Response object +``` + +Updates the specified Response Object. + +### Examples + +```ruby +api_instance = Fastly::ResponseObjectApi.new +opts = { + service_id: 'service_id_example', # String | Alphanumeric string identifying the service. + version_id: 56, # Integer | Integer identifying a service version. + response_object_name: 'response_object_name_example', # String | Name for the request settings. +} + +begin + # Update a Response object + result = api_instance.update_response_object(opts) + p result +rescue Fastly::ApiError => e + puts "Error when calling ResponseObjectApi->update_response_object: #{e}" +end +``` + +### Options + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **service_id** | **String** | Alphanumeric string identifying the service. | | +| **version_id** | **Integer** | Integer identifying a service version. | | +| **response_object_name** | **String** | Name for the request settings. | | + +### Return type + +[**ResponseObjectResponse**](ResponseObjectResponse.md) [[Back to top]](#) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)