svix 0.83.0 → 0.84.0

data/lib/svix/api/authentication_api.rb

@@ -19,52 +19,52 @@ module Svix
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Expire All
-    # Expire all of the tokens associated with a specific Application
+    # App Portal Access
+    # Use this function to get magic links (and authentication codes) for connecting your users to the Consumer Application Portal.
     # @param app_id [String] 
-    # @param application_token_expire_in [ApplicationTokenExpireIn] 
+    # @param app_portal_access_in [AppPortalAccessIn] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request's idempotency key
-    # @return [nil]
-    def expire_all_api_v1_auth_app_app_id_expire_all_post(app_id, application_token_expire_in, opts = {})
-      expire_all_api_v1_auth_app_app_id_expire_all_post_with_http_info(app_id, application_token_expire_in, opts)
-      nil
+    # @return [AppPortalAccessOut]
+    def v1_authentication_app_portal_access(app_id, app_portal_access_in, opts = {})
+      data, _status_code, _headers = v1_authentication_app_portal_access_with_http_info(app_id, app_portal_access_in, opts)
+      data
     end
 
-    # Expire All
-    # Expire all of the tokens associated with a specific Application
+    # App Portal Access
+    # Use this function to get magic links (and authentication codes) for connecting your users to the Consumer Application Portal.
     # @param app_id [String] 
-    # @param application_token_expire_in [ApplicationTokenExpireIn] 
+    # @param app_portal_access_in [AppPortalAccessIn] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request's idempotency key
-    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def expire_all_api_v1_auth_app_app_id_expire_all_post_with_http_info(app_id, application_token_expire_in, opts = {})
+    # @return [Array<(AppPortalAccessOut, Integer, Hash)>] AppPortalAccessOut data, response status code and response headers
+    def v1_authentication_app_portal_access_with_http_info(app_id, app_portal_access_in, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AuthenticationApi.expire_all_api_v1_auth_app_app_id_expire_all_post ...'
+        @api_client.config.logger.debug 'Calling API: AuthenticationApi.v1_authentication_app_portal_access ...'
       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.expire_all_api_v1_auth_app_app_id_expire_all_post"
+        fail ArgumentError, "Missing the required parameter 'app_id' when calling AuthenticationApi.v1_authentication_app_portal_access"
       end
       if @api_client.config.client_side_validation && app_id.to_s.length > 256
-        fail ArgumentError, 'invalid value for "app_id" when calling AuthenticationApi.expire_all_api_v1_auth_app_app_id_expire_all_post, the character length must be smaller than or equal to 256.'
+        fail ArgumentError, 'invalid value for "app_id" when calling AuthenticationApi.v1_authentication_app_portal_access, 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.expire_all_api_v1_auth_app_app_id_expire_all_post, the character length must be great than or equal to 1.'
+        fail ArgumentError, 'invalid value for "app_id" when calling AuthenticationApi.v1_authentication_app_portal_access, 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.expire_all_api_v1_auth_app_app_id_expire_all_post, must conform to the pattern #{pattern}."
+        fail ArgumentError, "invalid value for 'app_id' when calling AuthenticationApi.v1_authentication_app_portal_access, must conform to the pattern #{pattern}."
       end
 
-      # verify the required parameter 'application_token_expire_in' is set
-      if @api_client.config.client_side_validation && application_token_expire_in.nil?
-        fail ArgumentError, "Missing the required parameter 'application_token_expire_in' when calling AuthenticationApi.expire_all_api_v1_auth_app_app_id_expire_all_post"
+      # verify the required parameter 'app_portal_access_in' is set
+      if @api_client.config.client_side_validation && app_portal_access_in.nil?
+        fail ArgumentError, "Missing the required parameter 'app_portal_access_in' when calling AuthenticationApi.v1_authentication_app_portal_access"
       end
       # resource path
-      local_var_path = '/api/v1/auth/app/{app_id}/expire-all/'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s))
+      local_var_path = '/api/v1/auth/app-portal-access/{app_id}/'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -81,16 +81,16 @@ module Svix
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(application_token_expire_in)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(app_portal_access_in)
 
       # return_type
