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
data/docs/JourneyCampaign.md
DELETED
@@ -1,19 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: JourneyCampaign
|
3
|
-
---
|
4
|
-
## PureCloud::JourneyCampaign
|
5
|
-
|
6
|
-
## Properties
|
7
|
-
|
8
|
-
|Name | Type | Description | Notes|
|
9
|
-
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **content** | **String** | Differentiate ads or links that point to the same URL (e.g. textlink). | [optional] |
|
11
|
-
| **medium** | **String** | Identify a medium such as email or cost-per-click (e.g. CPC). | [optional] |
|
12
|
-
| **name** | **String** | Identify a specific product promotion or strategic campaign (e.g. 320banner). | [optional] |
|
13
|
-
| **source** | **String** | Identify a search engine, newsletter name, or other source (e.g. Google). | [optional] |
|
14
|
-
| **term** | **String** | Note the keywords for this ad (e.g. running+shoes). | [optional] |
|
15
|
-
| **click_id** | **String** | The click ID (unique number that is generated when a potential customer clicks on an affiliate link). | [optional] |
|
16
|
-
| **network** | **String** | The ad network to which the click ID belongs. | [optional] |
|
17
|
-
{: class="table table-striped"}
|
18
|
-
|
19
|
-
|
data/docs/JourneyGeolocation.md
DELETED
@@ -1,22 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: JourneyGeolocation
|
3
|
-
---
|
4
|
-
## PureCloud::JourneyGeolocation
|
5
|
-
|
6
|
-
## Properties
|
7
|
-
|
8
|
-
|Name | Type | Description | Notes|
|
9
|
-
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **country** | **String** | Geolocation's ISO 3166-1 alpha-2 country code. | [optional] |
|
11
|
-
| **country_name** | **String** | Geolocation's country name. | [optional] |
|
12
|
-
| **latitude** | **Float** | Geolocation's latitude. | [optional] |
|
13
|
-
| **longitude** | **Float** | Geolocation's longitude. | [optional] |
|
14
|
-
| **locality** | **String** | Geolocation's locality or city. | [optional] |
|
15
|
-
| **postal_code** | **String** | Geolocation's postal code or ZIP code. | [optional] |
|
16
|
-
| **region** | **String** | Geolocation's ISO-3166-2 region code. | [optional] |
|
17
|
-
| **region_name** | **String** | Geolocation's region name. | [optional] |
|
18
|
-
| **source** | **String** | The source that was used to determine the geolocation information. | [optional] |
|
19
|
-
| **timezone** | **String** | Geolocation's timezone. | [optional] |
|
20
|
-
{: class="table table-striped"}
|
21
|
-
|
22
|
-
|
data/docs/JourneyPage.md
DELETED
@@ -1,22 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: JourneyPage
|
3
|
-
---
|
4
|
-
## PureCloud::JourneyPage
|
5
|
-
|
6
|
-
## Properties
|
7
|
-
|
8
|
-
|Name | Type | Description | Notes|
|
9
|
-
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **url** | **String** | The page URL. | |
|
11
|
-
| **title** | **String** | Title of the page. | [optional] |
|
12
|
-
| **domain** | **String** | Domain of the page's URL. | |
|
13
|
-
| **fragment** | **String** | Fragment or hash of the page's URL. | [optional] |
|
14
|
-
| **hostname** | **String** | Hostname of the page's URL. | |
|
15
|
-
| **keywords** | **String** | Keywords from the HTML {@code <meta>} tag of the page. | [optional] |
|
16
|
-
| **lang** | **String** | ISO 639-1 language code for the page as defined in the {@code <html>} tag. | [optional] |
|
17
|
-
| **pathname** | **String** | Path name of the page for the event. | |
|
18
|
-
| **query_string** | **String** | Query string that is passed to the page in the current event. | [optional] |
|
19
|
-
| **breadcrumb** | **Array<String>** | Hierarchy of the current page in relation to the website's structure. | [optional] |
|
20
|
-
{: class="table table-striped"}
|
21
|
-
|
22
|
-
|
data/docs/JourneyPattern.md
DELETED
@@ -1,14 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: JourneyPattern
|
3
|
-
---
|
4
|
-
## PureCloud::JourneyPattern
|
5
|
-
|
6
|
-
## Properties
|
7
|
-
|
8
|
-
|Name | Type | Description | Notes|
|
9
|
-
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **criteria** | [**Array<Criteria>**](Criteria.html) | A list of one or more criteria to satisfy. | |
|
11
|
-
| **count** | **Integer** | The number of times the pattern must match. | [optional] |
|
12
|
-
{: class="table table-striped"}
|
13
|
-
|
14
|
-
|
data/docs/JourneySegment.md
DELETED
@@ -1,25 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: JourneySegment
|
3
|
-
---
|
4
|
-
## PureCloud::JourneySegment
|
5
|
-
|
6
|
-
## Properties
|
7
|
-
|
8
|
-
|Name | Type | Description | Notes|
|
9
|
-
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
|
-
| **name** | **String** | | [optional] |
|
12
|
-
| **is_active** | **BOOLEAN** | Whether or not the segment is active. | [optional] |
|
13
|
-
| **display_name** | **String** | The display name of the segment. | |
|
14
|
-
| **version** | **Integer** | The version of the segment. | [optional] |
|
15
|
-
| **description** | **String** | A description of the segment. | [optional] |
|
16
|
-
| **color** | **String** | The hexadecimal color value of the segment. | [optional] |
|
17
|
-
| **should_display_to_agent** | **BOOLEAN** | Whether or not the segment should be displayed to agent/supervisor users. | [optional] |
|
18
|
-
| **context** | [**Context**](Context.html) | The context of the segment. | [optional] |
|
19
|
-
| **journey** | [**Journey**](Journey.html) | The pattern of rules defining the segment. | [optional] |
|
20
|
-
| **self_uri** | **String** | The URI for this object | [optional] |
|
21
|
-
| **created_date** | **DateTime** | Timestamp indicating when the segment was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
22
|
-
| **modified_date** | **DateTime** | Timestamp indicating when the the segment was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
23
|
-
{: class="table table-striped"}
|
24
|
-
|
25
|
-
|
@@ -1,17 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: JourneySurveyQuestion
|
3
|
-
---
|
4
|
-
## PureCloud::JourneySurveyQuestion
|
5
|
-
|
6
|
-
## Properties
|
7
|
-
|
8
|
-
|Name | Type | Description | Notes|
|
9
|
-
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **type** | **String** | Type of survey question. | [optional] |
|
11
|
-
| **label** | **String** | Label of question. | |
|
12
|
-
| **customer_property** | **String** | The customer property that the answer maps to. | [optional] |
|
13
|
-
| **choices** | **Array<String>** | Choices available to user. | [optional] |
|
14
|
-
| **is_mandatory** | **BOOLEAN** | Whether answering this question is mandatory. | [optional] |
|
15
|
-
{: class="table table-striped"}
|
16
|
-
|
17
|
-
|
@@ -1,15 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: MatchShiftTradeRequest
|
3
|
-
---
|
4
|
-
## PureCloud::MatchShiftTradeRequest
|
5
|
-
|
6
|
-
## Properties
|
7
|
-
|
8
|
-
|Name | Type | Description | Notes|
|
9
|
-
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **receiving_schedule_id** | **String** | The ID of the schedule with which the shift trade is associated | |
|
11
|
-
| **receiving_shift_id** | **String** | The ID of the shift the receiving user is giving up in trade, if applicable | [optional] |
|
12
|
-
| **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Version metadata for the shift trade | |
|
13
|
-
{: class="table table-striped"}
|
14
|
-
|
15
|
-
|
@@ -1,15 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: MatchShiftTradeResponse
|
3
|
-
---
|
4
|
-
## PureCloud::MatchShiftTradeResponse
|
5
|
-
|
6
|
-
## Properties
|
7
|
-
|
8
|
-
|Name | Type | Description | Notes|
|
9
|
-
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **trade** | [**ShiftTradeResponse**](ShiftTradeResponse.html) | The associated shift trade | [optional] |
|
11
|
-
| **violations** | [**Array<ShiftTradeMatchViolation>**](ShiftTradeMatchViolation.html) | Constraint violations which disallow this shift trade | [optional] |
|
12
|
-
| **admin_review_violations** | [**Array<ShiftTradeMatchViolation>**](ShiftTradeMatchViolation.html) | Constraint violations for this shift trade which require shift trade administrator review | [optional] |
|
13
|
-
{: class="table table-striped"}
|
14
|
-
|
15
|
-
|
data/docs/Outcome.md
DELETED
@@ -1,24 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: Outcome
|
3
|
-
---
|
4
|
-
## PureCloud::Outcome
|
5
|
-
|
6
|
-
## Properties
|
7
|
-
|
8
|
-
|Name | Type | Description | Notes|
|
9
|
-
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
|
-
| **name** | **String** | | [optional] |
|
12
|
-
| **is_active** | **BOOLEAN** | Whether or not the outcome is active. | [optional] |
|
13
|
-
| **display_name** | **String** | The display name of the outcome. | |
|
14
|
-
| **version** | **Integer** | The version of the outcome. | [optional] |
|
15
|
-
| **description** | **String** | A description of the outcome. | [optional] |
|
16
|
-
| **is_positive** | **BOOLEAN** | Whether or not the outcome is positive. | [optional] |
|
17
|
-
| **context** | [**Context**](Context.html) | The context of the outcome. | [optional] |
|
18
|
-
| **journey** | [**Journey**](Journey.html) | The pattern of rules defining the filter of the outcome. | [optional] |
|
19
|
-
| **self_uri** | **String** | The URI for this object | [optional] |
|
20
|
-
| **created_date** | **DateTime** | Timestamp indicating when the outcome was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
21
|
-
| **modified_date** | **DateTime** | Timestamp indicating when the outcome was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
22
|
-
{: class="table table-striped"}
|
23
|
-
|
24
|
-
|
@@ -1,22 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: OutcomeAchievedEvent
|
3
|
-
---
|
4
|
-
## PureCloud::OutcomeAchievedEvent
|
5
|
-
|
6
|
-
## Properties
|
7
|
-
|
8
|
-
|Name | Type | Description | Notes|
|
9
|
-
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **outcome** | [**Outcome**](Outcome.html) | The outcome achieved. | |
|
11
|
-
| **user_agent_string** | **String** | HTTP User-Agent string (see https://tools.ietf.org/html/rfc1945#section-10.15). | [optional] |
|
12
|
-
| **browser** | [**Browser**](Browser.html) | Customer's browser. | [optional] |
|
13
|
-
| **device** | [**Device**](Device.html) | Customer's device. | [optional] |
|
14
|
-
| **geolocation** | [**JourneyGeolocation**](JourneyGeolocation.html) | Customer's geolocation. | [optional] |
|
15
|
-
| **ip_address** | **String** | Visitor's IP address. | [optional] |
|
16
|
-
| **ip_organization** | **String** | Visitor's IP-based organization or ISP name. | [optional] |
|
17
|
-
| **mkt_campaign** | [**JourneyCampaign**](JourneyCampaign.html) | Marketing / traffic source information. | [optional] |
|
18
|
-
| **visit_referrer** | [**Referrer**](Referrer.html) | Visit's referrer. | [optional] |
|
19
|
-
| **visit_created_date** | **DateTime** | When visit was created (e.g. timestamp of the first event in visit). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
20
|
-
{: class="table table-striped"}
|
21
|
-
|
22
|
-
|
@@ -1,15 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: OutcomeProbabilityCondition
|
3
|
-
---
|
4
|
-
## PureCloud::OutcomeProbabilityCondition
|
5
|
-
|
6
|
-
## Properties
|
7
|
-
|
8
|
-
|Name | Type | Description | Notes|
|
9
|
-
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **outcome_id** | **String** | The outcome ID. | |
|
11
|
-
| **maximum_probability** | **Float** | Probability value for the selected outcome at or above which the action map will trigger. | |
|
12
|
-
| **probability** | **Float** | Additional probability condition, where if set, the action map will trigger if the current outcome probability is lower or equal to the value. | [optional] |
|
13
|
-
{: class="table table-striped"}
|
14
|
-
|
15
|
-
|
data/docs/Referrer.md
DELETED
@@ -1,21 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: Referrer
|
3
|
-
---
|
4
|
-
## PureCloud::Referrer
|
5
|
-
|
6
|
-
## Properties
|
7
|
-
|
8
|
-
|Name | Type | Description | Notes|
|
9
|
-
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **url** | **String** | Referrer URL. | |
|
11
|
-
| **domain** | **String** | Referrer URL domain. | |
|
12
|
-
| **hostname** | **String** | Referrer URL hostname. | |
|
13
|
-
| **keywords** | **String** | Referrer keywords. | [optional] |
|
14
|
-
| **pathname** | **String** | Referrer URL pathname. | |
|
15
|
-
| **query_string** | **String** | Referrer URL querystring. | [optional] |
|
16
|
-
| **fragment** | **String** | Referrer URL fragment. | [optional] |
|
17
|
-
| **name** | **String** | Name of referrer (e.g. Yahoo!, Google, InfoSpace). | [optional] |
|
18
|
-
| **medium** | **String** | Type of referrer (e.g. search, social). | [optional] |
|
19
|
-
{: class="table table-striped"}
|
20
|
-
|
21
|
-
|
@@ -1,15 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: SearchShiftTradeResponse
|
3
|
-
---
|
4
|
-
## PureCloud::SearchShiftTradeResponse
|
5
|
-
|
6
|
-
## Properties
|
7
|
-
|
8
|
-
|Name | Type | Description | Notes|
|
9
|
-
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **trade** | [**ShiftTradeResponse**](ShiftTradeResponse.html) | A trade which matches search criteria | [optional] |
|
11
|
-
| **matching_receiving_shift_ids** | **Array<String>** | IDs of shifts which match the search criteria | [optional] |
|
12
|
-
| **preview** | [**ShiftTradePreviewResponse**](ShiftTradePreviewResponse.html) | A preview of what the shift trade would look like if matched | [optional] |
|
13
|
-
{: class="table table-striped"}
|
14
|
-
|
15
|
-
|
@@ -1,14 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: SearchShiftTradesRequest
|
3
|
-
---
|
4
|
-
## PureCloud::SearchShiftTradesRequest
|
5
|
-
|
6
|
-
## Properties
|
7
|
-
|
8
|
-
|Name | Type | Description | Notes|
|
9
|
-
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **receiving_schedule_id** | **String** | The ID of the schedule for which to search for available shift trades | |
|
11
|
-
| **receiving_shift_ids** | **Array<String>** | The IDs of shifts that the receiving user would potentially be willing to trade. If empty, only returns one sided trades (pick up a shift) | [optional] |
|
12
|
-
{: class="table table-striped"}
|
13
|
-
|
14
|
-
|
@@ -1,13 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: SearchShiftTradesResponse
|
3
|
-
---
|
4
|
-
## PureCloud::SearchShiftTradesResponse
|
5
|
-
|
6
|
-
## Properties
|
7
|
-
|
8
|
-
|Name | Type | Description | Notes|
|
9
|
-
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **trades** | [**Array<SearchShiftTradeResponse>**](SearchShiftTradeResponse.html) | The shift trades that match the search criteria | [optional] |
|
11
|
-
{: class="table table-striped"}
|
12
|
-
|
13
|
-
|
@@ -1,22 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: SegmentAssignedEvent
|
3
|
-
---
|
4
|
-
## PureCloud::SegmentAssignedEvent
|
5
|
-
|
6
|
-
## Properties
|
7
|
-
|
8
|
-
|Name | Type | Description | Notes|
|
9
|
-
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **segment** | [**JourneySegment**](JourneySegment.html) | The segment that was matched. | |
|
11
|
-
| **user_agent_string** | **String** | HTTP User-Agent string (see https://tools.ietf.org/html/rfc1945#section-10.15). | [optional] |
|
12
|
-
| **browser** | [**Browser**](Browser.html) | Customer's browser. | [optional] |
|
13
|
-
| **device** | [**Device**](Device.html) | Customer's device. | [optional] |
|
14
|
-
| **geolocation** | [**JourneyGeolocation**](JourneyGeolocation.html) | Customer's geolocation. | [optional] |
|
15
|
-
| **ip_address** | **String** | Visitor's IP address. | [optional] |
|
16
|
-
| **ip_organization** | **String** | Visitor's IP-based organization or ISP name. | [optional] |
|
17
|
-
| **mkt_campaign** | [**JourneyCampaign**](JourneyCampaign.html) | Marketing / traffic source information. | [optional] |
|
18
|
-
| **visit_referrer** | [**Referrer**](Referrer.html) | Visit's referrer. | [optional] |
|
19
|
-
| **visit_created_date** | **DateTime** | When visit was created (e.g. timestamp of the first event in visit). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
20
|
-
{: class="table table-striped"}
|
21
|
-
|
22
|
-
|
data/docs/Session.md
DELETED
@@ -1,15 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: Session
|
3
|
-
---
|
4
|
-
## PureCloud::Session
|
5
|
-
|
6
|
-
## Properties
|
7
|
-
|
8
|
-
|Name | Type | Description | Notes|
|
9
|
-
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
|
-
| **name** | **String** | | [optional] |
|
12
|
-
| **self_uri** | **String** | The URI for this object | [optional] |
|
13
|
-
{: class="table table-striped"}
|
14
|
-
|
15
|
-
|
@@ -1,16 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: ShiftTradeActivityPreviewResponse
|
3
|
-
---
|
4
|
-
## PureCloud::ShiftTradeActivityPreviewResponse
|
5
|
-
|
6
|
-
## Properties
|
7
|
-
|
8
|
-
|Name | Type | Description | Notes|
|
9
|
-
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **start_date** | **DateTime** | The start date and time of this activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
11
|
-
| **length_minutes** | **Integer** | The length in minutes of this activity | [optional] |
|
12
|
-
| **activity_code_id** | **String** | The ID of the activity code for this activity | [optional] |
|
13
|
-
| **counts_as_paid_time** | **BOOLEAN** | Whether this activity counts as paid time | [optional] |
|
14
|
-
{: class="table table-striped"}
|
15
|
-
|
16
|
-
|
@@ -1,16 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: ShiftTradeMatchReviewResponse
|
3
|
-
---
|
4
|
-
## PureCloud::ShiftTradeMatchReviewResponse
|
5
|
-
|
6
|
-
## Properties
|
7
|
-
|
8
|
-
|Name | Type | Description | Notes|
|
9
|
-
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **initiating_user** | [**ShiftTradeMatchReviewUserResponse**](ShiftTradeMatchReviewUserResponse.html) | Details for the initiatingUser side of the shift trade | [optional] |
|
11
|
-
| **receiving_user** | [**ShiftTradeMatchReviewUserResponse**](ShiftTradeMatchReviewUserResponse.html) | Details for the receivingUser side of the shift trade | [optional] |
|
12
|
-
| **violations** | [**Array<ShiftTradeMatchViolation>**](ShiftTradeMatchViolation.html) | Constraint violations introduced after being matched that would normally disallow a trade, but which can still be overridden by the shift trade administrator | [optional] |
|
13
|
-
| **admin_review_violations** | [**Array<ShiftTradeMatchViolation>**](ShiftTradeMatchViolation.html) | Constraint violations associated with this shift trade which require shift trade administrator review | [optional] |
|
14
|
-
{: class="table table-striped"}
|
15
|
-
|
16
|
-
|
@@ -1,17 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: ShiftTradeMatchReviewUserResponse
|
3
|
-
---
|
4
|
-
## PureCloud::ShiftTradeMatchReviewUserResponse
|
5
|
-
|
6
|
-
## Properties
|
7
|
-
|
8
|
-
|Name | Type | Description | Notes|
|
9
|
-
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **weekly_minimum_paid_minutes** | **Integer** | The minimum weekly paid minutes for this user per the work plan tied to the agent schedule | [optional] |
|
11
|
-
| **weekly_maximum_paid_minutes** | **Integer** | The maximum weekly paid minutes for this user per the work plan tied to the agent schedule | [optional] |
|
12
|
-
| **pre_trade_schedule_paid_minutes** | **Integer** | The paid minutes on the week schedule for this user prior to the shift trade | [optional] |
|
13
|
-
| **post_trade_schedule_paid_minutes** | **Integer** | The paid minutes on the week schedule for this user if the shift trade is approved | [optional] |
|
14
|
-
| **post_trade_new_shift** | [**ShiftTradePreviewResponse**](ShiftTradePreviewResponse.html) | Preview of what the shift will look like for the opposite side of this trade after the match is approved | [optional] |
|
15
|
-
{: class="table table-striped"}
|
16
|
-
|
17
|
-
|
@@ -1,14 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: ShiftTradeMatchViolation
|
3
|
-
---
|
4
|
-
## PureCloud::ShiftTradeMatchViolation
|
5
|
-
|
6
|
-
## Properties
|
7
|
-
|
8
|
-
|Name | Type | Description | Notes|
|
9
|
-
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **type** | **String** | The type of constraint violation | [optional] |
|
11
|
-
| **params** | **Hash<String, String>** | Clarifying user params for constructing helpful error messages | [optional] |
|
12
|
-
{: class="table table-striped"}
|
13
|
-
|
14
|
-
|
@@ -1,13 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: ShiftTradePreviewResponse
|
3
|
-
---
|
4
|
-
## PureCloud::ShiftTradePreviewResponse
|
5
|
-
|
6
|
-
## Properties
|
7
|
-
|
8
|
-
|Name | Type | Description | Notes|
|
9
|
-
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **activities** | [**Array<ShiftTradeActivityPreviewResponse>**](ShiftTradeActivityPreviewResponse.html) | List of activities that will make up the new shift if this shift trade is approved | [optional] |
|
11
|
-
{: class="table table-striped"}
|
12
|
-
|
13
|
-
|
@@ -1,14 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: ShiftTradeResponseAcceptableIntervals
|
3
|
-
---
|
4
|
-
## PureCloud::ShiftTradeResponseAcceptableIntervals
|
5
|
-
|
6
|
-
## Properties
|
7
|
-
|
8
|
-
|Name | Type | Description | Notes|
|
9
|
-
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **start** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
11
|
-
| **_end** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
12
|
-
{: class="table table-striped"}
|
13
|
-
|
14
|
-
|
data/docs/UpdateAgentRequest.md
DELETED
@@ -1,13 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: UpdateAgentRequest
|
3
|
-
---
|
4
|
-
## PureCloud::UpdateAgentRequest
|
5
|
-
|
6
|
-
## Properties
|
7
|
-
|
8
|
-
|Name | Type | Description | Notes|
|
9
|
-
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **accept_direct_shift_trades** | **BOOLEAN** | Whether the agent accepts direct shift trades | [optional] |
|
11
|
-
{: class="table table-striped"}
|
12
|
-
|
13
|
-
|