Generated v4.9.0

fastly · Aug 5, 2024 · c50dc16 · c50dc16
1 parent 6450b54
commit c50dc16
Show file tree

Hide file tree

Showing 106 changed files with 2,941 additions and 48 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,15 @@
 # Changelog
 
+## [v4.9.0](https://github.com/fastly/fastly-rust/releases/tag/release/v4.9.0) (2024-08-04)
+
+**Enhancements:**
+
+- feat(observability): Adds new Observability Custom Dashboards API
+- feat(billing-invoices): Adds month-to-date invoice information
+- feat(billing-usage-metrics): Adds information on service-level usage.
+- feat(tls): Adds an endpoint to get a TLS certificate blob (Limited Availability)
+- feat(stats): Add `origin_offload` metric
+
 ## [v4.8.0](https://github.com/fastly/fastly-rust/releases/tag/release/v4.8.0) (2024-07-01)
 
 **Bug fixes:**

diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "fastly-api"
-version = "4.8.0"
+version = "4.9.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.8.0"
+fastly-api = "4.9.0"
 ```
 
 ## Usage
@@ -116,7 +116,10 @@ Class | Method | Description
 *BillingAddressApi* | [**get_billing_addr**](docs/BillingAddressApi.md#get_billing_addr) | Get a billing address
 *BillingAddressApi* | [**update_billing_addr**](docs/BillingAddressApi.md#update_billing_addr) | Update a billing address
 *BillingInvoicesApi* | [**get_invoice_by_invoice_id**](docs/BillingInvoicesApi.md#get_invoice_by_invoice_id) | Get invoice by ID.
+*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.
 *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
@@ -417,6 +420,11 @@ 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
+*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
+*ObservabilityCustomDashboardsApi* | [**list_dashboards**](docs/ObservabilityCustomDashboardsApi.md#list_dashboards) | List all custom dashboards
+*ObservabilityCustomDashboardsApi* | [**update_dashboard**](docs/ObservabilityCustomDashboardsApi.md#update_dashboard) | Update an existing dashboard
 *OriginInspectorHistoricalApi* | [**get_origin_inspector_historical**](docs/OriginInspectorHistoricalApi.md#get_origin_inspector_historical) | Get historical origin data for a service
 *OriginInspectorRealtimeApi* | [**get_origin_inspector_last120_seconds**](docs/OriginInspectorRealtimeApi.md#get_origin_inspector_last120_seconds) | Get real-time origin data for the last 120 seconds
 *OriginInspectorRealtimeApi* | [**get_origin_inspector_last_max_entries**](docs/OriginInspectorRealtimeApi.md#get_origin_inspector_last_max_entries) | Get a limited number of real-time origin data entries
@@ -518,6 +526,7 @@ Class | Method | Description
 *TlsCertificatesApi* | [**create_tls_cert**](docs/TlsCertificatesApi.md#create_tls_cert) | Create a TLS certificate
 *TlsCertificatesApi* | [**delete_tls_cert**](docs/TlsCertificatesApi.md#delete_tls_cert) | Delete a TLS certificate
 *TlsCertificatesApi* | [**get_tls_cert**](docs/TlsCertificatesApi.md#get_tls_cert) | Get a TLS certificate
+*TlsCertificatesApi* | [**get_tls_cert_blob**](docs/TlsCertificatesApi.md#get_tls_cert_blob) | Get a TLS certificate blob (Limited Availability)
 *TlsCertificatesApi* | [**list_tls_certs**](docs/TlsCertificatesApi.md#list_tls_certs) | List TLS certificates
 *TlsCertificatesApi* | [**update_tls_cert**](docs/TlsCertificatesApi.md#update_tls_cert) | Update a TLS certificate
 *TlsConfigurationsApi* | [**get_tls_config**](docs/TlsConfigurationsApi.md#get_tls_config) | Get a TLS configuration
@@ -615,6 +624,8 @@ The fastly-rust API client currently does not support the following endpoints:
 - [`/alerts/definitions/{definition_id}`](https://www.fastly.com/documentation/reference/api/observability/alerts/definitions) (DELETE, GET, PUT)
 - [`/alerts/definitions`](https://www.fastly.com/documentation/reference/api/observability/alerts/definitions) (GET, POST)
 - [`/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)
 - [`/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)
@@ -634,7 +645,9 @@ The fastly-rust API client currently does not support the following endpoints:
 - [`/stats`](https://www.fastly.com/documentation/reference/api/metrics-stats/historical-stats) (GET)
 - [`/tls/activations/{tls_activation_id}`](https://www.fastly.com/documentation/reference/api/tls/mutual-tls/activations) (GET, PATCH)
 - [`/tls/activations`](https://www.fastly.com/documentation/reference/api/tls/mutual-tls/activations) (GET)
-- [`/tls/preview/domains/{tls_preview_domain_id}`](https://www.fastly.com/documentation/reference/api/) (GET, PATCH)
+- [`/tls/configurations/{tls_configuration_id}`](https://www.fastly.com/documentation/reference/api/) (DELETE, GET, PATCH)
+- [`/tls/configurations`](https://www.fastly.com/documentation/reference/api/) (GET, POST)
+- [`/tls/preview/domains/{domain_id}`](https://www.fastly.com/documentation/reference/api/) (GET, PATCH)
 - [`/tls/preview/domains`](https://www.fastly.com/documentation/reference/api/) (GET, POST)
 - [`/v1/channel/{service_id}/ts/h/limit/{max_entries}`](https://www.fastly.com/documentation/reference/api/metrics-stats/origin-insights) (GET)
 - [`/v1/channel/{service_id}/ts/h`](https://www.fastly.com/documentation/reference/api/metrics-stats/origin-insights) (GET)

diff --git a/docs/RelationshipTlsDnsRecord.md → docs/AsyncResponse.md b/docs/RelationshipTlsDnsRecord.md → docs/AsyncResponse.md
@@ -1,10 +1,11 @@
-# RelationshipTlsDnsRecord
+# AsyncResponse
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**dns_record** | Option<[**crate::models::RelationshipTlsDnsRecordDnsRecord**](RelationshipTlsDnsRecordDnsRecord.md)> |  | 
+**title** | Option<**String**> |  | 
+**status** | Option<**String**> |  | 
 
 [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/BillingInvoicesApi.md b/docs/BillingInvoicesApi.md
@@ -6,6 +6,7 @@
 Method | HTTP request | Description
 ------ | ------------ | -----------
 [**get_invoice_by_invoice_id**](BillingInvoicesApi.md#get_invoice_by_invoice_id) | **GET** /billing/v3/invoices/{invoice_id} | Get invoice by ID.
+[**get_month_to_date_invoice**](BillingInvoicesApi.md#get_month_to_date_invoice) | **GET** /billing/v3/invoices/month-to-date | Get month-to-date invoice.
 [**list_invoices**](BillingInvoicesApi.md#list_invoices) | **GET** /billing/v3/invoices | List of invoices.
 
 
@@ -31,7 +32,39 @@ Name | Type | Description  | Required | Notes
 
 ### Return type
 
-[**crate::models::InvoiceResponse**](InvoiceResponse.md)
+[**crate::models::EomInvoiceResponse**](EomInvoiceResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
+## get_month_to_date_invoice
+
+Returns month-to-date invoice for the current month.
+
+```rust
+let cfg = &Configuration::default();
+let params = GetMonthToDateInvoiceParams {
+    // parameters
+};
+get_month_to_date_invoice(cfg, params)
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**crate::models::MtdInvoiceResponse**](MtdInvoiceResponse.md)
 
 ### Authorization
 
