From 2c7cb5c1d464aab1295f4ce334975b69b448575b Mon Sep 17 00:00:00 2001 From: github-actions Date: Wed, 28 Feb 2024 14:10:03 +0000 Subject: [PATCH] Generated v5.1.0 --- CHANGELOG.md | 46 ++- README.md | 18 +- ...nse.md => AutomationTokenErrorResponse.md} | 2 +- docs/AutomationTokensApi.md | 12 +- docs/Backend.md | 2 +- docs/BackendApi.md | 8 +- docs/BackendResponse.md | 2 +- docs/BillingInvoicesApi.md | 181 +++++++++ docs/Director.md | 2 +- docs/DirectorApi.md | 4 +- docs/DirectorResponse.md | 2 +- docs/DomainInspectorHistoricalApi.md | 8 +- docs/DomainInspectorRealtimeEntry.md | 2 +- docs/Error.md | 15 + docs/ErrorResponseData.md | 13 + docs/Invoice.md | 20 + docs/InvoiceResponse.md | 20 + docs/Invoicelineitems.md | 20 + docs/KvStoreApi.md | 4 +- docs/ListInvoicesResponse.md | 13 + docs/Listinvoices.md | 13 + docs/LoggingScalyrAdditional.md | 2 +- docs/LoggingScalyrApi.md | 8 +- docs/LoggingScalyrResponse.md | 2 +- docs/Metadata.md | 16 + docs/OriginInspectorHistoricalApi.md | 8 +- docs/OriginInspectorRealtimeEntry.md | 2 +- docs/PoolAdditional.md | 2 +- docs/PoolApi.md | 8 +- docs/PoolResponse.md | 2 +- docs/PoolResponsePost.md | 2 +- docs/Pop.md | 4 +- docs/PublishApi.md | 2 +- docs/RealtimeEntryDatacenter.md | 2 +- docs/RelationshipTlsCertificate.md | 2 +- docs/RelationshipTlsConfiguration.md | 2 +- docs/Results.md | 2 + docs/SecretStoreApi.md | 8 +- docs/SecretStoreItemApi.md | 4 +- docs/ServiceDetail.md | 2 +- docs/ServiceListResponse.md | 4 +- docs/ServiceListResponseAllOf.md | 4 +- docs/ServiceResponse.md | 2 +- docs/ServiceResponseAllOf.md | 2 +- docs/TlsConfigurationResponseAttributes.md | 2 +- ...TlsConfigurationResponseAttributesAllOf.md | 2 +- docs/TlsCsr.md | 12 + docs/TlsCsrData.md | 14 + docs/TlsCsrDataAttributes.md | 22 ++ docs/TlsCsrErrorResponse.md | 12 + docs/TlsCsrResponse.md | 12 + docs/TlsCsrResponseAttributes.md | 12 + docs/TlsCsrResponseData.md | 15 + docs/TlsCsrsApi.md | 115 ++++++ docs/TlsSubscriptionResponseAttributes.md | 1 + .../TlsSubscriptionResponseAttributesAllOf.md | 1 + docs/TokensApi.md | 2 +- docs/TypeTlsCsr.md | 12 + docs/VclApi.md | 2 +- docs/WafActiveRulesApi.md | 2 +- fastly/__init__.py | 2 +- fastly/api/automation_tokens_api.py | 6 +- fastly/api/backend_api.py | 4 +- fastly/api/billing_invoices_api.py | 322 ++++++++++++++++ fastly/api/director_api.py | 2 +- fastly/api/domain_inspector_historical_api.py | 4 +- fastly/api/kv_store_api.py | 2 +- fastly/api/logging_scalyr_api.py | 4 +- fastly/api/origin_inspector_historical_api.py | 4 +- fastly/api/pool_api.py | 4 +- fastly/api/publish_api.py | 2 +- fastly/api/secret_store_api.py | 8 +- fastly/api/secret_store_item_api.py | 2 +- fastly/api/tls_csrs_api.py | 168 +++++++++ fastly/api/tokens_api.py | 2 +- fastly/api/vcl_api.py | 2 +- fastly/api/waf_active_rules_api.py | 2 +- fastly/api_client.py | 2 +- fastly/apis/__init__.py | 2 + fastly/configuration.py | 2 +- ....py => automation_token_error_response.py} | 6 +- fastly/model/backend.py | 4 +- fastly/model/backend_response.py | 4 +- fastly/model/director.py | 4 +- fastly/model/director_response.py | 4 +- .../model/domain_inspector_realtime_entry.py | 4 +- fastly/model/error.py | 265 ++++++++++++++ fastly/model/error_response_data.py | 257 +++++++++++++ fastly/model/event_attributes.py | 4 + fastly/model/invoice.py | 291 +++++++++++++++ fastly/model/invoice_response.py | 343 ++++++++++++++++++ fastly/model/invoicelineitems.py | 285 +++++++++++++++ fastly/model/list_invoices_response.py | 317 ++++++++++++++++ fastly/model/listinvoices.py | 265 ++++++++++++++ fastly/model/logging_scalyr_additional.py | 4 +- fastly/model/logging_scalyr_response.py | 4 +- fastly/model/metadata.py | 265 ++++++++++++++ .../model/origin_inspector_realtime_entry.py | 4 +- fastly/model/pool_additional.py | 4 +- fastly/model/pool_response.py | 4 +- fastly/model/pool_response_post.py | 4 +- fastly/model/pop.py | 8 +- fastly/model/results.py | 8 + fastly/model/service_detail.py | 4 +- fastly/model/service_list_response.py | 8 +- fastly/model/service_list_response_all_of.py | 8 +- fastly/model/service_response.py | 4 +- fastly/model/service_response_all_of.py | 4 +- .../tls_configuration_response_attributes.py | 4 +- ...onfiguration_response_attributes_all_of.py | 4 +- fastly/model/tls_csr.py | 259 +++++++++++++ fastly/model/tls_csr_data.py | 271 ++++++++++++++ fastly/model/tls_csr_data_attributes.py | 303 ++++++++++++++++ fastly/model/tls_csr_error_response.py | 259 +++++++++++++ fastly/model/tls_csr_response.py | 259 +++++++++++++ fastly/model/tls_csr_response_attributes.py | 253 +++++++++++++ fastly/model/tls_csr_response_data.py | 275 ++++++++++++++ .../model/tls_subscription_data_attributes.py | 1 + .../tls_subscription_response_attributes.py | 4 + ...subscription_response_attributes_all_of.py | 4 + fastly/model/type_tls_csr.py | 271 ++++++++++++++ fastly/models/__init__.py | 18 +- setup.py | 2 +- sig.json | 2 +- 124 files changed, 5701 insertions(+), 157 deletions(-) rename docs/{ErrorResponse.md => AutomationTokenErrorResponse.md} (95%) create mode 100644 docs/BillingInvoicesApi.md create mode 100644 docs/Error.md create mode 100644 docs/ErrorResponseData.md create mode 100644 docs/Invoice.md create mode 100644 docs/InvoiceResponse.md create mode 100644 docs/Invoicelineitems.md create mode 100644 docs/ListInvoicesResponse.md create mode 100644 docs/Listinvoices.md create mode 100644 docs/Metadata.md create mode 100644 docs/TlsCsr.md create mode 100644 docs/TlsCsrData.md create mode 100644 docs/TlsCsrDataAttributes.md create mode 100644 docs/TlsCsrErrorResponse.md create mode 100644 docs/TlsCsrResponse.md create mode 100644 docs/TlsCsrResponseAttributes.md create mode 100644 docs/TlsCsrResponseData.md create mode 100644 docs/TlsCsrsApi.md create mode 100644 docs/TypeTlsCsr.md create mode 100644 fastly/api/billing_invoices_api.py create mode 100644 fastly/api/tls_csrs_api.py rename fastly/model/{error_response.py => automation_token_error_response.py} (98%) create mode 100644 fastly/model/error.py create mode 100644 fastly/model/error_response_data.py create mode 100644 fastly/model/invoice.py create mode 100644 fastly/model/invoice_response.py create mode 100644 fastly/model/invoicelineitems.py create mode 100644 fastly/model/list_invoices_response.py create mode 100644 fastly/model/listinvoices.py create mode 100644 fastly/model/metadata.py create mode 100644 fastly/model/tls_csr.py create mode 100644 fastly/model/tls_csr_data.py create mode 100644 fastly/model/tls_csr_data_attributes.py create mode 100644 fastly/model/tls_csr_error_response.py create mode 100644 fastly/model/tls_csr_response.py create mode 100644 fastly/model/tls_csr_response_attributes.py create mode 100644 fastly/model/tls_csr_response_data.py create mode 100644 fastly/model/type_tls_csr.py diff --git a/CHANGELOG.md b/CHANGELOG.md index 3c301e2..45d35f8 100644 --- a/CHANGELOG.md +++ b/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 diff --git a/README.md b/README.md index e713c95..74b6b43 100644 --- a/README.md +++ b/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] diff --git a/docs/ErrorResponse.md b/docs/AutomationTokenErrorResponse.md similarity index 95% rename from docs/ErrorResponse.md rename to docs/AutomationTokenErrorResponse.md index 676eb4a..366b0ae 100644 --- a/docs/ErrorResponse.md +++ b/docs/AutomationTokenErrorResponse.md @@ -1,4 +1,4 @@ -# ErrorResponse +# AutomationTokenErrorResponse ## Properties diff --git a/docs/AutomationTokensApi.md b/docs/AutomationTokensApi.md index c75f49b..ac5f5b1 100644 --- a/docs/AutomationTokensApi.md +++ b/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 diff --git a/docs/Backend.md b/docs/Backend.md index 1872dec..0e703eb 100644 --- a/docs/Backend.md +++ b/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] diff --git a/docs/BackendApi.md b/docs/BackendApi.md index 167a944..9ac49de 100644 --- a/docs/BackendApi.md +++ b/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] diff --git a/docs/BackendResponse.md b/docs/BackendResponse.md index 79ac86b..8f1505f 100644 --- a/docs/BackendResponse.md +++ b/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] diff --git a/docs/BillingInvoicesApi.md b/docs/BillingInvoicesApi.md new file mode 100644 index 0000000..831ee5f --- /dev/null +++ b/docs/BillingInvoicesApi.md @@ -0,0 +1,181 @@ +# fastly.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** +> InvoiceResponse get_invoice_by_invoice_id(invoice_id) + +Get invoice by ID. + +Returns invoice associated with the invoice id. + +### Example + +* Api Key Authentication (token): + +```python +import time +import fastly +from fastly.api import billing_invoices_api +from fastly.model.invoice_response import InvoiceResponse +from fastly.model.error import Error +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. +configuration = fastly.Configuration( + host = "https://api.fastly.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: token +configuration.api_key['token'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['token'] = 'Bearer' + +# Enter a context with an instance of the API client +with fastly.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = billing_invoices_api.BillingInvoicesApi(api_client) + invoice_id = "7SlAESxcJ2zxHOV4gQ9y9X" # str | Alphanumeric string identifying the invoice. + + # example passing only required values which don't have defaults set + try: + # Get invoice by ID. + api_response = api_instance.get_invoice_by_invoice_id(invoice_id) + pprint(api_response) + except fastly.ApiException as e: + print("Exception when calling BillingInvoicesApi->get_invoice_by_invoice_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **invoice_id** | **str**| Alphanumeric string identifying the invoice. | + +### Return type + +[**InvoiceResponse**](InvoiceResponse.md) + +### Authorization + +[token](../README.md#token) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**401** | Unauthorized | - | +**404** | Not Found | - | +**500** | Internal Server Error | - | + +[[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) + +# **list_invoices** +> ListInvoicesResponse list_invoices() + +List of invoices. + +Returns the list of invoices, sorted by billing start date (newest to oldest). + +### Example + +* Api Key Authentication (token): + +```python +import time +import fastly +from fastly.api import billing_invoices_api +from fastly.model.error import Error +from fastly.model.list_invoices_response import ListInvoicesResponse +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. +configuration = fastly.Configuration( + host = "https://api.fastly.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: token +configuration.api_key['token'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['token'] = 'Bearer' + +# Enter a context with an instance of the API client +with fastly.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = billing_invoices_api.BillingInvoicesApi(api_client) + billing_start_date = "2023-01-01T00:00:00Z" # str | (optional) + billing_end_date = "2023-01-31T00:00:00Z" # str | (optional) + limit = "100" # str | Number of results per page. The maximum is 200. (optional) if omitted the server will use the default value of "100" + cursor = "cursor_example" # str | 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) + + # example passing only required values which don't have defaults set + # and optional values + try: + # List of invoices. + api_response = api_instance.list_invoices(billing_start_date=billing_start_date, billing_end_date=billing_end_date, limit=limit, cursor=cursor) + pprint(api_response) + except fastly.ApiException as e: + print("Exception when calling BillingInvoicesApi->list_invoices: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **billing_start_date** | **str**| | [optional] + **billing_end_date** | **str**| | [optional] + **limit** | **str**| Number of results per page. The maximum is 200. | [optional] if omitted the server will use the default value of "100" + **cursor** | **str**| 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) + +### Authorization + +[token](../README.md#token) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**500** | Internal Server Error | - | + +[[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) + diff --git a/docs/Director.md b/docs/Director.md index c6c4ca6..c63afb1 100644 --- a/docs/Director.md +++ b/docs/Director.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **comment** | **str, none_type** | A freeform descriptive note. | [optional] **name** | **str** | Name for the Director. | [optional] **quorum** | **int** | The percentage of capacity that needs to be up for a director to be considered up. `0` to `100`. | [optional] if omitted the server will use the default value of 75 -**shield** | **str, none_type** | 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] if omitted the server will use the default value of "null" +**shield** | **str, none_type** | 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] if omitted the server will use the default value of "null" **type** | **int** | What type of load balance group to use. | [optional] if omitted the server will use the default value of 1 **retries** | **int** | How many backends to search if it fails. | [optional] if omitted the server will use the default value of 5 **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/docs/DirectorApi.md b/docs/DirectorApi.md index 65dafca..54048dc 100644 --- a/docs/DirectorApi.md +++ b/docs/DirectorApi.md @@ -91,7 +91,7 @@ with fastly.ApiClient(configuration) as api_client: comment = "" # str, none_type | A freeform descriptive note. (optional) name = "test-director" # str | Name for the Director. (optional) quorum = 75 # int | The percentage of capacity that needs to be up for a director to be considered up. `0` to `100`. (optional) if omitted the server will use the default value of 75 - shield = "null" # str, none_type | 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) if omitted the server will use the default value of "null" + shield = "null" # str, none_type | 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) if omitted the server will use the default value of "null" type = 1 # int | What type of load balance group to use. (optional) if omitted the server will use the default value of 1 retries = 5 # int | How many backends to search if it fails. (optional) if omitted the server will use the default value of 5 @@ -125,7 +125,7 @@ Name | Type | Description | Notes **comment** | **str, none_type**| A freeform descriptive note. | [optional] **name** | **str**| Name for the Director. | [optional] **quorum** | **int**| The percentage of capacity that needs to be up for a director to be considered up. `0` to `100`. | [optional] if omitted the server will use the default value of 75 - **shield** | **str, none_type**| 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] if omitted the server will use the default value of "null" + **shield** | **str, none_type**| 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] if omitted the server will use the default value of "null" **type** | **int**| What type of load balance group to use. | [optional] if omitted the server will use the default value of 1 **retries** | **int**| How many backends to search if it fails. | [optional] if omitted the server will use the default value of 5 diff --git a/docs/DirectorResponse.md b/docs/DirectorResponse.md index 03012f0..6b7d7d5 100644 --- a/docs/DirectorResponse.md +++ b/docs/DirectorResponse.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **comment** | **str, none_type** | A freeform descriptive note. | [optional] **name** | **str** | Name for the Director. | [optional] **quorum** | **int** | The percentage of capacity that needs to be up for a director to be considered up. `0` to `100`. | [optional] if omitted the server will use the default value of 75 -**shield** | **str, none_type** | 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] if omitted the server will use the default value of "null" +**shield** | **str, none_type** | 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] if omitted the server will use the default value of "null" **type** | **int** | What type of load balance group to use. | [optional] if omitted the server will use the default value of 1 **retries** | **int** | How many backends to search if it fails. | [optional] if omitted the server will use the default value of 5 **service_id** | **str** | | [optional] [readonly] diff --git a/docs/DomainInspectorHistoricalApi.md b/docs/DomainInspectorHistoricalApi.md index 883d325..a68eb0a 100644 --- a/docs/DomainInspectorHistoricalApi.md +++ b/docs/DomainInspectorHistoricalApi.md @@ -49,10 +49,10 @@ with fastly.ApiClient(configuration) as api_client: start = "2021-08-01T00:00:00.000Z" # str | A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the inclusive start of the query time range. If not provided, a default is chosen based on the provided `downsample` value. (optional) end = "2020-08-02T00:00:00.000Z" # str | A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the exclusive end of the query time range. If not provided, a default is chosen based on the provided `downsample` value. (optional) downsample = "hour" # str | Duration of sample windows. (optional) if omitted the server will use the default value of "hour" - metric = "resp_body_bytes,status_2xx" # str | The metric to retrieve. Up to ten comma-separated metrics are accepted. (optional) if omitted the server will use the default value of "edge_requests" + metric = "resp_body_bytes,status_2xx" # str | The metrics to retrieve. Multiple values should be comma-separated. (optional) if omitted the server will use the default value of "edge_requests" group_by = "domain" # str | Dimensions to return in the query. Multiple dimensions may be separated by commas. For example, `group_by=domain` will return one timeseries for every domain, as a total across all datacenters (POPs). (optional) limit = "100" # str | Number of results per page. The maximum is 200. (optional) if omitted the server will use the default value of "100" - cursor = "cursor_example" # str | Cursor value from a previous response to retrieve the next page. To request the first page, this should be empty. (optional) + cursor = "cursor_example" # str | 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) region = "usa" # str | Limit query to one or more specific geographic regions. Values should be comma-separated. (optional) datacenter = "SJC,STP" # str | Limit query to one or more specific POPs. Values should be comma-separated. (optional) domain = "domain_1.com,domain_2.com" # str | Limit query to one or more specific domains. Values should be comma-separated. (optional) @@ -84,10 +84,10 @@ Name | Type | Description | Notes **start** | **str**| A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the inclusive start of the query time range. If not provided, a default is chosen based on the provided `downsample` value. | [optional] **end** | **str**| A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the exclusive end of the query time range. If not provided, a default is chosen based on the provided `downsample` value. | [optional] **downsample** | **str**| Duration of sample windows. | [optional] if omitted the server will use the default value of "hour" - **metric** | **str**| The metric to retrieve. Up to ten comma-separated metrics are accepted. | [optional] if omitted the server will use the default value of "edge_requests" + **metric** | **str**| The metrics to retrieve. Multiple values should be comma-separated. | [optional] if omitted the server will use the default value of "edge_requests" **group_by** | **str**| Dimensions to return in the query. Multiple dimensions may be separated by commas. For example, `group_by=domain` will return one timeseries for every domain, as a total across all datacenters (POPs). | [optional] **limit** | **str**| Number of results per page. The maximum is 200. | [optional] if omitted the server will use the default value of "100" - **cursor** | **str**| Cursor value from a previous response to retrieve the next page. To request the first page, this should be empty. | [optional] + **cursor** | **str**| 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] **region** | **str**| Limit query to one or more specific geographic regions. Values should be comma-separated. | [optional] **datacenter** | **str**| Limit query to one or more specific POPs. Values should be comma-separated. | [optional] **domain** | **str**| Limit query to one or more specific domains. Values should be comma-separated. | [optional] diff --git a/docs/DomainInspectorRealtimeEntry.md b/docs/DomainInspectorRealtimeEntry.md index 2445b62..1ef24ef 100644 --- a/docs/DomainInspectorRealtimeEntry.md +++ b/docs/DomainInspectorRealtimeEntry.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **recorded** | [**RecordedTimestamp**](RecordedTimestamp.md) | | [optional] **aggregated** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Groups [measurements](#measurements-data-model) by backend name and then by IP address. | [optional] -**datacenter** | **{str: ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},)}** | Groups [measurements](#measurements-data-model) by POP, then backend name, and then IP address. See the [POPs API](/reference/api/utils/pops/) for details about POP identifiers. | [optional] +**datacenter** | **{str: ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},)}** | Groups [measurements](#measurements-data-model) by POP, then backend name, and then IP address. See the [POPs API](https://www.fastly.com/documentation/reference/api/utils/pops/) for details about POP identifiers. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Error.md b/docs/Error.md new file mode 100644 index 0000000..48034b5 --- /dev/null +++ b/docs/Error.md @@ -0,0 +1,15 @@ +# Error + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | | [optional] +**title** | **str** | | [optional] +**code** | **str** | | [optional] +**status** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ErrorResponseData.md b/docs/ErrorResponseData.md new file mode 100644 index 0000000..b29e02e --- /dev/null +++ b/docs/ErrorResponseData.md @@ -0,0 +1,13 @@ +# ErrorResponseData + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**title** | **str** | | [optional] +**detail** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Invoice.md b/docs/Invoice.md new file mode 100644 index 0000000..2d9b030 --- /dev/null +++ b/docs/Invoice.md @@ -0,0 +1,20 @@ +# Invoice + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**customer_id** | **str** | Customer ID associated with the invoice. | [optional] +**invoice_id** | **str** | Alphanumeric string identifying the invoice. | [optional] +**invoice_posted_on** | **datetime** | Date and time invoice was posted on, in ISO 8601 format. | [optional] +**billing_start_date** | **datetime** | Date and time (in ISO 8601 format) for initiation point of a billing cycle, signifying the start of charges for a service or subscription. | [optional] +**billing_end_date** | **datetime** | Date and time (in ISO 8601 format) for termination point of a billing cycle, signifying the end of charges for a service or subscription. | [optional] +**statement_number** | **str** | Alphanumeric string identifying the statement number. | [optional] +**currency_code** | **str** | Three-letter code representing a specific currency used for financial transactions. | [optional] +**monthly_transaction_amount** | **float** | Total billable amount for invoiced services charged within a single month. | [optional] +**transaction_line_items** | [**[Invoicelineitems]**](Invoicelineitems.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/InvoiceResponse.md b/docs/InvoiceResponse.md new file mode 100644 index 0000000..4151b06 --- /dev/null +++ b/docs/InvoiceResponse.md @@ -0,0 +1,20 @@ +# InvoiceResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**customer_id** | **str** | Customer ID associated with the invoice. | [optional] +**invoice_id** | **str** | Alphanumeric string identifying the invoice. | [optional] +**invoice_posted_on** | **datetime** | Date and time invoice was posted on, in ISO 8601 format. | [optional] +**billing_start_date** | **datetime** | Date and time (in ISO 8601 format) for initiation point of a billing cycle, signifying the start of charges for a service or subscription. | [optional] +**billing_end_date** | **datetime** | Date and time (in ISO 8601 format) for termination point of a billing cycle, signifying the end of charges for a service or subscription. | [optional] +**statement_number** | **str** | Alphanumeric string identifying the statement number. | [optional] +**currency_code** | **str** | Three-letter code representing a specific currency used for financial transactions. | [optional] +**monthly_transaction_amount** | **float** | Total billable amount for invoiced services charged within a single month. | [optional] +**transaction_line_items** | [**[Invoicelineitems]**](Invoicelineitems.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Invoicelineitems.md b/docs/Invoicelineitems.md new file mode 100644 index 0000000..0c3bc80 --- /dev/null +++ b/docs/Invoicelineitems.md @@ -0,0 +1,20 @@ +# Invoicelineitems + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **str** | Invoice line item transaction name. | [optional] +**amount** | **float** | Billed amount for line item. | [optional] +**credit_coupon_code** | **str** | Discount coupon associated with the invoice for any account or service credits. | [optional] +**rate** | **float** | Price per unit. | [optional] +**units** | **float** | Total number of units of usage. | [optional] +**product_name** | **str** | The name of the product. | [optional] +**product_group** | **str** | The broader classification of the product (e.g., `Compute` or `Full-Site Delivery`). | [optional] +**region** | **str** | The geographical area applicable for regionally based products. | [optional] +**usage_type** | **str** | The unit of measure (e.g., `requests` or `bandwidth`). | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/KvStoreApi.md b/docs/KvStoreApi.md index 940f509..b7f0152 100644 --- a/docs/KvStoreApi.md +++ b/docs/KvStoreApi.md @@ -287,7 +287,7 @@ with fastly.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = kv_store_api.KvStoreApi(api_client) cursor = "cursor_example" # str | (optional) - limit = 100 # int | (optional) if omitted the server will use the default value of 100 + limit = 1000 # int | (optional) if omitted the server will use the default value of 1000 # example passing only required values which don't have defaults set # and optional values @@ -305,7 +305,7 @@ with fastly.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **cursor** | **str**| | [optional] - **limit** | **int**| | [optional] if omitted the server will use the default value of 100 + **limit** | **int**| | [optional] if omitted the server will use the default value of 1000 ### Return type diff --git a/docs/ListInvoicesResponse.md b/docs/ListInvoicesResponse.md new file mode 100644 index 0000000..b44e675 --- /dev/null +++ b/docs/ListInvoicesResponse.md @@ -0,0 +1,13 @@ +# ListInvoicesResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[Invoice]**](Invoice.md) | | [optional] +**meta** | [**Metadata**](Metadata.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Listinvoices.md b/docs/Listinvoices.md new file mode 100644 index 0000000..96cc6da --- /dev/null +++ b/docs/Listinvoices.md @@ -0,0 +1,13 @@ +# Listinvoices + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[Invoice]**](Invoice.md) | | [optional] +**meta** | [**Metadata**](Metadata.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/LoggingScalyrAdditional.md b/docs/LoggingScalyrAdditional.md index 195aa4b..9bfbc90 100644 --- a/docs/LoggingScalyrAdditional.md +++ b/docs/LoggingScalyrAdditional.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **region** | **str** | The region that log data will be sent to. | [optional] if omitted the server will use the default value of "US" -**token** | **str** | The token to use for authentication ([https://www.scalyr.com/keys](https://www.scalyr.com/keys)). | [optional] +**token** | **str** | The token to use for authentication. | [optional] **project_id** | **str** | The name of the logfile within Scalyr. | [optional] if omitted the server will use the default value of "logplex" **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/docs/LoggingScalyrApi.md b/docs/LoggingScalyrApi.md index 5bcfa6d..15466cb 100644 --- a/docs/LoggingScalyrApi.md +++ b/docs/LoggingScalyrApi.md @@ -57,7 +57,7 @@ with fastly.ApiClient(configuration) as api_client: format = "%h %l %u %t "%r" %>s %b" # str | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). (optional) if omitted the server will use the default value of "%h %l %u %t "%r" %>s %b" format_version = 2 # int | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. (optional) if omitted the server will use the default value of 2 region = "US" # str | The region that log data will be sent to. (optional) if omitted the server will use the default value of "US" - token = "token_example" # str | The token to use for authentication ([https://www.scalyr.com/keys](https://www.scalyr.com/keys)). (optional) + token = "token_example" # str | The token to use for authentication. (optional) project_id = "logplex" # str | The name of the logfile within Scalyr. (optional) if omitted the server will use the default value of "logplex" # example passing only required values which don't have defaults set @@ -91,7 +91,7 @@ Name | Type | Description | Notes **format** | **str**| A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). | [optional] if omitted the server will use the default value of "%h %l %u %t "%r" %>s %b" **format_version** | **int**| The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. | [optional] if omitted the server will use the default value of 2 **region** | **str**| The region that log data will be sent to. | [optional] if omitted the server will use the default value of "US" - **token** | **str**| The token to use for authentication ([https://www.scalyr.com/keys](https://www.scalyr.com/keys)). | [optional] + **token** | **str**| The token to use for authentication. | [optional] **project_id** | **str**| The name of the logfile within Scalyr. | [optional] if omitted the server will use the default value of "logplex" ### Return type @@ -407,7 +407,7 @@ with fastly.ApiClient(configuration) as api_client: format = "%h %l %u %t "%r" %>s %b" # str | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). (optional) if omitted the server will use the default value of "%h %l %u %t "%r" %>s %b" format_version = 2 # int | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. (optional) if omitted the server will use the default value of 2 region = "US" # str | The region that log data will be sent to. (optional) if omitted the server will use the default value of "US" - token = "token_example" # str | The token to use for authentication ([https://www.scalyr.com/keys](https://www.scalyr.com/keys)). (optional) + token = "token_example" # str | The token to use for authentication. (optional) project_id = "logplex" # str | The name of the logfile within Scalyr. (optional) if omitted the server will use the default value of "logplex" # example passing only required values which don't have defaults set @@ -442,7 +442,7 @@ Name | Type | Description | Notes **format** | **str**| A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). | [optional] if omitted the server will use the default value of "%h %l %u %t "%r" %>s %b" **format_version** | **int**| The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. | [optional] if omitted the server will use the default value of 2 **region** | **str**| The region that log data will be sent to. | [optional] if omitted the server will use the default value of "US" - **token** | **str**| The token to use for authentication ([https://www.scalyr.com/keys](https://www.scalyr.com/keys)). | [optional] + **token** | **str**| The token to use for authentication. | [optional] **project_id** | **str**| The name of the logfile within Scalyr. | [optional] if omitted the server will use the default value of "logplex" ### Return type diff --git a/docs/LoggingScalyrResponse.md b/docs/LoggingScalyrResponse.md index 7177032..998e7cd 100644 --- a/docs/LoggingScalyrResponse.md +++ b/docs/LoggingScalyrResponse.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **format** | **str** | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). | [optional] if omitted the server will use the default value of "%h %l %u %t "%r" %>s %b" **format_version** | **str** | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. | [optional] if omitted the server will use the default value of "2" **region** | **str** | The region that log data will be sent to. | [optional] if omitted the server will use the default value of "US" -**token** | **str** | The token to use for authentication ([https://www.scalyr.com/keys](https://www.scalyr.com/keys)). | [optional] +**token** | **str** | The token to use for authentication. | [optional] **project_id** | **str** | The name of the logfile within Scalyr. | [optional] if omitted the server will use the default value of "logplex" **created_at** | **datetime, none_type** | Date and time in ISO 8601 format. | [optional] [readonly] **deleted_at** | **datetime, none_type** | Date and time in ISO 8601 format. | [optional] [readonly] diff --git a/docs/Metadata.md b/docs/Metadata.md new file mode 100644 index 0000000..d80e215 --- /dev/null +++ b/docs/Metadata.md @@ -0,0 +1,16 @@ +# Metadata + +Pagination metadata + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_cursor** | **str** | The token used to request the next set of results. | [optional] +**limit** | **int** | The number of invoices included in the response. | [optional] +**sort** | **str** | The sort order of the invoices in the response. | [optional] if omitted the server will use the default value of "billing_start_date" +**total** | **int** | Total number of records available on the backend. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/OriginInspectorHistoricalApi.md b/docs/OriginInspectorHistoricalApi.md index 3b99bfe..518b7a0 100644 --- a/docs/OriginInspectorHistoricalApi.md +++ b/docs/OriginInspectorHistoricalApi.md @@ -49,10 +49,10 @@ with fastly.ApiClient(configuration) as api_client: start = "2021-08-01T00:00:00.000Z" # str | A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the inclusive start of the query time range. If not provided, a default is chosen based on the provided `downsample` value. (optional) end = "2020-08-02T00:00:00.000Z" # str | A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the exclusive end of the query time range. If not provided, a default is chosen based on the provided `downsample` value. (optional) downsample = "hour" # str | Duration of sample windows. (optional) if omitted the server will use the default value of "hour" - metric = "resp_body_bytes,status_2xx" # str | The metric to retrieve. Up to ten comma-separated metrics are accepted. (optional) if omitted the server will use the default value of "responses" + metric = "resp_body_bytes,status_2xx" # str | The metrics to retrieve. Multiple values should be comma-separated. (optional) if omitted the server will use the default value of "responses" group_by = "host" # str | Dimensions to return in the query. Multiple dimensions may be separated by commas. For example, `group_by=host` will return one timeseries for every origin host, as a total across all POPs. (optional) limit = "100" # str | Number of results per page. The maximum is 200. (optional) if omitted the server will use the default value of "100" - cursor = "cursor_example" # str | Cursor value from a previous response to retrieve the next page. To request the first page, this should be empty. (optional) + cursor = "cursor_example" # str | 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) region = "usa" # str | Limit query to one or more specific geographic regions. Values should be comma-separated. (optional) datacenter = "SJC,STP" # str | Limit query to one or more specific POPs. Values should be comma-separated. (optional) host = "origin_1,origin_2" # str | Limit query to one or more specific origin hosts. Values should be comma-separated. (optional) @@ -84,10 +84,10 @@ Name | Type | Description | Notes **start** | **str**| A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the inclusive start of the query time range. If not provided, a default is chosen based on the provided `downsample` value. | [optional] **end** | **str**| A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the exclusive end of the query time range. If not provided, a default is chosen based on the provided `downsample` value. | [optional] **downsample** | **str**| Duration of sample windows. | [optional] if omitted the server will use the default value of "hour" - **metric** | **str**| The metric to retrieve. Up to ten comma-separated metrics are accepted. | [optional] if omitted the server will use the default value of "responses" + **metric** | **str**| The metrics to retrieve. Multiple values should be comma-separated. | [optional] if omitted the server will use the default value of "responses" **group_by** | **str**| Dimensions to return in the query. Multiple dimensions may be separated by commas. For example, `group_by=host` will return one timeseries for every origin host, as a total across all POPs. | [optional] **limit** | **str**| Number of results per page. The maximum is 200. | [optional] if omitted the server will use the default value of "100" - **cursor** | **str**| Cursor value from a previous response to retrieve the next page. To request the first page, this should be empty. | [optional] + **cursor** | **str**| 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] **region** | **str**| Limit query to one or more specific geographic regions. Values should be comma-separated. | [optional] **datacenter** | **str**| Limit query to one or more specific POPs. Values should be comma-separated. | [optional] **host** | **str**| Limit query to one or more specific origin hosts. Values should be comma-separated. | [optional] diff --git a/docs/OriginInspectorRealtimeEntry.md b/docs/OriginInspectorRealtimeEntry.md index 28dc3c1..5725299 100644 --- a/docs/OriginInspectorRealtimeEntry.md +++ b/docs/OriginInspectorRealtimeEntry.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **recorded** | [**OriginInspectorRealtimeEntryRecorded**](OriginInspectorRealtimeEntryRecorded.md) | | [optional] **aggregated** | [**{str: (OriginInspectorMeasurements,)}**](OriginInspectorMeasurements.md) | Groups [measurements](#measurements-data-model) by backend name. | [optional] -**datacenter** | **{str: ({str: (OriginInspectorMeasurements,)},)}** | Groups [measurements](#measurements-data-model) by POP, then backend name. See the [POPs API](/reference/api/utils/pops/) for details about POP identifiers. | [optional] +**datacenter** | **{str: ({str: (OriginInspectorMeasurements,)},)}** | Groups [measurements](#measurements-data-model) by POP, then backend name. See the [POPs API](https://www.fastly.com/documentation/reference/api/utils/pops/) for details about POP identifiers. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/PoolAdditional.md b/docs/PoolAdditional.md index b66d821..1abd9a5 100644 --- a/docs/PoolAdditional.md +++ b/docs/PoolAdditional.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **str** | Name for the Pool. | [optional] -**shield** | **str, none_type** | Selected POP to serve as a shield for the servers. 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] if omitted the server will use the default value of "null" +**shield** | **str, none_type** | Selected POP to serve as a shield for the servers. 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] if omitted the server will use the default value of "null" **request_condition** | **str, none_type** | Condition which, if met, will select this configuration during a request. Optional. | [optional] **tls_ciphers** | **str, none_type** | List of OpenSSL ciphers (see the [openssl.org manpages](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) for details). Optional. | [optional] **tls_sni_hostname** | **str, none_type** | SNI hostname. Optional. | [optional] diff --git a/docs/PoolApi.md b/docs/PoolApi.md index 6781a94..f4ae40f 100644 --- a/docs/PoolApi.md +++ b/docs/PoolApi.md @@ -62,7 +62,7 @@ with fastly.ApiClient(configuration) as api_client: service_id2 = "service_id_example" # str | (optional) version = "version_example" # str | (optional) name = "my-pool" # str | Name for the Pool. (optional) - shield = "null" # str, none_type | Selected POP to serve as a shield for the servers. 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) if omitted the server will use the default value of "null" + shield = "null" # str, none_type | Selected POP to serve as a shield for the servers. 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) if omitted the server will use the default value of "null" request_condition = "request_condition_example" # str, none_type | Condition which, if met, will select this configuration during a request. Optional. (optional) tls_ciphers = "tls_ciphers_example" # str, none_type | List of OpenSSL ciphers (see the [openssl.org manpages](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) for details). Optional. (optional) tls_sni_hostname = "tls_sni_hostname_example" # str, none_type | SNI hostname. Optional. (optional) @@ -115,7 +115,7 @@ Name | Type | Description | Notes **service_id2** | **str**| | [optional] **version** | **str**| | [optional] **name** | **str**| Name for the Pool. | [optional] - **shield** | **str, none_type**| Selected POP to serve as a shield for the servers. 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] if omitted the server will use the default value of "null" + **shield** | **str, none_type**| Selected POP to serve as a shield for the servers. 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] if omitted the server will use the default value of "null" **request_condition** | **str, none_type**| Condition which, if met, will select this configuration during a request. Optional. | [optional] **tls_ciphers** | **str, none_type**| List of OpenSSL ciphers (see the [openssl.org manpages](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) for details). Optional. | [optional] **tls_sni_hostname** | **str, none_type**| SNI hostname. Optional. | [optional] @@ -450,7 +450,7 @@ with fastly.ApiClient(configuration) as api_client: service_id2 = "service_id_example" # str | (optional) version = "version_example" # str | (optional) name = "my-pool" # str | Name for the Pool. (optional) - shield = "null" # str, none_type | Selected POP to serve as a shield for the servers. 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) if omitted the server will use the default value of "null" + shield = "null" # str, none_type | Selected POP to serve as a shield for the servers. 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) if omitted the server will use the default value of "null" request_condition = "request_condition_example" # str, none_type | Condition which, if met, will select this configuration during a request. Optional. (optional) tls_ciphers = "tls_ciphers_example" # str, none_type | List of OpenSSL ciphers (see the [openssl.org manpages](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) for details). Optional. (optional) tls_sni_hostname = "tls_sni_hostname_example" # str, none_type | SNI hostname. Optional. (optional) @@ -504,7 +504,7 @@ Name | Type | Description | Notes **service_id2** | **str**| | [optional] **version** | **str**| | [optional] **name** | **str**| Name for the Pool. | [optional] - **shield** | **str, none_type**| Selected POP to serve as a shield for the servers. 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] if omitted the server will use the default value of "null" + **shield** | **str, none_type**| Selected POP to serve as a shield for the servers. 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] if omitted the server will use the default value of "null" **request_condition** | **str, none_type**| Condition which, if met, will select this configuration during a request. Optional. | [optional] **tls_ciphers** | **str, none_type**| List of OpenSSL ciphers (see the [openssl.org manpages](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) for details). Optional. | [optional] **tls_sni_hostname** | **str, none_type**| SNI hostname. Optional. | [optional] diff --git a/docs/PoolResponse.md b/docs/PoolResponse.md index b1b6eaf..c57555a 100644 --- a/docs/PoolResponse.md +++ b/docs/PoolResponse.md @@ -15,7 +15,7 @@ Name | Type | Description | Notes **service_id** | **str** | | [optional] [readonly] **version** | **str** | | [optional] [readonly] **name** | **str** | Name for the Pool. | [optional] -**shield** | **str, none_type** | Selected POP to serve as a shield for the servers. 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] if omitted the server will use the default value of "null" +**shield** | **str, none_type** | Selected POP to serve as a shield for the servers. 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] if omitted the server will use the default value of "null" **request_condition** | **str, none_type** | Condition which, if met, will select this configuration during a request. Optional. | [optional] **tls_ciphers** | **str, none_type** | List of OpenSSL ciphers (see the [openssl.org manpages](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) for details). Optional. | [optional] **tls_sni_hostname** | **str, none_type** | SNI hostname. Optional. | [optional] diff --git a/docs/PoolResponsePost.md b/docs/PoolResponsePost.md index 6381bf6..f8ecc54 100644 --- a/docs/PoolResponsePost.md +++ b/docs/PoolResponsePost.md @@ -15,7 +15,7 @@ Name | Type | Description | Notes **service_id** | **str** | | [optional] [readonly] **version** | **str** | | [optional] [readonly] **name** | **str** | Name for the Pool. | [optional] -**shield** | **str, none_type** | Selected POP to serve as a shield for the servers. 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] if omitted the server will use the default value of "null" +**shield** | **str, none_type** | Selected POP to serve as a shield for the servers. 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] if omitted the server will use the default value of "null" **request_condition** | **str, none_type** | Condition which, if met, will select this configuration during a request. Optional. | [optional] **tls_ciphers** | **str, none_type** | List of OpenSSL ciphers (see the [openssl.org manpages](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) for details). Optional. | [optional] **tls_sni_hostname** | **str, none_type** | SNI hostname. Optional. | [optional] diff --git a/docs/Pop.md b/docs/Pop.md index 4c73c4b..951f6ec 100644 --- a/docs/Pop.md +++ b/docs/Pop.md @@ -4,14 +4,14 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**code** | **str** | the three-letter code for the [POP](https://developer.fastly.com/learning/concepts/pop/) | +**code** | **str** | the three-letter code for the [POP](https://www.fastly.com/documentation/learning/concepts/pop/) | **name** | **str** | the name of the POP | **group** | **str** | | **region** | **str** | | **stats_region** | **str** | the region used for stats reporting | **billing_region** | **str** | the region used for billing | **coordinates** | [**PopCoordinates**](PopCoordinates.md) | | [optional] -**shield** | **str** | the name of the [shield code](https://developer.fastly.com/learning/concepts/shielding/#choosing-a-shield-location) if this POP is suitable for shielding | [optional] +**shield** | **str** | the name of the [shield code](https://www.fastly.com/documentation/learning/concepts/shielding/#choosing-a-shield-location) if this POP is suitable for shielding | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/PublishApi.md b/docs/PublishApi.md index bb02463..ed18b30 100644 --- a/docs/PublishApi.md +++ b/docs/PublishApi.md @@ -12,7 +12,7 @@ Method | HTTP request | Description Send messages to Fanout subscribers -Send one or more messages to [Fanout](https://developer.fastly.com/learning/concepts/real-time-messaging/fanout) subscribers. Each message specifies a channel, and Fanout will deliver the message to all subscribers of its channel. > **IMPORTANT:** For compatibility with GRIP, this endpoint requires a trailing slash, and the API token may be provided in the `Authorization` header (instead of the `Fastly-Key` header) using the `Bearer` scheme. +Send one or more messages to [Fanout](https://www.fastly.com/documentation/learning/concepts/real-time-messaging/fanout) subscribers. Each message specifies a channel, and Fanout will deliver the message to all subscribers of its channel. > **IMPORTANT:** For compatibility with GRIP, this endpoint requires a trailing slash, and the API token may be provided in the `Authorization` header (instead of the `Fastly-Key` header) using the `Bearer` scheme. ### Example diff --git a/docs/RealtimeEntryDatacenter.md b/docs/RealtimeEntryDatacenter.md index ab3dfb7..26e7d56 100644 --- a/docs/RealtimeEntryDatacenter.md +++ b/docs/RealtimeEntryDatacenter.md @@ -1,6 +1,6 @@ # RealtimeEntryDatacenter -Groups [measurements](#measurements-data-model) by POP. See the [POPs API](/reference/api/utils/pops/) for details of POP identifiers. +Groups [measurements](#measurements-data-model) by POP. See the [POPs API](https://www.fastly.com/documentation/reference/api/utils/pops/) for details of POP identifiers. ## Properties Name | Type | Description | Notes diff --git a/docs/RelationshipTlsCertificate.md b/docs/RelationshipTlsCertificate.md index 9f60407..3138bee 100644 --- a/docs/RelationshipTlsCertificate.md +++ b/docs/RelationshipTlsCertificate.md @@ -1,6 +1,6 @@ # RelationshipTlsCertificate -The [TLS certificate](/reference/api/tls/custom-certs/certificates/) being used to terminate TLS traffic for a domain. Required. +The [TLS certificate](https://www.fastly.com/documentation/reference/api/tls/custom-certs/certificates/) being used to terminate TLS traffic for a domain. Required. ## Properties Name | Type | Description | Notes diff --git a/docs/RelationshipTlsConfiguration.md b/docs/RelationshipTlsConfiguration.md index 864db6d..32d35d7 100644 --- a/docs/RelationshipTlsConfiguration.md +++ b/docs/RelationshipTlsConfiguration.md @@ -1,6 +1,6 @@ # RelationshipTlsConfiguration -The [TLS configuration](/reference/api/tls/custom-certs/configuration/) being used to terminate TLS traffic. Optional. +The [TLS configuration](https://www.fastly.com/documentation/reference/api/tls/custom-certs/configuration/) being used to terminate TLS traffic. Optional. ## Properties Name | Type | Description | Notes diff --git a/docs/Results.md b/docs/Results.md index a5356ae..2dd03d2 100644 --- a/docs/Results.md +++ b/docs/Results.md @@ -84,8 +84,10 @@ Name | Type | Description | Notes **imgopto** | **int** | Number of responses that came from the Fastly Image Optimizer service. If the service receives 10 requests for an image, this stat will be 10 regardless of how many times the image was transformed. | [optional] **imgopto_resp_body_bytes** | **int** | Total body bytes delivered from the Fastly Image Optimizer service, including shield traffic. | [optional] **imgopto_resp_header_bytes** | **int** | Total header bytes delivered from the Fastly Image Optimizer service, including shield traffic. | [optional] +**imgopto_shield** | **int** | Number of responses that came from the Fastly Image Optimizer service via a shield. | [optional] **imgopto_shield_resp_body_bytes** | **int** | Total body bytes delivered via a shield from the Fastly Image Optimizer service. | [optional] **imgopto_shield_resp_header_bytes** | **int** | Total header bytes delivered via a shield from the Fastly Image Optimizer service. | [optional] +**imgopto_transforms** | **int** | Number of transforms performed by the Fastly Image Optimizer service. | [optional] **imgvideo** | **int** | Number of video responses that came from the Fastly Image Optimizer service. | [optional] **imgvideo_frames** | **int** | Number of video frames that came from the Fastly Image Optimizer service. A video frame is an individual image within a sequence of video. | [optional] **imgvideo_resp_header_bytes** | **int** | Total header bytes of video delivered from the Fastly Image Optimizer service. | [optional] diff --git a/docs/SecretStoreApi.md b/docs/SecretStoreApi.md index 518207a..27f6c82 100644 --- a/docs/SecretStoreApi.md +++ b/docs/SecretStoreApi.md @@ -360,14 +360,15 @@ configuration.api_key['token'] = 'YOUR_API_KEY' with fastly.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = secret_store_api.SecretStoreApi(api_client) - cursor = "cursor_example" # str | Cursor value from a previous response to retrieve the next page. To request the first page, this should be empty. (optional) + cursor = "cursor_example" # str | 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) limit = "100" # str | Number of results per page. The maximum is 200. (optional) if omitted the server will use the default value of "100" + name = "name_example" # str | Returns a one-element array containing the details for the named secret store. (optional) # example passing only required values which don't have defaults set # and optional values try: # Get all secret stores - api_response = api_instance.get_secret_stores(cursor=cursor, limit=limit) + api_response = api_instance.get_secret_stores(cursor=cursor, limit=limit, name=name) pprint(api_response) except fastly.ApiException as e: print("Exception when calling SecretStoreApi->get_secret_stores: %s\n" % e) @@ -378,8 +379,9 @@ with fastly.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **cursor** | **str**| Cursor value from a previous response to retrieve the next page. To request the first page, this should be empty. | [optional] + **cursor** | **str**| 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] **limit** | **str**| Number of results per page. The maximum is 200. | [optional] if omitted the server will use the default value of "100" + **name** | **str**| Returns a one-element array containing the details for the named secret store. | [optional] ### Return type diff --git a/docs/SecretStoreItemApi.md b/docs/SecretStoreItemApi.md index c570f7e..ddcb968 100644 --- a/docs/SecretStoreItemApi.md +++ b/docs/SecretStoreItemApi.md @@ -303,7 +303,7 @@ with fastly.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = secret_store_item_api.SecretStoreItemApi(api_client) store_id = "store_id_example" # str | - cursor = "cursor_example" # str | Cursor value from a previous response to retrieve the next page. To request the first page, this should be empty. (optional) + cursor = "cursor_example" # str | 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) limit = "100" # str | Number of results per page. The maximum is 200. (optional) if omitted the server will use the default value of "100" # example passing only required values which don't have defaults set @@ -330,7 +330,7 @@ with fastly.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **store_id** | **str**| | - **cursor** | **str**| Cursor value from a previous response to retrieve the next page. To request the first page, this should be empty. | [optional] + **cursor** | **str**| 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] **limit** | **str**| Number of results per page. The maximum is 200. | [optional] if omitted the server will use the default value of "100" ### Return type diff --git a/docs/ServiceDetail.md b/docs/ServiceDetail.md index ccbef61..cf0814d 100644 --- a/docs/ServiceDetail.md +++ b/docs/ServiceDetail.md @@ -14,7 +14,7 @@ Name | Type | Description | Notes **id** | **str** | | [optional] [readonly] **publish_key** | **str** | Unused at this time. | [optional] **paused** | **bool** | Whether the service is paused. Services are paused due to a lack of traffic for an extended period of time. Services are resumed either when a draft version is activated or a locked version is cloned and reactivated. | [optional] -**versions** | [**[SchemasVersionResponse]**](SchemasVersionResponse.md) | A list of [versions](/reference/api/services/version/) associated with the service. | [optional] +**versions** | [**[SchemasVersionResponse]**](SchemasVersionResponse.md) | A list of [versions](https://www.fastly.com/documentation/reference/api/services/version/) associated with the service. | [optional] **active_version** | [**ServiceVersionDetailOrNull**](ServiceVersionDetailOrNull.md) | | [optional] **version** | [**ServiceVersionDetail**](ServiceVersionDetail.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/docs/ServiceListResponse.md b/docs/ServiceListResponse.md index ddcd24d..24e6a50 100644 --- a/docs/ServiceListResponse.md +++ b/docs/ServiceListResponse.md @@ -12,8 +12,8 @@ Name | Type | Description | Notes **customer_id** | **str** | Alphanumeric string identifying the customer. | [optional] **type** | **str** | The type of this service. | [optional] **id** | **str** | | [optional] [readonly] -**version** | **int** | Current [version](/reference/api/services/version/) of the service. | [optional] -**versions** | [**[SchemasVersionResponse]**](SchemasVersionResponse.md) | A list of [versions](/reference/api/services/version/) associated with the service. | [optional] +**version** | **int** | Current [version](https://www.fastly.com/documentation/reference/api/services/version/) of the service. | [optional] +**versions** | [**[SchemasVersionResponse]**](SchemasVersionResponse.md) | A list of [versions](https://www.fastly.com/documentation/reference/api/services/version/) associated with the service. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ServiceListResponseAllOf.md b/docs/ServiceListResponseAllOf.md index ff1494b..0e0b4d4 100644 --- a/docs/ServiceListResponseAllOf.md +++ b/docs/ServiceListResponseAllOf.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | [optional] [readonly] -**version** | **int** | Current [version](/reference/api/services/version/) of the service. | [optional] -**versions** | [**[SchemasVersionResponse]**](SchemasVersionResponse.md) | A list of [versions](/reference/api/services/version/) associated with the service. | [optional] +**version** | **int** | Current [version](https://www.fastly.com/documentation/reference/api/services/version/) of the service. | [optional] +**versions** | [**[SchemasVersionResponse]**](SchemasVersionResponse.md) | A list of [versions](https://www.fastly.com/documentation/reference/api/services/version/) associated with the service. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ServiceResponse.md b/docs/ServiceResponse.md index b1e13dc..f308d1b 100644 --- a/docs/ServiceResponse.md +++ b/docs/ServiceResponse.md @@ -14,7 +14,7 @@ Name | Type | Description | Notes **id** | **str** | | [optional] [readonly] **publish_key** | **str** | Unused at this time. | [optional] **paused** | **bool** | Whether the service is paused. Services are paused due to a lack of traffic for an extended period of time. Services are resumed either when a draft version is activated or a locked version is cloned and reactivated. | [optional] -**versions** | [**[SchemasVersionResponse]**](SchemasVersionResponse.md) | A list of [versions](/reference/api/services/version/) associated with the service. | [optional] +**versions** | [**[SchemasVersionResponse]**](SchemasVersionResponse.md) | A list of [versions](https://www.fastly.com/documentation/reference/api/services/version/) associated with the service. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ServiceResponseAllOf.md b/docs/ServiceResponseAllOf.md index 7515a03..5ca007e 100644 --- a/docs/ServiceResponseAllOf.md +++ b/docs/ServiceResponseAllOf.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **id** | **str** | | [optional] [readonly] **publish_key** | **str** | Unused at this time. | [optional] **paused** | **bool** | Whether the service is paused. Services are paused due to a lack of traffic for an extended period of time. Services are resumed either when a draft version is activated or a locked version is cloned and reactivated. | [optional] -**versions** | [**[SchemasVersionResponse]**](SchemasVersionResponse.md) | A list of [versions](/reference/api/services/version/) associated with the service. | [optional] +**versions** | [**[SchemasVersionResponse]**](SchemasVersionResponse.md) | A list of [versions](https://www.fastly.com/documentation/reference/api/services/version/) associated with the service. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TlsConfigurationResponseAttributes.md b/docs/TlsConfigurationResponseAttributes.md index b67f50b..79c3b45 100644 --- a/docs/TlsConfigurationResponseAttributes.md +++ b/docs/TlsConfigurationResponseAttributes.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **created_at** | **datetime, none_type** | Date and time in ISO 8601 format. | [optional] [readonly] **deleted_at** | **datetime, none_type** | Date and time in ISO 8601 format. | [optional] [readonly] **updated_at** | **datetime, none_type** | Date and time in ISO 8601 format. | [optional] [readonly] -**default** | **bool** | Signifies whether or not Fastly will use this configuration as a default when creating a new [TLS Activation](/reference/api/tls/custom-certs/activations/). | [optional] [readonly] +**default** | **bool** | Signifies whether or not Fastly will use this configuration as a default when creating a new [TLS Activation](https://www.fastly.com/documentation/reference/api/tls/custom-certs/activations/). | [optional] [readonly] **http_protocols** | **[str]** | HTTP protocols available on your configuration. | [optional] [readonly] **tls_protocols** | **[str]** | TLS protocols available on your configuration. | [optional] [readonly] **bulk** | **bool** | Signifies whether the configuration is used for Platform TLS or not. | [optional] [readonly] diff --git a/docs/TlsConfigurationResponseAttributesAllOf.md b/docs/TlsConfigurationResponseAttributesAllOf.md index 0ba4622..ea2354a 100644 --- a/docs/TlsConfigurationResponseAttributesAllOf.md +++ b/docs/TlsConfigurationResponseAttributesAllOf.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**default** | **bool** | Signifies whether or not Fastly will use this configuration as a default when creating a new [TLS Activation](/reference/api/tls/custom-certs/activations/). | [optional] [readonly] +**default** | **bool** | Signifies whether or not Fastly will use this configuration as a default when creating a new [TLS Activation](https://www.fastly.com/documentation/reference/api/tls/custom-certs/activations/). | [optional] [readonly] **http_protocols** | **[str]** | HTTP protocols available on your configuration. | [optional] [readonly] **tls_protocols** | **[str]** | TLS protocols available on your configuration. | [optional] [readonly] **bulk** | **bool** | Signifies whether the configuration is used for Platform TLS or not. | [optional] [readonly] diff --git a/docs/TlsCsr.md b/docs/TlsCsr.md new file mode 100644 index 0000000..456e667 --- /dev/null +++ b/docs/TlsCsr.md @@ -0,0 +1,12 @@ +# TlsCsr + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**TlsCsrData**](TlsCsrData.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TlsCsrData.md b/docs/TlsCsrData.md new file mode 100644 index 0000000..7c71da5 --- /dev/null +++ b/docs/TlsCsrData.md @@ -0,0 +1,14 @@ +# TlsCsrData + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**TypeTlsCsr**](TypeTlsCsr.md) | | [optional] +**attributes** | [**TlsCsrDataAttributes**](TlsCsrDataAttributes.md) | | [optional] +**relationships** | [**RelationshipTlsPrivateKey**](RelationshipTlsPrivateKey.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TlsCsrDataAttributes.md b/docs/TlsCsrDataAttributes.md new file mode 100644 index 0000000..a6c6902 --- /dev/null +++ b/docs/TlsCsrDataAttributes.md @@ -0,0 +1,22 @@ +# TlsCsrDataAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sans** | **[str]** | Subject Alternate Names - An array of one or more fully qualified domain names or public IP addresses to be secured by this certificate. Required. | +**common_name** | **str** | Common Name (CN) - The fully qualified domain name (FQDN) to be secured by this certificate. The common name should be one of the entries in the SANs parameter. | [optional] +**country** | **str** | Country (C) - The two-letter ISO country code where the organization is located. | [optional] +**state** | **str** | State (S) - The state, province, region, or county where the organization is located. This should not be abbreviated. | [optional] +**city** | **str** | Locality (L) - The locality, city, town, or village where the organization is located. | [optional] +**postal_code** | **str** | Postal Code - The postal code where the organization is located. | [optional] +**street_address** | **str** | Street Address - The street address where the organization is located. | [optional] +**organization** | **str** | Organization (O) - The legal name of the organization, including any suffixes. This should not be abbreviated. | [optional] +**organizational_unit** | **str** | Organizational Unit (OU) - The internal division of the organization managing the certificate. | [optional] +**email** | **str** | Email Address (EMAIL) - The organizational contact for this. | [optional] +**key_type** | **str** | CSR Key Type. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TlsCsrErrorResponse.md b/docs/TlsCsrErrorResponse.md new file mode 100644 index 0000000..491e67d --- /dev/null +++ b/docs/TlsCsrErrorResponse.md @@ -0,0 +1,12 @@ +# TlsCsrErrorResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | [**[ErrorResponseData]**](ErrorResponseData.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TlsCsrResponse.md b/docs/TlsCsrResponse.md new file mode 100644 index 0000000..1452160 --- /dev/null +++ b/docs/TlsCsrResponse.md @@ -0,0 +1,12 @@ +# TlsCsrResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**TlsCsrResponseData**](TlsCsrResponseData.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TlsCsrResponseAttributes.md b/docs/TlsCsrResponseAttributes.md new file mode 100644 index 0000000..88394b3 --- /dev/null +++ b/docs/TlsCsrResponseAttributes.md @@ -0,0 +1,12 @@ +# TlsCsrResponseAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | **str** | The PEM encoded CSR. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TlsCsrResponseData.md b/docs/TlsCsrResponseData.md new file mode 100644 index 0000000..9cbb9fd --- /dev/null +++ b/docs/TlsCsrResponseData.md @@ -0,0 +1,15 @@ +# TlsCsrResponseData + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] +**type** | [**TypeTlsCsr**](TypeTlsCsr.md) | | [optional] +**attributes** | [**TlsCsrResponseAttributes**](TlsCsrResponseAttributes.md) | | [optional] +**relationships** | [**RelationshipTlsPrivateKey**](RelationshipTlsPrivateKey.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TlsCsrsApi.md b/docs/TlsCsrsApi.md new file mode 100644 index 0000000..0d9e082 --- /dev/null +++ b/docs/TlsCsrsApi.md @@ -0,0 +1,115 @@ +# fastly.TlsCsrsApi + +All URIs are relative to *https://api.fastly.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_csr**](TlsCsrsApi.md#create_csr) | **POST** /tls/certificate_signing_requests | Create CSR + + +# **create_csr** +> TlsCsrResponse create_csr() + +Create CSR + +Creates a certificate signing request (CSR). + +### Example + +* Api Key Authentication (token): + +```python +import time +import fastly +from fastly.api import tls_csrs_api +from fastly.model.tls_csr_response import TlsCsrResponse +from fastly.model.tls_csr import TlsCsr +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. +configuration = fastly.Configuration( + host = "https://api.fastly.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: token +configuration.api_key['token'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['token'] = 'Bearer' + +# Enter a context with an instance of the API client +with fastly.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = tls_csrs_api.TlsCsrsApi(api_client) + tls_csr = TlsCsr( + data=TlsCsrData( + type=TypeTlsCsr("csr"), + attributes=TlsCsrDataAttributes( + sans=[ + "sans_example", + ], + common_name="common_name_example", + country="country_example", + state="state_example", + city="city_example", + postal_code="postal_code_example", + street_address="street_address_example", + organization="organization_example", + organizational_unit="organizational_unit_example", + email="email_example", + key_type="RSA2048", + ), + relationships=RelationshipTlsPrivateKey( + tls_private_key=RelationshipTlsPrivateKeyTlsPrivateKey( + data=RelationshipMemberTlsPrivateKey( + type=TypeTlsPrivateKey("tls_private_key"), + ), + ), + ), + ), + ) # TlsCsr | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create CSR + api_response = api_instance.create_csr(tls_csr=tls_csr) + pprint(api_response) + except fastly.ApiException as e: + print("Exception when calling TlsCsrsApi->create_csr: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tls_csr** | [**TlsCsr**](TlsCsr.md)| | [optional] + +### Return type + +[**TlsCsrResponse**](TlsCsrResponse.md) + +### Authorization + +[token](../README.md#token) + +### HTTP request headers + + - **Content-Type**: application/vnd.api+json + - **Accept**: application/vnd.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Created | - | + +[[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) + diff --git a/docs/TlsSubscriptionResponseAttributes.md b/docs/TlsSubscriptionResponseAttributes.md index 813b430..2a049d7 100644 --- a/docs/TlsSubscriptionResponseAttributes.md +++ b/docs/TlsSubscriptionResponseAttributes.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes **deleted_at** | **datetime, none_type** | Date and time in ISO 8601 format. | [optional] [readonly] **updated_at** | **datetime, none_type** | Date and time in ISO 8601 format. | [optional] [readonly] **state** | **str** | The current state of your subscription. | [optional] +**has_active_order** | **bool** | Subscription has an active order | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TlsSubscriptionResponseAttributesAllOf.md b/docs/TlsSubscriptionResponseAttributesAllOf.md index b8e575e..b499173 100644 --- a/docs/TlsSubscriptionResponseAttributesAllOf.md +++ b/docs/TlsSubscriptionResponseAttributesAllOf.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **state** | **str** | The current state of your subscription. | [optional] +**has_active_order** | **bool** | Subscription has an active order | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TokensApi.md b/docs/TokensApi.md index 5a53079..fa3751c 100644 --- a/docs/TokensApi.md +++ b/docs/TokensApi.md @@ -96,7 +96,7 @@ void (empty response body) Create a token -Create an API token. If two-factor authentication is enabled for your account, review [the instructions](/reference/api/auth-tokens/user/) for including a one-time password in the request. +Create an API token. If two-factor authentication is enabled for your account, review [the instructions](https://www.fastly.com/documentation/reference/api/auth-tokens/user/) for including a one-time password in the request. ### Example diff --git a/docs/TypeTlsCsr.md b/docs/TypeTlsCsr.md new file mode 100644 index 0000000..59df872 --- /dev/null +++ b/docs/TypeTlsCsr.md @@ -0,0 +1,12 @@ +# TypeTlsCsr + +CSR Resource Type + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | CSR Resource Type | defaults to "csr", must be one of ["csr", ] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VclApi.md b/docs/VclApi.md index e5b98b3..1698bd4 100644 --- a/docs/VclApi.md +++ b/docs/VclApi.md @@ -294,7 +294,7 @@ Name | Type | Description | Notes Get boilerplate VCL -Return boilerplate VCL with the service's TTL from the [settings](/reference/api/vcl-services/settings/). +Return boilerplate VCL with the service's TTL from the [settings](https://www.fastly.com/documentation/reference/api/vcl-services/settings/). ### Example diff --git a/docs/WafActiveRulesApi.md b/docs/WafActiveRulesApi.md index 6c88bc0..81b26ce 100644 --- a/docs/WafActiveRulesApi.md +++ b/docs/WafActiveRulesApi.md @@ -107,7 +107,7 @@ void (empty response body) Update multiple active rules -Bulk update all active rules on a [firewall version](https://developer.fastly.com/reference/api/waf/firewall-version/). This endpoint will not add new active rules, only update existing active rules. +Bulk update all active rules on a [firewall version](https://www.fastly.com/documentation/reference/api/waf/firewall-version/). This endpoint will not add new active rules, only update existing active rules. ### Example diff --git a/fastly/__init__.py b/fastly/__init__.py index 0e53a7e..0caeeae 100644 --- a/fastly/__init__.py +++ b/fastly/__init__.py @@ -10,7 +10,7 @@ """ -__version__ = "5.0.1" +__version__ = "5.1.0" # import ApiClient from fastly.api_client import ApiClient diff --git a/fastly/api/automation_tokens_api.py b/fastly/api/automation_tokens_api.py index 4ee8fb6..dcd1153 100644 --- a/fastly/api/automation_tokens_api.py +++ b/fastly/api/automation_tokens_api.py @@ -23,8 +23,8 @@ ) from fastly.model.automation_token_create_request import AutomationTokenCreateRequest from fastly.model.automation_token_create_response import AutomationTokenCreateResponse +from fastly.model.automation_token_error_response import AutomationTokenErrorResponse from fastly.model.automation_token_response import AutomationTokenResponse -from fastly.model.error_response import ErrorResponse from fastly.model.inline_response2001 import InlineResponse2001 @@ -286,7 +286,7 @@ def __init__(self, api_client=None): ) self.revoke_automation_token_id_endpoint = _Endpoint( settings={ - 'response_type': (ErrorResponse,), + 'response_type': (AutomationTokenErrorResponse,), 'auth': [ 'token' ], @@ -697,7 +697,7 @@ def revoke_automation_token_id( async_req (bool): execute request asynchronously Returns: - ErrorResponse + AutomationTokenErrorResponse If the method is called asynchronously, returns the request thread. """ diff --git a/fastly/api/backend_api.py b/fastly/api/backend_api.py index 3fcaf81..0a9a069 100644 --- a/fastly/api/backend_api.py +++ b/fastly/api/backend_api.py @@ -785,7 +785,7 @@ def create_backend( 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] @@ -1154,7 +1154,7 @@ def update_backend( 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] diff --git a/fastly/api/billing_invoices_api.py b/fastly/api/billing_invoices_api.py new file mode 100644 index 0000000..584a3a1 --- /dev/null +++ b/fastly/api/billing_invoices_api.py @@ -0,0 +1,322 @@ +""" + Fastly API + + Via the Fastly API you can perform any of the operations that are possible within the management console, including creating services, domains, and backends, configuring rules or uploading your own application code, as well as account operations such as user administration and billing reports. The API is organized into collections of endpoints that allow manipulation of objects related to Fastly services and accounts. For the most accurate and up-to-date API reference content, visit our [Developer Hub](https://developer.fastly.com/reference/api/) # noqa: E501 + + The version of the OpenAPI document: 1.0.0 + Contact: oss@fastly.com +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fastly.api_client import ApiClient, Endpoint as _Endpoint +from fastly.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from fastly.model.error import Error +from fastly.model.invoice_response import InvoiceResponse +from fastly.model.list_invoices_response import ListInvoicesResponse + + +class BillingInvoicesApi(object): + """NOTE: This class is auto generated. + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_invoice_by_invoice_id_endpoint = _Endpoint( + settings={ + 'response_type': (InvoiceResponse,), + 'auth': [ + 'token' + ], + 'endpoint_path': '/billing/v3/invoices/{invoice_id}', + 'operation_id': 'get_invoice_by_invoice_id', + 'http_method': 'GET', + 'servers': [ + { + 'url': "https://api.fastly.com", + 'description': "No description provided", + }, + ] + }, + params_map={ + 'all': [ + 'invoice_id', + ], + 'required': [ + 'invoice_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'invoice_id': + (str,), + }, + 'attribute_map': { + 'invoice_id': 'invoice_id', + }, + 'location_map': { + 'invoice_id': 'path', + }, + 'path_params_allow_reserved_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.list_invoices_endpoint = _Endpoint( + settings={ + 'response_type': (ListInvoicesResponse,), + 'auth': [ + 'token' + ], + 'endpoint_path': '/billing/v3/invoices', + 'operation_id': 'list_invoices', + 'http_method': 'GET', + 'servers': [ + { + 'url': "https://api.fastly.com", + 'description': "No description provided", + }, + ] + }, + params_map={ + 'all': [ + 'billing_start_date', + 'billing_end_date', + 'limit', + 'cursor', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'billing_start_date': + (str,), + 'billing_end_date': + (str,), + 'limit': + (str,), + 'cursor': + (str,), + }, + 'attribute_map': { + 'billing_start_date': 'billing_start_date', + 'billing_end_date': 'billing_end_date', + 'limit': 'limit', + 'cursor': 'cursor', + }, + 'location_map': { + 'billing_start_date': 'query', + 'billing_end_date': 'query', + 'limit': 'query', + 'cursor': 'query', + }, + 'path_params_allow_reserved_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_invoice_by_invoice_id( + self, + invoice_id, + **kwargs + ): + """Get invoice by ID. # noqa: E501 + + Returns invoice associated with the invoice id. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_invoice_by_invoice_id(invoice_id, async_req=True) + >>> result = thread.get() + + Args: + invoice_id (str): Alphanumeric string identifying the invoice. + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + InvoiceResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['invoice_id'] = \ + invoice_id + return self.get_invoice_by_invoice_id_endpoint.call_with_http_info(**kwargs) + + def list_invoices( + self, + **kwargs + ): + """List of invoices. # noqa: E501 + + Returns the list of invoices, sorted by billing start date (newest to oldest). # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_invoices(async_req=True) + >>> result = thread.get() + + + Keyword Args: + billing_start_date (str): [optional] + billing_end_date (str): [optional] + limit (str): Number of results per page. The maximum is 200.. [optional] if omitted the server will use the default value of "100" + cursor (str): 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_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + ListInvoicesResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.list_invoices_endpoint.call_with_http_info(**kwargs) + diff --git a/fastly/api/director_api.py b/fastly/api/director_api.py index 79b9784..b0f183a 100644 --- a/fastly/api/director_api.py +++ b/fastly/api/director_api.py @@ -459,7 +459,7 @@ def create_director( comment (str, none_type): A freeform descriptive note.. [optional] name (str): Name for the Director.. [optional] quorum (int): The percentage of capacity that needs to be up for a director to be considered up. `0` to `100`.. [optional] if omitted the server will use the default value of 75 - shield (str, none_type): 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] if omitted the server will use the default value of "null" + shield (str, none_type): 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] if omitted the server will use the default value of "null" type (int): What type of load balance group to use.. [optional] if omitted the server will use the default value of 1 retries (int): How many backends to search if it fails.. [optional] if omitted the server will use the default value of 5 _return_http_data_only (bool): response data without head status diff --git a/fastly/api/domain_inspector_historical_api.py b/fastly/api/domain_inspector_historical_api.py index 5dc8662..3461e9a 100644 --- a/fastly/api/domain_inspector_historical_api.py +++ b/fastly/api/domain_inspector_historical_api.py @@ -189,10 +189,10 @@ def get_domain_inspector_historical( start (str): A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the inclusive start of the query time range. If not provided, a default is chosen based on the provided `downsample` value.. [optional] end (str): A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the exclusive end of the query time range. If not provided, a default is chosen based on the provided `downsample` value.. [optional] downsample (str): Duration of sample windows.. [optional] if omitted the server will use the default value of "hour" - metric (str): The metric to retrieve. Up to ten comma-separated metrics are accepted.. [optional] if omitted the server will use the default value of "edge_requests" + metric (str): The metrics to retrieve. Multiple values should be comma-separated.. [optional] if omitted the server will use the default value of "edge_requests" group_by (str): Dimensions to return in the query. Multiple dimensions may be separated by commas. For example, `group_by=domain` will return one timeseries for every domain, as a total across all datacenters (POPs). . [optional] limit (str): Number of results per page. The maximum is 200.. [optional] if omitted the server will use the default value of "100" - cursor (str): Cursor value from a previous response to retrieve the next page. To request the first page, this should be empty.. [optional] + cursor (str): 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] region (str): Limit query to one or more specific geographic regions. Values should be comma-separated. . [optional] datacenter (str): Limit query to one or more specific POPs. Values should be comma-separated.. [optional] domain (str): Limit query to one or more specific domains. Values should be comma-separated.. [optional] diff --git a/fastly/api/kv_store_api.py b/fastly/api/kv_store_api.py index fdc373f..7497e26 100644 --- a/fastly/api/kv_store_api.py +++ b/fastly/api/kv_store_api.py @@ -520,7 +520,7 @@ def get_stores( Keyword Args: cursor (str): [optional] - limit (int): [optional] if omitted the server will use the default value of 100 + limit (int): [optional] if omitted the server will use the default value of 1000 _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object diff --git a/fastly/api/logging_scalyr_api.py b/fastly/api/logging_scalyr_api.py index 87c9705..a23440e 100644 --- a/fastly/api/logging_scalyr_api.py +++ b/fastly/api/logging_scalyr_api.py @@ -525,7 +525,7 @@ def create_log_scalyr( format (str): A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats).. [optional] if omitted the server will use the default value of "%h %l %u %t "%r" %>s %b" format_version (int): The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. . [optional] if omitted the server will use the default value of 2 region (str): The region that log data will be sent to.. [optional] if omitted the server will use the default value of "US" - token (str): The token to use for authentication ([https://www.scalyr.com/keys](https://www.scalyr.com/keys)).. [optional] + token (str): The token to use for authentication.. [optional] project_id (str): The name of the logfile within Scalyr.. [optional] if omitted the server will use the default value of "logplex" _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -871,7 +871,7 @@ def update_log_scalyr( format (str): A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats).. [optional] if omitted the server will use the default value of "%h %l %u %t "%r" %>s %b" format_version (int): The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. . [optional] if omitted the server will use the default value of 2 region (str): The region that log data will be sent to.. [optional] if omitted the server will use the default value of "US" - token (str): The token to use for authentication ([https://www.scalyr.com/keys](https://www.scalyr.com/keys)).. [optional] + token (str): The token to use for authentication.. [optional] project_id (str): The name of the logfile within Scalyr.. [optional] if omitted the server will use the default value of "logplex" _return_http_data_only (bool): response data without head status code and headers. Default is True. diff --git a/fastly/api/origin_inspector_historical_api.py b/fastly/api/origin_inspector_historical_api.py index 8ebee2e..7a4111b 100644 --- a/fastly/api/origin_inspector_historical_api.py +++ b/fastly/api/origin_inspector_historical_api.py @@ -189,10 +189,10 @@ def get_origin_inspector_historical( start (str): A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the inclusive start of the query time range. If not provided, a default is chosen based on the provided `downsample` value.. [optional] end (str): A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the exclusive end of the query time range. If not provided, a default is chosen based on the provided `downsample` value.. [optional] downsample (str): Duration of sample windows.. [optional] if omitted the server will use the default value of "hour" - metric (str): The metric to retrieve. Up to ten comma-separated metrics are accepted.. [optional] if omitted the server will use the default value of "responses" + metric (str): The metrics to retrieve. Multiple values should be comma-separated.. [optional] if omitted the server will use the default value of "responses" group_by (str): Dimensions to return in the query. Multiple dimensions may be separated by commas. For example, `group_by=host` will return one timeseries for every origin host, as a total across all POPs. . [optional] limit (str): Number of results per page. The maximum is 200.. [optional] if omitted the server will use the default value of "100" - cursor (str): Cursor value from a previous response to retrieve the next page. To request the first page, this should be empty.. [optional] + cursor (str): 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] region (str): Limit query to one or more specific geographic regions. Values should be comma-separated. . [optional] datacenter (str): Limit query to one or more specific POPs. Values should be comma-separated.. [optional] host (str): Limit query to one or more specific origin hosts. Values should be comma-separated.. [optional] diff --git a/fastly/api/pool_api.py b/fastly/api/pool_api.py index 8867aec..6bdc945 100644 --- a/fastly/api/pool_api.py +++ b/fastly/api/pool_api.py @@ -751,7 +751,7 @@ def create_server_pool( service_id2 (str): [optional] version (str): [optional] name (str): Name for the Pool.. [optional] - shield (str, none_type): Selected POP to serve as a shield for the servers. 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] if omitted the server will use the default value of "null" + shield (str, none_type): Selected POP to serve as a shield for the servers. 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] if omitted the server will use the default value of "null" request_condition (str, none_type): Condition which, if met, will select this configuration during a request. Optional.. [optional] tls_ciphers (str, none_type): List of OpenSSL ciphers (see the [openssl.org manpages](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) for details). Optional.. [optional] tls_sni_hostname (str, none_type): SNI hostname. Optional.. [optional] @@ -1116,7 +1116,7 @@ def update_server_pool( service_id2 (str): [optional] version (str): [optional] name (str): Name for the Pool.. [optional] - shield (str, none_type): Selected POP to serve as a shield for the servers. 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] if omitted the server will use the default value of "null" + shield (str, none_type): Selected POP to serve as a shield for the servers. 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] if omitted the server will use the default value of "null" request_condition (str, none_type): Condition which, if met, will select this configuration during a request. Optional.. [optional] tls_ciphers (str, none_type): List of OpenSSL ciphers (see the [openssl.org manpages](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) for details). Optional.. [optional] tls_sni_hostname (str, none_type): SNI hostname. Optional.. [optional] diff --git a/fastly/api/publish_api.py b/fastly/api/publish_api.py index d97aacc..c70bdb6 100644 --- a/fastly/api/publish_api.py +++ b/fastly/api/publish_api.py @@ -105,7 +105,7 @@ def publish( ): """Send messages to Fanout subscribers # noqa: E501 - Send one or more messages to [Fanout](https://developer.fastly.com/learning/concepts/real-time-messaging/fanout) subscribers. Each message specifies a channel, and Fanout will deliver the message to all subscribers of its channel. > **IMPORTANT:** For compatibility with GRIP, this endpoint requires a trailing slash, and the API token may be provided in the `Authorization` header (instead of the `Fastly-Key` header) using the `Bearer` scheme. # noqa: E501 + Send one or more messages to [Fanout](https://www.fastly.com/documentation/learning/concepts/real-time-messaging/fanout) subscribers. Each message specifies a channel, and Fanout will deliver the message to all subscribers of its channel. > **IMPORTANT:** For compatibility with GRIP, this endpoint requires a trailing slash, and the API token may be provided in the `Authorization` header (instead of the `Fastly-Key` header) using the `Bearer` scheme. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/fastly/api/secret_store_api.py b/fastly/api/secret_store_api.py index c39b8d3..c8b8620 100644 --- a/fastly/api/secret_store_api.py +++ b/fastly/api/secret_store_api.py @@ -279,6 +279,7 @@ def __init__(self, api_client=None): 'all': [ 'cursor', 'limit', + 'name', ], 'required': [], 'nullable': [ @@ -298,14 +299,18 @@ def __init__(self, api_client=None): (str,), 'limit': (str,), + 'name': + (str,), }, 'attribute_map': { 'cursor': 'cursor', 'limit': 'limit', + 'name': 'name', }, 'location_map': { 'cursor': 'query', 'limit': 'query', + 'name': 'query', }, 'path_params_allow_reserved_map': { }, @@ -690,8 +695,9 @@ def get_secret_stores( Keyword Args: - cursor (str): Cursor value from a previous response to retrieve the next page. To request the first page, this should be empty.. [optional] + cursor (str): 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] limit (str): Number of results per page. The maximum is 200.. [optional] if omitted the server will use the default value of "100" + name (str): Returns a one-element array containing the details for the named secret store.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object diff --git a/fastly/api/secret_store_item_api.py b/fastly/api/secret_store_item_api.py index 7c033a8..fed5593 100644 --- a/fastly/api/secret_store_item_api.py +++ b/fastly/api/secret_store_item_api.py @@ -683,7 +683,7 @@ def get_secrets( store_id (str): Keyword Args: - cursor (str): Cursor value from a previous response to retrieve the next page. To request the first page, this should be empty.. [optional] + cursor (str): 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] limit (str): Number of results per page. The maximum is 200.. [optional] if omitted the server will use the default value of "100" _return_http_data_only (bool): response data without head status code and headers. Default is True. diff --git a/fastly/api/tls_csrs_api.py b/fastly/api/tls_csrs_api.py new file mode 100644 index 0000000..206bc6b --- /dev/null +++ b/fastly/api/tls_csrs_api.py @@ -0,0 +1,168 @@ +""" + Fastly API + + Via the Fastly API you can perform any of the operations that are possible within the management console, including creating services, domains, and backends, configuring rules or uploading your own application code, as well as account operations such as user administration and billing reports. The API is organized into collections of endpoints that allow manipulation of objects related to Fastly services and accounts. For the most accurate and up-to-date API reference content, visit our [Developer Hub](https://developer.fastly.com/reference/api/) # noqa: E501 + + The version of the OpenAPI document: 1.0.0 + Contact: oss@fastly.com +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fastly.api_client import ApiClient, Endpoint as _Endpoint +from fastly.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from fastly.model.tls_csr import TlsCsr +from fastly.model.tls_csr_response import TlsCsrResponse + + +class TlsCsrsApi(object): + """NOTE: This class is auto generated. + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_csr_endpoint = _Endpoint( + settings={ + 'response_type': (TlsCsrResponse,), + 'auth': [ + 'token' + ], + 'endpoint_path': '/tls/certificate_signing_requests', + 'operation_id': 'create_csr', + 'http_method': 'POST', + 'servers': [ + { + 'url': "https://api.fastly.com", + 'description': "No description provided", + }, + ] + }, + params_map={ + 'all': [ + 'tls_csr', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'tls_csr': + (TlsCsr,), + }, + 'attribute_map': { + }, + 'location_map': { + 'tls_csr': 'body', + }, + 'path_params_allow_reserved_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/vnd.api+json' + ], + 'content_type': [ + 'application/vnd.api+json' + ] + }, + api_client=api_client + ) + + def create_csr( + self, + **kwargs + ): + """Create CSR # noqa: E501 + + Creates a certificate signing request (CSR). # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_csr(async_req=True) + >>> result = thread.get() + + + Keyword Args: + tls_csr (TlsCsr): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + TlsCsrResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.create_csr_endpoint.call_with_http_info(**kwargs) + diff --git a/fastly/api/tokens_api.py b/fastly/api/tokens_api.py index c70e963..05dc76f 100644 --- a/fastly/api/tokens_api.py +++ b/fastly/api/tokens_api.py @@ -553,7 +553,7 @@ def create_token( ): """Create a token # noqa: E501 - Create an API token. If two-factor authentication is enabled for your account, review [the instructions](/reference/api/auth-tokens/user/) for including a one-time password in the request. # noqa: E501 + Create an API token. If two-factor authentication is enabled for your account, review [the instructions](https://www.fastly.com/documentation/reference/api/auth-tokens/user/) for including a one-time password in the request. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/fastly/api/vcl_api.py b/fastly/api/vcl_api.py index 1b0f8fc..d51502f 100644 --- a/fastly/api/vcl_api.py +++ b/fastly/api/vcl_api.py @@ -1208,7 +1208,7 @@ def get_custom_vcl_boilerplate( ): """Get boilerplate VCL # noqa: E501 - Return boilerplate VCL with the service's TTL from the [settings](/reference/api/vcl-services/settings/). # noqa: E501 + Return boilerplate VCL with the service's TTL from the [settings](https://www.fastly.com/documentation/reference/api/vcl-services/settings/). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/fastly/api/waf_active_rules_api.py b/fastly/api/waf_active_rules_api.py index b9275c7..5cbc7b2 100644 --- a/fastly/api/waf_active_rules_api.py +++ b/fastly/api/waf_active_rules_api.py @@ -735,7 +735,7 @@ def bulk_update_waf_active_rules( ): """Update multiple active rules # noqa: E501 - Bulk update all active rules on a [firewall version](https://developer.fastly.com/reference/api/waf/firewall-version/). This endpoint will not add new active rules, only update existing active rules. # noqa: E501 + Bulk update all active rules on a [firewall version](https://www.fastly.com/documentation/reference/api/waf/firewall-version/). This endpoint will not add new active rules, only update existing active rules. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/fastly/api_client.py b/fastly/api_client.py index f31e56a..7232d10 100644 --- a/fastly/api_client.py +++ b/fastly/api_client.py @@ -79,7 +79,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None, self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = 'fastly-py/5.0.1' + self.user_agent = 'fastly-py/5.1.0' # The last observed value of http header Fastly-RateLimit-Remaining self.rate_limit_remaining = DEFAULT_RATELIMIT diff --git a/fastly/apis/__init__.py b/fastly/apis/__init__.py index 9a2160d..dce2536 100644 --- a/fastly/apis/__init__.py +++ b/fastly/apis/__init__.py @@ -21,6 +21,7 @@ from fastly.api.backend_api import BackendApi from fastly.api.billing_api import BillingApi from fastly.api.billing_address_api import BillingAddressApi +from fastly.api.billing_invoices_api import BillingInvoicesApi from fastly.api.cache_settings_api import CacheSettingsApi from fastly.api.condition_api import ConditionApi from fastly.api.config_store_api import ConfigStoreApi @@ -115,6 +116,7 @@ from fastly.api.tls_bulk_certificates_api import TlsBulkCertificatesApi from fastly.api.tls_certificates_api import TlsCertificatesApi from fastly.api.tls_configurations_api import TlsConfigurationsApi +from fastly.api.tls_csrs_api import TlsCsrsApi from fastly.api.tls_domains_api import TlsDomainsApi from fastly.api.tls_private_keys_api import TlsPrivateKeysApi from fastly.api.tls_subscriptions_api import TlsSubscriptionsApi diff --git a/fastly/configuration.py b/fastly/configuration.py index fe3f93e..4113936 100644 --- a/fastly/configuration.py +++ b/fastly/configuration.py @@ -446,7 +446,7 @@ def to_debug_report(self): "OS: {env}\n"\ "Python Version: {pyversion}\n"\ "Version of the API: 1.0.0\n"\ - "SDK Package Version: 5.0.1".\ + "SDK Package Version: 5.1.0".\ format(env=sys.platform, pyversion=sys.version) def get_host_settings(self): diff --git a/fastly/model/error_response.py b/fastly/model/automation_token_error_response.py similarity index 98% rename from fastly/model/error_response.py rename to fastly/model/automation_token_error_response.py index fb68d97..4bdab99 100644 --- a/fastly/model/error_response.py +++ b/fastly/model/automation_token_error_response.py @@ -30,7 +30,7 @@ -class ErrorResponse(ModelNormal): +class AutomationTokenErrorResponse(ModelNormal): """NOTE: This class is auto generated. Do not edit the class manually. @@ -105,7 +105,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ErrorResponse - a model defined in OpenAPI + """AutomationTokenErrorResponse - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -190,7 +190,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """ErrorResponse - a model defined in OpenAPI + """AutomationTokenErrorResponse - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types diff --git a/fastly/model/backend.py b/fastly/model/backend.py index d5b91cd..d4225ae 100644 --- a/fastly/model/backend.py +++ b/fastly/model/backend.py @@ -221,7 +221,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 ssl_ca_cert (str, none_type): CA certificate attached to origin.. [optional] # noqa: E501 ssl_cert_hostname (str, none_type): Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all.. [optional] # noqa: E501 ssl_check_cert (bool, none_type): Be strict on checking SSL certs.. [optional] if omitted the server will use the default value of True # noqa: E501 - 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] # noqa: E501 + 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] # noqa: E501 ssl_client_cert (str, none_type): Client certificate attached to origin.. [optional] # noqa: E501 ssl_client_key (str, none_type): Client key attached to origin.. [optional] # noqa: E501 ssl_hostname (str, none_type): Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation.. [optional] # noqa: E501 @@ -333,7 +333,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 ssl_ca_cert (str, none_type): CA certificate attached to origin.. [optional] # noqa: E501 ssl_cert_hostname (str, none_type): Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all.. [optional] # noqa: E501 ssl_check_cert (bool, none_type): Be strict on checking SSL certs.. [optional] if omitted the server will use the default value of True # noqa: E501 - 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] # noqa: E501 + 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] # noqa: E501 ssl_client_cert (str, none_type): Client certificate attached to origin.. [optional] # noqa: E501 ssl_client_key (str, none_type): Client key attached to origin.. [optional] # noqa: E501 ssl_hostname (str, none_type): Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation.. [optional] # noqa: E501 diff --git a/fastly/model/backend_response.py b/fastly/model/backend_response.py index ad33430..19610e3 100644 --- a/fastly/model/backend_response.py +++ b/fastly/model/backend_response.py @@ -249,7 +249,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 ssl_ca_cert (str, none_type): CA certificate attached to origin.. [optional] # noqa: E501 ssl_cert_hostname (str, none_type): Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all.. [optional] # noqa: E501 ssl_check_cert (bool, none_type): Be strict on checking SSL certs.. [optional] if omitted the server will use the default value of True # noqa: E501 - 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] # noqa: E501 + 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] # noqa: E501 ssl_client_cert (str, none_type): Client certificate attached to origin.. [optional] # noqa: E501 ssl_client_key (str, none_type): Client key attached to origin.. [optional] # noqa: E501 ssl_hostname (str, none_type): Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation.. [optional] # noqa: E501 @@ -385,7 +385,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 ssl_ca_cert (str, none_type): CA certificate attached to origin.. [optional] # noqa: E501 ssl_cert_hostname (str, none_type): Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all.. [optional] # noqa: E501 ssl_check_cert (bool, none_type): Be strict on checking SSL certs.. [optional] if omitted the server will use the default value of True # noqa: E501 - 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] # noqa: E501 + 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] # noqa: E501 ssl_client_cert (str, none_type): Client certificate attached to origin.. [optional] # noqa: E501 ssl_client_key (str, none_type): Client key attached to origin.. [optional] # noqa: E501 ssl_hostname (str, none_type): Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation.. [optional] # noqa: E501 diff --git a/fastly/model/director.py b/fastly/model/director.py index 5fb3d19..b2188d3 100644 --- a/fastly/model/director.py +++ b/fastly/model/director.py @@ -166,7 +166,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 comment (str, none_type): A freeform descriptive note.. [optional] # noqa: E501 name (str): Name for the Director.. [optional] # noqa: E501 quorum (int): The percentage of capacity that needs to be up for a director to be considered up. `0` to `100`.. [optional] if omitted the server will use the default value of 75 # noqa: E501 - shield (str, none_type): 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] if omitted the server will use the default value of "null" # noqa: E501 + shield (str, none_type): 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] if omitted the server will use the default value of "null" # noqa: E501 type (int): What type of load balance group to use.. [optional] if omitted the server will use the default value of 1 # noqa: E501 retries (int): How many backends to search if it fails.. [optional] if omitted the server will use the default value of 5 # noqa: E501 """ @@ -255,7 +255,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 comment (str, none_type): A freeform descriptive note.. [optional] # noqa: E501 name (str): Name for the Director.. [optional] # noqa: E501 quorum (int): The percentage of capacity that needs to be up for a director to be considered up. `0` to `100`.. [optional] if omitted the server will use the default value of 75 # noqa: E501 - shield (str, none_type): 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] if omitted the server will use the default value of "null" # noqa: E501 + shield (str, none_type): 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] if omitted the server will use the default value of "null" # noqa: E501 type (int): What type of load balance group to use.. [optional] if omitted the server will use the default value of 1 # noqa: E501 retries (int): How many backends to search if it fails.. [optional] if omitted the server will use the default value of 5 # noqa: E501 """ diff --git a/fastly/model/director_response.py b/fastly/model/director_response.py index e44389b..97ab377 100644 --- a/fastly/model/director_response.py +++ b/fastly/model/director_response.py @@ -185,7 +185,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 comment (str, none_type): A freeform descriptive note.. [optional] # noqa: E501 name (str): Name for the Director.. [optional] # noqa: E501 quorum (int): The percentage of capacity that needs to be up for a director to be considered up. `0` to `100`.. [optional] if omitted the server will use the default value of 75 # noqa: E501 - shield (str, none_type): 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] if omitted the server will use the default value of "null" # noqa: E501 + shield (str, none_type): 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] if omitted the server will use the default value of "null" # noqa: E501 type (int): What type of load balance group to use.. [optional] if omitted the server will use the default value of 1 # noqa: E501 retries (int): How many backends to search if it fails.. [optional] if omitted the server will use the default value of 5 # noqa: E501 service_id (str): [optional] # noqa: E501 @@ -297,7 +297,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 comment (str, none_type): A freeform descriptive note.. [optional] # noqa: E501 name (str): Name for the Director.. [optional] # noqa: E501 quorum (int): The percentage of capacity that needs to be up for a director to be considered up. `0` to `100`.. [optional] if omitted the server will use the default value of 75 # noqa: E501 - shield (str, none_type): 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] if omitted the server will use the default value of "null" # noqa: E501 + shield (str, none_type): 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] if omitted the server will use the default value of "null" # noqa: E501 type (int): What type of load balance group to use.. [optional] if omitted the server will use the default value of 1 # noqa: E501 retries (int): How many backends to search if it fails.. [optional] if omitted the server will use the default value of 5 # noqa: E501 service_id (str): [optional] # noqa: E501 diff --git a/fastly/model/domain_inspector_realtime_entry.py b/fastly/model/domain_inspector_realtime_entry.py index 7e94729..600a95a 100644 --- a/fastly/model/domain_inspector_realtime_entry.py +++ b/fastly/model/domain_inspector_realtime_entry.py @@ -146,7 +146,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) recorded (RecordedTimestamp): [optional] # noqa: E501 aggregated ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Groups [measurements](#measurements-data-model) by backend name and then by IP address.. [optional] # noqa: E501 - datacenter ({str: ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},)}): Groups [measurements](#measurements-data-model) by POP, then backend name, and then IP address. See the [POPs API](/reference/api/utils/pops/) for details about POP identifiers.. [optional] # noqa: E501 + datacenter ({str: ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},)}): Groups [measurements](#measurements-data-model) by POP, then backend name, and then IP address. See the [POPs API](https://www.fastly.com/documentation/reference/api/utils/pops/) for details about POP identifiers.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -230,7 +230,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) recorded (RecordedTimestamp): [optional] # noqa: E501 aggregated ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Groups [measurements](#measurements-data-model) by backend name and then by IP address.. [optional] # noqa: E501 - datacenter ({str: ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},)}): Groups [measurements](#measurements-data-model) by POP, then backend name, and then IP address. See the [POPs API](/reference/api/utils/pops/) for details about POP identifiers.. [optional] # noqa: E501 + datacenter ({str: ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},)}): Groups [measurements](#measurements-data-model) by POP, then backend name, and then IP address. See the [POPs API](https://www.fastly.com/documentation/reference/api/utils/pops/) for details about POP identifiers.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/fastly/model/error.py b/fastly/model/error.py new file mode 100644 index 0000000..2aa7a28 --- /dev/null +++ b/fastly/model/error.py @@ -0,0 +1,265 @@ +""" + Fastly API + + Via the Fastly API you can perform any of the operations that are possible within the management console, including creating services, domains, and backends, configuring rules or uploading your own application code, as well as account operations such as user administration and billing reports. The API is organized into collections of endpoints that allow manipulation of objects related to Fastly services and accounts. For the most accurate and up-to-date API reference content, visit our [Developer Hub](https://developer.fastly.com/reference/api/) # noqa: E501 + + The version of the OpenAPI document: 1.0.0 + Contact: oss@fastly.com +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fastly.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from fastly.exceptions import ApiAttributeError + + + +class Error(ModelNormal): + """NOTE: This class is auto generated. + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'type': (str,), # noqa: E501 + 'title': (str,), # noqa: E501 + 'code': (str,), # noqa: E501 + 'status': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'type': 'type', # noqa: E501 + 'title': 'title', # noqa: E501 + 'code': 'code', # noqa: E501 + 'status': 'status', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Error - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + type (str): [optional] # noqa: E501 + title (str): [optional] # noqa: E501 + code (str): [optional] # noqa: E501 + status (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Error - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + type (str): [optional] # noqa: E501 + title (str): [optional] # noqa: E501 + code (str): [optional] # noqa: E501 + status (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/fastly/model/error_response_data.py b/fastly/model/error_response_data.py new file mode 100644 index 0000000..5e18cf4 --- /dev/null +++ b/fastly/model/error_response_data.py @@ -0,0 +1,257 @@ +""" + Fastly API + + Via the Fastly API you can perform any of the operations that are possible within the management console, including creating services, domains, and backends, configuring rules or uploading your own application code, as well as account operations such as user administration and billing reports. The API is organized into collections of endpoints that allow manipulation of objects related to Fastly services and accounts. For the most accurate and up-to-date API reference content, visit our [Developer Hub](https://developer.fastly.com/reference/api/) # noqa: E501 + + The version of the OpenAPI document: 1.0.0 + Contact: oss@fastly.com +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fastly.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from fastly.exceptions import ApiAttributeError + + + +class ErrorResponseData(ModelNormal): + """NOTE: This class is auto generated. + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'title': (str,), # noqa: E501 + 'detail': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'title': 'title', # noqa: E501 + 'detail': 'detail', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ErrorResponseData - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + title (str): [optional] # noqa: E501 + detail (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ErrorResponseData - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + title (str): [optional] # noqa: E501 + detail (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/fastly/model/event_attributes.py b/fastly/model/event_attributes.py index 25023b8..240f335 100644 --- a/fastly/model/event_attributes.py +++ b/fastly/model/event_attributes.py @@ -61,6 +61,10 @@ class EventAttributes(ModelNormal): 'ADDRESS.CREATE': "address.create", 'ADDRESS.DELETE': "address.delete", 'ADDRESS.UPDATE': "address.update", + 'ALERTS.DEFINITION.CREATE': "alerts.definition.create", + 'ALERTS.DEFINITION.DELETE': "alerts.definition.delete", + 'ALERTS.DEFINITION.TEST': "alerts.definition.test", + 'ALERTS.DEFINITION.UPDATE': "alerts.definition.update", 'BACKEND.CREATE': "backend.create", 'BACKEND.DELETE': "backend.delete", 'BACKEND.UPDATE': "backend.update", diff --git a/fastly/model/invoice.py b/fastly/model/invoice.py new file mode 100644 index 0000000..dcd8f1e --- /dev/null +++ b/fastly/model/invoice.py @@ -0,0 +1,291 @@ +""" + Fastly API + + Via the Fastly API you can perform any of the operations that are possible within the management console, including creating services, domains, and backends, configuring rules or uploading your own application code, as well as account operations such as user administration and billing reports. The API is organized into collections of endpoints that allow manipulation of objects related to Fastly services and accounts. For the most accurate and up-to-date API reference content, visit our [Developer Hub](https://developer.fastly.com/reference/api/) # noqa: E501 + + The version of the OpenAPI document: 1.0.0 + Contact: oss@fastly.com +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fastly.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from fastly.exceptions import ApiAttributeError + + +def lazy_import(): + from fastly.model.invoicelineitems import Invoicelineitems + globals()['Invoicelineitems'] = Invoicelineitems + + +class Invoice(ModelNormal): + """NOTE: This class is auto generated. + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'customer_id': (str,), # noqa: E501 + 'invoice_id': (str,), # noqa: E501 + 'invoice_posted_on': (datetime,), # noqa: E501 + 'billing_start_date': (datetime,), # noqa: E501 + 'billing_end_date': (datetime,), # noqa: E501 + 'statement_number': (str,), # noqa: E501 + 'currency_code': (str,), # noqa: E501 + 'monthly_transaction_amount': (float,), # noqa: E501 + 'transaction_line_items': ([Invoicelineitems],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'customer_id': 'customer_id', # noqa: E501 + 'invoice_id': 'invoice_id', # noqa: E501 + 'invoice_posted_on': 'invoice_posted_on', # noqa: E501 + 'billing_start_date': 'billing_start_date', # noqa: E501 + 'billing_end_date': 'billing_end_date', # noqa: E501 + 'statement_number': 'statement_number', # noqa: E501 + 'currency_code': 'currency_code', # noqa: E501 + 'monthly_transaction_amount': 'monthly_transaction_amount', # noqa: E501 + 'transaction_line_items': 'transaction_line_items', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Invoice - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + customer_id (str): Customer ID associated with the invoice.. [optional] # noqa: E501 + invoice_id (str): Alphanumeric string identifying the invoice.. [optional] # noqa: E501 + invoice_posted_on (datetime): Date and time invoice was posted on, in ISO 8601 format.. [optional] # noqa: E501 + billing_start_date (datetime): Date and time (in ISO 8601 format) for initiation point of a billing cycle, signifying the start of charges for a service or subscription.. [optional] # noqa: E501 + billing_end_date (datetime): Date and time (in ISO 8601 format) for termination point of a billing cycle, signifying the end of charges for a service or subscription.. [optional] # noqa: E501 + statement_number (str): Alphanumeric string identifying the statement number.. [optional] # noqa: E501 + currency_code (str): Three-letter code representing a specific currency used for financial transactions.. [optional] # noqa: E501 + monthly_transaction_amount (float): Total billable amount for invoiced services charged within a single month.. [optional] # noqa: E501 + transaction_line_items ([Invoicelineitems]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Invoice - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + customer_id (str): Customer ID associated with the invoice.. [optional] # noqa: E501 + invoice_id (str): Alphanumeric string identifying the invoice.. [optional] # noqa: E501 + invoice_posted_on (datetime): Date and time invoice was posted on, in ISO 8601 format.. [optional] # noqa: E501 + billing_start_date (datetime): Date and time (in ISO 8601 format) for initiation point of a billing cycle, signifying the start of charges for a service or subscription.. [optional] # noqa: E501 + billing_end_date (datetime): Date and time (in ISO 8601 format) for termination point of a billing cycle, signifying the end of charges for a service or subscription.. [optional] # noqa: E501 + statement_number (str): Alphanumeric string identifying the statement number.. [optional] # noqa: E501 + currency_code (str): Three-letter code representing a specific currency used for financial transactions.. [optional] # noqa: E501 + monthly_transaction_amount (float): Total billable amount for invoiced services charged within a single month.. [optional] # noqa: E501 + transaction_line_items ([Invoicelineitems]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/fastly/model/invoice_response.py b/fastly/model/invoice_response.py new file mode 100644 index 0000000..ca1201a --- /dev/null +++ b/fastly/model/invoice_response.py @@ -0,0 +1,343 @@ +""" + Fastly API + + Via the Fastly API you can perform any of the operations that are possible within the management console, including creating services, domains, and backends, configuring rules or uploading your own application code, as well as account operations such as user administration and billing reports. The API is organized into collections of endpoints that allow manipulation of objects related to Fastly services and accounts. For the most accurate and up-to-date API reference content, visit our [Developer Hub](https://developer.fastly.com/reference/api/) # noqa: E501 + + The version of the OpenAPI document: 1.0.0 + Contact: oss@fastly.com +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fastly.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from fastly.exceptions import ApiAttributeError + + +def lazy_import(): + from fastly.model.invoice import Invoice + from fastly.model.invoicelineitems import Invoicelineitems + globals()['Invoice'] = Invoice + globals()['Invoicelineitems'] = Invoicelineitems + + +class InvoiceResponse(ModelComposed): + """NOTE: This class is auto generated. + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'customer_id': (str,), # noqa: E501 + 'invoice_id': (str,), # noqa: E501 + 'invoice_posted_on': (datetime,), # noqa: E501 + 'billing_start_date': (datetime,), # noqa: E501 + 'billing_end_date': (datetime,), # noqa: E501 + 'statement_number': (str,), # noqa: E501 + 'currency_code': (str,), # noqa: E501 + 'monthly_transaction_amount': (float,), # noqa: E501 + 'transaction_line_items': ([Invoicelineitems],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'customer_id': 'customer_id', # noqa: E501 + 'invoice_id': 'invoice_id', # noqa: E501 + 'invoice_posted_on': 'invoice_posted_on', # noqa: E501 + 'billing_start_date': 'billing_start_date', # noqa: E501 + 'billing_end_date': 'billing_end_date', # noqa: E501 + 'statement_number': 'statement_number', # noqa: E501 + 'currency_code': 'currency_code', # noqa: E501 + 'monthly_transaction_amount': 'monthly_transaction_amount', # noqa: E501 + 'transaction_line_items': 'transaction_line_items', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """InvoiceResponse - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + customer_id (str): Customer ID associated with the invoice.. [optional] # noqa: E501 + invoice_id (str): Alphanumeric string identifying the invoice.. [optional] # noqa: E501 + invoice_posted_on (datetime): Date and time invoice was posted on, in ISO 8601 format.. [optional] # noqa: E501 + billing_start_date (datetime): Date and time (in ISO 8601 format) for initiation point of a billing cycle, signifying the start of charges for a service or subscription.. [optional] # noqa: E501 + billing_end_date (datetime): Date and time (in ISO 8601 format) for termination point of a billing cycle, signifying the end of charges for a service or subscription.. [optional] # noqa: E501 + statement_number (str): Alphanumeric string identifying the statement number.. [optional] # noqa: E501 + currency_code (str): Three-letter code representing a specific currency used for financial transactions.. [optional] # noqa: E501 + monthly_transaction_amount (float): Total billable amount for invoiced services charged within a single month.. [optional] # noqa: E501 + transaction_line_items ([Invoicelineitems]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """InvoiceResponse - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + customer_id (str): Customer ID associated with the invoice.. [optional] # noqa: E501 + invoice_id (str): Alphanumeric string identifying the invoice.. [optional] # noqa: E501 + invoice_posted_on (datetime): Date and time invoice was posted on, in ISO 8601 format.. [optional] # noqa: E501 + billing_start_date (datetime): Date and time (in ISO 8601 format) for initiation point of a billing cycle, signifying the start of charges for a service or subscription.. [optional] # noqa: E501 + billing_end_date (datetime): Date and time (in ISO 8601 format) for termination point of a billing cycle, signifying the end of charges for a service or subscription.. [optional] # noqa: E501 + statement_number (str): Alphanumeric string identifying the statement number.. [optional] # noqa: E501 + currency_code (str): Three-letter code representing a specific currency used for financial transactions.. [optional] # noqa: E501 + monthly_transaction_amount (float): Total billable amount for invoiced services charged within a single month.. [optional] # noqa: E501 + transaction_line_items ([Invoicelineitems]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + Invoice, + ], + 'oneOf': [ + ], + } diff --git a/fastly/model/invoicelineitems.py b/fastly/model/invoicelineitems.py new file mode 100644 index 0000000..5abc1e4 --- /dev/null +++ b/fastly/model/invoicelineitems.py @@ -0,0 +1,285 @@ +""" + Fastly API + + Via the Fastly API you can perform any of the operations that are possible within the management console, including creating services, domains, and backends, configuring rules or uploading your own application code, as well as account operations such as user administration and billing reports. The API is organized into collections of endpoints that allow manipulation of objects related to Fastly services and accounts. For the most accurate and up-to-date API reference content, visit our [Developer Hub](https://developer.fastly.com/reference/api/) # noqa: E501 + + The version of the OpenAPI document: 1.0.0 + Contact: oss@fastly.com +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fastly.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from fastly.exceptions import ApiAttributeError + + + +class Invoicelineitems(ModelNormal): + """NOTE: This class is auto generated. + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'description': (str,), # noqa: E501 + 'amount': (float,), # noqa: E501 + 'credit_coupon_code': (str,), # noqa: E501 + 'rate': (float,), # noqa: E501 + 'units': (float,), # noqa: E501 + 'product_name': (str,), # noqa: E501 + 'product_group': (str,), # noqa: E501 + 'region': (str,), # noqa: E501 + 'usage_type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'description': 'description', # noqa: E501 + 'amount': 'amount', # noqa: E501 + 'credit_coupon_code': 'credit_coupon_code', # noqa: E501 + 'rate': 'rate', # noqa: E501 + 'units': 'units', # noqa: E501 + 'product_name': 'ProductName', # noqa: E501 + 'product_group': 'ProductGroup', # noqa: E501 + 'region': 'Region', # noqa: E501 + 'usage_type': 'UsageType', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Invoicelineitems - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + description (str): Invoice line item transaction name.. [optional] # noqa: E501 + amount (float): Billed amount for line item.. [optional] # noqa: E501 + credit_coupon_code (str): Discount coupon associated with the invoice for any account or service credits.. [optional] # noqa: E501 + rate (float): Price per unit.. [optional] # noqa: E501 + units (float): Total number of units of usage.. [optional] # noqa: E501 + product_name (str): The name of the product.. [optional] # noqa: E501 + product_group (str): The broader classification of the product (e.g., `Compute` or `Full-Site Delivery`).. [optional] # noqa: E501 + region (str): The geographical area applicable for regionally based products.. [optional] # noqa: E501 + usage_type (str): The unit of measure (e.g., `requests` or `bandwidth`).. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Invoicelineitems - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + description (str): Invoice line item transaction name.. [optional] # noqa: E501 + amount (float): Billed amount for line item.. [optional] # noqa: E501 + credit_coupon_code (str): Discount coupon associated with the invoice for any account or service credits.. [optional] # noqa: E501 + rate (float): Price per unit.. [optional] # noqa: E501 + units (float): Total number of units of usage.. [optional] # noqa: E501 + product_name (str): The name of the product.. [optional] # noqa: E501 + product_group (str): The broader classification of the product (e.g., `Compute` or `Full-Site Delivery`).. [optional] # noqa: E501 + region (str): The geographical area applicable for regionally based products.. [optional] # noqa: E501 + usage_type (str): The unit of measure (e.g., `requests` or `bandwidth`).. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/fastly/model/list_invoices_response.py b/fastly/model/list_invoices_response.py new file mode 100644 index 0000000..7db9cfd --- /dev/null +++ b/fastly/model/list_invoices_response.py @@ -0,0 +1,317 @@ +""" + Fastly API + + Via the Fastly API you can perform any of the operations that are possible within the management console, including creating services, domains, and backends, configuring rules or uploading your own application code, as well as account operations such as user administration and billing reports. The API is organized into collections of endpoints that allow manipulation of objects related to Fastly services and accounts. For the most accurate and up-to-date API reference content, visit our [Developer Hub](https://developer.fastly.com/reference/api/) # noqa: E501 + + The version of the OpenAPI document: 1.0.0 + Contact: oss@fastly.com +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fastly.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from fastly.exceptions import ApiAttributeError + + +def lazy_import(): + from fastly.model.invoice import Invoice + from fastly.model.listinvoices import Listinvoices + from fastly.model.metadata import Metadata + globals()['Invoice'] = Invoice + globals()['Listinvoices'] = Listinvoices + globals()['Metadata'] = Metadata + + +class ListInvoicesResponse(ModelComposed): + """NOTE: This class is auto generated. + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': ([Invoice],), # noqa: E501 + 'meta': (Metadata,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ListInvoicesResponse - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + data ([Invoice]): [optional] # noqa: E501 + meta (Metadata): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ListInvoicesResponse - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + data ([Invoice]): [optional] # noqa: E501 + meta (Metadata): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + Listinvoices, + ], + 'oneOf': [ + ], + } diff --git a/fastly/model/listinvoices.py b/fastly/model/listinvoices.py new file mode 100644 index 0000000..681b394 --- /dev/null +++ b/fastly/model/listinvoices.py @@ -0,0 +1,265 @@ +""" + Fastly API + + Via the Fastly API you can perform any of the operations that are possible within the management console, including creating services, domains, and backends, configuring rules or uploading your own application code, as well as account operations such as user administration and billing reports. The API is organized into collections of endpoints that allow manipulation of objects related to Fastly services and accounts. For the most accurate and up-to-date API reference content, visit our [Developer Hub](https://developer.fastly.com/reference/api/) # noqa: E501 + + The version of the OpenAPI document: 1.0.0 + Contact: oss@fastly.com +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fastly.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from fastly.exceptions import ApiAttributeError + + +def lazy_import(): + from fastly.model.invoice import Invoice + from fastly.model.metadata import Metadata + globals()['Invoice'] = Invoice + globals()['Metadata'] = Metadata + + +class Listinvoices(ModelNormal): + """NOTE: This class is auto generated. + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': ([Invoice],), # noqa: E501 + 'meta': (Metadata,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Listinvoices - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + data ([Invoice]): [optional] # noqa: E501 + meta (Metadata): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Listinvoices - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + data ([Invoice]): [optional] # noqa: E501 + meta (Metadata): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/fastly/model/logging_scalyr_additional.py b/fastly/model/logging_scalyr_additional.py index f62252c..9e0ede8 100644 --- a/fastly/model/logging_scalyr_additional.py +++ b/fastly/model/logging_scalyr_additional.py @@ -141,7 +141,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) region (str): The region that log data will be sent to.. [optional] if omitted the server will use the default value of "US" # noqa: E501 - token (str): The token to use for authentication ([https://www.scalyr.com/keys](https://www.scalyr.com/keys)).. [optional] # noqa: E501 + token (str): The token to use for authentication.. [optional] # noqa: E501 project_id (str): The name of the logfile within Scalyr.. [optional] if omitted the server will use the default value of "logplex" # noqa: E501 """ @@ -225,7 +225,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) region (str): The region that log data will be sent to.. [optional] if omitted the server will use the default value of "US" # noqa: E501 - token (str): The token to use for authentication ([https://www.scalyr.com/keys](https://www.scalyr.com/keys)).. [optional] # noqa: E501 + token (str): The token to use for authentication.. [optional] # noqa: E501 project_id (str): The name of the logfile within Scalyr.. [optional] if omitted the server will use the default value of "logplex" # noqa: E501 """ diff --git a/fastly/model/logging_scalyr_response.py b/fastly/model/logging_scalyr_response.py index 64aef04..5a13062 100644 --- a/fastly/model/logging_scalyr_response.py +++ b/fastly/model/logging_scalyr_response.py @@ -191,7 +191,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 format (str): A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats).. [optional] if omitted the server will use the default value of "%h %l %u %t "%r" %>s %b" # noqa: E501 format_version (str): The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. . [optional] if omitted the server will use the default value of "2" # noqa: E501 region (str): The region that log data will be sent to.. [optional] if omitted the server will use the default value of "US" # noqa: E501 - token (str): The token to use for authentication ([https://www.scalyr.com/keys](https://www.scalyr.com/keys)).. [optional] # noqa: E501 + token (str): The token to use for authentication.. [optional] # noqa: E501 project_id (str): The name of the logfile within Scalyr.. [optional] if omitted the server will use the default value of "logplex" # noqa: E501 created_at (datetime, none_type): Date and time in ISO 8601 format.. [optional] # noqa: E501 deleted_at (datetime, none_type): Date and time in ISO 8601 format.. [optional] # noqa: E501 @@ -303,7 +303,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 format (str): A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats).. [optional] if omitted the server will use the default value of "%h %l %u %t "%r" %>s %b" # noqa: E501 format_version (str): The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. . [optional] if omitted the server will use the default value of "2" # noqa: E501 region (str): The region that log data will be sent to.. [optional] if omitted the server will use the default value of "US" # noqa: E501 - token (str): The token to use for authentication ([https://www.scalyr.com/keys](https://www.scalyr.com/keys)).. [optional] # noqa: E501 + token (str): The token to use for authentication.. [optional] # noqa: E501 project_id (str): The name of the logfile within Scalyr.. [optional] if omitted the server will use the default value of "logplex" # noqa: E501 created_at (datetime, none_type): Date and time in ISO 8601 format.. [optional] # noqa: E501 deleted_at (datetime, none_type): Date and time in ISO 8601 format.. [optional] # noqa: E501 diff --git a/fastly/model/metadata.py b/fastly/model/metadata.py new file mode 100644 index 0000000..21f903a --- /dev/null +++ b/fastly/model/metadata.py @@ -0,0 +1,265 @@ +""" + Fastly API + + Via the Fastly API you can perform any of the operations that are possible within the management console, including creating services, domains, and backends, configuring rules or uploading your own application code, as well as account operations such as user administration and billing reports. The API is organized into collections of endpoints that allow manipulation of objects related to Fastly services and accounts. For the most accurate and up-to-date API reference content, visit our [Developer Hub](https://developer.fastly.com/reference/api/) # noqa: E501 + + The version of the OpenAPI document: 1.0.0 + Contact: oss@fastly.com +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fastly.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from fastly.exceptions import ApiAttributeError + + + +class Metadata(ModelNormal): + """NOTE: This class is auto generated. + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'next_cursor': (str,), # noqa: E501 + 'limit': (int,), # noqa: E501 + 'sort': (str,), # noqa: E501 + 'total': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'next_cursor': 'next_cursor', # noqa: E501 + 'limit': 'limit', # noqa: E501 + 'sort': 'sort', # noqa: E501 + 'total': 'total', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Metadata - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + next_cursor (str): The token used to request the next set of results.. [optional] # noqa: E501 + limit (int): The number of invoices included in the response.. [optional] # noqa: E501 + sort (str): The sort order of the invoices in the response.. [optional] if omitted the server will use the default value of "billing_start_date" # noqa: E501 + total (int): Total number of records available on the backend.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Metadata - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + next_cursor (str): The token used to request the next set of results.. [optional] # noqa: E501 + limit (int): The number of invoices included in the response.. [optional] # noqa: E501 + sort (str): The sort order of the invoices in the response.. [optional] if omitted the server will use the default value of "billing_start_date" # noqa: E501 + total (int): Total number of records available on the backend.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/fastly/model/origin_inspector_realtime_entry.py b/fastly/model/origin_inspector_realtime_entry.py index 8c54006..580921e 100644 --- a/fastly/model/origin_inspector_realtime_entry.py +++ b/fastly/model/origin_inspector_realtime_entry.py @@ -146,7 +146,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) recorded (OriginInspectorRealtimeEntryRecorded): [optional] # noqa: E501 aggregated ({str: (OriginInspectorMeasurements,)}): Groups [measurements](#measurements-data-model) by backend name.. [optional] # noqa: E501 - datacenter ({str: ({str: (OriginInspectorMeasurements,)},)}): Groups [measurements](#measurements-data-model) by POP, then backend name. See the [POPs API](/reference/api/utils/pops/) for details about POP identifiers.. [optional] # noqa: E501 + datacenter ({str: ({str: (OriginInspectorMeasurements,)},)}): Groups [measurements](#measurements-data-model) by POP, then backend name. See the [POPs API](https://www.fastly.com/documentation/reference/api/utils/pops/) for details about POP identifiers.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -230,7 +230,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) recorded (OriginInspectorRealtimeEntryRecorded): [optional] # noqa: E501 aggregated ({str: (OriginInspectorMeasurements,)}): Groups [measurements](#measurements-data-model) by backend name.. [optional] # noqa: E501 - datacenter ({str: ({str: (OriginInspectorMeasurements,)},)}): Groups [measurements](#measurements-data-model) by POP, then backend name. See the [POPs API](/reference/api/utils/pops/) for details about POP identifiers.. [optional] # noqa: E501 + datacenter ({str: ({str: (OriginInspectorMeasurements,)},)}): Groups [measurements](#measurements-data-model) by POP, then backend name. See the [POPs API](https://www.fastly.com/documentation/reference/api/utils/pops/) for details about POP identifiers.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/fastly/model/pool_additional.py b/fastly/model/pool_additional.py index 23d47fe..bd678cd 100644 --- a/fastly/model/pool_additional.py +++ b/fastly/model/pool_additional.py @@ -158,7 +158,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) name (str): Name for the Pool.. [optional] # noqa: E501 - shield (str, none_type): Selected POP to serve as a shield for the servers. 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] if omitted the server will use the default value of "null" # noqa: E501 + shield (str, none_type): Selected POP to serve as a shield for the servers. 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] if omitted the server will use the default value of "null" # noqa: E501 request_condition (str, none_type): Condition which, if met, will select this configuration during a request. Optional.. [optional] # noqa: E501 tls_ciphers (str, none_type): List of OpenSSL ciphers (see the [openssl.org manpages](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) for details). Optional.. [optional] # noqa: E501 tls_sni_hostname (str, none_type): SNI hostname. Optional.. [optional] # noqa: E501 @@ -250,7 +250,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) name (str): Name for the Pool.. [optional] # noqa: E501 - shield (str, none_type): Selected POP to serve as a shield for the servers. 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] if omitted the server will use the default value of "null" # noqa: E501 + shield (str, none_type): Selected POP to serve as a shield for the servers. 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] if omitted the server will use the default value of "null" # noqa: E501 request_condition (str, none_type): Condition which, if met, will select this configuration during a request. Optional.. [optional] # noqa: E501 tls_ciphers (str, none_type): List of OpenSSL ciphers (see the [openssl.org manpages](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) for details). Optional.. [optional] # noqa: E501 tls_sni_hostname (str, none_type): SNI hostname. Optional.. [optional] # noqa: E501 diff --git a/fastly/model/pool_response.py b/fastly/model/pool_response.py index e0622b6..3b69705 100644 --- a/fastly/model/pool_response.py +++ b/fastly/model/pool_response.py @@ -226,7 +226,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 service_id (str): [optional] # noqa: E501 version (str): [optional] # noqa: E501 name (str): Name for the Pool.. [optional] # noqa: E501 - shield (str, none_type): Selected POP to serve as a shield for the servers. 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] if omitted the server will use the default value of "null" # noqa: E501 + shield (str, none_type): Selected POP to serve as a shield for the servers. 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] if omitted the server will use the default value of "null" # noqa: E501 request_condition (str, none_type): Condition which, if met, will select this configuration during a request. Optional.. [optional] # noqa: E501 tls_ciphers (str, none_type): List of OpenSSL ciphers (see the [openssl.org manpages](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) for details). Optional.. [optional] # noqa: E501 tls_sni_hostname (str, none_type): SNI hostname. Optional.. [optional] # noqa: E501 @@ -353,7 +353,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 service_id (str): [optional] # noqa: E501 version (str): [optional] # noqa: E501 name (str): Name for the Pool.. [optional] # noqa: E501 - shield (str, none_type): Selected POP to serve as a shield for the servers. 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] if omitted the server will use the default value of "null" # noqa: E501 + shield (str, none_type): Selected POP to serve as a shield for the servers. 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] if omitted the server will use the default value of "null" # noqa: E501 request_condition (str, none_type): Condition which, if met, will select this configuration during a request. Optional.. [optional] # noqa: E501 tls_ciphers (str, none_type): List of OpenSSL ciphers (see the [openssl.org manpages](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) for details). Optional.. [optional] # noqa: E501 tls_sni_hostname (str, none_type): SNI hostname. Optional.. [optional] # noqa: E501 diff --git a/fastly/model/pool_response_post.py b/fastly/model/pool_response_post.py index 1a60dd7..5a6c06d 100644 --- a/fastly/model/pool_response_post.py +++ b/fastly/model/pool_response_post.py @@ -226,7 +226,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 service_id (str): [optional] # noqa: E501 version (str): [optional] # noqa: E501 name (str): Name for the Pool.. [optional] # noqa: E501 - shield (str, none_type): Selected POP to serve as a shield for the servers. 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] if omitted the server will use the default value of "null" # noqa: E501 + shield (str, none_type): Selected POP to serve as a shield for the servers. 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] if omitted the server will use the default value of "null" # noqa: E501 request_condition (str, none_type): Condition which, if met, will select this configuration during a request. Optional.. [optional] # noqa: E501 tls_ciphers (str, none_type): List of OpenSSL ciphers (see the [openssl.org manpages](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) for details). Optional.. [optional] # noqa: E501 tls_sni_hostname (str, none_type): SNI hostname. Optional.. [optional] # noqa: E501 @@ -353,7 +353,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 service_id (str): [optional] # noqa: E501 version (str): [optional] # noqa: E501 name (str): Name for the Pool.. [optional] # noqa: E501 - shield (str, none_type): Selected POP to serve as a shield for the servers. 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] if omitted the server will use the default value of "null" # noqa: E501 + shield (str, none_type): Selected POP to serve as a shield for the servers. 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] if omitted the server will use the default value of "null" # noqa: E501 request_condition (str, none_type): Condition which, if met, will select this configuration during a request. Optional.. [optional] # noqa: E501 tls_ciphers (str, none_type): List of OpenSSL ciphers (see the [openssl.org manpages](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) for details). Optional.. [optional] # noqa: E501 tls_sni_hostname (str, none_type): SNI hostname. Optional.. [optional] # noqa: E501 diff --git a/fastly/model/pop.py b/fastly/model/pop.py index d78848a..62dfedd 100644 --- a/fastly/model/pop.py +++ b/fastly/model/pop.py @@ -162,7 +162,7 @@ def _from_openapi_data(cls, code, name, group, region, stats_region, billing_reg """Pop - a model defined in OpenAPI Args: - code (str): the three-letter code for the [POP](https://developer.fastly.com/learning/concepts/pop/) + code (str): the three-letter code for the [POP](https://www.fastly.com/documentation/learning/concepts/pop/) name (str): the name of the POP group (str): region (str): @@ -201,7 +201,7 @@ def _from_openapi_data(cls, code, name, group, region, stats_region, billing_reg through its discriminator because we passed in _visited_composed_classes = (Animal,) coordinates (PopCoordinates): [optional] # noqa: E501 - shield (str): the name of the [shield code](https://developer.fastly.com/learning/concepts/shielding/#choosing-a-shield-location) if this POP is suitable for shielding. [optional] # noqa: E501 + shield (str): the name of the [shield code](https://www.fastly.com/documentation/learning/concepts/shielding/#choosing-a-shield-location) if this POP is suitable for shielding. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -259,7 +259,7 @@ def __init__(self, code, name, group, region, stats_region, billing_region, *arg """Pop - a model defined in OpenAPI Args: - code (str): the three-letter code for the [POP](https://developer.fastly.com/learning/concepts/pop/) + code (str): the three-letter code for the [POP](https://www.fastly.com/documentation/learning/concepts/pop/) name (str): the name of the POP group (str): region (str): @@ -298,7 +298,7 @@ def __init__(self, code, name, group, region, stats_region, billing_region, *arg through its discriminator because we passed in _visited_composed_classes = (Animal,) coordinates (PopCoordinates): [optional] # noqa: E501 - shield (str): the name of the [shield code](https://developer.fastly.com/learning/concepts/shielding/#choosing-a-shield-location) if this POP is suitable for shielding. [optional] # noqa: E501 + shield (str): the name of the [shield code](https://www.fastly.com/documentation/learning/concepts/shielding/#choosing-a-shield-location) if this POP is suitable for shielding. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/fastly/model/results.py b/fastly/model/results.py index 4126035..932d7de 100644 --- a/fastly/model/results.py +++ b/fastly/model/results.py @@ -158,8 +158,10 @@ def openapi_types(): 'imgopto': (int,), # noqa: E501 'imgopto_resp_body_bytes': (int,), # noqa: E501 'imgopto_resp_header_bytes': (int,), # noqa: E501 + 'imgopto_shield': (int,), # noqa: E501 'imgopto_shield_resp_body_bytes': (int,), # noqa: E501 'imgopto_shield_resp_header_bytes': (int,), # noqa: E501 + 'imgopto_transforms': (int,), # noqa: E501 'imgvideo': (int,), # noqa: E501 'imgvideo_frames': (int,), # noqa: E501 'imgvideo_resp_header_bytes': (int,), # noqa: E501 @@ -393,8 +395,10 @@ def discriminator(): 'imgopto': 'imgopto', # noqa: E501 'imgopto_resp_body_bytes': 'imgopto_resp_body_bytes', # noqa: E501 'imgopto_resp_header_bytes': 'imgopto_resp_header_bytes', # noqa: E501 + 'imgopto_shield': 'imgopto_shield', # noqa: E501 'imgopto_shield_resp_body_bytes': 'imgopto_shield_resp_body_bytes', # noqa: E501 'imgopto_shield_resp_header_bytes': 'imgopto_shield_resp_header_bytes', # noqa: E501 + 'imgopto_transforms': 'imgopto_transforms', # noqa: E501 'imgvideo': 'imgvideo', # noqa: E501 'imgvideo_frames': 'imgvideo_frames', # noqa: E501 'imgvideo_resp_header_bytes': 'imgvideo_resp_header_bytes', # noqa: E501 @@ -664,8 +668,10 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 imgopto (int): Number of responses that came from the Fastly Image Optimizer service. If the service receives 10 requests for an image, this stat will be 10 regardless of how many times the image was transformed.. [optional] # noqa: E501 imgopto_resp_body_bytes (int): Total body bytes delivered from the Fastly Image Optimizer service, including shield traffic.. [optional] # noqa: E501 imgopto_resp_header_bytes (int): Total header bytes delivered from the Fastly Image Optimizer service, including shield traffic.. [optional] # noqa: E501 + imgopto_shield (int): Number of responses that came from the Fastly Image Optimizer service via a shield.. [optional] # noqa: E501 imgopto_shield_resp_body_bytes (int): Total body bytes delivered via a shield from the Fastly Image Optimizer service.. [optional] # noqa: E501 imgopto_shield_resp_header_bytes (int): Total header bytes delivered via a shield from the Fastly Image Optimizer service.. [optional] # noqa: E501 + imgopto_transforms (int): Number of transforms performed by the Fastly Image Optimizer service.. [optional] # noqa: E501 imgvideo (int): Number of video responses that came from the Fastly Image Optimizer service.. [optional] # noqa: E501 imgvideo_frames (int): Number of video frames that came from the Fastly Image Optimizer service. A video frame is an individual image within a sequence of video.. [optional] # noqa: E501 imgvideo_resp_header_bytes (int): Total header bytes of video delivered from the Fastly Image Optimizer service.. [optional] # noqa: E501 @@ -972,8 +978,10 @@ def __init__(self, *args, **kwargs): # noqa: E501 imgopto (int): Number of responses that came from the Fastly Image Optimizer service. If the service receives 10 requests for an image, this stat will be 10 regardless of how many times the image was transformed.. [optional] # noqa: E501 imgopto_resp_body_bytes (int): Total body bytes delivered from the Fastly Image Optimizer service, including shield traffic.. [optional] # noqa: E501 imgopto_resp_header_bytes (int): Total header bytes delivered from the Fastly Image Optimizer service, including shield traffic.. [optional] # noqa: E501 + imgopto_shield (int): Number of responses that came from the Fastly Image Optimizer service via a shield.. [optional] # noqa: E501 imgopto_shield_resp_body_bytes (int): Total body bytes delivered via a shield from the Fastly Image Optimizer service.. [optional] # noqa: E501 imgopto_shield_resp_header_bytes (int): Total header bytes delivered via a shield from the Fastly Image Optimizer service.. [optional] # noqa: E501 + imgopto_transforms (int): Number of transforms performed by the Fastly Image Optimizer service.. [optional] # noqa: E501 imgvideo (int): Number of video responses that came from the Fastly Image Optimizer service.. [optional] # noqa: E501 imgvideo_frames (int): Number of video frames that came from the Fastly Image Optimizer service. A video frame is an individual image within a sequence of video.. [optional] # noqa: E501 imgvideo_resp_header_bytes (int): Total header bytes of video delivered from the Fastly Image Optimizer service.. [optional] # noqa: E501 diff --git a/fastly/model/service_detail.py b/fastly/model/service_detail.py index 13efc3e..5800fe2 100644 --- a/fastly/model/service_detail.py +++ b/fastly/model/service_detail.py @@ -186,7 +186,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 id (str): [optional] # noqa: E501 publish_key (str): Unused at this time.. [optional] # noqa: E501 paused (bool): Whether the service is paused. Services are paused due to a lack of traffic for an extended period of time. Services are resumed either when a draft version is activated or a locked version is cloned and reactivated.. [optional] # noqa: E501 - versions ([SchemasVersionResponse]): A list of [versions](/reference/api/services/version/) associated with the service.. [optional] # noqa: E501 + versions ([SchemasVersionResponse]): A list of [versions](https://www.fastly.com/documentation/reference/api/services/version/) associated with the service.. [optional] # noqa: E501 active_version (ServiceVersionDetailOrNull): [optional] # noqa: E501 version (ServiceVersionDetail): [optional] # noqa: E501 """ @@ -298,7 +298,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 id (str): [optional] # noqa: E501 publish_key (str): Unused at this time.. [optional] # noqa: E501 paused (bool): Whether the service is paused. Services are paused due to a lack of traffic for an extended period of time. Services are resumed either when a draft version is activated or a locked version is cloned and reactivated.. [optional] # noqa: E501 - versions ([SchemasVersionResponse]): A list of [versions](/reference/api/services/version/) associated with the service.. [optional] # noqa: E501 + versions ([SchemasVersionResponse]): A list of [versions](https://www.fastly.com/documentation/reference/api/services/version/) associated with the service.. [optional] # noqa: E501 active_version (ServiceVersionDetailOrNull): [optional] # noqa: E501 version (ServiceVersionDetail): [optional] # noqa: E501 """ diff --git a/fastly/model/service_list_response.py b/fastly/model/service_list_response.py index 32d1aa8..5d53e91 100644 --- a/fastly/model/service_list_response.py +++ b/fastly/model/service_list_response.py @@ -176,8 +176,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 customer_id (str): Alphanumeric string identifying the customer.. [optional] # noqa: E501 type (str): The type of this service.. [optional] # noqa: E501 id (str): [optional] # noqa: E501 - version (int): Current [version](/reference/api/services/version/) of the service.. [optional] # noqa: E501 - versions ([SchemasVersionResponse]): A list of [versions](/reference/api/services/version/) associated with the service.. [optional] # noqa: E501 + version (int): Current [version](https://www.fastly.com/documentation/reference/api/services/version/) of the service.. [optional] # noqa: E501 + versions ([SchemasVersionResponse]): A list of [versions](https://www.fastly.com/documentation/reference/api/services/version/) associated with the service.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -285,8 +285,8 @@ def __init__(self, *args, **kwargs): # noqa: E501 customer_id (str): Alphanumeric string identifying the customer.. [optional] # noqa: E501 type (str): The type of this service.. [optional] # noqa: E501 id (str): [optional] # noqa: E501 - version (int): Current [version](/reference/api/services/version/) of the service.. [optional] # noqa: E501 - versions ([SchemasVersionResponse]): A list of [versions](/reference/api/services/version/) associated with the service.. [optional] # noqa: E501 + version (int): Current [version](https://www.fastly.com/documentation/reference/api/services/version/) of the service.. [optional] # noqa: E501 + versions ([SchemasVersionResponse]): A list of [versions](https://www.fastly.com/documentation/reference/api/services/version/) associated with the service.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/fastly/model/service_list_response_all_of.py b/fastly/model/service_list_response_all_of.py index 54ae13f..65f843c 100644 --- a/fastly/model/service_list_response_all_of.py +++ b/fastly/model/service_list_response_all_of.py @@ -144,8 +144,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) id (str): [optional] # noqa: E501 - version (int): Current [version](/reference/api/services/version/) of the service.. [optional] # noqa: E501 - versions ([SchemasVersionResponse]): A list of [versions](/reference/api/services/version/) associated with the service.. [optional] # noqa: E501 + version (int): Current [version](https://www.fastly.com/documentation/reference/api/services/version/) of the service.. [optional] # noqa: E501 + versions ([SchemasVersionResponse]): A list of [versions](https://www.fastly.com/documentation/reference/api/services/version/) associated with the service.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -228,8 +228,8 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) id (str): [optional] # noqa: E501 - version (int): Current [version](/reference/api/services/version/) of the service.. [optional] # noqa: E501 - versions ([SchemasVersionResponse]): A list of [versions](/reference/api/services/version/) associated with the service.. [optional] # noqa: E501 + version (int): Current [version](https://www.fastly.com/documentation/reference/api/services/version/) of the service.. [optional] # noqa: E501 + versions ([SchemasVersionResponse]): A list of [versions](https://www.fastly.com/documentation/reference/api/services/version/) associated with the service.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/fastly/model/service_response.py b/fastly/model/service_response.py index 2fcd8bb..2a273f1 100644 --- a/fastly/model/service_response.py +++ b/fastly/model/service_response.py @@ -180,7 +180,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 id (str): [optional] # noqa: E501 publish_key (str): Unused at this time.. [optional] # noqa: E501 paused (bool): Whether the service is paused. Services are paused due to a lack of traffic for an extended period of time. Services are resumed either when a draft version is activated or a locked version is cloned and reactivated.. [optional] # noqa: E501 - versions ([SchemasVersionResponse]): A list of [versions](/reference/api/services/version/) associated with the service.. [optional] # noqa: E501 + versions ([SchemasVersionResponse]): A list of [versions](https://www.fastly.com/documentation/reference/api/services/version/) associated with the service.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -290,7 +290,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 id (str): [optional] # noqa: E501 publish_key (str): Unused at this time.. [optional] # noqa: E501 paused (bool): Whether the service is paused. Services are paused due to a lack of traffic for an extended period of time. Services are resumed either when a draft version is activated or a locked version is cloned and reactivated.. [optional] # noqa: E501 - versions ([SchemasVersionResponse]): A list of [versions](/reference/api/services/version/) associated with the service.. [optional] # noqa: E501 + versions ([SchemasVersionResponse]): A list of [versions](https://www.fastly.com/documentation/reference/api/services/version/) associated with the service.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/fastly/model/service_response_all_of.py b/fastly/model/service_response_all_of.py index 140314b..49c8f22 100644 --- a/fastly/model/service_response_all_of.py +++ b/fastly/model/service_response_all_of.py @@ -148,7 +148,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 id (str): [optional] # noqa: E501 publish_key (str): Unused at this time.. [optional] # noqa: E501 paused (bool): Whether the service is paused. Services are paused due to a lack of traffic for an extended period of time. Services are resumed either when a draft version is activated or a locked version is cloned and reactivated.. [optional] # noqa: E501 - versions ([SchemasVersionResponse]): A list of [versions](/reference/api/services/version/) associated with the service.. [optional] # noqa: E501 + versions ([SchemasVersionResponse]): A list of [versions](https://www.fastly.com/documentation/reference/api/services/version/) associated with the service.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -233,7 +233,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 id (str): [optional] # noqa: E501 publish_key (str): Unused at this time.. [optional] # noqa: E501 paused (bool): Whether the service is paused. Services are paused due to a lack of traffic for an extended period of time. Services are resumed either when a draft version is activated or a locked version is cloned and reactivated.. [optional] # noqa: E501 - versions ([SchemasVersionResponse]): A list of [versions](/reference/api/services/version/) associated with the service.. [optional] # noqa: E501 + versions ([SchemasVersionResponse]): A list of [versions](https://www.fastly.com/documentation/reference/api/services/version/) associated with the service.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/fastly/model/tls_configuration_response_attributes.py b/fastly/model/tls_configuration_response_attributes.py index 4e397d5..4a183e9 100644 --- a/fastly/model/tls_configuration_response_attributes.py +++ b/fastly/model/tls_configuration_response_attributes.py @@ -160,7 +160,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 created_at (datetime, none_type): Date and time in ISO 8601 format.. [optional] # noqa: E501 deleted_at (datetime, none_type): Date and time in ISO 8601 format.. [optional] # noqa: E501 updated_at (datetime, none_type): Date and time in ISO 8601 format.. [optional] # noqa: E501 - default (bool): Signifies whether or not Fastly will use this configuration as a default when creating a new [TLS Activation](/reference/api/tls/custom-certs/activations/).. [optional] # noqa: E501 + default (bool): Signifies whether or not Fastly will use this configuration as a default when creating a new [TLS Activation](https://www.fastly.com/documentation/reference/api/tls/custom-certs/activations/).. [optional] # noqa: E501 http_protocols ([str]): HTTP protocols available on your configuration.. [optional] # noqa: E501 tls_protocols ([str]): TLS protocols available on your configuration.. [optional] # noqa: E501 bulk (bool): Signifies whether the configuration is used for Platform TLS or not.. [optional] # noqa: E501 @@ -266,7 +266,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 created_at (datetime, none_type): Date and time in ISO 8601 format.. [optional] # noqa: E501 deleted_at (datetime, none_type): Date and time in ISO 8601 format.. [optional] # noqa: E501 updated_at (datetime, none_type): Date and time in ISO 8601 format.. [optional] # noqa: E501 - default (bool): Signifies whether or not Fastly will use this configuration as a default when creating a new [TLS Activation](/reference/api/tls/custom-certs/activations/).. [optional] # noqa: E501 + default (bool): Signifies whether or not Fastly will use this configuration as a default when creating a new [TLS Activation](https://www.fastly.com/documentation/reference/api/tls/custom-certs/activations/).. [optional] # noqa: E501 http_protocols ([str]): HTTP protocols available on your configuration.. [optional] # noqa: E501 tls_protocols ([str]): TLS protocols available on your configuration.. [optional] # noqa: E501 bulk (bool): Signifies whether the configuration is used for Platform TLS or not.. [optional] # noqa: E501 diff --git a/fastly/model/tls_configuration_response_attributes_all_of.py b/fastly/model/tls_configuration_response_attributes_all_of.py index d70a86f..869eb81 100644 --- a/fastly/model/tls_configuration_response_attributes_all_of.py +++ b/fastly/model/tls_configuration_response_attributes_all_of.py @@ -142,7 +142,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - default (bool): Signifies whether or not Fastly will use this configuration as a default when creating a new [TLS Activation](/reference/api/tls/custom-certs/activations/).. [optional] # noqa: E501 + default (bool): Signifies whether or not Fastly will use this configuration as a default when creating a new [TLS Activation](https://www.fastly.com/documentation/reference/api/tls/custom-certs/activations/).. [optional] # noqa: E501 http_protocols ([str]): HTTP protocols available on your configuration.. [optional] # noqa: E501 tls_protocols ([str]): TLS protocols available on your configuration.. [optional] # noqa: E501 bulk (bool): Signifies whether the configuration is used for Platform TLS or not.. [optional] # noqa: E501 @@ -227,7 +227,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - default (bool): Signifies whether or not Fastly will use this configuration as a default when creating a new [TLS Activation](/reference/api/tls/custom-certs/activations/).. [optional] # noqa: E501 + default (bool): Signifies whether or not Fastly will use this configuration as a default when creating a new [TLS Activation](https://www.fastly.com/documentation/reference/api/tls/custom-certs/activations/).. [optional] # noqa: E501 http_protocols ([str]): HTTP protocols available on your configuration.. [optional] # noqa: E501 tls_protocols ([str]): TLS protocols available on your configuration.. [optional] # noqa: E501 bulk (bool): Signifies whether the configuration is used for Platform TLS or not.. [optional] # noqa: E501 diff --git a/fastly/model/tls_csr.py b/fastly/model/tls_csr.py new file mode 100644 index 0000000..83c53df --- /dev/null +++ b/fastly/model/tls_csr.py @@ -0,0 +1,259 @@ +""" + Fastly API + + Via the Fastly API you can perform any of the operations that are possible within the management console, including creating services, domains, and backends, configuring rules or uploading your own application code, as well as account operations such as user administration and billing reports. The API is organized into collections of endpoints that allow manipulation of objects related to Fastly services and accounts. For the most accurate and up-to-date API reference content, visit our [Developer Hub](https://developer.fastly.com/reference/api/) # noqa: E501 + + The version of the OpenAPI document: 1.0.0 + Contact: oss@fastly.com +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fastly.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from fastly.exceptions import ApiAttributeError + + +def lazy_import(): + from fastly.model.tls_csr_data import TlsCsrData + globals()['TlsCsrData'] = TlsCsrData + + +class TlsCsr(ModelNormal): + """NOTE: This class is auto generated. + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': (TlsCsrData,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """TlsCsr - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + data (TlsCsrData): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """TlsCsr - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + data (TlsCsrData): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/fastly/model/tls_csr_data.py b/fastly/model/tls_csr_data.py new file mode 100644 index 0000000..929d031 --- /dev/null +++ b/fastly/model/tls_csr_data.py @@ -0,0 +1,271 @@ +""" + Fastly API + + Via the Fastly API you can perform any of the operations that are possible within the management console, including creating services, domains, and backends, configuring rules or uploading your own application code, as well as account operations such as user administration and billing reports. The API is organized into collections of endpoints that allow manipulation of objects related to Fastly services and accounts. For the most accurate and up-to-date API reference content, visit our [Developer Hub](https://developer.fastly.com/reference/api/) # noqa: E501 + + The version of the OpenAPI document: 1.0.0 + Contact: oss@fastly.com +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fastly.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from fastly.exceptions import ApiAttributeError + + +def lazy_import(): + from fastly.model.relationship_tls_private_key import RelationshipTlsPrivateKey + from fastly.model.tls_csr_data_attributes import TlsCsrDataAttributes + from fastly.model.type_tls_csr import TypeTlsCsr + globals()['RelationshipTlsPrivateKey'] = RelationshipTlsPrivateKey + globals()['TlsCsrDataAttributes'] = TlsCsrDataAttributes + globals()['TypeTlsCsr'] = TypeTlsCsr + + +class TlsCsrData(ModelNormal): + """NOTE: This class is auto generated. + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'type': (TypeTlsCsr,), # noqa: E501 + 'attributes': (TlsCsrDataAttributes,), # noqa: E501 + 'relationships': (RelationshipTlsPrivateKey,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'type': 'type', # noqa: E501 + 'attributes': 'attributes', # noqa: E501 + 'relationships': 'relationships', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """TlsCsrData - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + type (TypeTlsCsr): [optional] # noqa: E501 + attributes (TlsCsrDataAttributes): [optional] # noqa: E501 + relationships (RelationshipTlsPrivateKey): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """TlsCsrData - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + type (TypeTlsCsr): [optional] # noqa: E501 + attributes (TlsCsrDataAttributes): [optional] # noqa: E501 + relationships (RelationshipTlsPrivateKey): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/fastly/model/tls_csr_data_attributes.py b/fastly/model/tls_csr_data_attributes.py new file mode 100644 index 0000000..1f735a8 --- /dev/null +++ b/fastly/model/tls_csr_data_attributes.py @@ -0,0 +1,303 @@ +""" + Fastly API + + Via the Fastly API you can perform any of the operations that are possible within the management console, including creating services, domains, and backends, configuring rules or uploading your own application code, as well as account operations such as user administration and billing reports. The API is organized into collections of endpoints that allow manipulation of objects related to Fastly services and accounts. For the most accurate and up-to-date API reference content, visit our [Developer Hub](https://developer.fastly.com/reference/api/) # noqa: E501 + + The version of the OpenAPI document: 1.0.0 + Contact: oss@fastly.com +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fastly.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from fastly.exceptions import ApiAttributeError + + + +class TlsCsrDataAttributes(ModelNormal): + """NOTE: This class is auto generated. + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('key_type',): { + 'RSA2048': "RSA2048", + 'ECDSA256': "ECDSA256", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'sans': ([str],), # noqa: E501 + 'common_name': (str,), # noqa: E501 + 'country': (str,), # noqa: E501 + 'state': (str,), # noqa: E501 + 'city': (str,), # noqa: E501 + 'postal_code': (str,), # noqa: E501 + 'street_address': (str,), # noqa: E501 + 'organization': (str,), # noqa: E501 + 'organizational_unit': (str,), # noqa: E501 + 'email': (str,), # noqa: E501 + 'key_type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'sans': 'sans', # noqa: E501 + 'common_name': 'common_name', # noqa: E501 + 'country': 'country', # noqa: E501 + 'state': 'state', # noqa: E501 + 'city': 'city', # noqa: E501 + 'postal_code': 'postal_code', # noqa: E501 + 'street_address': 'street_address', # noqa: E501 + 'organization': 'organization', # noqa: E501 + 'organizational_unit': 'organizational_unit', # noqa: E501 + 'email': 'email', # noqa: E501 + 'key_type': 'key_type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, sans, *args, **kwargs): # noqa: E501 + """TlsCsrDataAttributes - a model defined in OpenAPI + + Args: + sans ([str]): Subject Alternate Names - An array of one or more fully qualified domain names or public IP addresses to be secured by this certificate. Required. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + common_name (str): Common Name (CN) - The fully qualified domain name (FQDN) to be secured by this certificate. The common name should be one of the entries in the SANs parameter.. [optional] # noqa: E501 + country (str): Country (C) - The two-letter ISO country code where the organization is located.. [optional] # noqa: E501 + state (str): State (S) - The state, province, region, or county where the organization is located. This should not be abbreviated.. [optional] # noqa: E501 + city (str): Locality (L) - The locality, city, town, or village where the organization is located.. [optional] # noqa: E501 + postal_code (str): Postal Code - The postal code where the organization is located.. [optional] # noqa: E501 + street_address (str): Street Address - The street address where the organization is located.. [optional] # noqa: E501 + organization (str): Organization (O) - The legal name of the organization, including any suffixes. This should not be abbreviated.. [optional] # noqa: E501 + organizational_unit (str): Organizational Unit (OU) - The internal division of the organization managing the certificate.. [optional] # noqa: E501 + email (str): Email Address (EMAIL) - The organizational contact for this.. [optional] # noqa: E501 + key_type (str): CSR Key Type.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.sans = sans + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, sans, *args, **kwargs): # noqa: E501 + """TlsCsrDataAttributes - a model defined in OpenAPI + + Args: + sans ([str]): Subject Alternate Names - An array of one or more fully qualified domain names or public IP addresses to be secured by this certificate. Required. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + common_name (str): Common Name (CN) - The fully qualified domain name (FQDN) to be secured by this certificate. The common name should be one of the entries in the SANs parameter.. [optional] # noqa: E501 + country (str): Country (C) - The two-letter ISO country code where the organization is located.. [optional] # noqa: E501 + state (str): State (S) - The state, province, region, or county where the organization is located. This should not be abbreviated.. [optional] # noqa: E501 + city (str): Locality (L) - The locality, city, town, or village where the organization is located.. [optional] # noqa: E501 + postal_code (str): Postal Code - The postal code where the organization is located.. [optional] # noqa: E501 + street_address (str): Street Address - The street address where the organization is located.. [optional] # noqa: E501 + organization (str): Organization (O) - The legal name of the organization, including any suffixes. This should not be abbreviated.. [optional] # noqa: E501 + organizational_unit (str): Organizational Unit (OU) - The internal division of the organization managing the certificate.. [optional] # noqa: E501 + email (str): Email Address (EMAIL) - The organizational contact for this.. [optional] # noqa: E501 + key_type (str): CSR Key Type.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.sans = sans + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/fastly/model/tls_csr_error_response.py b/fastly/model/tls_csr_error_response.py new file mode 100644 index 0000000..2f21ecd --- /dev/null +++ b/fastly/model/tls_csr_error_response.py @@ -0,0 +1,259 @@ +""" + Fastly API + + Via the Fastly API you can perform any of the operations that are possible within the management console, including creating services, domains, and backends, configuring rules or uploading your own application code, as well as account operations such as user administration and billing reports. The API is organized into collections of endpoints that allow manipulation of objects related to Fastly services and accounts. For the most accurate and up-to-date API reference content, visit our [Developer Hub](https://developer.fastly.com/reference/api/) # noqa: E501 + + The version of the OpenAPI document: 1.0.0 + Contact: oss@fastly.com +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fastly.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from fastly.exceptions import ApiAttributeError + + +def lazy_import(): + from fastly.model.error_response_data import ErrorResponseData + globals()['ErrorResponseData'] = ErrorResponseData + + +class TlsCsrErrorResponse(ModelNormal): + """NOTE: This class is auto generated. + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'errors': ([ErrorResponseData],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'errors': 'errors', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """TlsCsrErrorResponse - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + errors ([ErrorResponseData]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """TlsCsrErrorResponse - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + errors ([ErrorResponseData]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/fastly/model/tls_csr_response.py b/fastly/model/tls_csr_response.py new file mode 100644 index 0000000..0b51937 --- /dev/null +++ b/fastly/model/tls_csr_response.py @@ -0,0 +1,259 @@ +""" + Fastly API + + Via the Fastly API you can perform any of the operations that are possible within the management console, including creating services, domains, and backends, configuring rules or uploading your own application code, as well as account operations such as user administration and billing reports. The API is organized into collections of endpoints that allow manipulation of objects related to Fastly services and accounts. For the most accurate and up-to-date API reference content, visit our [Developer Hub](https://developer.fastly.com/reference/api/) # noqa: E501 + + The version of the OpenAPI document: 1.0.0 + Contact: oss@fastly.com +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fastly.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from fastly.exceptions import ApiAttributeError + + +def lazy_import(): + from fastly.model.tls_csr_response_data import TlsCsrResponseData + globals()['TlsCsrResponseData'] = TlsCsrResponseData + + +class TlsCsrResponse(ModelNormal): + """NOTE: This class is auto generated. + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': (TlsCsrResponseData,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """TlsCsrResponse - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + data (TlsCsrResponseData): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """TlsCsrResponse - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + data (TlsCsrResponseData): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/fastly/model/tls_csr_response_attributes.py b/fastly/model/tls_csr_response_attributes.py new file mode 100644 index 0000000..ff1d5bf --- /dev/null +++ b/fastly/model/tls_csr_response_attributes.py @@ -0,0 +1,253 @@ +""" + Fastly API + + Via the Fastly API you can perform any of the operations that are possible within the management console, including creating services, domains, and backends, configuring rules or uploading your own application code, as well as account operations such as user administration and billing reports. The API is organized into collections of endpoints that allow manipulation of objects related to Fastly services and accounts. For the most accurate and up-to-date API reference content, visit our [Developer Hub](https://developer.fastly.com/reference/api/) # noqa: E501 + + The version of the OpenAPI document: 1.0.0 + Contact: oss@fastly.com +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fastly.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from fastly.exceptions import ApiAttributeError + + + +class TlsCsrResponseAttributes(ModelNormal): + """NOTE: This class is auto generated. + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'content': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'content': 'content', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """TlsCsrResponseAttributes - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + content (str): The PEM encoded CSR.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """TlsCsrResponseAttributes - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + content (str): The PEM encoded CSR.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/fastly/model/tls_csr_response_data.py b/fastly/model/tls_csr_response_data.py new file mode 100644 index 0000000..bf3f3aa --- /dev/null +++ b/fastly/model/tls_csr_response_data.py @@ -0,0 +1,275 @@ +""" + Fastly API + + Via the Fastly API you can perform any of the operations that are possible within the management console, including creating services, domains, and backends, configuring rules or uploading your own application code, as well as account operations such as user administration and billing reports. The API is organized into collections of endpoints that allow manipulation of objects related to Fastly services and accounts. For the most accurate and up-to-date API reference content, visit our [Developer Hub](https://developer.fastly.com/reference/api/) # noqa: E501 + + The version of the OpenAPI document: 1.0.0 + Contact: oss@fastly.com +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fastly.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from fastly.exceptions import ApiAttributeError + + +def lazy_import(): + from fastly.model.relationship_tls_private_key import RelationshipTlsPrivateKey + from fastly.model.tls_csr_response_attributes import TlsCsrResponseAttributes + from fastly.model.type_tls_csr import TypeTlsCsr + globals()['RelationshipTlsPrivateKey'] = RelationshipTlsPrivateKey + globals()['TlsCsrResponseAttributes'] = TlsCsrResponseAttributes + globals()['TypeTlsCsr'] = TypeTlsCsr + + +class TlsCsrResponseData(ModelNormal): + """NOTE: This class is auto generated. + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'type': (TypeTlsCsr,), # noqa: E501 + 'attributes': (TlsCsrResponseAttributes,), # noqa: E501 + 'relationships': (RelationshipTlsPrivateKey,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + 'attributes': 'attributes', # noqa: E501 + 'relationships': 'relationships', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """TlsCsrResponseData - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + type (TypeTlsCsr): [optional] # noqa: E501 + attributes (TlsCsrResponseAttributes): [optional] # noqa: E501 + relationships (RelationshipTlsPrivateKey): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """TlsCsrResponseData - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + type (TypeTlsCsr): [optional] # noqa: E501 + attributes (TlsCsrResponseAttributes): [optional] # noqa: E501 + relationships (RelationshipTlsPrivateKey): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/fastly/model/tls_subscription_data_attributes.py b/fastly/model/tls_subscription_data_attributes.py index b442105..fdd3b4a 100644 --- a/fastly/model/tls_subscription_data_attributes.py +++ b/fastly/model/tls_subscription_data_attributes.py @@ -55,6 +55,7 @@ class TlsSubscriptionDataAttributes(ModelNormal): allowed_values = { ('certificate_authority',): { 'LETS-ENCRYPT': "lets-encrypt", + 'CERTAINLY': "certainly", 'GLOBALSIGN': "globalsign", }, } diff --git a/fastly/model/tls_subscription_response_attributes.py b/fastly/model/tls_subscription_response_attributes.py index 6b0120c..7cb4772 100644 --- a/fastly/model/tls_subscription_response_attributes.py +++ b/fastly/model/tls_subscription_response_attributes.py @@ -98,6 +98,7 @@ def openapi_types(): 'deleted_at': (datetime, none_type,), # noqa: E501 'updated_at': (datetime, none_type,), # noqa: E501 'state': (str,), # noqa: E501 + 'has_active_order': (bool,), # noqa: E501 } @cached_property @@ -110,6 +111,7 @@ def discriminator(): 'deleted_at': 'deleted_at', # noqa: E501 'updated_at': 'updated_at', # noqa: E501 'state': 'state', # noqa: E501 + 'has_active_order': 'has_active_order', # noqa: E501 } read_only_vars = { @@ -158,6 +160,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 deleted_at (datetime, none_type): Date and time in ISO 8601 format.. [optional] # noqa: E501 updated_at (datetime, none_type): Date and time in ISO 8601 format.. [optional] # noqa: E501 state (str): The current state of your subscription.. [optional] # noqa: E501 + has_active_order (bool): Subscription has an active order. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -261,6 +264,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 deleted_at (datetime, none_type): Date and time in ISO 8601 format.. [optional] # noqa: E501 updated_at (datetime, none_type): Date and time in ISO 8601 format.. [optional] # noqa: E501 state (str): The current state of your subscription.. [optional] # noqa: E501 + has_active_order (bool): Subscription has an active order. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/fastly/model/tls_subscription_response_attributes_all_of.py b/fastly/model/tls_subscription_response_attributes_all_of.py index 8b28540..208896c 100644 --- a/fastly/model/tls_subscription_response_attributes_all_of.py +++ b/fastly/model/tls_subscription_response_attributes_all_of.py @@ -87,6 +87,7 @@ def openapi_types(): """ return { 'state': (str,), # noqa: E501 + 'has_active_order': (bool,), # noqa: E501 } @cached_property @@ -96,6 +97,7 @@ def discriminator(): attribute_map = { 'state': 'state', # noqa: E501 + 'has_active_order': 'has_active_order', # noqa: E501 } read_only_vars = { @@ -140,6 +142,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) state (str): The current state of your subscription.. [optional] # noqa: E501 + has_active_order (bool): Subscription has an active order. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -222,6 +225,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) state (str): The current state of your subscription.. [optional] # noqa: E501 + has_active_order (bool): Subscription has an active order. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/fastly/model/type_tls_csr.py b/fastly/model/type_tls_csr.py new file mode 100644 index 0000000..eff1915 --- /dev/null +++ b/fastly/model/type_tls_csr.py @@ -0,0 +1,271 @@ +""" + Fastly API + + Via the Fastly API you can perform any of the operations that are possible within the management console, including creating services, domains, and backends, configuring rules or uploading your own application code, as well as account operations such as user administration and billing reports. The API is organized into collections of endpoints that allow manipulation of objects related to Fastly services and accounts. For the most accurate and up-to-date API reference content, visit our [Developer Hub](https://developer.fastly.com/reference/api/) # noqa: E501 + + The version of the OpenAPI document: 1.0.0 + Contact: oss@fastly.com +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from fastly.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from fastly.exceptions import ApiAttributeError + + + +class TypeTlsCsr(ModelSimple): + """NOTE: This class is auto generated. + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('value',): { + 'CSR': "csr", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """TypeTlsCsr - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): CSR Resource Type. if omitted defaults to "csr", must be one of ["csr", ] # noqa: E501 + + Keyword Args: + value (str): CSR Resource Type. if omitted defaults to "csr", must be one of ["csr", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + value = "csr" + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """TypeTlsCsr - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): CSR Resource Type. if omitted defaults to "csr", must be one of ["csr", ] # noqa: E501 + + Keyword Args: + value (str): CSR Resource Type. if omitted defaults to "csr", must be one of ["csr", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + value = "csr" + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/fastly/models/__init__.py b/fastly/models/__init__.py index 7b24b7e..3271c83 100644 --- a/fastly/models/__init__.py +++ b/fastly/models/__init__.py @@ -22,6 +22,7 @@ from fastly.model.automation_token_create_request_attributes import AutomationTokenCreateRequestAttributes from fastly.model.automation_token_create_response import AutomationTokenCreateResponse from fastly.model.automation_token_create_response_all_of import AutomationTokenCreateResponseAllOf +from fastly.model.automation_token_error_response import AutomationTokenErrorResponse from fastly.model.automation_token_response import AutomationTokenResponse from fastly.model.automation_token_response_all_of import AutomationTokenResponseAllOf from fastly.model.aws_region import AwsRegion @@ -106,7 +107,8 @@ from fastly.model.enabled_product_response_links import EnabledProductResponseLinks from fastly.model.enabled_product_response_product import EnabledProductResponseProduct from fastly.model.enabled_product_response_service import EnabledProductResponseService -from fastly.model.error_response import ErrorResponse +from fastly.model.error import Error +from fastly.model.error_response_data import ErrorResponseData from fastly.model.event import Event from fastly.model.event_attributes import EventAttributes from fastly.model.event_data import EventData @@ -192,6 +194,9 @@ from fastly.model.invitation_response_data_all_of import InvitationResponseDataAllOf from fastly.model.invitations_response import InvitationsResponse from fastly.model.invitations_response_all_of import InvitationsResponseAllOf +from fastly.model.invoice import Invoice +from fastly.model.invoice_response import InvoiceResponse +from fastly.model.invoicelineitems import Invoicelineitems from fastly.model.legacy_waf_configuration_set import LegacyWafConfigurationSet from fastly.model.legacy_waf_firewall import LegacyWafFirewall from fastly.model.legacy_waf_owasp import LegacyWafOwasp @@ -202,6 +207,8 @@ from fastly.model.legacy_waf_update_status import LegacyWafUpdateStatus from fastly.model.line_item_data import LineItemData from fastly.model.line_item_data_read_only_invoice_id import LineItemDataReadOnlyInvoiceId +from fastly.model.list_invoices_response import ListInvoicesResponse +from fastly.model.listinvoices import Listinvoices from fastly.model.logging_address_and_port import LoggingAddressAndPort from fastly.model.logging_azureblob_additional import LoggingAzureblobAdditional from fastly.model.logging_azureblob_response import LoggingAzureblobResponse @@ -275,6 +282,7 @@ from fastly.model.logging_syslog_response import LoggingSyslogResponse from fastly.model.logging_tls_common import LoggingTlsCommon from fastly.model.logging_use_tls import LoggingUseTls +from fastly.model.metadata import Metadata from fastly.model.mutual_authentication import MutualAuthentication from fastly.model.mutual_authentication_data import MutualAuthenticationData from fastly.model.mutual_authentication_data_attributes import MutualAuthenticationDataAttributes @@ -557,6 +565,13 @@ from fastly.model.tls_configuration_response_data_all_of import TlsConfigurationResponseDataAllOf from fastly.model.tls_configurations_response import TlsConfigurationsResponse from fastly.model.tls_configurations_response_all_of import TlsConfigurationsResponseAllOf +from fastly.model.tls_csr import TlsCsr +from fastly.model.tls_csr_data import TlsCsrData +from fastly.model.tls_csr_data_attributes import TlsCsrDataAttributes +from fastly.model.tls_csr_error_response import TlsCsrErrorResponse +from fastly.model.tls_csr_response import TlsCsrResponse +from fastly.model.tls_csr_response_attributes import TlsCsrResponseAttributes +from fastly.model.tls_csr_response_data import TlsCsrResponseData from fastly.model.tls_dns_record import TlsDnsRecord from fastly.model.tls_domain_data import TlsDomainData from fastly.model.tls_domains_response import TlsDomainsResponse @@ -601,6 +616,7 @@ from fastly.model.type_tls_bulk_certificate import TypeTlsBulkCertificate from fastly.model.type_tls_certificate import TypeTlsCertificate from fastly.model.type_tls_configuration import TypeTlsConfiguration +from fastly.model.type_tls_csr import TypeTlsCsr from fastly.model.type_tls_dns_record import TypeTlsDnsRecord from fastly.model.type_tls_domain import TypeTlsDomain from fastly.model.type_tls_private_key import TypeTlsPrivateKey diff --git a/setup.py b/setup.py index ae73eb0..4ec16dd 100644 --- a/setup.py +++ b/setup.py @@ -12,7 +12,7 @@ from pathlib import Path NAME = "fastly" -VERSION = "5.0.1" +VERSION = "5.1.0" # To install the library, run the following # # python setup.py install diff --git a/sig.json b/sig.json index d934674..3e89073 100644 --- a/sig.json +++ b/sig.json @@ -1 +1 @@ -{"G": "d93f414c", "D": "01d08f3f"} +{"G": "fba34a94", "D": "3069431b"}