merge_ruby_client 0.1.4 → 1.1.0

data/lib/merge_ruby_client/ats/types/screening_question_type_enum.rb

@@ -2,14 +2,14 @@
 
 module Merge
   module Ats
-    # - `DATE` - DATE
-    #  - `FILE` - FILE
-    #  - `SINGLE_SELECT` - SINGLE_SELECT
-    #  - `MULTI_SELECT` - MULTI_SELECT
-    #  - `SINGLE_LINE_TEXT` - SINGLE_LINE_TEXT
-    #  - `MULTI_LINE_TEXT` - MULTI_LINE_TEXT
-    #  - `NUMERIC` - NUMERIC
-    #  - `BOOLEAN` - BOOLEAN
+    # * `DATE` - DATE
+    #  * `FILE` - FILE
+    #  * `SINGLE_SELECT` - SINGLE_SELECT
+    #  * `MULTI_SELECT` - MULTI_SELECT
+    #  * `SINGLE_LINE_TEXT` - SINGLE_LINE_TEXT
+    #  * `MULTI_LINE_TEXT` - MULTI_LINE_TEXT
+    #  * `NUMERIC` - NUMERIC
+    #  * `BOOLEAN` - BOOLEAN
     class ScreeningQuestionTypeEnum
       DATE = "DATE"
       FILE = "FILE"

data/lib/merge_ruby_client/ats/types/selective_sync_configurations_usage_enum.rb

@@ -2,8 +2,8 @@
 
 module Merge
   module Ats
-    # - `IN_NEXT_SYNC` - IN_NEXT_SYNC
-    #  - `IN_LAST_SYNC` - IN_LAST_SYNC
+    # * `IN_NEXT_SYNC` - IN_NEXT_SYNC
+    #  * `IN_LAST_SYNC` - IN_LAST_SYNC
     class SelectiveSyncConfigurationsUsageEnum
       IN_NEXT_SYNC = "IN_NEXT_SYNC"
       IN_LAST_SYNC = "IN_LAST_SYNC"

data/lib/merge_ruby_client/ats/types/status_fd_5_enum.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Merge
+  module Ats
+    # * `SYNCING` - SYNCING
+    #  * `DONE` - DONE
+    #  * `FAILED` - FAILED
+    #  * `DISABLED` - DISABLED
+    #  * `PAUSED` - PAUSED
+    #  * `PARTIALLY_SYNCED` - PARTIALLY_SYNCED
+    class StatusFd5Enum
+      SYNCING = "SYNCING"
+      DONE = "DONE"
+      FAILED = "FAILED"
+      DISABLED = "DISABLED"
+      PAUSED = "PAUSED"
+      PARTIALLY_SYNCED = "PARTIALLY_SYNCED"
+    end
+  end
+end

data/lib/merge_ruby_client/ats/types/sync_status.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 require "date"
-require_relative "sync_status_status_enum"
+require_relative "last_sync_result_enum"
+require_relative "status_fd_5_enum"
 require_relative "selective_sync_configurations_usage_enum"
 require "ostruct"
 require "json"
@@ -22,7 +23,11 @@ module Merge
       attr_reader :last_sync_start
       # @return [DateTime]
       attr_reader :next_sync_start
-      # @return [Merge::Ats::SyncStatusStatusEnum]
+      # @return [Merge::Ats::LastSyncResultEnum]
+      attr_reader :last_sync_result
+      # @return [DateTime]
+      attr_reader :last_sync_finished
+      # @return [Merge::Ats::StatusFd5Enum]
       attr_reader :status
       # @return [Boolean]
       attr_reader :is_initial_sync
@@ -40,17 +45,21 @@ module Merge
       # @param model_id [String]
       # @param last_sync_start [DateTime]
       # @param next_sync_start [DateTime]
