svix 0.84.0 → 0.84.1

data/lib/svix/api/message_attempt_api.rb

@@ -3,7 +3,7 @@
 
 #Welcome to the Svix API documentation!  Useful links: [Homepage](https://www.svix.com) | [Support email](mailto:support+docs@svix.com) | [Blog](https://www.svix.com/blog/) | [Slack Community](https://www.svix.com/slack/)  # Introduction  This is the reference documentation and schemas for the [Svix webhook service](https://www.svix.com) API. For tutorials and other documentation please refer to [the documentation](https://docs.svix.com).  ## Main concepts  In Svix you have four important entities you will be interacting with:  - `messages`: these are the webhooks being sent. They can have contents and a few other properties. - `application`: this is where `messages` are sent to. Usually you want to create one application for each user on your platform. - `endpoint`: endpoints are the URLs messages will be sent to. Each application can have multiple `endpoints` and each message sent to that application will be sent to all of them (unless they are not subscribed to the sent event type). - `event-type`: event types are identifiers denoting the type of the message being sent. Event types are primarily used to decide which events are sent to which endpoint.   ## Authentication  Get your authentication token (`AUTH_TOKEN`) from the [Svix dashboard](https://dashboard.svix.com) and use it as part of the `Authorization` header as such: `Authorization: Bearer ${AUTH_TOKEN}`.  <SecurityDefinitions />   ## Code samples  The code samples assume you already have the respective libraries installed and you know how to use them. For the latest information on how to do that, please refer to [the documentation](https://docs.svix.com/).   ## Idempotency  Svix supports [idempotency](https://en.wikipedia.org/wiki/Idempotence) for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response.  To perform an idempotent request, pass the idempotency key in the `Idempotency-Key` header to the request. The idempotency key should be a unique value generated by the client. You can create the key in however way you like, though we suggest using UUID v4, or any other string with enough entropy to avoid collisions.  Svix's idempotency works by saving the resulting status code and body of the first request made for any given idempotency key for any successful request. Subsequent requests with the same key return the same result.  Please note that idempotency is only supported for `POST` requests.   ## Cross-Origin Resource Sharing  This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site. 
 
-The version of the OpenAPI document: 1.4
+The version of the OpenAPI document: 1.4.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.0
@@ -19,11 +19,11 @@ module Svix
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Expunge Attempt Content
+    # Delete attempt response body
     # Deletes the given attempt's response body. Useful when an endpoint accidentally returned sensitive content.
-    # @param app_id [String] 
-    # @param msg_id [String] 
-    # @param attempt_id [String] 
+    # @param app_id [String] The app&#39;s ID or UID
+    # @param msg_id [String] The msg&#39;s ID or UID
+    # @param attempt_id [String] The attempt&#39;s ID
     # @param [Hash] opts the optional parameters
     # @return [nil]
     def v1_message_attempt_expunge_content(app_id, msg_id, attempt_id, opts = {})
@@ -31,11 +31,11 @@ module Svix
       nil
     end
 
-    # Expunge Attempt Content
+    # Delete attempt response body
     # Deletes the given attempt&#39;s response body. Useful when an endpoint accidentally returned sensitive content.
