merge_ruby_client 0.1.4 → 1.0.0

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

@@ -33,9 +33,14 @@ module Merge
       # @param cursor [String] The pagination cursor value.
       # @param expand [Merge::Ats::Applications::ApplicationsListRequestExpand] 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_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 job_id [String] If provided, will only return applications for this job.
       # @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
@@ -54,7 +59,7 @@ module Merge
       #  )
       #  api.ats.applications.list
       def list(candidate_id: nil, created_after: nil, created_before: nil, credited_to_id: nil, current_stage_id: nil,
-               cursor: nil, expand: nil, include_deleted_data: nil, include_remote_data: nil, job_id: nil, modified_after: nil, modified_before: nil, page_size: nil, reject_reason_id: nil, remote_id: nil, source: nil, request_options: nil)
+               cursor: nil, expand: nil, include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil, job_id: nil, modified_after: nil, modified_before: nil, page_size: nil, reject_reason_id: nil, remote_id: nil, source: 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?
@@ -75,6 +80,7 @@ module Merge
             "expand": expand,
             "include_deleted_data": include_deleted_data,
             "include_remote_data": include_remote_data,
+            "include_shell_data": include_shell_data,
             "job_id": job_id,
             "modified_after": modified_after,
             "modified_before": modified_before,
@@ -92,6 +98,12 @@ module Merge
       end
 
       # Creates an `Application` object with the given values.
+      #  For certain integrations, but not all, our API detects duplicate candidates and
+      #  will associate applications with existing records in the third-party. New
+      #  candidates are created and automatically linked to the application.
+      #  See our [Help Center
+      #  tps://help.merge.dev/en/articles/10012366-updates-to-post-applications-oct-2024)
+      #  for detailed support per integration.
       #
       # @param is_debug_mode [Boolean] Whether to include debug fields (such as log file links) in the response.
       # @param run_async [Boolean] Whether or not third-party updates should be run asynchronously.
@@ -280,9 +292,14 @@ module Merge
       # @param cursor [String] The pagination cursor value.
       # @param expand [Merge::Ats::Applications::ApplicationsListRequestExpand] 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_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 job_id [String] If provided, will only return applications for this job.
       # @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
@@ -301,7 +318,7 @@ module Merge
       #  )
       #  api.ats.applications.list
       def list(candidate_id: nil, created_after: nil, created_before: nil, credited_to_id: nil, current_stage_id: nil,
-               cursor: nil, expand: nil, include_deleted_data: nil, include_remote_data: nil, job_id: nil, modified_after: nil, modified_before: nil, page_size: nil, reject_reason_id: nil, remote_id: nil, source: nil, request_options: nil)
+               cursor: nil, expand: nil, include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil, job_id: nil, modified_after: nil, modified_before: nil, page_size: nil, reject_reason_id: nil, remote_id: nil, source: 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?
@@ -323,6 +340,7 @@ module Merge
               "expand": expand,
               "include_deleted_data": include_deleted_data,
               "include_remote_data": include_remote_data,
+              "include_shell_data": include_shell_data,
               "job_id": job_id,
               "modified_after": modified_after,
               "modified_before": modified_before,
@@ -341,6 +359,12 @@ module Merge
       end
 
       # Creates an `Application` object with the given values.
+      #  For certain integrations, but not all, our API detects duplicate candidates and
+      #  will associate applications with existing records in the third-party. New
+      #  candidates are created and automatically linked to the application.
+      #  See our [Help Center
+      #  tps://help.merge.dev/en/articles/10012366-updates-to-post-applications-oct-2024)
+      #  for detailed support per integration.
       #
       # @param is_debug_mode [Boolean] Whether to include debug fields (such as log file links) in the response.
       # @param run_async [Boolean] Whether or not third-party updates should be run asynchronously.

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

@@ -3,7 +3,7 @@
 require_relative "../../../requests"
 require_relative "../types/data_passthrough_request"
 require_relative "../types/async_passthrough_reciept"
-require_relative "../types/remote_response"
+require_relative "types/async_passthrough_retrieve_response"
 require "async"
 
 module Merge
@@ -61,7 +61,7 @@ module Merge
       #
       # @param async_passthrough_receipt_id [String]
       # @param request_options [Merge::RequestOptions]
-      # @return [Merge::Ats::RemoteResponse]
+      # @return [Merge::Ats::RemoteResponse, String]
       # @example
       #  api = Merge::Client.new(
       #    base_url: "https://api.example.com",
@@ -87,7 +87,7 @@ module Merge
           end
           req.url "#{@request_client.get_url(request_options: request_options)}/ats/v1/async-passthrough/#{async_passthrough_receipt_id}"
         end
