Class: Increase::Resources::Simulations::CheckDeposits

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ CheckDeposits

Returns a new instance of CheckDeposits.



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

def initialize(client:)
  @client = client
end

Instance Method Details

#reject(check_deposit_id, opts = {}) ⇒ Increase::Models::CheckDeposit

Simulates the rejection of a Check Deposit by Increase due to factors like poor image quality. This Check Deposit must first have a status of pending.

Parameters:

  • check_deposit_id (String) —

    The identifier of the Check Deposit you wish to reject.

  • 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_deposits.rb', line 19

def reject(check_deposit_id, opts = {})
  req = {}
  req[:method] = :post
  req[:path] = "/simulations/check_deposits/#{check_deposit_id}/reject"
  req[:model] = Increase::Models::CheckDeposit
  @client.request(req, opts)
end

#return_(check_deposit_id, opts = {}) ⇒ Increase::Models::CheckDeposit

Simulates the return of a Check Deposit. This Check Deposit must first have a status of submitted.

Parameters:

  • check_deposit_id (String) —

    The identifier of the Check Deposit you wish to return.

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

    Options to specify HTTP behaviour for this request.

Returns:



34
35
36
37
38
39
40
 
# File 'lib/increase/resources/simulations/check_deposits.rb', line 34

def return_(check_deposit_id, opts = {})
  req = {}
  req[:method] = :post
  req[:path] = "/simulations/check_deposits/#{check_deposit_id}/return"
  req[:model] = Increase::Models::CheckDeposit
  @client.request(req, opts)
end

#submit(check_deposit_id, opts = {}) ⇒ Increase::Models::CheckDeposit

Simulates the submission of a Check Deposit to the Federal Reserve. This Check Deposit must first have a status of pending.

Parameters:

  • check_deposit_id (String) —

    The identifier of the Check Deposit you wish to submit.

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

    Options to specify HTTP behaviour for this request.

Returns:



49
50
51
52
53
54
55
 
# File 'lib/increase/resources/simulations/check_deposits.rb', line 49

def submit(check_deposit_id, opts = {})
  req = {}
  req[:method] = :post
  req[:path] = "/simulations/check_deposits/#{check_deposit_id}/submit"
  req[:model] = Increase::Models::CheckDeposit
  @client.request(req, opts)
end