purecloudplatformclientv2 87.0.0 → 92.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (179) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -5
  3. data/docs/AmazonLexRequest.md +14 -0
  4. data/docs/AnalyticsEvaluation.md +1 -1
  5. data/docs/ApiUsageQuery.md +16 -0
  6. data/docs/ApiUsageQueryResult.md +14 -0
  7. data/docs/ApiUsageRow.md +25 -0
  8. data/docs/ArchitectApi.md +132 -0
  9. data/docs/AuditApi.md +130 -0
  10. data/docs/AuditQueryEntity.md +14 -0
  11. data/docs/AuditQueryExecutionStatusResponse.md +1 -0
  12. data/docs/AuditQueryRequest.md +1 -0
  13. data/docs/AuditQueryService.md +14 -0
  14. data/docs/AuditQueryServiceMapping.md +13 -0
  15. data/docs/AuditQuerySort.md +14 -0
  16. data/docs/AuditRealtimeQueryRequest.md +18 -0
  17. data/docs/AuditRealtimeQueryResultsResponse.md +17 -0
  18. data/docs/BuAgentScheduleActivity.md +2 -0
  19. data/docs/BuRescheduleRequest.md +2 -2
  20. data/docs/ButtonComponent.md +16 -0
  21. data/docs/CoachingApi.md +1 -1
  22. data/docs/ContentActions.md +17 -0
  23. data/docs/ContentAttachment.md +19 -0
  24. data/docs/ContentGeneric.md +19 -0
  25. data/docs/ContentList.md +19 -0
  26. data/docs/ContentLocation.md +17 -0
  27. data/docs/ContentNotificationTemplate.md +17 -0
  28. data/docs/ContentQuickReply.md +16 -0
  29. data/docs/ConversationAggregationQuery.md +1 -1
  30. data/docs/CreateQueueRequest.md +1 -0
  31. data/docs/EdgeGroup.md +1 -0
  32. data/docs/EntityListing.md +1 -5
  33. data/docs/EvaluationAggregationQuery.md +1 -1
  34. data/docs/ExternalContact.md +2 -0
  35. data/docs/ExternalOrganization.md +2 -0
  36. data/docs/FlowAggregationQuery.md +1 -1
  37. data/docs/FlowExecutionLaunchRequest.md +16 -0
  38. data/docs/FlowExecutionLaunchResponse.md +16 -0
  39. data/docs/FlowRuntimeExecution.md +23 -0
  40. data/docs/GenericSAML.md +22 -0
  41. data/docs/GoogleDialogflowCustomSettings.md +13 -0
  42. data/docs/GroupsApi.md +4 -4
  43. data/docs/IdentityProviderApi.md +187 -0
  44. data/docs/IpAddressAuthentication.md +13 -0
  45. data/docs/KnowledgeSearchResponse.md +1 -1
  46. data/docs/LanguageUnderstandingApi.md +164 -30
  47. data/docs/ListItemComponent.md +19 -0
  48. data/docs/MessageContent.md +19 -0
  49. data/docs/NluDomainVersion.md +3 -1
  50. data/docs/NotificationTemplateBody.md +14 -0
  51. data/docs/NotificationTemplateFooter.md +13 -0
  52. data/docs/NotificationTemplateHeader.md +16 -0
  53. data/docs/NotificationTemplateParameter.md +14 -0
  54. data/docs/OAuthApi.md +208 -0
  55. data/docs/OrganizationApi.md +126 -0
  56. data/docs/PostTextMessage.md +15 -0
  57. data/docs/PostTextRequest.md +23 -0
  58. data/docs/PostTextResponse.md +20 -0
  59. data/docs/Prompt.md +2 -2
  60. data/docs/Queue.md +1 -0
  61. data/docs/QueueRequest.md +1 -0
  62. data/docs/RecordingApi.md +12 -0
  63. data/docs/ReportingDataExportTopicDataExportNotification.md +1 -0
  64. data/docs/ScimEmail.md +1 -1
  65. data/docs/SurveyAggregationQuery.md +1 -1
  66. data/docs/SurveyForm.md +0 -2
  67. data/docs/TextbotsApi.md +78 -0
  68. data/docs/UploadUrlRequest.md +1 -0
  69. data/docs/UsageApi.md +144 -0
  70. data/docs/UsageExecutionResult.md +14 -0
  71. data/docs/UserAggregationQuery.md +1 -1
  72. data/docs/UserQueue.md +1 -0
  73. data/docs/UsersApi.md +5 -5
  74. data/docs/ViewFilter.md +2 -0
  75. data/docs/VoicemailMessagesTopicOwner.md +13 -0
  76. data/docs/VoicemailMessagesTopicVoicemailCopyRecord.md +14 -0
  77. data/docs/VoicemailMessagesTopicVoicemailMessage.md +2 -0
  78. data/docs/WfmBuShortTermForecastImportCompleteTopicBuForecastModification.md +23 -0
  79. data/docs/WfmBuShortTermForecastImportCompleteTopicBuShortTermForecast.md +24 -0
  80. data/docs/WfmBuShortTermForecastImportCompleteTopicBuShortTermForecastNotification.md +15 -0
  81. data/docs/WfmBuShortTermForecastImportCompleteTopicForecastSourceDayPointer.md +17 -0
  82. data/docs/WfmBuShortTermForecastImportCompleteTopicModificationIntervalOffsetValue.md +14 -0
  83. data/docs/WfmBuShortTermForecastImportCompleteTopicUserReference.md +13 -0
  84. data/docs/WfmBuShortTermForecastImportCompleteTopicWfmVersionedEntityMetadata.md +15 -0
  85. data/docs/WorkforceManagementApi.md +3 -3
  86. data/lib/purecloudplatformclientv2.rb +45 -0
  87. data/lib/purecloudplatformclientv2/api/architect_api.rb +130 -0
  88. data/lib/purecloudplatformclientv2/api/audit_api.rb +129 -0
  89. data/lib/purecloudplatformclientv2/api/groups_api.rb +4 -4
  90. data/lib/purecloudplatformclientv2/api/identity_provider_api.rb +175 -0
  91. data/lib/purecloudplatformclientv2/api/language_understanding_api.rb +189 -30
  92. data/lib/purecloudplatformclientv2/api/o_auth_api.rb +224 -0
  93. data/lib/purecloudplatformclientv2/api/organization_api.rb +120 -0
  94. data/lib/purecloudplatformclientv2/api/recording_api.rb +78 -0
  95. data/lib/purecloudplatformclientv2/api/textbots_api.rb +92 -0
  96. data/lib/purecloudplatformclientv2/api/usage_api.rb +157 -0
  97. data/lib/purecloudplatformclientv2/api/users_api.rb +4 -4
  98. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +6 -6
  99. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  100. data/lib/purecloudplatformclientv2/models/amazon_lex_request.rb +232 -0
  101. data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +13 -13
  102. data/lib/purecloudplatformclientv2/models/api_usage_query.rb +303 -0
  103. data/lib/purecloudplatformclientv2/models/api_usage_query_result.rb +244 -0
  104. data/lib/purecloudplatformclientv2/models/api_usage_row.rb +514 -0
  105. data/lib/purecloudplatformclientv2/models/audit_log_message.rb +6 -6
  106. data/lib/purecloudplatformclientv2/models/audit_query_entity.rb +244 -0
  107. data/lib/purecloudplatformclientv2/models/audit_query_execution_status_response.rb +34 -6
  108. data/lib/purecloudplatformclientv2/models/audit_query_request.rb +34 -6
  109. data/lib/purecloudplatformclientv2/models/audit_query_service.rb +244 -0
  110. data/lib/purecloudplatformclientv2/models/audit_query_service_mapping.rb +204 -0
  111. data/lib/purecloudplatformclientv2/models/audit_query_sort.rb +266 -0
  112. data/lib/purecloudplatformclientv2/models/audit_realtime_query_request.rb +360 -0
  113. data/lib/purecloudplatformclientv2/models/audit_realtime_query_results_response.rb +303 -0
  114. data/lib/purecloudplatformclientv2/models/bu_agent_schedule_activity.rb +70 -4
  115. data/lib/purecloudplatformclientv2/models/bu_reschedule_request.rb +2 -12
  116. data/lib/purecloudplatformclientv2/models/button_component.rb +281 -0
  117. data/lib/purecloudplatformclientv2/models/coaching_appointment_response.rb +2 -2
  118. data/lib/purecloudplatformclientv2/models/coaching_notification.rb +2 -2
  119. data/lib/purecloudplatformclientv2/models/content_actions.rb +309 -0
  120. data/lib/purecloudplatformclientv2/models/content_attachment.rb +378 -0
  121. data/lib/purecloudplatformclientv2/models/content_generic.rb +361 -0
  122. data/lib/purecloudplatformclientv2/models/content_list.rb +375 -0
  123. data/lib/purecloudplatformclientv2/models/content_location.rb +307 -0
  124. data/lib/purecloudplatformclientv2/models/content_notification_template.rb +312 -0
  125. data/lib/purecloudplatformclientv2/models/content_quick_reply.rb +300 -0
  126. data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
  127. data/lib/purecloudplatformclientv2/models/conversation_aggregation_query.rb +1 -1
  128. data/lib/purecloudplatformclientv2/models/create_queue_request.rb +29 -1
  129. data/lib/purecloudplatformclientv2/models/edge_group.rb +27 -1
  130. data/lib/purecloudplatformclientv2/models/entity_listing.rb +4 -104
  131. data/lib/purecloudplatformclientv2/models/evaluation_aggregation_query.rb +1 -1
  132. data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
  133. data/lib/purecloudplatformclientv2/models/external_contact.rb +55 -1
  134. data/lib/purecloudplatformclientv2/models/external_organization.rb +55 -1
  135. data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
  136. data/lib/purecloudplatformclientv2/models/flow_aggregation_query.rb +1 -1
  137. data/lib/purecloudplatformclientv2/models/flow_execution_launch_request.rb +288 -0
  138. data/lib/purecloudplatformclientv2/models/flow_execution_launch_response.rb +281 -0
  139. data/lib/purecloudplatformclientv2/models/flow_runtime_execution.rb +494 -0
  140. data/lib/purecloudplatformclientv2/models/generic_saml.rb +428 -0
  141. data/lib/purecloudplatformclientv2/models/google_dialogflow_custom_settings.rb +202 -0
  142. data/lib/purecloudplatformclientv2/models/ip_address_authentication.rb +203 -0
  143. data/lib/purecloudplatformclientv2/models/knowledge_search_response.rb +18 -18
  144. data/lib/purecloudplatformclientv2/models/list_item_component.rb +373 -0
  145. data/lib/purecloudplatformclientv2/models/message_content.rb +378 -0
  146. data/lib/purecloudplatformclientv2/models/nlu_domain_version.rb +72 -1
  147. data/lib/purecloudplatformclientv2/models/notification_template_body.rb +236 -0
  148. data/lib/purecloudplatformclientv2/models/notification_template_footer.rb +203 -0
  149. data/lib/purecloudplatformclientv2/models/notification_template_header.rb +302 -0
  150. data/lib/purecloudplatformclientv2/models/notification_template_parameter.rb +234 -0
  151. data/lib/purecloudplatformclientv2/models/post_text_message.rb +275 -0
  152. data/lib/purecloudplatformclientv2/models/post_text_request.rb +482 -0
  153. data/lib/purecloudplatformclientv2/models/post_text_response.rb +413 -0
  154. data/lib/purecloudplatformclientv2/models/prompt.rb +2 -0
  155. data/lib/purecloudplatformclientv2/models/prompt_asset.rb +15 -1
  156. data/lib/purecloudplatformclientv2/models/prompt_asset_create.rb +15 -1
  157. data/lib/purecloudplatformclientv2/models/queue.rb +29 -1
  158. data/lib/purecloudplatformclientv2/models/queue_request.rb +29 -1
  159. data/lib/purecloudplatformclientv2/models/reporting_data_export_topic_data_export_notification.rb +31 -4
  160. data/lib/purecloudplatformclientv2/models/scim_email.rb +1 -1
  161. data/lib/purecloudplatformclientv2/models/survey_aggregation_query.rb +1 -1
  162. data/lib/purecloudplatformclientv2/models/survey_form.rb +1 -53
  163. data/lib/purecloudplatformclientv2/models/upload_url_request.rb +43 -4
  164. data/lib/purecloudplatformclientv2/models/usage_execution_result.rb +228 -0
  165. data/lib/purecloudplatformclientv2/models/user_aggregation_query.rb +1 -1
  166. data/lib/purecloudplatformclientv2/models/user_queue.rb +29 -1
  167. data/lib/purecloudplatformclientv2/models/view_filter.rb +58 -4
  168. data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_owner.rb +201 -0
  169. data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_voicemail_copy_record.rb +226 -0
  170. data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_voicemail_message.rb +56 -4
  171. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_forecast_modification.rb +497 -0
  172. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast.rb +494 -0
  173. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast_notification.rb +265 -0
  174. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_forecast_source_day_pointer.rb +315 -0
  175. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_modification_interval_offset_value.rb +226 -0
  176. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_user_reference.rb +201 -0
  177. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_wfm_versioned_entity_metadata.rb +251 -0
  178. data/lib/purecloudplatformclientv2/version.rb +1 -1
  179. metadata +92 -2
