purecloudplatformclientv2 45.0.0 → 46.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/ADFS.md +1 -1
- data/docs/ActionEntityListing.md +1 -1
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/AnalyticsApi.md +67 -0
- data/docs/AnalyticsSession.md +1 -0
- data/docs/ArchitectApi.md +8 -10
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AttributeEntityListing.md +1 -1
- data/docs/AuthzDivisionEntityListing.md +1 -1
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/CallbackConversationEntityListing.md +1 -1
- data/docs/CampaignDivisionViewListing.md +1 -1
- data/docs/CampaignEntityListing.md +1 -1
- data/docs/CampaignRuleEntityListing.md +1 -1
- data/docs/CampaignSequenceEntityListing.md +1 -1
- data/docs/CertificateAuthorityEntityListing.md +1 -1
- data/docs/CertificateDetails.md +1 -1
- data/docs/ChatConversationEntityListing.md +1 -1
- data/docs/ClientAppEntityListing.md +1 -1
- data/docs/CobrowseConversationEntityListing.md +1 -1
- data/docs/CommandStatusEntityListing.md +1 -1
- data/docs/ConsumedResourcesEntityListing.md +1 -1
- data/docs/ConsumingResourcesEntityListing.md +1 -1
- data/docs/ContactListDivisionViewListing.md +1 -1
- data/docs/ContactListEntityListing.md +1 -1
- data/docs/ContactListFilterEntityListing.md +1 -1
- data/docs/ContactListing.md +1 -1
- data/docs/ConversationEntityListing.md +1 -1
- data/docs/ConversationsApi.md +67 -0
- data/docs/CreateCallRequest.md +1 -0
- data/docs/CredentialInfoListing.md +1 -1
- data/docs/CredentialTypeListing.md +1 -1
- data/docs/CustomerInteractionCenter.md +1 -1
- data/docs/DIDEntityListing.md +1 -1
- data/docs/DIDPoolEntityListing.md +1 -1
- data/docs/DataTableRowEntityListing.md +1 -1
- data/docs/DataTablesDomainEntityListing.md +1 -1
- data/docs/DependencyObjectEntityListing.md +1 -1
- data/docs/DependencyTypeEntityListing.md +1 -1
- data/docs/DialerEventEntityListing.md +1 -1
- data/docs/DirectoryUserDevicesListing.md +1 -1
- data/docs/DncListDivisionView.md +18 -0
- data/docs/DncListDivisionViewListing.md +22 -0
- data/docs/DncListEntityListing.md +1 -1
- data/docs/DocumentAuditEntityListing.md +1 -1
- data/docs/DocumentEntityListing.md +1 -1
- data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
- data/docs/DomainEntityListing.md +1 -1
- data/docs/DomainEntityListingEvaluationForm.md +1 -1
- data/docs/DomainEntityListingQueryResult.md +1 -1
- data/docs/DomainEntityListingSurveyForm.md +1 -1
- data/docs/EdgeEntityListing.md +1 -1
- data/docs/EdgeGroupEntityListing.md +1 -1
- data/docs/EdgeLineEntityListing.md +1 -1
- data/docs/EmailConversationEntityListing.md +1 -1
- data/docs/EmailMessageListing.md +1 -1
- data/docs/EmergencyGroupListing.md +1 -1
- data/docs/EncryptionKeyEntityListing.md +1 -1
- data/docs/EndpointEntityListing.md +1 -1
- data/docs/EvaluationEntityListing.md +1 -1
- data/docs/EvaluationFormEntityListing.md +1 -1
- data/docs/EvaluatorActivityEntityListing.md +1 -1
- data/docs/ExtensionEntityListing.md +1 -1
- data/docs/ExtensionPoolEntityListing.md +1 -1
- data/docs/ExternalOrganizationListing.md +1 -1
- data/docs/FacebookIntegrationEntityListing.md +1 -1
- data/docs/FaxDocumentEntityListing.md +1 -1
- data/docs/FlowDivisionViewEntityListing.md +1 -1
- data/docs/FlowEntityListing.md +1 -1
- data/docs/FlowVersionEntityListing.md +1 -1
- data/docs/GDPRRequestEntityListing.md +1 -1
- data/docs/GDPRSubjectEntityListing.md +1 -1
- data/docs/GSuite.md +1 -1
- data/docs/GreetingListing.md +1 -1
- data/docs/GroupEntityListing.md +1 -1
- data/docs/GroupProfileEntityListing.md +1 -1
- data/docs/IVREntityListing.md +1 -1
- data/docs/IdentityNow.md +1 -1
- data/docs/InboundDomainEntityListing.md +1 -1
- data/docs/InboundRouteEntityListing.md +1 -1
- data/docs/IntegrationEntityListing.md +1 -1
- data/docs/IntegrationEventEntityListing.md +1 -1
- data/docs/IntegrationTypeEntityListing.md +1 -1
- data/docs/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LibraryEntityListing.md +1 -1
- data/docs/LineBaseEntityListing.md +1 -1
- data/docs/LineEntityListing.md +1 -1
- data/docs/LineIntegrationEntityListing.md +1 -1
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/MessageConversationEntityListing.md +1 -1
- data/docs/MessageMediaAttachment.md +17 -0
- data/docs/MessageStickerAttachment.md +14 -0
- data/docs/MessagingStickerEntityListing.md +1 -1
- data/docs/NoteListing.md +1 -1
- data/docs/OAuthClientEntityListing.md +1 -1
- data/docs/OAuthProviderEntityListing.md +1 -1
- data/docs/Okta.md +1 -1
- data/docs/OneLogin.md +1 -1
- data/docs/OrganizationPresenceEntityListing.md +1 -1
- data/docs/OrganizationRoleEntityListing.md +1 -1
- data/docs/OrphanRecordingListing.md +1 -1
- data/docs/OutboundApi.md +228 -66
- data/docs/OutboundRouteBaseEntityListing.md +1 -1
- data/docs/OutboundRouteEntityListing.md +1 -1
- data/docs/PermissionCollectionEntityListing.md +1 -1
- data/docs/PhoneBaseEntityListing.md +1 -1
- data/docs/PhoneEntityListing.md +1 -1
- data/docs/PhoneMetaBaseEntityListing.md +1 -1
- data/docs/PhysicalInterfaceEntityListing.md +1 -1
- data/docs/PingIdentity.md +1 -1
- data/docs/PolicyEntityListing.md +1 -1
- data/docs/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- data/docs/QualityApi.md +83 -7
- data/docs/QualityAuditPage.md +1 -1
- data/docs/QueueEntityListing.md +1 -1
- data/docs/QueueMemberEntityListing.md +1 -1
- data/docs/RecipientListing.md +1 -1
- data/docs/RecordingMessagingMessage.md +2 -0
- data/docs/RelationshipListing.md +1 -1
- data/docs/ReportMetaDataEntityListing.md +1 -1
- data/docs/ReportRunEntryEntityDomainListing.md +1 -1
- data/docs/ReportScheduleEntityListing.md +1 -1
- data/docs/ReportingExportJobListing.md +1 -1
- data/docs/ResponseEntityList.md +1 -1
- data/docs/ResponseEntityListing.md +1 -1
- data/docs/ResponseSetEntityListing.md +1 -1
- data/docs/RoutingApi.md +6 -2
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/Salesforce.md +1 -1
- data/docs/ScheduleEntityListing.md +1 -1
- data/docs/ScheduleGroupEntityListing.md +1 -1
- data/docs/SchemaCategoryEntityListing.md +1 -1
- data/docs/SchemaReferenceEntityListing.md +1 -1
- data/docs/ScreenRecordingSessionListing.md +1 -1
- data/docs/ScriptEntityListing.md +1 -1
- data/docs/SecurityProfileEntityListing.md +1 -1
- data/docs/ShareEntityListing.md +1 -1
- data/docs/SiteEntityListing.md +1 -1
- data/docs/SkillEntityListing.md +1 -1
- data/docs/SmsPhoneNumberEntityListing.md +1 -1
- data/docs/StationEntityListing.md +1 -1
- data/docs/SubjectDivisionGrantsEntityListing.md +1 -1
- data/docs/SurveyFormEntityListing.md +1 -1
- data/docs/SystemPromptAssetEntityListing.md +1 -1
- data/docs/SystemPromptEntityListing.md +1 -1
- data/docs/TagValueEntityListing.md +1 -1
- data/docs/TextMessageListing.md +1 -1
- data/docs/TimeZoneEntityListing.md +1 -1
- data/docs/TrunkBaseEntityListing.md +1 -1
- data/docs/TrunkEntityListing.md +1 -1
- data/docs/TrunkMetabaseEntityListing.md +1 -1
- data/docs/TrustEntityListing.md +1 -1
- data/docs/TrustUserEntityListing.md +1 -1
- data/docs/TrustorEntityListing.md +1 -1
- data/docs/TwitterIntegrationEntityListing.md +1 -1
- data/docs/UserActionCategoryEntityListing.md +1 -1
- data/docs/UserEntityListing.md +1 -1
- data/docs/UserLanguageEntityListing.md +1 -1
- data/docs/UserProfileEntityListing.md +1 -1
- data/docs/UserQueueEntityListing.md +1 -1
- data/docs/UserRecordingEntityListing.md +1 -1
- data/docs/UserSkillEntityListing.md +1 -1
- data/docs/ViewFilter.md +7 -0
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +4 -0
- data/lib/purecloudplatformclientv2/api/analytics_api.rb +64 -0
- data/lib/purecloudplatformclientv2/api/architect_api.rb +12 -26
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +64 -0
- data/lib/purecloudplatformclientv2/api/outbound_api.rb +312 -66
- data/lib/purecloudplatformclientv2/api/quality_api.rb +110 -8
- data/lib/purecloudplatformclientv2/api/routing_api.rb +18 -0
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/adfs.rb +12 -12
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/analytics_session.rb +30 -4
- data/lib/purecloudplatformclientv2/models/async_week_schedule_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/attribute_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/certificate_details.rb +13 -13
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/conversation_notification_message_details.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_notification_messages.rb +2 -2
- data/lib/purecloudplatformclientv2/models/create_call_request.rb +30 -4
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/customer_interaction_center.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dnc_list_division_view.rb +331 -0
- data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/endpoint_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/g_suite.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/generate_short_term_forecast_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/generate_week_schedule_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/identity_now.rb +12 -12
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/message_conversation_notification_message_details.rb +2 -2
- data/lib/purecloudplatformclientv2/models/message_conversation_notification_messages.rb +2 -2
- data/lib/purecloudplatformclientv2/models/message_media_attachment.rb +318 -0
- data/lib/purecloudplatformclientv2/models/message_sticker_attachment.rb +227 -0
- data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/note_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/okta.rb +12 -12
- data/lib/purecloudplatformclientv2/models/one_login.rb +12 -12
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/ping_identity.rb +12 -12
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/recording_messaging_message.rb +58 -4
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/salesforce.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/short_term_forecast_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/view_filter.rb +232 -4
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_calculations_complete_notice_notification.rb +2 -2
- data/lib/purecloudplatformclientv2/models/wfm_schedule_notification_notification.rb +2 -2
- data/lib/purecloudplatformclientv2/models/wfm_update_agent_details_complete_notification.rb +2 -2
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +10 -2
|
@@ -11,8 +11,8 @@ title: MessagingStickerEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
data/docs/NoteListing.md
CHANGED
|
@@ -11,8 +11,8 @@ title: NoteListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: OAuthClientEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: OAuthProviderEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
data/docs/Okta.md
CHANGED
|
@@ -10,8 +10,8 @@ title: Okta
|
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
11
|
| **name** | **String** | | [optional] |
|
|
12
12
|
| **certificate** | **String** | | [optional] |
|
|
13
|
-
| **sso_target_uri** | **String** | | [optional] |
|
|
14
13
|
| **issuer_uri** | **String** | | [optional] |
|
|
14
|
+
| **sso_target_uri** | **String** | | [optional] |
|
|
15
15
|
| **disabled** | **BOOLEAN** | | [optional] |
|
|
16
16
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
17
17
|
{: class="table table-striped"}
|
data/docs/OneLogin.md
CHANGED
|
@@ -10,8 +10,8 @@ title: OneLogin
|
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
11
|
| **name** | **String** | | [optional] |
|
|
12
12
|
| **certificate** | **String** | | [optional] |
|
|
13
|
-
| **sso_target_uri** | **String** | | [optional] |
|
|
14
13
|
| **issuer_uri** | **String** | | [optional] |
|
|
14
|
+
| **sso_target_uri** | **String** | | [optional] |
|
|
15
15
|
| **disabled** | **BOOLEAN** | | [optional] |
|
|
16
16
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
17
17
|
{: class="table table-striped"}
|
|
@@ -11,8 +11,8 @@ title: OrganizationPresenceEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: OrganizationRoleEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: OrphanRecordingListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
data/docs/OutboundApi.md
CHANGED
|
@@ -47,11 +47,14 @@ Method | Description
|
|
|
47
47
|
[**get_outbound_contactlistfilter**](OutboundApi.html#get_outbound_contactlistfilter) | Get Contact list filter
|
|
48
48
|
[**get_outbound_contactlistfilters**](OutboundApi.html#get_outbound_contactlistfilters) | Query Contact list filters
|
|
49
49
|
[**get_outbound_contactlists**](OutboundApi.html#get_outbound_contactlists) | Query a list of contact lists.
|
|
50
|
+
[**get_outbound_contactlists_divisionview**](OutboundApi.html#get_outbound_contactlists_divisionview) | Get a basic ContactList information object
|
|
50
51
|
[**get_outbound_contactlists_divisionviews**](OutboundApi.html#get_outbound_contactlists_divisionviews) | Query a list of simplified contact list objects.
|
|
51
52
|
[**get_outbound_dnclist**](OutboundApi.html#get_outbound_dnclist) | Get dialer DNC list
|
|
52
53
|
[**get_outbound_dnclist_export**](OutboundApi.html#get_outbound_dnclist_export) | Get the URI of a DNC list export.
|
|
53
54
|
[**get_outbound_dnclist_importstatus**](OutboundApi.html#get_outbound_dnclist_importstatus) | Get dialer dncList import status.
|
|
54
55
|
[**get_outbound_dnclists**](OutboundApi.html#get_outbound_dnclists) | Query dialer DNC lists
|
|
56
|
+
[**get_outbound_dnclists_divisionview**](OutboundApi.html#get_outbound_dnclists_divisionview) | Get a basic DncList information object
|
|
57
|
+
[**get_outbound_dnclists_divisionviews**](OutboundApi.html#get_outbound_dnclists_divisionviews) | Query a list of simplified dnc list objects.
|
|
55
58
|
[**get_outbound_event**](OutboundApi.html#get_outbound_event) | Get Dialer Event
|
|
56
59
|
[**get_outbound_events**](OutboundApi.html#get_outbound_events) | Query Event Logs
|
|
57
60
|
[**get_outbound_ruleset**](OutboundApi.html#get_outbound_ruleset) | Get a Rule Set by ID.
|
|
@@ -73,7 +76,6 @@ Method | Description
|
|
|
73
76
|
[**post_outbound_campaignrules**](OutboundApi.html#post_outbound_campaignrules) | Create Campaign Rule
|
|
74
77
|
[**post_outbound_campaigns**](OutboundApi.html#post_outbound_campaigns) | Create a campaign.
|
|
75
78
|
[**post_outbound_campaigns_progress**](OutboundApi.html#post_outbound_campaigns_progress) | Get progress for a list of campaigns
|
|
76
|
-
[**post_outbound_contactlist_clear**](OutboundApi.html#post_outbound_contactlist_clear) | Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled.
|
|
77
79
|
[**post_outbound_contactlist_contacts**](OutboundApi.html#post_outbound_contactlist_contacts) | Add contacts to a contact list.
|
|
78
80
|
[**post_outbound_contactlist_contacts_bulk**](OutboundApi.html#post_outbound_contactlist_contacts_bulk) | Get contacts from a contact list.
|
|
79
81
|
[**post_outbound_contactlist_export**](OutboundApi.html#post_outbound_contactlist_export) | Initiate the export of a contact list.
|
|
@@ -2755,6 +2757,77 @@ Name | Type | Description | Notes
|
|
|
2755
2757
|
|
|
2756
2758
|
|
|
2757
2759
|
|
|
2760
|
+
<a name="get_outbound_contactlists_divisionview"></a>
|
|
2761
|
+
|
|
2762
|
+
## -[**ContactListDivisionView**](ContactListDivisionView.html) get_outbound_contactlists_divisionview(contact_list_id, opts)
|
|
2763
|
+
|
|
2764
|
+
|
|
2765
|
+
|
|
2766
|
+
Get a basic ContactList information object
|
|
2767
|
+
|
|
2768
|
+
This returns a simplified version of a ContactList, consisting of the name, division, column names, phone columns, import status, and size.
|
|
2769
|
+
|
|
2770
|
+
Wraps GET /api/v2/outbound/contactlists/divisionviews/{contactListId}
|
|
2771
|
+
|
|
2772
|
+
Requires ANY permissions:
|
|
2773
|
+
|
|
2774
|
+
* outbound:contactList:search
|
|
2775
|
+
|
|
2776
|
+
|
|
2777
|
+
### Example
|
|
2778
|
+
~~~ruby
|
|
2779
|
+
# load the gem
|
|
2780
|
+
require 'purecloudplatformclientv2'
|
|
2781
|
+
# setup authorization
|
|
2782
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2783
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2784
|
+
environment = "mypurecloud.com"
|
|
2785
|
+
|
|
2786
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2787
|
+
|
|
2788
|
+
PureCloud.configure do |config|
|
|
2789
|
+
config.access_token = @authToken
|
|
2790
|
+
end
|
|
2791
|
+
|
|
2792
|
+
api_instance = PureCloud::OutboundApi.new
|
|
2793
|
+
|
|
2794
|
+
contact_list_id = "contact_list_id_example" # String | Contactlist ID
|
|
2795
|
+
|
|
2796
|
+
opts = {
|
|
2797
|
+
include_import_status: false, # BOOLEAN | Include import status
|
|
2798
|
+
include_size: false # BOOLEAN | Include size
|
|
2799
|
+
}
|
|
2800
|
+
|
|
2801
|
+
begin
|
|
2802
|
+
#Get a basic ContactList information object
|
|
2803
|
+
result = api_instance.get_outbound_contactlists_divisionview(contact_list_id, opts)
|
|
2804
|
+
p result
|
|
2805
|
+
rescue PureCloud::ApiError => e
|
|
2806
|
+
puts "Exception when calling OutboundApi->get_outbound_contactlists_divisionview: #{e}"
|
|
2807
|
+
end
|
|
2808
|
+
~~~
|
|
2809
|
+
|
|
2810
|
+
### Parameters
|
|
2811
|
+
|
|
2812
|
+
Name | Type | Description | Notes
|
|
2813
|
+
------------- | ------------- | ------------- | -------------
|
|
2814
|
+
**contact_list_id** | **String**| Contactlist ID | |
|
|
2815
|
+
**include_import_status** | **BOOLEAN**| Include import status | [optional] [default to false] |
|
|
2816
|
+
**include_size** | **BOOLEAN**| Include size | [optional] [default to false] |
|
|
2817
|
+
{: class="table table-striped"}
|
|
2818
|
+
|
|
2819
|
+
|
|
2820
|
+
### Return type
|
|
2821
|
+
|
|
2822
|
+
[**ContactListDivisionView**](ContactListDivisionView.html)
|
|
2823
|
+
|
|
2824
|
+
### HTTP request headers
|
|
2825
|
+
|
|
2826
|
+
- **Content-Type**: application/json
|
|
2827
|
+
- **Accept**: application/json
|
|
2828
|
+
|
|
2829
|
+
|
|
2830
|
+
|
|
2758
2831
|
<a name="get_outbound_contactlists_divisionviews"></a>
|
|
2759
2832
|
|
|
2760
2833
|
## -[**ContactListDivisionViewListing**](ContactListDivisionViewListing.html) get_outbound_contactlists_divisionviews(opts)
|
|
@@ -2763,7 +2836,7 @@ Name | Type | Description | Notes
|
|
|
2763
2836
|
|
|
2764
2837
|
Query a list of simplified contact list objects.
|
|
2765
2838
|
|
|
2766
|
-
This return a simplified version of contact lists, consisting of the name,
|
|
2839
|
+
This return a simplified version of contact lists, consisting of the name, division, column names, phone columns, import status, and size.
|
|
2767
2840
|
|
|
2768
2841
|
Wraps GET /api/v2/outbound/contactlists/divisionviews
|
|
2769
2842
|
|
|
@@ -3127,6 +3200,159 @@ Name | Type | Description | Notes
|
|
|
3127
3200
|
|
|
3128
3201
|
|
|
3129
3202
|
|
|
3203
|
+
<a name="get_outbound_dnclists_divisionview"></a>
|
|
3204
|
+
|
|
3205
|
+
## -[**DncListDivisionView**](DncListDivisionView.html) get_outbound_dnclists_divisionview(dnc_list_id, opts)
|
|
3206
|
+
|
|
3207
|
+
|
|
3208
|
+
|
|
3209
|
+
Get a basic DncList information object
|
|
3210
|
+
|
|
3211
|
+
This returns a simplified version of a DncList, consisting of the name, division, import status, and size.
|
|
3212
|
+
|
|
3213
|
+
Wraps GET /api/v2/outbound/dnclists/divisionviews/{dncListId}
|
|
3214
|
+
|
|
3215
|
+
Requires ANY permissions:
|
|
3216
|
+
|
|
3217
|
+
* outbound:dncList:search
|
|
3218
|
+
|
|
3219
|
+
|
|
3220
|
+
### Example
|
|
3221
|
+
~~~ruby
|
|
3222
|
+
# load the gem
|
|
3223
|
+
require 'purecloudplatformclientv2'
|
|
3224
|
+
# setup authorization
|
|
3225
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3226
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3227
|
+
environment = "mypurecloud.com"
|
|
3228
|
+
|
|
3229
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3230
|
+
|
|
3231
|
+
PureCloud.configure do |config|
|
|
3232
|
+
config.access_token = @authToken
|
|
3233
|
+
end
|
|
3234
|
+
|
|
3235
|
+
api_instance = PureCloud::OutboundApi.new
|
|
3236
|
+
|
|
3237
|
+
dnc_list_id = "dnc_list_id_example" # String | Dnclist ID
|
|
3238
|
+
|
|
3239
|
+
opts = {
|
|
3240
|
+
include_import_status: false, # BOOLEAN | Include import status
|
|
3241
|
+
include_size: false # BOOLEAN | Include size
|
|
3242
|
+
}
|
|
3243
|
+
|
|
3244
|
+
begin
|
|
3245
|
+
#Get a basic DncList information object
|
|
3246
|
+
result = api_instance.get_outbound_dnclists_divisionview(dnc_list_id, opts)
|
|
3247
|
+
p result
|
|
3248
|
+
rescue PureCloud::ApiError => e
|
|
3249
|
+
puts "Exception when calling OutboundApi->get_outbound_dnclists_divisionview: #{e}"
|
|
3250
|
+
end
|
|
3251
|
+
~~~
|
|
3252
|
+
|
|
3253
|
+
### Parameters
|
|
3254
|
+
|
|
3255
|
+
Name | Type | Description | Notes
|
|
3256
|
+
------------- | ------------- | ------------- | -------------
|
|
3257
|
+
**dnc_list_id** | **String**| Dnclist ID | |
|
|
3258
|
+
**include_import_status** | **BOOLEAN**| Include import status | [optional] [default to false] |
|
|
3259
|
+
**include_size** | **BOOLEAN**| Include size | [optional] [default to false] |
|
|
3260
|
+
{: class="table table-striped"}
|
|
3261
|
+
|
|
3262
|
+
|
|
3263
|
+
### Return type
|
|
3264
|
+
|
|
3265
|
+
[**DncListDivisionView**](DncListDivisionView.html)
|
|
3266
|
+
|
|
3267
|
+
### HTTP request headers
|
|
3268
|
+
|
|
3269
|
+
- **Content-Type**: application/json
|
|
3270
|
+
- **Accept**: application/json
|
|
3271
|
+
|
|
3272
|
+
|
|
3273
|
+
|
|
3274
|
+
<a name="get_outbound_dnclists_divisionviews"></a>
|
|
3275
|
+
|
|
3276
|
+
## -[**DncListDivisionViewListing**](DncListDivisionViewListing.html) get_outbound_dnclists_divisionviews(opts)
|
|
3277
|
+
|
|
3278
|
+
|
|
3279
|
+
|
|
3280
|
+
Query a list of simplified dnc list objects.
|
|
3281
|
+
|
|
3282
|
+
This return a simplified version of dnc lists, consisting of the name, division, import status, and size.
|
|
3283
|
+
|
|
3284
|
+
Wraps GET /api/v2/outbound/dnclists/divisionviews
|
|
3285
|
+
|
|
3286
|
+
Requires ANY permissions:
|
|
3287
|
+
|
|
3288
|
+
* outbound:dncList:search
|
|
3289
|
+
|
|
3290
|
+
|
|
3291
|
+
### Example
|
|
3292
|
+
~~~ruby
|
|
3293
|
+
# load the gem
|
|
3294
|
+
require 'purecloudplatformclientv2'
|
|
3295
|
+
# setup authorization
|
|
3296
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3297
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3298
|
+
environment = "mypurecloud.com"
|
|
3299
|
+
|
|
3300
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3301
|
+
|
|
3302
|
+
PureCloud.configure do |config|
|
|
3303
|
+
config.access_token = @authToken
|
|
3304
|
+
end
|
|
3305
|
+
|
|
3306
|
+
api_instance = PureCloud::OutboundApi.new
|
|
3307
|
+
|
|
3308
|
+
opts = {
|
|
3309
|
+
include_import_status: false, # BOOLEAN | Include import status
|
|
3310
|
+
include_size: false, # BOOLEAN | Include size
|
|
3311
|
+
page_size: 25, # Integer | Page size. The max that will be returned is 100.
|
|
3312
|
+
page_number: 1, # Integer | Page number
|
|
3313
|
+
filter_type: "Prefix", # String | Filter type
|
|
3314
|
+
name: "name_example", # String | Name
|
|
3315
|
+
id: ["id_example"], # Array<String> | id
|
|
3316
|
+
sort_by: "sort_by_example", # String | Sort by
|
|
3317
|
+
sort_order: "a" # String | Sort order
|
|
3318
|
+
}
|
|
3319
|
+
|
|
3320
|
+
begin
|
|
3321
|
+
#Query a list of simplified dnc list objects.
|
|
3322
|
+
result = api_instance.get_outbound_dnclists_divisionviews(opts)
|
|
3323
|
+
p result
|
|
3324
|
+
rescue PureCloud::ApiError => e
|
|
3325
|
+
puts "Exception when calling OutboundApi->get_outbound_dnclists_divisionviews: #{e}"
|
|
3326
|
+
end
|
|
3327
|
+
~~~
|
|
3328
|
+
|
|
3329
|
+
### Parameters
|
|
3330
|
+
|
|
3331
|
+
Name | Type | Description | Notes
|
|
3332
|
+
------------- | ------------- | ------------- | -------------
|
|
3333
|
+
**include_import_status** | **BOOLEAN**| Include import status | [optional] [default to false] |
|
|
3334
|
+
**include_size** | **BOOLEAN**| Include size | [optional] [default to false] |
|
|
3335
|
+
**page_size** | **Integer**| Page size. The max that will be returned is 100. | [optional] [default to 25] |
|
|
3336
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
3337
|
+
**filter_type** | **String**| Filter type | [optional] [default to Prefix]<br />**Values**: Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith |
|
|
3338
|
+
**name** | **String**| Name | [optional] |
|
|
3339
|
+
**id** | [**Array<String>**](String.html)| id | [optional] |
|
|
3340
|
+
**sort_by** | **String**| Sort by | [optional] |
|
|
3341
|
+
**sort_order** | **String**| Sort order | [optional] [default to a]<br />**Values**: ascending, descending |
|
|
3342
|
+
{: class="table table-striped"}
|
|
3343
|
+
|
|
3344
|
+
|
|
3345
|
+
### Return type
|
|
3346
|
+
|
|
3347
|
+
[**DncListDivisionViewListing**](DncListDivisionViewListing.html)
|
|
3348
|
+
|
|
3349
|
+
### HTTP request headers
|
|
3350
|
+
|
|
3351
|
+
- **Content-Type**: application/json
|
|
3352
|
+
- **Accept**: application/json
|
|
3353
|
+
|
|
3354
|
+
|
|
3355
|
+
|
|
3130
3356
|
<a name="get_outbound_event"></a>
|
|
3131
3357
|
|
|
3132
3358
|
## -[**EventLog**](EventLog.html) get_outbound_event(event_id)
|
|
@@ -4516,70 +4742,6 @@ Name | Type | Description | Notes
|
|
|
4516
4742
|
|
|
4517
4743
|
|
|
4518
4744
|
|
|
4519
|
-
<a name="post_outbound_contactlist_clear"></a>
|
|
4520
|
-
|
|
4521
|
-
## - post_outbound_contactlist_clear(contact_list_id)
|
|
4522
|
-
|
|
4523
|
-
|
|
4524
|
-
|
|
4525
|
-
Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled.
|
|
4526
|
-
|
|
4527
|
-
|
|
4528
|
-
|
|
4529
|
-
Wraps POST /api/v2/outbound/contactlists/{contactListId}/clear
|
|
4530
|
-
|
|
4531
|
-
Requires ANY permissions:
|
|
4532
|
-
|
|
4533
|
-
* outbound:contact:delete
|
|
4534
|
-
|
|
4535
|
-
|
|
4536
|
-
### Example
|
|
4537
|
-
~~~ruby
|
|
4538
|
-
# load the gem
|
|
4539
|
-
require 'purecloudplatformclientv2'
|
|
4540
|
-
# setup authorization
|
|
4541
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
4542
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
4543
|
-
environment = "mypurecloud.com"
|
|
4544
|
-
|
|
4545
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
4546
|
-
|
|
4547
|
-
PureCloud.configure do |config|
|
|
4548
|
-
config.access_token = @authToken
|
|
4549
|
-
end
|
|
4550
|
-
|
|
4551
|
-
api_instance = PureCloud::OutboundApi.new
|
|
4552
|
-
|
|
4553
|
-
contact_list_id = "contact_list_id_example" # String | Contact List ID
|
|
4554
|
-
|
|
4555
|
-
|
|
4556
|
-
begin
|
|
4557
|
-
#Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled.
|
|
4558
|
-
api_instance.post_outbound_contactlist_clear(contact_list_id)
|
|
4559
|
-
rescue PureCloud::ApiError => e
|
|
4560
|
-
puts "Exception when calling OutboundApi->post_outbound_contactlist_clear: #{e}"
|
|
4561
|
-
end
|
|
4562
|
-
~~~
|
|
4563
|
-
|
|
4564
|
-
### Parameters
|
|
4565
|
-
|
|
4566
|
-
Name | Type | Description | Notes
|
|
4567
|
-
------------- | ------------- | ------------- | -------------
|
|
4568
|
-
**contact_list_id** | **String**| Contact List ID | |
|
|
4569
|
-
{: class="table table-striped"}
|
|
4570
|
-
|
|
4571
|
-
|
|
4572
|
-
### Return type
|
|
4573
|
-
|
|
4574
|
-
nil (empty response body)
|
|
4575
|
-
|
|
4576
|
-
### HTTP request headers
|
|
4577
|
-
|
|
4578
|
-
- **Content-Type**: application/json
|
|
4579
|
-
- **Accept**: application/json
|
|
4580
|
-
|
|
4581
|
-
|
|
4582
|
-
|
|
4583
4745
|
<a name="post_outbound_contactlist_contacts"></a>
|
|
4584
4746
|
|
|
4585
4747
|
## -[**Array<DialerContact>**](DialerContact.html) post_outbound_contactlist_contacts(contact_list_id, body, opts)
|
|
@@ -11,8 +11,8 @@ title: OutboundRouteBaseEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: OutboundRouteEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|