merge_hris_client 3.0.0 → 3.1.0

data/lib/merge_hris_client/models/pay_group.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module MergeHRISClient
-  # # The PayGroup Object ### Description The `PayGroup` object is used to represent Pay Group information that employees belong to. This is often referenced with an Employee object.  ### Usage Example Fetch from the `LIST PayGroup` endpoint and filter by `ID` to show all pay group information.
+  # # The PayGroup Object ### Description The `PayGroup` object is used to represent a subset of employees that are put together for payroll processing purposes.  ### Usage Example Fetch from the `LIST PayGroup` endpoint and filter by `ID` to show all pay group information.
   class PayGroup
     attr_accessor :id
 
@@ -24,19 +24,26 @@ module MergeHRISClient
     # The pay group name.
     attr_accessor :pay_group_name
 
-    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',
         :'pay_group_name' => :'pay_group_name',
-        :'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
 
@@ -51,8 +58,10 @@ module MergeHRISClient
         :'id' => :'String',
         :'remote_id' => :'String',
         :'pay_group_name' => :'String',
-        :'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
 
@@ -61,7 +70,8 @@ module MergeHRISClient
       Set.new([
         :'remote_id',
         :'pay_group_name',
-        :'remote_data',
+        :'field_mappings',
+        :'remote_data'
       ])
     end
 
@@ -92,15 +102,25 @@ module MergeHRISClient
         self.pay_group_name = attributes[:'pay_group_name']
       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?
@@ -124,8 +144,10 @@ module MergeHRISClient
           id == o.id &&
           remote_id == o.remote_id &&
           pay_group_name == o.pay_group_name &&
-          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
@@ -137,7 +159,7 @@ module MergeHRISClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, remote_id, pay_group_name, remote_data, remote_was_deleted].hash
+      [id, remote_id, pay_group_name, remote_was_deleted, field_mappings, modified_at, remote_data].hash
     end
 
     # Builds the object from hash

data/lib/merge_hris_client/models/pay_period_enum.rb

@@ -19,6 +19,7 @@ module MergeHRISClient
     DAY = "DAY".freeze
     WEEK = "WEEK".freeze
     EVERY_TWO_WEEKS = "EVERY_TWO_WEEKS".freeze
+    SEMIMONTHLY = "SEMIMONTHLY".freeze
     MONTH = "MONTH".freeze
     QUARTER = "QUARTER".freeze
     EVERY_SIX_MONTHS = "EVERY_SIX_MONTHS".freeze
@@ -34,7 +35,7 @@ module MergeHRISClient
     # @return [String] The enum value
     def build_from_hash(value)
       @raw_value = value
-      if ["HOUR", "DAY", "WEEK", "EVERY_TWO_WEEKS", "MONTH", "QUARTER", "EVERY_SIX_MONTHS", "YEAR", ].include? value
+      if ["HOUR", "DAY", "WEEK", "EVERY_TWO_WEEKS", "SEMIMONTHLY", "MONTH", "QUARTER", "EVERY_SIX_MONTHS", "YEAR", ].include? value
         @value = value
       else
         @value = MERGE_NONSTANDARD_VALUE

data/lib/merge_hris_client/models/payroll_run.rb

@@ -14,17 +14,17 @@ require 'date'
 require 'time'
 
 module MergeHRISClient
-  # # The PayrollRun Object ### Description The `PayrollRun` object is used to represent a payroll run. This payroll run is not specific to an employee.  ### Usage Example Fetch from the `LIST PayrollRuns` endpoint and filter by `ID` to show all payroll runs.
+  # # The PayrollRun Object ### Description The `PayrollRun` object is used to represent a group of pay statements for a specific pay schedule.  ### Usage Example Fetch from the `LIST PayrollRuns` endpoint and filter by `ID` to show all payroll runs.
   class PayrollRun
     attr_accessor :id
 
     # The third-party API ID of the matching object.
     attr_accessor :remote_id
 
-    # The state of the payroll run
+    # The state of the payroll run  * `PAID` - PAID * `DRAFT` - DRAFT * `APPROVED` - APPROVED * `FAILED` - FAILED * `CLOSED` - CLOSED
     attr_accessor :run_state
 
-    # The type of the payroll run
+    # The type of the payroll run  * `REGULAR` - REGULAR * `OFF_CYCLE` - OFF_CYCLE * `CORRECTION` - CORRECTION * `TERMINATION` - TERMINATION * `SIGN_ON_BONUS` - SIGN_ON_BONUS
     attr_accessor :run_type
 
     # The day and time the payroll run started.
