merge_ruby_client 0.1.3 → 1.0.0

data/lib/merge_ruby_client/hris/types/employee_payroll_run.rb

@@ -51,7 +51,9 @@ module Merge
       # @return [Array<Merge::Hris::Tax>]
       attr_reader :taxes
       # @return [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       attr_reader :remote_was_deleted
       # @return [Hash{String => Object}]
       attr_reader :field_mappings
@@ -82,7 +84,9 @@ module Merge
       # @param deductions [Array<Merge::Hris::Deduction>]
       # @param taxes [Array<Merge::Hris::Tax>]
       # @param remote_was_deleted [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       # @param field_mappings [Hash{String => Object}]
       # @param remote_data [Array<Merge::Hris::RemoteData>]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition

data/lib/merge_ruby_client/hris/types/employee_request.rb

@@ -21,7 +21,8 @@ module Merge
     # # The Employee Object
     #  ### Description
     #  The `Employee` object is used to represent any person who has been employed by a
-    #  company.
+    #  company. By default, it returns all employees. To filter for only active
+    #  employees, set the `employment_status` query parameter to `ACTIVE`.
     #  ### Usage Example
     #  Fetch from the `LIST Employee` endpoint and filter by `ID` to show all
     #  employees.

data/lib/merge_ruby_client/hris/types/employer_benefit.rb

@@ -2,6 +2,7 @@
 
 require "date"
 require_relative "benefit_plan_type_enum"
+require_relative "remote_data"
 require "ostruct"
 require "json"
 
@@ -37,11 +38,13 @@ module Merge
       # @return [String] The employer benefit's deduction code.
       attr_reader :deduction_code
       # @return [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       attr_reader :remote_was_deleted
       # @return [Hash{String => Object}]
       attr_reader :field_mappings
-      # @return [Array<Hash{String => Object}>]
+      # @return [Array<Merge::Hris::RemoteData>]
       attr_reader :remote_data
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
@@ -65,9 +68,11 @@ module Merge
       # @param description [String] The employer benefit's description.
       # @param deduction_code [String] The employer benefit's deduction code.
       # @param remote_was_deleted [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       # @param field_mappings [Hash{String => Object}]
-      # @param remote_data [Array<Hash{String => Object}>]
+      # @param remote_data [Array<Merge::Hris::RemoteData>]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Merge::Hris::EmployerBenefit]
       def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, benefit_plan_type: OMIT,
@@ -118,7 +123,10 @@ module Merge
         deduction_code = parsed_json["deduction_code"]
         remote_was_deleted = parsed_json["remote_was_deleted"]
         field_mappings = parsed_json["field_mappings"]
