merge_ruby_client 1.0.0 → 1.1.0

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

@@ -41,8 +41,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 [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
@@ -75,8 +75,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 remote_was_deleted [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

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/users/client.rb

@@ -91,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
@@ -100,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?
@@ -113,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
@@ -297,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
@@ -306,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?
@@ -320,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

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

@@ -25,10 +25,11 @@ module Merge
       #  `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`,
       #  `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `INVITED_USER`,
       #  `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`,
-      #  `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`,
-      #  `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`,
-      #  `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`,
-      #  `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`,
+      #  `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`,
+      #  `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`,
+      #  `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`,
+      #  `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`,
+      #  `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`,
       #  `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`,
       #  `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`,
       #  `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`,
@@ -107,10 +108,11 @@ module Merge
       #  `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`,
       #  `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `INVITED_USER`,
       #  `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`,
-      #  `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`,
-      #  `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`,
-      #  `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`,
-      #  `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`,
+      #  `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`,
+      #  `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`,
+      #  `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`,
+      #  `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`,
+      #  `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`,
       #  `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`,
       #  `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`,
       #  `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`,

data/lib/merge_ruby_client/filestorage/drives/client.rb

@@ -85,6 +85,8 @@ module Merge
       # @param id [String]
       # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
+      # @param include_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Filestorage::Drive]
       # @example
@@ -94,7 +96,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.filestorage.drives.retrieve(id: "id")
-      def retrieve(id:, include_remote_data: nil, request_options: nil)
+      def retrieve(id:, include_remote_data: nil, include_shell_data: nil, request_options: nil)
         response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
@@ -106,7 +108,8 @@ module Merge
           }.compact
           req.params = {
             **(request_options&.additional_query_parameters || {}),
-            "include_remote_data": include_remote_data
+            "include_remote_data": include_remote_data,
+            "include_shell_data": include_shell_data
           }.compact
           unless request_options.nil? || request_options&.additional_body_parameters.nil?
             req.body = { **(request_options&.additional_body_parameters || {}) }.compact
@@ -196,6 +199,8 @@ module Merge
       # @param id [String]
       # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
+      # @param include_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Filestorage::Drive]
       # @example
@@ -205,7 +210,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.filestorage.drives.retrieve(id: "id")
-      def retrieve(id:, include_remote_data: nil, request_options: nil)
+      def retrieve(id:, include_remote_data: nil, include_shell_data: nil, request_options: nil)
         Async do
           response = @request_client.conn.get do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -218,7 +223,8 @@ module Merge
             }.compact
             req.params = {
               **(request_options&.additional_query_parameters || {}),
-              "include_remote_data": include_remote_data
+              "include_remote_data": include_remote_data,
+              "include_shell_data": include_shell_data
             }.compact
             unless request_options.nil? || request_options&.additional_body_parameters.nil?
               req.body = { **(request_options&.additional_body_parameters || {}) }.compact

data/lib/merge_ruby_client/filestorage/files/client.rb

@@ -8,6 +8,8 @@ require_relative "../types/file_request"
 require_relative "../types/file_storage_file_response"
 require_relative "types/files_retrieve_request_expand"
 require_relative "../types/file"
+require_relative "../types/download_request_meta"
+require_relative "../types/paginated_download_request_meta_list"
 require_relative "../types/meta_response"
 require "async"
 
@@ -150,6 +152,8 @@ module Merge
       #  should be comma separated without spaces.
       # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
+      # @param include_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Filestorage::File]
       # @example
@@ -159,7 +163,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.filestorage.files.retrieve(id: "id")
-      def retrieve(id:, expand: nil, include_remote_data: nil, request_options: nil)
+      def retrieve(id:, expand: nil, include_remote_data: nil, include_shell_data: nil, request_options: nil)
         response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
