smplkit 3.0.118 → 3.0.119

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04fadfa766349cc993a30eed1a237b3791ec4185ba19fe7e654260126c4b7f85
-  data.tar.gz: a7ce4b99c41b98fcddb8926d10cfa74cd61e00873b65ad736c48ec48b1a194d0
+  metadata.gz: 9911186cf0810c9d76cc16feb24f9a155d8c6708fce3edc406b581b5c9376f1c
+  data.tar.gz: '009441ca636ade20f9f9a4cbec10d9ea9d2255b81549a2bc7e1274a94091e05d'
 SHA512:
-  metadata.gz: 7ce5ce6b39a7d00c08a38c1219382522b5cc4e9e974bd68b0aec564519ca061fd227af19fca822c94b2c12bd9035bafb993fa966bc8867d077e12ff769812568
-  data.tar.gz: b8049752ea39cfa22aa158ced47f31a40d018c572f6927bd4243c133e60d83d97032a3c7f7a269894aaf52cf5fe784f44c4ff568856f837b0a5f5fcab153e9a8
+  metadata.gz: 5558c39aa882f3bc403613ac51bf20b8f8dddbd4eb663126847a6b5f3a0c5fd961ec13f939c274e3c39c46f3cc2af8d2e44540b999c1e6e4b2239e1a1886e4ec
+  data.tar.gz: e944872fdef51e90924897ee1173e0dcad70f36255e95a1372f99690f238478852890e54ba1c1a62bbebab2fd7b73f81cecbb4a27591cb79382a348edb46657c

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

@@ -20,7 +20,7 @@ module SmplkitGeneratedClient::Jobs
       @api_client = api_client
     end
     # 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.\"
+    # Cancel a pending or running run.  Returns `404` if the run does not exist and `409` if it 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.\" A run that has already started running still counts toward your monthly run allowance even if you cancel it; a run canceled while it is still pending does not count.
     # @param run_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [RunResponse]
@@ -30,7 +30,7 @@ module SmplkitGeneratedClient::Jobs
     end
 
     # 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.\"
+    # Cancel a pending or running run.  Returns `404` if the run does not exist and `409` if it 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.\" A run that has already started running still counts toward your monthly run allowance even if you cancel it; a run canceled while it is still pending does not count.
     # @param run_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(RunResponse, Integer, Hash)>] RunResponse data, response status code and response headers
@@ -247,7 +247,7 @@ module SmplkitGeneratedClient::Jobs
     end
 
     # 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.
+    # Spawn a new run from a prior run, using the job's current configuration.  Returns `404` if the run does not exist and `409` if the run's parent job has been deleted.
     # @param run_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [RunResponse]
@@ -257,7 +257,7 @@ module SmplkitGeneratedClient::Jobs
     end
 
     # Rerun Run
-    # Spawn a new run from a prior run, using the job&#39;s current configuration.  Returns &#x60;409&#x60; if the run&#39;s parent job has been deleted.
+    # Spawn a new run from a prior run, using the job&#39;s current configuration.  Returns &#x60;404&#x60; if the run does not exist and &#x60;409&#x60; if the run&#39;s parent job has been deleted.
     # @param run_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(RunResponse, Integer, Hash)>] RunResponse data, response status code and response headers

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

@@ -0,0 +1,213 @@
+=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
+  # Single JSON:API error object.
+  class Error < ApiModelBase
+    attr_accessor :status
+
+    attr_accessor :title
+
+    attr_accessor :detail
+
+    attr_accessor :source
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'status' => :'status',
+        :'title' => :'title',
+        :'detail' => :'detail',
+        :'source' => :'source'
+      }
+    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
+      {
+        :'status' => :'String',
+        :'title' => :'String',
+        :'detail' => :'String',
+        :'source' => :'Hash<String, Object>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'detail',
+        :'source'
+      ])
+    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::Error` 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::Error`. 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?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      else
+        self.title = nil
+      end
+
+      if attributes.key?(:'detail')
+        self.detail = attributes[:'detail']
+      end
+
+      if attributes.key?(:'source')
+        if (value = attributes[:'source']).is_a?(Hash)
+          self.source = value
+        end
+      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 @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @title.nil?
+        invalid_properties.push('invalid value for "title", title 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 @status.nil?
+      return false if @title.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] status Value to be assigned
+    def status=(status)
+      if status.nil?
+        fail ArgumentError, 'status cannot be nil'
+      end
+
+      @status = status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] title Value to be assigned
+    def title=(title)
+      if title.nil?
+        fail ArgumentError, 'title cannot be nil'
+      end
+
+      @title = title
+    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 &&
+          status == o.status &&
+          title == o.title &&
+          detail == o.detail &&
+          source == o.source
+    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
+      [status, title, detail, source].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/models/error_response.rb

