purecloudplatformclientv2 85.0.0 → 89.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/ActionEntityListing.md +1 -1
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/ApiUsageQuery.md +16 -0
- data/docs/ApiUsageQueryResult.md +14 -0
- data/docs/ApiUsageRow.md +25 -0
- data/docs/ArchitectApi.md +132 -0
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AuditApi.md +60 -0
- data/docs/AuditQueryEntity.md +14 -0
- data/docs/AuditQueryExecutionStatusResponse.md +1 -0
- data/docs/AuditQueryRequest.md +1 -0
- data/docs/AuditQueryService.md +14 -0
- data/docs/AuditQueryServiceMapping.md +13 -0
- data/docs/AuditQuerySort.md +14 -0
- data/docs/AuthzDivisionEntityListing.md +1 -1
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/Call.md +1 -0
- data/docs/CallBasic.md +1 -0
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/Callback.md +1 -0
- data/docs/CallbackBasic.md +1 -0
- data/docs/CallbackConversationEntityListing.md +1 -1
- data/docs/CampaignDivisionViewListing.md +1 -1
- data/docs/CampaignEntityListing.md +1 -1
- data/docs/CampaignRuleEntityListing.md +1 -1
- data/docs/CampaignSequenceEntityListing.md +1 -1
- data/docs/CertificateAuthorityEntityListing.md +1 -1
- data/docs/ChatConversationEntityListing.md +1 -1
- data/docs/ClientAppEntityListing.md +1 -1
- data/docs/CoachingAnnotation.md +21 -0
- data/docs/CoachingAnnotationCreateRequest.md +14 -0
- data/docs/CoachingAnnotationList.md +22 -0
- data/docs/CoachingApi.md +1132 -0
- data/docs/CoachingAppointmentReference.md +14 -0
- data/docs/CoachingAppointmentResponse.md +27 -0
- data/docs/CoachingAppointmentResponseList.md +22 -0
- data/docs/CoachingAppointmentStatusDto.md +16 -0
- data/docs/CoachingAppointmentStatusDtoList.md +17 -0
- data/docs/CoachingNotification.md +23 -0
- data/docs/CoachingNotificationList.md +22 -0
- data/docs/CobrowseConversationEntityListing.md +1 -1
- data/docs/Cobrowsesession.md +1 -0
- data/docs/CommandStatusEntityListing.md +1 -1
- data/docs/ConsumedResourcesEntityListing.md +1 -1
- data/docs/ConsumingResourcesEntityListing.md +1 -1
- data/docs/ContactListDivisionViewListing.md +1 -1
- data/docs/ContactListEntityListing.md +1 -1
- data/docs/ContactListFilterEntityListing.md +1 -1
- data/docs/ContactListing.md +1 -1
- data/docs/{PartialUploadResponse.md → ContextEntity.md} +3 -3
- data/docs/ContextIntent.md +13 -0
- data/docs/ConversationCallbackEventTopicCallbackMediaParticipant.md +1 -0
- data/docs/ConversationChat.md +1 -0
- data/docs/ConversationEntityListing.md +1 -1
- data/docs/ConversationEventTopicCall.md +1 -0
- data/docs/ConversationEventTopicCallback.md +2 -0
- data/docs/ConversationEventTopicChat.md +1 -0
- data/docs/ConversationEventTopicCobrowse.md +1 -0
- data/docs/ConversationEventTopicEmail.md +1 -0
- data/docs/ConversationEventTopicMessage.md +1 -0
- data/docs/ConversationEventTopicScreenshare.md +1 -0
- data/docs/ConversationEventTopicSocialExpression.md +1 -0
- data/docs/ConversationEventTopicVideo.md +1 -0
- data/docs/ConversationReference.md +14 -0
- data/docs/Coretype.md +23 -0
- data/docs/CoretypeListing.md +15 -0
- data/docs/CreateCoachingAppointmentRequest.md +20 -0
- data/docs/CreateQueueRequest.md +1 -0
- data/docs/CredentialInfoListing.md +1 -1
- data/docs/CredentialTypeListing.md +1 -1
- data/docs/DIDEntityListing.md +1 -1
- data/docs/DIDPoolEntityListing.md +1 -1
- data/docs/DataExtensionsApi.md +198 -0
- data/docs/DataSchemaListing.md +15 -0
- data/docs/DataTableRowEntityListing.md +1 -1
- data/docs/DataTablesDomainEntityListing.md +1 -1
- data/docs/DependencyObjectEntityListing.md +1 -1
- data/docs/DependencyTypeEntityListing.md +1 -1
- data/docs/DetectedDialogAct.md +14 -0
- data/docs/DetectedIntent.md +15 -0
- data/docs/DetectedNamedEntity.md +16 -0
- data/docs/DetectedNamedEntityValue.md +14 -0
- data/docs/DialerEventEntityListing.md +1 -1
- data/docs/DialogflowAgent.md +3 -2
- data/docs/DialogflowAgentSummaryEntityListing.md +1 -1
- data/docs/DirectoryUserDevicesListing.md +1 -1
- data/docs/DivsPermittedEntityListing.md +1 -1
- data/docs/DncListDivisionViewListing.md +1 -1
- data/docs/DncListEntityListing.md +1 -1
- data/docs/DocumentAuditEntityListing.md +1 -1
- data/docs/DocumentEntityListing.md +1 -1
- data/docs/DocumentReference.md +14 -0
- data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
- data/docs/DomainEntityListing.md +1 -1
- data/docs/DomainEntityListingEvaluationForm.md +1 -1
- data/docs/DomainEntityListingQueryResult.md +1 -1
- data/docs/DomainEntityListingSurveyForm.md +1 -1
- data/docs/Edge.md +1 -1
- data/docs/EdgeEntityListing.md +1 -1
- data/docs/EdgeGroupEntityListing.md +1 -1
- data/docs/EdgeLineEntityListing.md +1 -1
- data/docs/Email.md +1 -0
- data/docs/EmailConversationEntityListing.md +1 -1
- data/docs/EmailMessageListing.md +1 -1
- data/docs/EmergencyGroupListing.md +1 -1
- data/docs/EncryptionKeyEntityListing.md +1 -1
- data/docs/EvaluationEntityListing.md +1 -1
- data/docs/EvaluationFormEntityListing.md +1 -1
- data/docs/EvaluatorActivityEntityListing.md +1 -1
- data/docs/ExtensionEntityListing.md +1 -1
- data/docs/ExtensionPoolEntityListing.md +1 -1
- data/docs/ExternalContact.md +2 -0
- data/docs/ExternalContactsApi.md +1001 -144
- data/docs/ExternalOrganization.md +2 -0
- data/docs/ExternalOrganizationListing.md +1 -1
- data/docs/FacebookIntegrationEntityListing.md +1 -1
- data/docs/FaxDocumentEntityListing.md +1 -1
- data/docs/FlowDivisionView.md +2 -0
- data/docs/FlowDivisionViewEntityListing.md +1 -1
- data/docs/FlowEntityListing.md +1 -1
- data/docs/FlowExecutionLaunchRequest.md +16 -0
- data/docs/FlowExecutionLaunchResponse.md +16 -0
- data/docs/FlowOutcomeListing.md +1 -1
- data/docs/FlowRuntimeExecution.md +23 -0
- data/docs/FlowVersionEntityListing.md +1 -1
- data/docs/GDPRRequestEntityListing.md +1 -1
- data/docs/GDPRSubjectEntityListing.md +1 -1
- data/docs/GenericSAML.md +22 -0
- data/docs/GreetingListing.md +1 -1
- data/docs/GroupEntityListing.md +1 -1
- data/docs/GroupProfileEntityListing.md +1 -1
- data/docs/IVREntityListing.md +1 -1
- data/docs/IdentityProviderApi.md +187 -0
- data/docs/InboundDomainEntityListing.md +1 -1
- data/docs/InboundRouteEntityListing.md +1 -1
- data/docs/IntegrationEntityListing.md +1 -1
- data/docs/IntegrationEventEntityListing.md +1 -1
- data/docs/IntegrationTypeEntityListing.md +1 -1
- data/docs/IntentDefinition.md +15 -0
- data/docs/IntentFeedback.md +16 -0
- data/docs/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/IpAddressAuthentication.md +13 -0
- data/docs/ItemValidationLimits.md +14 -0
- data/docs/Items.md +14 -0
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/KnowledgeSearchResponse.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LanguageUnderstandingApi.md +1160 -0
- data/docs/LexBotAliasEntityListing.md +1 -1
- data/docs/LexBotEntityListing.md +1 -1
- data/docs/LibraryEntityListing.md +1 -1
- data/docs/LineBaseEntityListing.md +1 -1
- data/docs/LineEntityListing.md +1 -1
- data/docs/LineIntegrationEntityListing.md +1 -1
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/MaxLength.md +14 -0
- data/docs/Message.md +1 -0
- data/docs/MessageConversationEntityListing.md +1 -1
- data/docs/MessagingIntegrationEntityListing.md +1 -1
- data/docs/MessagingStickerEntityListing.md +1 -1
- data/docs/MinLength.md +14 -0
- data/docs/NamedEntityAnnotation.md +13 -0
- data/docs/NamedEntityTypeBinding.md +14 -0
- data/docs/NamedEntityTypeDefinition.md +15 -0
- data/docs/NamedEntityTypeItem.md +14 -0
- data/docs/NamedEntityTypeMechanism.md +15 -0
- data/docs/NluConfusionMatrixColumn.md +14 -0
- data/docs/NluConfusionMatrixRow.md +14 -0
- data/docs/NluDetectionContext.md +14 -0
- data/docs/NluDetectionInput.md +13 -0
- data/docs/NluDetectionOutput.md +14 -0
- data/docs/NluDetectionRequest.md +14 -0
- data/docs/NluDetectionResponse.md +15 -0
- data/docs/NluDomain.md +19 -0
- data/docs/NluDomainListing.md +22 -0
- data/docs/NluDomainVersion.md +25 -0
- data/docs/NluDomainVersionListing.md +22 -0
- data/docs/NluDomainVersionQualityReport.md +15 -0
- data/docs/NluDomainVersionTrainingResponse.md +14 -0
- data/docs/NluFeedbackListing.md +22 -0
- data/docs/NluFeedbackRequest.md +15 -0
- data/docs/NluFeedbackResponse.md +18 -0
- data/docs/NluQualityReportSummary.md +13 -0
- data/docs/NluQualityReportSummaryMetric.md +14 -0
- data/docs/NluUtterance.md +13 -0
- data/docs/NluUtteranceSegment.md +14 -0
- data/docs/NoteListing.md +1 -1
- data/docs/OAuthApi.md +208 -0
- data/docs/OAuthClientEntityListing.md +1 -1
- data/docs/OAuthProviderEntityListing.md +1 -1
- data/docs/OrganizationApi.md +126 -0
- data/docs/OrganizationPresenceEntityListing.md +1 -1
- data/docs/OrganizationRoleEntityListing.md +1 -1
- data/docs/OrphanRecordingListing.md +1 -1
- data/docs/OutboundRouteBaseEntityListing.md +1 -1
- data/docs/OutboundRouteEntityListing.md +1 -1
- data/docs/PermissionCollectionEntityListing.md +1 -1
- data/docs/PhoneBaseEntityListing.md +1 -1
- data/docs/PhoneEntityListing.md +1 -1
- data/docs/PhoneMetaBaseEntityListing.md +1 -1
- data/docs/PhysicalInterfaceEntityListing.md +1 -1
- data/docs/PolicyEntityListing.md +1 -1
- data/docs/Prompt.md +2 -2
- data/docs/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- data/docs/QualityAuditPage.md +1 -1
- data/docs/Queue.md +1 -0
- data/docs/QueueConversationCallbackEventTopicCallbackMediaParticipant.md +1 -0
- data/docs/QueueConversationEventTopicCall.md +1 -0
- data/docs/QueueConversationEventTopicCallback.md +2 -0
- data/docs/QueueConversationEventTopicChat.md +1 -0
- data/docs/QueueConversationEventTopicCobrowse.md +1 -0
- data/docs/QueueConversationEventTopicEmail.md +1 -0
- data/docs/QueueConversationEventTopicMessage.md +1 -0
- data/docs/QueueConversationEventTopicScreenshare.md +1 -0
- data/docs/QueueConversationEventTopicSocialExpression.md +1 -0
- data/docs/QueueConversationEventTopicVideo.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicCall.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicCallback.md +2 -0
- data/docs/QueueConversationSocialExpressionEventTopicChat.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicCobrowse.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicEmail.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicMessage.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicScreenshare.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicSocialExpression.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicVideo.md +1 -0
- data/docs/QueueConversationVideoEventTopicCall.md +1 -0
- data/docs/QueueConversationVideoEventTopicCallback.md +2 -0
- data/docs/QueueConversationVideoEventTopicChat.md +1 -0
- data/docs/QueueConversationVideoEventTopicCobrowse.md +1 -0
- data/docs/QueueConversationVideoEventTopicEmail.md +1 -0
- data/docs/QueueConversationVideoEventTopicMessage.md +1 -0
- data/docs/QueueConversationVideoEventTopicScreenshare.md +1 -0
- data/docs/QueueConversationVideoEventTopicSocialExpression.md +1 -0
- data/docs/QueueConversationVideoEventTopicVideo.md +1 -0
- data/docs/QueueEntityListing.md +1 -1
- data/docs/QueueMemberEntityListing.md +1 -1
- data/docs/QueueRequest.md +1 -0
- data/docs/RecipientListing.md +1 -1
- data/docs/RecordingApi.md +12 -0
- data/docs/RecordingJobEntityListing.md +1 -1
- data/docs/RelationshipListing.md +1 -1
- data/docs/ReportMetaDataEntityListing.md +1 -1
- data/docs/ReportRunEntryEntityDomainListing.md +1 -1
- data/docs/ReportScheduleEntityListing.md +1 -1
- data/docs/ReportingExportJobListing.md +1 -1
- data/docs/ReportingExportJobRequest.md +1 -0
- data/docs/ReportingExportJobResponse.md +2 -0
- data/docs/ReportingExportMetadataJobListing.md +1 -1
- data/docs/ResponseEntityList.md +1 -1
- data/docs/ResponseEntityListing.md +1 -1
- data/docs/ResponseSetEntityListing.md +1 -1
- data/docs/RoutingApi.md +65 -0
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/SCIMApi.md +24 -36
- data/docs/ScheduleEntityListing.md +1 -1
- data/docs/ScheduleGroupEntityListing.md +1 -1
- data/docs/Schema.md +17 -0
- data/docs/SchemaCategoryEntityListing.md +1 -1
- data/docs/SchemaQuantityLimits.md +26 -0
- data/docs/SchemaReferenceEntityListing.md +1 -1
- data/docs/ScimV2EnterpriseUser.md +1 -0
- data/docs/ScreenRecordingSessionListing.md +1 -1
- data/docs/Screenshare.md +1 -0
- data/docs/ScriptEntityListing.md +1 -1
- data/docs/SecurityProfileEntityListing.md +1 -1
- data/docs/ShareEntityListing.md +1 -1
- data/docs/SiteEntityListing.md +1 -1
- data/docs/SkillEntityListing.md +1 -1
- data/docs/SmsAddressEntityListing.md +1 -1
- data/docs/SmsPhoneNumberEntityListing.md +1 -1
- data/docs/SocialExpression.md +1 -0
- data/docs/StationEntityListing.md +1 -1
- data/docs/SubjectDivisionGrantsEntityListing.md +1 -1
- data/docs/SurveyFormEntityListing.md +1 -1
- data/docs/SystemPromptAssetEntityListing.md +1 -1
- data/docs/SystemPromptEntityListing.md +1 -1
- data/docs/TagValueEntityListing.md +1 -1
- data/docs/TextMessageListing.md +1 -1
- data/docs/{TimeOffRequestLookup.md → TimeOffRequest.md} +2 -2
- data/docs/TimeOffRequestListing.md +13 -0
- data/docs/TimeZoneEntityListing.md +1 -1
- data/docs/TrunkBaseEntityListing.md +1 -1
- data/docs/TrunkEntityListing.md +1 -1
- data/docs/TrunkMetabaseEntityListing.md +1 -1
- data/docs/TrustEntityListing.md +1 -1
- data/docs/TrustUserEntityListing.md +1 -1
- data/docs/TrustorEntityListing.md +1 -1
- data/docs/TtsEngineEntityListing.md +1 -1
- data/docs/TtsVoiceEntityListing.md +1 -1
- data/docs/TwitterIntegrationEntityListing.md +1 -1
- data/docs/UpdateCoachingAppointmentRequest.md +18 -0
- data/docs/UploadUrlRequest.md +16 -0
- data/docs/UploadUrlResponse.md +14 -0
- data/docs/UploadsApi.md +78 -0
- data/docs/UsageApi.md +144 -0
- data/docs/UsageExecutionResult.md +14 -0
- data/docs/UserActionCategoryEntityListing.md +1 -1
- data/docs/UserAppEntityListing.md +1 -1
- data/docs/UserEntityListing.md +1 -1
- data/docs/UserLanguageEntityListing.md +1 -1
- data/docs/UserProfileEntityListing.md +1 -1
- data/docs/UserQueue.md +1 -0
- data/docs/UserQueueEntityListing.md +1 -1
- data/docs/UserRecordingEntityListing.md +1 -1
- data/docs/UserSkillEntityListing.md +1 -1
- data/docs/ValidationLimits.md +18 -0
- data/docs/Video.md +1 -0
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WebChatMemberInfoEntityList.md +1 -1
- data/docs/WemLearningAssignmentRuleRunTopicLearningAssignmentRuleRunNotification.md +14 -0
- data/docs/WemLearningAssignmentRuleRunTopicLearningModuleReference.md +14 -0
- data/docs/WemLearningAssignmentRuleRunTopicWemLearningAssignmentsCreated.md +13 -0
- data/docs/WemLearningAssignmentTopicLearningAssignmentNotification.md +22 -0
- data/docs/WemLearningAssignmentTopicLearningModuleReference.md +14 -0
- data/docs/WemLearningAssignmentTopicUserReference.md +13 -0
- data/docs/WhatsAppIntegrationEntityListing.md +1 -1
- data/docs/WorkforceManagementApi.md +297 -448
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +85 -57
- data/lib/purecloudplatformclientv2/api/architect_api.rb +130 -0
- data/lib/purecloudplatformclientv2/api/audit_api.rb +55 -0
- data/lib/purecloudplatformclientv2/api/coaching_api.rb +1296 -0
- data/lib/purecloudplatformclientv2/api/data_extensions_api.rb +207 -0
- data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +868 -4
- data/lib/purecloudplatformclientv2/api/identity_provider_api.rb +175 -0
- data/lib/purecloudplatformclientv2/api/language_understanding_api.rb +1304 -0
- data/lib/purecloudplatformclientv2/api/o_auth_api.rb +224 -0
- data/lib/purecloudplatformclientv2/api/organization_api.rb +120 -0
- data/lib/purecloudplatformclientv2/api/recording_api.rb +78 -0
- data/lib/purecloudplatformclientv2/api/routing_api.rb +64 -0
- data/lib/purecloudplatformclientv2/api/scim_api.rb +16 -16
- data/lib/purecloudplatformclientv2/api/uploads_api.rb +92 -0
- data/lib/purecloudplatformclientv2/api/usage_api.rb +157 -0
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +314 -571
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/{intraday_query_data_command.rb → api_usage_query.rb} +45 -67
- data/lib/purecloudplatformclientv2/models/api_usage_query_result.rb +244 -0
- data/lib/purecloudplatformclientv2/models/{reschedule_request.rb → api_usage_row.rb} +182 -86
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/{unscheduled_agent_warning.rb → audit_query_entity.rb} +32 -30
- data/lib/purecloudplatformclientv2/models/audit_query_execution_status_response.rb +32 -4
- data/lib/purecloudplatformclientv2/models/audit_query_request.rb +32 -4
- data/lib/purecloudplatformclientv2/models/{wfm_intraday_queue_listing.rb → audit_query_service.rb} +32 -31
- data/lib/purecloudplatformclientv2/models/{short_term_forecast_list_response.rb → audit_query_service_mapping.rb} +10 -9
- data/lib/purecloudplatformclientv2/models/audit_query_sort.rb +266 -0
- data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/bulk_update_shift_trade_state_result_item.rb +2 -2
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +16 -16
- 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 +16 -16
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/callback.rb +30 -4
- data/lib/purecloudplatformclientv2/models/callback_basic.rb +30 -4
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/{short_term_forecast.rb → coaching_annotation.rb} +73 -105
- data/lib/purecloudplatformclientv2/models/coaching_annotation_create_request.rb +252 -0
- data/lib/purecloudplatformclientv2/models/coaching_annotation_list.rb +428 -0
- data/lib/purecloudplatformclientv2/models/coaching_appointment_reference.rb +228 -0
- data/lib/purecloudplatformclientv2/models/coaching_appointment_response.rb +587 -0
- data/lib/purecloudplatformclientv2/models/coaching_appointment_response_list.rb +428 -0
- data/lib/purecloudplatformclientv2/models/{generate_short_term_forecast_response.rb → coaching_appointment_status_dto.rb} +49 -44
- data/lib/purecloudplatformclientv2/models/{wfm_forecast_modification_attributes.rb → coaching_appointment_status_dto_list.rb} +52 -37
- data/lib/purecloudplatformclientv2/models/coaching_notification.rb +504 -0
- data/lib/purecloudplatformclientv2/models/coaching_notification_list.rb +428 -0
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/cobrowsesession.rb +30 -4
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/{list_wrapper_wfm_forecast_modification.rb → context_entity.rb} +14 -10
- data/lib/purecloudplatformclientv2/models/{list_wrapper_forecast_source_day_pointer.rb → context_intent.rb} +14 -10
- data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_callback_event_topic_callback_media_participant.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_chat.rb +32 -6
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_call.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb +51 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_cobrowse.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_message.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_screenshare.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_social_expression.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_video.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_reference.rb +228 -0
- data/lib/purecloudplatformclientv2/models/coretype.rb +465 -0
- data/lib/purecloudplatformclientv2/models/coretype_listing.rb +253 -0
- data/lib/purecloudplatformclientv2/models/{intraday_historical_queue_data.rb → create_coaching_appointment_request.rb} +100 -58
- data/lib/purecloudplatformclientv2/models/create_queue_request.rb +29 -1
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/data_schema_listing.rb +253 -0
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/{forecast_result_response.rb → detected_dialog_act.rb} +16 -16
- data/lib/purecloudplatformclientv2/models/{intraday_queue.rb → detected_intent.rb} +23 -23
- data/lib/purecloudplatformclientv2/models/{create_queue_media_association_request.rb → detected_named_entity.rb} +49 -26
- data/lib/purecloudplatformclientv2/models/detected_named_entity_value.rb +228 -0
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/dialogflow_agent.rb +31 -3
- data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/{user_schedules_partial_upload_request.rb → document_reference.rb} +34 -16
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +16 -16
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +16 -16
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +16 -16
- data/lib/purecloudplatformclientv2/models/edge.rb +1 -0
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/email.rb +30 -4
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/external_contact.rb +55 -1
- data/lib/purecloudplatformclientv2/models/external_organization.rb +55 -1
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/flow_division_view.rb +53 -1
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/{queue_media_association.rb → flow_execution_launch_request.rb} +37 -32
- data/lib/purecloudplatformclientv2/models/{create_service_goal_group_request.rb → flow_execution_launch_response.rb} +43 -24
- data/lib/purecloudplatformclientv2/models/flow_outcome_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/{rescheduling_options_response.rb → flow_runtime_execution.rb} +120 -96
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/generic_saml.rb +428 -0
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/{service_goal_group_goals.rb → intent_definition.rb} +34 -26
- data/lib/purecloudplatformclientv2/models/intent_feedback.rb +296 -0
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +16 -16
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +16 -16
- data/lib/purecloudplatformclientv2/models/ip_address_authentication.rb +203 -0
- data/lib/purecloudplatformclientv2/models/item_validation_limits.rb +238 -0
- data/lib/purecloudplatformclientv2/models/{time_off_request_entity_list.rb → items.rb} +33 -10
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/knowledge_search_response.rb +18 -18
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/lex_bot_alias_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/lex_bot_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/max_length.rb +238 -0
- data/lib/purecloudplatformclientv2/models/message.rb +30 -4
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/messaging_integration_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/{forecast_generation_route_group_result.rb → min_length.rb} +26 -18
- data/lib/purecloudplatformclientv2/models/{scheduling_run_list_response.rb → named_entity_annotation.rb} +14 -10
- data/lib/purecloudplatformclientv2/models/{copy_short_term_forecast_request.rb → named_entity_type_binding.rb} +18 -19
- data/lib/purecloudplatformclientv2/models/{generate_week_schedule_request.rb → named_entity_type_definition.rb} +38 -13
- data/lib/purecloudplatformclientv2/models/{wfm_abandon_rate.rb → named_entity_type_item.rb} +19 -18
- data/lib/purecloudplatformclientv2/models/{short_term_forecast_response.rb → named_entity_type_mechanism.rb} +48 -36
- data/lib/purecloudplatformclientv2/models/{copy_week_schedule_request.rb → nlu_confusion_matrix_column.rb} +18 -18
- data/lib/purecloudplatformclientv2/models/{wfm_average_speed_of_answer.rb → nlu_confusion_matrix_row.rb} +24 -18
- data/lib/purecloudplatformclientv2/models/nlu_detection_context.rb +228 -0
- data/lib/purecloudplatformclientv2/models/nlu_detection_input.rb +207 -0
- data/lib/purecloudplatformclientv2/models/nlu_detection_output.rb +232 -0
- data/lib/purecloudplatformclientv2/models/nlu_detection_request.rb +233 -0
- data/lib/purecloudplatformclientv2/models/{route_group_list.rb → nlu_detection_response.rb} +39 -22
- data/lib/purecloudplatformclientv2/models/{short_term_forecast_list_item_response.rb → nlu_domain.rb} +66 -60
- data/lib/purecloudplatformclientv2/models/nlu_domain_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/{update_week_schedule_request.rb → nlu_domain_version.rb} +187 -79
- data/lib/purecloudplatformclientv2/models/nlu_domain_version_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/{intraday_metric.rb → nlu_domain_version_quality_report.rb} +57 -28
- data/lib/purecloudplatformclientv2/models/nlu_domain_version_training_response.rb +227 -0
- data/lib/purecloudplatformclientv2/models/nlu_feedback_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/{wfm_service_level.rb → nlu_feedback_request.rb} +36 -25
- data/lib/purecloudplatformclientv2/models/{service_goal_group.rb → nlu_feedback_response.rb} +32 -37
- data/lib/purecloudplatformclientv2/models/{generate_short_term_forecast_request.rb → nlu_quality_report_summary.rb} +12 -10
- data/lib/purecloudplatformclientv2/models/nlu_quality_report_summary_metric.rb +238 -0
- data/lib/purecloudplatformclientv2/models/nlu_utterance.rb +209 -0
- data/lib/purecloudplatformclientv2/models/nlu_utterance_segment.rb +233 -0
- data/lib/purecloudplatformclientv2/models/note_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/prompt.rb +2 -0
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +16 -16
- data/lib/purecloudplatformclientv2/models/queue.rb +29 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_callback_event_topic_callback_media_participant.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_call.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_callback.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_cobrowse.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_message.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_screenshare.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_social_expression.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_video.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_call.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_callback.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_cobrowse.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_screenshare.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_social_expression.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_video.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_call.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_callback.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_cobrowse.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_message.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_screenshare.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_social_expression.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_video.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/queue_request.rb +29 -1
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/recording_job_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +32 -4
- data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +57 -1
- data/lib/purecloudplatformclientv2/models/reporting_export_metadata_job_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +16 -16
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/{import_short_term_forecast_request.rb → schema.rb} +50 -35
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/schema_quantity_limits.rb +539 -0
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/scim_v2_enterprise_user.rb +30 -4
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/screenshare.rb +30 -4
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/shift_trade_match_violation.rb +2 -2
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/sms_address_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/social_expression.rb +30 -4
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/{time_off_request_lookup.rb → time_off_request.rb} +1 -1
- data/lib/purecloudplatformclientv2/models/{time_off_request_lookup_list.rb → time_off_request_listing.rb} +2 -2
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/tts_engine_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/tts_voice_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/{import_week_schedule_request.rb → update_coaching_appointment_request.rb} +60 -39
- data/lib/purecloudplatformclientv2/models/{route_group_attributes.rb → upload_url_request.rb} +43 -57
- data/lib/purecloudplatformclientv2/models/upload_url_response.rb +230 -0
- data/lib/purecloudplatformclientv2/models/usage_execution_result.rb +228 -0
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/user_app_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/user_queue.rb +29 -1
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/validation_limits.rb +326 -0
- data/lib/purecloudplatformclientv2/models/video.rb +30 -4
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +16 -16
- data/lib/purecloudplatformclientv2/models/{service_goal_group_list.rb → wem_learning_assignment_rule_run_topic_learning_assignment_rule_run_notification.rb} +9 -11
- data/lib/purecloudplatformclientv2/models/wem_learning_assignment_rule_run_topic_learning_module_reference.rb +226 -0
- data/lib/purecloudplatformclientv2/models/wem_learning_assignment_rule_run_topic_wem_learning_assignments_created.rb +201 -0
- data/lib/purecloudplatformclientv2/models/wem_learning_assignment_topic_learning_assignment_notification.rb +440 -0
- data/lib/purecloudplatformclientv2/models/{intraday_performance_prediction_agent_data.rb → wem_learning_assignment_topic_learning_module_reference.rb} +33 -9
- data/lib/purecloudplatformclientv2/models/{partial_upload_response.rb → wem_learning_assignment_topic_user_reference.rb} +1 -2
- data/lib/purecloudplatformclientv2/models/whats_app_integration_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +172 -116
- data/docs/AsyncWeekScheduleResponse.md +0 -16
- data/docs/CopyShortTermForecastRequest.md +0 -14
- data/docs/CopyWeekScheduleRequest.md +0 -14
- data/docs/CreateQueueMediaAssociationRequest.md +0 -15
- data/docs/CreateServiceGoalGroupRequest.md +0 -15
- data/docs/ForecastGenerationResult.md +0 -13
- data/docs/ForecastGenerationRouteGroupResult.md +0 -14
- data/docs/ForecastResultResponse.md +0 -14
- data/docs/ForecastTimeSeriesResult.md +0 -14
- data/docs/GenerateShortTermForecastRequest.md +0 -13
- data/docs/GenerateShortTermForecastResponse.md +0 -16
- data/docs/GenerateWeekScheduleRequest.md +0 -14
- data/docs/GenerateWeekScheduleResponse.md +0 -15
- data/docs/ImportShortTermForecastRequest.md +0 -16
- data/docs/ImportWeekScheduleRequest.md +0 -17
- data/docs/IntradayDataGroup.md +0 -19
- data/docs/IntradayForecastData.md +0 -15
- data/docs/IntradayHistoricalAgentData.md +0 -14
- data/docs/IntradayHistoricalQueueData.md +0 -20
- data/docs/IntradayMetric.md +0 -14
- data/docs/IntradayPerformancePredictionAgentData.md +0 -13
- data/docs/IntradayPerformancePredictionQueueData.md +0 -15
- data/docs/IntradayQueryDataCommand.md +0 -17
- data/docs/IntradayQueue.md +0 -15
- data/docs/IntradayResponse.md +0 -20
- data/docs/IntradayScheduleData.md +0 -14
- data/docs/ListWrapperForecastSourceDayPointer.md +0 -13
- data/docs/ListWrapperWfmForecastModification.md +0 -13
- data/docs/QueueMediaAssociation.md +0 -16
- data/docs/RescheduleRequest.md +0 -20
- data/docs/RescheduleResult.md +0 -13
- data/docs/ReschedulingOptionsResponse.md +0 -22
- data/docs/RouteGroup.md +0 -18
- data/docs/RouteGroupAttributes.md +0 -16
- data/docs/RouteGroupList.md +0 -14
- data/docs/SchedulingRunListResponse.md +0 -13
- data/docs/SchedulingRunResponse.md +0 -28
- data/docs/ServiceGoalGroup.md +0 -18
- data/docs/ServiceGoalGroupGoals.md +0 -15
- data/docs/ServiceGoalGroupList.md +0 -14
- data/docs/ShortTermForecast.md +0 -22
- data/docs/ShortTermForecastListItemResponse.md +0 -18
- data/docs/ShortTermForecastListResponse.md +0 -13
- data/docs/ShortTermForecastResponse.md +0 -15
- data/docs/TimeOffRequestEntityList.md +0 -13
- data/docs/TimeOffRequestLookupList.md +0 -13
- data/docs/UnscheduledAgentWarning.md +0 -14
- data/docs/UpdateWeekScheduleRequest.md +0 -21
- data/docs/UserSchedulesPartialUploadRequest.md +0 -13
- data/docs/WfmAbandonRate.md +0 -14
- data/docs/WfmAverageSpeedOfAnswer.md +0 -14
- data/docs/WfmForecastModification.md +0 -20
- data/docs/WfmForecastModificationAttributes.md +0 -16
- data/docs/WfmIntradayQueueListing.md +0 -14
- data/docs/WfmServiceLevel.md +0 -15
- data/lib/purecloudplatformclientv2/models/async_week_schedule_response.rb +0 -295
- data/lib/purecloudplatformclientv2/models/forecast_generation_result.rb +0 -204
- data/lib/purecloudplatformclientv2/models/forecast_time_series_result.rb +0 -256
- data/lib/purecloudplatformclientv2/models/generate_week_schedule_response.rb +0 -269
- data/lib/purecloudplatformclientv2/models/intraday_data_group.rb +0 -384
- data/lib/purecloudplatformclientv2/models/intraday_forecast_data.rb +0 -254
- data/lib/purecloudplatformclientv2/models/intraday_historical_agent_data.rb +0 -228
- data/lib/purecloudplatformclientv2/models/intraday_performance_prediction_queue_data.rb +0 -254
- data/lib/purecloudplatformclientv2/models/intraday_response.rb +0 -404
- data/lib/purecloudplatformclientv2/models/intraday_schedule_data.rb +0 -228
- data/lib/purecloudplatformclientv2/models/reschedule_result.rb +0 -202
- data/lib/purecloudplatformclientv2/models/route_group.rb +0 -363
- data/lib/purecloudplatformclientv2/models/scheduling_run_response.rb +0 -609
- data/lib/purecloudplatformclientv2/models/wfm_forecast_modification.rb +0 -435
|
@@ -12,10 +12,10 @@ title: CalibrationEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **previous_uri** | **String** | | [optional] |
|
|
15
16
|
| **self_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/Call.md
CHANGED
|
@@ -32,6 +32,7 @@ title: Call
|
|
|
32
32
|
| **uui_data** | **String** | User to User Information (UUI) data managed by SIP session application. | [optional] |
|
|
33
33
|
| **_self** | [**Address**](Address.html) | Address and name data for a call endpoint. | [optional] |
|
|
34
34
|
| **other** | [**Address**](Address.html) | Address and name data for a call endpoint. | [optional] |
|
|
35
|
+
| **wrapup** | [**Wrapup**](Wrapup.html) | Call wrap up or disposition data. | [optional] |
|
|
35
36
|
{: class="table table-striped"}
|
|
36
37
|
|
|
37
38
|
|
data/docs/CallBasic.md
CHANGED
|
@@ -32,6 +32,7 @@ title: CallBasic
|
|
|
32
32
|
| **uui_data** | **String** | User to User Information (UUI) data managed by SIP session application. | [optional] |
|
|
33
33
|
| **_self** | [**Address**](Address.html) | Address and name data for a call endpoint. | [optional] |
|
|
34
34
|
| **other** | [**Address**](Address.html) | Address and name data for a call endpoint. | [optional] |
|
|
35
|
+
| **wrapup** | [**Wrapup**](Wrapup.html) | Call wrap up or disposition data. | [optional] |
|
|
35
36
|
{: class="table table-striped"}
|
|
36
37
|
|
|
37
38
|
|
|
@@ -12,10 +12,10 @@ title: CallConversationEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **previous_uri** | **String** | | [optional] |
|
|
15
16
|
| **self_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -12,10 +12,10 @@ title: CallHistoryConversationEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **previous_uri** | **String** | | [optional] |
|
|
15
16
|
| **self_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -12,10 +12,10 @@ title: CallableTimeSetEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **previous_uri** | **String** | | [optional] |
|
|
15
16
|
| **self_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/Callback.md
CHANGED
|
@@ -29,6 +29,7 @@ title: Callback
|
|
|
29
29
|
| **automated_callback_config_id** | **String** | The id of the config for automatically placing the callback (and handling the disposition). If null, the callback will not be placed automatically but routed to an agent as per normal. | [optional] |
|
|
30
30
|
| **provider** | **String** | The source provider for the callback. | [optional] |
|
|
31
31
|
| **peer_id** | **String** | The id of the peer communication corresponding to a matching leg for this communication. | [optional] |
|
|
32
|
+
| **wrapup** | [**Wrapup**](Wrapup.html) | Call wrap up or disposition data. | [optional] |
|
|
32
33
|
{: class="table table-striped"}
|
|
33
34
|
|
|
34
35
|
|
data/docs/CallbackBasic.md
CHANGED
|
@@ -29,6 +29,7 @@ title: CallbackBasic
|
|
|
29
29
|
| **automated_callback_config_id** | **String** | The id of the config for automatically placing the callback (and handling the disposition). If null, the callback will not be placed automatically but routed to an agent as per normal. | [optional] |
|
|
30
30
|
| **provider** | **String** | The source provider for the callback. | [optional] |
|
|
31
31
|
| **peer_id** | **String** | The id of the peer communication corresponding to a matching leg for this communication. | [optional] |
|
|
32
|
+
| **wrapup** | [**Wrapup**](Wrapup.html) | Call wrap up or disposition data. | [optional] |
|
|
32
33
|
{: class="table table-striped"}
|
|
33
34
|
|
|
34
35
|
|
|
@@ -12,10 +12,10 @@ title: CallbackConversationEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **previous_uri** | **String** | | [optional] |
|
|
15
16
|
| **self_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -12,10 +12,10 @@ title: CampaignDivisionViewListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **previous_uri** | **String** | | [optional] |
|
|
15
16
|
| **self_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -12,10 +12,10 @@ title: CampaignEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **previous_uri** | **String** | | [optional] |
|
|
15
16
|
| **self_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -12,10 +12,10 @@ title: CampaignRuleEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **previous_uri** | **String** | | [optional] |
|
|
15
16
|
| **self_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -12,10 +12,10 @@ title: CampaignSequenceEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **previous_uri** | **String** | | [optional] |
|
|
15
16
|
| **self_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -12,10 +12,10 @@ title: CertificateAuthorityEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **previous_uri** | **String** | | [optional] |
|
|
15
16
|
| **self_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -12,10 +12,10 @@ title: ChatConversationEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **previous_uri** | **String** | | [optional] |
|
|
15
16
|
| **self_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -12,10 +12,10 @@ title: ClientAppEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **previous_uri** | **String** | | [optional] |
|
|
15
16
|
| **self_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: CoachingAnnotation
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::CoachingAnnotation
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
|
+
| **created_by** | [**UserReference**](UserReference.html) | The user who created the annotation. | [optional] |
|
|
12
|
+
| **date_created** | **DateTime** | The date/time the annotation was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
13
|
+
| **modified_by** | [**UserReference**](UserReference.html) | The last user to modify the annotation. | [optional] |
|
|
14
|
+
| **date_modified** | **DateTime** | The date/time the annotation was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
15
|
+
| **text** | **String** | The text of the annotation. | |
|
|
16
|
+
| **is_deleted** | **BOOLEAN** | Flag indicating whether the annotation is deleted. | [optional] |
|
|
17
|
+
| **access_type** | **String** | Determines the permissions required to view this item. | [optional] |
|
|
18
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
19
|
+
{: class="table table-striped"}
|
|
20
|
+
|
|
21
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: CoachingAnnotationCreateRequest
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::CoachingAnnotationCreateRequest
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **text** | **String** | The text of the annotation. | |
|
|
11
|
+
| **access_type** | **String** | Determines the permissions required to view this item. | |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: CoachingAnnotationList
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::CoachingAnnotationList
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **entities** | [**Array<CoachingAnnotation>**](CoachingAnnotation.html) | | [optional] |
|
|
11
|
+
| **page_size** | **Integer** | | [optional] |
|
|
12
|
+
| **page_number** | **Integer** | | [optional] |
|
|
13
|
+
| **total** | **Integer** | | [optional] |
|
|
14
|
+
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **previous_uri** | **String** | | [optional] |
|
|
16
|
+
| **self_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
|
+
| **page_count** | **Integer** | | [optional] |
|
|
20
|
+
{: class="table table-striped"}
|
|
21
|
+
|
|
22
|
+
|
data/docs/CoachingApi.md
ADDED
|
@@ -0,0 +1,1132 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: CoachingApi
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
## PureCloud::CoachingApi
|
|
6
|
+
|
|
7
|
+
All URIs are relative to *https://api.mypurecloud.com*
|
|
8
|
+
|
|
9
|
+
Method | Description
|
|
10
|
+
------------- | ------------- | -------------
|
|
11
|
+
[**delete_coaching_appointment**](CoachingApi.html#delete_coaching_appointment) | Delete an existing appointment
|
|
12
|
+
[**delete_coaching_appointment_annotation**](CoachingApi.html#delete_coaching_appointment_annotation) | Delete an existing annotation
|
|
13
|
+
[**get_coaching_appointment**](CoachingApi.html#get_coaching_appointment) | Retrieve an appointment
|
|
14
|
+
[**get_coaching_appointment_annotation**](CoachingApi.html#get_coaching_appointment_annotation) | Retrieve an annotation.
|
|
15
|
+
[**get_coaching_appointment_annotations**](CoachingApi.html#get_coaching_appointment_annotations) | Get a list of annotations.
|
|
16
|
+
[**get_coaching_appointment_statuses**](CoachingApi.html#get_coaching_appointment_statuses) | Get the list of status changes for a coaching appointment.
|
|
17
|
+
[**get_coaching_appointments**](CoachingApi.html#get_coaching_appointments) | Get appointments for users and optional date range
|
|
18
|
+
[**get_coaching_appointments_me**](CoachingApi.html#get_coaching_appointments_me) | Get my appointments for a given date range
|
|
19
|
+
[**get_coaching_notification**](CoachingApi.html#get_coaching_notification) | Get an existing notification
|
|
20
|
+
[**get_coaching_notifications**](CoachingApi.html#get_coaching_notifications) | Retrieve the list of your notifications.
|
|
21
|
+
[**patch_coaching_appointment**](CoachingApi.html#patch_coaching_appointment) | Update an existing appointment
|
|
22
|
+
[**patch_coaching_appointment_annotation**](CoachingApi.html#patch_coaching_appointment_annotation) | Update an existing annotation.
|
|
23
|
+
[**patch_coaching_appointment_status**](CoachingApi.html#patch_coaching_appointment_status) | Update the status of a coaching appointment
|
|
24
|
+
[**patch_coaching_notification**](CoachingApi.html#patch_coaching_notification) | Update an existing notification.
|
|
25
|
+
[**post_coaching_appointment_annotations**](CoachingApi.html#post_coaching_appointment_annotations) | Create a new annotation.
|
|
26
|
+
[**post_coaching_appointments**](CoachingApi.html#post_coaching_appointments) | Create a new appointment
|
|
27
|
+
{: class="table table-striped"}
|
|
28
|
+
|
|
29
|
+
<a name="delete_coaching_appointment"></a>
|
|
30
|
+
|
|
31
|
+
## delete_coaching_appointment(appointment_id)
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
Delete an existing appointment
|
|
36
|
+
|
|
37
|
+
Permission not required if you are the creator of the appointment
|
|
38
|
+
|
|
39
|
+
Wraps DELETE /api/v2/coaching/appointments/{appointmentId}
|
|
40
|
+
|
|
41
|
+
Requires ANY permissions:
|
|
42
|
+
|
|
43
|
+
* COACHING:APPOINTMENT:DELETE
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
### Example
|
|
47
|
+
```{"language":"ruby"}
|
|
48
|
+
# load the gem
|
|
49
|
+
require 'purecloudplatformclientv2'
|
|
50
|
+
# setup authorization
|
|
51
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
52
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
53
|
+
environment = "mypurecloud.com"
|
|
54
|
+
|
|
55
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
56
|
+
|
|
57
|
+
PureCloud.configure do |config|
|
|
58
|
+
config.access_token = @authToken
|
|
59
|
+
end
|
|
60
|
+
|
|
61
|
+
api_instance = PureCloud::CoachingApi.new
|
|
62
|
+
|
|
63
|
+
appointment_id = "appointment_id_example" # String | The ID of the coaching appointment.
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
begin
|
|
67
|
+
#Delete an existing appointment
|
|
68
|
+
api_instance.delete_coaching_appointment(appointment_id)
|
|
69
|
+
rescue PureCloud::ApiError => e
|
|
70
|
+
puts "Exception when calling CoachingApi->delete_coaching_appointment: #{e}"
|
|
71
|
+
end
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### Parameters
|
|
75
|
+
|
|
76
|
+
Name | Type | Description | Notes
|
|
77
|
+
------------- | ------------- | ------------- | -------------
|
|
78
|
+
**appointment_id** | **String**| The ID of the coaching appointment. | |
|
|
79
|
+
{: class="table table-striped"}
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
### Return type
|
|
83
|
+
|
|
84
|
+
nil (empty response body)
|
|
85
|
+
|
|
86
|
+
### HTTP request headers
|
|
87
|
+
|
|
88
|
+
- **Content-Type**: application/json
|
|
89
|
+
- **Accept**: application/json
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
<a name="delete_coaching_appointment_annotation"></a>
|
|
94
|
+
|
|
95
|
+
## delete_coaching_appointment_annotation(appointment_id, annotation_id)
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
Delete an existing annotation
|
|
100
|
+
|
|
101
|
+
You must have the appropriate permission for the type of annotation you are updating. Permission not required if you are the creator or facilitator of the appointment
|
|
102
|
+
|
|
103
|
+
Wraps DELETE /api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId}
|
|
104
|
+
|
|
105
|
+
Requires ANY permissions:
|
|
106
|
+
|
|
107
|
+
* COACHING:ANNOTATION:DELETE
|
|
108
|
+
* COACHING:PRIVATEANNOTATION:DELETE
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
### Example
|
|
112
|
+
```{"language":"ruby"}
|
|
113
|
+
# load the gem
|
|
114
|
+
require 'purecloudplatformclientv2'
|
|
115
|
+
# setup authorization
|
|
116
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
117
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
118
|
+
environment = "mypurecloud.com"
|
|
119
|
+
|
|
120
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
121
|
+
|
|
122
|
+
PureCloud.configure do |config|
|
|
123
|
+
config.access_token = @authToken
|
|
124
|
+
end
|
|
125
|
+
|
|
126
|
+
api_instance = PureCloud::CoachingApi.new
|
|
127
|
+
|
|
128
|
+
appointment_id = "appointment_id_example" # String | The ID of the coaching appointment.
|
|
129
|
+
|
|
130
|
+
annotation_id = "annotation_id_example" # String | The ID of the annotation.
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
begin
|
|
134
|
+
#Delete an existing annotation
|
|
135
|
+
api_instance.delete_coaching_appointment_annotation(appointment_id, annotation_id)
|
|
136
|
+
rescue PureCloud::ApiError => e
|
|
137
|
+
puts "Exception when calling CoachingApi->delete_coaching_appointment_annotation: #{e}"
|
|
138
|
+
end
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
### Parameters
|
|
142
|
+
|
|
143
|
+
Name | Type | Description | Notes
|
|
144
|
+
------------- | ------------- | ------------- | -------------
|
|
145
|
+
**appointment_id** | **String**| The ID of the coaching appointment. | |
|
|
146
|
+
**annotation_id** | **String**| The ID of the annotation. | |
|
|
147
|
+
{: class="table table-striped"}
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
### Return type
|
|
151
|
+
|
|
152
|
+
nil (empty response body)
|
|
153
|
+
|
|
154
|
+
### HTTP request headers
|
|
155
|
+
|
|
156
|
+
- **Content-Type**: application/json
|
|
157
|
+
- **Accept**: application/json
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
<a name="get_coaching_appointment"></a>
|
|
162
|
+
|
|
163
|
+
## [**CoachingAppointmentResponse**](CoachingAppointmentResponse.html) get_coaching_appointment(appointment_id)
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
Retrieve an appointment
|
|
168
|
+
|
|
169
|
+
Permission not required if you are the attendee, creator or facilitator of the appointment
|
|
170
|
+
|
|
171
|
+
Wraps GET /api/v2/coaching/appointments/{appointmentId}
|
|
172
|
+
|
|
173
|
+
Requires ANY permissions:
|
|
174
|
+
|
|
175
|
+
* COACHING:APPOINTMENT:VIEW
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
### Example
|
|
179
|
+
```{"language":"ruby"}
|
|
180
|
+
# load the gem
|
|
181
|
+
require 'purecloudplatformclientv2'
|
|
182
|
+
# setup authorization
|
|
183
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
184
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
185
|
+
environment = "mypurecloud.com"
|
|
186
|
+
|
|
187
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
188
|
+
|
|
189
|
+
PureCloud.configure do |config|
|
|
190
|
+
config.access_token = @authToken
|
|
191
|
+
end
|
|
192
|
+
|
|
193
|
+
api_instance = PureCloud::CoachingApi.new
|
|
194
|
+
|
|
195
|
+
appointment_id = "appointment_id_example" # String | The ID of the coaching appointment.
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
begin
|
|
199
|
+
#Retrieve an appointment
|
|
200
|
+
result = api_instance.get_coaching_appointment(appointment_id)
|
|
201
|
+
p result
|
|
202
|
+
rescue PureCloud::ApiError => e
|
|
203
|
+
puts "Exception when calling CoachingApi->get_coaching_appointment: #{e}"
|
|
204
|
+
end
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
### Parameters
|
|
208
|
+
|
|
209
|
+
Name | Type | Description | Notes
|
|
210
|
+
------------- | ------------- | ------------- | -------------
|
|
211
|
+
**appointment_id** | **String**| The ID of the coaching appointment. | |
|
|
212
|
+
{: class="table table-striped"}
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
### Return type
|
|
216
|
+
|
|
217
|
+
[**CoachingAppointmentResponse**](CoachingAppointmentResponse.html)
|
|
218
|
+
|
|
219
|
+
### HTTP request headers
|
|
220
|
+
|
|
221
|
+
- **Content-Type**: application/json
|
|
222
|
+
- **Accept**: application/json
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
<a name="get_coaching_appointment_annotation"></a>
|
|
227
|
+
|
|
228
|
+
## [**CoachingAnnotation**](CoachingAnnotation.html) get_coaching_appointment_annotation(appointment_id, annotation_id)
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
Retrieve an annotation.
|
|
233
|
+
|
|
234
|
+
You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can view private annotations).
|
|
235
|
+
|
|
236
|
+
Wraps GET /api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId}
|
|
237
|
+
|
|
238
|
+
Requires ANY permissions:
|
|
239
|
+
|
|
240
|
+
* COACHING:ANNOTATION:VIEW
|
|
241
|
+
* COACHING:PRIVATEANNOTATION:VIEW
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
### Example
|
|
245
|
+
```{"language":"ruby"}
|
|
246
|
+
# load the gem
|
|
247
|
+
require 'purecloudplatformclientv2'
|
|
248
|
+
# setup authorization
|
|
249
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
250
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
251
|
+
environment = "mypurecloud.com"
|
|
252
|
+
|
|
253
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
254
|
+
|
|
255
|
+
PureCloud.configure do |config|
|
|
256
|
+
config.access_token = @authToken
|
|
257
|
+
end
|
|
258
|
+
|
|
259
|
+
api_instance = PureCloud::CoachingApi.new
|
|
260
|
+
|
|
261
|
+
appointment_id = "appointment_id_example" # String | The ID of the coaching appointment.
|
|
262
|
+
|
|
263
|
+
annotation_id = "annotation_id_example" # String | The ID of the annotation.
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
begin
|
|
267
|
+
#Retrieve an annotation.
|
|
268
|
+
result = api_instance.get_coaching_appointment_annotation(appointment_id, annotation_id)
|
|
269
|
+
p result
|
|
270
|
+
rescue PureCloud::ApiError => e
|
|
271
|
+
puts "Exception when calling CoachingApi->get_coaching_appointment_annotation: #{e}"
|
|
272
|
+
end
|
|
273
|
+
```
|
|
274
|
+
|
|
275
|
+
### Parameters
|
|
276
|
+
|
|
277
|
+
Name | Type | Description | Notes
|
|
278
|
+
------------- | ------------- | ------------- | -------------
|
|
279
|
+
**appointment_id** | **String**| The ID of the coaching appointment. | |
|
|
280
|
+
**annotation_id** | **String**| The ID of the annotation. | |
|
|
281
|
+
{: class="table table-striped"}
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
### Return type
|
|
285
|
+
|
|
286
|
+
[**CoachingAnnotation**](CoachingAnnotation.html)
|
|
287
|
+
|
|
288
|
+
### HTTP request headers
|
|
289
|
+
|
|
290
|
+
- **Content-Type**: application/json
|
|
291
|
+
- **Accept**: application/json
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
<a name="get_coaching_appointment_annotations"></a>
|
|
296
|
+
|
|
297
|
+
## [**CoachingAnnotationList**](CoachingAnnotationList.html) get_coaching_appointment_annotations(appointment_id, opts)
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
Get a list of annotations.
|
|
302
|
+
|
|
303
|
+
You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can view private annotations).
|
|
304
|
+
|
|
305
|
+
Wraps GET /api/v2/coaching/appointments/{appointmentId}/annotations
|
|
306
|
+
|
|
307
|
+
Requires ANY permissions:
|
|
308
|
+
|
|
309
|
+
* COACHING:ANNOTATION:VIEW
|
|
310
|
+
* COACHING:PRIVATEANNOTATION:VIEW
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
### Example
|
|
314
|
+
```{"language":"ruby"}
|
|
315
|
+
# load the gem
|
|
316
|
+
require 'purecloudplatformclientv2'
|
|
317
|
+
# setup authorization
|
|
318
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
319
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
320
|
+
environment = "mypurecloud.com"
|
|
321
|
+
|
|
322
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
323
|
+
|
|
324
|
+
PureCloud.configure do |config|
|
|
325
|
+
config.access_token = @authToken
|
|
326
|
+
end
|
|
327
|
+
|
|
328
|
+
api_instance = PureCloud::CoachingApi.new
|
|
329
|
+
|
|
330
|
+
appointment_id = "appointment_id_example" # String | The ID of the coaching appointment.
|
|
331
|
+
|
|
332
|
+
opts = {
|
|
333
|
+
page_number: 1, # Integer | Page number
|
|
334
|
+
page_size: 25 # Integer | Page size
|
|
335
|
+
}
|
|
336
|
+
|
|
337
|
+
begin
|
|
338
|
+
#Get a list of annotations.
|
|
339
|
+
result = api_instance.get_coaching_appointment_annotations(appointment_id, opts)
|
|
340
|
+
p result
|
|
341
|
+
rescue PureCloud::ApiError => e
|
|
342
|
+
puts "Exception when calling CoachingApi->get_coaching_appointment_annotations: #{e}"
|
|
343
|
+
end
|
|
344
|
+
```
|
|
345
|
+
|
|
346
|
+
### Parameters
|
|
347
|
+
|
|
348
|
+
Name | Type | Description | Notes
|
|
349
|
+
------------- | ------------- | ------------- | -------------
|
|
350
|
+
**appointment_id** | **String**| The ID of the coaching appointment. | |
|
|
351
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
352
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
353
|
+
{: class="table table-striped"}
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
### Return type
|
|
357
|
+
|
|
358
|
+
[**CoachingAnnotationList**](CoachingAnnotationList.html)
|
|
359
|
+
|
|
360
|
+
### HTTP request headers
|
|
361
|
+
|
|
362
|
+
- **Content-Type**: application/json
|
|
363
|
+
- **Accept**: application/json
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
<a name="get_coaching_appointment_statuses"></a>
|
|
368
|
+
|
|
369
|
+
## [**CoachingAppointmentStatusDtoList**](CoachingAppointmentStatusDtoList.html) get_coaching_appointment_statuses(appointment_id, opts)
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
Get the list of status changes for a coaching appointment.
|
|
374
|
+
|
|
375
|
+
Permission not required if you are an attendee, creator or facilitator of the appointment
|
|
376
|
+
|
|
377
|
+
Wraps GET /api/v2/coaching/appointments/{appointmentId}/statuses
|
|
378
|
+
|
|
379
|
+
Requires ANY permissions:
|
|
380
|
+
|
|
381
|
+
* COACHING:APPOINTMENTSTATUS:VIEW
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
### Example
|
|
385
|
+
```{"language":"ruby"}
|
|
386
|
+
# load the gem
|
|
387
|
+
require 'purecloudplatformclientv2'
|
|
388
|
+
# setup authorization
|
|
389
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
390
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
391
|
+
environment = "mypurecloud.com"
|
|
392
|
+
|
|
393
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
394
|
+
|
|
395
|
+
PureCloud.configure do |config|
|
|
396
|
+
config.access_token = @authToken
|
|
397
|
+
end
|
|
398
|
+
|
|
399
|
+
api_instance = PureCloud::CoachingApi.new
|
|
400
|
+
|
|
401
|
+
appointment_id = "appointment_id_example" # String | The ID of the coaching appointment.
|
|
402
|
+
|
|
403
|
+
opts = {
|
|
404
|
+
page_number: 1, # Integer | Page number
|
|
405
|
+
page_size: 25 # Integer | Page size
|
|
406
|
+
}
|
|
407
|
+
|
|
408
|
+
begin
|
|
409
|
+
#Get the list of status changes for a coaching appointment.
|
|
410
|
+
result = api_instance.get_coaching_appointment_statuses(appointment_id, opts)
|
|
411
|
+
p result
|
|
412
|
+
rescue PureCloud::ApiError => e
|
|
413
|
+
puts "Exception when calling CoachingApi->get_coaching_appointment_statuses: #{e}"
|
|
414
|
+
end
|
|
415
|
+
```
|
|
416
|
+
|
|
417
|
+
### Parameters
|
|
418
|
+
|
|
419
|
+
Name | Type | Description | Notes
|
|
420
|
+
------------- | ------------- | ------------- | -------------
|
|
421
|
+
**appointment_id** | **String**| The ID of the coaching appointment. | |
|
|
422
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
423
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
424
|
+
{: class="table table-striped"}
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
### Return type
|
|
428
|
+
|
|
429
|
+
[**CoachingAppointmentStatusDtoList**](CoachingAppointmentStatusDtoList.html)
|
|
430
|
+
|
|
431
|
+
### HTTP request headers
|
|
432
|
+
|
|
433
|
+
- **Content-Type**: application/json
|
|
434
|
+
- **Accept**: application/json
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
<a name="get_coaching_appointments"></a>
|
|
439
|
+
|
|
440
|
+
## [**CoachingAppointmentResponseList**](CoachingAppointmentResponseList.html) get_coaching_appointments(user_ids, opts)
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
Get appointments for users and optional date range
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
Wraps GET /api/v2/coaching/appointments
|
|
449
|
+
|
|
450
|
+
Requires ANY permissions:
|
|
451
|
+
|
|
452
|
+
* COACHING:APPOINTMENT:VIEW
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
### Example
|
|
456
|
+
```{"language":"ruby"}
|
|
457
|
+
# load the gem
|
|
458
|
+
require 'purecloudplatformclientv2'
|
|
459
|
+
# setup authorization
|
|
460
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
461
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
462
|
+
environment = "mypurecloud.com"
|
|
463
|
+
|
|
464
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
465
|
+
|
|
466
|
+
PureCloud.configure do |config|
|
|
467
|
+
config.access_token = @authToken
|
|
468
|
+
end
|
|
469
|
+
|
|
470
|
+
api_instance = PureCloud::CoachingApi.new
|
|
471
|
+
|
|
472
|
+
user_ids = ["user_ids_example"] # Array<String> | The user IDs for which to retrieve appointments
|
|
473
|
+
|
|
474
|
+
opts = {
|
|
475
|
+
interval: "interval_example", # String | Interval string; format is ISO-8601. Separate start and end times with forward slash '/'
|
|
476
|
+
page_number: 1, # Integer | Page number
|
|
477
|
+
page_size: 25, # Integer | Page size
|
|
478
|
+
statuses: ["statuses_example"], # Array<String> | Appointment Statuses to filter by
|
|
479
|
+
facilitator_ids: ["facilitator_ids_example"], # Array<String> | The facilitator IDs for which to retrieve appointments
|
|
480
|
+
sort_order: "sort_order_example" # String | Sort (by due date) either Asc or Desc
|
|
481
|
+
}
|
|
482
|
+
|
|
483
|
+
begin
|
|
484
|
+
#Get appointments for users and optional date range
|
|
485
|
+
result = api_instance.get_coaching_appointments(user_ids, opts)
|
|
486
|
+
p result
|
|
487
|
+
rescue PureCloud::ApiError => e
|
|
488
|
+
puts "Exception when calling CoachingApi->get_coaching_appointments: #{e}"
|
|
489
|
+
end
|
|
490
|
+
```
|
|
491
|
+
|
|
492
|
+
### Parameters
|
|
493
|
+
|
|
494
|
+
Name | Type | Description | Notes
|
|
495
|
+
------------- | ------------- | ------------- | -------------
|
|
496
|
+
**user_ids** | [**Array<String>**](String.html)| The user IDs for which to retrieve appointments | |
|
|
497
|
+
**interval** | **String**| Interval string; format is ISO-8601. Separate start and end times with forward slash '/' | [optional] |
|
|
498
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
499
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
500
|
+
**statuses** | [**Array<String>**](String.html)| Appointment Statuses to filter by | [optional] <br />**Values**: Scheduled, InProgress, Completed |
|
|
501
|
+
**facilitator_ids** | [**Array<String>**](String.html)| The facilitator IDs for which to retrieve appointments | [optional] |
|
|
502
|
+
**sort_order** | **String**| Sort (by due date) either Asc or Desc | [optional] <br />**Values**: Desc, Asc |
|
|
503
|
+
{: class="table table-striped"}
|
|
504
|
+
|
|
505
|
+
|
|
506
|
+
### Return type
|
|
507
|
+
|
|
508
|
+
[**CoachingAppointmentResponseList**](CoachingAppointmentResponseList.html)
|
|
509
|
+
|
|
510
|
+
### HTTP request headers
|
|
511
|
+
|
|
512
|
+
- **Content-Type**: application/json
|
|
513
|
+
- **Accept**: application/json
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
<a name="get_coaching_appointments_me"></a>
|
|
518
|
+
|
|
519
|
+
## [**CoachingAppointmentResponseList**](CoachingAppointmentResponseList.html) get_coaching_appointments_me(opts)
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
Get my appointments for a given date range
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
Wraps GET /api/v2/coaching/appointments/me
|
|
528
|
+
|
|
529
|
+
Requires NO permissions:
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
### Example
|
|
534
|
+
```{"language":"ruby"}
|
|
535
|
+
# load the gem
|
|
536
|
+
require 'purecloudplatformclientv2'
|
|
537
|
+
# setup authorization
|
|
538
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
539
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
540
|
+
environment = "mypurecloud.com"
|
|
541
|
+
|
|
542
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
543
|
+
|
|
544
|
+
PureCloud.configure do |config|
|
|
545
|
+
config.access_token = @authToken
|
|
546
|
+
end
|
|
547
|
+
|
|
548
|
+
api_instance = PureCloud::CoachingApi.new
|
|
549
|
+
|
|
550
|
+
opts = {
|
|
551
|
+
interval: "interval_example", # String | Interval string; format is ISO-8601. Separate start and end times with forward slash '/'
|
|
552
|
+
page_number: 1, # Integer | Page number
|
|
553
|
+
page_size: 25, # Integer | Page size
|
|
554
|
+
statuses: ["statuses_example"], # Array<String> | Appointment Statuses to filter by
|
|
555
|
+
facilitator_ids: ["facilitator_ids_example"], # Array<String> | The facilitator IDs for which to retrieve appointments
|
|
556
|
+
sort_order: "sort_order_example" # String | Sort (by due date) either Asc or Desc
|
|
557
|
+
}
|
|
558
|
+
|
|
559
|
+
begin
|
|
560
|
+
#Get my appointments for a given date range
|
|
561
|
+
result = api_instance.get_coaching_appointments_me(opts)
|
|
562
|
+
p result
|
|
563
|
+
rescue PureCloud::ApiError => e
|
|
564
|
+
puts "Exception when calling CoachingApi->get_coaching_appointments_me: #{e}"
|
|
565
|
+
end
|
|
566
|
+
```
|
|
567
|
+
|
|
568
|
+
### Parameters
|
|
569
|
+
|
|
570
|
+
Name | Type | Description | Notes
|
|
571
|
+
------------- | ------------- | ------------- | -------------
|
|
572
|
+
**interval** | **String**| Interval string; format is ISO-8601. Separate start and end times with forward slash '/' | [optional] |
|
|
573
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
574
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
575
|
+
**statuses** | [**Array<String>**](String.html)| Appointment Statuses to filter by | [optional] <br />**Values**: Scheduled, InProgress, Completed |
|
|
576
|
+
**facilitator_ids** | [**Array<String>**](String.html)| The facilitator IDs for which to retrieve appointments | [optional] |
|
|
577
|
+
**sort_order** | **String**| Sort (by due date) either Asc or Desc | [optional] <br />**Values**: Desc, Asc |
|
|
578
|
+
{: class="table table-striped"}
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
### Return type
|
|
582
|
+
|
|
583
|
+
[**CoachingAppointmentResponseList**](CoachingAppointmentResponseList.html)
|
|
584
|
+
|
|
585
|
+
### HTTP request headers
|
|
586
|
+
|
|
587
|
+
- **Content-Type**: application/json
|
|
588
|
+
- **Accept**: application/json
|
|
589
|
+
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
<a name="get_coaching_notification"></a>
|
|
593
|
+
|
|
594
|
+
## [**CoachingNotification**](CoachingNotification.html) get_coaching_notification(notification_id)
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
Get an existing notification
|
|
599
|
+
|
|
600
|
+
Permission not required if you are the owner of the notification.
|
|
601
|
+
|
|
602
|
+
Wraps GET /api/v2/coaching/notifications/{notificationId}
|
|
603
|
+
|
|
604
|
+
Requires ANY permissions:
|
|
605
|
+
|
|
606
|
+
* COACHING:NOTIFICATION:VIEW
|
|
607
|
+
|
|
608
|
+
|
|
609
|
+
### Example
|
|
610
|
+
```{"language":"ruby"}
|
|
611
|
+
# load the gem
|
|
612
|
+
require 'purecloudplatformclientv2'
|
|
613
|
+
# setup authorization
|
|
614
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
615
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
616
|
+
environment = "mypurecloud.com"
|
|
617
|
+
|
|
618
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
619
|
+
|
|
620
|
+
PureCloud.configure do |config|
|
|
621
|
+
config.access_token = @authToken
|
|
622
|
+
end
|
|
623
|
+
|
|
624
|
+
api_instance = PureCloud::CoachingApi.new
|
|
625
|
+
|
|
626
|
+
notification_id = "notification_id_example" # String | The ID of the notification.
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
begin
|
|
630
|
+
#Get an existing notification
|
|
631
|
+
result = api_instance.get_coaching_notification(notification_id)
|
|
632
|
+
p result
|
|
633
|
+
rescue PureCloud::ApiError => e
|
|
634
|
+
puts "Exception when calling CoachingApi->get_coaching_notification: #{e}"
|
|
635
|
+
end
|
|
636
|
+
```
|
|
637
|
+
|
|
638
|
+
### Parameters
|
|
639
|
+
|
|
640
|
+
Name | Type | Description | Notes
|
|
641
|
+
------------- | ------------- | ------------- | -------------
|
|
642
|
+
**notification_id** | **String**| The ID of the notification. | |
|
|
643
|
+
{: class="table table-striped"}
|
|
644
|
+
|
|
645
|
+
|
|
646
|
+
### Return type
|
|
647
|
+
|
|
648
|
+
[**CoachingNotification**](CoachingNotification.html)
|
|
649
|
+
|
|
650
|
+
### HTTP request headers
|
|
651
|
+
|
|
652
|
+
- **Content-Type**: application/json
|
|
653
|
+
- **Accept**: application/json
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
<a name="get_coaching_notifications"></a>
|
|
658
|
+
|
|
659
|
+
## [**CoachingNotificationList**](CoachingNotificationList.html) get_coaching_notifications(opts)
|
|
660
|
+
|
|
661
|
+
|
|
662
|
+
|
|
663
|
+
Retrieve the list of your notifications.
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
|
|
667
|
+
Wraps GET /api/v2/coaching/notifications
|
|
668
|
+
|
|
669
|
+
Requires NO permissions:
|
|
670
|
+
|
|
671
|
+
|
|
672
|
+
|
|
673
|
+
### Example
|
|
674
|
+
```{"language":"ruby"}
|
|
675
|
+
# load the gem
|
|
676
|
+
require 'purecloudplatformclientv2'
|
|
677
|
+
# setup authorization
|
|
678
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
679
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
680
|
+
environment = "mypurecloud.com"
|
|
681
|
+
|
|
682
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
683
|
+
|
|
684
|
+
PureCloud.configure do |config|
|
|
685
|
+
config.access_token = @authToken
|
|
686
|
+
end
|
|
687
|
+
|
|
688
|
+
api_instance = PureCloud::CoachingApi.new
|
|
689
|
+
|
|
690
|
+
opts = {
|
|
691
|
+
page_number: 1, # Integer | Page number
|
|
692
|
+
page_size: 25 # Integer | Page size
|
|
693
|
+
}
|
|
694
|
+
|
|
695
|
+
begin
|
|
696
|
+
#Retrieve the list of your notifications.
|
|
697
|
+
result = api_instance.get_coaching_notifications(opts)
|
|
698
|
+
p result
|
|
699
|
+
rescue PureCloud::ApiError => e
|
|
700
|
+
puts "Exception when calling CoachingApi->get_coaching_notifications: #{e}"
|
|
701
|
+
end
|
|
702
|
+
```
|
|
703
|
+
|
|
704
|
+
### Parameters
|
|
705
|
+
|
|
706
|
+
Name | Type | Description | Notes
|
|
707
|
+
------------- | ------------- | ------------- | -------------
|
|
708
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
709
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
710
|
+
{: class="table table-striped"}
|
|
711
|
+
|
|
712
|
+
|
|
713
|
+
### Return type
|
|
714
|
+
|
|
715
|
+
[**CoachingNotificationList**](CoachingNotificationList.html)
|
|
716
|
+
|
|
717
|
+
### HTTP request headers
|
|
718
|
+
|
|
719
|
+
- **Content-Type**: application/json
|
|
720
|
+
- **Accept**: application/json
|
|
721
|
+
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
<a name="patch_coaching_appointment"></a>
|
|
725
|
+
|
|
726
|
+
## [**CoachingAppointmentResponse**](CoachingAppointmentResponse.html) patch_coaching_appointment(appointment_id, body)
|
|
727
|
+
|
|
728
|
+
|
|
729
|
+
|
|
730
|
+
Update an existing appointment
|
|
731
|
+
|
|
732
|
+
Permission not required if you are the creator or facilitator of the appointment
|
|
733
|
+
|
|
734
|
+
Wraps PATCH /api/v2/coaching/appointments/{appointmentId}
|
|
735
|
+
|
|
736
|
+
Requires ANY permissions:
|
|
737
|
+
|
|
738
|
+
* COACHING:APPOINTMENT:EDIT
|
|
739
|
+
|
|
740
|
+
|
|
741
|
+
### Example
|
|
742
|
+
```{"language":"ruby"}
|
|
743
|
+
# load the gem
|
|
744
|
+
require 'purecloudplatformclientv2'
|
|
745
|
+
# setup authorization
|
|
746
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
747
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
748
|
+
environment = "mypurecloud.com"
|
|
749
|
+
|
|
750
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
751
|
+
|
|
752
|
+
PureCloud.configure do |config|
|
|
753
|
+
config.access_token = @authToken
|
|
754
|
+
end
|
|
755
|
+
|
|
756
|
+
api_instance = PureCloud::CoachingApi.new
|
|
757
|
+
|
|
758
|
+
appointment_id = "appointment_id_example" # String | The ID of the coaching appointment.
|
|
759
|
+
|
|
760
|
+
body = PureCloud::UpdateCoachingAppointmentRequest.new # UpdateCoachingAppointmentRequest | The new version of the appointment
|
|
761
|
+
|
|
762
|
+
|
|
763
|
+
begin
|
|
764
|
+
#Update an existing appointment
|
|
765
|
+
result = api_instance.patch_coaching_appointment(appointment_id, body)
|
|
766
|
+
p result
|
|
767
|
+
rescue PureCloud::ApiError => e
|
|
768
|
+
puts "Exception when calling CoachingApi->patch_coaching_appointment: #{e}"
|
|
769
|
+
end
|
|
770
|
+
```
|
|
771
|
+
|
|
772
|
+
### Parameters
|
|
773
|
+
|
|
774
|
+
Name | Type | Description | Notes
|
|
775
|
+
------------- | ------------- | ------------- | -------------
|
|
776
|
+
**appointment_id** | **String**| The ID of the coaching appointment. | |
|
|
777
|
+
**body** | [**UpdateCoachingAppointmentRequest**](UpdateCoachingAppointmentRequest.html)| The new version of the appointment | |
|
|
778
|
+
{: class="table table-striped"}
|
|
779
|
+
|
|
780
|
+
|
|
781
|
+
### Return type
|
|
782
|
+
|
|
783
|
+
[**CoachingAppointmentResponse**](CoachingAppointmentResponse.html)
|
|
784
|
+
|
|
785
|
+
### HTTP request headers
|
|
786
|
+
|
|
787
|
+
- **Content-Type**: application/json
|
|
788
|
+
- **Accept**: application/json
|
|
789
|
+
|
|
790
|
+
|
|
791
|
+
|
|
792
|
+
<a name="patch_coaching_appointment_annotation"></a>
|
|
793
|
+
|
|
794
|
+
## [**CoachingAnnotation**](CoachingAnnotation.html) patch_coaching_appointment_annotation(appointment_id, annotation_id, body)
|
|
795
|
+
|
|
796
|
+
|
|
797
|
+
|
|
798
|
+
Update an existing annotation.
|
|
799
|
+
|
|
800
|
+
You must have the appropriate permission for the type of annotation you are updating. Permission not required if you are the creator or facilitator of the appointment
|
|
801
|
+
|
|
802
|
+
Wraps PATCH /api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId}
|
|
803
|
+
|
|
804
|
+
Requires ANY permissions:
|
|
805
|
+
|
|
806
|
+
* COACHING:ANNOTATION:EDIT
|
|
807
|
+
* COACHING:PRIVATEANNOTATION:EDIT
|
|
808
|
+
|
|
809
|
+
|
|
810
|
+
### Example
|
|
811
|
+
```{"language":"ruby"}
|
|
812
|
+
# load the gem
|
|
813
|
+
require 'purecloudplatformclientv2'
|
|
814
|
+
# setup authorization
|
|
815
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
816
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
817
|
+
environment = "mypurecloud.com"
|
|
818
|
+
|
|
819
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
820
|
+
|
|
821
|
+
PureCloud.configure do |config|
|
|
822
|
+
config.access_token = @authToken
|
|
823
|
+
end
|
|
824
|
+
|
|
825
|
+
api_instance = PureCloud::CoachingApi.new
|
|
826
|
+
|
|
827
|
+
appointment_id = "appointment_id_example" # String | The ID of the coaching appointment.
|
|
828
|
+
|
|
829
|
+
annotation_id = "annotation_id_example" # String | The ID of the annotation.
|
|
830
|
+
|
|
831
|
+
body = PureCloud::CoachingAnnotation.new # CoachingAnnotation | The new version of the annotation
|
|
832
|
+
|
|
833
|
+
|
|
834
|
+
begin
|
|
835
|
+
#Update an existing annotation.
|
|
836
|
+
result = api_instance.patch_coaching_appointment_annotation(appointment_id, annotation_id, body)
|
|
837
|
+
p result
|
|
838
|
+
rescue PureCloud::ApiError => e
|
|
839
|
+
puts "Exception when calling CoachingApi->patch_coaching_appointment_annotation: #{e}"
|
|
840
|
+
end
|
|
841
|
+
```
|
|
842
|
+
|
|
843
|
+
### Parameters
|
|
844
|
+
|
|
845
|
+
Name | Type | Description | Notes
|
|
846
|
+
------------- | ------------- | ------------- | -------------
|
|
847
|
+
**appointment_id** | **String**| The ID of the coaching appointment. | |
|
|
848
|
+
**annotation_id** | **String**| The ID of the annotation. | |
|
|
849
|
+
**body** | [**CoachingAnnotation**](CoachingAnnotation.html)| The new version of the annotation | |
|
|
850
|
+
{: class="table table-striped"}
|
|
851
|
+
|
|
852
|
+
|
|
853
|
+
### Return type
|
|
854
|
+
|
|
855
|
+
[**CoachingAnnotation**](CoachingAnnotation.html)
|
|
856
|
+
|
|
857
|
+
### HTTP request headers
|
|
858
|
+
|
|
859
|
+
- **Content-Type**: application/json
|
|
860
|
+
- **Accept**: application/json
|
|
861
|
+
|
|
862
|
+
|
|
863
|
+
|
|
864
|
+
<a name="patch_coaching_appointment_status"></a>
|
|
865
|
+
|
|
866
|
+
## [**CoachingAppointmentStatusDto**](CoachingAppointmentStatusDto.html) patch_coaching_appointment_status(appointment_id, body)
|
|
867
|
+
|
|
868
|
+
|
|
869
|
+
|
|
870
|
+
Update the status of a coaching appointment
|
|
871
|
+
|
|
872
|
+
Permission not required if you are an attendee, creator or facilitator of the appointment
|
|
873
|
+
|
|
874
|
+
Wraps PATCH /api/v2/coaching/appointments/{appointmentId}/status
|
|
875
|
+
|
|
876
|
+
Requires ANY permissions:
|
|
877
|
+
|
|
878
|
+
* COACHING:APPOINTMENTSTATUS:EDIT
|
|
879
|
+
|
|
880
|
+
|
|
881
|
+
### Example
|
|
882
|
+
```{"language":"ruby"}
|
|
883
|
+
# load the gem
|
|
884
|
+
require 'purecloudplatformclientv2'
|
|
885
|
+
# setup authorization
|
|
886
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
887
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
888
|
+
environment = "mypurecloud.com"
|
|
889
|
+
|
|
890
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
891
|
+
|
|
892
|
+
PureCloud.configure do |config|
|
|
893
|
+
config.access_token = @authToken
|
|
894
|
+
end
|
|
895
|
+
|
|
896
|
+
api_instance = PureCloud::CoachingApi.new
|
|
897
|
+
|
|
898
|
+
appointment_id = "appointment_id_example" # String | The ID of the coaching appointment.
|
|
899
|
+
|
|
900
|
+
body = PureCloud::CoachingAppointmentStatusDto.new # CoachingAppointmentStatusDto | Updated status of the coaching appointment
|
|
901
|
+
|
|
902
|
+
|
|
903
|
+
begin
|
|
904
|
+
#Update the status of a coaching appointment
|
|
905
|
+
result = api_instance.patch_coaching_appointment_status(appointment_id, body)
|
|
906
|
+
p result
|
|
907
|
+
rescue PureCloud::ApiError => e
|
|
908
|
+
puts "Exception when calling CoachingApi->patch_coaching_appointment_status: #{e}"
|
|
909
|
+
end
|
|
910
|
+
```
|
|
911
|
+
|
|
912
|
+
### Parameters
|
|
913
|
+
|
|
914
|
+
Name | Type | Description | Notes
|
|
915
|
+
------------- | ------------- | ------------- | -------------
|
|
916
|
+
**appointment_id** | **String**| The ID of the coaching appointment. | |
|
|
917
|
+
**body** | [**CoachingAppointmentStatusDto**](CoachingAppointmentStatusDto.html)| Updated status of the coaching appointment | |
|
|
918
|
+
{: class="table table-striped"}
|
|
919
|
+
|
|
920
|
+
|
|
921
|
+
### Return type
|
|
922
|
+
|
|
923
|
+
[**CoachingAppointmentStatusDto**](CoachingAppointmentStatusDto.html)
|
|
924
|
+
|
|
925
|
+
### HTTP request headers
|
|
926
|
+
|
|
927
|
+
- **Content-Type**: application/json
|
|
928
|
+
- **Accept**: application/json
|
|
929
|
+
|
|
930
|
+
|
|
931
|
+
|
|
932
|
+
<a name="patch_coaching_notification"></a>
|
|
933
|
+
|
|
934
|
+
## [**CoachingNotification**](CoachingNotification.html) patch_coaching_notification(notification_id, body)
|
|
935
|
+
|
|
936
|
+
|
|
937
|
+
|
|
938
|
+
Update an existing notification.
|
|
939
|
+
|
|
940
|
+
Can only update your own notifications.
|
|
941
|
+
|
|
942
|
+
Wraps PATCH /api/v2/coaching/notifications/{notificationId}
|
|
943
|
+
|
|
944
|
+
Requires NO permissions:
|
|
945
|
+
|
|
946
|
+
|
|
947
|
+
|
|
948
|
+
### Example
|
|
949
|
+
```{"language":"ruby"}
|
|
950
|
+
# load the gem
|
|
951
|
+
require 'purecloudplatformclientv2'
|
|
952
|
+
# setup authorization
|
|
953
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
954
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
955
|
+
environment = "mypurecloud.com"
|
|
956
|
+
|
|
957
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
958
|
+
|
|
959
|
+
PureCloud.configure do |config|
|
|
960
|
+
config.access_token = @authToken
|
|
961
|
+
end
|
|
962
|
+
|
|
963
|
+
api_instance = PureCloud::CoachingApi.new
|
|
964
|
+
|
|
965
|
+
notification_id = "notification_id_example" # String | The ID of the notification.
|
|
966
|
+
|
|
967
|
+
body = PureCloud::CoachingNotification.new # CoachingNotification | Change the read state of a notification
|
|
968
|
+
|
|
969
|
+
|
|
970
|
+
begin
|
|
971
|
+
#Update an existing notification.
|
|
972
|
+
result = api_instance.patch_coaching_notification(notification_id, body)
|
|
973
|
+
p result
|
|
974
|
+
rescue PureCloud::ApiError => e
|
|
975
|
+
puts "Exception when calling CoachingApi->patch_coaching_notification: #{e}"
|
|
976
|
+
end
|
|
977
|
+
```
|
|
978
|
+
|
|
979
|
+
### Parameters
|
|
980
|
+
|
|
981
|
+
Name | Type | Description | Notes
|
|
982
|
+
------------- | ------------- | ------------- | -------------
|
|
983
|
+
**notification_id** | **String**| The ID of the notification. | |
|
|
984
|
+
**body** | [**CoachingNotification**](CoachingNotification.html)| Change the read state of a notification | |
|
|
985
|
+
{: class="table table-striped"}
|
|
986
|
+
|
|
987
|
+
|
|
988
|
+
### Return type
|
|
989
|
+
|
|
990
|
+
[**CoachingNotification**](CoachingNotification.html)
|
|
991
|
+
|
|
992
|
+
### HTTP request headers
|
|
993
|
+
|
|
994
|
+
- **Content-Type**: application/json
|
|
995
|
+
- **Accept**: application/json
|
|
996
|
+
|
|
997
|
+
|
|
998
|
+
|
|
999
|
+
<a name="post_coaching_appointment_annotations"></a>
|
|
1000
|
+
|
|
1001
|
+
## [**CoachingAnnotation**](CoachingAnnotation.html) post_coaching_appointment_annotations(appointment_id, body)
|
|
1002
|
+
|
|
1003
|
+
|
|
1004
|
+
|
|
1005
|
+
Create a new annotation.
|
|
1006
|
+
|
|
1007
|
+
You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can create private annotations).
|
|
1008
|
+
|
|
1009
|
+
Wraps POST /api/v2/coaching/appointments/{appointmentId}/annotations
|
|
1010
|
+
|
|
1011
|
+
Requires ANY permissions:
|
|
1012
|
+
|
|
1013
|
+
* COACHING:ANNOTATION:ADD
|
|
1014
|
+
* COACHING:PRIVATEANNOTATION:ADD
|
|
1015
|
+
|
|
1016
|
+
|
|
1017
|
+
### Example
|
|
1018
|
+
```{"language":"ruby"}
|
|
1019
|
+
# load the gem
|
|
1020
|
+
require 'purecloudplatformclientv2'
|
|
1021
|
+
# setup authorization
|
|
1022
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1023
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1024
|
+
environment = "mypurecloud.com"
|
|
1025
|
+
|
|
1026
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1027
|
+
|
|
1028
|
+
PureCloud.configure do |config|
|
|
1029
|
+
config.access_token = @authToken
|
|
1030
|
+
end
|
|
1031
|
+
|
|
1032
|
+
api_instance = PureCloud::CoachingApi.new
|
|
1033
|
+
|
|
1034
|
+
appointment_id = "appointment_id_example" # String | The ID of the coaching appointment.
|
|
1035
|
+
|
|
1036
|
+
body = PureCloud::CoachingAnnotationCreateRequest.new # CoachingAnnotationCreateRequest | The annotation to add
|
|
1037
|
+
|
|
1038
|
+
|
|
1039
|
+
begin
|
|
1040
|
+
#Create a new annotation.
|
|
1041
|
+
result = api_instance.post_coaching_appointment_annotations(appointment_id, body)
|
|
1042
|
+
p result
|
|
1043
|
+
rescue PureCloud::ApiError => e
|
|
1044
|
+
puts "Exception when calling CoachingApi->post_coaching_appointment_annotations: #{e}"
|
|
1045
|
+
end
|
|
1046
|
+
```
|
|
1047
|
+
|
|
1048
|
+
### Parameters
|
|
1049
|
+
|
|
1050
|
+
Name | Type | Description | Notes
|
|
1051
|
+
------------- | ------------- | ------------- | -------------
|
|
1052
|
+
**appointment_id** | **String**| The ID of the coaching appointment. | |
|
|
1053
|
+
**body** | [**CoachingAnnotationCreateRequest**](CoachingAnnotationCreateRequest.html)| The annotation to add | |
|
|
1054
|
+
{: class="table table-striped"}
|
|
1055
|
+
|
|
1056
|
+
|
|
1057
|
+
### Return type
|
|
1058
|
+
|
|
1059
|
+
[**CoachingAnnotation**](CoachingAnnotation.html)
|
|
1060
|
+
|
|
1061
|
+
### HTTP request headers
|
|
1062
|
+
|
|
1063
|
+
- **Content-Type**: application/json
|
|
1064
|
+
- **Accept**: application/json
|
|
1065
|
+
|
|
1066
|
+
|
|
1067
|
+
|
|
1068
|
+
<a name="post_coaching_appointments"></a>
|
|
1069
|
+
|
|
1070
|
+
## [**CoachingAppointmentResponse**](CoachingAppointmentResponse.html) post_coaching_appointments(body)
|
|
1071
|
+
|
|
1072
|
+
|
|
1073
|
+
|
|
1074
|
+
Create a new appointment
|
|
1075
|
+
|
|
1076
|
+
|
|
1077
|
+
|
|
1078
|
+
Wraps POST /api/v2/coaching/appointments
|
|
1079
|
+
|
|
1080
|
+
Requires ANY permissions:
|
|
1081
|
+
|
|
1082
|
+
* COACHING:APPOINTMENT:ADD
|
|
1083
|
+
|
|
1084
|
+
|
|
1085
|
+
### Example
|
|
1086
|
+
```{"language":"ruby"}
|
|
1087
|
+
# load the gem
|
|
1088
|
+
require 'purecloudplatformclientv2'
|
|
1089
|
+
# setup authorization
|
|
1090
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1091
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1092
|
+
environment = "mypurecloud.com"
|
|
1093
|
+
|
|
1094
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1095
|
+
|
|
1096
|
+
PureCloud.configure do |config|
|
|
1097
|
+
config.access_token = @authToken
|
|
1098
|
+
end
|
|
1099
|
+
|
|
1100
|
+
api_instance = PureCloud::CoachingApi.new
|
|
1101
|
+
|
|
1102
|
+
body = PureCloud::CreateCoachingAppointmentRequest.new # CreateCoachingAppointmentRequest | The appointment to add
|
|
1103
|
+
|
|
1104
|
+
|
|
1105
|
+
begin
|
|
1106
|
+
#Create a new appointment
|
|
1107
|
+
result = api_instance.post_coaching_appointments(body)
|
|
1108
|
+
p result
|
|
1109
|
+
rescue PureCloud::ApiError => e
|
|
1110
|
+
puts "Exception when calling CoachingApi->post_coaching_appointments: #{e}"
|
|
1111
|
+
end
|
|
1112
|
+
```
|
|
1113
|
+
|
|
1114
|
+
### Parameters
|
|
1115
|
+
|
|
1116
|
+
Name | Type | Description | Notes
|
|
1117
|
+
------------- | ------------- | ------------- | -------------
|
|
1118
|
+
**body** | [**CreateCoachingAppointmentRequest**](CreateCoachingAppointmentRequest.html)| The appointment to add | |
|
|
1119
|
+
{: class="table table-striped"}
|
|
1120
|
+
|
|
1121
|
+
|
|
1122
|
+
### Return type
|
|
1123
|
+
|
|
1124
|
+
[**CoachingAppointmentResponse**](CoachingAppointmentResponse.html)
|
|
1125
|
+
|
|
1126
|
+
### HTTP request headers
|
|
1127
|
+
|
|
1128
|
+
- **Content-Type**: application/json
|
|
1129
|
+
- **Accept**: application/json
|
|
1130
|
+
|
|
1131
|
+
|
|
1132
|
+
|