purecloudplatformclientv2 15.0.0 → 16.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (131) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/Action.md +21 -0
  4. data/docs/ActionConfig.md +14 -0
  5. data/docs/ActionContract.md +14 -0
  6. data/docs/ActionContractInput.md +14 -0
  7. data/docs/ActionEntityListing.md +22 -0
  8. data/docs/ActionInput.md +15 -0
  9. data/docs/ActionOutput.md +18 -0
  10. data/docs/ActiveAlertCount.md +13 -0
  11. data/docs/AggregationQuery.md +1 -1
  12. data/docs/AlertingApi.md +54 -0
  13. data/docs/ArchitectApi.md +31 -25
  14. data/docs/CallConversationNotificationCallMediaParticipant.md +1 -0
  15. data/docs/CallConversationNotificationParticipants.md +1 -0
  16. data/docs/CallbackConversationNotificationCallbackMediaParticipant.md +1 -0
  17. data/docs/CallbackConversationNotificationParticipants.md +1 -0
  18. data/docs/Category.md +13 -0
  19. data/docs/CategoryEntityListing.md +17 -0
  20. data/docs/ChatConversationNotificationChatMediaParticipant.md +1 -0
  21. data/docs/ChatConversationNotificationParticipants.md +1 -0
  22. data/docs/CobrowseConversationNotificationCobrowseMediaParticipant.md +1 -0
  23. data/docs/CobrowseConversationNotificationParticipants.md +1 -0
  24. data/docs/ConversationNotificationCall.md +1 -0
  25. data/docs/ConversationNotificationCalls.md +1 -0
  26. data/docs/ConversationNotificationEmail.md +1 -0
  27. data/docs/ConversationNotificationEmails.md +1 -0
  28. data/docs/ConversationNotificationParticipant.md +1 -0
  29. data/docs/ConversationNotificationParticipants.md +1 -0
  30. data/docs/ConversationsApi.md +3 -3
  31. data/docs/Document.md +1 -1
  32. data/docs/DomainOrganizationRole.md +1 -1
  33. data/docs/DomainOrganizationRoleCreate.md +1 -1
  34. data/docs/DomainOrganizationRoleUpdate.md +1 -1
  35. data/docs/DraftValidationResult.md +14 -0
  36. data/docs/EmailConversationNotificationEmailMediaParticipant.md +2 -0
  37. data/docs/EmailConversationNotificationParticipants.md +2 -0
  38. data/docs/FaxDocument.md +1 -1
  39. data/docs/IntegrationsApi.md +1355 -0
  40. data/docs/JsonNode.md +4 -4
  41. data/docs/ManagementUnit.md +1 -1
  42. data/docs/ManagementUnitListing.md +22 -0
  43. data/docs/OutboundApi.md +59 -0
  44. data/docs/PostActionInput.md +18 -0
  45. data/docs/PostInputContract.md +13 -0
  46. data/docs/PostOutputContract.md +13 -0
  47. data/docs/PublishDraftInput.md +13 -0
  48. data/docs/RecordingApi.md +123 -0
  49. data/docs/RequestConfig.md +17 -0
  50. data/docs/ResponseConfig.md +15 -0
  51. data/docs/ScreenShareConversationNotificationParticipants.md +1 -0
  52. data/docs/ScreenShareConversationNotificationScreenShareMediaParticipant.md +1 -0
  53. data/docs/SocialConversationNotificationParticipants.md +1 -0
  54. data/docs/SocialConversationNotificationSocialMediaParticipant.md +1 -0
  55. data/docs/TestExecutionOperationResult.md +17 -0
  56. data/docs/TestExecutionResult.md +16 -0
  57. data/docs/UpdateActionInput.md +16 -0
  58. data/docs/UpdateDraftInput.md +18 -0
  59. data/docs/VideoConversationNotificationParticipants.md +1 -0
  60. data/docs/VideoConversationNotificationVideoMediaParticipant.md +1 -0
  61. data/docs/WorkforceManagementApi.md +2 -4
  62. data/lib/purecloudplatformclientv2.rb +23 -1
  63. data/lib/purecloudplatformclientv2/api/alerting_api.rb +55 -0
  64. data/lib/purecloudplatformclientv2/api/architect_api.rb +52 -20
  65. data/lib/purecloudplatformclientv2/api/conversations_api.rb +2 -2
  66. data/lib/purecloudplatformclientv2/api/integrations_api.rb +1723 -0
  67. data/lib/purecloudplatformclientv2/api/outbound_api.rb +65 -0
  68. data/lib/purecloudplatformclientv2/api/recording_api.rb +140 -0
  69. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +3 -12
  70. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  71. data/lib/purecloudplatformclientv2/models/action.rb +409 -0
  72. data/lib/purecloudplatformclientv2/models/action_config.rb +229 -0
  73. data/lib/purecloudplatformclientv2/models/action_contract.rb +229 -0
  74. data/lib/purecloudplatformclientv2/models/action_contract_input.rb +239 -0
  75. data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +428 -0
  76. data/lib/purecloudplatformclientv2/models/action_input.rb +255 -0
  77. data/lib/purecloudplatformclientv2/models/action_output.rb +333 -0
  78. data/lib/purecloudplatformclientv2/models/active_alert_count.rb +202 -0
  79. data/lib/purecloudplatformclientv2/models/aggregation_query.rb +1 -1
  80. data/lib/purecloudplatformclientv2/models/call_conversation_notification_call_media_participant.rb +26 -1
  81. data/lib/purecloudplatformclientv2/models/call_conversation_notification_participants.rb +26 -1
  82. data/lib/purecloudplatformclientv2/models/callback_conversation_notification_callback_media_participant.rb +26 -1
  83. data/lib/purecloudplatformclientv2/models/callback_conversation_notification_participants.rb +26 -1
  84. data/lib/purecloudplatformclientv2/models/category.rb +203 -0
  85. data/lib/purecloudplatformclientv2/models/category_entity_listing.rb +303 -0
  86. data/lib/purecloudplatformclientv2/models/chat_conversation_notification_chat_media_participant.rb +26 -1
  87. data/lib/purecloudplatformclientv2/models/chat_conversation_notification_participants.rb +26 -1
  88. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_cobrowse_media_participant.rb +26 -1
  89. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_participants.rb +26 -1
  90. data/lib/purecloudplatformclientv2/models/condition.rb +2 -2
  91. data/lib/purecloudplatformclientv2/models/conversation_notification_call.rb +26 -1
  92. data/lib/purecloudplatformclientv2/models/conversation_notification_calls.rb +26 -1
  93. data/lib/purecloudplatformclientv2/models/conversation_notification_email.rb +26 -1
  94. data/lib/purecloudplatformclientv2/models/conversation_notification_emails.rb +26 -1
  95. data/lib/purecloudplatformclientv2/models/conversation_notification_participant.rb +40 -1
  96. data/lib/purecloudplatformclientv2/models/conversation_notification_participants.rb +40 -1
  97. data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
  98. data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
  99. data/lib/purecloudplatformclientv2/models/document.rb +12 -12
  100. data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +12 -12
  101. data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
  102. data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
  103. data/lib/purecloudplatformclientv2/models/draft_validation_result.rb +231 -0
  104. data/lib/purecloudplatformclientv2/models/email_conversation_notification_email_media_participant.rb +54 -4
  105. data/lib/purecloudplatformclientv2/models/email_conversation_notification_participants.rb +54 -4
  106. data/lib/purecloudplatformclientv2/models/fax_document.rb +12 -12
  107. data/lib/purecloudplatformclientv2/models/flow.rb +2 -2
  108. data/lib/purecloudplatformclientv2/models/interaction_stats_alert.rb +2 -2
  109. data/lib/purecloudplatformclientv2/models/interaction_stats_rule.rb +2 -2
  110. data/lib/purecloudplatformclientv2/models/json_node.rb +72 -72
  111. data/lib/purecloudplatformclientv2/models/management_unit.rb +7 -7
  112. data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +428 -0
  113. data/lib/purecloudplatformclientv2/models/post_action_input.rb +358 -0
  114. data/lib/purecloudplatformclientv2/models/post_input_contract.rb +208 -0
  115. data/lib/purecloudplatformclientv2/models/post_output_contract.rb +208 -0
  116. data/lib/purecloudplatformclientv2/models/publish_draft_input.rb +208 -0
  117. data/lib/purecloudplatformclientv2/models/request_config.rb +309 -0
  118. data/lib/purecloudplatformclientv2/models/response_config.rb +257 -0
  119. data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_participants.rb +26 -1
  120. data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_screen_share_media_participant.rb +26 -1
  121. data/lib/purecloudplatformclientv2/models/social_conversation_notification_participants.rb +26 -1
  122. data/lib/purecloudplatformclientv2/models/social_conversation_notification_social_media_participant.rb +26 -1
  123. data/lib/purecloudplatformclientv2/models/test_execution_operation_result.rb +306 -0
  124. data/lib/purecloudplatformclientv2/models/test_execution_result.rb +282 -0
  125. data/lib/purecloudplatformclientv2/models/{publish_flow_notification_notification.rb → update_action_input.rb} +35 -26
  126. data/lib/purecloudplatformclientv2/models/update_draft_input.rb +338 -0
  127. data/lib/purecloudplatformclientv2/models/video_conversation_notification_participants.rb +26 -1
  128. data/lib/purecloudplatformclientv2/models/video_conversation_notification_video_media_participant.rb +26 -1
  129. data/lib/purecloudplatformclientv2/version.rb +1 -1
  130. metadata +91 -47
  131. data/docs/PublishFlowNotificationNotification.md +0 -16
