merge_ruby_client 0.1.4 → 1.1.0

data/lib/merge_ruby_client/hris/locations/client.rb

@@ -3,7 +3,11 @@
 require_relative "../../../requests"
 require "date"
 require_relative "types/locations_list_request_location_type"
+require_relative "types/locations_list_request_remote_fields"
+require_relative "types/locations_list_request_show_enum_origins"
 require_relative "../types/paginated_location_list"
+require_relative "types/locations_retrieve_request_remote_fields"
+require_relative "types/locations_retrieve_request_show_enum_origins"
 require_relative "../types/location"
 require "async"
 
@@ -24,19 +28,24 @@ module Merge
       # @param created_after [DateTime] If provided, will only return objects created after this datetime.
       # @param created_before [DateTime] If provided, will only return objects created before this datetime.
       # @param cursor [String] The pagination cursor value.
-      # @param include_deleted_data [Boolean] Whether to include data that was marked as deleted by third party webhooks.
+      # @param include_deleted_data [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 include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
+      # @param include_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
       # @param location_type [Merge::Hris::Locations::LocationsListRequestLocationType] If provided, will only return locations with this location_type
-      #  - `HOME` - HOME
-      #  - `WORK` - WORK
+      #  * `HOME` - HOME
+      #  * `WORK` - WORK
       # @param modified_after [DateTime] If provided, only objects synced by Merge after this date time will be returned.
       # @param modified_before [DateTime] If provided, only objects synced by Merge before this date time will be
       #  returned.
       # @param page_size [Integer] Number of results to return per page.
-      # @param remote_fields [String] Deprecated. Use show_enum_origins.
+      # @param remote_fields [Merge::Hris::Locations::LocationsListRequestRemoteFields] Deprecated. Use show_enum_origins.
       # @param remote_id [String] The API provider's ID for the given object.
-      # @param show_enum_origins [String] A comma separated list of enum field names for which you'd like the original
+      # @param show_enum_origins [Merge::Hris::Locations::LocationsListRequestShowEnumOrigins] A comma separated list of enum field names for which you'd like the original
       #  values to be returned, instead of Merge's normalized enum values. [Learn
       #  e](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
       # @param request_options [Merge::RequestOptions]
@@ -49,7 +58,7 @@ module Merge
       #  )
       #  api.hris.locations.list
       def list(created_after: nil, created_before: nil, cursor: nil, include_deleted_data: nil,
-               include_remote_data: nil, location_type: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, request_options: nil)
+               include_remote_data: nil, include_shell_data: nil, location_type: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, request_options: nil)
         response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
@@ -66,6 +75,7 @@ module Merge
             "cursor": cursor,
             "include_deleted_data": include_deleted_data,
             "include_remote_data": include_remote_data,
+            "include_shell_data": include_shell_data,
             "location_type": location_type,
             "modified_after": modified_after,
             "modified_before": modified_before,
@@ -87,8 +97,10 @@ module Merge
       # @param id [String]
       # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
-      # @param remote_fields [String] Deprecated. Use show_enum_origins.
-      # @param show_enum_origins [String] A comma separated list of enum field names for which you'd like the original
+      # @param include_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
+      # @param remote_fields [Merge::Hris::Locations::LocationsRetrieveRequestRemoteFields] Deprecated. Use show_enum_origins.
+      # @param show_enum_origins [Merge::Hris::Locations::LocationsRetrieveRequestShowEnumOrigins] A comma separated list of enum field names for which you'd like the original
       #  values to be returned, instead of Merge's normalized enum values. [Learn
       #  e](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
       # @param request_options [Merge::RequestOptions]
@@ -100,7 +112,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.hris.locations.retrieve(id: "id")
-      def retrieve(id:, include_remote_data: nil, remote_fields: nil, show_enum_origins: nil, request_options: nil)
+      def retrieve(id:, include_remote_data: nil, include_shell_data: nil, remote_fields: nil, show_enum_origins: nil,
+                   request_options: nil)
         response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
