Skip to content

Commit

Permalink
Generated v8.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Feb 28, 2024
1 parent cee7eb9 commit f501542
Show file tree
Hide file tree
Showing 122 changed files with 4,844 additions and 277 deletions.
328 changes: 198 additions & 130 deletions CHANGELOG.md

Large diffs are not rendered by default.

20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.0.1'
gem 'fastly', '~> 8.1.0'
```

Then run `bundle install`.
Expand Down Expand Up @@ -94,6 +94,8 @@ Class | Method | Description
[*Fastly::BillingAddressApi*](docs/BillingAddressApi.md) | [**delete_billing_addr**](docs/BillingAddressApi.md#delete_billing_addr) | Delete a billing address
[*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) | [**list_invoices**](docs/BillingInvoicesApi.md#list_invoices) | List of invoices.
[*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
Expand Down Expand Up @@ -509,6 +511,7 @@ Class | Method | Description
[*Fastly::TlsConfigurationsApi*](docs/TlsConfigurationsApi.md) | [**get_tls_config**](docs/TlsConfigurationsApi.md#get_tls_config) | Get a TLS configuration
[*Fastly::TlsConfigurationsApi*](docs/TlsConfigurationsApi.md) | [**list_tls_configs**](docs/TlsConfigurationsApi.md#list_tls_configs) | List TLS configurations
[*Fastly::TlsConfigurationsApi*](docs/TlsConfigurationsApi.md) | [**update_tls_config**](docs/TlsConfigurationsApi.md#update_tls_config) | Update a TLS configuration
[*Fastly::TlsCsrsApi*](docs/TlsCsrsApi.md) | [**create_csr**](docs/TlsCsrsApi.md#create_csr) | Create CSR
[*Fastly::TlsDomainsApi*](docs/TlsDomainsApi.md) | [**list_tls_domains**](docs/TlsDomainsApi.md#list_tls_domains) | List TLS domains
[*Fastly::TlsPrivateKeysApi*](docs/TlsPrivateKeysApi.md) | [**create_tls_key**](docs/TlsPrivateKeysApi.md#create_tls_key) | Create a TLS private key
[*Fastly::TlsPrivateKeysApi*](docs/TlsPrivateKeysApi.md) | [**delete_tls_key**](docs/TlsPrivateKeysApi.md#delete_tls_key) | Delete a TLS private key
Expand Down Expand Up @@ -595,12 +598,15 @@ Class | Method | Description

The fastly-ruby API client currently does not support the following endpoints:

- [`/resources/stores/kv/{store_id}/batch`](https://developer.fastly.com/reference/api/services/resources/kv-store-item) (PUT)
- [`/tls/activations/{tls_activation_id}`](https://developer.fastly.com/reference/api/tls/mutual-tls/activations) (GET, PATCH)
- [`/tls/activations`](https://developer.fastly.com/reference/api/tls/mutual-tls/activations) (GET)
- [`/v1/channel/{service_id}/ts/h/limit/{max_entries}`](https://developer.fastly.com/reference/api/metrics-stats/origin-insights) (GET)
- [`/v1/channel/{service_id}/ts/h`](https://developer.fastly.com/reference/api/metrics-stats/origin-insights) (GET)
- [`/v1/channel/{service_id}/ts/{start_timestamp}`](https://developer.fastly.com/reference/api/metrics-stats/origin-insights) (GET)
- [`/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)
- [`/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)
- [`/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)
- [`/v1/channel/{service_id}/ts/{start_timestamp}`](https://www.fastly.com/documentation/reference/api/metrics-stats/origin-insights) (GET)


If you encounter any non-security-related bug or unexpected behavior, please [file an issue][bug]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Fastly::ErrorResponse
# Fastly::AutomationTokenErrorResponse

## Properties

Expand Down
4 changes: 2 additions & 2 deletions docs/AutomationTokensApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ end
## `revoke_automation_token_id()`

```ruby
revoke_automation_token_id(opts): <ErrorResponse> # Revoke an Automation Token by ID
revoke_automation_token_id(opts): <AutomationTokenErrorResponse> # Revoke an Automation Token by ID
```

Revoke an automation token by ID.
Expand Down Expand Up @@ -204,7 +204,7 @@ end

### Return type

[**ErrorResponse**](ErrorResponse.md)
[**AutomationTokenErrorResponse**](AutomationTokenErrorResponse.md)

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to README]](../../README.md)
2 changes: 1 addition & 1 deletion docs/Backend.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
| **ssl_ca_cert** | **String** | CA certificate attached to origin. | [optional] |
| **ssl_cert_hostname** | **String** | Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all. | [optional] |
| **ssl_check_cert** | **Boolean** | Be strict on checking SSL certs. | [optional][default to true] |
| **ssl_ciphers** | **String** | List of [OpenSSL ciphers](https://www.openssl.org/docs/manmaster/man1/ciphers.html) to support for connections to this origin. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated. | [optional] |
| **ssl_ciphers** | **String** | List of [OpenSSL ciphers](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) to support for connections to this origin. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated. | [optional] |
| **ssl_client_cert** | **String** | Client certificate attached to origin. | [optional] |
| **ssl_client_key** | **String** | Client key attached to origin. | [optional] |
| **ssl_hostname** | **String** | Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation. | [optional] |
Expand Down
8 changes: 4 additions & 4 deletions docs/BackendApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ opts = {
ssl_ca_cert: 'ssl_ca_cert_example', # String | CA certificate attached to origin.
ssl_cert_hostname: 'ssl_cert_hostname_example', # String | Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all.
ssl_check_cert: true, # Boolean | Be strict on checking SSL certs.
ssl_ciphers: 'ssl_ciphers_example', # String | List of [OpenSSL ciphers](https://www.openssl.org/docs/manmaster/man1/ciphers.html) to support for connections to this origin. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated.
ssl_ciphers: 'ssl_ciphers_example', # String | List of [OpenSSL ciphers](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) to support for connections to this origin. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated.
ssl_client_cert: 'ssl_client_cert_example', # String | Client certificate attached to origin.
ssl_client_key: 'ssl_client_key_example', # String | Client key attached to origin.
ssl_hostname: 'ssl_hostname_example', # String | Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation.
Expand Down Expand Up @@ -104,7 +104,7 @@ end
| **ssl_ca_cert** | **String** | CA certificate attached to origin. | [optional] |
| **ssl_cert_hostname** | **String** | Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all. | [optional] |
| **ssl_check_cert** | **Boolean** | Be strict on checking SSL certs. | [optional][default to true] |
| **ssl_ciphers** | **String** | List of [OpenSSL ciphers](https://www.openssl.org/docs/manmaster/man1/ciphers.html) to support for connections to this origin. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated. | [optional] |
| **ssl_ciphers** | **String** | List of [OpenSSL ciphers](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) to support for connections to this origin. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated. | [optional] |
| **ssl_client_cert** | **String** | Client certificate attached to origin. | [optional] |
| **ssl_client_key** | **String** | Client key attached to origin. | [optional] |
| **ssl_hostname** | **String** | Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation. | [optional] |
Expand Down Expand Up @@ -279,7 +279,7 @@ opts = {
ssl_ca_cert: 'ssl_ca_cert_example', # String | CA certificate attached to origin.
ssl_cert_hostname: 'ssl_cert_hostname_example', # String | Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all.
ssl_check_cert: true, # Boolean | Be strict on checking SSL certs.
ssl_ciphers: 'ssl_ciphers_example', # String | List of [OpenSSL ciphers](https://www.openssl.org/docs/manmaster/man1/ciphers.html) to support for connections to this origin. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated.
ssl_ciphers: 'ssl_ciphers_example', # String | List of [OpenSSL ciphers](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) to support for connections to this origin. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated.
ssl_client_cert: 'ssl_client_cert_example', # String | Client certificate attached to origin.
ssl_client_key: 'ssl_client_key_example', # String | Client key attached to origin.
ssl_hostname: 'ssl_hostname_example', # String | Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation.
Expand Down Expand Up @@ -328,7 +328,7 @@ end
| **ssl_ca_cert** | **String** | CA certificate attached to origin. | [optional] |
| **ssl_cert_hostname** | **String** | Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all. | [optional] |
| **ssl_check_cert** | **Boolean** | Be strict on checking SSL certs. | [optional][default to true] |
| **ssl_ciphers** | **String** | List of [OpenSSL ciphers](https://www.openssl.org/docs/manmaster/man1/ciphers.html) to support for connections to this origin. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated. | [optional] |
| **ssl_ciphers** | **String** | List of [OpenSSL ciphers](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) to support for connections to this origin. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated. | [optional] |
| **ssl_client_cert** | **String** | Client certificate attached to origin. | [optional] |
| **ssl_client_key** | **String** | Client key attached to origin. | [optional] |
| **ssl_hostname** | **String** | Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation. | [optional] |
Expand Down
2 changes: 1 addition & 1 deletion docs/BackendResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
| **ssl_ca_cert** | **String** | CA certificate attached to origin. | [optional] |
| **ssl_cert_hostname** | **String** | Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all. | [optional] |
| **ssl_check_cert** | **Boolean** | Be strict on checking SSL certs. | [optional][default to true] |
| **ssl_ciphers** | **String** | List of [OpenSSL ciphers](https://www.openssl.org/docs/manmaster/man1/ciphers.html) to support for connections to this origin. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated. | [optional] |
| **ssl_ciphers** | **String** | List of [OpenSSL ciphers](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) to support for connections to this origin. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated. | [optional] |
| **ssl_client_cert** | **String** | Client certificate attached to origin. | [optional] |
| **ssl_client_key** | **String** | Client key attached to origin. | [optional] |
| **ssl_hostname** | **String** | Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation. | [optional] |
Expand Down
96 changes: 96 additions & 0 deletions docs/BillingInvoicesApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
# Fastly::BillingInvoicesApi


```ruby
require 'fastly'
api_instance = Fastly::BillingInvoicesApi.new
```

## Methods

| 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. |
| [**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.
```

Returns invoice associated with the invoice id.

### Examples

```ruby
api_instance = Fastly::BillingInvoicesApi.new
opts = {
invoice_id: 'invoice_id_example', # String | Alphanumeric string identifying the invoice.
}

begin
# Get invoice by ID.
result = api_instance.get_invoice_by_invoice_id(opts)
p result
rescue Fastly::ApiError => e
puts "Error when calling BillingInvoicesApi->get_invoice_by_invoice_id: #{e}"
end
```

### Options

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **invoice_id** | **String** | Alphanumeric string identifying the invoice. | |

### Return type

[**InvoiceResponse**](InvoiceResponse.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.
```

Returns the list of invoices, sorted by billing start date (newest to oldest).

### Examples

```ruby
api_instance = Fastly::BillingInvoicesApi.new
opts = {
billing_start_date: '2023-01-01T00:00:00Z', # String |
billing_end_date: '2023-01-31T00:00:00Z', # String |
limit: 'limit_example', # String | Number of results per page. The maximum is 200.
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
# List of invoices.
result = api_instance.list_invoices(opts)
p result
rescue Fastly::ApiError => e
puts "Error when calling BillingInvoicesApi->list_invoices: #{e}"
end
```

### Options

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **billing_start_date** | **String** | | [optional] |
| **billing_end_date** | **String** | | [optional] |
| **limit** | **String** | Number of results per page. The maximum is 200. | [optional][default to &#39;100&#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

[**ListInvoicesResponse**](ListInvoicesResponse.md)

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to README]](../../README.md)
2 changes: 1 addition & 1 deletion docs/Director.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
| **comment** | **String** | A freeform descriptive note. | [optional] |
| **name** | **String** | Name for the Director. | [optional] |
| **quorum** | **Integer** | The percentage of capacity that needs to be up for a director to be considered up. `0` to `100`. | [optional][default to 75] |
| **shield** | **String** | Selected POP to serve as a shield for the backends. Defaults to `null` meaning no origin shielding if not set. Refer to the [POPs API endpoint](/reference/api/utils/pops/) to get a list of available POPs used for shielding. | [optional][default to &#39;null&#39;] |
| **shield** | **String** | Selected POP to serve as a shield for the backends. Defaults to `null` meaning no origin shielding if not set. Refer to the [POPs API endpoint](https://www.fastly.com/documentation/reference/api/utils/pops/) to get a list of available POPs used for shielding. | [optional][default to &#39;null&#39;] |
| **type** | **Integer** | What type of load balance group to use. | [optional][default to TYPE::random] |
| **retries** | **Integer** | How many backends to search if it fails. | [optional][default to 5] |

Expand Down
4 changes: 2 additions & 2 deletions docs/DirectorApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ opts = {
comment: 'comment_example', # String | A freeform descriptive note.
name: 'name_example', # String | Name for the Director.
quorum: 56, # Integer | The percentage of capacity that needs to be up for a director to be considered up. `0` to `100`.
shield: 'shield_example', # String | Selected POP to serve as a shield for the backends. Defaults to `null` meaning no origin shielding if not set. Refer to the [POPs API endpoint](/reference/api/utils/pops/) to get a list of available POPs used for shielding.
shield: 'shield_example', # String | Selected POP to serve as a shield for the backends. Defaults to `null` meaning no origin shielding if not set. Refer to the [POPs API endpoint](https://www.fastly.com/documentation/reference/api/utils/pops/) to get a list of available POPs used for shielding.
type: 1, # Integer | What type of load balance group to use.
retries: 56, # Integer | How many backends to search if it fails.
}
Expand All @@ -62,7 +62,7 @@ end
| **comment** | **String** | A freeform descriptive note. | [optional] |
| **name** | **String** | Name for the Director. | [optional] |
| **quorum** | **Integer** | The percentage of capacity that needs to be up for a director to be considered up. `0` to `100`. | [optional][default to 75] |
| **shield** | **String** | Selected POP to serve as a shield for the backends. Defaults to `null` meaning no origin shielding if not set. Refer to the [POPs API endpoint](/reference/api/utils/pops/) to get a list of available POPs used for shielding. | [optional][default to &#39;null&#39;] |
| **shield** | **String** | Selected POP to serve as a shield for the backends. Defaults to `null` meaning no origin shielding if not set. Refer to the [POPs API endpoint](https://www.fastly.com/documentation/reference/api/utils/pops/) to get a list of available POPs used for shielding. | [optional][default to &#39;null&#39;] |
| **type** | **Integer** | What type of load balance group to use. | [optional][default to 1] |
| **retries** | **Integer** | How many backends to search if it fails. | [optional][default to 5] |

Expand Down
Loading

0 comments on commit f501542

Please sign in to comment.