purecloudplatformclientv2 25.0.0 → 26.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/ArchitectApi.md +633 -0
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AttributeEntityListing.md +1 -1
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallHistoryConversation.md +3 -0
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/CallbackConversationEntityListing.md +1 -1
- data/docs/CampaignEntityListing.md +1 -1
- data/docs/CampaignRuleEntityListing.md +1 -1
- data/docs/CampaignSequenceEntityListing.md +1 -1
- data/docs/CertificateAuthorityEntityListing.md +1 -1
- data/docs/ChangeMyPasswordRequest.md +14 -0
- data/docs/ChangePasswordRequest.md +13 -0
- data/docs/ChatConversationEntityListing.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/ContactListEntityListing.md +1 -1
- data/docs/ContactListFilterEntityListing.md +1 -1
- data/docs/ContactListNotification.md +2 -0
- data/docs/ContactListing.md +1 -1
- data/docs/ConversationEntityListing.md +1 -1
- data/docs/DIDEntityListing.md +1 -1
- data/docs/DIDPoolEntityListing.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/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/EncryptionKeyEntityListing.md +1 -1
- data/docs/EndpointEntityListing.md +1 -1
- data/docs/EvaluationEntityListing.md +1 -1
- data/docs/EvaluationFormEntityListing.md +1 -1
- data/docs/EvaluatorActivityEntityListing.md +1 -1
- data/docs/ExtensionEntityListing.md +1 -1
- data/docs/ExtensionPoolEntityListing.md +1 -1
- data/docs/ExternalContact.md +1 -1
- data/docs/ExternalOrganization.md +1 -0
- 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/GreetingListing.md +1 -1
- data/docs/GroupEntityListing.md +1 -1
- data/docs/IVREntityListing.md +1 -1
- data/docs/InboundDomainEntityListing.md +1 -1
- data/docs/InboundRouteEntityListing.md +1 -1
- data/docs/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/JsonNode.md +3 -3
- data/docs/JsonSchemaDocument.md +1 -0
- 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/LocationEntityListing.md +1 -1
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/Metabase.md +1 -0
- data/docs/NoteListing.md +1 -1
- data/docs/OAuthClientEntityListing.md +1 -1
- data/docs/OAuthProviderEntityListing.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/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/PolicyActions.md +1 -0
- data/docs/PolicyEntityListing.md +1 -1
- data/docs/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- data/docs/PublishForm.md +1 -1
- data/docs/QualityApi.md +4 -4
- data/docs/QualityAuditPage.md +1 -1
- data/docs/QueueEntityListing.md +1 -1
- data/docs/QueueMemberEntityListing.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/ResponseEntityList.md +1 -1
- data/docs/ResponseEntityListing.md +1 -1
- data/docs/ResponseSetEntityListing.md +1 -1
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/ScheduleEntityListing.md +1 -1
- data/docs/ScheduleGroupEntityListing.md +1 -1
- data/docs/SchemaCategoryEntityListing.md +1 -1
- data/docs/SchemaReferenceEntityListing.md +1 -1
- data/docs/ScreenRecordingSessionListing.md +1 -1
- data/docs/ScriptEntityListing.md +1 -1
- data/docs/SecurityProfileEntityListing.md +1 -1
- data/docs/ShareEntityListing.md +1 -1
- data/docs/SiteEntityListing.md +1 -1
- data/docs/SkillEntityListing.md +1 -1
- data/docs/StationEntityListing.md +1 -1
- data/docs/SurveyAssignment.md +15 -0
- data/docs/SurveyFormEntityListing.md +1 -1
- data/docs/SurveyFormUriReference.md +16 -0
- data/docs/SystemPromptAssetEntityListing.md +1 -1
- data/docs/SystemPromptEntityListing.md +1 -1
- data/docs/TagValueEntityListing.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/UserEntityListing.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 +121 -0
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WebChatApi.md +0 -60
- data/docs/WfmUpdateAgentDetailsCompleteNotification.md +1 -1
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +4 -0
- data/lib/purecloudplatformclientv2/api/architect_api.rb +838 -99
- data/lib/purecloudplatformclientv2/api/quality_api.rb +4 -4
- data/lib/purecloudplatformclientv2/api/users_api.rb +138 -0
- data/lib/purecloudplatformclientv2/api/web_chat_api.rb +0 -65
- 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/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_history_conversation.rb +79 -1
- 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_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/change_my_password_request.rb +238 -0
- data/lib/purecloudplatformclientv2/models/change_password_request.rb +207 -0
- data/lib/purecloudplatformclientv2/models/chat_conversation_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_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_notification.rb +51 -1
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dnc_list_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/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_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_contact.rb +1 -0
- data/lib/purecloudplatformclientv2/models/external_organization.rb +27 -1
- 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/greeting_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/group_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/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/json_node.rb +29 -29
- data/lib/purecloudplatformclientv2/models/json_schema_document.rb +29 -4
- 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/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/metabase.rb +40 -1
- 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_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_actions.rb +28 -1
- 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/publish_form.rb +9 -9
- 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/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/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/screen_recording_session_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/survey_assignment.rb +254 -0
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/survey_form_uri_reference.rb +277 -0
- 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/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/user_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/voicemail_message_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/wfm_update_agent_details_complete_notification.rb +15 -15
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +10 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 0a9e8cdddaa549c348f7c991127c861066e15bb1
|
4
|
+
data.tar.gz: 61db16077c166549b76fefe13e2e8f39314b1cd6
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6b9ec3687d566ebbbfa5690052d5db119397348cd982e879db2bfae2dd60f3dac17b4d9577ee0d8ec4f6f71ad7c13a1e0524432debbbcf804eb2790fe9bc743f
|
7
|
+
data.tar.gz: 9adc91e6b803739f81cb4df5c17d238f5a659328804105a8c6261a98b7025dace94f0889fb79e3fbbe36d4c21276886bbdce678875306ddaeff30b405c784fb5
|
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=26.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
|
~~~ ruby
|
13
|
-
gem install 'purecloudplatformclientv2', '~>
|
13
|
+
gem install 'purecloudplatformclientv2', '~> 26.0.0'
|
14
14
|
~~~
|
15
15
|
|
16
16
|
### Install from Git
|
data/docs/ActionEntityListing.md
CHANGED
@@ -13,8 +13,8 @@ title: ActionEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **previous_uri** | **String** | | [optional] |
|
17
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -13,8 +13,8 @@ title: AgentActivityEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **previous_uri** | **String** | | [optional] |
|
17
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
data/docs/ArchitectApi.md
CHANGED
@@ -17,6 +17,8 @@ Method | Description
|
|
17
17
|
[**delete_architect_systemprompt_resource**](ArchitectApi.html#delete_architect_systemprompt_resource) | Delete a system prompt resource override.
|
18
18
|
[**delete_flow**](ArchitectApi.html#delete_flow) | Delete flow
|
19
19
|
[**delete_flows**](ArchitectApi.html#delete_flows) | Batch-delete a list of flows
|
20
|
+
[**delete_flows_datatable**](ArchitectApi.html#delete_flows_datatable) | deletes a specific datatable by id
|
21
|
+
[**delete_flows_datatable_row**](ArchitectApi.html#delete_flows_datatable_row) | Delete a row entry
|
20
22
|
[**get_architect_dependencytracking**](ArchitectApi.html#get_architect_dependencytracking) | Get Dependency Tracking objects that have a given display name
|
21
23
|
[**get_architect_dependencytracking_build**](ArchitectApi.html#get_architect_dependencytracking_build) | Get Dependency Tracking build status for an organization
|
22
24
|
[**get_architect_dependencytracking_consumedresources**](ArchitectApi.html#get_architect_dependencytracking_consumedresources) | Get resources that are consumed by a given Dependency Tracking object
|
@@ -49,6 +51,10 @@ Method | Description
|
|
49
51
|
[**get_flow_version_configuration**](ArchitectApi.html#get_flow_version_configuration) | Create flow version configuration
|
50
52
|
[**get_flow_versions**](ArchitectApi.html#get_flow_versions) | Get flow version list
|
51
53
|
[**get_flows**](ArchitectApi.html#get_flows) | Get a pageable list of flows, filtered by query parameters
|
54
|
+
[**get_flows_datatable**](ArchitectApi.html#get_flows_datatable) | Returns a specific datatable by datatableId
|
55
|
+
[**get_flows_datatable_row**](ArchitectApi.html#get_flows_datatable_row) | Returns a specific row for the datatable
|
56
|
+
[**get_flows_datatable_rows**](ArchitectApi.html#get_flows_datatable_rows) | Returns the rows for the datatable
|
57
|
+
[**get_flows_datatables**](ArchitectApi.html#get_flows_datatables) | Retrieve a list of datatables for the org
|
52
58
|
[**post_architect_dependencytracking_build**](ArchitectApi.html#post_architect_dependencytracking_build) | Rebuild Dependency Tracking data for an organization
|
53
59
|
[**post_architect_ivrs**](ArchitectApi.html#post_architect_ivrs) | Create IVR config.
|
54
60
|
[**post_architect_prompt_history**](ArchitectApi.html#post_architect_prompt_history) | Generate prompt history
|
@@ -66,6 +72,8 @@ Method | Description
|
|
66
72
|
[**post_flows_actions_publish**](ArchitectApi.html#post_flows_actions_publish) | Publish flow
|
67
73
|
[**post_flows_actions_revert**](ArchitectApi.html#post_flows_actions_revert) | Revert flow
|
68
74
|
[**post_flows_actions_unlock**](ArchitectApi.html#post_flows_actions_unlock) | Unlock flow
|
75
|
+
[**post_flows_datatable_rows**](ArchitectApi.html#post_flows_datatable_rows) | Create a new row entry
|
76
|
+
[**post_flows_datatables**](ArchitectApi.html#post_flows_datatables) | Create a new datatable with the specified json-schema definition
|
69
77
|
[**put_architect_ivr**](ArchitectApi.html#put_architect_ivr) | Update an IVR Config.
|
70
78
|
[**put_architect_prompt**](ArchitectApi.html#put_architect_prompt) | Update specified user prompt
|
71
79
|
[**put_architect_prompt_resource**](ArchitectApi.html#put_architect_prompt_resource) | Update specified user prompt resource
|
@@ -73,6 +81,8 @@ Method | Description
|
|
73
81
|
[**put_architect_schedulegroup**](ArchitectApi.html#put_architect_schedulegroup) | Updates a schedule group by ID
|
74
82
|
[**put_architect_systemprompt_resource**](ArchitectApi.html#put_architect_systemprompt_resource) | Updates a system prompt resource override.
|
75
83
|
[**put_flow**](ArchitectApi.html#put_flow) | Update flow
|
84
|
+
[**put_flows_datatable**](ArchitectApi.html#put_flows_datatable) | Updates a specific datatable by datatableId
|
85
|
+
[**put_flows_datatable_row**](ArchitectApi.html#put_flows_datatable_row) | Update a row entry
|
76
86
|
{: class="table table-striped"}
|
77
87
|
|
78
88
|
<a name="delete_architect_ivr"></a>
|
@@ -609,6 +619,125 @@ Name | Type | Description | Notes
|
|
609
619
|
|
610
620
|
|
611
621
|
|
622
|
+
<a name="delete_flows_datatable"></a>
|
623
|
+
|
624
|
+
## - delete_flows_datatable(datatable_id)
|
625
|
+
|
626
|
+
deletes a specific datatable by id
|
627
|
+
|
628
|
+
deletes an entire datatable (including schema and data) with a given datatableId)
|
629
|
+
|
630
|
+
Wraps DELETE /api/v2/flows/datatables/{datatableId}
|
631
|
+
|
632
|
+
|
633
|
+
### Example
|
634
|
+
~~~ruby
|
635
|
+
# load the gem
|
636
|
+
require 'purecloudplatformclientv2'
|
637
|
+
# setup authorization
|
638
|
+
@secret = ENV['PURECLOUD_SECRET']
|
639
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
640
|
+
environment = "mypurecloud.com"
|
641
|
+
|
642
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
643
|
+
|
644
|
+
PureCloud.configure do |config|
|
645
|
+
config.access_token = @authToken
|
646
|
+
end
|
647
|
+
|
648
|
+
api_instance = PureCloud::ArchitectApi.new
|
649
|
+
|
650
|
+
datatable_id = "datatable_id_example" # String | id of datatable
|
651
|
+
|
652
|
+
|
653
|
+
begin
|
654
|
+
#deletes a specific datatable by id
|
655
|
+
api_instance.delete_flows_datatable(datatable_id)
|
656
|
+
rescue PureCloud::ApiError => e
|
657
|
+
puts "Exception when calling ArchitectApi->delete_flows_datatable: #{e}"
|
658
|
+
end
|
659
|
+
~~~
|
660
|
+
|
661
|
+
### Parameters
|
662
|
+
|
663
|
+
Name | Type | Description | Notes
|
664
|
+
------------- | ------------- | ------------- | -------------
|
665
|
+
**datatable_id** | **String**| id of datatable | |
|
666
|
+
{: class="table table-striped"}
|
667
|
+
|
668
|
+
|
669
|
+
### Return type
|
670
|
+
|
671
|
+
nil (empty response body)
|
672
|
+
|
673
|
+
### HTTP request headers
|
674
|
+
|
675
|
+
- **Content-Type**: application/json
|
676
|
+
- **Accept**: application/json
|
677
|
+
|
678
|
+
|
679
|
+
|
680
|
+
<a name="delete_flows_datatable_row"></a>
|
681
|
+
|
682
|
+
## - delete_flows_datatable_row(datatable_id, row_id)
|
683
|
+
|
684
|
+
Delete a row entry
|
685
|
+
|
686
|
+
Deletes a row with a given rowId.
|
687
|
+
|
688
|
+
Wraps DELETE /api/v2/flows/datatables/{datatableId}/rows/{rowId}
|
689
|
+
|
690
|
+
|
691
|
+
### Example
|
692
|
+
~~~ruby
|
693
|
+
# load the gem
|
694
|
+
require 'purecloudplatformclientv2'
|
695
|
+
# setup authorization
|
696
|
+
@secret = ENV['PURECLOUD_SECRET']
|
697
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
698
|
+
environment = "mypurecloud.com"
|
699
|
+
|
700
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
701
|
+
|
702
|
+
PureCloud.configure do |config|
|
703
|
+
config.access_token = @authToken
|
704
|
+
end
|
705
|
+
|
706
|
+
api_instance = PureCloud::ArchitectApi.new
|
707
|
+
|
708
|
+
datatable_id = "datatable_id_example" # String | id of datatable
|
709
|
+
|
710
|
+
row_id = "row_id_example" # String | the key for the row
|
711
|
+
|
712
|
+
|
713
|
+
begin
|
714
|
+
#Delete a row entry
|
715
|
+
api_instance.delete_flows_datatable_row(datatable_id, row_id)
|
716
|
+
rescue PureCloud::ApiError => e
|
717
|
+
puts "Exception when calling ArchitectApi->delete_flows_datatable_row: #{e}"
|
718
|
+
end
|
719
|
+
~~~
|
720
|
+
|
721
|
+
### Parameters
|
722
|
+
|
723
|
+
Name | Type | Description | Notes
|
724
|
+
------------- | ------------- | ------------- | -------------
|
725
|
+
**datatable_id** | **String**| id of datatable | |
|
726
|
+
**row_id** | **String**| the key for the row | |
|
727
|
+
{: class="table table-striped"}
|
728
|
+
|
729
|
+
|
730
|
+
### Return type
|
731
|
+
|
732
|
+
nil (empty response body)
|
733
|
+
|
734
|
+
### HTTP request headers
|
735
|
+
|
736
|
+
- **Content-Type**: application/json
|
737
|
+
- **Accept**: application/json
|
738
|
+
|
739
|
+
|
740
|
+
|
612
741
|
<a name="get_architect_dependencytracking"></a>
|
613
742
|
|
614
743
|
## -[**DependencyObjectEntityListing**](DependencyObjectEntityListing.html) get_architect_dependencytracking(name, opts)
|
@@ -2749,6 +2878,258 @@ Name | Type | Description | Notes
|
|
2749
2878
|
|
2750
2879
|
|
2751
2880
|
|
2881
|
+
<a name="get_flows_datatable"></a>
|
2882
|
+
|
2883
|
+
## -[**JsonSchemaDocument**](JsonSchemaDocument.html) get_flows_datatable(datatable_id, opts)
|
2884
|
+
|
2885
|
+
Returns a specific datatable by datatableId
|
2886
|
+
|
2887
|
+
Given a datableid returns the schema associated with it.
|
2888
|
+
|
2889
|
+
Wraps GET /api/v2/flows/datatables/{datatableId}
|
2890
|
+
|
2891
|
+
|
2892
|
+
### Example
|
2893
|
+
~~~ruby
|
2894
|
+
# load the gem
|
2895
|
+
require 'purecloudplatformclientv2'
|
2896
|
+
# setup authorization
|
2897
|
+
@secret = ENV['PURECLOUD_SECRET']
|
2898
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
2899
|
+
environment = "mypurecloud.com"
|
2900
|
+
|
2901
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
2902
|
+
|
2903
|
+
PureCloud.configure do |config|
|
2904
|
+
config.access_token = @authToken
|
2905
|
+
end
|
2906
|
+
|
2907
|
+
api_instance = PureCloud::ArchitectApi.new
|
2908
|
+
|
2909
|
+
datatable_id = "datatable_id_example" # String | id of datatable
|
2910
|
+
|
2911
|
+
opts = {
|
2912
|
+
showbrief: true # BOOLEAN | If true returns a shortened version of the schema including the name, id and description]
|
2913
|
+
}
|
2914
|
+
|
2915
|
+
begin
|
2916
|
+
#Returns a specific datatable by datatableId
|
2917
|
+
result = api_instance.get_flows_datatable(datatable_id, opts)
|
2918
|
+
p result
|
2919
|
+
rescue PureCloud::ApiError => e
|
2920
|
+
puts "Exception when calling ArchitectApi->get_flows_datatable: #{e}"
|
2921
|
+
end
|
2922
|
+
~~~
|
2923
|
+
|
2924
|
+
### Parameters
|
2925
|
+
|
2926
|
+
Name | Type | Description | Notes
|
2927
|
+
------------- | ------------- | ------------- | -------------
|
2928
|
+
**datatable_id** | **String**| id of datatable | |
|
2929
|
+
**showbrief** | **BOOLEAN**| If true returns a shortened version of the schema including the name, id and description] | [optional] [default to true] |
|
2930
|
+
{: class="table table-striped"}
|
2931
|
+
|
2932
|
+
|
2933
|
+
### Return type
|
2934
|
+
|
2935
|
+
[**JsonSchemaDocument**](JsonSchemaDocument.html)
|
2936
|
+
|
2937
|
+
### HTTP request headers
|
2938
|
+
|
2939
|
+
- **Content-Type**: application/json
|
2940
|
+
- **Accept**: application/json
|
2941
|
+
|
2942
|
+
|
2943
|
+
|
2944
|
+
<a name="get_flows_datatable_row"></a>
|
2945
|
+
|
2946
|
+
## -Hash<String, Object>** get_flows_datatable_row(datatable_id, row_id, opts)
|
2947
|
+
|
2948
|
+
Returns a specific row for the datatable
|
2949
|
+
|
2950
|
+
Given a datatable id and a rowId (key) will return the full row contents for that rowId.
|
2951
|
+
|
2952
|
+
Wraps GET /api/v2/flows/datatables/{datatableId}/rows/{rowId}
|
2953
|
+
|
2954
|
+
|
2955
|
+
### Example
|
2956
|
+
~~~ruby
|
2957
|
+
# load the gem
|
2958
|
+
require 'purecloudplatformclientv2'
|
2959
|
+
# setup authorization
|
2960
|
+
@secret = ENV['PURECLOUD_SECRET']
|
2961
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
2962
|
+
environment = "mypurecloud.com"
|
2963
|
+
|
2964
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
2965
|
+
|
2966
|
+
PureCloud.configure do |config|
|
2967
|
+
config.access_token = @authToken
|
2968
|
+
end
|
2969
|
+
|
2970
|
+
api_instance = PureCloud::ArchitectApi.new
|
2971
|
+
|
2972
|
+
datatable_id = "datatable_id_example" # String | id of datatable
|
2973
|
+
|
2974
|
+
row_id = "row_id_example" # String | The key for the row
|
2975
|
+
|
2976
|
+
opts = {
|
2977
|
+
showbrief: true # BOOLEAN | if true returns just the key field for the row
|
2978
|
+
}
|
2979
|
+
|
2980
|
+
begin
|
2981
|
+
#Returns a specific row for the datatable
|
2982
|
+
result = api_instance.get_flows_datatable_row(datatable_id, row_id, opts)
|
2983
|
+
p result
|
2984
|
+
rescue PureCloud::ApiError => e
|
2985
|
+
puts "Exception when calling ArchitectApi->get_flows_datatable_row: #{e}"
|
2986
|
+
end
|
2987
|
+
~~~
|
2988
|
+
|
2989
|
+
### Parameters
|
2990
|
+
|
2991
|
+
Name | Type | Description | Notes
|
2992
|
+
------------- | ------------- | ------------- | -------------
|
2993
|
+
**datatable_id** | **String**| id of datatable | |
|
2994
|
+
**row_id** | **String**| The key for the row | |
|
2995
|
+
**showbrief** | **BOOLEAN**| if true returns just the key field for the row | [optional] [default to true] |
|
2996
|
+
{: class="table table-striped"}
|
2997
|
+
|
2998
|
+
|
2999
|
+
### Return type
|
3000
|
+
|
3001
|
+
**Hash<String, Object>**
|
3002
|
+
|
3003
|
+
### HTTP request headers
|
3004
|
+
|
3005
|
+
- **Content-Type**: application/json
|
3006
|
+
- **Accept**: application/json
|
3007
|
+
|
3008
|
+
|
3009
|
+
|
3010
|
+
<a name="get_flows_datatable_rows"></a>
|
3011
|
+
|
3012
|
+
## -Array<Hash<String, Object>>** get_flows_datatable_rows(datatable_id, opts)
|
3013
|
+
|
3014
|
+
Returns the rows for the datatable
|
3015
|
+
|
3016
|
+
Returns all of the rows for the datatable with the given id. By default this will just be a shortened list returning the key for each row. Set expand to all to return all of the row contents.
|
3017
|
+
|
3018
|
+
Wraps GET /api/v2/flows/datatables/{datatableId}/rows
|
3019
|
+
|
3020
|
+
|
3021
|
+
### Example
|
3022
|
+
~~~ruby
|
3023
|
+
# load the gem
|
3024
|
+
require 'purecloudplatformclientv2'
|
3025
|
+
# setup authorization
|
3026
|
+
@secret = ENV['PURECLOUD_SECRET']
|
3027
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
3028
|
+
environment = "mypurecloud.com"
|
3029
|
+
|
3030
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
3031
|
+
|
3032
|
+
PureCloud.configure do |config|
|
3033
|
+
config.access_token = @authToken
|
3034
|
+
end
|
3035
|
+
|
3036
|
+
api_instance = PureCloud::ArchitectApi.new
|
3037
|
+
|
3038
|
+
datatable_id = "datatable_id_example" # String | id of datatable
|
3039
|
+
|
3040
|
+
opts = {
|
3041
|
+
showbrief: true # BOOLEAN | If true returns just the key value of the row
|
3042
|
+
}
|
3043
|
+
|
3044
|
+
begin
|
3045
|
+
#Returns the rows for the datatable
|
3046
|
+
result = api_instance.get_flows_datatable_rows(datatable_id, opts)
|
3047
|
+
p result
|
3048
|
+
rescue PureCloud::ApiError => e
|
3049
|
+
puts "Exception when calling ArchitectApi->get_flows_datatable_rows: #{e}"
|
3050
|
+
end
|
3051
|
+
~~~
|
3052
|
+
|
3053
|
+
### Parameters
|
3054
|
+
|
3055
|
+
Name | Type | Description | Notes
|
3056
|
+
------------- | ------------- | ------------- | -------------
|
3057
|
+
**datatable_id** | **String**| id of datatable | |
|
3058
|
+
**showbrief** | **BOOLEAN**| If true returns just the key value of the row | [optional] [default to true] |
|
3059
|
+
{: class="table table-striped"}
|
3060
|
+
|
3061
|
+
|
3062
|
+
### Return type
|
3063
|
+
|
3064
|
+
**Array<Hash<String, Object>>**
|
3065
|
+
|
3066
|
+
### HTTP request headers
|
3067
|
+
|
3068
|
+
- **Content-Type**: application/json
|
3069
|
+
- **Accept**: application/json
|
3070
|
+
|
3071
|
+
|
3072
|
+
|
3073
|
+
<a name="get_flows_datatables"></a>
|
3074
|
+
|
3075
|
+
## -[**Array<JsonSchemaDocument>**](JsonSchemaDocument.html) get_flows_datatables(opts)
|
3076
|
+
|
3077
|
+
Retrieve a list of datatables for the org
|
3078
|
+
|
3079
|
+
Returns a metadata list of the datatables associated with this org, including ID, name and description.
|
3080
|
+
|
3081
|
+
Wraps GET /api/v2/flows/datatables
|
3082
|
+
|
3083
|
+
|
3084
|
+
### Example
|
3085
|
+
~~~ruby
|
3086
|
+
# load the gem
|
3087
|
+
require 'purecloudplatformclientv2'
|
3088
|
+
# setup authorization
|
3089
|
+
@secret = ENV['PURECLOUD_SECRET']
|
3090
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
3091
|
+
environment = "mypurecloud.com"
|
3092
|
+
|
3093
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
3094
|
+
|
3095
|
+
PureCloud.configure do |config|
|
3096
|
+
config.access_token = @authToken
|
3097
|
+
end
|
3098
|
+
|
3099
|
+
api_instance = PureCloud::ArchitectApi.new
|
3100
|
+
|
3101
|
+
opts = {
|
3102
|
+
showbrief: true # BOOLEAN | If true, returns a shortened version of the schema including the name, id and description
|
3103
|
+
}
|
3104
|
+
|
3105
|
+
begin
|
3106
|
+
#Retrieve a list of datatables for the org
|
3107
|
+
result = api_instance.get_flows_datatables(opts)
|
3108
|
+
p result
|
3109
|
+
rescue PureCloud::ApiError => e
|
3110
|
+
puts "Exception when calling ArchitectApi->get_flows_datatables: #{e}"
|
3111
|
+
end
|
3112
|
+
~~~
|
3113
|
+
|
3114
|
+
### Parameters
|
3115
|
+
|
3116
|
+
Name | Type | Description | Notes
|
3117
|
+
------------- | ------------- | ------------- | -------------
|
3118
|
+
**showbrief** | **BOOLEAN**| If true, returns a shortened version of the schema including the name, id and description | [optional] [default to true] |
|
3119
|
+
{: class="table table-striped"}
|
3120
|
+
|
3121
|
+
|
3122
|
+
### Return type
|
3123
|
+
|
3124
|
+
[**Array<JsonSchemaDocument>**](JsonSchemaDocument.html)
|
3125
|
+
|
3126
|
+
### HTTP request headers
|
3127
|
+
|
3128
|
+
- **Content-Type**: application/json
|
3129
|
+
- **Accept**: application/json
|
3130
|
+
|
3131
|
+
|
3132
|
+
|
2752
3133
|
<a name="post_architect_dependencytracking_build"></a>
|
2753
3134
|
|
2754
3135
|
## - post_architect_dependencytracking_build
|
@@ -3766,6 +4147,127 @@ Name | Type | Description | Notes
|
|
3766
4147
|
|
3767
4148
|
|
3768
4149
|
|
4150
|
+
<a name="post_flows_datatable_rows"></a>
|
4151
|
+
|
4152
|
+
## -Hash<String, Object>** post_flows_datatable_rows(datatable_id, data_table_row)
|
4153
|
+
|
4154
|
+
Create a new row entry
|
4155
|
+
|
4156
|
+
Will add the passed in row entry to the datatable with the given id after verifying it against the schema.
|
4157
|
+
|
4158
|
+
Wraps POST /api/v2/flows/datatables/{datatableId}/rows
|
4159
|
+
|
4160
|
+
|
4161
|
+
### Example
|
4162
|
+
~~~ruby
|
4163
|
+
# load the gem
|
4164
|
+
require 'purecloudplatformclientv2'
|
4165
|
+
# setup authorization
|
4166
|
+
@secret = ENV['PURECLOUD_SECRET']
|
4167
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
4168
|
+
environment = "mypurecloud.com"
|
4169
|
+
|
4170
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
4171
|
+
|
4172
|
+
PureCloud.configure do |config|
|
4173
|
+
config.access_token = @authToken
|
4174
|
+
end
|
4175
|
+
|
4176
|
+
api_instance = PureCloud::ArchitectApi.new
|
4177
|
+
|
4178
|
+
datatable_id = "datatable_id_example" # String | id of datatable
|
4179
|
+
|
4180
|
+
data_table_row = nil # Object |
|
4181
|
+
|
4182
|
+
|
4183
|
+
begin
|
4184
|
+
#Create a new row entry
|
4185
|
+
result = api_instance.post_flows_datatable_rows(datatable_id, data_table_row)
|
4186
|
+
p result
|
4187
|
+
rescue PureCloud::ApiError => e
|
4188
|
+
puts "Exception when calling ArchitectApi->post_flows_datatable_rows: #{e}"
|
4189
|
+
end
|
4190
|
+
~~~
|
4191
|
+
|
4192
|
+
### Parameters
|
4193
|
+
|
4194
|
+
Name | Type | Description | Notes
|
4195
|
+
------------- | ------------- | ------------- | -------------
|
4196
|
+
**datatable_id** | **String**| id of datatable | |
|
4197
|
+
**data_table_row** | **Object**| | |
|
4198
|
+
{: class="table table-striped"}
|
4199
|
+
|
4200
|
+
|
4201
|
+
### Return type
|
4202
|
+
|
4203
|
+
**Hash<String, Object>**
|
4204
|
+
|
4205
|
+
### HTTP request headers
|
4206
|
+
|
4207
|
+
- **Content-Type**: application/json
|
4208
|
+
- **Accept**: application/json
|
4209
|
+
|
4210
|
+
|
4211
|
+
|
4212
|
+
<a name="post_flows_datatables"></a>
|
4213
|
+
|
4214
|
+
## -[**JsonSchemaDocument**](JsonSchemaDocument.html) post_flows_datatables(body)
|
4215
|
+
|
4216
|
+
Create a new datatable with the specified json-schema definition
|
4217
|
+
|
4218
|
+
This will create a new datatable with fields that match the property definitions in the JSON schema. The name of the table from the title field of the json-schema. See also http://json-schema.org/
|
4219
|
+
|
4220
|
+
Wraps POST /api/v2/flows/datatables
|
4221
|
+
|
4222
|
+
|
4223
|
+
### Example
|
4224
|
+
~~~ruby
|
4225
|
+
# load the gem
|
4226
|
+
require 'purecloudplatformclientv2'
|
4227
|
+
# setup authorization
|
4228
|
+
@secret = ENV['PURECLOUD_SECRET']
|
4229
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
4230
|
+
environment = "mypurecloud.com"
|
4231
|
+
|
4232
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
4233
|
+
|
4234
|
+
PureCloud.configure do |config|
|
4235
|
+
config.access_token = @authToken
|
4236
|
+
end
|
4237
|
+
|
4238
|
+
api_instance = PureCloud::ArchitectApi.new
|
4239
|
+
|
4240
|
+
body = PureCloud::JsonSchemaDocument.new # JsonSchemaDocument | datatable json-schema
|
4241
|
+
|
4242
|
+
|
4243
|
+
begin
|
4244
|
+
#Create a new datatable with the specified json-schema definition
|
4245
|
+
result = api_instance.post_flows_datatables(body)
|
4246
|
+
p result
|
4247
|
+
rescue PureCloud::ApiError => e
|
4248
|
+
puts "Exception when calling ArchitectApi->post_flows_datatables: #{e}"
|
4249
|
+
end
|
4250
|
+
~~~
|
4251
|
+
|
4252
|
+
### Parameters
|
4253
|
+
|
4254
|
+
Name | Type | Description | Notes
|
4255
|
+
------------- | ------------- | ------------- | -------------
|
4256
|
+
**body** | [**JsonSchemaDocument**](JsonSchemaDocument.html)| datatable json-schema | |
|
4257
|
+
{: class="table table-striped"}
|
4258
|
+
|
4259
|
+
|
4260
|
+
### Return type
|
4261
|
+
|
4262
|
+
[**JsonSchemaDocument**](JsonSchemaDocument.html)
|
4263
|
+
|
4264
|
+
### HTTP request headers
|
4265
|
+
|
4266
|
+
- **Content-Type**: application/json
|
4267
|
+
- **Accept**: application/json
|
4268
|
+
|
4269
|
+
|
4270
|
+
|
3769
4271
|
<a name="put_architect_ivr"></a>
|
3770
4272
|
|
3771
4273
|
## -[**IVR**](IVR.html) put_architect_ivr(ivr_id, opts)
|
@@ -4213,3 +4715,134 @@ Name | Type | Description | Notes
|
|
4213
4715
|
|
4214
4716
|
|
4215
4717
|
|
4718
|
+
<a name="put_flows_datatable"></a>
|
4719
|
+
|
4720
|
+
## -[**JsonSchemaDocument**](JsonSchemaDocument.html) put_flows_datatable(datatable_id, opts)
|
4721
|
+
|
4722
|
+
Updates a specific datatable by datatableId
|
4723
|
+
|
4724
|
+
Updates a schema for a datatable with the given datatableId - updates are additive only, no changes or removals of existing fields.
|
4725
|
+
|
4726
|
+
Wraps PUT /api/v2/flows/datatables/{datatableId}
|
4727
|
+
|
4728
|
+
|
4729
|
+
### Example
|
4730
|
+
~~~ruby
|
4731
|
+
# load the gem
|
4732
|
+
require 'purecloudplatformclientv2'
|
4733
|
+
# setup authorization
|
4734
|
+
@secret = ENV['PURECLOUD_SECRET']
|
4735
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
4736
|
+
environment = "mypurecloud.com"
|
4737
|
+
|
4738
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
4739
|
+
|
4740
|
+
PureCloud.configure do |config|
|
4741
|
+
config.access_token = @authToken
|
4742
|
+
end
|
4743
|
+
|
4744
|
+
api_instance = PureCloud::ArchitectApi.new
|
4745
|
+
|
4746
|
+
datatable_id = "datatable_id_example" # String | id of datatable
|
4747
|
+
|
4748
|
+
opts = {
|
4749
|
+
showbrief: true, # BOOLEAN | If true returns a shortened version of the schema including the name, id and description
|
4750
|
+
body: PureCloud::JsonSchemaDocument.new # JsonSchemaDocument | datatable json-schema
|
4751
|
+
}
|
4752
|
+
|
4753
|
+
begin
|
4754
|
+
#Updates a specific datatable by datatableId
|
4755
|
+
result = api_instance.put_flows_datatable(datatable_id, opts)
|
4756
|
+
p result
|
4757
|
+
rescue PureCloud::ApiError => e
|
4758
|
+
puts "Exception when calling ArchitectApi->put_flows_datatable: #{e}"
|
4759
|
+
end
|
4760
|
+
~~~
|
4761
|
+
|
4762
|
+
### Parameters
|
4763
|
+
|
4764
|
+
Name | Type | Description | Notes
|
4765
|
+
------------- | ------------- | ------------- | -------------
|
4766
|
+
**datatable_id** | **String**| id of datatable | |
|
4767
|
+
**showbrief** | **BOOLEAN**| If true returns a shortened version of the schema including the name, id and description | [optional] [default to true] |
|
4768
|
+
**body** | [**JsonSchemaDocument**](JsonSchemaDocument.html)| datatable json-schema | [optional] |
|
4769
|
+
{: class="table table-striped"}
|
4770
|
+
|
4771
|
+
|
4772
|
+
### Return type
|
4773
|
+
|
4774
|
+
[**JsonSchemaDocument**](JsonSchemaDocument.html)
|
4775
|
+
|
4776
|
+
### HTTP request headers
|
4777
|
+
|
4778
|
+
- **Content-Type**: application/json
|
4779
|
+
- **Accept**: application/json
|
4780
|
+
|
4781
|
+
|
4782
|
+
|
4783
|
+
<a name="put_flows_datatable_row"></a>
|
4784
|
+
|
4785
|
+
## -Hash<String, Object>** put_flows_datatable_row(datatable_id, row_id, opts)
|
4786
|
+
|
4787
|
+
Update a row entry
|
4788
|
+
|
4789
|
+
Updates a row with the given to the new values.
|
4790
|
+
|
4791
|
+
Wraps PUT /api/v2/flows/datatables/{datatableId}/rows/{rowId}
|
4792
|
+
|
4793
|
+
|
4794
|
+
### Example
|
4795
|
+
~~~ruby
|
4796
|
+
# load the gem
|
4797
|
+
require 'purecloudplatformclientv2'
|
4798
|
+
# setup authorization
|
4799
|
+
@secret = ENV['PURECLOUD_SECRET']
|
4800
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
4801
|
+
environment = "mypurecloud.com"
|
4802
|
+
|
4803
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
4804
|
+
|
4805
|
+
PureCloud.configure do |config|
|
4806
|
+
config.access_token = @authToken
|
4807
|
+
end
|
4808
|
+
|
4809
|
+
api_instance = PureCloud::ArchitectApi.new
|
4810
|
+
|
4811
|
+
datatable_id = "datatable_id_example" # String | id of datatable
|
4812
|
+
|
4813
|
+
row_id = "row_id_example" # String | the key for the row
|
4814
|
+
|
4815
|
+
opts = {
|
4816
|
+
body: nil # Object | datatable row
|
4817
|
+
}
|
4818
|
+
|
4819
|
+
begin
|
4820
|
+
#Update a row entry
|
4821
|
+
result = api_instance.put_flows_datatable_row(datatable_id, row_id, opts)
|
4822
|
+
p result
|
4823
|
+
rescue PureCloud::ApiError => e
|
4824
|
+
puts "Exception when calling ArchitectApi->put_flows_datatable_row: #{e}"
|
4825
|
+
end
|
4826
|
+
~~~
|
4827
|
+
|
4828
|
+
### Parameters
|
4829
|
+
|
4830
|
+
Name | Type | Description | Notes
|
4831
|
+
------------- | ------------- | ------------- | -------------
|
4832
|
+
**datatable_id** | **String**| id of datatable | |
|
4833
|
+
**row_id** | **String**| the key for the row | |
|
4834
|
+
**body** | **Object**| datatable row | [optional] |
|
4835
|
+
{: class="table table-striped"}
|
4836
|
+
|
4837
|
+
|
4838
|
+
### Return type
|
4839
|
+
|
4840
|
+
**Hash<String, Object>**
|
4841
|
+
|
4842
|
+
### HTTP request headers
|
4843
|
+
|
4844
|
+
- **Content-Type**: application/json
|
4845
|
+
- **Accept**: application/json
|
4846
|
+
|
4847
|
+
|
4848
|
+
|