merge_hris_client 3.0.0 → 3.2.0

data/lib/merge_hris_client/models/deduction.rb

@@ -14,36 +14,47 @@ require 'date'
 require 'time'
 
 module MergeHRISClient
-  # # The Deduction Object ### Description The `Deduction` object is used to represent a deduction for a given employee's payroll run. One run could include several deductions.  ### Usage Example Fetch from the `LIST Deductions` endpoint and filter by `ID` to show all deductions.
+  # # The Deduction Object ### Description The `Deduction` object is used to represent an array of the wages withheld from total earnings for the purpose of paying taxes.  ### Usage Example Fetch from the `LIST Deductions` endpoint and filter by `ID` to show all deductions.
   class Deduction
     attr_accessor :id
 
+    # The third-party API ID of the matching object.
+    attr_accessor :remote_id
+
     attr_accessor :employee_payroll_run
 
     # The deduction's name.
     attr_accessor :name
 
-    # The amount the employee is deducting.
+    # The amount of money that is withheld from an employee's gross pay by the employee.
     attr_accessor :employee_deduction
 
-    # The amount the company is deducting.
+    # The amount of money that is withheld on behalf of an employee by the company.
     attr_accessor :company_deduction
 
-    attr_accessor :remote_data
-
     # Indicates whether or not this object has been deleted by third party webhooks.
     attr_accessor :remote_was_deleted
 
+    attr_accessor :field_mappings
+
+    # This is the datetime that this object was last updated by Merge
+    attr_accessor :modified_at
+
+    attr_accessor :remote_data
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'id' => :'id',
+        :'remote_id' => :'remote_id',
         :'employee_payroll_run' => :'employee_payroll_run',
         :'name' => :'name',
         :'employee_deduction' => :'employee_deduction',
         :'company_deduction' => :'company_deduction',
-        :'remote_data' => :'remote_data',
-        :'remote_was_deleted' => :'remote_was_deleted'
+        :'remote_was_deleted' => :'remote_was_deleted',
+        :'field_mappings' => :'field_mappings',
+        :'modified_at' => :'modified_at',
+        :'remote_data' => :'remote_data'
       }
     end
 
@@ -56,23 +67,28 @@ module MergeHRISClient
     def self.openapi_types
       {
         :'id' => :'String',
+        :'remote_id' => :'String',
         :'employee_payroll_run' => :'String',
         :'name' => :'String',
         :'employee_deduction' => :'Float',
         :'company_deduction' => :'Float',
-        :'remote_data' => :'Array<RemoteData>',
-        :'remote_was_deleted' => :'Boolean'
+        :'remote_was_deleted' => :'Boolean',
+        :'field_mappings' => :'Hash<String, Object>',
+        :'modified_at' => :'Time',
+        :'remote_data' => :'Array<RemoteData>'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'remote_id',
         :'employee_payroll_run',
         :'name',
         :'employee_deduction',
         :'company_deduction',
-        :'remote_data',
+        :'field_mappings',
+        :'remote_data'
       ])
     end
 
@@ -95,6 +111,10 @@ module MergeHRISClient
         self.id = attributes[:'id']
       end
 
+      if attributes.key?(:'remote_id')
+        self.remote_id = attributes[:'remote_id']
+      end
+
       if attributes.key?(:'employee_payroll_run')
         self.employee_payroll_run = attributes[:'employee_payroll_run']
       end
@@ -111,15 +131,25 @@ module MergeHRISClient
         self.company_deduction = attributes[:'company_deduction']
       end
 
+      if attributes.key?(:'remote_was_deleted')
+        self.remote_was_deleted = attributes[:'remote_was_deleted']
+      end
+
+      if attributes.key?(:'field_mappings')
+        if (value = attributes[:'field_mappings']).is_a?(Hash)
+          self.field_mappings = value
+        end
+      end
+
+      if attributes.key?(:'modified_at')
+        self.modified_at = attributes[:'modified_at']
+      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?
@@ -141,12 +171,15 @@ module MergeHRISClient
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
+          remote_id == o.remote_id &&
           employee_payroll_run == o.employee_payroll_run &&
           name == o.name &&
           employee_deduction == o.employee_deduction &&
           company_deduction == o.company_deduction &&
