Generated v8.6.0

fastly · Aug 5, 2024 · 15f8879 · 15f8879
1 parent f66532c
commit 15f8879
Show file tree

Hide file tree

Showing 106 changed files with 9,712 additions and 89 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,15 @@
 # Changelog
 
+## [v8.6.0](https://github.com/fastly/fastly-ruby/releases/tag/release/v8.6.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
+
 ## [v8.5.0](https://github.com/fastly/fastly-ruby/releases/tag/release/v8.5.0) (2024-07-01)
 
 **Bug fixes:**

diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@ A Ruby client library for interacting with most facets of the [Fastly API](https
 To install via RubyGems, add the following to your project's `Gemfile`:
 
 ```ruby
-gem 'fastly', '~> 8.5.0'
+gem 'fastly', '~> 8.6.0'
 ```
 
 Then run `bundle install`.
@@ -102,7 +102,10 @@ Class | Method | Description
 [*Fastly::BillingAddressApi*](docs/BillingAddressApi.md) | [**get_billing_addr**](docs/BillingAddressApi.md#get_billing_addr) | Get a billing address
 [*Fastly::BillingAddressApi*](docs/BillingAddressApi.md) | [**update_billing_addr**](docs/BillingAddressApi.md#update_billing_addr) | Update a billing address
 [*Fastly::BillingInvoicesApi*](docs/BillingInvoicesApi.md) | [**get_invoice_by_invoice_id**](docs/BillingInvoicesApi.md#get_invoice_by_invoice_id) | Get invoice by ID.
+[*Fastly::BillingInvoicesApi*](docs/BillingInvoicesApi.md) | [**get_month_to_date_invoice**](docs/BillingInvoicesApi.md#get_month_to_date_invoice) | Get month-to-date invoice.
 [*Fastly::BillingInvoicesApi*](docs/BillingInvoicesApi.md) | [**list_invoices**](docs/BillingInvoicesApi.md#list_invoices) | List of invoices.
+[*Fastly::BillingUsageMetricsApi*](docs/BillingUsageMetricsApi.md) | [**get_service_level_usage**](docs/BillingUsageMetricsApi.md#get_service_level_usage) | Retrieve service-level usage metrics for a product.
+[*Fastly::BillingUsageMetricsApi*](docs/BillingUsageMetricsApi.md) | [**get_service_level_usage_types**](docs/BillingUsageMetricsApi.md#get_service_level_usage_types) | Retrieve product usage types for a customer.
 [*Fastly::CacheSettingsApi*](docs/CacheSettingsApi.md) | [**create_cache_settings**](docs/CacheSettingsApi.md#create_cache_settings) | Create a cache settings object
 [*Fastly::CacheSettingsApi*](docs/CacheSettingsApi.md) | [**delete_cache_settings**](docs/CacheSettingsApi.md#delete_cache_settings) | Delete a cache settings object
 [*Fastly::CacheSettingsApi*](docs/CacheSettingsApi.md) | [**get_cache_settings**](docs/CacheSettingsApi.md#get_cache_settings) | Get a cache settings object
@@ -414,6 +417,11 @@ Class | Method | Description
 [*Fastly::MutualAuthenticationApi*](docs/MutualAuthenticationApi.md) | [**get_mutual_authentication**](docs/MutualAuthenticationApi.md#get_mutual_authentication) | Get a Mutual Authentication
 [*Fastly::MutualAuthenticationApi*](docs/MutualAuthenticationApi.md) | [**list_mutual_authentications**](docs/MutualAuthenticationApi.md#list_mutual_authentications) | List Mutual Authentications
 [*Fastly::MutualAuthenticationApi*](docs/MutualAuthenticationApi.md) | [**patch_mutual_authentication**](docs/MutualAuthenticationApi.md#patch_mutual_authentication) | Update a Mutual Authentication
+[*Fastly::ObservabilityCustomDashboardsApi*](docs/ObservabilityCustomDashboardsApi.md) | [**create_dashboard**](docs/ObservabilityCustomDashboardsApi.md#create_dashboard) | Create a new dashboard
+[*Fastly::ObservabilityCustomDashboardsApi*](docs/ObservabilityCustomDashboardsApi.md) | [**delete_dashboard**](docs/ObservabilityCustomDashboardsApi.md#delete_dashboard) | Delete an existing dashboard
+[*Fastly::ObservabilityCustomDashboardsApi*](docs/ObservabilityCustomDashboardsApi.md) | [**get_dashboard**](docs/ObservabilityCustomDashboardsApi.md#get_dashboard) | Retrieve a dashboard by ID
+[*Fastly::ObservabilityCustomDashboardsApi*](docs/ObservabilityCustomDashboardsApi.md) | [**list_dashboards**](docs/ObservabilityCustomDashboardsApi.md#list_dashboards) | List all custom dashboards
+[*Fastly::ObservabilityCustomDashboardsApi*](docs/ObservabilityCustomDashboardsApi.md) | [**update_dashboard**](docs/ObservabilityCustomDashboardsApi.md#update_dashboard) | Update an existing dashboard
 [*Fastly::OriginInspectorHistoricalApi*](docs/OriginInspectorHistoricalApi.md) | [**get_origin_inspector_historical**](docs/OriginInspectorHistoricalApi.md#get_origin_inspector_historical) | Get historical origin data for a service
 [*Fastly::OriginInspectorRealtimeApi*](docs/OriginInspectorRealtimeApi.md) | [**get_origin_inspector_last120_seconds**](docs/OriginInspectorRealtimeApi.md#get_origin_inspector_last120_seconds) | Get real-time origin data for the last 120 seconds
 [*Fastly::OriginInspectorRealtimeApi*](docs/OriginInspectorRealtimeApi.md) | [**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
@@ -515,6 +523,7 @@ Class | Method | Description
 [*Fastly::TlsCertificatesApi*](docs/TlsCertificatesApi.md) | [**create_tls_cert**](docs/TlsCertificatesApi.md#create_tls_cert) | Create a TLS certificate
 [*Fastly::TlsCertificatesApi*](docs/TlsCertificatesApi.md) | [**delete_tls_cert**](docs/TlsCertificatesApi.md#delete_tls_cert) | Delete a TLS certificate
 [*Fastly::TlsCertificatesApi*](docs/TlsCertificatesApi.md) | [**get_tls_cert**](docs/TlsCertificatesApi.md#get_tls_cert) | Get a TLS certificate
+[*Fastly::TlsCertificatesApi*](docs/TlsCertificatesApi.md) | [**get_tls_cert_blob**](docs/TlsCertificatesApi.md#get_tls_cert_blob) | Get a TLS certificate blob (Limited Availability)
 [*Fastly::TlsCertificatesApi*](docs/TlsCertificatesApi.md) | [**list_tls_certs**](docs/TlsCertificatesApi.md#list_tls_certs) | List TLS certificates
 [*Fastly::TlsCertificatesApi*](docs/TlsCertificatesApi.md) | [**update_tls_cert**](docs/TlsCertificatesApi.md#update_tls_cert) | Update a TLS certificate
 [*Fastly::TlsConfigurationsApi*](docs/TlsConfigurationsApi.md) | [**get_tls_config**](docs/TlsConfigurationsApi.md#get_tls_config) | Get a TLS configuration
@@ -612,6 +621,8 @@ The fastly-ruby 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)
@@ -621,7 +632,9 @@ The fastly-ruby API client currently does not support the following endpoints:
 - [`/resources/stores/kv/{store_id}/batch`](https://www.fastly.com/documentation/reference/api/services/resources/kv-store-item) (PUT)
 - [`/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 @@
-# Fastly::RelationshipTlsDnsRecord
+# Fastly::AsyncResponse
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **dns_record** | [**RelationshipTlsDnsRecordDnsRecord**](RelationshipTlsDnsRecordDnsRecord.md) |  | [optional] |
+| **title** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
 
 [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
 
diff --git a/docs/BillingInvoicesApi.md b/docs/BillingInvoicesApi.md
@@ -14,13 +14,14 @@ api_instance = Fastly::BillingInvoicesApi.new
 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.
 
 
 ## `get_invoice_by_invoice_id()`
 
 ```ruby
-get_invoice_by_invoice_id(opts): <InvoiceResponse> # Get invoice by ID.
+get_invoice_by_invoice_id(opts): <EomInvoiceResponse> # Get invoice by ID.
 ```
 
 Returns invoice associated with the invoice id.
@@ -50,14 +51,46 @@ end
 
 ### Return type
 
-[**InvoiceResponse**](InvoiceResponse.md)
+[**EomInvoiceResponse**](EomInvoiceResponse.md)
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to README]](../../README.md)
+## `get_month_to_date_invoice()`
+
+```ruby
+get_month_to_date_invoice: <MtdInvoiceResponse> # Get month-to-date invoice.
+```
+
+Returns month-to-date invoice for the current month.
+
+### Examples
+
+```ruby
+api_instance = Fastly::BillingInvoicesApi.new
+
+begin
+  # Get month-to-date invoice.
+  result = api_instance.get_month_to_date_invoice
+  p result
+rescue Fastly::ApiError => e
+  puts "Error when calling BillingInvoicesApi->get_month_to_date_invoice: #{e}"
+end
+```
+
+### Options
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**MtdInvoiceResponse**](MtdInvoiceResponse.md)
 
 [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
 [[Back to README]](../../README.md)
 ## `list_invoices()`
 
 ```ruby
-list_invoices(opts): <ListInvoicesResponse> # List of invoices.
+list_invoices(opts): <ListEomInvoicesResponse> # List of invoices.
 ```
 
 Returns the list of invoices, sorted by billing start date (newest to oldest).
@@ -93,7 +126,7 @@ end
 
 ### Return type
 
-[**ListInvoicesResponse**](ListInvoicesResponse.md)
+[**ListEomInvoicesResponse**](ListEomInvoicesResponse.md)
 
 [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
 [[Back to README]](../../README.md)
diff --git a/docs/BillingUsageMetricsApi.md b/docs/BillingUsageMetricsApi.md
@@ -0,0 +1,111 @@
+# Fastly::BillingUsageMetricsApi
+
+
+```ruby
+require 'fastly'
+api_instance = Fastly::BillingUsageMetricsApi.new
+```
+
+## Methods
+
+> [!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()`
+
+```ruby
+get_service_level_usage(opts): <Serviceusagemetrics> # Retrieve service-level usage metrics for a product.
+```
+
+Returns product usage, broken down by service.
+
+### Examples
+
+```ruby
+api_instance = Fastly::BillingUsageMetricsApi.new
+opts = {
+    customer_id: 'customer_id_example', # String | Alphanumeric string identifying the customer.
+    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.
+    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.
+    time_granularity: 'time_granularity_example', # String | 
+    start_date: '2023-01-01', # String | 
+    end_date: '2023-01-31', # String | 
+    start_month: '2023-01', # String | 
+    end_month: '2023-03', # String | 
+    limit: 'limit_example', # String | Number of results per page. The maximum is 100.
+    cursor: 'cursor_example', # 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.
+}
+
+begin
+  # Retrieve service-level usage metrics for a product.
+  result = api_instance.get_service_level_usage(opts)
+  p result
+rescue Fastly::ApiError => e
+  puts "Error when calling BillingUsageMetricsApi->get_service_level_usage: #{e}"
+end
+```
+
+### Options
+
+| 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][default to &#39;5&#39;] |
+| **cursor** | **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. | [optional] |
+
+### Return type
+
+[**Serviceusagemetrics**](Serviceusagemetrics.md)
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to README]](../../README.md)
+## `get_service_level_usage_types()`
+
+```ruby
+get_service_level_usage_types(opts): <Serviceusagetypes> # Retrieve product usage types for a customer.
+```
+
+Returns product usage types reported by the customer's services.
+
+### Examples
+
+```ruby
+api_instance = Fastly::BillingUsageMetricsApi.new
+opts = {
+    customer_id: 'customer_id_example', # String | Alphanumeric string identifying the customer.
+}
+
+begin
+  # Retrieve product usage types for a customer.
+  result = api_instance.get_service_level_usage_types(opts)
+  p result
+rescue Fastly::ApiError => e
+  puts "Error when calling BillingUsageMetricsApi->get_service_level_usage_types: #{e}"
+end
+```
+
+### Options
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer_id** | **String** | Alphanumeric string identifying the customer. |  |
+
+### Return type
+
+[**Serviceusagetypes**](Serviceusagetypes.md)
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to README]](../../README.md)
diff --git a/docs/CreateDashboardRequest.md b/docs/CreateDashboardRequest.md
@@ -0,0 +1,12 @@
+# Fastly::CreateDashboardRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A human-readable name |  |
+| **description** | **String** | A short description of the dashboard | [optional] |
+| **items** | [**Array&lt;DashboardItem&gt;**](DashboardItem.md) | A list of [dashboard items](#dashboard-item). | [optional] |
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
+
diff --git a/docs/Dashboard.md b/docs/Dashboard.md
@@ -0,0 +1,17 @@
+# Fastly::Dashboard
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Dashboard identifier (UUID) | [optional][readonly] |
+| **name** | **String** | A human-readable name | [optional] |
+| **description** | **String** | A short description of the dashboard | [optional] |
+| **items** | [**Array&lt;DashboardItem&gt;**](DashboardItem.md) | A list of [dashboard items](#dashboard-item). | [optional] |
+| **created_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
+| **updated_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
+| **created_by** | [**DashboardPropertyCreatedBy**](DashboardPropertyCreatedBy.md) |  | [optional] |
+| **updated_by** | [**DashboardPropertyUpdatedBy**](DashboardPropertyUpdatedBy.md) |  | [optional] |
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
+
diff --git a/docs/DashboardItem.md b/docs/DashboardItem.md
@@ -0,0 +1,15 @@
+# Fastly::DashboardItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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** | [**DashboardItemPropertyDataSource**](DashboardItemPropertyDataSource.md) |  |  |
+| **visualization** | [**DashboardItemPropertyVisualization**](DashboardItemPropertyVisualization.md) |  |  |
+| **id** | **String** | Dashboard item identifier (UUID) | [optional][readonly] |
+| **span** | **Integer** | The number of columns for the dashboard item to span. Dashboards are rendered on a 12-column grid on \&quot;desktop\&quot; screen sizes. | [optional][default to 4] |
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
+
diff --git a/docs/DashboardItemPropertyDataSource.md b/docs/DashboardItemPropertyDataSource.md
@@ -0,0 +1,11 @@
+# Fastly::DashboardItemPropertyDataSource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | The source of the data to display. |  |
+| **config** | [**DashboardItemPropertyDataSourcePropertyConfig**](DashboardItemPropertyDataSourcePropertyConfig.md) |  |  |
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
+
diff --git a/docs/DashboardItemPropertyDataSourcePropertyConfig.md b/docs/DashboardItemPropertyDataSourcePropertyConfig.md
@@ -0,0 +1,10 @@
+# Fastly::DashboardItemPropertyDataSourcePropertyConfig
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metrics** | **Array&lt;String&gt;** | The metrics to visualize. Valid options are defined by the selected [data source](#field_data_source). |  |
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
+
diff --git a/docs/DashboardItemPropertyVisualization.md b/docs/DashboardItemPropertyVisualization.md
@@ -0,0 +1,11 @@
+# Fastly::DashboardItemPropertyVisualization
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | The type of visualization to display.  |  |
+| **config** | [**DashboardItemPropertyVisualizationPropertyConfig**](DashboardItemPropertyVisualizationPropertyConfig.md) |  |  |
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
+
diff --git a/docs/DashboardItemPropertyVisualizationPropertyConfig.md b/docs/DashboardItemPropertyVisualizationPropertyConfig.md
@@ -0,0 +1,12 @@
+# Fastly::DashboardItemPropertyVisualizationPropertyConfig
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **plot_type** | **String** | The type of chart to display.  |  |
+| **format** | **String** | (Optional) The units to use to format the data.  | [optional][default to &#39;number&#39;] |
+| **calculation_method** | **String** | (Optional) The aggregation function to apply to the dataset.  | [optional] |
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
+
diff --git a/docs/RelationshipTlsDnsRecords.md → docs/DashboardPropertyCreatedBy.md b/docs/RelationshipTlsDnsRecords.md → docs/DashboardPropertyCreatedBy.md
@@ -1,10 +1,9 @@
-# Fastly::RelationshipTlsDnsRecords
+# Fastly::DashboardPropertyCreatedBy
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **dns_records** | [**RelationshipTlsDnsRecordDnsRecord**](RelationshipTlsDnsRecordDnsRecord.md) |  | [optional] |
 
 [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)