@@ -113,6 +126,7 @@ module Merge
           req.params = {
             **(request_options&.additional_query_parameters || {}),
             "include_remote_data": include_remote_data,
+            "include_shell_data": include_shell_data,
             "remote_fields": remote_fields,
             "show_enum_origins": show_enum_origins
           }.compact
@@ -140,19 +154,24 @@ module Merge
       # @param created_after [DateTime] If provided, will only return objects created after this datetime.
       # @param created_before [DateTime] If provided, will only return objects created before this datetime.
       # @param cursor [String] The pagination cursor value.
-      # @param include_deleted_data [Boolean] Whether to include data that was marked as deleted by third party webhooks.
+      # @param include_deleted_data [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 include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
+      # @param include_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
       # @param location_type [Merge::Hris::Locations::LocationsListRequestLocationType] If provided, will only return locations with this location_type
-      #  - `HOME` - HOME
-      #  - `WORK` - WORK
+      #  * `HOME` - HOME
+      #  * `WORK` - WORK
       # @param modified_after [DateTime] If provided, only objects synced by Merge after this date time will be returned.
       # @param modified_before [DateTime] If provided, only objects synced by Merge before this date time will be
       #  returned.
       # @param page_size [Integer] Number of results to return per page.
-      # @param remote_fields [String] Deprecated. Use show_enum_origins.
+      # @param remote_fields [Merge::Hris::Locations::LocationsListRequestRemoteFields] Deprecated. Use show_enum_origins.
       # @param remote_id [String] The API provider's ID for the given object.
-      # @param show_enum_origins [String] A comma separated list of enum field names for which you'd like the original
+      # @param show_enum_origins [Merge::Hris::Locations::LocationsListRequestShowEnumOrigins] A comma separated list of enum field names for which you'd like the original
       #  values to be returned, instead of Merge's normalized enum values. [Learn
       #  e](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
       # @param request_options [Merge::RequestOptions]
@@ -165,7 +184,7 @@ module Merge
       #  )
       #  api.hris.locations.list
       def list(created_after: nil, created_before: nil, cursor: nil, include_deleted_data: nil,
-               include_remote_data: nil, location_type: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, request_options: nil)
+               include_remote_data: nil, include_shell_data: nil, location_type: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, request_options: nil)
         Async do
           response = @request_client.conn.get do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -183,6 +202,7 @@ module Merge
               "cursor": cursor,
               "include_deleted_data": include_deleted_data,
               "include_remote_data": include_remote_data,
+              "include_shell_data": include_shell_data,
               "location_type": location_type,
               "modified_after": modified_after,
               "modified_before": modified_before,
@@ -205,8 +225,10 @@ module Merge
       # @param id [String]
       # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
-      # @param remote_fields [String] Deprecated. Use show_enum_origins.
-      # @param show_enum_origins [String] A comma separated list of enum field names for which you'd like the original
+      # @param include_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
+      # @param remote_fields [Merge::Hris::Locations::LocationsRetrieveRequestRemoteFields] Deprecated. Use show_enum_origins.
+      # @param show_enum_origins [Merge::Hris::Locations::LocationsRetrieveRequestShowEnumOrigins] A comma separated list of enum field names for which you'd like the original
       #  values to be returned, instead of Merge's normalized enum values. [Learn
       #  e](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
       # @param request_options [Merge::RequestOptions]
@@ -218,7 +240,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.hris.locations.retrieve(id: "id")
-      def retrieve(id:, include_remote_data: nil, remote_fields: nil, show_enum_origins: nil, request_options: nil)
+      def retrieve(id:, include_remote_data: nil, include_shell_data: nil, remote_fields: nil, show_enum_origins: nil,
+                   request_options: nil)
         Async do
           response = @request_client.conn.get do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -232,6 +255,7 @@ module Merge
             req.params = {
               **(request_options&.additional_query_parameters || {}),
               "include_remote_data": include_remote_data,
+              "include_shell_data": include_shell_data,
               "remote_fields": remote_fields,
               "show_enum_origins": show_enum_origins
             }.compact

