Generated v2.3.1

fastly · Jul 5, 2023 · 8ff496b · 8ff496b
1 parent d3b9737
commit 8ff496b
Show file tree

Hide file tree

Showing 30 changed files with 2,474 additions and 241 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,12 @@
 # Changelog
 
+## [v2.3.1](https://github.com/fastly/fastly-php/releases/tag/release/v2.3.1) (2023-07-05)
+
+**Bug fixes:**
+
+- fix(snippet): dynamic field switched from int to string.
+- fix(vcl): implement correct response models.
+
 ## [v2.3.0](https://github.com/fastly/fastly-php/releases/tag/release/v2.3.0) (2023-06-27)
 
 **Enhancements:**

diff --git a/README.md b/README.md
@@ -529,6 +529,7 @@ The fastly-php API client currently does not support the following endpoints:
 - [`/customer/{customer_id}/contacts`](https://developer.fastly.com/reference/api/account/contact) (POST)
 - [`/metrics/domains/services/{service_id}`](https://developer.fastly.com/reference/api/metrics-stats/domain-inspector/historical) (GET)
 - [`/metrics/origins/services/{service_id}`](https://developer.fastly.com/reference/api/metrics-stats/origin-inspector/historical) (GET)
+- [`/resources/stores/kv/{store_id}/batch`](https://developer.fastly.com/reference/api/services/resources/kv-store-item) (PUT)
 - [`/resources/stores/secret/client-key`](https://developer.fastly.com/reference/api/services/resources/secret-store) (POST)
 - [`/resources/stores/secret/signing-key`](https://developer.fastly.com/reference/api/services/resources/secret-store) (GET)
 - [`/resources/stores/secret/{store_id}/secrets/{secret_name}`](https://developer.fastly.com/reference/api/services/resources/secret) (DELETE, GET)

diff --git a/docs/Api/SnippetApi.md b/docs/Api/SnippetApi.md
@@ -35,7 +35,7 @@ Create a snippet for a particular service and version.
     $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
 $options['version_id'] = 56; // int | Integer identifying a service version.
 $options['name'] = 'name_example'; // string | The name for the snippet.
-$options['dynamic'] = 56; // int | Sets the snippet version.
+$options['dynamic'] = 'dynamic_example'; // string | Sets the snippet version.
 $options['type'] = 'type_example'; // string | The location in generated VCL where the snippet should be placed.
 $options['content'] = 'content_example'; // string | The VCL code that specifies exactly what the snippet does.
 $options['priority'] = '100'; // string | Priority determines execution order. Lower numbers execute first.
@@ -56,7 +56,7 @@ Name | Type | Description  | Notes
 **service_id** | **string** | Alphanumeric string identifying the service. |
 **version_id** | **int** | Integer identifying a service version. |
 **name** | **string** | The name for the snippet. | [optional]
-**dynamic** | **int** | Sets the snippet version. | [optional] [one of: 0, 1]
+**dynamic** | **string** | Sets the snippet version. | [optional] [one of: '0', '1']
 **type** | **string** | The location in generated VCL where the snippet should be placed. | [optional] [one of: 'init', 'recv', 'hash', 'hit', 'miss', 'pass', 'fetch', 'error', 'deliver', 'log', 'none']
 **content** | **string** | The VCL code that specifies exactly what the snippet does. | [optional]
 **priority** | **string** | Priority determines execution order. Lower numbers execute first. | [optional] [defaults to '100']
@@ -229,7 +229,7 @@ Update a dynamic snippet for a particular service.
     $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
 $options['snippet_id'] = 'snippet_id_example'; // string | Alphanumeric string identifying a VCL Snippet.
 $options['name'] = 'name_example'; // string | The name for the snippet.
-$options['dynamic'] = 56; // int | Sets the snippet version.
+$options['dynamic'] = 'dynamic_example'; // string | Sets the snippet version.
 $options['type'] = 'type_example'; // string | The location in generated VCL where the snippet should be placed.
 $options['content'] = 'content_example'; // string | The VCL code that specifies exactly what the snippet does.
 $options['priority'] = '100'; // string | Priority determines execution order. Lower numbers execute first.
@@ -250,7 +250,7 @@ Name | Type | Description  | Notes
 **service_id** | **string** | Alphanumeric string identifying the service. |
 **snippet_id** | **string** | Alphanumeric string identifying a VCL Snippet. |
 **name** | **string** | The name for the snippet. | [optional]
-**dynamic** | **int** | Sets the snippet version. | [optional] [one of: 0, 1]
+**dynamic** | **string** | Sets the snippet version. | [optional] [one of: '0', '1']
 **type** | **string** | The location in generated VCL where the snippet should be placed. | [optional] [one of: 'init', 'recv', 'hash', 'hit', 'miss', 'pass', 'fetch', 'error', 'deliver', 'log', 'none']
 **content** | **string** | The VCL code that specifies exactly what the snippet does. | [optional]
 **priority** | **string** | Priority determines execution order. Lower numbers execute first. | [optional] [defaults to '100']

diff --git a/docs/Api/VclApi.md b/docs/Api/VclApi.md
@@ -224,7 +224,7 @@ Name | Type | Description  | Notes
 ## `getCustomVclGeneratedHighlighted()`
 
 ```php
-getCustomVclGeneratedHighlighted($options) // Get the generated VCL with syntax highlighting
+getCustomVclGeneratedHighlighted($options): \Fastly\Model\VclSyntaxHighlightingResponse // Get the generated VCL with syntax highlighting
 ```
 
 Display the content of generated VCL with HTML syntax highlighting. Include line numbers by sending `lineno=true` as a request parameter.
@@ -235,7 +235,7 @@ Display the content of generated VCL with HTML syntax highlighting. Include line
 $options['version_id'] = 56; // int | Integer identifying a service version.
 
 try {
-    $apiInstance->getCustomVclGeneratedHighlighted($options);
+    $result = $apiInstance->getCustomVclGeneratedHighlighted($options);
 } catch (Exception $e) {
     echo 'Exception when calling VclApi->getCustomVclGeneratedHighlighted: ', $e->getMessage(), PHP_EOL;
 }
@@ -252,15 +252,15 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-void (empty response body)
+[**\Fastly\Model\VclSyntaxHighlightingResponse**](../Model/VclSyntaxHighlightingResponse.md)
 
 [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
 [[Back to README]](../../README.md)
 
 ## `getCustomVclHighlighted()`
 
 ```php
-getCustomVclHighlighted($options) // Get a custom VCL file with syntax highlighting
+getCustomVclHighlighted($options): \Fastly\Model\VclSyntaxHighlightingResponse // Get a custom VCL file with syntax highlighting
 ```
 
 Get the uploaded VCL for a particular service and version with HTML syntax highlighting. Include line numbers by sending `lineno=true` as a request parameter.
@@ -272,7 +272,7 @@ $options['version_id'] = 56; // int | Integer identifying a service version.
 $options['vcl_name'] = 'vcl_name_example'; // string | The name of this VCL.
 
 try {
-    $apiInstance->getCustomVclHighlighted($options);
+    $result = $apiInstance->getCustomVclHighlighted($options);
 } catch (Exception $e) {
     echo 'Exception when calling VclApi->getCustomVclHighlighted: ', $e->getMessage(), PHP_EOL;
 }
@@ -290,7 +290,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-void (empty response body)
+[**\Fastly\Model\VclSyntaxHighlightingResponse**](../Model/VclSyntaxHighlightingResponse.md)
 
 [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
 [[Back to README]](../../README.md)

diff --git a/docs/Model/Batch.md b/docs/Model/Batch.md
@@ -0,0 +1,12 @@
+# # Batch
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **string** | A descriptor for the response of the entire batch | [optional] 
+**type** | **string** | If an error is present in any of the requests, this field will describe that error | [optional] 
+**errors** | [**\Fastly\Model\BatchErrors[]**](BatchErrors.md) | Per-key errors which failed to parse, validate, or otherwise transmit | [optional] 
+
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/BatchErrors.md b/docs/Model/BatchErrors.md
@@ -0,0 +1,13 @@
+# # BatchErrors
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **string** | The key that the error corresponds to. This field will be empty if the object or one of its fields was unable to be parsed. | [optional] 
+**index** | **int** | The line number of the payload on which the error occurred (starting from 0 for the first line). | [optional] 
+**code** | **string** | The HTTP response code for the request, or a 400 if the request was not able to be completed. | [optional] 
+**reason** | **string** | A descriptor of this particular item&#39;s error. | [optional] 
+
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/SchemasSnippetResponse.md b/docs/Model/SchemasSnippetResponse.md
@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **string** | The name for the snippet. | [optional] 
-**dynamic** | **int** | Sets the snippet version. | [optional]  [one of: 0, 1]
+**dynamic** | **string** | Sets the snippet version. | [optional]  [one of: '0', '1']
 **type** | **string** | The location in generated VCL where the snippet should be placed. | [optional]  [one of: 'init', 'recv', 'hash', 'hit', 'miss', 'pass', 'fetch', 'error', 'deliver', 'log', 'none']
 **content** | **string** | The VCL code that specifies exactly what the snippet does. | [optional] 
 **priority** | **string** | Priority determines execution order. Lower numbers execute first. | [optional]  [defaults to '100']

diff --git a/docs/Model/Snippet.md b/docs/Model/Snippet.md
@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **string** | The name for the snippet. | [optional] 
-**dynamic** | **int** | Sets the snippet version. | [optional]  [one of: 0, 1]
+**dynamic** | **string** | Sets the snippet version. | [optional]  [one of: '0', '1']
 **type** | **string** | The location in generated VCL where the snippet should be placed. | [optional]  [one of: 'init', 'recv', 'hash', 'hit', 'miss', 'pass', 'fetch', 'error', 'deliver', 'log', 'none']
 **content** | **string** | The VCL code that specifies exactly what the snippet does. | [optional] 
 **priority** | **string** | Priority determines execution order. Lower numbers execute first. | [optional]  [defaults to '100']

diff --git a/docs/Model/SnippetResponse.md b/docs/Model/SnippetResponse.md
@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **string** | The name for the snippet. | [optional] 
-**dynamic** | **int** | Sets the snippet version. | [optional]  [one of: 0, 1]
+**dynamic** | **string** | Sets the snippet version. | [optional]  [one of: '0', '1']
 **type** | **string** | The location in generated VCL where the snippet should be placed. | [optional]  [one of: 'init', 'recv', 'hash', 'hit', 'miss', 'pass', 'fetch', 'error', 'deliver', 'log', 'none']
 **content** | **string** | The VCL code that specifies exactly what the snippet does. | [optional] 
 **priority** | **string** | Priority determines execution order. Lower numbers execute first. | [optional]  [defaults to '100']

diff --git a/docs/Model/TokensAdditionalProps.md b/docs/Model/TokensAdditionalProps.md
@@ -0,0 +1,9 @@
+# # TokensAdditionalProps
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/ValidatorResult.md b/docs/Model/ValidatorResult.md
@@ -4,11 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**msg** | **string** |  | [optional] 
-**status** | **string** |  | [optional]  [one of: 'error', 'ok']
-**errors** | **string[]** |  | [optional] 
-**warnings** | **string[]** |  | [optional] 
-**messages** | [**\Fastly\Model\ValidatorResultMessages[]**](ValidatorResultMessages.md) |  | [optional] 
+**data** | [**\Fastly\Model\ValidatorResultData**](ValidatorResultData.md) |  | [optional] 
 
 
 [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/ValidatorResultData.md b/docs/Model/ValidatorResultData.md
@@ -0,0 +1,12 @@
+# # ValidatorResultData
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] 
+**type** | **string** |  | [optional] 
+**attributes** | [**\Fastly\Model\ValidatorResultDataAttributes**](ValidatorResultDataAttributes.md) |  | [optional] 
+
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/ValidatorResultDataAttributes.md b/docs/Model/ValidatorResultDataAttributes.md
@@ -0,0 +1,14 @@
+# # ValidatorResultDataAttributes
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**msg** | **string** |  | [optional] 
+**status** | **string** |  | [optional]  [one of: 'error', 'ok']
+**errors** | **string[]** |  | [optional] 
+**warnings** | **string[]** |  | [optional] 
+**messages** | [**\Fastly\Model\ValidatorResultDataAttributesMessages[]**](ValidatorResultDataAttributesMessages.md) |  | [optional] 
+
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/ValidatorResultMessages.md → .../ValidatorResultDataAttributesMessages.md b/docs/Model/ValidatorResultMessages.md → .../ValidatorResultDataAttributesMessages.md
@@ -1,4 +1,4 @@
-# # ValidatorResultMessages
+# # ValidatorResultDataAttributesMessages
 
 ## Properties
 
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **type** | **string** |  | 
 **warning** | **bool** |  | 
 **message** | **string** |  | 
-**tokens** | **array&lt;string,AnyOfStringNumber&gt;[]** |  | 
+**tokens** | **array&lt;string,\Fastly\Model\TokensAdditionalProps&gt;[]** |  | 
 
 
 [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/VclSyntaxHighlightingResponse.md b/docs/Model/VclSyntaxHighlightingResponse.md
@@ -0,0 +1,10 @@
+# # VclSyntaxHighlightingResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | **string** | VCL with HTML syntax highlighting. | [optional] 
+
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)