Class: ModernTreasury::Resources::BulkRequests

Inherits:

Object

• Object
• ModernTreasury::Resources::BulkRequests

Defined in:

lib/modern_treasury/resources/bulk_requests.rb

Instance Method Summary

• #create(action_type: , resource_type: , resources: , metadata: nil, request_options: {}) ⇒ ModernTreasury::Models::BulkRequest

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

• #initialize(client:) ⇒ BulkRequests constructor private

  A new instance of BulkRequests.

• #list(action_type: nil, after_cursor: nil, metadata: nil, per_page: nil, resource_type: nil, status: nil, request_options: {}) ⇒ ModernTreasury::Internal::Page<ModernTreasury::Models::BulkRequest>

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

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

  get bulk_request.

Constructor Details

#initialize(client:) ⇒ BulkRequests

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

Parameters:

• client (ModernTreasury::Client)

# File 'lib/modern_treasury/resources/bulk_requests.rb', line 96

def initialize(client:)
  @client = client
end

Instance Method Details

#create(action_type: , resource_type: , resources: , metadata: nil, request_options: {}) ⇒ ModernTreasury::Models::BulkRequest

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

create bulk_request

Parameters:

• action_type (Symbol, ModernTreasury::Models::BulkRequestCreateParams::ActionType) —

  One of create, or update.

• resource_type (Symbol, ModernTreasury::Models::BulkRequestCreateParams::ResourceType) —

  One of payment_order, expected_payment, or ledger_transaction.

• resources (Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest, ModernTreasury::Models::LedgerTransactionCreateRequest, ModernTreasury::Models::LedgerAccountCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ID, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID>) —

  An array of objects where each object contains the input params for a single ‘ac

• metadata (Hash{Symbol=>String}) —

  Additional data represented as key-value pairs. Both the key and value must be s

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

Returns:

• (ModernTreasury::Models::BulkRequest)

See Also:

• Models::BulkRequestCreateParams

# File 'lib/modern_treasury/resources/bulk_requests.rb', line 26

def create(params)
  parsed, options = ModernTreasury::BulkRequestCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "api/bulk_requests",
    body: parsed,
    model: ModernTreasury::BulkRequest,
    options: options
  )
end

#list(action_type: nil, after_cursor: nil, metadata: nil, per_page: nil, resource_type: nil, status: nil, request_options: {}) ⇒ ModernTreasury::Internal::Page<ModernTreasury::Models::BulkRequest>

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

list bulk_requests

Parameters:

• action_type (Symbol, ModernTreasury::Models::BulkRequestListParams::ActionType) —

  One of create, or update.

• after_cursor (String, nil)
• metadata (Hash{Symbol=>String}) —

  For example, if you want to query for records with metadata key ‘Type` and value

• per_page (Integer)
• resource_type (Symbol, ModernTreasury::Models::BulkRequestListParams::ResourceType) —

  One of payment_order, expected_payment, or ledger_transaction.

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

  One of pending, processing, or completed.

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

Returns:

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

See Also:

• Models::BulkRequestListParams

# File 'lib/modern_treasury/resources/bulk_requests.rb', line 81

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

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

get bulk_request

Parameters:

• id (String) —

  id

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

Returns:

• (ModernTreasury::Models::BulkRequest)

See Also:

• Models::BulkRequestRetrieveParams

# File 'lib/modern_treasury/resources/bulk_requests.rb', line 48

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