smplkit 3.0.56 → 3.0.57

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74d41ad288136751834d3d7aa631ddfff4fcf6b6fc4e6e05b82f6c12c2bc90e9
-  data.tar.gz: db65e4fa1e1b1efae7e9bdb4b729c603c5d60671d1942fe950f82a2795687701
+  metadata.gz: 7c1d34fa4489a303254962e23037830b21f8668d4fe8c7a2d235e689247f2931
+  data.tar.gz: 1d20b1833431fc1dfd1bb862d1a346c46534da84cce86ae41c1bdcc7b3171191
 SHA512:
-  metadata.gz: f19f199b0a6bde6b1d9b110ccbed94a5fa66d93caf8dfb1dd729d552dde2f3f02e1f19b1f9d7e0025425967a573b9839e941a9a51f422e5cc5a1af870e924efc
-  data.tar.gz: 372d6d2dbf2cb66084066093185a5a534fd36a9df01acb9544010fc18c12855cfcb314668d465c50a92c6e6f05f862e5f884a7beb410a97a6decde1ebb0ea537
+  metadata.gz: 8d9d9996e1a73b8e1937677798670bf1c02a0a5f87f125bf06dacc3523c9fa12ef50d797f8094208d3353285af65edb1e03d47d500212875c64a99c47097b8f9
+  data.tar.gz: 37448fac41ec69fbce2bd7cee46d94f3f47856f9fa2e225820a88816992e2077a0105164e87666d5904f3ca88be9901f59f55d1133076b1d1e274065a87527a8

data/lib/smplkit/_generated/config/lib/smplkit_config_client/api/configs_api.rb

@@ -89,26 +89,26 @@ module SmplkitGeneratedClient::Config
 
     # Create Config
     # Create a config for this account.  The caller supplies the config's key as `data.id`. Keys are unique within an account and immutable for the lifetime of the config.
-    # @param config_request [ConfigRequest] 
+    # @param config_create_request [ConfigCreateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [ConfigResponse]
-    def create_config(config_request, opts = {})
-      data, _status_code, _headers = create_config_with_http_info(config_request, opts)
+    def create_config(config_create_request, opts = {})
+      data, _status_code, _headers = create_config_with_http_info(config_create_request, opts)
       data
     end
 
     # Create Config
     # Create a config for this account.  The caller supplies the config's key as `data.id`. Keys are unique within an account and immutable for the lifetime of the config.
-    # @param config_request [ConfigRequest] 
+    # @param config_create_request [ConfigCreateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ConfigResponse, Integer, Hash)>] ConfigResponse data, response status code and response headers
-    def create_config_with_http_info(config_request, opts = {})
+    def create_config_with_http_info(config_create_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ConfigsApi.create_config ...'
       end
-      # verify the required parameter 'config_request' is set
-      if @api_client.config.client_side_validation && config_request.nil?
-        fail ArgumentError, "Missing the required parameter 'config_request' when calling ConfigsApi.create_config"
+      # verify the required parameter 'config_create_request' is set
+      if @api_client.config.client_side_validation && config_create_request.nil?
+        fail ArgumentError, "Missing the required parameter 'config_create_request' when calling ConfigsApi.create_config"
       end
       # resource path
       local_var_path = '/api/v1/configs'
@@ -130,7 +130,7 @@ module SmplkitGeneratedClient::Config
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(config_request)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(config_create_request)
 
       # return_type
       return_type = opts[:debug_return_type] || 'ConfigResponse'

data/lib/smplkit/_generated/config/lib/smplkit_config_client/models/config_create_request.rb

@@ -0,0 +1,165 @@
+=begin
+#smplkit Config API
+
+#Configuration management 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::Config
+  # JSON:API request envelope for creating a config.  Distinct from :class:`ConfigRequest` because create requires caller-supplied ``data.id`` while update does not.
+  class ConfigCreateRequest < 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' => :'ConfigCreateResource'
+      }
+    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::Config::ConfigCreateRequest` 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::Config::ConfigCreateRequest`. 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/config/lib/smplkit_config_client/models/config_create_resource.rb