-          remote_data == o.remote_data &&
-          remote_was_deleted == o.remote_was_deleted
+          remote_was_deleted == o.remote_was_deleted &&
+          field_mappings == o.field_mappings &&
+          modified_at == o.modified_at &&
+          remote_data == o.remote_data
     end
 
     # @see the `==` method
@@ -158,7 +191,7 @@ module MergeHRISClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, employee_payroll_run, name, employee_deduction, company_deduction, remote_data, remote_was_deleted].hash
+      [id, remote_id, employee_payroll_run, name, employee_deduction, company_deduction, remote_was_deleted, field_mappings, modified_at, remote_data].hash
     end
 
     # Builds the object from hash

data/lib/merge_hris_client/models/earning.rb

@@ -14,29 +14,43 @@ 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
+
     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
 
     # Indicates whether or not this object has been deleted by third party webhooks.
     attr_accessor :remote_was_deleted
 
+    attr_accessor :field_mappings
+
+    # This is the datetime that this object was last updated by Merge
+    attr_accessor :modified_at
+
+    attr_accessor :remote_data
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'id' => :'id',
+        :'remote_id' => :'remote_id',
         :'employee_payroll_run' => :'employee_payroll_run',
         :'amount' => :'amount',
         :'type' => :'type',
-        :'remote_was_deleted' => :'remote_was_deleted'
+        :'remote_was_deleted' => :'remote_was_deleted',
+        :'field_mappings' => :'field_mappings',
+        :'modified_at' => :'modified_at',
+        :'remote_data' => :'remote_data'
       }
     end
 
@@ -49,19 +63,26 @@ module MergeHRISClient
     def self.openapi_types
       {
         :'id' => :'String',
+        :'remote_id' => :'String',
         :'employee_payroll_run' => :'String',
         :'amount' => :'Float',
         :'type' => :'EarningTypeEnum',
-        :'remote_was_deleted' => :'Boolean'
+        :'remote_was_deleted' => :'Boolean',
+        :'field_mappings' => :'Hash<String, Object>',
+        :'modified_at' => :'Time',
+        :'remote_data' => :'Array<RemoteData>'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'remote_id',
         :'employee_payroll_run',
         :'amount',
         :'type',
+        :'field_mappings',
+        :'remote_data'
       ])
     end
 
@@ -84,6 +105,10 @@ module MergeHRISClient
         self.id = attributes[:'id']
       end
 
+      if attributes.key?(:'remote_id')
+        self.remote_id = attributes[:'remote_id']
+      end
+
       if attributes.key?(:'employee_payroll_run')
         self.employee_payroll_run = attributes[:'employee_payroll_run']
       end
@@ -99,6 +124,22 @@ module MergeHRISClient
       if attributes.key?(:'remote_was_deleted')
         self.remote_was_deleted = attributes[:'remote_was_deleted']
       end
+
+      if attributes.key?(:'field_mappings')
+        if (value = attributes[:'field_mappings']).is_a?(Hash)
+          self.field_mappings = value
+        end
+      end
+
+      if attributes.key?(:'modified_at')
+        self.modified_at = attributes[:'modified_at']
+      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?
@@ -120,10 +161,14 @@ module MergeHRISClient
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
+          remote_id == o.remote_id &&
           employee_payroll_run == o.employee_payroll_run &&
           amount == o.amount &&
           type == o.type &&
-          remote_was_deleted == o.remote_was_deleted
+          remote_was_deleted == o.remote_was_deleted &&
+          field_mappings == o.field_mappings &&
+          modified_at == o.modified_at &&
+          remote_data == o.remote_data
     end
 
     # @see the `==` method
@@ -135,7 +180,7 @@ module MergeHRISClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, employee_payroll_run, amount, type, remote_was_deleted].hash
+      [id, remote_id, employee_payroll_run, amount, type, remote_was_deleted, field_mappings, modified_at, remote_data].hash
     end
 
     # Builds the object from hash

data/lib/merge_hris_client/models/employee.rb

@@ -14,16 +14,17 @@ 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 Employee
     attr_accessor :id
 
     # 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.
@@ -52,26 +53,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.
@@ -80,13 +86,13 @@ 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
 
     # When the third party's employee was created.
     attr_accessor :remote_created_at
 