-        remote_data = parsed_json["remote_data"]
+        remote_data = parsed_json["remote_data"]&.map do |item|
+          item = item.to_json
+          Merge::Hris::RemoteData.from_json(json_object: item)
+        end
         new(
           id: id,
           remote_id: remote_id,

data/lib/merge_ruby_client/hris/types/employment.rb

@@ -17,9 +17,11 @@ module Merge
     # # The Employment Object
     #  ### Description
     #  The `Employment` object is used to represent a job position at a company.
-    #  Please note: When there is a change in pay or title, integrations with
-    #  historical data will create new Employment objects while integrations without
-    #  historical data will update existing ones.
+    #  If an integration supports historical tracking of employments, it will be
+    #  reflected in the data. If not, a new `Employment` object will be created
+    #  whenever there is a change in job title or pay. The `effective_date` field
+    #  should be used to order `Employment` objects, with the most recent date
+    #  corresponding to the latest employment record for an employee.
     #  ### Usage Example
     #  Fetch from the `LIST Employments` endpoint and filter by `ID` to show all
     #  employees.
@@ -36,7 +38,7 @@ module Merge
       attr_reader :employee
       # @return [String] The position's title.
       attr_reader :job_title
-      # @return [Float] The position's pay rate in dollars.
+      # @return [Float] The position's pay rate.
       attr_reader :pay_rate
       # @return [Merge::Hris::PayPeriodEnum] The time period this pay rate encompasses.
       #  - `HOUR` - HOUR
@@ -386,7 +388,9 @@ module Merge
       #  - `FREELANCE` - FREELANCE
       attr_reader :employment_type
       # @return [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       attr_reader :remote_was_deleted
       # @return [Hash{String => Object}]
       attr_reader :field_mappings
@@ -406,7 +410,7 @@ module Merge
       # @param modified_at [DateTime] The datetime that this object was modified by Merge.
       # @param employee [Merge::Hris::EmploymentEmployee] The employee holding this position.
       # @param job_title [String] The position's title.
-      # @param pay_rate [Float] The position's pay rate in dollars.
+      # @param pay_rate [Float] The position's pay rate.
       # @param pay_period [Merge::Hris::PayPeriodEnum] The time period this pay rate encompasses.
       #  - `HOUR` - HOUR
       #  - `DAY` - DAY
@@ -748,7 +752,9 @@ module Merge
       #  - `CONTRACTOR` - CONTRACTOR
       #  - `FREELANCE` - FREELANCE
       # @param remote_was_deleted [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       # @param field_mappings [Hash{String => Object}]
       # @param remote_data [Array<Merge::Hris::RemoteData>]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition

data/lib/merge_ruby_client/hris/types/event_type_enum.rb

@@ -40,12 +40,19 @@ module Merge
     #  - `DELETED_INTEGRATION_WIDE_FIELD_MAPPING` -
     #  DELETED_INTEGRATION_WIDE_FIELD_MAPPING
     #  - `DELETED_LINKED_ACCOUNT_FIELD_MAPPING` - DELETED_LINKED_ACCOUNT_FIELD_MAPPING
+    #  - `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE` -
+    #  CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE
+    #  - `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE` -
+    #  CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE
+    #  - `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE` -
+    #  DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE
     #  - `FORCED_LINKED_ACCOUNT_RESYNC` - FORCED_LINKED_ACCOUNT_RESYNC
     #  - `MUTED_ISSUE` - MUTED_ISSUE
     #  - `GENERATED_MAGIC_LINK` - GENERATED_MAGIC_LINK
     #  - `ENABLED_MERGE_WEBHOOK` - ENABLED_MERGE_WEBHOOK
     #  - `DISABLED_MERGE_WEBHOOK` - DISABLED_MERGE_WEBHOOK
     #  - `MERGE_WEBHOOK_TARGET_CHANGED` - MERGE_WEBHOOK_TARGET_CHANGED
+    #  - `END_USER_CREDENTIALS_ACCESSED` - END_USER_CREDENTIALS_ACCESSED
     class EventTypeEnum
       CREATED_REMOTE_PRODUCTION_API_KEY = "CREATED_REMOTE_PRODUCTION_API_KEY"
       DELETED_REMOTE_PRODUCTION_API_KEY = "DELETED_REMOTE_PRODUCTION_API_KEY"
@@ -78,12 +85,16 @@ module Merge
       CHANGED_LINKED_ACCOUNT_FIELD_MAPPING = "CHANGED_LINKED_ACCOUNT_FIELD_MAPPING"
       DELETED_INTEGRATION_WIDE_FIELD_MAPPING = "DELETED_INTEGRATION_WIDE_FIELD_MAPPING"
       DELETED_LINKED_ACCOUNT_FIELD_MAPPING = "DELETED_LINKED_ACCOUNT_FIELD_MAPPING"
+      CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE = "CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE"
+      CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE = "CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE"
+      DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE = "DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE"
       FORCED_LINKED_ACCOUNT_RESYNC = "FORCED_LINKED_ACCOUNT_RESYNC"
       MUTED_ISSUE = "MUTED_ISSUE"
       GENERATED_MAGIC_LINK = "GENERATED_MAGIC_LINK"
       ENABLED_MERGE_WEBHOOK = "ENABLED_MERGE_WEBHOOK"
       DISABLED_MERGE_WEBHOOK = "DISABLED_MERGE_WEBHOOK"
       MERGE_WEBHOOK_TARGET_CHANGED = "MERGE_WEBHOOK_TARGET_CHANGED"
+      END_USER_CREDENTIALS_ACCESSED = "END_USER_CREDENTIALS_ACCESSED"
     end
   end
 end

data/lib/merge_ruby_client/hris/types/field_mapping_api_instance_remote_field.rb

@@ -26,16 +26,18 @@ module Merge
       # @param remote_endpoint_info [Merge::Hris::FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Merge::Hris::FieldMappingApiInstanceRemoteField]
-      def initialize(remote_key_name:, schema:, remote_endpoint_info:, additional_properties: nil)
-        @remote_key_name = remote_key_name
-        @schema = schema
+      def initialize(remote_endpoint_info:, remote_key_name: OMIT, schema: OMIT, additional_properties: nil)
+        @remote_key_name = remote_key_name if remote_key_name != OMIT
+        @schema = schema if schema != OMIT
         @remote_endpoint_info = remote_endpoint_info
         @additional_properties = additional_properties
         @_field_set = {
           "remote_key_name": remote_key_name,
           "schema": schema,
           "remote_endpoint_info": remote_endpoint_info
-        }
+        }.reject do |_k, v|
+          v == OMIT
+        end
       end
 
       # Deserialize a JSON object to an instance of FieldMappingApiInstanceRemoteField