@@ -0,0 +1,18 @@
1
+ ---
2
+ title: UpdateDraftInput
3
+ ---
4
+ ## PureCloud::UpdateDraftInput
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **category** | **String** | Category of action | [optional] |
11
+ | **name** | **String** | Name of action | [optional] |
12
+ | **config** | [**ActionConfig**](ActionConfig.html) | Configuration to support request and response processing | [optional] |
13
+ | **contract** | [**ActionContractInput**](ActionContractInput.html) | Action contract | [optional] |
14
+ | **secure** | **BOOLEAN** | Indication of whether or not the action is designed to accept sensitive data | [optional] |
15
+ | **version** | **Integer** | Version of current Draft | |
16
+ {: class="table table-striped"}
17
+
18
+
@@ -33,6 +33,7 @@ title: VideoConversationNotificationParticipants
33
33
  | **external_organization** | [**VideoConversationNotificationUriReference**](VideoConversationNotificationUriReference.html) | | [optional] |
34
34
  | **wrapup** | [**ConversationNotificationWrapup**](ConversationNotificationWrapup.html) | | [optional] |
35
35
  | **peer** | **String** | | [optional] |
36
+ | **screen_recording_state** | **String** | | [optional] |
36
37
  | **audio_muted** | **BOOLEAN** | | [optional] |
