Generated v6.0.0

fastly · Dec 6, 2024 · bf29ec7 · bf29ec7
1 parent 909acd5
commit bf29ec7
Show file tree

Hide file tree

Showing 123 changed files with 15,776 additions and 320 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,36 @@
 # Changelog
 
+## [v6.0.0](https://github.com/fastly/fastly-py/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-py/releases/tag/release/v5.10.0) (2024-10-23)
 
 **Bug fixes:**

diff --git a/README.md b/README.md
@@ -107,7 +107,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
@@ -245,6 +245,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
@@ -284,6 +285,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
@@ -324,6 +326,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
@@ -424,6 +431,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
@@ -632,8 +643,8 @@ The fastly-py 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,14 @@
+# AccessKey
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **str** | A description of the access key. | 
+**permission** | **str** | The permissions granted to an access key. | 
+**buckets** | **[str]** |  | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[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,17 @@
+# AccessKeyResponse
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**access_key** | **str** | Generated access key. | [optional] 
+**secret_key** | **str** | Generated secret key. | [optional] 
+**description** | **str** | Description for the access key. | [optional] 
+**permission** | **str** | Permissions granted to an access key. | [optional] 
+**buckets** | **[str]** |  | [optional] 
+**created_at** | **datetime, none_type** | Date and time in ISO 8601 format. | [optional] [readonly] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[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
@@ -536,13 +536,15 @@ with fastly.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = acls_in_compute_api.AclsInComputeApi(api_client)
     acl_id = "acl_id_example" # str | 
-    compute_acl_update = ComputeAclUpdate([
-        ComputeAclUpdateEntry(
-            op="op_example",
-            prefix="prefix_example",
-            action="action_example",
-        ),
-    ]) # ComputeAclUpdate |  (optional)
+    compute_acl_update = ComputeAclUpdate(
+        entries=[
+            ComputeAclUpdateEntry(
+                op="op_example",
+                prefix="prefix_example",
+                action="action_example",
+            ),
+        ],
+    ) # ComputeAclUpdate |  (optional)
 
     # example passing only required values which don't have defaults set
     try:

diff --git a/docs/BillingUsageMetricsApi.md b/docs/BillingUsageMetricsApi.md
@@ -5,12 +5,12 @@
 
 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
 
 
 # **get_service_level_usage**
-> Serviceusagemetrics get_service_level_usage(customer_id, product_id, usage_type_name, time_granularity)
+> Serviceusagemetrics get_service_level_usage(product_id, usage_type_name)
 
 Retrieve service-level usage metrics for a product.
 
@@ -48,12 +48,8 @@ configuration.api_key['token'] = 'YOUR_API_KEY'
 with fastly.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = billing_usage_metrics_api.BillingUsageMetricsApi(api_client)
-    customer_id = "x4xCwxxJxGCx123Rx5xTx" # str | Alphanumeric string identifying the customer.
     product_id = "product_id_example" # str | The product identifier for the metrics returned (e.g., `cdn_usage`). This field is not required for CSV requests.
     usage_type_name = "usage_type_name_example" # str | The usage type name for the metrics returned (e.g., `North America Requests`). This field is not required for CSV requests.
-    time_granularity = "month" # str | 
-    start_date = "2023-01-01" # str |  (optional)
-    end_date = "2023-01-31" # str |  (optional)
     start_month = "2023-01" # str |  (optional)
     end_month = "2023-03" # str |  (optional)
     limit = "5" # str | Number of results per page. The maximum is 100. (optional) if omitted the server will use the default value of "5"
@@ -62,7 +58,7 @@ with fastly.ApiClient(configuration) as api_client:
     # example passing only required values which don't have defaults set
     try:
         # Retrieve service-level usage metrics for a product.
-        api_response = api_instance.get_service_level_usage(customer_id, product_id, usage_type_name, time_granularity)
+        api_response = api_instance.get_service_level_usage(product_id, usage_type_name)
         pprint(api_response)
     except fastly.ApiException as e:
         print("Exception when calling BillingUsageMetricsApi->get_service_level_usage: %s\n" % e)
@@ -71,7 +67,7 @@ with fastly.ApiClient(configuration) as api_client:
     # and optional values
     try:
         # Retrieve service-level usage metrics for a product.
-        api_response = api_instance.get_service_level_usage(customer_id, product_id, usage_type_name, time_granularity, start_date=start_date, end_date=end_date, start_month=start_month, end_month=end_month, limit=limit, cursor=cursor)
+        api_response = api_instance.get_service_level_usage(product_id, usage_type_name, start_month=start_month, end_month=end_month, limit=limit, cursor=cursor)
         pprint(api_response)
     except fastly.ApiException as e:
         print("Exception when calling BillingUsageMetricsApi->get_service_level_usage: %s\n" % e)
@@ -82,12 +78,8 @@ with fastly.ApiClient(configuration) as api_client:
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **customer_id** | **str**| Alphanumeric string identifying the customer. |
  **product_id** | **str**| The product identifier for the metrics returned (e.g., `cdn_usage`). This field is not required for CSV requests. |
  **usage_type_name** | **str**| The usage type name for the metrics returned (e.g., `North America Requests`). This field is not required for CSV requests. |
- **time_granularity** | **str**|  |
- **start_date** | **str**|  | [optional]
- **end_date** | **str**|  | [optional]
  **start_month** | **str**|  | [optional]
  **end_month** | **str**|  | [optional]
  **limit** | **str**| Number of results per page. The maximum is 100. | [optional] if omitted the server will use the default value of "5"
@@ -118,12 +110,12 @@ Name | Type | Description  | Notes
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
-# **get_service_level_usage_types**
-> Serviceusagetypes get_service_level_usage_types(customer_id)
+# **get_usage_metrics**
+> Usagemetric get_usage_metrics()
 
-Retrieve product usage types for a customer.
+Get monthly usage metrics
 
-Returns product usage types reported by the customer's services.
+Returns monthly usage metrics for customer by product.
 
 ### Example
 
@@ -134,7 +126,7 @@ import time
 import fastly
 from fastly.api import billing_usage_metrics_api
 from fastly.model.error import Error
-from fastly.model.serviceusagetypes import Serviceusagetypes
+from fastly.model.usagemetric import Usagemetric
 from pprint import pprint
 # Defining the host is optional and defaults to https://api.fastly.com
 # See configuration.py for a list of all supported configuration parameters.
@@ -157,27 +149,30 @@ configuration.api_key['token'] = 'YOUR_API_KEY'
 with fastly.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = billing_usage_metrics_api.BillingUsageMetricsApi(api_client)
-    customer_id = "x4xCwxxJxGCx123Rx5xTx" # str | Alphanumeric string identifying the customer.
+    start_month = "2023-01" # str |  (optional)
+    end_month = "2023-03" # str |  (optional)
 
     # example passing only required values which don't have defaults set
+    # and optional values
     try:
-        # Retrieve product usage types for a customer.
-        api_response = api_instance.get_service_level_usage_types(customer_id)
+        # Get monthly usage metrics
+        api_response = api_instance.get_usage_metrics(start_month=start_month, end_month=end_month)
         pprint(api_response)
     except fastly.ApiException as e:
-        print("Exception when calling BillingUsageMetricsApi->get_service_level_usage_types: %s\n" % e)
+        print("Exception when calling BillingUsageMetricsApi->get_usage_metrics: %s\n" % e)
 ```
 
 
 ### Parameters
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **customer_id** | **str**| Alphanumeric string identifying the customer. |
+ **start_month** | **str**|  | [optional]
+ **end_month** | **str**|  | [optional]
 
 ### Return type
 
-[**Serviceusagetypes**](Serviceusagetypes.md)
+[**Usagemetric**](Usagemetric.md)
 
 ### Authorization
 
@@ -193,7 +188,7 @@ Name | Type | Description  | Notes
 
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-**200** | A response containing usage elements. |  -  |
+**200** | A response containing usage metric elements. |  -  |
 **400** | Bad Request |  -  |
 **401** | Unauthorized |  -  |
 **500** | Internal Server Error |  -  |

diff --git a/docs/ComputeAclListEntries.md b/docs/ComputeAclListEntries.md
@@ -1,6 +1,6 @@
 # ComputeAclListEntries
 
-An example of an ACL List Response.
+Defines the structure of what the ACL List endpoint returns.
 
 ## Properties
 Name | Type | Description | Notes

diff --git a/docs/ComputeAclLookup.md b/docs/ComputeAclLookup.md
@@ -1,6 +1,6 @@
 # ComputeAclLookup
 
-An example of an ACL Lookup response.
+Defines the structure of an ACL Lookup response.
 
 ## Properties
 Name | Type | Description | Notes

diff --git a/docs/ComputeAclUpdate.md b/docs/ComputeAclUpdate.md
@@ -1,11 +1,12 @@
 # ComputeAclUpdate
 
-An example of an ACL update request.
+Defines the structure of an ACL update request array.
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**value** | [**[ComputeAclUpdateEntry]**](ComputeAclUpdateEntry.md) | An example of an ACL update request. | 
+**entries** | [**[ComputeAclUpdateEntry]**](ComputeAclUpdateEntry.md) |  | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/ComputeAclUpdateEntry.md b/docs/ComputeAclUpdateEntry.md
@@ -1,6 +1,6 @@
 # ComputeAclUpdateEntry
 
-An example of an ACL update request entry.
+Defines the structure of an ACL update request entry.
 
 ## Properties
 Name | Type | Description | Notes