Generated v8.4.0

CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## [v8.4.0](https://github.com/fastly/fastly-ruby/releases/tag/release/v8.4.0) (2024-06-27)
+
+**Bug fixes:**
+
+- bugfix(alerts-definitions): For Origin derived metrics, correct `all_bandwidth` type to `integer`
+
+**Enhancements:**
+
+- feat(logging-s3): Add `file_max_bytes` configuration field
+- feat(alerts-definitions): Add `integration_id` parameter to the List Alert Definitions endpoint
+- feat(alerts-definitions): For Origin derived metrics, add `all_status_4xx_excl_404_rate` and `all_status_404_rate` properties
+- feat(alerts-definitions): For Domain derived metrics, add `status_4xx_excl_404_rate` and `status_404_rate` properties
+- feat(alerts-definitions): For Stats derived metrics, add `status_4xx_excl_404_rate`, `status_404_rate`, `all_status_5xx_rate`,
+                            `all_status_4xx_rate`, `all_status_gte_400_rate`, and `all_status_lt_500_rate` properties
+- feat(billing-invoices): For invoice line items, added `ProductLine` property
+
+**Documentation:**
+
+- doc(billing-invoices): "Billing Invoices API" relabeled to "Invoices API"
+- doc(billing-invoices): Updated documentation of `billing_start_date` and `billing_end_date` query parameters of
+                         List of invoices endpoint
+- doc(alerts-definitions): Updated documentation of several fields
+- doc(notification-service): Updated documentation examples for several fields
+
 ## [v8.3.0](https://github.com/fastly/fastly-ruby/releases/tag/release/v8.3.0) (2024-05-24)
 
 **Bug fixes:**

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', '~> 8.3.0'
+gem 'fastly', '~> 8.4.0'
 ```
 
 Then run `bundle install`.
@@ -621,6 +621,8 @@ The fastly-ruby API client currently does not support the following endpoints:
 - [`/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)
