svix 1.23.0 → 1.25.0

data/lib/svix/api/message_api.rb

@@ -126,7 +126,7 @@ module Svix
     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 any application in your environment, 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.
+    # 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's ID or UID
     # @param message_in [MessageIn] 
     # @param [Hash] opts the optional parameters
@@ -139,7 +139,7 @@ module Svix
     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 any application in your environment, 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.
+    # 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's ID or UID
     # @param message_in [MessageIn] 
     # @param [Hash] opts the optional parameters
@@ -215,6 +215,222 @@ module Svix
       return data, status_code, headers
     end
 
+    # Stream Events Subscription
+    # Reads the stream of created messages for an application, but using server-managed iterator tracking.
+    # @param app_id [String] The app's ID or UID
+    # @param subscription_id [String] The esub'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 [Time] :after 
+    # @return [MessageStreamOut]
+    def v1_message_events_subscription(app_id, subscription_id, opts = {})
+      data, _status_code, _headers = v1_message_events_subscription_with_http_info(app_id, subscription_id, opts)
+      data
+    end
+
+    # Stream Events Subscription
+    # Reads the stream of created messages for an application, but using server-managed iterator tracking.
+    # @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
+    # @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 [Time] :after 
+    # @return [Array<(MessageStreamOut, Integer, Hash)>] MessageStreamOut data, response status code and response headers
+    def v1_message_events_subscription_with_http_info(app_id, subscription_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MessageApi.v1_message_events_subscription ...'
+      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_events_subscription"
+      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_events_subscription, 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_events_subscription, 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_events_subscription, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'subscription_id' is set
+      if @api_client.config.client_side_validation && subscription_id.nil?
+        fail ArgumentError, "Missing the required parameter 'subscription_id' when calling MessageApi.v1_message_events_subscription"
+      end
+      if @api_client.config.client_side_validation && subscription_id.to_s.length > 256
+        fail ArgumentError, 'invalid value for "subscription_id" when calling MessageApi.v1_message_events_subscription, the character length must be smaller than or equal to 256.'
+      end
+
+      if @api_client.config.client_side_validation && subscription_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "subscription_id" when calling MessageApi.v1_message_events_subscription, 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 && subscription_id !~ pattern
+        fail ArgumentError, "invalid value for 'subscription_id' when calling MessageApi.v1_message_events_subscription, 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_message_events_subscription, 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_message_events_subscription, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/api/v1/app/{app_id}/events/subscription/{subscription_id}'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'subscription_id' + '}', CGI.escape(subscription_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_types'] = @api_client.build_collection_param(opts[:'event_types'], :multi) if !opts[:'event_types'].nil?
+      query_params[:'channels'] = @api_client.build_collection_param(opts[:'channels'], :multi) if !opts[:'channels'].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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MessageStreamOut'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"MessageApi.v1_message_events_subscription",
+        :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_events_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Stream Events Create Token
+    # 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
+    # @option opts [String] :idempotency_key The request&#39;s idempotency key
+    # @return [MessageSubscriberAuthTokenOut]
+    def v1_message_events_subscription_create_token(app_id, subscription_id, opts = {})
+      data, _status_code, _headers = v1_message_events_subscription_create_token_with_http_info(app_id, subscription_id, opts)
+      data
+    end
+
+    # Stream Events Create Token
+    # 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
+    # @option opts [String] :idempotency_key The request&#39;s idempotency key
+    # @return [Array<(MessageSubscriberAuthTokenOut, Integer, Hash)>] MessageSubscriberAuthTokenOut data, response status code and response headers
+    def v1_message_events_subscription_create_token_with_http_info(app_id, subscription_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MessageApi.v1_message_events_subscription_create_token ...'
+      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_events_subscription_create_token"
+      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_events_subscription_create_token, 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_events_subscription_create_token, 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_events_subscription_create_token, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'subscription_id' is set
+      if @api_client.config.client_side_validation && subscription_id.nil?
+        fail ArgumentError, "Missing the required parameter 'subscription_id' when calling MessageApi.v1_message_events_subscription_create_token"
+      end
+      if @api_client.config.client_side_validation && subscription_id.to_s.length > 256
+        fail ArgumentError, 'invalid value for "subscription_id" when calling MessageApi.v1_message_events_subscription_create_token, the character length must be smaller than or equal to 256.'
+      end
+
+      if @api_client.config.client_side_validation && subscription_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "subscription_id" when calling MessageApi.v1_message_events_subscription_create_token, 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 && subscription_id !~ pattern
+        fail ArgumentError, "invalid value for 'subscription_id' when calling MessageApi.v1_message_events_subscription_create_token, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/api/v1/app/{app_id}/events/subscription/{subscription_id}/create_token'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'subscription_id' + '}', CGI.escape(subscription_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'])
+      header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MessageSubscriberAuthTokenOut'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"MessageApi.v1_message_events_subscription_create_token",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MessageApi#v1_message_events_subscription_create_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    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.
     # @param app_id [String] The app&#39;s ID or UID

data/lib/svix/api/streams_api.rb

@@ -0,0 +1,185 @@
+=begin
+#Svix API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.1.1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.2.0
+
+=end
+
+require 'cgi'
+
+module Svix
+  class StreamsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Append To Stream
+    # Creates streaming events.
+    # @param app_id [String] The app's ID or UID
+    # @param create_stream_in [CreateStreamIn] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key The request's idempotency key
+    # @return [nil]
+    def append_to_stream(app_id, create_stream_in, opts = {})
+      append_to_stream_with_http_info(app_id, create_stream_in, opts)
+      nil
+    end
+
+    # Append To Stream
+    # Creates streaming events.
+    # @param app_id [String] The app's ID or UID
+    # @param create_stream_in [CreateStreamIn] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key The request's idempotency key
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def append_to_stream_with_http_info(app_id, create_stream_in, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StreamsApi.append_to_stream ...'
+      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 StreamsApi.append_to_stream"
+      end
+      if @api_client.config.client_side_validation && app_id.to_s.length > 256
+        fail ArgumentError, 'invalid value for "app_id" when calling StreamsApi.append_to_stream, 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 StreamsApi.append_to_stream, 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 StreamsApi.append_to_stream, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'create_stream_in' is set
+      if @api_client.config.client_side_validation && create_stream_in.nil?
+        fail ArgumentError, "Missing the required parameter 'create_stream_in' when calling StreamsApi.append_to_stream"
+      end
+      # resource path
+      local_var_path = '/api/v1/app/{app_id}/stream'.sub('{' + 'app_id' + '}', CGI.escape(app_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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(create_stream_in)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"StreamsApi.append_to_stream",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StreamsApi#append_to_stream\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List Stream
+    # List streaming events.
+    # @param app_id [String] The app&#39;s ID or UID
+    # @param [Hash] opts the optional parameters
+    # @return [ListResponseEventOut]
+    def list_stream(app_id, opts = {})
+      data, _status_code, _headers = list_stream_with_http_info(app_id, opts)
+      data
+    end
+
+    # List Stream
+    # List streaming events.
+    # @param app_id [String] The app&#39;s ID or UID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ListResponseEventOut, Integer, Hash)>] ListResponseEventOut data, response status code and response headers
+    def list_stream_with_http_info(app_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StreamsApi.list_stream ...'
+      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 StreamsApi.list_stream"
+      end
+      if @api_client.config.client_side_validation && app_id.to_s.length > 256
+        fail ArgumentError, 'invalid value for "app_id" when calling StreamsApi.list_stream, 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 StreamsApi.list_stream, 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 StreamsApi.list_stream, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/api/v1/app/{app_id}/stream'.sub('{' + 'app_id' + '}', CGI.escape(app_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] || 'ListResponseEventOut'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"StreamsApi.list_stream",
+        :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: StreamsApi#list_stream\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end