merge_hris_client 2.0.4 → 3.2.2

data/lib/merge_hris_client/models/employee_request.rb

@@ -14,14 +14,12 @@ require 'date'
 require 'time'
 
 module MergeHRISClient
-  # # The Employee Object ### Description The `Employee` object is used to represent an Employee for a company.  ### Usage Example Fetch from the `LIST Employee` endpoint and filter by `ID` to show all employees.
+  # # The Employee Object ### Description The `Employee` object is used to represent any person who has been employed by a company.  ### Usage Example Fetch from the `LIST Employee` endpoint and filter by `ID` to show all employees.
   class EmployeeRequest
-    # The third-party API ID of the matching object.
-    attr_accessor :remote_id
-
-    # The employee's number that appears in the remote UI. Note: This is distinct from the remote_id field, which is a unique identifier for the employee set by the remote API, and is not exposed to the user. This value can also change in many API providers.
+    # The employee's number that appears in the third-party integration's UI.
     attr_accessor :employee_number
 
+    # The ID of the employee's company.
     attr_accessor :company
 
     # The employee's first name.
@@ -30,9 +28,15 @@ module MergeHRISClient
     # The employee's last name.
     attr_accessor :last_name
 
+    # The employee's preferred first name.
+    attr_accessor :preferred_name
+
     # The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.
     attr_accessor :display_full_name
 
+    # The employee's username that appears in the remote UI.
+    attr_accessor :username
+
     attr_accessor :groups
 
     # The employee's work email.
@@ -47,26 +51,31 @@ module MergeHRISClient
     # Array of `Employment` IDs for this Employee.
     attr_accessor :employments
 
+    # The employee's home address.
     attr_accessor :home_location
 
+    # The employee's work address.
     attr_accessor :work_location
 
+    # The employee ID of the employee's manager.
     attr_accessor :manager
 
+    # The employee's team.
     attr_accessor :team
 
+    # The employee's pay group
     attr_accessor :pay_group
 
     # The employee's social security number.
     attr_accessor :ssn
 
-    # The employee's gender.
+    # The employee's gender.  * `MALE` - MALE * `FEMALE` - FEMALE * `NON-BINARY` - NON-BINARY * `OTHER` - OTHER * `PREFER_NOT_TO_DISCLOSE` - PREFER_NOT_TO_DISCLOSE
     attr_accessor :gender
 
-    # The employee's ethnicity.
+    # The employee's ethnicity.  * `AMERICAN_INDIAN_OR_ALASKA_NATIVE` - AMERICAN_INDIAN_OR_ALASKA_NATIVE * `ASIAN_OR_INDIAN_SUBCONTINENT` - ASIAN_OR_INDIAN_SUBCONTINENT * `BLACK_OR_AFRICAN_AMERICAN` - BLACK_OR_AFRICAN_AMERICAN * `HISPANIC_OR_LATINO` - HISPANIC_OR_LATINO * `NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER` - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER * `TWO_OR_MORE_RACES` - TWO_OR_MORE_RACES * `WHITE` - WHITE * `PREFER_NOT_TO_DISCLOSE` - PREFER_NOT_TO_DISCLOSE
     attr_accessor :ethnicity
 
-    # The employee's marital status.
+    # The employee's filing status as related to marital status.  * `SINGLE` - SINGLE * `MARRIED_FILING_JOINTLY` - MARRIED_FILING_JOINTLY * `MARRIED_FILING_SEPARATELY` - MARRIED_FILING_SEPARATELY * `HEAD_OF_HOUSEHOLD` - HEAD_OF_HOUSEHOLD * `QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD` - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD
     attr_accessor :marital_status
 
     # The employee's date of birth.
@@ -75,10 +84,10 @@ module MergeHRISClient
     # The date that the employee was hired, usually the day that an offer letter is signed. If an employee has multiple hire dates from previous employments, this represents the most recent hire date. Note: If you're looking for the employee's start date, refer to the start_date field.
     attr_accessor :hire_date
 
-    # The date that the employee started working. If an employee has multiple start dates from previous employments, this represents the most recent start date.
+    # The date that the employee started working. If an employee was rehired, the most recent start date will be returned.
     attr_accessor :start_date
 
-    # The employment status of the employee.
+    # The employment status of the employee.  * `ACTIVE` - ACTIVE * `PENDING` - PENDING * `INACTIVE` - INACTIVE
     attr_accessor :employment_status
 
     # The employee's termination date.
