merge_hris_client 2.0.4 → 3.2.2

data/lib/merge_hris_client/models/dependent.rb

@@ -0,0 +1,478 @@
+=begin
+#Merge HRIS API
+
+#The unified API for building rich integrations with multiple HR Information System platforms.
+
+The version of the OpenAPI document: 1.0
+Contact: hello@merge.dev
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'date'
+require 'time'
+
+module MergeHRISClient
+  # # The Dependent Object ### Description The `Dependent` object is used to represent a dependent (e.g. child, spouse, domestic partner, etc) of an `Employee`  ### Usage Example Fetch from the `LIST Dependents` endpoint and filter by `ID` to show all dependents.
+  class Dependent
+    attr_accessor :id
+
+    # The third-party API ID of the matching object.
+    attr_accessor :remote_id
+
+    # The datetime that this object was created by Merge.
+    attr_accessor :created_at
+
+    # The datetime that this object was modified by Merge.
+    attr_accessor :modified_at
+
+    # The dependents's first name.
+    attr_accessor :first_name
+
+    # The dependents's middle name.
+    attr_accessor :middle_name
+
+    # The dependents's last name.
+    attr_accessor :last_name
+
+    # The dependent's relationship to the employee.  * `CHILD` - CHILD * `SPOUSE` - SPOUSE * `DOMESTIC_PARTNER` - DOMESTIC_PARTNER
+    attr_accessor :relationship
+
+    # The employee this person is a dependent of.
+    attr_accessor :employee
+
+    # The dependent's date of birth.
+    attr_accessor :date_of_birth
+
+    # The dependent's gender.  * `MALE` - MALE * `FEMALE` - FEMALE * `NON-BINARY` - NON-BINARY * `OTHER` - OTHER * `PREFER_NOT_TO_DISCLOSE` - PREFER_NOT_TO_DISCLOSE
+    attr_accessor :gender
+
+    # The dependent's phone number.
+    attr_accessor :phone_number
+
+    # The dependents's home address.
+    attr_accessor :home_location
+
+    # Whether or not the dependent is a student
+    attr_accessor :is_student
+
+    # The dependents's social security number.
+    attr_accessor :ssn
+
+    # Indicates whether or not this object has been deleted in the third party platform.
+    attr_accessor :remote_was_deleted
+
+    attr_accessor :field_mappings
+
+    attr_accessor :remote_data
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'remote_id' => :'remote_id',
+        :'created_at' => :'created_at',
+        :'modified_at' => :'modified_at',
+        :'first_name' => :'first_name',
+        :'middle_name' => :'middle_name',
+        :'last_name' => :'last_name',
+        :'relationship' => :'relationship',
+        :'employee' => :'employee',
+        :'date_of_birth' => :'date_of_birth',
+        :'gender' => :'gender',
+        :'phone_number' => :'phone_number',
+        :'home_location' => :'home_location',
+        :'is_student' => :'is_student',
+        :'ssn' => :'ssn',
+        :'remote_was_deleted' => :'remote_was_deleted',
+        :'field_mappings' => :'field_mappings',
+        :'remote_data' => :'remote_data'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'remote_id' => :'String',
+        :'created_at' => :'Time',
+        :'modified_at' => :'Time',
+        :'first_name' => :'String',
+        :'middle_name' => :'String',
+        :'last_name' => :'String',
+        :'relationship' => :'RelationshipEnum',
+        :'employee' => :'String',
+        :'date_of_birth' => :'Time',
+        :'gender' => :'GenderEnum',
+        :'phone_number' => :'String',
+        :'home_location' => :'String',
+        :'is_student' => :'Boolean',
+        :'ssn' => :'String',
+        :'remote_was_deleted' => :'Boolean',
+        :'field_mappings' => :'Object',
+        :'remote_data' => :'Array<RemoteData>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'remote_id',
+        :'first_name',
+        :'middle_name',
+        :'last_name',
+        :'relationship',
+        :'employee',
+        :'date_of_birth',
+        :'gender',
+        :'phone_number',
+        :'home_location',
+        :'is_student',
+        :'ssn',
+        :'field_mappings',
+        :'remote_data'
+      ])
+    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 `MergeHRISClient::Dependent` 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 `MergeHRISClient::Dependent`. 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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'remote_id')
+        self.remote_id = attributes[:'remote_id']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'modified_at')
+        self.modified_at = attributes[:'modified_at']
+      end
+
+      if attributes.key?(:'first_name')
+        self.first_name = attributes[:'first_name']
+      end
+
+      if attributes.key?(:'middle_name')
+        self.middle_name = attributes[:'middle_name']
+      end
+
+      if attributes.key?(:'last_name')
+        self.last_name = attributes[:'last_name']
+      end
+
+      if attributes.key?(:'relationship')
+        self.relationship = attributes[:'relationship']
+      end
+
+      if attributes.key?(:'employee')
+        self.employee = attributes[:'employee']
+      end
+
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
+      end
+
+      if attributes.key?(:'gender')
+        self.gender = attributes[:'gender']
+      end
+
+      if attributes.key?(:'phone_number')
+        self.phone_number = attributes[:'phone_number']
+      end
+
+      if attributes.key?(:'home_location')
+        self.home_location = attributes[:'home_location']
+      end
+
+      if attributes.key?(:'is_student')
+        self.is_student = attributes[:'is_student']
+      end
+
+      if attributes.key?(:'ssn')
+        self.ssn = attributes[:'ssn']
+      end
+
+      if attributes.key?(:'remote_was_deleted')
+        self.remote_was_deleted = attributes[:'remote_was_deleted']
+      end
+
+      if attributes.key?(:'field_mappings')
+        self.field_mappings = attributes[:'field_mappings']
+      end
+
+      if attributes.key?(:'remote_data')
+        if (value = attributes[:'remote_data']).is_a?(Array)
+          self.remote_data = 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
+      invalid_properties = Array.new
+      if !@first_name.nil? && @first_name.to_s.length > 60
+        invalid_properties.push('invalid value for "first_name", the character length must be smaller than or equal to 60.')
+      end
+
+      if !@middle_name.nil? && @middle_name.to_s.length > 60
+        invalid_properties.push('invalid value for "middle_name", the character length must be smaller than or equal to 60.')
+      end
+
+      if !@last_name.nil? && @last_name.to_s.length > 60
+        invalid_properties.push('invalid value for "last_name", the character length must be smaller than or equal to 60.')
+      end
+
+      if !@phone_number.nil? && @phone_number.to_s.length > 50
+        invalid_properties.push('invalid value for "phone_number", the character length must be smaller than or equal to 50.')
+      end
+
+      if !@ssn.nil? && @ssn.to_s.length > 50
+        invalid_properties.push('invalid value for "ssn", the character length must be smaller than or equal to 50.')
+      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 !@first_name.nil? && @first_name.to_s.length > 60
+      return false if !@middle_name.nil? && @middle_name.to_s.length > 60
+      return false if !@last_name.nil? && @last_name.to_s.length > 60
+      return false if !@phone_number.nil? && @phone_number.to_s.length > 50
+      return false if !@ssn.nil? && @ssn.to_s.length > 50
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] first_name Value to be assigned
+    def first_name=(first_name)
+      if !first_name.nil? && first_name.to_s.length > 60
+        fail ArgumentError, 'invalid value for "first_name", the character length must be smaller than or equal to 60.'
+      end
+
+      @first_name = first_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] middle_name Value to be assigned
+    def middle_name=(middle_name)
+      if !middle_name.nil? && middle_name.to_s.length > 60
+        fail ArgumentError, 'invalid value for "middle_name", the character length must be smaller than or equal to 60.'
+      end
+
+      @middle_name = middle_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] last_name Value to be assigned
+    def last_name=(last_name)
+      if !last_name.nil? && last_name.to_s.length > 60
+        fail ArgumentError, 'invalid value for "last_name", the character length must be smaller than or equal to 60.'
+      end
+
+      @last_name = last_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] phone_number Value to be assigned
+    def phone_number=(phone_number)
+      if !phone_number.nil? && phone_number.to_s.length > 50
+        fail ArgumentError, 'invalid value for "phone_number", the character length must be smaller than or equal to 50.'
+      end
+
+      @phone_number = phone_number
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ssn Value to be assigned
+    def ssn=(ssn)
+      if !ssn.nil? && ssn.to_s.length > 50
+        fail ArgumentError, 'invalid value for "ssn", the character length must be smaller than or equal to 50.'
+      end
+
+      @ssn = ssn
+    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 &&
+          remote_id == o.remote_id &&
+          created_at == o.created_at &&
+          modified_at == o.modified_at &&
+          first_name == o.first_name &&
+          middle_name == o.middle_name &&
+          last_name == o.last_name &&
+          relationship == o.relationship &&
+          employee == o.employee &&
+          date_of_birth == o.date_of_birth &&
+          gender == o.gender &&
+          phone_number == o.phone_number &&
+          home_location == o.home_location &&
+          is_student == o.is_student &&
+          ssn == o.ssn &&
+          remote_was_deleted == o.remote_was_deleted &&
+          field_mappings == o.field_mappings &&
+          remote_data == o.remote_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
+      [id, remote_id, created_at, modified_at, first_name, middle_name, last_name, relationship, employee, date_of_birth, gender, phone_number, home_location, is_student, ssn, remote_was_deleted, field_mappings, remote_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)
+      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)
+      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
+      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 = MergeHRISClient.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/merge_hris_client/models/earning.rb

