Increase.InboundWireDrawdownRequests (Increase v1.0.0)

Copy Markdown View Source

Inbound wire drawdown requests are requests from someone else to send them a wire. For more information, see our [Wire Drawdown Requests documentation].

See https://increase.com/documentation/api/inbound-wire-drawdown-requests for the full API reference for this resource.

Summary

Functions

list(client, params \\ %{}, opts \\ [])

List Inbound Wire Drawdown Requests

retrieve(client, inbound_wire_drawdown_request_id, opts \\ [])

Retrieve an Inbound Wire Drawdown Request

Functions

list(client, params \\ %{}, opts \\ [])

@spec list(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) ::
  {:ok, Increase.Page.t()} | {:error, Increase.Error.t()}

List Inbound Wire Drawdown Requests

Returns a %Increase.Page{} whose data is a list of %__MODULE__. InboundWireDrawdownRequest{} structs. Page through results with Increase.Page.auto_paging_stream/1 or Increase.Page.auto_paging_each/2.

GET /inbound_wire_drawdown_requests

retrieve(client, inbound_wire_drawdown_request_id, opts \\ [])

@spec retrieve(Increase.Client.t() | keyword() | nil, String.t(), keyword()) ::
  {:ok, Increase.InboundWireDrawdownRequests.InboundWireDrawdownRequest.t()}
  | {:error, Increase.Error.t()}

Retrieve an Inbound Wire Drawdown Request

GET /inbound_wire_drawdown_requests/{inbound_wire_drawdown_request_id}