svix 1.43.0 → 1.45.0

data/lib/svix/api/message_api.rb

@@ -20,7 +20,7 @@ module Svix
       @api_client = api_client
     end
     # Create Message Attempt For Endpoint
-    # Creates and sends a message to the specified endpoint. The message attempt and response from the endpoint is returned. FIXME: use MessageIn for expediency, even though the `application` parameter is unused. Since this endpoint isn't publicly documented anyway, it should be fine
+    # Creates and sends a message to the specified endpoint.  The message attempt and response from the endpoint is returned.
     # @param app_id [String] The app's ID or UID
     # @param endpoint_id [String] The ep's ID or UID
     # @param message_in [MessageIn] 
@@ -33,7 +33,7 @@ module Svix
     end
 
     # Create Message Attempt For Endpoint
-    # Creates and sends a message to the specified endpoint. The message attempt and response from the endpoint is returned. FIXME: use MessageIn for expediency, even though the `application` parameter is unused. Since this endpoint isn't publicly documented anyway, it should be fine
+    # Creates and sends a message to the specified endpoint.  The message attempt and response from the endpoint is returned.
     # @param app_id [String] The app's ID or UID
     # @param endpoint_id [String] The ep's ID or UID
     # @param message_in [MessageIn] 
@@ -128,12 +128,148 @@ module Svix
       return data, status_code, headers
     end
 
+    # Public Events
+    # Reads the stream of created messages for an application, filtered on the Sink's event types and Channels.
+    # @param app_id [String] The app's ID or UID
+    # @param sink_id [String] The ep's ID or UID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Limit the number of returned items
+    # @option opts [String] :iterator The iterator returned from a prior invocation
+    # @option opts [String] :event_type Filters messages sent with this event type (optional).
+    # @option opts [String] :channel Filters messages sent with this channel (optional).
+    # @option opts [Time] :after 
+    # @return [MessageEventsOut]
+    def v1_events_public(app_id, sink_id, opts = {})
+      data, _status_code, _headers = v1_events_public_with_http_info(app_id, sink_id, opts)
+      data
+    end
+
+    # Public Events
+    # Reads the stream of created messages for an application, filtered on the Sink's event types and Channels.
+    # @param app_id [String] The app's ID or UID
+    # @param sink_id [String] The ep's ID or UID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Limit the number of returned items
+    # @option opts [String] :iterator The iterator returned from a prior invocation
+    # @option opts [String] :event_type Filters messages sent with this event type (optional).
+    # @option opts [String] :channel Filters messages sent with this channel (optional).
+    # @option opts [Time] :after 
+    # @return [Array<(MessageEventsOut, Integer, Hash)>] MessageEventsOut data, response status code and response headers
+    def v1_events_public_with_http_info(app_id, sink_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MessageApi.v1_events_public ...'
+      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_events_public"
+      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_events_public, 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_events_public, 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_events_public, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'sink_id' is set
+      if @api_client.config.client_side_validation && sink_id.nil?
+        fail ArgumentError, "Missing the required parameter 'sink_id' when calling MessageApi.v1_events_public"
+      end
+      if @api_client.config.client_side_validation && sink_id.to_s.length > 256
+        fail ArgumentError, 'invalid value for "sink_id" when calling MessageApi.v1_events_public, the character length must be smaller than or equal to 256.'
+      end
+
+      if @api_client.config.client_side_validation && sink_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "sink_id" when calling MessageApi.v1_events_public, 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 && sink_id !~ pattern
+        fail ArgumentError, "invalid value for 'sink_id' when calling MessageApi.v1_events_public, must conform to the pattern #{pattern}."
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 250
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MessageApi.v1_events_public, 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 MessageApi.v1_events_public, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'event_type'].nil? && opts[:'event_type'].to_s.length > 256
+        fail ArgumentError, 'invalid value for "opts[:"event_type"]" when calling MessageApi.v1_events_public, the character length must be smaller than or equal to 256.'
+      end
+
+      pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
+      if @api_client.config.client_side_validation && !opts[:'event_type'].nil? && opts[:'event_type'] !~ pattern
+        fail ArgumentError, "invalid value for 'opts[:\"event_type\"]' when calling MessageApi.v1_events_public, must conform to the pattern #{pattern}."
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'channel'].nil? && opts[:'channel'].to_s.length > 128
+        fail ArgumentError, 'invalid value for "opts[:"channel"]" when calling MessageApi.v1_events_public, the character length must be smaller than or equal to 128.'
+      end
+
+      pattern = Regexp.new(/^[a-zA-Z0-9\-_.:]+$/)
+      if @api_client.config.client_side_validation && !opts[:'channel'].nil? && opts[:'channel'] !~ pattern
+        fail ArgumentError, "invalid value for 'opts[:\"channel\"]' when calling MessageApi.v1_events_public, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/api/v1/app/{app_id}/poller/{sink_id}'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'sink_id' + '}', CGI.escape(sink_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'iterator'] = opts[:'iterator'] if !opts[:'iterator'].nil?
+      query_params[:'event_type'] = opts[:'event_type'] if !opts[:'event_type'].nil?
+      query_params[:'channel'] = opts[:'channel'] if !opts[:'channel'].nil?
+      query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MessageEventsOut'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"MessageApi.v1_events_public",
+        :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_events_public\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Create Message
     # Creates a new message and dispatches it to all of the application's endpoints.  The `eventId` is an optional custom unique ID. It's verified to be unique only up to a day, after that no verification will be made. If a message with the same `eventId` already exists for the application, a 409 conflict error will be returned.  The `eventType` indicates the type and schema of the event. All messages of a certain `eventType` are expected to have the same schema. Endpoints can choose to only listen to specific event types. Messages can also have `channels`, which similar to event types let endpoints filter by them. Unlike event types, messages can have multiple channels, and channels don't imply a specific message content or schema.  The `payload` property is the webhook's body (the actual webhook message). Svix supports payload sizes of up to ~350kb, though it's generally a good idea to keep webhook payloads small, probably no larger than 40kb.
     # @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 When &#x60;true&#x60; message payloads are included in the response (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 = {})
