Generated v5.1.0

CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## [v5.1.0](https://github.com/fastly/fastly-py/releases/tag/release/v5.1.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.
+
 ## [v5.0.1](https://github.com/fastly/fastly-py/releases/tag/release/v5.0.1) (2024-02-16)
 
 **Bug fixes:**
@@ -288,38 +306,39 @@ Substantial changes were made to the underlying OpenAPI specification that produ
 
 **Enhancements:**
 
-* New interface from code-generated API client [#82](https://github.com/fastly/fastly-py/pull/82) 
-  * [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-py#documentation-for-api-endpoints)
-  * [Unsupported API endpoints](https://github.com/fastly/fastly-py#issues)
+- New interface from code-generated API client [#82](https://github.com/fastly/fastly-py/pull/82)
+  - [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-py#documentation-for-api-endpoints)
+  - [Unsupported API endpoints](https://github.com/fastly/fastly-py#issues)
 
-## [0.5.1] - March 26, 2021
+## \[0.5.1\] - March 26, 2021
 
 ### Fixed
 
 - Boolean values in attributes now properly lower-cased during save
 
-## [0.5.0] - September 30, 2020
+## \[0.5.0\] - September 30, 2020
 
 ### Breaking
 
 - Removed support for password authentication because the API no longer supports it.
 - Fixed how the `FASTLY_SECURE` environment variable is processed so as to convert it to a boolean
 
-## [0.4.0] - January 6, 2020
+## \[0.4.0\] - January 6, 2020
 
 ### Added
 
 - new command-line interface: `fastly` using argparse, thanks to the work of @dcmoore-gd
 
-## [0.3.1] - January 6, 2020: 
+## \[0.3.1\] - January 6, 2020:
 
 ### Fixed
 
 - Fixed [unused imports](https://github.com/fastly/fastly-py/pull/47)
-- Fixed [compatibility with python < 3.6](https://github.com/fastly/fastly-py/pull/46)
+- Fixed [compatibility with python \< 3.6](https://github.com/fastly/fastly-py/pull/46)
+
+## \[0.3.0\] - July 10, 2019:
 
-## [0.3.0] - July 10, 2019: 
 ### Added
 
 - This `CHANGELOG.md` file
@@ -330,12 +349,15 @@ Substantial changes were made to the underlying OpenAPI specification that produ
 
 - Updated Service.version and Version.vcl to use new Model.create
 - Compare `attrs` and `_original_attrs` before saving. (Without this check, calling .save() on an instance without changed attributes makes a PUT call with no data. Then instance.attrs is set to the error response for an incomplete API call, e.g. {"msg": "Missing parameter", "detail": "param is missing or the value is empty: item_value"})
-Added missing VCL import to fastly.py
+  Added missing VCL import to fastly.py
+
+## \[0.2.3\] - August 2019
 
-## [0.2.3] - August 2019
 ## Added
+
 - Custom errors
 - Backwards compatibility with Python 3.4
 
 ## Fixed
+
 - Updates API models

README.md

@@ -91,6 +91,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
@@ -506,6 +508,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
@@ -592,12 +595,15 @@ Class | Method | HTTP request | Description
 
 The fastly-py 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]

docs/ErrorResponse.md → docs/AutomationTokenErrorResponse.md

@@ -1,4 +1,4 @@
-# ErrorResponse
+# AutomationTokenErrorResponse
 
 
 ## Properties

docs/AutomationTokensApi.md

@@ -120,7 +120,7 @@ import time
 import fastly
 from fastly.api import automation_tokens_api
 from fastly.model.automation_token_response import AutomationTokenResponse
-from fastly.model.error_response import ErrorResponse
+from fastly.model.automation_token_error_response import AutomationTokenErrorResponse
 from pprint import pprint
 # Defining the host is optional and defaults to https://api.fastly.com
 # See configuration.py for a list of all supported configuration parameters.
@@ -200,7 +200,7 @@ List of services associated with the automation token.
 import time
 import fastly
 from fastly.api import automation_tokens_api
-from fastly.model.error_response import ErrorResponse
+from fastly.model.automation_token_error_response import AutomationTokenErrorResponse
 from fastly.model.inline_response2001 import InlineResponse2001
 from pprint import pprint
 # Defining the host is optional and defaults to https://api.fastly.com
@@ -295,7 +295,7 @@ import time
 import fastly
 from fastly.api import automation_tokens_api
 from fastly.model.automation_token_response import AutomationTokenResponse
-from fastly.model.error_response import ErrorResponse
+from fastly.model.automation_token_error_response import AutomationTokenErrorResponse
 from pprint import pprint
 # Defining the host is optional and defaults to https://api.fastly.com
 # See configuration.py for a list of all supported configuration parameters.
@@ -364,7 +364,7 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **revoke_automation_token_id**
-> ErrorResponse revoke_automation_token_id(id)
+> AutomationTokenErrorResponse revoke_automation_token_id(id)
 
 Revoke an Automation Token by ID
 
@@ -378,7 +378,7 @@ Revoke an automation token by ID.
 import time
 import fastly
 from fastly.api import automation_tokens_api
-from fastly.model.error_response import ErrorResponse
+from fastly.model.automation_token_error_response import AutomationTokenErrorResponse
 from pprint import pprint
 # Defining the host is optional and defaults to https://api.fastly.com
 # See configuration.py for a list of all supported configuration parameters.
@@ -421,7 +421,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**ErrorResponse**](ErrorResponse.md)
+[**AutomationTokenErrorResponse**](AutomationTokenErrorResponse.md)
 
 ### Authorization
 

docs/Backend.md

@@ -28,7 +28,7 @@ Name | Type | Description | Notes
 **ssl_ca_cert** | **str, none_type** | CA certificate attached to origin. | [optional] 
 **ssl_cert_hostname** | **str, none_type** | Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all. | [optional] 
 **ssl_check_cert** | **bool, none_type** | Be strict on checking SSL certs. | [optional]  if omitted the server will use the default value of True
-**ssl_ciphers** | **str, none_type** | 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** | **str, none_type** | 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** | **str, none_type** | Client certificate attached to origin. | [optional] 
 **ssl_client_key** | **str, none_type** | Client key attached to origin. | [optional] 
 **ssl_hostname** | **str, none_type** | Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation. | [optional] 

docs/BackendApi.md

@@ -75,7 +75,7 @@ with fastly.ApiClient(configuration) as api_client:
     ssl_ca_cert = "ssl_ca_cert_example" # str, none_type | CA certificate attached to origin. (optional)
     ssl_cert_hostname = "ssl_cert_hostname_example" # str, none_type | Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all. (optional)
     ssl_check_cert = True # bool, none_type | Be strict on checking SSL certs. (optional) if omitted the server will use the default value of True
-    ssl_ciphers = "ssl_ciphers_example" # str, none_type | 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 = "ssl_ciphers_example" # str, none_type | 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 = "ssl_client_cert_example" # str, none_type | Client certificate attached to origin. (optional)
     ssl_client_key = "ssl_client_key_example" # str, none_type | Client key attached to origin. (optional)
     ssl_hostname = "ssl_hostname_example" # str, none_type | Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation. (optional)
@@ -132,7 +132,7 @@ Name | Type | Description  | Notes
  **ssl_ca_cert** | **str, none_type**| CA certificate attached to origin. | [optional]
  **ssl_cert_hostname** | **str, none_type**| Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all. | [optional]
  **ssl_check_cert** | **bool, none_type**| Be strict on checking SSL certs. | [optional] if omitted the server will use the default value of True
- **ssl_ciphers** | **str, none_type**| 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** | **str, none_type**| 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** | **str, none_type**| Client certificate attached to origin. | [optional]
  **ssl_client_key** | **str, none_type**| Client key attached to origin. | [optional]
  **ssl_hostname** | **str, none_type**| Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation. | [optional]
@@ -471,7 +471,7 @@ with fastly.ApiClient(configuration) as api_client:
     ssl_ca_cert = "ssl_ca_cert_example" # str, none_type | CA certificate attached to origin. (optional)
     ssl_cert_hostname = "ssl_cert_hostname_example" # str, none_type | Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all. (optional)
     ssl_check_cert = True # bool, none_type | Be strict on checking SSL certs. (optional) if omitted the server will use the default value of True
-    ssl_ciphers = "ssl_ciphers_example" # str, none_type | 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 = "ssl_ciphers_example" # str, none_type | 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 = "ssl_client_cert_example" # str, none_type | Client certificate attached to origin. (optional)
     ssl_client_key = "ssl_client_key_example" # str, none_type | Client key attached to origin. (optional)
     ssl_hostname = "ssl_hostname_example" # str, none_type | Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation. (optional)
@@ -529,7 +529,7 @@ Name | Type | Description  | Notes
  **ssl_ca_cert** | **str, none_type**| CA certificate attached to origin. | [optional]
  **ssl_cert_hostname** | **str, none_type**| Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all. | [optional]
  **ssl_check_cert** | **bool, none_type**| Be strict on checking SSL certs. | [optional] if omitted the server will use the default value of True
- **ssl_ciphers** | **str, none_type**| 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** | **str, none_type**| 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** | **str, none_type**| Client certificate attached to origin. | [optional]
  **ssl_client_key** | **str, none_type**| Client key attached to origin. | [optional]
  **ssl_hostname** | **str, none_type**| Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation. | [optional]

docs/BackendResponse.md

@@ -28,7 +28,7 @@ Name | Type | Description | Notes
 **ssl_ca_cert** | **str, none_type** | CA certificate attached to origin. | [optional] 
 **ssl_cert_hostname** | **str, none_type** | Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all. | [optional] 
 **ssl_check_cert** | **bool, none_type** | Be strict on checking SSL certs. | [optional]  if omitted the server will use the default value of True
-**ssl_ciphers** | **str, none_type** | 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** | **str, none_type** | 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** | **str, none_type** | Client certificate attached to origin. | [optional] 
 **ssl_client_key** | **str, none_type** | Client key attached to origin. | [optional] 
 **ssl_hostname** | **str, none_type** | Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation. | [optional]