@@ -14,32 +14,47 @@ require 'date'
 require 'time'
 
 module MergeHRISClient
-  # # The Earning Object ### Description The `Earning` object is used to represent an earning for a given employee's payroll run. One run could include several earnings.  ### Usage Example Fetch from the `LIST Earnings` endpoint and filter by `ID` to show all earnings.
+  # # The Earning Object ### Description The `Earning` object is used to represent an array of different compensations that an employee receives within specific wage categories.  ### Usage Example Fetch from the `LIST Earnings` endpoint and filter by `ID` to show all earnings.
   class Earning
     attr_accessor :id
 
+    # The third-party API ID of the matching object.
+    attr_accessor :remote_id
+
+    # The datetime that this object was created by Merge.
+    attr_accessor :created_at
+
+    # The datetime that this object was modified by Merge.
+    attr_accessor :modified_at
+
     attr_accessor :employee_payroll_run
 
     # The amount earned.
     attr_accessor :amount
 
-    # The type of earning.
+    # The type of earning.  * `SALARY` - SALARY * `REIMBURSEMENT` - REIMBURSEMENT * `OVERTIME` - OVERTIME * `BONUS` - BONUS
     attr_accessor :type
 
-    attr_accessor :remote_data
-
-    # Indicates whether or not this object has been deleted by third party webhooks.
+    # Indicates whether or not this object has been deleted in the third party platform.
     attr_accessor :remote_was_deleted
 
