Generated v5.3.0

CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## [v5.3.0](https://github.com/fastly/fastly-py/releases/tag/release/v5.3.0) (2024-05-24)
+
+**Bug fixes:**
+
+- fix(backend): Correct tcp_keepalive_enable to be nullable
+- bugfix(resource): Correct `type_resource` accepted values
+- bugfix(sudo): Mark API to require authentication token
+
+**Enhancements:**
+
+- feat(image-optimizer-default-settings): Add Image Optimizer Default Settings APIs
+- feat(tls-subscriptions): Add `certificate_authority` filter parameter
+
+**Documentation:**
+
+- docs(generator): Update links in docs and comments with unified docs site URL structure
+- docs(generator): Clean up README by using GitHub alert icons and collapsible sections
+- doc(logging-kinesis): Update description of `format` field.
+- doc(tls-subscriptions): Update descriptions of `certificate_authority` and `tls_subscription_include` fields.
+
 ## [v5.2.0](https://github.com/fastly/fastly-py/releases/tag/release/v5.2.0) (2024-04-25)
 
 **Bug fixes:**

docs/AclApi.md

@@ -1,6 +1,7 @@
 # fastly.AclApi
 
-All URIs are relative to *https://api.fastly.com*
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

docs/AclEntryApi.md

@@ -1,6 +1,7 @@
 # fastly.AclEntryApi
 
-All URIs are relative to *https://api.fastly.com*
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

docs/ApexRedirectApi.md

@@ -1,6 +1,7 @@
 # fastly.ApexRedirectApi
 
-All URIs are relative to *https://api.fastly.com*
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

docs/AutomationTokensApi.md

@@ -1,6 +1,7 @@
 # fastly.AutomationTokensApi
 
-All URIs are relative to *https://api.fastly.com*
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

docs/Backend.md

@@ -33,7 +33,7 @@ Name | Type | Description | Notes
 **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] 
 **ssl_sni_hostname** | **str, none_type** | Overrides `ssl_hostname`, but only for SNI in the handshake. Does not affect cert validation at all. | [optional] 
-**tcp_keepalive_enable** | **bool** | Whether to enable TCP keepalives for backend connections. Varnish defaults to using keepalives if this is unspecified. | [optional] 
+**tcp_keepalive_enable** | **bool, none_type** | Whether to enable TCP keepalives for backend connections. Varnish defaults to using keepalives if this is unspecified. | [optional] 
 **tcp_keepalive_interval** | **int, none_type** | Interval in seconds between subsequent keepalive probes. | [optional] 
 **tcp_keepalive_probes** | **int, none_type** | Number of unacknowledged probes to send before considering the connection dead. | [optional] 
 **tcp_keepalive_time** | **int, none_type** | Interval in seconds between the last data packet sent and the first keepalive probe. | [optional] 

docs/BackendApi.md

@@ -1,6 +1,7 @@
 # fastly.BackendApi
 
-All URIs are relative to *https://api.fastly.com*
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
@@ -80,7 +81,7 @@ with fastly.ApiClient(configuration) as api_client:
     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)
     ssl_sni_hostname = "ssl_sni_hostname_example" # str, none_type | Overrides `ssl_hostname`, but only for SNI in the handshake. Does not affect cert validation at all. (optional)
-    tcp_keepalive_enable = True # bool | Whether to enable TCP keepalives for backend connections. Varnish defaults to using keepalives if this is unspecified. (optional)
+    tcp_keepalive_enable = True # bool, none_type | Whether to enable TCP keepalives for backend connections. Varnish defaults to using keepalives if this is unspecified. (optional)
     tcp_keepalive_interval = 1 # int, none_type | Interval in seconds between subsequent keepalive probes. (optional)
     tcp_keepalive_probes = 1 # int, none_type | Number of unacknowledged probes to send before considering the connection dead. (optional)
     tcp_keepalive_time = 1 # int, none_type | Interval in seconds between the last data packet sent and the first keepalive probe. (optional)
@@ -141,7 +142,7 @@ Name | Type | Description  | Notes
  **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]
  **ssl_sni_hostname** | **str, none_type**| Overrides `ssl_hostname`, but only for SNI in the handshake. Does not affect cert validation at all. | [optional]
- **tcp_keepalive_enable** | **bool**| Whether to enable TCP keepalives for backend connections. Varnish defaults to using keepalives if this is unspecified. | [optional]
+ **tcp_keepalive_enable** | **bool, none_type**| Whether to enable TCP keepalives for backend connections. Varnish defaults to using keepalives if this is unspecified. | [optional]
  **tcp_keepalive_interval** | **int, none_type**| Interval in seconds between subsequent keepalive probes. | [optional]
  **tcp_keepalive_probes** | **int, none_type**| Number of unacknowledged probes to send before considering the connection dead. | [optional]
  **tcp_keepalive_time** | **int, none_type**| Interval in seconds between the last data packet sent and the first keepalive probe. | [optional]