-      return_type = opts[:debug_return_type]
+      return_type = opts[:debug_return_type] || 'AppPortalAccessOut'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
-        :operation => :"AuthenticationApi.expire_all_api_v1_auth_app_app_id_expire_all_post",
+        :operation => :"AuthenticationApi.v1_authentication_app_portal_access",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -101,57 +101,51 @@ module Svix
 
       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#expire_all_api_v1_auth_app_app_id_expire_all_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: AuthenticationApi#v1_authentication_app_portal_access\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Get Consumer App Portal Access
-    # Use this function to get magic links (and authentication codes) for connecting your users to the Consumer Application Portal.
+    # 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] 
-    # @param app_portal_access_in [AppPortalAccessIn] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request&#39;s idempotency key
-    # @return [AppPortalAccessOut]
-    def get_app_portal_access_api_v1_auth_app_portal_access_app_id_post(app_id, app_portal_access_in, opts = {})
-      data, _status_code, _headers = get_app_portal_access_api_v1_auth_app_portal_access_app_id_post_with_http_info(app_id, app_portal_access_in, opts)
+    # @return [DashboardAccessOut]
+    def v1_authentication_dashboard_access(app_id, opts = {})
+      data, _status_code, _headers = v1_authentication_dashboard_access_with_http_info(app_id, opts)
       data
     end
 
-    # Get Consumer App Portal Access
-    # Use this function to get magic links (and authentication codes) for connecting your users to the Consumer Application Portal.
+    # Dashboard Access
+    # DEPRECATED: Please use &#x60;app-portal-access&#x60; instead.  Use this function to get magic links (and authentication codes) for connecting your users to the Consumer Application Portal.
     # @param app_id [String] 
-    # @param app_portal_access_in [AppPortalAccessIn] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request&#39;s idempotency key
-    # @return [Array<(AppPortalAccessOut, Integer, Hash)>] AppPortalAccessOut data, response status code and response headers
-    def get_app_portal_access_api_v1_auth_app_portal_access_app_id_post_with_http_info(app_id, app_portal_access_in, opts = {})
+    # @return [Array<(DashboardAccessOut, Integer, Hash)>] DashboardAccessOut data, response status code and response headers
+    def v1_authentication_dashboard_access_with_http_info(app_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AuthenticationApi.get_app_portal_access_api_v1_auth_app_portal_access_app_id_post ...'
+        @api_client.config.logger.debug 'Calling API: AuthenticationApi.v1_authentication_dashboard_access ...'
       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.get_app_portal_access_api_v1_auth_app_portal_access_app_id_post"
+        fail ArgumentError, "Missing the required parameter 'app_id' when calling AuthenticationApi.v1_authentication_dashboard_access"
       end
       if @api_client.config.client_side_validation && app_id.to_s.length > 256
-        fail ArgumentError, 'invalid value for "app_id" when calling AuthenticationApi.get_app_portal_access_api_v1_auth_app_portal_access_app_id_post, the character length must be smaller than or equal to 256.'
+        fail ArgumentError, 'invalid value for "app_id" when calling AuthenticationApi.v1_authentication_dashboard_access, 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.get_app_portal_access_api_v1_auth_app_portal_access_app_id_post, the character length must be great than or equal to 1.'
+        fail ArgumentError, 'invalid value for "app_id" when calling AuthenticationApi.v1_authentication_dashboard_access, 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.get_app_portal_access_api_v1_auth_app_portal_access_app_id_post, must conform to the pattern #{pattern}."
+        fail ArgumentError, "invalid value for 'app_id' when calling AuthenticationApi.v1_authentication_dashboard_access, must conform to the pattern #{pattern}."
       end
 
-      # verify the required parameter 'app_portal_access_in' is set
-      if @api_client.config.client_side_validation && app_portal_access_in.nil?
-        fail ArgumentError, "Missing the required parameter 'app_portal_access_in' when calling AuthenticationApi.get_app_portal_access_api_v1_auth_app_portal_access_app_id_post"
-      end
       # resource path
-      local_var_path = '/api/v1/auth/app-portal-access/{app_id}/'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s))
+      local_var_path = '/api/v1/auth/dashboard-access/{app_id}/'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -160,24 +154,22 @@ 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(app_portal_access_in)
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'AppPortalAccessOut'
+      return_type = opts[:debug_return_type] || 'DashboardAccessOut'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
-        :operation => :"AuthenticationApi.get_app_portal_access_api_v1_auth_app_portal_access_app_id_post",
+        :operation => :"AuthenticationApi.v1_authentication_dashboard_access",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -188,51 +180,57 @@ module Svix
 
       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#get_app_portal_access_api_v1_auth_app_portal_access_app_id_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: AuthenticationApi#v1_authentication_dashboard_access\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Get 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.
