Generated v6.0.0

CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## [v6.0.0](https://github.com/fastly/fastly-js/releases/tag/release/v6.0.0) (2023-07-31)
+
+**Breaking:**
+
+The following restructures have helped resolve some issues with our OpenAPI schemas but as a side-effect this has resulted in a break to our API client interface as different types are now being generated.
+
+- refactor: general restructure OpenAPI schemas.
+- refactor(domain): remove explicit schema type for 'any'.
+
+**Bug fixes:**
+
+- fix: change response `version` type to string.
+- fix(cache_settings): change response `stale_ttl` and `ttl` types to strings.
+- fix(header): change response `ignore_if_set` and `priority` types to strings.
+- fix(logging): change response `period` and `gzip_level` types to strings.
+- fix(pool): change response `use_tls`, `max_conn_default`, `first_byte_timeout`, `quorum` and `tls_check_cert` types to strings.
+- fix(request_settings): change response `bypass_busy_wait`, `force_miss`, `force_ssl`, `geo_headers`, `max_stale_age` and `timer_support` types to strings.
+- fix(response_object): change response `status` type to string.
+
 ## [v5.0.2](https://github.com/fastly/fastly-js/releases/tag/release/v5.0.2) (2023-07-13)
 
 **Bug fixes:**

README.md

@@ -4,6 +4,7 @@ An asynchronous JavaScript client library for interacting with most facets of th
 
 > **NOTE:** This API client is auto-generated from Fastly's OpenAPI specification and may not function correctly when used on the Compute@Edge platform. Support for Compute@Edge is on the roadmap but has not yet been prioritised.
 