+- [`/tls/preview/domains/{tls_preview_domain_id}`](https://www.fastly.com/documentation/reference/api/) (GET, PATCH)
+- [`/tls/preview/domains`](https://www.fastly.com/documentation/reference/api/) (GET, POST)
 - [`/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)

docs/BillingInvoicesApi.md

@@ -67,8 +67,8 @@ Returns the list of invoices, sorted by billing start date (newest to oldest).
 ```ruby
 api_instance = Fastly::BillingInvoicesApi.new
 opts = {
-    billing_start_date: '2023-01-01T00:00:00Z', # String | 
-    billing_end_date: '2023-01-31T00:00:00Z', # String | 
+    billing_start_date: '2023-01-01', # String | 
+    billing_end_date: '2023-01-31', # String | 
     limit: 'limit_example', # String | Number of results per page. The maximum is 200.
     cursor: 'cursor_example', # String | 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.
 }

docs/Invoicelineitems.md

@@ -11,6 +11,7 @@
 | **units** | **Float** | Total number of units of usage. | [optional] |
 | **product_name** | **String** | The name of the product. | [optional] |
 | **product_group** | **String** | The broader classification of the product (e.g., `Compute` or `Full-Site Delivery`). | [optional] |
+| **product_line** | **String** | The broader classification of the product (e.g., `Network Services` or `Security`). | [optional] |
 | **region** | **String** | The geographical area applicable for regionally based products. | [optional] |
 | **usage_type** | **String** | The unit of measure (e.g., `requests` or `bandwidth`). | [optional] |
 

docs/LoggingS3Additional.md

@@ -15,6 +15,7 @@
 | **secret_key** | **String** | The secret key for your S3 account. Not required if `iam_role` is provided. | [optional] |
 | **server_side_encryption_kms_key_id** | **String** | Optional server-side KMS Key Id. Must be set if `server_side_encryption` is set to `aws:kms` or `AES256`. | [optional][default to 'null'] |
 | **server_side_encryption** | **String** | Set this to `AES256` or `aws:kms` to enable S3 Server Side Encryption. | [optional][default to 'null'] |
+| **file_max_bytes** | **Integer** | The maximum number of bytes for each uploaded file. A value of 0 can be used to indicate there is no limit on the size of uploaded files, otherwise the minimum value is 1048576 bytes (1 MiB.) | [optional] |
 
 [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
 

docs/LoggingS3Api.md

@@ -56,6 +56,7 @@ opts = {
     secret_key: 'secret_key_example', # String | The secret key for your S3 account. Not required if `iam_role` is provided.
     server_side_encryption_kms_key_id: 'server_side_encryption_kms_key_id_example', # String | Optional server-side KMS Key Id. Must be set if `server_side_encryption` is set to `aws:kms` or `AES256`.
     server_side_encryption: 'server_side_encryption_example', # String | Set this to `AES256` or `aws:kms` to enable S3 Server Side Encryption.
+    file_max_bytes: 56, # Integer | The maximum number of bytes for each uploaded file. A value of 0 can be used to indicate there is no limit on the size of uploaded files, otherwise the minimum value is 1048576 bytes (1 MiB.)
 }
 
 begin
@@ -94,6 +95,7 @@ end
 | **secret_key** | **String** | The secret key for your S3 account. Not required if `iam_role` is provided. | [optional] |
 | **server_side_encryption_kms_key_id** | **String** | Optional server-side KMS Key Id. Must be set if `server_side_encryption` is set to `aws:kms` or `AES256`. | [optional][default to 'null'] |
 | **server_side_encryption** | **String** | Set this to `AES256` or `aws:kms` to enable S3 Server Side Encryption. | [optional][default to 'null'] |
+| **file_max_bytes** | **Integer** | The maximum number of bytes for each uploaded file. A value of 0 can be used to indicate there is no limit on the size of uploaded files, otherwise the minimum value is 1048576 bytes (1 MiB.) | [optional] |
 
 ### Return type
 
@@ -259,6 +261,7 @@ opts = {
     secret_key: 'secret_key_example', # String | The secret key for your S3 account. Not required if `iam_role` is provided.
     server_side_encryption_kms_key_id: 'server_side_encryption_kms_key_id_example', # String | Optional server-side KMS Key Id. Must be set if `server_side_encryption` is set to `aws:kms` or `AES256`.
     server_side_encryption: 'server_side_encryption_example', # String | Set this to `AES256` or `aws:kms` to enable S3 Server Side Encryption.
+    file_max_bytes: 56, # Integer | The maximum number of bytes for each uploaded file. A value of 0 can be used to indicate there is no limit on the size of uploaded files, otherwise the minimum value is 1048576 bytes (1 MiB.)
 }
 
 begin
@@ -298,6 +301,7 @@ end
 | **secret_key** | **String** | The secret key for your S3 account. Not required if `iam_role` is provided. | [optional] |
 | **server_side_encryption_kms_key_id** | **String** | Optional server-side KMS Key Id. Must be set if `server_side_encryption` is set to `aws:kms` or `AES256`. | [optional][default to 'null'] |
 | **server_side_encryption** | **String** | Set this to `AES256` or `aws:kms` to enable S3 Server Side Encryption. | [optional][default to 'null'] |
+| **file_max_bytes** | **Integer** | The maximum number of bytes for each uploaded file. A value of 0 can be used to indicate there is no limit on the size of uploaded files, otherwise the minimum value is 1048576 bytes (1 MiB.) | [optional] |
 
 ### Return type
 

docs/LoggingS3Response.md

@@ -30,6 +30,7 @@
 | **secret_key** | **String** | The secret key for your S3 account. Not required if `iam_role` is provided. | [optional] |
 | **server_side_encryption_kms_key_id** | **String** | Optional server-side KMS Key Id. Must be set if `server_side_encryption` is set to `aws:kms` or `AES256`. | [optional][default to 'null'] |
 | **server_side_encryption** | **String** | Set this to `AES256` or `aws:kms` to enable S3 Server Side Encryption. | [optional][default to 'null'] |
+| **file_max_bytes** | **Integer** | The maximum number of bytes for each uploaded file. A value of 0 can be used to indicate there is no limit on the size of uploaded files, otherwise the minimum value is 1048576 bytes (1 MiB.) | [optional] |
 
 [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
 

lib/fastly/api/logging_s3_api.rb

@@ -42,6 +42,7 @@ def initialize(api_client = ApiClient.default)
     # @option opts [String] :secret_key The secret key for your S3 account. Not required if `iam_role` is provided.
     # @option opts [String] :server_side_encryption_kms_key_id Optional server-side KMS Key Id. Must be set if `server_side_encryption` is set to `aws:kms` or `AES256`. (default to 'null')
     # @option opts [String] :server_side_encryption Set this to `AES256` or `aws:kms` to enable S3 Server Side Encryption. (default to 'null')
+    # @option opts [Integer] :file_max_bytes The maximum number of bytes for each uploaded file. A value of 0 can be used to indicate there is no limit on the size of uploaded files, otherwise the minimum value is 1048576 bytes (1 MiB.)
     # @return [LoggingS3Response]
     def create_log_aws_s3(opts = {})
       data, _status_code, _headers = create_log_aws_s3_with_http_info(opts)
@@ -73,6 +74,7 @@ def create_log_aws_s3(opts = {})
     # @option opts [String] :secret_key The secret key for your S3 account. Not required if `iam_role` is provided.
     # @option opts [String] :server_side_encryption_kms_key_id Optional server-side KMS Key Id. Must be set if `server_side_encryption` is set to `aws:kms` or `AES256`. (default to 'null')
     # @option opts [String] :server_side_encryption Set this to `AES256` or `aws:kms` to enable S3 Server Side Encryption. (default to 'null')
+    # @option opts [Integer] :file_max_bytes The maximum number of bytes for each uploaded file. A value of 0 can be used to indicate there is no limit on the size of uploaded files, otherwise the minimum value is 1048576 bytes (1 MiB.)
     # @return [Array<(LoggingS3Response, Integer, Hash)>] LoggingS3Response data, response status code and response headers
     def create_log_aws_s3_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -105,6 +107,10 @@ def create_log_aws_s3_with_http_info(opts = {})
       if @api_client.config.client_side_validation && opts[:'compression_codec'] && !allowable_values.include?(opts[:'compression_codec'])
         fail ArgumentError, "invalid value for \"compression_codec\", must be one of #{allowable_values}"
       end
+      if @api_client.config.client_side_validation && !opts[:'file_max_bytes'].nil? && opts[:'file_max_bytes'] < 1048576
+        fail ArgumentError, 'invalid value for "opts[:"file_max_bytes"]" when calling LoggingS3Api.create_log_aws_s3, must be greater than or equal to 1048576.'
+      end
+
       # resource path
       local_var_path = '/service/{service_id}/version/{version_id}/logging/s3'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s))
 
@@ -144,6 +150,7 @@ def create_log_aws_s3_with_http_info(opts = {})
       form_params['secret_key'] = opts[:'secret_key'] if !opts[:'secret_key'].nil?
       form_params['server_side_encryption_kms_key_id'] = opts[:'server_side_encryption_kms_key_id'] if !opts[:'server_side_encryption_kms_key_id'].nil?
       form_params['server_side_encryption'] = opts[:'server_side_encryption'] if !opts[:'server_side_encryption'].nil?
+      form_params['file_max_bytes'] = opts[:'file_max_bytes'] if !opts[:'file_max_bytes'].nil?
 
       # http body (model)
       post_body = opts[:debug_body]
@@ -421,6 +428,7 @@ def list_log_aws_s3_with_http_info(opts = {})
     # @option opts [String] :secret_key The secret key for your S3 account. Not required if &#x60;iam_role&#x60; is provided.
     # @option opts [String] :server_side_encryption_kms_key_id Optional server-side KMS Key Id. Must be set if &#x60;server_side_encryption&#x60; is set to &#x60;aws:kms&#x60; or &#x60;AES256&#x60;. (default to 'null')
     # @option opts [String] :server_side_encryption Set this to &#x60;AES256&#x60; or &#x60;aws:kms&#x60; to enable S3 Server Side Encryption. (default to 'null')
+    # @option opts [Integer] :file_max_bytes The maximum number of bytes for each uploaded file. A value of 0 can be used to indicate there is no limit on the size of uploaded files, otherwise the minimum value is 1048576 bytes (1 MiB.)
     # @return [LoggingS3Response]
     def update_log_aws_s3(opts = {})
       data, _status_code, _headers = update_log_aws_s3_with_http_info(opts)
@@ -453,6 +461,7 @@ def update_log_aws_s3(opts = {})
     # @option opts [String] :secret_key The secret key for your S3 account. Not required if &#x60;iam_role&#x60; is provided.
     # @option opts [String] :server_side_encryption_kms_key_id Optional server-side KMS Key Id. Must be set if &#x60;server_side_encryption&#x60; is set to &#x60;aws:kms&#x60; or &#x60;AES256&#x60;. (default to 'null')
     # @option opts [String] :server_side_encryption Set this to &#x60;AES256&#x60; or &#x60;aws:kms&#x60; to enable S3 Server Side Encryption. (default to 'null')
+    # @option opts [Integer] :file_max_bytes The maximum number of bytes for each uploaded file. A value of 0 can be used to indicate there is no limit on the size of uploaded files, otherwise the minimum value is 1048576 bytes (1 MiB.)
     # @return [Array<(LoggingS3Response, Integer, Hash)>] LoggingS3Response data, response status code and response headers
     def update_log_aws_s3_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -490,6 +499,10 @@ def update_log_aws_s3_with_http_info(opts = {})
       if @api_client.config.client_side_validation && opts[:'compression_codec'] && !allowable_values.include?(opts[:'compression_codec'])
         fail ArgumentError, "invalid value for \"compression_codec\", must be one of #{allowable_values}"
       end
+      if @api_client.config.client_side_validation && !opts[:'file_max_bytes'].nil? && opts[:'file_max_bytes'] < 1048576
+        fail ArgumentError, 'invalid value for "opts[:"file_max_bytes"]" when calling LoggingS3Api.update_log_aws_s3, must be greater than or equal to 1048576.'
+      end
+
       # resource path
       local_var_path = '/service/{service_id}/version/{version_id}/logging/s3/{logging_s3_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'logging_s3_name' + '}', CGI.escape(logging_s3_name.to_s))
 
@@ -529,6 +542,7 @@ def update_log_aws_s3_with_http_info(opts = {})
       form_params['secret_key'] = opts[:'secret_key'] if !opts[:'secret_key'].nil?
       form_params['server_side_encryption_kms_key_id'] = opts[:'server_side_encryption_kms_key_id'] if !opts[:'server_side_encryption_kms_key_id'].nil?
       form_params['server_side_encryption'] = opts[:'server_side_encryption'] if !opts[:'server_side_encryption'].nil?
+      form_params['file_max_bytes'] = opts[:'file_max_bytes'] if !opts[:'file_max_bytes'].nil?
 
       # http body (model)
       post_body = opts[:debug_body]

lib/fastly/models/invoicelineitems.rb

@@ -34,6 +34,9 @@ class Invoicelineitems
     # The broader classification of the product (e.g., `Compute` or `Full-Site Delivery`).
     attr_accessor :product_group
 
+    # The broader classification of the product (e.g., `Network Services` or `Security`).
+    attr_accessor :product_line
+
     # The geographical area applicable for regionally based products.
     attr_accessor :region
 
@@ -50,6 +53,7 @@ def self.attribute_map
         :'units' => :'units',
         :'product_name' => :'ProductName',
         :'product_group' => :'ProductGroup',
+        :'product_line' => :'ProductLine',
         :'region' => :'Region',
         :'usage_type' => :'UsageType'
       }
@@ -70,6 +74,7 @@ def self.fastly_types
         :'units' => :'Float',
         :'product_name' => :'String',
         :'product_group' => :'String',
+        :'product_line' => :'String',
         :'region' => :'String',
         :'usage_type' => :'String'
       }
@@ -124,6 +129,10 @@ def initialize(attributes = {})
         self.product_group = attributes[:'product_group']
       end
 
+      if attributes.key?(:'product_line')
+        self.product_line = attributes[:'product_line']
+      end
+
       if attributes.key?(:'region')
         self.region = attributes[:'region']
       end
@@ -158,6 +167,7 @@ def ==(o)
           units == o.units &&
           product_name == o.product_name &&
           product_group == o.product_group &&
+          product_line == o.product_line &&
           region == o.region &&
           usage_type == o.usage_type
     end
@@ -171,7 +181,7 @@ def eql?(o)
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [description, amount, credit_coupon_code, rate, units, product_name, product_group, region, usage_type].hash
+      [description, amount, credit_coupon_code, rate, units, product_name, product_group, product_line, region, usage_type].hash
     end
 
     # Builds the object from hash