merge_ruby_client 0.1.4 → 1.0.0

data/lib/merge_ruby_client/filestorage/types/folder.rb

@@ -4,6 +4,7 @@ require "date"
 require_relative "folder_parent_folder"
 require_relative "folder_drive"
 require_relative "folder_permissions"
+require_relative "remote_data"
 require "ostruct"
 require "json"
 
@@ -29,7 +30,7 @@ module Merge
       attr_reader :name
       # @return [String] The URL to access the folder.
       attr_reader :folder_url
-      # @return [Integer] The folder's size, in bytes.
+      # @return [Long] The folder's size, in bytes.
       attr_reader :size
       # @return [String] The folder's description.
       attr_reader :description
@@ -46,11 +47,13 @@ module Merge
       # @return [DateTime] When the third party's folder was updated.
       attr_reader :remote_updated_at
       # @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
-      # @return [Array<Hash{String => Object}>]
+      # @return [Array<Merge::Filestorage::RemoteData>]
       attr_reader :remote_data
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
@@ -66,7 +69,7 @@ module Merge
       # @param modified_at [DateTime] The datetime that this object was modified by Merge.
       # @param name [String] The folder's name.
       # @param folder_url [String] The URL to access the folder.
-      # @param size [Integer] The folder's size, in bytes.
+      # @param size [Long] The folder's size, in bytes.
       # @param description [String] The folder's description.
       # @param parent_folder [Merge::Filestorage::FolderParentFolder] The folder that the folder belongs to.
       # @param drive [Merge::Filestorage::FolderDrive] The drive that the folder belongs to.
@@ -76,9 +79,11 @@ module Merge
       # @param remote_created_at [DateTime] When the third party's folder was created.
       # @param remote_updated_at [DateTime] When the third party's folder was updated.
       # @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 remote_data [Array<Merge::Filestorage::RemoteData>]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Merge::Filestorage::Folder]
       def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, name: OMIT, folder_url: OMIT,
@@ -163,7 +168,10 @@ module Merge
                             end
         remote_was_deleted = parsed_json["remote_was_deleted"]
         field_mappings = parsed_json["field_mappings"]
-        remote_data = parsed_json["remote_data"]
+        remote_data = parsed_json["remote_data"]&.map do |item|
+          item = item.to_json
+          Merge::Filestorage::RemoteData.from_json(json_object: item)
+        end
         new(
           id: id,
           remote_id: remote_id,
@@ -205,7 +213,7 @@ module Merge
         obj.modified_at&.is_a?(DateTime) != false || raise("Passed value for field obj.modified_at is not the expected type, validation failed.")
         obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
         obj.folder_url&.is_a?(String) != false || raise("Passed value for field obj.folder_url is not the expected type, validation failed.")
-        obj.size&.is_a?(Integer) != false || raise("Passed value for field obj.size is not the expected type, validation failed.")
+        obj.size&.is_a?(Long) != false || raise("Passed value for field obj.size is not the expected type, validation failed.")
         obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
         obj.parent_folder.nil? || Merge::Filestorage::FolderParentFolder.validate_raw(obj: obj.parent_folder)
         obj.drive.nil? || Merge::Filestorage::FolderDrive.validate_raw(obj: obj.drive)

data/lib/merge_ruby_client/filestorage/types/folder_request.rb

@@ -20,7 +20,7 @@ module Merge
       attr_reader :name
       # @return [String] The URL to access the folder.
       attr_reader :folder_url
-      # @return [Integer] The folder's size, in bytes.
+      # @return [Long] The folder's size, in bytes.
       attr_reader :size
       # @return [String] The folder's description.
       attr_reader :description
@@ -46,7 +46,7 @@ module Merge
 
       # @param name [String] The folder's name.
       # @param folder_url [String] The URL to access the folder.
-      # @param size [Integer] The folder's size, in bytes.
+      # @param size [Long] The folder's size, in bytes.
       # @param description [String] The folder's description.
       # @param parent_folder [Merge::Filestorage::FolderRequestParentFolder] The folder that the folder belongs to.
       # @param drive [Merge::Filestorage::FolderRequestDrive] The drive that the folder belongs to.
@@ -145,7 +145,7 @@ module Merge
       def self.validate_raw(obj:)
         obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
         obj.folder_url&.is_a?(String) != false || raise("Passed value for field obj.folder_url is not the expected type, validation failed.")
-        obj.size&.is_a?(Integer) != false || raise("Passed value for field obj.size is not the expected type, validation failed.")
+        obj.size&.is_a?(Long) != false || raise("Passed value for field obj.size is not the expected type, validation failed.")
         obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
         obj.parent_folder.nil? || Merge::Filestorage::FolderRequestParentFolder.validate_raw(obj: obj.parent_folder)
         obj.drive.nil? || Merge::Filestorage::FolderRequestDrive.validate_raw(obj: obj.drive)

data/lib/merge_ruby_client/filestorage/types/group.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require "date"
+require_relative "group_child_groups_item"
+require_relative "remote_data"
 require "ostruct"
 require "json"
 
@@ -26,12 +28,16 @@ module Merge
       # @return [Array<String>] The users that belong in the group. If null, this typically means it's either a
       #  domain or the third-party platform does not surface this information.
       attr_reader :users
+      # @return [Array<Merge::Filestorage::GroupChildGroupsItem>] Groups that inherit the permissions of the parent group.
+      attr_reader :child_groups
       # @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
-      # @return [Array<Hash{String => Object}>]
+      # @return [Array<Merge::Filestorage::RemoteData>]
       attr_reader :remote_data
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
@@ -48,20 +54,24 @@ module Merge
       # @param name [String] The group's name.
       # @param users [Array<String>] The users that belong in the group. If null, this typically means it's either a
       #  domain or the third-party platform does not surface this information.
+      # @param child_groups [Array<Merge::Filestorage::GroupChildGroupsItem>] Groups that inherit the permissions of the parent group.
       # @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 remote_data [Array<Merge::Filestorage::RemoteData>]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Merge::Filestorage::Group]
       def initialize(users:, id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, name: OMIT,
-                     remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil)
+                     child_groups: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil)
         @id = id if id != OMIT
         @remote_id = remote_id if remote_id != OMIT
         @created_at = created_at if created_at != OMIT
         @modified_at = modified_at if modified_at != OMIT
         @name = name if name != OMIT
         @users = users
