Method: TransferZero::SendersApi#get_senders

Defined in:
lib/transferzero-sdk/api/senders_api.rb

#get_senders(opts = {}) ⇒ SenderListResponse

Listing senders Get a list of available senders

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page number to request (defaults to 1)

  • :per (Integer) —

    The number of results to load per page (defaults to 10)

  • :created_at_from (String) —

    Start date to filter recipients by created_at range Allows filtering results by the specified `created_at` timeframe. Example: `/v1/recipients?created_at_from=2018-06-06&created_at_to=2018-06-08`

  • :created_at_to (String) —

    End date to filter recipients by created_at range Allows filtering results by the specified `created_at` timeframe. Example: `/v1/recipients?created_at_from=2018-06-06&created_at_to=2018-06-08`

  • :external_id (String) —

    Allows filtering results by `external_id`. Example: `/v1/senders?external_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87`

Returns:



151
152
153
154
 
# File 'lib/transferzero-sdk/api/senders_api.rb', line 151

def get_senders(opts = {})
  data, _status_code, _headers = get_senders_with_http_info(opts)
  data
end