purecloud 0.38.1 → 0.39.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (147) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +3 -3
  3. data/config-ruby.json +1 -1
  4. data/doc_out/AuthorizationApi.html.md +0 -57
  5. data/doc_out/AvailableLanguageList.html.md +13 -0
  6. data/doc_out/BillingContact.html.md +20 -0
  7. data/doc_out/{FlowHistoryResultItemEntityListing.html.md → BillingContactListing.html.md} +3 -3
  8. data/doc_out/CallRecord.html.md +2 -2
  9. data/doc_out/CallableContactsDiagnostic.html.md +3 -3
  10. data/doc_out/CallableTimeSet.html.md +3 -3
  11. data/doc_out/Campaign.html.md +3 -3
  12. data/doc_out/CampaignDiagnostics.html.md +3 -3
  13. data/doc_out/CampaignSchedule.html.md +6 -6
  14. data/doc_out/CampaignSequence.html.md +8 -8
  15. data/doc_out/CampaignStats.html.md +4 -4
  16. data/doc_out/Condition.html.md +7 -7
  17. data/doc_out/ConnectRate.html.md +3 -3
  18. data/doc_out/ContactCallbackRequest.html.md +5 -5
  19. data/doc_out/ContactList.html.md +9 -9
  20. data/doc_out/ContactPhoneNumberColumn.html.md +3 -3
  21. data/doc_out/CreateCallbackCommand.html.md +1 -0
  22. data/doc_out/CreateUser.html.md +1 -1
  23. data/doc_out/CustomerInteractionCenter.html.md +18 -0
  24. data/doc_out/DialerAction.html.md +4 -4
  25. data/doc_out/DialerContact.html.md +5 -5
  26. data/doc_out/DialerRule.html.md +6 -6
  27. data/doc_out/DncList.html.md +6 -7
  28. data/doc_out/ExternalContact.html.md +1 -0
  29. data/doc_out/ExternalDataSource.html.md +14 -0
  30. data/doc_out/ExternalOrganization.html.md +1 -0
  31. data/doc_out/IdentityProviderApi.html.md +1011 -0
  32. data/doc_out/ImportStatus.html.md +5 -5
  33. data/doc_out/InitiateScreenRecording.html.md +15 -0
  34. data/doc_out/JsonNode.html.md +3 -3
  35. data/doc_out/Keyword.html.md +19 -0
  36. data/doc_out/KeywordSet.html.md +21 -0
  37. data/doc_out/KeywordSetEntityListing.html.md +22 -0
  38. data/doc_out/OAuthApi.html.md +45 -886
  39. data/doc_out/OAuthClient.html.md +2 -2
  40. data/doc_out/Okta.html.md +1 -1
  41. data/doc_out/OneLogin.html.md +1 -1
  42. data/doc_out/OrgMediaUtilization.html.md +1 -0
  43. data/doc_out/OutboundApi.html.md +3 -3
  44. data/doc_out/PaymentMethod.html.md +3 -0
  45. data/doc_out/PhoneNumberStatus.html.md +1 -1
  46. data/doc_out/PolicyActions.html.md +1 -0
  47. data/doc_out/PresenceApi.html.md +68 -17
  48. data/doc_out/QualityApi.html.md +361 -0
  49. data/doc_out/QueueUtilizationDiagnostic.html.md +8 -8
  50. data/doc_out/ResponseSet.html.md +3 -3
  51. data/doc_out/RoutingApi.html.md +15 -12
  52. data/doc_out/RoutingSkill.html.md +1 -2
  53. data/doc_out/RuleSet.html.md +6 -6
  54. data/doc_out/Salesforce.html.md +1 -1
  55. data/doc_out/ScheduleInterval.html.md +14 -0
  56. data/doc_out/SequenceSchedule.html.md +6 -6
  57. data/doc_out/Station.html.md +1 -0
  58. data/doc_out/StationsApi.html.md +3 -1
  59. data/doc_out/SupportCredit.html.md +16 -0
  60. data/doc_out/SupportCreditListing.html.md +22 -0
  61. data/doc_out/SystemPresence.html.md +15 -0
  62. data/doc_out/TelephonyProvidersEdgeApi.html.md +112 -1
  63. data/doc_out/TrunkRecordingEnabledCount.html.md +14 -0
  64. data/doc_out/UserImage.html.md +1 -1
  65. data/doc_out/UserMe.html.md +5 -1
  66. data/doc_out/UserRoutingSkill.html.md +2 -2
  67. data/doc_out/UsersApi.html.md +182 -0
  68. data/doc_out/WrapUpCodeMapping.html.md +5 -5
  69. data/doc_out/index.html.md +3 -3
  70. data/lib/purecloud.rb +15 -3
  71. data/lib/purecloud/api/authorization_api.rb +0 -60
  72. data/lib/purecloud/api/identity_provider_api.rb +1072 -0
  73. data/lib/purecloud/api/o_auth_api.rb +26 -906
  74. data/lib/purecloud/api/outbound_api.rb +2 -2
  75. data/lib/purecloud/api/presence_api.rb +67 -12
  76. data/lib/purecloud/api/quality_api.rb +378 -0
  77. data/lib/purecloud/api/routing_api.rb +21 -16
  78. data/lib/purecloud/api/stations_api.rb +3 -0
  79. data/lib/purecloud/api/telephony_providers_edge_api.rb +120 -0
  80. data/lib/purecloud/api/users_api.rb +189 -0
  81. data/lib/purecloud/api_client.rb +1 -1
  82. data/lib/purecloud/models/analytics_session.rb +1 -1
  83. data/lib/purecloud/models/available_language_list.rb +167 -0
  84. data/lib/purecloud/models/billing_contact.rb +237 -0
  85. data/lib/purecloud/models/{flow_history_result_item_entity_listing.rb → billing_contact_listing.rb} +2 -2
  86. data/lib/purecloud/models/call_record.rb +2 -1
  87. data/lib/purecloud/models/callable_contacts_diagnostic.rb +3 -0
  88. data/lib/purecloud/models/callable_time_set.rb +3 -3
  89. data/lib/purecloud/models/campaign.rb +3 -3
  90. data/lib/purecloud/models/campaign_diagnostics.rb +3 -0
  91. data/lib/purecloud/models/campaign_schedule.rb +7 -4
  92. data/lib/purecloud/models/campaign_sequence.rb +8 -3
  93. data/lib/purecloud/models/campaign_stats.rb +4 -0
  94. data/lib/purecloud/models/condition.rb +16 -0
  95. data/lib/purecloud/models/connect_rate.rb +3 -0
  96. data/lib/purecloud/models/contact_callback_request.rb +5 -0
  97. data/lib/purecloud/models/contact_list.rb +9 -3
  98. data/lib/purecloud/models/contact_phone_number_column.rb +3 -0
  99. data/lib/purecloud/models/create_callback_command.rb +12 -1
  100. data/lib/purecloud/models/create_user.rb +1 -0
  101. data/lib/purecloud/models/customer_interaction_center.rb +217 -0
  102. data/lib/purecloud/models/dialer_action.rb +31 -0
  103. data/lib/purecloud/models/dialer_contact.rb +5 -0
  104. data/lib/purecloud/models/dialer_rule.rb +15 -0
  105. data/lib/purecloud/models/dnc_list.rb +7 -14
  106. data/lib/purecloud/models/external_contact.rb +14 -1
  107. data/lib/purecloud/models/external_data_source.rb +176 -0
  108. data/lib/purecloud/models/external_organization.rb +14 -1
  109. data/lib/purecloud/models/import_status.rb +5 -0
  110. data/lib/purecloud/models/initiate_screen_recording.rb +187 -0
  111. data/lib/purecloud/models/json_node.rb +37 -37
  112. data/lib/purecloud/models/keyword.rb +227 -0
  113. data/lib/purecloud/models/keyword_set.rb +253 -0
  114. data/lib/purecloud/models/keyword_set_entity_listing.rb +257 -0
  115. data/lib/purecloud/models/o_auth_client.rb +3 -3
  116. data/lib/purecloud/models/okta.rb +11 -11
  117. data/lib/purecloud/models/one_login.rb +11 -11
  118. data/lib/purecloud/models/org_media_utilization.rb +17 -4
  119. data/lib/purecloud/models/organization_presence.rb +0 -9
  120. data/lib/purecloud/models/payment_method.rb +42 -1
  121. data/lib/purecloud/models/phone_number_status.rb +1 -0
  122. data/lib/purecloud/models/policy_actions.rb +14 -4
  123. data/lib/purecloud/models/queue_utilization_diagnostic.rb +8 -0
  124. data/lib/purecloud/models/response_set.rb +3 -3
  125. data/lib/purecloud/models/routing_skill.rb +2 -12
  126. data/lib/purecloud/models/routing_status.rb +1 -1
  127. data/lib/purecloud/models/rule_set.rb +6 -3
  128. data/lib/purecloud/models/salesforce.rb +11 -11
  129. data/lib/purecloud/models/{campaign_schedule_intervals.rb → schedule_interval.rb} +5 -5
  130. data/lib/purecloud/models/sequence_schedule.rb +7 -4
  131. data/lib/purecloud/models/station.rb +11 -1
  132. data/lib/purecloud/models/support_credit.rb +197 -0
  133. data/lib/purecloud/models/support_credit_listing.rb +257 -0
  134. data/lib/purecloud/models/system_presence.rb +187 -0
  135. data/lib/purecloud/models/trunk_recording_enabled_count.rb +177 -0
  136. data/lib/purecloud/models/user_image.rb +1 -0
  137. data/lib/purecloud/models/user_me.rb +50 -2
  138. data/lib/purecloud/models/user_routing_skill.rb +18 -11
  139. data/lib/purecloud/models/wrap_up_code_mapping.rb +5 -3
  140. data/lib/purecloud/version.rb +1 -1
  141. data/newVersion.md +1 -1
  142. data/swagger.json +1 -1
  143. data/version.json +1 -1
  144. metadata +32 -8
  145. data/doc_out/CampaignScheduleIntervals.html.md +0 -14
  146. data/doc_out/ObjectsApi.html.md +0 -69
  147. data/lib/purecloud/api/objects_api.rb +0 -87