@@ -146,7 +282,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 When &#x60;true&#x60; message payloads are included in the response (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 [Array<(MessageOut, Integer, Hash)>] MessageOut data, response status code and response headers
     def v1_message_create_with_http_info(app_id, message_in, opts = {})
@@ -222,13 +358,13 @@ module Svix
     end
 
     # Message Events
-    # Reads the stream of created messages for an application
+    # Reads the stream of created messages for an application.
     # @param app_id [String] The app&#39;s ID or UID
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit Limit the number of returned items
     # @option opts [String] :iterator The iterator returned from a prior invocation
     # @option opts [Array<String>] :event_types Filter response based on the event type
-    # @option opts [Array<String>] :channels Filter response based on the event type
+    # @option opts [Array<String>] :channels Filter response based on the event type.
     # @option opts [Time] :after 
     # @return [MessageEventsOut]
     def v1_message_events(app_id, opts = {})
@@ -237,13 +373,13 @@ module Svix
     end
 
     # Message Events
-    # Reads the stream of created messages for an application
+    # Reads the stream of created messages for an application.
     # @param app_id [String] The app&#39;s ID or UID
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit Limit the number of returned items
     # @option opts [String] :iterator The iterator returned from a prior invocation
     # @option opts [Array<String>] :event_types Filter response based on the event type
-    # @option opts [Array<String>] :channels Filter response based on the event type
+    # @option opts [Array<String>] :channels Filter response based on the event type.
     # @option opts [Time] :after 
     # @return [Array<(MessageEventsOut, Integer, Hash)>] MessageEventsOut data, response status code and response headers
     def v1_message_events_with_http_info(app_id, opts = {})
@@ -328,7 +464,7 @@ module Svix
     # @option opts [Integer] :limit Limit the number of returned items
     # @option opts [String] :iterator The iterator returned from a prior invocation
     # @option opts [Array<String>] :event_types Filter response based on the event type
-    # @option opts [Array<String>] :channels Filter response based on the event type
+    # @option opts [Array<String>] :channels Filter response based on the event type.
     # @option opts [Time] :after 
     # @return [MessageEventsOut]
     def v1_message_events_subscription(app_id, subscription_id, opts = {})
@@ -344,7 +480,7 @@ module Svix
     # @option opts [Integer] :limit Limit the number of returned items
     # @option opts [String] :iterator The iterator returned from a prior invocation
     # @option opts [Array<String>] :event_types Filter response based on the event type
-    # @option opts [Array<String>] :channels Filter response based on the event type
+    # @option opts [Array<String>] :channels Filter response based on the event type.
     # @option opts [Time] :after 
     # @return [Array<(MessageEventsOut, Integer, Hash)>] MessageEventsOut data, response status code and response headers
     def v1_message_events_subscription_with_http_info(app_id, subscription_id, opts = {})
@@ -439,7 +575,7 @@ module Svix
     end
 
     # Message Events Create Token