+
 ## Usage
 
 ```javascript

docs/CacheSetting.md

@@ -7,8 +7,8 @@ Name | Type | Description | Notes
 **action** | **String** | If set, will cause vcl_fetch to terminate after processing this rule with the return state specified. If not set, other configuration logic in vcl_fetch with a lower priority will run after this rule.  | [optional]  [one of: "pass", "cache", "restart"]
 **cache_condition** | **String** | Name of the cache condition controlling when this configuration applies. | [optional] 
 **name** | **String** | Name for the cache settings object. | [optional] 
-**stale_ttl** | **Number** | Maximum time in seconds to continue to use a stale version of the object if future requests to your backend server fail (also known as 'stale if error'). | [optional] 
-**ttl** | **Number** | Maximum time to consider the object fresh in the cache (the cache 'time to live'). | [optional] 
+**stale_ttl** | **String** | Maximum time in seconds to continue to use a stale version of the object if future requests to your backend server fail (also known as 'stale if error'). | [optional] 
+**ttl** | **String** | Maximum time to consider the object fresh in the cache (the cache 'time to live'). | [optional] 
 
 
 [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

docs/CacheSettingResponse.md

@@ -7,10 +7,10 @@ Name | Type | Description | Notes
 **action** | **String** | If set, will cause vcl_fetch to terminate after processing this rule with the return state specified. If not set, other configuration logic in vcl_fetch with a lower priority will run after this rule.  | [optional]  [one of: "pass", "cache", "restart"]
 **cache_condition** | **String** | Name of the cache condition controlling when this configuration applies. | [optional] 
 **name** | **String** | Name for the cache settings object. | [optional] 
-**stale_ttl** | **Number** | Maximum time in seconds to continue to use a stale version of the object if future requests to your backend server fail (also known as 'stale if error'). | [optional] 
-**ttl** | **Number** | Maximum time to consider the object fresh in the cache (the cache 'time to live'). | [optional] 
+**stale_ttl** | **String** | Maximum time in seconds to continue to use a stale version of the object if future requests to your backend server fail (also known as 'stale if error'). | [optional] 
+**ttl** | **String** | Maximum time to consider the object fresh in the cache (the cache 'time to live'). | [optional] 
 **service_id** | **String** |  | [optional] [readonly] 
-**version** | **Number** |  | [optional] [readonly] 
+**version** | **String** |  | [optional] [readonly] 
 **created_at** | **Date** | Date and time in ISO 8601 format. | [optional] [readonly] 
 **deleted_at** | **Date** | Date and time in ISO 8601 format. | [optional] [readonly] 
 **updated_at** | **Date** | Date and time in ISO 8601 format. | [optional] [readonly] 

docs/CacheSettingsApi.md

@@ -31,8 +31,8 @@ const options = {
   action: "pass",
   cache_condition: "cache_condition_example",
   name: "name_example",
-  stale_ttl: 56,
-  ttl: 56,
+  stale_ttl: "stale_ttl_example",
+  ttl: "ttl_example",
 };
 
 apiInstance.createCacheSettings(options)
@@ -53,8 +53,8 @@ Name | Type | Description  | Notes
 **action** | **String** | If set, will cause vcl_fetch to terminate after processing this rule with the return state specified. If not set, other configuration logic in vcl_fetch with a lower priority will run after this rule.  | [optional] [one of: "pass", "cache", "restart"]
 **cache_condition** | **String** | Name of the cache condition controlling when this configuration applies. | [optional]
 **name** | **String** | Name for the cache settings object. | [optional]
-**stale_ttl** | **Number** | Maximum time in seconds to continue to use a stale version of the object if future requests to your backend server fail (also known as 'stale if error'). | [optional]
-**ttl** | **Number** | Maximum time to consider the object fresh in the cache (the cache 'time to live'). | [optional]
+**stale_ttl** | **String** | Maximum time in seconds to continue to use a stale version of the object if future requests to your backend server fail (also known as 'stale if error'). | [optional]
+**ttl** | **String** | Maximum time to consider the object fresh in the cache (the cache 'time to live'). | [optional]
 
 ### Return type
 
@@ -194,8 +194,8 @@ const options = {
   action: "pass",
   cache_condition: "cache_condition_example",
   name: "name_example",
-  stale_ttl: 56,
-  ttl: 56,
+  stale_ttl: "stale_ttl_example",
+  ttl: "ttl_example",
 };
 
 apiInstance.updateCacheSettings(options)
@@ -217,8 +217,8 @@ Name | Type | Description  | Notes
 **action** | **String** | If set, will cause vcl_fetch to terminate after processing this rule with the return state specified. If not set, other configuration logic in vcl_fetch with a lower priority will run after this rule.  | [optional] [one of: "pass", "cache", "restart"]
 **cache_condition** | **String** | Name of the cache condition controlling when this configuration applies. | [optional]
 **name** | **String** | Name for the cache settings object. | [optional]
-**stale_ttl** | **Number** | Maximum time in seconds to continue to use a stale version of the object if future requests to your backend server fail (also known as 'stale if error'). | [optional]
-**ttl** | **Number** | Maximum time to consider the object fresh in the cache (the cache 'time to live'). | [optional]
+**stale_ttl** | **String** | Maximum time in seconds to continue to use a stale version of the object if future requests to your backend server fail (also known as 'stale if error'). | [optional]
+**ttl** | **String** | Maximum time to consider the object fresh in the cache (the cache 'time to live'). | [optional]
 
 ### Return type
 

docs/DomainApi.md

@@ -52,7 +52,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**[DomainCheckItem]**](DomainCheckItem.md)
+**[Object]**
 
 
 ## `checkDomains`

docs/GzipResponse.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **extensions** | **String** | Space-separated list of file extensions to compress. If you omit this field a default list will be used. | [optional] 
 **name** | **String** | Name of the gzip configuration. | [optional] 
 **service_id** | **String** |  | [optional] [readonly] 
-**version** | **Number** |  | [optional] [readonly] 
+**version** | **String** |  | [optional] [readonly] 
 **created_at** | **Date** | Date and time in ISO 8601 format. | [optional] [readonly] 
 **deleted_at** | **Date** | Date and time in ISO 8601 format. | [optional] [readonly] 
 **updated_at** | **Date** | Date and time in ISO 8601 format. | [optional] [readonly] 

docs/Header.md

@@ -7,9 +7,7 @@ Name | Type | Description | Notes
 **action** | **String** | Accepts a string value. | [optional]  [one of: "set", "append", "delete", "regex", "regex_repeat"]
 **cache_condition** | **String** | Name of the cache condition controlling when this configuration applies. | [optional] 
 **dst** | **String** | Header to set. | [optional] 
-**ignore_if_set** | **Number** | Don't add the header if it is added already. Only applies to 'set' action. | [optional] 
 **name** | **String** | A handle to refer to this Header object. | [optional] 
-**priority** | **Number** | Priority determines execution order. Lower numbers execute first. | [optional]  [defaults to 100]
 **regex** | **String** | Regular expression to use. Only applies to `regex` and `regex_repeat` actions. | [optional] 
 **request_condition** | **String** | Condition which, if met, will select this configuration during a request. Optional. | [optional] 
 **response_condition** | **String** | Optional name of a response condition to apply. | [optional] 

docs/HeaderApi.md

@@ -17,7 +17,7 @@ Method | Fastly API endpoint | Description
 ## `createHeaderObject`
 
 ```javascript
