Generated v5.4.0

CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## [v5.4.0](https://github.com/fastly/fastly-py/releases/tag/release/v5.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
+
 ## [v5.3.0](https://github.com/fastly/fastly-py/releases/tag/release/v5.3.0) (2024-05-24)
 
 **Bug fixes:**

README.md

@@ -616,6 +616,8 @@ The fastly-py 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

@@ -130,8 +130,8 @@ configuration.api_key['token'] = 'YOUR_API_KEY'
 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)
+    billing_start_date = "2023-01-01" # str |  (optional)
+    billing_end_date = "2023-01-31" # 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)
 

docs/Invoicelineitems.md

@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **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] 
+**product_line** | **str** | The broader classification of the product (e.g., `Network Services` or `Security`). | [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]

docs/LoggingS3Additional.md

@@ -15,6 +15,7 @@ Name | Type | Description | Notes
 **secret_key** | **str, none_type** | The secret key for your S3 account. Not required if `iam_role` is provided. | [optional] 
 **server_side_encryption_kms_key_id** | **str, none_type** | Optional server-side KMS Key Id. Must be set if `server_side_encryption` is set to `aws:kms` or `AES256`. | [optional]  if omitted the server will use the default value of "null"
 **server_side_encryption** | **str, none_type** | Set this to `AES256` or `aws:kms` to enable S3 Server Side Encryption. | [optional]  if omitted the server will use the default value of "null"
+**file_max_bytes** | **int** | 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] 
 **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/LoggingS3Api.md

@@ -76,6 +76,7 @@ with fastly.ApiClient(configuration) as api_client:
     secret_key = "secret_key_example" # str, none_type | The secret key for your S3 account. Not required if `iam_role` is provided. (optional)
     server_side_encryption_kms_key_id = "null" # str, none_type | Optional server-side KMS Key Id. Must be set if `server_side_encryption` is set to `aws:kms` or `AES256`. (optional) if omitted the server will use the default value of "null"
     server_side_encryption = "null" # str, none_type | Set this to `AES256` or `aws:kms` to enable S3 Server Side Encryption. (optional) if omitted the server will use the default value of "null"
+    file_max_bytes = 1048576 # int | 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)
 
     # example passing only required values which don't have defaults set
     try:
@@ -89,7 +90,7 @@ with fastly.ApiClient(configuration) as api_client:
     # and optional values
     try:
         # Create an AWS S3 log endpoint
-        api_response = api_instance.create_log_aws_s3(service_id, version_id, name=name, placement=placement, response_condition=response_condition, format=format, format_version=format_version, message_type=message_type, timestamp_format=timestamp_format, compression_codec=compression_codec, period=period, gzip_level=gzip_level, access_key=access_key, acl=acl, bucket_name=bucket_name, domain=domain, iam_role=iam_role, path=path, public_key=public_key, redundancy=redundancy, secret_key=secret_key, server_side_encryption_kms_key_id=server_side_encryption_kms_key_id, server_side_encryption=server_side_encryption)
+        api_response = api_instance.create_log_aws_s3(service_id, version_id, name=name, placement=placement, response_condition=response_condition, format=format, format_version=format_version, message_type=message_type, timestamp_format=timestamp_format, compression_codec=compression_codec, period=period, gzip_level=gzip_level, access_key=access_key, acl=acl, bucket_name=bucket_name, domain=domain, iam_role=iam_role, path=path, public_key=public_key, redundancy=redundancy, secret_key=secret_key, server_side_encryption_kms_key_id=server_side_encryption_kms_key_id, server_side_encryption=server_side_encryption, file_max_bytes=file_max_bytes)
         pprint(api_response)
     except fastly.ApiException as e:
         print("Exception when calling LoggingS3Api->create_log_aws_s3: %s\n" % e)
@@ -123,6 +124,7 @@ Name | Type | Description  | Notes
  **secret_key** | **str, none_type**| The secret key for your S3 account. Not required if `iam_role` is provided. | [optional]
  **server_side_encryption_kms_key_id** | **str, none_type**| Optional server-side KMS Key Id. Must be set if `server_side_encryption` is set to `aws:kms` or `AES256`. | [optional] if omitted the server will use the default value of "null"
  **server_side_encryption** | **str, none_type**| Set this to `AES256` or `aws:kms` to enable S3 Server Side Encryption. | [optional] if omitted the server will use the default value of "null"
+ **file_max_bytes** | **int**| 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
 
