svix 1.10.0 → 1.12.0

data/lib/svix/api/message_api.rb

@@ -1,9 +1,9 @@
 =begin
 #Svix API
 
-#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}`. For more information on authentication, please refer to the [authentication token docs](https://docs.svix.com/api-keys).  <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. 
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 1.7.0
+The version of the OpenAPI document: 1.1.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.0
@@ -130,7 +130,7 @@ module Svix
     # @param app_id [String] The app&#39;s ID or UID
     # @param message_in [MessageIn] 
     # @param [Hash] opts the optional parameters
-    # @option opts [Boolean] :with_content  (default to true)
+    # @option opts [Boolean] :with_content When &#x60;true&#x60; message payloads are included in the response (default to true)
     # @option opts [String] :idempotency_key The request&#39;s idempotency key
     # @return [MessageOut]
     def v1_message_create(app_id, message_in, opts = {})
@@ -143,7 +143,7 @@ module Svix
     # @param app_id [String] The app&#39;s ID or UID
     # @param message_in [MessageIn] 
     # @param [Hash] opts the optional parameters
-    # @option opts [Boolean] :with_content 
+    # @option opts [Boolean] :with_content When &#x60;true&#x60; message payloads are included in the response
     # @option opts [String] :idempotency_key The request&#39;s idempotency key
     # @return [Array<(MessageOut, Integer, Hash)>] MessageOut data, response status code and response headers
     def v1_message_create_with_http_info(app_id, message_in, opts = {})
@@ -315,7 +315,7 @@ module Svix
     # @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 [Boolean] :with_content  (default to true)
+    # @option opts [Boolean] :with_content When &#x60;true&#x60; message payloads are included in the response (default to true)
     # @return [MessageOut]
     def v1_message_get(app_id, msg_id, opts = {})
       data, _status_code, _headers = v1_message_get_with_http_info(app_id, msg_id, opts)
@@ -327,7 +327,7 @@ module Svix
     # @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 [Boolean] :with_content 
+    # @option opts [Boolean] :with_content When &#x60;true&#x60; message payloads are included in the response
     # @return [Array<(MessageOut, Integer, Hash)>] MessageOut data, response status code and response headers
     def v1_message_get_with_http_info(app_id, msg_id, opts = {})
       if @api_client.config.debugging
@@ -408,17 +408,112 @@ module Svix
       return data, status_code, headers
     end
 