@@ -75,8 +77,8 @@ module Merge
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
-        obj.remote_key_name.is_a?(String) != false || raise("Passed value for field obj.remote_key_name is not the expected type, validation failed.")
-        obj.schema.is_a?(Hash) != false || raise("Passed value for field obj.schema is not the expected type, validation failed.")
+        obj.remote_key_name&.is_a?(String) != false || raise("Passed value for field obj.remote_key_name is not the expected type, validation failed.")
+        obj.schema&.is_a?(Hash) != false || raise("Passed value for field obj.schema is not the expected type, validation failed.")
         Merge::Hris::FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo.validate_raw(obj: obj.remote_endpoint_info)
       end
     end

data/lib/merge_ruby_client/hris/types/field_permission_deserializer.rb

@@ -7,9 +7,9 @@ module Merge
   module Hris
     class FieldPermissionDeserializer
       # @return [Array<Object>]
-      attr_reader :enabled
+      attr_reader :enabled_fields
       # @return [Array<Object>]
-      attr_reader :disabled
+      attr_reader :disabled_fields
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
       # @return [Object]
@@ -18,15 +18,15 @@ module Merge
 
       OMIT = Object.new
 
-      # @param enabled [Array<Object>]
-      # @param disabled [Array<Object>]
+      # @param enabled_fields [Array<Object>]
+      # @param disabled_fields [Array<Object>]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Merge::Hris::FieldPermissionDeserializer]
-      def initialize(enabled: OMIT, disabled: OMIT, additional_properties: nil)
-        @enabled = enabled if enabled != OMIT
-        @disabled = disabled if disabled != OMIT
+      def initialize(enabled_fields: OMIT, disabled_fields: OMIT, additional_properties: nil)
+        @enabled_fields = enabled_fields if enabled_fields != OMIT
+        @disabled_fields = disabled_fields if disabled_fields != OMIT
         @additional_properties = additional_properties
-        @_field_set = { "enabled": enabled, "disabled": disabled }.reject do |_k, v|
+        @_field_set = { "enabled_fields": enabled_fields, "disabled_fields": disabled_fields }.reject do |_k, v|
           v == OMIT
         end
       end
@@ -38,11 +38,11 @@ module Merge
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
-        enabled = parsed_json["enabled"]
-        disabled = parsed_json["disabled"]
+        enabled_fields = parsed_json["enabled_fields"]
+        disabled_fields = parsed_json["disabled_fields"]
         new(
-          enabled: enabled,
-          disabled: disabled,
+          enabled_fields: enabled_fields,
+          disabled_fields: disabled_fields,
           additional_properties: struct
         )
       end
@@ -61,8 +61,8 @@ module Merge
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
-        obj.enabled&.is_a?(Array) != false || raise("Passed value for field obj.enabled is not the expected type, validation failed.")
-        obj.disabled&.is_a?(Array) != false || raise("Passed value for field obj.disabled is not the expected type, validation failed.")
+        obj.enabled_fields&.is_a?(Array) != false || raise("Passed value for field obj.enabled_fields is not the expected type, validation failed.")
+        obj.disabled_fields&.is_a?(Array) != false || raise("Passed value for field obj.disabled_fields is not the expected type, validation failed.")
       end
     end
   end

data/lib/merge_ruby_client/hris/types/field_permission_deserializer_request.rb

@@ -7,9 +7,9 @@ module Merge
   module Hris
     class FieldPermissionDeserializerRequest
       # @return [Array<Object>]
