purecloud 0.67.1 → 0.68.1
Sign up to get free protection for your applications and to get access to all the features.
- 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: InboundRouteEntityListing
|
|
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: InteractionStatsAlertContainer
|
|
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: InteractionStatsRuleContainer
|
|
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/JsonNode.html.md
CHANGED
@@ -7,6 +7,8 @@ title: JsonNode
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **array** | **BOOLEAN** | | [optional] |
|
11
|
+
| **null** | **BOOLEAN** | | [optional] |
|
10
12
|
| **node_type** | **String** | | [optional] |
|
11
13
|
| **object** | **BOOLEAN** | | [optional] |
|
12
14
|
| **boolean** | **BOOLEAN** | | [optional] |
|
@@ -26,8 +28,6 @@ title: JsonNode
|
|
26
28
|
| **big_integer** | **BOOLEAN** | | [optional] |
|
27
29
|
| **textual** | **BOOLEAN** | | [optional] |
|
28
30
|
| **binary** | **BOOLEAN** | | [optional] |
|
29
|
-
| **array** | **BOOLEAN** | | [optional] |
|
30
|
-
| **null** | **BOOLEAN** | | [optional] |
|
31
31
|
{: class="table table-striped"}
|
32
32
|
|
33
33
|
|
@@ -11,11 +11,11 @@ title: KeywordSetEntityListing
|
|
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: LanguageEntityListing
|
|
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,18 +6,18 @@ title: LanguagesApi
|
|
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
|
-
|
11
|
+
[**delete_language_id**](LanguagesApi.html#delete_language_id) | Delete Language (Deprecated)
|
12
|
+
[**delete_languages_language_id**](LanguagesApi.html#delete_languages_language_id) | Delete Language
|
13
|
+
[**get_language_id**](LanguagesApi.html#get_language_id) | Get language (Deprecated)
|
14
|
+
[**get_languages**](LanguagesApi.html#get_languages) | Get the list of supported languages. (Deprecated)
|
15
|
+
[**get_languages_language_id**](LanguagesApi.html#get_languages_language_id) | Get language
|
16
|
+
[**get_translations**](LanguagesApi.html#get_translations) | Get all available languages for translation
|
17
|
+
[**get_translations_builtin**](LanguagesApi.html#get_translations_builtin) | Get the builtin translation for a language
|
18
|
+
[**get_translations_organization**](LanguagesApi.html#get_translations_organization) | Get effective translation for an organization by language
|
19
|
+
[**get_translations_users_user_id**](LanguagesApi.html#get_translations_users_user_id) | Get effective language translation for a user
|
20
|
+
[**post_languages**](LanguagesApi.html#post_languages) | Create Language (Deprecated)
|
21
21
|
{: class="table table-striped"}
|
22
22
|
|
23
23
|
<a name="delete_language_id"></a>
|
@@ -28,6 +28,9 @@ Delete Language (Deprecated)
|
|
28
28
|
|
29
29
|
This endpoint is deprecated. It has been moved to /routing/languages/{languageId}
|
30
30
|
|
31
|
+
Wraps DELETE /api/v2/languages/{languageId}
|
32
|
+
|
33
|
+
|
31
34
|
### Example
|
32
35
|
~~~ruby
|
33
36
|
# load the gem
|
@@ -83,6 +86,9 @@ Delete Language
|
|
83
86
|
|
84
87
|
|
85
88
|
|
89
|
+
Wraps DELETE /api/v2/routing/languages/{languageId}
|
90
|
+
|
91
|
+
|
86
92
|
### Example
|
87
93
|
~~~ruby
|
88
94
|
# load the gem
|
@@ -138,6 +144,9 @@ Get language (Deprecated)
|
|
138
144
|
|
139
145
|
This endpoint is deprecated. It has been moved to /routing/languages/{languageId}
|
140
146
|
|
147
|
+
Wraps GET /api/v2/languages/{languageId}
|
148
|
+
|
149
|
+
|
141
150
|
### Example
|
142
151
|
~~~ruby
|
143
152
|
# load the gem
|
@@ -194,6 +203,9 @@ Get the list of supported languages. (Deprecated)
|
|
194
203
|
|
195
204
|
This endpoint is deprecated. It has been moved to /routing/languages
|
196
205
|
|
206
|
+
Wraps GET /api/v2/languages
|
207
|
+
|
208
|
+
|
197
209
|
### Example
|
198
210
|
~~~ruby
|
199
211
|
# load the gem
|
@@ -257,6 +269,9 @@ Get language
|
|
257
269
|
|
258
270
|
|
259
271
|
|
272
|
+
Wraps GET /api/v2/routing/languages/{languageId}
|
273
|
+
|
274
|
+
|
260
275
|
### Example
|
261
276
|
~~~ruby
|
262
277
|
# load the gem
|
@@ -313,6 +328,9 @@ Get all available languages for translation
|
|
313
328
|
|
314
329
|
|
315
330
|
|
331
|
+
Wraps GET /api/v2/languages/translations
|
332
|
+
|
333
|
+
|
316
334
|
### Example
|
317
335
|
~~~ruby
|
318
336
|
# load the gem
|
@@ -363,6 +381,9 @@ Get the builtin translation for a language
|
|
363
381
|
|
364
382
|
|
365
383
|
|
384
|
+
Wraps GET /api/v2/languages/translations/builtin
|
385
|
+
|
386
|
+
|
366
387
|
### Example
|
367
388
|
~~~ruby
|
368
389
|
# load the gem
|
@@ -419,6 +440,9 @@ Get effective translation for an organization by language
|
|
419
440
|
|
420
441
|
|
421
442
|
|
443
|
+
Wraps GET /api/v2/languages/translations/organization
|
444
|
+
|
445
|
+
|
422
446
|
### Example
|
423
447
|
~~~ruby
|
424
448
|
# load the gem
|
@@ -475,6 +499,9 @@ Get effective language translation for a user
|
|
475
499
|
|
476
500
|
|
477
501
|
|
502
|
+
Wraps GET /api/v2/languages/translations/users/{userId}
|
503
|
+
|
504
|
+
|
478
505
|
### Example
|
479
506
|
~~~ruby
|
480
507
|
# load the gem
|
@@ -531,6 +558,9 @@ Create Language (Deprecated)
|
|
531
558
|
|
532
559
|
This endpoint is deprecated. It has been moved to /routing/languages
|
533
560
|
|
561
|
+
Wraps POST /api/v2/languages
|
562
|
+
|
563
|
+
|
534
564
|
### Example
|
535
565
|
~~~ruby
|
536
566
|
# load the gem
|
@@ -11,11 +11,11 @@ title: LibraryEntityListing
|
|
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: LineBaseEntityListing
|
|
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: LineEntityListing
|
|
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: LocalEncryptionConfigurationListing
|
|
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: LocationsApi
|
|
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_location_id**](LocationsApi.html#get_location_id) | Get Location by ID.
|
12
|
+
[**get_locations**](LocationsApi.html#get_locations) | Get a list of all locations.
|
13
|
+
[**get_search**](LocationsApi.html#get_search) | Search locations using the q64 value returned from a previous search
|
14
|
+
[**post_search**](LocationsApi.html#post_search) | Search locations
|
15
15
|
{: class="table table-striped"}
|
16
16
|
|
17
17
|
<a name="get_location_id"></a>
|
@@ -22,6 +22,9 @@ Get Location by ID.
|
|
22
22
|
|
23
23
|
|
24
24
|
|
25
|
+
Wraps GET /api/v2/locations/{locationId}
|
26
|
+
|
27
|
+
|
25
28
|
### Example
|
26
29
|
~~~ruby
|
27
30
|
# load the gem
|
@@ -78,6 +81,9 @@ Get a list of all locations.
|
|
78
81
|
|
79
82
|
|
80
83
|
|
84
|
+
Wraps GET /api/v2/locations
|
85
|
+
|
86
|
+
|
81
87
|
### Example
|
82
88
|
~~~ruby
|
83
89
|
# load the gem
|
@@ -139,6 +145,9 @@ Search locations using the q64 value returned from a previous search
|
|
139
145
|
|
140
146
|
|
141
147
|
|
148
|
+
Wraps GET /api/v2/locations/search
|
149
|
+
|
150
|
+
|
142
151
|
### Example
|
143
152
|
~~~ruby
|
144
153
|
# load the gem
|
@@ -199,6 +208,9 @@ Search locations
|
|
199
208
|
|
200
209
|
|
201
210
|
|
211
|
+
Wraps POST /api/v2/locations/search
|
212
|
+
|
213
|
+
|
202
214
|
### Example
|
203
215
|
~~~ruby
|
204
216
|
# load the gem
|
@@ -11,11 +11,11 @@ title: LogicalInterfaceEntityListing
|
|
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,15 +6,15 @@ title: NotificationsApi
|
|
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
|
-
|
11
|
+
[**delete_channels_channel_id_subscriptions**](NotificationsApi.html#delete_channels_channel_id_subscriptions) | Remove all subscriptions
|
12
|
+
[**get_availabletopics**](NotificationsApi.html#get_availabletopics) | Get available notification topics.
|
13
|
+
[**get_channels**](NotificationsApi.html#get_channels) | The list of existing channels
|
14
|
+
[**get_channels_channel_id_subscriptions**](NotificationsApi.html#get_channels_channel_id_subscriptions) | The list of all subscriptions for this channel
|
15
|
+
[**post_channels**](NotificationsApi.html#post_channels) | Create a new channel
|
16
|
+
[**post_channels_channel_id_subscriptions**](NotificationsApi.html#post_channels_channel_id_subscriptions) | Add a list of subscriptions to the existing list of subscriptions
|
17
|
+
[**put_channels_channel_id_subscriptions**](NotificationsApi.html#put_channels_channel_id_subscriptions) | Replace the current list of subscriptions with a new list.
|
18
18
|
{: class="table table-striped"}
|
19
19
|
|
20
20
|
<a name="delete_channels_channel_id_subscriptions"></a>
|
@@ -25,6 +25,9 @@ Remove all subscriptions
|
|
25
25
|
|
26
26
|
|
27
27
|
|
28
|
+
Wraps DELETE /api/v2/notifications/channels/{channelId}/subscriptions
|
29
|
+
|
30
|
+
|
28
31
|
### Example
|
29
32
|
~~~ruby
|
30
33
|
# load the gem
|
@@ -81,6 +84,9 @@ Get available notification topics.
|
|
81
84
|
|
82
85
|
|
83
86
|
|
87
|
+
Wraps GET /api/v2/notifications/availabletopics
|
88
|
+
|
89
|
+
|
84
90
|
### Example
|
85
91
|
~~~ruby
|
86
92
|
# load the gem
|
@@ -138,6 +144,9 @@ The list of existing channels
|
|
138
144
|
|
139
145
|
|
140
146
|
|
147
|
+
Wraps GET /api/v2/notifications/channels
|
148
|
+
|
149
|
+
|
141
150
|
### Example
|
142
151
|
~~~ruby
|
143
152
|
# load the gem
|
@@ -188,6 +197,9 @@ The list of all subscriptions for this channel
|
|
188
197
|
|
189
198
|
|
190
199
|
|
200
|
+
Wraps GET /api/v2/notifications/channels/{channelId}/subscriptions
|
201
|
+
|
202
|
+
|
191
203
|
### Example
|
192
204
|
~~~ruby
|
193
205
|
# load the gem
|
@@ -244,6 +256,9 @@ Create a new channel
|
|
244
256
|
|
245
257
|
There is a limit of 10 channels. Creating an 11th channel will remove the channel with oldest last used date.
|
246
258
|
|
259
|
+
Wraps POST /api/v2/notifications/channels
|
260
|
+
|
261
|
+
|
247
262
|
### Example
|
248
263
|
~~~ruby
|
249
264
|
# load the gem
|
@@ -294,6 +309,9 @@ Add a list of subscriptions to the existing list of subscriptions
|
|
294
309
|
|
295
310
|
|
296
311
|
|
312
|
+
Wraps POST /api/v2/notifications/channels/{channelId}/subscriptions
|
313
|
+
|
314
|
+
|
297
315
|
### Example
|
298
316
|
~~~ruby
|
299
317
|
# load the gem
|
@@ -353,6 +371,9 @@ Replace the current list of subscriptions with a new list.
|
|
353
371
|
|
354
372
|
|
355
373
|
|
374
|
+
Wraps PUT /api/v2/notifications/channels/{channelId}/subscriptions
|
375
|
+
|
376
|
+
|
356
377
|
### Example
|
357
378
|
~~~ruby
|
358
379
|
# load the gem
|
data/doc_out/OAuthApi.html.md
CHANGED
@@ -6,14 +6,14 @@ title: OAuthApi
|
|
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_clients_client_id**](OAuthApi.html#delete_clients_client_id) | Delete OAuth Client
|
12
|
+
[**get_clients**](OAuthApi.html#get_clients) | The list of OAuth clients
|
13
|
+
[**get_clients_client_id**](OAuthApi.html#get_clients_client_id) | Get OAuth Client
|
14
|
+
[**post_clients**](OAuthApi.html#post_clients) | Create OAuth client
|
15
|
+
[**post_clients_client_id_secret**](OAuthApi.html#post_clients_client_id_secret) | Regenerate Client Secret
|
16
|
+
[**put_clients_client_id**](OAuthApi.html#put_clients_client_id) | Update OAuth Client
|
17
17
|
{: class="table table-striped"}
|
18
18
|
|
19
19
|
<a name="delete_clients_client_id"></a>
|
@@ -24,6 +24,9 @@ Delete OAuth Client
|
|
24
24
|
|
25
25
|
|
26
26
|
|
27
|
+
Wraps DELETE /api/v2/oauth/clients/{clientId}
|
28
|
+
|
29
|
+
|
27
30
|
### Example
|
28
31
|
~~~ruby
|
29
32
|
# load the gem
|
@@ -79,6 +82,9 @@ The list of OAuth clients
|
|
79
82
|
|
80
83
|
|
81
84
|
|
85
|
+
Wraps GET /api/v2/oauth/clients
|
86
|
+
|
87
|
+
|
82
88
|
### Example
|
83
89
|
~~~ruby
|
84
90
|
# load the gem
|
@@ -129,6 +135,9 @@ Get OAuth Client
|
|
129
135
|
|
130
136
|
|
131
137
|
|
138
|
+
Wraps GET /api/v2/oauth/clients/{clientId}
|
139
|
+
|
140
|
+
|
132
141
|
### Example
|
133
142
|
~~~ruby
|
134
143
|
# load the gem
|
@@ -185,6 +194,9 @@ Create OAuth client
|
|
185
194
|
|
186
195
|
The OAuth Grant/Client is required in order to create an authentication token and gain access to PureCloud. \nThe preferred authorizedGrantTypes is 'CODE' which requires applications to send a client ID and client secret. This is typically a web server. \nIf the client is unable to secure the client secret then the 'TOKEN' grant type aka IMPLICIT should be used. This is would be for browser or mobile apps. \nIf a client is to be used outside of the context of a user then the 'CLIENT-CREDENTIALS' grant may be used. In this case the client must be granted roles \nvia the 'roleIds' field.
|
187
196
|
|
197
|
+
Wraps POST /api/v2/oauth/clients
|
198
|
+
|
199
|
+
|
188
200
|
### Example
|
189
201
|
~~~ruby
|
190
202
|
# load the gem
|
@@ -241,6 +253,9 @@ Regenerate Client Secret
|
|
241
253
|
|
242
254
|
This operation will set the client secret to a randomly generated cryptographically random value. All clients must be updated with the new secret. This operation should be used with caution.
|
243
255
|
|
256
|
+
Wraps POST /api/v2/oauth/clients/{clientId}/secret
|
257
|
+
|
258
|
+
|
244
259
|
### Example
|
245
260
|
~~~ruby
|
246
261
|
# load the gem
|
@@ -296,6 +311,9 @@ Update OAuth Client
|
|
296
311
|
|
297
312
|
|
298
313
|
|
314
|
+
Wraps PUT /api/v2/oauth/clients/{clientId}
|
315
|
+
|
316
|
+
|
299
317
|
### Example
|
300
318
|
~~~ruby
|
301
319
|
# load the gem
|