-    # @param app_id [String] 
-    # @param msg_id [String] 
-    # @param attempt_id [String] 
+    # @param app_id [String] The app&#39;s ID or UID
+    # @param msg_id [String] The msg&#39;s ID or UID
+    # @param attempt_id [String] The attempt&#39;s ID
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def v1_message_attempt_expunge_content_with_http_info(app_id, msg_id, attempt_id, opts = {})
@@ -101,7 +101,7 @@ module Svix
       return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || []
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
 
       new_options = opts.merge(
         :operation => :"MessageAttemptApi.v1_message_attempt_expunge_content",
@@ -120,11 +120,11 @@ module Svix
       return data, status_code, headers
     end
 
-    # Get Messageattempt
+    # Get Attempt
     # `msg_id`: Use a message id or a message `eventId`
-    # @param app_id [String] 
-    # @param msg_id [String] 
-    # @param attempt_id [String] 
+    # @param app_id [String] The app&#39;s ID or UID
+    # @param msg_id [String] The msg&#39;s ID or UID
+    # @param attempt_id [String] The attempt&#39;s ID
     # @param [Hash] opts the optional parameters
     # @return [MessageAttemptOut]
     def v1_message_attempt_get(app_id, msg_id, attempt_id, opts = {})
@@ -132,11 +132,11 @@ module Svix
       data
     end
 
-    # Get Messageattempt
+    # Get Attempt
     # &#x60;msg_id&#x60;: Use a message id or a message &#x60;eventId&#x60;
-    # @param app_id [String] 
-    # @param msg_id [String] 
-    # @param attempt_id [String] 
+    # @param app_id [String] The app&#39;s ID or UID
+    # @param msg_id [String] The msg&#39;s ID or UID
+    # @param attempt_id [String] The attempt&#39;s ID
     # @param [Hash] opts the optional parameters
     # @return [Array<(MessageAttemptOut, Integer, Hash)>] MessageAttemptOut data, response status code and response headers
     def v1_message_attempt_get_with_http_info(app_id, msg_id, attempt_id, opts = {})
@@ -202,7 +202,7 @@ module Svix
       return_type = opts[:debug_return_type] || 'MessageAttemptOut'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || []
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
 
       new_options = opts.merge(
         :operation => :"MessageAttemptApi.v1_message_attempt_get",
@@ -223,9 +223,9 @@ module Svix
 
     # Get Attempt Headers
     # Calculate and return headers used on a given message attempt
-    # @param app_id [String] 
-    # @param msg_id [String] 
-    # @param attempt_id [String] 
+    # @param app_id [String] The app&#39;s ID or UID
+    # @param msg_id [String] The msg&#39;s ID or UID
+    # @param attempt_id [String] The attempt&#39;s ID
     # @param [Hash] opts the optional parameters
     # @return [MessageAttemptHeadersOut]
     def v1_message_attempt_get_headers(app_id, msg_id, attempt_id, opts = {})
@@ -235,9 +235,9 @@ module Svix
 
     # Get Attempt Headers
     # Calculate and return headers used on a given message attempt
-    # @param app_id [String] 
-    # @param msg_id [String] 
-    # @param attempt_id [String] 
+    # @param app_id [String] The app&#39;s ID or UID
+    # @param msg_id [String] The msg&#39;s ID or UID
+    # @param attempt_id [String] The attempt&#39;s ID
     # @param [Hash] opts the optional parameters
     # @return [Array<(MessageAttemptHeadersOut, Integer, Hash)>] MessageAttemptHeadersOut data, response status code and response headers
     def v1_message_attempt_get_headers_with_http_info(app_id, msg_id, attempt_id, opts = {})
@@ -303,7 +303,7 @@ module Svix
       return_type = opts[:debug_return_type] || 'MessageAttemptHeadersOut'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || []
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
 
       new_options = opts.merge(
         :operation => :"MessageAttemptApi.v1_message_attempt_get_headers",
@@ -324,8 +324,8 @@ module Svix
 
     # List Attempted Destinations
     # `msg_id`: Use a message id or a message `eventId`
-    # @param app_id [String] 
-    # @param msg_id [String] 
+    # @param app_id [String] The app&#39;s ID or UID
+    # @param msg_id [String] The msg&#39;s ID or UID
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit 
     # @option opts [String] :iterator 
@@ -337,8 +337,8 @@ module Svix
 
     # List Attempted Destinations
     # &#x60;msg_id&#x60;: Use a message id or a message &#x60;eventId&#x60;
-    # @param app_id [String] 
-    # @param msg_id [String] 
+    # @param app_id [String] The app&#39;s ID or UID
+    # @param msg_id [String] The msg&#39;s ID or UID
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit 
     # @option opts [String] :iterator 
@@ -381,8 +381,12 @@ module Svix
         fail ArgumentError, "invalid value for 'msg_id' when calling MessageAttemptApi.v1_message_attempt_list_attempted_destinations, must conform to the pattern #{pattern}."
       end
 
-      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
-        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MessageAttemptApi.v1_message_attempt_list_attempted_destinations, must be greater than or equal to 0.'
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 250
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MessageAttemptApi.v1_message_attempt_list_attempted_destinations, must be smaller than or equal to 250.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MessageAttemptApi.v1_message_attempt_list_attempted_destinations, must be greater than or equal to 1.'
       end
 
       # resource path
@@ -408,7 +412,7 @@ module Svix
       return_type = opts[:debug_return_type] || 'ListResponseMessageEndpointOut'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || []
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
 
       new_options = opts.merge(
         :operation => :"MessageAttemptApi.v1_message_attempt_list_attempted_destinations",
@@ -429,11 +433,11 @@ module Svix
 
     # List Attempted Messages
     # List messages for a particular endpoint. Additionally includes metadata about the latest message attempt.  The `before` parameter lets you filter all items created before a certain date and is ignored if an iterator is passed.
-    # @param app_id [String] 
-    # @param endpoint_id [String] 
+    # @param app_id [String] The app&#39;s ID or UID
+    # @param endpoint_id [String] The ep&#39;s ID or UID
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit 
-    # @option opts [String] :iterator 
+    # @option opts [String] :iterator The msg&#39;s ID
     # @option opts [String] :channel 
     # @option opts [MessageStatus] :status 
     # @option opts [Time] :before 
@@ -446,11 +450,11 @@ module Svix
 
     # List Attempted Messages
     # List messages for a particular endpoint. Additionally includes metadata about the latest message attempt.  The &#x60;before&#x60; parameter lets you filter all items created before a certain date and is ignored if an iterator is passed.
-    # @param app_id [String] 
-    # @param endpoint_id [String] 
+    # @param app_id [String] The app&#39;s ID or UID
+    # @param endpoint_id [String] The ep&#39;s ID or UID
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit 
-    # @option opts [String] :iterator 
+    # @option opts [String] :iterator The msg&#39;s ID
     # @option opts [String] :channel 
     # @option opts [MessageStatus] :status 
     # @option opts [Time] :before 
@@ -494,8 +498,12 @@ module Svix
         fail ArgumentError, "invalid value for 'endpoint_id' when calling MessageAttemptApi.v1_message_attempt_list_attempted_messages, must conform to the pattern #{pattern}."
       end
 
-      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
-        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MessageAttemptApi.v1_message_attempt_list_attempted_messages, must be greater than or equal to 0.'
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 250
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MessageAttemptApi.v1_message_attempt_list_attempted_messages, must be smaller than or equal to 250.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MessageAttemptApi.v1_message_attempt_list_attempted_messages, must be greater than or equal to 1.'
       end
 
       if @api_client.config.client_side_validation && !opts[:'channel'].nil? && opts[:'channel'].to_s.length > 128
@@ -534,7 +542,7 @@ module Svix
       return_type = opts[:debug_return_type] || 'ListResponseEndpointMessageOut'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || []
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
 
       new_options = opts.merge(
         :operation => :"MessageAttemptApi.v1_message_attempt_list_attempted_messages",
@@ -555,11 +563,11 @@ module Svix
 
     # List Attempts By Endpoint
     # List attempts by endpoint id
-    # @param app_id [String] 
-    # @param endpoint_id [String] 
+    # @param app_id [String] The app&#39;s ID or UID
+    # @param endpoint_id [String] The ep&#39;s ID or UID
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit 
-    # @option opts [String] :iterator 
+    # @option opts [String] :iterator The attempt&#39;s ID
     # @option opts [MessageStatus] :status 
     # @option opts [StatusCodeClass] :status_code_class 
     # @option opts [String] :channel 
@@ -574,11 +582,11 @@ module Svix
 
     # List Attempts By Endpoint
     # List attempts by endpoint id
-    # @param app_id [String] 
-    # @param endpoint_id [String] 
+    # @param app_id [String] The app&#39;s ID or UID
+    # @param endpoint_id [String] The ep&#39;s ID or UID
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit 
-    # @option opts [String] :iterator 
+    # @option opts [String] :iterator The attempt&#39;s ID
     # @option opts [MessageStatus] :status 
     # @option opts [StatusCodeClass] :status_code_class 
     # @option opts [String] :channel 
@@ -624,8 +632,12 @@ module Svix
         fail ArgumentError, "invalid value for 'endpoint_id' when calling MessageAttemptApi.v1_message_attempt_list_by_endpoint, must conform to the pattern #{pattern}."
       end
 
-      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
-        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MessageAttemptApi.v1_message_attempt_list_by_endpoint, must be greater than or equal to 0.'
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 250
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MessageAttemptApi.v1_message_attempt_list_by_endpoint, must be smaller than or equal to 250.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MessageAttemptApi.v1_message_attempt_list_by_endpoint, must be greater than or equal to 1.'
       end
 
       if @api_client.config.client_side_validation && !opts[:'channel'].nil? && opts[:'channel'].to_s.length > 128
@@ -666,7 +678,7 @@ module Svix
       return_type = opts[:debug_return_type] || 'ListResponseMessageAttemptOut'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || []
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
 
       new_options = opts.merge(
         :operation => :"MessageAttemptApi.v1_message_attempt_list_by_endpoint",
@@ -687,12 +699,12 @@ module Svix
 
     # List Attempts For Endpoint
     # DEPRECATED: please use list_attempts with endpoint_id as a query parameter instead.  List the message attempts for a particular endpoint.  Returning the endpoint.  The `before` parameter lets you filter all items created before a certain date and is ignored if an iterator is passed.
-    # @param app_id [String] 
-    # @param msg_id [String] 
-    # @param endpoint_id [String] 
+    # @param app_id [String] The app&#39;s ID or UID
+    # @param msg_id [String] The msg&#39;s ID or UID
+    # @param endpoint_id [String] The ep&#39;s ID or UID
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit 
-    # @option opts [String] :iterator 
+    # @option opts [String] :iterator The attempt&#39;s ID
     # @option opts [String] :channel 
     # @option opts [MessageStatus] :status 
     # @option opts [Time] :before 
@@ -706,12 +718,12 @@ module Svix
 
     # List Attempts For Endpoint
     # DEPRECATED: please use list_attempts with endpoint_id as a query parameter instead.  List the message attempts for a particular endpoint.  Returning the endpoint.  The &#x60;before&#x60; parameter lets you filter all items created before a certain date and is ignored if an iterator is passed.
-    # @param app_id [String] 
-    # @param msg_id [String] 
-    # @param endpoint_id [String] 
+    # @param app_id [String] The app&#39;s ID or UID
+    # @param msg_id [String] The msg&#39;s ID or UID
+    # @param endpoint_id [String] The ep&#39;s ID or UID
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit 
-    # @option opts [String] :iterator 
+    # @option opts [String] :iterator The attempt&#39;s ID
     # @option opts [String] :channel 
     # @option opts [MessageStatus] :status 
     # @option opts [Time] :before 
@@ -773,8 +785,12 @@ module Svix
         fail ArgumentError, "invalid value for 'endpoint_id' when calling MessageAttemptApi.v1_message_attempt_list_by_endpoint_deprecated, must conform to the pattern #{pattern}."
       end
 
-      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
-        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MessageAttemptApi.v1_message_attempt_list_by_endpoint_deprecated, must be greater than or equal to 0.'
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 250
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MessageAttemptApi.v1_message_attempt_list_by_endpoint_deprecated, must be smaller than or equal to 250.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MessageAttemptApi.v1_message_attempt_list_by_endpoint_deprecated, must be greater than or equal to 1.'
       end
 
       if @api_client.config.client_side_validation && !opts[:'channel'].nil? && opts[:'channel'].to_s.length > 128
@@ -814,7 +830,7 @@ module Svix
       return_type = opts[:debug_return_type] || 'ListResponseMessageAttemptEndpointOut'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || []
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
 
       new_options = opts.merge(
         :operation => :"MessageAttemptApi.v1_message_attempt_list_by_endpoint_deprecated",
@@ -835,15 +851,15 @@ module Svix
 
     # List Attempts By Msg
     # List attempts by message id
-    # @param app_id [String] 
-    # @param msg_id [String] 
+    # @param app_id [String] The app&#39;s ID or UID
+    # @param msg_id [String] The msg&#39;s ID or UID
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit 
-    # @option opts [String] :iterator 
+    # @option opts [String] :iterator The attempt&#39;s ID
     # @option opts [MessageStatus] :status 
     # @option opts [StatusCodeClass] :status_code_class 
     # @option opts [String] :channel 
-    # @option opts [String] :endpoint_id 
+    # @option opts [String] :endpoint_id The ep&#39;s ID or UID
     # @option opts [Time] :before 
     # @option opts [Time] :after 
     # @option opts [Array<String>] :event_types 
@@ -855,15 +871,15 @@ module Svix
 
     # List Attempts By Msg
     # List attempts by message id
-    # @param app_id [String] 
-    # @param msg_id [String] 
+    # @param app_id [String] The app&#39;s ID or UID
+    # @param msg_id [String] The msg&#39;s ID or UID
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit 
-    # @option opts [String] :iterator 
+    # @option opts [String] :iterator The attempt&#39;s ID
     # @option opts [MessageStatus] :status 
     # @option opts [StatusCodeClass] :status_code_class 
     # @option opts [String] :channel 
-    # @option opts [String] :endpoint_id 
+    # @option opts [String] :endpoint_id The ep&#39;s ID or UID
     # @option opts [Time] :before 
     # @option opts [Time] :after 
     # @option opts [Array<String>] :event_types 
@@ -906,8 +922,12 @@ module Svix
         fail ArgumentError, "invalid value for 'msg_id' when calling MessageAttemptApi.v1_message_attempt_list_by_msg, must conform to the pattern #{pattern}."
       end
 
-      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
-        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MessageAttemptApi.v1_message_attempt_list_by_msg, must be greater than or equal to 0.'
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 250
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MessageAttemptApi.v1_message_attempt_list_by_msg, must be smaller than or equal to 250.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MessageAttemptApi.v1_message_attempt_list_by_msg, must be greater than or equal to 1.'
       end
 
       if @api_client.config.client_side_validation && !opts[:'channel'].nil? && opts[:'channel'].to_s.length > 128
@@ -962,7 +982,7 @@ module Svix
       return_type = opts[:debug_return_type] || 'ListResponseMessageAttemptOut'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || []
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
 
       new_options = opts.merge(
         :operation => :"MessageAttemptApi.v1_message_attempt_list_by_msg",
@@ -981,14 +1001,14 @@ module Svix
       return data, status_code, headers
     end
 
-    # List Messageattempts
+    # List Attempts
     # Deprecated: Please use \"List Attempts by Endpoint\" and \"List Attempts by Msg\" instead.  `msg_id`: Use a message id or a message `eventId`
-    # @param app_id [String] 
-    # @param msg_id [String] 
+    # @param app_id [String] The app&#39;s ID or UID
+    # @param msg_id [String] The msg&#39;s ID or UID
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit 
-    # @option opts [String] :iterator 
-    # @option opts [String] :endpoint_id 
+    # @option opts [String] :iterator The attempt&#39;s ID
+    # @option opts [String] :endpoint_id The ep&#39;s ID or UID
     # @option opts [String] :channel 
     # @option opts [MessageStatus] :status 
     # @option opts [Time] :before 
@@ -1001,14 +1021,14 @@ module Svix
       data
     end
 
-    # List Messageattempts
+    # List Attempts
     # Deprecated: Please use \&quot;List Attempts by Endpoint\&quot; and \&quot;List Attempts by Msg\&quot; instead.  &#x60;msg_id&#x60;: Use a message id or a message &#x60;eventId&#x60;
-    # @param app_id [String] 
-    # @param msg_id [String] 
+    # @param app_id [String] The app&#39;s ID or UID
+    # @param msg_id [String] The msg&#39;s ID or UID
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit 
-    # @option opts [String] :iterator 
-    # @option opts [String] :endpoint_id 
+    # @option opts [String] :iterator The attempt&#39;s ID
+    # @option opts [String] :endpoint_id The ep&#39;s ID or UID
     # @option opts [String] :channel 
     # @option opts [MessageStatus] :status 
     # @option opts [Time] :before 
@@ -1054,8 +1074,12 @@ module Svix
         fail ArgumentError, "invalid value for 'msg_id' when calling MessageAttemptApi.v1_message_attempt_list_by_msg_deprecated, must conform to the pattern #{pattern}."
       end
 
-      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
-        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MessageAttemptApi.v1_message_attempt_list_by_msg_deprecated, must be greater than or equal to 0.'
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 250
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MessageAttemptApi.v1_message_attempt_list_by_msg_deprecated, must be smaller than or equal to 250.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MessageAttemptApi.v1_message_attempt_list_by_msg_deprecated, must be greater than or equal to 1.'
       end
 
       if @api_client.config.client_side_validation && !opts[:'endpoint_id'].nil? && opts[:'endpoint_id'].to_s.length > 256
@@ -1110,7 +1134,7 @@ module Svix
       return_type = opts[:debug_return_type] || 'ListResponseMessageAttemptOut'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || []
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
 
       new_options = opts.merge(
         :operation => :"MessageAttemptApi.v1_message_attempt_list_by_msg_deprecated",
@@ -1131,9 +1155,9 @@ module Svix
 
     # Resend Webhook
     # Resend a message to the specified endpoint.
-    # @param app_id [String] 
-    # @param msg_id [String] 
-    # @param endpoint_id [String] 
+    # @param app_id [String] The app&#39;s ID or UID
+    # @param msg_id [String] The msg&#39;s ID or UID
+    # @param endpoint_id [String] The ep&#39;s ID or UID
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request&#39;s idempotency key
     # @return [nil]
@@ -1144,9 +1168,9 @@ module Svix
 
     # Resend Webhook
     # Resend a message to the specified endpoint.
-    # @param app_id [String] 
-    # @param msg_id [String] 
-    # @param endpoint_id [String] 
+    # @param app_id [String] The app&#39;s ID or UID
+    # @param msg_id [String] The msg&#39;s ID or UID
+    # @param endpoint_id [String] The ep&#39;s ID or UID
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request&#39;s idempotency key
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -1227,7 +1251,7 @@ module Svix
       return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || []
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
 
       new_options = opts.merge(
         :operation => :"MessageAttemptApi.v1_message_attempt_resend",

data/lib/svix/api/statistics_api.rb

@@ -3,7 +3,7 @@
 
 #Welcome to the Svix API documentation!  Useful links: [Homepage](https://www.svix.com) | [Support email](mailto:support+docs@svix.com) | [Blog](https://www.svix.com/blog/) | [Slack Community](https://www.svix.com/slack/)  # Introduction  This is the reference documentation and schemas for the [Svix webhook service](https://www.svix.com) API. For tutorials and other documentation please refer to [the documentation](https://docs.svix.com).  ## Main concepts  In Svix you have four important entities you will be interacting with:  - `messages`: these are the webhooks being sent. They can have contents and a few other properties. - `application`: this is where `messages` are sent to. Usually you want to create one application for each user on your platform. - `endpoint`: endpoints are the URLs messages will be sent to. Each application can have multiple `endpoints` and each message sent to that application will be sent to all of them (unless they are not subscribed to the sent event type). - `event-type`: event types are identifiers denoting the type of the message being sent. Event types are primarily used to decide which events are sent to which endpoint.   ## Authentication  Get your authentication token (`AUTH_TOKEN`) from the [Svix dashboard](https://dashboard.svix.com) and use it as part of the `Authorization` header as such: `Authorization: Bearer ${AUTH_TOKEN}`.  <SecurityDefinitions />   ## Code samples  The code samples assume you already have the respective libraries installed and you know how to use them. For the latest information on how to do that, please refer to [the documentation](https://docs.svix.com/).   ## Idempotency  Svix supports [idempotency](https://en.wikipedia.org/wiki/Idempotence) for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response.  To perform an idempotent request, pass the idempotency key in the `Idempotency-Key` header to the request. The idempotency key should be a unique value generated by the client. You can create the key in however way you like, though we suggest using UUID v4, or any other string with enough entropy to avoid collisions.  Svix's idempotency works by saving the resulting status code and body of the first request made for any given idempotency key for any successful request. Subsequent requests with the same key return the same result.  Please note that idempotency is only supported for `POST` requests.   ## Cross-Origin Resource Sharing  This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site. 
 
-The version of the OpenAPI document: 1.4
+The version of the OpenAPI document: 1.4.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.0
@@ -21,28 +21,28 @@ module Svix
     end
     # Calculate Aggregate App Stats
     # Creates a background task to calculate the message destinations for all applications in the environment.
-    # @param calculate_app_stats_in [CalculateAppStatsIn] 
+    # @param app_usage_stats_in [AppUsageStatsIn] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request&#39;s idempotency key
-    # @return [BackgroundTaskOutCommon]
-    def calculate_aggregate_app_stats(calculate_app_stats_in, opts = {})
-      data, _status_code, _headers = calculate_aggregate_app_stats_with_http_info(calculate_app_stats_in, opts)
+    # @return [AppUsageStatsOut]
+    def calculate_aggregate_app_stats(app_usage_stats_in, opts = {})
+      data, _status_code, _headers = calculate_aggregate_app_stats_with_http_info(app_usage_stats_in, opts)
       data
     end
 
     # Calculate Aggregate App Stats
     # Creates a background task to calculate the message destinations for all applications in the environment.
-    # @param calculate_app_stats_in [CalculateAppStatsIn] 
+    # @param app_usage_stats_in [AppUsageStatsIn] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request&#39;s idempotency key
-    # @return [Array<(BackgroundTaskOutCommon, Integer, Hash)>] BackgroundTaskOutCommon data, response status code and response headers
-    def calculate_aggregate_app_stats_with_http_info(calculate_app_stats_in, opts = {})
+    # @return [Array<(AppUsageStatsOut, Integer, Hash)>] AppUsageStatsOut data, response status code and response headers
+    def calculate_aggregate_app_stats_with_http_info(app_usage_stats_in, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: StatisticsApi.calculate_aggregate_app_stats ...'
       end
-      # verify the required parameter 'calculate_app_stats_in' is set
-      if @api_client.config.client_side_validation && calculate_app_stats_in.nil?
-        fail ArgumentError, "Missing the required parameter 'calculate_app_stats_in' when calling StatisticsApi.calculate_aggregate_app_stats"
+      # verify the required parameter 'app_usage_stats_in' is set
+      if @api_client.config.client_side_validation && app_usage_stats_in.nil?
+        fail ArgumentError, "Missing the required parameter 'app_usage_stats_in' when calling StatisticsApi.calculate_aggregate_app_stats"
       end
       # resource path
       local_var_path = '/api/v1/stats/usage/app/'
@@ -62,13 +62,13 @@ module Svix
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(calculate_app_stats_in)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(app_usage_stats_in)
 
       # return_type
-      return_type = opts[:debug_return_type] || 'BackgroundTaskOutCommon'
+      return_type = opts[:debug_return_type] || 'AppUsageStatsOut'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || []
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
 
       new_options = opts.merge(
         :operation => :"StatisticsApi.calculate_aggregate_app_stats",
@@ -89,7 +89,7 @@ module Svix
 
     # Get App Attempt Stats
     # Returns application-level statistics on message attempts
-    # @param app_id [String] 
+    # @param app_id [String] The app&#39;s ID or UID
     # @param [Hash] opts the optional parameters
     # @option opts [Time] :start_date 
     # @option opts [Time] :end_date 
@@ -101,7 +101,7 @@ module Svix
 
     # Get App Attempt Stats
     # Returns application-level statistics on message attempts
-    # @param app_id [String] 
+    # @param app_id [String] The app&#39;s ID or UID
     # @param [Hash] opts the optional parameters
     # @option opts [Time] :start_date 
     # @option opts [Time] :end_date 
@@ -150,7 +150,7 @@ module Svix
       return_type = opts[:debug_return_type] || 'AttemptStatisticsResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || []
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
 
       new_options = opts.merge(
         :operation => :"StatisticsApi.v1_stats_app_attempts",
@@ -171,8 +171,8 @@ module Svix
 
     # Get Ep Stats
     # Returns endpoint-level statistics on message attempts
-    # @param app_id [String] 
-    # @param endpoint_id [String] 
+    # @param app_id [String] The app&#39;s ID or UID
+    # @param endpoint_id [String] The ep&#39;s ID or UID
     # @param [Hash] opts the optional parameters
     # @option opts [Time] :start_date 
     # @option opts [Time] :end_date 
@@ -184,8 +184,8 @@ module Svix
 
     # Get Ep Stats
     # Returns endpoint-level statistics on message attempts
-    # @param app_id [String] 
-    # @param endpoint_id [String] 
+    # @param app_id [String] The app&#39;s ID or UID
+    # @param endpoint_id [String] The ep&#39;s ID or UID
     # @param [Hash] opts the optional parameters
     # @option opts [Time] :start_date 
     # @option opts [Time] :end_date 
@@ -251,7 +251,7 @@ module Svix
       return_type = opts[:debug_return_type] || 'AttemptStatisticsResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || []
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
 
       new_options = opts.merge(
         :operation => :"StatisticsApi.v1_stats_endpoint_attempts",

data/lib/svix/api_client.rb

@@ -3,7 +3,7 @@
 
 #Welcome to the Svix API documentation!  Useful links: [Homepage](https://www.svix.com) | [Support email](mailto:support+docs@svix.com) | [Blog](https://www.svix.com/blog/) | [Slack Community](https://www.svix.com/slack/)  # Introduction  This is the reference documentation and schemas for the [Svix webhook service](https://www.svix.com) API. For tutorials and other documentation please refer to [the documentation](https://docs.svix.com).  ## Main concepts  In Svix you have four important entities you will be interacting with:  - `messages`: these are the webhooks being sent. They can have contents and a few other properties. - `application`: this is where `messages` are sent to. Usually you want to create one application for each user on your platform. - `endpoint`: endpoints are the URLs messages will be sent to. Each application can have multiple `endpoints` and each message sent to that application will be sent to all of them (unless they are not subscribed to the sent event type). - `event-type`: event types are identifiers denoting the type of the message being sent. Event types are primarily used to decide which events are sent to which endpoint.   ## Authentication  Get your authentication token (`AUTH_TOKEN`) from the [Svix dashboard](https://dashboard.svix.com) and use it as part of the `Authorization` header as such: `Authorization: Bearer ${AUTH_TOKEN}`.  <SecurityDefinitions />   ## Code samples  The code samples assume you already have the respective libraries installed and you know how to use them. For the latest information on how to do that, please refer to [the documentation](https://docs.svix.com/).   ## Idempotency  Svix supports [idempotency](https://en.wikipedia.org/wiki/Idempotence) for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response.  To perform an idempotent request, pass the idempotency key in the `Idempotency-Key` header to the request. The idempotency key should be a unique value generated by the client. You can create the key in however way you like, though we suggest using UUID v4, or any other string with enough entropy to avoid collisions.  Svix's idempotency works by saving the resulting status code and body of the first request made for any given idempotency key for any successful request. Subsequent requests with the same key return the same result.  Please note that idempotency is only supported for `POST` requests.   ## Cross-Origin Resource Sharing  This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site. 
 
-The version of the OpenAPI document: 1.4
+The version of the OpenAPI document: 1.4.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.0
@@ -110,6 +110,7 @@ module Svix
       query_params = opts[:query_params] || {}
       form_params = opts[:form_params] || {}
 
+      update_params_for_auth! header_params, query_params, opts[:auth_names]
 
       # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
       _verify_ssl_host = @config.verify_ssl_host ? 2 : 0