purecloudplatformclientv2 32.0.0 → 33.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/AdminTimeOffRequestPatch.md +19 -0
- data/docs/AgentActivityEntityListing.md +2 -2
- data/docs/AttemptLimitsEntityListing.md +2 -2
- data/docs/AttributeEntityListing.md +2 -2
- data/docs/AuthorizationApi.md +6 -6
- data/docs/AuthzDivision.md +18 -0
- data/docs/AvailableTopic.md +1 -1
- data/docs/CalibrationEntityListing.md +2 -2
- data/docs/CallConversationEntityListing.md +2 -2
- data/docs/CallHistoryConversationEntityListing.md +2 -2
- data/docs/CallHistoryParticipant.md +1 -0
- data/docs/CallableTimeSetEntityListing.md +2 -2
- data/docs/CallbackConversationEntityListing.md +2 -2
- data/docs/Campaign.md +1 -0
- data/docs/CampaignDiagnostics.md +1 -0
- 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/CertificateDetails.md +1 -1
- data/docs/Channel.md +1 -1
- data/docs/ChannelTopic.md +1 -1
- 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/ContactColumnTimeZone.md +2 -0
- data/docs/ContactList.md +3 -1
- data/docs/ContactListEntityListing.md +2 -2
- data/docs/ContactListFilterEntityListing.md +2 -2
- data/docs/ContactListing.md +2 -2
- data/docs/ContactPhoneNumberColumn.md +1 -1
- 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/DialerAction.md +1 -1
- data/docs/DialerContact.md +1 -0
- data/docs/DialerEventEntityListing.md +2 -2
- data/docs/Digits.md +1 -1
- data/docs/DirectoryUserDevicesListing.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/DomainOrganizationRole.md +1 -1
- data/docs/DomainOrganizationRoleCreate.md +1 -1
- data/docs/DomainOrganizationRoleUpdate.md +1 -1
- data/docs/DomainPermission.md +1 -0
- 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/EndpointEntityListing.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/ExternalContact.md +1 -1
- data/docs/ExternalOrganization.md +1 -1
- data/docs/ExternalOrganizationListing.md +2 -2
- data/docs/FaxDocumentEntityListing.md +2 -2
- data/docs/Flow.md +1 -0
- data/docs/FlowEntityListing.md +2 -2
- data/docs/FlowVersionEntityListing.md +2 -2
- data/docs/GreetingListing.md +2 -2
- data/docs/GroupEntityListing.md +2 -2
- data/docs/GroupProfileEntityListing.md +2 -2
- data/docs/GroupsApi.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/IntegrationsApi.md +16 -16
- data/docs/InteractionStatsAlertContainer.md +2 -2
- data/docs/InteractionStatsRuleContainer.md +2 -2
- data/docs/JsonNode.md +3 -3
- 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/LocationEntityListing.md +2 -2
- data/docs/LogicalInterfaceEntityListing.md +2 -2
- data/docs/ManagementUnitListing.md +2 -2
- data/docs/MessageConversationEntityListing.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/OutboundSettings.md +2 -0
- 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/QualityApi.md +18 -18
- 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/RecordingApi.md +4 -4
- 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/RoutingApi.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/SiteEntityListing.md +2 -2
- data/docs/SkillEntityListing.md +2 -2
- data/docs/SmsPhoneNumberEntityListing.md +2 -2
- data/docs/StationEntityListing.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/TimeOffRequestList.md +1 -1
- data/docs/{TimeOffRequest.md → TimeOffRequestResponse.md} +15 -15
- data/docs/TimeZone.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/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/UserSchedule.md +3 -0
- data/docs/UserScheduleActivity.md +1 -0
- data/docs/UserScheduleFullDayTimeOffMarker.md +2 -1
- data/docs/UserScheduleShift.md +3 -0
- data/docs/UserSkillEntityListing.md +2 -2
- data/docs/ViewFilter.md +1 -0
- data/docs/VoicemailMessageEntityListing.md +2 -2
- data/docs/WorkforceManagementApi.md +89 -19
- data/docs/WorkspaceEntityListing.md +2 -2
- data/docs/WorkspaceMemberEntityListing.md +2 -2
- data/docs/WrapupCodeEntityListing.md +2 -2
- data/docs/{Entity.md → WritableEntity.md} +2 -2
- data/lib/purecloudplatformclientv2.rb +4 -12
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +6 -6
- data/lib/purecloudplatformclientv2/api/groups_api.rb +3 -3
- data/lib/purecloudplatformclientv2/api/integrations_api.rb +16 -16
- data/lib/purecloudplatformclientv2/api/quality_api.rb +18 -18
- data/lib/purecloudplatformclientv2/api/recording_api.rb +4 -4
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +110 -17
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/{platform.rb → admin_time_off_request_patch.rb} +165 -20
- 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/attribute_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/{paged_listing_entity.rb → authz_division.rb} +69 -34
- data/lib/purecloudplatformclientv2/models/available_topic.rb +0 -1
- 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/call_history_participant.rb +44 -4
- 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.rb +27 -1
- data/lib/purecloudplatformclientv2/models/campaign_diagnostics.rb +30 -4
- 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/certificate_details.rb +13 -13
- data/lib/purecloudplatformclientv2/models/channel.rb +0 -1
- data/lib/purecloudplatformclientv2/models/channel_topic.rb +0 -1
- 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_column_time_zone.rb +68 -2
- data/lib/purecloudplatformclientv2/models/contact_list.rb +54 -2
- 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/contact_phone_number_column.rb +1 -1
- 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_action.rb +1 -1
- data/lib/purecloudplatformclientv2/models/dialer_contact.rb +29 -1
- 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/digits.rb +1 -6
- data/lib/purecloudplatformclientv2/models/directory_user_devices_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/domain_organization_role.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_permission.rb +29 -4
- 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/endpoint_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_contact.rb +1 -1
- data/lib/purecloudplatformclientv2/models/external_organization.rb +1 -1
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/flow.rb +26 -1
- 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/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/json_node.rb +53 -53
- 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/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.rb +2 -2
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/message_data.rb +2 -2
- data/lib/purecloudplatformclientv2/models/message_media_participant.rb +2 -2
- 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/outbound_settings.rb +67 -1
- 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/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/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_off_request_list.rb +1 -1
- data/lib/purecloudplatformclientv2/models/{time_off_request.rb → time_off_request_response.rb} +51 -80
- data/lib/purecloudplatformclientv2/models/time_zone.rb +24 -24
- 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/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_schedule.rb +87 -4
- data/lib/purecloudplatformclientv2/models/user_schedule_activity.rb +30 -4
- data/lib/purecloudplatformclientv2/models/user_schedule_full_day_time_off_marker.rb +31 -5
- data/lib/purecloudplatformclientv2/models/user_schedule_shift.rb +82 -4
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/view_filter.rb +32 -4
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +13 -13
- 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/models/{entity.rb → writable_entity.rb} +1 -1
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +11 -27
- data/docs/AppFoundryApi.md +0 -229
- data/docs/AppFoundryListing.md +0 -36
- data/docs/AppFoundryListingCategory.md +0 -14
- data/docs/AppFoundryListingRegistryInfo.md +0 -14
- data/docs/LocalizedField.md +0 -12
- data/docs/MarketingInfo.md +0 -14
- data/docs/PagedListingEntity.md +0 -17
- data/docs/Platform.md +0 -14
- data/docs/PricingOption.md +0 -14
- data/docs/SmartCase.md +0 -14
- data/lib/purecloudplatformclientv2/api/app_foundry_api.rb +0 -360
- data/lib/purecloudplatformclientv2/models/app_foundry_listing.rb +0 -815
- data/lib/purecloudplatformclientv2/models/app_foundry_listing_category.rb +0 -231
- data/lib/purecloudplatformclientv2/models/app_foundry_listing_registry_info.rb +0 -231
- data/lib/purecloudplatformclientv2/models/localized_field.rb +0 -177
- data/lib/purecloudplatformclientv2/models/marketing_info.rb +0 -229
- data/lib/purecloudplatformclientv2/models/pricing_option.rb +0 -234
- data/lib/purecloudplatformclientv2/models/smart_case.rb +0 -229
|
@@ -1,30 +1,30 @@
|
|
|
1
1
|
---
|
|
2
|
-
title:
|
|
2
|
+
title: TimeOffRequestResponse
|
|
3
3
|
---
|
|
4
|
-
## PureCloud::
|
|
4
|
+
## PureCloud::TimeOffRequestResponse
|
|
5
5
|
|
|
6
6
|
## Properties
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
|
-
| **
|
|
12
|
-
| **
|
|
13
|
-
| **
|
|
14
|
-
| **
|
|
15
|
-
| **
|
|
16
|
-
| **
|
|
17
|
-
| **
|
|
18
|
-
| **daily_duration_minutes** | **Integer** | The daily duration of this
|
|
19
|
-
| **notes** | **String** |
|
|
20
|
-
| **submitted_by** | [**User**](User.html) | The user who submitted this
|
|
11
|
+
| **user** | [**User**](User.html) | The user associated with this time off request | [optional] |
|
|
12
|
+
| **is_full_day_request** | **BOOLEAN** | Whether this is a full day request (false means partial day) | [optional] |
|
|
13
|
+
| **marked_as_read** | **BOOLEAN** | Whether this request has been marked as read by the agent | [optional] |
|
|
14
|
+
| **activity_code_id** | **String** | The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category | [optional] |
|
|
15
|
+
| **status** | **String** | The status of this time off request | [optional] |
|
|
16
|
+
| **partial_day_start_date_times** | **Array<DateTime>** | A set of start date-times in ISO-8601 format for partial day requests. Will be not empty if isFullDayRequest == false | [optional] |
|
|
17
|
+
| **full_day_management_unit_dates** | **Array<String>** | A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone. Will be not empty if isFullDayRequest == true | [optional] |
|
|
18
|
+
| **daily_duration_minutes** | **Integer** | The daily duration of this time off request in minutes | [optional] |
|
|
19
|
+
| **notes** | **String** | Notes about the time off request | [optional] |
|
|
20
|
+
| **submitted_by** | [**User**](User.html) | The user who submitted this time off request | [optional] |
|
|
21
21
|
| **submitted_date** | **DateTime** | The timestamp when this request was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
22
|
-
| **reviewed_by** | [**User**](User.html) | The user who reviewed this
|
|
22
|
+
| **reviewed_by** | [**User**](User.html) | The user who reviewed this time off request | [optional] |
|
|
23
23
|
| **reviewed_date** | **DateTime** | The timestamp when this request was reviewed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
24
|
-
| **modified_by** | [**
|
|
24
|
+
| **modified_by** | [**UserReference**](UserReference.html) | The user who last modified this TimeOffRequestResponse | [optional] |
|
|
25
25
|
| **modified_date** | **DateTime** | The timestamp when this request was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
26
|
+
| **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | The version metadata of the time off request | [optional] |
|
|
26
27
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
27
|
-
| **full_day_management_unit_dates** | **Array<String>** | ISO-8601 date only with no timezones. Should be interpreted in the Management Unit's configured time zone. Required if isFullDayRequest == true | [optional] |
|
|
28
28
|
{: class="table table-striped"}
|
|
29
29
|
|
|
30
30
|
|
data/docs/TimeZone.md
CHANGED
|
@@ -7,10 +7,10 @@ title: TimeZone
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **display_name** | **String** | | [optional] |
|
|
11
|
+
| **id** | **String** | | [optional] |
|
|
10
12
|
| **dstsavings** | **Integer** | | [optional] |
|
|
11
13
|
| **raw_offset** | **Integer** | | [optional] |
|
|
12
|
-
| **id** | **String** | | [optional] |
|
|
13
|
-
| **display_name** | **String** | | [optional] |
|
|
14
14
|
{: class="table table-striped"}
|
|
15
15
|
|
|
16
16
|
|
|
@@ -13,9 +13,9 @@ title: TimeZoneEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_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: TrunkBaseEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/TrunkEntityListing.md
CHANGED
|
@@ -13,9 +13,9 @@ title: TrunkEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_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: TrunkMetabaseEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_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
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_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
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_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
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_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
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_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
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_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
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_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
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_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
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_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
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/UserSchedule.md
CHANGED
|
@@ -9,6 +9,9 @@ title: UserSchedule
|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **shifts** | [**Array<UserScheduleShift>**](UserScheduleShift.html) | The shifts that belong to this schedule | [optional] |
|
|
11
11
|
| **full_day_time_off_markers** | [**Array<UserScheduleFullDayTimeOffMarker>**](UserScheduleFullDayTimeOffMarker.html) | Markers to indicate a full day time off request, relative to the management unit time zone | [optional] |
|
|
12
|
+
| **delete** | **BOOLEAN** | If marked true for updating an existing user schedule, it will be deleted | [optional] |
|
|
13
|
+
| **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Version metadata for this schedule | |
|
|
14
|
+
| **work_plan_id** | **String** | ID of the work plan associated with the user during schedule creation | [optional] |
|
|
12
15
|
{: class="table table-striped"}
|
|
13
16
|
|
|
14
17
|
|
|
@@ -13,6 +13,7 @@ title: UserScheduleActivity
|
|
|
13
13
|
| **description** | **String** | Description for this activity | [optional] |
|
|
14
14
|
| **counts_as_paid_time** | **BOOLEAN** | Whether this activity is paid | [optional] |
|
|
15
15
|
| **is_dst_fallback** | **BOOLEAN** | Whether this activity spans a DST fallback | [optional] |
|
|
16
|
+
| **time_off_request_id** | **String** | Time off request id of this activity | [optional] |
|
|
16
17
|
{: class="table table-striped"}
|
|
17
18
|
|
|
18
19
|
|
|
@@ -7,11 +7,12 @@ title: UserScheduleFullDayTimeOffMarker
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **management_unit_date** | **String** | The date associated with the time off request that this marker corresponds to. Date only, in ISO-8601 format | [optional] |
|
|
10
|
+
| **management_unit_date** | **String** | The date associated with the time off request that this marker corresponds to. Date only, in ISO-8601 format. | [optional] |
|
|
11
11
|
| **activity_code_id** | **String** | The id for the activity code. Look up a map of activity codes with the activities route | [optional] |
|
|
12
12
|
| **is_paid** | **BOOLEAN** | Whether this is paid time off | [optional] |
|
|
13
13
|
| **length_in_minutes** | **Integer** | The length in minutes of this time off marker | [optional] |
|
|
14
14
|
| **description** | **String** | The description associated with the time off request that this marker corresponds to | [optional] |
|
|
15
|
+
| **delete** | **BOOLEAN** | If marked true for updating an existing full day time off marker, it will be deleted | [optional] |
|
|
15
16
|
{: class="table table-striped"}
|
|
16
17
|
|
|
17
18
|
|
data/docs/UserScheduleShift.md
CHANGED
|
@@ -7,9 +7,12 @@ title: UserScheduleShift
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | ID of the schedule shift. This is only for the case of updating and deleting an existing shift | [optional] |
|
|
10
11
|
| **start_date** | **DateTime** | Start time in UTC for this shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
11
12
|
| **length_in_minutes** | **Integer** | Length of this shift in minutes | [optional] |
|
|
12
13
|
| **activities** | [**Array<UserScheduleActivity>**](UserScheduleActivity.html) | List of activities in this shift | [optional] |
|
|
14
|
+
| **delete** | **BOOLEAN** | If marked true for updating this schedule shift, it will be deleted | [optional] |
|
|
15
|
+
| **manually_edited** | **BOOLEAN** | Whether the shift was set as manually edited | [optional] |
|
|
13
16
|
{: class="table table-striped"}
|
|
14
17
|
|
|
15
18
|
|
|
@@ -13,9 +13,9 @@ title: UserSkillEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/ViewFilter.md
CHANGED
|
@@ -29,6 +29,7 @@ title: ViewFilter
|
|
|
29
29
|
| **evaluator_ids** | **Array<String>** | The evaluator ids are used to filter the view | [optional] |
|
|
30
30
|
| **transferred** | **BOOLEAN** | Indicates filtering for transfers | [optional] |
|
|
31
31
|
| **abandoned** | **BOOLEAN** | Indicates filtering for abandons | [optional] |
|
|
32
|
+
| **message_types** | **Array<String>** | The message media types used to filter the view | [optional] |
|
|
32
33
|
{: class="table table-striped"}
|
|
33
34
|
|
|
34
35
|
|
|
@@ -13,9 +13,9 @@ title: VoicemailMessageEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -11,14 +11,15 @@ Method | Description
|
|
|
11
11
|
[**get_workforcemanagement_adherence**](WorkforceManagementApi.html#get_workforcemanagement_adherence) | Get a list of UserScheduleAdherence records for the requested users
|
|
12
12
|
[**get_workforcemanagement_managementunit_activitycodes**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_activitycodes) | Get activity codes
|
|
13
13
|
[**get_workforcemanagement_managementunit_intraday_queues**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_intraday_queues) | Get intraday queues for the given date
|
|
14
|
-
[**get_workforcemanagement_managementunit_user_timeoffrequest**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_user_timeoffrequest) | Get a time off request
|
|
15
|
-
[**get_workforcemanagement_managementunit_user_timeoffrequests**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_user_timeoffrequests) | Get a list of time off requests for
|
|
14
|
+
[**get_workforcemanagement_managementunit_user_timeoffrequest**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_user_timeoffrequest) | Get a time off request
|
|
15
|
+
[**get_workforcemanagement_managementunit_user_timeoffrequests**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_user_timeoffrequests) | Get a list of time off requests for a given user
|
|
16
16
|
[**get_workforcemanagement_managementunit_users**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_users) | Get agents in the management unit
|
|
17
17
|
[**get_workforcemanagement_managementunits**](WorkforceManagementApi.html#get_workforcemanagement_managementunits) | Get management units
|
|
18
|
+
[**patch_workforcemanagement_managementunit_user_timeoffrequest**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_user_timeoffrequest) | Update a time off request
|
|
18
19
|
[**post_workforcemanagement_managementunit_activitycodes**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_activitycodes) | Create a new activity code
|
|
19
20
|
[**post_workforcemanagement_managementunit_historicaladherencequery**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_historicaladherencequery) | Request a historical adherence report
|
|
20
21
|
[**post_workforcemanagement_managementunit_intraday**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_intraday) | Get intraday data for the given date for the requested queueIds
|
|
21
|
-
[**post_workforcemanagement_managementunit_schedules_search**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_schedules_search) |
|
|
22
|
+
[**post_workforcemanagement_managementunit_schedules_search**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_schedules_search) | Query published schedules for given given time range for set of users
|
|
22
23
|
{: class="table table-striped"}
|
|
23
24
|
|
|
24
25
|
<a name="get_workforcemanagement_adherence"></a>
|
|
@@ -108,7 +109,7 @@ end
|
|
|
108
109
|
|
|
109
110
|
api_instance = PureCloud::WorkforceManagementApi.new
|
|
110
111
|
|
|
111
|
-
mu_id = "mu_id_example" # String | The
|
|
112
|
+
mu_id = "mu_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
112
113
|
|
|
113
114
|
|
|
114
115
|
begin
|
|
@@ -124,7 +125,7 @@ end
|
|
|
124
125
|
|
|
125
126
|
Name | Type | Description | Notes
|
|
126
127
|
------------- | ------------- | ------------- | -------------
|
|
127
|
-
**mu_id** | **String**| The
|
|
128
|
+
**mu_id** | **String**| The ID of the management unit, or 'mine' for the management unit of the logged-in user. | |
|
|
128
129
|
{: class="table table-striped"}
|
|
129
130
|
|
|
130
131
|
|
|
@@ -203,9 +204,9 @@ Name | Type | Description | Notes
|
|
|
203
204
|
|
|
204
205
|
<a name="get_workforcemanagement_managementunit_user_timeoffrequest"></a>
|
|
205
206
|
|
|
206
|
-
## -[**
|
|
207
|
+
## -[**TimeOffRequestResponse**](TimeOffRequestResponse.html) get_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id)
|
|
207
208
|
|
|
208
|
-
Get a time off request
|
|
209
|
+
Get a time off request
|
|
209
210
|
|
|
210
211
|
|
|
211
212
|
|
|
@@ -229,7 +230,7 @@ end
|
|
|
229
230
|
|
|
230
231
|
api_instance = PureCloud::WorkforceManagementApi.new
|
|
231
232
|
|
|
232
|
-
mu_id = "mu_id_example" # String | The
|
|
233
|
+
mu_id = "mu_id_example" # String | The muId of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
233
234
|
|
|
234
235
|
user_id = "user_id_example" # String | The userId to whom the Time Off Request applies.
|
|
235
236
|
|
|
@@ -237,7 +238,7 @@ time_off_request_id = "time_off_request_id_example" # String | Time Off Request
|
|
|
237
238
|
|
|
238
239
|
|
|
239
240
|
begin
|
|
240
|
-
#Get a time off request
|
|
241
|
+
#Get a time off request
|
|
241
242
|
result = api_instance.get_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id)
|
|
242
243
|
p result
|
|
243
244
|
rescue PureCloud::ApiError => e
|
|
@@ -249,7 +250,7 @@ end
|
|
|
249
250
|
|
|
250
251
|
Name | Type | Description | Notes
|
|
251
252
|
------------- | ------------- | ------------- | -------------
|
|
252
|
-
**mu_id** | **String**| The
|
|
253
|
+
**mu_id** | **String**| The muId of the management unit, or 'mine' for the management unit of the logged-in user. | |
|
|
253
254
|
**user_id** | **String**| The userId to whom the Time Off Request applies. | |
|
|
254
255
|
**time_off_request_id** | **String**| Time Off Request Id | |
|
|
255
256
|
{: class="table table-striped"}
|
|
@@ -257,7 +258,7 @@ Name | Type | Description | Notes
|
|
|
257
258
|
|
|
258
259
|
### Return type
|
|
259
260
|
|
|
260
|
-
[**
|
|
261
|
+
[**TimeOffRequestResponse**](TimeOffRequestResponse.html)
|
|
261
262
|
|
|
262
263
|
### HTTP request headers
|
|
263
264
|
|
|
@@ -270,7 +271,7 @@ Name | Type | Description | Notes
|
|
|
270
271
|
|
|
271
272
|
## -[**TimeOffRequestList**](TimeOffRequestList.html) get_workforcemanagement_managementunit_user_timeoffrequests(mu_id, user_id, opts)
|
|
272
273
|
|
|
273
|
-
Get a list of time off requests for
|
|
274
|
+
Get a list of time off requests for a given user
|
|
274
275
|
|
|
275
276
|
|
|
276
277
|
|
|
@@ -294,7 +295,7 @@ end
|
|
|
294
295
|
|
|
295
296
|
api_instance = PureCloud::WorkforceManagementApi.new
|
|
296
297
|
|
|
297
|
-
mu_id = "mu_id_example" # String | The
|
|
298
|
+
mu_id = "mu_id_example" # String | The muId of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
298
299
|
|
|
299
300
|
user_id = "user_id_example" # String | The userId to whom the Time Off Request applies.
|
|
300
301
|
|
|
@@ -303,7 +304,7 @@ opts = {
|
|
|
303
304
|
}
|
|
304
305
|
|
|
305
306
|
begin
|
|
306
|
-
#Get a list of time off requests for
|
|
307
|
+
#Get a list of time off requests for a given user
|
|
307
308
|
result = api_instance.get_workforcemanagement_managementunit_user_timeoffrequests(mu_id, user_id, opts)
|
|
308
309
|
p result
|
|
309
310
|
rescue PureCloud::ApiError => e
|
|
@@ -315,7 +316,7 @@ end
|
|
|
315
316
|
|
|
316
317
|
Name | Type | Description | Notes
|
|
317
318
|
------------- | ------------- | ------------- | -------------
|
|
318
|
-
**mu_id** | **String**| The
|
|
319
|
+
**mu_id** | **String**| The muId of the management unit, or 'mine' for the management unit of the logged-in user. | |
|
|
319
320
|
**user_id** | **String**| The userId to whom the Time Off Request applies. | |
|
|
320
321
|
**recently_reviewed** | **BOOLEAN**| Limit results to requests that have been reviewed within the preceding 30 days | [optional] [default to false] |
|
|
321
322
|
{: class="table table-striped"}
|
|
@@ -455,6 +456,75 @@ Name | Type | Description | Notes
|
|
|
455
456
|
|
|
456
457
|
|
|
457
458
|
|
|
459
|
+
<a name="patch_workforcemanagement_managementunit_user_timeoffrequest"></a>
|
|
460
|
+
|
|
461
|
+
## -[**TimeOffRequestResponse**](TimeOffRequestResponse.html) patch_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id, opts)
|
|
462
|
+
|
|
463
|
+
Update a time off request
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
Wraps PATCH /api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests/{timeOffRequestId}
|
|
468
|
+
|
|
469
|
+
|
|
470
|
+
### Example
|
|
471
|
+
~~~ruby
|
|
472
|
+
# load the gem
|
|
473
|
+
require 'purecloudplatformclientv2'
|
|
474
|
+
# setup authorization
|
|
475
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
476
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
477
|
+
environment = "mypurecloud.com"
|
|
478
|
+
|
|
479
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
480
|
+
|
|
481
|
+
PureCloud.configure do |config|
|
|
482
|
+
config.access_token = @authToken
|
|
483
|
+
end
|
|
484
|
+
|
|
485
|
+
api_instance = PureCloud::WorkforceManagementApi.new
|
|
486
|
+
|
|
487
|
+
mu_id = "mu_id_example" # String | The muId of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
488
|
+
|
|
489
|
+
user_id = "user_id_example" # String | The id of the user the requested time off request belongs to
|
|
490
|
+
|
|
491
|
+
time_off_request_id = "time_off_request_id_example" # String | The id of the time off request to update
|
|
492
|
+
|
|
493
|
+
opts = {
|
|
494
|
+
body: PureCloud::AdminTimeOffRequestPatch.new # AdminTimeOffRequestPatch | body
|
|
495
|
+
}
|
|
496
|
+
|
|
497
|
+
begin
|
|
498
|
+
#Update a time off request
|
|
499
|
+
result = api_instance.patch_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id, opts)
|
|
500
|
+
p result
|
|
501
|
+
rescue PureCloud::ApiError => e
|
|
502
|
+
puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_user_timeoffrequest: #{e}"
|
|
503
|
+
end
|
|
504
|
+
~~~
|
|
505
|
+
|
|
506
|
+
### Parameters
|
|
507
|
+
|
|
508
|
+
Name | Type | Description | Notes
|
|
509
|
+
------------- | ------------- | ------------- | -------------
|
|
510
|
+
**mu_id** | **String**| The muId of the management unit, or 'mine' for the management unit of the logged-in user. | |
|
|
511
|
+
**user_id** | **String**| The id of the user the requested time off request belongs to | |
|
|
512
|
+
**time_off_request_id** | **String**| The id of the time off request to update | |
|
|
513
|
+
**body** | [**AdminTimeOffRequestPatch**](AdminTimeOffRequestPatch.html)| body | [optional] |
|
|
514
|
+
{: class="table table-striped"}
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
### Return type
|
|
518
|
+
|
|
519
|
+
[**TimeOffRequestResponse**](TimeOffRequestResponse.html)
|
|
520
|
+
|
|
521
|
+
### HTTP request headers
|
|
522
|
+
|
|
523
|
+
- **Content-Type**: application/json
|
|
524
|
+
- **Accept**: application/json
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
|
|
458
528
|
<a name="post_workforcemanagement_managementunit_activitycodes"></a>
|
|
459
529
|
|
|
460
530
|
## -[**ActivityCode**](ActivityCode.html) post_workforcemanagement_managementunit_activitycodes(mu_id, opts)
|
|
@@ -483,7 +553,7 @@ end
|
|
|
483
553
|
|
|
484
554
|
api_instance = PureCloud::WorkforceManagementApi.new
|
|
485
555
|
|
|
486
|
-
mu_id = "mu_id_example" # String | The
|
|
556
|
+
mu_id = "mu_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
487
557
|
|
|
488
558
|
opts = {
|
|
489
559
|
body: PureCloud::CreateActivityCodeRequest.new # CreateActivityCodeRequest | body
|
|
@@ -502,7 +572,7 @@ end
|
|
|
502
572
|
|
|
503
573
|
Name | Type | Description | Notes
|
|
504
574
|
------------- | ------------- | ------------- | -------------
|
|
505
|
-
**mu_id** | **String**| The
|
|
575
|
+
**mu_id** | **String**| The ID of the management unit, or 'mine' for the management unit of the logged-in user. | |
|
|
506
576
|
**body** | [**CreateActivityCodeRequest**](CreateActivityCodeRequest.html)| body | [optional] |
|
|
507
577
|
{: class="table table-striped"}
|
|
508
578
|
|
|
@@ -648,7 +718,7 @@ Name | Type | Description | Notes
|
|
|
648
718
|
|
|
649
719
|
## -[**UserScheduleContainer**](UserScheduleContainer.html) post_workforcemanagement_managementunit_schedules_search(mu_id, opts)
|
|
650
720
|
|
|
651
|
-
|
|
721
|
+
Query published schedules for given given time range for set of users
|
|
652
722
|
|
|
653
723
|
|
|
654
724
|
|
|
@@ -679,7 +749,7 @@ opts = {
|
|
|
679
749
|
}
|
|
680
750
|
|
|
681
751
|
begin
|
|
682
|
-
#
|
|
752
|
+
#Query published schedules for given given time range for set of users
|
|
683
753
|
result = api_instance.post_workforcemanagement_managementunit_schedules_search(mu_id, opts)
|
|
684
754
|
p result
|
|
685
755
|
rescue PureCloud::ApiError => e
|