Generated v6.0.0

fastly · Dec 6, 2024 · 09e9f0d · 09e9f0d
1 parent 5ce77ff
commit 09e9f0d
Show file tree

Hide file tree

Showing 112 changed files with 22,494 additions and 845 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,36 @@
 # Changelog
 
+## [v6.0.0](https://github.com/fastly/fastly-php/releases/tag/release/v6.0.0) (2024-12-05)
+
+**Breaking Changes:**
+
+- fix(udm-domains): Use v1 versioned HTTP endpoints for UDM domains
+- fix(historical): Remove references to VCL on Compute metrics
+- fix(realtime): Remove references to VCL on Compute metrics
+- feat(billing-usage-metrics): Updated to v3 of the API
+
+**Bug fixes:**
+
+- fix(acls-in-compute): Corrected shape of `compute-acl-update` model.
+
+**Enhancements:**
+
+- feat(object-storage-access-keys): Added Object Storage Access Keys API
+- feat(logging-grafanacloudlogs): Added Grafana Cloud Logs Loggin API
+- feat(log-explorer): Added Log Explorer API
+- feat(insights): Added Insights API
+- feat(kv-store-item): Added `consistency` parameter to `get-keys` operation.
+- feat(enabled-products): Added `mode` property to `set-configuration`.
+
+**Documentation:**
+
+- doc(observability-custom-dashboards): Fix bad link in custom dashboard documentation
+- doc(observability-custom-dashboards): Reformat some enums to fix docs rendering
+- doc(acls-in-compute): Corrections to descriptions of `compute-acl-lookup`, `compute-acl-list-entries`,
+                        `compute-acl-update-entry`, and `compute-acl-update` structures
+- doc(enabled-products): Added support for product ID `log_explorer_insights`.
+- doc(enabled-products): Added support for product ID `ddos_protection`.
+
 ## [v5.10.0](https://github.com/fastly/fastly-php/releases/tag/release/v5.10.0) (2024-10-23)
 
 **Documentation:**

