Generated v5.0.0

fastly · Dec 6, 2024 · d127180 · d127180
1 parent 3aee570
commit d127180
Show file tree

Hide file tree

Showing 116 changed files with 3,791 additions and 173 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,36 @@
 # Changelog
 
+## [v5.0.0](https://github.com/fastly/fastly-rust/releases/tag/release/v5.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`.
+
 ## [v4.13.0](https://github.com/fastly/fastly-rust/releases/tag/release/v4.13.0) (2024-10-23)
 
 **Documentation:**

diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "fastly-api"
-version = "4.13.0"
+version = "5.0.0"
 authors = ["Fastly <[email protected]>"]
 edition = "2021"
 description = "Fastly API client"

diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@ Rust 2021 Edition
 Add the following to `Cargo.toml` under `[dependencies]`:
 
 ```toml
-fastly-api = "4.13.0"
+fastly-api = "5.0.0"
 ```
 
 ## Usage
@@ -126,7 +126,7 @@ Class | Method | Description
 *BillingInvoicesApi* | [**get_month_to_date_invoice**](docs/BillingInvoicesApi.md#get_month_to_date_invoice) | Get month-to-date invoice.
 *BillingInvoicesApi* | [**list_invoices**](docs/BillingInvoicesApi.md#list_invoices) | List of invoices.
 *BillingUsageMetricsApi* | [**get_service_level_usage**](docs/BillingUsageMetricsApi.md#get_service_level_usage) | Retrieve service-level usage metrics for a product.
-*BillingUsageMetricsApi* | [**get_service_level_usage_types**](docs/BillingUsageMetricsApi.md#get_service_level_usage_types) | Retrieve product usage types for a customer.
+*BillingUsageMetricsApi* | [**get_usage_metrics**](docs/BillingUsageMetricsApi.md#get_usage_metrics) | Get monthly usage metrics
 *CacheSettingsApi* | [**create_cache_settings**](docs/CacheSettingsApi.md#create_cache_settings) | Create a cache settings object
 *CacheSettingsApi* | [**delete_cache_settings**](docs/CacheSettingsApi.md#delete_cache_settings) | Delete a cache settings object
 *CacheSettingsApi* | [**get_cache_settings**](docs/CacheSettingsApi.md#get_cache_settings) | Get a cache settings object
@@ -253,6 +253,7 @@ Class | Method | Description
 *IamUserGroupsApi* | [**update_a_user_group**](docs/IamUserGroupsApi.md#update_a_user_group) | Update a user group
 *ImageOptimizerDefaultSettingsApi* | [**get_default_settings**](docs/ImageOptimizerDefaultSettingsApi.md#get_default_settings) | Get current Image Optimizer Default Settings
 *ImageOptimizerDefaultSettingsApi* | [**update_default_settings**](docs/ImageOptimizerDefaultSettingsApi.md#update_default_settings) | Update Image Optimizer Default Settings
+*InsightsApi* | [**get_log_insights**](docs/InsightsApi.md#get_log_insights) | Retrieve log insights
 *InvitationsApi* | [**create_invitation**](docs/InvitationsApi.md#create_invitation) | Create an invitation
 *InvitationsApi* | [**delete_invitation**](docs/InvitationsApi.md#delete_invitation) | Delete an invitation
 *InvitationsApi* | [**list_invitations**](docs/InvitationsApi.md#list_invitations) | List invitations
@@ -292,6 +293,7 @@ Class | Method | Description
 *LegacyWafTagApi* | [**list_legacy_waf_tags**](docs/LegacyWafTagApi.md#list_legacy_waf_tags) | List WAF tags
 *LegacyWafUpdateStatusApi* | [**get_waf_update_status**](docs/LegacyWafUpdateStatusApi.md#get_waf_update_status) | Get the status of a WAF update
 *LegacyWafUpdateStatusApi* | [**list_waf_update_statuses**](docs/LegacyWafUpdateStatusApi.md#list_waf_update_statuses) | List update statuses
+*LogExplorerApi* | [**get_log_records**](docs/LogExplorerApi.md#get_log_records) | Retrieve log records
 *LoggingAzureblobApi* | [**create_log_azure**](docs/LoggingAzureblobApi.md#create_log_azure) | Create an Azure Blob Storage log endpoint
 *LoggingAzureblobApi* | [**delete_log_azure**](docs/LoggingAzureblobApi.md#delete_log_azure) | Delete the Azure Blob Storage log endpoint
 *LoggingAzureblobApi* | [**get_log_azure**](docs/LoggingAzureblobApi.md#get_log_azure) | Get an Azure Blob Storage log endpoint
@@ -332,6 +334,11 @@ Class | Method | Description
 *LoggingGcsApi* | [**get_log_gcs**](docs/LoggingGcsApi.md#get_log_gcs) | Get a GCS log endpoint
 *LoggingGcsApi* | [**list_log_gcs**](docs/LoggingGcsApi.md#list_log_gcs) | List GCS log endpoints
 *LoggingGcsApi* | [**update_log_gcs**](docs/LoggingGcsApi.md#update_log_gcs) | Update a GCS log endpoint
+*LoggingGrafanacloudlogsApi* | [**create_log_grafanacloudlogs**](docs/LoggingGrafanacloudlogsApi.md#create_log_grafanacloudlogs) | Create a Grafana Cloud Logs log endpoint
+*LoggingGrafanacloudlogsApi* | [**delete_log_grafanacloudlogs**](docs/LoggingGrafanacloudlogsApi.md#delete_log_grafanacloudlogs) | Delete the Grafana Cloud Logs log endpoint
+*LoggingGrafanacloudlogsApi* | [**get_log_grafanacloudlogs**](docs/LoggingGrafanacloudlogsApi.md#get_log_grafanacloudlogs) | Get a Grafana Cloud Logs log endpoint
+*LoggingGrafanacloudlogsApi* | [**list_log_grafanacloudlogs**](docs/LoggingGrafanacloudlogsApi.md#list_log_grafanacloudlogs) | List Grafana Cloud Logs log endpoints
+*LoggingGrafanacloudlogsApi* | [**update_log_grafanacloudlogs**](docs/LoggingGrafanacloudlogsApi.md#update_log_grafanacloudlogs) | Update a Grafana Cloud Logs log endpoint
 *LoggingHerokuApi* | [**create_log_heroku**](docs/LoggingHerokuApi.md#create_log_heroku) | Create a Heroku log endpoint
 *LoggingHerokuApi* | [**delete_log_heroku**](docs/LoggingHerokuApi.md#delete_log_heroku) | Delete the Heroku log endpoint
 *LoggingHerokuApi* | [**get_log_heroku**](docs/LoggingHerokuApi.md#get_log_heroku) | Get a Heroku log endpoint
@@ -432,6 +439,10 @@ Class | Method | Description
 *MutualAuthenticationApi* | [**get_mutual_authentication**](docs/MutualAuthenticationApi.md#get_mutual_authentication) | Get a Mutual Authentication
 *MutualAuthenticationApi* | [**list_mutual_authentications**](docs/MutualAuthenticationApi.md#list_mutual_authentications) | List Mutual Authentications
 *MutualAuthenticationApi* | [**patch_mutual_authentication**](docs/MutualAuthenticationApi.md#patch_mutual_authentication) | Update a Mutual Authentication
+*ObjectStorageAccessKeysApi* | [**create_access_key**](docs/ObjectStorageAccessKeysApi.md#create_access_key) | Create an access key
+*ObjectStorageAccessKeysApi* | [**delete_access_key**](docs/ObjectStorageAccessKeysApi.md#delete_access_key) | Delete an access key
+*ObjectStorageAccessKeysApi* | [**get_access_key**](docs/ObjectStorageAccessKeysApi.md#get_access_key) | Get an access key
+*ObjectStorageAccessKeysApi* | [**list_access_keys**](docs/ObjectStorageAccessKeysApi.md#list_access_keys) | List access keys
 *ObservabilityCustomDashboardsApi* | [**create_dashboard**](docs/ObservabilityCustomDashboardsApi.md#create_dashboard) | Create a new dashboard
 *ObservabilityCustomDashboardsApi* | [**delete_dashboard**](docs/ObservabilityCustomDashboardsApi.md#delete_dashboard) | Delete an existing dashboard
 *ObservabilityCustomDashboardsApi* | [**get_dashboard**](docs/ObservabilityCustomDashboardsApi.md#get_dashboard) | Retrieve a dashboard by ID
@@ -640,8 +651,8 @@ The fastly-rust 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/AccessKey.md b/docs/AccessKey.md
@@ -0,0 +1,13 @@
+# AccessKey
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | A description of the access key. | 
+**permission** | **String** | The permissions granted to an access key. | 
+**buckets** | Option<**Vec<String>**> |  | 
+
+[[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/AccessKeyResponse.md b/docs/AccessKeyResponse.md
@@ -0,0 +1,16 @@
+# AccessKeyResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**access_key** | Option<**String**> | Generated access key. | 
+**secret_key** | Option<**String**> | Generated secret key. | 
+**description** | Option<**String**> | Description for the access key. | 
+**permission** | Option<**String**> | Permissions granted to an access key. | 
+**buckets** | Option<**Vec<String>**> |  | 
+**created_at** | Option<**String**> | Date and time in ISO 8601 format. | [readonly]
+
+[[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/AclsInComputeApi.md b/docs/AclsInComputeApi.md
@@ -243,7 +243,7 @@ compute_acl_update_acls(cfg, params)
 Name | Type | Description  | Required | Notes
 ------------- | ------------- | ------------- | ------------- | -------------
 **acl_id** | **String** |  | [required] |
-**compute_acl_update_entry** | Option\<[**Vec&lt;crate::models::ComputeAclUpdateEntry&gt;**](compute-acl-update-entry.md)> |  |  |
+**compute_acl_update** | Option\<[**ComputeAclUpdate**](ComputeAclUpdate.md)> |  |  |
 
 ### Return type
 

diff --git a/docs/BillingUsageMetricsApi.md b/docs/BillingUsageMetricsApi.md
@@ -5,8 +5,8 @@
 
 Method | HTTP request | Description
 ------ | ------------ | -----------
-[**get_service_level_usage**](BillingUsageMetricsApi.md#get_service_level_usage) | **GET** /billing/v2/account_customers/{customer_id}/service-usage-metrics | Retrieve service-level usage metrics for a product.
-[**get_service_level_usage_types**](BillingUsageMetricsApi.md#get_service_level_usage_types) | **GET** /billing/v2/account_customers/{customer_id}/service-usage-types | Retrieve product usage types for a customer.
+[**get_service_level_usage**](BillingUsageMetricsApi.md#get_service_level_usage) | **GET** /billing/v3/service-usage-metrics | Retrieve service-level usage metrics for a product.
+[**get_usage_metrics**](BillingUsageMetricsApi.md#get_usage_metrics) | **GET** /billing/v3/usage-metrics | Get monthly usage metrics
 
 
 
@@ -27,12 +27,8 @@ get_service_level_usage(cfg, params)
 
 Name | Type | Description  | Required | Notes
 ------------- | ------------- | ------------- | ------------- | -------------
-**customer_id** | **String** | Alphanumeric string identifying the customer. | [required] |
 **product_id** | **String** | The product identifier for the metrics returned (e.g., `cdn_usage`). This field is not required for CSV requests. | [required] |
 **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. | [required] |
-**time_granularity** | **String** |  | [required] |
-**start_date** | Option\<**String**> |  |  |
-**end_date** | Option\<**String**> |  |  |
 **start_month** | Option\<**String**> |  |  |
 **end_month** | Option\<**String**> |  |  |
 **limit** | Option\<**String**> | Number of results per page. The maximum is 100. |  |[default to 5]
@@ -54,28 +50,29 @@ Name | Type | Description  | Required | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
 
-## get_service_level_usage_types
+## get_usage_metrics
 
-Returns product usage types reported by the customer's services.
+Returns monthly usage metrics for customer by product.
 
 ```rust
 let cfg = &Configuration::default();
-let params = GetServiceLevelUsageTypesParams {
+let params = GetUsageMetricsParams {
     // parameters
 };
-get_service_level_usage_types(cfg, params)
+get_usage_metrics(cfg, params)
 ```
 
 ### Parameters
 
 
 Name | Type | Description  | Required | Notes
 ------------- | ------------- | ------------- | ------------- | -------------
-**customer_id** | **String** | Alphanumeric string identifying the customer. | [required] |
+**start_month** | Option\<**String**> |  |  |
+**end_month** | Option\<**String**> |  |  |
 
 ### Return type
 
-[**crate::models::Serviceusagetypes**](Serviceusagetypes.md)
+[**crate::models::Usagemetric**](Usagemetric.md)
 
 ### Authorization
 

diff --git a/docs/ComputeAclUpdate.md b/docs/ComputeAclUpdate.md
@@ -0,0 +1,11 @@
+# ComputeAclUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entries** | Option<[**Vec&lt;crate::models::ComputeAclUpdateEntry&gt;**](ComputeAclUpdateEntry.md)> |  | 
+
+[[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/DimensionAttributesCountryStats.md b/docs/DimensionAttributesCountryStats.md
@@ -0,0 +1,13 @@
+# DimensionAttributesCountryStats
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**country_chr** | Option<**f32**> | The cache hit ratio for the country. | 
+**country_error_rate** | Option<**f32**> | The error rate for the country. | 
+**country_request_rate** | Option<**f32**> | This country's percentage of the total requests. | 
+
+[[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/DimensionAttributesRate.md b/docs/DimensionAttributesRate.md
@@ -0,0 +1,11 @@
+# DimensionAttributesRate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rate** | Option<**f32**> | The rate at which the value in the current dimension occurs. | 
+
+[[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/DimensionBrowser.md b/docs/DimensionBrowser.md
@@ -0,0 +1,11 @@
+# DimensionBrowser
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**browser** | Option<**String**> | The client's browser for this dimension. | 
+
+[[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/DimensionContentType.md b/docs/DimensionContentType.md
@@ -0,0 +1,11 @@
+# DimensionContentType
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content_type** | Option<**String**> | The content type of the response for this dimension. | 
+
+[[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/DimensionCountry.md b/docs/DimensionCountry.md
@@ -0,0 +1,11 @@
+# DimensionCountry
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**country** | Option<**String**> | The client's country for this dimension. | 
+
+[[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/DimensionDevice.md b/docs/DimensionDevice.md
@@ -0,0 +1,11 @@
+# DimensionDevice
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**device** | Option<**String**> | The client's device type for this dimension. | 
+
+[[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/DimensionOs.md b/docs/DimensionOs.md
@@ -0,0 +1,11 @@
+# DimensionOs
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**os** | Option<**String**> | The client's operating system for this dimension. | 
+
+[[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/DimensionResponse.md b/docs/DimensionResponse.md
@@ -0,0 +1,11 @@
+# DimensionResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**response** | Option<**String**> | The HTTP reason phrase for this dimension. | 
+
+[[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/DimensionStatusCode.md b/docs/DimensionStatusCode.md
@@ -0,0 +1,11 @@
+# DimensionStatusCode
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status_code** | Option<**String**> | The HTTP response code for this dimension. | 
+
+[[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/DimensionUrl.md b/docs/DimensionUrl.md
@@ -0,0 +1,11 @@
+# DimensionUrl
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | Option<**String**> | The URL path for this dimension. | 
+
+[[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/EnabledProductsApi.md b/docs/EnabledProductsApi.md
@@ -15,7 +15,7 @@ Method | HTTP request | Description
 
 ## disable_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`.
 
 ```rust
 let cfg = &Configuration::default();
@@ -51,7 +51,7 @@ Name | Type | Description  | Required | Notes
 
 ## enable_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`.
 
 ```rust
 let cfg = &Configuration::default();
@@ -88,7 +88,7 @@ Name | Type | Description  | Required | Notes
 
 ## 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`.
 
 ```rust
 let cfg = &Configuration::default();
@@ -124,7 +124,7 @@ Name | Type | Description  | Required | Notes
 
 ## get_product_configuration
 
-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`.
 
 ```rust
 let cfg = &Configuration::default();
@@ -160,7 +160,7 @@ Name | Type | Description  | Required | Notes
 
 ## set_product_configuration
 
-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`.
 
 ```rust
 let cfg = &Configuration::default();