@@ -83,631 +83,26 @@ module PureCloud
83
83
  return data, status_code, headers
84
84
  end
85
85
 
86
- # Delete Okta Identity Provider
87
- #
88
- # @param [Hash] opts the optional parameters
89
- # @return [nil]
90
- def delete_okta(opts = {})
91
- delete_okta_with_http_info(opts)
92
- return nil
93
- end
94
-
95
- # Delete Okta Identity Provider
96
- #
97
- # @param [Hash] opts the optional parameters
98
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
99
- def delete_okta_with_http_info(opts = {})
100
- if @api_client.config.debugging
101
- @api_client.config.logger.debug "Calling API: OAuthApi#delete_okta ..."
102
- end
103
-
104
- # resource path
105
- local_var_path = "/api/v2/identityproviders/okta".sub('{format}','json')
106
-
107
- # query parameters
108
- query_params = {}
109
-
110
- # header parameters
111
- header_params = {}
112
-
113
- # HTTP header 'Accept' (if needed)
114
- _header_accept = ['application/json']
115
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
116
-
117
- # HTTP header 'Content-Type'
118
- _header_content_type = ['application/json']
119
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
120
-
121
- # form parameters
122
- form_params = {}
123
-
124
- # http body (model)
125
- post_body = nil
126
-
127
- auth_names = ['PureCloud Auth']
128
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
129
- :header_params => header_params,
130
- :query_params => query_params,
131
- :form_params => form_params,
132
- :body => post_body,
133
- :auth_names => auth_names)
134
- if @api_client.config.debugging
135
- @api_client.config.logger.debug "API called: OAuthApi#delete_okta\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
136
- end
137
- return data, status_code, headers
138
- end
139
-
140
- # Delete OneLogin Identity Provider
141
- #
142
- # @param [Hash] opts the optional parameters
143
- # @return [nil]
144
- def delete_onelogin(opts = {})
145
- delete_onelogin_with_http_info(opts)
146
- return nil
147
- end
148
-
149
- # Delete OneLogin Identity Provider
150
- #
151
- # @param [Hash] opts the optional parameters
152
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
153
- def delete_onelogin_with_http_info(opts = {})
154
- if @api_client.config.debugging
155
- @api_client.config.logger.debug "Calling API: OAuthApi#delete_onelogin ..."
156
- end
157
-
158
- # resource path
159
- local_var_path = "/api/v2/identityproviders/onelogin".sub('{format}','json')
160
-
161
- # query parameters
162
- query_params = {}
163
-
164
- # header parameters
165
- header_params = {}
166
-
167
- # HTTP header 'Accept' (if needed)
168
- _header_accept = ['application/json']
169
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
170
-
171
- # HTTP header 'Content-Type'
172
- _header_content_type = ['application/json']
173
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
174
-
175
- # form parameters
176
- form_params = {}
177
-
178
- # http body (model)
179
- post_body = nil
180
-
181
- auth_names = ['PureCloud Auth']
182
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
183
- :header_params => header_params,
184
- :query_params => query_params,
185
- :form_params => form_params,
186
- :body => post_body,
187
- :auth_names => auth_names)
188
- if @api_client.config.debugging
189
- @api_client.config.logger.debug "API called: OAuthApi#delete_onelogin\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
190
- end
191
- return data, status_code, headers
192
- end
193
-
194
- # Delete an identity provider
195
- #
196
- # @param [Hash] opts the optional parameters
197
- # @return [nil]
198
- def delete_provider_id(opts = {})
199
- delete_provider_id_with_http_info(opts)
200
- return nil
201
- end
202
-
203
- # Delete an identity provider
204
- #
205
- # @param [Hash] opts the optional parameters
206
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
207
- def delete_provider_id_with_http_info(opts = {})
208
- if @api_client.config.debugging
209
- @api_client.config.logger.debug "Calling API: OAuthApi#delete_provider_id ..."
210
- end
211
-
212
- # resource path
213
- local_var_path = "/api/v2/identityproviders/{providerId}".sub('{format}','json')
214
-
215
- # query parameters
216
- query_params = {}
217
-
218
- # header parameters
219
- header_params = {}
220
-
221
- # HTTP header 'Accept' (if needed)
222
- _header_accept = ['application/json']
223
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
224
-
225
- # HTTP header 'Content-Type'
226
- _header_content_type = ['application/json']
227
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
228
-
229
- # form parameters
230
- form_params = {}
231
-
232
- # http body (model)
233
- post_body = nil
234
-
235
- auth_names = ['PureCloud Auth']
236
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
237
- :header_params => header_params,
238
- :query_params => query_params,
239
- :form_params => form_params,
240
- :body => post_body,
241
- :auth_names => auth_names)
242
- if @api_client.config.debugging
243
- @api_client.config.logger.debug "API called: OAuthApi#delete_provider_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
244
- end
245
- return data, status_code, headers
246
- end
247
-
248
- # Delete PureCloud Identity Provider
249
- #
250
- # @param [Hash] opts the optional parameters
251
- # @return [nil]
252
- def delete_purecloud(opts = {})
253
- delete_purecloud_with_http_info(opts)
254
- return nil
255
- end
256
-
257
- # Delete PureCloud Identity Provider
258
- #
259
- # @param [Hash] opts the optional parameters
260
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
261
- def delete_purecloud_with_http_info(opts = {})
262
- if @api_client.config.debugging
263
- @api_client.config.logger.debug "Calling API: OAuthApi#delete_purecloud ..."
264
- end
265
-
266
- # resource path
267
- local_var_path = "/api/v2/identityproviders/purecloud".sub('{format}','json')
268
-
269
- # query parameters
270
- query_params = {}
271
-
272
- # header parameters
273
- header_params = {}
274
-
275
- # HTTP header 'Accept' (if needed)
276
- _header_accept = ['application/json']
277
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
278
-
279
- # HTTP header 'Content-Type'
280
- _header_content_type = ['application/json']
281
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
282
-
283
- # form parameters
284
- form_params = {}
285
-
286
- # http body (model)
287
- post_body = nil
288
-
289
- auth_names = ['PureCloud Auth']
290
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
291
- :header_params => header_params,
292
- :query_params => query_params,
293
- :form_params => form_params,
294
- :body => post_body,
295
- :auth_names => auth_names)
296
- if @api_client.config.debugging
297
- @api_client.config.logger.debug "API called: OAuthApi#delete_purecloud\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
298
- end
299
- return data, status_code, headers
300
- end
301
-
302
- # Delete Salesforce Identity Provider
303
- #
304
- # @param [Hash] opts the optional parameters
305
- # @return [nil]
306
- def delete_salesforce(opts = {})
307
- delete_salesforce_with_http_info(opts)
308
- return nil
309
- end
310
-
311
- # Delete Salesforce Identity Provider
312
- #
313
- # @param [Hash] opts the optional parameters
314
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
315
- def delete_salesforce_with_http_info(opts = {})
316
- if @api_client.config.debugging
317
- @api_client.config.logger.debug "Calling API: OAuthApi#delete_salesforce ..."
318
- end
319
-
320
- # resource path
321
- local_var_path = "/api/v2/identityproviders/salesforce".sub('{format}','json')
322
-
323
- # query parameters
324
- query_params = {}
325
-
326
- # header parameters
327
- header_params = {}
328
-
329
- # HTTP header 'Accept' (if needed)
330
- _header_accept = ['application/json']
331
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
332
-
333
- # HTTP header 'Content-Type'
334
- _header_content_type = ['application/json']
335
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
336
-
337
- # form parameters
338
- form_params = {}
339
-
340
- # http body (model)
341
- post_body = nil
342
-
343
- auth_names = ['PureCloud Auth']
344
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
345
- :header_params => header_params,
346
- :query_params => query_params,
347
- :form_params => form_params,
348
- :body => post_body,
349
- :auth_names => auth_names)
350
- if @api_client.config.debugging
351
- @api_client.config.logger.debug "API called: OAuthApi#delete_salesforce\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
352
- end
353
- return data, status_code, headers
354
- end
355
-
356
- # The list of OAuth clients
357
- #
358
- # @param [Hash] opts the optional parameters
359
- # @return [OAuthClientEntityListing]
360
- def get_clients(opts = {})
361
- data, status_code, headers = get_clients_with_http_info(opts)
362
- return data
363
- end
364
-
365
86
  # The list of OAuth clients
