purecloudplatformclientv2 85.0.1 → 90.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 +5 -5
- 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/ArrayNode.md +5 -5
- 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/BuRescheduleRequest.md +2 -2
- 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/DomainOrganizationRole.md +1 -1
- data/docs/DomainOrganizationRoleCreate.md +1 -1
- data/docs/DomainOrganizationRoleUpdate.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/EntityListing.md +1 -5
- 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/GroupsApi.md +4 -4
- 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/JsonNode.md +5 -5
- 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/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 +12 -12
- 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/ScimEmail.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/UsersApi.md +5 -5
- 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/groups_api.rb +4 -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 +8 -8
- data/lib/purecloudplatformclientv2/api/uploads_api.rb +92 -0
- data/lib/purecloudplatformclientv2/api/usage_api.rb +157 -0
- data/lib/purecloudplatformclientv2/api/users_api.rb +4 -4
- 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 +12 -12
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +12 -12
- 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/array_node.rb +51 -51
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +12 -12
- 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 +12 -12
- data/lib/purecloudplatformclientv2/models/bu_reschedule_request.rb +2 -12
- data/lib/purecloudplatformclientv2/models/bulk_update_shift_trade_state_result_item.rb +2 -2
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +12 -12
- 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 +12 -12
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/callback.rb +30 -4
- data/lib/purecloudplatformclientv2/models/callback_basic.rb +30 -4
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{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 +12 -12
- data/lib/purecloudplatformclientv2/models/cobrowsesession.rb +30 -4
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{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 +12 -12
- 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 +12 -12
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_schema_listing.rb +253 -0
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{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 +12 -12
- data/lib/purecloudplatformclientv2/models/dialogflow_agent.rb +31 -3
- data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{user_schedules_partial_upload_request.rb → document_reference.rb} +34 -16
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge.rb +1 -0
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email.rb +30 -4
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/entity_listing.rb +4 -104
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/external_contact.rb +55 -1
- data/lib/purecloudplatformclientv2/models/external_organization.rb +55 -1
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/flow_division_view.rb +53 -1
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{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 +12 -12
- data/lib/purecloudplatformclientv2/models/{rescheduling_options_response.rb → flow_runtime_execution.rb} +120 -96
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/generic_saml.rb +428 -0
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{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 +12 -12
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +12 -12
- 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 +12 -12
- data/lib/purecloudplatformclientv2/models/json_node.rb +51 -51
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/knowledge_search_response.rb +18 -18
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/lex_bot_alias_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/lex_bot_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/max_length.rb +238 -0
- data/lib/purecloudplatformclientv2/models/message.rb +30 -4
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/messaging_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{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 +12 -12
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/prompt.rb +2 -0
- data/lib/purecloudplatformclientv2/models/prompt_asset.rb +15 -1
- data/lib/purecloudplatformclientv2/models/prompt_asset_create.rb +15 -1
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue.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 +12 -12
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue_request.rb +29 -1
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/recording_job_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/reporting_export_job_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 +12 -12
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{import_short_term_forecast_request.rb → schema.rb} +50 -35
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schema_quantity_limits.rb +539 -0
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/scim_email.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_enterprise_user.rb +30 -4
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/screenshare.rb +30 -4
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/shift_trade_match_violation.rb +2 -2
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/sms_address_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/social_expression.rb +30 -4
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{time_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 +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tts_engine_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tts_voice_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{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 +12 -12
- data/lib/purecloudplatformclientv2/models/user_app_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_queue.rb +29 -1
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/validation_limits.rb +326 -0
- data/lib/purecloudplatformclientv2/models/video.rb +30 -4
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{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 +12 -12
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +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
@@ -4983,6 +4983,71 @@ module PureCloud
|
|
4983
4983
|
return data, status_code, headers
|
4984
4984
|
end
|
4985
4985
|
|
4986
|
+
# Get a flow execution's details. Flow execution details are available for several days after the flow is started.
|
4987
|
+
#
|
4988
|
+
# @param flow_execution_id flow execution ID
|
4989
|
+
# @param [Hash] opts the optional parameters
|
4990
|
+
# @return [FlowRuntimeExecution]
|
4991
|
+
def get_flows_execution(flow_execution_id, opts = {})
|
4992
|
+
data, _status_code, _headers = get_flows_execution_with_http_info(flow_execution_id, opts)
|
4993
|
+
return data
|
4994
|
+
end
|
4995
|
+
|
4996
|
+
# Get a flow execution's details. Flow execution details are available for several days after the flow is started.
|
4997
|
+
#
|
4998
|
+
# @param flow_execution_id flow execution ID
|
4999
|
+
# @param [Hash] opts the optional parameters
|
5000
|
+
# @return [Array<(FlowRuntimeExecution, Fixnum, Hash)>] FlowRuntimeExecution data, response status code and response headers
|
5001
|
+
def get_flows_execution_with_http_info(flow_execution_id, opts = {})
|
5002
|
+
if @api_client.config.debugging
|
5003
|
+
@api_client.config.logger.debug "Calling API: ArchitectApi.get_flows_execution ..."
|
5004
|
+
end
|
5005
|
+
|
5006
|
+
|
5007
|
+
# verify the required parameter 'flow_execution_id' is set
|
5008
|
+
fail ArgumentError, "Missing the required parameter 'flow_execution_id' when calling ArchitectApi.get_flows_execution" if flow_execution_id.nil?
|
5009
|
+
|
5010
|
+
|
5011
|
+
|
5012
|
+
|
5013
|
+
|
5014
|
+
# resource path
|
5015
|
+
local_var_path = "/api/v2/flows/executions/{flowExecutionId}".sub('{format}','json').sub('{' + 'flowExecutionId' + '}', flow_execution_id.to_s)
|
5016
|
+
|
5017
|
+
# query parameters
|
5018
|
+
query_params = {}
|
5019
|
+
|
5020
|
+
# header parameters
|
5021
|
+
header_params = {}
|
5022
|
+
|
5023
|
+
# HTTP header 'Accept' (if needed)
|
5024
|
+
local_header_accept = ['application/json']
|
5025
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
5026
|
+
|
5027
|
+
# HTTP header 'Content-Type'
|
5028
|
+
local_header_content_type = ['application/json']
|
5029
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
5030
|
+
|
5031
|
+
# form parameters
|
5032
|
+
form_params = {}
|
5033
|
+
|
5034
|
+
# http body (model)
|
5035
|
+
post_body = nil
|
5036
|
+
|
5037
|
+
auth_names = ['PureCloud OAuth']
|
5038
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
5039
|
+
:header_params => header_params,
|
5040
|
+
:query_params => query_params,
|
5041
|
+
:form_params => form_params,
|
5042
|
+
:body => post_body,
|
5043
|
+
:auth_names => auth_names,
|
5044
|
+
:return_type => 'FlowRuntimeExecution')
|
5045
|
+
if @api_client.config.debugging
|
5046
|
+
@api_client.config.logger.debug "API called: ArchitectApi#get_flows_execution\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
5047
|
+
end
|
5048
|
+
return data, status_code, headers
|
5049
|
+
end
|
5050
|
+
|
4986
5051
|
# Get a flow outcome
|
4987
5052
|
# Returns a specified flow outcome
|
4988
5053
|
# @param flow_outcome_id flow outcome ID
|
@@ -6659,6 +6724,71 @@ module PureCloud
|
|
6659
6724
|
return data, status_code, headers
|
6660
6725
|
end
|
6661
6726
|
|
6727
|
+
# Launch an instance of a flow definition, for flow types that support it such as the 'workflow' type.
|
6728
|
+
# The launch is asynchronous, it returns as soon as the flow starts. You can use the returned ID to query its status if you need.
|
6729
|
+
# @param flow_launch_request
|
6730
|
+
# @param [Hash] opts the optional parameters
|
6731
|
+
# @return [FlowExecutionLaunchResponse]
|
6732
|
+
def post_flows_executions(flow_launch_request, opts = {})
|
6733
|
+
data, _status_code, _headers = post_flows_executions_with_http_info(flow_launch_request, opts)
|
6734
|
+
return data
|
6735
|
+
end
|
6736
|
+
|
6737
|
+
# Launch an instance of a flow definition, for flow types that support it such as the 'workflow' type.
|
6738
|
+
# The launch is asynchronous, it returns as soon as the flow starts. You can use the returned ID to query its status if you need.
|
6739
|
+
# @param flow_launch_request
|
6740
|
+
# @param [Hash] opts the optional parameters
|
6741
|
+
# @return [Array<(FlowExecutionLaunchResponse, Fixnum, Hash)>] FlowExecutionLaunchResponse data, response status code and response headers
|
6742
|
+
def post_flows_executions_with_http_info(flow_launch_request, opts = {})
|
6743
|
+
if @api_client.config.debugging
|
6744
|
+
@api_client.config.logger.debug "Calling API: ArchitectApi.post_flows_executions ..."
|
6745
|
+
end
|
6746
|
+
|
6747
|
+
|
6748
|
+
# verify the required parameter 'flow_launch_request' is set
|
6749
|
+
fail ArgumentError, "Missing the required parameter 'flow_launch_request' when calling ArchitectApi.post_flows_executions" if flow_launch_request.nil?
|
6750
|
+
|
6751
|
+
|
6752
|
+
|
6753
|
+
|
6754
|
+
|
6755
|
+
# resource path
|
6756
|
+
local_var_path = "/api/v2/flows/executions".sub('{format}','json')
|
6757
|
+
|
6758
|
+
# query parameters
|
6759
|
+
query_params = {}
|
6760
|
+
|
6761
|
+
# header parameters
|
6762
|
+
header_params = {}
|
6763
|
+
|
6764
|
+
# HTTP header 'Accept' (if needed)
|
6765
|
+
local_header_accept = ['application/json']
|
6766
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
6767
|
+
|
6768
|
+
# HTTP header 'Content-Type'
|
6769
|
+
local_header_content_type = ['application/json']
|
6770
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
6771
|
+
|
6772
|
+
# form parameters
|
6773
|
+
form_params = {}
|
6774
|
+
|
6775
|
+
# http body (model)
|
6776
|
+
post_body = @api_client.object_to_http_body(flow_launch_request)
|
6777
|
+
|
6778
|
+
auth_names = ['PureCloud OAuth']
|
6779
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
6780
|
+
:header_params => header_params,
|
6781
|
+
:query_params => query_params,
|
6782
|
+
:form_params => form_params,
|
6783
|
+
:body => post_body,
|
6784
|
+
:auth_names => auth_names,
|
6785
|
+
:return_type => 'FlowExecutionLaunchResponse')
|
6786
|
+
if @api_client.config.debugging
|
6787
|
+
@api_client.config.logger.debug "API called: ArchitectApi#post_flows_executions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
6788
|
+
end
|
6789
|
+
return data, status_code, headers
|
6790
|
+
end
|
6791
|
+
|
6662
6792
|
# Create a flow outcome
|
6663
6793
|
# Asynchronous. Notification topic: v2.flows.outcomes.{flowOutcomeId}
|
6664
6794
|
# @param [Hash] opts the optional parameters
|
@@ -24,6 +24,61 @@ module PureCloud
|
|
24
24
|
@api_client = api_client
|
25
25
|
end
|
26
26
|
|
27
|
+
# Get service mapping information used in audits.
|
28
|
+
#
|
29
|
+
# @param [Hash] opts the optional parameters
|
30
|
+
# @return [AuditQueryServiceMapping]
|
31
|
+
def get_audits_query_servicemapping(opts = {})
|
32
|
+
data, _status_code, _headers = get_audits_query_servicemapping_with_http_info(opts)
|
33
|
+
return data
|
34
|
+
end
|
35
|
+
|
36
|
+
# Get service mapping information used in audits.
|
37
|
+
#
|
38
|
+
# @param [Hash] opts the optional parameters
|
39
|
+
# @return [Array<(AuditQueryServiceMapping, Fixnum, Hash)>] AuditQueryServiceMapping data, response status code and response headers
|
40
|
+
def get_audits_query_servicemapping_with_http_info(opts = {})
|
41
|
+
if @api_client.config.debugging
|
42
|
+
@api_client.config.logger.debug "Calling API: AuditApi.get_audits_query_servicemapping ..."
|
43
|
+
end
|
44
|
+
|
45
|
+
# resource path
|
46
|
+
local_var_path = "/api/v2/audits/query/servicemapping".sub('{format}','json')
|
47
|
+
|
48
|
+
# query parameters
|
49
|
+
query_params = {}
|
50
|
+
|
51
|
+
# header parameters
|
52
|
+
header_params = {}
|
53
|
+
|
54
|
+
# HTTP header 'Accept' (if needed)
|
55
|
+
local_header_accept = ['application/json']
|
56
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
57
|
+
|
58
|
+
# HTTP header 'Content-Type'
|
59
|
+
local_header_content_type = ['application/json']
|
60
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
61
|
+
|
62
|
+
# form parameters
|
63
|
+
form_params = {}
|
64
|
+
|
65
|
+
# http body (model)
|
66
|
+
post_body = nil
|
67
|
+
|
68
|
+
auth_names = ['PureCloud OAuth']
|
69
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
70
|
+
:header_params => header_params,
|
71
|
+
:query_params => query_params,
|
72
|
+
:form_params => form_params,
|
73
|
+
:body => post_body,
|
74
|
+
:auth_names => auth_names,
|
75
|
+
:return_type => 'AuditQueryServiceMapping')
|
76
|
+
if @api_client.config.debugging
|
77
|
+
@api_client.config.logger.debug "API called: AuditApi#get_audits_query_servicemapping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
78
|
+
end
|
79
|
+
return data, status_code, headers
|
80
|
+
end
|
81
|
+
|
27
82
|
# Get status of audit query execution
|
28
83
|
#
|
29
84
|
# @param transaction_id Transaction ID
|
@@ -0,0 +1,1296 @@
|
|
1
|
+
=begin
|
2
|
+
PureCloud Platform API
|
3
|
+
|
4
|
+
With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
|
5
|
+
|
6
|
+
OpenAPI spec version: v2
|
7
|
+
Contact: DeveloperEvangelists@genesys.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
|
10
|
+
License: UNLICENSED
|
11
|
+
https://help.mypurecloud.com/articles/terms-and-conditions/
|
12
|
+
|
13
|
+
Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
|
14
|
+
|
15
|
+
=end
|
16
|
+
|
17
|
+
require "uri"
|
18
|
+
|
19
|
+
module PureCloud
|
20
|
+
class CoachingApi
|
21
|
+
attr_accessor :api_client
|
22
|
+
|
23
|
+
def initialize(api_client = ApiClient.default)
|
24
|
+
@api_client = api_client
|
25
|
+
end
|
26
|
+
|
27
|
+
# Delete an existing appointment
|
28
|
+
# Permission not required if you are the creator of the appointment
|
29
|
+
# @param appointment_id The ID of the coaching appointment.
|
30
|
+
# @param [Hash] opts the optional parameters
|
31
|
+
# @return [nil]
|
32
|
+
def delete_coaching_appointment(appointment_id, opts = {})
|
33
|
+
delete_coaching_appointment_with_http_info(appointment_id, opts)
|
34
|
+
return nil
|
35
|
+
end
|
36
|
+
|
37
|
+
# Delete an existing appointment
|
38
|
+
# Permission not required if you are the creator of the appointment
|
39
|
+
# @param appointment_id The ID of the coaching appointment.
|
40
|
+
# @param [Hash] opts the optional parameters
|
41
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
42
|
+
def delete_coaching_appointment_with_http_info(appointment_id, opts = {})
|
43
|
+
if @api_client.config.debugging
|
44
|
+
@api_client.config.logger.debug "Calling API: CoachingApi.delete_coaching_appointment ..."
|
45
|
+
end
|
46
|
+
|
47
|
+
|
48
|
+
# verify the required parameter 'appointment_id' is set
|
49
|
+
fail ArgumentError, "Missing the required parameter 'appointment_id' when calling CoachingApi.delete_coaching_appointment" if appointment_id.nil?
|
50
|
+
|
51
|
+
|
52
|
+
|
53
|
+
|
54
|
+
|
55
|
+
# resource path
|
56
|
+
local_var_path = "/api/v2/coaching/appointments/{appointmentId}".sub('{format}','json').sub('{' + 'appointmentId' + '}', appointment_id.to_s)
|
57
|
+
|
58
|
+
# query parameters
|
59
|
+
query_params = {}
|
60
|
+
|
61
|
+
# header parameters
|
62
|
+
header_params = {}
|
63
|
+
|
64
|
+
# HTTP header 'Accept' (if needed)
|
65
|
+
local_header_accept = ['application/json']
|
66
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
67
|
+
|
68
|
+
# HTTP header 'Content-Type'
|
69
|
+
local_header_content_type = ['application/json']
|
70
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
71
|
+
|
72
|
+
# form parameters
|
73
|
+
form_params = {}
|
74
|
+
|
75
|
+
# http body (model)
|
76
|
+
post_body = nil
|
77
|
+
|
78
|
+
auth_names = ['PureCloud OAuth']
|
79
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
80
|
+
:header_params => header_params,
|
81
|
+
:query_params => query_params,
|
82
|
+
:form_params => form_params,
|
83
|
+
:body => post_body,
|
84
|
+
:auth_names => auth_names)
|
85
|
+
if @api_client.config.debugging
|
86
|
+
@api_client.config.logger.debug "API called: CoachingApi#delete_coaching_appointment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
87
|
+
end
|
88
|
+
return data, status_code, headers
|
89
|
+
end
|
90
|
+
|
91
|
+
# Delete an existing annotation
|
92
|
+
# 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
|
93
|
+
# @param appointment_id The ID of the coaching appointment.
|
94
|
+
# @param annotation_id The ID of the annotation.
|
95
|
+
# @param [Hash] opts the optional parameters
|
96
|
+
# @return [nil]
|
97
|
+
def delete_coaching_appointment_annotation(appointment_id, annotation_id, opts = {})
|
98
|
+
delete_coaching_appointment_annotation_with_http_info(appointment_id, annotation_id, opts)
|
99
|
+
return nil
|
100
|
+
end
|
101
|
+
|
102
|
+
# Delete an existing annotation
|
103
|
+
# 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
|
104
|
+
# @param appointment_id The ID of the coaching appointment.
|
105
|
+
# @param annotation_id The ID of the annotation.
|
106
|
+
# @param [Hash] opts the optional parameters
|
107
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
108
|
+
def delete_coaching_appointment_annotation_with_http_info(appointment_id, annotation_id, opts = {})
|
109
|
+
if @api_client.config.debugging
|
110
|
+
@api_client.config.logger.debug "Calling API: CoachingApi.delete_coaching_appointment_annotation ..."
|
111
|
+
end
|
112
|
+
|
113
|
+
|
114
|
+
# verify the required parameter 'appointment_id' is set
|
115
|
+
fail ArgumentError, "Missing the required parameter 'appointment_id' when calling CoachingApi.delete_coaching_appointment_annotation" if appointment_id.nil?
|
116
|
+
|
117
|
+
|
118
|
+
|
119
|
+
|
120
|
+
|
121
|
+
|
122
|
+
# verify the required parameter 'annotation_id' is set
|
123
|
+
fail ArgumentError, "Missing the required parameter 'annotation_id' when calling CoachingApi.delete_coaching_appointment_annotation" if annotation_id.nil?
|
124
|
+
|
125
|
+
|
126
|
+
|
127
|
+
|
128
|
+
|
129
|
+
# resource path
|
130
|
+
local_var_path = "/api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId}".sub('{format}','json').sub('{' + 'appointmentId' + '}', appointment_id.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)
|
131
|
+
|
132
|
+
# query parameters
|
133
|
+
query_params = {}
|
134
|
+
|
135
|
+
# header parameters
|
136
|
+
header_params = {}
|
137
|
+
|
138
|
+
# HTTP header 'Accept' (if needed)
|
139
|
+
local_header_accept = ['application/json']
|
140
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
141
|
+
|
142
|
+
# HTTP header 'Content-Type'
|
143
|
+
local_header_content_type = ['application/json']
|
144
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
145
|
+
|
146
|
+
# form parameters
|
147
|
+
form_params = {}
|
148
|
+
|
149
|
+
# http body (model)
|
150
|
+
post_body = nil
|
151
|
+
|
152
|
+
auth_names = ['PureCloud OAuth']
|
153
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
154
|
+
:header_params => header_params,
|
155
|
+
:query_params => query_params,
|
156
|
+
:form_params => form_params,
|
157
|
+
:body => post_body,
|
158
|
+
:auth_names => auth_names)
|
159
|
+
if @api_client.config.debugging
|
160
|
+
@api_client.config.logger.debug "API called: CoachingApi#delete_coaching_appointment_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
161
|
+
end
|
162
|
+
return data, status_code, headers
|
163
|
+
end
|
164
|
+
|
165
|
+
# Retrieve an appointment
|
166
|
+
# Permission not required if you are the attendee, creator or facilitator of the appointment
|
167
|
+
# @param appointment_id The ID of the coaching appointment.
|
168
|
+
# @param [Hash] opts the optional parameters
|
169
|
+
# @return [CoachingAppointmentResponse]
|
170
|
+
def get_coaching_appointment(appointment_id, opts = {})
|
171
|
+
data, _status_code, _headers = get_coaching_appointment_with_http_info(appointment_id, opts)
|
172
|
+
return data
|
173
|
+
end
|
174
|
+
|
175
|
+
# Retrieve an appointment
|
176
|
+
# Permission not required if you are the attendee, creator or facilitator of the appointment
|
177
|
+
# @param appointment_id The ID of the coaching appointment.
|
178
|
+
# @param [Hash] opts the optional parameters
|
179
|
+
# @return [Array<(CoachingAppointmentResponse, Fixnum, Hash)>] CoachingAppointmentResponse data, response status code and response headers
|
180
|
+
def get_coaching_appointment_with_http_info(appointment_id, opts = {})
|
181
|
+
if @api_client.config.debugging
|
182
|
+
@api_client.config.logger.debug "Calling API: CoachingApi.get_coaching_appointment ..."
|
183
|
+
end
|
184
|
+
|
185
|
+
|
186
|
+
# verify the required parameter 'appointment_id' is set
|
187
|
+
fail ArgumentError, "Missing the required parameter 'appointment_id' when calling CoachingApi.get_coaching_appointment" if appointment_id.nil?
|
188
|
+
|
189
|
+
|
190
|
+
|
191
|
+
|
192
|
+
|
193
|
+
# resource path
|
194
|
+
local_var_path = "/api/v2/coaching/appointments/{appointmentId}".sub('{format}','json').sub('{' + 'appointmentId' + '}', appointment_id.to_s)
|
195
|
+
|
196
|
+
# query parameters
|
197
|
+
query_params = {}
|
198
|
+
|
199
|
+
# header parameters
|
200
|
+
header_params = {}
|
201
|
+
|
202
|
+
# HTTP header 'Accept' (if needed)
|
203
|
+
local_header_accept = ['application/json']
|
204
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
205
|
+
|
206
|
+
# HTTP header 'Content-Type'
|
207
|
+
local_header_content_type = ['application/json']
|
208
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
209
|
+
|
210
|
+
# form parameters
|
211
|
+
form_params = {}
|
212
|
+
|
213
|
+
# http body (model)
|
214
|
+
post_body = nil
|
215
|
+
|
216
|
+
auth_names = ['PureCloud OAuth']
|
217
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
218
|
+
:header_params => header_params,
|
219
|
+
:query_params => query_params,
|
220
|
+
:form_params => form_params,
|
221
|
+
:body => post_body,
|
222
|
+
:auth_names => auth_names,
|
223
|
+
:return_type => 'CoachingAppointmentResponse')
|
224
|
+
if @api_client.config.debugging
|
225
|
+
@api_client.config.logger.debug "API called: CoachingApi#get_coaching_appointment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
226
|
+
end
|
227
|
+
return data, status_code, headers
|
228
|
+
end
|
229
|
+
|
230
|
+
# Retrieve an annotation.
|
231
|
+
# 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).
|
232
|
+
# @param appointment_id The ID of the coaching appointment.
|
233
|
+
# @param annotation_id The ID of the annotation.
|
234
|
+
# @param [Hash] opts the optional parameters
|
235
|
+
# @return [CoachingAnnotation]
|
236
|
+
def get_coaching_appointment_annotation(appointment_id, annotation_id, opts = {})
|
237
|
+
data, _status_code, _headers = get_coaching_appointment_annotation_with_http_info(appointment_id, annotation_id, opts)
|
238
|
+
return data
|
239
|
+
end
|
240
|
+
|
241
|
+
# Retrieve an annotation.
|
242
|
+
# 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).
|
243
|
+
# @param appointment_id The ID of the coaching appointment.
|
244
|
+
# @param annotation_id The ID of the annotation.
|
245
|
+
# @param [Hash] opts the optional parameters
|
246
|
+
# @return [Array<(CoachingAnnotation, Fixnum, Hash)>] CoachingAnnotation data, response status code and response headers
|
247
|
+
def get_coaching_appointment_annotation_with_http_info(appointment_id, annotation_id, opts = {})
|
248
|
+
if @api_client.config.debugging
|
249
|
+
@api_client.config.logger.debug "Calling API: CoachingApi.get_coaching_appointment_annotation ..."
|
250
|
+
end
|
251
|
+
|
252
|
+
|
253
|
+
# verify the required parameter 'appointment_id' is set
|
254
|
+
fail ArgumentError, "Missing the required parameter 'appointment_id' when calling CoachingApi.get_coaching_appointment_annotation" if appointment_id.nil?
|
255
|
+
|
256
|
+
|
257
|
+
|
258
|
+
|
259
|
+
|
260
|
+
|
261
|
+
# verify the required parameter 'annotation_id' is set
|
262
|
+
fail ArgumentError, "Missing the required parameter 'annotation_id' when calling CoachingApi.get_coaching_appointment_annotation" if annotation_id.nil?
|
263
|
+
|
264
|
+
|
265
|
+
|
266
|
+
|
267
|
+
|
268
|
+
# resource path
|
269
|
+
local_var_path = "/api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId}".sub('{format}','json').sub('{' + 'appointmentId' + '}', appointment_id.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)
|
270
|
+
|
271
|
+
# query parameters
|
272
|
+
query_params = {}
|
273
|
+
|
274
|
+
# header parameters
|
275
|
+
header_params = {}
|
276
|
+
|
277
|
+
# HTTP header 'Accept' (if needed)
|
278
|
+
local_header_accept = ['application/json']
|
279
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
280
|
+
|
281
|
+
# HTTP header 'Content-Type'
|
282
|
+
local_header_content_type = ['application/json']
|
283
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
284
|
+
|
285
|
+
# form parameters
|
286
|
+
form_params = {}
|
287
|
+
|
288
|
+
# http body (model)
|
289
|
+
post_body = nil
|
290
|
+
|
291
|
+
auth_names = ['PureCloud OAuth']
|
292
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
293
|
+
:header_params => header_params,
|
294
|
+
:query_params => query_params,
|
295
|
+
:form_params => form_params,
|
296
|
+
:body => post_body,
|
297
|
+
:auth_names => auth_names,
|
298
|
+
:return_type => 'CoachingAnnotation')
|
299
|
+
if @api_client.config.debugging
|
300
|
+
@api_client.config.logger.debug "API called: CoachingApi#get_coaching_appointment_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
301
|
+
end
|
302
|
+
return data, status_code, headers
|
303
|
+
end
|
304
|
+
|
305
|
+
# Get a list of annotations.
|
306
|
+
# 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).
|
307
|
+
# @param appointment_id The ID of the coaching appointment.
|
308
|
+
# @param [Hash] opts the optional parameters
|
309
|
+
# @option opts [Integer] :page_number Page number (default to 1)
|
310
|
+
# @option opts [Integer] :page_size Page size (default to 25)
|
311
|
+
# @return [CoachingAnnotationList]
|
312
|
+
def get_coaching_appointment_annotations(appointment_id, opts = {})
|
313
|
+
data, _status_code, _headers = get_coaching_appointment_annotations_with_http_info(appointment_id, opts)
|
314
|
+
return data
|
315
|
+
end
|
316
|
+
|
317
|
+
# Get a list of annotations.
|
318
|
+
# 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).
|
319
|
+
# @param appointment_id The ID of the coaching appointment.
|
320
|
+
# @param [Hash] opts the optional parameters
|
321
|
+
# @option opts [Integer] :page_number Page number
|
322
|
+
# @option opts [Integer] :page_size Page size
|
323
|
+
# @return [Array<(CoachingAnnotationList, Fixnum, Hash)>] CoachingAnnotationList data, response status code and response headers
|
324
|
+
def get_coaching_appointment_annotations_with_http_info(appointment_id, opts = {})
|
325
|
+
if @api_client.config.debugging
|
326
|
+
@api_client.config.logger.debug "Calling API: CoachingApi.get_coaching_appointment_annotations ..."
|
327
|
+
end
|
328
|
+
|
329
|
+
|
330
|
+
# verify the required parameter 'appointment_id' is set
|
331
|
+
fail ArgumentError, "Missing the required parameter 'appointment_id' when calling CoachingApi.get_coaching_appointment_annotations" if appointment_id.nil?
|
332
|
+
|
333
|
+
|
334
|
+
|
335
|
+
|
336
|
+
|
337
|
+
|
338
|
+
|
339
|
+
|
340
|
+
|
341
|
+
|
342
|
+
|
343
|
+
|
344
|
+
|
345
|
+
|
346
|
+
|
347
|
+
|
348
|
+
|
349
|
+
# resource path
|
350
|
+
local_var_path = "/api/v2/coaching/appointments/{appointmentId}/annotations".sub('{format}','json').sub('{' + 'appointmentId' + '}', appointment_id.to_s)
|
351
|
+
|
352
|
+
# query parameters
|
353
|
+
query_params = {}
|
354
|
+
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
355
|
+
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
356
|
+
|
357
|
+
# header parameters
|
358
|
+
header_params = {}
|
359
|
+
|
360
|
+
# HTTP header 'Accept' (if needed)
|
361
|
+
local_header_accept = ['application/json']
|
362
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
363
|
+
|
364
|
+
# HTTP header 'Content-Type'
|
365
|
+
local_header_content_type = ['application/json']
|
366
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
367
|
+
|
368
|
+
# form parameters
|
369
|
+
form_params = {}
|
370
|
+
|
371
|
+
# http body (model)
|
372
|
+
post_body = nil
|
373
|
+
|
374
|
+
auth_names = ['PureCloud OAuth']
|
375
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
376
|
+
:header_params => header_params,
|
377
|
+
:query_params => query_params,
|
378
|
+
:form_params => form_params,
|
379
|
+
:body => post_body,
|
380
|
+
:auth_names => auth_names,
|
381
|
+
:return_type => 'CoachingAnnotationList')
|
382
|
+
if @api_client.config.debugging
|
383
|
+
@api_client.config.logger.debug "API called: CoachingApi#get_coaching_appointment_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
384
|
+
end
|
385
|
+
return data, status_code, headers
|
386
|
+
end
|
387
|
+
|
388
|
+
# Get the list of status changes for a coaching appointment.
|
389
|
+
# Permission not required if you are an attendee, creator or facilitator of the appointment
|
390
|
+
# @param appointment_id The ID of the coaching appointment.
|
391
|
+
# @param [Hash] opts the optional parameters
|
392
|
+
# @option opts [Integer] :page_number Page number (default to 1)
|
393
|
+
# @option opts [Integer] :page_size Page size (default to 25)
|
394
|
+
# @return [CoachingAppointmentStatusDtoList]
|
395
|
+
def get_coaching_appointment_statuses(appointment_id, opts = {})
|
396
|
+
data, _status_code, _headers = get_coaching_appointment_statuses_with_http_info(appointment_id, opts)
|
397
|
+
return data
|
398
|
+
end
|
399
|
+
|
400
|
+
# Get the list of status changes for a coaching appointment.
|
401
|
+
# Permission not required if you are an attendee, creator or facilitator of the appointment
|
402
|
+
# @param appointment_id The ID of the coaching appointment.
|
403
|
+
# @param [Hash] opts the optional parameters
|
404
|
+
# @option opts [Integer] :page_number Page number
|
405
|
+
# @option opts [Integer] :page_size Page size
|
406
|
+
# @return [Array<(CoachingAppointmentStatusDtoList, Fixnum, Hash)>] CoachingAppointmentStatusDtoList data, response status code and response headers
|
407
|
+
def get_coaching_appointment_statuses_with_http_info(appointment_id, opts = {})
|
408
|
+
if @api_client.config.debugging
|
409
|
+
@api_client.config.logger.debug "Calling API: CoachingApi.get_coaching_appointment_statuses ..."
|
410
|
+
end
|
411
|
+
|
412
|
+
|
413
|
+
# verify the required parameter 'appointment_id' is set
|
414
|
+
fail ArgumentError, "Missing the required parameter 'appointment_id' when calling CoachingApi.get_coaching_appointment_statuses" if appointment_id.nil?
|
415
|
+
|
416
|
+
|
417
|
+
|
418
|
+
|
419
|
+
|
420
|
+
|
421
|
+
|
422
|
+
|
423
|
+
|
424
|
+
|
425
|
+
|
426
|
+
|
427
|
+
|
428
|
+
|
429
|
+
|
430
|
+
|
431
|
+
|
432
|
+
# resource path
|
433
|
+
local_var_path = "/api/v2/coaching/appointments/{appointmentId}/statuses".sub('{format}','json').sub('{' + 'appointmentId' + '}', appointment_id.to_s)
|
434
|
+
|
435
|
+
# query parameters
|
436
|
+
query_params = {}
|
437
|
+
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
438
|
+
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
439
|
+
|
440
|
+
# header parameters
|
441
|
+
header_params = {}
|
442
|
+
|
443
|
+
# HTTP header 'Accept' (if needed)
|
444
|
+
local_header_accept = ['application/json']
|
445
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
446
|
+
|
447
|
+
# HTTP header 'Content-Type'
|
448
|
+
local_header_content_type = ['application/json']
|
449
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
450
|
+
|
451
|
+
# form parameters
|
452
|
+
form_params = {}
|
453
|
+
|
454
|
+
# http body (model)
|
455
|
+
post_body = nil
|
456
|
+
|
457
|
+
auth_names = ['PureCloud OAuth']
|
458
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
459
|
+
:header_params => header_params,
|
460
|
+
:query_params => query_params,
|
461
|
+
:form_params => form_params,
|
462
|
+
:body => post_body,
|
463
|
+
:auth_names => auth_names,
|
464
|
+
:return_type => 'CoachingAppointmentStatusDtoList')
|
465
|
+
if @api_client.config.debugging
|
466
|
+
@api_client.config.logger.debug "API called: CoachingApi#get_coaching_appointment_statuses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
467
|
+
end
|
468
|
+
return data, status_code, headers
|
469
|
+
end
|
470
|
+
|
471
|
+
# Get appointments for users and optional date range
|
472
|
+
#
|
473
|
+
# @param user_ids The user IDs for which to retrieve appointments
|
474
|
+
# @param [Hash] opts the optional parameters
|
475
|
+
# @option opts [String] :interval Interval string; format is ISO-8601. Separate start and end times with forward slash '/'
|
476
|
+
# @option opts [Integer] :page_number Page number (default to 1)
|
477
|
+
# @option opts [Integer] :page_size Page size (default to 25)
|
478
|
+
# @option opts [Array<String>] :statuses Appointment Statuses to filter by
|
479
|
+
# @option opts [Array<String>] :facilitator_ids The facilitator IDs for which to retrieve appointments
|
480
|
+
# @option opts [String] :sort_order Sort (by due date) either Asc or Desc
|
481
|
+
# @return [CoachingAppointmentResponseList]
|
482
|
+
def get_coaching_appointments(user_ids, opts = {})
|
483
|
+
data, _status_code, _headers = get_coaching_appointments_with_http_info(user_ids, opts)
|
484
|
+
return data
|
485
|
+
end
|
486
|
+
|
487
|
+
# Get appointments for users and optional date range
|
488
|
+
#
|
489
|
+
# @param user_ids The user IDs for which to retrieve appointments
|
490
|
+
# @param [Hash] opts the optional parameters
|
491
|
+
# @option opts [String] :interval Interval string; format is ISO-8601. Separate start and end times with forward slash '/'
|
492
|
+
# @option opts [Integer] :page_number Page number
|
493
|
+
# @option opts [Integer] :page_size Page size
|
494
|
+
# @option opts [Array<String>] :statuses Appointment Statuses to filter by
|
495
|
+
# @option opts [Array<String>] :facilitator_ids The facilitator IDs for which to retrieve appointments
|
496
|
+
# @option opts [String] :sort_order Sort (by due date) either Asc or Desc
|
497
|
+
# @return [Array<(CoachingAppointmentResponseList, Fixnum, Hash)>] CoachingAppointmentResponseList data, response status code and response headers
|
498
|
+
def get_coaching_appointments_with_http_info(user_ids, opts = {})
|
499
|
+
if @api_client.config.debugging
|
500
|
+
@api_client.config.logger.debug "Calling API: CoachingApi.get_coaching_appointments ..."
|
501
|
+
end
|
502
|
+
|
503
|
+
|
504
|
+
# verify the required parameter 'user_ids' is set
|
505
|
+
fail ArgumentError, "Missing the required parameter 'user_ids' when calling CoachingApi.get_coaching_appointments" if user_ids.nil?
|
506
|
+
|
507
|
+
|
508
|
+
|
509
|
+
|
510
|
+
|
511
|
+
|
512
|
+
|
513
|
+
|
514
|
+
|
515
|
+
|
516
|
+
|
517
|
+
|
518
|
+
|
519
|
+
|
520
|
+
|
521
|
+
|
522
|
+
|
523
|
+
|
524
|
+
|
525
|
+
|
526
|
+
|
527
|
+
|
528
|
+
|
529
|
+
|
530
|
+
|
531
|
+
|
532
|
+
|
533
|
+
|
534
|
+
|
535
|
+
|
536
|
+
|
537
|
+
|
538
|
+
|
539
|
+
|
540
|
+
|
541
|
+
|
542
|
+
|
543
|
+
|
544
|
+
if opts[:'sort_order'] && !['Desc', 'Asc'].include?(opts[:'sort_order'])
|
545
|
+
fail ArgumentError, 'invalid value for "sort_order", must be one of Desc, Asc'
|
546
|
+
end
|
547
|
+
|
548
|
+
|
549
|
+
|
550
|
+
|
551
|
+
# resource path
|
552
|
+
local_var_path = "/api/v2/coaching/appointments".sub('{format}','json')
|
553
|
+
|
554
|
+
# query parameters
|
555
|
+
query_params = {}
|
556
|
+
query_params[:'userIds'] = @api_client.build_collection_param(user_ids, :multi)
|
557
|
+
query_params[:'interval'] = opts[:'interval'] if opts[:'interval']
|
558
|
+
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
559
|
+
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
560
|
+
query_params[:'statuses'] = @api_client.build_collection_param(opts[:'statuses'], :multi) if opts[:'statuses']
|
561
|
+
query_params[:'facilitatorIds'] = @api_client.build_collection_param(opts[:'facilitator_ids'], :multi) if opts[:'facilitator_ids']
|
562
|
+
query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
|
563
|
+
|
564
|
+
# header parameters
|
565
|
+
header_params = {}
|
566
|
+
|
567
|
+
# HTTP header 'Accept' (if needed)
|
568
|
+
local_header_accept = ['application/json']
|
569
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
570
|
+
|
571
|
+
# HTTP header 'Content-Type'
|
572
|
+
local_header_content_type = ['application/json']
|
573
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
574
|
+
|
575
|
+
# form parameters
|
576
|
+
form_params = {}
|
577
|
+
|
578
|
+
# http body (model)
|
579
|
+
post_body = nil
|
580
|
+
|
581
|
+
auth_names = ['PureCloud OAuth']
|
582
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
583
|
+
:header_params => header_params,
|
584
|
+
:query_params => query_params,
|
585
|
+
:form_params => form_params,
|
586
|
+
:body => post_body,
|
587
|
+
:auth_names => auth_names,
|
588
|
+
:return_type => 'CoachingAppointmentResponseList')
|
589
|
+
if @api_client.config.debugging
|
590
|
+
@api_client.config.logger.debug "API called: CoachingApi#get_coaching_appointments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
591
|
+
end
|
592
|
+
return data, status_code, headers
|
593
|
+
end
|
594
|
+
|
595
|
+
# Get my appointments for a given date range
|
596
|
+
#
|
597
|
+
# @param [Hash] opts the optional parameters
|
598
|
+
# @option opts [String] :interval Interval string; format is ISO-8601. Separate start and end times with forward slash '/'
|
599
|
+
# @option opts [Integer] :page_number Page number (default to 1)
|
600
|
+
# @option opts [Integer] :page_size Page size (default to 25)
|
601
|
+
# @option opts [Array<String>] :statuses Appointment Statuses to filter by
|
602
|
+
# @option opts [Array<String>] :facilitator_ids The facilitator IDs for which to retrieve appointments
|
603
|
+
# @option opts [String] :sort_order Sort (by due date) either Asc or Desc
|
604
|
+
# @return [CoachingAppointmentResponseList]
|
605
|
+
def get_coaching_appointments_me(opts = {})
|
606
|
+
data, _status_code, _headers = get_coaching_appointments_me_with_http_info(opts)
|
607
|
+
return data
|
608
|
+
end
|
609
|
+
|
610
|
+
# Get my appointments for a given date range
|
611
|
+
#
|
612
|
+
# @param [Hash] opts the optional parameters
|
613
|
+
# @option opts [String] :interval Interval string; format is ISO-8601. Separate start and end times with forward slash '/'
|
614
|
+
# @option opts [Integer] :page_number Page number
|
615
|
+
# @option opts [Integer] :page_size Page size
|
616
|
+
# @option opts [Array<String>] :statuses Appointment Statuses to filter by
|
617
|
+
# @option opts [Array<String>] :facilitator_ids The facilitator IDs for which to retrieve appointments
|
618
|
+
# @option opts [String] :sort_order Sort (by due date) either Asc or Desc
|
619
|
+
# @return [Array<(CoachingAppointmentResponseList, Fixnum, Hash)>] CoachingAppointmentResponseList data, response status code and response headers
|
620
|
+
def get_coaching_appointments_me_with_http_info(opts = {})
|
621
|
+
if @api_client.config.debugging
|
622
|
+
@api_client.config.logger.debug "Calling API: CoachingApi.get_coaching_appointments_me ..."
|
623
|
+
end
|
624
|
+
|
625
|
+
|
626
|
+
|
627
|
+
|
628
|
+
|
629
|
+
|
630
|
+
|
631
|
+
|
632
|
+
|
633
|
+
|
634
|
+
|
635
|
+
|
636
|
+
|
637
|
+
|
638
|
+
|
639
|
+
|
640
|
+
|
641
|
+
|
642
|
+
|
643
|
+
|
644
|
+
|
645
|
+
|
646
|
+
|
647
|
+
|
648
|
+
|
649
|
+
|
650
|
+
|
651
|
+
|
652
|
+
|
653
|
+
|
654
|
+
|
655
|
+
|
656
|
+
|
657
|
+
|
658
|
+
if opts[:'sort_order'] && !['Desc', 'Asc'].include?(opts[:'sort_order'])
|
659
|
+
fail ArgumentError, 'invalid value for "sort_order", must be one of Desc, Asc'
|
660
|
+
end
|
661
|
+
|
662
|
+
|
663
|
+
|
664
|
+
|
665
|
+
# resource path
|
666
|
+
local_var_path = "/api/v2/coaching/appointments/me".sub('{format}','json')
|
667
|
+
|
668
|
+
# query parameters
|
669
|
+
query_params = {}
|
670
|
+
query_params[:'interval'] = opts[:'interval'] if opts[:'interval']
|
671
|
+
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
672
|
+
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
673
|
+
query_params[:'statuses'] = @api_client.build_collection_param(opts[:'statuses'], :multi) if opts[:'statuses']
|
674
|
+
query_params[:'facilitatorIds'] = @api_client.build_collection_param(opts[:'facilitator_ids'], :multi) if opts[:'facilitator_ids']
|
675
|
+
query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
|
676
|
+
|
677
|
+
# header parameters
|
678
|
+
header_params = {}
|
679
|
+
|
680
|
+
# HTTP header 'Accept' (if needed)
|
681
|
+
local_header_accept = ['application/json']
|
682
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
683
|
+
|
684
|
+
# HTTP header 'Content-Type'
|
685
|
+
local_header_content_type = ['application/json']
|
686
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
687
|
+
|
688
|
+
# form parameters
|
689
|
+
form_params = {}
|
690
|
+
|
691
|
+
# http body (model)
|
692
|
+
post_body = nil
|
693
|
+
|
694
|
+
auth_names = ['PureCloud OAuth']
|
695
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
696
|
+
:header_params => header_params,
|
697
|
+
:query_params => query_params,
|
698
|
+
:form_params => form_params,
|
699
|
+
:body => post_body,
|
700
|
+
:auth_names => auth_names,
|
701
|
+
:return_type => 'CoachingAppointmentResponseList')
|
702
|
+
if @api_client.config.debugging
|
703
|
+
@api_client.config.logger.debug "API called: CoachingApi#get_coaching_appointments_me\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
704
|
+
end
|
705
|
+
return data, status_code, headers
|
706
|
+
end
|
707
|
+
|
708
|
+
# Get an existing notification
|
709
|
+
# Permission not required if you are the owner of the notification.
|
710
|
+
# @param notification_id The ID of the notification.
|
711
|
+
# @param [Hash] opts the optional parameters
|
712
|
+
# @return [CoachingNotification]
|
713
|
+
def get_coaching_notification(notification_id, opts = {})
|
714
|
+
data, _status_code, _headers = get_coaching_notification_with_http_info(notification_id, opts)
|
715
|
+
return data
|
716
|
+
end
|
717
|
+
|
718
|
+
# Get an existing notification
|
719
|
+
# Permission not required if you are the owner of the notification.
|
720
|
+
# @param notification_id The ID of the notification.
|
721
|
+
# @param [Hash] opts the optional parameters
|
722
|
+
# @return [Array<(CoachingNotification, Fixnum, Hash)>] CoachingNotification data, response status code and response headers
|
723
|
+
def get_coaching_notification_with_http_info(notification_id, opts = {})
|
724
|
+
if @api_client.config.debugging
|
725
|
+
@api_client.config.logger.debug "Calling API: CoachingApi.get_coaching_notification ..."
|
726
|
+
end
|
727
|
+
|
728
|
+
|
729
|
+
# verify the required parameter 'notification_id' is set
|
730
|
+
fail ArgumentError, "Missing the required parameter 'notification_id' when calling CoachingApi.get_coaching_notification" if notification_id.nil?
|
731
|
+
|
732
|
+
|
733
|
+
|
734
|
+
|
735
|
+
|
736
|
+
# resource path
|
737
|
+
local_var_path = "/api/v2/coaching/notifications/{notificationId}".sub('{format}','json').sub('{' + 'notificationId' + '}', notification_id.to_s)
|
738
|
+
|
739
|
+
# query parameters
|
740
|
+
query_params = {}
|
741
|
+
|
742
|
+
# header parameters
|
743
|
+
header_params = {}
|
744
|
+
|
745
|
+
# HTTP header 'Accept' (if needed)
|
746
|
+
local_header_accept = ['application/json']
|
747
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
748
|
+
|
749
|
+
# HTTP header 'Content-Type'
|
750
|
+
local_header_content_type = ['application/json']
|
751
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
752
|
+
|
753
|
+
# form parameters
|
754
|
+
form_params = {}
|
755
|
+
|
756
|
+
# http body (model)
|
757
|
+
post_body = nil
|
758
|
+
|
759
|
+
auth_names = ['PureCloud OAuth']
|
760
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
761
|
+
:header_params => header_params,
|
762
|
+
:query_params => query_params,
|
763
|
+
:form_params => form_params,
|
764
|
+
:body => post_body,
|
765
|
+
:auth_names => auth_names,
|
766
|
+
:return_type => 'CoachingNotification')
|
767
|
+
if @api_client.config.debugging
|
768
|
+
@api_client.config.logger.debug "API called: CoachingApi#get_coaching_notification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
769
|
+
end
|
770
|
+
return data, status_code, headers
|
771
|
+
end
|
772
|
+
|
773
|
+
# Retrieve the list of your notifications.
|
774
|
+
#
|
775
|
+
# @param [Hash] opts the optional parameters
|
776
|
+
# @option opts [Integer] :page_number Page number (default to 1)
|
777
|
+
# @option opts [Integer] :page_size Page size (default to 25)
|
778
|
+
# @return [CoachingNotificationList]
|
779
|
+
def get_coaching_notifications(opts = {})
|
780
|
+
data, _status_code, _headers = get_coaching_notifications_with_http_info(opts)
|
781
|
+
return data
|
782
|
+
end
|
783
|
+
|
784
|
+
# Retrieve the list of your notifications.
|
785
|
+
#
|
786
|
+
# @param [Hash] opts the optional parameters
|
787
|
+
# @option opts [Integer] :page_number Page number
|
788
|
+
# @option opts [Integer] :page_size Page size
|
789
|
+
# @return [Array<(CoachingNotificationList, Fixnum, Hash)>] CoachingNotificationList data, response status code and response headers
|
790
|
+
def get_coaching_notifications_with_http_info(opts = {})
|
791
|
+
if @api_client.config.debugging
|
792
|
+
@api_client.config.logger.debug "Calling API: CoachingApi.get_coaching_notifications ..."
|
793
|
+
end
|
794
|
+
|
795
|
+
|
796
|
+
|
797
|
+
|
798
|
+
|
799
|
+
|
800
|
+
|
801
|
+
|
802
|
+
|
803
|
+
|
804
|
+
|
805
|
+
|
806
|
+
|
807
|
+
# resource path
|
808
|
+
local_var_path = "/api/v2/coaching/notifications".sub('{format}','json')
|
809
|
+
|
810
|
+
# query parameters
|
811
|
+
query_params = {}
|
812
|
+
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
813
|
+
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
814
|
+
|
815
|
+
# header parameters
|
816
|
+
header_params = {}
|
817
|
+
|
818
|
+
# HTTP header 'Accept' (if needed)
|
819
|
+
local_header_accept = ['application/json']
|
820
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
821
|
+
|
822
|
+
# HTTP header 'Content-Type'
|
823
|
+
local_header_content_type = ['application/json']
|
824
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
825
|
+
|
826
|
+
# form parameters
|
827
|
+
form_params = {}
|
828
|
+
|
829
|
+
# http body (model)
|
830
|
+
post_body = nil
|
831
|
+
|
832
|
+
auth_names = ['PureCloud OAuth']
|
833
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
834
|
+
:header_params => header_params,
|
835
|
+
:query_params => query_params,
|
836
|
+
:form_params => form_params,
|
837
|
+
:body => post_body,
|
838
|
+
:auth_names => auth_names,
|
839
|
+
:return_type => 'CoachingNotificationList')
|
840
|
+
if @api_client.config.debugging
|
841
|
+
@api_client.config.logger.debug "API called: CoachingApi#get_coaching_notifications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
842
|
+
end
|
843
|
+
return data, status_code, headers
|
844
|
+
end
|
845
|
+
|
846
|
+
# Update an existing appointment
|
847
|
+
# Permission not required if you are the creator or facilitator of the appointment
|
848
|
+
# @param appointment_id The ID of the coaching appointment.
|
849
|
+
# @param body The new version of the appointment
|
850
|
+
# @param [Hash] opts the optional parameters
|
851
|
+
# @return [CoachingAppointmentResponse]
|
852
|
+
def patch_coaching_appointment(appointment_id, body, opts = {})
|
853
|
+
data, _status_code, _headers = patch_coaching_appointment_with_http_info(appointment_id, body, opts)
|
854
|
+
return data
|
855
|
+
end
|
856
|
+
|
857
|
+
# Update an existing appointment
|
858
|
+
# Permission not required if you are the creator or facilitator of the appointment
|
859
|
+
# @param appointment_id The ID of the coaching appointment.
|
860
|
+
# @param body The new version of the appointment
|
861
|
+
# @param [Hash] opts the optional parameters
|
862
|
+
# @return [Array<(CoachingAppointmentResponse, Fixnum, Hash)>] CoachingAppointmentResponse data, response status code and response headers
|
863
|
+
def patch_coaching_appointment_with_http_info(appointment_id, body, opts = {})
|
864
|
+
if @api_client.config.debugging
|
865
|
+
@api_client.config.logger.debug "Calling API: CoachingApi.patch_coaching_appointment ..."
|
866
|
+
end
|
867
|
+
|
868
|
+
|
869
|
+
# verify the required parameter 'appointment_id' is set
|
870
|
+
fail ArgumentError, "Missing the required parameter 'appointment_id' when calling CoachingApi.patch_coaching_appointment" if appointment_id.nil?
|
871
|
+
|
872
|
+
|
873
|
+
|
874
|
+
|
875
|
+
|
876
|
+
|
877
|
+
# verify the required parameter 'body' is set
|
878
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling CoachingApi.patch_coaching_appointment" if body.nil?
|
879
|
+
|
880
|
+
|
881
|
+
|
882
|
+
|
883
|
+
|
884
|
+
# resource path
|
885
|
+
local_var_path = "/api/v2/coaching/appointments/{appointmentId}".sub('{format}','json').sub('{' + 'appointmentId' + '}', appointment_id.to_s)
|
886
|
+
|
887
|
+
# query parameters
|
888
|
+
query_params = {}
|
889
|
+
|
890
|
+
# header parameters
|
891
|
+
header_params = {}
|
892
|
+
|
893
|
+
# HTTP header 'Accept' (if needed)
|
894
|
+
local_header_accept = ['application/json']
|
895
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
896
|
+
|
897
|
+
# HTTP header 'Content-Type'
|
898
|
+
local_header_content_type = ['application/json']
|
899
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
900
|
+
|
901
|
+
# form parameters
|
902
|
+
form_params = {}
|
903
|
+
|
904
|
+
# http body (model)
|
905
|
+
post_body = @api_client.object_to_http_body(body)
|
906
|
+
|
907
|
+
auth_names = ['PureCloud OAuth']
|
908
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
|
909
|
+
:header_params => header_params,
|
910
|
+
:query_params => query_params,
|
911
|
+
:form_params => form_params,
|
912
|
+
:body => post_body,
|
913
|
+
:auth_names => auth_names,
|
914
|
+
:return_type => 'CoachingAppointmentResponse')
|
915
|
+
if @api_client.config.debugging
|
916
|
+
@api_client.config.logger.debug "API called: CoachingApi#patch_coaching_appointment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
917
|
+
end
|
918
|
+
return data, status_code, headers
|
919
|
+
end
|
920
|
+
|
921
|
+
# Update an existing annotation.
|
922
|
+
# 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
|
923
|
+
# @param appointment_id The ID of the coaching appointment.
|
924
|
+
# @param annotation_id The ID of the annotation.
|
925
|
+
# @param body The new version of the annotation
|
926
|
+
# @param [Hash] opts the optional parameters
|
927
|
+
# @return [CoachingAnnotation]
|
928
|
+
def patch_coaching_appointment_annotation(appointment_id, annotation_id, body, opts = {})
|
929
|
+
data, _status_code, _headers = patch_coaching_appointment_annotation_with_http_info(appointment_id, annotation_id, body, opts)
|
930
|
+
return data
|
931
|
+
end
|
932
|
+
|
933
|
+
# Update an existing annotation.
|
934
|
+
# 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
|
935
|
+
# @param appointment_id The ID of the coaching appointment.
|
936
|
+
# @param annotation_id The ID of the annotation.
|
937
|
+
# @param body The new version of the annotation
|
938
|
+
# @param [Hash] opts the optional parameters
|
939
|
+
# @return [Array<(CoachingAnnotation, Fixnum, Hash)>] CoachingAnnotation data, response status code and response headers
|
940
|
+
def patch_coaching_appointment_annotation_with_http_info(appointment_id, annotation_id, body, opts = {})
|
941
|
+
if @api_client.config.debugging
|
942
|
+
@api_client.config.logger.debug "Calling API: CoachingApi.patch_coaching_appointment_annotation ..."
|
943
|
+
end
|
944
|
+
|
945
|
+
|
946
|
+
# verify the required parameter 'appointment_id' is set
|
947
|
+
fail ArgumentError, "Missing the required parameter 'appointment_id' when calling CoachingApi.patch_coaching_appointment_annotation" if appointment_id.nil?
|
948
|
+
|
949
|
+
|
950
|
+
|
951
|
+
|
952
|
+
|
953
|
+
|
954
|
+
# verify the required parameter 'annotation_id' is set
|
955
|
+
fail ArgumentError, "Missing the required parameter 'annotation_id' when calling CoachingApi.patch_coaching_appointment_annotation" if annotation_id.nil?
|
956
|
+
|
957
|
+
|
958
|
+
|
959
|
+
|
960
|
+
|
961
|
+
|
962
|
+
# verify the required parameter 'body' is set
|
963
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling CoachingApi.patch_coaching_appointment_annotation" if body.nil?
|
964
|
+
|
965
|
+
|
966
|
+
|
967
|
+
|
968
|
+
|
969
|
+
# resource path
|
970
|
+
local_var_path = "/api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId}".sub('{format}','json').sub('{' + 'appointmentId' + '}', appointment_id.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)
|
971
|
+
|
972
|
+
# query parameters
|
973
|
+
query_params = {}
|
974
|
+
|
975
|
+
# header parameters
|
976
|
+
header_params = {}
|
977
|
+
|
978
|
+
# HTTP header 'Accept' (if needed)
|
979
|
+
local_header_accept = ['application/json']
|
980
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
981
|
+
|
982
|
+
# HTTP header 'Content-Type'
|
983
|
+
local_header_content_type = ['application/json']
|
984
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
985
|
+
|
986
|
+
# form parameters
|
987
|
+
form_params = {}
|
988
|
+
|
989
|
+
# http body (model)
|
990
|
+
post_body = @api_client.object_to_http_body(body)
|
991
|
+
|
992
|
+
auth_names = ['PureCloud OAuth']
|
993
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
|
994
|
+
:header_params => header_params,
|
995
|
+
:query_params => query_params,
|
996
|
+
:form_params => form_params,
|
997
|
+
:body => post_body,
|
998
|
+
:auth_names => auth_names,
|
999
|
+
:return_type => 'CoachingAnnotation')
|
1000
|
+
if @api_client.config.debugging
|
1001
|
+
@api_client.config.logger.debug "API called: CoachingApi#patch_coaching_appointment_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1002
|
+
end
|
1003
|
+
return data, status_code, headers
|
1004
|
+
end
|
1005
|
+
|
1006
|
+
# Update the status of a coaching appointment
|
1007
|
+
# Permission not required if you are an attendee, creator or facilitator of the appointment
|
1008
|
+
# @param appointment_id The ID of the coaching appointment.
|
1009
|
+
# @param body Updated status of the coaching appointment
|
1010
|
+
# @param [Hash] opts the optional parameters
|
1011
|
+
# @return [CoachingAppointmentStatusDto]
|
1012
|
+
def patch_coaching_appointment_status(appointment_id, body, opts = {})
|
1013
|
+
data, _status_code, _headers = patch_coaching_appointment_status_with_http_info(appointment_id, body, opts)
|
1014
|
+
return data
|
1015
|
+
end
|
1016
|
+
|
1017
|
+
# Update the status of a coaching appointment
|
1018
|
+
# Permission not required if you are an attendee, creator or facilitator of the appointment
|
1019
|
+
# @param appointment_id The ID of the coaching appointment.
|
1020
|
+
# @param body Updated status of the coaching appointment
|
1021
|
+
# @param [Hash] opts the optional parameters
|
1022
|
+
# @return [Array<(CoachingAppointmentStatusDto, Fixnum, Hash)>] CoachingAppointmentStatusDto data, response status code and response headers
|
1023
|
+
def patch_coaching_appointment_status_with_http_info(appointment_id, body, opts = {})
|
1024
|
+
if @api_client.config.debugging
|
1025
|
+
@api_client.config.logger.debug "Calling API: CoachingApi.patch_coaching_appointment_status ..."
|
1026
|
+
end
|
1027
|
+
|
1028
|
+
|
1029
|
+
# verify the required parameter 'appointment_id' is set
|
1030
|
+
fail ArgumentError, "Missing the required parameter 'appointment_id' when calling CoachingApi.patch_coaching_appointment_status" if appointment_id.nil?
|
1031
|
+
|
1032
|
+
|
1033
|
+
|
1034
|
+
|
1035
|
+
|
1036
|
+
|
1037
|
+
# verify the required parameter 'body' is set
|
1038
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling CoachingApi.patch_coaching_appointment_status" if body.nil?
|
1039
|
+
|
1040
|
+
|
1041
|
+
|
1042
|
+
|
1043
|
+
|
1044
|
+
# resource path
|
1045
|
+
local_var_path = "/api/v2/coaching/appointments/{appointmentId}/status".sub('{format}','json').sub('{' + 'appointmentId' + '}', appointment_id.to_s)
|
1046
|
+
|
1047
|
+
# query parameters
|
1048
|
+
query_params = {}
|
1049
|
+
|
1050
|
+
# header parameters
|
1051
|
+
header_params = {}
|
1052
|
+
|
1053
|
+
# HTTP header 'Accept' (if needed)
|
1054
|
+
local_header_accept = ['application/json']
|
1055
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
1056
|
+
|
1057
|
+
# HTTP header 'Content-Type'
|
1058
|
+
local_header_content_type = ['application/json']
|
1059
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
1060
|
+
|
1061
|
+
# form parameters
|
1062
|
+
form_params = {}
|
1063
|
+
|
1064
|
+
# http body (model)
|
1065
|
+
post_body = @api_client.object_to_http_body(body)
|
1066
|
+
|
1067
|
+
auth_names = ['PureCloud OAuth']
|
1068
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
|
1069
|
+
:header_params => header_params,
|
1070
|
+
:query_params => query_params,
|
1071
|
+
:form_params => form_params,
|
1072
|
+
:body => post_body,
|
1073
|
+
:auth_names => auth_names,
|
1074
|
+
:return_type => 'CoachingAppointmentStatusDto')
|
1075
|
+
if @api_client.config.debugging
|
1076
|
+
@api_client.config.logger.debug "API called: CoachingApi#patch_coaching_appointment_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1077
|
+
end
|
1078
|
+
return data, status_code, headers
|
1079
|
+
end
|
1080
|
+
|
1081
|
+
# Update an existing notification.
|
1082
|
+
# Can only update your own notifications.
|
1083
|
+
# @param notification_id The ID of the notification.
|
1084
|
+
# @param body Change the read state of a notification
|
1085
|
+
# @param [Hash] opts the optional parameters
|
1086
|
+
# @return [CoachingNotification]
|
1087
|
+
def patch_coaching_notification(notification_id, body, opts = {})
|
1088
|
+
data, _status_code, _headers = patch_coaching_notification_with_http_info(notification_id, body, opts)
|
1089
|
+
return data
|
1090
|
+
end
|
1091
|
+
|
1092
|
+
# Update an existing notification.
|
1093
|
+
# Can only update your own notifications.
|
1094
|
+
# @param notification_id The ID of the notification.
|
1095
|
+
# @param body Change the read state of a notification
|
1096
|
+
# @param [Hash] opts the optional parameters
|
1097
|
+
# @return [Array<(CoachingNotification, Fixnum, Hash)>] CoachingNotification data, response status code and response headers
|
1098
|
+
def patch_coaching_notification_with_http_info(notification_id, body, opts = {})
|
1099
|
+
if @api_client.config.debugging
|
1100
|
+
@api_client.config.logger.debug "Calling API: CoachingApi.patch_coaching_notification ..."
|
1101
|
+
end
|
1102
|
+
|
1103
|
+
|
1104
|
+
# verify the required parameter 'notification_id' is set
|
1105
|
+
fail ArgumentError, "Missing the required parameter 'notification_id' when calling CoachingApi.patch_coaching_notification" if notification_id.nil?
|
1106
|
+
|
1107
|
+
|
1108
|
+
|
1109
|
+
|
1110
|
+
|
1111
|
+
|
1112
|
+
# verify the required parameter 'body' is set
|
1113
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling CoachingApi.patch_coaching_notification" if body.nil?
|
1114
|
+
|
1115
|
+
|
1116
|
+
|
1117
|
+
|
1118
|
+
|
1119
|
+
# resource path
|
1120
|
+
local_var_path = "/api/v2/coaching/notifications/{notificationId}".sub('{format}','json').sub('{' + 'notificationId' + '}', notification_id.to_s)
|
1121
|
+
|
1122
|
+
# query parameters
|
1123
|
+
query_params = {}
|
1124
|
+
|
1125
|
+
# header parameters
|
1126
|
+
header_params = {}
|
1127
|
+
|
1128
|
+
# HTTP header 'Accept' (if needed)
|
1129
|
+
local_header_accept = ['application/json']
|
1130
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
1131
|
+
|
1132
|
+
# HTTP header 'Content-Type'
|
1133
|
+
local_header_content_type = ['application/json']
|
1134
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
1135
|
+
|
1136
|
+
# form parameters
|
1137
|
+
form_params = {}
|
1138
|
+
|
1139
|
+
# http body (model)
|
1140
|
+
post_body = @api_client.object_to_http_body(body)
|
1141
|
+
|
1142
|
+
auth_names = ['PureCloud OAuth']
|
1143
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
|
1144
|
+
:header_params => header_params,
|
1145
|
+
:query_params => query_params,
|
1146
|
+
:form_params => form_params,
|
1147
|
+
:body => post_body,
|
1148
|
+
:auth_names => auth_names,
|
1149
|
+
:return_type => 'CoachingNotification')
|
1150
|
+
if @api_client.config.debugging
|
1151
|
+
@api_client.config.logger.debug "API called: CoachingApi#patch_coaching_notification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1152
|
+
end
|
1153
|
+
return data, status_code, headers
|
1154
|
+
end
|
1155
|
+
|
1156
|
+
# Create a new annotation.
|
1157
|
+
# 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).
|
1158
|
+
# @param appointment_id The ID of the coaching appointment.
|
1159
|
+
# @param body The annotation to add
|
1160
|
+
# @param [Hash] opts the optional parameters
|
1161
|
+
# @return [CoachingAnnotation]
|
1162
|
+
def post_coaching_appointment_annotations(appointment_id, body, opts = {})
|
1163
|
+
data, _status_code, _headers = post_coaching_appointment_annotations_with_http_info(appointment_id, body, opts)
|
1164
|
+
return data
|
1165
|
+
end
|
1166
|
+
|
1167
|
+
# Create a new annotation.
|
1168
|
+
# 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).
|
1169
|
+
# @param appointment_id The ID of the coaching appointment.
|
1170
|
+
# @param body The annotation to add
|
1171
|
+
# @param [Hash] opts the optional parameters
|
1172
|
+
# @return [Array<(CoachingAnnotation, Fixnum, Hash)>] CoachingAnnotation data, response status code and response headers
|
1173
|
+
def post_coaching_appointment_annotations_with_http_info(appointment_id, body, opts = {})
|
1174
|
+
if @api_client.config.debugging
|
1175
|
+
@api_client.config.logger.debug "Calling API: CoachingApi.post_coaching_appointment_annotations ..."
|
1176
|
+
end
|
1177
|
+
|
1178
|
+
|
1179
|
+
# verify the required parameter 'appointment_id' is set
|
1180
|
+
fail ArgumentError, "Missing the required parameter 'appointment_id' when calling CoachingApi.post_coaching_appointment_annotations" if appointment_id.nil?
|
1181
|
+
|
1182
|
+
|
1183
|
+
|
1184
|
+
|
1185
|
+
|
1186
|
+
|
1187
|
+
# verify the required parameter 'body' is set
|
1188
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling CoachingApi.post_coaching_appointment_annotations" if body.nil?
|
1189
|
+
|
1190
|
+
|
1191
|
+
|
1192
|
+
|
1193
|
+
|
1194
|
+
# resource path
|
1195
|
+
local_var_path = "/api/v2/coaching/appointments/{appointmentId}/annotations".sub('{format}','json').sub('{' + 'appointmentId' + '}', appointment_id.to_s)
|
1196
|
+
|
1197
|
+
# query parameters
|
1198
|
+
query_params = {}
|
1199
|
+
|
1200
|
+
# header parameters
|
1201
|
+
header_params = {}
|
1202
|
+
|
1203
|
+
# HTTP header 'Accept' (if needed)
|
1204
|
+
local_header_accept = ['application/json']
|
1205
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
1206
|
+
|
1207
|
+
# HTTP header 'Content-Type'
|
1208
|
+
local_header_content_type = ['application/json']
|
1209
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
1210
|
+
|
1211
|
+
# form parameters
|
1212
|
+
form_params = {}
|
1213
|
+
|
1214
|
+
# http body (model)
|
1215
|
+
post_body = @api_client.object_to_http_body(body)
|
1216
|
+
|
1217
|
+
auth_names = ['PureCloud OAuth']
|
1218
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1219
|
+
:header_params => header_params,
|
1220
|
+
:query_params => query_params,
|
1221
|
+
:form_params => form_params,
|
1222
|
+
:body => post_body,
|
1223
|
+
:auth_names => auth_names,
|
1224
|
+
:return_type => 'CoachingAnnotation')
|
1225
|
+
if @api_client.config.debugging
|
1226
|
+
@api_client.config.logger.debug "API called: CoachingApi#post_coaching_appointment_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1227
|
+
end
|
1228
|
+
return data, status_code, headers
|
1229
|
+
end
|
1230
|
+
|
1231
|
+
# Create a new appointment
|
1232
|
+
#
|
1233
|
+
# @param body The appointment to add
|
1234
|
+
# @param [Hash] opts the optional parameters
|
1235
|
+
# @return [CoachingAppointmentResponse]
|
1236
|
+
def post_coaching_appointments(body, opts = {})
|
1237
|
+
data, _status_code, _headers = post_coaching_appointments_with_http_info(body, opts)
|
1238
|
+
return data
|
1239
|
+
end
|
1240
|
+
|
1241
|
+
# Create a new appointment
|
1242
|
+
#
|
1243
|
+
# @param body The appointment to add
|
1244
|
+
# @param [Hash] opts the optional parameters
|
1245
|
+
# @return [Array<(CoachingAppointmentResponse, Fixnum, Hash)>] CoachingAppointmentResponse data, response status code and response headers
|
1246
|
+
def post_coaching_appointments_with_http_info(body, opts = {})
|
1247
|
+
if @api_client.config.debugging
|
1248
|
+
@api_client.config.logger.debug "Calling API: CoachingApi.post_coaching_appointments ..."
|
1249
|
+
end
|
1250
|
+
|
1251
|
+
|
1252
|
+
# verify the required parameter 'body' is set
|
1253
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling CoachingApi.post_coaching_appointments" if body.nil?
|
1254
|
+
|
1255
|
+
|
1256
|
+
|
1257
|
+
|
1258
|
+
|
1259
|
+
# resource path
|
1260
|
+
local_var_path = "/api/v2/coaching/appointments".sub('{format}','json')
|
1261
|
+
|
1262
|
+
# query parameters
|
1263
|
+
query_params = {}
|
1264
|
+
|
1265
|
+
# header parameters
|
1266
|
+
header_params = {}
|
1267
|
+
|
1268
|
+
# HTTP header 'Accept' (if needed)
|
1269
|
+
local_header_accept = ['application/json']
|
1270
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
1271
|
+
|
1272
|
+
# HTTP header 'Content-Type'
|
1273
|
+
local_header_content_type = ['application/json']
|
1274
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
1275
|
+
|
1276
|
+
# form parameters
|
1277
|
+
form_params = {}
|
1278
|
+
|
1279
|
+
# http body (model)
|
1280
|
+
post_body = @api_client.object_to_http_body(body)
|
1281
|
+
|
1282
|
+
auth_names = ['PureCloud OAuth']
|
1283
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1284
|
+
:header_params => header_params,
|
1285
|
+
:query_params => query_params,
|
1286
|
+
:form_params => form_params,
|
1287
|
+
:body => post_body,
|
1288
|
+
:auth_names => auth_names,
|
1289
|
+
:return_type => 'CoachingAppointmentResponse')
|
1290
|
+
if @api_client.config.debugging
|
1291
|
+
@api_client.config.logger.debug "API called: CoachingApi#post_coaching_appointments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1292
|
+
end
|
1293
|
+
return data, status_code, headers
|
1294
|
+
end
|
1295
|
+
end
|
1296
|
+
end
|