-        Merge::Ats::RemoteResponse.from_json(json_object: response.body)
+        Merge::Ats::AsyncPassthrough::AsyncPassthroughRetrieveResponse.from_json(json_object: response.body)
       end
     end
 
@@ -146,7 +146,7 @@ module Merge
       #
       # @param async_passthrough_receipt_id [String]
       # @param request_options [Merge::RequestOptions]
-      # @return [Merge::Ats::RemoteResponse]
+      # @return [Merge::Ats::RemoteResponse, String]
       # @example
       #  api = Merge::Client.new(
       #    base_url: "https://api.example.com",
@@ -173,7 +173,7 @@ module Merge
             end
             req.url "#{@request_client.get_url(request_options: request_options)}/ats/v1/async-passthrough/#{async_passthrough_receipt_id}"
           end
-          Merge::Ats::RemoteResponse.from_json(json_object: response.body)
+          Merge::Ats::AsyncPassthrough::AsyncPassthroughRetrieveResponse.from_json(json_object: response.body)
         end
       end
     end

data/lib/merge_ruby_client/ats/async_passthrough/types/async_passthrough_retrieve_response.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "../../types/remote_response"
+
+module Merge
+  module Ats
+    class AsyncPassthrough
+      class AsyncPassthroughRetrieveResponse
+        # Deserialize a JSON object to an instance of AsyncPassthroughRetrieveResponse
+        #
+        # @param json_object [String]
+        # @return [Merge::Ats::AsyncPassthrough::AsyncPassthroughRetrieveResponse]
+        def self.from_json(json_object:)
+          struct = JSON.parse(json_object, object_class: OpenStruct)
+          begin
+            Merge::Ats::RemoteResponse.validate_raw(obj: struct)
+            return Merge::Ats::RemoteResponse.from_json(json_object: struct) unless struct.nil?
+
+            return nil
+          rescue StandardError
+            # noop
+          end
+          begin
+            struct.is_a?(String) != false || raise("Passed value for field struct is not the expected type, validation failed.")
+            return struct unless struct.nil?
+
+            return nil
+          rescue StandardError
+            # noop
+          end
+          struct
+        end
+
+        # Leveraged for Union-type generation, validate_raw attempts to parse the given
+        #  hash and check each fields type against the current object's property
+        #  definitions.
+        #
+        # @param obj [Object]
+        # @return [Void]
+        def self.validate_raw(obj:)
+          begin
+            return Merge::Ats::RemoteResponse.validate_raw(obj: obj)
+          rescue StandardError
+            # noop
+          end
+          begin
+            return obj.is_a?(String) != false || raise("Passed value for field obj is not the expected type, validation failed.")
+          rescue StandardError
+            # noop
+          end
+          raise("Passed value matched no type within the union, validation failed.")
+        end
+      end
+    end
+  end
+end

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