-    # 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.
@@ -95,13 +101,18 @@ module MergeHRISClient
     # The URL of the employee's avatar image.
     attr_accessor :avatar
 
-    attr_accessor :remote_data
-
     # Custom fields configured for a given model.
     attr_accessor :custom_fields
 
     attr_accessor :remote_was_deleted
 
+    attr_accessor :field_mappings
+
+    # This is the datetime that this object was last updated by Merge
+    attr_accessor :modified_at
+
+    attr_accessor :remote_data
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -134,9 +145,11 @@ module MergeHRISClient
         :'employment_status' => :'employment_status',
         :'termination_date' => :'termination_date',
         :'avatar' => :'avatar',
-        :'remote_data' => :'remote_data',
         :'custom_fields' => :'custom_fields',
-        :'remote_was_deleted' => :'remote_was_deleted'
+        :'remote_was_deleted' => :'remote_was_deleted',
+        :'field_mappings' => :'field_mappings',
+        :'modified_at' => :'modified_at',
+        :'remote_data' => :'remote_data'
       }
     end
 
@@ -177,9 +190,11 @@ module MergeHRISClient
         :'employment_status' => :'EmploymentStatusEnum',
         :'termination_date' => :'Time',
         :'avatar' => :'String',
-        :'remote_data' => :'Array<RemoteData>',
         :'custom_fields' => :'Hash<String, Object>',
-        :'remote_was_deleted' => :'Boolean'
+        :'remote_was_deleted' => :'Boolean',
+        :'field_mappings' => :'Hash<String, Object>',
+        :'modified_at' => :'Time',
+        :'remote_data' => :'Array<RemoteData>'
       }
     end
 
@@ -212,8 +227,9 @@ module MergeHRISClient
         :'employment_status',
         :'termination_date',
         :'avatar',
-        :'remote_data',
         :'custom_fields',
+        :'field_mappings',
+        :'remote_data'
       ])
     end
 
@@ -352,12 +368,6 @@ module MergeHRISClient
         self.avatar = attributes[:'avatar']
       end
 
-      if attributes.key?(:'remote_data')
-        if (value = attributes[:'remote_data']).is_a?(Array)
-          self.remote_data = value
-        end
-      end
-
       if attributes.key?(:'custom_fields')
         if (value = attributes[:'custom_fields']).is_a?(Hash)
           self.custom_fields = value
@@ -367,6 +377,22 @@ module MergeHRISClient
       if attributes.key?(:'remote_was_deleted')
         self.remote_was_deleted = attributes[:'remote_was_deleted']
       end
+
+      if attributes.key?(:'field_mappings')
+        if (value = attributes[:'field_mappings']).is_a?(Hash)
+          self.field_mappings = value
+        end
+      end
+
+      if attributes.key?(:'modified_at')
+        self.modified_at = attributes[:'modified_at']
+      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?
@@ -476,9 +502,11 @@ module MergeHRISClient
           employment_status == o.employment_status &&
           termination_date == o.termination_date &&
           avatar == o.avatar &&
-          remote_data == o.remote_data &&
           custom_fields == o.custom_fields &&
-          remote_was_deleted == o.remote_was_deleted
+          remote_was_deleted == o.remote_was_deleted &&
+          field_mappings == o.field_mappings &&
+          modified_at == o.modified_at &&
+          remote_data == o.remote_data
     end
 
     # @see the `==` method
@@ -490,7 +518,7 @@ module MergeHRISClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, remote_id, employee_number, company, first_name, last_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, remote_created_at, employment_status, termination_date, avatar, remote_data, custom_fields, remote_was_deleted].hash
+      [id, remote_id, employee_number, company, first_name, last_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, remote_created_at, employment_status, termination_date, avatar, custom_fields, remote_was_deleted, field_mappings, modified_at, remote_data].hash
     end
 
     # Builds the object from hash

data/lib/merge_hris_client/models/employee_payroll_run.rb

@@ -14,21 +14,23 @@ require 'date'
 require 'time'
 
 module MergeHRISClient
