smplkit 3.0.82 → 3.0.83

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75775d5e9d52e0059125f85cd2490a821e06008100aab97ccbc08e14982d4962
-  data.tar.gz: d3545d806795f19cc51bda19b2f0c6a2c44c52dbfbb6235da16fe436e808315d
+  metadata.gz: 9c306fbb8f49cc593c4988f4717f10ad634ff28c768b87e132ce8a9e15395962
+  data.tar.gz: 10ad1f6409a137133bb63f43f856e48022ca3d6cddd398a5d1aa15e6d8b026b4
 SHA512:
-  metadata.gz: 9f83bcad6063d097ddab756c43d5d45653255d39c837bdd79a9ca5c71383b8836245462866a1ce346cdc0660c82035a1992bdf2723f11a76446a96f11ed34ced
-  data.tar.gz: b6600ead26b7bf353353538adf9e0133462840474ad8f73b745281de271e8c0ff354b6bf52db54f985606fc725b9070e489634fed8d2e9ad14e4166a3e585914
+  metadata.gz: d2469ab35543347240453b9e90f8913f638049730052e1b306a139cda51ea6fbc5de85abcc3842bb3dfb1691bc089151205799cdac2feff6027b6eb5c07da860
+  data.tar.gz: 5f8aa745f79295e3cb7df2280432a5eae1cacde66ad510b639b7409ccbda84065a73c333255dbf62a464b32123608f9bb5265d708ea79afe4de63c49edb6cae7

data/lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/api/jobs_api.rb

