Generated v3.0.0

fastly · Jul 6, 2023 · 1662384 · 1662384
1 parent 8ff496b
commit 1662384
Show file tree

Hide file tree

Showing 186 changed files with 74,523 additions and 1,202 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,54 @@
 # Changelog
 
+## [v3.0.0](https://github.com/fastly/fastly-php/releases/tag/release/v3.0.0) (2023-07-06)
+
+Substantial changes were made to the underlying OpenAPI specification that produces this API client. These changes have resulted in multiple new endpoints being supported as well as multiple breaking type changes and so we're publishing these changes as a new major release.
+
+**Enhancements:**
+
+- feat(apex_redirect): support all endpoints.
+- feat(contact): support 'create' endpoint.
+- feat(director): support 'update' endpoint.
+- feat(domain_inspector): support all endpoints.
+- feat(iam_roles): support 'add permissions' endpoint.
+- feat(iam_roles): support 'create role' endpoint.
+- feat(iam_roles): support 'delete permissions' endpoint.
+- feat(iam_roles): support 'update role' endpoint.
+- feat(iam_services): support 'add services' endpoint.
+- feat(iam_services): support 'create service group' endpoint.
+- feat(iam_services): support 'remove services' endpoint.
+- feat(iam_services): support 'update service group' endpoint.
+- feat(iam_users): support 'add members' endpoint.
+- feat(iam_users): support 'add roles' endpoint.
+- feat(iam_users): support 'add service groups' endpoint.
+- feat(iam_users): support 'create user group' endpoint.
+- feat(iam_users): support 'remove members' endpoint.
+- feat(iam_users): support 'remove roles' endpoint.
+- feat(iam_users): support 'remove service groups' endpoint.
+- feat(iam_users): support 'update user group' endpoint.
+- feat(legacy_waf): support all endpoints.
+- feat(logging_kafka): support 'update' endpoint.
+- feat(logging_kinesis): support 'update' endpoint.
+- feat(origin_inspector): support all endpoints.
+- feat(request_settings): support 'create' endpoint.
+- feat(response_object): support 'create' endpoint.
+- feat(response_object): support 'update' endpoint.
+- feat(secret_store): support all endpoints.
+- feat(service_authorizations): support 'delete' endpoint.
+- feat(service_authorizations): support 'update' endpoint.
+- feat(snippet): support 'update versioned snippet' endpoint.
+- feat(sudo): support 'request sudo access' endpoint.
+- feat(tokens): support 'revoke multiple tokens' endpoint.
+- feat(tokens): support 'create token' endpoint.
+- feat(waf_active_rules): support 'delete' endpoint.
+
+**Bug fixes:**
+
+- fix(content): update request/response types.
+- fix(events): update metadata type.
+- fix(realtime_entry): update recorded/aggregated type.
+- fix(realtime_measurements): update miss_histogram type.
+
 ## [v2.3.1](https://github.com/fastly/fastly-php/releases/tag/release/v2.3.1) (2023-07-05)
 
 **Bug fixes:**

