smplkit 3.0.82 → 3.0.83

data/lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/usage_response.rb

@@ -0,0 +1,165 @@
+=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 'date'
+require 'time'
+
+module SmplkitGeneratedClient::Jobs
+  # JSON:API single-resource response for usage.
+  class UsageResponse < ApiModelBase
+    attr_accessor :data
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data' => :'data'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'data' => :'UsageResource'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SmplkitGeneratedClient::Jobs::UsageResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SmplkitGeneratedClient::Jobs::UsageResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'data')
+        self.data = attributes[:'data']
+      else
+        self.data = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @data.nil?
+        invalid_properties.push('invalid value for "data", data cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @data.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] data Value to be assigned
+    def data=(data)
+      if data.nil?
+        fail ArgumentError, 'data cannot be nil'
+      end
+
+      @data = data
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          data == o.data
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [data].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end

data/lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/version.rb

@@ -0,0 +1,15 @@
+=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
+
+module SmplkitGeneratedClient::Jobs
+  VERSION = '0.0.0'
+end

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

@@ -0,0 +1,63 @@
+=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
+
+# Common files
+require 'smplkit_jobs_client/api_client'
+require 'smplkit_jobs_client/api_error'
+require 'smplkit_jobs_client/api_model_base'
+require 'smplkit_jobs_client/version'
+require 'smplkit_jobs_client/configuration'
+
+# Models
+require 'smplkit_jobs_client/models/http_header'
+require 'smplkit_jobs_client/models/job'
+require 'smplkit_jobs_client/models/job_create_request'
+require 'smplkit_jobs_client/models/job_create_resource'
+require 'smplkit_jobs_client/models/job_http_configuration'
+require 'smplkit_jobs_client/models/job_list_response'
+require 'smplkit_jobs_client/models/job_request'
+require 'smplkit_jobs_client/models/job_resource'
+require 'smplkit_jobs_client/models/job_response'
+require 'smplkit_jobs_client/models/list_meta'
+require 'smplkit_jobs_client/models/pagination_meta'
+require 'smplkit_jobs_client/models/run'
+require 'smplkit_jobs_client/models/run_list_links'
+require 'smplkit_jobs_client/models/run_list_meta'
+require 'smplkit_jobs_client/models/run_list_response'
+require 'smplkit_jobs_client/models/run_resource'
+require 'smplkit_jobs_client/models/run_response'
+require 'smplkit_jobs_client/models/usage'
+require 'smplkit_jobs_client/models/usage_resource'
+require 'smplkit_jobs_client/models/usage_response'
+
+# APIs
+require 'smplkit_jobs_client/api/jobs_api'
+require 'smplkit_jobs_client/api/runs_api'
+require 'smplkit_jobs_client/api/usage_api'
+
+module SmplkitGeneratedClient::Jobs
+  class << self
+    # Customize default settings for the SDK using block.
+    #   SmplkitGeneratedClient::Jobs.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/lib/smplkit/_generated/jobs/spec/api/jobs_api_spec.rb

@@ -0,0 +1,111 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for SmplkitGeneratedClient::Jobs::JobsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'JobsApi' do
+  before do
+    # run before each test
+    @api_instance = SmplkitGeneratedClient::Jobs::JobsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of JobsApi' do
+    it 'should create an instance of JobsApi' do
+      expect(@api_instance).to be_instance_of(SmplkitGeneratedClient::Jobs::JobsApi)
+    end
+  end
+
+  # unit tests for create_job
+  # 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 
+  # @param [Hash] opts the optional parameters
+  # @return [JobResponse]
+  describe 'create_job test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for delete_job
+  # Delete Job
+  # Delete a job. Its run history is retained; the slug may be reused later.
+  # @param job_id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_job test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_job
+  # Get Job
+  # Retrieve a single job by its id (slug).
+  # @param job_id 
+  # @param [Hash] opts the optional parameters
+  # @return [JobResponse]
+  describe 'get_job test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for list_jobs
+  # 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 `1` when omitted. Must be `>= 1` — requests with a smaller value are rejected with a 400 error.
+  # @option opts [Integer] :page_size Number of items per page. Optional; defaults to `1000` when omitted. Must be between `1` and `1000` inclusive — requests outside that range are rejected with a 400 error.
+  # @option opts [Boolean] :meta_total When `true`, the response's `meta.pagination` block includes `total` (the total number of matching items across all pages) and `total_pages`. Computing these requires an extra `COUNT` query, so omit (or pass `false`) when the totals are not needed. Defaults to `false`.
+  # @return [JobListResponse]
+  describe 'list_jobs test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for run_job_now
+  # 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 
+  # @param [Hash] opts the optional parameters
+  # @return [RunResponse]
+  describe 'run_job_now test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for update_job
+  # 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 
+  # @param job_request 
+  # @param [Hash] opts the optional parameters
+  # @return [JobResponse]
+  describe 'update_job test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/lib/smplkit/_generated/jobs/spec/api/runs_api_spec.rb

@@ -0,0 +1,85 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for SmplkitGeneratedClient::Jobs::RunsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'RunsApi' do
+  before do
+    # run before each test
+    @api_instance = SmplkitGeneratedClient::Jobs::RunsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of RunsApi' do
+    it 'should create an instance of RunsApi' do
+      expect(@api_instance).to be_instance_of(SmplkitGeneratedClient::Jobs::RunsApi)
+    end
+  end
+
+  # unit tests for cancel_run
+  # Cancel Run
+  # Cancel a pending or running run.  Returns `409` if the run is already in a terminal state. Canceling a running run stops us tracking it, but the HTTP request may already be in flight — cancel means \"stop tracking,\" not \"guaranteed it didn't happen.\"
+  # @param run_id 
+  # @param [Hash] opts the optional parameters
+  # @return [RunResponse]
+  describe 'cancel_run test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_run
+  # Get Run
+  # Retrieve a single run by its id.
+  # @param run_id 
+  # @param [Hash] opts the optional parameters
+  # @return [RunResponse]
+  describe 'get_run test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for list_runs
+  # List Runs
+  # List runs for this account, newest first (cursor paginated).  Use `filter[job]={slug}` for a single job's run history.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :filter_job 
+  # @option opts [Integer] :page_size 
+  # @option opts [String] :page_after 
+  # @return [RunListResponse]
+  describe 'list_runs test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for rerun_run
+  # Rerun Run
+  # Spawn a new run from a prior run, using the job's current configuration.  Returns `409` if the run's parent job has been deleted.
+  # @param run_id 
+  # @param [Hash] opts the optional parameters
+  # @return [RunResponse]
+  describe 'rerun_run test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/lib/smplkit/_generated/jobs/spec/api/usage_api_spec.rb

@@ -0,0 +1,47 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for SmplkitGeneratedClient::Jobs::UsageApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'UsageApi' do
+  before do
+    # run before each test
+    @api_instance = SmplkitGeneratedClient::Jobs::UsageApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of UsageApi' do
+    it 'should create an instance of UsageApi' do
+      expect(@api_instance).to be_instance_of(SmplkitGeneratedClient::Jobs::UsageApi)
+    end
+  end
+
+  # unit tests for get_usage
+  # Get Usage
+  # Report this account's current-period usage against its plan allotments.  `runs_used` is the number of runs metered so far this calendar month; `active_jobs` is the number of currently-enabled jobs.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :filter_period 
+  # @return [UsageResponse]
+  describe 'get_usage test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/lib/smplkit/_generated/jobs/spec/models/http_header_spec.rb

@@ -0,0 +1,42 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SmplkitGeneratedClient::Jobs::HttpHeader
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe SmplkitGeneratedClient::Jobs::HttpHeader do
+  #let(:instance) { SmplkitGeneratedClient::Jobs::HttpHeader.new }
+
+  describe 'test an instance of HttpHeader' do
+    it 'should create an instance of HttpHeader' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(SmplkitGeneratedClient::Jobs::HttpHeader)
+    end
+  end
+
+  describe 'test attribute "name"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "value"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/lib/smplkit/_generated/jobs/spec/models/job_create_request_spec.rb

@@ -0,0 +1,36 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SmplkitGeneratedClient::Jobs::JobCreateRequest
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe SmplkitGeneratedClient::Jobs::JobCreateRequest do
+  #let(:instance) { SmplkitGeneratedClient::Jobs::JobCreateRequest.new }
+
+  describe 'test an instance of JobCreateRequest' do
+    it 'should create an instance of JobCreateRequest' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(SmplkitGeneratedClient::Jobs::JobCreateRequest)
+    end
+  end
+
+  describe 'test attribute "data"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/lib/smplkit/_generated/jobs/spec/models/job_create_resource_spec.rb

@@ -0,0 +1,52 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SmplkitGeneratedClient::Jobs::JobCreateResource
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe SmplkitGeneratedClient::Jobs::JobCreateResource do
+  #let(:instance) { SmplkitGeneratedClient::Jobs::JobCreateResource.new }
+
+  describe 'test an instance of JobCreateResource' do
+    it 'should create an instance of JobCreateResource' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(SmplkitGeneratedClient::Jobs::JobCreateResource)
+    end
+  end
+
+  describe 'test attribute "id"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "type"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["job"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.type = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "attributes"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end