purecloud 0.68.1 → 0.69.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 +12 -4
- data/config-ruby.json +1 -1
- data/doc_out/AgentActivityEntityListing.html.md +3 -3
- data/doc_out/AggregateViewData.html.md +14 -0
- data/doc_out/AggregationQuery.html.md +1 -0
- data/doc_out/AnalyticsView.html.md +16 -0
- data/doc_out/AnswerOption.html.md +15 -0
- data/doc_out/AttemptLimitsEntityListing.html.md +3 -3
- data/doc_out/AttemptLimitsNotificationRecallEntries.html.md +2 -2
- data/doc_out/AttributeEntityListing.html.md +3 -3
- data/doc_out/AvailableTopic.html.md +2 -2
- data/doc_out/CalibrationEntityListing.html.md +3 -3
- data/doc_out/CallBasic.html.md +31 -0
- data/doc_out/CallConversationEntityListing.html.md +3 -3
- data/doc_out/CallConversationNotificationCallMediaParticipant.html.md +1 -0
- data/doc_out/CallConversationNotificationErrorInfo.html.md +7 -7
- data/doc_out/CallConversationNotificationFaxStatus.html.md +5 -5
- data/doc_out/CallConversationNotificationParticipants.html.md +25 -24
- data/doc_out/CallConversationNotificationWrapup.html.md +18 -0
- data/doc_out/CallMediaParticipant.html.md +1 -0
- data/doc_out/CallableTimeSetEntityListing.html.md +3 -3
- data/doc_out/CallableTimeSetNotificationCallableTimes.html.md +1 -1
- data/doc_out/CallableTimeSetNotificationTimeSlots.html.md +1 -1
- data/doc_out/CallbackBasic.html.md +30 -0
- data/doc_out/CallbackConversationEntityListing.html.md +3 -3
- data/doc_out/CallbackConversationNotificationCallbackMediaParticipant.html.md +1 -0
- data/doc_out/CallbackConversationNotificationErrorInfo.html.md +7 -7
- data/doc_out/CallbackConversationNotificationErrorInfoDetails.html.md +2 -2
- data/doc_out/CallbackConversationNotificationParticipants.html.md +24 -23
- data/doc_out/CallbackConversationNotificationWrapup.html.md +18 -0
- data/doc_out/CallbackMediaParticipant.html.md +1 -0
- data/doc_out/CampaignEntityListing.html.md +3 -3
- data/doc_out/CampaignInteraction.html.md +1 -1
- data/doc_out/CampaignNotificationContactSort.html.md +1 -1
- data/doc_out/CampaignNotificationErrors.html.md +1 -1
- data/doc_out/CampaignNotificationPhoneColumns.html.md +1 -1
- data/doc_out/CampaignRuleEntityListing.html.md +3 -3
- data/doc_out/CampaignRuleNotificationCampaignRuleActionEntities.html.md +2 -2
- data/doc_out/CampaignRuleNotificationCampaignRuleActions.html.md +1 -1
- data/doc_out/CampaignRuleNotificationCampaignRuleConditions.html.md +1 -1
- data/doc_out/CampaignRuleNotificationCampaignRuleEntities.html.md +1 -1
- data/doc_out/CampaignScheduleNotificationIntervals.html.md +1 -1
- data/doc_out/CampaignSequenceEntityListing.html.md +3 -3
- data/doc_out/CampaignStats.html.md +2 -0
- data/doc_out/CertificateAuthorityEntityListing.html.md +3 -3
- data/doc_out/Channel.html.md +1 -1
- data/doc_out/ChannelEntityListing.html.md +0 -9
- data/doc_out/ChannelTopic.html.md +1 -1
- data/doc_out/ChatConversationEntityListing.html.md +3 -3
- data/doc_out/ChatConversationNotificationChatMediaParticipant.html.md +1 -0
- data/doc_out/ChatConversationNotificationErrorInfo.html.md +7 -7
- data/doc_out/ChatConversationNotificationParticipants.html.md +17 -16
- data/doc_out/ChatConversationNotificationWrapup.html.md +18 -0
- data/doc_out/ChatMediaParticipant.html.md +1 -0
- data/doc_out/CobrowseConversationEntityListing.html.md +3 -3
- data/doc_out/CobrowseConversationNotificationCobrowseMediaParticipant.html.md +1 -0
- data/doc_out/CobrowseConversationNotificationErrorInfo.html.md +7 -7
- data/doc_out/CobrowseConversationNotificationParticipants.html.md +22 -21
- data/doc_out/CobrowseConversationNotificationWrapup.html.md +18 -0
- data/doc_out/CobrowseMediaParticipant.html.md +1 -0
- data/doc_out/CommandStatusEntityListing.html.md +3 -3
- data/doc_out/ContactList.html.md +1 -0
- data/doc_out/ContactListEntityListing.html.md +3 -3
- data/doc_out/ContactListNotificationImportStatus.html.md +3 -3
- data/doc_out/ContactListNotificationPhoneColumns.html.md +1 -1
- data/doc_out/ConversationBasic.html.md +18 -0
- data/doc_out/ConversationEntityListing.html.md +3 -3
- data/doc_out/ConversationNotificationCallbacks.html.md +11 -11
- data/doc_out/ConversationNotificationCalls.html.md +12 -12
- data/doc_out/ConversationNotificationChats.html.md +5 -5
- data/doc_out/ConversationNotificationCobrowsesessions.html.md +8 -8
- data/doc_out/ConversationNotificationDialerPreview.html.md +3 -3
- data/doc_out/ConversationNotificationDisconnectReasons.html.md +1 -1
- data/doc_out/ConversationNotificationEmails.html.md +7 -7
- data/doc_out/ConversationNotificationErrorInfo.html.md +4 -4
- data/doc_out/ConversationNotificationFaxStatus.html.md +5 -5
- data/doc_out/ConversationNotificationParticipants.html.md +20 -20
- data/doc_out/ConversationNotificationScreenshares.html.md +7 -7
- data/doc_out/ConversationNotificationSelf.html.md +3 -3
- data/doc_out/ConversationNotificationSocialExpressions.html.md +5 -5
- data/doc_out/ConversationNotificationVideos.html.md +7 -7
- data/doc_out/ConversationNotificationWrapup.html.md +4 -4
- data/doc_out/CreateEmailRequest.html.md +1 -0
- data/doc_out/DIDEntityListing.html.md +3 -3
- data/doc_out/DIDPoolEntityListing.html.md +3 -3
- data/doc_out/DncListCreate.html.md +24 -0
- data/doc_out/DncListEntityListing.html.md +3 -3
- data/doc_out/DocumentAuditEntityListing.html.md +3 -3
- data/doc_out/DocumentDataV2NotificationCreatedBy.html.md +1 -1
- data/doc_out/DocumentDataV2NotificationLockInfo.html.md +1 -1
- data/doc_out/DocumentEntityListing.html.md +3 -3
- data/doc_out/DocumentationResult.html.md +32 -0
- data/doc_out/{ForecastSearchCriteria.html.md → DocumentationSearchCriteria.html.md} +3 -3
- data/doc_out/{ForecastSearchRequest.html.md → DocumentationSearchRequest.html.md} +3 -6
- data/doc_out/DocumentationSearchResponse.html.md +21 -0
- data/doc_out/DomainEdgeSoftwareUpdateDto.html.md +1 -0
- data/doc_out/DomainEdgeSoftwareVersionDtoEntityListing.html.md +3 -3
- data/doc_out/DomainEntityListing.html.md +3 -3
- data/doc_out/DomainEntityListingEvaluationForm.html.md +3 -3
- data/doc_out/DomainEntityListingQueryResult.html.md +3 -3
- 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 +3 -3
- data/doc_out/EdgeGroup.html.md +1 -1
- data/doc_out/EdgeGroupEntityListing.html.md +3 -3
- data/doc_out/EdgeLineEntityListing.html.md +3 -3
- data/doc_out/EdgeServiceStateRequest.html.md +14 -0
- data/doc_out/EdgeTrunkBase.html.md +27 -0
- data/doc_out/EmailConversationEntityListing.html.md +3 -3
- data/doc_out/EmailConversationNotificationEmailMediaParticipant.html.md +1 -0
- data/doc_out/EmailConversationNotificationErrorInfo.html.md +7 -7
- data/doc_out/EmailConversationNotificationParticipants.html.md +19 -18
- data/doc_out/EmailConversationNotificationWrapup.html.md +18 -0
- data/doc_out/EmailMediaParticipant.html.md +1 -0
- data/doc_out/EmailMessageListing.html.md +3 -3
- data/doc_out/EncryptionKeyEntityListing.html.md +3 -3
- data/doc_out/EndpointEntityListing.html.md +3 -3
- data/doc_out/Entry.html.md +2 -2
- data/doc_out/EvaluationEntityListing.html.md +3 -3
- data/doc_out/EvaluationFormEntityListing.html.md +3 -3
- data/doc_out/EvaluatorActivityEntityListing.html.md +3 -3
- data/doc_out/ExtensionEntityListing.html.md +3 -3
- data/doc_out/ExtensionPoolEntityListing.html.md +3 -3
- data/doc_out/FaxDataV2NotificationLockInfo.html.md +1 -1
- data/doc_out/FaxDocumentEntityListing.html.md +3 -3
- data/doc_out/{EntryFeatureBoolean.html.md → FeatureState.html.md} +3 -4
- data/doc_out/GSuite.html.md +20 -0
- data/doc_out/Geolocation.html.md +1 -0
- data/doc_out/GreetingListing.html.md +3 -3
- data/doc_out/GreetingsApi.html.md +3 -4
- data/doc_out/GroupEntityListing.html.md +3 -3
- data/doc_out/GroupSearchRequest.html.md +0 -2
- data/doc_out/GroupsApi.html.md +3 -4
- data/doc_out/HeartBeatAlertContainer.html.md +3 -3
- data/doc_out/HeartBeatAlertNotificationNotificationUsers.html.md +1 -1
- data/doc_out/HeartBeatRuleContainer.html.md +3 -3
- data/doc_out/IdentityProviderApi.html.md +247 -65
- data/doc_out/InboundDomainEntityListing.html.md +3 -3
- data/doc_out/InboundRouteEntityListing.html.md +3 -3
- data/doc_out/InteractionStatsAlertContainer.html.md +3 -3
- data/doc_out/InteractionStatsRuleContainer.html.md +3 -3
- data/doc_out/JsonNode.html.md +3 -3
- data/doc_out/KeywordSet.html.md +0 -1
- data/doc_out/KeywordSetEntityListing.html.md +3 -3
- data/doc_out/LanguageEntityListing.html.md +3 -3
- data/doc_out/LibraryEntityListing.html.md +3 -3
- data/doc_out/LineBaseEntityListing.html.md +3 -3
- data/doc_out/LineEntityListing.html.md +3 -3
- data/doc_out/LocalEncryptionConfigurationListing.html.md +1 -8
- data/doc_out/LocationSearchRequest.html.md +0 -2
- data/doc_out/LogicalInterfaceEntityListing.html.md +3 -3
- data/doc_out/NotificationsApi.html.md +7 -8
- data/doc_out/OAuthApi.html.md +4 -3
- data/doc_out/OAuthClientEntityListing.html.md +3 -3
- data/doc_out/OAuthProviderEntityListing.html.md +3 -3
- data/doc_out/OrganizationApi.html.md +13 -11
- data/doc_out/OrganizationFeatures.html.md +25 -0
- data/doc_out/OrganizationPresenceEntityListing.html.md +3 -3
- data/doc_out/OrganizationRoleEntityListing.html.md +3 -3
- data/doc_out/OrphanRecordingListing.html.md +3 -3
- data/doc_out/OutboundApi.html.md +8 -8
- data/doc_out/OutboundRouteBaseEntityListing.html.md +3 -3
- data/doc_out/OutboundRouteEntityListing.html.md +3 -3
- data/doc_out/ParticipantBasic.html.md +48 -0
- data/doc_out/PermissionCollectionEntityListing.html.md +3 -3
- data/doc_out/PhoneBaseEntityListing.html.md +3 -3
- data/doc_out/PhoneEntityListing.html.md +3 -3
- data/doc_out/PhoneMetaBaseEntityListing.html.md +3 -3
- data/doc_out/PhysicalInterfaceEntityListing.html.md +3 -3
- data/doc_out/PingIdentity.html.md +20 -0
- data/doc_out/PolicyEntityListing.html.md +3 -3
- data/doc_out/PredictionResults.html.md +1 -0
- data/doc_out/QualityAudit.html.md +1 -1
- data/doc_out/QualityAuditPage.html.md +3 -3
- data/doc_out/Question.html.md +24 -0
- data/doc_out/QuestionGroup.html.md +1 -1
- data/doc_out/QueueEntityListing.html.md +3 -3
- data/doc_out/QueueMember.html.md +1 -1
- data/doc_out/QueueMemberEntityListing.html.md +3 -3
- data/doc_out/RecordingDataV2NotificationLockInfo.html.md +1 -1
- data/doc_out/ReportMetaDataEntityListing.html.md +3 -3
- data/doc_out/ReportRunEntryEntityDomainListing.html.md +3 -3
- data/doc_out/ReportScheduleEntityListing.html.md +3 -3
- data/doc_out/Response.html.md +1 -0
- data/doc_out/ResponseEntityList.html.md +3 -3
- data/doc_out/ResponseEntityListing.html.md +3 -3
- data/doc_out/ResponseSetEntityListing.html.md +3 -3
- data/doc_out/ResponseSetNotificationResponses.html.md +2 -2
- data/doc_out/ResponseSubstitution.html.md +15 -0
- data/doc_out/RoutingApi.html.md +23 -290
- data/doc_out/RoutingStatusAlertContainer.html.md +3 -3
- data/doc_out/RoutingStatusRuleContainer.html.md +3 -3
- data/doc_out/RuleSetEntityListing.html.md +3 -3
- data/doc_out/RuleSetNotificationActions.html.md +2 -2
- data/doc_out/RuleSetNotificationConditions.html.md +4 -4
- data/doc_out/RuleSetNotificationRules.html.md +4 -4
- data/doc_out/SchemaCategoryEntityListing.html.md +3 -3
- data/doc_out/SchemaReferenceEntityListing.html.md +3 -3
- data/doc_out/ScreenRecordingSessionListing.html.md +3 -3
- data/doc_out/ScreenShareConversationNotificationErrorInfo.html.md +7 -7
- data/doc_out/ScreenShareConversationNotificationParticipants.html.md +18 -17
- data/doc_out/ScreenShareConversationNotificationScreenShareMediaParticipant.html.md +1 -0
- data/doc_out/ScreenShareConversationNotificationWrapup.html.md +18 -0
- data/doc_out/ScriptEntityListing.html.md +3 -3
- data/doc_out/ScriptsApi.html.md +10 -2
- data/doc_out/SearchApi.html.md +168 -48
- data/doc_out/SearchRequest.html.md +1 -1
- data/doc_out/SecurityProfileEntityListing.html.md +3 -3
- data/doc_out/ShareEntityListing.html.md +3 -3
- data/doc_out/SiteEntityListing.html.md +3 -3
- data/doc_out/SkillEntityListing.html.md +3 -3
- data/doc_out/SocialConversationNotificationErrorInfo.html.md +7 -7
- data/doc_out/SocialConversationNotificationParticipants.html.md +20 -19
- data/doc_out/SocialConversationNotificationSocialMediaParticipant.html.md +1 -0
- data/doc_out/SocialConversationNotificationWrapup.html.md +18 -0
- data/doc_out/StationEntityListing.html.md +3 -3
- data/doc_out/StatisticalResponse.html.md +1 -0
- data/doc_out/TagValueEntityListing.html.md +3 -3
- data/doc_out/TelephonyProvidersEdgeApi.html.md +347 -79
- data/doc_out/TimeOffRequestUpdateNotification.html.md +28 -0
- data/doc_out/TimeOffRequestUpdateNotificationUser.html.md +13 -0
- data/doc_out/TimeZoneEntityListing.html.md +3 -3
- data/doc_out/TransferRequest.html.md +1 -1
- data/doc_out/Trunk.html.md +2 -1
- data/doc_out/TrunkBase.html.md +1 -1
- data/doc_out/TrunkBaseEntityListing.html.md +3 -3
- data/doc_out/TrunkEntityListing.html.md +3 -3
- data/doc_out/TrunkMetabaseEntityListing.html.md +3 -3
- data/doc_out/TrunkMetrics.html.md +17 -0
- data/doc_out/TrunkMetricsCalls.html.md +14 -0
- data/doc_out/TrunkMetricsQoS.html.md +13 -0
- data/doc_out/User.html.md +1 -0
- data/doc_out/UserConversationSummaryNotificationCallContactCenter.html.md +1 -1
- data/doc_out/UserEntityListing.html.md +3 -3
- data/doc_out/UserMe.html.md +1 -0
- data/doc_out/UserPresenceAlertContainer.html.md +3 -3
- data/doc_out/UserPresenceNotificationPresenceDefinition.html.md +1 -1
- data/doc_out/UserPresenceRuleContainer.html.md +3 -3
- data/doc_out/UserQueueEntityListing.html.md +3 -3
- data/doc_out/UserRecordingEntityListing.html.md +3 -3
- data/doc_out/UserScheduleAdherenceUpdateNotification.html.md +22 -0
- data/doc_out/UserScheduleAdherenceUpdateNotificationUser.html.md +13 -0
- data/doc_out/UserSearchRequest.html.md +0 -1
- data/doc_out/UserSkillEntityListing.html.md +3 -3
- data/doc_out/UserStationsNotification.html.md +13 -0
- data/doc_out/UserStationsNotificationAssociatedStation.html.md +15 -0
- data/doc_out/UserStationsNotificationUser.html.md +13 -0
- data/doc_out/UserStationsNotificationUserStation.html.md +15 -0
- data/doc_out/UsersApi.html.md +2 -2
- data/doc_out/VideoConversationNotificationErrorInfo.html.md +7 -7
- data/doc_out/VideoConversationNotificationParticipants.html.md +20 -19
- data/doc_out/VideoConversationNotificationVideoMediaParticipant.html.md +1 -0
- data/doc_out/VideoConversationNotificationWrapup.html.md +18 -0
- data/doc_out/VoicemailMessageEntityListing.html.md +3 -3
- data/doc_out/VoicemailSearchRequest.html.md +0 -1
- data/doc_out/WorkforceManagementApi.html.md +15 -134
- data/doc_out/WorkspaceEntityListing.html.md +3 -3
- data/doc_out/WorkspaceMemberEntityListing.html.md +3 -3
- data/doc_out/WrapUpCodeMappingNotification.html.md +2 -3
- data/doc_out/WrapupCodeEntityListing.html.md +3 -3
- data/doc_out/index.html.md +3 -3
- data/lib/purecloud.rb +39 -15
- data/lib/purecloud/api/greetings_api.rb +5 -6
- data/lib/purecloud/api/groups_api.rb +5 -6
- data/lib/purecloud/api/identity_provider_api.rb +280 -96
- data/lib/purecloud/api/notifications_api.rb +9 -10
- data/lib/purecloud/api/o_auth_api.rb +6 -5
- data/lib/purecloud/api/organization_api.rb +23 -12
- data/lib/purecloud/api/outbound_api.rb +9 -9
- data/lib/purecloud/api/routing_api.rb +32 -297
- data/lib/purecloud/api/scripts_api.rb +9 -0
- data/lib/purecloud/api/search_api.rb +180 -59
- data/lib/purecloud/api/telephony_providers_edge_api.rb +368 -89
- data/lib/purecloud/api/users_api.rb +3 -3
- data/lib/purecloud/api/workforce_management_api.rb +20 -139
- data/lib/purecloud/api_client.rb +1 -1
- data/lib/purecloud/models/agent_activity_entity_listing.rb +23 -23
- data/lib/purecloud/models/aggregate_view_data.rb +175 -0
- data/lib/purecloud/models/aggregation_query.rb +17 -4
- data/lib/purecloud/models/analytics_view.rb +208 -0
- data/lib/purecloud/models/{entry_feature_boolean.rb → answer_option.rb} +23 -22
- data/lib/purecloud/models/attempt_limits_entity_listing.rb +23 -23
- data/lib/purecloud/models/attempt_limits_notification_recall_entries.rb +13 -13
- data/lib/purecloud/models/attribute_entity_listing.rb +23 -23
- data/lib/purecloud/models/available_topic.rb +22 -22
- data/lib/purecloud/models/calibration_entity_listing.rb +23 -23
- data/lib/purecloud/models/call_basic.rb +403 -0
- data/lib/purecloud/models/call_conversation_entity_listing.rb +23 -23
- data/lib/purecloud/models/call_conversation_notification_call_media_participant.rb +11 -1
- data/lib/purecloud/models/call_conversation_notification_error_info.rb +61 -61
- data/lib/purecloud/models/call_conversation_notification_fax_status.rb +39 -39
- data/lib/purecloud/models/call_conversation_notification_participants.rb +193 -183
- data/lib/purecloud/models/call_conversation_notification_wrapup.rb +217 -0
- data/lib/purecloud/models/call_media_participant.rb +12 -1
- data/lib/purecloud/models/callable_time_set_entity_listing.rb +23 -23
- data/lib/purecloud/models/callable_time_set_notification_callable_times.rb +14 -14
- data/lib/purecloud/models/callable_time_set_notification_time_slots.rb +14 -14
- data/lib/purecloud/models/callback_basic.rb +384 -0
- data/lib/purecloud/models/callback_conversation_entity_listing.rb +23 -23
- data/lib/purecloud/models/callback_conversation_notification_callback_media_participant.rb +11 -1
- data/lib/purecloud/models/callback_conversation_notification_error_info.rb +61 -61
- data/lib/purecloud/models/callback_conversation_notification_error_info_details.rb +23 -23
- data/lib/purecloud/models/callback_conversation_notification_participants.rb +185 -175
- data/lib/purecloud/models/callback_conversation_notification_wrapup.rb +217 -0
- data/lib/purecloud/models/callback_media_participant.rb +12 -1
- data/lib/purecloud/models/campaign_entity_listing.rb +23 -23
- data/lib/purecloud/models/campaign_interaction.rb +1 -1
- data/lib/purecloud/models/campaign_notification_contact_sort.rb +14 -14
- data/lib/purecloud/models/campaign_notification_errors.rb +13 -13
- data/lib/purecloud/models/campaign_notification_phone_columns.rb +13 -13
- data/lib/purecloud/models/campaign_rule_action.rb +1 -1
- data/lib/purecloud/models/campaign_rule_entity_listing.rb +23 -23
- data/lib/purecloud/models/campaign_rule_notification_campaign_rule_action_entities.rb +25 -25
- data/lib/purecloud/models/campaign_rule_notification_campaign_rule_actions.rb +11 -11
- data/lib/purecloud/models/campaign_rule_notification_campaign_rule_conditions.rb +11 -11
- data/lib/purecloud/models/campaign_rule_notification_campaign_rule_entities.rb +15 -15
- data/lib/purecloud/models/campaign_schedule_notification_intervals.rb +13 -13
- data/lib/purecloud/models/campaign_sequence_entity_listing.rb +23 -23
- data/lib/purecloud/models/campaign_stats.rb +26 -4
- data/lib/purecloud/models/certificate_authority_entity_listing.rb +23 -23
- data/lib/purecloud/models/channel.rb +14 -14
- data/lib/purecloud/models/channel_entity_listing.rb +4 -94
- data/lib/purecloud/models/chat_conversation_entity_listing.rb +23 -23
- data/lib/purecloud/models/chat_conversation_notification_chat_media_participant.rb +11 -1
- data/lib/purecloud/models/chat_conversation_notification_error_info.rb +61 -61
- data/lib/purecloud/models/chat_conversation_notification_participants.rb +144 -134
- data/lib/purecloud/models/chat_conversation_notification_wrapup.rb +217 -0
- data/lib/purecloud/models/chat_media_participant.rb +12 -1
- data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +23 -23
- data/lib/purecloud/models/cobrowse_conversation_notification_cobrowse_media_participant.rb +11 -1
- data/lib/purecloud/models/cobrowse_conversation_notification_error_info.rb +61 -61
- data/lib/purecloud/models/cobrowse_conversation_notification_participants.rb +168 -158
- data/lib/purecloud/models/cobrowse_conversation_notification_wrapup.rb +217 -0
- data/lib/purecloud/models/cobrowse_media_participant.rb +12 -1
- data/lib/purecloud/models/command_status_entity_listing.rb +23 -23
- data/lib/purecloud/models/contact_list.rb +12 -1
- data/lib/purecloud/models/contact_list_entity_listing.rb +23 -23
- data/lib/purecloud/models/contact_list_notification_import_status.rb +27 -27
- data/lib/purecloud/models/contact_list_notification_phone_columns.rb +14 -14
- data/lib/purecloud/models/{edge_metrics_network.rb → conversation_basic.rb} +48 -37
- data/lib/purecloud/models/conversation_entity_listing.rb +23 -23
- data/lib/purecloud/models/conversation_notification_callbacks.rb +95 -95
- data/lib/purecloud/models/conversation_notification_calls.rb +117 -117
- data/lib/purecloud/models/conversation_notification_chats.rb +46 -46
- data/lib/purecloud/models/conversation_notification_cobrowsesessions.rb +71 -71
- data/lib/purecloud/models/conversation_notification_dialer_preview.rb +25 -25
- data/lib/purecloud/models/conversation_notification_disconnect_reasons.rb +11 -11
- data/lib/purecloud/models/conversation_notification_emails.rb +59 -59
- data/lib/purecloud/models/conversation_notification_error_info.rb +35 -35
- data/lib/purecloud/models/conversation_notification_fax_status.rb +39 -39
- data/lib/purecloud/models/conversation_notification_participants.rb +154 -154
- data/lib/purecloud/models/conversation_notification_screenshares.rb +55 -55
- data/lib/purecloud/models/conversation_notification_self.rb +27 -27
- data/lib/purecloud/models/conversation_notification_social_expressions.rb +57 -57
- data/lib/purecloud/models/conversation_notification_videos.rb +61 -61
- data/lib/purecloud/models/conversation_notification_wrapup.rb +35 -35
- data/lib/purecloud/models/create_email_request.rb +24 -4
- data/lib/purecloud/models/did_entity_listing.rb +23 -23
- data/lib/purecloud/models/did_pool_entity_listing.rb +23 -23
- data/lib/purecloud/models/dnc_list_create.rb +298 -0
- data/lib/purecloud/models/dnc_list_entity_listing.rb +23 -23
- data/lib/purecloud/models/document_audit_entity_listing.rb +23 -23
- data/lib/purecloud/models/document_data_v2_notification_created_by.rb +13 -13
- data/lib/purecloud/models/document_data_v2_notification_lock_info.rb +11 -11
- data/lib/purecloud/models/document_entity_listing.rb +23 -23
- data/lib/purecloud/models/documentation_result.rb +395 -0
- data/lib/purecloud/models/{forecast_search_criteria.rb → documentation_search_criteria.rb} +3 -3
- data/lib/purecloud/models/{forecast_search_request.rb → documentation_search_request.rb} +3 -42
- data/lib/purecloud/models/{decisions_file_metadata_entity_listing.rb → documentation_search_response.rb} +61 -60
- data/lib/purecloud/models/domain_edge_software_update_dto.rb +11 -1
- data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +23 -23
- data/lib/purecloud/models/domain_entity_listing.rb +23 -23
- data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +23 -23
- data/lib/purecloud/models/domain_entity_listing_query_result.rb +23 -23
- 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 +23 -23
- data/lib/purecloud/models/edge_group_entity_listing.rb +23 -23
- data/lib/purecloud/models/edge_line_entity_listing.rb +23 -23
- data/lib/purecloud/models/{edge_metrics_disk.rb → edge_service_state_request.rb} +16 -27
- data/lib/purecloud/models/edge_trunk_base.rb +332 -0
- data/lib/purecloud/models/email_conversation_entity_listing.rb +23 -23
- data/lib/purecloud/models/email_conversation_notification_email_media_participant.rb +11 -1
- data/lib/purecloud/models/email_conversation_notification_error_info.rb +61 -61
- data/lib/purecloud/models/email_conversation_notification_participants.rb +147 -137
- data/lib/purecloud/models/email_conversation_notification_wrapup.rb +217 -0
- data/lib/purecloud/models/email_media_participant.rb +12 -1
- data/lib/purecloud/models/email_message_listing.rb +23 -23
- data/lib/purecloud/models/encryption_key_entity_listing.rb +23 -23
- data/lib/purecloud/models/endpoint_entity_listing.rb +23 -23
- data/lib/purecloud/models/entry.rb +10 -8
- data/lib/purecloud/models/evaluation_entity_listing.rb +23 -23
- data/lib/purecloud/models/evaluation_form_entity_listing.rb +23 -23
- data/lib/purecloud/models/evaluator_activity_entity_listing.rb +23 -23
- data/lib/purecloud/models/extension_entity_listing.rb +23 -23
- data/lib/purecloud/models/extension_pool_entity_listing.rb +23 -23
- data/lib/purecloud/models/fax_data_v2_notification_lock_info.rb +11 -11
- data/lib/purecloud/models/fax_document_entity_listing.rb +23 -23
- data/lib/purecloud/models/feature_state.rb +165 -0
- data/lib/purecloud/models/{decisions_download_metadata.rb → g_suite.rb} +32 -37
- data/lib/purecloud/models/geolocation.rb +13 -1
- data/lib/purecloud/models/greeting_listing.rb +23 -23
- data/lib/purecloud/models/group_entity_listing.rb +23 -23
- data/lib/purecloud/models/group_search_request.rb +1 -27
- data/lib/purecloud/models/heart_beat_alert_container.rb +23 -23
- data/lib/purecloud/models/heart_beat_alert_notification_notification_users.rb +13 -13
- data/lib/purecloud/models/heart_beat_rule_container.rb +23 -23
- data/lib/purecloud/models/inbound_domain_entity_listing.rb +23 -23
- data/lib/purecloud/models/inbound_route_entity_listing.rb +23 -23
- data/lib/purecloud/models/interaction_stats_alert_container.rb +23 -23
- data/lib/purecloud/models/interaction_stats_rule_container.rb +23 -23
- data/lib/purecloud/models/json_node.rb +34 -34
- data/lib/purecloud/models/keyword_set.rb +1 -11
- data/lib/purecloud/models/keyword_set_entity_listing.rb +23 -23
- data/lib/purecloud/models/language_entity_listing.rb +23 -23
- data/lib/purecloud/models/library_entity_listing.rb +23 -23
- data/lib/purecloud/models/line_base_entity_listing.rb +23 -23
- data/lib/purecloud/models/line_entity_listing.rb +23 -23
- data/lib/purecloud/models/local_encryption_configuration_listing.rb +13 -83
- data/lib/purecloud/models/location_search_request.rb +1 -27
- data/lib/purecloud/models/logical_interface_entity_listing.rb +23 -23
- data/lib/purecloud/models/o_auth_client_entity_listing.rb +23 -23
- data/lib/purecloud/models/o_auth_provider_entity_listing.rb +23 -23
- data/lib/purecloud/models/organization_features.rb +285 -0
- data/lib/purecloud/models/organization_presence_entity_listing.rb +23 -23
- data/lib/purecloud/models/organization_role_entity_listing.rb +23 -23
- data/lib/purecloud/models/orphan_recording_listing.rb +23 -23
- data/lib/purecloud/models/outbound_route_base_entity_listing.rb +23 -23
- data/lib/purecloud/models/outbound_route_entity_listing.rb +23 -23
- data/lib/purecloud/models/participant_basic.rb +571 -0
- data/lib/purecloud/models/permission_collection_entity_listing.rb +23 -23
- data/lib/purecloud/models/phone_base_entity_listing.rb +23 -23
- data/lib/purecloud/models/phone_entity_listing.rb +23 -23
- data/lib/purecloud/models/phone_meta_base_entity_listing.rb +23 -23
- data/lib/purecloud/models/physical_interface_entity_listing.rb +23 -23
- data/lib/purecloud/models/ping_identity.rb +237 -0
- data/lib/purecloud/models/policy_entity_listing.rb +23 -23
- data/lib/purecloud/models/prediction_results.rb +22 -2
- data/lib/purecloud/models/quality_audit.rb +11 -11
- data/lib/purecloud/models/quality_audit_page.rb +23 -23
- data/lib/purecloud/models/{billing_task_result_notification.rb → question.rb} +80 -66
- data/lib/purecloud/models/question_group.rb +1 -1
- data/lib/purecloud/models/queue_entity_listing.rb +23 -23
- data/lib/purecloud/models/queue_member.rb +1 -1
- data/lib/purecloud/models/queue_member_entity_listing.rb +23 -23
- data/lib/purecloud/models/recording_data_v2_notification_lock_info.rb +11 -11
- data/lib/purecloud/models/report_meta_data_entity_listing.rb +23 -23
- data/lib/purecloud/models/report_run_entry.rb +1 -1
- data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +23 -23
- data/lib/purecloud/models/report_schedule_entity_listing.rb +23 -23
- data/lib/purecloud/models/response.rb +14 -1
- data/lib/purecloud/models/response_entity_list.rb +23 -23
- data/lib/purecloud/models/response_entity_listing.rb +23 -23
- data/lib/purecloud/models/response_set_entity_listing.rb +23 -23
- data/lib/purecloud/models/response_set_notification_responses.rb +23 -23
- data/lib/purecloud/models/{forecast_creation_completion.rb → response_substitution.rb} +21 -29
- data/lib/purecloud/models/routing_status_alert_container.rb +23 -23
- data/lib/purecloud/models/routing_status_rule_container.rb +23 -23
- data/lib/purecloud/models/rule_set_entity_listing.rb +23 -23
- data/lib/purecloud/models/rule_set_notification_actions.rb +23 -23
- data/lib/purecloud/models/rule_set_notification_conditions.rb +35 -35
- data/lib/purecloud/models/rule_set_notification_rules.rb +37 -37
- data/lib/purecloud/models/schema_category_entity_listing.rb +23 -23
- data/lib/purecloud/models/schema_reference_entity_listing.rb +23 -23
- data/lib/purecloud/models/screen_recording_session_listing.rb +23 -23
- data/lib/purecloud/models/screen_share_conversation_notification_error_info.rb +61 -61
- data/lib/purecloud/models/screen_share_conversation_notification_participants.rb +159 -149
- data/lib/purecloud/models/screen_share_conversation_notification_screen_share_media_participant.rb +11 -1
- data/lib/purecloud/models/screen_share_conversation_notification_wrapup.rb +217 -0
- data/lib/purecloud/models/script_entity_listing.rb +23 -23
- data/lib/purecloud/models/search_request.rb +1 -1
- data/lib/purecloud/models/security_profile_entity_listing.rb +23 -23
- data/lib/purecloud/models/share_entity_listing.rb +23 -23
- data/lib/purecloud/models/site_entity_listing.rb +23 -23
- data/lib/purecloud/models/skill_entity_listing.rb +23 -23
- data/lib/purecloud/models/social_conversation_notification_error_info.rb +61 -61
- data/lib/purecloud/models/social_conversation_notification_participants.rb +158 -148
- data/lib/purecloud/models/social_conversation_notification_social_media_participant.rb +11 -1
- data/lib/purecloud/models/social_conversation_notification_wrapup.rb +217 -0
- data/lib/purecloud/models/station_entity_listing.rb +23 -23
- data/lib/purecloud/models/statistical_response.rb +16 -4
- data/lib/purecloud/models/tag_value_entity_listing.rb +23 -23
- data/lib/purecloud/models/time_off_request_update_notification.rb +328 -0
- data/lib/purecloud/models/{decisions_download_link.rb → time_off_request_update_notification_user.rb} +5 -17
- data/lib/purecloud/models/time_zone_entity_listing.rb +23 -23
- data/lib/purecloud/models/transfer_request.rb +1 -1
- data/lib/purecloud/models/trunk.rb +12 -1
- data/lib/purecloud/models/trunk_base.rb +1 -1
- data/lib/purecloud/models/trunk_base_entity_listing.rb +23 -23
- data/lib/purecloud/models/trunk_entity_listing.rb +23 -23
- data/lib/purecloud/models/trunk_metabase_entity_listing.rb +23 -23
- data/lib/purecloud/models/trunk_metrics.rb +206 -0
- data/lib/purecloud/models/trunk_metrics_calls.rb +175 -0
- data/lib/purecloud/models/trunk_metrics_qo_s.rb +166 -0
- data/lib/purecloud/models/user.rb +14 -1
- data/lib/purecloud/models/user_conversation_summary_notification_call_contact_center.rb +13 -13
- data/lib/purecloud/models/user_entity_listing.rb +23 -23
- data/lib/purecloud/models/user_me.rb +14 -1
- data/lib/purecloud/models/user_presence_alert_container.rb +23 -23
- data/lib/purecloud/models/user_presence_notification_presence_definition.rb +13 -13
- data/lib/purecloud/models/user_presence_rule_container.rb +23 -23
- data/lib/purecloud/models/user_queue_entity_listing.rb +23 -23
- data/lib/purecloud/models/user_recording_entity_listing.rb +23 -23
- data/lib/purecloud/models/{forecast_creation.rb → user_schedule_adherence_update_notification.rb} +81 -49
- data/lib/purecloud/models/user_schedule_adherence_update_notification_user.rb +165 -0
- data/lib/purecloud/models/user_search_request.rb +1 -14
- data/lib/purecloud/models/user_skill_entity_listing.rb +23 -23
- data/lib/purecloud/models/user_stations_notification.rb +165 -0
- data/lib/purecloud/models/{edge_metrics_memory.rb → user_stations_notification_associated_station.rb} +20 -23
- data/lib/purecloud/models/user_stations_notification_user.rb +165 -0
- data/lib/purecloud/models/{edge_metrics_subsystem.rb → user_stations_notification_user_station.rb} +20 -23
- data/lib/purecloud/models/video_conversation_notification_error_info.rb +61 -61
- data/lib/purecloud/models/video_conversation_notification_participants.rb +161 -151
- data/lib/purecloud/models/video_conversation_notification_video_media_participant.rb +11 -1
- data/lib/purecloud/models/video_conversation_notification_wrapup.rb +217 -0
- data/lib/purecloud/models/voicemail_message_entity_listing.rb +23 -23
- data/lib/purecloud/models/voicemail_search_request.rb +1 -14
- data/lib/purecloud/models/workspace_entity_listing.rb +23 -23
- data/lib/purecloud/models/workspace_member_entity_listing.rb +23 -23
- data/lib/purecloud/models/wrap_up_code_mapping_notification.rb +27 -46
- data/lib/purecloud/models/wrapup_code_entity_listing.rb +23 -23
- data/lib/purecloud/version.rb +1 -1
- data/newVersion.md +1 -1
- data/swagger.json +1 -1
- data/version.json +1 -1
- metadata +80 -32
- data/doc_out/BillingTaskResultNotification.html.md +0 -21
- data/doc_out/DecisionsDownloadLink.html.md +0 -14
- data/doc_out/DecisionsDownloadMetadata.html.md +0 -20
- data/doc_out/DecisionsFileMetadataEntityListing.html.md +0 -22
- data/doc_out/EdgeMetrics.html.md +0 -20
- data/doc_out/EdgeMetricsDisk.html.md +0 -15
- data/doc_out/EdgeMetricsMemory.html.md +0 -15
- data/doc_out/EdgeMetricsNetwork.html.md +0 -17
- data/doc_out/EdgeMetricsProcessor.html.md +0 -17
- data/doc_out/EdgeMetricsSubsystem.html.md +0 -15
- data/doc_out/ForecastCreation.html.md +0 -18
- data/doc_out/ForecastCreationCompletion.html.md +0 -15
- data/lib/purecloud/models/edge_metrics.rb +0 -246
- data/lib/purecloud/models/edge_metrics_processor.rb +0 -210
|
@@ -11,7 +11,7 @@ title: SearchRequest
|
|
|
11
11
|
| **sort_by** | **String** | The field in the resource that you want to sort the results by | [optional] |
|
|
12
12
|
| **page_size** | **Integer** | The number of results per page | [optional] |
|
|
13
13
|
| **page_number** | **Integer** | The page of resources you want to retrieve | [optional] |
|
|
14
|
-
| **return_fields** | **Array<String>** | A List of strings
|
|
14
|
+
| **return_fields** | **Array<String>** | A List of strings. Possible values are any field in the resource you are searching on. The other option is to use ALL_FIELDS, when this is provided all fields in the resource will be returned in the search results. | [optional] |
|
|
15
15
|
| **expand** | **Array<String>** | Provides more details about a specified resource | [optional] |
|
|
16
16
|
| **types** | **Array<String>** | Resource domain type to search | |
|
|
17
17
|
| **query** | [**Array<SearchCriteria>**](SearchCriteria.html) | The search criteria | [optional] |
|
|
@@ -11,11 +11,11 @@ title: SecurityProfileEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
|
17
|
+
| **previous_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: ShareEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
|
17
|
+
| **previous_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: SiteEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
|
17
|
+
| **previous_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: SkillEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -7,16 +7,16 @@ title: SocialConversationNotificationErrorInfo
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **message** | **String** | | [optional] |
|
|
11
|
-
| **context_id** | **String** | | [optional] |
|
|
12
|
-
| **errors** | [**Array<SocialConversationNotificationErrorBody>**](SocialConversationNotificationErrorBody.html) | | [optional] |
|
|
13
|
-
| **message_params** | **Hash<String, String>** | | [optional] |
|
|
14
|
-
| **details** | [**Array<CallbackConversationNotificationErrorInfoDetails>**](CallbackConversationNotificationErrorInfoDetails.html) | | [optional] |
|
|
15
|
-
| **status** | **Integer** | | [optional] |
|
|
16
10
|
| **message_with_params** | **String** | | [optional] |
|
|
17
|
-
| **entity_id** | **String** | | [optional] |
|
|
18
11
|
| **code** | **String** | | [optional] |
|
|
19
12
|
| **entity_name** | **String** | | [optional] |
|
|
13
|
+
| **entity_id** | **String** | | [optional] |
|
|
14
|
+
| **context_id** | **String** | | [optional] |
|
|
15
|
+
| **details** | [**Array<CallbackConversationNotificationErrorInfoDetails>**](CallbackConversationNotificationErrorInfoDetails.html) | | [optional] |
|
|
16
|
+
| **message_params** | **Hash<String, String>** | | [optional] |
|
|
17
|
+
| **message** | **String** | | [optional] |
|
|
18
|
+
| **errors** | [**Array<SocialConversationNotificationErrorBody>**](SocialConversationNotificationErrorBody.html) | | [optional] |
|
|
19
|
+
| **status** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
22
22
|
|
|
@@ -7,34 +7,35 @@ title: SocialConversationNotificationParticipants
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **queue** | [**SocialConversationNotificationUriReference**](SocialConversationNotificationUriReference.html) | | [optional] |
|
|
11
|
-
| **error_info** | [**SocialConversationNotificationErrorInfo**](SocialConversationNotificationErrorInfo.html) | | [optional] |
|
|
12
|
-
| **connected_time** | **DateTime** | | [optional] |
|
|
13
|
-
| **social_user_name** | **String** | | [optional] |
|
|
14
|
-
| **direction** | **String** | | [optional] |
|
|
15
10
|
| **wrapup_skipped** | **BOOLEAN** | | [optional] |
|
|
16
|
-
| **state** | **String** | | [optional] |
|
|
17
11
|
| **purpose** | **String** | | [optional] |
|
|
18
|
-
| **
|
|
19
|
-
| **
|
|
12
|
+
| **held** | **BOOLEAN** | | [optional] |
|
|
13
|
+
| **wrapup_timeout_ms** | **Integer** | | [optional] |
|
|
14
|
+
| **error_info** | [**SocialConversationNotificationErrorInfo**](SocialConversationNotificationErrorInfo.html) | | [optional] |
|
|
15
|
+
| **provider** | **String** | | [optional] |
|
|
16
|
+
| **wrapup_required** | **BOOLEAN** | | [optional] |
|
|
17
|
+
| **connected_time** | **DateTime** | | [optional] |
|
|
18
|
+
| **disconnect_type** | **String** | | [optional] |
|
|
19
|
+
| **social_media_id** | **String** | | [optional] |
|
|
20
20
|
| **start_time** | **DateTime** | | [optional] |
|
|
21
|
+
| **social_user_name** | **String** | | [optional] |
|
|
21
22
|
| **id** | **String** | | [optional] |
|
|
22
|
-
| **
|
|
23
|
-
| **name** | **String** | | [optional] |
|
|
24
|
-
| **wrapup_timeout_ms** | **Integer** | | [optional] |
|
|
25
|
-
| **external_organization** | [**SocialConversationNotificationUriReference**](SocialConversationNotificationUriReference.html) | | [optional] |
|
|
23
|
+
| **state** | **String** | | [optional] |
|
|
26
24
|
| **preview_text** | **String** | | [optional] |
|
|
27
|
-
| **
|
|
28
|
-
| **
|
|
29
|
-
| **
|
|
25
|
+
| **direction** | **String** | | [optional] |
|
|
26
|
+
| **wrapup** | [**ConversationNotificationWrapup**](ConversationNotificationWrapup.html) | | [optional] |
|
|
27
|
+
| **address** | **String** | | [optional] |
|
|
30
28
|
| **external_contact** | [**SocialConversationNotificationUriReference**](SocialConversationNotificationUriReference.html) | | [optional] |
|
|
31
|
-
| **
|
|
29
|
+
| **external_organization** | [**SocialConversationNotificationUriReference**](SocialConversationNotificationUriReference.html) | | [optional] |
|
|
32
30
|
| **script** | [**SocialConversationNotificationUriReference**](SocialConversationNotificationUriReference.html) | | [optional] |
|
|
33
|
-
| **
|
|
34
|
-
| **
|
|
35
|
-
| **
|
|
31
|
+
| **social_media_hub** | **String** | | [optional] |
|
|
32
|
+
| **name** | **String** | | [optional] |
|
|
33
|
+
| **wrapup_prompt** | **String** | | [optional] |
|
|
36
34
|
| **attributes** | **Hash<String, String>** | | [optional] |
|
|
35
|
+
| **end_time** | **DateTime** | | [optional] |
|
|
36
|
+
| **start_hold_time** | **DateTime** | | [optional] |
|
|
37
37
|
| **user** | [**DocumentDataV2NotificationCreatedBy**](DocumentDataV2NotificationCreatedBy.html) | | [optional] |
|
|
38
|
+
| **queue** | [**SocialConversationNotificationUriReference**](SocialConversationNotificationUriReference.html) | | [optional] |
|
|
38
39
|
{: class="table table-striped"}
|
|
39
40
|
|
|
40
41
|
|
|
@@ -31,6 +31,7 @@ title: SocialConversationNotificationSocialMediaParticipant
|
|
|
31
31
|
| **provider** | **String** | | [optional] |
|
|
32
32
|
| **external_contact** | [**SocialConversationNotificationUriReference**](SocialConversationNotificationUriReference.html) | | [optional] |
|
|
33
33
|
| **external_organization** | [**SocialConversationNotificationUriReference**](SocialConversationNotificationUriReference.html) | | [optional] |
|
|
34
|
+
| **wrapup** | [**ConversationNotificationWrapup**](ConversationNotificationWrapup.html) | | [optional] |
|
|
34
35
|
| **social_media_id** | **String** | | [optional] |
|
|
35
36
|
| **social_media_hub** | **String** | | [optional] |
|
|
36
37
|
| **social_user_name** | **String** | | [optional] |
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: SocialConversationNotificationWrapup
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::SocialConversationNotificationWrapup
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **code** | **String** | | [optional] |
|
|
11
|
+
| **notes** | **String** | | [optional] |
|
|
12
|
+
| **tags** | **Array<String>** | | [optional] |
|
|
13
|
+
| **duration_seconds** | **Integer** | | [optional] |
|
|
14
|
+
| **end_time** | **DateTime** | | [optional] |
|
|
15
|
+
| **additional_properties** | **Object** | | [optional] |
|
|
16
|
+
{: class="table table-striped"}
|
|
17
|
+
|
|
18
|
+
|
|
@@ -11,11 +11,11 @@ title: StationEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -9,6 +9,7 @@ title: StatisticalResponse
|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **interval** | **String** | | [optional] |
|
|
11
11
|
| **metrics** | [**Array<AggregateMetricData>**](AggregateMetricData.html) | | [optional] |
|
|
12
|
+
| **views** | [**Array<AggregateViewData>**](AggregateViewData.html) | | [optional] |
|
|
12
13
|
{: class="table table-striped"}
|
|
13
14
|
|
|
14
15
|
|
|
@@ -11,11 +11,11 @@ title: TagValueEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -36,7 +36,6 @@ Method | Description
|
|
|
36
36
|
[**get_providers_edges_edge_id_logicalinterfaces**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_logicalinterfaces) | Get edge logical interfaces.
|
|
37
37
|
[**get_providers_edges_edge_id_logicalinterfaces_interface_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_logicalinterfaces_interface_id) | Get an edge logical interface
|
|
38
38
|
[**get_providers_edges_edge_id_logs_jobs_job_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_logs_jobs_job_id) | Get an Edge logs job.
|
|
39
|
-
[**get_providers_edges_edge_id_metrics**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_metrics) | Get the edge metrics.
|
|
40
39
|
[**get_providers_edges_edge_id_physicalinterfaces**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_physicalinterfaces) | Retrieve a list of all configured physical interfaces from a specific edge.
|
|
41
40
|
[**get_providers_edges_edge_id_physicalinterfaces_interface_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_physicalinterfaces_interface_id) | Get edge physical interface.
|
|
42
41
|
[**get_providers_edges_edge_id_setuppackage**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_setuppackage) | Get the setup package for a locally deployed edge device. This is needed to complete the setup process for the virtual edge.
|
|
@@ -44,6 +43,7 @@ Method | Description
|
|
|
44
43
|
[**get_providers_edges_edge_id_softwareversions**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_softwareversions) | Gets all the available software versions for this edge.
|
|
45
44
|
[**get_providers_edges_edgegroups**](TelephonyProvidersEdgeApi.html#get_providers_edges_edgegroups) | Get the list of edge groups.
|
|
46
45
|
[**get_providers_edges_edgegroups_edgegroup_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_edgegroups_edgegroup_id) | Get edge group.
|
|
46
|
+
[**get_providers_edges_edgegroups_edgegroup_id_edgetrunkbases_edgetrunkbase_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_edgegroups_edgegroup_id_edgetrunkbases_edgetrunkbase_id) | Gets the edge trunk base associated with the edge group
|
|
47
47
|
[**get_providers_edges_edgeversionreport**](TelephonyProvidersEdgeApi.html#get_providers_edges_edgeversionreport) | Get the edge version report.
|
|
48
48
|
[**get_providers_edges_endpoints**](TelephonyProvidersEdgeApi.html#get_providers_edges_endpoints) | Get endpoints
|
|
49
49
|
[**get_providers_edges_endpoints_endpoint_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_endpoints_endpoint_id) | Get endpoint
|
|
@@ -56,7 +56,7 @@ Method | Description
|
|
|
56
56
|
[**get_providers_edges_lines**](TelephonyProvidersEdgeApi.html#get_providers_edges_lines) | Get a list of Lines
|
|
57
57
|
[**get_providers_edges_lines_line_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_lines_line_id) | Get a Line by ID
|
|
58
58
|
[**get_providers_edges_lines_template**](TelephonyProvidersEdgeApi.html#get_providers_edges_lines_template) | Get a Line instance template based on a Line Base Settings object. This object can then be modified and saved as a new Line instance
|
|
59
|
-
[**
|
|
59
|
+
[**get_providers_edges_logicalinterfaces**](TelephonyProvidersEdgeApi.html#get_providers_edges_logicalinterfaces) | Get edge logical interfaces.
|
|
60
60
|
[**get_providers_edges_outboundroutes**](TelephonyProvidersEdgeApi.html#get_providers_edges_outboundroutes) | Get outbound routes
|
|
61
61
|
[**get_providers_edges_outboundroutes_outboundroute_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_outboundroutes_outboundroute_id) | Get outbound route
|
|
62
62
|
[**get_providers_edges_phonebasesettings**](TelephonyProvidersEdgeApi.html#get_providers_edges_phonebasesettings) | Get a list of Phone Base Settings objects
|
|
@@ -79,7 +79,9 @@ Method | Description
|
|
|
79
79
|
[**get_providers_edges_trunkbasesettings_template**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunkbasesettings_template) | Get a Trunk Base Settings instance template from a given make and model. This object can then be modified and saved as a new Trunk Base Settings instance
|
|
80
80
|
[**get_providers_edges_trunkbasesettings_trunkbasesettings_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunkbasesettings_trunkbasesettings_id) | Get a Trunk Base Settings object by ID
|
|
81
81
|
[**get_providers_edges_trunks**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunks) | Get the list of available trunks.
|
|
82
|
+
[**get_providers_edges_trunks_metrics**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunks_metrics) | Get the metrics for a list of trunks.
|
|
82
83
|
[**get_providers_edges_trunks_trunk_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunks_trunk_id) | Get a Trunk by ID
|
|
84
|
+
[**get_providers_edges_trunks_trunk_id_metrics**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunks_trunk_id_metrics) | Get the trunk metrics.
|
|
83
85
|
[**get_providers_edges_trunkswithrecording**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunkswithrecording) | Get Counts of trunks that have recording disabled or enabled
|
|
84
86
|
[**get_schemas_edges_vnext**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext) | Lists available schema categories (Deprecated)
|
|
85
87
|
[**get_schemas_edges_vnext_schemacategory**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext_schemacategory) | List schemas of a specific category (Deprecated)
|
|
@@ -95,6 +97,7 @@ Method | Description
|
|
|
95
97
|
[**post_providers_edges_edge_id_logs_jobs_job_id_upload**](TelephonyProvidersEdgeApi.html#post_providers_edges_edge_id_logs_jobs_job_id_upload) | Request that the specified fileIds be uploaded from the Edge.
|
|
96
98
|
[**post_providers_edges_edge_id_reboot**](TelephonyProvidersEdgeApi.html#post_providers_edges_edge_id_reboot) | Reboot an Edge
|
|
97
99
|
[**post_providers_edges_edge_id_softwareupdate**](TelephonyProvidersEdgeApi.html#post_providers_edges_edge_id_softwareupdate) | Starts a software update for this edge.
|
|
100
|
+
[**post_providers_edges_edge_id_statuscode**](TelephonyProvidersEdgeApi.html#post_providers_edges_edge_id_statuscode) | Take an Edge in or out of service
|
|
98
101
|
[**post_providers_edges_edge_id_unpair**](TelephonyProvidersEdgeApi.html#post_providers_edges_edge_id_unpair) | Unpair an Edge
|
|
99
102
|
[**post_providers_edges_edgegroups**](TelephonyProvidersEdgeApi.html#post_providers_edges_edgegroups) | Create an edge group.
|
|
100
103
|
[**post_providers_edges_endpoints**](TelephonyProvidersEdgeApi.html#post_providers_edges_endpoints) | Create endpoint
|
|
@@ -116,6 +119,7 @@ Method | Description
|
|
|
116
119
|
[**put_providers_edges_edge_id_lines_line_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_edge_id_lines_line_id) | Update a line.
|
|
117
120
|
[**put_providers_edges_edge_id_logicalinterfaces_interface_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_edge_id_logicalinterfaces_interface_id) | Update an edge logical interface.
|
|
118
121
|
[**put_providers_edges_edgegroups_edgegroup_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_edgegroups_edgegroup_id) | Update an edge group.
|
|
122
|
+
[**put_providers_edges_edgegroups_edgegroup_id_edgetrunkbases_edgetrunkbase_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_edgegroups_edgegroup_id_edgetrunkbases_edgetrunkbase_id) | Update the edge trunk base associated with the edge group
|
|
119
123
|
[**put_providers_edges_endpoints_endpoint_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_endpoints_endpoint_id) | Update endpoint
|
|
120
124
|
[**put_providers_edges_extensionpools_extensionpool_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_extensionpools_extensionpool_id) | Update an extension pool by ID
|
|
121
125
|
[**put_providers_edges_extensions_extension_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_extensions_extension_id) | Update an extension by ID.
|
|
@@ -840,7 +844,7 @@ Name | Type | Description | Notes
|
|
|
840
844
|
|
|
841
845
|
<a name="delete_providers_edges_sites_site_id_outboundroutes_outboundroute_id"></a>
|
|
842
846
|
|
|
843
|
-
## -String** delete_providers_edges_sites_site_id_outboundroutes_outboundroute_id(outbound_route_id)
|
|
847
|
+
## -String** delete_providers_edges_sites_site_id_outboundroutes_outboundroute_id(site_id, outbound_route_id)
|
|
844
848
|
|
|
845
849
|
Delete Outbound Route
|
|
846
850
|
|
|
@@ -866,12 +870,14 @@ end
|
|
|
866
870
|
|
|
867
871
|
api_instance = PureCloud::TelephonyProvidersEdgeApi.new
|
|
868
872
|
|
|
873
|
+
site_id = "site_id_example" # String | Site ID
|
|
874
|
+
|
|
869
875
|
outbound_route_id = "outbound_route_id_example" # String | Outbound route ID
|
|
870
876
|
|
|
871
877
|
|
|
872
878
|
begin
|
|
873
879
|
#Delete Outbound Route
|
|
874
|
-
result = api_instance.delete_providers_edges_sites_site_id_outboundroutes_outboundroute_id(outbound_route_id)
|
|
880
|
+
result = api_instance.delete_providers_edges_sites_site_id_outboundroutes_outboundroute_id(site_id, outbound_route_id)
|
|
875
881
|
p result
|
|
876
882
|
rescue PureCloud::ApiError => e
|
|
877
883
|
puts "Exception when calling TelephonyProvidersEdgeApi->delete_providers_edges_sites_site_id_outboundroutes_outboundroute_id: #{e}"
|
|
@@ -882,6 +888,7 @@ end
|
|
|
882
888
|
|
|
883
889
|
Name | Type | Description | Notes
|
|
884
890
|
------------- | ------------- | ------------- | -------------
|
|
891
|
+
**site_id** | **String**| Site ID |
|
|
885
892
|
**outbound_route_id** | **String**| Outbound route ID |
|
|
886
893
|
{: class="table table-striped"}
|
|
887
894
|
|
|
@@ -1824,65 +1831,6 @@ Name | Type | Description | Notes
|
|
|
1824
1831
|
|
|
1825
1832
|
|
|
1826
1833
|
|
|
1827
|
-
<a name="get_providers_edges_edge_id_metrics"></a>
|
|
1828
|
-
|
|
1829
|
-
## -[**EdgeMetrics**](EdgeMetrics.html) get_providers_edges_edge_id_metrics(edge_id)
|
|
1830
|
-
|
|
1831
|
-
Get the edge metrics.
|
|
1832
|
-
|
|
1833
|
-
|
|
1834
|
-
|
|
1835
|
-
Wraps GET /api/v2/telephony/providers/edges/{edgeId}/metrics
|
|
1836
|
-
|
|
1837
|
-
|
|
1838
|
-
### Example
|
|
1839
|
-
~~~ruby
|
|
1840
|
-
# load the gem
|
|
1841
|
-
require 'purecloud'
|
|
1842
|
-
# setup authorization
|
|
1843
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
1844
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1845
|
-
environment = "mypurecloud.com"
|
|
1846
|
-
|
|
1847
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1848
|
-
|
|
1849
|
-
PureCloud.configure do |config|
|
|
1850
|
-
config.access_token = @authToken
|
|
1851
|
-
end
|
|
1852
|
-
|
|
1853
|
-
api_instance = PureCloud::TelephonyProvidersEdgeApi.new
|
|
1854
|
-
|
|
1855
|
-
edge_id = "edge_id_example" # String | Edge Id
|
|
1856
|
-
|
|
1857
|
-
|
|
1858
|
-
begin
|
|
1859
|
-
#Get the edge metrics.
|
|
1860
|
-
result = api_instance.get_providers_edges_edge_id_metrics(edge_id)
|
|
1861
|
-
p result
|
|
1862
|
-
rescue PureCloud::ApiError => e
|
|
1863
|
-
puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_edge_id_metrics: #{e}"
|
|
1864
|
-
end
|
|
1865
|
-
~~~
|
|
1866
|
-
|
|
1867
|
-
### Parameters
|
|
1868
|
-
|
|
1869
|
-
Name | Type | Description | Notes
|
|
1870
|
-
------------- | ------------- | ------------- | -------------
|
|
1871
|
-
**edge_id** | **String**| Edge Id |
|
|
1872
|
-
{: class="table table-striped"}
|
|
1873
|
-
|
|
1874
|
-
|
|
1875
|
-
### Return type
|
|
1876
|
-
|
|
1877
|
-
[**EdgeMetrics**](EdgeMetrics.html)
|
|
1878
|
-
|
|
1879
|
-
### HTTP request headers
|
|
1880
|
-
|
|
1881
|
-
- **Content-Type**: application/json
|
|
1882
|
-
- **Accept**: application/json
|
|
1883
|
-
|
|
1884
|
-
|
|
1885
|
-
|
|
1886
1834
|
<a name="get_providers_edges_edge_id_physicalinterfaces"></a>
|
|
1887
1835
|
|
|
1888
1836
|
## -[**PhysicalInterfaceEntityListing**](PhysicalInterfaceEntityListing.html) get_providers_edges_edge_id_physicalinterfaces(edge_id)
|
|
@@ -2312,6 +2260,68 @@ Name | Type | Description | Notes
|
|
|
2312
2260
|
|
|
2313
2261
|
|
|
2314
2262
|
|
|
2263
|
+
<a name="get_providers_edges_edgegroups_edgegroup_id_edgetrunkbases_edgetrunkbase_id"></a>
|
|
2264
|
+
|
|
2265
|
+
## -[**EdgeTrunkBase**](EdgeTrunkBase.html) get_providers_edges_edgegroups_edgegroup_id_edgetrunkbases_edgetrunkbase_id(edgegroup_id, edgetrunkbase_id)
|
|
2266
|
+
|
|
2267
|
+
Gets the edge trunk base associated with the edge group
|
|
2268
|
+
|
|
2269
|
+
|
|
2270
|
+
|
|
2271
|
+
Wraps GET /api/v2/telephony/providers/edges/edgegroups/{edgegroupId}/edgetrunkbases/{edgetrunkbaseId}
|
|
2272
|
+
|
|
2273
|
+
|
|
2274
|
+
### Example
|
|
2275
|
+
~~~ruby
|
|
2276
|
+
# load the gem
|
|
2277
|
+
require 'purecloud'
|
|
2278
|
+
# setup authorization
|
|
2279
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2280
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2281
|
+
environment = "mypurecloud.com"
|
|
2282
|
+
|
|
2283
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2284
|
+
|
|
2285
|
+
PureCloud.configure do |config|
|
|
2286
|
+
config.access_token = @authToken
|
|
2287
|
+
end
|
|
2288
|
+
|
|
2289
|
+
api_instance = PureCloud::TelephonyProvidersEdgeApi.new
|
|
2290
|
+
|
|
2291
|
+
edgegroup_id = "edgegroup_id_example" # String | Edge Group ID
|
|
2292
|
+
|
|
2293
|
+
edgetrunkbase_id = "edgetrunkbase_id_example" # String | Edge Trunk Base ID
|
|
2294
|
+
|
|
2295
|
+
|
|
2296
|
+
begin
|
|
2297
|
+
#Gets the edge trunk base associated with the edge group
|
|
2298
|
+
result = api_instance.get_providers_edges_edgegroups_edgegroup_id_edgetrunkbases_edgetrunkbase_id(edgegroup_id, edgetrunkbase_id)
|
|
2299
|
+
p result
|
|
2300
|
+
rescue PureCloud::ApiError => e
|
|
2301
|
+
puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_edgegroups_edgegroup_id_edgetrunkbases_edgetrunkbase_id: #{e}"
|
|
2302
|
+
end
|
|
2303
|
+
~~~
|
|
2304
|
+
|
|
2305
|
+
### Parameters
|
|
2306
|
+
|
|
2307
|
+
Name | Type | Description | Notes
|
|
2308
|
+
------------- | ------------- | ------------- | -------------
|
|
2309
|
+
**edgegroup_id** | **String**| Edge Group ID |
|
|
2310
|
+
**edgetrunkbase_id** | **String**| Edge Trunk Base ID |
|
|
2311
|
+
{: class="table table-striped"}
|
|
2312
|
+
|
|
2313
|
+
|
|
2314
|
+
### Return type
|
|
2315
|
+
|
|
2316
|
+
[**EdgeTrunkBase**](EdgeTrunkBase.html)
|
|
2317
|
+
|
|
2318
|
+
### HTTP request headers
|
|
2319
|
+
|
|
2320
|
+
- **Content-Type**: application/json
|
|
2321
|
+
- **Accept**: application/json
|
|
2322
|
+
|
|
2323
|
+
|
|
2324
|
+
|
|
2315
2325
|
<a name="get_providers_edges_edgeversionreport"></a>
|
|
2316
2326
|
|
|
2317
2327
|
## -[**EdgeVersionReport**](EdgeVersionReport.html) get_providers_edges_edgeversionreport
|
|
@@ -3053,15 +3063,15 @@ Name | Type | Description | Notes
|
|
|
3053
3063
|
|
|
3054
3064
|
|
|
3055
3065
|
|
|
3056
|
-
<a name="
|
|
3057
|
-
|
|
3058
|
-
## -[**Array<EdgeMetrics>**](EdgeMetrics.html) get_providers_edges_metrics(edge_ids)
|
|
3066
|
+
<a name="get_providers_edges_logicalinterfaces"></a>
|
|
3059
3067
|
|
|
3060
|
-
|
|
3068
|
+
## -[**LogicalInterfaceEntityListing**](LogicalInterfaceEntityListing.html) get_providers_edges_logicalinterfaces(edge_ids, opts)
|
|
3061
3069
|
|
|
3070
|
+
Get edge logical interfaces.
|
|
3062
3071
|
|
|
3072
|
+
Retrieve the configured logical interfaces for a list edges. Only 100 edges can be requested at a time.
|
|
3063
3073
|
|
|
3064
|
-
Wraps GET /api/v2/telephony/providers/edges/
|
|
3074
|
+
Wraps GET /api/v2/telephony/providers/edges/logicalinterfaces
|
|
3065
3075
|
|
|
3066
3076
|
|
|
3067
3077
|
### Example
|
|
@@ -3083,13 +3093,16 @@ api_instance = PureCloud::TelephonyProvidersEdgeApi.new
|
|
|
3083
3093
|
|
|
3084
3094
|
edge_ids = "edge_ids_example" # String | Comma separated list of Edge Id's
|
|
3085
3095
|
|
|
3096
|
+
opts = {
|
|
3097
|
+
expand: ["expand_example"] # Array<String> | Field to expand in the response
|
|
3098
|
+
}
|
|
3086
3099
|
|
|
3087
3100
|
begin
|
|
3088
|
-
#Get
|
|
3089
|
-
result = api_instance.
|
|
3101
|
+
#Get edge logical interfaces.
|
|
3102
|
+
result = api_instance.get_providers_edges_logicalinterfaces(edge_ids, opts)
|
|
3090
3103
|
p result
|
|
3091
3104
|
rescue PureCloud::ApiError => e
|
|
3092
|
-
puts "Exception when calling TelephonyProvidersEdgeApi->
|
|
3105
|
+
puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_logicalinterfaces: #{e}"
|
|
3093
3106
|
end
|
|
3094
3107
|
~~~
|
|
3095
3108
|
|
|
@@ -3098,12 +3111,13 @@ end
|
|
|
3098
3111
|
Name | Type | Description | Notes
|
|
3099
3112
|
------------- | ------------- | ------------- | -------------
|
|
3100
3113
|
**edge_ids** | **String**| Comma separated list of Edge Id's |
|
|
3114
|
+
**expand** | [**Array<String>**](String.html)| Field to expand in the response | [optional]
|
|
3101
3115
|
{: class="table table-striped"}
|
|
3102
3116
|
|
|
3103
3117
|
|
|
3104
3118
|
### Return type
|
|
3105
3119
|
|
|
3106
|
-
[**
|
|
3120
|
+
[**LogicalInterfaceEntityListing**](LogicalInterfaceEntityListing.html)
|
|
3107
3121
|
|
|
3108
3122
|
### HTTP request headers
|
|
3109
3123
|
|
|
@@ -3268,8 +3282,8 @@ end
|
|
|
3268
3282
|
api_instance = PureCloud::TelephonyProvidersEdgeApi.new
|
|
3269
3283
|
|
|
3270
3284
|
opts = {
|
|
3271
|
-
page_number: 1, # Integer | Page number
|
|
3272
3285
|
page_size: 25, # Integer | Page size
|
|
3286
|
+
page_number: 1, # Integer | Page number
|
|
3273
3287
|
sort_by: "name", # String | Value by which to sort
|
|
3274
3288
|
sort_order: "ASC", # String | Sort order
|
|
3275
3289
|
name: "name_example" # String | Name
|
|
@@ -3288,8 +3302,8 @@ end
|
|
|
3288
3302
|
|
|
3289
3303
|
Name | Type | Description | Notes
|
|
3290
3304
|
------------- | ------------- | ------------- | -------------
|
|
3291
|
-
**page_number** | **Integer**| Page number | [optional] [default to 1]
|
|
3292
3305
|
**page_size** | **Integer**| Page size | [optional] [default to 25]
|
|
3306
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1]
|
|
3293
3307
|
**sort_by** | **String**| Value by which to sort | [optional] [default to name]
|
|
3294
3308
|
**sort_order** | **String**| Sort order | [optional] [default to ASC]
|
|
3295
3309
|
**name** | **String**| Name | [optional]
|
|
@@ -4077,7 +4091,7 @@ Name | Type | Description | Notes
|
|
|
4077
4091
|
|
|
4078
4092
|
<a name="get_providers_edges_sites_site_id_outboundroutes_outboundroute_id"></a>
|
|
4079
4093
|
|
|
4080
|
-
## -[**OutboundRouteBase**](OutboundRouteBase.html) get_providers_edges_sites_site_id_outboundroutes_outboundroute_id(outbound_route_id, opts)
|
|
4094
|
+
## -[**OutboundRouteBase**](OutboundRouteBase.html) get_providers_edges_sites_site_id_outboundroutes_outboundroute_id(site_id, outbound_route_id, opts)
|
|
4081
4095
|
|
|
4082
4096
|
Get an outbound route
|
|
4083
4097
|
|
|
@@ -4103,6 +4117,8 @@ end
|
|
|
4103
4117
|
|
|
4104
4118
|
api_instance = PureCloud::TelephonyProvidersEdgeApi.new
|
|
4105
4119
|
|
|
4120
|
+
site_id = "site_id_example" # String | Site ID
|
|
4121
|
+
|
|
4106
4122
|
outbound_route_id = "outbound_route_id_example" # String | Outbound route ID
|
|
4107
4123
|
|
|
4108
4124
|
opts = {
|
|
@@ -4114,7 +4130,7 @@ opts = {
|
|
|
4114
4130
|
|
|
4115
4131
|
begin
|
|
4116
4132
|
#Get an outbound route
|
|
4117
|
-
result = api_instance.get_providers_edges_sites_site_id_outboundroutes_outboundroute_id(outbound_route_id, opts)
|
|
4133
|
+
result = api_instance.get_providers_edges_sites_site_id_outboundroutes_outboundroute_id(site_id, outbound_route_id, opts)
|
|
4118
4134
|
p result
|
|
4119
4135
|
rescue PureCloud::ApiError => e
|
|
4120
4136
|
puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_sites_site_id_outboundroutes_outboundroute_id: #{e}"
|
|
@@ -4125,6 +4141,7 @@ end
|
|
|
4125
4141
|
|
|
4126
4142
|
Name | Type | Description | Notes
|
|
4127
4143
|
------------- | ------------- | ------------- | -------------
|
|
4144
|
+
**site_id** | **String**| Site ID |
|
|
4128
4145
|
**outbound_route_id** | **String**| Outbound route ID |
|
|
4129
4146
|
**page_size** | **Integer**| Page size | [optional] [default to 25]
|
|
4130
4147
|
**page_number** | **Integer**| Page number | [optional] [default to 1]
|
|
@@ -4242,7 +4259,8 @@ opts = {
|
|
|
4242
4259
|
recording_enabled: true, # BOOLEAN | Filter trunks by recording enabled
|
|
4243
4260
|
ignore_hidden: true, # BOOLEAN | Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only.
|
|
4244
4261
|
managed: true, # BOOLEAN | Filter by managed
|
|
4245
|
-
expand: ["expand_example"] # Array<String> | Fields to expand in the response, comma-separated
|
|
4262
|
+
expand: ["expand_example"], # Array<String> | Fields to expand in the response, comma-separated
|
|
4263
|
+
name: "name_example" # String | Name of the TrunkBase to filter by
|
|
4246
4264
|
}
|
|
4247
4265
|
|
|
4248
4266
|
begin
|
|
@@ -4266,6 +4284,7 @@ Name | Type | Description | Notes
|
|
|
4266
4284
|
**ignore_hidden** | **BOOLEAN**| Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only. | [optional]
|
|
4267
4285
|
**managed** | **BOOLEAN**| Filter by managed | [optional]
|
|
4268
4286
|
**expand** | [**Array<String>**](String.html)| Fields to expand in the response, comma-separated | [optional]
|
|
4287
|
+
**name** | **String**| Name of the TrunkBase to filter by | [optional]
|
|
4269
4288
|
{: class="table table-striped"}
|
|
4270
4289
|
|
|
4271
4290
|
|
|
@@ -4538,6 +4557,65 @@ Name | Type | Description | Notes
|
|
|
4538
4557
|
|
|
4539
4558
|
|
|
4540
4559
|
|
|
4560
|
+
<a name="get_providers_edges_trunks_metrics"></a>
|
|
4561
|
+
|
|
4562
|
+
## -[**Array<TrunkMetrics>**](TrunkMetrics.html) get_providers_edges_trunks_metrics(trunk_ids)
|
|
4563
|
+
|
|
4564
|
+
Get the metrics for a list of trunks.
|
|
4565
|
+
|
|
4566
|
+
|
|
4567
|
+
|
|
4568
|
+
Wraps GET /api/v2/telephony/providers/edges/trunks/metrics
|
|
4569
|
+
|
|
4570
|
+
|
|
4571
|
+
### Example
|
|
4572
|
+
~~~ruby
|
|
4573
|
+
# load the gem
|
|
4574
|
+
require 'purecloud'
|
|
4575
|
+
# setup authorization
|
|
4576
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
4577
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
4578
|
+
environment = "mypurecloud.com"
|
|
4579
|
+
|
|
4580
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
4581
|
+
|
|
4582
|
+
PureCloud.configure do |config|
|
|
4583
|
+
config.access_token = @authToken
|
|
4584
|
+
end
|
|
4585
|
+
|
|
4586
|
+
api_instance = PureCloud::TelephonyProvidersEdgeApi.new
|
|
4587
|
+
|
|
4588
|
+
trunk_ids = "trunk_ids_example" # String | Comma separated list of Trunk Id's
|
|
4589
|
+
|
|
4590
|
+
|
|
4591
|
+
begin
|
|
4592
|
+
#Get the metrics for a list of trunks.
|
|
4593
|
+
result = api_instance.get_providers_edges_trunks_metrics(trunk_ids)
|
|
4594
|
+
p result
|
|
4595
|
+
rescue PureCloud::ApiError => e
|
|
4596
|
+
puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_trunks_metrics: #{e}"
|
|
4597
|
+
end
|
|
4598
|
+
~~~
|
|
4599
|
+
|
|
4600
|
+
### Parameters
|
|
4601
|
+
|
|
4602
|
+
Name | Type | Description | Notes
|
|
4603
|
+
------------- | ------------- | ------------- | -------------
|
|
4604
|
+
**trunk_ids** | **String**| Comma separated list of Trunk Id's |
|
|
4605
|
+
{: class="table table-striped"}
|
|
4606
|
+
|
|
4607
|
+
|
|
4608
|
+
### Return type
|
|
4609
|
+
|
|
4610
|
+
[**Array<TrunkMetrics>**](TrunkMetrics.html)
|
|
4611
|
+
|
|
4612
|
+
### HTTP request headers
|
|
4613
|
+
|
|
4614
|
+
- **Content-Type**: application/json
|
|
4615
|
+
- **Accept**: application/json
|
|
4616
|
+
|
|
4617
|
+
|
|
4618
|
+
|
|
4541
4619
|
<a name="get_providers_edges_trunks_trunk_id"></a>
|
|
4542
4620
|
|
|
4543
4621
|
## -[**Trunk**](Trunk.html) get_providers_edges_trunks_trunk_id(trunk_id)
|
|
@@ -4597,6 +4675,65 @@ Name | Type | Description | Notes
|
|
|
4597
4675
|
|
|
4598
4676
|
|
|
4599
4677
|
|
|
4678
|
+
<a name="get_providers_edges_trunks_trunk_id_metrics"></a>
|
|
4679
|
+
|
|
4680
|
+
## -[**TrunkMetrics**](TrunkMetrics.html) get_providers_edges_trunks_trunk_id_metrics(trunk_id)
|
|
4681
|
+
|
|
4682
|
+
Get the trunk metrics.
|
|
4683
|
+
|
|
4684
|
+
|
|
4685
|
+
|
|
4686
|
+
Wraps GET /api/v2/telephony/providers/edges/trunks/{trunkId}/metrics
|
|
4687
|
+
|
|
4688
|
+
|
|
4689
|
+
### Example
|
|
4690
|
+
~~~ruby
|
|
4691
|
+
# load the gem
|
|
4692
|
+
require 'purecloud'
|
|
4693
|
+
# setup authorization
|
|
4694
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
4695
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
4696
|
+
environment = "mypurecloud.com"
|
|
4697
|
+
|
|
4698
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
4699
|
+
|
|
4700
|
+
PureCloud.configure do |config|
|
|
4701
|
+
config.access_token = @authToken
|
|
4702
|
+
end
|
|
4703
|
+
|
|
4704
|
+
api_instance = PureCloud::TelephonyProvidersEdgeApi.new
|
|
4705
|
+
|
|
4706
|
+
trunk_id = "trunk_id_example" # String | Trunk Id
|
|
4707
|
+
|
|
4708
|
+
|
|
4709
|
+
begin
|
|
4710
|
+
#Get the trunk metrics.
|
|
4711
|
+
result = api_instance.get_providers_edges_trunks_trunk_id_metrics(trunk_id)
|
|
4712
|
+
p result
|
|
4713
|
+
rescue PureCloud::ApiError => e
|
|
4714
|
+
puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_trunks_trunk_id_metrics: #{e}"
|
|
4715
|
+
end
|
|
4716
|
+
~~~
|
|
4717
|
+
|
|
4718
|
+
### Parameters
|
|
4719
|
+
|
|
4720
|
+
Name | Type | Description | Notes
|
|
4721
|
+
------------- | ------------- | ------------- | -------------
|
|
4722
|
+
**trunk_id** | **String**| Trunk Id |
|
|
4723
|
+
{: class="table table-striped"}
|
|
4724
|
+
|
|
4725
|
+
|
|
4726
|
+
### Return type
|
|
4727
|
+
|
|
4728
|
+
[**TrunkMetrics**](TrunkMetrics.html)
|
|
4729
|
+
|
|
4730
|
+
### HTTP request headers
|
|
4731
|
+
|
|
4732
|
+
- **Content-Type**: application/json
|
|
4733
|
+
- **Accept**: application/json
|
|
4734
|
+
|
|
4735
|
+
|
|
4736
|
+
|
|
4600
4737
|
<a name="get_providers_edges_trunkswithrecording"></a>
|
|
4601
4738
|
|
|
4602
4739
|
## -[**TrunkRecordingEnabledCount**](TrunkRecordingEnabledCount.html) get_providers_edges_trunkswithrecording(opts)
|
|
@@ -5541,6 +5678,69 @@ Name | Type | Description | Notes
|
|
|
5541
5678
|
|
|
5542
5679
|
|
|
5543
5680
|
|
|
5681
|
+
<a name="post_providers_edges_edge_id_statuscode"></a>
|
|
5682
|
+
|
|
5683
|
+
## -String** post_providers_edges_edge_id_statuscode(edge_id, opts)
|
|
5684
|
+
|
|
5685
|
+
Take an Edge in or out of service
|
|
5686
|
+
|
|
5687
|
+
|
|
5688
|
+
|
|
5689
|
+
Wraps POST /api/v2/telephony/providers/edges/{edgeId}/statuscode
|
|
5690
|
+
|
|
5691
|
+
|
|
5692
|
+
### Example
|
|
5693
|
+
~~~ruby
|
|
5694
|
+
# load the gem
|
|
5695
|
+
require 'purecloud'
|
|
5696
|
+
# setup authorization
|
|
5697
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
5698
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
5699
|
+
environment = "mypurecloud.com"
|
|
5700
|
+
|
|
5701
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
5702
|
+
|
|
5703
|
+
PureCloud.configure do |config|
|
|
5704
|
+
config.access_token = @authToken
|
|
5705
|
+
end
|
|
5706
|
+
|
|
5707
|
+
api_instance = PureCloud::TelephonyProvidersEdgeApi.new
|
|
5708
|
+
|
|
5709
|
+
edge_id = "edge_id_example" # String | Edge ID
|
|
5710
|
+
|
|
5711
|
+
opts = {
|
|
5712
|
+
body: PureCloud::EdgeServiceStateRequest.new # EdgeServiceStateRequest | Edge Service State
|
|
5713
|
+
}
|
|
5714
|
+
|
|
5715
|
+
begin
|
|
5716
|
+
#Take an Edge in or out of service
|
|
5717
|
+
result = api_instance.post_providers_edges_edge_id_statuscode(edge_id, opts)
|
|
5718
|
+
p result
|
|
5719
|
+
rescue PureCloud::ApiError => e
|
|
5720
|
+
puts "Exception when calling TelephonyProvidersEdgeApi->post_providers_edges_edge_id_statuscode: #{e}"
|
|
5721
|
+
end
|
|
5722
|
+
~~~
|
|
5723
|
+
|
|
5724
|
+
### Parameters
|
|
5725
|
+
|
|
5726
|
+
Name | Type | Description | Notes
|
|
5727
|
+
------------- | ------------- | ------------- | -------------
|
|
5728
|
+
**edge_id** | **String**| Edge ID |
|
|
5729
|
+
**body** | [**EdgeServiceStateRequest**](EdgeServiceStateRequest.html)| Edge Service State | [optional]
|
|
5730
|
+
{: class="table table-striped"}
|
|
5731
|
+
|
|
5732
|
+
|
|
5733
|
+
### Return type
|
|
5734
|
+
|
|
5735
|
+
**String**
|
|
5736
|
+
|
|
5737
|
+
### HTTP request headers
|
|
5738
|
+
|
|
5739
|
+
- **Content-Type**: application/json
|
|
5740
|
+
- **Accept**: application/json
|
|
5741
|
+
|
|
5742
|
+
|
|
5743
|
+
|
|
5544
5744
|
<a name="post_providers_edges_edge_id_unpair"></a>
|
|
5545
5745
|
|
|
5546
5746
|
## -String** post_providers_edges_edge_id_unpair(edge_id)
|
|
@@ -6807,6 +7007,71 @@ Name | Type | Description | Notes
|
|
|
6807
7007
|
|
|
6808
7008
|
|
|
6809
7009
|
|
|
7010
|
+
<a name="put_providers_edges_edgegroups_edgegroup_id_edgetrunkbases_edgetrunkbase_id"></a>
|
|
7011
|
+
|
|
7012
|
+
## -[**EdgeTrunkBase**](EdgeTrunkBase.html) put_providers_edges_edgegroups_edgegroup_id_edgetrunkbases_edgetrunkbase_id(edgegroup_id, edgetrunkbase_id, body)
|
|
7013
|
+
|
|
7014
|
+
Update the edge trunk base associated with the edge group
|
|
7015
|
+
|
|
7016
|
+
|
|
7017
|
+
|
|
7018
|
+
Wraps PUT /api/v2/telephony/providers/edges/edgegroups/{edgegroupId}/edgetrunkbases/{edgetrunkbaseId}
|
|
7019
|
+
|
|
7020
|
+
|
|
7021
|
+
### Example
|
|
7022
|
+
~~~ruby
|
|
7023
|
+
# load the gem
|
|
7024
|
+
require 'purecloud'
|
|
7025
|
+
# setup authorization
|
|
7026
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
7027
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
7028
|
+
environment = "mypurecloud.com"
|
|
7029
|
+
|
|
7030
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
7031
|
+
|
|
7032
|
+
PureCloud.configure do |config|
|
|
7033
|
+
config.access_token = @authToken
|
|
7034
|
+
end
|
|
7035
|
+
|
|
7036
|
+
api_instance = PureCloud::TelephonyProvidersEdgeApi.new
|
|
7037
|
+
|
|
7038
|
+
edgegroup_id = "edgegroup_id_example" # String | Edge Group ID
|
|
7039
|
+
|
|
7040
|
+
edgetrunkbase_id = "edgetrunkbase_id_example" # String | Edge Trunk Base ID
|
|
7041
|
+
|
|
7042
|
+
body = PureCloud::EdgeTrunkBase.new # EdgeTrunkBase | EdgeTrunkBase
|
|
7043
|
+
|
|
7044
|
+
|
|
7045
|
+
begin
|
|
7046
|
+
#Update the edge trunk base associated with the edge group
|
|
7047
|
+
result = api_instance.put_providers_edges_edgegroups_edgegroup_id_edgetrunkbases_edgetrunkbase_id(edgegroup_id, edgetrunkbase_id, body)
|
|
7048
|
+
p result
|
|
7049
|
+
rescue PureCloud::ApiError => e
|
|
7050
|
+
puts "Exception when calling TelephonyProvidersEdgeApi->put_providers_edges_edgegroups_edgegroup_id_edgetrunkbases_edgetrunkbase_id: #{e}"
|
|
7051
|
+
end
|
|
7052
|
+
~~~
|
|
7053
|
+
|
|
7054
|
+
### Parameters
|
|
7055
|
+
|
|
7056
|
+
Name | Type | Description | Notes
|
|
7057
|
+
------------- | ------------- | ------------- | -------------
|
|
7058
|
+
**edgegroup_id** | **String**| Edge Group ID |
|
|
7059
|
+
**edgetrunkbase_id** | **String**| Edge Trunk Base ID |
|
|
7060
|
+
**body** | [**EdgeTrunkBase**](EdgeTrunkBase.html)| EdgeTrunkBase |
|
|
7061
|
+
{: class="table table-striped"}
|
|
7062
|
+
|
|
7063
|
+
|
|
7064
|
+
### Return type
|
|
7065
|
+
|
|
7066
|
+
[**EdgeTrunkBase**](EdgeTrunkBase.html)
|
|
7067
|
+
|
|
7068
|
+
### HTTP request headers
|
|
7069
|
+
|
|
7070
|
+
- **Content-Type**: application/json
|
|
7071
|
+
- **Accept**: application/json
|
|
7072
|
+
|
|
7073
|
+
|
|
7074
|
+
|
|
6810
7075
|
<a name="put_providers_edges_endpoints_endpoint_id"></a>
|
|
6811
7076
|
|
|
6812
7077
|
## -[**Endpoint**](Endpoint.html) put_providers_edges_endpoints_endpoint_id(endpoint_id, body)
|
|
@@ -7305,7 +7570,7 @@ Name | Type | Description | Notes
|
|
|
7305
7570
|
|
|
7306
7571
|
<a name="put_providers_edges_sites_site_id_outboundroutes_outboundroute_id"></a>
|
|
7307
7572
|
|
|
7308
|
-
## -[**OutboundRouteBase**](OutboundRouteBase.html) put_providers_edges_sites_site_id_outboundroutes_outboundroute_id(outbound_route_id, body)
|
|
7573
|
+
## -[**OutboundRouteBase**](OutboundRouteBase.html) put_providers_edges_sites_site_id_outboundroutes_outboundroute_id(site_id, outbound_route_id, body)
|
|
7309
7574
|
|
|
7310
7575
|
Update outbound route
|
|
7311
7576
|
|
|
@@ -7331,6 +7596,8 @@ end
|
|
|
7331
7596
|
|
|
7332
7597
|
api_instance = PureCloud::TelephonyProvidersEdgeApi.new
|
|
7333
7598
|
|
|
7599
|
+
site_id = "site_id_example" # String | Site ID
|
|
7600
|
+
|
|
7334
7601
|
outbound_route_id = "outbound_route_id_example" # String | Outbound route ID
|
|
7335
7602
|
|
|
7336
7603
|
body = PureCloud::OutboundRouteBase.new # OutboundRouteBase | OutboundRoute
|
|
@@ -7338,7 +7605,7 @@ body = PureCloud::OutboundRouteBase.new # OutboundRouteBase | OutboundRoute
|
|
|
7338
7605
|
|
|
7339
7606
|
begin
|
|
7340
7607
|
#Update outbound route
|
|
7341
|
-
result = api_instance.put_providers_edges_sites_site_id_outboundroutes_outboundroute_id(outbound_route_id, body)
|
|
7608
|
+
result = api_instance.put_providers_edges_sites_site_id_outboundroutes_outboundroute_id(site_id, outbound_route_id, body)
|
|
7342
7609
|
p result
|
|
7343
7610
|
rescue PureCloud::ApiError => e
|
|
7344
7611
|
puts "Exception when calling TelephonyProvidersEdgeApi->put_providers_edges_sites_site_id_outboundroutes_outboundroute_id: #{e}"
|
|
@@ -7349,6 +7616,7 @@ end
|
|
|
7349
7616
|
|
|
7350
7617
|
Name | Type | Description | Notes
|
|
7351
7618
|
------------- | ------------- | ------------- | -------------
|
|
7619
|
+
**site_id** | **String**| Site ID |
|
|
7352
7620
|
**outbound_route_id** | **String**| Outbound route ID |
|
|
7353
7621
|
**body** | [**OutboundRouteBase**](OutboundRouteBase.html)| OutboundRoute |
|
|
7354
7622
|
{: class="table table-striped"}
|