Class: PureCloud::StationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/api/stations_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ StationsApi

Returns a new instance of StationsApi.



23
24
25
 
# File 'lib/purecloudplatformclientv2/api/stations_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/stations_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#delete_station_associateduser(station_id, opts = {}) ⇒ nil

Unassigns the user assigned to this station

Parameters:

  • station_id —

    Station ID

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_station_associateduser(station_id, opts = {})
  delete_station_associateduser_with_http_info(station_id, opts)
  return nil
end

#delete_station_associateduser_with_http_info(station_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Unassigns the user assigned to this station

Parameters:

  • station_id —

    Station 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/purecloudplatformclientv2/api/stations_api.rb', line 42

def delete_station_associateduser_with_http_info(station_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: StationsApi.delete_station_associateduser ..."
  end
  
  
  # verify the required parameter 'station_id' is set
  fail ArgumentError, "Missing the required parameter 'station_id' when calling StationsApi.delete_station_associateduser" if station_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/stations/{stationId}/associateduser".sub('{format}','json').sub('{' + 'stationId' + '}', station_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 OAuth']
  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: StationsApi#delete_station_associateduser\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_station(station_id, opts = {}) ⇒ Station

Get station.

Parameters:

  • station_id —

    Station ID

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

    the optional parameters

Returns:



96
97
98
99
 
# File 'lib/purecloudplatformclientv2/api/stations_api.rb', line 96

def get_station(station_id, opts = {})
  data, _status_code, _headers = get_station_with_http_info(station_id, opts)
  return data
end

#get_station_with_http_info(station_id, opts = {}) ⇒ Array<(Station, Fixnum, Hash)>

Get station.

Parameters:

  • station_id —

    Station ID

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

    the optional parameters

Returns:

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

    Station 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/purecloudplatformclientv2/api/stations_api.rb', line 106

def get_station_with_http_info(station_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: StationsApi.get_station ..."
  end
  
  
  # verify the required parameter 'station_id' is set
  fail ArgumentError, "Missing the required parameter 'station_id' when calling StationsApi.get_station" if station_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/stations/{stationId}".sub('{format}','json').sub('{' + 'stationId' + '}', station_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 OAuth']
  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 => 'Station')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StationsApi#get_station\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_stations(opts = {}) ⇒ StationEntityListing

Get the list of available stations.

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_by (String) —

    Sort by (default to name)

  • :name (String) —

    Name

  • :user_selectable (String) —

    True for stations that the user can select otherwise false

  • :web_rtc_user_id (String) —

    Filter for the webRtc station of the webRtcUserId

  • :id (String) —

    Comma separated list of stationIds

  • :line_appearance_id (String) —

    lineAppearanceId

Returns:



168
169
170
171
 
# File 'lib/purecloudplatformclientv2/api/stations_api.rb', line 168

def get_stations(opts = {})
  data, _status_code, _headers = get_stations_with_http_info(opts)
  return data
end

#get_stations_settings(opts = {}) ⇒ StationSettings

Get an organization’s StationSettings

Parameters:

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

    the optional parameters

Returns:



287
288
289
290
 
# File 'lib/purecloudplatformclientv2/api/stations_api.rb', line 287

def get_stations_settings(opts = {})
  data, _status_code, _headers = get_stations_settings_with_http_info(opts)
  return data
end

#get_stations_settings_with_http_info(opts = {}) ⇒ Array<(StationSettings, Fixnum, Hash)>

Get an organization&#39;s StationSettings

Parameters:

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

    the optional parameters

Returns:

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

    StationSettings data, response status code and response headers



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/purecloudplatformclientv2/api/stations_api.rb', line 296

def get_stations_settings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: StationsApi.get_stations_settings ..."
  end
  
  # resource path
  local_var_path = "/api/v2/stations/settings".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 = nil
  
  auth_names = ['PureCloud OAuth']
  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 => 'StationSettings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StationsApi#get_stations_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_stations_with_http_info(opts = {}) ⇒ Array<(StationEntityListing, Fixnum, Hash)>

Get the list of available stations.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :sort_by (String) —

    Sort by

  • :name (String) —

    Name

  • :user_selectable (String) —

    True for stations that the user can select otherwise false

  • :web_rtc_user_id (String) —

    Filter for the webRtc station of the webRtcUserId

  • :id (String) —

    Comma separated list of stationIds

  • :line_appearance_id (String) —

    lineAppearanceId

Returns:

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

    StationEntityListing data, response status code and response headers



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
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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/purecloudplatformclientv2/api/stations_api.rb', line 185

def get_stations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: StationsApi.get_stations ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/stations".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[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'userSelectable'] = opts[:'user_selectable'] if opts[:'user_selectable']
  query_params[:'webRtcUserId'] = opts[:'web_rtc_user_id'] if opts[:'web_rtc_user_id']
  query_params[:'id'] = opts[:'id'] if opts[:'id']
  query_params[:'lineAppearanceId'] = opts[:'line_appearance_id'] if opts[:'line_appearance_id']

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

#patch_stations_settings(body, opts = {}) ⇒ StationSettings

Patch an organization’s StationSettings

Parameters:

  • body —

    Station settings

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

    the optional parameters

Returns:



343
344
345
346
 
# File 'lib/purecloudplatformclientv2/api/stations_api.rb', line 343

def patch_stations_settings(body, opts = {})
  data, _status_code, _headers = patch_stations_settings_with_http_info(body, opts)
  return data
end

#patch_stations_settings_with_http_info(body, opts = {}) ⇒ Array<(StationSettings, Fixnum, Hash)>

Patch an organization&#39;s StationSettings

Parameters:

  • body —

    Station settings

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

    the optional parameters

Returns:

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

    StationSettings data, response status code and response headers



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
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/purecloudplatformclientv2/api/stations_api.rb', line 353

def patch_stations_settings_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: StationsApi.patch_stations_settings ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling StationsApi.patch_stations_settings" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/stations/settings".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 OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'StationSettings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StationsApi#patch_stations_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end