Class: PureCloud::MobileDevicesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudclient_v2a/api/mobile_devices_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MobileDevicesApi

Returns a new instance of MobileDevicesApi.



23
24
25
 
# File 'lib/purecloudclient_v2a/api/mobile_devices_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/purecloudclient_v2a/api/mobile_devices_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#delete_mobiledevice(device_id, opts = {}) ⇒ nil

Delete device

Parameters:

  • device_id —

    Device ID

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

    the optional parameters

Returns:

  • (nil) 


32
33
34
35
 
# File 'lib/purecloudclient_v2a/api/mobile_devices_api.rb', line 32

def delete_mobiledevice(device_id, opts = {})
  delete_mobiledevice_with_http_info(device_id, opts)
  return nil
end

#delete_mobiledevice_with_http_info(device_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete device

Parameters:

  • device_id —

    Device ID

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

    the optional parameters

Returns:

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

    nil, 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
83
84
85
86
87
88
89
 
# File 'lib/purecloudclient_v2a/api/mobile_devices_api.rb', line 42

def delete_mobiledevice_with_http_info(device_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MobileDevicesApi.delete_mobiledevice ..."
  end
  
  
  # verify the required parameter 'device_id' is set
  fail ArgumentError, "Missing the required parameter 'device_id' when calling MobileDevicesApi.delete_mobiledevice" if device_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/mobiledevices/{deviceId}".sub('{format}','json').sub('{' + 'deviceId' + '}', device_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(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MobileDevicesApi#delete_mobiledevice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_mobiledevice(device_id, opts = {}) ⇒ UserDevice

Get device

Parameters:

  • device_id —

    Device ID

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

    the optional parameters

Returns:



96
97
98
99
 
# File 'lib/purecloudclient_v2a/api/mobile_devices_api.rb', line 96

def get_mobiledevice(device_id, opts = {})
  data, _status_code, _headers = get_mobiledevice_with_http_info(device_id, opts)
  return data
end

#get_mobiledevice_with_http_info(device_id, opts = {}) ⇒ Array<(UserDevice, Fixnum, Hash)>

Get device

Parameters:

  • device_id —

    Device ID

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

    the optional parameters

Returns:

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

    UserDevice data, response status code and response headers



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
148
149
150
151
152
153
154
 
# File 'lib/purecloudclient_v2a/api/mobile_devices_api.rb', line 106

def get_mobiledevice_with_http_info(device_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MobileDevicesApi.get_mobiledevice ..."
  end
  
  
  # verify the required parameter 'device_id' is set
  fail ArgumentError, "Missing the required parameter 'device_id' when calling MobileDevicesApi.get_mobiledevice" if device_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/mobiledevices/{deviceId}".sub('{format}','json').sub('{' + 'deviceId' + '}', device_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 => 'UserDevice')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MobileDevicesApi#get_mobiledevice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_mobiledevices(opts = {}) ⇒ DirectoryUserDevicesListing

Get a list of all devices.

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) —

    Ascending or descending sort order (default to ascending)

Returns:



163
164
165
166
 
# File 'lib/purecloudclient_v2a/api/mobile_devices_api.rb', line 163

def get_mobiledevices(opts = {})
  data, _status_code, _headers = get_mobiledevices_with_http_info(opts)
  return data
end

#get_mobiledevices_with_http_info(opts = {}) ⇒ Array<(DirectoryUserDevicesListing, Fixnum, Hash)>

Get a list of all devices.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :sort_order (String) —

    Ascending or descending sort order

Returns:



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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/purecloudclient_v2a/api/mobile_devices_api.rb', line 175

def get_mobiledevices_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MobileDevicesApi.get_mobiledevices ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  
  
  
  # resource path
  local_var_path = "/api/v2/mobiledevices".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 => 'DirectoryUserDevicesListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MobileDevicesApi#get_mobiledevices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_mobiledevices(body, opts = {}) ⇒ UserDevice

Create User device

Parameters:

  • body —

    Device

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

    the optional parameters

Returns:



247
248
249
250
 
# File 'lib/purecloudclient_v2a/api/mobile_devices_api.rb', line 247

def post_mobiledevices(body, opts = {})
  data, _status_code, _headers = post_mobiledevices_with_http_info(body, opts)
  return data
end

#post_mobiledevices_with_http_info(body, opts = {}) ⇒ Array<(UserDevice, Fixnum, Hash)>

Create User device

Parameters:

  • body —

    Device

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

    the optional parameters

Returns:

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

    UserDevice data, response status code and response headers



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/purecloudclient_v2a/api/mobile_devices_api.rb', line 257

def post_mobiledevices_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MobileDevicesApi.post_mobiledevices ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling MobileDevicesApi.post_mobiledevices" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/mobiledevices".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 => 'UserDevice')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MobileDevicesApi#post_mobiledevices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_mobiledevice(device_id, opts = {}) ⇒ UserDevice

Update device

Parameters:

  • device_id —

    Device ID

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

    the optional parameters

Options Hash (opts):

Returns:



313
314
315
316
 
# File 'lib/purecloudclient_v2a/api/mobile_devices_api.rb', line 313

def put_mobiledevice(device_id, opts = {})
  data, _status_code, _headers = put_mobiledevice_with_http_info(device_id, opts)
  return data
end

#put_mobiledevice_with_http_info(device_id, opts = {}) ⇒ Array<(UserDevice, Fixnum, Hash)>

Update device

Parameters:

  • device_id —

    Device ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    UserDevice data, response status code and response headers



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/purecloudclient_v2a/api/mobile_devices_api.rb', line 324

def put_mobiledevice_with_http_info(device_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MobileDevicesApi.put_mobiledevice ..."
  end
  
  
  # verify the required parameter 'device_id' is set
  fail ArgumentError, "Missing the required parameter 'device_id' when calling MobileDevicesApi.put_mobiledevice" if device_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/mobiledevices/{deviceId}".sub('{format}','json').sub('{' + 'deviceId' + '}', device_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 = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserDevice')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MobileDevicesApi#put_mobiledevice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end