+    # Get Raw Message Payload
+    # Get a message raw payload by its ID or eventID.
+    # @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
+    # @return [MessageRawPayloadOut]
+    def v1_message_get_raw_payload(app_id, msg_id, opts = {})
+      data, _status_code, _headers = v1_message_get_raw_payload_with_http_info(app_id, msg_id, opts)
+      data
+    end
+
+    # Get Raw Message Payload
+    # Get a message raw payload by its ID or eventID.
+    # @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
+    # @return [Array<(MessageRawPayloadOut, Integer, Hash)>] MessageRawPayloadOut data, response status code and response headers
+    def v1_message_get_raw_payload_with_http_info(app_id, msg_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MessageApi.v1_message_get_raw_payload ...'
+      end
+      # verify the required parameter 'app_id' is set
+      if @api_client.config.client_side_validation && app_id.nil?
+        fail ArgumentError, "Missing the required parameter 'app_id' when calling MessageApi.v1_message_get_raw_payload"
+      end
+      if @api_client.config.client_side_validation && app_id.to_s.length > 256
+        fail ArgumentError, 'invalid value for "app_id" when calling MessageApi.v1_message_get_raw_payload, the character length must be smaller than or equal to 256.'
+      end
+
+      if @api_client.config.client_side_validation && app_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "app_id" when calling MessageApi.v1_message_get_raw_payload, the character length must be great than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
+      if @api_client.config.client_side_validation && app_id !~ pattern
+        fail ArgumentError, "invalid value for 'app_id' when calling MessageApi.v1_message_get_raw_payload, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'msg_id' is set
+      if @api_client.config.client_side_validation && msg_id.nil?
+        fail ArgumentError, "Missing the required parameter 'msg_id' when calling MessageApi.v1_message_get_raw_payload"
+      end
+      if @api_client.config.client_side_validation && msg_id.to_s.length > 256
+        fail ArgumentError, 'invalid value for "msg_id" when calling MessageApi.v1_message_get_raw_payload, the character length must be smaller than or equal to 256.'
+      end
+
+      if @api_client.config.client_side_validation && msg_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "msg_id" when calling MessageApi.v1_message_get_raw_payload, the character length must be great than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
+      if @api_client.config.client_side_validation && msg_id !~ pattern
+        fail ArgumentError, "invalid value for 'msg_id' when calling MessageApi.v1_message_get_raw_payload, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/api/v1/app/{app_id}/msg/{msg_id}/raw/'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'msg_id' + '}', CGI.escape(msg_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MessageRawPayloadOut'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"MessageApi.v1_message_get_raw_payload",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MessageApi#v1_message_get_raw_payload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # List Messages
     # List all of the application's messages.  The `before` and `after` parameters let you filter all items created before or after a certain date. These can be used alongside an iterator to paginate over results within a certain window.  Note that by default this endpoint is limited to retrieving 90 days' worth of data relative to now or, if an iterator is provided, 90 days before/after the time indicated by the iterator ID. If you require data beyond those time ranges, you will need to explicitly set the `before` or `after` parameter as appropriate. 
     # @param app_id [String] The app&#39;s ID or UID
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :limit 
-    # @option opts [String] :iterator The msg&#39;s ID
-    # @option opts [String] :channel 
-    # @option opts [Time] :before 
-    # @option opts [Time] :after 
-    # @option opts [Boolean] :with_content  (default to false)
-    # @option opts [Array<String>] :event_types 
+    # @option opts [Integer] :limit Limit the number of returned items
+    # @option opts [String] :iterator The iterator returned from a prior invocation
+    # @option opts [String] :channel Filter response based on the channel
+    # @option opts [Time] :before Only include items created before a certain date
+    # @option opts [Time] :after Only include items created after a certain date
+    # @option opts [Boolean] :with_content When &#x60;true&#x60; message payloads are included in the response (default to true)
+    # @option opts [Array<String>] :event_types Filter response based on the event type
     # @return [ListResponseMessageOut]
     def v1_message_list(app_id, opts = {})
       data, _status_code, _headers = v1_message_list_with_http_info(app_id, opts)
@@ -429,13 +524,13 @@ module Svix
     # List all of the application&#39;s messages.  The &#x60;before&#x60; and &#x60;after&#x60; parameters let you filter all items created before or after a certain date. These can be used alongside an iterator to paginate over results within a certain window.  Note that by default this endpoint is limited to retrieving 90 days&#39; worth of data relative to now or, if an iterator is provided, 90 days before/after the time indicated by the iterator ID. If you require data beyond those time ranges, you will need to explicitly set the &#x60;before&#x60; or &#x60;after&#x60; parameter as appropriate. 
     # @param app_id [String] The app&#39;s ID or UID
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :limit 
-    # @option opts [String] :iterator The msg&#39;s ID
-    # @option opts [String] :channel 
-    # @option opts [Time] :before 
-    # @option opts [Time] :after 
-    # @option opts [Boolean] :with_content 
-    # @option opts [Array<String>] :event_types 
+    # @option opts [Integer] :limit Limit the number of returned items
+    # @option opts [String] :iterator The iterator returned from a prior invocation
+    # @option opts [String] :channel Filter response based on the channel
+    # @option opts [Time] :before Only include items created before a certain date
+    # @option opts [Time] :after Only include items created after a certain date
+    # @option opts [Boolean] :with_content When &#x60;true&#x60; message payloads are included in the response
+    # @option opts [Array<String>] :event_types Filter response based on the event type
     # @return [Array<(ListResponseMessageOut, Integer, Hash)>] ListResponseMessageOut data, response status code and response headers
     def v1_message_list_with_http_info(app_id, opts = {})
       if @api_client.config.debugging

data/lib/svix/api/message_attempt_api.rb

@@ -1,9 +1,9 @@
 =begin
 #Svix API
 
-#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}`. For more information on authentication, please refer to the [authentication token docs](https://docs.svix.com/api-keys).  <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. 
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 1.7.0
+The version of the OpenAPI document: 1.1.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.0
@@ -323,12 +323,12 @@ module Svix
     end
 
     # List Attempted Destinations
-    # `msg_id`: Use a message id or a message `eventId`
+    # List endpoints attempted by a given message. Additionally includes metadata about the latest message attempt. By default, endpoints are listed in ascending order by ID.
     # @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 [Integer] :limit Limit the number of returned items
+    # @option opts [String] :iterator The iterator returned from a prior invocation
     # @return [ListResponseMessageEndpointOut]
     def v1_message_attempt_list_attempted_destinations(app_id, msg_id, opts = {})
       data, _status_code, _headers = v1_message_attempt_list_attempted_destinations_with_http_info(app_id, msg_id, opts)
@@ -336,12 +336,12 @@ module Svix
     end
 
     # List Attempted Destinations
-    # &#x60;msg_id&#x60;: Use a message id or a message &#x60;eventId&#x60;
+    # List endpoints attempted by a given message. Additionally includes metadata about the latest message attempt. By default, endpoints are listed in ascending order by ID.
     # @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 [Integer] :limit Limit the number of returned items
+    # @option opts [String] :iterator The iterator returned from a prior invocation
     # @return [Array<(ListResponseMessageEndpointOut, Integer, Hash)>] ListResponseMessageEndpointOut data, response status code and response headers
     def v1_message_attempt_list_attempted_destinations_with_http_info(app_id, msg_id, opts = {})
       if @api_client.config.debugging
@@ -436,14 +436,14 @@ module Svix
     # @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 The msg&#39;s ID
-    # @option opts [String] :channel 
-    # @option opts [MessageStatus] :status 
-    # @option opts [Time] :before 
-    # @option opts [Time] :after 
-    # @option opts [Boolean] :with_content  (default to true)
-    # @option opts [Array<String>] :event_types 
+    # @option opts [Integer] :limit Limit the number of returned items
+    # @option opts [String] :iterator The iterator returned from a prior invocation
+    # @option opts [String] :channel Filter response based on the channel
+    # @option opts [MessageStatus] :status Filter response based on the delivery status
+    # @option opts [Time] :before Only include items created before a certain date
+    # @option opts [Time] :after Only include items created after a certain date
+    # @option opts [Boolean] :with_content When &#x60;true&#x60; message payloads are included in the response (default to true)
+    # @option opts [Array<String>] :event_types Filter response based on the event type
     # @return [ListResponseEndpointMessageOut]
     def v1_message_attempt_list_attempted_messages(app_id, endpoint_id, opts = {})
       data, _status_code, _headers = v1_message_attempt_list_attempted_messages_with_http_info(app_id, endpoint_id, opts)
@@ -455,14 +455,14 @@ module Svix
     # @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 The msg&#39;s ID
-    # @option opts [String] :channel 
-    # @option opts [MessageStatus] :status 
-    # @option opts [Time] :before 
-    # @option opts [Time] :after 
-    # @option opts [Boolean] :with_content 
-    # @option opts [Array<String>] :event_types 
+    # @option opts [Integer] :limit Limit the number of returned items
+    # @option opts [String] :iterator The iterator returned from a prior invocation
+    # @option opts [String] :channel Filter response based on the channel
+    # @option opts [MessageStatus] :status Filter response based on the delivery status
+    # @option opts [Time] :before Only include items created before a certain date
+    # @option opts [Time] :after Only include items created after a certain date
+    # @option opts [Boolean] :with_content When &#x60;true&#x60; message payloads are included in the response
+    # @option opts [Array<String>] :event_types Filter response based on the event type
     # @return [Array<(ListResponseEndpointMessageOut, Integer, Hash)>] ListResponseEndpointMessageOut data, response status code and response headers
     def v1_message_attempt_list_attempted_messages_with_http_info(app_id, endpoint_id, opts = {})
       if @api_client.config.debugging
@@ -572,15 +572,15 @@ module Svix
     # @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 The attempt&#39;s ID
-    # @option opts [MessageStatus] :status 
-    # @option opts [StatusCodeClass] :status_code_class 
-    # @option opts [String] :channel 
-    # @option opts [Time] :before 
-    # @option opts [Time] :after 
-    # @option opts [Boolean] :with_content  (default to true)
-    # @option opts [Array<String>] :event_types 
+    # @option opts [Integer] :limit Limit the number of returned items
+    # @option opts [String] :iterator The iterator returned from a prior invocation
+    # @option opts [MessageStatus] :status Filter response based on the delivery status
+    # @option opts [StatusCodeClass] :status_code_class Filter response based on the HTTP status code
+    # @option opts [String] :channel Filter response based on the channel
+    # @option opts [Time] :before Only include items created before a certain date
+    # @option opts [Time] :after Only include items created after a certain date
+    # @option opts [Boolean] :with_content When &#x60;true&#x60; attempt content is included in the response (default to true)
+    # @option opts [Array<String>] :event_types Filter response based on the event type
     # @return [ListResponseMessageAttemptOut]
     def v1_message_attempt_list_by_endpoint(app_id, endpoint_id, opts = {})
       data, _status_code, _headers = v1_message_attempt_list_by_endpoint_with_http_info(app_id, endpoint_id, opts)
@@ -592,15 +592,15 @@ module Svix
     # @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 The attempt&#39;s ID
-    # @option opts [MessageStatus] :status 
-    # @option opts [StatusCodeClass] :status_code_class 
-    # @option opts [String] :channel 
-    # @option opts [Time] :before 
-    # @option opts [Time] :after 
-    # @option opts [Boolean] :with_content 
-    # @option opts [Array<String>] :event_types 
+    # @option opts [Integer] :limit Limit the number of returned items
+    # @option opts [String] :iterator The iterator returned from a prior invocation
+    # @option opts [MessageStatus] :status Filter response based on the delivery status
+    # @option opts [StatusCodeClass] :status_code_class Filter response based on the HTTP status code
+    # @option opts [String] :channel Filter response based on the channel
+    # @option opts [Time] :before Only include items created before a certain date
+    # @option opts [Time] :after Only include items created after a certain date
+    # @option opts [Boolean] :with_content When &#x60;true&#x60; attempt content is included in the response
+    # @option opts [Array<String>] :event_types Filter response based on the event type
     # @return [Array<(ListResponseMessageAttemptOut, Integer, Hash)>] ListResponseMessageAttemptOut data, response status code and response headers
     def v1_message_attempt_list_by_endpoint_with_http_info(app_id, endpoint_id, opts = {})
       if @api_client.config.debugging
@@ -712,13 +712,13 @@ module Svix
     # @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 The attempt&#39;s ID
-    # @option opts [String] :channel 
-    # @option opts [MessageStatus] :status 
-    # @option opts [Time] :before 
-    # @option opts [Time] :after 
-    # @option opts [Array<String>] :event_types 
+    # @option opts [Integer] :limit Limit the number of returned items
+    # @option opts [String] :iterator The iterator returned from a prior invocation
+    # @option opts [String] :channel Filter response based on the channel
+    # @option opts [MessageStatus] :status Filter response based on the delivery status
+    # @option opts [Time] :before Only include items created before a certain date
+    # @option opts [Time] :after Only include items created after a certain date
+    # @option opts [Array<String>] :event_types Filter response based on the event type
     # @return [ListResponseMessageAttemptEndpointOut]
     def v1_message_attempt_list_by_endpoint_deprecated(app_id, msg_id, endpoint_id, opts = {})
       data, _status_code, _headers = v1_message_attempt_list_by_endpoint_deprecated_with_http_info(app_id, msg_id, endpoint_id, opts)
@@ -731,13 +731,13 @@ module Svix
     # @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 The attempt&#39;s ID
-    # @option opts [String] :channel 
-    # @option opts [MessageStatus] :status 
-    # @option opts [Time] :before 
-    # @option opts [Time] :after 
-    # @option opts [Array<String>] :event_types 
+    # @option opts [Integer] :limit Limit the number of returned items
+    # @option opts [String] :iterator The iterator returned from a prior invocation
+    # @option opts [String] :channel Filter response based on the channel
+    # @option opts [MessageStatus] :status Filter response based on the delivery status
+    # @option opts [Time] :before Only include items created before a certain date
+    # @option opts [Time] :after Only include items created after a certain date
+    # @option opts [Array<String>] :event_types Filter response based on the event type
     # @return [Array<(ListResponseMessageAttemptEndpointOut, Integer, Hash)>] ListResponseMessageAttemptEndpointOut data, response status code and response headers
     def v1_message_attempt_list_by_endpoint_deprecated_with_http_info(app_id, msg_id, endpoint_id, opts = {})
       if @api_client.config.debugging
@@ -863,16 +863,16 @@ module Svix
     # @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 The attempt&#39;s ID
-    # @option opts [MessageStatus] :status 
-    # @option opts [StatusCodeClass] :status_code_class 
-    # @option opts [String] :channel 
-    # @option opts [String] :endpoint_id The ep&#39;s ID or UID
-    # @option opts [Time] :before 
-    # @option opts [Time] :after 
-    # @option opts [Boolean] :with_content  (default to true)
-    # @option opts [Array<String>] :event_types 
+    # @option opts [Integer] :limit Limit the number of returned items
+    # @option opts [String] :iterator The iterator returned from a prior invocation
+    # @option opts [MessageStatus] :status Filter response based on the delivery status
+    # @option opts [StatusCodeClass] :status_code_class Filter response based on the HTTP status code
+    # @option opts [String] :channel Filter response based on the channel
+    # @option opts [String] :endpoint_id Filter the attempts based on the attempted endpoint
+    # @option opts [Time] :before Only include items created before a certain date
+    # @option opts [Time] :after Only include items created after a certain date
+    # @option opts [Boolean] :with_content When &#x60;true&#x60; attempt content is included in the response (default to true)
+    # @option opts [Array<String>] :event_types Filter response based on the event type
     # @return [ListResponseMessageAttemptOut]
     def v1_message_attempt_list_by_msg(app_id, msg_id, opts = {})
       data, _status_code, _headers = v1_message_attempt_list_by_msg_with_http_info(app_id, msg_id, opts)
@@ -884,16 +884,16 @@ module Svix
     # @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 The attempt&#39;s ID
-    # @option opts [MessageStatus] :status 
-    # @option opts [StatusCodeClass] :status_code_class 
-    # @option opts [String] :channel 
-    # @option opts [String] :endpoint_id The ep&#39;s ID or UID
-    # @option opts [Time] :before 
-    # @option opts [Time] :after 
-    # @option opts [Boolean] :with_content 
-    # @option opts [Array<String>] :event_types 
+    # @option opts [Integer] :limit Limit the number of returned items
+    # @option opts [String] :iterator The iterator returned from a prior invocation
+    # @option opts [MessageStatus] :status Filter response based on the delivery status
+    # @option opts [StatusCodeClass] :status_code_class Filter response based on the HTTP status code
+    # @option opts [String] :channel Filter response based on the channel
+    # @option opts [String] :endpoint_id Filter the attempts based on the attempted endpoint
+    # @option opts [Time] :before Only include items created before a certain date
+    # @option opts [Time] :after Only include items created after a certain date
+    # @option opts [Boolean] :with_content When &#x60;true&#x60; attempt content is included in the response
+    # @option opts [Array<String>] :event_types Filter response based on the event type
     # @return [Array<(ListResponseMessageAttemptOut, Integer, Hash)>] ListResponseMessageAttemptOut data, response status code and response headers
     def v1_message_attempt_list_by_msg_with_http_info(app_id, msg_id, opts = {})
       if @api_client.config.debugging
@@ -1018,15 +1018,15 @@ module Svix
     # @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 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 
-    # @option opts [Time] :after 
-    # @option opts [StatusCodeClass] :status_code_class 
-    # @option opts [Array<String>] :event_types 
+    # @option opts [Integer] :limit Limit the number of returned items
+    # @option opts [String] :iterator The iterator returned from a prior invocation
+    # @option opts [String] :endpoint_id Filter the attempts based on the attempted endpoint
+    # @option opts [String] :channel Filter response based on the channel
+    # @option opts [MessageStatus] :status Filter response based on the delivery status
+    # @option opts [Time] :before Only include items created before a certain date
+    # @option opts [Time] :after Only include items created after a certain date
+    # @option opts [StatusCodeClass] :status_code_class Filter response based on the HTTP status code
+    # @option opts [Array<String>] :event_types Filter response based on the event type
     # @return [ListResponseMessageAttemptOut]
     def v1_message_attempt_list_by_msg_deprecated(app_id, msg_id, opts = {})
       data, _status_code, _headers = v1_message_attempt_list_by_msg_deprecated_with_http_info(app_id, msg_id, opts)
@@ -1038,15 +1038,15 @@ module Svix
     # @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 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 
-    # @option opts [Time] :after 
-    # @option opts [StatusCodeClass] :status_code_class 
-    # @option opts [Array<String>] :event_types 
+    # @option opts [Integer] :limit Limit the number of returned items
+    # @option opts [String] :iterator The iterator returned from a prior invocation
+    # @option opts [String] :endpoint_id Filter the attempts based on the attempted endpoint
+    # @option opts [String] :channel Filter response based on the channel
+    # @option opts [MessageStatus] :status Filter response based on the delivery status
+    # @option opts [Time] :before Only include items created before a certain date
+    # @option opts [Time] :after Only include items created after a certain date
+    # @option opts [StatusCodeClass] :status_code_class Filter response based on the HTTP status code
+    # @option opts [Array<String>] :event_types Filter response based on the event type
     # @return [Array<(ListResponseMessageAttemptOut, Integer, Hash)>] ListResponseMessageAttemptOut data, response status code and response headers
     def v1_message_attempt_list_by_msg_deprecated_with_http_info(app_id, msg_id, opts = {})
       if @api_client.config.debugging

data/lib/svix/api/statistics_api.rb

@@ -1,9 +1,9 @@
 =begin
 #Svix API
 
-#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}`. For more information on authentication, please refer to the [authentication token docs](https://docs.svix.com/api-keys).  <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. 
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 1.7.0
+The version of the OpenAPI document: 1.1.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.0
@@ -91,8 +91,8 @@ module Svix
     # Returns application-level statistics on message attempts
     # @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 
+    # @option opts [Time] :start_date Filter the range to data starting from this date
+    # @option opts [Time] :end_date Filter the range to data ending by this date
     # @return [AttemptStatisticsResponse]
     def v1_stats_app_attempts(app_id, opts = {})
       data, _status_code, _headers = v1_stats_app_attempts_with_http_info(app_id, opts)
@@ -103,8 +103,8 @@ module Svix
     # Returns application-level statistics on message attempts
     # @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 
+    # @option opts [Time] :start_date Filter the range to data starting from this date
+    # @option opts [Time] :end_date Filter the range to data ending by this date
     # @return [Array<(AttemptStatisticsResponse, Integer, Hash)>] AttemptStatisticsResponse data, response status code and response headers
     def v1_stats_app_attempts_with_http_info(app_id, opts = {})
       if @api_client.config.debugging
@@ -174,8 +174,8 @@ module Svix
     # @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 
+    # @option opts [Time] :start_date Filter the range to data starting from this date
+    # @option opts [Time] :end_date Filter the range to data ending by this date
     # @return [AttemptStatisticsResponse]
     def v1_stats_endpoint_attempts(app_id, endpoint_id, opts = {})
       data, _status_code, _headers = v1_stats_endpoint_attempts_with_http_info(app_id, endpoint_id, opts)
@@ -187,8 +187,8 @@ module Svix
     # @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 
+    # @option opts [Time] :start_date Filter the range to data starting from this date
+    # @option opts [Time] :end_date Filter the range to data ending by this date
     # @return [Array<(AttemptStatisticsResponse, Integer, Hash)>] AttemptStatisticsResponse data, response status code and response headers
     def v1_stats_endpoint_attempts_with_http_info(app_id, endpoint_id, opts = {})
       if @api_client.config.debugging

data/lib/svix/api/transformation_template_api.rb

@@ -1,9 +1,9 @@
 =begin
 #Svix API
 
-#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}`. For more information on authentication, please refer to the [authentication token docs](https://docs.svix.com/api-keys).  <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. 
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 1.7.0
+The version of the OpenAPI document: 1.1.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.0
@@ -216,9 +216,9 @@ module Svix
     # List Transformation Templates
     # List all transformation templates for an application
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :limit 
-    # @option opts [String] :iterator 
-    # @option opts [Ordering] :order 
+    # @option opts [Integer] :limit Limit the number of returned items
+    # @option opts [String] :iterator The iterator returned from a prior invocation
+    # @option opts [Ordering] :order The sorting order of the returned items
     # @return [ListResponseTemplateOut]
     def v1_transformation_template_list(opts = {})
       data, _status_code, _headers = v1_transformation_template_list_with_http_info(opts)
@@ -228,9 +228,9 @@ module Svix
     # List Transformation Templates
     # List all transformation templates for an application
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :limit 
-    # @option opts [String] :iterator 
-    # @option opts [Ordering] :order 
+    # @option opts [Integer] :limit Limit the number of returned items
+    # @option opts [String] :iterator The iterator returned from a prior invocation
+    # @option opts [Ordering] :order The sorting order of the returned items
     # @return [Array<(ListResponseTemplateOut, Integer, Hash)>] ListResponseTemplateOut data, response status code and response headers
     def v1_transformation_template_list_with_http_info(opts = {})
       if @api_client.config.debugging

data/lib/svix/api_client.rb

@@ -1,9 +1,9 @@
 =begin
 #Svix API
 
-#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}`. For more information on authentication, please refer to the [authentication token docs](https://docs.svix.com/api-keys).  <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. 
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 1.7.0
+The version of the OpenAPI document: 1.1.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.0

data/lib/svix/api_error.rb

@@ -1,9 +1,9 @@
 =begin
 #Svix API
 
-#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}`. For more information on authentication, please refer to the [authentication token docs](https://docs.svix.com/api-keys).  <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. 
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 1.7.0
+The version of the OpenAPI document: 1.1.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.0