-createHeaderObject({ service_id, version_id, [action, ][cache_condition, ][dst, ][ignore_if_set, ][name, ][priority, ][regex, ][request_condition, ][response_condition, ][src, ][substitution, ][type] })
+createHeaderObject({ service_id, version_id, [action, ][cache_condition, ][dst, ][name, ][regex, ][request_condition, ][response_condition, ][src, ][substitution, ][type, ][ignore_if_set, ][priority] })
 ```
 
 Creates a new Header object.
@@ -31,15 +31,15 @@ const options = {
   action: "set",
   cache_condition: "cache_condition_example",
   dst: "dst_example",
-  ignore_if_set: 56,
   name: "name_example",
-  priority: 100,
   regex: "regex_example",
   request_condition: "request_condition_example",
   response_condition: "response_condition_example",
   src: "src_example",
   substitution: "substitution_example",
   type: "request",
+  ignore_if_set: 56,
+  priority: 100,
 };
 
 apiInstance.createHeaderObject(options)
@@ -60,15 +60,15 @@ Name | Type | Description  | Notes
 **action** | **String** | Accepts a string value. | [optional] [one of: "set", "append", "delete", "regex", "regex_repeat"]
 **cache_condition** | **String** | Name of the cache condition controlling when this configuration applies. | [optional]
 **dst** | **String** | Header to set. | [optional]
-**ignore_if_set** | **Number** | Don't add the header if it is added already. Only applies to 'set' action. | [optional]
 **name** | **String** | A handle to refer to this Header object. | [optional]
-**priority** | **Number** | Priority determines execution order. Lower numbers execute first. | [optional] [defaults to 100]
 **regex** | **String** | Regular expression to use. Only applies to `regex` and `regex_repeat` actions. | [optional]
 **request_condition** | **String** | Condition which, if met, will select this configuration during a request. Optional. | [optional]
 **response_condition** | **String** | Optional name of a response condition to apply. | [optional]
 **src** | **String** | Variable to be used as a source for the header content. Does not apply to `delete` action. | [optional]
 **substitution** | **String** | Value to substitute in place of regular expression. Only applies to `regex` and `regex_repeat` actions. | [optional]
 **type** | **String** | Accepts a string value. | [optional] [one of: "request", "cache", "response"]
+**ignore_if_set** | **Number** | Don't add the header if it is added already. Only applies to 'set' action. | [optional]
+**priority** | **Number** | Priority determines execution order. Lower numbers execute first. | [optional] [defaults to 100]
 
 ### Return type
 
@@ -193,7 +193,7 @@ Name | Type | Description  | Notes
 ## `updateHeaderObject`
 
 ```javascript