data/lib/merge_ruby_client/hris/locations/types/locations_list_request_remote_fields.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Merge
+  module Hris
+    class Locations
+      class LocationsListRequestRemoteFields
+        COUNTRY = "country"
+        COUNTRY_LOCATION_TYPE = "country,location_type"
+        LOCATION_TYPE = "location_type"
+      end
+    end
+  end
+end

data/lib/merge_ruby_client/hris/locations/types/locations_list_request_show_enum_origins.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Merge
+  module Hris
+    class Locations
+      class LocationsListRequestShowEnumOrigins
+        COUNTRY = "country"
+        COUNTRY_LOCATION_TYPE = "country,location_type"
+        LOCATION_TYPE = "location_type"
+      end
+    end
+  end
+end

data/lib/merge_ruby_client/hris/locations/types/locations_retrieve_request_remote_fields.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Merge
+  module Hris
+    class Locations
+      class LocationsRetrieveRequestRemoteFields
+        COUNTRY = "country"
+        COUNTRY_LOCATION_TYPE = "country,location_type"
+        LOCATION_TYPE = "location_type"
+      end
+    end
+  end
+end

data/lib/merge_ruby_client/hris/locations/types/locations_retrieve_request_show_enum_origins.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Merge
+  module Hris
+    class Locations
+      class LocationsRetrieveRequestShowEnumOrigins
+        COUNTRY = "country"
+        COUNTRY_LOCATION_TYPE = "country,location_type"
+        LOCATION_TYPE = "location_type"
+      end
+    end
+  end
+end

data/lib/merge_ruby_client/hris/pay_groups/client.rb

@@ -23,9 +23,14 @@ module Merge
       # @param created_after [DateTime] If provided, will only return objects created after this datetime.
       # @param created_before [DateTime] If provided, will only return objects created before this datetime.
       # @param cursor [String] The pagination cursor value.
-      # @param include_deleted_data [Boolean] Whether to include data that was marked as deleted by third party webhooks.
+      # @param include_deleted_data [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 include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
+      # @param include_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
       # @param modified_after [DateTime] If provided, only objects synced by Merge after this date time will be returned.
       # @param modified_before [DateTime] If provided, only objects synced by Merge before this date time will be
       #  returned.
@@ -41,7 +46,7 @@ module Merge
       #  )
       #  api.hris.pay_groups.list
       def list(created_after: nil, created_before: nil, cursor: nil, include_deleted_data: nil,
-               include_remote_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_id: nil, request_options: nil)
+               include_remote_data: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_id: nil, request_options: nil)
         response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
@@ -58,6 +63,7 @@ module Merge
             "cursor": cursor,
             "include_deleted_data": include_deleted_data,
             "include_remote_data": include_remote_data,
+            "include_shell_data": include_shell_data,
             "modified_after": modified_after,
             "modified_before": modified_before,
             "page_size": page_size,
@@ -76,6 +82,8 @@ module Merge
       # @param id [String]
       # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
+      # @param include_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Hris::PayGroup]
       # @example
@@ -85,7 +93,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.hris.pay_groups.retrieve(id: "id")
-      def retrieve(id:, include_remote_data: nil, request_options: nil)
+      def retrieve(id:, include_remote_data: nil, include_shell_data: nil, request_options: nil)
         response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
@@ -97,7 +105,8 @@ module Merge
           }.compact
           req.params = {
             **(request_options&.additional_query_parameters || {}),
-            "include_remote_data": include_remote_data
+            "include_remote_data": include_remote_data,
+            "include_shell_data": include_shell_data
           }.compact
           unless request_options.nil? || request_options&.additional_body_parameters.nil?
             req.body = { **(request_options&.additional_body_parameters || {}) }.compact
@@ -123,9 +132,14 @@ module Merge
       # @param created_after [DateTime] If provided, will only return objects created after this datetime.
       # @param created_before [DateTime] If provided, will only return objects created before this datetime.
       # @param cursor [String] The pagination cursor value.