366
87
  #
367
88
  # @param [Hash] opts the optional parameters
368
- # @return [Array<(OAuthClientEntityListing, Fixnum, Hash)>] OAuthClientEntityListing data, response status code and response headers
369
- def get_clients_with_http_info(opts = {})
370
- if @api_client.config.debugging
371
- @api_client.config.logger.debug "Calling API: OAuthApi#get_clients ..."
372
- end
373
-
374
- # resource path
375
- local_var_path = "/api/v2/oauth/clients".sub('{format}','json')
376
-
377
- # query parameters
378
- query_params = {}
379
-
380
- # header parameters
381
- header_params = {}
382
-
383
- # HTTP header 'Accept' (if needed)
384
- _header_accept = ['application/json']
385
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
386
-
387
- # HTTP header 'Content-Type'
388
- _header_content_type = ['application/json']
389
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
390
-
391
- # form parameters
392
- form_params = {}
393
-
394
- # http body (model)
395
- post_body = nil
396
-
397
- auth_names = ['PureCloud Auth']
398
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
399
- :header_params => header_params,
400
- :query_params => query_params,
401
- :form_params => form_params,
402
- :body => post_body,
403
- :auth_names => auth_names,
404
- :return_type => 'OAuthClientEntityListing')
405
- if @api_client.config.debugging
406
- @api_client.config.logger.debug "API called: OAuthApi#get_clients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
407
- end
408
- return data, status_code, headers
409
- end
410
-
411
- # Get OAuth Client
412
- #
413
- # @param client_id Client ID
414
- # @param [Hash] opts the optional parameters
415
- # @return [OAuthClient]
416
- def get_clients_client_id(client_id, opts = {})
417
- data, status_code, headers = get_clients_client_id_with_http_info(client_id, opts)
418
- return data
419
- end
420
-
421
- # Get OAuth Client
422
- #
423
- # @param client_id Client ID
424
- # @param [Hash] opts the optional parameters
425
- # @return [Array<(OAuthClient, Fixnum, Hash)>] OAuthClient data, response status code and response headers
426
- def get_clients_client_id_with_http_info(client_id, opts = {})
427
- if @api_client.config.debugging
428
- @api_client.config.logger.debug "Calling API: OAuthApi#get_clients_client_id ..."
429
- end
430
-
431
- # verify the required parameter 'client_id' is set
432
- fail "Missing the required parameter 'client_id' when calling get_clients_client_id" if client_id.nil?
433
-
434
- # resource path
435
- local_var_path = "/api/v2/oauth/clients/{clientId}".sub('{format}','json').sub('{' + 'clientId' + '}', client_id.to_s)
436
-
437
- # query parameters
438
- query_params = {}
439
-
440
- # header parameters
441
- header_params = {}
442
-
443
- # HTTP header 'Accept' (if needed)
444
- _header_accept = ['application/json']
445
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
446
-
447
- # HTTP header 'Content-Type'
448
- _header_content_type = ['application/json']
449
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
450
-
451
- # form parameters
452
- form_params = {}
453
-
454
- # http body (model)
455
- post_body = nil
456
-
457
- auth_names = ['PureCloud Auth']
458
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
459
- :header_params => header_params,
460
- :query_params => query_params,
461
- :form_params => form_params,
462
- :body => post_body,
463
- :auth_names => auth_names,
464
- :return_type => 'OAuthClient')
465
- if @api_client.config.debugging
466
- @api_client.config.logger.debug "API called: OAuthApi#get_clients_client_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
467
- end
468
- return data, status_code, headers
469
- end
470
-
471
- # The list of identity providers
472
- #
473
- # @param [Hash] opts the optional parameters
474
- # @return [OAuthProviderEntityListing]
475
- def get_identityproviders(opts = {})
476
- data, status_code, headers = get_identityproviders_with_http_info(opts)
477
- return data
478
- end
479
-
480
- # The list of identity providers
481
- #
482
- # @param [Hash] opts the optional parameters
483
- # @return [Array<(OAuthProviderEntityListing, Fixnum, Hash)>] OAuthProviderEntityListing data, response status code and response headers
484
- def get_identityproviders_with_http_info(opts = {})
485
- if @api_client.config.debugging
486
- @api_client.config.logger.debug "Calling API: OAuthApi#get_identityproviders ..."
487
- end
488
-
489
- # resource path
490
- local_var_path = "/api/v2/identityproviders".sub('{format}','json')
491
-
492
- # query parameters
493
- query_params = {}
494
-
495
- # header parameters
496
- header_params = {}
497
-
498
- # HTTP header 'Accept' (if needed)
499
- _header_accept = ['application/json']
500
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
501
-
502
- # HTTP header 'Content-Type'
503
- _header_content_type = ['application/json']
504
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
505
-
506
- # form parameters
507
- form_params = {}
508
-
509
- # http body (model)
510
- post_body = nil
511
-
512
- auth_names = ['PureCloud Auth']
513
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
514
- :header_params => header_params,
515
- :query_params => query_params,
516
- :form_params => form_params,
517
- :body => post_body,
518
- :auth_names => auth_names,
519
- :return_type => 'OAuthProviderEntityListing')
520
- if @api_client.config.debugging
521
- @api_client.config.logger.debug "API called: OAuthApi#get_identityproviders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
522
- end
523
- return data, status_code, headers
524
- end
525
-
526
- # Get Okta Identity Provider
527
- #
528
- # @param [Hash] opts the optional parameters
529
- # @return [Okta]
530
- def get_okta(opts = {})
531
- data, status_code, headers = get_okta_with_http_info(opts)
532
- return data
533
- end
534
-
535
- # Get Okta Identity Provider
536
- #
537
- # @param [Hash] opts the optional parameters
538
- # @return [Array<(Okta, Fixnum, Hash)>] Okta data, response status code and response headers
539
- def get_okta_with_http_info(opts = {})
540
- if @api_client.config.debugging
541
- @api_client.config.logger.debug "Calling API: OAuthApi#get_okta ..."
542
- end
543
-
544
- # resource path
545
- local_var_path = "/api/v2/identityproviders/okta".sub('{format}','json')
546
-
547
- # query parameters
548
- query_params = {}
549
-
550
- # header parameters
551
- header_params = {}
552
-
553
- # HTTP header 'Accept' (if needed)
554
- _header_accept = ['application/json']
555
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
556
-
557
- # HTTP header 'Content-Type'
558
- _header_content_type = ['application/json']
559
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
560
-
561
- # form parameters
562
- form_params = {}
563
-
564
- # http body (model)
565
- post_body = nil
566
-
567
- auth_names = ['PureCloud Auth']
568
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
569
- :header_params => header_params,
570
- :query_params => query_params,
571
- :form_params => form_params,
572
- :body => post_body,
573
- :auth_names => auth_names,
574
- :return_type => 'Okta')
575
- if @api_client.config.debugging
576
- @api_client.config.logger.debug "API called: OAuthApi#get_okta\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
577
- end
578
- return data, status_code, headers
579
- end
580
-
581
- # Get OneLogin Identity Provider
582
- #
583
- # @param [Hash] opts the optional parameters
584
- # @return [OneLogin]
585
- def get_onelogin(opts = {})
586
- data, status_code, headers = get_onelogin_with_http_info(opts)
587
- return data
588
- end
589
-
590
- # Get OneLogin Identity Provider
591
- #
592
- # @param [Hash] opts the optional parameters
593
- # @return [Array<(OneLogin, Fixnum, Hash)>] OneLogin data, response status code and response headers
594
- def get_onelogin_with_http_info(opts = {})
595
- if @api_client.config.debugging
596
- @api_client.config.logger.debug "Calling API: OAuthApi#get_onelogin ..."
597
- end
598
-
599
- # resource path
600
- local_var_path = "/api/v2/identityproviders/onelogin".sub('{format}','json')
601
-
602
- # query parameters
603
- query_params = {}
604
-
605
- # header parameters
606
- header_params = {}
607
-
608
- # HTTP header 'Accept' (if needed)
609
- _header_accept = ['application/json']
610
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
611
-
612
- # HTTP header 'Content-Type'
613
- _header_content_type = ['application/json']
614
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
615
-
616
- # form parameters
617
- form_params = {}
618
-
619
- # http body (model)
620
- post_body = nil
621
-
622
- auth_names = ['PureCloud Auth']
623
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
624
- :header_params => header_params,
625
- :query_params => query_params,
626
- :form_params => form_params,
627
- :body => post_body,
628
- :auth_names => auth_names,
629
- :return_type => 'OneLogin')
630
- if @api_client.config.debugging
631
- @api_client.config.logger.debug "API called: OAuthApi#get_onelogin\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
632
- end
633
- return data, status_code, headers
634
- end
635
-
636
- # Get an identity provider
637
- #
638
- # @param [Hash] opts the optional parameters
639
- # @return [OAuthProvider]
640
- def get_provider_id(opts = {})
641
- data, status_code, headers = get_provider_id_with_http_info(opts)
642
- return data
643
- end
644
-
645
- # Get an identity provider
646
- #
647
- # @param [Hash] opts the optional parameters
648
- # @return [Array<(OAuthProvider, Fixnum, Hash)>] OAuthProvider data, response status code and response headers
649
- def get_provider_id_with_http_info(opts = {})
650
- if @api_client.config.debugging
651
- @api_client.config.logger.debug "Calling API: OAuthApi#get_provider_id ..."
652
- end
653
-
654
- # resource path
655
- local_var_path = "/api/v2/identityproviders/{providerId}".sub('{format}','json')
656
-
657
- # query parameters
658
- query_params = {}
659
-
660
- # header parameters
661
- header_params = {}
662
-
663
- # HTTP header 'Accept' (if needed)
664
- _header_accept = ['application/json']
665
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
666
-
667
- # HTTP header 'Content-Type'
668
- _header_content_type = ['application/json']
669
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
670
-
671
- # form parameters
672
- form_params = {}
673
-
674
- # http body (model)
675
- post_body = nil
676
-
677
- auth_names = ['PureCloud Auth']
678
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
679
- :header_params => header_params,
680
- :query_params => query_params,
681
- :form_params => form_params,
682
- :body => post_body,
683
- :auth_names => auth_names,
684
- :return_type => 'OAuthProvider')
685
- if @api_client.config.debugging
686
- @api_client.config.logger.debug "API called: OAuthApi#get_provider_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
687
- end
688
- return data, status_code, headers
689
- end
690
-
691
- # Get PureCloud Identity Provider
692
- #
693
- # @param [Hash] opts the optional parameters
694
- # @return [PureCloud]
695
- def get_purecloud(opts = {})
696
- data, status_code, headers = get_purecloud_with_http_info(opts)
89
+ # @return [OAuthClientEntityListing]
90
+ def get_clients(opts = {})
91
+ data, status_code, headers = get_clients_with_http_info(opts)
697
92
  return data
