fastly 4.0.1.pre.alpha.0 → 4.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/docs/SettingsApi.md CHANGED
@@ -11,6 +11,7 @@ api_instance = Fastly::SettingsApi.new
11
11
  | Method | HTTP request | Description |
12
12
  | ------ | ------------ | ----------- |
13
13
  | [**get_service_settings**](SettingsApi.md#get_service_settings) | **GET** /service/{service_id}/version/{version_id}/settings | Get service settings |
14
+ | [**update_service_settings**](SettingsApi.md#update_service_settings) | **PUT** /service/{service_id}/version/{version_id}/settings | Update service settings |
14
15
 
15
16
 
16
17
  ## `get_service_settings()`
@@ -52,3 +53,50 @@ end
52
53
 
53
54
  [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
54
55
  [[Back to README]](../../README.md)
56
+ ## `update_service_settings()`
57
+
58
+ ```ruby
59
+ update_service_settings(opts): <SettingsResponse> # Update service settings
60
+ ```
61
+
62
+ Update the settings for a particular service and version. NOTE: If you override TTLs with custom VCL, any general.default_ttl value will not be honored and the expected behavior may change.
63
+
64
+ ### Examples
65
+
66
+ ```ruby
67
+ api_instance = Fastly::SettingsApi.new
68
+ opts = {
69
+ service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
70
+ version_id: 56, # Integer | Integer identifying a service version.
71
+ general_default_host: 'general_default_host_example', # String | The default host name for the version.
72
+ general_default_ttl: 56, # Integer | The default time-to-live (TTL) for the version.
73
+ general_stale_if_error: true, # Boolean | Enables serving a stale object if there is an error.
74
+ general_stale_if_error_ttl: 56, # Integer | The default time-to-live (TTL) for serving the stale object for the version.
75
+ }
76
+
77
+ begin
78
+ # Update service settings
79
+ result = api_instance.update_service_settings(opts)
80
+ p result
81
+ rescue Fastly::ApiError => e
82
+ puts "Error when calling SettingsApi->update_service_settings: #{e}"
83
+ end
84
+ ```
85
+
86
+ ### Options
87
+
88
+ | Name | Type | Description | Notes |
89
+ | ---- | ---- | ----------- | ----- |
90
+ | **service_id** | **String** | Alphanumeric string identifying the service. | |
91
+ | **version_id** | **Integer** | Integer identifying a service version. | |
92
+ | **general_default_host** | **String** | The default host name for the version. | [optional] |
93
+ | **general_default_ttl** | **Integer** | The default time-to-live (TTL) for the version. | [optional] |
94
+ | **general_stale_if_error** | **Boolean** | Enables serving a stale object if there is an error. | [optional][default to false] |
95
+ | **general_stale_if_error_ttl** | **Integer** | The default time-to-live (TTL) for serving the stale object for the version. | [optional][default to 43200] |
96
+
97
+ ### Return type
98
+
99
+ [**SettingsResponse**](SettingsResponse.md)
100
+
101
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
102
+ [[Back to README]](../../README.md)
data/docs/Store.md ADDED
@@ -0,0 +1,10 @@
1
+ # Fastly::Store
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | A human-readable name for the store. | [optional] |
8
+
9
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
10
+
@@ -0,0 +1,11 @@
1
+ # Fastly::StoreResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | ID of the store. | [optional] |
8
+ | **name** | **String** | A human-readable name for the store. | [optional] |
9
+
10
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
11
+
data/docs/UserApi.md CHANGED
@@ -219,7 +219,7 @@ end
219
219
  update_user(opts): <UserResponse> # Update a user
220
220
  ```
221
221
 
222
- Update a user. Only users with the role of `superuser` can make changes to other users on the account. Non-superusers may use this endpoint to make changes to their own account. Modifications to `login` email require a valid password in the request body. Two-factor attributes are not editable via this endpoint.
222
+ Update a user. Only users with the role of `superuser` can make changes to other users on the account. Non-superusers may use this endpoint to make changes to their own account. Two-factor attributes are not editable via this endpoint.
223
223
 
224
224
  ### Examples
225
225
 
@@ -144,6 +144,7 @@ module Fastly
144
144
  # Get a Mutual Authentication
145
145
  # Show a Mutual Authentication.
146
146
  # @option opts [String] :mutual_authentication_id Alphanumeric string identifying a mutual authentication. (required)
147
+ # @option opts [String] :include Comma-separated list of related objects to include (optional). Permitted values: &#x60;tls_activations&#x60;. Including TLS activations will provide you with the TLS domain names that are related to your Mutual TLS authentication.
147
148
  # @return [MutualAuthenticationResponse]
148
149
  def get_mutual_authentication(opts = {})
149
150
  data, _status_code, _headers = get_mutual_authentication_with_http_info(opts)
@@ -153,6 +154,7 @@ module Fastly
153
154
  # Get a Mutual Authentication
154
155
  # Show a Mutual Authentication.
155
156
  # @option opts [String] :mutual_authentication_id Alphanumeric string identifying a mutual authentication. (required)
157
+ # @option opts [String] :include Comma-separated list of related objects to include (optional). Permitted values: &#x60;tls_activations&#x60;. Including TLS activations will provide you with the TLS domain names that are related to your Mutual TLS authentication.
156
158
  # @return [Array<(MutualAuthenticationResponse, Integer, Hash)>] MutualAuthenticationResponse data, response status code and response headers
157
159
  def get_mutual_authentication_with_http_info(opts = {})
158
160
  if @api_client.config.debugging
@@ -169,6 +171,7 @@ module Fastly
169
171
 
170
172
  # query parameters
171
173
  query_params = opts[:query_params] || {}
174
+ query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?
172
175
 
173
176
  # header parameters
174
177
  header_params = opts[:header_params] || {}
@@ -206,6 +209,7 @@ module Fastly
206
209
 
207
210
  # List Mutual Authentications
208
211
  # List all mutual authentications.
212
+ # @option opts [String] :include Comma-separated list of related objects to include (optional). Permitted values: &#x60;tls_activations&#x60;. Including TLS activations will provide you with the TLS domain names that are related to your Mutual TLS authentication.
209
213
  # @option opts [Integer] :page_number Current page.
210
214
  # @option opts [Integer] :page_size Number of records per page. (default to 20)
211
215
  # @return [MutualAuthenticationsResponse]
@@ -216,6 +220,7 @@ module Fastly
216
220
 
217
221
  # List Mutual Authentications
218
222
  # List all mutual authentications.
223
+ # @option opts [String] :include Comma-separated list of related objects to include (optional). Permitted values: &#x60;tls_activations&#x60;. Including TLS activations will provide you with the TLS domain names that are related to your Mutual TLS authentication.
219
224
  # @option opts [Integer] :page_number Current page.
220
225
  # @option opts [Integer] :page_size Number of records per page. (default to 20)
221
226
  # @return [Array<(MutualAuthenticationsResponse, Integer, Hash)>] MutualAuthenticationsResponse data, response status code and response headers
@@ -237,6 +242,7 @@ module Fastly
237
242
 
238
243
  # query parameters
239
244
  query_params = opts[:query_params] || {}
245
+ query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?
240
246
  query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
241
247
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
242
248