@@ -0,0 +1,242 @@
+=begin
+#smplkit Config API
+
+#Configuration management 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::Config
+  # JSON:API resource envelope for creating a config (id required).
+  class ConfigCreateResource < ApiModelBase
+    # Client-supplied resource id.
+    attr_accessor :id
+
+    attr_accessor :type
+
+    attr_accessor :attributes
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'type' => :'type',
+        :'attributes' => :'attributes'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'type' => :'String',
+        :'attributes' => :'Config'
+      }
+    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::Config::ConfigCreateResource` 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::Config::ConfigCreateResource`. 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?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'attributes')
+        self.attributes = attributes[:'attributes']
+      else
+        self.attributes = 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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @attributes.nil?
+        invalid_properties.push('invalid value for "attributes", attributes 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 @id.nil?
+      return false if @type.nil?
+      type_validator = EnumAttributeValidator.new('String', ["config"])
+      return false unless type_validator.valid?(@type)
+      return false if @attributes.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["config"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] attributes Value to be assigned
+    def attributes=(attributes)
+      if attributes.nil?
+        fail ArgumentError, 'attributes cannot be nil'
+      end
+
+      @attributes = attributes
+    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 &&
+          id == o.id &&
+          type == o.type &&
+          attributes == o.attributes
+    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
+      [id, type, attributes].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/config/lib/smplkit_config_client/models/config_request.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Config
-  # JSON:API request envelope for creating or updating a config.
+  # JSON:API request envelope for updating a config.
   class ConfigRequest < ApiModelBase
     attr_accessor :data
 

data/lib/smplkit/_generated/config/lib/smplkit_config_client.rb

@@ -22,6 +22,8 @@ require 'smplkit_config_client/models/config'
 require 'smplkit_config_client/models/config_bulk_item'
 require 'smplkit_config_client/models/config_bulk_request'
 require 'smplkit_config_client/models/config_bulk_response'
+require 'smplkit_config_client/models/config_create_request'
+require 'smplkit_config_client/models/config_create_resource'
 require 'smplkit_config_client/models/config_item_definition'
 require 'smplkit_config_client/models/config_item_override'
 require 'smplkit_config_client/models/config_list_response'

data/lib/smplkit/_generated/config/spec/api/configs_api_spec.rb

@@ -47,7 +47,7 @@ describe 'ConfigsApi' do
   # unit tests for create_config
   # Create Config
   # Create a config for this account.  The caller supplies the config's key as `data.id`. Keys are unique within an account and immutable for the lifetime of the config.
-  # @param config_request 
+  # @param config_create_request 
   # @param [Hash] opts the optional parameters
   # @return [ConfigResponse]
   describe 'create_config test' do

data/lib/smplkit/_generated/config/spec/models/config_create_request_spec.rb

@@ -0,0 +1,36 @@
+=begin
+#smplkit Config API
+
+#Configuration management 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::Config::ConfigCreateRequest
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe SmplkitGeneratedClient::Config::ConfigCreateRequest do
+  #let(:instance) { SmplkitGeneratedClient::Config::ConfigCreateRequest.new }
+
+  describe 'test an instance of ConfigCreateRequest' do
+    it 'should create an instance of ConfigCreateRequest' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(SmplkitGeneratedClient::Config::ConfigCreateRequest)
+    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/config/spec/models/config_create_resource_spec.rb

@@ -0,0 +1,52 @@
+=begin
+#smplkit Config API
+
+#Configuration management 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::Config::ConfigCreateResource
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe SmplkitGeneratedClient::Config::ConfigCreateResource do
+  #let(:instance) { SmplkitGeneratedClient::Config::ConfigCreateResource.new }
+
+  describe 'test an instance of ConfigCreateResource' do
+    it 'should create an instance of ConfigCreateResource' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(SmplkitGeneratedClient::Config::ConfigCreateResource)
+    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', ["config"])
+      # 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smplkit
 version: !ruby/object:Gem::Version
-  version: 3.0.56
+  version: 3.0.57
 platform: ruby
 authors:
 - Smpl Solutions LLC
@@ -566,6 +566,8 @@ files:
 - lib/smplkit/_generated/config/lib/smplkit_config_client/models/config_bulk_item.rb
 - lib/smplkit/_generated/config/lib/smplkit_config_client/models/config_bulk_request.rb
 - lib/smplkit/_generated/config/lib/smplkit_config_client/models/config_bulk_response.rb
+- lib/smplkit/_generated/config/lib/smplkit_config_client/models/config_create_request.rb
+- lib/smplkit/_generated/config/lib/smplkit_config_client/models/config_create_resource.rb
 - lib/smplkit/_generated/config/lib/smplkit_config_client/models/config_item_definition.rb
 - lib/smplkit/_generated/config/lib/smplkit_config_client/models/config_item_override.rb
 - lib/smplkit/_generated/config/lib/smplkit_config_client/models/config_list_response.rb
@@ -584,6 +586,8 @@ files:
 - lib/smplkit/_generated/config/spec/models/config_bulk_item_spec.rb
 - lib/smplkit/_generated/config/spec/models/config_bulk_request_spec.rb
 - lib/smplkit/_generated/config/spec/models/config_bulk_response_spec.rb
+- lib/smplkit/_generated/config/spec/models/config_create_request_spec.rb
+- lib/smplkit/_generated/config/spec/models/config_create_resource_spec.rb
 - lib/smplkit/_generated/config/spec/models/config_item_definition_spec.rb
 - lib/smplkit/_generated/config/spec/models/config_item_override_spec.rb
 - lib/smplkit/_generated/config/spec/models/config_list_response_spec.rb