+    attr_accessor :field_mappings
+
+    attr_accessor :remote_data
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'id' => :'id',
+        :'remote_id' => :'remote_id',
+        :'created_at' => :'created_at',
+        :'modified_at' => :'modified_at',
         :'employee_payroll_run' => :'employee_payroll_run',
         :'amount' => :'amount',
         :'type' => :'type',
-        :'remote_data' => :'remote_data',
-        :'remote_was_deleted' => :'remote_was_deleted'
+        :'remote_was_deleted' => :'remote_was_deleted',
+        :'field_mappings' => :'field_mappings',
+        :'remote_data' => :'remote_data'
       }
     end
 
@@ -52,21 +67,27 @@ module MergeHRISClient
     def self.openapi_types
       {
         :'id' => :'String',
+        :'remote_id' => :'String',
+        :'created_at' => :'Time',
+        :'modified_at' => :'Time',
         :'employee_payroll_run' => :'String',
         :'amount' => :'Float',
         :'type' => :'EarningTypeEnum',
-        :'remote_data' => :'Array<Hash<String, AnyType>>',
-        :'remote_was_deleted' => :'Boolean'
+        :'remote_was_deleted' => :'Boolean',
+        :'field_mappings' => :'Object',
+        :'remote_data' => :'Array<RemoteData>'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'remote_id',
         :'employee_payroll_run',
         :'amount',
         :'type',
-        :'remote_data',
+        :'field_mappings',
+        :'remote_data'
       ])
     end
 
