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

Returns a new instance of CheckTransfers.



7
8
9
 
# File 'lib/increase/resources/simulations/check_transfers.rb', line 7

def initialize(client:)
  @client = client
end

Instance Method Details

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

Simulates the mailing of a Check Transfer, which happens once per weekday 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.

  • opts (Hash|RequestOptions) (defaults to: {}) —

    Options to specify HTTP behaviour for this request.

Returns:



19
20
21
22
23
24
25
 
# File 'lib/increase/resources/simulations/check_transfers.rb', line 19

def mail(check_transfer_id, opts = {})
  req = {}
  req[:method] = :post
  req[:path] = "/simulations/check_transfers/#{check_transfer_id}/mail"
  req[:model] = Increase::Models::CheckTransfer
  @client.request(req, opts)
end