diff --git a/README.md b/README.md
diff --git a/docs/Api/ApexRedirectApi.md b/docs/Api/ApexRedirectApi.md
@@ -14,12 +14,65 @@ $apiInstance = new Fastly\Api\ApexRedirectApi(
 
 Method | Fastly API endpoint | Description
 ------------- | ------------- | -------------
+[**createApexRedirect()**](ApexRedirectApi.md#createApexRedirect) | **POST** /service/{service_id}/version/{version_id}/apex-redirects | Create an apex redirect
 [**deleteApexRedirect()**](ApexRedirectApi.md#deleteApexRedirect) | **DELETE** /apex-redirects/{apex_redirect_id} | Delete an apex redirect
 [**getApexRedirect()**](ApexRedirectApi.md#getApexRedirect) | **GET** /apex-redirects/{apex_redirect_id} | Get an apex redirect
 [**listApexRedirects()**](ApexRedirectApi.md#listApexRedirects) | **GET** /service/{service_id}/version/{version_id}/apex-redirects | List apex redirects
 [**updateApexRedirect()**](ApexRedirectApi.md#updateApexRedirect) | **PUT** /apex-redirects/{apex_redirect_id} | Update an apex redirect
 
 
+## `createApexRedirect()`
+
+```php
+createApexRedirect($options): \Fastly\Model\ApexRedirect // Create an apex redirect
+```
+
+Create an apex redirect for a particular service and version.
+
+### Example
+```php
+    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
+$options['version_id'] = 56; // int | Integer identifying a service version.
+$options['service_id'] = 'service_id_example'; // string
+$options['version'] = 56; // int
+$options['created_at'] = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Date and time in ISO 8601 format.
+$options['deleted_at'] = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Date and time in ISO 8601 format.
+$options['updated_at'] = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Date and time in ISO 8601 format.
+$options['status_code'] = 56; // int | HTTP status code used to redirect the client.
+$options['domains'] = array('domains_example'); // string[] | Array of apex domains that should redirect to their WWW subdomain.
+$options['feature_revision'] = 56; // int | Revision number of the apex redirect feature implementation. Defaults to the most recent revision.
+
+try {
+    $result = $apiInstance->createApexRedirect($options);
+} catch (Exception $e) {
+    echo 'Exception when calling ApexRedirectApi->createApexRedirect: ', $e->getMessage(), PHP_EOL;
+}
+```
+
+### Options
+
+Note: the input parameter is an associative array with the keys listed below.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+**service_id** | **string** | Alphanumeric string identifying the service. |
+**version_id** | **int** | Integer identifying a service version. |
+**service_id** | **string** |  | [optional]
+**version** | **int** |  | [optional]
+**created_at** | **\DateTime** | Date and time in ISO 8601 format. | [optional]
+**deleted_at** | **\DateTime** | Date and time in ISO 8601 format. | [optional]
+**updated_at** | **\DateTime** | Date and time in ISO 8601 format. | [optional]
+**status_code** | **int** | HTTP status code used to redirect the client. | [optional] [one of: 301, 302, 307, 308]
+**domains** | [**string[]**](../Model/string.md) | Array of apex domains that should redirect to their WWW subdomain. | [optional]
+**feature_revision** | **int** | Revision number of the apex redirect feature implementation. Defaults to the most recent revision. | [optional]
+
+### Return type
+
+[**\Fastly\Model\ApexRedirect**](../Model/ApexRedirect.md)
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to README]](../../README.md)
+
 ## `deleteApexRedirect()`
 
 ```php

diff --git a/docs/Api/ContactApi.md b/docs/Api/ContactApi.md
@@ -14,10 +14,57 @@ $apiInstance = new Fastly\Api\ContactApi(
 
 Method | Fastly API endpoint | Description
 ------------- | ------------- | -------------
+[**createContacts()**](ContactApi.md#createContacts) | **POST** /customer/{customer_id}/contacts | Add a new customer contact
 [**deleteContact()**](ContactApi.md#deleteContact) | **DELETE** /customer/{customer_id}/contact/{contact_id} | Delete a contact
 [**listContacts()**](ContactApi.md#listContacts) | **GET** /customer/{customer_id}/contacts | List contacts
 
 
+## `createContacts()`
+
+```php
+createContacts($options): \Fastly\Model\ContactResponse // Add a new customer contact
+```
+
+Create a contact.
+
+### Example
+```php
+    $options['customer_id'] = 'customer_id_example'; // string | Alphanumeric string identifying the customer.
+$options['user_id'] = 'user_id_example'; // string | The alphanumeric string representing the user for this customer contact.
+$options['contact_type'] = 'contact_type_example'; // string | The type of contact.
+$options['name'] = 'name_example'; // string | The name of this contact, when user_id is not provided.
+$options['email'] = 'email_example'; // string | The email of this contact, when a user_id is not provided.
+$options['phone'] = 'phone_example'; // string | The phone number for this contact. Required for primary, technical, and security contact types.
+$options['customer_id'] = 'customer_id_example'; // string | The alphanumeric string representing the customer for this customer contact.
+
+try {
+    $result = $apiInstance->createContacts($options);
+} catch (Exception $e) {
+    echo 'Exception when calling ContactApi->createContacts: ', $e->getMessage(), PHP_EOL;
+}
+```
+
+### Options
+
+Note: the input parameter is an associative array with the keys listed below.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+**customer_id** | **string** | Alphanumeric string identifying the customer. |
+**user_id** | **string** | The alphanumeric string representing the user for this customer contact. | [optional]
+**contact_type** | **string** | The type of contact. | [optional] [one of: 'primary', 'billing', 'technical', 'security', 'emergency', 'general compliance']
+**name** | **string** | The name of this contact, when user_id is not provided. | [optional]
+**email** | **string** | The email of this contact, when a user_id is not provided. | [optional]
+**phone** | **string** | The phone number for this contact. Required for primary, technical, and security contact types. | [optional]
+**customer_id** | **string** | The alphanumeric string representing the customer for this customer contact. | [optional]
+
+### Return type
+
+[**\Fastly\Model\ContactResponse**](../Model/ContactResponse.md)
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to README]](../../README.md)
+
 ## `deleteContact()`
 
 ```php

diff --git a/docs/Api/DirectorApi.md b/docs/Api/DirectorApi.md
@@ -18,6 +18,7 @@ Method | Fastly API endpoint | Description
 [**deleteDirector()**](DirectorApi.md#deleteDirector) | **DELETE** /service/{service_id}/version/{version_id}/director/{director_name} | Delete a director
 [**getDirector()**](DirectorApi.md#getDirector) | **GET** /service/{service_id}/version/{version_id}/director/{director_name} | Get a director
 [**listDirectors()**](DirectorApi.md#listDirectors) | **GET** /service/{service_id}/version/{version_id}/director | List directors
+[**updateDirector()**](DirectorApi.md#updateDirector) | **PUT** /service/{service_id}/version/{version_id}/director/{director_name} | Update a director
 
 
 ## `createDirector()`
@@ -183,3 +184,41 @@ Name | Type | Description  | Notes
 
 [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
 [[Back to README]](../../README.md)
+
+## `updateDirector()`
+
+```php
+updateDirector($options): \Fastly\Model\DirectorResponse // Update a director
+```
+
+Update the director for a particular service and version.
+
+### Example
+```php
+    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
+$options['version_id'] = 56; // int | Integer identifying a service version.
+$options['director_name'] = 'director_name_example'; // string | Name for the Director.
+
+try {
+    $result = $apiInstance->updateDirector($options);
+} catch (Exception $e) {
+    echo 'Exception when calling DirectorApi->updateDirector: ', $e->getMessage(), PHP_EOL;
+}
+```
+
+### Options
+
+Note: the input parameter is an associative array with the keys listed below.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+**service_id** | **string** | Alphanumeric string identifying the service. |
+**version_id** | **int** | Integer identifying a service version. |
+**director_name** | **string** | Name for the Director. |
+
+### Return type
+
+[**\Fastly\Model\DirectorResponse**](../Model/DirectorResponse.md)
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to README]](../../README.md)
diff --git a/docs/Api/DomainInspectorHistoricalApi.md b/docs/Api/DomainInspectorHistoricalApi.md
@@ -0,0 +1,72 @@
+# Fastly\Api\DomainInspectorHistoricalApi
+
+
+```php
+$apiInstance = new Fastly\Api\DomainInspectorHistoricalApi(
+    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
+    // This is optional, `GuzzleHttp\Client` will be used as default.
+    new GuzzleHttp\Client(),
+    $config
+);
+```
+
+## Methods
+
+Method | Fastly API endpoint | Description
+------------- | ------------- | -------------
+[**getDomainInspectorHistorical()**](DomainInspectorHistoricalApi.md#getDomainInspectorHistorical) | **GET** /metrics/domains/services/{service_id} | Get historical domain data for a service
+
+
+## `getDomainInspectorHistorical()`
+
+```php
+getDomainInspectorHistorical($options): \Fastly\Model\HistoricalDomainsResponse // Get historical domain data for a service
+```
+
+Fetches historical domain metrics for a given Fastly service, optionally filtering and grouping the results by domain, region, or POP.
+
+### Example
+```php
+    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
+$options['start'] = 2021-08-01T00:00:00.000Z; // string | A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the inclusive start of the query time range. If not provided, a default is chosen based on the provided `downsample` value.
+$options['end'] = 2020-08-02T00:00:00.000Z; // string | A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the exclusive end of the query time range. If not provided, a default is chosen based on the provided `downsample` value.
+$options['downsample'] = hour; // string | Duration of sample windows.
+$options['metric'] = resp_body_bytes,status_2xx; // string | The metric to retrieve. Up to ten comma-separated metrics are accepted.
+$options['group_by'] = domain; // string | Dimensions to return in the query. Multiple dimensions may be separated by commas. For example, `group_by=domain` will return one timeseries for every domain, as a total across all datacenters (POPs).
+$options['limit'] = '100'; // string | Number of results per page. The maximum is 200.
+$options['cursor'] = 'cursor_example'; // string | Cursor value from a previous response to retrieve the next page. To request the first page, this should be empty.
+$options['region'] = usa; // string | Limit query to one or more specific geographic regions. Values should be comma-separated.
+$options['datacenter'] = SJC,STP; // string | Limit query to one or more specific POPs. Values should be comma-separated.
+$options['domain'] = domain_1.com,domain_2.com; // string | Limit query to one or more specific domains. Values should be comma-separated.
+
+try {
+    $result = $apiInstance->getDomainInspectorHistorical($options);
+} catch (Exception $e) {
+    echo 'Exception when calling DomainInspectorHistoricalApi->getDomainInspectorHistorical: ', $e->getMessage(), PHP_EOL;
+}
+```
+
+### Options
+
+Note: the input parameter is an associative array with the keys listed below.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+**service_id** | **string** | Alphanumeric string identifying the service. |
+**start** | **string** | A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the inclusive start of the query time range. If not provided, a default is chosen based on the provided `downsample` value. | [optional]
+**end** | **string** | A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the exclusive end of the query time range. If not provided, a default is chosen based on the provided `downsample` value. | [optional]
+**downsample** | **string** | Duration of sample windows. | [optional] [one of: 'hour', 'minute', 'day'] [defaults to 'hour']
+**metric** | **string** | The metric to retrieve. Up to ten comma-separated metrics are accepted. | [optional] [defaults to 'edge_requests']
+**group_by** | **string** | Dimensions to return in the query. Multiple dimensions may be separated by commas. For example, `group_by&#x3D;domain` will return one timeseries for every domain, as a total across all datacenters (POPs). | [optional] [one of: 'domain', 'datacenter', 'region', 'none']
+**limit** | **string** | Number of results per page. The maximum is 200. | [optional] [defaults to '100']
+**cursor** | **string** | Cursor value from a previous response to retrieve the next page. To request the first page, this should be empty. | [optional]
+**region** | **string** | Limit query to one or more specific geographic regions. Values should be comma-separated. | [optional] [one of: 'usa', 'europe', 'asia', 'asia_india', 'asia_southkorea', 'africa_std', 'southamerica_std']
+**datacenter** | **string** | Limit query to one or more specific POPs. Values should be comma-separated. | [optional]
+**domain** | **string** | Limit query to one or more specific domains. Values should be comma-separated. | [optional]
+
+### Return type
+
+[**\Fastly\Model\HistoricalDomainsResponse**](../Model/HistoricalDomainsResponse.md)
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to README]](../../README.md)