-      # @param status [Merge::Ats::SyncStatusStatusEnum]
+      # @param last_sync_result [Merge::Ats::LastSyncResultEnum]
+      # @param last_sync_finished [DateTime]
+      # @param status [Merge::Ats::StatusFd5Enum]
       # @param is_initial_sync [Boolean]
       # @param selective_sync_configurations_usage [Merge::Ats::SelectiveSyncConfigurationsUsageEnum]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Merge::Ats::SyncStatus]
-      def initialize(model_name:, model_id:, status:, is_initial_sync:, last_sync_start: OMIT, next_sync_start: OMIT,
-                     selective_sync_configurations_usage: OMIT, additional_properties: nil)
+      def initialize(model_name:, model_id:, status:, is_initial_sync:, last_sync_start: OMIT, next_sync_start: OMIT, last_sync_result: OMIT,
+                     last_sync_finished: OMIT, selective_sync_configurations_usage: OMIT, additional_properties: nil)
         @model_name = model_name
         @model_id = model_id
         @last_sync_start = last_sync_start if last_sync_start != OMIT
         @next_sync_start = next_sync_start if next_sync_start != OMIT
+        @last_sync_result = last_sync_result if last_sync_result != OMIT
+        @last_sync_finished = last_sync_finished if last_sync_finished != OMIT
         @status = status
         @is_initial_sync = is_initial_sync
         if selective_sync_configurations_usage != OMIT
@@ -62,6 +71,8 @@ module Merge
           "model_id": model_id,
           "last_sync_start": last_sync_start,
           "next_sync_start": next_sync_start,
+          "last_sync_result": last_sync_result,
+          "last_sync_finished": last_sync_finished,
           "status": status,
           "is_initial_sync": is_initial_sync,
           "selective_sync_configurations_usage": selective_sync_configurations_usage
@@ -81,6 +92,10 @@ module Merge
         model_id = parsed_json["model_id"]
         last_sync_start = (DateTime.parse(parsed_json["last_sync_start"]) unless parsed_json["last_sync_start"].nil?)
         next_sync_start = (DateTime.parse(parsed_json["next_sync_start"]) unless parsed_json["next_sync_start"].nil?)
+        last_sync_result = parsed_json["last_sync_result"]
+        last_sync_finished = unless parsed_json["last_sync_finished"].nil?
+                               DateTime.parse(parsed_json["last_sync_finished"])
+                             end
         status = parsed_json["status"]
         is_initial_sync = parsed_json["is_initial_sync"]
         selective_sync_configurations_usage = parsed_json["selective_sync_configurations_usage"]
@@ -89,6 +104,8 @@ module Merge
           model_id: model_id,
           last_sync_start: last_sync_start,
           next_sync_start: next_sync_start,
+          last_sync_result: last_sync_result,
+          last_sync_finished: last_sync_finished,
           status: status,
           is_initial_sync: is_initial_sync,
           selective_sync_configurations_usage: selective_sync_configurations_usage,
@@ -114,7 +131,9 @@ module Merge
         obj.model_id.is_a?(String) != false || raise("Passed value for field obj.model_id is not the expected type, validation failed.")
         obj.last_sync_start&.is_a?(DateTime) != false || raise("Passed value for field obj.last_sync_start is not the expected type, validation failed.")
         obj.next_sync_start&.is_a?(DateTime) != false || raise("Passed value for field obj.next_sync_start is not the expected type, validation failed.")
-        obj.status.is_a?(Merge::Ats::SyncStatusStatusEnum) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+        obj.last_sync_result&.is_a?(Merge::Ats::LastSyncResultEnum) != false || raise("Passed value for field obj.last_sync_result is not the expected type, validation failed.")
+        obj.last_sync_finished&.is_a?(DateTime) != false || raise("Passed value for field obj.last_sync_finished is not the expected type, validation failed.")
+        obj.status.is_a?(Merge::Ats::StatusFd5Enum) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
         obj.is_initial_sync.is_a?(Boolean) != false || raise("Passed value for field obj.is_initial_sync is not the expected type, validation failed.")
         obj.selective_sync_configurations_usage&.is_a?(Merge::Ats::SelectiveSyncConfigurationsUsageEnum) != false || raise("Passed value for field obj.selective_sync_configurations_usage is not the expected type, validation failed.")
       end

