merge_ruby_client 1.0.0 → 2.0.0

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

@@ -37,9 +37,9 @@ module Merge
       # @param cursor [String] The pagination cursor value.
       # @param display_full_name [String] If provided, will only return employees with this display name.
       # @param employment_status [Merge::Hris::Employees::EmployeesListRequestEmploymentStatus] If provided, will only return employees with this employment status.
-      #  - `ACTIVE` - ACTIVE
-      #  - `PENDING` - PENDING
-      #  - `INACTIVE` - INACTIVE
+      #  * `ACTIVE` - ACTIVE
+      #  * `PENDING` - PENDING
+      #  * `INACTIVE` - INACTIVE
       # @param employment_type [String] If provided, will only return employees that have an employment of the specified
       #  employment_type.
       # @param expand [Merge::Hris::Employees::EmployeesListRequestExpand] Which relations should be returned in expanded form. Multiple relation names
@@ -219,6 +219,8 @@ module Merge
       #  produce these models.
       # @param include_sensitive_fields [Boolean] Whether to include sensitive fields (such as social security numbers) in the
       #  response.
+      # @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::Employees::EmployeesRetrieveRequestRemoteFields] Deprecated. Use show_enum_origins.
       # @param show_enum_origins [Merge::Hris::Employees::EmployeesRetrieveRequestShowEnumOrigins] 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
@@ -232,8 +234,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.hris.employees.retrieve(id: "id")
-      def retrieve(id:, expand: nil, include_remote_data: nil, include_sensitive_fields: nil, remote_fields: nil,
-                   show_enum_origins: nil, request_options: nil)
+      def retrieve(id:, expand: nil, include_remote_data: nil, include_sensitive_fields: 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?
@@ -248,6 +250,7 @@ module Merge
             "expand": expand,
             "include_remote_data": include_remote_data,
             "include_sensitive_fields": include_sensitive_fields,
+            "include_shell_data": include_shell_data,
             "remote_fields": remote_fields,
             "show_enum_origins": show_enum_origins
           }.compact
@@ -345,9 +348,9 @@ module Merge
       # @param cursor [String] The pagination cursor value.
       # @param display_full_name [String] If provided, will only return employees with this display name.
       # @param employment_status [Merge::Hris::Employees::EmployeesListRequestEmploymentStatus] If provided, will only return employees with this employment status.
-      #  - `ACTIVE` - ACTIVE
-      #  - `PENDING` - PENDING
-      #  - `INACTIVE` - INACTIVE
+      #  * `ACTIVE` - ACTIVE
+      #  * `PENDING` - PENDING
+      #  * `INACTIVE` - INACTIVE
       # @param employment_type [String] If provided, will only return employees that have an employment of the specified
       #  employment_type.
       # @param expand [Merge::Hris::Employees::EmployeesListRequestExpand] Which relations should be returned in expanded form. Multiple relation names
@@ -531,6 +534,8 @@ module Merge
       #  produce these models.
       # @param include_sensitive_fields [Boolean] Whether to include sensitive fields (such as social security numbers) in the
       #  response.
+      # @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::Employees::EmployeesRetrieveRequestRemoteFields] Deprecated. Use show_enum_origins.
       # @param show_enum_origins [Merge::Hris::Employees::EmployeesRetrieveRequestShowEnumOrigins] 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
@@ -544,8 +549,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.hris.employees.retrieve(id: "id")
-      def retrieve(id:, expand: nil, include_remote_data: nil, include_sensitive_fields: nil, remote_fields: nil,
-                   show_enum_origins: nil, request_options: nil)
+      def retrieve(id:, expand: nil, include_remote_data: nil, include_sensitive_fields: 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?
@@ -561,6 +566,7 @@ module Merge
               "expand": expand,
               "include_remote_data": include_remote_data,
               "include_sensitive_fields": include_sensitive_fields,
+              "include_shell_data": include_shell_data,
               "remote_fields": remote_fields,
               "show_enum_origins": show_enum_origins
             }.compact

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

@@ -82,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::EmployerBenefit]
       # @example
@@ -91,7 +93,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.hris.employer_benefits.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?
@@ -103,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
@@ -190,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::EmployerBenefit]
       # @example
@@ -199,7 +204,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.hris.employer_benefits.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?
@@ -212,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/employments/client.rb

@@ -105,6 +105,8 @@ module Merge
       #  should be comma separated without spaces.
       # @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::Employments::EmploymentsRetrieveRequestRemoteFields] Deprecated. Use show_enum_origins.
       # @param show_enum_origins [Merge::Hris::Employments::EmploymentsRetrieveRequestShowEnumOrigins] 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
@@ -118,8 +120,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.hris.employments.retrieve(id: "id")
-      def retrieve(id:, expand: nil, include_remote_data: nil, remote_fields: nil, show_enum_origins: nil,
-                   request_options: nil)
+      def retrieve(id:, expand: nil, 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?
@@ -133,6 +135,7 @@ module Merge
             **(request_options&.additional_query_parameters || {}),
             "expand": expand,
             "include_remote_data": include_remote_data,
+            "include_shell_data": include_shell_data,
             "remote_fields": remote_fields,
             "show_enum_origins": show_enum_origins
           }.compact
@@ -237,6 +240,8 @@ module Merge
       #  should be comma separated without spaces.
       # @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::Employments::EmploymentsRetrieveRequestRemoteFields] Deprecated. Use show_enum_origins.
       # @param show_enum_origins [Merge::Hris::Employments::EmploymentsRetrieveRequestShowEnumOrigins] 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