@@ -0,0 +1,420 @@
+=begin
+#smplkit Jobs API
+
+#Scheduled HTTP job execution API for smplkit.
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'cgi'
+
+module SmplkitGeneratedClient::Jobs
+  class JobsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create Job
+    # Create a job for this account.  The caller supplies the job's id (a slug) as `data.id`. Slugs are unique within an account and immutable. An enabled job begins scheduling immediately.
+    # @param job_create_request [JobCreateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [JobResponse]
+    def create_job(job_create_request, opts = {})
+      data, _status_code, _headers = create_job_with_http_info(job_create_request, opts)
+      data
+    end
+
+    # Create Job
+    # Create a job for this account.  The caller supplies the job's id (a slug) as `data.id`. Slugs are unique within an account and immutable. An enabled job begins scheduling immediately.
+    # @param job_create_request [JobCreateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(JobResponse, Integer, Hash)>] JobResponse data, response status code and response headers
+    def create_job_with_http_info(job_create_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: JobsApi.create_job ...'
+      end
+      # verify the required parameter 'job_create_request' is set
+      if @api_client.config.client_side_validation && job_create_request.nil?
+        fail ArgumentError, "Missing the required parameter 'job_create_request' when calling JobsApi.create_job"
+      end
+      # resource path
+      local_var_path = '/api/v1/jobs'
+
+      # 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/vnd.api+json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(job_create_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'JobResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"JobsApi.create_job",
+        :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: JobsApi#create_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete Job
+    # Delete a job. Its run history is retained; the slug may be reused later.
+    # @param job_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_job(job_id, opts = {})
+      delete_job_with_http_info(job_id, opts)
+      nil
+    end
+
+    # Delete Job
+    # Delete a job. Its run history is retained; the slug may be reused later.
+    # @param job_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_job_with_http_info(job_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: JobsApi.delete_job ...'
+      end
+      # verify the required parameter 'job_id' is set
+      if @api_client.config.client_side_validation && job_id.nil?
+        fail ArgumentError, "Missing the required parameter 'job_id' when calling JobsApi.delete_job"
+      end
+      # resource path
+      local_var_path = '/api/v1/jobs/{job_id}'.sub('{job_id}', CGI.escape(job_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"JobsApi.delete_job",
+        :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(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: JobsApi#delete_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Job
+    # Retrieve a single job by its id (slug).
+    # @param job_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [JobResponse]
+    def get_job(job_id, opts = {})
+      data, _status_code, _headers = get_job_with_http_info(job_id, opts)
+      data
+    end
+
+    # Get Job
+    # Retrieve a single job by its id (slug).
+    # @param job_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(JobResponse, Integer, Hash)>] JobResponse data, response status code and response headers
+    def get_job_with_http_info(job_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: JobsApi.get_job ...'
+      end
+      # verify the required parameter 'job_id' is set
+      if @api_client.config.client_side_validation && job_id.nil?
+        fail ArgumentError, "Missing the required parameter 'job_id' when calling JobsApi.get_job"
+      end
+      # resource path
+      local_var_path = '/api/v1/jobs/{job_id}'.sub('{job_id}', CGI.escape(job_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/vnd.api+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] || 'JobResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"JobsApi.get_job",
+        :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: JobsApi#get_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List Jobs
+    # List this account's jobs, newest first.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :filter_enabled 
+    # @option opts [Integer] :page_number 1-based page number to return. Optional; defaults to &#x60;1&#x60; when omitted. Must be &#x60;&gt;&#x3D; 1&#x60; — requests with a smaller value are rejected with a 400 error. (default to 1)
+    # @option opts [Integer] :page_size Number of items per page. Optional; defaults to &#x60;1000&#x60; when omitted. Must be between &#x60;1&#x60; and &#x60;1000&#x60; inclusive — requests outside that range are rejected with a 400 error. (default to 1000)
+    # @option opts [Boolean] :meta_total When &#x60;true&#x60;, the response&#39;s &#x60;meta.pagination&#x60; block includes &#x60;total&#x60; (the total number of matching items across all pages) and &#x60;total_pages&#x60;. Computing these requires an extra &#x60;COUNT&#x60; query, so omit (or pass &#x60;false&#x60;) when the totals are not needed. Defaults to &#x60;false&#x60;. (default to false)
+    # @return [JobListResponse]
+    def list_jobs(opts = {})
+      data, _status_code, _headers = list_jobs_with_http_info(opts)
+      data
+    end
+
+    # List Jobs
+    # List this account&#39;s jobs, newest first.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :filter_enabled 
+    # @option opts [Integer] :page_number 1-based page number to return. Optional; defaults to &#x60;1&#x60; when omitted. Must be &#x60;&gt;&#x3D; 1&#x60; — requests with a smaller value are rejected with a 400 error. (default to 1)
+    # @option opts [Integer] :page_size Number of items per page. Optional; defaults to &#x60;1000&#x60; when omitted. Must be between &#x60;1&#x60; and &#x60;1000&#x60; inclusive — requests outside that range are rejected with a 400 error. (default to 1000)
+    # @option opts [Boolean] :meta_total When &#x60;true&#x60;, the response&#39;s &#x60;meta.pagination&#x60; block includes &#x60;total&#x60; (the total number of matching items across all pages) and &#x60;total_pages&#x60;. Computing these requires an extra &#x60;COUNT&#x60; query, so omit (or pass &#x60;false&#x60;) when the totals are not needed. Defaults to &#x60;false&#x60;. (default to false)
+    # @return [Array<(JobListResponse, Integer, Hash)>] JobListResponse data, response status code and response headers
+    def list_jobs_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: JobsApi.list_jobs ...'
+      end
+      # resource path
+      local_var_path = '/api/v1/jobs'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'filter[enabled]'] = opts[:'filter_enabled'] if !opts[:'filter_enabled'].nil?
+      query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
+      query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'meta[total]'] = opts[:'meta_total'] if !opts[:'meta_total'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+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] || 'JobListResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"JobsApi.list_jobs",
+        :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: JobsApi#list_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Run Job Now
+    # Trigger one immediate run of the job (a `MANUAL` run).  The job's schedule and enabled state are untouched. The run is enqueued and executed by the worker; if the account is over its run allotment the run will fail with reason `QUOTA_EXCEEDED` rather than being rejected here.
+    # @param job_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [RunResponse]
+    def run_job_now(job_id, opts = {})
+      data, _status_code, _headers = run_job_now_with_http_info(job_id, opts)
+      data
+    end
+
+    # Run Job Now
+    # Trigger one immediate run of the job (a &#x60;MANUAL&#x60; run).  The job&#39;s schedule and enabled state are untouched. The run is enqueued and executed by the worker; if the account is over its run allotment the run will fail with reason &#x60;QUOTA_EXCEEDED&#x60; rather than being rejected here.
+    # @param job_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RunResponse, Integer, Hash)>] RunResponse data, response status code and response headers
+    def run_job_now_with_http_info(job_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: JobsApi.run_job_now ...'
+      end
+      # verify the required parameter 'job_id' is set
+      if @api_client.config.client_side_validation && job_id.nil?
+        fail ArgumentError, "Missing the required parameter 'job_id' when calling JobsApi.run_job_now"
+      end
+      # resource path
+      local_var_path = '/api/v1/jobs/{job_id}/actions/run'.sub('{job_id}', CGI.escape(job_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/vnd.api+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] || 'RunResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"JobsApi.run_job_now",
+        :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: JobsApi#run_job_now\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update Job
+    # Replace an existing job. Every writable field is overwritten.  Enabling a paused job is a `PUT` with `enabled: true`; pausing is `enabled: false`. Editing the schedule recomputes the next fire time.
+    # @param job_id [String] 
+    # @param job_request [JobRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [JobResponse]
+    def update_job(job_id, job_request, opts = {})
+      data, _status_code, _headers = update_job_with_http_info(job_id, job_request, opts)
+      data
+    end
+
+    # Update Job
+    # Replace an existing job. Every writable field is overwritten.  Enabling a paused job is a &#x60;PUT&#x60; with &#x60;enabled: true&#x60;; pausing is &#x60;enabled: false&#x60;. Editing the schedule recomputes the next fire time.
+    # @param job_id [String] 
+    # @param job_request [JobRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(JobResponse, Integer, Hash)>] JobResponse data, response status code and response headers
+    def update_job_with_http_info(job_id, job_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: JobsApi.update_job ...'
+      end
+      # verify the required parameter 'job_id' is set
+      if @api_client.config.client_side_validation && job_id.nil?
+        fail ArgumentError, "Missing the required parameter 'job_id' when calling JobsApi.update_job"
+      end
+      # verify the required parameter 'job_request' is set
+      if @api_client.config.client_side_validation && job_request.nil?
+        fail ArgumentError, "Missing the required parameter 'job_request' when calling JobsApi.update_job"
+      end
+      # resource path
+      local_var_path = '/api/v1/jobs/{job_id}'.sub('{job_id}', CGI.escape(job_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/vnd.api+json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(job_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'JobResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"JobsApi.update_job",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: JobsApi#update_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end