@@ -89,6 +110,18 @@ module MergeHRISClient
         self.id = attributes[:'id']
       end
 
+      if attributes.key?(:'remote_id')
+        self.remote_id = attributes[:'remote_id']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'modified_at')
+        self.modified_at = attributes[:'modified_at']
+      end
+
       if attributes.key?(:'employee_payroll_run')
         self.employee_payroll_run = attributes[:'employee_payroll_run']
       end
@@ -101,15 +134,19 @@ module MergeHRISClient
         self.type = attributes[:'type']
       end
 
+      if attributes.key?(:'remote_was_deleted')
+        self.remote_was_deleted = attributes[:'remote_was_deleted']
+      end
+
+      if attributes.key?(:'field_mappings')
+        self.field_mappings = attributes[:'field_mappings']
+      end
+
       if attributes.key?(:'remote_data')
         if (value = attributes[:'remote_data']).is_a?(Array)
           self.remote_data = value
         end
       end
-
-      if attributes.key?(:'remote_was_deleted')
-        self.remote_was_deleted = attributes[:'remote_was_deleted']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -131,11 +168,15 @@ module MergeHRISClient
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
+          remote_id == o.remote_id &&
+          created_at == o.created_at &&
+          modified_at == o.modified_at &&
           employee_payroll_run == o.employee_payroll_run &&
           amount == o.amount &&
           type == o.type &&
-          remote_data == o.remote_data &&
-          remote_was_deleted == o.remote_was_deleted
+          remote_was_deleted == o.remote_was_deleted &&
+          field_mappings == o.field_mappings &&
+          remote_data == o.remote_data
     end
 
     # @see the `==` method
@@ -147,7 +188,7 @@ module MergeHRISClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, employee_payroll_run, amount, type, remote_data, remote_was_deleted].hash
+      [id, remote_id, created_at, modified_at, employee_payroll_run, amount, type, remote_was_deleted, field_mappings, remote_data].hash
     end
 
     # Builds the object from hash

data/lib/merge_hris_client/models/earning_type_enum.rb

@@ -20,18 +20,28 @@ module MergeHRISClient
     OVERTIME = "OVERTIME".freeze
     BONUS = "BONUS".freeze
 
-    # Builds the enum from string
-    # @param [String] The enum value in the form of the string
-    # @return [String] The enum value
-    def self.build_from_hash(value)
-      new.build_from_hash(value)
-    end
+    MERGE_NONSTANDARD_VALUE = "MERGE_NONSTANDARD_VALUE".freeze
+
+    attr_accessor :value
+    attr_accessor :raw_value
 
     # Builds the enum from string
     # @param [String] The enum value in the form of the string
     # @return [String] The enum value
     def build_from_hash(value)
-      value
+      @raw_value = value
+      if ["SALARY", "REIMBURSEMENT", "OVERTIME", "BONUS", ].include? value
+        @value = value
+      else
+        @value = MERGE_NONSTANDARD_VALUE
+      end
+
+      self
+    end
+
+    def self.build_from_hash(value)
+      EarningTypeEnum.new.build_from_hash(value)
     end
   end
+
 end