698
93
  end
699
94
 
700
- # Get PureCloud Identity Provider
95
+ # The list of OAuth clients
701
96
  #
702
97
  # @param [Hash] opts the optional parameters
703
- # @return [Array<(PureCloud, Fixnum, Hash)>] PureCloud data, response status code and response headers
704
- def get_purecloud_with_http_info(opts = {})
98
+ # @return [Array<(OAuthClientEntityListing, Fixnum, Hash)>] OAuthClientEntityListing data, response status code and response headers
99
+ def get_clients_with_http_info(opts = {})
705
100
  if @api_client.config.debugging
706
- @api_client.config.logger.debug "Calling API: OAuthApi#get_purecloud ..."
101
+ @api_client.config.logger.debug "Calling API: OAuthApi#get_clients ..."
707
102
  end
708
103
 
709
104
  # resource path
710
- local_var_path = "/api/v2/identityproviders/purecloud".sub('{format}','json')
105
+ local_var_path = "/api/v2/oauth/clients".sub('{format}','json')
711
106
 
712
107
  # query parameters
713
108
  query_params = {}
@@ -736,33 +131,38 @@ module PureCloud
736
131
  :form_params => form_params,
737
132
  :body => post_body,
738
133
  :auth_names => auth_names,
739
- :return_type => 'PureCloud')
134
+ :return_type => 'OAuthClientEntityListing')
740
135
  if @api_client.config.debugging
