purecloudplatformclientv2 53.0.0 → 54.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 +2 -2
- data/docs/AgentActivityEntityListing.md +2 -2
- data/docs/AttemptLimitsEntityListing.md +2 -2
- data/docs/AuthzDivisionEntityListing.md +2 -2
- data/docs/CalibrationEntityListing.md +2 -2
- data/docs/CallConversationEntityListing.md +2 -2
- data/docs/CallHistoryConversationEntityListing.md +2 -2
- data/docs/CallableTimeSetEntityListing.md +2 -2
- data/docs/CallbackConversationEntityListing.md +2 -2
- data/docs/CampaignDivisionViewListing.md +2 -2
- data/docs/CampaignEntityListing.md +2 -2
- data/docs/CampaignRuleEntityListing.md +2 -2
- data/docs/CampaignSequenceEntityListing.md +2 -2
- data/docs/CertificateAuthorityEntityListing.md +2 -2
- data/docs/ChatConversationEntityListing.md +2 -2
- data/docs/ClientAppEntityListing.md +2 -2
- data/docs/CobrowseConversationEntityListing.md +2 -2
- data/docs/CommandStatusEntityListing.md +2 -2
- data/docs/ConsumedResourcesEntityListing.md +2 -2
- data/docs/ConsumingResourcesEntityListing.md +2 -2
- data/docs/ContactListDivisionViewListing.md +2 -2
- data/docs/ContactListEntityListing.md +2 -2
- data/docs/ContactListFilterEntityListing.md +2 -2
- data/docs/ContactListing.md +2 -2
- data/docs/ConversationEntityListing.md +2 -2
- data/docs/CredentialInfoListing.md +2 -2
- data/docs/CredentialTypeListing.md +2 -2
- data/docs/DIDEntityListing.md +2 -2
- data/docs/DIDPoolEntityListing.md +2 -2
- data/docs/DataTableRowEntityListing.md +2 -2
- data/docs/DataTablesDomainEntityListing.md +2 -2
- data/docs/DependencyObjectEntityListing.md +2 -2
- data/docs/DependencyTypeEntityListing.md +2 -2
- data/docs/DialerEventEntityListing.md +2 -2
- data/docs/DirectoryUserDevicesListing.md +2 -2
- data/docs/DncListDivisionViewListing.md +2 -2
- data/docs/DncListEntityListing.md +2 -2
- data/docs/DocumentAuditEntityListing.md +2 -2
- data/docs/DocumentEntityListing.md +2 -2
- data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +2 -2
- data/docs/DomainEntityListing.md +2 -2
- data/docs/DomainEntityListingEvaluationForm.md +2 -2
- data/docs/DomainEntityListingQueryResult.md +2 -2
- data/docs/DomainEntityListingSurveyForm.md +2 -2
- data/docs/EdgeEntityListing.md +2 -2
- data/docs/EdgeGroupEntityListing.md +2 -2
- data/docs/EdgeLineEntityListing.md +2 -2
- data/docs/EmailConversationEntityListing.md +2 -2
- data/docs/EmailMessageListing.md +2 -2
- data/docs/EmergencyGroupListing.md +2 -2
- data/docs/EncryptionKeyEntityListing.md +2 -2
- data/docs/EvaluationEntityListing.md +2 -2
- data/docs/EvaluationFormEntityListing.md +2 -2
- data/docs/EvaluatorActivityEntityListing.md +2 -2
- data/docs/ExtensionEntityListing.md +2 -2
- data/docs/ExtensionPoolEntityListing.md +2 -2
- data/docs/ExternalOrganizationListing.md +2 -2
- data/docs/FacebookIntegrationEntityListing.md +2 -2
- data/docs/FaxDocumentEntityListing.md +2 -2
- data/docs/FlowDivisionViewEntityListing.md +2 -2
- data/docs/FlowEntityListing.md +2 -2
- data/docs/FlowVersionEntityListing.md +2 -2
- data/docs/GDPRRequestEntityListing.md +2 -2
- data/docs/GDPRSubjectEntityListing.md +2 -2
- data/docs/GreetingListing.md +2 -2
- data/docs/GroupEntityListing.md +2 -2
- data/docs/GroupProfileEntityListing.md +2 -2
- data/docs/IVREntityListing.md +2 -2
- data/docs/InboundDomainEntityListing.md +2 -2
- data/docs/InboundRouteEntityListing.md +2 -2
- data/docs/IntegrationEntityListing.md +2 -2
- data/docs/IntegrationEventEntityListing.md +2 -2
- data/docs/IntegrationTypeEntityListing.md +2 -2
- data/docs/InteractionStatsAlertContainer.md +2 -2
- data/docs/InteractionStatsRuleContainer.md +2 -2
- data/docs/KeywordSetEntityListing.md +2 -2
- data/docs/LanguageEntityListing.md +2 -2
- data/docs/LibraryEntityListing.md +2 -2
- data/docs/LineBaseEntityListing.md +2 -2
- data/docs/LineEntityListing.md +2 -2
- data/docs/LineIntegrationEntityListing.md +2 -2
- data/docs/LocationEntityListing.md +2 -2
- data/docs/LocationsApi.md +1 -2
- data/docs/LogicalInterfaceEntityListing.md +2 -2
- data/docs/ManagementUnitListing.md +2 -2
- data/docs/MessageConversationEntityListing.md +2 -2
- data/docs/MessagingStickerEntityListing.md +2 -2
- data/docs/NoteListing.md +2 -2
- data/docs/OAuthClientEntityListing.md +2 -2
- data/docs/OAuthProviderEntityListing.md +2 -2
- data/docs/OrganizationPresenceEntityListing.md +2 -2
- data/docs/OrganizationRoleEntityListing.md +2 -2
- data/docs/OrphanRecordingListing.md +2 -2
- data/docs/OutboundRouteBaseEntityListing.md +2 -2
- data/docs/OutboundRouteEntityListing.md +2 -2
- data/docs/PermissionCollectionEntityListing.md +2 -2
- data/docs/PhoneBaseEntityListing.md +2 -2
- data/docs/PhoneEntityListing.md +2 -2
- data/docs/PhoneMetaBaseEntityListing.md +2 -2
- data/docs/PhysicalInterfaceEntityListing.md +2 -2
- data/docs/PolicyEntityListing.md +2 -2
- data/docs/PromptAssetEntityListing.md +2 -2
- data/docs/PromptEntityListing.md +2 -2
- data/docs/QualityAuditPage.md +2 -2
- data/docs/QueueEntityListing.md +2 -2
- data/docs/QueueMemberEntityListing.md +2 -2
- data/docs/RecipientListing.md +2 -2
- data/docs/RelationshipListing.md +2 -2
- data/docs/ReportMetaDataEntityListing.md +2 -2
- data/docs/ReportRunEntryEntityDomainListing.md +2 -2
- data/docs/ReportScheduleEntityListing.md +2 -2
- data/docs/ReportingExportJobListing.md +2 -2
- data/docs/ResponseEntityList.md +2 -2
- data/docs/ResponseEntityListing.md +2 -2
- data/docs/ResponseSetEntityListing.md +2 -2
- data/docs/RuleSetEntityListing.md +2 -2
- data/docs/ScheduleEntityListing.md +2 -2
- data/docs/ScheduleGroupEntityListing.md +2 -2
- data/docs/SchemaCategoryEntityListing.md +2 -2
- data/docs/SchemaReferenceEntityListing.md +2 -2
- data/docs/ScreenRecordingSessionListing.md +2 -2
- data/docs/ScriptEntityListing.md +2 -2
- data/docs/SecurityProfileEntityListing.md +2 -2
- data/docs/ShareEntityListing.md +2 -2
- data/docs/ShiftTradeResponse.md +1 -1
- data/docs/SiteEntityListing.md +2 -2
- data/docs/SkillEntityListing.md +2 -2
- data/docs/SmsPhoneNumberEntityListing.md +2 -2
- data/docs/StationEntityListing.md +2 -2
- data/docs/SubjectDivisionGrantsEntityListing.md +2 -2
- data/docs/SurveyFormEntityListing.md +2 -2
- data/docs/SystemPromptAssetEntityListing.md +2 -2
- data/docs/SystemPromptEntityListing.md +2 -2
- data/docs/TagValueEntityListing.md +2 -2
- data/docs/TextMessageListing.md +2 -2
- data/docs/TimeZoneEntityListing.md +2 -2
- data/docs/TrunkBaseEntityListing.md +2 -2
- data/docs/TrunkEntityListing.md +2 -2
- data/docs/TrunkMetabaseEntityListing.md +2 -2
- data/docs/TrustEntityListing.md +2 -2
- data/docs/TrustUserEntityListing.md +2 -2
- data/docs/TrustorEntityListing.md +2 -2
- data/docs/TwitterIntegrationEntityListing.md +2 -2
- data/docs/UserActionCategoryEntityListing.md +2 -2
- data/docs/UserEntityListing.md +2 -2
- data/docs/UserLanguageEntityListing.md +2 -2
- data/docs/UserProfileEntityListing.md +2 -2
- data/docs/UserQueueEntityListing.md +2 -2
- data/docs/UserRecordingEntityListing.md +2 -2
- data/docs/UserSkillEntityListing.md +2 -2
- data/docs/VoicemailMessageEntityListing.md +2 -2
- data/docs/WfmAgent.md +4 -4
- data/docs/WorkforceManagementApi.md +0 -652
- data/docs/WorkspaceEntityListing.md +2 -2
- data/docs/WorkspaceMemberEntityListing.md +2 -2
- data/docs/WrapupCodeEntityListing.md +2 -2
- data/lib/purecloudplatformclientv2.rb +0 -54
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +53 -751
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +13 -13
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +13 -13
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +13 -13
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +13 -13
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +13 -13
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/note_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +13 -13
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +13 -13
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/shift_trade_response.rb +1 -1
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/wfm_agent.rb +55 -55
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +2 -110
- data/docs/ActionMap.md +0 -30
- data/docs/ActionMapAction.md +0 -16
- data/docs/ActionProperties.md +0 -14
- data/docs/ActionSurvey.md +0 -13
- data/docs/ActionTarget.md +0 -15
- data/docs/Activation.md +0 -14
- data/docs/AddShiftTradeRequest.md +0 -17
- data/docs/Browser.md +0 -23
- data/docs/Context.md +0 -13
- data/docs/ContextPattern.md +0 -13
- data/docs/Criteria.md +0 -16
- data/docs/Cursors.md +0 -14
- data/docs/CustomEventAttribute.md +0 -14
- data/docs/Device.md +0 -20
- data/docs/EntityTypeCriteria.md +0 -17
- data/docs/Event.md +0 -24
- data/docs/EventAction.md +0 -17
- data/docs/EventCondition.md +0 -15
- data/docs/EventListing.md +0 -16
- data/docs/GenericActionEvent.md +0 -16
- data/docs/GenericEventAction.md +0 -18
- data/docs/Journey.md +0 -13
- data/docs/JourneyApi.md +0 -85
- data/docs/JourneyCampaign.md +0 -19
- data/docs/JourneyGeolocation.md +0 -22
- data/docs/JourneyPage.md +0 -22
- data/docs/JourneyPattern.md +0 -14
- data/docs/JourneySegment.md +0 -25
- data/docs/JourneySurveyQuestion.md +0 -17
- data/docs/MatchShiftTradeRequest.md +0 -15
- data/docs/MatchShiftTradeResponse.md +0 -15
- data/docs/Outcome.md +0 -24
- data/docs/OutcomeAchievedEvent.md +0 -22
- data/docs/OutcomeProbabilityCondition.md +0 -15
- data/docs/Referrer.md +0 -21
- data/docs/SearchShiftTradeResponse.md +0 -15
- data/docs/SearchShiftTradesRequest.md +0 -14
- data/docs/SearchShiftTradesResponse.md +0 -13
- data/docs/SegmentAssignedEvent.md +0 -22
- data/docs/Session.md +0 -15
- data/docs/ShiftTradeActivityPreviewResponse.md +0 -16
- data/docs/ShiftTradeMatchReviewResponse.md +0 -16
- data/docs/ShiftTradeMatchReviewUserResponse.md +0 -17
- data/docs/ShiftTradeMatchViolation.md +0 -14
- data/docs/ShiftTradePreviewResponse.md +0 -13
- data/docs/ShiftTradeResponseAcceptableIntervals.md +0 -14
- data/docs/UpdateAgentRequest.md +0 -13
- data/docs/UpdateShiftTradeRequest.md +0 -16
- data/docs/UpdateShiftTradeStateRequest.md +0 -14
- data/docs/UrlCondition.md +0 -14
- data/docs/WebActionEvent.md +0 -26
- data/docs/WebEvent.md +0 -25
- data/docs/WeekShiftTradeListResponse.md +0 -13
- data/docs/WeekShiftTradeResponse.md +0 -14
- data/lib/purecloudplatformclientv2/api/journey_api.rb +0 -119
- data/lib/purecloudplatformclientv2/models/action_map.rb +0 -666
- data/lib/purecloudplatformclientv2/models/action_map_action.rb +0 -299
- data/lib/purecloudplatformclientv2/models/action_properties.rb +0 -228
- data/lib/purecloudplatformclientv2/models/action_survey.rb +0 -209
- data/lib/purecloudplatformclientv2/models/action_target.rb +0 -253
- data/lib/purecloudplatformclientv2/models/activation.rb +0 -233
- data/lib/purecloudplatformclientv2/models/add_shift_trade_request.rb +0 -317
- data/lib/purecloudplatformclientv2/models/browser.rb +0 -472
- data/lib/purecloudplatformclientv2/models/context.rb +0 -209
- data/lib/purecloudplatformclientv2/models/context_pattern.rb +0 -209
- data/lib/purecloudplatformclientv2/models/criteria.rb +0 -311
- data/lib/purecloudplatformclientv2/models/cursors.rb +0 -226
- data/lib/purecloudplatformclientv2/models/custom_event_attribute.rb +0 -228
- data/lib/purecloudplatformclientv2/models/device.rb +0 -418
- data/lib/purecloudplatformclientv2/models/entity_type_criteria.rb +0 -351
- data/lib/purecloudplatformclientv2/models/event.rb +0 -503
- data/lib/purecloudplatformclientv2/models/event_action.rb +0 -339
- data/lib/purecloudplatformclientv2/models/event_condition.rb +0 -280
- data/lib/purecloudplatformclientv2/models/event_listing.rb +0 -278
- data/lib/purecloudplatformclientv2/models/generic_action_event.rb +0 -285
- data/lib/purecloudplatformclientv2/models/generic_event_action.rb +0 -365
- data/lib/purecloudplatformclientv2/models/journey.rb +0 -209
- data/lib/purecloudplatformclientv2/models/journey_campaign.rb +0 -358
- data/lib/purecloudplatformclientv2/models/journey_geolocation.rb +0 -436
- data/lib/purecloudplatformclientv2/models/journey_page.rb +0 -458
- data/lib/purecloudplatformclientv2/models/journey_pattern.rb +0 -235
- data/lib/purecloudplatformclientv2/models/journey_segment.rb +0 -518
- data/lib/purecloudplatformclientv2/models/journey_survey_question.rb +0 -341
- data/lib/purecloudplatformclientv2/models/match_shift_trade_request.rb +0 -264
- data/lib/purecloudplatformclientv2/models/match_shift_trade_response.rb +0 -258
- data/lib/purecloudplatformclientv2/models/outcome.rb +0 -492
- data/lib/purecloudplatformclientv2/models/outcome_achieved_event.rb +0 -441
- data/lib/purecloudplatformclientv2/models/outcome_probability_condition.rb +0 -264
- data/lib/purecloudplatformclientv2/models/referrer.rb +0 -444
- data/lib/purecloudplatformclientv2/models/search_shift_trade_response.rb +0 -256
- data/lib/purecloudplatformclientv2/models/search_shift_trades_request.rb +0 -235
- data/lib/purecloudplatformclientv2/models/search_shift_trades_response.rb +0 -204
- data/lib/purecloudplatformclientv2/models/segment_assigned_event.rb +0 -441
- data/lib/purecloudplatformclientv2/models/session.rb +0 -253
- data/lib/purecloudplatformclientv2/models/shift_trade_activity_preview_response.rb +0 -280
- data/lib/purecloudplatformclientv2/models/shift_trade_match_review_response.rb +0 -284
- data/lib/purecloudplatformclientv2/models/shift_trade_match_review_user_response.rb +0 -306
- data/lib/purecloudplatformclientv2/models/shift_trade_match_violation.rb +0 -244
- data/lib/purecloudplatformclientv2/models/shift_trade_preview_response.rb +0 -204
- data/lib/purecloudplatformclientv2/models/shift_trade_response_acceptable_intervals.rb +0 -228
- data/lib/purecloudplatformclientv2/models/update_agent_request.rb +0 -202
- data/lib/purecloudplatformclientv2/models/update_shift_trade_request.rb +0 -286
- data/lib/purecloudplatformclientv2/models/update_shift_trade_state_request.rb +0 -252
- data/lib/purecloudplatformclientv2/models/url_condition.rb +0 -254
- data/lib/purecloudplatformclientv2/models/web_action_event.rb +0 -545
- data/lib/purecloudplatformclientv2/models/web_event.rb +0 -521
- data/lib/purecloudplatformclientv2/models/week_shift_trade_list_response.rb +0 -203
- data/lib/purecloudplatformclientv2/models/week_shift_trade_response.rb +0 -228
|
@@ -13,9 +13,9 @@ title: TrunkMetabaseEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_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
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_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
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_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
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_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
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: UserActionCategoryEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_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
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_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
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_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
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: UserQueueEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_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
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: UserSkillEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: VoicemailMessageEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/WfmAgent.md
CHANGED
|
@@ -9,14 +9,14 @@ title: WfmAgent
|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
11
|
| **user** | [**UserReference**](UserReference.html) | The user associated with this data | [optional] |
|
|
12
|
-
| **queues** | [**Array<QueueReference>**](QueueReference.html) | List of queues to which the agent belongs and which are defined in the service goal groups in this management unit | [optional] |
|
|
13
|
-
| **languages** | [**Array<LanguageReference>**](LanguageReference.html) | The list of languages | [optional] |
|
|
14
|
-
| **skills** | [**Array<RoutingSkillReference>**](RoutingSkillReference.html) | The list of skills | [optional] |
|
|
15
12
|
| **work_plan** | [**WorkPlanReference**](WorkPlanReference.html) | The work plan associated with this agent | [optional] |
|
|
16
|
-
| **schedulable** | **BOOLEAN** | Whether the agent has the permission to be included in schedule generation | [optional] |
|
|
17
13
|
| **time_zone** | [**WfmTimeZone**](WfmTimeZone.html) | The time zone for this agent. Defaults to the time zone of the management unit to which the agent belongs | [optional] |
|
|
18
14
|
| **accept_direct_shift_trades** | **BOOLEAN** | Whether the agent accepts direct shift trade requests | [optional] |
|
|
19
15
|
| **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Metadata for this agent | [optional] |
|
|
16
|
+
| **queues** | [**Array<QueueReference>**](QueueReference.html) | List of queues to which the agent belongs and which are defined in the service goal groups in this management unit | [optional] |
|
|
17
|
+
| **languages** | [**Array<LanguageReference>**](LanguageReference.html) | The list of languages | [optional] |
|
|
18
|
+
| **skills** | [**Array<RoutingSkillReference>**](RoutingSkillReference.html) | The list of skills | [optional] |
|
|
19
|
+
| **schedulable** | **BOOLEAN** | Whether the agent has the permission to be included in schedule generation | [optional] |
|
|
20
20
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
21
21
|
{: class="table table-striped"}
|
|
22
22
|
|
|
@@ -21,7 +21,6 @@ Method | Description
|
|
|
21
21
|
[**get_workforcemanagement_managementunit_activitycode**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_activitycode) | Get an activity code
|
|
22
22
|
[**get_workforcemanagement_managementunit_activitycodes**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_activitycodes) | Get activity codes
|
|
23
23
|
[**get_workforcemanagement_managementunit_agent**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_agent) | Get data for agent in the management unit
|
|
24
|
-
[**get_workforcemanagement_managementunit_agent_shifttrades**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_agent_shifttrades) | Gets all the shift trades for a given agent
|
|
25
24
|
[**get_workforcemanagement_managementunit_intraday_queues**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_intraday_queues) | Get intraday queues for the given date
|
|
26
25
|
[**get_workforcemanagement_managementunit_scheduling_run**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_scheduling_run) | Gets the status for a specific scheduling run
|
|
27
26
|
[**get_workforcemanagement_managementunit_scheduling_run_result**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_scheduling_run_result) | Gets the result of a specific scheduling run
|
|
@@ -37,7 +36,6 @@ Method | Description
|
|
|
37
36
|
[**get_workforcemanagement_managementunit_week_schedule**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_week_schedule) | Get a week schedule
|
|
38
37
|
[**get_workforcemanagement_managementunit_week_schedule_generationresults**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_week_schedule_generationresults) | Get week schedule generation results
|
|
39
38
|
[**get_workforcemanagement_managementunit_week_schedules**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_week_schedules) | Get the list of schedules in a week in management unit
|
|
40
|
-
[**get_workforcemanagement_managementunit_week_shifttrades**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_week_shifttrades) | Gets all the shift trades for a given week
|
|
41
39
|
[**get_workforcemanagement_managementunit_week_shorttermforecast_final**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_week_shorttermforecast_final) | Get the final result of a short term forecast calculation with modifications applied
|
|
42
40
|
[**get_workforcemanagement_managementunit_week_shorttermforecasts**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_week_shorttermforecasts) | Get short term forecasts
|
|
43
41
|
[**get_workforcemanagement_managementunit_workplan**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_workplan) | Get a work plan
|
|
@@ -50,7 +48,6 @@ Method | Description
|
|
|
50
48
|
[**get_workforcemanagement_timeoffrequest**](WorkforceManagementApi.html#get_workforcemanagement_timeoffrequest) | Get a time off request for the current user
|
|
51
49
|
[**get_workforcemanagement_timeoffrequests**](WorkforceManagementApi.html#get_workforcemanagement_timeoffrequests) | Get a list of time off requests for the current user
|
|
52
50
|
[**patch_workforcemanagement_managementunit_activitycode**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_activitycode) | Update an activity code
|
|
53
|
-
[**patch_workforcemanagement_managementunit_agent**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_agent) | Update agent details
|
|
54
51
|
[**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
|
|
55
52
|
[**patch_workforcemanagement_managementunit_servicegoalgroup**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_servicegoalgroup) | Update a service goal group
|
|
56
53
|
[**patch_workforcemanagement_managementunit_settings**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_settings) | Patch the settings for the requested management unit
|
|
@@ -72,10 +69,6 @@ Method | Description
|
|
|
72
69
|
[**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
|
|
73
70
|
[**post_workforcemanagement_managementunit_week_schedules_generate**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_schedules_generate) | Generate a week schedule
|
|
74
71
|
[**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
|
|
75
|
-
[**post_workforcemanagement_managementunit_week_shifttrade_match**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_shifttrade_match) | Matches a shift trade. This route can only be called by the receiving agent
|
|
76
|
-
[**post_workforcemanagement_managementunit_week_shifttrade_update**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_shifttrade_update) | Updates a shift trade. This route can only be called by the initiating agent
|
|
77
|
-
[**post_workforcemanagement_managementunit_week_shifttrades**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_shifttrades) | Adds a shift trade
|
|
78
|
-
[**post_workforcemanagement_managementunit_week_shifttrades_search**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_shifttrades_search) | Searches for potential shift trade matches for the current agent
|
|
79
72
|
[**post_workforcemanagement_managementunit_week_shorttermforecast_copy**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_shorttermforecast_copy) | Copy a short term forecast
|
|
80
73
|
[**post_workforcemanagement_managementunit_week_shorttermforecasts**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_shorttermforecasts) | Import a short term forecast
|
|
81
74
|
[**post_workforcemanagement_managementunit_week_shorttermforecasts_generate**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_shorttermforecasts_generate) | Generate a short term forecast
|
|
@@ -86,7 +79,6 @@ Method | Description
|
|
|
86
79
|
[**post_workforcemanagement_notifications_update**](WorkforceManagementApi.html#post_workforcemanagement_notifications_update) | Mark a list of notifications as read or unread
|
|
87
80
|
[**post_workforcemanagement_schedules**](WorkforceManagementApi.html#post_workforcemanagement_schedules) | Get published schedule for the current user
|
|
88
81
|
[**post_workforcemanagement_timeoffrequests**](WorkforceManagementApi.html#post_workforcemanagement_timeoffrequests) | Create a time off request for the current user
|
|
89
|
-
[**put_workforcemanagement_managementunit_week_shifttrade_state**](WorkforceManagementApi.html#put_workforcemanagement_managementunit_week_shifttrade_state) | Updates a shift trade state
|
|
90
82
|
{: class="table table-striped"}
|
|
91
83
|
|
|
92
84
|
<a name="delete_workforcemanagement_managementunit"></a>
|
|
@@ -103,7 +95,6 @@ Wraps DELETE /api/v2/workforcemanagement/managementunits/{muId}
|
|
|
103
95
|
|
|
104
96
|
Requires ANY permissions:
|
|
105
97
|
|
|
106
|
-
* wfm:managementUnit:administer
|
|
107
98
|
* wfm:managementUnit:delete
|
|
108
99
|
|
|
109
100
|
|
|
@@ -168,7 +159,6 @@ Wraps DELETE /api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{a
|
|
|
168
159
|
|
|
169
160
|
Requires ANY permissions:
|
|
170
161
|
|
|
171
|
-
* wfm:activityCode:administer
|
|
172
162
|
* wfm:activityCode:delete
|
|
173
163
|
|
|
174
164
|
|
|
@@ -303,7 +293,6 @@ Wraps DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId}/serv
|
|
|
303
293
|
|
|
304
294
|
Requires ANY permissions:
|
|
305
295
|
|
|
306
|
-
* wfm:serviceGoalGroup:administer
|
|
307
296
|
* wfm:serviceGoalGroup:delete
|
|
308
297
|
|
|
309
298
|
|
|
@@ -371,7 +360,6 @@ Wraps DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId}/week
|
|
|
371
360
|
|
|
372
361
|
Requires ANY permissions:
|
|
373
362
|
|
|
374
|
-
* wfm:schedule:administer
|
|
375
363
|
* wfm:schedule:delete
|
|
376
364
|
|
|
377
365
|
|
|
@@ -442,7 +430,6 @@ Wraps DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId}/week
|
|
|
442
430
|
|
|
443
431
|
Requires ANY permissions:
|
|
444
432
|
|
|
445
|
-
* wfm:shortTermForecast:administer
|
|
446
433
|
* wfm:shortTermForecast:delete
|
|
447
434
|
|
|
448
435
|
|
|
@@ -513,7 +500,6 @@ Wraps DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId}/work
|
|
|
513
500
|
|
|
514
501
|
Requires ANY permissions:
|
|
515
502
|
|
|
516
|
-
* wfm:workPlan:administer
|
|
517
503
|
* wfm:workPlan:delete
|
|
518
504
|
|
|
519
505
|
|
|
@@ -712,11 +698,9 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{muId}
|
|
|
712
698
|
Requires ANY permissions:
|
|
713
699
|
|
|
714
700
|
* wfm:activityCode:add
|
|
715
|
-
* wfm:activityCode:administer
|
|
716
701
|
* wfm:activityCode:delete
|
|
717
702
|
* wfm:activityCode:edit
|
|
718
703
|
* wfm:activityCode:view
|
|
719
|
-
* wfm:agent:administer
|
|
720
704
|
* wfm:agent:edit
|
|
721
705
|
* wfm:agentSchedule:view
|
|
722
706
|
* wfm:agentTimeOffRequest:submit
|
|
@@ -724,34 +708,28 @@ Requires ANY permissions:
|
|
|
724
708
|
* wfm:historicalAdherence:view
|
|
725
709
|
* wfm:intraday:view
|
|
726
710
|
* wfm:managementUnit:add
|
|
727
|
-
* wfm:managementUnit:administer
|
|
728
711
|
* wfm:managementUnit:delete
|
|
729
712
|
* wfm:managementUnit:edit
|
|
730
713
|
* wfm:managementUnit:view
|
|
731
714
|
* wfm:publishedSchedule:view
|
|
732
715
|
* wfm:realtimeAdherence:view
|
|
733
716
|
* wfm:schedule:add
|
|
734
|
-
* wfm:schedule:administer
|
|
735
717
|
* wfm:schedule:delete
|
|
736
718
|
* wfm:schedule:edit
|
|
737
719
|
* wfm:schedule:generate
|
|
738
720
|
* wfm:schedule:view
|
|
739
721
|
* wfm:serviceGoalGroup:add
|
|
740
|
-
* wfm:serviceGoalGroup:administer
|
|
741
722
|
* wfm:serviceGoalGroup:delete
|
|
742
723
|
* wfm:serviceGoalGroup:edit
|
|
743
724
|
* wfm:serviceGoalGroup:view
|
|
744
725
|
* wfm:shortTermForecast:add
|
|
745
|
-
* wfm:shortTermForecast:administer
|
|
746
726
|
* wfm:shortTermForecast:delete
|
|
747
727
|
* wfm:shortTermForecast:edit
|
|
748
728
|
* wfm:shortTermForecast:view
|
|
749
729
|
* wfm:timeOffRequest:add
|
|
750
|
-
* wfm:timeOffRequest:administer
|
|
751
730
|
* wfm:timeOffRequest:edit
|
|
752
731
|
* wfm:timeOffRequest:view
|
|
753
732
|
* wfm:workPlan:add
|
|
754
|
-
* wfm:workPlan:administer
|
|
755
733
|
* wfm:workPlan:delete
|
|
756
734
|
* wfm:workPlan:edit
|
|
757
735
|
* wfm:workPlan:view
|
|
@@ -823,7 +801,6 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId
|
|
|
823
801
|
|
|
824
802
|
Requires ANY permissions:
|
|
825
803
|
|
|
826
|
-
* wfm:activityCode:administer
|
|
827
804
|
* wfm:activityCode:view
|
|
828
805
|
|
|
829
806
|
|
|
@@ -893,11 +870,9 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/activitycodes
|
|
|
893
870
|
Requires ANY permissions:
|
|
894
871
|
|
|
895
872
|
* wfm:activityCode:add
|
|
896
|
-
* wfm:activityCode:administer
|
|
897
873
|
* wfm:activityCode:delete
|
|
898
874
|
* wfm:activityCode:edit
|
|
899
875
|
* wfm:activityCode:view
|
|
900
|
-
* wfm:agent:administer
|
|
901
876
|
* wfm:agent:edit
|
|
902
877
|
* wfm:agentSchedule:view
|
|
903
878
|
* wfm:agentTimeOffRequest:submit
|
|
@@ -905,34 +880,28 @@ Requires ANY permissions:
|
|
|
905
880
|
* wfm:historicalAdherence:view
|
|
906
881
|
* wfm:intraday:view
|
|
907
882
|
* wfm:managementUnit:add
|
|
908
|
-
* wfm:managementUnit:administer
|
|
909
883
|
* wfm:managementUnit:delete
|
|
910
884
|
* wfm:managementUnit:edit
|
|
911
885
|
* wfm:managementUnit:view
|
|
912
886
|
* wfm:publishedSchedule:view
|
|
913
887
|
* wfm:realtimeAdherence:view
|
|
914
888
|
* wfm:schedule:add
|
|
915
|
-
* wfm:schedule:administer
|
|
916
889
|
* wfm:schedule:delete
|
|
917
890
|
* wfm:schedule:edit
|
|
918
891
|
* wfm:schedule:generate
|
|
919
892
|
* wfm:schedule:view
|
|
920
893
|
* wfm:serviceGoalGroup:add
|
|
921
|
-
* wfm:serviceGoalGroup:administer
|
|
922
894
|
* wfm:serviceGoalGroup:delete
|
|
923
895
|
* wfm:serviceGoalGroup:edit
|
|
924
896
|
* wfm:serviceGoalGroup:view
|
|
925
897
|
* wfm:shortTermForecast:add
|
|
926
|
-
* wfm:shortTermForecast:administer
|
|
927
898
|
* wfm:shortTermForecast:delete
|
|
928
899
|
* wfm:shortTermForecast:edit
|
|
929
900
|
* wfm:shortTermForecast:view
|
|
930
901
|
* wfm:timeOffRequest:add
|
|
931
|
-
* wfm:timeOffRequest:administer
|
|
932
902
|
* wfm:timeOffRequest:edit
|
|
933
903
|
* wfm:timeOffRequest:view
|
|
934
904
|
* wfm:workPlan:add
|
|
935
|
-
* wfm:workPlan:administer
|
|
936
905
|
* wfm:workPlan:delete
|
|
937
906
|
* wfm:workPlan:edit
|
|
938
907
|
* wfm:workPlan:view
|
|
@@ -1000,7 +969,6 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/
|
|
|
1000
969
|
|
|
1001
970
|
Requires ANY permissions:
|
|
1002
971
|
|
|
1003
|
-
* wfm:agent:administer
|
|
1004
972
|
* wfm:agent:view
|
|
1005
973
|
|
|
1006
974
|
|
|
@@ -1055,75 +1023,6 @@ Name | Type | Description | Notes
|
|
|
1055
1023
|
|
|
1056
1024
|
|
|
1057
1025
|
|
|
1058
|
-
<a name="get_workforcemanagement_managementunit_agent_shifttrades"></a>
|
|
1059
|
-
|
|
1060
|
-
## [**ShiftTradeListResponse**](ShiftTradeListResponse.html) get_workforcemanagement_managementunit_agent_shifttrades(management_unit_id, agent_id)
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
Gets all the shift trades for a given agent
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}/shifttrades
|
|
1069
|
-
|
|
1070
|
-
Requires ANY permissions:
|
|
1071
|
-
|
|
1072
|
-
* wfm:shiftTradeRequest:edit
|
|
1073
|
-
* wfm:shiftTradeRequest:view
|
|
1074
|
-
|
|
1075
|
-
|
|
1076
|
-
### Example
|
|
1077
|
-
```{"language":"ruby"}
|
|
1078
|
-
# load the gem
|
|
1079
|
-
require 'purecloudplatformclientv2'
|
|
1080
|
-
# setup authorization
|
|
1081
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
1082
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1083
|
-
environment = "mypurecloud.com"
|
|
1084
|
-
|
|
1085
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1086
|
-
|
|
1087
|
-
PureCloud.configure do |config|
|
|
1088
|
-
config.access_token = @authToken
|
|
1089
|
-
end
|
|
1090
|
-
|
|
1091
|
-
api_instance = PureCloud::WorkforceManagementApi.new
|
|
1092
|
-
|
|
1093
|
-
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.
|
|
1094
|
-
|
|
1095
|
-
agent_id = "agent_id_example" # String | The agent id
|
|
1096
|
-
|
|
1097
|
-
|
|
1098
|
-
begin
|
|
1099
|
-
#Gets all the shift trades for a given agent
|
|
1100
|
-
result = api_instance.get_workforcemanagement_managementunit_agent_shifttrades(management_unit_id, agent_id)
|
|
1101
|
-
p result
|
|
1102
|
-
rescue PureCloud::ApiError => e
|
|
1103
|
-
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_agent_shifttrades: #{e}"
|
|
1104
|
-
end
|
|
1105
|
-
```
|
|
1106
|
-
|
|
1107
|
-
### Parameters
|
|
1108
|
-
|
|
1109
|
-
Name | Type | Description | Notes
|
|
1110
|
-
------------- | ------------- | ------------- | -------------
|
|
1111
|
-
**management_unit_id** | **String**| The id of the management unit, or 'mine' for the management unit of the logged-in user. | |
|
|
1112
|
-
**agent_id** | **String**| The agent id | |
|
|
1113
|
-
{: class="table table-striped"}
|
|
1114
|
-
|
|
1115
|
-
|
|
1116
|
-
### Return type
|
|
1117
|
-
|
|
1118
|
-
[**ShiftTradeListResponse**](ShiftTradeListResponse.html)
|
|
1119
|
-
|
|
1120
|
-
### HTTP request headers
|
|
1121
|
-
|
|
1122
|
-
- **Content-Type**: application/json
|
|
1123
|
-
- **Accept**: application/json
|
|
1124
|
-
|
|
1125
|
-
|
|
1126
|
-
|
|
1127
1026
|
<a name="get_workforcemanagement_managementunit_intraday_queues"></a>
|
|
1128
1027
|
|
|
1129
1028
|
## [**WfmIntradayQueueListing**](WfmIntradayQueueListing.html) get_workforcemanagement_managementunit_intraday_queues(mu_id, date)
|
|
@@ -1407,7 +1306,6 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/service
|
|
|
1407
1306
|
|
|
1408
1307
|
Requires ANY permissions:
|
|
1409
1308
|
|
|
1410
|
-
* wfm:serviceGoalGroup:administer
|
|
1411
1309
|
* wfm:serviceGoalGroup:view
|
|
1412
1310
|
|
|
1413
1311
|
|
|
@@ -1476,9 +1374,7 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/service
|
|
|
1476
1374
|
|
|
1477
1375
|
Requires ANY permissions:
|
|
1478
1376
|
|
|
1479
|
-
* wfm:serviceGoalGroup:administer
|
|
1480
1377
|
* wfm:serviceGoalGroup:view
|
|
1481
|
-
* wfm:shortTermForecast:administer
|
|
1482
1378
|
* wfm:shortTermForecast:view
|
|
1483
1379
|
|
|
1484
1380
|
|
|
@@ -1544,7 +1440,6 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/settings
|
|
|
1544
1440
|
|
|
1545
1441
|
Requires ANY permissions:
|
|
1546
1442
|
|
|
1547
|
-
* wfm:managementUnit:administer
|
|
1548
1443
|
* wfm:managementUnit:view
|
|
1549
1444
|
|
|
1550
1445
|
|
|
@@ -1741,7 +1636,6 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/time
|
|
|
1741
1636
|
|
|
1742
1637
|
Requires ANY permissions:
|
|
1743
1638
|
|
|
1744
|
-
* wfm:timeOffRequest:administer
|
|
1745
1639
|
* wfm:timeOffRequest:view
|
|
1746
1640
|
|
|
1747
1641
|
|
|
@@ -1813,7 +1707,6 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/time
|
|
|
1813
1707
|
|
|
1814
1708
|
Requires ANY permissions:
|
|
1815
1709
|
|
|
1816
|
-
* wfm:timeOffRequest:administer
|
|
1817
1710
|
* wfm:timeOffRequest:view
|
|
1818
1711
|
|
|
1819
1712
|
|
|
@@ -1886,16 +1779,12 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/users
|
|
|
1886
1779
|
|
|
1887
1780
|
Requires ANY permissions:
|
|
1888
1781
|
|
|
1889
|
-
* wfm:agent:administer
|
|
1890
1782
|
* wfm:agent:view
|
|
1891
1783
|
* wfm:historicalAdherence:view
|
|
1892
1784
|
* wfm:publishedSchedule:view
|
|
1893
1785
|
* wfm:realtimeAdherence:view
|
|
1894
|
-
* wfm:schedule:administer
|
|
1895
1786
|
* wfm:schedule:view
|
|
1896
|
-
* wfm:timeOffRequest:administer
|
|
1897
1787
|
* wfm:timeOffRequest:view
|
|
1898
|
-
* wfm:workPlan:administer
|
|
1899
1788
|
* wfm:workPlan:view
|
|
1900
1789
|
|
|
1901
1790
|
|
|
@@ -1962,7 +1851,6 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{
|
|
|
1962
1851
|
Requires ANY permissions:
|
|
1963
1852
|
|
|
1964
1853
|
* wfm:publishedSchedule:view
|
|
1965
|
-
* wfm:schedule:administer
|
|
1966
1854
|
* wfm:schedule:view
|
|
1967
1855
|
|
|
1968
1856
|
|
|
@@ -2041,7 +1929,6 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{
|
|
|
2041
1929
|
Requires ANY permissions:
|
|
2042
1930
|
|
|
2043
1931
|
* wfm:publishedSchedule:view
|
|
2044
|
-
* wfm:schedule:administer
|
|
2045
1932
|
* wfm:schedule:view
|
|
2046
1933
|
|
|
2047
1934
|
|
|
@@ -2114,7 +2001,6 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{
|
|
|
2114
2001
|
Requires ANY permissions:
|
|
2115
2002
|
|
|
2116
2003
|
* wfm:publishedSchedule:view
|
|
2117
|
-
* wfm:schedule:administer
|
|
2118
2004
|
* wfm:schedule:view
|
|
2119
2005
|
|
|
2120
2006
|
|
|
@@ -2169,79 +2055,6 @@ Name | Type | Description | Notes
|
|
|
2169
2055
|
|
|
2170
2056
|
|
|
2171
2057
|
|
|
2172
|
-
<a name="get_workforcemanagement_managementunit_week_shifttrades"></a>
|
|
2173
|
-
|
|
2174
|
-
## [**WeekShiftTradeListResponse**](WeekShiftTradeListResponse.html) get_workforcemanagement_managementunit_week_shifttrades(management_unit_id, week_date_id, opts)
|
|
2175
|
-
|
|
2176
|
-
|
|
2177
|
-
|
|
2178
|
-
Gets all the shift trades for a given week
|
|
2179
|
-
|
|
2180
|
-
|
|
2181
|
-
|
|
2182
|
-
Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades
|
|
2183
|
-
|
|
2184
|
-
Requires ANY permissions:
|
|
2185
|
-
|
|
2186
|
-
* wfm:shiftTradeRequest:view
|
|
2187
|
-
* wfm:shiftTradeRequest:edit
|
|
2188
|
-
|
|
2189
|
-
|
|
2190
|
-
### Example
|
|
2191
|
-
```{"language":"ruby"}
|
|
2192
|
-
# load the gem
|
|
2193
|
-
require 'purecloudplatformclientv2'
|
|
2194
|
-
# setup authorization
|
|
2195
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
2196
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2197
|
-
environment = "mypurecloud.com"
|
|
2198
|
-
|
|
2199
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2200
|
-
|
|
2201
|
-
PureCloud.configure do |config|
|
|
2202
|
-
config.access_token = @authToken
|
|
2203
|
-
end
|
|
2204
|
-
|
|
2205
|
-
api_instance = PureCloud::WorkforceManagementApi.new
|
|
2206
|
-
|
|
2207
|
-
management_unit_id = "management_unit_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
2208
|
-
|
|
2209
|
-
week_date_id = Date.parse("2013-10-20") # Date | The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
2210
|
-
|
|
2211
|
-
opts = {
|
|
2212
|
-
evaluate_matches: true # BOOLEAN | Whether to evaluate the matches for violations
|
|
2213
|
-
}
|
|
2214
|
-
|
|
2215
|
-
begin
|
|
2216
|
-
#Gets all the shift trades for a given week
|
|
2217
|
-
result = api_instance.get_workforcemanagement_managementunit_week_shifttrades(management_unit_id, week_date_id, opts)
|
|
2218
|
-
p result
|
|
2219
|
-
rescue PureCloud::ApiError => e
|
|
2220
|
-
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_week_shifttrades: #{e}"
|
|
2221
|
-
end
|
|
2222
|
-
```
|
|
2223
|
-
|
|
2224
|
-
### Parameters
|
|
2225
|
-
|
|
2226
|
-
Name | Type | Description | Notes
|
|
2227
|
-
------------- | ------------- | ------------- | -------------
|
|
2228
|
-
**management_unit_id** | **String**| The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user. | |
|
|
2229
|
-
**week_date_id** | **Date**| The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | |
|
|
2230
|
-
**evaluate_matches** | **BOOLEAN**| Whether to evaluate the matches for violations | [optional] [default to true] |
|
|
2231
|
-
{: class="table table-striped"}
|
|
2232
|
-
|
|
2233
|
-
|
|
2234
|
-
### Return type
|
|
2235
|
-
|
|
2236
|
-
[**WeekShiftTradeListResponse**](WeekShiftTradeListResponse.html)
|
|
2237
|
-
|
|
2238
|
-
### HTTP request headers
|
|
2239
|
-
|
|
2240
|
-
- **Content-Type**: application/json
|
|
2241
|
-
- **Accept**: application/json
|
|
2242
|
-
|
|
2243
|
-
|
|
2244
|
-
|
|
2245
2058
|
<a name="get_workforcemanagement_managementunit_week_shorttermforecast_final"></a>
|
|
2246
2059
|
|
|
2247
2060
|
## [**ForecastResultResponse**](ForecastResultResponse.html) get_workforcemanagement_managementunit_week_shorttermforecast_final(management_unit_id, week_date_id, forecast_id, opts)
|
|
@@ -2256,7 +2069,6 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{
|
|
|
2256
2069
|
|
|
2257
2070
|
Requires ANY permissions:
|
|
2258
2071
|
|
|
2259
|
-
* wfm:shortTermForecast:administer
|
|
2260
2072
|
* wfm:shortTermForecast:view
|
|
2261
2073
|
|
|
2262
2074
|
|
|
@@ -2333,7 +2145,6 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{
|
|
|
2333
2145
|
Requires ANY permissions:
|
|
2334
2146
|
|
|
2335
2147
|
* wfm:schedule:generate
|
|
2336
|
-
* wfm:shortTermForecast:administer
|
|
2337
2148
|
* wfm:shortTermForecast:view
|
|
2338
2149
|
|
|
2339
2150
|
|
|
@@ -2402,9 +2213,7 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/workpla
|
|
|
2402
2213
|
|
|
2403
2214
|
Requires ANY permissions:
|
|
2404
2215
|
|
|
2405
|
-
* wfm:workPlan:administer
|
|
2406
2216
|
* wfm:workPlan:view
|
|
2407
|
-
* wfm:schedule:administer
|
|
2408
2217
|
* wfm:schedule:edit
|
|
2409
2218
|
|
|
2410
2219
|
|
|
@@ -2473,11 +2282,8 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/workpla
|
|
|
2473
2282
|
|
|
2474
2283
|
Requires ANY permissions:
|
|
2475
2284
|
|
|
2476
|
-
* wfm:workPlan:administer
|
|
2477
|
-
* wfm:agent:administer
|
|
2478
2285
|
* wfm:agent:view
|
|
2479
2286
|
* wfm:publishedSchedule:view
|
|
2480
|
-
* wfm:schedule:administer
|
|
2481
2287
|
* wfm:schedule:view
|
|
2482
2288
|
* wfm:workPlan:view
|
|
2483
2289
|
|
|
@@ -3004,7 +2810,6 @@ Wraps PATCH /api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{ac
|
|
|
3004
2810
|
|
|
3005
2811
|
Requires ANY permissions:
|
|
3006
2812
|
|
|
3007
|
-
* wfm:activityCode:administer
|
|
3008
2813
|
* wfm:activityCode:edit
|
|
3009
2814
|
|
|
3010
2815
|
|
|
@@ -3063,75 +2868,6 @@ Name | Type | Description | Notes
|
|
|
3063
2868
|
|
|
3064
2869
|
|
|
3065
2870
|
|
|
3066
|
-
<a name="patch_workforcemanagement_managementunit_agent"></a>
|
|
3067
|
-
|
|
3068
|
-
## patch_workforcemanagement_managementunit_agent(management_unit_id, agent_id, body)
|
|
3069
|
-
|
|
3070
|
-
|
|
3071
|
-
|
|
3072
|
-
Update agent details
|
|
3073
|
-
|
|
3074
|
-
|
|
3075
|
-
|
|
3076
|
-
Wraps PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}
|
|
3077
|
-
|
|
3078
|
-
Requires NO permissions:
|
|
3079
|
-
|
|
3080
|
-
|
|
3081
|
-
|
|
3082
|
-
### Example
|
|
3083
|
-
```{"language":"ruby"}
|
|
3084
|
-
# load the gem
|
|
3085
|
-
require 'purecloudplatformclientv2'
|
|
3086
|
-
# setup authorization
|
|
3087
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
3088
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3089
|
-
environment = "mypurecloud.com"
|
|
3090
|
-
|
|
3091
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3092
|
-
|
|
3093
|
-
PureCloud.configure do |config|
|
|
3094
|
-
config.access_token = @authToken
|
|
3095
|
-
end
|
|
3096
|
-
|
|
3097
|
-
api_instance = PureCloud::WorkforceManagementApi.new
|
|
3098
|
-
|
|
3099
|
-
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.
|
|
3100
|
-
|
|
3101
|
-
agent_id = "agent_id_example" # String | The agent id
|
|
3102
|
-
|
|
3103
|
-
body = PureCloud::UpdateAgentRequest.new # UpdateAgentRequest | The request body
|
|
3104
|
-
|
|
3105
|
-
|
|
3106
|
-
begin
|
|
3107
|
-
#Update agent details
|
|
3108
|
-
api_instance.patch_workforcemanagement_managementunit_agent(management_unit_id, agent_id, body)
|
|
3109
|
-
rescue PureCloud::ApiError => e
|
|
3110
|
-
puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_agent: #{e}"
|
|
3111
|
-
end
|
|
3112
|
-
```
|
|
3113
|
-
|
|
3114
|
-
### Parameters
|
|
3115
|
-
|
|
3116
|
-
Name | Type | Description | Notes
|
|
3117
|
-
------------- | ------------- | ------------- | -------------
|
|
3118
|
-
**management_unit_id** | **String**| The id of the management unit, or 'mine' for the management unit of the logged-in user. | |
|
|
3119
|
-
**agent_id** | **String**| The agent id | |
|
|
3120
|
-
**body** | [**UpdateAgentRequest**](UpdateAgentRequest.html)| The request body | |
|
|
3121
|
-
{: class="table table-striped"}
|
|
3122
|
-
|
|
3123
|
-
|
|
3124
|
-
### Return type
|
|
3125
|
-
|
|
3126
|
-
nil (empty response body)
|
|
3127
|
-
|
|
3128
|
-
### HTTP request headers
|
|
3129
|
-
|
|
3130
|
-
- **Content-Type**: application/json
|
|
3131
|
-
- **Accept**: application/json
|
|
3132
|
-
|
|
3133
|
-
|
|
3134
|
-
|
|
3135
2871
|
<a name="patch_workforcemanagement_managementunit_scheduling_run"></a>
|
|
3136
2872
|
|
|
3137
2873
|
## [**RescheduleResult**](RescheduleResult.html) patch_workforcemanagement_managementunit_scheduling_run(management_unit_id, run_id, opts)
|
|
@@ -3218,7 +2954,6 @@ Wraps PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/servi
|
|
|
3218
2954
|
|
|
3219
2955
|
Requires ANY permissions:
|
|
3220
2956
|
|
|
3221
|
-
* wfm:serviceGoalGroup:administer
|
|
3222
2957
|
* wfm:serviceGoalGroup:edit
|
|
3223
2958
|
|
|
3224
2959
|
|
|
@@ -3291,7 +3026,6 @@ Wraps PATCH /api/v2/workforcemanagement/managementunits/{muId}/settings
|
|
|
3291
3026
|
|
|
3292
3027
|
Requires ANY permissions:
|
|
3293
3028
|
|
|
3294
|
-
* wfm:managementUnit:administer
|
|
3295
3029
|
* wfm:managementUnit:edit
|
|
3296
3030
|
|
|
3297
3031
|
|
|
@@ -3361,7 +3095,6 @@ Wraps PATCH /api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/ti
|
|
|
3361
3095
|
|
|
3362
3096
|
Requires ANY permissions:
|
|
3363
3097
|
|
|
3364
|
-
* wfm:timeOffRequest:administer
|
|
3365
3098
|
* wfm:timeOffRequest:edit
|
|
3366
3099
|
|
|
3367
3100
|
|
|
@@ -3437,7 +3170,6 @@ Wraps PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks
|
|
|
3437
3170
|
|
|
3438
3171
|
Requires ANY permissions:
|
|
3439
3172
|
|
|
3440
|
-
* wfm:schedule:administer
|
|
3441
3173
|
* wfm:schedule:edit
|
|
3442
3174
|
|
|
3443
3175
|
|
|
@@ -3517,7 +3249,6 @@ Wraps PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/workp
|
|
|
3517
3249
|
|
|
3518
3250
|
Requires ANY permissions:
|
|
3519
3251
|
|
|
3520
|
-
* wfm:workPlan:administer
|
|
3521
3252
|
* wfm:workPlan:edit
|
|
3522
3253
|
|
|
3523
3254
|
|
|
@@ -3726,7 +3457,6 @@ Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/activitycodes
|
|
|
3726
3457
|
Requires ANY permissions:
|
|
3727
3458
|
|
|
3728
3459
|
* wfm:activityCode:add
|
|
3729
|
-
* wfm:activityCode:administer
|
|
3730
3460
|
|
|
3731
3461
|
|
|
3732
3462
|
### Example
|
|
@@ -3934,7 +3664,6 @@ Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/schedules/search
|
|
|
3934
3664
|
Requires ANY permissions:
|
|
3935
3665
|
|
|
3936
3666
|
* wfm:publishedSchedule:view
|
|
3937
|
-
* wfm:schedule:administer
|
|
3938
3667
|
* wfm:schedule:view
|
|
3939
3668
|
|
|
3940
3669
|
|
|
@@ -4005,7 +3734,6 @@ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/servic
|
|
|
4005
3734
|
Requires ANY permissions:
|
|
4006
3735
|
|
|
4007
3736
|
* wfm:serviceGoalGroup:add
|
|
4008
|
-
* wfm:serviceGoalGroup:administer
|
|
4009
3737
|
|
|
4010
3738
|
|
|
4011
3739
|
### Example
|
|
@@ -4074,7 +3802,6 @@ Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests
|
|
|
4074
3802
|
|
|
4075
3803
|
Requires ANY permissions:
|
|
4076
3804
|
|
|
4077
|
-
* wfm:timeOffRequest:administer
|
|
4078
3805
|
* wfm:timeOffRequest:add
|
|
4079
3806
|
|
|
4080
3807
|
|
|
@@ -4144,7 +3871,6 @@ Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests/fe
|
|
|
4144
3871
|
|
|
4145
3872
|
Requires ANY permissions:
|
|
4146
3873
|
|
|
4147
|
-
* wfm:timeOffRequest:administer
|
|
4148
3874
|
* wfm:timeOffRequest:view
|
|
4149
3875
|
|
|
4150
3876
|
|
|
@@ -4214,7 +3940,6 @@ Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests/qu
|
|
|
4214
3940
|
|
|
4215
3941
|
Requires ANY permissions:
|
|
4216
3942
|
|
|
4217
|
-
* wfm:timeOffRequest:administer
|
|
4218
3943
|
* wfm:timeOffRequest:view
|
|
4219
3944
|
|
|
4220
3945
|
|
|
@@ -4285,7 +4010,6 @@ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/
|
|
|
4285
4010
|
Requires ANY permissions:
|
|
4286
4011
|
|
|
4287
4012
|
* wfm:schedule:add
|
|
4288
|
-
* wfm:schedule:administer
|
|
4289
4013
|
|
|
4290
4014
|
|
|
4291
4015
|
### Example
|
|
@@ -4364,7 +4088,6 @@ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/
|
|
|
4364
4088
|
|
|
4365
4089
|
Requires ANY permissions:
|
|
4366
4090
|
|
|
4367
|
-
* wfm:schedule:administer
|
|
4368
4091
|
* wfm:schedule:edit
|
|
4369
4092
|
|
|
4370
4093
|
|
|
@@ -4441,7 +4164,6 @@ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/
|
|
|
4441
4164
|
Requires ANY permissions:
|
|
4442
4165
|
|
|
4443
4166
|
* wfm:schedule:add
|
|
4444
|
-
* wfm:schedule:administer
|
|
4445
4167
|
|
|
4446
4168
|
|
|
4447
4169
|
### Example
|
|
@@ -4590,7 +4312,6 @@ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/
|
|
|
4590
4312
|
Requires ANY permissions:
|
|
4591
4313
|
|
|
4592
4314
|
* wfm:schedule:add
|
|
4593
|
-
* wfm:schedule:administer
|
|
4594
4315
|
* wfm:schedule:edit
|
|
4595
4316
|
|
|
4596
4317
|
|
|
@@ -4649,296 +4370,6 @@ Name | Type | Description | Notes
|
|
|
4649
4370
|
|
|
4650
4371
|
|
|
4651
4372
|
|
|
4652
|
-
<a name="post_workforcemanagement_managementunit_week_shifttrade_match"></a>
|
|
4653
|
-
|
|
4654
|
-
## [**MatchShiftTradeResponse**](MatchShiftTradeResponse.html) post_workforcemanagement_managementunit_week_shifttrade_match(management_unit_id, week_date_id, body, trade_id)
|
|
4655
|
-
|
|
4656
|
-
|
|
4657
|
-
|
|
4658
|
-
Matches a shift trade. This route can only be called by the receiving agent
|
|
4659
|
-
|
|
4660
|
-
|
|
4661
|
-
|
|
4662
|
-
Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}/match
|
|
4663
|
-
|
|
4664
|
-
Requires ANY permissions:
|
|
4665
|
-
|
|
4666
|
-
* wfm:agentShiftTradeRequest:participate
|
|
4667
|
-
|
|
4668
|
-
|
|
4669
|
-
### Example
|
|
4670
|
-
```{"language":"ruby"}
|
|
4671
|
-
# load the gem
|
|
4672
|
-
require 'purecloudplatformclientv2'
|
|
4673
|
-
# setup authorization
|
|
4674
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
4675
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
4676
|
-
environment = "mypurecloud.com"
|
|
4677
|
-
|
|
4678
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
4679
|
-
|
|
4680
|
-
PureCloud.configure do |config|
|
|
4681
|
-
config.access_token = @authToken
|
|
4682
|
-
end
|
|
4683
|
-
|
|
4684
|
-
api_instance = PureCloud::WorkforceManagementApi.new
|
|
4685
|
-
|
|
4686
|
-
management_unit_id = "management_unit_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
4687
|
-
|
|
4688
|
-
week_date_id = Date.parse("2013-10-20") # Date | The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
4689
|
-
|
|
4690
|
-
body = PureCloud::MatchShiftTradeRequest.new # MatchShiftTradeRequest | body
|
|
4691
|
-
|
|
4692
|
-
trade_id = "trade_id_example" # String | The ID of the shift trade to update
|
|
4693
|
-
|
|
4694
|
-
|
|
4695
|
-
begin
|
|
4696
|
-
#Matches a shift trade. This route can only be called by the receiving agent
|
|
4697
|
-
result = api_instance.post_workforcemanagement_managementunit_week_shifttrade_match(management_unit_id, week_date_id, body, trade_id)
|
|
4698
|
-
p result
|
|
4699
|
-
rescue PureCloud::ApiError => e
|
|
4700
|
-
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_shifttrade_match: #{e}"
|
|
4701
|
-
end
|
|
4702
|
-
```
|
|
4703
|
-
|
|
4704
|
-
### Parameters
|
|
4705
|
-
|
|
4706
|
-
Name | Type | Description | Notes
|
|
4707
|
-
------------- | ------------- | ------------- | -------------
|
|
4708
|
-
**management_unit_id** | **String**| The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user. | |
|
|
4709
|
-
**week_date_id** | **Date**| The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | |
|
|
4710
|
-
**body** | [**MatchShiftTradeRequest**](MatchShiftTradeRequest.html)| body | |
|
|
4711
|
-
**trade_id** | **String**| The ID of the shift trade to update | |
|
|
4712
|
-
{: class="table table-striped"}
|
|
4713
|
-
|
|
4714
|
-
|
|
4715
|
-
### Return type
|
|
4716
|
-
|
|
4717
|
-
[**MatchShiftTradeResponse**](MatchShiftTradeResponse.html)
|
|
4718
|
-
|
|
4719
|
-
### HTTP request headers
|
|
4720
|
-
|
|
4721
|
-
- **Content-Type**: application/json
|
|
4722
|
-
- **Accept**: application/json
|
|
4723
|
-
|
|
4724
|
-
|
|
4725
|
-
|
|
4726
|
-
<a name="post_workforcemanagement_managementunit_week_shifttrade_update"></a>
|
|
4727
|
-
|
|
4728
|
-
## [**ShiftTradeResponse**](ShiftTradeResponse.html) post_workforcemanagement_managementunit_week_shifttrade_update(management_unit_id, week_date_id, body, trade_id)
|
|
4729
|
-
|
|
4730
|
-
|
|
4731
|
-
|
|
4732
|
-
Updates a shift trade. This route can only be called by the initiating agent
|
|
4733
|
-
|
|
4734
|
-
|
|
4735
|
-
|
|
4736
|
-
Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}/update
|
|
4737
|
-
|
|
4738
|
-
Requires ANY permissions:
|
|
4739
|
-
|
|
4740
|
-
* wfm:agentShiftTradeRequest:participate
|
|
4741
|
-
|
|
4742
|
-
|
|
4743
|
-
### Example
|
|
4744
|
-
```{"language":"ruby"}
|
|
4745
|
-
# load the gem
|
|
4746
|
-
require 'purecloudplatformclientv2'
|
|
4747
|
-
# setup authorization
|
|
4748
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
4749
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
4750
|
-
environment = "mypurecloud.com"
|
|
4751
|
-
|
|
4752
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
4753
|
-
|
|
4754
|
-
PureCloud.configure do |config|
|
|
4755
|
-
config.access_token = @authToken
|
|
4756
|
-
end
|
|
4757
|
-
|
|
4758
|
-
api_instance = PureCloud::WorkforceManagementApi.new
|
|
4759
|
-
|
|
4760
|
-
management_unit_id = "management_unit_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
4761
|
-
|
|
4762
|
-
week_date_id = Date.parse("2013-10-20") # Date | The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
4763
|
-
|
|
4764
|
-
body = PureCloud::UpdateShiftTradeRequest.new # UpdateShiftTradeRequest | body
|
|
4765
|
-
|
|
4766
|
-
trade_id = "trade_id_example" # String | The ID of the shift trade to update
|
|
4767
|
-
|
|
4768
|
-
|
|
4769
|
-
begin
|
|
4770
|
-
#Updates a shift trade. This route can only be called by the initiating agent
|
|
4771
|
-
result = api_instance.post_workforcemanagement_managementunit_week_shifttrade_update(management_unit_id, week_date_id, body, trade_id)
|
|
4772
|
-
p result
|
|
4773
|
-
rescue PureCloud::ApiError => e
|
|
4774
|
-
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_shifttrade_update: #{e}"
|
|
4775
|
-
end
|
|
4776
|
-
```
|
|
4777
|
-
|
|
4778
|
-
### Parameters
|
|
4779
|
-
|
|
4780
|
-
Name | Type | Description | Notes
|
|
4781
|
-
------------- | ------------- | ------------- | -------------
|
|
4782
|
-
**management_unit_id** | **String**| The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user. | |
|
|
4783
|
-
**week_date_id** | **Date**| The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | |
|
|
4784
|
-
**body** | [**UpdateShiftTradeRequest**](UpdateShiftTradeRequest.html)| body | |
|
|
4785
|
-
**trade_id** | **String**| The ID of the shift trade to update | |
|
|
4786
|
-
{: class="table table-striped"}
|
|
4787
|
-
|
|
4788
|
-
|
|
4789
|
-
### Return type
|
|
4790
|
-
|
|
4791
|
-
[**ShiftTradeResponse**](ShiftTradeResponse.html)
|
|
4792
|
-
|
|
4793
|
-
### HTTP request headers
|
|
4794
|
-
|
|
4795
|
-
- **Content-Type**: application/json
|
|
4796
|
-
- **Accept**: application/json
|
|
4797
|
-
|
|
4798
|
-
|
|
4799
|
-
|
|
4800
|
-
<a name="post_workforcemanagement_managementunit_week_shifttrades"></a>
|
|
4801
|
-
|
|
4802
|
-
## [**ShiftTradeResponse**](ShiftTradeResponse.html) post_workforcemanagement_managementunit_week_shifttrades(management_unit_id, week_date_id, body)
|
|
4803
|
-
|
|
4804
|
-
|
|
4805
|
-
|
|
4806
|
-
Adds a shift trade
|
|
4807
|
-
|
|
4808
|
-
|
|
4809
|
-
|
|
4810
|
-
Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades
|
|
4811
|
-
|
|
4812
|
-
Requires ANY permissions:
|
|
4813
|
-
|
|
4814
|
-
* wfm:agentShiftTradeRequest:participate
|
|
4815
|
-
|
|
4816
|
-
|
|
4817
|
-
### Example
|
|
4818
|
-
```{"language":"ruby"}
|
|
4819
|
-
# load the gem
|
|
4820
|
-
require 'purecloudplatformclientv2'
|
|
4821
|
-
# setup authorization
|
|
4822
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
4823
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
4824
|
-
environment = "mypurecloud.com"
|
|
4825
|
-
|
|
4826
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
4827
|
-
|
|
4828
|
-
PureCloud.configure do |config|
|
|
4829
|
-
config.access_token = @authToken
|
|
4830
|
-
end
|
|
4831
|
-
|
|
4832
|
-
api_instance = PureCloud::WorkforceManagementApi.new
|
|
4833
|
-
|
|
4834
|
-
management_unit_id = "management_unit_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
4835
|
-
|
|
4836
|
-
week_date_id = Date.parse("2013-10-20") # Date | The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
4837
|
-
|
|
4838
|
-
body = PureCloud::AddShiftTradeRequest.new # AddShiftTradeRequest | body
|
|
4839
|
-
|
|
4840
|
-
|
|
4841
|
-
begin
|
|
4842
|
-
#Adds a shift trade
|
|
4843
|
-
result = api_instance.post_workforcemanagement_managementunit_week_shifttrades(management_unit_id, week_date_id, body)
|
|
4844
|
-
p result
|
|
4845
|
-
rescue PureCloud::ApiError => e
|
|
4846
|
-
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_shifttrades: #{e}"
|
|
4847
|
-
end
|
|
4848
|
-
```
|
|
4849
|
-
|
|
4850
|
-
### Parameters
|
|
4851
|
-
|
|
4852
|
-
Name | Type | Description | Notes
|
|
4853
|
-
------------- | ------------- | ------------- | -------------
|
|
4854
|
-
**management_unit_id** | **String**| The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user. | |
|
|
4855
|
-
**week_date_id** | **Date**| The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | |
|
|
4856
|
-
**body** | [**AddShiftTradeRequest**](AddShiftTradeRequest.html)| body | |
|
|
4857
|
-
{: class="table table-striped"}
|
|
4858
|
-
|
|
4859
|
-
|
|
4860
|
-
### Return type
|
|
4861
|
-
|
|
4862
|
-
[**ShiftTradeResponse**](ShiftTradeResponse.html)
|
|
4863
|
-
|
|
4864
|
-
### HTTP request headers
|
|
4865
|
-
|
|
4866
|
-
- **Content-Type**: application/json
|
|
4867
|
-
- **Accept**: application/json
|
|
4868
|
-
|
|
4869
|
-
|
|
4870
|
-
|
|
4871
|
-
<a name="post_workforcemanagement_managementunit_week_shifttrades_search"></a>
|
|
4872
|
-
|
|
4873
|
-
## [**SearchShiftTradesResponse**](SearchShiftTradesResponse.html) post_workforcemanagement_managementunit_week_shifttrades_search(management_unit_id, week_date_id, body)
|
|
4874
|
-
|
|
4875
|
-
|
|
4876
|
-
|
|
4877
|
-
Searches for potential shift trade matches for the current agent
|
|
4878
|
-
|
|
4879
|
-
|
|
4880
|
-
|
|
4881
|
-
Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/search
|
|
4882
|
-
|
|
4883
|
-
Requires ANY permissions:
|
|
4884
|
-
|
|
4885
|
-
* wfm:agentShiftTradeRequest:participate
|
|
4886
|
-
|
|
4887
|
-
|
|
4888
|
-
### Example
|
|
4889
|
-
```{"language":"ruby"}
|
|
4890
|
-
# load the gem
|
|
4891
|
-
require 'purecloudplatformclientv2'
|
|
4892
|
-
# setup authorization
|
|
4893
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
4894
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
4895
|
-
environment = "mypurecloud.com"
|
|
4896
|
-
|
|
4897
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
4898
|
-
|
|
4899
|
-
PureCloud.configure do |config|
|
|
4900
|
-
config.access_token = @authToken
|
|
4901
|
-
end
|
|
4902
|
-
|
|
4903
|
-
api_instance = PureCloud::WorkforceManagementApi.new
|
|
4904
|
-
|
|
4905
|
-
management_unit_id = "management_unit_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
4906
|
-
|
|
4907
|
-
week_date_id = Date.parse("2013-10-20") # Date | The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
4908
|
-
|
|
4909
|
-
body = PureCloud::SearchShiftTradesRequest.new # SearchShiftTradesRequest | body
|
|
4910
|
-
|
|
4911
|
-
|
|
4912
|
-
begin
|
|
4913
|
-
#Searches for potential shift trade matches for the current agent
|
|
4914
|
-
result = api_instance.post_workforcemanagement_managementunit_week_shifttrades_search(management_unit_id, week_date_id, body)
|
|
4915
|
-
p result
|
|
4916
|
-
rescue PureCloud::ApiError => e
|
|
4917
|
-
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_shifttrades_search: #{e}"
|
|
4918
|
-
end
|
|
4919
|
-
```
|
|
4920
|
-
|
|
4921
|
-
### Parameters
|
|
4922
|
-
|
|
4923
|
-
Name | Type | Description | Notes
|
|
4924
|
-
------------- | ------------- | ------------- | -------------
|
|
4925
|
-
**management_unit_id** | **String**| The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user. | |
|
|
4926
|
-
**week_date_id** | **Date**| The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | |
|
|
4927
|
-
**body** | [**SearchShiftTradesRequest**](SearchShiftTradesRequest.html)| body | |
|
|
4928
|
-
{: class="table table-striped"}
|
|
4929
|
-
|
|
4930
|
-
|
|
4931
|
-
### Return type
|
|
4932
|
-
|
|
4933
|
-
[**SearchShiftTradesResponse**](SearchShiftTradesResponse.html)
|
|
4934
|
-
|
|
4935
|
-
### HTTP request headers
|
|
4936
|
-
|
|
4937
|
-
- **Content-Type**: application/json
|
|
4938
|
-
- **Accept**: application/json
|
|
4939
|
-
|
|
4940
|
-
|
|
4941
|
-
|
|
4942
4373
|
<a name="post_workforcemanagement_managementunit_week_shorttermforecast_copy"></a>
|
|
4943
4374
|
|
|
4944
4375
|
## [**ShortTermForecastResponse**](ShortTermForecastResponse.html) post_workforcemanagement_managementunit_week_shorttermforecast_copy(management_unit_id, week_date_id, forecast_id, body, opts)
|
|
@@ -4954,7 +4385,6 @@ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/
|
|
|
4954
4385
|
Requires ANY permissions:
|
|
4955
4386
|
|
|
4956
4387
|
* wfm:shortTermForecast:add
|
|
4957
|
-
* wfm:shortTermForecast:administer
|
|
4958
4388
|
|
|
4959
4389
|
|
|
4960
4390
|
### Example
|
|
@@ -5033,7 +4463,6 @@ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/
|
|
|
5033
4463
|
Requires ANY permissions:
|
|
5034
4464
|
|
|
5035
4465
|
* wfm:shortTermForecast:add
|
|
5036
|
-
* wfm:shortTermForecast:administer
|
|
5037
4466
|
|
|
5038
4467
|
|
|
5039
4468
|
### Example
|
|
@@ -5109,7 +4538,6 @@ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/
|
|
|
5109
4538
|
Requires ANY permissions:
|
|
5110
4539
|
|
|
5111
4540
|
* wfm:shortTermForecast:add
|
|
5112
|
-
* wfm:shortTermForecast:administer
|
|
5113
4541
|
|
|
5114
4542
|
|
|
5115
4543
|
### Example
|
|
@@ -5185,7 +4613,6 @@ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/
|
|
|
5185
4613
|
Requires ANY permissions:
|
|
5186
4614
|
|
|
5187
4615
|
* wfm:shortTermForecast:add
|
|
5188
|
-
* wfm:shortTermForecast:administer
|
|
5189
4616
|
|
|
5190
4617
|
|
|
5191
4618
|
### Example
|
|
@@ -5257,7 +4684,6 @@ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/workpl
|
|
|
5257
4684
|
Requires ANY permissions:
|
|
5258
4685
|
|
|
5259
4686
|
* wfm:workPlan:add
|
|
5260
|
-
* wfm:workPlan:administer
|
|
5261
4687
|
|
|
5262
4688
|
|
|
5263
4689
|
### Example
|
|
@@ -5330,7 +4756,6 @@ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/workpl
|
|
|
5330
4756
|
Requires ANY permissions:
|
|
5331
4757
|
|
|
5332
4758
|
* wfm:workPlan:add
|
|
5333
|
-
* wfm:workPlan:administer
|
|
5334
4759
|
|
|
5335
4760
|
|
|
5336
4761
|
### Example
|
|
@@ -5399,7 +4824,6 @@ Wraps POST /api/v2/workforcemanagement/managementunits
|
|
|
5399
4824
|
|
|
5400
4825
|
Requires ANY permissions:
|
|
5401
4826
|
|
|
5402
|
-
* wfm:managementUnit:administer
|
|
5403
4827
|
* wfm:managementUnit:add
|
|
5404
4828
|
|
|
5405
4829
|
|
|
@@ -5533,7 +4957,6 @@ Requires ANY permissions:
|
|
|
5533
4957
|
|
|
5534
4958
|
* wfm:agentSchedule:view
|
|
5535
4959
|
* wfm:publishedSchedule:view
|
|
5536
|
-
* wfm:schedule:administer
|
|
5537
4960
|
|
|
5538
4961
|
|
|
5539
4962
|
### Example
|
|
@@ -5651,78 +5074,3 @@ Name | Type | Description | Notes
|
|
|
5651
5074
|
|
|
5652
5075
|
|
|
5653
5076
|
|
|
5654
|
-
<a name="put_workforcemanagement_managementunit_week_shifttrade_state"></a>
|
|
5655
|
-
|
|
5656
|
-
## [**ShiftTradeResponse**](ShiftTradeResponse.html) put_workforcemanagement_managementunit_week_shifttrade_state(management_unit_id, week_date_id, trade_id, body)
|
|
5657
|
-
|
|
5658
|
-
|
|
5659
|
-
|
|
5660
|
-
Updates a shift trade state
|
|
5661
|
-
|
|
5662
|
-
|
|
5663
|
-
|
|
5664
|
-
Wraps PUT /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}/state
|
|
5665
|
-
|
|
5666
|
-
Requires ANY permissions:
|
|
5667
|
-
|
|
5668
|
-
* wfm:agentShiftTradeRequest:participate
|
|
5669
|
-
* wfm:shiftTradeRequest:edit
|
|
5670
|
-
|
|
5671
|
-
|
|
5672
|
-
### Example
|
|
5673
|
-
```{"language":"ruby"}
|
|
5674
|
-
# load the gem
|
|
5675
|
-
require 'purecloudplatformclientv2'
|
|
5676
|
-
# setup authorization
|
|
5677
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
5678
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
5679
|
-
environment = "mypurecloud.com"
|
|
5680
|
-
|
|
5681
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
5682
|
-
|
|
5683
|
-
PureCloud.configure do |config|
|
|
5684
|
-
config.access_token = @authToken
|
|
5685
|
-
end
|
|
5686
|
-
|
|
5687
|
-
api_instance = PureCloud::WorkforceManagementApi.new
|
|
5688
|
-
|
|
5689
|
-
management_unit_id = "management_unit_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
5690
|
-
|
|
5691
|
-
week_date_id = Date.parse("2013-10-20") # Date | The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
5692
|
-
|
|
5693
|
-
trade_id = "trade_id_example" # String | The ID of the shift trade to update
|
|
5694
|
-
|
|
5695
|
-
body = PureCloud::UpdateShiftTradeStateRequest.new # UpdateShiftTradeStateRequest | body
|
|
5696
|
-
|
|
5697
|
-
|
|
5698
|
-
begin
|
|
5699
|
-
#Updates a shift trade state
|
|
5700
|
-
result = api_instance.put_workforcemanagement_managementunit_week_shifttrade_state(management_unit_id, week_date_id, trade_id, body)
|
|
5701
|
-
p result
|
|
5702
|
-
rescue PureCloud::ApiError => e
|
|
5703
|
-
puts "Exception when calling WorkforceManagementApi->put_workforcemanagement_managementunit_week_shifttrade_state: #{e}"
|
|
5704
|
-
end
|
|
5705
|
-
```
|
|
5706
|
-
|
|
5707
|
-
### Parameters
|
|
5708
|
-
|
|
5709
|
-
Name | Type | Description | Notes
|
|
5710
|
-
------------- | ------------- | ------------- | -------------
|
|
5711
|
-
**management_unit_id** | **String**| The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user. | |
|
|
5712
|
-
**week_date_id** | **Date**| The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | |
|
|
5713
|
-
**trade_id** | **String**| The ID of the shift trade to update | |
|
|
5714
|
-
**body** | [**UpdateShiftTradeStateRequest**](UpdateShiftTradeStateRequest.html)| body | |
|
|
5715
|
-
{: class="table table-striped"}
|
|
5716
|
-
|
|
5717
|
-
|
|
5718
|
-
### Return type
|
|
5719
|
-
|
|
5720
|
-
[**ShiftTradeResponse**](ShiftTradeResponse.html)
|
|
5721
|
-
|
|
5722
|
-
### HTTP request headers
|
|
5723
|
-
|
|
5724
|
-
- **Content-Type**: application/json
|
|
5725
|
-
- **Accept**: application/json
|
|
5726
|
-
|
|
5727
|
-
|
|
5728
|
-
|