+    # Expire All
+    # Expire all of the tokens associated with a specific Application
     # @param app_id [String] 
+    # @param application_token_expire_in [ApplicationTokenExpireIn] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request&#39;s idempotency key
-    # @return [DashboardAccessOut]
-    def get_dashboard_access_api_v1_auth_dashboard_access_app_id_post(app_id, opts = {})
-      data, _status_code, _headers = get_dashboard_access_api_v1_auth_dashboard_access_app_id_post_with_http_info(app_id, opts)
-      data
+    # @return [nil]
+    def v1_authentication_expire_all(app_id, application_token_expire_in, opts = {})
+      v1_authentication_expire_all_with_http_info(app_id, application_token_expire_in, opts)
+      nil
     end
 
-    # Get Dashboard Access
-    # DEPRECATED: Please use &#x60;app-portal-access&#x60; instead.  Use this function to get magic links (and authentication codes) for connecting your users to the Consumer Application Portal.
+    # Expire All
+    # Expire all of the tokens associated with a specific Application
     # @param app_id [String] 
+    # @param application_token_expire_in [ApplicationTokenExpireIn] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request&#39;s idempotency key
-    # @return [Array<(DashboardAccessOut, Integer, Hash)>] DashboardAccessOut data, response status code and response headers
-    def get_dashboard_access_api_v1_auth_dashboard_access_app_id_post_with_http_info(app_id, opts = {})
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def v1_authentication_expire_all_with_http_info(app_id, application_token_expire_in, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AuthenticationApi.get_dashboard_access_api_v1_auth_dashboard_access_app_id_post ...'
+        @api_client.config.logger.debug 'Calling API: AuthenticationApi.v1_authentication_expire_all ...'
       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.get_dashboard_access_api_v1_auth_dashboard_access_app_id_post"
+        fail ArgumentError, "Missing the required parameter 'app_id' when calling AuthenticationApi.v1_authentication_expire_all"
       end
       if @api_client.config.client_side_validation && app_id.to_s.length > 256
-        fail ArgumentError, 'invalid value for "app_id" when calling AuthenticationApi.get_dashboard_access_api_v1_auth_dashboard_access_app_id_post, the character length must be smaller than or equal to 256.'
+        fail ArgumentError, 'invalid value for "app_id" when calling AuthenticationApi.v1_authentication_expire_all, 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.get_dashboard_access_api_v1_auth_dashboard_access_app_id_post, the character length must be great than or equal to 1.'
+        fail ArgumentError, 'invalid value for "app_id" when calling AuthenticationApi.v1_authentication_expire_all, 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.get_dashboard_access_api_v1_auth_dashboard_access_app_id_post, must conform to the pattern #{pattern}."
+        fail ArgumentError, "invalid value for 'app_id' when calling AuthenticationApi.v1_authentication_expire_all, must conform to the pattern #{pattern}."
       end
 
+      # verify the required parameter 'application_token_expire_in' is set
+      if @api_client.config.client_side_validation && application_token_expire_in.nil?
+        fail ArgumentError, "Missing the required parameter 'application_token_expire_in' when calling AuthenticationApi.v1_authentication_expire_all"
+      end
       # resource path
-      local_var_path = '/api/v1/auth/dashboard-access/{app_id}/'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s))
+      local_var_path = '/api/v1/auth/app/{app_id}/expire-all/'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -241,22 +239,24 @@ 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]
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(application_token_expire_in)
 
       # return_type
-      return_type = opts[:debug_return_type] || 'DashboardAccessOut'
+      return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
-        :operation => :"AuthenticationApi.get_dashboard_access_api_v1_auth_dashboard_access_app_id_post",
+        :operation => :"AuthenticationApi.v1_authentication_expire_all",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -267,7 +267,7 @@ module Svix
 
       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#get_dashboard_access_api_v1_auth_dashboard_access_app_id_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: AuthenticationApi#v1_authentication_expire_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
