stackone_hris_client 1.3.1 → 1.4.0

data/lib/stackone_hris_client/models/pay_period_enum.rb

@@ -0,0 +1,270 @@
+=begin
+#StackOne Unified API - HRIS
+
+#The documentation for the StackOne Unified API - HRIS
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.5.0
+
+=end
+
+require 'date'
+require 'time'
+
+module StackOneHRIS
+  class PayPeriodEnum
+    attr_accessor :value
+
+    attr_accessor :source_value
+
+    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
+      {
+        :'value' => :'value',
+        :'source_value' => :'source_value'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'value' => :'String',
+        :'source_value' => :'String'
+      }
+    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 `StackOneHRIS::PayPeriodEnum` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `StackOneHRIS::PayPeriodEnum`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'value')
+        self.value = attributes[:'value']
+      end
+
+      if attributes.key?(:'source_value')
+        self.source_value = attributes[:'source_value']
+      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
+      invalid_properties = Array.new
+      if @value.nil?
+        invalid_properties.push('invalid value for "value", value cannot be nil.')
+      end
+
+      if @source_value.nil?
+        invalid_properties.push('invalid value for "source_value", source_value 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?
+      return false if @value.nil?
+      value_validator = EnumAttributeValidator.new('String', ["hour", "day", "week", "every_two_weeks", "month", "quarter", "every_six_months", "year", "unmapped_value"])
+      return false unless value_validator.valid?(@value)
+      return false if @source_value.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] value Object to be assigned
+    def value=(value)
+      validator = EnumAttributeValidator.new('String', ["hour", "day", "week", "every_two_weeks", "month", "quarter", "every_six_months", "year", "unmapped_value"])
+      unless validator.valid?(value)
+        fail ArgumentError, "invalid value for \"value\", must be one of #{validator.allowable_values}."
+      end
+      @value = value
+    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 &&
+          value == o.value &&
+          source_value == o.source_value
+    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
+      [value, source_value].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)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = StackOneHRIS.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/stackone_hris_client/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.5.0
 =end
 
 module StackOneHRIS
-  VERSION = '1.3.1'
+  VERSION = '1.4.0'
 end

data/lib/stackone_hris_client.rb

@@ -30,10 +30,18 @@ require 'stackone_hris_client/models/employee_result'
 require 'stackone_hris_client/models/employees_paginated'
 require 'stackone_hris_client/models/employment'
 require 'stackone_hris_client/models/employment_result'
+require 'stackone_hris_client/models/employment_status_enum'
+require 'stackone_hris_client/models/employment_type_enum'
 require 'stackone_hris_client/models/employments_paginated'
+require 'stackone_hris_client/models/ethnicity_enum'
+require 'stackone_hris_client/models/gender_enum'
 require 'stackone_hris_client/models/location'
 require 'stackone_hris_client/models/location_result'
+require 'stackone_hris_client/models/location_type_enum'
 require 'stackone_hris_client/models/locations_paginated'
+require 'stackone_hris_client/models/marital_status_enum'
+require 'stackone_hris_client/models/pay_frequency_enum'
+require 'stackone_hris_client/models/pay_period_enum'
 
 # APIs
 require 'stackone_hris_client/api/accounts_api'

data/spec/configuration_spec.rb

@@ -18,7 +18,7 @@ describe StackOneHRIS::Configuration do
   before(:each) do
     # uncomment below to setup host and base_path
     # require 'URI'
-    # uri = URI.parse("http://localhost")
+    # uri = URI.parse("https://api.stackone.com")
     # StackOneHRIS.configure do |c|
     #   c.host = uri.host
     #   c.base_path = uri.path
@@ -28,14 +28,14 @@ describe StackOneHRIS::Configuration do
   describe '#base_url' do
     it 'should have the default value' do
       # uncomment below to test default value of the base path
-      # expect(config.base_url).to eq("http://localhost")
+      # expect(config.base_url).to eq("https://api.stackone.com")
     end
 
     it 'should remove trailing slashes' do
       [nil, '', '/', '//'].each do |base_path|
         config.base_path = base_path
         # uncomment below to test trailing slashes
-        # expect(config.base_url).to eq("http://localhost")
+        # expect(config.base_url).to eq("https://api.stackone.com")
       end
     end
   end

data/spec/models/employment_status_enum_spec.rb

@@ -0,0 +1,44 @@
+=begin
+#StackOne Unified API - HRIS
+
+#The documentation for the StackOne Unified API - HRIS
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.5.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for StackOneHRIS::EmploymentStatusEnum
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe StackOneHRIS::EmploymentStatusEnum do
+  let(:instance) { StackOneHRIS::EmploymentStatusEnum.new }
+
+  describe 'test an instance of EmploymentStatusEnum' do
+    it 'should create an instance of EmploymentStatusEnum' do
+      expect(instance).to be_instance_of(StackOneHRIS::EmploymentStatusEnum)
+    end
+  end
+  describe 'test attribute "value"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["active", "pending", "terminated", "unmapped_value"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.value = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "source_value"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/employment_type_enum_spec.rb