@@ -455,6 +457,7 @@ with fastly.ApiClient(configuration) as api_client:
     secret_key = "secret_key_example" # str, none_type | The secret key for your S3 account. Not required if `iam_role` is provided. (optional)
     server_side_encryption_kms_key_id = "null" # str, none_type | Optional server-side KMS Key Id. Must be set if `server_side_encryption` is set to `aws:kms` or `AES256`. (optional) if omitted the server will use the default value of "null"
     server_side_encryption = "null" # str, none_type | Set this to `AES256` or `aws:kms` to enable S3 Server Side Encryption. (optional) if omitted the server will use the default value of "null"
+    file_max_bytes = 1048576 # int | 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)
 
     # example passing only required values which don't have defaults set
     try:
@@ -468,7 +471,7 @@ with fastly.ApiClient(configuration) as api_client:
     # and optional values
     try:
         # Update an AWS S3 log endpoint
-        api_response = api_instance.update_log_aws_s3(service_id, version_id, logging_s3_name, name=name, placement=placement, response_condition=response_condition, format=format, format_version=format_version, message_type=message_type, timestamp_format=timestamp_format, compression_codec=compression_codec, period=period, gzip_level=gzip_level, access_key=access_key, acl=acl, bucket_name=bucket_name, domain=domain, iam_role=iam_role, path=path, public_key=public_key, redundancy=redundancy, secret_key=secret_key, server_side_encryption_kms_key_id=server_side_encryption_kms_key_id, server_side_encryption=server_side_encryption)
+        api_response = api_instance.update_log_aws_s3(service_id, version_id, logging_s3_name, name=name, placement=placement, response_condition=response_condition, format=format, format_version=format_version, message_type=message_type, timestamp_format=timestamp_format, compression_codec=compression_codec, period=period, gzip_level=gzip_level, access_key=access_key, acl=acl, bucket_name=bucket_name, domain=domain, iam_role=iam_role, path=path, public_key=public_key, redundancy=redundancy, secret_key=secret_key, server_side_encryption_kms_key_id=server_side_encryption_kms_key_id, server_side_encryption=server_side_encryption, file_max_bytes=file_max_bytes)
         pprint(api_response)
     except fastly.ApiException as e:
         print("Exception when calling LoggingS3Api->update_log_aws_s3: %s\n" % e)
@@ -503,6 +506,7 @@ Name | Type | Description  | Notes
  **secret_key** | **str, none_type**| The secret key for your S3 account. Not required if `iam_role` is provided. | [optional]
  **server_side_encryption_kms_key_id** | **str, none_type**| Optional server-side KMS Key Id. Must be set if `server_side_encryption` is set to `aws:kms` or `AES256`. | [optional] if omitted the server will use the default value of "null"
  **server_side_encryption** | **str, none_type**| Set this to `AES256` or `aws:kms` to enable S3 Server Side Encryption. | [optional] if omitted the server will use the default value of "null"
+ **file_max_bytes** | **int**| 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 @@ Name | Type | Description | Notes
 **secret_key** | **str, none_type** | The secret key for your S3 account. Not required if `iam_role` is provided. | [optional] 
 **server_side_encryption_kms_key_id** | **str, none_type** | Optional server-side KMS Key Id. Must be set if `server_side_encryption` is set to `aws:kms` or `AES256`. | [optional]  if omitted the server will use the default value of "null"
 **server_side_encryption** | **str, none_type** | Set this to `AES256` or `aws:kms` to enable S3 Server Side Encryption. | [optional]  if omitted the server will use the default value of "null"
+**file_max_bytes** | **int** | 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] 
 **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)

fastly/__init__.py