-updateHeaderObject({ service_id, version_id, header_name, [action, ][cache_condition, ][dst, ][ignore_if_set, ][name, ][priority, ][regex, ][request_condition, ][response_condition, ][src, ][substitution, ][type] })
+updateHeaderObject({ service_id, version_id, header_name, [action, ][cache_condition, ][dst, ][name, ][regex, ][request_condition, ][response_condition, ][src, ][substitution, ][type, ][ignore_if_set, ][priority] })
 ```
 
 Modifies an existing Header object by name.
@@ -208,15 +208,15 @@ const options = {
   action: "set",
   cache_condition: "cache_condition_example",
   dst: "dst_example",
-  ignore_if_set: 56,
   name: "name_example",
-  priority: 100,
   regex: "regex_example",
   request_condition: "request_condition_example",
   response_condition: "response_condition_example",
   src: "src_example",
   substitution: "substitution_example",
   type: "request",
+  ignore_if_set: 56,
+  priority: 100,
 };
 
 apiInstance.updateHeaderObject(options)
@@ -238,15 +238,15 @@ Name | Type | Description  | Notes
 **action** | **String** | Accepts a string value. | [optional] [one of: "set", "append", "delete", "regex", "regex_repeat"]
 **cache_condition** | **String** | Name of the cache condition controlling when this configuration applies. | [optional]
 **dst** | **String** | Header to set. | [optional]
-**ignore_if_set** | **Number** | Don't add the header if it is added already. Only applies to 'set' action. | [optional]
 **name** | **String** | A handle to refer to this Header object. | [optional]
-**priority** | **Number** | Priority determines execution order. Lower numbers execute first. | [optional] [defaults to 100]
 **regex** | **String** | Regular expression to use. Only applies to `regex` and `regex_repeat` actions. | [optional]
 **request_condition** | **String** | Condition which, if met, will select this configuration during a request. Optional. | [optional]
 **response_condition** | **String** | Optional name of a response condition to apply. | [optional]
 **src** | **String** | Variable to be used as a source for the header content. Does not apply to `delete` action. | [optional]
 **substitution** | **String** | Value to substitute in place of regular expression. Only applies to `regex` and `regex_repeat` actions. | [optional]
 **type** | **String** | Accepts a string value. | [optional] [one of: "request", "cache", "response"]
+**ignore_if_set** | **Number** | Don't add the header if it is added already. Only applies to 'set' action. | [optional]
+**priority** | **Number** | Priority determines execution order. Lower numbers execute first. | [optional] [defaults to 100]
 
 ### Return type
 

docs/HeaderResponse.md

@@ -7,17 +7,17 @@ Name | Type | Description | Notes
 **action** | **String** | Accepts a string value. | [optional]  [one of: "set", "append", "delete", "regex", "regex_repeat"]
 **cache_condition** | **String** | Name of the cache condition controlling when this configuration applies. | [optional] 
 **dst** | **String** | Header to set. | [optional] 
-**ignore_if_set** | **Number** | Don't add the header if it is added already. Only applies to 'set' action. | [optional] 
 **name** | **String** | A handle to refer to this Header object. | [optional] 
-**priority** | **Number** | Priority determines execution order. Lower numbers execute first. | [optional]  [defaults to 100]
 **regex** | **String** | Regular expression to use. Only applies to `regex` and `regex_repeat` actions. | [optional] 
 **request_condition** | **String** | Condition which, if met, will select this configuration during a request. Optional. | [optional] 
 **response_condition** | **String** | Optional name of a response condition to apply. | [optional] 
 **src** | **String** | Variable to be used as a source for the header content. Does not apply to `delete` action. | [optional] 
 **substitution** | **String** | Value to substitute in place of regular expression. Only applies to `regex` and `regex_repeat` actions. | [optional] 
 **type** | **String** | Accepts a string value. | [optional]  [one of: "request", "cache", "response"]
+**ignore_if_set** | **String** | Don't add the header if it is added already. Only applies to 'set' action. Numerical value (\"0\" = false, \"1\" = true) | [optional] 
+**priority** | **String** | Priority determines execution order. Lower numbers execute first. | [optional]  [defaults to '100']
 **service_id** | **String** |  | [optional] [readonly] 
-**version** | **Number** |  | [optional] [readonly] 
+**version** | **String** |  | [optional] [readonly] 
 **created_at** | **Date** | Date and time in ISO 8601 format. | [optional] [readonly] 
 **deleted_at** | **Date** | Date and time in ISO 8601 format. | [optional] [readonly] 
 **updated_at** | **Date** | Date and time in ISO 8601 format. | [optional] [readonly] 

docs/HeaderResponseAdditional.md

@@ -0,0 +1,11 @@
+# Fastly.HeaderResponseAdditional
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ignore_if_set** | **String** | Don't add the header if it is added already. Only applies to 'set' action. Numerical value (\"0\" = false, \"1\" = true) | [optional] 
+**priority** | **String** | Priority determines execution order. Lower numbers execute first. | [optional]  [defaults to '100']
+
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)