purecloudplatformclientv2 62.0.0 → 66.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/AnalyticsApi.md +32 -32
- data/docs/AnalyticsEvaluation.md +2 -0
- data/docs/AnalyticsParticipant.md +1 -0
- data/docs/ArchitectDependencyTrackingBuildNotificationClient.md +14 -0
- data/docs/ArchitectDependencyTrackingBuildNotificationDependencyTrackingBuildNotification.md +1 -0
- data/docs/ArchitectFlowNotificationArchitectOperation.md +1 -0
- data/docs/ArchitectFlowNotificationClient.md +14 -0
- data/docs/ArchitectFlowOutcomeNotificationArchitectOperation.md +1 -0
- data/docs/ArchitectFlowOutcomeNotificationClient.md +14 -0
- data/docs/ArchitectPromptNotificationArchitectOperation.md +1 -0
- data/docs/ArchitectPromptNotificationClient.md +14 -0
- data/docs/ArrayNode.md +5 -5
- data/docs/AsyncConversationQuery.md +7 -6
- data/docs/AuthorizationApi.md +7 -7
- data/docs/CallConversation.md +1 -0
- data/docs/ConversationAggregateDataContainer.md +14 -0
- data/docs/ConversationAggregateQueryClause.md +14 -0
- data/docs/ConversationAggregateQueryFilter.md +15 -0
- data/docs/ConversationAggregateQueryPredicate.md +17 -0
- data/docs/ConversationAggregateQueryResponse.md +13 -0
- data/docs/ConversationAggregationQuery.md +20 -0
- data/docs/ConversationAggregationView.md +16 -0
- data/docs/ConversationDetailQueryClause.md +14 -0
- data/docs/ConversationDetailQueryFilter.md +15 -0
- data/docs/ConversationDetailQueryPredicate.md +18 -0
- data/docs/ConversationQuery.md +6 -6
- data/docs/ConversationsApi.md +286 -4
- data/docs/CreateQueueMediaAssociationRequest.md +1 -0
- data/docs/DataSchema.md +1 -1
- data/docs/DependencyStatus.md +2 -1
- data/docs/DomainOrganizationRole.md +1 -1
- data/docs/DomainOrganizationRoleCreate.md +1 -1
- data/docs/DomainOrganizationRoleUpdate.md +1 -1
- data/docs/EvaluationAggregateDataContainer.md +14 -0
- data/docs/EvaluationAggregateQueryClause.md +14 -0
- data/docs/EvaluationAggregateQueryFilter.md +15 -0
- data/docs/EvaluationAggregateQueryPredicate.md +17 -0
- data/docs/EvaluationAggregateQueryResponse.md +13 -0
- data/docs/EvaluationAggregationQuery.md +21 -0
- data/docs/EvaluationAggregationView.md +16 -0
- data/docs/EvaluationDetailQueryClause.md +14 -0
- data/docs/EvaluationDetailQueryFilter.md +15 -0
- data/docs/EvaluationDetailQueryPredicate.md +18 -0
- data/docs/Flow.md +2 -1
- data/docs/{AggregateDataContainer.md → FlowAggregateDataContainer.md} +2 -2
- data/docs/FlowAggregateQueryClause.md +14 -0
- data/docs/FlowAggregateQueryFilter.md +15 -0
- data/docs/FlowAggregateQueryPredicate.md +17 -0
- data/docs/FlowAggregateQueryResponse.md +13 -0
- data/docs/{AggregationQuery.md → FlowAggregationQuery.md} +4 -4
- data/docs/{AnalyticsView.md → FlowAggregationView.md} +3 -3
- data/docs/{ObservationDataContainer.md → FlowObservationDataContainer.md} +2 -2
- data/docs/{ObservationQuery.md → FlowObservationQuery.md} +3 -3
- data/docs/FlowObservationQueryClause.md +14 -0
- data/docs/FlowObservationQueryFilter.md +15 -0
- data/docs/FlowObservationQueryPredicate.md +17 -0
- data/docs/FlowObservationQueryResponse.md +13 -0
- data/docs/FlowVersion.md +1 -0
- data/docs/FlowsApi.md +8 -8
- data/docs/HistoryEntry.md +2 -1
- data/docs/HistoryListing.md +1 -0
- data/docs/HomerRecord.md +63 -0
- data/docs/IpAddressRange.md +15 -0
- data/docs/IpAddressRangeListing.md +13 -0
- data/docs/JsonNode.md +5 -5
- data/docs/Location.md +4 -4
- data/docs/{LocationUpdateDefinition.md → LocationCreateUpdateDefinition.md} +7 -6
- data/docs/LocationDefinition.md +1 -0
- data/docs/LocationSearchRequest.md +1 -0
- data/docs/LocationsApi.md +6 -6
- data/docs/Manager.md +1 -1
- data/docs/MediaEndpointStatDetailQueryClause.md +14 -0
- data/docs/MediaEndpointStatDetailQueryFilter.md +15 -0
- data/docs/MediaEndpointStatDetailQueryPredicate.md +17 -0
- data/docs/MessageInfo.md +4 -4
- data/docs/ObjectsApi.md +1 -1
- data/docs/Operation.md +1 -0
- data/docs/PresenceDetailQueryClause.md +14 -0
- data/docs/PresenceDetailQueryFilter.md +15 -0
- data/docs/PresenceDetailQueryPredicate.md +17 -0
- data/docs/QualityApi.md +8 -8
- data/docs/QueueMediaAssociation.md +1 -1
- data/docs/QueueObservationDataContainer.md +14 -0
- data/docs/QueueObservationQuery.md +15 -0
- data/docs/QueueObservationQueryClause.md +14 -0
- data/docs/QueueObservationQueryFilter.md +15 -0
- data/docs/QueueObservationQueryPredicate.md +17 -0
- data/docs/{QualifierMappingObservationQueryResponse.md → QueueObservationQueryResponse.md} +3 -3
- data/docs/Recording.md +5 -4
- data/docs/RecordingApi.md +2 -2
- data/docs/RecordingJob.md +1 -0
- data/docs/RecordingJobsQuery.md +2 -2
- data/docs/RecordingMetadata.md +30 -0
- data/docs/ReportingExportJobRequest.md +2 -0
- data/docs/ReportingExportJobResponse.md +2 -0
- data/docs/RoutingApi.md +4 -4
- data/docs/RoutingStatusDetailQueryClause.md +14 -0
- data/docs/RoutingStatusDetailQueryFilter.md +15 -0
- data/docs/RoutingStatusDetailQueryPredicate.md +17 -0
- data/docs/SCIMApi.md +295 -31
- data/docs/SIPSearchPublicRequest.md +22 -0
- data/docs/ScimConfigResourceType.md +20 -0
- data/docs/ScimConfigResourceTypeSchemaExtension.md +14 -0
- data/docs/ScimConfigResourceTypesListResponse.md +17 -0
- data/docs/ScimError.md +16 -0
- data/docs/ScimGroupListResponse.md +2 -2
- data/docs/ScimMetadata.md +2 -2
- data/docs/ScimPhoneNumber.md +1 -1
- data/docs/ScimServiceProviderConfig.md +10 -2
- data/docs/ScimServiceProviderConfigAuthenticationScheme.md +18 -0
- data/docs/ScimServiceProviderConfigBulkFeature.md +15 -0
- data/docs/ScimServiceProviderConfigFilterFeature.md +14 -0
- data/docs/ScimServiceProviderConfigSimpleFeature.md +13 -0
- data/docs/ScimUserListResponse.md +2 -2
- data/docs/ScimV2CreateUser.md +8 -8
- data/docs/ScimV2Group.md +3 -3
- data/docs/ScimV2GroupReference.md +2 -2
- data/docs/ScimV2MemberReference.md +2 -2
- data/docs/ScimV2PatchOperation.md +2 -2
- data/docs/ScimV2PatchRequest.md +2 -2
- data/docs/ScimV2User.md +9 -9
- data/docs/SearchApi.md +4 -4
- data/docs/SegmentDetailQueryClause.md +14 -0
- data/docs/SegmentDetailQueryFilter.md +15 -0
- data/docs/{AnalyticsQueryPredicate.md → SegmentDetailQueryPredicate.md} +4 -4
- data/docs/SignedUrlResponse.md +16 -0
- data/docs/SipDownloadResponse.md +14 -0
- data/docs/SipSearchResult.md +20 -0
- data/docs/Site.md +1 -0
- data/docs/SmsPhoneNumber.md +1 -0
- data/docs/SuggestApi.md +2 -2
- data/docs/SurveyAggregateDataContainer.md +14 -0
- data/docs/SurveyAggregateQueryClause.md +14 -0
- data/docs/SurveyAggregateQueryFilter.md +15 -0
- data/docs/SurveyAggregateQueryPredicate.md +17 -0
- data/docs/SurveyAggregateQueryResponse.md +13 -0
- data/docs/SurveyAggregationQuery.md +20 -0
- data/docs/SurveyAggregationView.md +16 -0
- data/docs/SurveyDetailQueryClause.md +14 -0
- data/docs/SurveyDetailQueryFilter.md +15 -0
- data/docs/SurveyDetailQueryPredicate.md +18 -0
- data/docs/TelephonyApi.md +223 -0
- data/docs/TelephonyProvidersEdgeApi.md +6 -6
- data/docs/TokensApi.md +2 -1
- data/docs/TrusteeBillingOverview.md +1 -0
- data/docs/UserAggregateDataContainer.md +14 -0
- data/docs/UserAggregateQueryClause.md +14 -0
- data/docs/UserAggregateQueryFilter.md +15 -0
- data/docs/UserAggregateQueryPredicate.md +17 -0
- data/docs/{PresenceQueryResponse.md → UserAggregateQueryResponse.md} +3 -3
- data/docs/UserAggregationQuery.md +20 -0
- data/docs/UserAggregationView.md +16 -0
- data/docs/UserAuthorization.md +1 -1
- data/docs/UserDetailQueryClause.md +14 -0
- data/docs/UserDetailQueryFilter.md +15 -0
- data/docs/UserDetailQueryPredicate.md +17 -0
- data/docs/UserDetailsQuery.md +4 -4
- data/docs/UserObservationDataContainer.md +14 -0
- data/docs/UserObservationQuery.md +15 -0
- data/docs/UserObservationQueryClause.md +14 -0
- data/docs/UserObservationQueryFilter.md +15 -0
- data/docs/UserObservationQueryPredicate.md +17 -0
- data/docs/UserObservationQueryResponse.md +13 -0
- data/docs/UsersApi.md +10 -10
- data/docs/UtilitiesApi.md +59 -0
- data/lib/purecloudplatformclientv2.rb +99 -13
- data/lib/purecloudplatformclientv2/api/analytics_api.rb +24 -24
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +8 -8
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +343 -3
- data/lib/purecloudplatformclientv2/api/flows_api.rb +6 -6
- data/lib/purecloudplatformclientv2/api/locations_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api/objects_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api/quality_api.rb +6 -6
- data/lib/purecloudplatformclientv2/api/recording_api.rb +3 -3
- data/lib/purecloudplatformclientv2/api/routing_api.rb +3 -3
- data/lib/purecloudplatformclientv2/api/scim_api.rb +344 -30
- data/lib/purecloudplatformclientv2/api/search_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api/telephony_api.rb +270 -0
- data/lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb +4 -4
- data/lib/purecloudplatformclientv2/api/users_api.rb +8 -8
- data/lib/purecloudplatformclientv2/api/utilities_api.rb +55 -0
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/aggregate_metric_data.rb +1 -15
- data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +53 -1
- data/lib/purecloudplatformclientv2/models/analytics_participant.rb +31 -3
- data/lib/purecloudplatformclientv2/models/architect_dependency_tracking_build_notification_client.rb +226 -0
- data/lib/purecloudplatformclientv2/models/architect_dependency_tracking_build_notification_dependency_tracking_build_notification.rb +26 -1
- data/lib/purecloudplatformclientv2/models/architect_flow_notification_architect_operation.rb +26 -1
- data/lib/purecloudplatformclientv2/models/architect_flow_notification_client.rb +226 -0
- data/lib/purecloudplatformclientv2/models/architect_flow_outcome_notification_architect_operation.rb +26 -1
- data/lib/purecloudplatformclientv2/models/architect_flow_outcome_notification_client.rb +226 -0
- data/lib/purecloudplatformclientv2/models/architect_prompt_notification_architect_operation.rb +26 -1
- data/lib/purecloudplatformclientv2/models/architect_prompt_notification_client.rb +226 -0
- data/lib/purecloudplatformclientv2/models/array_node.rb +51 -51
- data/lib/purecloudplatformclientv2/models/async_conversation_query.rb +57 -31
- data/lib/purecloudplatformclientv2/models/call_conversation.rb +27 -1
- data/lib/purecloudplatformclientv2/models/conversation_aggregate_data_container.rb +231 -0
- data/lib/purecloudplatformclientv2/models/{analytics_query_clause.rb → conversation_aggregate_query_clause.rb} +3 -3
- data/lib/purecloudplatformclientv2/models/{analytics_query_filter.rb → conversation_aggregate_query_filter.rb} +4 -4
- data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_response.rb +203 -0
- data/lib/purecloudplatformclientv2/models/conversation_aggregation_query.rb +390 -0
- data/lib/purecloudplatformclientv2/models/conversation_aggregation_view.rb +323 -0
- data/lib/purecloudplatformclientv2/models/conversation_detail_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/conversation_detail_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/conversation_detail_query_predicate.rb +388 -0
- data/lib/purecloudplatformclientv2/models/conversation_query.rb +28 -28
- data/lib/purecloudplatformclientv2/models/create_queue_media_association_request.rb +27 -1
- data/lib/purecloudplatformclientv2/models/data_schema.rb +1 -1
- data/lib/purecloudplatformclientv2/models/dependency_status.rb +28 -1
- data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +1 -0
- data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +1 -0
- data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +1 -0
- data/lib/purecloudplatformclientv2/models/evaluation_aggregate_data_container.rb +231 -0
- data/lib/purecloudplatformclientv2/models/evaluation_aggregate_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/evaluation_aggregate_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/evaluation_aggregate_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/evaluation_aggregate_query_response.rb +203 -0
- data/lib/purecloudplatformclientv2/models/evaluation_aggregation_query.rb +430 -0
- data/lib/purecloudplatformclientv2/models/evaluation_aggregation_view.rb +323 -0
- data/lib/purecloudplatformclientv2/models/evaluation_detail_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/evaluation_detail_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/evaluation_detail_query_predicate.rb +388 -0
- data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/flow.rb +28 -1
- data/lib/purecloudplatformclientv2/models/{aggregate_data_container.rb → flow_aggregate_data_container.rb} +1 -1
- data/lib/purecloudplatformclientv2/models/flow_aggregate_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/flow_aggregate_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/{aggregate_query_response.rb → flow_aggregate_query_response.rb} +2 -2
- data/lib/purecloudplatformclientv2/models/{aggregation_query.rb → flow_aggregation_query.rb} +3 -3
- data/lib/purecloudplatformclientv2/models/flow_aggregation_view.rb +323 -0
- data/lib/purecloudplatformclientv2/models/{observation_data_container.rb → flow_observation_data_container.rb} +1 -1
- data/lib/purecloudplatformclientv2/models/{observation_query.rb → flow_observation_query.rb} +2 -2
- data/lib/purecloudplatformclientv2/models/flow_observation_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/flow_observation_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/flow_observation_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/{observation_query_response.rb → flow_observation_query_response.rb} +2 -2
- data/lib/purecloudplatformclientv2/models/flow_version.rb +26 -1
- data/lib/purecloudplatformclientv2/models/history_entry.rb +28 -1
- data/lib/purecloudplatformclientv2/models/history_listing.rb +26 -1
- data/lib/purecloudplatformclientv2/models/homer_record.rb +1501 -0
- data/lib/purecloudplatformclientv2/models/ip_address_range.rb +265 -0
- data/lib/purecloudplatformclientv2/models/ip_address_range_listing.rb +203 -0
- data/lib/purecloudplatformclientv2/models/json_node.rb +51 -51
- data/lib/purecloudplatformclientv2/models/location.rb +4 -0
- data/lib/purecloudplatformclientv2/models/{location_update_definition.rb → location_create_update_definition.rb} +56 -25
- data/lib/purecloudplatformclientv2/models/location_definition.rb +27 -1
- data/lib/purecloudplatformclientv2/models/location_search_request.rb +29 -1
- data/lib/purecloudplatformclientv2/models/manager.rb +1 -1
- data/lib/purecloudplatformclientv2/models/media_endpoint_stat_detail_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/media_endpoint_stat_detail_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/media_endpoint_stat_detail_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/message_info.rb +4 -0
- data/lib/purecloudplatformclientv2/models/observation_metric_data.rb +1 -15
- data/lib/purecloudplatformclientv2/models/operation.rb +26 -1
- data/lib/purecloudplatformclientv2/models/presence_detail_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/presence_detail_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/presence_detail_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/queue_media_association.rb +17 -17
- data/lib/purecloudplatformclientv2/models/queue_observation_data_container.rb +231 -0
- data/lib/purecloudplatformclientv2/models/queue_observation_query.rb +263 -0
- data/lib/purecloudplatformclientv2/models/queue_observation_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/queue_observation_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/queue_observation_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/{qualifier_mapping_observation_query_response.rb → queue_observation_query_response.rb} +2 -2
- data/lib/purecloudplatformclientv2/models/recording.rb +31 -3
- data/lib/purecloudplatformclientv2/models/recording_job.rb +30 -4
- data/lib/purecloudplatformclientv2/models/recording_jobs_query.rb +2 -2
- data/lib/purecloudplatformclientv2/models/recording_metadata.rb +670 -0
- data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +58 -6
- data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +55 -3
- data/lib/purecloudplatformclientv2/models/routing_status_detail_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/routing_status_detail_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/routing_status_detail_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/scim_config_resource_type.rb +389 -0
- data/lib/purecloudplatformclientv2/models/scim_config_resource_type_schema_extension.rb +229 -0
- data/lib/purecloudplatformclientv2/models/scim_config_resource_types_list_response.rb +311 -0
- data/lib/purecloudplatformclientv2/models/scim_error.rb +297 -0
- data/lib/purecloudplatformclientv2/models/scim_group_list_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_metadata.rb +4 -4
- data/lib/purecloudplatformclientv2/models/scim_phone_number.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config.rb +216 -3
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb +362 -0
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_bulk_feature.rb +255 -0
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_filter_feature.rb +229 -0
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_simple_feature.rb +203 -0
- data/lib/purecloudplatformclientv2/models/scim_user_list_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +8 -8
- data/lib/purecloudplatformclientv2/models/scim_v2_group.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_v2_group_reference.rb +4 -4
- data/lib/purecloudplatformclientv2/models/scim_v2_member_reference.rb +4 -4
- data/lib/purecloudplatformclientv2/models/scim_v2_patch_operation.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_v2_patch_request.rb +2 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +9 -9
- data/lib/purecloudplatformclientv2/models/segment_detail_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/segment_detail_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/{analytics_query_predicate.rb → segment_detail_query_predicate.rb} +7 -7
- data/lib/purecloudplatformclientv2/models/signed_url_response.rb +279 -0
- data/lib/purecloudplatformclientv2/models/sip_download_response.rb +228 -0
- data/lib/purecloudplatformclientv2/models/sip_search_public_request.rb +445 -0
- data/lib/purecloudplatformclientv2/models/sip_search_result.rb +386 -0
- data/lib/purecloudplatformclientv2/models/site.rb +26 -1
- data/lib/purecloudplatformclientv2/models/sms_phone_number.rb +41 -1
- data/lib/purecloudplatformclientv2/models/subject_division_grants.rb +2 -2
- data/lib/purecloudplatformclientv2/models/survey_aggregate_data_container.rb +231 -0
- data/lib/purecloudplatformclientv2/models/survey_aggregate_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/survey_aggregate_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/survey_aggregate_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/survey_aggregate_query_response.rb +203 -0
- data/lib/purecloudplatformclientv2/models/survey_aggregation_query.rb +390 -0
- data/lib/purecloudplatformclientv2/models/survey_aggregation_view.rb +323 -0
- data/lib/purecloudplatformclientv2/models/survey_detail_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/survey_detail_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/survey_detail_query_predicate.rb +388 -0
- data/lib/purecloudplatformclientv2/models/system_message_system_message.rb +4 -4
- data/lib/purecloudplatformclientv2/models/trustee_billing_overview.rb +27 -1
- data/lib/purecloudplatformclientv2/models/user_aggregate_data_container.rb +231 -0
- data/lib/purecloudplatformclientv2/models/user_aggregate_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/user_aggregate_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/user_aggregate_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/{presence_query_response.rb → user_aggregate_query_response.rb} +2 -2
- data/lib/purecloudplatformclientv2/models/user_aggregation_query.rb +390 -0
- data/lib/purecloudplatformclientv2/models/{analytics_view.rb → user_aggregation_view.rb} +17 -3
- data/lib/purecloudplatformclientv2/models/user_authorization.rb +1 -0
- data/lib/purecloudplatformclientv2/models/user_detail_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/user_detail_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/user_detail_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/user_details_query.rb +37 -38
- data/lib/purecloudplatformclientv2/models/user_observation_data_container.rb +231 -0
- data/lib/purecloudplatformclientv2/models/user_observation_query.rb +263 -0
- data/lib/purecloudplatformclientv2/models/user_observation_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/user_observation_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/user_observation_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/user_observation_query_response.rb +203 -0
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +200 -28
- data/docs/AggregateQueryResponse.md +0 -13
- data/docs/AnalyticsQueryClause.md +0 -14
- data/docs/AnalyticsQueryFilter.md +0 -15
- data/docs/ObservationQueryResponse.md +0 -13
data/docs/AuthorizationApi.md
CHANGED
@@ -873,7 +873,7 @@ api_instance = PureCloud::AuthorizationApi.new
|
|
873
873
|
role_id = "role_id_example" # String | Role ID
|
874
874
|
|
875
875
|
opts = {
|
876
|
-
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand.
|
876
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand. \"unusedPermissions\" returns the permissions not used for the role
|
877
877
|
}
|
878
878
|
|
879
879
|
begin
|
@@ -890,7 +890,7 @@ end
|
|
890
890
|
Name | Type | Description | Notes
|
891
891
|
------------- | ------------- | ------------- | -------------
|
892
892
|
**role_id** | **String**| Role ID | |
|
893
|
-
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand. | [optional] <br />**Values**: unusedPermissions |
|
893
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand. \"unusedPermissions\" returns the permissions not used for the role | [optional] <br />**Values**: unusedPermissions |
|
894
894
|
{: class="table table-striped"}
|
895
895
|
|
896
896
|
|
@@ -1583,7 +1583,7 @@ end
|
|
1583
1583
|
Name | Type | Description | Notes
|
1584
1584
|
------------- | ------------- | ------------- | -------------
|
1585
1585
|
**division_id** | **String**| Division ID | |
|
1586
|
-
**object_type** | **String**| The type of the objects. Must be one of the valid object types | <br />**Values**: QUEUE, CAMPAIGN, CONTACTLIST, DNCLIST, MANAGEMENTUNIT, BUSINESSUNIT, FLOW, USER |
|
1586
|
+
**object_type** | **String**| The type of the objects. Must be one of the valid object types | <br />**Values**: QUEUE, CAMPAIGN, CONTACTLIST, DNCLIST, MESSAGINGCAMPAIGN, MANAGEMENTUNIT, BUSINESSUNIT, FLOW, USER |
|
1587
1587
|
**body** | **Array<String>**| Object Id List | |
|
1588
1588
|
{: class="table table-striped"}
|
1589
1589
|
|
@@ -1704,7 +1704,7 @@ role_id = "role_id_example" # String | Role ID
|
|
1704
1704
|
body = PureCloud::SubjectDivisions.new # SubjectDivisions | Subjects and Divisions
|
1705
1705
|
|
1706
1706
|
opts = {
|
1707
|
-
subject_type: "PC_USER" # String | what the type of the
|
1707
|
+
subject_type: "PC_USER" # String | what the type of the subjects are (PC_GROUP, PC_USER or PC_OAUTH_CLIENT)
|
1708
1708
|
}
|
1709
1709
|
|
1710
1710
|
begin
|
@@ -1721,7 +1721,7 @@ Name | Type | Description | Notes
|
|
1721
1721
|
------------- | ------------- | ------------- | -------------
|
1722
1722
|
**role_id** | **String**| Role ID | |
|
1723
1723
|
**body** | [**SubjectDivisions**](SubjectDivisions.html)| Subjects and Divisions | |
|
1724
|
-
**subject_type** | **String**| what the type of the
|
1724
|
+
**subject_type** | **String**| what the type of the subjects are (PC_GROUP, PC_USER or PC_OAUTH_CLIENT) | [optional] [default to PC_USER] |
|
1725
1725
|
{: class="table table-striped"}
|
1726
1726
|
|
1727
1727
|
|
@@ -1979,7 +1979,7 @@ division_id = "division_id_example" # String | the id of the division to which t
|
|
1979
1979
|
role_id = "role_id_example" # String | the id of the role to grant
|
1980
1980
|
|
1981
1981
|
opts = {
|
1982
|
-
subject_type: "PC_USER" # String | what the type of the subject is
|
1982
|
+
subject_type: "PC_USER" # String | what the type of the subject is: PC_GROUP, PC_USER or PC_OAUTH_CLIENT (note: for cross-org authorization, please use the Organization Authorization endpoints)
|
1983
1983
|
}
|
1984
1984
|
|
1985
1985
|
begin
|
@@ -1997,7 +1997,7 @@ Name | Type | Description | Notes
|
|
1997
1997
|
**subject_id** | **String**| Subject ID (user or group) | |
|
1998
1998
|
**division_id** | **String**| the id of the division to which to make the grant | |
|
1999
1999
|
**role_id** | **String**| the id of the role to grant | |
|
2000
|
-
**subject_type** | **String**| what the type of the subject is
|
2000
|
+
**subject_type** | **String**| what the type of the subject is: PC_GROUP, PC_USER or PC_OAUTH_CLIENT (note: for cross-org authorization, please use the Organization Authorization endpoints) | [optional] [default to PC_USER] |
|
2001
2001
|
{: class="table table-striped"}
|
2002
2002
|
|
2003
2003
|
|
data/docs/CallConversation.md
CHANGED
@@ -12,6 +12,7 @@ title: CallConversation
|
|
12
12
|
| **participants** | [**Array<CallMediaParticipant>**](CallMediaParticipant.html) | The list of participants involved in the conversation. | [optional] |
|
13
13
|
| **other_media_uris** | **Array<String>** | The list of other media channels involved in the conversation. | [optional] |
|
14
14
|
| **recording_state** | **String** | | [optional] |
|
15
|
+
| **max_participants** | **Integer** | If this is a conference conversation, then this field indicates the maximum number of participants allowed to participant in the conference. | [optional] |
|
15
16
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
16
17
|
{: class="table table-striped"}
|
17
18
|
|
@@ -0,0 +1,14 @@
|
|
1
|
+
---
|
2
|
+
title: ConversationAggregateDataContainer
|
3
|
+
---
|
4
|
+
## PureCloud::ConversationAggregateDataContainer
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **group** | **Hash<String, String>** | A mapping from dimension to value | [optional] |
|
11
|
+
| **data** | [**Array<StatisticalResponse>**](StatisticalResponse.html) | | [optional] |
|
12
|
+
{: class="table table-striped"}
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
---
|
2
|
+
title: ConversationAggregateQueryClause
|
3
|
+
---
|
4
|
+
## PureCloud::ConversationAggregateQueryClause
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **type** | **String** | Boolean operation to apply to the provided predicates | |
|
11
|
+
| **predicates** | [**Array<ConversationAggregateQueryPredicate>**](ConversationAggregateQueryPredicate.html) | Like a three-word sentence: (attribute-name) (operator) (target-value). | |
|
12
|
+
{: class="table table-striped"}
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
---
|
2
|
+
title: ConversationAggregateQueryFilter
|
3
|
+
---
|
4
|
+
## PureCloud::ConversationAggregateQueryFilter
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **type** | **String** | Boolean operation to apply to the provided predicates and clauses | |
|
11
|
+
| **clauses** | [**Array<ConversationAggregateQueryClause>**](ConversationAggregateQueryClause.html) | Boolean 'and/or' logic with up to two-levels of nesting | [optional] |
|
12
|
+
| **predicates** | [**Array<ConversationAggregateQueryPredicate>**](ConversationAggregateQueryPredicate.html) | Like a three-word sentence: (attribute-name) (operator) (target-value). | [optional] |
|
13
|
+
{: class="table table-striped"}
|
14
|
+
|
15
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
---
|
2
|
+
title: ConversationAggregateQueryPredicate
|
3
|
+
---
|
4
|
+
## PureCloud::ConversationAggregateQueryPredicate
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **type** | **String** | Optional type, can usually be inferred | [optional] |
|
11
|
+
| **dimension** | **String** | Left hand side for dimension predicates | [optional] |
|
12
|
+
| **operator** | **String** | Optional operator, default is matches | [optional] |
|
13
|
+
| **value** | **String** | Right hand side for dimension predicates | [optional] |
|
14
|
+
| **range** | [**NumericRange**](NumericRange.html) | Right hand side for dimension predicates | [optional] |
|
15
|
+
{: class="table table-striped"}
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
---
|
2
|
+
title: ConversationAggregateQueryResponse
|
3
|
+
---
|
4
|
+
## PureCloud::ConversationAggregateQueryResponse
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **results** | [**Array<ConversationAggregateDataContainer>**](ConversationAggregateDataContainer.html) | | [optional] |
|
11
|
+
{: class="table table-striped"}
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
---
|
2
|
+
title: ConversationAggregationQuery
|
3
|
+
---
|
4
|
+
## PureCloud::ConversationAggregationQuery
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **interval** | **String** | Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | [optional] |
|
11
|
+
| **granularity** | **String** | Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H | [optional] |
|
12
|
+
| **time_zone** | **String** | Sets the time zone for the query interval, defaults to UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London | [optional] |
|
13
|
+
| **group_by** | **Array<String>** | Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group. | [optional] |
|
14
|
+
| **filter** | [**ConversationAggregateQueryFilter**](ConversationAggregateQueryFilter.html) | Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters | [optional] |
|
15
|
+
| **metrics** | **Array<String>** | Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *). | [optional] |
|
16
|
+
| **flatten_multivalued_dimensions** | **BOOLEAN** | Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c') | [optional] |
|
17
|
+
| **views** | [**Array<ConversationAggregationView>**](ConversationAggregationView.html) | Custom derived metric views | [optional] |
|
18
|
+
{: class="table table-striped"}
|
19
|
+
|
20
|
+
|
@@ -0,0 +1,16 @@
|
|
1
|
+
---
|
2
|
+
title: ConversationAggregationView
|
3
|
+
---
|
4
|
+
## PureCloud::ConversationAggregationView
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **target** | **String** | Target metric name | |
|
11
|
+
| **name** | **String** | A unique name for this view. Must be distinct from other views and built-in metric names. | |
|
12
|
+
| **function** | **String** | Type of view you wish to create | |
|
13
|
+
| **range** | [**AggregationRange**](AggregationRange.html) | Range of numbers for slicing up data | [optional] |
|
14
|
+
{: class="table table-striped"}
|
15
|
+
|
16
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
---
|
2
|
+
title: ConversationDetailQueryClause
|
3
|
+
---
|
4
|
+
## PureCloud::ConversationDetailQueryClause
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **type** | **String** | Boolean operation to apply to the provided predicates | |
|
11
|
+
| **predicates** | [**Array<ConversationDetailQueryPredicate>**](ConversationDetailQueryPredicate.html) | Like a three-word sentence: (attribute-name) (operator) (target-value). | |
|
12
|
+
{: class="table table-striped"}
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
---
|
2
|
+
title: ConversationDetailQueryFilter
|
3
|
+
---
|
4
|
+
## PureCloud::ConversationDetailQueryFilter
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **type** | **String** | Boolean operation to apply to the provided predicates and clauses | |
|
11
|
+
| **clauses** | [**Array<ConversationDetailQueryClause>**](ConversationDetailQueryClause.html) | Boolean 'and/or' logic with up to two-levels of nesting | [optional] |
|
12
|
+
| **predicates** | [**Array<ConversationDetailQueryPredicate>**](ConversationDetailQueryPredicate.html) | Like a three-word sentence: (attribute-name) (operator) (target-value). | [optional] |
|
13
|
+
{: class="table table-striped"}
|
14
|
+
|
15
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
---
|
2
|
+
title: ConversationDetailQueryPredicate
|
3
|
+
---
|
4
|
+
## PureCloud::ConversationDetailQueryPredicate
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **type** | **String** | Optional type, can usually be inferred | [optional] |
|
11
|
+
| **dimension** | **String** | Left hand side for dimension predicates | [optional] |
|
12
|
+
| **metric** | **String** | Left hand side for metric predicates | [optional] |
|
13
|
+
| **operator** | **String** | Optional operator, default is matches | [optional] |
|
14
|
+
| **value** | **String** | Right hand side for dimension or metric predicates | [optional] |
|
15
|
+
| **range** | [**NumericRange**](NumericRange.html) | Right hand side for dimension or metric predicates | [optional] |
|
16
|
+
{: class="table table-striped"}
|
17
|
+
|
18
|
+
|
data/docs/ConversationQuery.md
CHANGED
@@ -7,12 +7,12 @@ title: ConversationQuery
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **interval** | **String** | Specifies the date and time range of data being queried. Results will include conversations that both started on a day touched by the interval AND either started, ended, or any activity during the interval.
|
11
|
-
| **conversation_filters** | [**Array<
|
12
|
-
| **
|
13
|
-
| **
|
14
|
-
| **media_endpoint_stat_filters** | [**Array<
|
15
|
-
| **
|
10
|
+
| **interval** | **String** | Specifies the date and time range of data being queried. Results will include conversations that both started on a day touched by the interval AND either started, ended, or any activity during the interval. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | [optional] |
|
11
|
+
| **conversation_filters** | [**Array<ConversationDetailQueryFilter>**](ConversationDetailQueryFilter.html) | Filters that target conversation-level data | [optional] |
|
12
|
+
| **segment_filters** | [**Array<SegmentDetailQueryFilter>**](SegmentDetailQueryFilter.html) | Filters that target individual segments within a conversation | [optional] |
|
13
|
+
| **evaluation_filters** | [**Array<EvaluationDetailQueryFilter>**](EvaluationDetailQueryFilter.html) | Filters that target evaluations | [optional] |
|
14
|
+
| **media_endpoint_stat_filters** | [**Array<MediaEndpointStatDetailQueryFilter>**](MediaEndpointStatDetailQueryFilter.html) | Filters that target mediaEndpointStats | [optional] |
|
15
|
+
| **survey_filters** | [**Array<SurveyDetailQueryFilter>**](SurveyDetailQueryFilter.html) | Filters that target surveys | [optional] |
|
16
16
|
| **order** | **String** | Sort the result set in ascending/descending order. Default is ascending | [optional] |
|
17
17
|
| **order_by** | **String** | Specify which data element within the result set to use for sorting. The options to use as a basis for sorting the results: conversationStart, segmentStart, and segmentEnd. If not specified, the default is conversationStart | [optional] |
|
18
18
|
| **aggregations** | [**Array<AnalyticsQueryAggregation>**](AnalyticsQueryAggregation.html) | Include faceted search and aggregate roll-ups describing your search results. This does not function as a filter, but rather, summary data about the data matching your filters | [optional] |
|
data/docs/ConversationsApi.md
CHANGED
@@ -37,6 +37,8 @@ Method | Description
|
|
37
37
|
[**get_conversations_calls_history**](ConversationsApi.html#get_conversations_calls_history) | Get call history
|
38
38
|
[**get_conversations_calls_maximumconferenceparties**](ConversationsApi.html#get_conversations_calls_maximumconferenceparties) | Get the maximum number of participants that this user can have on a conference
|
39
39
|
[**get_conversations_chat**](ConversationsApi.html#get_conversations_chat) | Get chat conversation
|
40
|
+
[**get_conversations_chat_message**](ConversationsApi.html#get_conversations_chat_message) | Get a web chat conversation message
|
41
|
+
[**get_conversations_chat_messages**](ConversationsApi.html#get_conversations_chat_messages) | Get the messages of a chat conversation.
|
40
42
|
[**get_conversations_chat_participant_wrapup**](ConversationsApi.html#get_conversations_chat_participant_wrapup) | Get the wrap-up for this conversation participant.
|
41
43
|
[**get_conversations_chat_participant_wrapupcodes**](ConversationsApi.html#get_conversations_chat_participant_wrapupcodes) | Get list of wrapup codes for this conversation participant
|
42
44
|
[**get_conversations_chats**](ConversationsApi.html#get_conversations_chats) | Get active chat conversations for the logged in user
|
@@ -112,6 +114,8 @@ Method | Description
|
|
112
114
|
[**post_conversations_callback_participant_replace**](ConversationsApi.html#post_conversations_callback_participant_replace) | Replace this participant with the specified user and/or address
|
113
115
|
[**post_conversations_callbacks**](ConversationsApi.html#post_conversations_callbacks) | Create a Callback
|
114
116
|
[**post_conversations_calls**](ConversationsApi.html#post_conversations_calls) | Create a call conversation
|
117
|
+
[**post_conversations_chat_communication_messages**](ConversationsApi.html#post_conversations_chat_communication_messages) | Send a message on behalf of a communication in a chat conversation.
|
118
|
+
[**post_conversations_chat_communication_typing**](ConversationsApi.html#post_conversations_chat_communication_typing) | Send a typing-indicator on behalf of a communication in a chat conversation.
|
115
119
|
[**post_conversations_chat_participant_replace**](ConversationsApi.html#post_conversations_chat_participant_replace) | Replace this participant with the specified user and/or address
|
116
120
|
[**post_conversations_chats**](ConversationsApi.html#post_conversations_chats) | Create a web chat conversation
|
117
121
|
[**post_conversations_cobrowsesession_participant_replace**](ConversationsApi.html#post_conversations_cobrowsesession_participant_replace) | Replace this participant with the specified user and/or address
|
@@ -2040,6 +2044,147 @@ Name | Type | Description | Notes
|
|
2040
2044
|
|
2041
2045
|
|
2042
2046
|
|
2047
|
+
<a name="get_conversations_chat_message"></a>
|
2048
|
+
|
2049
|
+
## [**WebChatMessage**](WebChatMessage.html) get_conversations_chat_message(conversation_id, message_id)
|
2050
|
+
|
2051
|
+
|
2052
|
+
|
2053
|
+
Get a web chat conversation message
|
2054
|
+
|
2055
|
+
The current user must be involved with the conversation to get its messages.
|
2056
|
+
|
2057
|
+
Wraps GET /api/v2/conversations/chats/{conversationId}/messages/{messageId}
|
2058
|
+
|
2059
|
+
Requires NO permissions:
|
2060
|
+
|
2061
|
+
|
2062
|
+
|
2063
|
+
### Example
|
2064
|
+
```{"language":"ruby"}
|
2065
|
+
# load the gem
|
2066
|
+
require 'purecloudplatformclientv2'
|
2067
|
+
# setup authorization
|
2068
|
+
@secret = ENV['PURECLOUD_SECRET']
|
2069
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
2070
|
+
environment = "mypurecloud.com"
|
2071
|
+
|
2072
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
2073
|
+
|
2074
|
+
PureCloud.configure do |config|
|
2075
|
+
config.access_token = @authToken
|
2076
|
+
end
|
2077
|
+
|
2078
|
+
api_instance = PureCloud::ConversationsApi.new
|
2079
|
+
|
2080
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
2081
|
+
|
2082
|
+
message_id = "message_id_example" # String | messageId
|
2083
|
+
|
2084
|
+
|
2085
|
+
begin
|
2086
|
+
#Get a web chat conversation message
|
2087
|
+
result = api_instance.get_conversations_chat_message(conversation_id, message_id)
|
2088
|
+
p result
|
2089
|
+
rescue PureCloud::ApiError => e
|
2090
|
+
puts "Exception when calling ConversationsApi->get_conversations_chat_message: #{e}"
|
2091
|
+
end
|
2092
|
+
```
|
2093
|
+
|
2094
|
+
### Parameters
|
2095
|
+
|
2096
|
+
Name | Type | Description | Notes
|
2097
|
+
------------- | ------------- | ------------- | -------------
|
2098
|
+
**conversation_id** | **String**| conversationId | |
|
2099
|
+
**message_id** | **String**| messageId | |
|
2100
|
+
{: class="table table-striped"}
|
2101
|
+
|
2102
|
+
|
2103
|
+
### Return type
|
2104
|
+
|
2105
|
+
[**WebChatMessage**](WebChatMessage.html)
|
2106
|
+
|
2107
|
+
### HTTP request headers
|
2108
|
+
|
2109
|
+
- **Content-Type**: application/json
|
2110
|
+
- **Accept**: application/json
|
2111
|
+
|
2112
|
+
|
2113
|
+
|
2114
|
+
<a name="get_conversations_chat_messages"></a>
|
2115
|
+
|
2116
|
+
## [**WebChatMessageEntityList**](WebChatMessageEntityList.html) get_conversations_chat_messages(conversation_id, opts)
|
2117
|
+
|
2118
|
+
|
2119
|
+
|
2120
|
+
Get the messages of a chat conversation.
|
2121
|
+
|
2122
|
+
The current user must be involved with the conversation to get its messages.
|
2123
|
+
|
2124
|
+
Wraps GET /api/v2/conversations/chats/{conversationId}/messages
|
2125
|
+
|
2126
|
+
Requires NO permissions:
|
2127
|
+
|
2128
|
+
|
2129
|
+
|
2130
|
+
### Example
|
2131
|
+
```{"language":"ruby"}
|
2132
|
+
# load the gem
|
2133
|
+
require 'purecloudplatformclientv2'
|
2134
|
+
# setup authorization
|
2135
|
+
@secret = ENV['PURECLOUD_SECRET']
|
2136
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
2137
|
+
environment = "mypurecloud.com"
|
2138
|
+
|
2139
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
2140
|
+
|
2141
|
+
PureCloud.configure do |config|
|
2142
|
+
config.access_token = @authToken
|
2143
|
+
end
|
2144
|
+
|
2145
|
+
api_instance = PureCloud::ConversationsApi.new
|
2146
|
+
|
2147
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
2148
|
+
|
2149
|
+
opts = {
|
2150
|
+
after: "after_example", # String | If specified, get the messages chronologically after the id of this message
|
2151
|
+
before: "before_example", # String | If specified, get the messages chronologically before the id of this message
|
2152
|
+
sort_order: "ascending", # String | Sort order
|
2153
|
+
max_results: 100 # Integer | Limit the returned number of messages, up to a maximum of 100
|
2154
|
+
}
|
2155
|
+
|
2156
|
+
begin
|
2157
|
+
#Get the messages of a chat conversation.
|
2158
|
+
result = api_instance.get_conversations_chat_messages(conversation_id, opts)
|
2159
|
+
p result
|
2160
|
+
rescue PureCloud::ApiError => e
|
2161
|
+
puts "Exception when calling ConversationsApi->get_conversations_chat_messages: #{e}"
|
2162
|
+
end
|
2163
|
+
```
|
2164
|
+
|
2165
|
+
### Parameters
|
2166
|
+
|
2167
|
+
Name | Type | Description | Notes
|
2168
|
+
------------- | ------------- | ------------- | -------------
|
2169
|
+
**conversation_id** | **String**| conversationId | |
|
2170
|
+
**after** | **String**| If specified, get the messages chronologically after the id of this message | [optional] |
|
2171
|
+
**before** | **String**| If specified, get the messages chronologically before the id of this message | [optional] |
|
2172
|
+
**sort_order** | **String**| Sort order | [optional] [default to ascending]<br />**Values**: ascending, descending |
|
2173
|
+
**max_results** | **Integer**| Limit the returned number of messages, up to a maximum of 100 | [optional] [default to 100] |
|
2174
|
+
{: class="table table-striped"}
|
2175
|
+
|
2176
|
+
|
2177
|
+
### Return type
|
2178
|
+
|
2179
|
+
[**WebChatMessageEntityList**](WebChatMessageEntityList.html)
|
2180
|
+
|
2181
|
+
### HTTP request headers
|
2182
|
+
|
2183
|
+
- **Content-Type**: application/json
|
2184
|
+
- **Accept**: application/json
|
2185
|
+
|
2186
|
+
|
2187
|
+
|
2043
2188
|
<a name="get_conversations_chat_participant_wrapup"></a>
|
2044
2189
|
|
2045
2190
|
## [**AssignedWrapupCode**](AssignedWrapupCode.html) get_conversations_chat_participant_wrapup(conversation_id, participant_id, opts)
|
@@ -6045,7 +6190,7 @@ Name | Type | Description | Notes
|
|
6045
6190
|
|
6046
6191
|
<a name="post_analytics_conversations_aggregates_query"></a>
|
6047
6192
|
|
6048
|
-
## [**
|
6193
|
+
## [**ConversationAggregateQueryResponse**](ConversationAggregateQueryResponse.html) post_analytics_conversations_aggregates_query(body)
|
6049
6194
|
|
6050
6195
|
|
6051
6196
|
|
@@ -6077,7 +6222,7 @@ end
|
|
6077
6222
|
|
6078
6223
|
api_instance = PureCloud::ConversationsApi.new
|
6079
6224
|
|
6080
|
-
body = PureCloud::
|
6225
|
+
body = PureCloud::ConversationAggregationQuery.new # ConversationAggregationQuery | query
|
6081
6226
|
|
6082
6227
|
|
6083
6228
|
begin
|
@@ -6093,13 +6238,13 @@ end
|
|
6093
6238
|
|
6094
6239
|
Name | Type | Description | Notes
|
6095
6240
|
------------- | ------------- | ------------- | -------------
|
6096
|
-
**body** | [**
|
6241
|
+
**body** | [**ConversationAggregationQuery**](ConversationAggregationQuery.html)| query | |
|
6097
6242
|
{: class="table table-striped"}
|
6098
6243
|
|
6099
6244
|
|
6100
6245
|
### Return type
|
6101
6246
|
|
6102
|
-
[**
|
6247
|
+
[**ConversationAggregateQueryResponse**](ConversationAggregateQueryResponse.html)
|
6103
6248
|
|
6104
6249
|
### HTTP request headers
|
6105
6250
|
|
@@ -7123,6 +7268,143 @@ Name | Type | Description | Notes
|
|
7123
7268
|
|
7124
7269
|
|
7125
7270
|
|
7271
|
+
<a name="post_conversations_chat_communication_messages"></a>
|
7272
|
+
|
7273
|
+
## [**WebChatMessage**](WebChatMessage.html) post_conversations_chat_communication_messages(conversation_id, communication_id, body)
|
7274
|
+
|
7275
|
+
|
7276
|
+
|
7277
|
+
Send a message on behalf of a communication in a chat conversation.
|
7278
|
+
|
7279
|
+
|
7280
|
+
|
7281
|
+
Wraps POST /api/v2/conversations/chats/{conversationId}/communications/{communicationId}/messages
|
7282
|
+
|
7283
|
+
Requires NO permissions:
|
7284
|
+
|
7285
|
+
|
7286
|
+
|
7287
|
+
### Example
|
7288
|
+
```{"language":"ruby"}
|
7289
|
+
# load the gem
|
7290
|
+
require 'purecloudplatformclientv2'
|
7291
|
+
# setup authorization
|
7292
|
+
@secret = ENV['PURECLOUD_SECRET']
|
7293
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
7294
|
+
environment = "mypurecloud.com"
|
7295
|
+
|
7296
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
7297
|
+
|
7298
|
+
PureCloud.configure do |config|
|
7299
|
+
config.access_token = @authToken
|
7300
|
+
end
|
7301
|
+
|
7302
|
+
api_instance = PureCloud::ConversationsApi.new
|
7303
|
+
|
7304
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
7305
|
+
|
7306
|
+
communication_id = "communication_id_example" # String | communicationId
|
7307
|
+
|
7308
|
+
body = PureCloud::CreateWebChatMessageRequest.new # CreateWebChatMessageRequest | Message
|
7309
|
+
|
7310
|
+
|
7311
|
+
begin
|
7312
|
+
#Send a message on behalf of a communication in a chat conversation.
|
7313
|
+
result = api_instance.post_conversations_chat_communication_messages(conversation_id, communication_id, body)
|
7314
|
+
p result
|
7315
|
+
rescue PureCloud::ApiError => e
|
7316
|
+
puts "Exception when calling ConversationsApi->post_conversations_chat_communication_messages: #{e}"
|
7317
|
+
end
|
7318
|
+
```
|
7319
|
+
|
7320
|
+
### Parameters
|
7321
|
+
|
7322
|
+
Name | Type | Description | Notes
|
7323
|
+
------------- | ------------- | ------------- | -------------
|
7324
|
+
**conversation_id** | **String**| conversationId | |
|
7325
|
+
**communication_id** | **String**| communicationId | |
|
7326
|
+
**body** | [**CreateWebChatMessageRequest**](CreateWebChatMessageRequest.html)| Message | |
|
7327
|
+
{: class="table table-striped"}
|
7328
|
+
|
7329
|
+
|
7330
|
+
### Return type
|
7331
|
+
|
7332
|
+
[**WebChatMessage**](WebChatMessage.html)
|
7333
|
+
|
7334
|
+
### HTTP request headers
|
7335
|
+
|
7336
|
+
- **Content-Type**: application/json
|
7337
|
+
- **Accept**: application/json
|
7338
|
+
|
7339
|
+
|
7340
|
+
|
7341
|
+
<a name="post_conversations_chat_communication_typing"></a>
|
7342
|
+
|
7343
|
+
## [**WebChatTyping**](WebChatTyping.html) post_conversations_chat_communication_typing(conversation_id, communication_id)
|
7344
|
+
|
7345
|
+
|
7346
|
+
|
7347
|
+
Send a typing-indicator on behalf of a communication in a chat conversation.
|
7348
|
+
|
7349
|
+
|
7350
|
+
|
7351
|
+
Wraps POST /api/v2/conversations/chats/{conversationId}/communications/{communicationId}/typing
|
7352
|
+
|
7353
|
+
Requires NO permissions:
|
7354
|
+
|
7355
|
+
|
7356
|
+
|
7357
|
+
### Example
|
7358
|
+
```{"language":"ruby"}
|
7359
|
+
# load the gem
|
7360
|
+
require 'purecloudplatformclientv2'
|
7361
|
+
# setup authorization
|
7362
|
+
@secret = ENV['PURECLOUD_SECRET']
|
7363
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
7364
|
+
environment = "mypurecloud.com"
|
7365
|
+
|
7366
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
7367
|
+
|
7368
|
+
PureCloud.configure do |config|
|
7369
|
+
config.access_token = @authToken
|
7370
|
+
end
|
7371
|
+
|
7372
|
+
api_instance = PureCloud::ConversationsApi.new
|
7373
|
+
|
7374
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
7375
|
+
|
7376
|
+
communication_id = "communication_id_example" # String | communicationId
|
7377
|
+
|
7378
|
+
|
7379
|
+
begin
|
7380
|
+
#Send a typing-indicator on behalf of a communication in a chat conversation.
|
7381
|
+
result = api_instance.post_conversations_chat_communication_typing(conversation_id, communication_id)
|
7382
|
+
p result
|
7383
|
+
rescue PureCloud::ApiError => e
|
7384
|
+
puts "Exception when calling ConversationsApi->post_conversations_chat_communication_typing: #{e}"
|
7385
|
+
end
|
7386
|
+
```
|
7387
|
+
|
7388
|
+
### Parameters
|
7389
|
+
|
7390
|
+
Name | Type | Description | Notes
|
7391
|
+
------------- | ------------- | ------------- | -------------
|
7392
|
+
**conversation_id** | **String**| conversationId | |
|
7393
|
+
**communication_id** | **String**| communicationId | |
|
7394
|
+
{: class="table table-striped"}
|
7395
|
+
|
7396
|
+
|
7397
|
+
### Return type
|
7398
|
+
|
7399
|
+
[**WebChatTyping**](WebChatTyping.html)
|
7400
|
+
|
7401
|
+
### HTTP request headers
|
7402
|
+
|
7403
|
+
- **Content-Type**: application/json
|
7404
|
+
- **Accept**: application/json
|
7405
|
+
|
7406
|
+
|
7407
|
+
|
7126
7408
|
<a name="post_conversations_chat_participant_replace"></a>
|
7127
7409
|
|
7128
7410
|
## post_conversations_chat_participant_replace(conversation_id, participant_id, body)
|