+        @child_groups = child_groups if child_groups != OMIT
         @remote_was_deleted = remote_was_deleted if remote_was_deleted != OMIT
         @field_mappings = field_mappings if field_mappings != OMIT
         @remote_data = remote_data if remote_data != OMIT
@@ -73,6 +83,7 @@ module Merge
           "modified_at": modified_at,
           "name": name,
           "users": users,
+          "child_groups": child_groups,
           "remote_was_deleted": remote_was_deleted,
           "field_mappings": field_mappings,
           "remote_data": remote_data
@@ -94,9 +105,16 @@ module Merge
         modified_at = (DateTime.parse(parsed_json["modified_at"]) unless parsed_json["modified_at"].nil?)
         name = parsed_json["name"]
         users = parsed_json["users"]
+        child_groups = parsed_json["child_groups"]&.map do |item|
+          item = item.to_json
+          Merge::Filestorage::GroupChildGroupsItem.from_json(json_object: item)
+        end
         remote_was_deleted = parsed_json["remote_was_deleted"]
         field_mappings = parsed_json["field_mappings"]
-        remote_data = parsed_json["remote_data"]
+        remote_data = parsed_json["remote_data"]&.map do |item|
+          item = item.to_json
+          Merge::Filestorage::RemoteData.from_json(json_object: item)
+        end
         new(
           id: id,
           remote_id: remote_id,
@@ -104,6 +122,7 @@ module Merge
           modified_at: modified_at,
           name: name,
           users: users,
+          child_groups: child_groups,
           remote_was_deleted: remote_was_deleted,
           field_mappings: field_mappings,
           remote_data: remote_data,
@@ -131,6 +150,7 @@ module Merge
         obj.modified_at&.is_a?(DateTime) != false || raise("Passed value for field obj.modified_at is not the expected type, validation failed.")
         obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
         obj.users.is_a?(Array) != false || raise("Passed value for field obj.users is not the expected type, validation failed.")
+        obj.child_groups&.is_a?(Array) != false || raise("Passed value for field obj.child_groups is not the expected type, validation failed.")
         obj.remote_was_deleted&.is_a?(Boolean) != false || raise("Passed value for field obj.remote_was_deleted is not the expected type, validation failed.")
         obj.field_mappings&.is_a?(Hash) != false || raise("Passed value for field obj.field_mappings is not the expected type, validation failed.")
         obj.remote_data&.is_a?(Array) != false || raise("Passed value for field obj.remote_data is not the expected type, validation failed.")

data/lib/merge_ruby_client/filestorage/types/group_child_groups_item.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "group"
+
+module Merge
+  module Filestorage
+    class GroupChildGroupsItem
+      # Deserialize a JSON object to an instance of GroupChildGroupsItem
+      #
+      # @param json_object [String]
+      # @return [Merge::Filestorage::GroupChildGroupsItem]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        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
+        begin
+          Merge::Filestorage::Group.validate_raw(obj: struct)
+          return Merge::Filestorage::Group.from_json(json_object: 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 obj.is_a?(String) != false || raise("Passed value for field obj is not the expected type, validation failed.")
+        rescue StandardError
+          # noop
+        end
+        begin
+          return Merge::Filestorage::Group.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        raise("Passed value matched no type within the union, validation failed.")
+      end
+    end
+  end
+end

data/lib/merge_ruby_client/filestorage/types/language_enum.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Merge
+  module Filestorage
+    # - `en` - en
+    #  - `de` - de
+    class LanguageEnum
+      EN = "en"
+      DE = "de"
+    end
+  end
+end

data/lib/merge_ruby_client/filestorage/types/permission.rb

@@ -26,9 +26,11 @@ module Merge
       attr_reader :created_at
       # @return [DateTime] The datetime that this object was modified by Merge.
       attr_reader :modified_at
-      # @return [Merge::Filestorage::PermissionUser] The user that is granted this permission.
+      # @return [Merge::Filestorage::PermissionUser] The user that is granted this permission. This will only be populated if the
+      #  type is `USER`.
       attr_reader :user
-      # @return [Merge::Filestorage::PermissionGroup] The group that is granted this permission.
+      # @return [Merge::Filestorage::PermissionGroup] The group that is granted this permission. This will only be populated if the
+      #  type is `GROUP`.
       attr_reader :group
       # @return [Merge::Filestorage::TypeEnum] Denotes what type of people have access to the file.
       #  - `USER` - USER
@@ -53,8 +55,10 @@ module Merge
       # @param remote_id [String] The third-party API ID of the matching object.
       # @param created_at [DateTime] The datetime that this object was created by Merge.
       # @param modified_at [DateTime] The datetime that this object was modified by Merge.
-      # @param user [Merge::Filestorage::PermissionUser] The user that is granted this permission.
-      # @param group [Merge::Filestorage::PermissionGroup] The group that is granted this permission.
+      # @param user [Merge::Filestorage::PermissionUser] The user that is granted this permission. This will only be populated if the
+      #  type is `USER`.
+      # @param group [Merge::Filestorage::PermissionGroup] The group that is granted this permission. This will only be populated if the
+      #  type is `GROUP`.
       # @param type [Merge::Filestorage::TypeEnum] Denotes what type of people have access to the file.
       #  - `USER` - USER
       #  - `GROUP` - GROUP

data/lib/merge_ruby_client/filestorage/types/permission_group.rb

@@ -5,7 +5,8 @@ require_relative "group"
 
 module Merge
   module Filestorage
-    # The group that is granted this permission.
+    # The group that is granted this permission. This will only be populated if the
+    #  type is `GROUP`.
     class PermissionGroup
       # Deserialize a JSON object to an instance of PermissionGroup
       #

data/lib/merge_ruby_client/filestorage/types/permission_request.rb

@@ -19,9 +19,11 @@ module Merge
     class PermissionRequest
       # @return [String] The third-party API ID of the matching object.
       attr_reader :remote_id
-      # @return [Merge::Filestorage::PermissionRequestUser] The user that is granted this permission.
+      # @return [Merge::Filestorage::PermissionRequestUser] The user that is granted this permission. This will only be populated if the
+      #  type is `USER`.
       attr_reader :user
-      # @return [Merge::Filestorage::PermissionRequestGroup] The group that is granted this permission.
+      # @return [Merge::Filestorage::PermissionRequestGroup] The group that is granted this permission. This will only be populated if the
+      #  type is `GROUP`.
       attr_reader :group
       # @return [Merge::Filestorage::TypeEnum] Denotes what type of people have access to the file.
       #  - `USER` - USER
@@ -47,8 +49,10 @@ module Merge
       OMIT = Object.new
 
       # @param remote_id [String] The third-party API ID of the matching object.
-      # @param user [Merge::Filestorage::PermissionRequestUser] The user that is granted this permission.
-      # @param group [Merge::Filestorage::PermissionRequestGroup] The group that is granted this permission.
+      # @param user [Merge::Filestorage::PermissionRequestUser] The user that is granted this permission. This will only be populated if the
+      #  type is `USER`.
+      # @param group [Merge::Filestorage::PermissionRequestGroup] The group that is granted this permission. This will only be populated if the
+      #  type is `GROUP`.
       # @param type [Merge::Filestorage::TypeEnum] Denotes what type of people have access to the file.
       #  - `USER` - USER
       #  - `GROUP` - GROUP

data/lib/merge_ruby_client/filestorage/types/permission_request_group.rb

@@ -5,7 +5,8 @@ require_relative "group"
 
 module Merge
   module Filestorage
-    # The group that is granted this permission.
+    # The group that is granted this permission. This will only be populated if the
+    #  type is `GROUP`.
     class PermissionRequestGroup
       # Deserialize a JSON object to an instance of PermissionRequestGroup
       #

data/lib/merge_ruby_client/filestorage/types/permission_request_user.rb

@@ -5,7 +5,8 @@ require_relative "user"
 
 module Merge
   module Filestorage
-    # The user that is granted this permission.
+    # The user that is granted this permission. This will only be populated if the
+    #  type is `USER`.
     class PermissionRequestUser
       # Deserialize a JSON object to an instance of PermissionRequestUser
       #

data/lib/merge_ruby_client/filestorage/types/permission_user.rb

@@ -5,7 +5,8 @@ require_relative "user"
 
 module Merge
   module Filestorage
-    # The user that is granted this permission.
+    # The user that is granted this permission. This will only be populated if the
+    #  type is `USER`.
     class PermissionUser
       # Deserialize a JSON object to an instance of PermissionUser
       #

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Merge
+  module Filestorage
+    # # 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] The third-party API path that is being called.
+      attr_reader :path
+      # @return [Object]
+      attr_reader :data
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @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::Filestorage::RemoteData]
+      def initialize(path:, data: OMIT, additional_properties: nil)
+        @path = path
+        @data = data if data != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "path": path, "data": data }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of RemoteData
+      #
+      # @param json_object [String]
+      # @return [Merge::Filestorage::RemoteData]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        path = parsed_json["path"]
+        data = parsed_json["data"]
+        new(
+          path: path,
+          data: data,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of RemoteData to a JSON object
+      #
+      # @return [String]
+      def to_json(*_args)
+        @_field_set&.to_json
+      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:)
+        obj.path.is_a?(String) != false || raise("Passed value for field obj.path is not the expected type, validation failed.")
+        obj.data&.is_a?(Object) != false || raise("Passed value for field obj.data is not the expected type, validation failed.")
+      end
+    end
+  end
+end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "date"
+require_relative "remote_data"
 require "ostruct"
 require "json"
 
