merge_ruby_client 0.1.4 → 1.1.0

data/lib/merge_ruby_client/crm/types/patched_engagement_request.rb

@@ -22,8 +22,8 @@ module Merge
       # @return [String] The engagement's subject.
       attr_reader :subject
       # @return [Merge::Crm::DirectionEnum] The engagement's direction.
-      #  - `INBOUND` - INBOUND
-      #  - `OUTBOUND` - OUTBOUND
+      #  * `INBOUND` - INBOUND
+      #  * `OUTBOUND` - OUTBOUND
       attr_reader :direction
       # @return [String] The engagement type of the engagement.
       attr_reader :engagement_type
@@ -53,8 +53,8 @@ module Merge
       # @param content [String] The engagement's content.
       # @param subject [String] The engagement's subject.
       # @param direction [Merge::Crm::DirectionEnum] The engagement's direction.
-      #  - `INBOUND` - INBOUND
-      #  - `OUTBOUND` - OUTBOUND
+      #  * `INBOUND` - INBOUND
+      #  * `OUTBOUND` - OUTBOUND
       # @param engagement_type [String] The engagement type of the engagement.
       # @param start_time [DateTime] The time at which the engagement started.
       # @param end_time [DateTime] The time at which the engagement ended.

data/lib/merge_ruby_client/crm/types/patched_opportunity_request.rb

@@ -28,9 +28,9 @@ module Merge
       # @return [String] The stage of the opportunity.
       attr_reader :stage
       # @return [Merge::Crm::OpportunityStatusEnum] The opportunity's status.
-      #  - `OPEN` - OPEN
-      #  - `WON` - WON
-      #  - `LOST` - LOST
+      #  * `OPEN` - OPEN
+      #  * `WON` - WON
+      #  * `LOST` - LOST
       attr_reader :status
       # @return [DateTime] When the opportunity's last activity occurred.
       attr_reader :last_activity_at
@@ -57,9 +57,9 @@ module Merge
       # @param account [String] The account of the opportunity.
       # @param stage [String] The stage of the opportunity.
       # @param status [Merge::Crm::OpportunityStatusEnum] The opportunity's status.
-      #  - `OPEN` - OPEN
-      #  - `WON` - WON
-      #  - `LOST` - LOST
+      #  * `OPEN` - OPEN
+      #  * `WON` - WON
+      #  * `LOST` - LOST
       # @param last_activity_at [DateTime] When the opportunity's last activity occurred.
       # @param close_date [DateTime] When the opportunity was closed.
       # @param integration_params [Hash{String => Object}]

data/lib/merge_ruby_client/crm/types/patched_task_request.rb

@@ -29,8 +29,8 @@ module Merge
       # @return [DateTime] When the task is due.
       attr_reader :due_date
       # @return [Merge::Crm::TaskStatusEnum] The task's status.
-      #  - `OPEN` - OPEN
-      #  - `CLOSED` - CLOSED
+      #  * `OPEN` - OPEN
+      #  * `CLOSED` - CLOSED
       attr_reader :status
       # @return [Hash{String => Object}]
       attr_reader :integration_params
@@ -54,8 +54,8 @@ module Merge
       # @param completed_date [DateTime] When the task is completed.
       # @param due_date [DateTime] When the task is due.
       # @param status [Merge::Crm::TaskStatusEnum] The task's status.
-      #  - `OPEN` - OPEN
-      #  - `CLOSED` - CLOSED
+      #  * `OPEN` - OPEN
+      #  * `CLOSED` - CLOSED
       # @param integration_params [Hash{String => Object}]
       # @param linked_account_params [Hash{String => Object}]
       # @param remote_fields [Array<Merge::Crm::RemoteFieldRequest>]

data/lib/merge_ruby_client/crm/types/reason_enum.rb

@@ -2,9 +2,9 @@
 
 module Merge
   module Crm
-    # - `GENERAL_CUSTOMER_REQUEST` - GENERAL_CUSTOMER_REQUEST
-    #  - `GDPR` - GDPR
-    #  - `OTHER` - OTHER
+    # * `GENERAL_CUSTOMER_REQUEST` - GENERAL_CUSTOMER_REQUEST
+    #  * `GDPR` - GDPR
+    #  * `OTHER` - OTHER
     class ReasonEnum
       GENERAL_CUSTOMER_REQUEST = "GENERAL_CUSTOMER_REQUEST"
       GDPR = "GDPR"

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

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

data/lib/merge_ruby_client/crm/types/request_format_enum.rb

@@ -2,9 +2,9 @@
 
 module Merge
   module Crm
