Class: Increase::Resources::Simulations::CheckTransfers

Inherits:
Object
  • Object
show all
Defined in:
lib/increase/resources/simulations/check_transfers.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ CheckTransfers

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

Parameters:



33
34
35
 
# File 'lib/increase/resources/simulations/check_transfers.rb', line 33

def initialize(client:)
  @client = client
end

Instance Method Details

#mail(check_transfer_id, request_options: {}) ⇒ Increase::Models::CheckTransfer

Simulates the mailing of a [Check Transfer](#check-transfers), which happens periodically throughout the day in production but can be sped up in sandbox. This transfer must first have a ‘status` of `pending_approval` or `pending_submission`.

Parameters:

  • check_transfer_id (String) —

    The identifier of the Check Transfer you wish to mail.

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

Returns:

See Also:



21
22
23
24
25
26
27
28
 
# File 'lib/increase/resources/simulations/check_transfers.rb', line 21

def mail(check_transfer_id, params = {})
  @client.request(
    method: :post,
    path: ["simulations/check_transfers/%1$s/mail", check_transfer_id],
    model: Increase::CheckTransfer,
    options: params[:request_options]
  )
end