Generated v4.4.0

fastly · Feb 28, 2024 · aa34aa8 · aa34aa8
1 parent 2c03865
commit aa34aa8
Show file tree

Hide file tree

Showing 115 changed files with 1,122 additions and 128 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,23 @@
 # Changelog
 
+## [v4.4.0](https://github.com/fastly/fastly-rust/releases/tag/release/v4.4.0) (2024-02-28)
+
+**Enhancements:**
+
+- feat(billing): add 'get invoice by invoice ID' endpoint.
+- feat(billing): add 'list invoices' endpoint.
+- feat(image_opto): add 'shield' and 'transform' methods and fields.
+- feat(secret_store): add 'name' filter.
+- feat(tls): add 'create CSR' endpoint.
+- feat(tls_subscription): add 'active order' methods and fields.
+
+**Documentation:**
+
+- doc(backend) fix openssl link.
+- doc(director,domain_inspector,pool,realtime) fix POPs link.
+- doc(service) fix service version link.
+- doc(tls) fix activation link.
+
 ## [v4.3.1](https://github.com/fastly/fastly-rust/releases/tag/release/v4.3.1) (2024-02-19)
 
 **Bug fixes:**
@@ -267,7 +285,7 @@ Substantial changes were made to the underlying OpenAPI specification that produ
 
 **Enhancements:**
 
