Class: PureCloud::NotificationsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ NotificationsApi

Returns a new instance of NotificationsApi.



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

def api_client
  @api_client
end

Instance Method Details

#delete_notifications_channel_subscriptions(channel_id, opts = {}) ⇒ nil

Remove all subscriptions

Parameters:

  • channel_id —

    Channel ID

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_notifications_channel_subscriptions(channel_id, opts = {})
  delete_notifications_channel_subscriptions_with_http_info(channel_id, opts)
  return nil
end

#delete_notifications_channel_subscriptions_with_http_info(channel_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Remove all subscriptions

Parameters:

  • channel_id —

    Channel 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
 
# File 'lib/purecloudplatformclientv2/api/notifications_api.rb', line 42

def delete_notifications_channel_subscriptions_with_http_info(channel_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NotificationsApi.delete_notifications_channel_subscriptions ..."
  end
  # verify the required parameter 'channel_id' is set
  fail ArgumentError, "Missing the required parameter 'channel_id' when calling NotificationsApi.delete_notifications_channel_subscriptions" if channel_id.nil?
  # resource path
  local_var_path = "/api/v2/notifications/channels/{channelId}/subscriptions".sub('{format}','json').sub('{' + 'channelId' + '}', channel_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: NotificationsApi#delete_notifications_channel_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_notifications_availabletopics(opts = {}) ⇒ AvailableTopicEntityListing

Get available notification topics.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



88
89
90
91
 
# File 'lib/purecloudplatformclientv2/api/notifications_api.rb', line 88

def get_notifications_availabletopics(opts = {})
  data, _status_code, _headers = get_notifications_availabletopics_with_http_info(opts)
  return data
end

#get_notifications_availabletopics_with_http_info(opts = {}) ⇒ Array<(AvailableTopicEntityListing, Fixnum, Hash)>

Get available notification topics.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



98
99
100
101
102
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
 
# File 'lib/purecloudplatformclientv2/api/notifications_api.rb', line 98

def get_notifications_availabletopics_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NotificationsApi.get_notifications_availabletopics ..."
  end
  # resource path
  local_var_path = "/api/v2/notifications/availabletopics".sub('{format}','json')

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

#get_notifications_channel_subscriptions(channel_id, opts = {}) ⇒ ChannelTopicEntityListing

The list of all subscriptions for this channel

Parameters:

  • channel_id —

    Channel ID

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

    the optional parameters

Returns:



144
145
146
147
 
# File 'lib/purecloudplatformclientv2/api/notifications_api.rb', line 144

def get_notifications_channel_subscriptions(channel_id, opts = {})
  data, _status_code, _headers = get_notifications_channel_subscriptions_with_http_info(channel_id, opts)
  return data
end

#get_notifications_channel_subscriptions_with_http_info(channel_id, opts = {}) ⇒ Array<(ChannelTopicEntityListing, Fixnum, Hash)>

The list of all subscriptions for this channel

Parameters:

  • channel_id —

    Channel ID

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

    the optional parameters

Returns:

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

    ChannelTopicEntityListing data, response status code and response headers



154
155
156
157
158
159
160
161
162
163
164
165
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
 
# File 'lib/purecloudplatformclientv2/api/notifications_api.rb', line 154

def get_notifications_channel_subscriptions_with_http_info(channel_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NotificationsApi.get_notifications_channel_subscriptions ..."
  end
  # verify the required parameter 'channel_id' is set
  fail ArgumentError, "Missing the required parameter 'channel_id' when calling NotificationsApi.get_notifications_channel_subscriptions" if channel_id.nil?
  # resource path
  local_var_path = "/api/v2/notifications/channels/{channelId}/subscriptions".sub('{format}','json').sub('{' + 'channelId' + '}', channel_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 => 'ChannelTopicEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NotificationsApi#get_notifications_channel_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_notifications_channels(opts = {}) ⇒ ChannelEntityListing

The list of existing channels

Parameters:

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

    the optional parameters

Returns:



200
201
202
203
 
# File 'lib/purecloudplatformclientv2/api/notifications_api.rb', line 200

def get_notifications_channels(opts = {})
  data, _status_code, _headers = get_notifications_channels_with_http_info(opts)
  return data
end

#get_notifications_channels_with_http_info(opts = {}) ⇒ Array<(ChannelEntityListing, Fixnum, Hash)>

The list of existing channels

Parameters:

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

    the optional parameters

Returns:

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

    ChannelEntityListing data, response status code and response headers



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
 
# File 'lib/purecloudplatformclientv2/api/notifications_api.rb', line 209

def get_notifications_channels_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NotificationsApi.get_notifications_channels ..."
  end
  # resource path
  local_var_path = "/api/v2/notifications/channels".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 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 => 'ChannelEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NotificationsApi#get_notifications_channels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_notifications_channel_subscriptions(channel_id, body, opts = {}) ⇒ ChannelTopicEntityListing

Add a list of subscriptions to the existing list of subscriptions

Parameters:

  • channel_id —

    Channel ID

  • body —

    Body

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

    the optional parameters

Returns:



255
256
257
258
 
# File 'lib/purecloudplatformclientv2/api/notifications_api.rb', line 255

def post_notifications_channel_subscriptions(channel_id, body, opts = {})
  data, _status_code, _headers = post_notifications_channel_subscriptions_with_http_info(channel_id, body, opts)
  return data
end

#post_notifications_channel_subscriptions_with_http_info(channel_id, body, opts = {}) ⇒ Array<(ChannelTopicEntityListing, Fixnum, Hash)>

Add a list of subscriptions to the existing list of subscriptions

Parameters:

  • channel_id —

    Channel ID

  • body —

    Body

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

    the optional parameters

Returns:

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

    ChannelTopicEntityListing data, response status code and response headers



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
306
307
308
 
# File 'lib/purecloudplatformclientv2/api/notifications_api.rb', line 266

def post_notifications_channel_subscriptions_with_http_info(channel_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NotificationsApi.post_notifications_channel_subscriptions ..."
  end
  # verify the required parameter 'channel_id' is set
  fail ArgumentError, "Missing the required parameter 'channel_id' when calling NotificationsApi.post_notifications_channel_subscriptions" if channel_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling NotificationsApi.post_notifications_channel_subscriptions" if body.nil?
  # resource path
  local_var_path = "/api/v2/notifications/channels/{channelId}/subscriptions".sub('{format}','json').sub('{' + 'channelId' + '}', channel_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(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 => 'ChannelTopicEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NotificationsApi#post_notifications_channel_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_notifications_channels(opts = {}) ⇒ Channel

Create a new channel There is a limit of 10 channels. Creating an 11th channel will remove the channel with oldest last used date.

Parameters:

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

    the optional parameters

Returns:



314
315
316
317
 
# File 'lib/purecloudplatformclientv2/api/notifications_api.rb', line 314

def post_notifications_channels(opts = {})
  data, _status_code, _headers = post_notifications_channels_with_http_info(opts)
  return data
end

#post_notifications_channels_with_http_info(opts = {}) ⇒ Array<(Channel, Fixnum, Hash)>

Create a new channel There is a limit of 10 channels. Creating an 11th channel will remove the channel with oldest last used date.

Parameters:

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

    the optional parameters

Returns:

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

    Channel data, response status code and response headers



323
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
 
# File 'lib/purecloudplatformclientv2/api/notifications_api.rb', line 323

def post_notifications_channels_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NotificationsApi.post_notifications_channels ..."
  end
  # resource path
  local_var_path = "/api/v2/notifications/channels".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 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 => 'Channel')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NotificationsApi#post_notifications_channels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_notifications_channel_subscriptions(channel_id, body, opts = {}) ⇒ ChannelTopicEntityListing

Replace the current list of subscriptions with a new list.

Parameters:

  • channel_id —

    Channel ID

  • body —

    Body

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

    the optional parameters

Returns:



369
370
371
372
 
# File 'lib/purecloudplatformclientv2/api/notifications_api.rb', line 369

def put_notifications_channel_subscriptions(channel_id, body, opts = {})
  data, _status_code, _headers = put_notifications_channel_subscriptions_with_http_info(channel_id, body, opts)
  return data
end

#put_notifications_channel_subscriptions_with_http_info(channel_id, body, opts = {}) ⇒ Array<(ChannelTopicEntityListing, Fixnum, Hash)>

Replace the current list of subscriptions with a new list.

Parameters:

  • channel_id —

    Channel ID

  • body —

    Body

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

    the optional parameters

Returns:

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

    ChannelTopicEntityListing data, response status code and response headers



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/purecloudplatformclientv2/api/notifications_api.rb', line 380

def put_notifications_channel_subscriptions_with_http_info(channel_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NotificationsApi.put_notifications_channel_subscriptions ..."
  end
  # verify the required parameter 'channel_id' is set
  fail ArgumentError, "Missing the required parameter 'channel_id' when calling NotificationsApi.put_notifications_channel_subscriptions" if channel_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling NotificationsApi.put_notifications_channel_subscriptions" if body.nil?
  # resource path
  local_var_path = "/api/v2/notifications/channels/{channelId}/subscriptions".sub('{format}','json').sub('{' + 'channelId' + '}', channel_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(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 => 'ChannelTopicEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NotificationsApi#put_notifications_channel_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end