@@ -484,7 +485,7 @@ with fastly.ApiClient(configuration) as api_client:
     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)
     ssl_sni_hostname = "ssl_sni_hostname_example" # str, none_type | Overrides `ssl_hostname`, but only for SNI in the handshake. Does not affect cert validation at all. (optional)
-    tcp_keepalive_enable = True # bool | Whether to enable TCP keepalives for backend connections. Varnish defaults to using keepalives if this is unspecified. (optional)
+    tcp_keepalive_enable = True # bool, none_type | Whether to enable TCP keepalives for backend connections. Varnish defaults to using keepalives if this is unspecified. (optional)
     tcp_keepalive_interval = 1 # int, none_type | Interval in seconds between subsequent keepalive probes. (optional)
     tcp_keepalive_probes = 1 # int, none_type | Number of unacknowledged probes to send before considering the connection dead. (optional)
     tcp_keepalive_time = 1 # int, none_type | Interval in seconds between the last data packet sent and the first keepalive probe. (optional)
@@ -546,7 +547,7 @@ Name | Type | Description  | Notes
  **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]
  **ssl_sni_hostname** | **str, none_type**| Overrides `ssl_hostname`, but only for SNI in the handshake. Does not affect cert validation at all. | [optional]
- **tcp_keepalive_enable** | **bool**| Whether to enable TCP keepalives for backend connections. Varnish defaults to using keepalives if this is unspecified. | [optional]
+ **tcp_keepalive_enable** | **bool, none_type**| Whether to enable TCP keepalives for backend connections. Varnish defaults to using keepalives if this is unspecified. | [optional]
  **tcp_keepalive_interval** | **int, none_type**| Interval in seconds between subsequent keepalive probes. | [optional]
  **tcp_keepalive_probes** | **int, none_type**| Number of unacknowledged probes to send before considering the connection dead. | [optional]
  **tcp_keepalive_time** | **int, none_type**| Interval in seconds between the last data packet sent and the first keepalive probe. | [optional]

docs/BackendResponse.md

@@ -33,7 +33,7 @@ Name | Type | Description | Notes
 **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] 
 **ssl_sni_hostname** | **str, none_type** | Overrides `ssl_hostname`, but only for SNI in the handshake. Does not affect cert validation at all. | [optional] 
-**tcp_keepalive_enable** | **bool** | Whether to enable TCP keepalives for backend connections. Varnish defaults to using keepalives if this is unspecified. | [optional] 
+**tcp_keepalive_enable** | **bool, none_type** | Whether to enable TCP keepalives for backend connections. Varnish defaults to using keepalives if this is unspecified. | [optional] 
 **tcp_keepalive_interval** | **int, none_type** | Interval in seconds between subsequent keepalive probes. | [optional] 
 **tcp_keepalive_probes** | **int, none_type** | Number of unacknowledged probes to send before considering the connection dead. | [optional] 
 **tcp_keepalive_time** | **int, none_type** | Interval in seconds between the last data packet sent and the first keepalive probe. | [optional] 

docs/BillingAddressApi.md

@@ -1,6 +1,7 @@
 # fastly.BillingAddressApi
 
-All URIs are relative to *https://api.fastly.com*
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

docs/BillingApi.md

@@ -1,6 +1,7 @@
 # fastly.BillingApi
 
-All URIs are relative to *https://api.fastly.com*
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

docs/BillingInvoicesApi.md

@@ -1,6 +1,7 @@
 # fastly.BillingInvoicesApi
 
-All URIs are relative to *https://api.fastly.com*
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

docs/CacheSettingsApi.md

@@ -1,6 +1,7 @@
 # fastly.CacheSettingsApi
 
-All URIs are relative to *https://api.fastly.com*
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

docs/ConditionApi.md

@@ -1,6 +1,7 @@
 # fastly.ConditionApi
 
-All URIs are relative to *https://api.fastly.com*
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

docs/ConfigStoreApi.md

@@ -1,6 +1,7 @@
 # fastly.ConfigStoreApi
 
-All URIs are relative to *https://api.fastly.com*
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

docs/ConfigStoreItemApi.md

@@ -1,6 +1,7 @@
 # fastly.ConfigStoreItemApi
 
-All URIs are relative to *https://api.fastly.com*
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

docs/ContactApi.md

@@ -1,6 +1,7 @@
 # fastly.ContactApi
 
-All URIs are relative to *https://api.fastly.com*
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

docs/ContentApi.md

@@ -1,6 +1,7 @@
 # fastly.ContentApi
 
-All URIs are relative to *https://api.fastly.com*
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

docs/CustomerApi.md

@@ -1,6 +1,7 @@
 # fastly.CustomerApi
 
-All URIs are relative to *https://api.fastly.com*
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

docs/DefaultSettings.md