37
38
  | **video_muted** | **BOOLEAN** | | [optional] |
38
39
  | **sharing_screen** | **BOOLEAN** | | [optional] |
@@ -33,6 +33,7 @@ title: VideoConversationNotificationVideoMediaParticipant
33
33
  | **external_organization** | [**VideoConversationNotificationUriReference**](VideoConversationNotificationUriReference.html) | | [optional] |
34
34
  | **wrapup** | [**ConversationNotificationWrapup**](ConversationNotificationWrapup.html) | | [optional] |
35
35
  | **peer** | **String** | | [optional] |
36
+ | **screen_recording_state** | **String** | | [optional] |
36
37
  | **audio_muted** | **BOOLEAN** | | [optional] |
37
38
  | **video_muted** | **BOOLEAN** | | [optional] |
38
39
  | **sharing_screen** | **BOOLEAN** | | [optional] |
@@ -396,7 +396,7 @@ Name | Type | Description | Notes
396
396
 
397
397
  <a name="get_workforcemanagement_managementunits"></a>
398
398
 
399
- ## -[**Array&lt;ManagementUnit&gt;**](ManagementUnit.html) get_workforcemanagement_managementunits(opts)
399
+ ## -[**ManagementUnitListing**](ManagementUnitListing.html) get_workforcemanagement_managementunits(opts)
400
400
 
401
401
  Get management units
402
402
 
@@ -423,7 +423,6 @@ end
423
423
  api_instance = PureCloud::WorkforceManagementApi.new
424
424
 
425
425
  opts = {
426
- selector: "selector_example", # String | Selector
427
426
  page_size: 25, # Integer |
428
427
  page_number: 1 # Integer |
429
428
  }
@@ -441,7 +440,6 @@ end
441
440
 
442
441
  Name | Type | Description | Notes
443
442
  ------------- | ------------- | ------------- | -------------
444
- **selector** | **String**| Selector | [optional] |
445
443
  **page_size** | **Integer**| | [optional] [default to 25] |
446
444
  **page_number** | **Integer**| | [optional] [default to 1] |
447
445
  {: class="table table-striped"}
@@ -449,7 +447,7 @@ Name | Type | Description | Notes
449
447
 
450
448
  ### Return type
451
449
 
452
- [**Array&lt;ManagementUnit&gt;**](ManagementUnit.html)
450
+ [**ManagementUnitListing**](ManagementUnitListing.html)
453
451
 
454
452
  ### HTTP request headers
455
453
 
@@ -22,7 +22,15 @@ require 'purecloudplatformclientv2/configuration'
22
22
 
23
23
  # Models
24
24
  require 'purecloudplatformclientv2/models/adfs'
