svix 1.15.0 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a606b32c5ca79a0d0ccb3b18d578ec53a1a1f55cf324b22861148fe71af8041c
-  data.tar.gz: 7f31beb1b6ee11d0c9a76541a2997fb5e9b43dfae62f5e70e41d1e8f2ce12427
+  metadata.gz: af99d60754c708dc656f1b76db700927a11ddc7fc962d1487d9ceffea8aa7f16
+  data.tar.gz: 73740a06e1d1c076759fa5a27fae9da4602af40025a76eda69349e26f377cdfe
 SHA512:
-  metadata.gz: 2a14e95930d3df9d4625f102acc46d41d010fbd60795a95a38d2e36438bb8c36eeaa56840bb3896bb506df177b795f75a91c83f7cab1d4154a9b34de354afb07
-  data.tar.gz: 9798437a428c55b80863d9090f7db80091cd36ccf18a4c04159729b985c78ebad94ed3a3189eadd231d24db8906eeb09bbb6c7d22b79d8fdb5ea7f514fe4a7d4
+  metadata.gz: 320643c346d8dc0f495f53744785c2bc7abe1b71ea4d9a1ad2b5618602b027c417563c0cec2195e9e584330f3fd26796e2e63d776d169e92bb423520b9f077dd
+  data.tar.gz: cf7452898da4e5a34873e150a969aa7759804b736059a7a83774a1d3c8863cd8e707378b68a5272a123fba43b13c0660df8500033d9e1c518fe369cca490db38

data/Gemfile.lock

@@ -1,16 +1,16 @@
 PATH
   remote: .
   specs:
-    svix (1.15.0)
+    svix (1.16.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.4.4)
-    ethon (0.14.0)
+    ethon (0.16.0)
       ffi (>= 1.15.0)
-    ffi (1.15.1)
+    ffi (1.16.3)
     rake (13.0.6)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -29,7 +29,7 @@ GEM
       ethon (>= 0.9.0)
 
 PLATFORMS
-  ruby
+  x86_64-linux
 
 DEPENDENCIES
   bundler (>= 2.2.10)
@@ -38,4 +38,4 @@ DEPENDENCIES
   svix!
 
 BUNDLED WITH
-   2.2.33
+   2.4.22

data/lib/svix/api/environment_api.rb

@@ -21,29 +21,23 @@ module Svix
     end
     # Export Environment Configuration
     # Download a JSON file containing all org-settings and event types
-    # @param body [Object] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request's idempotency key
     # @return [EnvironmentOut]
-    def v1_environment_export(body, opts = {})
-      data, _status_code, _headers = v1_environment_export_with_http_info(body, opts)
+    def v1_environment_export(opts = {})
+      data, _status_code, _headers = v1_environment_export_with_http_info(opts)
       data
     end
 
     # Export Environment Configuration
     # Download a JSON file containing all org-settings and event types
-    # @param body [Object] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request's idempotency key
     # @return [Array<(EnvironmentOut, Integer, Hash)>] EnvironmentOut data, response status code and response headers
-    def v1_environment_export_with_http_info(body, opts = {})
+    def v1_environment_export_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: EnvironmentApi.v1_environment_export ...'
       end
-      # verify the required parameter 'body' is set
-      if @api_client.config.client_side_validation && body.nil?
-        fail ArgumentError, "Missing the required parameter 'body' when calling EnvironmentApi.v1_environment_export"
-      end
       # resource path
       local_var_path = '/api/v1/environment/export/'
 
@@ -54,15 +48,13 @@ module Svix
       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(body)
+      post_body = opts[:debug_body]
 
       # return_type
       return_type = opts[:debug_return_type] || 'EnvironmentOut'
@@ -87,6 +79,63 @@ module Svix
       return data, status_code, headers
     end
 
+    # Export Environment Configuration
+    # Download a JSON file containing all org-settings and event types
+    # @param [Hash] opts the optional parameters
+    # @return [EnvironmentOut]
+    def v1_environment_export_get(opts = {})
+      data, _status_code, _headers = v1_environment_export_get_with_http_info(opts)
+      data
+    end
+
+    # Export Environment Configuration
+    # Download a JSON file containing all org-settings and event types
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EnvironmentOut, Integer, Hash)>] EnvironmentOut data, response status code and response headers
+    def v1_environment_export_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EnvironmentApi.v1_environment_export_get ...'
+      end
+      # resource path
+      local_var_path = '/api/v1/environment/export/'
+
+      # 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] || 'EnvironmentOut'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"EnvironmentApi.v1_environment_export_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: EnvironmentApi#v1_environment_export_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Import Environment Configuration
     # Import a configuration into the active organization. It doesn't delete anything, only adds/updates what was passed to it.
     # @param environment_in [EnvironmentIn] 

data/lib/svix/api/event_type_api.rb

@@ -362,6 +362,78 @@ module Svix
       return data, status_code, headers
     end
 