@@ -87,18 +96,20 @@ module MergeHRISClient
     # The URL of the employee's avatar image.
     attr_accessor :avatar
 
-    # Custom fields configured for a given model.
-    attr_accessor :custom_fields
+    attr_accessor :integration_params
+
+    attr_accessor :linked_account_params
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'remote_id' => :'remote_id',
         :'employee_number' => :'employee_number',
         :'company' => :'company',
         :'first_name' => :'first_name',
         :'last_name' => :'last_name',
+        :'preferred_name' => :'preferred_name',
         :'display_full_name' => :'display_full_name',
+        :'username' => :'username',
         :'groups' => :'groups',
         :'work_email' => :'work_email',
         :'personal_email' => :'personal_email',
@@ -119,7 +130,8 @@ module MergeHRISClient
         :'employment_status' => :'employment_status',
         :'termination_date' => :'termination_date',
         :'avatar' => :'avatar',
-        :'custom_fields' => :'custom_fields'
+        :'integration_params' => :'integration_params',
+        :'linked_account_params' => :'linked_account_params'
       }
     end
 
@@ -131,12 +143,13 @@ module MergeHRISClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'remote_id' => :'String',
         :'employee_number' => :'String',
         :'company' => :'String',
         :'first_name' => :'String',
         :'last_name' => :'String',
+        :'preferred_name' => :'String',
         :'display_full_name' => :'String',
+        :'username' => :'String',
         :'groups' => :'Array<String>',
         :'work_email' => :'String',
         :'personal_email' => :'String',
@@ -157,19 +170,21 @@ module MergeHRISClient
         :'employment_status' => :'EmploymentStatusEnum',
         :'termination_date' => :'Time',
         :'avatar' => :'String',
-        :'custom_fields' => :'Hash<String, AnyType>'
+        :'integration_params' => :'Hash<String, Object>',
+        :'linked_account_params' => :'Hash<String, Object>'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'remote_id',
         :'employee_number',
         :'company',
         :'first_name',
         :'last_name',
+        :'preferred_name',
         :'display_full_name',
+        :'username',
         :'work_email',
         :'personal_email',
         :'mobile_phone_number',
@@ -188,7 +203,8 @@ module MergeHRISClient
         :'employment_status',
         :'termination_date',
         :'avatar',
-        :'custom_fields'
+        :'integration_params',
+        :'linked_account_params'
       ])
     end
 
@@ -207,10 +223,6 @@ module MergeHRISClient
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'remote_id')
-        self.remote_id = attributes[:'remote_id']
-      end
-
       if attributes.key?(:'employee_number')
         self.employee_number = attributes[:'employee_number']
       end
@@ -227,10 +239,18 @@ module MergeHRISClient
         self.last_name = attributes[:'last_name']
       end
 
+      if attributes.key?(:'preferred_name')
+        self.preferred_name = attributes[:'preferred_name']
+      end
+
       if attributes.key?(:'display_full_name')
         self.display_full_name = attributes[:'display_full_name']
       end
 
+      if attributes.key?(:'username')
+        self.username = attributes[:'username']
+      end
+
       if attributes.key?(:'groups')
         if (value = attributes[:'groups']).is_a?(Array)
           self.groups = value
@@ -315,9 +335,15 @@ module MergeHRISClient
         self.avatar = attributes[:'avatar']
       end
 
-      if attributes.key?(:'custom_fields')
-        if (value = attributes[:'custom_fields']).is_a?(Hash)
-          self.custom_fields = value
+      if attributes.key?(:'integration_params')
+        if (value = attributes[:'integration_params']).is_a?(Hash)
+          self.integration_params = value
+        end
+      end
+
+      if attributes.key?(:'linked_account_params')
+        if (value = attributes[:'linked_account_params']).is_a?(Hash)
+          self.linked_account_params = value
         end
       end
     end
@@ -400,12 +426,13 @@ module MergeHRISClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          remote_id == o.remote_id &&
           employee_number == o.employee_number &&
           company == o.company &&
           first_name == o.first_name &&
           last_name == o.last_name &&
+          preferred_name == o.preferred_name &&
           display_full_name == o.display_full_name &&
+          username == o.username &&
           groups == o.groups &&
           work_email == o.work_email &&
           personal_email == o.personal_email &&