25
+ require 'purecloudplatformclientv2/models/action'
26
+ require 'purecloudplatformclientv2/models/action_config'
27
+ require 'purecloudplatformclientv2/models/action_contract'
28
+ require 'purecloudplatformclientv2/models/action_contract_input'
29
+ require 'purecloudplatformclientv2/models/action_entity_listing'
30
+ require 'purecloudplatformclientv2/models/action_input'
31
+ require 'purecloudplatformclientv2/models/action_output'
25
32
  require 'purecloudplatformclientv2/models/actions'
33
+ require 'purecloudplatformclientv2/models/active_alert_count'
26
34
  require 'purecloudplatformclientv2/models/activity_code'
27
35
  require 'purecloudplatformclientv2/models/activity_code_container'
28
36
  require 'purecloudplatformclientv2/models/acw_settings'
@@ -176,6 +184,8 @@ require 'purecloudplatformclientv2/models/campaign_sequence_notification'
176
184
  require 'purecloudplatformclientv2/models/campaign_sequence_notification_uri_reference'
177
185
  require 'purecloudplatformclientv2/models/campaign_stats'
178
186
  require 'purecloudplatformclientv2/models/campaign_time_slot'
187
+ require 'purecloudplatformclientv2/models/category'
188
+ require 'purecloudplatformclientv2/models/category_entity_listing'
179
189
  require 'purecloudplatformclientv2/models/certificate'
180
190
  require 'purecloudplatformclientv2/models/certificate_authority_entity_listing'
181
191
  require 'purecloudplatformclientv2/models/certificate_details'
@@ -381,6 +391,7 @@ require 'purecloudplatformclientv2/models/domain_resource_condition_value'
381
391
  require 'purecloudplatformclientv2/models/domain_role'
382
392
  require 'purecloudplatformclientv2/models/domain_schema_reference'
383
393
  require 'purecloudplatformclientv2/models/download_response'
394
+ require 'purecloudplatformclientv2/models/draft_validation_result'
384
395
  require 'purecloudplatformclientv2/models/duration_condition'
385
396
  require 'purecloudplatformclientv2/models/edge'
386
397
  require 'purecloudplatformclientv2/models/edge_auto_update_config'
@@ -596,6 +607,7 @@ require 'purecloudplatformclientv2/models/locations_search_response'
596
607
  require 'purecloudplatformclientv2/models/lock_info'
597
608
  require 'purecloudplatformclientv2/models/logical_interface_entity_listing'
598
609
  require 'purecloudplatformclientv2/models/management_unit'
610
+ require 'purecloudplatformclientv2/models/management_unit_listing'
599
611
  require 'purecloudplatformclientv2/models/max_participants'
600
612
  require 'purecloudplatformclientv2/models/media_participant_request'
601
613
  require 'purecloudplatformclientv2/models/media_policies'
@@ -674,6 +686,9 @@ require 'purecloudplatformclientv2/models/policy_create'
674
686
  require 'purecloudplatformclientv2/models/policy_entity_listing'
675
687
  require 'purecloudplatformclientv2/models/policy_error_message'
676
688
  require 'purecloudplatformclientv2/models/policy_errors'
689
+ require 'purecloudplatformclientv2/models/post_action_input'
690
+ require 'purecloudplatformclientv2/models/post_input_contract'
691
+ require 'purecloudplatformclientv2/models/post_output_contract'
677
692
  require 'purecloudplatformclientv2/models/prediction_results'
678
693
  require 'purecloudplatformclientv2/models/presence_definition'
679
694
  require 'purecloudplatformclientv2/models/presence_query_response'
@@ -694,7 +709,7 @@ require 'purecloudplatformclientv2/models/prompt_notification_notification_user'
694
709
  require 'purecloudplatformclientv2/models/prompt_resource_notification_notification'
695
710
  require 'purecloudplatformclientv2/models/property_index_request'
696
711
  require 'purecloudplatformclientv2/models/provision_info'
697
- require 'purecloudplatformclientv2/models/publish_flow_notification_notification'
712
+ require 'purecloudplatformclientv2/models/publish_draft_input'
698
713
  require 'purecloudplatformclientv2/models/pure_cloud'
699
714
  require 'purecloudplatformclientv2/models/qualifier_mapping_observation_query_response'
700
715
  require 'purecloudplatformclientv2/models/quality_audit'
@@ -735,10 +750,12 @@ require 'purecloudplatformclientv2/models/report_run_entry'
735
750
  require 'purecloudplatformclientv2/models/report_run_entry_entity_domain_listing'
736
751
  require 'purecloudplatformclientv2/models/report_schedule'
737
752
  require 'purecloudplatformclientv2/models/report_schedule_entity_listing'
753
+ require 'purecloudplatformclientv2/models/request_config'
738
754
  require 'purecloudplatformclientv2/models/resource_condition_node'
739
755
  require 'purecloudplatformclientv2/models/resource_condition_value'
