Class: Increase::Resources::InboundCheckDeposits

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ InboundCheckDeposits

Returns a new instance of InboundCheckDeposits.



6
7
8
 
# File 'lib/increase/resources/inbound_check_deposits.rb', line 6

def initialize(client:)
  @client = client
end

Instance Method Details

#decline(inbound_check_deposit_id, opts = {}) ⇒ Increase::Models::InboundCheckDeposit

Decline an Inbound Check Deposit

Parameters:

  • inbound_check_deposit_id (String) —

    The identifier of the Inbound Check Deposit to decline.

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

    Options to specify HTTP behaviour for this request.

Returns:



54
55
56
57
58
59
60
 
# File 'lib/increase/resources/inbound_check_deposits.rb', line 54

def decline(inbound_check_deposit_id, opts = {})
  req = {}
  req[:method] = :post
  req[:path] = "/inbound_check_deposits/#{inbound_check_deposit_id}/decline"
  req[:model] = Increase::Models::InboundCheckDeposit
  @client.request(req, opts)
end

#list(params = {}, opts = {}) ⇒ Increase::Page<Increase::Models::InboundCheckDeposit>

List Inbound Check Deposits

Parameters:

  • params (Hash) (defaults to: {}) —

    Attributes to send in this request.

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

    Options to specify HTTP behaviour for this request.

Options Hash (params):

  • :account_id (String) —

    Filter Inbound Check Deposits to those belonging to the specified Account.

  • :check_transfer_id (String) —

    Filter Inbound Check Deposits to those belonging to the specified Check Transfer.

  • :created_at (CreatedAt)
  • :cursor (String) —

    Return the page of entries after this one.

  • :limit (Integer) —

    Limit the size of the list that is returned. The default (and maximum) is 100 objects.

Returns:



38
39
40
41
42
43
44
45
46
 
# File 'lib/increase/resources/inbound_check_deposits.rb', line 38

def list(params = {}, opts = {})
  req = {}
  req[:method] = :get
  req[:path] = "/inbound_check_deposits"
  req[:query] = params
  req[:page] = Increase::Page
  req[:model] = Increase::Models::InboundCheckDeposit
  @client.request(req, opts)
end

#retrieve(inbound_check_deposit_id, opts = {}) ⇒ Increase::Models::InboundCheckDeposit

Retrieve an Inbound Check Deposit

Parameters:

  • inbound_check_deposit_id (String) —

    The identifier of the Inbound Check Deposit to get details for.

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

    Options to specify HTTP behaviour for this request.

Returns:



16
17
18
19
20
21
22
 
# File 'lib/increase/resources/inbound_check_deposits.rb', line 16

def retrieve(inbound_check_deposit_id, opts = {})
  req = {}
  req[:method] = :get
  req[:path] = "/inbound_check_deposits/#{inbound_check_deposit_id}"
  req[:model] = Increase::Models::InboundCheckDeposit
  @client.request(req, opts)
end

#return_(inbound_check_deposit_id, params = {}, opts = {}) ⇒ Increase::Models::InboundCheckDeposit

Return an Inbound Check Deposit

Parameters:

  • inbound_check_deposit_id (String) —

    The identifier of the Inbound Check Deposit to return.

  • params (Hash) (defaults to: {}) —

    Attributes to send in this request.

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

    Options to specify HTTP behaviour for this request.

Options Hash (params):

  • :reason (Symbol) —

    The reason to return the Inbound Check Deposit.

Returns:



72
73
74
75
76
77
78
79
 
# File 'lib/increase/resources/inbound_check_deposits.rb', line 72

def return_(inbound_check_deposit_id, params = {}, opts = {})
  req = {}
  req[:method] = :post
  req[:path] = "/inbound_check_deposits/#{inbound_check_deposit_id}/return"
  req[:body] = params
  req[:model] = Increase::Models::InboundCheckDeposit
  @client.request(req, opts)
end