-      attr_reader :enabled
+      attr_reader :enabled_fields
       # @return [Array<Object>]
-      attr_reader :disabled
+      attr_reader :disabled_fields
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
       # @return [Object]
@@ -18,15 +18,15 @@ module Merge
 
       OMIT = Object.new
 
-      # @param enabled [Array<Object>]
-      # @param disabled [Array<Object>]
+      # @param enabled_fields [Array<Object>]
+      # @param disabled_fields [Array<Object>]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Merge::Hris::FieldPermissionDeserializerRequest]
-      def initialize(enabled: OMIT, disabled: OMIT, additional_properties: nil)
-        @enabled = enabled if enabled != OMIT
-        @disabled = disabled if disabled != OMIT
+      def initialize(enabled_fields: OMIT, disabled_fields: OMIT, additional_properties: nil)
+        @enabled_fields = enabled_fields if enabled_fields != OMIT
+        @disabled_fields = disabled_fields if disabled_fields != OMIT
         @additional_properties = additional_properties
-        @_field_set = { "enabled": enabled, "disabled": disabled }.reject do |_k, v|
+        @_field_set = { "enabled_fields": enabled_fields, "disabled_fields": disabled_fields }.reject do |_k, v|
           v == OMIT
         end
       end
@@ -38,11 +38,11 @@ module Merge
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
-        enabled = parsed_json["enabled"]
-        disabled = parsed_json["disabled"]
+        enabled_fields = parsed_json["enabled_fields"]
+        disabled_fields = parsed_json["disabled_fields"]
         new(
-          enabled: enabled,
-          disabled: disabled,
+          enabled_fields: enabled_fields,
+          disabled_fields: disabled_fields,
           additional_properties: struct
         )
       end
@@ -61,8 +61,8 @@ module Merge
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
-        obj.enabled&.is_a?(Array) != false || raise("Passed value for field obj.enabled is not the expected type, validation failed.")
-        obj.disabled&.is_a?(Array) != false || raise("Passed value for field obj.disabled is not the expected type, validation failed.")
+        obj.enabled_fields&.is_a?(Array) != false || raise("Passed value for field obj.enabled_fields is not the expected type, validation failed.")
+        obj.disabled_fields&.is_a?(Array) != false || raise("Passed value for field obj.disabled_fields is not the expected type, validation failed.")
       end
     end
   end

data/lib/merge_ruby_client/hris/types/group.rb

@@ -36,7 +36,9 @@ module Merge
       #  - `GROUP` - GROUP
       attr_reader :type
       # @return [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       attr_reader :remote_was_deleted
       # @return [Boolean] Indicates whether the Group refers to a team in the third party platform. Note
       #  that this is an opinionated view based on how Merge observes most organizations
@@ -68,7 +70,9 @@ module Merge
       #  - `BUSINESS_UNIT` - BUSINESS_UNIT
       #  - `GROUP` - GROUP
       # @param remote_was_deleted [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       # @param is_commonly_used_as_team [Boolean] Indicates whether the Group refers to a team in the third party platform. Note
       #  that this is an opinionated view based on how Merge observes most organizations
       #  representing teams in each third party platform. If your customer uses a

data/lib/merge_ruby_client/hris/types/language_enum.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Merge
+  module Hris
+    # - `en` - en
+    #  - `de` - de
+    class LanguageEnum
+      EN = "en"
+      DE = "de"
+    end
+  end
+end

data/lib/merge_ruby_client/hris/types/location.rb

@@ -295,7 +295,9 @@ module Merge
       #  - `WORK` - WORK
       attr_reader :location_type
       # @return [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       attr_reader :remote_was_deleted
       # @return [Hash{String => Object}]
       attr_reader :field_mappings
@@ -574,7 +576,9 @@ module Merge
       #  - `HOME` - HOME
       #  - `WORK` - WORK
       # @param remote_was_deleted [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       # @param field_mappings [Hash{String => Object}]
       # @param remote_data [Array<Merge::Hris::RemoteData>]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition

data/lib/merge_ruby_client/hris/types/pay_group.rb

@@ -26,7 +26,9 @@ module Merge
       # @return [String] The pay group name.
       attr_reader :pay_group_name
       # @return [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       attr_reader :remote_was_deleted
       # @return [Hash{String => Object}]
       attr_reader :field_mappings