-      # @param include_deleted_data [Boolean] Whether to include data that was marked as deleted by third party webhooks.
+      # @param include_deleted_data [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 include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
+      # @param include_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
       # @param modified_after [DateTime] If provided, only objects synced by Merge after this date time will be returned.
       # @param modified_before [DateTime] If provided, only objects synced by Merge before this date time will be
       #  returned.
@@ -141,7 +155,7 @@ module Merge
       #  )
       #  api.hris.pay_groups.list
       def list(created_after: nil, created_before: nil, cursor: nil, include_deleted_data: nil,
-               include_remote_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_id: nil, request_options: nil)
+               include_remote_data: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_id: nil, request_options: nil)
         Async do
           response = @request_client.conn.get do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -159,6 +173,7 @@ module Merge
               "cursor": cursor,
               "include_deleted_data": include_deleted_data,
               "include_remote_data": include_remote_data,
+              "include_shell_data": include_shell_data,
               "modified_after": modified_after,
               "modified_before": modified_before,
               "page_size": page_size,
@@ -178,6 +193,8 @@ module Merge
       # @param id [String]
       # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
+      # @param include_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Hris::PayGroup]
       # @example
@@ -187,7 +204,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.hris.pay_groups.retrieve(id: "id")
-      def retrieve(id:, include_remote_data: nil, request_options: nil)
+      def retrieve(id:, include_remote_data: nil, include_shell_data: nil, request_options: nil)
         Async do
           response = @request_client.conn.get do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -200,7 +217,8 @@ module Merge
             }.compact
             req.params = {
               **(request_options&.additional_query_parameters || {}),
-              "include_remote_data": include_remote_data
+              "include_remote_data": include_remote_data,
+              "include_shell_data": include_shell_data
             }.compact
             unless request_options.nil? || request_options&.additional_body_parameters.nil?
               req.body = { **(request_options&.additional_body_parameters || {}) }.compact

data/lib/merge_ruby_client/hris/payroll_runs/client.rb

@@ -30,9 +30,14 @@ module Merge
       # @param cursor [String] The pagination cursor value.
       # @param ended_after [DateTime] If provided, will only return payroll runs ended after this datetime.
       # @param ended_before [DateTime] If provided, will only return payroll runs ended before this datetime.
-      # @param include_deleted_data [Boolean] Whether to include data that was marked as deleted by third party webhooks.
+      # @param include_deleted_data [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 include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
+      # @param include_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
       # @param modified_after [DateTime] If provided, only objects synced by Merge after this date time will be returned.
       # @param modified_before [DateTime] If provided, only objects synced by Merge before this date time will be
       #  returned.
@@ -41,11 +46,11 @@ module Merge
       # @param remote_id [String] The API provider's ID for the given object.
       # @param run_type [Merge::Hris::PayrollRuns::PayrollRunsListRequestRunType] If provided, will only return PayrollRun's with this status. Options:
       #  ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS')
-      #  - `REGULAR` - REGULAR
-      #  - `OFF_CYCLE` - OFF_CYCLE
-      #  - `CORRECTION` - CORRECTION
-      #  - `TERMINATION` - TERMINATION
-      #  - `SIGN_ON_BONUS` - SIGN_ON_BONUS
+      #  * `REGULAR` - REGULAR
+      #  * `OFF_CYCLE` - OFF_CYCLE
+      #  * `CORRECTION` - CORRECTION
+      #  * `TERMINATION` - TERMINATION
+      #  * `SIGN_ON_BONUS` - SIGN_ON_BONUS
       # @param show_enum_origins [Merge::Hris::PayrollRuns::PayrollRunsListRequestShowEnumOrigins] A comma separated list of enum field names for which you'd like the original
       #  values to be returned, instead of Merge's normalized enum values. [Learn
       #  e](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
@@ -61,7 +66,7 @@ module Merge
       #  )
       #  api.hris.payroll_runs.list
       def list(created_after: nil, created_before: nil, cursor: nil, ended_after: nil, ended_before: nil,
-               include_deleted_data: nil, include_remote_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_fields: nil, remote_id: nil, run_type: nil, show_enum_origins: nil, started_after: nil, started_before: nil, request_options: nil)
+               include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_fields: nil, remote_id: nil, run_type: nil, show_enum_origins: nil, started_after: nil, started_before: nil, request_options: nil)
         response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