-    # - `JSON` - JSON
-    #  - `XML` - XML
-    #  - `MULTIPART` - MULTIPART
+    # * `JSON` - JSON
+    #  * `XML` - XML
+    #  * `MULTIPART` - MULTIPART
     class RequestFormatEnum
       JSON_ = "JSON"
       XML = "XML"

data/lib/merge_ruby_client/crm/types/response_type_enum.rb

@@ -2,8 +2,8 @@
 
 module Merge
   module Crm
-    # - `JSON` - JSON
-    #  - `BASE64_GZIP` - BASE64_GZIP
+    # * `JSON` - JSON
+    #  * `BASE64_GZIP` - BASE64_GZIP
     class ResponseTypeEnum
       JSON_ = "JSON"
       BASE_64_GZIP = "BASE64_GZIP"

data/lib/merge_ruby_client/crm/types/role_enum.rb

@@ -2,12 +2,12 @@
 
 module Merge
   module Crm
-    # - `ADMIN` - ADMIN
-    #  - `DEVELOPER` - DEVELOPER
-    #  - `MEMBER` - MEMBER
-    #  - `API` - API
-    #  - `SYSTEM` - SYSTEM
-    #  - `MERGE_TEAM` - MERGE_TEAM
+    # * `ADMIN` - ADMIN
+    #  * `DEVELOPER` - DEVELOPER
+    #  * `MEMBER` - MEMBER
+    #  * `API` - API
+    #  * `SYSTEM` - SYSTEM
+    #  * `MERGE_TEAM` - MERGE_TEAM
     class RoleEnum
       ADMIN = "ADMIN"
       DEVELOPER = "DEVELOPER"

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

@@ -2,8 +2,8 @@
 
 module Merge
   module Crm
-    # - `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/crm/types/stage.rb

@@ -25,7 +25,9 @@ module Merge
       # @return [String] The stage'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
@@ -47,7 +49,9 @@ module Merge
       # @param modified_at [DateTime] The datetime that this object was modified by Merge.
       # @param name [String] The stage'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<Merge::Crm::RemoteData>]
       # @param remote_fields [Array<Merge::Crm::RemoteField>]

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Merge
+  module Crm
+    # * `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/crm/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::Crm::SyncStatusStatusEnum]
+      # @return [Merge::Crm::LastSyncResultEnum]
+      attr_reader :last_sync_result
+      # @return [DateTime]
+      attr_reader :last_sync_finished
+      # @return [Merge::Crm::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::Crm::SyncStatusStatusEnum]
+      # @param last_sync_result [Merge::Crm::LastSyncResultEnum]
+      # @param last_sync_finished [DateTime]
+      # @param status [Merge::Crm::StatusFd5Enum]
       # @param is_initial_sync [Boolean]
       # @param selective_sync_configurations_usage [Merge::Crm::SelectiveSyncConfigurationsUsageEnum]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Merge::Crm::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::Crm::SyncStatusStatusEnum) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+        obj.last_sync_result&.is_a?(Merge::Crm::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::Crm::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::Crm::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/crm/types/task.rb

@@ -41,11 +41,13 @@ module Merge
       # @return [DateTime] When the task is due.
       attr_reader :due_date
       # @return [Merge::Crm::TaskStatusEnum] The task's status.
-      #  - `OPEN` - OPEN
-      #  - `CLOSED` - CLOSED
+      #  * `OPEN` - OPEN
+      #  * `CLOSED` - CLOSED
       attr_reader :status
       # @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
@@ -73,10 +75,12 @@ module Merge
       # @param completed_date [DateTime] When the task is completed.
       # @param due_date [DateTime] When the task is due.
       # @param status [Merge::Crm::TaskStatusEnum] The task's status.
-      #  - `OPEN` - OPEN
-      #  - `CLOSED` - CLOSED
+      #  * `OPEN` - OPEN
+      #  * `CLOSED` - CLOSED
       # @param remote_was_deleted [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       # @param field_mappings [Hash{String => Object}]
       # @param remote_data [Array<Merge::Crm::RemoteData>]
       # @param remote_fields [Array<Merge::Crm::RemoteField>]

data/lib/merge_ruby_client/crm/types/task_request.rb

@@ -32,8 +32,8 @@ module Merge
       # @return [DateTime] When the task is due.
       attr_reader :due_date
       # @return [Merge::Crm::TaskStatusEnum] The task's status.
-      #  - `OPEN` - OPEN
-      #  - `CLOSED` - CLOSED
+      #  * `OPEN` - OPEN
+      #  * `CLOSED` - CLOSED
       attr_reader :status
       # @return [Hash{String => Object}]
       attr_reader :integration_params
@@ -57,8 +57,8 @@ module Merge
       # @param completed_date [DateTime] When the task is completed.
       # @param due_date [DateTime] When the task is due.
       # @param status [Merge::Crm::TaskStatusEnum] The task's status.