-    # Creates an auth token that can be used with the `v1.message.events-subscription` endpoint
+    # Creates an auth token that can be used with the `v1.message.events-subscription` endpoint.
     # @param app_id [String] The app&#39;s ID or UID
     # @param subscription_id [String] The esub&#39;s ID or UID
     # @param [Hash] opts the optional parameters
@@ -451,7 +587,7 @@ module Svix
     end
 
     # Message Events Create Token
-    # Creates an auth token that can be used with the &#x60;v1.message.events-subscription&#x60; endpoint
+    # Creates an auth token that can be used with the &#x60;v1.message.events-subscription&#x60; endpoint.
     # @param app_id [String] The app&#39;s ID or UID
     # @param subscription_id [String] The esub&#39;s ID or UID
     # @param [Hash] opts the optional parameters
@@ -537,7 +673,7 @@ module Svix
     end
 
     # Delete message payload
-    # Delete the given message's payload. Useful in cases when a message was accidentally sent with sensitive content.  The message can't be replayed or resent once its payload has been deleted or expired.
+    # Delete the given message's payload.  Useful in cases when a message was accidentally sent with sensitive content. The message can't be replayed or resent once its payload has been deleted or expired.
     # @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
@@ -548,7 +684,7 @@ module Svix
     end
 
     # Delete message payload
-    # Delete the given message&#39;s payload. Useful in cases when a message was accidentally sent with sensitive content.  The message can&#39;t be replayed or resent once its payload has been deleted or expired.
+    # Delete the given message&#39;s payload.  Useful in cases when a message was accidentally sent with sensitive content. The message can&#39;t be replayed or resent once its payload has been deleted or expired.
     # @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
@@ -636,7 +772,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 When &#x60;true&#x60; message payloads are included in the response (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)
@@ -648,7 +784,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 When &#x60;true&#x60; message payloads are included in the response (default to true)
+    # @option opts [Boolean] :with_content When &#x60;true&#x60; message payloads are included in the response. (default to true)
     # @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
@@ -830,11 +966,11 @@ module Svix
     # @param [Hash] opts the optional parameters
     # @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 [String] :tag Filter messages matching the provided tag
+    # @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 [String] :tag Filter messages matching the provided tag.
     # @option opts [Array<String>] :event_types Filter response based on the event type
     # @return [ListResponseMessageOut]
     def v1_message_list(app_id, opts = {})
@@ -848,11 +984,11 @@ module Svix
     # @param [Hash] opts the optional parameters
     # @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 [String] :tag Filter messages matching the provided tag
+    # @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 [String] :tag Filter messages matching the provided tag.
     # @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 = {})

data/lib/svix/api/message_attempt_api.rb

@@ -154,7 +154,7 @@ module Svix
     end
 
     # Delete attempt response body
-    # Deletes the given attempt's response body. Useful when an endpoint accidentally returned sensitive content.
+    # Deletes the given attempt's response body.  Useful when an endpoint accidentally returned sensitive content. The message can't be replayed or resent once its payload has been deleted or expired.
     # @param app_id [String] The app's ID or UID
     # @param msg_id [String] The msg's ID or UID
     # @param attempt_id [String] The attempt's ID
@@ -166,7 +166,7 @@ module Svix
     end
 
     # Delete attempt response body
-    # Deletes the given attempt's response body. Useful when an endpoint accidentally returned sensitive content.
+    # Deletes the given attempt's response body.  Useful when an endpoint accidentally returned sensitive content. The message can't be replayed or resent once its payload has been deleted or expired.
     # @param app_id [String] The app's ID or UID
     # @param msg_id [String] The msg's ID or UID
     # @param attempt_id [String] The attempt's ID
@@ -457,7 +457,7 @@ module Svix
     end
 
     # List Attempted Destinations
-    # 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.
+    # 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's ID or UID
     # @param msg_id [String] The msg's ID or UID
     # @param [Hash] opts the optional parameters
@@ -470,7 +470,7 @@ module Svix
     end
 
     # List Attempted Destinations
-    # 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.
+    # 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's ID or UID
     # @param msg_id [String] The msg's ID or UID
     # @param [Hash] opts the optional parameters
@@ -1032,7 +1032,7 @@ module Svix
     end
 
     # List Attempts By Msg
-    # List attempts by message id  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. 
+    # List attempts by message ID.  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's ID or UID
     # @param msg_id [String] The msg's ID or UID
     # @param [Hash] opts the optional parameters
@@ -1054,7 +1054,7 @@ module Svix
     end
 
     # List Attempts By Msg
-    # List attempts by message id  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. 
+    # List attempts by message ID.  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's ID or UID
     # @param msg_id [String] The msg's ID or UID
     # @param [Hash] opts the optional parameters