@@ -80,6 +85,7 @@ module Merge
             "ended_before": ended_before,
             "include_deleted_data": include_deleted_data,
             "include_remote_data": include_remote_data,
+            "include_shell_data": include_shell_data,
             "modified_after": modified_after,
             "modified_before": modified_before,
             "page_size": page_size,
@@ -103,6 +109,8 @@ module Merge
       # @param id [String]
       # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
+      # @param include_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
       # @param remote_fields [Merge::Hris::PayrollRuns::PayrollRunsRetrieveRequestRemoteFields] Deprecated. Use show_enum_origins.
       # @param show_enum_origins [Merge::Hris::PayrollRuns::PayrollRunsRetrieveRequestShowEnumOrigins] A comma separated list of enum field names for which you'd like the original
       #  values to be returned, instead of Merge's normalized enum values. [Learn
@@ -116,7 +124,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.hris.payroll_runs.retrieve(id: "id")
-      def retrieve(id:, include_remote_data: nil, remote_fields: nil, show_enum_origins: nil, request_options: nil)
+      def retrieve(id:, include_remote_data: nil, include_shell_data: nil, remote_fields: nil, show_enum_origins: nil,
+                   request_options: nil)
         response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
@@ -129,6 +138,7 @@ module Merge
           req.params = {
             **(request_options&.additional_query_parameters || {}),
             "include_remote_data": include_remote_data,
+            "include_shell_data": include_shell_data,
             "remote_fields": remote_fields,
             "show_enum_origins": show_enum_origins
           }.compact
@@ -158,9 +168,14 @@ module Merge
       # @param cursor [String] The pagination cursor value.
       # @param ended_after [DateTime] If provided, will only return payroll runs ended after this datetime.
       # @param ended_before [DateTime] If provided, will only return payroll runs ended before this datetime.
-      # @param include_deleted_data [Boolean] Whether to include data that was marked as deleted by third party webhooks.
+      # @param include_deleted_data [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 include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
+      # @param include_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
       # @param modified_after [DateTime] If provided, only objects synced by Merge after this date time will be returned.
       # @param modified_before [DateTime] If provided, only objects synced by Merge before this date time will be
       #  returned.
@@ -169,11 +184,11 @@ module Merge
       # @param remote_id [String] The API provider's ID for the given object.
       # @param run_type [Merge::Hris::PayrollRuns::PayrollRunsListRequestRunType] If provided, will only return PayrollRun's with this status. Options:
       #  ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS')
-      #  - `REGULAR` - REGULAR
-      #  - `OFF_CYCLE` - OFF_CYCLE
-      #  - `CORRECTION` - CORRECTION
-      #  - `TERMINATION` - TERMINATION
-      #  - `SIGN_ON_BONUS` - SIGN_ON_BONUS
+      #  * `REGULAR` - REGULAR
+      #  * `OFF_CYCLE` - OFF_CYCLE
+      #  * `CORRECTION` - CORRECTION
+      #  * `TERMINATION` - TERMINATION
+      #  * `SIGN_ON_BONUS` - SIGN_ON_BONUS
       # @param show_enum_origins [Merge::Hris::PayrollRuns::PayrollRunsListRequestShowEnumOrigins] A comma separated list of enum field names for which you'd like the original
       #  values to be returned, instead of Merge's normalized enum values. [Learn
       #  e](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
@@ -189,7 +204,7 @@ module Merge
       #  )
       #  api.hris.payroll_runs.list
       def list(created_after: nil, created_before: nil, cursor: nil, ended_after: nil, ended_before: nil,
-               include_deleted_data: nil, include_remote_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_fields: nil, remote_id: nil, run_type: nil, show_enum_origins: nil, started_after: nil, started_before: nil, request_options: nil)
+               include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_fields: nil, remote_id: nil, run_type: nil, show_enum_origins: nil, started_after: nil, started_before: nil, request_options: nil)
         Async do
           response = @request_client.conn.get do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -209,6 +224,7 @@ module Merge
               "ended_before": ended_before,
               "include_deleted_data": include_deleted_data,
               "include_remote_data": include_remote_data,
