svix 1.24.0 → 1.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ccf861a161a61299e676c576187fdf2ecf7a748eba371ced72182b66ab1e5e3
-  data.tar.gz: 4164060536e9f5f349e9111aed010bb0d2ffec043a036e32239285fea3b3f5bc
+  metadata.gz: 137159e57b6b673d13577f4f6707cacb923cc9c31f00280487d5877073eec8b5
+  data.tar.gz: a4a8cfbf51502fee0f60119fa61305c83286130295c75db822fd55f76c4fd082
 SHA512:
-  metadata.gz: ecc7d97006a0d3f9446377fc096c43fdca661a1c00a96685d8f62a5afbd67e9a18d2e544b0fcca0c1c669997042527942a01a911a3727813d60c8ee72a2c2350
-  data.tar.gz: 603bcebef98e16a838afed4849d0673f8cffee4c7239a51a90032b6e3b0959223c7140be60679cd165bdc51b4201266f4e01d1781e17ddc9f6cea74e8829daa6
+  metadata.gz: d511f01e9d2d071d878f859d3ebfc363158930c1f30b470a729d381087a12a7e55c61c47bf07c7a1394a24c102a52a9ac9ec1d45d34fe721287fba280478070b
+  data.tar.gz: 23ef12bff4592bc625826d993852144052b9d9915aa9d3fa973a49527fe1a2d3583233ab169b11058a6363593647bf72e8d768482791b3bec417329d0f510182

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    svix (1.24.0)
+    svix (1.26.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
@@ -10,7 +10,7 @@ GEM
     diff-lcs (1.4.4)
     ethon (0.16.0)
       ffi (>= 1.15.0)
-    ffi (1.16.3)
+    ffi (1.17.0)
     rake (13.0.6)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)

data/lib/svix/api/authentication_api.rb

@@ -106,6 +106,93 @@ module Svix
       return data, status_code, headers
     end
 
+    # Create Cmg Token
+    # Create a new access token that only allows creating messages inside this application.
+    # @param app_id [String] The app's ID or UID
+    # @param create_message_token_in [CreateMessageTokenIn] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key The request's idempotency key
+    # @return [AuthTokenOut]
+    def v1_authentication_create_message_token(app_id, create_message_token_in, opts = {})
+      data, _status_code, _headers = v1_authentication_create_message_token_with_http_info(app_id, create_message_token_in, opts)
+      data
+    end
+
+    # Create Cmg Token
+    # Create a new access token that only allows creating messages inside this application.
+    # @param app_id [String] The app's ID or UID
+    # @param create_message_token_in [CreateMessageTokenIn] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key The request's idempotency key
+    # @return [Array<(AuthTokenOut, Integer, Hash)>] AuthTokenOut data, response status code and response headers
+    def v1_authentication_create_message_token_with_http_info(app_id, create_message_token_in, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthenticationApi.v1_authentication_create_message_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 AuthenticationApi.v1_authentication_create_message_token"
+      end
+      if @api_client.config.client_side_validation && app_id.to_s.length > 256
+        fail ArgumentError, 'invalid value for "app_id" when calling AuthenticationApi.v1_authentication_create_message_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 AuthenticationApi.v1_authentication_create_message_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 AuthenticationApi.v1_authentication_create_message_token, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'create_message_token_in' is set
+      if @api_client.config.client_side_validation && create_message_token_in.nil?
+        fail ArgumentError, "Missing the required parameter 'create_message_token_in' when calling AuthenticationApi.v1_authentication_create_message_token"
+      end
+      # resource path
+      local_var_path = '/api/v1/auth/app/{app_id}/create-message-token'.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_message_token_in)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AuthTokenOut'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"AuthenticationApi.v1_authentication_create_message_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: AuthenticationApi#v1_authentication_create_message_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Dashboard Access
     # DEPRECATED: Please use `app-portal-access` instead.  Use this function to get magic links (and authentication codes) for connecting your users to the Consumer Application Portal.
     # @param app_id [String] The app&#39;s ID or UID

data/lib/svix/api/endpoint_api.rb

@@ -1395,7 +1395,7 @@ module Svix
     end
 
     # Send Event Type Example Message
-    # Send an example message for event
+    # Send an example message for an event
     # @param app_id [String] The app's ID or UID
     # @param endpoint_id [String] The ep's ID or UID
     # @param event_example_in [EventExampleIn] 
@@ -1408,7 +1408,7 @@ module Svix
     end
 
     # Send Event Type Example Message
-    # Send an example message for event
+    # Send an example message for an event
     # @param app_id [String] The app's ID or UID
     # @param endpoint_id [String] The ep's ID or UID
     # @param event_example_in [EventExampleIn] 
@@ -2215,5 +2215,280 @@ module Svix
       end
       return data, status_code, headers
     end
