Generated v7.2.0

CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [v7.2.0](https://github.com/fastly/fastly-ruby/releases/tag/release/v7.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.
+
 ## [v7.1.1](https://github.com/fastly/fastly-ruby/releases/tag/release/v7.1.1) (2023-09-01)
 
 **Enhancements:**

README.md

@@ -8,7 +8,7 @@ A Ruby client library for interacting with most facets of the [Fastly API](https
 To install via RubyGems, add the following to your project's `Gemfile`:
 
 ```ruby
-gem 'fastly', '~> 7.1.1'
+gem 'fastly', '~> 7.2.0'
 ```
 
 Then run `bundle install`.
@@ -227,10 +227,10 @@ Class | Method | Description
 [*Fastly::InvitationsApi*](docs/InvitationsApi.md) | [**create_invitation**](docs/InvitationsApi.md#create_invitation) | Create an invitation
 [*Fastly::InvitationsApi*](docs/InvitationsApi.md) | [**delete_invitation**](docs/InvitationsApi.md#delete_invitation) | Delete an invitation
 [*Fastly::InvitationsApi*](docs/InvitationsApi.md) | [**list_invitations**](docs/InvitationsApi.md#list_invitations) | List invitations
-[*Fastly::KvStoreApi*](docs/KvStoreApi.md) | [**create_store**](docs/KvStoreApi.md#create_store) | Create an kv store.
-[*Fastly::KvStoreApi*](docs/KvStoreApi.md) | [**delete_store**](docs/KvStoreApi.md#delete_store) | Delete an kv store.
-[*Fastly::KvStoreApi*](docs/KvStoreApi.md) | [**get_store**](docs/KvStoreApi.md#get_store) | Describe an kv store.
-[*Fastly::KvStoreApi*](docs/KvStoreApi.md) | [**get_stores**](docs/KvStoreApi.md#get_stores) | List kv stores.
+[*Fastly::KvStoreApi*](docs/KvStoreApi.md) | [**create_store**](docs/KvStoreApi.md#create_store) | Create a KV store.
+[*Fastly::KvStoreApi*](docs/KvStoreApi.md) | [**delete_store**](docs/KvStoreApi.md#delete_store) | Delete a KV store.
+[*Fastly::KvStoreApi*](docs/KvStoreApi.md) | [**get_store**](docs/KvStoreApi.md#get_store) | Describe a KV store.
+[*Fastly::KvStoreApi*](docs/KvStoreApi.md) | [**get_stores**](docs/KvStoreApi.md#get_stores) | List KV stores.
 [*Fastly::KvStoreItemApi*](docs/KvStoreItemApi.md) | [**delete_key_from_store**](docs/KvStoreItemApi.md#delete_key_from_store) | Delete kv store item.
 [*Fastly::KvStoreItemApi*](docs/KvStoreItemApi.md) | [**get_keys**](docs/KvStoreItemApi.md#get_keys) | List kv store keys.
 [*Fastly::KvStoreItemApi*](docs/KvStoreItemApi.md) | [**get_value_for_key**](docs/KvStoreItemApi.md#get_value_for_key) | Get the value of an kv store item
@@ -588,6 +588,7 @@ Class | Method | Description
 [*Fastly::WafRulesApi*](docs/WafRulesApi.md) | [**get_waf_rule**](docs/WafRulesApi.md#get_waf_rule) | Get a rule
 [*Fastly::WafRulesApi*](docs/WafRulesApi.md) | [**list_waf_rules**](docs/WafRulesApi.md#list_waf_rules) | List available WAF rules
 [*Fastly::WafTagsApi*](docs/WafTagsApi.md) | [**list_waf_tags**](docs/WafTagsApi.md#list_waf_tags) | List tags
+[*Fastly::WholePlatformDdosHistoricalApi*](docs/WholePlatformDdosHistoricalApi.md) | [**get_platform_ddos_historical**](docs/WholePlatformDdosHistoricalApi.md#get_platform_ddos_historical) | Get historical DDoS metrics for the entire Fastly platform
 
 
 ## Issues

docs/HistoricalDdos.md

@@ -0,0 +1,13 @@
+# Fastly::HistoricalDdos
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** | Whether or not we were able to successfully execute the query. | [optional] |
+| **meta** | [**HistoricalDdosMeta**](HistoricalDdosMeta.md) |  | [optional] |
+| **msg** | **String** | If the query was not successful, this will provide a string that explains why. | [optional] |
+| **data** | [**Array<PlatformDdosDataItems>**](PlatformDdosDataItems.md) | A list of [entries](#entry-data-model). | [optional] |
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
+

docs/HistoricalDdosMeta.md

@@ -0,0 +1,13 @@
+# Fastly::HistoricalDdosMeta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **start** | **String** | Start time that was used to perform the query as an ISO-8601-formatted date and time. | [optional] |
+| **_end** | **String** | End time that was used to perform the query as an ISO-8601-formatted date and time. | [optional] |
+| **downsample** | **String** | Downsample that was used to perform the query. One of `hour` or `day`. | [optional] |
+| **metric** | **String** | A comma-separated list of the metrics that were requested. | [optional] |
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
+

docs/HistoricalFieldResultsAttributes.md

@@ -220,6 +220,15 @@
 | **ddos_action_tarpit** | **Integer** | The number of times the tarpit action was taken. The tarpit action delays writing the response to the client. | [optional] |
 | **ddos_action_close** | **Integer** | 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** | **Integer** | 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** | **Integer** | The number of challenge-start tokens created. | [optional] |
+| **bot_challenge_complete_tokens_passed** | **Integer** | The number of challenge-complete tokens that passed validation. | [optional] |
+| **bot_challenge_complete_tokens_failed** | **Integer** | The number of challenge-complete tokens that failed validation. | [optional] |
+| **bot_challenge_complete_tokens_checked** | **Integer** | The number of challenge-complete tokens checked. | [optional] |
+| **bot_challenge_complete_tokens_disabled** | **Integer** | The number of challenge-complete tokens not checked because the feature was disabled. | [optional] |
+| **bot_challenge_complete_tokens_issued** | **Integer** | 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** | **Integer** | The number of challenges issued. For example, the issuance of a CAPTCHA challenge. | [optional] |
+| **bot_challenges_succeeded** | **Integer** | The number of successful challenge solutions processed. For example, a correct CAPTCHA solution. | [optional] |
+| **bot_challenges_failed** | **Integer** | The number of failed challenge solutions processed. For example, an incorrect CAPTCHA solution. | [optional] |
 | **service_id** | [**ReadOnlyIdService**](ReadOnlyIdService.md) |  | [optional] |
 | **start_time** | **Integer** |  | [optional] |
 

docs/KvStoreApi.md

@@ -10,19 +10,19 @@ api_instance = Fastly::KvStoreApi.new
 
 | 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()`
 
 ```ruby
-create_store(opts): <StoreResponse> # Create an kv store.
+create_store(opts): <StoreResponse> # Create a KV store.
 ```
 
-Create a new kv store.
+Create a new KV store.
 
 ### Examples
 
@@ -34,7 +34,7 @@ opts = {
 }
 
 begin
-  # Create an kv store.
+  # Create a KV store.
   result = api_instance.create_store(opts)
   p result
 rescue Fastly::ApiError => e
@@ -58,10 +58,10 @@ end
 ## `delete_store()`
 
 ```ruby
-delete_store(opts) # Delete an kv store.
+delete_store(opts) # 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).
 
 ### Examples
 
@@ -72,7 +72,7 @@ opts = {
 }
 
 begin
-  # Delete an kv store.
+  # Delete a KV store.
   api_instance.delete_store(opts)
 rescue Fastly::ApiError => e
   puts "Error when calling KvStoreApi->delete_store: #{e}"
@@ -94,10 +94,10 @@ nil (empty response body)
 ## `get_store()`
 
 ```ruby
-get_store(opts): <StoreResponse> # Describe an kv store.
+get_store(opts): <StoreResponse> # Describe a KV store.
 ```
 
-Get an kv store by ID.
+Get a KV store by ID.
 
 ### Examples
 
@@ -108,7 +108,7 @@ opts = {
 }
 
 begin
-  # Describe an kv store.
+  # Describe a KV store.
   result = api_instance.get_store(opts)
   p result
 rescue Fastly::ApiError => e
@@ -131,7 +131,7 @@ end
 ## `get_stores()`
 
 ```ruby
-get_stores(opts): <InlineResponse2003> # List kv stores.
+get_stores(opts): <InlineResponse2003> # List KV stores.
 ```
 
 Get all stores for a given customer.
@@ -146,7 +146,7 @@ opts = {
 }
 
 begin
-  # List kv stores.
+  # List KV stores.
   result = api_instance.get_stores(opts)
   p result
 rescue Fastly::ApiError => e

docs/LoggingLogentriesAdditional.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **port** | **Integer** | The port number. | [optional][default to 20000] |
-| **token** | **String** | Use token based authentication ([https://logentries.com/doc/input-token/](https://logentries.com/doc/input-token/)). | [optional] |
+| **token** | **String** | Use token based authentication. | [optional] |
 | **use_tls** | [**LoggingUseTls**](LoggingUseTls.md) |  | [optional][default to LoggingUseTls::no_tls] |
 | **region** | **String** | The region to which to stream logs. | [optional] |
 

docs/LoggingLogentriesApi.md

@@ -38,7 +38,7 @@ opts = {
     format: 'format_example', # String | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats).
     format_version: 1, # Integer | 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`. 
     port: 56, # Integer | The port number.
-    token: 'token_example', # String | Use token based authentication ([https://logentries.com/doc/input-token/](https://logentries.com/doc/input-token/)).
+    token: 'token_example', # String | Use token based authentication.
     use_tls: Fastly::LoggingUseTls::no_tls, # LoggingUseTls | 
     region: 'US', # String | The region to which to stream logs.
 }
@@ -64,7 +64,7 @@ end
 | **format** | **String** | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
 | **format_version** | **Integer** | 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][default to FORMAT_VERSION::v2] |
 | **port** | **Integer** | The port number. | [optional][default to 20000] |
-| **token** | **String** | Use token based authentication ([https://logentries.com/doc/input-token/](https://logentries.com/doc/input-token/)). | [optional] |
+| **token** | **String** | Use token based authentication. | [optional] |
 | **use_tls** | [**LoggingUseTls**](LoggingUseTls.md) |  | [optional][default to LoggingUseTls::no_tls] |
 | **region** | **String** | The region to which to stream logs. | [optional] |
 
@@ -217,7 +217,7 @@ opts = {
     format: 'format_example', # String | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats).
     format_version: 1, # Integer | 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`. 
     port: 56, # Integer | The port number.
-    token: 'token_example', # String | Use token based authentication ([https://logentries.com/doc/input-token/](https://logentries.com/doc/input-token/)).
+    token: 'token_example', # String | Use token based authentication.
     use_tls: Fastly::LoggingUseTls::no_tls, # LoggingUseTls | 
     region: 'US', # String | The region to which to stream logs.
 }
@@ -244,7 +244,7 @@ end
 | **format** | **String** | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
 | **format_version** | **Integer** | 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][default to FORMAT_VERSION::v2] |
 | **port** | **Integer** | The port number. | [optional][default to 20000] |
-| **token** | **String** | Use token based authentication ([https://logentries.com/doc/input-token/](https://logentries.com/doc/input-token/)). | [optional] |
+| **token** | **String** | Use token based authentication. | [optional] |
 | **use_tls** | [**LoggingUseTls**](LoggingUseTls.md) |  | [optional][default to LoggingUseTls::no_tls] |
 | **region** | **String** | The region to which to stream logs. | [optional] |
 

docs/LoggingLogentriesResponse.md

@@ -10,7 +10,7 @@
 | **format** | **String** | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
 | **format_version** | **String** | 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][default to '2'] |
 | **port** | **Integer** | The port number. | [optional][default to 20000] |
-| **token** | **String** | Use token based authentication ([https://logentries.com/doc/input-token/](https://logentries.com/doc/input-token/)). | [optional] |
+| **token** | **String** | Use token based authentication. | [optional] |
 | **use_tls** | [**LoggingUseTls**](LoggingUseTls.md) |  | [optional][default to LoggingUseTls::no_tls] |
 | **region** | **String** | The region to which to stream logs. | [optional] |
 | **created_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |

docs/PlatformDdosDataItems.md

@@ -0,0 +1,10 @@
+# Fastly::PlatformDdosDataItems
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **values** | [**Values**](Values.md) |  | [optional] |
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
+

docs/PlatformDdosEntry.md

@@ -0,0 +1,10 @@
+# Fastly::PlatformDdosEntry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **values** | [**Array<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] |
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
+

docs/PlatformDdosResponse.md

@@ -0,0 +1,13 @@
+# Fastly::PlatformDdosResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** | Whether or not we were able to successfully execute the query. | [optional] |
+| **meta** | [**HistoricalDdosMeta**](HistoricalDdosMeta.md) |  | [optional] |
+| **msg** | **String** | If the query was not successful, this will provide a string that explains why. | [optional] |
+| **data** | [**Array<PlatformDdosEntry>**](PlatformDdosEntry.md) | A list of timeseries. | [optional] |
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
+

docs/PlatformDdosResponseAllOf.md

@@ -0,0 +1,10 @@
+# Fastly::PlatformDdosResponseAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<PlatformDdosEntry>**](PlatformDdosEntry.md) | A list of timeseries. | [optional] |
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
+

docs/RealtimeEntryAggregated.md

@@ -222,6 +222,15 @@
 | **ddos_action_tarpit** | **Integer** | The number of times the tarpit action was taken. The tarpit action delays writing the response to the client. | [optional] |
 | **ddos_action_close** | **Integer** | 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** | **Integer** | 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** | **Integer** | The number of challenge-start tokens created. | [optional] |
+| **bot_challenge_complete_tokens_passed** | **Integer** | The number of challenge-complete tokens that passed validation. | [optional] |
+| **bot_challenge_complete_tokens_failed** | **Integer** | The number of challenge-complete tokens that failed validation. | [optional] |
+| **bot_challenge_complete_tokens_checked** | **Integer** | The number of challenge-complete tokens checked. | [optional] |
+| **bot_challenge_complete_tokens_disabled** | **Integer** | The number of challenge-complete tokens not checked because the feature was disabled. | [optional] |
+| **bot_challenges_issued** | **Integer** | The number of challenges issued. For example, the issuance of a CAPTCHA challenge. | [optional] |
+| **bot_challenges_succeeded** | **Integer** | The number of successful challenge solutions processed. For example, a correct CAPTCHA solution. | [optional] |
+| **bot_challenges_failed** | **Integer** | The number of failed challenge solutions processed. For example, an incorrect CAPTCHA solution. | [optional] |
+| **bot_challenge_complete_tokens_issued** | **Integer** | The number of challenge-complete tokens issued. For example, issuing a challenge-complete token after a series of CAPTCHA challenges ending in success. | [optional] |
 
 [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)