741
- @api_client.config.logger.debug "API called: OAuthApi#get_purecloud\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
136
+ @api_client.config.logger.debug "API called: OAuthApi#get_clients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
742
137
  end
743
138
  return data, status_code, headers
744
139
  end
745
140
 
746
- # Get Salesforce Identity Provider
141
+ # Get OAuth Client
747
142
  #
143
+ # @param client_id Client ID
748
144
  # @param [Hash] opts the optional parameters
749
- # @return [Salesforce]
750
- def get_salesforce(opts = {})
751
- data, status_code, headers = get_salesforce_with_http_info(opts)
145
+ # @return [OAuthClient]
146
+ def get_clients_client_id(client_id, opts = {})
147
+ data, status_code, headers = get_clients_client_id_with_http_info(client_id, opts)
752
148
  return data
753
149
  end
754
150
 
755
- # Get Salesforce Identity Provider
151
+ # Get OAuth Client
756
152
  #
153
+ # @param client_id Client ID
757
154
  # @param [Hash] opts the optional parameters
758
- # @return [Array<(Salesforce, Fixnum, Hash)>] Salesforce data, response status code and response headers
759
- def get_salesforce_with_http_info(opts = {})
155
+ # @return [Array<(OAuthClient, Fixnum, Hash)>] OAuthClient data, response status code and response headers
156
+ def get_clients_client_id_with_http_info(client_id, opts = {})
760
157
  if @api_client.config.debugging
