purecloud 0.67.1 → 0.68.1
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 +3 -3
- data/bin/notificationMappings.json +4 -4
- data/config-ruby.json +1 -1
- data/doc_out/ActivityCode.html.md +20 -0
- data/doc_out/ActivityCodeContainer.html.md +13 -0
- data/doc_out/AgentActivityEntityListing.html.md +2 -2
- data/doc_out/AlertingApi.html.md +137 -35
- data/doc_out/AnalyticsApi.html.md +89 -23
- data/doc_out/AttemptLimitsEntityListing.html.md +2 -2
- data/doc_out/AttemptLimitsNotification.html.md +2 -1
- data/doc_out/AttributeEntityListing.html.md +2 -2
- data/doc_out/AttributesApi.html.md +25 -7
- data/doc_out/AuthorizationApi.html.md +69 -18
- data/doc_out/CalibrationEntityListing.html.md +2 -2
- data/doc_out/CallConversationEntityListing.html.md +2 -2
- data/doc_out/CallConversationNotificationCallMediaParticipant.html.md +1 -1
- data/doc_out/CallConversationNotificationParticipants.html.md +1 -1
- data/doc_out/CallableTimeSetEntityListing.html.md +2 -2
- data/doc_out/CallableTimeSetNotification.html.md +1 -1
- data/doc_out/CallbackConversationEntityListing.html.md +2 -2
- data/doc_out/CallbackConversationNotificationCallbackMediaParticipant.html.md +1 -1
- data/doc_out/CallbackConversationNotificationParticipants.html.md +1 -1
- data/doc_out/CampaignEntityListing.html.md +2 -2
- data/doc_out/CampaignNotification.html.md +2 -2
- data/doc_out/{CampaignNotificationError.html.md → CampaignNotificationRestErrorDetail.html.md} +2 -2
- data/doc_out/CampaignProgressNotification.html.md +1 -1
- data/doc_out/CampaignRuleEntityListing.html.md +2 -2
- data/doc_out/CampaignRuleNotification.html.md +1 -1
- data/doc_out/CampaignRuleNotificationCampaignRuleActionEntities.html.md +2 -2
- data/doc_out/CampaignRuleNotificationCampaignRuleEntities.html.md +2 -3
- data/doc_out/CampaignRuleNotificationUriReference.html.md +14 -0
- data/doc_out/CampaignScheduleNotification.html.md +2 -2
- data/doc_out/CampaignSequenceEntityListing.html.md +2 -2
- data/doc_out/CampaignSequenceNotification.html.md +2 -2
- data/doc_out/CertificateAuthorityEntityListing.html.md +2 -2
- data/doc_out/ChannelEntityListing.html.md +2 -2
- data/doc_out/ChatConversationEntityListing.html.md +2 -2
- data/doc_out/ChatConversationNotificationChatMediaParticipant.html.md +1 -1
- data/doc_out/ChatConversationNotificationParticipants.html.md +1 -1
- data/doc_out/CobrowseConversationEntityListing.html.md +2 -2
- data/doc_out/CobrowseConversationNotificationCobrowseMediaParticipant.html.md +1 -1
- data/doc_out/CobrowseConversationNotificationParticipants.html.md +1 -1
- data/doc_out/CommandStatusEntityListing.html.md +2 -2
- data/doc_out/ContactListEntityListing.html.md +2 -2
- data/doc_out/ContactListNotification.html.md +2 -2
- data/doc_out/{ContactListNotificationPhoneColumn_.html.md → ContactListNotificationContactPhoneNumberColumn.html.md} +2 -2
- data/doc_out/ContentManagementApi.html.md +153 -39
- data/doc_out/ConversationEntityListing.html.md +2 -2
- data/doc_out/ConversationsApi.html.md +421 -76
- data/doc_out/CreateEmailRequest.html.md +23 -0
- data/doc_out/CreateWebChatRequest.html.md +19 -0
- data/doc_out/DIDEntityListing.html.md +2 -2
- data/doc_out/DIDPoolEntityListing.html.md +2 -2
- data/doc_out/DecisionsFileMetadataEntityListing.html.md +2 -2
- data/doc_out/DncListEntityListing.html.md +2 -2
- data/doc_out/DncListNotification.html.md +1 -1
- data/doc_out/DocumentAuditEntityListing.html.md +2 -2
- data/doc_out/DocumentDataV2Notification.html.md +26 -0
- data/doc_out/{RecordingDataNotificationUserData.html.md → DocumentDataV2NotificationCreatedBy.html.md} +2 -2
- data/doc_out/DocumentDataV2NotificationLockData.html.md +15 -0
- data/doc_out/DocumentDataV2NotificationLockInfo.html.md +15 -0
- data/doc_out/{DocumentDataNotificationUserData.html.md → DocumentDataV2NotificationUserData.html.md} +2 -2
- data/doc_out/{DocumentDataNotificationWorkspace.html.md → DocumentDataV2NotificationWorkspace.html.md} +2 -2
- data/doc_out/{DocumentDataNotificationWorkspaceData.html.md → DocumentDataV2NotificationWorkspaceData.html.md} +2 -2
- data/doc_out/DocumentEntityListing.html.md +2 -2
- data/doc_out/DomainEdgeSoftwareVersionDtoEntityListing.html.md +2 -2
- data/doc_out/DomainEntityListing.html.md +2 -2
- data/doc_out/DomainEntityListingEvaluationForm.html.md +2 -2
- data/doc_out/DomainEntityListingQueryResult.html.md +2 -2
- data/doc_out/DomainOrganizationRole.html.md +1 -1
- data/doc_out/DomainOrganizationRoleCreate.html.md +1 -1
- data/doc_out/DomainOrganizationRoleUpdate.html.md +1 -1
- data/doc_out/EdgeEntityListing.html.md +2 -2
- data/doc_out/EdgeGroupEntityListing.html.md +2 -2
- data/doc_out/EdgeLineEntityListing.html.md +2 -2
- data/doc_out/EdgeRebootParameters.html.md +13 -0
- data/doc_out/EmailConversationEntityListing.html.md +2 -2
- data/doc_out/EmailConversationNotificationEmailMediaParticipant.html.md +1 -1
- data/doc_out/EmailConversationNotificationParticipants.html.md +1 -1
- data/doc_out/EmailMessageListing.html.md +2 -2
- data/doc_out/EncryptionKeyEntityListing.html.md +2 -2
- data/doc_out/EndpointEntityListing.html.md +2 -2
- data/doc_out/Entry.html.md +2 -2
- data/doc_out/EntryFeatureBoolean.html.md +14 -0
- data/doc_out/EvaluationEntityListing.html.md +2 -2
- data/doc_out/EvaluationFormEntityListing.html.md +2 -2
- data/doc_out/EvaluatorActivityEntityListing.html.md +2 -2
- data/doc_out/ExtensionEntityListing.html.md +2 -2
- data/doc_out/ExtensionPoolEntityListing.html.md +2 -2
- data/doc_out/FaxApi.html.md +25 -7
- data/doc_out/FaxDataV2Notification.html.md +29 -0
- data/doc_out/FaxDataV2NotificationLockData.html.md +15 -0
- data/doc_out/FaxDataV2NotificationLockInfo.html.md +15 -0
- data/doc_out/{FaxDataNotificationUserData.html.md → FaxDataV2NotificationUserData.html.md} +2 -2
- data/doc_out/{FaxDataNotificationWorkspaceData.html.md → FaxDataV2NotificationWorkspaceData.html.md} +2 -2
- data/doc_out/FaxDocumentEntityListing.html.md +2 -2
- data/doc_out/GeolocationApi.html.md +17 -5
- data/doc_out/GreetingListing.html.md +2 -2
- data/doc_out/GreetingsApi.html.md +65 -17
- data/doc_out/GroupEntityListing.html.md +2 -2
- data/doc_out/GroupsApi.html.md +45 -12
- data/doc_out/HeartBeatAlertContainer.html.md +2 -2
- data/doc_out/HeartBeatRuleContainer.html.md +2 -2
- data/doc_out/IdentityProviderApi.html.md +89 -23
- data/doc_out/InboundDomainEntityListing.html.md +2 -2
- data/doc_out/InboundRouteEntityListing.html.md +2 -2
- data/doc_out/InteractionStatsAlertContainer.html.md +2 -2
- data/doc_out/InteractionStatsRuleContainer.html.md +2 -2
- data/doc_out/JsonNode.html.md +2 -2
- data/doc_out/KeywordSetEntityListing.html.md +2 -2
- data/doc_out/LanguageEntityListing.html.md +2 -2
- data/doc_out/LanguagesApi.html.md +41 -11
- data/doc_out/LibraryEntityListing.html.md +2 -2
- data/doc_out/LineBaseEntityListing.html.md +2 -2
- data/doc_out/LineEntityListing.html.md +2 -2
- data/doc_out/LocalEncryptionConfigurationListing.html.md +2 -2
- data/doc_out/LocationsApi.html.md +17 -5
- data/doc_out/LogicalInterfaceEntityListing.html.md +2 -2
- data/doc_out/NotificationsApi.html.md +29 -8
- data/doc_out/OAuthApi.html.md +25 -7
- data/doc_out/OAuthClientEntityListing.html.md +2 -2
- data/doc_out/OAuthProviderEntityListing.html.md +2 -2
- data/doc_out/Organization.html.md +1 -0
- data/doc_out/OrganizationApi.html.md +70 -3
- data/doc_out/OrganizationPresenceEntityListing.html.md +2 -2
- data/doc_out/OrganizationRoleEntityListing.html.md +2 -2
- data/doc_out/OrphanRecordingListing.html.md +2 -2
- data/doc_out/OutOfOfficeNotification.html.md +1 -1
- data/doc_out/OutboundApi.html.md +323 -95
- data/doc_out/OutboundRouteBaseEntityListing.html.md +2 -2
- data/doc_out/OutboundRouteEntityListing.html.md +2 -2
- data/doc_out/PermissionCollectionEntityListing.html.md +2 -2
- data/doc_out/PhoneBaseEntityListing.html.md +2 -2
- data/doc_out/PhoneEntityListing.html.md +2 -2
- data/doc_out/PhoneMetaBaseEntityListing.html.md +2 -2
- data/doc_out/PhysicalInterfaceEntityListing.html.md +2 -2
- data/doc_out/PolicyEntityListing.html.md +2 -2
- data/doc_out/PresenceApi.html.md +33 -9
- data/doc_out/QualityApi.html.md +128 -33
- data/doc_out/QualityAuditPage.html.md +2 -2
- data/doc_out/QueueEntityListing.html.md +2 -2
- data/doc_out/QueueMemberEntityListing.html.md +2 -2
- data/doc_out/RecordingApi.html.md +133 -34
- data/doc_out/RecordingDataV2Notification.html.md +29 -0
- data/doc_out/{RecordingDataNotificationConversationData.html.md → RecordingDataV2NotificationConversationData.html.md} +2 -2
- data/doc_out/RecordingDataV2NotificationLockData.html.md +15 -0
- data/doc_out/RecordingDataV2NotificationLockInfo.html.md +15 -0
- data/doc_out/{DocumentDataNotificationCreatedBy.html.md → RecordingDataV2NotificationUserData.html.md} +2 -2
- data/doc_out/{RecordingDataNotificationWorkspaceData.html.md → RecordingDataV2NotificationWorkspaceData.html.md} +2 -2
- data/doc_out/ReportMetaDataEntityListing.html.md +2 -2
- data/doc_out/ReportRunEntryEntityDomainListing.html.md +2 -2
- data/doc_out/ReportScheduleEntityListing.html.md +2 -2
- data/doc_out/ResponseEntityList.html.md +2 -2
- data/doc_out/ResponseEntityListing.html.md +2 -2
- data/doc_out/ResponseManagementApi.html.md +45 -12
- data/doc_out/ResponseSetEntityListing.html.md +2 -2
- data/doc_out/ResponseSetNotification.html.md +1 -1
- data/doc_out/RoutingApi.html.md +193 -49
- data/doc_out/RoutingStatusAlertContainer.html.md +2 -2
- data/doc_out/RoutingStatusRuleContainer.html.md +2 -2
- data/doc_out/RuleSetEntityListing.html.md +2 -2
- data/doc_out/RuleSetNotification.html.md +1 -1
- data/doc_out/RuleSetNotificationCondition.html.md +1 -1
- data/doc_out/RuleSetNotificationConditions.html.md +1 -1
- data/doc_out/SchemaCategoryEntityListing.html.md +2 -2
- data/doc_out/SchemaReferenceEntityListing.html.md +2 -2
- data/doc_out/ScreenRecordingSessionListing.html.md +2 -2
- data/doc_out/ScreenShareConversationNotificationParticipants.html.md +1 -1
- data/doc_out/ScreenShareConversationNotificationScreenShareMediaParticipant.html.md +1 -1
- data/doc_out/ScriptEntityListing.html.md +2 -2
- data/doc_out/ScriptsApi.html.md +37 -10
- data/doc_out/SearchApi.html.md +49 -13
- data/doc_out/SecurityProfileEntityListing.html.md +2 -2
- data/doc_out/SequenceScheduleNotification.html.md +2 -2
- data/doc_out/ShareEntityListing.html.md +2 -2
- data/doc_out/SiteEntityListing.html.md +2 -2
- data/doc_out/SkillEntityListing.html.md +2 -2
- data/doc_out/SocialConversationNotificationParticipants.html.md +1 -1
- data/doc_out/SocialConversationNotificationSocialMediaParticipant.html.md +1 -1
- data/doc_out/StationEntityListing.html.md +2 -2
- data/doc_out/StationsApi.html.md +13 -4
- data/doc_out/SuggestApi.html.md +17 -5
- data/doc_out/TagValueEntityListing.html.md +2 -2
- data/doc_out/TelephonyProvidersEdgeApi.html.md +479 -121
- data/doc_out/TimeZoneEntityListing.html.md +2 -2
- data/doc_out/TokensApi.html.md +5 -2
- data/doc_out/TrunkBaseEntityListing.html.md +2 -2
- data/doc_out/TrunkEntityListing.html.md +2 -2
- data/doc_out/TrunkMetabaseEntityListing.html.md +2 -2
- data/doc_out/UserEntityListing.html.md +2 -2
- data/doc_out/UserListScheduleRequestBody.html.md +15 -0
- data/doc_out/UserPresenceAlertContainer.html.md +2 -2
- data/doc_out/UserPresenceRuleContainer.html.md +2 -2
- data/doc_out/UserQueueEntityListing.html.md +2 -2
- data/doc_out/UserRecordingEntityListing.html.md +2 -2
- data/doc_out/UserRecordingsApi.html.md +25 -7
- data/doc_out/UserSchedule.html.md +14 -0
- data/doc_out/UserScheduleActivity.html.md +18 -0
- data/doc_out/UserScheduleContainer.html.md +14 -0
- data/doc_out/UserScheduleFullDayTimeOffMarker.html.md +17 -0
- data/doc_out/UserScheduleShift.html.md +15 -0
- data/doc_out/UserSkillEntityListing.html.md +2 -2
- data/doc_out/UsersApi.html.md +169 -43
- data/doc_out/UtilitiesApi.html.md +13 -4
- data/doc_out/VideoConversationNotificationParticipants.html.md +1 -1
- data/doc_out/VideoConversationNotificationVideoMediaParticipant.html.md +1 -1
- data/doc_out/VoicemailApi.html.md +89 -23
- data/doc_out/VoicemailMessageEntityListing.html.md +2 -2
- data/doc_out/WfmUserEntityListing.html.md +13 -0
- data/doc_out/WorkforceManagementApi.html.md +227 -13
- data/doc_out/WorkspaceEntityListing.html.md +2 -2
- data/doc_out/WorkspaceMemberEntityListing.html.md +2 -2
- data/doc_out/WrapUpCodeMappingNotification.html.md +0 -1
- data/doc_out/WrapupCodeEntityListing.html.md +2 -2
- data/doc_out/index.html.md +3 -3
- data/lib/purecloud.rb +34 -20
- data/lib/purecloud/api/conversations_api.rb +120 -0
- data/lib/purecloud/api/organization_api.rb +57 -0
- data/lib/purecloud/api/outbound_api.rb +9 -9
- data/lib/purecloud/api/quality_api.rb +7 -0
- data/lib/purecloud/api/telephony_providers_edge_api.rb +3 -1
- data/lib/purecloud/api/workforce_management_api.rb +185 -3
- data/lib/purecloud/api_client.rb +1 -1
- data/lib/purecloud/models/activity_code.rb +253 -0
- data/lib/purecloud/models/activity_code_container.rb +169 -0
- data/lib/purecloud/models/agent_activity_entity_listing.rb +17 -17
- data/lib/purecloud/models/attempt_limits_entity_listing.rb +17 -17
- data/lib/purecloud/models/attempt_limits_notification.rb +24 -14
- data/lib/purecloud/models/attribute_entity_listing.rb +17 -17
- data/lib/purecloud/models/calibration_entity_listing.rb +17 -17
- data/lib/purecloud/models/call_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/call_conversation_notification_call_media_participant.rb +1 -1
- data/lib/purecloud/models/call_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/callable_time_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/callable_time_set_notification.rb +13 -13
- data/lib/purecloud/models/callback_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/callback_conversation_notification_callback_media_participant.rb +1 -1
- data/lib/purecloud/models/callback_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/campaign_entity_listing.rb +17 -17
- data/lib/purecloud/models/campaign_notification.rb +15 -15
- data/lib/purecloud/models/{campaign_notification_error.rb → campaign_notification_rest_error_detail.rb} +1 -1
- data/lib/purecloud/models/campaign_progress_notification.rb +1 -1
- data/lib/purecloud/models/campaign_rule_entity_listing.rb +17 -17
- data/lib/purecloud/models/campaign_rule_notification.rb +14 -14
- data/lib/purecloud/models/campaign_rule_notification_campaign_rule_action_entities.rb +2 -2
- data/lib/purecloud/models/campaign_rule_notification_campaign_rule_entities.rb +3 -13
- data/lib/purecloud/models/campaign_rule_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/campaign_schedule_notification.rb +14 -14
- data/lib/purecloud/models/campaign_sequence_entity_listing.rb +17 -17
- data/lib/purecloud/models/campaign_sequence_notification.rb +15 -15
- data/lib/purecloud/models/certificate_authority_entity_listing.rb +17 -17
- data/lib/purecloud/models/channel_entity_listing.rb +17 -17
- data/lib/purecloud/models/chat_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/chat_conversation_notification_chat_media_participant.rb +1 -1
- data/lib/purecloud/models/chat_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/cobrowse_conversation_notification_cobrowse_media_participant.rb +1 -1
- data/lib/purecloud/models/cobrowse_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/command_status_entity_listing.rb +17 -17
- data/lib/purecloud/models/contact_list_entity_listing.rb +17 -17
- data/lib/purecloud/models/contact_list_notification.rb +14 -14
- data/lib/purecloud/models/{contact_list_notification_phone_column_.rb → contact_list_notification_contact_phone_number_column.rb} +1 -1
- data/lib/purecloud/models/contact_list_notification_import_status.rb +1 -1
- data/lib/purecloud/models/conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/create_email_request.rb +280 -0
- data/lib/purecloud/models/create_web_chat_request.rb +236 -0
- data/lib/purecloud/models/decisions_file_metadata_entity_listing.rb +17 -17
- data/lib/purecloud/models/did_entity_listing.rb +17 -17
- data/lib/purecloud/models/did_pool_entity_listing.rb +17 -17
- data/lib/purecloud/models/dnc_list_entity_listing.rb +17 -17
- data/lib/purecloud/models/dnc_list_notification.rb +14 -14
- data/lib/purecloud/models/dnc_list_notification_import_status.rb +1 -1
- data/lib/purecloud/models/document_audit_entity_listing.rb +17 -17
- data/lib/purecloud/models/{document_data_notification.rb → document_data_v2_notification.rb} +9 -29
- data/lib/purecloud/models/{recording_data_notification_user_data.rb → document_data_v2_notification_created_by.rb} +1 -1
- data/lib/purecloud/models/{document_data_notification_lock_info.rb → document_data_v2_notification_lock_data.rb} +4 -4
- data/lib/purecloud/models/{document_data_notification_lock_data.rb → document_data_v2_notification_lock_info.rb} +4 -4
- data/lib/purecloud/models/{document_data_notification_user_data.rb → document_data_v2_notification_user_data.rb} +1 -1
- data/lib/purecloud/models/{document_data_notification_workspace.rb → document_data_v2_notification_workspace.rb} +1 -1
- data/lib/purecloud/models/{document_data_notification_workspace_data.rb → document_data_v2_notification_workspace_data.rb} +1 -1
- data/lib/purecloud/models/document_entity_listing.rb +17 -17
- data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +17 -17
- data/lib/purecloud/models/domain_entity_listing.rb +17 -17
- data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +17 -17
- data/lib/purecloud/models/domain_entity_listing_query_result.rb +17 -17
- data/lib/purecloud/models/domain_organization_role.rb +11 -11
- data/lib/purecloud/models/domain_organization_role_create.rb +11 -11
- data/lib/purecloud/models/domain_organization_role_update.rb +11 -11
- data/lib/purecloud/models/edge_entity_listing.rb +17 -17
- data/lib/purecloud/models/edge_group_entity_listing.rb +17 -17
- data/lib/purecloud/models/edge_line_entity_listing.rb +17 -17
- data/lib/purecloud/models/edge_reboot_parameters.rb +166 -0
- data/lib/purecloud/models/email_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/email_conversation_notification_email_media_participant.rb +1 -1
- data/lib/purecloud/models/email_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/email_message_listing.rb +17 -17
- data/lib/purecloud/models/encryption_key_entity_listing.rb +17 -17
- data/lib/purecloud/models/endpoint_entity_listing.rb +17 -17
- data/lib/purecloud/models/entry.rb +8 -10
- data/lib/purecloud/models/entry_feature_boolean.rb +184 -0
- data/lib/purecloud/models/evaluation_entity_listing.rb +17 -17
- data/lib/purecloud/models/evaluation_form_entity_listing.rb +17 -17
- data/lib/purecloud/models/evaluator_activity_entity_listing.rb +17 -17
- data/lib/purecloud/models/extension_entity_listing.rb +17 -17
- data/lib/purecloud/models/extension_pool_entity_listing.rb +17 -17
- data/lib/purecloud/models/{fax_data_notification.rb → fax_data_v2_notification.rb} +9 -29
- data/lib/purecloud/models/{fax_data_notification_lock_info.rb → fax_data_v2_notification_lock_data.rb} +4 -4
- data/lib/purecloud/models/{fax_data_notification_lock_data.rb → fax_data_v2_notification_lock_info.rb} +4 -4
- data/lib/purecloud/models/{fax_data_notification_user_data.rb → fax_data_v2_notification_user_data.rb} +1 -1
- data/lib/purecloud/models/{fax_data_notification_workspace_data.rb → fax_data_v2_notification_workspace_data.rb} +1 -1
- data/lib/purecloud/models/fax_document_entity_listing.rb +17 -17
- data/lib/purecloud/models/greeting_listing.rb +17 -17
- data/lib/purecloud/models/group_entity_listing.rb +17 -17
- data/lib/purecloud/models/heart_beat_alert_container.rb +17 -17
- data/lib/purecloud/models/heart_beat_rule_container.rb +17 -17
- data/lib/purecloud/models/import_status_notification.rb +1 -1
- data/lib/purecloud/models/inbound_domain_entity_listing.rb +17 -17
- data/lib/purecloud/models/inbound_route_entity_listing.rb +17 -17
- data/lib/purecloud/models/interaction_stats_alert_container.rb +17 -17
- data/lib/purecloud/models/interaction_stats_rule_container.rb +17 -17
- data/lib/purecloud/models/json_node.rb +24 -24
- data/lib/purecloud/models/keyword_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/language_entity_listing.rb +17 -17
- data/lib/purecloud/models/library_entity_listing.rb +17 -17
- data/lib/purecloud/models/line_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/line_entity_listing.rb +17 -17
- data/lib/purecloud/models/local_encryption_configuration_listing.rb +17 -17
- data/lib/purecloud/models/logical_interface_entity_listing.rb +17 -17
- data/lib/purecloud/models/o_auth_client_entity_listing.rb +17 -17
- data/lib/purecloud/models/o_auth_provider_entity_listing.rb +17 -17
- data/lib/purecloud/models/organization.rb +17 -4
- data/lib/purecloud/models/organization_presence_entity_listing.rb +17 -17
- data/lib/purecloud/models/organization_role_entity_listing.rb +17 -17
- data/lib/purecloud/models/orphan_recording_listing.rb +17 -17
- data/lib/purecloud/models/out_of_office_notification.rb +1 -1
- data/lib/purecloud/models/outbound_route_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/outbound_route_entity_listing.rb +17 -17
- data/lib/purecloud/models/permission_collection_entity_listing.rb +17 -17
- data/lib/purecloud/models/phone_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/phone_entity_listing.rb +17 -17
- data/lib/purecloud/models/phone_meta_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/physical_interface_entity_listing.rb +17 -17
- data/lib/purecloud/models/policy_entity_listing.rb +17 -17
- data/lib/purecloud/models/quality_audit_page.rb +17 -17
- data/lib/purecloud/models/queue_entity_listing.rb +17 -17
- data/lib/purecloud/models/queue_member_entity_listing.rb +17 -17
- data/lib/purecloud/models/{recording_data_notification.rb → recording_data_v2_notification.rb} +10 -30
- data/lib/purecloud/models/{recording_data_notification_conversation_data.rb → recording_data_v2_notification_conversation_data.rb} +1 -1
- data/lib/purecloud/models/recording_data_v2_notification_lock_data.rb +185 -0
- data/lib/purecloud/models/recording_data_v2_notification_lock_info.rb +185 -0
- data/lib/purecloud/models/{document_data_notification_created_by.rb → recording_data_v2_notification_user_data.rb} +1 -1
- data/lib/purecloud/models/{recording_data_notification_workspace_data.rb → recording_data_v2_notification_workspace_data.rb} +1 -1
- data/lib/purecloud/models/report_meta_data_entity_listing.rb +17 -17
- data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +17 -17
- data/lib/purecloud/models/report_schedule_entity_listing.rb +17 -17
- data/lib/purecloud/models/response_entity_list.rb +17 -17
- data/lib/purecloud/models/response_entity_listing.rb +17 -17
- data/lib/purecloud/models/response_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/response_set_notification.rb +13 -13
- data/lib/purecloud/models/routing_status_alert_container.rb +17 -17
- data/lib/purecloud/models/routing_status_rule_container.rb +17 -17
- data/lib/purecloud/models/rule_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/rule_set_notification.rb +1 -1
- data/lib/purecloud/models/rule_set_notification_condition.rb +11 -11
- data/lib/purecloud/models/rule_set_notification_conditions.rb +18 -18
- data/lib/purecloud/models/rule_set_notification_rule.rb +9 -0
- data/lib/purecloud/models/rule_set_notification_rules.rb +9 -0
- data/lib/purecloud/models/schema_category_entity_listing.rb +17 -17
- data/lib/purecloud/models/schema_reference_entity_listing.rb +17 -17
- data/lib/purecloud/models/screen_recording_session_listing.rb +17 -17
- data/lib/purecloud/models/screen_share_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/screen_share_conversation_notification_screen_share_media_participant.rb +1 -1
- data/lib/purecloud/models/script_entity_listing.rb +17 -17
- data/lib/purecloud/models/security_profile_entity_listing.rb +17 -17
- data/lib/purecloud/models/sequence_schedule_notification.rb +14 -14
- data/lib/purecloud/models/share_entity_listing.rb +17 -17
- data/lib/purecloud/models/site_entity_listing.rb +17 -17
- data/lib/purecloud/models/skill_entity_listing.rb +17 -17
- data/lib/purecloud/models/social_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/social_conversation_notification_social_media_participant.rb +1 -1
- data/lib/purecloud/models/station_entity_listing.rb +17 -17
- data/lib/purecloud/models/tag_value_entity_listing.rb +17 -17
- data/lib/purecloud/models/time_zone_entity_listing.rb +17 -17
- data/lib/purecloud/models/trunk_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/trunk_entity_listing.rb +17 -17
- data/lib/purecloud/models/trunk_metabase_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_list_schedule_request_body.rb +191 -0
- data/lib/purecloud/models/user_presence_alert_container.rb +17 -17
- data/lib/purecloud/models/user_presence_rule_container.rb +17 -17
- data/lib/purecloud/models/user_queue_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_recording_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_schedule.rb +182 -0
- data/lib/purecloud/models/user_schedule_activity.rb +222 -0
- data/lib/purecloud/models/user_schedule_container.rb +180 -0
- data/lib/purecloud/models/user_schedule_full_day_time_off_marker.rb +211 -0
- data/lib/purecloud/models/user_schedule_shift.rb +191 -0
- data/lib/purecloud/models/user_skill_entity_listing.rb +17 -17
- data/lib/purecloud/models/video_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/video_conversation_notification_video_media_participant.rb +1 -1
- data/lib/purecloud/models/voicemail_message_entity_listing.rb +17 -17
- data/lib/purecloud/models/wfm_user_entity_listing.rb +167 -0
- data/lib/purecloud/models/workspace_entity_listing.rb +17 -17
- data/lib/purecloud/models/workspace_member_entity_listing.rb +17 -17
- data/lib/purecloud/models/wrap_up_code_mapping_notification.rb +4 -14
- data/lib/purecloud/models/wrapup_code_entity_listing.rb +17 -17
- data/lib/purecloud/version.rb +1 -1
- data/newVersion.md +1 -1
- data/swagger.json +1 -1
- data/swagger_template/api_doc.mustache +5 -2
- data/version.json +1 -1
- metadata +70 -42
- data/doc_out/DocumentDataNotification.html.md +0 -28
- data/doc_out/DocumentDataNotificationLockData.html.md +0 -15
- data/doc_out/DocumentDataNotificationLockInfo.html.md +0 -15
- data/doc_out/FaxDataNotification.html.md +0 -31
- data/doc_out/FaxDataNotificationLockData.html.md +0 -15
- data/doc_out/FaxDataNotificationLockInfo.html.md +0 -15
- data/doc_out/RecordingDataNotification.html.md +0 -31
- data/doc_out/RecordingDataNotificationLockData.html.md +0 -15
- data/doc_out/RecordingDataNotificationLockInfo.html.md +0 -15
- data/lib/purecloud/models/recording_data_notification_lock_data.rb +0 -185
- data/lib/purecloud/models/recording_data_notification_lock_info.rb +0 -185
|
@@ -11,11 +11,11 @@ title: EncryptionKeyEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -11,11 +11,11 @@ title: EndpointEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/doc_out/Entry.html.md
CHANGED
|
@@ -7,8 +7,8 @@ title: Entry
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **value** | **
|
|
11
|
-
| **
|
|
10
|
+
| **value** | **Object** | | [optional] |
|
|
11
|
+
| **key** | **Object** | | [optional] |
|
|
12
12
|
{: class="table table-striped"}
|
|
13
13
|
|
|
14
14
|
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: EntryFeatureBoolean
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::EntryFeatureBoolean
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **value** | **BOOLEAN** | | [optional] |
|
|
11
|
+
| **key** | **String** | | [optional] |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
|
@@ -11,11 +11,11 @@ title: EvaluationEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -11,11 +11,11 @@ title: EvaluationFormEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -11,11 +11,11 @@ title: EvaluatorActivityEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -11,11 +11,11 @@ title: ExtensionEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -11,11 +11,11 @@ title: ExtensionPoolEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/doc_out/FaxApi.html.md
CHANGED
|
@@ -6,14 +6,14 @@ title: FaxApi
|
|
|
6
6
|
|
|
7
7
|
All URIs are relative to *https://api.mypurecloud.com*
|
|
8
8
|
|
|
9
|
-
Method |
|
|
9
|
+
Method | Description
|
|
10
10
|
------------- | ------------- | -------------
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
11
|
+
[**delete_documents_document_id**](FaxApi.html#delete_documents_document_id) | Delete a fax document.
|
|
12
|
+
[**get_documents**](FaxApi.html#get_documents) | Get a list of fax documents.
|
|
13
|
+
[**get_documents_document_id**](FaxApi.html#get_documents_document_id) | Get a document.
|
|
14
|
+
[**get_documents_document_id_content**](FaxApi.html#get_documents_document_id_content) | Download a fax document.
|
|
15
|
+
[**get_summary**](FaxApi.html#get_summary) | Get fax summary
|
|
16
|
+
[**put_documents_document_id**](FaxApi.html#put_documents_document_id) | Update a fax document.
|
|
17
17
|
{: class="table table-striped"}
|
|
18
18
|
|
|
19
19
|
<a name="delete_documents_document_id"></a>
|
|
@@ -24,6 +24,9 @@ Delete a fax document.
|
|
|
24
24
|
|
|
25
25
|
|
|
26
26
|
|
|
27
|
+
Wraps DELETE /api/v2/fax/documents/{documentId}
|
|
28
|
+
|
|
29
|
+
|
|
27
30
|
### Example
|
|
28
31
|
~~~ruby
|
|
29
32
|
# load the gem
|
|
@@ -79,6 +82,9 @@ Get a list of fax documents.
|
|
|
79
82
|
|
|
80
83
|
|
|
81
84
|
|
|
85
|
+
Wraps GET /api/v2/fax/documents
|
|
86
|
+
|
|
87
|
+
|
|
82
88
|
### Example
|
|
83
89
|
~~~ruby
|
|
84
90
|
# load the gem
|
|
@@ -138,6 +144,9 @@ Get a document.
|
|
|
138
144
|
|
|
139
145
|
|
|
140
146
|
|
|
147
|
+
Wraps GET /api/v2/fax/documents/{documentId}
|
|
148
|
+
|
|
149
|
+
|
|
141
150
|
### Example
|
|
142
151
|
~~~ruby
|
|
143
152
|
# load the gem
|
|
@@ -194,6 +203,9 @@ Download a fax document.
|
|
|
194
203
|
|
|
195
204
|
|
|
196
205
|
|
|
206
|
+
Wraps GET /api/v2/fax/documents/{documentId}/content
|
|
207
|
+
|
|
208
|
+
|
|
197
209
|
### Example
|
|
198
210
|
~~~ruby
|
|
199
211
|
# load the gem
|
|
@@ -250,6 +262,9 @@ Get fax summary
|
|
|
250
262
|
|
|
251
263
|
|
|
252
264
|
|
|
265
|
+
Wraps GET /api/v2/fax/summary
|
|
266
|
+
|
|
267
|
+
|
|
253
268
|
### Example
|
|
254
269
|
~~~ruby
|
|
255
270
|
# load the gem
|
|
@@ -300,6 +315,9 @@ Update a fax document.
|
|
|
300
315
|
|
|
301
316
|
|
|
302
317
|
|
|
318
|
+
Wraps PUT /api/v2/fax/documents/{documentId}
|
|
319
|
+
|
|
320
|
+
|
|
303
321
|
### Example
|
|
304
322
|
~~~ruby
|
|
305
323
|
# load the gem
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: FaxDataV2Notification
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::FaxDataV2Notification
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | | [optional] |
|
|
11
|
+
| **name** | **String** | | [optional] |
|
|
12
|
+
| **date_created** | **DateTime** | | [optional] |
|
|
13
|
+
| **date_modified** | **DateTime** | | [optional] |
|
|
14
|
+
| **workspace** | [**DocumentDataV2NotificationWorkspace**](DocumentDataV2NotificationWorkspace.html) | | [optional] |
|
|
15
|
+
| **created_by** | [**DocumentDataV2NotificationCreatedBy**](DocumentDataV2NotificationCreatedBy.html) | | [optional] |
|
|
16
|
+
| **content_type** | **String** | | [optional] |
|
|
17
|
+
| **content_length** | **Integer** | | [optional] |
|
|
18
|
+
| **filename** | **String** | | [optional] |
|
|
19
|
+
| **change_number** | **Integer** | | [optional] |
|
|
20
|
+
| **date_uploaded** | **DateTime** | | [optional] |
|
|
21
|
+
| **uploaded_by** | [**FaxDataV2NotificationUserData**](FaxDataV2NotificationUserData.html) | | [optional] |
|
|
22
|
+
| **lock_info** | [**FaxDataV2NotificationLockInfo**](FaxDataV2NotificationLockInfo.html) | | [optional] |
|
|
23
|
+
| **self_uri** | **String** | | [optional] |
|
|
24
|
+
| **caller_address** | **String** | | [optional] |
|
|
25
|
+
| **receiver_address** | **String** | | [optional] |
|
|
26
|
+
| **read** | **BOOLEAN** | | [optional] |
|
|
27
|
+
{: class="table table-striped"}
|
|
28
|
+
|
|
29
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: FaxDataV2NotificationLockData
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::FaxDataV2NotificationLockData
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **locked_by** | [**FaxDataV2NotificationUserData**](FaxDataV2NotificationUserData.html) | | [optional] |
|
|
11
|
+
| **date_created** | **DateTime** | | [optional] |
|
|
12
|
+
| **date_expires** | **DateTime** | | [optional] |
|
|
13
|
+
{: class="table table-striped"}
|
|
14
|
+
|
|
15
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: FaxDataV2NotificationLockInfo
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::FaxDataV2NotificationLockInfo
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **locked_by** | [**FaxDataV2NotificationUserData**](FaxDataV2NotificationUserData.html) | | [optional] |
|
|
11
|
+
| **date_created** | **DateTime** | | [optional] |
|
|
12
|
+
| **date_expires** | **DateTime** | | [optional] |
|
|
13
|
+
{: class="table table-striped"}
|
|
14
|
+
|
|
15
|
+
|
|
@@ -11,11 +11,11 @@ title: FaxDocumentEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -6,12 +6,12 @@ title: GeolocationApi
|
|
|
6
6
|
|
|
7
7
|
All URIs are relative to *https://api.mypurecloud.com*
|
|
8
8
|
|
|
9
|
-
Method |
|
|
9
|
+
Method | Description
|
|
10
10
|
------------- | ------------- | -------------
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
11
|
+
[**get_settings**](GeolocationApi.html#get_settings) | Get a organization's GeolocationSettings
|
|
12
|
+
[**get_user_id_geolocations_client_id**](GeolocationApi.html#get_user_id_geolocations_client_id) | Get a user's Geolocation
|
|
13
|
+
[**patch_settings**](GeolocationApi.html#patch_settings) | Patch a organization's GeolocationSettings
|
|
14
|
+
[**patch_user_id_geolocations_client_id**](GeolocationApi.html#patch_user_id_geolocations_client_id) | Patch a user's Geolocation
|
|
15
15
|
{: class="table table-striped"}
|
|
16
16
|
|
|
17
17
|
<a name="get_settings"></a>
|
|
@@ -22,6 +22,9 @@ Get a organization's GeolocationSettings
|
|
|
22
22
|
|
|
23
23
|
|
|
24
24
|
|
|
25
|
+
Wraps GET /api/v2/geolocations/settings
|
|
26
|
+
|
|
27
|
+
|
|
25
28
|
### Example
|
|
26
29
|
~~~ruby
|
|
27
30
|
# load the gem
|
|
@@ -72,6 +75,9 @@ Get a user's Geolocation
|
|
|
72
75
|
|
|
73
76
|
|
|
74
77
|
|
|
78
|
+
Wraps GET /api/v2/users/{userId}/geolocations/{clientId}
|
|
79
|
+
|
|
80
|
+
|
|
75
81
|
### Example
|
|
76
82
|
~~~ruby
|
|
77
83
|
# load the gem
|
|
@@ -131,6 +137,9 @@ Patch a organization's GeolocationSettings
|
|
|
131
137
|
|
|
132
138
|
|
|
133
139
|
|
|
140
|
+
Wraps PATCH /api/v2/geolocations/settings
|
|
141
|
+
|
|
142
|
+
|
|
134
143
|
### Example
|
|
135
144
|
~~~ruby
|
|
136
145
|
# load the gem
|
|
@@ -187,6 +196,9 @@ Patch a user's Geolocation
|
|
|
187
196
|
|
|
188
197
|
The geolocation object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the client as the user's primary geolocation source. Option 2: Provide the 'latitude' and 'longitude' values. This will enqueue an asynchronous update of the 'city', 'region', and 'country', generating a notification. A subsequent GET operation will include the new values for 'city', 'region' and 'country'. Option 3: Provide the 'city', 'region', 'country' values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.
|
|
189
198
|
|
|
199
|
+
Wraps PATCH /api/v2/users/{userId}/geolocations/{clientId}
|
|
200
|
+
|
|
201
|
+
|
|
190
202
|
### Example
|
|
191
203
|
~~~ruby
|
|
192
204
|
# load the gem
|
|
@@ -11,11 +11,11 @@ title: GreetingListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -6,24 +6,24 @@ title: GreetingsApi
|
|
|
6
6
|
|
|
7
7
|
All URIs are relative to *https://api.mypurecloud.com*
|
|
8
8
|
|
|
9
|
-
Method |
|
|
9
|
+
Method | Description
|
|
10
10
|
------------- | ------------- | -------------
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
11
|
+
[**delete_greeting_id**](GreetingsApi.html#delete_greeting_id) | Deletes a Greeting with the given GreetingId
|
|
12
|
+
[**get_defaults**](GreetingsApi.html#get_defaults) | Get an Organization's DefaultGreetingList
|
|
13
|
+
[**get_greeting_id**](GreetingsApi.html#get_greeting_id) | Get a Greeting with the given GreetingId
|
|
14
|
+
[**get_greeting_id_media**](GreetingsApi.html#get_greeting_id_media) | Get media playback URI for this greeting
|
|
15
|
+
[**get_greetings**](GreetingsApi.html#get_greetings) | Gets an Organization's Greetings
|
|
16
|
+
[**get_group_id_greetings**](GreetingsApi.html#get_group_id_greetings) | Get a list of the Group's Greetings
|
|
17
|
+
[**get_group_id_greetings_defaults**](GreetingsApi.html#get_group_id_greetings_defaults) | Grabs the list of Default Greetings given a Group's ID
|
|
18
|
+
[**get_user_id_greetings**](GreetingsApi.html#get_user_id_greetings) | Get a list of the User's Greetings
|
|
19
|
+
[**get_user_id_greetings_defaults**](GreetingsApi.html#get_user_id_greetings_defaults) | Grabs the list of Default Greetings given a User's ID
|
|
20
|
+
[**post_greetings**](GreetingsApi.html#post_greetings) | Create a Greeting for an Organization
|
|
21
|
+
[**post_group_id_greetings**](GreetingsApi.html#post_group_id_greetings) | Creates a Greeting for a Group
|
|
22
|
+
[**post_user_id_greetings**](GreetingsApi.html#post_user_id_greetings) | Creates a Greeting for a User
|
|
23
|
+
[**put_defaults**](GreetingsApi.html#put_defaults) | Update an Organization's DefaultGreetingList
|
|
24
|
+
[**put_greeting_id**](GreetingsApi.html#put_greeting_id) | Updates the Greeting with the given GreetingId
|
|
25
|
+
[**put_group_id_greetings_defaults**](GreetingsApi.html#put_group_id_greetings_defaults) | Updates the DefaultGreetingList of the specified Group
|
|
26
|
+
[**put_user_id_greetings_defaults**](GreetingsApi.html#put_user_id_greetings_defaults) | Updates the DefaultGreetingList of the specified User
|
|
27
27
|
{: class="table table-striped"}
|
|
28
28
|
|
|
29
29
|
<a name="delete_greeting_id"></a>
|
|
@@ -34,6 +34,9 @@ Deletes a Greeting with the given GreetingId
|
|
|
34
34
|
|
|
35
35
|
|
|
36
36
|
|
|
37
|
+
Wraps DELETE /api/v2/greetings/{greetingId}
|
|
38
|
+
|
|
39
|
+
|
|
37
40
|
### Example
|
|
38
41
|
~~~ruby
|
|
39
42
|
# load the gem
|
|
@@ -90,6 +93,9 @@ Get an Organization's DefaultGreetingList
|
|
|
90
93
|
|
|
91
94
|
|
|
92
95
|
|
|
96
|
+
Wraps GET /api/v2/greetings/defaults
|
|
97
|
+
|
|
98
|
+
|
|
93
99
|
### Example
|
|
94
100
|
~~~ruby
|
|
95
101
|
# load the gem
|
|
@@ -140,6 +146,9 @@ Get a Greeting with the given GreetingId
|
|
|
140
146
|
|
|
141
147
|
|
|
142
148
|
|
|
149
|
+
Wraps GET /api/v2/greetings/{greetingId}
|
|
150
|
+
|
|
151
|
+
|
|
143
152
|
### Example
|
|
144
153
|
~~~ruby
|
|
145
154
|
# load the gem
|
|
@@ -196,6 +205,9 @@ Get media playback URI for this greeting
|
|
|
196
205
|
|
|
197
206
|
|
|
198
207
|
|
|
208
|
+
Wraps GET /api/v2/greetings/{greetingId}/media
|
|
209
|
+
|
|
210
|
+
|
|
199
211
|
### Example
|
|
200
212
|
~~~ruby
|
|
201
213
|
# load the gem
|
|
@@ -256,6 +268,9 @@ Gets an Organization's Greetings
|
|
|
256
268
|
|
|
257
269
|
|
|
258
270
|
|
|
271
|
+
Wraps GET /api/v2/greetings
|
|
272
|
+
|
|
273
|
+
|
|
259
274
|
### Example
|
|
260
275
|
~~~ruby
|
|
261
276
|
# load the gem
|
|
@@ -315,6 +330,9 @@ Get a list of the Group's Greetings
|
|
|
315
330
|
|
|
316
331
|
|
|
317
332
|
|
|
333
|
+
Wraps GET /api/v2/groups/{groupId}/greetings
|
|
334
|
+
|
|
335
|
+
|
|
318
336
|
### Example
|
|
319
337
|
~~~ruby
|
|
320
338
|
# load the gem
|
|
@@ -377,6 +395,9 @@ Grabs the list of Default Greetings given a Group's ID
|
|
|
377
395
|
|
|
378
396
|
|
|
379
397
|
|
|
398
|
+
Wraps GET /api/v2/groups/{groupId}/greetings/defaults
|
|
399
|
+
|
|
400
|
+
|
|
380
401
|
### Example
|
|
381
402
|
~~~ruby
|
|
382
403
|
# load the gem
|
|
@@ -433,6 +454,9 @@ Get a list of the User's Greetings
|
|
|
433
454
|
|
|
434
455
|
|
|
435
456
|
|
|
457
|
+
Wraps GET /api/v2/users/{userId}/greetings
|
|
458
|
+
|
|
459
|
+
|
|
436
460
|
### Example
|
|
437
461
|
~~~ruby
|
|
438
462
|
# load the gem
|
|
@@ -495,6 +519,9 @@ Grabs the list of Default Greetings given a User's ID
|
|
|
495
519
|
|
|
496
520
|
|
|
497
521
|
|
|
522
|
+
Wraps GET /api/v2/users/{userId}/greetings/defaults
|
|
523
|
+
|
|
524
|
+
|
|
498
525
|
### Example
|
|
499
526
|
~~~ruby
|
|
500
527
|
# load the gem
|
|
@@ -551,6 +578,9 @@ Create a Greeting for an Organization
|
|
|
551
578
|
|
|
552
579
|
|
|
553
580
|
|
|
581
|
+
Wraps POST /api/v2/greetings
|
|
582
|
+
|
|
583
|
+
|
|
554
584
|
### Example
|
|
555
585
|
~~~ruby
|
|
556
586
|
# load the gem
|
|
@@ -607,6 +637,9 @@ Creates a Greeting for a Group
|
|
|
607
637
|
|
|
608
638
|
|
|
609
639
|
|
|
640
|
+
Wraps POST /api/v2/groups/{groupId}/greetings
|
|
641
|
+
|
|
642
|
+
|
|
610
643
|
### Example
|
|
611
644
|
~~~ruby
|
|
612
645
|
# load the gem
|
|
@@ -666,6 +699,9 @@ Creates a Greeting for a User
|
|
|
666
699
|
|
|
667
700
|
|
|
668
701
|
|
|
702
|
+
Wraps POST /api/v2/users/{userId}/greetings
|
|
703
|
+
|
|
704
|
+
|
|
669
705
|
### Example
|
|
670
706
|
~~~ruby
|
|
671
707
|
# load the gem
|
|
@@ -725,6 +761,9 @@ Update an Organization's DefaultGreetingList
|
|
|
725
761
|
|
|
726
762
|
|
|
727
763
|
|
|
764
|
+
Wraps PUT /api/v2/greetings/defaults
|
|
765
|
+
|
|
766
|
+
|
|
728
767
|
### Example
|
|
729
768
|
~~~ruby
|
|
730
769
|
# load the gem
|
|
@@ -781,6 +820,9 @@ Updates the Greeting with the given GreetingId
|
|
|
781
820
|
|
|
782
821
|
|
|
783
822
|
|
|
823
|
+
Wraps PUT /api/v2/greetings/{greetingId}
|
|
824
|
+
|
|
825
|
+
|
|
784
826
|
### Example
|
|
785
827
|
~~~ruby
|
|
786
828
|
# load the gem
|
|
@@ -840,6 +882,9 @@ Updates the DefaultGreetingList of the specified Group
|
|
|
840
882
|
|
|
841
883
|
|
|
842
884
|
|
|
885
|
+
Wraps PUT /api/v2/groups/{groupId}/greetings/defaults
|
|
886
|
+
|
|
887
|
+
|
|
843
888
|
### Example
|
|
844
889
|
~~~ruby
|
|
845
890
|
# load the gem
|
|
@@ -899,6 +944,9 @@ Updates the DefaultGreetingList of the specified User
|
|
|
899
944
|
|
|
900
945
|
|
|
901
946
|
|
|
947
|
+
Wraps PUT /api/v2/users/{userId}/greetings/defaults
|
|
948
|
+
|
|
949
|
+
|
|
902
950
|
### Example
|
|
903
951
|
~~~ruby
|
|
904
952
|
# load the gem
|