Class: ModernTreasury::Resources::BulkResults

Inherits:

Object

• Object
• ModernTreasury::Resources::BulkResults

Defined in:

lib/modern_treasury/resources/bulk_results.rb

Instance Method Summary

• #initialize(client:) ⇒ BulkResults constructor private

  A new instance of BulkResults.

• #list(after_cursor: nil, entity_id: nil, entity_type: nil, per_page: nil, request_id: nil, request_type: nil, status: nil, request_options: {}) ⇒ ModernTreasury::Internal::Page<ModernTreasury::Models::BulkResult>

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

• #retrieve(id, request_options: {}) ⇒ ModernTreasury::Models::BulkResult

  get bulk_result.

Constructor Details

#initialize(client:) ⇒ BulkResults

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

Parameters:

• client (ModernTreasury::Client)

# File 'lib/modern_treasury/resources/bulk_results.rb', line 67

def initialize(client:)
  @client = client
end

Instance Method Details

#list(after_cursor: nil, entity_id: nil, entity_type: nil, per_page: nil, request_id: nil, request_type: nil, status: nil, request_options: {}) ⇒ ModernTreasury::Internal::Page<ModernTreasury::Models::BulkResult>

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

list bulk_results

Parameters:

• after_cursor (String, nil)
• entity_id (String) —

  Unique identifier for the result entity object.

• entity_type (Symbol, ModernTreasury::Models::BulkResultListParams::EntityType) —

  The type of the request that created this result. bulk_request is the only suppo

• per_page (Integer)
• request_id (String) —

  Unique identifier for the request that created this bulk result. This is the ID

• request_type (Symbol, ModernTreasury::Models::BulkResultListParams::RequestType) —

  The type of the request that created this result. bulk_request is the only suppo

• status (Symbol, ModernTreasury::Models::BulkResultListParams::Status) —

  One of successful or failed.

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

Returns:

• (ModernTreasury::Internal::Page<ModernTreasury::Models::BulkResult>)

See Also:

• Models::BulkResultListParams

# File 'lib/modern_treasury/resources/bulk_results.rb', line 52

def list(params = {})
  parsed, options = ModernTreasury::BulkResultListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "api/bulk_results",
    query: parsed,
    page: ModernTreasury::Internal::Page,
    model: ModernTreasury::BulkResult,
    options: options
  )
end

#retrieve(id, request_options: {}) ⇒ ModernTreasury::Models::BulkResult

get bulk_result

Parameters:

• id (String) —

  id

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

Returns:

• (ModernTreasury::Models::BulkResult)

See Also:

• Models::BulkResultRetrieveParams

# File 'lib/modern_treasury/resources/bulk_results.rb', line 17

def retrieve(id, params = {})
  @client.request(
    method: :get,
    path: ["api/bulk_results/%1$s", id],
    model: ModernTreasury::BulkResult,
    options: params[:request_options]
  )
end