Class: Merge::Filestorage::FilesClient

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/filestorage/files/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Merge::Filestorage::FilesClient

Parameters:



26
27
28
 
# File 'lib/merge_ruby_client/filestorage/files/client.rb', line 26

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Merge::RequestClient (readonly)

Returns:



22
23
24
 
# File 'lib/merge_ruby_client/filestorage/files/client.rb', line 22

def request_client
  @request_client
end

Instance Method Details

#create(model:, is_debug_mode: nil, run_async: nil, request_options: nil) ⇒ Merge::Filestorage::FileStorageFileResponse

Creates a ‘File` object with the given values.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.filestorage.files.create(model: {  })

Parameters:

  • is_debug_mode (Boolean) (defaults to: nil) —

    Whether to include debug fields (such as log file links) in the response.

  • run_async (Boolean) (defaults to: nil) —

    Whether or not third-party updates should be run asynchronously.

  • model (Hash) —

    Request of type Merge::Filestorage::FileRequest, as a Hash

    • :name (String)

    • :file_url (String)

    • :file_thumbnail_url (String)

    • :size (Long)

    • :mime_type (String)

    • :description (String)

    • :folder (Hash)

    • :checksum (Hash=> Object)

    • :permissions (Hash)

    • :drive (Hash)

    • :integration_params (Hash=> Object)

    • :linked_account_params (Hash=> Object)

  • request_options (Merge::RequestOptions) (defaults to: nil)

Returns:



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/merge_ruby_client/filestorage/files/client.rb', line 139

def create(model:, is_debug_mode: nil, run_async: nil, request_options: nil)
  response = @request_client.conn.post do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
    req.headers["X-Account-Token"] = request_options. unless request_options&..nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    req.params = {
      **(request_options&.additional_query_parameters || {}),
      "is_debug_mode": is_debug_mode,
      "run_async": run_async
    }.compact
    req.body = { **(request_options&.additional_body_parameters || {}), model: model }.compact
    req.url "#{@request_client.get_url(request_options: request_options)}/filestorage/v1/files"
  end
  Merge::Filestorage::FileStorageFileResponse.from_json(json_object: response.body)
end

#download_request_meta_list(created_after: nil, created_before: nil, cursor: nil, ids: nil, include_deleted_data: nil, mime_types: nil, modified_after: nil, modified_before: nil, order_by: nil, page_size: nil, request_options: nil) ⇒ Merge::Filestorage::PaginatedDownloadRequestMetaList

Returns metadata to construct authenticated file download requests, allowing you

to download files directly from the third-party.

Examples:

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(cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw")

Parameters:

  • created_after (String) (defaults to: nil) —

    If provided, will only return objects created after this datetime.

  • created_before (String) (defaults to: nil) —

    If provided, will only return objects created before this datetime.

  • cursor (String) (defaults to: nil) —

    The pagination cursor value.

  • ids (String) (defaults to: nil) —

    If provided, will only return objects with the given IDs. Comma-separated list of strings.

  • include_deleted_data (Boolean) (defaults to: nil) —

    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](docs.merge.dev/integrations/hris/supported-features/).

  • mime_types (String) (defaults to: nil) —

    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>.

  • modified_after (String) (defaults to: nil) —

    If provided, will only return objects modified after this datetime.

  • modified_before (String) (defaults to: nil) —

    If provided, will only return objects modified before this datetime.

  • order_by (Merge::Filestorage::Files::FilesDownloadRequestMetaListRequestOrderBy) (defaults to: nil) —

    Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at.

  • page_size (Integer) (defaults to: nil) —

    Number of results to return per page.

  • request_options (Merge::RequestOptions) (defaults to: nil)

Returns:



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/merge_ruby_client/filestorage/files/client.rb', line 308

def download_request_meta_list(created_after: nil, created_before: nil, cursor: nil, ids: 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. unless request_options&..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,
      "ids": ids,
      "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

#download_request_meta_retrieve(id:, mime_type: nil, request_options: nil) ⇒ Merge::Filestorage::DownloadRequestMeta

Returns metadata to construct an authenticated file download request for a

singular file, allowing you to download file directly from the third-party.

Examples:

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_retrieve(id: "id")

Parameters:

  • id (String)
  • mime_type (String) (defaults to: nil) —

    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>.

  • request_options (Merge::RequestOptions) (defaults to: nil)

Returns:



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/merge_ruby_client/filestorage/files/client.rb', line 257

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. unless request_options&..nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    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/request-meta"
  end
  Merge::Filestorage::DownloadRequestMeta.from_json(json_object: response.body)
end

#download_retrieve(id:, include_shell_data: nil, mime_type: nil, request_options: nil, &on_data) ⇒ Void

Returns the ‘File` content with the given `id` as a stream of bytes.

Parameters:

  • id (String)
  • include_shell_data (Boolean) (defaults to: nil) —

    Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

  • mime_type (String) (defaults to: nil) —

    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>.

  • request_options (Merge::RequestOptions) (defaults to: nil)

