Generated v4.2.0

CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [v4.2.0](https://github.com/fastly/fastly-py/releases/tag/release/v4.2.0) (2023-10-24)
+
+**Enhancements:**
+
+- feat(stats): add historical DDoS metrics.
+- feat(stats): add bot challenges.
+
+**Bug fixes:**
+
+- fix(snippets): ensure POST response's dynamic field is numerical.
+
 ## [v4.1.1](https://github.com/fastly/fastly-py/releases/tag/release/v4.1.1) (2023-09-01)
 
 **Enhancements:**

README.md

@@ -224,10 +224,10 @@ Class | Method | HTTP request | Description
 *InvitationsApi* | [**create_invitation**](docs/InvitationsApi.md#create_invitation) | **POST** /invitations | Create an invitation
 *InvitationsApi* | [**delete_invitation**](docs/InvitationsApi.md#delete_invitation) | **DELETE** /invitations/{invitation_id} | Delete an invitation
 *InvitationsApi* | [**list_invitations**](docs/InvitationsApi.md#list_invitations) | **GET** /invitations | List invitations
-*KvStoreApi* | [**create_store**](docs/KvStoreApi.md#create_store) | **POST** /resources/stores/kv | Create an kv store.
-*KvStoreApi* | [**delete_store**](docs/KvStoreApi.md#delete_store) | **DELETE** /resources/stores/kv/{store_id} | Delete an kv store.
-*KvStoreApi* | [**get_store**](docs/KvStoreApi.md#get_store) | **GET** /resources/stores/kv/{store_id} | Describe an kv store.
-*KvStoreApi* | [**get_stores**](docs/KvStoreApi.md#get_stores) | **GET** /resources/stores/kv | List kv stores.
+*KvStoreApi* | [**create_store**](docs/KvStoreApi.md#create_store) | **POST** /resources/stores/kv | Create a KV store.
+*KvStoreApi* | [**delete_store**](docs/KvStoreApi.md#delete_store) | **DELETE** /resources/stores/kv/{store_id} | Delete a KV store.
+*KvStoreApi* | [**get_store**](docs/KvStoreApi.md#get_store) | **GET** /resources/stores/kv/{store_id} | Describe a KV store.
+*KvStoreApi* | [**get_stores**](docs/KvStoreApi.md#get_stores) | **GET** /resources/stores/kv | List KV stores.
 *KvStoreItemApi* | [**delete_key_from_store**](docs/KvStoreItemApi.md#delete_key_from_store) | **DELETE** /resources/stores/kv/{store_id}/keys/{key_name} | Delete kv store item.
 *KvStoreItemApi* | [**get_keys**](docs/KvStoreItemApi.md#get_keys) | **GET** /resources/stores/kv/{store_id}/keys | List kv store keys.
 *KvStoreItemApi* | [**get_value_for_key**](docs/KvStoreItemApi.md#get_value_for_key) | **GET** /resources/stores/kv/{store_id}/keys/{key_name} | Get the value of an kv store item
@@ -585,6 +585,7 @@ Class | Method | HTTP request | Description
 *WafRulesApi* | [**get_waf_rule**](docs/WafRulesApi.md#get_waf_rule) | **GET** /waf/rules/{waf_rule_id} | Get a rule
 *WafRulesApi* | [**list_waf_rules**](docs/WafRulesApi.md#list_waf_rules) | **GET** /waf/rules | List available WAF rules
 *WafTagsApi* | [**list_waf_tags**](docs/WafTagsApi.md#list_waf_tags) | **GET** /waf/tags | List tags
+*WholePlatformDdosHistoricalApi* | [**get_platform_ddos_historical**](docs/WholePlatformDdosHistoricalApi.md#get_platform_ddos_historical) | **GET** /metrics/platform/ddos | Get historical DDoS metrics for the entire Fastly platform
 
 
 ## Issues

docs/HistoricalDdos.md

@@ -0,0 +1,15 @@
+# HistoricalDdos
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **str** | Whether or not we were able to successfully execute the query. | [optional] 
+**meta** | [**HistoricalDdosMeta**](HistoricalDdosMeta.md) |  | [optional] 
+**msg** | **str, none_type** | If the query was not successful, this will provide a string that explains why. | [optional] 
+**data** | [**[PlatformDdosDataItems]**](PlatformDdosDataItems.md) | A list of [entries](#entry-data-model). | [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/HistoricalDdosMeta.md

@@ -0,0 +1,16 @@
+# HistoricalDdosMeta
+
+Meta information about the scope of the query in a human readable format.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**start** | **str** | Start time that was used to perform the query as an ISO-8601-formatted date and time. | [optional] 
+**end** | **str** | End time that was used to perform the query as an ISO-8601-formatted date and time. | [optional] 
+**downsample** | **str** | Downsample that was used to perform the query. One of `hour` or `day`. | [optional] 
+**metric** | **str** | A comma-separated list of the metrics that were requested. | [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/HistoricalFieldResultsAttributes.md

@@ -220,6 +220,15 @@ Name | Type | Description | Notes
 **ddos_action_tarpit** | **int** | The number of times the tarpit action was taken. The tarpit action delays writing the response to the client. | [optional] 
 **ddos_action_close** | **int** | The number of times the close action was taken. The close action aborts the connection as soon as possible. The close action takes effect either right after accept, right after the client hello, or right after the response was sent. | [optional] 
 **ddos_action_blackhole** | **int** | The number of times the blackhole action was taken. The blackhole action quietly closes a TCP connection without sending a reset. The blackhole action quietly closes a TCP connection without notifying its peer (all TCP state is dropped). | [optional] 
+**bot_challenge_starts** | **int** | The number of challenge-start tokens created. | [optional] 
+**bot_challenge_complete_tokens_passed** | **int** | The number of challenge-complete tokens that passed validation. | [optional] 
+**bot_challenge_complete_tokens_failed** | **int** | The number of challenge-complete tokens that failed validation. | [optional] 
+**bot_challenge_complete_tokens_checked** | **int** | The number of challenge-complete tokens checked. | [optional] 
+**bot_challenge_complete_tokens_disabled** | **int** | The number of challenge-complete tokens not checked because the feature was disabled. | [optional] 
+**bot_challenge_complete_tokens_issued** | **int** | The number of challenge-complete tokens issued. For example, issuing a challenge-complete token after a series of CAPTCHA challenges ending in success. | [optional] 
+**bot_challenges_issued** | **int** | The number of challenges issued. For example, the issuance of a CAPTCHA challenge. | [optional] 
+**bot_challenges_succeeded** | **int** | The number of successful challenge solutions processed. For example, a correct CAPTCHA solution. | [optional] 
+**bot_challenges_failed** | **int** | The number of failed challenge solutions processed. For example, an incorrect CAPTCHA solution. | [optional] 
 **service_id** | [**ReadOnlyIdService**](ReadOnlyIdService.md) |  | [optional] 
 **start_time** | **int** |  | [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]

docs/KvStoreApi.md

@@ -4,18 +4,18 @@ All URIs are relative to *https://api.fastly.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**create_store**](KvStoreApi.md#create_store) | **POST** /resources/stores/kv | Create an kv store.
-[**delete_store**](KvStoreApi.md#delete_store) | **DELETE** /resources/stores/kv/{store_id} | Delete an kv store.
-[**get_store**](KvStoreApi.md#get_store) | **GET** /resources/stores/kv/{store_id} | Describe an kv store.
-[**get_stores**](KvStoreApi.md#get_stores) | **GET** /resources/stores/kv | List kv stores.
+[**create_store**](KvStoreApi.md#create_store) | **POST** /resources/stores/kv | Create a KV store.
+[**delete_store**](KvStoreApi.md#delete_store) | **DELETE** /resources/stores/kv/{store_id} | Delete a KV store.
+[**get_store**](KvStoreApi.md#get_store) | **GET** /resources/stores/kv/{store_id} | Describe a KV store.
+[**get_stores**](KvStoreApi.md#get_stores) | **GET** /resources/stores/kv | List KV stores.
 
 
 # **create_store**
 > StoreResponse create_store()
 
-Create an kv store.
+Create a KV store.
 
-Create a new kv store.
+Create a new KV store.
 
 ### Example
 
@@ -57,7 +57,7 @@ with fastly.ApiClient(configuration) as api_client:
     # example passing only required values which don't have defaults set
     # and optional values
     try:
-        # Create an kv store.
+        # Create a KV store.
         api_response = api_instance.create_store(location=location, store=store)
         pprint(api_response)
     except fastly.ApiException as e:
@@ -97,9 +97,9 @@ Name | Type | Description  | Notes
 # **delete_store**
 > delete_store(store_id)
 
-Delete an kv store.
+Delete a KV store.
 
-An kv store must be empty before it can be deleted.  Deleting an kv store that still contains keys will result in a `409` (Conflict).
+A KV store must be empty before it can be deleted.  Deleting a KV store that still contains keys will result in a `409` (Conflict).
 
 ### Example
 
@@ -135,7 +135,7 @@ with fastly.ApiClient(configuration) as api_client:
 
     # example passing only required values which don't have defaults set
     try:
-        # Delete an kv store.
+        # Delete a KV store.
         api_instance.delete_store(store_id)
     except fastly.ApiException as e:
         print("Exception when calling KvStoreApi->delete_store: %s\n" % e)
@@ -173,9 +173,9 @@ void (empty response body)
 # **get_store**
 > StoreResponse get_store(store_id)
 
-Describe an kv store.
+Describe a KV store.
 
-Get an kv store by ID.
+Get a KV store by ID.
 
 ### Example
 
@@ -212,7 +212,7 @@ with fastly.ApiClient(configuration) as api_client:
 
     # example passing only required values which don't have defaults set
     try:
-        # Describe an kv store.
+        # Describe a KV store.
         api_response = api_instance.get_store(store_id)
         pprint(api_response)
     except fastly.ApiException as e:
@@ -251,7 +251,7 @@ Name | Type | Description  | Notes
 # **get_stores**
 > InlineResponse2003 get_stores()
 
-List kv stores.
+List KV stores.
 
 Get all stores for a given customer.
 
@@ -292,7 +292,7 @@ with fastly.ApiClient(configuration) as api_client:
     # example passing only required values which don't have defaults set
     # and optional values
     try:
-        # List kv stores.
+        # List KV stores.
         api_response = api_instance.get_stores(cursor=cursor, limit=limit)
         pprint(api_response)
     except fastly.ApiException as e:

docs/LoggingLogentriesAdditional.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **port** | **int** | The port number. | [optional]  if omitted the server will use the default value of 20000
-**token** | **str** | Use token based authentication ([https://logentries.com/doc/input-token/](https://logentries.com/doc/input-token/)). | [optional] 
+**token** | **str** | Use token based authentication. | [optional] 
 **use_tls** | [**LoggingUseTls**](LoggingUseTls.md) |  | [optional] 
 **region** | **str** | The region to which to stream logs. | [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]

docs/LoggingLogentriesApi.md

@@ -58,7 +58,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
     port = 20000 # int | The port number. (optional) if omitted the server will use the default value of 20000
-    token = "token_example" # str | Use token based authentication ([https://logentries.com/doc/input-token/](https://logentries.com/doc/input-token/)). (optional)
+    token = "token_example" # str | Use token based authentication. (optional)
     use_tls = LoggingUseTls(0) # LoggingUseTls |  (optional)
     region = "US" # str | The region to which to stream logs. (optional)
 
@@ -93,7 +93,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
  **port** | **int**| The port number. | [optional] if omitted the server will use the default value of 20000
- **token** | **str**| Use token based authentication ([https://logentries.com/doc/input-token/](https://logentries.com/doc/input-token/)). | [optional]
+ **token** | **str**| Use token based authentication. | [optional]
  **use_tls** | [**LoggingUseTls**](LoggingUseTls.md)|  | [optional]
  **region** | **str**| The region to which to stream logs. | [optional]
 
@@ -411,7 +411,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
     port = 20000 # int | The port number. (optional) if omitted the server will use the default value of 20000
-    token = "token_example" # str | Use token based authentication ([https://logentries.com/doc/input-token/](https://logentries.com/doc/input-token/)). (optional)
+    token = "token_example" # str | Use token based authentication. (optional)
     use_tls = LoggingUseTls(0) # LoggingUseTls |  (optional)
     region = "US" # str | The region to which to stream logs. (optional)
 
@@ -447,7 +447,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
  **port** | **int**| The port number. | [optional] if omitted the server will use the default value of 20000
- **token** | **str**| Use token based authentication ([https://logentries.com/doc/input-token/](https://logentries.com/doc/input-token/)). | [optional]
+ **token** | **str**| Use token based authentication. | [optional]
  **use_tls** | [**LoggingUseTls**](LoggingUseTls.md)|  | [optional]
  **region** | **str**| The region to which to stream logs. | [optional]
 

docs/LoggingLogentriesResponse.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"
 **port** | **int** | The port number. | [optional]  if omitted the server will use the default value of 20000
-**token** | **str** | Use token based authentication ([https://logentries.com/doc/input-token/](https://logentries.com/doc/input-token/)). | [optional] 
+**token** | **str** | Use token based authentication. | [optional] 
 **use_tls** | [**LoggingUseTls**](LoggingUseTls.md) |  | [optional] 
 **region** | **str** | The region to which to stream logs. | [optional] 
 **created_at** | **datetime, none_type** | Date and time in ISO 8601 format. | [optional] [readonly] 

docs/PlatformDdosDataItems.md

@@ -0,0 +1,12 @@
+# PlatformDdosDataItems
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**values** | [**Values**](Values.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)
+
+

docs/PlatformDdosEntry.md

@@ -0,0 +1,12 @@
+# PlatformDdosEntry
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**values** | [**[ValuesDdos]**](ValuesDdos.md) | An array of values representing the metric values at each point in time. Note that this dataset is sparse: only the keys with non-zero values will be included in the record.  | [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/PlatformDdosResponse.md

@@ -0,0 +1,15 @@
+# PlatformDdosResponse
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **str** | Whether or not we were able to successfully execute the query. | [optional] 
+**meta** | [**HistoricalDdosMeta**](HistoricalDdosMeta.md) |  | [optional] 
+**msg** | **str, none_type** | If the query was not successful, this will provide a string that explains why. | [optional] 
+**data** | [**PlatformDdosResponseData**](PlatformDdosResponseData.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)
+
+

docs/PlatformDdosResponseAllOf.md

@@ -0,0 +1,12 @@
+# PlatformDdosResponseAllOf
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**PlatformDdosResponseData**](PlatformDdosResponseData.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)
+
+

docs/PlatformDdosResponseData.md

@@ -0,0 +1,12 @@
+# PlatformDdosResponseData
+
+A list of timeseries.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | [**[PlatformDdosEntry]**](PlatformDdosEntry.md) | A list of timeseries. | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+