Class: Increase::Resources::InboundRealTimePaymentsTransfers

Inherits:
Object
  • Object
show all
Defined in:
lib/increase/resources/inbound_real_time_payments_transfers.rb,
sig/increase/resources/inbound_real_time_payments_transfers.rbs

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ InboundRealTimePaymentsTransfers

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

Parameters:



68
69
70
 
# File 'lib/increase/resources/inbound_real_time_payments_transfers.rb', line 68

def initialize(client:)
  @client = client
end

Instance Method Details

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

List Inbound Real-Time Payments Transfers

Parameters:

  • account_id (String) —

    Filter Inbound Real-Time Payments Transfers to those belonging to the specified Account.

  • account_number_id (String) —

    Filter Inbound Real-Time Payments Transfers to ones belonging to the specified Account Number.

  • created_at (Increase::Models::InboundRealTimePaymentsTransferListParams::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.

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

Returns:

See Also:



52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/increase/resources/inbound_real_time_payments_transfers.rb', line 52

def list(params = {})
  parsed, options = Increase::InboundRealTimePaymentsTransferListParams.dump_request(params)
  query = Increase::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "inbound_real_time_payments_transfers",
    query: query,
    page: Increase::Internal::Page,
    model: Increase::InboundRealTimePaymentsTransfer,
    options: options
  )
end

#retrieve(inbound_real_time_payments_transfer_id, request_options: {}) ⇒ Increase::Models::InboundRealTimePaymentsTransfer

Retrieve an Inbound Real-Time Payments Transfer

Parameters:

  • inbound_real_time_payments_transfer_id (String) —

    The identifier of the Inbound Real-Time Payments Transfer to get details for.

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

Returns:

See Also:



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

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