Generated v4.0.0

CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## [v4.0.0](https://github.com/fastly/fastly-php/releases/tag/release/v4.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.
+
 ## [v3.0.3](https://github.com/fastly/fastly-php/releases/tag/release/v3.0.3) (2023-07-13)
 
 **Bug fixes:**

docs/Api/CacheSettingsApi.md

@@ -36,8 +36,8 @@ $options['version_id'] = 56; // int | Integer identifying a service version.
 $options['action'] = 'action_example'; // 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.
 $options['cache_condition'] = 'cache_condition_example'; // string | Name of the cache condition controlling when this configuration applies.
 $options['name'] = 'name_example'; // string | Name for the cache settings object.
-$options['stale_ttl'] = 56; // int | 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').
-$options['ttl'] = 56; // int | Maximum time to consider the object fresh in the cache (the cache 'time to live').
+$options['stale_ttl'] = 'stale_ttl_example'; // 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').
+$options['ttl'] = 'ttl_example'; // string | Maximum time to consider the object fresh in the cache (the cache 'time to live').
 
 try {
     $result = $apiInstance->createCacheSettings($options);
@@ -57,8 +57,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** | **int** | 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** | **int** | 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
 
@@ -195,8 +195,8 @@ $options['cache_settings_name'] = 'cache_settings_name_example'; // string | Nam
 $options['action'] = 'action_example'; // 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.
 $options['cache_condition'] = 'cache_condition_example'; // string | Name of the cache condition controlling when this configuration applies.
 $options['name'] = 'name_example'; // string | Name for the cache settings object.
-$options['stale_ttl'] = 56; // int | 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').
-$options['ttl'] = 56; // int | Maximum time to consider the object fresh in the cache (the cache 'time to live').
+$options['stale_ttl'] = 'stale_ttl_example'; // 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').
+$options['ttl'] = 'ttl_example'; // string | Maximum time to consider the object fresh in the cache (the cache 'time to live').
 
 try {
     $result = $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** | **int** | 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** | **int** | 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/Api/DomainApi.md

@@ -26,7 +26,7 @@ Method | Fastly API endpoint | Description
 ## `checkDomain()`
 
 ```php
-checkDomain($options): \Fastly\Model\DomainCheckItem[] // Validate DNS configuration for a single domain on a service
+checkDomain($options): mixed[] // Validate DNS configuration for a single domain on a service
 ```
 
 Checks the status of a specific domain's DNS record for a Service Version. Returns an array in the same format as domain/check_all.
@@ -56,7 +56,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**\Fastly\Model\DomainCheckItem[]**](../Model/DomainCheckItem.md)
+**mixed[]**
 
 [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
 [[Back to README]](../../README.md)

docs/Api/HeaderApi.md

@@ -36,15 +36,15 @@ $options['version_id'] = 56; // int | Integer identifying a service version.
 $options['action'] = 'action_example'; // string | Accepts a string value.
 $options['cache_condition'] = 'cache_condition_example'; // string | Name of the cache condition controlling when this configuration applies.
 $options['dst'] = 'dst_example'; // string | Header to set.
-$options['ignore_if_set'] = 56; // int | Don't add the header if it is added already. Only applies to 'set' action.
 $options['name'] = 'name_example'; // string | A handle to refer to this Header object.
-$options['priority'] = 100; // int | Priority determines execution order. Lower numbers execute first.
 $options['regex'] = 'regex_example'; // string | Regular expression to use. Only applies to `regex` and `regex_repeat` actions.
 $options['request_condition'] = 'request_condition_example'; // string | Condition which, if met, will select this configuration during a request. Optional.
 $options['response_condition'] = 'response_condition_example'; // string | Optional name of a response condition to apply.
 $options['src'] = 'src_example'; // string | Variable to be used as a source for the header content. Does not apply to `delete` action.
 $options['substitution'] = 'substitution_example'; // string | Value to substitute in place of regular expression. Only applies to `regex` and `regex_repeat` actions.
 $options['type'] = 'type_example'; // string | Accepts a string value.
+$options['ignore_if_set'] = 56; // int | Don't add the header if it is added already. Only applies to 'set' action.
+$options['priority'] = 100; // int | Priority determines execution order. Lower numbers execute first.
 
 try {
     $result = $apiInstance->createHeaderObject($options);
@@ -64,15 +64,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** | **int** | 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** | **int** | 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** | **int** | Don't add the header if it is added already. Only applies to 'set' action. | [optional]
+**priority** | **int** | Priority determines execution order. Lower numbers execute first. | [optional] [defaults to 100]
 
 ### Return type
 
@@ -209,15 +209,15 @@ $options['header_name'] = 'header_name_example'; // string | A handle to refer t
 $options['action'] = 'action_example'; // string | Accepts a string value.
 $options['cache_condition'] = 'cache_condition_example'; // string | Name of the cache condition controlling when this configuration applies.
 $options['dst'] = 'dst_example'; // string | Header to set.
-$options['ignore_if_set'] = 56; // int | Don't add the header if it is added already. Only applies to 'set' action.
 $options['name'] = 'name_example'; // string | A handle to refer to this Header object.
-$options['priority'] = 100; // int | Priority determines execution order. Lower numbers execute first.
 $options['regex'] = 'regex_example'; // string | Regular expression to use. Only applies to `regex` and `regex_repeat` actions.
 $options['request_condition'] = 'request_condition_example'; // string | Condition which, if met, will select this configuration during a request. Optional.
 $options['response_condition'] = 'response_condition_example'; // string | Optional name of a response condition to apply.
 $options['src'] = 'src_example'; // string | Variable to be used as a source for the header content. Does not apply to `delete` action.
 $options['substitution'] = 'substitution_example'; // string | Value to substitute in place of regular expression. Only applies to `regex` and `regex_repeat` actions.
 $options['type'] = 'type_example'; // string | Accepts a string value.
+$options['ignore_if_set'] = 56; // int | Don't add the header if it is added already. Only applies to 'set' action.
+$options['priority'] = 100; // int | Priority determines execution order. Lower numbers execute first.
 
 try {
     $result = $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** | **int** | 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** | **int** | 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** | **int** | Don't add the header if it is added already. Only applies to 'set' action. | [optional]
+**priority** | **int** | Priority determines execution order. Lower numbers execute first. | [optional] [defaults to 100]
 
 ### Return type