@@ -172,7 +176,8 @@ module Merge
           req.params = {
             **(request_options&.additional_query_parameters || {}),
             "expand": expand,
-            "include_remote_data": include_remote_data
+            "include_remote_data": include_remote_data,
+            "include_shell_data": include_shell_data
           }.compact
           unless request_options.nil? || request_options&.additional_body_parameters.nil?
             req.body = { **(request_options&.additional_body_parameters || {}) }.compact
@@ -185,6 +190,8 @@ module Merge
       # Returns the `File` content with the given `id` as a stream of bytes.
       #
       # @param id [String]
+      # @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 mime_type [String] If provided, specifies the export format of the file to be downloaded. For
       #  information on supported export formats, please refer to our <a
       #  tps://help.merge.dev/en/articles/8615316-file-export-and-download-specification'
@@ -195,15 +202,48 @@ module Merge
       #  response environment. The latter will allow access to the response status,
       #  headers and reason, as well as the request info.
       # @return [Void]
+      def download_retrieve(id:, include_shell_data: nil, mime_type: nil, request_options: nil, &on_data)
+        @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?
+          req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          req.options.on_data = on_data
+          req.params = {
+            **(request_options&.additional_query_parameters || {}),
+            "include_shell_data": include_shell_data,
+            "mime_type": mime_type
+          }.compact
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(request_options: request_options)}/filestorage/v1/files/#{id}/download"
+        end
+      end
+
+      # Returns metadata to construct an authenticated file download request for a
+      #  singular file, allowing you to download file directly from the third-party.
+      #
+      # @param id [String]
+      # @param mime_type [String] If provided, specifies the export format of the file to be downloaded. For
+      #  information on supported export formats, please refer to our <a
+      #  tps://help.merge.dev/en/articles/8615316-file-export-and-download-specification'
+      #  target='_blank'>export format help center article</a>.
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Filestorage::DownloadRequestMeta]
       # @example
       #  api = Merge::Client.new(
       #    base_url: "https://api.example.com",
       #    environment: Merge::Environment::PRODUCTION,
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
-      #  api.filestorage.files.download_retrieve(id: "string", mime_type: "string")
-      def download_retrieve(id:, mime_type: nil, request_options: nil, &on_data)
-        @request_client.conn.get do |req|
+      #  api.filestorage.files.download_request_meta_retrieve(id: "id")
+      def download_request_meta_retrieve(id:, mime_type: 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?
           req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
@@ -212,13 +252,61 @@ module Merge
         **@request_client.get_headers,
         **(request_options&.additional_headers || {})
           }.compact
-          req.options.on_data = on_data
           req.params = { **(request_options&.additional_query_parameters || {}), "mime_type": mime_type }.compact
           unless request_options.nil? || request_options&.additional_body_parameters.nil?
             req.body = { **(request_options&.additional_body_parameters || {}) }.compact
           end
-          req.url "#{@request_client.get_url(request_options: request_options)}/filestorage/v1/files/#{id}/download"
+          req.url "#{@request_client.get_url(request_options: request_options)}/filestorage/v1/files/#{id}/download/request-meta"
         end
+        Merge::Filestorage::DownloadRequestMeta.from_json(json_object: response.body)
+      end
+
+      # Returns metadata to construct authenticated file download requests, allowing you
+      #  to download files directly from the third-party.
+      #
+      # @param cursor [String] The pagination cursor value.
+      # @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 mime_type [String] If provided, specifies the export format of the files to be downloaded. For
+      #  information on supported export formats, please refer to our <a
+      #  tps://help.merge.dev/en/articles/8615316-file-export-and-download-specification'
+      #  target='_blank'>export format help center article</a>.
+      # @param page_size [Integer] Number of results to return per page.
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Filestorage::PaginatedDownloadRequestMetaList]
+      # @example
+      #  api = Merge::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Merge::Environment::PRODUCTION,
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.filestorage.files.download_request_meta_list
+      def download_request_meta_list(cursor: nil, include_deleted_data: nil, mime_type: 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?
+          req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          req.params = {
+            **(request_options&.additional_query_parameters || {}),
+            "cursor": cursor,
+            "include_deleted_data": include_deleted_data,
+            "mime_type": mime_type,
+            "page_size": page_size
+          }.compact
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(request_options: request_options)}/filestorage/v1/files/download/request-meta"
+        end
+        Merge::Filestorage::PaginatedDownloadRequestMetaList.from_json(json_object: response.body)
       end
 
       # Returns metadata for `FileStorageFile` POSTs.