@@ -36,11 +36,16 @@ module MergeHRISClient
     # The day and time the payroll run was checked.
     attr_accessor :check_date
 
-    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
       {
@@ -51,8 +56,10 @@ module MergeHRISClient
         :'start_date' => :'start_date',
         :'end_date' => :'end_date',
         :'check_date' => :'check_date',
-        :'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
 
@@ -71,8 +78,10 @@ module MergeHRISClient
         :'start_date' => :'Time',
         :'end_date' => :'Time',
         :'check_date' => :'Time',
-        :'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
 
@@ -85,7 +94,8 @@ module MergeHRISClient
         :'start_date',
         :'end_date',
         :'check_date',
-        :'remote_data',
+        :'field_mappings',
+        :'remote_data'
       ])
     end
 
@@ -132,15 +142,25 @@ module MergeHRISClient
         self.check_date = attributes[:'check_date']
       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?
@@ -168,8 +188,10 @@ module MergeHRISClient
           start_date == o.start_date &&
           end_date == o.end_date &&
           check_date == o.check_date &&
-          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
@@ -181,7 +203,7 @@ module MergeHRISClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, remote_id, run_state, run_type, start_date, end_date, check_date, remote_data, remote_was_deleted].hash
+      [id, remote_id, run_state, run_type, start_date, end_date, check_date, remote_was_deleted, field_mappings, modified_at, remote_data].hash
     end
 
     # Builds the object from hash

data/lib/merge_hris_client/models/selective_sync_configurations_usage_enum.rb

@@ -0,0 +1,45 @@
+=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
+  class SelectiveSyncConfigurationsUsageEnum
+    NEXT_SYNC = "IN_NEXT_SYNC".freeze
+    LAST_SYNC = "IN_LAST_SYNC".freeze
+
+    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)
+      @raw_value = value
+      if ["IN_NEXT_SYNC", "IN_LAST_SYNC", ].include? value
+        @value = value
+      else
+        @value = MERGE_NONSTANDARD_VALUE
+      end
+
+      self
+    end
+
+    def self.build_from_hash(value)
+      SelectiveSyncConfigurationsUsageEnum.new.build_from_hash(value)
+    end
+  end
+
+end

data/lib/merge_hris_client/models/sync_status.rb

@@ -28,6 +28,8 @@ module MergeHRISClient
 
     attr_accessor :is_initial_sync
 
+    attr_accessor :selective_sync_configurations_usage
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -36,7 +38,8 @@ module MergeHRISClient
         :'last_sync_start' => :'last_sync_start',
         :'next_sync_start' => :'next_sync_start',
         :'status' => :'status',
-        :'is_initial_sync' => :'is_initial_sync'
+        :'is_initial_sync' => :'is_initial_sync',
+        :'selective_sync_configurations_usage' => :'selective_sync_configurations_usage'
       }
     end
 
@@ -53,7 +56,8 @@ module MergeHRISClient
         :'last_sync_start' => :'Time',
         :'next_sync_start' => :'Time',
         :'status' => :'SyncStatusStatusEnum',
-        :'is_initial_sync' => :'Boolean'
+        :'is_initial_sync' => :'Boolean',
+        :'selective_sync_configurations_usage' => :'SelectiveSyncConfigurationsUsageEnum'
       }
     end
 
@@ -101,6 +105,10 @@ module MergeHRISClient
       if attributes.key?(:'is_initial_sync')
         self.is_initial_sync = attributes[:'is_initial_sync']
       end
+
+      if attributes.key?(:'selective_sync_configurations_usage')
+        self.selective_sync_configurations_usage = attributes[:'selective_sync_configurations_usage']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -146,7 +154,8 @@ module MergeHRISClient
           last_sync_start == o.last_sync_start &&
           next_sync_start == o.next_sync_start &&
           status == o.status &&
-          is_initial_sync == o.is_initial_sync
+          is_initial_sync == o.is_initial_sync &&
+          selective_sync_configurations_usage == o.selective_sync_configurations_usage
     end
 
     # @see the `==` method
@@ -158,7 +167,7 @@ module MergeHRISClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [model_name, model_id, last_sync_start, next_sync_start, status, is_initial_sync].hash
+      [model_name, model_id, last_sync_start, next_sync_start, status, is_initial_sync, selective_sync_configurations_usage].hash
     end
 
     # Builds the object from hash

