Class: PureCloud::WidgetsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WidgetsApi

Returns a new instance of WidgetsApi.



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

def api_client
  @api_client
end

Instance Method Details

#delete_widgets_deployment(deployment_id, opts = {}) ⇒ nil

Delete a Widget deployment

Parameters:

  • deployment_id —

    Widget Config Id

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_widgets_deployment(deployment_id, opts = {})
  delete_widgets_deployment_with_http_info(deployment_id, opts)
  return nil
end

#delete_widgets_deployment_with_http_info(deployment_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a Widget deployment

Parameters:

  • deployment_id —

    Widget Config 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/widgets_api.rb', line 42

def delete_widgets_deployment_with_http_info(deployment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WidgetsApi.delete_widgets_deployment ..."
  end
  
  
  # verify the required parameter 'deployment_id' is set
  fail ArgumentError, "Missing the required parameter 'deployment_id' when calling WidgetsApi.delete_widgets_deployment" if deployment_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/widgets/deployments/{deploymentId}".sub('{format}','json').sub('{' + 'deploymentId' + '}', deployment_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: WidgetsApi#delete_widgets_deployment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_widgets_deployment(deployment_id, opts = {}) ⇒ WidgetDeployment

Get a Widget deployment

Parameters:

  • deployment_id —

    Widget Config Id

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

    the optional parameters

Returns:



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

def get_widgets_deployment(deployment_id, opts = {})
  data, _status_code, _headers = get_widgets_deployment_with_http_info(deployment_id, opts)
  return data
end

#get_widgets_deployment_with_http_info(deployment_id, opts = {}) ⇒ Array<(WidgetDeployment, Fixnum, Hash)>

Get a Widget deployment

Parameters:

  • deployment_id —

    Widget Config Id

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

    the optional parameters

Returns:

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

    WidgetDeployment 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/widgets_api.rb', line 106

def get_widgets_deployment_with_http_info(deployment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WidgetsApi.get_widgets_deployment ..."
  end
  
  
  # verify the required parameter 'deployment_id' is set
  fail ArgumentError, "Missing the required parameter 'deployment_id' when calling WidgetsApi.get_widgets_deployment" if deployment_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/widgets/deployments/{deploymentId}".sub('{format}','json').sub('{' + 'deploymentId' + '}', deployment_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 => 'WidgetDeployment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WidgetsApi#get_widgets_deployment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_widgets_deployments(opts = {}) ⇒ WidgetDeploymentEntityListing

List Widget deployments

Parameters:

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

    the optional parameters

Returns:



160
161
162
163
 
# File 'lib/purecloudplatformclientv2/api/widgets_api.rb', line 160

def get_widgets_deployments(opts = {})
  data, _status_code, _headers = get_widgets_deployments_with_http_info(opts)
  return data
end

#get_widgets_deployments_with_http_info(opts = {}) ⇒ Array<(WidgetDeploymentEntityListing, Fixnum, Hash)>

List Widget deployments

Parameters:

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

    the optional parameters

Returns:



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

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

#post_widgets_deployments(body, opts = {}) ⇒ WidgetDeployment

Create Widget deployment

Parameters:

  • body —

    Deployment

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

    the optional parameters

Returns:



216
217
218
219
 
# File 'lib/purecloudplatformclientv2/api/widgets_api.rb', line 216

def post_widgets_deployments(body, opts = {})
  data, _status_code, _headers = post_widgets_deployments_with_http_info(body, opts)
  return data
end

#post_widgets_deployments_with_http_info(body, opts = {}) ⇒ Array<(WidgetDeployment, Fixnum, Hash)>

Create Widget deployment

Parameters:

  • body —

    Deployment

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

    the optional parameters

Returns:

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

    WidgetDeployment data, response status code and response headers



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

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

#put_widgets_deployment(deployment_id, body, opts = {}) ⇒ WidgetDeployment

Update a Widget deployment

Parameters:

  • deployment_id —

    Widget Config Id

  • body —

    Deployment

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

    the optional parameters

Returns:



282
283
284
285
 
# File 'lib/purecloudplatformclientv2/api/widgets_api.rb', line 282

def put_widgets_deployment(deployment_id, body, opts = {})
  data, _status_code, _headers = put_widgets_deployment_with_http_info(deployment_id, body, opts)
  return data
end

#put_widgets_deployment_with_http_info(deployment_id, body, opts = {}) ⇒ Array<(WidgetDeployment, Fixnum, Hash)>

Update a Widget deployment

Parameters:

  • deployment_id —

    Widget Config Id

  • body —

    Deployment

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

    the optional parameters

Returns:

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

    WidgetDeployment data, response status code and response headers



293
294
295
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
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/purecloudplatformclientv2/api/widgets_api.rb', line 293

def put_widgets_deployment_with_http_info(deployment_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WidgetsApi.put_widgets_deployment ..."
  end
  
  
  # verify the required parameter 'deployment_id' is set
  fail ArgumentError, "Missing the required parameter 'deployment_id' when calling WidgetsApi.put_widgets_deployment" if deployment_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling WidgetsApi.put_widgets_deployment" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/widgets/deployments/{deploymentId}".sub('{format}','json').sub('{' + 'deploymentId' + '}', deployment_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 OAuth']
  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 => 'WidgetDeployment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WidgetsApi#put_widgets_deployment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end