purecloud 0.35.1 → 0.36.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/Gemfile +0 -1
- data/Gemfile.lock +0 -2
- data/README.md +38 -51
- data/config-ruby.json +1 -1
- data/doc_out/Account.html.md +42 -0
- data/doc_out/AccountManager.html.md +16 -0
- data/doc_out/AccountOverview.html.md +20 -0
- data/doc_out/AccountStatus.html.md +21 -0
- data/doc_out/Actions.html.md +13 -0
- data/doc_out/AcwSettings.html.md +14 -0
- data/doc_out/Address.html.md +20 -0
- data/doc_out/AddressListing.html.md +22 -0
- data/doc_out/Agent.html.md +13 -0
- data/doc_out/AgentActivity.html.md +19 -0
- data/doc_out/AgentActivityEntityListing.html.md +22 -0
- data/doc_out/AgentEvaluatorActivity.html.md +19 -0
- data/doc_out/AggregateDataContainer.html.md +14 -0
- data/doc_out/AggregateMetricData.html.md +15 -0
- data/doc_out/AggregateQueryResponse.html.md +13 -0
- data/doc_out/AggregationQuery.html.md +18 -0
- data/doc_out/AggregationRange.html.md +14 -0
- data/doc_out/AggregationResult.html.md +17 -0
- data/doc_out/AggregationResultEntry.html.md +16 -0
- data/doc_out/AlertingApi.html.md +571 -0
- data/doc_out/AnalyticsApi.html.md +1233 -0
- data/doc_out/AnalyticsConversation.html.md +16 -0
- data/doc_out/AnalyticsConversationQueryResponse.html.md +14 -0
- data/doc_out/AnalyticsConversationSegment.html.md +34 -0
- data/doc_out/AnalyticsEvaluation.html.md +22 -0
- data/doc_out/AnalyticsParticipant.html.md +17 -0
- data/doc_out/AnalyticsProperty.html.md +15 -0
- data/doc_out/AnalyticsQueryAggregation.html.md +17 -0
- data/doc_out/AnalyticsQueryClause.html.md +14 -0
- data/doc_out/AnalyticsQueryFilter.html.md +15 -0
- data/doc_out/AnalyticsQueryPredicate.html.md +20 -0
- data/doc_out/AnalyticsSession.html.md +29 -0
- data/doc_out/Annotation.html.md +20 -0
- data/doc_out/App.html.md +14 -0
- data/doc_out/ArchiveRetention.html.md +14 -0
- data/doc_out/AssociatedDocument.html.md +14 -0
- data/doc_out/Attachment.html.md +17 -0
- data/doc_out/Attribute.html.md +21 -0
- data/doc_out/AttributeEntityListing.html.md +22 -0
- data/doc_out/AttributeFilterItem.html.md +15 -0
- data/doc_out/AttributeQueryRequest.html.md +15 -0
- data/doc_out/AttributesApi.html.md +362 -0
- data/doc_out/AuditChange.html.md +16 -0
- data/doc_out/AuditEntity.html.md +16 -0
- data/doc_out/AuditEntityReference.html.md +17 -0
- data/doc_out/AuditFacet.html.md +14 -0
- data/doc_out/AuditFilter.html.md +16 -0
- data/doc_out/AuditMessage.html.md +28 -0
- data/doc_out/AuditSearchResult.html.md +18 -0
- data/doc_out/AuditUser.html.md +15 -0
- data/doc_out/AuthorizationApi.html.md +1024 -0
- data/doc_out/AutomateQueue.html.md +19 -0
- data/doc_out/AutomateQueueMember.html.md +16 -0
- data/doc_out/AutomateQueueMemberEntityListing.html.md +22 -0
- data/doc_out/AvailableAdditionalService.html.md +22 -0
- data/doc_out/AvailableAdditionalServiceListing.html.md +22 -0
- data/doc_out/AvailableTopic.html.md +15 -0
- data/doc_out/AvailableTopicEntityListing.html.md +22 -0
- data/doc_out/BackendFlowAvailableActions.html.md +13 -0
- data/doc_out/BasicTransform.html.md +14 -0
- data/doc_out/BatchCommand.html.md +14 -0
- data/doc_out/BatchItem.html.md +15 -0
- data/doc_out/BatchItemBody.html.md +13 -0
- data/doc_out/BatchReply.html.md +13 -0
- data/doc_out/BatchReplyItem.html.md +15 -0
- data/doc_out/BillingAddress.html.md +20 -0
- data/doc_out/BillingPeriod.html.md +17 -0
- data/doc_out/Bullseye.html.md +13 -0
- data/doc_out/Calibration.html.md +28 -0
- data/doc_out/CalibrationAssignment.html.md +16 -0
- data/doc_out/CalibrationEntityListing.html.md +22 -0
- data/doc_out/Call.html.md +29 -0
- data/doc_out/CallCommand.html.md +13 -0
- data/doc_out/CallConversation.html.md +18 -0
- data/doc_out/CallConversationEntityListing.html.md +22 -0
- data/doc_out/CallForwarding.html.md +19 -0
- data/doc_out/CallMediaParticipant.html.md +43 -0
- data/doc_out/CallRecord.html.md +14 -0
- data/doc_out/CallableContactsDiagnostic.html.md +15 -0
- data/doc_out/CallableTime.html.md +14 -0
- data/doc_out/CallableTimeSet.html.md +19 -0
- data/doc_out/CallableTimeSetEntityListing.html.md +22 -0
- data/doc_out/Callback.html.md +27 -0
- data/doc_out/CallbackConversation.html.md +17 -0
- data/doc_out/CallbackConversationEntityListing.html.md +22 -0
- data/doc_out/CallbackMediaParticipant.html.md +38 -0
- data/doc_out/Campaign.html.md +38 -0
- data/doc_out/CampaignDiagnostics.html.md +15 -0
- data/doc_out/CampaignEntityListing.html.md +22 -0
- data/doc_out/CampaignProgress.html.md +17 -0
- data/doc_out/CampaignSchedule.html.md +21 -0
- data/doc_out/CampaignScheduleIntervals.html.md +14 -0
- data/doc_out/CampaignSequence.html.md +23 -0
- data/doc_out/CampaignSequenceEntityListing.html.md +22 -0
- data/doc_out/CampaignStats.html.md +16 -0
- data/doc_out/CampaignTimeSlot.html.md +15 -0
- data/doc_out/Carrier.html.md +20 -0
- data/doc_out/CarrierAddress.html.md +17 -0
- data/doc_out/CarrierEntityListing.html.md +22 -0
- data/doc_out/Certificate.html.md +13 -0
- data/doc_out/CertificateAuthorityEntityListing.html.md +22 -0
- data/doc_out/CertificateDetails.html.md +19 -0
- data/doc_out/Change.html.md +16 -0
- data/doc_out/Channel.html.md +14 -0
- data/doc_out/ChannelEntityListing.html.md +22 -0
- data/doc_out/ChannelTopic.html.md +14 -0
- data/doc_out/ChannelTopicEntityListing.html.md +22 -0
- data/doc_out/Charge.html.md +20 -0
- data/doc_out/Chat.html.md +13 -0
- data/doc_out/ChatConversation.html.md +17 -0
- data/doc_out/ChatConversationEntityListing.html.md +22 -0
- data/doc_out/ChatMediaParticipant.html.md +34 -0
- data/doc_out/ChatMessage.html.md +21 -0
- data/doc_out/ChatMessageUser.html.md +17 -0
- data/doc_out/ClientSpreadsheetTransform.html.md +19 -0
- data/doc_out/ClientTextTableTransform.html.md +20 -0
- data/doc_out/ColumnCollapse.html.md +14 -0
- data/doc_out/CommandStatus.html.md +20 -0
- data/doc_out/CommandStatusEntityListing.html.md +22 -0
- data/doc_out/CommonAuditRequest.html.md +19 -0
- data/doc_out/ComposerTemplate.html.md +22 -0
- data/doc_out/Condition.html.md +19 -0
- data/doc_out/ConfigurationApi.html.md +232 -0
- data/doc_out/ConnectRate.html.md +15 -0
- data/doc_out/ConsultTransfer.html.md +14 -0
- data/doc_out/ConsultTransferResponse.html.md +13 -0
- data/doc_out/ConsultTransferUpdate.html.md +13 -0
- data/doc_out/ConsumedResourcesEntityListing.html.md +22 -0
- data/doc_out/ConsumingResourcesEntityListing.html.md +22 -0
- data/doc_out/Contact.html.md +16 -0
- data/doc_out/ContactAddress.html.md +18 -0
- data/doc_out/ContactCallbackRequest.html.md +17 -0
- data/doc_out/ContactList.html.md +24 -0
- data/doc_out/ContactListEntityListing.html.md +22 -0
- data/doc_out/ContactListing.html.md +22 -0
- data/doc_out/ContactPhoneNumberColumn.html.md +15 -0
- data/doc_out/ContactSales.html.md +25 -0
- data/doc_out/ContactSalesResponse.html.md +16 -0
- data/doc_out/ContactSort.html.md +14 -0
- data/doc_out/ContentAttributeFilterItem.html.md +15 -0
- data/doc_out/ContentFacetFilterItem.html.md +16 -0
- data/doc_out/ContentFilterItem.html.md +16 -0
- data/doc_out/ContentManagementApi.html.md +2236 -0
- data/doc_out/ContentQueryRequest.html.md +19 -0
- data/doc_out/ContentSortItem.html.md +14 -0
- data/doc_out/Contract.html.md +18 -0
- data/doc_out/ContractJob.html.md +17 -0
- data/doc_out/Control.html.md +19 -0
- data/doc_out/ControlOptions.html.md +14 -0
- data/doc_out/Conversation.html.md +22 -0
- data/doc_out/ConversationChat.html.md +23 -0
- data/doc_out/ConversationEntityListing.html.md +22 -0
- data/doc_out/ConversationQuery.html.md +20 -0
- data/doc_out/ConversationsApi.html.md +3374 -0
- data/doc_out/CoverSheet.html.md +14 -0
- data/doc_out/CreateCallRequest.html.md +21 -0
- data/doc_out/CreateCallResponse.html.md +15 -0
- data/doc_out/CreateCallbackCommand.html.md +18 -0
- data/doc_out/CreateShareRequest.html.md +17 -0
- data/doc_out/CreateShareRequestMember.html.md +14 -0
- data/doc_out/CreateShareResponse.html.md +23 -0
- data/doc_out/CreateTemplateFromScriptRequestData.html.md +17 -0
- data/doc_out/CreateUser.html.md +19 -0
- data/doc_out/CsvSchema.html.md +19 -0
- data/doc_out/Currency.html.md +16 -0
- data/doc_out/CustomerAccount.html.md +21 -0
- data/doc_out/DID.html.md +28 -0
- data/doc_out/DIDEntityListing.html.md +22 -0
- data/doc_out/DIDPool.html.md +28 -0
- data/doc_out/DIDPoolEntityListing.html.md +22 -0
- data/doc_out/DataItem.html.md +15 -0
- data/doc_out/DataValueInfo.html.md +13 -0
- data/doc_out/DefaultGreetingList.html.md +22 -0
- data/doc_out/DeleteRetention.html.md +13 -0
- data/doc_out/DeletedResourceConsumerEntityListing.html.md +22 -0
- data/doc_out/DeltaDocument.html.md +19 -0
- data/doc_out/DeltaRequest.html.md +13 -0
- data/doc_out/DeltaResponse.html.md +15 -0
- data/doc_out/Dependency.html.md +18 -0
- data/doc_out/DependencyObject.html.md +20 -0
- data/doc_out/DependencyObjectEntityListing.html.md +22 -0
- data/doc_out/DependencyStatus.html.md +21 -0
- data/doc_out/DependencyType.html.md +16 -0
- data/doc_out/DependencyTypeEntityListing.html.md +22 -0
- data/doc_out/Destination.html.md +16 -0
- data/doc_out/Detail.html.md +16 -0
- data/doc_out/DiagnosticEmail.html.md +19 -0
- data/doc_out/DialerAction.html.md +16 -0
- data/doc_out/DialerAuditRequest.html.md +16 -0
- data/doc_out/DialerContact.html.md +20 -0
- data/doc_out/DialerPreview.html.md +17 -0
- data/doc_out/DialerRule.html.md +18 -0
- data/doc_out/DigitLength.html.md +14 -0
- data/doc_out/DisconnectReason.html.md +15 -0
- data/doc_out/Discount.html.md +20 -0
- data/doc_out/DncList.html.md +22 -0
- data/doc_out/DncListEntityListing.html.md +22 -0
- data/doc_out/Dns.html.md +15 -0
- data/doc_out/Document.html.md +43 -0
- data/doc_out/DocumentAttribute.html.md +14 -0
- data/doc_out/DocumentAudit.html.md +28 -0
- data/doc_out/DocumentAuditEntityListing.html.md +22 -0
- data/doc_out/DocumentEntityListing.html.md +22 -0
- data/doc_out/DocumentThumbnail.html.md +14 -0
- data/doc_out/DocumentUpdate.html.md +21 -0
- data/doc_out/DocumentUpload.html.md +16 -0
- data/doc_out/DomainBillingPeriodEntityListing.html.md +22 -0
- data/doc_out/DomainCapabilities.html.md +15 -0
- data/doc_out/DomainCertificateAuthority.html.md +28 -0
- data/doc_out/DomainEdgeSoftwareUpdateDto.html.md +21 -0
- data/doc_out/DomainEdgeSoftwareVersionDto.html.md +20 -0
- data/doc_out/DomainEntity.html.md +15 -0
- data/doc_out/DomainEntityListing.html.md +22 -0
- data/doc_out/DomainEntityListingEvaluationForm.html.md +22 -0
- data/doc_out/DomainEntityListingQueryResult.html.md +22 -0
- data/doc_out/DomainInvoiceEntityListing.html.md +22 -0
- data/doc_out/DomainLogicalInterface.html.md +49 -0
- data/doc_out/DomainNetworkAddress.html.md +16 -0
- data/doc_out/DomainNetworkCommandResponse.html.md +16 -0
- data/doc_out/DomainNetworkRoute.html.md +17 -0
- data/doc_out/DomainOrgRoleDifference.html.md +17 -0
- data/doc_out/DomainOrganizationProduct.html.md +13 -0
- data/doc_out/DomainOrganizationRole.html.md +22 -0
- data/doc_out/DomainPermission.html.md +17 -0
- data/doc_out/DomainPermissionCollection.html.md +17 -0
- data/doc_out/DomainPermissionPolicy.html.md +20 -0
- data/doc_out/DomainPhysicalCapabilities.html.md +14 -0
- data/doc_out/DomainPhysicalInterface.html.md +20 -0
- data/doc_out/DomainResourceConditionNode.html.md +17 -0
- data/doc_out/DomainResourceConditionValue.html.md +16 -0
- data/doc_out/DomainRole.html.md +14 -0
- data/doc_out/DomainSchemaReference.html.md +15 -0
- data/doc_out/DomainThirdPartyAccountEntityListing.html.md +22 -0
- data/doc_out/DomainThirdPartySubscriptionEntityListing.html.md +22 -0
- data/doc_out/DomainVoiceRateExtendedResponseItemEntityListing.html.md +22 -0
- data/doc_out/DomainVoiceRateInternationalResponseItemEntityListing.html.md +22 -0
- data/doc_out/DomainVoiceRateResponseItemEntityListing.html.md +22 -0
- data/doc_out/DownloadResponse.html.md +14 -0
- data/doc_out/DurationCondition.html.md +15 -0
- data/doc_out/Edge.html.md +47 -0
- data/doc_out/EdgeAutoUpdateConfig.html.md +16 -0
- data/doc_out/EdgeEntityListing.html.md +22 -0
- data/doc_out/EdgeGroup.html.md +28 -0
- data/doc_out/EdgeGroupEntityListing.html.md +22 -0
- data/doc_out/EdgeInterface.html.md +20 -0
- data/doc_out/EdgeLine.html.md +23 -0
- data/doc_out/EdgeLineEntityListing.html.md +22 -0
- data/doc_out/EdgeLogsJob.html.md +16 -0
- data/doc_out/EdgeLogsJobFile.html.md +21 -0
- data/doc_out/EdgeLogsJobRequest.html.md +15 -0
- data/doc_out/EdgeLogsJobResponse.html.md +15 -0
- data/doc_out/EdgeLogsJobUploadRequest.html.md +13 -0
- data/doc_out/EdgeVersionInformation.html.md +13 -0
- data/doc_out/EdgeVersionReport.html.md +14 -0
- data/doc_out/Email.html.md +25 -0
- data/doc_out/EmailAddress.html.md +14 -0
- data/doc_out/EmailAttachment.html.md +17 -0
- data/doc_out/EmailConversation.html.md +17 -0
- data/doc_out/EmailConversationEntityListing.html.md +22 -0
- data/doc_out/EmailMediaParticipant.html.md +35 -0
- data/doc_out/EmailMessage.html.md +24 -0
- data/doc_out/EmailMessageListing.html.md +22 -0
- data/doc_out/EmailSetup.html.md +13 -0
- data/doc_out/EmbeddedSignatureView.html.md +13 -0
- data/doc_out/EncryptionKey.html.md +18 -0
- data/doc_out/EncryptionKeyEntityListing.html.md +22 -0
- data/doc_out/Endpoint.html.md +30 -0
- data/doc_out/EndpointEntityListing.html.md +22 -0
- data/doc_out/Entity.html.md +16 -0
- data/doc_out/Entry.html.md +14 -0
- data/doc_out/ErrorBody.html.md +22 -0
- data/doc_out/ErrorDetails.html.md +20 -0
- data/doc_out/EstimatedWaitTimePredictions.html.md +13 -0
- data/doc_out/Evaluation.html.md +31 -0
- data/doc_out/EvaluationAssignment.html.md +14 -0
- data/doc_out/EvaluationEntityListing.html.md +22 -0
- data/doc_out/EvaluationForm.html.md +21 -0
- data/doc_out/EvaluationFormAndScoringSet.html.md +14 -0
- data/doc_out/EvaluationFormEntityListing.html.md +22 -0
- data/doc_out/EvaluationScoringSet.html.md +18 -0
- data/doc_out/EvaluatorActivity.html.md +22 -0
- data/doc_out/EvaluatorActivityEntityListing.html.md +22 -0
- data/doc_out/ExpansionCriterium.html.md +14 -0
- data/doc_out/ExpressionResponse.html.md +23 -0
- data/doc_out/Extension.html.md +28 -0
- data/doc_out/ExtensionEntityListing.html.md +22 -0
- data/doc_out/ExtensionPool.html.md +26 -0
- data/doc_out/ExtensionPoolEntityListing.html.md +22 -0
- data/doc_out/ExternalContact.html.md +30 -0
- data/doc_out/ExternalContactsApi.html.md +1594 -0
- data/doc_out/ExternalOrganization.html.md +28 -0
- data/doc_out/ExternalOrganizationListing.html.md +22 -0
- data/doc_out/FacetEntry.html.md +20 -0
- data/doc_out/FacetInfo.html.md +14 -0
- data/doc_out/FacetKeyAttribute.html.md +15 -0
- data/doc_out/FacetRequest.html.md +19 -0
- data/doc_out/FacetResult.html.md +17 -0
- data/doc_out/FacetResultItem.html.md +19 -0
- data/doc_out/FacetStatistics.html.md +19 -0
- data/doc_out/FacetTerm.html.md +18 -0
- data/doc_out/FailedObject.html.md +16 -0
- data/doc_out/FavoriteTemplateRequestData.html.md +13 -0
- data/doc_out/FaxApi.html.md +354 -0
- data/doc_out/FaxDocument.html.md +30 -0
- data/doc_out/FaxDocumentEntityListing.html.md +22 -0
- data/doc_out/FaxSendRequest.html.md +20 -0
- data/doc_out/FaxSendResponse.html.md +17 -0
- data/doc_out/FaxSummary.html.md +15 -0
- data/doc_out/FilterItem.html.md +17 -0
- data/doc_out/Flow.html.md +24 -0
- data/doc_out/FlowBody.html.md +14 -0
- data/doc_out/FlowBodyFormat.html.md +14 -0
- data/doc_out/FlowConfigId.html.md +16 -0
- data/doc_out/FlowConfigMetaData.html.md +23 -0
- data/doc_out/FlowConfigMetaDataEntityListing.html.md +22 -0
- data/doc_out/FlowDetails.html.md +24 -0
- data/doc_out/FlowDetailsSearchResult.html.md +14 -0
- data/doc_out/FlowEntityListing.html.md +22 -0
- data/doc_out/FlowExecId.html.md +15 -0
- data/doc_out/FlowHistoryItem.html.md +20 -0
- data/doc_out/FlowHistoryResultItem.html.md +15 -0
- data/doc_out/FlowHistoryResultItemEntityListing.html.md +22 -0
- data/doc_out/FlowInputData.html.md +13 -0
- data/doc_out/FlowLaunchRequest.html.md +16 -0
- data/doc_out/FlowPublish.html.md +17 -0
- data/doc_out/FlowReportResultItem.html.md +24 -0
- data/doc_out/FlowSearchRequest.html.md +19 -0
- data/doc_out/FlowState.html.md +15 -0
- data/doc_out/FlowTerminateRequest.html.md +13 -0
- data/doc_out/FlowUploadResponse.html.md +14 -0
- data/doc_out/FlowVersion.html.md +23 -0
- data/doc_out/FlowVersionConfigMetaData.html.md +20 -0
- data/doc_out/FlowVersionConfigMetaDataEntityListing.html.md +22 -0
- data/doc_out/FlowVersionEntityListing.html.md +22 -0
- data/doc_out/Form.html.md +13 -0
- data/doc_out/Gateway.html.md +15 -0
- data/doc_out/Geolocation.html.md +22 -0
- data/doc_out/GeolocationApi.html.md +245 -0
- data/doc_out/GeolocationSettings.html.md +16 -0
- data/doc_out/Gistener.html.md +25 -0
- data/doc_out/Greeting.html.md +24 -0
- data/doc_out/GreetingAudioFile.html.md +15 -0
- data/doc_out/GreetingMediaInfo.html.md +15 -0
- data/doc_out/GreetingOwner.html.md +15 -0
- data/doc_out/GreetingsApi.html.md +712 -0
- data/doc_out/Group.html.md +22 -0
- data/doc_out/GroupEntityListing.html.md +22 -0
- data/doc_out/GroupTag.html.md +19 -0
- data/doc_out/GroupsApi.html.md +314 -0
- data/doc_out/GroupsSearchResponse.html.md +21 -0
- data/doc_out/HIPAAConfig.html.md +16 -0
- data/doc_out/HardwareRate.html.md +18 -0
- data/doc_out/HardwareRateListing.html.md +22 -0
- data/doc_out/HealthCheckInfo.html.md +21 -0
- data/doc_out/IVR.html.md +31 -0
- data/doc_out/IVREntityListing.html.md +22 -0
- data/doc_out/ImportStatus.html.md +17 -0
- data/doc_out/InboundDomain.html.md +17 -0
- data/doc_out/InboundDomainEntityListing.html.md +22 -0
- data/doc_out/InboundRoute.html.md +22 -0
- data/doc_out/InboundRouteEntityListing.html.md +22 -0
- data/doc_out/IndexedTransform.html.md +16 -0
- data/doc_out/IntegrationType.html.md +18 -0
- data/doc_out/IntegrationTypeEntityListing.html.md +22 -0
- data/doc_out/InteractionStatsAlert.html.md +29 -0
- data/doc_out/InteractionStatsAlertContainer.html.md +22 -0
- data/doc_out/InteractionStatsRule.html.md +26 -0
- data/doc_out/InteractionStatsRuleContainer.html.md +22 -0
- data/doc_out/Invoice.html.md +21 -0
- data/doc_out/JsonNode.html.md +33 -0
- data/doc_out/JsonNodeSearchResponse.html.md +21 -0
- data/doc_out/KeyRotationSchedule.html.md +16 -0
- data/doc_out/Language.html.md +18 -0
- data/doc_out/LanguageEntityListing.html.md +22 -0
- data/doc_out/LanguagesApi.html.md +306 -0
- data/doc_out/Library.html.md +18 -0
- data/doc_out/LibraryEntityListing.html.md +22 -0
- data/doc_out/License.html.md +14 -0
- data/doc_out/LicensesByPermission.html.md +15 -0
- data/doc_out/Line.html.md +32 -0
- data/doc_out/LineBase.html.md +17 -0
- data/doc_out/LineBaseEntityListing.html.md +22 -0
- data/doc_out/LineEntityListing.html.md +22 -0
- data/doc_out/LineStatus.html.md +17 -0
- data/doc_out/LinkedEntityListingFlowDetails.html.md +22 -0
- data/doc_out/LinkedEntityListingWorkItemSearchDetails.html.md +22 -0
- data/doc_out/Location.html.md +24 -0
- data/doc_out/LocationAddressFields.html.md +19 -0
- data/doc_out/LocationEmergencyNumber.html.md +15 -0
- data/doc_out/LocationEntityListing.html.md +22 -0
- data/doc_out/LocationsApi.html.md +133 -0
- data/doc_out/LockInfo.html.md +16 -0
- data/doc_out/LogicalInterfaceEntityListing.html.md +22 -0
- data/doc_out/ManagementUnit.html.md +18 -0
- data/doc_out/ManagementUnitTimezone.html.md +13 -0
- data/doc_out/MaxParticipants.html.md +13 -0
- data/doc_out/MediaParticipantRequest.html.md +19 -0
- data/doc_out/MediaPolicies.html.md +15 -0
- data/doc_out/MediaPolicy.html.md +14 -0
- data/doc_out/MediaResult.html.md +14 -0
- data/doc_out/MediaSetting.html.md +14 -0
- data/doc_out/MediaSummary.html.md +14 -0
- data/doc_out/MediaSummaryDetail.html.md +14 -0
- data/doc_out/MemberEntity.html.md +13 -0
- data/doc_out/Metabase.html.md +16 -0
- data/doc_out/MeteredEvaluationAssignment.html.md +18 -0
- data/doc_out/NocSupport.html.md +14 -0
- data/doc_out/Note.html.md +18 -0
- data/doc_out/NoteListing.html.md +22 -0
- data/doc_out/NotificationsApi.html.md +408 -0
- data/doc_out/Number.html.md +14 -0
- data/doc_out/NumberOrderRequest.html.md +17 -0
- data/doc_out/NumberPlan.html.md +31 -0
- data/doc_out/NumericRange.html.md +16 -0
- data/doc_out/OAuthApi.html.md +1192 -0
- data/doc_out/OAuthClient.html.md +21 -0
- data/doc_out/OAuthClientEntityListing.html.md +22 -0
- data/doc_out/OAuthProvider.html.md +15 -0
- data/doc_out/OAuthProviderEntityListing.html.md +22 -0
- data/doc_out/ObservationDataContainer.html.md +14 -0
- data/doc_out/ObservationQuery.html.md +14 -0
- data/doc_out/ObservationQueryResponse.html.md +13 -0
- data/doc_out/Okta.html.md +18 -0
- data/doc_out/OneLogin.html.md +18 -0
- data/doc_out/Order.html.md +17 -0
- data/doc_out/OrgLicenseAssignment.html.md +16 -0
- data/doc_out/OrgMediaUtilization.html.md +14 -0
- data/doc_out/Organization.html.md +23 -0
- data/doc_out/OrganizationApi.html.md +172 -0
- data/doc_out/OrganizationCreate.html.md +18 -0
- data/doc_out/OrganizationPresence.html.md +22 -0
- data/doc_out/OrganizationPresenceEntityListing.html.md +22 -0
- data/doc_out/OrganizationProductEntityListing.html.md +17 -0
- data/doc_out/OrganizationRoleEntityListing.html.md +22 -0
- data/doc_out/OrphanRecording.html.md +23 -0
- data/doc_out/OrphanRecordingListing.html.md +22 -0
- data/doc_out/OutOfOffice.html.md +19 -0
- data/doc_out/OutboundApi.html.md +3780 -0
- data/doc_out/OutboundRoute.html.md +30 -0
- data/doc_out/OutboundRouteEntityListing.html.md +22 -0
- data/doc_out/PINConfiguration.html.md +14 -0
- data/doc_out/Page.html.md +20 -0
- data/doc_out/PagingSpec.html.md +14 -0
- data/doc_out/Parameter.html.md +16 -0
- data/doc_out/ParsedCertificate.html.md +13 -0
- data/doc_out/Participant.html.md +44 -0
- data/doc_out/ParticipantAttributes.html.md +13 -0
- data/doc_out/PaymentMethod.html.md +18 -0
- data/doc_out/PaymentMethodListing.html.md +22 -0
- data/doc_out/PaymentTokenProvider.html.md +16 -0
- data/doc_out/PermissionCollectionEntityListing.html.md +22 -0
- data/doc_out/Permissions.html.md +15 -0
- data/doc_out/Phone.html.md +34 -0
- data/doc_out/PhoneBase.html.md +19 -0
- data/doc_out/PhoneBaseEntityListing.html.md +22 -0
- data/doc_out/PhoneCapabilities.html.md +18 -0
- data/doc_out/PhoneColumn.html.md +14 -0
- data/doc_out/PhoneEntityListing.html.md +22 -0
- data/doc_out/PhoneMetaBaseEntityListing.html.md +22 -0
- data/doc_out/PhoneNumber.html.md +18 -0
- data/doc_out/PhoneNumberColumn.html.md +14 -0
- data/doc_out/PhoneNumberStatus.html.md +13 -0
- data/doc_out/PhoneStatus.html.md +21 -0
- data/doc_out/PhonesReboot.html.md +14 -0
- data/doc_out/PhysicalInterfaceEntityListing.html.md +22 -0
- data/doc_out/Policy.html.md +24 -0
- data/doc_out/PolicyActions.html.md +18 -0
- data/doc_out/PolicyConditions.html.md +20 -0
- data/doc_out/PolicyEntityListing.html.md +22 -0
- data/doc_out/PolicyErrorMessage.html.md +19 -0
- data/doc_out/PolicyErrors.html.md +13 -0
- data/doc_out/PredictionResults.html.md +14 -0
- data/doc_out/PresenceApi.html.md +427 -0
- data/doc_out/PresenceQueryResponse.html.md +14 -0
- data/doc_out/Product.html.md +17 -0
- data/doc_out/Prompt.html.md +17 -0
- data/doc_out/PromptAsset.html.md +24 -0
- data/doc_out/PromptAssetEntityListing.html.md +22 -0
- data/doc_out/PromptEntityListing.html.md +22 -0
- data/doc_out/PropertyIndexRequest.html.md +15 -0
- data/doc_out/ProvisionInfo.html.md +15 -0
- data/doc_out/Publication.html.md +20 -0
- data/doc_out/PublishScriptRequestData.html.md +14 -0
- data/doc_out/PublishedResult.html.md +18 -0
- data/doc_out/PureCloud.html.md +15 -0
- data/doc_out/QualityApi.html.md +1569 -0
- data/doc_out/QualityAudit.html.md +23 -0
- data/doc_out/QualityAuditPage.html.md +22 -0
- data/doc_out/QueryFacetInfo.html.md +14 -0
- data/doc_out/QueryRequest.html.md +19 -0
- data/doc_out/QueryResult.html.md +16 -0
- data/doc_out/QueryResults.html.md +14 -0
- data/doc_out/QuestionGroup.html.md +21 -0
- data/doc_out/QuestionGroupScore.html.md +23 -0
- data/doc_out/QuestionScore.html.md +18 -0
- data/doc_out/Queue.html.md +32 -0
- data/doc_out/QueueEntityListing.html.md +22 -0
- data/doc_out/QueueMember.html.md +20 -0
- data/doc_out/QueueUtilizationDiagnostic.html.md +20 -0
- data/doc_out/QueuesEntityListing.html.md +22 -0
- data/doc_out/Quote.html.md +32 -0
- data/doc_out/QuoteCharge.html.md +25 -0
- data/doc_out/QuoteListing.html.md +22 -0
- data/doc_out/Rate.html.md +17 -0
- data/doc_out/Reaction.html.md +15 -0
- data/doc_out/Recording.html.md +34 -0
- data/doc_out/RecordingApi.html.md +1243 -0
- data/doc_out/RecordingEmailMessage.html.md +22 -0
- data/doc_out/RecordingSettings.html.md +13 -0
- data/doc_out/Relationship.html.md +18 -0
- data/doc_out/RelationshipListing.html.md +22 -0
- data/doc_out/ReplaceRequest.html.md +15 -0
- data/doc_out/ReplaceResponse.html.md +18 -0
- data/doc_out/ReportMetaData.html.md +21 -0
- data/doc_out/ReportMetaDataEntityListing.html.md +22 -0
- data/doc_out/ReportRequest.html.md +18 -0
- data/doc_out/ReportRunEntry.html.md +23 -0
- data/doc_out/ReportRunEntryEntityDomainListing.html.md +22 -0
- data/doc_out/ReportSchedule.html.md +29 -0
- data/doc_out/ReportScheduleEntityListing.html.md +22 -0
- data/doc_out/Reservation.html.md +16 -0
- data/doc_out/ResourceConditionNode.html.md +17 -0
- data/doc_out/ResourceConditionValue.html.md +14 -0
- data/doc_out/ResourcePermissionPolicy.html.md +22 -0
- data/doc_out/Response.html.md +20 -0
- data/doc_out/ResponseEntityList.html.md +22 -0
- data/doc_out/ResponseEntityListing.html.md +22 -0
- data/doc_out/ResponseFilter.html.md +15 -0
- data/doc_out/ResponseManagementApi.html.md +657 -0
- data/doc_out/ResponseQueryRequest.html.md +15 -0
- data/doc_out/ResponseQueryResults.html.md +13 -0
- data/doc_out/ResponseSet.html.md +19 -0
- data/doc_out/ResponseSetEntityListing.html.md +22 -0
- data/doc_out/ResponseText.html.md +14 -0
- data/doc_out/RestErrorDetail.html.md +14 -0
- data/doc_out/RetentionDuration.html.md +14 -0
- data/doc_out/Ring.html.md +14 -0
- data/doc_out/RoutingApi.html.md +2388 -0
- data/doc_out/RoutingSkill.html.md +19 -0
- data/doc_out/RoutingStatus.html.md +15 -0
- data/doc_out/RuleSet.html.md +21 -0
- data/doc_out/RuleSetEntityListing.html.md +22 -0
- data/doc_out/RunNowResponse.html.md +15 -0
- data/doc_out/Salesforce.html.md +18 -0
- data/doc_out/Schedule.html.md +28 -0
- data/doc_out/ScheduleEntityListing.html.md +22 -0
- data/doc_out/ScheduleGroup.html.md +27 -0
- data/doc_out/ScheduleGroupEntityListing.html.md +22 -0
- data/doc_out/SchemaCategory.html.md +15 -0
- data/doc_out/SchemaCategoryEntityListing.html.md +22 -0
- data/doc_out/SchemaReferenceEntityListing.html.md +22 -0
- data/doc_out/Script.html.md +25 -0
- data/doc_out/ScriptEntityListing.html.md +22 -0
- data/doc_out/SearchAggregation.html.md +15 -0
- data/doc_out/SearchApi.html.md +366 -0
- data/doc_out/SearchCriteria.html.md +20 -0
- data/doc_out/SearchRequest.html.md +21 -0
- data/doc_out/SecurityProfile.html.md +16 -0
- data/doc_out/SecurityProfileEntityListing.html.md +22 -0
- data/doc_out/Segment.html.md +17 -0
- data/doc_out/SequenceSchedule.html.md +21 -0
- data/doc_out/ServerDate.html.md +13 -0
- data/doc_out/Service.html.md +22 -0
- data/doc_out/ServiceContext.html.md +13 -0
- data/doc_out/ServiceEntityListing.html.md +22 -0
- data/doc_out/ServiceLevel.html.md +14 -0
- data/doc_out/ServiceType.html.md +19 -0
- data/doc_out/Share.html.md +22 -0
- data/doc_out/ShareEntityListing.html.md +22 -0
- data/doc_out/SharedEntity.html.md +13 -0
- data/doc_out/SharedResponse.html.md +17 -0
- data/doc_out/SheetSchema.html.md +18 -0
- data/doc_out/SheetTransform.html.md +15 -0
- data/doc_out/SignatureDocumentInfo.html.md +15 -0
- data/doc_out/Site.html.md +33 -0
- data/doc_out/SiteEntityListing.html.md +22 -0
- data/doc_out/SkillEntityListing.html.md +22 -0
- data/doc_out/SkillsToRemove.html.md +15 -0
- data/doc_out/Snapshot.html.md +15 -0
- data/doc_out/SocialAccount.html.md +24 -0
- data/doc_out/SocialConversation.html.md +17 -0
- data/doc_out/SocialConversationEntityListing.html.md +22 -0
- data/doc_out/SocialExpression.html.md +25 -0
- data/doc_out/SocialMediaParticipant.html.md +37 -0
- data/doc_out/SocializeEntityFilter.html.md +15 -0
- data/doc_out/SocializeFilterRequest.html.md +17 -0
- data/doc_out/SortBy.html.md +14 -0
- data/doc_out/SortField.html.md +14 -0
- data/doc_out/SortItem.html.md +14 -0
- data/doc_out/SpreadsheetTransform.html.md +21 -0
- data/doc_out/SpreadsheetTransformEntityListing.html.md +22 -0
- data/doc_out/Station.html.md +21 -0
- data/doc_out/StationEntityListing.html.md +22 -0
- data/doc_out/StationsApi.html.md +190 -0
- data/doc_out/StatisticalResponse.html.md +14 -0
- data/doc_out/StatisticalSummary.html.md +21 -0
- data/doc_out/SubDataItem.html.md +17 -0
- data/doc_out/SubscriberResponse.html.md +14 -0
- data/doc_out/Support.html.md +15 -0
- data/doc_out/SystemPrompt.html.md +17 -0
- data/doc_out/SystemPromptAsset.html.md +25 -0
- data/doc_out/SystemPromptAssetEntityListing.html.md +22 -0
- data/doc_out/SystemPromptEntityListing.html.md +22 -0
- data/doc_out/TableTransform.html.md +18 -0
- data/doc_out/TagModel.html.md +14 -0
- data/doc_out/TagQueryRequest.html.md +15 -0
- data/doc_out/TagValue.html.md +17 -0
- data/doc_out/TagValueEntityListing.html.md +22 -0
- data/doc_out/TelephonyProvidersEdgeApi.html.md +6283 -0
- data/doc_out/TemplateEntityListing.html.md +22 -0
- data/doc_out/TermAttribute.html.md +15 -0
- data/doc_out/TextTableTransform.html.md +21 -0
- data/doc_out/TextTableTransformEntityListing.html.md +22 -0
- data/doc_out/ThirdPartyAccount.html.md +19 -0
- data/doc_out/ThirdPartySubscription.html.md +18 -0
- data/doc_out/Ticker.html.md +14 -0
- data/doc_out/Tier.html.md +14 -0
- data/doc_out/TimeAllowed.html.md +15 -0
- data/doc_out/TimeInterval.html.md +14 -0
- data/doc_out/TimeSlot.html.md +15 -0
- data/doc_out/TimeZone.html.md +16 -0
- data/doc_out/TimeZoneEntityListing.html.md +22 -0
- data/doc_out/TokensApi.html.md +63 -0
- data/doc_out/Trace.html.md +19 -0
- data/doc_out/TraceList.html.md +14 -0
- data/doc_out/TransferRequest.html.md +17 -0
- data/doc_out/TransformEndpoint.html.md +24 -0
- data/doc_out/TransformLens.html.md +14 -0
- data/doc_out/TrunkBase.html.md +28 -0
- data/doc_out/TrunkBaseAssignment.html.md +14 -0
- data/doc_out/TrunkMetabaseEntityListing.html.md +22 -0
- data/doc_out/TwitterExpression.html.md +36 -0
- data/doc_out/TwitterExpressionBuffer.html.md +13 -0
- data/doc_out/UnpivotColumns.html.md +13 -0
- data/doc_out/UnreadMetric.html.md +13 -0
- data/doc_out/UnreadStatus.html.md +13 -0
- data/doc_out/UploadProgress.html.md +19 -0
- data/doc_out/UriReference.html.md +15 -0
- data/doc_out/UrlResponse.html.md +13 -0
- data/doc_out/User.html.md +32 -0
- data/doc_out/UserActionCategory.html.md +15 -0
- data/doc_out/UserActionCategoryEntityListing.html.md +22 -0
- data/doc_out/UserActionMetadata.html.md +22 -0
- data/doc_out/UserActionMetadataEntityListing.html.md +20 -0
- data/doc_out/UserActionMetadataRequest.html.md +18 -0
- data/doc_out/UserAuthorization.html.md +15 -0
- data/doc_out/UserConversationSummary.html.md +19 -0
- data/doc_out/UserEntityListing.html.md +22 -0
- data/doc_out/UserImage.html.md +14 -0
- data/doc_out/UserLicenseAssignment.html.md +17 -0
- data/doc_out/UserMe.html.md +33 -0
- data/doc_out/UserParam.html.md +14 -0
- data/doc_out/UserPresence.html.md +19 -0
- data/doc_out/UserQueue.html.md +33 -0
- data/doc_out/UserQueueEntityListing.html.md +22 -0
- data/doc_out/UserRecording.html.md +25 -0
- data/doc_out/UserRecordingEntityListing.html.md +22 -0
- data/doc_out/UserRecordingsApi.html.md +366 -0
- data/doc_out/UserRoutingSkill.html.md +18 -0
- data/doc_out/UserSkillEntityListing.html.md +22 -0
- data/doc_out/UserStation.html.md +16 -0
- data/doc_out/UserStations.html.md +16 -0
- data/doc_out/UsersApi.html.md +2104 -0
- data/doc_out/UsersEntityListing.html.md +22 -0
- data/doc_out/UsersSearchResponse.html.md +21 -0
- data/doc_out/UtilitiesApi.html.md +181 -0
- data/doc_out/Utilization.html.md +13 -0
- data/doc_out/ValidateAddressRequest.html.md +13 -0
- data/doc_out/ValidateAddressResponse.html.md +14 -0
- data/doc_out/Value.html.md +19 -0
- data/doc_out/VendorConnectionRequest.html.md +15 -0
- data/doc_out/Video.html.md +22 -0
- data/doc_out/VideoConversation.html.md +17 -0
- data/doc_out/VideoConversationEntityListing.html.md +22 -0
- data/doc_out/VideoMediaParticipant.html.md +38 -0
- data/doc_out/View.html.md +13 -0
- data/doc_out/VoiceRate.html.md +22 -0
- data/doc_out/VoiceRateExtended.html.md +31 -0
- data/doc_out/VoiceRateInternational.html.md +24 -0
- data/doc_out/VoiceRateInternationalEntityListing.html.md +22 -0
- data/doc_out/VoiceRateUpdate.html.md +25 -0
- data/doc_out/VoiceRatesCsv.html.md +16 -0
- data/doc_out/VoiceXmlOperation.html.md +24 -0
- data/doc_out/VoiceXmlOperationEntityListing.html.md +22 -0
- data/doc_out/VoicemailApi.html.md +627 -0
- data/doc_out/VoicemailMailboxInfo.html.md +18 -0
- data/doc_out/VoicemailMediaInfo.html.md +15 -0
- data/doc_out/VoicemailMessage.html.md +23 -0
- data/doc_out/VoicemailMessageEntityListing.html.md +22 -0
- data/doc_out/VoicemailOrganizationPolicy.html.md +27 -0
- data/doc_out/VoicemailUserPolicy.html.md +23 -0
- data/doc_out/Vpn.html.md +15 -0
- data/doc_out/WorkItem.html.md +15 -0
- data/doc_out/WorkItemActions.html.md +13 -0
- data/doc_out/WorkItemCache.html.md +17 -0
- data/doc_out/WorkItemCommand.html.md +14 -0
- data/doc_out/WorkItemCommandGroup.html.md +15 -0
- data/doc_out/WorkItemDefinition.html.md +16 -0
- data/doc_out/WorkItemDetails.html.md +32 -0
- data/doc_out/WorkItemSearchDetails.html.md +13 -0
- data/doc_out/WorkItemSearchDetailsSearchResult.html.md +14 -0
- data/doc_out/WorkItemSubmitRequest.html.md +14 -0
- data/doc_out/WorkItemTransferRequest.html.md +14 -0
- data/doc_out/Workspace.html.md +23 -0
- data/doc_out/WorkspaceCreate.html.md +14 -0
- data/doc_out/WorkspaceEntityListing.html.md +22 -0
- data/doc_out/WorkspaceMember.html.md +21 -0
- data/doc_out/WorkspaceMemberEntityListing.html.md +22 -0
- data/doc_out/WorkspaceSummary.html.md +13 -0
- data/doc_out/WrapUpCodeMapping.html.md +20 -0
- data/doc_out/Wrapup.html.md +19 -0
- data/doc_out/WrapupCode.html.md +19 -0
- data/doc_out/WrapupCodeEntityListing.html.md +22 -0
- data/doc_out/XlsxSchema.html.md +15 -0
- data/doc_out/index.html.md +56 -0
- data/external/swagger-codegen-cli.jar +0 -0
- data/git_push.sh +52 -0
- data/lib/purecloud.rb +679 -664
- data/lib/purecloud/api/alerting_api.rb +157 -155
- data/lib/purecloud/api/analytics_api.rb +384 -393
- data/lib/purecloud/api/attributes_api.rb +115 -109
- data/lib/purecloud/api/authorization_api.rb +322 -327
- data/lib/purecloud/api/configuration_api.rb +46 -38
- data/lib/purecloud/api/content_management_api.rb +739 -763
- data/lib/purecloud/api/conversations_api.rb +1082 -1126
- data/lib/purecloud/api/external_contacts_api.rb +522 -536
- data/lib/purecloud/api/fax_api.rb +110 -104
- data/lib/purecloud/api/geolocation_api.rb +61 -53
- data/lib/purecloud/api/greetings_api.rb +216 -216
- data/lib/purecloud/api/groups_api.rb +121 -114
- data/lib/purecloud/api/languages_api.rb +99 -92
- data/lib/purecloud/api/locations_api.rb +59 -49
- data/lib/purecloud/api/notifications_api.rb +97 -92
- data/lib/purecloud/api/o_auth_api.rb +330 -340
- data/lib/purecloud/api/organization_api.rb +53 -44
- data/lib/purecloud/api/outbound_api.rb +1259 -1310
- data/lib/purecloud/api/presence_api.rb +152 -147
- data/lib/purecloud/api/quality_api.rb +624 -636
- data/lib/purecloud/api/recording_api.rb +396 -404
- data/lib/purecloud/api/response_management_api.rb +200 -199
- data/lib/purecloud/api/routing_api.rb +721 -749
- data/lib/purecloud/api/search_api.rb +74 -68
- data/lib/purecloud/api/stations_api.rb +59 -50
- data/lib/purecloud/api/telephony_providers_edge_api.rb +1921 -2014
- data/lib/purecloud/api/tokens_api.rb +18 -7
- data/lib/purecloud/api/user_recordings_api.rb +129 -123
- data/lib/purecloud/api/users_api.rb +618 -641
- data/lib/purecloud/api/utilities_api.rb +62 -53
- data/lib/purecloud/api/voicemail_api.rb +186 -185
- data/lib/purecloud/api_client.rb +48 -14
- data/lib/purecloud/api_error.rb +16 -0
- data/lib/purecloud/models/account.rb +20 -1
- data/lib/purecloud/models/account_manager.rb +20 -1
- data/lib/purecloud/models/account_overview.rb +20 -1
- data/lib/purecloud/models/account_status.rb +20 -1
- data/lib/purecloud/models/actions.rb +20 -1
- data/lib/purecloud/models/acw_settings.rb +20 -1
- data/lib/purecloud/models/address.rb +20 -1
- data/lib/purecloud/models/address_listing.rb +20 -1
- data/lib/purecloud/models/agent.rb +20 -1
- data/lib/purecloud/models/agent_activity.rb +20 -1
- data/lib/purecloud/models/agent_activity_entity_listing.rb +20 -1
- data/lib/purecloud/models/agent_evaluator_activity.rb +20 -1
- data/lib/purecloud/models/aggregate_data_container.rb +20 -1
- data/lib/purecloud/models/aggregate_metric_data.rb +20 -1
- data/lib/purecloud/models/aggregate_query_response.rb +20 -1
- data/lib/purecloud/models/aggregation_query.rb +20 -1
- data/lib/purecloud/models/aggregation_range.rb +20 -1
- data/lib/purecloud/models/aggregation_result.rb +20 -1
- data/lib/purecloud/models/aggregation_result_entry.rb +20 -1
- data/lib/purecloud/models/analytics_conversation.rb +20 -1
- data/lib/purecloud/models/analytics_conversation_query_response.rb +20 -1
- data/lib/purecloud/models/analytics_conversation_segment.rb +20 -1
- data/lib/purecloud/models/analytics_evaluation.rb +20 -1
- data/lib/purecloud/models/analytics_participant.rb +20 -1
- data/lib/purecloud/models/analytics_property.rb +20 -1
- data/lib/purecloud/models/analytics_query_aggregation.rb +20 -1
- data/lib/purecloud/models/analytics_query_clause.rb +20 -1
- data/lib/purecloud/models/analytics_query_filter.rb +20 -1
- data/lib/purecloud/models/analytics_query_predicate.rb +20 -1
- data/lib/purecloud/models/analytics_session.rb +20 -1
- data/lib/purecloud/models/annotation.rb +20 -1
- data/lib/purecloud/models/app.rb +20 -1
- data/lib/purecloud/models/archive_retention.rb +20 -1
- data/lib/purecloud/models/associated_document.rb +20 -1
- data/lib/purecloud/models/attachment.rb +20 -1
- data/lib/purecloud/models/attribute.rb +20 -1
- data/lib/purecloud/models/attribute_entity_listing.rb +20 -1
- data/lib/purecloud/models/attribute_filter_item.rb +20 -1
- data/lib/purecloud/models/attribute_query_request.rb +20 -1
- data/lib/purecloud/models/audit_change.rb +20 -1
- data/lib/purecloud/models/audit_entity.rb +20 -1
- data/lib/purecloud/models/audit_entity_reference.rb +20 -1
- data/lib/purecloud/models/audit_facet.rb +20 -1
- data/lib/purecloud/models/audit_filter.rb +20 -1
- data/lib/purecloud/models/audit_message.rb +20 -1
- data/lib/purecloud/models/audit_search_result.rb +20 -1
- data/lib/purecloud/models/audit_user.rb +20 -1
- data/lib/purecloud/models/automate_queue.rb +21 -2
- data/lib/purecloud/models/automate_queue_member.rb +20 -1
- data/lib/purecloud/models/automate_queue_member_entity_listing.rb +20 -1
- data/lib/purecloud/models/available_additional_service.rb +20 -1
- data/lib/purecloud/models/available_additional_service_listing.rb +20 -1
- data/lib/purecloud/models/available_topic.rb +21 -2
- data/lib/purecloud/models/available_topic_entity_listing.rb +20 -1
- data/lib/purecloud/models/backend_flow_available_actions.rb +20 -1
- data/lib/purecloud/models/basic_transform.rb +20 -1
- data/lib/purecloud/models/batch_command.rb +20 -1
- data/lib/purecloud/models/batch_item.rb +20 -1
- data/lib/purecloud/models/batch_item_body.rb +20 -1
- data/lib/purecloud/models/batch_reply.rb +20 -1
- data/lib/purecloud/models/batch_reply_item.rb +20 -1
- data/lib/purecloud/models/billing_address.rb +20 -1
- data/lib/purecloud/models/billing_period.rb +20 -1
- data/lib/purecloud/models/bullseye.rb +20 -1
- data/lib/purecloud/models/calibration.rb +20 -1
- data/lib/purecloud/models/calibration_assignment.rb +20 -1
- data/lib/purecloud/models/calibration_entity_listing.rb +20 -1
- data/lib/purecloud/models/call.rb +20 -1
- data/lib/purecloud/models/call_command.rb +20 -1
- data/lib/purecloud/models/call_conversation.rb +20 -1
- data/lib/purecloud/models/call_conversation_entity_listing.rb +20 -1
- data/lib/purecloud/models/call_forwarding.rb +20 -1
- data/lib/purecloud/models/call_media_participant.rb +20 -1
- data/lib/purecloud/models/call_record.rb +20 -1
- data/lib/purecloud/models/callable_contacts_diagnostic.rb +20 -1
- data/lib/purecloud/models/callable_time.rb +20 -1
- data/lib/purecloud/models/callable_time_set.rb +20 -1
- data/lib/purecloud/models/callable_time_set_entity_listing.rb +20 -1
- data/lib/purecloud/models/callback.rb +20 -1
- data/lib/purecloud/models/callback_conversation.rb +20 -1
- data/lib/purecloud/models/callback_conversation_entity_listing.rb +20 -1
- data/lib/purecloud/models/callback_media_participant.rb +20 -1
- data/lib/purecloud/models/campaign.rb +20 -1
- data/lib/purecloud/models/campaign_diagnostics.rb +20 -1
- data/lib/purecloud/models/campaign_entity_listing.rb +20 -1
- data/lib/purecloud/models/campaign_progress.rb +20 -1
- data/lib/purecloud/models/campaign_schedule.rb +21 -2
- data/lib/purecloud/models/campaign_schedule_intervals.rb +20 -1
- data/lib/purecloud/models/campaign_sequence.rb +20 -1
- data/lib/purecloud/models/campaign_sequence_entity_listing.rb +20 -1
- data/lib/purecloud/models/campaign_stats.rb +20 -1
- data/lib/purecloud/models/campaign_time_slot.rb +20 -1
- data/lib/purecloud/models/carrier.rb +20 -1
- data/lib/purecloud/models/carrier_address.rb +20 -1
- data/lib/purecloud/models/carrier_entity_listing.rb +20 -1
- data/lib/purecloud/models/certificate.rb +20 -1
- data/lib/purecloud/models/certificate_authority_entity_listing.rb +20 -1
- data/lib/purecloud/models/certificate_details.rb +20 -1
- data/lib/purecloud/models/change.rb +20 -1
- data/lib/purecloud/models/channel.rb +20 -1
- data/lib/purecloud/models/channel_entity_listing.rb +20 -1
- data/lib/purecloud/models/channel_topic.rb +20 -1
- data/lib/purecloud/models/channel_topic_entity_listing.rb +20 -1
- data/lib/purecloud/models/charge.rb +20 -1
- data/lib/purecloud/models/chat.rb +20 -1
- data/lib/purecloud/models/chat_conversation.rb +20 -1
- data/lib/purecloud/models/chat_conversation_entity_listing.rb +20 -1
- data/lib/purecloud/models/chat_media_participant.rb +20 -1
- data/lib/purecloud/models/chat_message.rb +20 -1
- data/lib/purecloud/models/chat_message_user.rb +20 -1
- data/lib/purecloud/models/client_spreadsheet_transform.rb +20 -1
- data/lib/purecloud/models/client_text_table_transform.rb +20 -1
- data/lib/purecloud/models/column_collapse.rb +20 -1
- data/lib/purecloud/models/command_status.rb +20 -1
- data/lib/purecloud/models/command_status_entity_listing.rb +20 -1
- data/lib/purecloud/models/common_audit_request.rb +20 -1
- data/lib/purecloud/models/composer_template.rb +21 -2
- data/lib/purecloud/models/condition.rb +20 -1
- data/lib/purecloud/models/connect_rate.rb +20 -1
- data/lib/purecloud/models/consult_transfer.rb +20 -1
- data/lib/purecloud/models/consult_transfer_response.rb +20 -1
- data/lib/purecloud/models/consult_transfer_update.rb +20 -1
- data/lib/purecloud/models/consumed_resources_entity_listing.rb +20 -1
- data/lib/purecloud/models/consuming_resources_entity_listing.rb +20 -1
- data/lib/purecloud/models/contact.rb +20 -1
- data/lib/purecloud/models/contact_address.rb +20 -1
- data/lib/purecloud/models/contact_callback_request.rb +20 -1
- data/lib/purecloud/models/contact_list.rb +20 -1
- data/lib/purecloud/models/contact_list_entity_listing.rb +20 -1
- data/lib/purecloud/models/contact_listing.rb +20 -1
- data/lib/purecloud/models/contact_phone_number_column.rb +20 -1
- data/lib/purecloud/models/contact_sales.rb +20 -1
- data/lib/purecloud/models/contact_sales_response.rb +20 -1
- data/lib/purecloud/models/contact_sort.rb +20 -1
- data/lib/purecloud/models/content_attribute_filter_item.rb +20 -1
- data/lib/purecloud/models/content_facet_filter_item.rb +20 -1
- data/lib/purecloud/models/content_filter_item.rb +20 -1
- data/lib/purecloud/models/content_query_request.rb +20 -1
- data/lib/purecloud/models/content_sort_item.rb +20 -1
- data/lib/purecloud/models/contract.rb +20 -1
- data/lib/purecloud/models/contract_job.rb +20 -1
- data/lib/purecloud/models/control.rb +20 -1
- data/lib/purecloud/models/control_options.rb +20 -1
- data/lib/purecloud/models/conversation.rb +20 -1
- data/lib/purecloud/models/conversation_chat.rb +20 -1
- data/lib/purecloud/models/conversation_entity_listing.rb +20 -1
- data/lib/purecloud/models/conversation_query.rb +20 -1
- data/lib/purecloud/models/cover_sheet.rb +20 -1
- data/lib/purecloud/models/create_call_request.rb +20 -1
- data/lib/purecloud/models/create_call_response.rb +20 -1
- data/lib/purecloud/models/create_callback_command.rb +20 -1
- data/lib/purecloud/models/create_share_request.rb +20 -1
- data/lib/purecloud/models/create_share_request_member.rb +20 -1
- data/lib/purecloud/models/create_share_response.rb +20 -1
- data/lib/purecloud/models/create_template_from_script_request_data.rb +20 -1
- data/lib/purecloud/models/create_user.rb +20 -1
- data/lib/purecloud/models/csv_schema.rb +20 -1
- data/lib/purecloud/models/currency.rb +20 -1
- data/lib/purecloud/models/customer_account.rb +20 -1
- data/lib/purecloud/models/data_item.rb +20 -1
- data/lib/purecloud/models/data_value_info.rb +20 -1
- data/lib/purecloud/models/default_greeting_list.rb +20 -1
- data/lib/purecloud/models/delete_retention.rb +20 -1
- data/lib/purecloud/models/deleted_resource_consumer_entity_listing.rb +20 -1
- data/lib/purecloud/models/delta_document.rb +20 -1
- data/lib/purecloud/models/delta_request.rb +20 -1
- data/lib/purecloud/models/delta_response.rb +20 -1
- data/lib/purecloud/models/dependency.rb +20 -1
- data/lib/purecloud/models/dependency_object.rb +20 -1
- data/lib/purecloud/models/dependency_object_entity_listing.rb +20 -1
- data/lib/purecloud/models/dependency_status.rb +20 -1
- data/lib/purecloud/models/dependency_type.rb +20 -1
- data/lib/purecloud/models/dependency_type_entity_listing.rb +20 -1
- data/lib/purecloud/models/destination.rb +20 -1
- data/lib/purecloud/models/detail.rb +20 -1
- data/lib/purecloud/models/diagnostic_email.rb +20 -1
- data/lib/purecloud/models/dialer_action.rb +20 -1
- data/lib/purecloud/models/dialer_audit_request.rb +20 -1
- data/lib/purecloud/models/dialer_contact.rb +21 -2
- data/lib/purecloud/models/dialer_preview.rb +20 -1
- data/lib/purecloud/models/dialer_rule.rb +20 -1
- data/lib/purecloud/models/did.rb +20 -1
- data/lib/purecloud/models/did_entity_listing.rb +20 -1
- data/lib/purecloud/models/did_pool.rb +20 -1
- data/lib/purecloud/models/did_pool_entity_listing.rb +20 -1
- data/lib/purecloud/models/digit_length.rb +20 -1
- data/lib/purecloud/models/disconnect_reason.rb +20 -1
- data/lib/purecloud/models/discount.rb +20 -1
- data/lib/purecloud/models/dnc_list.rb +20 -1
- data/lib/purecloud/models/dnc_list_entity_listing.rb +20 -1
- data/lib/purecloud/models/dns.rb +20 -1
- data/lib/purecloud/models/document.rb +20 -1
- data/lib/purecloud/models/document_attribute.rb +20 -1
- data/lib/purecloud/models/document_audit.rb +20 -1
- data/lib/purecloud/models/document_audit_entity_listing.rb +20 -1
- data/lib/purecloud/models/document_entity_listing.rb +20 -1
- data/lib/purecloud/models/document_thumbnail.rb +20 -1
- data/lib/purecloud/models/document_update.rb +20 -1
- data/lib/purecloud/models/document_upload.rb +20 -1
- data/lib/purecloud/models/domain_billing_period_entity_listing.rb +20 -1
- data/lib/purecloud/models/domain_capabilities.rb +20 -1
- data/lib/purecloud/models/domain_certificate_authority.rb +20 -1
- data/lib/purecloud/models/domain_edge_software_update_dto.rb +20 -1
- data/lib/purecloud/models/domain_edge_software_version_dto.rb +20 -1
- data/lib/purecloud/models/domain_entity.rb +20 -1
- data/lib/purecloud/models/domain_entity_listing.rb +20 -1
- data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +20 -1
- data/lib/purecloud/models/domain_entity_listing_query_result.rb +20 -1
- data/lib/purecloud/models/domain_invoice_entity_listing.rb +20 -1
- data/lib/purecloud/models/domain_logical_interface.rb +20 -1
- data/lib/purecloud/models/domain_network_address.rb +20 -1
- data/lib/purecloud/models/domain_network_command_response.rb +20 -1
- data/lib/purecloud/models/domain_network_route.rb +20 -1
- data/lib/purecloud/models/domain_org_role_difference.rb +20 -1
- data/lib/purecloud/models/domain_organization_product.rb +20 -1
- data/lib/purecloud/models/domain_organization_role.rb +20 -1
- data/lib/purecloud/models/domain_permission.rb +20 -1
- data/lib/purecloud/models/domain_permission_collection.rb +20 -1
- data/lib/purecloud/models/domain_permission_policy.rb +20 -1
- data/lib/purecloud/models/domain_physical_capabilities.rb +20 -1
- data/lib/purecloud/models/domain_physical_interface.rb +20 -1
- data/lib/purecloud/models/domain_resource_condition_node.rb +20 -1
- data/lib/purecloud/models/domain_resource_condition_value.rb +20 -1
- data/lib/purecloud/models/domain_role.rb +20 -1
- data/lib/purecloud/models/domain_schema_reference.rb +20 -1
- data/lib/purecloud/models/domain_third_party_account_entity_listing.rb +20 -1
- data/lib/purecloud/models/domain_third_party_subscription_entity_listing.rb +20 -1
- data/lib/purecloud/models/domain_voice_rate_extended_response_item_entity_listing.rb +20 -1
- data/lib/purecloud/models/domain_voice_rate_international_response_item_entity_listing.rb +20 -1
- data/lib/purecloud/models/domain_voice_rate_response_item_entity_listing.rb +20 -1
- data/lib/purecloud/models/download_response.rb +20 -1
- data/lib/purecloud/models/duration_condition.rb +20 -1
- data/lib/purecloud/models/edge.rb +20 -1
- data/lib/purecloud/models/edge_auto_update_config.rb +20 -1
- data/lib/purecloud/models/edge_entity_listing.rb +20 -1
- data/lib/purecloud/models/edge_group.rb +20 -1
- data/lib/purecloud/models/edge_group_entity_listing.rb +20 -1
- data/lib/purecloud/models/edge_interface.rb +20 -1
- data/lib/purecloud/models/edge_line.rb +21 -2
- data/lib/purecloud/models/edge_line_entity_listing.rb +20 -1
- data/lib/purecloud/models/edge_logs_job.rb +20 -1
- data/lib/purecloud/models/edge_logs_job_file.rb +20 -1
- data/lib/purecloud/models/edge_logs_job_request.rb +26 -7
- data/lib/purecloud/models/edge_logs_job_response.rb +20 -1
- data/lib/purecloud/models/edge_logs_job_upload_request.rb +20 -1
- data/lib/purecloud/models/edge_version_information.rb +20 -1
- data/lib/purecloud/models/edge_version_report.rb +20 -1
- data/lib/purecloud/models/email.rb +20 -1
- data/lib/purecloud/models/email_address.rb +20 -1
- data/lib/purecloud/models/email_attachment.rb +20 -1
- data/lib/purecloud/models/email_conversation.rb +20 -1
- data/lib/purecloud/models/email_conversation_entity_listing.rb +20 -1
- data/lib/purecloud/models/email_media_participant.rb +20 -1
- data/lib/purecloud/models/email_message.rb +20 -1
- data/lib/purecloud/models/email_message_listing.rb +20 -1
- data/lib/purecloud/models/email_setup.rb +20 -1
- data/lib/purecloud/models/embedded_signature_view.rb +20 -1
- data/lib/purecloud/models/encryption_key.rb +20 -1
- data/lib/purecloud/models/encryption_key_entity_listing.rb +20 -1
- data/lib/purecloud/models/endpoint.rb +21 -2
- data/lib/purecloud/models/endpoint_entity_listing.rb +20 -1
- data/lib/purecloud/models/entity.rb +20 -1
- data/lib/purecloud/models/entry.rb +20 -1
- data/lib/purecloud/models/error_body.rb +20 -1
- data/lib/purecloud/models/error_details.rb +20 -1
- data/lib/purecloud/models/estimated_wait_time_predictions.rb +20 -1
- data/lib/purecloud/models/evaluation.rb +20 -1
- data/lib/purecloud/models/evaluation_assignment.rb +20 -1
- data/lib/purecloud/models/evaluation_entity_listing.rb +20 -1
- data/lib/purecloud/models/evaluation_form.rb +20 -1
- data/lib/purecloud/models/evaluation_form_and_scoring_set.rb +20 -1
- data/lib/purecloud/models/evaluation_form_entity_listing.rb +20 -1
- data/lib/purecloud/models/evaluation_scoring_set.rb +20 -1
- data/lib/purecloud/models/evaluator_activity.rb +20 -1
- data/lib/purecloud/models/evaluator_activity_entity_listing.rb +20 -1
- data/lib/purecloud/models/expansion_criterium.rb +20 -1
- data/lib/purecloud/models/expression_response.rb +20 -1
- data/lib/purecloud/models/extension.rb +20 -1
- data/lib/purecloud/models/extension_entity_listing.rb +20 -1
- data/lib/purecloud/models/extension_pool.rb +20 -1
- data/lib/purecloud/models/extension_pool_entity_listing.rb +20 -1
- data/lib/purecloud/models/external_contact.rb +20 -1
- data/lib/purecloud/models/external_organization.rb +20 -1
- data/lib/purecloud/models/external_organization_listing.rb +20 -1
- data/lib/purecloud/models/facet_entry.rb +20 -1
- data/lib/purecloud/models/facet_info.rb +20 -1
- data/lib/purecloud/models/facet_key_attribute.rb +20 -1
- data/lib/purecloud/models/facet_request.rb +20 -1
- data/lib/purecloud/models/facet_result.rb +20 -1
- data/lib/purecloud/models/facet_result_item.rb +20 -1
- data/lib/purecloud/models/facet_statistics.rb +20 -1
- data/lib/purecloud/models/facet_term.rb +20 -1
- data/lib/purecloud/models/failed_object.rb +20 -1
- data/lib/purecloud/models/favorite_template_request_data.rb +20 -1
- data/lib/purecloud/models/fax_document.rb +20 -1
- data/lib/purecloud/models/fax_document_entity_listing.rb +20 -1
- data/lib/purecloud/models/fax_send_request.rb +20 -1
- data/lib/purecloud/models/fax_send_response.rb +20 -1
- data/lib/purecloud/models/fax_summary.rb +20 -1
- data/lib/purecloud/models/filter_item.rb +20 -1
- data/lib/purecloud/models/flow.rb +20 -1
- data/lib/purecloud/models/flow_body.rb +21 -2
- data/lib/purecloud/models/flow_body_format.rb +20 -1
- data/lib/purecloud/models/flow_config_id.rb +20 -1
- data/lib/purecloud/models/flow_config_meta_data.rb +20 -1
- data/lib/purecloud/models/flow_config_meta_data_entity_listing.rb +20 -1
- data/lib/purecloud/models/flow_details.rb +20 -1
- data/lib/purecloud/models/flow_details_search_result.rb +20 -1
- data/lib/purecloud/models/flow_entity_listing.rb +20 -1
- data/lib/purecloud/models/flow_exec_id.rb +20 -1
- data/lib/purecloud/models/flow_history_item.rb +20 -1
- data/lib/purecloud/models/flow_history_result_item.rb +20 -1
- data/lib/purecloud/models/flow_history_result_item_entity_listing.rb +20 -1
- data/lib/purecloud/models/flow_input_data.rb +20 -1
- data/lib/purecloud/models/flow_launch_request.rb +20 -1
- data/lib/purecloud/models/flow_publish.rb +20 -1
- data/lib/purecloud/models/flow_report_result_item.rb +20 -1
- data/lib/purecloud/models/flow_search_request.rb +20 -1
- data/lib/purecloud/models/flow_state.rb +20 -1
- data/lib/purecloud/models/flow_terminate_request.rb +20 -1
- data/lib/purecloud/models/flow_upload_response.rb +20 -1
- data/lib/purecloud/models/flow_version.rb +20 -1
- data/lib/purecloud/models/flow_version_config_meta_data.rb +20 -1
- data/lib/purecloud/models/flow_version_config_meta_data_entity_listing.rb +20 -1
- data/lib/purecloud/models/flow_version_entity_listing.rb +20 -1
- data/lib/purecloud/models/form.rb +20 -1
- data/lib/purecloud/models/gateway.rb +20 -1
- data/lib/purecloud/models/geolocation.rb +20 -1
- data/lib/purecloud/models/geolocation_settings.rb +20 -1
- data/lib/purecloud/models/gistener.rb +20 -1
- data/lib/purecloud/models/greeting.rb +20 -1
- data/lib/purecloud/models/greeting_audio_file.rb +20 -1
- data/lib/purecloud/models/greeting_media_info.rb +20 -1
- data/lib/purecloud/models/greeting_owner.rb +20 -1
- data/lib/purecloud/models/group.rb +20 -1
- data/lib/purecloud/models/group_entity_listing.rb +20 -1
- data/lib/purecloud/models/group_tag.rb +20 -1
- data/lib/purecloud/models/groups_search_response.rb +20 -1
- data/lib/purecloud/models/hardware_rate.rb +20 -1
- data/lib/purecloud/models/hardware_rate_listing.rb +20 -1
- data/lib/purecloud/models/health_check_info.rb +20 -1
- data/lib/purecloud/models/hipaa_config.rb +20 -1
- data/lib/purecloud/models/import_status.rb +20 -1
- data/lib/purecloud/models/inbound_domain.rb +20 -1
- data/lib/purecloud/models/inbound_domain_entity_listing.rb +20 -1
- data/lib/purecloud/models/inbound_route.rb +20 -1
- data/lib/purecloud/models/inbound_route_entity_listing.rb +20 -1
- data/lib/purecloud/models/indexed_transform.rb +20 -1
- data/lib/purecloud/models/integration_type.rb +20 -1
- data/lib/purecloud/models/integration_type_entity_listing.rb +20 -1
- data/lib/purecloud/models/interaction_stats_alert.rb +20 -1
- data/lib/purecloud/models/interaction_stats_alert_container.rb +20 -1
- data/lib/purecloud/models/interaction_stats_rule.rb +20 -1
- data/lib/purecloud/models/interaction_stats_rule_container.rb +20 -1
- data/lib/purecloud/models/invoice.rb +20 -1
- data/lib/purecloud/models/ivr.rb +20 -1
- data/lib/purecloud/models/ivr_entity_listing.rb +20 -1
- data/lib/purecloud/models/json_node.rb +20 -1
- data/lib/purecloud/models/json_node_search_response.rb +20 -1
- data/lib/purecloud/models/key_rotation_schedule.rb +20 -1
- data/lib/purecloud/models/language.rb +20 -1
- data/lib/purecloud/models/language_entity_listing.rb +20 -1
- data/lib/purecloud/models/library.rb +20 -1
- data/lib/purecloud/models/library_entity_listing.rb +20 -1
- data/lib/purecloud/models/license.rb +20 -1
- data/lib/purecloud/models/licenses_by_permission.rb +20 -1
- data/lib/purecloud/models/line.rb +21 -2
- data/lib/purecloud/models/line_base.rb +21 -2
- data/lib/purecloud/models/line_base_entity_listing.rb +20 -1
- data/lib/purecloud/models/line_entity_listing.rb +20 -1
- data/lib/purecloud/models/line_status.rb +20 -1
- data/lib/purecloud/models/linked_entity_listing_flow_details.rb +20 -1
- data/lib/purecloud/models/linked_entity_listing_work_item_search_details.rb +20 -1
- data/lib/purecloud/models/location.rb +26 -7
- data/lib/purecloud/models/location_address_fields.rb +20 -1
- data/lib/purecloud/models/location_emergency_number.rb +20 -1
- data/lib/purecloud/models/location_entity_listing.rb +20 -1
- data/lib/purecloud/models/lock_info.rb +20 -1
- data/lib/purecloud/models/logical_interface_entity_listing.rb +20 -1
- data/lib/purecloud/models/management_unit.rb +20 -1
- data/lib/purecloud/models/management_unit_timezone.rb +20 -1
- data/lib/purecloud/models/max_participants.rb +20 -1
- data/lib/purecloud/models/media_participant_request.rb +20 -1
- data/lib/purecloud/models/media_policies.rb +20 -1
- data/lib/purecloud/models/media_policy.rb +20 -1
- data/lib/purecloud/models/media_result.rb +20 -1
- data/lib/purecloud/models/media_setting.rb +20 -1
- data/lib/purecloud/models/media_summary.rb +20 -1
- data/lib/purecloud/models/media_summary_detail.rb +20 -1
- data/lib/purecloud/models/member_entity.rb +20 -1
- data/lib/purecloud/models/metabase.rb +20 -1
- data/lib/purecloud/models/metered_evaluation_assignment.rb +20 -1
- data/lib/purecloud/models/noc_support.rb +20 -1
- data/lib/purecloud/models/note.rb +20 -1
- data/lib/purecloud/models/note_listing.rb +20 -1
- data/lib/purecloud/models/number.rb +20 -1
- data/lib/purecloud/models/number_order_request.rb +20 -1
- data/lib/purecloud/models/number_plan.rb +20 -1
- data/lib/purecloud/models/numeric_range.rb +20 -1
- data/lib/purecloud/models/o_auth_client.rb +20 -1
- data/lib/purecloud/models/o_auth_client_entity_listing.rb +20 -1
- data/lib/purecloud/models/o_auth_provider.rb +20 -1
- data/lib/purecloud/models/o_auth_provider_entity_listing.rb +20 -1
- data/lib/purecloud/models/observation_data_container.rb +20 -1
- data/lib/purecloud/models/observation_query.rb +20 -1
- data/lib/purecloud/models/observation_query_response.rb +20 -1
- data/lib/purecloud/models/okta.rb +20 -1
- data/lib/purecloud/models/one_login.rb +20 -1
- data/lib/purecloud/models/order.rb +20 -1
- data/lib/purecloud/models/org_license_assignment.rb +20 -1
- data/lib/purecloud/models/org_media_utilization.rb +20 -1
- data/lib/purecloud/models/organization.rb +20 -1
- data/lib/purecloud/models/organization_create.rb +20 -1
- data/lib/purecloud/models/organization_presence.rb +20 -1
- data/lib/purecloud/models/organization_presence_entity_listing.rb +20 -1
- data/lib/purecloud/models/organization_product_entity_listing.rb +20 -1
- data/lib/purecloud/models/organization_role_entity_listing.rb +20 -1
- data/lib/purecloud/models/orphan_recording.rb +20 -1
- data/lib/purecloud/models/orphan_recording_listing.rb +20 -1
- data/lib/purecloud/models/out_of_office.rb +20 -1
- data/lib/purecloud/models/outbound_route.rb +20 -1
- data/lib/purecloud/models/outbound_route_entity_listing.rb +20 -1
- data/lib/purecloud/models/page.rb +22 -3
- data/lib/purecloud/models/paging_spec.rb +20 -1
- data/lib/purecloud/models/parameter.rb +20 -1
- data/lib/purecloud/models/parsed_certificate.rb +20 -1
- data/lib/purecloud/models/participant.rb +20 -1
- data/lib/purecloud/models/participant_attributes.rb +20 -1
- data/lib/purecloud/models/payment_method.rb +20 -1
- data/lib/purecloud/models/payment_method_listing.rb +20 -1
- data/lib/purecloud/models/payment_token_provider.rb +20 -1
- data/lib/purecloud/models/permission_collection_entity_listing.rb +20 -1
- data/lib/purecloud/models/permissions.rb +20 -1
- data/lib/purecloud/models/phone.rb +21 -2
- data/lib/purecloud/models/phone_base.rb +21 -2
- data/lib/purecloud/models/phone_base_entity_listing.rb +20 -1
- data/lib/purecloud/models/phone_capabilities.rb +20 -1
- data/lib/purecloud/models/phone_column.rb +20 -1
- data/lib/purecloud/models/phone_entity_listing.rb +20 -1
- data/lib/purecloud/models/phone_meta_base_entity_listing.rb +20 -1
- data/lib/purecloud/models/phone_number.rb +20 -1
- data/lib/purecloud/models/phone_number_column.rb +20 -1
- data/lib/purecloud/models/phone_number_status.rb +20 -1
- data/lib/purecloud/models/phone_status.rb +20 -1
- data/lib/purecloud/models/phones_reboot.rb +20 -1
- data/lib/purecloud/models/physical_interface_entity_listing.rb +20 -1
- data/lib/purecloud/models/pin_configuration.rb +20 -1
- data/lib/purecloud/models/policy.rb +20 -1
- data/lib/purecloud/models/policy_actions.rb +20 -1
- data/lib/purecloud/models/policy_conditions.rb +20 -1
- data/lib/purecloud/models/policy_entity_listing.rb +20 -1
- data/lib/purecloud/models/policy_error_message.rb +20 -1
- data/lib/purecloud/models/policy_errors.rb +20 -1
- data/lib/purecloud/models/prediction_results.rb +20 -1
- data/lib/purecloud/models/presence_query_response.rb +20 -1
- data/lib/purecloud/models/product.rb +20 -1
- data/lib/purecloud/models/prompt.rb +20 -1
- data/lib/purecloud/models/prompt_asset.rb +20 -1
- data/lib/purecloud/models/prompt_asset_entity_listing.rb +20 -1
- data/lib/purecloud/models/prompt_entity_listing.rb +20 -1
- data/lib/purecloud/models/property_index_request.rb +20 -1
- data/lib/purecloud/models/provision_info.rb +20 -1
- data/lib/purecloud/models/publication.rb +20 -1
- data/lib/purecloud/models/publish_script_request_data.rb +20 -1
- data/lib/purecloud/models/published_result.rb +20 -1
- data/lib/purecloud/models/pure_cloud.rb +20 -1
- data/lib/purecloud/models/quality_audit.rb +20 -1
- data/lib/purecloud/models/quality_audit_page.rb +20 -1
- data/lib/purecloud/models/query_facet_info.rb +20 -1
- data/lib/purecloud/models/query_request.rb +20 -1
- data/lib/purecloud/models/query_result.rb +20 -1
- data/lib/purecloud/models/query_results.rb +20 -1
- data/lib/purecloud/models/question_group.rb +20 -1
- data/lib/purecloud/models/question_group_score.rb +20 -1
- data/lib/purecloud/models/question_score.rb +20 -1
- data/lib/purecloud/models/queue.rb +20 -1
- data/lib/purecloud/models/queue_entity_listing.rb +20 -1
- data/lib/purecloud/models/queue_member.rb +20 -1
- data/lib/purecloud/models/queue_utilization_diagnostic.rb +20 -1
- data/lib/purecloud/models/queues_entity_listing.rb +20 -1
- data/lib/purecloud/models/quote.rb +20 -1
- data/lib/purecloud/models/quote_charge.rb +20 -1
- data/lib/purecloud/models/quote_listing.rb +20 -1
- data/lib/purecloud/models/rate.rb +20 -1
- data/lib/purecloud/models/reaction.rb +20 -1
- data/lib/purecloud/models/recording.rb +26 -7
- data/lib/purecloud/models/recording_email_message.rb +20 -1
- data/lib/purecloud/models/recording_settings.rb +20 -1
- data/lib/purecloud/models/relationship.rb +20 -1
- data/lib/purecloud/models/relationship_listing.rb +20 -1
- data/lib/purecloud/models/replace_request.rb +20 -1
- data/lib/purecloud/models/replace_response.rb +20 -1
- data/lib/purecloud/models/report_meta_data.rb +20 -1
- data/lib/purecloud/models/report_meta_data_entity_listing.rb +20 -1
- data/lib/purecloud/models/report_request.rb +20 -1
- data/lib/purecloud/models/report_run_entry.rb +20 -1
- data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +20 -1
- data/lib/purecloud/models/report_schedule.rb +21 -2
- data/lib/purecloud/models/report_schedule_entity_listing.rb +20 -1
- data/lib/purecloud/models/reservation.rb +20 -1
- data/lib/purecloud/models/resource_condition_node.rb +20 -1
- data/lib/purecloud/models/resource_condition_value.rb +20 -1
- data/lib/purecloud/models/resource_permission_policy.rb +20 -1
- data/lib/purecloud/models/response.rb +20 -1
- data/lib/purecloud/models/response_entity_list.rb +20 -1
- data/lib/purecloud/models/response_entity_listing.rb +20 -1
- data/lib/purecloud/models/response_filter.rb +20 -1
- data/lib/purecloud/models/response_query_request.rb +20 -1
- data/lib/purecloud/models/response_query_results.rb +20 -1
- data/lib/purecloud/models/response_set.rb +20 -1
- data/lib/purecloud/models/response_set_entity_listing.rb +20 -1
- data/lib/purecloud/models/response_text.rb +20 -1
- data/lib/purecloud/models/rest_error_detail.rb +20 -1
- data/lib/purecloud/models/retention_duration.rb +20 -1
- data/lib/purecloud/models/ring.rb +20 -1
- data/lib/purecloud/models/routing_skill.rb +20 -1
- data/lib/purecloud/models/routing_status.rb +20 -1
- data/lib/purecloud/models/rule_set.rb +20 -1
- data/lib/purecloud/models/rule_set_entity_listing.rb +20 -1
- data/lib/purecloud/models/run_now_response.rb +20 -1
- data/lib/purecloud/models/salesforce.rb +20 -1
- data/lib/purecloud/models/schedule.rb +20 -1
- data/lib/purecloud/models/schedule_entity_listing.rb +20 -1
- data/lib/purecloud/models/schedule_group.rb +20 -1
- data/lib/purecloud/models/schedule_group_entity_listing.rb +20 -1
- data/lib/purecloud/models/schema_category.rb +20 -1
- data/lib/purecloud/models/schema_category_entity_listing.rb +20 -1
- data/lib/purecloud/models/schema_reference_entity_listing.rb +20 -1
- data/lib/purecloud/models/script.rb +20 -1
- data/lib/purecloud/models/script_entity_listing.rb +20 -1
- data/lib/purecloud/models/search_aggregation.rb +20 -1
- data/lib/purecloud/models/search_criteria.rb +20 -1
- data/lib/purecloud/models/search_request.rb +20 -1
- data/lib/purecloud/models/security_profile.rb +20 -1
- data/lib/purecloud/models/security_profile_entity_listing.rb +20 -1
- data/lib/purecloud/models/segment.rb +20 -1
- data/lib/purecloud/models/sequence_schedule.rb +21 -2
- data/lib/purecloud/models/server_date.rb +20 -1
- data/lib/purecloud/models/service.rb +20 -1
- data/lib/purecloud/models/service_context.rb +20 -1
- data/lib/purecloud/models/service_entity_listing.rb +20 -1
- data/lib/purecloud/models/service_level.rb +20 -1
- data/lib/purecloud/models/service_type.rb +20 -1
- data/lib/purecloud/models/share.rb +20 -1
- data/lib/purecloud/models/share_entity_listing.rb +20 -1
- data/lib/purecloud/models/shared_entity.rb +20 -1
- data/lib/purecloud/models/shared_response.rb +20 -1
- data/lib/purecloud/models/sheet_schema.rb +20 -1
- data/lib/purecloud/models/sheet_transform.rb +20 -1
- data/lib/purecloud/models/signature_document_info.rb +20 -1
- data/lib/purecloud/models/site.rb +20 -1
- data/lib/purecloud/models/site_entity_listing.rb +20 -1
- data/lib/purecloud/models/skill_entity_listing.rb +20 -1
- data/lib/purecloud/models/skills_to_remove.rb +20 -1
- data/lib/purecloud/models/snapshot.rb +20 -1
- data/lib/purecloud/models/social_account.rb +20 -1
- data/lib/purecloud/models/social_conversation.rb +20 -1
- data/lib/purecloud/models/social_conversation_entity_listing.rb +20 -1
- data/lib/purecloud/models/social_expression.rb +20 -1
- data/lib/purecloud/models/social_media_participant.rb +20 -1
- data/lib/purecloud/models/socialize_entity_filter.rb +20 -1
- data/lib/purecloud/models/socialize_filter_request.rb +20 -1
- data/lib/purecloud/models/sort_by.rb +20 -1
- data/lib/purecloud/models/sort_field.rb +20 -1
- data/lib/purecloud/models/sort_item.rb +20 -1
- data/lib/purecloud/models/spreadsheet_transform.rb +20 -1
- data/lib/purecloud/models/spreadsheet_transform_entity_listing.rb +20 -1
- data/lib/purecloud/models/station.rb +20 -1
- data/lib/purecloud/models/station_entity_listing.rb +20 -1
- data/lib/purecloud/models/statistical_response.rb +20 -1
- data/lib/purecloud/models/statistical_summary.rb +20 -1
- data/lib/purecloud/models/sub_data_item.rb +20 -1
- data/lib/purecloud/models/subscriber_response.rb +20 -1
- data/lib/purecloud/models/support.rb +20 -1
- data/lib/purecloud/models/system_prompt.rb +20 -1
- data/lib/purecloud/models/system_prompt_asset.rb +20 -1
- data/lib/purecloud/models/system_prompt_asset_entity_listing.rb +20 -1
- data/lib/purecloud/models/system_prompt_entity_listing.rb +20 -1
- data/lib/purecloud/models/table_transform.rb +20 -1
- data/lib/purecloud/models/tag_model.rb +20 -1
- data/lib/purecloud/models/tag_query_request.rb +20 -1
- data/lib/purecloud/models/tag_value.rb +20 -1
- data/lib/purecloud/models/tag_value_entity_listing.rb +20 -1
- data/lib/purecloud/models/template_entity_listing.rb +20 -1
- data/lib/purecloud/models/term_attribute.rb +20 -1
- data/lib/purecloud/models/text_table_transform.rb +20 -1
- data/lib/purecloud/models/text_table_transform_entity_listing.rb +20 -1
- data/lib/purecloud/models/third_party_account.rb +20 -1
- data/lib/purecloud/models/third_party_subscription.rb +20 -1
- data/lib/purecloud/models/ticker.rb +20 -1
- data/lib/purecloud/models/tier.rb +20 -1
- data/lib/purecloud/models/time_allowed.rb +20 -1
- data/lib/purecloud/models/time_interval.rb +20 -1
- data/lib/purecloud/models/time_slot.rb +20 -1
- data/lib/purecloud/models/time_zone.rb +20 -1
- data/lib/purecloud/models/time_zone_entity_listing.rb +20 -1
- data/lib/purecloud/models/trace.rb +20 -1
- data/lib/purecloud/models/trace_list.rb +20 -1
- data/lib/purecloud/models/transfer_request.rb +20 -1
- data/lib/purecloud/models/transform_endpoint.rb +20 -1
- data/lib/purecloud/models/transform_lens.rb +20 -1
- data/lib/purecloud/models/trunk_base.rb +21 -2
- data/lib/purecloud/models/trunk_base_assignment.rb +20 -1
- data/lib/purecloud/models/trunk_metabase_entity_listing.rb +20 -1
- data/lib/purecloud/models/twitter_expression.rb +20 -1
- data/lib/purecloud/models/twitter_expression_buffer.rb +20 -1
- data/lib/purecloud/models/unpivot_columns.rb +20 -1
- data/lib/purecloud/models/unread_metric.rb +20 -1
- data/lib/purecloud/models/unread_status.rb +20 -1
- data/lib/purecloud/models/upload_progress.rb +20 -1
- data/lib/purecloud/models/uri_reference.rb +20 -1
- data/lib/purecloud/models/url_response.rb +20 -1
- data/lib/purecloud/models/user.rb +20 -1
- data/lib/purecloud/models/user_action_category.rb +20 -1
- data/lib/purecloud/models/user_action_category_entity_listing.rb +20 -1
- data/lib/purecloud/models/user_action_metadata.rb +20 -1
- data/lib/purecloud/models/user_action_metadata_entity_listing.rb +20 -1
- data/lib/purecloud/models/user_action_metadata_request.rb +20 -1
- data/lib/purecloud/models/user_authorization.rb +20 -1
- data/lib/purecloud/models/user_conversation_summary.rb +20 -1
- data/lib/purecloud/models/user_entity_listing.rb +20 -1
- data/lib/purecloud/models/user_image.rb +20 -1
- data/lib/purecloud/models/user_license_assignment.rb +20 -1
- data/lib/purecloud/models/user_me.rb +21 -2
- data/lib/purecloud/models/user_param.rb +20 -1
- data/lib/purecloud/models/user_presence.rb +20 -1
- data/lib/purecloud/models/user_queue.rb +20 -1
- data/lib/purecloud/models/user_queue_entity_listing.rb +20 -1
- data/lib/purecloud/models/user_recording.rb +20 -1
- data/lib/purecloud/models/user_recording_entity_listing.rb +20 -1
- data/lib/purecloud/models/user_routing_skill.rb +20 -1
- data/lib/purecloud/models/user_skill_entity_listing.rb +20 -1
- data/lib/purecloud/models/user_station.rb +20 -1
- data/lib/purecloud/models/user_stations.rb +20 -1
- data/lib/purecloud/models/users_entity_listing.rb +20 -1
- data/lib/purecloud/models/users_search_response.rb +20 -1
- data/lib/purecloud/models/utilization.rb +20 -1
- data/lib/purecloud/models/validate_address_request.rb +20 -1
- data/lib/purecloud/models/validate_address_response.rb +20 -1
- data/lib/purecloud/models/value.rb +20 -1
- data/lib/purecloud/models/vendor_connection_request.rb +20 -1
- data/lib/purecloud/models/video.rb +20 -1
- data/lib/purecloud/models/video_conversation.rb +20 -1
- data/lib/purecloud/models/video_conversation_entity_listing.rb +20 -1
- data/lib/purecloud/models/video_media_participant.rb +20 -1
- data/lib/purecloud/models/view.rb +20 -1
- data/lib/purecloud/models/voice_rate.rb +20 -1
- data/lib/purecloud/models/voice_rate_extended.rb +20 -1
- data/lib/purecloud/models/voice_rate_international.rb +20 -1
- data/lib/purecloud/models/voice_rate_international_entity_listing.rb +20 -1
- data/lib/purecloud/models/voice_rate_update.rb +20 -1
- data/lib/purecloud/models/voice_rates_csv.rb +20 -1
- data/lib/purecloud/models/voice_xml_operation.rb +20 -1
- data/lib/purecloud/models/voice_xml_operation_entity_listing.rb +20 -1
- data/lib/purecloud/models/voicemail_mailbox_info.rb +20 -1
- data/lib/purecloud/models/voicemail_media_info.rb +20 -1
- data/lib/purecloud/models/voicemail_message.rb +20 -1
- data/lib/purecloud/models/voicemail_message_entity_listing.rb +20 -1
- data/lib/purecloud/models/voicemail_organization_policy.rb +20 -1
- data/lib/purecloud/models/voicemail_user_policy.rb +20 -1
- data/lib/purecloud/models/vpn.rb +20 -1
- data/lib/purecloud/models/work_item.rb +20 -1
- data/lib/purecloud/models/work_item_actions.rb +20 -1
- data/lib/purecloud/models/work_item_cache.rb +20 -1
- data/lib/purecloud/models/work_item_command.rb +20 -1
- data/lib/purecloud/models/work_item_command_group.rb +20 -1
- data/lib/purecloud/models/work_item_definition.rb +20 -1
- data/lib/purecloud/models/work_item_details.rb +20 -1
- data/lib/purecloud/models/work_item_search_details.rb +20 -1
- data/lib/purecloud/models/work_item_search_details_search_result.rb +20 -1
- data/lib/purecloud/models/work_item_submit_request.rb +20 -1
- data/lib/purecloud/models/work_item_transfer_request.rb +20 -1
- data/lib/purecloud/models/workspace.rb +20 -1
- data/lib/purecloud/models/workspace_create.rb +20 -1
- data/lib/purecloud/models/workspace_entity_listing.rb +20 -1
- data/lib/purecloud/models/workspace_member.rb +20 -1
- data/lib/purecloud/models/workspace_member_entity_listing.rb +20 -1
- data/lib/purecloud/models/workspace_summary.rb +20 -1
- data/lib/purecloud/models/wrap_up_code_mapping.rb +20 -1
- data/lib/purecloud/models/wrapup.rb +20 -1
- data/lib/purecloud/models/wrapup_code.rb +20 -1
- data/lib/purecloud/models/wrapup_code_entity_listing.rb +20 -1
- data/lib/purecloud/models/xlsx_schema.rb +20 -1
- data/lib/purecloud/version.rb +17 -1
- data/purecloud.gemspec +3 -4
- data/rakefile +13 -23
- data/spec/test.rb +109 -8
- data/swagger_template/README.mustache +72 -0
- data/swagger_template/api_client.mustache +36 -14
- data/swagger_template/api_doc.mustache +80 -0
- data/swagger_template/base_object.mustache +4 -1
- data/swagger_template/gemspec.mustache +3 -4
- data/swagger_template/gitignore.mustache +44 -0
- data/swagger_template/model_doc.mustache +15 -0
- data/version.json +1 -1
- metadata +732 -34
- data/doc/template/default/layout/html/layout.erb +0 -4
- data/doc/template/default/method_details/html/source.erb +0 -0
- data/doc/template/default/module/html/attribute_summary.erb +0 -8
- data/doc/template/default/module/html/box_info.erb +0 -0
- data/doc/template/default/module/html/children.erb +0 -0
- data/lib/purecloud/models/line_properties.rb +0 -136
- data/newVersion.md +0 -1
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: OrganizationPresenceEntityListing
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::OrganizationPresenceEntityListing
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **page_size** | **Integer** | | [optional] |
|
|
11
|
+
| **page_number** | **Integer** | | [optional] |
|
|
12
|
+
| **total** | **Integer** | | [optional] |
|
|
13
|
+
| **entities** | [**Array<OrganizationPresence>**](OrganizationPresence.html) | | [optional] |
|
|
14
|
+
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
|
+
| **page_count** | **Integer** | | [optional] |
|
|
20
|
+
{: class="table table-striped"}
|
|
21
|
+
|
|
22
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: OrganizationProductEntityListing
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::OrganizationProductEntityListing
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **page_size** | **Integer** | | [optional] |
|
|
11
|
+
| **page_number** | **Integer** | | [optional] |
|
|
12
|
+
| **total** | **Integer** | | [optional] |
|
|
13
|
+
| **entities** | [**Array<DomainOrganizationProduct>**](DomainOrganizationProduct.html) | | [optional] |
|
|
14
|
+
| **page_count** | **Integer** | | [optional] |
|
|
15
|
+
{: class="table table-striped"}
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: OrganizationRoleEntityListing
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::OrganizationRoleEntityListing
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **page_size** | **Integer** | | [optional] |
|
|
11
|
+
| **page_number** | **Integer** | | [optional] |
|
|
12
|
+
| **total** | **Integer** | | [optional] |
|
|
13
|
+
| **entities** | [**Array<DomainOrganizationRole>**](DomainOrganizationRole.html) | | [optional] |
|
|
14
|
+
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
|
+
| **page_count** | **Integer** | | [optional] |
|
|
20
|
+
{: class="table table-striped"}
|
|
21
|
+
|
|
22
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: OrphanRecording
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::OrphanRecording
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
|
+
| **name** | **String** | | [optional] |
|
|
12
|
+
| **created_time** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
13
|
+
| **recovered_time** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
14
|
+
| **provider_type** | **String** | | [optional] |
|
|
15
|
+
| **media_size_bytes** | **Integer** | | [optional] |
|
|
16
|
+
| **media_type** | **String** | | [optional] |
|
|
17
|
+
| **file_state** | **String** | | [optional] |
|
|
18
|
+
| **provider_endpoint** | [**Endpoint**](Endpoint.html) | | [optional] |
|
|
19
|
+
| **recording** | [**Recording**](Recording.html) | | [optional] |
|
|
20
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
21
|
+
{: class="table table-striped"}
|
|
22
|
+
|
|
23
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: OrphanRecordingListing
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::OrphanRecordingListing
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **page_size** | **Integer** | | [optional] |
|
|
11
|
+
| **page_number** | **Integer** | | [optional] |
|
|
12
|
+
| **total** | **Integer** | | [optional] |
|
|
13
|
+
| **entities** | [**Array<OrphanRecording>**](OrphanRecording.html) | | [optional] |
|
|
14
|
+
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
|
+
| **page_count** | **Integer** | | [optional] |
|
|
20
|
+
{: class="table table-striped"}
|
|
21
|
+
|
|
22
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: OutOfOffice
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::OutOfOffice
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
|
+
| **name** | **String** | | [optional] |
|
|
12
|
+
| **user** | [**User**](User.html) | | [optional] |
|
|
13
|
+
| **start_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
14
|
+
| **end_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
15
|
+
| **active** | **BOOLEAN** | | [optional] [default to false]|
|
|
16
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
17
|
+
{: class="table table-striped"}
|
|
18
|
+
|
|
19
|
+
|
|
@@ -0,0 +1,3780 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: OutboundApi
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
## PureCloud::OutboundApi
|
|
6
|
+
|
|
7
|
+
All URIs are relative to *https://api.mypurecloud.com*
|
|
8
|
+
|
|
9
|
+
Method | HTTP request | Description
|
|
10
|
+
------------- | ------------- | -------------
|
|
11
|
+
|[**delete_callabletimesets_callabletimeset_id**](OutboundApi.html#delete_callabletimesets_callabletimeset_id) | **DELETE** /api/v2/outbound/callabletimesets/{callableTimeSetId} | Delete callable time set|
|
|
12
|
+
|[**delete_callanalysisresponsesets_callanalysisset_id**](OutboundApi.html#delete_callanalysisresponsesets_callanalysisset_id) | **DELETE** /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId} | Delete a dialer call analysis response set.|
|
|
13
|
+
|[**delete_campaigns_campaign_id**](OutboundApi.html#delete_campaigns_campaign_id) | **DELETE** /api/v2/outbound/campaigns/{campaignId} | Delete a campaign.|
|
|
14
|
+
|[**delete_campaigns_campaign_id_progress**](OutboundApi.html#delete_campaigns_campaign_id_progress) | **DELETE** /api/v2/outbound/campaigns/{campaignId}/progress | Reset campaign progress and recycle the campaign|
|
|
15
|
+
|[**delete_contactlists_contactlist_id**](OutboundApi.html#delete_contactlists_contactlist_id) | **DELETE** /api/v2/outbound/contactlists/{contactListId} | Delete a contact list.|
|
|
16
|
+
|[**delete_contactlists_contactlist_id_contacts_contact_id**](OutboundApi.html#delete_contactlists_contactlist_id_contacts_contact_id) | **DELETE** /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId} | Delete a contact.|
|
|
17
|
+
|[**delete_dnclists_dnclist_id**](OutboundApi.html#delete_dnclists_dnclist_id) | **DELETE** /api/v2/outbound/dnclists/{dncListId} | Delete dialer DNC list|
|
|
18
|
+
|[**delete_rulesets_ruleset_id**](OutboundApi.html#delete_rulesets_ruleset_id) | **DELETE** /api/v2/outbound/rulesets/{ruleSetId} | Delete a Rule set.|
|
|
19
|
+
|[**delete_schedules_campaigns_campaign_id**](OutboundApi.html#delete_schedules_campaigns_campaign_id) | **DELETE** /api/v2/outbound/schedules/campaigns/{campaignId} | Delete a dialer campaign schedule.|
|
|
20
|
+
|[**delete_schedules_sequences_sequence_id**](OutboundApi.html#delete_schedules_sequences_sequence_id) | **DELETE** /api/v2/outbound/schedules/sequences/{sequenceId} | Delete a dialer sequence schedule.|
|
|
21
|
+
|[**delete_sequences_sequence_id**](OutboundApi.html#delete_sequences_sequence_id) | **DELETE** /api/v2/outbound/sequences/{sequenceId} | Delete a dialer campaign sequence.|
|
|
22
|
+
|[**get_callabletimesets**](OutboundApi.html#get_callabletimesets) | **GET** /api/v2/outbound/callabletimesets | Query callable time set list|
|
|
23
|
+
|[**get_callabletimesets_callabletimeset_id**](OutboundApi.html#get_callabletimesets_callabletimeset_id) | **GET** /api/v2/outbound/callabletimesets/{callableTimeSetId} | Get callable time set|
|
|
24
|
+
|[**get_callanalysisresponsesets**](OutboundApi.html#get_callanalysisresponsesets) | **GET** /api/v2/outbound/callanalysisresponsesets | Query a list of dialer call analysis response sets.|
|
|
25
|
+
|[**get_callanalysisresponsesets_callanalysisset_id**](OutboundApi.html#get_callanalysisresponsesets_callanalysisset_id) | **GET** /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId} | Get a dialer call analysis response set.|
|
|
26
|
+
|[**get_campaigns**](OutboundApi.html#get_campaigns) | **GET** /api/v2/outbound/campaigns | Query a list of dialer campaigns.|
|
|
27
|
+
|[**get_campaigns_campaign_id**](OutboundApi.html#get_campaigns_campaign_id) | **GET** /api/v2/outbound/campaigns/{campaignId} | Get dialer campaign.|
|
|
28
|
+
|[**get_campaigns_campaign_id_diagnostics**](OutboundApi.html#get_campaigns_campaign_id_diagnostics) | **GET** /api/v2/outbound/campaigns/{campaignId}/diagnostics | Get campaign diagnostics|
|
|
29
|
+
|[**get_campaigns_campaign_id_progress**](OutboundApi.html#get_campaigns_campaign_id_progress) | **GET** /api/v2/outbound/campaigns/{campaignId}/progress | Get campaign progress|
|
|
30
|
+
|[**get_campaigns_campaign_id_stats**](OutboundApi.html#get_campaigns_campaign_id_stats) | **GET** /api/v2/outbound/campaigns/{campaignId}/stats | Get statistics about a Dialer Campaign|
|
|
31
|
+
|[**get_contactlists**](OutboundApi.html#get_contactlists) | **GET** /api/v2/outbound/contactlists | Query a list of contact lists.|
|
|
32
|
+
|[**get_contactlists_contactlist_id**](OutboundApi.html#get_contactlists_contactlist_id) | **GET** /api/v2/outbound/contactlists/{contactListId} | Get dialer contactList.|
|
|
33
|
+
|[**get_contactlists_contactlist_id_contacts_contact_id**](OutboundApi.html#get_contactlists_contactlist_id_contacts_contact_id) | **GET** /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId} | Get dialer contactList.|
|
|
34
|
+
|[**get_contactlists_contactlist_id_importstatus**](OutboundApi.html#get_contactlists_contactlist_id_importstatus) | **GET** /api/v2/outbound/contactlists/{contactListId}/importstatus | Get dialer contactList import status.|
|
|
35
|
+
|[**get_dnclists**](OutboundApi.html#get_dnclists) | **GET** /api/v2/outbound/dnclists | Query dialer DNC lists|
|
|
36
|
+
|[**get_dnclists_dnclist_id**](OutboundApi.html#get_dnclists_dnclist_id) | **GET** /api/v2/outbound/dnclists/{dncListId} | Get dialer DNC list|
|
|
37
|
+
|[**get_dnclists_dnclist_id_importstatus**](OutboundApi.html#get_dnclists_dnclist_id_importstatus) | **GET** /api/v2/outbound/dnclists/{dncListId}/importstatus | Get dialer dncList import status.|
|
|
38
|
+
|[**get_rulesets**](OutboundApi.html#get_rulesets) | **GET** /api/v2/outbound/rulesets | Query a list of Rule Sets.|
|
|
39
|
+
|[**get_rulesets_ruleset_id**](OutboundApi.html#get_rulesets_ruleset_id) | **GET** /api/v2/outbound/rulesets/{ruleSetId} | Get a Rule Set by ID.|
|
|
40
|
+
|[**get_schedules_campaigns**](OutboundApi.html#get_schedules_campaigns) | **GET** /api/v2/outbound/schedules/campaigns | Query for a list of dialer campaign schedules.|
|
|
41
|
+
|[**get_schedules_campaigns_campaign_id**](OutboundApi.html#get_schedules_campaigns_campaign_id) | **GET** /api/v2/outbound/schedules/campaigns/{campaignId} | Get a dialer campaign schedule.|
|
|
42
|
+
|[**get_schedules_sequences**](OutboundApi.html#get_schedules_sequences) | **GET** /api/v2/outbound/schedules/sequences | Query for a list of dialer sequence schedules.|
|
|
43
|
+
|[**get_schedules_sequences_sequence_id**](OutboundApi.html#get_schedules_sequences_sequence_id) | **GET** /api/v2/outbound/schedules/sequences/{sequenceId} | Get a dialer sequence schedule.|
|
|
44
|
+
|[**get_sequences**](OutboundApi.html#get_sequences) | **GET** /api/v2/outbound/sequences | Query a list of dialer campaign sequences.|
|
|
45
|
+
|[**get_sequences_sequence_id**](OutboundApi.html#get_sequences_sequence_id) | **GET** /api/v2/outbound/sequences/{sequenceId} | Get a dialer campaign sequence.|
|
|
46
|
+
|[**get_wrapupcodemappings**](OutboundApi.html#get_wrapupcodemappings) | **GET** /api/v2/outbound/wrapupcodemappings | Get the Dialer wrap up code mapping.|
|
|
47
|
+
|[**post_audits**](OutboundApi.html#post_audits) | **POST** /api/v2/outbound/audits | Retrieves audits for dialer.|
|
|
48
|
+
|[**post_callabletimesets**](OutboundApi.html#post_callabletimesets) | **POST** /api/v2/outbound/callabletimesets | Create callable time set|
|
|
49
|
+
|[**post_callanalysisresponsesets**](OutboundApi.html#post_callanalysisresponsesets) | **POST** /api/v2/outbound/callanalysisresponsesets | Create a dialer call analysis response set.|
|
|
50
|
+
|[**post_campaigns**](OutboundApi.html#post_campaigns) | **POST** /api/v2/outbound/campaigns | Create a campaign.|
|
|
51
|
+
|[**post_campaigns_campaign_id_callback_schedule**](OutboundApi.html#post_campaigns_campaign_id_callback_schedule) | **POST** /api/v2/outbound/campaigns/{campaignId}/callback/schedule | Schedule a Callback for a Dialer Campaign|
|
|
52
|
+
|[**post_campaigns_progress**](OutboundApi.html#post_campaigns_progress) | **POST** /api/v2/outbound/campaigns/progress | Get progress for a list of campaigns|
|
|
53
|
+
|[**post_contactlists**](OutboundApi.html#post_contactlists) | **POST** /api/v2/outbound/contactlists | Create a contact List.|
|
|
54
|
+
|[**post_contactlists_contactlist_id_contacts**](OutboundApi.html#post_contactlists_contactlist_id_contacts) | **POST** /api/v2/outbound/contactlists/{contactListId}/contacts | Add contacts to a contact list.|
|
|
55
|
+
|[**post_contactlists_contactlist_id_export**](OutboundApi.html#post_contactlists_contactlist_id_export) | **POST** /api/v2/outbound/contactlists/{contactListId}/export | Initiate the export of a contact list.|
|
|
56
|
+
|[**post_conversations_conversation_id_dnc**](OutboundApi.html#post_conversations_conversation_id_dnc) | **POST** /api/v2/outbound/conversations/{conversationId}/dnc | Add phone numbers to a Dialer DNC list.|
|
|
57
|
+
|[**post_dnclists**](OutboundApi.html#post_dnclists) | **POST** /api/v2/outbound/dnclists | Create dialer DNC list|
|
|
58
|
+
|[**post_dnclists_dnclist_id_export**](OutboundApi.html#post_dnclists_dnclist_id_export) | **POST** /api/v2/outbound/dnclists/{dncListId}/export | Initiate the export of a dnc list.|
|
|
59
|
+
|[**post_dnclists_dnclist_id_phonenumbers**](OutboundApi.html#post_dnclists_dnclist_id_phonenumbers) | **POST** /api/v2/outbound/dnclists/{dncListId}/phonenumbers | Add phone numbers to a Dialer DNC list.|
|
|
60
|
+
|[**post_rulesets**](OutboundApi.html#post_rulesets) | **POST** /api/v2/outbound/rulesets | Create a Dialer Call Analysis Response Set.|
|
|
61
|
+
|[**post_sequences**](OutboundApi.html#post_sequences) | **POST** /api/v2/outbound/sequences | Create a new campaign sequence.|
|
|
62
|
+
|[**put_callabletimesets_callabletimeset_id**](OutboundApi.html#put_callabletimesets_callabletimeset_id) | **PUT** /api/v2/outbound/callabletimesets/{callableTimeSetId} | Update callable time set|
|
|
63
|
+
|[**put_callanalysisresponsesets_callanalysisset_id**](OutboundApi.html#put_callanalysisresponsesets_callanalysisset_id) | **PUT** /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId} | Update a dialer call analysis response set.|
|
|
64
|
+
|[**put_campaigns_campaign_id**](OutboundApi.html#put_campaigns_campaign_id) | **PUT** /api/v2/outbound/campaigns/{campaignId} | Update a campaign.|
|
|
65
|
+
|[**put_campaigns_campaign_id_agents_user_id**](OutboundApi.html#put_campaigns_campaign_id_agents_user_id) | **PUT** /api/v2/outbound/campaigns/{campaignId}/agents/{userId} | Send notification that an agent's state changed |
|
|
66
|
+
|[**put_contactlists_contactlist_id**](OutboundApi.html#put_contactlists_contactlist_id) | **PUT** /api/v2/outbound/contactlists/{contactListId} | Update a contact list.|
|
|
67
|
+
|[**put_contactlists_contactlist_id_contacts_contact_id**](OutboundApi.html#put_contactlists_contactlist_id_contacts_contact_id) | **PUT** /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId} | Update a contact.|
|
|
68
|
+
|[**put_dnclists_dnclist_id**](OutboundApi.html#put_dnclists_dnclist_id) | **PUT** /api/v2/outbound/dnclists/{dncListId} | Update dialer DNC list|
|
|
69
|
+
|[**put_rulesets_ruleset_id**](OutboundApi.html#put_rulesets_ruleset_id) | **PUT** /api/v2/outbound/rulesets/{ruleSetId} | Update a RuleSet.|
|
|
70
|
+
|[**put_schedules_campaigns_campaign_id**](OutboundApi.html#put_schedules_campaigns_campaign_id) | **PUT** /api/v2/outbound/schedules/campaigns/{campaignId} | Update a new campaign schedule.|
|
|
71
|
+
|[**put_schedules_sequences_sequence_id**](OutboundApi.html#put_schedules_sequences_sequence_id) | **PUT** /api/v2/outbound/schedules/sequences/{sequenceId} | Update a new sequence schedule.|
|
|
72
|
+
|[**put_sequences_sequence_id**](OutboundApi.html#put_sequences_sequence_id) | **PUT** /api/v2/outbound/sequences/{sequenceId} | Update a new campaign sequence.|
|
|
73
|
+
|[**put_wrapupcodemappings**](OutboundApi.html#put_wrapupcodemappings) | **PUT** /api/v2/outbound/wrapupcodemappings | Update the Dialer wrap up code mapping.|
|
|
74
|
+
{: class="table table-striped"}
|
|
75
|
+
|
|
76
|
+
<a name="delete_callabletimesets_callabletimeset_id"></a>
|
|
77
|
+
|
|
78
|
+
## -String** delete_callabletimesets_callabletimeset_id(callable_time_set_id)
|
|
79
|
+
|
|
80
|
+
Delete callable time set
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
### Example
|
|
85
|
+
~~~ruby
|
|
86
|
+
# load the gem
|
|
87
|
+
require 'purecloud'
|
|
88
|
+
# setup authorization
|
|
89
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
90
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
91
|
+
environment = "mypurecloud.com"
|
|
92
|
+
|
|
93
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
94
|
+
|
|
95
|
+
PureCloud.configure do |config|
|
|
96
|
+
config.access_token = @authToken
|
|
97
|
+
end
|
|
98
|
+
|
|
99
|
+
api_instance = PureCloud::OutboundApi.new
|
|
100
|
+
|
|
101
|
+
callable_time_set_id = "callable_time_set_id_example" # String | Callable Time Set ID
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
begin
|
|
105
|
+
#Delete callable time set
|
|
106
|
+
result = api_instance.delete_callabletimesets_callabletimeset_id(callable_time_set_id)
|
|
107
|
+
p result
|
|
108
|
+
rescue PureCloud::ApiError => e
|
|
109
|
+
puts "Exception when calling OutboundApi->delete_callabletimesets_callabletimeset_id: #{e}"
|
|
110
|
+
end
|
|
111
|
+
~~~
|
|
112
|
+
|
|
113
|
+
### Parameters
|
|
114
|
+
|
|
115
|
+
Name | Type | Description | Notes
|
|
116
|
+
------------- | ------------- | ------------- | -------------
|
|
117
|
+
**callable_time_set_id** | **String**| Callable Time Set ID |
|
|
118
|
+
{: class="table table-striped"}
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
### Return type
|
|
122
|
+
|
|
123
|
+
**String**
|
|
124
|
+
|
|
125
|
+
### HTTP request headers
|
|
126
|
+
|
|
127
|
+
- **Content-Type**: application/json
|
|
128
|
+
- **Accept**: application/json
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
<a name="delete_callanalysisresponsesets_callanalysisset_id"></a>
|
|
133
|
+
|
|
134
|
+
## -String** delete_callanalysisresponsesets_callanalysisset_id(call_analysis_set_id)
|
|
135
|
+
|
|
136
|
+
Delete a dialer call analysis response set.
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
### Example
|
|
141
|
+
~~~ruby
|
|
142
|
+
# load the gem
|
|
143
|
+
require 'purecloud'
|
|
144
|
+
# setup authorization
|
|
145
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
146
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
147
|
+
environment = "mypurecloud.com"
|
|
148
|
+
|
|
149
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
150
|
+
|
|
151
|
+
PureCloud.configure do |config|
|
|
152
|
+
config.access_token = @authToken
|
|
153
|
+
end
|
|
154
|
+
|
|
155
|
+
api_instance = PureCloud::OutboundApi.new
|
|
156
|
+
|
|
157
|
+
call_analysis_set_id = "call_analysis_set_id_example" # String | Call Analysis Response Set ID
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
begin
|
|
161
|
+
#Delete a dialer call analysis response set.
|
|
162
|
+
result = api_instance.delete_callanalysisresponsesets_callanalysisset_id(call_analysis_set_id)
|
|
163
|
+
p result
|
|
164
|
+
rescue PureCloud::ApiError => e
|
|
165
|
+
puts "Exception when calling OutboundApi->delete_callanalysisresponsesets_callanalysisset_id: #{e}"
|
|
166
|
+
end
|
|
167
|
+
~~~
|
|
168
|
+
|
|
169
|
+
### Parameters
|
|
170
|
+
|
|
171
|
+
Name | Type | Description | Notes
|
|
172
|
+
------------- | ------------- | ------------- | -------------
|
|
173
|
+
**call_analysis_set_id** | **String**| Call Analysis Response Set ID |
|
|
174
|
+
{: class="table table-striped"}
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
### Return type
|
|
178
|
+
|
|
179
|
+
**String**
|
|
180
|
+
|
|
181
|
+
### HTTP request headers
|
|
182
|
+
|
|
183
|
+
- **Content-Type**: application/json
|
|
184
|
+
- **Accept**: application/json
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
<a name="delete_campaigns_campaign_id"></a>
|
|
189
|
+
|
|
190
|
+
## -String** delete_campaigns_campaign_id(campaign_id)
|
|
191
|
+
|
|
192
|
+
Delete a campaign.
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
### Example
|
|
197
|
+
~~~ruby
|
|
198
|
+
# load the gem
|
|
199
|
+
require 'purecloud'
|
|
200
|
+
# setup authorization
|
|
201
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
202
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
203
|
+
environment = "mypurecloud.com"
|
|
204
|
+
|
|
205
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
206
|
+
|
|
207
|
+
PureCloud.configure do |config|
|
|
208
|
+
config.access_token = @authToken
|
|
209
|
+
end
|
|
210
|
+
|
|
211
|
+
api_instance = PureCloud::OutboundApi.new
|
|
212
|
+
|
|
213
|
+
campaign_id = "campaign_id_example" # String | Campaign ID
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
begin
|
|
217
|
+
#Delete a campaign.
|
|
218
|
+
result = api_instance.delete_campaigns_campaign_id(campaign_id)
|
|
219
|
+
p result
|
|
220
|
+
rescue PureCloud::ApiError => e
|
|
221
|
+
puts "Exception when calling OutboundApi->delete_campaigns_campaign_id: #{e}"
|
|
222
|
+
end
|
|
223
|
+
~~~
|
|
224
|
+
|
|
225
|
+
### Parameters
|
|
226
|
+
|
|
227
|
+
Name | Type | Description | Notes
|
|
228
|
+
------------- | ------------- | ------------- | -------------
|
|
229
|
+
**campaign_id** | **String**| Campaign ID |
|
|
230
|
+
{: class="table table-striped"}
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
### Return type
|
|
234
|
+
|
|
235
|
+
**String**
|
|
236
|
+
|
|
237
|
+
### HTTP request headers
|
|
238
|
+
|
|
239
|
+
- **Content-Type**: application/json
|
|
240
|
+
- **Accept**: application/json
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
<a name="delete_campaigns_campaign_id_progress"></a>
|
|
245
|
+
|
|
246
|
+
## -String** delete_campaigns_campaign_id_progress(campaign_id)
|
|
247
|
+
|
|
248
|
+
Reset campaign progress and recycle the campaign
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
### Example
|
|
253
|
+
~~~ruby
|
|
254
|
+
# load the gem
|
|
255
|
+
require 'purecloud'
|
|
256
|
+
# setup authorization
|
|
257
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
258
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
259
|
+
environment = "mypurecloud.com"
|
|
260
|
+
|
|
261
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
262
|
+
|
|
263
|
+
PureCloud.configure do |config|
|
|
264
|
+
config.access_token = @authToken
|
|
265
|
+
end
|
|
266
|
+
|
|
267
|
+
api_instance = PureCloud::OutboundApi.new
|
|
268
|
+
|
|
269
|
+
campaign_id = "campaign_id_example" # String | Campaign ID
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
begin
|
|
273
|
+
#Reset campaign progress and recycle the campaign
|
|
274
|
+
result = api_instance.delete_campaigns_campaign_id_progress(campaign_id)
|
|
275
|
+
p result
|
|
276
|
+
rescue PureCloud::ApiError => e
|
|
277
|
+
puts "Exception when calling OutboundApi->delete_campaigns_campaign_id_progress: #{e}"
|
|
278
|
+
end
|
|
279
|
+
~~~
|
|
280
|
+
|
|
281
|
+
### Parameters
|
|
282
|
+
|
|
283
|
+
Name | Type | Description | Notes
|
|
284
|
+
------------- | ------------- | ------------- | -------------
|
|
285
|
+
**campaign_id** | **String**| Campaign ID |
|
|
286
|
+
{: class="table table-striped"}
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
### Return type
|
|
290
|
+
|
|
291
|
+
**String**
|
|
292
|
+
|
|
293
|
+
### HTTP request headers
|
|
294
|
+
|
|
295
|
+
- **Content-Type**: application/json
|
|
296
|
+
- **Accept**: application/json
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
<a name="delete_contactlists_contactlist_id"></a>
|
|
301
|
+
|
|
302
|
+
## -String** delete_contactlists_contactlist_id(contact_list_id)
|
|
303
|
+
|
|
304
|
+
Delete a contact list.
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
### Example
|
|
309
|
+
~~~ruby
|
|
310
|
+
# load the gem
|
|
311
|
+
require 'purecloud'
|
|
312
|
+
# setup authorization
|
|
313
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
314
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
315
|
+
environment = "mypurecloud.com"
|
|
316
|
+
|
|
317
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
318
|
+
|
|
319
|
+
PureCloud.configure do |config|
|
|
320
|
+
config.access_token = @authToken
|
|
321
|
+
end
|
|
322
|
+
|
|
323
|
+
api_instance = PureCloud::OutboundApi.new
|
|
324
|
+
|
|
325
|
+
contact_list_id = "contact_list_id_example" # String | ContactList ID
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
begin
|
|
329
|
+
#Delete a contact list.
|
|
330
|
+
result = api_instance.delete_contactlists_contactlist_id(contact_list_id)
|
|
331
|
+
p result
|
|
332
|
+
rescue PureCloud::ApiError => e
|
|
333
|
+
puts "Exception when calling OutboundApi->delete_contactlists_contactlist_id: #{e}"
|
|
334
|
+
end
|
|
335
|
+
~~~
|
|
336
|
+
|
|
337
|
+
### Parameters
|
|
338
|
+
|
|
339
|
+
Name | Type | Description | Notes
|
|
340
|
+
------------- | ------------- | ------------- | -------------
|
|
341
|
+
**contact_list_id** | **String**| ContactList ID |
|
|
342
|
+
{: class="table table-striped"}
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
### Return type
|
|
346
|
+
|
|
347
|
+
**String**
|
|
348
|
+
|
|
349
|
+
### HTTP request headers
|
|
350
|
+
|
|
351
|
+
- **Content-Type**: application/json
|
|
352
|
+
- **Accept**: application/json
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
<a name="delete_contactlists_contactlist_id_contacts_contact_id"></a>
|
|
357
|
+
|
|
358
|
+
## -String** delete_contactlists_contactlist_id_contacts_contact_id(contact_list_id, contact_id)
|
|
359
|
+
|
|
360
|
+
Delete a contact.
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
### Example
|
|
365
|
+
~~~ruby
|
|
366
|
+
# load the gem
|
|
367
|
+
require 'purecloud'
|
|
368
|
+
# setup authorization
|
|
369
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
370
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
371
|
+
environment = "mypurecloud.com"
|
|
372
|
+
|
|
373
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
374
|
+
|
|
375
|
+
PureCloud.configure do |config|
|
|
376
|
+
config.access_token = @authToken
|
|
377
|
+
end
|
|
378
|
+
|
|
379
|
+
api_instance = PureCloud::OutboundApi.new
|
|
380
|
+
|
|
381
|
+
contact_list_id = "contact_list_id_example" # String | Contact List ID
|
|
382
|
+
|
|
383
|
+
contact_id = "contact_id_example" # String | Contact ID
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
begin
|
|
387
|
+
#Delete a contact.
|
|
388
|
+
result = api_instance.delete_contactlists_contactlist_id_contacts_contact_id(contact_list_id, contact_id)
|
|
389
|
+
p result
|
|
390
|
+
rescue PureCloud::ApiError => e
|
|
391
|
+
puts "Exception when calling OutboundApi->delete_contactlists_contactlist_id_contacts_contact_id: #{e}"
|
|
392
|
+
end
|
|
393
|
+
~~~
|
|
394
|
+
|
|
395
|
+
### Parameters
|
|
396
|
+
|
|
397
|
+
Name | Type | Description | Notes
|
|
398
|
+
------------- | ------------- | ------------- | -------------
|
|
399
|
+
**contact_list_id** | **String**| Contact List ID |
|
|
400
|
+
**contact_id** | **String**| Contact ID |
|
|
401
|
+
{: class="table table-striped"}
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
### Return type
|
|
405
|
+
|
|
406
|
+
**String**
|
|
407
|
+
|
|
408
|
+
### HTTP request headers
|
|
409
|
+
|
|
410
|
+
- **Content-Type**: application/json
|
|
411
|
+
- **Accept**: application/json
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
<a name="delete_dnclists_dnclist_id"></a>
|
|
416
|
+
|
|
417
|
+
## -String** delete_dnclists_dnclist_id(dnc_list_id)
|
|
418
|
+
|
|
419
|
+
Delete dialer DNC list
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
### Example
|
|
424
|
+
~~~ruby
|
|
425
|
+
# load the gem
|
|
426
|
+
require 'purecloud'
|
|
427
|
+
# setup authorization
|
|
428
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
429
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
430
|
+
environment = "mypurecloud.com"
|
|
431
|
+
|
|
432
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
433
|
+
|
|
434
|
+
PureCloud.configure do |config|
|
|
435
|
+
config.access_token = @authToken
|
|
436
|
+
end
|
|
437
|
+
|
|
438
|
+
api_instance = PureCloud::OutboundApi.new
|
|
439
|
+
|
|
440
|
+
dnc_list_id = "dnc_list_id_example" # String | DncList ID
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
begin
|
|
444
|
+
#Delete dialer DNC list
|
|
445
|
+
result = api_instance.delete_dnclists_dnclist_id(dnc_list_id)
|
|
446
|
+
p result
|
|
447
|
+
rescue PureCloud::ApiError => e
|
|
448
|
+
puts "Exception when calling OutboundApi->delete_dnclists_dnclist_id: #{e}"
|
|
449
|
+
end
|
|
450
|
+
~~~
|
|
451
|
+
|
|
452
|
+
### Parameters
|
|
453
|
+
|
|
454
|
+
Name | Type | Description | Notes
|
|
455
|
+
------------- | ------------- | ------------- | -------------
|
|
456
|
+
**dnc_list_id** | **String**| DncList ID |
|
|
457
|
+
{: class="table table-striped"}
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
### Return type
|
|
461
|
+
|
|
462
|
+
**String**
|
|
463
|
+
|
|
464
|
+
### HTTP request headers
|
|
465
|
+
|
|
466
|
+
- **Content-Type**: application/json
|
|
467
|
+
- **Accept**: application/json
|
|
468
|
+
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
<a name="delete_rulesets_ruleset_id"></a>
|
|
472
|
+
|
|
473
|
+
## -String** delete_rulesets_ruleset_id(rule_set_id)
|
|
474
|
+
|
|
475
|
+
Delete a Rule set.
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
### Example
|
|
480
|
+
~~~ruby
|
|
481
|
+
# load the gem
|
|
482
|
+
require 'purecloud'
|
|
483
|
+
# setup authorization
|
|
484
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
485
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
486
|
+
environment = "mypurecloud.com"
|
|
487
|
+
|
|
488
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
489
|
+
|
|
490
|
+
PureCloud.configure do |config|
|
|
491
|
+
config.access_token = @authToken
|
|
492
|
+
end
|
|
493
|
+
|
|
494
|
+
api_instance = PureCloud::OutboundApi.new
|
|
495
|
+
|
|
496
|
+
rule_set_id = "rule_set_id_example" # String | Rule Set ID
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
begin
|
|
500
|
+
#Delete a Rule set.
|
|
501
|
+
result = api_instance.delete_rulesets_ruleset_id(rule_set_id)
|
|
502
|
+
p result
|
|
503
|
+
rescue PureCloud::ApiError => e
|
|
504
|
+
puts "Exception when calling OutboundApi->delete_rulesets_ruleset_id: #{e}"
|
|
505
|
+
end
|
|
506
|
+
~~~
|
|
507
|
+
|
|
508
|
+
### Parameters
|
|
509
|
+
|
|
510
|
+
Name | Type | Description | Notes
|
|
511
|
+
------------- | ------------- | ------------- | -------------
|
|
512
|
+
**rule_set_id** | **String**| Rule Set ID |
|
|
513
|
+
{: class="table table-striped"}
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
### Return type
|
|
517
|
+
|
|
518
|
+
**String**
|
|
519
|
+
|
|
520
|
+
### HTTP request headers
|
|
521
|
+
|
|
522
|
+
- **Content-Type**: application/json
|
|
523
|
+
- **Accept**: application/json
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
<a name="delete_schedules_campaigns_campaign_id"></a>
|
|
528
|
+
|
|
529
|
+
## -String** delete_schedules_campaigns_campaign_id(campaign_id)
|
|
530
|
+
|
|
531
|
+
Delete a dialer campaign schedule.
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
### Example
|
|
536
|
+
~~~ruby
|
|
537
|
+
# load the gem
|
|
538
|
+
require 'purecloud'
|
|
539
|
+
# setup authorization
|
|
540
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
541
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
542
|
+
environment = "mypurecloud.com"
|
|
543
|
+
|
|
544
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
545
|
+
|
|
546
|
+
PureCloud.configure do |config|
|
|
547
|
+
config.access_token = @authToken
|
|
548
|
+
end
|
|
549
|
+
|
|
550
|
+
api_instance = PureCloud::OutboundApi.new
|
|
551
|
+
|
|
552
|
+
campaign_id = "campaign_id_example" # String | Campaign ID
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
begin
|
|
556
|
+
#Delete a dialer campaign schedule.
|
|
557
|
+
result = api_instance.delete_schedules_campaigns_campaign_id(campaign_id)
|
|
558
|
+
p result
|
|
559
|
+
rescue PureCloud::ApiError => e
|
|
560
|
+
puts "Exception when calling OutboundApi->delete_schedules_campaigns_campaign_id: #{e}"
|
|
561
|
+
end
|
|
562
|
+
~~~
|
|
563
|
+
|
|
564
|
+
### Parameters
|
|
565
|
+
|
|
566
|
+
Name | Type | Description | Notes
|
|
567
|
+
------------- | ------------- | ------------- | -------------
|
|
568
|
+
**campaign_id** | **String**| Campaign ID |
|
|
569
|
+
{: class="table table-striped"}
|
|
570
|
+
|
|
571
|
+
|
|
572
|
+
### Return type
|
|
573
|
+
|
|
574
|
+
**String**
|
|
575
|
+
|
|
576
|
+
### HTTP request headers
|
|
577
|
+
|
|
578
|
+
- **Content-Type**: application/json
|
|
579
|
+
- **Accept**: application/json
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
<a name="delete_schedules_sequences_sequence_id"></a>
|
|
584
|
+
|
|
585
|
+
## -String** delete_schedules_sequences_sequence_id(sequence_id)
|
|
586
|
+
|
|
587
|
+
Delete a dialer sequence schedule.
|
|
588
|
+
|
|
589
|
+
|
|
590
|
+
|
|
591
|
+
### Example
|
|
592
|
+
~~~ruby
|
|
593
|
+
# load the gem
|
|
594
|
+
require 'purecloud'
|
|
595
|
+
# setup authorization
|
|
596
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
597
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
598
|
+
environment = "mypurecloud.com"
|
|
599
|
+
|
|
600
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
601
|
+
|
|
602
|
+
PureCloud.configure do |config|
|
|
603
|
+
config.access_token = @authToken
|
|
604
|
+
end
|
|
605
|
+
|
|
606
|
+
api_instance = PureCloud::OutboundApi.new
|
|
607
|
+
|
|
608
|
+
sequence_id = "sequence_id_example" # String | Sequence ID
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
begin
|
|
612
|
+
#Delete a dialer sequence schedule.
|
|
613
|
+
result = api_instance.delete_schedules_sequences_sequence_id(sequence_id)
|
|
614
|
+
p result
|
|
615
|
+
rescue PureCloud::ApiError => e
|
|
616
|
+
puts "Exception when calling OutboundApi->delete_schedules_sequences_sequence_id: #{e}"
|
|
617
|
+
end
|
|
618
|
+
~~~
|
|
619
|
+
|
|
620
|
+
### Parameters
|
|
621
|
+
|
|
622
|
+
Name | Type | Description | Notes
|
|
623
|
+
------------- | ------------- | ------------- | -------------
|
|
624
|
+
**sequence_id** | **String**| Sequence ID |
|
|
625
|
+
{: class="table table-striped"}
|
|
626
|
+
|
|
627
|
+
|
|
628
|
+
### Return type
|
|
629
|
+
|
|
630
|
+
**String**
|
|
631
|
+
|
|
632
|
+
### HTTP request headers
|
|
633
|
+
|
|
634
|
+
- **Content-Type**: application/json
|
|
635
|
+
- **Accept**: application/json
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
<a name="delete_sequences_sequence_id"></a>
|
|
640
|
+
|
|
641
|
+
## -String** delete_sequences_sequence_id(sequence_id)
|
|
642
|
+
|
|
643
|
+
Delete a dialer campaign sequence.
|
|
644
|
+
|
|
645
|
+
|
|
646
|
+
|
|
647
|
+
### Example
|
|
648
|
+
~~~ruby
|
|
649
|
+
# load the gem
|
|
650
|
+
require 'purecloud'
|
|
651
|
+
# setup authorization
|
|
652
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
653
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
654
|
+
environment = "mypurecloud.com"
|
|
655
|
+
|
|
656
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
657
|
+
|
|
658
|
+
PureCloud.configure do |config|
|
|
659
|
+
config.access_token = @authToken
|
|
660
|
+
end
|
|
661
|
+
|
|
662
|
+
api_instance = PureCloud::OutboundApi.new
|
|
663
|
+
|
|
664
|
+
sequence_id = "sequence_id_example" # String | Campaign Sequence ID
|
|
665
|
+
|
|
666
|
+
|
|
667
|
+
begin
|
|
668
|
+
#Delete a dialer campaign sequence.
|
|
669
|
+
result = api_instance.delete_sequences_sequence_id(sequence_id)
|
|
670
|
+
p result
|
|
671
|
+
rescue PureCloud::ApiError => e
|
|
672
|
+
puts "Exception when calling OutboundApi->delete_sequences_sequence_id: #{e}"
|
|
673
|
+
end
|
|
674
|
+
~~~
|
|
675
|
+
|
|
676
|
+
### Parameters
|
|
677
|
+
|
|
678
|
+
Name | Type | Description | Notes
|
|
679
|
+
------------- | ------------- | ------------- | -------------
|
|
680
|
+
**sequence_id** | **String**| Campaign Sequence ID |
|
|
681
|
+
{: class="table table-striped"}
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
### Return type
|
|
685
|
+
|
|
686
|
+
**String**
|
|
687
|
+
|
|
688
|
+
### HTTP request headers
|
|
689
|
+
|
|
690
|
+
- **Content-Type**: application/json
|
|
691
|
+
- **Accept**: application/json
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
<a name="get_callabletimesets"></a>
|
|
696
|
+
|
|
697
|
+
## -[**CallableTimeSetEntityListing**](CallableTimeSetEntityListing.html) get_callabletimesets(opts)
|
|
698
|
+
|
|
699
|
+
Query callable time set list
|
|
700
|
+
|
|
701
|
+
|
|
702
|
+
|
|
703
|
+
### Example
|
|
704
|
+
~~~ruby
|
|
705
|
+
# load the gem
|
|
706
|
+
require 'purecloud'
|
|
707
|
+
# setup authorization
|
|
708
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
709
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
710
|
+
environment = "mypurecloud.com"
|
|
711
|
+
|
|
712
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
713
|
+
|
|
714
|
+
PureCloud.configure do |config|
|
|
715
|
+
config.access_token = @authToken
|
|
716
|
+
end
|
|
717
|
+
|
|
718
|
+
api_instance = PureCloud::OutboundApi.new
|
|
719
|
+
|
|
720
|
+
opts = {
|
|
721
|
+
page_size: 25, # Integer | Page size
|
|
722
|
+
page_number: 1, # Integer | Page number
|
|
723
|
+
filter_type: "PREFIX", # String | Filter type
|
|
724
|
+
name: "name_example", # String | Name
|
|
725
|
+
sort_by: "sort_by_example", # String | Sort by
|
|
726
|
+
sort_order: "a" # String | Sort order
|
|
727
|
+
}
|
|
728
|
+
|
|
729
|
+
begin
|
|
730
|
+
#Query callable time set list
|
|
731
|
+
result = api_instance.get_callabletimesets(opts)
|
|
732
|
+
p result
|
|
733
|
+
rescue PureCloud::ApiError => e
|
|
734
|
+
puts "Exception when calling OutboundApi->get_callabletimesets: #{e}"
|
|
735
|
+
end
|
|
736
|
+
~~~
|
|
737
|
+
|
|
738
|
+
### Parameters
|
|
739
|
+
|
|
740
|
+
Name | Type | Description | Notes
|
|
741
|
+
------------- | ------------- | ------------- | -------------
|
|
742
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25]
|
|
743
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1]
|
|
744
|
+
**filter_type** | **String**| Filter type | [optional] [default to PREFIX]
|
|
745
|
+
**name** | **String**| Name | [optional]
|
|
746
|
+
**sort_by** | **String**| Sort by | [optional]
|
|
747
|
+
**sort_order** | **String**| Sort order | [optional] [default to a]
|
|
748
|
+
{: class="table table-striped"}
|
|
749
|
+
|
|
750
|
+
|
|
751
|
+
### Return type
|
|
752
|
+
|
|
753
|
+
[**CallableTimeSetEntityListing**](CallableTimeSetEntityListing.html)
|
|
754
|
+
|
|
755
|
+
### HTTP request headers
|
|
756
|
+
|
|
757
|
+
- **Content-Type**: application/json
|
|
758
|
+
- **Accept**: application/json
|
|
759
|
+
|
|
760
|
+
|
|
761
|
+
|
|
762
|
+
<a name="get_callabletimesets_callabletimeset_id"></a>
|
|
763
|
+
|
|
764
|
+
## -[**CallableTimeSet**](CallableTimeSet.html) get_callabletimesets_callabletimeset_id(callable_time_set_id)
|
|
765
|
+
|
|
766
|
+
Get callable time set
|
|
767
|
+
|
|
768
|
+
|
|
769
|
+
|
|
770
|
+
### Example
|
|
771
|
+
~~~ruby
|
|
772
|
+
# load the gem
|
|
773
|
+
require 'purecloud'
|
|
774
|
+
# setup authorization
|
|
775
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
776
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
777
|
+
environment = "mypurecloud.com"
|
|
778
|
+
|
|
779
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
780
|
+
|
|
781
|
+
PureCloud.configure do |config|
|
|
782
|
+
config.access_token = @authToken
|
|
783
|
+
end
|
|
784
|
+
|
|
785
|
+
api_instance = PureCloud::OutboundApi.new
|
|
786
|
+
|
|
787
|
+
callable_time_set_id = "callable_time_set_id_example" # String | Callable Time Set ID
|
|
788
|
+
|
|
789
|
+
|
|
790
|
+
begin
|
|
791
|
+
#Get callable time set
|
|
792
|
+
result = api_instance.get_callabletimesets_callabletimeset_id(callable_time_set_id)
|
|
793
|
+
p result
|
|
794
|
+
rescue PureCloud::ApiError => e
|
|
795
|
+
puts "Exception when calling OutboundApi->get_callabletimesets_callabletimeset_id: #{e}"
|
|
796
|
+
end
|
|
797
|
+
~~~
|
|
798
|
+
|
|
799
|
+
### Parameters
|
|
800
|
+
|
|
801
|
+
Name | Type | Description | Notes
|
|
802
|
+
------------- | ------------- | ------------- | -------------
|
|
803
|
+
**callable_time_set_id** | **String**| Callable Time Set ID |
|
|
804
|
+
{: class="table table-striped"}
|
|
805
|
+
|
|
806
|
+
|
|
807
|
+
### Return type
|
|
808
|
+
|
|
809
|
+
[**CallableTimeSet**](CallableTimeSet.html)
|
|
810
|
+
|
|
811
|
+
### HTTP request headers
|
|
812
|
+
|
|
813
|
+
- **Content-Type**: application/json
|
|
814
|
+
- **Accept**: application/json
|
|
815
|
+
|
|
816
|
+
|
|
817
|
+
|
|
818
|
+
<a name="get_callanalysisresponsesets"></a>
|
|
819
|
+
|
|
820
|
+
## -[**ResponseSetEntityListing**](ResponseSetEntityListing.html) get_callanalysisresponsesets(opts)
|
|
821
|
+
|
|
822
|
+
Query a list of dialer call analysis response sets.
|
|
823
|
+
|
|
824
|
+
|
|
825
|
+
|
|
826
|
+
### Example
|
|
827
|
+
~~~ruby
|
|
828
|
+
# load the gem
|
|
829
|
+
require 'purecloud'
|
|
830
|
+
# setup authorization
|
|
831
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
832
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
833
|
+
environment = "mypurecloud.com"
|
|
834
|
+
|
|
835
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
836
|
+
|
|
837
|
+
PureCloud.configure do |config|
|
|
838
|
+
config.access_token = @authToken
|
|
839
|
+
end
|
|
840
|
+
|
|
841
|
+
api_instance = PureCloud::OutboundApi.new
|
|
842
|
+
|
|
843
|
+
opts = {
|
|
844
|
+
page_size: 25, # Integer | Page size
|
|
845
|
+
page_number: 1, # Integer | Page number
|
|
846
|
+
filter_type: "PREFIX", # String | Filter type
|
|
847
|
+
name: "name_example", # String | Name
|
|
848
|
+
sort_by: "sort_by_example", # String | Sort by
|
|
849
|
+
sort_order: "a" # String | Sort order
|
|
850
|
+
}
|
|
851
|
+
|
|
852
|
+
begin
|
|
853
|
+
#Query a list of dialer call analysis response sets.
|
|
854
|
+
result = api_instance.get_callanalysisresponsesets(opts)
|
|
855
|
+
p result
|
|
856
|
+
rescue PureCloud::ApiError => e
|
|
857
|
+
puts "Exception when calling OutboundApi->get_callanalysisresponsesets: #{e}"
|
|
858
|
+
end
|
|
859
|
+
~~~
|
|
860
|
+
|
|
861
|
+
### Parameters
|
|
862
|
+
|
|
863
|
+
Name | Type | Description | Notes
|
|
864
|
+
------------- | ------------- | ------------- | -------------
|
|
865
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25]
|
|
866
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1]
|
|
867
|
+
**filter_type** | **String**| Filter type | [optional] [default to PREFIX]
|
|
868
|
+
**name** | **String**| Name | [optional]
|
|
869
|
+
**sort_by** | **String**| Sort by | [optional]
|
|
870
|
+
**sort_order** | **String**| Sort order | [optional] [default to a]
|
|
871
|
+
{: class="table table-striped"}
|
|
872
|
+
|
|
873
|
+
|
|
874
|
+
### Return type
|
|
875
|
+
|
|
876
|
+
[**ResponseSetEntityListing**](ResponseSetEntityListing.html)
|
|
877
|
+
|
|
878
|
+
### HTTP request headers
|
|
879
|
+
|
|
880
|
+
- **Content-Type**: application/json
|
|
881
|
+
- **Accept**: application/json
|
|
882
|
+
|
|
883
|
+
|
|
884
|
+
|
|
885
|
+
<a name="get_callanalysisresponsesets_callanalysisset_id"></a>
|
|
886
|
+
|
|
887
|
+
## -[**ResponseSet**](ResponseSet.html) get_callanalysisresponsesets_callanalysisset_id(call_analysis_set_id)
|
|
888
|
+
|
|
889
|
+
Get a dialer call analysis response set.
|
|
890
|
+
|
|
891
|
+
|
|
892
|
+
|
|
893
|
+
### Example
|
|
894
|
+
~~~ruby
|
|
895
|
+
# load the gem
|
|
896
|
+
require 'purecloud'
|
|
897
|
+
# setup authorization
|
|
898
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
899
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
900
|
+
environment = "mypurecloud.com"
|
|
901
|
+
|
|
902
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
903
|
+
|
|
904
|
+
PureCloud.configure do |config|
|
|
905
|
+
config.access_token = @authToken
|
|
906
|
+
end
|
|
907
|
+
|
|
908
|
+
api_instance = PureCloud::OutboundApi.new
|
|
909
|
+
|
|
910
|
+
call_analysis_set_id = "call_analysis_set_id_example" # String | Call Analysis Response Set ID
|
|
911
|
+
|
|
912
|
+
|
|
913
|
+
begin
|
|
914
|
+
#Get a dialer call analysis response set.
|
|
915
|
+
result = api_instance.get_callanalysisresponsesets_callanalysisset_id(call_analysis_set_id)
|
|
916
|
+
p result
|
|
917
|
+
rescue PureCloud::ApiError => e
|
|
918
|
+
puts "Exception when calling OutboundApi->get_callanalysisresponsesets_callanalysisset_id: #{e}"
|
|
919
|
+
end
|
|
920
|
+
~~~
|
|
921
|
+
|
|
922
|
+
### Parameters
|
|
923
|
+
|
|
924
|
+
Name | Type | Description | Notes
|
|
925
|
+
------------- | ------------- | ------------- | -------------
|
|
926
|
+
**call_analysis_set_id** | **String**| Call Analysis Response Set ID |
|
|
927
|
+
{: class="table table-striped"}
|
|
928
|
+
|
|
929
|
+
|
|
930
|
+
### Return type
|
|
931
|
+
|
|
932
|
+
[**ResponseSet**](ResponseSet.html)
|
|
933
|
+
|
|
934
|
+
### HTTP request headers
|
|
935
|
+
|
|
936
|
+
- **Content-Type**: application/json
|
|
937
|
+
- **Accept**: application/json
|
|
938
|
+
|
|
939
|
+
|
|
940
|
+
|
|
941
|
+
<a name="get_campaigns"></a>
|
|
942
|
+
|
|
943
|
+
## -[**CampaignEntityListing**](CampaignEntityListing.html) get_campaigns(opts)
|
|
944
|
+
|
|
945
|
+
Query a list of dialer campaigns.
|
|
946
|
+
|
|
947
|
+
|
|
948
|
+
|
|
949
|
+
### Example
|
|
950
|
+
~~~ruby
|
|
951
|
+
# load the gem
|
|
952
|
+
require 'purecloud'
|
|
953
|
+
# setup authorization
|
|
954
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
955
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
956
|
+
environment = "mypurecloud.com"
|
|
957
|
+
|
|
958
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
959
|
+
|
|
960
|
+
PureCloud.configure do |config|
|
|
961
|
+
config.access_token = @authToken
|
|
962
|
+
end
|
|
963
|
+
|
|
964
|
+
api_instance = PureCloud::OutboundApi.new
|
|
965
|
+
|
|
966
|
+
opts = {
|
|
967
|
+
page_size: 25, # Integer | Page size
|
|
968
|
+
page_number: 1, # Integer | Page number
|
|
969
|
+
filter_type: "PREFIX", # String | Filter type
|
|
970
|
+
name: "name_example", # String | Name
|
|
971
|
+
contact_list_id: "contact_list_id_example", # String | Contact List ID
|
|
972
|
+
dnc_list_id: "dnc_list_id_example", # String | DNC list ID
|
|
973
|
+
distribution_queue_id: "distribution_queue_id_example", # String | Distribution queue ID
|
|
974
|
+
edge_group_id: "edge_group_id_example", # String | Edge group ID
|
|
975
|
+
call_analysis_response_set_id: "call_analysis_response_set_id_example", # String | Call analysis response set ID
|
|
976
|
+
sort_by: "sort_by_example", # String | Sort by
|
|
977
|
+
sort_order: "a" # String | Sort order
|
|
978
|
+
}
|
|
979
|
+
|
|
980
|
+
begin
|
|
981
|
+
#Query a list of dialer campaigns.
|
|
982
|
+
result = api_instance.get_campaigns(opts)
|
|
983
|
+
p result
|
|
984
|
+
rescue PureCloud::ApiError => e
|
|
985
|
+
puts "Exception when calling OutboundApi->get_campaigns: #{e}"
|
|
986
|
+
end
|
|
987
|
+
~~~
|
|
988
|
+
|
|
989
|
+
### Parameters
|
|
990
|
+
|
|
991
|
+
Name | Type | Description | Notes
|
|
992
|
+
------------- | ------------- | ------------- | -------------
|
|
993
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25]
|
|
994
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1]
|
|
995
|
+
**filter_type** | **String**| Filter type | [optional] [default to PREFIX]
|
|
996
|
+
**name** | **String**| Name | [optional]
|
|
997
|
+
**contact_list_id** | **String**| Contact List ID | [optional]
|
|
998
|
+
**dnc_list_id** | **String**| DNC list ID | [optional]
|
|
999
|
+
**distribution_queue_id** | **String**| Distribution queue ID | [optional]
|
|
1000
|
+
**edge_group_id** | **String**| Edge group ID | [optional]
|
|
1001
|
+
**call_analysis_response_set_id** | **String**| Call analysis response set ID | [optional]
|
|
1002
|
+
**sort_by** | **String**| Sort by | [optional]
|
|
1003
|
+
**sort_order** | **String**| Sort order | [optional] [default to a]
|
|
1004
|
+
{: class="table table-striped"}
|
|
1005
|
+
|
|
1006
|
+
|
|
1007
|
+
### Return type
|
|
1008
|
+
|
|
1009
|
+
[**CampaignEntityListing**](CampaignEntityListing.html)
|
|
1010
|
+
|
|
1011
|
+
### HTTP request headers
|
|
1012
|
+
|
|
1013
|
+
- **Content-Type**: application/json
|
|
1014
|
+
- **Accept**: application/json
|
|
1015
|
+
|
|
1016
|
+
|
|
1017
|
+
|
|
1018
|
+
<a name="get_campaigns_campaign_id"></a>
|
|
1019
|
+
|
|
1020
|
+
## -[**Campaign**](Campaign.html) get_campaigns_campaign_id(campaign_id)
|
|
1021
|
+
|
|
1022
|
+
Get dialer campaign.
|
|
1023
|
+
|
|
1024
|
+
|
|
1025
|
+
|
|
1026
|
+
### Example
|
|
1027
|
+
~~~ruby
|
|
1028
|
+
# load the gem
|
|
1029
|
+
require 'purecloud'
|
|
1030
|
+
# setup authorization
|
|
1031
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1032
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1033
|
+
environment = "mypurecloud.com"
|
|
1034
|
+
|
|
1035
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1036
|
+
|
|
1037
|
+
PureCloud.configure do |config|
|
|
1038
|
+
config.access_token = @authToken
|
|
1039
|
+
end
|
|
1040
|
+
|
|
1041
|
+
api_instance = PureCloud::OutboundApi.new
|
|
1042
|
+
|
|
1043
|
+
campaign_id = "campaign_id_example" # String | Campaign ID
|
|
1044
|
+
|
|
1045
|
+
|
|
1046
|
+
begin
|
|
1047
|
+
#Get dialer campaign.
|
|
1048
|
+
result = api_instance.get_campaigns_campaign_id(campaign_id)
|
|
1049
|
+
p result
|
|
1050
|
+
rescue PureCloud::ApiError => e
|
|
1051
|
+
puts "Exception when calling OutboundApi->get_campaigns_campaign_id: #{e}"
|
|
1052
|
+
end
|
|
1053
|
+
~~~
|
|
1054
|
+
|
|
1055
|
+
### Parameters
|
|
1056
|
+
|
|
1057
|
+
Name | Type | Description | Notes
|
|
1058
|
+
------------- | ------------- | ------------- | -------------
|
|
1059
|
+
**campaign_id** | **String**| Campaign ID |
|
|
1060
|
+
{: class="table table-striped"}
|
|
1061
|
+
|
|
1062
|
+
|
|
1063
|
+
### Return type
|
|
1064
|
+
|
|
1065
|
+
[**Campaign**](Campaign.html)
|
|
1066
|
+
|
|
1067
|
+
### HTTP request headers
|
|
1068
|
+
|
|
1069
|
+
- **Content-Type**: application/json
|
|
1070
|
+
- **Accept**: application/json
|
|
1071
|
+
|
|
1072
|
+
|
|
1073
|
+
|
|
1074
|
+
<a name="get_campaigns_campaign_id_diagnostics"></a>
|
|
1075
|
+
|
|
1076
|
+
## -[**CampaignDiagnostics**](CampaignDiagnostics.html) get_campaigns_campaign_id_diagnostics(campaign_id)
|
|
1077
|
+
|
|
1078
|
+
Get campaign diagnostics
|
|
1079
|
+
|
|
1080
|
+
|
|
1081
|
+
|
|
1082
|
+
### Example
|
|
1083
|
+
~~~ruby
|
|
1084
|
+
# load the gem
|
|
1085
|
+
require 'purecloud'
|
|
1086
|
+
# setup authorization
|
|
1087
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1088
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1089
|
+
environment = "mypurecloud.com"
|
|
1090
|
+
|
|
1091
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1092
|
+
|
|
1093
|
+
PureCloud.configure do |config|
|
|
1094
|
+
config.access_token = @authToken
|
|
1095
|
+
end
|
|
1096
|
+
|
|
1097
|
+
api_instance = PureCloud::OutboundApi.new
|
|
1098
|
+
|
|
1099
|
+
campaign_id = "campaign_id_example" # String | Campaign ID
|
|
1100
|
+
|
|
1101
|
+
|
|
1102
|
+
begin
|
|
1103
|
+
#Get campaign diagnostics
|
|
1104
|
+
result = api_instance.get_campaigns_campaign_id_diagnostics(campaign_id)
|
|
1105
|
+
p result
|
|
1106
|
+
rescue PureCloud::ApiError => e
|
|
1107
|
+
puts "Exception when calling OutboundApi->get_campaigns_campaign_id_diagnostics: #{e}"
|
|
1108
|
+
end
|
|
1109
|
+
~~~
|
|
1110
|
+
|
|
1111
|
+
### Parameters
|
|
1112
|
+
|
|
1113
|
+
Name | Type | Description | Notes
|
|
1114
|
+
------------- | ------------- | ------------- | -------------
|
|
1115
|
+
**campaign_id** | **String**| Campaign ID |
|
|
1116
|
+
{: class="table table-striped"}
|
|
1117
|
+
|
|
1118
|
+
|
|
1119
|
+
### Return type
|
|
1120
|
+
|
|
1121
|
+
[**CampaignDiagnostics**](CampaignDiagnostics.html)
|
|
1122
|
+
|
|
1123
|
+
### HTTP request headers
|
|
1124
|
+
|
|
1125
|
+
- **Content-Type**: application/json
|
|
1126
|
+
- **Accept**: application/json
|
|
1127
|
+
|
|
1128
|
+
|
|
1129
|
+
|
|
1130
|
+
<a name="get_campaigns_campaign_id_progress"></a>
|
|
1131
|
+
|
|
1132
|
+
## -[**CampaignProgress**](CampaignProgress.html) get_campaigns_campaign_id_progress(campaign_id)
|
|
1133
|
+
|
|
1134
|
+
Get campaign progress
|
|
1135
|
+
|
|
1136
|
+
|
|
1137
|
+
|
|
1138
|
+
### Example
|
|
1139
|
+
~~~ruby
|
|
1140
|
+
# load the gem
|
|
1141
|
+
require 'purecloud'
|
|
1142
|
+
# setup authorization
|
|
1143
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1144
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1145
|
+
environment = "mypurecloud.com"
|
|
1146
|
+
|
|
1147
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1148
|
+
|
|
1149
|
+
PureCloud.configure do |config|
|
|
1150
|
+
config.access_token = @authToken
|
|
1151
|
+
end
|
|
1152
|
+
|
|
1153
|
+
api_instance = PureCloud::OutboundApi.new
|
|
1154
|
+
|
|
1155
|
+
campaign_id = "campaign_id_example" # String | Campaign ID
|
|
1156
|
+
|
|
1157
|
+
|
|
1158
|
+
begin
|
|
1159
|
+
#Get campaign progress
|
|
1160
|
+
result = api_instance.get_campaigns_campaign_id_progress(campaign_id)
|
|
1161
|
+
p result
|
|
1162
|
+
rescue PureCloud::ApiError => e
|
|
1163
|
+
puts "Exception when calling OutboundApi->get_campaigns_campaign_id_progress: #{e}"
|
|
1164
|
+
end
|
|
1165
|
+
~~~
|
|
1166
|
+
|
|
1167
|
+
### Parameters
|
|
1168
|
+
|
|
1169
|
+
Name | Type | Description | Notes
|
|
1170
|
+
------------- | ------------- | ------------- | -------------
|
|
1171
|
+
**campaign_id** | **String**| Campaign ID |
|
|
1172
|
+
{: class="table table-striped"}
|
|
1173
|
+
|
|
1174
|
+
|
|
1175
|
+
### Return type
|
|
1176
|
+
|
|
1177
|
+
[**CampaignProgress**](CampaignProgress.html)
|
|
1178
|
+
|
|
1179
|
+
### HTTP request headers
|
|
1180
|
+
|
|
1181
|
+
- **Content-Type**: application/json
|
|
1182
|
+
- **Accept**: application/json
|
|
1183
|
+
|
|
1184
|
+
|
|
1185
|
+
|
|
1186
|
+
<a name="get_campaigns_campaign_id_stats"></a>
|
|
1187
|
+
|
|
1188
|
+
## -[**CampaignStats**](CampaignStats.html) get_campaigns_campaign_id_stats(campaign_id)
|
|
1189
|
+
|
|
1190
|
+
Get statistics about a Dialer Campaign
|
|
1191
|
+
|
|
1192
|
+
|
|
1193
|
+
|
|
1194
|
+
### Example
|
|
1195
|
+
~~~ruby
|
|
1196
|
+
# load the gem
|
|
1197
|
+
require 'purecloud'
|
|
1198
|
+
# setup authorization
|
|
1199
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1200
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1201
|
+
environment = "mypurecloud.com"
|
|
1202
|
+
|
|
1203
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1204
|
+
|
|
1205
|
+
PureCloud.configure do |config|
|
|
1206
|
+
config.access_token = @authToken
|
|
1207
|
+
end
|
|
1208
|
+
|
|
1209
|
+
api_instance = PureCloud::OutboundApi.new
|
|
1210
|
+
|
|
1211
|
+
campaign_id = "campaign_id_example" # String | Campaign ID
|
|
1212
|
+
|
|
1213
|
+
|
|
1214
|
+
begin
|
|
1215
|
+
#Get statistics about a Dialer Campaign
|
|
1216
|
+
result = api_instance.get_campaigns_campaign_id_stats(campaign_id)
|
|
1217
|
+
p result
|
|
1218
|
+
rescue PureCloud::ApiError => e
|
|
1219
|
+
puts "Exception when calling OutboundApi->get_campaigns_campaign_id_stats: #{e}"
|
|
1220
|
+
end
|
|
1221
|
+
~~~
|
|
1222
|
+
|
|
1223
|
+
### Parameters
|
|
1224
|
+
|
|
1225
|
+
Name | Type | Description | Notes
|
|
1226
|
+
------------- | ------------- | ------------- | -------------
|
|
1227
|
+
**campaign_id** | **String**| Campaign ID |
|
|
1228
|
+
{: class="table table-striped"}
|
|
1229
|
+
|
|
1230
|
+
|
|
1231
|
+
### Return type
|
|
1232
|
+
|
|
1233
|
+
[**CampaignStats**](CampaignStats.html)
|
|
1234
|
+
|
|
1235
|
+
### HTTP request headers
|
|
1236
|
+
|
|
1237
|
+
- **Content-Type**: application/json
|
|
1238
|
+
- **Accept**: application/json
|
|
1239
|
+
|
|
1240
|
+
|
|
1241
|
+
|
|
1242
|
+
<a name="get_contactlists"></a>
|
|
1243
|
+
|
|
1244
|
+
## -[**ContactListEntityListing**](ContactListEntityListing.html) get_contactlists(opts)
|
|
1245
|
+
|
|
1246
|
+
Query a list of contact lists.
|
|
1247
|
+
|
|
1248
|
+
|
|
1249
|
+
|
|
1250
|
+
### Example
|
|
1251
|
+
~~~ruby
|
|
1252
|
+
# load the gem
|
|
1253
|
+
require 'purecloud'
|
|
1254
|
+
# setup authorization
|
|
1255
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1256
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1257
|
+
environment = "mypurecloud.com"
|
|
1258
|
+
|
|
1259
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1260
|
+
|
|
1261
|
+
PureCloud.configure do |config|
|
|
1262
|
+
config.access_token = @authToken
|
|
1263
|
+
end
|
|
1264
|
+
|
|
1265
|
+
api_instance = PureCloud::OutboundApi.new
|
|
1266
|
+
|
|
1267
|
+
opts = {
|
|
1268
|
+
include_import_status: false, # BOOLEAN | Include import status
|
|
1269
|
+
include_size: false, # BOOLEAN | Include size
|
|
1270
|
+
page_size: 25, # Integer | Page size
|
|
1271
|
+
page_number: 1, # Integer | Page number
|
|
1272
|
+
filter_type: "PREFIX", # String | Filter type
|
|
1273
|
+
name: "name_example", # String | Name
|
|
1274
|
+
sort_by: "sort_by_example", # String | Sort by
|
|
1275
|
+
sort_order: "a" # String | Sort order
|
|
1276
|
+
}
|
|
1277
|
+
|
|
1278
|
+
begin
|
|
1279
|
+
#Query a list of contact lists.
|
|
1280
|
+
result = api_instance.get_contactlists(opts)
|
|
1281
|
+
p result
|
|
1282
|
+
rescue PureCloud::ApiError => e
|
|
1283
|
+
puts "Exception when calling OutboundApi->get_contactlists: #{e}"
|
|
1284
|
+
end
|
|
1285
|
+
~~~
|
|
1286
|
+
|
|
1287
|
+
### Parameters
|
|
1288
|
+
|
|
1289
|
+
Name | Type | Description | Notes
|
|
1290
|
+
------------- | ------------- | ------------- | -------------
|
|
1291
|
+
**include_import_status** | **BOOLEAN**| Include import status | [optional] [default to false]
|
|
1292
|
+
**include_size** | **BOOLEAN**| Include size | [optional] [default to false]
|
|
1293
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25]
|
|
1294
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1]
|
|
1295
|
+
**filter_type** | **String**| Filter type | [optional] [default to PREFIX]
|
|
1296
|
+
**name** | **String**| Name | [optional]
|
|
1297
|
+
**sort_by** | **String**| Sort by | [optional]
|
|
1298
|
+
**sort_order** | **String**| Sort order | [optional] [default to a]
|
|
1299
|
+
{: class="table table-striped"}
|
|
1300
|
+
|
|
1301
|
+
|
|
1302
|
+
### Return type
|
|
1303
|
+
|
|
1304
|
+
[**ContactListEntityListing**](ContactListEntityListing.html)
|
|
1305
|
+
|
|
1306
|
+
### HTTP request headers
|
|
1307
|
+
|
|
1308
|
+
- **Content-Type**: application/json
|
|
1309
|
+
- **Accept**: application/json
|
|
1310
|
+
|
|
1311
|
+
|
|
1312
|
+
|
|
1313
|
+
<a name="get_contactlists_contactlist_id"></a>
|
|
1314
|
+
|
|
1315
|
+
## -[**ContactList**](ContactList.html) get_contactlists_contactlist_id(contact_list_id, opts)
|
|
1316
|
+
|
|
1317
|
+
Get dialer contactList.
|
|
1318
|
+
|
|
1319
|
+
|
|
1320
|
+
|
|
1321
|
+
### Example
|
|
1322
|
+
~~~ruby
|
|
1323
|
+
# load the gem
|
|
1324
|
+
require 'purecloud'
|
|
1325
|
+
# setup authorization
|
|
1326
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1327
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1328
|
+
environment = "mypurecloud.com"
|
|
1329
|
+
|
|
1330
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1331
|
+
|
|
1332
|
+
PureCloud.configure do |config|
|
|
1333
|
+
config.access_token = @authToken
|
|
1334
|
+
end
|
|
1335
|
+
|
|
1336
|
+
api_instance = PureCloud::OutboundApi.new
|
|
1337
|
+
|
|
1338
|
+
contact_list_id = "contact_list_id_example" # String | ContactList ID
|
|
1339
|
+
|
|
1340
|
+
opts = {
|
|
1341
|
+
include_import_status: false, # BOOLEAN | Import status
|
|
1342
|
+
include_size: false # BOOLEAN | Include size
|
|
1343
|
+
}
|
|
1344
|
+
|
|
1345
|
+
begin
|
|
1346
|
+
#Get dialer contactList.
|
|
1347
|
+
result = api_instance.get_contactlists_contactlist_id(contact_list_id, opts)
|
|
1348
|
+
p result
|
|
1349
|
+
rescue PureCloud::ApiError => e
|
|
1350
|
+
puts "Exception when calling OutboundApi->get_contactlists_contactlist_id: #{e}"
|
|
1351
|
+
end
|
|
1352
|
+
~~~
|
|
1353
|
+
|
|
1354
|
+
### Parameters
|
|
1355
|
+
|
|
1356
|
+
Name | Type | Description | Notes
|
|
1357
|
+
------------- | ------------- | ------------- | -------------
|
|
1358
|
+
**contact_list_id** | **String**| ContactList ID |
|
|
1359
|
+
**include_import_status** | **BOOLEAN**| Import status | [optional] [default to false]
|
|
1360
|
+
**include_size** | **BOOLEAN**| Include size | [optional] [default to false]
|
|
1361
|
+
{: class="table table-striped"}
|
|
1362
|
+
|
|
1363
|
+
|
|
1364
|
+
### Return type
|
|
1365
|
+
|
|
1366
|
+
[**ContactList**](ContactList.html)
|
|
1367
|
+
|
|
1368
|
+
### HTTP request headers
|
|
1369
|
+
|
|
1370
|
+
- **Content-Type**: application/json
|
|
1371
|
+
- **Accept**: application/json
|
|
1372
|
+
|
|
1373
|
+
|
|
1374
|
+
|
|
1375
|
+
<a name="get_contactlists_contactlist_id_contacts_contact_id"></a>
|
|
1376
|
+
|
|
1377
|
+
## -[**DialerContact**](DialerContact.html) get_contactlists_contactlist_id_contacts_contact_id(contact_list_id, contact_id)
|
|
1378
|
+
|
|
1379
|
+
Get dialer contactList.
|
|
1380
|
+
|
|
1381
|
+
|
|
1382
|
+
|
|
1383
|
+
### Example
|
|
1384
|
+
~~~ruby
|
|
1385
|
+
# load the gem
|
|
1386
|
+
require 'purecloud'
|
|
1387
|
+
# setup authorization
|
|
1388
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1389
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1390
|
+
environment = "mypurecloud.com"
|
|
1391
|
+
|
|
1392
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1393
|
+
|
|
1394
|
+
PureCloud.configure do |config|
|
|
1395
|
+
config.access_token = @authToken
|
|
1396
|
+
end
|
|
1397
|
+
|
|
1398
|
+
api_instance = PureCloud::OutboundApi.new
|
|
1399
|
+
|
|
1400
|
+
contact_list_id = "contact_list_id_example" # String | Contact List ID
|
|
1401
|
+
|
|
1402
|
+
contact_id = "contact_id_example" # String | Contact ID
|
|
1403
|
+
|
|
1404
|
+
|
|
1405
|
+
begin
|
|
1406
|
+
#Get dialer contactList.
|
|
1407
|
+
result = api_instance.get_contactlists_contactlist_id_contacts_contact_id(contact_list_id, contact_id)
|
|
1408
|
+
p result
|
|
1409
|
+
rescue PureCloud::ApiError => e
|
|
1410
|
+
puts "Exception when calling OutboundApi->get_contactlists_contactlist_id_contacts_contact_id: #{e}"
|
|
1411
|
+
end
|
|
1412
|
+
~~~
|
|
1413
|
+
|
|
1414
|
+
### Parameters
|
|
1415
|
+
|
|
1416
|
+
Name | Type | Description | Notes
|
|
1417
|
+
------------- | ------------- | ------------- | -------------
|
|
1418
|
+
**contact_list_id** | **String**| Contact List ID |
|
|
1419
|
+
**contact_id** | **String**| Contact ID |
|
|
1420
|
+
{: class="table table-striped"}
|
|
1421
|
+
|
|
1422
|
+
|
|
1423
|
+
### Return type
|
|
1424
|
+
|
|
1425
|
+
[**DialerContact**](DialerContact.html)
|
|
1426
|
+
|
|
1427
|
+
### HTTP request headers
|
|
1428
|
+
|
|
1429
|
+
- **Content-Type**: application/json
|
|
1430
|
+
- **Accept**: application/json
|
|
1431
|
+
|
|
1432
|
+
|
|
1433
|
+
|
|
1434
|
+
<a name="get_contactlists_contactlist_id_importstatus"></a>
|
|
1435
|
+
|
|
1436
|
+
## -[**ImportStatus**](ImportStatus.html) get_contactlists_contactlist_id_importstatus(contact_list_id)
|
|
1437
|
+
|
|
1438
|
+
Get dialer contactList import status.
|
|
1439
|
+
|
|
1440
|
+
|
|
1441
|
+
|
|
1442
|
+
### Example
|
|
1443
|
+
~~~ruby
|
|
1444
|
+
# load the gem
|
|
1445
|
+
require 'purecloud'
|
|
1446
|
+
# setup authorization
|
|
1447
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1448
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1449
|
+
environment = "mypurecloud.com"
|
|
1450
|
+
|
|
1451
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1452
|
+
|
|
1453
|
+
PureCloud.configure do |config|
|
|
1454
|
+
config.access_token = @authToken
|
|
1455
|
+
end
|
|
1456
|
+
|
|
1457
|
+
api_instance = PureCloud::OutboundApi.new
|
|
1458
|
+
|
|
1459
|
+
contact_list_id = "contact_list_id_example" # String | ContactList ID
|
|
1460
|
+
|
|
1461
|
+
|
|
1462
|
+
begin
|
|
1463
|
+
#Get dialer contactList import status.
|
|
1464
|
+
result = api_instance.get_contactlists_contactlist_id_importstatus(contact_list_id)
|
|
1465
|
+
p result
|
|
1466
|
+
rescue PureCloud::ApiError => e
|
|
1467
|
+
puts "Exception when calling OutboundApi->get_contactlists_contactlist_id_importstatus: #{e}"
|
|
1468
|
+
end
|
|
1469
|
+
~~~
|
|
1470
|
+
|
|
1471
|
+
### Parameters
|
|
1472
|
+
|
|
1473
|
+
Name | Type | Description | Notes
|
|
1474
|
+
------------- | ------------- | ------------- | -------------
|
|
1475
|
+
**contact_list_id** | **String**| ContactList ID |
|
|
1476
|
+
{: class="table table-striped"}
|
|
1477
|
+
|
|
1478
|
+
|
|
1479
|
+
### Return type
|
|
1480
|
+
|
|
1481
|
+
[**ImportStatus**](ImportStatus.html)
|
|
1482
|
+
|
|
1483
|
+
### HTTP request headers
|
|
1484
|
+
|
|
1485
|
+
- **Content-Type**: application/json
|
|
1486
|
+
- **Accept**: application/json
|
|
1487
|
+
|
|
1488
|
+
|
|
1489
|
+
|
|
1490
|
+
<a name="get_dnclists"></a>
|
|
1491
|
+
|
|
1492
|
+
## -[**DncListEntityListing**](DncListEntityListing.html) get_dnclists(opts)
|
|
1493
|
+
|
|
1494
|
+
Query dialer DNC lists
|
|
1495
|
+
|
|
1496
|
+
|
|
1497
|
+
|
|
1498
|
+
### Example
|
|
1499
|
+
~~~ruby
|
|
1500
|
+
# load the gem
|
|
1501
|
+
require 'purecloud'
|
|
1502
|
+
# setup authorization
|
|
1503
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1504
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1505
|
+
environment = "mypurecloud.com"
|
|
1506
|
+
|
|
1507
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1508
|
+
|
|
1509
|
+
PureCloud.configure do |config|
|
|
1510
|
+
config.access_token = @authToken
|
|
1511
|
+
end
|
|
1512
|
+
|
|
1513
|
+
api_instance = PureCloud::OutboundApi.new
|
|
1514
|
+
|
|
1515
|
+
opts = {
|
|
1516
|
+
include_import_status: false, # BOOLEAN | Import status
|
|
1517
|
+
include_size: false, # BOOLEAN | Include size
|
|
1518
|
+
page_size: 25, # Integer | Page size
|
|
1519
|
+
page_number: 1, # Integer | Page number
|
|
1520
|
+
filter_type: "PREFIX", # String | Filter type
|
|
1521
|
+
name: "name_example", # String | Name
|
|
1522
|
+
sort_by: "sort_by_example", # String | Sort by
|
|
1523
|
+
sort_order: "sort_order_example" # String | Sort order
|
|
1524
|
+
}
|
|
1525
|
+
|
|
1526
|
+
begin
|
|
1527
|
+
#Query dialer DNC lists
|
|
1528
|
+
result = api_instance.get_dnclists(opts)
|
|
1529
|
+
p result
|
|
1530
|
+
rescue PureCloud::ApiError => e
|
|
1531
|
+
puts "Exception when calling OutboundApi->get_dnclists: #{e}"
|
|
1532
|
+
end
|
|
1533
|
+
~~~
|
|
1534
|
+
|
|
1535
|
+
### Parameters
|
|
1536
|
+
|
|
1537
|
+
Name | Type | Description | Notes
|
|
1538
|
+
------------- | ------------- | ------------- | -------------
|
|
1539
|
+
**include_import_status** | **BOOLEAN**| Import status | [optional] [default to false]
|
|
1540
|
+
**include_size** | **BOOLEAN**| Include size | [optional] [default to false]
|
|
1541
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25]
|
|
1542
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1]
|
|
1543
|
+
**filter_type** | **String**| Filter type | [optional] [default to PREFIX]
|
|
1544
|
+
**name** | **String**| Name | [optional]
|
|
1545
|
+
**sort_by** | **String**| Sort by | [optional]
|
|
1546
|
+
**sort_order** | **String**| Sort order | [optional]
|
|
1547
|
+
{: class="table table-striped"}
|
|
1548
|
+
|
|
1549
|
+
|
|
1550
|
+
### Return type
|
|
1551
|
+
|
|
1552
|
+
[**DncListEntityListing**](DncListEntityListing.html)
|
|
1553
|
+
|
|
1554
|
+
### HTTP request headers
|
|
1555
|
+
|
|
1556
|
+
- **Content-Type**: application/json
|
|
1557
|
+
- **Accept**: application/json
|
|
1558
|
+
|
|
1559
|
+
|
|
1560
|
+
|
|
1561
|
+
<a name="get_dnclists_dnclist_id"></a>
|
|
1562
|
+
|
|
1563
|
+
## -[**DncList**](DncList.html) get_dnclists_dnclist_id(dnc_list_id, opts)
|
|
1564
|
+
|
|
1565
|
+
Get dialer DNC list
|
|
1566
|
+
|
|
1567
|
+
|
|
1568
|
+
|
|
1569
|
+
### Example
|
|
1570
|
+
~~~ruby
|
|
1571
|
+
# load the gem
|
|
1572
|
+
require 'purecloud'
|
|
1573
|
+
# setup authorization
|
|
1574
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1575
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1576
|
+
environment = "mypurecloud.com"
|
|
1577
|
+
|
|
1578
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1579
|
+
|
|
1580
|
+
PureCloud.configure do |config|
|
|
1581
|
+
config.access_token = @authToken
|
|
1582
|
+
end
|
|
1583
|
+
|
|
1584
|
+
api_instance = PureCloud::OutboundApi.new
|
|
1585
|
+
|
|
1586
|
+
dnc_list_id = "dnc_list_id_example" # String | DncList ID
|
|
1587
|
+
|
|
1588
|
+
opts = {
|
|
1589
|
+
include_import_status: false, # BOOLEAN | Import status
|
|
1590
|
+
include_size: false # BOOLEAN | Include size
|
|
1591
|
+
}
|
|
1592
|
+
|
|
1593
|
+
begin
|
|
1594
|
+
#Get dialer DNC list
|
|
1595
|
+
result = api_instance.get_dnclists_dnclist_id(dnc_list_id, opts)
|
|
1596
|
+
p result
|
|
1597
|
+
rescue PureCloud::ApiError => e
|
|
1598
|
+
puts "Exception when calling OutboundApi->get_dnclists_dnclist_id: #{e}"
|
|
1599
|
+
end
|
|
1600
|
+
~~~
|
|
1601
|
+
|
|
1602
|
+
### Parameters
|
|
1603
|
+
|
|
1604
|
+
Name | Type | Description | Notes
|
|
1605
|
+
------------- | ------------- | ------------- | -------------
|
|
1606
|
+
**dnc_list_id** | **String**| DncList ID |
|
|
1607
|
+
**include_import_status** | **BOOLEAN**| Import status | [optional] [default to false]
|
|
1608
|
+
**include_size** | **BOOLEAN**| Include size | [optional] [default to false]
|
|
1609
|
+
{: class="table table-striped"}
|
|
1610
|
+
|
|
1611
|
+
|
|
1612
|
+
### Return type
|
|
1613
|
+
|
|
1614
|
+
[**DncList**](DncList.html)
|
|
1615
|
+
|
|
1616
|
+
### HTTP request headers
|
|
1617
|
+
|
|
1618
|
+
- **Content-Type**: application/json
|
|
1619
|
+
- **Accept**: application/json
|
|
1620
|
+
|
|
1621
|
+
|
|
1622
|
+
|
|
1623
|
+
<a name="get_dnclists_dnclist_id_importstatus"></a>
|
|
1624
|
+
|
|
1625
|
+
## -[**ImportStatus**](ImportStatus.html) get_dnclists_dnclist_id_importstatus(dnc_list_id)
|
|
1626
|
+
|
|
1627
|
+
Get dialer dncList import status.
|
|
1628
|
+
|
|
1629
|
+
|
|
1630
|
+
|
|
1631
|
+
### Example
|
|
1632
|
+
~~~ruby
|
|
1633
|
+
# load the gem
|
|
1634
|
+
require 'purecloud'
|
|
1635
|
+
# setup authorization
|
|
1636
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1637
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1638
|
+
environment = "mypurecloud.com"
|
|
1639
|
+
|
|
1640
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1641
|
+
|
|
1642
|
+
PureCloud.configure do |config|
|
|
1643
|
+
config.access_token = @authToken
|
|
1644
|
+
end
|
|
1645
|
+
|
|
1646
|
+
api_instance = PureCloud::OutboundApi.new
|
|
1647
|
+
|
|
1648
|
+
dnc_list_id = "dnc_list_id_example" # String | DncList ID
|
|
1649
|
+
|
|
1650
|
+
|
|
1651
|
+
begin
|
|
1652
|
+
#Get dialer dncList import status.
|
|
1653
|
+
result = api_instance.get_dnclists_dnclist_id_importstatus(dnc_list_id)
|
|
1654
|
+
p result
|
|
1655
|
+
rescue PureCloud::ApiError => e
|
|
1656
|
+
puts "Exception when calling OutboundApi->get_dnclists_dnclist_id_importstatus: #{e}"
|
|
1657
|
+
end
|
|
1658
|
+
~~~
|
|
1659
|
+
|
|
1660
|
+
### Parameters
|
|
1661
|
+
|
|
1662
|
+
Name | Type | Description | Notes
|
|
1663
|
+
------------- | ------------- | ------------- | -------------
|
|
1664
|
+
**dnc_list_id** | **String**| DncList ID |
|
|
1665
|
+
{: class="table table-striped"}
|
|
1666
|
+
|
|
1667
|
+
|
|
1668
|
+
### Return type
|
|
1669
|
+
|
|
1670
|
+
[**ImportStatus**](ImportStatus.html)
|
|
1671
|
+
|
|
1672
|
+
### HTTP request headers
|
|
1673
|
+
|
|
1674
|
+
- **Content-Type**: application/json
|
|
1675
|
+
- **Accept**: application/json
|
|
1676
|
+
|
|
1677
|
+
|
|
1678
|
+
|
|
1679
|
+
<a name="get_rulesets"></a>
|
|
1680
|
+
|
|
1681
|
+
## -[**RuleSetEntityListing**](RuleSetEntityListing.html) get_rulesets(opts)
|
|
1682
|
+
|
|
1683
|
+
Query a list of Rule Sets.
|
|
1684
|
+
|
|
1685
|
+
|
|
1686
|
+
|
|
1687
|
+
### Example
|
|
1688
|
+
~~~ruby
|
|
1689
|
+
# load the gem
|
|
1690
|
+
require 'purecloud'
|
|
1691
|
+
# setup authorization
|
|
1692
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1693
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1694
|
+
environment = "mypurecloud.com"
|
|
1695
|
+
|
|
1696
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1697
|
+
|
|
1698
|
+
PureCloud.configure do |config|
|
|
1699
|
+
config.access_token = @authToken
|
|
1700
|
+
end
|
|
1701
|
+
|
|
1702
|
+
api_instance = PureCloud::OutboundApi.new
|
|
1703
|
+
|
|
1704
|
+
opts = {
|
|
1705
|
+
page_size: 25, # Integer | Page size
|
|
1706
|
+
page_number: 1, # Integer | Page number
|
|
1707
|
+
filter_type: "PREFIX", # String | Filter type
|
|
1708
|
+
name: "name_example", # String | Name
|
|
1709
|
+
sort_by: "sort_by_example", # String | Sort by
|
|
1710
|
+
sort_order: "a" # String | Sort order
|
|
1711
|
+
}
|
|
1712
|
+
|
|
1713
|
+
begin
|
|
1714
|
+
#Query a list of Rule Sets.
|
|
1715
|
+
result = api_instance.get_rulesets(opts)
|
|
1716
|
+
p result
|
|
1717
|
+
rescue PureCloud::ApiError => e
|
|
1718
|
+
puts "Exception when calling OutboundApi->get_rulesets: #{e}"
|
|
1719
|
+
end
|
|
1720
|
+
~~~
|
|
1721
|
+
|
|
1722
|
+
### Parameters
|
|
1723
|
+
|
|
1724
|
+
Name | Type | Description | Notes
|
|
1725
|
+
------------- | ------------- | ------------- | -------------
|
|
1726
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25]
|
|
1727
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1]
|
|
1728
|
+
**filter_type** | **String**| Filter type | [optional] [default to PREFIX]
|
|
1729
|
+
**name** | **String**| Name | [optional]
|
|
1730
|
+
**sort_by** | **String**| Sort by | [optional]
|
|
1731
|
+
**sort_order** | **String**| Sort order | [optional] [default to a]
|
|
1732
|
+
{: class="table table-striped"}
|
|
1733
|
+
|
|
1734
|
+
|
|
1735
|
+
### Return type
|
|
1736
|
+
|
|
1737
|
+
[**RuleSetEntityListing**](RuleSetEntityListing.html)
|
|
1738
|
+
|
|
1739
|
+
### HTTP request headers
|
|
1740
|
+
|
|
1741
|
+
- **Content-Type**: application/json
|
|
1742
|
+
- **Accept**: application/json
|
|
1743
|
+
|
|
1744
|
+
|
|
1745
|
+
|
|
1746
|
+
<a name="get_rulesets_ruleset_id"></a>
|
|
1747
|
+
|
|
1748
|
+
## -[**RuleSet**](RuleSet.html) get_rulesets_ruleset_id(rule_set_id)
|
|
1749
|
+
|
|
1750
|
+
Get a Rule Set by ID.
|
|
1751
|
+
|
|
1752
|
+
|
|
1753
|
+
|
|
1754
|
+
### Example
|
|
1755
|
+
~~~ruby
|
|
1756
|
+
# load the gem
|
|
1757
|
+
require 'purecloud'
|
|
1758
|
+
# setup authorization
|
|
1759
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1760
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1761
|
+
environment = "mypurecloud.com"
|
|
1762
|
+
|
|
1763
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1764
|
+
|
|
1765
|
+
PureCloud.configure do |config|
|
|
1766
|
+
config.access_token = @authToken
|
|
1767
|
+
end
|
|
1768
|
+
|
|
1769
|
+
api_instance = PureCloud::OutboundApi.new
|
|
1770
|
+
|
|
1771
|
+
rule_set_id = "rule_set_id_example" # String | Rule Set ID
|
|
1772
|
+
|
|
1773
|
+
|
|
1774
|
+
begin
|
|
1775
|
+
#Get a Rule Set by ID.
|
|
1776
|
+
result = api_instance.get_rulesets_ruleset_id(rule_set_id)
|
|
1777
|
+
p result
|
|
1778
|
+
rescue PureCloud::ApiError => e
|
|
1779
|
+
puts "Exception when calling OutboundApi->get_rulesets_ruleset_id: #{e}"
|
|
1780
|
+
end
|
|
1781
|
+
~~~
|
|
1782
|
+
|
|
1783
|
+
### Parameters
|
|
1784
|
+
|
|
1785
|
+
Name | Type | Description | Notes
|
|
1786
|
+
------------- | ------------- | ------------- | -------------
|
|
1787
|
+
**rule_set_id** | **String**| Rule Set ID |
|
|
1788
|
+
{: class="table table-striped"}
|
|
1789
|
+
|
|
1790
|
+
|
|
1791
|
+
### Return type
|
|
1792
|
+
|
|
1793
|
+
[**RuleSet**](RuleSet.html)
|
|
1794
|
+
|
|
1795
|
+
### HTTP request headers
|
|
1796
|
+
|
|
1797
|
+
- **Content-Type**: application/json
|
|
1798
|
+
- **Accept**: application/json
|
|
1799
|
+
|
|
1800
|
+
|
|
1801
|
+
|
|
1802
|
+
<a name="get_schedules_campaigns"></a>
|
|
1803
|
+
|
|
1804
|
+
## -[**Array<CampaignSchedule>**](CampaignSchedule.html) get_schedules_campaigns
|
|
1805
|
+
|
|
1806
|
+
Query for a list of dialer campaign schedules.
|
|
1807
|
+
|
|
1808
|
+
|
|
1809
|
+
|
|
1810
|
+
### Example
|
|
1811
|
+
~~~ruby
|
|
1812
|
+
# load the gem
|
|
1813
|
+
require 'purecloud'
|
|
1814
|
+
# setup authorization
|
|
1815
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1816
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1817
|
+
environment = "mypurecloud.com"
|
|
1818
|
+
|
|
1819
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1820
|
+
|
|
1821
|
+
PureCloud.configure do |config|
|
|
1822
|
+
config.access_token = @authToken
|
|
1823
|
+
end
|
|
1824
|
+
|
|
1825
|
+
api_instance = PureCloud::OutboundApi.new
|
|
1826
|
+
|
|
1827
|
+
begin
|
|
1828
|
+
#Query for a list of dialer campaign schedules.
|
|
1829
|
+
result = api_instance.get_schedules_campaigns
|
|
1830
|
+
p result
|
|
1831
|
+
rescue PureCloud::ApiError => e
|
|
1832
|
+
puts "Exception when calling OutboundApi->get_schedules_campaigns: #{e}"
|
|
1833
|
+
end
|
|
1834
|
+
~~~
|
|
1835
|
+
|
|
1836
|
+
### Parameters
|
|
1837
|
+
This endpoint does not need any parameter.
|
|
1838
|
+
{: class="table table-striped"}
|
|
1839
|
+
|
|
1840
|
+
|
|
1841
|
+
### Return type
|
|
1842
|
+
|
|
1843
|
+
[**Array<CampaignSchedule>**](CampaignSchedule.html)
|
|
1844
|
+
|
|
1845
|
+
### HTTP request headers
|
|
1846
|
+
|
|
1847
|
+
- **Content-Type**: application/json
|
|
1848
|
+
- **Accept**: application/json
|
|
1849
|
+
|
|
1850
|
+
|
|
1851
|
+
|
|
1852
|
+
<a name="get_schedules_campaigns_campaign_id"></a>
|
|
1853
|
+
|
|
1854
|
+
## -[**CampaignSchedule**](CampaignSchedule.html) get_schedules_campaigns_campaign_id(campaign_id)
|
|
1855
|
+
|
|
1856
|
+
Get a dialer campaign schedule.
|
|
1857
|
+
|
|
1858
|
+
|
|
1859
|
+
|
|
1860
|
+
### Example
|
|
1861
|
+
~~~ruby
|
|
1862
|
+
# load the gem
|
|
1863
|
+
require 'purecloud'
|
|
1864
|
+
# setup authorization
|
|
1865
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1866
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1867
|
+
environment = "mypurecloud.com"
|
|
1868
|
+
|
|
1869
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1870
|
+
|
|
1871
|
+
PureCloud.configure do |config|
|
|
1872
|
+
config.access_token = @authToken
|
|
1873
|
+
end
|
|
1874
|
+
|
|
1875
|
+
api_instance = PureCloud::OutboundApi.new
|
|
1876
|
+
|
|
1877
|
+
campaign_id = "campaign_id_example" # String | Campaign ID
|
|
1878
|
+
|
|
1879
|
+
|
|
1880
|
+
begin
|
|
1881
|
+
#Get a dialer campaign schedule.
|
|
1882
|
+
result = api_instance.get_schedules_campaigns_campaign_id(campaign_id)
|
|
1883
|
+
p result
|
|
1884
|
+
rescue PureCloud::ApiError => e
|
|
1885
|
+
puts "Exception when calling OutboundApi->get_schedules_campaigns_campaign_id: #{e}"
|
|
1886
|
+
end
|
|
1887
|
+
~~~
|
|
1888
|
+
|
|
1889
|
+
### Parameters
|
|
1890
|
+
|
|
1891
|
+
Name | Type | Description | Notes
|
|
1892
|
+
------------- | ------------- | ------------- | -------------
|
|
1893
|
+
**campaign_id** | **String**| Campaign ID |
|
|
1894
|
+
{: class="table table-striped"}
|
|
1895
|
+
|
|
1896
|
+
|
|
1897
|
+
### Return type
|
|
1898
|
+
|
|
1899
|
+
[**CampaignSchedule**](CampaignSchedule.html)
|
|
1900
|
+
|
|
1901
|
+
### HTTP request headers
|
|
1902
|
+
|
|
1903
|
+
- **Content-Type**: application/json
|
|
1904
|
+
- **Accept**: application/json
|
|
1905
|
+
|
|
1906
|
+
|
|
1907
|
+
|
|
1908
|
+
<a name="get_schedules_sequences"></a>
|
|
1909
|
+
|
|
1910
|
+
## -[**Array<SequenceSchedule>**](SequenceSchedule.html) get_schedules_sequences
|
|
1911
|
+
|
|
1912
|
+
Query for a list of dialer sequence schedules.
|
|
1913
|
+
|
|
1914
|
+
|
|
1915
|
+
|
|
1916
|
+
### Example
|
|
1917
|
+
~~~ruby
|
|
1918
|
+
# load the gem
|
|
1919
|
+
require 'purecloud'
|
|
1920
|
+
# setup authorization
|
|
1921
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1922
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1923
|
+
environment = "mypurecloud.com"
|
|
1924
|
+
|
|
1925
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1926
|
+
|
|
1927
|
+
PureCloud.configure do |config|
|
|
1928
|
+
config.access_token = @authToken
|
|
1929
|
+
end
|
|
1930
|
+
|
|
1931
|
+
api_instance = PureCloud::OutboundApi.new
|
|
1932
|
+
|
|
1933
|
+
begin
|
|
1934
|
+
#Query for a list of dialer sequence schedules.
|
|
1935
|
+
result = api_instance.get_schedules_sequences
|
|
1936
|
+
p result
|
|
1937
|
+
rescue PureCloud::ApiError => e
|
|
1938
|
+
puts "Exception when calling OutboundApi->get_schedules_sequences: #{e}"
|
|
1939
|
+
end
|
|
1940
|
+
~~~
|
|
1941
|
+
|
|
1942
|
+
### Parameters
|
|
1943
|
+
This endpoint does not need any parameter.
|
|
1944
|
+
{: class="table table-striped"}
|
|
1945
|
+
|
|
1946
|
+
|
|
1947
|
+
### Return type
|
|
1948
|
+
|
|
1949
|
+
[**Array<SequenceSchedule>**](SequenceSchedule.html)
|
|
1950
|
+
|
|
1951
|
+
### HTTP request headers
|
|
1952
|
+
|
|
1953
|
+
- **Content-Type**: application/json
|
|
1954
|
+
- **Accept**: application/json
|
|
1955
|
+
|
|
1956
|
+
|
|
1957
|
+
|
|
1958
|
+
<a name="get_schedules_sequences_sequence_id"></a>
|
|
1959
|
+
|
|
1960
|
+
## -[**SequenceSchedule**](SequenceSchedule.html) get_schedules_sequences_sequence_id(sequence_id)
|
|
1961
|
+
|
|
1962
|
+
Get a dialer sequence schedule.
|
|
1963
|
+
|
|
1964
|
+
|
|
1965
|
+
|
|
1966
|
+
### Example
|
|
1967
|
+
~~~ruby
|
|
1968
|
+
# load the gem
|
|
1969
|
+
require 'purecloud'
|
|
1970
|
+
# setup authorization
|
|
1971
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1972
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1973
|
+
environment = "mypurecloud.com"
|
|
1974
|
+
|
|
1975
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1976
|
+
|
|
1977
|
+
PureCloud.configure do |config|
|
|
1978
|
+
config.access_token = @authToken
|
|
1979
|
+
end
|
|
1980
|
+
|
|
1981
|
+
api_instance = PureCloud::OutboundApi.new
|
|
1982
|
+
|
|
1983
|
+
sequence_id = "sequence_id_example" # String | Sequence ID
|
|
1984
|
+
|
|
1985
|
+
|
|
1986
|
+
begin
|
|
1987
|
+
#Get a dialer sequence schedule.
|
|
1988
|
+
result = api_instance.get_schedules_sequences_sequence_id(sequence_id)
|
|
1989
|
+
p result
|
|
1990
|
+
rescue PureCloud::ApiError => e
|
|
1991
|
+
puts "Exception when calling OutboundApi->get_schedules_sequences_sequence_id: #{e}"
|
|
1992
|
+
end
|
|
1993
|
+
~~~
|
|
1994
|
+
|
|
1995
|
+
### Parameters
|
|
1996
|
+
|
|
1997
|
+
Name | Type | Description | Notes
|
|
1998
|
+
------------- | ------------- | ------------- | -------------
|
|
1999
|
+
**sequence_id** | **String**| Sequence ID |
|
|
2000
|
+
{: class="table table-striped"}
|
|
2001
|
+
|
|
2002
|
+
|
|
2003
|
+
### Return type
|
|
2004
|
+
|
|
2005
|
+
[**SequenceSchedule**](SequenceSchedule.html)
|
|
2006
|
+
|
|
2007
|
+
### HTTP request headers
|
|
2008
|
+
|
|
2009
|
+
- **Content-Type**: application/json
|
|
2010
|
+
- **Accept**: application/json
|
|
2011
|
+
|
|
2012
|
+
|
|
2013
|
+
|
|
2014
|
+
<a name="get_sequences"></a>
|
|
2015
|
+
|
|
2016
|
+
## -[**CampaignSequenceEntityListing**](CampaignSequenceEntityListing.html) get_sequences(opts)
|
|
2017
|
+
|
|
2018
|
+
Query a list of dialer campaign sequences.
|
|
2019
|
+
|
|
2020
|
+
|
|
2021
|
+
|
|
2022
|
+
### Example
|
|
2023
|
+
~~~ruby
|
|
2024
|
+
# load the gem
|
|
2025
|
+
require 'purecloud'
|
|
2026
|
+
# setup authorization
|
|
2027
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2028
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2029
|
+
environment = "mypurecloud.com"
|
|
2030
|
+
|
|
2031
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2032
|
+
|
|
2033
|
+
PureCloud.configure do |config|
|
|
2034
|
+
config.access_token = @authToken
|
|
2035
|
+
end
|
|
2036
|
+
|
|
2037
|
+
api_instance = PureCloud::OutboundApi.new
|
|
2038
|
+
|
|
2039
|
+
opts = {
|
|
2040
|
+
page_size: 25, # Integer | Page size
|
|
2041
|
+
page_number: 1, # Integer | Page number
|
|
2042
|
+
filter_type: "PREFIX", # String | Filter type
|
|
2043
|
+
name: "name_example", # String | Name
|
|
2044
|
+
sort_by: "sort_by_example", # String | Sort by
|
|
2045
|
+
sort_order: "a" # String | Sort order
|
|
2046
|
+
}
|
|
2047
|
+
|
|
2048
|
+
begin
|
|
2049
|
+
#Query a list of dialer campaign sequences.
|
|
2050
|
+
result = api_instance.get_sequences(opts)
|
|
2051
|
+
p result
|
|
2052
|
+
rescue PureCloud::ApiError => e
|
|
2053
|
+
puts "Exception when calling OutboundApi->get_sequences: #{e}"
|
|
2054
|
+
end
|
|
2055
|
+
~~~
|
|
2056
|
+
|
|
2057
|
+
### Parameters
|
|
2058
|
+
|
|
2059
|
+
Name | Type | Description | Notes
|
|
2060
|
+
------------- | ------------- | ------------- | -------------
|
|
2061
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25]
|
|
2062
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1]
|
|
2063
|
+
**filter_type** | **String**| Filter type | [optional] [default to PREFIX]
|
|
2064
|
+
**name** | **String**| Name | [optional]
|
|
2065
|
+
**sort_by** | **String**| Sort by | [optional]
|
|
2066
|
+
**sort_order** | **String**| Sort order | [optional] [default to a]
|
|
2067
|
+
{: class="table table-striped"}
|
|
2068
|
+
|
|
2069
|
+
|
|
2070
|
+
### Return type
|
|
2071
|
+
|
|
2072
|
+
[**CampaignSequenceEntityListing**](CampaignSequenceEntityListing.html)
|
|
2073
|
+
|
|
2074
|
+
### HTTP request headers
|
|
2075
|
+
|
|
2076
|
+
- **Content-Type**: application/json
|
|
2077
|
+
- **Accept**: application/json
|
|
2078
|
+
|
|
2079
|
+
|
|
2080
|
+
|
|
2081
|
+
<a name="get_sequences_sequence_id"></a>
|
|
2082
|
+
|
|
2083
|
+
## -[**CampaignSequence**](CampaignSequence.html) get_sequences_sequence_id(sequence_id)
|
|
2084
|
+
|
|
2085
|
+
Get a dialer campaign sequence.
|
|
2086
|
+
|
|
2087
|
+
|
|
2088
|
+
|
|
2089
|
+
### Example
|
|
2090
|
+
~~~ruby
|
|
2091
|
+
# load the gem
|
|
2092
|
+
require 'purecloud'
|
|
2093
|
+
# setup authorization
|
|
2094
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2095
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2096
|
+
environment = "mypurecloud.com"
|
|
2097
|
+
|
|
2098
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2099
|
+
|
|
2100
|
+
PureCloud.configure do |config|
|
|
2101
|
+
config.access_token = @authToken
|
|
2102
|
+
end
|
|
2103
|
+
|
|
2104
|
+
api_instance = PureCloud::OutboundApi.new
|
|
2105
|
+
|
|
2106
|
+
sequence_id = "sequence_id_example" # String | Campaign Sequence ID
|
|
2107
|
+
|
|
2108
|
+
|
|
2109
|
+
begin
|
|
2110
|
+
#Get a dialer campaign sequence.
|
|
2111
|
+
result = api_instance.get_sequences_sequence_id(sequence_id)
|
|
2112
|
+
p result
|
|
2113
|
+
rescue PureCloud::ApiError => e
|
|
2114
|
+
puts "Exception when calling OutboundApi->get_sequences_sequence_id: #{e}"
|
|
2115
|
+
end
|
|
2116
|
+
~~~
|
|
2117
|
+
|
|
2118
|
+
### Parameters
|
|
2119
|
+
|
|
2120
|
+
Name | Type | Description | Notes
|
|
2121
|
+
------------- | ------------- | ------------- | -------------
|
|
2122
|
+
**sequence_id** | **String**| Campaign Sequence ID |
|
|
2123
|
+
{: class="table table-striped"}
|
|
2124
|
+
|
|
2125
|
+
|
|
2126
|
+
### Return type
|
|
2127
|
+
|
|
2128
|
+
[**CampaignSequence**](CampaignSequence.html)
|
|
2129
|
+
|
|
2130
|
+
### HTTP request headers
|
|
2131
|
+
|
|
2132
|
+
- **Content-Type**: application/json
|
|
2133
|
+
- **Accept**: application/json
|
|
2134
|
+
|
|
2135
|
+
|
|
2136
|
+
|
|
2137
|
+
<a name="get_wrapupcodemappings"></a>
|
|
2138
|
+
|
|
2139
|
+
## -[**WrapUpCodeMapping**](WrapUpCodeMapping.html) get_wrapupcodemappings
|
|
2140
|
+
|
|
2141
|
+
Get the Dialer wrap up code mapping.
|
|
2142
|
+
|
|
2143
|
+
|
|
2144
|
+
|
|
2145
|
+
### Example
|
|
2146
|
+
~~~ruby
|
|
2147
|
+
# load the gem
|
|
2148
|
+
require 'purecloud'
|
|
2149
|
+
# setup authorization
|
|
2150
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2151
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2152
|
+
environment = "mypurecloud.com"
|
|
2153
|
+
|
|
2154
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2155
|
+
|
|
2156
|
+
PureCloud.configure do |config|
|
|
2157
|
+
config.access_token = @authToken
|
|
2158
|
+
end
|
|
2159
|
+
|
|
2160
|
+
api_instance = PureCloud::OutboundApi.new
|
|
2161
|
+
|
|
2162
|
+
begin
|
|
2163
|
+
#Get the Dialer wrap up code mapping.
|
|
2164
|
+
result = api_instance.get_wrapupcodemappings
|
|
2165
|
+
p result
|
|
2166
|
+
rescue PureCloud::ApiError => e
|
|
2167
|
+
puts "Exception when calling OutboundApi->get_wrapupcodemappings: #{e}"
|
|
2168
|
+
end
|
|
2169
|
+
~~~
|
|
2170
|
+
|
|
2171
|
+
### Parameters
|
|
2172
|
+
This endpoint does not need any parameter.
|
|
2173
|
+
{: class="table table-striped"}
|
|
2174
|
+
|
|
2175
|
+
|
|
2176
|
+
### Return type
|
|
2177
|
+
|
|
2178
|
+
[**WrapUpCodeMapping**](WrapUpCodeMapping.html)
|
|
2179
|
+
|
|
2180
|
+
### HTTP request headers
|
|
2181
|
+
|
|
2182
|
+
- **Content-Type**: application/json
|
|
2183
|
+
- **Accept**: application/json
|
|
2184
|
+
|
|
2185
|
+
|
|
2186
|
+
|
|
2187
|
+
<a name="post_audits"></a>
|
|
2188
|
+
|
|
2189
|
+
## -[**AuditSearchResult**](AuditSearchResult.html) post_audits(opts)
|
|
2190
|
+
|
|
2191
|
+
Retrieves audits for dialer.
|
|
2192
|
+
|
|
2193
|
+
|
|
2194
|
+
|
|
2195
|
+
### Example
|
|
2196
|
+
~~~ruby
|
|
2197
|
+
# load the gem
|
|
2198
|
+
require 'purecloud'
|
|
2199
|
+
# setup authorization
|
|
2200
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2201
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2202
|
+
environment = "mypurecloud.com"
|
|
2203
|
+
|
|
2204
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2205
|
+
|
|
2206
|
+
PureCloud.configure do |config|
|
|
2207
|
+
config.access_token = @authToken
|
|
2208
|
+
end
|
|
2209
|
+
|
|
2210
|
+
api_instance = PureCloud::OutboundApi.new
|
|
2211
|
+
|
|
2212
|
+
opts = {
|
|
2213
|
+
body: PureCloud::DialerAuditRequest.new, # DialerAuditRequest | AuditSearch
|
|
2214
|
+
page_size: 25, # Integer | Page size
|
|
2215
|
+
page_number: 1, # Integer | Page number
|
|
2216
|
+
sort_by: "entity.name", # String | Sort by
|
|
2217
|
+
sort_order: "ascending", # String | Sort order
|
|
2218
|
+
facets_only: false # BOOLEAN | Facets only
|
|
2219
|
+
}
|
|
2220
|
+
|
|
2221
|
+
begin
|
|
2222
|
+
#Retrieves audits for dialer.
|
|
2223
|
+
result = api_instance.post_audits(opts)
|
|
2224
|
+
p result
|
|
2225
|
+
rescue PureCloud::ApiError => e
|
|
2226
|
+
puts "Exception when calling OutboundApi->post_audits: #{e}"
|
|
2227
|
+
end
|
|
2228
|
+
~~~
|
|
2229
|
+
|
|
2230
|
+
### Parameters
|
|
2231
|
+
|
|
2232
|
+
Name | Type | Description | Notes
|
|
2233
|
+
------------- | ------------- | ------------- | -------------
|
|
2234
|
+
**body** | [**DialerAuditRequest**](DialerAuditRequest.html)| AuditSearch | [optional]
|
|
2235
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25]
|
|
2236
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1]
|
|
2237
|
+
**sort_by** | **String**| Sort by | [optional] [default to entity.name]
|
|
2238
|
+
**sort_order** | **String**| Sort order | [optional] [default to ascending]
|
|
2239
|
+
**facets_only** | **BOOLEAN**| Facets only | [optional] [default to false]
|
|
2240
|
+
{: class="table table-striped"}
|
|
2241
|
+
|
|
2242
|
+
|
|
2243
|
+
### Return type
|
|
2244
|
+
|
|
2245
|
+
[**AuditSearchResult**](AuditSearchResult.html)
|
|
2246
|
+
|
|
2247
|
+
### HTTP request headers
|
|
2248
|
+
|
|
2249
|
+
- **Content-Type**: application/json
|
|
2250
|
+
- **Accept**: application/json
|
|
2251
|
+
|
|
2252
|
+
|
|
2253
|
+
|
|
2254
|
+
<a name="post_callabletimesets"></a>
|
|
2255
|
+
|
|
2256
|
+
## -[**CallableTimeSet**](CallableTimeSet.html) post_callabletimesets(opts)
|
|
2257
|
+
|
|
2258
|
+
Create callable time set
|
|
2259
|
+
|
|
2260
|
+
|
|
2261
|
+
|
|
2262
|
+
### Example
|
|
2263
|
+
~~~ruby
|
|
2264
|
+
# load the gem
|
|
2265
|
+
require 'purecloud'
|
|
2266
|
+
# setup authorization
|
|
2267
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2268
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2269
|
+
environment = "mypurecloud.com"
|
|
2270
|
+
|
|
2271
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2272
|
+
|
|
2273
|
+
PureCloud.configure do |config|
|
|
2274
|
+
config.access_token = @authToken
|
|
2275
|
+
end
|
|
2276
|
+
|
|
2277
|
+
api_instance = PureCloud::OutboundApi.new
|
|
2278
|
+
|
|
2279
|
+
opts = {
|
|
2280
|
+
body: PureCloud::CallableTimeSet.new # CallableTimeSet | DialerCallableTimeSet
|
|
2281
|
+
}
|
|
2282
|
+
|
|
2283
|
+
begin
|
|
2284
|
+
#Create callable time set
|
|
2285
|
+
result = api_instance.post_callabletimesets(opts)
|
|
2286
|
+
p result
|
|
2287
|
+
rescue PureCloud::ApiError => e
|
|
2288
|
+
puts "Exception when calling OutboundApi->post_callabletimesets: #{e}"
|
|
2289
|
+
end
|
|
2290
|
+
~~~
|
|
2291
|
+
|
|
2292
|
+
### Parameters
|
|
2293
|
+
|
|
2294
|
+
Name | Type | Description | Notes
|
|
2295
|
+
------------- | ------------- | ------------- | -------------
|
|
2296
|
+
**body** | [**CallableTimeSet**](CallableTimeSet.html)| DialerCallableTimeSet | [optional]
|
|
2297
|
+
{: class="table table-striped"}
|
|
2298
|
+
|
|
2299
|
+
|
|
2300
|
+
### Return type
|
|
2301
|
+
|
|
2302
|
+
[**CallableTimeSet**](CallableTimeSet.html)
|
|
2303
|
+
|
|
2304
|
+
### HTTP request headers
|
|
2305
|
+
|
|
2306
|
+
- **Content-Type**: application/json
|
|
2307
|
+
- **Accept**: application/json
|
|
2308
|
+
|
|
2309
|
+
|
|
2310
|
+
|
|
2311
|
+
<a name="post_callanalysisresponsesets"></a>
|
|
2312
|
+
|
|
2313
|
+
## -[**ResponseSet**](ResponseSet.html) post_callanalysisresponsesets(opts)
|
|
2314
|
+
|
|
2315
|
+
Create a dialer call analysis response set.
|
|
2316
|
+
|
|
2317
|
+
|
|
2318
|
+
|
|
2319
|
+
### Example
|
|
2320
|
+
~~~ruby
|
|
2321
|
+
# load the gem
|
|
2322
|
+
require 'purecloud'
|
|
2323
|
+
# setup authorization
|
|
2324
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2325
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2326
|
+
environment = "mypurecloud.com"
|
|
2327
|
+
|
|
2328
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2329
|
+
|
|
2330
|
+
PureCloud.configure do |config|
|
|
2331
|
+
config.access_token = @authToken
|
|
2332
|
+
end
|
|
2333
|
+
|
|
2334
|
+
api_instance = PureCloud::OutboundApi.new
|
|
2335
|
+
|
|
2336
|
+
opts = {
|
|
2337
|
+
body: PureCloud::ResponseSet.new # ResponseSet | ResponseSet
|
|
2338
|
+
}
|
|
2339
|
+
|
|
2340
|
+
begin
|
|
2341
|
+
#Create a dialer call analysis response set.
|
|
2342
|
+
result = api_instance.post_callanalysisresponsesets(opts)
|
|
2343
|
+
p result
|
|
2344
|
+
rescue PureCloud::ApiError => e
|
|
2345
|
+
puts "Exception when calling OutboundApi->post_callanalysisresponsesets: #{e}"
|
|
2346
|
+
end
|
|
2347
|
+
~~~
|
|
2348
|
+
|
|
2349
|
+
### Parameters
|
|
2350
|
+
|
|
2351
|
+
Name | Type | Description | Notes
|
|
2352
|
+
------------- | ------------- | ------------- | -------------
|
|
2353
|
+
**body** | [**ResponseSet**](ResponseSet.html)| ResponseSet | [optional]
|
|
2354
|
+
{: class="table table-striped"}
|
|
2355
|
+
|
|
2356
|
+
|
|
2357
|
+
### Return type
|
|
2358
|
+
|
|
2359
|
+
[**ResponseSet**](ResponseSet.html)
|
|
2360
|
+
|
|
2361
|
+
### HTTP request headers
|
|
2362
|
+
|
|
2363
|
+
- **Content-Type**: application/json
|
|
2364
|
+
- **Accept**: application/json
|
|
2365
|
+
|
|
2366
|
+
|
|
2367
|
+
|
|
2368
|
+
<a name="post_campaigns"></a>
|
|
2369
|
+
|
|
2370
|
+
## -[**Campaign**](Campaign.html) post_campaigns(opts)
|
|
2371
|
+
|
|
2372
|
+
Create a campaign.
|
|
2373
|
+
|
|
2374
|
+
|
|
2375
|
+
|
|
2376
|
+
### Example
|
|
2377
|
+
~~~ruby
|
|
2378
|
+
# load the gem
|
|
2379
|
+
require 'purecloud'
|
|
2380
|
+
# setup authorization
|
|
2381
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2382
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2383
|
+
environment = "mypurecloud.com"
|
|
2384
|
+
|
|
2385
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2386
|
+
|
|
2387
|
+
PureCloud.configure do |config|
|
|
2388
|
+
config.access_token = @authToken
|
|
2389
|
+
end
|
|
2390
|
+
|
|
2391
|
+
api_instance = PureCloud::OutboundApi.new
|
|
2392
|
+
|
|
2393
|
+
opts = {
|
|
2394
|
+
body: PureCloud::Campaign.new # Campaign | Campaign
|
|
2395
|
+
}
|
|
2396
|
+
|
|
2397
|
+
begin
|
|
2398
|
+
#Create a campaign.
|
|
2399
|
+
result = api_instance.post_campaigns(opts)
|
|
2400
|
+
p result
|
|
2401
|
+
rescue PureCloud::ApiError => e
|
|
2402
|
+
puts "Exception when calling OutboundApi->post_campaigns: #{e}"
|
|
2403
|
+
end
|
|
2404
|
+
~~~
|
|
2405
|
+
|
|
2406
|
+
### Parameters
|
|
2407
|
+
|
|
2408
|
+
Name | Type | Description | Notes
|
|
2409
|
+
------------- | ------------- | ------------- | -------------
|
|
2410
|
+
**body** | [**Campaign**](Campaign.html)| Campaign | [optional]
|
|
2411
|
+
{: class="table table-striped"}
|
|
2412
|
+
|
|
2413
|
+
|
|
2414
|
+
### Return type
|
|
2415
|
+
|
|
2416
|
+
[**Campaign**](Campaign.html)
|
|
2417
|
+
|
|
2418
|
+
### HTTP request headers
|
|
2419
|
+
|
|
2420
|
+
- **Content-Type**: application/json
|
|
2421
|
+
- **Accept**: application/json
|
|
2422
|
+
|
|
2423
|
+
|
|
2424
|
+
|
|
2425
|
+
<a name="post_campaigns_campaign_id_callback_schedule"></a>
|
|
2426
|
+
|
|
2427
|
+
## -[**ContactCallbackRequest**](ContactCallbackRequest.html) post_campaigns_campaign_id_callback_schedule(campaign_id, opts)
|
|
2428
|
+
|
|
2429
|
+
Schedule a Callback for a Dialer Campaign
|
|
2430
|
+
|
|
2431
|
+
|
|
2432
|
+
|
|
2433
|
+
### Example
|
|
2434
|
+
~~~ruby
|
|
2435
|
+
# load the gem
|
|
2436
|
+
require 'purecloud'
|
|
2437
|
+
# setup authorization
|
|
2438
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2439
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2440
|
+
environment = "mypurecloud.com"
|
|
2441
|
+
|
|
2442
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2443
|
+
|
|
2444
|
+
PureCloud.configure do |config|
|
|
2445
|
+
config.access_token = @authToken
|
|
2446
|
+
end
|
|
2447
|
+
|
|
2448
|
+
api_instance = PureCloud::OutboundApi.new
|
|
2449
|
+
|
|
2450
|
+
campaign_id = "campaign_id_example" # String | Campaign ID
|
|
2451
|
+
|
|
2452
|
+
opts = {
|
|
2453
|
+
body: PureCloud::ContactCallbackRequest.new # ContactCallbackRequest | ContactCallbackRequest
|
|
2454
|
+
}
|
|
2455
|
+
|
|
2456
|
+
begin
|
|
2457
|
+
#Schedule a Callback for a Dialer Campaign
|
|
2458
|
+
result = api_instance.post_campaigns_campaign_id_callback_schedule(campaign_id, opts)
|
|
2459
|
+
p result
|
|
2460
|
+
rescue PureCloud::ApiError => e
|
|
2461
|
+
puts "Exception when calling OutboundApi->post_campaigns_campaign_id_callback_schedule: #{e}"
|
|
2462
|
+
end
|
|
2463
|
+
~~~
|
|
2464
|
+
|
|
2465
|
+
### Parameters
|
|
2466
|
+
|
|
2467
|
+
Name | Type | Description | Notes
|
|
2468
|
+
------------- | ------------- | ------------- | -------------
|
|
2469
|
+
**campaign_id** | **String**| Campaign ID |
|
|
2470
|
+
**body** | [**ContactCallbackRequest**](ContactCallbackRequest.html)| ContactCallbackRequest | [optional]
|
|
2471
|
+
{: class="table table-striped"}
|
|
2472
|
+
|
|
2473
|
+
|
|
2474
|
+
### Return type
|
|
2475
|
+
|
|
2476
|
+
[**ContactCallbackRequest**](ContactCallbackRequest.html)
|
|
2477
|
+
|
|
2478
|
+
### HTTP request headers
|
|
2479
|
+
|
|
2480
|
+
- **Content-Type**: application/json
|
|
2481
|
+
- **Accept**: application/json
|
|
2482
|
+
|
|
2483
|
+
|
|
2484
|
+
|
|
2485
|
+
<a name="post_campaigns_progress"></a>
|
|
2486
|
+
|
|
2487
|
+
## -[**Array<CampaignProgress>**](CampaignProgress.html) post_campaigns_progress(opts)
|
|
2488
|
+
|
|
2489
|
+
Get progress for a list of campaigns
|
|
2490
|
+
|
|
2491
|
+
|
|
2492
|
+
|
|
2493
|
+
### Example
|
|
2494
|
+
~~~ruby
|
|
2495
|
+
# load the gem
|
|
2496
|
+
require 'purecloud'
|
|
2497
|
+
# setup authorization
|
|
2498
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2499
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2500
|
+
environment = "mypurecloud.com"
|
|
2501
|
+
|
|
2502
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2503
|
+
|
|
2504
|
+
PureCloud.configure do |config|
|
|
2505
|
+
config.access_token = @authToken
|
|
2506
|
+
end
|
|
2507
|
+
|
|
2508
|
+
api_instance = PureCloud::OutboundApi.new
|
|
2509
|
+
|
|
2510
|
+
opts = {
|
|
2511
|
+
body: [PureCloud::Array<String>.new] # Array<String> | Campaign IDs
|
|
2512
|
+
}
|
|
2513
|
+
|
|
2514
|
+
begin
|
|
2515
|
+
#Get progress for a list of campaigns
|
|
2516
|
+
result = api_instance.post_campaigns_progress(opts)
|
|
2517
|
+
p result
|
|
2518
|
+
rescue PureCloud::ApiError => e
|
|
2519
|
+
puts "Exception when calling OutboundApi->post_campaigns_progress: #{e}"
|
|
2520
|
+
end
|
|
2521
|
+
~~~
|
|
2522
|
+
|
|
2523
|
+
### Parameters
|
|
2524
|
+
|
|
2525
|
+
Name | Type | Description | Notes
|
|
2526
|
+
------------- | ------------- | ------------- | -------------
|
|
2527
|
+
**body** | **Array<String>**| Campaign IDs | [optional]
|
|
2528
|
+
{: class="table table-striped"}
|
|
2529
|
+
|
|
2530
|
+
|
|
2531
|
+
### Return type
|
|
2532
|
+
|
|
2533
|
+
[**Array<CampaignProgress>**](CampaignProgress.html)
|
|
2534
|
+
|
|
2535
|
+
### HTTP request headers
|
|
2536
|
+
|
|
2537
|
+
- **Content-Type**: application/json
|
|
2538
|
+
- **Accept**: application/json
|
|
2539
|
+
|
|
2540
|
+
|
|
2541
|
+
|
|
2542
|
+
<a name="post_contactlists"></a>
|
|
2543
|
+
|
|
2544
|
+
## -[**ContactList**](ContactList.html) post_contactlists(opts)
|
|
2545
|
+
|
|
2546
|
+
Create a contact List.
|
|
2547
|
+
|
|
2548
|
+
|
|
2549
|
+
|
|
2550
|
+
### Example
|
|
2551
|
+
~~~ruby
|
|
2552
|
+
# load the gem
|
|
2553
|
+
require 'purecloud'
|
|
2554
|
+
# setup authorization
|
|
2555
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2556
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2557
|
+
environment = "mypurecloud.com"
|
|
2558
|
+
|
|
2559
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2560
|
+
|
|
2561
|
+
PureCloud.configure do |config|
|
|
2562
|
+
config.access_token = @authToken
|
|
2563
|
+
end
|
|
2564
|
+
|
|
2565
|
+
api_instance = PureCloud::OutboundApi.new
|
|
2566
|
+
|
|
2567
|
+
opts = {
|
|
2568
|
+
body: PureCloud::ContactList.new # ContactList | ContactList
|
|
2569
|
+
}
|
|
2570
|
+
|
|
2571
|
+
begin
|
|
2572
|
+
#Create a contact List.
|
|
2573
|
+
result = api_instance.post_contactlists(opts)
|
|
2574
|
+
p result
|
|
2575
|
+
rescue PureCloud::ApiError => e
|
|
2576
|
+
puts "Exception when calling OutboundApi->post_contactlists: #{e}"
|
|
2577
|
+
end
|
|
2578
|
+
~~~
|
|
2579
|
+
|
|
2580
|
+
### Parameters
|
|
2581
|
+
|
|
2582
|
+
Name | Type | Description | Notes
|
|
2583
|
+
------------- | ------------- | ------------- | -------------
|
|
2584
|
+
**body** | [**ContactList**](ContactList.html)| ContactList | [optional]
|
|
2585
|
+
{: class="table table-striped"}
|
|
2586
|
+
|
|
2587
|
+
|
|
2588
|
+
### Return type
|
|
2589
|
+
|
|
2590
|
+
[**ContactList**](ContactList.html)
|
|
2591
|
+
|
|
2592
|
+
### HTTP request headers
|
|
2593
|
+
|
|
2594
|
+
- **Content-Type**: application/json
|
|
2595
|
+
- **Accept**: application/json
|
|
2596
|
+
|
|
2597
|
+
|
|
2598
|
+
|
|
2599
|
+
<a name="post_contactlists_contactlist_id_contacts"></a>
|
|
2600
|
+
|
|
2601
|
+
## -[**DialerContact**](DialerContact.html) post_contactlists_contactlist_id_contacts(contact_list_id, opts)
|
|
2602
|
+
|
|
2603
|
+
Add contacts to a contact list.
|
|
2604
|
+
|
|
2605
|
+
|
|
2606
|
+
|
|
2607
|
+
### Example
|
|
2608
|
+
~~~ruby
|
|
2609
|
+
# load the gem
|
|
2610
|
+
require 'purecloud'
|
|
2611
|
+
# setup authorization
|
|
2612
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2613
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2614
|
+
environment = "mypurecloud.com"
|
|
2615
|
+
|
|
2616
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2617
|
+
|
|
2618
|
+
PureCloud.configure do |config|
|
|
2619
|
+
config.access_token = @authToken
|
|
2620
|
+
end
|
|
2621
|
+
|
|
2622
|
+
api_instance = PureCloud::OutboundApi.new
|
|
2623
|
+
|
|
2624
|
+
contact_list_id = "contact_list_id_example" # String | Contact List ID
|
|
2625
|
+
|
|
2626
|
+
opts = {
|
|
2627
|
+
body: [PureCloud::DialerContact.new], # Array<DialerContact> | Contact
|
|
2628
|
+
priority: true # BOOLEAN |
|
|
2629
|
+
}
|
|
2630
|
+
|
|
2631
|
+
begin
|
|
2632
|
+
#Add contacts to a contact list.
|
|
2633
|
+
result = api_instance.post_contactlists_contactlist_id_contacts(contact_list_id, opts)
|
|
2634
|
+
p result
|
|
2635
|
+
rescue PureCloud::ApiError => e
|
|
2636
|
+
puts "Exception when calling OutboundApi->post_contactlists_contactlist_id_contacts: #{e}"
|
|
2637
|
+
end
|
|
2638
|
+
~~~
|
|
2639
|
+
|
|
2640
|
+
### Parameters
|
|
2641
|
+
|
|
2642
|
+
Name | Type | Description | Notes
|
|
2643
|
+
------------- | ------------- | ------------- | -------------
|
|
2644
|
+
**contact_list_id** | **String**| Contact List ID |
|
|
2645
|
+
**body** | [**Array<DialerContact>**](DialerContact.html)| Contact | [optional]
|
|
2646
|
+
**priority** | **BOOLEAN**| | [optional]
|
|
2647
|
+
{: class="table table-striped"}
|
|
2648
|
+
|
|
2649
|
+
|
|
2650
|
+
### Return type
|
|
2651
|
+
|
|
2652
|
+
[**DialerContact**](DialerContact.html)
|
|
2653
|
+
|
|
2654
|
+
### HTTP request headers
|
|
2655
|
+
|
|
2656
|
+
- **Content-Type**: application/json
|
|
2657
|
+
- **Accept**: application/json
|
|
2658
|
+
|
|
2659
|
+
|
|
2660
|
+
|
|
2661
|
+
<a name="post_contactlists_contactlist_id_export"></a>
|
|
2662
|
+
|
|
2663
|
+
## -String** post_contactlists_contactlist_id_export(contact_list_id)
|
|
2664
|
+
|
|
2665
|
+
Initiate the export of a contact list.
|
|
2666
|
+
|
|
2667
|
+
Returns 200 if received OK.
|
|
2668
|
+
|
|
2669
|
+
### Example
|
|
2670
|
+
~~~ruby
|
|
2671
|
+
# load the gem
|
|
2672
|
+
require 'purecloud'
|
|
2673
|
+
# setup authorization
|
|
2674
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2675
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2676
|
+
environment = "mypurecloud.com"
|
|
2677
|
+
|
|
2678
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2679
|
+
|
|
2680
|
+
PureCloud.configure do |config|
|
|
2681
|
+
config.access_token = @authToken
|
|
2682
|
+
end
|
|
2683
|
+
|
|
2684
|
+
api_instance = PureCloud::OutboundApi.new
|
|
2685
|
+
|
|
2686
|
+
contact_list_id = "contact_list_id_example" # String | ContactList ID
|
|
2687
|
+
|
|
2688
|
+
|
|
2689
|
+
begin
|
|
2690
|
+
#Initiate the export of a contact list.
|
|
2691
|
+
result = api_instance.post_contactlists_contactlist_id_export(contact_list_id)
|
|
2692
|
+
p result
|
|
2693
|
+
rescue PureCloud::ApiError => e
|
|
2694
|
+
puts "Exception when calling OutboundApi->post_contactlists_contactlist_id_export: #{e}"
|
|
2695
|
+
end
|
|
2696
|
+
~~~
|
|
2697
|
+
|
|
2698
|
+
### Parameters
|
|
2699
|
+
|
|
2700
|
+
Name | Type | Description | Notes
|
|
2701
|
+
------------- | ------------- | ------------- | -------------
|
|
2702
|
+
**contact_list_id** | **String**| ContactList ID |
|
|
2703
|
+
{: class="table table-striped"}
|
|
2704
|
+
|
|
2705
|
+
|
|
2706
|
+
### Return type
|
|
2707
|
+
|
|
2708
|
+
**String**
|
|
2709
|
+
|
|
2710
|
+
### HTTP request headers
|
|
2711
|
+
|
|
2712
|
+
- **Content-Type**: application/json
|
|
2713
|
+
- **Accept**: application/json
|
|
2714
|
+
|
|
2715
|
+
|
|
2716
|
+
|
|
2717
|
+
<a name="post_conversations_conversation_id_dnc"></a>
|
|
2718
|
+
|
|
2719
|
+
## - post_conversations_conversation_id_dnc(conversation_id)
|
|
2720
|
+
|
|
2721
|
+
Add phone numbers to a Dialer DNC list.
|
|
2722
|
+
|
|
2723
|
+
|
|
2724
|
+
|
|
2725
|
+
### Example
|
|
2726
|
+
~~~ruby
|
|
2727
|
+
# load the gem
|
|
2728
|
+
require 'purecloud'
|
|
2729
|
+
# setup authorization
|
|
2730
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2731
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2732
|
+
environment = "mypurecloud.com"
|
|
2733
|
+
|
|
2734
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2735
|
+
|
|
2736
|
+
PureCloud.configure do |config|
|
|
2737
|
+
config.access_token = @authToken
|
|
2738
|
+
end
|
|
2739
|
+
|
|
2740
|
+
api_instance = PureCloud::OutboundApi.new
|
|
2741
|
+
|
|
2742
|
+
conversation_id = "conversation_id_example" # String | Conversation ID
|
|
2743
|
+
|
|
2744
|
+
|
|
2745
|
+
begin
|
|
2746
|
+
#Add phone numbers to a Dialer DNC list.
|
|
2747
|
+
api_instance.post_conversations_conversation_id_dnc(conversation_id)
|
|
2748
|
+
rescue PureCloud::ApiError => e
|
|
2749
|
+
puts "Exception when calling OutboundApi->post_conversations_conversation_id_dnc: #{e}"
|
|
2750
|
+
end
|
|
2751
|
+
~~~
|
|
2752
|
+
|
|
2753
|
+
### Parameters
|
|
2754
|
+
|
|
2755
|
+
Name | Type | Description | Notes
|
|
2756
|
+
------------- | ------------- | ------------- | -------------
|
|
2757
|
+
**conversation_id** | **String**| Conversation ID |
|
|
2758
|
+
{: class="table table-striped"}
|
|
2759
|
+
|
|
2760
|
+
|
|
2761
|
+
### Return type
|
|
2762
|
+
|
|
2763
|
+
nil (empty response body)
|
|
2764
|
+
|
|
2765
|
+
### HTTP request headers
|
|
2766
|
+
|
|
2767
|
+
- **Content-Type**: application/json
|
|
2768
|
+
- **Accept**: application/json
|
|
2769
|
+
|
|
2770
|
+
|
|
2771
|
+
|
|
2772
|
+
<a name="post_dnclists"></a>
|
|
2773
|
+
|
|
2774
|
+
## -[**DncList**](DncList.html) post_dnclists(opts)
|
|
2775
|
+
|
|
2776
|
+
Create dialer DNC list
|
|
2777
|
+
|
|
2778
|
+
|
|
2779
|
+
|
|
2780
|
+
### Example
|
|
2781
|
+
~~~ruby
|
|
2782
|
+
# load the gem
|
|
2783
|
+
require 'purecloud'
|
|
2784
|
+
# setup authorization
|
|
2785
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2786
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2787
|
+
environment = "mypurecloud.com"
|
|
2788
|
+
|
|
2789
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2790
|
+
|
|
2791
|
+
PureCloud.configure do |config|
|
|
2792
|
+
config.access_token = @authToken
|
|
2793
|
+
end
|
|
2794
|
+
|
|
2795
|
+
api_instance = PureCloud::OutboundApi.new
|
|
2796
|
+
|
|
2797
|
+
opts = {
|
|
2798
|
+
body: PureCloud::DncList.new # DncList | DncList
|
|
2799
|
+
}
|
|
2800
|
+
|
|
2801
|
+
begin
|
|
2802
|
+
#Create dialer DNC list
|
|
2803
|
+
result = api_instance.post_dnclists(opts)
|
|
2804
|
+
p result
|
|
2805
|
+
rescue PureCloud::ApiError => e
|
|
2806
|
+
puts "Exception when calling OutboundApi->post_dnclists: #{e}"
|
|
2807
|
+
end
|
|
2808
|
+
~~~
|
|
2809
|
+
|
|
2810
|
+
### Parameters
|
|
2811
|
+
|
|
2812
|
+
Name | Type | Description | Notes
|
|
2813
|
+
------------- | ------------- | ------------- | -------------
|
|
2814
|
+
**body** | [**DncList**](DncList.html)| DncList | [optional]
|
|
2815
|
+
{: class="table table-striped"}
|
|
2816
|
+
|
|
2817
|
+
|
|
2818
|
+
### Return type
|
|
2819
|
+
|
|
2820
|
+
[**DncList**](DncList.html)
|
|
2821
|
+
|
|
2822
|
+
### HTTP request headers
|
|
2823
|
+
|
|
2824
|
+
- **Content-Type**: application/json
|
|
2825
|
+
- **Accept**: application/json
|
|
2826
|
+
|
|
2827
|
+
|
|
2828
|
+
|
|
2829
|
+
<a name="post_dnclists_dnclist_id_export"></a>
|
|
2830
|
+
|
|
2831
|
+
## -String** post_dnclists_dnclist_id_export(dnc_list_id)
|
|
2832
|
+
|
|
2833
|
+
Initiate the export of a dnc list.
|
|
2834
|
+
|
|
2835
|
+
Returns 200 if received OK.
|
|
2836
|
+
|
|
2837
|
+
### Example
|
|
2838
|
+
~~~ruby
|
|
2839
|
+
# load the gem
|
|
2840
|
+
require 'purecloud'
|
|
2841
|
+
# setup authorization
|
|
2842
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2843
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2844
|
+
environment = "mypurecloud.com"
|
|
2845
|
+
|
|
2846
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2847
|
+
|
|
2848
|
+
PureCloud.configure do |config|
|
|
2849
|
+
config.access_token = @authToken
|
|
2850
|
+
end
|
|
2851
|
+
|
|
2852
|
+
api_instance = PureCloud::OutboundApi.new
|
|
2853
|
+
|
|
2854
|
+
dnc_list_id = "dnc_list_id_example" # String | DncList ID
|
|
2855
|
+
|
|
2856
|
+
|
|
2857
|
+
begin
|
|
2858
|
+
#Initiate the export of a dnc list.
|
|
2859
|
+
result = api_instance.post_dnclists_dnclist_id_export(dnc_list_id)
|
|
2860
|
+
p result
|
|
2861
|
+
rescue PureCloud::ApiError => e
|
|
2862
|
+
puts "Exception when calling OutboundApi->post_dnclists_dnclist_id_export: #{e}"
|
|
2863
|
+
end
|
|
2864
|
+
~~~
|
|
2865
|
+
|
|
2866
|
+
### Parameters
|
|
2867
|
+
|
|
2868
|
+
Name | Type | Description | Notes
|
|
2869
|
+
------------- | ------------- | ------------- | -------------
|
|
2870
|
+
**dnc_list_id** | **String**| DncList ID |
|
|
2871
|
+
{: class="table table-striped"}
|
|
2872
|
+
|
|
2873
|
+
|
|
2874
|
+
### Return type
|
|
2875
|
+
|
|
2876
|
+
**String**
|
|
2877
|
+
|
|
2878
|
+
### HTTP request headers
|
|
2879
|
+
|
|
2880
|
+
- **Content-Type**: application/json
|
|
2881
|
+
- **Accept**: application/json
|
|
2882
|
+
|
|
2883
|
+
|
|
2884
|
+
|
|
2885
|
+
<a name="post_dnclists_dnclist_id_phonenumbers"></a>
|
|
2886
|
+
|
|
2887
|
+
## - post_dnclists_dnclist_id_phonenumbers(dnc_list_id, opts)
|
|
2888
|
+
|
|
2889
|
+
Add phone numbers to a Dialer DNC list.
|
|
2890
|
+
|
|
2891
|
+
|
|
2892
|
+
|
|
2893
|
+
### Example
|
|
2894
|
+
~~~ruby
|
|
2895
|
+
# load the gem
|
|
2896
|
+
require 'purecloud'
|
|
2897
|
+
# setup authorization
|
|
2898
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2899
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2900
|
+
environment = "mypurecloud.com"
|
|
2901
|
+
|
|
2902
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2903
|
+
|
|
2904
|
+
PureCloud.configure do |config|
|
|
2905
|
+
config.access_token = @authToken
|
|
2906
|
+
end
|
|
2907
|
+
|
|
2908
|
+
api_instance = PureCloud::OutboundApi.new
|
|
2909
|
+
|
|
2910
|
+
dnc_list_id = "dnc_list_id_example" # String | DncList ID
|
|
2911
|
+
|
|
2912
|
+
opts = {
|
|
2913
|
+
body: [PureCloud::Array<String>.new] # Array<String> | DNC Phone Numbers
|
|
2914
|
+
}
|
|
2915
|
+
|
|
2916
|
+
begin
|
|
2917
|
+
#Add phone numbers to a Dialer DNC list.
|
|
2918
|
+
api_instance.post_dnclists_dnclist_id_phonenumbers(dnc_list_id, opts)
|
|
2919
|
+
rescue PureCloud::ApiError => e
|
|
2920
|
+
puts "Exception when calling OutboundApi->post_dnclists_dnclist_id_phonenumbers: #{e}"
|
|
2921
|
+
end
|
|
2922
|
+
~~~
|
|
2923
|
+
|
|
2924
|
+
### Parameters
|
|
2925
|
+
|
|
2926
|
+
Name | Type | Description | Notes
|
|
2927
|
+
------------- | ------------- | ------------- | -------------
|
|
2928
|
+
**dnc_list_id** | **String**| DncList ID |
|
|
2929
|
+
**body** | **Array<String>**| DNC Phone Numbers | [optional]
|
|
2930
|
+
{: class="table table-striped"}
|
|
2931
|
+
|
|
2932
|
+
|
|
2933
|
+
### Return type
|
|
2934
|
+
|
|
2935
|
+
nil (empty response body)
|
|
2936
|
+
|
|
2937
|
+
### HTTP request headers
|
|
2938
|
+
|
|
2939
|
+
- **Content-Type**: application/json
|
|
2940
|
+
- **Accept**: application/json
|
|
2941
|
+
|
|
2942
|
+
|
|
2943
|
+
|
|
2944
|
+
<a name="post_rulesets"></a>
|
|
2945
|
+
|
|
2946
|
+
## -[**RuleSet**](RuleSet.html) post_rulesets(opts)
|
|
2947
|
+
|
|
2948
|
+
Create a Dialer Call Analysis Response Set.
|
|
2949
|
+
|
|
2950
|
+
|
|
2951
|
+
|
|
2952
|
+
### Example
|
|
2953
|
+
~~~ruby
|
|
2954
|
+
# load the gem
|
|
2955
|
+
require 'purecloud'
|
|
2956
|
+
# setup authorization
|
|
2957
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2958
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2959
|
+
environment = "mypurecloud.com"
|
|
2960
|
+
|
|
2961
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2962
|
+
|
|
2963
|
+
PureCloud.configure do |config|
|
|
2964
|
+
config.access_token = @authToken
|
|
2965
|
+
end
|
|
2966
|
+
|
|
2967
|
+
api_instance = PureCloud::OutboundApi.new
|
|
2968
|
+
|
|
2969
|
+
opts = {
|
|
2970
|
+
body: PureCloud::RuleSet.new # RuleSet | RuleSet
|
|
2971
|
+
}
|
|
2972
|
+
|
|
2973
|
+
begin
|
|
2974
|
+
#Create a Dialer Call Analysis Response Set.
|
|
2975
|
+
result = api_instance.post_rulesets(opts)
|
|
2976
|
+
p result
|
|
2977
|
+
rescue PureCloud::ApiError => e
|
|
2978
|
+
puts "Exception when calling OutboundApi->post_rulesets: #{e}"
|
|
2979
|
+
end
|
|
2980
|
+
~~~
|
|
2981
|
+
|
|
2982
|
+
### Parameters
|
|
2983
|
+
|
|
2984
|
+
Name | Type | Description | Notes
|
|
2985
|
+
------------- | ------------- | ------------- | -------------
|
|
2986
|
+
**body** | [**RuleSet**](RuleSet.html)| RuleSet | [optional]
|
|
2987
|
+
{: class="table table-striped"}
|
|
2988
|
+
|
|
2989
|
+
|
|
2990
|
+
### Return type
|
|
2991
|
+
|
|
2992
|
+
[**RuleSet**](RuleSet.html)
|
|
2993
|
+
|
|
2994
|
+
### HTTP request headers
|
|
2995
|
+
|
|
2996
|
+
- **Content-Type**: application/json
|
|
2997
|
+
- **Accept**: application/json
|
|
2998
|
+
|
|
2999
|
+
|
|
3000
|
+
|
|
3001
|
+
<a name="post_sequences"></a>
|
|
3002
|
+
|
|
3003
|
+
## -[**CampaignSequence**](CampaignSequence.html) post_sequences(opts)
|
|
3004
|
+
|
|
3005
|
+
Create a new campaign sequence.
|
|
3006
|
+
|
|
3007
|
+
|
|
3008
|
+
|
|
3009
|
+
### Example
|
|
3010
|
+
~~~ruby
|
|
3011
|
+
# load the gem
|
|
3012
|
+
require 'purecloud'
|
|
3013
|
+
# setup authorization
|
|
3014
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3015
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3016
|
+
environment = "mypurecloud.com"
|
|
3017
|
+
|
|
3018
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3019
|
+
|
|
3020
|
+
PureCloud.configure do |config|
|
|
3021
|
+
config.access_token = @authToken
|
|
3022
|
+
end
|
|
3023
|
+
|
|
3024
|
+
api_instance = PureCloud::OutboundApi.new
|
|
3025
|
+
|
|
3026
|
+
opts = {
|
|
3027
|
+
body: PureCloud::CampaignSequence.new # CampaignSequence | Organization
|
|
3028
|
+
}
|
|
3029
|
+
|
|
3030
|
+
begin
|
|
3031
|
+
#Create a new campaign sequence.
|
|
3032
|
+
result = api_instance.post_sequences(opts)
|
|
3033
|
+
p result
|
|
3034
|
+
rescue PureCloud::ApiError => e
|
|
3035
|
+
puts "Exception when calling OutboundApi->post_sequences: #{e}"
|
|
3036
|
+
end
|
|
3037
|
+
~~~
|
|
3038
|
+
|
|
3039
|
+
### Parameters
|
|
3040
|
+
|
|
3041
|
+
Name | Type | Description | Notes
|
|
3042
|
+
------------- | ------------- | ------------- | -------------
|
|
3043
|
+
**body** | [**CampaignSequence**](CampaignSequence.html)| Organization | [optional]
|
|
3044
|
+
{: class="table table-striped"}
|
|
3045
|
+
|
|
3046
|
+
|
|
3047
|
+
### Return type
|
|
3048
|
+
|
|
3049
|
+
[**CampaignSequence**](CampaignSequence.html)
|
|
3050
|
+
|
|
3051
|
+
### HTTP request headers
|
|
3052
|
+
|
|
3053
|
+
- **Content-Type**: application/json
|
|
3054
|
+
- **Accept**: application/json
|
|
3055
|
+
|
|
3056
|
+
|
|
3057
|
+
|
|
3058
|
+
<a name="put_callabletimesets_callabletimeset_id"></a>
|
|
3059
|
+
|
|
3060
|
+
## -[**CallableTimeSet**](CallableTimeSet.html) put_callabletimesets_callabletimeset_id(callable_time_set_id, opts)
|
|
3061
|
+
|
|
3062
|
+
Update callable time set
|
|
3063
|
+
|
|
3064
|
+
|
|
3065
|
+
|
|
3066
|
+
### Example
|
|
3067
|
+
~~~ruby
|
|
3068
|
+
# load the gem
|
|
3069
|
+
require 'purecloud'
|
|
3070
|
+
# setup authorization
|
|
3071
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3072
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3073
|
+
environment = "mypurecloud.com"
|
|
3074
|
+
|
|
3075
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3076
|
+
|
|
3077
|
+
PureCloud.configure do |config|
|
|
3078
|
+
config.access_token = @authToken
|
|
3079
|
+
end
|
|
3080
|
+
|
|
3081
|
+
api_instance = PureCloud::OutboundApi.new
|
|
3082
|
+
|
|
3083
|
+
callable_time_set_id = "callable_time_set_id_example" # String | Callable Time Set ID
|
|
3084
|
+
|
|
3085
|
+
opts = {
|
|
3086
|
+
body: PureCloud::CallableTimeSet.new # CallableTimeSet | DialerCallableTimeSet
|
|
3087
|
+
}
|
|
3088
|
+
|
|
3089
|
+
begin
|
|
3090
|
+
#Update callable time set
|
|
3091
|
+
result = api_instance.put_callabletimesets_callabletimeset_id(callable_time_set_id, opts)
|
|
3092
|
+
p result
|
|
3093
|
+
rescue PureCloud::ApiError => e
|
|
3094
|
+
puts "Exception when calling OutboundApi->put_callabletimesets_callabletimeset_id: #{e}"
|
|
3095
|
+
end
|
|
3096
|
+
~~~
|
|
3097
|
+
|
|
3098
|
+
### Parameters
|
|
3099
|
+
|
|
3100
|
+
Name | Type | Description | Notes
|
|
3101
|
+
------------- | ------------- | ------------- | -------------
|
|
3102
|
+
**callable_time_set_id** | **String**| Callable Time Set ID |
|
|
3103
|
+
**body** | [**CallableTimeSet**](CallableTimeSet.html)| DialerCallableTimeSet | [optional]
|
|
3104
|
+
{: class="table table-striped"}
|
|
3105
|
+
|
|
3106
|
+
|
|
3107
|
+
### Return type
|
|
3108
|
+
|
|
3109
|
+
[**CallableTimeSet**](CallableTimeSet.html)
|
|
3110
|
+
|
|
3111
|
+
### HTTP request headers
|
|
3112
|
+
|
|
3113
|
+
- **Content-Type**: application/json
|
|
3114
|
+
- **Accept**: application/json
|
|
3115
|
+
|
|
3116
|
+
|
|
3117
|
+
|
|
3118
|
+
<a name="put_callanalysisresponsesets_callanalysisset_id"></a>
|
|
3119
|
+
|
|
3120
|
+
## -[**ResponseSet**](ResponseSet.html) put_callanalysisresponsesets_callanalysisset_id(call_analysis_set_id, opts)
|
|
3121
|
+
|
|
3122
|
+
Update a dialer call analysis response set.
|
|
3123
|
+
|
|
3124
|
+
|
|
3125
|
+
|
|
3126
|
+
### Example
|
|
3127
|
+
~~~ruby
|
|
3128
|
+
# load the gem
|
|
3129
|
+
require 'purecloud'
|
|
3130
|
+
# setup authorization
|
|
3131
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3132
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3133
|
+
environment = "mypurecloud.com"
|
|
3134
|
+
|
|
3135
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3136
|
+
|
|
3137
|
+
PureCloud.configure do |config|
|
|
3138
|
+
config.access_token = @authToken
|
|
3139
|
+
end
|
|
3140
|
+
|
|
3141
|
+
api_instance = PureCloud::OutboundApi.new
|
|
3142
|
+
|
|
3143
|
+
call_analysis_set_id = "call_analysis_set_id_example" # String | Call Analysis Response Set ID
|
|
3144
|
+
|
|
3145
|
+
opts = {
|
|
3146
|
+
body: PureCloud::ResponseSet.new # ResponseSet | ResponseSet
|
|
3147
|
+
}
|
|
3148
|
+
|
|
3149
|
+
begin
|
|
3150
|
+
#Update a dialer call analysis response set.
|
|
3151
|
+
result = api_instance.put_callanalysisresponsesets_callanalysisset_id(call_analysis_set_id, opts)
|
|
3152
|
+
p result
|
|
3153
|
+
rescue PureCloud::ApiError => e
|
|
3154
|
+
puts "Exception when calling OutboundApi->put_callanalysisresponsesets_callanalysisset_id: #{e}"
|
|
3155
|
+
end
|
|
3156
|
+
~~~
|
|
3157
|
+
|
|
3158
|
+
### Parameters
|
|
3159
|
+
|
|
3160
|
+
Name | Type | Description | Notes
|
|
3161
|
+
------------- | ------------- | ------------- | -------------
|
|
3162
|
+
**call_analysis_set_id** | **String**| Call Analysis Response Set ID |
|
|
3163
|
+
**body** | [**ResponseSet**](ResponseSet.html)| ResponseSet | [optional]
|
|
3164
|
+
{: class="table table-striped"}
|
|
3165
|
+
|
|
3166
|
+
|
|
3167
|
+
### Return type
|
|
3168
|
+
|
|
3169
|
+
[**ResponseSet**](ResponseSet.html)
|
|
3170
|
+
|
|
3171
|
+
### HTTP request headers
|
|
3172
|
+
|
|
3173
|
+
- **Content-Type**: application/json
|
|
3174
|
+
- **Accept**: application/json
|
|
3175
|
+
|
|
3176
|
+
|
|
3177
|
+
|
|
3178
|
+
<a name="put_campaigns_campaign_id"></a>
|
|
3179
|
+
|
|
3180
|
+
## -[**Campaign**](Campaign.html) put_campaigns_campaign_id(campaign_id, opts)
|
|
3181
|
+
|
|
3182
|
+
Update a campaign.
|
|
3183
|
+
|
|
3184
|
+
|
|
3185
|
+
|
|
3186
|
+
### Example
|
|
3187
|
+
~~~ruby
|
|
3188
|
+
# load the gem
|
|
3189
|
+
require 'purecloud'
|
|
3190
|
+
# setup authorization
|
|
3191
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3192
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3193
|
+
environment = "mypurecloud.com"
|
|
3194
|
+
|
|
3195
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3196
|
+
|
|
3197
|
+
PureCloud.configure do |config|
|
|
3198
|
+
config.access_token = @authToken
|
|
3199
|
+
end
|
|
3200
|
+
|
|
3201
|
+
api_instance = PureCloud::OutboundApi.new
|
|
3202
|
+
|
|
3203
|
+
campaign_id = "campaign_id_example" # String | Campaign ID
|
|
3204
|
+
|
|
3205
|
+
opts = {
|
|
3206
|
+
body: PureCloud::Campaign.new # Campaign | Campaign
|
|
3207
|
+
}
|
|
3208
|
+
|
|
3209
|
+
begin
|
|
3210
|
+
#Update a campaign.
|
|
3211
|
+
result = api_instance.put_campaigns_campaign_id(campaign_id, opts)
|
|
3212
|
+
p result
|
|
3213
|
+
rescue PureCloud::ApiError => e
|
|
3214
|
+
puts "Exception when calling OutboundApi->put_campaigns_campaign_id: #{e}"
|
|
3215
|
+
end
|
|
3216
|
+
~~~
|
|
3217
|
+
|
|
3218
|
+
### Parameters
|
|
3219
|
+
|
|
3220
|
+
Name | Type | Description | Notes
|
|
3221
|
+
------------- | ------------- | ------------- | -------------
|
|
3222
|
+
**campaign_id** | **String**| Campaign ID |
|
|
3223
|
+
**body** | [**Campaign**](Campaign.html)| Campaign | [optional]
|
|
3224
|
+
{: class="table table-striped"}
|
|
3225
|
+
|
|
3226
|
+
|
|
3227
|
+
### Return type
|
|
3228
|
+
|
|
3229
|
+
[**Campaign**](Campaign.html)
|
|
3230
|
+
|
|
3231
|
+
### HTTP request headers
|
|
3232
|
+
|
|
3233
|
+
- **Content-Type**: application/json
|
|
3234
|
+
- **Accept**: application/json
|
|
3235
|
+
|
|
3236
|
+
|
|
3237
|
+
|
|
3238
|
+
<a name="put_campaigns_campaign_id_agents_user_id"></a>
|
|
3239
|
+
|
|
3240
|
+
## -String** put_campaigns_campaign_id_agents_user_id(campaign_id, user_id, opts)
|
|
3241
|
+
|
|
3242
|
+
Send notification that an agent's state changed
|
|
3243
|
+
|
|
3244
|
+
New agent state.
|
|
3245
|
+
|
|
3246
|
+
### Example
|
|
3247
|
+
~~~ruby
|
|
3248
|
+
# load the gem
|
|
3249
|
+
require 'purecloud'
|
|
3250
|
+
# setup authorization
|
|
3251
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3252
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3253
|
+
environment = "mypurecloud.com"
|
|
3254
|
+
|
|
3255
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3256
|
+
|
|
3257
|
+
PureCloud.configure do |config|
|
|
3258
|
+
config.access_token = @authToken
|
|
3259
|
+
end
|
|
3260
|
+
|
|
3261
|
+
api_instance = PureCloud::OutboundApi.new
|
|
3262
|
+
|
|
3263
|
+
campaign_id = "campaign_id_example" # String | Campaign ID
|
|
3264
|
+
|
|
3265
|
+
user_id = "user_id_example" # String | Agent's user ID
|
|
3266
|
+
|
|
3267
|
+
opts = {
|
|
3268
|
+
body: PureCloud::Agent.new # Agent | agent
|
|
3269
|
+
}
|
|
3270
|
+
|
|
3271
|
+
begin
|
|
3272
|
+
#Send notification that an agent's state changed
|
|
3273
|
+
result = api_instance.put_campaigns_campaign_id_agents_user_id(campaign_id, user_id, opts)
|
|
3274
|
+
p result
|
|
3275
|
+
rescue PureCloud::ApiError => e
|
|
3276
|
+
puts "Exception when calling OutboundApi->put_campaigns_campaign_id_agents_user_id: #{e}"
|
|
3277
|
+
end
|
|
3278
|
+
~~~
|
|
3279
|
+
|
|
3280
|
+
### Parameters
|
|
3281
|
+
|
|
3282
|
+
Name | Type | Description | Notes
|
|
3283
|
+
------------- | ------------- | ------------- | -------------
|
|
3284
|
+
**campaign_id** | **String**| Campaign ID |
|
|
3285
|
+
**user_id** | **String**| Agent's user ID |
|
|
3286
|
+
**body** | [**Agent**](Agent.html)| agent | [optional]
|
|
3287
|
+
{: class="table table-striped"}
|
|
3288
|
+
|
|
3289
|
+
|
|
3290
|
+
### Return type
|
|
3291
|
+
|
|
3292
|
+
**String**
|
|
3293
|
+
|
|
3294
|
+
### HTTP request headers
|
|
3295
|
+
|
|
3296
|
+
- **Content-Type**: application/json
|
|
3297
|
+
- **Accept**: application/json
|
|
3298
|
+
|
|
3299
|
+
|
|
3300
|
+
|
|
3301
|
+
<a name="put_contactlists_contactlist_id"></a>
|
|
3302
|
+
|
|
3303
|
+
## -[**ContactList**](ContactList.html) put_contactlists_contactlist_id(contact_list_id, opts)
|
|
3304
|
+
|
|
3305
|
+
Update a contact list.
|
|
3306
|
+
|
|
3307
|
+
|
|
3308
|
+
|
|
3309
|
+
### Example
|
|
3310
|
+
~~~ruby
|
|
3311
|
+
# load the gem
|
|
3312
|
+
require 'purecloud'
|
|
3313
|
+
# setup authorization
|
|
3314
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3315
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3316
|
+
environment = "mypurecloud.com"
|
|
3317
|
+
|
|
3318
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3319
|
+
|
|
3320
|
+
PureCloud.configure do |config|
|
|
3321
|
+
config.access_token = @authToken
|
|
3322
|
+
end
|
|
3323
|
+
|
|
3324
|
+
api_instance = PureCloud::OutboundApi.new
|
|
3325
|
+
|
|
3326
|
+
contact_list_id = "contact_list_id_example" # String | ContactList ID
|
|
3327
|
+
|
|
3328
|
+
opts = {
|
|
3329
|
+
body: PureCloud::ContactList.new # ContactList | ContactList
|
|
3330
|
+
}
|
|
3331
|
+
|
|
3332
|
+
begin
|
|
3333
|
+
#Update a contact list.
|
|
3334
|
+
result = api_instance.put_contactlists_contactlist_id(contact_list_id, opts)
|
|
3335
|
+
p result
|
|
3336
|
+
rescue PureCloud::ApiError => e
|
|
3337
|
+
puts "Exception when calling OutboundApi->put_contactlists_contactlist_id: #{e}"
|
|
3338
|
+
end
|
|
3339
|
+
~~~
|
|
3340
|
+
|
|
3341
|
+
### Parameters
|
|
3342
|
+
|
|
3343
|
+
Name | Type | Description | Notes
|
|
3344
|
+
------------- | ------------- | ------------- | -------------
|
|
3345
|
+
**contact_list_id** | **String**| ContactList ID |
|
|
3346
|
+
**body** | [**ContactList**](ContactList.html)| ContactList | [optional]
|
|
3347
|
+
{: class="table table-striped"}
|
|
3348
|
+
|
|
3349
|
+
|
|
3350
|
+
### Return type
|
|
3351
|
+
|
|
3352
|
+
[**ContactList**](ContactList.html)
|
|
3353
|
+
|
|
3354
|
+
### HTTP request headers
|
|
3355
|
+
|
|
3356
|
+
- **Content-Type**: application/json
|
|
3357
|
+
- **Accept**: application/json
|
|
3358
|
+
|
|
3359
|
+
|
|
3360
|
+
|
|
3361
|
+
<a name="put_contactlists_contactlist_id_contacts_contact_id"></a>
|
|
3362
|
+
|
|
3363
|
+
## -[**DialerContact**](DialerContact.html) put_contactlists_contactlist_id_contacts_contact_id(contact_list_id, contact_id, opts)
|
|
3364
|
+
|
|
3365
|
+
Update a contact.
|
|
3366
|
+
|
|
3367
|
+
|
|
3368
|
+
|
|
3369
|
+
### Example
|
|
3370
|
+
~~~ruby
|
|
3371
|
+
# load the gem
|
|
3372
|
+
require 'purecloud'
|
|
3373
|
+
# setup authorization
|
|
3374
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3375
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3376
|
+
environment = "mypurecloud.com"
|
|
3377
|
+
|
|
3378
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3379
|
+
|
|
3380
|
+
PureCloud.configure do |config|
|
|
3381
|
+
config.access_token = @authToken
|
|
3382
|
+
end
|
|
3383
|
+
|
|
3384
|
+
api_instance = PureCloud::OutboundApi.new
|
|
3385
|
+
|
|
3386
|
+
contact_list_id = "contact_list_id_example" # String | Contact List ID
|
|
3387
|
+
|
|
3388
|
+
contact_id = "contact_id_example" # String | Contact ID
|
|
3389
|
+
|
|
3390
|
+
opts = {
|
|
3391
|
+
body: PureCloud::DialerContact.new # DialerContact | Contact
|
|
3392
|
+
}
|
|
3393
|
+
|
|
3394
|
+
begin
|
|
3395
|
+
#Update a contact.
|
|
3396
|
+
result = api_instance.put_contactlists_contactlist_id_contacts_contact_id(contact_list_id, contact_id, opts)
|
|
3397
|
+
p result
|
|
3398
|
+
rescue PureCloud::ApiError => e
|
|
3399
|
+
puts "Exception when calling OutboundApi->put_contactlists_contactlist_id_contacts_contact_id: #{e}"
|
|
3400
|
+
end
|
|
3401
|
+
~~~
|
|
3402
|
+
|
|
3403
|
+
### Parameters
|
|
3404
|
+
|
|
3405
|
+
Name | Type | Description | Notes
|
|
3406
|
+
------------- | ------------- | ------------- | -------------
|
|
3407
|
+
**contact_list_id** | **String**| Contact List ID |
|
|
3408
|
+
**contact_id** | **String**| Contact ID |
|
|
3409
|
+
**body** | [**DialerContact**](DialerContact.html)| Contact | [optional]
|
|
3410
|
+
{: class="table table-striped"}
|
|
3411
|
+
|
|
3412
|
+
|
|
3413
|
+
### Return type
|
|
3414
|
+
|
|
3415
|
+
[**DialerContact**](DialerContact.html)
|
|
3416
|
+
|
|
3417
|
+
### HTTP request headers
|
|
3418
|
+
|
|
3419
|
+
- **Content-Type**: application/json
|
|
3420
|
+
- **Accept**: application/json
|
|
3421
|
+
|
|
3422
|
+
|
|
3423
|
+
|
|
3424
|
+
<a name="put_dnclists_dnclist_id"></a>
|
|
3425
|
+
|
|
3426
|
+
## -[**DncList**](DncList.html) put_dnclists_dnclist_id(dnc_list_id, opts)
|
|
3427
|
+
|
|
3428
|
+
Update dialer DNC list
|
|
3429
|
+
|
|
3430
|
+
|
|
3431
|
+
|
|
3432
|
+
### Example
|
|
3433
|
+
~~~ruby
|
|
3434
|
+
# load the gem
|
|
3435
|
+
require 'purecloud'
|
|
3436
|
+
# setup authorization
|
|
3437
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3438
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3439
|
+
environment = "mypurecloud.com"
|
|
3440
|
+
|
|
3441
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3442
|
+
|
|
3443
|
+
PureCloud.configure do |config|
|
|
3444
|
+
config.access_token = @authToken
|
|
3445
|
+
end
|
|
3446
|
+
|
|
3447
|
+
api_instance = PureCloud::OutboundApi.new
|
|
3448
|
+
|
|
3449
|
+
dnc_list_id = "dnc_list_id_example" # String | DncList ID
|
|
3450
|
+
|
|
3451
|
+
opts = {
|
|
3452
|
+
body: PureCloud::DncList.new # DncList | DncList
|
|
3453
|
+
}
|
|
3454
|
+
|
|
3455
|
+
begin
|
|
3456
|
+
#Update dialer DNC list
|
|
3457
|
+
result = api_instance.put_dnclists_dnclist_id(dnc_list_id, opts)
|
|
3458
|
+
p result
|
|
3459
|
+
rescue PureCloud::ApiError => e
|
|
3460
|
+
puts "Exception when calling OutboundApi->put_dnclists_dnclist_id: #{e}"
|
|
3461
|
+
end
|
|
3462
|
+
~~~
|
|
3463
|
+
|
|
3464
|
+
### Parameters
|
|
3465
|
+
|
|
3466
|
+
Name | Type | Description | Notes
|
|
3467
|
+
------------- | ------------- | ------------- | -------------
|
|
3468
|
+
**dnc_list_id** | **String**| DncList ID |
|
|
3469
|
+
**body** | [**DncList**](DncList.html)| DncList | [optional]
|
|
3470
|
+
{: class="table table-striped"}
|
|
3471
|
+
|
|
3472
|
+
|
|
3473
|
+
### Return type
|
|
3474
|
+
|
|
3475
|
+
[**DncList**](DncList.html)
|
|
3476
|
+
|
|
3477
|
+
### HTTP request headers
|
|
3478
|
+
|
|
3479
|
+
- **Content-Type**: application/json
|
|
3480
|
+
- **Accept**: application/json
|
|
3481
|
+
|
|
3482
|
+
|
|
3483
|
+
|
|
3484
|
+
<a name="put_rulesets_ruleset_id"></a>
|
|
3485
|
+
|
|
3486
|
+
## -[**RuleSet**](RuleSet.html) put_rulesets_ruleset_id(rule_set_id, opts)
|
|
3487
|
+
|
|
3488
|
+
Update a RuleSet.
|
|
3489
|
+
|
|
3490
|
+
|
|
3491
|
+
|
|
3492
|
+
### Example
|
|
3493
|
+
~~~ruby
|
|
3494
|
+
# load the gem
|
|
3495
|
+
require 'purecloud'
|
|
3496
|
+
# setup authorization
|
|
3497
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3498
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3499
|
+
environment = "mypurecloud.com"
|
|
3500
|
+
|
|
3501
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3502
|
+
|
|
3503
|
+
PureCloud.configure do |config|
|
|
3504
|
+
config.access_token = @authToken
|
|
3505
|
+
end
|
|
3506
|
+
|
|
3507
|
+
api_instance = PureCloud::OutboundApi.new
|
|
3508
|
+
|
|
3509
|
+
rule_set_id = "rule_set_id_example" # String | Rule Set ID
|
|
3510
|
+
|
|
3511
|
+
opts = {
|
|
3512
|
+
body: PureCloud::RuleSet.new # RuleSet | RuleSet
|
|
3513
|
+
}
|
|
3514
|
+
|
|
3515
|
+
begin
|
|
3516
|
+
#Update a RuleSet.
|
|
3517
|
+
result = api_instance.put_rulesets_ruleset_id(rule_set_id, opts)
|
|
3518
|
+
p result
|
|
3519
|
+
rescue PureCloud::ApiError => e
|
|
3520
|
+
puts "Exception when calling OutboundApi->put_rulesets_ruleset_id: #{e}"
|
|
3521
|
+
end
|
|
3522
|
+
~~~
|
|
3523
|
+
|
|
3524
|
+
### Parameters
|
|
3525
|
+
|
|
3526
|
+
Name | Type | Description | Notes
|
|
3527
|
+
------------- | ------------- | ------------- | -------------
|
|
3528
|
+
**rule_set_id** | **String**| Rule Set ID |
|
|
3529
|
+
**body** | [**RuleSet**](RuleSet.html)| RuleSet | [optional]
|
|
3530
|
+
{: class="table table-striped"}
|
|
3531
|
+
|
|
3532
|
+
|
|
3533
|
+
### Return type
|
|
3534
|
+
|
|
3535
|
+
[**RuleSet**](RuleSet.html)
|
|
3536
|
+
|
|
3537
|
+
### HTTP request headers
|
|
3538
|
+
|
|
3539
|
+
- **Content-Type**: application/json
|
|
3540
|
+
- **Accept**: application/json
|
|
3541
|
+
|
|
3542
|
+
|
|
3543
|
+
|
|
3544
|
+
<a name="put_schedules_campaigns_campaign_id"></a>
|
|
3545
|
+
|
|
3546
|
+
## -[**CampaignSchedule**](CampaignSchedule.html) put_schedules_campaigns_campaign_id(campaign_id, opts)
|
|
3547
|
+
|
|
3548
|
+
Update a new campaign schedule.
|
|
3549
|
+
|
|
3550
|
+
|
|
3551
|
+
|
|
3552
|
+
### Example
|
|
3553
|
+
~~~ruby
|
|
3554
|
+
# load the gem
|
|
3555
|
+
require 'purecloud'
|
|
3556
|
+
# setup authorization
|
|
3557
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3558
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3559
|
+
environment = "mypurecloud.com"
|
|
3560
|
+
|
|
3561
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3562
|
+
|
|
3563
|
+
PureCloud.configure do |config|
|
|
3564
|
+
config.access_token = @authToken
|
|
3565
|
+
end
|
|
3566
|
+
|
|
3567
|
+
api_instance = PureCloud::OutboundApi.new
|
|
3568
|
+
|
|
3569
|
+
campaign_id = "campaign_id_example" # String | Campaign ID
|
|
3570
|
+
|
|
3571
|
+
opts = {
|
|
3572
|
+
body: PureCloud::CampaignSchedule.new # CampaignSchedule | CampaignSchedule
|
|
3573
|
+
}
|
|
3574
|
+
|
|
3575
|
+
begin
|
|
3576
|
+
#Update a new campaign schedule.
|
|
3577
|
+
result = api_instance.put_schedules_campaigns_campaign_id(campaign_id, opts)
|
|
3578
|
+
p result
|
|
3579
|
+
rescue PureCloud::ApiError => e
|
|
3580
|
+
puts "Exception when calling OutboundApi->put_schedules_campaigns_campaign_id: #{e}"
|
|
3581
|
+
end
|
|
3582
|
+
~~~
|
|
3583
|
+
|
|
3584
|
+
### Parameters
|
|
3585
|
+
|
|
3586
|
+
Name | Type | Description | Notes
|
|
3587
|
+
------------- | ------------- | ------------- | -------------
|
|
3588
|
+
**campaign_id** | **String**| Campaign ID |
|
|
3589
|
+
**body** | [**CampaignSchedule**](CampaignSchedule.html)| CampaignSchedule | [optional]
|
|
3590
|
+
{: class="table table-striped"}
|
|
3591
|
+
|
|
3592
|
+
|
|
3593
|
+
### Return type
|
|
3594
|
+
|
|
3595
|
+
[**CampaignSchedule**](CampaignSchedule.html)
|
|
3596
|
+
|
|
3597
|
+
### HTTP request headers
|
|
3598
|
+
|
|
3599
|
+
- **Content-Type**: application/json
|
|
3600
|
+
- **Accept**: application/json
|
|
3601
|
+
|
|
3602
|
+
|
|
3603
|
+
|
|
3604
|
+
<a name="put_schedules_sequences_sequence_id"></a>
|
|
3605
|
+
|
|
3606
|
+
## -[**SequenceSchedule**](SequenceSchedule.html) put_schedules_sequences_sequence_id(sequence_id, opts)
|
|
3607
|
+
|
|
3608
|
+
Update a new sequence schedule.
|
|
3609
|
+
|
|
3610
|
+
|
|
3611
|
+
|
|
3612
|
+
### Example
|
|
3613
|
+
~~~ruby
|
|
3614
|
+
# load the gem
|
|
3615
|
+
require 'purecloud'
|
|
3616
|
+
# setup authorization
|
|
3617
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3618
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3619
|
+
environment = "mypurecloud.com"
|
|
3620
|
+
|
|
3621
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3622
|
+
|
|
3623
|
+
PureCloud.configure do |config|
|
|
3624
|
+
config.access_token = @authToken
|
|
3625
|
+
end
|
|
3626
|
+
|
|
3627
|
+
api_instance = PureCloud::OutboundApi.new
|
|
3628
|
+
|
|
3629
|
+
sequence_id = "sequence_id_example" # String | Sequence ID
|
|
3630
|
+
|
|
3631
|
+
opts = {
|
|
3632
|
+
body: PureCloud::SequenceSchedule.new # SequenceSchedule | SequenceSchedule
|
|
3633
|
+
}
|
|
3634
|
+
|
|
3635
|
+
begin
|
|
3636
|
+
#Update a new sequence schedule.
|
|
3637
|
+
result = api_instance.put_schedules_sequences_sequence_id(sequence_id, opts)
|
|
3638
|
+
p result
|
|
3639
|
+
rescue PureCloud::ApiError => e
|
|
3640
|
+
puts "Exception when calling OutboundApi->put_schedules_sequences_sequence_id: #{e}"
|
|
3641
|
+
end
|
|
3642
|
+
~~~
|
|
3643
|
+
|
|
3644
|
+
### Parameters
|
|
3645
|
+
|
|
3646
|
+
Name | Type | Description | Notes
|
|
3647
|
+
------------- | ------------- | ------------- | -------------
|
|
3648
|
+
**sequence_id** | **String**| Sequence ID |
|
|
3649
|
+
**body** | [**SequenceSchedule**](SequenceSchedule.html)| SequenceSchedule | [optional]
|
|
3650
|
+
{: class="table table-striped"}
|
|
3651
|
+
|
|
3652
|
+
|
|
3653
|
+
### Return type
|
|
3654
|
+
|
|
3655
|
+
[**SequenceSchedule**](SequenceSchedule.html)
|
|
3656
|
+
|
|
3657
|
+
### HTTP request headers
|
|
3658
|
+
|
|
3659
|
+
- **Content-Type**: application/json
|
|
3660
|
+
- **Accept**: application/json
|
|
3661
|
+
|
|
3662
|
+
|
|
3663
|
+
|
|
3664
|
+
<a name="put_sequences_sequence_id"></a>
|
|
3665
|
+
|
|
3666
|
+
## -[**CampaignSequence**](CampaignSequence.html) put_sequences_sequence_id(sequence_id, opts)
|
|
3667
|
+
|
|
3668
|
+
Update a new campaign sequence.
|
|
3669
|
+
|
|
3670
|
+
|
|
3671
|
+
|
|
3672
|
+
### Example
|
|
3673
|
+
~~~ruby
|
|
3674
|
+
# load the gem
|
|
3675
|
+
require 'purecloud'
|
|
3676
|
+
# setup authorization
|
|
3677
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3678
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3679
|
+
environment = "mypurecloud.com"
|
|
3680
|
+
|
|
3681
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3682
|
+
|
|
3683
|
+
PureCloud.configure do |config|
|
|
3684
|
+
config.access_token = @authToken
|
|
3685
|
+
end
|
|
3686
|
+
|
|
3687
|
+
api_instance = PureCloud::OutboundApi.new
|
|
3688
|
+
|
|
3689
|
+
sequence_id = "sequence_id_example" # String | Campaign Sequence ID
|
|
3690
|
+
|
|
3691
|
+
opts = {
|
|
3692
|
+
body: PureCloud::CampaignSequence.new # CampaignSequence | Organization
|
|
3693
|
+
}
|
|
3694
|
+
|
|
3695
|
+
begin
|
|
3696
|
+
#Update a new campaign sequence.
|
|
3697
|
+
result = api_instance.put_sequences_sequence_id(sequence_id, opts)
|
|
3698
|
+
p result
|
|
3699
|
+
rescue PureCloud::ApiError => e
|
|
3700
|
+
puts "Exception when calling OutboundApi->put_sequences_sequence_id: #{e}"
|
|
3701
|
+
end
|
|
3702
|
+
~~~
|
|
3703
|
+
|
|
3704
|
+
### Parameters
|
|
3705
|
+
|
|
3706
|
+
Name | Type | Description | Notes
|
|
3707
|
+
------------- | ------------- | ------------- | -------------
|
|
3708
|
+
**sequence_id** | **String**| Campaign Sequence ID |
|
|
3709
|
+
**body** | [**CampaignSequence**](CampaignSequence.html)| Organization | [optional]
|
|
3710
|
+
{: class="table table-striped"}
|
|
3711
|
+
|
|
3712
|
+
|
|
3713
|
+
### Return type
|
|
3714
|
+
|
|
3715
|
+
[**CampaignSequence**](CampaignSequence.html)
|
|
3716
|
+
|
|
3717
|
+
### HTTP request headers
|
|
3718
|
+
|
|
3719
|
+
- **Content-Type**: application/json
|
|
3720
|
+
- **Accept**: application/json
|
|
3721
|
+
|
|
3722
|
+
|
|
3723
|
+
|
|
3724
|
+
<a name="put_wrapupcodemappings"></a>
|
|
3725
|
+
|
|
3726
|
+
## -[**WrapUpCodeMapping**](WrapUpCodeMapping.html) put_wrapupcodemappings(opts)
|
|
3727
|
+
|
|
3728
|
+
Update the Dialer wrap up code mapping.
|
|
3729
|
+
|
|
3730
|
+
|
|
3731
|
+
|
|
3732
|
+
### Example
|
|
3733
|
+
~~~ruby
|
|
3734
|
+
# load the gem
|
|
3735
|
+
require 'purecloud'
|
|
3736
|
+
# setup authorization
|
|
3737
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3738
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3739
|
+
environment = "mypurecloud.com"
|
|
3740
|
+
|
|
3741
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3742
|
+
|
|
3743
|
+
PureCloud.configure do |config|
|
|
3744
|
+
config.access_token = @authToken
|
|
3745
|
+
end
|
|
3746
|
+
|
|
3747
|
+
api_instance = PureCloud::OutboundApi.new
|
|
3748
|
+
|
|
3749
|
+
opts = {
|
|
3750
|
+
body: PureCloud::WrapUpCodeMapping.new # WrapUpCodeMapping | wrapUpCodeMapping
|
|
3751
|
+
}
|
|
3752
|
+
|
|
3753
|
+
begin
|
|
3754
|
+
#Update the Dialer wrap up code mapping.
|
|
3755
|
+
result = api_instance.put_wrapupcodemappings(opts)
|
|
3756
|
+
p result
|
|
3757
|
+
rescue PureCloud::ApiError => e
|
|
3758
|
+
puts "Exception when calling OutboundApi->put_wrapupcodemappings: #{e}"
|
|
3759
|
+
end
|
|
3760
|
+
~~~
|
|
3761
|
+
|
|
3762
|
+
### Parameters
|
|
3763
|
+
|
|
3764
|
+
Name | Type | Description | Notes
|
|
3765
|
+
------------- | ------------- | ------------- | -------------
|
|
3766
|
+
**body** | [**WrapUpCodeMapping**](WrapUpCodeMapping.html)| wrapUpCodeMapping | [optional]
|
|
3767
|
+
{: class="table table-striped"}
|
|
3768
|
+
|
|
3769
|
+
|
|
3770
|
+
### Return type
|
|
3771
|
+
|
|
3772
|
+
[**WrapUpCodeMapping**](WrapUpCodeMapping.html)
|
|
3773
|
+
|
|
3774
|
+
### HTTP request headers
|
|
3775
|
+
|
|
3776
|
+
- **Content-Type**: application/json
|
|
3777
|
+
- **Accept**: application/json
|
|
3778
|
+
|
|
3779
|
+
|
|
3780
|
+
|