Skip to content

Latest commit

 

History

History
71 lines (51 loc) · 2.64 KB

SearchApi.md

File metadata and controls

71 lines (51 loc) · 2.64 KB

RebillySdk::SearchApi

All URIs are relative to https://api-sandbox.rebilly.com/organizations/{organizationId}

Method HTTP request Description
get_search GET /search Search merchant data

get_search

Array<Search> get_search(opts)

Search merchant data

Search merchant's data to return resources such as customers, invoices, orders, transactions.

Example

# load the gem
require 'rebilly_sdk'
# setup authorization
RebillySdk.configure do |config|

  # Configure API key authorization: SecretApiKey
  config.api_key['REB-APIKEY'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['REB-APIKEY'] = 'Bearer'
end

api_instance = RebillySdk::SearchApi.new
opts = { 
  organization_id: RebillySdk::ResourceId.new, # ResourceId | Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).  It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
  sort: ['sort_example'], # Array<String> | The collection items sort field and order (prefix with \"-\" for descending sort).
  limit: 56, # Integer | The collection items limit.
  offset: 56, # Integer | The collection items offset.
  q: 'q_example' # String | The default search. It will search across resources and many fields.
}

begin
  #Search merchant data
  result = api_instance.get_search(opts)
  p result
rescue RebillySdk::ApiError => e
  puts "Exception when calling SearchApi->get_search: #{e}"
end

Parameters

Name Type Description Notes
organization_id ResourceId Organization identifier in scope of which need to perform request (if not specified, the default organization will be used). It is deprecated. Use servers with `/organizations/{organizationId}` base path instead. [optional]
sort Array<String> The collection items sort field and order (prefix with &quot;-&quot; for descending sort). [optional]
limit Integer The collection items limit. [optional]
offset Integer The collection items offset. [optional]
q String The default search. It will search across resources and many fields. [optional]

Return type

Array<Search>

Authorization

JWT, SecretApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json