purecloudplatformclientv2 86.0.0 → 91.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.
- checksums.yaml +4 -4
- data/README.md +5 -5
- data/docs/AnalyticsEvaluation.md +1 -1
- data/docs/ApiUsageQuery.md +16 -0
- data/docs/ApiUsageQueryResult.md +14 -0
- data/docs/ApiUsageRow.md +25 -0
- data/docs/ArchitectApi.md +132 -0
- data/docs/AuditApi.md +60 -0
- data/docs/AuditQueryEntity.md +14 -0
- data/docs/AuditQueryExecutionStatusResponse.md +1 -0
- data/docs/AuditQueryRequest.md +1 -0
- data/docs/AuditQueryService.md +14 -0
- data/docs/AuditQueryServiceMapping.md +13 -0
- data/docs/AuditQuerySort.md +14 -0
- data/docs/BuAgentScheduleActivity.md +2 -0
- data/docs/BuRescheduleRequest.md +2 -2
- data/docs/CoachingAnnotation.md +21 -0
- data/docs/CoachingAnnotationCreateRequest.md +14 -0
- data/docs/CoachingAnnotationList.md +22 -0
- data/docs/CoachingApi.md +1132 -0
- data/docs/CoachingAppointmentReference.md +14 -0
- data/docs/CoachingAppointmentResponse.md +27 -0
- data/docs/CoachingAppointmentResponseList.md +22 -0
- data/docs/CoachingAppointmentStatusDto.md +16 -0
- data/docs/CoachingAppointmentStatusDtoList.md +17 -0
- data/docs/CoachingNotification.md +23 -0
- data/docs/CoachingNotificationList.md +22 -0
- data/docs/ConversationAggregationQuery.md +1 -1
- data/docs/ConversationEventTopicCall.md +1 -0
- data/docs/ConversationEventTopicCallback.md +1 -0
- data/docs/ConversationEventTopicChat.md +1 -0
- data/docs/ConversationEventTopicCobrowse.md +1 -0
- data/docs/ConversationEventTopicEmail.md +1 -0
- data/docs/ConversationEventTopicMessage.md +1 -0
- data/docs/ConversationEventTopicScreenshare.md +1 -0
- data/docs/ConversationEventTopicSocialExpression.md +1 -0
- data/docs/ConversationEventTopicVideo.md +1 -0
- data/docs/ConversationReference.md +14 -0
- data/docs/CreateCoachingAppointmentRequest.md +20 -0
- data/docs/CreateQueueRequest.md +1 -0
- data/docs/DocumentReference.md +14 -0
- data/docs/EntityListing.md +5 -1
- data/docs/EvaluationAggregationQuery.md +1 -1
- data/docs/ExternalContact.md +2 -0
- data/docs/ExternalOrganization.md +2 -0
- data/docs/FlowAggregationQuery.md +1 -1
- data/docs/FlowExecutionLaunchRequest.md +16 -0
- data/docs/FlowExecutionLaunchResponse.md +16 -0
- data/docs/FlowRuntimeExecution.md +23 -0
- data/docs/GenericSAML.md +22 -0
- data/docs/GroupsApi.md +4 -4
- data/docs/IdentityProviderApi.md +187 -0
- data/docs/IpAddressAuthentication.md +13 -0
- data/docs/KnowledgeSearchResponse.md +1 -1
- data/docs/NluDomainVersion.md +1 -0
- data/docs/OAuthApi.md +208 -0
- data/docs/OrganizationApi.md +126 -0
- data/docs/Prompt.md +2 -2
- data/docs/Queue.md +1 -0
- data/docs/QueueConversationEventTopicCall.md +1 -0
- data/docs/QueueConversationEventTopicCallback.md +1 -0
- data/docs/QueueConversationEventTopicChat.md +1 -0
- data/docs/QueueConversationEventTopicCobrowse.md +1 -0
- data/docs/QueueConversationEventTopicEmail.md +1 -0
- data/docs/QueueConversationEventTopicMessage.md +1 -0
- data/docs/QueueConversationEventTopicScreenshare.md +1 -0
- data/docs/QueueConversationEventTopicSocialExpression.md +1 -0
- data/docs/QueueConversationEventTopicVideo.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicCall.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicCallback.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicChat.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicCobrowse.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicEmail.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicMessage.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicScreenshare.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicSocialExpression.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicVideo.md +1 -0
- data/docs/QueueConversationVideoEventTopicCall.md +1 -0
- data/docs/QueueConversationVideoEventTopicCallback.md +1 -0
- data/docs/QueueConversationVideoEventTopicChat.md +1 -0
- data/docs/QueueConversationVideoEventTopicCobrowse.md +1 -0
- data/docs/QueueConversationVideoEventTopicEmail.md +1 -0
- data/docs/QueueConversationVideoEventTopicMessage.md +1 -0
- data/docs/QueueConversationVideoEventTopicScreenshare.md +1 -0
- data/docs/QueueConversationVideoEventTopicSocialExpression.md +1 -0
- data/docs/QueueConversationVideoEventTopicVideo.md +1 -0
- data/docs/QueueRequest.md +1 -0
- data/docs/RecordingApi.md +12 -0
- data/docs/ReportingDataExportTopicDataExportNotification.md +1 -0
- data/docs/ScimEmail.md +1 -1
- data/docs/SurveyAggregationQuery.md +1 -1
- data/docs/UpdateCoachingAppointmentRequest.md +18 -0
- data/docs/UploadUrlRequest.md +1 -0
- data/docs/UsageApi.md +144 -0
- data/docs/UsageExecutionResult.md +14 -0
- data/docs/UserAggregationQuery.md +1 -1
- data/docs/UserQueue.md +1 -0
- data/docs/UsersApi.md +5 -5
- data/docs/ViewFilter.md +2 -0
- data/docs/VoicemailMessagesTopicOwner.md +13 -0
- data/docs/VoicemailMessagesTopicVoicemailCopyRecord.md +14 -0
- data/docs/VoicemailMessagesTopicVoicemailMessage.md +2 -0
- data/docs/WemLearningAssignmentRuleRunTopicLearningAssignmentRuleRunNotification.md +14 -0
- data/docs/WemLearningAssignmentRuleRunTopicLearningModuleReference.md +14 -0
- data/docs/WemLearningAssignmentRuleRunTopicWemLearningAssignmentsCreated.md +13 -0
- data/docs/WemLearningAssignmentTopicLearningAssignmentNotification.md +22 -0
- data/docs/WemLearningAssignmentTopicLearningModuleReference.md +14 -0
- data/docs/WemLearningAssignmentTopicUserReference.md +13 -0
- data/docs/WfmBuShortTermForecastImportCompleteTopicBuForecastModification.md +23 -0
- data/docs/WfmBuShortTermForecastImportCompleteTopicBuShortTermForecast.md +24 -0
- data/docs/WfmBuShortTermForecastImportCompleteTopicBuShortTermForecastNotification.md +15 -0
- data/docs/WfmBuShortTermForecastImportCompleteTopicForecastSourceDayPointer.md +17 -0
- data/docs/WfmBuShortTermForecastImportCompleteTopicModificationIntervalOffsetValue.md +14 -0
- data/docs/WfmBuShortTermForecastImportCompleteTopicUserReference.md +13 -0
- data/docs/WfmBuShortTermForecastImportCompleteTopicWfmVersionedEntityMetadata.md +15 -0
- data/docs/WorkforceManagementApi.md +3 -3
- data/lib/purecloudplatformclientv2.rb +44 -0
- data/lib/purecloudplatformclientv2/api/architect_api.rb +130 -0
- data/lib/purecloudplatformclientv2/api/audit_api.rb +55 -0
- data/lib/purecloudplatformclientv2/api/coaching_api.rb +1296 -0
- data/lib/purecloudplatformclientv2/api/groups_api.rb +4 -4
- data/lib/purecloudplatformclientv2/api/identity_provider_api.rb +175 -0
- data/lib/purecloudplatformclientv2/api/o_auth_api.rb +224 -0
- data/lib/purecloudplatformclientv2/api/organization_api.rb +120 -0
- data/lib/purecloudplatformclientv2/api/recording_api.rb +78 -0
- data/lib/purecloudplatformclientv2/api/usage_api.rb +157 -0
- data/lib/purecloudplatformclientv2/api/users_api.rb +4 -4
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +6 -6
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +13 -13
- data/lib/purecloudplatformclientv2/models/api_usage_query.rb +303 -0
- data/lib/purecloudplatformclientv2/models/api_usage_query_result.rb +244 -0
- data/lib/purecloudplatformclientv2/models/api_usage_row.rb +514 -0
- data/lib/purecloudplatformclientv2/models/audit_log_message.rb +6 -6
- data/lib/purecloudplatformclientv2/models/audit_query_entity.rb +244 -0
- data/lib/purecloudplatformclientv2/models/audit_query_execution_status_response.rb +34 -6
- data/lib/purecloudplatformclientv2/models/audit_query_request.rb +34 -6
- data/lib/purecloudplatformclientv2/models/audit_query_service.rb +244 -0
- data/lib/purecloudplatformclientv2/models/audit_query_service_mapping.rb +204 -0
- data/lib/purecloudplatformclientv2/models/audit_query_sort.rb +266 -0
- data/lib/purecloudplatformclientv2/models/bu_agent_schedule_activity.rb +70 -4
- data/lib/purecloudplatformclientv2/models/bu_reschedule_request.rb +2 -12
- data/lib/purecloudplatformclientv2/models/coaching_annotation.rb +429 -0
- data/lib/purecloudplatformclientv2/models/coaching_annotation_create_request.rb +252 -0
- data/lib/purecloudplatformclientv2/models/coaching_annotation_list.rb +428 -0
- data/lib/purecloudplatformclientv2/models/coaching_appointment_reference.rb +228 -0
- data/lib/purecloudplatformclientv2/models/coaching_appointment_response.rb +587 -0
- data/lib/purecloudplatformclientv2/models/coaching_appointment_response_list.rb +428 -0
- data/lib/purecloudplatformclientv2/models/coaching_appointment_status_dto.rb +299 -0
- data/lib/purecloudplatformclientv2/models/coaching_appointment_status_dto_list.rb +303 -0
- data/lib/purecloudplatformclientv2/models/coaching_notification.rb +504 -0
- data/lib/purecloudplatformclientv2/models/coaching_notification_list.rb +428 -0
- data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_aggregation_query.rb +1 -1
- data/lib/purecloudplatformclientv2/models/conversation_chat.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_call.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_cobrowse.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_message.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_screenshare.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_social_expression.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_video.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_reference.rb +228 -0
- data/lib/purecloudplatformclientv2/models/create_coaching_appointment_request.rb +426 -0
- data/lib/purecloudplatformclientv2/models/create_queue_request.rb +29 -1
- data/lib/purecloudplatformclientv2/models/document_reference.rb +228 -0
- data/lib/purecloudplatformclientv2/models/entity_listing.rb +104 -4
- data/lib/purecloudplatformclientv2/models/evaluation_aggregation_query.rb +1 -1
- data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/external_contact.rb +55 -1
- data/lib/purecloudplatformclientv2/models/external_organization.rb +55 -1
- data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/flow_aggregation_query.rb +1 -1
- data/lib/purecloudplatformclientv2/models/flow_execution_launch_request.rb +288 -0
- data/lib/purecloudplatformclientv2/models/flow_execution_launch_response.rb +281 -0
- data/lib/purecloudplatformclientv2/models/flow_runtime_execution.rb +494 -0
- data/lib/purecloudplatformclientv2/models/generic_saml.rb +428 -0
- data/lib/purecloudplatformclientv2/models/ip_address_authentication.rb +203 -0
- data/lib/purecloudplatformclientv2/models/knowledge_search_response.rb +18 -18
- data/lib/purecloudplatformclientv2/models/nlu_domain_version.rb +41 -1
- data/lib/purecloudplatformclientv2/models/prompt.rb +2 -0
- data/lib/purecloudplatformclientv2/models/prompt_asset.rb +15 -1
- data/lib/purecloudplatformclientv2/models/prompt_asset_create.rb +15 -1
- data/lib/purecloudplatformclientv2/models/queue.rb +29 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_call.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_callback.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_cobrowse.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_message.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_screenshare.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_social_expression.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_video.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_call.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_callback.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_cobrowse.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_screenshare.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_social_expression.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_video.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_call.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_callback.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_cobrowse.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_message.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_screenshare.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_social_expression.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_video.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_request.rb +29 -1
- data/lib/purecloudplatformclientv2/models/reporting_data_export_topic_data_export_notification.rb +31 -4
- data/lib/purecloudplatformclientv2/models/scim_email.rb +1 -1
- data/lib/purecloudplatformclientv2/models/survey_aggregation_query.rb +1 -1
- data/lib/purecloudplatformclientv2/models/update_coaching_appointment_request.rb +337 -0
- data/lib/purecloudplatformclientv2/models/upload_url_request.rb +43 -4
- data/lib/purecloudplatformclientv2/models/usage_execution_result.rb +228 -0
- data/lib/purecloudplatformclientv2/models/user_aggregation_query.rb +1 -1
- data/lib/purecloudplatformclientv2/models/user_queue.rb +29 -1
- data/lib/purecloudplatformclientv2/models/view_filter.rb +58 -4
- data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_owner.rb +201 -0
- data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_voicemail_copy_record.rb +226 -0
- data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_voicemail_message.rb +56 -4
- data/lib/purecloudplatformclientv2/models/wem_learning_assignment_rule_run_topic_learning_assignment_rule_run_notification.rb +228 -0
- data/lib/purecloudplatformclientv2/models/wem_learning_assignment_rule_run_topic_learning_module_reference.rb +226 -0
- data/lib/purecloudplatformclientv2/models/wem_learning_assignment_rule_run_topic_wem_learning_assignments_created.rb +201 -0
- data/lib/purecloudplatformclientv2/models/wem_learning_assignment_topic_learning_assignment_notification.rb +440 -0
- data/lib/purecloudplatformclientv2/models/wem_learning_assignment_topic_learning_module_reference.rb +226 -0
- data/lib/purecloudplatformclientv2/models/wem_learning_assignment_topic_user_reference.rb +201 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_forecast_modification.rb +497 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast.rb +494 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast_notification.rb +265 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_forecast_source_day_pointer.rb +315 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_modification_interval_offset_value.rb +226 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_user_reference.rb +201 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_wfm_versioned_entity_metadata.rb +251 -0
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +90 -2
data/docs/OrganizationApi.md
CHANGED
|
@@ -10,10 +10,12 @@ Method | Description
|
|
|
10
10
|
------------- | ------------- | -------------
|
|
11
11
|
[**get_fieldconfig**](OrganizationApi.html#get_fieldconfig) | Fetch field config for an entity type
|
|
12
12
|
[**get_organizations_embeddedintegration**](OrganizationApi.html#get_organizations_embeddedintegration) | Get the list of domains that will be allowed to embed PureCloud applications
|
|
13
|
+
[**get_organizations_ipaddressauthentication**](OrganizationApi.html#get_organizations_ipaddressauthentication) | Get organization IP address whitelist settings
|
|
13
14
|
[**get_organizations_me**](OrganizationApi.html#get_organizations_me) | Get organization.
|
|
14
15
|
[**get_organizations_whitelist**](OrganizationApi.html#get_organizations_whitelist) | Use PUT /api/v2/organizations/embeddedintegration instead
|
|
15
16
|
[**patch_organizations_feature**](OrganizationApi.html#patch_organizations_feature) | Update organization
|
|
16
17
|
[**put_organizations_embeddedintegration**](OrganizationApi.html#put_organizations_embeddedintegration) | Update the list of domains that will be allowed to embed PureCloud applications
|
|
18
|
+
[**put_organizations_ipaddressauthentication**](OrganizationApi.html#put_organizations_ipaddressauthentication) | Update organization IP address whitelist settings
|
|
17
19
|
[**put_organizations_me**](OrganizationApi.html#put_organizations_me) | Update organization.
|
|
18
20
|
[**put_organizations_whitelist**](OrganizationApi.html#put_organizations_whitelist) | Use PUT /api/v2/organizations/embeddedintegration instead
|
|
19
21
|
{: class="table table-striped"}
|
|
@@ -140,6 +142,65 @@ This endpoint does not need any parameter.
|
|
|
140
142
|
|
|
141
143
|
|
|
142
144
|
|
|
145
|
+
<a name="get_organizations_ipaddressauthentication"></a>
|
|
146
|
+
|
|
147
|
+
## [**IpAddressAuthentication**](IpAddressAuthentication.html) get_organizations_ipaddressauthentication
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
Get organization IP address whitelist settings
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
Wraps GET /api/v2/organizations/ipaddressauthentication
|
|
156
|
+
|
|
157
|
+
Requires ANY permissions:
|
|
158
|
+
|
|
159
|
+
* directory:organization:admin
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
### Example
|
|
163
|
+
```{"language":"ruby"}
|
|
164
|
+
# load the gem
|
|
165
|
+
require 'purecloudplatformclientv2'
|
|
166
|
+
# setup authorization
|
|
167
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
168
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
169
|
+
environment = "mypurecloud.com"
|
|
170
|
+
|
|
171
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
172
|
+
|
|
173
|
+
PureCloud.configure do |config|
|
|
174
|
+
config.access_token = @authToken
|
|
175
|
+
end
|
|
176
|
+
|
|
177
|
+
api_instance = PureCloud::OrganizationApi.new
|
|
178
|
+
|
|
179
|
+
begin
|
|
180
|
+
#Get organization IP address whitelist settings
|
|
181
|
+
result = api_instance.get_organizations_ipaddressauthentication
|
|
182
|
+
p result
|
|
183
|
+
rescue PureCloud::ApiError => e
|
|
184
|
+
puts "Exception when calling OrganizationApi->get_organizations_ipaddressauthentication: #{e}"
|
|
185
|
+
end
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
### Parameters
|
|
189
|
+
This endpoint does not need any parameter.
|
|
190
|
+
{: class="table table-striped"}
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
### Return type
|
|
194
|
+
|
|
195
|
+
[**IpAddressAuthentication**](IpAddressAuthentication.html)
|
|
196
|
+
|
|
197
|
+
### HTTP request headers
|
|
198
|
+
|
|
199
|
+
- **Content-Type**: application/json
|
|
200
|
+
- **Accept**: application/json
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
143
204
|
<a name="get_organizations_me"></a>
|
|
144
205
|
|
|
145
206
|
## [**Organization**](Organization.html) get_organizations_me
|
|
@@ -389,6 +450,71 @@ Name | Type | Description | Notes
|
|
|
389
450
|
|
|
390
451
|
|
|
391
452
|
|
|
453
|
+
<a name="put_organizations_ipaddressauthentication"></a>
|
|
454
|
+
|
|
455
|
+
## [**IpAddressAuthentication**](IpAddressAuthentication.html) put_organizations_ipaddressauthentication(body)
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
Update organization IP address whitelist settings
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
Wraps PUT /api/v2/organizations/ipaddressauthentication
|
|
464
|
+
|
|
465
|
+
Requires ANY permissions:
|
|
466
|
+
|
|
467
|
+
* directory:organization:admin
|
|
468
|
+
|
|
469
|
+
|
|
470
|
+
### Example
|
|
471
|
+
```{"language":"ruby"}
|
|
472
|
+
# load the gem
|
|
473
|
+
require 'purecloudplatformclientv2'
|
|
474
|
+
# setup authorization
|
|
475
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
476
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
477
|
+
environment = "mypurecloud.com"
|
|
478
|
+
|
|
479
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
480
|
+
|
|
481
|
+
PureCloud.configure do |config|
|
|
482
|
+
config.access_token = @authToken
|
|
483
|
+
end
|
|
484
|
+
|
|
485
|
+
api_instance = PureCloud::OrganizationApi.new
|
|
486
|
+
|
|
487
|
+
body = PureCloud::IpAddressAuthentication.new # IpAddressAuthentication | IP address Whitelist settings
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
begin
|
|
491
|
+
#Update organization IP address whitelist settings
|
|
492
|
+
result = api_instance.put_organizations_ipaddressauthentication(body)
|
|
493
|
+
p result
|
|
494
|
+
rescue PureCloud::ApiError => e
|
|
495
|
+
puts "Exception when calling OrganizationApi->put_organizations_ipaddressauthentication: #{e}"
|
|
496
|
+
end
|
|
497
|
+
```
|
|
498
|
+
|
|
499
|
+
### Parameters
|
|
500
|
+
|
|
501
|
+
Name | Type | Description | Notes
|
|
502
|
+
------------- | ------------- | ------------- | -------------
|
|
503
|
+
**body** | [**IpAddressAuthentication**](IpAddressAuthentication.html)| IP address Whitelist settings | |
|
|
504
|
+
{: class="table table-striped"}
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
### Return type
|
|
508
|
+
|
|
509
|
+
[**IpAddressAuthentication**](IpAddressAuthentication.html)
|
|
510
|
+
|
|
511
|
+
### HTTP request headers
|
|
512
|
+
|
|
513
|
+
- **Content-Type**: application/json
|
|
514
|
+
- **Accept**: application/json
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
|
|
392
518
|
<a name="put_organizations_me"></a>
|
|
393
519
|
|
|
394
520
|
## [**Organization**](Organization.html) put_organizations_me(opts)
|
data/docs/Prompt.md
CHANGED
|
@@ -10,8 +10,8 @@ title: Prompt
|
|
|
10
10
|
| **id** | **String** | The prompt identifier | [optional] |
|
|
11
11
|
| **name** | **String** | The prompt name. | |
|
|
12
12
|
| **description** | **String** | | [optional] |
|
|
13
|
-
| **resources** | [**Array<PromptAsset>**](PromptAsset.html) |
|
|
14
|
-
| **current_operation** | [**Operation**](Operation.html) |
|
|
13
|
+
| **resources** | [**Array<PromptAsset>**](PromptAsset.html) | List of resources associated with this prompt | [optional] |
|
|
14
|
+
| **current_operation** | [**Operation**](Operation.html) | Current prompt operation status | [optional] |
|
|
15
15
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
16
16
|
{: class="table table-striped"}
|
|
17
17
|
|
data/docs/Queue.md
CHANGED
|
@@ -17,6 +17,7 @@ title: Queue
|
|
|
17
17
|
| **created_by** | **String** | The ID of the user that created the queue. | [optional] |
|
|
18
18
|
| **member_count** | **Integer** | The number of users in the queue. | [optional] |
|
|
19
19
|
| **media_settings** | [**Hash<String, MediaSetting>**](MediaSetting.html) | The media settings for the queue. Valid key values: CALL, CALLBACK, CHAT, EMAIL, MESSAGE, SOCIAL_EXPRESSION, VIDEO_COMM | [optional] |
|
|
20
|
+
| **routing_rules** | [**Array<RoutingRule>**](RoutingRule.html) | The routing rules for the queue, used for routing to known or preferred agents. | [optional] |
|
|
20
21
|
| **bullseye** | [**Bullseye**](Bullseye.html) | The bulls-eye settings for the queue. | [optional] |
|
|
21
22
|
| **acw_settings** | [**AcwSettings**](AcwSettings.html) | The ACW settings for the queue. | [optional] |
|
|
22
23
|
| **skill_evaluation_method** | **String** | The skill evaluation method to use when routing conversations. | [optional] |
|
|
@@ -29,6 +29,7 @@ title: QueueConversationEventTopicCall
|
|
|
29
29
|
| **disconnect_reasons** | [**Array<QueueConversationEventTopicDisconnectReason>**](QueueConversationEventTopicDisconnectReason.html) | | [optional] |
|
|
30
30
|
| **fax_status** | [**QueueConversationEventTopicFaxStatus**](QueueConversationEventTopicFaxStatus.html) | | [optional] |
|
|
31
31
|
| **uui_data** | **String** | | [optional] |
|
|
32
|
+
| **wrapup** | [**QueueConversationEventTopicWrapup**](QueueConversationEventTopicWrapup.html) | | [optional] |
|
|
32
33
|
| **additional_properties** | **Object** | | [optional] |
|
|
33
34
|
{: class="table table-striped"}
|
|
34
35
|
|
|
@@ -27,6 +27,7 @@ title: QueueConversationEventTopicCallback
|
|
|
27
27
|
| **disconnected_time** | **DateTime** | | [optional] |
|
|
28
28
|
| **callback_scheduled_time** | **DateTime** | | [optional] |
|
|
29
29
|
| **automated_callback_config_id** | **String** | | [optional] |
|
|
30
|
+
| **wrapup** | [**QueueConversationEventTopicWrapup**](QueueConversationEventTopicWrapup.html) | | [optional] |
|
|
30
31
|
| **additional_properties** | **Object** | | [optional] |
|
|
31
32
|
{: class="table table-striped"}
|
|
32
33
|
|
|
@@ -20,6 +20,7 @@ title: QueueConversationEventTopicChat
|
|
|
20
20
|
| **connected_time** | **DateTime** | | [optional] |
|
|
21
21
|
| **disconnected_time** | **DateTime** | | [optional] |
|
|
22
22
|
| **journey_context** | [**QueueConversationEventTopicJourneyContext**](QueueConversationEventTopicJourneyContext.html) | | [optional] |
|
|
23
|
+
| **wrapup** | [**QueueConversationEventTopicWrapup**](QueueConversationEventTopicWrapup.html) | | [optional] |
|
|
23
24
|
| **additional_properties** | **Object** | | [optional] |
|
|
24
25
|
{: class="table table-striped"}
|
|
25
26
|
|
|
@@ -22,6 +22,7 @@ title: QueueConversationEventTopicCobrowse
|
|
|
22
22
|
| **provider_event_time** | **DateTime** | | [optional] |
|
|
23
23
|
| **connected_time** | **DateTime** | | [optional] |
|
|
24
24
|
| **disconnected_time** | **DateTime** | | [optional] |
|
|
25
|
+
| **wrapup** | [**QueueConversationEventTopicWrapup**](QueueConversationEventTopicWrapup.html) | | [optional] |
|
|
25
26
|
| **additional_properties** | **Object** | | [optional] |
|
|
26
27
|
{: class="table table-striped"}
|
|
27
28
|
|
|
@@ -25,6 +25,7 @@ title: QueueConversationEventTopicEmail
|
|
|
25
25
|
| **direction** | **String** | | [optional] |
|
|
26
26
|
| **draft_attachments** | [**Array<QueueConversationEventTopicAttachment>**](QueueConversationEventTopicAttachment.html) | | [optional] |
|
|
27
27
|
| **spam** | **BOOLEAN** | | [optional] |
|
|
28
|
+
| **wrapup** | [**QueueConversationEventTopicWrapup**](QueueConversationEventTopicWrapup.html) | | [optional] |
|
|
28
29
|
| **additional_properties** | **Object** | | [optional] |
|
|
29
30
|
{: class="table table-striped"}
|
|
30
31
|
|
|
@@ -24,6 +24,7 @@ title: QueueConversationEventTopicMessage
|
|
|
24
24
|
| **type** | **String** | | [optional] |
|
|
25
25
|
| **recipient_country** | **String** | | [optional] |
|
|
26
26
|
| **recipient_type** | **String** | | [optional] |
|
|
27
|
+
| **wrapup** | [**QueueConversationEventTopicWrapup**](QueueConversationEventTopicWrapup.html) | | [optional] |
|
|
27
28
|
| **additional_properties** | **Object** | | [optional] |
|
|
28
29
|
{: class="table table-striped"}
|
|
29
30
|
|
|
@@ -18,6 +18,7 @@ title: QueueConversationEventTopicScreenshare
|
|
|
18
18
|
| **disconnect_type** | **String** | | [optional] |
|
|
19
19
|
| **connected_time** | **DateTime** | | [optional] |
|
|
20
20
|
| **disconnected_time** | **DateTime** | | [optional] |
|
|
21
|
+
| **wrapup** | [**QueueConversationEventTopicWrapup**](QueueConversationEventTopicWrapup.html) | | [optional] |
|
|
21
22
|
| **additional_properties** | **Object** | | [optional] |
|
|
22
23
|
{: class="table table-striped"}
|
|
23
24
|
|
|
@@ -22,6 +22,7 @@ title: QueueConversationEventTopicSocialExpression
|
|
|
22
22
|
| **start_hold_time** | **DateTime** | | [optional] |
|
|
23
23
|
| **connected_time** | **DateTime** | | [optional] |
|
|
24
24
|
| **disconnected_time** | **DateTime** | | [optional] |
|
|
25
|
+
| **wrapup** | [**QueueConversationEventTopicWrapup**](QueueConversationEventTopicWrapup.html) | | [optional] |
|
|
25
26
|
| **additional_properties** | **Object** | | [optional] |
|
|
26
27
|
{: class="table table-striped"}
|
|
27
28
|
|
|
@@ -21,6 +21,7 @@ title: QueueConversationEventTopicVideo
|
|
|
21
21
|
| **connected_time** | **DateTime** | | [optional] |
|
|
22
22
|
| **disconnected_time** | **DateTime** | | [optional] |
|
|
23
23
|
| **msids** | **Array<String>** | | [optional] |
|
|
24
|
+
| **wrapup** | [**QueueConversationEventTopicWrapup**](QueueConversationEventTopicWrapup.html) | | [optional] |
|
|
24
25
|
| **additional_properties** | **Object** | | [optional] |
|
|
25
26
|
{: class="table table-striped"}
|
|
26
27
|
|
|
@@ -29,6 +29,7 @@ title: QueueConversationSocialExpressionEventTopicCall
|
|
|
29
29
|
| **disconnect_reasons** | [**Array<QueueConversationSocialExpressionEventTopicDisconnectReason>**](QueueConversationSocialExpressionEventTopicDisconnectReason.html) | | [optional] |
|
|
30
30
|
| **fax_status** | [**QueueConversationSocialExpressionEventTopicFaxStatus**](QueueConversationSocialExpressionEventTopicFaxStatus.html) | | [optional] |
|
|
31
31
|
| **uui_data** | **String** | | [optional] |
|
|
32
|
+
| **wrapup** | [**QueueConversationSocialExpressionEventTopicWrapup**](QueueConversationSocialExpressionEventTopicWrapup.html) | | [optional] |
|
|
32
33
|
| **additional_properties** | **Object** | | [optional] |
|
|
33
34
|
{: class="table table-striped"}
|
|
34
35
|
|
|
@@ -27,6 +27,7 @@ title: QueueConversationSocialExpressionEventTopicCallback
|
|
|
27
27
|
| **disconnected_time** | **DateTime** | | [optional] |
|
|
28
28
|
| **callback_scheduled_time** | **DateTime** | | [optional] |
|
|
29
29
|
| **automated_callback_config_id** | **String** | | [optional] |
|
|
30
|
+
| **wrapup** | [**QueueConversationSocialExpressionEventTopicWrapup**](QueueConversationSocialExpressionEventTopicWrapup.html) | | [optional] |
|
|
30
31
|
| **additional_properties** | **Object** | | [optional] |
|
|
31
32
|
{: class="table table-striped"}
|
|
32
33
|
|
|
@@ -20,6 +20,7 @@ title: QueueConversationSocialExpressionEventTopicChat
|
|
|
20
20
|
| **connected_time** | **DateTime** | | [optional] |
|
|
21
21
|
| **disconnected_time** | **DateTime** | | [optional] |
|
|
22
22
|
| **journey_context** | [**QueueConversationSocialExpressionEventTopicJourneyContext**](QueueConversationSocialExpressionEventTopicJourneyContext.html) | | [optional] |
|
|
23
|
+
| **wrapup** | [**QueueConversationSocialExpressionEventTopicWrapup**](QueueConversationSocialExpressionEventTopicWrapup.html) | | [optional] |
|
|
23
24
|
| **additional_properties** | **Object** | | [optional] |
|
|
24
25
|
{: class="table table-striped"}
|
|
25
26
|
|
|
@@ -22,6 +22,7 @@ title: QueueConversationSocialExpressionEventTopicCobrowse
|
|
|
22
22
|
| **provider_event_time** | **DateTime** | | [optional] |
|
|
23
23
|
| **connected_time** | **DateTime** | | [optional] |
|
|
24
24
|
| **disconnected_time** | **DateTime** | | [optional] |
|
|
25
|
+
| **wrapup** | [**QueueConversationSocialExpressionEventTopicWrapup**](QueueConversationSocialExpressionEventTopicWrapup.html) | | [optional] |
|
|
25
26
|
| **additional_properties** | **Object** | | [optional] |
|
|
26
27
|
{: class="table table-striped"}
|
|
27
28
|
|
|
@@ -25,6 +25,7 @@ title: QueueConversationSocialExpressionEventTopicEmail
|
|
|
25
25
|
| **direction** | **String** | | [optional] |
|
|
26
26
|
| **draft_attachments** | [**Array<QueueConversationSocialExpressionEventTopicAttachment>**](QueueConversationSocialExpressionEventTopicAttachment.html) | | [optional] |
|
|
27
27
|
| **spam** | **BOOLEAN** | | [optional] |
|
|
28
|
+
| **wrapup** | [**QueueConversationSocialExpressionEventTopicWrapup**](QueueConversationSocialExpressionEventTopicWrapup.html) | | [optional] |
|
|
28
29
|
| **additional_properties** | **Object** | | [optional] |
|
|
29
30
|
{: class="table table-striped"}
|
|
30
31
|
|
|
@@ -24,6 +24,7 @@ title: QueueConversationSocialExpressionEventTopicMessage
|
|
|
24
24
|
| **type** | **String** | | [optional] |
|
|
25
25
|
| **recipient_country** | **String** | | [optional] |
|
|
26
26
|
| **recipient_type** | **String** | | [optional] |
|
|
27
|
+
| **wrapup** | [**QueueConversationSocialExpressionEventTopicWrapup**](QueueConversationSocialExpressionEventTopicWrapup.html) | | [optional] |
|
|
27
28
|
| **additional_properties** | **Object** | | [optional] |
|
|
28
29
|
{: class="table table-striped"}
|
|
29
30
|
|
|
@@ -18,6 +18,7 @@ title: QueueConversationSocialExpressionEventTopicScreenshare
|
|
|
18
18
|
| **disconnect_type** | **String** | | [optional] |
|
|
19
19
|
| **connected_time** | **DateTime** | | [optional] |
|
|
20
20
|
| **disconnected_time** | **DateTime** | | [optional] |
|
|
21
|
+
| **wrapup** | [**QueueConversationSocialExpressionEventTopicWrapup**](QueueConversationSocialExpressionEventTopicWrapup.html) | | [optional] |
|
|
21
22
|
| **additional_properties** | **Object** | | [optional] |
|
|
22
23
|
{: class="table table-striped"}
|
|
23
24
|
|
|
@@ -22,6 +22,7 @@ title: QueueConversationSocialExpressionEventTopicSocialExpression
|
|
|
22
22
|
| **start_hold_time** | **DateTime** | | [optional] |
|
|
23
23
|
| **connected_time** | **DateTime** | | [optional] |
|
|
24
24
|
| **disconnected_time** | **DateTime** | | [optional] |
|
|
25
|
+
| **wrapup** | [**QueueConversationSocialExpressionEventTopicWrapup**](QueueConversationSocialExpressionEventTopicWrapup.html) | | [optional] |
|
|
25
26
|
| **additional_properties** | **Object** | | [optional] |
|
|
26
27
|
{: class="table table-striped"}
|
|
27
28
|
|
|
@@ -21,6 +21,7 @@ title: QueueConversationSocialExpressionEventTopicVideo
|
|
|
21
21
|
| **connected_time** | **DateTime** | | [optional] |
|
|
22
22
|
| **disconnected_time** | **DateTime** | | [optional] |
|
|
23
23
|
| **msids** | **Array<String>** | | [optional] |
|
|
24
|
+
| **wrapup** | [**QueueConversationSocialExpressionEventTopicWrapup**](QueueConversationSocialExpressionEventTopicWrapup.html) | | [optional] |
|
|
24
25
|
| **additional_properties** | **Object** | | [optional] |
|
|
25
26
|
{: class="table table-striped"}
|
|
26
27
|
|
|
@@ -29,6 +29,7 @@ title: QueueConversationVideoEventTopicCall
|
|
|
29
29
|
| **disconnect_reasons** | [**Array<QueueConversationVideoEventTopicDisconnectReason>**](QueueConversationVideoEventTopicDisconnectReason.html) | | [optional] |
|
|
30
30
|
| **fax_status** | [**QueueConversationVideoEventTopicFaxStatus**](QueueConversationVideoEventTopicFaxStatus.html) | | [optional] |
|
|
31
31
|
| **uui_data** | **String** | | [optional] |
|
|
32
|
+
| **wrapup** | [**QueueConversationVideoEventTopicWrapup**](QueueConversationVideoEventTopicWrapup.html) | | [optional] |
|
|
32
33
|
| **additional_properties** | **Object** | | [optional] |
|
|
33
34
|
{: class="table table-striped"}
|
|
34
35
|
|
|
@@ -27,6 +27,7 @@ title: QueueConversationVideoEventTopicCallback
|
|
|
27
27
|
| **disconnected_time** | **DateTime** | | [optional] |
|
|
28
28
|
| **callback_scheduled_time** | **DateTime** | | [optional] |
|
|
29
29
|
| **automated_callback_config_id** | **String** | | [optional] |
|
|
30
|
+
| **wrapup** | [**QueueConversationVideoEventTopicWrapup**](QueueConversationVideoEventTopicWrapup.html) | | [optional] |
|
|
30
31
|
| **additional_properties** | **Object** | | [optional] |
|
|
31
32
|
{: class="table table-striped"}
|
|
32
33
|
|
|
@@ -20,6 +20,7 @@ title: QueueConversationVideoEventTopicChat
|
|
|
20
20
|
| **connected_time** | **DateTime** | | [optional] |
|
|
21
21
|
| **disconnected_time** | **DateTime** | | [optional] |
|
|
22
22
|
| **journey_context** | [**QueueConversationVideoEventTopicJourneyContext**](QueueConversationVideoEventTopicJourneyContext.html) | | [optional] |
|
|
23
|
+
| **wrapup** | [**QueueConversationVideoEventTopicWrapup**](QueueConversationVideoEventTopicWrapup.html) | | [optional] |
|
|
23
24
|
| **additional_properties** | **Object** | | [optional] |
|
|
24
25
|
{: class="table table-striped"}
|
|
25
26
|
|
|
@@ -22,6 +22,7 @@ title: QueueConversationVideoEventTopicCobrowse
|
|
|
22
22
|
| **provider_event_time** | **DateTime** | | [optional] |
|
|
23
23
|
| **connected_time** | **DateTime** | | [optional] |
|
|
24
24
|
| **disconnected_time** | **DateTime** | | [optional] |
|
|
25
|
+
| **wrapup** | [**QueueConversationVideoEventTopicWrapup**](QueueConversationVideoEventTopicWrapup.html) | | [optional] |
|
|
25
26
|
| **additional_properties** | **Object** | | [optional] |
|
|
26
27
|
{: class="table table-striped"}
|
|
27
28
|
|
|
@@ -25,6 +25,7 @@ title: QueueConversationVideoEventTopicEmail
|
|
|
25
25
|
| **direction** | **String** | | [optional] |
|
|
26
26
|
| **draft_attachments** | [**Array<QueueConversationVideoEventTopicAttachment>**](QueueConversationVideoEventTopicAttachment.html) | | [optional] |
|
|
27
27
|
| **spam** | **BOOLEAN** | | [optional] |
|
|
28
|
+
| **wrapup** | [**QueueConversationVideoEventTopicWrapup**](QueueConversationVideoEventTopicWrapup.html) | | [optional] |
|
|
28
29
|
| **additional_properties** | **Object** | | [optional] |
|
|
29
30
|
{: class="table table-striped"}
|
|
30
31
|
|
|
@@ -24,6 +24,7 @@ title: QueueConversationVideoEventTopicMessage
|
|
|
24
24
|
| **type** | **String** | | [optional] |
|
|
25
25
|
| **recipient_country** | **String** | | [optional] |
|
|
26
26
|
| **recipient_type** | **String** | | [optional] |
|
|
27
|
+
| **wrapup** | [**QueueConversationVideoEventTopicWrapup**](QueueConversationVideoEventTopicWrapup.html) | | [optional] |
|
|
27
28
|
| **additional_properties** | **Object** | | [optional] |
|
|
28
29
|
{: class="table table-striped"}
|
|
29
30
|
|
|
@@ -18,6 +18,7 @@ title: QueueConversationVideoEventTopicScreenshare
|
|
|
18
18
|
| **disconnect_type** | **String** | | [optional] |
|
|
19
19
|
| **connected_time** | **DateTime** | | [optional] |
|
|
20
20
|
| **disconnected_time** | **DateTime** | | [optional] |
|
|
21
|
+
| **wrapup** | [**QueueConversationVideoEventTopicWrapup**](QueueConversationVideoEventTopicWrapup.html) | | [optional] |
|
|
21
22
|
| **additional_properties** | **Object** | | [optional] |
|
|
22
23
|
{: class="table table-striped"}
|
|
23
24
|
|
|
@@ -22,6 +22,7 @@ title: QueueConversationVideoEventTopicSocialExpression
|
|
|
22
22
|
| **start_hold_time** | **DateTime** | | [optional] |
|
|
23
23
|
| **connected_time** | **DateTime** | | [optional] |
|
|
24
24
|
| **disconnected_time** | **DateTime** | | [optional] |
|
|
25
|
+
| **wrapup** | [**QueueConversationVideoEventTopicWrapup**](QueueConversationVideoEventTopicWrapup.html) | | [optional] |
|
|
25
26
|
| **additional_properties** | **Object** | | [optional] |
|
|
26
27
|
{: class="table table-striped"}
|
|
27
28
|
|
|
@@ -21,6 +21,7 @@ title: QueueConversationVideoEventTopicVideo
|
|
|
21
21
|
| **connected_time** | **DateTime** | | [optional] |
|
|
22
22
|
| **disconnected_time** | **DateTime** | | [optional] |
|
|
23
23
|
| **msids** | **Array<String>** | | [optional] |
|
|
24
|
+
| **wrapup** | [**QueueConversationVideoEventTopicWrapup**](QueueConversationVideoEventTopicWrapup.html) | | [optional] |
|
|
24
25
|
| **additional_properties** | **Object** | | [optional] |
|
|
25
26
|
{: class="table table-striped"}
|
|
26
27
|
|
data/docs/QueueRequest.md
CHANGED
|
@@ -17,6 +17,7 @@ title: QueueRequest
|
|
|
17
17
|
| **created_by** | **String** | The ID of the user that created the queue. | [optional] |
|
|
18
18
|
| **member_count** | **Integer** | The number of users in the queue. | [optional] |
|
|
19
19
|
| **media_settings** | [**Hash<String, MediaSetting>**](MediaSetting.html) | The media settings for the queue. Valid key values: CALL, CALLBACK, CHAT, EMAIL, MESSAGE, SOCIAL_EXPRESSION, VIDEO_COMM | [optional] |
|
|
20
|
+
| **routing_rules** | [**Array<RoutingRule>**](RoutingRule.html) | The routing rules for the queue, used for routing to known or preferred agents. | [optional] |
|
|
20
21
|
| **bullseye** | [**Bullseye**](Bullseye.html) | The bulls-eye settings for the queue. | [optional] |
|
|
21
22
|
| **acw_settings** | [**AcwSettings**](AcwSettings.html) | The ACW settings for the queue. | [optional] |
|
|
22
23
|
| **skill_evaluation_method** | **String** | The skill evaluation method to use when routing conversations. | [optional] |
|
data/docs/RecordingApi.md
CHANGED
|
@@ -421,6 +421,9 @@ recording_id = "recording_id_example" # String | Recording ID
|
|
|
421
421
|
|
|
422
422
|
opts = {
|
|
423
423
|
format_id: "WEBM", # String | The desired media format.
|
|
424
|
+
email_format_id: "EML", # String | The desired media format when downloading an email recording.
|
|
425
|
+
chat_format_id: "ZIP", # String | The desired media format when downloading a chat recording.
|
|
426
|
+
message_format_id: "ZIP", # String | The desired media format when downloading a message recording.
|
|
424
427
|
download: false, # BOOLEAN | requesting a download format of the recording
|
|
425
428
|
file_name: "file_name_example", # String | the name of the downloaded fileName
|
|
426
429
|
locale: "locale_example" # String | The locale for the requested file when downloading, as an ISO 639-1 code
|
|
@@ -442,6 +445,9 @@ Name | Type | Description | Notes
|
|
|
442
445
|
**conversation_id** | **String**| Conversation ID | |
|
|
443
446
|
**recording_id** | **String**| Recording ID | |
|
|
444
447
|
**format_id** | **String**| The desired media format. | [optional] [default to WEBM]<br />**Values**: WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, MP3, NONE |
|
|
448
|
+
**email_format_id** | **String**| The desired media format when downloading an email recording. | [optional] [default to EML]<br />**Values**: EML, NONE |
|
|
449
|
+
**chat_format_id** | **String**| The desired media format when downloading a chat recording. | [optional] [default to ZIP]<br />**Values**: ZIP, NONE |
|
|
450
|
+
**message_format_id** | **String**| The desired media format when downloading a message recording. | [optional] [default to ZIP]<br />**Values**: ZIP, NONE |
|
|
445
451
|
**download** | **BOOLEAN**| requesting a download format of the recording | [optional] [default to false] |
|
|
446
452
|
**file_name** | **String**| the name of the downloaded fileName | [optional] |
|
|
447
453
|
**locale** | **String**| The locale for the requested file when downloading, as an ISO 639-1 code | [optional] |
|
|
@@ -904,6 +910,9 @@ orphan_id = "orphan_id_example" # String | Orphan ID
|
|
|
904
910
|
|
|
905
911
|
opts = {
|
|
906
912
|
format_id: "WEBM", # String | The desired media format.
|
|
913
|
+
email_format_id: "EML", # String | The desired media format when downloading an email recording.
|
|
914
|
+
chat_format_id: "ZIP", # String | The desired media format when downloading a chat recording.
|
|
915
|
+
message_format_id: "ZIP", # String | The desired media format when downloading a message recording.
|
|
907
916
|
download: false, # BOOLEAN | requesting a download format of the recording
|
|
908
917
|
file_name: "file_name_example", # String | the name of the downloaded fileName
|
|
909
918
|
locale: "locale_example" # String | The locale for the requested file when downloading, as an ISO 639-1 code
|
|
@@ -924,6 +933,9 @@ Name | Type | Description | Notes
|
|
|
924
933
|
------------- | ------------- | ------------- | -------------
|
|
925
934
|
**orphan_id** | **String**| Orphan ID | |
|
|
926
935
|
**format_id** | **String**| The desired media format. | [optional] [default to WEBM]<br />**Values**: WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, MP3, NONE |
|
|
936
|
+
**email_format_id** | **String**| The desired media format when downloading an email recording. | [optional] [default to EML]<br />**Values**: EML, NONE |
|
|
937
|
+
**chat_format_id** | **String**| The desired media format when downloading a chat recording. | [optional] [default to ZIP]<br />**Values**: ZIP, NONE |
|
|
938
|
+
**message_format_id** | **String**| The desired media format when downloading a message recording. | [optional] [default to ZIP]<br />**Values**: ZIP, NONE |
|
|
927
939
|
**download** | **BOOLEAN**| requesting a download format of the recording | [optional] [default to false] |
|
|
928
940
|
**file_name** | **String**| the name of the downloaded fileName | [optional] |
|
|
929
941
|
**locale** | **String**| The locale for the requested file when downloading, as an ISO 639-1 code | [optional] |
|