Class: Svix::BackgroundTasksApi
- Inherits:
-
Object
- Object
- Svix::BackgroundTasksApi
- Defined in:
- lib/svix/api/background_tasks_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#get_background_task(task_id, opts = {}) ⇒ BackgroundTaskOut
Get Background Task Get a background task by ID.
-
#get_background_task_with_http_info(task_id, opts = {}) ⇒ Array<(BackgroundTaskOut, Integer, Hash)>
Get Background Task Get a background task by ID.
-
#initialize(api_client = ApiClient.default) ⇒ BackgroundTasksApi
constructor
A new instance of BackgroundTasksApi.
-
#list_background_tasks(opts = {}) ⇒ ListResponseBackgroundTaskOut
List Background Tasks List background tasks executed in the past 90 days.
-
#list_background_tasks_with_http_info(opts = {}) ⇒ Array<(ListResponseBackgroundTaskOut, Integer, Hash)>
List Background Tasks List background tasks executed in the past 90 days.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ BackgroundTasksApi
Returns a new instance of BackgroundTasksApi.
19 20 21 |
# File 'lib/svix/api/background_tasks_api.rb', line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/svix/api/background_tasks_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#get_background_task(task_id, opts = {}) ⇒ BackgroundTaskOut
Get Background Task Get a background task by ID.
27 28 29 30 |
# File 'lib/svix/api/background_tasks_api.rb', line 27 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_with_http_info(task_id, opts = {}) ⇒ Array<(BackgroundTaskOut, Integer, Hash)>
Get Background Task Get a background task by ID.
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
# File 'lib/svix/api/background_tasks_api.rb', line 37 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] || ['HTTPBearer'] = 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, ) 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(opts = {}) ⇒ ListResponseBackgroundTaskOut
List Background Tasks List background tasks executed in the past 90 days.
94 95 96 97 |
# File 'lib/svix/api/background_tasks_api.rb', line 94 def list_background_tasks(opts = {}) data, _status_code, _headers = list_background_tasks_with_http_info(opts) data end |
#list_background_tasks_with_http_info(opts = {}) ⇒ Array<(ListResponseBackgroundTaskOut, Integer, Hash)>
List Background Tasks List background tasks executed in the past 90 days.
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 |
# File 'lib/svix/api/background_tasks_api.rb', line 108 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'] > 250 fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling BackgroundTasksApi.list_background_tasks, must be smaller than or equal to 250.' end if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1 fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling BackgroundTasksApi.list_background_tasks, must be greater than or equal to 1.' 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] || ['HTTPBearer'] = 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, ) 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 |