@@ -29,9 +29,14 @@ 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_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.
@@ -51,7 +56,7 @@ module Merge
       #  )
       #  api.ats.attachments.list
       def list(candidate_id: nil, created_after: nil, created_before: nil, cursor: nil, expand: 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_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, 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?
@@ -70,6 +75,7 @@ module Merge
             "expand": expand,
             "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,
@@ -228,9 +234,14 @@ 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_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.
@@ -250,7 +261,7 @@ module Merge
       #  )
       #  api.ats.attachments.list
       def list(candidate_id: nil, created_after: nil, created_before: nil, cursor: nil, expand: 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_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, 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?
@@ -270,6 +281,7 @@ module Merge
               "expand": expand,
               "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,

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

@@ -38,7 +38,10 @@ module Merge
       #  `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`,
       #  `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`,
       #  `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`,
-      #  `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `FORCED_LINKED_ACCOUNT_RESYNC`,
+      #  `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`,
+      #  `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`,
+      #  `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`,
+      #  `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`,
       #  `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`,
       #  `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`,
       #  `END_USER_CREDENTIALS_ACCESSED`
@@ -117,7 +120,10 @@ module Merge
       #  `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`,
       #  `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`,
       #  `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`,
-      #  `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `FORCED_LINKED_ACCOUNT_RESYNC`,
+      #  `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`,
+      #  `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`,
+      #  `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`,
+      #  `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`,
       #  `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`,
       #  `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`,
       #  `END_USER_CREDENTIALS_ACCESSED`

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

@@ -35,9 +35,14 @@ module Merge
       # @param expand [Merge::Ats::Candidates::CandidatesListRequestExpand] Which relations should be returned in expanded form. Multiple relation names
       #  should be comma separated without spaces.
       # @param first_name [String] If provided, will only return candidates with this first name.
-      # @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 last_name [String] If provided, will only return candidates with this last name.
       # @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
@@ -56,7 +61,7 @@ module Merge
       #  )
       #  api.ats.candidates.list
       def list(created_after: nil, created_before: nil, cursor: nil, email_addresses: nil, expand: nil,
-               first_name: nil, include_deleted_data: nil, include_remote_data: nil, last_name: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_id: nil, tags: nil, request_options: nil)
+               first_name: nil, include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil, last_name: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_id: nil, tags: 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?
@@ -76,6 +81,7 @@ module Merge
             "first_name": first_name,
             "include_deleted_data": include_deleted_data,
             "include_remote_data": include_remote_data,
+            "include_shell_data": include_shell_data,
             "last_name": last_name,
             "modified_after": modified_after,
             "modified_before": modified_before,
@@ -370,9 +376,14 @@ module Merge
       # @param expand [Merge::Ats::Candidates::CandidatesListRequestExpand] Which relations should be returned in expanded form. Multiple relation names
       #  should be comma separated without spaces.
       # @param first_name [String] If provided, will only return candidates with this first name.
-      # @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 last_name [String] If provided, will only return candidates with this last name.
       # @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
@@ -391,7 +402,7 @@ module Merge
       #  )
       #  api.ats.candidates.list
       def list(created_after: nil, created_before: nil, cursor: nil, email_addresses: nil, expand: nil,
-               first_name: nil, include_deleted_data: nil, include_remote_data: nil, last_name: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_id: nil, tags: nil, request_options: nil)
+               first_name: nil, include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil, last_name: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_id: nil, tags: 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?
@@ -412,6 +423,7 @@ module Merge
               "first_name": first_name,
               "include_deleted_data": include_deleted_data,
               "include_remote_data": include_remote_data,
+              "include_shell_data": include_shell_data,
               "last_name": last_name,
               "modified_after": modified_after,
               "modified_before": modified_before,

data/lib/merge_ruby_client/ats/departments/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.ats.departments.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,
@@ -123,9 +129,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 +152,7 @@ module Merge
       #  )
       #  api.ats.departments.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 +170,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,

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

@@ -30,9 +30,14 @@ 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_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.ats.eeocs.list
       def list(candidate_id: nil, created_after: nil, created_before: nil, cursor: nil, expand: 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_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, 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?
@@ -71,6 +76,7 @@ module Merge
             "expand": expand,
             "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,
@@ -151,9 +157,14 @@ 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_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.
@@ -173,7 +184,7 @@ module Merge
       #  )
       #  api.ats.eeocs.list
       def list(candidate_id: nil, created_after: nil, created_before: nil, cursor: nil, expand: 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_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, 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?
@@ -193,6 +204,7 @@ module Merge
               "expand": expand,
               "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,

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

@@ -23,6 +23,10 @@ module Merge
       #  between third-party Remote Fields and user defined Merge fields. [Learn
       #  more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
       #
+      # @param exclude_remote_field_metadata [Boolean] If `true`, remote fields metadata is excluded from each field mapping instance
+      #  (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null).
+      #  This will increase the speed of the request since these fields require some
+      #  calculations.
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Ats::FieldMappingApiInstanceResponse]
       # @example
@@ -32,7 +36,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.ats.field_mapping.field_mappings_retrieve
-      def field_mappings_retrieve(request_options: nil)
+      def field_mappings_retrieve(exclude_remote_field_metadata: 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?
@@ -42,9 +46,10 @@ module Merge
         **@request_client.get_headers,
         **(request_options&.additional_headers || {})
           }.compact
-          unless request_options.nil? || request_options&.additional_query_parameters.nil?
-            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
-          end
+          req.params = {
+            **(request_options&.additional_query_parameters || {}),
+            "exclude_remote_field_metadata": exclude_remote_field_metadata
+          }.compact
           unless request_options.nil? || request_options&.additional_body_parameters.nil?
             req.body = { **(request_options&.additional_body_parameters || {}) }.compact
           end
@@ -57,6 +62,10 @@ module Merge
       #  This will cause the next sync for this Linked Account to sync **ALL** data from
       #  start.
       #
+      # @param exclude_remote_field_metadata [Boolean] If `true`, remote fields metadata is excluded from each field mapping instance
+      #  (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null).
+      #  This will increase the speed of the request since these fields require some
+      #  calculations.
       # @param target_field_name [String] The name of the target field you want this remote field to map to.
       # @param target_field_description [String] The description of the target field you want this remote field to map to.
       # @param remote_field_traversal_path [Array<Object>] The field traversal path of the remote field listed when you hit the GET
@@ -82,7 +91,7 @@ module Merge
       #    common_model_name: "ExampleCommonModel"
       #  )
       def field_mappings_create(target_field_name:, target_field_description:, remote_field_traversal_path:,
-                                remote_method:, remote_url_path:, common_model_name:, request_options: nil)
+                                remote_method:, remote_url_path:, common_model_name:, exclude_remote_field_metadata: nil, 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?
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
@@ -92,9 +101,10 @@ module Merge
         **@request_client.get_headers,
         **(request_options&.additional_headers || {})
           }.compact
-          unless request_options.nil? || request_options&.additional_query_parameters.nil?
-            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
-          end
+          req.params = {
+            **(request_options&.additional_query_parameters || {}),
+            "exclude_remote_field_metadata": exclude_remote_field_metadata
+          }.compact
           req.body = {
             **(request_options&.additional_body_parameters || {}),
             target_field_name: target_field_name,
@@ -280,6 +290,10 @@ module Merge
       #  between third-party Remote Fields and user defined Merge fields. [Learn
       #  more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
       #
+      # @param exclude_remote_field_metadata [Boolean] If `true`, remote fields metadata is excluded from each field mapping instance
+      #  (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null).
+      #  This will increase the speed of the request since these fields require some
+      #  calculations.
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Ats::FieldMappingApiInstanceResponse]
       # @example
@@ -289,7 +303,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.ats.field_mapping.field_mappings_retrieve
-      def field_mappings_retrieve(request_options: nil)
+      def field_mappings_retrieve(exclude_remote_field_metadata: 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?
@@ -300,9 +314,10 @@ module Merge
           **@request_client.get_headers,
           **(request_options&.additional_headers || {})
             }.compact
-            unless request_options.nil? || request_options&.additional_query_parameters.nil?
-              req.params = { **(request_options&.additional_query_parameters || {}) }.compact
-            end
+            req.params = {
+              **(request_options&.additional_query_parameters || {}),
+              "exclude_remote_field_metadata": exclude_remote_field_metadata
+            }.compact
             unless request_options.nil? || request_options&.additional_body_parameters.nil?
               req.body = { **(request_options&.additional_body_parameters || {}) }.compact
             end
@@ -316,6 +331,10 @@ module Merge
       #  This will cause the next sync for this Linked Account to sync **ALL** data from
       #  start.
       #
+      # @param exclude_remote_field_metadata [Boolean] If `true`, remote fields metadata is excluded from each field mapping instance
+      #  (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null).
+      #  This will increase the speed of the request since these fields require some
+      #  calculations.
       # @param target_field_name [String] The name of the target field you want this remote field to map to.
       # @param target_field_description [String] The description of the target field you want this remote field to map to.
       # @param remote_field_traversal_path [Array<Object>] The field traversal path of the remote field listed when you hit the GET
@@ -341,7 +360,7 @@ module Merge
       #    common_model_name: "ExampleCommonModel"
       #  )
       def field_mappings_create(target_field_name:, target_field_description:, remote_field_traversal_path:,
-                                remote_method:, remote_url_path:, common_model_name:, request_options: nil)
+                                remote_method:, remote_url_path:, common_model_name:, exclude_remote_field_metadata: nil, request_options: nil)
         Async do
           response = @request_client.conn.post do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -352,9 +371,10 @@ module Merge
           **@request_client.get_headers,
           **(request_options&.additional_headers || {})
             }.compact
-            unless request_options.nil? || request_options&.additional_query_parameters.nil?
-              req.params = { **(request_options&.additional_query_parameters || {}) }.compact
-            end
+            req.params = {
+              **(request_options&.additional_query_parameters || {}),
+              "exclude_remote_field_metadata": exclude_remote_field_metadata
+            }.compact
             req.body = {
               **(request_options&.additional_body_parameters || {}),
               target_field_name: target_field_name,

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

@@ -19,7 +19,7 @@ module Merge
 
       # 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 Launch, Professional, or
+      #  quarterly, and highest sync frequency customers on the Professional or
       #  Enterprise plans. Doing so will consume a sync credit for the relevant linked
       #  account.
       #
@@ -70,7 +70,7 @@ module Merge
 
       # 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 Launch, Professional, or
+      #  quarterly, and highest sync frequency customers on the Professional or
       #  Enterprise plans. Doing so will consume a sync credit for the relevant linked
       #  account.
       #