740
756
  require 'purecloudplatformclientv2/models/resource_permission_policy'
741
757
  require 'purecloudplatformclientv2/models/response'
758
+ require 'purecloudplatformclientv2/models/response_config'
742
759
  require 'purecloudplatformclientv2/models/response_entity_list'
743
760
  require 'purecloudplatformclientv2/models/response_entity_listing'
744
761
  require 'purecloudplatformclientv2/models/response_filter'
@@ -850,6 +867,8 @@ require 'purecloudplatformclientv2/models/tag_query_request'
850
867
  require 'purecloudplatformclientv2/models/tag_value'
851
868
  require 'purecloudplatformclientv2/models/tag_value_entity_listing'
852
869
  require 'purecloudplatformclientv2/models/term_attribute'
870
+ require 'purecloudplatformclientv2/models/test_execution_operation_result'
871
+ require 'purecloudplatformclientv2/models/test_execution_result'
853
872
  require 'purecloudplatformclientv2/models/ticker'
854
873
  require 'purecloudplatformclientv2/models/time_allowed'
855
874
  require 'purecloudplatformclientv2/models/time_interval'
@@ -892,6 +911,8 @@ require 'purecloudplatformclientv2/models/trustor_entity_listing'
892
911
  require 'purecloudplatformclientv2/models/twitter_id'
893
912
  require 'purecloudplatformclientv2/models/unread_metric'
894
913
  require 'purecloudplatformclientv2/models/unread_status'
914
+ require 'purecloudplatformclientv2/models/update_action_input'
915
+ require 'purecloudplatformclientv2/models/update_draft_input'
895
916
  require 'purecloudplatformclientv2/models/update_user'
896
917
  require 'purecloudplatformclientv2/models/uri_reference'
897
918
  require 'purecloudplatformclientv2/models/usage'
@@ -1000,6 +1021,7 @@ require 'purecloudplatformclientv2/api/geolocation_api'
1000
1021
  require 'purecloudplatformclientv2/api/greetings_api'
1001
1022
  require 'purecloudplatformclientv2/api/groups_api'
1002
1023
  require 'purecloudplatformclientv2/api/identity_provider_api'
1024
+ require 'purecloudplatformclientv2/api/integrations_api'
1003
1025
  require 'purecloudplatformclientv2/api/languages_api'
1004
1026
  require 'purecloudplatformclientv2/api/license_api'
1005
1027
  require 'purecloudplatformclientv2/api/locations_api'
@@ -152,6 +152,61 @@ module PureCloud
152
152
  return data, status_code, headers
153
153
  end
154
154
 
155
+ # Gets active alert count for a user.
156
+ #
157
+ # @param [Hash] opts the optional parameters
158
+ # @return [ActiveAlertCount]
159
+ def get_alerting_alerts_active(opts = {})
160
+ data, _status_code, _headers = get_alerting_alerts_active_with_http_info(opts)
161
+ return data
162
+ end
163
+
164
+ # Gets active alert count for a user.
165
+ #
166
+ # @param [Hash] opts the optional parameters
167
+ # @return [Array<(ActiveAlertCount, Fixnum, Hash)>] ActiveAlertCount data, response status code and response headers
168
+ def get_alerting_alerts_active_with_http_info(opts = {})
169
+ if @api_client.config.debugging
170
+ @api_client.config.logger.debug "Calling API: AlertingApi.get_alerting_alerts_active ..."
171
+ end
172
+
173
+ # resource path
174
+ local_var_path = "/api/v2/alerting/alerts/active".sub('{format}','json')
175
+
176
+ # query parameters
177
+ query_params = {}
178
+
179
+ # header parameters
180
+ header_params = {}
181
+
182
+ # HTTP header 'Accept' (if needed)
183
+ local_header_accept = ['application/json']
184
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
185
+
186
+ # HTTP header 'Content-Type'
187
+ local_header_content_type = ['application/json']
188
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
189
+
190
+ # form parameters
191
+ form_params = {}
192
+
193
+ # http body (model)
194
+ post_body = nil
195
+
196
+ auth_names = ['PureCloud Auth']
197
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
198
+ :header_params => header_params,
199
+ :query_params => query_params,
200
+ :form_params => form_params,
201
+ :body => post_body,
202
+ :auth_names => auth_names,
203
+ :return_type => 'ActiveAlertCount')
204
+ if @api_client.config.debugging
205
+ @api_client.config.logger.debug "API called: AlertingApi#get_alerting_alerts_active\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
206
+ end
207
+ return data, status_code, headers
208
+ end
209
+
155
210
  # Get an interaction stats alert
156
211
  #
157
212
  # @param alert_id Alert ID
