purecloudplatformclientv2 42.0.0 → 43.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/ADFS.md +1 -1
- data/docs/ActionEntityListing.md +2 -2
- data/docs/AgentActivityEntityListing.md +2 -2
- data/docs/AnalyticsApi.md +66 -0
- data/docs/AnalyticsSurvey.md +1 -0
- data/docs/AttemptLimitsEntityListing.md +2 -2
- data/docs/AttributeEntityListing.md +2 -2
- data/docs/AuthorizationApi.md +1278 -185
- data/docs/AuthzDivision.md +18 -0
- data/docs/AuthzDivisionEntityListing.md +22 -0
- data/docs/AuthzGrant.md +16 -0
- data/docs/AuthzGrantPolicy.md +16 -0
- data/docs/AuthzGrantRole.md +18 -0
- data/docs/AuthzSubject.md +17 -0
- data/docs/CalibrationEntityListing.md +2 -2
- data/docs/CallConversationEntityListing.md +2 -2
- data/docs/CallHistoryConversationEntityListing.md +2 -2
- data/docs/CallableTimeSetEntityListing.md +2 -2
- data/docs/CallbackConversationEntityListing.md +2 -2
- data/docs/CampaignDivisionViewListing.md +2 -2
- data/docs/CampaignEntityListing.md +2 -2
- data/docs/CampaignRuleEntityListing.md +2 -2
- data/docs/CampaignSequenceEntityListing.md +2 -2
- data/docs/CertificateAuthorityEntityListing.md +2 -2
- data/docs/CertificateDetails.md +1 -1
- data/docs/ChatBadgeNotificationBadgeEntity.md +1 -3
- data/docs/ChatBadgeNotificationEntity.md +1 -3
- data/docs/ChatConversationEntityListing.md +2 -2
- data/docs/ClientAppEntityListing.md +2 -2
- data/docs/CobrowseConversationEntityListing.md +2 -2
- data/docs/CommandStatusEntityListing.md +2 -2
- data/docs/ConsumedResourcesEntityListing.md +2 -2
- data/docs/ConsumingResourcesEntityListing.md +2 -2
- data/docs/ContactListEntityListing.md +2 -2
- data/docs/ContactListFilterEntityListing.md +2 -2
- data/docs/ContactListing.md +2 -2
- data/docs/ConversationEntityListing.md +2 -2
- data/docs/ConversationQuery.md +1 -0
- data/docs/CreateCallbackCommand.md +1 -0
- data/docs/CreateCallbackOnConversationCommand.md +1 -0
- data/docs/CreateQueueRequest.md +1 -1
- data/docs/CredentialInfoListing.md +2 -2
- data/docs/CredentialTypeListing.md +2 -2
- data/docs/CustomerInteractionCenter.md +1 -1
- data/docs/DIDEntityListing.md +2 -2
- data/docs/DIDPoolEntityListing.md +2 -2
- data/docs/DataTableRowEntityListing.md +2 -2
- data/docs/DataTablesDomainEntityListing.md +2 -2
- data/docs/DependencyObjectEntityListing.md +2 -2
- data/docs/DependencyTypeEntityListing.md +2 -2
- data/docs/DialerEventEntityListing.md +2 -2
- data/docs/DirectoryUserDevicesListing.md +2 -2
- data/docs/DncListEntityListing.md +2 -2
- data/docs/Document.md +1 -1
- data/docs/DocumentAuditEntityListing.md +2 -2
- data/docs/DocumentEntityListing.md +2 -2
- data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +2 -2
- data/docs/DomainEntityListing.md +2 -2
- data/docs/DomainEntityListingEvaluationForm.md +2 -2
- data/docs/DomainEntityListingQueryResult.md +2 -2
- data/docs/DomainEntityListingSurveyForm.md +2 -2
- data/docs/DomainOrganizationRole.md +1 -1
- data/docs/DomainOrganizationRoleCreate.md +1 -1
- data/docs/DomainOrganizationRoleUpdate.md +1 -1
- data/docs/EdgeEntityListing.md +2 -2
- data/docs/EdgeGroupEntityListing.md +2 -2
- data/docs/EdgeLineEntityListing.md +2 -2
- data/docs/EmailConversationEntityListing.md +2 -2
- data/docs/EmailMessageListing.md +2 -2
- data/docs/EmergencyGroupListing.md +2 -2
- data/docs/EncryptionKeyEntityListing.md +2 -2
- data/docs/EndpointEntityListing.md +2 -2
- data/docs/EvaluationEntityListing.md +2 -2
- data/docs/EvaluationFormEntityListing.md +2 -2
- data/docs/EvaluatorActivityEntityListing.md +2 -2
- data/docs/ExtensionEntityListing.md +2 -2
- data/docs/ExtensionPoolEntityListing.md +2 -2
- data/docs/ExternalOrganizationListing.md +2 -2
- data/docs/FacebookIntegration.md +24 -0
- data/docs/FacebookIntegrationEntityListing.md +22 -0
- data/docs/FacebookIntegrationRequest.md +20 -0
- data/docs/FaxDocument.md +1 -1
- data/docs/FaxDocumentEntityListing.md +2 -2
- data/docs/FlowDivisionViewEntityListing.md +2 -2
- data/docs/FlowEntityListing.md +2 -2
- data/docs/FlowVersionEntityListing.md +2 -2
- data/docs/FlowsApi.md +78 -0
- data/docs/GDPRRequestEntityListing.md +2 -2
- data/docs/GDPRSubjectEntityListing.md +2 -2
- data/docs/GKNDocumentationResult.md +16 -0
- data/docs/GKNDocumentationSearchCriteria.md +20 -0
- data/docs/GKNDocumentationSearchRequest.md +18 -0
- data/docs/GKNDocumentationSearchResponse.md +21 -0
- data/docs/GSuite.md +1 -1
- data/docs/GreetingListing.md +2 -2
- data/docs/GroupEntityListing.md +2 -2
- data/docs/GroupProfileEntityListing.md +2 -2
- data/docs/GroupsApi.md +1 -1
- data/docs/IVREntityListing.md +2 -2
- data/docs/IdentityNow.md +1 -1
- data/docs/InboundDomainEntityListing.md +2 -2
- data/docs/InboundRouteEntityListing.md +2 -2
- data/docs/IntegrationEntityListing.md +2 -2
- data/docs/IntegrationEventEntityListing.md +2 -2
- data/docs/IntegrationTypeEntityListing.md +2 -2
- data/docs/InteractionStatsAlertContainer.md +2 -2
- data/docs/InteractionStatsRuleContainer.md +2 -2
- data/docs/JsonNode.md +6 -6
- data/docs/KeywordSetEntityListing.md +2 -2
- data/docs/LanguageEntityListing.md +2 -2
- data/docs/LibraryEntityListing.md +2 -2
- data/docs/LineBaseEntityListing.md +2 -2
- data/docs/LineEntityListing.md +2 -2
- data/docs/LineIntegration.md +24 -0
- data/docs/LineIntegrationEntityListing.md +22 -0
- data/docs/LineIntegrationRequest.md +19 -0
- data/docs/LocationEntityListing.md +2 -2
- data/docs/LogicalInterfaceEntityListing.md +2 -2
- data/docs/ManagementUnitListing.md +2 -2
- data/docs/MessageConversationEntityListing.md +2 -2
- data/docs/MessagingApi.md +1015 -0
- data/docs/MessagingSticker.md +22 -0
- data/docs/MessagingStickerEntityListing.md +22 -0
- data/docs/NoteListing.md +2 -2
- data/docs/OAuthClientEntityListing.md +2 -2
- data/docs/OAuthProviderEntityListing.md +2 -2
- data/docs/ObjectsApi.md +554 -0
- data/docs/Okta.md +1 -1
- data/docs/OneLogin.md +1 -1
- data/docs/OrgUser.md +3 -1
- data/docs/OrganizationPresenceEntityListing.md +2 -2
- data/docs/OrganizationRoleEntityListing.md +2 -2
- data/docs/OrphanRecordingListing.md +2 -2
- data/docs/OutboundApi.md +2 -2
- data/docs/OutboundRouteBaseEntityListing.md +2 -2
- data/docs/OutboundRouteEntityListing.md +2 -2
- data/docs/PermissionCollectionEntityListing.md +2 -2
- data/docs/PhoneBaseEntityListing.md +2 -2
- data/docs/PhoneEntityListing.md +2 -2
- data/docs/PhoneMetaBaseEntityListing.md +2 -2
- data/docs/PhysicalInterfaceEntityListing.md +2 -2
- data/docs/PingIdentity.md +1 -1
- data/docs/PolicyEntityListing.md +2 -2
- data/docs/PresenceApi.md +66 -0
- data/docs/PromptAsset.md +1 -0
- data/docs/PromptAssetCreate.md +1 -0
- data/docs/PromptAssetEntityListing.md +2 -2
- data/docs/PromptEntityListing.md +2 -2
- data/docs/QualityAuditPage.md +2 -2
- data/docs/QueueEntityListing.md +2 -2
- data/docs/QueueMemberEntityListing.md +2 -2
- data/docs/QueueRequest.md +1 -1
- data/docs/RecipientListing.md +2 -2
- data/docs/RelationshipListing.md +2 -2
- data/docs/ReportMetaDataEntityListing.md +2 -2
- data/docs/ReportRunEntryEntityDomainListing.md +2 -2
- data/docs/ReportScheduleEntityListing.md +2 -2
- data/docs/ReportingExportJobListing.md +2 -2
- data/docs/ResponseConfig.md +1 -0
- data/docs/ResponseEntityList.md +2 -2
- data/docs/ResponseEntityListing.md +2 -2
- data/docs/ResponseSetEntityListing.md +2 -2
- data/docs/RoutingApi.md +144 -4
- data/docs/RuleSetEntityListing.md +2 -2
- data/docs/Salesforce.md +1 -1
- data/docs/ScheduleEntityListing.md +2 -2
- data/docs/ScheduleGroupEntityListing.md +2 -2
- data/docs/SchemaCategoryEntityListing.md +2 -2
- data/docs/SchemaReferenceEntityListing.md +2 -2
- data/docs/ScreenRecordingSessionListing.md +2 -2
- data/docs/ScriptEntityListing.md +2 -2
- data/docs/SearchApi.md +132 -2
- data/docs/SecurityProfileEntityListing.md +2 -2
- data/docs/ShareEntityListing.md +2 -2
- data/docs/SiteEntityListing.md +2 -2
- data/docs/SkillEntityListing.md +2 -2
- data/docs/SmsPhoneNumberEntityListing.md +2 -2
- data/docs/StationEntityListing.md +2 -2
- data/docs/SubjectDivisionGrantsEntityListing.md +2 -2
- data/docs/SubjectDivisions.md +14 -0
- data/docs/SuggestApi.md +2 -2
- data/docs/SurveyFormEntityListing.md +2 -2
- data/docs/SystemPromptAsset.md +1 -0
- data/docs/SystemPromptAssetEntityListing.md +2 -2
- data/docs/SystemPromptEntityListing.md +2 -2
- data/docs/TagValueEntityListing.md +2 -2
- data/docs/TextMessageListing.md +2 -2
- data/docs/TimeZone.md +2 -2
- data/docs/TimeZoneEntityListing.md +2 -2
- data/docs/TrunkBaseEntityListing.md +2 -2
- data/docs/TrunkEntityListing.md +2 -2
- data/docs/TrunkMetabaseEntityListing.md +2 -2
- data/docs/TrustEntityListing.md +2 -2
- data/docs/TrustUser.md +3 -1
- data/docs/TrustUserEntityListing.md +2 -2
- data/docs/TrustorEntityListing.md +2 -2
- data/docs/TwitterIntegration.md +28 -0
- data/docs/TwitterIntegrationEntityListing.md +22 -0
- data/docs/TwitterIntegrationRequest.md +21 -0
- data/docs/UpdateUser.md +1 -1
- data/docs/UpdateWeekScheduleRequest.md +1 -0
- data/docs/User.md +3 -1
- data/docs/UserActionCategoryEntityListing.md +2 -2
- data/docs/UserEntityListing.md +2 -2
- data/docs/UserLanguageEntityListing.md +2 -2
- data/docs/UserMe.md +3 -1
- data/docs/UserProfileEntityListing.md +2 -2
- data/docs/UserQueueEntityListing.md +2 -2
- data/docs/UserRecordingEntityListing.md +2 -2
- data/docs/UserSkillEntityListing.md +2 -2
- data/docs/UsersApi.md +560 -8
- data/docs/VoicemailMessageEntityListing.md +2 -2
- data/docs/WorkforceManagementApi.md +67 -0
- data/docs/WorkspaceEntityListing.md +2 -2
- data/docs/WorkspaceMemberEntityListing.md +2 -2
- data/docs/WrapupCodeEntityListing.md +2 -2
- data/docs/WritableDialerContact.md +17 -0
- data/lib/purecloudplatformclientv2.rb +26 -0
- data/lib/purecloudplatformclientv2/api/analytics_api.rb +65 -0
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +1477 -250
- data/lib/purecloudplatformclientv2/api/flows_api.rb +92 -0
- data/lib/purecloudplatformclientv2/api/messaging_api.rb +1050 -0
- data/lib/purecloudplatformclientv2/api/objects_api.rb +640 -0
- data/lib/purecloudplatformclientv2/api/presence_api.rb +65 -0
- data/lib/purecloudplatformclientv2/api/routing_api.rb +157 -3
- data/lib/purecloudplatformclientv2/api/search_api.rb +131 -0
- data/lib/purecloudplatformclientv2/api/users_api.rb +607 -0
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +64 -0
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/adfs.rb +12 -12
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/analytics_session.rb +2 -2
- data/lib/purecloudplatformclientv2/models/analytics_survey.rb +30 -4
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/attribute_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/authz_division.rb +338 -0
- data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/authz_grant.rb +277 -0
- data/lib/purecloudplatformclientv2/models/authz_grant_policy.rb +278 -0
- data/lib/purecloudplatformclientv2/models/authz_grant_role.rb +330 -0
- data/lib/purecloudplatformclientv2/models/authz_subject.rb +305 -0
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/certificate_details.rb +13 -13
- data/lib/purecloudplatformclientv2/models/chat_badge_notification_badge_entity.rb +7 -71
- data/lib/purecloudplatformclientv2/models/chat_badge_notification_entity.rb +7 -71
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/conversation_query.rb +29 -1
- data/lib/purecloudplatformclientv2/models/create_callback_command.rb +27 -1
- data/lib/purecloudplatformclientv2/models/create_callback_on_conversation_command.rb +27 -1
- data/lib/purecloudplatformclientv2/models/create_queue_request.rb +6 -0
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/customer_interaction_center.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/document.rb +12 -12
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +23 -23
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +23 -23
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +23 -23
- data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/endpoint_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/facebook_integration.rb +508 -0
- data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/facebook_integration_request.rb +394 -0
- data/lib/purecloudplatformclientv2/models/fax_document.rb +12 -12
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/forecast_time_series_result.rb +2 -2
- data/lib/purecloudplatformclientv2/models/g_suite.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/gkn_documentation_result.rb +285 -0
- data/lib/purecloudplatformclientv2/models/gkn_documentation_search_criteria.rb +423 -0
- data/lib/purecloudplatformclientv2/models/gkn_documentation_search_request.rb +349 -0
- data/lib/purecloudplatformclientv2/models/gkn_documentation_search_response.rb +444 -0
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/identity_now.rb +12 -12
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +23 -23
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +23 -23
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/json_node.rb +89 -89
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/line_integration.rb +513 -0
- data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/line_integration_request.rb +363 -0
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/messaging_sticker.rb +477 -0
- data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/note_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/okta.rb +12 -12
- data/lib/purecloudplatformclientv2/models/one_login.rb +12 -12
- data/lib/purecloudplatformclientv2/models/org_user.rb +58 -2
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/ping_identity.rb +12 -12
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/prompt_asset.rb +26 -1
- data/lib/purecloudplatformclientv2/models/prompt_asset_create.rb +26 -1
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +23 -23
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/queue_request.rb +6 -0
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/response_config.rb +29 -1
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +23 -23
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/salesforce.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/subject_divisions.rb +242 -0
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/system_prompt_asset.rb +26 -1
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/time_zone.rb +24 -24
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/trust_user.rb +58 -2
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/twitter_integration.rb +636 -0
- data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/twitter_integration_request.rb +454 -0
- data/lib/purecloudplatformclientv2/models/update_user.rb +1 -1
- data/lib/purecloudplatformclientv2/models/update_week_schedule_request.rb +44 -4
- data/lib/purecloudplatformclientv2/models/user.rb +58 -2
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/user_me.rb +58 -2
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/web_chat_config.rb +15 -1
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/writable_dialer_contact.rb +320 -0
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +54 -2
|
@@ -12,10 +12,10 @@ title: ReportingExportJobListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
15
|
| **previous_uri** | **String** | | [optional] |
|
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **first_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/ResponseConfig.md
CHANGED
|
@@ -8,6 +8,7 @@ title: ResponseConfig
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **translation_map** | **Hash<String, String>** | Map 'attribute name' and 'JSON path' pairs used to extract data from REST response. | [optional] |
|
|
11
|
+
| **translation_map_defaults** | **Hash<String, String>** | Map 'attribute name' and 'default value' pairs used as fallback values if JSON path extraction fails for specified key. | [optional] |
|
|
11
12
|
| **success_template** | **String** | Velocity template to build response to return from Action. | [optional] |
|
|
12
13
|
| **success_template_uri** | **String** | URI to retrieve success template. | [optional] |
|
|
13
14
|
{: class="table table-striped"}
|
data/docs/ResponseEntityList.md
CHANGED
|
@@ -12,10 +12,10 @@ title: ResponseEntityList
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
15
|
| **previous_uri** | **String** | | [optional] |
|
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **first_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -12,10 +12,10 @@ title: ResponseEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
15
|
| **previous_uri** | **String** | | [optional] |
|
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **first_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -12,10 +12,10 @@ title: ResponseSetEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
15
|
| **previous_uri** | **String** | | [optional] |
|
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **first_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/RoutingApi.md
CHANGED
|
@@ -47,6 +47,8 @@ Method | Description
|
|
|
47
47
|
[**patch_routing_queue_user**](RoutingApi.html#patch_routing_queue_user) | Update the ring number of joined status for a User in a Queue
|
|
48
48
|
[**patch_routing_queue_users**](RoutingApi.html#patch_routing_queue_users) | Join or unjoin a set of users for a queue
|
|
49
49
|
[**patch_user_routinglanguage**](RoutingApi.html#patch_user_routinglanguage) | Update routing language proficiency or state.
|
|
50
|
+
[**patch_user_routinglanguages_bulk**](RoutingApi.html#patch_user_routinglanguages_bulk) | Add bulk routing language to user. Max limit 50 languages
|
|
51
|
+
[**patch_user_routingskills_bulk**](RoutingApi.html#patch_user_routingskills_bulk) | Add bulk routing skills to user
|
|
50
52
|
[**post_analytics_queues_observations_query**](RoutingApi.html#post_analytics_queues_observations_query) | Query for queue observations
|
|
51
53
|
[**post_routing_email_domain_routes**](RoutingApi.html#post_routing_email_domain_routes) | Create a route
|
|
52
54
|
[**post_routing_email_domains**](RoutingApi.html#post_routing_email_domains) | Create a domain
|
|
@@ -1585,7 +1587,7 @@ Name | Type | Description | Notes
|
|
|
1585
1587
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
1586
1588
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
1587
1589
|
**sort_by** | **String**| Sort by | [optional] [default to name] |
|
|
1588
|
-
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand. | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups,
|
|
1590
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand. | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages |
|
|
1589
1591
|
**joined** | **BOOLEAN**| Filter by joined status | [optional] |
|
|
1590
1592
|
**name** | **String**| Filter by queue member name | [optional] |
|
|
1591
1593
|
**profile_skills** | [**Array<String>**](String.html)| Filter by profile skill | [optional] |
|
|
@@ -2340,8 +2342,8 @@ api_instance = PureCloud::RoutingApi.new
|
|
|
2340
2342
|
opts = {
|
|
2341
2343
|
page_size: 25, # Integer | Page size
|
|
2342
2344
|
page_number: 1, # Integer | Page number
|
|
2343
|
-
|
|
2344
|
-
|
|
2345
|
+
sort_by: "name", # String | Sort by
|
|
2346
|
+
name: "name_example" # String | Name
|
|
2345
2347
|
}
|
|
2346
2348
|
|
|
2347
2349
|
begin
|
|
@@ -2359,8 +2361,8 @@ Name | Type | Description | Notes
|
|
|
2359
2361
|
------------- | ------------- | ------------- | -------------
|
|
2360
2362
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
2361
2363
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
2364
|
+
**sort_by** | **String**| Sort by | [optional] [default to name]<br />**Values**: name, id |
|
|
2362
2365
|
**name** | **String**| Name | [optional] |
|
|
2363
|
-
**sort_by** | **String**| Sort by | [optional] [default to name] |
|
|
2364
2366
|
{: class="table table-striped"}
|
|
2365
2367
|
|
|
2366
2368
|
|
|
@@ -2730,6 +2732,144 @@ Name | Type | Description | Notes
|
|
|
2730
2732
|
|
|
2731
2733
|
|
|
2732
2734
|
|
|
2735
|
+
<a name="patch_user_routinglanguages_bulk"></a>
|
|
2736
|
+
|
|
2737
|
+
## -[**UserLanguageEntityListing**](UserLanguageEntityListing.html) patch_user_routinglanguages_bulk(user_id, body)
|
|
2738
|
+
|
|
2739
|
+
|
|
2740
|
+
|
|
2741
|
+
Add bulk routing language to user. Max limit 50 languages
|
|
2742
|
+
|
|
2743
|
+
|
|
2744
|
+
|
|
2745
|
+
Wraps PATCH /api/v2/users/{userId}/routinglanguages/bulk
|
|
2746
|
+
|
|
2747
|
+
Requires ANY permissions:
|
|
2748
|
+
|
|
2749
|
+
* routing:skill:assign
|
|
2750
|
+
* admin
|
|
2751
|
+
|
|
2752
|
+
|
|
2753
|
+
### Example
|
|
2754
|
+
~~~ruby
|
|
2755
|
+
# load the gem
|
|
2756
|
+
require 'purecloudplatformclientv2'
|
|
2757
|
+
# setup authorization
|
|
2758
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2759
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2760
|
+
environment = "mypurecloud.com"
|
|
2761
|
+
|
|
2762
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2763
|
+
|
|
2764
|
+
PureCloud.configure do |config|
|
|
2765
|
+
config.access_token = @authToken
|
|
2766
|
+
end
|
|
2767
|
+
|
|
2768
|
+
api_instance = PureCloud::RoutingApi.new
|
|
2769
|
+
|
|
2770
|
+
user_id = "user_id_example" # String | User ID
|
|
2771
|
+
|
|
2772
|
+
body = [PureCloud::UserRoutingLanguagePost.new] # Array<UserRoutingLanguagePost> | Language
|
|
2773
|
+
|
|
2774
|
+
|
|
2775
|
+
begin
|
|
2776
|
+
#Add bulk routing language to user. Max limit 50 languages
|
|
2777
|
+
result = api_instance.patch_user_routinglanguages_bulk(user_id, body)
|
|
2778
|
+
p result
|
|
2779
|
+
rescue PureCloud::ApiError => e
|
|
2780
|
+
puts "Exception when calling RoutingApi->patch_user_routinglanguages_bulk: #{e}"
|
|
2781
|
+
end
|
|
2782
|
+
~~~
|
|
2783
|
+
|
|
2784
|
+
### Parameters
|
|
2785
|
+
|
|
2786
|
+
Name | Type | Description | Notes
|
|
2787
|
+
------------- | ------------- | ------------- | -------------
|
|
2788
|
+
**user_id** | **String**| User ID | |
|
|
2789
|
+
**body** | [**Array<UserRoutingLanguagePost>**](UserRoutingLanguagePost.html)| Language | |
|
|
2790
|
+
{: class="table table-striped"}
|
|
2791
|
+
|
|
2792
|
+
|
|
2793
|
+
### Return type
|
|
2794
|
+
|
|
2795
|
+
[**UserLanguageEntityListing**](UserLanguageEntityListing.html)
|
|
2796
|
+
|
|
2797
|
+
### HTTP request headers
|
|
2798
|
+
|
|
2799
|
+
- **Content-Type**: application/json
|
|
2800
|
+
- **Accept**: application/json
|
|
2801
|
+
|
|
2802
|
+
|
|
2803
|
+
|
|
2804
|
+
<a name="patch_user_routingskills_bulk"></a>
|
|
2805
|
+
|
|
2806
|
+
## -[**UserSkillEntityListing**](UserSkillEntityListing.html) patch_user_routingskills_bulk(user_id, body)
|
|
2807
|
+
|
|
2808
|
+
|
|
2809
|
+
|
|
2810
|
+
Add bulk routing skills to user
|
|
2811
|
+
|
|
2812
|
+
|
|
2813
|
+
|
|
2814
|
+
Wraps PATCH /api/v2/users/{userId}/routingskills/bulk
|
|
2815
|
+
|
|
2816
|
+
Requires ANY permissions:
|
|
2817
|
+
|
|
2818
|
+
* routing:skill:assign
|
|
2819
|
+
* admin
|
|
2820
|
+
|
|
2821
|
+
|
|
2822
|
+
### Example
|
|
2823
|
+
~~~ruby
|
|
2824
|
+
# load the gem
|
|
2825
|
+
require 'purecloudplatformclientv2'
|
|
2826
|
+
# setup authorization
|
|
2827
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2828
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2829
|
+
environment = "mypurecloud.com"
|
|
2830
|
+
|
|
2831
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2832
|
+
|
|
2833
|
+
PureCloud.configure do |config|
|
|
2834
|
+
config.access_token = @authToken
|
|
2835
|
+
end
|
|
2836
|
+
|
|
2837
|
+
api_instance = PureCloud::RoutingApi.new
|
|
2838
|
+
|
|
2839
|
+
user_id = "user_id_example" # String | User ID
|
|
2840
|
+
|
|
2841
|
+
body = [PureCloud::UserRoutingSkillPost.new] # Array<UserRoutingSkillPost> | Skill
|
|
2842
|
+
|
|
2843
|
+
|
|
2844
|
+
begin
|
|
2845
|
+
#Add bulk routing skills to user
|
|
2846
|
+
result = api_instance.patch_user_routingskills_bulk(user_id, body)
|
|
2847
|
+
p result
|
|
2848
|
+
rescue PureCloud::ApiError => e
|
|
2849
|
+
puts "Exception when calling RoutingApi->patch_user_routingskills_bulk: #{e}"
|
|
2850
|
+
end
|
|
2851
|
+
~~~
|
|
2852
|
+
|
|
2853
|
+
### Parameters
|
|
2854
|
+
|
|
2855
|
+
Name | Type | Description | Notes
|
|
2856
|
+
------------- | ------------- | ------------- | -------------
|
|
2857
|
+
**user_id** | **String**| User ID | |
|
|
2858
|
+
**body** | [**Array<UserRoutingSkillPost>**](UserRoutingSkillPost.html)| Skill | |
|
|
2859
|
+
{: class="table table-striped"}
|
|
2860
|
+
|
|
2861
|
+
|
|
2862
|
+
### Return type
|
|
2863
|
+
|
|
2864
|
+
[**UserSkillEntityListing**](UserSkillEntityListing.html)
|
|
2865
|
+
|
|
2866
|
+
### HTTP request headers
|
|
2867
|
+
|
|
2868
|
+
- **Content-Type**: application/json
|
|
2869
|
+
- **Accept**: application/json
|
|
2870
|
+
|
|
2871
|
+
|
|
2872
|
+
|
|
2733
2873
|
<a name="post_analytics_queues_observations_query"></a>
|
|
2734
2874
|
|
|
2735
2875
|
## -[**QualifierMappingObservationQueryResponse**](QualifierMappingObservationQueryResponse.html) post_analytics_queues_observations_query(body)
|
|
@@ -12,10 +12,10 @@ title: RuleSetEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
15
|
| **previous_uri** | **String** | | [optional] |
|
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **first_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/Salesforce.md
CHANGED
|
@@ -10,8 +10,8 @@ title: Salesforce
|
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
11
|
| **name** | **String** | | [optional] |
|
|
12
12
|
| **certificate** | **String** | | [optional] |
|
|
13
|
-
| **issuer_uri** | **String** | | [optional] |
|
|
14
13
|
| **sso_target_uri** | **String** | | [optional] |
|
|
14
|
+
| **issuer_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"}
|
|
@@ -12,10 +12,10 @@ title: ScheduleEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
15
|
| **previous_uri** | **String** | | [optional] |
|
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **first_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -12,10 +12,10 @@ title: ScheduleGroupEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
15
|
| **previous_uri** | **String** | | [optional] |
|
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **first_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -12,10 +12,10 @@ title: SchemaCategoryEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
15
|
| **previous_uri** | **String** | | [optional] |
|
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **first_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -12,10 +12,10 @@ title: SchemaReferenceEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
15
|
| **previous_uri** | **String** | | [optional] |
|
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **first_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -12,10 +12,10 @@ title: ScreenRecordingSessionListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
15
|
| **previous_uri** | **String** | | [optional] |
|
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **first_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/ScriptEntityListing.md
CHANGED
|
@@ -12,10 +12,10 @@ title: ScriptEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
-
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
15
|
| **previous_uri** | **String** | | [optional] |
|
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **first_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/SearchApi.md
CHANGED
|
@@ -8,6 +8,7 @@ All URIs are relative to *https://api.mypurecloud.com*
|
|
|
8
8
|
|
|
9
9
|
Method | Description
|
|
10
10
|
------------- | ------------- | -------------
|
|
11
|
+
[**get_documentation_gkn_search**](SearchApi.html#get_documentation_gkn_search) | Search gkn documentation using the q64 value returned from a previous search
|
|
11
12
|
[**get_documentation_search**](SearchApi.html#get_documentation_search) | Search documentation using the q64 value returned from a previous search
|
|
12
13
|
[**get_groups_search**](SearchApi.html#get_groups_search) | Search groups using the q64 value returned from a previous search
|
|
13
14
|
[**get_locations_search**](SearchApi.html#get_locations_search) | Search locations using the q64 value returned from a previous search
|
|
@@ -15,6 +16,7 @@ Method | Description
|
|
|
15
16
|
[**get_search_suggest**](SearchApi.html#get_search_suggest) | Suggest resources using the q64 value returned from a previous suggest query.
|
|
16
17
|
[**get_users_search**](SearchApi.html#get_users_search) | Search users using the q64 value returned from a previous search
|
|
17
18
|
[**get_voicemail_search**](SearchApi.html#get_voicemail_search) | Search voicemails using the q64 value returned from a previous search
|
|
19
|
+
[**post_documentation_gkn_search**](SearchApi.html#post_documentation_gkn_search) | Search gkn documentation
|
|
18
20
|
[**post_documentation_search**](SearchApi.html#post_documentation_search) | Search documentation
|
|
19
21
|
[**post_groups_search**](SearchApi.html#post_groups_search) | Search groups
|
|
20
22
|
[**post_locations_search**](SearchApi.html#post_locations_search) | Search locations
|
|
@@ -24,6 +26,70 @@ Method | Description
|
|
|
24
26
|
[**post_voicemail_search**](SearchApi.html#post_voicemail_search) | Search voicemails
|
|
25
27
|
{: class="table table-striped"}
|
|
26
28
|
|
|
29
|
+
<a name="get_documentation_gkn_search"></a>
|
|
30
|
+
|
|
31
|
+
## -[**GKNDocumentationSearchResponse**](GKNDocumentationSearchResponse.html) get_documentation_gkn_search(q64)
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
Search gkn documentation using the q64 value returned from a previous search
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
Wraps GET /api/v2/documentation/gkn/search
|
|
40
|
+
|
|
41
|
+
Requires NO permissions:
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
### Example
|
|
46
|
+
~~~ruby
|
|
47
|
+
# load the gem
|
|
48
|
+
require 'purecloudplatformclientv2'
|
|
49
|
+
# setup authorization
|
|
50
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
51
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
52
|
+
environment = "mypurecloud.com"
|
|
53
|
+
|
|
54
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
55
|
+
|
|
56
|
+
PureCloud.configure do |config|
|
|
57
|
+
config.access_token = @authToken
|
|
58
|
+
end
|
|
59
|
+
|
|
60
|
+
api_instance = PureCloud::SearchApi.new
|
|
61
|
+
|
|
62
|
+
q64 = "q64_example" # String | q64
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
begin
|
|
66
|
+
#Search gkn documentation using the q64 value returned from a previous search
|
|
67
|
+
result = api_instance.get_documentation_gkn_search(q64)
|
|
68
|
+
p result
|
|
69
|
+
rescue PureCloud::ApiError => e
|
|
70
|
+
puts "Exception when calling SearchApi->get_documentation_gkn_search: #{e}"
|
|
71
|
+
end
|
|
72
|
+
~~~
|
|
73
|
+
|
|
74
|
+
### Parameters
|
|
75
|
+
|
|
76
|
+
Name | Type | Description | Notes
|
|
77
|
+
------------- | ------------- | ------------- | -------------
|
|
78
|
+
**q64** | **String**| q64 | |
|
|
79
|
+
{: class="table table-striped"}
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
### Return type
|
|
83
|
+
|
|
84
|
+
[**GKNDocumentationSearchResponse**](GKNDocumentationSearchResponse.html)
|
|
85
|
+
|
|
86
|
+
### HTTP request headers
|
|
87
|
+
|
|
88
|
+
- **Content-Type**: application/json
|
|
89
|
+
- **Accept**: application/json
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
27
93
|
<a name="get_documentation_search"></a>
|
|
28
94
|
|
|
29
95
|
## -[**DocumentationSearchResponse**](DocumentationSearchResponse.html) get_documentation_search(q64)
|
|
@@ -278,7 +344,7 @@ end
|
|
|
278
344
|
Name | Type | Description | Notes
|
|
279
345
|
------------- | ------------- | ------------- | -------------
|
|
280
346
|
**q64** | **String**| q64 | |
|
|
281
|
-
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, callerUser.routingStatus, callerUser.primaryPresence, callerUser.conversationSummary, callerUser.outOfOffice, callerUser.geolocation |
|
|
347
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages, callerUser.routingStatus, callerUser.primaryPresence, callerUser.conversationSummary, callerUser.outOfOffice, callerUser.geolocation |
|
|
282
348
|
**profile** | **BOOLEAN**| profile | [optional] [default to true] |
|
|
283
349
|
{: class="table table-striped"}
|
|
284
350
|
|
|
@@ -348,7 +414,7 @@ end
|
|
|
348
414
|
Name | Type | Description | Notes
|
|
349
415
|
------------- | ------------- | ------------- | -------------
|
|
350
416
|
**q64** | **String**| q64 | |
|
|
351
|
-
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, callerUser.routingStatus, callerUser.primaryPresence, callerUser.conversationSummary, callerUser.outOfOffice, callerUser.geolocation |
|
|
417
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages, callerUser.routingStatus, callerUser.primaryPresence, callerUser.conversationSummary, callerUser.outOfOffice, callerUser.geolocation |
|
|
352
418
|
**profile** | **BOOLEAN**| profile | [optional] [default to true] |
|
|
353
419
|
{: class="table table-striped"}
|
|
354
420
|
|
|
@@ -500,6 +566,70 @@ Name | Type | Description | Notes
|
|
|
500
566
|
|
|
501
567
|
|
|
502
568
|
|
|
569
|
+
<a name="post_documentation_gkn_search"></a>
|
|
570
|
+
|
|
571
|
+
## -[**GKNDocumentationSearchResponse**](GKNDocumentationSearchResponse.html) post_documentation_gkn_search(body)
|
|
572
|
+
|
|
573
|
+
|
|
574
|
+
|
|
575
|
+
Search gkn documentation
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
Wraps POST /api/v2/documentation/gkn/search
|
|
580
|
+
|
|
581
|
+
Requires NO permissions:
|
|
582
|
+
|
|
583
|
+
|
|
584
|
+
|
|
585
|
+
### Example
|
|
586
|
+
~~~ruby
|
|
587
|
+
# load the gem
|
|
588
|
+
require 'purecloudplatformclientv2'
|
|
589
|
+
# setup authorization
|
|
590
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
591
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
592
|
+
environment = "mypurecloud.com"
|
|
593
|
+
|
|
594
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
595
|
+
|
|
596
|
+
PureCloud.configure do |config|
|
|
597
|
+
config.access_token = @authToken
|
|
598
|
+
end
|
|
599
|
+
|
|
600
|
+
api_instance = PureCloud::SearchApi.new
|
|
601
|
+
|
|
602
|
+
body = PureCloud::GKNDocumentationSearchRequest.new # GKNDocumentationSearchRequest | Search request options
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
begin
|
|
606
|
+
#Search gkn documentation
|
|
607
|
+
result = api_instance.post_documentation_gkn_search(body)
|
|
608
|
+
p result
|
|
609
|
+
rescue PureCloud::ApiError => e
|
|
610
|
+
puts "Exception when calling SearchApi->post_documentation_gkn_search: #{e}"
|
|
611
|
+
end
|
|
612
|
+
~~~
|
|
613
|
+
|
|
614
|
+
### Parameters
|
|
615
|
+
|
|
616
|
+
Name | Type | Description | Notes
|
|
617
|
+
------------- | ------------- | ------------- | -------------
|
|
618
|
+
**body** | [**GKNDocumentationSearchRequest**](GKNDocumentationSearchRequest.html)| Search request options | |
|
|
619
|
+
{: class="table table-striped"}
|
|
620
|
+
|
|
621
|
+
|
|
622
|
+
### Return type
|
|
623
|
+
|
|
624
|
+
[**GKNDocumentationSearchResponse**](GKNDocumentationSearchResponse.html)
|
|
625
|
+
|
|
626
|
+
### HTTP request headers
|
|
627
|
+
|
|
628
|
+
- **Content-Type**: application/json
|
|
629
|
+
- **Accept**: application/json
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
|
|
503
633
|
<a name="post_documentation_search"></a>
|
|
504
634
|
|
|
505
635
|
## -[**DocumentationSearchResponse**](DocumentationSearchResponse.html) post_documentation_search(body)
|