761
- @api_client.config.logger.debug "Calling API: OAuthApi#get_salesforce ..."
158
+ @api_client.config.logger.debug "Calling API: OAuthApi#get_clients_client_id ..."
762
159
  end
763
160
 
161
+ # verify the required parameter 'client_id' is set
162
+ fail "Missing the required parameter 'client_id' when calling get_clients_client_id" if client_id.nil?
163
+
764
164
  # resource path
765
- local_var_path = "/api/v2/identityproviders/salesforce".sub('{format}','json')
165
+ local_var_path = "/api/v2/oauth/clients/{clientId}".sub('{format}','json').sub('{' + 'clientId' + '}', client_id.to_s)
766
166
 
767
167
  # query parameters
768
168
  query_params = {}
@@ -791,9 +191,9 @@ module PureCloud
791
191
  :form_params => form_params,
792
192
  :body => post_body,
793
193
  :auth_names => auth_names,
794
- :return_type => 'Salesforce')
194
+ :return_type => 'OAuthClient')
795
195
  if @api_client.config.debugging
796
- @api_client.config.logger.debug "API called: OAuthApi#get_salesforce\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
196
+ @api_client.config.logger.debug "API called: OAuthApi#get_clients_client_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
797
197
  end
798
198
  return data, status_code, headers