@@ -69,7 +102,7 @@ Name | Type | Description  | Required | Notes
 
 ### Return type
 
-[**crate::models::ListInvoicesResponse**](ListInvoicesResponse.md)
+[**crate::models::ListEomInvoicesResponse**](ListEomInvoicesResponse.md)
 
 ### Authorization
 

diff --git a/docs/BillingUsageMetricsApi.md b/docs/BillingUsageMetricsApi.md
@@ -0,0 +1,90 @@
+# BillingUsageMetricsApi
+
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
+
+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
+
+Returns product usage, broken down by service.
+
+```rust
+let cfg = &Configuration::default();
+let params = GetServiceLevelUsageParams {
+    // parameters
+};
+get_service_level_usage(cfg, params)
+```
+
+### Parameters
+
+
+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]
+**cursor** | Option\<**String**> | Cursor value from the `next_cursor` field of a previous response, used to retrieve the next page. To request the first page, this should be empty. |  |
+
+### Return type
+
+[**crate::models::Serviceusagemetrics**](Serviceusagemetrics.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
+## get_service_level_usage_types
+
+Returns product usage types reported by the customer's services.
+
+```rust
+let cfg = &Configuration::default();
+let params = GetServiceLevelUsageTypesParams {
+    // parameters
+};
+get_service_level_usage_types(cfg, params)
+```
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**customer_id** | **String** | Alphanumeric string identifying the customer. | [required] |
+
+### Return type
+
+[**crate::models::Serviceusagetypes**](Serviceusagetypes.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
diff --git a/docs/CreateDashboardRequest.md b/docs/CreateDashboardRequest.md
@@ -0,0 +1,13 @@
+# CreateDashboardRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | A human-readable name | 
+**description** | Option<**String**> | A short description of the dashboard | 
+**items** | Option<[**Vec&lt;crate::models::DashboardItem&gt;**](DashboardItem.md)> | A list of [dashboard items](#dashboard-item). | 
+
+[[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/Dashboard.md b/docs/Dashboard.md
@@ -0,0 +1,18 @@
+# Dashboard
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | Option<**String**> | Dashboard identifier (UUID) | [readonly]
+**name** | Option<**String**> | A human-readable name | 
+**description** | Option<**String**> | A short description of the dashboard | 
+**items** | Option<[**Vec&lt;crate::models::DashboardItem&gt;**](DashboardItem.md)> | A list of [dashboard items](#dashboard-item). | 
+**created_at** | Option<**String**> | Date and time in ISO 8601 format. | [readonly]
+**updated_at** | Option<**String**> | Date and time in ISO 8601 format. | [readonly]
+**created_by** | Option<[**crate::models::DashboardPropertyCreatedBy**](DashboardPropertyCreatedBy.md)> |  | 
+**updated_by** | Option<[**crate::models::DashboardPropertyUpdatedBy**](DashboardPropertyUpdatedBy.md)> |  | 
+
+[[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/DashboardItem.md b/docs/DashboardItem.md
@@ -0,0 +1,16 @@
+# DashboardItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | Option<**String**> | Dashboard item identifier (UUID) | [readonly]
+**title** | **String** | A human-readable title for the dashboard item | 
+**subtitle** | **String** | A human-readable subtitle for the dashboard item. Often a description of the visualization. | 
+**data_source** | [**crate::models::DashboardItemPropertyDataSource**](DashboardItemPropertyDataSource.md) |  | 
+**visualization** | [**crate::models::DashboardItemPropertyVisualization**](DashboardItemPropertyVisualization.md) |  | 
+**span** | Option<**i32**> | The number of columns for the dashboard item to span. Dashboards are rendered on a 12-column grid on \"desktop\" screen sizes. | [default to 4]
+
+[[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/DashboardItemPropertyDataSource.md b/docs/DashboardItemPropertyDataSource.md
@@ -0,0 +1,12 @@
+# DashboardItemPropertyDataSource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_type** | **String** | The source of the data to display. | 
+**config** | [**crate::models::DashboardItemPropertyDataSourcePropertyConfig**](DashboardItemPropertyDataSourcePropertyConfig.md) |  | 
+
+[[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/DashboardItemPropertyDataSourcePropertyConfig.md b/docs/DashboardItemPropertyDataSourcePropertyConfig.md
@@ -0,0 +1,11 @@
+# DashboardItemPropertyDataSourcePropertyConfig
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metrics** | **Vec<String>** | The metrics to visualize. Valid options are defined by the selected [data source](#field_data_source). | 
+
+[[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/DashboardItemPropertyVisualization.md b/docs/DashboardItemPropertyVisualization.md
@@ -0,0 +1,12 @@
+# DashboardItemPropertyVisualization
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_type** | **String** | The type of visualization to display.  | 
+**config** | [**crate::models::DashboardItemPropertyVisualizationPropertyConfig**](DashboardItemPropertyVisualizationPropertyConfig.md) |  | 
+
+[[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/DashboardItemPropertyVisualizationPropertyConfig.md b/docs/DashboardItemPropertyVisualizationPropertyConfig.md
@@ -0,0 +1,13 @@
+# DashboardItemPropertyVisualizationPropertyConfig
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**plot_type** | **String** | The type of chart to display.  | 
+**format** | Option<**String**> | (Optional) The units to use to format the data.  | [default to Format_Number]
+**calculation_method** | Option<**String**> | (Optional) The aggregation function to apply to the dataset.  | 
+
+[[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/RelationshipTlsDnsRecordDnsRecord.md → docs/DashboardPropertyCreatedBy.md b/docs/RelationshipTlsDnsRecordDnsRecord.md → docs/DashboardPropertyCreatedBy.md
@@ -1,10 +1,9 @@
-# RelationshipTlsDnsRecordDnsRecord
+# DashboardPropertyCreatedBy
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**data** | Option<[**Vec&lt;crate::models::RelationshipMemberTlsDnsRecord&gt;**](RelationshipMemberTlsDnsRecord.md)> |  | 
 
 [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/DashboardPropertyUpdatedBy.md b/docs/DashboardPropertyUpdatedBy.md
@@ -0,0 +1,10 @@
+# DashboardPropertyUpdatedBy
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+[[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/DomainInspectorMeasurements.md b/docs/DomainInspectorMeasurements.md
@@ -42,7 +42,7 @@ Name | Type | Description | Notes
 **origin_fetch_resp_body_bytes** | Option<**i32**> | Total body bytes received from origin. | 
 **bandwidth** | Option<**i32**> | Total bytes delivered (`resp_header_bytes` + `resp_body_bytes` + `bereq_header_bytes` + `bereq_body_bytes`). | 
 **edge_hit_ratio** | Option<**f32**> | Ratio of cache hits to cache misses at the edge, between 0 and 1 (`edge_hit_requests` / (`edge_hit_requests` + `edge_miss_requests`)). | 
-**origin_offload** | Option<**f32**> | Ratio of response bytes delivered from the edge compared to what is delivered from origin, between 0 and 1. (`edge_resp_body_bytes` + `edge_resp_header_bytes`) / (`origin_fetch_resp_body_bytes` + `origin_fetch_resp_header_bytes` + `edge_resp_body_bytes` + `edge_resp_header_bytes`). | 
+**origin_offload** | Option<**f32**> | Origin Offload measures the ratio of bytes served to end users that were cached by Fastly, over the bytes served to end users, between 0 and 1. ((`edge_resp_body_bytes` + `edge_resp_header_bytes`) - (`origin_fetch_resp_body_bytes` + `origin_fetch_resp_header_bytes`)) / (`edge_resp_body_bytes` + `edge_resp_header_bytes`). Previously, Origin Offload used a different formula. [Learn more](https://www.fastly.com/documentation/reference/changes/2024/06/add-origin_offload-metric). | 
 **origin_status_200** | Option<**i32**> | Number of responses received from origin with status code 200 (Success). | 
 **origin_status_204** | Option<**i32**> | Number of responses received from origin with status code 204 (No Content). | 
 **origin_status_206** | Option<**i32**> | Number of responses received from origin with status code 206 (Partial Content). | 

diff --git a/docs/InvoiceResponse.md → docs/EomInvoiceResponse.md b/docs/InvoiceResponse.md → docs/EomInvoiceResponse.md
@@ -1,4 +1,4 @@
-# InvoiceResponse
+# EomInvoiceResponse
 
 ## Properties
 

diff --git a/docs/GetServiceLevelUsageResponse.md b/docs/GetServiceLevelUsageResponse.md
@@ -0,0 +1,11 @@
+# GetServiceLevelUsageResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | Option<[**crate::models::ServiceusagemetricsData**](ServiceusagemetricsData.md)> |  | 
+
+[[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+