Method: TransferZero::DocumentsApi#get_documents_with_http_info

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

#get_documents_with_http_info(opts = {}) ⇒ Array<(DocumentListResponse, Fixnum, Hash)>

Getting a list of documents Fetches a list of documents.

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)

Returns:

  • (Array<(DocumentListResponse, Fixnum, Hash)>) —

    DocumentListResponse data, response status code and response headers



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/transferzero-sdk/api/documents_api.rb', line 105

def get_documents_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.get_documents ...'
  end
  # resource path
  local_var_path = '/documents'

  # query parameters
  query_params = {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per'] = opts[:'per'] if !opts[:'per'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['AuthorizationKey', 'AuthorizationNonce', 'AuthorizationSecret', 'AuthorizationSignature']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DocumentListResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DocumentsApi#get_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end