@@ -821,7 +821,7 @@ module PureCloud
821
821
  #
822
822
  # @param id Consuming object ID
823
823
  # @param version Consuming object version
824
- # @param object_type Consuming object type
824
+ # @param object_type Consuming object type. Only versioned types are allowed here.
825
825
  # @param [Hash] opts the optional parameters
826
826
  # @option opts [Array<String>] :resource_type Types of consumed resources to show
827
827
  # @return [ConsumedResourcesEntityListing]
@@ -834,7 +834,7 @@ module PureCloud
834
834
  #
835
835
  # @param id Consuming object ID
836
836
  # @param version Consuming object version
837
- # @param object_type Consuming object type
837
+ # @param object_type Consuming object type. Only versioned types are allowed here.
838
838
  # @param [Hash] opts the optional parameters
839
839
  # @option opts [Array<String>] :resource_type Types of consumed resources to show
840
840
  # @return [Array<(ConsumedResourcesEntityListing, Fixnum, Hash)>] ConsumedResourcesEntityListing data, response status code and response headers
@@ -864,8 +864,8 @@ module PureCloud
864
864
  fail ArgumentError, "Missing the required parameter 'object_type' when calling ArchitectApi.get_architect_dependencytracking_consumedresources" if object_type.nil?
865
865
 
866
866
  # verify enum value