data/lib/svix/api/statistics_api.rb

@@ -151,8 +151,8 @@ module Svix
     # Returns application-level statistics on message attempts
     # @param app_id [String] The app's ID or UID
     # @param [Hash] opts the optional parameters
-    # @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
+    # @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)
@@ -163,8 +163,8 @@ module Svix
     # Returns application-level statistics on message attempts
     # @param app_id [String] The app's ID or UID
     # @param [Hash] opts the optional parameters
-    # @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
+    # @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
@@ -230,12 +230,12 @@ module Svix
     end
 
     # Get Ep Stats
-    # Returns endpoint-level statistics on message attempts
+    # Returns endpoint-level statistics on message attempts.
     # @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 Filter the range to data starting from this date
-    # @option opts [Time] :end_date Filter the range to data ending by this 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)
@@ -243,12 +243,12 @@ module Svix
     end
 
     # Get Ep Stats
-    # Returns endpoint-level statistics on message attempts
+    # Returns endpoint-level statistics on message attempts.
     # @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 Filter the range to data starting from this date
-    # @option opts [Time] :end_date Filter the range to data ending by this 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

@@ -20,7 +20,7 @@ module Svix
       @api_client = api_client
     end
     # Update Hubspot Oauth Config
-    # Create/update endpoint Hubsport OAuth configuration Specific private endpoint just for us, to avoid exposing the Hubspot secret to the client.
+    # Create/update endpoint Hubspot OAuth configuration Specific private endpoint just for us, to avoid exposing the Hubspot secret to the client.
     # @param app_id [String] The app's ID or UID
     # @param endpoint_id [String] The ep's ID or UID
     # @param hubspot_oauth_config_in [HubspotOauthConfigIn] 
@@ -32,7 +32,7 @@ module Svix
     end
 
     # Update Hubspot Oauth Config
-    # Create/update endpoint Hubsport OAuth configuration Specific private endpoint just for us, to avoid exposing the Hubspot secret to the client.
+    # Create/update endpoint Hubspot OAuth configuration Specific private endpoint just for us, to avoid exposing the Hubspot secret to the client.
     # @param app_id [String] The app's ID or UID
     # @param endpoint_id [String] The ep's ID or UID
     # @param hubspot_oauth_config_in [HubspotOauthConfigIn] 
@@ -126,7 +126,7 @@ module Svix
     end
 
     # Create Transformation Template
-    # Create a new transformation template
+    # Create a new transformation template.
     # @param template_in [TemplateIn] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request's idempotency key
@@ -137,7 +137,7 @@ module Svix
     end
 
     # Create Transformation Template
-    # Create a new transformation template
+    # Create a new transformation template.
     # @param template_in [TemplateIn] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request's idempotency key
@@ -197,7 +197,7 @@ module Svix
     end
 
     # Delete Transformation Template
-    # Delete a transformation template
+    # Delete a transformation template.
     # @param transformation_template_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -207,7 +207,7 @@ module Svix
     end
 
     # Delete Transformation Template
-    # Delete a transformation template
+    # Delete a transformation template.
     # @param transformation_template_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -260,7 +260,7 @@ module Svix
     end
 
     # Generate
-    # Use OpenAI's Completion API to generate code for a transformation template
+    # Use OpenAI's Completion API to generate code for a transformation template.
     # @param generate_in [GenerateIn] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request&#39;s idempotency key
@@ -271,7 +271,7 @@ module Svix
     end
 
     # Generate
-    # Use OpenAI&#39;s Completion API to generate code for a transformation template
+    # Use OpenAI&#39;s Completion API to generate code for a transformation template.
     # @param generate_in [GenerateIn] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request&#39;s idempotency key
@@ -331,7 +331,7 @@ module Svix
     end
 
     # Get Transformation Template
-    # Get a transformation template
+    # Get a transformation template.
     # @param transformation_template_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [TemplateOut]
@@ -341,7 +341,7 @@ module Svix
     end
 
     # Get Transformation Template
-    # Get a transformation template
+    # Get a transformation template.
     # @param transformation_template_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(TemplateOut, Integer, Hash)>] TemplateOut data, response status code and response headers
@@ -394,7 +394,7 @@ module Svix
     end
 
     # List Transformation Templates
-    # List all transformation templates for an application
+    # List all transformation templates for an application.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit Limit the number of returned items
     # @option opts [String] :iterator The iterator returned from a prior invocation
@@ -406,7 +406,7 @@ module Svix
     end
 
     # List Transformation Templates