data/lib/merge_hris_client/models/tax.rb

@@ -14,10 +14,13 @@ require 'date'
 require 'time'
 
 module MergeHRISClient
-  # # The Tax Object ### Description The `Tax` object is used to represent a tax for a given employee's payroll run. One run could include several taxes.  ### Usage Example Fetch from the `LIST Taxes` endpoint and filter by `ID` to show all taxes.
+  # # The Tax Object ### Description The `Tax` object is used to represent an array of the tax deductions for a given employee's payroll run.  ### Usage Example Fetch from the `LIST Taxes` endpoint and filter by `ID` to show all taxes.
   class Tax
     attr_accessor :id
 
+    # The third-party API ID of the matching object.
+    attr_accessor :remote_id
+
     attr_accessor :employee_payroll_run
 
     # The tax's name.
@@ -32,15 +35,26 @@ module MergeHRISClient
     # 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',
         :'amount' => :'amount',
         :'employer_tax' => :'employer_tax',
-        :'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
 
@@ -53,21 +67,28 @@ module MergeHRISClient
     def self.openapi_types
       {
         :'id' => :'String',
+        :'remote_id' => :'String',
         :'employee_payroll_run' => :'String',
         :'name' => :'String',
         :'amount' => :'Float',
         :'employer_tax' => :'Boolean',
-        :'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',
         :'amount',
         :'employer_tax',
+        :'field_mappings',
+        :'remote_data'
       ])
     end
 
@@ -90,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
@@ -109,6 +134,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?
@@ -130,11 +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 &&
           amount == o.amount &&
           employer_tax == o.employer_tax &&
-          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
@@ -146,7 +191,7 @@ module MergeHRISClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, employee_payroll_run, name, amount, employer_tax, remote_was_deleted].hash
+      [id, remote_id, employee_payroll_run, name, amount, employer_tax, remote_was_deleted, field_mappings, modified_at, remote_data].hash
     end
 
     # Builds the object from hash

data/lib/merge_hris_client/models/team.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module MergeHRISClient
-  # # The Team Object ### Description The `Team` object is used to represent a Team within a company. `Employee` objects are often grouped this way. Note that in the Merge HRIS API, company subdivisions are all represented with `Teams`, rather than `Teams` and `Departments`.  ### Usage Example If you're building a way to filter by `Team`, you'd hit the `GET Teams` endpoint to fetch the `Teams`, and then use the `ID` of the team your user selects to filter the `GET Employees` endpoint.
+  # # The Team Object ### Description The `Team` object is used to represent a subdivision of the company, usually a department. Each employee will be grouped into one specific Team.  ### Usage Example If you're building a way to filter by `Team`, you'd hit the `GET Teams` endpoint to fetch the `Teams`, and then use the `ID` of the team your user selects to filter the `GET Employees` endpoint.
   class Team
     attr_accessor :id
 
@@ -24,13 +24,19 @@ module MergeHRISClient
     # The team's name.
     attr_accessor :name
 
+    # The team's parent team.
     attr_accessor :parent_team
 
-    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
       {
@@ -38,8 +44,10 @@ module MergeHRISClient
         :'remote_id' => :'remote_id',
         :'name' => :'name',
         :'parent_team' => :'parent_team',
-        :'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
 
@@ -55,8 +63,10 @@ module MergeHRISClient
         :'remote_id' => :'String',
         :'name' => :'String',
         :'parent_team' => :'String',
-        :'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
 
@@ -66,7 +76,8 @@ module MergeHRISClient
         :'remote_id',
         :'name',
         :'parent_team',
-        :'remote_data',
+        :'field_mappings',
+        :'remote_data'
       ])
     end
 
@@ -101,15 +112,25 @@ module MergeHRISClient
         self.parent_team = attributes[:'parent_team']
       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?
@@ -134,8 +155,10 @@ module MergeHRISClient
           remote_id == o.remote_id &&
           name == o.name &&
           parent_team == o.parent_team &&
-          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
@@ -147,7 +170,7 @@ module MergeHRISClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, remote_id, name, parent_team, remote_data, remote_was_deleted].hash
+      [id, remote_id, name, parent_team, remote_was_deleted, field_mappings, modified_at, remote_data].hash
     end
 
     # Builds the object from hash