data/lib/merge_ruby_client/ats/types/tag.rb

@@ -21,7 +21,9 @@ module Merge
       # @return [String] The tag's name.
       attr_reader :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
@@ -40,7 +42,9 @@ module Merge
       # @param modified_at [DateTime] The datetime that this object was modified by Merge.
       # @param name [String] The tag's 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<Hash{String => Object}>]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition

data/lib/merge_ruby_client/ats/types/url.rb

@@ -21,16 +21,18 @@ module Merge
       # @return [String] The site's url.
       attr_reader :value
       # @return [Merge::Ats::UrlTypeEnum] The type of site.
-      #  - `PERSONAL` - PERSONAL
-      #  - `COMPANY` - COMPANY
-      #  - `PORTFOLIO` - PORTFOLIO
-      #  - `BLOG` - BLOG
-      #  - `SOCIAL_MEDIA` - SOCIAL_MEDIA
-      #  - `OTHER` - OTHER
-      #  - `JOB_POSTING` - JOB_POSTING
+      #  * `PERSONAL` - PERSONAL
+      #  * `COMPANY` - COMPANY
+      #  * `PORTFOLIO` - PORTFOLIO
+      #  * `BLOG` - BLOG
+      #  * `SOCIAL_MEDIA` - SOCIAL_MEDIA
+      #  * `OTHER` - OTHER
+      #  * `JOB_POSTING` - JOB_POSTING
       attr_reader :url_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 [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
@@ -44,15 +46,17 @@ module Merge
       # @param modified_at [DateTime] The datetime that this object was modified by Merge.
       # @param value [String] The site's url.
       # @param url_type [Merge::Ats::UrlTypeEnum] The type of site.
-      #  - `PERSONAL` - PERSONAL
-      #  - `COMPANY` - COMPANY
-      #  - `PORTFOLIO` - PORTFOLIO
-      #  - `BLOG` - BLOG
-      #  - `SOCIAL_MEDIA` - SOCIAL_MEDIA
-      #  - `OTHER` - OTHER
-      #  - `JOB_POSTING` - JOB_POSTING
+      #  * `PERSONAL` - PERSONAL
+      #  * `COMPANY` - COMPANY
+      #  * `PORTFOLIO` - PORTFOLIO
+      #  * `BLOG` - BLOG
+      #  * `SOCIAL_MEDIA` - SOCIAL_MEDIA
+      #  * `OTHER` - OTHER
+      #  * `JOB_POSTING` - JOB_POSTING
       # @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 additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Merge::Ats::Url]
       def initialize(created_at: OMIT, modified_at: OMIT, value: OMIT, url_type: OMIT, remote_was_deleted: OMIT,

data/lib/merge_ruby_client/ats/types/url_request.rb

@@ -16,13 +16,13 @@ module Merge
       # @return [String] The site's url.
       attr_reader :value
       # @return [Merge::Ats::UrlTypeEnum] The type of site.
-      #  - `PERSONAL` - PERSONAL
-      #  - `COMPANY` - COMPANY
-      #  - `PORTFOLIO` - PORTFOLIO
-      #  - `BLOG` - BLOG
-      #  - `SOCIAL_MEDIA` - SOCIAL_MEDIA
-      #  - `OTHER` - OTHER
-      #  - `JOB_POSTING` - JOB_POSTING
+      #  * `PERSONAL` - PERSONAL
+      #  * `COMPANY` - COMPANY
+      #  * `PORTFOLIO` - PORTFOLIO
+      #  * `BLOG` - BLOG
+      #  * `SOCIAL_MEDIA` - SOCIAL_MEDIA
+      #  * `OTHER` - OTHER
+      #  * `JOB_POSTING` - JOB_POSTING
       attr_reader :url_type
       # @return [Hash{String => Object}]
       attr_reader :integration_params
@@ -38,13 +38,13 @@ module Merge
 
       # @param value [String] The site's url.
       # @param url_type [Merge::Ats::UrlTypeEnum] The type of site.
-      #  - `PERSONAL` - PERSONAL
-      #  - `COMPANY` - COMPANY
-      #  - `PORTFOLIO` - PORTFOLIO
-      #  - `BLOG` - BLOG
-      #  - `SOCIAL_MEDIA` - SOCIAL_MEDIA
-      #  - `OTHER` - OTHER
-      #  - `JOB_POSTING` - JOB_POSTING
+      #  * `PERSONAL` - PERSONAL
+      #  * `COMPANY` - COMPANY
+      #  * `PORTFOLIO` - PORTFOLIO
+      #  * `BLOG` - BLOG
+      #  * `SOCIAL_MEDIA` - SOCIAL_MEDIA
+      #  * `OTHER` - OTHER
+      #  * `JOB_POSTING` - JOB_POSTING
       # @param integration_params [Hash{String => Object}]
       # @param linked_account_params [Hash{String => Object}]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition

data/lib/merge_ruby_client/ats/types/url_type_enum.rb

@@ -2,13 +2,13 @@
 
 module Merge
   module Ats
-    # - `PERSONAL` - PERSONAL
-    #  - `COMPANY` - COMPANY
-    #  - `PORTFOLIO` - PORTFOLIO
-    #  - `BLOG` - BLOG
-    #  - `SOCIAL_MEDIA` - SOCIAL_MEDIA
-    #  - `OTHER` - OTHER
-    #  - `JOB_POSTING` - JOB_POSTING
+    # * `PERSONAL` - PERSONAL
+    #  * `COMPANY` - COMPANY
+    #  * `PORTFOLIO` - PORTFOLIO
+    #  * `BLOG` - BLOG
+    #  * `SOCIAL_MEDIA` - SOCIAL_MEDIA
+    #  * `OTHER` - OTHER
+    #  * `JOB_POSTING` - JOB_POSTING
     class UrlTypeEnum
       PERSONAL = "PERSONAL"
       COMPANY = "COMPANY"

data/lib/merge_ruby_client/ats/types/veteran_status_enum.rb

@@ -2,10 +2,10 @@
 
 module Merge
   module Ats
-    # - `I_AM_NOT_A_PROTECTED_VETERAN` - I_AM_NOT_A_PROTECTED_VETERAN
-    #  - `I_IDENTIFY_AS_ONE_OR_MORE_OF_THE_CLASSIFICATIONS_OF_A_PROTECTED_VETERAN` -
+    # * `I_AM_NOT_A_PROTECTED_VETERAN` - I_AM_NOT_A_PROTECTED_VETERAN
+    #  * `I_IDENTIFY_AS_ONE_OR_MORE_OF_THE_CLASSIFICATIONS_OF_A_PROTECTED_VETERAN` -
     #  I_IDENTIFY_AS_ONE_OR_MORE_OF_THE_CLASSIFICATIONS_OF_A_PROTECTED_VETERAN
-    #  - `I_DONT_WISH_TO_ANSWER` - I_DONT_WISH_TO_ANSWER
+    #  * `I_DONT_WISH_TO_ANSWER` - I_DONT_WISH_TO_ANSWER
     class VeteranStatusEnum
       I_AM_NOT_A_PROTECTED_VETERAN = "I_AM_NOT_A_PROTECTED_VETERAN"
       I_IDENTIFY_AS_ONE_OR_MORE_OF_THE_CLASSIFICATIONS_OF_A_PROTECTED_VETERAN = "I_IDENTIFY_AS_ONE_OR_MORE_OF_THE_CLASSIFICATIONS_OF_A_PROTECTED_VETERAN"

data/lib/merge_ruby_client/ats/types/visibility_enum.rb

@@ -2,9 +2,9 @@
 
 module Merge
   module Ats
-    # - `ADMIN_ONLY` - ADMIN_ONLY
-    #  - `PUBLIC` - PUBLIC
-    #  - `PRIVATE` - PRIVATE
+    # * `ADMIN_ONLY` - ADMIN_ONLY
+    #  * `PUBLIC` - PUBLIC
+    #  * `PRIVATE` - PRIVATE
     class VisibilityEnum
       ADMIN_ONLY = "ADMIN_ONLY"
       PUBLIC = "PUBLIC"

data/lib/merge_ruby_client/ats/users/client.rb

@@ -24,9 +24,14 @@ module Merge
       # @param created_before [DateTime] If provided, will only return objects created before this datetime.
       # @param cursor [String] The pagination cursor value.
       # @param email [String] If provided, will only return remote users with the given email address
-      # @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.
@@ -46,7 +51,7 @@ module Merge
       #  )
       #  api.ats.users.list
       def list(created_after: nil, created_before: nil, cursor: nil, email: nil, include_deleted_data: nil,
-               include_remote_data: 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, 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?
@@ -64,6 +69,7 @@ module Merge
             "email": email,
             "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,
@@ -84,6 +90,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
@@ -97,7 +105,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.ats.users.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?
@@ -110,6 +119,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
@@ -138,9 +148,14 @@ module Merge
       # @param created_before [DateTime] If provided, will only return objects created before this datetime.
       # @param cursor [String] The pagination cursor value.
       # @param email [String] If provided, will only return remote users with the given email address
-      # @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.
@@ -160,7 +175,7 @@ module Merge
       #  )
       #  api.ats.users.list
       def list(created_after: nil, created_before: nil, cursor: nil, email: nil, include_deleted_data: nil,
-               include_remote_data: 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, 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?
@@ -179,6 +194,7 @@ module Merge
               "email": email,
               "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,
@@ -200,6 +216,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
@@ -213,7 +231,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.ats.users.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?
@@ -227,6 +246,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/crm/accounts/client.rb

@@ -30,11 +30,16 @@ module Merge
       # @param cursor [String] The pagination cursor value.
       # @param expand [String] Which relations should be returned in expanded form. Multiple relation names
       #  should be comma separated without spaces.
-      # @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_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to
       #  common models, in a normalized format.
+      # @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.
@@ -52,7 +57,7 @@ module Merge
       #  )
       #  api.crm.accounts.list
       def list(created_after: nil, created_before: nil, cursor: nil, expand: nil, include_deleted_data: nil,
-               include_remote_data: nil, include_remote_fields: nil, modified_after: nil, modified_before: nil, name: nil, owner_id: nil, page_size: nil, remote_id: nil, request_options: nil)
+               include_remote_data: nil, include_remote_fields: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, name: nil, owner_id: 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?
@@ -71,6 +76,7 @@ module Merge
             "include_deleted_data": include_deleted_data,
             "include_remote_data": include_remote_data,
             "include_remote_fields": include_remote_fields,
+            "include_shell_data": include_shell_data,
             "modified_after": modified_after,
             "modified_before": modified_before,
             "name": name,
@@ -141,6 +147,8 @@ module Merge
       #  produce these models.
       # @param include_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to
       #  common models, in a normalized format.
+      # @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::Crm::Account]
       # @example
@@ -150,7 +158,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.crm.accounts.retrieve(id: "id")
-      def retrieve(id:, expand: nil, include_remote_data: nil, include_remote_fields: nil, request_options: nil)
+      def retrieve(id:, expand: nil, include_remote_data: nil, include_remote_fields: 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?
@@ -164,7 +173,8 @@ module Merge
             **(request_options&.additional_query_parameters || {}),
             "expand": expand,
             "include_remote_data": include_remote_data,
-            "include_remote_fields": include_remote_fields
+            "include_remote_fields": include_remote_fields,
+            "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
@@ -289,11 +299,16 @@ module Merge
       # Returns a list of `RemoteFieldClass` objects.
       #
       # @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_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to
       #  common models, in a normalized format.
+      # @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 is_common_model_field [Boolean] If provided, will only return remote field classes with this
       #  is_common_model_field value
       # @param page_size [Integer] Number of results to return per page.
@@ -307,7 +322,7 @@ module Merge
       #  )
       #  api.crm.accounts.remote_field_classes_list
       def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
-                                    include_remote_fields: nil, is_common_model_field: nil, page_size: nil, request_options: nil)
+                                    include_remote_fields: nil, include_shell_data: nil, is_common_model_field: nil, page_size: 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?
@@ -323,6 +338,7 @@ module Merge
             "include_deleted_data": include_deleted_data,
             "include_remote_data": include_remote_data,
             "include_remote_fields": include_remote_fields,
+            "include_shell_data": include_shell_data,
             "is_common_model_field": is_common_model_field,
             "page_size": page_size
           }.compact
@@ -352,11 +368,16 @@ module Merge
       # @param cursor [String] The pagination cursor value.
       # @param expand [String] Which relations should be returned in expanded form. Multiple relation names
       #  should be comma separated without spaces.
-      # @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_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to
       #  common models, in a normalized format.
+      # @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.
@@ -374,7 +395,7 @@ module Merge
       #  )
       #  api.crm.accounts.list
       def list(created_after: nil, created_before: nil, cursor: nil, expand: nil, include_deleted_data: nil,
-               include_remote_data: nil, include_remote_fields: nil, modified_after: nil, modified_before: nil, name: nil, owner_id: nil, page_size: nil, remote_id: nil, request_options: nil)
+               include_remote_data: nil, include_remote_fields: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, name: nil, owner_id: 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?
@@ -394,6 +415,7 @@ module Merge
               "include_deleted_data": include_deleted_data,
               "include_remote_data": include_remote_data,
               "include_remote_fields": include_remote_fields,
+              "include_shell_data": include_shell_data,
               "modified_after": modified_after,
               "modified_before": modified_before,
               "name": name,
@@ -467,6 +489,8 @@ module Merge
       #  produce these models.
       # @param include_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to
       #  common models, in a normalized format.
+      # @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::Crm::Account]
       # @example
@@ -476,7 +500,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.crm.accounts.retrieve(id: "id")
-      def retrieve(id:, expand: nil, include_remote_data: nil, include_remote_fields: nil, request_options: nil)
+      def retrieve(id:, expand: nil, include_remote_data: nil, include_remote_fields: 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?
@@ -491,7 +516,8 @@ module Merge
               **(request_options&.additional_query_parameters || {}),
               "expand": expand,
               "include_remote_data": include_remote_data,
-              "include_remote_fields": include_remote_fields
+              "include_remote_fields": include_remote_fields,
+              "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
@@ -623,11 +649,16 @@ module Merge
       # Returns a list of `RemoteFieldClass` objects.
       #
       # @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_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to
       #  common models, in a normalized format.
+      # @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 is_common_model_field [Boolean] If provided, will only return remote field classes with this
       #  is_common_model_field value
       # @param page_size [Integer] Number of results to return per page.
@@ -641,7 +672,7 @@ module Merge
       #  )
       #  api.crm.accounts.remote_field_classes_list
       def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
-                                    include_remote_fields: nil, is_common_model_field: nil, page_size: nil, request_options: nil)
+                                    include_remote_fields: nil, include_shell_data: nil, is_common_model_field: nil, page_size: 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?
@@ -658,6 +689,7 @@ module Merge
               "include_deleted_data": include_deleted_data,
               "include_remote_data": include_remote_data,
               "include_remote_fields": include_remote_fields,
+              "include_shell_data": include_shell_data,
               "is_common_model_field": is_common_model_field,
               "page_size": page_size
             }.compact