@@ -0,0 +1,18 @@
+# DefaultSettings
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**resize_filter** | **str** | The type of filter to use while resizing an image. | [optional]  if omitted the server will use the default value of "lanczos3"
+**webp** | **bool** | Controls whether or not to default to WebP output when the client supports it. This is equivalent to adding \"auto=webp\" to all image optimizer requests.  | [optional]  if omitted the server will use the default value of False
+**webp_quality** | **int** | The default quality to use with WebP output. This can be overridden with the second option in the \"quality\" URL parameter on specific image optimizer requests.  | [optional]  if omitted the server will use the default value of 85
+**jpeg_type** | **str** | The default type of JPEG output to use. This can be overridden with \"format=bjpeg\" and \"format=pjpeg\" on specific image optimizer requests.  | [optional]  if omitted the server will use the default value of "auto"
+**jpeg_quality** | **int** | The default quality to use with JPEG output. This can be overridden with the \"quality\" parameter on specific image optimizer requests.  | [optional]  if omitted the server will use the default value of 85
+**upscale** | **bool** | Whether or not we should allow output images to render at sizes larger than input.  | [optional]  if omitted the server will use the default value of False
+**allow_video** | **bool** | Enables GIF to MP4 transformations on this service. | [optional]  if omitted the server will use the default value of False
+**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)
+
+

docs/DefaultSettingsError.md

@@ -0,0 +1,14 @@
+# DefaultSettingsError
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **str** |  | [optional] 
+**type** | **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)
+
+

docs/DefaultSettingsResponse.md

@@ -0,0 +1,18 @@
+# DefaultSettingsResponse
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**resize_filter** | **str** | The type of filter to use while resizing an image. | defaults to "lanczos3"
+**webp** | **bool** | Controls whether or not to default to WebP output when the client supports it. This is equivalent to adding \"auto=webp\" to all image optimizer requests.  | defaults to False
+**webp_quality** | **int** | The default quality to use with WebP output. This can be overridden with the second option in the \"quality\" URL parameter on specific image optimizer requests.  | defaults to 85
+**jpeg_type** | **str** | The default type of JPEG output to use. This can be overridden with \"format=bjpeg\" and \"format=pjpeg\" on specific image optimizer requests.  | defaults to "auto"
+**jpeg_quality** | **int** | The default quality to use with JPEG output. This can be overridden with the \"quality\" parameter on specific image optimizer requests.  | defaults to 85
+**upscale** | **bool** | Whether or not we should allow output images to render at sizes larger than input.  | defaults to False
+**allow_video** | **bool** | Enables GIF to MP4 transformations on this service. | defaults to False
+**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)
+
+

docs/DictionaryApi.md

@@ -1,6 +1,7 @@
 # fastly.DictionaryApi
 
-All URIs are relative to *https://api.fastly.com*
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

docs/DictionaryInfoApi.md

@@ -1,6 +1,7 @@
 # fastly.DictionaryInfoApi
 
-All URIs are relative to *https://api.fastly.com*
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

docs/DictionaryItemApi.md

@@ -1,6 +1,7 @@
 # fastly.DictionaryItemApi
 
-All URIs are relative to *https://api.fastly.com*
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

docs/DiffApi.md

@@ -1,6 +1,7 @@
 # fastly.DiffApi
 
-All URIs are relative to *https://api.fastly.com*
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

docs/DirectorApi.md

@@ -1,6 +1,7 @@
 # fastly.DirectorApi
 
-All URIs are relative to *https://api.fastly.com*
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

docs/DirectorBackendApi.md

@@ -1,6 +1,7 @@
 # fastly.DirectorBackendApi
 
-All URIs are relative to *https://api.fastly.com*
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

docs/DomainApi.md

@@ -1,6 +1,7 @@
 # fastly.DomainApi
 
-All URIs are relative to *https://api.fastly.com*
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

docs/DomainInspectorHistoricalApi.md

@@ -1,6 +1,7 @@
 # fastly.DomainInspectorHistoricalApi
 
-All URIs are relative to *https://api.fastly.com*
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

docs/DomainInspectorRealtimeApi.md

@@ -1,6 +1,7 @@
 # fastly.DomainInspectorRealtimeApi
 
-All URIs are relative to *https://api.fastly.com*
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

docs/DomainOwnershipsApi.md

@@ -1,6 +1,7 @@
 # fastly.DomainOwnershipsApi
 
-All URIs are relative to *https://api.fastly.com*
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

docs/EnabledProductsApi.md

@@ -1,6 +1,7 @@
 # fastly.EnabledProductsApi
 
-All URIs are relative to *https://api.fastly.com*
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

docs/EventsApi.md

@@ -1,6 +1,7 @@
 # fastly.EventsApi
 
-All URIs are relative to *https://api.fastly.com*
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

docs/GzipApi.md

@@ -1,6 +1,7 @@
 # fastly.GzipApi
 
-All URIs are relative to *https://api.fastly.com*
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

docs/HeaderApi.md

@@ -1,6 +1,7 @@
 # fastly.HeaderApi
 
-All URIs are relative to *https://api.fastly.com*
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------