purecloudplatformclientv2 30.1.0 → 31.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 +1 -1
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/AppFoundryApi.md +229 -0
- data/docs/AppFoundryListing.md +36 -0
- data/docs/AppFoundryListingCategory.md +14 -0
- data/docs/AppFoundryListingRegistryInfo.md +14 -0
- data/docs/ArchitectApi.md +14 -14
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AttributeEntityListing.md +1 -1
- data/docs/AuthorizationApi.md +0 -120
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallConversationNotificationCallMediaParticipant.md +1 -0
- data/docs/CallConversationNotificationParticipants.md +1 -0
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- data/docs/CallMediaParticipant.md +1 -0
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/CallbackConversationEntityListing.md +1 -1
- data/docs/CallbackConversationNotificationCallbackMediaParticipant.md +1 -0
- data/docs/CallbackConversationNotificationParticipants.md +1 -0
- data/docs/CallbackMediaParticipant.md +1 -0
- 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/ChatConversationNotificationChatMediaParticipant.md +1 -0
- data/docs/ChatConversationNotificationParticipants.md +1 -0
- data/docs/ChatMediaParticipant.md +1 -0
- data/docs/ClientApp.md +21 -0
- data/docs/ClientAppConfigurationInfo.md +14 -0
- data/docs/ClientAppEntityListing.md +22 -0
- data/docs/CobrowseConversationEntityListing.md +1 -1
- data/docs/CobrowseConversationNotificationCobrowseMediaParticipant.md +1 -0
- data/docs/CobrowseConversationNotificationParticipants.md +1 -0
- data/docs/CobrowseMediaParticipant.md +1 -0
- data/docs/CommandStatusEntityListing.md +1 -1
- data/docs/ConsumedResourcesEntityListing.md +1 -1
- data/docs/ConsumingResourcesEntityListing.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/ConversationNotificationParticipant.md +1 -0
- data/docs/ConversationNotificationParticipants.md +1 -0
- data/docs/ConversationNotificationVideo.md +1 -0
- data/docs/ConversationNotificationVideos.md +1 -0
- data/docs/CreateCallRequest.md +2 -0
- data/docs/CreateIntegrationRequest.md +16 -0
- data/docs/Credential.md +17 -0
- data/docs/CredentialInfo.md +18 -0
- data/docs/CredentialInfoListing.md +22 -0
- data/docs/CredentialSpecification.md +15 -0
- data/docs/CredentialType.md +17 -0
- data/docs/CredentialTypeListing.md +22 -0
- data/docs/CustomerInteractionCenter.md +1 -1
- data/docs/DIDEntityListing.md +1 -1
- data/docs/DIDPoolEntityListing.md +1 -1
- data/docs/DataExportNotificationNotification.md +22 -0
- 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/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/DomainOrganizationRole.md +1 -1
- data/docs/DomainOrganizationRoleCreate.md +1 -1
- data/docs/DomainOrganizationRoleUpdate.md +1 -1
- data/docs/EdgeEntityListing.md +1 -1
- data/docs/EdgeGroupEntityListing.md +1 -1
- data/docs/EdgeLineEntityListing.md +1 -1
- data/docs/EffectiveConfiguration.md +17 -0
- data/docs/EmailConversationEntityListing.md +1 -1
- data/docs/EmailConversationNotificationEmailMediaParticipant.md +1 -0
- data/docs/EmailConversationNotificationParticipants.md +1 -0
- data/docs/EmailMediaParticipant.md +1 -0
- 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/EventEntity.md +14 -0
- data/docs/ExtensionEntityListing.md +1 -1
- data/docs/ExtensionPoolEntityListing.md +1 -1
- data/docs/ExternalOrganizationListing.md +1 -1
- data/docs/FaxDocumentEntityListing.md +1 -1
- data/docs/FlowEntityListing.md +1 -1
- data/docs/FlowVersionEntityListing.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/Integration.md +21 -0
- data/docs/IntegrationConfiguration.md +20 -0
- data/docs/IntegrationConfigurationInfo.md +13 -0
- data/docs/IntegrationEntityListing.md +22 -0
- data/docs/IntegrationEvent.md +23 -0
- data/docs/IntegrationEventEntityListing.md +22 -0
- data/docs/IntegrationStatusInfo.md +16 -0
- data/docs/IntegrationType.md +26 -0
- data/docs/IntegrationTypeEntityListing.md +22 -0
- data/docs/IntegrationsApi.md +1457 -175
- data/docs/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/IntradayDataUpdateNotification.md +2 -2
- data/docs/IntradayDataUpdateNotificationDateTime.md +16 -0
- data/docs/IntradayDataUpdateNotificationStartDate.md +16 -0
- data/docs/JsonNode.md +3 -3
- 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/LocalizedField.md +12 -0
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/MarketingInfo.md +14 -0
- data/docs/MessageConversationEntityListing.md +1 -1
- data/docs/MessageConversationNotificationMessageMediaParticipant.md +1 -0
- data/docs/MessageConversationNotificationParticipants.md +1 -0
- data/docs/MessageInfo.md +16 -0
- data/docs/MessageMediaParticipant.md +1 -0
- 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/OutboundRouteBaseEntityListing.md +1 -1
- data/docs/OutboundRouteEntityListing.md +1 -1
- data/docs/PagedListingEntity.md +17 -0
- data/docs/Participant.md +1 -0
- data/docs/ParticipantBasic.md +1 -0
- 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/Platform.md +14 -0
- data/docs/PolicyEntityListing.md +1 -1
- data/docs/PricingOption.md +14 -0
- data/docs/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- 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/RegionTimeZone.md +16 -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/ReportingExportJobRequest.md +1 -1
- data/docs/ReportingExportJobResponse.md +1 -1
- data/docs/ResponseEntityList.md +1 -1
- data/docs/ResponseEntityListing.md +1 -1
- data/docs/ResponseSetEntityListing.md +1 -1
- 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/ScreenShareConversationNotificationParticipants.md +1 -0
- data/docs/ScreenShareConversationNotificationScreenShareMediaParticipant.md +1 -0
- 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/SmartCase.md +14 -0
- data/docs/SmsPhoneNumberEntityListing.md +1 -1
- data/docs/SocialConversationNotificationParticipants.md +1 -0
- data/docs/SocialConversationNotificationSocialMediaParticipant.md +1 -0
- data/docs/StationEntityListing.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/{WfmMoveAgentsCompleteNotificationUser.md → TimeOffRequestUpdateNotificationUserReference.md} +2 -2
- data/docs/TimeZone.md +4 -4
- data/docs/TimeZoneEntityListing.md +2 -2
- 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/UserActionCategory.md +15 -0
- data/docs/UserActionCategoryEntityListing.md +22 -0
- 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/UserScheduleAdherence.md +2 -1
- data/docs/UserScheduleAdherenceUpdateNotification.md +2 -1
- data/docs/UserScheduleAdherenceUpdateNotificationDateTime.md +16 -0
- data/docs/{TimeOffRequestUpdateNotificationUser.md → UserScheduleAdherenceUpdateNotificationUserReference.md} +2 -2
- data/docs/UserSkillEntityListing.md +1 -1
- data/docs/VendorConnectionRequest.md +15 -0
- data/docs/VideoConversationNotificationParticipants.md +2 -0
- data/docs/VideoConversationNotificationVideoMediaParticipant.md +2 -0
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WfmMoveAgentsCompleteNotificationResults.md +1 -1
- data/docs/{UserScheduleAdherenceUpdateNotificationUser.md → WfmMoveAgentsCompleteNotificationUserReference.md} +2 -2
- data/docs/WfmMoveAgentsCompleteNotificationWfmMoveAgentData.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 +43 -6
- data/lib/purecloudplatformclientv2/api/app_foundry_api.rb +360 -0
- data/lib/purecloudplatformclientv2/api/architect_api.rb +6 -6
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +0 -145
- data/lib/purecloudplatformclientv2/api/integrations_api.rb +1926 -321
- 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/app_foundry_listing.rb +815 -0
- data/lib/purecloudplatformclientv2/models/app_foundry_listing_category.rb +231 -0
- data/lib/purecloudplatformclientv2/models/app_foundry_listing_registry_info.rb +231 -0
- 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/calibration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_conversation_notification_call_media_participant.rb +40 -1
- data/lib/purecloudplatformclientv2/models/call_conversation_notification_participants.rb +40 -1
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_media_participant.rb +41 -1
- 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/callback_conversation_notification_callback_media_participant.rb +40 -1
- data/lib/purecloudplatformclientv2/models/callback_conversation_notification_participants.rb +40 -1
- data/lib/purecloudplatformclientv2/models/callback_media_participant.rb +41 -1
- 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/chat_conversation_notification_chat_media_participant.rb +40 -1
- data/lib/purecloudplatformclientv2/models/chat_conversation_notification_participants.rb +40 -1
- data/lib/purecloudplatformclientv2/models/chat_media_participant.rb +41 -1
- data/lib/purecloudplatformclientv2/models/client_app.rb +432 -0
- data/lib/purecloudplatformclientv2/models/client_app_configuration_info.rb +229 -0
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_cobrowse_media_participant.rb +40 -1
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_participants.rb +40 -1
- data/lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb +41 -1
- 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_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_participant.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_notification_participants.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_notification_video.rb +28 -1
- data/lib/purecloudplatformclientv2/models/conversation_notification_videos.rb +28 -1
- data/lib/purecloudplatformclientv2/models/create_call_request.rb +53 -1
- data/lib/purecloudplatformclientv2/models/create_integration_request.rb +291 -0
- data/lib/purecloudplatformclientv2/models/credential.rb +311 -0
- data/lib/purecloudplatformclientv2/models/credential_info.rb +331 -0
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/credential_specification.rb +257 -0
- data/lib/purecloudplatformclientv2/models/credential_type.rb +309 -0
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/customer_interaction_center.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_export_notification_notification.rb +482 -0
- 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.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
- 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_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/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 +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/effective_configuration.rb +338 -0
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email_conversation_notification_email_media_participant.rb +40 -1
- data/lib/purecloudplatformclientv2/models/email_conversation_notification_participants.rb +40 -1
- data/lib/purecloudplatformclientv2/models/email_media_participant.rb +41 -1
- 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/event_entity.rb +228 -0
- data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
- 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/fax_document_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/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.rb +432 -0
- data/lib/purecloudplatformclientv2/models/integration_configuration.rb +417 -0
- data/lib/purecloudplatformclientv2/models/integration_configuration_info.rb +203 -0
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/integration_event.rb +481 -0
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/{data_column.rb → integration_status_info.rb} +79 -36
- data/lib/purecloudplatformclientv2/models/integration_type.rb +551 -0
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +428 -0
- 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/intraday_data_update_notification.rb +2 -2
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_date_time.rb +276 -0
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_data_group.rb +2 -2
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_data_groupings.rb +2 -2
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_metric.rb +2 -2
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_metrics.rb +2 -2
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_start_date.rb +276 -0
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/json_node.rb +66 -66
- 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/localized_field.rb +177 -0
- 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/marketing_info.rb +229 -0
- data/lib/purecloudplatformclientv2/models/message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/message_conversation_notification_message_media_participant.rb +40 -1
- data/lib/purecloudplatformclientv2/models/message_conversation_notification_participants.rb +40 -1
- data/lib/purecloudplatformclientv2/models/message_info.rb +278 -0
- data/lib/purecloudplatformclientv2/models/message_media_participant.rb +43 -3
- 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/paged_listing_entity.rb +303 -0
- data/lib/purecloudplatformclientv2/models/participant.rb +44 -4
- data/lib/purecloudplatformclientv2/models/participant_basic.rb +44 -4
- 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/platform.rb +236 -0
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/pricing_option.rb +234 -0
- 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/{authz_typed_object.rb → region_time_zone.rb} +58 -32
- 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/reporting_export_job_request.rb +35 -37
- data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +32 -34
- 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/screen_share_conversation_notification_participants.rb +40 -1
- data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_screen_share_media_participant.rb +40 -1
- 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/site_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/smart_case.rb +229 -0
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/social_conversation_notification_participants.rb +40 -1
- data/lib/purecloudplatformclientv2/models/social_conversation_notification_social_media_participant.rb +40 -1
- data/lib/purecloudplatformclientv2/models/station_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/{user_schedule_adherence_update_notification_user.rb → time_off_request_update_notification_user_reference.rb} +1 -1
- data/lib/purecloudplatformclientv2/models/time_zone.rb +24 -26
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +13 -13
- 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/user_action_category.rb +253 -0
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +428 -0
- 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_schedule_adherence.rb +28 -2
- data/lib/purecloudplatformclientv2/models/user_schedule_adherence_update_notification.rb +43 -4
- data/lib/purecloudplatformclientv2/models/user_schedule_adherence_update_notification_date_time.rb +276 -0
- data/lib/purecloudplatformclientv2/models/{wfm_move_agents_complete_notification_user.rb → user_schedule_adherence_update_notification_user_reference.rb} +1 -1
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/vendor_connection_request.rb +269 -0
- data/lib/purecloudplatformclientv2/models/video_conversation_notification_participants.rb +70 -4
- data/lib/purecloudplatformclientv2/models/video_conversation_notification_video_media_participant.rb +70 -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_move_agents_complete_notification_results.rb +1 -1
- data/lib/purecloudplatformclientv2/models/{time_off_request_update_notification_user.rb → wfm_move_agents_complete_notification_user_reference.rb} +1 -1
- data/lib/purecloudplatformclientv2/models/wfm_move_agents_complete_notification_wfm_move_agent_data.rb +1 -1
- 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 +88 -14
- data/docs/AuthzTypedObject.md +0 -14
- data/docs/DataColumn.md +0 -14
- data/docs/ObjectsApi.md +0 -132
- data/lib/purecloudplatformclientv2/api/objects_api.rb +0 -172
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: bf6a727a4623fd05e1bfbaf8849a5102fa4327b8
|
|
4
|
+
data.tar.gz: 0e7f8fc9d295c393ef9500855b02e63b8a06ff00
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: ec92461f67c7e5cc973379034829c770a7275e85ae3a317d3331bd106f8c656203ff193aeb34d057313acd03edcff89893e27bd647350d3b67d28f4b01de7635
|
|
7
|
+
data.tar.gz: 3d417c45aabd14636a94e6b58ac751040256c4b2eccd47f2e16f7fe23863e420cdfc72f7c42803efdb878056e75271ec926d8e6e6a80042f2492304484b05358
|
data/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: PureCloud Ruby Gem
|
|
3
3
|
---
|
|
4
|
-
|
|
5
5
|
|
|
6
6
|
Documentation can be found at [https://developer.mypurecloud.com/api/rest/client-libraries/ruby/](https://developer.mypurecloud.com/api/rest/client-libraries/ruby/)
|
|
7
7
|
|
|
@@ -10,7 +10,7 @@ Documentation can be found at [https://developer.mypurecloud.com/api/rest/client
|
|
|
10
10
|
### from rubygems.org
|
|
11
11
|
|
|
12
12
|
~~~ ruby
|
|
13
|
-
gem install 'purecloudplatformclientv2', '~>
|
|
13
|
+
gem install 'purecloudplatformclientv2', '~> 31.0.0'
|
|
14
14
|
~~~
|
|
15
15
|
|
|
16
16
|
### Install from Git
|
data/docs/ADFS.md
CHANGED
|
@@ -11,8 +11,8 @@ title: ADFS
|
|
|
11
11
|
| **name** | **String** | | [optional] |
|
|
12
12
|
| **relying_party_identifier** | **String** | | [optional] |
|
|
13
13
|
| **certificate** | **String** | | [optional] |
|
|
14
|
-
| **issuer_uri** | **String** | | [optional] |
|
|
15
14
|
| **sso_target_uri** | **String** | | [optional] |
|
|
15
|
+
| **issuer_uri** | **String** | | [optional] |
|
|
16
16
|
| **disabled** | **BOOLEAN** | | [optional] |
|
|
17
17
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
18
18
|
{: class="table table-striped"}
|
data/docs/ActionEntityListing.md
CHANGED
|
@@ -14,8 +14,8 @@ title: ActionEntityListing
|
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: AgentActivityEntityListing
|
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -0,0 +1,229 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: AppFoundryApi
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
## PureCloud::AppFoundryApi
|
|
6
|
+
|
|
7
|
+
All URIs are relative to *https://api.mypurecloud.com*
|
|
8
|
+
|
|
9
|
+
Method | Description
|
|
10
|
+
------------- | ------------- | -------------
|
|
11
|
+
[**get_appfoundry_platform_name_categories**](AppFoundryApi.html#get_appfoundry_platform_name_categories) | Return a structured hierarchy of available listing categories
|
|
12
|
+
[**get_appfoundry_platform_name_category**](AppFoundryApi.html#get_appfoundry_platform_name_category) | Get listings that are part of the specified root category or a contained subcategory
|
|
13
|
+
[**get_appfoundry_platform_name_category_sub_category_name**](AppFoundryApi.html#get_appfoundry_platform_name_category_sub_category_name) | Get listings that are part of the specified subcategory
|
|
14
|
+
{: class="table table-striped"}
|
|
15
|
+
|
|
16
|
+
<a name="get_appfoundry_platform_name_categories"></a>
|
|
17
|
+
|
|
18
|
+
## -[**Array<AppFoundryListingCategory>**](AppFoundryListingCategory.html) get_appfoundry_platform_name_categories(platform_name)
|
|
19
|
+
|
|
20
|
+
Return a structured hierarchy of available listing categories
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
Wraps GET /api/v2/appfoundry/{platformName}/categories
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
### Example
|
|
28
|
+
~~~ruby
|
|
29
|
+
# load the gem
|
|
30
|
+
require 'purecloudplatformclientv2'
|
|
31
|
+
# setup authorization
|
|
32
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
33
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
34
|
+
environment = "mypurecloud.com"
|
|
35
|
+
|
|
36
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
37
|
+
|
|
38
|
+
PureCloud.configure do |config|
|
|
39
|
+
config.access_token = @authToken
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
api_instance = PureCloud::AppFoundryApi.new
|
|
43
|
+
|
|
44
|
+
platform_name = "platform_name_example" # String |
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
begin
|
|
48
|
+
#Return a structured hierarchy of available listing categories
|
|
49
|
+
result = api_instance.get_appfoundry_platform_name_categories(platform_name)
|
|
50
|
+
p result
|
|
51
|
+
rescue PureCloud::ApiError => e
|
|
52
|
+
puts "Exception when calling AppFoundryApi->get_appfoundry_platform_name_categories: #{e}"
|
|
53
|
+
end
|
|
54
|
+
~~~
|
|
55
|
+
|
|
56
|
+
### Parameters
|
|
57
|
+
|
|
58
|
+
Name | Type | Description | Notes
|
|
59
|
+
------------- | ------------- | ------------- | -------------
|
|
60
|
+
**platform_name** | **String**| | |
|
|
61
|
+
{: class="table table-striped"}
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
### Return type
|
|
65
|
+
|
|
66
|
+
[**Array<AppFoundryListingCategory>**](AppFoundryListingCategory.html)
|
|
67
|
+
|
|
68
|
+
### HTTP request headers
|
|
69
|
+
|
|
70
|
+
- **Content-Type**: application/json
|
|
71
|
+
- **Accept**: application/json
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
<a name="get_appfoundry_platform_name_category"></a>
|
|
76
|
+
|
|
77
|
+
## -[**PagedListingEntity**](PagedListingEntity.html) get_appfoundry_platform_name_category(platform_name, category_name, opts)
|
|
78
|
+
|
|
79
|
+
Get listings that are part of the specified root category or a contained subcategory
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
Wraps GET /api/v2/appfoundry/{platformName}/categories/{categoryName}
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
### Example
|
|
87
|
+
~~~ruby
|
|
88
|
+
# load the gem
|
|
89
|
+
require 'purecloudplatformclientv2'
|
|
90
|
+
# setup authorization
|
|
91
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
92
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
93
|
+
environment = "mypurecloud.com"
|
|
94
|
+
|
|
95
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
96
|
+
|
|
97
|
+
PureCloud.configure do |config|
|
|
98
|
+
config.access_token = @authToken
|
|
99
|
+
end
|
|
100
|
+
|
|
101
|
+
api_instance = PureCloud::AppFoundryApi.new
|
|
102
|
+
|
|
103
|
+
platform_name = "platform_name_example" # String |
|
|
104
|
+
|
|
105
|
+
category_name = "category_name_example" # String | Name of category to request listings from
|
|
106
|
+
|
|
107
|
+
opts = {
|
|
108
|
+
page_size: 25, # Integer | The total page size requested
|
|
109
|
+
page_number: 1, # Integer | The page number requested
|
|
110
|
+
sort_by: "sort_by_example", # String | variable name requested to sort by
|
|
111
|
+
expand: nil, # Array<Object> | variable name requested by expand list
|
|
112
|
+
next_page: "next_page_example", # String | next page token
|
|
113
|
+
previous_page: "previous_page_example" # String | Previous page token
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
begin
|
|
117
|
+
#Get listings that are part of the specified root category or a contained subcategory
|
|
118
|
+
result = api_instance.get_appfoundry_platform_name_category(platform_name, category_name, opts)
|
|
119
|
+
p result
|
|
120
|
+
rescue PureCloud::ApiError => e
|
|
121
|
+
puts "Exception when calling AppFoundryApi->get_appfoundry_platform_name_category: #{e}"
|
|
122
|
+
end
|
|
123
|
+
~~~
|
|
124
|
+
|
|
125
|
+
### Parameters
|
|
126
|
+
|
|
127
|
+
Name | Type | Description | Notes
|
|
128
|
+
------------- | ------------- | ------------- | -------------
|
|
129
|
+
**platform_name** | **String**| | |
|
|
130
|
+
**category_name** | **String**| Name of category to request listings from | |
|
|
131
|
+
**page_size** | **Integer**| The total page size requested | [optional] [default to 25] |
|
|
132
|
+
**page_number** | **Integer**| The page number requested | [optional] [default to 1] |
|
|
133
|
+
**sort_by** | **String**| variable name requested to sort by | [optional] |
|
|
134
|
+
**expand** | [**Array<Object>**](Object.html)| variable name requested by expand list | [optional] |
|
|
135
|
+
**next_page** | **String**| next page token | [optional] |
|
|
136
|
+
**previous_page** | **String**| Previous page token | [optional] |
|
|
137
|
+
{: class="table table-striped"}
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
### Return type
|
|
141
|
+
|
|
142
|
+
[**PagedListingEntity**](PagedListingEntity.html)
|
|
143
|
+
|
|
144
|
+
### HTTP request headers
|
|
145
|
+
|
|
146
|
+
- **Content-Type**: application/json
|
|
147
|
+
- **Accept**: application/json
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
<a name="get_appfoundry_platform_name_category_sub_category_name"></a>
|
|
152
|
+
|
|
153
|
+
## -[**PagedListingEntity**](PagedListingEntity.html) get_appfoundry_platform_name_category_sub_category_name(platform_name, category_name, sub_category_name, opts)
|
|
154
|
+
|
|
155
|
+
Get listings that are part of the specified subcategory
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
Wraps GET /api/v2/appfoundry/{platformName}/categories/{categoryName}/{subCategoryName}
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
### Example
|
|
163
|
+
~~~ruby
|
|
164
|
+
# load the gem
|
|
165
|
+
require 'purecloudplatformclientv2'
|
|
166
|
+
# setup authorization
|
|
167
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
168
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
169
|
+
environment = "mypurecloud.com"
|
|
170
|
+
|
|
171
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
172
|
+
|
|
173
|
+
PureCloud.configure do |config|
|
|
174
|
+
config.access_token = @authToken
|
|
175
|
+
end
|
|
176
|
+
|
|
177
|
+
api_instance = PureCloud::AppFoundryApi.new
|
|
178
|
+
|
|
179
|
+
platform_name = "platform_name_example" # String |
|
|
180
|
+
|
|
181
|
+
category_name = "category_name_example" # String | Name of category to request listings from
|
|
182
|
+
|
|
183
|
+
sub_category_name = "sub_category_name_example" # String | Name of subcategory to request listings from
|
|
184
|
+
|
|
185
|
+
opts = {
|
|
186
|
+
page_size: 25, # Integer | The total page size requested
|
|
187
|
+
page_number: 1, # Integer | The page number requested
|
|
188
|
+
sort_by: "sort_by_example", # String | variable name requested to sort by
|
|
189
|
+
expand: nil, # Array<Object> | variable name requested by expand list
|
|
190
|
+
next_page: "next_page_example", # String | next page token
|
|
191
|
+
previous_page: "previous_page_example" # String | Previous page token
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
begin
|
|
195
|
+
#Get listings that are part of the specified subcategory
|
|
196
|
+
result = api_instance.get_appfoundry_platform_name_category_sub_category_name(platform_name, category_name, sub_category_name, opts)
|
|
197
|
+
p result
|
|
198
|
+
rescue PureCloud::ApiError => e
|
|
199
|
+
puts "Exception when calling AppFoundryApi->get_appfoundry_platform_name_category_sub_category_name: #{e}"
|
|
200
|
+
end
|
|
201
|
+
~~~
|
|
202
|
+
|
|
203
|
+
### Parameters
|
|
204
|
+
|
|
205
|
+
Name | Type | Description | Notes
|
|
206
|
+
------------- | ------------- | ------------- | -------------
|
|
207
|
+
**platform_name** | **String**| | |
|
|
208
|
+
**category_name** | **String**| Name of category to request listings from | |
|
|
209
|
+
**sub_category_name** | **String**| Name of subcategory to request listings from | |
|
|
210
|
+
**page_size** | **Integer**| The total page size requested | [optional] [default to 25] |
|
|
211
|
+
**page_number** | **Integer**| The page number requested | [optional] [default to 1] |
|
|
212
|
+
**sort_by** | **String**| variable name requested to sort by | [optional] |
|
|
213
|
+
**expand** | [**Array<Object>**](Object.html)| variable name requested by expand list | [optional] |
|
|
214
|
+
**next_page** | **String**| next page token | [optional] |
|
|
215
|
+
**previous_page** | **String**| Previous page token | [optional] |
|
|
216
|
+
{: class="table table-striped"}
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
### Return type
|
|
220
|
+
|
|
221
|
+
[**PagedListingEntity**](PagedListingEntity.html)
|
|
222
|
+
|
|
223
|
+
### HTTP request headers
|
|
224
|
+
|
|
225
|
+
- **Content-Type**: application/json
|
|
226
|
+
- **Accept**: application/json
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: AppFoundryListing
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::AppFoundryListing
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
|
+
| **name** | [**LocalizedField**](LocalizedField.html) | Localized name | [optional] |
|
|
12
|
+
| **registry_info** | [**AppFoundryListingRegistryInfo**](AppFoundryListingRegistryInfo.html) | Provides information about the integration implementation | [optional] |
|
|
13
|
+
| **marketing_info** | [**MarketingInfo**](MarketingInfo.html) | Marketing data | [optional] |
|
|
14
|
+
| **tagline** | [**LocalizedField**](LocalizedField.html) | Localized tagline | [optional] |
|
|
15
|
+
| **brief_description** | [**LocalizedField**](LocalizedField.html) | Localized short description | [optional] |
|
|
16
|
+
| **full_description** | [**LocalizedField**](LocalizedField.html) | Localized full description | [optional] |
|
|
17
|
+
| **platform** | [**Platform**](Platform.html) | The supported platform | [optional] |
|
|
18
|
+
| **company_logo** | **String** | URL to the company logo to be displayed | [optional] |
|
|
19
|
+
| **app_logo** | **String** | URL to the app logo to be displayed | [optional] |
|
|
20
|
+
| **company_name** | [**LocalizedField**](LocalizedField.html) | Localized company name for the listing publisher | [optional] |
|
|
21
|
+
| **website** | [**LocalizedField**](LocalizedField.html) | Localized URL to the website associated with the listing | [optional] |
|
|
22
|
+
| **screenshots** | **Array<String>** | Screenshot URLS | [optional] |
|
|
23
|
+
| **video_links** | **Array<String>** | Usage video URLS | [optional] |
|
|
24
|
+
| **languages** | **Array<String>** | Indicates the languages that the application supports. Supported application languages may differ from the listing localization languages | [optional] |
|
|
25
|
+
| **vendor_email** | **String** | Contact email for the listing publisher | [optional] |
|
|
26
|
+
| **terms_of_service** | **String** | URL to the terms of service | [optional] |
|
|
27
|
+
| **help_documentation_url** | [**LocalizedField**](LocalizedField.html) | URL to help documentation | [optional] |
|
|
28
|
+
| **marketing_url** | [**LocalizedField**](LocalizedField.html) | URL to external marketing page | [optional] |
|
|
29
|
+
| **industries** | **Array<String>** | Industries targeted | [optional] |
|
|
30
|
+
| **categories** | **Array<String>** | Indicated the categories the listing belongs to | [optional] |
|
|
31
|
+
| **smart_cases** | [**Array<SmartCase>**](SmartCase.html) | Use cases the listing is meant to address | [optional] |
|
|
32
|
+
| **pricing** | [**Array<PricingOption>**](PricingOption.html) | Pricing options for the listing | [optional] |
|
|
33
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
34
|
+
{: class="table table-striped"}
|
|
35
|
+
|
|
36
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: AppFoundryListingCategory
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::AppFoundryListingCategory
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **name** | **String** | Name of the category | [optional] |
|
|
11
|
+
| **sub_categories** | **Array<String>** | Subcategories under this category | [optional] |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: AppFoundryListingRegistryInfo
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::AppFoundryListingRegistryInfo
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | The ID of the integration registry entry that is represented by the listing | [optional] |
|
|
11
|
+
| **regions** | **Array<String>** | Supported regions where the listing may be installed | [optional] |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
data/docs/ArchitectApi.md
CHANGED
|
@@ -861,11 +861,11 @@ Name | Type | Description | Notes
|
|
|
861
861
|
**name** | **String**| Object name to search for | |
|
|
862
862
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
863
863
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
864
|
-
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
864
|
+
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
865
865
|
**consumed_resources** | **BOOLEAN**| Include resources each result item consumes | [optional] |
|
|
866
866
|
**consuming_resources** | **BOOLEAN**| Include resources that consume each result item | [optional] |
|
|
867
|
-
**consumed_resource_type** | [**Array<String>**](String.html)| Types of consumed resources to return, if consumed resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
868
|
-
**consuming_resource_type** | [**Array<String>**](String.html)| Types of consuming resources to return, if consuming resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
867
|
+
**consumed_resource_type** | [**Array<String>**](String.html)| Types of consumed resources to return, if consumed resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
868
|
+
**consuming_resource_type** | [**Array<String>**](String.html)| Types of consuming resources to return, if consuming resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
869
869
|
{: class="table table-striped"}
|
|
870
870
|
|
|
871
871
|
|
|
@@ -986,8 +986,8 @@ Name | Type | Description | Notes
|
|
|
986
986
|
------------- | ------------- | ------------- | -------------
|
|
987
987
|
**id** | **String**| Consuming object ID | |
|
|
988
988
|
**version** | **String**| Consuming object version | |
|
|
989
|
-
**object_type** | **String**| Consuming object type. Only versioned types are allowed here. | <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
990
|
-
**resource_type** | [**Array<String>**](String.html)| Types of consumed resources to show | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
989
|
+
**object_type** | **String**| Consuming object type. Only versioned types are allowed here. | <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
990
|
+
**resource_type** | [**Array<String>**](String.html)| Types of consumed resources to show | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
991
991
|
{: class="table table-striped"}
|
|
992
992
|
|
|
993
993
|
|
|
@@ -1052,8 +1052,8 @@ end
|
|
|
1052
1052
|
Name | Type | Description | Notes
|
|
1053
1053
|
------------- | ------------- | ------------- | -------------
|
|
1054
1054
|
**id** | **String**| Consumed object ID | |
|
|
1055
|
-
**object_type** | **String**| Consumed object type | <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1056
|
-
**resource_type** | [**Array<String>**](String.html)| Types of consuming resources to show. Only versioned types are allowed here. | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1055
|
+
**object_type** | **String**| Consumed object type | <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1056
|
+
**resource_type** | [**Array<String>**](String.html)| Types of consuming resources to show. Only versioned types are allowed here. | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1057
1057
|
{: class="table table-striped"}
|
|
1058
1058
|
|
|
1059
1059
|
|
|
@@ -1120,10 +1120,10 @@ end
|
|
|
1120
1120
|
Name | Type | Description | Notes
|
|
1121
1121
|
------------- | ------------- | ------------- | -------------
|
|
1122
1122
|
**name** | **String**| Name to search for | [optional] |
|
|
1123
|
-
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1123
|
+
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1124
1124
|
**flow_filter** | **String**| Show only checkedIn or published flows | [optional] <br />**Values**: checkedIn, published |
|
|
1125
1125
|
**consumed_resources** | **BOOLEAN**| Return consumed resources? | [optional] [default to false] |
|
|
1126
|
-
**consumed_resource_type** | [**Array<String>**](String.html)| Resource type(s) to return | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1126
|
+
**consumed_resource_type** | [**Array<String>**](String.html)| Resource type(s) to return | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1127
1127
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
1128
1128
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
1129
1129
|
{: class="table table-striped"}
|
|
@@ -1194,11 +1194,11 @@ Name | Type | Description | Notes
|
|
|
1194
1194
|
------------- | ------------- | ------------- | -------------
|
|
1195
1195
|
**id** | **String**| Object ID | |
|
|
1196
1196
|
**version** | **String**| Object version | [optional] |
|
|
1197
|
-
**object_type** | **String**| Object type | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1197
|
+
**object_type** | **String**| Object type | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1198
1198
|
**consumed_resources** | **BOOLEAN**| Include resources this item consumes | [optional] |
|
|
1199
1199
|
**consuming_resources** | **BOOLEAN**| Include resources that consume this item | [optional] |
|
|
1200
|
-
**consumed_resource_type** | [**Array<String>**](String.html)| Types of consumed resources to return, if consumed resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1201
|
-
**consuming_resource_type** | [**Array<String>**](String.html)| Types of consuming resources to return, if consuming resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1200
|
+
**consumed_resource_type** | [**Array<String>**](String.html)| Types of consumed resources to return, if consumed resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1201
|
+
**consuming_resource_type** | [**Array<String>**](String.html)| Types of consuming resources to return, if consuming resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1202
1202
|
{: class="table table-striped"}
|
|
1203
1203
|
|
|
1204
1204
|
|
|
@@ -1385,9 +1385,9 @@ end
|
|
|
1385
1385
|
Name | Type | Description | Notes
|
|
1386
1386
|
------------- | ------------- | ------------- | -------------
|
|
1387
1387
|
**name** | **String**| Name to search for | [optional] |
|
|
1388
|
-
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1388
|
+
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1389
1389
|
**consumed_resources** | **BOOLEAN**| Return consumed resources? | [optional] [default to false] |
|
|
1390
|
-
**consumed_resource_type** | [**Array<String>**](String.html)| Resource type(s) to return | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1390
|
+
**consumed_resource_type** | [**Array<String>**](String.html)| Resource type(s) to return | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1391
1391
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
1392
1392
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
1393
1393
|
{: class="table table-striped"}
|
|
@@ -14,8 +14,8 @@ title: AttemptLimitsEntityListing
|
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: AttributeEntityListing
|
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|