-* New interface from code-generated API client [#43](https://github.com/fastly/fastly-rust/pull/3) 
-  * [Blog post: Better Fastly API clients with OpenAPI Generator](https://dev.to/fastly/better-fastly-api-clients-with-openapi-generator-3lno)
-  * [Documentation](https://github.com/fastly/fastly-rust#documentation-for-api-endpoints)
-  * [Unsupported API endpoints](https://github.com/fastly/fastly-rust#issues)
+- New interface from code-generated API client [#43](https://github.com/fastly/fastly-rust/pull/3)
+  - [Blog post: Better Fastly API clients with OpenAPI Generator](https://dev.to/fastly/better-fastly-api-clients-with-openapi-generator-3lno)
+  - [Documentation](https://github.com/fastly/fastly-rust#documentation-for-api-endpoints)
+  - [Unsupported API endpoints](https://github.com/fastly/fastly-rust#issues)
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "fastly-api"
-version = "4.3.1"
+version = "4.4.0"
 authors = ["Fastly <[email protected]>"]
 edition = "2021"
 description = "Fastly API client"

diff --git a/README.md b/README.md
@@ -14,7 +14,7 @@ Rust 2021 Edition
 Add the following to `Cargo.toml` under `[dependencies]`:
 
 ```toml
-fastly-api = "4.3.1"
+fastly-api = "4.4.0"
 ```
 
 ## Usage
@@ -107,6 +107,8 @@ Class | Method | HTTP request | Description
 *BillingAddressApi* | [**delete_billing_addr**](docs/BillingAddressApi.md#delete_billing_addr) | **DELETE** /customer/{customer_id}/billing_address | Delete a billing address
 *BillingAddressApi* | [**get_billing_addr**](docs/BillingAddressApi.md#get_billing_addr) | **GET** /customer/{customer_id}/billing_address | Get a billing address
 *BillingAddressApi* | [**update_billing_addr**](docs/BillingAddressApi.md#update_billing_addr) | **PATCH** /customer/{customer_id}/billing_address | Update a billing address
+*BillingInvoicesApi* | [**get_invoice_by_invoice_id**](docs/BillingInvoicesApi.md#get_invoice_by_invoice_id) | **GET** /billing/v3/invoices/{invoice_id} | Get invoice by ID.
+*BillingInvoicesApi* | [**list_invoices**](docs/BillingInvoicesApi.md#list_invoices) | **GET** /billing/v3/invoices | List of invoices.
 *CacheSettingsApi* | [**create_cache_settings**](docs/CacheSettingsApi.md#create_cache_settings) | **POST** /service/{service_id}/version/{version_id}/cache_settings | Create a cache settings object
 *CacheSettingsApi* | [**delete_cache_settings**](docs/CacheSettingsApi.md#delete_cache_settings) | **DELETE** /service/{service_id}/version/{version_id}/cache_settings/{cache_settings_name} | Delete a cache settings object
 *CacheSettingsApi* | [**get_cache_settings**](docs/CacheSettingsApi.md#get_cache_settings) | **GET** /service/{service_id}/version/{version_id}/cache_settings/{cache_settings_name} | Get a cache settings object
@@ -511,6 +513,7 @@ Class | Method | HTTP request | Description
 *TlsConfigurationsApi* | [**get_tls_config**](docs/TlsConfigurationsApi.md#get_tls_config) | **GET** /tls/configurations/{tls_configuration_id} | Get a TLS configuration
 *TlsConfigurationsApi* | [**list_tls_configs**](docs/TlsConfigurationsApi.md#list_tls_configs) | **GET** /tls/configurations | List TLS configurations
 *TlsConfigurationsApi* | [**update_tls_config**](docs/TlsConfigurationsApi.md#update_tls_config) | **PATCH** /tls/configurations/{tls_configuration_id} | Update a TLS configuration
+*TlsCsrsApi* | [**create_csr**](docs/TlsCsrsApi.md#create_csr) | **POST** /tls/certificate_signing_requests | Create CSR
 *TlsDomainsApi* | [**list_tls_domains**](docs/TlsDomainsApi.md#list_tls_domains) | **GET** /tls/domains | List TLS domains
 *TlsPrivateKeysApi* | [**create_tls_key**](docs/TlsPrivateKeysApi.md#create_tls_key) | **POST** /tls/private_keys | Create a TLS private key
 *TlsPrivateKeysApi* | [**delete_tls_key**](docs/TlsPrivateKeysApi.md#delete_tls_key) | **DELETE** /tls/private_keys/{tls_private_key_id} | Delete a TLS private key
@@ -597,22 +600,25 @@ Class | Method | HTTP request | Description
 
 The fastly-rust 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)
-- [`/service/{service_id}/version/{version_id}/director`](https://developer.fastly.com/reference/api/load-balancing/directors/director) (POST)
-- [`/stats/aggregate`](https://developer.fastly.com/reference/api/metrics-stats/historical-stats) (GET)
-- [`/stats/field/{field}`](https://developer.fastly.com/reference/api/metrics-stats/historical-stats) (GET)
-- [`/stats/regions`](https://developer.fastly.com/reference/api/metrics-stats/historical-stats) (GET)
-- [`/stats/service/{service_id}/field/{field}`](https://developer.fastly.com/reference/api/metrics-stats/historical-stats) (GET)
-- [`/stats/service/{service_id}`](https://developer.fastly.com/reference/api/metrics-stats/historical-stats) (GET)
-- [`/stats/usage_by_month`](https://developer.fastly.com/reference/api/metrics-stats/historical-stats) (GET)
-- [`/stats/usage_by_service`](https://developer.fastly.com/reference/api/metrics-stats/historical-stats) (GET)
-- [`/stats/usage`](https://developer.fastly.com/reference/api/metrics-stats/historical-stats) (GET)
-- [`/stats`](https://developer.fastly.com/reference/api/metrics-stats/historical-stats) (GET)
-- [`/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)
+- [`/service/{service_id}/version/{version_id}/director`](https://www.fastly.com/documentation/reference/api/load-balancing/directors/director) (POST)
+- [`/stats/aggregate`](https://www.fastly.com/documentation/reference/api/metrics-stats/historical-stats) (GET)
+- [`/stats/field/{field}`](https://www.fastly.com/documentation/reference/api/metrics-stats/historical-stats) (GET)
+- [`/stats/regions`](https://www.fastly.com/documentation/reference/api/metrics-stats/historical-stats) (GET)
+- [`/stats/service/{service_id}/field/{field}`](https://www.fastly.com/documentation/reference/api/metrics-stats/historical-stats) (GET)
+- [`/stats/service/{service_id}`](https://www.fastly.com/documentation/reference/api/metrics-stats/historical-stats) (GET)
+- [`/stats/usage_by_month`](https://www.fastly.com/documentation/reference/api/metrics-stats/historical-stats) (GET)
+- [`/stats/usage_by_service`](https://www.fastly.com/documentation/reference/api/metrics-stats/historical-stats) (GET)
+- [`/stats/usage`](https://www.fastly.com/documentation/reference/api/metrics-stats/historical-stats) (GET)
+- [`/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)
+- [`/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]

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

diff --git a/docs/AutomationTokensApi.md b/docs/AutomationTokensApi.md
@@ -176,7 +176,7 @@ Name | Type | Description  | Required | Notes
 
 ### Return type
 
-[**crate::models::ErrorResponse**](ErrorResponse.md)
+[**crate::models::AutomationTokenErrorResponse**](AutomationTokenErrorResponse.md)
 
 ### Authorization
 

diff --git a/docs/Backend.md b/docs/Backend.md
@@ -28,7 +28,7 @@ Name | Type | Description | Notes
 **ssl_ca_cert** | Option<**String**> | CA certificate attached to origin. | 
 **ssl_cert_hostname** | Option<**String**> | Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all. | 
 **ssl_check_cert** | Option<**bool**> | Be strict on checking SSL certs. | [default to true]
-**ssl_ciphers** | Option<**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** | Option<**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** | Option<**String**> | Client certificate attached to origin. | 
 **ssl_client_key** | Option<**String**> | Client key attached to origin. | 
 **ssl_hostname** | Option<**String**> | Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation. | 

diff --git a/docs/BackendApi.md b/docs/BackendApi.md
@@ -55,7 +55,7 @@ Name | Type | Description  | Required | Notes
 **ssl_ca_cert** | Option\<**String**> | CA certificate attached to origin. |  |
 **ssl_cert_hostname** | Option\<**String**> | Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all. |  |
 **ssl_check_cert** | Option\<**bool**> | Be strict on checking SSL certs. |  |[default to true]
-**ssl_ciphers** | Option\<**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** | Option\<**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** | Option\<**String**> | Client certificate attached to origin. |  |
 **ssl_client_key** | Option\<**String**> | Client key attached to origin. |  |
 **ssl_hostname** | Option\<**String**> | Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation. |  |
@@ -233,7 +233,7 @@ Name | Type | Description  | Required | Notes
 **ssl_ca_cert** | Option\<**String**> | CA certificate attached to origin. |  |
 **ssl_cert_hostname** | Option\<**String**> | Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all. |  |
 **ssl_check_cert** | Option\<**bool**> | Be strict on checking SSL certs. |  |[default to true]
-**ssl_ciphers** | Option\<**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** | Option\<**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** | Option\<**String**> | Client certificate attached to origin. |  |
 **ssl_client_key** | Option\<**String**> | Client key attached to origin. |  |
 **ssl_hostname** | Option\<**String**> | Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation. |  |

diff --git a/docs/BackendResponse.md b/docs/BackendResponse.md
@@ -28,7 +28,7 @@ Name | Type | Description | Notes
 **ssl_ca_cert** | Option<**String**> | CA certificate attached to origin. | 
 **ssl_cert_hostname** | Option<**String**> | Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all. | 
 **ssl_check_cert** | Option<**bool**> | Be strict on checking SSL certs. | [default to true]
-**ssl_ciphers** | Option<**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** | Option<**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** | Option<**String**> | Client certificate attached to origin. | 
 **ssl_client_key** | Option<**String**> | Client key attached to origin. | 
 **ssl_hostname** | Option<**String**> | Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation. | 

diff --git a/docs/BillingInvoicesApi.md b/docs/BillingInvoicesApi.md
@@ -0,0 +1,83 @@
+# BillingInvoicesApi
+
+All URIs are relative to *https://api.fastly.com*
+
+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
+
+Returns invoice associated with the invoice id.
+
+```rust
+let cfg = &Configuration::default();
+let params = GetInvoiceByInvoiceIdParams {
+    // parameters
+};
+get_invoice_by_invoice_id(cfg, params)
+```
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**invoice_id** | **String** | Alphanumeric string identifying the invoice. | [required] |
+
+### Return type
+
+[**crate::models::InvoiceResponse**](InvoiceResponse.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)
+
+
+## list_invoices
+
+Returns the list of invoices, sorted by billing start date (newest to oldest).
+
+```rust
+let cfg = &Configuration::default();
+let params = ListInvoicesParams {
+    // parameters
+};
+list_invoices(cfg, params)
+```
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**billing_start_date** | Option\<**String**> |  |  |
+**billing_end_date** | Option\<**String**> |  |  |
+**limit** | Option\<**String**> | Number of results per page. The maximum is 200. |  |[default to 100]
+**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::ListInvoicesResponse**](ListInvoicesResponse.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/Director.md b/docs/Director.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **comment** | Option<**String**> | A freeform descriptive note. | 
 **name** | Option<**String**> | Name for the Director. | 
 **quorum** | Option<**i32**> | The percentage of capacity that needs to be up for a director to be considered up. `0` to `100`. | [default to 75]
-**shield** | Option<**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. | [default to null]
+**shield** | Option<**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. | [default to null]
 **_type** | Option<**i32**> | What type of load balance group to use. | [default to Type_random]
 **retries** | Option<**i32**> | How many backends to search if it fails. | [default to 5]
 

diff --git a/docs/DirectorResponse.md b/docs/DirectorResponse.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **comment** | Option<**String**> | A freeform descriptive note. | 
 **name** | Option<**String**> | Name for the Director. | 
 **quorum** | Option<**i32**> | The percentage of capacity that needs to be up for a director to be considered up. `0` to `100`. | [default to 75]
-**shield** | Option<**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. | [default to null]
+**shield** | Option<**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. | [default to null]
 **_type** | Option<**i32**> | What type of load balance group to use. | [default to Type_random]
 **retries** | Option<**i32**> | How many backends to search if it fails. | [default to 5]
 **service_id** | Option<**String**> |  | [readonly]