@@ -395,6 +483,8 @@ module Merge
       #  should be comma separated without spaces.
       # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
+      # @param include_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Filestorage::File]
       # @example
@@ -404,7 +494,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.filestorage.files.retrieve(id: "id")
-      def retrieve(id:, expand: nil, include_remote_data: nil, request_options: nil)
+      def retrieve(id:, expand: nil, include_remote_data: nil, include_shell_data: nil, request_options: nil)
         Async do
           response = @request_client.conn.get do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -418,7 +508,8 @@ module Merge
             req.params = {
               **(request_options&.additional_query_parameters || {}),
               "expand": expand,
-              "include_remote_data": include_remote_data
+              "include_remote_data": include_remote_data,
+              "include_shell_data": include_shell_data
             }.compact
             unless request_options.nil? || request_options&.additional_body_parameters.nil?
               req.body = { **(request_options&.additional_body_parameters || {}) }.compact
@@ -432,6 +523,8 @@ module Merge
       # Returns the `File` content with the given `id` as a stream of bytes.
       #
       # @param id [String]
+      # @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 mime_type [String] If provided, specifies the export format of the file to be downloaded. For
       #  information on supported export formats, please refer to our <a
       #  tps://help.merge.dev/en/articles/8615316-file-export-and-download-specification'
@@ -442,16 +535,51 @@ module Merge
       #  response environment. The latter will allow access to the response status,
       #  headers and reason, as well as the request info.
       # @return [Void]
+      def download_retrieve(id:, include_shell_data: nil, mime_type: nil, request_options: nil, &on_data)
+        Async do
+          @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?
+            req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
+            req.options.on_data = on_data
+            req.params = {
+              **(request_options&.additional_query_parameters || {}),
+              "include_shell_data": include_shell_data,
+              "mime_type": mime_type
+            }.compact
+            unless request_options.nil? || request_options&.additional_body_parameters.nil?
+              req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+            end
+            req.url "#{@request_client.get_url(request_options: request_options)}/filestorage/v1/files/#{id}/download"
+          end
+        end
+      end
+
+      # Returns metadata to construct an authenticated file download request for a
+      #  singular file, allowing you to download file directly from the third-party.
+      #
+      # @param id [String]
+      # @param mime_type [String] If provided, specifies the export format of the file to be downloaded. For
+      #  information on supported export formats, please refer to our <a
+      #  tps://help.merge.dev/en/articles/8615316-file-export-and-download-specification'
+      #  target='_blank'>export format help center article</a>.
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Filestorage::DownloadRequestMeta]
       # @example
       #  api = Merge::Client.new(
       #    base_url: "https://api.example.com",
       #    environment: Merge::Environment::PRODUCTION,
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
-      #  api.filestorage.files.download_retrieve(id: "string", mime_type: "string")
-      def download_retrieve(id:, mime_type: nil, request_options: nil, &on_data)
+      #  api.filestorage.files.download_request_meta_retrieve(id: "id")
+      def download_request_meta_retrieve(id:, mime_type: nil, request_options: nil)
         Async do
-          @request_client.conn.get do |req|
+          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?
             req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
@@ -460,13 +588,63 @@ module Merge
           **@request_client.get_headers,
           **(request_options&.additional_headers || {})
             }.compact
