Class: PureCloud::LocationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/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.



23
24
25
 
# File 'lib/purecloudplatformclientv2/api/locations_api.rb', line 23

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



21
22
23
 
# File 'lib/purecloudplatformclientv2/api/locations_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#get_location(location_id, opts = {}) ⇒ LocationDefinition

Get Location by ID.

Parameters:

  • location_id —

    Location ID

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

    the optional parameters

Returns:



32
33
34
35
 
# File 'lib/purecloudplatformclientv2/api/locations_api.rb', line 32

def get_location(location_id, opts = {})
  data, _status_code, _headers = get_location_with_http_info(location_id, opts)
  return data
end

#get_location_with_http_info(location_id, opts = {}) ⇒ Array<(LocationDefinition, Fixnum, Hash)>

Get Location by ID.

Parameters:

  • location_id —

    Location ID

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

    the optional parameters

Returns:

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

    LocationDefinition data, response status code and response headers



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
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/purecloudplatformclientv2/api/locations_api.rb', line 42

def get_location_with_http_info(location_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LocationsApi.get_location ..."
  end
  # verify the required parameter 'location_id' is set
  fail ArgumentError, "Missing the required parameter 'location_id' when calling LocationsApi.get_location" if location_id.nil?
  # resource path
  local_var_path = "/api/v2/locations/{locationId}".sub('{format}','json').sub('{' + 'locationId' + '}', location_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_locations(opts = {}) ⇒ Array<LocationDefinition>

Get a list of all locations.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :sort_order (String) —

    Sort order

Returns:



91
92
93
94
 
# File 'lib/purecloudplatformclientv2/api/locations_api.rb', line 91

def get_locations(opts = {})
  data, _status_code, _headers = get_locations_with_http_info(opts)
  return data
end

#get_locations_search(q64, opts = {}) ⇒ LocationsSearchResponse

Search locations using the q64 value returned from a previous search

Parameters:

  • q64 —

    q64

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    expand

Returns:



155
156
157
158
 
# File 'lib/purecloudplatformclientv2/api/locations_api.rb', line 155

def get_locations_search(q64, opts = {})
  data, _status_code, _headers = get_locations_search_with_http_info(q64, opts)
  return data
end

#get_locations_search_with_http_info(q64, opts = {}) ⇒ Array<(LocationsSearchResponse, Fixnum, Hash)>

Search locations using the q64 value returned from a previous search

Parameters:

  • q64 —

    q64

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    expand

Returns:

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

    LocationsSearchResponse data, response status code and response headers



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/purecloudplatformclientv2/api/locations_api.rb', line 166

def get_locations_search_with_http_info(q64, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LocationsApi.get_locations_search ..."
  end
  # verify the required parameter 'q64' is set
  fail ArgumentError, "Missing the required parameter 'q64' when calling LocationsApi.get_locations_search" if q64.nil?
  # resource path
  local_var_path = "/api/v2/locations/search".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'q64'] = q64
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_locations_with_http_info(opts = {}) ⇒ Array<(Array<LocationDefinition>, Fixnum, Hash)>

Get a list of all locations.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :sort_order (String) —

    Sort order

Returns:

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

    Array<LocationDefinition> data, response status code and response headers



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/purecloudplatformclientv2/api/locations_api.rb', line 103

def get_locations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LocationsApi.get_locations ..."
  end
  if opts[:'sort_order'] && !['asc', 'desc'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of asc, desc'
  end
  # resource path
  local_var_path = "/api/v2/locations".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#post_locations_search(body, opts = {}) ⇒ LocationsSearchResponse

Search locations

Parameters:

  • body —

    Search request options

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

    the optional parameters

Returns:



215
216
217
218
 
# File 'lib/purecloudplatformclientv2/api/locations_api.rb', line 215

def post_locations_search(body, opts = {})
  data, _status_code, _headers = post_locations_search_with_http_info(body, opts)
  return data
end

#post_locations_search_with_http_info(body, opts = {}) ⇒ Array<(LocationsSearchResponse, Fixnum, Hash)>

Search locations

Parameters:

  • body —

    Search request options

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

    the optional parameters

Returns:

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

    LocationsSearchResponse data, response status code and response headers



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/purecloudplatformclientv2/api/locations_api.rb', line 225

def post_locations_search_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LocationsApi.post_locations_search ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling LocationsApi.post_locations_search" if body.nil?
  # resource path
  local_var_path = "/api/v2/locations/search".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LocationsSearchResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LocationsApi#post_locations_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end