799
199
  end
@@ -975,285 +375,5 @@ module PureCloud
975
375
  end
976
376
  return data, status_code, headers
977
377
  end
978
-
979
- # Update/Create Okta Identity Provider
980
- #
981
- # @param [Hash] opts the optional parameters
982
- # @option opts [Okta] :body Provider
983
- # @return [nil]
984
- def put_okta(opts = {})
985
- put_okta_with_http_info(opts)
986
- return nil
987
- end
988
-
989
- # Update/Create Okta Identity Provider
990
- #
991
- # @param [Hash] opts the optional parameters
992
- # @option opts [Okta] :body Provider
993
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
994
- def put_okta_with_http_info(opts = {})
995
- if @api_client.config.debugging
996
- @api_client.config.logger.debug "Calling API: OAuthApi#put_okta ..."
997
- end
998
-
999
- # resource path
1000
- local_var_path = "/api/v2/identityproviders/okta".sub('{format}','json')
1001
-
1002
- # query parameters
1003
- query_params = {}
1004
-
1005
- # header parameters
1006
- header_params = {}
1007
-
1008
- # HTTP header 'Accept' (if needed)
1009
- _header_accept = ['application/json']
1010
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1011
-
1012
- # HTTP header 'Content-Type'
1013
- _header_content_type = ['application/json']
1014
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1015
-
1016
- # form parameters
1017
- form_params = {}
1018
-
1019
- # http body (model)
1020
- post_body = @api_client.object_to_http_body(opts[:'body'])
1021
-
1022
- auth_names = ['PureCloud Auth']
1023
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1024
- :header_params => header_params,
1025
- :query_params => query_params,
1026
- :form_params => form_params,
1027
- :body => post_body,
1028
- :auth_names => auth_names)
1029
- if @api_client.config.debugging
1030
- @api_client.config.logger.debug "API called: OAuthApi#put_okta\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1031
- end
1032
- return data, status_code, headers
1033
- end
1034
-
1035
- # Update/Create OneLogin Identity Provider
1036
- #
1037
- # @param [Hash] opts the optional parameters
1038
- # @option opts [OneLogin] :body Provider
1039
- # @return [nil]
1040
- def put_onelogin(opts = {})
1041
- put_onelogin_with_http_info(opts)
1042
- return nil
1043
- end
1044
-
1045
- # Update/Create OneLogin Identity Provider
1046
- #
1047
- # @param [Hash] opts the optional parameters
1048
- # @option opts [OneLogin] :body Provider
1049
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1050
- def put_onelogin_with_http_info(opts = {})
1051
- if @api_client.config.debugging
1052
- @api_client.config.logger.debug "Calling API: OAuthApi#put_onelogin ..."
1053
- end
1054
-
1055
- # resource path
1056
- local_var_path = "/api/v2/identityproviders/onelogin".sub('{format}','json')
1057
-
1058
- # query parameters
1059
- query_params = {}
1060
-
1061
- # header parameters
1062
- header_params = {}
1063
-
1064
- # HTTP header 'Accept' (if needed)
1065
- _header_accept = ['application/json']
1066
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1067
-
1068
- # HTTP header 'Content-Type'
1069
- _header_content_type = ['application/json']
1070
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1071
-
1072
- # form parameters
1073
- form_params = {}
1074
-
1075
- # http body (model)
1076
- post_body = @api_client.object_to_http_body(opts[:'body'])
1077
-
1078
- auth_names = ['PureCloud Auth']
1079
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1080
- :header_params => header_params,
1081
- :query_params => query_params,
1082
- :form_params => form_params,
1083
- :body => post_body,
1084
- :auth_names => auth_names)
1085
- if @api_client.config.debugging
1086
- @api_client.config.logger.debug "API called: OAuthApi#put_onelogin\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1087
- end
1088
- return data, status_code, headers
1089
- end
1090
-
1091
- # Update an identity provider
1092
- #
1093
- # @param [Hash] opts the optional parameters
1094
- # @option opts [OAuthProvider] :body Provider
1095
- # @return [nil]
1096
- def put_provider_id(opts = {})
1097
- put_provider_id_with_http_info(opts)
1098
- return nil
1099
- end
1100
-
1101
- # Update an identity provider
1102
- #
1103
- # @param [Hash] opts the optional parameters
1104
- # @option opts [OAuthProvider] :body Provider
1105
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1106
- def put_provider_id_with_http_info(opts = {})
1107
- if @api_client.config.debugging
1108
- @api_client.config.logger.debug "Calling API: OAuthApi#put_provider_id ..."
1109
- end
1110
-
1111
- # resource path
1112
- local_var_path = "/api/v2/identityproviders/{providerId}".sub('{format}','json')
1113
-
1114
- # query parameters
1115
- query_params = {}
1116
-
1117
- # header parameters
1118
- header_params = {}
1119
-
1120
- # HTTP header 'Accept' (if needed)
1121
- _header_accept = ['application/json']
1122
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1123
-
1124
- # HTTP header 'Content-Type'
1125
- _header_content_type = ['application/json']
1126
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1127
-
1128
- # form parameters
1129
- form_params = {}
1130
-
1131
- # http body (model)
1132
- post_body = @api_client.object_to_http_body(opts[:'body'])
1133
-
1134
- auth_names = ['PureCloud Auth']
1135
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1136
- :header_params => header_params,
1137
- :query_params => query_params,
1138
- :form_params => form_params,
1139
- :body => post_body,
1140
- :auth_names => auth_names)
1141
- if @api_client.config.debugging
1142
- @api_client.config.logger.debug "API called: OAuthApi#put_provider_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1143
- end
1144
- return data, status_code, headers
1145
- end
1146
-
1147
- # Update/Create PureCloud Identity Provider
1148
- #
1149
- # @param [Hash] opts the optional parameters
1150
- # @option opts [PureCloud] :body Provider
1151
- # @return [nil]
1152
- def put_purecloud(opts = {})
1153
- put_purecloud_with_http_info(opts)
1154
- return nil
1155
- end
1156
-
1157
- # Update/Create PureCloud Identity Provider
1158
- #
1159
- # @param [Hash] opts the optional parameters
1160
- # @option opts [PureCloud] :body Provider
1161
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1162
- def put_purecloud_with_http_info(opts = {})
1163
- if @api_client.config.debugging
1164
- @api_client.config.logger.debug "Calling API: OAuthApi#put_purecloud ..."
1165
- end
1166
-
1167
- # resource path
1168
- local_var_path = "/api/v2/identityproviders/purecloud".sub('{format}','json')
1169
-
1170
- # query parameters
1171
- query_params = {}
1172
-
1173
- # header parameters
1174
- header_params = {}
1175
-
1176
- # HTTP header 'Accept' (if needed)
1177
- _header_accept = ['application/json']
1178
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1179
-
1180
- # HTTP header 'Content-Type'
1181
- _header_content_type = ['application/json']
1182
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1183
-
1184
- # form parameters
1185
- form_params = {}
1186
-
1187
- # http body (model)
1188
- post_body = @api_client.object_to_http_body(opts[:'body'])
1189
-
1190
- auth_names = ['PureCloud Auth']
1191
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1192
- :header_params => header_params,
1193
- :query_params => query_params,
1194
- :form_params => form_params,
1195
- :body => post_body,
1196
- :auth_names => auth_names)
1197
- if @api_client.config.debugging
1198
- @api_client.config.logger.debug "API called: OAuthApi#put_purecloud\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1199
- end
1200
- return data, status_code, headers
1201
- end
1202
-
1203
- # Update/Create Salesforce Identity Provider
1204
- #
1205
- # @param [Hash] opts the optional parameters
1206
- # @option opts [Salesforce] :body Provider
1207
- # @return [nil]
1208
- def put_salesforce(opts = {})
1209
- put_salesforce_with_http_info(opts)
1210
- return nil
1211
- end
1212
-
1213
- # Update/Create Salesforce Identity Provider
1214
- #
1215
- # @param [Hash] opts the optional parameters
1216
- # @option opts [Salesforce] :body Provider
1217
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1218
- def put_salesforce_with_http_info(opts = {})
1219
- if @api_client.config.debugging
1220
- @api_client.config.logger.debug "Calling API: OAuthApi#put_salesforce ..."
1221
- end
1222
-
1223
- # resource path
1224
- local_var_path = "/api/v2/identityproviders/salesforce".sub('{format}','json')
1225
-
1226
- # query parameters
1227
- query_params = {}
1228
-
1229
- # header parameters
1230
- header_params = {}
1231
-
1232
- # HTTP header 'Accept' (if needed)
1233
- _header_accept = ['application/json']
1234
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1235
-
1236
- # HTTP header 'Content-Type'
1237
- _header_content_type = ['application/json']
1238
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1239
-
1240
- # form parameters
1241
- form_params = {}
1242
-
1243
- # http body (model)
1244
- post_body = @api_client.object_to_http_body(opts[:'body'])
1245
-
1246
- auth_names = ['PureCloud Auth']
1247
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1248
- :header_params => header_params,
1249
- :query_params => query_params,
1250
- :form_params => form_params,
1251
- :body => post_body,
1252
- :auth_names => auth_names)
1253
- if @api_client.config.debugging
1254
- @api_client.config.logger.debug "API called: OAuthApi#put_salesforce\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1255
- end
1256
- return data, status_code, headers
1257
- end
1258
378
  end
1259
379
  end