+    # Get Retry Schedule
+    # Gets the retry schedule for messages using the given event type
+    # @param event_type_name [String] The event type's name
+    # @param [Hash] opts the optional parameters
+    # @return [RetryScheduleInOut]
+    def v1_event_type_get_retry_schedule(event_type_name, opts = {})
+      data, _status_code, _headers = v1_event_type_get_retry_schedule_with_http_info(event_type_name, opts)
+      data
+    end
+
+    # Get Retry Schedule
+    # Gets the retry schedule for messages using the given event type
+    # @param event_type_name [String] The event type's name
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RetryScheduleInOut, Integer, Hash)>] RetryScheduleInOut data, response status code and response headers
+    def v1_event_type_get_retry_schedule_with_http_info(event_type_name, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EventTypeApi.v1_event_type_get_retry_schedule ...'
+      end
+      # verify the required parameter 'event_type_name' is set
+      if @api_client.config.client_side_validation && event_type_name.nil?
+        fail ArgumentError, "Missing the required parameter 'event_type_name' when calling EventTypeApi.v1_event_type_get_retry_schedule"
+      end
+      if @api_client.config.client_side_validation && event_type_name.to_s.length > 256
+        fail ArgumentError, 'invalid value for "event_type_name" when calling EventTypeApi.v1_event_type_get_retry_schedule, 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 && event_type_name !~ pattern
+        fail ArgumentError, "invalid value for 'event_type_name' when calling EventTypeApi.v1_event_type_get_retry_schedule, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/api/v1/event-type/{event_type_name}/retry-schedule/'.sub('{' + 'event_type_name' + '}', CGI.escape(event_type_name.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] || 'RetryScheduleInOut'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"EventTypeApi.v1_event_type_get_retry_schedule",
+        :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: EventTypeApi#v1_event_type_get_retry_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Event Type Import From Openapi
     # Given an OpenAPI spec, create new or update existing event types. If an existing `archived` event type is updated, it will be unarchvied.  The importer will convert all webhooks found in the either the `webhooks` or `x-webhooks` top-level.
     # @param event_type_import_open_api_in [EventTypeImportOpenApiIn] Import a list of event types from webhooks defined in an OpenAPI spec.  The OpenAPI spec can be specified as either &#x60;spec&#x60; given the spec as a JSON object, or as &#x60;specRaw&#x60; (a &#x60;string&#x60;) which will be parsed as YAML or JSON by the server. Sending neither or both is invalid, resulting in a &#x60;400&#x60; **Bad Request**.
@@ -678,5 +750,85 @@ module Svix
       end
       return data, status_code, headers
     end
+
+    # Update Retry Schedule
+    # Sets a retry schedule for all messages using the given event type
+    # @param event_type_name [String] The event type&#39;s name
+    # @param retry_schedule_in_out [RetryScheduleInOut] 
+    # @param [Hash] opts the optional parameters
+    # @return [RetryScheduleInOut]
+    def v1_event_type_update_retry_schedule(event_type_name, retry_schedule_in_out, opts = {})
+      data, _status_code, _headers = v1_event_type_update_retry_schedule_with_http_info(event_type_name, retry_schedule_in_out, opts)
+      data
+    end
+
+    # Update Retry Schedule
+    # Sets a retry schedule for all messages using the given event type
+    # @param event_type_name [String] The event type&#39;s name
+    # @param retry_schedule_in_out [RetryScheduleInOut] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RetryScheduleInOut, Integer, Hash)>] RetryScheduleInOut data, response status code and response headers
+    def v1_event_type_update_retry_schedule_with_http_info(event_type_name, retry_schedule_in_out, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EventTypeApi.v1_event_type_update_retry_schedule ...'
+      end
+      # verify the required parameter 'event_type_name' is set
+      if @api_client.config.client_side_validation && event_type_name.nil?
+        fail ArgumentError, "Missing the required parameter 'event_type_name' when calling EventTypeApi.v1_event_type_update_retry_schedule"
+      end
+      if @api_client.config.client_side_validation && event_type_name.to_s.length > 256
+        fail ArgumentError, 'invalid value for "event_type_name" when calling EventTypeApi.v1_event_type_update_retry_schedule, 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 && event_type_name !~ pattern
+        fail ArgumentError, "invalid value for 'event_type_name' when calling EventTypeApi.v1_event_type_update_retry_schedule, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'retry_schedule_in_out' is set
+      if @api_client.config.client_side_validation && retry_schedule_in_out.nil?
+        fail ArgumentError, "Missing the required parameter 'retry_schedule_in_out' when calling EventTypeApi.v1_event_type_update_retry_schedule"
+      end
+      # resource path
+      local_var_path = '/api/v1/event-type/{event_type_name}/retry-schedule/'.sub('{' + 'event_type_name' + '}', CGI.escape(event_type_name.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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(retry_schedule_in_out)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'RetryScheduleInOut'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"EventTypeApi.v1_event_type_update_retry_schedule",
+        :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(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EventTypeApi#v1_event_type_update_retry_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/svix/api/inbound_api.rb

@@ -0,0 +1,206 @@
+=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 InboundApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Handle Inbound
+    # Handles a raw inbound webhook for the application.
+    # @param app_id [String] The app's ID or UID
+    # @param inbound_token [String] 
+    # @param body [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :event_type The event type's name
+    # @option opts [String] :idempotency_key The request's idempotency key
+    # @return [MessageOut]
+    def v1_inbound_msg(app_id, inbound_token, body, opts = {})
+      data, _status_code, _headers = v1_inbound_msg_with_http_info(app_id, inbound_token, body, opts)
+      data
+    end
+
+    # Handle Inbound
+    # Handles a raw inbound webhook for the application.
+    # @param app_id [String] The app's ID or UID
+    # @param inbound_token [String] 
+    # @param body [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :event_type The event type's name
+    # @option opts [String] :idempotency_key The request's idempotency key
+    # @return [Array<(MessageOut, Integer, Hash)>] MessageOut data, response status code and response headers
+    def v1_inbound_msg_with_http_info(app_id, inbound_token, body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboundApi.v1_inbound_msg ...'
+      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 InboundApi.v1_inbound_msg"
+      end
+      if @api_client.config.client_side_validation && app_id.to_s.length > 256
+        fail ArgumentError, 'invalid value for "app_id" when calling InboundApi.v1_inbound_msg, 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 InboundApi.v1_inbound_msg, 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 InboundApi.v1_inbound_msg, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'inbound_token' is set
+      if @api_client.config.client_side_validation && inbound_token.nil?
+        fail ArgumentError, "Missing the required parameter 'inbound_token' when calling InboundApi.v1_inbound_msg"
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling InboundApi.v1_inbound_msg"
+      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 InboundApi.v1_inbound_msg, 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 InboundApi.v1_inbound_msg, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/api/v1/app/{app_id}/inbound/msg/{inbound_token}/'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'inbound_token' + '}', CGI.escape(inbound_token.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'event_type'] = opts[:'event_type'] if !opts[:'event_type'].nil?
+
+      # 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(['text/plain; charset=utf-8'])
+      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(body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MessageOut'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"InboundApi.v1_inbound_msg",
+        :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: InboundApi#v1_inbound_msg\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Rotate Url
+    # Invalidates the previous inbound url (if one exists), producing a new inbound URL for this app
+    # @param app_id [String] The app&#39;s ID or UID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key The request&#39;s idempotency key
+    # @return [RotatedUrlOut]
+    def v1_inbound_rotate_url(app_id, opts = {})
+      data, _status_code, _headers = v1_inbound_rotate_url_with_http_info(app_id, opts)
+      data
+    end
+
+    # Rotate Url
+    # Invalidates the previous inbound url (if one exists), producing a new inbound URL for this app
+    # @param app_id [String] The app&#39;s ID or UID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key The request&#39;s idempotency key
+    # @return [Array<(RotatedUrlOut, Integer, Hash)>] RotatedUrlOut data, response status code and response headers
+    def v1_inbound_rotate_url_with_http_info(app_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboundApi.v1_inbound_rotate_url ...'
+      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 InboundApi.v1_inbound_rotate_url"
+      end
+      if @api_client.config.client_side_validation && app_id.to_s.length > 256
+        fail ArgumentError, 'invalid value for "app_id" when calling InboundApi.v1_inbound_rotate_url, 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 InboundApi.v1_inbound_rotate_url, 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 InboundApi.v1_inbound_rotate_url, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/api/v1/app/{app_id}/inbound/rotate-url/'.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'])
+      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] || 'RotatedUrlOut'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"InboundApi.v1_inbound_rotate_url",
+        :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: InboundApi#v1_inbound_rotate_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/svix/api/message_api.rb

@@ -628,5 +628,101 @@ module Svix
       end
       return data, status_code, headers
     end
+
+    # Stream Events
+    # Reads the stream of created messages for an application
+    # @param app_id [String] The app'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
+    # @return [MessageStreamOut]
+    def v1_message_stream(app_id, opts = {})
+      data, _status_code, _headers = v1_message_stream_with_http_info(app_id, opts)
+      data
+    end
+
+    # Stream Events
+    # 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
+    # @return [Array<(MessageStreamOut, Integer, Hash)>] MessageStreamOut data, response status code and response headers
+    def v1_message_stream_with_http_info(app_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MessageApi.v1_message_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 MessageApi.v1_message_stream"
+      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_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 MessageApi.v1_message_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 MessageApi.v1_message_stream, 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_stream, 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_stream, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/api/v1/app/{app_id}/events/'.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[:'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?
+
+      # 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_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: MessageApi#v1_message_stream\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/svix/api/message_attempt_api.rb

@@ -580,7 +580,7 @@ module Svix
     # @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 `true` attempt content is included in the response (default to true)
-    # @option opts [Boolean] :with_msg  (default to false)
+    # @option opts [Boolean] :with_msg When `true`, the message information is included in the response (default to false)
     # @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 = {})
@@ -601,7 +601,7 @@ module Svix
     # @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 [Boolean] :with_msg 
+    # @option opts [Boolean] :with_msg When &#x60;true&#x60;, the message information 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 = {})