purecloudplatformclientv2 58.0.1 → 59.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/ActionEntityListing.md +1 -1
- data/docs/{Skill.md → AddressableEntityRef.md} +2 -2
- data/docs/Agent.md +1 -2
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/ArchitectApi.md +298 -14
- data/docs/AsyncConversationQuery.md +21 -0
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AuthzDivisionEntityListing.md +1 -1
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallHistoryConversation.md +1 -0
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- data/docs/CallHistoryParticipant.md +1 -0
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/CallbackConversationEntityListing.md +1 -1
- data/docs/CampaignDivisionViewListing.md +1 -1
- data/docs/CampaignEntityListing.md +1 -1
- data/docs/CampaignRuleEntityListing.md +1 -1
- data/docs/CampaignSequenceEntityListing.md +1 -1
- data/docs/CertificateAuthorityEntityListing.md +1 -1
- data/docs/ChatConversationEntityListing.md +1 -1
- data/docs/ClientAppEntityListing.md +1 -1
- data/docs/CobrowseConversationEntityListing.md +1 -1
- data/docs/CommandStatusEntityListing.md +1 -1
- data/docs/ConsumedResourcesEntityListing.md +1 -1
- data/docs/ConsumingResourcesEntityListing.md +1 -1
- data/docs/ContactListDivisionViewListing.md +1 -1
- data/docs/ContactListEntityListing.md +1 -1
- data/docs/ContactListFilterEntityListing.md +1 -1
- data/docs/ContactListing.md +1 -1
- data/docs/Conversation.md +1 -0
- data/docs/ConversationBasic.md +1 -0
- data/docs/ConversationChatEventTopicChatMediaParticipant.md +1 -0
- data/docs/ConversationEntityListing.md +1 -1
- data/docs/ConversationEventTopicChat.md +1 -0
- data/docs/ConversationProperties.md +1 -0
- data/docs/ConversationRoutingData.md +3 -3
- data/docs/CreateManagementUnitApiRequest.md +1 -1
- data/docs/CreateUser.md +1 -1
- data/docs/CredentialInfoListing.md +1 -1
- data/docs/CredentialTypeListing.md +1 -1
- data/docs/DIDEntityListing.md +1 -1
- data/docs/DIDPoolEntityListing.md +1 -1
- data/docs/DataSchema.md +4 -5
- data/docs/DataTableRowEntityListing.md +1 -1
- data/docs/DataTablesDomainEntityListing.md +1 -1
- data/docs/DependencyObjectEntityListing.md +1 -1
- data/docs/DependencyTypeEntityListing.md +1 -1
- data/docs/DialerEventEntityListing.md +1 -1
- data/docs/DialogflowAgent.md +18 -0
- data/docs/DialogflowAgentSummary.md +17 -0
- data/docs/DialogflowAgentSummaryEntityListing.md +22 -0
- data/docs/DialogflowIntent.md +14 -0
- data/docs/DialogflowParameter.md +14 -0
- data/docs/DialogflowProject.md +14 -0
- data/docs/DirectoryUserDevicesListing.md +1 -1
- data/docs/DncListDivisionViewListing.md +1 -1
- data/docs/DncListEntityListing.md +1 -1
- data/docs/DocumentAuditEntityListing.md +1 -1
- data/docs/DocumentEntityListing.md +1 -1
- data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
- data/docs/DomainEntityListing.md +1 -1
- data/docs/DomainEntityListingEvaluationForm.md +1 -1
- data/docs/DomainEntityListingQueryResult.md +1 -1
- data/docs/DomainEntityListingSurveyForm.md +1 -1
- data/docs/EdgeEntityListing.md +1 -1
- data/docs/EdgeGroupEntityListing.md +1 -1
- data/docs/EdgeLineEntityListing.md +1 -1
- data/docs/EmailConversationEntityListing.md +1 -1
- data/docs/EmailMediaParticipant.md +1 -0
- data/docs/EmailMessage.md +1 -0
- data/docs/EmailMessageListing.md +1 -1
- data/docs/EmergencyGroupListing.md +1 -1
- data/docs/EncryptionKeyEntityListing.md +1 -1
- data/docs/EvaluationEntityListing.md +1 -1
- data/docs/EvaluationFormEntityListing.md +1 -1
- data/docs/EvaluatorActivityEntityListing.md +1 -1
- data/docs/ExecuteRecordingJobsQuery.md +13 -0
- data/docs/ExtensionEntityListing.md +1 -1
- data/docs/ExtensionPoolEntityListing.md +1 -1
- data/docs/ExternalOrganizationListing.md +1 -1
- data/docs/FacebookIntegrationEntityListing.md +1 -1
- data/docs/FaxDocumentEntityListing.md +1 -1
- data/docs/FlowDivisionViewEntityListing.md +1 -1
- data/docs/FlowEntityListing.md +1 -1
- data/docs/FlowOutcome.md +17 -0
- data/docs/FlowOutcomeListing.md +22 -0
- data/docs/FlowVersionEntityListing.md +1 -1
- data/docs/GDPRRequestEntityListing.md +1 -1
- data/docs/GDPRSubjectEntityListing.md +1 -1
- data/docs/GreetingListing.md +1 -1
- data/docs/GroupEntityListing.md +1 -1
- data/docs/GroupProfileEntityListing.md +1 -1
- data/docs/IVREntityListing.md +1 -1
- data/docs/InboundDomainEntityListing.md +1 -1
- data/docs/InboundRouteEntityListing.md +1 -1
- data/docs/IntegrationEntityListing.md +1 -1
- data/docs/IntegrationEventEntityListing.md +1 -1
- data/docs/IntegrationTypeEntityListing.md +1 -1
- data/docs/IntegrationsApi.md +762 -0
- data/docs/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LanguageOverride.md +15 -0
- data/docs/LexBot.md +16 -0
- data/docs/LexBotAlias.md +21 -0
- data/docs/LexBotAliasEntityListing.md +22 -0
- data/docs/LexBotEntityListing.md +22 -0
- data/docs/LexIntent.md +16 -0
- data/docs/LexSlot.md +16 -0
- data/docs/LibraryEntityListing.md +1 -1
- data/docs/LineBaseEntityListing.md +1 -1
- data/docs/LineEntityListing.md +1 -1
- data/docs/LineIntegrationEntityListing.md +1 -1
- data/docs/LocationDefinition.md +2 -0
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LocationImage.md +14 -0
- data/docs/LocationsApi.md +6 -2
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnit.md +5 -6
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/MessageConversationEntityListing.md +1 -1
- data/docs/MessagingApi.md +1211 -134
- data/docs/MessagingIntegration.md +23 -0
- data/docs/MessagingIntegrationEntityListing.md +22 -0
- data/docs/MessagingStickerEntityListing.md +1 -1
- data/docs/MoveManagementUnitRequest.md +13 -0
- data/docs/MoveManagementUnitResponse.md +14 -0
- data/docs/NoteListing.md +1 -1
- data/docs/OAuthClientEntityListing.md +1 -1
- data/docs/OAuthProviderEntityListing.md +1 -1
- data/docs/OrganizationPresenceEntityListing.md +1 -1
- data/docs/OrganizationRoleEntityListing.md +1 -1
- data/docs/OrphanRecordingListing.md +1 -1
- data/docs/OutboundRouteBaseEntityListing.md +1 -1
- data/docs/OutboundRouteEntityListing.md +1 -1
- data/docs/PermissionCollectionEntityListing.md +1 -1
- data/docs/PhoneBaseEntityListing.md +1 -1
- data/docs/PhoneEntityListing.md +1 -1
- data/docs/PhoneMetaBaseEntityListing.md +1 -1
- data/docs/PhysicalInterfaceEntityListing.md +1 -1
- data/docs/PolicyEntityListing.md +1 -1
- data/docs/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- data/docs/QualityAudit.md +1 -0
- data/docs/QualityAuditPage.md +1 -1
- data/docs/QueueConversationChatEventTopicChatMediaParticipant.md +1 -0
- data/docs/QueueConversationEventTopicChat.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicChat.md +1 -0
- data/docs/QueueConversationVideoEventTopicChat.md +1 -0
- data/docs/QueueEntityListing.md +1 -1
- data/docs/QueueMemberEntityListing.md +1 -1
- data/docs/RecipientListing.md +1 -1
- data/docs/RecordingApi.md +335 -0
- data/docs/RecordingJob.md +23 -0
- data/docs/RecordingJobEntityListing.md +22 -0
- data/docs/RecordingJobsQuery.md +15 -0
- data/docs/RelationshipListing.md +1 -1
- data/docs/ReportMetaDataEntityListing.md +1 -1
- data/docs/ReportRunEntryEntityDomainListing.md +1 -1
- data/docs/ReportScheduleEntityListing.md +1 -1
- data/docs/ReportingExportJobListing.md +1 -1
- data/docs/ResponseEntityList.md +1 -1
- data/docs/ResponseEntityListing.md +1 -1
- data/docs/ResponseSetEntityListing.md +1 -1
- data/docs/RoutingApi.md +1 -1
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/SCIMApi.md +145 -145
- data/docs/ScheduleEntityListing.md +1 -1
- data/docs/ScheduleGroupEntityListing.md +1 -1
- data/docs/SchemaCategoryEntityListing.md +1 -1
- data/docs/SchemaReferenceEntityListing.md +1 -1
- data/docs/ScoredAgent.md +1 -1
- data/docs/ScreenRecordingSessionListing.md +1 -1
- data/docs/ScriptEntityListing.md +1 -1
- data/docs/SecurityProfileEntityListing.md +1 -1
- data/docs/ShareEntityListing.md +1 -1
- data/docs/SiteEntityListing.md +1 -1
- data/docs/SkillEntityListing.md +1 -1
- data/docs/SmsPhoneNumberEntityListing.md +1 -1
- data/docs/StationEntityListing.md +1 -1
- data/docs/SubjectDivisionGrantsEntityListing.md +1 -1
- data/docs/SubscriptionOverviewUsage.md +1 -0
- data/docs/SurveyFormEntityListing.md +1 -1
- data/docs/SystemPromptAssetEntityListing.md +1 -1
- data/docs/SystemPromptEntityListing.md +1 -1
- data/docs/TagValueEntityListing.md +1 -1
- data/docs/TextMessageListing.md +1 -1
- data/docs/TimeZoneEntityListing.md +1 -1
- data/docs/TrunkBaseEntityListing.md +1 -1
- data/docs/TrunkEntityListing.md +1 -1
- data/docs/TrunkMetabaseEntityListing.md +1 -1
- data/docs/TrustEntityListing.md +1 -1
- data/docs/TrustUserEntityListing.md +1 -1
- data/docs/TrustorEntityListing.md +1 -1
- data/docs/TtsEngineEntity.md +20 -0
- data/docs/TtsEngineEntityListing.md +22 -0
- data/docs/TtsSettings.md +14 -0
- data/docs/TtsVoiceEntity.md +19 -0
- data/docs/TtsVoiceEntityListing.md +22 -0
- data/docs/TwitterIntegrationEntityListing.md +1 -1
- data/docs/UpdateManagementUnitRequest.md +15 -0
- data/docs/UserActionCategoryEntityListing.md +1 -1
- data/docs/UserEntityListing.md +1 -1
- data/docs/UserLanguageEntityListing.md +1 -1
- data/docs/UserProfileEntityListing.md +1 -1
- data/docs/UserQueueEntityListing.md +1 -1
- data/docs/UserRecordingEntityListing.md +1 -1
- data/docs/UserSkillEntityListing.md +1 -1
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WebChatMemberInfoEntityList.md +1 -1
- data/docs/WfmMoveManagementUnitTopicBusinessUnit.md +13 -0
- data/docs/WfmMoveManagementUnitTopicMoveManagementUnitNotification.md +14 -0
- data/docs/WfmUserNotificationTopicTimeOffRequestNotification.md +18 -0
- data/docs/WfmUserNotificationTopicWfmUserNotification.md +1 -0
- data/docs/WorkforceManagementApi.md +158 -18
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +35 -1
- data/lib/purecloudplatformclientv2/api/architect_api.rb +334 -6
- data/lib/purecloudplatformclientv2/api/integrations_api.rb +851 -0
- data/lib/purecloudplatformclientv2/api/locations_api.rb +9 -0
- data/lib/purecloudplatformclientv2/api/messaging_api.rb +1111 -6
- data/lib/purecloudplatformclientv2/api/recording_api.rb +342 -0
- data/lib/purecloudplatformclientv2/api/routing_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api/scim_api.rb +124 -124
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +163 -21
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{skill.rb → addressable_entity_ref.rb} +1 -1
- data/lib/purecloudplatformclientv2/models/agent.rb +8 -32
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/async_conversation_query.rb +448 -0
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_history_conversation.rb +27 -1
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_history_participant.rb +30 -4
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/conversation.rb +29 -1
- data/lib/purecloudplatformclientv2/models/conversation_basic.rb +29 -1
- data/lib/purecloudplatformclientv2/models/conversation_chat_event_topic_chat_media_participant.rb +29 -4
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_properties.rb +27 -1
- data/lib/purecloudplatformclientv2/models/conversation_routing_data.rb +3 -3
- data/lib/purecloudplatformclientv2/models/create_management_unit_api_request.rb +1 -1
- data/lib/purecloudplatformclientv2/models/create_user.rb +5 -0
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_schema.rb +5 -31
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dialogflow_agent.rb +335 -0
- data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary.rb +305 -0
- data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/dialogflow_intent.rb +240 -0
- data/lib/purecloudplatformclientv2/models/dialogflow_parameter.rb +238 -0
- data/lib/purecloudplatformclientv2/models/dialogflow_project.rb +226 -0
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email_media_participant.rb +30 -4
- data/lib/purecloudplatformclientv2/models/email_message.rb +27 -1
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/execute_recording_jobs_query.rb +221 -0
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_outcome.rb +309 -0
- data/lib/purecloudplatformclientv2/models/flow_outcome_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/language_override.rb +269 -0
- data/lib/purecloudplatformclientv2/models/lex_bot.rb +279 -0
- data/lib/purecloudplatformclientv2/models/lex_bot_alias.rb +444 -0
- data/lib/purecloudplatformclientv2/models/lex_bot_alias_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/lex_bot_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/lex_intent.rb +297 -0
- data/lib/purecloudplatformclientv2/models/lex_slot.rb +290 -0
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/location_definition.rb +56 -1
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/location_image.rb +227 -0
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/management_unit.rb +21 -57
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/messaging_integration.rb +510 -0
- data/lib/purecloudplatformclientv2/models/messaging_integration_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/move_management_unit_request.rb +207 -0
- data/lib/purecloudplatformclientv2/models/move_management_unit_response.rb +242 -0
- data/lib/purecloudplatformclientv2/models/note_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/quality_audit.rb +26 -1
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue_conversation_chat_event_topic_chat_media_participant.rb +29 -4
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/recording_job.rb +480 -0
- data/lib/purecloudplatformclientv2/models/recording_job_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/recording_jobs_query.rb +283 -0
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +2 -2
- data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/scored_agent.rb +1 -1
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/subscription_overview_usage.rb +30 -4
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tts_engine_entity.rb +399 -0
- data/lib/purecloudplatformclientv2/models/tts_engine_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/tts_settings.rb +240 -0
- data/lib/purecloudplatformclientv2/models/tts_voice_entity.rb +372 -0
- data/lib/purecloudplatformclientv2/models/tts_voice_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/update_management_unit_request.rb +254 -0
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/wfm_move_management_unit_topic_business_unit.rb +201 -0
- data/lib/purecloudplatformclientv2/models/wfm_move_management_unit_topic_move_management_unit_notification.rb +240 -0
- data/lib/purecloudplatformclientv2/models/wfm_user_notification_topic_time_off_request_notification.rb +344 -0
- data/lib/purecloudplatformclientv2/models/wfm_user_notification_topic_wfm_user_notification.rb +28 -3
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +72 -4
|
@@ -13,8 +13,8 @@ title: UserProfileEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_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"}
|
|
@@ -13,8 +13,8 @@ title: UserQueueEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_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"}
|
|
@@ -13,8 +13,8 @@ title: UserRecordingEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_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"}
|
|
@@ -13,8 +13,8 @@ title: UserSkillEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_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"}
|
|
@@ -13,8 +13,8 @@ title: VoicemailMessageEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_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"}
|
|
@@ -13,8 +13,8 @@ title: WebChatMemberInfoEntityList
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_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,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: WfmMoveManagementUnitTopicBusinessUnit
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::WfmMoveManagementUnitTopicBusinessUnit
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | | [optional] |
|
|
11
|
+
{: class="table table-striped"}
|
|
12
|
+
|
|
13
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: WfmMoveManagementUnitTopicMoveManagementUnitNotification
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::WfmMoveManagementUnitTopicMoveManagementUnitNotification
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **business_unit** | [**WfmMoveManagementUnitTopicBusinessUnit**](WfmMoveManagementUnitTopicBusinessUnit.html) | | [optional] |
|
|
11
|
+
| **status** | **String** | | [optional] |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: WfmUserNotificationTopicTimeOffRequestNotification
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::WfmUserNotificationTopicTimeOffRequestNotification
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **time_off_request_id** | **String** | | [optional] |
|
|
11
|
+
| **user** | [**WfmUserNotificationTopicUserReference**](WfmUserNotificationTopicUserReference.html) | | [optional] |
|
|
12
|
+
| **is_full_day_request** | **BOOLEAN** | | [optional] |
|
|
13
|
+
| **status** | **String** | | [optional] |
|
|
14
|
+
| **partial_day_start_date_times** | **Array<DateTime>** | | [optional] |
|
|
15
|
+
| **full_day_management_unit_dates** | **Array<String>** | | [optional] |
|
|
16
|
+
{: class="table table-striped"}
|
|
17
|
+
|
|
18
|
+
|
|
@@ -12,6 +12,7 @@ title: WfmUserNotificationTopicWfmUserNotification
|
|
|
12
12
|
| **timestamp** | **DateTime** | | [optional] |
|
|
13
13
|
| **type** | **String** | | [optional] |
|
|
14
14
|
| **shift_trade** | [**WfmUserNotificationTopicShiftTradeNotification**](WfmUserNotificationTopicShiftTradeNotification.html) | | [optional] |
|
|
15
|
+
| **time_off_request** | [**WfmUserNotificationTopicTimeOffRequestNotification**](WfmUserNotificationTopicTimeOffRequestNotification.html) | | [optional] |
|
|
15
16
|
| **agent_notification** | **BOOLEAN** | | [optional] |
|
|
16
17
|
| **other_notification_ids_in_group** | **Array<String>** | | [optional] |
|
|
17
18
|
{: class="table table-striped"}
|
|
@@ -27,7 +27,7 @@ Method | Description
|
|
|
27
27
|
[**get_workforcemanagement_managementunit_scheduling_runs**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_scheduling_runs) | Get the status of all the ongoing schedule runs
|
|
28
28
|
[**get_workforcemanagement_managementunit_servicegoalgroup**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_servicegoalgroup) | Get a service goal group
|
|
29
29
|
[**get_workforcemanagement_managementunit_servicegoalgroups**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_servicegoalgroups) | Get service goal groups
|
|
30
|
-
[**get_workforcemanagement_managementunit_settings**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_settings) | Get the settings for the requested management unit
|
|
30
|
+
[**get_workforcemanagement_managementunit_settings**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_settings) | Get the settings for the requested management unit. Deprecated, use the GET management unit route instead
|
|
31
31
|
[**get_workforcemanagement_managementunit_shifttrades_matched**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_shifttrades_matched) | Gets a summary of all shift trades in the matched state
|
|
32
32
|
[**get_workforcemanagement_managementunit_shifttrades_users**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_shifttrades_users) | Gets list of users available for whom you can send direct shift trade requests
|
|
33
33
|
[**get_workforcemanagement_managementunit_user_timeoffrequest**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_user_timeoffrequest) | Get a time off request
|
|
@@ -47,10 +47,11 @@ Method | Description
|
|
|
47
47
|
[**get_workforcemanagement_shifttrades**](WorkforceManagementApi.html#get_workforcemanagement_shifttrades) | Gets all of my shift trades
|
|
48
48
|
[**get_workforcemanagement_timeoffrequest**](WorkforceManagementApi.html#get_workforcemanagement_timeoffrequest) | Get a time off request for the current user
|
|
49
49
|
[**get_workforcemanagement_timeoffrequests**](WorkforceManagementApi.html#get_workforcemanagement_timeoffrequests) | Get a list of time off requests for the current user
|
|
50
|
+
[**patch_workforcemanagement_managementunit**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit) | Update the requested management unit
|
|
50
51
|
[**patch_workforcemanagement_managementunit_activitycode**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_activitycode) | Update an activity code
|
|
51
52
|
[**patch_workforcemanagement_managementunit_scheduling_run**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_scheduling_run) | Marks a specific scheduling run as applied, allowing a new rescheduling run to be started
|
|
52
53
|
[**patch_workforcemanagement_managementunit_servicegoalgroup**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_servicegoalgroup) | Update a service goal group
|
|
53
|
-
[**patch_workforcemanagement_managementunit_settings**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_settings) |
|
|
54
|
+
[**patch_workforcemanagement_managementunit_settings**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_settings) | Update the settings for the requested management unit
|
|
54
55
|
[**patch_workforcemanagement_managementunit_user_timeoffrequest**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_user_timeoffrequest) | Update a time off request
|
|
55
56
|
[**patch_workforcemanagement_managementunit_week_schedule**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_week_schedule) | Update a week schedule
|
|
56
57
|
[**patch_workforcemanagement_managementunit_workplan**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_workplan) | Update a work plan
|
|
@@ -59,6 +60,7 @@ Method | Description
|
|
|
59
60
|
[**post_workforcemanagement_managementunit_activitycodes**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_activitycodes) | Create a new activity code
|
|
60
61
|
[**post_workforcemanagement_managementunit_historicaladherencequery**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_historicaladherencequery) | Request a historical adherence report
|
|
61
62
|
[**post_workforcemanagement_managementunit_intraday**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_intraday) | Get intraday data for the given date for the requested queueIds
|
|
63
|
+
[**post_workforcemanagement_managementunit_move**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_move) | Move the requested management unit to a new business unit
|
|
62
64
|
[**post_workforcemanagement_managementunit_schedules_search**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_schedules_search) | Query published schedules for given given time range for set of users
|
|
63
65
|
[**post_workforcemanagement_managementunit_servicegoalgroups**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_servicegoalgroups) | Create a new service goal group
|
|
64
66
|
[**post_workforcemanagement_managementunit_timeoffrequests**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_timeoffrequests) | Create a new time off request
|
|
@@ -115,7 +117,7 @@ end
|
|
|
115
117
|
|
|
116
118
|
api_instance = PureCloud::WorkforceManagementApi.new
|
|
117
119
|
|
|
118
|
-
mu_id = "mu_id_example" # String | The
|
|
120
|
+
mu_id = "mu_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
119
121
|
|
|
120
122
|
|
|
121
123
|
begin
|
|
@@ -130,7 +132,7 @@ end
|
|
|
130
132
|
|
|
131
133
|
Name | Type | Description | Notes
|
|
132
134
|
------------- | ------------- | ------------- | -------------
|
|
133
|
-
**mu_id** | **String**| The
|
|
135
|
+
**mu_id** | **String**| The ID of the management unit, or 'mine' for the management unit of the logged-in user. | |
|
|
134
136
|
{: class="table table-striped"}
|
|
135
137
|
|
|
136
138
|
|
|
@@ -759,10 +761,10 @@ end
|
|
|
759
761
|
|
|
760
762
|
api_instance = PureCloud::WorkforceManagementApi.new
|
|
761
763
|
|
|
762
|
-
mu_id = "mu_id_example" # String | The
|
|
764
|
+
mu_id = "mu_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
763
765
|
|
|
764
766
|
opts = {
|
|
765
|
-
expand: "expand_example" # String |
|
|
767
|
+
expand: ["expand_example"] # Array<String> |
|
|
766
768
|
}
|
|
767
769
|
|
|
768
770
|
begin
|
|
@@ -778,8 +780,8 @@ end
|
|
|
778
780
|
|
|
779
781
|
Name | Type | Description | Notes
|
|
780
782
|
------------- | ------------- | ------------- | -------------
|
|
781
|
-
**mu_id** | **String**| The
|
|
782
|
-
**expand** | **String
|
|
783
|
+
**mu_id** | **String**| The ID of the management unit, or 'mine' for the management unit of the logged-in user. | |
|
|
784
|
+
**expand** | [**Array<String>**](String.html)| | [optional] <br />**Values**: settings, settings.adherence, settings.timeOff, settings.scheduling, settings.shortTermForecasting, settings.shiftTrading |
|
|
783
785
|
{: class="table table-striped"}
|
|
784
786
|
|
|
785
787
|
|
|
@@ -1441,9 +1443,9 @@ Name | Type | Description | Notes
|
|
|
1441
1443
|
|
|
1442
1444
|
## [**ManagementUnitSettings**](ManagementUnitSettings.html) get_workforcemanagement_managementunit_settings(mu_id)
|
|
1443
1445
|
|
|
1446
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
|
1444
1447
|
|
|
1445
|
-
|
|
1446
|
-
Get the settings for the requested management unit
|
|
1448
|
+
Get the settings for the requested management unit. Deprecated, use the GET management unit route instead
|
|
1447
1449
|
|
|
1448
1450
|
|
|
1449
1451
|
|
|
@@ -1471,11 +1473,11 @@ end
|
|
|
1471
1473
|
|
|
1472
1474
|
api_instance = PureCloud::WorkforceManagementApi.new
|
|
1473
1475
|
|
|
1474
|
-
mu_id = "mu_id_example" # String | The
|
|
1476
|
+
mu_id = "mu_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
1475
1477
|
|
|
1476
1478
|
|
|
1477
1479
|
begin
|
|
1478
|
-
#Get the settings for the requested management unit
|
|
1480
|
+
#Get the settings for the requested management unit. Deprecated, use the GET management unit route instead
|
|
1479
1481
|
result = api_instance.get_workforcemanagement_managementunit_settings(mu_id)
|
|
1480
1482
|
p result
|
|
1481
1483
|
rescue PureCloud::ApiError => e
|
|
@@ -1487,7 +1489,7 @@ end
|
|
|
1487
1489
|
|
|
1488
1490
|
Name | Type | Description | Notes
|
|
1489
1491
|
------------- | ------------- | ------------- | -------------
|
|
1490
|
-
**mu_id** | **String**| The
|
|
1492
|
+
**mu_id** | **String**| The ID of the management unit, or 'mine' for the management unit of the logged-in user. | |
|
|
1491
1493
|
{: class="table table-striped"}
|
|
1492
1494
|
|
|
1493
1495
|
|
|
@@ -2416,7 +2418,7 @@ Name | Type | Description | Notes
|
|
|
2416
2418
|
**page_size** | **Integer**| | [optional] |
|
|
2417
2419
|
**page_number** | **Integer**| | [optional] |
|
|
2418
2420
|
**expand** | **String**| | [optional] <br />**Values**: details |
|
|
2419
|
-
**feature** | **String**| | [optional] <br />**Values**: AgentSchedule, AgentTimeOffRequest, ActivityCodes, Agents, BusinessUnits, HistoricalAdherence, IntradayMonitoring, ManagementUnits, RealTimeAdherence, Schedules, ServiceGoalGroups, ServiceGoalTemplates, ShiftTrading, ShortTermForecasts, TimeOffRequests, WorkPlans |
|
|
2421
|
+
**feature** | **String**| | [optional] <br />**Values**: AgentSchedule, AgentTimeOffRequest, ActivityCodes, Agents, BusinessUnitActivityCodes, BusinessUnits, HistoricalAdherence, IntradayMonitoring, ManagementUnits, RealTimeAdherence, Schedules, ServiceGoalGroups, ServiceGoalTemplates, ShiftTrading, ShortTermForecasts, TimeOffRequests, WorkPlans |
|
|
2420
2422
|
**division_id** | **String**| | [optional] |
|
|
2421
2423
|
{: class="table table-striped"}
|
|
2422
2424
|
|
|
@@ -2815,6 +2817,75 @@ Name | Type | Description | Notes
|
|
|
2815
2817
|
|
|
2816
2818
|
|
|
2817
2819
|
|
|
2820
|
+
<a name="patch_workforcemanagement_managementunit"></a>
|
|
2821
|
+
|
|
2822
|
+
## [**ManagementUnit**](ManagementUnit.html) patch_workforcemanagement_managementunit(mu_id, opts)
|
|
2823
|
+
|
|
2824
|
+
|
|
2825
|
+
|
|
2826
|
+
Update the requested management unit
|
|
2827
|
+
|
|
2828
|
+
|
|
2829
|
+
|
|
2830
|
+
Wraps PATCH /api/v2/workforcemanagement/managementunits/{muId}
|
|
2831
|
+
|
|
2832
|
+
Requires ANY permissions:
|
|
2833
|
+
|
|
2834
|
+
* wfm:managementUnit:edit
|
|
2835
|
+
|
|
2836
|
+
|
|
2837
|
+
### Example
|
|
2838
|
+
```{"language":"ruby"}
|
|
2839
|
+
# load the gem
|
|
2840
|
+
require 'purecloudplatformclientv2'
|
|
2841
|
+
# setup authorization
|
|
2842
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2843
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2844
|
+
environment = "mypurecloud.com"
|
|
2845
|
+
|
|
2846
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2847
|
+
|
|
2848
|
+
PureCloud.configure do |config|
|
|
2849
|
+
config.access_token = @authToken
|
|
2850
|
+
end
|
|
2851
|
+
|
|
2852
|
+
api_instance = PureCloud::WorkforceManagementApi.new
|
|
2853
|
+
|
|
2854
|
+
mu_id = "mu_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
2855
|
+
|
|
2856
|
+
opts = {
|
|
2857
|
+
body: PureCloud::UpdateManagementUnitRequest.new # UpdateManagementUnitRequest | body
|
|
2858
|
+
}
|
|
2859
|
+
|
|
2860
|
+
begin
|
|
2861
|
+
#Update the requested management unit
|
|
2862
|
+
result = api_instance.patch_workforcemanagement_managementunit(mu_id, opts)
|
|
2863
|
+
p result
|
|
2864
|
+
rescue PureCloud::ApiError => e
|
|
2865
|
+
puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit: #{e}"
|
|
2866
|
+
end
|
|
2867
|
+
```
|
|
2868
|
+
|
|
2869
|
+
### Parameters
|
|
2870
|
+
|
|
2871
|
+
Name | Type | Description | Notes
|
|
2872
|
+
------------- | ------------- | ------------- | -------------
|
|
2873
|
+
**mu_id** | **String**| The ID of the management unit, or 'mine' for the management unit of the logged-in user. | |
|
|
2874
|
+
**body** | [**UpdateManagementUnitRequest**](UpdateManagementUnitRequest.html)| body | [optional] |
|
|
2875
|
+
{: class="table table-striped"}
|
|
2876
|
+
|
|
2877
|
+
|
|
2878
|
+
### Return type
|
|
2879
|
+
|
|
2880
|
+
[**ManagementUnit**](ManagementUnit.html)
|
|
2881
|
+
|
|
2882
|
+
### HTTP request headers
|
|
2883
|
+
|
|
2884
|
+
- **Content-Type**: application/json
|
|
2885
|
+
- **Accept**: application/json
|
|
2886
|
+
|
|
2887
|
+
|
|
2888
|
+
|
|
2818
2889
|
<a name="patch_workforcemanagement_managementunit_activitycode"></a>
|
|
2819
2890
|
|
|
2820
2891
|
## [**ActivityCode**](ActivityCode.html) patch_workforcemanagement_managementunit_activitycode(mu_id, ac_id, opts)
|
|
@@ -3037,7 +3108,7 @@ Name | Type | Description | Notes
|
|
|
3037
3108
|
|
|
3038
3109
|
|
|
3039
3110
|
|
|
3040
|
-
|
|
3111
|
+
Update the settings for the requested management unit
|
|
3041
3112
|
|
|
3042
3113
|
|
|
3043
3114
|
|
|
@@ -3065,14 +3136,14 @@ end
|
|
|
3065
3136
|
|
|
3066
3137
|
api_instance = PureCloud::WorkforceManagementApi.new
|
|
3067
3138
|
|
|
3068
|
-
mu_id = "mu_id_example" # String | The
|
|
3139
|
+
mu_id = "mu_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
3069
3140
|
|
|
3070
3141
|
opts = {
|
|
3071
3142
|
body: PureCloud::ManagementUnitSettings.new # ManagementUnitSettings | config
|
|
3072
3143
|
}
|
|
3073
3144
|
|
|
3074
3145
|
begin
|
|
3075
|
-
#
|
|
3146
|
+
#Update the settings for the requested management unit
|
|
3076
3147
|
result = api_instance.patch_workforcemanagement_managementunit_settings(mu_id, opts)
|
|
3077
3148
|
p result
|
|
3078
3149
|
rescue PureCloud::ApiError => e
|
|
@@ -3084,7 +3155,7 @@ end
|
|
|
3084
3155
|
|
|
3085
3156
|
Name | Type | Description | Notes
|
|
3086
3157
|
------------- | ------------- | ------------- | -------------
|
|
3087
|
-
**mu_id** | **String**| The
|
|
3158
|
+
**mu_id** | **String**| The ID of the management unit, or 'mine' for the management unit of the logged-in user. | |
|
|
3088
3159
|
**body** | [**ManagementUnitSettings**](ManagementUnitSettings.html)| config | [optional] |
|
|
3089
3160
|
{: class="table table-striped"}
|
|
3090
3161
|
|
|
@@ -3668,6 +3739,75 @@ Name | Type | Description | Notes
|
|
|
3668
3739
|
|
|
3669
3740
|
|
|
3670
3741
|
|
|
3742
|
+
<a name="post_workforcemanagement_managementunit_move"></a>
|
|
3743
|
+
|
|
3744
|
+
## [**MoveManagementUnitResponse**](MoveManagementUnitResponse.html) post_workforcemanagement_managementunit_move(mu_id, opts)
|
|
3745
|
+
|
|
3746
|
+
|
|
3747
|
+
|
|
3748
|
+
Move the requested management unit to a new business unit
|
|
3749
|
+
|
|
3750
|
+
Returns status 200 if the management unit is already in the requested business unit
|
|
3751
|
+
|
|
3752
|
+
Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/move
|
|
3753
|
+
|
|
3754
|
+
Requires ANY permissions:
|
|
3755
|
+
|
|
3756
|
+
* wfm:managementUnit:edit
|
|
3757
|
+
|
|
3758
|
+
|
|
3759
|
+
### Example
|
|
3760
|
+
```{"language":"ruby"}
|
|
3761
|
+
# load the gem
|
|
3762
|
+
require 'purecloudplatformclientv2'
|
|
3763
|
+
# setup authorization
|
|
3764
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3765
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3766
|
+
environment = "mypurecloud.com"
|
|
3767
|
+
|
|
3768
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3769
|
+
|
|
3770
|
+
PureCloud.configure do |config|
|
|
3771
|
+
config.access_token = @authToken
|
|
3772
|
+
end
|
|
3773
|
+
|
|
3774
|
+
api_instance = PureCloud::WorkforceManagementApi.new
|
|
3775
|
+
|
|
3776
|
+
mu_id = "mu_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
3777
|
+
|
|
3778
|
+
opts = {
|
|
3779
|
+
body: PureCloud::MoveManagementUnitRequest.new # MoveManagementUnitRequest | body
|
|
3780
|
+
}
|
|
3781
|
+
|
|
3782
|
+
begin
|
|
3783
|
+
#Move the requested management unit to a new business unit
|
|
3784
|
+
result = api_instance.post_workforcemanagement_managementunit_move(mu_id, opts)
|
|
3785
|
+
p result
|
|
3786
|
+
rescue PureCloud::ApiError => e
|
|
3787
|
+
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_move: #{e}"
|
|
3788
|
+
end
|
|
3789
|
+
```
|
|
3790
|
+
|
|
3791
|
+
### Parameters
|
|
3792
|
+
|
|
3793
|
+
Name | Type | Description | Notes
|
|
3794
|
+
------------- | ------------- | ------------- | -------------
|
|
3795
|
+
**mu_id** | **String**| The ID of the management unit, or 'mine' for the management unit of the logged-in user. | |
|
|
3796
|
+
**body** | [**MoveManagementUnitRequest**](MoveManagementUnitRequest.html)| body | [optional] |
|
|
3797
|
+
{: class="table table-striped"}
|
|
3798
|
+
|
|
3799
|
+
|
|
3800
|
+
### Return type
|
|
3801
|
+
|
|
3802
|
+
[**MoveManagementUnitResponse**](MoveManagementUnitResponse.html)
|
|
3803
|
+
|
|
3804
|
+
### HTTP request headers
|
|
3805
|
+
|
|
3806
|
+
- **Content-Type**: application/json
|
|
3807
|
+
- **Accept**: application/json
|
|
3808
|
+
|
|
3809
|
+
|
|
3810
|
+
|
|
3671
3811
|
<a name="post_workforcemanagement_managementunit_schedules_search"></a>
|
|
3672
3812
|
|
|
3673
3813
|
## [**UserScheduleContainer**](UserScheduleContainer.html) post_workforcemanagement_managementunit_schedules_search(mu_id, opts)
|
|
@@ -13,8 +13,8 @@ title: WorkspaceEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_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"}
|
|
@@ -13,8 +13,8 @@ title: WorkspaceMemberEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_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"}
|
|
@@ -13,8 +13,8 @@ title: WrapupCodeEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_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"}
|