You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-2Lines changed: 15 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ A Ruby client library for interacting with most facets of the [Fastly API](https
8
8
To install via RubyGems, add the following to your project's `Gemfile`:
9
9
10
10
```ruby
11
-
gem 'fastly', '~> 8.5.0'
11
+
gem 'fastly', '~> 8.6.0'
12
12
```
13
13
14
14
Then run `bundle install`.
@@ -102,7 +102,10 @@ Class | Method | Description
102
102
[*Fastly::BillingAddressApi*](docs/BillingAddressApi.md) | [**get_billing_addr**](docs/BillingAddressApi.md#get_billing_addr) | Get a billing address
103
103
[*Fastly::BillingAddressApi*](docs/BillingAddressApi.md) | [**update_billing_addr**](docs/BillingAddressApi.md#update_billing_addr) | Update a billing address
104
104
[*Fastly::BillingInvoicesApi*](docs/BillingInvoicesApi.md) | [**get_invoice_by_invoice_id**](docs/BillingInvoicesApi.md#get_invoice_by_invoice_id) | Get invoice by ID.
105
+
[*Fastly::BillingInvoicesApi*](docs/BillingInvoicesApi.md) | [**get_month_to_date_invoice**](docs/BillingInvoicesApi.md#get_month_to_date_invoice) | Get month-to-date invoice.
105
106
[*Fastly::BillingInvoicesApi*](docs/BillingInvoicesApi.md) | [**list_invoices**](docs/BillingInvoicesApi.md#list_invoices) | List of invoices.
107
+
[*Fastly::BillingUsageMetricsApi*](docs/BillingUsageMetricsApi.md) | [**get_service_level_usage**](docs/BillingUsageMetricsApi.md#get_service_level_usage) | Retrieve service-level usage metrics for a product.
108
+
[*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.
106
109
[*Fastly::CacheSettingsApi*](docs/CacheSettingsApi.md) | [**create_cache_settings**](docs/CacheSettingsApi.md#create_cache_settings) | Create a cache settings object
107
110
[*Fastly::CacheSettingsApi*](docs/CacheSettingsApi.md) | [**delete_cache_settings**](docs/CacheSettingsApi.md#delete_cache_settings) | Delete a cache settings object
108
111
[*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
414
417
[*Fastly::MutualAuthenticationApi*](docs/MutualAuthenticationApi.md) | [**get_mutual_authentication**](docs/MutualAuthenticationApi.md#get_mutual_authentication) | Get a Mutual Authentication
415
418
[*Fastly::MutualAuthenticationApi*](docs/MutualAuthenticationApi.md) | [**list_mutual_authentications**](docs/MutualAuthenticationApi.md#list_mutual_authentications) | List Mutual Authentications
416
419
[*Fastly::MutualAuthenticationApi*](docs/MutualAuthenticationApi.md) | [**patch_mutual_authentication**](docs/MutualAuthenticationApi.md#patch_mutual_authentication) | Update a Mutual Authentication
420
+
[*Fastly::ObservabilityCustomDashboardsApi*](docs/ObservabilityCustomDashboardsApi.md) | [**create_dashboard**](docs/ObservabilityCustomDashboardsApi.md#create_dashboard) | Create a new dashboard
421
+
[*Fastly::ObservabilityCustomDashboardsApi*](docs/ObservabilityCustomDashboardsApi.md) | [**delete_dashboard**](docs/ObservabilityCustomDashboardsApi.md#delete_dashboard) | Delete an existing dashboard
422
+
[*Fastly::ObservabilityCustomDashboardsApi*](docs/ObservabilityCustomDashboardsApi.md) | [**get_dashboard**](docs/ObservabilityCustomDashboardsApi.md#get_dashboard) | Retrieve a dashboard by ID
423
+
[*Fastly::ObservabilityCustomDashboardsApi*](docs/ObservabilityCustomDashboardsApi.md) | [**list_dashboards**](docs/ObservabilityCustomDashboardsApi.md#list_dashboards) | List all custom dashboards
424
+
[*Fastly::ObservabilityCustomDashboardsApi*](docs/ObservabilityCustomDashboardsApi.md) | [**update_dashboard**](docs/ObservabilityCustomDashboardsApi.md#update_dashboard) | Update an existing dashboard
417
425
[*Fastly::OriginInspectorHistoricalApi*](docs/OriginInspectorHistoricalApi.md) | [**get_origin_inspector_historical**](docs/OriginInspectorHistoricalApi.md#get_origin_inspector_historical) | Get historical origin data for a service
418
426
[*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
419
427
[*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
515
523
[*Fastly::TlsCertificatesApi*](docs/TlsCertificatesApi.md) | [**create_tls_cert**](docs/TlsCertificatesApi.md#create_tls_cert) | Create a TLS certificate
516
524
[*Fastly::TlsCertificatesApi*](docs/TlsCertificatesApi.md) | [**delete_tls_cert**](docs/TlsCertificatesApi.md#delete_tls_cert) | Delete a TLS certificate
517
525
[*Fastly::TlsCertificatesApi*](docs/TlsCertificatesApi.md) | [**get_tls_cert**](docs/TlsCertificatesApi.md#get_tls_cert) | Get a TLS certificate
526
+
[*Fastly::TlsCertificatesApi*](docs/TlsCertificatesApi.md) | [**get_tls_cert_blob**](docs/TlsCertificatesApi.md#get_tls_cert_blob) | Get a TLS certificate blob (Limited Availability)
518
527
[*Fastly::TlsCertificatesApi*](docs/TlsCertificatesApi.md) | [**list_tls_certs**](docs/TlsCertificatesApi.md#list_tls_certs) | List TLS certificates
519
528
[*Fastly::TlsCertificatesApi*](docs/TlsCertificatesApi.md) | [**update_tls_cert**](docs/TlsCertificatesApi.md#update_tls_cert) | Update a TLS certificate
520
529
[*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:
> All URIs are relative to `https://api.fastly.com`
13
+
14
+
Method | HTTP request | Description
15
+
------ | ------------ | -----------
16
+
[**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.
17
+
[**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.
18
+
19
+
20
+
## `get_service_level_usage()`
21
+
22
+
```ruby
23
+
get_service_level_usage(opts): <Serviceusagemetrics># Retrieve service-level usage metrics for a product.
24
+
```
25
+
26
+
Returns product usage, broken down by service.
27
+
28
+
### Examples
29
+
30
+
```ruby
31
+
api_instance =Fastly::BillingUsageMetricsApi.new
32
+
opts = {
33
+
customer_id:'customer_id_example', # String | Alphanumeric string identifying the customer.
34
+
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.
35
+
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.
limit:'limit_example', # String | Number of results per page. The maximum is 100.
42
+
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.
43
+
}
44
+
45
+
begin
46
+
# Retrieve service-level usage metrics for a product.
47
+
result = api_instance.get_service_level_usage(opts)
48
+
p result
49
+
rescueFastly::ApiError => e
50
+
puts"Error when calling BillingUsageMetricsApi->get_service_level_usage: #{e}"
51
+
end
52
+
```
53
+
54
+
### Options
55
+
56
+
| Name | Type | Description | Notes |
57
+
| ---- | ---- | ----------- | ----- |
58
+
|**customer_id**|**String**| Alphanumeric string identifying the customer. ||
59
+
|**product_id**|**String**| The product identifier for the metrics returned (e.g., `cdn_usage`). This field is not required for CSV requests. ||
60
+
|**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. ||
61
+
|**time_granularity**|**String**|||
62
+
|**start_date**|**String**||[optional]|
63
+
|**end_date**|**String**||[optional]|
64
+
|**start_month**|**String**||[optional]|
65
+
|**end_month**|**String**||[optional]|
66
+
|**limit**|**String**| Number of results per page. The maximum is 100. |[optional][default to '5']|
67
+
|**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]|
68
+
69
+
### Return type
70
+
71
+
[**Serviceusagemetrics**](Serviceusagemetrics.md)
72
+
73
+
[[Back to top]](#)[[Back to API list]](../../README.md#endpoints)
74
+
[[Back to README]](../../README.md)
75
+
## `get_service_level_usage_types()`
76
+
77
+
```ruby
78
+
get_service_level_usage_types(opts): <Serviceusagetypes># Retrieve product usage types for a customer.
79
+
```
80
+
81
+
Returns product usage types reported by the customer's services.
82
+
83
+
### Examples
84
+
85
+
```ruby
86
+
api_instance =Fastly::BillingUsageMetricsApi.new
87
+
opts = {
88
+
customer_id:'customer_id_example', # String | Alphanumeric string identifying the customer.
89
+
}
90
+
91
+
begin
92
+
# Retrieve product usage types for a customer.
93
+
result = api_instance.get_service_level_usage_types(opts)
94
+
p result
95
+
rescueFastly::ApiError => e
96
+
puts"Error when calling BillingUsageMetricsApi->get_service_level_usage_types: #{e}"
97
+
end
98
+
```
99
+
100
+
### Options
101
+
102
+
| Name | Type | Description | Notes |
103
+
| ---- | ---- | ----------- | ----- |
104
+
|**customer_id**|**String**| Alphanumeric string identifying the customer. ||
105
+
106
+
### Return type
107
+
108
+
[**Serviceusagetypes**](Serviceusagetypes.md)
109
+
110
+
[[Back to top]](#)[[Back to API list]](../../README.md#endpoints)
|**span**|**Integer**| The number of columns for the dashboard item to span. Dashboards are rendered on a 12-column grid on \"desktop\" screen sizes. |[optional][default to 4]|
13
+
14
+
[[Back to API list]](../../README.md#endpoints)[[Back to README]](../../README.md)
0 commit comments