+
+    # Create Sink
+    # Create a new sink for the application.
+    # @param app_id [String] The app's ID or UID
+    # @param sink_in [SinkIn] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key The request's idempotency key
+    # @return [SinkOut]
+    def v1_sink_create(app_id, sink_in, opts = {})
+      data, _status_code, _headers = v1_sink_create_with_http_info(app_id, sink_in, opts)
+      data
+    end
+
+    # Create Sink
+    # Create a new sink for the application.
+    # @param app_id [String] The app's ID or UID
+    # @param sink_in [SinkIn] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key The request's idempotency key
+    # @return [Array<(SinkOut, Integer, Hash)>] SinkOut data, response status code and response headers
+    def v1_sink_create_with_http_info(app_id, sink_in, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EndpointApi.v1_sink_create ...'
+      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 EndpointApi.v1_sink_create"
+      end
+      if @api_client.config.client_side_validation && app_id.to_s.length > 256
+        fail ArgumentError, 'invalid value for "app_id" when calling EndpointApi.v1_sink_create, 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 EndpointApi.v1_sink_create, 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 EndpointApi.v1_sink_create, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'sink_in' is set
+      if @api_client.config.client_side_validation && sink_in.nil?
+        fail ArgumentError, "Missing the required parameter 'sink_in' when calling EndpointApi.v1_sink_create"
+      end
+      # resource path
+      local_var_path = '/api/v1/app/{app_id}/sink'.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(sink_in)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SinkOut'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"EndpointApi.v1_sink_create",
+        :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: EndpointApi#v1_sink_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Sink
+    # Get a sink.
+    # @param app_id [String] The app&#39;s ID or UID
+    # @param sink_id [String] The ep&#39;s ID or UID
+    # @param [Hash] opts the optional parameters
+    # @return [SinkOut]
+    def v1_sink_get(app_id, sink_id, opts = {})
+      data, _status_code, _headers = v1_sink_get_with_http_info(app_id, sink_id, opts)
+      data
+    end
+
+    # Get Sink
+    # Get a sink.
+    # @param app_id [String] The app&#39;s ID or UID
+    # @param sink_id [String] The ep&#39;s ID or UID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SinkOut, Integer, Hash)>] SinkOut data, response status code and response headers
+    def v1_sink_get_with_http_info(app_id, sink_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EndpointApi.v1_sink_get ...'
+      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 EndpointApi.v1_sink_get"
+      end
+      if @api_client.config.client_side_validation && app_id.to_s.length > 256
+        fail ArgumentError, 'invalid value for "app_id" when calling EndpointApi.v1_sink_get, 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 EndpointApi.v1_sink_get, 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 EndpointApi.v1_sink_get, 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 EndpointApi.v1_sink_get"
+      end
+      if @api_client.config.client_side_validation && sink_id.to_s.length > 256
+        fail ArgumentError, 'invalid value for "sink_id" when calling EndpointApi.v1_sink_get, 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 EndpointApi.v1_sink_get, 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 EndpointApi.v1_sink_get, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/api/v1/app/{app_id}/sink/{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] || {}
+
+      # 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] || 'SinkOut'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"EndpointApi.v1_sink_get",
+        :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: EndpointApi#v1_sink_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List Sinks
+    # List the application's sinks.
+    # @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 [Ordering] :order The sorting order of the returned items
+    # @return [ListResponseSinkOut]
+    def v1_sink_list(app_id, opts = {})
+      data, _status_code, _headers = v1_sink_list_with_http_info(app_id, opts)
+      data
+    end
+
+    # List Sinks
+    # List the application&#39;s sinks.
+    # @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 [Ordering] :order The sorting order of the returned items
+    # @return [Array<(ListResponseSinkOut, Integer, Hash)>] ListResponseSinkOut data, response status code and response headers
+    def v1_sink_list_with_http_info(app_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EndpointApi.v1_sink_list ...'
+      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 EndpointApi.v1_sink_list"
+      end
+      if @api_client.config.client_side_validation && app_id.to_s.length > 256
+        fail ArgumentError, 'invalid value for "app_id" when calling EndpointApi.v1_sink_list, 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 EndpointApi.v1_sink_list, 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 EndpointApi.v1_sink_list, 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 EndpointApi.v1_sink_list, 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 EndpointApi.v1_sink_list, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/api/v1/app/{app_id}/sink'.sub('{' + 'app_id' + '}', CGI.escape(app_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[:'order'] = opts[:'order'] if !opts[:'order'].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] || 'ListResponseSinkOut'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"EndpointApi.v1_sink_list",
+        :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: EndpointApi#v1_sink_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/svix/api/events_api.rb

@@ -27,7 +27,7 @@ module Svix
     # @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]
+    # @return [MessageEventsOut]
     def v1_events(opts = {})
       data, _status_code, _headers = v1_events_with_http_info(opts)
       data
@@ -41,7 +41,7 @@ module Svix
     # @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
+    # @return [Array<(MessageEventsOut, Integer, Hash)>] MessageEventsOut data, response status code and response headers
     def v1_events_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: EventsApi.v1_events ...'
@@ -77,7 +77,7 @@ module Svix
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'MessageStreamOut'
+      return_type = opts[:debug_return_type] || 'MessageEventsOut'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['HTTPBearer']