purecloudplatformclientv2 78.1.0 → 79.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/ActionEntityListing.md +1 -1
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/AnalyticsConversationAsyncQueryResponse.md +1 -1
- data/docs/AnalyticsConversationQueryResponse.md +1 -1
- data/docs/AnalyticsParticipant.md +1 -0
- data/docs/AnalyticsParticipantWithoutAttributes.md +1 -0
- data/docs/ArchitectApi.md +345 -0
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AuditApi.md +3 -1
- data/docs/AuditLogMessage.md +1 -1
- data/docs/AuthorizationApi.md +154 -9
- data/docs/AuthzDivisionEntityListing.md +1 -1
- data/docs/AvailableTopic.md +3 -1
- data/docs/BuAgentScheduleActivity.md +18 -0
- data/docs/BuAgentSchedulePublishedScheduleReference.md +16 -0
- data/docs/BuAgentScheduleSearchResponse.md +15 -0
- data/docs/BuAgentScheduleShift.md +18 -0
- data/docs/BuAgentSchedulesSearchResponse.md +15 -0
- data/docs/BuAsyncAgentSchedulesSearchResponse.md +17 -0
- data/docs/BuFullDayTimeOffMarker.md +18 -0
- data/docs/BuScheduleReference.md +15 -0
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/CallbackConversationEntityListing.md +1 -1
- data/docs/CampaignDivisionViewListing.md +1 -1
- data/docs/CampaignEntityListing.md +1 -1
- data/docs/CampaignProgress.md +2 -1
- data/docs/CampaignRuleEntityListing.md +1 -1
- data/docs/CampaignSequenceEntityListing.md +1 -1
- data/docs/CertificateAuthorityEntityListing.md +1 -1
- data/docs/ChatConversationEntityListing.md +1 -1
- data/docs/ClientAppEntityListing.md +1 -1
- data/docs/CobrowseConversationEntityListing.md +1 -1
- data/docs/CommandStatusEntityListing.md +1 -1
- data/docs/ConsumedResourcesEntityListing.md +1 -1
- data/docs/ConsumingResourcesEntityListing.md +1 -1
- data/docs/ContactListDivisionViewListing.md +1 -1
- data/docs/ContactListEntityListing.md +1 -1
- data/docs/ContactListFilterEntityListing.md +1 -1
- data/docs/ContactListing.md +1 -1
- data/docs/ConversationEntityListing.md +1 -1
- data/docs/CredentialInfoListing.md +1 -1
- data/docs/CredentialTypeListing.md +1 -1
- data/docs/DIDEntityListing.md +1 -1
- data/docs/DIDPoolEntityListing.md +1 -1
- data/docs/DataTableExportJob.md +22 -0
- data/docs/DataTableImportJob.md +25 -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/DialogflowAgentSummaryEntityListing.md +1 -1
- data/docs/DirectoryUserDevicesListing.md +1 -1
- data/docs/DivsPermittedEntityListing.md +23 -0
- data/docs/DncListDivisionViewListing.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/EdgeEntityListing.md +1 -1
- data/docs/EdgeGroupEntityListing.md +1 -1
- data/docs/EdgeLineEntityListing.md +1 -1
- data/docs/EmailConversationEntityListing.md +1 -1
- data/docs/EmailMessageListing.md +1 -1
- data/docs/EmergencyGroupListing.md +1 -1
- data/docs/EncryptionKeyEntityListing.md +1 -1
- data/docs/EntityListing.md +17 -0
- data/docs/EvaluationEntityListing.md +1 -1
- data/docs/EvaluationFormEntityListing.md +1 -1
- data/docs/EvaluationQuestionGroupScore.md +4 -0
- data/docs/EvaluationScoringSet.md +1 -0
- data/docs/EvaluatorActivityEntityListing.md +1 -1
- data/docs/ExtensionEntityListing.md +1 -1
- data/docs/ExtensionPoolEntityListing.md +1 -1
- data/docs/ExternalOrganizationListing.md +1 -1
- data/docs/FacebookIntegrationEntityListing.md +1 -1
- data/docs/FaxDocumentEntityListing.md +1 -1
- data/docs/FlowDivisionViewEntityListing.md +1 -1
- data/docs/FlowEntityListing.md +1 -1
- data/docs/FlowOutcomeListing.md +1 -1
- data/docs/FlowVersionEntityListing.md +1 -1
- data/docs/GDPRRequestEntityListing.md +1 -1
- data/docs/GDPRSubjectEntityListing.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/InboundDomainEntityListing.md +1 -1
- data/docs/InboundRouteEntityListing.md +1 -1
- data/docs/IntegrationEntityListing.md +1 -1
- data/docs/IntegrationEventEntityListing.md +1 -1
- data/docs/IntegrationTypeEntityListing.md +1 -1
- data/docs/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LexBotAliasEntityListing.md +1 -1
- data/docs/LexBotEntityListing.md +1 -1
- data/docs/LibraryEntityListing.md +1 -1
- data/docs/LicenseApi.md +66 -0
- data/docs/LineBaseEntityListing.md +1 -1
- data/docs/LineEntityListing.md +1 -1
- data/docs/LineIntegrationEntityListing.md +1 -1
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/MessageConversationEntityListing.md +1 -1
- data/docs/MessagingIntegrationEntityListing.md +1 -1
- data/docs/MessagingStickerEntityListing.md +1 -1
- data/docs/NoteListing.md +1 -1
- data/docs/OAuthClientEntityListing.md +1 -1
- data/docs/OAuthProviderEntityListing.md +1 -1
- data/docs/Organization.md +1 -0
- 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/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/PolicyEntityListing.md +1 -1
- 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/RecordingJobEntityListing.md +1 -1
- 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/ReportingExportMetadataJobListing.md +1 -1
- data/docs/ResponseEntityList.md +1 -1
- data/docs/ResponseEntityListing.md +1 -1
- data/docs/ResponseSetEntityListing.md +1 -1
- data/docs/RoutingApi.md +201 -0
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/SCIMApi.md +8 -8
- 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/ScimUserExtensions.md +2 -2
- data/docs/ScreenRecordingSessionListing.md +1 -1
- data/docs/ScriptEntityListing.md +1 -1
- data/docs/SecurityProfileEntityListing.md +1 -1
- data/docs/ShareEntityListing.md +1 -1
- data/docs/SiteEntityListing.md +1 -1
- data/docs/SkillEntityListing.md +1 -1
- data/docs/SmsAddressEntityListing.md +1 -1
- data/docs/SmsPhoneNumberEntityListing.md +1 -1
- data/docs/StationEntityListing.md +1 -1
- data/docs/SubjectDivisionGrantsEntityListing.md +1 -1
- data/docs/SurveyFormEntityListing.md +1 -1
- data/docs/SystemPromptAssetEntityListing.md +1 -1
- data/docs/SystemPromptEntityListing.md +1 -1
- data/docs/TagValueEntityListing.md +1 -1
- data/docs/TextMessageListing.md +1 -1
- data/docs/TimeZoneEntityListing.md +1 -1
- data/docs/TrunkBaseEntityListing.md +1 -1
- data/docs/TrunkEntityListing.md +1 -1
- data/docs/TrunkMetabaseEntityListing.md +1 -1
- data/docs/TrustEntityListing.md +1 -1
- data/docs/TrustUserEntityListing.md +1 -1
- data/docs/TrustorEntityListing.md +1 -1
- data/docs/TtsEngineEntityListing.md +1 -1
- data/docs/TtsVoiceEntityListing.md +1 -1
- data/docs/TwitterIntegrationEntityListing.md +1 -1
- data/docs/UserActionCategoryEntityListing.md +1 -1
- data/docs/UserEntityListing.md +1 -1
- data/docs/UserLanguageEntityListing.md +1 -1
- data/docs/UserProfileEntityListing.md +1 -1
- data/docs/UserQueueEntityListing.md +1 -1
- data/docs/UserRecordingEntityListing.md +1 -1
- data/docs/UserSkillEntityListing.md +1 -1
- data/docs/UsersApi.md +355 -9
- data/docs/ViewFilter.md +0 -10
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WebChatMemberInfoEntityList.md +1 -1
- data/docs/WhatsAppIntegrationEntityListing.md +1 -1
- data/docs/WorkforceManagementApi.md +2 -2
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +12 -0
- data/lib/purecloudplatformclientv2/api/architect_api.rb +373 -0
- data/lib/purecloudplatformclientv2/api/audit_api.rb +9 -0
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +185 -7
- data/lib/purecloudplatformclientv2/api/license_api.rb +63 -0
- data/lib/purecloudplatformclientv2/api/routing_api.rb +204 -0
- data/lib/purecloudplatformclientv2/api/users_api.rb +389 -7
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +3 -3
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/analytics_conversation_async_query_response.rb +15 -15
- data/lib/purecloudplatformclientv2/models/analytics_conversation_query_response.rb +15 -15
- data/lib/purecloudplatformclientv2/models/analytics_participant.rb +27 -1
- data/lib/purecloudplatformclientv2/models/analytics_participant_without_attributes.rb +27 -1
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/audit_log_message.rb +1 -1
- data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/available_topic.rb +57 -4
- data/lib/purecloudplatformclientv2/models/bu_agent_schedule_activity.rb +332 -0
- data/lib/purecloudplatformclientv2/models/bu_agent_schedule_published_schedule_reference.rb +280 -0
- data/lib/purecloudplatformclientv2/models/bu_agent_schedule_search_response.rb +258 -0
- data/lib/purecloudplatformclientv2/models/bu_agent_schedule_shift.rb +334 -0
- data/lib/purecloudplatformclientv2/models/bu_agent_schedules_search_response.rb +258 -0
- data/lib/purecloudplatformclientv2/models/bu_async_agent_schedules_search_response.rb +320 -0
- data/lib/purecloudplatformclientv2/models/bu_full_day_time_off_marker.rb +332 -0
- data/lib/purecloudplatformclientv2/models/bu_schedule_reference.rb +254 -0
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_progress.rb +28 -2
- 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/chat_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_table_export_job.rb +455 -0
- data/lib/purecloudplatformclientv2/models/data_table_import_job.rb +547 -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_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/dialogflow_agent_summary_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/divs_permitted_entity_listing.rb +453 -0
- data/lib/purecloudplatformclientv2/models/dnc_list_division_view_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/edge_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/entity_listing.rb +303 -0
- 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/evaluation_question_group_score.rb +101 -1
- data/lib/purecloudplatformclientv2/models/evaluation_scoring_set.rb +26 -1
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_outcome_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/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/inbound_domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/lex_bot_alias_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/lex_bot_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/messaging_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/note_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/organization.rb +41 -1
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/recording_job_entity_listing.rb +12 -12
- 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_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/reporting_export_metadata_job_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/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/scim_user_extensions.rb +2 -2
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb +2 -2
- 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/sms_address_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tts_engine_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tts_voice_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/view_filter.rb +1 -313
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/whats_app_integration_entity_listing.rb +12 -12
- 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 +26 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 2fb7ad6b87905946dfc74db0074de53b61f551e6
|
4
|
+
data.tar.gz: 6f6596a2d8a487e68467d888aedbc0cfc98dca6b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5c11fc677709bf7299ebc3245733d791db6f363f4d1775c3497f8126c230d391db0594bc8eba9085e4721faedfb605e9ae536b0f77340ee5bdde76dca683a833
|
7
|
+
data.tar.gz: 60f5105b91dc8cfbf71977085f83822c7e2164ef26f33040bdcb8c6c1f067661ab3a2c259fd205eb39647d05d9976b6ee9adbe9532e186456cc3ab1ff40ebb28
|
data/README.md
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
title: PureCloud Ruby Gem
|
3
3
|
---
|
4
|
-
![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=
|
4
|
+
![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=79.0.0)
|
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
|
```{"language":"ruby"}
|
13
|
-
gem install 'purecloudplatformclientv2', '~>
|
13
|
+
gem install 'purecloudplatformclientv2', '~> 79.0.0'
|
14
14
|
```
|
15
15
|
|
16
16
|
### Install from Git
|
data/docs/ActionEntityListing.md
CHANGED
@@ -14,8 +14,8 @@ title: ActionEntityListing
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **last_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
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -7,8 +7,8 @@ title: AnalyticsConversationAsyncQueryResponse
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **conversations** | [**Array<AnalyticsConversation>**](AnalyticsConversation.html) | | [optional] |
|
11
10
|
| **cursor** | **String** | Optional cursor to indicate where to resume the results | [optional] |
|
11
|
+
| **conversations** | [**Array<AnalyticsConversation>**](AnalyticsConversation.html) | | [optional] |
|
12
12
|
{: class="table table-striped"}
|
13
13
|
|
14
14
|
|
@@ -7,8 +7,8 @@ title: AnalyticsConversationQueryResponse
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **conversations** | [**Array<AnalyticsConversation>**](AnalyticsConversation.html) | | [optional] |
|
11
10
|
| **aggregations** | [**Array<AggregationResult>**](AggregationResult.html) | | [optional] |
|
11
|
+
| **conversations** | [**Array<AnalyticsConversationWithoutAttributes>**](AnalyticsConversationWithoutAttributes.html) | | [optional] |
|
12
12
|
{: class="table table-striped"}
|
13
13
|
|
14
14
|
|
@@ -14,6 +14,7 @@ title: AnalyticsParticipant
|
|
14
14
|
| **external_contact_id** | **String** | External Contact Identifier | [optional] |
|
15
15
|
| **external_organization_id** | **String** | External Organization Identifier | [optional] |
|
16
16
|
| **flagged_reason** | **String** | Reason for which participant flagged conversation | [optional] |
|
17
|
+
| **team_id** | **String** | The team id the user is a member of | [optional] |
|
17
18
|
| **sessions** | [**Array<AnalyticsSession>**](AnalyticsSession.html) | List of sessions associated to this participant | [optional] |
|
18
19
|
| **attributes** | **Hash<String, String>** | List of attributes associated to this participant | [optional] |
|
19
20
|
{: class="table table-striped"}
|
@@ -14,6 +14,7 @@ title: AnalyticsParticipantWithoutAttributes
|
|
14
14
|
| **external_contact_id** | **String** | External Contact Identifier | [optional] |
|
15
15
|
| **external_organization_id** | **String** | External Organization Identifier | [optional] |
|
16
16
|
| **flagged_reason** | **String** | Reason for which participant flagged conversation | [optional] |
|
17
|
+
| **team_id** | **String** | The team id the user is a member of | [optional] |
|
17
18
|
| **sessions** | [**Array<AnalyticsSession>**](AnalyticsSession.html) | List of sessions associated to this participant | [optional] |
|
18
19
|
{: class="table table-striped"}
|
19
20
|
|
data/docs/ArchitectApi.md
CHANGED
@@ -56,6 +56,9 @@ Method | Description
|
|
56
56
|
[**get_flow_versions**](ArchitectApi.html#get_flow_versions) | Get flow version list
|
57
57
|
[**get_flows**](ArchitectApi.html#get_flows) | Get a pageable list of flows, filtered by query parameters
|
58
58
|
[**get_flows_datatable**](ArchitectApi.html#get_flows_datatable) | Returns a specific datatable by id
|
59
|
+
[**get_flows_datatable_export_job**](ArchitectApi.html#get_flows_datatable_export_job) | Returns the state information about an export job
|
60
|
+
[**get_flows_datatable_import_job**](ArchitectApi.html#get_flows_datatable_import_job) | Returns the state information about an import job
|
61
|
+
[**get_flows_datatable_import_jobs**](ArchitectApi.html#get_flows_datatable_import_jobs) | Get all recent import jobs
|
59
62
|
[**get_flows_datatable_row**](ArchitectApi.html#get_flows_datatable_row) | Returns a specific row for the datatable
|
60
63
|
[**get_flows_datatable_rows**](ArchitectApi.html#get_flows_datatable_rows) | Returns the rows for the datatable with the given id
|
61
64
|
[**get_flows_datatables**](ArchitectApi.html#get_flows_datatables) | Retrieve a list of datatables for the org
|
@@ -80,6 +83,8 @@ Method | Description
|
|
80
83
|
[**post_flows_actions_publish**](ArchitectApi.html#post_flows_actions_publish) | Publish flow
|
81
84
|
[**post_flows_actions_revert**](ArchitectApi.html#post_flows_actions_revert) | Revert flow
|
82
85
|
[**post_flows_actions_unlock**](ArchitectApi.html#post_flows_actions_unlock) | Unlock flow
|
86
|
+
[**post_flows_datatable_export_jobs**](ArchitectApi.html#post_flows_datatable_export_jobs) | Begin an export process for exporting all rows from a datatable
|
87
|
+
[**post_flows_datatable_import_jobs**](ArchitectApi.html#post_flows_datatable_import_jobs) | Begin an import process for importing rows into a datatable
|
83
88
|
[**post_flows_datatable_rows**](ArchitectApi.html#post_flows_datatable_rows) | Create a new row entry for the datatable.
|
84
89
|
[**post_flows_datatables**](ArchitectApi.html#post_flows_datatables) | Create a new datatable with the specified json-schema definition
|
85
90
|
[**post_flows_outcomes**](ArchitectApi.html#post_flows_outcomes) | Create a flow outcome
|
@@ -3503,6 +3508,213 @@ Name | Type | Description | Notes
|
|
3503
3508
|
|
3504
3509
|
|
3505
3510
|
|
3511
|
+
<a name="get_flows_datatable_export_job"></a>
|
3512
|
+
|
3513
|
+
## [**DataTableExportJob**](DataTableExportJob.html) get_flows_datatable_export_job(datatable_id, export_job_id)
|
3514
|
+
|
3515
|
+
|
3516
|
+
|
3517
|
+
Returns the state information about an export job
|
3518
|
+
|
3519
|
+
Returns the state information about an export job.
|
3520
|
+
|
3521
|
+
Wraps GET /api/v2/flows/datatables/{datatableId}/export/jobs/{exportJobId}
|
3522
|
+
|
3523
|
+
Requires ANY permissions:
|
3524
|
+
|
3525
|
+
* architect:datatable:view
|
3526
|
+
|
3527
|
+
|
3528
|
+
### Example
|
3529
|
+
```{"language":"ruby"}
|
3530
|
+
# load the gem
|
3531
|
+
require 'purecloudplatformclientv2'
|
3532
|
+
# setup authorization
|
3533
|
+
@secret = ENV['PURECLOUD_SECRET']
|
3534
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
3535
|
+
environment = "mypurecloud.com"
|
3536
|
+
|
3537
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
3538
|
+
|
3539
|
+
PureCloud.configure do |config|
|
3540
|
+
config.access_token = @authToken
|
3541
|
+
end
|
3542
|
+
|
3543
|
+
api_instance = PureCloud::ArchitectApi.new
|
3544
|
+
|
3545
|
+
datatable_id = "datatable_id_example" # String | id of datatable
|
3546
|
+
|
3547
|
+
export_job_id = "export_job_id_example" # String | id of export job
|
3548
|
+
|
3549
|
+
|
3550
|
+
begin
|
3551
|
+
#Returns the state information about an export job
|
3552
|
+
result = api_instance.get_flows_datatable_export_job(datatable_id, export_job_id)
|
3553
|
+
p result
|
3554
|
+
rescue PureCloud::ApiError => e
|
3555
|
+
puts "Exception when calling ArchitectApi->get_flows_datatable_export_job: #{e}"
|
3556
|
+
end
|
3557
|
+
```
|
3558
|
+
|
3559
|
+
### Parameters
|
3560
|
+
|
3561
|
+
Name | Type | Description | Notes
|
3562
|
+
------------- | ------------- | ------------- | -------------
|
3563
|
+
**datatable_id** | **String**| id of datatable | |
|
3564
|
+
**export_job_id** | **String**| id of export job | |
|
3565
|
+
{: class="table table-striped"}
|
3566
|
+
|
3567
|
+
|
3568
|
+
### Return type
|
3569
|
+
|
3570
|
+
[**DataTableExportJob**](DataTableExportJob.html)
|
3571
|
+
|
3572
|
+
### HTTP request headers
|
3573
|
+
|
3574
|
+
- **Content-Type**: application/json
|
3575
|
+
- **Accept**: application/json
|
3576
|
+
|
3577
|
+
|
3578
|
+
|
3579
|
+
<a name="get_flows_datatable_import_job"></a>
|
3580
|
+
|
3581
|
+
## [**DataTableImportJob**](DataTableImportJob.html) get_flows_datatable_import_job(datatable_id, import_job_id)
|
3582
|
+
|
3583
|
+
|
3584
|
+
|
3585
|
+
Returns the state information about an import job
|
3586
|
+
|
3587
|
+
Returns the state information about an import job.
|
3588
|
+
|
3589
|
+
Wraps GET /api/v2/flows/datatables/{datatableId}/import/jobs/{importJobId}
|
3590
|
+
|
3591
|
+
Requires ANY permissions:
|
3592
|
+
|
3593
|
+
* architect:datatable:view
|
3594
|
+
|
3595
|
+
|
3596
|
+
### Example
|
3597
|
+
```{"language":"ruby"}
|
3598
|
+
# load the gem
|
3599
|
+
require 'purecloudplatformclientv2'
|
3600
|
+
# setup authorization
|
3601
|
+
@secret = ENV['PURECLOUD_SECRET']
|
3602
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
3603
|
+
environment = "mypurecloud.com"
|
3604
|
+
|
3605
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
3606
|
+
|
3607
|
+
PureCloud.configure do |config|
|
3608
|
+
config.access_token = @authToken
|
3609
|
+
end
|
3610
|
+
|
3611
|
+
api_instance = PureCloud::ArchitectApi.new
|
3612
|
+
|
3613
|
+
datatable_id = "datatable_id_example" # String | id of datatable
|
3614
|
+
|
3615
|
+
import_job_id = "import_job_id_example" # String | id of import job
|
3616
|
+
|
3617
|
+
|
3618
|
+
begin
|
3619
|
+
#Returns the state information about an import job
|
3620
|
+
result = api_instance.get_flows_datatable_import_job(datatable_id, import_job_id)
|
3621
|
+
p result
|
3622
|
+
rescue PureCloud::ApiError => e
|
3623
|
+
puts "Exception when calling ArchitectApi->get_flows_datatable_import_job: #{e}"
|
3624
|
+
end
|
3625
|
+
```
|
3626
|
+
|
3627
|
+
### Parameters
|
3628
|
+
|
3629
|
+
Name | Type | Description | Notes
|
3630
|
+
------------- | ------------- | ------------- | -------------
|
3631
|
+
**datatable_id** | **String**| id of datatable | |
|
3632
|
+
**import_job_id** | **String**| id of import job | |
|
3633
|
+
{: class="table table-striped"}
|
3634
|
+
|
3635
|
+
|
3636
|
+
### Return type
|
3637
|
+
|
3638
|
+
[**DataTableImportJob**](DataTableImportJob.html)
|
3639
|
+
|
3640
|
+
### HTTP request headers
|
3641
|
+
|
3642
|
+
- **Content-Type**: application/json
|
3643
|
+
- **Accept**: application/json
|
3644
|
+
|
3645
|
+
|
3646
|
+
|
3647
|
+
<a name="get_flows_datatable_import_jobs"></a>
|
3648
|
+
|
3649
|
+
## [**EntityListing**](EntityListing.html) get_flows_datatable_import_jobs(datatable_id, opts)
|
3650
|
+
|
3651
|
+
|
3652
|
+
|
3653
|
+
Get all recent import jobs
|
3654
|
+
|
3655
|
+
Get all recent import jobs
|
3656
|
+
|
3657
|
+
Wraps GET /api/v2/flows/datatables/{datatableId}/import/jobs
|
3658
|
+
|
3659
|
+
Requires ANY permissions:
|
3660
|
+
|
3661
|
+
* architect:datatable:edit
|
3662
|
+
|
3663
|
+
|
3664
|
+
### Example
|
3665
|
+
```{"language":"ruby"}
|
3666
|
+
# load the gem
|
3667
|
+
require 'purecloudplatformclientv2'
|
3668
|
+
# setup authorization
|
3669
|
+
@secret = ENV['PURECLOUD_SECRET']
|
3670
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
3671
|
+
environment = "mypurecloud.com"
|
3672
|
+
|
3673
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
3674
|
+
|
3675
|
+
PureCloud.configure do |config|
|
3676
|
+
config.access_token = @authToken
|
3677
|
+
end
|
3678
|
+
|
3679
|
+
api_instance = PureCloud::ArchitectApi.new
|
3680
|
+
|
3681
|
+
datatable_id = "datatable_id_example" # String | id of datatable
|
3682
|
+
|
3683
|
+
opts = {
|
3684
|
+
page_number: 1, # Integer | Page number
|
3685
|
+
page_size: 25 # Integer | Page size
|
3686
|
+
}
|
3687
|
+
|
3688
|
+
begin
|
3689
|
+
#Get all recent import jobs
|
3690
|
+
result = api_instance.get_flows_datatable_import_jobs(datatable_id, opts)
|
3691
|
+
p result
|
3692
|
+
rescue PureCloud::ApiError => e
|
3693
|
+
puts "Exception when calling ArchitectApi->get_flows_datatable_import_jobs: #{e}"
|
3694
|
+
end
|
3695
|
+
```
|
3696
|
+
|
3697
|
+
### Parameters
|
3698
|
+
|
3699
|
+
Name | Type | Description | Notes
|
3700
|
+
------------- | ------------- | ------------- | -------------
|
3701
|
+
**datatable_id** | **String**| id of datatable | |
|
3702
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
3703
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
3704
|
+
{: class="table table-striped"}
|
3705
|
+
|
3706
|
+
|
3707
|
+
### Return type
|
3708
|
+
|
3709
|
+
[**EntityListing**](EntityListing.html)
|
3710
|
+
|
3711
|
+
### HTTP request headers
|
3712
|
+
|
3713
|
+
- **Content-Type**: application/json
|
3714
|
+
- **Accept**: application/json
|
3715
|
+
|
3716
|
+
|
3717
|
+
|
3506
3718
|
<a name="get_flows_datatable_row"></a>
|
3507
3719
|
|
3508
3720
|
## Hash<String, Object>** get_flows_datatable_row(datatable_id, row_id, opts)
|
@@ -5133,6 +5345,139 @@ Name | Type | Description | Notes
|
|
5133
5345
|
|
5134
5346
|
|
5135
5347
|
|
5348
|
+
<a name="post_flows_datatable_export_jobs"></a>
|
5349
|
+
|
5350
|
+
## [**DataTableExportJob**](DataTableExportJob.html) post_flows_datatable_export_jobs(datatable_id)
|
5351
|
+
|
5352
|
+
|
5353
|
+
|
5354
|
+
Begin an export process for exporting all rows from a datatable
|
5355
|
+
|
5356
|
+
Create an export job for exporting rows. The caller can then poll for status of the export using the token returned in the response
|
5357
|
+
|
5358
|
+
Wraps POST /api/v2/flows/datatables/{datatableId}/export/jobs
|
5359
|
+
|
5360
|
+
Requires ANY permissions:
|
5361
|
+
|
5362
|
+
* architect:datatable:view
|
5363
|
+
|
5364
|
+
|
5365
|
+
### Example
|
5366
|
+
```{"language":"ruby"}
|
5367
|
+
# load the gem
|
5368
|
+
require 'purecloudplatformclientv2'
|
5369
|
+
# setup authorization
|
5370
|
+
@secret = ENV['PURECLOUD_SECRET']
|
5371
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
5372
|
+
environment = "mypurecloud.com"
|
5373
|
+
|
5374
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
5375
|
+
|
5376
|
+
PureCloud.configure do |config|
|
5377
|
+
config.access_token = @authToken
|
5378
|
+
end
|
5379
|
+
|
5380
|
+
api_instance = PureCloud::ArchitectApi.new
|
5381
|
+
|
5382
|
+
datatable_id = "datatable_id_example" # String | id of datatable
|
5383
|
+
|
5384
|
+
|
5385
|
+
begin
|
5386
|
+
#Begin an export process for exporting all rows from a datatable
|
5387
|
+
result = api_instance.post_flows_datatable_export_jobs(datatable_id)
|
5388
|
+
p result
|
5389
|
+
rescue PureCloud::ApiError => e
|
5390
|
+
puts "Exception when calling ArchitectApi->post_flows_datatable_export_jobs: #{e}"
|
5391
|
+
end
|
5392
|
+
```
|
5393
|
+
|
5394
|
+
### Parameters
|
5395
|
+
|
5396
|
+
Name | Type | Description | Notes
|
5397
|
+
------------- | ------------- | ------------- | -------------
|
5398
|
+
**datatable_id** | **String**| id of datatable | |
|
5399
|
+
{: class="table table-striped"}
|
5400
|
+
|
5401
|
+
|
5402
|
+
### Return type
|
5403
|
+
|
5404
|
+
[**DataTableExportJob**](DataTableExportJob.html)
|
5405
|
+
|
5406
|
+
### HTTP request headers
|
5407
|
+
|
5408
|
+
- **Content-Type**: application/json
|
5409
|
+
- **Accept**: application/json
|
5410
|
+
|
5411
|
+
|
5412
|
+
|
5413
|
+
<a name="post_flows_datatable_import_jobs"></a>
|
5414
|
+
|
5415
|
+
## [**DataTableImportJob**](DataTableImportJob.html) post_flows_datatable_import_jobs(datatable_id, body)
|
5416
|
+
|
5417
|
+
|
5418
|
+
|
5419
|
+
Begin an import process for importing rows into a datatable
|
5420
|
+
|
5421
|
+
Create an import job for importing rows. The caller can then poll for status of the import using the token returned in the response
|
5422
|
+
|
5423
|
+
Wraps POST /api/v2/flows/datatables/{datatableId}/import/jobs
|
5424
|
+
|
5425
|
+
Requires ANY permissions:
|
5426
|
+
|
5427
|
+
* architect:datatable:edit
|
5428
|
+
|
5429
|
+
|
5430
|
+
### Example
|
5431
|
+
```{"language":"ruby"}
|
5432
|
+
# load the gem
|
5433
|
+
require 'purecloudplatformclientv2'
|
5434
|
+
# setup authorization
|
5435
|
+
@secret = ENV['PURECLOUD_SECRET']
|
5436
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
5437
|
+
environment = "mypurecloud.com"
|
5438
|
+
|
5439
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
5440
|
+
|
5441
|
+
PureCloud.configure do |config|
|
5442
|
+
config.access_token = @authToken
|
5443
|
+
end
|
5444
|
+
|
5445
|
+
api_instance = PureCloud::ArchitectApi.new
|
5446
|
+
|
5447
|
+
datatable_id = "datatable_id_example" # String | id of datatable
|
5448
|
+
|
5449
|
+
body = PureCloud::DataTableImportJob.new # DataTableImportJob | import job information
|
5450
|
+
|
5451
|
+
|
5452
|
+
begin
|
5453
|
+
#Begin an import process for importing rows into a datatable
|
5454
|
+
result = api_instance.post_flows_datatable_import_jobs(datatable_id, body)
|
5455
|
+
p result
|
5456
|
+
rescue PureCloud::ApiError => e
|
5457
|
+
puts "Exception when calling ArchitectApi->post_flows_datatable_import_jobs: #{e}"
|
5458
|
+
end
|
5459
|
+
```
|
5460
|
+
|
5461
|
+
### Parameters
|
5462
|
+
|
5463
|
+
Name | Type | Description | Notes
|
5464
|
+
------------- | ------------- | ------------- | -------------
|
5465
|
+
**datatable_id** | **String**| id of datatable | |
|
5466
|
+
**body** | [**DataTableImportJob**](DataTableImportJob.html)| import job information | |
|
5467
|
+
{: class="table table-striped"}
|
5468
|
+
|
5469
|
+
|
5470
|
+
### Return type
|
5471
|
+
|
5472
|
+
[**DataTableImportJob**](DataTableImportJob.html)
|
5473
|
+
|
5474
|
+
### HTTP request headers
|
5475
|
+
|
5476
|
+
- **Content-Type**: application/json
|
5477
|
+
- **Accept**: application/json
|
5478
|
+
|
5479
|
+
|
5480
|
+
|
5136
5481
|
<a name="post_flows_datatable_rows"></a>
|
5137
5482
|
|
5138
5483
|
## Hash<String, Object>** post_flows_datatable_rows(datatable_id, data_table_row)
|