purecloud 0.52.1 → 0.53.1
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 +3 -3
- data/bin/notificationMappings.json +8 -0
- data/config-ruby.json +1 -1
- data/doc_out/AgentActivityEntityListing.html.md +1 -1
- data/doc_out/AttemptLimitsEntityListing.html.md +1 -1
- data/doc_out/AttributeEntityListing.html.md +1 -1
- data/doc_out/CalibrationEntityListing.html.md +1 -1
- data/doc_out/Call.html.md +1 -0
- data/doc_out/CallConversationEntityListing.html.md +1 -1
- data/doc_out/CallConversationNotificationCallMediaParticipant.html.md +1 -0
- data/doc_out/CallConversationNotificationParticipants.html.md +1 -0
- data/doc_out/CallableContactsDiagnostic.html.md +1 -0
- data/doc_out/CallableTimeSetEntityListing.html.md +1 -1
- data/doc_out/Callback.html.md +1 -0
- data/doc_out/CallbackConversationEntityListing.html.md +1 -1
- data/doc_out/CallbackConversationNotificationCallbackMediaParticipant.html.md +1 -0
- data/doc_out/CallbackConversationNotificationParticipants.html.md +1 -0
- data/doc_out/Campaign.html.md +1 -0
- data/doc_out/CampaignEntityListing.html.md +1 -1
- data/doc_out/CampaignSequenceEntityListing.html.md +1 -1
- data/doc_out/CertificateAuthorityEntityListing.html.md +1 -1
- data/doc_out/ChannelEntityListing.html.md +1 -1
- data/doc_out/ChatConversationEntityListing.html.md +1 -1
- data/doc_out/ChatConversationNotificationChatMediaParticipant.html.md +1 -0
- data/doc_out/ChatConversationNotificationParticipants.html.md +1 -0
- data/doc_out/CobrowseConversationEntityListing.html.md +1 -1
- data/doc_out/CobrowseConversationNotificationCobrowseMediaParticipant.html.md +1 -0
- data/doc_out/CobrowseConversationNotificationParticipants.html.md +9 -8
- data/doc_out/Cobrowsesession.html.md +1 -0
- data/doc_out/CommandStatusEntityListing.html.md +1 -1
- data/doc_out/ContactListEntityListing.html.md +1 -1
- data/doc_out/ConversationEntityListing.html.md +1 -1
- data/doc_out/ConversationNotificationCall.html.md +1 -0
- data/doc_out/ConversationNotificationCallback.html.md +1 -0
- data/doc_out/ConversationNotificationCallbacks.html.md +1 -0
- data/doc_out/ConversationNotificationCalls.html.md +1 -0
- data/doc_out/ConversationNotificationChat.html.md +1 -0
- data/doc_out/ConversationNotificationChats.html.md +1 -0
- data/doc_out/ConversationNotificationCobrowse.html.md +1 -0
- data/doc_out/ConversationNotificationCobrowsesessions.html.md +1 -0
- data/doc_out/ConversationNotificationEmail.html.md +1 -0
- data/doc_out/ConversationNotificationEmails.html.md +1 -0
- data/doc_out/ConversationNotificationScreenShare.html.md +1 -0
- data/doc_out/ConversationNotificationScreenShares.html.md +1 -0
- data/doc_out/ConversationNotificationSocialExpression.html.md +1 -0
- data/doc_out/ConversationNotificationSocialExpressions.html.md +2 -1
- data/doc_out/DIDEntityListing.html.md +1 -1
- data/doc_out/DIDPoolEntityListing.html.md +1 -1
- data/doc_out/DncListEntityListing.html.md +1 -1
- data/doc_out/DocumentAuditEntityListing.html.md +1 -1
- data/doc_out/DocumentEntityListing.html.md +1 -1
- data/doc_out/DomainEdgeSoftwareVersionDtoEntityListing.html.md +1 -1
- data/doc_out/DomainEntityListing.html.md +1 -1
- data/doc_out/DomainEntityListingEvaluationForm.html.md +1 -1
- data/doc_out/DomainEntityListingQueryResult.html.md +1 -1
- data/doc_out/DomainOrganizationRole.html.md +1 -0
- data/doc_out/DomainOrganizationRoleCreate.html.md +1 -0
- data/doc_out/EdgeEntityListing.html.md +1 -1
- data/doc_out/EdgeGroupEntityListing.html.md +1 -1
- data/doc_out/EdgeLineEntityListing.html.md +1 -1
- data/doc_out/EmailConversationEntityListing.html.md +1 -1
- data/doc_out/EmailConversationNotificationEmailMediaParticipant.html.md +1 -0
- data/doc_out/EmailConversationNotificationParticipants.html.md +1 -0
- data/doc_out/EmailMessageListing.html.md +1 -1
- data/doc_out/EncryptionKeyEntityListing.html.md +1 -1
- data/doc_out/EndpointEntityListing.html.md +1 -1
- data/doc_out/EvaluationEntityListing.html.md +1 -1
- data/doc_out/EvaluationFormEntityListing.html.md +1 -1
- data/doc_out/EvaluatorActivityEntityListing.html.md +1 -1
- data/doc_out/ExtensionEntityListing.html.md +1 -1
- data/doc_out/ExtensionPoolEntityListing.html.md +1 -1
- data/doc_out/FaxDocumentEntityListing.html.md +1 -1
- data/doc_out/GroupEntityListing.html.md +1 -1
- data/doc_out/GroupSearchCriteria.html.md +7 -7
- data/doc_out/GroupSearchRequest.html.md +6 -6
- data/doc_out/GroupsApi.html.md +6 -6
- data/doc_out/GroupsSearchResponse.html.md +9 -9
- data/doc_out/HeartBeatAlertContainer.html.md +1 -1
- data/doc_out/HeartBeatRuleContainer.html.md +1 -1
- data/doc_out/InboundDomainEntityListing.html.md +1 -1
- data/doc_out/InboundRouteEntityListing.html.md +1 -1
- data/doc_out/InteractionStatsAlertContainer.html.md +1 -1
- data/doc_out/InteractionStatsRuleContainer.html.md +1 -1
- data/doc_out/JsonNode.html.md +3 -3
- data/doc_out/JsonNodeSearchResponse.html.md +9 -9
- data/doc_out/KeywordSetEntityListing.html.md +1 -1
- data/doc_out/LanguageEntityListing.html.md +1 -1
- data/doc_out/LibraryEntityListing.html.md +1 -1
- data/doc_out/LineBaseEntityListing.html.md +1 -1
- data/doc_out/LineEntityListing.html.md +1 -1
- data/doc_out/LocationSearchCriteria.html.md +7 -7
- data/doc_out/LocationSearchRequest.html.md +6 -6
- data/doc_out/LocationsApi.html.md +6 -6
- data/doc_out/LocationsSearchResponse.html.md +9 -9
- data/doc_out/LogicalInterfaceEntityListing.html.md +1 -1
- data/doc_out/ManagementUnit.html.md +18 -0
- data/doc_out/OAuthClientEntityListing.html.md +1 -1
- data/doc_out/OAuthProviderEntityListing.html.md +1 -1
- data/doc_out/OrganizationPresenceEntityListing.html.md +1 -1
- data/doc_out/OrganizationRoleEntityListing.html.md +1 -1
- data/doc_out/OrphanRecordingListing.html.md +1 -1
- data/doc_out/OutboundRouteEntityListing.html.md +1 -1
- data/doc_out/PermissionCollectionEntityListing.html.md +1 -1
- data/doc_out/PhoneBaseEntityListing.html.md +1 -1
- data/doc_out/PhoneEntityListing.html.md +1 -1
- data/doc_out/PhoneMetaBaseEntityListing.html.md +1 -1
- data/doc_out/PhysicalInterfaceEntityListing.html.md +1 -1
- data/doc_out/PolicyEntityListing.html.md +1 -1
- data/doc_out/Predicate.html.md +14 -0
- data/doc_out/QualityAuditPage.html.md +1 -1
- data/doc_out/QuestionGroup.html.md +1 -0
- data/doc_out/QueueEntityListing.html.md +1 -1
- data/doc_out/QueueMemberEntityListing.html.md +1 -1
- data/doc_out/ReportMetaDataEntityListing.html.md +1 -1
- data/doc_out/ReportRunEntryEntityDomainListing.html.md +1 -1
- data/doc_out/ReportScheduleEntityListing.html.md +1 -1
- data/doc_out/ResponseEntityList.html.md +1 -1
- data/doc_out/ResponseEntityListing.html.md +1 -1
- data/doc_out/ResponseSetEntityListing.html.md +1 -1
- data/doc_out/RuleSetEntityListing.html.md +1 -1
- data/doc_out/SchemaCategoryEntityListing.html.md +1 -1
- data/doc_out/SchemaReferenceEntityListing.html.md +1 -1
- data/doc_out/ScreenRecordingSessionListing.html.md +1 -1
- data/doc_out/ScreenShareConversationNotificationParticipants.html.md +10 -9
- data/doc_out/ScreenShareConversationNotificationScreenShareMediaParticipant.html.md +1 -0
- data/doc_out/Screenshare.html.md +1 -0
- data/doc_out/SearchAggregation.html.md +6 -6
- data/doc_out/SearchApi.html.md +30 -30
- data/doc_out/SearchCriteria.html.md +7 -7
- data/doc_out/SearchRequest.html.md +9 -9
- data/doc_out/SecurityProfileEntityListing.html.md +1 -1
- data/doc_out/ShareEntityListing.html.md +1 -1
- data/doc_out/SiteEntityListing.html.md +1 -1
- data/doc_out/SkillEntityListing.html.md +1 -1
- data/doc_out/SocialConversationNotificationParticipants.html.md +11 -10
- data/doc_out/SocialConversationNotificationSocialMediaParticipant.html.md +1 -0
- data/doc_out/SocialExpression.html.md +1 -0
- data/doc_out/StationEntityListing.html.md +1 -1
- data/doc_out/SuggestApi.html.md +12 -12
- data/doc_out/SuggestSearchCriteria.html.md +7 -7
- data/doc_out/SuggestSearchRequest.html.md +2 -2
- data/doc_out/TagValueEntityListing.html.md +1 -1
- data/doc_out/TimeZoneEntityListing.html.md +1 -1
- data/doc_out/TrunkEntityListing.html.md +1 -1
- data/doc_out/TrunkMetabaseEntityListing.html.md +1 -1
- data/doc_out/UserEntityListing.html.md +1 -1
- data/doc_out/UserQueueEntityListing.html.md +1 -1
- data/doc_out/UserRecordingEntityListing.html.md +1 -1
- data/doc_out/UserScheduleAdherence.html.md +26 -0
- data/doc_out/UserSearchCriteria.html.md +7 -7
- data/doc_out/UserSearchRequest.html.md +6 -6
- data/doc_out/UserSkillEntityListing.html.md +1 -1
- data/doc_out/UsersApi.html.md +124 -6
- data/doc_out/UsersEntityListing.html.md +1 -1
- data/doc_out/UsersSearchResponse.html.md +9 -9
- data/doc_out/Video.html.md +1 -0
- data/doc_out/VideoConversationNotificationParticipants.html.md +1 -1
- data/doc_out/VideoConversationNotificationVideoMediaParticipant.html.md +1 -1
- data/doc_out/VisibilityCondition.html.md +14 -0
- data/doc_out/WorkforceManagementApi.html.md +69 -0
- data/doc_out/WorkspaceEntityListing.html.md +1 -1
- data/doc_out/WorkspaceMemberEntityListing.html.md +1 -1
- data/doc_out/WrapupCodeEntityListing.html.md +1 -1
- data/doc_out/index.html.md +3 -3
- data/lib/purecloud.rb +5 -0
- data/lib/purecloud/api/groups_api.rb +4 -4
- data/lib/purecloud/api/locations_api.rb +4 -4
- data/lib/purecloud/api/search_api.rb +20 -20
- data/lib/purecloud/api/suggest_api.rb +8 -8
- data/lib/purecloud/api/users_api.rb +126 -4
- data/lib/purecloud/api/workforce_management_api.rb +88 -0
- data/lib/purecloud/api_client.rb +1 -1
- data/lib/purecloud/models/agent_activity_entity_listing.rb +11 -11
- data/lib/purecloud/models/analytics_query_predicate.rb +1 -1
- data/lib/purecloud/models/attempt_limits_entity_listing.rb +11 -11
- data/lib/purecloud/models/attribute_entity_listing.rb +11 -11
- data/lib/purecloud/models/calibration_entity_listing.rb +11 -11
- data/lib/purecloud/models/call.rb +15 -4
- data/lib/purecloud/models/call_conversation_entity_listing.rb +11 -11
- data/lib/purecloud/models/call_conversation_notification_call_media_participant.rb +11 -1
- data/lib/purecloud/models/call_conversation_notification_participants.rb +11 -1
- data/lib/purecloud/models/callable_contacts_diagnostic.rb +12 -1
- data/lib/purecloud/models/callable_time_set_entity_listing.rb +11 -11
- data/lib/purecloud/models/callback.rb +15 -4
- data/lib/purecloud/models/callback_conversation_entity_listing.rb +11 -11
- data/lib/purecloud/models/callback_conversation_notification_callback_media_participant.rb +11 -1
- data/lib/purecloud/models/callback_conversation_notification_participants.rb +11 -1
- data/lib/purecloud/models/campaign.rb +12 -1
- data/lib/purecloud/models/campaign_entity_listing.rb +11 -11
- data/lib/purecloud/models/campaign_sequence_entity_listing.rb +11 -11
- data/lib/purecloud/models/certificate_authority_entity_listing.rb +11 -11
- data/lib/purecloud/models/channel_entity_listing.rb +11 -11
- data/lib/purecloud/models/chat_conversation_entity_listing.rb +11 -11
- data/lib/purecloud/models/chat_conversation_notification_chat_media_participant.rb +11 -1
- data/lib/purecloud/models/chat_conversation_notification_participants.rb +11 -1
- data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +11 -11
- data/lib/purecloud/models/cobrowse_conversation_notification_cobrowse_media_participant.rb +11 -1
- data/lib/purecloud/models/cobrowse_conversation_notification_participants.rb +87 -77
- data/lib/purecloud/models/cobrowsesession.rb +15 -4
- data/lib/purecloud/models/command_status_entity_listing.rb +11 -11
- data/lib/purecloud/models/contact_list_entity_listing.rb +11 -11
- data/lib/purecloud/models/conversation_entity_listing.rb +11 -11
- data/lib/purecloud/models/conversation_notification_call.rb +11 -1
- data/lib/purecloud/models/conversation_notification_callback.rb +11 -1
- data/lib/purecloud/models/conversation_notification_callbacks.rb +11 -1
- data/lib/purecloud/models/conversation_notification_calls.rb +11 -1
- data/lib/purecloud/models/conversation_notification_chat.rb +11 -1
- data/lib/purecloud/models/conversation_notification_chats.rb +14 -4
- data/lib/purecloud/models/conversation_notification_cobrowse.rb +11 -1
- data/lib/purecloud/models/conversation_notification_cobrowsesessions.rb +11 -1
- data/lib/purecloud/models/conversation_notification_email.rb +11 -1
- data/lib/purecloud/models/conversation_notification_emails.rb +11 -1
- data/lib/purecloud/models/conversation_notification_screen_share.rb +11 -1
- data/lib/purecloud/models/conversation_notification_screen_shares.rb +11 -1
- data/lib/purecloud/models/conversation_notification_social_expression.rb +11 -1
- data/lib/purecloud/models/conversation_notification_social_expressions.rb +21 -11
- data/lib/purecloud/models/conversation_notification_video.rb +0 -9
- data/lib/purecloud/models/conversation_notification_videos.rb +0 -9
- data/lib/purecloud/models/did_entity_listing.rb +11 -11
- data/lib/purecloud/models/did_pool_entity_listing.rb +11 -11
- data/lib/purecloud/models/dnc_list_entity_listing.rb +11 -11
- data/lib/purecloud/models/document_audit_entity_listing.rb +11 -11
- data/lib/purecloud/models/document_entity_listing.rb +11 -11
- data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +11 -11
- data/lib/purecloud/models/domain_entity_listing.rb +11 -11
- data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +11 -11
- data/lib/purecloud/models/domain_entity_listing_query_result.rb +11 -11
- data/lib/purecloud/models/domain_organization_role.rb +13 -1
- data/lib/purecloud/models/domain_organization_role_create.rb +13 -1
- data/lib/purecloud/models/edge_entity_listing.rb +11 -11
- data/lib/purecloud/models/edge_group_entity_listing.rb +11 -11
- data/lib/purecloud/models/edge_line_entity_listing.rb +11 -11
- data/lib/purecloud/models/email_conversation_entity_listing.rb +11 -11
- data/lib/purecloud/models/email_conversation_notification_email_media_participant.rb +11 -1
- data/lib/purecloud/models/email_conversation_notification_participants.rb +11 -1
- data/lib/purecloud/models/email_message_listing.rb +11 -11
- data/lib/purecloud/models/encryption_key_entity_listing.rb +11 -11
- data/lib/purecloud/models/endpoint_entity_listing.rb +11 -11
- data/lib/purecloud/models/evaluation_entity_listing.rb +11 -11
- data/lib/purecloud/models/evaluation_form_entity_listing.rb +11 -11
- data/lib/purecloud/models/evaluator_activity_entity_listing.rb +11 -11
- data/lib/purecloud/models/extension_entity_listing.rb +11 -11
- data/lib/purecloud/models/extension_pool_entity_listing.rb +11 -11
- data/lib/purecloud/models/fax_document_entity_listing.rb +11 -11
- data/lib/purecloud/models/group_entity_listing.rb +11 -11
- data/lib/purecloud/models/group_search_criteria.rb +7 -0
- data/lib/purecloud/models/group_search_request.rb +6 -0
- data/lib/purecloud/models/groups_search_response.rb +9 -0
- data/lib/purecloud/models/heart_beat_alert_container.rb +11 -11
- data/lib/purecloud/models/heart_beat_rule_container.rb +11 -11
- data/lib/purecloud/models/inbound_domain_entity_listing.rb +11 -11
- data/lib/purecloud/models/inbound_route_entity_listing.rb +11 -11
- data/lib/purecloud/models/interaction_stats_alert_container.rb +11 -11
- data/lib/purecloud/models/interaction_stats_rule_container.rb +11 -11
- data/lib/purecloud/models/json_node.rb +40 -40
- data/lib/purecloud/models/json_node_search_response.rb +9 -0
- data/lib/purecloud/models/keyword_set_entity_listing.rb +11 -11
- data/lib/purecloud/models/language_entity_listing.rb +11 -11
- data/lib/purecloud/models/library_entity_listing.rb +11 -11
- data/lib/purecloud/models/line_base_entity_listing.rb +11 -11
- data/lib/purecloud/models/line_entity_listing.rb +11 -11
- data/lib/purecloud/models/location_search_criteria.rb +7 -0
- data/lib/purecloud/models/location_search_request.rb +6 -0
- data/lib/purecloud/models/locations_search_response.rb +9 -0
- data/lib/purecloud/models/logical_interface_entity_listing.rb +11 -11
- data/lib/purecloud/models/management_unit.rb +230 -0
- data/lib/purecloud/models/o_auth_client_entity_listing.rb +11 -11
- data/lib/purecloud/models/o_auth_provider_entity_listing.rb +11 -11
- data/lib/purecloud/models/organization_presence_entity_listing.rb +11 -11
- data/lib/purecloud/models/organization_role_entity_listing.rb +11 -11
- data/lib/purecloud/models/orphan_recording_listing.rb +11 -11
- data/lib/purecloud/models/outbound_route_entity_listing.rb +11 -11
- data/lib/purecloud/models/permission_collection_entity_listing.rb +11 -11
- data/lib/purecloud/models/phone_base_entity_listing.rb +11 -11
- data/lib/purecloud/models/phone_entity_listing.rb +11 -11
- data/lib/purecloud/models/phone_meta_base_entity_listing.rb +11 -11
- data/lib/purecloud/models/physical_interface_entity_listing.rb +11 -11
- data/lib/purecloud/models/policy_entity_listing.rb +11 -11
- data/lib/purecloud/models/predicate.rb +175 -0
- data/lib/purecloud/models/quality_audit_page.rb +11 -11
- data/lib/purecloud/models/question_group.rb +14 -4
- data/lib/purecloud/models/queue_entity_listing.rb +11 -11
- data/lib/purecloud/models/queue_member_entity_listing.rb +11 -11
- data/lib/purecloud/models/report_meta_data_entity_listing.rb +11 -11
- data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +11 -11
- data/lib/purecloud/models/report_schedule_entity_listing.rb +11 -11
- data/lib/purecloud/models/response_entity_list.rb +11 -11
- data/lib/purecloud/models/response_entity_listing.rb +11 -11
- data/lib/purecloud/models/response_set_entity_listing.rb +11 -11
- data/lib/purecloud/models/rule_set_entity_listing.rb +11 -11
- data/lib/purecloud/models/schema_category_entity_listing.rb +11 -11
- data/lib/purecloud/models/schema_reference_entity_listing.rb +11 -11
- data/lib/purecloud/models/screen_recording_session_listing.rb +11 -11
- data/lib/purecloud/models/screen_share_conversation_notification_participants.rb +89 -79
- data/lib/purecloud/models/screen_share_conversation_notification_screen_share_media_participant.rb +11 -1
- data/lib/purecloud/models/screenshare.rb +15 -4
- data/lib/purecloud/models/search_aggregation.rb +6 -0
- data/lib/purecloud/models/search_criteria.rb +7 -0
- data/lib/purecloud/models/search_request.rb +9 -1
- data/lib/purecloud/models/security_profile_entity_listing.rb +11 -11
- data/lib/purecloud/models/share_entity_listing.rb +11 -11
- data/lib/purecloud/models/site_entity_listing.rb +11 -11
- data/lib/purecloud/models/skill_entity_listing.rb +11 -11
- data/lib/purecloud/models/social_conversation_notification_participants.rb +103 -93
- data/lib/purecloud/models/social_conversation_notification_social_media_participant.rb +11 -1
- data/lib/purecloud/models/social_expression.rb +15 -4
- data/lib/purecloud/models/station_entity_listing.rb +11 -11
- data/lib/purecloud/models/suggest_search_criteria.rb +7 -0
- data/lib/purecloud/models/suggest_search_request.rb +2 -1
- data/lib/purecloud/models/tag_value_entity_listing.rb +11 -11
- data/lib/purecloud/models/time_zone_entity_listing.rb +11 -11
- data/lib/purecloud/models/trunk_entity_listing.rb +11 -11
- data/lib/purecloud/models/trunk_metabase_entity_listing.rb +11 -11
- data/lib/purecloud/models/user_entity_listing.rb +11 -11
- data/lib/purecloud/models/user_queue_entity_listing.rb +11 -11
- data/lib/purecloud/models/user_recording_entity_listing.rb +11 -11
- data/lib/purecloud/models/user_schedule_adherence.rb +364 -0
- data/lib/purecloud/models/user_search_criteria.rb +7 -0
- data/lib/purecloud/models/user_search_request.rb +6 -0
- data/lib/purecloud/models/user_skill_entity_listing.rb +11 -11
- data/lib/purecloud/models/users_entity_listing.rb +11 -11
- data/lib/purecloud/models/users_search_response.rb +9 -0
- data/lib/purecloud/models/video.rb +15 -4
- data/lib/purecloud/models/video_conversation_notification_participants.rb +13 -22
- data/lib/purecloud/models/video_conversation_notification_video_media_participant.rb +14 -23
- data/lib/purecloud/models/visibility_condition.rb +186 -0
- data/lib/purecloud/models/workspace_entity_listing.rb +11 -11
- data/lib/purecloud/models/workspace_member_entity_listing.rb +11 -11
- data/lib/purecloud/models/wrapup_code_entity_listing.rb +11 -11
- data/lib/purecloud/version.rb +1 -1
- data/newVersion.md +1 -1
- data/swagger.json +1 -1
- data/version.json +1 -1
- metadata +12 -2
|
@@ -7,13 +7,13 @@ title: SearchCriteria
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **end_value** | **String** |
|
|
11
|
-
| **values** | **Array<String>** |
|
|
12
|
-
| **start_value** | **String** |
|
|
13
|
-
| **fields** | **Array<String>** |
|
|
14
|
-
| **value** | **String** |
|
|
15
|
-
| **operator** | **String** |
|
|
16
|
-
| **group** | [**Array<SearchCriteria>**](SearchCriteria.html) |
|
|
10
|
+
| **end_value** | **String** | The end value of the range. This field is used for range search types. | [optional] |
|
|
11
|
+
| **values** | **Array<String>** | A list of values for the search to match against | [optional] |
|
|
12
|
+
| **start_value** | **String** | The start value of the range. This field is used for range search types. | [optional] |
|
|
13
|
+
| **fields** | **Array<String>** | Field names to search against | [optional] |
|
|
14
|
+
| **value** | **String** | A value for the search to match against | [optional] |
|
|
15
|
+
| **operator** | **String** | How to apply this search criteria against other criteria | [optional] |
|
|
16
|
+
| **group** | [**Array<SearchCriteria>**](SearchCriteria.html) | Groups multiple conditions | [optional] |
|
|
17
17
|
| **type** | **String** | | [optional] |
|
|
18
18
|
{: class="table table-striped"}
|
|
19
19
|
|
|
@@ -7,15 +7,15 @@ title: SearchRequest
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **sort_order** | **String** |
|
|
11
|
-
| **sort_by** | **String** |
|
|
12
|
-
| **page_size** | **Integer** |
|
|
13
|
-
| **page_number** | **Integer** |
|
|
14
|
-
| **return_fields** | **Array<String>** |
|
|
15
|
-
| **expand** | **Array<String>** |
|
|
16
|
-
| **types** | **Array<String>** | Resource
|
|
17
|
-
| **query** | [**Array<SearchCriteria>**](SearchCriteria.html) |
|
|
18
|
-
| **aggregations** | [**Array<SearchAggregation>**](SearchAggregation.html) |
|
|
10
|
+
| **sort_order** | **String** | The sort order for results | [optional] |
|
|
11
|
+
| **sort_by** | **String** | The field in the resource that you want to sort the results by | [optional] |
|
|
12
|
+
| **page_size** | **Integer** | The number of results per page | [optional] |
|
|
13
|
+
| **page_number** | **Integer** | The page of resources you want to retrieve | [optional] |
|
|
14
|
+
| **return_fields** | **Array<String>** | A List of strings containing the resource field paths that you want to return | [optional] |
|
|
15
|
+
| **expand** | **Array<String>** | Provides more details about a specified resource | [optional] |
|
|
16
|
+
| **types** | **Array<String>** | Resource domain type to search | |
|
|
17
|
+
| **query** | [**Array<SearchCriteria>**](SearchCriteria.html) | The search criteria | [optional] |
|
|
18
|
+
| **aggregations** | [**Array<SearchAggregation>**](SearchAggregation.html) | Aggregation criteria | [optional] |
|
|
19
19
|
{: class="table table-striped"}
|
|
20
20
|
|
|
21
21
|
|
|
@@ -12,9 +12,9 @@ title: SecurityProfileEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **next_uri** | **String** | | [optional] |
|
|
16
15
|
| **first_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -12,9 +12,9 @@ title: ShareEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **next_uri** | **String** | | [optional] |
|
|
16
15
|
| **first_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -12,9 +12,9 @@ title: SiteEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **next_uri** | **String** | | [optional] |
|
|
16
15
|
| **first_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -12,9 +12,9 @@ title: SkillEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **next_uri** | **String** | | [optional] |
|
|
16
15
|
| **first_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -8,29 +8,30 @@ title: SocialConversationNotificationParticipants
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **queue** | [**SocialConversationNotificationUriReference**](SocialConversationNotificationUriReference.html) | | [optional] |
|
|
11
|
-
| **held** | **BOOLEAN** | | [optional] |
|
|
12
|
-
| **social_media_id** | **String** | | [optional] |
|
|
13
11
|
| **error_info** | [**SocialConversationNotificationErrorInfo**](SocialConversationNotificationErrorInfo.html) | | [optional] |
|
|
14
12
|
| **connected_time** | **DateTime** | | [optional] |
|
|
15
13
|
| **social_user_name** | **String** | | [optional] |
|
|
16
|
-
| **wrapup_skipped** | **BOOLEAN** | | [optional] |
|
|
17
14
|
| **direction** | **String** | | [optional] |
|
|
18
|
-
| **
|
|
15
|
+
| **wrapup_skipped** | **BOOLEAN** | | [optional] |
|
|
19
16
|
| **state** | **String** | | [optional] |
|
|
20
17
|
| **purpose** | **String** | | [optional] |
|
|
21
|
-
| **script** | [**SocialConversationNotificationUriReference**](SocialConversationNotificationUriReference.html) | | [optional] |
|
|
22
18
|
| **end_time** | **DateTime** | | [optional] |
|
|
23
19
|
| **social_media_hub** | **String** | | [optional] |
|
|
24
|
-
| **id** | **String** | | [optional] |
|
|
25
20
|
| **start_time** | **DateTime** | | [optional] |
|
|
26
|
-
| **
|
|
21
|
+
| **id** | **String** | | [optional] |
|
|
27
22
|
| **wrapup_prompt** | **String** | | [optional] |
|
|
28
|
-
| **address** | **String** | | [optional] |
|
|
29
23
|
| **name** | **String** | | [optional] |
|
|
30
|
-
| **start_hold_time** | **DateTime** | | [optional] |
|
|
31
24
|
| **wrapup_timeout_ms** | **Integer** | | [optional] |
|
|
32
|
-
| **attributes** | **Hash<String, String>** | | [optional] |
|
|
33
25
|
| **preview_text** | **String** | | [optional] |
|
|
26
|
+
| **held** | **BOOLEAN** | | [optional] |
|
|
27
|
+
| **social_media_id** | **String** | | [optional] |
|
|
28
|
+
| **wrapup_required** | **BOOLEAN** | | [optional] |
|
|
29
|
+
| **provider** | **String** | | [optional] |
|
|
30
|
+
| **script** | [**SocialConversationNotificationUriReference**](SocialConversationNotificationUriReference.html) | | [optional] |
|
|
31
|
+
| **disconnect_type** | **String** | | [optional] |
|
|
32
|
+
| **address** | **String** | | [optional] |
|
|
33
|
+
| **start_hold_time** | **DateTime** | | [optional] |
|
|
34
|
+
| **attributes** | **Hash<String, String>** | | [optional] |
|
|
34
35
|
| **user** | [**CallbackConversationNotificationUser**](CallbackConversationNotificationUser.html) | | [optional] |
|
|
35
36
|
{: class="table table-striped"}
|
|
36
37
|
|
|
@@ -28,6 +28,7 @@ title: SocialConversationNotificationSocialMediaParticipant
|
|
|
28
28
|
| **script** | [**SocialConversationNotificationUriReference**](SocialConversationNotificationUriReference.html) | | [optional] |
|
|
29
29
|
| **wrapup_timeout_ms** | **Integer** | | [optional] |
|
|
30
30
|
| **wrapup_skipped** | **BOOLEAN** | | [optional] |
|
|
31
|
+
| **provider** | **String** | | [optional] |
|
|
31
32
|
| **social_media_id** | **String** | | [optional] |
|
|
32
33
|
| **social_media_hub** | **String** | | [optional] |
|
|
33
34
|
| **social_user_name** | **String** | | [optional] |
|
|
@@ -20,6 +20,7 @@ title: SocialExpression
|
|
|
20
20
|
| **start_hold_time** | **DateTime** | The timestamp the chat was placed on hold in the cloud clock if the chat is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
21
21
|
| **connected_time** | **DateTime** | The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
22
22
|
| **disconnected_time** | **DateTime** | The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
23
|
+
| **provider** | **String** | The source provider for the video. | [optional] |
|
|
23
24
|
{: class="table table-striped"}
|
|
24
25
|
|
|
25
26
|
|
|
@@ -12,9 +12,9 @@ title: StationEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **next_uri** | **String** | | [optional] |
|
|
16
15
|
| **first_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
data/doc_out/SuggestApi.html.md
CHANGED
|
@@ -8,17 +8,17 @@ All URIs are relative to *https://api.mypurecloud.com*
|
|
|
8
8
|
|
|
9
9
|
Method | HTTP request | Description
|
|
10
10
|
------------- | ------------- | -------------
|
|
11
|
-
|[**get_search**](SuggestApi.html#get_search) | **GET** /api/v2/search | Search using q64
|
|
12
|
-
|[**get_suggest**](SuggestApi.html#get_suggest) | **GET** /api/v2/search/suggest | Suggest using q64
|
|
13
|
-
|[**post_search**](SuggestApi.html#post_search) | **POST** /api/v2/search | Search
|
|
14
|
-
|[**post_suggest**](SuggestApi.html#post_suggest) | **POST** /api/v2/search/suggest | Suggest
|
|
11
|
+
|[**get_search**](SuggestApi.html#get_search) | **GET** /api/v2/search | Search using the q64 value returned from a previous search.|
|
|
12
|
+
|[**get_suggest**](SuggestApi.html#get_suggest) | **GET** /api/v2/search/suggest | Suggest resources using the q64 value returned from a previous suggest query.|
|
|
13
|
+
|[**post_search**](SuggestApi.html#post_search) | **POST** /api/v2/search | Search resources.|
|
|
14
|
+
|[**post_suggest**](SuggestApi.html#post_suggest) | **POST** /api/v2/search/suggest | Suggest resources.|
|
|
15
15
|
{: class="table table-striped"}
|
|
16
16
|
|
|
17
17
|
<a name="get_search"></a>
|
|
18
18
|
|
|
19
19
|
## -[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) get_search(q64, opts)
|
|
20
20
|
|
|
21
|
-
Search using q64
|
|
21
|
+
Search using the q64 value returned from a previous search.
|
|
22
22
|
|
|
23
23
|
|
|
24
24
|
|
|
@@ -47,7 +47,7 @@ opts = {
|
|
|
47
47
|
}
|
|
48
48
|
|
|
49
49
|
begin
|
|
50
|
-
#Search using q64
|
|
50
|
+
#Search using the q64 value returned from a previous search.
|
|
51
51
|
result = api_instance.get_search(q64, opts)
|
|
52
52
|
p result
|
|
53
53
|
rescue PureCloud::ApiError => e
|
|
@@ -80,7 +80,7 @@ Name | Type | Description | Notes
|
|
|
80
80
|
|
|
81
81
|
## -[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) get_suggest(q64, opts)
|
|
82
82
|
|
|
83
|
-
Suggest using q64
|
|
83
|
+
Suggest resources using the q64 value returned from a previous suggest query.
|
|
84
84
|
|
|
85
85
|
|
|
86
86
|
|
|
@@ -108,7 +108,7 @@ opts = {
|
|
|
108
108
|
}
|
|
109
109
|
|
|
110
110
|
begin
|
|
111
|
-
#Suggest using q64
|
|
111
|
+
#Suggest resources using the q64 value returned from a previous suggest query.
|
|
112
112
|
result = api_instance.get_suggest(q64, opts)
|
|
113
113
|
p result
|
|
114
114
|
rescue PureCloud::ApiError => e
|
|
@@ -140,7 +140,7 @@ Name | Type | Description | Notes
|
|
|
140
140
|
|
|
141
141
|
## -[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) post_search(body, opts)
|
|
142
142
|
|
|
143
|
-
Search
|
|
143
|
+
Search resources.
|
|
144
144
|
|
|
145
145
|
|
|
146
146
|
|
|
@@ -168,7 +168,7 @@ opts = {
|
|
|
168
168
|
}
|
|
169
169
|
|
|
170
170
|
begin
|
|
171
|
-
#Search
|
|
171
|
+
#Search resources.
|
|
172
172
|
result = api_instance.post_search(body, opts)
|
|
173
173
|
p result
|
|
174
174
|
rescue PureCloud::ApiError => e
|
|
@@ -200,7 +200,7 @@ Name | Type | Description | Notes
|
|
|
200
200
|
|
|
201
201
|
## -[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) post_suggest(body, opts)
|
|
202
202
|
|
|
203
|
-
Suggest
|
|
203
|
+
Suggest resources.
|
|
204
204
|
|
|
205
205
|
|
|
206
206
|
|
|
@@ -228,7 +228,7 @@ opts = {
|
|
|
228
228
|
}
|
|
229
229
|
|
|
230
230
|
begin
|
|
231
|
-
#Suggest
|
|
231
|
+
#Suggest resources.
|
|
232
232
|
result = api_instance.post_suggest(body, opts)
|
|
233
233
|
p result
|
|
234
234
|
rescue PureCloud::ApiError => e
|
|
@@ -7,13 +7,13 @@ title: SuggestSearchCriteria
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **end_value** | **String** |
|
|
11
|
-
| **values** | **Array<String>** |
|
|
12
|
-
| **start_value** | **String** |
|
|
13
|
-
| **fields** | **Array<String>** |
|
|
14
|
-
| **value** | **String** |
|
|
15
|
-
| **operator** | **String** |
|
|
16
|
-
| **group** | [**Array<SuggestSearchCriteria>**](SuggestSearchCriteria.html) |
|
|
10
|
+
| **end_value** | **String** | The end value of the range. This field is used for range search types. | [optional] |
|
|
11
|
+
| **values** | **Array<String>** | A list of values for the search to match against | [optional] |
|
|
12
|
+
| **start_value** | **String** | The start value of the range. This field is used for range search types. | [optional] |
|
|
13
|
+
| **fields** | **Array<String>** | Field names to search against | [optional] |
|
|
14
|
+
| **value** | **String** | A value for the search to match against | [optional] |
|
|
15
|
+
| **operator** | **String** | How to apply this search criteria against other criteria | [optional] |
|
|
16
|
+
| **group** | [**Array<SuggestSearchCriteria>**](SuggestSearchCriteria.html) | Groups multiple conditions | [optional] |
|
|
17
17
|
{: class="table table-striped"}
|
|
18
18
|
|
|
19
19
|
|
|
@@ -7,8 +7,8 @@ title: SuggestSearchRequest
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **types** | **Array<String>** | Resource
|
|
11
|
-
| **query** | [**Array<SuggestSearchCriteria>**](SuggestSearchCriteria.html) |
|
|
10
|
+
| **types** | **Array<String>** | Resource domain type to search | |
|
|
11
|
+
| **query** | [**Array<SuggestSearchCriteria>**](SuggestSearchCriteria.html) | Suggest query | |
|
|
12
12
|
{: class="table table-striped"}
|
|
13
13
|
|
|
14
14
|
|
|
@@ -12,9 +12,9 @@ title: TagValueEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **next_uri** | **String** | | [optional] |
|
|
16
15
|
| **first_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -12,9 +12,9 @@ title: TimeZoneEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **next_uri** | **String** | | [optional] |
|
|
16
15
|
| **first_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -12,9 +12,9 @@ title: TrunkEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **next_uri** | **String** | | [optional] |
|
|
16
15
|
| **first_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -12,9 +12,9 @@ title: TrunkMetabaseEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **next_uri** | **String** | | [optional] |
|
|
16
15
|
| **first_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -12,9 +12,9 @@ title: UserEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **next_uri** | **String** | | [optional] |
|
|
16
15
|
| **first_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -12,9 +12,9 @@ title: UserQueueEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **next_uri** | **String** | | [optional] |
|
|
16
15
|
| **first_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -12,9 +12,9 @@ title: UserRecordingEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **next_uri** | **String** | | [optional] |
|
|
16
15
|
| **first_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: UserScheduleAdherence
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::UserScheduleAdherence
|
|
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
|
+
| **user** | [**User**](User.html) | The user for whom this status applies | [optional] |
|
|
13
|
+
| **management_unit** | [**ManagementUnit**](ManagementUnit.html) | The management unit to which this user belongs | [optional] |
|
|
14
|
+
| **scheduled_activity_category** | **String** | Activity for which the user is scheduled | [optional] |
|
|
15
|
+
| **system_presence** | **String** | Actual underlying system presence value | [optional] |
|
|
16
|
+
| **organization_secondary_presence_id** | **String** | Organization Secondary Presence Id. | [optional] |
|
|
17
|
+
| **routing_status** | **String** | Actual underlying routing status, used to determine whether a user is actually in adherence when OnQueue | [optional] |
|
|
18
|
+
| **actual_activity_category** | **String** | Activity in which the user is actually engaged | [optional] |
|
|
19
|
+
| **is_out_of_office** | **BOOLEAN** | Whether the user is marked OutOfOffice | [optional] [default to false]|
|
|
20
|
+
| **adherence_state** | **String** | The user's current adherence state | [optional] |
|
|
21
|
+
| **impact** | **String** | The impact of the user's current adherenceState | [optional] |
|
|
22
|
+
| **time_of_adherence_change** | **String** | Time when the user entered the current adherenceState in ISO-8601 format | [optional] |
|
|
23
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
24
|
+
{: class="table table-striped"}
|
|
25
|
+
|
|
26
|
+
|
|
@@ -7,13 +7,13 @@ title: UserSearchCriteria
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **end_value** | **String** |
|
|
11
|
-
| **values** | **Array<String>** |
|
|
12
|
-
| **start_value** | **String** |
|
|
13
|
-
| **fields** | **Array<String>** |
|
|
14
|
-
| **value** | **String** |
|
|
15
|
-
| **operator** | **String** |
|
|
16
|
-
| **group** | [**Array<UserSearchCriteria>**](UserSearchCriteria.html) |
|
|
10
|
+
| **end_value** | **String** | The end value of the range. This field is used for range search types. | [optional] |
|
|
11
|
+
| **values** | **Array<String>** | A list of values for the search to match against | [optional] |
|
|
12
|
+
| **start_value** | **String** | The start value of the range. This field is used for range search types. | [optional] |
|
|
13
|
+
| **fields** | **Array<String>** | Field names to search against | [optional] |
|
|
14
|
+
| **value** | **String** | A value for the search to match against | [optional] |
|
|
15
|
+
| **operator** | **String** | How to apply this search criteria against other criteria | [optional] |
|
|
16
|
+
| **group** | [**Array<UserSearchCriteria>**](UserSearchCriteria.html) | Groups multiple conditions | [optional] |
|
|
17
17
|
| **type** | **String** | Search Type | |
|
|
18
18
|
{: class="table table-striped"}
|
|
19
19
|
|
|
@@ -7,12 +7,12 @@ title: UserSearchRequest
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **sort_order** | **String** |
|
|
11
|
-
| **sort_by** | **String** |
|
|
12
|
-
| **page_size** | **Integer** |
|
|
13
|
-
| **page_number** | **Integer** |
|
|
14
|
-
| **return_fields** | **Array<String>** |
|
|
15
|
-
| **expand** | **Array<String>** |
|
|
10
|
+
| **sort_order** | **String** | The sort order for results | [optional] |
|
|
11
|
+
| **sort_by** | **String** | The field in the resource that you want to sort the results by | [optional] |
|
|
12
|
+
| **page_size** | **Integer** | The number of results per page | [optional] |
|
|
13
|
+
| **page_number** | **Integer** | The page of resources you want to retrieve | [optional] |
|
|
14
|
+
| **return_fields** | **Array<String>** | A List of strings containing the resource field paths that you want to return | [optional] |
|
|
15
|
+
| **expand** | **Array<String>** | Provides more details about a specified resource | [optional] |
|
|
16
16
|
| **query** | [**Array<UserSearchCriteria>**](UserSearchCriteria.html) | | [optional] |
|
|
17
17
|
{: class="table table-striped"}
|
|
18
18
|
|
|
@@ -12,9 +12,9 @@ title: UserSkillEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **next_uri** | **String** | | [optional] |
|
|
16
15
|
| **first_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|