@@ -425,11 +425,11 @@ Name | Type | Description | Notes
425
425
 
426
426
  ## [**GroupProfile**](GroupProfile.html) get_group_profile(group_id, opts)
427
427
 
428
-
428
+ <span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
429
429
 
430
430
  Get group profile
431
431
 
432
-
432
+ This api is deprecated. Use /api/v2/groups instead
433
433
 
434
434
  Wraps GET /api/v2/groups/{groupId}/profile
435
435
 
@@ -634,11 +634,11 @@ Name | Type | Description | Notes
634
634
 
635
635
  ## [**GroupProfileEntityListing**](GroupProfileEntityListing.html) get_profiles_groups(opts)
636
636
 
637
-
637
+ <span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
638
638
 
639
639
  Get group profile listing
640
640
 
641
-
641
+ This api is deprecated. Use /api/v2/groups instead.
642
642
 
643
643
  Wraps GET /api/v2/profiles/groups
644
644
 
@@ -10,6 +10,7 @@ Method | Description
10
10
  ------------- | ------------- | -------------
11
11
  [**delete_identityproviders_adfs**](IdentityProviderApi.html#delete_identityproviders_adfs) | Delete ADFS Identity Provider
12
12
  [**delete_identityproviders_cic**](IdentityProviderApi.html#delete_identityproviders_cic) | Delete Customer Interaction Center (CIC) Identity Provider
13
+ [**delete_identityproviders_generic**](IdentityProviderApi.html#delete_identityproviders_generic) | Delete Generic SAML Identity Provider
13
14
  [**delete_identityproviders_gsuite**](IdentityProviderApi.html#delete_identityproviders_gsuite) | Delete G Suite Identity Provider
14
15
  [**delete_identityproviders_identitynow**](IdentityProviderApi.html#delete_identityproviders_identitynow) | Delete IdentityNow Provider
15
16
  [**delete_identityproviders_okta**](IdentityProviderApi.html#delete_identityproviders_okta) | Delete Okta Identity Provider
@@ -21,6 +22,7 @@ Method | Description
21
22
  [**get_identityproviders**](IdentityProviderApi.html#get_identityproviders) | The list of identity providers
22
23
  [**get_identityproviders_adfs**](IdentityProviderApi.html#get_identityproviders_adfs) | Get ADFS Identity Provider
23
24
  [**get_identityproviders_cic**](IdentityProviderApi.html#get_identityproviders_cic) | Get Customer Interaction Center (CIC) Identity Provider
25
+ [**get_identityproviders_generic**](IdentityProviderApi.html#get_identityproviders_generic) | Get Generic SAML Identity Provider
24
26
  [**get_identityproviders_gsuite**](IdentityProviderApi.html#get_identityproviders_gsuite) | Get G Suite Identity Provider
25
27
  [**get_identityproviders_identitynow**](IdentityProviderApi.html#get_identityproviders_identitynow) | Get IdentityNow Provider
26
28
  [**get_identityproviders_okta**](IdentityProviderApi.html#get_identityproviders_okta) | Get Okta Identity Provider
@@ -31,6 +33,7 @@ Method | Description
31
33
  [**get_identityproviders_salesforce**](IdentityProviderApi.html#get_identityproviders_salesforce) | Get Salesforce Identity Provider
32
34
  [**put_identityproviders_adfs**](IdentityProviderApi.html#put_identityproviders_adfs) | Update/Create ADFS Identity Provider
33
35
  [**put_identityproviders_cic**](IdentityProviderApi.html#put_identityproviders_cic) | Update/Create Customer Interaction Center (CIC) Identity Provider
36
+ [**put_identityproviders_generic**](IdentityProviderApi.html#put_identityproviders_generic) | Update/Create Generic SAML Identity Provider
34
37
  [**put_identityproviders_gsuite**](IdentityProviderApi.html#put_identityproviders_gsuite) | Update/Create G Suite Identity Provider
35
38
  [**put_identityproviders_identitynow**](IdentityProviderApi.html#put_identityproviders_identitynow) | Update/Create IdentityNow Provider
36
39
  [**put_identityproviders_okta**](IdentityProviderApi.html#put_identityproviders_okta) | Update/Create Okta Identity Provider
@@ -159,6 +162,65 @@ This endpoint does not need any parameter.
159
162
 
160
163
 
161
164
 
165
+ <a name="delete_identityproviders_generic"></a>
166
+
167
+ ## [**Empty**](Empty.html) delete_identityproviders_generic
168
+
169
+
170
+
171
+ Delete Generic SAML Identity Provider
172
+
173
+
174
+
175
+ Wraps DELETE /api/v2/identityproviders/generic
176
+
177
+ Requires ANY permissions:
178
+
179
+ * sso:provider:delete
180
+
181
+
182
+ ### Example
183
+ ```{"language":"ruby"}
184
+ # load the gem
185
+ require 'purecloudplatformclientv2'
186
+ # setup authorization
187
+ @secret = ENV['PURECLOUD_SECRET']
188
+ @id = ENV['PURECLOUD_CLIENT_ID']
189
+ environment = "mypurecloud.com"
190
+
191
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
192
+
193
+ PureCloud.configure do |config|
194
+ config.access_token = @authToken
195
+ end
196
+
197
+ api_instance = PureCloud::IdentityProviderApi.new
198
+
199
+ begin
200
+ #Delete Generic SAML Identity Provider
201
+ result = api_instance.delete_identityproviders_generic
202
+ p result
203
+ rescue PureCloud::ApiError => e
204
+ puts "Exception when calling IdentityProviderApi->delete_identityproviders_generic: #{e}"
205
+ end
206
+ ```
207
+
208
+ ### Parameters
209
+ This endpoint does not need any parameter.
210
+ {: class="table table-striped"}
211
+
212
+
213
+ ### Return type
214
+
215
+ [**Empty**](Empty.html)
216
+
217
+ ### HTTP request headers
218
+
219
+ - **Content-Type**: application/json
220
+ - **Accept**: application/json
221
+
222
+
223
+
162
224
  <a name="delete_identityproviders_gsuite"></a>
163
225
 
164
226
  ## [**Empty**](Empty.html) delete_identityproviders_gsuite
@@ -808,6 +870,65 @@ This endpoint does not need any parameter.
808
870
 
809
871
 
810
872
 
873
+ <a name="get_identityproviders_generic"></a>
874
+
875
+ ## [**GenericSAML**](GenericSAML.html) get_identityproviders_generic
876
+
877
+
878
+
879
+ Get Generic SAML Identity Provider
880
+
881
+
882
+
883
+ Wraps GET /api/v2/identityproviders/generic
884
+
885
+ Requires ANY permissions:
886
+
887
+ * sso:provider:view
888
+
889
+
890
+ ### Example
891
+ ```{"language":"ruby"}
892
+ # load the gem
893
+ require 'purecloudplatformclientv2'
894
+ # setup authorization
895
+ @secret = ENV['PURECLOUD_SECRET']
896
+ @id = ENV['PURECLOUD_CLIENT_ID']
897
+ environment = "mypurecloud.com"
898
+
899
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
900
+
901
+ PureCloud.configure do |config|
902
+ config.access_token = @authToken
903
+ end
904
+
905
+ api_instance = PureCloud::IdentityProviderApi.new
906
+
907
+ begin
908
+ #Get Generic SAML Identity Provider
909
+ result = api_instance.get_identityproviders_generic
910
+ p result
911
+ rescue PureCloud::ApiError => e
912
+ puts "Exception when calling IdentityProviderApi->get_identityproviders_generic: #{e}"
913
+ end
914
+ ```
915
+
916
+ ### Parameters
917
+ This endpoint does not need any parameter.
918
+ {: class="table table-striped"}
919
+
920
+
921
+ ### Return type
922
+
923
+ [**GenericSAML**](GenericSAML.html)
924
+
925
+ ### HTTP request headers
926
+
927
+ - **Content-Type**: application/json
928
+ - **Accept**: application/json
929
+
930
+
931
+
811
932
  <a name="get_identityproviders_gsuite"></a>
812
933
 
813
934
  ## [**GSuite**](GSuite.html) get_identityproviders_gsuite
@@ -1412,6 +1533,72 @@ Name | Type | Description | Notes
1412
1533
 
1413
1534
 
1414
1535
 
1536
+ <a name="put_identityproviders_generic"></a>
1537
+
1538
+ ## [**OAuthProvider**](OAuthProvider.html) put_identityproviders_generic(body)
1539
+
1540
+
1541
+
1542
+ Update/Create Generic SAML Identity Provider
1543
+
1544
+
1545
+
1546
+ Wraps PUT /api/v2/identityproviders/generic
1547
+
1548
+ Requires ANY permissions:
1549
+
1550
+ * sso:provider:add
1551
+ * sso:provider:edit
1552
+
1553
+
1554
+ ### Example
1555
+ ```{"language":"ruby"}
1556
+ # load the gem
1557
+ require 'purecloudplatformclientv2'
1558
+ # setup authorization
1559
+ @secret = ENV['PURECLOUD_SECRET']
1560
+ @id = ENV['PURECLOUD_CLIENT_ID']
1561
+ environment = "mypurecloud.com"
1562
+
1563
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1564
+
1565
+ PureCloud.configure do |config|
1566
+ config.access_token = @authToken
1567
+ end
1568
+
1569
+ api_instance = PureCloud::IdentityProviderApi.new
1570
+
1571
+ body = PureCloud::GenericSAML.new # GenericSAML | Provider
1572
+
1573
+
1574
+ begin
1575
+ #Update/Create Generic SAML Identity Provider
1576
+ result = api_instance.put_identityproviders_generic(body)
1577
+ p result
1578
+ rescue PureCloud::ApiError => e
1579
+ puts "Exception when calling IdentityProviderApi->put_identityproviders_generic: #{e}"
1580
+ end
1581
+ ```
1582
+
1583
+ ### Parameters
1584
+
1585
+ Name | Type | Description | Notes
1586
+ ------------- | ------------- | ------------- | -------------
1587
+ **body** | [**GenericSAML**](GenericSAML.html)| Provider | |
1588
+ {: class="table table-striped"}
1589
+
1590
+
1591
+ ### Return type
1592
+
1593
+ [**OAuthProvider**](OAuthProvider.html)
1594
+
1595
+ ### HTTP request headers
1596
+
1597
+ - **Content-Type**: application/json
1598
+ - **Accept**: application/json
1599
+
1600
+
1601
+
1415
1602
  <a name="put_identityproviders_gsuite"></a>
1416
1603
 
1417
1604
  ## [**OAuthProvider**](OAuthProvider.html) put_identityproviders_gsuite(body)
@@ -0,0 +1,13 @@
1
+ ---
2
+ title: IpAddressAuthentication
3
+ ---
4
+ ## PureCloud::IpAddressAuthentication
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **network_whitelist** | **Array&lt;String&gt;** | | [optional] |
11
+ {: class="table table-striped"}
12
+
13
+
@@ -7,11 +7,11 @@ title: KnowledgeSearchResponse
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
+ | **search_id** | **String** | Search Id | [optional] |
10
11
  | **total** | **Integer** | Total number of records returned | [optional] |
11
12
  | **page_count** | **Integer** | Number of pages returned in the result calculated according to the pageSize and the total | [optional] |
12
13
  | **page_size** | **Integer** | Number of records according to the page size | [optional] |
13
14
  | **page_number** | **Integer** | Current page number for the returned records | [optional] |
14
- | **search_id** | **String** | ID of the Search Response | [optional] |
15
15
  | **results** | [**Array&lt;KnowledgeSearchDocument&gt;**](KnowledgeSearchDocument.html) | Results associated to the search response | [optional] |
16
16
  {: class="table table-striped"}
17
17
 
@@ -10,6 +10,7 @@ Method | Description
10
10
  ------------- | ------------- | -------------
11
11
  [**delete_languageunderstanding_domain**](LanguageUnderstandingApi.html#delete_languageunderstanding_domain) | Delete an NLU Domain.
12
12
  [**delete_languageunderstanding_domain_feedback_feedback_id**](LanguageUnderstandingApi.html#delete_languageunderstanding_domain_feedback_feedback_id) | Delete the feedback on the NLU Domain Version.
13
+ [**delete_languageunderstanding_domain_version**](LanguageUnderstandingApi.html#delete_languageunderstanding_domain_version) | Delete an NLU Domain Version
13
14
  [**get_languageunderstanding_domain**](LanguageUnderstandingApi.html#get_languageunderstanding_domain) | Find an NLU Domain.
14
15
  [**get_languageunderstanding_domain_feedback**](LanguageUnderstandingApi.html#get_languageunderstanding_domain_feedback) | Get all feedback in the given NLU Domain Version.
15
16
  [**get_languageunderstanding_domain_feedback_feedback_id**](LanguageUnderstandingApi.html#get_languageunderstanding_domain_feedback_feedback_id) | Find a Feedback
@@ -22,6 +23,7 @@ Method | Description
22
23
  [**post_languageunderstanding_domain_version_detect**](LanguageUnderstandingApi.html#post_languageunderstanding_domain_version_detect) | Detect intent, entities, etc. in the submitted text using the specified NLU domain version.
23
24
  [**post_languageunderstanding_domain_version_publish**](LanguageUnderstandingApi.html#post_languageunderstanding_domain_version_publish) | Publish the draft NLU Domain Version.
24
25
  [**post_languageunderstanding_domain_version_train**](LanguageUnderstandingApi.html#post_languageunderstanding_domain_version_train) | Train the draft NLU Domain Version.
26
+ [**post_languageunderstanding_domain_versions**](LanguageUnderstandingApi.html#post_languageunderstanding_domain_versions) | Create an NLU Domain Version.
25
27
  [**post_languageunderstanding_domains**](LanguageUnderstandingApi.html#post_languageunderstanding_domains) | Create an NLU Domain.
26
28
  [**put_languageunderstanding_domain_version**](LanguageUnderstandingApi.html#put_languageunderstanding_domain_version) | Update an NLU Domain Version.
27
29
  {: class="table table-striped"}
@@ -159,6 +161,74 @@ nil (empty response body)
159
161
 
160
162
 
161
163
 
164
+ <a name="delete_languageunderstanding_domain_version"></a>
165
+
166
+ ## delete_languageunderstanding_domain_version(domain_id, domain_version_id)
167
+
168
+
169
+
170
+ Delete an NLU Domain Version
171
+
172
+
173
+
174
+ Wraps DELETE /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}
175
+
176
+ Requires ANY permissions:
177
+
178
+ * languageUnderstanding:nluDomainVersion:delete
179
+ * dialog:botVersion:delete
180
+
181
+
182
+ ### Example
183
+ ```{"language":"ruby"}
184
+ # load the gem
185
+ require 'purecloudplatformclientv2'
186
+ # setup authorization
187
+ @secret = ENV['PURECLOUD_SECRET']
188
+ @id = ENV['PURECLOUD_CLIENT_ID']
189
+ environment = "mypurecloud.com"
190
+
191
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
192
+
193
+ PureCloud.configure do |config|
194
+ config.access_token = @authToken
195
+ end
196
+
197
+ api_instance = PureCloud::LanguageUnderstandingApi.new
198
+
199
+ domain_id = "domain_id_example" # String | ID of the NLU domain.
200
+
201
+ domain_version_id = "domain_version_id_example" # String | ID of the NLU domain version.
202
+
203
+
204
+ begin
205
+ #Delete an NLU Domain Version
206
+ api_instance.delete_languageunderstanding_domain_version(domain_id, domain_version_id)
207
+ rescue PureCloud::ApiError => e
208
+ puts "Exception when calling LanguageUnderstandingApi->delete_languageunderstanding_domain_version: #{e}"
209
+ end
210
+ ```
211
+
212
+ ### Parameters
213
+
214
+ Name | Type | Description | Notes
215
+ ------------- | ------------- | ------------- | -------------
216
+ **domain_id** | **String**| ID of the NLU domain. | |
217
+ **domain_version_id** | **String**| ID of the NLU domain version. | |
218
+ {: class="table table-striped"}
219
+
220
+
221
+ ### Return type
222
+
223
+ nil (empty response body)
224
+
225
+ ### HTTP request headers
226
+
227
+ - **Content-Type**: application/json
228
+ - **Accept**: application/json
229
+
230
+
231
+
162
232
  <a name="get_languageunderstanding_domain"></a>
163
233
 
164
234
  ## [**NluDomain**](NluDomain.html) get_languageunderstanding_domain(domain_id)
@@ -669,7 +739,7 @@ Name | Type | Description | Notes
669
739
 
670
740
  <a name="patch_languageunderstanding_domain"></a>
671
741
 
672
- ## [**NluDomain**](NluDomain.html) patch_languageunderstanding_domain(domain_id, opts)
742
+ ## [**NluDomain**](NluDomain.html) patch_languageunderstanding_domain(domain_id, body)
673
743
 
674
744
 
675
745
 
@@ -704,13 +774,12 @@ api_instance = PureCloud::LanguageUnderstandingApi.new
704
774
 
705
775
  domain_id = "domain_id_example" # String | ID of the NLU domain.
706
776
 
707
- opts = {
708
- body: PureCloud::NluDomain.new # NluDomain |
709
- }
777
+ body = PureCloud::NluDomain.new # NluDomain | The updated NLU Domain.
778
+
710
779
 
711
780
  begin
712
781
  #Update an NLU Domain.
713
- result = api_instance.patch_languageunderstanding_domain(domain_id, opts)
782
+ result = api_instance.patch_languageunderstanding_domain(domain_id, body)
714
783
  p result
715
784
  rescue PureCloud::ApiError => e
716
785
  puts "Exception when calling LanguageUnderstandingApi->patch_languageunderstanding_domain: #{e}"
@@ -722,7 +791,7 @@ end
722
791
  Name | Type | Description | Notes
723
792
  ------------- | ------------- | ------------- | -------------
724
793
  **domain_id** | **String**| ID of the NLU domain. | |
725
- **body** | [**NluDomain**](NluDomain.html)| | [optional] |
794
+ **body** | [**NluDomain**](NluDomain.html)| The updated NLU Domain. | |
726
795
  {: class="table table-striped"}
727
796
 
728
797
 
@@ -739,7 +808,7 @@ Name | Type | Description | Notes
739
808
 
740
809
  <a name="post_languageunderstanding_domain_feedback"></a>
741
810
 
742
- ## [**NluFeedbackResponse**](NluFeedbackResponse.html) post_languageunderstanding_domain_feedback(domain_id, opts)
811
+ ## [**NluFeedbackResponse**](NluFeedbackResponse.html) post_languageunderstanding_domain_feedback(domain_id, body)
743
812
 
744
813
 
745
814
 
@@ -774,13 +843,12 @@ api_instance = PureCloud::LanguageUnderstandingApi.new
774
843
 
775
844
  domain_id = "domain_id_example" # String | ID of the NLU domain.
776
845
 
777
- opts = {
778
- body: PureCloud::NluFeedbackRequest.new # NluFeedbackRequest |
779
- }
846
+ body = PureCloud::NluFeedbackRequest.new # NluFeedbackRequest | The Feedback to create.
847
+
780
848
 
781
849
  begin
782
850
  #Create feedback for the NLU Domain Version.
783
- result = api_instance.post_languageunderstanding_domain_feedback(domain_id, opts)
851
+ result = api_instance.post_languageunderstanding_domain_feedback(domain_id, body)
784
852
  p result
785
853
  rescue PureCloud::ApiError => e
786
854
  puts "Exception when calling LanguageUnderstandingApi->post_languageunderstanding_domain_feedback: #{e}"
@@ -792,7 +860,7 @@ end
792
860
  Name | Type | Description | Notes
793
861
  ------------- | ------------- | ------------- | -------------
794
862
  **domain_id** | **String**| ID of the NLU domain. | |
795
- **body** | [**NluFeedbackRequest**](NluFeedbackRequest.html)| | [optional] |
863
+ **body** | [**NluFeedbackRequest**](NluFeedbackRequest.html)| The Feedback to create. | |
796
864
  {: class="table table-striped"}
797
865
 
798
866
 
@@ -809,7 +877,7 @@ Name | Type | Description | Notes
809
877
 
810
878
  <a name="post_languageunderstanding_domain_version_detect"></a>
811
879
 
812
- ## [**NluDetectionResponse**](NluDetectionResponse.html) post_languageunderstanding_domain_version_detect(domain_id, domain_version_id, opts)
880
+ ## [**NluDetectionResponse**](NluDetectionResponse.html) post_languageunderstanding_domain_version_detect(domain_id, domain_version_id, body)
813
881
 
814
882
 
815
883
 
@@ -846,13 +914,12 @@ domain_id = "domain_id_example" # String | ID of the NLU domain.
846
914
 
847
915
  domain_version_id = "domain_version_id_example" # String | ID of the NLU domain version.
848
916
 
849
- opts = {
850
- body: PureCloud::NluDetectionRequest.new # NluDetectionRequest |
851
- }
917
+ body = PureCloud::NluDetectionRequest.new # NluDetectionRequest | The input data to perform detection on.
918
+
852
919
 
853
920
  begin
854
921
  #Detect intent, entities, etc. in the submitted text using the specified NLU domain version.
855
- result = api_instance.post_languageunderstanding_domain_version_detect(domain_id, domain_version_id, opts)
922
+ result = api_instance.post_languageunderstanding_domain_version_detect(domain_id, domain_version_id, body)
856
923
  p result
857
924
  rescue PureCloud::ApiError => e
858
925
  puts "Exception when calling LanguageUnderstandingApi->post_languageunderstanding_domain_version_detect: #{e}"
@@ -865,7 +932,7 @@ Name | Type | Description | Notes
865
932
  ------------- | ------------- | ------------- | -------------
866
933
  **domain_id** | **String**| ID of the NLU domain. | |
867
934
  **domain_version_id** | **String**| ID of the NLU domain version. | |
868
- **body** | [**NluDetectionRequest**](NluDetectionRequest.html)| | [optional] |
935
+ **body** | [**NluDetectionRequest**](NluDetectionRequest.html)| The input data to perform detection on. | |
869
936
  {: class="table table-striped"}
870
937
 
871
938
 
@@ -1018,9 +1085,78 @@ Name | Type | Description | Notes
1018
1085
 
1019
1086
 
1020
1087
 
1088
+ <a name="post_languageunderstanding_domain_versions"></a>
1089
+
1090
+ ## [**NluDomainVersion**](NluDomainVersion.html) post_languageunderstanding_domain_versions(domain_id, body)
1091
+
1092
+
1093
+
1094
+ Create an NLU Domain Version.
1095
+
1096
+
1097
+
1098
+ Wraps POST /api/v2/languageunderstanding/domains/{domainId}/versions
1099
+
1100
+ Requires ANY permissions:
1101
+
1102
+ * languageUnderstanding:nluDomainVersion:add
1103
+ * dialog:botVersion:add
1104
+
1105
+
1106
+ ### Example
1107
+ ```{"language":"ruby"}
1108
+ # load the gem
1109
+ require 'purecloudplatformclientv2'
1110
+ # setup authorization
1111
+ @secret = ENV['PURECLOUD_SECRET']
1112
+ @id = ENV['PURECLOUD_CLIENT_ID']
1113
+ environment = "mypurecloud.com"
1114
+
1115
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1116
+
1117
+ PureCloud.configure do |config|
1118
+ config.access_token = @authToken
1119
+ end
1120
+
1121
+ api_instance = PureCloud::LanguageUnderstandingApi.new
1122
+
1123
+ domain_id = "domain_id_example" # String | ID of the NLU domain.
1124
+
1125
+ body = PureCloud::NluDomainVersion.new # NluDomainVersion | The NLU Domain Version to create.
1126
+
1127
+
1128
+ begin
1129
+ #Create an NLU Domain Version.
1130
+ result = api_instance.post_languageunderstanding_domain_versions(domain_id, body)
1131
+ p result
1132
+ rescue PureCloud::ApiError => e
1133
+ puts "Exception when calling LanguageUnderstandingApi->post_languageunderstanding_domain_versions: #{e}"
1134
+ end
1135
+ ```
1136
+
1137
+ ### Parameters
1138
+
1139
+ Name | Type | Description | Notes
1140
+ ------------- | ------------- | ------------- | -------------
1141
+ **domain_id** | **String**| ID of the NLU domain. | |
1142
+ **body** | [**NluDomainVersion**](NluDomainVersion.html)| The NLU Domain Version to create. | |
1143
+ {: class="table table-striped"}
1144
+
1145
+
1146
+ ### Return type
1147
+
1148
+ [**NluDomainVersion**](NluDomainVersion.html)
1149
+
1150
+ ### HTTP request headers
1151
+
1152
+ - **Content-Type**: application/json
1153
+ - **Accept**: application/json
1154
+
1155
+
1156
+
1021
1157
  <a name="post_languageunderstanding_domains"></a>
1022
1158
 
1023
- ## [**NluDomain**](NluDomain.html) post_languageunderstanding_domains(opts)
1159
+ ## [**NluDomain**](NluDomain.html) post_languageunderstanding_domains(body)
1024
1160
 
1025
1161
 
1026
1162
 
@@ -1053,13 +1189,12 @@ end
1053
1189
 
1054
1190
  api_instance = PureCloud::LanguageUnderstandingApi.new
1055
1191
 
1056
- opts = {
1057
- body: PureCloud::NluDomain.new # NluDomain |
1058
- }
1192
+ body = PureCloud::NluDomain.new # NluDomain | The NLU Domain to create.
1193
+
1059
1194
 
1060
1195
  begin
1061
1196
  #Create an NLU Domain.
1062
- result = api_instance.post_languageunderstanding_domains(opts)
1197
+ result = api_instance.post_languageunderstanding_domains(body)
1063
1198
  p result
1064
1199
  rescue PureCloud::ApiError => e
1065
1200
  puts "Exception when calling LanguageUnderstandingApi->post_languageunderstanding_domains: #{e}"
@@ -1070,7 +1205,7 @@ end
1070
1205
 
1071
1206
  Name | Type | Description | Notes
1072
1207
  ------------- | ------------- | ------------- | -------------
1073
- **body** | [**NluDomain**](NluDomain.html)| | [optional] |
1208
+ **body** | [**NluDomain**](NluDomain.html)| The NLU Domain to create. | |
1074
1209
  {: class="table table-striped"}
1075
1210
 
1076
1211
 
@@ -1087,7 +1222,7 @@ Name | Type | Description | Notes
1087
1222
 
1088
1223
  <a name="put_languageunderstanding_domain_version"></a>
1089
1224
 
1090
- ## [**NluDomainVersion**](NluDomainVersion.html) put_languageunderstanding_domain_version(domain_id, domain_version_id, opts)
1225
+ ## [**NluDomainVersion**](NluDomainVersion.html) put_languageunderstanding_domain_version(domain_id, domain_version_id, body)
1091
1226
 
1092
1227
 
1093
1228
 
@@ -1124,13 +1259,12 @@ domain_id = "domain_id_example" # String | ID of the NLU domain.
1124
1259
 
1125
1260
  domain_version_id = "domain_version_id_example" # String | ID of the NLU domain version.
1126
1261
 
1127
- opts = {
1128
- body: PureCloud::NluDomainVersion.new # NluDomainVersion |
1129
- }
1262
+ body = PureCloud::NluDomainVersion.new # NluDomainVersion | The updated NLU Domain Version.
1263
+
1130
1264
 
1131
1265
  begin
1132
1266
  #Update an NLU Domain Version.
1133
- result = api_instance.put_languageunderstanding_domain_version(domain_id, domain_version_id, opts)
1267
+ result = api_instance.put_languageunderstanding_domain_version(domain_id, domain_version_id, body)
1134
1268
  p result
1135
1269
  rescue PureCloud::ApiError => e
1136
1270
  puts "Exception when calling LanguageUnderstandingApi->put_languageunderstanding_domain_version: #{e}"
@@ -1143,7 +1277,7 @@ Name | Type | Description | Notes
1143
1277
  ------------- | ------------- | ------------- | -------------
1144
1278
  **domain_id** | **String**| ID of the NLU domain. | |
1145
1279
  **domain_version_id** | **String**| ID of the NLU domain version. | |
1146
- **body** | [**NluDomainVersion**](NluDomainVersion.html)| | [optional] |
1280
+ **body** | [**NluDomainVersion**](NluDomainVersion.html)| The updated NLU Domain Version. | |
1147
1281
  {: class="table table-striped"}
1148
1282
 
1149
1283