svix 0.83.1 → 0.84.1

data/lib/svix/api/statistics_api.rb

@@ -3,7 +3,7 @@
 
 #Welcome to the Svix API documentation!  Useful links: [Homepage](https://www.svix.com) | [Support email](mailto:support+docs@svix.com) | [Blog](https://www.svix.com/blog/) | [Slack Community](https://www.svix.com/slack/)  # Introduction  This is the reference documentation and schemas for the [Svix webhook service](https://www.svix.com) API. For tutorials and other documentation please refer to [the documentation](https://docs.svix.com).  ## Main concepts  In Svix you have four important entities you will be interacting with:  - `messages`: these are the webhooks being sent. They can have contents and a few other properties. - `application`: this is where `messages` are sent to. Usually you want to create one application for each user on your platform. - `endpoint`: endpoints are the URLs messages will be sent to. Each application can have multiple `endpoints` and each message sent to that application will be sent to all of them (unless they are not subscribed to the sent event type). - `event-type`: event types are identifiers denoting the type of the message being sent. Event types are primarily used to decide which events are sent to which endpoint.   ## Authentication  Get your authentication token (`AUTH_TOKEN`) from the [Svix dashboard](https://dashboard.svix.com) and use it as part of the `Authorization` header as such: `Authorization: Bearer ${AUTH_TOKEN}`.  <SecurityDefinitions />   ## Code samples  The code samples assume you already have the respective libraries installed and you know how to use them. For the latest information on how to do that, please refer to [the documentation](https://docs.svix.com/).   ## Idempotency  Svix supports [idempotency](https://en.wikipedia.org/wiki/Idempotence) for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response.  To perform an idempotent request, pass the idempotency key in the `Idempotency-Key` header to the request. The idempotency key should be a unique value generated by the client. You can create the key in however way you like, though we suggest using UUID v4, or any other string with enough entropy to avoid collisions.  Svix's idempotency works by saving the resulting status code and body of the first request made for any given idempotency key for any successful request. Subsequent requests with the same key return the same result.  Please note that idempotency is only supported for `POST` requests.   ## Cross-Origin Resource Sharing  This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site. 
 