+              "include_shell_data": include_shell_data,
               "modified_after": modified_after,
               "modified_before": modified_before,
               "page_size": page_size,
@@ -233,6 +249,8 @@ module Merge
       # @param id [String]
       # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
+      # @param include_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
       # @param remote_fields [Merge::Hris::PayrollRuns::PayrollRunsRetrieveRequestRemoteFields] Deprecated. Use show_enum_origins.
       # @param show_enum_origins [Merge::Hris::PayrollRuns::PayrollRunsRetrieveRequestShowEnumOrigins] A comma separated list of enum field names for which you'd like the original
       #  values to be returned, instead of Merge's normalized enum values. [Learn
@@ -246,7 +264,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.hris.payroll_runs.retrieve(id: "id")
-      def retrieve(id:, include_remote_data: nil, remote_fields: nil, show_enum_origins: nil, request_options: nil)
+      def retrieve(id:, include_remote_data: nil, include_shell_data: nil, remote_fields: nil, show_enum_origins: nil,
+                   request_options: nil)
         Async do
           response = @request_client.conn.get do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -260,6 +279,7 @@ module Merge
             req.params = {
               **(request_options&.additional_query_parameters || {}),
               "include_remote_data": include_remote_data,
+              "include_shell_data": include_shell_data,
               "remote_fields": remote_fields,
               "show_enum_origins": show_enum_origins
             }.compact

data/lib/merge_ruby_client/hris/scopes/client.rb

@@ -19,7 +19,7 @@ module Merge
 
       # Get the default permissions for Merge Common Models and fields across all Linked
       #  Accounts of a given category. [Learn
-      #  more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
+      #  more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
       #
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Hris::CommonModelScopeApi]
@@ -53,7 +53,7 @@ module Merge
 
       # Get all available permissions for Merge Common Models and fields for a single
       #  Linked Account. [Learn
-      #  more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
+      #  more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
       #
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Hris::CommonModelScopeApi]
@@ -87,14 +87,14 @@ module Merge
 
       # Update permissions for any Common Model or field for a single Linked Account.
       #  Any Scopes not set in this POST request will inherit the default Scopes. [Learn
-      #  more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes)
+      #  more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
       #
       # @param common_models [Array<Hash>] The common models you want to update the scopes forRequest of type Array<Merge::Hris::IndividualCommonModelScopeDeserializerRequest>, as a Hash
       #   * :model_name (String)
       #   * :model_permissions (Hash{String => Merge::Hris::ModelPermissionDeserializerRequest})
       #   * :field_permissions (Hash)
-      #     * :enabled (Array<Object>)
-      #     * :disabled (Array<Object>)
+      #     * :enabled_fields (Array<Object>)
+      #     * :disabled_fields (Array<Object>)
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Hris::CommonModelScopeApi]
       # @example
@@ -103,7 +103,7 @@ module Merge
       #    environment: Merge::Environment::PRODUCTION,
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
-      #  api.hris.scopes.linked_account_scopes_create(common_models: [{ model_name: "Employee", model_permissions: { "READ": { is_enabled: true }, "WRITE": { is_enabled: false } } }, { model_name: "Benefit", model_permissions: { "WRITE": { is_enabled: false } } }])
+      #  api.hris.scopes.linked_account_scopes_create(common_models: [{ model_name: "Employee", model_permissions: { "READ": { is_enabled: true }, "WRITE": { is_enabled: false } }, field_permissions: { enabled_fields: ["avatar", "home_location"], disabled_fields: ["work_location"] } }, { model_name: "Benefit", model_permissions: { "WRITE": { is_enabled: false } } }])
       def linked_account_scopes_create(common_models:, request_options: nil)
         response = @request_client.conn.post do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -136,7 +136,7 @@ module Merge
 
       # Get the default permissions for Merge Common Models and fields across all Linked
       #  Accounts of a given category. [Learn
