purecloudplatformclientv2 62.0.0 → 66.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 +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
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: PresenceDetailQueryPredicate
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::PresenceDetailQueryPredicate
|
|
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
|
+
|
data/docs/QualityApi.md
CHANGED
|
@@ -2695,7 +2695,7 @@ Name | Type | Description | Notes
|
|
|
2695
2695
|
|
|
2696
2696
|
<a name="post_analytics_evaluations_aggregates_query"></a>
|
|
2697
2697
|
|
|
2698
|
-
## [**
|
|
2698
|
+
## [**EvaluationAggregateQueryResponse**](EvaluationAggregateQueryResponse.html) post_analytics_evaluations_aggregates_query(body)
|
|
2699
2699
|
|
|
2700
2700
|
|
|
2701
2701
|
|
|
@@ -2727,7 +2727,7 @@ end
|
|
|
2727
2727
|
|
|
2728
2728
|
api_instance = PureCloud::QualityApi.new
|
|
2729
2729
|
|
|
2730
|
-
body = PureCloud::
|
|
2730
|
+
body = PureCloud::EvaluationAggregationQuery.new # EvaluationAggregationQuery | query
|
|
2731
2731
|
|
|
2732
2732
|
|
|
2733
2733
|
begin
|
|
@@ -2743,13 +2743,13 @@ end
|
|
|
2743
2743
|
|
|
2744
2744
|
Name | Type | Description | Notes
|
|
2745
2745
|
------------- | ------------- | ------------- | -------------
|
|
2746
|
-
**body** | [**
|
|
2746
|
+
**body** | [**EvaluationAggregationQuery**](EvaluationAggregationQuery.html)| query | |
|
|
2747
2747
|
{: class="table table-striped"}
|
|
2748
2748
|
|
|
2749
2749
|
|
|
2750
2750
|
### Return type
|
|
2751
2751
|
|
|
2752
|
-
[**
|
|
2752
|
+
[**EvaluationAggregateQueryResponse**](EvaluationAggregateQueryResponse.html)
|
|
2753
2753
|
|
|
2754
2754
|
### HTTP request headers
|
|
2755
2755
|
|
|
@@ -2760,7 +2760,7 @@ Name | Type | Description | Notes
|
|
|
2760
2760
|
|
|
2761
2761
|
<a name="post_analytics_surveys_aggregates_query"></a>
|
|
2762
2762
|
|
|
2763
|
-
## [**
|
|
2763
|
+
## [**SurveyAggregateQueryResponse**](SurveyAggregateQueryResponse.html) post_analytics_surveys_aggregates_query(body)
|
|
2764
2764
|
|
|
2765
2765
|
|
|
2766
2766
|
|
|
@@ -2792,7 +2792,7 @@ end
|
|
|
2792
2792
|
|
|
2793
2793
|
api_instance = PureCloud::QualityApi.new
|
|
2794
2794
|
|
|
2795
|
-
body = PureCloud::
|
|
2795
|
+
body = PureCloud::SurveyAggregationQuery.new # SurveyAggregationQuery | query
|
|
2796
2796
|
|
|
2797
2797
|
|
|
2798
2798
|
begin
|
|
@@ -2808,13 +2808,13 @@ end
|
|
|
2808
2808
|
|
|
2809
2809
|
Name | Type | Description | Notes
|
|
2810
2810
|
------------- | ------------- | ------------- | -------------
|
|
2811
|
-
**body** | [**
|
|
2811
|
+
**body** | [**SurveyAggregationQuery**](SurveyAggregationQuery.html)| query | |
|
|
2812
2812
|
{: class="table table-striped"}
|
|
2813
2813
|
|
|
2814
2814
|
|
|
2815
2815
|
### Return type
|
|
2816
2816
|
|
|
2817
|
-
[**
|
|
2817
|
+
[**SurveyAggregateQueryResponse**](SurveyAggregateQueryResponse.html)
|
|
2818
2818
|
|
|
2819
2819
|
### HTTP request headers
|
|
2820
2820
|
|
|
@@ -7,9 +7,9 @@ title: QueueMediaAssociation
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | The reference ID for this QueueMediaAssociation | [optional] |
|
|
10
11
|
| **queue** | [**QueueReference**](QueueReference.html) | The queue to associate with the service goal group | [optional] |
|
|
11
12
|
| **media_types** | **Array<String>** | The media types of the given queue to associate with the service goal group | [optional] |
|
|
12
|
-
| **id** | **String** | The reference ID for this QueueMediaAssociation | [optional] |
|
|
13
13
|
| **delete** | **BOOLEAN** | If marked true on a PATCH, this QueueMediaAssociation will be permanently deleted | [optional] |
|
|
14
14
|
{: class="table table-striped"}
|
|
15
15
|
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: QueueObservationDataContainer
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::QueueObservationDataContainer
|
|
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<ObservationMetricData>**](ObservationMetricData.html) | | [optional] |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: QueueObservationQuery
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::QueueObservationQuery
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **filter** | [**QueueObservationQueryFilter**](QueueObservationQueryFilter.html) | Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters | |
|
|
11
|
+
| **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] |
|
|
12
|
+
| **detail_metrics** | **Array<String>** | Metrics for which to include additional detailed observations | [optional] |
|
|
13
|
+
{: class="table table-striped"}
|
|
14
|
+
|
|
15
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: QueueObservationQueryClause
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::QueueObservationQueryClause
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **type** | **String** | Boolean operation to apply to the provided predicates | |
|
|
11
|
+
| **predicates** | [**Array<QueueObservationQueryPredicate>**](QueueObservationQueryPredicate.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: QueueObservationQueryFilter
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::QueueObservationQueryFilter
|
|
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<QueueObservationQueryClause>**](QueueObservationQueryClause.html) | Boolean 'and/or' logic with up to two-levels of nesting | [optional] |
|
|
12
|
+
| **predicates** | [**Array<QueueObservationQueryPredicate>**](QueueObservationQueryPredicate.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: QueueObservationQueryPredicate
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::QueueObservationQueryPredicate
|
|
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
|
+
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
---
|
|
2
|
-
title:
|
|
2
|
+
title: QueueObservationQueryResponse
|
|
3
3
|
---
|
|
4
|
-
## PureCloud::
|
|
4
|
+
## PureCloud::QueueObservationQueryResponse
|
|
5
5
|
|
|
6
6
|
## Properties
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **system_to_organization_mappings** | **Hash<String, Array<String>>** | A mapping from system presence to a list of organization presence ids | [optional] |
|
|
11
|
-
| **results** | [**Array<
|
|
11
|
+
| **results** | [**Array<QueueObservationDataContainer>**](QueueObservationDataContainer.html) | | [optional] |
|
|
12
12
|
{: class="table table-striped"}
|
|
13
13
|
|
|
14
14
|
|
data/docs/Recording.md
CHANGED
|
@@ -11,8 +11,8 @@ title: Recording
|
|
|
11
11
|
| **name** | **String** | | [optional] |
|
|
12
12
|
| **conversation_id** | **String** | | [optional] |
|
|
13
13
|
| **path** | **String** | | [optional] |
|
|
14
|
-
| **start_time** | **String** |
|
|
15
|
-
| **end_time** | **String** |
|
|
14
|
+
| **start_time** | **String** | The start time of the recording. Null when there is no playable media. | [optional] |
|
|
15
|
+
| **end_time** | **String** | The end time of the recording. Null when there is no playable media. | [optional] |
|
|
16
16
|
| **media** | **String** | The type of media that the recording is. At the moment that could be audio, chat, or email. | [optional] |
|
|
17
17
|
| **annotations** | [**Array<Annotation>**](Annotation.html) | Annotations that belong to the recording. | [optional] |
|
|
18
18
|
| **transcript** | [**Array<ChatMessage>**](ChatMessage.html) | Represents a chat transcript | [optional] |
|
|
@@ -20,14 +20,15 @@ title: Recording
|
|
|
20
20
|
| **messaging_transcript** | [**Array<RecordingMessagingMessage>**](RecordingMessagingMessage.html) | Represents a messaging transcript | [optional] |
|
|
21
21
|
| **file_state** | **String** | Represents the current file state for a recording. Examples: Uploading, Archived, etc | [optional] |
|
|
22
22
|
| **restore_expiration_time** | **DateTime** | The amount of time a restored recording will remain restored before being archived again. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
23
|
-
| **media_uris** | [**Hash<String, MediaResult>**](MediaResult.html) | The different mediaUris for the recording. | [optional] |
|
|
23
|
+
| **media_uris** | [**Hash<String, MediaResult>**](MediaResult.html) | The different mediaUris for the recording. Null when there is no playable media. | [optional] |
|
|
24
24
|
| **estimated_transcode_time_ms** | **Integer** | | [optional] |
|
|
25
25
|
| **actual_transcode_time_ms** | **Integer** | | [optional] |
|
|
26
26
|
| **archive_date** | **DateTime** | The date the recording will be archived. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
27
27
|
| **archive_medium** | **String** | The type of archive medium used. Example: CloudArchive | [optional] |
|
|
28
28
|
| **delete_date** | **DateTime** | The date the recording will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
29
|
+
| **export_date** | **DateTime** | The date the recording will be exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
29
30
|
| **output_duration_ms** | **Integer** | Duration of transcoded media in milliseconds | [optional] |
|
|
30
|
-
| **output_size_in_bytes** | **Integer** | Size of transcoded media in bytes | [optional] |
|
|
31
|
+
| **output_size_in_bytes** | **Integer** | Size of transcoded media in bytes. 0 if there is no transcoded media. | [optional] |
|
|
31
32
|
| **max_allowed_restorations_for_org** | **Integer** | How many archive restorations the organization is allowed to have. | [optional] |
|
|
32
33
|
| **remaining_restorations_allowed_for_org** | **Integer** | The remaining archive restorations the organization has. | [optional] |
|
|
33
34
|
| **session_id** | **String** | The session id represents an external resource id, such as email, call, chat, etc | [optional] |
|
data/docs/RecordingApi.md
CHANGED
|
@@ -656,7 +656,7 @@ Name | Type | Description | Notes
|
|
|
656
656
|
|
|
657
657
|
<a name="get_conversation_recordingmetadata_recording_id"></a>
|
|
658
658
|
|
|
659
|
-
## [**
|
|
659
|
+
## [**RecordingMetadata**](RecordingMetadata.html) get_conversation_recordingmetadata_recording_id(conversation_id, recording_id)
|
|
660
660
|
|
|
661
661
|
|
|
662
662
|
|
|
@@ -712,7 +712,7 @@ Name | Type | Description | Notes
|
|
|
712
712
|
|
|
713
713
|
### Return type
|
|
714
714
|
|
|
715
|
-
[**
|
|
715
|
+
[**RecordingMetadata**](RecordingMetadata.html)
|
|
716
716
|
|
|
717
717
|
### HTTP request headers
|
|
718
718
|
|
data/docs/RecordingJob.md
CHANGED
|
@@ -17,6 +17,7 @@ title: RecordingJob
|
|
|
17
17
|
| **percent_progress** | **Integer** | Progress in percentage based on the number of recordings | [optional] |
|
|
18
18
|
| **error_message** | **String** | Error occurred during the job execution | [optional] |
|
|
19
19
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
20
|
+
| **user** | [**AddressableEntityRef**](AddressableEntityRef.html) | Details of the user created the job | [optional] |
|
|
20
21
|
{: class="table table-striped"}
|
|
21
22
|
|
|
22
23
|
|
data/docs/RecordingJobsQuery.md
CHANGED
|
@@ -8,8 +8,8 @@ title: RecordingJobsQuery
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **action** | **String** | Operation to perform bulk task | |
|
|
11
|
-
| **action_date** | **DateTime** | The date when the action will be performed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
|
|
12
|
-
| **integration_id** | **String** |
|
|
11
|
+
| **action_date** | **DateTime** | The date when the action will be performed. If the operation will cause the delete date of a recording to be older than the export date, the export date will be adjusted to the delete date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
|
|
12
|
+
| **integration_id** | **String** | IntegrationId to Access AWS S3 bucket for bulk recording exports. This field is for EXPORT only | [optional] |
|
|
13
13
|
| **include_screen_recordings** | **BOOLEAN** | Include Screen recordings for export action, default value = true | [optional] |
|
|
14
14
|
| **conversation_query** | [**AsyncConversationQuery**](AsyncConversationQuery.html) | Conversation Query. Note: After the recording is created, it might take up to 48 hours for the recording to be included in the submitted job query. | |
|
|
15
15
|
{: class="table table-striped"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: RecordingMetadata
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::RecordingMetadata
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
|
+
| **name** | **String** | | [optional] |
|
|
12
|
+
| **conversation_id** | **String** | | [optional] |
|
|
13
|
+
| **path** | **String** | | [optional] |
|
|
14
|
+
| **start_time** | **String** | The start time of the recording for screen recordings. Null for other types. | [optional] |
|
|
15
|
+
| **end_time** | **String** | | [optional] |
|
|
16
|
+
| **media** | **String** | The type of media that the recording is. At the moment that could be audio, chat, email, or message. | [optional] |
|
|
17
|
+
| **annotations** | [**Array<Annotation>**](Annotation.html) | Annotations that belong to the recording. Populated when recording filestate is AVAILABLE. | [optional] |
|
|
18
|
+
| **file_state** | **String** | Represents the current file state for a recording. Examples: Uploading, Archived, etc | [optional] |
|
|
19
|
+
| **restore_expiration_time** | **DateTime** | The amount of time a restored recording will remain restored before being archived again. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
20
|
+
| **archive_date** | **DateTime** | The date the recording will be archived. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
21
|
+
| **archive_medium** | **String** | The type of archive medium used. Example: CloudArchive | [optional] |
|
|
22
|
+
| **delete_date** | **DateTime** | The date the recording will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
23
|
+
| **export_date** | **DateTime** | The date the recording will be exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
24
|
+
| **max_allowed_restorations_for_org** | **Integer** | How many archive restorations the organization is allowed to have. | [optional] |
|
|
25
|
+
| **remaining_restorations_allowed_for_org** | **Integer** | The remaining archive restorations the organization has. | [optional] |
|
|
26
|
+
| **session_id** | **String** | The session id represents an external resource id, such as email, call, chat, etc | [optional] |
|
|
27
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
28
|
+
{: class="table table-striped"}
|
|
29
|
+
|
|
30
|
+
|
|
@@ -16,6 +16,8 @@ title: ReportingExportJobRequest
|
|
|
16
16
|
| **filter** | [**ViewFilter**](ViewFilter.html) | Filters to apply to create the view | |
|
|
17
17
|
| **read** | **BOOLEAN** | Indicates if the request has been marked as read | [optional] |
|
|
18
18
|
| **locale** | **String** | The locale use for localization of the exported data, i.e. en-us, es-mx | |
|
|
19
|
+
| **has_format_durations** | **BOOLEAN** | Indicates if durations are formatted in hh:mm:ss format instead of ms | [optional] |
|
|
20
|
+
| **has_split_filters** | **BOOLEAN** | Indicates if filters will be split in aggregate detail exports | [optional] |
|
|
19
21
|
{: class="table table-striped"}
|
|
20
22
|
|
|
21
23
|
|
|
@@ -23,6 +23,8 @@ title: ReportingExportJobResponse
|
|
|
23
23
|
| **modified_date_time** | **DateTime** | The last modified date/time of the request. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
|
|
24
24
|
| **locale** | **String** | The locale use for localization of the exported data, i.e. en-us, es-mx | |
|
|
25
25
|
| **percentage_complete** | **Float** | The percentage of the job that has completed processing | |
|
|
26
|
+
| **has_format_durations** | **BOOLEAN** | Indicates if durations are formatted in hh:mm:ss format instead of ms | [optional] |
|
|
27
|
+
| **has_split_filters** | **BOOLEAN** | Indicates if filters will be split in aggregate detail exports | [optional] |
|
|
26
28
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
27
29
|
{: class="table table-striped"}
|
|
28
30
|
|
data/docs/RoutingApi.md
CHANGED
|
@@ -3167,7 +3167,7 @@ Name | Type | Description | Notes
|
|
|
3167
3167
|
|
|
3168
3168
|
<a name="post_analytics_queues_observations_query"></a>
|
|
3169
3169
|
|
|
3170
|
-
## [**
|
|
3170
|
+
## [**QueueObservationQueryResponse**](QueueObservationQueryResponse.html) post_analytics_queues_observations_query(body)
|
|
3171
3171
|
|
|
3172
3172
|
|
|
3173
3173
|
|
|
@@ -3199,7 +3199,7 @@ end
|
|
|
3199
3199
|
|
|
3200
3200
|
api_instance = PureCloud::RoutingApi.new
|
|
3201
3201
|
|
|
3202
|
-
body = PureCloud::
|
|
3202
|
+
body = PureCloud::QueueObservationQuery.new # QueueObservationQuery | query
|
|
3203
3203
|
|
|
3204
3204
|
|
|
3205
3205
|
begin
|
|
@@ -3215,13 +3215,13 @@ end
|
|
|
3215
3215
|
|
|
3216
3216
|
Name | Type | Description | Notes
|
|
3217
3217
|
------------- | ------------- | ------------- | -------------
|
|
3218
|
-
**body** | [**
|
|
3218
|
+
**body** | [**QueueObservationQuery**](QueueObservationQuery.html)| query | |
|
|
3219
3219
|
{: class="table table-striped"}
|
|
3220
3220
|
|
|
3221
3221
|
|
|
3222
3222
|
### Return type
|
|
3223
3223
|
|
|
3224
|
-
[**
|
|
3224
|
+
[**QueueObservationQueryResponse**](QueueObservationQueryResponse.html)
|
|
3225
3225
|
|
|
3226
3226
|
### HTTP request headers
|
|
3227
3227
|
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: RoutingStatusDetailQueryClause
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::RoutingStatusDetailQueryClause
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **type** | **String** | Boolean operation to apply to the provided predicates | |
|
|
11
|
+
| **predicates** | [**Array<RoutingStatusDetailQueryPredicate>**](RoutingStatusDetailQueryPredicate.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: RoutingStatusDetailQueryFilter
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::RoutingStatusDetailQueryFilter
|
|
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<RoutingStatusDetailQueryClause>**](RoutingStatusDetailQueryClause.html) | Boolean 'and/or' logic with up to two-levels of nesting | [optional] |
|
|
12
|
+
| **predicates** | [**Array<RoutingStatusDetailQueryPredicate>**](RoutingStatusDetailQueryPredicate.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: RoutingStatusDetailQueryPredicate
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::RoutingStatusDetailQueryPredicate
|
|
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
|
+
|
data/docs/SCIMApi.md
CHANGED
|
@@ -12,11 +12,16 @@ Method | Description
|
|
|
12
12
|
[**delete_scim_v2_user**](SCIMApi.html#delete_scim_v2_user) | Delete a user
|
|
13
13
|
[**get_scim_group**](SCIMApi.html#get_scim_group) | Get a group
|
|
14
14
|
[**get_scim_groups**](SCIMApi.html#get_scim_groups) | Get a list of groups
|
|
15
|
+
[**get_scim_resourcetype**](SCIMApi.html#get_scim_resourcetype) | Get a resource type
|
|
16
|
+
[**get_scim_resourcetypes**](SCIMApi.html#get_scim_resourcetypes) | Get a list of resource types
|
|
17
|
+
[**get_scim_serviceproviderconfig**](SCIMApi.html#get_scim_serviceproviderconfig) | Get a service provider's configuration
|
|
15
18
|
[**get_scim_user**](SCIMApi.html#get_scim_user) | Get a user
|
|
16
19
|
[**get_scim_users**](SCIMApi.html#get_scim_users) | Get a list of users
|
|
17
20
|
[**get_scim_v2_group**](SCIMApi.html#get_scim_v2_group) | Get a group
|
|
18
21
|
[**get_scim_v2_groups**](SCIMApi.html#get_scim_v2_groups) | Get a list of groups
|
|
19
|
-
[**
|
|
22
|
+
[**get_scim_v2_resourcetype**](SCIMApi.html#get_scim_v2_resourcetype) | Get a resource type
|
|
23
|
+
[**get_scim_v2_resourcetypes**](SCIMApi.html#get_scim_v2_resourcetypes) | Get a list of resource types
|
|
24
|
+
[**get_scim_v2_serviceproviderconfig**](SCIMApi.html#get_scim_v2_serviceproviderconfig) | Get a service provider's configuration
|
|
20
25
|
[**get_scim_v2_user**](SCIMApi.html#get_scim_v2_user) | Get a user
|
|
21
26
|
[**get_scim_v2_users**](SCIMApi.html#get_scim_v2_users) | Get a list of users
|
|
22
27
|
[**patch_scim_group**](SCIMApi.html#patch_scim_group) | Modify a group
|
|
@@ -68,7 +73,7 @@ api_instance = PureCloud::SCIMApi.new
|
|
|
68
73
|
user_id = "user_id_example" # String | The ID of a user. Returned with GET /api/v2/scim/users.
|
|
69
74
|
|
|
70
75
|
opts = {
|
|
71
|
-
if_match: "if_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\".
|
|
76
|
+
if_match: "if_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
72
77
|
}
|
|
73
78
|
|
|
74
79
|
begin
|
|
@@ -85,7 +90,7 @@ end
|
|
|
85
90
|
Name | Type | Description | Notes
|
|
86
91
|
------------- | ------------- | ------------- | -------------
|
|
87
92
|
**user_id** | **String**| The ID of a user. Returned with GET /api/v2/scim/users. | |
|
|
88
|
-
**if_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\". | [optional] |
|
|
93
|
+
**if_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". | [optional] |
|
|
89
94
|
{: class="table table-striped"}
|
|
90
95
|
|
|
91
96
|
|
|
@@ -137,7 +142,7 @@ api_instance = PureCloud::SCIMApi.new
|
|
|
137
142
|
user_id = "user_id_example" # String | The ID of a user. Returned with GET /api/v2/scim/v2/users.
|
|
138
143
|
|
|
139
144
|
opts = {
|
|
140
|
-
if_match: "if_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\".
|
|
145
|
+
if_match: "if_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
141
146
|
}
|
|
142
147
|
|
|
143
148
|
begin
|
|
@@ -154,7 +159,7 @@ end
|
|
|
154
159
|
Name | Type | Description | Notes
|
|
155
160
|
------------- | ------------- | ------------- | -------------
|
|
156
161
|
**user_id** | **String**| The ID of a user. Returned with GET /api/v2/scim/v2/users. | |
|
|
157
|
-
**if_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\". | [optional] |
|
|
162
|
+
**if_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". | [optional] |
|
|
158
163
|
{: class="table table-striped"}
|
|
159
164
|
|
|
160
165
|
|
|
@@ -274,7 +279,7 @@ api_instance = PureCloud::SCIMApi.new
|
|
|
274
279
|
|
|
275
280
|
opts = {
|
|
276
281
|
start_index: 1, # Integer | The 1-based index of the first query result.
|
|
277
|
-
count: 25, # Integer | The requested number of items per page. A value of 0 returns totalResults.
|
|
282
|
+
count: 25, # Integer | The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
278
283
|
filter: "displayName eq groupName" # String | Filters results.
|
|
279
284
|
}
|
|
280
285
|
|
|
@@ -292,7 +297,7 @@ end
|
|
|
292
297
|
Name | Type | Description | Notes
|
|
293
298
|
------------- | ------------- | ------------- | -------------
|
|
294
299
|
**start_index** | **Integer**| The 1-based index of the first query result. | [optional] [default to 1] |
|
|
295
|
-
**count** | **Integer**| The requested number of items per page. A value of 0 returns totalResults
|
|
300
|
+
**count** | **Integer**| The requested number of items per page. A value of 0 returns \"totalResults\". | [optional] [default to 25] |
|
|
296
301
|
**filter** | **String**| Filters results. | [optional] |
|
|
297
302
|
{: class="table table-striped"}
|
|
298
303
|
|
|
@@ -308,6 +313,163 @@ Name | Type | Description | Notes
|
|
|
308
313
|
|
|
309
314
|
|
|
310
315
|
|
|
316
|
+
<a name="get_scim_resourcetype"></a>
|
|
317
|
+
|
|
318
|
+
## [**ScimConfigResourceType**](ScimConfigResourceType.html) get_scim_resourcetype(resource_type)
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
Get a resource type
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
Wraps GET /api/v2/scim/resourcetypes/{resourceType}
|
|
327
|
+
|
|
328
|
+
Requires NO permissions:
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
### Example
|
|
333
|
+
```{"language":"ruby"}
|
|
334
|
+
# load the gem
|
|
335
|
+
require 'purecloudplatformclientv2'
|
|
336
|
+
|
|
337
|
+
api_instance = PureCloud::SCIMApi.new
|
|
338
|
+
|
|
339
|
+
resource_type = "resource_type_example" # String | The type of resource. Returned with GET /api/v2/scim/resourcetypes.
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
begin
|
|
343
|
+
#Get a resource type
|
|
344
|
+
result = api_instance.get_scim_resourcetype(resource_type)
|
|
345
|
+
p result
|
|
346
|
+
rescue PureCloud::ApiError => e
|
|
347
|
+
puts "Exception when calling SCIMApi->get_scim_resourcetype: #{e}"
|
|
348
|
+
end
|
|
349
|
+
```
|
|
350
|
+
|
|
351
|
+
### Parameters
|
|
352
|
+
|
|
353
|
+
Name | Type | Description | Notes
|
|
354
|
+
------------- | ------------- | ------------- | -------------
|
|
355
|
+
**resource_type** | **String**| The type of resource. Returned with GET /api/v2/scim/resourcetypes. | <br />**Values**: User, Group, ServiceProviderConfig, ResourceType |
|
|
356
|
+
{: class="table table-striped"}
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
### Return type
|
|
360
|
+
|
|
361
|
+
[**ScimConfigResourceType**](ScimConfigResourceType.html)
|
|
362
|
+
|
|
363
|
+
### HTTP request headers
|
|
364
|
+
|
|
365
|
+
- **Content-Type**: application/json, application/scim+json
|
|
366
|
+
- **Accept**: application/json, application/scim+json
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
<a name="get_scim_resourcetypes"></a>
|
|
371
|
+
|
|
372
|
+
## [**ScimConfigResourceTypesListResponse**](ScimConfigResourceTypesListResponse.html) get_scim_resourcetypes
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
Get a list of resource types
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
Wraps GET /api/v2/scim/resourcetypes
|
|
381
|
+
|
|
382
|
+
Requires NO permissions:
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
### Example
|
|
387
|
+
```{"language":"ruby"}
|
|
388
|
+
# load the gem
|
|
389
|
+
require 'purecloudplatformclientv2'
|
|
390
|
+
|
|
391
|
+
api_instance = PureCloud::SCIMApi.new
|
|
392
|
+
|
|
393
|
+
begin
|
|
394
|
+
#Get a list of resource types
|
|
395
|
+
result = api_instance.get_scim_resourcetypes
|
|
396
|
+
p result
|
|
397
|
+
rescue PureCloud::ApiError => e
|
|
398
|
+
puts "Exception when calling SCIMApi->get_scim_resourcetypes: #{e}"
|
|
399
|
+
end
|
|
400
|
+
```
|
|
401
|
+
|
|
402
|
+
### Parameters
|
|
403
|
+
This endpoint does not need any parameter.
|
|
404
|
+
{: class="table table-striped"}
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
### Return type
|
|
408
|
+
|
|
409
|
+
[**ScimConfigResourceTypesListResponse**](ScimConfigResourceTypesListResponse.html)
|
|
410
|
+
|
|
411
|
+
### HTTP request headers
|
|
412
|
+
|
|
413
|
+
- **Content-Type**: application/json, application/scim+json
|
|
414
|
+
- **Accept**: application/json, application/scim+json
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
<a name="get_scim_serviceproviderconfig"></a>
|
|
419
|
+
|
|
420
|
+
## [**ScimServiceProviderConfig**](ScimServiceProviderConfig.html) get_scim_serviceproviderconfig(opts)
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
Get a service provider's configuration
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
Wraps GET /api/v2/scim/serviceproviderconfig
|
|
429
|
+
|
|
430
|
+
Requires NO permissions:
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
### Example
|
|
435
|
+
```{"language":"ruby"}
|
|
436
|
+
# load the gem
|
|
437
|
+
require 'purecloudplatformclientv2'
|
|
438
|
+
|
|
439
|
+
api_instance = PureCloud::SCIMApi.new
|
|
440
|
+
|
|
441
|
+
opts = {
|
|
442
|
+
if_none_match: "if_none_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/serviceproviderconfig. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
|
|
443
|
+
}
|
|
444
|
+
|
|
445
|
+
begin
|
|
446
|
+
#Get a service provider's configuration
|
|
447
|
+
result = api_instance.get_scim_serviceproviderconfig(opts)
|
|
448
|
+
p result
|
|
449
|
+
rescue PureCloud::ApiError => e
|
|
450
|
+
puts "Exception when calling SCIMApi->get_scim_serviceproviderconfig: #{e}"
|
|
451
|
+
end
|
|
452
|
+
```
|
|
453
|
+
|
|
454
|
+
### Parameters
|
|
455
|
+
|
|
456
|
+
Name | Type | Description | Notes
|
|
457
|
+
------------- | ------------- | ------------- | -------------
|
|
458
|
+
**if_none_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/serviceproviderconfig. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. | [optional] |
|
|
459
|
+
{: class="table table-striped"}
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
### Return type
|
|
463
|
+
|
|
464
|
+
[**ScimServiceProviderConfig**](ScimServiceProviderConfig.html)
|
|
465
|
+
|
|
466
|
+
### HTTP request headers
|
|
467
|
+
|
|
468
|
+
- **Content-Type**: application/json, application/scim+json
|
|
469
|
+
- **Accept**: application/json, application/scim+json
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
|
|
311
473
|
<a name="get_scim_user"></a>
|
|
312
474
|
|
|
313
475
|
## [**ScimV2User**](ScimV2User.html) get_scim_user(user_id, opts)
|
|
@@ -417,7 +579,7 @@ filter = "filter_example" # String | Filters results.
|
|
|
417
579
|
|
|
418
580
|
opts = {
|
|
419
581
|
start_index: 1, # Integer | The 1-based index of the first query result.
|
|
420
|
-
count: 25 # Integer | The requested number of items per page. A value of 0 returns totalResults.
|
|
582
|
+
count: 25 # Integer | The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
421
583
|
}
|
|
422
584
|
|
|
423
585
|
begin
|
|
@@ -435,7 +597,7 @@ Name | Type | Description | Notes
|
|
|
435
597
|
------------- | ------------- | ------------- | -------------
|
|
436
598
|
**filter** | **String**| Filters results. | |
|
|
437
599
|
**start_index** | **Integer**| The 1-based index of the first query result. | [optional] [default to 1] |
|
|
438
|
-
**count** | **Integer**| The requested number of items per page. A value of 0 returns totalResults
|
|
600
|
+
**count** | **Integer**| The requested number of items per page. A value of 0 returns \"totalResults\". | [optional] [default to 25] |
|
|
439
601
|
{: class="table table-striped"}
|
|
440
602
|
|
|
441
603
|
|
|
@@ -557,7 +719,7 @@ filter = "displayName eq groupName" # String | Filters results.
|
|
|
557
719
|
|
|
558
720
|
opts = {
|
|
559
721
|
start_index: 1, # Integer | The 1-based index of the first query result.
|
|
560
|
-
count: 25 # Integer | The requested number of items per page. A value of 0 returns totalResults.
|
|
722
|
+
count: 25 # Integer | The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
561
723
|
}
|
|
562
724
|
|
|
563
725
|
begin
|
|
@@ -575,7 +737,7 @@ Name | Type | Description | Notes
|
|
|
575
737
|
------------- | ------------- | ------------- | -------------
|
|
576
738
|
**filter** | **String**| Filters results. | |
|
|
577
739
|
**start_index** | **Integer**| The 1-based index of the first query result. | [optional] [default to 1] |
|
|
578
|
-
**count** | **Integer**| The requested number of items per page. A value of 0 returns totalResults
|
|
740
|
+
**count** | **Integer**| The requested number of items per page. A value of 0 returns \"totalResults\". | [optional] [default to 25] |
|
|
579
741
|
{: class="table table-striped"}
|
|
580
742
|
|
|
581
743
|
|
|
@@ -590,13 +752,115 @@ Name | Type | Description | Notes
|
|
|
590
752
|
|
|
591
753
|
|
|
592
754
|
|
|
755
|
+
<a name="get_scim_v2_resourcetype"></a>
|
|
756
|
+
|
|
757
|
+
## [**ScimConfigResourceType**](ScimConfigResourceType.html) get_scim_v2_resourcetype(resource_type)
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
|
|
761
|
+
Get a resource type
|
|
762
|
+
|
|
763
|
+
|
|
764
|
+
|
|
765
|
+
Wraps GET /api/v2/scim/v2/resourcetypes/{resourceType}
|
|
766
|
+
|
|
767
|
+
Requires NO permissions:
|
|
768
|
+
|
|
769
|
+
|
|
770
|
+
|
|
771
|
+
### Example
|
|
772
|
+
```{"language":"ruby"}
|
|
773
|
+
# load the gem
|
|
774
|
+
require 'purecloudplatformclientv2'
|
|
775
|
+
|
|
776
|
+
api_instance = PureCloud::SCIMApi.new
|
|
777
|
+
|
|
778
|
+
resource_type = "resource_type_example" # String | The type of resource. Returned with GET /api/v2/scim/v2/resourcetypes.
|
|
779
|
+
|
|
780
|
+
|
|
781
|
+
begin
|
|
782
|
+
#Get a resource type
|
|
783
|
+
result = api_instance.get_scim_v2_resourcetype(resource_type)
|
|
784
|
+
p result
|
|
785
|
+
rescue PureCloud::ApiError => e
|
|
786
|
+
puts "Exception when calling SCIMApi->get_scim_v2_resourcetype: #{e}"
|
|
787
|
+
end
|
|
788
|
+
```
|
|
789
|
+
|
|
790
|
+
### Parameters
|
|
791
|
+
|
|
792
|
+
Name | Type | Description | Notes
|
|
793
|
+
------------- | ------------- | ------------- | -------------
|
|
794
|
+
**resource_type** | **String**| The type of resource. Returned with GET /api/v2/scim/v2/resourcetypes. | <br />**Values**: User, Group, ServiceProviderConfig, ResourceType |
|
|
795
|
+
{: class="table table-striped"}
|
|
796
|
+
|
|
797
|
+
|
|
798
|
+
### Return type
|
|
799
|
+
|
|
800
|
+
[**ScimConfigResourceType**](ScimConfigResourceType.html)
|
|
801
|
+
|
|
802
|
+
### HTTP request headers
|
|
803
|
+
|
|
804
|
+
- **Content-Type**: application/json, application/scim+json
|
|
805
|
+
- **Accept**: application/json, application/scim+json
|
|
806
|
+
|
|
807
|
+
|
|
808
|
+
|
|
809
|
+
<a name="get_scim_v2_resourcetypes"></a>
|
|
810
|
+
|
|
811
|
+
## [**ScimConfigResourceTypesListResponse**](ScimConfigResourceTypesListResponse.html) get_scim_v2_resourcetypes
|
|
812
|
+
|
|
813
|
+
|
|
814
|
+
|
|
815
|
+
Get a list of resource types
|
|
816
|
+
|
|
817
|
+
|
|
818
|
+
|
|
819
|
+
Wraps GET /api/v2/scim/v2/resourcetypes
|
|
820
|
+
|
|
821
|
+
Requires NO permissions:
|
|
822
|
+
|
|
823
|
+
|
|
824
|
+
|
|
825
|
+
### Example
|
|
826
|
+
```{"language":"ruby"}
|
|
827
|
+
# load the gem
|
|
828
|
+
require 'purecloudplatformclientv2'
|
|
829
|
+
|
|
830
|
+
api_instance = PureCloud::SCIMApi.new
|
|
831
|
+
|
|
832
|
+
begin
|
|
833
|
+
#Get a list of resource types
|
|
834
|
+
result = api_instance.get_scim_v2_resourcetypes
|
|
835
|
+
p result
|
|
836
|
+
rescue PureCloud::ApiError => e
|
|
837
|
+
puts "Exception when calling SCIMApi->get_scim_v2_resourcetypes: #{e}"
|
|
838
|
+
end
|
|
839
|
+
```
|
|
840
|
+
|
|
841
|
+
### Parameters
|
|
842
|
+
This endpoint does not need any parameter.
|
|
843
|
+
{: class="table table-striped"}
|
|
844
|
+
|
|
845
|
+
|
|
846
|
+
### Return type
|
|
847
|
+
|
|
848
|
+
[**ScimConfigResourceTypesListResponse**](ScimConfigResourceTypesListResponse.html)
|
|
849
|
+
|
|
850
|
+
### HTTP request headers
|
|
851
|
+
|
|
852
|
+
- **Content-Type**: application/json, application/scim+json
|
|
853
|
+
- **Accept**: application/json, application/scim+json
|
|
854
|
+
|
|
855
|
+
|
|
856
|
+
|
|
593
857
|
<a name="get_scim_v2_serviceproviderconfig"></a>
|
|
594
858
|
|
|
595
859
|
## [**ScimServiceProviderConfig**](ScimServiceProviderConfig.html) get_scim_v2_serviceproviderconfig(opts)
|
|
596
860
|
|
|
597
861
|
|
|
598
862
|
|
|
599
|
-
Get
|
|
863
|
+
Get a service provider's configuration
|
|
600
864
|
|
|
601
865
|
|
|
602
866
|
|
|
@@ -618,7 +882,7 @@ opts = {
|
|
|
618
882
|
}
|
|
619
883
|
|
|
620
884
|
begin
|
|
621
|
-
#Get
|
|
885
|
+
#Get a service provider's configuration
|
|
622
886
|
result = api_instance.get_scim_v2_serviceproviderconfig(opts)
|
|
623
887
|
p result
|
|
624
888
|
rescue PureCloud::ApiError => e
|
|
@@ -754,7 +1018,7 @@ filter = "filter_example" # String | Filters results.
|
|
|
754
1018
|
|
|
755
1019
|
opts = {
|
|
756
1020
|
start_index: 1, # Integer | The 1-based index of the first query result.
|
|
757
|
-
count: 25 # Integer | The requested number of items per page. A value of 0 returns totalResults.
|
|
1021
|
+
count: 25 # Integer | The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
758
1022
|
}
|
|
759
1023
|
|
|
760
1024
|
begin
|
|
@@ -772,7 +1036,7 @@ Name | Type | Description | Notes
|
|
|
772
1036
|
------------- | ------------- | ------------- | -------------
|
|
773
1037
|
**filter** | **String**| Filters results. | |
|
|
774
1038
|
**start_index** | **Integer**| The 1-based index of the first query result. | [optional] [default to 1] |
|
|
775
|
-
**count** | **Integer**| The requested number of items per page. A value of 0 returns totalResults
|
|
1039
|
+
**count** | **Integer**| The requested number of items per page. A value of 0 returns \"totalResults\". | [optional] [default to 25] |
|
|
776
1040
|
{: class="table table-striped"}
|
|
777
1041
|
|
|
778
1042
|
|
|
@@ -826,7 +1090,7 @@ group_id = "group_id_example" # String | The ID of a group. Returned with GET /a
|
|
|
826
1090
|
body = PureCloud::ScimV2PatchRequest.new # ScimV2PatchRequest | The information used to modify a group.
|
|
827
1091
|
|
|
828
1092
|
opts = {
|
|
829
|
-
if_match: "if_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\".
|
|
1093
|
+
if_match: "if_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
830
1094
|
}
|
|
831
1095
|
|
|
832
1096
|
begin
|
|
@@ -844,7 +1108,7 @@ Name | Type | Description | Notes
|
|
|
844
1108
|
------------- | ------------- | ------------- | -------------
|
|
845
1109
|
**group_id** | **String**| The ID of a group. Returned with GET /api/v2/scim/groups. | |
|
|
846
1110
|
**body** | [**ScimV2PatchRequest**](ScimV2PatchRequest.html)| The information used to modify a group. | |
|
|
847
|
-
**if_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\". | [optional] |
|
|
1111
|
+
**if_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". | [optional] |
|
|
848
1112
|
{: class="table table-striped"}
|
|
849
1113
|
|
|
850
1114
|
|
|
@@ -899,7 +1163,7 @@ user_id = "user_id_example" # String | The ID of a user. Returned with GET /api/
|
|
|
899
1163
|
body = PureCloud::ScimV2PatchRequest.new # ScimV2PatchRequest | The information used to modify a user.
|
|
900
1164
|
|
|
901
1165
|
opts = {
|
|
902
|
-
if_match: "if_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\".
|
|
1166
|
+
if_match: "if_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
903
1167
|
}
|
|
904
1168
|
|
|
905
1169
|
begin
|
|
@@ -917,7 +1181,7 @@ Name | Type | Description | Notes
|
|
|
917
1181
|
------------- | ------------- | ------------- | -------------
|
|
918
1182
|
**user_id** | **String**| The ID of a user. Returned with GET /api/v2/scim/users. | |
|
|
919
1183
|
**body** | [**ScimV2PatchRequest**](ScimV2PatchRequest.html)| The information used to modify a user. | |
|
|
920
|
-
**if_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\". | [optional] |
|
|
1184
|
+
**if_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". | [optional] |
|
|
921
1185
|
{: class="table table-striped"}
|
|
922
1186
|
|
|
923
1187
|
|
|
@@ -971,7 +1235,7 @@ group_id = "group_id_example" # String | The ID of a group. Returned with GET /a
|
|
|
971
1235
|
body = PureCloud::ScimV2PatchRequest.new # ScimV2PatchRequest | The information used to modify a group.
|
|
972
1236
|
|
|
973
1237
|
opts = {
|
|
974
|
-
if_match: "if_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\".
|
|
1238
|
+
if_match: "if_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
975
1239
|
}
|
|
976
1240
|
|
|
977
1241
|
begin
|
|
@@ -989,7 +1253,7 @@ Name | Type | Description | Notes
|
|
|
989
1253
|
------------- | ------------- | ------------- | -------------
|
|
990
1254
|
**group_id** | **String**| The ID of a group. Returned with GET /api/v2/scim/v2/groups. | |
|
|
991
1255
|
**body** | [**ScimV2PatchRequest**](ScimV2PatchRequest.html)| The information used to modify a group. | |
|
|
992
|
-
**if_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\". | [optional] |
|
|
1256
|
+
**if_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". | [optional] |
|
|
993
1257
|
{: class="table table-striped"}
|
|
994
1258
|
|
|
995
1259
|
|
|
@@ -1044,7 +1308,7 @@ user_id = "user_id_example" # String | The ID of a user. Returned with GET /api/
|
|
|
1044
1308
|
body = PureCloud::ScimV2PatchRequest.new # ScimV2PatchRequest | The information used to modify a user.
|
|
1045
1309
|
|
|
1046
1310
|
opts = {
|
|
1047
|
-
if_match: "if_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\".
|
|
1311
|
+
if_match: "if_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
1048
1312
|
}
|
|
1049
1313
|
|
|
1050
1314
|
begin
|
|
@@ -1062,7 +1326,7 @@ Name | Type | Description | Notes
|
|
|
1062
1326
|
------------- | ------------- | ------------- | -------------
|
|
1063
1327
|
**user_id** | **String**| The ID of a user. Returned with GET /api/v2/scim/v2/users. | |
|
|
1064
1328
|
**body** | [**ScimV2PatchRequest**](ScimV2PatchRequest.html)| The information used to modify a user. | |
|
|
1065
|
-
**if_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\". | [optional] |
|
|
1329
|
+
**if_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". | [optional] |
|
|
1066
1330
|
{: class="table table-striped"}
|
|
1067
1331
|
|
|
1068
1332
|
|
|
@@ -1246,7 +1510,7 @@ group_id = "group_id_example" # String | The ID of a group. Returned with GET /a
|
|
|
1246
1510
|
body = PureCloud::ScimV2Group.new # ScimV2Group | The information used to replace a group.
|
|
1247
1511
|
|
|
1248
1512
|
opts = {
|
|
1249
|
-
if_match: "if_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\".
|
|
1513
|
+
if_match: "if_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
1250
1514
|
}
|
|
1251
1515
|
|
|
1252
1516
|
begin
|
|
@@ -1264,7 +1528,7 @@ Name | Type | Description | Notes
|
|
|
1264
1528
|
------------- | ------------- | ------------- | -------------
|
|
1265
1529
|
**group_id** | **String**| The ID of a group. Returned with GET /api/v2/scim/groups. | |
|
|
1266
1530
|
**body** | [**ScimV2Group**](ScimV2Group.html)| The information used to replace a group. | |
|
|
1267
|
-
**if_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\". | [optional] |
|
|
1531
|
+
**if_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". | [optional] |
|
|
1268
1532
|
{: class="table table-striped"}
|
|
1269
1533
|
|
|
1270
1534
|
|
|
@@ -1319,7 +1583,7 @@ user_id = "user_id_example" # String | The ID of a user. Returned with GET /api/
|
|
|
1319
1583
|
body = PureCloud::ScimV2User.new # ScimV2User | The information used to replace a user.
|
|
1320
1584
|
|
|
1321
1585
|
opts = {
|
|
1322
|
-
if_match: "if_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\".
|
|
1586
|
+
if_match: "if_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
1323
1587
|
}
|
|
1324
1588
|
|
|
1325
1589
|
begin
|
|
@@ -1337,7 +1601,7 @@ Name | Type | Description | Notes
|
|
|
1337
1601
|
------------- | ------------- | ------------- | -------------
|
|
1338
1602
|
**user_id** | **String**| The ID of a user. Returned with GET /api/v2/scim/users. | |
|
|
1339
1603
|
**body** | [**ScimV2User**](ScimV2User.html)| The information used to replace a user. | |
|
|
1340
|
-
**if_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\". | [optional] |
|
|
1604
|
+
**if_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". | [optional] |
|
|
1341
1605
|
{: class="table table-striped"}
|
|
1342
1606
|
|
|
1343
1607
|
|
|
@@ -1391,7 +1655,7 @@ group_id = "group_id_example" # String | The ID of a group. Returned with GET /a
|
|
|
1391
1655
|
body = PureCloud::ScimV2Group.new # ScimV2Group | The information used to replace a group.
|
|
1392
1656
|
|
|
1393
1657
|
opts = {
|
|
1394
|
-
if_match: "if_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\".
|
|
1658
|
+
if_match: "if_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
1395
1659
|
}
|
|
1396
1660
|
|
|
1397
1661
|
begin
|
|
@@ -1409,7 +1673,7 @@ Name | Type | Description | Notes
|
|
|
1409
1673
|
------------- | ------------- | ------------- | -------------
|
|
1410
1674
|
**group_id** | **String**| The ID of a group. Returned with GET /api/v2/scim/v2/groups. | |
|
|
1411
1675
|
**body** | [**ScimV2Group**](ScimV2Group.html)| The information used to replace a group. | |
|
|
1412
|
-
**if_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\". | [optional] |
|
|
1676
|
+
**if_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". | [optional] |
|
|
1413
1677
|
{: class="table table-striped"}
|
|
1414
1678
|
|
|
1415
1679
|
|
|
@@ -1464,7 +1728,7 @@ user_id = "user_id_example" # String | The ID of a user. Returned with GET /api/
|
|
|
1464
1728
|
body = PureCloud::ScimV2User.new # ScimV2User | The information used to replace a user.
|
|
1465
1729
|
|
|
1466
1730
|
opts = {
|
|
1467
|
-
if_match: "if_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\".
|
|
1731
|
+
if_match: "if_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
1468
1732
|
}
|
|
1469
1733
|
|
|
1470
1734
|
begin
|
|
@@ -1482,7 +1746,7 @@ Name | Type | Description | Notes
|
|
|
1482
1746
|
------------- | ------------- | ------------- | -------------
|
|
1483
1747
|
**user_id** | **String**| The ID of a user. Returned with GET /api/v2/scim/v2/users. | |
|
|
1484
1748
|
**body** | [**ScimV2User**](ScimV2User.html)| The information used to replace a user. | |
|
|
1485
|
-
**if_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\". | [optional] |
|
|
1749
|
+
**if_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". | [optional] |
|
|
1486
1750
|
{: class="table table-striped"}
|
|
1487
1751
|
|
|
1488
1752
|
|