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

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

Parameters:



107
108
109
 
# File 'lib/increase/resources/inbound_check_deposits.rb', line 107

def initialize(client:)
  @client = client
end

Instance Method Details

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

Decline an Inbound Check Deposit

Parameters:

  • inbound_check_deposit_id (String) —

    The identifier of the Inbound Check Deposit to decline.

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

Returns:

See Also:



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

def decline(inbound_check_deposit_id, params = {})
  @client.request(
    method: :post,
    path: ["inbound_check_deposits/%1$s/decline", inbound_check_deposit_id],
    model: Increase::InboundCheckDeposit,
    options: params[:request_options]
  )
end

#list(account_id: nil, check_transfer_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {}) ⇒ Increase::Internal::Page<Increase::Models::InboundCheckDeposit>

Some parameter documentations has been truncated, see Models::InboundCheckDepositListParams for more details.

List Inbound Check Deposits

Parameters:

  • 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 (Increase::Models::InboundCheckDepositListParams::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 ob

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

Returns:

See Also:



48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/increase/resources/inbound_check_deposits.rb', line 48

def list(params = {})
  parsed, options = Increase::InboundCheckDepositListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "inbound_check_deposits",
    query: parsed,
    page: Increase::Internal::Page,
    model: Increase::InboundCheckDeposit,
    options: options
  )
end

#retrieve(inbound_check_deposit_id, request_options: {}) ⇒ 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.

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

Returns:

See Also:



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

def retrieve(inbound_check_deposit_id, params = {})
  @client.request(
    method: :get,
    path: ["inbound_check_deposits/%1$s", inbound_check_deposit_id],
    model: Increase::InboundCheckDeposit,
    options: params[:request_options]
  )
end

#return_(inbound_check_deposit_id, reason: , request_options: {}) ⇒ Increase::Models::InboundCheckDeposit

Return an Inbound Check Deposit

Parameters:

Returns:

See Also:



93
94
95
96
97
98
99
100
101
102
 
# File 'lib/increase/resources/inbound_check_deposits.rb', line 93

def return_(inbound_check_deposit_id, params)
  parsed, options = Increase::InboundCheckDepositReturnParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["inbound_check_deposits/%1$s/return", inbound_check_deposit_id],
    body: parsed,
    model: Increase::InboundCheckDeposit,
    options: options
  )
end