@@ -28,11 +29,13 @@ module Merge
       # @return [Boolean] Whether the user is the one who linked this account.
       attr_reader :is_me
       # @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
-      # @return [Array<Hash{String => Object}>]
+      # @return [Array<Merge::Filestorage::RemoteData>]
       attr_reader :remote_data
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
@@ -51,9 +54,11 @@ module Merge
       #  linked accounts.
       # @param is_me [Boolean] Whether the user is the one who linked this account.
       # @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 remote_data [Array<Merge::Filestorage::RemoteData>]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Merge::Filestorage::User]
       def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, name: OMIT, email_address: OMIT,
@@ -101,7 +106,10 @@ module Merge
         is_me = parsed_json["is_me"]
         remote_was_deleted = parsed_json["remote_was_deleted"]
         field_mappings = parsed_json["field_mappings"]
-        remote_data = parsed_json["remote_data"]
+        remote_data = parsed_json["remote_data"]&.map do |item|
+          item = item.to_json
+          Merge::Filestorage::RemoteData.from_json(json_object: item)
+        end
         new(
           id: id,
           remote_id: remote_id,

data/lib/merge_ruby_client/filestorage/users/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 is_me [String] If provided, will only return the user object for requestor.
       # @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
@@ -42,7 +47,7 @@ module Merge
       #  )
       #  api.filestorage.users.list
       def list(created_after: nil, created_before: nil, cursor: nil, include_deleted_data: nil,
-               include_remote_data: nil, is_me: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_id: nil, request_options: nil)
+               include_remote_data: nil, include_shell_data: nil, is_me: 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?
@@ -59,6 +64,7 @@ module Merge
             "cursor": cursor,
             "include_deleted_data": include_deleted_data,
             "include_remote_data": include_remote_data,
+            "include_shell_data": include_shell_data,
             "is_me": is_me,
             "modified_after": modified_after,
             "modified_before": modified_before,
@@ -125,9 +131,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 is_me [String] If provided, will only return the user object for requestor.
       # @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
@@ -144,7 +155,7 @@ module Merge
       #  )
       #  api.filestorage.users.list
       def list(created_after: nil, created_before: nil, cursor: nil, include_deleted_data: nil,
-               include_remote_data: nil, is_me: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_id: nil, request_options: nil)
+               include_remote_data: nil, include_shell_data: nil, is_me: 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?
@@ -162,6 +173,7 @@ module Merge
               "cursor": cursor,
               "include_deleted_data": include_deleted_data,
               "include_remote_data": include_remote_data,
+              "include_shell_data": include_shell_data,
               "is_me": is_me,
               "modified_after": modified_after,
               "modified_before": modified_before,

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