diff --git a/README.md b/README.md
@@ -128,7 +128,7 @@ Class | Method | Description
 [*BillingInvoicesApi*](docs/Api/BillingInvoicesApi.md) | [**getMonthToDateInvoice**](docs/Api/BillingInvoicesApi.md#getmonthtodateinvoice) | Get month-to-date invoice.
 [*BillingInvoicesApi*](docs/Api/BillingInvoicesApi.md) | [**listInvoices**](docs/Api/BillingInvoicesApi.md#listinvoices) | List of invoices.
 [*BillingUsageMetricsApi*](docs/Api/BillingUsageMetricsApi.md) | [**getServiceLevelUsage**](docs/Api/BillingUsageMetricsApi.md#getservicelevelusage) | Retrieve service-level usage metrics for a product.
-[*BillingUsageMetricsApi*](docs/Api/BillingUsageMetricsApi.md) | [**getServiceLevelUsageTypes**](docs/Api/BillingUsageMetricsApi.md#getservicelevelusagetypes) | Retrieve product usage types for a customer.
+[*BillingUsageMetricsApi*](docs/Api/BillingUsageMetricsApi.md) | [**getUsageMetrics**](docs/Api/BillingUsageMetricsApi.md#getusagemetrics) | Get monthly usage metrics
 [*CacheSettingsApi*](docs/Api/CacheSettingsApi.md) | [**createCacheSettings**](docs/Api/CacheSettingsApi.md#createcachesettings) | Create a cache settings object
 [*CacheSettingsApi*](docs/Api/CacheSettingsApi.md) | [**deleteCacheSettings**](docs/Api/CacheSettingsApi.md#deletecachesettings) | Delete a cache settings object
 [*CacheSettingsApi*](docs/Api/CacheSettingsApi.md) | [**getCacheSettings**](docs/Api/CacheSettingsApi.md#getcachesettings) | Get a cache settings object
@@ -266,6 +266,7 @@ Class | Method | Description
 [*IamUserGroupsApi*](docs/Api/IamUserGroupsApi.md) | [**updateAUserGroup**](docs/Api/IamUserGroupsApi.md#updateausergroup) | Update a user group
 [*ImageOptimizerDefaultSettingsApi*](docs/Api/ImageOptimizerDefaultSettingsApi.md) | [**getDefaultSettings**](docs/Api/ImageOptimizerDefaultSettingsApi.md#getdefaultsettings) | Get current Image Optimizer Default Settings
 [*ImageOptimizerDefaultSettingsApi*](docs/Api/ImageOptimizerDefaultSettingsApi.md) | [**updateDefaultSettings**](docs/Api/ImageOptimizerDefaultSettingsApi.md#updatedefaultsettings) | Update Image Optimizer Default Settings
+[*InsightsApi*](docs/Api/InsightsApi.md) | [**getLogInsights**](docs/Api/InsightsApi.md#getloginsights) | Retrieve log insights
 [*InvitationsApi*](docs/Api/InvitationsApi.md) | [**createInvitation**](docs/Api/InvitationsApi.md#createinvitation) | Create an invitation
 [*InvitationsApi*](docs/Api/InvitationsApi.md) | [**deleteInvitation**](docs/Api/InvitationsApi.md#deleteinvitation) | Delete an invitation
 [*InvitationsApi*](docs/Api/InvitationsApi.md) | [**listInvitations**](docs/Api/InvitationsApi.md#listinvitations) | List invitations
@@ -305,6 +306,7 @@ Class | Method | Description
 [*LegacyWafTagApi*](docs/Api/LegacyWafTagApi.md) | [**listLegacyWafTags**](docs/Api/LegacyWafTagApi.md#listlegacywaftags) | List WAF tags
 [*LegacyWafUpdateStatusApi*](docs/Api/LegacyWafUpdateStatusApi.md) | [**getWafUpdateStatus**](docs/Api/LegacyWafUpdateStatusApi.md#getwafupdatestatus) | Get the status of a WAF update
 [*LegacyWafUpdateStatusApi*](docs/Api/LegacyWafUpdateStatusApi.md) | [**listWafUpdateStatuses**](docs/Api/LegacyWafUpdateStatusApi.md#listwafupdatestatuses) | List update statuses
+[*LogExplorerApi*](docs/Api/LogExplorerApi.md) | [**getLogRecords**](docs/Api/LogExplorerApi.md#getlogrecords) | Retrieve log records
 [*LoggingAzureblobApi*](docs/Api/LoggingAzureblobApi.md) | [**createLogAzure**](docs/Api/LoggingAzureblobApi.md#createlogazure) | Create an Azure Blob Storage log endpoint
 [*LoggingAzureblobApi*](docs/Api/LoggingAzureblobApi.md) | [**deleteLogAzure**](docs/Api/LoggingAzureblobApi.md#deletelogazure) | Delete the Azure Blob Storage log endpoint
 [*LoggingAzureblobApi*](docs/Api/LoggingAzureblobApi.md) | [**getLogAzure**](docs/Api/LoggingAzureblobApi.md#getlogazure) | Get an Azure Blob Storage log endpoint
@@ -345,6 +347,11 @@ Class | Method | Description
 [*LoggingGcsApi*](docs/Api/LoggingGcsApi.md) | [**getLogGcs**](docs/Api/LoggingGcsApi.md#getloggcs) | Get a GCS log endpoint
 [*LoggingGcsApi*](docs/Api/LoggingGcsApi.md) | [**listLogGcs**](docs/Api/LoggingGcsApi.md#listloggcs) | List GCS log endpoints
 [*LoggingGcsApi*](docs/Api/LoggingGcsApi.md) | [**updateLogGcs**](docs/Api/LoggingGcsApi.md#updateloggcs) | Update a GCS log endpoint
+[*LoggingGrafanacloudlogsApi*](docs/Api/LoggingGrafanacloudlogsApi.md) | [**createLogGrafanacloudlogs**](docs/Api/LoggingGrafanacloudlogsApi.md#createloggrafanacloudlogs) | Create a Grafana Cloud Logs log endpoint
+[*LoggingGrafanacloudlogsApi*](docs/Api/LoggingGrafanacloudlogsApi.md) | [**deleteLogGrafanacloudlogs**](docs/Api/LoggingGrafanacloudlogsApi.md#deleteloggrafanacloudlogs) | Delete the Grafana Cloud Logs log endpoint
+[*LoggingGrafanacloudlogsApi*](docs/Api/LoggingGrafanacloudlogsApi.md) | [**getLogGrafanacloudlogs**](docs/Api/LoggingGrafanacloudlogsApi.md#getloggrafanacloudlogs) | Get a Grafana Cloud Logs log endpoint
+[*LoggingGrafanacloudlogsApi*](docs/Api/LoggingGrafanacloudlogsApi.md) | [**listLogGrafanacloudlogs**](docs/Api/LoggingGrafanacloudlogsApi.md#listloggrafanacloudlogs) | List Grafana Cloud Logs log endpoints
+[*LoggingGrafanacloudlogsApi*](docs/Api/LoggingGrafanacloudlogsApi.md) | [**updateLogGrafanacloudlogs**](docs/Api/LoggingGrafanacloudlogsApi.md#updateloggrafanacloudlogs) | Update a Grafana Cloud Logs log endpoint
 [*LoggingHerokuApi*](docs/Api/LoggingHerokuApi.md) | [**createLogHeroku**](docs/Api/LoggingHerokuApi.md#createlogheroku) | Create a Heroku log endpoint
 [*LoggingHerokuApi*](docs/Api/LoggingHerokuApi.md) | [**deleteLogHeroku**](docs/Api/LoggingHerokuApi.md#deletelogheroku) | Delete the Heroku log endpoint
 [*LoggingHerokuApi*](docs/Api/LoggingHerokuApi.md) | [**getLogHeroku**](docs/Api/LoggingHerokuApi.md#getlogheroku) | Get a Heroku log endpoint
@@ -445,6 +452,10 @@ Class | Method | Description
 [*MutualAuthenticationApi*](docs/Api/MutualAuthenticationApi.md) | [**getMutualAuthentication**](docs/Api/MutualAuthenticationApi.md#getmutualauthentication) | Get a Mutual Authentication
 [*MutualAuthenticationApi*](docs/Api/MutualAuthenticationApi.md) | [**listMutualAuthentications**](docs/Api/MutualAuthenticationApi.md#listmutualauthentications) | List Mutual Authentications
 [*MutualAuthenticationApi*](docs/Api/MutualAuthenticationApi.md) | [**patchMutualAuthentication**](docs/Api/MutualAuthenticationApi.md#patchmutualauthentication) | Update a Mutual Authentication
+[*ObjectStorageAccessKeysApi*](docs/Api/ObjectStorageAccessKeysApi.md) | [**createAccessKey**](docs/Api/ObjectStorageAccessKeysApi.md#createaccesskey) | Create an access key
+[*ObjectStorageAccessKeysApi*](docs/Api/ObjectStorageAccessKeysApi.md) | [**deleteAccessKey**](docs/Api/ObjectStorageAccessKeysApi.md#deleteaccesskey) | Delete an access key
+[*ObjectStorageAccessKeysApi*](docs/Api/ObjectStorageAccessKeysApi.md) | [**getAccessKey**](docs/Api/ObjectStorageAccessKeysApi.md#getaccesskey) | Get an access key
+[*ObjectStorageAccessKeysApi*](docs/Api/ObjectStorageAccessKeysApi.md) | [**listAccessKeys**](docs/Api/ObjectStorageAccessKeysApi.md#listaccesskeys) | List access keys
 [*ObservabilityCustomDashboardsApi*](docs/Api/ObservabilityCustomDashboardsApi.md) | [**createDashboard**](docs/Api/ObservabilityCustomDashboardsApi.md#createdashboard) | Create a new dashboard
 [*ObservabilityCustomDashboardsApi*](docs/Api/ObservabilityCustomDashboardsApi.md) | [**deleteDashboard**](docs/Api/ObservabilityCustomDashboardsApi.md#deletedashboard) | Delete an existing dashboard
 [*ObservabilityCustomDashboardsApi*](docs/Api/ObservabilityCustomDashboardsApi.md) | [**getDashboard**](docs/Api/ObservabilityCustomDashboardsApi.md#getdashboard) | Retrieve a dashboard by ID
@@ -653,8 +664,8 @@ The fastly-php API client currently does not support the following endpoints:
 - [`/alerts/history`](https://www.fastly.com/documentation/reference/api/observability/alerts/history) (GET)
 - [`/dns/configurations/{dns_configuration_id}`](https://www.fastly.com/documentation/reference/api/) (DELETE, GET, PATCH)
 - [`/dns/configurations`](https://www.fastly.com/documentation/reference/api/) (GET, POST)
-- [`/domains/{domain_id}`](https://www.fastly.com/documentation/reference/api/) (DELETE, GET, PATCH)
-- [`/domains`](https://www.fastly.com/documentation/reference/api/) (GET, POST)
+- [`/domains/v1/{domain_id}`](https://www.fastly.com/documentation/reference/api/) (DELETE, GET, PATCH)
+- [`/domains/v1`](https://www.fastly.com/documentation/reference/api/) (GET, POST)
 - [`/notifications/integration-types`](https://developer.fastly.com/reference/api/observability/notification) (GET)
 - [`/notifications/integrations/{integration_id}/rotateSigningKey`](https://developer.fastly.com/reference/api/observability/notification) (POST)
 - [`/notifications/integrations/{integration_id}/signingKey`](https://developer.fastly.com/reference/api/observability/notification) (GET)

diff --git a/docs/Api/AclsInComputeApi.md b/docs/Api/AclsInComputeApi.md
@@ -244,7 +244,7 @@ Update an ACL.
 ### Example
 ```php
     $options['acl_id'] = 'acl_id_example'; // string
-$options['compute_acl_update_entry'] = array(new \Fastly\Model\ComputeAclUpdateEntry()); // \Fastly\Model\ComputeAclUpdateEntry[]
+$options['compute_acl_update'] = new \Fastly\Model\ComputeAclUpdate(); // \Fastly\Model\ComputeAclUpdate
 
 try {
     $apiInstance->computeAclUpdateAcls($options);
@@ -260,7 +260,7 @@ Note: the input parameter is an associative array with the keys listed below.
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
 **acl_id** | **string** |  |
-**compute_acl_update_entry** | [**\Fastly\Model\ComputeAclUpdateEntry[]**](../Model/ComputeAclUpdateEntry.md) |  | [optional]
+**compute_acl_update** | [**\Fastly\Model\ComputeAclUpdate**](../Model/ComputeAclUpdate.md) |  | [optional]
 
 ### Return type
 

diff --git a/docs/Api/BillingUsageMetricsApi.md b/docs/Api/BillingUsageMetricsApi.md
@@ -17,8 +17,8 @@ $apiInstance = new Fastly\Api\BillingUsageMetricsApi(
 
 Method | HTTP request | Description
 ------ | ------------ | -----------
-[**getServiceLevelUsage()**](BillingUsageMetricsApi.md#getServiceLevelUsage) | **GET** /billing/v2/account_customers/{customer_id}/service-usage-metrics | Retrieve service-level usage metrics for a product.
-[**getServiceLevelUsageTypes()**](BillingUsageMetricsApi.md#getServiceLevelUsageTypes) | **GET** /billing/v2/account_customers/{customer_id}/service-usage-types | Retrieve product usage types for a customer.
+[**getServiceLevelUsage()**](BillingUsageMetricsApi.md#getServiceLevelUsage) | **GET** /billing/v3/service-usage-metrics | Retrieve service-level usage metrics for a product.
+[**getUsageMetrics()**](BillingUsageMetricsApi.md#getUsageMetrics) | **GET** /billing/v3/usage-metrics | Get monthly usage metrics
 
 
 ## `getServiceLevelUsage()`
@@ -31,12 +31,8 @@ Returns product usage, broken down by service.
 
 ### Example
 ```php
-    $options['customer_id'] = 'customer_id_example'; // string | Alphanumeric string identifying the customer.
-$options['product_id'] = 'product_id_example'; // string | The product identifier for the metrics returned (e.g., `cdn_usage`). This field is not required for CSV requests.
+    $options['product_id'] = 'product_id_example'; // string | The product identifier for the metrics returned (e.g., `cdn_usage`). This field is not required for CSV requests.
 $options['usage_type_name'] = 'usage_type_name_example'; // string | The usage type name for the metrics returned (e.g., `North America Requests`). This field is not required for CSV requests.
-$options['time_granularity'] = 'time_granularity_example'; // string
-$options['start_date'] = 2023-01-01; // string
-$options['end_date'] = 2023-01-31; // string
 $options['start_month'] = 2023-01; // string
 $options['end_month'] = 2023-03; // string
 $options['limit'] = '5'; // string | Number of results per page. The maximum is 100.
@@ -55,12 +51,8 @@ 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. |
 **product_id** | **string** | The product identifier for the metrics returned (e.g., `cdn_usage`). This field is not required for CSV requests. |
 **usage_type_name** | **string** | The usage type name for the metrics returned (e.g., `North America Requests`). This field is not required for CSV requests. |
-**time_granularity** | **string** |  |
-**start_date** | **string** |  | [optional]
-**end_date** | **string** |  | [optional]
 **start_month** | **string** |  | [optional]
 **end_month** | **string** |  | [optional]
 **limit** | **string** | Number of results per page. The maximum is 100. | [optional] [defaults to '5']
@@ -73,22 +65,23 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
 [[Back to README]](../../README.md)
 
-## `getServiceLevelUsageTypes()`
+## `getUsageMetrics()`
 
 ```php
-getServiceLevelUsageTypes($options): \Fastly\Model\Serviceusagetypes // Retrieve product usage types for a customer.
+getUsageMetrics($options): \Fastly\Model\Usagemetric // Get monthly usage metrics
 ```
 
-Returns product usage types reported by the customer's services.
+Returns monthly usage metrics for customer by product.
 
 ### Example
 ```php
-    $options['customer_id'] = 'customer_id_example'; // string | Alphanumeric string identifying the customer.
+    $options['start_month'] = 2023-01; // string
+$options['end_month'] = 2023-03; // string
 
 try {
-    $result = $apiInstance->getServiceLevelUsageTypes($options);
+    $result = $apiInstance->getUsageMetrics($options);
 } catch (Exception $e) {
-    echo 'Exception when calling BillingUsageMetricsApi->getServiceLevelUsageTypes: ', $e->getMessage(), PHP_EOL;
+    echo 'Exception when calling BillingUsageMetricsApi->getUsageMetrics: ', $e->getMessage(), PHP_EOL;
 }
 ```
 
@@ -98,11 +91,12 @@ 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. |
+**start_month** | **string** |  | [optional]
+**end_month** | **string** |  | [optional]
 
 ### Return type
 
-[**\Fastly\Model\Serviceusagetypes**](../Model/Serviceusagetypes.md)
+[**\Fastly\Model\Usagemetric**](../Model/Usagemetric.md)
 
 [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
 [[Back to README]](../../README.md)
diff --git a/docs/Api/EnabledProductsApi.md b/docs/Api/EnabledProductsApi.md
@@ -30,7 +30,7 @@ Method | HTTP request | Description
 disableProduct($options) // Disable a product
 ```
 
-Disable a product on a service. Supported product IDs: `brotli_compression`,`domain_inspector`,`fanout`,`image_optimizer`,`origin_inspector`, `websockets`, `bot_management`, and `ngwaf`.
+Disable a product on a service. Supported product IDs: `brotli_compression`,`domain_inspector`,`fanout`,`image_optimizer`,`origin_inspector`, `websockets`, `bot_management`, `ngwaf`, `ddos_protection`, and `log_explorer_insights`.
 
 ### Example
 ```php
@@ -66,7 +66,7 @@ void (empty response body)
 enableProduct($options): \Fastly\Model\EnabledProductResponse // Enable a product
 ```
 
-Enable a product on a service. Supported product IDs: `brotli_compression`,`domain_inspector`,`fanout`,`image_optimizer`,`origin_inspector`, `websockets`, `bot_management`, and `ngwaf`.
+Enable a product on a service. Supported product IDs: `brotli_compression`,`domain_inspector`,`fanout`,`image_optimizer`,`origin_inspector`, `websockets`, `bot_management`, `ngwaf`, `ddos_protection`, and `log_explorer_insights`.
 
 ### Example
 ```php
@@ -104,7 +104,7 @@ Name | Type | Description  | Notes
 getEnabledProduct($options): \Fastly\Model\EnabledProductResponse // Get enabled product
 ```
 
-Get enabled product on a service. Supported product IDs: `brotli_compression`,`domain_inspector`,`fanout`,`image_optimizer`,`origin_inspector`, `websockets`, `bot_management`, and `ngwaf`.
+Get enabled product on a service. Supported product IDs: `brotli_compression`,`domain_inspector`,`fanout`,`image_optimizer`,`origin_inspector`, `websockets`, `bot_management`, `ngwaf`, `ddos_protection`, and `log_explorer_insights`.
 
 ### Example
 ```php
@@ -140,7 +140,7 @@ Name | Type | Description  | Notes
 getProductConfiguration($options): \Fastly\Model\ConfiguredProductResponse // Get configuration for a product
 ```
 
-Get configuration for an enabled product on a service. Supported product IDs: `ngwaf`.
+Get configuration for an enabled product on a service. Supported product IDs: `ngwaf` and `ddos_protection`.
 
 ### Example
 ```php
@@ -176,7 +176,7 @@ Name | Type | Description  | Notes
 setProductConfiguration($options): \Fastly\Model\ConfiguredProductResponse // Update configuration for a product
 ```
 
-Update configuration for an enabled product on a service. Supported product IDs: `ngwaf`.
+Update configuration for an enabled product on a service. Supported product IDs: `ngwaf` and `ddos_protection`.
 
 ### Example
 ```php