@@ -0,0 +1,167 @@
+=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 error response envelope.
+  class ErrorResponse < ApiModelBase
+    attr_accessor :errors
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'errors' => :'errors'
+      }
+    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
+      {
+        :'errors' => :'Array<Error>'
+      }
+    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::ErrorResponse` 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::ErrorResponse`. 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?(:'errors')
+        if (value = attributes[:'errors']).is_a?(Array)
+          self.errors = value
+        end
+      else
+        self.errors = 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 @errors.nil?
+        invalid_properties.push('invalid value for "errors", errors 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 @errors.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] errors Value to be assigned
+    def errors=(errors)
+      if errors.nil?
+        fail ArgumentError, 'errors cannot be nil'
+      end
+
+      @errors = errors
+    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 &&
+          errors == o.errors
+    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
+      [errors].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.rb

@@ -18,6 +18,8 @@ require 'smplkit_jobs_client/version'
 require 'smplkit_jobs_client/configuration'
 
 # Models
+require 'smplkit_jobs_client/models/error'
+require 'smplkit_jobs_client/models/error_response'
 require 'smplkit_jobs_client/models/http_header'
 require 'smplkit_jobs_client/models/job'
 require 'smplkit_jobs_client/models/job_create_request'

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

@@ -34,7 +34,7 @@ describe 'RunsApi' do
 
   # 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.\"
+  # Cancel a pending or running run.  Returns `404` if the run does not exist and `409` if it 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.\" A run that has already started running still counts toward your monthly run allowance even if you cancel it; a run canceled while it is still pending does not count.
   # @param run_id 
   # @param [Hash] opts the optional parameters
   # @return [RunResponse]
@@ -81,7 +81,7 @@ describe 'RunsApi' do
 
   # 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.
+  # Spawn a new run from a prior run, using the job's current configuration.  Returns `404` if the run does not exist and `409` if the run's parent job has been deleted.
   # @param run_id 
   # @param [Hash] opts the optional parameters
   # @return [RunResponse]

data/lib/smplkit/_generated/jobs/spec/models/error_response_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::ErrorResponse
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe SmplkitGeneratedClient::Jobs::ErrorResponse do
+  #let(:instance) { SmplkitGeneratedClient::Jobs::ErrorResponse.new }
+
+  describe 'test an instance of ErrorResponse' do
+    it 'should create an instance of ErrorResponse' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(SmplkitGeneratedClient::Jobs::ErrorResponse)
+    end
+  end
+
+  describe 'test attribute "errors"' 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/error_spec.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smplkit
 version: !ruby/object:Gem::Version
-  version: 3.0.118
+  version: 3.0.119
 platform: ruby
 authors:
 - Smpl Solutions LLC
@@ -764,6 +764,8 @@ files:
 - lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/api_error.rb
 - lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/api_model_base.rb
 - lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/configuration.rb
+- lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/error.rb
+- lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/error_response.rb
 - lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/http_header.rb
 - lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/job.rb
 - lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/job_create_request.rb
@@ -799,6 +801,8 @@ files:
 - lib/smplkit/_generated/jobs/spec/api/retry_policies_api_spec.rb
 - lib/smplkit/_generated/jobs/spec/api/runs_api_spec.rb
 - lib/smplkit/_generated/jobs/spec/api/usage_api_spec.rb
+- lib/smplkit/_generated/jobs/spec/models/error_response_spec.rb
+- lib/smplkit/_generated/jobs/spec/models/error_spec.rb
 - lib/smplkit/_generated/jobs/spec/models/http_header_spec.rb
 - lib/smplkit/_generated/jobs/spec/models/job_create_request_spec.rb
 - lib/smplkit/_generated/jobs/spec/models/job_create_resource_spec.rb