-    # List all transformation templates for an application
+    # List all transformation templates for an application.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit Limit the number of returned items
     # @option opts [String] :iterator The iterator returned from a prior invocation
@@ -468,7 +468,7 @@ module Svix
     end
 
     # Authorize Discord
-    # Get Discord Incoming webhook URL
+    # Get Discord Incoming webhook URL.
     # @param o_auth_payload_in [OAuthPayloadIn] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request&#39;s idempotency key
@@ -479,7 +479,7 @@ module Svix
     end
 
     # Authorize Discord
-    # Get Discord Incoming webhook URL
+    # Get Discord Incoming webhook URL.
     # @param o_auth_payload_in [OAuthPayloadIn] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request&#39;s idempotency key
@@ -539,7 +539,7 @@ module Svix
     end
 
     # Authorize Hubspot
-    # Get Hubspot access token using authorization code
+    # Get Hubspot access token using authorization code.
     # @param o_auth_payload_in [OAuthPayloadIn] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request&#39;s idempotency key
@@ -550,7 +550,7 @@ module Svix
     end
 
     # Authorize Hubspot
-    # Get Hubspot access token using authorization code
+    # Get Hubspot access token using authorization code.
     # @param o_auth_payload_in [OAuthPayloadIn] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request&#39;s idempotency key
@@ -610,7 +610,7 @@ module Svix
     end
 
     # Authorize Slack
-    # Get Slack Incoming webhook URL
+    # Get Slack Incoming webhook URL.
     # @param o_auth_payload_in [OAuthPayloadIn] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request&#39;s idempotency key
@@ -621,7 +621,7 @@ module Svix
     end
 
     # Authorize Slack
-    # Get Slack Incoming webhook URL
+    # Get Slack Incoming webhook URL.
     # @param o_auth_payload_in [OAuthPayloadIn] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request&#39;s idempotency key
@@ -681,7 +681,7 @@ module Svix
     end
 
     # Patch Transformation Template
-    # Partially update a transformation template
+    # Partially update a transformation template.
     # @param transformation_template_id [String] 
     # @param template_patch [TemplatePatch] 
     # @param [Hash] opts the optional parameters
@@ -692,7 +692,7 @@ module Svix
     end
 
     # Patch Transformation Template
-    # Partially update a transformation template
+    # Partially update a transformation template.
     # @param transformation_template_id [String] 
     # @param template_patch [TemplatePatch] 
     # @param [Hash] opts the optional parameters
@@ -755,7 +755,7 @@ module Svix
     end
 
     # Simulate
-    # Simulate running the transformation on the payload and code
+    # Simulate running the transformation on the payload and code.
     # @param transformation_simulate_in [TransformationSimulateIn] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request&#39;s idempotency key
@@ -766,7 +766,7 @@ module Svix
     end
 
     # Simulate
-    # Simulate running the transformation on the payload and code
+    # Simulate running the transformation on the payload and code.
     # @param transformation_simulate_in [TransformationSimulateIn] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request&#39;s idempotency key
@@ -826,7 +826,7 @@ module Svix
     end
 
     # Update Transformation Template
-    # Update a transformation template
+    # Update a transformation template.
     # @param transformation_template_id [String] 
     # @param template_update [TemplateUpdate] 
     # @param [Hash] opts the optional parameters
@@ -837,7 +837,7 @@ module Svix
     end
 
     # Update Transformation Template
-    # Update a transformation template
+    # Update a transformation template.
     # @param transformation_template_id [String] 
     # @param template_update [TemplateUpdate] 
     # @param [Hash] opts the optional parameters

data/lib/svix/endpoint_api.rb

@@ -60,7 +60,7 @@ module Svix
     end
 
     def replay_missing(app_id, endpoint_id, replay_in, options = {})
-      @api.v1_endpoint_replay(app_id, endpoint_id, replay_in, options)
+      @api.v1_endpoint_replay_missing(app_id, endpoint_id, replay_in, options)
       nil
     end
 

data/lib/svix/message_api.rb

@@ -25,7 +25,7 @@ module Svix
     end
   end
 
-  # Creates a [`MessageIn`] with a pre-serialized payload.
+  # Creates a [`MessageIn`] with a raw string payload.
   #
   # The payload is not normalized on the server. Normally, payloads are required
   # to be JSON, and Svix will minify the payload before sending the webhook

data/lib/svix/models/application_in.rb

@@ -21,7 +21,7 @@ module Svix
 
     attr_accessor :rate_limit
 
-    # Optional unique identifier for the application
+    # Optional unique identifier for the application.
     attr_accessor :uid
 
     # Attribute mapping from ruby-style variable name to JSON key.