purecloudplatformclientv2 43.1.0 → 44.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/ActionEntityListing.md +1 -1
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/AnalyticsSurvey.md +6 -5
- data/docs/ArchitectApi.md +14 -14
- data/docs/{JsonNode.md → ArrayNode.md} +2 -2
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AttributeEntityListing.md +1 -1
- data/docs/AuthzDivisionEntityListing.md +1 -1
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- 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/ContactListEntityListing.md +1 -1
- data/docs/ContactListFilterEntityListing.md +1 -1
- data/docs/ContactListing.md +1 -1
- data/docs/ConversationEntityListing.md +1 -1
- data/docs/ConversationsApi.md +66 -0
- data/docs/CreateOutboundMessagingConversationRequest.md +18 -0
- data/docs/CreateQueueRequest.md +1 -0
- data/docs/CreateUser.md +1 -0
- 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/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/DirectoryUserDevicesListing.md +1 -1
- data/docs/DncListCreate.md +7 -7
- 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/EmailMessageListing.md +1 -1
- data/docs/EmergencyGroupListing.md +1 -1
- data/docs/EncryptionKeyEntityListing.md +1 -1
- data/docs/EndpointEntityListing.md +1 -1
- data/docs/EvaluationEntityListing.md +1 -1
- data/docs/EvaluationFormEntityListing.md +1 -1
- data/docs/EvaluatorActivityEntityListing.md +1 -1
- 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/FacebookIntegrationRequest.md +3 -3
- data/docs/FaxDocumentEntityListing.md +1 -1
- data/docs/FlowDivisionViewEntityListing.md +1 -1
- data/docs/FlowEntityListing.md +1 -1
- 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/HeadcountForecast.md +14 -0
- data/docs/{HeadcountIntervalResponse.md → HeadcountInterval.md} +4 -4
- 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/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/IntradayDataUpdateNotificationDateTime.md +1 -1
- data/docs/IntradayDataUpdateNotificationStartDate.md +1 -1
- data/docs/JsonNodeSearchResponse.md +2 -2
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- 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/LineIntegrationRequest.md +0 -1
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/MessageConversationEntityListing.md +1 -1
- data/docs/MessagingApi.md +0 -64
- data/docs/MessagingStickerEntityListing.md +1 -1
- 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/OutboundApi.md +66 -66
- 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/QualityApi.md +9 -3
- data/docs/QualityAuditPage.md +1 -1
- data/docs/Queue.md +1 -0
- data/docs/QueueEntityListing.md +1 -1
- data/docs/QueueMemberEntityListing.md +1 -1
- data/docs/QueueMessagingAddresses.md +13 -0
- data/docs/QueueRequest.md +1 -0
- data/docs/Recipient.md +1 -0
- data/docs/RecipientListing.md +1 -1
- 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/RescheduleRequest.md +20 -0
- data/docs/RescheduleResult.md +13 -0
- data/docs/ReschedulingOptionsResponse.md +22 -0
- data/docs/ResponseEntityList.md +1 -1
- data/docs/ResponseEntityListing.md +1 -1
- data/docs/ResponseSetEntityListing.md +1 -1
- data/docs/RoutingApi.md +2 -0
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/ScheduleEntityListing.md +1 -1
- data/docs/ScheduleGroupEntityListing.md +1 -1
- data/docs/SchedulingRunResponse.md +8 -2
- data/docs/SchemaCategoryEntityListing.md +1 -1
- data/docs/SchemaReferenceEntityListing.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/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/TimeZoneMappingPreview.md +21 -0
- 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/TwitterIntegrationEntityListing.md +1 -1
- data/docs/UnscheduledAgentWarning.md +14 -0
- data/docs/UpdateSchedulingRunRequest.md +13 -0
- data/docs/UpdateWeekScheduleRequest.md +3 -1
- 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/UserQueue.md +1 -0
- data/docs/UserQueueEntityListing.md +1 -1
- data/docs/UserRecordingEntityListing.md +1 -1
- data/docs/UserScheduleAdherenceUpdateNotificationDateTime.md +1 -1
- data/docs/UserSkillEntityListing.md +1 -1
- data/docs/ViewFilter.md +2 -0
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WeekSchedule.md +1 -1
- data/docs/WorkforceManagementApi.md +288 -0
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +11 -3
- data/lib/purecloudplatformclientv2/api/architect_api.rb +6 -6
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +65 -0
- data/lib/purecloudplatformclientv2/api/messaging_api.rb +0 -64
- data/lib/purecloudplatformclientv2/api/outbound_api.rb +65 -65
- data/lib/purecloudplatformclientv2/api/quality_api.rb +27 -0
- data/lib/purecloudplatformclientv2/api/routing_api.rb +13 -0
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +326 -0
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/analytics_survey.rb +83 -51
- data/lib/purecloudplatformclientv2/models/{json_node.rb → array_node.rb} +1 -1
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/attribute_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/create_outbound_messaging_conversation_request.rb +361 -0
- data/lib/purecloudplatformclientv2/models/create_queue_request.rb +27 -1
- data/lib/purecloudplatformclientv2/models/create_user.rb +30 -4
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +14 -14
- 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 +14 -14
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dnc_list_create.rb +12 -7
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +14 -14
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/endpoint_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/facebook_integration_request.rb +3 -3
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/{headcount_forecast_response.rb → headcount_forecast.rb} +13 -3
- data/lib/purecloudplatformclientv2/models/{headcount_interval_response.rb → headcount_interval.rb} +12 -2
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +14 -14
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +14 -14
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_date_time.rb +17 -17
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_start_date.rb +17 -17
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/json_node_search_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/line_integration_request.rb +1 -27
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/note_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +14 -14
- data/lib/purecloudplatformclientv2/models/queue.rb +27 -1
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/queue_messaging_addresses.rb +201 -0
- data/lib/purecloudplatformclientv2/models/queue_request.rb +27 -1
- data/lib/purecloudplatformclientv2/models/recipient.rb +41 -1
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/reschedule_request.rb +418 -0
- data/lib/purecloudplatformclientv2/models/reschedule_result.rb +202 -0
- data/lib/purecloudplatformclientv2/models/rescheduling_options_response.rb +470 -0
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +14 -14
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/scheduling_run_response.rb +164 -6
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/time_zone_mapping_preview.rb +414 -0
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/unscheduled_agent_warning.rb +242 -0
- data/lib/purecloudplatformclientv2/models/update_scheduling_run_request.rb +202 -0
- data/lib/purecloudplatformclientv2/models/update_week_schedule_request.rb +54 -2
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_queue.rb +27 -1
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_schedule_adherence_update_notification_date_time.rb +17 -17
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/view_filter.rb +57 -1
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/week_schedule.rb +1 -1
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +24 -8
- data/docs/HeadcountForecastResponse.md +0 -14
data/docs/TextMessageListing.md
CHANGED
|
@@ -13,9 +13,9 @@ title: TextMessageListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: TimeZoneEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: TimeZoneMappingPreview
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::TimeZoneMappingPreview
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **contact_list** | [**UriReference**](UriReference.html) | The associated ContactList | [optional] |
|
|
11
|
+
| **contacts_per_time_zone** | **Hash<String, Integer>** | The number of contacts per time zone that mapped to only that time zone | [optional] |
|
|
12
|
+
| **contacts_mapped_using_zip_code** | **Hash<String, Integer>** | The number of contacts per time zone that mapped to only that time zone and were mapped using the zip code column | [optional] |
|
|
13
|
+
| **contacts_mapped_to_a_single_zone** | **Integer** | The total number of contacts that mapped to a single time zone | [optional] |
|
|
14
|
+
| **contacts_mapped_to_a_single_zone_using_zip_code** | **Integer** | The total number of contacts that mapped to a single time zone and were mapped using the zip code column | [optional] |
|
|
15
|
+
| **contacts_mapped_to_multiple_zones** | **Integer** | The total number of contacts that mapped to multiple time zones | [optional] |
|
|
16
|
+
| **contacts_mapped_to_multiple_zones_using_zip_code** | **Integer** | The total number of contacts that mapped to multiple time zones and were mapped using the zip code column | [optional] |
|
|
17
|
+
| **contacts_in_default_window** | **Integer** | The total number of contacts that will be dialed during the default window | [optional] |
|
|
18
|
+
| **contact_list_size** | **Integer** | The total number of contacts in the contact list | [optional] |
|
|
19
|
+
{: class="table table-striped"}
|
|
20
|
+
|
|
21
|
+
|
|
@@ -13,9 +13,9 @@ title: TrunkBaseEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/TrunkEntityListing.md
CHANGED
|
@@ -13,9 +13,9 @@ title: TrunkEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: TrunkMetabaseEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/TrustEntityListing.md
CHANGED
|
@@ -13,9 +13,9 @@ title: TrustEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: TrustUserEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: TrustorEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: TwitterIntegrationEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: UnscheduledAgentWarning
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::UnscheduledAgentWarning
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **agent** | [**UserReference**](UserReference.html) | The agent for which this warning applies | [optional] |
|
|
11
|
+
| **unscheduled_reason** | **String** | The reason this agent was not scheduled | [optional] |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: UpdateSchedulingRunRequest
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::UpdateSchedulingRunRequest
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **applied** | **BOOLEAN** | Mark the run as applied. Request will be rejected if the value != true. Note: To discard a run without applying, you still need to mark it as applied so that other reschedule runs can be done | [optional] |
|
|
11
|
+
{: class="table table-striped"}
|
|
12
|
+
|
|
13
|
+
|
|
@@ -13,7 +13,9 @@ title: UpdateWeekScheduleRequest
|
|
|
13
13
|
| **partial_upload_ids** | **Array<String>** | IDs of partial uploads to include in this imported schedule. It is applicable only for large schedules where activity count in schedule is greater than 17500 | [optional] |
|
|
14
14
|
| **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Version metadata for this work plan | |
|
|
15
15
|
| **agent_schedules_version** | **Integer** | Version of agent schedules in the week schedule | |
|
|
16
|
-
| **
|
|
16
|
+
| **short_term_forecast** | [**ShortTermForecastReference**](ShortTermForecastReference.html) | Reference to optionally point the schedule at a new short term forecast | [optional] |
|
|
17
|
+
| **headcount_forecast** | [**HeadcountForecast**](HeadcountForecast.html) | The headcount forecast associated with the schedule. If not null, existing values will be irrecoverably replaced | [optional] |
|
|
18
|
+
| **agent_update_filter** | **String** | For a published schedule, this determines whether a notification will be shown to agents in the default PureCloud user interface. The CPC notification will always be sent and the value specified here affects what data is returned in the 'updates' property. In the default PureCloud UI, \"None\" means that agents will not be notified, \"ShiftTimesOnly\" means agents will only be notified for changes to shift start and end times, and \"All\" means that agents will be notified for any change to a shift or activity (except for full day off activities). When building a custom client, use this property to specify the level of detail you need. Defaults to \"ShiftTimesOnly\". | [optional] |
|
|
17
19
|
{: class="table table-striped"}
|
|
18
20
|
|
|
19
21
|
|
|
@@ -13,9 +13,9 @@ title: UserActionCategoryEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/UserEntityListing.md
CHANGED
|
@@ -13,9 +13,9 @@ title: UserEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: UserLanguageEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: UserProfileEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/UserQueue.md
CHANGED
|
@@ -28,6 +28,7 @@ title: UserQueue
|
|
|
28
28
|
| **calling_party_name** | **String** | The name to use for caller identification for outbound calls from this queue. | [optional] |
|
|
29
29
|
| **calling_party_number** | **String** | The phone number to use for caller identification for outbound calls from this queue. | [optional] |
|
|
30
30
|
| **default_scripts** | [**Hash<String, Script>**](Script.html) | The default script Ids for the communication types. | [optional] |
|
|
31
|
+
| **outbound_messaging_addresses** | [**QueueMessagingAddresses**](QueueMessagingAddresses.html) | The messaging addresses for the queue. | [optional] |
|
|
31
32
|
| **outbound_email_address** | [**QueueEmailAddress**](QueueEmailAddress.html) | | [optional] |
|
|
32
33
|
| **joined** | **BOOLEAN** | | [optional] |
|
|
33
34
|
| **member_count** | **Integer** | | [optional] |
|
|
@@ -13,9 +13,9 @@ title: UserQueueEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: UserRecordingEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -8,9 +8,9 @@ title: UserScheduleAdherenceUpdateNotificationDateTime
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **i_millis** | **Integer** | | [optional] |
|
|
11
|
+
| **before_now** | **BOOLEAN** | | [optional] |
|
|
11
12
|
| **after_now** | **BOOLEAN** | | [optional] |
|
|
12
13
|
| **equal_now** | **BOOLEAN** | | [optional] |
|
|
13
|
-
| **before_now** | **BOOLEAN** | | [optional] |
|
|
14
14
|
{: class="table table-striped"}
|
|
15
15
|
|
|
16
16
|
|
|
@@ -13,9 +13,9 @@ title: UserSkillEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/ViewFilter.md
CHANGED
|
@@ -16,6 +16,8 @@ title: ViewFilter
|
|
|
16
16
|
| **directions** | **Array<String>** | The directions are used to filter the view | [optional] |
|
|
17
17
|
| **wrap_up_codes** | **Array<String>** | The wrap up codes are used to filter the view | [optional] |
|
|
18
18
|
| **dnis_list** | **Array<String>** | The dnis list is used to filter the view | [optional] |
|
|
19
|
+
| **filter_queues_by_user_ids** | **Array<String>** | The user ids are used to fetch associated queues for the view | [optional] |
|
|
20
|
+
| **filter_users_by_queue_ids** | **Array<String>** | The queue ids are used to fetch associated users for the view | [optional] |
|
|
19
21
|
| **user_ids** | **Array<String>** | The user ids are used to filter the view | [optional] |
|
|
20
22
|
| **address_tos** | **Array<String>** | The address To values are used to filter the view | [optional] |
|
|
21
23
|
| **address_froms** | **Array<String>** | The address from values are used to filter the view | [optional] |
|
|
@@ -13,9 +13,9 @@ title: VoicemailMessageEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/WeekSchedule.md
CHANGED
|
@@ -15,7 +15,7 @@ title: WeekSchedule
|
|
|
15
15
|
| **short_term_forecast** | [**ShortTermForecastReference**](ShortTermForecastReference.html) | Short term forecast associated with this schedule | [optional] |
|
|
16
16
|
| **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Version metadata for this work plan | [optional] |
|
|
17
17
|
| **user_schedules** | [**Hash<String, UserSchedule>**](UserSchedule.html) | User schedules in the week | [optional] |
|
|
18
|
-
| **headcount_forecast** | [**
|
|
18
|
+
| **headcount_forecast** | [**HeadcountForecast**](HeadcountForecast.html) | Headcount information for the week schedule | [optional] |
|
|
19
19
|
| **agent_schedules_version** | **Integer** | Version of agent schedules in the week schedule | [optional] |
|
|
20
20
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
21
21
|
{: class="table table-striped"}
|
|
@@ -21,6 +21,8 @@ Method | Description
|
|
|
21
21
|
[**get_workforcemanagement_managementunit_activitycodes**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_activitycodes) | Get activity codes
|
|
22
22
|
[**get_workforcemanagement_managementunit_agent**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_agent) | Get data for agent in the management unit
|
|
23
23
|
[**get_workforcemanagement_managementunit_intraday_queues**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_intraday_queues) | Get intraday queues for the given date
|
|
24
|
+
[**get_workforcemanagement_managementunit_scheduling_run**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_scheduling_run) | Gets the status for a specific scheduling run
|
|
25
|
+
[**get_workforcemanagement_managementunit_scheduling_run_result**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_scheduling_run_result) | Gets the result of a specific scheduling run
|
|
24
26
|
[**get_workforcemanagement_managementunit_scheduling_runs**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_scheduling_runs) | Get the status of all the ongoing schedule runs
|
|
25
27
|
[**get_workforcemanagement_managementunit_servicegoalgroup**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_servicegoalgroup) | Get a service goal group
|
|
26
28
|
[**get_workforcemanagement_managementunit_servicegoalgroups**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_servicegoalgroups) | Get service goal groups
|
|
@@ -40,6 +42,7 @@ Method | Description
|
|
|
40
42
|
[**get_workforcemanagement_timeoffrequest**](WorkforceManagementApi.html#get_workforcemanagement_timeoffrequest) | Get a time off request for the current user
|
|
41
43
|
[**get_workforcemanagement_timeoffrequests**](WorkforceManagementApi.html#get_workforcemanagement_timeoffrequests) | Get a list of time off requests for the current user
|
|
42
44
|
[**patch_workforcemanagement_managementunit_activitycode**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_activitycode) | Update an activity code
|
|
45
|
+
[**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
|
|
43
46
|
[**patch_workforcemanagement_managementunit_servicegoalgroup**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_servicegoalgroup) | Update a service goal group
|
|
44
47
|
[**patch_workforcemanagement_managementunit_settings**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_settings) | Patch the settings for the requested management unit
|
|
45
48
|
[**patch_workforcemanagement_managementunit_user_timeoffrequest**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_user_timeoffrequest) | Update a time off request
|
|
@@ -56,6 +59,7 @@ Method | Description
|
|
|
56
59
|
[**post_workforcemanagement_managementunit_timeoffrequests_fetchdetails**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_timeoffrequests_fetchdetails) | Gets a list of time off requests from lookup ids
|
|
57
60
|
[**post_workforcemanagement_managementunit_timeoffrequests_query**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_timeoffrequests_query) | Gets the lookup ids to fetch the specified set of requests
|
|
58
61
|
[**post_workforcemanagement_managementunit_week_schedule_copy**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_schedule_copy) | Copy a week schedule
|
|
62
|
+
[**post_workforcemanagement_managementunit_week_schedule_reschedule**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_schedule_reschedule) | Start a scheduling run to compute the reschedule. When the scheduling run finishes, a client can get the reschedule changes and then the client can apply them to the schedule, save the schedule, and mark the scheduling run as applied
|
|
59
63
|
[**post_workforcemanagement_managementunit_week_schedules**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_schedules) | Add a schedule for a week in management unit using imported data. Use partial uploads of user schedules if activity count in schedule is greater than 17500
|
|
60
64
|
[**post_workforcemanagement_managementunit_week_schedules_generate**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_schedules_generate) | Generate a week schedule
|
|
61
65
|
[**post_workforcemanagement_managementunit_week_schedules_partialupload**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_schedules_partialupload) | Partial upload of user schedules where activity count is greater than 17500
|
|
@@ -1039,6 +1043,142 @@ Name | Type | Description | Notes
|
|
|
1039
1043
|
|
|
1040
1044
|
|
|
1041
1045
|
|
|
1046
|
+
<a name="get_workforcemanagement_managementunit_scheduling_run"></a>
|
|
1047
|
+
|
|
1048
|
+
## -[**SchedulingRunResponse**](SchedulingRunResponse.html) get_workforcemanagement_managementunit_scheduling_run(management_unit_id, run_id)
|
|
1049
|
+
|
|
1050
|
+
|
|
1051
|
+
|
|
1052
|
+
Gets the status for a specific scheduling run
|
|
1053
|
+
|
|
1054
|
+
|
|
1055
|
+
|
|
1056
|
+
Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}
|
|
1057
|
+
|
|
1058
|
+
Requires ANY permissions:
|
|
1059
|
+
|
|
1060
|
+
* wfm:schedule:generate
|
|
1061
|
+
|
|
1062
|
+
|
|
1063
|
+
### Example
|
|
1064
|
+
~~~ruby
|
|
1065
|
+
# load the gem
|
|
1066
|
+
require 'purecloudplatformclientv2'
|
|
1067
|
+
# setup authorization
|
|
1068
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1069
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1070
|
+
environment = "mypurecloud.com"
|
|
1071
|
+
|
|
1072
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1073
|
+
|
|
1074
|
+
PureCloud.configure do |config|
|
|
1075
|
+
config.access_token = @authToken
|
|
1076
|
+
end
|
|
1077
|
+
|
|
1078
|
+
api_instance = PureCloud::WorkforceManagementApi.new
|
|
1079
|
+
|
|
1080
|
+
management_unit_id = "management_unit_id_example" # String | The ID of the management unit.
|
|
1081
|
+
|
|
1082
|
+
run_id = "run_id_example" # String | The ID of the schedule run
|
|
1083
|
+
|
|
1084
|
+
|
|
1085
|
+
begin
|
|
1086
|
+
#Gets the status for a specific scheduling run
|
|
1087
|
+
result = api_instance.get_workforcemanagement_managementunit_scheduling_run(management_unit_id, run_id)
|
|
1088
|
+
p result
|
|
1089
|
+
rescue PureCloud::ApiError => e
|
|
1090
|
+
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_scheduling_run: #{e}"
|
|
1091
|
+
end
|
|
1092
|
+
~~~
|
|
1093
|
+
|
|
1094
|
+
### Parameters
|
|
1095
|
+
|
|
1096
|
+
Name | Type | Description | Notes
|
|
1097
|
+
------------- | ------------- | ------------- | -------------
|
|
1098
|
+
**management_unit_id** | **String**| The ID of the management unit. | |
|
|
1099
|
+
**run_id** | **String**| The ID of the schedule run | |
|
|
1100
|
+
{: class="table table-striped"}
|
|
1101
|
+
|
|
1102
|
+
|
|
1103
|
+
### Return type
|
|
1104
|
+
|
|
1105
|
+
[**SchedulingRunResponse**](SchedulingRunResponse.html)
|
|
1106
|
+
|
|
1107
|
+
### HTTP request headers
|
|
1108
|
+
|
|
1109
|
+
- **Content-Type**: application/json
|
|
1110
|
+
- **Accept**: application/json
|
|
1111
|
+
|
|
1112
|
+
|
|
1113
|
+
|
|
1114
|
+
<a name="get_workforcemanagement_managementunit_scheduling_run_result"></a>
|
|
1115
|
+
|
|
1116
|
+
## -[**RescheduleResult**](RescheduleResult.html) get_workforcemanagement_managementunit_scheduling_run_result(management_unit_id, run_id)
|
|
1117
|
+
|
|
1118
|
+
|
|
1119
|
+
|
|
1120
|
+
Gets the result of a specific scheduling run
|
|
1121
|
+
|
|
1122
|
+
|
|
1123
|
+
|
|
1124
|
+
Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}/result
|
|
1125
|
+
|
|
1126
|
+
Requires ANY permissions:
|
|
1127
|
+
|
|
1128
|
+
* wfm:schedule:generate
|
|
1129
|
+
|
|
1130
|
+
|
|
1131
|
+
### Example
|
|
1132
|
+
~~~ruby
|
|
1133
|
+
# load the gem
|
|
1134
|
+
require 'purecloudplatformclientv2'
|
|
1135
|
+
# setup authorization
|
|
1136
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1137
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1138
|
+
environment = "mypurecloud.com"
|
|
1139
|
+
|
|
1140
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1141
|
+
|
|
1142
|
+
PureCloud.configure do |config|
|
|
1143
|
+
config.access_token = @authToken
|
|
1144
|
+
end
|
|
1145
|
+
|
|
1146
|
+
api_instance = PureCloud::WorkforceManagementApi.new
|
|
1147
|
+
|
|
1148
|
+
management_unit_id = "management_unit_id_example" # String | The ID of the management unit.
|
|
1149
|
+
|
|
1150
|
+
run_id = "run_id_example" # String | The ID of the schedule run
|
|
1151
|
+
|
|
1152
|
+
|
|
1153
|
+
begin
|
|
1154
|
+
#Gets the result of a specific scheduling run
|
|
1155
|
+
result = api_instance.get_workforcemanagement_managementunit_scheduling_run_result(management_unit_id, run_id)
|
|
1156
|
+
p result
|
|
1157
|
+
rescue PureCloud::ApiError => e
|
|
1158
|
+
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_scheduling_run_result: #{e}"
|
|
1159
|
+
end
|
|
1160
|
+
~~~
|
|
1161
|
+
|
|
1162
|
+
### Parameters
|
|
1163
|
+
|
|
1164
|
+
Name | Type | Description | Notes
|
|
1165
|
+
------------- | ------------- | ------------- | -------------
|
|
1166
|
+
**management_unit_id** | **String**| The ID of the management unit. | |
|
|
1167
|
+
**run_id** | **String**| The ID of the schedule run | |
|
|
1168
|
+
{: class="table table-striped"}
|
|
1169
|
+
|
|
1170
|
+
|
|
1171
|
+
### Return type
|
|
1172
|
+
|
|
1173
|
+
[**RescheduleResult**](RescheduleResult.html)
|
|
1174
|
+
|
|
1175
|
+
### HTTP request headers
|
|
1176
|
+
|
|
1177
|
+
- **Content-Type**: application/json
|
|
1178
|
+
- **Accept**: application/json
|
|
1179
|
+
|
|
1180
|
+
|
|
1181
|
+
|
|
1042
1182
|
<a name="get_workforcemanagement_managementunit_scheduling_runs"></a>
|
|
1043
1183
|
|
|
1044
1184
|
## -[**SchedulingRunListResponse**](SchedulingRunListResponse.html) get_workforcemanagement_managementunit_scheduling_runs(management_unit_id)
|
|
@@ -2386,6 +2526,78 @@ Name | Type | Description | Notes
|
|
|
2386
2526
|
|
|
2387
2527
|
|
|
2388
2528
|
|
|
2529
|
+
<a name="patch_workforcemanagement_managementunit_scheduling_run"></a>
|
|
2530
|
+
|
|
2531
|
+
## -[**RescheduleResult**](RescheduleResult.html) patch_workforcemanagement_managementunit_scheduling_run(management_unit_id, run_id, opts)
|
|
2532
|
+
|
|
2533
|
+
|
|
2534
|
+
|
|
2535
|
+
Marks a specific scheduling run as applied, allowing a new rescheduling run to be started
|
|
2536
|
+
|
|
2537
|
+
|
|
2538
|
+
|
|
2539
|
+
Wraps PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}
|
|
2540
|
+
|
|
2541
|
+
Requires ANY permissions:
|
|
2542
|
+
|
|
2543
|
+
* wfm:schedule:generate
|
|
2544
|
+
|
|
2545
|
+
|
|
2546
|
+
### Example
|
|
2547
|
+
~~~ruby
|
|
2548
|
+
# load the gem
|
|
2549
|
+
require 'purecloudplatformclientv2'
|
|
2550
|
+
# setup authorization
|
|
2551
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2552
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2553
|
+
environment = "mypurecloud.com"
|
|
2554
|
+
|
|
2555
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2556
|
+
|
|
2557
|
+
PureCloud.configure do |config|
|
|
2558
|
+
config.access_token = @authToken
|
|
2559
|
+
end
|
|
2560
|
+
|
|
2561
|
+
api_instance = PureCloud::WorkforceManagementApi.new
|
|
2562
|
+
|
|
2563
|
+
management_unit_id = "management_unit_id_example" # String | The ID of the management unit.
|
|
2564
|
+
|
|
2565
|
+
run_id = "run_id_example" # String | The ID of the schedule run
|
|
2566
|
+
|
|
2567
|
+
opts = {
|
|
2568
|
+
body: PureCloud::UpdateSchedulingRunRequest.new # UpdateSchedulingRunRequest | body
|
|
2569
|
+
}
|
|
2570
|
+
|
|
2571
|
+
begin
|
|
2572
|
+
#Marks a specific scheduling run as applied, allowing a new rescheduling run to be started
|
|
2573
|
+
result = api_instance.patch_workforcemanagement_managementunit_scheduling_run(management_unit_id, run_id, opts)
|
|
2574
|
+
p result
|
|
2575
|
+
rescue PureCloud::ApiError => e
|
|
2576
|
+
puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_scheduling_run: #{e}"
|
|
2577
|
+
end
|
|
2578
|
+
~~~
|
|
2579
|
+
|
|
2580
|
+
### Parameters
|
|
2581
|
+
|
|
2582
|
+
Name | Type | Description | Notes
|
|
2583
|
+
------------- | ------------- | ------------- | -------------
|
|
2584
|
+
**management_unit_id** | **String**| The ID of the management unit. | |
|
|
2585
|
+
**run_id** | **String**| The ID of the schedule run | |
|
|
2586
|
+
**body** | [**UpdateSchedulingRunRequest**](UpdateSchedulingRunRequest.html)| body | [optional] |
|
|
2587
|
+
{: class="table table-striped"}
|
|
2588
|
+
|
|
2589
|
+
|
|
2590
|
+
### Return type
|
|
2591
|
+
|
|
2592
|
+
[**RescheduleResult**](RescheduleResult.html)
|
|
2593
|
+
|
|
2594
|
+
### HTTP request headers
|
|
2595
|
+
|
|
2596
|
+
- **Content-Type**: application/json
|
|
2597
|
+
- **Accept**: application/json
|
|
2598
|
+
|
|
2599
|
+
|
|
2600
|
+
|
|
2389
2601
|
<a name="patch_workforcemanagement_managementunit_servicegoalgroup"></a>
|
|
2390
2602
|
|
|
2391
2603
|
## -[**ServiceGoalGroup**](ServiceGoalGroup.html) patch_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id, opts)
|
|
@@ -3532,6 +3744,82 @@ Name | Type | Description | Notes
|
|
|
3532
3744
|
|
|
3533
3745
|
|
|
3534
3746
|
|
|
3747
|
+
<a name="post_workforcemanagement_managementunit_week_schedule_reschedule"></a>
|
|
3748
|
+
|
|
3749
|
+
## -[**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html) post_workforcemanagement_managementunit_week_schedule_reschedule(management_unit_id, week_id, schedule_id, opts)
|
|
3750
|
+
|
|
3751
|
+
|
|
3752
|
+
|
|
3753
|
+
Start a scheduling run to compute the reschedule. When the scheduling run finishes, a client can get the reschedule changes and then the client can apply them to the schedule, save the schedule, and mark the scheduling run as applied
|
|
3754
|
+
|
|
3755
|
+
|
|
3756
|
+
|
|
3757
|
+
Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/reschedule
|
|
3758
|
+
|
|
3759
|
+
Requires ANY permissions:
|
|
3760
|
+
|
|
3761
|
+
* wfm:schedule:administer
|
|
3762
|
+
* wfm:schedule:edit
|
|
3763
|
+
|
|
3764
|
+
|
|
3765
|
+
### Example
|
|
3766
|
+
~~~ruby
|
|
3767
|
+
# load the gem
|
|
3768
|
+
require 'purecloudplatformclientv2'
|
|
3769
|
+
# setup authorization
|
|
3770
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3771
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3772
|
+
environment = "mypurecloud.com"
|
|
3773
|
+
|
|
3774
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3775
|
+
|
|
3776
|
+
PureCloud.configure do |config|
|
|
3777
|
+
config.access_token = @authToken
|
|
3778
|
+
end
|
|
3779
|
+
|
|
3780
|
+
api_instance = PureCloud::WorkforceManagementApi.new
|
|
3781
|
+
|
|
3782
|
+
management_unit_id = "management_unit_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
3783
|
+
|
|
3784
|
+
week_id = "week_id_example" # String | First day of schedule week in yyyy-MM-dd format.
|
|
3785
|
+
|
|
3786
|
+
schedule_id = "schedule_id_example" # String | The ID of the schedule to re-optimize
|
|
3787
|
+
|
|
3788
|
+
opts = {
|
|
3789
|
+
body: PureCloud::RescheduleRequest.new # RescheduleRequest | body
|
|
3790
|
+
}
|
|
3791
|
+
|
|
3792
|
+
begin
|
|
3793
|
+
#Start a scheduling run to compute the reschedule. When the scheduling run finishes, a client can get the reschedule changes and then the client can apply them to the schedule, save the schedule, and mark the scheduling run as applied
|
|
3794
|
+
result = api_instance.post_workforcemanagement_managementunit_week_schedule_reschedule(management_unit_id, week_id, schedule_id, opts)
|
|
3795
|
+
p result
|
|
3796
|
+
rescue PureCloud::ApiError => e
|
|
3797
|
+
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_schedule_reschedule: #{e}"
|
|
3798
|
+
end
|
|
3799
|
+
~~~
|
|
3800
|
+
|
|
3801
|
+
### Parameters
|
|
3802
|
+
|
|
3803
|
+
Name | Type | Description | Notes
|
|
3804
|
+
------------- | ------------- | ------------- | -------------
|
|
3805
|
+
**management_unit_id** | **String**| The ID of the management unit, or 'mine' for the management unit of the logged-in user. | |
|
|
3806
|
+
**week_id** | **String**| First day of schedule week in yyyy-MM-dd format. | |
|
|
3807
|
+
**schedule_id** | **String**| The ID of the schedule to re-optimize | |
|
|
3808
|
+
**body** | [**RescheduleRequest**](RescheduleRequest.html)| body | [optional] |
|
|
3809
|
+
{: class="table table-striped"}
|
|
3810
|
+
|
|
3811
|
+
|
|
3812
|
+
### Return type
|
|
3813
|
+
|
|
3814
|
+
[**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html)
|
|
3815
|
+
|
|
3816
|
+
### HTTP request headers
|
|
3817
|
+
|
|
3818
|
+
- **Content-Type**: application/json
|
|
3819
|
+
- **Accept**: application/json
|
|
3820
|
+
|
|
3821
|
+
|
|
3822
|
+
|
|
3535
3823
|
<a name="post_workforcemanagement_managementunit_week_schedules"></a>
|
|
3536
3824
|
|
|
3537
3825
|
## -[**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html) post_workforcemanagement_managementunit_week_schedules(management_unit_id, week_id, opts)
|