@@ -0,0 +1,44 @@
+=begin
+#StackOne Unified API - HRIS
+
+#The documentation for the StackOne Unified API - HRIS
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.5.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for StackOneHRIS::EmploymentTypeEnum
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe StackOneHRIS::EmploymentTypeEnum do
+  let(:instance) { StackOneHRIS::EmploymentTypeEnum.new }
+
+  describe 'test an instance of EmploymentTypeEnum' do
+    it 'should create an instance of EmploymentTypeEnum' do
+      expect(instance).to be_instance_of(StackOneHRIS::EmploymentTypeEnum)
+    end
+  end
+  describe 'test attribute "value"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["full_time", "part_time", "contractor", "intern", "freelance", "terminated", "unmapped_value", "temporary", "seasonal", "volunteer"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.value = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "source_value"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/ethnicity_enum_spec.rb

@@ -0,0 +1,44 @@
+=begin
+#StackOne Unified API - HRIS
+
+#The documentation for the StackOne Unified API - HRIS
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.5.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for StackOneHRIS::EthnicityEnum
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe StackOneHRIS::EthnicityEnum do
+  let(:instance) { StackOneHRIS::EthnicityEnum.new }
+
+  describe 'test an instance of EthnicityEnum' do
+    it 'should create an instance of EthnicityEnum' do
+      expect(instance).to be_instance_of(StackOneHRIS::EthnicityEnum)
+    end
+  end
+  describe 'test attribute "value"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["white", "black_or_african_american", "asian", "hispanic_or_latino", "american_indian_or_alaska_native", "native_hawaiian_or_pacific_islander", "two_or_more_races", "not_disclosed", "unmapped_value"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.value = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "source_value"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/gender_enum_spec.rb

@@ -0,0 +1,44 @@
+=begin
+#StackOne Unified API - HRIS
+
+#The documentation for the StackOne Unified API - HRIS
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.5.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for StackOneHRIS::GenderEnum
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe StackOneHRIS::GenderEnum do
+  let(:instance) { StackOneHRIS::GenderEnum.new }
+
+  describe 'test an instance of GenderEnum' do
+    it 'should create an instance of GenderEnum' do
+      expect(instance).to be_instance_of(StackOneHRIS::GenderEnum)
+    end
+  end
+  describe 'test attribute "value"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["male", "female", "non_binary", "other", "not_disclosed", "unmapped_value"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.value = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "source_value"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/location_type_enum_spec.rb

@@ -0,0 +1,44 @@
+=begin
+#StackOne Unified API - HRIS
+
+#The documentation for the StackOne Unified API - HRIS
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.5.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for StackOneHRIS::LocationTypeEnum
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe StackOneHRIS::LocationTypeEnum do
+  let(:instance) { StackOneHRIS::LocationTypeEnum.new }
+
+  describe 'test an instance of LocationTypeEnum' do
+    it 'should create an instance of LocationTypeEnum' do
+      expect(instance).to be_instance_of(StackOneHRIS::LocationTypeEnum)
+    end
+  end
+  describe 'test attribute "value"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["home", "work", "unmapped_value"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.value = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "source_value"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/marital_status_enum_spec.rb

@@ -0,0 +1,44 @@
+=begin
+#StackOne Unified API - HRIS
+
+#The documentation for the StackOne Unified API - HRIS
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.5.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for StackOneHRIS::MaritalStatusEnum
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe StackOneHRIS::MaritalStatusEnum do
+  let(:instance) { StackOneHRIS::MaritalStatusEnum.new }
+
+  describe 'test an instance of MaritalStatusEnum' do
+    it 'should create an instance of MaritalStatusEnum' do
+      expect(instance).to be_instance_of(StackOneHRIS::MaritalStatusEnum)
+    end
+  end
+  describe 'test attribute "value"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["single", "married", "divorced", "widowed", "domestic_partnership", "separated", "other", "unmapped_value"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.value = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "source_value"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/pay_frequency_enum_spec.rb

@@ -0,0 +1,44 @@
+=begin
+#StackOne Unified API - HRIS
+
+#The documentation for the StackOne Unified API - HRIS
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.5.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for StackOneHRIS::PayFrequencyEnum
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe StackOneHRIS::PayFrequencyEnum do
+  let(:instance) { StackOneHRIS::PayFrequencyEnum.new }
+
+  describe 'test an instance of PayFrequencyEnum' do
+    it 'should create an instance of PayFrequencyEnum' do
+      expect(instance).to be_instance_of(StackOneHRIS::PayFrequencyEnum)
+    end
+  end
+  describe 'test attribute "value"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["hourly", "weekly", "bi_weekly", "four_weekly", "semi_monthly", "monthly", "quarterly", "semi_annually", "yearly", "thirteen_monthly", "pro_rata", "unmapped_value"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.value = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "source_value"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/pay_period_enum_spec.rb

@@ -0,0 +1,44 @@
+=begin
+#StackOne Unified API - HRIS
+
+#The documentation for the StackOne Unified API - HRIS
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.5.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for StackOneHRIS::PayPeriodEnum
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe StackOneHRIS::PayPeriodEnum do
+  let(:instance) { StackOneHRIS::PayPeriodEnum.new }
+
+  describe 'test an instance of PayPeriodEnum' do
+    it 'should create an instance of PayPeriodEnum' do
+      expect(instance).to be_instance_of(StackOneHRIS::PayPeriodEnum)
+    end
+  end
+  describe 'test attribute "value"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["hour", "day", "week", "every_two_weeks", "month", "quarter", "every_six_months", "year", "unmapped_value"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.value = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "source_value"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end