Class: MethodRuby::Resources::Reports::Download

Inherits:

Object

• Object
• MethodRuby::Resources::Reports::Download

Defined in:

lib/method_ruby/resources/reports/download.rb

Overview

Downloadable reports

Instance Method Summary

• #initialize(client:) ⇒ Download constructor private

  A new instance of Download.

• #retrieve(report_id, method_version:, request_options: {}) ⇒ StringIO

  Some parameter documentations has been truncated, see Models::Reports::DownloadRetrieveParams for more details.

Constructor Details

#initialize(client:) ⇒ Download

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Download.

Parameters:

• client (MethodRuby::Client)

# File 'lib/method_ruby/resources/reports/download.rb', line 39

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(report_id, method_version:, request_options: {}) ⇒ StringIO

Some parameter documentations has been truncated, see Models::Reports::DownloadRetrieveParams for more details.

Returns the completed report as a CSV file attachment.

Parameters:

• report_id (String) —

  Unique identifier for the report.

• method_version (Symbol, MethodRuby::Models::Reports::DownloadRetrieveParams::MethodVersion) —

  API version to use for this request. This spec targets ‘2025-12-01`.

• request_options (MethodRuby::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (StringIO)

See Also:

• Models::Reports::DownloadRetrieveParams

# File 'lib/method_ruby/resources/reports/download.rb', line 24

def retrieve(report_id, params)
  parsed, options = MethodRuby::Reports::DownloadRetrieveParams.dump_request(params)
  @client.request(
    method: :get,
    path: ["reports/%1$s/download", report_id],
    headers: {"accept" => "text/csv", **parsed}.transform_keys(method_version: "method-version"),
    model: MethodRuby::Internal::Type::FileInput,
    security: {secret_key: true},
    options: options
  )
end