-      #  more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
+      #  more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
       #
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Hris::CommonModelScopeApi]
@@ -172,7 +172,7 @@ module Merge
 
       # Get all available permissions for Merge Common Models and fields for a single
       #  Linked Account. [Learn
-      #  more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
+      #  more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
       #
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Hris::CommonModelScopeApi]
@@ -208,14 +208,14 @@ module Merge
 
       # Update permissions for any Common Model or field for a single Linked Account.
       #  Any Scopes not set in this POST request will inherit the default Scopes. [Learn
-      #  more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes)
+      #  more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
       #
       # @param common_models [Array<Hash>] The common models you want to update the scopes forRequest of type Array<Merge::Hris::IndividualCommonModelScopeDeserializerRequest>, as a Hash
       #   * :model_name (String)
       #   * :model_permissions (Hash{String => Merge::Hris::ModelPermissionDeserializerRequest})
       #   * :field_permissions (Hash)
-      #     * :enabled (Array<Object>)
-      #     * :disabled (Array<Object>)
+      #     * :enabled_fields (Array<Object>)
+      #     * :disabled_fields (Array<Object>)
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Hris::CommonModelScopeApi]
       # @example
@@ -224,7 +224,7 @@ module Merge
       #    environment: Merge::Environment::PRODUCTION,
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
-      #  api.hris.scopes.linked_account_scopes_create(common_models: [{ model_name: "Employee", model_permissions: { "READ": { is_enabled: true }, "WRITE": { is_enabled: false } } }, { model_name: "Benefit", model_permissions: { "WRITE": { is_enabled: false } } }])
+      #  api.hris.scopes.linked_account_scopes_create(common_models: [{ model_name: "Employee", model_permissions: { "READ": { is_enabled: true }, "WRITE": { is_enabled: false } }, field_permissions: { enabled_fields: ["avatar", "home_location"], disabled_fields: ["work_location"] } }, { model_name: "Benefit", model_permissions: { "WRITE": { is_enabled: false } } }])
       def linked_account_scopes_create(common_models:, request_options: nil)
         Async do
           response = @request_client.conn.post do |req|

data/lib/merge_ruby_client/hris/sync_status/client.rb

@@ -16,9 +16,16 @@ module Merge
         @request_client = request_client
       end
 
-      # Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`,
-      #  `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our
-      #  [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
+      # Get sync status for the current sync and the most recently finished sync.
+      #  `last_sync_start` represents the most recent time any sync began.
+      #  `last_sync_finished` represents the most recent time any sync completed. These
+      #  timestamps may correspond to different sync instances which may result in a sync
+      #  start time being later than a separate sync completed time. To ensure you are
+      #  retrieving the latest available data reference the `last_sync_finished`
+      #  timestamp where `last_sync_result` is `DONE`. Possible values for `status` and
+      #  `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`,
+      #  `PAUSED`, `SYNCING`. Learn more about sync status in our [Help
+      #  Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
       #
       # @param cursor [String] The pagination cursor value.
       # @param page_size [Integer] Number of results to return per page.
@@ -65,9 +72,16 @@ module Merge
         @request_client = request_client
       end
 
-      # Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`,
-      #  `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our
-      #  [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
+      # Get sync status for the current sync and the most recently finished sync.
+      #  `last_sync_start` represents the most recent time any sync began.
+      #  `last_sync_finished` represents the most recent time any sync completed. These
+      #  timestamps may correspond to different sync instances which may result in a sync
+      #  start time being later than a separate sync completed time. To ensure you are
+      #  retrieving the latest available data reference the `last_sync_finished`
+      #  timestamp where `last_sync_result` is `DONE`. Possible values for `status` and
+      #  `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`,
+      #  `PAUSED`, `SYNCING`. Learn more about sync status in our [Help
+      #  Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
       #
       # @param cursor [String] The pagination cursor value.
       # @param page_size [Integer] Number of results to return per page.