@@ -250,8 +255,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.hris.employments.retrieve(id: "id")
-      def retrieve(id:, expand: nil, include_remote_data: nil, remote_fields: nil, show_enum_origins: nil,
-                   request_options: nil)
+      def retrieve(id:, expand: nil, 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?
@@ -266,6 +271,7 @@ module Merge
               **(request_options&.additional_query_parameters || {}),
               "expand": expand,
               "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/force_resync/client.rb

@@ -17,11 +17,11 @@ module Merge
         @request_client = request_client
       end
 
-      # Force re-sync of all models. This is available for all organizations via the
-      #  dashboard. Force re-sync is also available programmatically via API for monthly,
-      #  quarterly, and highest sync frequency customers on the Professional or
-      #  Enterprise plans. Doing so will consume a sync credit for the relevant linked
-      #  account.
+      # Force re-sync of all models. This endpoint is available for monthly, quarterly,
+      #  and highest sync frequency customers on the Professional or Enterprise plans.
+      #  Doing so will consume a sync credit for the relevant linked account. Force
+      #  re-syncs can also be triggered manually in the Merge Dashboard and is available
+      #  for all customers.
       #
       # @param request_options [Merge::RequestOptions]
       # @return [Array<Merge::Hris::SyncStatus>]
@@ -68,11 +68,11 @@ module Merge
         @request_client = request_client
       end
 
-      # Force re-sync of all models. This is available for all organizations via the
-      #  dashboard. Force re-sync is also available programmatically via API for monthly,
-      #  quarterly, and highest sync frequency customers on the Professional or
-      #  Enterprise plans. Doing so will consume a sync credit for the relevant linked
-      #  account.
+      # Force re-sync of all models. This endpoint is available for monthly, quarterly,
+      #  and highest sync frequency customers on the Professional or Enterprise plans.
+      #  Doing so will consume a sync credit for the relevant linked account. Force
+      #  re-syncs can also be triggered manually in the Merge Dashboard and is available
+      #  for all customers.
       #
       # @param request_options [Merge::RequestOptions]
       # @return [Array<Merge::Hris::SyncStatus>]

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

@@ -98,6 +98,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 [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
       #  values to be returned, instead of Merge's normalized enum values. [Learn
@@ -111,7 +113,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.hris.groups.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?
@@ -124,6 +127,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
@@ -228,6 +232,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 [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
       #  values to be returned, instead of Merge's normalized enum values. [Learn
@@ -241,7 +247,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.hris.groups.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?
@@ -255,6 +262,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/issues/client.rb

@@ -42,8 +42,8 @@ module Merge
       # @param start_date [String] If included, will only include issues whose most recent action occurred after
       #  this time
       # @param status [Merge::Hris::Issues::IssuesListRequestStatus] Status of the issue. Options: ('ONGOING', 'RESOLVED')
-      #  - `ONGOING` - ONGOING
-      #  - `RESOLVED` - RESOLVED
+      #  * `ONGOING` - ONGOING
+      #  * `RESOLVED` - RESOLVED
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Hris::PaginatedIssueList]
       # @example
@@ -156,8 +156,8 @@ module Merge
       # @param start_date [String] If included, will only include issues whose most recent action occurred after
       #  this time
       # @param status [Merge::Hris::Issues::IssuesListRequestStatus] Status of the issue. Options: ('ONGOING', 'RESOLVED')
-      #  - `ONGOING` - ONGOING
-      #  - `RESOLVED` - RESOLVED
+      #  * `ONGOING` - ONGOING
+      #  * `RESOLVED` - RESOLVED
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Hris::PaginatedIssueList]
       # @example

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

@@ -20,13 +20,13 @@ module Merge
       # List linked accounts for your organization.
       #
       # @param category [Merge::Hris::LinkedAccounts::LinkedAccountsListRequestCategory] Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-      #  - `hris` - hris
-      #  - `ats` - ats
-      #  - `accounting` - accounting
-      #  - `ticketing` - ticketing
-      #  - `crm` - crm
-      #  - `mktg` - mktg
-      #  - `filestorage` - filestorage
+      #  * `hris` - hris
+      #  * `ats` - ats
+      #  * `accounting` - accounting
+      #  * `ticketing` - ticketing
+      #  * `crm` - crm
+      #  * `mktg` - mktg
+      #  * `filestorage` - filestorage
       # @param cursor [String] The pagination cursor value.
       # @param end_user_email_address [String] If provided, will only return linked accounts associated with the given email
       #  address.
@@ -106,13 +106,13 @@ module Merge
       # List linked accounts for your organization.
       #
       # @param category [Merge::Hris::LinkedAccounts::LinkedAccountsListRequestCategory] Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-      #  - `hris` - hris
-      #  - `ats` - ats
-      #  - `accounting` - accounting
-      #  - `ticketing` - ticketing
-      #  - `crm` - crm
-      #  - `mktg` - mktg
-      #  - `filestorage` - filestorage
+      #  * `hris` - hris
+      #  * `ats` - ats
+      #  * `accounting` - accounting
+      #  * `ticketing` - ticketing
+      #  * `crm` - crm
+      #  * `mktg` - mktg
+      #  * `filestorage` - filestorage
       # @param cursor [String] The pagination cursor value.
       # @param end_user_email_address [String] If provided, will only return linked accounts associated with the given email
       #  address.

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

@@ -37,8 +37,8 @@ module Merge
       # @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.
@@ -97,6 +97,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::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
@@ -110,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?
@@ -123,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
@@ -159,8 +163,8 @@ module Merge
       # @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.
@@ -221,6 +225,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::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
@@ -234,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?
@@ -248,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/pay_groups/client.rb

@@ -82,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
@@ -91,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?
@@ -103,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
@@ -190,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
@@ -199,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?
@@ -212,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

@@ -46,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)
@@ -109,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
@@ -122,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?
@@ -135,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
@@ -180,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)
@@ -245,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
@@ -258,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?
@@ -272,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/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.