Class: Atrium::MerchantsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/atrium-ruby/api/merchants_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MerchantsApi

Returns a new instance of MerchantsApi.



15
16
17
 
# File 'lib/atrium-ruby/api/merchants_api.rb', line 15

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



13
14
15
 
# File 'lib/atrium-ruby/api/merchants_api.rb', line 13

def api_client
  @api_client
end

Instance Method Details

#list_merchant_locations(merchant_guid, opts = {}) ⇒ MerchantLocationsResponseBody

List merchant locations Returns a list of all the merchant locations associated with a merchant, including physical location, latitude, longitude, etc.

Parameters:

  • merchant_guid —

    The unique identifier for a `merchant`.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:



25
26
27
28
 
# File 'lib/atrium-ruby/api/merchants_api.rb', line 25

def list_merchant_locations(merchant_guid, opts = {})
  data, _status_code, _headers = list_merchant_locations_with_http_info(merchant_guid, opts)
  data
end

#list_merchants(opts = {}) ⇒ MerchantsResponseBody

List merchants Returns a list of merchnants.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:



36
37
38
39
 
# File 'lib/atrium-ruby/api/merchants_api.rb', line 36

def list_merchants(opts = {})
  data, _status_code, _headers = list_merchants_with_http_info(opts)
  data
end

#read_merchant(merchant_guid, opts = {}) ⇒ MerchantResponseBody

Read merchant Returns information about a particular merchant, such as a logo, name, and website.

Parameters:

  • merchant_guid —

    The unique identifier for a `merchant`.

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

    the optional parameters

Returns:



46
47
48
49
 
# File 'lib/atrium-ruby/api/merchants_api.rb', line 46

def read_merchant(merchant_guid, opts = {})
  data, _status_code, _headers = read_merchant_with_http_info(merchant_guid, opts)
  data
end

#read_merchant_location(merchant_guid, merchant_location_guid, opts = {}) ⇒ MerchantLocationResponseBody

Read merchant location Retuns a specific location associated with a merchant, including physical location, latitude, longitude, etc.

Parameters:

  • merchant_guid —

    The unique identifier for a `merchant`.

  • merchant_location_guid —

    The unique identifier for a `merchant_location`.

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

    the optional parameters

Returns:



57
58
59
60
 
# File 'lib/atrium-ruby/api/merchants_api.rb', line 57

def read_merchant_location(merchant_guid, merchant_location_guid, opts = {})
  data, _status_code, _headers = read_merchant_location_with_http_info(merchant_guid, merchant_location_guid, opts)
  data
end