@@ -46,7 +48,9 @@ module Merge
       # @param modified_at [DateTime] The datetime that this object was modified by Merge.
       # @param pay_group_name [String] The pay group name.
       # @param remote_was_deleted [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       # @param field_mappings [Hash{String => Object}]
       # @param remote_data [Array<Merge::Hris::RemoteData>]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition

data/lib/merge_ruby_client/hris/types/payroll_run.rb

@@ -46,7 +46,9 @@ module Merge
       # @return [DateTime] The day and time the payroll run was checked.
       attr_reader :check_date
       # @return [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       attr_reader :remote_was_deleted
       # @return [Hash{String => Object}]
       attr_reader :field_mappings
@@ -80,7 +82,9 @@ module Merge
       # @param end_date [DateTime] The day and time the payroll run ended.
       # @param check_date [DateTime] The day and time the payroll run was checked.
       # @param remote_was_deleted [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       # @param field_mappings [Hash{String => Object}]
       # @param remote_data [Array<Merge::Hris::RemoteData>]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition

data/lib/merge_ruby_client/hris/types/remote_data.rb

@@ -5,8 +5,14 @@ require "json"
 
 module Merge
   module Hris
+    # # The RemoteData Object
+    #  ### Description
+    #  The `RemoteData` object is used to represent the full data pulled from the
+    #  third-party API for an object.
+    #  ### Usage Example
+    #  TODO
     class RemoteData
-      # @return [String]
+      # @return [String] The third-party API path that is being called.
       attr_reader :path
       # @return [Object]
       attr_reader :data
@@ -18,7 +24,7 @@ module Merge
 
       OMIT = Object.new
 
-      # @param path [String]
+      # @param path [String] The third-party API path that is being called.
       # @param data [Object]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Merge::Hris::RemoteData]

data/lib/merge_ruby_client/hris/types/remote_field_api.rb

@@ -37,12 +37,12 @@ module Merge
       # @param coverage [Merge::Hris::RemoteFieldApiCoverage]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Merge::Hris::RemoteFieldApi]