@@ -277,8 +277,8 @@ module Svix
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request&#39;s idempotency key
     # @return [nil]
-    def logout_api_v1_auth_logout_post(opts = {})
-      logout_api_v1_auth_logout_post_with_http_info(opts)
+    def v1_authentication_logout(opts = {})
+      v1_authentication_logout_with_http_info(opts)
       nil
     end
 
@@ -287,9 +287,9 @@ module Svix
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request&#39;s idempotency key
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def logout_api_v1_auth_logout_post_with_http_info(opts = {})
+    def v1_authentication_logout_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AuthenticationApi.logout_api_v1_auth_logout_post ...'
+        @api_client.config.logger.debug 'Calling API: AuthenticationApi.v1_authentication_logout ...'
       end
       # resource path
       local_var_path = '/api/v1/auth/logout/'
@@ -313,10 +313,10 @@ module Svix
       return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
-        :operation => :"AuthenticationApi.logout_api_v1_auth_logout_post",
+        :operation => :"AuthenticationApi.v1_authentication_logout",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -327,7 +327,7 @@ module Svix
 
       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#logout_api_v1_auth_logout_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: AuthenticationApi#v1_authentication_logout\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end

data/lib/svix/api/background_tasks_api.rb

@@ -0,0 +1,161 @@
+=begin
+#Svix API
+
+#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
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.2.0
+
+=end
+
+require 'cgi'
+
+module Svix
+  class BackgroundTasksApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get Background Task
+    # Get a background task by ID.
+    # @param task_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [BackgroundTaskOut]
+    def get_background_task(task_id, opts = {})
+      data, _status_code, _headers = get_background_task_with_http_info(task_id, opts)
+      data
+    end
+
+    # Get Background Task
+    # Get a background task by ID.
+    # @param task_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BackgroundTaskOut, Integer, Hash)>] BackgroundTaskOut data, response status code and response headers
+    def get_background_task_with_http_info(task_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BackgroundTasksApi.get_background_task ...'
+      end
+      # verify the required parameter 'task_id' is set
+      if @api_client.config.client_side_validation && task_id.nil?
+        fail ArgumentError, "Missing the required parameter 'task_id' when calling BackgroundTasksApi.get_background_task"
+      end
+      # resource path
+      local_var_path = '/api/v1/background-task/{task_id}/'.sub('{' + 'task_id' + '}', CGI.escape(task_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] || 'BackgroundTaskOut'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"BackgroundTasksApi.get_background_task",
+        :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: BackgroundTasksApi#get_background_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List Background Tasks
+    # List background tasks executed in the past 90 days.
+    # @param [Hash] opts the optional parameters
+    # @option opts [BackgroundTaskStatus] :status 
+    # @option opts [BackgroundTaskType] :task 
+    # @option opts [Integer] :limit 
+    # @option opts [String] :iterator 
+    # @option opts [Ordering] :order 
+    # @return [ListResponseBackgroundTaskOut]
+    def list_background_tasks(opts = {})
+      data, _status_code, _headers = list_background_tasks_with_http_info(opts)
+      data
+    end
+
+    # List Background Tasks
+    # List background tasks executed in the past 90 days.
+    # @param [Hash] opts the optional parameters
+    # @option opts [BackgroundTaskStatus] :status 
+    # @option opts [BackgroundTaskType] :task 
+    # @option opts [Integer] :limit 
+    # @option opts [String] :iterator 
+    # @option opts [Ordering] :order 
+    # @return [Array<(ListResponseBackgroundTaskOut, Integer, Hash)>] ListResponseBackgroundTaskOut data, response status code and response headers
+    def list_background_tasks_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BackgroundTasksApi.list_background_tasks ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling BackgroundTasksApi.list_background_tasks, must be greater than or equal to 0.'
+      end
+
+      # resource path
+      local_var_path = '/api/v1/background-task/'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
+      query_params[:'task'] = opts[:'task'] if !opts[:'task'].nil?
+      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] || 'ListResponseBackgroundTaskOut'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"BackgroundTasksApi.list_background_tasks",
+        :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: BackgroundTasksApi#list_background_tasks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end