purecloud 0.58.1 → 0.59.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +3 -3
- data/bin/notificationMappings.json +16 -0
- data/config-ruby.json +1 -1
- data/doc_out/AgentActivityEntityListing.html.md +2 -2
- data/doc_out/AnalyticsApi.html.md +57 -0
- data/doc_out/AnalyticsConversationSegment.html.md +2 -0
- data/doc_out/AnalyticsRoutingStatusRecord.html.md +16 -0
- data/doc_out/AnalyticsSession.html.md +8 -0
- data/doc_out/AnalyticsUserDetail.html.md +15 -0
- data/doc_out/AnalyticsUserDetailsQueryResponse.html.md +14 -0
- data/doc_out/AnalyticsUserPresenceRecord.html.md +17 -0
- data/doc_out/AttemptLimitsEntityListing.html.md +2 -2
- data/doc_out/AttributeEntityListing.html.md +2 -2
- data/doc_out/CalibrationEntityListing.html.md +2 -2
- data/doc_out/CallConversationEntityListing.html.md +2 -2
- data/doc_out/CallConversationNotificationCallMediaParticipant.html.md +1 -1
- data/doc_out/CallConversationNotificationParticipants.html.md +1 -1
- data/doc_out/CallableTimeSetEntityListing.html.md +2 -2
- data/doc_out/CallbackConversationEntityListing.html.md +2 -2
- data/doc_out/CallbackConversationNotificationCallbackMediaParticipant.html.md +1 -1
- data/doc_out/CallbackConversationNotificationParticipants.html.md +1 -1
- data/doc_out/CampaignEntityListing.html.md +2 -2
- data/doc_out/CampaignSequenceEntityListing.html.md +2 -2
- data/doc_out/CertificateAuthorityEntityListing.html.md +2 -2
- data/doc_out/ChannelEntityListing.html.md +2 -2
- data/doc_out/ChatConversationEntityListing.html.md +2 -2
- data/doc_out/ChatConversationNotificationChatMediaParticipant.html.md +1 -1
- data/doc_out/ChatConversationNotificationParticipants.html.md +1 -1
- data/doc_out/CobrowseConversationEntityListing.html.md +2 -2
- data/doc_out/CobrowseConversationNotificationCobrowseMediaParticipant.html.md +1 -1
- data/doc_out/CobrowseConversationNotificationParticipants.html.md +1 -1
- data/doc_out/CommandStatusEntityListing.html.md +2 -2
- data/doc_out/ContactListEntityListing.html.md +2 -2
- data/doc_out/ContentManagementApi.html.md +69 -0
- data/doc_out/ConversationEntityListing.html.md +2 -2
- data/doc_out/ConversationNotificationParticipant.html.md +1 -1
- data/doc_out/ConversationNotificationParticipants.html.md +13 -13
- data/doc_out/{ConversationNotificationScreenShare.html.md → ConversationNotificationScreenshare.html.md} +2 -2
- data/doc_out/{ConversationNotificationScreenShares.html.md → ConversationNotificationScreenshares.html.md} +2 -2
- data/doc_out/DIDEntityListing.html.md +2 -2
- data/doc_out/DIDPoolEntityListing.html.md +2 -2
- data/doc_out/DncListEntityListing.html.md +2 -2
- data/doc_out/DocumentAuditEntityListing.html.md +2 -2
- data/doc_out/DocumentDataNotification.html.md +28 -0
- data/doc_out/{CallbackConversationNotificationUser.html.md → DocumentDataNotificationCreatedBy.html.md} +2 -2
- data/doc_out/DocumentDataNotificationLockData.html.md +15 -0
- data/doc_out/DocumentDataNotificationLockInfo.html.md +15 -0
- data/doc_out/DocumentDataNotificationUserData.html.md +14 -0
- data/doc_out/DocumentDataNotificationWorkspace.html.md +13 -0
- data/doc_out/DocumentDataNotificationWorkspaceData.html.md +13 -0
- data/doc_out/DocumentEntityListing.html.md +2 -2
- data/doc_out/DomainEdgeSoftwareVersionDtoEntityListing.html.md +2 -2
- data/doc_out/DomainEntityListing.html.md +2 -2
- data/doc_out/DomainEntityListingEvaluationForm.html.md +2 -2
- data/doc_out/DomainEntityListingQueryResult.html.md +2 -2
- data/doc_out/EdgeEntityListing.html.md +2 -2
- data/doc_out/EdgeGroupEntityListing.html.md +2 -2
- data/doc_out/EdgeLineEntityListing.html.md +2 -2
- data/doc_out/EmailConversationEntityListing.html.md +2 -2
- data/doc_out/EmailConversationNotificationEmailMediaParticipant.html.md +1 -1
- data/doc_out/EmailConversationNotificationParticipants.html.md +1 -1
- data/doc_out/EmailMessageListing.html.md +2 -2
- data/doc_out/EncryptionKeyEntityListing.html.md +2 -2
- data/doc_out/EndpointEntityListing.html.md +2 -2
- data/doc_out/EvaluationEntityListing.html.md +2 -2
- data/doc_out/EvaluationFormEntityListing.html.md +2 -2
- data/doc_out/EvaluatorActivityEntityListing.html.md +2 -2
- data/doc_out/ExtensionEntityListing.html.md +2 -2
- data/doc_out/ExtensionPoolEntityListing.html.md +2 -2
- data/doc_out/FaxDataNotification.html.md +31 -0
- data/doc_out/FaxDataNotificationLockData.html.md +15 -0
- data/doc_out/FaxDataNotificationLockInfo.html.md +15 -0
- data/doc_out/FaxDataNotificationUserData.html.md +14 -0
- data/doc_out/FaxDataNotificationWorkspaceData.html.md +13 -0
- data/doc_out/FaxDocumentEntityListing.html.md +2 -2
- data/doc_out/GroupEntityListing.html.md +2 -2
- data/doc_out/GroupsApi.html.md +3 -1
- data/doc_out/HeartBeatAlertContainer.html.md +2 -2
- data/doc_out/HeartBeatRuleContainer.html.md +2 -2
- data/doc_out/InboundDomainEntityListing.html.md +2 -2
- data/doc_out/InboundRouteEntityListing.html.md +2 -2
- data/doc_out/InteractionStatsAlertContainer.html.md +2 -2
- data/doc_out/InteractionStatsRuleContainer.html.md +2 -2
- data/doc_out/KeywordSetEntityListing.html.md +2 -2
- data/doc_out/LanguageEntityListing.html.md +2 -2
- data/doc_out/LibraryEntityListing.html.md +2 -2
- data/doc_out/LineBaseEntityListing.html.md +2 -2
- data/doc_out/LineEntityListing.html.md +2 -2
- data/doc_out/LocalEncryptionConfigurationListing.html.md +2 -2
- data/doc_out/LogicalInterfaceEntityListing.html.md +2 -2
- data/doc_out/OAuthClientEntityListing.html.md +2 -2
- data/doc_out/OAuthProviderEntityListing.html.md +2 -2
- data/doc_out/OrganizationPresenceEntityListing.html.md +2 -2
- data/doc_out/OrganizationRoleEntityListing.html.md +2 -2
- data/doc_out/OrphanRecordingListing.html.md +2 -2
- data/doc_out/OutOfOfficeNotification.html.md +1 -1
- data/doc_out/OutboundRouteEntityListing.html.md +2 -2
- data/doc_out/Page.html.md +20 -0
- data/doc_out/PermissionCollectionEntityListing.html.md +2 -2
- data/doc_out/PhoneBaseEntityListing.html.md +2 -2
- data/doc_out/PhoneEntityListing.html.md +2 -2
- data/doc_out/PhoneMetaBaseEntityListing.html.md +2 -2
- data/doc_out/PhysicalInterfaceEntityListing.html.md +2 -2
- data/doc_out/PolicyEntityListing.html.md +2 -2
- data/doc_out/PresenceApi.html.md +3 -4
- data/doc_out/QualityAuditPage.html.md +2 -2
- data/doc_out/QueueEmailAddress.html.md +1 -1
- data/doc_out/QueueEntityListing.html.md +2 -2
- data/doc_out/QueueMemberEntityListing.html.md +2 -2
- data/doc_out/RecordingApi.html.md +2 -2
- data/doc_out/RecordingDataNotification.html.md +31 -0
- data/doc_out/RecordingDataNotificationConversationData.html.md +13 -0
- data/doc_out/RecordingDataNotificationLockData.html.md +15 -0
- data/doc_out/RecordingDataNotificationLockInfo.html.md +15 -0
- data/doc_out/RecordingDataNotificationUserData.html.md +14 -0
- data/doc_out/RecordingDataNotificationWorkspaceData.html.md +13 -0
- data/doc_out/ReportMetaDataEntityListing.html.md +2 -2
- data/doc_out/ReportRunEntryEntityDomainListing.html.md +2 -2
- data/doc_out/ReportScheduleEntityListing.html.md +2 -2
- data/doc_out/ResponseEntityList.html.md +2 -2
- data/doc_out/ResponseEntityListing.html.md +2 -2
- data/doc_out/ResponseSetEntityListing.html.md +2 -2
- data/doc_out/RuleSetEntityListing.html.md +2 -2
- data/doc_out/SchemaCategoryEntityListing.html.md +2 -2
- data/doc_out/SchemaReferenceEntityListing.html.md +2 -2
- data/doc_out/ScreenRecordingSessionListing.html.md +2 -2
- data/doc_out/ScreenShareConversationNotificationParticipants.html.md +1 -1
- data/doc_out/ScreenShareConversationNotificationScreenShareMediaParticipant.html.md +1 -1
- data/doc_out/Script.html.md +26 -0
- data/doc_out/ScriptEntityListing.html.md +22 -0
- data/doc_out/ScriptsApi.html.md +557 -0
- data/doc_out/SecurityProfileEntityListing.html.md +2 -2
- data/doc_out/ShareEntityListing.html.md +2 -2
- data/doc_out/SiteEntityListing.html.md +2 -2
- data/doc_out/SkillEntityListing.html.md +2 -2
- data/doc_out/SocialConversationNotificationParticipants.html.md +1 -1
- data/doc_out/SocialConversationNotificationSocialMediaParticipant.html.md +1 -1
- data/doc_out/StationEntityListing.html.md +2 -2
- data/doc_out/TagValueEntityListing.html.md +2 -2
- data/doc_out/TelephonyProvidersEdgeApi.html.md +5 -3
- data/doc_out/TimeOffRequest.html.md +30 -0
- data/doc_out/TimeOffRequestList.html.md +16 -0
- data/doc_out/TimeOffRequestPatch.html.md +13 -0
- data/doc_out/TimeZoneEntityListing.html.md +2 -2
- data/doc_out/TrunkBaseEntityListing.html.md +2 -2
- data/doc_out/TrunkEntityListing.html.md +2 -2
- data/doc_out/TrunkMetabaseEntityListing.html.md +2 -2
- data/doc_out/UserDetailsQuery.html.md +20 -0
- data/doc_out/UserEntityListing.html.md +2 -2
- data/doc_out/UserQueueEntityListing.html.md +2 -2
- data/doc_out/UserRecordingEntityListing.html.md +2 -2
- data/doc_out/UserSkillEntityListing.html.md +2 -2
- data/doc_out/UsersApi.html.md +73 -12
- data/doc_out/UsersEntityListing.html.md +2 -2
- data/doc_out/VideoConversationNotificationParticipants.html.md +1 -1
- data/doc_out/VideoConversationNotificationVideoMediaParticipant.html.md +1 -1
- data/doc_out/WorkforceManagementApi.html.md +302 -0
- data/doc_out/WorkspaceEntityListing.html.md +2 -2
- data/doc_out/WorkspaceMemberEntityListing.html.md +2 -2
- data/doc_out/WrapupCodeEntityListing.html.md +2 -2
- data/doc_out/index.html.md +3 -3
- data/lib/purecloud.rb +32 -3
- data/lib/purecloud/api/analytics_api.rb +60 -0
- data/lib/purecloud/api/content_management_api.rb +75 -0
- data/lib/purecloud/api/groups_api.rb +3 -0
- data/lib/purecloud/api/outbound_api.rb +16 -16
- data/lib/purecloud/api/presence_api.rb +5 -6
- data/lib/purecloud/api/recording_api.rb +2 -2
- data/lib/purecloud/api/scripts_api.rb +617 -0
- data/lib/purecloud/api/telephony_providers_edge_api.rb +7 -4
- data/lib/purecloud/api/users_api.rb +84 -20
- data/lib/purecloud/api/workforce_management_api.rb +317 -0
- data/lib/purecloud/api_client.rb +1 -1
- data/lib/purecloud/models/agent_activity_entity_listing.rb +17 -17
- data/lib/purecloud/models/analytics_conversation_segment.rb +28 -4
- data/lib/purecloud/models/analytics_routing_status_record.rb +208 -0
- data/lib/purecloud/models/analytics_session.rb +83 -1
- data/lib/purecloud/models/analytics_user_detail.rb +192 -0
- data/lib/purecloud/models/analytics_user_details_query_response.rb +179 -0
- data/lib/purecloud/models/analytics_user_presence_record.rb +219 -0
- data/lib/purecloud/models/attempt_limits_entity_listing.rb +17 -17
- data/lib/purecloud/models/attribute_entity_listing.rb +17 -17
- data/lib/purecloud/models/calibration_entity_listing.rb +17 -17
- data/lib/purecloud/models/call.rb +4 -4
- data/lib/purecloud/models/call_conversation.rb +1 -1
- data/lib/purecloud/models/call_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/call_conversation_notification_call_media_participant.rb +1 -1
- data/lib/purecloud/models/call_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/call_media_participant.rb +4 -4
- data/lib/purecloud/models/callable_time_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/callback.rb +3 -3
- data/lib/purecloud/models/callback_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/callback_conversation_notification_callback_media_participant.rb +1 -1
- data/lib/purecloud/models/callback_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/callback_media_participant.rb +3 -3
- data/lib/purecloud/models/campaign_entity_listing.rb +17 -17
- data/lib/purecloud/models/campaign_sequence.rb +1 -1
- data/lib/purecloud/models/campaign_sequence_entity_listing.rb +17 -17
- data/lib/purecloud/models/certificate_authority_entity_listing.rb +17 -17
- data/lib/purecloud/models/channel_entity_listing.rb +17 -17
- data/lib/purecloud/models/chat_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/chat_conversation_notification_chat_media_participant.rb +1 -1
- data/lib/purecloud/models/chat_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/chat_media_participant.rb +3 -3
- data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/cobrowse_conversation_notification_cobrowse_media_participant.rb +1 -1
- data/lib/purecloud/models/cobrowse_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/cobrowse_media_participant.rb +3 -3
- data/lib/purecloud/models/cobrowsesession.rb +2 -2
- data/lib/purecloud/models/command_status_entity_listing.rb +17 -17
- data/lib/purecloud/models/contact_list_entity_listing.rb +17 -17
- data/lib/purecloud/models/conversation.rb +1 -1
- data/lib/purecloud/models/conversation_chat.rb +3 -3
- data/lib/purecloud/models/conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/conversation_notification_participant.rb +8 -8
- data/lib/purecloud/models/conversation_notification_participants.rb +128 -128
- data/lib/purecloud/models/{conversation_notification_screen_share.rb → conversation_notification_screenshare.rb} +1 -1
- data/lib/purecloud/models/{conversation_notification_screen_shares.rb → conversation_notification_screenshares.rb} +1 -1
- data/lib/purecloud/models/did_entity_listing.rb +17 -17
- data/lib/purecloud/models/did_pool_entity_listing.rb +17 -17
- data/lib/purecloud/models/disconnect_reason.rb +1 -1
- data/lib/purecloud/models/dnc_list_entity_listing.rb +17 -17
- data/lib/purecloud/models/document_audit_entity_listing.rb +17 -17
- data/lib/purecloud/models/document_data_notification.rb +315 -0
- data/lib/purecloud/models/{callback_conversation_notification_user.rb → document_data_notification_created_by.rb} +1 -1
- data/lib/purecloud/models/document_data_notification_lock_data.rb +185 -0
- data/lib/purecloud/models/document_data_notification_lock_info.rb +185 -0
- data/lib/purecloud/models/document_data_notification_user_data.rb +175 -0
- data/lib/purecloud/models/document_data_notification_workspace.rb +165 -0
- data/lib/purecloud/models/document_data_notification_workspace_data.rb +165 -0
- data/lib/purecloud/models/document_entity_listing.rb +17 -17
- data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +17 -17
- data/lib/purecloud/models/domain_entity_listing.rb +17 -17
- data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +17 -17
- data/lib/purecloud/models/domain_entity_listing_query_result.rb +17 -17
- data/lib/purecloud/models/edge_entity_listing.rb +17 -17
- data/lib/purecloud/models/edge_group_entity_listing.rb +17 -17
- data/lib/purecloud/models/edge_line_entity_listing.rb +17 -17
- data/lib/purecloud/models/email.rb +3 -3
- data/lib/purecloud/models/email_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/email_conversation_notification_email_media_participant.rb +1 -1
- data/lib/purecloud/models/email_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/email_media_participant.rb +3 -3
- data/lib/purecloud/models/email_message_listing.rb +17 -17
- data/lib/purecloud/models/encryption_key_entity_listing.rb +17 -17
- data/lib/purecloud/models/endpoint_entity_listing.rb +17 -17
- data/lib/purecloud/models/evaluation_entity_listing.rb +17 -17
- data/lib/purecloud/models/evaluation_form_entity_listing.rb +17 -17
- data/lib/purecloud/models/evaluator_activity_entity_listing.rb +17 -17
- data/lib/purecloud/models/extension_entity_listing.rb +17 -17
- data/lib/purecloud/models/extension_pool_entity_listing.rb +17 -17
- data/lib/purecloud/models/fax_data_notification.rb +345 -0
- data/lib/purecloud/models/fax_data_notification_lock_data.rb +185 -0
- data/lib/purecloud/models/fax_data_notification_lock_info.rb +185 -0
- data/lib/purecloud/models/fax_data_notification_user_data.rb +175 -0
- data/lib/purecloud/models/fax_data_notification_workspace_data.rb +165 -0
- data/lib/purecloud/models/fax_document_entity_listing.rb +17 -17
- data/lib/purecloud/models/group_entity_listing.rb +17 -17
- data/lib/purecloud/models/heart_beat_alert_container.rb +17 -17
- data/lib/purecloud/models/heart_beat_rule_container.rb +17 -17
- data/lib/purecloud/models/inbound_domain_entity_listing.rb +17 -17
- data/lib/purecloud/models/inbound_route_entity_listing.rb +17 -17
- data/lib/purecloud/models/interaction_stats_alert_container.rb +17 -17
- data/lib/purecloud/models/interaction_stats_rule_container.rb +17 -17
- data/lib/purecloud/models/keyword_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/language_entity_listing.rb +17 -17
- data/lib/purecloud/models/library_entity_listing.rb +17 -17
- data/lib/purecloud/models/line_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/line_entity_listing.rb +17 -17
- data/lib/purecloud/models/local_encryption_configuration_listing.rb +17 -17
- data/lib/purecloud/models/logical_interface_entity_listing.rb +17 -17
- data/lib/purecloud/models/media_participant_request.rb +1 -1
- data/lib/purecloud/models/o_auth_client_entity_listing.rb +17 -17
- data/lib/purecloud/models/o_auth_provider_entity_listing.rb +17 -17
- data/lib/purecloud/models/organization_presence_entity_listing.rb +17 -17
- data/lib/purecloud/models/organization_role_entity_listing.rb +17 -17
- data/lib/purecloud/models/orphan_recording_listing.rb +17 -17
- data/lib/purecloud/models/out_of_office_notification.rb +1 -1
- data/lib/purecloud/models/outbound_route_entity_listing.rb +17 -17
- data/lib/purecloud/models/page.rb +243 -0
- data/lib/purecloud/models/participant.rb +1 -1
- data/lib/purecloud/models/permission_collection_entity_listing.rb +17 -17
- data/lib/purecloud/models/phone_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/phone_entity_listing.rb +17 -17
- data/lib/purecloud/models/phone_meta_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/physical_interface_entity_listing.rb +17 -17
- data/lib/purecloud/models/policy_entity_listing.rb +17 -17
- data/lib/purecloud/models/quality_audit_page.rb +17 -17
- data/lib/purecloud/models/queue_email_address.rb +1 -1
- data/lib/purecloud/models/queue_entity_listing.rb +17 -17
- data/lib/purecloud/models/queue_member_entity_listing.rb +17 -17
- data/lib/purecloud/models/recording_data_notification.rb +345 -0
- data/lib/purecloud/models/recording_data_notification_conversation_data.rb +165 -0
- data/lib/purecloud/models/recording_data_notification_lock_data.rb +185 -0
- data/lib/purecloud/models/recording_data_notification_lock_info.rb +185 -0
- data/lib/purecloud/models/recording_data_notification_user_data.rb +175 -0
- data/lib/purecloud/models/recording_data_notification_workspace_data.rb +165 -0
- data/lib/purecloud/models/report_meta_data_entity_listing.rb +17 -17
- data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +17 -17
- data/lib/purecloud/models/report_schedule_entity_listing.rb +17 -17
- data/lib/purecloud/models/response_entity_list.rb +17 -17
- data/lib/purecloud/models/response_entity_listing.rb +17 -17
- data/lib/purecloud/models/response_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/rule_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/schema_category_entity_listing.rb +17 -17
- data/lib/purecloud/models/schema_reference_entity_listing.rb +17 -17
- data/lib/purecloud/models/screen_recording_session_listing.rb +17 -17
- data/lib/purecloud/models/screen_share_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/screen_share_conversation_notification_screen_share_media_participant.rb +1 -1
- data/lib/purecloud/models/screenshare.rb +2 -2
- data/lib/purecloud/models/script.rb +303 -0
- data/lib/purecloud/models/script_entity_listing.rb +257 -0
- data/lib/purecloud/models/search_aggregation.rb +1 -1
- data/lib/purecloud/models/search_criteria.rb +1 -1
- data/lib/purecloud/models/security_profile_entity_listing.rb +17 -17
- data/lib/purecloud/models/share_entity_listing.rb +17 -17
- data/lib/purecloud/models/site_entity_listing.rb +17 -17
- data/lib/purecloud/models/skill_entity_listing.rb +17 -17
- data/lib/purecloud/models/social_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/social_conversation_notification_social_media_participant.rb +1 -1
- data/lib/purecloud/models/social_expression.rb +2 -2
- data/lib/purecloud/models/station_entity_listing.rb +17 -17
- data/lib/purecloud/models/tag_value_entity_listing.rb +17 -17
- data/lib/purecloud/models/time_off_request.rb +369 -0
- data/lib/purecloud/models/time_off_request_list.rb +199 -0
- data/lib/purecloud/models/time_off_request_patch.rb +167 -0
- data/lib/purecloud/models/time_zone_entity_listing.rb +17 -17
- data/lib/purecloud/models/trunk_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/trunk_entity_listing.rb +17 -17
- data/lib/purecloud/models/trunk_metabase_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_details_query.rb +262 -0
- data/lib/purecloud/models/user_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_queue_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_recording_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_schedule_adherence.rb +3 -3
- data/lib/purecloud/models/user_skill_entity_listing.rb +17 -17
- data/lib/purecloud/models/users_entity_listing.rb +17 -17
- data/lib/purecloud/models/video.rb +2 -2
- data/lib/purecloud/models/video_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/video_conversation_notification_video_media_participant.rb +1 -1
- data/lib/purecloud/models/workspace_entity_listing.rb +17 -17
- data/lib/purecloud/models/workspace_member_entity_listing.rb +17 -17
- data/lib/purecloud/models/wrapup_code_entity_listing.rb +17 -17
- data/lib/purecloud/version.rb +1 -1
- data/newVersion.md +1 -1
- data/swagger.json +1 -1
- data/version.json +1 -1
- metadata +66 -8
|
@@ -1178,6 +1178,66 @@ module PureCloud
|
|
|
1178
1178
|
return data, status_code, headers
|
|
1179
1179
|
end
|
|
1180
1180
|
|
|
1181
|
+
# Query for user details
|
|
1182
|
+
#
|
|
1183
|
+
# @param body query
|
|
1184
|
+
# @param [Hash] opts the optional parameters
|
|
1185
|
+
# @return [AnalyticsUserDetailsQueryResponse]
|
|
1186
|
+
def post_users_details_query(body, opts = {})
|
|
1187
|
+
data, status_code, headers = post_users_details_query_with_http_info(body, opts)
|
|
1188
|
+
return data
|
|
1189
|
+
end
|
|
1190
|
+
|
|
1191
|
+
# Query for user details
|
|
1192
|
+
#
|
|
1193
|
+
# @param body query
|
|
1194
|
+
# @param [Hash] opts the optional parameters
|
|
1195
|
+
# @return [Array<(AnalyticsUserDetailsQueryResponse, Fixnum, Hash)>] AnalyticsUserDetailsQueryResponse data, response status code and response headers
|
|
1196
|
+
def post_users_details_query_with_http_info(body, opts = {})
|
|
1197
|
+
if @api_client.config.debugging
|
|
1198
|
+
@api_client.config.logger.debug "Calling API: AnalyticsApi#post_users_details_query ..."
|
|
1199
|
+
end
|
|
1200
|
+
|
|
1201
|
+
# verify the required parameter 'body' is set
|
|
1202
|
+
fail "Missing the required parameter 'body' when calling post_users_details_query" if body.nil?
|
|
1203
|
+
|
|
1204
|
+
# resource path
|
|
1205
|
+
local_var_path = "/api/v2/analytics/users/details/query".sub('{format}','json')
|
|
1206
|
+
|
|
1207
|
+
# query parameters
|
|
1208
|
+
query_params = {}
|
|
1209
|
+
|
|
1210
|
+
# header parameters
|
|
1211
|
+
header_params = {}
|
|
1212
|
+
|
|
1213
|
+
# HTTP header 'Accept' (if needed)
|
|
1214
|
+
_header_accept = ['application/json']
|
|
1215
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
1216
|
+
|
|
1217
|
+
# HTTP header 'Content-Type'
|
|
1218
|
+
_header_content_type = ['application/json']
|
|
1219
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
1220
|
+
|
|
1221
|
+
# form parameters
|
|
1222
|
+
form_params = {}
|
|
1223
|
+
|
|
1224
|
+
# http body (model)
|
|
1225
|
+
post_body = @api_client.object_to_http_body(body)
|
|
1226
|
+
|
|
1227
|
+
auth_names = ['PureCloud Auth']
|
|
1228
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
1229
|
+
:header_params => header_params,
|
|
1230
|
+
:query_params => query_params,
|
|
1231
|
+
:form_params => form_params,
|
|
1232
|
+
:body => post_body,
|
|
1233
|
+
:auth_names => auth_names,
|
|
1234
|
+
:return_type => 'AnalyticsUserDetailsQueryResponse')
|
|
1235
|
+
if @api_client.config.debugging
|
|
1236
|
+
@api_client.config.logger.debug "API called: AnalyticsApi#post_users_details_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1237
|
+
end
|
|
1238
|
+
return data, status_code, headers
|
|
1239
|
+
end
|
|
1240
|
+
|
|
1181
1241
|
# Query for user observations
|
|
1182
1242
|
#
|
|
1183
1243
|
# @param body query
|
|
@@ -1390,6 +1390,81 @@ module PureCloud
|
|
|
1390
1390
|
return data, status_code, headers
|
|
1391
1391
|
end
|
|
1392
1392
|
|
|
1393
|
+
# Get a list of documents.
|
|
1394
|
+
#
|
|
1395
|
+
# @param workspace_id Workspace ID
|
|
1396
|
+
# @param [Hash] opts the optional parameters
|
|
1397
|
+
# @option opts [Array<String>] :expand Which fields, if any, to expand.
|
|
1398
|
+
# @option opts [Integer] :page_size Page size (default to 25)
|
|
1399
|
+
# @option opts [Integer] :page_number Page number (default to 1)
|
|
1400
|
+
# @option opts [String] :sort_by name or dateCreated
|
|
1401
|
+
# @option opts [String] :sort_order ascending or descending (default to ascending)
|
|
1402
|
+
# @return [DocumentEntityListing]
|
|
1403
|
+
def get_workspaces_workspace_id_documents(workspace_id, opts = {})
|
|
1404
|
+
data, status_code, headers = get_workspaces_workspace_id_documents_with_http_info(workspace_id, opts)
|
|
1405
|
+
return data
|
|
1406
|
+
end
|
|
1407
|
+
|
|
1408
|
+
# Get a list of documents.
|
|
1409
|
+
#
|
|
1410
|
+
# @param workspace_id Workspace ID
|
|
1411
|
+
# @param [Hash] opts the optional parameters
|
|
1412
|
+
# @option opts [Array<String>] :expand Which fields, if any, to expand.
|
|
1413
|
+
# @option opts [Integer] :page_size Page size
|
|
1414
|
+
# @option opts [Integer] :page_number Page number
|
|
1415
|
+
# @option opts [String] :sort_by name or dateCreated
|
|
1416
|
+
# @option opts [String] :sort_order ascending or descending
|
|
1417
|
+
# @return [Array<(DocumentEntityListing, Fixnum, Hash)>] DocumentEntityListing data, response status code and response headers
|
|
1418
|
+
def get_workspaces_workspace_id_documents_with_http_info(workspace_id, opts = {})
|
|
1419
|
+
if @api_client.config.debugging
|
|
1420
|
+
@api_client.config.logger.debug "Calling API: ContentManagementApi#get_workspaces_workspace_id_documents ..."
|
|
1421
|
+
end
|
|
1422
|
+
|
|
1423
|
+
# verify the required parameter 'workspace_id' is set
|
|
1424
|
+
fail "Missing the required parameter 'workspace_id' when calling get_workspaces_workspace_id_documents" if workspace_id.nil?
|
|
1425
|
+
|
|
1426
|
+
# resource path
|
|
1427
|
+
local_var_path = "/api/v2/contentmanagement/workspaces/{workspaceId}/documents".sub('{format}','json').sub('{' + 'workspaceId' + '}', workspace_id.to_s)
|
|
1428
|
+
|
|
1429
|
+
# query parameters
|
|
1430
|
+
query_params = {}
|
|
1431
|
+
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
|
|
1432
|
+
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
|
1433
|
+
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
|
1434
|
+
query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
|
|
1435
|
+
query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
|
|
1436
|
+
|
|
1437
|
+
# header parameters
|
|
1438
|
+
header_params = {}
|
|
1439
|
+
|
|
1440
|
+
# HTTP header 'Accept' (if needed)
|
|
1441
|
+
_header_accept = ['application/json']
|
|
1442
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
1443
|
+
|
|
1444
|
+
# HTTP header 'Content-Type'
|
|
1445
|
+
_header_content_type = ['application/json']
|
|
1446
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
1447
|
+
|
|
1448
|
+
# form parameters
|
|
1449
|
+
form_params = {}
|
|
1450
|
+
|
|
1451
|
+
# http body (model)
|
|
1452
|
+
post_body = nil
|
|
1453
|
+
|
|
1454
|
+
auth_names = ['PureCloud Auth']
|
|
1455
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
1456
|
+
:header_params => header_params,
|
|
1457
|
+
:query_params => query_params,
|
|
1458
|
+
:form_params => form_params,
|
|
1459
|
+
:body => post_body,
|
|
1460
|
+
:auth_names => auth_names,
|
|
1461
|
+
:return_type => 'DocumentEntityListing')
|
|
1462
|
+
if @api_client.config.debugging
|
|
1463
|
+
@api_client.config.logger.debug "API called: ContentManagementApi#get_workspaces_workspace_id_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1464
|
+
end
|
|
1465
|
+
return data, status_code, headers
|
|
1466
|
+
end
|
|
1467
|
+
|
|
1393
1468
|
# Get a list workspace members
|
|
1394
1469
|
#
|
|
1395
1470
|
# @param workspace_id Workspace ID
|
|
@@ -280,6 +280,7 @@ module PureCloud
|
|
|
280
280
|
# @option opts [Integer] :page_size Page size (default to 25)
|
|
281
281
|
# @option opts [Integer] :page_number Page number (default to 1)
|
|
282
282
|
# @option opts [String] :sort_order Ascending or descending sort order (default to ASC)
|
|
283
|
+
# @option opts [Array<String>] :expand Which fields, if any, to expand
|
|
283
284
|
# @return [UserEntityListing]
|
|
284
285
|
def get_group_id_members(group_id, opts = {})
|
|
285
286
|
data, status_code, headers = get_group_id_members_with_http_info(group_id, opts)
|
|
@@ -293,6 +294,7 @@ module PureCloud
|
|
|
293
294
|
# @option opts [Integer] :page_size Page size
|
|
294
295
|
# @option opts [Integer] :page_number Page number
|
|
295
296
|
# @option opts [String] :sort_order Ascending or descending sort order
|
|
297
|
+
# @option opts [Array<String>] :expand Which fields, if any, to expand
|
|
296
298
|
# @return [Array<(UserEntityListing, Fixnum, Hash)>] UserEntityListing data, response status code and response headers
|
|
297
299
|
def get_group_id_members_with_http_info(group_id, opts = {})
|
|
298
300
|
if @api_client.config.debugging
|
|
@@ -314,6 +316,7 @@ module PureCloud
|
|
|
314
316
|
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
|
315
317
|
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
|
316
318
|
query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
|
|
319
|
+
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
|
|
317
320
|
|
|
318
321
|
# header parameters
|
|
319
322
|
header_params = {}
|
|
@@ -779,8 +779,8 @@ module PureCloud
|
|
|
779
779
|
@api_client.config.logger.debug "Calling API: OutboundApi#get_attemptlimits ..."
|
|
780
780
|
end
|
|
781
781
|
|
|
782
|
-
if opts[:'filter_type'] && !['
|
|
783
|
-
fail 'invalid value for "filter_type", must be one of
|
|
782
|
+
if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
|
|
783
|
+
fail 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
|
|
784
784
|
end
|
|
785
785
|
|
|
786
786
|
if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
|
|
@@ -920,8 +920,8 @@ module PureCloud
|
|
|
920
920
|
@api_client.config.logger.debug "Calling API: OutboundApi#get_callabletimesets ..."
|
|
921
921
|
end
|
|
922
922
|
|
|
923
|
-
if opts[:'filter_type'] && !['
|
|
924
|
-
fail 'invalid value for "filter_type", must be one of
|
|
923
|
+
if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
|
|
924
|
+
fail 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
|
|
925
925
|
end
|
|
926
926
|
|
|
927
927
|
if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
|
|
@@ -1061,8 +1061,8 @@ module PureCloud
|
|
|
1061
1061
|
@api_client.config.logger.debug "Calling API: OutboundApi#get_callanalysisresponsesets ..."
|
|
1062
1062
|
end
|
|
1063
1063
|
|
|
1064
|
-
if opts[:'filter_type'] && !['
|
|
1065
|
-
fail 'invalid value for "filter_type", must be one of
|
|
1064
|
+
if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
|
|
1065
|
+
fail 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
|
|
1066
1066
|
end
|
|
1067
1067
|
|
|
1068
1068
|
if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
|
|
@@ -1212,8 +1212,8 @@ module PureCloud
|
|
|
1212
1212
|
@api_client.config.logger.debug "Calling API: OutboundApi#get_campaigns ..."
|
|
1213
1213
|
end
|
|
1214
1214
|
|
|
1215
|
-
if opts[:'filter_type'] && !['
|
|
1216
|
-
fail 'invalid value for "filter_type", must be one of
|
|
1215
|
+
if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
|
|
1216
|
+
fail 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
|
|
1217
1217
|
end
|
|
1218
1218
|
|
|
1219
1219
|
if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
|
|
@@ -1602,8 +1602,8 @@ module PureCloud
|
|
|
1602
1602
|
@api_client.config.logger.debug "Calling API: OutboundApi#get_contactlists ..."
|
|
1603
1603
|
end
|
|
1604
1604
|
|
|
1605
|
-
if opts[:'filter_type'] && !['
|
|
1606
|
-
fail 'invalid value for "filter_type", must be one of
|
|
1605
|
+
if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
|
|
1606
|
+
fail 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
|
|
1607
1607
|
end
|
|
1608
1608
|
|
|
1609
1609
|
if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
|
|
@@ -1943,8 +1943,8 @@ module PureCloud
|
|
|
1943
1943
|
@api_client.config.logger.debug "Calling API: OutboundApi#get_dnclists ..."
|
|
1944
1944
|
end
|
|
1945
1945
|
|
|
1946
|
-
if opts[:'filter_type'] && !['
|
|
1947
|
-
fail 'invalid value for "filter_type", must be one of
|
|
1946
|
+
if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
|
|
1947
|
+
fail 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
|
|
1948
1948
|
end
|
|
1949
1949
|
|
|
1950
1950
|
if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
|
|
@@ -2215,8 +2215,8 @@ module PureCloud
|
|
|
2215
2215
|
@api_client.config.logger.debug "Calling API: OutboundApi#get_rulesets ..."
|
|
2216
2216
|
end
|
|
2217
2217
|
|
|
2218
|
-
if opts[:'filter_type'] && !['
|
|
2219
|
-
fail 'invalid value for "filter_type", must be one of
|
|
2218
|
+
if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
|
|
2219
|
+
fail 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
|
|
2220
2220
|
end
|
|
2221
2221
|
|
|
2222
2222
|
if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
|
|
@@ -2586,8 +2586,8 @@ module PureCloud
|
|
|
2586
2586
|
@api_client.config.logger.debug "Calling API: OutboundApi#get_sequences ..."
|
|
2587
2587
|
end
|
|
2588
2588
|
|
|
2589
|
-
if opts[:'filter_type'] && !['
|
|
2590
|
-
fail 'invalid value for "filter_type", must be one of
|
|
2589
|
+
if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
|
|
2590
|
+
fail 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
|
|
2591
2591
|
end
|
|
2592
2592
|
|
|
2593
2593
|
if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
|
|
@@ -28,17 +28,17 @@ module PureCloud
|
|
|
28
28
|
#
|
|
29
29
|
# @param presence_id Organization Presence ID
|
|
30
30
|
# @param [Hash] opts the optional parameters
|
|
31
|
-
# @return [
|
|
31
|
+
# @return [nil]
|
|
32
32
|
def delete_presence_id(presence_id, opts = {})
|
|
33
|
-
|
|
34
|
-
return
|
|
33
|
+
delete_presence_id_with_http_info(presence_id, opts)
|
|
34
|
+
return nil
|
|
35
35
|
end
|
|
36
36
|
|
|
37
37
|
# Delete a Presence Definition
|
|
38
38
|
#
|
|
39
39
|
# @param presence_id Organization Presence ID
|
|
40
40
|
# @param [Hash] opts the optional parameters
|
|
41
|
-
# @return [Array<(
|
|
41
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
42
42
|
def delete_presence_id_with_http_info(presence_id, opts = {})
|
|
43
43
|
if @api_client.config.debugging
|
|
44
44
|
@api_client.config.logger.debug "Calling API: PresenceApi#delete_presence_id ..."
|
|
@@ -76,8 +76,7 @@ module PureCloud
|
|
|
76
76
|
:query_params => query_params,
|
|
77
77
|
:form_params => form_params,
|
|
78
78
|
:body => post_body,
|
|
79
|
-
:auth_names => auth_names
|
|
80
|
-
:return_type => 'OrganizationPresence')
|
|
79
|
+
:auth_names => auth_names)
|
|
81
80
|
if @api_client.config.debugging
|
|
82
81
|
@api_client.config.logger.debug "API called: PresenceApi#delete_presence_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
83
82
|
end
|
|
@@ -278,7 +278,7 @@ module PureCloud
|
|
|
278
278
|
#
|
|
279
279
|
# @param conversation_id Conversation ID
|
|
280
280
|
# @param [Hash] opts the optional parameters
|
|
281
|
-
# @option opts [Integer] :max_wait_ms The maximum number of milliseconds to wait for the recording to be ready. (default to 5000)
|
|
281
|
+
# @option opts [Integer] :max_wait_ms The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value. (default to 5000)
|
|
282
282
|
# @option opts [String] :format_id The desired media format (default to WEBM)
|
|
283
283
|
# @return [Array<Recording>]
|
|
284
284
|
def get_conversation_id_recordings(conversation_id, opts = {})
|
|
@@ -290,7 +290,7 @@ module PureCloud
|
|
|
290
290
|
#
|
|
291
291
|
# @param conversation_id Conversation ID
|
|
292
292
|
# @param [Hash] opts the optional parameters
|
|
293
|
-
# @option opts [Integer] :max_wait_ms The maximum number of milliseconds to wait for the recording to be ready.
|
|
293
|
+
# @option opts [Integer] :max_wait_ms The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value.
|
|
294
294
|
# @option opts [String] :format_id The desired media format
|
|
295
295
|
# @return [Array<(Array<Recording>, Fixnum, Hash)>] Array<Recording> data, response status code and response headers
|
|
296
296
|
def get_conversation_id_recordings_with_http_info(conversation_id, opts = {})
|
|
@@ -0,0 +1,617 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
PureCloud Platform API
|
|
3
|
+
|
|
4
|
+
With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
|
|
5
|
+
|
|
6
|
+
OpenAPI spec version: v2
|
|
7
|
+
Contact: DeveloperEvangelists@inin.com
|
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
|
+
|
|
10
|
+
License: ININ
|
|
11
|
+
http://www.inin.com
|
|
12
|
+
|
|
13
|
+
Terms of Service: https://developer.mypurecloud.com/tos
|
|
14
|
+
|
|
15
|
+
=end
|
|
16
|
+
|
|
17
|
+
require "uri"
|
|
18
|
+
|
|
19
|
+
module PureCloud
|
|
20
|
+
class ScriptsApi
|
|
21
|
+
attr_accessor :api_client
|
|
22
|
+
|
|
23
|
+
def initialize(api_client = ApiClient.default)
|
|
24
|
+
@api_client = api_client
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
# Get the published scripts.
|
|
28
|
+
#
|
|
29
|
+
# @param [Hash] opts the optional parameters
|
|
30
|
+
# @option opts [Integer] :page_size Page size (default to 25)
|
|
31
|
+
# @option opts [Integer] :page_number Page number (default to 1)
|
|
32
|
+
# @option opts [String] :expand Expand
|
|
33
|
+
# @option opts [String] :name Name filter
|
|
34
|
+
# @option opts [String] :feature Feature filter
|
|
35
|
+
# @option opts [String] :flow_id Secure flow id filter
|
|
36
|
+
# @return [ScriptEntityListing]
|
|
37
|
+
def get_published(opts = {})
|
|
38
|
+
data, status_code, headers = get_published_with_http_info(opts)
|
|
39
|
+
return data
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
# Get the published scripts.
|
|
43
|
+
#
|
|
44
|
+
# @param [Hash] opts the optional parameters
|
|
45
|
+
# @option opts [Integer] :page_size Page size
|
|
46
|
+
# @option opts [Integer] :page_number Page number
|
|
47
|
+
# @option opts [String] :expand Expand
|
|
48
|
+
# @option opts [String] :name Name filter
|
|
49
|
+
# @option opts [String] :feature Feature filter
|
|
50
|
+
# @option opts [String] :flow_id Secure flow id filter
|
|
51
|
+
# @return [Array<(ScriptEntityListing, Fixnum, Hash)>] ScriptEntityListing data, response status code and response headers
|
|
52
|
+
def get_published_with_http_info(opts = {})
|
|
53
|
+
if @api_client.config.debugging
|
|
54
|
+
@api_client.config.logger.debug "Calling API: ScriptsApi#get_published ..."
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# resource path
|
|
58
|
+
local_var_path = "/api/v2/scripts/published".sub('{format}','json')
|
|
59
|
+
|
|
60
|
+
# query parameters
|
|
61
|
+
query_params = {}
|
|
62
|
+
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
|
63
|
+
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
|
64
|
+
query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
|
|
65
|
+
query_params[:'name'] = opts[:'name'] if opts[:'name']
|
|
66
|
+
query_params[:'feature'] = opts[:'feature'] if opts[:'feature']
|
|
67
|
+
query_params[:'flowId'] = opts[:'flow_id'] if opts[:'flow_id']
|
|
68
|
+
|
|
69
|
+
# header parameters
|
|
70
|
+
header_params = {}
|
|
71
|
+
|
|
72
|
+
# HTTP header 'Accept' (if needed)
|
|
73
|
+
_header_accept = ['application/json']
|
|
74
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
75
|
+
|
|
76
|
+
# HTTP header 'Content-Type'
|
|
77
|
+
_header_content_type = ['application/json']
|
|
78
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
79
|
+
|
|
80
|
+
# form parameters
|
|
81
|
+
form_params = {}
|
|
82
|
+
|
|
83
|
+
# http body (model)
|
|
84
|
+
post_body = nil
|
|
85
|
+
|
|
86
|
+
auth_names = ['PureCloud Auth']
|
|
87
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
88
|
+
:header_params => header_params,
|
|
89
|
+
:query_params => query_params,
|
|
90
|
+
:form_params => form_params,
|
|
91
|
+
:body => post_body,
|
|
92
|
+
:auth_names => auth_names,
|
|
93
|
+
:return_type => 'ScriptEntityListing')
|
|
94
|
+
if @api_client.config.debugging
|
|
95
|
+
@api_client.config.logger.debug "API called: ScriptsApi#get_published\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
96
|
+
end
|
|
97
|
+
return data, status_code, headers
|
|
98
|
+
end
|
|
99
|
+
|
|
100
|
+
# Get the published script.
|
|
101
|
+
#
|
|
102
|
+
# @param script_id Script ID
|
|
103
|
+
# @param [Hash] opts the optional parameters
|
|
104
|
+
# @return [Script]
|
|
105
|
+
def get_published_script_id(script_id, opts = {})
|
|
106
|
+
data, status_code, headers = get_published_script_id_with_http_info(script_id, opts)
|
|
107
|
+
return data
|
|
108
|
+
end
|
|
109
|
+
|
|
110
|
+
# Get the published script.
|
|
111
|
+
#
|
|
112
|
+
# @param script_id Script ID
|
|
113
|
+
# @param [Hash] opts the optional parameters
|
|
114
|
+
# @return [Array<(Script, Fixnum, Hash)>] Script data, response status code and response headers
|
|
115
|
+
def get_published_script_id_with_http_info(script_id, opts = {})
|
|
116
|
+
if @api_client.config.debugging
|
|
117
|
+
@api_client.config.logger.debug "Calling API: ScriptsApi#get_published_script_id ..."
|
|
118
|
+
end
|
|
119
|
+
|
|
120
|
+
# verify the required parameter 'script_id' is set
|
|
121
|
+
fail "Missing the required parameter 'script_id' when calling get_published_script_id" if script_id.nil?
|
|
122
|
+
|
|
123
|
+
# resource path
|
|
124
|
+
local_var_path = "/api/v2/scripts/published/{scriptId}".sub('{format}','json').sub('{' + 'scriptId' + '}', script_id.to_s)
|
|
125
|
+
|
|
126
|
+
# query parameters
|
|
127
|
+
query_params = {}
|
|
128
|
+
|
|
129
|
+
# header parameters
|
|
130
|
+
header_params = {}
|
|
131
|
+
|
|
132
|
+
# HTTP header 'Accept' (if needed)
|
|
133
|
+
_header_accept = ['application/json']
|
|
134
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
135
|
+
|
|
136
|
+
# HTTP header 'Content-Type'
|
|
137
|
+
_header_content_type = ['application/json']
|
|
138
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
139
|
+
|
|
140
|
+
# form parameters
|
|
141
|
+
form_params = {}
|
|
142
|
+
|
|
143
|
+
# http body (model)
|
|
144
|
+
post_body = nil
|
|
145
|
+
|
|
146
|
+
auth_names = ['PureCloud Auth']
|
|
147
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
148
|
+
:header_params => header_params,
|
|
149
|
+
:query_params => query_params,
|
|
150
|
+
:form_params => form_params,
|
|
151
|
+
:body => post_body,
|
|
152
|
+
:auth_names => auth_names,
|
|
153
|
+
:return_type => 'Script')
|
|
154
|
+
if @api_client.config.debugging
|
|
155
|
+
@api_client.config.logger.debug "API called: ScriptsApi#get_published_script_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
156
|
+
end
|
|
157
|
+
return data, status_code, headers
|
|
158
|
+
end
|
|
159
|
+
|
|
160
|
+
# Get the list of published pages
|
|
161
|
+
#
|
|
162
|
+
# @param script_id Script ID
|
|
163
|
+
# @param [Hash] opts the optional parameters
|
|
164
|
+
# @return [Array<Page>]
|
|
165
|
+
def get_published_script_id_pages(script_id, opts = {})
|
|
166
|
+
data, status_code, headers = get_published_script_id_pages_with_http_info(script_id, opts)
|
|
167
|
+
return data
|
|
168
|
+
end
|
|
169
|
+
|
|
170
|
+
# Get the list of published pages
|
|
171
|
+
#
|
|
172
|
+
# @param script_id Script ID
|
|
173
|
+
# @param [Hash] opts the optional parameters
|
|
174
|
+
# @return [Array<(Array<Page>, Fixnum, Hash)>] Array<Page> data, response status code and response headers
|
|
175
|
+
def get_published_script_id_pages_with_http_info(script_id, opts = {})
|
|
176
|
+
if @api_client.config.debugging
|
|
177
|
+
@api_client.config.logger.debug "Calling API: ScriptsApi#get_published_script_id_pages ..."
|
|
178
|
+
end
|
|
179
|
+
|
|
180
|
+
# verify the required parameter 'script_id' is set
|
|
181
|
+
fail "Missing the required parameter 'script_id' when calling get_published_script_id_pages" if script_id.nil?
|
|
182
|
+
|
|
183
|
+
# resource path
|
|
184
|
+
local_var_path = "/api/v2/scripts/published/{scriptId}/pages".sub('{format}','json').sub('{' + 'scriptId' + '}', script_id.to_s)
|
|
185
|
+
|
|
186
|
+
# query parameters
|
|
187
|
+
query_params = {}
|
|
188
|
+
|
|
189
|
+
# header parameters
|
|
190
|
+
header_params = {}
|
|
191
|
+
|
|
192
|
+
# HTTP header 'Accept' (if needed)
|
|
193
|
+
_header_accept = ['application/json']
|
|
194
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
195
|
+
|
|
196
|
+
# HTTP header 'Content-Type'
|
|
197
|
+
_header_content_type = ['application/json']
|
|
198
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
199
|
+
|
|
200
|
+
# form parameters
|
|
201
|
+
form_params = {}
|
|
202
|
+
|
|
203
|
+
# http body (model)
|
|
204
|
+
post_body = nil
|
|
205
|
+
|
|
206
|
+
auth_names = ['PureCloud Auth']
|
|
207
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
208
|
+
:header_params => header_params,
|
|
209
|
+
:query_params => query_params,
|
|
210
|
+
:form_params => form_params,
|
|
211
|
+
:body => post_body,
|
|
212
|
+
:auth_names => auth_names,
|
|
213
|
+
:return_type => 'Array<Page>')
|
|
214
|
+
if @api_client.config.debugging
|
|
215
|
+
@api_client.config.logger.debug "API called: ScriptsApi#get_published_script_id_pages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
216
|
+
end
|
|
217
|
+
return data, status_code, headers
|
|
218
|
+
end
|
|
219
|
+
|
|
220
|
+
# Get the published page.
|
|
221
|
+
#
|
|
222
|
+
# @param script_id Script ID
|
|
223
|
+
# @param page_id Page ID
|
|
224
|
+
# @param [Hash] opts the optional parameters
|
|
225
|
+
# @return [Page]
|
|
226
|
+
def get_published_script_id_pages_page_id(script_id, page_id, opts = {})
|
|
227
|
+
data, status_code, headers = get_published_script_id_pages_page_id_with_http_info(script_id, page_id, opts)
|
|
228
|
+
return data
|
|
229
|
+
end
|
|
230
|
+
|
|
231
|
+
# Get the published page.
|
|
232
|
+
#
|
|
233
|
+
# @param script_id Script ID
|
|
234
|
+
# @param page_id Page ID
|
|
235
|
+
# @param [Hash] opts the optional parameters
|
|
236
|
+
# @return [Array<(Page, Fixnum, Hash)>] Page data, response status code and response headers
|
|
237
|
+
def get_published_script_id_pages_page_id_with_http_info(script_id, page_id, opts = {})
|
|
238
|
+
if @api_client.config.debugging
|
|
239
|
+
@api_client.config.logger.debug "Calling API: ScriptsApi#get_published_script_id_pages_page_id ..."
|
|
240
|
+
end
|
|
241
|
+
|
|
242
|
+
# verify the required parameter 'script_id' is set
|
|
243
|
+
fail "Missing the required parameter 'script_id' when calling get_published_script_id_pages_page_id" if script_id.nil?
|
|
244
|
+
|
|
245
|
+
# verify the required parameter 'page_id' is set
|
|
246
|
+
fail "Missing the required parameter 'page_id' when calling get_published_script_id_pages_page_id" if page_id.nil?
|
|
247
|
+
|
|
248
|
+
# resource path
|
|
249
|
+
local_var_path = "/api/v2/scripts/published/{scriptId}/pages/{pageId}".sub('{format}','json').sub('{' + 'scriptId' + '}', script_id.to_s).sub('{' + 'pageId' + '}', page_id.to_s)
|
|
250
|
+
|
|
251
|
+
# query parameters
|
|
252
|
+
query_params = {}
|
|
253
|
+
|
|
254
|
+
# header parameters
|
|
255
|
+
header_params = {}
|
|
256
|
+
|
|
257
|
+
# HTTP header 'Accept' (if needed)
|
|
258
|
+
_header_accept = ['application/json']
|
|
259
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
260
|
+
|
|
261
|
+
# HTTP header 'Content-Type'
|
|
262
|
+
_header_content_type = ['application/json']
|
|
263
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
264
|
+
|
|
265
|
+
# form parameters
|
|
266
|
+
form_params = {}
|
|
267
|
+
|
|
268
|
+
# http body (model)
|
|
269
|
+
post_body = nil
|
|
270
|
+
|
|
271
|
+
auth_names = ['PureCloud Auth']
|
|
272
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
273
|
+
:header_params => header_params,
|
|
274
|
+
:query_params => query_params,
|
|
275
|
+
:form_params => form_params,
|
|
276
|
+
:body => post_body,
|
|
277
|
+
:auth_names => auth_names,
|
|
278
|
+
:return_type => 'Page')
|
|
279
|
+
if @api_client.config.debugging
|
|
280
|
+
@api_client.config.logger.debug "API called: ScriptsApi#get_published_script_id_pages_page_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
281
|
+
end
|
|
282
|
+
return data, status_code, headers
|
|
283
|
+
end
|
|
284
|
+
|
|
285
|
+
# Get the published variables
|
|
286
|
+
#
|
|
287
|
+
# @param script_id Script ID
|
|
288
|
+
# @param [Hash] opts the optional parameters
|
|
289
|
+
# @return [Object]
|
|
290
|
+
def get_published_script_id_variables(script_id, opts = {})
|
|
291
|
+
data, status_code, headers = get_published_script_id_variables_with_http_info(script_id, opts)
|
|
292
|
+
return data
|
|
293
|
+
end
|
|
294
|
+
|
|
295
|
+
# Get the published variables
|
|
296
|
+
#
|
|
297
|
+
# @param script_id Script ID
|
|
298
|
+
# @param [Hash] opts the optional parameters
|
|
299
|
+
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
|
300
|
+
def get_published_script_id_variables_with_http_info(script_id, opts = {})
|
|
301
|
+
if @api_client.config.debugging
|
|
302
|
+
@api_client.config.logger.debug "Calling API: ScriptsApi#get_published_script_id_variables ..."
|
|
303
|
+
end
|
|
304
|
+
|
|
305
|
+
# verify the required parameter 'script_id' is set
|
|
306
|
+
fail "Missing the required parameter 'script_id' when calling get_published_script_id_variables" if script_id.nil?
|
|
307
|
+
|
|
308
|
+
# resource path
|
|
309
|
+
local_var_path = "/api/v2/scripts/published/{scriptId}/variables".sub('{format}','json').sub('{' + 'scriptId' + '}', script_id.to_s)
|
|
310
|
+
|
|
311
|
+
# query parameters
|
|
312
|
+
query_params = {}
|
|
313
|
+
|
|
314
|
+
# header parameters
|
|
315
|
+
header_params = {}
|
|
316
|
+
|
|
317
|
+
# HTTP header 'Accept' (if needed)
|
|
318
|
+
_header_accept = ['application/json']
|
|
319
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
320
|
+
|
|
321
|
+
# HTTP header 'Content-Type'
|
|
322
|
+
_header_content_type = ['application/json']
|
|
323
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
324
|
+
|
|
325
|
+
# form parameters
|
|
326
|
+
form_params = {}
|
|
327
|
+
|
|
328
|
+
# http body (model)
|
|
329
|
+
post_body = nil
|
|
330
|
+
|
|
331
|
+
auth_names = ['PureCloud Auth']
|
|
332
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
333
|
+
:header_params => header_params,
|
|
334
|
+
:query_params => query_params,
|
|
335
|
+
:form_params => form_params,
|
|
336
|
+
:body => post_body,
|
|
337
|
+
:auth_names => auth_names,
|
|
338
|
+
:return_type => 'Object')
|
|
339
|
+
if @api_client.config.debugging
|
|
340
|
+
@api_client.config.logger.debug "API called: ScriptsApi#get_published_script_id_variables\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
341
|
+
end
|
|
342
|
+
return data, status_code, headers
|
|
343
|
+
end
|
|
344
|
+
|
|
345
|
+
# Get a script
|
|
346
|
+
#
|
|
347
|
+
# @param script_id Script ID
|
|
348
|
+
# @param [Hash] opts the optional parameters
|
|
349
|
+
# @return [Script]
|
|
350
|
+
def get_script_id(script_id, opts = {})
|
|
351
|
+
data, status_code, headers = get_script_id_with_http_info(script_id, opts)
|
|
352
|
+
return data
|
|
353
|
+
end
|
|
354
|
+
|
|
355
|
+
# Get a script
|
|
356
|
+
#
|
|
357
|
+
# @param script_id Script ID
|
|
358
|
+
# @param [Hash] opts the optional parameters
|
|
359
|
+
# @return [Array<(Script, Fixnum, Hash)>] Script data, response status code and response headers
|
|
360
|
+
def get_script_id_with_http_info(script_id, opts = {})
|
|
361
|
+
if @api_client.config.debugging
|
|
362
|
+
@api_client.config.logger.debug "Calling API: ScriptsApi#get_script_id ..."
|
|
363
|
+
end
|
|
364
|
+
|
|
365
|
+
# verify the required parameter 'script_id' is set
|
|
366
|
+
fail "Missing the required parameter 'script_id' when calling get_script_id" if script_id.nil?
|
|
367
|
+
|
|
368
|
+
# resource path
|
|
369
|
+
local_var_path = "/api/v2/scripts/{scriptId}".sub('{format}','json').sub('{' + 'scriptId' + '}', script_id.to_s)
|
|
370
|
+
|
|
371
|
+
# query parameters
|
|
372
|
+
query_params = {}
|
|
373
|
+
|
|
374
|
+
# header parameters
|
|
375
|
+
header_params = {}
|
|
376
|
+
|
|
377
|
+
# HTTP header 'Accept' (if needed)
|
|
378
|
+
_header_accept = ['application/json']
|
|
379
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
380
|
+
|
|
381
|
+
# HTTP header 'Content-Type'
|
|
382
|
+
_header_content_type = ['application/json']
|
|
383
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
384
|
+
|
|
385
|
+
# form parameters
|
|
386
|
+
form_params = {}
|
|
387
|
+
|
|
388
|
+
# http body (model)
|
|
389
|
+
post_body = nil
|
|
390
|
+
|
|
391
|
+
auth_names = ['PureCloud Auth']
|
|
392
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
393
|
+
:header_params => header_params,
|
|
394
|
+
:query_params => query_params,
|
|
395
|
+
:form_params => form_params,
|
|
396
|
+
:body => post_body,
|
|
397
|
+
:auth_names => auth_names,
|
|
398
|
+
:return_type => 'Script')
|
|
399
|
+
if @api_client.config.debugging
|
|
400
|
+
@api_client.config.logger.debug "API called: ScriptsApi#get_script_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
401
|
+
end
|
|
402
|
+
return data, status_code, headers
|
|
403
|
+
end
|
|
404
|
+
|
|
405
|
+
# Get the list of pages
|
|
406
|
+
#
|
|
407
|
+
# @param script_id Script ID
|
|
408
|
+
# @param [Hash] opts the optional parameters
|
|
409
|
+
# @return [Array<Page>]
|
|
410
|
+
def get_script_id_pages(script_id, opts = {})
|
|
411
|
+
data, status_code, headers = get_script_id_pages_with_http_info(script_id, opts)
|
|
412
|
+
return data
|
|
413
|
+
end
|
|
414
|
+
|
|
415
|
+
# Get the list of pages
|
|
416
|
+
#
|
|
417
|
+
# @param script_id Script ID
|
|
418
|
+
# @param [Hash] opts the optional parameters
|
|
419
|
+
# @return [Array<(Array<Page>, Fixnum, Hash)>] Array<Page> data, response status code and response headers
|
|
420
|
+
def get_script_id_pages_with_http_info(script_id, opts = {})
|
|
421
|
+
if @api_client.config.debugging
|
|
422
|
+
@api_client.config.logger.debug "Calling API: ScriptsApi#get_script_id_pages ..."
|
|
423
|
+
end
|
|
424
|
+
|
|
425
|
+
# verify the required parameter 'script_id' is set
|
|
426
|
+
fail "Missing the required parameter 'script_id' when calling get_script_id_pages" if script_id.nil?
|
|
427
|
+
|
|
428
|
+
# resource path
|
|
429
|
+
local_var_path = "/api/v2/scripts/{scriptId}/pages".sub('{format}','json').sub('{' + 'scriptId' + '}', script_id.to_s)
|
|
430
|
+
|
|
431
|
+
# query parameters
|
|
432
|
+
query_params = {}
|
|
433
|
+
|
|
434
|
+
# header parameters
|
|
435
|
+
header_params = {}
|
|
436
|
+
|
|
437
|
+
# HTTP header 'Accept' (if needed)
|
|
438
|
+
_header_accept = ['application/json']
|
|
439
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
440
|
+
|
|
441
|
+
# HTTP header 'Content-Type'
|
|
442
|
+
_header_content_type = ['application/json']
|
|
443
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
444
|
+
|
|
445
|
+
# form parameters
|
|
446
|
+
form_params = {}
|
|
447
|
+
|
|
448
|
+
# http body (model)
|
|
449
|
+
post_body = nil
|
|
450
|
+
|
|
451
|
+
auth_names = ['PureCloud Auth']
|
|
452
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
453
|
+
:header_params => header_params,
|
|
454
|
+
:query_params => query_params,
|
|
455
|
+
:form_params => form_params,
|
|
456
|
+
:body => post_body,
|
|
457
|
+
:auth_names => auth_names,
|
|
458
|
+
:return_type => 'Array<Page>')
|
|
459
|
+
if @api_client.config.debugging
|
|
460
|
+
@api_client.config.logger.debug "API called: ScriptsApi#get_script_id_pages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
461
|
+
end
|
|
462
|
+
return data, status_code, headers
|
|
463
|
+
end
|
|
464
|
+
|
|
465
|
+
# Get a page
|
|
466
|
+
#
|
|
467
|
+
# @param script_id Script ID
|
|
468
|
+
# @param page_id Page ID
|
|
469
|
+
# @param [Hash] opts the optional parameters
|
|
470
|
+
# @return [Page]
|
|
471
|
+
def get_script_id_pages_page_id(script_id, page_id, opts = {})
|
|
472
|
+
data, status_code, headers = get_script_id_pages_page_id_with_http_info(script_id, page_id, opts)
|
|
473
|
+
return data
|
|
474
|
+
end
|
|
475
|
+
|
|
476
|
+
# Get a page
|
|
477
|
+
#
|
|
478
|
+
# @param script_id Script ID
|
|
479
|
+
# @param page_id Page ID
|
|
480
|
+
# @param [Hash] opts the optional parameters
|
|
481
|
+
# @return [Array<(Page, Fixnum, Hash)>] Page data, response status code and response headers
|
|
482
|
+
def get_script_id_pages_page_id_with_http_info(script_id, page_id, opts = {})
|
|
483
|
+
if @api_client.config.debugging
|
|
484
|
+
@api_client.config.logger.debug "Calling API: ScriptsApi#get_script_id_pages_page_id ..."
|
|
485
|
+
end
|
|
486
|
+
|
|
487
|
+
# verify the required parameter 'script_id' is set
|
|
488
|
+
fail "Missing the required parameter 'script_id' when calling get_script_id_pages_page_id" if script_id.nil?
|
|
489
|
+
|
|
490
|
+
# verify the required parameter 'page_id' is set
|
|
491
|
+
fail "Missing the required parameter 'page_id' when calling get_script_id_pages_page_id" if page_id.nil?
|
|
492
|
+
|
|
493
|
+
# resource path
|
|
494
|
+
local_var_path = "/api/v2/scripts/{scriptId}/pages/{pageId}".sub('{format}','json').sub('{' + 'scriptId' + '}', script_id.to_s).sub('{' + 'pageId' + '}', page_id.to_s)
|
|
495
|
+
|
|
496
|
+
# query parameters
|
|
497
|
+
query_params = {}
|
|
498
|
+
|
|
499
|
+
# header parameters
|
|
500
|
+
header_params = {}
|
|
501
|
+
|
|
502
|
+
# HTTP header 'Accept' (if needed)
|
|
503
|
+
_header_accept = ['application/json']
|
|
504
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
505
|
+
|
|
506
|
+
# HTTP header 'Content-Type'
|
|
507
|
+
_header_content_type = ['application/json']
|
|
508
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
509
|
+
|
|
510
|
+
# form parameters
|
|
511
|
+
form_params = {}
|
|
512
|
+
|
|
513
|
+
# http body (model)
|
|
514
|
+
post_body = nil
|
|
515
|
+
|
|
516
|
+
auth_names = ['PureCloud Auth']
|
|
517
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
518
|
+
:header_params => header_params,
|
|
519
|
+
:query_params => query_params,
|
|
520
|
+
:form_params => form_params,
|
|
521
|
+
:body => post_body,
|
|
522
|
+
:auth_names => auth_names,
|
|
523
|
+
:return_type => 'Page')
|
|
524
|
+
if @api_client.config.debugging
|
|
525
|
+
@api_client.config.logger.debug "API called: ScriptsApi#get_script_id_pages_page_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
526
|
+
end
|
|
527
|
+
return data, status_code, headers
|
|
528
|
+
end
|
|
529
|
+
|
|
530
|
+
# Get the list of scripts
|
|
531
|
+
#
|
|
532
|
+
# @param [Hash] opts the optional parameters
|
|
533
|
+
# @option opts [Integer] :page_size Page size (default to 25)
|
|
534
|
+
# @option opts [Integer] :page_number Page number (default to 1)
|
|
535
|
+
# @option opts [String] :expand Expand
|
|
536
|
+
# @option opts [String] :name Name filter
|
|
537
|
+
# @option opts [String] :feature Feature filter
|
|
538
|
+
# @option opts [String] :flow_id Secure flow id filter
|
|
539
|
+
# @option opts [String] :sort_by SortBy
|
|
540
|
+
# @option opts [String] :sort_order SortOrder
|
|
541
|
+
# @return [ScriptEntityListing]
|
|
542
|
+
def get_scripts(opts = {})
|
|
543
|
+
data, status_code, headers = get_scripts_with_http_info(opts)
|
|
544
|
+
return data
|
|
545
|
+
end
|
|
546
|
+
|
|
547
|
+
# Get the list of scripts
|
|
548
|
+
#
|
|
549
|
+
# @param [Hash] opts the optional parameters
|
|
550
|
+
# @option opts [Integer] :page_size Page size
|
|
551
|
+
# @option opts [Integer] :page_number Page number
|
|
552
|
+
# @option opts [String] :expand Expand
|
|
553
|
+
# @option opts [String] :name Name filter
|
|
554
|
+
# @option opts [String] :feature Feature filter
|
|
555
|
+
# @option opts [String] :flow_id Secure flow id filter
|
|
556
|
+
# @option opts [String] :sort_by SortBy
|
|
557
|
+
# @option opts [String] :sort_order SortOrder
|
|
558
|
+
# @return [Array<(ScriptEntityListing, Fixnum, Hash)>] ScriptEntityListing data, response status code and response headers
|
|
559
|
+
def get_scripts_with_http_info(opts = {})
|
|
560
|
+
if @api_client.config.debugging
|
|
561
|
+
@api_client.config.logger.debug "Calling API: ScriptsApi#get_scripts ..."
|
|
562
|
+
end
|
|
563
|
+
|
|
564
|
+
if opts[:'sort_by'] && !['modifiedDate', 'createdDate'].include?(opts[:'sort_by'])
|
|
565
|
+
fail 'invalid value for "sort_by", must be one of modifiedDate, createdDate'
|
|
566
|
+
end
|
|
567
|
+
|
|
568
|
+
if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
|
|
569
|
+
fail 'invalid value for "sort_order", must be one of ascending, descending'
|
|
570
|
+
end
|
|
571
|
+
|
|
572
|
+
# resource path
|
|
573
|
+
local_var_path = "/api/v2/scripts".sub('{format}','json')
|
|
574
|
+
|
|
575
|
+
# query parameters
|
|
576
|
+
query_params = {}
|
|
577
|
+
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
|
578
|
+
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
|
579
|
+
query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
|
|
580
|
+
query_params[:'name'] = opts[:'name'] if opts[:'name']
|
|
581
|
+
query_params[:'feature'] = opts[:'feature'] if opts[:'feature']
|
|
582
|
+
query_params[:'flowId'] = opts[:'flow_id'] if opts[:'flow_id']
|
|
583
|
+
query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
|
|
584
|
+
query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
|
|
585
|
+
|
|
586
|
+
# header parameters
|
|
587
|
+
header_params = {}
|
|
588
|
+
|
|
589
|
+
# HTTP header 'Accept' (if needed)
|
|
590
|
+
_header_accept = ['application/json']
|
|
591
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
592
|
+
|
|
593
|
+
# HTTP header 'Content-Type'
|
|
594
|
+
_header_content_type = ['application/json']
|
|
595
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
596
|
+
|
|
597
|
+
# form parameters
|
|
598
|
+
form_params = {}
|
|
599
|
+
|
|
600
|
+
# http body (model)
|
|
601
|
+
post_body = nil
|
|
602
|
+
|
|
603
|
+
auth_names = ['PureCloud Auth']
|
|
604
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
605
|
+
:header_params => header_params,
|
|
606
|
+
:query_params => query_params,
|
|
607
|
+
:form_params => form_params,
|
|
608
|
+
:body => post_body,
|
|
609
|
+
:auth_names => auth_names,
|
|
610
|
+
:return_type => 'ScriptEntityListing')
|
|
611
|
+
if @api_client.config.debugging
|
|
612
|
+
@api_client.config.logger.debug "API called: ScriptsApi#get_scripts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
613
|
+
end
|
|
614
|
+
return data, status_code, headers
|
|
615
|
+
end
|
|
616
|
+
end
|
|
617
|
+
end
|