@@ -426,7 +453,8 @@ module MergeHRISClient
           employment_status == o.employment_status &&
           termination_date == o.termination_date &&
           avatar == o.avatar &&
-          custom_fields == o.custom_fields
+          integration_params == o.integration_params &&
+          linked_account_params == o.linked_account_params
     end
 
     # @see the `==` method
@@ -438,7 +466,7 @@ module MergeHRISClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [remote_id, employee_number, company, first_name, last_name, display_full_name, groups, work_email, personal_email, mobile_phone_number, employments, home_location, work_location, manager, team, pay_group, ssn, gender, ethnicity, marital_status, date_of_birth, hire_date, start_date, employment_status, termination_date, avatar, custom_fields].hash
+      [employee_number, company, first_name, last_name, preferred_name, display_full_name, username, groups, work_email, personal_email, mobile_phone_number, employments, home_location, work_location, manager, team, pay_group, ssn, gender, ethnicity, marital_status, date_of_birth, hire_date, start_date, employment_status, termination_date, avatar, integration_params, linked_account_params].hash
     end
 
     # Builds the object from hash

data/lib/merge_hris_client/models/employer_benefit.rb

@@ -0,0 +1,371 @@
+=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 EmployerBenefit Object ### Description The `Employer Benefit` object is used to represent a benefit plan offered by a company.  ### Usage Example Fetch from the `LIST EmployerBenefits` endpoint and filter by `ID` to show all EmployerBenefits.
+  class EmployerBenefit
+    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 type of benefit plan.  * `MEDICAL` - MEDICAL * `HEALTH_SAVINGS` - HEALTH_SAVINGS * `INSURANCE` - INSURANCE * `RETIREMENT` - RETIREMENT * `OTHER` - OTHER
+    attr_accessor :benefit_plan_type
+
+    # The employer benefit's name - typically the carrier or network name.
+    attr_accessor :name
+
+    # The employer benefit's description.
+    attr_accessor :description
+
+    # The employer benefit's deduction code.
+    attr_accessor :deduction_code
+
+    # 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',
+        :'benefit_plan_type' => :'benefit_plan_type',
+        :'name' => :'name',
+        :'description' => :'description',
+        :'deduction_code' => :'deduction_code',
+        :'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',
+        :'benefit_plan_type' => :'BenefitPlanTypeEnum',
+        :'name' => :'String',
+        :'description' => :'String',
+        :'deduction_code' => :'String',
+        :'remote_was_deleted' => :'Boolean',
+        :'field_mappings' => :'Object',
+        :'remote_data' => :'Array<Hash<String, Object>>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'remote_id',
+        :'benefit_plan_type',
+        :'name',
+        :'description',
+        :'deduction_code',
+        :'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::EmployerBenefit` 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::EmployerBenefit`. 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?(:'benefit_plan_type')
+        self.benefit_plan_type = attributes[:'benefit_plan_type']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'deduction_code')
+        self.deduction_code = attributes[:'deduction_code']
+      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 !@name.nil? && @name.to_s.length > 200
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 200.')
+      end
+
+      if !@description.nil? && @description.to_s.length > 2000
+        invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 2000.')
+      end
+
+      if !@deduction_code.nil? && @deduction_code.to_s.length > 60
+        invalid_properties.push('invalid value for "deduction_code", the character length must be smaller than or equal to 60.')
+      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 !@name.nil? && @name.to_s.length > 200
+      return false if !@description.nil? && @description.to_s.length > 2000
+      return false if !@deduction_code.nil? && @deduction_code.to_s.length > 60
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if !name.nil? && name.to_s.length > 200
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 200.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] description Value to be assigned
+    def description=(description)
+      if !description.nil? && description.to_s.length > 2000
+        fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 2000.'
+      end
+
+      @description = description
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] deduction_code Value to be assigned
+    def deduction_code=(deduction_code)
+      if !deduction_code.nil? && deduction_code.to_s.length > 60
+        fail ArgumentError, 'invalid value for "deduction_code", the character length must be smaller than or equal to 60.'
+      end
+
+      @deduction_code = deduction_code
+    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 &&
+          benefit_plan_type == o.benefit_plan_type &&
+          name == o.name &&
+          description == o.description &&
+          deduction_code == o.deduction_code &&
+          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, benefit_plan_type, name, description, deduction_code, 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