svix 1.44.0 → 1.45.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bb8f1f741bd9fbb3cf5dc2cc8b2bb54df6204be348067f17c27c3ab60db2b84
-  data.tar.gz: 17c2be082a1ee07687fb0156687cfe3739006d7ba9845b1da20dcb481bb5b9aa
+  metadata.gz: 6dfa58771ff2660a3ec8b28179dea7829356a30fb2360c7998925fc2dce244d5
+  data.tar.gz: ffea24392bfeb1823fd2234f544dbdfadaf42f28d455f0f2f7c54a92dd581ce1
 SHA512:
-  metadata.gz: c6aa1d2390a49e73385371b255641361db4f67578777f8f2c15f2cd384314642a7b6e6dee86dc8cbbe260cda8a375e2a16212edb41d147195a8aa613e5425ea8
-  data.tar.gz: 335f718d8bb4a1a09de18c1743f1b0d6a86337b82715fca9ba9c638ec45659f8f28e38dbb0757b576dd73b5a74e54413a08433b0a86eceb71767d4da0389e274
+  metadata.gz: 7df9201dc2db2c06513f9c28ef7c459cfe21213c6c947c71b6b93648e6675e1b3bee9129ee5357399e3d99ad53c0f345e8d5a1aaa6d8e32e9b30bac756adb94b
+  data.tar.gz: 636f35b89938ef7195d0b835aa1aaa9977ca001f0afc908d0c47a8a9a63da0153c9444d24976888f85d5d519bf28312fa2b10831b9448d72fd218bd7ebf1edd4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    svix (1.44.0)
+    svix (1.45.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/svix/api/application_api.rb

@@ -21,11 +21,11 @@ module Svix
     end
     # Get App Usage Stats
     # Get basic statistics for all applications.
-    # @param since [Time] Filter the range to data after this date
-    # @param _until [Time] Filter the range to data before this date
+    # @param since [Time] Filter the range to data after this date.
+    # @param _until [Time] Filter the range to data before this date.
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :limit Limit the number of returned items (default to 50)
-    # @option opts [String] :iterator The iterator to use (depends on the chosen ordering)
+    # @option opts [Integer] :limit Limit the number of returned items. (default to 50)
+    # @option opts [String] :iterator The iterator to use (depends on the chosen ordering).
     # @return [ListResponseApplicationStats]
     def get_app_usage_stats_api_v1_app_stats_usage_get(since, _until, opts = {})
       data, _status_code, _headers = get_app_usage_stats_api_v1_app_stats_usage_get_with_http_info(since, _until, opts)
@@ -34,11 +34,11 @@ module Svix
 
     # Get App Usage Stats
     # Get basic statistics for all applications.
-    # @param since [Time] Filter the range to data after this date
-    # @param _until [Time] Filter the range to data before this date
+    # @param since [Time] Filter the range to data after this date.
+    # @param _until [Time] Filter the range to data before this date.
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :limit Limit the number of returned items (default to 50)
-    # @option opts [String] :iterator The iterator to use (depends on the chosen ordering)
+    # @option opts [Integer] :limit Limit the number of returned items. (default to 50)
+    # @option opts [String] :iterator The iterator to use (depends on the chosen ordering).
     # @return [Array<(ListResponseApplicationStats, Integer, Hash)>] ListResponseApplicationStats data, response status code and response headers
     def get_app_usage_stats_api_v1_app_stats_usage_get_with_http_info(since, _until, opts = {})
       if @api_client.config.debugging
@@ -327,9 +327,9 @@ module Svix
     end
 
     # Get App Stats
-    # Get basic statistics for the application
-    # @param since [Time] Filter the range to data starting from this date
-    # @param _until [Time] Filter the range to data ending by this date
+    # Get basic statistics for the application.
+    # @param since [Time] Filter the range to data starting from this date.
+    # @param _until [Time] Filter the range to data ending by this date.
     # @param app_id [String] The app&#39;s ID or UID
     # @param [Hash] opts the optional parameters
     # @return [ApplicationStats]
@@ -339,9 +339,9 @@ module Svix
     end
 
     # Get App Stats
-    # Get basic statistics for the application
-    # @param since [Time] Filter the range to data starting from this date
-    # @param _until [Time] Filter the range to data ending by this date
+    # Get basic statistics for the application.
+    # @param since [Time] Filter the range to data starting from this date.
+    # @param _until [Time] Filter the range to data ending by this date.
     # @param app_id [String] The app&#39;s ID or UID
     # @param [Hash] opts the optional parameters
     # @return [Array<(ApplicationStats, Integer, Hash)>] ApplicationStats data, response status code and response headers

data/lib/svix/api/authentication_api.rb

@@ -279,7 +279,7 @@ module Svix
     end
 
     # Exchange One Time Token
-    # This is a one time token
+    # This is a one time token.
     # @param one_time_token_in [OneTimeTokenIn] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request's idempotency key
@@ -290,7 +290,7 @@ module Svix
     end
 
     # Exchange One Time Token
-    # This is a one time token
+    # This is a one time token.
     # @param one_time_token_in [OneTimeTokenIn] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request's idempotency key
@@ -350,7 +350,7 @@ module Svix
     end
 
     # Expire All
-    # Expire all of the tokens associated with a specific Application
+    # Expire all of the tokens associated with a specific application.
     # @param app_id [String] The app's ID or UID
     # @param application_token_expire_in [ApplicationTokenExpireIn] 
     # @param [Hash] opts the optional parameters
@@ -362,7 +362,7 @@ module Svix
     end
 
     # Expire All
-    # Expire all of the tokens associated with a specific Application
+    # Expire all of the tokens associated with a specific application.
     # @param app_id [String] The app's ID or UID
     # @param application_token_expire_in [ApplicationTokenExpireIn] 
     # @param [Hash] opts the optional parameters
@@ -439,6 +439,101 @@ module Svix
       return data, status_code, headers
     end
 
+    # Get Poller Token
+    # Get the current auth token for the poller.
+    # @param app_id [String] The app's ID or UID
+    # @param endpoint_id [String] The ep's ID or UID
+    # @param [Hash] opts the optional parameters
+    # @return [AuthTokenOut]
+    def v1_authentication_get_poller_token(app_id, endpoint_id, opts = {})
+      data, _status_code, _headers = v1_authentication_get_poller_token_with_http_info(app_id, endpoint_id, opts)
+      data
+    end
+
+    # Get Poller Token
+    # Get the current auth token for the poller.
+    # @param app_id [String] The app's ID or UID
+    # @param endpoint_id [String] The ep's ID or UID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AuthTokenOut, Integer, Hash)>] AuthTokenOut data, response status code and response headers
+    def v1_authentication_get_poller_token_with_http_info(app_id, endpoint_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthenticationApi.v1_authentication_get_poller_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_get_poller_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_get_poller_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_get_poller_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_get_poller_token, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'endpoint_id' is set
+      if @api_client.config.client_side_validation && endpoint_id.nil?
+        fail ArgumentError, "Missing the required parameter 'endpoint_id' when calling AuthenticationApi.v1_authentication_get_poller_token"
+      end
+      if @api_client.config.client_side_validation && endpoint_id.to_s.length > 256
+        fail ArgumentError, 'invalid value for "endpoint_id" when calling AuthenticationApi.v1_authentication_get_poller_token, the character length must be smaller than or equal to 256.'
+      end
+
+      if @api_client.config.client_side_validation && endpoint_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "endpoint_id" when calling AuthenticationApi.v1_authentication_get_poller_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 && endpoint_id !~ pattern
+        fail ArgumentError, "invalid value for 'endpoint_id' when calling AuthenticationApi.v1_authentication_get_poller_token, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/api/v1/auth/app/{app_id}/poller/{endpoint_id}/token'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'endpoint_id' + '}', CGI.escape(endpoint_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']) 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] || 'AuthTokenOut'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"AuthenticationApi.v1_authentication_get_poller_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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AuthenticationApi#v1_authentication_get_poller_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Logout
     # Logout an app token.  Trying to log out other tokens will fail.
     # @param [Hash] opts the optional parameters
@@ -498,5 +593,114 @@ module Svix
       end
       return data, status_code, headers
     end
+
+    # Rotate Poller Token
+    # Create a new auth token that can for the poller API.
+    # @param app_id [String] The app&#39;s ID or UID
+    # @param endpoint_id [String] The ep&#39;s ID or UID
+    # @param rotate_poller_token_in [RotatePollerTokenIn] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key The request&#39;s idempotency key
+    # @return [AuthTokenOut]
+    def v1_authentication_rotate_poller_token(app_id, endpoint_id, rotate_poller_token_in, opts = {})
+      data, _status_code, _headers = v1_authentication_rotate_poller_token_with_http_info(app_id, endpoint_id, rotate_poller_token_in, opts)
+      data
+    end
+
+    # Rotate Poller Token
+    # Create a new auth token that can for the poller API.
+    # @param app_id [String] The app&#39;s ID or UID
+    # @param endpoint_id [String] The ep&#39;s ID or UID
+    # @param rotate_poller_token_in [RotatePollerTokenIn] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key The request&#39;s idempotency key
+    # @return [Array<(AuthTokenOut, Integer, Hash)>] AuthTokenOut data, response status code and response headers
+    def v1_authentication_rotate_poller_token_with_http_info(app_id, endpoint_id, rotate_poller_token_in, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthenticationApi.v1_authentication_rotate_poller_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_rotate_poller_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_rotate_poller_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_rotate_poller_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_rotate_poller_token, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'endpoint_id' is set
+      if @api_client.config.client_side_validation && endpoint_id.nil?
+        fail ArgumentError, "Missing the required parameter 'endpoint_id' when calling AuthenticationApi.v1_authentication_rotate_poller_token"
+      end
+      if @api_client.config.client_side_validation && endpoint_id.to_s.length > 256
+        fail ArgumentError, 'invalid value for "endpoint_id" when calling AuthenticationApi.v1_authentication_rotate_poller_token, the character length must be smaller than or equal to 256.'
+      end
+
+      if @api_client.config.client_side_validation && endpoint_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "endpoint_id" when calling AuthenticationApi.v1_authentication_rotate_poller_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 && endpoint_id !~ pattern
+        fail ArgumentError, "invalid value for 'endpoint_id' when calling AuthenticationApi.v1_authentication_rotate_poller_token, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'rotate_poller_token_in' is set
+      if @api_client.config.client_side_validation && rotate_poller_token_in.nil?
+        fail ArgumentError, "Missing the required parameter 'rotate_poller_token_in' when calling AuthenticationApi.v1_authentication_rotate_poller_token"
+      end
+      # resource path
+      local_var_path = '/api/v1/auth/app/{app_id}/poller/{endpoint_id}/token/rotate'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'endpoint_id' + '}', CGI.escape(endpoint_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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+      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(rotate_poller_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_rotate_poller_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_rotate_poller_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/svix/api/background_tasks_api.rb

@@ -85,8 +85,8 @@ module Svix
     # List Background Tasks
     # List background tasks executed in the past 90 days.
     # @param [Hash] opts the optional parameters
-    # @option opts [BackgroundTaskStatus] :status Filter the response based on the status
-    # @option opts [BackgroundTaskType] :task Filter the response based on the type
+    # @option opts [BackgroundTaskStatus] :status Filter the response based on the status.
+    # @option opts [BackgroundTaskType] :task Filter the response based on the type.
     # @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
@@ -99,8 +99,8 @@ module Svix
     # List Background Tasks
     # List background tasks executed in the past 90 days.
     # @param [Hash] opts the optional parameters
-    # @option opts [BackgroundTaskStatus] :status Filter the response based on the status
-    # @option opts [BackgroundTaskType] :task Filter the response based on the type
+    # @option opts [BackgroundTaskStatus] :status Filter the response based on the status.
+    # @option opts [BackgroundTaskType] :task Filter the response based on the type.
     # @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

data/lib/svix/api/broadcast_api.rb

@@ -20,7 +20,7 @@ module Svix
       @api_client = api_client
     end
     # Create Broadcast Message
-    # Creates a background task to send the same message to each application in your organization
+    # Creates a background task to send the same message to each application in your organization.
     # @param message_broadcast_in [MessageBroadcastIn] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request's idempotency key
@@ -31,7 +31,7 @@ module Svix
     end
 
     # Create Broadcast Message
-    # Creates a background task to send the same message to each application in your organization
+    # Creates a background task to send the same message to each application in your organization.
     # @param message_broadcast_in [MessageBroadcastIn] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request's idempotency key