-The version of the OpenAPI document: 1.4
+The version of the OpenAPI document: 1.4.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.0
@@ -19,46 +19,112 @@ module Svix
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Calculate Aggregate App Stats
+    # Creates a background task to calculate the message destinations for all applications in the environment.
+    # @param app_usage_stats_in [AppUsageStatsIn] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key The request&#39;s idempotency key
+    # @return [AppUsageStatsOut]
+    def calculate_aggregate_app_stats(app_usage_stats_in, opts = {})
+      data, _status_code, _headers = calculate_aggregate_app_stats_with_http_info(app_usage_stats_in, opts)
+      data
+    end
+
+    # Calculate Aggregate App Stats
+    # Creates a background task to calculate the message destinations for all applications in the environment.
+    # @param app_usage_stats_in [AppUsageStatsIn] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key The request&#39;s idempotency key
+    # @return [Array<(AppUsageStatsOut, Integer, Hash)>] AppUsageStatsOut data, response status code and response headers
+    def calculate_aggregate_app_stats_with_http_info(app_usage_stats_in, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StatisticsApi.calculate_aggregate_app_stats ...'
+      end
+      # verify the required parameter 'app_usage_stats_in' is set
+      if @api_client.config.client_side_validation && app_usage_stats_in.nil?
+        fail ArgumentError, "Missing the required parameter 'app_usage_stats_in' when calling StatisticsApi.calculate_aggregate_app_stats"
+      end
+      # resource path
+      local_var_path = '/api/v1/stats/usage/app/'
+
+      # 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(app_usage_stats_in)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AppUsageStatsOut'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"StatisticsApi.calculate_aggregate_app_stats",
+        :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: StatisticsApi#calculate_aggregate_app_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get App Attempt Stats
     # Returns application-level statistics on message attempts
-    # @param app_id [String] 
+    # @param app_id [String] The app&#39;s ID or UID
     # @param [Hash] opts the optional parameters
     # @option opts [Time] :start_date 
     # @option opts [Time] :end_date 
-    # @option opts [String] :idempotency_key The request&#39;s idempotency key
     # @return [AttemptStatisticsResponse]
-    def get_app_attempt_stats_api_v1_stats_app_app_id_attempt_get(app_id, opts = {})
-      data, _status_code, _headers = get_app_attempt_stats_api_v1_stats_app_app_id_attempt_get_with_http_info(app_id, opts)
+    def v1_stats_app_attempts(app_id, opts = {})
+      data, _status_code, _headers = v1_stats_app_attempts_with_http_info(app_id, opts)
       data
     end
 
     # Get App Attempt Stats
     # Returns application-level statistics on message attempts
-    # @param app_id [String] 
+    # @param app_id [String] The app&#39;s ID or UID
     # @param [Hash] opts the optional parameters
     # @option opts [Time] :start_date 
     # @option opts [Time] :end_date 
-    # @option opts [String] :idempotency_key The request&#39;s idempotency key
     # @return [Array<(AttemptStatisticsResponse, Integer, Hash)>] AttemptStatisticsResponse data, response status code and response headers
-    def get_app_attempt_stats_api_v1_stats_app_app_id_attempt_get_with_http_info(app_id, opts = {})
+    def v1_stats_app_attempts_with_http_info(app_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: StatisticsApi.get_app_attempt_stats_api_v1_stats_app_app_id_attempt_get ...'
+        @api_client.config.logger.debug 'Calling API: StatisticsApi.v1_stats_app_attempts ...'
       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 StatisticsApi.get_app_attempt_stats_api_v1_stats_app_app_id_attempt_get"
+        fail ArgumentError, "Missing the required parameter 'app_id' when calling StatisticsApi.v1_stats_app_attempts"
       end
       if @api_client.config.client_side_validation && app_id.to_s.length > 256
-        fail ArgumentError, 'invalid value for "app_id" when calling StatisticsApi.get_app_attempt_stats_api_v1_stats_app_app_id_attempt_get, the character length must be smaller than or equal to 256.'
+        fail ArgumentError, 'invalid value for "app_id" when calling StatisticsApi.v1_stats_app_attempts, 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 StatisticsApi.get_app_attempt_stats_api_v1_stats_app_app_id_attempt_get, the character length must be great than or equal to 1.'
+        fail ArgumentError, 'invalid value for "app_id" when calling StatisticsApi.v1_stats_app_attempts, 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 StatisticsApi.get_app_attempt_stats_api_v1_stats_app_app_id_attempt_get, must conform to the pattern #{pattern}."
+        fail ArgumentError, "invalid value for 'app_id' when calling StatisticsApi.v1_stats_app_attempts, must conform to the pattern #{pattern}."
       end
 
       # resource path
@@ -73,7 +139,6 @@ module Svix
       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] || {}
@@ -88,7 +153,7 @@ module Svix
       auth_names = opts[:debug_auth_names] || ['HTTPBearer']
 
       new_options = opts.merge(
-        :operation => :"StatisticsApi.get_app_attempt_stats_api_v1_stats_app_app_id_attempt_get",
+        :operation => :"StatisticsApi.v1_stats_app_attempts",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -99,74 +164,72 @@ module Svix
 
       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: StatisticsApi#get_app_attempt_stats_api_v1_stats_app_app_id_attempt_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: StatisticsApi#v1_stats_app_attempts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
     # Get Ep Stats
     # Returns endpoint-level statistics on message attempts
-    # @param endpoint_id [String] 
-    # @param app_id [String] 
+    # @param app_id [String] The app&#39;s ID or UID
+    # @param endpoint_id [String] The ep&#39;s ID or UID
     # @param [Hash] opts the optional parameters
     # @option opts [Time] :start_date 
     # @option opts [Time] :end_date 
-    # @option opts [String] :idempotency_key The request&#39;s idempotency key
     # @return [AttemptStatisticsResponse]
-    def get_ep_stats_api_v1_stats_app_app_id_ep_endpoint_id_attempt_get(endpoint_id, app_id, opts = {})
-      data, _status_code, _headers = get_ep_stats_api_v1_stats_app_app_id_ep_endpoint_id_attempt_get_with_http_info(endpoint_id, app_id, opts)
+    def v1_stats_endpoint_attempts(app_id, endpoint_id, opts = {})
+      data, _status_code, _headers = v1_stats_endpoint_attempts_with_http_info(app_id, endpoint_id, opts)
       data
     end
 
     # Get Ep Stats
     # Returns endpoint-level statistics on message attempts
-    # @param endpoint_id [String] 
-    # @param app_id [String] 
+    # @param app_id [String] The app&#39;s ID or UID
+    # @param endpoint_id [String] The ep&#39;s ID or UID
     # @param [Hash] opts the optional parameters
     # @option opts [Time] :start_date 
     # @option opts [Time] :end_date 
-    # @option opts [String] :idempotency_key The request&#39;s idempotency key
     # @return [Array<(AttemptStatisticsResponse, Integer, Hash)>] AttemptStatisticsResponse data, response status code and response headers
-    def get_ep_stats_api_v1_stats_app_app_id_ep_endpoint_id_attempt_get_with_http_info(endpoint_id, app_id, opts = {})
+    def v1_stats_endpoint_attempts_with_http_info(app_id, endpoint_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: StatisticsApi.get_ep_stats_api_v1_stats_app_app_id_ep_endpoint_id_attempt_get ...'
+        @api_client.config.logger.debug 'Calling API: StatisticsApi.v1_stats_endpoint_attempts ...'
       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 StatisticsApi.get_ep_stats_api_v1_stats_app_app_id_ep_endpoint_id_attempt_get"
+      # 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 StatisticsApi.v1_stats_endpoint_attempts"
       end
-      if @api_client.config.client_side_validation && endpoint_id.to_s.length > 256
-        fail ArgumentError, 'invalid value for "endpoint_id" when calling StatisticsApi.get_ep_stats_api_v1_stats_app_app_id_ep_endpoint_id_attempt_get, the character length must be smaller than or equal to 256.'
+      if @api_client.config.client_side_validation && app_id.to_s.length > 256
+        fail ArgumentError, 'invalid value for "app_id" when calling StatisticsApi.v1_stats_endpoint_attempts, 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 StatisticsApi.get_ep_stats_api_v1_stats_app_app_id_ep_endpoint_id_attempt_get, the character length must be great than or equal to 1.'
+      if @api_client.config.client_side_validation && app_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "app_id" when calling StatisticsApi.v1_stats_endpoint_attempts, 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 StatisticsApi.get_ep_stats_api_v1_stats_app_app_id_ep_endpoint_id_attempt_get, must conform to the pattern #{pattern}."
+      if @api_client.config.client_side_validation && app_id !~ pattern
+        fail ArgumentError, "invalid value for 'app_id' when calling StatisticsApi.v1_stats_endpoint_attempts, must conform to the pattern #{pattern}."
       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 StatisticsApi.get_ep_stats_api_v1_stats_app_app_id_ep_endpoint_id_attempt_get"
+      # 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 StatisticsApi.v1_stats_endpoint_attempts"
       end
-      if @api_client.config.client_side_validation && app_id.to_s.length > 256
-        fail ArgumentError, 'invalid value for "app_id" when calling StatisticsApi.get_ep_stats_api_v1_stats_app_app_id_ep_endpoint_id_attempt_get, the character length must be smaller than or equal to 256.'
+      if @api_client.config.client_side_validation && endpoint_id.to_s.length > 256
+        fail ArgumentError, 'invalid value for "endpoint_id" when calling StatisticsApi.v1_stats_endpoint_attempts, 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 StatisticsApi.get_ep_stats_api_v1_stats_app_app_id_ep_endpoint_id_attempt_get, the character length must be great than or equal to 1.'
+      if @api_client.config.client_side_validation && endpoint_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "endpoint_id" when calling StatisticsApi.v1_stats_endpoint_attempts, 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 StatisticsApi.get_ep_stats_api_v1_stats_app_app_id_ep_endpoint_id_attempt_get, must conform to the pattern #{pattern}."
+      if @api_client.config.client_side_validation && endpoint_id !~ pattern
+        fail ArgumentError, "invalid value for 'endpoint_id' when calling StatisticsApi.v1_stats_endpoint_attempts, must conform to the pattern #{pattern}."
       end
 
       # resource path
-      local_var_path = '/api/v1/stats/app/{app_id}/ep/{endpoint_id}/attempt/'.sub('{' + 'endpoint_id' + '}', CGI.escape(endpoint_id.to_s)).sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s))
+      local_var_path = '/api/v1/stats/app/{app_id}/ep/{endpoint_id}/attempt/'.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] || {}
@@ -177,7 +240,6 @@ module Svix
       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] || {}
