Method: ShellDataReportingApIs::InvoiceController#search_documents

Defined in:

lib/shell_data_reporting_ap_is/controllers/invoice_controller.rb

#search_documents(request_id, body: nil) ⇒ SearchDocumentsResponse

• This API allows querying the details of all invoices successfully uploaded to the Worldline invoice repository and file reference numbers for downloading. to RFC 4122 standards) for requests and responses. This will be played back in the response from the request. RequestBody

Parameters:

• request_id (String) —

  Required parameter: Mandatory UUID (according

• body (SearchDocumentsRequest) (defaults to: nil) —

  Optional parameter: SearchDocuments

Returns:

• (SearchDocumentsResponse) —

  response from the API call

# File 'lib/shell_data_reporting_ap_is/controllers/invoice_controller.rb', line 290

def search_documents(request_id,
                     body: nil)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/invoice-management/v1/searchdocuments',
                                 Server::SHELL)
               .header_param(new_parameter(request_id, key: 'RequestId'))
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(Single.new('BearerToken')))
    .response(new_response_handler
               .deserializer(APIHelper.method(:custom_type_deserializer))
               .deserialize_into(SearchDocumentsResponse.method(:from_hash))
               .local_error('400',
                            "The server cannot or will not process the request due to'\
                             ' something that is perceived to be a client error (e.g.,'\
                             ' malformed request syntax, invalid request message framing, or'\
                             ' deceptive request routing).\n",
                            ErrorObjectException)
               .local_error('401',
                            "The request has not been applied because it lacks valid '\
                             ' authentication credentials for the target resource.\n",
                            ErrorObjectException)
               .local_error('403',
                            'Forbidden',
                            ErrorObjectException)
               .local_error('404',
                            "The origin server did not find a current representation  for'\
                             ' the target resource or is not willing to disclose  that one'\
                             ' exists.\n",
                            ErrorObjectException)
               .local_error('500',
                            "The server encountered an unexpected condition that  prevented'\
                             ' it from fulfilling the request.\n",
                            ErrorObjectException))
    .execute
end