Class: SquareConnect::V1LocationsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ V1LocationsApi

Returns a new instance of V1LocationsApi.



16
17
18
 
# File 'lib/square_connect/api/v1_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/v1_locations_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#list_locations(opts = {}) ⇒ Array<V1Merchant>

ListLocations Provides details for a business’s locations, including their IDs.

Parameters:

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

    the optional parameters

Returns:



24
25
26
27
 
# File 'lib/square_connect/api/v1_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<(Array<V1Merchant>, Fixnum, Hash)>

ListLocations Provides details for a business&#39;s locations, including their IDs.

Parameters:

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

    the optional parameters

Returns:

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

    Array<V1Merchant> 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/v1_locations_api.rb', line 33

def list_locations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: V1LocationsApi.list_locations ..."
  end
  # resource path
  local_var_path = "/v1/me/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-06-12"

  # 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 => 'Array<V1Merchant>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V1LocationsApi#list_locations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#retrieve_business(opts = {}) ⇒ V1Merchant

RetrieveBusiness Get a business’s information.

Parameters:

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

    the optional parameters

Returns:



75
76
77
78
 
# File 'lib/square_connect/api/v1_locations_api.rb', line 75

def retrieve_business(opts = {})
  data, _status_code, _headers = retrieve_business_with_http_info(opts)
  return data
end

#retrieve_business_with_http_info(opts = {}) ⇒ Array<(V1Merchant, Fixnum, Hash)>

RetrieveBusiness Get a business&#39;s information.

Parameters:

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

    the optional parameters

Returns:

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

    V1Merchant data, response status code and response headers



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/square_connect/api/v1_locations_api.rb', line 84

def retrieve_business_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: V1LocationsApi.retrieve_business ..."
  end
  # resource path
  local_var_path = "/v1/me".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-06-12"

  # 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 => 'V1Merchant')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V1LocationsApi#retrieve_business\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end