@@ -192,7 +254,7 @@ module Svix
       auth_names = opts[:debug_auth_names] || ['HTTPBearer']
 
       new_options = opts.merge(
-        :operation => :"StatisticsApi.get_ep_stats_api_v1_stats_app_app_id_ep_endpoint_id_attempt_get",
+        :operation => :"StatisticsApi.v1_stats_endpoint_attempts",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -203,7 +265,7 @@ module Svix
 
       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: StatisticsApi#get_ep_stats_api_v1_stats_app_app_id_ep_endpoint_id_attempt_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: StatisticsApi#v1_stats_endpoint_attempts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end

data/lib/svix/api_client.rb

@@ -3,7 +3,7 @@
 
 #Welcome to the Svix API documentation!  Useful links: [Homepage](https://www.svix.com) | [Support email](mailto:support+docs@svix.com) | [Blog](https://www.svix.com/blog/) | [Slack Community](https://www.svix.com/slack/)  # Introduction  This is the reference documentation and schemas for the [Svix webhook service](https://www.svix.com) API. For tutorials and other documentation please refer to [the documentation](https://docs.svix.com).  ## Main concepts  In Svix you have four important entities you will be interacting with:  - `messages`: these are the webhooks being sent. They can have contents and a few other properties. - `application`: this is where `messages` are sent to. Usually you want to create one application for each user on your platform. - `endpoint`: endpoints are the URLs messages will be sent to. Each application can have multiple `endpoints` and each message sent to that application will be sent to all of them (unless they are not subscribed to the sent event type). - `event-type`: event types are identifiers denoting the type of the message being sent. Event types are primarily used to decide which events are sent to which endpoint.   ## Authentication  Get your authentication token (`AUTH_TOKEN`) from the [Svix dashboard](https://dashboard.svix.com) and use it as part of the `Authorization` header as such: `Authorization: Bearer ${AUTH_TOKEN}`.  <SecurityDefinitions />   ## Code samples  The code samples assume you already have the respective libraries installed and you know how to use them. For the latest information on how to do that, please refer to [the documentation](https://docs.svix.com/).   ## Idempotency  Svix supports [idempotency](https://en.wikipedia.org/wiki/Idempotence) for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response.  To perform an idempotent request, pass the idempotency key in the `Idempotency-Key` header to the request. The idempotency key should be a unique value generated by the client. You can create the key in however way you like, though we suggest using UUID v4, or any other string with enough entropy to avoid collisions.  Svix's idempotency works by saving the resulting status code and body of the first request made for any given idempotency key for any successful request. Subsequent requests with the same key return the same result.  Please note that idempotency is only supported for `POST` requests.   ## Cross-Origin Resource Sharing  This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site. 
 
-The version of the OpenAPI document: 1.4
+The version of the OpenAPI document: 1.4.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.0

data/lib/svix/api_error.rb

@@ -3,7 +3,7 @@
 
 #Welcome to the Svix API documentation!  Useful links: [Homepage](https://www.svix.com) | [Support email](mailto:support+docs@svix.com) | [Blog](https://www.svix.com/blog/) | [Slack Community](https://www.svix.com/slack/)  # Introduction  This is the reference documentation and schemas for the [Svix webhook service](https://www.svix.com) API. For tutorials and other documentation please refer to [the documentation](https://docs.svix.com).  ## Main concepts  In Svix you have four important entities you will be interacting with:  - `messages`: these are the webhooks being sent. They can have contents and a few other properties. - `application`: this is where `messages` are sent to. Usually you want to create one application for each user on your platform. - `endpoint`: endpoints are the URLs messages will be sent to. Each application can have multiple `endpoints` and each message sent to that application will be sent to all of them (unless they are not subscribed to the sent event type). - `event-type`: event types are identifiers denoting the type of the message being sent. Event types are primarily used to decide which events are sent to which endpoint.   ## Authentication  Get your authentication token (`AUTH_TOKEN`) from the [Svix dashboard](https://dashboard.svix.com) and use it as part of the `Authorization` header as such: `Authorization: Bearer ${AUTH_TOKEN}`.  <SecurityDefinitions />   ## Code samples  The code samples assume you already have the respective libraries installed and you know how to use them. For the latest information on how to do that, please refer to [the documentation](https://docs.svix.com/).   ## Idempotency  Svix supports [idempotency](https://en.wikipedia.org/wiki/Idempotence) for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response.  To perform an idempotent request, pass the idempotency key in the `Idempotency-Key` header to the request. The idempotency key should be a unique value generated by the client. You can create the key in however way you like, though we suggest using UUID v4, or any other string with enough entropy to avoid collisions.  Svix's idempotency works by saving the resulting status code and body of the first request made for any given idempotency key for any successful request. Subsequent requests with the same key return the same result.  Please note that idempotency is only supported for `POST` requests.   ## Cross-Origin Resource Sharing  This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site. 
 
-The version of the OpenAPI document: 1.4
+The version of the OpenAPI document: 1.4.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.0

data/lib/svix/application_api.rb

@@ -1,31 +1,31 @@
 # frozen_string_literal: true
 
 module Svix
-    class ApplicationAPI
-        def initialize(api_client)
-            @api = ApplicationApi.new(api_client)
-        end
+  class ApplicationAPI
+    def initialize(api_client)
+      @api = ApplicationApi.new(api_client)
+    end
 
-        def list(options = {})
-            return @api.list_applications_api_v1_app_get(options)
-        end
+    def list(options = {})
+      return @api.v1_application_list(options)
+    end
 
-        def create(application_in, options = {})
-            return @api.create_application_api_v1_app_post(application_in, options)
-        end
-        def get_or_create(application_in, options = {})
-            return @api.create_application_api_v1_app_post(application_in, {**options, get_if_exists: true})
-        end
-        def get(app_id)
-            return @api.get_application_api_v1_app_app_id_get(app_id)
-        end
+    def create(application_in, options = {})
+      return @api.v1_application_create(application_in, options)
+    end
+    def get_or_create(application_in, options = {})
+      return @api.v1_application_create(application_in, {**options, get_if_exists: true})
+    end
+    def get(app_id)
+      return @api.v1_application_get(app_id)
+    end
 
-        def update(app_id, application_in)
-            return @api.update_application_api_v1_app_app_id_put(app_id, application_in)
-        end
+    def update(app_id, application_in)
+      return @api.v1_application_update(app_id, application_in)
+    end
 
-        def delete(app_id)
-            return @api.delete_application_api_v1_app_app_id_delete(app_id)
-        end
+    def delete(app_id)
+      return @api.v1_application_delete(app_id)
     end
+  end
 end

data/lib/svix/authentication_api.rb

@@ -7,15 +7,15 @@ module Svix
     end
 
     def app_portal_access(app_id, app_portal_access_in, options = {})
-      return @api.get_app_portal_access_access_api_v1_auth_dashboard_access_app_id_post(app_id, app_portal_access_in, options)
+      return @api.v1_authentication_app_portal_access(app_id, app_portal_access_in, options)
     end
 
     def dashboard_access(app_id, options = {})
-      return @api.get_dashboard_access_api_v1_auth_dashboard_access_app_id_post(app_id, options)
+      return @api.v1_authentication_dashboard_access(app_id, options)
     end
 
     def logout(options = {})
-      return @api.logout_api_v1_auth_logout_post(options)
+      return @api.v1_authentication_logout(options)
     end
   end
 end

data/lib/svix/configuration.rb

@@ -3,7 +3,7 @@
 
 #Welcome to the Svix API documentation!  Useful links: [Homepage](https://www.svix.com) | [Support email](mailto:support+docs@svix.com) | [Blog](https://www.svix.com/blog/) | [Slack Community](https://www.svix.com/slack/)  # Introduction  This is the reference documentation and schemas for the [Svix webhook service](https://www.svix.com) API. For tutorials and other documentation please refer to [the documentation](https://docs.svix.com).  ## Main concepts  In Svix you have four important entities you will be interacting with:  - `messages`: these are the webhooks being sent. They can have contents and a few other properties. - `application`: this is where `messages` are sent to. Usually you want to create one application for each user on your platform. - `endpoint`: endpoints are the URLs messages will be sent to. Each application can have multiple `endpoints` and each message sent to that application will be sent to all of them (unless they are not subscribed to the sent event type). - `event-type`: event types are identifiers denoting the type of the message being sent. Event types are primarily used to decide which events are sent to which endpoint.   ## Authentication  Get your authentication token (`AUTH_TOKEN`) from the [Svix dashboard](https://dashboard.svix.com) and use it as part of the `Authorization` header as such: `Authorization: Bearer ${AUTH_TOKEN}`.  <SecurityDefinitions />   ## Code samples  The code samples assume you already have the respective libraries installed and you know how to use them. For the latest information on how to do that, please refer to [the documentation](https://docs.svix.com/).   ## Idempotency  Svix supports [idempotency](https://en.wikipedia.org/wiki/Idempotence) for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response.  To perform an idempotent request, pass the idempotency key in the `Idempotency-Key` header to the request. The idempotency key should be a unique value generated by the client. You can create the key in however way you like, though we suggest using UUID v4, or any other string with enough entropy to avoid collisions.  Svix's idempotency works by saving the resulting status code and body of the first request made for any given idempotency key for any successful request. Subsequent requests with the same key return the same result.  Please note that idempotency is only supported for `POST` requests.   ## Cross-Origin Resource Sharing  This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site. 
 
-The version of the OpenAPI document: 1.4
+The version of the OpenAPI document: 1.4.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.0
@@ -219,6 +219,7 @@ module Svix
           {
             type: 'bearer',
             in: 'header',
+            format: 'null',
             key: 'Authorization',
             value: "Bearer #{access_token}"
           },

data/lib/svix/endpoint_api.rb

@@ -7,70 +7,70 @@ module Svix
     end
 
     def list(app_id, options = {})
-      return @api.list_endpoints_api_v1_app_app_id_endpoint_get(app_id, options)
+      return @api.v1_endpoint_list(app_id, options)
     end
 
     def create(app_id, endpoint_in, options = {})
-      return @api.create_endpoint_api_v1_app_app_id_endpoint_post(app_id, endpoint_in, options)
+      return @api.v1_endpoint_create(app_id, endpoint_in, options)
     end
 
     def get(app_id, endpoint_id)
-      return @api.get_endpoint_api_v1_app_app_id_endpoint_endpoint_id_get(endpoint_id, app_id)
+      return @api.v1_endpoint_get(app_id, endpoint_id)
     end
 
     def update(app_id, endpoint_id, endpoint_update)
-      return @api.update_endpoint_api_v1_app_app_id_endpoint_endpoint_id_put(endpoint_id, app_id, endpoint_update)
+      return @api.v1_endpoint_update(app_id, endpoint_id, endpoint_update)
     end
 
     def delete(app_id, endpoint_id)
-      return @api.delete_endpoint_api_v1_app_app_id_endpoint_endpoint_id_delete(endpoint_id, app_id)
+      return @api.v1_endpoint_delete(app_id, endpoint_id)
     end
 
     def get_secret(app_id, endpoint_id)
-      return @api.get_endpoint_secret_api_v1_app_app_id_endpoint_endpoint_id_secret_get(endpoint_id, app_id)
+      return @api.v1_endpoint_get_secret(app_id, endpoint_id)
     end
 
     def rotate_secret(app_id, endpoint_id, endpoint_secret_rotate_in, options = {})
-      return @api.rotate_endpoint_secret_api_v1_app_app_id_endpoint_endpoint_id_secret_rotate_post(endpoint_id, app_id, endpoint_secret_rotate_in, options)
+      return @api.v1_endpoint_rotate_secret(app_id, endpoint_id, endpoint_secret_rotate_in, options)
     end
 
     def recover(app_id, endpoint_id, recover_in, options = {})
-      @api.recover_failed_webhooks_api_v1_app_app_id_endpoint_endpoint_id_recover_post(app_id, endpoint_id, recover_in, options)
+      @api.v1_endpoint_recover(app_id, endpoint_id, recover_in, options)
       nil
     end
 
     def get_headers(app_id, endpoint_id)
-      return @api.get_endpoint_headers_api_v1_app_app_id_endpoint_endpoint_id_headers_get(endpoint_id app_id)
+      return @api.v1_endpoint_get_headers(app_id, endpoint_id)
     end
 
     def update_headers(app_id, endpoint_id, endpoint_headers_in)
-      return @api.update_endpoint_headers_api_v1_app_app_id_endpoint_endpoint_id_headers_put(app_id, endpoint_id, endpoint_headers_in)
+      return @api.v1_endpoint_update_headers(app_id, endpoint_id, endpoint_headers_in)
     end
 
     def patch_headers(app_id, endpoint_id, endpoint_headers_in)
-      return @api.patch_endpoint_headers_api_v1_app_app_id_endpoint_endpoint_id_headers_patch(app_id, endpoint_id, endpoint_headers_in)
+      return @api.v1_endpoint_patch_headers(app_id, endpoint_id, endpoint_headers_in)
     end
 
     def get_stats(app_id, endpoint_id)
-      return @api.get_endpoint_stats_api_v1_app_app_id_endpoint_endpoint_id_stats_get(endpoint_id app_id)
+      return @api.v1_endpoint_get_stats(app_id, endpoint_id)
     end
 
     def replay_missing(app_id, endpoint_id, replay_in, options = {})
-      @api.replay_missing_webhooks_api_v1_app_app_id_endpoint_endpoint_id_replay_missing_post(app_id, endpoint_id, replay_in, options)
+      @api.v1_endpoint_replay(app_id, endpoint_id, replay_in, options)
       nil
     end
 
     def transformation_get(app_id, endpoint_id, options = {})
-      return @api.get_endpoint_transformation_api_v1_app_app_id_endpoint_endpoint_id_transformation_get(endpoint_id, app_id, options)
+      return @api.v1_endpoint_transformation_get(app_id, endpoint_id, options)
     end
 
     def transformation_partial_update(app_id, endpoint_id, endpoint_transformation_in, options = {})
-      @api.set_endpoint_transformation_api_v1_app_app_id_endpoint_endpoint_id_transformation_patch(app_id, endpoint_id, endpoint_transformation_in, options)
+      @api.v1_endpoint_transformation_partial_update(app_id, endpoint_id, endpoint_transformation_in, options)
       nil
     end
 
     def send_example(app_id, endpoint_id, event_example_in, options = {})
-      @api.send_event_type_example_message_api_v1_app_app_id_endpoint_endpoint_id_send_example_post(app_id, endpoint_id, event_example_in, options)
+      @api.v1_endpoint_send_example(app_id, endpoint_id, event_example_in, options)
     end
   end
 end

data/lib/svix/event_type_api.rb

@@ -1,29 +1,29 @@
 # frozen_string_literal: true
 
 module Svix
-    class EventTypeAPI
-        def initialize(api_client)
-            @api = EventTypeApi.new(api_client)
-        end
+  class EventTypeAPI
+    def initialize(api_client)
+      @api = EventTypeApi.new(api_client)
+    end
 
-        def list(options = {})
-            return @api.list_event_types_api_v1_event_type_get(options)
-        end
+    def list(options = {})
+      return @api.v1_event_type_list(options)
+    end
 
-        def create(event_type_in, options = {})
-            return @api.create_event_type_api_v1_event_type_post(event_type_in, options)
-        end
+    def create(event_type_in, options = {})
+      return @api.v1_event_type_create(event_type_in, options)
+    end
 
-        def get(event_type_name)
-            return @api.get_event_type_api_v1_event_type_event_type_name_get(event_type_name)
-        end
+    def get(event_type_name)
+      return @api.v1_event_type_get(event_type_name)
+    end
 
-        def update(event_type_name, event_type_update)
-            return @api.update_event_type_api_v1_event_type_event_type_name_put(event_type_name, event_type_update)
-        end
+    def update(event_type_name, event_type_update)
+      return @api.v1_event_type_update(event_type_name, event_type_update)
+    end
 
-        def delete(event_type_name)
-            return @api.delete_event_type_api_v1_event_type_event_type_name_delete(event_type_name)
-        end
+    def delete(event_type_name)
+      return @api.v1_event_type_delete(event_type_name)
     end
+  end
 end

data/lib/svix/integration_api.rb

@@ -1,38 +1,38 @@
 # frozen_string_literal: true
 
 module Svix
-    class IntegrationAPI
-        def initialize(api_client)
-            @api = IntegrationApi.new(api_client)
-        end
-
-        def list(app_id, options = {})
-            return @api.list_integrations_api_v1_app_app_id_integration_get(app_id, options)
-        end
+  class IntegrationAPI
+    def initialize(api_client)
+      @api = IntegrationApi.new(api_client)
+    end
 
-        def create(app_id, integ_in, options = {})
-            return @api.create_integration_api_v1_app_app_id_integration_post(app_id, integ_in, options)
-        end
+    def list(app_id, options = {})
+      return @api.v1_integration_list(app_id, options)
+    end
 
-        def get(app_id, integ_id)
-            return @api.get_integration_api_v1_app_app_id_integration_integ_id_get(integ_id, app_id)
-        end
+    def create(app_id, integ_in, options = {})
+      return @api.v1_integration_create(app_id, integ_in, options)
+    end
 
-        def update(app_id, integ_id, integ_update)
-            return @api.update_integration_api_v1_app_app_id_integration_integ_id_put(integ_id, app_id, integ_update)
-        end
+    def get(app_id, integ_id)
+      return @api.v1_integration_get(app_id, integ_id)
+    end
 
-        def delete(app_id, integ_id)
-            return @api.delete_integration_api_v1_app_app_id_integration_integ_id_delete(integ_id, app_id)
-        end
+    def update(app_id, integ_id, integ_update)
+      return @api.v1_integration_update(app_id, integ_id, integ_update)
+    end
 
-        def get_key(app_id, integ_id)
-            return @api.get_integration_key_api_v1_app_app_id_integration_integ_id_key_get(integ_id, app_id)
-        end
+    def delete(app_id, integ_id)
+      return @api.v1_integration_delete(app_id, integ_id)
+    end
 
-        def rotate_key(app_id, integ_id, options = {})
-            return @api.rotate_integration_key_api_v1_app_app_id_integration_integ_id_key_rotate_post(integ_id, app_id, options)
-        end
+    def get_key(app_id, integ_id)
+      return @api.v1_integration_get_key(app_id, integ_id)
+    end
 
+    def rotate_key(app_id, integ_id, options = {})
+      return @api.v1_integration_rotate_key(app_id, integ_id, options)
     end
+
+  end
 end

data/lib/svix/message_api.rb

@@ -7,19 +7,19 @@ module Svix
     end
 
     def list(app_id, options = {})
-      return @api.list_messages_api_v1_app_app_id_msg_get(app_id, options)
+      return @api.v1_message_list(app_id, options)
     end
 
     def create(app_id, message_in, options = {})
-      return @api.create_message_api_v1_app_app_id_msg_post(app_id, message_in, options)
+      return @api.v1_message_create(app_id, message_in, options)
     end
 
     def get(app_id, msg_id)
-      return @api.get_message_api_v1_app_app_id_msg_msg_id_get(msg_id, app_id)
+      return @api.v1_message_get(app_id, msg_id)
     end
 
     def expunge_content(app_id, msg_id)
-      return @api.expunge_message_payload_api_v1_app_app_id_msg_msg_id_content_delete(msg_id, app_id)
+      return @api.v1_message_expunge_content(app_id, msg_id)
     end
   end
 end