Returns:

  • (Void) 


217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/merge_ruby_client/filestorage/files/client.rb', line 217

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. unless request_options&..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

#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, order_by: nil, page_size: nil, remote_created_after: nil, remote_created_before: nil, remote_id: nil, request_options: nil) ⇒ Merge::Filestorage::PaginatedFileList

Returns a list of ‘File` objects.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.filestorage.files.list(cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw")

Parameters:

  • created_after (DateTime) (defaults to: nil) —

    If provided, will only return objects created after this datetime.

  • created_before (DateTime) (defaults to: nil) —

    If provided, will only return objects created before this datetime.

  • cursor (String) (defaults to: nil) —

    The pagination cursor value.

  • drive_id (String) (defaults to: nil) —

    Specifying a drive id returns only the files in that drive. Specifying null returns only the files outside the top-level drive.

  • expand (Merge::Filestorage::Files::FilesListRequestExpand) (defaults to: nil) —

    Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

  • folder_id (String) (defaults to: nil) —

    Specifying a folder id returns only the files in that folder. Specifying null returns only the files in root directory.

  • include_deleted_data (Boolean) (defaults to: nil) —

    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](docs.merge.dev/integrations/hris/supported-features/).

  • include_remote_data (Boolean) (defaults to: nil) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

  • include_shell_data (Boolean) (defaults to: nil) —

    Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

  • mime_type (String) (defaults to: nil) —

    If provided, will only return files with these mime_types. Multiple values can be separated by commas.

  • modified_after (DateTime) (defaults to: nil) —

    If provided, only objects synced by Merge after this date time will be returned.

  • modified_before (DateTime) (defaults to: nil) —

    If provided, only objects synced by Merge before this date time will be returned.

  • name (String) (defaults to: nil) —

    If provided, will only return files with this name. This performs an exact match.

  • order_by (Merge::Filestorage::Files::FilesListRequestOrderBy) (defaults to: nil) —

    Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at.

  • page_size (Integer) (defaults to: nil) —

    Number of results to return per page.

  • remote_created_after (DateTime) (defaults to: nil) —

    If provided, will only return files created in the third party platform after this datetime.

  • remote_created_before (DateTime) (defaults to: nil) —

    If provided, will only return files created in the third party platform before this datetime.

  • remote_id (String) (defaults to: nil) —

    The API provider’s ID for the given object.

  • request_options (Merge::RequestOptions) (defaults to: nil)

Returns:



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/merge_ruby_client/filestorage/files/client.rb', line 73

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, order_by: nil, page_size: nil, remote_created_after: nil, remote_created_before: 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?
    req.headers["X-Account-Token"] = request_options. unless request_options&..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,
      "drive_id": drive_id,
      "expand": expand,
      "folder_id": folder_id,
      "include_deleted_data": include_deleted_data,
      "include_remote_data": include_remote_data,
      "include_shell_data": include_shell_data,
      "mime_type": mime_type,
      "modified_after": modified_after,
      "modified_before": modified_before,
      "name": name,
      "order_by": order_by,
      "page_size": page_size,
      "remote_created_after": remote_created_after,
      "remote_created_before": remote_created_before,
      "remote_id": remote_id
    }.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"
  end
  Merge::Filestorage::PaginatedFileList.from_json(json_object: response.body)
end

#meta_post_retrieve(request_options: nil) ⇒ Merge::Filestorage::MetaResponse

Returns metadata for ‘FileStorageFile` POSTs.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.filestorage.files.meta_post_retrieve

Parameters:

Returns:



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/merge_ruby_client/filestorage/files/client.rb', line 351

def meta_post_retrieve(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. unless request_options&..nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    unless request_options.nil? || request_options&.additional_query_parameters.nil?
      req.params = { **(request_options&.additional_query_parameters || {}) }.compact
    end
    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/meta/post"
  end
  Merge::Filestorage::MetaResponse.from_json(json_object: response.body)
end

#retrieve(id:, expand: nil, include_remote_data: nil, include_shell_data: nil, request_options: nil) ⇒ Merge::Filestorage::File

Returns a ‘File` object with the given `id`.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.filestorage.files.retrieve(id: "id")

Parameters:

  • id (String)
  • expand (Merge::Filestorage::Files::FilesRetrieveRequestExpand) (defaults to: nil) —

    Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

  • include_remote_data (Boolean) (defaults to: nil) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

  • include_shell_data (Boolean) (defaults to: nil) —

    Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

  • request_options (Merge::RequestOptions) (defaults to: nil)

Returns:



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/merge_ruby_client/filestorage/files/client.rb', line 178

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?
    req.headers["X-Account-Token"] = request_options. unless request_options&..nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    req.params = {
      **(request_options&.additional_query_parameters || {}),
      "expand": expand,
      "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
    end
    req.url "#{@request_client.get_url(request_options: request_options)}/filestorage/v1/files/#{id}"
  end
  Merge::Filestorage::File.from_json(json_object: response.body)
end