Class: SquareConnect::LocationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/square_connect/api/locations_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LocationsApi

Returns a new instance of LocationsApi.



16
17
18
 
# File 'lib/square_connect/api/locations_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/square_connect/api/locations_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#list_locations(opts = {}) ⇒ ListLocationsResponse

ListLocations Provides the details for all of a business’s locations. Most other Connect API endpoints have a required ‘location_id` path parameter. The `id` field of the [`Location`](#type-location) objects returned by this endpoint correspond to that `location_id` parameter.

Parameters:

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

    the optional parameters

Returns:



24
25
26
27
 
# File 'lib/square_connect/api/locations_api.rb', line 24

def list_locations(opts = {})
  data, _status_code, _headers = list_locations_with_http_info(opts)
  return data
end

#list_locations_with_http_info(opts = {}) ⇒ Array<(ListLocationsResponse, Fixnum, Hash)>

ListLocations Provides the details for all of a business&#39;s locations. Most other Connect API endpoints have a required &#x60;location_id&#x60; path parameter. The &#x60;id&#x60; field of the [&#x60;Location&#x60;](#type-location) objects returned by this endpoint correspond to that &#x60;location_id&#x60; parameter.

Parameters:

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

    the optional parameters

Returns:

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

    ListLocationsResponse data, response status code and response headers



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/square_connect/api/locations_api.rb', line 33

def list_locations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LocationsApi.list_locations ..."
  end
  # resource path
  local_var_path = "/v2/locations".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  
  header_params['Square-Version'] = "2019-02-13"

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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 => 'ListLocationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LocationsApi#list_locations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end