Class: Merge::Filestorage::AsyncFilesClient

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::AsyncFilesClient

Parameters:



379
380
381
 
# File 'lib/merge_ruby_client/filestorage/files/client.rb', line 379

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Merge::AsyncRequestClient (readonly)

Returns:



375
376
377
 
# File 'lib/merge_ruby_client/filestorage/files/client.rb', line 375

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:



494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/merge_ruby_client/filestorage/files/client.rb', line 494

def create(model:, is_debug_mode: nil, run_async: nil, request_options: nil)
  Async do
    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
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:



671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
 
# File 'lib/merge_ruby_client/filestorage/files/client.rb', line 671

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



618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
 
# File 'lib/merge_ruby_client/filestorage/files/client.rb', line 618

def download_request_meta_retrieve(id:, mime_type: 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. 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
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) 


576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
 
# File 'lib/merge_ruby_client/filestorage/files/client.rb', line 576

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



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/merge_ruby_client/filestorage/files/client.rb', line 426

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



716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
 
# File 'lib/merge_ruby_client/filestorage/files/client.rb', line 716

def meta_post_retrieve(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. 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
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:



535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
 
# File 'lib/merge_ruby_client/filestorage/files/client.rb', line 535

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?
      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
end