867
- unless ['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BRIDGEACTION', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'EMAILROUTE', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDEMAILFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'USER', 'USERPROMPT', 'VOICEXML', 'WORKFLOW'].include?(object_type)
868
- fail ArgumentError, "invalid value for 'object_type', must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW"
867
+ unless ['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BRIDGEACTION', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'EMAILROUTE', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGE', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'USER', 'USERPROMPT', 'VOICEXML', 'WORKFLOW'].include?(object_type)
868
+ fail ArgumentError, "invalid value for 'object_type', must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGE, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW"
869
869
  end
870
870
 
871
871
 
@@ -922,9 +922,9 @@ module PureCloud
922
922
  # Get resources that consume a given Dependency Tracking object
923
923
  #
924
924
  # @param id Consumed object ID
925
- # @param object_type Consumed object type (only versioned object types are valid)
925
+ # @param object_type Consumed object type
926
926
  # @param [Hash] opts the optional parameters
927
- # @option opts [Array<String>] :resource_type Types of consuming resources to show
927
+ # @option opts [Array<String>] :resource_type Types of consuming resources to show. Only versioned types are allowed here.
928
928
  # @return [ConsumingResourcesEntityListing]
929
929
  def get_architect_dependencytracking_consumingresources(id, object_type, opts = {})
930
930
  data, _status_code, _headers = get_architect_dependencytracking_consumingresources_with_http_info(id, object_type, opts)
@@ -934,9 +934,9 @@ module PureCloud
934
934
  # Get resources that consume a given Dependency Tracking object
935
935
  #
936
936
  # @param id Consumed object ID
937
- # @param object_type Consumed object type (only versioned object types are valid)
937
+ # @param object_type Consumed object type
938
938
  # @param [Hash] opts the optional parameters
939
- # @option opts [Array<String>] :resource_type Types of consuming resources to show
939
+ # @option opts [Array<String>] :resource_type Types of consuming resources to show. Only versioned types are allowed here.
940
940
  # @return [Array<(ConsumingResourcesEntityListing, Fixnum, Hash)>] ConsumingResourcesEntityListing data, response status code and response headers
941
941
  def get_architect_dependencytracking_consumingresources_with_http_info(id, object_type, opts = {})
942
942
  if @api_client.config.debugging
@@ -956,8 +956,8 @@ module PureCloud
956
956
  fail ArgumentError, "Missing the required parameter 'object_type' when calling ArchitectApi.get_architect_dependencytracking_consumingresources" if object_type.nil?
957
957
 
958
958
  # verify enum value
959
- unless ['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BRIDGEACTION', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'EMAILROUTE', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDEMAILFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'USER', 'USERPROMPT', 'VOICEXML', 'WORKFLOW'].include?(object_type)
960
- fail ArgumentError, "invalid value for 'object_type', must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW"
959
+ unless ['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BRIDGEACTION', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'EMAILROUTE', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGE', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'USER', 'USERPROMPT', 'VOICEXML', 'WORKFLOW'].include?(object_type)
960
+ fail ArgumentError, "invalid value for 'object_type', must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGE, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW"
961
961
  end
962
962
 
963
963
 
@@ -1181,8 +1181,8 @@ module PureCloud
1181
1181
 
1182
1182
 
1183
1183
 
1184
- if opts[:'object_type'] && !['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BRIDGEACTION', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'EMAILROUTE', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDEMAILFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'USER', 'USERPROMPT', 'VOICEXML', 'WORKFLOW'].include?(opts[:'object_type'])
1185
- fail ArgumentError, 'invalid value for "object_type", must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW'
1184
+ if opts[:'object_type'] && !['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BRIDGEACTION', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'EMAILROUTE', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGE', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'USER', 'USERPROMPT', 'VOICEXML', 'WORKFLOW'].include?(opts[:'object_type'])
1185
+ fail ArgumentError, 'invalid value for "object_type", must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGE, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW'
1186
1186
  end
1187
1187
 
1188
1188
 
@@ -1575,6 +1575,7 @@ module PureCloud
1575
1575
  # @option opts [Integer] :page_size Page size (default to 25)
1576
1576
  # @option opts [String] :sort_by Sort by (default to name)
1577
1577
  # @option opts [String] :sort_order Sort order (default to ASC)
1578
+ # @option opts [String] :name Name of the IVR to filter by.
1578
1579
  # @return [IVREntityListing]
1579
1580
  def get_architect_ivrs(opts = {})
1580
1581
  data, _status_code, _headers = get_architect_ivrs_with_http_info(opts)
@@ -1588,6 +1589,7 @@ module PureCloud
1588
1589
  # @option opts [Integer] :page_size Page size
1589
1590
  # @option opts [String] :sort_by Sort by
1590
1591
  # @option opts [String] :sort_order Sort order
1592
+ # @option opts [String] :name Name of the IVR to filter by.
1591
1593
  # @return [Array<(IVREntityListing, Fixnum, Hash)>] IVREntityListing data, response status code and response headers
1592
1594
  def get_architect_ivrs_with_http_info(opts = {})
1593
1595
  if @api_client.config.debugging
@@ -1611,6 +1613,12 @@ module PureCloud
1611
1613
 
1612
1614
 
1613
1615
 
1616
+
1617
+
1618
+
1619
+
1620
+
1621
+
1614
1622
 
1615
1623
 
1616
1624
 
@@ -1627,6 +1635,7 @@ module PureCloud
1627
1635
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1628
1636
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
1629
1637
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
1638
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
1630
1639
 
1631
1640
  # header parameters
1632
1641
  header_params = {}
@@ -2119,6 +2128,7 @@ module PureCloud
2119
2128
  # @option opts [Integer] :page_size Page size (default to 25)
2120
2129
  # @option opts [String] :sort_by Sort by (default to name)
2121
2130
  # @option opts [String] :sort_order Sort order (default to ASC)
2131
+ # @option opts [String] :name Name of the Schedule Group to filter by.
2122
2132
  # @return [ScheduleGroupEntityListing]
2123
2133
  def get_architect_schedulegroups(opts = {})
2124
2134
  data, _status_code, _headers = get_architect_schedulegroups_with_http_info(opts)
@@ -2132,6 +2142,7 @@ module PureCloud
2132
2142
  # @option opts [Integer] :page_size Page size
2133
2143
  # @option opts [String] :sort_by Sort by
2134
2144
  # @option opts [String] :sort_order Sort order
2145
+ # @option opts [String] :name Name of the Schedule Group to filter by.
2135
2146
  # @return [Array<(ScheduleGroupEntityListing, Fixnum, Hash)>] ScheduleGroupEntityListing data, response status code and response headers
2136
2147
  def get_architect_schedulegroups_with_http_info(opts = {})
2137
2148
  if @api_client.config.debugging
@@ -2155,6 +2166,12 @@ module PureCloud
2155
2166
 
2156
2167
 
2157
2168
 
2169
+
2170
+
2171
+
2172
+
2173
+
2174
+
2158
2175
 
2159
2176
 
2160
2177
 
@@ -2171,6 +2188,7 @@ module PureCloud
2171
2188
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
2172
2189
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
2173
2190
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
2191
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
2174
2192
 
2175
2193
  # header parameters
2176
2194
  header_params = {}
@@ -2210,6 +2228,7 @@ module PureCloud
2210
2228
  # @option opts [Integer] :page_size Page size (default to 25)
2211
2229
  # @option opts [String] :sort_by Sort by (default to name)
2212
2230
  # @option opts [String] :sort_order Sort order (default to ASC)
2231
+ # @option opts [String] :name Name of the Schedule to filter by.
2213
2232
  # @return [ScheduleEntityListing]
2214
2233
  def get_architect_schedules(opts = {})
2215
2234
  data, _status_code, _headers = get_architect_schedules_with_http_info(opts)
@@ -2223,6 +2242,7 @@ module PureCloud
2223
2242
  # @option opts [Integer] :page_size Page size
2224
2243
  # @option opts [String] :sort_by Sort by
2225
2244
  # @option opts [String] :sort_order Sort order
2245
+ # @option opts [String] :name Name of the Schedule to filter by.
2226
2246
  # @return [Array<(ScheduleEntityListing, Fixnum, Hash)>] ScheduleEntityListing data, response status code and response headers
2227
2247
  def get_architect_schedules_with_http_info(opts = {})
2228
2248
  if @api_client.config.debugging
@@ -2246,6 +2266,12 @@ module PureCloud
2246
2266
 
2247
2267
 
2248
2268
 
2269
+
2270
+
2271
+
2272
+
2273
+
2274
+
2249
2275
 
2250
2276
 
2251
2277
 
@@ -2262,6 +2288,7 @@ module PureCloud
2262
2288
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
2263
2289
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
2264
2290
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
2291
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
2265
2292
 
2266
2293
  # header parameters
2267
2294
  header_params = {}
@@ -2734,9 +2761,9 @@ module PureCloud
2734
2761
  # @param [Hash] opts the optional parameters
2735
2762
  # @option opts [Integer] :page_number Page number (default to 1)
2736
2763
  # @option opts [Integer] :page_size Page size (default to 25)
2737
- # @option opts [String] :sort_by Sort by (default to timestamp)
2738
2764
  # @option opts [String] :sort_order Sort order (default to desc)
2739
- # @option opts [Array<String>] :action Flow actions
2765
+ # @option opts [String] :sort_by Sort by (default to timestamp)
2766
+ # @option opts [Array<String>] :action Flow actions to include (omit to include all)
2740
2767
  # @return [HistoryListing]
2741
2768
  def get_flow_history_history_id(flow_id, history_id, opts = {})
2742
2769
  data, _status_code, _headers = get_flow_history_history_id_with_http_info(flow_id, history_id, opts)
@@ -2750,9 +2777,9 @@ module PureCloud
2750
2777
  # @param [Hash] opts the optional parameters
2751
2778
  # @option opts [Integer] :page_number Page number
2752
2779
  # @option opts [Integer] :page_size Page size
2753
- # @option opts [String] :sort_by Sort by
2754
2780
  # @option opts [String] :sort_order Sort order
2755
- # @option opts [Array<String>] :action Flow actions
2781
+ # @option opts [String] :sort_by Sort by
2782
+ # @option opts [Array<String>] :action Flow actions to include (omit to include all)
2756
2783
  # @return [Array<(HistoryListing, Fixnum, Hash)>] HistoryListing data, response status code and response headers
2757
2784
  def get_flow_history_history_id_with_http_info(flow_id, history_id, opts = {})
2758
2785
  if @api_client.config.debugging
@@ -2790,15 +2817,15 @@ module PureCloud
2790
2817
 
2791
2818
 
2792
2819
 
2793
- if opts[:'sort_by'] && !['action', 'timestamp', 'user'].include?(opts[:'sort_by'])
2794
- fail ArgumentError, 'invalid value for "sort_by", must be one of action, timestamp, user'
2795
- end
2796
2820
 
2797
2821
 
2798
2822
 
2799
2823
 
2800
2824
 
2801
2825
 
2826
+ if opts[:'sort_by'] && !['action', 'timestamp', 'user'].include?(opts[:'sort_by'])
2827
+ fail ArgumentError, 'invalid value for "sort_by", must be one of action, timestamp, user'
2828
+ end
2802
2829
 
2803
2830
 
2804
2831
 
@@ -2816,8 +2843,8 @@ module PureCloud
2816
2843
  query_params = {}
2817
2844
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
2818
2845
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
2819
- query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
2820
2846
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
2847
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
2821
2848
  query_params[:'action'] = @api_client.build_collection_param(opts[:'action'], :multi) if opts[:'action']
2822
2849
 
2823
2850
  # header parameters
@@ -3237,6 +3264,11 @@ module PureCloud
3237
3264
  # verify the required parameter 'type' is set
3238
3265
  fail ArgumentError, "Missing the required parameter 'type' when calling ArchitectApi.get_flows" if type.nil?
3239
3266
 
3267
+ # verify enum value
3268
+ unless ['inboundcall', 'inboundemail', 'inboundshortmessage', 'outboundcall', 'inqueuecall', 'speech', 'securecall', 'surveyinvite', 'workflow'].include?(type)
3269
+ fail ArgumentError, "invalid value for 'type', must be one of inboundcall, inboundemail, inboundshortmessage, outboundcall, inqueuecall, speech, securecall, surveyinvite, workflow"
3270
+ end
3271
+
3240
3272
 
3241
3273
 
3242
3274