-      def initialize(schema:, remote_key_name:, remote_endpoint_info:, example_values:, advanced_metadata: OMIT,
+      def initialize(schema:, remote_key_name:, remote_endpoint_info:, example_values: OMIT, advanced_metadata: OMIT,
                      coverage: OMIT, additional_properties: nil)
         @schema = schema
         @remote_key_name = remote_key_name
         @remote_endpoint_info = remote_endpoint_info
-        @example_values = example_values
+        @example_values = example_values if example_values != OMIT
         @advanced_metadata = advanced_metadata if advanced_metadata != OMIT
         @coverage = coverage if coverage != OMIT
         @additional_properties = additional_properties
@@ -114,7 +114,7 @@ module Merge
         obj.schema.is_a?(Hash) != false || raise("Passed value for field obj.schema is not the expected type, validation failed.")
         obj.remote_key_name.is_a?(String) != false || raise("Passed value for field obj.remote_key_name is not the expected type, validation failed.")
         Merge::Hris::RemoteEndpointInfo.validate_raw(obj: obj.remote_endpoint_info)
-        obj.example_values.is_a?(Array) != false || raise("Passed value for field obj.example_values is not the expected type, validation failed.")
+        obj.example_values&.is_a?(Array) != false || raise("Passed value for field obj.example_values is not the expected type, validation failed.")
         obj.advanced_metadata.nil? || Merge::Hris::AdvancedMetadata.validate_raw(obj: obj.advanced_metadata)
         obj.coverage.nil? || Merge::Hris::RemoteFieldApiCoverage.validate_raw(obj: obj.coverage)
       end

data/lib/merge_ruby_client/hris/types/tax.rb

@@ -31,7 +31,9 @@ module Merge
       # @return [Boolean] Whether or not the employer is responsible for paying the tax.
       attr_reader :employer_tax
       # @return [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       attr_reader :remote_was_deleted
       # @return [Hash{String => Object}]
       attr_reader :field_mappings
@@ -54,7 +56,9 @@ module Merge
       # @param amount [Float] The tax amount.
       # @param employer_tax [Boolean] Whether or not the employer is responsible for paying the tax.
       # @param remote_was_deleted [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       # @param field_mappings [Hash{String => Object}]
       # @param remote_data [Array<Merge::Hris::RemoteData>]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition

data/lib/merge_ruby_client/hris/types/team.rb

@@ -30,7 +30,9 @@ module Merge
       # @return [Merge::Hris::TeamParentTeam] The team's parent team.
       attr_reader :parent_team
       # @return [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       attr_reader :remote_was_deleted
       # @return [Hash{String => Object}]
       attr_reader :field_mappings
@@ -51,7 +53,9 @@ module Merge
       # @param name [String] The team's name.
       # @param parent_team [Merge::Hris::TeamParentTeam] The team's parent team.
       # @param remote_was_deleted [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       # @param field_mappings [Hash{String => Object}]
       # @param remote_data [Array<Merge::Hris::RemoteData>]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition

data/lib/merge_ruby_client/hris/types/time_off.rb

@@ -58,7 +58,10 @@ module Merge
       attr_reader :start_time
       # @return [DateTime] The day and time of the end of the time requested off.
       attr_reader :end_time
-      # @return [Boolean]
+      # @return [Boolean] Indicates whether or not this object has been deleted in the third party
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       attr_reader :remote_was_deleted
       # @return [Hash{String => Object}]
       attr_reader :field_mappings
@@ -98,7 +101,10 @@ module Merge
       #  - `BEREAVEMENT` - BEREAVEMENT
       # @param start_time [DateTime] The day and time of the start of the time requested off.
       # @param end_time [DateTime] The day and time of the end of the time requested off.
-      # @param remote_was_deleted [Boolean]
+      # @param remote_was_deleted [Boolean] Indicates whether or not this object has been deleted in the third party
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       # @param field_mappings [Hash{String => Object}]
       # @param remote_data [Array<Merge::Hris::RemoteData>]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition

data/lib/merge_ruby_client/hris/types/time_off_balance.rb

@@ -27,9 +27,11 @@ module Merge
       attr_reader :modified_at
       # @return [Merge::Hris::TimeOffBalanceEmployee] The employee the balance belongs to.
       attr_reader :employee
-      # @return [Float] The current remaining PTO balance, always measured in terms of hours.
+      # @return [Float] The current remaining PTO balance, measured in hours. For integrations that
+      #  return this value in days, Merge multiplies by 8 to calculate hours.
       attr_reader :balance
-      # @return [Float] The amount of PTO used in terms of hours.
+      # @return [Float] The amount of PTO used in terms of hours. For integrations that return this
+      #  value in days, Merge multiplies by 8 to calculate hours.
       attr_reader :used
       # @return [Merge::Hris::PolicyTypeEnum] The policy type of this time off balance.
       #  - `VACATION` - VACATION
@@ -40,7 +42,9 @@ module Merge
       #  - `BEREAVEMENT` - BEREAVEMENT
       attr_reader :policy_type
       # @return [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       attr_reader :remote_was_deleted
       # @return [Hash{String => Object}]
       attr_reader :field_mappings
@@ -59,8 +63,10 @@ module Merge
       # @param created_at [DateTime] The datetime that this object was created by Merge.
       # @param modified_at [DateTime] The datetime that this object was modified by Merge.
       # @param employee [Merge::Hris::TimeOffBalanceEmployee] The employee the balance belongs to.
-      # @param balance [Float] The current remaining PTO balance, always measured in terms of hours.
-      # @param used [Float] The amount of PTO used in terms of hours.
+      # @param balance [Float] The current remaining PTO balance, measured in hours. For integrations that
+      #  return this value in days, Merge multiplies by 8 to calculate hours.
+      # @param used [Float] The amount of PTO used in terms of hours. For integrations that return this
+      #  value in days, Merge multiplies by 8 to calculate hours.
       # @param policy_type [Merge::Hris::PolicyTypeEnum] The policy type of this time off balance.
       #  - `VACATION` - VACATION
       #  - `SICK` - SICK
@@ -69,7 +75,9 @@ module Merge
       #  - `VOLUNTEER` - VOLUNTEER
       #  - `BEREAVEMENT` - BEREAVEMENT
       # @param remote_was_deleted [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       # @param field_mappings [Hash{String => Object}]
       # @param remote_data [Array<Merge::Hris::RemoteData>]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition