merge_ruby_client 1.0.0 → 2.0.0

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

@@ -3,11 +3,15 @@
 require_relative "../../../requests"
 require "date"
 require_relative "types/files_list_request_expand"
+require_relative "types/files_list_request_order_by"
 require_relative "../types/paginated_file_list"
 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/files_download_request_meta_list_request_order_by"
+require_relative "../types/paginated_download_request_meta_list"
 require_relative "../types/meta_response"
 require "async"
 
@@ -49,6 +53,8 @@ module Merge
       #  returned.
       # @param name [String] If provided, will only return files with this name. This performs an exact
       #  match.
+      # @param order_by [Merge::Filestorage::Files::FilesListRequestOrderBy] Overrides the default ordering for this endpoint. Possible values include:
+      #  created_at, -created_at, modified_at, -modified_at.
       # @param page_size [Integer] Number of results to return per page.
       # @param remote_id [String] The API provider's ID for the given object.
       # @param request_options [Merge::RequestOptions]
@@ -61,7 +67,7 @@ module Merge
       #  )
       #  api.filestorage.files.list
       def list(created_after: nil, created_before: nil, cursor: nil, drive_id: nil, expand: nil, folder_id: nil,
-               include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil, mime_type: nil, modified_after: nil, modified_before: nil, name: nil, page_size: nil, remote_id: nil, request_options: nil)
+               include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil, mime_type: nil, modified_after: nil, modified_before: nil, name: nil, order_by: 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?
@@ -86,6 +92,7 @@ module Merge
             "modified_after": modified_after,
             "modified_before": modified_before,
             "name": name,
+            "order_by": order_by,
             "page_size": page_size,
             "remote_id": remote_id
           }.compact
@@ -109,6 +116,7 @@ module Merge
       #   * :mime_type (String)
       #   * :description (String)
       #   * :folder (Hash)
+      #   * :checksum (Hash{String => Object})
       #   * :permissions (Hash)
       #   * :drive (Hash)
       #   * :integration_params (Hash{String => Object})
@@ -150,6 +158,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 +169,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 +182,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 +196,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 +208,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 +258,74 @@ 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 created_after [String] If provided, will only return objects created after this datetime.
+      # @param created_before [String] If provided, will only return objects created before this datetime.
+      # @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_types [String] A comma-separated list of preferred MIME types in order of priority. If
+      #  supported by the third-party provider, the file(s) will be returned in the first
+      #  supported MIME type from the list. The default MIME type is PDF. To see
+      #  supported MIME types by file type, 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 modified_after [String] If provided, will only return objects modified after this datetime.
+      # @param modified_before [String] If provided, will only return objects modified before this datetime.
+      # @param order_by [Merge::Filestorage::Files::FilesDownloadRequestMetaListRequestOrderBy] Overrides the default ordering for this endpoint. Possible values include:
+      #  created_at, -created_at, modified_at, -modified_at.
+      # @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(created_after: nil, created_before: nil, cursor: nil, include_deleted_data: nil,
+                                     mime_types: nil, modified_after: nil, modified_before: nil, order_by: 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 || {}),
+            "created_after": created_after,
+            "created_before": created_before,
+            "cursor": cursor,
+            "include_deleted_data": include_deleted_data,
+            "mime_types": mime_types,
+            "modified_after": modified_after,
+            "modified_before": modified_before,
+            "order_by": order_by,
+            "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.
@@ -290,6 +397,8 @@ module Merge
       #  returned.
       # @param name [String] If provided, will only return files with this name. This performs an exact
       #  match.
+      # @param order_by [Merge::Filestorage::Files::FilesListRequestOrderBy] Overrides the default ordering for this endpoint. Possible values include:
+      #  created_at, -created_at, modified_at, -modified_at.
       # @param page_size [Integer] Number of results to return per page.
       # @param remote_id [String] The API provider's ID for the given object.
       # @param request_options [Merge::RequestOptions]
@@ -302,7 +411,7 @@ module Merge
       #  )
       #  api.filestorage.files.list
       def list(created_after: nil, created_before: nil, cursor: nil, drive_id: nil, expand: nil, folder_id: nil,
-               include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil, mime_type: nil, modified_after: nil, modified_before: nil, name: nil, page_size: nil, remote_id: nil, request_options: nil)
+               include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil, mime_type: nil, modified_after: nil, modified_before: nil, name: nil, order_by: 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?
@@ -328,6 +437,7 @@ module Merge
               "modified_after": modified_after,
               "modified_before": modified_before,
               "name": name,
+              "order_by": order_by,
               "page_size": page_size,
               "remote_id": remote_id
             }.compact
@@ -352,6 +462,7 @@ module Merge
       #   * :mime_type (String)
       #   * :description (String)
       #   * :folder (Hash)
+      #   * :checksum (Hash{String => Object})
       #   * :permissions (Hash)
       #   * :drive (Hash)
       #   * :integration_params (Hash{String => Object})
@@ -395,6 +506,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 +517,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 +531,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 +546,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 +558,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 +611,76 @@ 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 created_after [String] If provided, will only return objects created after this datetime.
+      # @param created_before [String] If provided, will only return objects created before this datetime.
+      # @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_types [String] A comma-separated list of preferred MIME types in order of priority. If
+      #  supported by the third-party provider, the file(s) will be returned in the first
+      #  supported MIME type from the list. The default MIME type is PDF. To see
+      #  supported MIME types by file type, 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 modified_after [String] If provided, will only return objects modified after this datetime.
+      # @param modified_before [String] If provided, will only return objects modified before this datetime.
+      # @param order_by [Merge::Filestorage::Files::FilesDownloadRequestMetaListRequestOrderBy] Overrides the default ordering for this endpoint. Possible values include:
+      #  created_at, -created_at, modified_at, -modified_at.
+      # @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(created_after: nil, created_before: nil, cursor: nil, include_deleted_data: nil,
+                                     mime_types: nil, modified_after: nil, modified_before: nil, order_by: 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 || {}),
+              "created_after": created_after,
+              "created_before": created_before,
+              "cursor": cursor,
+              "include_deleted_data": include_deleted_data,
+              "mime_types": mime_types,
+              "modified_after": modified_after,
+              "modified_before": modified_before,
+              "order_by": order_by,
+              "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/files/types/files_download_request_meta_list_request_order_by.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Merge
+  module Filestorage
+    class Files
+      class FilesDownloadRequestMetaListRequestOrderBy
+        CREATED_AT_DESCENDING = "-created_at"
+        MODIFIED_AT_DESCENDING = "-modified_at"
+        CREATED_AT_ASCENDING = "created_at"
+        MODIFIED_AT_ASCENDING = "modified_at"
+      end
+    end
+  end
+end

data/lib/merge_ruby_client/filestorage/files/types/files_list_request_order_by.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Merge
+  module Filestorage
+    class Files
+      class FilesListRequestOrderBy
+        CREATED_AT_DESCENDING = "-created_at"
+        MODIFIED_AT_DESCENDING = "-modified_at"
+        CREATED_AT_ASCENDING = "created_at"
+        MODIFIED_AT_ASCENDING = "modified_at"
+      end
+    end
+  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>]

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

@@ -87,6 +87,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::Group]
       # @example
@@ -96,7 +98,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.filestorage.groups.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?
@@ -109,7 +111,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
@@ -201,6 +204,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::Group]
       # @example
@@ -210,7 +215,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.filestorage.groups.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?
@@ -224,7 +229,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/issues/client.rb

@@ -42,8 +42,8 @@ module Merge
       # @param start_date [String] If included, will only include issues whose most recent action occurred after
       #  this time
       # @param status [Merge::Filestorage::Issues::IssuesListRequestStatus] Status of the issue. Options: ('ONGOING', 'RESOLVED')
-      #  - `ONGOING` - ONGOING
-      #  - `RESOLVED` - RESOLVED
+      #  * `ONGOING` - ONGOING
+      #  * `RESOLVED` - RESOLVED
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Filestorage::PaginatedIssueList]
       # @example
@@ -156,8 +156,8 @@ module Merge
       # @param start_date [String] If included, will only include issues whose most recent action occurred after
       #  this time
       # @param status [Merge::Filestorage::Issues::IssuesListRequestStatus] Status of the issue. Options: ('ONGOING', 'RESOLVED')
-      #  - `ONGOING` - ONGOING
-      #  - `RESOLVED` - RESOLVED
+      #  * `ONGOING` - ONGOING
+      #  * `RESOLVED` - RESOLVED
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Filestorage::PaginatedIssueList]
       # @example