-  # # The EmployeePayrollRun Object ### Description The `EmployeePayrollRun` object is used to represent a payroll run for a specific employee.  ### Usage Example Fetch from the `LIST EmployeePayrollRun` endpoint and filter by `ID` to show all employee payroll runs.
+  # # The EmployeePayrollRun Object ### Description The `EmployeePayrollRun` object is used to represent an employee's pay statement for a specific payroll run.  ### Usage Example Fetch from the `LIST EmployeePayrollRun` endpoint and filter by `ID` to show all employee payroll runs.
   class EmployeePayrollRun
     attr_accessor :id
 
     # The third-party API ID of the matching object.
     attr_accessor :remote_id
 
+    # The employee whose payroll is being run.
     attr_accessor :employee
 
+    # The payroll being run.
     attr_accessor :payroll_run
 
-    # The gross pay from the run.
+    # The total earnings throughout a given period for an employee before any deductions are made.
     attr_accessor :gross_pay
 
-    # The net pay from the run.
+    # The take-home pay throughout a given period for an employee after deductions are made.
     attr_accessor :net_pay
 
     # The day and time the payroll run started.
@@ -46,11 +48,16 @@ module MergeHRISClient
 
     attr_accessor :taxes
 
-    attr_accessor :remote_data
-
     # Indicates whether or not this object has been deleted by third party webhooks.
     attr_accessor :remote_was_deleted
 
+    attr_accessor :field_mappings
+
+    # This is the datetime that this object was last updated by Merge
+    attr_accessor :modified_at
+
+    attr_accessor :remote_data
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -66,8 +73,10 @@ module MergeHRISClient
         :'earnings' => :'earnings',
         :'deductions' => :'deductions',
         :'taxes' => :'taxes',
-        :'remote_data' => :'remote_data',
-        :'remote_was_deleted' => :'remote_was_deleted'
+        :'remote_was_deleted' => :'remote_was_deleted',
+        :'field_mappings' => :'field_mappings',
+        :'modified_at' => :'modified_at',
+        :'remote_data' => :'remote_data'
       }
     end
 
@@ -91,8 +100,10 @@ module MergeHRISClient
         :'earnings' => :'Array<Earning>',
         :'deductions' => :'Array<Deduction>',
         :'taxes' => :'Array<Tax>',
-        :'remote_data' => :'Array<RemoteData>',
-        :'remote_was_deleted' => :'Boolean'
+        :'remote_was_deleted' => :'Boolean',
+        :'field_mappings' => :'Hash<String, Object>',
+        :'modified_at' => :'Time',
+        :'remote_data' => :'Array<RemoteData>'
       }
     end
 
@@ -107,7 +118,8 @@ module MergeHRISClient
         :'start_date',
         :'end_date',
         :'check_date',
-        :'remote_data',
+        :'field_mappings',
+        :'remote_data'
       ])
     end
 
@@ -180,15 +192,25 @@ module MergeHRISClient
         end
       end
 
+      if attributes.key?(:'remote_was_deleted')
+        self.remote_was_deleted = attributes[:'remote_was_deleted']
+      end
+
+      if attributes.key?(:'field_mappings')
+        if (value = attributes[:'field_mappings']).is_a?(Hash)
+          self.field_mappings = value
+        end
+      end
+
+      if attributes.key?(:'modified_at')
+        self.modified_at = attributes[:'modified_at']
+      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?
@@ -221,8 +243,10 @@ module MergeHRISClient
           earnings == o.earnings &&
           deductions == o.deductions &&
           taxes == o.taxes &&
-          remote_data == o.remote_data &&
-          remote_was_deleted == o.remote_was_deleted
+          remote_was_deleted == o.remote_was_deleted &&
+          field_mappings == o.field_mappings &&
+          modified_at == o.modified_at &&
+          remote_data == o.remote_data
     end
 
     # @see the `==` method
@@ -234,7 +258,7 @@ module MergeHRISClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, remote_id, employee, payroll_run, gross_pay, net_pay, start_date, end_date, check_date, earnings, deductions, taxes, remote_data, remote_was_deleted].hash
+      [id, remote_id, employee, payroll_run, gross_pay, net_pay, start_date, end_date, check_date, earnings, deductions, taxes, remote_was_deleted, field_mappings, modified_at, remote_data].hash
     end
 
     # Builds the object from hash