-      #  - `OPEN` - OPEN
-      #  - `CLOSED` - CLOSED
+      #  * `OPEN` - OPEN
+      #  * `CLOSED` - CLOSED
       # @param integration_params [Hash{String => Object}]
       # @param linked_account_params [Hash{String => Object}]
       # @param remote_fields [Array<Merge::Crm::RemoteFieldRequest>]

data/lib/merge_ruby_client/crm/types/task_status_enum.rb

@@ -2,8 +2,8 @@
 
 module Merge
   module Crm
-    # - `OPEN` - OPEN
-    #  - `CLOSED` - CLOSED
+    # * `OPEN` - OPEN
+    #  * `CLOSED` - CLOSED
     class TaskStatusEnum
       OPEN = "OPEN"
       CLOSED = "CLOSED"

data/lib/merge_ruby_client/crm/types/user.rb

@@ -29,7 +29,9 @@ module Merge
       # @return [Boolean] Whether or not the user is active.
       attr_reader :is_active
       # @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
@@ -53,7 +55,9 @@ module Merge
       # @param email [String] The user's email address.
       # @param is_active [Boolean] Whether or not the user is active.
       # @param remote_was_deleted [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       # @param field_mappings [Hash{String => Object}]
       # @param remote_data [Array<Merge::Crm::RemoteData>]
       # @param remote_fields [Array<Merge::Crm::RemoteField>]

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

@@ -25,11 +25,17 @@ 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 email [String] If provided, will only return users with this email.
+      # @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.
@@ -44,8 +50,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.crm.users.list
-      def list(created_after: nil, created_before: nil, cursor: nil, include_deleted_data: nil,
-               include_remote_data: nil, include_remote_fields: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_id: nil, request_options: nil)
+      def list(created_after: nil, created_before: nil, cursor: nil, email: nil, include_deleted_data: nil,
+               include_remote_data: nil, include_remote_fields: 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?
@@ -60,9 +66,11 @@ module Merge
             "created_after": created_after,
             "created_before": created_before,
             "cursor": cursor,
+            "email": email,
             "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,
             "page_size": page_size,
@@ -83,6 +91,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::User]
       # @example
@@ -92,7 +102,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.crm.users.retrieve(id: "id")
-      def retrieve(id:, include_remote_data: nil, include_remote_fields: nil, request_options: nil)
+      def retrieve(id:, 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?
@@ -105,7 +116,8 @@ module Merge
           req.params = {
             **(request_options&.additional_query_parameters || {}),
             "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
@@ -154,11 +166,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.
@@ -172,7 +189,7 @@ module Merge
       #  )
       #  api.crm.users.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?
@@ -188,6 +205,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
@@ -215,11 +233,17 @@ 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 email [String] If provided, will only return users with this email.
+      # @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.
@@ -234,8 +258,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.crm.users.list
-      def list(created_after: nil, created_before: nil, cursor: nil, include_deleted_data: nil,
-               include_remote_data: nil, include_remote_fields: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_id: nil, request_options: nil)
+      def list(created_after: nil, created_before: nil, cursor: nil, email: nil, include_deleted_data: nil,
+               include_remote_data: nil, include_remote_fields: 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?
@@ -251,9 +275,11 @@ module Merge
               "created_after": created_after,
               "created_before": created_before,
               "cursor": cursor,
+              "email": email,
               "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,
               "page_size": page_size,
@@ -275,6 +301,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::User]
       # @example
@@ -284,7 +312,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.crm.users.retrieve(id: "id")
-      def retrieve(id:, include_remote_data: nil, include_remote_fields: nil, request_options: nil)
+      def retrieve(id:, 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?
@@ -298,7 +327,8 @@ module Merge
             req.params = {
               **(request_options&.additional_query_parameters || {}),
               "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
@@ -350,11 +380,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.
@@ -368,7 +403,7 @@ module Merge
       #  )
       #  api.crm.users.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?
@@ -385,6 +420,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

data/lib/merge_ruby_client/filestorage/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::Filestorage::RemoteResponse]
+      # @return [Merge::Filestorage::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)}/filestorage/v1/async-passthrough/#{async_passthrough_receipt_id}"
         end
-        Merge::Filestorage::RemoteResponse.from_json(json_object: response.body)
+        Merge::Filestorage::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::Filestorage::RemoteResponse]
+      # @return [Merge::Filestorage::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)}/filestorage/v1/async-passthrough/#{async_passthrough_receipt_id}"
           end
-          Merge::Filestorage::RemoteResponse.from_json(json_object: response.body)
+          Merge::Filestorage::AsyncPassthrough::AsyncPassthroughRetrieveResponse.from_json(json_object: response.body)
         end
       end
     end