Class: Increase::Resources::InboundWireTransfers

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ InboundWireTransfers

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

Parameters:



95
96
97
 
# File 'lib/increase/resources/inbound_wire_transfers.rb', line 95

def initialize(client:)
  @client = client
end

Instance Method Details

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

List Inbound Wire Transfers

Parameters:

  • account_id (String) —

    Filter Inbound Wire Transfers to ones belonging to the specified Account.

  • account_number_id (String) —

    Filter Inbound Wire Transfers to ones belonging to the specified Account Number.

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

  • status (Increase::Models::InboundWireTransferListParams::Status)
  • wire_drawdown_request_id (String) —

    Filter Inbound Wire Transfers to ones belonging to the specified Wire Drawdown Request.

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

Returns:

See Also:



54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/increase/resources/inbound_wire_transfers.rb', line 54

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

#retrieve(inbound_wire_transfer_id, request_options: {}) ⇒ Increase::Models::InboundWireTransfer

Retrieve an Inbound Wire Transfer

Parameters:

  • inbound_wire_transfer_id (String) —

    The identifier of the Inbound Wire Transfer 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_wire_transfers.rb', line 17

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

#reverse(inbound_wire_transfer_id, reason:, request_options: {}) ⇒ Increase::Models::InboundWireTransfer

Reverse an Inbound Wire Transfer

Parameters:

Returns:

See Also:



81
82
83
84
85
86
87
88
89
90
 
# File 'lib/increase/resources/inbound_wire_transfers.rb', line 81

def reverse(inbound_wire_transfer_id, params)
  parsed, options = Increase::InboundWireTransferReverseParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["inbound_wire_transfers/%1$s/reverse", inbound_wire_transfer_id],
    body: parsed,
    model: Increase::InboundWireTransfer,
    options: options
  )
end