-            req.options.on_data = on_data
             req.params = { **(request_options&.additional_query_parameters || {}), "mime_type": mime_type }.compact
             unless request_options.nil? || request_options&.additional_body_parameters.nil?
               req.body = { **(request_options&.additional_body_parameters || {}) }.compact
             end
-            req.url "#{@request_client.get_url(request_options: request_options)}/filestorage/v1/files/#{id}/download"
+            req.url "#{@request_client.get_url(request_options: request_options)}/filestorage/v1/files/#{id}/download/request-meta"
+          end
+          Merge::Filestorage::DownloadRequestMeta.from_json(json_object: response.body)
+        end
+      end
+
+      # Returns metadata to construct authenticated file download requests, allowing you
+      #  to download files directly from the third-party.
+      #
+      # @param cursor [String] The pagination cursor value.
+      # @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 mime_type [String] If provided, specifies the export format of the files to be downloaded. For
+      #  information on supported export formats, please refer to our <a
+      #  tps://help.merge.dev/en/articles/8615316-file-export-and-download-specification'
+      #  target='_blank'>export format help center article</a>.
+      # @param page_size [Integer] Number of results to return per page.
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Filestorage::PaginatedDownloadRequestMetaList]
+      # @example
+      #  api = Merge::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Merge::Environment::PRODUCTION,
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.filestorage.files.download_request_meta_list
+      def download_request_meta_list(cursor: nil, include_deleted_data: nil, mime_type: 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?
+            req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+            req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
+            req.params = {
+              **(request_options&.additional_query_parameters || {}),
+              "cursor": cursor,
+              "include_deleted_data": include_deleted_data,
+              "mime_type": mime_type,
+              "page_size": page_size
+            }.compact
+            unless request_options.nil? || request_options&.additional_body_parameters.nil?
+              req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+            end
+            req.url "#{@request_client.get_url(request_options: request_options)}/filestorage/v1/files/download/request-meta"
           end
+          Merge::Filestorage::PaginatedDownloadRequestMetaList.from_json(json_object: response.body)
         end
       end
 

data/lib/merge_ruby_client/filestorage/folders/client.rb

@@ -144,6 +144,8 @@ module Merge
       #  should be comma separated without spaces.
       # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
+      # @param include_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Filestorage::Folder]
       # @example
@@ -153,7 +155,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.filestorage.folders.retrieve(id: "id")
-      def retrieve(id:, expand: nil, include_remote_data: nil, request_options: nil)
+      def retrieve(id:, expand: nil, include_remote_data: nil, include_shell_data: nil, request_options: nil)
         response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
@@ -166,7 +168,8 @@ module Merge
           req.params = {
             **(request_options&.additional_query_parameters || {}),
             "expand": expand,
-            "include_remote_data": include_remote_data
+            "include_remote_data": include_remote_data,
+            "include_shell_data": include_shell_data
           }.compact
           unless request_options.nil? || request_options&.additional_body_parameters.nil?
             req.body = { **(request_options&.additional_body_parameters || {}) }.compact
@@ -344,6 +347,8 @@ module Merge
       #  should be comma separated without spaces.
       # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
+      # @param include_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Filestorage::Folder]
       # @example
@@ -353,7 +358,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.filestorage.folders.retrieve(id: "id")
-      def retrieve(id:, expand: nil, include_remote_data: nil, request_options: nil)
+      def retrieve(id:, expand: nil, include_remote_data: nil, include_shell_data: nil, request_options: nil)
         Async do
           response = @request_client.conn.get do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -367,7 +372,8 @@ module Merge
             req.params = {
               **(request_options&.additional_query_parameters || {}),
               "expand": expand,
-              "include_remote_data": include_remote_data
+              "include_remote_data": include_remote_data,
+              "include_shell_data": include_shell_data
             }.compact
             unless request_options.nil? || request_options&.additional_body_parameters.nil?
               req.body = { **(request_options&.additional_body_parameters || {}) }.compact

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

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