purecloudplatformclientv2 13.1.0 → 14.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/AgentActivityEntityListing.md +2 -2
- data/docs/ArchitectApi.md +966 -33
- data/docs/AttemptLimitsEntityListing.md +2 -2
- data/docs/AttributeEntityListing.md +2 -2
- data/docs/AuditQueryResponse.md +12 -0
- data/docs/AuthorizationApi.md +2 -0
- data/docs/CalibrationEntityListing.md +2 -2
- data/docs/Call.md +1 -0
- data/docs/CallBasic.md +1 -0
- data/docs/CallConversationEntityListing.md +2 -2
- data/docs/CallableTimeSetEntityListing.md +2 -2
- data/docs/CallbackConversationEntityListing.md +2 -2
- data/docs/CampaignEntityListing.md +2 -2
- data/docs/CampaignRuleEntityListing.md +2 -2
- data/docs/CampaignSequenceEntityListing.md +2 -2
- data/docs/CertificateAuthorityEntityListing.md +2 -2
- data/docs/ChatConversationEntityListing.md +2 -2
- data/docs/CobrowseConversationEntityListing.md +2 -2
- data/docs/CommandStatusEntityListing.md +2 -2
- data/docs/ConsumedResourcesEntityListing.md +2 -2
- data/docs/ConsumingResourcesEntityListing.md +2 -2
- data/docs/ContactListEntityListing.md +2 -2
- data/docs/ContactListFilterEntityListing.md +2 -2
- data/docs/ContactListing.md +2 -2
- data/docs/ConversationChat.md +1 -0
- data/docs/ConversationEntityListing.md +2 -2
- data/docs/ConversationsApi.md +71 -2
- data/docs/CreateCallbackOnConversationCommand.md +20 -0
- data/docs/DIDEntityListing.md +2 -2
- data/docs/DIDPoolEntityListing.md +2 -2
- data/docs/DependencyObjectEntityListing.md +2 -2
- data/docs/DependencyTypeEntityListing.md +2 -2
- data/docs/DialerEventEntityListing.md +2 -2
- data/docs/DncListEntityListing.md +2 -2
- data/docs/DocumentAuditEntityListing.md +2 -2
- data/docs/DocumentEntityListing.md +2 -2
- data/docs/DocumentationSearchRequest.md +1 -0
- data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +2 -2
- data/docs/DomainEntityListing.md +2 -2
- data/docs/DomainEntityListingEvaluationForm.md +2 -2
- data/docs/DomainEntityListingQueryResult.md +2 -2
- data/docs/EdgeEntityListing.md +2 -2
- data/docs/EdgeGroupEntityListing.md +2 -2
- data/docs/EdgeLineEntityListing.md +2 -2
- data/docs/Email.md +2 -0
- data/docs/EmailConversationEntityListing.md +2 -2
- data/docs/EmailMessageListing.md +2 -2
- data/docs/EncryptionKeyEntityListing.md +2 -2
- data/docs/EndpointEntityListing.md +2 -2
- data/docs/EvaluationEntityListing.md +2 -2
- data/docs/EvaluationFormEntityListing.md +2 -2
- data/docs/EvaluatorActivityEntityListing.md +2 -2
- data/docs/ExtensionEntityListing.md +2 -2
- data/docs/ExtensionPoolEntityListing.md +2 -2
- data/docs/ExternalContactsApi.md +2 -2
- data/docs/ExternalOrganizationListing.md +2 -2
- data/docs/Facet.md +14 -0
- data/docs/FaxDocumentEntityListing.md +2 -2
- data/docs/Filter.md +16 -0
- data/docs/FlowEntityListing.md +2 -2
- data/docs/FlowVersionEntityListing.md +2 -2
- data/docs/GreetingListing.md +2 -2
- data/docs/GroupEntityListing.md +2 -2
- data/docs/GroupSearchRequest.md +1 -0
- data/docs/HistoryListing.md +10 -5
- data/docs/IVR.md +28 -0
- data/docs/IVREntityListing.md +22 -0
- data/docs/InboundDomainEntityListing.md +2 -2
- data/docs/InboundRouteEntityListing.md +2 -2
- data/docs/InteractionStatsAlertContainer.md +2 -2
- data/docs/InteractionStatsRuleContainer.md +2 -2
- data/docs/KeywordSetEntityListing.md +2 -2
- data/docs/LanguageEntityListing.md +2 -2
- data/docs/LibraryEntityListing.md +2 -2
- data/docs/LineBaseEntityListing.md +2 -2
- data/docs/LineEntityListing.md +2 -2
- data/docs/LocationEntityListing.md +2 -2
- data/docs/LocationSearchRequest.md +1 -0
- data/docs/LogicalInterfaceEntityListing.md +2 -2
- data/docs/NoteListing.md +2 -2
- data/docs/OAuthClientEntityListing.md +2 -2
- data/docs/OAuthProviderEntityListing.md +2 -2
- data/docs/OrganizationAuthorizationApi.md +1458 -0
- data/docs/OrganizationPresenceEntityListing.md +2 -2
- data/docs/OrganizationRoleEntityListing.md +2 -2
- data/docs/OrphanRecordingListing.md +2 -2
- data/docs/OutboundRouteBaseEntityListing.md +2 -2
- data/docs/OutboundRouteEntityListing.md +2 -2
- data/docs/Participant.md +1 -0
- data/docs/ParticipantBasic.md +1 -0
- data/docs/PermissionCollectionEntityListing.md +2 -2
- data/docs/PhoneBaseEntityListing.md +2 -2
- data/docs/PhoneEntityListing.md +2 -2
- data/docs/PhoneMetaBaseEntityListing.md +2 -2
- data/docs/PhysicalInterfaceEntityListing.md +2 -2
- data/docs/PolicyEntityListing.md +2 -2
- data/docs/PromptAssetEntityListing.md +2 -2
- data/docs/PromptEntityListing.md +2 -2
- data/docs/QualityAuditPage.md +2 -2
- data/docs/QueueEntityListing.md +2 -2
- data/docs/QueueMemberEntityListing.md +2 -2
- data/docs/RelationshipListing.md +2 -2
- data/docs/ReportMetaDataEntityListing.md +2 -2
- data/docs/ReportRunEntryEntityDomainListing.md +2 -2
- data/docs/ReportScheduleEntityListing.md +2 -2
- data/docs/ResponseEntityList.md +2 -2
- data/docs/ResponseEntityListing.md +2 -2
- data/docs/ResponseSetEntityListing.md +2 -2
- data/docs/RoutingApi.md +1 -1
- data/docs/RuleSetEntityListing.md +2 -2
- data/docs/Schedule.md +27 -0
- data/docs/ScheduleEntityListing.md +22 -0
- data/docs/ScheduleGroup.md +27 -0
- data/docs/ScheduleGroupEntityListing.md +22 -0
- data/docs/SchemaCategoryEntityListing.md +2 -2
- data/docs/SchemaReferenceEntityListing.md +2 -2
- data/docs/ScreenRecordingSession.md +1 -1
- data/docs/ScreenRecordingSessionListing.md +2 -2
- data/docs/ScriptEntityListing.md +2 -2
- data/docs/SearchRequest.md +1 -0
- data/docs/SearchSort.md +14 -0
- data/docs/SecurityProfileEntityListing.md +2 -2
- data/docs/SetUuiDataRequest.md +13 -0
- data/docs/ShareEntityListing.md +2 -2
- data/docs/SiteEntityListing.md +2 -2
- data/docs/SkillEntityListing.md +2 -2
- data/docs/SocialExpression.md +1 -0
- data/docs/StationEntityListing.md +2 -2
- data/docs/SystemPromptAssetEntityListing.md +2 -2
- data/docs/SystemPromptEntityListing.md +2 -2
- data/docs/TagValueEntityListing.md +2 -2
- data/docs/TimeZoneEntityListing.md +2 -2
- data/docs/TrunkBaseEntityListing.md +2 -2
- data/docs/TrunkEntityListing.md +2 -2
- data/docs/TrunkMetabaseEntityListing.md +2 -2
- data/docs/TrustCreate.md +15 -0
- data/docs/TrustEntityListing.md +22 -0
- data/docs/TrustRequest.md +18 -0
- data/docs/TrustRequestCreate.md +13 -0
- data/docs/TrustUser.md +36 -0
- data/docs/TrustUserCreate.md +14 -0
- data/docs/TrustUserDetails.md +14 -0
- data/docs/TrustUserEntityListing.md +22 -0
- data/docs/Trustee.md +18 -0
- data/docs/TrusteeAuditQueryRequest.md +19 -0
- data/docs/TrustorAuditQueryRequest.md +19 -0
- data/docs/TrustorEntityListing.md +22 -0
- data/docs/UserEntityListing.md +2 -2
- data/docs/UserMe.md +1 -0
- data/docs/UserQueueEntityListing.md +2 -2
- data/docs/UserRecordingEntityListing.md +2 -2
- data/docs/UserSearchRequest.md +1 -0
- data/docs/UserSkillEntityListing.md +2 -2
- data/docs/UsersApi.md +1 -1
- data/docs/VoicemailMessageEntityListing.md +2 -2
- data/docs/VoicemailSearchRequest.md +1 -0
- data/docs/WorkspaceEntityListing.md +2 -2
- data/docs/WorkspaceMemberEntityListing.md +2 -2
- data/docs/WrapupCodeEntityListing.md +2 -2
- data/lib/purecloudplatformclientv2.rb +25 -1
- data/lib/purecloudplatformclientv2/api/architect_api.rb +1216 -148
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +9 -0
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +97 -2
- data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api/organization_authorization_api.rb +1751 -0
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/attribute_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/audit_query_response.rb +176 -0
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/call.rb +30 -4
- data/lib/purecloudplatformclientv2/models/call_basic.rb +30 -4
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/campaign.rb +15 -1
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/conversation_chat.rb +27 -1
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/create_callback_on_conversation_command.rb +393 -0
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/documentation_search_request.rb +29 -1
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +25 -25
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +25 -25
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/email.rb +56 -4
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/endpoint_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/facet.rb +238 -0
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/filter.rb +302 -0
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/group_search_request.rb +29 -1
- data/lib/purecloudplatformclientv2/models/history_listing.rb +197 -38
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +25 -25
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +25 -25
- data/lib/purecloudplatformclientv2/models/ivr.rb +607 -0
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/location_search_request.rb +29 -1
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/note_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/participant.rb +44 -4
- data/lib/purecloudplatformclientv2/models/participant_basic.rb +44 -4
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +25 -25
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/reaction.rb +2 -2
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +25 -25
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/schedule.rb +578 -0
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/schedule_group.rb +577 -0
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/screen_recording_session.rb +8 -8
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/search_request.rb +29 -1
- data/lib/purecloudplatformclientv2/models/search_sort.rb +242 -0
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/set_uui_data_request.rb +202 -0
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/social_expression.rb +27 -1
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/trust_create.rb +271 -0
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/trust_request.rb +344 -0
- data/lib/purecloudplatformclientv2/models/trust_request_create.rb +209 -0
- data/lib/purecloudplatformclientv2/models/trust_user.rb +822 -0
- data/lib/purecloudplatformclientv2/models/trust_user_create.rb +240 -0
- data/lib/purecloudplatformclientv2/models/trust_user_details.rb +228 -0
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/{history_entry.rb → trustee.rb} +66 -46
- data/lib/purecloudplatformclientv2/models/trustee_audit_query_request.rb +376 -0
- data/lib/purecloudplatformclientv2/models/trustor_audit_query_request.rb +374 -0
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/user_me.rb +29 -1
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/user_search_request.rb +29 -1
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/voicemail_search_request.rb +29 -1
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +25 -25
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +52 -4
- data/docs/HistoryEntry.md +0 -17
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b14a3081eaec15589a6376100176c3e45cb9437d
|
4
|
+
data.tar.gz: c0a012e0b722abda8369b7ae2ee095e8a1d60be2
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c31dee8c96939a6183ee1c7fa88ce05ead884c8026f98d202d1c688103cd78401e818a018dd8621e31f7fb58b14fbf79a5c85be213b096036f4e606b56c82cb2
|
7
|
+
data.tar.gz: 887368fd459d1dfef889b1aef3d723d2c6edc6234a0996918f1a21dae0e858835a71886553867e44a115a4d519337810af6ed195d550f8a803f40bb3b96f1027
|
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=14.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', '~> 14.0.0'
|
14
14
|
~~~
|
15
15
|
|
16
16
|
### Install from Git
|
@@ -11,11 +11,11 @@ title: AgentActivityEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
+
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
14
16
|
| **previous_uri** | **String** | | [optional] |
|
15
17
|
| **next_uri** | **String** | | [optional] |
|
16
18
|
| **last_uri** | **String** | | [optional] |
|
17
|
-
| **self_uri** | **String** | | [optional] |
|
18
|
-
| **first_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/docs/ArchitectApi.md
CHANGED
@@ -8,9 +8,12 @@ All URIs are relative to *https://api.mypurecloud.com*
|
|
8
8
|
|
9
9
|
Method | Description
|
10
10
|
------------- | ------------- | -------------
|
11
|
+
[**delete_architect_ivr**](ArchitectApi.html#delete_architect_ivr) | Delete an IVR Config.
|
11
12
|
[**delete_architect_prompt**](ArchitectApi.html#delete_architect_prompt) | Delete specified user prompt
|
12
13
|
[**delete_architect_prompt_resource**](ArchitectApi.html#delete_architect_prompt_resource) | Delete specified user prompt resource
|
13
14
|
[**delete_architect_prompts**](ArchitectApi.html#delete_architect_prompts) | Batch-delete a list of prompts
|
15
|
+
[**delete_architect_schedule**](ArchitectApi.html#delete_architect_schedule) | Delete a schedule by id
|
16
|
+
[**delete_architect_schedulegroup**](ArchitectApi.html#delete_architect_schedulegroup) | Deletes a schedule group by ID
|
14
17
|
[**delete_architect_systemprompt_resource**](ArchitectApi.html#delete_architect_systemprompt_resource) | Delete a system prompt resource override.
|
15
18
|
[**delete_flow**](ArchitectApi.html#delete_flow) | Delete flow
|
16
19
|
[**delete_flows**](ArchitectApi.html#delete_flows) | Batch-delete a list of flows
|
@@ -23,10 +26,16 @@ Method | Description
|
|
23
26
|
[**get_architect_dependencytracking_type**](ArchitectApi.html#get_architect_dependencytracking_type) | Get a Dependency Tracking type.
|
24
27
|
[**get_architect_dependencytracking_types**](ArchitectApi.html#get_architect_dependencytracking_types) | Get Dependency Tracking types.
|
25
28
|
[**get_architect_dependencytracking_updatedresourceconsumers**](ArchitectApi.html#get_architect_dependencytracking_updatedresourceconsumers) | Get Dependency Tracking objects that depend on updated resources
|
29
|
+
[**get_architect_ivr**](ArchitectApi.html#get_architect_ivr) | Get an IVR config.
|
30
|
+
[**get_architect_ivrs**](ArchitectApi.html#get_architect_ivrs) | Get IVR configs.
|
26
31
|
[**get_architect_prompt**](ArchitectApi.html#get_architect_prompt) | Get specified user prompt
|
27
32
|
[**get_architect_prompt_resource**](ArchitectApi.html#get_architect_prompt_resource) | Get specified user prompt resource
|
28
33
|
[**get_architect_prompt_resources**](ArchitectApi.html#get_architect_prompt_resources) | Get a pageable list of user prompt resources
|
29
34
|
[**get_architect_prompts**](ArchitectApi.html#get_architect_prompts) | Get a pageable list of user prompts
|
35
|
+
[**get_architect_schedule**](ArchitectApi.html#get_architect_schedule) | Get a schedule by ID
|
36
|
+
[**get_architect_schedulegroup**](ArchitectApi.html#get_architect_schedulegroup) | Gets a schedule group by ID
|
37
|
+
[**get_architect_schedulegroups**](ArchitectApi.html#get_architect_schedulegroups) | Get a list of schedule groups.
|
38
|
+
[**get_architect_schedules**](ArchitectApi.html#get_architect_schedules) | Get a list of schedules.
|
30
39
|
[**get_architect_systemprompt**](ArchitectApi.html#get_architect_systemprompt) | Get a system prompt
|
31
40
|
[**get_architect_systemprompt_resource**](ArchitectApi.html#get_architect_systemprompt_resource) | Get a system prompt resource.
|
32
41
|
[**get_architect_systemprompt_resources**](ArchitectApi.html#get_architect_systemprompt_resources) | Get system prompt resources.
|
@@ -39,8 +48,11 @@ Method | Description
|
|
39
48
|
[**get_flow_versions**](ArchitectApi.html#get_flow_versions) | Get flow version list
|
40
49
|
[**get_flows**](ArchitectApi.html#get_flows) | Get a pageable list of flows, filtered by query parameters
|
41
50
|
[**post_architect_dependencytracking_build**](ArchitectApi.html#post_architect_dependencytracking_build) | Rebuild Dependency Tracking data for an organization
|
51
|
+
[**post_architect_ivrs**](ArchitectApi.html#post_architect_ivrs) | Create IVR config.
|
42
52
|
[**post_architect_prompt_resources**](ArchitectApi.html#post_architect_prompt_resources) | Create a new user prompt resource
|
43
53
|
[**post_architect_prompts**](ArchitectApi.html#post_architect_prompts) | Create a new user prompt
|
54
|
+
[**post_architect_schedulegroups**](ArchitectApi.html#post_architect_schedulegroups) | Creates a new schedule group
|
55
|
+
[**post_architect_schedules**](ArchitectApi.html#post_architect_schedules) | Create a new schedule.
|
44
56
|
[**post_architect_systemprompt_resources**](ArchitectApi.html#post_architect_systemprompt_resources) | Create system prompt resource override.
|
45
57
|
[**post_flow_versions**](ArchitectApi.html#post_flow_versions) | Create flow version
|
46
58
|
[**post_flows**](ArchitectApi.html#post_flows) | Create flow
|
@@ -50,12 +62,73 @@ Method | Description
|
|
50
62
|
[**post_flows_actions_publish**](ArchitectApi.html#post_flows_actions_publish) | Publish flow
|
51
63
|
[**post_flows_actions_revert**](ArchitectApi.html#post_flows_actions_revert) | Revert flow
|
52
64
|
[**post_flows_actions_unlock**](ArchitectApi.html#post_flows_actions_unlock) | Unlock flow
|
65
|
+
[**put_architect_ivr**](ArchitectApi.html#put_architect_ivr) | Update an IVR Config.
|
53
66
|
[**put_architect_prompt**](ArchitectApi.html#put_architect_prompt) | Update specified user prompt
|
54
67
|
[**put_architect_prompt_resource**](ArchitectApi.html#put_architect_prompt_resource) | Update specified user prompt resource
|
68
|
+
[**put_architect_schedule**](ArchitectApi.html#put_architect_schedule) | Update schedule by ID
|
69
|
+
[**put_architect_schedulegroup**](ArchitectApi.html#put_architect_schedulegroup) | Updates a schedule group by ID
|
55
70
|
[**put_architect_systemprompt_resource**](ArchitectApi.html#put_architect_systemprompt_resource) | Updates a system prompt resource override.
|
56
71
|
[**put_flow**](ArchitectApi.html#put_flow) | Update flow
|
57
72
|
{: class="table table-striped"}
|
58
73
|
|
74
|
+
<a name="delete_architect_ivr"></a>
|
75
|
+
|
76
|
+
## - delete_architect_ivr(ivr_id)
|
77
|
+
|
78
|
+
Delete an IVR Config.
|
79
|
+
|
80
|
+
|
81
|
+
|
82
|
+
Wraps DELETE /api/v2/architect/ivrs/{ivrId}
|
83
|
+
|
84
|
+
|
85
|
+
### Example
|
86
|
+
~~~ruby
|
87
|
+
# load the gem
|
88
|
+
require 'purecloudplatformclientv2'
|
89
|
+
# setup authorization
|
90
|
+
@secret = ENV['PURECLOUD_SECRET']
|
91
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
92
|
+
environment = "mypurecloud.com"
|
93
|
+
|
94
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
95
|
+
|
96
|
+
PureCloud.configure do |config|
|
97
|
+
config.access_token = @authToken
|
98
|
+
end
|
99
|
+
|
100
|
+
api_instance = PureCloud::ArchitectApi.new
|
101
|
+
|
102
|
+
ivr_id = "ivr_id_example" # String | IVR id
|
103
|
+
|
104
|
+
|
105
|
+
begin
|
106
|
+
#Delete an IVR Config.
|
107
|
+
api_instance.delete_architect_ivr(ivr_id)
|
108
|
+
rescue PureCloud::ApiError => e
|
109
|
+
puts "Exception when calling ArchitectApi->delete_architect_ivr: #{e}"
|
110
|
+
end
|
111
|
+
~~~
|
112
|
+
|
113
|
+
### Parameters
|
114
|
+
|
115
|
+
Name | Type | Description | Notes
|
116
|
+
------------- | ------------- | ------------- | -------------
|
117
|
+
**ivr_id** | **String**| IVR id | |
|
118
|
+
{: class="table table-striped"}
|
119
|
+
|
120
|
+
|
121
|
+
### Return type
|
122
|
+
|
123
|
+
nil (empty response body)
|
124
|
+
|
125
|
+
### HTTP request headers
|
126
|
+
|
127
|
+
- **Content-Type**: application/json
|
128
|
+
- **Accept**: application/json
|
129
|
+
|
130
|
+
|
131
|
+
|
59
132
|
<a name="delete_architect_prompt"></a>
|
60
133
|
|
61
134
|
## - delete_architect_prompt(prompt_id, opts)
|
@@ -238,6 +311,122 @@ Name | Type | Description | Notes
|
|
238
311
|
|
239
312
|
|
240
313
|
|
314
|
+
<a name="delete_architect_schedule"></a>
|
315
|
+
|
316
|
+
## - delete_architect_schedule(schedule_id)
|
317
|
+
|
318
|
+
Delete a schedule by id
|
319
|
+
|
320
|
+
|
321
|
+
|
322
|
+
Wraps DELETE /api/v2/architect/schedules/{scheduleId}
|
323
|
+
|
324
|
+
|
325
|
+
### Example
|
326
|
+
~~~ruby
|
327
|
+
# load the gem
|
328
|
+
require 'purecloudplatformclientv2'
|
329
|
+
# setup authorization
|
330
|
+
@secret = ENV['PURECLOUD_SECRET']
|
331
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
332
|
+
environment = "mypurecloud.com"
|
333
|
+
|
334
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
335
|
+
|
336
|
+
PureCloud.configure do |config|
|
337
|
+
config.access_token = @authToken
|
338
|
+
end
|
339
|
+
|
340
|
+
api_instance = PureCloud::ArchitectApi.new
|
341
|
+
|
342
|
+
schedule_id = "schedule_id_example" # String | Schedule ID
|
343
|
+
|
344
|
+
|
345
|
+
begin
|
346
|
+
#Delete a schedule by id
|
347
|
+
api_instance.delete_architect_schedule(schedule_id)
|
348
|
+
rescue PureCloud::ApiError => e
|
349
|
+
puts "Exception when calling ArchitectApi->delete_architect_schedule: #{e}"
|
350
|
+
end
|
351
|
+
~~~
|
352
|
+
|
353
|
+
### Parameters
|
354
|
+
|
355
|
+
Name | Type | Description | Notes
|
356
|
+
------------- | ------------- | ------------- | -------------
|
357
|
+
**schedule_id** | **String**| Schedule ID | |
|
358
|
+
{: class="table table-striped"}
|
359
|
+
|
360
|
+
|
361
|
+
### Return type
|
362
|
+
|
363
|
+
nil (empty response body)
|
364
|
+
|
365
|
+
### HTTP request headers
|
366
|
+
|
367
|
+
- **Content-Type**: application/json
|
368
|
+
- **Accept**: application/json
|
369
|
+
|
370
|
+
|
371
|
+
|
372
|
+
<a name="delete_architect_schedulegroup"></a>
|
373
|
+
|
374
|
+
## - delete_architect_schedulegroup(schedule_group_id)
|
375
|
+
|
376
|
+
Deletes a schedule group by ID
|
377
|
+
|
378
|
+
|
379
|
+
|
380
|
+
Wraps DELETE /api/v2/architect/schedulegroups/{scheduleGroupId}
|
381
|
+
|
382
|
+
|
383
|
+
### Example
|
384
|
+
~~~ruby
|
385
|
+
# load the gem
|
386
|
+
require 'purecloudplatformclientv2'
|
387
|
+
# setup authorization
|
388
|
+
@secret = ENV['PURECLOUD_SECRET']
|
389
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
390
|
+
environment = "mypurecloud.com"
|
391
|
+
|
392
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
393
|
+
|
394
|
+
PureCloud.configure do |config|
|
395
|
+
config.access_token = @authToken
|
396
|
+
end
|
397
|
+
|
398
|
+
api_instance = PureCloud::ArchitectApi.new
|
399
|
+
|
400
|
+
schedule_group_id = "schedule_group_id_example" # String | Schedule group ID
|
401
|
+
|
402
|
+
|
403
|
+
begin
|
404
|
+
#Deletes a schedule group by ID
|
405
|
+
api_instance.delete_architect_schedulegroup(schedule_group_id)
|
406
|
+
rescue PureCloud::ApiError => e
|
407
|
+
puts "Exception when calling ArchitectApi->delete_architect_schedulegroup: #{e}"
|
408
|
+
end
|
409
|
+
~~~
|
410
|
+
|
411
|
+
### Parameters
|
412
|
+
|
413
|
+
Name | Type | Description | Notes
|
414
|
+
------------- | ------------- | ------------- | -------------
|
415
|
+
**schedule_group_id** | **String**| Schedule group ID | |
|
416
|
+
{: class="table table-striped"}
|
417
|
+
|
418
|
+
|
419
|
+
### Return type
|
420
|
+
|
421
|
+
nil (empty response body)
|
422
|
+
|
423
|
+
### HTTP request headers
|
424
|
+
|
425
|
+
- **Content-Type**: application/json
|
426
|
+
- **Accept**: application/json
|
427
|
+
|
428
|
+
|
429
|
+
|
241
430
|
<a name="delete_architect_systemprompt_resource"></a>
|
242
431
|
|
243
432
|
## - delete_architect_systemprompt_resource(prompt_id, language_code)
|
@@ -1015,6 +1204,131 @@ Name | Type | Description | Notes
|
|
1015
1204
|
|
1016
1205
|
|
1017
1206
|
|
1207
|
+
<a name="get_architect_ivr"></a>
|
1208
|
+
|
1209
|
+
## -[**IVR**](IVR.html) get_architect_ivr(ivr_id)
|
1210
|
+
|
1211
|
+
Get an IVR config.
|
1212
|
+
|
1213
|
+
|
1214
|
+
|
1215
|
+
Wraps GET /api/v2/architect/ivrs/{ivrId}
|
1216
|
+
|
1217
|
+
|
1218
|
+
### Example
|
1219
|
+
~~~ruby
|
1220
|
+
# load the gem
|
1221
|
+
require 'purecloudplatformclientv2'
|
1222
|
+
# setup authorization
|
1223
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1224
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1225
|
+
environment = "mypurecloud.com"
|
1226
|
+
|
1227
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1228
|
+
|
1229
|
+
PureCloud.configure do |config|
|
1230
|
+
config.access_token = @authToken
|
1231
|
+
end
|
1232
|
+
|
1233
|
+
api_instance = PureCloud::ArchitectApi.new
|
1234
|
+
|
1235
|
+
ivr_id = "ivr_id_example" # String | IVR id
|
1236
|
+
|
1237
|
+
|
1238
|
+
begin
|
1239
|
+
#Get an IVR config.
|
1240
|
+
result = api_instance.get_architect_ivr(ivr_id)
|
1241
|
+
p result
|
1242
|
+
rescue PureCloud::ApiError => e
|
1243
|
+
puts "Exception when calling ArchitectApi->get_architect_ivr: #{e}"
|
1244
|
+
end
|
1245
|
+
~~~
|
1246
|
+
|
1247
|
+
### Parameters
|
1248
|
+
|
1249
|
+
Name | Type | Description | Notes
|
1250
|
+
------------- | ------------- | ------------- | -------------
|
1251
|
+
**ivr_id** | **String**| IVR id | |
|
1252
|
+
{: class="table table-striped"}
|
1253
|
+
|
1254
|
+
|
1255
|
+
### Return type
|
1256
|
+
|
1257
|
+
[**IVR**](IVR.html)
|
1258
|
+
|
1259
|
+
### HTTP request headers
|
1260
|
+
|
1261
|
+
- **Content-Type**: application/json
|
1262
|
+
- **Accept**: application/json
|
1263
|
+
|
1264
|
+
|
1265
|
+
|
1266
|
+
<a name="get_architect_ivrs"></a>
|
1267
|
+
|
1268
|
+
## -[**IVREntityListing**](IVREntityListing.html) get_architect_ivrs(opts)
|
1269
|
+
|
1270
|
+
Get IVR configs.
|
1271
|
+
|
1272
|
+
|
1273
|
+
|
1274
|
+
Wraps GET /api/v2/architect/ivrs
|
1275
|
+
|
1276
|
+
|
1277
|
+
### Example
|
1278
|
+
~~~ruby
|
1279
|
+
# load the gem
|
1280
|
+
require 'purecloudplatformclientv2'
|
1281
|
+
# setup authorization
|
1282
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1283
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1284
|
+
environment = "mypurecloud.com"
|
1285
|
+
|
1286
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1287
|
+
|
1288
|
+
PureCloud.configure do |config|
|
1289
|
+
config.access_token = @authToken
|
1290
|
+
end
|
1291
|
+
|
1292
|
+
api_instance = PureCloud::ArchitectApi.new
|
1293
|
+
|
1294
|
+
opts = {
|
1295
|
+
page_number: 1, # Integer | Page number
|
1296
|
+
page_size: 25, # Integer | Page size
|
1297
|
+
sort_by: "name", # String | Sort by
|
1298
|
+
sort_order: "ASC" # String | Sort order
|
1299
|
+
}
|
1300
|
+
|
1301
|
+
begin
|
1302
|
+
#Get IVR configs.
|
1303
|
+
result = api_instance.get_architect_ivrs(opts)
|
1304
|
+
p result
|
1305
|
+
rescue PureCloud::ApiError => e
|
1306
|
+
puts "Exception when calling ArchitectApi->get_architect_ivrs: #{e}"
|
1307
|
+
end
|
1308
|
+
~~~
|
1309
|
+
|
1310
|
+
### Parameters
|
1311
|
+
|
1312
|
+
Name | Type | Description | Notes
|
1313
|
+
------------- | ------------- | ------------- | -------------
|
1314
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
1315
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
1316
|
+
**sort_by** | **String**| Sort by | [optional] [default to name] |
|
1317
|
+
**sort_order** | **String**| Sort order | [optional] [default to ASC] |
|
1318
|
+
{: class="table table-striped"}
|
1319
|
+
|
1320
|
+
|
1321
|
+
### Return type
|
1322
|
+
|
1323
|
+
[**IVREntityListing**](IVREntityListing.html)
|
1324
|
+
|
1325
|
+
### HTTP request headers
|
1326
|
+
|
1327
|
+
- **Content-Type**: application/json
|
1328
|
+
- **Accept**: application/json
|
1329
|
+
|
1330
|
+
|
1331
|
+
|
1018
1332
|
<a name="get_architect_prompt"></a>
|
1019
1333
|
|
1020
1334
|
## -[**Prompt**](Prompt.html) get_architect_prompt(prompt_id)
|
@@ -1269,15 +1583,15 @@ Name | Type | Description | Notes
|
|
1269
1583
|
|
1270
1584
|
|
1271
1585
|
|
1272
|
-
<a name="
|
1586
|
+
<a name="get_architect_schedule"></a>
|
1273
1587
|
|
1274
|
-
## -[**
|
1588
|
+
## -[**Schedule**](Schedule.html) get_architect_schedule(schedule_id)
|
1275
1589
|
|
1276
|
-
Get a
|
1590
|
+
Get a schedule by ID
|
1277
1591
|
|
1278
1592
|
|
1279
1593
|
|
1280
|
-
Wraps GET /api/v2/architect/
|
1594
|
+
Wraps GET /api/v2/architect/schedules/{scheduleId}
|
1281
1595
|
|
1282
1596
|
|
1283
1597
|
### Example
|
@@ -1297,11 +1611,261 @@ end
|
|
1297
1611
|
|
1298
1612
|
api_instance = PureCloud::ArchitectApi.new
|
1299
1613
|
|
1300
|
-
|
1614
|
+
schedule_id = "schedule_id_example" # String | Schedule ID
|
1301
1615
|
|
1302
1616
|
|
1303
1617
|
begin
|
1304
|
-
#Get a
|
1618
|
+
#Get a schedule by ID
|
1619
|
+
result = api_instance.get_architect_schedule(schedule_id)
|
1620
|
+
p result
|
1621
|
+
rescue PureCloud::ApiError => e
|
1622
|
+
puts "Exception when calling ArchitectApi->get_architect_schedule: #{e}"
|
1623
|
+
end
|
1624
|
+
~~~
|
1625
|
+
|
1626
|
+
### Parameters
|
1627
|
+
|
1628
|
+
Name | Type | Description | Notes
|
1629
|
+
------------- | ------------- | ------------- | -------------
|
1630
|
+
**schedule_id** | **String**| Schedule ID | |
|
1631
|
+
{: class="table table-striped"}
|
1632
|
+
|
1633
|
+
|
1634
|
+
### Return type
|
1635
|
+
|
1636
|
+
[**Schedule**](Schedule.html)
|
1637
|
+
|
1638
|
+
### HTTP request headers
|
1639
|
+
|
1640
|
+
- **Content-Type**: application/json
|
1641
|
+
- **Accept**: application/json
|
1642
|
+
|
1643
|
+
|
1644
|
+
|
1645
|
+
<a name="get_architect_schedulegroup"></a>
|
1646
|
+
|
1647
|
+
## -[**ScheduleGroup**](ScheduleGroup.html) get_architect_schedulegroup(schedule_group_id)
|
1648
|
+
|
1649
|
+
Gets a schedule group by ID
|
1650
|
+
|
1651
|
+
|
1652
|
+
|
1653
|
+
Wraps GET /api/v2/architect/schedulegroups/{scheduleGroupId}
|
1654
|
+
|
1655
|
+
|
1656
|
+
### Example
|
1657
|
+
~~~ruby
|
1658
|
+
# load the gem
|
1659
|
+
require 'purecloudplatformclientv2'
|
1660
|
+
# setup authorization
|
1661
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1662
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1663
|
+
environment = "mypurecloud.com"
|
1664
|
+
|
1665
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1666
|
+
|
1667
|
+
PureCloud.configure do |config|
|
1668
|
+
config.access_token = @authToken
|
1669
|
+
end
|
1670
|
+
|
1671
|
+
api_instance = PureCloud::ArchitectApi.new
|
1672
|
+
|
1673
|
+
schedule_group_id = "schedule_group_id_example" # String | Schedule group ID
|
1674
|
+
|
1675
|
+
|
1676
|
+
begin
|
1677
|
+
#Gets a schedule group by ID
|
1678
|
+
result = api_instance.get_architect_schedulegroup(schedule_group_id)
|
1679
|
+
p result
|
1680
|
+
rescue PureCloud::ApiError => e
|
1681
|
+
puts "Exception when calling ArchitectApi->get_architect_schedulegroup: #{e}"
|
1682
|
+
end
|
1683
|
+
~~~
|
1684
|
+
|
1685
|
+
### Parameters
|
1686
|
+
|
1687
|
+
Name | Type | Description | Notes
|
1688
|
+
------------- | ------------- | ------------- | -------------
|
1689
|
+
**schedule_group_id** | **String**| Schedule group ID | |
|
1690
|
+
{: class="table table-striped"}
|
1691
|
+
|
1692
|
+
|
1693
|
+
### Return type
|
1694
|
+
|
1695
|
+
[**ScheduleGroup**](ScheduleGroup.html)
|
1696
|
+
|
1697
|
+
### HTTP request headers
|
1698
|
+
|
1699
|
+
- **Content-Type**: application/json
|
1700
|
+
- **Accept**: application/json
|
1701
|
+
|
1702
|
+
|
1703
|
+
|
1704
|
+
<a name="get_architect_schedulegroups"></a>
|
1705
|
+
|
1706
|
+
## -[**ScheduleGroupEntityListing**](ScheduleGroupEntityListing.html) get_architect_schedulegroups(opts)
|
1707
|
+
|
1708
|
+
Get a list of schedule groups.
|
1709
|
+
|
1710
|
+
|
1711
|
+
|
1712
|
+
Wraps GET /api/v2/architect/schedulegroups
|
1713
|
+
|
1714
|
+
|
1715
|
+
### Example
|
1716
|
+
~~~ruby
|
1717
|
+
# load the gem
|
1718
|
+
require 'purecloudplatformclientv2'
|
1719
|
+
# setup authorization
|
1720
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1721
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1722
|
+
environment = "mypurecloud.com"
|
1723
|
+
|
1724
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1725
|
+
|
1726
|
+
PureCloud.configure do |config|
|
1727
|
+
config.access_token = @authToken
|
1728
|
+
end
|
1729
|
+
|
1730
|
+
api_instance = PureCloud::ArchitectApi.new
|
1731
|
+
|
1732
|
+
opts = {
|
1733
|
+
page_number: 1, # Integer | Page number
|
1734
|
+
page_size: 25, # Integer | Page size
|
1735
|
+
sort_by: "name", # String | Sort by
|
1736
|
+
sort_order: "ASC" # String | Sort order
|
1737
|
+
}
|
1738
|
+
|
1739
|
+
begin
|
1740
|
+
#Get a list of schedule groups.
|
1741
|
+
result = api_instance.get_architect_schedulegroups(opts)
|
1742
|
+
p result
|
1743
|
+
rescue PureCloud::ApiError => e
|
1744
|
+
puts "Exception when calling ArchitectApi->get_architect_schedulegroups: #{e}"
|
1745
|
+
end
|
1746
|
+
~~~
|
1747
|
+
|
1748
|
+
### Parameters
|
1749
|
+
|
1750
|
+
Name | Type | Description | Notes
|
1751
|
+
------------- | ------------- | ------------- | -------------
|
1752
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
1753
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
1754
|
+
**sort_by** | **String**| Sort by | [optional] [default to name] |
|
1755
|
+
**sort_order** | **String**| Sort order | [optional] [default to ASC] |
|
1756
|
+
{: class="table table-striped"}
|
1757
|
+
|
1758
|
+
|
1759
|
+
### Return type
|
1760
|
+
|
1761
|
+
[**ScheduleGroupEntityListing**](ScheduleGroupEntityListing.html)
|
1762
|
+
|
1763
|
+
### HTTP request headers
|
1764
|
+
|
1765
|
+
- **Content-Type**: application/json
|
1766
|
+
- **Accept**: application/json
|
1767
|
+
|
1768
|
+
|
1769
|
+
|
1770
|
+
<a name="get_architect_schedules"></a>
|
1771
|
+
|
1772
|
+
## -[**ScheduleEntityListing**](ScheduleEntityListing.html) get_architect_schedules(opts)
|
1773
|
+
|
1774
|
+
Get a list of schedules.
|
1775
|
+
|
1776
|
+
|
1777
|
+
|
1778
|
+
Wraps GET /api/v2/architect/schedules
|
1779
|
+
|
1780
|
+
|
1781
|
+
### Example
|
1782
|
+
~~~ruby
|
1783
|
+
# load the gem
|
1784
|
+
require 'purecloudplatformclientv2'
|
1785
|
+
# setup authorization
|
1786
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1787
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1788
|
+
environment = "mypurecloud.com"
|
1789
|
+
|
1790
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1791
|
+
|
1792
|
+
PureCloud.configure do |config|
|
1793
|
+
config.access_token = @authToken
|
1794
|
+
end
|
1795
|
+
|
1796
|
+
api_instance = PureCloud::ArchitectApi.new
|
1797
|
+
|
1798
|
+
opts = {
|
1799
|
+
page_number: 1, # Integer | Page number
|
1800
|
+
page_size: 25, # Integer | Page size
|
1801
|
+
sort_by: "name", # String | Sort by
|
1802
|
+
sort_order: "ASC" # String | Sort order
|
1803
|
+
}
|
1804
|
+
|
1805
|
+
begin
|
1806
|
+
#Get a list of schedules.
|
1807
|
+
result = api_instance.get_architect_schedules(opts)
|
1808
|
+
p result
|
1809
|
+
rescue PureCloud::ApiError => e
|
1810
|
+
puts "Exception when calling ArchitectApi->get_architect_schedules: #{e}"
|
1811
|
+
end
|
1812
|
+
~~~
|
1813
|
+
|
1814
|
+
### Parameters
|
1815
|
+
|
1816
|
+
Name | Type | Description | Notes
|
1817
|
+
------------- | ------------- | ------------- | -------------
|
1818
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
1819
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
1820
|
+
**sort_by** | **String**| Sort by | [optional] [default to name] |
|
1821
|
+
**sort_order** | **String**| Sort order | [optional] [default to ASC] |
|
1822
|
+
{: class="table table-striped"}
|
1823
|
+
|
1824
|
+
|
1825
|
+
### Return type
|
1826
|
+
|
1827
|
+
[**ScheduleEntityListing**](ScheduleEntityListing.html)
|
1828
|
+
|
1829
|
+
### HTTP request headers
|
1830
|
+
|
1831
|
+
- **Content-Type**: application/json
|
1832
|
+
- **Accept**: application/json
|
1833
|
+
|
1834
|
+
|
1835
|
+
|
1836
|
+
<a name="get_architect_systemprompt"></a>
|
1837
|
+
|
1838
|
+
## -[**SystemPrompt**](SystemPrompt.html) get_architect_systemprompt(prompt_id)
|
1839
|
+
|
1840
|
+
Get a system prompt
|
1841
|
+
|
1842
|
+
|
1843
|
+
|
1844
|
+
Wraps GET /api/v2/architect/systemprompts/{promptId}
|
1845
|
+
|
1846
|
+
|
1847
|
+
### Example
|
1848
|
+
~~~ruby
|
1849
|
+
# load the gem
|
1850
|
+
require 'purecloudplatformclientv2'
|
1851
|
+
# setup authorization
|
1852
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1853
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1854
|
+
environment = "mypurecloud.com"
|
1855
|
+
|
1856
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1857
|
+
|
1858
|
+
PureCloud.configure do |config|
|
1859
|
+
config.access_token = @authToken
|
1860
|
+
end
|
1861
|
+
|
1862
|
+
api_instance = PureCloud::ArchitectApi.new
|
1863
|
+
|
1864
|
+
prompt_id = "prompt_id_example" # String | promptId
|
1865
|
+
|
1866
|
+
|
1867
|
+
begin
|
1868
|
+
#Get a system prompt
|
1305
1869
|
result = api_instance.get_architect_systemprompt(prompt_id)
|
1306
1870
|
p result
|
1307
1871
|
rescue PureCloud::ApiError => e
|
@@ -2071,15 +2635,15 @@ nil (empty response body)
|
|
2071
2635
|
|
2072
2636
|
|
2073
2637
|
|
2074
|
-
<a name="
|
2638
|
+
<a name="post_architect_ivrs"></a>
|
2075
2639
|
|
2076
|
-
## -[**
|
2640
|
+
## -[**IVR**](IVR.html) post_architect_ivrs(opts)
|
2077
2641
|
|
2078
|
-
Create
|
2642
|
+
Create IVR config.
|
2079
2643
|
|
2080
2644
|
|
2081
2645
|
|
2082
|
-
Wraps POST /api/v2/architect/
|
2646
|
+
Wraps POST /api/v2/architect/ivrs
|
2083
2647
|
|
2084
2648
|
|
2085
2649
|
### Example
|
@@ -2099,18 +2663,16 @@ end
|
|
2099
2663
|
|
2100
2664
|
api_instance = PureCloud::ArchitectApi.new
|
2101
2665
|
|
2102
|
-
prompt_id = "prompt_id_example" # String | Prompt ID
|
2103
|
-
|
2104
2666
|
opts = {
|
2105
|
-
body: PureCloud::
|
2667
|
+
body: PureCloud::IVR.new # IVR |
|
2106
2668
|
}
|
2107
2669
|
|
2108
2670
|
begin
|
2109
|
-
#Create
|
2110
|
-
result = api_instance.
|
2671
|
+
#Create IVR config.
|
2672
|
+
result = api_instance.post_architect_ivrs(opts)
|
2111
2673
|
p result
|
2112
2674
|
rescue PureCloud::ApiError => e
|
2113
|
-
puts "Exception when calling ArchitectApi->
|
2675
|
+
puts "Exception when calling ArchitectApi->post_architect_ivrs: #{e}"
|
2114
2676
|
end
|
2115
2677
|
~~~
|
2116
2678
|
|
@@ -2118,14 +2680,13 @@ end
|
|
2118
2680
|
|
2119
2681
|
Name | Type | Description | Notes
|
2120
2682
|
------------- | ------------- | ------------- | -------------
|
2121
|
-
**
|
2122
|
-
**body** | [**PromptAssetCreate**](PromptAssetCreate.html)| | [optional] |
|
2683
|
+
**body** | [**IVR**](IVR.html)| | [optional] |
|
2123
2684
|
{: class="table table-striped"}
|
2124
2685
|
|
2125
2686
|
|
2126
2687
|
### Return type
|
2127
2688
|
|
2128
|
-
[**
|
2689
|
+
[**IVR**](IVR.html)
|
2129
2690
|
|
2130
2691
|
### HTTP request headers
|
2131
2692
|
|
@@ -2134,15 +2695,15 @@ Name | Type | Description | Notes
|
|
2134
2695
|
|
2135
2696
|
|
2136
2697
|
|
2137
|
-
<a name="
|
2698
|
+
<a name="post_architect_prompt_resources"></a>
|
2138
2699
|
|
2139
|
-
## -[**
|
2700
|
+
## -[**PromptAsset**](PromptAsset.html) post_architect_prompt_resources(prompt_id, opts)
|
2140
2701
|
|
2141
|
-
Create a new user prompt
|
2702
|
+
Create a new user prompt resource
|
2142
2703
|
|
2143
2704
|
|
2144
2705
|
|
2145
|
-
Wraps POST /api/v2/architect/prompts
|
2706
|
+
Wraps POST /api/v2/architect/prompts/{promptId}/resources
|
2146
2707
|
|
2147
2708
|
|
2148
2709
|
### Example
|
@@ -2162,16 +2723,18 @@ end
|
|
2162
2723
|
|
2163
2724
|
api_instance = PureCloud::ArchitectApi.new
|
2164
2725
|
|
2726
|
+
prompt_id = "prompt_id_example" # String | Prompt ID
|
2727
|
+
|
2165
2728
|
opts = {
|
2166
|
-
body: PureCloud::
|
2729
|
+
body: PureCloud::PromptAssetCreate.new # PromptAssetCreate |
|
2167
2730
|
}
|
2168
2731
|
|
2169
2732
|
begin
|
2170
|
-
#Create a new user prompt
|
2171
|
-
result = api_instance.
|
2733
|
+
#Create a new user prompt resource
|
2734
|
+
result = api_instance.post_architect_prompt_resources(prompt_id, opts)
|
2172
2735
|
p result
|
2173
2736
|
rescue PureCloud::ApiError => e
|
2174
|
-
puts "Exception when calling ArchitectApi->
|
2737
|
+
puts "Exception when calling ArchitectApi->post_architect_prompt_resources: #{e}"
|
2175
2738
|
end
|
2176
2739
|
~~~
|
2177
2740
|
|
@@ -2179,13 +2742,14 @@ end
|
|
2179
2742
|
|
2180
2743
|
Name | Type | Description | Notes
|
2181
2744
|
------------- | ------------- | ------------- | -------------
|
2182
|
-
**
|
2745
|
+
**prompt_id** | **String**| Prompt ID | |
|
2746
|
+
**body** | [**PromptAssetCreate**](PromptAssetCreate.html)| | [optional] |
|
2183
2747
|
{: class="table table-striped"}
|
2184
2748
|
|
2185
2749
|
|
2186
2750
|
### Return type
|
2187
2751
|
|
2188
|
-
[**
|
2752
|
+
[**PromptAsset**](PromptAsset.html)
|
2189
2753
|
|
2190
2754
|
### HTTP request headers
|
2191
2755
|
|
@@ -2194,15 +2758,195 @@ Name | Type | Description | Notes
|
|
2194
2758
|
|
2195
2759
|
|
2196
2760
|
|
2197
|
-
<a name="
|
2761
|
+
<a name="post_architect_prompts"></a>
|
2198
2762
|
|
2199
|
-
## -[**
|
2763
|
+
## -[**Prompt**](Prompt.html) post_architect_prompts(opts)
|
2200
2764
|
|
2201
|
-
Create
|
2765
|
+
Create a new user prompt
|
2202
2766
|
|
2203
2767
|
|
2204
2768
|
|
2205
|
-
Wraps POST /api/v2/architect/
|
2769
|
+
Wraps POST /api/v2/architect/prompts
|
2770
|
+
|
2771
|
+
|
2772
|
+
### Example
|
2773
|
+
~~~ruby
|
2774
|
+
# load the gem
|
2775
|
+
require 'purecloudplatformclientv2'
|
2776
|
+
# setup authorization
|
2777
|
+
@secret = ENV['PURECLOUD_SECRET']
|
2778
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
2779
|
+
environment = "mypurecloud.com"
|
2780
|
+
|
2781
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
2782
|
+
|
2783
|
+
PureCloud.configure do |config|
|
2784
|
+
config.access_token = @authToken
|
2785
|
+
end
|
2786
|
+
|
2787
|
+
api_instance = PureCloud::ArchitectApi.new
|
2788
|
+
|
2789
|
+
opts = {
|
2790
|
+
body: PureCloud::Prompt.new # Prompt |
|
2791
|
+
}
|
2792
|
+
|
2793
|
+
begin
|
2794
|
+
#Create a new user prompt
|
2795
|
+
result = api_instance.post_architect_prompts(opts)
|
2796
|
+
p result
|
2797
|
+
rescue PureCloud::ApiError => e
|
2798
|
+
puts "Exception when calling ArchitectApi->post_architect_prompts: #{e}"
|
2799
|
+
end
|
2800
|
+
~~~
|
2801
|
+
|
2802
|
+
### Parameters
|
2803
|
+
|
2804
|
+
Name | Type | Description | Notes
|
2805
|
+
------------- | ------------- | ------------- | -------------
|
2806
|
+
**body** | [**Prompt**](Prompt.html)| | [optional] |
|
2807
|
+
{: class="table table-striped"}
|
2808
|
+
|
2809
|
+
|
2810
|
+
### Return type
|
2811
|
+
|
2812
|
+
[**Prompt**](Prompt.html)
|
2813
|
+
|
2814
|
+
### HTTP request headers
|
2815
|
+
|
2816
|
+
- **Content-Type**: application/json
|
2817
|
+
- **Accept**: application/json
|
2818
|
+
|
2819
|
+
|
2820
|
+
|
2821
|
+
<a name="post_architect_schedulegroups"></a>
|
2822
|
+
|
2823
|
+
## -[**ScheduleGroup**](ScheduleGroup.html) post_architect_schedulegroups(opts)
|
2824
|
+
|
2825
|
+
Creates a new schedule group
|
2826
|
+
|
2827
|
+
|
2828
|
+
|
2829
|
+
Wraps POST /api/v2/architect/schedulegroups
|
2830
|
+
|
2831
|
+
|
2832
|
+
### Example
|
2833
|
+
~~~ruby
|
2834
|
+
# load the gem
|
2835
|
+
require 'purecloudplatformclientv2'
|
2836
|
+
# setup authorization
|
2837
|
+
@secret = ENV['PURECLOUD_SECRET']
|
2838
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
2839
|
+
environment = "mypurecloud.com"
|
2840
|
+
|
2841
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
2842
|
+
|
2843
|
+
PureCloud.configure do |config|
|
2844
|
+
config.access_token = @authToken
|
2845
|
+
end
|
2846
|
+
|
2847
|
+
api_instance = PureCloud::ArchitectApi.new
|
2848
|
+
|
2849
|
+
opts = {
|
2850
|
+
body: PureCloud::ScheduleGroup.new # ScheduleGroup |
|
2851
|
+
}
|
2852
|
+
|
2853
|
+
begin
|
2854
|
+
#Creates a new schedule group
|
2855
|
+
result = api_instance.post_architect_schedulegroups(opts)
|
2856
|
+
p result
|
2857
|
+
rescue PureCloud::ApiError => e
|
2858
|
+
puts "Exception when calling ArchitectApi->post_architect_schedulegroups: #{e}"
|
2859
|
+
end
|
2860
|
+
~~~
|
2861
|
+
|
2862
|
+
### Parameters
|
2863
|
+
|
2864
|
+
Name | Type | Description | Notes
|
2865
|
+
------------- | ------------- | ------------- | -------------
|
2866
|
+
**body** | [**ScheduleGroup**](ScheduleGroup.html)| | [optional] |
|
2867
|
+
{: class="table table-striped"}
|
2868
|
+
|
2869
|
+
|
2870
|
+
### Return type
|
2871
|
+
|
2872
|
+
[**ScheduleGroup**](ScheduleGroup.html)
|
2873
|
+
|
2874
|
+
### HTTP request headers
|
2875
|
+
|
2876
|
+
- **Content-Type**: application/json
|
2877
|
+
- **Accept**: application/json
|
2878
|
+
|
2879
|
+
|
2880
|
+
|
2881
|
+
<a name="post_architect_schedules"></a>
|
2882
|
+
|
2883
|
+
## -[**Schedule**](Schedule.html) post_architect_schedules(opts)
|
2884
|
+
|
2885
|
+
Create a new schedule.
|
2886
|
+
|
2887
|
+
|
2888
|
+
|
2889
|
+
Wraps POST /api/v2/architect/schedules
|
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
|
+
opts = {
|
2910
|
+
body: PureCloud::Schedule.new # Schedule |
|
2911
|
+
}
|
2912
|
+
|
2913
|
+
begin
|
2914
|
+
#Create a new schedule.
|
2915
|
+
result = api_instance.post_architect_schedules(opts)
|
2916
|
+
p result
|
2917
|
+
rescue PureCloud::ApiError => e
|
2918
|
+
puts "Exception when calling ArchitectApi->post_architect_schedules: #{e}"
|
2919
|
+
end
|
2920
|
+
~~~
|
2921
|
+
|
2922
|
+
### Parameters
|
2923
|
+
|
2924
|
+
Name | Type | Description | Notes
|
2925
|
+
------------- | ------------- | ------------- | -------------
|
2926
|
+
**body** | [**Schedule**](Schedule.html)| | [optional] |
|
2927
|
+
{: class="table table-striped"}
|
2928
|
+
|
2929
|
+
|
2930
|
+
### Return type
|
2931
|
+
|
2932
|
+
[**Schedule**](Schedule.html)
|
2933
|
+
|
2934
|
+
### HTTP request headers
|
2935
|
+
|
2936
|
+
- **Content-Type**: application/json
|
2937
|
+
- **Accept**: application/json
|
2938
|
+
|
2939
|
+
|
2940
|
+
|
2941
|
+
<a name="post_architect_systemprompt_resources"></a>
|
2942
|
+
|
2943
|
+
## -[**SystemPromptAsset**](SystemPromptAsset.html) post_architect_systemprompt_resources(prompt_id, opts)
|
2944
|
+
|
2945
|
+
Create system prompt resource override.
|
2946
|
+
|
2947
|
+
|
2948
|
+
|
2949
|
+
Wraps POST /api/v2/architect/systemprompts/{promptId}/resources
|
2206
2950
|
|
2207
2951
|
|
2208
2952
|
### Example
|
@@ -2738,6 +3482,69 @@ Name | Type | Description | Notes
|
|
2738
3482
|
|
2739
3483
|
|
2740
3484
|
|
3485
|
+
<a name="put_architect_ivr"></a>
|
3486
|
+
|
3487
|
+
## -[**IVR**](IVR.html) put_architect_ivr(ivr_id, opts)
|
3488
|
+
|
3489
|
+
Update an IVR Config.
|
3490
|
+
|
3491
|
+
|
3492
|
+
|
3493
|
+
Wraps PUT /api/v2/architect/ivrs/{ivrId}
|
3494
|
+
|
3495
|
+
|
3496
|
+
### Example
|
3497
|
+
~~~ruby
|
3498
|
+
# load the gem
|
3499
|
+
require 'purecloudplatformclientv2'
|
3500
|
+
# setup authorization
|
3501
|
+
@secret = ENV['PURECLOUD_SECRET']
|
3502
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
3503
|
+
environment = "mypurecloud.com"
|
3504
|
+
|
3505
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
3506
|
+
|
3507
|
+
PureCloud.configure do |config|
|
3508
|
+
config.access_token = @authToken
|
3509
|
+
end
|
3510
|
+
|
3511
|
+
api_instance = PureCloud::ArchitectApi.new
|
3512
|
+
|
3513
|
+
ivr_id = "ivr_id_example" # String | IVR id
|
3514
|
+
|
3515
|
+
opts = {
|
3516
|
+
body: PureCloud::IVR.new # IVR |
|
3517
|
+
}
|
3518
|
+
|
3519
|
+
begin
|
3520
|
+
#Update an IVR Config.
|
3521
|
+
result = api_instance.put_architect_ivr(ivr_id, opts)
|
3522
|
+
p result
|
3523
|
+
rescue PureCloud::ApiError => e
|
3524
|
+
puts "Exception when calling ArchitectApi->put_architect_ivr: #{e}"
|
3525
|
+
end
|
3526
|
+
~~~
|
3527
|
+
|
3528
|
+
### Parameters
|
3529
|
+
|
3530
|
+
Name | Type | Description | Notes
|
3531
|
+
------------- | ------------- | ------------- | -------------
|
3532
|
+
**ivr_id** | **String**| IVR id | |
|
3533
|
+
**body** | [**IVR**](IVR.html)| | [optional] |
|
3534
|
+
{: class="table table-striped"}
|
3535
|
+
|
3536
|
+
|
3537
|
+
### Return type
|
3538
|
+
|
3539
|
+
[**IVR**](IVR.html)
|
3540
|
+
|
3541
|
+
### HTTP request headers
|
3542
|
+
|
3543
|
+
- **Content-Type**: application/json
|
3544
|
+
- **Accept**: application/json
|
3545
|
+
|
3546
|
+
|
3547
|
+
|
2741
3548
|
<a name="put_architect_prompt"></a>
|
2742
3549
|
|
2743
3550
|
## -[**Prompt**](Prompt.html) put_architect_prompt(prompt_id, opts)
|
@@ -2867,6 +3674,132 @@ Name | Type | Description | Notes
|
|
2867
3674
|
|
2868
3675
|
|
2869
3676
|
|
3677
|
+
<a name="put_architect_schedule"></a>
|
3678
|
+
|
3679
|
+
## -[**Schedule**](Schedule.html) put_architect_schedule(schedule_id, opts)
|
3680
|
+
|
3681
|
+
Update schedule by ID
|
3682
|
+
|
3683
|
+
|
3684
|
+
|
3685
|
+
Wraps PUT /api/v2/architect/schedules/{scheduleId}
|
3686
|
+
|
3687
|
+
|
3688
|
+
### Example
|
3689
|
+
~~~ruby
|
3690
|
+
# load the gem
|
3691
|
+
require 'purecloudplatformclientv2'
|
3692
|
+
# setup authorization
|
3693
|
+
@secret = ENV['PURECLOUD_SECRET']
|
3694
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
3695
|
+
environment = "mypurecloud.com"
|
3696
|
+
|
3697
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
3698
|
+
|
3699
|
+
PureCloud.configure do |config|
|
3700
|
+
config.access_token = @authToken
|
3701
|
+
end
|
3702
|
+
|
3703
|
+
api_instance = PureCloud::ArchitectApi.new
|
3704
|
+
|
3705
|
+
schedule_id = "schedule_id_example" # String | Schedule ID
|
3706
|
+
|
3707
|
+
opts = {
|
3708
|
+
body: PureCloud::Schedule.new # Schedule |
|
3709
|
+
}
|
3710
|
+
|
3711
|
+
begin
|
3712
|
+
#Update schedule by ID
|
3713
|
+
result = api_instance.put_architect_schedule(schedule_id, opts)
|
3714
|
+
p result
|
3715
|
+
rescue PureCloud::ApiError => e
|
3716
|
+
puts "Exception when calling ArchitectApi->put_architect_schedule: #{e}"
|
3717
|
+
end
|
3718
|
+
~~~
|
3719
|
+
|
3720
|
+
### Parameters
|
3721
|
+
|
3722
|
+
Name | Type | Description | Notes
|
3723
|
+
------------- | ------------- | ------------- | -------------
|
3724
|
+
**schedule_id** | **String**| Schedule ID | |
|
3725
|
+
**body** | [**Schedule**](Schedule.html)| | [optional] |
|
3726
|
+
{: class="table table-striped"}
|
3727
|
+
|
3728
|
+
|
3729
|
+
### Return type
|
3730
|
+
|
3731
|
+
[**Schedule**](Schedule.html)
|
3732
|
+
|
3733
|
+
### HTTP request headers
|
3734
|
+
|
3735
|
+
- **Content-Type**: application/json
|
3736
|
+
- **Accept**: application/json
|
3737
|
+
|
3738
|
+
|
3739
|
+
|
3740
|
+
<a name="put_architect_schedulegroup"></a>
|
3741
|
+
|
3742
|
+
## -[**ScheduleGroup**](ScheduleGroup.html) put_architect_schedulegroup(schedule_group_id, opts)
|
3743
|
+
|
3744
|
+
Updates a schedule group by ID
|
3745
|
+
|
3746
|
+
|
3747
|
+
|
3748
|
+
Wraps PUT /api/v2/architect/schedulegroups/{scheduleGroupId}
|
3749
|
+
|
3750
|
+
|
3751
|
+
### Example
|
3752
|
+
~~~ruby
|
3753
|
+
# load the gem
|
3754
|
+
require 'purecloudplatformclientv2'
|
3755
|
+
# setup authorization
|
3756
|
+
@secret = ENV['PURECLOUD_SECRET']
|
3757
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
3758
|
+
environment = "mypurecloud.com"
|
3759
|
+
|
3760
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
3761
|
+
|
3762
|
+
PureCloud.configure do |config|
|
3763
|
+
config.access_token = @authToken
|
3764
|
+
end
|
3765
|
+
|
3766
|
+
api_instance = PureCloud::ArchitectApi.new
|
3767
|
+
|
3768
|
+
schedule_group_id = "schedule_group_id_example" # String | Schedule group ID
|
3769
|
+
|
3770
|
+
opts = {
|
3771
|
+
body: PureCloud::ScheduleGroup.new # ScheduleGroup |
|
3772
|
+
}
|
3773
|
+
|
3774
|
+
begin
|
3775
|
+
#Updates a schedule group by ID
|
3776
|
+
result = api_instance.put_architect_schedulegroup(schedule_group_id, opts)
|
3777
|
+
p result
|
3778
|
+
rescue PureCloud::ApiError => e
|
3779
|
+
puts "Exception when calling ArchitectApi->put_architect_schedulegroup: #{e}"
|
3780
|
+
end
|
3781
|
+
~~~
|
3782
|
+
|
3783
|
+
### Parameters
|
3784
|
+
|
3785
|
+
Name | Type | Description | Notes
|
3786
|
+
------------- | ------------- | ------------- | -------------
|
3787
|
+
**schedule_group_id** | **String**| Schedule group ID | |
|
3788
|
+
**body** | [**ScheduleGroup**](ScheduleGroup.html)| | [optional] |
|
3789
|
+
{: class="table table-striped"}
|
3790
|
+
|
3791
|
+
|
3792
|
+
### Return type
|
3793
|
+
|
3794
|
+
[**ScheduleGroup**](ScheduleGroup.html)
|
3795
|
+
|
3796
|
+
### HTTP request headers
|
3797
|
+
|
3798
|
+
- **Content-Type**: application/json
|
3799
|
+
- **Accept**: application/json
|
3800
|
+
|
3801
|
+
|
3802
|
+
|
2870
3803
|
<a name="put_architect_systemprompt_resource"></a>
|
2871
3804
|
|
2872
3805
|
## -[**SystemPromptAsset**](SystemPromptAsset.html) put_architect_systemprompt_resource(prompt_id, language_code, opts)
|