Class: Increase::Resources::Simulations::AccountTransfers

Inherits:

Object

• Object
• Increase::Resources::Simulations::AccountTransfers

Defined in:

lib/increase/resources/simulations/account_transfers.rb

Instance Method Summary

• #complete(account_transfer_id, request_options: {}) ⇒ Increase::Models::AccountTransfer

  If your account is configured to require approval for each transfer, this endpoint simulates the approval of an [Account Transfer](#account-transfers).

• #initialize(client:) ⇒ AccountTransfers constructor private

  A new instance of AccountTransfers.

Constructor Details

#initialize(client:) ⇒ AccountTransfers

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

Parameters:

• client (Increase::Client)

# File 'lib/increase/resources/simulations/account_transfers.rb', line 33

def initialize(client:)
  @client = client
end

Instance Method Details

#complete(account_transfer_id, request_options: {}) ⇒ Increase::Models::AccountTransfer

If your account is configured to require approval for each transfer, this endpoint simulates the approval of an [Account Transfer](#account-transfers). You can also approve sandbox Account Transfers in the dashboard. This transfer must first have a ‘status` of `pending_approval`.

Parameters:

• account_transfer_id (String) —

  The identifier of the Account Transfer you wish to complete.

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

Returns:

• (Increase::Models::AccountTransfer)

See Also:

• Models::Simulations::AccountTransferCompleteParams

# File 'lib/increase/resources/simulations/account_transfers.rb', line 21

def complete(account_transfer_id, params = {})
  @client.request(
    method: :post,
    path: ["simulations/account_transfers/%1$s/complete", account_transfer_id],
    model: Increase::AccountTransfer,
    options: params[:request_options]
  )
end