@@ -10,7 +10,7 @@
 """
 
 
-__version__ = "5.3.0"
+__version__ = "5.4.0"
 
 # import ApiClient
 from fastly.api_client import ApiClient

fastly/api/logging_s3_api.py

@@ -75,6 +75,7 @@ def __init__(self, api_client=None):
                     'secret_key',
                     'server_side_encryption_kms_key_id',
                     'server_side_encryption',
+                    'file_max_bytes',
                 ],
                 'required': [
                     'service_id',
@@ -100,10 +101,15 @@ def __init__(self, api_client=None):
                     'compression_codec',
                 ],
                 'validation': [
+                    'file_max_bytes',
                 ]
             },
             root_map={
                 'validations': {
+                    ('file_max_bytes',): {
+
+                        'inclusive_minimum': 1048576,
+                    },
                 },
                 'allowed_values': {
                     ('placement',): {
@@ -178,6 +184,8 @@ def __init__(self, api_client=None):
                         (str, none_type,),
                     'server_side_encryption':
                         (str, none_type,),
+                    'file_max_bytes':
+                        (int,),
                 },
                 'attribute_map': {
                     'service_id': 'service_id',
@@ -203,6 +211,7 @@ def __init__(self, api_client=None):
                     'secret_key': 'secret_key',
                     'server_side_encryption_kms_key_id': 'server_side_encryption_kms_key_id',
                     'server_side_encryption': 'server_side_encryption',
+                    'file_max_bytes': 'file_max_bytes',
                 },
                 'location_map': {
                     'service_id': 'path',
@@ -228,6 +237,7 @@ def __init__(self, api_client=None):
                     'secret_key': 'form',
                     'server_side_encryption_kms_key_id': 'form',
                     'server_side_encryption': 'form',
+                    'file_max_bytes': 'form',
                 },
                 'path_params_allow_reserved_map': {
                 },
@@ -490,6 +500,7 @@ def __init__(self, api_client=None):
                     'secret_key',
                     'server_side_encryption_kms_key_id',
                     'server_side_encryption',
+                    'file_max_bytes',
                 ],
                 'required': [
                     'service_id',
@@ -516,10 +527,15 @@ def __init__(self, api_client=None):
                     'compression_codec',
                 ],
                 'validation': [
+                    'file_max_bytes',
                 ]
             },
             root_map={
                 'validations': {
+                    ('file_max_bytes',): {
+
+                        'inclusive_minimum': 1048576,
+                    },
                 },
                 'allowed_values': {
                     ('placement',): {
@@ -596,6 +612,8 @@ def __init__(self, api_client=None):
                         (str, none_type,),
                     'server_side_encryption':
                         (str, none_type,),
+                    'file_max_bytes':
+                        (int,),
                 },
                 'attribute_map': {
                     'service_id': 'service_id',
@@ -622,6 +640,7 @@ def __init__(self, api_client=None):
                     'secret_key': 'secret_key',
                     'server_side_encryption_kms_key_id': 'server_side_encryption_kms_key_id',
                     'server_side_encryption': 'server_side_encryption',
+                    'file_max_bytes': 'file_max_bytes',
                 },
                 'location_map': {
                     'service_id': 'path',
@@ -648,6 +667,7 @@ def __init__(self, api_client=None):
                     'secret_key': 'form',
                     'server_side_encryption_kms_key_id': 'form',
                     'server_side_encryption': 'form',
+                    'file_max_bytes': 'form',
                 },
                 'path_params_allow_reserved_map': {
                 },
@@ -706,6 +726,7 @@ def create_log_aws_s3(
             secret_key (str, none_type): The secret key for your S3 account. Not required if `iam_role` is provided.. [optional]
             server_side_encryption_kms_key_id (str, none_type): Optional server-side KMS Key Id. Must be set if `server_side_encryption` is set to `aws:kms` or `AES256`.. [optional] if omitted the server will use the default value of "null"
             server_side_encryption (str, none_type): Set this to `AES256` or `aws:kms` to enable S3 Server Side Encryption.. [optional] if omitted the server will use the default value of "null"
+            file_max_bytes (int): 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_http_data_only (bool): response data without head status
                 code and headers. Default is True.
             _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -1065,6 +1086,7 @@ def update_log_aws_s3(
             secret_key (str, none_type): The secret key for your S3 account. Not required if `iam_role` is provided.. [optional]
             server_side_encryption_kms_key_id (str, none_type): Optional server-side KMS Key Id. Must be set if `server_side_encryption` is set to `aws:kms` or `AES256`.. [optional] if omitted the server will use the default value of "null"
             server_side_encryption (str, none_type): Set this to `AES256` or `aws:kms` to enable S3 Server Side Encryption.. [optional] if omitted the server will use the default value of "null"
+            file_max_bytes (int): 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_http_data_only (bool): response data without head status
                 code and headers. Default is True.
             _preload_content (bool): if False, the urllib3.HTTPResponse object

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.3.0'
+        self.user_agent = 'fastly-py/5.4.0'
 
         # The last observed value of http header Fastly-RateLimit-Remaining
         self.rate_limit_remaining = DEFAULT_RATELIMIT