mavenagi 1.2.9 → 1.2.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/BaseClient.d.ts +36 -0
- package/BaseClient.js +3 -0
- package/Client.d.ts +6 -30
- package/Client.js +25 -20
- package/README.md +45 -15
- package/api/resources/actions/client/Client.d.ts +7 -33
- package/api/resources/actions/client/Client.js +33 -33
- package/api/resources/actions/client/index.d.ts +0 -1
- package/api/resources/actions/client/requests/ActionPatchRequest.d.ts +1 -1
- package/api/resources/actions/client/requests/index.d.ts +2 -2
- package/api/resources/actions/index.d.ts +1 -1
- package/api/resources/actions/index.js +1 -1
- package/api/resources/actions/types/ActionFilter.d.ts +1 -1
- package/api/resources/actions/types/ActionRequest.d.ts +5 -5
- package/api/resources/actions/types/ActionsResponse.d.ts +1 -1
- package/api/resources/actions/types/ActionsSearchRequest.d.ts +1 -1
- package/api/resources/actions/types/index.d.ts +2 -2
- package/api/resources/actions/types/index.js +2 -2
- package/api/resources/agents/client/Client.d.ts +3 -29
- package/api/resources/agents/client/Client.js +34 -34
- package/api/resources/agents/client/index.d.ts +0 -1
- package/api/resources/agents/client/requests/AgentPatchRequest.d.ts +1 -1
- package/api/resources/agents/client/requests/index.d.ts +1 -1
- package/api/resources/agents/index.d.ts +1 -1
- package/api/resources/agents/index.js +1 -1
- package/api/resources/agents/types/Agent.d.ts +1 -1
- package/api/resources/agents/types/AgentFilter.d.ts +1 -1
- package/api/resources/agents/types/AgentPrompting.d.ts +1 -1
- package/api/resources/agents/types/AgentsSearchRequest.d.ts +1 -1
- package/api/resources/agents/types/AgentsSearchResponse.d.ts +1 -1
- package/api/resources/agents/types/CreateAgentRequest.d.ts +1 -1
- package/api/resources/agents/types/index.d.ts +4 -5
- package/api/resources/agents/types/index.js +4 -5
- package/api/resources/analytics/client/Client.d.ts +89 -29
- package/api/resources/analytics/client/Client.js +271 -25
- package/api/resources/analytics/index.d.ts +1 -1
- package/api/resources/analytics/index.js +1 -1
- package/api/resources/analytics/types/AgentUserAnalyticsRequest.d.ts +1 -1
- package/api/resources/analytics/types/AgentUserColumnDefinition.d.ts +1 -1
- package/api/resources/analytics/types/AgentUserCount.d.ts +1 -2
- package/api/resources/analytics/types/AgentUserMetric.d.ts +1 -1
- package/api/resources/analytics/types/AgentUserRow.d.ts +1 -1
- package/api/resources/analytics/types/AgentUserTableRequest.d.ts +1 -1
- package/api/resources/analytics/types/AgentUserTableResponse.d.ts +1 -1
- package/api/resources/analytics/types/BarChartResponse.d.ts +1 -1
- package/api/resources/analytics/types/CellData.d.ts +1 -1
- package/api/resources/analytics/types/ChartResponse.d.ts +1 -1
- package/api/resources/analytics/types/ConversationAnalyticsRequest.d.ts +1 -1
- package/api/resources/analytics/types/ConversationAverage.d.ts +1 -1
- package/api/resources/analytics/types/ConversationBarChartRequest.d.ts +1 -1
- package/api/resources/analytics/types/ConversationBasicMetric.d.ts +1 -1
- package/api/resources/analytics/types/ConversationChartRequest.d.ts +1 -1
- package/api/resources/analytics/types/ConversationColumnDefinition.d.ts +1 -1
- package/api/resources/analytics/types/ConversationCount.d.ts +1 -2
- package/api/resources/analytics/types/ConversationDateHistogramRequest.d.ts +1 -1
- package/api/resources/analytics/types/ConversationDistinctCount.d.ts +1 -1
- package/api/resources/analytics/types/ConversationGroupBy.d.ts +1 -1
- package/api/resources/analytics/types/ConversationMax.d.ts +1 -1
- package/api/resources/analytics/types/ConversationMedian.d.ts +1 -1
- package/api/resources/analytics/types/ConversationMetric.d.ts +1 -1
- package/api/resources/analytics/types/ConversationMin.d.ts +1 -1
- package/api/resources/analytics/types/ConversationNumericMetric.d.ts +1 -1
- package/api/resources/analytics/types/ConversationPercentile.d.ts +1 -1
- package/api/resources/analytics/types/ConversationPieChartRequest.d.ts +1 -1
- package/api/resources/analytics/types/ConversationRow.d.ts +1 -1
- package/api/resources/analytics/types/ConversationSum.d.ts +1 -1
- package/api/resources/analytics/types/ConversationTableRequest.d.ts +1 -1
- package/api/resources/analytics/types/ConversationTableResponse.d.ts +1 -1
- package/api/resources/analytics/types/DateHistogramResponse.d.ts +1 -1
- package/api/resources/analytics/types/EventAnalyticsRequest.d.ts +11 -0
- package/api/resources/analytics/types/EventAnalyticsRequest.js +3 -0
- package/api/resources/analytics/types/EventBarChartRequest.d.ts +12 -0
- package/api/resources/analytics/types/EventBarChartRequest.js +3 -0
- package/api/resources/analytics/types/EventChartRequest.d.ts +60 -0
- package/api/resources/analytics/types/EventChartRequest.js +3 -0
- package/api/resources/analytics/types/EventColumnDefinition.d.ts +5 -0
- package/api/resources/analytics/types/EventColumnDefinition.js +3 -0
- package/api/resources/analytics/types/EventCount.d.ts +4 -0
- package/api/resources/analytics/types/EventCount.js +3 -0
- package/api/resources/analytics/types/EventDateHistogramRequest.d.ts +9 -0
- package/api/resources/analytics/types/EventDateHistogramRequest.js +3 -0
- package/api/resources/analytics/types/EventDistinctCount.d.ts +8 -0
- package/api/resources/analytics/types/EventDistinctCount.js +3 -0
- package/api/resources/analytics/types/EventGroupBy.d.ts +5 -0
- package/api/resources/analytics/types/EventGroupBy.js +3 -0
- package/api/resources/analytics/types/EventMetric.d.ts +14 -0
- package/api/resources/analytics/types/EventMetric.js +3 -0
- package/api/resources/analytics/types/EventPieChartRequest.d.ts +7 -0
- package/api/resources/analytics/types/EventPieChartRequest.js +3 -0
- package/api/resources/analytics/types/EventRow.d.ts +8 -0
- package/api/resources/analytics/types/EventRow.js +3 -0
- package/api/resources/analytics/types/EventTableRequest.d.ts +38 -0
- package/api/resources/analytics/types/EventTableRequest.js +3 -0
- package/api/resources/analytics/types/EventTableResponse.d.ts +42 -0
- package/api/resources/analytics/types/EventTableResponse.js +3 -0
- package/api/resources/analytics/types/FeedbackAnalyticsRequest.d.ts +1 -1
- package/api/resources/analytics/types/FeedbackColumnDefinition.d.ts +1 -1
- package/api/resources/analytics/types/FeedbackCount.d.ts +1 -2
- package/api/resources/analytics/types/FeedbackDistinctCount.d.ts +1 -1
- package/api/resources/analytics/types/FeedbackGroupBy.d.ts +1 -1
- package/api/resources/analytics/types/FeedbackMetric.d.ts +1 -1
- package/api/resources/analytics/types/FeedbackRow.d.ts +1 -1
- package/api/resources/analytics/types/FeedbackTableRequest.d.ts +1 -1
- package/api/resources/analytics/types/FeedbackTableResponse.d.ts +1 -1
- package/api/resources/analytics/types/FieldValue.d.ts +1 -1
- package/api/resources/analytics/types/PieChartResponse.d.ts +1 -1
- package/api/resources/analytics/types/RowBase.d.ts +1 -1
- package/api/resources/analytics/types/Series.d.ts +1 -1
- package/api/resources/analytics/types/TimeSeries.d.ts +1 -1
- package/api/resources/analytics/types/index.d.ts +49 -36
- package/api/resources/analytics/types/index.js +49 -36
- package/api/resources/appSettings/client/Client.d.ts +3 -29
- package/api/resources/appSettings/client/Client.js +18 -18
- package/api/resources/appSettings/client/index.d.ts +0 -1
- package/api/resources/appSettings/client/requests/index.d.ts +1 -1
- package/api/resources/appSettings/index.d.ts +1 -1
- package/api/resources/appSettings/index.js +1 -1
- package/api/resources/appSettings/types/SearchAppSettingsResponse.d.ts +1 -1
- package/api/resources/appSettings/types/index.d.ts +1 -1
- package/api/resources/appSettings/types/index.js +1 -1
- package/api/resources/assets/client/Client.d.ts +3 -29
- package/api/resources/assets/client/Client.js +14 -14
- package/api/resources/assets/index.d.ts +1 -1
- package/api/resources/assets/index.js +1 -1
- package/api/resources/assets/types/InitiateAssetUploadRequest.d.ts +1 -1
- package/api/resources/assets/types/InitiateAssetUploadResponse.d.ts +1 -1
- package/api/resources/assets/types/index.d.ts +1 -1
- package/api/resources/assets/types/index.js +1 -1
- package/api/resources/commons/errors/BadRequestError.d.ts +2 -2
- package/api/resources/commons/errors/NotFoundError.d.ts +2 -2
- package/api/resources/commons/errors/ServerError.d.ts +2 -2
- package/api/resources/commons/errors/index.d.ts +1 -1
- package/api/resources/commons/errors/index.js +1 -1
- package/api/resources/commons/index.d.ts +1 -1
- package/api/resources/commons/index.js +1 -1
- package/api/resources/commons/types/ActionBase.d.ts +1 -1
- package/api/resources/commons/types/ActionExecutionParamValue.d.ts +1 -1
- package/api/resources/commons/types/ActionFormField.d.ts +1 -1
- package/api/resources/commons/types/ActionParameter.d.ts +1 -1
- package/api/resources/commons/types/ActionResponse.d.ts +5 -5
- package/api/resources/commons/types/AppPrecondition.d.ts +1 -1
- package/api/resources/commons/types/AppUser.d.ts +1 -1
- package/api/resources/commons/types/AppUserIdentifier.d.ts +1 -1
- package/api/resources/commons/types/AppUserRequest.d.ts +1 -1
- package/api/resources/commons/types/AppUserResponse.d.ts +1 -1
- package/api/resources/commons/types/AttachmentRequest.d.ts +1 -1
- package/api/resources/commons/types/AttachmentResponse.d.ts +1 -1
- package/api/resources/commons/types/BaseConversationResponse.d.ts +1 -1
- package/api/resources/commons/types/BaseSearchRequest.d.ts +1 -1
- package/api/resources/commons/types/BotActionFormResponse.d.ts +1 -1
- package/api/resources/commons/types/BotChartResponse.d.ts +1 -1
- package/api/resources/commons/types/BotLogic.d.ts +1 -1
- package/api/resources/commons/types/BotLogicActionExecutedDetail.d.ts +1 -1
- package/api/resources/commons/types/BotLogicActionItem.d.ts +1 -1
- package/api/resources/commons/types/BotLogicActionReviewedDetail.d.ts +1 -1
- package/api/resources/commons/types/BotLogicFormSubmissionItem.d.ts +1 -1
- package/api/resources/commons/types/BotLogicItem.d.ts +1 -1
- package/api/resources/commons/types/BotLogicKnowledgeDetail.d.ts +1 -1
- package/api/resources/commons/types/BotLogicKnowledgeItem.d.ts +1 -1
- package/api/resources/commons/types/BotLogicSafetyItem.d.ts +3 -0
- package/api/resources/commons/types/BotLogicSegmentsItem.d.ts +1 -1
- package/api/resources/commons/types/BotMessage.d.ts +1 -1
- package/api/resources/commons/types/BotResponse.d.ts +1 -1
- package/api/resources/commons/types/BotResponseMetadata.d.ts +1 -1
- package/api/resources/commons/types/BrowserInfo.d.ts +1 -1
- package/api/resources/commons/types/ConversationAnalysis.d.ts +1 -1
- package/api/resources/commons/types/ConversationExecutedActionPrecondition.d.ts +1 -1
- package/api/resources/commons/types/ConversationInformation.d.ts +1 -1
- package/api/resources/commons/types/ConversationMessageResponse.d.ts +1 -1
- package/api/resources/commons/types/ConversationPrecondition.d.ts +1 -1
- package/api/resources/commons/types/ConversationPreview.d.ts +1 -1
- package/api/resources/commons/types/ConversationResponse.d.ts +4 -2
- package/api/resources/commons/types/ConversationSummary.d.ts +11 -1
- package/api/resources/commons/types/DeviceInfo.d.ts +1 -1
- package/api/resources/commons/types/DocumentInformation.d.ts +1 -1
- package/api/resources/commons/types/EntityId.d.ts +1 -1
- package/api/resources/commons/types/EntityIdWithoutAgent.d.ts +1 -1
- package/api/resources/commons/types/EntityResult.d.ts +1 -1
- package/api/resources/commons/types/EventBaseNoId.d.ts +1 -1
- package/api/resources/commons/types/EventField.d.ts +15 -0
- package/api/resources/commons/types/EventField.js +15 -0
- package/api/resources/commons/types/EventFilter.d.ts +1 -1
- package/api/resources/commons/types/EventRequest.d.ts +1 -1
- package/api/resources/commons/types/EventResponse.d.ts +1 -1
- package/api/resources/commons/types/EventUserInfo.d.ts +1 -1
- package/api/resources/commons/types/EventUserInfoBase.d.ts +1 -1
- package/api/resources/commons/types/EventsSearchRequest.d.ts +1 -1
- package/api/resources/commons/types/EventsSearchResponse.d.ts +1 -1
- package/api/resources/commons/types/Feedback.d.ts +1 -1
- package/api/resources/commons/types/FeedbackBase.d.ts +1 -1
- package/api/resources/commons/types/FeedbackInfo.d.ts +1 -1
- package/api/resources/commons/types/HarmfulContentAnalysis.d.ts +10 -0
- package/api/resources/commons/types/HarmfulContentAnalysis.js +3 -0
- package/api/resources/commons/types/InboxItem.d.ts +1 -1
- package/api/resources/commons/types/InboxItemBase.d.ts +1 -1
- package/api/resources/commons/types/InboxItemCustom.d.ts +1 -1
- package/api/resources/commons/types/InboxItemDuplicateDocuments.d.ts +1 -1
- package/api/resources/commons/types/InboxItemFix.d.ts +1 -1
- package/api/resources/commons/types/InboxItemFixAddDocument.d.ts +1 -1
- package/api/resources/commons/types/InboxItemFixBase.d.ts +1 -1
- package/api/resources/commons/types/InboxItemFixDeactivateDocument.d.ts +1 -1
- package/api/resources/commons/types/InboxItemMissingKnowledge.d.ts +1 -1
- package/api/resources/commons/types/InboxItemType.d.ts +3 -0
- package/api/resources/commons/types/InboxItemType.js +3 -0
- package/api/resources/commons/types/KnowledgeContextByEntities.d.ts +4 -0
- package/api/resources/commons/types/KnowledgeContextByEntities.js +3 -0
- package/api/resources/commons/types/KnowledgeContextByEntityTypes.d.ts +4 -0
- package/api/resources/commons/types/KnowledgeContextByEntityTypes.js +3 -0
- package/api/resources/commons/types/KnowledgeContextFilter.d.ts +10 -0
- package/api/resources/commons/types/KnowledgeContextFilter.js +3 -0
- package/api/resources/commons/types/MetadataPrecondition.d.ts +1 -1
- package/api/resources/commons/types/NovelSystemEvent.d.ts +1 -1
- package/api/resources/commons/types/NovelSystemEventNoId.d.ts +1 -1
- package/api/resources/commons/types/NovelUserEvent.d.ts +1 -1
- package/api/resources/commons/types/OsInfo.d.ts +1 -1
- package/api/resources/commons/types/Precondition.d.ts +1 -1
- package/api/resources/commons/types/PreconditionBase.d.ts +1 -1
- package/api/resources/commons/types/PreconditionGroup.d.ts +1 -1
- package/api/resources/commons/types/ResponseConfig.d.ts +7 -1
- package/api/resources/commons/types/ResponseConfigPrecondition.d.ts +1 -1
- package/api/resources/commons/types/SafetyCheckReport.d.ts +9 -0
- package/api/resources/commons/types/SafetyCheckReport.js +3 -0
- package/api/resources/commons/types/ScopedEntity.d.ts +1 -1
- package/api/resources/commons/types/SimulationContext.d.ts +1 -1
- package/api/resources/commons/types/SourceInfo.d.ts +1 -1
- package/api/resources/commons/types/SystemEvent.d.ts +1 -1
- package/api/resources/commons/types/TagsPrecondition.d.ts +1 -1
- package/api/resources/commons/types/UserData.d.ts +1 -1
- package/api/resources/commons/types/UserDataWithReference.d.ts +1 -1
- package/api/resources/commons/types/UserEvent.d.ts +1 -1
- package/api/resources/commons/types/UserMessage.d.ts +1 -1
- package/api/resources/commons/types/UserMessageBase.d.ts +1 -1
- package/api/resources/commons/types/index.d.ts +118 -112
- package/api/resources/commons/types/index.js +118 -112
- package/api/resources/conversation/client/Client.d.ts +5 -31
- package/api/resources/conversation/client/Client.js +90 -90
- package/api/resources/conversation/client/index.d.ts +0 -1
- package/api/resources/conversation/client/requests/SimulationImportRequest.d.ts +1 -1
- package/api/resources/conversation/client/requests/index.d.ts +3 -3
- package/api/resources/conversation/index.d.ts +1 -1
- package/api/resources/conversation/index.js +1 -1
- package/api/resources/conversation/types/ActionFormAttachment.d.ts +1 -1
- package/api/resources/conversation/types/ActionFormRequestParamValue.d.ts +1 -1
- package/api/resources/conversation/types/AskObjectRequest.d.ts +1 -1
- package/api/resources/conversation/types/AskRequest.d.ts +1 -1
- package/api/resources/conversation/types/AskStreamActionEvent.d.ts +1 -1
- package/api/resources/conversation/types/AskStreamChartEvent.d.ts +1 -1
- package/api/resources/conversation/types/AskStreamEndEvent.d.ts +1 -1
- package/api/resources/conversation/types/AskStreamMetadataEvent.d.ts +1 -1
- package/api/resources/conversation/types/AskStreamOAuthButtonEvent.d.ts +1 -1
- package/api/resources/conversation/types/AskStreamStartEvent.d.ts +1 -1
- package/api/resources/conversation/types/ConversationField.d.ts +2 -0
- package/api/resources/conversation/types/ConversationField.js +2 -0
- package/api/resources/conversation/types/ConversationFilter.d.ts +1 -1
- package/api/resources/conversation/types/ConversationMessageRequest.d.ts +1 -1
- package/api/resources/conversation/types/ConversationPatchRequest.d.ts +1 -1
- package/api/resources/conversation/types/ConversationRequest.d.ts +1 -1
- package/api/resources/conversation/types/ConversationsResponse.d.ts +1 -1
- package/api/resources/conversation/types/ConversationsSearchRequest.d.ts +1 -1
- package/api/resources/conversation/types/DeliverConversationMessageRequest.d.ts +1 -1
- package/api/resources/conversation/types/DeliverMessageRequest.d.ts +1 -1
- package/api/resources/conversation/types/DeliverMessageResponse.d.ts +1 -1
- package/api/resources/conversation/types/DeliverUserMessageRequest.d.ts +1 -1
- package/api/resources/conversation/types/FeedbackFilter.d.ts +1 -1
- package/api/resources/conversation/types/FeedbackRequest.d.ts +1 -1
- package/api/resources/conversation/types/NumericConversationField.d.ts +1 -0
- package/api/resources/conversation/types/NumericConversationField.js +1 -0
- package/api/resources/conversation/types/ObjectStreamResponse.d.ts +1 -1
- package/api/resources/conversation/types/StreamResponse.d.ts +1 -1
- package/api/resources/conversation/types/SubmitActionFormRequest.d.ts +1 -1
- package/api/resources/conversation/types/index.d.ts +21 -21
- package/api/resources/conversation/types/index.js +21 -21
- package/api/resources/customers/client/Client.d.ts +82 -0
- package/api/resources/customers/client/Client.js +462 -0
- package/api/resources/customers/client/index.d.ts +1 -0
- package/api/resources/customers/client/index.js +17 -0
- package/api/resources/customers/client/requests/CustomerGetRequest.d.ts +8 -0
- package/api/resources/customers/client/requests/CustomerGetRequest.js +3 -0
- package/api/resources/customers/client/requests/index.d.ts +1 -0
- package/api/resources/customers/client/requests/index.js +2 -0
- package/api/resources/customers/index.d.ts +2 -0
- package/api/resources/customers/index.js +18 -0
- package/api/resources/customers/types/CustomerBase.d.ts +12 -0
- package/api/resources/customers/types/CustomerBase.js +3 -0
- package/api/resources/customers/types/CustomerField.d.ts +5 -0
- package/api/resources/customers/types/CustomerField.js +8 -0
- package/api/resources/customers/types/CustomerFilter.d.ts +11 -0
- package/api/resources/customers/types/CustomerFilter.js +3 -0
- package/api/resources/customers/types/CustomerPatchRequest.d.ts +21 -0
- package/api/resources/customers/types/CustomerPatchRequest.js +3 -0
- package/api/resources/customers/types/CustomerRequest.d.ts +15 -0
- package/api/resources/customers/types/CustomerRequest.js +3 -0
- package/api/resources/customers/types/CustomerResponse.d.ts +30 -0
- package/api/resources/customers/types/CustomerResponse.js +3 -0
- package/api/resources/customers/types/CustomerStatus.d.ts +5 -0
- package/api/resources/customers/types/CustomerStatus.js +8 -0
- package/api/resources/customers/types/CustomersSearchRequest.d.ts +7 -0
- package/api/resources/customers/types/CustomersSearchRequest.js +3 -0
- package/api/resources/customers/types/CustomersSearchResponse.d.ts +4 -0
- package/api/resources/customers/types/CustomersSearchResponse.js +3 -0
- package/api/resources/customers/types/index.d.ts +9 -0
- package/api/resources/customers/types/index.js +25 -0
- package/api/resources/events/client/Client.d.ts +3 -29
- package/api/resources/events/client/Client.js +23 -23
- package/api/resources/events/client/index.d.ts +0 -1
- package/api/resources/events/client/requests/index.d.ts +1 -1
- package/api/resources/inbox/client/Client.d.ts +3 -29
- package/api/resources/inbox/client/Client.js +32 -32
- package/api/resources/inbox/client/index.d.ts +0 -1
- package/api/resources/inbox/client/requests/index.d.ts +3 -3
- package/api/resources/inbox/index.d.ts +1 -1
- package/api/resources/inbox/index.js +1 -1
- package/api/resources/inbox/types/AddDocumentFixRequest.d.ts +1 -1
- package/api/resources/inbox/types/ApplyFixesRequest.d.ts +1 -1
- package/api/resources/inbox/types/InboxFilter.d.ts +1 -1
- package/api/resources/inbox/types/InboxSearchRequest.d.ts +1 -1
- package/api/resources/inbox/types/InboxSearchResponse.d.ts +1 -1
- package/api/resources/inbox/types/index.d.ts +2 -2
- package/api/resources/inbox/types/index.js +2 -2
- package/api/resources/index.d.ts +15 -12
- package/api/resources/index.js +16 -13
- package/api/resources/knowledge/client/Client.d.ts +3 -29
- package/api/resources/knowledge/client/Client.js +70 -70
- package/api/resources/knowledge/client/index.d.ts +0 -1
- package/api/resources/knowledge/client/requests/KnowledgeBasePatchRequest.d.ts +1 -1
- package/api/resources/knowledge/client/requests/KnowledgeDocumentPatchRequest.d.ts +1 -1
- package/api/resources/knowledge/client/requests/index.d.ts +5 -5
- package/api/resources/knowledge/index.d.ts +1 -1
- package/api/resources/knowledge/index.js +1 -1
- package/api/resources/knowledge/types/FinalizeKnowledgeBaseVersionRequest.d.ts +1 -1
- package/api/resources/knowledge/types/KnowledgeBaseFilter.d.ts +1 -1
- package/api/resources/knowledge/types/KnowledgeBaseProperties.d.ts +1 -1
- package/api/resources/knowledge/types/KnowledgeBaseRequest.d.ts +1 -1
- package/api/resources/knowledge/types/KnowledgeBaseResponse.d.ts +1 -1
- package/api/resources/knowledge/types/KnowledgeBaseSearchRequest.d.ts +1 -1
- package/api/resources/knowledge/types/KnowledgeBaseVersion.d.ts +1 -1
- package/api/resources/knowledge/types/KnowledgeBaseVersionRequest.d.ts +1 -1
- package/api/resources/knowledge/types/KnowledgeBaseVersionsListResponse.d.ts +1 -1
- package/api/resources/knowledge/types/KnowledgeBasesResponse.d.ts +1 -1
- package/api/resources/knowledge/types/KnowledgeDeleteRequest.d.ts +1 -1
- package/api/resources/knowledge/types/KnowledgeDocumentFilter.d.ts +1 -1
- package/api/resources/knowledge/types/KnowledgeDocumentRequest.d.ts +3 -1
- package/api/resources/knowledge/types/KnowledgeDocumentResponse.d.ts +19 -1
- package/api/resources/knowledge/types/KnowledgeDocumentSearchRequest.d.ts +1 -1
- package/api/resources/knowledge/types/KnowledgeDocumentSearchResponse.d.ts +1 -1
- package/api/resources/knowledge/types/KnowledgeDocumentsResponse.d.ts +1 -1
- package/api/resources/knowledge/types/index.d.ts +16 -16
- package/api/resources/knowledge/types/index.js +16 -16
- package/api/resources/organizations/client/Client.d.ts +3 -29
- package/api/resources/organizations/client/Client.js +33 -33
- package/api/resources/organizations/index.d.ts +1 -1
- package/api/resources/organizations/index.js +1 -1
- package/api/resources/organizations/types/CreateOrganizationRequest.d.ts +1 -1
- package/api/resources/organizations/types/Organization.d.ts +1 -1
- package/api/resources/organizations/types/index.d.ts +1 -1
- package/api/resources/organizations/types/index.js +1 -1
- package/api/resources/segments/client/Client.d.ts +7 -33
- package/api/resources/segments/client/Client.js +28 -28
- package/api/resources/segments/client/index.d.ts +0 -1
- package/api/resources/segments/client/requests/index.d.ts +1 -1
- package/api/resources/segments/index.d.ts +1 -1
- package/api/resources/segments/index.js +1 -1
- package/api/resources/segments/types/SegmentBase.d.ts +1 -1
- package/api/resources/segments/types/SegmentPatchRequest.d.ts +1 -1
- package/api/resources/segments/types/SegmentRequest.d.ts +5 -5
- package/api/resources/segments/types/SegmentResponse.d.ts +5 -5
- package/api/resources/segments/types/SegmentsSearchRequest.d.ts +1 -1
- package/api/resources/segments/types/SegmentsSearchResponse.d.ts +1 -1
- package/api/resources/segments/types/index.d.ts +4 -4
- package/api/resources/segments/types/index.js +4 -4
- package/api/resources/translations/client/Client.d.ts +3 -29
- package/api/resources/translations/client/Client.js +9 -9
- package/api/resources/translations/index.d.ts +1 -1
- package/api/resources/translations/index.js +1 -1
- package/api/resources/triggers/client/Client.d.ts +3 -29
- package/api/resources/triggers/client/Client.js +29 -29
- package/api/resources/triggers/client/index.d.ts +0 -1
- package/api/resources/triggers/client/requests/PartialUpdateRequest.d.ts +1 -1
- package/api/resources/triggers/client/requests/index.d.ts +1 -1
- package/api/resources/triggers/index.d.ts +1 -1
- package/api/resources/triggers/index.js +1 -1
- package/api/resources/triggers/types/EventTriggerBase.d.ts +1 -1
- package/api/resources/triggers/types/EventTriggerRequest.d.ts +1 -1
- package/api/resources/triggers/types/EventTriggerResponse.d.ts +1 -1
- package/api/resources/triggers/types/EventTriggersSearchRequest.d.ts +1 -1
- package/api/resources/triggers/types/EventTriggersSearchResponse.d.ts +1 -1
- package/api/resources/triggers/types/index.d.ts +3 -3
- package/api/resources/triggers/types/index.js +3 -3
- package/api/resources/users/client/Client.d.ts +3 -29
- package/api/resources/users/client/Client.js +30 -30
- package/api/resources/users/client/index.d.ts +0 -1
- package/api/resources/users/client/requests/index.d.ts +2 -2
- package/api/resources/users/index.d.ts +1 -1
- package/api/resources/users/index.js +1 -1
- package/api/resources/users/types/AgentUser.d.ts +1 -1
- package/api/resources/users/types/AgentUserSearchRequest.d.ts +1 -1
- package/api/resources/users/types/AgentUserSearchResponse.d.ts +1 -1
- package/api/resources/users/types/AppUserSummary.d.ts +1 -1
- package/api/resources/users/types/index.d.ts +1 -1
- package/api/resources/users/types/index.js +1 -1
- package/core/auth/AuthProvider.d.ts +1 -1
- package/core/fetcher/APIResponse.d.ts +1 -1
- package/core/fetcher/BinaryResponse.d.ts +1 -1
- package/core/fetcher/EndpointSupplier.d.ts +2 -2
- package/core/fetcher/Fetcher.d.ts +2 -2
- package/core/fetcher/Fetcher.js +2 -1
- package/core/fetcher/HttpResponsePromise.d.ts +1 -1
- package/core/fetcher/getErrorResponseBody.js +2 -1
- package/core/fetcher/getResponseBody.js +3 -3
- package/core/fetcher/makeRequest.js +2 -2
- package/core/fetcher/requestWithRetries.js +3 -3
- package/core/file/file.d.ts +6 -1
- package/core/file/file.js +25 -7
- package/core/form-data-utils/FormDataWrapper.d.ts +2 -3
- package/core/form-data-utils/FormDataWrapper.js +62 -85
- package/core/index.d.ts +4 -4
- package/core/index.js +5 -5
- package/core/schemas/Schema.d.ts +1 -1
- package/core/schemas/builders/bigint/bigint.d.ts +1 -1
- package/core/schemas/builders/bigint/bigint.js +2 -2
- package/core/schemas/builders/date/date.d.ts +1 -1
- package/core/schemas/builders/date/date.js +2 -2
- package/core/schemas/builders/enum/enum.d.ts +1 -1
- package/core/schemas/builders/index.d.ts +14 -14
- package/core/schemas/builders/index.js +14 -14
- package/core/schemas/builders/lazy/lazy.d.ts +1 -1
- package/core/schemas/builders/lazy/lazy.js +2 -2
- package/core/schemas/builders/lazy/lazyObject.d.ts +2 -2
- package/core/schemas/builders/lazy/lazyObject.js +4 -4
- package/core/schemas/builders/list/list.d.ts +1 -1
- package/core/schemas/builders/list/list.js +2 -2
- package/core/schemas/builders/literals/booleanLiteral.d.ts +1 -1
- package/core/schemas/builders/literals/stringLiteral.d.ts +1 -1
- package/core/schemas/builders/object/object.d.ts +1 -1
- package/core/schemas/builders/object/object.js +5 -5
- package/core/schemas/builders/object/objectWithoutOptionalProperties.d.ts +1 -1
- package/core/schemas/builders/object/property.d.ts +1 -1
- package/core/schemas/builders/object/types.d.ts +5 -5
- package/core/schemas/builders/object-like/getObjectLikeUtils.d.ts +2 -2
- package/core/schemas/builders/object-like/getObjectLikeUtils.js +2 -2
- package/core/schemas/builders/object-like/types.d.ts +1 -1
- package/core/schemas/builders/primitives/any.d.ts +1 -1
- package/core/schemas/builders/primitives/boolean.d.ts +1 -1
- package/core/schemas/builders/primitives/number.d.ts +1 -1
- package/core/schemas/builders/primitives/string.d.ts +1 -1
- package/core/schemas/builders/primitives/unknown.d.ts +1 -1
- package/core/schemas/builders/record/record.d.ts +2 -2
- package/core/schemas/builders/record/record.js +3 -3
- package/core/schemas/builders/record/types.d.ts +2 -2
- package/core/schemas/builders/schema-utils/JsonError.d.ts +1 -1
- package/core/schemas/builders/schema-utils/ParseError.d.ts +1 -1
- package/core/schemas/builders/schema-utils/getSchemaUtils.d.ts +1 -1
- package/core/schemas/builders/schema-utils/stringifyValidationErrors.d.ts +1 -1
- package/core/schemas/builders/set/set.d.ts +1 -1
- package/core/schemas/builders/set/set.js +4 -4
- package/core/schemas/builders/undiscriminated-union/types.d.ts +1 -1
- package/core/schemas/builders/undiscriminated-union/undiscriminatedUnion.d.ts +2 -2
- package/core/schemas/builders/undiscriminated-union/undiscriminatedUnion.js +2 -2
- package/core/schemas/builders/union/types.d.ts +2 -2
- package/core/schemas/builders/union/union.d.ts +3 -3
- package/core/schemas/builders/union/union.js +4 -4
- package/core/schemas/index.d.ts +1 -1
- package/core/schemas/index.js +1 -1
- package/core/schemas/utils/createIdentitySchemaCreator.d.ts +1 -1
- package/core/schemas/utils/createIdentitySchemaCreator.js +2 -2
- package/core/schemas/utils/maybeSkipValidation.d.ts +1 -1
- package/core/stream/Stream.d.ts +1 -0
- package/core/stream/Stream.js +8 -5
- package/core/url/encodePathParam.d.ts +1 -0
- package/core/url/encodePathParam.js +21 -0
- package/core/url/index.d.ts +1 -0
- package/core/url/index.js +3 -1
- package/core/url/join.js +3 -3
- package/dist/BaseClient.d.ts +36 -0
- package/dist/BaseClient.js +3 -0
- package/dist/Client.d.ts +6 -30
- package/dist/Client.js +25 -20
- package/dist/api/resources/actions/client/Client.d.ts +7 -33
- package/dist/api/resources/actions/client/Client.js +33 -33
- package/dist/api/resources/actions/client/index.d.ts +0 -1
- package/dist/api/resources/actions/client/requests/ActionPatchRequest.d.ts +1 -1
- package/dist/api/resources/actions/client/requests/index.d.ts +2 -2
- package/dist/api/resources/actions/index.d.ts +1 -1
- package/dist/api/resources/actions/index.js +1 -1
- package/dist/api/resources/actions/types/ActionFilter.d.ts +1 -1
- package/dist/api/resources/actions/types/ActionRequest.d.ts +5 -5
- package/dist/api/resources/actions/types/ActionsResponse.d.ts +1 -1
- package/dist/api/resources/actions/types/ActionsSearchRequest.d.ts +1 -1
- package/dist/api/resources/actions/types/index.d.ts +2 -2
- package/dist/api/resources/actions/types/index.js +2 -2
- package/dist/api/resources/agents/client/Client.d.ts +3 -29
- package/dist/api/resources/agents/client/Client.js +34 -34
- package/dist/api/resources/agents/client/index.d.ts +0 -1
- package/dist/api/resources/agents/client/requests/AgentPatchRequest.d.ts +1 -1
- package/dist/api/resources/agents/client/requests/index.d.ts +1 -1
- package/dist/api/resources/agents/index.d.ts +1 -1
- package/dist/api/resources/agents/index.js +1 -1
- package/dist/api/resources/agents/types/Agent.d.ts +1 -1
- package/dist/api/resources/agents/types/AgentFilter.d.ts +1 -1
- package/dist/api/resources/agents/types/AgentPrompting.d.ts +1 -1
- package/dist/api/resources/agents/types/AgentsSearchRequest.d.ts +1 -1
- package/dist/api/resources/agents/types/AgentsSearchResponse.d.ts +1 -1
- package/dist/api/resources/agents/types/CreateAgentRequest.d.ts +1 -1
- package/dist/api/resources/agents/types/index.d.ts +4 -5
- package/dist/api/resources/agents/types/index.js +4 -5
- package/dist/api/resources/analytics/client/Client.d.ts +89 -29
- package/dist/api/resources/analytics/client/Client.js +271 -25
- package/dist/api/resources/analytics/index.d.ts +1 -1
- package/dist/api/resources/analytics/index.js +1 -1
- package/dist/api/resources/analytics/types/AgentUserAnalyticsRequest.d.ts +1 -1
- package/dist/api/resources/analytics/types/AgentUserColumnDefinition.d.ts +1 -1
- package/dist/api/resources/analytics/types/AgentUserCount.d.ts +1 -2
- package/dist/api/resources/analytics/types/AgentUserMetric.d.ts +1 -1
- package/dist/api/resources/analytics/types/AgentUserRow.d.ts +1 -1
- package/dist/api/resources/analytics/types/AgentUserTableRequest.d.ts +1 -1
- package/dist/api/resources/analytics/types/AgentUserTableResponse.d.ts +1 -1
- package/dist/api/resources/analytics/types/BarChartResponse.d.ts +1 -1
- package/dist/api/resources/analytics/types/CellData.d.ts +1 -1
- package/dist/api/resources/analytics/types/ChartResponse.d.ts +1 -1
- package/dist/api/resources/analytics/types/ConversationAnalyticsRequest.d.ts +1 -1
- package/dist/api/resources/analytics/types/ConversationAverage.d.ts +1 -1
- package/dist/api/resources/analytics/types/ConversationBarChartRequest.d.ts +1 -1
- package/dist/api/resources/analytics/types/ConversationBasicMetric.d.ts +1 -1
- package/dist/api/resources/analytics/types/ConversationChartRequest.d.ts +1 -1
- package/dist/api/resources/analytics/types/ConversationColumnDefinition.d.ts +1 -1
- package/dist/api/resources/analytics/types/ConversationCount.d.ts +1 -2
- package/dist/api/resources/analytics/types/ConversationDateHistogramRequest.d.ts +1 -1
- package/dist/api/resources/analytics/types/ConversationDistinctCount.d.ts +1 -1
- package/dist/api/resources/analytics/types/ConversationGroupBy.d.ts +1 -1
- package/dist/api/resources/analytics/types/ConversationMax.d.ts +1 -1
- package/dist/api/resources/analytics/types/ConversationMedian.d.ts +1 -1
- package/dist/api/resources/analytics/types/ConversationMetric.d.ts +1 -1
- package/dist/api/resources/analytics/types/ConversationMin.d.ts +1 -1
- package/dist/api/resources/analytics/types/ConversationNumericMetric.d.ts +1 -1
- package/dist/api/resources/analytics/types/ConversationPercentile.d.ts +1 -1
- package/dist/api/resources/analytics/types/ConversationPieChartRequest.d.ts +1 -1
- package/dist/api/resources/analytics/types/ConversationRow.d.ts +1 -1
- package/dist/api/resources/analytics/types/ConversationSum.d.ts +1 -1
- package/dist/api/resources/analytics/types/ConversationTableRequest.d.ts +1 -1
- package/dist/api/resources/analytics/types/ConversationTableResponse.d.ts +1 -1
- package/dist/api/resources/analytics/types/DateHistogramResponse.d.ts +1 -1
- package/dist/api/resources/analytics/types/EventAnalyticsRequest.d.ts +11 -0
- package/dist/api/resources/analytics/types/EventAnalyticsRequest.js +3 -0
- package/dist/api/resources/analytics/types/EventBarChartRequest.d.ts +12 -0
- package/dist/api/resources/analytics/types/EventBarChartRequest.js +3 -0
- package/dist/api/resources/analytics/types/EventChartRequest.d.ts +60 -0
- package/dist/api/resources/analytics/types/EventChartRequest.js +3 -0
- package/dist/api/resources/analytics/types/EventColumnDefinition.d.ts +5 -0
- package/dist/api/resources/analytics/types/EventColumnDefinition.js +3 -0
- package/dist/api/resources/analytics/types/EventCount.d.ts +4 -0
- package/dist/api/resources/analytics/types/EventCount.js +3 -0
- package/dist/api/resources/analytics/types/EventDateHistogramRequest.d.ts +9 -0
- package/dist/api/resources/analytics/types/EventDateHistogramRequest.js +3 -0
- package/dist/api/resources/analytics/types/EventDistinctCount.d.ts +8 -0
- package/dist/api/resources/analytics/types/EventDistinctCount.js +3 -0
- package/dist/api/resources/analytics/types/EventGroupBy.d.ts +5 -0
- package/dist/api/resources/analytics/types/EventGroupBy.js +3 -0
- package/dist/api/resources/analytics/types/EventMetric.d.ts +14 -0
- package/dist/api/resources/analytics/types/EventMetric.js +3 -0
- package/dist/api/resources/analytics/types/EventPieChartRequest.d.ts +7 -0
- package/dist/api/resources/analytics/types/EventPieChartRequest.js +3 -0
- package/dist/api/resources/analytics/types/EventRow.d.ts +8 -0
- package/dist/api/resources/analytics/types/EventRow.js +3 -0
- package/dist/api/resources/analytics/types/EventTableRequest.d.ts +38 -0
- package/dist/api/resources/analytics/types/EventTableRequest.js +3 -0
- package/dist/api/resources/analytics/types/EventTableResponse.d.ts +42 -0
- package/dist/api/resources/analytics/types/EventTableResponse.js +3 -0
- package/dist/api/resources/analytics/types/FeedbackAnalyticsRequest.d.ts +1 -1
- package/dist/api/resources/analytics/types/FeedbackColumnDefinition.d.ts +1 -1
- package/dist/api/resources/analytics/types/FeedbackCount.d.ts +1 -2
- package/dist/api/resources/analytics/types/FeedbackDistinctCount.d.ts +1 -1
- package/dist/api/resources/analytics/types/FeedbackGroupBy.d.ts +1 -1
- package/dist/api/resources/analytics/types/FeedbackMetric.d.ts +1 -1
- package/dist/api/resources/analytics/types/FeedbackRow.d.ts +1 -1
- package/dist/api/resources/analytics/types/FeedbackTableRequest.d.ts +1 -1
- package/dist/api/resources/analytics/types/FeedbackTableResponse.d.ts +1 -1
- package/dist/api/resources/analytics/types/FieldValue.d.ts +1 -1
- package/dist/api/resources/analytics/types/PieChartResponse.d.ts +1 -1
- package/dist/api/resources/analytics/types/RowBase.d.ts +1 -1
- package/dist/api/resources/analytics/types/Series.d.ts +1 -1
- package/dist/api/resources/analytics/types/TimeSeries.d.ts +1 -1
- package/dist/api/resources/analytics/types/index.d.ts +49 -36
- package/dist/api/resources/analytics/types/index.js +49 -36
- package/dist/api/resources/appSettings/client/Client.d.ts +3 -29
- package/dist/api/resources/appSettings/client/Client.js +18 -18
- package/dist/api/resources/appSettings/client/index.d.ts +0 -1
- package/dist/api/resources/appSettings/client/requests/index.d.ts +1 -1
- package/dist/api/resources/appSettings/index.d.ts +1 -1
- package/dist/api/resources/appSettings/index.js +1 -1
- package/dist/api/resources/appSettings/types/SearchAppSettingsResponse.d.ts +1 -1
- package/dist/api/resources/appSettings/types/index.d.ts +1 -1
- package/dist/api/resources/appSettings/types/index.js +1 -1
- package/dist/api/resources/assets/client/Client.d.ts +3 -29
- package/dist/api/resources/assets/client/Client.js +14 -14
- package/dist/api/resources/assets/index.d.ts +1 -1
- package/dist/api/resources/assets/index.js +1 -1
- package/dist/api/resources/assets/types/InitiateAssetUploadRequest.d.ts +1 -1
- package/dist/api/resources/assets/types/InitiateAssetUploadResponse.d.ts +1 -1
- package/dist/api/resources/assets/types/index.d.ts +1 -1
- package/dist/api/resources/assets/types/index.js +1 -1
- package/dist/api/resources/commons/errors/BadRequestError.d.ts +2 -2
- package/dist/api/resources/commons/errors/NotFoundError.d.ts +2 -2
- package/dist/api/resources/commons/errors/ServerError.d.ts +2 -2
- package/dist/api/resources/commons/errors/index.d.ts +1 -1
- package/dist/api/resources/commons/errors/index.js +1 -1
- package/dist/api/resources/commons/index.d.ts +1 -1
- package/dist/api/resources/commons/index.js +1 -1
- package/dist/api/resources/commons/types/ActionBase.d.ts +1 -1
- package/dist/api/resources/commons/types/ActionExecutionParamValue.d.ts +1 -1
- package/dist/api/resources/commons/types/ActionFormField.d.ts +1 -1
- package/dist/api/resources/commons/types/ActionParameter.d.ts +1 -1
- package/dist/api/resources/commons/types/ActionResponse.d.ts +5 -5
- package/dist/api/resources/commons/types/AppPrecondition.d.ts +1 -1
- package/dist/api/resources/commons/types/AppUser.d.ts +1 -1
- package/dist/api/resources/commons/types/AppUserIdentifier.d.ts +1 -1
- package/dist/api/resources/commons/types/AppUserRequest.d.ts +1 -1
- package/dist/api/resources/commons/types/AppUserResponse.d.ts +1 -1
- package/dist/api/resources/commons/types/AttachmentRequest.d.ts +1 -1
- package/dist/api/resources/commons/types/AttachmentResponse.d.ts +1 -1
- package/dist/api/resources/commons/types/BaseConversationResponse.d.ts +1 -1
- package/dist/api/resources/commons/types/BaseSearchRequest.d.ts +1 -1
- package/dist/api/resources/commons/types/BotActionFormResponse.d.ts +1 -1
- package/dist/api/resources/commons/types/BotChartResponse.d.ts +1 -1
- package/dist/api/resources/commons/types/BotLogic.d.ts +1 -1
- package/dist/api/resources/commons/types/BotLogicActionExecutedDetail.d.ts +1 -1
- package/dist/api/resources/commons/types/BotLogicActionItem.d.ts +1 -1
- package/dist/api/resources/commons/types/BotLogicActionReviewedDetail.d.ts +1 -1
- package/dist/api/resources/commons/types/BotLogicFormSubmissionItem.d.ts +1 -1
- package/dist/api/resources/commons/types/BotLogicItem.d.ts +1 -1
- package/dist/api/resources/commons/types/BotLogicKnowledgeDetail.d.ts +1 -1
- package/dist/api/resources/commons/types/BotLogicKnowledgeItem.d.ts +1 -1
- package/dist/api/resources/commons/types/BotLogicSafetyItem.d.ts +3 -0
- package/dist/api/resources/commons/types/BotLogicSegmentsItem.d.ts +1 -1
- package/dist/api/resources/commons/types/BotMessage.d.ts +1 -1
- package/dist/api/resources/commons/types/BotResponse.d.ts +1 -1
- package/dist/api/resources/commons/types/BotResponseMetadata.d.ts +1 -1
- package/dist/api/resources/commons/types/BrowserInfo.d.ts +1 -1
- package/dist/api/resources/commons/types/ConversationAnalysis.d.ts +1 -1
- package/dist/api/resources/commons/types/ConversationExecutedActionPrecondition.d.ts +1 -1
- package/dist/api/resources/commons/types/ConversationInformation.d.ts +1 -1
- package/dist/api/resources/commons/types/ConversationMessageResponse.d.ts +1 -1
- package/dist/api/resources/commons/types/ConversationPrecondition.d.ts +1 -1
- package/dist/api/resources/commons/types/ConversationPreview.d.ts +1 -1
- package/dist/api/resources/commons/types/ConversationResponse.d.ts +4 -2
- package/dist/api/resources/commons/types/ConversationSummary.d.ts +11 -1
- package/dist/api/resources/commons/types/DeviceInfo.d.ts +1 -1
- package/dist/api/resources/commons/types/DocumentInformation.d.ts +1 -1
- package/dist/api/resources/commons/types/EntityId.d.ts +1 -1
- package/dist/api/resources/commons/types/EntityIdWithoutAgent.d.ts +1 -1
- package/dist/api/resources/commons/types/EntityResult.d.ts +1 -1
- package/dist/api/resources/commons/types/EventBaseNoId.d.ts +1 -1
- package/dist/api/resources/commons/types/EventField.d.ts +15 -0
- package/dist/api/resources/commons/types/EventField.js +15 -0
- package/dist/api/resources/commons/types/EventFilter.d.ts +1 -1
- package/dist/api/resources/commons/types/EventRequest.d.ts +1 -1
- package/dist/api/resources/commons/types/EventResponse.d.ts +1 -1
- package/dist/api/resources/commons/types/EventUserInfo.d.ts +1 -1
- package/dist/api/resources/commons/types/EventUserInfoBase.d.ts +1 -1
- package/dist/api/resources/commons/types/EventsSearchRequest.d.ts +1 -1
- package/dist/api/resources/commons/types/EventsSearchResponse.d.ts +1 -1
- package/dist/api/resources/commons/types/Feedback.d.ts +1 -1
- package/dist/api/resources/commons/types/FeedbackBase.d.ts +1 -1
- package/dist/api/resources/commons/types/FeedbackInfo.d.ts +1 -1
- package/dist/api/resources/commons/types/HarmfulContentAnalysis.d.ts +10 -0
- package/dist/api/resources/commons/types/HarmfulContentAnalysis.js +3 -0
- package/dist/api/resources/commons/types/InboxItem.d.ts +1 -1
- package/dist/api/resources/commons/types/InboxItemBase.d.ts +1 -1
- package/dist/api/resources/commons/types/InboxItemCustom.d.ts +1 -1
- package/dist/api/resources/commons/types/InboxItemDuplicateDocuments.d.ts +1 -1
- package/dist/api/resources/commons/types/InboxItemFix.d.ts +1 -1
- package/dist/api/resources/commons/types/InboxItemFixAddDocument.d.ts +1 -1
- package/dist/api/resources/commons/types/InboxItemFixBase.d.ts +1 -1
- package/dist/api/resources/commons/types/InboxItemFixDeactivateDocument.d.ts +1 -1
- package/dist/api/resources/commons/types/InboxItemMissingKnowledge.d.ts +1 -1
- package/dist/api/resources/commons/types/InboxItemType.d.ts +3 -0
- package/dist/api/resources/commons/types/InboxItemType.js +3 -0
- package/dist/api/resources/commons/types/KnowledgeContextByEntities.d.ts +4 -0
- package/dist/api/resources/commons/types/KnowledgeContextByEntities.js +3 -0
- package/dist/api/resources/commons/types/KnowledgeContextByEntityTypes.d.ts +4 -0
- package/dist/api/resources/commons/types/KnowledgeContextByEntityTypes.js +3 -0
- package/dist/api/resources/commons/types/KnowledgeContextFilter.d.ts +10 -0
- package/dist/api/resources/commons/types/KnowledgeContextFilter.js +3 -0
- package/dist/api/resources/commons/types/MetadataPrecondition.d.ts +1 -1
- package/dist/api/resources/commons/types/NovelSystemEvent.d.ts +1 -1
- package/dist/api/resources/commons/types/NovelSystemEventNoId.d.ts +1 -1
- package/dist/api/resources/commons/types/NovelUserEvent.d.ts +1 -1
- package/dist/api/resources/commons/types/OsInfo.d.ts +1 -1
- package/dist/api/resources/commons/types/Precondition.d.ts +1 -1
- package/dist/api/resources/commons/types/PreconditionBase.d.ts +1 -1
- package/dist/api/resources/commons/types/PreconditionGroup.d.ts +1 -1
- package/dist/api/resources/commons/types/ResponseConfig.d.ts +7 -1
- package/dist/api/resources/commons/types/ResponseConfigPrecondition.d.ts +1 -1
- package/dist/api/resources/commons/types/SafetyCheckReport.d.ts +9 -0
- package/dist/api/resources/commons/types/SafetyCheckReport.js +3 -0
- package/dist/api/resources/commons/types/ScopedEntity.d.ts +1 -1
- package/dist/api/resources/commons/types/SimulationContext.d.ts +1 -1
- package/dist/api/resources/commons/types/SourceInfo.d.ts +1 -1
- package/dist/api/resources/commons/types/SystemEvent.d.ts +1 -1
- package/dist/api/resources/commons/types/TagsPrecondition.d.ts +1 -1
- package/dist/api/resources/commons/types/UserData.d.ts +1 -1
- package/dist/api/resources/commons/types/UserDataWithReference.d.ts +1 -1
- package/dist/api/resources/commons/types/UserEvent.d.ts +1 -1
- package/dist/api/resources/commons/types/UserMessage.d.ts +1 -1
- package/dist/api/resources/commons/types/UserMessageBase.d.ts +1 -1
- package/dist/api/resources/commons/types/index.d.ts +118 -112
- package/dist/api/resources/commons/types/index.js +118 -112
- package/dist/api/resources/conversation/client/Client.d.ts +5 -31
- package/dist/api/resources/conversation/client/Client.js +90 -90
- package/dist/api/resources/conversation/client/index.d.ts +0 -1
- package/dist/api/resources/conversation/client/requests/SimulationImportRequest.d.ts +1 -1
- package/dist/api/resources/conversation/client/requests/index.d.ts +3 -3
- package/dist/api/resources/conversation/index.d.ts +1 -1
- package/dist/api/resources/conversation/index.js +1 -1
- package/dist/api/resources/conversation/types/ActionFormAttachment.d.ts +1 -1
- package/dist/api/resources/conversation/types/ActionFormRequestParamValue.d.ts +1 -1
- package/dist/api/resources/conversation/types/AskObjectRequest.d.ts +1 -1
- package/dist/api/resources/conversation/types/AskRequest.d.ts +1 -1
- package/dist/api/resources/conversation/types/AskStreamActionEvent.d.ts +1 -1
- package/dist/api/resources/conversation/types/AskStreamChartEvent.d.ts +1 -1
- package/dist/api/resources/conversation/types/AskStreamEndEvent.d.ts +1 -1
- package/dist/api/resources/conversation/types/AskStreamMetadataEvent.d.ts +1 -1
- package/dist/api/resources/conversation/types/AskStreamOAuthButtonEvent.d.ts +1 -1
- package/dist/api/resources/conversation/types/AskStreamStartEvent.d.ts +1 -1
- package/dist/api/resources/conversation/types/ConversationField.d.ts +2 -0
- package/dist/api/resources/conversation/types/ConversationField.js +2 -0
- package/dist/api/resources/conversation/types/ConversationFilter.d.ts +1 -1
- package/dist/api/resources/conversation/types/ConversationMessageRequest.d.ts +1 -1
- package/dist/api/resources/conversation/types/ConversationPatchRequest.d.ts +1 -1
- package/dist/api/resources/conversation/types/ConversationRequest.d.ts +1 -1
- package/dist/api/resources/conversation/types/ConversationsResponse.d.ts +1 -1
- package/dist/api/resources/conversation/types/ConversationsSearchRequest.d.ts +1 -1
- package/dist/api/resources/conversation/types/DeliverConversationMessageRequest.d.ts +1 -1
- package/dist/api/resources/conversation/types/DeliverMessageRequest.d.ts +1 -1
- package/dist/api/resources/conversation/types/DeliverMessageResponse.d.ts +1 -1
- package/dist/api/resources/conversation/types/DeliverUserMessageRequest.d.ts +1 -1
- package/dist/api/resources/conversation/types/FeedbackFilter.d.ts +1 -1
- package/dist/api/resources/conversation/types/FeedbackRequest.d.ts +1 -1
- package/dist/api/resources/conversation/types/NumericConversationField.d.ts +1 -0
- package/dist/api/resources/conversation/types/NumericConversationField.js +1 -0
- package/dist/api/resources/conversation/types/ObjectStreamResponse.d.ts +1 -1
- package/dist/api/resources/conversation/types/StreamResponse.d.ts +1 -1
- package/dist/api/resources/conversation/types/SubmitActionFormRequest.d.ts +1 -1
- package/dist/api/resources/conversation/types/index.d.ts +21 -21
- package/dist/api/resources/conversation/types/index.js +21 -21
- package/dist/api/resources/customers/client/Client.d.ts +82 -0
- package/dist/api/resources/customers/client/Client.js +462 -0
- package/dist/api/resources/customers/client/index.d.ts +1 -0
- package/dist/api/resources/customers/client/index.js +17 -0
- package/dist/api/resources/customers/client/requests/CustomerGetRequest.d.ts +8 -0
- package/dist/api/resources/customers/client/requests/CustomerGetRequest.js +3 -0
- package/dist/api/resources/customers/client/requests/index.d.ts +1 -0
- package/dist/api/resources/customers/client/requests/index.js +2 -0
- package/dist/api/resources/customers/index.d.ts +2 -0
- package/dist/api/resources/customers/index.js +18 -0
- package/dist/api/resources/customers/types/CustomerBase.d.ts +12 -0
- package/dist/api/resources/customers/types/CustomerBase.js +3 -0
- package/dist/api/resources/customers/types/CustomerField.d.ts +5 -0
- package/dist/api/resources/customers/types/CustomerField.js +8 -0
- package/dist/api/resources/customers/types/CustomerFilter.d.ts +11 -0
- package/dist/api/resources/customers/types/CustomerFilter.js +3 -0
- package/dist/api/resources/customers/types/CustomerPatchRequest.d.ts +21 -0
- package/dist/api/resources/customers/types/CustomerPatchRequest.js +3 -0
- package/dist/api/resources/customers/types/CustomerRequest.d.ts +15 -0
- package/dist/api/resources/customers/types/CustomerRequest.js +3 -0
- package/dist/api/resources/customers/types/CustomerResponse.d.ts +30 -0
- package/dist/api/resources/customers/types/CustomerResponse.js +3 -0
- package/dist/api/resources/customers/types/CustomerStatus.d.ts +5 -0
- package/dist/api/resources/customers/types/CustomerStatus.js +8 -0
- package/dist/api/resources/customers/types/CustomersSearchRequest.d.ts +7 -0
- package/dist/api/resources/customers/types/CustomersSearchRequest.js +3 -0
- package/dist/api/resources/customers/types/CustomersSearchResponse.d.ts +4 -0
- package/dist/api/resources/customers/types/CustomersSearchResponse.js +3 -0
- package/dist/api/resources/customers/types/index.d.ts +9 -0
- package/dist/api/resources/customers/types/index.js +25 -0
- package/dist/api/resources/events/client/Client.d.ts +3 -29
- package/dist/api/resources/events/client/Client.js +23 -23
- package/dist/api/resources/events/client/index.d.ts +0 -1
- package/dist/api/resources/events/client/requests/index.d.ts +1 -1
- package/dist/api/resources/inbox/client/Client.d.ts +3 -29
- package/dist/api/resources/inbox/client/Client.js +32 -32
- package/dist/api/resources/inbox/client/index.d.ts +0 -1
- package/dist/api/resources/inbox/client/requests/index.d.ts +3 -3
- package/dist/api/resources/inbox/index.d.ts +1 -1
- package/dist/api/resources/inbox/index.js +1 -1
- package/dist/api/resources/inbox/types/AddDocumentFixRequest.d.ts +1 -1
- package/dist/api/resources/inbox/types/ApplyFixesRequest.d.ts +1 -1
- package/dist/api/resources/inbox/types/InboxFilter.d.ts +1 -1
- package/dist/api/resources/inbox/types/InboxSearchRequest.d.ts +1 -1
- package/dist/api/resources/inbox/types/InboxSearchResponse.d.ts +1 -1
- package/dist/api/resources/inbox/types/index.d.ts +2 -2
- package/dist/api/resources/inbox/types/index.js +2 -2
- package/dist/api/resources/index.d.ts +15 -12
- package/dist/api/resources/index.js +16 -13
- package/dist/api/resources/knowledge/client/Client.d.ts +3 -29
- package/dist/api/resources/knowledge/client/Client.js +70 -70
- package/dist/api/resources/knowledge/client/index.d.ts +0 -1
- package/dist/api/resources/knowledge/client/requests/KnowledgeBasePatchRequest.d.ts +1 -1
- package/dist/api/resources/knowledge/client/requests/KnowledgeDocumentPatchRequest.d.ts +1 -1
- package/dist/api/resources/knowledge/client/requests/index.d.ts +5 -5
- package/dist/api/resources/knowledge/index.d.ts +1 -1
- package/dist/api/resources/knowledge/index.js +1 -1
- package/dist/api/resources/knowledge/types/FinalizeKnowledgeBaseVersionRequest.d.ts +1 -1
- package/dist/api/resources/knowledge/types/KnowledgeBaseFilter.d.ts +1 -1
- package/dist/api/resources/knowledge/types/KnowledgeBaseProperties.d.ts +1 -1
- package/dist/api/resources/knowledge/types/KnowledgeBaseRequest.d.ts +1 -1
- package/dist/api/resources/knowledge/types/KnowledgeBaseResponse.d.ts +1 -1
- package/dist/api/resources/knowledge/types/KnowledgeBaseSearchRequest.d.ts +1 -1
- package/dist/api/resources/knowledge/types/KnowledgeBaseVersion.d.ts +1 -1
- package/dist/api/resources/knowledge/types/KnowledgeBaseVersionRequest.d.ts +1 -1
- package/dist/api/resources/knowledge/types/KnowledgeBaseVersionsListResponse.d.ts +1 -1
- package/dist/api/resources/knowledge/types/KnowledgeBasesResponse.d.ts +1 -1
- package/dist/api/resources/knowledge/types/KnowledgeDeleteRequest.d.ts +1 -1
- package/dist/api/resources/knowledge/types/KnowledgeDocumentFilter.d.ts +1 -1
- package/dist/api/resources/knowledge/types/KnowledgeDocumentRequest.d.ts +3 -1
- package/dist/api/resources/knowledge/types/KnowledgeDocumentResponse.d.ts +19 -1
- package/dist/api/resources/knowledge/types/KnowledgeDocumentSearchRequest.d.ts +1 -1
- package/dist/api/resources/knowledge/types/KnowledgeDocumentSearchResponse.d.ts +1 -1
- package/dist/api/resources/knowledge/types/KnowledgeDocumentsResponse.d.ts +1 -1
- package/dist/api/resources/knowledge/types/index.d.ts +16 -16
- package/dist/api/resources/knowledge/types/index.js +16 -16
- package/dist/api/resources/organizations/client/Client.d.ts +3 -29
- package/dist/api/resources/organizations/client/Client.js +33 -33
- package/dist/api/resources/organizations/index.d.ts +1 -1
- package/dist/api/resources/organizations/index.js +1 -1
- package/dist/api/resources/organizations/types/CreateOrganizationRequest.d.ts +1 -1
- package/dist/api/resources/organizations/types/Organization.d.ts +1 -1
- package/dist/api/resources/organizations/types/index.d.ts +1 -1
- package/dist/api/resources/organizations/types/index.js +1 -1
- package/dist/api/resources/segments/client/Client.d.ts +7 -33
- package/dist/api/resources/segments/client/Client.js +28 -28
- package/dist/api/resources/segments/client/index.d.ts +0 -1
- package/dist/api/resources/segments/client/requests/index.d.ts +1 -1
- package/dist/api/resources/segments/index.d.ts +1 -1
- package/dist/api/resources/segments/index.js +1 -1
- package/dist/api/resources/segments/types/SegmentBase.d.ts +1 -1
- package/dist/api/resources/segments/types/SegmentPatchRequest.d.ts +1 -1
- package/dist/api/resources/segments/types/SegmentRequest.d.ts +5 -5
- package/dist/api/resources/segments/types/SegmentResponse.d.ts +5 -5
- package/dist/api/resources/segments/types/SegmentsSearchRequest.d.ts +1 -1
- package/dist/api/resources/segments/types/SegmentsSearchResponse.d.ts +1 -1
- package/dist/api/resources/segments/types/index.d.ts +4 -4
- package/dist/api/resources/segments/types/index.js +4 -4
- package/dist/api/resources/translations/client/Client.d.ts +3 -29
- package/dist/api/resources/translations/client/Client.js +9 -9
- package/dist/api/resources/translations/index.d.ts +1 -1
- package/dist/api/resources/translations/index.js +1 -1
- package/dist/api/resources/triggers/client/Client.d.ts +3 -29
- package/dist/api/resources/triggers/client/Client.js +29 -29
- package/dist/api/resources/triggers/client/index.d.ts +0 -1
- package/dist/api/resources/triggers/client/requests/PartialUpdateRequest.d.ts +1 -1
- package/dist/api/resources/triggers/client/requests/index.d.ts +1 -1
- package/dist/api/resources/triggers/index.d.ts +1 -1
- package/dist/api/resources/triggers/index.js +1 -1
- package/dist/api/resources/triggers/types/EventTriggerBase.d.ts +1 -1
- package/dist/api/resources/triggers/types/EventTriggerRequest.d.ts +1 -1
- package/dist/api/resources/triggers/types/EventTriggerResponse.d.ts +1 -1
- package/dist/api/resources/triggers/types/EventTriggersSearchRequest.d.ts +1 -1
- package/dist/api/resources/triggers/types/EventTriggersSearchResponse.d.ts +1 -1
- package/dist/api/resources/triggers/types/index.d.ts +3 -3
- package/dist/api/resources/triggers/types/index.js +3 -3
- package/dist/api/resources/users/client/Client.d.ts +3 -29
- package/dist/api/resources/users/client/Client.js +30 -30
- package/dist/api/resources/users/client/index.d.ts +0 -1
- package/dist/api/resources/users/client/requests/index.d.ts +2 -2
- package/dist/api/resources/users/index.d.ts +1 -1
- package/dist/api/resources/users/index.js +1 -1
- package/dist/api/resources/users/types/AgentUser.d.ts +1 -1
- package/dist/api/resources/users/types/AgentUserSearchRequest.d.ts +1 -1
- package/dist/api/resources/users/types/AgentUserSearchResponse.d.ts +1 -1
- package/dist/api/resources/users/types/AppUserSummary.d.ts +1 -1
- package/dist/api/resources/users/types/index.d.ts +1 -1
- package/dist/api/resources/users/types/index.js +1 -1
- package/dist/core/auth/AuthProvider.d.ts +1 -1
- package/dist/core/fetcher/APIResponse.d.ts +1 -1
- package/dist/core/fetcher/BinaryResponse.d.ts +1 -1
- package/dist/core/fetcher/EndpointSupplier.d.ts +2 -2
- package/dist/core/fetcher/Fetcher.d.ts +2 -2
- package/dist/core/fetcher/Fetcher.js +2 -1
- package/dist/core/fetcher/HttpResponsePromise.d.ts +1 -1
- package/dist/core/fetcher/getErrorResponseBody.js +2 -1
- package/dist/core/fetcher/getResponseBody.js +3 -3
- package/dist/core/fetcher/makeRequest.js +2 -2
- package/dist/core/fetcher/requestWithRetries.js +3 -3
- package/dist/core/file/file.d.ts +6 -1
- package/dist/core/file/file.js +25 -7
- package/dist/core/form-data-utils/FormDataWrapper.d.ts +2 -3
- package/dist/core/form-data-utils/FormDataWrapper.js +62 -85
- package/dist/core/index.d.ts +4 -4
- package/dist/core/index.js +5 -5
- package/dist/core/schemas/Schema.d.ts +1 -1
- package/dist/core/schemas/builders/bigint/bigint.d.ts +1 -1
- package/dist/core/schemas/builders/bigint/bigint.js +2 -2
- package/dist/core/schemas/builders/date/date.d.ts +1 -1
- package/dist/core/schemas/builders/date/date.js +2 -2
- package/dist/core/schemas/builders/enum/enum.d.ts +1 -1
- package/dist/core/schemas/builders/index.d.ts +14 -14
- package/dist/core/schemas/builders/index.js +14 -14
- package/dist/core/schemas/builders/lazy/lazy.d.ts +1 -1
- package/dist/core/schemas/builders/lazy/lazy.js +2 -2
- package/dist/core/schemas/builders/lazy/lazyObject.d.ts +2 -2
- package/dist/core/schemas/builders/lazy/lazyObject.js +4 -4
- package/dist/core/schemas/builders/list/list.d.ts +1 -1
- package/dist/core/schemas/builders/list/list.js +2 -2
- package/dist/core/schemas/builders/literals/booleanLiteral.d.ts +1 -1
- package/dist/core/schemas/builders/literals/stringLiteral.d.ts +1 -1
- package/dist/core/schemas/builders/object/object.d.ts +1 -1
- package/dist/core/schemas/builders/object/object.js +5 -5
- package/dist/core/schemas/builders/object/objectWithoutOptionalProperties.d.ts +1 -1
- package/dist/core/schemas/builders/object/property.d.ts +1 -1
- package/dist/core/schemas/builders/object/types.d.ts +5 -5
- package/dist/core/schemas/builders/object-like/getObjectLikeUtils.d.ts +2 -2
- package/dist/core/schemas/builders/object-like/getObjectLikeUtils.js +2 -2
- package/dist/core/schemas/builders/object-like/types.d.ts +1 -1
- package/dist/core/schemas/builders/primitives/any.d.ts +1 -1
- package/dist/core/schemas/builders/primitives/boolean.d.ts +1 -1
- package/dist/core/schemas/builders/primitives/number.d.ts +1 -1
- package/dist/core/schemas/builders/primitives/string.d.ts +1 -1
- package/dist/core/schemas/builders/primitives/unknown.d.ts +1 -1
- package/dist/core/schemas/builders/record/record.d.ts +2 -2
- package/dist/core/schemas/builders/record/record.js +3 -3
- package/dist/core/schemas/builders/record/types.d.ts +2 -2
- package/dist/core/schemas/builders/schema-utils/JsonError.d.ts +1 -1
- package/dist/core/schemas/builders/schema-utils/ParseError.d.ts +1 -1
- package/dist/core/schemas/builders/schema-utils/getSchemaUtils.d.ts +1 -1
- package/dist/core/schemas/builders/schema-utils/stringifyValidationErrors.d.ts +1 -1
- package/dist/core/schemas/builders/set/set.d.ts +1 -1
- package/dist/core/schemas/builders/set/set.js +4 -4
- package/dist/core/schemas/builders/undiscriminated-union/types.d.ts +1 -1
- package/dist/core/schemas/builders/undiscriminated-union/undiscriminatedUnion.d.ts +2 -2
- package/dist/core/schemas/builders/undiscriminated-union/undiscriminatedUnion.js +2 -2
- package/dist/core/schemas/builders/union/types.d.ts +2 -2
- package/dist/core/schemas/builders/union/union.d.ts +3 -3
- package/dist/core/schemas/builders/union/union.js +4 -4
- package/dist/core/schemas/index.d.ts +1 -1
- package/dist/core/schemas/index.js +1 -1
- package/dist/core/schemas/utils/createIdentitySchemaCreator.d.ts +1 -1
- package/dist/core/schemas/utils/createIdentitySchemaCreator.js +2 -2
- package/dist/core/schemas/utils/maybeSkipValidation.d.ts +1 -1
- package/dist/core/stream/Stream.d.ts +1 -0
- package/dist/core/stream/Stream.js +8 -5
- package/dist/core/url/encodePathParam.d.ts +1 -0
- package/dist/core/url/encodePathParam.js +21 -0
- package/dist/core/url/index.d.ts +1 -0
- package/dist/core/url/index.js +3 -1
- package/dist/core/url/join.js +3 -3
- package/dist/errors/MavenAGIError.d.ts +1 -1
- package/dist/errors/MavenAGIError.js +1 -1
- package/dist/index.d.ts +3 -2
- package/dist/index.js +5 -5
- package/dist/serialization/resources/actions/client/requests/ActionPatchRequest.d.ts +3 -3
- package/dist/serialization/resources/actions/client/requests/ActionPatchRequest.js +1 -1
- package/dist/serialization/resources/actions/index.d.ts +1 -1
- package/dist/serialization/resources/actions/index.js +1 -1
- package/dist/serialization/resources/actions/types/ActionField.d.ts +2 -2
- package/dist/serialization/resources/actions/types/ActionFilter.d.ts +2 -2
- package/dist/serialization/resources/actions/types/ActionRequest.d.ts +3 -3
- package/dist/serialization/resources/actions/types/ActionRequest.js +1 -1
- package/dist/serialization/resources/actions/types/ActionsResponse.d.ts +2 -2
- package/dist/serialization/resources/actions/types/ActionsSearchRequest.d.ts +3 -3
- package/dist/serialization/resources/actions/types/ActionsSearchRequest.js +1 -1
- package/dist/serialization/resources/actions/types/index.d.ts +2 -2
- package/dist/serialization/resources/actions/types/index.js +2 -2
- package/dist/serialization/resources/agents/client/list.d.ts +2 -2
- package/dist/serialization/resources/agents/client/requests/AgentPatchRequest.d.ts +4 -4
- package/dist/serialization/resources/agents/client/requests/AgentPatchRequest.js +2 -2
- package/dist/serialization/resources/agents/index.d.ts +1 -1
- package/dist/serialization/resources/agents/index.js +1 -1
- package/dist/serialization/resources/agents/types/Agent.d.ts +3 -3
- package/dist/serialization/resources/agents/types/Agent.js +1 -1
- package/dist/serialization/resources/agents/types/AgentEnvironment.d.ts +2 -2
- package/dist/serialization/resources/agents/types/AgentField.d.ts +2 -2
- package/dist/serialization/resources/agents/types/AgentFilter.d.ts +2 -2
- package/dist/serialization/resources/agents/types/AgentPrompting.d.ts +2 -2
- package/dist/serialization/resources/agents/types/AgentsSearchRequest.d.ts +3 -3
- package/dist/serialization/resources/agents/types/AgentsSearchRequest.js +1 -1
- package/dist/serialization/resources/agents/types/AgentsSearchResponse.d.ts +3 -3
- package/dist/serialization/resources/agents/types/AgentsSearchResponse.js +1 -1
- package/dist/serialization/resources/agents/types/CreateAgentRequest.d.ts +2 -2
- package/dist/serialization/resources/agents/types/index.d.ts +4 -5
- package/dist/serialization/resources/agents/types/index.js +4 -5
- package/dist/serialization/resources/analytics/types/AgentUserAnalyticsRequest.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/AgentUserColumnDefinition.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/AgentUserCount.d.ts +3 -4
- package/dist/serialization/resources/analytics/types/AgentUserMetric.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/AgentUserRow.d.ts +3 -3
- package/dist/serialization/resources/analytics/types/AgentUserRow.js +1 -1
- package/dist/serialization/resources/analytics/types/AgentUserTableRequest.d.ts +4 -4
- package/dist/serialization/resources/analytics/types/AgentUserTableRequest.js +2 -2
- package/dist/serialization/resources/analytics/types/AgentUserTableResponse.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/BarChartResponse.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/CellData.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/ChartResponse.d.ts +4 -4
- package/dist/serialization/resources/analytics/types/ChartResponse.js +2 -2
- package/dist/serialization/resources/analytics/types/ColumnDefinitionBase.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/ConversationAnalyticsRequest.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/ConversationAverage.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/ConversationBarChartRequest.d.ts +3 -3
- package/dist/serialization/resources/analytics/types/ConversationBarChartRequest.js +1 -1
- package/dist/serialization/resources/analytics/types/ConversationBasicMetric.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/ConversationChartRequest.d.ts +4 -4
- package/dist/serialization/resources/analytics/types/ConversationChartRequest.js +2 -2
- package/dist/serialization/resources/analytics/types/ConversationColumnDefinition.d.ts +3 -3
- package/dist/serialization/resources/analytics/types/ConversationColumnDefinition.js +1 -1
- package/dist/serialization/resources/analytics/types/ConversationCount.d.ts +3 -4
- package/dist/serialization/resources/analytics/types/ConversationDateHistogramRequest.d.ts +4 -4
- package/dist/serialization/resources/analytics/types/ConversationDateHistogramRequest.js +2 -2
- package/dist/serialization/resources/analytics/types/ConversationDistinctCount.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/ConversationGroupBy.d.ts +3 -3
- package/dist/serialization/resources/analytics/types/ConversationGroupBy.js +1 -1
- package/dist/serialization/resources/analytics/types/ConversationMax.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/ConversationMedian.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/ConversationMetric.d.ts +7 -7
- package/dist/serialization/resources/analytics/types/ConversationMetric.js +5 -5
- package/dist/serialization/resources/analytics/types/ConversationMin.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/ConversationNumericMetric.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/ConversationPercentile.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/ConversationPieChartRequest.d.ts +3 -3
- package/dist/serialization/resources/analytics/types/ConversationPieChartRequest.js +1 -1
- package/dist/serialization/resources/analytics/types/ConversationRow.d.ts +3 -3
- package/dist/serialization/resources/analytics/types/ConversationRow.js +1 -1
- package/dist/serialization/resources/analytics/types/ConversationSum.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/ConversationTableRequest.d.ts +5 -5
- package/dist/serialization/resources/analytics/types/ConversationTableRequest.js +3 -3
- package/dist/serialization/resources/analytics/types/ConversationTableResponse.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/DateHistogramResponse.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/EventAnalyticsRequest.d.ts +11 -0
- package/dist/serialization/resources/analytics/types/EventAnalyticsRequest.js +43 -0
- package/dist/serialization/resources/analytics/types/EventBarChartRequest.d.ts +14 -0
- package/dist/serialization/resources/analytics/types/EventBarChartRequest.js +48 -0
- package/dist/serialization/resources/analytics/types/EventChartRequest.d.ts +19 -0
- package/dist/serialization/resources/analytics/types/EventChartRequest.js +51 -0
- package/dist/serialization/resources/analytics/types/EventColumnDefinition.d.ts +11 -0
- package/dist/serialization/resources/analytics/types/EventColumnDefinition.js +45 -0
- package/dist/serialization/resources/analytics/types/EventCount.d.ts +7 -0
- package/dist/serialization/resources/analytics/types/EventCount.js +39 -0
- package/dist/serialization/resources/analytics/types/EventDateHistogramRequest.d.ts +15 -0
- package/dist/serialization/resources/analytics/types/EventDateHistogramRequest.js +49 -0
- package/dist/serialization/resources/analytics/types/EventDistinctCount.d.ts +10 -0
- package/dist/serialization/resources/analytics/types/EventDistinctCount.js +42 -0
- package/dist/serialization/resources/analytics/types/EventGroupBy.d.ts +11 -0
- package/dist/serialization/resources/analytics/types/EventGroupBy.js +45 -0
- package/dist/serialization/resources/analytics/types/EventMetric.d.ts +15 -0
- package/dist/serialization/resources/analytics/types/EventMetric.js +49 -0
- package/dist/serialization/resources/analytics/types/EventPieChartRequest.d.ts +13 -0
- package/dist/serialization/resources/analytics/types/EventPieChartRequest.js +47 -0
- package/dist/serialization/resources/analytics/types/EventRow.d.ts +12 -0
- package/dist/serialization/resources/analytics/types/EventRow.js +46 -0
- package/dist/serialization/resources/analytics/types/EventTableRequest.d.ts +15 -0
- package/dist/serialization/resources/analytics/types/EventTableRequest.js +49 -0
- package/dist/serialization/resources/analytics/types/EventTableResponse.d.ts +11 -0
- package/dist/serialization/resources/analytics/types/EventTableResponse.js +45 -0
- package/dist/serialization/resources/analytics/types/FeedbackAnalyticsRequest.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/FeedbackColumnDefinition.d.ts +3 -3
- package/dist/serialization/resources/analytics/types/FeedbackColumnDefinition.js +1 -1
- package/dist/serialization/resources/analytics/types/FeedbackCount.d.ts +3 -4
- package/dist/serialization/resources/analytics/types/FeedbackDistinctCount.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/FeedbackGroupBy.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/FeedbackMetric.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/FeedbackRow.d.ts +3 -3
- package/dist/serialization/resources/analytics/types/FeedbackRow.js +1 -1
- package/dist/serialization/resources/analytics/types/FeedbackTableRequest.d.ts +5 -5
- package/dist/serialization/resources/analytics/types/FeedbackTableRequest.js +3 -3
- package/dist/serialization/resources/analytics/types/FeedbackTableResponse.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/FieldValue.d.ts +3 -3
- package/dist/serialization/resources/analytics/types/FieldValue.js +1 -1
- package/dist/serialization/resources/analytics/types/GroupByBase.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/LabeledPoint.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/PieChartResponse.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/Range.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/RowBase.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/Series.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/TableResponseBase.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/TimeDataPoint.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/TimeInterval.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/TimeSeries.d.ts +2 -2
- package/dist/serialization/resources/analytics/types/index.d.ts +49 -36
- package/dist/serialization/resources/analytics/types/index.js +49 -36
- package/dist/serialization/resources/appSettings/client/get.d.ts +1 -1
- package/dist/serialization/resources/appSettings/client/update.d.ts +1 -1
- package/dist/serialization/resources/appSettings/index.d.ts +1 -1
- package/dist/serialization/resources/appSettings/index.js +1 -1
- package/dist/serialization/resources/appSettings/types/AppSettings.d.ts +2 -2
- package/dist/serialization/resources/appSettings/types/SearchAppSettingsResponse.d.ts +2 -2
- package/dist/serialization/resources/appSettings/types/index.d.ts +1 -1
- package/dist/serialization/resources/appSettings/types/index.js +1 -1
- package/dist/serialization/resources/assets/types/CommitAssetUploadRequest.d.ts +2 -2
- package/dist/serialization/resources/assets/types/InitiateAssetUploadRequest.d.ts +2 -2
- package/dist/serialization/resources/assets/types/InitiateAssetUploadResponse.d.ts +2 -2
- package/dist/serialization/resources/assets/types/index.d.ts +1 -1
- package/dist/serialization/resources/assets/types/index.js +1 -1
- package/dist/serialization/resources/commons/types/ActionBase.d.ts +2 -2
- package/dist/serialization/resources/commons/types/ActionBase.js +1 -1
- package/dist/serialization/resources/commons/types/ActionEnumOption.d.ts +2 -2
- package/dist/serialization/resources/commons/types/ActionExecutionParamValue.d.ts +2 -2
- package/dist/serialization/resources/commons/types/ActionFormField.d.ts +3 -3
- package/dist/serialization/resources/commons/types/ActionFormField.js +1 -1
- package/dist/serialization/resources/commons/types/ActionOAuthConfiguration.d.ts +2 -2
- package/dist/serialization/resources/commons/types/ActionParameter.d.ts +3 -3
- package/dist/serialization/resources/commons/types/ActionParameter.js +1 -1
- package/dist/serialization/resources/commons/types/ActionParameterType.d.ts +2 -2
- package/dist/serialization/resources/commons/types/ActionResponse.d.ts +3 -3
- package/dist/serialization/resources/commons/types/ActionResponse.js +1 -1
- package/dist/serialization/resources/commons/types/AppPrecondition.d.ts +2 -2
- package/dist/serialization/resources/commons/types/AppUser.d.ts +2 -2
- package/dist/serialization/resources/commons/types/AppUserIdentifier.d.ts +2 -2
- package/dist/serialization/resources/commons/types/AppUserIdentifyingPropertyType.d.ts +2 -2
- package/dist/serialization/resources/commons/types/AppUserRequest.d.ts +3 -3
- package/dist/serialization/resources/commons/types/AppUserRequest.js +1 -1
- package/dist/serialization/resources/commons/types/AppUserResponse.d.ts +3 -3
- package/dist/serialization/resources/commons/types/AppUserResponse.js +1 -1
- package/dist/serialization/resources/commons/types/AttachmentRequest.d.ts +3 -3
- package/dist/serialization/resources/commons/types/AttachmentRequest.js +1 -1
- package/dist/serialization/resources/commons/types/AttachmentResponse.d.ts +2 -2
- package/dist/serialization/resources/commons/types/AttachmentStatus.d.ts +2 -2
- package/dist/serialization/resources/commons/types/BaseAttachment.d.ts +2 -2
- package/dist/serialization/resources/commons/types/BaseConversationResponse.d.ts +4 -4
- package/dist/serialization/resources/commons/types/BaseConversationResponse.js +2 -2
- package/dist/serialization/resources/commons/types/BasePaginatedRequest.d.ts +2 -2
- package/dist/serialization/resources/commons/types/BaseSearchRequest.d.ts +2 -2
- package/dist/serialization/resources/commons/types/BotActionFormResponse.d.ts +3 -3
- package/dist/serialization/resources/commons/types/BotActionFormResponse.js +1 -1
- package/dist/serialization/resources/commons/types/BotChartResponse.d.ts +2 -2
- package/dist/serialization/resources/commons/types/BotConversationMessageType.d.ts +2 -2
- package/dist/serialization/resources/commons/types/BotLogic.d.ts +2 -2
- package/dist/serialization/resources/commons/types/BotLogicActionExecutedDetail.d.ts +2 -2
- package/dist/serialization/resources/commons/types/BotLogicActionItem.d.ts +3 -3
- package/dist/serialization/resources/commons/types/BotLogicActionItem.js +1 -1
- package/dist/serialization/resources/commons/types/BotLogicActionReviewedDetail.d.ts +2 -2
- package/dist/serialization/resources/commons/types/BotLogicFormSubmissionItem.d.ts +2 -2
- package/dist/serialization/resources/commons/types/BotLogicItem.d.ts +4 -4
- package/dist/serialization/resources/commons/types/BotLogicItem.js +2 -2
- package/dist/serialization/resources/commons/types/BotLogicKnowledgeDetail.d.ts +2 -2
- package/dist/serialization/resources/commons/types/BotLogicKnowledgeItem.d.ts +2 -2
- package/dist/serialization/resources/commons/types/BotLogicSafetyItem.d.ts +4 -2
- package/dist/serialization/resources/commons/types/BotLogicSafetyItem.js +2 -0
- package/dist/serialization/resources/commons/types/BotLogicSegmentsItem.d.ts +2 -2
- package/dist/serialization/resources/commons/types/BotLogicUserItem.d.ts +2 -2
- package/dist/serialization/resources/commons/types/BotMessage.d.ts +5 -5
- package/dist/serialization/resources/commons/types/BotMessage.js +3 -3
- package/dist/serialization/resources/commons/types/BotOAuthButtonResponse.d.ts +2 -2
- package/dist/serialization/resources/commons/types/BotObjectResponse.d.ts +2 -2
- package/dist/serialization/resources/commons/types/BotResponse.d.ts +4 -4
- package/dist/serialization/resources/commons/types/BotResponse.js +2 -2
- package/dist/serialization/resources/commons/types/BotResponseMetadata.d.ts +2 -2
- package/dist/serialization/resources/commons/types/BotTextResponse.d.ts +2 -2
- package/dist/serialization/resources/commons/types/BrowserInfo.d.ts +2 -2
- package/dist/serialization/resources/commons/types/BrowserType.d.ts +2 -2
- package/dist/serialization/resources/commons/types/Capability.d.ts +2 -2
- package/dist/serialization/resources/commons/types/ChartSpecSchema.d.ts +2 -2
- package/dist/serialization/resources/commons/types/ContextInfo.d.ts +2 -2
- package/dist/serialization/resources/commons/types/ConversationAnalysis.d.ts +3 -3
- package/dist/serialization/resources/commons/types/ConversationAnalysis.js +1 -1
- package/dist/serialization/resources/commons/types/ConversationExecutedActionPrecondition.d.ts +2 -2
- package/dist/serialization/resources/commons/types/ConversationInformation.d.ts +2 -2
- package/dist/serialization/resources/commons/types/ConversationMessageBase.d.ts +2 -2
- package/dist/serialization/resources/commons/types/ConversationMessageResponse.d.ts +3 -3
- package/dist/serialization/resources/commons/types/ConversationMessageResponse.js +1 -1
- package/dist/serialization/resources/commons/types/ConversationPrecondition.d.ts +5 -5
- package/dist/serialization/resources/commons/types/ConversationPrecondition.js +3 -3
- package/dist/serialization/resources/commons/types/ConversationPreview.d.ts +2 -2
- package/dist/serialization/resources/commons/types/ConversationResponse.d.ts +3 -3
- package/dist/serialization/resources/commons/types/ConversationResponse.js +1 -1
- package/dist/serialization/resources/commons/types/ConversationSummary.d.ts +4 -2
- package/dist/serialization/resources/commons/types/ConversationSummary.js +2 -0
- package/dist/serialization/resources/commons/types/DeviceInfo.d.ts +2 -2
- package/dist/serialization/resources/commons/types/DeviceType.d.ts +2 -2
- package/dist/serialization/resources/commons/types/DocumentInformation.d.ts +2 -2
- package/dist/serialization/resources/commons/types/EntityId.d.ts +2 -2
- package/dist/serialization/resources/commons/types/EntityIdBase.d.ts +2 -2
- package/dist/serialization/resources/commons/types/EntityIdFilter.d.ts +2 -2
- package/dist/serialization/resources/commons/types/EntityIdWithoutAgent.d.ts +3 -3
- package/dist/serialization/resources/commons/types/EntityIdWithoutAgent.js +1 -1
- package/dist/serialization/resources/commons/types/EntityResult.d.ts +2 -2
- package/dist/serialization/resources/commons/types/EntityType.d.ts +2 -2
- package/dist/serialization/resources/commons/types/ErrorMessage.d.ts +2 -2
- package/dist/serialization/resources/commons/types/EventBaseNoId.d.ts +4 -4
- package/dist/serialization/resources/commons/types/EventBaseNoId.js +2 -2
- package/dist/serialization/resources/commons/types/EventField.d.ts +3 -3
- package/dist/serialization/resources/commons/types/EventField.js +18 -1
- package/dist/serialization/resources/commons/types/EventFilter.d.ts +5 -5
- package/dist/serialization/resources/commons/types/EventFilter.js +3 -3
- package/dist/serialization/resources/commons/types/EventRequest.d.ts +3 -3
- package/dist/serialization/resources/commons/types/EventRequest.js +1 -1
- package/dist/serialization/resources/commons/types/EventResponse.d.ts +3 -3
- package/dist/serialization/resources/commons/types/EventResponse.js +1 -1
- package/dist/serialization/resources/commons/types/EventType.d.ts +2 -2
- package/dist/serialization/resources/commons/types/EventUserInfo.d.ts +2 -2
- package/dist/serialization/resources/commons/types/EventUserInfoBase.d.ts +2 -2
- package/dist/serialization/resources/commons/types/EventsSearchRequest.d.ts +3 -3
- package/dist/serialization/resources/commons/types/EventsSearchRequest.js +1 -1
- package/dist/serialization/resources/commons/types/EventsSearchResponse.d.ts +2 -2
- package/dist/serialization/resources/commons/types/Feedback.d.ts +2 -2
- package/dist/serialization/resources/commons/types/FeedbackBase.d.ts +2 -2
- package/dist/serialization/resources/commons/types/FeedbackInfo.d.ts +2 -2
- package/dist/serialization/resources/commons/types/FeedbackType.d.ts +2 -2
- package/dist/serialization/resources/commons/types/GeoInfo.d.ts +2 -2
- package/dist/serialization/resources/commons/types/HarmfulContentAnalysis.d.ts +12 -0
- package/dist/serialization/resources/commons/types/HarmfulContentAnalysis.js +44 -0
- package/dist/serialization/resources/commons/types/InboxItem.d.ts +3 -3
- package/dist/serialization/resources/commons/types/InboxItem.js +1 -1
- package/dist/serialization/resources/commons/types/InboxItemBase.d.ts +3 -3
- package/dist/serialization/resources/commons/types/InboxItemBase.js +1 -1
- package/dist/serialization/resources/commons/types/InboxItemCustom.d.ts +2 -2
- package/dist/serialization/resources/commons/types/InboxItemDuplicateDocuments.d.ts +3 -3
- package/dist/serialization/resources/commons/types/InboxItemDuplicateDocuments.js +1 -1
- package/dist/serialization/resources/commons/types/InboxItemFix.d.ts +2 -2
- package/dist/serialization/resources/commons/types/InboxItemFixAddDocument.d.ts +2 -2
- package/dist/serialization/resources/commons/types/InboxItemFixBase.d.ts +2 -2
- package/dist/serialization/resources/commons/types/InboxItemFixDeactivateDocument.d.ts +2 -2
- package/dist/serialization/resources/commons/types/InboxItemMissingKnowledge.d.ts +3 -3
- package/dist/serialization/resources/commons/types/InboxItemMissingKnowledge.js +1 -1
- package/dist/serialization/resources/commons/types/InboxItemSeverity.d.ts +2 -2
- package/dist/serialization/resources/commons/types/InboxItemStatus.d.ts +2 -2
- package/dist/serialization/resources/commons/types/InboxItemType.d.ts +3 -3
- package/dist/serialization/resources/commons/types/InboxItemType.js +1 -1
- package/dist/serialization/resources/commons/types/IpInfo.d.ts +2 -2
- package/dist/serialization/resources/commons/types/KnowledgeContextByEntities.d.ts +10 -0
- package/dist/serialization/resources/commons/types/KnowledgeContextByEntities.js +42 -0
- package/dist/serialization/resources/commons/types/KnowledgeContextByEntityTypes.d.ts +10 -0
- package/dist/serialization/resources/commons/types/KnowledgeContextByEntityTypes.js +42 -0
- package/dist/serialization/resources/commons/types/KnowledgeContextFilter.d.ts +15 -0
- package/dist/serialization/resources/commons/types/KnowledgeContextFilter.js +49 -0
- package/dist/serialization/resources/commons/types/LanguageInfo.d.ts +2 -2
- package/dist/serialization/resources/commons/types/LlmInclusionStatus.d.ts +2 -2
- package/dist/serialization/resources/commons/types/LlmPersona.d.ts +2 -2
- package/dist/serialization/resources/commons/types/MessageStatus.d.ts +2 -2
- package/dist/serialization/resources/commons/types/MetadataPrecondition.d.ts +2 -2
- package/dist/serialization/resources/commons/types/NovelSystemEvent.d.ts +2 -2
- package/dist/serialization/resources/commons/types/NovelSystemEventNoId.d.ts +3 -3
- package/dist/serialization/resources/commons/types/NovelSystemEventNoId.js +1 -1
- package/dist/serialization/resources/commons/types/NovelUserEvent.d.ts +4 -4
- package/dist/serialization/resources/commons/types/NovelUserEvent.js +2 -2
- package/dist/serialization/resources/commons/types/NumberRange.d.ts +2 -2
- package/dist/serialization/resources/commons/types/OsInfo.d.ts +2 -2
- package/dist/serialization/resources/commons/types/OsType.d.ts +2 -2
- package/dist/serialization/resources/commons/types/Page.d.ts +2 -2
- package/dist/serialization/resources/commons/types/PageInfo.d.ts +2 -2
- package/dist/serialization/resources/{agents → commons}/types/PiiCategory.d.ts +2 -2
- package/dist/serialization/resources/commons/types/Precondition.d.ts +3 -3
- package/dist/serialization/resources/commons/types/Precondition.js +2 -2
- package/dist/serialization/resources/commons/types/PreconditionBase.d.ts +2 -2
- package/dist/serialization/resources/commons/types/PreconditionGroup.d.ts +2 -2
- package/dist/serialization/resources/commons/types/PreconditionGroup.js +1 -1
- package/dist/serialization/resources/commons/types/PreconditionGroupOperator.d.ts +2 -2
- package/dist/serialization/resources/commons/types/PreconditionOperator.d.ts +2 -2
- package/dist/serialization/resources/commons/types/Quality.d.ts +2 -2
- package/dist/serialization/resources/commons/types/QualityReason.d.ts +2 -2
- package/dist/serialization/resources/commons/types/ResponseConfig.d.ts +4 -2
- package/dist/serialization/resources/commons/types/ResponseConfig.js +2 -0
- package/dist/serialization/resources/commons/types/ResponseConfigPrecondition.d.ts +3 -3
- package/dist/serialization/resources/commons/types/ResponseConfigPrecondition.js +1 -1
- package/dist/serialization/resources/commons/types/ResponseLength.d.ts +2 -2
- package/dist/serialization/resources/commons/types/SafetyCheckReport.d.ts +12 -0
- package/dist/serialization/resources/commons/types/SafetyCheckReport.js +44 -0
- package/dist/serialization/resources/commons/types/ScopedEntity.d.ts +2 -2
- package/dist/serialization/resources/commons/types/Sentiment.d.ts +2 -2
- package/dist/serialization/resources/commons/types/SessionInfo.d.ts +2 -2
- package/dist/serialization/resources/commons/types/SimulationContext.d.ts +3 -3
- package/dist/serialization/resources/commons/types/SimulationContext.js +1 -1
- package/dist/serialization/resources/commons/types/Source.d.ts +2 -2
- package/dist/serialization/resources/commons/types/SourceInfo.d.ts +4 -4
- package/dist/serialization/resources/commons/types/SourceInfo.js +2 -2
- package/dist/serialization/resources/commons/types/SourceType.d.ts +2 -2
- package/dist/serialization/resources/commons/types/SurveyInfo.d.ts +2 -2
- package/dist/serialization/resources/commons/types/SystemEvent.d.ts +2 -2
- package/dist/serialization/resources/commons/types/SystemEventName.d.ts +2 -2
- package/dist/serialization/resources/commons/types/TagsPrecondition.d.ts +2 -2
- package/dist/serialization/resources/commons/types/UserConversationMessageType.d.ts +2 -2
- package/dist/serialization/resources/commons/types/UserData.d.ts +2 -2
- package/dist/serialization/resources/commons/types/UserDataWithReference.d.ts +2 -2
- package/dist/serialization/resources/commons/types/UserEvent.d.ts +4 -4
- package/dist/serialization/resources/commons/types/UserEvent.js +2 -2
- package/dist/serialization/resources/commons/types/UserEventName.d.ts +2 -2
- package/dist/serialization/resources/commons/types/UserMessage.d.ts +4 -4
- package/dist/serialization/resources/commons/types/UserMessage.js +2 -2
- package/dist/serialization/resources/commons/types/UserMessageBase.d.ts +3 -3
- package/dist/serialization/resources/commons/types/UserMessageBase.js +1 -1
- package/dist/serialization/resources/commons/types/UserMessageResponseState.d.ts +2 -2
- package/dist/serialization/resources/commons/types/VisibilityType.d.ts +2 -2
- package/dist/serialization/resources/commons/types/index.d.ts +118 -112
- package/dist/serialization/resources/commons/types/index.js +118 -112
- package/dist/serialization/resources/conversation/client/addConversationMetadata.d.ts +1 -1
- package/dist/serialization/resources/conversation/client/appendNewMessages.d.ts +2 -2
- package/dist/serialization/resources/conversation/client/index.d.ts +1 -1
- package/dist/serialization/resources/conversation/client/index.js +2 -2
- package/dist/serialization/resources/conversation/index.d.ts +1 -1
- package/dist/serialization/resources/conversation/index.js +1 -1
- package/dist/serialization/resources/conversation/types/ActionFormAttachment.d.ts +2 -2
- package/dist/serialization/resources/conversation/types/ActionFormRequestParamValue.d.ts +2 -2
- package/dist/serialization/resources/conversation/types/AskObjectRequest.d.ts +2 -2
- package/dist/serialization/resources/conversation/types/AskRequest.d.ts +3 -3
- package/dist/serialization/resources/conversation/types/AskRequest.js +1 -1
- package/dist/serialization/resources/conversation/types/AskStreamActionEvent.d.ts +2 -2
- package/dist/serialization/resources/conversation/types/AskStreamChartEvent.d.ts +2 -2
- package/dist/serialization/resources/conversation/types/AskStreamEndEvent.d.ts +2 -2
- package/dist/serialization/resources/conversation/types/AskStreamMetadataEvent.d.ts +2 -2
- package/dist/serialization/resources/conversation/types/AskStreamOAuthButtonEvent.d.ts +2 -2
- package/dist/serialization/resources/conversation/types/AskStreamStartEvent.d.ts +2 -2
- package/dist/serialization/resources/conversation/types/AskStreamTextEvent.d.ts +2 -2
- package/dist/serialization/resources/conversation/types/CategorizationResponse.d.ts +2 -2
- package/dist/serialization/resources/conversation/types/ConversationField.d.ts +3 -3
- package/dist/serialization/resources/conversation/types/ConversationField.js +2 -0
- package/dist/serialization/resources/conversation/types/ConversationFilter.d.ts +3 -3
- package/dist/serialization/resources/conversation/types/ConversationFilter.js +1 -1
- package/dist/serialization/resources/conversation/types/ConversationMessageRequest.d.ts +3 -3
- package/dist/serialization/resources/conversation/types/ConversationMessageRequest.js +1 -1
- package/dist/serialization/resources/conversation/types/ConversationMetadata.d.ts +2 -2
- package/dist/serialization/resources/conversation/types/ConversationPatchRequest.d.ts +2 -2
- package/dist/serialization/resources/conversation/types/ConversationRequest.d.ts +3 -3
- package/dist/serialization/resources/conversation/types/ConversationRequest.js +1 -1
- package/dist/serialization/resources/conversation/types/ConversationsResponse.d.ts +2 -2
- package/dist/serialization/resources/conversation/types/ConversationsSearchRequest.d.ts +3 -3
- package/dist/serialization/resources/conversation/types/ConversationsSearchRequest.js +1 -1
- package/dist/serialization/resources/conversation/types/DeliverConversationMessageRequest.d.ts +2 -2
- package/dist/serialization/resources/conversation/types/DeliverMessageRequest.d.ts +3 -3
- package/dist/serialization/resources/conversation/types/DeliverMessageRequest.js +1 -1
- package/dist/serialization/resources/conversation/types/DeliverMessageResponse.d.ts +2 -2
- package/dist/serialization/resources/conversation/types/DeliverUserMessageRequest.d.ts +2 -2
- package/dist/serialization/resources/conversation/types/DeliveryStatus.d.ts +2 -2
- package/dist/serialization/resources/conversation/types/FeedbackField.d.ts +2 -2
- package/dist/serialization/resources/conversation/types/FeedbackFilter.d.ts +2 -2
- package/dist/serialization/resources/conversation/types/FeedbackRequest.d.ts +2 -2
- package/dist/serialization/resources/conversation/types/NumericConversationField.d.ts +3 -3
- package/dist/serialization/resources/conversation/types/NumericConversationField.js +1 -0
- package/dist/serialization/resources/conversation/types/ObjectStreamResponse.d.ts +4 -4
- package/dist/serialization/resources/conversation/types/ObjectStreamResponse.js +2 -2
- package/dist/serialization/resources/conversation/types/ResolutionStatus.d.ts +2 -2
- package/dist/serialization/resources/conversation/types/SimulationFilter.d.ts +2 -2
- package/dist/serialization/resources/conversation/types/StreamResponse.d.ts +5 -5
- package/dist/serialization/resources/conversation/types/StreamResponse.js +3 -3
- package/dist/serialization/resources/conversation/types/SubmitActionFormRequest.d.ts +2 -2
- package/dist/serialization/resources/conversation/types/UpdateMetadataRequest.d.ts +2 -2
- package/dist/serialization/resources/conversation/types/index.d.ts +21 -21
- package/dist/serialization/resources/conversation/types/index.js +21 -21
- package/dist/serialization/resources/customers/index.d.ts +1 -0
- package/dist/serialization/resources/customers/index.js +17 -0
- package/dist/serialization/resources/customers/types/CustomerBase.d.ts +13 -0
- package/dist/serialization/resources/customers/types/CustomerBase.js +45 -0
- package/dist/serialization/resources/customers/types/CustomerField.d.ts +7 -0
- package/dist/serialization/resources/customers/types/CustomerField.js +39 -0
- package/dist/serialization/resources/customers/types/CustomerFilter.d.ts +13 -0
- package/dist/serialization/resources/customers/types/CustomerFilter.js +45 -0
- package/dist/serialization/resources/customers/types/CustomerPatchRequest.d.ts +16 -0
- package/dist/serialization/resources/customers/types/CustomerPatchRequest.js +48 -0
- package/dist/serialization/resources/customers/types/CustomerRequest.d.ts +11 -0
- package/dist/serialization/resources/customers/types/CustomerRequest.js +43 -0
- package/dist/serialization/resources/customers/types/CustomerResponse.d.ts +13 -0
- package/dist/serialization/resources/customers/types/CustomerResponse.js +47 -0
- package/dist/serialization/resources/customers/types/CustomerStatus.d.ts +7 -0
- package/dist/serialization/resources/customers/types/CustomerStatus.js +39 -0
- package/dist/serialization/resources/customers/types/CustomersSearchRequest.d.ts +13 -0
- package/dist/serialization/resources/customers/types/CustomersSearchRequest.js +47 -0
- package/dist/serialization/resources/customers/types/CustomersSearchResponse.d.ts +11 -0
- package/dist/serialization/resources/customers/types/CustomersSearchResponse.js +45 -0
- package/dist/serialization/resources/customers/types/index.d.ts +9 -0
- package/dist/serialization/resources/customers/types/index.js +25 -0
- package/dist/serialization/resources/inbox/types/AddDocumentFixRequest.d.ts +2 -2
- package/dist/serialization/resources/inbox/types/ApplyFixesRequest.d.ts +2 -2
- package/dist/serialization/resources/inbox/types/InboxFilter.d.ts +2 -2
- package/dist/serialization/resources/inbox/types/InboxSearchRequest.d.ts +3 -3
- package/dist/serialization/resources/inbox/types/InboxSearchRequest.js +1 -1
- package/dist/serialization/resources/inbox/types/InboxSearchResponse.d.ts +2 -2
- package/dist/serialization/resources/inbox/types/index.d.ts +2 -2
- package/dist/serialization/resources/inbox/types/index.js +2 -2
- package/dist/serialization/resources/index.d.ts +5 -3
- package/dist/serialization/resources/index.js +6 -4
- package/dist/serialization/resources/knowledge/client/requests/KnowledgeBasePatchRequest.d.ts +3 -3
- package/dist/serialization/resources/knowledge/client/requests/KnowledgeBasePatchRequest.js +2 -2
- package/dist/serialization/resources/knowledge/client/requests/KnowledgeDocumentPatchRequest.d.ts +2 -2
- package/dist/serialization/resources/knowledge/index.d.ts +1 -1
- package/dist/serialization/resources/knowledge/index.js +1 -1
- package/dist/serialization/resources/knowledge/types/BaseKnowledgeDocument.d.ts +2 -2
- package/dist/serialization/resources/knowledge/types/FinalizeKnowledgeBaseVersionRequest.d.ts +2 -2
- package/dist/serialization/resources/knowledge/types/KnowledgeBaseField.d.ts +2 -2
- package/dist/serialization/resources/knowledge/types/KnowledgeBaseFilter.d.ts +3 -3
- package/dist/serialization/resources/knowledge/types/KnowledgeBaseFilter.js +1 -1
- package/dist/serialization/resources/knowledge/types/KnowledgeBaseProperties.d.ts +2 -2
- package/dist/serialization/resources/knowledge/types/KnowledgeBaseProperties.js +1 -1
- package/dist/serialization/resources/knowledge/types/KnowledgeBaseRefreshFrequency.d.ts +2 -2
- package/dist/serialization/resources/knowledge/types/KnowledgeBaseRefreshRequest.d.ts +2 -2
- package/dist/serialization/resources/knowledge/types/KnowledgeBaseRequest.d.ts +2 -2
- package/dist/serialization/resources/knowledge/types/KnowledgeBaseResponse.d.ts +5 -5
- package/dist/serialization/resources/knowledge/types/KnowledgeBaseResponse.js +3 -3
- package/dist/serialization/resources/knowledge/types/KnowledgeBaseSearchRequest.d.ts +3 -3
- package/dist/serialization/resources/knowledge/types/KnowledgeBaseSearchRequest.js +1 -1
- package/dist/serialization/resources/knowledge/types/KnowledgeBaseType.d.ts +2 -2
- package/dist/serialization/resources/knowledge/types/KnowledgeBaseVersion.d.ts +3 -3
- package/dist/serialization/resources/knowledge/types/KnowledgeBaseVersion.js +1 -1
- package/dist/serialization/resources/knowledge/types/KnowledgeBaseVersionFinalizeStatus.d.ts +2 -2
- package/dist/serialization/resources/knowledge/types/KnowledgeBaseVersionRequest.d.ts +2 -2
- package/dist/serialization/resources/knowledge/types/KnowledgeBaseVersionStatus.d.ts +2 -2
- package/dist/serialization/resources/knowledge/types/KnowledgeBaseVersionType.d.ts +2 -2
- package/dist/serialization/resources/knowledge/types/KnowledgeBaseVersionsListResponse.d.ts +2 -2
- package/dist/serialization/resources/knowledge/types/KnowledgeBasesResponse.d.ts +3 -3
- package/dist/serialization/resources/knowledge/types/KnowledgeBasesResponse.js +1 -1
- package/dist/serialization/resources/knowledge/types/KnowledgeDeleteRequest.d.ts +2 -2
- package/dist/serialization/resources/knowledge/types/KnowledgeDocumentContentType.d.ts +2 -2
- package/dist/serialization/resources/knowledge/types/KnowledgeDocumentField.d.ts +2 -2
- package/dist/serialization/resources/knowledge/types/KnowledgeDocumentFilter.d.ts +2 -2
- package/dist/serialization/resources/knowledge/types/KnowledgeDocumentRequest.d.ts +5 -3
- package/dist/serialization/resources/knowledge/types/KnowledgeDocumentRequest.js +3 -1
- package/dist/serialization/resources/knowledge/types/KnowledgeDocumentResponse.d.ts +5 -3
- package/dist/serialization/resources/knowledge/types/KnowledgeDocumentResponse.js +3 -1
- package/dist/serialization/resources/knowledge/types/KnowledgeDocumentSearchRequest.d.ts +3 -3
- package/dist/serialization/resources/knowledge/types/KnowledgeDocumentSearchRequest.js +1 -1
- package/dist/serialization/resources/knowledge/types/KnowledgeDocumentSearchResponse.d.ts +2 -2
- package/dist/serialization/resources/knowledge/types/KnowledgeDocumentStatus.d.ts +2 -2
- package/dist/serialization/resources/knowledge/types/KnowledgeDocumentsResponse.d.ts +3 -3
- package/dist/serialization/resources/knowledge/types/KnowledgeDocumentsResponse.js +1 -1
- package/dist/serialization/resources/knowledge/types/index.d.ts +16 -16
- package/dist/serialization/resources/knowledge/types/index.js +16 -16
- package/dist/serialization/resources/organizations/types/BaseOrganization.d.ts +2 -2
- package/dist/serialization/resources/organizations/types/CreateOrganizationRequest.d.ts +2 -2
- package/dist/serialization/resources/organizations/types/Organization.d.ts +2 -2
- package/dist/serialization/resources/organizations/types/OrganizationPatchRequest.d.ts +2 -2
- package/dist/serialization/resources/organizations/types/index.d.ts +1 -1
- package/dist/serialization/resources/organizations/types/index.js +1 -1
- package/dist/serialization/resources/segments/types/SegmentBase.d.ts +2 -2
- package/dist/serialization/resources/segments/types/SegmentBase.js +1 -1
- package/dist/serialization/resources/segments/types/SegmentField.d.ts +2 -2
- package/dist/serialization/resources/segments/types/SegmentPatchRequest.d.ts +2 -2
- package/dist/serialization/resources/segments/types/SegmentPatchRequest.js +1 -1
- package/dist/serialization/resources/segments/types/SegmentRequest.d.ts +2 -2
- package/dist/serialization/resources/segments/types/SegmentResponse.d.ts +3 -3
- package/dist/serialization/resources/segments/types/SegmentResponse.js +1 -1
- package/dist/serialization/resources/segments/types/SegmentStatus.d.ts +2 -2
- package/dist/serialization/resources/segments/types/SegmentsSearchRequest.d.ts +3 -3
- package/dist/serialization/resources/segments/types/SegmentsSearchRequest.js +1 -1
- package/dist/serialization/resources/segments/types/SegmentsSearchResponse.d.ts +3 -3
- package/dist/serialization/resources/segments/types/SegmentsSearchResponse.js +1 -1
- package/dist/serialization/resources/segments/types/index.d.ts +4 -4
- package/dist/serialization/resources/segments/types/index.js +4 -4
- package/dist/serialization/resources/translations/types/TranslationRequest.d.ts +2 -2
- package/dist/serialization/resources/translations/types/TranslationResponse.d.ts +2 -2
- package/dist/serialization/resources/triggers/types/EventTriggerBase.d.ts +2 -2
- package/dist/serialization/resources/triggers/types/EventTriggerRequest.d.ts +2 -2
- package/dist/serialization/resources/triggers/types/EventTriggerResponse.d.ts +2 -2
- package/dist/serialization/resources/triggers/types/EventTriggerType.d.ts +2 -2
- package/dist/serialization/resources/triggers/types/EventTriggersSearchRequest.d.ts +3 -3
- package/dist/serialization/resources/triggers/types/EventTriggersSearchRequest.js +1 -1
- package/dist/serialization/resources/triggers/types/EventTriggersSearchResponse.d.ts +3 -3
- package/dist/serialization/resources/triggers/types/EventTriggersSearchResponse.js +1 -1
- package/dist/serialization/resources/triggers/types/TriggerField.d.ts +2 -2
- package/dist/serialization/resources/triggers/types/TriggerPartialUpdate.d.ts +2 -2
- package/dist/serialization/resources/triggers/types/index.d.ts +3 -3
- package/dist/serialization/resources/triggers/types/index.js +3 -3
- package/dist/serialization/resources/users/types/AgentUser.d.ts +2 -2
- package/dist/serialization/resources/users/types/AgentUserField.d.ts +2 -2
- package/dist/serialization/resources/users/types/AgentUserFilter.d.ts +2 -2
- package/dist/serialization/resources/users/types/AgentUserSearchRequest.d.ts +3 -3
- package/dist/serialization/resources/users/types/AgentUserSearchRequest.js +1 -1
- package/dist/serialization/resources/users/types/AgentUserSearchResponse.d.ts +3 -3
- package/dist/serialization/resources/users/types/AgentUserSearchResponse.js +1 -1
- package/dist/serialization/resources/users/types/AppUserSummary.d.ts +3 -3
- package/dist/serialization/resources/users/types/AppUserSummary.js +1 -1
- package/dist/serialization/resources/users/types/index.d.ts +1 -1
- package/dist/serialization/resources/users/types/index.js +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/errors/MavenAGIError.d.ts +1 -1
- package/errors/MavenAGIError.js +1 -1
- package/index.d.ts +3 -2
- package/index.js +5 -5
- package/package.json +9 -4
- package/pnpm-workspace.yaml +1 -1
- package/reference.md +1206 -839
- package/serialization/resources/actions/client/requests/ActionPatchRequest.d.ts +3 -3
- package/serialization/resources/actions/client/requests/ActionPatchRequest.js +1 -1
- package/serialization/resources/actions/index.d.ts +1 -1
- package/serialization/resources/actions/index.js +1 -1
- package/serialization/resources/actions/types/ActionField.d.ts +2 -2
- package/serialization/resources/actions/types/ActionFilter.d.ts +2 -2
- package/serialization/resources/actions/types/ActionRequest.d.ts +3 -3
- package/serialization/resources/actions/types/ActionRequest.js +1 -1
- package/serialization/resources/actions/types/ActionsResponse.d.ts +2 -2
- package/serialization/resources/actions/types/ActionsSearchRequest.d.ts +3 -3
- package/serialization/resources/actions/types/ActionsSearchRequest.js +1 -1
- package/serialization/resources/actions/types/index.d.ts +2 -2
- package/serialization/resources/actions/types/index.js +2 -2
- package/serialization/resources/agents/client/list.d.ts +2 -2
- package/serialization/resources/agents/client/requests/AgentPatchRequest.d.ts +4 -4
- package/serialization/resources/agents/client/requests/AgentPatchRequest.js +2 -2
- package/serialization/resources/agents/index.d.ts +1 -1
- package/serialization/resources/agents/index.js +1 -1
- package/serialization/resources/agents/types/Agent.d.ts +3 -3
- package/serialization/resources/agents/types/Agent.js +1 -1
- package/serialization/resources/agents/types/AgentEnvironment.d.ts +2 -2
- package/serialization/resources/agents/types/AgentField.d.ts +2 -2
- package/serialization/resources/agents/types/AgentFilter.d.ts +2 -2
- package/serialization/resources/agents/types/AgentPrompting.d.ts +2 -2
- package/serialization/resources/agents/types/AgentsSearchRequest.d.ts +3 -3
- package/serialization/resources/agents/types/AgentsSearchRequest.js +1 -1
- package/serialization/resources/agents/types/AgentsSearchResponse.d.ts +3 -3
- package/serialization/resources/agents/types/AgentsSearchResponse.js +1 -1
- package/serialization/resources/agents/types/CreateAgentRequest.d.ts +2 -2
- package/serialization/resources/agents/types/index.d.ts +4 -5
- package/serialization/resources/agents/types/index.js +4 -5
- package/serialization/resources/analytics/types/AgentUserAnalyticsRequest.d.ts +2 -2
- package/serialization/resources/analytics/types/AgentUserColumnDefinition.d.ts +2 -2
- package/serialization/resources/analytics/types/AgentUserCount.d.ts +3 -4
- package/serialization/resources/analytics/types/AgentUserMetric.d.ts +2 -2
- package/serialization/resources/analytics/types/AgentUserRow.d.ts +3 -3
- package/serialization/resources/analytics/types/AgentUserRow.js +1 -1
- package/serialization/resources/analytics/types/AgentUserTableRequest.d.ts +4 -4
- package/serialization/resources/analytics/types/AgentUserTableRequest.js +2 -2
- package/serialization/resources/analytics/types/AgentUserTableResponse.d.ts +2 -2
- package/serialization/resources/analytics/types/BarChartResponse.d.ts +2 -2
- package/serialization/resources/analytics/types/CellData.d.ts +2 -2
- package/serialization/resources/analytics/types/ChartResponse.d.ts +4 -4
- package/serialization/resources/analytics/types/ChartResponse.js +2 -2
- package/serialization/resources/analytics/types/ColumnDefinitionBase.d.ts +2 -2
- package/serialization/resources/analytics/types/ConversationAnalyticsRequest.d.ts +2 -2
- package/serialization/resources/analytics/types/ConversationAverage.d.ts +2 -2
- package/serialization/resources/analytics/types/ConversationBarChartRequest.d.ts +3 -3
- package/serialization/resources/analytics/types/ConversationBarChartRequest.js +1 -1
- package/serialization/resources/analytics/types/ConversationBasicMetric.d.ts +2 -2
- package/serialization/resources/analytics/types/ConversationChartRequest.d.ts +4 -4
- package/serialization/resources/analytics/types/ConversationChartRequest.js +2 -2
- package/serialization/resources/analytics/types/ConversationColumnDefinition.d.ts +3 -3
- package/serialization/resources/analytics/types/ConversationColumnDefinition.js +1 -1
- package/serialization/resources/analytics/types/ConversationCount.d.ts +3 -4
- package/serialization/resources/analytics/types/ConversationDateHistogramRequest.d.ts +4 -4
- package/serialization/resources/analytics/types/ConversationDateHistogramRequest.js +2 -2
- package/serialization/resources/analytics/types/ConversationDistinctCount.d.ts +2 -2
- package/serialization/resources/analytics/types/ConversationGroupBy.d.ts +3 -3
- package/serialization/resources/analytics/types/ConversationGroupBy.js +1 -1
- package/serialization/resources/analytics/types/ConversationMax.d.ts +2 -2
- package/serialization/resources/analytics/types/ConversationMedian.d.ts +2 -2
- package/serialization/resources/analytics/types/ConversationMetric.d.ts +7 -7
- package/serialization/resources/analytics/types/ConversationMetric.js +5 -5
- package/serialization/resources/analytics/types/ConversationMin.d.ts +2 -2
- package/serialization/resources/analytics/types/ConversationNumericMetric.d.ts +2 -2
- package/serialization/resources/analytics/types/ConversationPercentile.d.ts +2 -2
- package/serialization/resources/analytics/types/ConversationPieChartRequest.d.ts +3 -3
- package/serialization/resources/analytics/types/ConversationPieChartRequest.js +1 -1
- package/serialization/resources/analytics/types/ConversationRow.d.ts +3 -3
- package/serialization/resources/analytics/types/ConversationRow.js +1 -1
- package/serialization/resources/analytics/types/ConversationSum.d.ts +2 -2
- package/serialization/resources/analytics/types/ConversationTableRequest.d.ts +5 -5
- package/serialization/resources/analytics/types/ConversationTableRequest.js +3 -3
- package/serialization/resources/analytics/types/ConversationTableResponse.d.ts +2 -2
- package/serialization/resources/analytics/types/DateHistogramResponse.d.ts +2 -2
- package/serialization/resources/analytics/types/EventAnalyticsRequest.d.ts +11 -0
- package/serialization/resources/analytics/types/EventAnalyticsRequest.js +43 -0
- package/serialization/resources/analytics/types/EventBarChartRequest.d.ts +14 -0
- package/serialization/resources/analytics/types/EventBarChartRequest.js +48 -0
- package/serialization/resources/analytics/types/EventChartRequest.d.ts +19 -0
- package/serialization/resources/analytics/types/EventChartRequest.js +51 -0
- package/serialization/resources/analytics/types/EventColumnDefinition.d.ts +11 -0
- package/serialization/resources/analytics/types/EventColumnDefinition.js +45 -0
- package/serialization/resources/analytics/types/EventCount.d.ts +7 -0
- package/serialization/resources/analytics/types/EventCount.js +39 -0
- package/serialization/resources/analytics/types/EventDateHistogramRequest.d.ts +15 -0
- package/serialization/resources/analytics/types/EventDateHistogramRequest.js +49 -0
- package/serialization/resources/analytics/types/EventDistinctCount.d.ts +10 -0
- package/serialization/resources/analytics/types/EventDistinctCount.js +42 -0
- package/serialization/resources/analytics/types/EventGroupBy.d.ts +11 -0
- package/serialization/resources/analytics/types/EventGroupBy.js +45 -0
- package/serialization/resources/analytics/types/EventMetric.d.ts +15 -0
- package/serialization/resources/analytics/types/EventMetric.js +49 -0
- package/serialization/resources/analytics/types/EventPieChartRequest.d.ts +13 -0
- package/serialization/resources/analytics/types/EventPieChartRequest.js +47 -0
- package/serialization/resources/analytics/types/EventRow.d.ts +12 -0
- package/serialization/resources/analytics/types/EventRow.js +46 -0
- package/serialization/resources/analytics/types/EventTableRequest.d.ts +15 -0
- package/serialization/resources/analytics/types/EventTableRequest.js +49 -0
- package/serialization/resources/analytics/types/EventTableResponse.d.ts +11 -0
- package/serialization/resources/analytics/types/EventTableResponse.js +45 -0
- package/serialization/resources/analytics/types/FeedbackAnalyticsRequest.d.ts +2 -2
- package/serialization/resources/analytics/types/FeedbackColumnDefinition.d.ts +3 -3
- package/serialization/resources/analytics/types/FeedbackColumnDefinition.js +1 -1
- package/serialization/resources/analytics/types/FeedbackCount.d.ts +3 -4
- package/serialization/resources/analytics/types/FeedbackDistinctCount.d.ts +2 -2
- package/serialization/resources/analytics/types/FeedbackGroupBy.d.ts +2 -2
- package/serialization/resources/analytics/types/FeedbackMetric.d.ts +2 -2
- package/serialization/resources/analytics/types/FeedbackRow.d.ts +3 -3
- package/serialization/resources/analytics/types/FeedbackRow.js +1 -1
- package/serialization/resources/analytics/types/FeedbackTableRequest.d.ts +5 -5
- package/serialization/resources/analytics/types/FeedbackTableRequest.js +3 -3
- package/serialization/resources/analytics/types/FeedbackTableResponse.d.ts +2 -2
- package/serialization/resources/analytics/types/FieldValue.d.ts +3 -3
- package/serialization/resources/analytics/types/FieldValue.js +1 -1
- package/serialization/resources/analytics/types/GroupByBase.d.ts +2 -2
- package/serialization/resources/analytics/types/LabeledPoint.d.ts +2 -2
- package/serialization/resources/analytics/types/PieChartResponse.d.ts +2 -2
- package/serialization/resources/analytics/types/Range.d.ts +2 -2
- package/serialization/resources/analytics/types/RowBase.d.ts +2 -2
- package/serialization/resources/analytics/types/Series.d.ts +2 -2
- package/serialization/resources/analytics/types/TableResponseBase.d.ts +2 -2
- package/serialization/resources/analytics/types/TimeDataPoint.d.ts +2 -2
- package/serialization/resources/analytics/types/TimeInterval.d.ts +2 -2
- package/serialization/resources/analytics/types/TimeSeries.d.ts +2 -2
- package/serialization/resources/analytics/types/index.d.ts +49 -36
- package/serialization/resources/analytics/types/index.js +49 -36
- package/serialization/resources/appSettings/client/get.d.ts +1 -1
- package/serialization/resources/appSettings/client/update.d.ts +1 -1
- package/serialization/resources/appSettings/index.d.ts +1 -1
- package/serialization/resources/appSettings/index.js +1 -1
- package/serialization/resources/appSettings/types/AppSettings.d.ts +2 -2
- package/serialization/resources/appSettings/types/SearchAppSettingsResponse.d.ts +2 -2
- package/serialization/resources/appSettings/types/index.d.ts +1 -1
- package/serialization/resources/appSettings/types/index.js +1 -1
- package/serialization/resources/assets/types/CommitAssetUploadRequest.d.ts +2 -2
- package/serialization/resources/assets/types/InitiateAssetUploadRequest.d.ts +2 -2
- package/serialization/resources/assets/types/InitiateAssetUploadResponse.d.ts +2 -2
- package/serialization/resources/assets/types/index.d.ts +1 -1
- package/serialization/resources/assets/types/index.js +1 -1
- package/serialization/resources/commons/types/ActionBase.d.ts +2 -2
- package/serialization/resources/commons/types/ActionBase.js +1 -1
- package/serialization/resources/commons/types/ActionEnumOption.d.ts +2 -2
- package/serialization/resources/commons/types/ActionExecutionParamValue.d.ts +2 -2
- package/serialization/resources/commons/types/ActionFormField.d.ts +3 -3
- package/serialization/resources/commons/types/ActionFormField.js +1 -1
- package/serialization/resources/commons/types/ActionOAuthConfiguration.d.ts +2 -2
- package/serialization/resources/commons/types/ActionParameter.d.ts +3 -3
- package/serialization/resources/commons/types/ActionParameter.js +1 -1
- package/serialization/resources/commons/types/ActionParameterType.d.ts +2 -2
- package/serialization/resources/commons/types/ActionResponse.d.ts +3 -3
- package/serialization/resources/commons/types/ActionResponse.js +1 -1
- package/serialization/resources/commons/types/AppPrecondition.d.ts +2 -2
- package/serialization/resources/commons/types/AppUser.d.ts +2 -2
- package/serialization/resources/commons/types/AppUserIdentifier.d.ts +2 -2
- package/serialization/resources/commons/types/AppUserIdentifyingPropertyType.d.ts +2 -2
- package/serialization/resources/commons/types/AppUserRequest.d.ts +3 -3
- package/serialization/resources/commons/types/AppUserRequest.js +1 -1
- package/serialization/resources/commons/types/AppUserResponse.d.ts +3 -3
- package/serialization/resources/commons/types/AppUserResponse.js +1 -1
- package/serialization/resources/commons/types/AttachmentRequest.d.ts +3 -3
- package/serialization/resources/commons/types/AttachmentRequest.js +1 -1
- package/serialization/resources/commons/types/AttachmentResponse.d.ts +2 -2
- package/serialization/resources/commons/types/AttachmentStatus.d.ts +2 -2
- package/serialization/resources/commons/types/BaseAttachment.d.ts +2 -2
- package/serialization/resources/commons/types/BaseConversationResponse.d.ts +4 -4
- package/serialization/resources/commons/types/BaseConversationResponse.js +2 -2
- package/serialization/resources/commons/types/BasePaginatedRequest.d.ts +2 -2
- package/serialization/resources/commons/types/BaseSearchRequest.d.ts +2 -2
- package/serialization/resources/commons/types/BotActionFormResponse.d.ts +3 -3
- package/serialization/resources/commons/types/BotActionFormResponse.js +1 -1
- package/serialization/resources/commons/types/BotChartResponse.d.ts +2 -2
- package/serialization/resources/commons/types/BotConversationMessageType.d.ts +2 -2
- package/serialization/resources/commons/types/BotLogic.d.ts +2 -2
- package/serialization/resources/commons/types/BotLogicActionExecutedDetail.d.ts +2 -2
- package/serialization/resources/commons/types/BotLogicActionItem.d.ts +3 -3
- package/serialization/resources/commons/types/BotLogicActionItem.js +1 -1
- package/serialization/resources/commons/types/BotLogicActionReviewedDetail.d.ts +2 -2
- package/serialization/resources/commons/types/BotLogicFormSubmissionItem.d.ts +2 -2
- package/serialization/resources/commons/types/BotLogicItem.d.ts +4 -4
- package/serialization/resources/commons/types/BotLogicItem.js +2 -2
- package/serialization/resources/commons/types/BotLogicKnowledgeDetail.d.ts +2 -2
- package/serialization/resources/commons/types/BotLogicKnowledgeItem.d.ts +2 -2
- package/serialization/resources/commons/types/BotLogicSafetyItem.d.ts +4 -2
- package/serialization/resources/commons/types/BotLogicSafetyItem.js +2 -0
- package/serialization/resources/commons/types/BotLogicSegmentsItem.d.ts +2 -2
- package/serialization/resources/commons/types/BotLogicUserItem.d.ts +2 -2
- package/serialization/resources/commons/types/BotMessage.d.ts +5 -5
- package/serialization/resources/commons/types/BotMessage.js +3 -3
- package/serialization/resources/commons/types/BotOAuthButtonResponse.d.ts +2 -2
- package/serialization/resources/commons/types/BotObjectResponse.d.ts +2 -2
- package/serialization/resources/commons/types/BotResponse.d.ts +4 -4
- package/serialization/resources/commons/types/BotResponse.js +2 -2
- package/serialization/resources/commons/types/BotResponseMetadata.d.ts +2 -2
- package/serialization/resources/commons/types/BotTextResponse.d.ts +2 -2
- package/serialization/resources/commons/types/BrowserInfo.d.ts +2 -2
- package/serialization/resources/commons/types/BrowserType.d.ts +2 -2
- package/serialization/resources/commons/types/Capability.d.ts +2 -2
- package/serialization/resources/commons/types/ChartSpecSchema.d.ts +2 -2
- package/serialization/resources/commons/types/ContextInfo.d.ts +2 -2
- package/serialization/resources/commons/types/ConversationAnalysis.d.ts +3 -3
- package/serialization/resources/commons/types/ConversationAnalysis.js +1 -1
- package/serialization/resources/commons/types/ConversationExecutedActionPrecondition.d.ts +2 -2
- package/serialization/resources/commons/types/ConversationInformation.d.ts +2 -2
- package/serialization/resources/commons/types/ConversationMessageBase.d.ts +2 -2
- package/serialization/resources/commons/types/ConversationMessageResponse.d.ts +3 -3
- package/serialization/resources/commons/types/ConversationMessageResponse.js +1 -1
- package/serialization/resources/commons/types/ConversationPrecondition.d.ts +5 -5
- package/serialization/resources/commons/types/ConversationPrecondition.js +3 -3
- package/serialization/resources/commons/types/ConversationPreview.d.ts +2 -2
- package/serialization/resources/commons/types/ConversationResponse.d.ts +3 -3
- package/serialization/resources/commons/types/ConversationResponse.js +1 -1
- package/serialization/resources/commons/types/ConversationSummary.d.ts +4 -2
- package/serialization/resources/commons/types/ConversationSummary.js +2 -0
- package/serialization/resources/commons/types/DeviceInfo.d.ts +2 -2
- package/serialization/resources/commons/types/DeviceType.d.ts +2 -2
- package/serialization/resources/commons/types/DocumentInformation.d.ts +2 -2
- package/serialization/resources/commons/types/EntityId.d.ts +2 -2
- package/serialization/resources/commons/types/EntityIdBase.d.ts +2 -2
- package/serialization/resources/commons/types/EntityIdFilter.d.ts +2 -2
- package/serialization/resources/commons/types/EntityIdWithoutAgent.d.ts +3 -3
- package/serialization/resources/commons/types/EntityIdWithoutAgent.js +1 -1
- package/serialization/resources/commons/types/EntityResult.d.ts +2 -2
- package/serialization/resources/commons/types/EntityType.d.ts +2 -2
- package/serialization/resources/commons/types/ErrorMessage.d.ts +2 -2
- package/serialization/resources/commons/types/EventBaseNoId.d.ts +4 -4
- package/serialization/resources/commons/types/EventBaseNoId.js +2 -2
- package/serialization/resources/commons/types/EventField.d.ts +3 -3
- package/serialization/resources/commons/types/EventField.js +18 -1
- package/serialization/resources/commons/types/EventFilter.d.ts +5 -5
- package/serialization/resources/commons/types/EventFilter.js +3 -3
- package/serialization/resources/commons/types/EventRequest.d.ts +3 -3
- package/serialization/resources/commons/types/EventRequest.js +1 -1
- package/serialization/resources/commons/types/EventResponse.d.ts +3 -3
- package/serialization/resources/commons/types/EventResponse.js +1 -1
- package/serialization/resources/commons/types/EventType.d.ts +2 -2
- package/serialization/resources/commons/types/EventUserInfo.d.ts +2 -2
- package/serialization/resources/commons/types/EventUserInfoBase.d.ts +2 -2
- package/serialization/resources/commons/types/EventsSearchRequest.d.ts +3 -3
- package/serialization/resources/commons/types/EventsSearchRequest.js +1 -1
- package/serialization/resources/commons/types/EventsSearchResponse.d.ts +2 -2
- package/serialization/resources/commons/types/Feedback.d.ts +2 -2
- package/serialization/resources/commons/types/FeedbackBase.d.ts +2 -2
- package/serialization/resources/commons/types/FeedbackInfo.d.ts +2 -2
- package/serialization/resources/commons/types/FeedbackType.d.ts +2 -2
- package/serialization/resources/commons/types/GeoInfo.d.ts +2 -2
- package/serialization/resources/commons/types/HarmfulContentAnalysis.d.ts +12 -0
- package/serialization/resources/commons/types/HarmfulContentAnalysis.js +44 -0
- package/serialization/resources/commons/types/InboxItem.d.ts +3 -3
- package/serialization/resources/commons/types/InboxItem.js +1 -1
- package/serialization/resources/commons/types/InboxItemBase.d.ts +3 -3
- package/serialization/resources/commons/types/InboxItemBase.js +1 -1
- package/serialization/resources/commons/types/InboxItemCustom.d.ts +2 -2
- package/serialization/resources/commons/types/InboxItemDuplicateDocuments.d.ts +3 -3
- package/serialization/resources/commons/types/InboxItemDuplicateDocuments.js +1 -1
- package/serialization/resources/commons/types/InboxItemFix.d.ts +2 -2
- package/serialization/resources/commons/types/InboxItemFixAddDocument.d.ts +2 -2
- package/serialization/resources/commons/types/InboxItemFixBase.d.ts +2 -2
- package/serialization/resources/commons/types/InboxItemFixDeactivateDocument.d.ts +2 -2
- package/serialization/resources/commons/types/InboxItemMissingKnowledge.d.ts +3 -3
- package/serialization/resources/commons/types/InboxItemMissingKnowledge.js +1 -1
- package/serialization/resources/commons/types/InboxItemSeverity.d.ts +2 -2
- package/serialization/resources/commons/types/InboxItemStatus.d.ts +2 -2
- package/serialization/resources/commons/types/InboxItemType.d.ts +3 -3
- package/serialization/resources/commons/types/InboxItemType.js +1 -1
- package/serialization/resources/commons/types/IpInfo.d.ts +2 -2
- package/serialization/resources/commons/types/KnowledgeContextByEntities.d.ts +10 -0
- package/serialization/resources/commons/types/KnowledgeContextByEntities.js +42 -0
- package/serialization/resources/commons/types/KnowledgeContextByEntityTypes.d.ts +10 -0
- package/serialization/resources/commons/types/KnowledgeContextByEntityTypes.js +42 -0
- package/serialization/resources/commons/types/KnowledgeContextFilter.d.ts +15 -0
- package/serialization/resources/commons/types/KnowledgeContextFilter.js +49 -0
- package/serialization/resources/commons/types/LanguageInfo.d.ts +2 -2
- package/serialization/resources/commons/types/LlmInclusionStatus.d.ts +2 -2
- package/serialization/resources/commons/types/LlmPersona.d.ts +2 -2
- package/serialization/resources/commons/types/MessageStatus.d.ts +2 -2
- package/serialization/resources/commons/types/MetadataPrecondition.d.ts +2 -2
- package/serialization/resources/commons/types/NovelSystemEvent.d.ts +2 -2
- package/serialization/resources/commons/types/NovelSystemEventNoId.d.ts +3 -3
- package/serialization/resources/commons/types/NovelSystemEventNoId.js +1 -1
- package/serialization/resources/commons/types/NovelUserEvent.d.ts +4 -4
- package/serialization/resources/commons/types/NovelUserEvent.js +2 -2
- package/serialization/resources/commons/types/NumberRange.d.ts +2 -2
- package/serialization/resources/commons/types/OsInfo.d.ts +2 -2
- package/serialization/resources/commons/types/OsType.d.ts +2 -2
- package/serialization/resources/commons/types/Page.d.ts +2 -2
- package/serialization/resources/commons/types/PageInfo.d.ts +2 -2
- package/serialization/resources/{agents → commons}/types/PiiCategory.d.ts +2 -2
- package/serialization/resources/commons/types/Precondition.d.ts +3 -3
- package/serialization/resources/commons/types/Precondition.js +2 -2
- package/serialization/resources/commons/types/PreconditionBase.d.ts +2 -2
- package/serialization/resources/commons/types/PreconditionGroup.d.ts +2 -2
- package/serialization/resources/commons/types/PreconditionGroup.js +1 -1
- package/serialization/resources/commons/types/PreconditionGroupOperator.d.ts +2 -2
- package/serialization/resources/commons/types/PreconditionOperator.d.ts +2 -2
- package/serialization/resources/commons/types/Quality.d.ts +2 -2
- package/serialization/resources/commons/types/QualityReason.d.ts +2 -2
- package/serialization/resources/commons/types/ResponseConfig.d.ts +4 -2
- package/serialization/resources/commons/types/ResponseConfig.js +2 -0
- package/serialization/resources/commons/types/ResponseConfigPrecondition.d.ts +3 -3
- package/serialization/resources/commons/types/ResponseConfigPrecondition.js +1 -1
- package/serialization/resources/commons/types/ResponseLength.d.ts +2 -2
- package/serialization/resources/commons/types/SafetyCheckReport.d.ts +12 -0
- package/serialization/resources/commons/types/SafetyCheckReport.js +44 -0
- package/serialization/resources/commons/types/ScopedEntity.d.ts +2 -2
- package/serialization/resources/commons/types/Sentiment.d.ts +2 -2
- package/serialization/resources/commons/types/SessionInfo.d.ts +2 -2
- package/serialization/resources/commons/types/SimulationContext.d.ts +3 -3
- package/serialization/resources/commons/types/SimulationContext.js +1 -1
- package/serialization/resources/commons/types/Source.d.ts +2 -2
- package/serialization/resources/commons/types/SourceInfo.d.ts +4 -4
- package/serialization/resources/commons/types/SourceInfo.js +2 -2
- package/serialization/resources/commons/types/SourceType.d.ts +2 -2
- package/serialization/resources/commons/types/SurveyInfo.d.ts +2 -2
- package/serialization/resources/commons/types/SystemEvent.d.ts +2 -2
- package/serialization/resources/commons/types/SystemEventName.d.ts +2 -2
- package/serialization/resources/commons/types/TagsPrecondition.d.ts +2 -2
- package/serialization/resources/commons/types/UserConversationMessageType.d.ts +2 -2
- package/serialization/resources/commons/types/UserData.d.ts +2 -2
- package/serialization/resources/commons/types/UserDataWithReference.d.ts +2 -2
- package/serialization/resources/commons/types/UserEvent.d.ts +4 -4
- package/serialization/resources/commons/types/UserEvent.js +2 -2
- package/serialization/resources/commons/types/UserEventName.d.ts +2 -2
- package/serialization/resources/commons/types/UserMessage.d.ts +4 -4
- package/serialization/resources/commons/types/UserMessage.js +2 -2
- package/serialization/resources/commons/types/UserMessageBase.d.ts +3 -3
- package/serialization/resources/commons/types/UserMessageBase.js +1 -1
- package/serialization/resources/commons/types/UserMessageResponseState.d.ts +2 -2
- package/serialization/resources/commons/types/VisibilityType.d.ts +2 -2
- package/serialization/resources/commons/types/index.d.ts +118 -112
- package/serialization/resources/commons/types/index.js +118 -112
- package/serialization/resources/conversation/client/addConversationMetadata.d.ts +1 -1
- package/serialization/resources/conversation/client/appendNewMessages.d.ts +2 -2
- package/serialization/resources/conversation/client/index.d.ts +1 -1
- package/serialization/resources/conversation/client/index.js +2 -2
- package/serialization/resources/conversation/index.d.ts +1 -1
- package/serialization/resources/conversation/index.js +1 -1
- package/serialization/resources/conversation/types/ActionFormAttachment.d.ts +2 -2
- package/serialization/resources/conversation/types/ActionFormRequestParamValue.d.ts +2 -2
- package/serialization/resources/conversation/types/AskObjectRequest.d.ts +2 -2
- package/serialization/resources/conversation/types/AskRequest.d.ts +3 -3
- package/serialization/resources/conversation/types/AskRequest.js +1 -1
- package/serialization/resources/conversation/types/AskStreamActionEvent.d.ts +2 -2
- package/serialization/resources/conversation/types/AskStreamChartEvent.d.ts +2 -2
- package/serialization/resources/conversation/types/AskStreamEndEvent.d.ts +2 -2
- package/serialization/resources/conversation/types/AskStreamMetadataEvent.d.ts +2 -2
- package/serialization/resources/conversation/types/AskStreamOAuthButtonEvent.d.ts +2 -2
- package/serialization/resources/conversation/types/AskStreamStartEvent.d.ts +2 -2
- package/serialization/resources/conversation/types/AskStreamTextEvent.d.ts +2 -2
- package/serialization/resources/conversation/types/CategorizationResponse.d.ts +2 -2
- package/serialization/resources/conversation/types/ConversationField.d.ts +3 -3
- package/serialization/resources/conversation/types/ConversationField.js +2 -0
- package/serialization/resources/conversation/types/ConversationFilter.d.ts +3 -3
- package/serialization/resources/conversation/types/ConversationFilter.js +1 -1
- package/serialization/resources/conversation/types/ConversationMessageRequest.d.ts +3 -3
- package/serialization/resources/conversation/types/ConversationMessageRequest.js +1 -1
- package/serialization/resources/conversation/types/ConversationMetadata.d.ts +2 -2
- package/serialization/resources/conversation/types/ConversationPatchRequest.d.ts +2 -2
- package/serialization/resources/conversation/types/ConversationRequest.d.ts +3 -3
- package/serialization/resources/conversation/types/ConversationRequest.js +1 -1
- package/serialization/resources/conversation/types/ConversationsResponse.d.ts +2 -2
- package/serialization/resources/conversation/types/ConversationsSearchRequest.d.ts +3 -3
- package/serialization/resources/conversation/types/ConversationsSearchRequest.js +1 -1
- package/serialization/resources/conversation/types/DeliverConversationMessageRequest.d.ts +2 -2
- package/serialization/resources/conversation/types/DeliverMessageRequest.d.ts +3 -3
- package/serialization/resources/conversation/types/DeliverMessageRequest.js +1 -1
- package/serialization/resources/conversation/types/DeliverMessageResponse.d.ts +2 -2
- package/serialization/resources/conversation/types/DeliverUserMessageRequest.d.ts +2 -2
- package/serialization/resources/conversation/types/DeliveryStatus.d.ts +2 -2
- package/serialization/resources/conversation/types/FeedbackField.d.ts +2 -2
- package/serialization/resources/conversation/types/FeedbackFilter.d.ts +2 -2
- package/serialization/resources/conversation/types/FeedbackRequest.d.ts +2 -2
- package/serialization/resources/conversation/types/NumericConversationField.d.ts +3 -3
- package/serialization/resources/conversation/types/NumericConversationField.js +1 -0
- package/serialization/resources/conversation/types/ObjectStreamResponse.d.ts +4 -4
- package/serialization/resources/conversation/types/ObjectStreamResponse.js +2 -2
- package/serialization/resources/conversation/types/ResolutionStatus.d.ts +2 -2
- package/serialization/resources/conversation/types/SimulationFilter.d.ts +2 -2
- package/serialization/resources/conversation/types/StreamResponse.d.ts +5 -5
- package/serialization/resources/conversation/types/StreamResponse.js +3 -3
- package/serialization/resources/conversation/types/SubmitActionFormRequest.d.ts +2 -2
- package/serialization/resources/conversation/types/UpdateMetadataRequest.d.ts +2 -2
- package/serialization/resources/conversation/types/index.d.ts +21 -21
- package/serialization/resources/conversation/types/index.js +21 -21
- package/serialization/resources/customers/index.d.ts +1 -0
- package/serialization/resources/customers/index.js +17 -0
- package/serialization/resources/customers/types/CustomerBase.d.ts +13 -0
- package/serialization/resources/customers/types/CustomerBase.js +45 -0
- package/serialization/resources/customers/types/CustomerField.d.ts +7 -0
- package/serialization/resources/customers/types/CustomerField.js +39 -0
- package/serialization/resources/customers/types/CustomerFilter.d.ts +13 -0
- package/serialization/resources/customers/types/CustomerFilter.js +45 -0
- package/serialization/resources/customers/types/CustomerPatchRequest.d.ts +16 -0
- package/serialization/resources/customers/types/CustomerPatchRequest.js +48 -0
- package/serialization/resources/customers/types/CustomerRequest.d.ts +11 -0
- package/serialization/resources/customers/types/CustomerRequest.js +43 -0
- package/serialization/resources/customers/types/CustomerResponse.d.ts +13 -0
- package/serialization/resources/customers/types/CustomerResponse.js +47 -0
- package/serialization/resources/customers/types/CustomerStatus.d.ts +7 -0
- package/serialization/resources/customers/types/CustomerStatus.js +39 -0
- package/serialization/resources/customers/types/CustomersSearchRequest.d.ts +13 -0
- package/serialization/resources/customers/types/CustomersSearchRequest.js +47 -0
- package/serialization/resources/customers/types/CustomersSearchResponse.d.ts +11 -0
- package/serialization/resources/customers/types/CustomersSearchResponse.js +45 -0
- package/serialization/resources/customers/types/index.d.ts +9 -0
- package/serialization/resources/customers/types/index.js +25 -0
- package/serialization/resources/inbox/types/AddDocumentFixRequest.d.ts +2 -2
- package/serialization/resources/inbox/types/ApplyFixesRequest.d.ts +2 -2
- package/serialization/resources/inbox/types/InboxFilter.d.ts +2 -2
- package/serialization/resources/inbox/types/InboxSearchRequest.d.ts +3 -3
- package/serialization/resources/inbox/types/InboxSearchRequest.js +1 -1
- package/serialization/resources/inbox/types/InboxSearchResponse.d.ts +2 -2
- package/serialization/resources/inbox/types/index.d.ts +2 -2
- package/serialization/resources/inbox/types/index.js +2 -2
- package/serialization/resources/index.d.ts +5 -3
- package/serialization/resources/index.js +6 -4
- package/serialization/resources/knowledge/client/requests/KnowledgeBasePatchRequest.d.ts +3 -3
- package/serialization/resources/knowledge/client/requests/KnowledgeBasePatchRequest.js +2 -2
- package/serialization/resources/knowledge/client/requests/KnowledgeDocumentPatchRequest.d.ts +2 -2
- package/serialization/resources/knowledge/index.d.ts +1 -1
- package/serialization/resources/knowledge/index.js +1 -1
- package/serialization/resources/knowledge/types/BaseKnowledgeDocument.d.ts +2 -2
- package/serialization/resources/knowledge/types/FinalizeKnowledgeBaseVersionRequest.d.ts +2 -2
- package/serialization/resources/knowledge/types/KnowledgeBaseField.d.ts +2 -2
- package/serialization/resources/knowledge/types/KnowledgeBaseFilter.d.ts +3 -3
- package/serialization/resources/knowledge/types/KnowledgeBaseFilter.js +1 -1
- package/serialization/resources/knowledge/types/KnowledgeBaseProperties.d.ts +2 -2
- package/serialization/resources/knowledge/types/KnowledgeBaseProperties.js +1 -1
- package/serialization/resources/knowledge/types/KnowledgeBaseRefreshFrequency.d.ts +2 -2
- package/serialization/resources/knowledge/types/KnowledgeBaseRefreshRequest.d.ts +2 -2
- package/serialization/resources/knowledge/types/KnowledgeBaseRequest.d.ts +2 -2
- package/serialization/resources/knowledge/types/KnowledgeBaseResponse.d.ts +5 -5
- package/serialization/resources/knowledge/types/KnowledgeBaseResponse.js +3 -3
- package/serialization/resources/knowledge/types/KnowledgeBaseSearchRequest.d.ts +3 -3
- package/serialization/resources/knowledge/types/KnowledgeBaseSearchRequest.js +1 -1
- package/serialization/resources/knowledge/types/KnowledgeBaseType.d.ts +2 -2
- package/serialization/resources/knowledge/types/KnowledgeBaseVersion.d.ts +3 -3
- package/serialization/resources/knowledge/types/KnowledgeBaseVersion.js +1 -1
- package/serialization/resources/knowledge/types/KnowledgeBaseVersionFinalizeStatus.d.ts +2 -2
- package/serialization/resources/knowledge/types/KnowledgeBaseVersionRequest.d.ts +2 -2
- package/serialization/resources/knowledge/types/KnowledgeBaseVersionStatus.d.ts +2 -2
- package/serialization/resources/knowledge/types/KnowledgeBaseVersionType.d.ts +2 -2
- package/serialization/resources/knowledge/types/KnowledgeBaseVersionsListResponse.d.ts +2 -2
- package/serialization/resources/knowledge/types/KnowledgeBasesResponse.d.ts +3 -3
- package/serialization/resources/knowledge/types/KnowledgeBasesResponse.js +1 -1
- package/serialization/resources/knowledge/types/KnowledgeDeleteRequest.d.ts +2 -2
- package/serialization/resources/knowledge/types/KnowledgeDocumentContentType.d.ts +2 -2
- package/serialization/resources/knowledge/types/KnowledgeDocumentField.d.ts +2 -2
- package/serialization/resources/knowledge/types/KnowledgeDocumentFilter.d.ts +2 -2
- package/serialization/resources/knowledge/types/KnowledgeDocumentRequest.d.ts +5 -3
- package/serialization/resources/knowledge/types/KnowledgeDocumentRequest.js +3 -1
- package/serialization/resources/knowledge/types/KnowledgeDocumentResponse.d.ts +5 -3
- package/serialization/resources/knowledge/types/KnowledgeDocumentResponse.js +3 -1
- package/serialization/resources/knowledge/types/KnowledgeDocumentSearchRequest.d.ts +3 -3
- package/serialization/resources/knowledge/types/KnowledgeDocumentSearchRequest.js +1 -1
- package/serialization/resources/knowledge/types/KnowledgeDocumentSearchResponse.d.ts +2 -2
- package/serialization/resources/knowledge/types/KnowledgeDocumentStatus.d.ts +2 -2
- package/serialization/resources/knowledge/types/KnowledgeDocumentsResponse.d.ts +3 -3
- package/serialization/resources/knowledge/types/KnowledgeDocumentsResponse.js +1 -1
- package/serialization/resources/knowledge/types/index.d.ts +16 -16
- package/serialization/resources/knowledge/types/index.js +16 -16
- package/serialization/resources/organizations/types/BaseOrganization.d.ts +2 -2
- package/serialization/resources/organizations/types/CreateOrganizationRequest.d.ts +2 -2
- package/serialization/resources/organizations/types/Organization.d.ts +2 -2
- package/serialization/resources/organizations/types/OrganizationPatchRequest.d.ts +2 -2
- package/serialization/resources/organizations/types/index.d.ts +1 -1
- package/serialization/resources/organizations/types/index.js +1 -1
- package/serialization/resources/segments/types/SegmentBase.d.ts +2 -2
- package/serialization/resources/segments/types/SegmentBase.js +1 -1
- package/serialization/resources/segments/types/SegmentField.d.ts +2 -2
- package/serialization/resources/segments/types/SegmentPatchRequest.d.ts +2 -2
- package/serialization/resources/segments/types/SegmentPatchRequest.js +1 -1
- package/serialization/resources/segments/types/SegmentRequest.d.ts +2 -2
- package/serialization/resources/segments/types/SegmentResponse.d.ts +3 -3
- package/serialization/resources/segments/types/SegmentResponse.js +1 -1
- package/serialization/resources/segments/types/SegmentStatus.d.ts +2 -2
- package/serialization/resources/segments/types/SegmentsSearchRequest.d.ts +3 -3
- package/serialization/resources/segments/types/SegmentsSearchRequest.js +1 -1
- package/serialization/resources/segments/types/SegmentsSearchResponse.d.ts +3 -3
- package/serialization/resources/segments/types/SegmentsSearchResponse.js +1 -1
- package/serialization/resources/segments/types/index.d.ts +4 -4
- package/serialization/resources/segments/types/index.js +4 -4
- package/serialization/resources/translations/types/TranslationRequest.d.ts +2 -2
- package/serialization/resources/translations/types/TranslationResponse.d.ts +2 -2
- package/serialization/resources/triggers/types/EventTriggerBase.d.ts +2 -2
- package/serialization/resources/triggers/types/EventTriggerRequest.d.ts +2 -2
- package/serialization/resources/triggers/types/EventTriggerResponse.d.ts +2 -2
- package/serialization/resources/triggers/types/EventTriggerType.d.ts +2 -2
- package/serialization/resources/triggers/types/EventTriggersSearchRequest.d.ts +3 -3
- package/serialization/resources/triggers/types/EventTriggersSearchRequest.js +1 -1
- package/serialization/resources/triggers/types/EventTriggersSearchResponse.d.ts +3 -3
- package/serialization/resources/triggers/types/EventTriggersSearchResponse.js +1 -1
- package/serialization/resources/triggers/types/TriggerField.d.ts +2 -2
- package/serialization/resources/triggers/types/TriggerPartialUpdate.d.ts +2 -2
- package/serialization/resources/triggers/types/index.d.ts +3 -3
- package/serialization/resources/triggers/types/index.js +3 -3
- package/serialization/resources/users/types/AgentUser.d.ts +2 -2
- package/serialization/resources/users/types/AgentUserField.d.ts +2 -2
- package/serialization/resources/users/types/AgentUserFilter.d.ts +2 -2
- package/serialization/resources/users/types/AgentUserSearchRequest.d.ts +3 -3
- package/serialization/resources/users/types/AgentUserSearchRequest.js +1 -1
- package/serialization/resources/users/types/AgentUserSearchResponse.d.ts +3 -3
- package/serialization/resources/users/types/AgentUserSearchResponse.js +1 -1
- package/serialization/resources/users/types/AppUserSummary.d.ts +3 -3
- package/serialization/resources/users/types/AppUserSummary.js +1 -1
- package/serialization/resources/users/types/index.d.ts +1 -1
- package/serialization/resources/users/types/index.js +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/.prettierignore +0 -9
- /package/api/resources/{agents → commons}/types/PiiCategory.d.ts +0 -0
- /package/api/resources/{agents → commons}/types/PiiCategory.js +0 -0
- /package/dist/api/resources/{agents → commons}/types/PiiCategory.d.ts +0 -0
- /package/dist/api/resources/{agents → commons}/types/PiiCategory.js +0 -0
- /package/dist/serialization/resources/{agents → commons}/types/PiiCategory.js +0 -0
- /package/serialization/resources/{agents → commons}/types/PiiCategory.js +0 -0
package/reference.md
CHANGED
|
@@ -1,7 +1,5 @@
|
|
|
1
1
|
# Reference
|
|
2
|
-
|
|
3
2
|
## Actions
|
|
4
|
-
|
|
5
3
|
<details><summary><code>client.actions.<a href="/src/api/resources/actions/client/Client.ts">search</a>({ ...params }) -> MavenAGI.ActionsResponse</code></summary>
|
|
6
4
|
<dl>
|
|
7
5
|
<dd>
|
|
@@ -16,8 +14,8 @@
|
|
|
16
14
|
|
|
17
15
|
```typescript
|
|
18
16
|
await client.actions.search({});
|
|
19
|
-
```
|
|
20
17
|
|
|
18
|
+
```
|
|
21
19
|
</dd>
|
|
22
20
|
</dl>
|
|
23
21
|
</dd>
|
|
@@ -31,21 +29,22 @@ await client.actions.search({});
|
|
|
31
29
|
<dl>
|
|
32
30
|
<dd>
|
|
33
31
|
|
|
34
|
-
**request:** `MavenAGI.ActionsSearchRequest`
|
|
35
|
-
|
|
32
|
+
**request:** `MavenAGI.ActionsSearchRequest`
|
|
33
|
+
|
|
36
34
|
</dd>
|
|
37
35
|
</dl>
|
|
38
36
|
|
|
39
37
|
<dl>
|
|
40
38
|
<dd>
|
|
41
39
|
|
|
42
|
-
**requestOptions:** `Actions.RequestOptions`
|
|
43
|
-
|
|
40
|
+
**requestOptions:** `Actions.RequestOptions`
|
|
41
|
+
|
|
44
42
|
</dd>
|
|
45
43
|
</dl>
|
|
46
44
|
</dd>
|
|
47
45
|
</dl>
|
|
48
46
|
|
|
47
|
+
|
|
49
48
|
</dd>
|
|
50
49
|
</dl>
|
|
51
50
|
</details>
|
|
@@ -63,7 +62,6 @@ await client.actions.search({});
|
|
|
63
62
|
<dd>
|
|
64
63
|
|
|
65
64
|
Update an action or create it if it doesn't exist
|
|
66
|
-
|
|
67
65
|
</dd>
|
|
68
66
|
</dl>
|
|
69
67
|
</dd>
|
|
@@ -80,7 +78,7 @@ Update an action or create it if it doesn't exist
|
|
|
80
78
|
```typescript
|
|
81
79
|
await client.actions.createOrUpdate({
|
|
82
80
|
actionId: {
|
|
83
|
-
referenceId: "get-balance"
|
|
81
|
+
referenceId: "get-balance"
|
|
84
82
|
},
|
|
85
83
|
name: "Get the user's balance",
|
|
86
84
|
description: "This action calls an API to get the user's current balance.",
|
|
@@ -89,21 +87,18 @@ await client.actions.createOrUpdate({
|
|
|
89
87
|
precondition: {
|
|
90
88
|
preconditionType: "group",
|
|
91
89
|
operator: "AND",
|
|
92
|
-
preconditions: [
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
key: "userKey2",
|
|
100
|
-
},
|
|
101
|
-
],
|
|
90
|
+
preconditions: [{
|
|
91
|
+
"preconditionType": "user",
|
|
92
|
+
"key": "userKey"
|
|
93
|
+
}, {
|
|
94
|
+
"preconditionType": "user",
|
|
95
|
+
"key": "userKey2"
|
|
96
|
+
}]
|
|
102
97
|
},
|
|
103
|
-
language: "en"
|
|
98
|
+
language: "en"
|
|
104
99
|
});
|
|
105
|
-
```
|
|
106
100
|
|
|
101
|
+
```
|
|
107
102
|
</dd>
|
|
108
103
|
</dl>
|
|
109
104
|
</dd>
|
|
@@ -117,21 +112,22 @@ await client.actions.createOrUpdate({
|
|
|
117
112
|
<dl>
|
|
118
113
|
<dd>
|
|
119
114
|
|
|
120
|
-
**request:** `MavenAGI.ActionRequest`
|
|
121
|
-
|
|
115
|
+
**request:** `MavenAGI.ActionRequest`
|
|
116
|
+
|
|
122
117
|
</dd>
|
|
123
118
|
</dl>
|
|
124
119
|
|
|
125
120
|
<dl>
|
|
126
121
|
<dd>
|
|
127
122
|
|
|
128
|
-
**requestOptions:** `Actions.RequestOptions`
|
|
129
|
-
|
|
123
|
+
**requestOptions:** `Actions.RequestOptions`
|
|
124
|
+
|
|
130
125
|
</dd>
|
|
131
126
|
</dl>
|
|
132
127
|
</dd>
|
|
133
128
|
</dl>
|
|
134
129
|
|
|
130
|
+
|
|
135
131
|
</dd>
|
|
136
132
|
</dl>
|
|
137
133
|
</details>
|
|
@@ -149,7 +145,6 @@ await client.actions.createOrUpdate({
|
|
|
149
145
|
<dd>
|
|
150
146
|
|
|
151
147
|
Get an action by its supplied ID
|
|
152
|
-
|
|
153
148
|
</dd>
|
|
154
149
|
</dl>
|
|
155
150
|
</dd>
|
|
@@ -165,8 +160,8 @@ Get an action by its supplied ID
|
|
|
165
160
|
|
|
166
161
|
```typescript
|
|
167
162
|
await client.actions.get("get-balance");
|
|
168
|
-
```
|
|
169
163
|
|
|
164
|
+
```
|
|
170
165
|
</dd>
|
|
171
166
|
</dl>
|
|
172
167
|
</dd>
|
|
@@ -181,28 +176,29 @@ await client.actions.get("get-balance");
|
|
|
181
176
|
<dd>
|
|
182
177
|
|
|
183
178
|
**actionReferenceId:** `string` — The reference ID of the action to get. All other entity ID fields are inferred from the request.
|
|
184
|
-
|
|
179
|
+
|
|
185
180
|
</dd>
|
|
186
181
|
</dl>
|
|
187
182
|
|
|
188
183
|
<dl>
|
|
189
184
|
<dd>
|
|
190
185
|
|
|
191
|
-
**request:** `MavenAGI.ActionGetRequest`
|
|
192
|
-
|
|
186
|
+
**request:** `MavenAGI.ActionGetRequest`
|
|
187
|
+
|
|
193
188
|
</dd>
|
|
194
189
|
</dl>
|
|
195
190
|
|
|
196
191
|
<dl>
|
|
197
192
|
<dd>
|
|
198
193
|
|
|
199
|
-
**requestOptions:** `Actions.RequestOptions`
|
|
200
|
-
|
|
194
|
+
**requestOptions:** `Actions.RequestOptions`
|
|
195
|
+
|
|
201
196
|
</dd>
|
|
202
197
|
</dl>
|
|
203
198
|
</dd>
|
|
204
199
|
</dl>
|
|
205
200
|
|
|
201
|
+
|
|
206
202
|
</dd>
|
|
207
203
|
</dl>
|
|
208
204
|
</details>
|
|
@@ -221,9 +217,8 @@ await client.actions.get("get-balance");
|
|
|
221
217
|
|
|
222
218
|
Update mutable action fields
|
|
223
219
|
|
|
224
|
-
The `appId` field can be provided to update an action owned by a different app.
|
|
220
|
+
The `appId` field can be provided to update an action owned by a different app.
|
|
225
221
|
All other fields will overwrite the existing value on the action only if provided.
|
|
226
|
-
|
|
227
222
|
</dd>
|
|
228
223
|
</dl>
|
|
229
224
|
</dd>
|
|
@@ -246,11 +241,11 @@ await client.actions.patch("get-balance", {
|
|
|
246
241
|
appId: "my-billing-system",
|
|
247
242
|
organizationId: "acme",
|
|
248
243
|
agentId: "support",
|
|
249
|
-
type: "SEGMENT"
|
|
250
|
-
}
|
|
244
|
+
type: "SEGMENT"
|
|
245
|
+
}
|
|
251
246
|
});
|
|
252
|
-
```
|
|
253
247
|
|
|
248
|
+
```
|
|
254
249
|
</dd>
|
|
255
250
|
</dl>
|
|
256
251
|
</dd>
|
|
@@ -265,28 +260,29 @@ await client.actions.patch("get-balance", {
|
|
|
265
260
|
<dd>
|
|
266
261
|
|
|
267
262
|
**actionReferenceId:** `string` — The reference ID of the action to patch.
|
|
268
|
-
|
|
263
|
+
|
|
269
264
|
</dd>
|
|
270
265
|
</dl>
|
|
271
266
|
|
|
272
267
|
<dl>
|
|
273
268
|
<dd>
|
|
274
269
|
|
|
275
|
-
**request:** `MavenAGI.ActionPatchRequest`
|
|
276
|
-
|
|
270
|
+
**request:** `MavenAGI.ActionPatchRequest`
|
|
271
|
+
|
|
277
272
|
</dd>
|
|
278
273
|
</dl>
|
|
279
274
|
|
|
280
275
|
<dl>
|
|
281
276
|
<dd>
|
|
282
277
|
|
|
283
|
-
**requestOptions:** `Actions.RequestOptions`
|
|
284
|
-
|
|
278
|
+
**requestOptions:** `Actions.RequestOptions`
|
|
279
|
+
|
|
285
280
|
</dd>
|
|
286
281
|
</dl>
|
|
287
282
|
</dd>
|
|
288
283
|
</dl>
|
|
289
284
|
|
|
285
|
+
|
|
290
286
|
</dd>
|
|
291
287
|
</dl>
|
|
292
288
|
</details>
|
|
@@ -304,7 +300,6 @@ await client.actions.patch("get-balance", {
|
|
|
304
300
|
<dd>
|
|
305
301
|
|
|
306
302
|
Delete an action
|
|
307
|
-
|
|
308
303
|
</dd>
|
|
309
304
|
</dl>
|
|
310
305
|
</dd>
|
|
@@ -320,8 +315,8 @@ Delete an action
|
|
|
320
315
|
|
|
321
316
|
```typescript
|
|
322
317
|
await client.actions.delete("get-balance");
|
|
323
|
-
```
|
|
324
318
|
|
|
319
|
+
```
|
|
325
320
|
</dd>
|
|
326
321
|
</dl>
|
|
327
322
|
</dd>
|
|
@@ -336,26 +331,26 @@ await client.actions.delete("get-balance");
|
|
|
336
331
|
<dd>
|
|
337
332
|
|
|
338
333
|
**actionReferenceId:** `string` — The reference ID of the action to unregister. All other entity ID fields are inferred from the request.
|
|
339
|
-
|
|
334
|
+
|
|
340
335
|
</dd>
|
|
341
336
|
</dl>
|
|
342
337
|
|
|
343
338
|
<dl>
|
|
344
339
|
<dd>
|
|
345
340
|
|
|
346
|
-
**requestOptions:** `Actions.RequestOptions`
|
|
347
|
-
|
|
341
|
+
**requestOptions:** `Actions.RequestOptions`
|
|
342
|
+
|
|
348
343
|
</dd>
|
|
349
344
|
</dl>
|
|
350
345
|
</dd>
|
|
351
346
|
</dl>
|
|
352
347
|
|
|
348
|
+
|
|
353
349
|
</dd>
|
|
354
350
|
</dl>
|
|
355
351
|
</details>
|
|
356
352
|
|
|
357
353
|
## Agents
|
|
358
|
-
|
|
359
354
|
<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">search</a>({ ...params }) -> MavenAGI.AgentsSearchResponse</code></summary>
|
|
360
355
|
<dl>
|
|
361
356
|
<dd>
|
|
@@ -388,8 +383,8 @@ This endpoint requires additional permissions. Contact support to request access
|
|
|
388
383
|
|
|
389
384
|
```typescript
|
|
390
385
|
await client.agents.search({});
|
|
391
|
-
```
|
|
392
386
|
|
|
387
|
+
```
|
|
393
388
|
</dd>
|
|
394
389
|
</dl>
|
|
395
390
|
</dd>
|
|
@@ -403,21 +398,22 @@ await client.agents.search({});
|
|
|
403
398
|
<dl>
|
|
404
399
|
<dd>
|
|
405
400
|
|
|
406
|
-
**request:** `MavenAGI.AgentsSearchRequest`
|
|
407
|
-
|
|
401
|
+
**request:** `MavenAGI.AgentsSearchRequest`
|
|
402
|
+
|
|
408
403
|
</dd>
|
|
409
404
|
</dl>
|
|
410
405
|
|
|
411
406
|
<dl>
|
|
412
407
|
<dd>
|
|
413
408
|
|
|
414
|
-
**requestOptions:** `Agents.RequestOptions`
|
|
415
|
-
|
|
409
|
+
**requestOptions:** `Agents.RequestOptions`
|
|
410
|
+
|
|
416
411
|
</dd>
|
|
417
412
|
</dl>
|
|
418
413
|
</dd>
|
|
419
414
|
</dl>
|
|
420
415
|
|
|
416
|
+
|
|
421
417
|
</dd>
|
|
422
418
|
</dl>
|
|
423
419
|
</details>
|
|
@@ -435,7 +431,6 @@ await client.agents.search({});
|
|
|
435
431
|
<dd>
|
|
436
432
|
|
|
437
433
|
Lists all agents for an organization
|
|
438
|
-
|
|
439
434
|
</dd>
|
|
440
435
|
</dl>
|
|
441
436
|
</dd>
|
|
@@ -451,8 +446,8 @@ Lists all agents for an organization
|
|
|
451
446
|
|
|
452
447
|
```typescript
|
|
453
448
|
await client.agents.list("organizationReferenceId");
|
|
454
|
-
```
|
|
455
449
|
|
|
450
|
+
```
|
|
456
451
|
</dd>
|
|
457
452
|
</dl>
|
|
458
453
|
</dd>
|
|
@@ -467,20 +462,21 @@ await client.agents.list("organizationReferenceId");
|
|
|
467
462
|
<dd>
|
|
468
463
|
|
|
469
464
|
**organizationReferenceId:** `string` — The ID of the organization.
|
|
470
|
-
|
|
465
|
+
|
|
471
466
|
</dd>
|
|
472
467
|
</dl>
|
|
473
468
|
|
|
474
469
|
<dl>
|
|
475
470
|
<dd>
|
|
476
471
|
|
|
477
|
-
**requestOptions:** `Agents.RequestOptions`
|
|
478
|
-
|
|
472
|
+
**requestOptions:** `Agents.RequestOptions`
|
|
473
|
+
|
|
479
474
|
</dd>
|
|
480
475
|
</dl>
|
|
481
476
|
</dd>
|
|
482
477
|
</dl>
|
|
483
478
|
|
|
479
|
+
|
|
484
480
|
</dd>
|
|
485
481
|
</dl>
|
|
486
482
|
</details>
|
|
@@ -518,10 +514,10 @@ This endpoint requires additional permissions. Contact support to request access
|
|
|
518
514
|
```typescript
|
|
519
515
|
await client.agents.create("organizationReferenceId", "agentReferenceId", {
|
|
520
516
|
name: "name",
|
|
521
|
-
environment: "DEMO"
|
|
517
|
+
environment: "DEMO"
|
|
522
518
|
});
|
|
523
|
-
```
|
|
524
519
|
|
|
520
|
+
```
|
|
525
521
|
</dd>
|
|
526
522
|
</dl>
|
|
527
523
|
</dd>
|
|
@@ -536,7 +532,7 @@ await client.agents.create("organizationReferenceId", "agentReferenceId", {
|
|
|
536
532
|
<dd>
|
|
537
533
|
|
|
538
534
|
**organizationReferenceId:** `string` — The ID of the organization.
|
|
539
|
-
|
|
535
|
+
|
|
540
536
|
</dd>
|
|
541
537
|
</dl>
|
|
542
538
|
|
|
@@ -544,28 +540,29 @@ await client.agents.create("organizationReferenceId", "agentReferenceId", {
|
|
|
544
540
|
<dd>
|
|
545
541
|
|
|
546
542
|
**agentReferenceId:** `string` — The ID of the agent.
|
|
547
|
-
|
|
543
|
+
|
|
548
544
|
</dd>
|
|
549
545
|
</dl>
|
|
550
546
|
|
|
551
547
|
<dl>
|
|
552
548
|
<dd>
|
|
553
549
|
|
|
554
|
-
**request:** `MavenAGI.CreateAgentRequest`
|
|
555
|
-
|
|
550
|
+
**request:** `MavenAGI.CreateAgentRequest`
|
|
551
|
+
|
|
556
552
|
</dd>
|
|
557
553
|
</dl>
|
|
558
554
|
|
|
559
555
|
<dl>
|
|
560
556
|
<dd>
|
|
561
557
|
|
|
562
|
-
**requestOptions:** `Agents.RequestOptions`
|
|
563
|
-
|
|
558
|
+
**requestOptions:** `Agents.RequestOptions`
|
|
559
|
+
|
|
564
560
|
</dd>
|
|
565
561
|
</dl>
|
|
566
562
|
</dd>
|
|
567
563
|
</dl>
|
|
568
564
|
|
|
565
|
+
|
|
569
566
|
</dd>
|
|
570
567
|
</dl>
|
|
571
568
|
</details>
|
|
@@ -583,7 +580,6 @@ await client.agents.create("organizationReferenceId", "agentReferenceId", {
|
|
|
583
580
|
<dd>
|
|
584
581
|
|
|
585
582
|
Get an agent
|
|
586
|
-
|
|
587
583
|
</dd>
|
|
588
584
|
</dl>
|
|
589
585
|
</dd>
|
|
@@ -599,8 +595,8 @@ Get an agent
|
|
|
599
595
|
|
|
600
596
|
```typescript
|
|
601
597
|
await client.agents.get("organizationReferenceId", "agentReferenceId");
|
|
602
|
-
```
|
|
603
598
|
|
|
599
|
+
```
|
|
604
600
|
</dd>
|
|
605
601
|
</dl>
|
|
606
602
|
</dd>
|
|
@@ -615,7 +611,7 @@ await client.agents.get("organizationReferenceId", "agentReferenceId");
|
|
|
615
611
|
<dd>
|
|
616
612
|
|
|
617
613
|
**organizationReferenceId:** `string` — The ID of the organization.
|
|
618
|
-
|
|
614
|
+
|
|
619
615
|
</dd>
|
|
620
616
|
</dl>
|
|
621
617
|
|
|
@@ -623,20 +619,21 @@ await client.agents.get("organizationReferenceId", "agentReferenceId");
|
|
|
623
619
|
<dd>
|
|
624
620
|
|
|
625
621
|
**agentReferenceId:** `string` — The ID of the agent.
|
|
626
|
-
|
|
622
|
+
|
|
627
623
|
</dd>
|
|
628
624
|
</dl>
|
|
629
625
|
|
|
630
626
|
<dl>
|
|
631
627
|
<dd>
|
|
632
628
|
|
|
633
|
-
**requestOptions:** `Agents.RequestOptions`
|
|
634
|
-
|
|
629
|
+
**requestOptions:** `Agents.RequestOptions`
|
|
630
|
+
|
|
635
631
|
</dd>
|
|
636
632
|
</dl>
|
|
637
633
|
</dd>
|
|
638
634
|
</dl>
|
|
639
635
|
|
|
636
|
+
|
|
640
637
|
</dd>
|
|
641
638
|
</dl>
|
|
642
639
|
</details>
|
|
@@ -653,7 +650,7 @@ await client.agents.get("organizationReferenceId", "agentReferenceId");
|
|
|
653
650
|
<dl>
|
|
654
651
|
<dd>
|
|
655
652
|
|
|
656
|
-
Update mutable agent fields
|
|
653
|
+
Update mutable agent fields
|
|
657
654
|
All fields will overwrite the existing value on the agent only if provided.
|
|
658
655
|
|
|
659
656
|
<Tip>
|
|
@@ -674,8 +671,8 @@ This endpoint requires additional permissions. Contact support to request access
|
|
|
674
671
|
|
|
675
672
|
```typescript
|
|
676
673
|
await client.agents.patch("organizationReferenceId", "agentReferenceId");
|
|
677
|
-
```
|
|
678
674
|
|
|
675
|
+
```
|
|
679
676
|
</dd>
|
|
680
677
|
</dl>
|
|
681
678
|
</dd>
|
|
@@ -690,7 +687,7 @@ await client.agents.patch("organizationReferenceId", "agentReferenceId");
|
|
|
690
687
|
<dd>
|
|
691
688
|
|
|
692
689
|
**organizationReferenceId:** `string` — The ID of the organization.
|
|
693
|
-
|
|
690
|
+
|
|
694
691
|
</dd>
|
|
695
692
|
</dl>
|
|
696
693
|
|
|
@@ -698,28 +695,29 @@ await client.agents.patch("organizationReferenceId", "agentReferenceId");
|
|
|
698
695
|
<dd>
|
|
699
696
|
|
|
700
697
|
**agentReferenceId:** `string` — The ID of the agent.
|
|
701
|
-
|
|
698
|
+
|
|
702
699
|
</dd>
|
|
703
700
|
</dl>
|
|
704
701
|
|
|
705
702
|
<dl>
|
|
706
703
|
<dd>
|
|
707
704
|
|
|
708
|
-
**request:** `MavenAGI.AgentPatchRequest`
|
|
709
|
-
|
|
705
|
+
**request:** `MavenAGI.AgentPatchRequest`
|
|
706
|
+
|
|
710
707
|
</dd>
|
|
711
708
|
</dl>
|
|
712
709
|
|
|
713
710
|
<dl>
|
|
714
711
|
<dd>
|
|
715
712
|
|
|
716
|
-
**requestOptions:** `Agents.RequestOptions`
|
|
717
|
-
|
|
713
|
+
**requestOptions:** `Agents.RequestOptions`
|
|
714
|
+
|
|
718
715
|
</dd>
|
|
719
716
|
</dl>
|
|
720
717
|
</dd>
|
|
721
718
|
</dl>
|
|
722
719
|
|
|
720
|
+
|
|
723
721
|
</dd>
|
|
724
722
|
</dl>
|
|
725
723
|
</details>
|
|
@@ -756,8 +754,8 @@ This endpoint requires additional permissions. Contact support to request access
|
|
|
756
754
|
|
|
757
755
|
```typescript
|
|
758
756
|
await client.agents.delete("organizationReferenceId", "agentReferenceId");
|
|
759
|
-
```
|
|
760
757
|
|
|
758
|
+
```
|
|
761
759
|
</dd>
|
|
762
760
|
</dl>
|
|
763
761
|
</dd>
|
|
@@ -772,7 +770,7 @@ await client.agents.delete("organizationReferenceId", "agentReferenceId");
|
|
|
772
770
|
<dd>
|
|
773
771
|
|
|
774
772
|
**organizationReferenceId:** `string` — The ID of the organization.
|
|
775
|
-
|
|
773
|
+
|
|
776
774
|
</dd>
|
|
777
775
|
</dl>
|
|
778
776
|
|
|
@@ -780,26 +778,26 @@ await client.agents.delete("organizationReferenceId", "agentReferenceId");
|
|
|
780
778
|
<dd>
|
|
781
779
|
|
|
782
780
|
**agentReferenceId:** `string` — The ID of the agent.
|
|
783
|
-
|
|
781
|
+
|
|
784
782
|
</dd>
|
|
785
783
|
</dl>
|
|
786
784
|
|
|
787
785
|
<dl>
|
|
788
786
|
<dd>
|
|
789
787
|
|
|
790
|
-
**requestOptions:** `Agents.RequestOptions`
|
|
791
|
-
|
|
788
|
+
**requestOptions:** `Agents.RequestOptions`
|
|
789
|
+
|
|
792
790
|
</dd>
|
|
793
791
|
</dl>
|
|
794
792
|
</dd>
|
|
795
793
|
</dl>
|
|
796
794
|
|
|
795
|
+
|
|
797
796
|
</dd>
|
|
798
797
|
</dl>
|
|
799
798
|
</details>
|
|
800
799
|
|
|
801
800
|
## Analytics
|
|
802
|
-
|
|
803
801
|
<details><summary><code>client.analytics.<a href="/src/api/resources/analytics/client/Client.ts">getConversationTable</a>({ ...params }) -> MavenAGI.ConversationTableResponse</code></summary>
|
|
804
802
|
<dl>
|
|
805
803
|
<dd>
|
|
@@ -813,7 +811,6 @@ await client.agents.delete("organizationReferenceId", "agentReferenceId");
|
|
|
813
811
|
<dd>
|
|
814
812
|
|
|
815
813
|
Retrieves structured conversation data formatted as a table, allowing users to group, filter, and define specific metrics to display as columns.
|
|
816
|
-
|
|
817
814
|
</dd>
|
|
818
815
|
</dl>
|
|
819
816
|
</dd>
|
|
@@ -830,40 +827,34 @@ Retrieves structured conversation data formatted as a table, allowing users to g
|
|
|
830
827
|
```typescript
|
|
831
828
|
await client.analytics.getConversationTable({
|
|
832
829
|
conversationFilter: {
|
|
833
|
-
languages: ["en", "es"]
|
|
830
|
+
languages: ["en", "es"]
|
|
834
831
|
},
|
|
835
832
|
timeGrouping: "DAY",
|
|
836
|
-
fieldGroupings: [
|
|
837
|
-
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
],
|
|
841
|
-
columnDefinitions: [
|
|
842
|
-
{
|
|
833
|
+
fieldGroupings: [{
|
|
834
|
+
field: "Category"
|
|
835
|
+
}],
|
|
836
|
+
columnDefinitions: [{
|
|
843
837
|
header: "count",
|
|
844
838
|
metric: {
|
|
845
|
-
type: "count"
|
|
846
|
-
}
|
|
847
|
-
},
|
|
848
|
-
{
|
|
839
|
+
type: "count"
|
|
840
|
+
}
|
|
841
|
+
}, {
|
|
849
842
|
header: "avg_first_response_time",
|
|
850
843
|
metric: {
|
|
851
844
|
type: "average",
|
|
852
|
-
targetField: "FirstResponseTime"
|
|
853
|
-
}
|
|
854
|
-
},
|
|
855
|
-
{
|
|
845
|
+
targetField: "FirstResponseTime"
|
|
846
|
+
}
|
|
847
|
+
}, {
|
|
856
848
|
header: "percentile_handle_time",
|
|
857
849
|
metric: {
|
|
858
850
|
type: "percentile",
|
|
859
851
|
targetField: "HandleTime",
|
|
860
|
-
percentile: 25
|
|
861
|
-
}
|
|
862
|
-
}
|
|
863
|
-
],
|
|
852
|
+
percentile: 25
|
|
853
|
+
}
|
|
854
|
+
}]
|
|
864
855
|
});
|
|
865
|
-
```
|
|
866
856
|
|
|
857
|
+
```
|
|
867
858
|
</dd>
|
|
868
859
|
</dl>
|
|
869
860
|
</dd>
|
|
@@ -877,21 +868,22 @@ await client.analytics.getConversationTable({
|
|
|
877
868
|
<dl>
|
|
878
869
|
<dd>
|
|
879
870
|
|
|
880
|
-
**request:** `MavenAGI.ConversationTableRequest`
|
|
881
|
-
|
|
871
|
+
**request:** `MavenAGI.ConversationTableRequest`
|
|
872
|
+
|
|
882
873
|
</dd>
|
|
883
874
|
</dl>
|
|
884
875
|
|
|
885
876
|
<dl>
|
|
886
877
|
<dd>
|
|
887
878
|
|
|
888
|
-
**requestOptions:** `Analytics.RequestOptions`
|
|
889
|
-
|
|
879
|
+
**requestOptions:** `Analytics.RequestOptions`
|
|
880
|
+
|
|
890
881
|
</dd>
|
|
891
882
|
</dl>
|
|
892
883
|
</dd>
|
|
893
884
|
</dl>
|
|
894
885
|
|
|
886
|
+
|
|
895
887
|
</dd>
|
|
896
888
|
</dl>
|
|
897
889
|
</details>
|
|
@@ -909,7 +901,6 @@ await client.analytics.getConversationTable({
|
|
|
909
901
|
<dd>
|
|
910
902
|
|
|
911
903
|
Fetches conversation data visualized in a chart format. Supported chart types include pie chart, date histogram, and stacked bar charts.
|
|
912
|
-
|
|
913
904
|
</dd>
|
|
914
905
|
</dl>
|
|
915
906
|
</dd>
|
|
@@ -927,17 +918,17 @@ Fetches conversation data visualized in a chart format. Supported chart types in
|
|
|
927
918
|
await client.analytics.getConversationChart({
|
|
928
919
|
type: "pieChart",
|
|
929
920
|
conversationFilter: {
|
|
930
|
-
languages: ["en", "es"]
|
|
921
|
+
languages: ["en", "es"]
|
|
931
922
|
},
|
|
932
923
|
groupBy: {
|
|
933
|
-
field: "Category"
|
|
924
|
+
field: "Category"
|
|
934
925
|
},
|
|
935
926
|
metric: {
|
|
936
|
-
type: "count"
|
|
937
|
-
}
|
|
927
|
+
type: "count"
|
|
928
|
+
}
|
|
938
929
|
});
|
|
939
|
-
```
|
|
940
930
|
|
|
931
|
+
```
|
|
941
932
|
</dd>
|
|
942
933
|
</dl>
|
|
943
934
|
</dd>
|
|
@@ -951,21 +942,22 @@ await client.analytics.getConversationChart({
|
|
|
951
942
|
<dl>
|
|
952
943
|
<dd>
|
|
953
944
|
|
|
954
|
-
**request:** `MavenAGI.ConversationChartRequest`
|
|
955
|
-
|
|
945
|
+
**request:** `MavenAGI.ConversationChartRequest`
|
|
946
|
+
|
|
956
947
|
</dd>
|
|
957
948
|
</dl>
|
|
958
949
|
|
|
959
950
|
<dl>
|
|
960
951
|
<dd>
|
|
961
952
|
|
|
962
|
-
**requestOptions:** `Analytics.RequestOptions`
|
|
963
|
-
|
|
953
|
+
**requestOptions:** `Analytics.RequestOptions`
|
|
954
|
+
|
|
964
955
|
</dd>
|
|
965
956
|
</dl>
|
|
966
957
|
</dd>
|
|
967
958
|
</dl>
|
|
968
959
|
|
|
960
|
+
|
|
969
961
|
</dd>
|
|
970
962
|
</dl>
|
|
971
963
|
</details>
|
|
@@ -985,7 +977,6 @@ await client.analytics.getConversationChart({
|
|
|
985
977
|
Export the conversation analytics table to a CSV file.
|
|
986
978
|
|
|
987
979
|
This outputs the current table view defined by the request. For most programmatic use cases, prefer `getConversationTable` and format client-side. The CSV format may change and should not be relied upon by code consumers. A maximum of 10,000 rows can be exported at a time.
|
|
988
|
-
|
|
989
980
|
</dd>
|
|
990
981
|
</dl>
|
|
991
982
|
</dd>
|
|
@@ -1001,31 +992,25 @@ This outputs the current table view defined by the request. For most programmati
|
|
|
1001
992
|
|
|
1002
993
|
```typescript
|
|
1003
994
|
await client.analytics.exportConversationTable({
|
|
1004
|
-
fieldGroupings: [
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
},
|
|
1011
|
-
],
|
|
1012
|
-
columnDefinitions: [
|
|
1013
|
-
{
|
|
995
|
+
fieldGroupings: [{
|
|
996
|
+
field: "Category"
|
|
997
|
+
}, {
|
|
998
|
+
field: "Category"
|
|
999
|
+
}],
|
|
1000
|
+
columnDefinitions: [{
|
|
1014
1001
|
metric: {
|
|
1015
|
-
type: "count"
|
|
1002
|
+
type: "count"
|
|
1016
1003
|
},
|
|
1017
|
-
header: "header"
|
|
1018
|
-
},
|
|
1019
|
-
{
|
|
1004
|
+
header: "header"
|
|
1005
|
+
}, {
|
|
1020
1006
|
metric: {
|
|
1021
|
-
type: "count"
|
|
1007
|
+
type: "count"
|
|
1022
1008
|
},
|
|
1023
|
-
header: "header"
|
|
1024
|
-
}
|
|
1025
|
-
],
|
|
1009
|
+
header: "header"
|
|
1010
|
+
}]
|
|
1026
1011
|
});
|
|
1027
|
-
```
|
|
1028
1012
|
|
|
1013
|
+
```
|
|
1029
1014
|
</dd>
|
|
1030
1015
|
</dl>
|
|
1031
1016
|
</dd>
|
|
@@ -1039,21 +1024,22 @@ await client.analytics.exportConversationTable({
|
|
|
1039
1024
|
<dl>
|
|
1040
1025
|
<dd>
|
|
1041
1026
|
|
|
1042
|
-
**request:** `MavenAGI.ConversationTableRequest`
|
|
1043
|
-
|
|
1027
|
+
**request:** `MavenAGI.ConversationTableRequest`
|
|
1028
|
+
|
|
1044
1029
|
</dd>
|
|
1045
1030
|
</dl>
|
|
1046
1031
|
|
|
1047
1032
|
<dl>
|
|
1048
1033
|
<dd>
|
|
1049
1034
|
|
|
1050
|
-
**requestOptions:** `Analytics.RequestOptions`
|
|
1051
|
-
|
|
1035
|
+
**requestOptions:** `Analytics.RequestOptions`
|
|
1036
|
+
|
|
1052
1037
|
</dd>
|
|
1053
1038
|
</dl>
|
|
1054
1039
|
</dd>
|
|
1055
1040
|
</dl>
|
|
1056
1041
|
|
|
1042
|
+
|
|
1057
1043
|
</dd>
|
|
1058
1044
|
</dl>
|
|
1059
1045
|
</details>
|
|
@@ -1070,8 +1056,7 @@ await client.analytics.exportConversationTable({
|
|
|
1070
1056
|
<dl>
|
|
1071
1057
|
<dd>
|
|
1072
1058
|
|
|
1073
|
-
Retrieves structured feedback data formatted as a table, allowing users to group, filter,
|
|
1074
|
-
|
|
1059
|
+
Retrieves structured feedback data formatted as a table, allowing users to group, filter, and define specific metrics to display as columns.
|
|
1075
1060
|
</dd>
|
|
1076
1061
|
</dl>
|
|
1077
1062
|
</dd>
|
|
@@ -1088,24 +1073,20 @@ Retrieves structured feedback data formatted as a table, allowing users to group
|
|
|
1088
1073
|
```typescript
|
|
1089
1074
|
await client.analytics.getFeedbackTable({
|
|
1090
1075
|
feedbackFilter: {
|
|
1091
|
-
types: ["THUMBS_UP", "INSERT"]
|
|
1076
|
+
types: ["THUMBS_UP", "INSERT"]
|
|
1092
1077
|
},
|
|
1093
|
-
fieldGroupings: [
|
|
1094
|
-
|
|
1095
|
-
|
|
1096
|
-
|
|
1097
|
-
],
|
|
1098
|
-
columnDefinitions: [
|
|
1099
|
-
{
|
|
1078
|
+
fieldGroupings: [{
|
|
1079
|
+
field: "CreatedBy"
|
|
1080
|
+
}],
|
|
1081
|
+
columnDefinitions: [{
|
|
1100
1082
|
header: "feedback_count",
|
|
1101
1083
|
metric: {
|
|
1102
|
-
type: "count"
|
|
1103
|
-
}
|
|
1104
|
-
}
|
|
1105
|
-
],
|
|
1084
|
+
type: "count"
|
|
1085
|
+
}
|
|
1086
|
+
}]
|
|
1106
1087
|
});
|
|
1107
|
-
```
|
|
1108
1088
|
|
|
1089
|
+
```
|
|
1109
1090
|
</dd>
|
|
1110
1091
|
</dl>
|
|
1111
1092
|
</dd>
|
|
@@ -1119,21 +1100,22 @@ await client.analytics.getFeedbackTable({
|
|
|
1119
1100
|
<dl>
|
|
1120
1101
|
<dd>
|
|
1121
1102
|
|
|
1122
|
-
**request:** `MavenAGI.FeedbackTableRequest`
|
|
1123
|
-
|
|
1103
|
+
**request:** `MavenAGI.FeedbackTableRequest`
|
|
1104
|
+
|
|
1124
1105
|
</dd>
|
|
1125
1106
|
</dl>
|
|
1126
1107
|
|
|
1127
1108
|
<dl>
|
|
1128
1109
|
<dd>
|
|
1129
1110
|
|
|
1130
|
-
**requestOptions:** `Analytics.RequestOptions`
|
|
1131
|
-
|
|
1111
|
+
**requestOptions:** `Analytics.RequestOptions`
|
|
1112
|
+
|
|
1132
1113
|
</dd>
|
|
1133
1114
|
</dl>
|
|
1134
1115
|
</dd>
|
|
1135
1116
|
</dl>
|
|
1136
1117
|
|
|
1118
|
+
|
|
1137
1119
|
</dd>
|
|
1138
1120
|
</dl>
|
|
1139
1121
|
</details>
|
|
@@ -1150,8 +1132,7 @@ await client.analytics.getFeedbackTable({
|
|
|
1150
1132
|
<dl>
|
|
1151
1133
|
<dd>
|
|
1152
1134
|
|
|
1153
|
-
Retrieves structured agent user data formatted as a table, allowing users to group, filter,
|
|
1154
|
-
|
|
1135
|
+
Retrieves structured agent user data formatted as a table, allowing users to group, filter, and define specific metrics to display as columns.
|
|
1155
1136
|
</dd>
|
|
1156
1137
|
</dl>
|
|
1157
1138
|
</dd>
|
|
@@ -1168,19 +1149,17 @@ Retrieves structured agent user data formatted as a table, allowing users to gro
|
|
|
1168
1149
|
```typescript
|
|
1169
1150
|
await client.analytics.getAgentUserTable({
|
|
1170
1151
|
agentUserFilter: {
|
|
1171
|
-
search: "john"
|
|
1152
|
+
search: "john"
|
|
1172
1153
|
},
|
|
1173
|
-
columnDefinitions: [
|
|
1174
|
-
{
|
|
1154
|
+
columnDefinitions: [{
|
|
1175
1155
|
header: "user_count",
|
|
1176
1156
|
metric: {
|
|
1177
|
-
type: "count"
|
|
1178
|
-
}
|
|
1179
|
-
}
|
|
1180
|
-
],
|
|
1157
|
+
type: "count"
|
|
1158
|
+
}
|
|
1159
|
+
}]
|
|
1181
1160
|
});
|
|
1182
|
-
```
|
|
1183
1161
|
|
|
1162
|
+
```
|
|
1184
1163
|
</dd>
|
|
1185
1164
|
</dl>
|
|
1186
1165
|
</dd>
|
|
@@ -1194,28 +1173,27 @@ await client.analytics.getAgentUserTable({
|
|
|
1194
1173
|
<dl>
|
|
1195
1174
|
<dd>
|
|
1196
1175
|
|
|
1197
|
-
**request:** `MavenAGI.AgentUserTableRequest`
|
|
1198
|
-
|
|
1176
|
+
**request:** `MavenAGI.AgentUserTableRequest`
|
|
1177
|
+
|
|
1199
1178
|
</dd>
|
|
1200
1179
|
</dl>
|
|
1201
1180
|
|
|
1202
1181
|
<dl>
|
|
1203
1182
|
<dd>
|
|
1204
1183
|
|
|
1205
|
-
**requestOptions:** `Analytics.RequestOptions`
|
|
1206
|
-
|
|
1184
|
+
**requestOptions:** `Analytics.RequestOptions`
|
|
1185
|
+
|
|
1207
1186
|
</dd>
|
|
1208
1187
|
</dl>
|
|
1209
1188
|
</dd>
|
|
1210
1189
|
</dl>
|
|
1211
1190
|
|
|
1191
|
+
|
|
1212
1192
|
</dd>
|
|
1213
1193
|
</dl>
|
|
1214
1194
|
</details>
|
|
1215
1195
|
|
|
1216
|
-
|
|
1217
|
-
|
|
1218
|
-
<details><summary><code>client.appSettings.<a href="/src/api/resources/appSettings/client/Client.ts">search</a>({ ...params }) -> MavenAGI.SearchAppSettingsResponse</code></summary>
|
|
1196
|
+
<details><summary><code>client.analytics.<a href="/src/api/resources/analytics/client/Client.ts">getEventTable</a>({ ...params }) -> MavenAGI.EventTableResponse</code></summary>
|
|
1219
1197
|
<dl>
|
|
1220
1198
|
<dd>
|
|
1221
1199
|
|
|
@@ -1227,12 +1205,7 @@ await client.analytics.getAgentUserTable({
|
|
|
1227
1205
|
<dl>
|
|
1228
1206
|
<dd>
|
|
1229
1207
|
|
|
1230
|
-
|
|
1231
|
-
|
|
1232
|
-
You can set the `$index` key using the Update app settings API.
|
|
1233
|
-
|
|
1234
|
-
<Warning>This API currently requires an organization ID and agent ID for any agent which is installed on the app. This requirement will be removed in a future update.</Warning>
|
|
1235
|
-
|
|
1208
|
+
Retrieves structured event data formatted as a table, allowing users to group, filter, and define specific metrics to display as columns.
|
|
1236
1209
|
</dd>
|
|
1237
1210
|
</dl>
|
|
1238
1211
|
</dd>
|
|
@@ -1247,11 +1220,22 @@ You can set the `$index` key using the Update app settings API.
|
|
|
1247
1220
|
<dd>
|
|
1248
1221
|
|
|
1249
1222
|
```typescript
|
|
1250
|
-
await client.
|
|
1251
|
-
|
|
1223
|
+
await client.analytics.getEventTable({
|
|
1224
|
+
eventFilter: {
|
|
1225
|
+
eventTypes: ["USER"]
|
|
1226
|
+
},
|
|
1227
|
+
fieldGroupings: [{
|
|
1228
|
+
field: "EVENT_NAME"
|
|
1229
|
+
}],
|
|
1230
|
+
columnDefinitions: [{
|
|
1231
|
+
header: "event_count",
|
|
1232
|
+
metric: {
|
|
1233
|
+
type: "count"
|
|
1234
|
+
}
|
|
1235
|
+
}]
|
|
1252
1236
|
});
|
|
1253
|
-
```
|
|
1254
1237
|
|
|
1238
|
+
```
|
|
1255
1239
|
</dd>
|
|
1256
1240
|
</dl>
|
|
1257
1241
|
</dd>
|
|
@@ -1265,26 +1249,27 @@ await client.appSettings.search({
|
|
|
1265
1249
|
<dl>
|
|
1266
1250
|
<dd>
|
|
1267
1251
|
|
|
1268
|
-
**request:** `MavenAGI.
|
|
1269
|
-
|
|
1252
|
+
**request:** `MavenAGI.EventTableRequest`
|
|
1253
|
+
|
|
1270
1254
|
</dd>
|
|
1271
1255
|
</dl>
|
|
1272
1256
|
|
|
1273
1257
|
<dl>
|
|
1274
1258
|
<dd>
|
|
1275
1259
|
|
|
1276
|
-
**requestOptions:** `
|
|
1277
|
-
|
|
1260
|
+
**requestOptions:** `Analytics.RequestOptions`
|
|
1261
|
+
|
|
1278
1262
|
</dd>
|
|
1279
1263
|
</dl>
|
|
1280
1264
|
</dd>
|
|
1281
1265
|
</dl>
|
|
1282
1266
|
|
|
1267
|
+
|
|
1283
1268
|
</dd>
|
|
1284
1269
|
</dl>
|
|
1285
1270
|
</details>
|
|
1286
1271
|
|
|
1287
|
-
<details><summary><code>client.
|
|
1272
|
+
<details><summary><code>client.analytics.<a href="/src/api/resources/analytics/client/Client.ts">getEventChart</a>({ ...params }) -> MavenAGI.ChartResponse</code></summary>
|
|
1288
1273
|
<dl>
|
|
1289
1274
|
<dd>
|
|
1290
1275
|
|
|
@@ -1296,8 +1281,7 @@ await client.appSettings.search({
|
|
|
1296
1281
|
<dl>
|
|
1297
1282
|
<dd>
|
|
1298
1283
|
|
|
1299
|
-
|
|
1300
|
-
|
|
1284
|
+
Fetches event data visualized in a chart format. Supported chart types include pie chart, date histogram, and stacked bar charts.
|
|
1301
1285
|
</dd>
|
|
1302
1286
|
</dl>
|
|
1303
1287
|
</dd>
|
|
@@ -1312,9 +1296,20 @@ Get app settings set during installation
|
|
|
1312
1296
|
<dd>
|
|
1313
1297
|
|
|
1314
1298
|
```typescript
|
|
1315
|
-
await client.
|
|
1316
|
-
|
|
1299
|
+
await client.analytics.getEventChart({
|
|
1300
|
+
type: "pieChart",
|
|
1301
|
+
eventFilter: {
|
|
1302
|
+
eventTypes: ["USER"]
|
|
1303
|
+
},
|
|
1304
|
+
groupBy: {
|
|
1305
|
+
field: "EVENT_NAME"
|
|
1306
|
+
},
|
|
1307
|
+
metric: {
|
|
1308
|
+
type: "count"
|
|
1309
|
+
}
|
|
1310
|
+
});
|
|
1317
1311
|
|
|
1312
|
+
```
|
|
1318
1313
|
</dd>
|
|
1319
1314
|
</dl>
|
|
1320
1315
|
</dd>
|
|
@@ -1328,18 +1323,28 @@ await client.appSettings.get();
|
|
|
1328
1323
|
<dl>
|
|
1329
1324
|
<dd>
|
|
1330
1325
|
|
|
1331
|
-
**
|
|
1326
|
+
**request:** `MavenAGI.EventChartRequest`
|
|
1327
|
+
|
|
1328
|
+
</dd>
|
|
1329
|
+
</dl>
|
|
1330
|
+
|
|
1331
|
+
<dl>
|
|
1332
|
+
<dd>
|
|
1332
1333
|
|
|
1334
|
+
**requestOptions:** `Analytics.RequestOptions`
|
|
1335
|
+
|
|
1333
1336
|
</dd>
|
|
1334
1337
|
</dl>
|
|
1335
1338
|
</dd>
|
|
1336
1339
|
</dl>
|
|
1337
1340
|
|
|
1341
|
+
|
|
1338
1342
|
</dd>
|
|
1339
1343
|
</dl>
|
|
1340
1344
|
</details>
|
|
1341
1345
|
|
|
1342
|
-
|
|
1346
|
+
## AppSettings
|
|
1347
|
+
<details><summary><code>client.appSettings.<a href="/src/api/resources/appSettings/client/Client.ts">search</a>({ ...params }) -> MavenAGI.SearchAppSettingsResponse</code></summary>
|
|
1343
1348
|
<dl>
|
|
1344
1349
|
<dd>
|
|
1345
1350
|
|
|
@@ -1351,14 +1356,11 @@ await client.appSettings.get();
|
|
|
1351
1356
|
<dl>
|
|
1352
1357
|
<dd>
|
|
1353
1358
|
|
|
1354
|
-
|
|
1355
|
-
|
|
1356
|
-
- If a new key is provided, it will be added to the app settings.
|
|
1357
|
-
- If an existing key is provided, it will be updated.
|
|
1358
|
-
- No keys will be removed.
|
|
1359
|
+
Search for app settings which have the `$index` key set to the provided value.
|
|
1359
1360
|
|
|
1360
|
-
|
|
1361
|
+
You can set the `$index` key using the Update app settings API.
|
|
1361
1362
|
|
|
1363
|
+
<Warning>This API currently requires an organization ID and agent ID for any agent which is installed on the app. This requirement will be removed in a future update.</Warning>
|
|
1362
1364
|
</dd>
|
|
1363
1365
|
</dl>
|
|
1364
1366
|
</dd>
|
|
@@ -1373,13 +1375,11 @@ Note that if an array value is provided it will fully replace an existing value
|
|
|
1373
1375
|
<dd>
|
|
1374
1376
|
|
|
1375
1377
|
```typescript
|
|
1376
|
-
await client.appSettings.
|
|
1377
|
-
|
|
1378
|
-
key: "value",
|
|
1379
|
-
},
|
|
1378
|
+
await client.appSettings.search({
|
|
1379
|
+
index: "index"
|
|
1380
1380
|
});
|
|
1381
|
-
```
|
|
1382
1381
|
|
|
1382
|
+
```
|
|
1383
1383
|
</dd>
|
|
1384
1384
|
</dl>
|
|
1385
1385
|
</dd>
|
|
@@ -1393,28 +1393,27 @@ await client.appSettings.update({
|
|
|
1393
1393
|
<dl>
|
|
1394
1394
|
<dd>
|
|
1395
1395
|
|
|
1396
|
-
**request:** `
|
|
1397
|
-
|
|
1396
|
+
**request:** `MavenAGI.SearchAppSettingsRequest`
|
|
1397
|
+
|
|
1398
1398
|
</dd>
|
|
1399
1399
|
</dl>
|
|
1400
1400
|
|
|
1401
1401
|
<dl>
|
|
1402
1402
|
<dd>
|
|
1403
1403
|
|
|
1404
|
-
**requestOptions:** `AppSettings.RequestOptions`
|
|
1405
|
-
|
|
1404
|
+
**requestOptions:** `AppSettings.RequestOptions`
|
|
1405
|
+
|
|
1406
1406
|
</dd>
|
|
1407
1407
|
</dl>
|
|
1408
1408
|
</dd>
|
|
1409
1409
|
</dl>
|
|
1410
1410
|
|
|
1411
|
+
|
|
1411
1412
|
</dd>
|
|
1412
1413
|
</dl>
|
|
1413
1414
|
</details>
|
|
1414
1415
|
|
|
1415
|
-
|
|
1416
|
-
|
|
1417
|
-
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">initiateUpload</a>({ ...params }) -> MavenAGI.InitiateAssetUploadResponse</code></summary>
|
|
1416
|
+
<details><summary><code>client.appSettings.<a href="/src/api/resources/appSettings/client/Client.ts">get</a>() -> Record<string, unknown></code></summary>
|
|
1418
1417
|
<dl>
|
|
1419
1418
|
<dd>
|
|
1420
1419
|
|
|
@@ -1426,9 +1425,7 @@ await client.appSettings.update({
|
|
|
1426
1425
|
<dl>
|
|
1427
1426
|
<dd>
|
|
1428
1427
|
|
|
1429
|
-
|
|
1430
|
-
Returns a pre-signed URL for direct file upload and an asset ID for subsequent operations.
|
|
1431
|
-
|
|
1428
|
+
Get app settings set during installation
|
|
1432
1429
|
</dd>
|
|
1433
1430
|
</dl>
|
|
1434
1431
|
</dd>
|
|
@@ -1443,11 +1440,9 @@ Returns a pre-signed URL for direct file upload and an asset ID for subsequent o
|
|
|
1443
1440
|
<dd>
|
|
1444
1441
|
|
|
1445
1442
|
```typescript
|
|
1446
|
-
await client.
|
|
1447
|
-
type: "type",
|
|
1448
|
-
});
|
|
1449
|
-
```
|
|
1443
|
+
await client.appSettings.get();
|
|
1450
1444
|
|
|
1445
|
+
```
|
|
1451
1446
|
</dd>
|
|
1452
1447
|
</dl>
|
|
1453
1448
|
</dd>
|
|
@@ -1461,26 +1456,19 @@ await client.assets.initiateUpload({
|
|
|
1461
1456
|
<dl>
|
|
1462
1457
|
<dd>
|
|
1463
1458
|
|
|
1464
|
-
**
|
|
1465
|
-
|
|
1466
|
-
</dd>
|
|
1467
|
-
</dl>
|
|
1468
|
-
|
|
1469
|
-
<dl>
|
|
1470
|
-
<dd>
|
|
1471
|
-
|
|
1472
|
-
**requestOptions:** `Assets.RequestOptions`
|
|
1473
|
-
|
|
1459
|
+
**requestOptions:** `AppSettings.RequestOptions`
|
|
1460
|
+
|
|
1474
1461
|
</dd>
|
|
1475
1462
|
</dl>
|
|
1476
1463
|
</dd>
|
|
1477
1464
|
</dl>
|
|
1478
1465
|
|
|
1466
|
+
|
|
1479
1467
|
</dd>
|
|
1480
1468
|
</dl>
|
|
1481
1469
|
</details>
|
|
1482
1470
|
|
|
1483
|
-
<details><summary><code>client.
|
|
1471
|
+
<details><summary><code>client.appSettings.<a href="/src/api/resources/appSettings/client/Client.ts">update</a>({ ...params }) -> Record<string, unknown></code></summary>
|
|
1484
1472
|
<dl>
|
|
1485
1473
|
<dd>
|
|
1486
1474
|
|
|
@@ -1492,9 +1480,13 @@ await client.assets.initiateUpload({
|
|
|
1492
1480
|
<dl>
|
|
1493
1481
|
<dd>
|
|
1494
1482
|
|
|
1495
|
-
|
|
1496
|
-
|
|
1483
|
+
Update app settings. Performs a merge of the provided settings with the existing app settings.
|
|
1484
|
+
|
|
1485
|
+
- If a new key is provided, it will be added to the app settings.
|
|
1486
|
+
- If an existing key is provided, it will be updated.
|
|
1487
|
+
- No keys will be removed.
|
|
1497
1488
|
|
|
1489
|
+
Note that if an array value is provided it will fully replace an existing value as arrays cannot be merged.
|
|
1498
1490
|
</dd>
|
|
1499
1491
|
</dl>
|
|
1500
1492
|
</dd>
|
|
@@ -1509,9 +1501,13 @@ Updates the asset status and makes it available for use.
|
|
|
1509
1501
|
<dd>
|
|
1510
1502
|
|
|
1511
1503
|
```typescript
|
|
1512
|
-
await client.
|
|
1513
|
-
|
|
1504
|
+
await client.appSettings.update({
|
|
1505
|
+
"string": {
|
|
1506
|
+
"key": "value"
|
|
1507
|
+
}
|
|
1508
|
+
});
|
|
1514
1509
|
|
|
1510
|
+
```
|
|
1515
1511
|
</dd>
|
|
1516
1512
|
</dl>
|
|
1517
1513
|
</dd>
|
|
@@ -1525,36 +1521,28 @@ await client.assets.commitUpload("assetReferenceId", {});
|
|
|
1525
1521
|
<dl>
|
|
1526
1522
|
<dd>
|
|
1527
1523
|
|
|
1528
|
-
**
|
|
1529
|
-
|
|
1530
|
-
</dd>
|
|
1531
|
-
</dl>
|
|
1532
|
-
|
|
1533
|
-
<dl>
|
|
1534
|
-
<dd>
|
|
1535
|
-
|
|
1536
|
-
**request:** `MavenAGI.CommitAssetUploadRequest`
|
|
1537
|
-
|
|
1524
|
+
**request:** `Record<string, unknown>`
|
|
1525
|
+
|
|
1538
1526
|
</dd>
|
|
1539
1527
|
</dl>
|
|
1540
1528
|
|
|
1541
1529
|
<dl>
|
|
1542
1530
|
<dd>
|
|
1543
1531
|
|
|
1544
|
-
**requestOptions:** `
|
|
1545
|
-
|
|
1532
|
+
**requestOptions:** `AppSettings.RequestOptions`
|
|
1533
|
+
|
|
1546
1534
|
</dd>
|
|
1547
1535
|
</dl>
|
|
1548
1536
|
</dd>
|
|
1549
1537
|
</dl>
|
|
1550
1538
|
|
|
1539
|
+
|
|
1551
1540
|
</dd>
|
|
1552
1541
|
</dl>
|
|
1553
1542
|
</details>
|
|
1554
1543
|
|
|
1555
|
-
##
|
|
1556
|
-
|
|
1557
|
-
<details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">initialize</a>({ ...params }) -> MavenAGI.ConversationResponse</code></summary>
|
|
1544
|
+
## Assets
|
|
1545
|
+
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">initiateUpload</a>({ ...params }) -> MavenAGI.InitiateAssetUploadResponse</code></summary>
|
|
1558
1546
|
<dl>
|
|
1559
1547
|
<dd>
|
|
1560
1548
|
|
|
@@ -1566,19 +1554,12 @@ await client.assets.commitUpload("assetReferenceId", {});
|
|
|
1566
1554
|
<dl>
|
|
1567
1555
|
<dd>
|
|
1568
1556
|
|
|
1569
|
-
|
|
1570
|
-
|
|
1571
|
-
|
|
1572
|
-
|
|
1573
|
-
|
|
1574
|
-
|
|
1575
|
-
|
|
1576
|
-
- metadata can be changed using the `updateConversationMetadata` API.
|
|
1577
|
-
- messages can be added to the conversation with the `appendNewMessages` or `ask` APIs.
|
|
1578
|
-
</dd>
|
|
1579
|
-
</dl>
|
|
1580
|
-
</dd>
|
|
1581
|
-
</dl>
|
|
1557
|
+
Initiate an upload.
|
|
1558
|
+
Returns a pre-signed URL for direct file upload and an asset ID for subsequent operations.
|
|
1559
|
+
</dd>
|
|
1560
|
+
</dl>
|
|
1561
|
+
</dd>
|
|
1562
|
+
</dl>
|
|
1582
1563
|
|
|
1583
1564
|
#### 🔌 Usage
|
|
1584
1565
|
|
|
@@ -1589,35 +1570,75 @@ After initialization,
|
|
|
1589
1570
|
<dd>
|
|
1590
1571
|
|
|
1591
1572
|
```typescript
|
|
1592
|
-
await client.
|
|
1593
|
-
|
|
1594
|
-
referenceId: "x",
|
|
1595
|
-
},
|
|
1596
|
-
messages: [
|
|
1597
|
-
{
|
|
1598
|
-
conversationMessageId: {
|
|
1599
|
-
referenceId: "x",
|
|
1600
|
-
},
|
|
1601
|
-
userId: {
|
|
1602
|
-
referenceId: "x",
|
|
1603
|
-
},
|
|
1604
|
-
text: "text",
|
|
1605
|
-
userMessageType: "USER",
|
|
1606
|
-
},
|
|
1607
|
-
{
|
|
1608
|
-
conversationMessageId: {
|
|
1609
|
-
referenceId: "x",
|
|
1610
|
-
},
|
|
1611
|
-
userId: {
|
|
1612
|
-
referenceId: "x",
|
|
1613
|
-
},
|
|
1614
|
-
text: "text",
|
|
1615
|
-
userMessageType: "USER",
|
|
1616
|
-
},
|
|
1617
|
-
],
|
|
1573
|
+
await client.assets.initiateUpload({
|
|
1574
|
+
type: "type"
|
|
1618
1575
|
});
|
|
1576
|
+
|
|
1619
1577
|
```
|
|
1578
|
+
</dd>
|
|
1579
|
+
</dl>
|
|
1580
|
+
</dd>
|
|
1581
|
+
</dl>
|
|
1582
|
+
|
|
1583
|
+
#### ⚙️ Parameters
|
|
1584
|
+
|
|
1585
|
+
<dl>
|
|
1586
|
+
<dd>
|
|
1587
|
+
|
|
1588
|
+
<dl>
|
|
1589
|
+
<dd>
|
|
1590
|
+
|
|
1591
|
+
**request:** `MavenAGI.InitiateAssetUploadRequest`
|
|
1592
|
+
|
|
1593
|
+
</dd>
|
|
1594
|
+
</dl>
|
|
1595
|
+
|
|
1596
|
+
<dl>
|
|
1597
|
+
<dd>
|
|
1598
|
+
|
|
1599
|
+
**requestOptions:** `Assets.RequestOptions`
|
|
1600
|
+
|
|
1601
|
+
</dd>
|
|
1602
|
+
</dl>
|
|
1603
|
+
</dd>
|
|
1604
|
+
</dl>
|
|
1605
|
+
|
|
1606
|
+
|
|
1607
|
+
</dd>
|
|
1608
|
+
</dl>
|
|
1609
|
+
</details>
|
|
1620
1610
|
|
|
1611
|
+
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">commitUpload</a>(assetReferenceId, { ...params }) -> void</code></summary>
|
|
1612
|
+
<dl>
|
|
1613
|
+
<dd>
|
|
1614
|
+
|
|
1615
|
+
#### 📝 Description
|
|
1616
|
+
|
|
1617
|
+
<dl>
|
|
1618
|
+
<dd>
|
|
1619
|
+
|
|
1620
|
+
<dl>
|
|
1621
|
+
<dd>
|
|
1622
|
+
|
|
1623
|
+
Commit an upload after successful file transfer.
|
|
1624
|
+
Updates the asset status and makes it available for use.
|
|
1625
|
+
</dd>
|
|
1626
|
+
</dl>
|
|
1627
|
+
</dd>
|
|
1628
|
+
</dl>
|
|
1629
|
+
|
|
1630
|
+
#### 🔌 Usage
|
|
1631
|
+
|
|
1632
|
+
<dl>
|
|
1633
|
+
<dd>
|
|
1634
|
+
|
|
1635
|
+
<dl>
|
|
1636
|
+
<dd>
|
|
1637
|
+
|
|
1638
|
+
```typescript
|
|
1639
|
+
await client.assets.commitUpload("assetReferenceId", {});
|
|
1640
|
+
|
|
1641
|
+
```
|
|
1621
1642
|
</dd>
|
|
1622
1643
|
</dl>
|
|
1623
1644
|
</dd>
|
|
@@ -1631,21 +1652,124 @@ await client.conversation.initialize({
|
|
|
1631
1652
|
<dl>
|
|
1632
1653
|
<dd>
|
|
1633
1654
|
|
|
1634
|
-
**
|
|
1655
|
+
**assetReferenceId:** `string` — The reference ID of the asset to commit (provided by the initiate call). All other entity ID fields are inferred from the API request.
|
|
1656
|
+
|
|
1657
|
+
</dd>
|
|
1658
|
+
</dl>
|
|
1659
|
+
|
|
1660
|
+
<dl>
|
|
1661
|
+
<dd>
|
|
1662
|
+
|
|
1663
|
+
**request:** `MavenAGI.CommitAssetUploadRequest`
|
|
1664
|
+
|
|
1665
|
+
</dd>
|
|
1666
|
+
</dl>
|
|
1667
|
+
|
|
1668
|
+
<dl>
|
|
1669
|
+
<dd>
|
|
1670
|
+
|
|
1671
|
+
**requestOptions:** `Assets.RequestOptions`
|
|
1672
|
+
|
|
1673
|
+
</dd>
|
|
1674
|
+
</dl>
|
|
1675
|
+
</dd>
|
|
1676
|
+
</dl>
|
|
1677
|
+
|
|
1678
|
+
|
|
1679
|
+
</dd>
|
|
1680
|
+
</dl>
|
|
1681
|
+
</details>
|
|
1682
|
+
|
|
1683
|
+
## Conversation
|
|
1684
|
+
<details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">initialize</a>({ ...params }) -> MavenAGI.ConversationResponse</code></summary>
|
|
1685
|
+
<dl>
|
|
1686
|
+
<dd>
|
|
1687
|
+
|
|
1688
|
+
#### 📝 Description
|
|
1689
|
+
|
|
1690
|
+
<dl>
|
|
1691
|
+
<dd>
|
|
1692
|
+
|
|
1693
|
+
<dl>
|
|
1694
|
+
<dd>
|
|
1695
|
+
|
|
1696
|
+
Initialize a new conversation.
|
|
1697
|
+
Only required if the ask request wishes to supply conversation level data or when syncing to external systems.
|
|
1698
|
+
|
|
1699
|
+
Conversations can not be modified using this API. If the conversation already exists then the existing conversation will be returned.
|
|
1700
|
+
|
|
1701
|
+
After initialization,
|
|
1702
|
+
- metadata can be changed using the `updateConversationMetadata` API.
|
|
1703
|
+
- messages can be added to the conversation with the `appendNewMessages` or `ask` APIs.
|
|
1704
|
+
</dd>
|
|
1705
|
+
</dl>
|
|
1706
|
+
</dd>
|
|
1707
|
+
</dl>
|
|
1708
|
+
|
|
1709
|
+
#### 🔌 Usage
|
|
1710
|
+
|
|
1711
|
+
<dl>
|
|
1712
|
+
<dd>
|
|
1713
|
+
|
|
1714
|
+
<dl>
|
|
1715
|
+
<dd>
|
|
1716
|
+
|
|
1717
|
+
```typescript
|
|
1718
|
+
await client.conversation.initialize({
|
|
1719
|
+
conversationId: {
|
|
1720
|
+
referenceId: "x"
|
|
1721
|
+
},
|
|
1722
|
+
messages: [{
|
|
1723
|
+
conversationMessageId: {
|
|
1724
|
+
referenceId: "x"
|
|
1725
|
+
},
|
|
1726
|
+
userId: {
|
|
1727
|
+
referenceId: "x"
|
|
1728
|
+
},
|
|
1729
|
+
text: "text",
|
|
1730
|
+
userMessageType: "USER"
|
|
1731
|
+
}, {
|
|
1732
|
+
conversationMessageId: {
|
|
1733
|
+
referenceId: "x"
|
|
1734
|
+
},
|
|
1735
|
+
userId: {
|
|
1736
|
+
referenceId: "x"
|
|
1737
|
+
},
|
|
1738
|
+
text: "text",
|
|
1739
|
+
userMessageType: "USER"
|
|
1740
|
+
}]
|
|
1741
|
+
});
|
|
1635
1742
|
|
|
1743
|
+
```
|
|
1744
|
+
</dd>
|
|
1745
|
+
</dl>
|
|
1636
1746
|
</dd>
|
|
1637
1747
|
</dl>
|
|
1638
1748
|
|
|
1749
|
+
#### ⚙️ Parameters
|
|
1750
|
+
|
|
1751
|
+
<dl>
|
|
1752
|
+
<dd>
|
|
1753
|
+
|
|
1639
1754
|
<dl>
|
|
1640
1755
|
<dd>
|
|
1641
1756
|
|
|
1642
|
-
**
|
|
1757
|
+
**request:** `MavenAGI.ConversationRequest`
|
|
1758
|
+
|
|
1759
|
+
</dd>
|
|
1760
|
+
</dl>
|
|
1761
|
+
|
|
1762
|
+
<dl>
|
|
1763
|
+
<dd>
|
|
1643
1764
|
|
|
1765
|
+
**requestOptions:** `Conversation.RequestOptions`
|
|
1766
|
+
|
|
1644
1767
|
</dd>
|
|
1645
1768
|
</dl>
|
|
1646
1769
|
</dd>
|
|
1647
1770
|
</dl>
|
|
1648
1771
|
|
|
1772
|
+
|
|
1649
1773
|
</dd>
|
|
1650
1774
|
</dl>
|
|
1651
1775
|
</details>
|
|
@@ -1662,11 +1786,10 @@ await client.conversation.initialize({
|
|
|
1662
1786
|
<dl>
|
|
1663
1787
|
<dd>
|
|
1664
1788
|
|
|
1665
|
-
Update mutable conversation fields.
|
|
1789
|
+
Update mutable conversation fields.
|
|
1666
1790
|
|
|
1667
|
-
The `appId` field can be provided to update a conversation owned by a different app.
|
|
1791
|
+
The `appId` field can be provided to update a conversation owned by a different app.
|
|
1668
1792
|
All other fields will overwrite the existing value on the conversation only if provided.
|
|
1669
|
-
|
|
1670
1793
|
</dd>
|
|
1671
1794
|
</dl>
|
|
1672
1795
|
</dd>
|
|
@@ -1682,10 +1805,10 @@ All other fields will overwrite the existing value on the conversation only if p
|
|
|
1682
1805
|
|
|
1683
1806
|
```typescript
|
|
1684
1807
|
await client.conversation.patch("conversation-0", {
|
|
1685
|
-
llmEnabled: true
|
|
1808
|
+
llmEnabled: true
|
|
1686
1809
|
});
|
|
1687
|
-
```
|
|
1688
1810
|
|
|
1811
|
+
```
|
|
1689
1812
|
</dd>
|
|
1690
1813
|
</dl>
|
|
1691
1814
|
</dd>
|
|
@@ -1700,28 +1823,29 @@ await client.conversation.patch("conversation-0", {
|
|
|
1700
1823
|
<dd>
|
|
1701
1824
|
|
|
1702
1825
|
**conversationId:** `string` — The ID of the conversation to patch
|
|
1703
|
-
|
|
1826
|
+
|
|
1704
1827
|
</dd>
|
|
1705
1828
|
</dl>
|
|
1706
1829
|
|
|
1707
1830
|
<dl>
|
|
1708
1831
|
<dd>
|
|
1709
1832
|
|
|
1710
|
-
**request:** `MavenAGI.ConversationPatchRequest`
|
|
1711
|
-
|
|
1833
|
+
**request:** `MavenAGI.ConversationPatchRequest`
|
|
1834
|
+
|
|
1712
1835
|
</dd>
|
|
1713
1836
|
</dl>
|
|
1714
1837
|
|
|
1715
1838
|
<dl>
|
|
1716
1839
|
<dd>
|
|
1717
1840
|
|
|
1718
|
-
**requestOptions:** `Conversation.RequestOptions`
|
|
1719
|
-
|
|
1841
|
+
**requestOptions:** `Conversation.RequestOptions`
|
|
1842
|
+
|
|
1720
1843
|
</dd>
|
|
1721
1844
|
</dl>
|
|
1722
1845
|
</dd>
|
|
1723
1846
|
</dl>
|
|
1724
1847
|
|
|
1848
|
+
|
|
1725
1849
|
</dd>
|
|
1726
1850
|
</dl>
|
|
1727
1851
|
</details>
|
|
@@ -1739,7 +1863,6 @@ await client.conversation.patch("conversation-0", {
|
|
|
1739
1863
|
<dd>
|
|
1740
1864
|
|
|
1741
1865
|
Get a conversation
|
|
1742
|
-
|
|
1743
1866
|
</dd>
|
|
1744
1867
|
</dl>
|
|
1745
1868
|
</dd>
|
|
@@ -1755,8 +1878,8 @@ Get a conversation
|
|
|
1755
1878
|
|
|
1756
1879
|
```typescript
|
|
1757
1880
|
await client.conversation.get("conversationId");
|
|
1758
|
-
```
|
|
1759
1881
|
|
|
1882
|
+
```
|
|
1760
1883
|
</dd>
|
|
1761
1884
|
</dl>
|
|
1762
1885
|
</dd>
|
|
@@ -1771,28 +1894,29 @@ await client.conversation.get("conversationId");
|
|
|
1771
1894
|
<dd>
|
|
1772
1895
|
|
|
1773
1896
|
**conversationId:** `string` — The ID of the conversation to get
|
|
1774
|
-
|
|
1897
|
+
|
|
1775
1898
|
</dd>
|
|
1776
1899
|
</dl>
|
|
1777
1900
|
|
|
1778
1901
|
<dl>
|
|
1779
1902
|
<dd>
|
|
1780
1903
|
|
|
1781
|
-
**request:** `MavenAGI.ConversationGetRequest`
|
|
1782
|
-
|
|
1904
|
+
**request:** `MavenAGI.ConversationGetRequest`
|
|
1905
|
+
|
|
1783
1906
|
</dd>
|
|
1784
1907
|
</dl>
|
|
1785
1908
|
|
|
1786
1909
|
<dl>
|
|
1787
1910
|
<dd>
|
|
1788
1911
|
|
|
1789
|
-
**requestOptions:** `Conversation.RequestOptions`
|
|
1790
|
-
|
|
1912
|
+
**requestOptions:** `Conversation.RequestOptions`
|
|
1913
|
+
|
|
1791
1914
|
</dd>
|
|
1792
1915
|
</dl>
|
|
1793
1916
|
</dd>
|
|
1794
1917
|
</dl>
|
|
1795
1918
|
|
|
1919
|
+
|
|
1796
1920
|
</dd>
|
|
1797
1921
|
</dl>
|
|
1798
1922
|
</details>
|
|
@@ -1809,17 +1933,16 @@ await client.conversation.get("conversationId");
|
|
|
1809
1933
|
<dl>
|
|
1810
1934
|
<dd>
|
|
1811
1935
|
|
|
1812
|
-
Wipes a conversation of all user data.
|
|
1813
|
-
The conversation ID will still exist and non-user specific data will still be retained.
|
|
1814
|
-
Attempts to modify or add messages to the conversation will throw an error.
|
|
1936
|
+
Wipes a conversation of all user data.
|
|
1937
|
+
The conversation ID will still exist and non-user specific data will still be retained.
|
|
1938
|
+
Attempts to modify or add messages to the conversation will throw an error.
|
|
1815
1939
|
|
|
1816
|
-
Simulation conversations will no longer be visible in search results nor metrics.
|
|
1940
|
+
Simulation conversations will no longer be visible in search results nor metrics.
|
|
1817
1941
|
Non-simulation conversations will remain visible - they can not be fully removed from the system.
|
|
1818
1942
|
|
|
1819
1943
|
<Warning>This is a destructive operation and cannot be undone. <br/><br/>
|
|
1820
|
-
The exact fields cleared include: the conversation subject, userRequest, agentResponse.
|
|
1944
|
+
The exact fields cleared include: the conversation subject, userRequest, agentResponse.
|
|
1821
1945
|
As well as the text response, followup questions, and backend LLM prompt of all messages.</Warning>
|
|
1822
|
-
|
|
1823
1946
|
</dd>
|
|
1824
1947
|
</dl>
|
|
1825
1948
|
</dd>
|
|
@@ -1835,10 +1958,10 @@ As well as the text response, followup questions, and backend LLM prompt of all
|
|
|
1835
1958
|
|
|
1836
1959
|
```typescript
|
|
1837
1960
|
await client.conversation.delete("conversation-0", {
|
|
1838
|
-
reason: "GDPR deletion request 1234."
|
|
1961
|
+
reason: "GDPR deletion request 1234."
|
|
1839
1962
|
});
|
|
1840
|
-
```
|
|
1841
1963
|
|
|
1964
|
+
```
|
|
1842
1965
|
</dd>
|
|
1843
1966
|
</dl>
|
|
1844
1967
|
</dd>
|
|
@@ -1853,28 +1976,29 @@ await client.conversation.delete("conversation-0", {
|
|
|
1853
1976
|
<dd>
|
|
1854
1977
|
|
|
1855
1978
|
**conversationId:** `string` — The ID of the conversation to delete
|
|
1856
|
-
|
|
1979
|
+
|
|
1857
1980
|
</dd>
|
|
1858
1981
|
</dl>
|
|
1859
1982
|
|
|
1860
1983
|
<dl>
|
|
1861
1984
|
<dd>
|
|
1862
1985
|
|
|
1863
|
-
**request:** `MavenAGI.ConversationDeleteRequest`
|
|
1864
|
-
|
|
1986
|
+
**request:** `MavenAGI.ConversationDeleteRequest`
|
|
1987
|
+
|
|
1865
1988
|
</dd>
|
|
1866
1989
|
</dl>
|
|
1867
1990
|
|
|
1868
1991
|
<dl>
|
|
1869
1992
|
<dd>
|
|
1870
1993
|
|
|
1871
|
-
**requestOptions:** `Conversation.RequestOptions`
|
|
1872
|
-
|
|
1994
|
+
**requestOptions:** `Conversation.RequestOptions`
|
|
1995
|
+
|
|
1873
1996
|
</dd>
|
|
1874
1997
|
</dl>
|
|
1875
1998
|
</dd>
|
|
1876
1999
|
</dl>
|
|
1877
2000
|
|
|
2001
|
+
|
|
1878
2002
|
</dd>
|
|
1879
2003
|
</dl>
|
|
1880
2004
|
</details>
|
|
@@ -1892,7 +2016,6 @@ await client.conversation.delete("conversation-0", {
|
|
|
1892
2016
|
<dd>
|
|
1893
2017
|
|
|
1894
2018
|
Append messages to an existing conversation. The conversation must be initialized first. If a message with the same ID already exists, it will be ignored. Messages do not allow modification.
|
|
1895
|
-
|
|
1896
2019
|
</dd>
|
|
1897
2020
|
</dl>
|
|
1898
2021
|
</dd>
|
|
@@ -1907,30 +2030,27 @@ Append messages to an existing conversation. The conversation must be initialize
|
|
|
1907
2030
|
<dd>
|
|
1908
2031
|
|
|
1909
2032
|
```typescript
|
|
1910
|
-
await client.conversation.appendNewMessages("conversationId", [
|
|
1911
|
-
{
|
|
2033
|
+
await client.conversation.appendNewMessages("conversationId", [{
|
|
1912
2034
|
conversationMessageId: {
|
|
1913
|
-
referenceId: "x"
|
|
2035
|
+
referenceId: "x"
|
|
1914
2036
|
},
|
|
1915
2037
|
userId: {
|
|
1916
|
-
referenceId: "x"
|
|
2038
|
+
referenceId: "x"
|
|
1917
2039
|
},
|
|
1918
2040
|
text: "text",
|
|
1919
|
-
userMessageType: "USER"
|
|
1920
|
-
},
|
|
1921
|
-
{
|
|
2041
|
+
userMessageType: "USER"
|
|
2042
|
+
}, {
|
|
1922
2043
|
conversationMessageId: {
|
|
1923
|
-
referenceId: "x"
|
|
2044
|
+
referenceId: "x"
|
|
1924
2045
|
},
|
|
1925
2046
|
userId: {
|
|
1926
|
-
referenceId: "x"
|
|
2047
|
+
referenceId: "x"
|
|
1927
2048
|
},
|
|
1928
2049
|
text: "text",
|
|
1929
|
-
userMessageType: "USER"
|
|
1930
|
-
}
|
|
1931
|
-
]);
|
|
1932
|
-
```
|
|
2050
|
+
userMessageType: "USER"
|
|
2051
|
+
}]);
|
|
1933
2052
|
|
|
2053
|
+
```
|
|
1934
2054
|
</dd>
|
|
1935
2055
|
</dl>
|
|
1936
2056
|
</dd>
|
|
@@ -1945,28 +2065,29 @@ await client.conversation.appendNewMessages("conversationId", [
|
|
|
1945
2065
|
<dd>
|
|
1946
2066
|
|
|
1947
2067
|
**conversationId:** `string` — The ID of the conversation to append messages to
|
|
1948
|
-
|
|
2068
|
+
|
|
1949
2069
|
</dd>
|
|
1950
2070
|
</dl>
|
|
1951
2071
|
|
|
1952
2072
|
<dl>
|
|
1953
2073
|
<dd>
|
|
1954
2074
|
|
|
1955
|
-
**request:** `MavenAGI.ConversationMessageRequest[]`
|
|
1956
|
-
|
|
2075
|
+
**request:** `MavenAGI.ConversationMessageRequest[]`
|
|
2076
|
+
|
|
1957
2077
|
</dd>
|
|
1958
2078
|
</dl>
|
|
1959
2079
|
|
|
1960
2080
|
<dl>
|
|
1961
2081
|
<dd>
|
|
1962
2082
|
|
|
1963
|
-
**requestOptions:** `Conversation.RequestOptions`
|
|
1964
|
-
|
|
2083
|
+
**requestOptions:** `Conversation.RequestOptions`
|
|
2084
|
+
|
|
1965
2085
|
</dd>
|
|
1966
2086
|
</dl>
|
|
1967
2087
|
</dd>
|
|
1968
2088
|
</dl>
|
|
1969
2089
|
|
|
2090
|
+
|
|
1970
2091
|
</dd>
|
|
1971
2092
|
</dl>
|
|
1972
2093
|
</details>
|
|
@@ -1983,21 +2104,19 @@ await client.conversation.appendNewMessages("conversationId", [
|
|
|
1983
2104
|
<dl>
|
|
1984
2105
|
<dd>
|
|
1985
2106
|
|
|
1986
|
-
Get an answer from Maven for a given user question. If the user question or its answer already exists,
|
|
1987
|
-
they will be reused and will not be updated. Messages do not allow modification once generated.
|
|
2107
|
+
Get an answer from Maven for a given user question. If the user question or its answer already exists,
|
|
2108
|
+
they will be reused and will not be updated. Messages do not allow modification once generated.
|
|
1988
2109
|
|
|
1989
2110
|
Concurrency Behavior:
|
|
1990
|
-
|
|
1991
2111
|
- If another API call is made for the same user question while a response is mid-stream, partial answers may be returned.
|
|
1992
2112
|
- The second caller will receive a truncated or partial response depending on where the first stream is in its processing. The first caller's stream will remain unaffected and continue delivering the full response.
|
|
1993
2113
|
|
|
1994
2114
|
Known Limitation:
|
|
1995
|
-
|
|
1996
2115
|
- The API does not currently expose metadata indicating whether a response or message is incomplete. This will be addressed in a future update.
|
|
1997
|
-
|
|
1998
|
-
|
|
1999
|
-
|
|
2000
|
-
|
|
2116
|
+
</dd>
|
|
2117
|
+
</dl>
|
|
2118
|
+
</dd>
|
|
2119
|
+
</dl>
|
|
2001
2120
|
|
|
2002
2121
|
#### 🔌 Usage
|
|
2003
2122
|
|
|
@@ -2010,26 +2129,24 @@ Known Limitation:
|
|
|
2010
2129
|
```typescript
|
|
2011
2130
|
await client.conversation.ask("conversation-0", {
|
|
2012
2131
|
conversationMessageId: {
|
|
2013
|
-
referenceId: "message-0"
|
|
2132
|
+
referenceId: "message-0"
|
|
2014
2133
|
},
|
|
2015
2134
|
userId: {
|
|
2016
|
-
referenceId: "user-0"
|
|
2135
|
+
referenceId: "user-0"
|
|
2017
2136
|
},
|
|
2018
2137
|
text: "How do I reset my password?",
|
|
2019
|
-
attachments: [
|
|
2020
|
-
{
|
|
2138
|
+
attachments: [{
|
|
2021
2139
|
type: "image/png",
|
|
2022
|
-
content: "iVBORw0KGgo..."
|
|
2023
|
-
},
|
|
2024
|
-
],
|
|
2140
|
+
content: "iVBORw0KGgo..."
|
|
2141
|
+
}],
|
|
2025
2142
|
transientData: {
|
|
2026
|
-
userToken: "abcdef123",
|
|
2027
|
-
queryApiKey: "foobar456"
|
|
2143
|
+
"userToken": "abcdef123",
|
|
2144
|
+
"queryApiKey": "foobar456"
|
|
2028
2145
|
},
|
|
2029
|
-
timezone: "America/New_York"
|
|
2146
|
+
timezone: "America/New_York"
|
|
2030
2147
|
});
|
|
2031
|
-
```
|
|
2032
2148
|
|
|
2149
|
+
```
|
|
2033
2150
|
</dd>
|
|
2034
2151
|
</dl>
|
|
2035
2152
|
</dd>
|
|
@@ -2044,28 +2161,29 @@ await client.conversation.ask("conversation-0", {
|
|
|
2044
2161
|
<dd>
|
|
2045
2162
|
|
|
2046
2163
|
**conversationId:** `string` — The ID of a new or existing conversation to use as context for the question
|
|
2047
|
-
|
|
2164
|
+
|
|
2048
2165
|
</dd>
|
|
2049
2166
|
</dl>
|
|
2050
2167
|
|
|
2051
2168
|
<dl>
|
|
2052
2169
|
<dd>
|
|
2053
2170
|
|
|
2054
|
-
**request:** `MavenAGI.AskRequest`
|
|
2055
|
-
|
|
2171
|
+
**request:** `MavenAGI.AskRequest`
|
|
2172
|
+
|
|
2056
2173
|
</dd>
|
|
2057
2174
|
</dl>
|
|
2058
2175
|
|
|
2059
2176
|
<dl>
|
|
2060
2177
|
<dd>
|
|
2061
2178
|
|
|
2062
|
-
**requestOptions:** `Conversation.RequestOptions`
|
|
2063
|
-
|
|
2179
|
+
**requestOptions:** `Conversation.RequestOptions`
|
|
2180
|
+
|
|
2064
2181
|
</dd>
|
|
2065
2182
|
</dl>
|
|
2066
2183
|
</dd>
|
|
2067
2184
|
</dl>
|
|
2068
2185
|
|
|
2186
|
+
|
|
2069
2187
|
</dd>
|
|
2070
2188
|
</dl>
|
|
2071
2189
|
</details>
|
|
@@ -2082,25 +2200,23 @@ await client.conversation.ask("conversation-0", {
|
|
|
2082
2200
|
<dl>
|
|
2083
2201
|
<dd>
|
|
2084
2202
|
|
|
2085
|
-
Get an answer from Maven for a given user question with a streaming response. The response will be sent as a stream of events.
|
|
2086
|
-
The text portions of stream responses should be concatenated to form the full response text.
|
|
2203
|
+
Get an answer from Maven for a given user question with a streaming response. The response will be sent as a stream of events.
|
|
2204
|
+
The text portions of stream responses should be concatenated to form the full response text.
|
|
2087
2205
|
Action and metadata events should overwrite past data and do not need concatenation.
|
|
2088
2206
|
|
|
2089
|
-
If the user question or its answer already exists, they will be reused and will not be updated.
|
|
2207
|
+
If the user question or its answer already exists, they will be reused and will not be updated.
|
|
2090
2208
|
Messages do not allow modification once generated.
|
|
2091
|
-
|
|
2209
|
+
|
|
2092
2210
|
Concurrency Behavior:
|
|
2093
|
-
|
|
2094
2211
|
- If another API call is made for the same user question while a response is mid-stream, partial answers may be returned.
|
|
2095
2212
|
- The second caller will receive a truncated or partial response depending on where the first stream is in its processing. The first caller's stream will remain unaffected and continue delivering the full response.
|
|
2096
2213
|
|
|
2097
2214
|
Known Limitation:
|
|
2098
|
-
|
|
2099
2215
|
- The API does not currently expose metadata indicating whether a response or message is incomplete. This will be addressed in a future update.
|
|
2100
|
-
|
|
2101
|
-
|
|
2102
|
-
|
|
2103
|
-
|
|
2216
|
+
</dd>
|
|
2217
|
+
</dl>
|
|
2218
|
+
</dd>
|
|
2219
|
+
</dl>
|
|
2104
2220
|
|
|
2105
2221
|
#### 🔌 Usage
|
|
2106
2222
|
|
|
@@ -2113,29 +2229,27 @@ Known Limitation:
|
|
|
2113
2229
|
```typescript
|
|
2114
2230
|
const response = await client.conversation.askStream("conversation-0", {
|
|
2115
2231
|
conversationMessageId: {
|
|
2116
|
-
referenceId: "message-0"
|
|
2232
|
+
referenceId: "message-0"
|
|
2117
2233
|
},
|
|
2118
2234
|
userId: {
|
|
2119
|
-
referenceId: "user-0"
|
|
2235
|
+
referenceId: "user-0"
|
|
2120
2236
|
},
|
|
2121
2237
|
text: "How do I reset my password?",
|
|
2122
|
-
attachments: [
|
|
2123
|
-
{
|
|
2238
|
+
attachments: [{
|
|
2124
2239
|
type: "image/png",
|
|
2125
|
-
content: "iVBORw0KGgo..."
|
|
2126
|
-
},
|
|
2127
|
-
],
|
|
2240
|
+
content: "iVBORw0KGgo..."
|
|
2241
|
+
}],
|
|
2128
2242
|
transientData: {
|
|
2129
|
-
userToken: "abcdef123",
|
|
2130
|
-
queryApiKey: "foobar456"
|
|
2243
|
+
"userToken": "abcdef123",
|
|
2244
|
+
"queryApiKey": "foobar456"
|
|
2131
2245
|
},
|
|
2132
|
-
timezone: "America/New_York"
|
|
2246
|
+
timezone: "America/New_York"
|
|
2133
2247
|
});
|
|
2134
2248
|
for await (const item of response) {
|
|
2135
2249
|
console.log(item);
|
|
2136
2250
|
}
|
|
2137
|
-
```
|
|
2138
2251
|
|
|
2252
|
+
```
|
|
2139
2253
|
</dd>
|
|
2140
2254
|
</dl>
|
|
2141
2255
|
</dd>
|
|
@@ -2150,28 +2264,29 @@ for await (const item of response) {
|
|
|
2150
2264
|
<dd>
|
|
2151
2265
|
|
|
2152
2266
|
**conversationId:** `string` — The ID of a new or existing conversation to use as context for the question
|
|
2153
|
-
|
|
2267
|
+
|
|
2154
2268
|
</dd>
|
|
2155
2269
|
</dl>
|
|
2156
2270
|
|
|
2157
2271
|
<dl>
|
|
2158
2272
|
<dd>
|
|
2159
2273
|
|
|
2160
|
-
**request:** `MavenAGI.AskRequest`
|
|
2161
|
-
|
|
2274
|
+
**request:** `MavenAGI.AskRequest`
|
|
2275
|
+
|
|
2162
2276
|
</dd>
|
|
2163
2277
|
</dl>
|
|
2164
2278
|
|
|
2165
2279
|
<dl>
|
|
2166
2280
|
<dd>
|
|
2167
2281
|
|
|
2168
|
-
**requestOptions:** `Conversation.RequestOptions`
|
|
2169
|
-
|
|
2282
|
+
**requestOptions:** `Conversation.RequestOptions`
|
|
2283
|
+
|
|
2170
2284
|
</dd>
|
|
2171
2285
|
</dl>
|
|
2172
2286
|
</dd>
|
|
2173
2287
|
</dl>
|
|
2174
2288
|
|
|
2289
|
+
|
|
2175
2290
|
</dd>
|
|
2176
2291
|
</dl>
|
|
2177
2292
|
</details>
|
|
@@ -2188,25 +2303,23 @@ for await (const item of response) {
|
|
|
2188
2303
|
<dl>
|
|
2189
2304
|
<dd>
|
|
2190
2305
|
|
|
2191
|
-
Generate a structured object response based on a provided schema and user prompt with a streaming response.
|
|
2306
|
+
Generate a structured object response based on a provided schema and user prompt with a streaming response.
|
|
2192
2307
|
The response will be sent as a stream of events containing text, start, and end events.
|
|
2193
2308
|
The text portions of stream responses should be concatenated to form the full response text.
|
|
2194
2309
|
|
|
2195
2310
|
If the user question and object response already exist, they will be reused and not updated.
|
|
2196
2311
|
|
|
2197
2312
|
Concurrency Behavior:
|
|
2198
|
-
|
|
2199
2313
|
- If another API call is made for the same user question while a response is mid-stream, partial answers may be returned.
|
|
2200
2314
|
- The second caller will receive a truncated or partial response depending on where the first stream is in its processing. The first caller's stream will remain unaffected and continue delivering the full response.
|
|
2201
2315
|
|
|
2202
2316
|
Known Limitations:
|
|
2203
|
-
|
|
2204
2317
|
- Schema enforcement is best-effort and may not guarantee exact conformity.
|
|
2205
2318
|
- The API does not currently expose metadata indicating whether a response or message is incomplete. This will be addressed in a future update.
|
|
2206
|
-
|
|
2207
|
-
|
|
2208
|
-
|
|
2209
|
-
|
|
2319
|
+
</dd>
|
|
2320
|
+
</dl>
|
|
2321
|
+
</dd>
|
|
2322
|
+
</dl>
|
|
2210
2323
|
|
|
2211
2324
|
#### 🔌 Usage
|
|
2212
2325
|
|
|
@@ -2220,18 +2333,18 @@ Known Limitations:
|
|
|
2220
2333
|
const response = await client.conversation.askObjectStream("conversationId", {
|
|
2221
2334
|
schema: "schema",
|
|
2222
2335
|
conversationMessageId: {
|
|
2223
|
-
referenceId: "x"
|
|
2336
|
+
referenceId: "x"
|
|
2224
2337
|
},
|
|
2225
2338
|
userId: {
|
|
2226
|
-
referenceId: "x"
|
|
2339
|
+
referenceId: "x"
|
|
2227
2340
|
},
|
|
2228
|
-
text: "text"
|
|
2341
|
+
text: "text"
|
|
2229
2342
|
});
|
|
2230
2343
|
for await (const item of response) {
|
|
2231
2344
|
console.log(item);
|
|
2232
2345
|
}
|
|
2233
|
-
```
|
|
2234
2346
|
|
|
2347
|
+
```
|
|
2235
2348
|
</dd>
|
|
2236
2349
|
</dl>
|
|
2237
2350
|
</dd>
|
|
@@ -2246,28 +2359,29 @@ for await (const item of response) {
|
|
|
2246
2359
|
<dd>
|
|
2247
2360
|
|
|
2248
2361
|
**conversationId:** `string` — The ID of a new or existing conversation to use as context for the object generation request
|
|
2249
|
-
|
|
2362
|
+
|
|
2250
2363
|
</dd>
|
|
2251
2364
|
</dl>
|
|
2252
2365
|
|
|
2253
2366
|
<dl>
|
|
2254
2367
|
<dd>
|
|
2255
2368
|
|
|
2256
|
-
**request:** `MavenAGI.AskObjectRequest`
|
|
2257
|
-
|
|
2369
|
+
**request:** `MavenAGI.AskObjectRequest`
|
|
2370
|
+
|
|
2258
2371
|
</dd>
|
|
2259
2372
|
</dl>
|
|
2260
2373
|
|
|
2261
2374
|
<dl>
|
|
2262
2375
|
<dd>
|
|
2263
2376
|
|
|
2264
|
-
**requestOptions:** `Conversation.RequestOptions`
|
|
2265
|
-
|
|
2377
|
+
**requestOptions:** `Conversation.RequestOptions`
|
|
2378
|
+
|
|
2266
2379
|
</dd>
|
|
2267
2380
|
</dl>
|
|
2268
2381
|
</dd>
|
|
2269
2382
|
</dl>
|
|
2270
2383
|
|
|
2384
|
+
|
|
2271
2385
|
</dd>
|
|
2272
2386
|
</dl>
|
|
2273
2387
|
</details>
|
|
@@ -2285,7 +2399,6 @@ for await (const item of response) {
|
|
|
2285
2399
|
<dd>
|
|
2286
2400
|
|
|
2287
2401
|
Uses an LLM flow to categorize the conversation. Experimental.
|
|
2288
|
-
|
|
2289
2402
|
</dd>
|
|
2290
2403
|
</dl>
|
|
2291
2404
|
</dd>
|
|
@@ -2301,8 +2414,8 @@ Uses an LLM flow to categorize the conversation. Experimental.
|
|
|
2301
2414
|
|
|
2302
2415
|
```typescript
|
|
2303
2416
|
await client.conversation.categorize("conversationId");
|
|
2304
|
-
```
|
|
2305
2417
|
|
|
2418
|
+
```
|
|
2306
2419
|
</dd>
|
|
2307
2420
|
</dl>
|
|
2308
2421
|
</dd>
|
|
@@ -2317,20 +2430,21 @@ await client.conversation.categorize("conversationId");
|
|
|
2317
2430
|
<dd>
|
|
2318
2431
|
|
|
2319
2432
|
**conversationId:** `string` — The ID of the conversation to categorize
|
|
2320
|
-
|
|
2433
|
+
|
|
2321
2434
|
</dd>
|
|
2322
2435
|
</dl>
|
|
2323
2436
|
|
|
2324
2437
|
<dl>
|
|
2325
2438
|
<dd>
|
|
2326
2439
|
|
|
2327
|
-
**requestOptions:** `Conversation.RequestOptions`
|
|
2328
|
-
|
|
2440
|
+
**requestOptions:** `Conversation.RequestOptions`
|
|
2441
|
+
|
|
2329
2442
|
</dd>
|
|
2330
2443
|
</dl>
|
|
2331
2444
|
</dd>
|
|
2332
2445
|
</dl>
|
|
2333
2446
|
|
|
2447
|
+
|
|
2334
2448
|
</dd>
|
|
2335
2449
|
</dl>
|
|
2336
2450
|
</details>
|
|
@@ -2348,7 +2462,6 @@ await client.conversation.categorize("conversationId");
|
|
|
2348
2462
|
<dd>
|
|
2349
2463
|
|
|
2350
2464
|
Update feedback or create it if it doesn't exist
|
|
2351
|
-
|
|
2352
2465
|
</dd>
|
|
2353
2466
|
</dl>
|
|
2354
2467
|
</dd>
|
|
@@ -2365,22 +2478,22 @@ Update feedback or create it if it doesn't exist
|
|
|
2365
2478
|
```typescript
|
|
2366
2479
|
await client.conversation.createFeedback({
|
|
2367
2480
|
feedbackId: {
|
|
2368
|
-
referenceId: "feedback-0"
|
|
2481
|
+
referenceId: "feedback-0"
|
|
2369
2482
|
},
|
|
2370
2483
|
userId: {
|
|
2371
|
-
referenceId: "user-0"
|
|
2484
|
+
referenceId: "user-0"
|
|
2372
2485
|
},
|
|
2373
2486
|
conversationId: {
|
|
2374
|
-
referenceId: "conversation-0"
|
|
2487
|
+
referenceId: "conversation-0"
|
|
2375
2488
|
},
|
|
2376
2489
|
conversationMessageId: {
|
|
2377
|
-
referenceId: "message-1"
|
|
2490
|
+
referenceId: "message-1"
|
|
2378
2491
|
},
|
|
2379
2492
|
type: "THUMBS_UP",
|
|
2380
|
-
text: "Great answer!"
|
|
2493
|
+
text: "Great answer!"
|
|
2381
2494
|
});
|
|
2382
|
-
```
|
|
2383
2495
|
|
|
2496
|
+
```
|
|
2384
2497
|
</dd>
|
|
2385
2498
|
</dl>
|
|
2386
2499
|
</dd>
|
|
@@ -2394,21 +2507,22 @@ await client.conversation.createFeedback({
|
|
|
2394
2507
|
<dl>
|
|
2395
2508
|
<dd>
|
|
2396
2509
|
|
|
2397
|
-
**request:** `MavenAGI.FeedbackRequest`
|
|
2398
|
-
|
|
2510
|
+
**request:** `MavenAGI.FeedbackRequest`
|
|
2511
|
+
|
|
2399
2512
|
</dd>
|
|
2400
2513
|
</dl>
|
|
2401
2514
|
|
|
2402
2515
|
<dl>
|
|
2403
2516
|
<dd>
|
|
2404
2517
|
|
|
2405
|
-
**requestOptions:** `Conversation.RequestOptions`
|
|
2406
|
-
|
|
2518
|
+
**requestOptions:** `Conversation.RequestOptions`
|
|
2519
|
+
|
|
2407
2520
|
</dd>
|
|
2408
2521
|
</dl>
|
|
2409
2522
|
</dd>
|
|
2410
2523
|
</dl>
|
|
2411
2524
|
|
|
2525
|
+
|
|
2412
2526
|
</dd>
|
|
2413
2527
|
</dl>
|
|
2414
2528
|
</details>
|
|
@@ -2425,12 +2539,11 @@ await client.conversation.createFeedback({
|
|
|
2425
2539
|
<dl>
|
|
2426
2540
|
<dd>
|
|
2427
2541
|
|
|
2428
|
-
Submit a filled out action form.
|
|
2542
|
+
Submit a filled out action form.
|
|
2429
2543
|
Action forms can not be submitted more than once, attempting to do so will result in an error.
|
|
2430
2544
|
|
|
2431
|
-
Additionally, form submission is only allowed when the form is the last message in the conversation.
|
|
2545
|
+
Additionally, form submission is only allowed when the form is the last message in the conversation.
|
|
2432
2546
|
Forms should be disabled in surface UI if a conversation continues and they remain unsubmitted.
|
|
2433
|
-
|
|
2434
2547
|
</dd>
|
|
2435
2548
|
</dl>
|
|
2436
2549
|
</dd>
|
|
@@ -2448,13 +2561,13 @@ Forms should be disabled in surface UI if a conversation continues and they rema
|
|
|
2448
2561
|
await client.conversation.submitActionForm("conversationId", {
|
|
2449
2562
|
actionFormId: "actionFormId",
|
|
2450
2563
|
parameters: {
|
|
2451
|
-
parameters: {
|
|
2452
|
-
key: "value"
|
|
2453
|
-
}
|
|
2454
|
-
}
|
|
2564
|
+
"parameters": {
|
|
2565
|
+
"key": "value"
|
|
2566
|
+
}
|
|
2567
|
+
}
|
|
2455
2568
|
});
|
|
2456
|
-
```
|
|
2457
2569
|
|
|
2570
|
+
```
|
|
2458
2571
|
</dd>
|
|
2459
2572
|
</dl>
|
|
2460
2573
|
</dd>
|
|
@@ -2469,28 +2582,29 @@ await client.conversation.submitActionForm("conversationId", {
|
|
|
2469
2582
|
<dd>
|
|
2470
2583
|
|
|
2471
2584
|
**conversationId:** `string` — The ID of a conversation the form being submitted belongs to
|
|
2472
|
-
|
|
2585
|
+
|
|
2473
2586
|
</dd>
|
|
2474
2587
|
</dl>
|
|
2475
2588
|
|
|
2476
2589
|
<dl>
|
|
2477
2590
|
<dd>
|
|
2478
2591
|
|
|
2479
|
-
**request:** `MavenAGI.SubmitActionFormRequest`
|
|
2480
|
-
|
|
2592
|
+
**request:** `MavenAGI.SubmitActionFormRequest`
|
|
2593
|
+
|
|
2481
2594
|
</dd>
|
|
2482
2595
|
</dl>
|
|
2483
2596
|
|
|
2484
2597
|
<dl>
|
|
2485
2598
|
<dd>
|
|
2486
2599
|
|
|
2487
|
-
**requestOptions:** `Conversation.RequestOptions`
|
|
2488
|
-
|
|
2600
|
+
**requestOptions:** `Conversation.RequestOptions`
|
|
2601
|
+
|
|
2489
2602
|
</dd>
|
|
2490
2603
|
</dl>
|
|
2491
2604
|
</dd>
|
|
2492
2605
|
</dl>
|
|
2493
2606
|
|
|
2607
|
+
|
|
2494
2608
|
</dd>
|
|
2495
2609
|
</dl>
|
|
2496
2610
|
</details>
|
|
@@ -2507,10 +2621,9 @@ await client.conversation.submitActionForm("conversationId", {
|
|
|
2507
2621
|
<dl>
|
|
2508
2622
|
<dd>
|
|
2509
2623
|
|
|
2510
|
-
Replaced by `updateConversationMetadata`.
|
|
2624
|
+
Replaced by `updateConversationMetadata`.
|
|
2511
2625
|
|
|
2512
2626
|
Adds metadata to an existing conversation. If a metadata field already exists, it will be overwritten.
|
|
2513
|
-
|
|
2514
2627
|
</dd>
|
|
2515
2628
|
</dl>
|
|
2516
2629
|
</dd>
|
|
@@ -2526,10 +2639,10 @@ Adds metadata to an existing conversation. If a metadata field already exists, i
|
|
|
2526
2639
|
|
|
2527
2640
|
```typescript
|
|
2528
2641
|
await client.conversation.addConversationMetadata("conversationId", {
|
|
2529
|
-
string: "string"
|
|
2642
|
+
"string": "string"
|
|
2530
2643
|
});
|
|
2531
|
-
```
|
|
2532
2644
|
|
|
2645
|
+
```
|
|
2533
2646
|
</dd>
|
|
2534
2647
|
</dl>
|
|
2535
2648
|
</dd>
|
|
@@ -2544,28 +2657,29 @@ await client.conversation.addConversationMetadata("conversationId", {
|
|
|
2544
2657
|
<dd>
|
|
2545
2658
|
|
|
2546
2659
|
**conversationId:** `string` — The ID of a conversation the metadata being added belongs to
|
|
2547
|
-
|
|
2660
|
+
|
|
2548
2661
|
</dd>
|
|
2549
2662
|
</dl>
|
|
2550
2663
|
|
|
2551
2664
|
<dl>
|
|
2552
2665
|
<dd>
|
|
2553
2666
|
|
|
2554
|
-
**request:** `Record<string, string>`
|
|
2555
|
-
|
|
2667
|
+
**request:** `Record<string, string>`
|
|
2668
|
+
|
|
2556
2669
|
</dd>
|
|
2557
2670
|
</dl>
|
|
2558
2671
|
|
|
2559
2672
|
<dl>
|
|
2560
2673
|
<dd>
|
|
2561
2674
|
|
|
2562
|
-
**requestOptions:** `Conversation.RequestOptions`
|
|
2563
|
-
|
|
2675
|
+
**requestOptions:** `Conversation.RequestOptions`
|
|
2676
|
+
|
|
2564
2677
|
</dd>
|
|
2565
2678
|
</dl>
|
|
2566
2679
|
</dd>
|
|
2567
2680
|
</dl>
|
|
2568
2681
|
|
|
2682
|
+
|
|
2569
2683
|
</dd>
|
|
2570
2684
|
</dl>
|
|
2571
2685
|
</details>
|
|
@@ -2582,14 +2696,13 @@ await client.conversation.addConversationMetadata("conversationId", {
|
|
|
2582
2696
|
<dl>
|
|
2583
2697
|
<dd>
|
|
2584
2698
|
|
|
2585
|
-
Update metadata supplied by the calling application for an existing conversation.
|
|
2699
|
+
Update metadata supplied by the calling application for an existing conversation.
|
|
2586
2700
|
Does not modify metadata saved by other apps.
|
|
2587
2701
|
|
|
2588
|
-
If a metadata field already exists for the calling app, it will be overwritten.
|
|
2702
|
+
If a metadata field already exists for the calling app, it will be overwritten.
|
|
2589
2703
|
If it does not exist, it will be added. Will not remove metadata fields.
|
|
2590
2704
|
|
|
2591
2705
|
Returns all metadata saved by any app on the conversation.
|
|
2592
|
-
|
|
2593
2706
|
</dd>
|
|
2594
2707
|
</dl>
|
|
2595
2708
|
</dd>
|
|
@@ -2607,11 +2720,11 @@ Returns all metadata saved by any app on the conversation.
|
|
|
2607
2720
|
await client.conversation.updateConversationMetadata("conversation-0", {
|
|
2608
2721
|
appId: "conversation-owning-app",
|
|
2609
2722
|
values: {
|
|
2610
|
-
key: "newValue"
|
|
2611
|
-
}
|
|
2723
|
+
"key": "newValue"
|
|
2724
|
+
}
|
|
2612
2725
|
});
|
|
2613
|
-
```
|
|
2614
2726
|
|
|
2727
|
+
```
|
|
2615
2728
|
</dd>
|
|
2616
2729
|
</dl>
|
|
2617
2730
|
</dd>
|
|
@@ -2626,28 +2739,29 @@ await client.conversation.updateConversationMetadata("conversation-0", {
|
|
|
2626
2739
|
<dd>
|
|
2627
2740
|
|
|
2628
2741
|
**conversationId:** `string` — The ID of the conversation to modify metadata for
|
|
2629
|
-
|
|
2742
|
+
|
|
2630
2743
|
</dd>
|
|
2631
2744
|
</dl>
|
|
2632
2745
|
|
|
2633
2746
|
<dl>
|
|
2634
2747
|
<dd>
|
|
2635
2748
|
|
|
2636
|
-
**request:** `MavenAGI.UpdateMetadataRequest`
|
|
2637
|
-
|
|
2749
|
+
**request:** `MavenAGI.UpdateMetadataRequest`
|
|
2750
|
+
|
|
2638
2751
|
</dd>
|
|
2639
2752
|
</dl>
|
|
2640
2753
|
|
|
2641
2754
|
<dl>
|
|
2642
2755
|
<dd>
|
|
2643
2756
|
|
|
2644
|
-
**requestOptions:** `Conversation.RequestOptions`
|
|
2645
|
-
|
|
2757
|
+
**requestOptions:** `Conversation.RequestOptions`
|
|
2758
|
+
|
|
2646
2759
|
</dd>
|
|
2647
2760
|
</dl>
|
|
2648
2761
|
</dd>
|
|
2649
2762
|
</dl>
|
|
2650
2763
|
|
|
2764
|
+
|
|
2651
2765
|
</dd>
|
|
2652
2766
|
</dl>
|
|
2653
2767
|
</details>
|
|
@@ -2665,7 +2779,6 @@ await client.conversation.updateConversationMetadata("conversation-0", {
|
|
|
2665
2779
|
<dd>
|
|
2666
2780
|
|
|
2667
2781
|
Search conversations
|
|
2668
|
-
|
|
2669
2782
|
</dd>
|
|
2670
2783
|
</dl>
|
|
2671
2784
|
</dd>
|
|
@@ -2681,8 +2794,8 @@ Search conversations
|
|
|
2681
2794
|
|
|
2682
2795
|
```typescript
|
|
2683
2796
|
await client.conversation.search({});
|
|
2684
|
-
```
|
|
2685
2797
|
|
|
2798
|
+
```
|
|
2686
2799
|
</dd>
|
|
2687
2800
|
</dl>
|
|
2688
2801
|
</dd>
|
|
@@ -2696,21 +2809,22 @@ await client.conversation.search({});
|
|
|
2696
2809
|
<dl>
|
|
2697
2810
|
<dd>
|
|
2698
2811
|
|
|
2699
|
-
**request:** `MavenAGI.ConversationsSearchRequest`
|
|
2700
|
-
|
|
2812
|
+
**request:** `MavenAGI.ConversationsSearchRequest`
|
|
2813
|
+
|
|
2701
2814
|
</dd>
|
|
2702
2815
|
</dl>
|
|
2703
2816
|
|
|
2704
2817
|
<dl>
|
|
2705
2818
|
<dd>
|
|
2706
2819
|
|
|
2707
|
-
**requestOptions:** `Conversation.RequestOptions`
|
|
2708
|
-
|
|
2820
|
+
**requestOptions:** `Conversation.RequestOptions`
|
|
2821
|
+
|
|
2709
2822
|
</dd>
|
|
2710
2823
|
</dl>
|
|
2711
2824
|
</dd>
|
|
2712
2825
|
</dl>
|
|
2713
2826
|
|
|
2827
|
+
|
|
2714
2828
|
</dd>
|
|
2715
2829
|
</dl>
|
|
2716
2830
|
</details>
|
|
@@ -2727,13 +2841,12 @@ await client.conversation.search({});
|
|
|
2727
2841
|
<dl>
|
|
2728
2842
|
<dd>
|
|
2729
2843
|
|
|
2730
|
-
Export conversations to a CSV file.
|
|
2844
|
+
Export conversations to a CSV file.
|
|
2731
2845
|
|
|
2732
2846
|
This will output a summary of each conversation that matches the supplied filter. A maximum of 10,000 conversations can be exported at a time.
|
|
2733
2847
|
|
|
2734
|
-
For most use cases it is recommended to use the `search` API instead and convert the JSON response to your desired format.
|
|
2848
|
+
For most use cases it is recommended to use the `search` API instead and convert the JSON response to your desired format.
|
|
2735
2849
|
The CSV format may change over time and should not be relied upon by code consumers.
|
|
2736
|
-
|
|
2737
2850
|
</dd>
|
|
2738
2851
|
</dl>
|
|
2739
2852
|
</dd>
|
|
@@ -2749,8 +2862,8 @@ The CSV format may change over time and should not be relied upon by code consum
|
|
|
2749
2862
|
|
|
2750
2863
|
```typescript
|
|
2751
2864
|
await client.conversation.export({});
|
|
2752
|
-
```
|
|
2753
2865
|
|
|
2866
|
+
```
|
|
2754
2867
|
</dd>
|
|
2755
2868
|
</dl>
|
|
2756
2869
|
</dd>
|
|
@@ -2764,21 +2877,22 @@ await client.conversation.export({});
|
|
|
2764
2877
|
<dl>
|
|
2765
2878
|
<dd>
|
|
2766
2879
|
|
|
2767
|
-
**request:** `MavenAGI.ConversationsSearchRequest`
|
|
2768
|
-
|
|
2880
|
+
**request:** `MavenAGI.ConversationsSearchRequest`
|
|
2881
|
+
|
|
2769
2882
|
</dd>
|
|
2770
2883
|
</dl>
|
|
2771
2884
|
|
|
2772
2885
|
<dl>
|
|
2773
2886
|
<dd>
|
|
2774
2887
|
|
|
2775
|
-
**requestOptions:** `Conversation.RequestOptions`
|
|
2776
|
-
|
|
2888
|
+
**requestOptions:** `Conversation.RequestOptions`
|
|
2889
|
+
|
|
2777
2890
|
</dd>
|
|
2778
2891
|
</dl>
|
|
2779
2892
|
</dd>
|
|
2780
2893
|
</dl>
|
|
2781
2894
|
|
|
2895
|
+
|
|
2782
2896
|
</dd>
|
|
2783
2897
|
</dl>
|
|
2784
2898
|
</details>
|
|
@@ -2820,21 +2934,202 @@ await client.conversation.deliverMessage({
|
|
|
2820
2934
|
userId: {
|
|
2821
2935
|
type: "AGENT",
|
|
2822
2936
|
appId: "appId",
|
|
2823
|
-
referenceId: "x"
|
|
2937
|
+
referenceId: "x"
|
|
2824
2938
|
},
|
|
2825
2939
|
message: {
|
|
2826
2940
|
conversationMessageId: {
|
|
2827
|
-
referenceId: "x"
|
|
2941
|
+
referenceId: "x"
|
|
2828
2942
|
},
|
|
2829
2943
|
userId: {
|
|
2830
|
-
referenceId: "x"
|
|
2944
|
+
referenceId: "x"
|
|
2831
2945
|
},
|
|
2832
2946
|
text: "text",
|
|
2833
|
-
userMessageType: "USER"
|
|
2947
|
+
userMessageType: "USER"
|
|
2948
|
+
}
|
|
2949
|
+
});
|
|
2950
|
+
|
|
2951
|
+
```
|
|
2952
|
+
</dd>
|
|
2953
|
+
</dl>
|
|
2954
|
+
</dd>
|
|
2955
|
+
</dl>
|
|
2956
|
+
|
|
2957
|
+
#### ⚙️ Parameters
|
|
2958
|
+
|
|
2959
|
+
<dl>
|
|
2960
|
+
<dd>
|
|
2961
|
+
|
|
2962
|
+
<dl>
|
|
2963
|
+
<dd>
|
|
2964
|
+
|
|
2965
|
+
**request:** `MavenAGI.DeliverMessageRequest`
|
|
2966
|
+
|
|
2967
|
+
</dd>
|
|
2968
|
+
</dl>
|
|
2969
|
+
|
|
2970
|
+
<dl>
|
|
2971
|
+
<dd>
|
|
2972
|
+
|
|
2973
|
+
**requestOptions:** `Conversation.RequestOptions`
|
|
2974
|
+
|
|
2975
|
+
</dd>
|
|
2976
|
+
</dl>
|
|
2977
|
+
</dd>
|
|
2978
|
+
</dl>
|
|
2979
|
+
|
|
2980
|
+
|
|
2981
|
+
</dd>
|
|
2982
|
+
</dl>
|
|
2983
|
+
</details>
|
|
2984
|
+
|
|
2985
|
+
## Customers
|
|
2986
|
+
<details><summary><code>client.customers.<a href="/src/api/resources/customers/client/Client.ts">search</a>({ ...params }) -> MavenAGI.CustomersSearchResponse</code></summary>
|
|
2987
|
+
<dl>
|
|
2988
|
+
<dd>
|
|
2989
|
+
|
|
2990
|
+
#### 🔌 Usage
|
|
2991
|
+
|
|
2992
|
+
<dl>
|
|
2993
|
+
<dd>
|
|
2994
|
+
|
|
2995
|
+
<dl>
|
|
2996
|
+
<dd>
|
|
2997
|
+
|
|
2998
|
+
```typescript
|
|
2999
|
+
await client.customers.search({});
|
|
3000
|
+
|
|
3001
|
+
```
|
|
3002
|
+
</dd>
|
|
3003
|
+
</dl>
|
|
3004
|
+
</dd>
|
|
3005
|
+
</dl>
|
|
3006
|
+
|
|
3007
|
+
#### ⚙️ Parameters
|
|
3008
|
+
|
|
3009
|
+
<dl>
|
|
3010
|
+
<dd>
|
|
3011
|
+
|
|
3012
|
+
<dl>
|
|
3013
|
+
<dd>
|
|
3014
|
+
|
|
3015
|
+
**request:** `MavenAGI.CustomersSearchRequest`
|
|
3016
|
+
|
|
3017
|
+
</dd>
|
|
3018
|
+
</dl>
|
|
3019
|
+
|
|
3020
|
+
<dl>
|
|
3021
|
+
<dd>
|
|
3022
|
+
|
|
3023
|
+
**requestOptions:** `Customers.RequestOptions`
|
|
3024
|
+
|
|
3025
|
+
</dd>
|
|
3026
|
+
</dl>
|
|
3027
|
+
</dd>
|
|
3028
|
+
</dl>
|
|
3029
|
+
|
|
3030
|
+
|
|
3031
|
+
</dd>
|
|
3032
|
+
</dl>
|
|
3033
|
+
</details>
|
|
3034
|
+
|
|
3035
|
+
<details><summary><code>client.customers.<a href="/src/api/resources/customers/client/Client.ts">createOrUpdate</a>({ ...params }) -> MavenAGI.CustomerResponse</code></summary>
|
|
3036
|
+
<dl>
|
|
3037
|
+
<dd>
|
|
3038
|
+
|
|
3039
|
+
#### 📝 Description
|
|
3040
|
+
|
|
3041
|
+
<dl>
|
|
3042
|
+
<dd>
|
|
3043
|
+
|
|
3044
|
+
<dl>
|
|
3045
|
+
<dd>
|
|
3046
|
+
|
|
3047
|
+
Update a customer of an agent or create it if it doesn't exist. In case of an update, fields not provided (e.g., description, status) will be preserved.
|
|
3048
|
+
</dd>
|
|
3049
|
+
</dl>
|
|
3050
|
+
</dd>
|
|
3051
|
+
</dl>
|
|
3052
|
+
|
|
3053
|
+
#### 🔌 Usage
|
|
3054
|
+
|
|
3055
|
+
<dl>
|
|
3056
|
+
<dd>
|
|
3057
|
+
|
|
3058
|
+
<dl>
|
|
3059
|
+
<dd>
|
|
3060
|
+
|
|
3061
|
+
```typescript
|
|
3062
|
+
await client.customers.createOrUpdate({
|
|
3063
|
+
customerId: {
|
|
3064
|
+
referenceId: "acme"
|
|
2834
3065
|
},
|
|
3066
|
+
name: "Acme Corporation"
|
|
2835
3067
|
});
|
|
3068
|
+
|
|
2836
3069
|
```
|
|
3070
|
+
</dd>
|
|
3071
|
+
</dl>
|
|
3072
|
+
</dd>
|
|
3073
|
+
</dl>
|
|
3074
|
+
|
|
3075
|
+
#### ⚙️ Parameters
|
|
3076
|
+
|
|
3077
|
+
<dl>
|
|
3078
|
+
<dd>
|
|
3079
|
+
|
|
3080
|
+
<dl>
|
|
3081
|
+
<dd>
|
|
3082
|
+
|
|
3083
|
+
**request:** `MavenAGI.CustomerRequest`
|
|
3084
|
+
|
|
3085
|
+
</dd>
|
|
3086
|
+
</dl>
|
|
2837
3087
|
|
|
3088
|
+
<dl>
|
|
3089
|
+
<dd>
|
|
3090
|
+
|
|
3091
|
+
**requestOptions:** `Customers.RequestOptions`
|
|
3092
|
+
|
|
3093
|
+
</dd>
|
|
3094
|
+
</dl>
|
|
3095
|
+
</dd>
|
|
3096
|
+
</dl>
|
|
3097
|
+
|
|
3098
|
+
|
|
3099
|
+
</dd>
|
|
3100
|
+
</dl>
|
|
3101
|
+
</details>
|
|
3102
|
+
|
|
3103
|
+
<details><summary><code>client.customers.<a href="/src/api/resources/customers/client/Client.ts">get</a>(customerReferenceId, { ...params }) -> MavenAGI.CustomerResponse</code></summary>
|
|
3104
|
+
<dl>
|
|
3105
|
+
<dd>
|
|
3106
|
+
|
|
3107
|
+
#### 📝 Description
|
|
3108
|
+
|
|
3109
|
+
<dl>
|
|
3110
|
+
<dd>
|
|
3111
|
+
|
|
3112
|
+
<dl>
|
|
3113
|
+
<dd>
|
|
3114
|
+
|
|
3115
|
+
Get a customer by its supplied ID
|
|
3116
|
+
</dd>
|
|
3117
|
+
</dl>
|
|
3118
|
+
</dd>
|
|
3119
|
+
</dl>
|
|
3120
|
+
|
|
3121
|
+
#### 🔌 Usage
|
|
3122
|
+
|
|
3123
|
+
<dl>
|
|
3124
|
+
<dd>
|
|
3125
|
+
|
|
3126
|
+
<dl>
|
|
3127
|
+
<dd>
|
|
3128
|
+
|
|
3129
|
+
```typescript
|
|
3130
|
+
await client.customers.get("acme");
|
|
3131
|
+
|
|
3132
|
+
```
|
|
2838
3133
|
</dd>
|
|
2839
3134
|
</dl>
|
|
2840
3135
|
</dd>
|
|
@@ -2848,27 +3143,109 @@ await client.conversation.deliverMessage({
|
|
|
2848
3143
|
<dl>
|
|
2849
3144
|
<dd>
|
|
2850
3145
|
|
|
2851
|
-
**
|
|
3146
|
+
**customerReferenceId:** `string` — The reference ID of the customer to get. All other entity ID fields are inferred from the request.
|
|
3147
|
+
|
|
3148
|
+
</dd>
|
|
3149
|
+
</dl>
|
|
3150
|
+
|
|
3151
|
+
<dl>
|
|
3152
|
+
<dd>
|
|
3153
|
+
|
|
3154
|
+
**request:** `MavenAGI.CustomerGetRequest`
|
|
3155
|
+
|
|
3156
|
+
</dd>
|
|
3157
|
+
</dl>
|
|
3158
|
+
|
|
3159
|
+
<dl>
|
|
3160
|
+
<dd>
|
|
3161
|
+
|
|
3162
|
+
**requestOptions:** `Customers.RequestOptions`
|
|
3163
|
+
|
|
3164
|
+
</dd>
|
|
3165
|
+
</dl>
|
|
3166
|
+
</dd>
|
|
3167
|
+
</dl>
|
|
3168
|
+
|
|
3169
|
+
|
|
3170
|
+
</dd>
|
|
3171
|
+
</dl>
|
|
3172
|
+
</details>
|
|
3173
|
+
|
|
3174
|
+
<details><summary><code>client.customers.<a href="/src/api/resources/customers/client/Client.ts">patch</a>(customerReferenceId, { ...params }) -> MavenAGI.CustomerResponse</code></summary>
|
|
3175
|
+
<dl>
|
|
3176
|
+
<dd>
|
|
3177
|
+
|
|
3178
|
+
#### 📝 Description
|
|
3179
|
+
|
|
3180
|
+
<dl>
|
|
3181
|
+
<dd>
|
|
3182
|
+
|
|
3183
|
+
<dl>
|
|
3184
|
+
<dd>
|
|
3185
|
+
|
|
3186
|
+
Update mutable customer fields
|
|
2852
3187
|
|
|
3188
|
+
The `appId` field can be provided to update a customer owned by a different app.
|
|
3189
|
+
All other fields will overwrite the existing value on the customer only if provided.
|
|
3190
|
+
</dd>
|
|
3191
|
+
</dl>
|
|
2853
3192
|
</dd>
|
|
2854
3193
|
</dl>
|
|
2855
3194
|
|
|
3195
|
+
#### 🔌 Usage
|
|
3196
|
+
|
|
2856
3197
|
<dl>
|
|
2857
3198
|
<dd>
|
|
2858
3199
|
|
|
2859
|
-
|
|
3200
|
+
<dl>
|
|
3201
|
+
<dd>
|
|
3202
|
+
|
|
3203
|
+
```typescript
|
|
3204
|
+
await client.customers.patch("customerReferenceId", {});
|
|
2860
3205
|
|
|
3206
|
+
```
|
|
2861
3207
|
</dd>
|
|
2862
3208
|
</dl>
|
|
2863
3209
|
</dd>
|
|
2864
3210
|
</dl>
|
|
2865
3211
|
|
|
3212
|
+
#### ⚙️ Parameters
|
|
3213
|
+
|
|
3214
|
+
<dl>
|
|
3215
|
+
<dd>
|
|
3216
|
+
|
|
3217
|
+
<dl>
|
|
3218
|
+
<dd>
|
|
3219
|
+
|
|
3220
|
+
**customerReferenceId:** `string` — The reference ID of the customer to update. All other entity ID fields are inferred from the request.
|
|
3221
|
+
|
|
3222
|
+
</dd>
|
|
3223
|
+
</dl>
|
|
3224
|
+
|
|
3225
|
+
<dl>
|
|
3226
|
+
<dd>
|
|
3227
|
+
|
|
3228
|
+
**request:** `MavenAGI.CustomerPatchRequest`
|
|
3229
|
+
|
|
3230
|
+
</dd>
|
|
3231
|
+
</dl>
|
|
3232
|
+
|
|
3233
|
+
<dl>
|
|
3234
|
+
<dd>
|
|
3235
|
+
|
|
3236
|
+
**requestOptions:** `Customers.RequestOptions`
|
|
3237
|
+
|
|
3238
|
+
</dd>
|
|
3239
|
+
</dl>
|
|
3240
|
+
</dd>
|
|
3241
|
+
</dl>
|
|
3242
|
+
|
|
3243
|
+
|
|
2866
3244
|
</dd>
|
|
2867
3245
|
</dl>
|
|
2868
3246
|
</details>
|
|
2869
3247
|
|
|
2870
3248
|
## Events
|
|
2871
|
-
|
|
2872
3249
|
<details><summary><code>client.events.<a href="/src/api/resources/events/client/Client.ts">create</a>({ ...params }) -> MavenAGI.EventResponse</code></summary>
|
|
2873
3250
|
<dl>
|
|
2874
3251
|
<dd>
|
|
@@ -2882,7 +3259,6 @@ await client.conversation.deliverMessage({
|
|
|
2882
3259
|
<dd>
|
|
2883
3260
|
|
|
2884
3261
|
Create a new event
|
|
2885
|
-
|
|
2886
3262
|
</dd>
|
|
2887
3263
|
</dl>
|
|
2888
3264
|
</dd>
|
|
@@ -2900,17 +3276,17 @@ Create a new event
|
|
|
2900
3276
|
await client.events.create({
|
|
2901
3277
|
eventType: "userEvent",
|
|
2902
3278
|
id: {
|
|
2903
|
-
referenceId: "x"
|
|
3279
|
+
referenceId: "x"
|
|
2904
3280
|
},
|
|
2905
3281
|
eventName: "BUTTON_CLICKED",
|
|
2906
3282
|
userInfo: {
|
|
2907
3283
|
id: {
|
|
2908
|
-
referenceId: "x"
|
|
2909
|
-
}
|
|
2910
|
-
}
|
|
3284
|
+
referenceId: "x"
|
|
3285
|
+
}
|
|
3286
|
+
}
|
|
2911
3287
|
});
|
|
2912
|
-
```
|
|
2913
3288
|
|
|
3289
|
+
```
|
|
2914
3290
|
</dd>
|
|
2915
3291
|
</dl>
|
|
2916
3292
|
</dd>
|
|
@@ -2924,21 +3300,22 @@ await client.events.create({
|
|
|
2924
3300
|
<dl>
|
|
2925
3301
|
<dd>
|
|
2926
3302
|
|
|
2927
|
-
**request:** `MavenAGI.EventRequest`
|
|
2928
|
-
|
|
3303
|
+
**request:** `MavenAGI.EventRequest`
|
|
3304
|
+
|
|
2929
3305
|
</dd>
|
|
2930
3306
|
</dl>
|
|
2931
3307
|
|
|
2932
3308
|
<dl>
|
|
2933
3309
|
<dd>
|
|
2934
3310
|
|
|
2935
|
-
**requestOptions:** `Events.RequestOptions`
|
|
2936
|
-
|
|
3311
|
+
**requestOptions:** `Events.RequestOptions`
|
|
3312
|
+
|
|
2937
3313
|
</dd>
|
|
2938
3314
|
</dl>
|
|
2939
3315
|
</dd>
|
|
2940
3316
|
</dl>
|
|
2941
3317
|
|
|
3318
|
+
|
|
2942
3319
|
</dd>
|
|
2943
3320
|
</dl>
|
|
2944
3321
|
</details>
|
|
@@ -2956,7 +3333,6 @@ await client.events.create({
|
|
|
2956
3333
|
<dd>
|
|
2957
3334
|
|
|
2958
3335
|
Search events
|
|
2959
|
-
|
|
2960
3336
|
</dd>
|
|
2961
3337
|
</dl>
|
|
2962
3338
|
</dd>
|
|
@@ -2972,8 +3348,8 @@ Search events
|
|
|
2972
3348
|
|
|
2973
3349
|
```typescript
|
|
2974
3350
|
await client.events.search({});
|
|
2975
|
-
```
|
|
2976
3351
|
|
|
3352
|
+
```
|
|
2977
3353
|
</dd>
|
|
2978
3354
|
</dl>
|
|
2979
3355
|
</dd>
|
|
@@ -2987,21 +3363,22 @@ await client.events.search({});
|
|
|
2987
3363
|
<dl>
|
|
2988
3364
|
<dd>
|
|
2989
3365
|
|
|
2990
|
-
**request:** `MavenAGI.EventsSearchRequest`
|
|
2991
|
-
|
|
3366
|
+
**request:** `MavenAGI.EventsSearchRequest`
|
|
3367
|
+
|
|
2992
3368
|
</dd>
|
|
2993
3369
|
</dl>
|
|
2994
3370
|
|
|
2995
3371
|
<dl>
|
|
2996
3372
|
<dd>
|
|
2997
3373
|
|
|
2998
|
-
**requestOptions:** `Events.RequestOptions`
|
|
2999
|
-
|
|
3374
|
+
**requestOptions:** `Events.RequestOptions`
|
|
3375
|
+
|
|
3000
3376
|
</dd>
|
|
3001
3377
|
</dl>
|
|
3002
3378
|
</dd>
|
|
3003
3379
|
</dl>
|
|
3004
3380
|
|
|
3381
|
+
|
|
3005
3382
|
</dd>
|
|
3006
3383
|
</dl>
|
|
3007
3384
|
</details>
|
|
@@ -3019,7 +3396,6 @@ await client.events.search({});
|
|
|
3019
3396
|
<dd>
|
|
3020
3397
|
|
|
3021
3398
|
Retrieve details of a specific Event item by its ID.
|
|
3022
|
-
|
|
3023
3399
|
</dd>
|
|
3024
3400
|
</dl>
|
|
3025
3401
|
</dd>
|
|
@@ -3035,10 +3411,10 @@ Retrieve details of a specific Event item by its ID.
|
|
|
3035
3411
|
|
|
3036
3412
|
```typescript
|
|
3037
3413
|
await client.events.get("eventId", {
|
|
3038
|
-
appId: "appId"
|
|
3414
|
+
appId: "appId"
|
|
3039
3415
|
});
|
|
3040
|
-
```
|
|
3041
3416
|
|
|
3417
|
+
```
|
|
3042
3418
|
</dd>
|
|
3043
3419
|
</dl>
|
|
3044
3420
|
</dd>
|
|
@@ -3053,28 +3429,29 @@ await client.events.get("eventId", {
|
|
|
3053
3429
|
<dd>
|
|
3054
3430
|
|
|
3055
3431
|
**eventId:** `string` — The ID of the Event to get.
|
|
3056
|
-
|
|
3432
|
+
|
|
3057
3433
|
</dd>
|
|
3058
3434
|
</dl>
|
|
3059
3435
|
|
|
3060
3436
|
<dl>
|
|
3061
3437
|
<dd>
|
|
3062
3438
|
|
|
3063
|
-
**request:** `MavenAGI.EventGetRequest`
|
|
3064
|
-
|
|
3439
|
+
**request:** `MavenAGI.EventGetRequest`
|
|
3440
|
+
|
|
3065
3441
|
</dd>
|
|
3066
3442
|
</dl>
|
|
3067
3443
|
|
|
3068
3444
|
<dl>
|
|
3069
3445
|
<dd>
|
|
3070
3446
|
|
|
3071
|
-
**requestOptions:** `Events.RequestOptions`
|
|
3072
|
-
|
|
3447
|
+
**requestOptions:** `Events.RequestOptions`
|
|
3448
|
+
|
|
3073
3449
|
</dd>
|
|
3074
3450
|
</dl>
|
|
3075
3451
|
</dd>
|
|
3076
3452
|
</dl>
|
|
3077
3453
|
|
|
3454
|
+
|
|
3078
3455
|
</dd>
|
|
3079
3456
|
</dl>
|
|
3080
3457
|
</details>
|
|
@@ -3094,7 +3471,6 @@ await client.events.get("eventId", {
|
|
|
3094
3471
|
Export events to a CSV file.
|
|
3095
3472
|
|
|
3096
3473
|
This will output a summary of each event that matches the supplied filter. A maximum of 10,000 events can be exported at a time. For most use cases it is recommended to use the search API instead and convert the JSON response to your desired format. The CSV format may change over time and should not be relied upon by code consumers.
|
|
3097
|
-
|
|
3098
3474
|
</dd>
|
|
3099
3475
|
</dl>
|
|
3100
3476
|
</dd>
|
|
@@ -3110,8 +3486,8 @@ This will output a summary of each event that matches the supplied filter. A max
|
|
|
3110
3486
|
|
|
3111
3487
|
```typescript
|
|
3112
3488
|
await client.events.export({});
|
|
3113
|
-
```
|
|
3114
3489
|
|
|
3490
|
+
```
|
|
3115
3491
|
</dd>
|
|
3116
3492
|
</dl>
|
|
3117
3493
|
</dd>
|
|
@@ -3125,27 +3501,27 @@ await client.events.export({});
|
|
|
3125
3501
|
<dl>
|
|
3126
3502
|
<dd>
|
|
3127
3503
|
|
|
3128
|
-
**request:** `MavenAGI.EventsSearchRequest`
|
|
3129
|
-
|
|
3504
|
+
**request:** `MavenAGI.EventsSearchRequest`
|
|
3505
|
+
|
|
3130
3506
|
</dd>
|
|
3131
3507
|
</dl>
|
|
3132
3508
|
|
|
3133
3509
|
<dl>
|
|
3134
3510
|
<dd>
|
|
3135
3511
|
|
|
3136
|
-
**requestOptions:** `Events.RequestOptions`
|
|
3137
|
-
|
|
3512
|
+
**requestOptions:** `Events.RequestOptions`
|
|
3513
|
+
|
|
3138
3514
|
</dd>
|
|
3139
3515
|
</dl>
|
|
3140
3516
|
</dd>
|
|
3141
3517
|
</dl>
|
|
3142
3518
|
|
|
3519
|
+
|
|
3143
3520
|
</dd>
|
|
3144
3521
|
</dl>
|
|
3145
3522
|
</details>
|
|
3146
3523
|
|
|
3147
3524
|
## Inbox
|
|
3148
|
-
|
|
3149
3525
|
<details><summary><code>client.inbox.<a href="/src/api/resources/inbox/client/Client.ts">search</a>({ ...params }) -> MavenAGI.InboxSearchResponse</code></summary>
|
|
3150
3526
|
<dl>
|
|
3151
3527
|
<dd>
|
|
@@ -3159,7 +3535,6 @@ await client.events.export({});
|
|
|
3159
3535
|
<dd>
|
|
3160
3536
|
|
|
3161
3537
|
Retrieve a paginated list of inbox items for an agent.
|
|
3162
|
-
|
|
3163
3538
|
</dd>
|
|
3164
3539
|
</dl>
|
|
3165
3540
|
</dd>
|
|
@@ -3175,8 +3550,8 @@ Retrieve a paginated list of inbox items for an agent.
|
|
|
3175
3550
|
|
|
3176
3551
|
```typescript
|
|
3177
3552
|
await client.inbox.search({});
|
|
3178
|
-
```
|
|
3179
3553
|
|
|
3554
|
+
```
|
|
3180
3555
|
</dd>
|
|
3181
3556
|
</dl>
|
|
3182
3557
|
</dd>
|
|
@@ -3190,21 +3565,22 @@ await client.inbox.search({});
|
|
|
3190
3565
|
<dl>
|
|
3191
3566
|
<dd>
|
|
3192
3567
|
|
|
3193
|
-
**request:** `MavenAGI.InboxSearchRequest`
|
|
3194
|
-
|
|
3568
|
+
**request:** `MavenAGI.InboxSearchRequest`
|
|
3569
|
+
|
|
3195
3570
|
</dd>
|
|
3196
3571
|
</dl>
|
|
3197
3572
|
|
|
3198
3573
|
<dl>
|
|
3199
3574
|
<dd>
|
|
3200
3575
|
|
|
3201
|
-
**requestOptions:** `Inbox.RequestOptions`
|
|
3202
|
-
|
|
3576
|
+
**requestOptions:** `Inbox.RequestOptions`
|
|
3577
|
+
|
|
3203
3578
|
</dd>
|
|
3204
3579
|
</dl>
|
|
3205
3580
|
</dd>
|
|
3206
3581
|
</dl>
|
|
3207
3582
|
|
|
3583
|
+
|
|
3208
3584
|
</dd>
|
|
3209
3585
|
</dl>
|
|
3210
3586
|
</details>
|
|
@@ -3222,7 +3598,6 @@ await client.inbox.search({});
|
|
|
3222
3598
|
<dd>
|
|
3223
3599
|
|
|
3224
3600
|
Retrieve details of a specific inbox item by its ID.
|
|
3225
|
-
|
|
3226
3601
|
</dd>
|
|
3227
3602
|
</dl>
|
|
3228
3603
|
</dd>
|
|
@@ -3238,10 +3613,10 @@ Retrieve details of a specific inbox item by its ID.
|
|
|
3238
3613
|
|
|
3239
3614
|
```typescript
|
|
3240
3615
|
await client.inbox.get("inboxItemId", {
|
|
3241
|
-
appId: "appId"
|
|
3616
|
+
appId: "appId"
|
|
3242
3617
|
});
|
|
3243
|
-
```
|
|
3244
3618
|
|
|
3619
|
+
```
|
|
3245
3620
|
</dd>
|
|
3246
3621
|
</dl>
|
|
3247
3622
|
</dd>
|
|
@@ -3256,28 +3631,29 @@ await client.inbox.get("inboxItemId", {
|
|
|
3256
3631
|
<dd>
|
|
3257
3632
|
|
|
3258
3633
|
**inboxItemId:** `string` — The ID of the inbox item to get. All other entity ID fields are inferred from the request.
|
|
3259
|
-
|
|
3634
|
+
|
|
3260
3635
|
</dd>
|
|
3261
3636
|
</dl>
|
|
3262
3637
|
|
|
3263
3638
|
<dl>
|
|
3264
3639
|
<dd>
|
|
3265
3640
|
|
|
3266
|
-
**request:** `MavenAGI.InboxItemRequest`
|
|
3267
|
-
|
|
3641
|
+
**request:** `MavenAGI.InboxItemRequest`
|
|
3642
|
+
|
|
3268
3643
|
</dd>
|
|
3269
3644
|
</dl>
|
|
3270
3645
|
|
|
3271
3646
|
<dl>
|
|
3272
3647
|
<dd>
|
|
3273
3648
|
|
|
3274
|
-
**requestOptions:** `Inbox.RequestOptions`
|
|
3275
|
-
|
|
3649
|
+
**requestOptions:** `Inbox.RequestOptions`
|
|
3650
|
+
|
|
3276
3651
|
</dd>
|
|
3277
3652
|
</dl>
|
|
3278
3653
|
</dd>
|
|
3279
3654
|
</dl>
|
|
3280
3655
|
|
|
3656
|
+
|
|
3281
3657
|
</dd>
|
|
3282
3658
|
</dl>
|
|
3283
3659
|
</details>
|
|
@@ -3295,7 +3671,6 @@ await client.inbox.get("inboxItemId", {
|
|
|
3295
3671
|
<dd>
|
|
3296
3672
|
|
|
3297
3673
|
Retrieve a suggested fix. Includes document information if the fix is a Missing Knowledge suggestion.
|
|
3298
|
-
|
|
3299
3674
|
</dd>
|
|
3300
3675
|
</dl>
|
|
3301
3676
|
</dd>
|
|
@@ -3311,10 +3686,10 @@ Retrieve a suggested fix. Includes document information if the fix is a Missing
|
|
|
3311
3686
|
|
|
3312
3687
|
```typescript
|
|
3313
3688
|
await client.inbox.getFix("inboxItemFixId", {
|
|
3314
|
-
appId: "appId"
|
|
3689
|
+
appId: "appId"
|
|
3315
3690
|
});
|
|
3316
|
-
```
|
|
3317
3691
|
|
|
3692
|
+
```
|
|
3318
3693
|
</dd>
|
|
3319
3694
|
</dl>
|
|
3320
3695
|
</dd>
|
|
@@ -3329,28 +3704,29 @@ await client.inbox.getFix("inboxItemFixId", {
|
|
|
3329
3704
|
<dd>
|
|
3330
3705
|
|
|
3331
3706
|
**inboxItemFixId:** `string` — Unique identifier for the inbox fix.
|
|
3332
|
-
|
|
3707
|
+
|
|
3333
3708
|
</dd>
|
|
3334
3709
|
</dl>
|
|
3335
3710
|
|
|
3336
3711
|
<dl>
|
|
3337
3712
|
<dd>
|
|
3338
3713
|
|
|
3339
|
-
**request:** `MavenAGI.InboxItemFixRequest`
|
|
3340
|
-
|
|
3714
|
+
**request:** `MavenAGI.InboxItemFixRequest`
|
|
3715
|
+
|
|
3341
3716
|
</dd>
|
|
3342
3717
|
</dl>
|
|
3343
3718
|
|
|
3344
3719
|
<dl>
|
|
3345
3720
|
<dd>
|
|
3346
3721
|
|
|
3347
|
-
**requestOptions:** `Inbox.RequestOptions`
|
|
3348
|
-
|
|
3722
|
+
**requestOptions:** `Inbox.RequestOptions`
|
|
3723
|
+
|
|
3349
3724
|
</dd>
|
|
3350
3725
|
</dl>
|
|
3351
3726
|
</dd>
|
|
3352
3727
|
</dl>
|
|
3353
3728
|
|
|
3729
|
+
|
|
3354
3730
|
</dd>
|
|
3355
3731
|
</dl>
|
|
3356
3732
|
</details>
|
|
@@ -3368,7 +3744,6 @@ await client.inbox.getFix("inboxItemFixId", {
|
|
|
3368
3744
|
<dd>
|
|
3369
3745
|
|
|
3370
3746
|
Apply a list of fixes belonging to an inbox item.
|
|
3371
|
-
|
|
3372
3747
|
</dd>
|
|
3373
3748
|
</dl>
|
|
3374
3749
|
</dd>
|
|
@@ -3385,10 +3760,10 @@ Apply a list of fixes belonging to an inbox item.
|
|
|
3385
3760
|
```typescript
|
|
3386
3761
|
await client.inbox.applyFixes("inboxItemId", {
|
|
3387
3762
|
appId: "appId",
|
|
3388
|
-
fixReferenceIds: ["fixReferenceIds", "fixReferenceIds"]
|
|
3763
|
+
fixReferenceIds: ["fixReferenceIds", "fixReferenceIds"]
|
|
3389
3764
|
});
|
|
3390
|
-
```
|
|
3391
3765
|
|
|
3766
|
+
```
|
|
3392
3767
|
</dd>
|
|
3393
3768
|
</dl>
|
|
3394
3769
|
</dd>
|
|
@@ -3403,28 +3778,29 @@ await client.inbox.applyFixes("inboxItemId", {
|
|
|
3403
3778
|
<dd>
|
|
3404
3779
|
|
|
3405
3780
|
**inboxItemId:** `string` — Unique identifier for the inbox item.
|
|
3406
|
-
|
|
3781
|
+
|
|
3407
3782
|
</dd>
|
|
3408
3783
|
</dl>
|
|
3409
3784
|
|
|
3410
3785
|
<dl>
|
|
3411
3786
|
<dd>
|
|
3412
3787
|
|
|
3413
|
-
**request:** `MavenAGI.ApplyFixesRequest`
|
|
3414
|
-
|
|
3788
|
+
**request:** `MavenAGI.ApplyFixesRequest`
|
|
3789
|
+
|
|
3415
3790
|
</dd>
|
|
3416
3791
|
</dl>
|
|
3417
3792
|
|
|
3418
3793
|
<dl>
|
|
3419
3794
|
<dd>
|
|
3420
3795
|
|
|
3421
|
-
**requestOptions:** `Inbox.RequestOptions`
|
|
3422
|
-
|
|
3796
|
+
**requestOptions:** `Inbox.RequestOptions`
|
|
3797
|
+
|
|
3423
3798
|
</dd>
|
|
3424
3799
|
</dl>
|
|
3425
3800
|
</dd>
|
|
3426
3801
|
</dl>
|
|
3427
3802
|
|
|
3803
|
+
|
|
3428
3804
|
</dd>
|
|
3429
3805
|
</dl>
|
|
3430
3806
|
</details>
|
|
@@ -3442,7 +3818,6 @@ await client.inbox.applyFixes("inboxItemId", {
|
|
|
3442
3818
|
<dd>
|
|
3443
3819
|
|
|
3444
3820
|
Ignore a specific inbox item by its ID.
|
|
3445
|
-
|
|
3446
3821
|
</dd>
|
|
3447
3822
|
</dl>
|
|
3448
3823
|
</dd>
|
|
@@ -3458,10 +3833,10 @@ Ignore a specific inbox item by its ID.
|
|
|
3458
3833
|
|
|
3459
3834
|
```typescript
|
|
3460
3835
|
await client.inbox.ignore("inboxItemId", {
|
|
3461
|
-
appId: "appId"
|
|
3836
|
+
appId: "appId"
|
|
3462
3837
|
});
|
|
3463
|
-
```
|
|
3464
3838
|
|
|
3839
|
+
```
|
|
3465
3840
|
</dd>
|
|
3466
3841
|
</dl>
|
|
3467
3842
|
</dd>
|
|
@@ -3476,34 +3851,34 @@ await client.inbox.ignore("inboxItemId", {
|
|
|
3476
3851
|
<dd>
|
|
3477
3852
|
|
|
3478
3853
|
**inboxItemId:** `string` — Unique identifier for the inbox item.
|
|
3479
|
-
|
|
3854
|
+
|
|
3480
3855
|
</dd>
|
|
3481
3856
|
</dl>
|
|
3482
3857
|
|
|
3483
3858
|
<dl>
|
|
3484
3859
|
<dd>
|
|
3485
3860
|
|
|
3486
|
-
**request:** `MavenAGI.InboxItemIgnoreRequest`
|
|
3487
|
-
|
|
3861
|
+
**request:** `MavenAGI.InboxItemIgnoreRequest`
|
|
3862
|
+
|
|
3488
3863
|
</dd>
|
|
3489
3864
|
</dl>
|
|
3490
3865
|
|
|
3491
3866
|
<dl>
|
|
3492
3867
|
<dd>
|
|
3493
3868
|
|
|
3494
|
-
**requestOptions:** `Inbox.RequestOptions`
|
|
3495
|
-
|
|
3869
|
+
**requestOptions:** `Inbox.RequestOptions`
|
|
3870
|
+
|
|
3496
3871
|
</dd>
|
|
3497
3872
|
</dl>
|
|
3498
3873
|
</dd>
|
|
3499
3874
|
</dl>
|
|
3500
3875
|
|
|
3876
|
+
|
|
3501
3877
|
</dd>
|
|
3502
3878
|
</dl>
|
|
3503
3879
|
</details>
|
|
3504
3880
|
|
|
3505
3881
|
## Knowledge
|
|
3506
|
-
|
|
3507
3882
|
<details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">searchKnowledgeBases</a>({ ...params }) -> MavenAGI.KnowledgeBasesResponse</code></summary>
|
|
3508
3883
|
<dl>
|
|
3509
3884
|
<dd>
|
|
@@ -3517,7 +3892,6 @@ await client.inbox.ignore("inboxItemId", {
|
|
|
3517
3892
|
<dd>
|
|
3518
3893
|
|
|
3519
3894
|
Search knowledge bases
|
|
3520
|
-
|
|
3521
3895
|
</dd>
|
|
3522
3896
|
</dl>
|
|
3523
3897
|
</dd>
|
|
@@ -3533,8 +3907,8 @@ Search knowledge bases
|
|
|
3533
3907
|
|
|
3534
3908
|
```typescript
|
|
3535
3909
|
await client.knowledge.searchKnowledgeBases({});
|
|
3536
|
-
```
|
|
3537
3910
|
|
|
3911
|
+
```
|
|
3538
3912
|
</dd>
|
|
3539
3913
|
</dl>
|
|
3540
3914
|
</dd>
|
|
@@ -3548,21 +3922,22 @@ await client.knowledge.searchKnowledgeBases({});
|
|
|
3548
3922
|
<dl>
|
|
3549
3923
|
<dd>
|
|
3550
3924
|
|
|
3551
|
-
**request:** `MavenAGI.KnowledgeBaseSearchRequest`
|
|
3552
|
-
|
|
3925
|
+
**request:** `MavenAGI.KnowledgeBaseSearchRequest`
|
|
3926
|
+
|
|
3553
3927
|
</dd>
|
|
3554
3928
|
</dl>
|
|
3555
3929
|
|
|
3556
3930
|
<dl>
|
|
3557
3931
|
<dd>
|
|
3558
3932
|
|
|
3559
|
-
**requestOptions:** `Knowledge.RequestOptions`
|
|
3560
|
-
|
|
3933
|
+
**requestOptions:** `Knowledge.RequestOptions`
|
|
3934
|
+
|
|
3561
3935
|
</dd>
|
|
3562
3936
|
</dl>
|
|
3563
3937
|
</dd>
|
|
3564
3938
|
</dl>
|
|
3565
3939
|
|
|
3940
|
+
|
|
3566
3941
|
</dd>
|
|
3567
3942
|
</dl>
|
|
3568
3943
|
</details>
|
|
@@ -3580,7 +3955,6 @@ await client.knowledge.searchKnowledgeBases({});
|
|
|
3580
3955
|
<dd>
|
|
3581
3956
|
|
|
3582
3957
|
Update a knowledge base or create it if it doesn't exist.
|
|
3583
|
-
|
|
3584
3958
|
</dd>
|
|
3585
3959
|
</dl>
|
|
3586
3960
|
</dd>
|
|
@@ -3597,12 +3971,12 @@ Update a knowledge base or create it if it doesn't exist.
|
|
|
3597
3971
|
```typescript
|
|
3598
3972
|
await client.knowledge.createOrUpdateKnowledgeBase({
|
|
3599
3973
|
knowledgeBaseId: {
|
|
3600
|
-
referenceId: "help-center"
|
|
3974
|
+
referenceId: "help-center"
|
|
3601
3975
|
},
|
|
3602
|
-
name: "Help center"
|
|
3976
|
+
name: "Help center"
|
|
3603
3977
|
});
|
|
3604
|
-
```
|
|
3605
3978
|
|
|
3979
|
+
```
|
|
3606
3980
|
</dd>
|
|
3607
3981
|
</dl>
|
|
3608
3982
|
</dd>
|
|
@@ -3616,21 +3990,22 @@ await client.knowledge.createOrUpdateKnowledgeBase({
|
|
|
3616
3990
|
<dl>
|
|
3617
3991
|
<dd>
|
|
3618
3992
|
|
|
3619
|
-
**request:** `MavenAGI.KnowledgeBaseRequest`
|
|
3620
|
-
|
|
3993
|
+
**request:** `MavenAGI.KnowledgeBaseRequest`
|
|
3994
|
+
|
|
3621
3995
|
</dd>
|
|
3622
3996
|
</dl>
|
|
3623
3997
|
|
|
3624
3998
|
<dl>
|
|
3625
3999
|
<dd>
|
|
3626
4000
|
|
|
3627
|
-
**requestOptions:** `Knowledge.RequestOptions`
|
|
3628
|
-
|
|
4001
|
+
**requestOptions:** `Knowledge.RequestOptions`
|
|
4002
|
+
|
|
3629
4003
|
</dd>
|
|
3630
4004
|
</dl>
|
|
3631
4005
|
</dd>
|
|
3632
4006
|
</dl>
|
|
3633
4007
|
|
|
4008
|
+
|
|
3634
4009
|
</dd>
|
|
3635
4010
|
</dl>
|
|
3636
4011
|
</details>
|
|
@@ -3648,7 +4023,6 @@ await client.knowledge.createOrUpdateKnowledgeBase({
|
|
|
3648
4023
|
<dd>
|
|
3649
4024
|
|
|
3650
4025
|
Get an existing knowledge base by its supplied ID
|
|
3651
|
-
|
|
3652
4026
|
</dd>
|
|
3653
4027
|
</dl>
|
|
3654
4028
|
</dd>
|
|
@@ -3664,8 +4038,8 @@ Get an existing knowledge base by its supplied ID
|
|
|
3664
4038
|
|
|
3665
4039
|
```typescript
|
|
3666
4040
|
await client.knowledge.getKnowledgeBase("help-center");
|
|
3667
|
-
```
|
|
3668
4041
|
|
|
4042
|
+
```
|
|
3669
4043
|
</dd>
|
|
3670
4044
|
</dl>
|
|
3671
4045
|
</dd>
|
|
@@ -3680,28 +4054,29 @@ await client.knowledge.getKnowledgeBase("help-center");
|
|
|
3680
4054
|
<dd>
|
|
3681
4055
|
|
|
3682
4056
|
**knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base to get. All other entity ID fields are inferred from the request.
|
|
3683
|
-
|
|
4057
|
+
|
|
3684
4058
|
</dd>
|
|
3685
4059
|
</dl>
|
|
3686
4060
|
|
|
3687
4061
|
<dl>
|
|
3688
4062
|
<dd>
|
|
3689
4063
|
|
|
3690
|
-
**request:** `MavenAGI.KnowledgeBaseGetRequest`
|
|
3691
|
-
|
|
4064
|
+
**request:** `MavenAGI.KnowledgeBaseGetRequest`
|
|
4065
|
+
|
|
3692
4066
|
</dd>
|
|
3693
4067
|
</dl>
|
|
3694
4068
|
|
|
3695
4069
|
<dl>
|
|
3696
4070
|
<dd>
|
|
3697
4071
|
|
|
3698
|
-
**requestOptions:** `Knowledge.RequestOptions`
|
|
3699
|
-
|
|
4072
|
+
**requestOptions:** `Knowledge.RequestOptions`
|
|
4073
|
+
|
|
3700
4074
|
</dd>
|
|
3701
4075
|
</dl>
|
|
3702
4076
|
</dd>
|
|
3703
4077
|
</dl>
|
|
3704
4078
|
|
|
4079
|
+
|
|
3705
4080
|
</dd>
|
|
3706
4081
|
</dl>
|
|
3707
4082
|
</details>
|
|
@@ -3722,7 +4097,6 @@ Request that a knowledge base refresh itself.
|
|
|
3722
4097
|
|
|
3723
4098
|
Knowledge bases refresh on a schedule determined by the `refreshFrequency` field.
|
|
3724
4099
|
They can also be refreshed on demand by calling this endpoint.
|
|
3725
|
-
|
|
3726
4100
|
</dd>
|
|
3727
4101
|
</dl>
|
|
3728
4102
|
</dd>
|
|
@@ -3738,10 +4112,10 @@ They can also be refreshed on demand by calling this endpoint.
|
|
|
3738
4112
|
|
|
3739
4113
|
```typescript
|
|
3740
4114
|
await client.knowledge.refreshKnowledgeBase("help-center", {
|
|
3741
|
-
appId: "readme"
|
|
4115
|
+
appId: "readme"
|
|
3742
4116
|
});
|
|
3743
|
-
```
|
|
3744
4117
|
|
|
4118
|
+
```
|
|
3745
4119
|
</dd>
|
|
3746
4120
|
</dl>
|
|
3747
4121
|
</dd>
|
|
@@ -3756,28 +4130,29 @@ await client.knowledge.refreshKnowledgeBase("help-center", {
|
|
|
3756
4130
|
<dd>
|
|
3757
4131
|
|
|
3758
4132
|
**knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base to refresh. All other entity ID fields are inferred from the request.
|
|
3759
|
-
|
|
4133
|
+
|
|
3760
4134
|
</dd>
|
|
3761
4135
|
</dl>
|
|
3762
4136
|
|
|
3763
4137
|
<dl>
|
|
3764
4138
|
<dd>
|
|
3765
4139
|
|
|
3766
|
-
**request:** `MavenAGI.KnowledgeBaseRefreshRequest`
|
|
3767
|
-
|
|
4140
|
+
**request:** `MavenAGI.KnowledgeBaseRefreshRequest`
|
|
4141
|
+
|
|
3768
4142
|
</dd>
|
|
3769
4143
|
</dl>
|
|
3770
4144
|
|
|
3771
4145
|
<dl>
|
|
3772
4146
|
<dd>
|
|
3773
4147
|
|
|
3774
|
-
**requestOptions:** `Knowledge.RequestOptions`
|
|
3775
|
-
|
|
4148
|
+
**requestOptions:** `Knowledge.RequestOptions`
|
|
4149
|
+
|
|
3776
4150
|
</dd>
|
|
3777
4151
|
</dl>
|
|
3778
4152
|
</dd>
|
|
3779
4153
|
</dl>
|
|
3780
4154
|
|
|
4155
|
+
|
|
3781
4156
|
</dd>
|
|
3782
4157
|
</dl>
|
|
3783
4158
|
</details>
|
|
@@ -3798,7 +4173,6 @@ Update mutable knowledge base fields
|
|
|
3798
4173
|
|
|
3799
4174
|
The `appId` field can be provided to update a knowledge base owned by a different app.
|
|
3800
4175
|
All other fields will overwrite the existing value on the knowledge base only if provided.
|
|
3801
|
-
|
|
3802
4176
|
</dd>
|
|
3803
4177
|
</dl>
|
|
3804
4178
|
</dd>
|
|
@@ -3821,11 +4195,11 @@ await client.knowledge.patchKnowledgeBase("help-center", {
|
|
|
3821
4195
|
appId: "readme",
|
|
3822
4196
|
organizationId: "acme",
|
|
3823
4197
|
agentId: "support",
|
|
3824
|
-
type: "SEGMENT"
|
|
3825
|
-
}
|
|
4198
|
+
type: "SEGMENT"
|
|
4199
|
+
}
|
|
3826
4200
|
});
|
|
3827
|
-
```
|
|
3828
4201
|
|
|
4202
|
+
```
|
|
3829
4203
|
</dd>
|
|
3830
4204
|
</dl>
|
|
3831
4205
|
</dd>
|
|
@@ -3840,28 +4214,29 @@ await client.knowledge.patchKnowledgeBase("help-center", {
|
|
|
3840
4214
|
<dd>
|
|
3841
4215
|
|
|
3842
4216
|
**knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base to patch.
|
|
3843
|
-
|
|
4217
|
+
|
|
3844
4218
|
</dd>
|
|
3845
4219
|
</dl>
|
|
3846
4220
|
|
|
3847
4221
|
<dl>
|
|
3848
4222
|
<dd>
|
|
3849
4223
|
|
|
3850
|
-
**request:** `MavenAGI.KnowledgeBasePatchRequest`
|
|
3851
|
-
|
|
4224
|
+
**request:** `MavenAGI.KnowledgeBasePatchRequest`
|
|
4225
|
+
|
|
3852
4226
|
</dd>
|
|
3853
4227
|
</dl>
|
|
3854
4228
|
|
|
3855
4229
|
<dl>
|
|
3856
4230
|
<dd>
|
|
3857
4231
|
|
|
3858
|
-
**requestOptions:** `Knowledge.RequestOptions`
|
|
3859
|
-
|
|
4232
|
+
**requestOptions:** `Knowledge.RequestOptions`
|
|
4233
|
+
|
|
3860
4234
|
</dd>
|
|
3861
4235
|
</dl>
|
|
3862
4236
|
</dd>
|
|
3863
4237
|
</dl>
|
|
3864
4238
|
|
|
4239
|
+
|
|
3865
4240
|
</dd>
|
|
3866
4241
|
</dl>
|
|
3867
4242
|
</details>
|
|
@@ -3881,7 +4256,6 @@ await client.knowledge.patchKnowledgeBase("help-center", {
|
|
|
3881
4256
|
Create a new knowledge base version.
|
|
3882
4257
|
|
|
3883
4258
|
If an existing version is in progress, then that version will be finalized in an error state.
|
|
3884
|
-
|
|
3885
4259
|
</dd>
|
|
3886
4260
|
</dl>
|
|
3887
4261
|
</dd>
|
|
@@ -3897,10 +4271,10 @@ If an existing version is in progress, then that version will be finalized in an
|
|
|
3897
4271
|
|
|
3898
4272
|
```typescript
|
|
3899
4273
|
await client.knowledge.createKnowledgeBaseVersion("help-center", {
|
|
3900
|
-
type: "FULL"
|
|
4274
|
+
type: "FULL"
|
|
3901
4275
|
});
|
|
3902
|
-
```
|
|
3903
4276
|
|
|
4277
|
+
```
|
|
3904
4278
|
</dd>
|
|
3905
4279
|
</dl>
|
|
3906
4280
|
</dd>
|
|
@@ -3915,28 +4289,29 @@ await client.knowledge.createKnowledgeBaseVersion("help-center", {
|
|
|
3915
4289
|
<dd>
|
|
3916
4290
|
|
|
3917
4291
|
**knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base to create a version for. All other entity ID fields are inferred from the request.
|
|
3918
|
-
|
|
4292
|
+
|
|
3919
4293
|
</dd>
|
|
3920
4294
|
</dl>
|
|
3921
4295
|
|
|
3922
4296
|
<dl>
|
|
3923
4297
|
<dd>
|
|
3924
4298
|
|
|
3925
|
-
**request:** `MavenAGI.KnowledgeBaseVersionRequest`
|
|
3926
|
-
|
|
4299
|
+
**request:** `MavenAGI.KnowledgeBaseVersionRequest`
|
|
4300
|
+
|
|
3927
4301
|
</dd>
|
|
3928
4302
|
</dl>
|
|
3929
4303
|
|
|
3930
4304
|
<dl>
|
|
3931
4305
|
<dd>
|
|
3932
4306
|
|
|
3933
|
-
**requestOptions:** `Knowledge.RequestOptions`
|
|
3934
|
-
|
|
4307
|
+
**requestOptions:** `Knowledge.RequestOptions`
|
|
4308
|
+
|
|
3935
4309
|
</dd>
|
|
3936
4310
|
</dl>
|
|
3937
4311
|
</dd>
|
|
3938
4312
|
</dl>
|
|
3939
4313
|
|
|
4314
|
+
|
|
3940
4315
|
</dd>
|
|
3941
4316
|
</dl>
|
|
3942
4317
|
</details>
|
|
@@ -3954,7 +4329,6 @@ await client.knowledge.createKnowledgeBaseVersion("help-center", {
|
|
|
3954
4329
|
<dd>
|
|
3955
4330
|
|
|
3956
4331
|
Finalize the latest knowledge base version. Required to indicate the version is complete. Will throw an exception if the latest version is not in progress.
|
|
3957
|
-
|
|
3958
4332
|
</dd>
|
|
3959
4333
|
</dl>
|
|
3960
4334
|
</dd>
|
|
@@ -3973,12 +4347,12 @@ await client.knowledge.finalizeKnowledgeBaseVersion("help-center", {
|
|
|
3973
4347
|
versionId: {
|
|
3974
4348
|
type: "KNOWLEDGE_BASE_VERSION",
|
|
3975
4349
|
referenceId: "versionId",
|
|
3976
|
-
appId: "maven"
|
|
4350
|
+
appId: "maven"
|
|
3977
4351
|
},
|
|
3978
|
-
status: "SUCCEEDED"
|
|
4352
|
+
status: "SUCCEEDED"
|
|
3979
4353
|
});
|
|
3980
|
-
```
|
|
3981
4354
|
|
|
4355
|
+
```
|
|
3982
4356
|
</dd>
|
|
3983
4357
|
</dl>
|
|
3984
4358
|
</dd>
|
|
@@ -3993,28 +4367,29 @@ await client.knowledge.finalizeKnowledgeBaseVersion("help-center", {
|
|
|
3993
4367
|
<dd>
|
|
3994
4368
|
|
|
3995
4369
|
**knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base to finalize a version for. All other entity ID fields are inferred from the request.
|
|
3996
|
-
|
|
4370
|
+
|
|
3997
4371
|
</dd>
|
|
3998
4372
|
</dl>
|
|
3999
4373
|
|
|
4000
4374
|
<dl>
|
|
4001
4375
|
<dd>
|
|
4002
4376
|
|
|
4003
|
-
**request:** `MavenAGI.FinalizeKnowledgeBaseVersionRequest`
|
|
4004
|
-
|
|
4377
|
+
**request:** `MavenAGI.FinalizeKnowledgeBaseVersionRequest`
|
|
4378
|
+
|
|
4005
4379
|
</dd>
|
|
4006
4380
|
</dl>
|
|
4007
4381
|
|
|
4008
4382
|
<dl>
|
|
4009
4383
|
<dd>
|
|
4010
4384
|
|
|
4011
|
-
**requestOptions:** `Knowledge.RequestOptions`
|
|
4012
|
-
|
|
4385
|
+
**requestOptions:** `Knowledge.RequestOptions`
|
|
4386
|
+
|
|
4013
4387
|
</dd>
|
|
4014
4388
|
</dl>
|
|
4015
4389
|
</dd>
|
|
4016
4390
|
</dl>
|
|
4017
4391
|
|
|
4392
|
+
|
|
4018
4393
|
</dd>
|
|
4019
4394
|
</dl>
|
|
4020
4395
|
</details>
|
|
@@ -4032,7 +4407,6 @@ await client.knowledge.finalizeKnowledgeBaseVersion("help-center", {
|
|
|
4032
4407
|
<dd>
|
|
4033
4408
|
|
|
4034
4409
|
List all active versions for a knowledge base. Returns the most recent versions first.
|
|
4035
|
-
|
|
4036
4410
|
</dd>
|
|
4037
4411
|
</dl>
|
|
4038
4412
|
</dd>
|
|
@@ -4048,8 +4422,8 @@ List all active versions for a knowledge base. Returns the most recent versions
|
|
|
4048
4422
|
|
|
4049
4423
|
```typescript
|
|
4050
4424
|
await client.knowledge.listKnowledgeBaseVersions("knowledgeBaseReferenceId");
|
|
4051
|
-
```
|
|
4052
4425
|
|
|
4426
|
+
```
|
|
4053
4427
|
</dd>
|
|
4054
4428
|
</dl>
|
|
4055
4429
|
</dd>
|
|
@@ -4064,28 +4438,29 @@ await client.knowledge.listKnowledgeBaseVersions("knowledgeBaseReferenceId");
|
|
|
4064
4438
|
<dd>
|
|
4065
4439
|
|
|
4066
4440
|
**knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base to list versions for. All other entity ID fields are inferred from the request.
|
|
4067
|
-
|
|
4441
|
+
|
|
4068
4442
|
</dd>
|
|
4069
4443
|
</dl>
|
|
4070
4444
|
|
|
4071
4445
|
<dl>
|
|
4072
4446
|
<dd>
|
|
4073
4447
|
|
|
4074
|
-
**request:** `MavenAGI.KnowledgeBaseVersionsListRequest`
|
|
4075
|
-
|
|
4448
|
+
**request:** `MavenAGI.KnowledgeBaseVersionsListRequest`
|
|
4449
|
+
|
|
4076
4450
|
</dd>
|
|
4077
4451
|
</dl>
|
|
4078
4452
|
|
|
4079
4453
|
<dl>
|
|
4080
4454
|
<dd>
|
|
4081
4455
|
|
|
4082
|
-
**requestOptions:** `Knowledge.RequestOptions`
|
|
4083
|
-
|
|
4456
|
+
**requestOptions:** `Knowledge.RequestOptions`
|
|
4457
|
+
|
|
4084
4458
|
</dd>
|
|
4085
4459
|
</dl>
|
|
4086
4460
|
</dd>
|
|
4087
4461
|
</dl>
|
|
4088
4462
|
|
|
4463
|
+
|
|
4089
4464
|
</dd>
|
|
4090
4465
|
</dl>
|
|
4091
4466
|
</details>
|
|
@@ -4103,7 +4478,6 @@ await client.knowledge.listKnowledgeBaseVersions("knowledgeBaseReferenceId");
|
|
|
4103
4478
|
<dd>
|
|
4104
4479
|
|
|
4105
4480
|
Search knowledge documents
|
|
4106
|
-
|
|
4107
4481
|
</dd>
|
|
4108
4482
|
</dl>
|
|
4109
4483
|
</dd>
|
|
@@ -4119,8 +4493,8 @@ Search knowledge documents
|
|
|
4119
4493
|
|
|
4120
4494
|
```typescript
|
|
4121
4495
|
await client.knowledge.searchKnowledgeDocuments({});
|
|
4122
|
-
```
|
|
4123
4496
|
|
|
4497
|
+
```
|
|
4124
4498
|
</dd>
|
|
4125
4499
|
</dl>
|
|
4126
4500
|
</dd>
|
|
@@ -4134,21 +4508,22 @@ await client.knowledge.searchKnowledgeDocuments({});
|
|
|
4134
4508
|
<dl>
|
|
4135
4509
|
<dd>
|
|
4136
4510
|
|
|
4137
|
-
**request:** `MavenAGI.KnowledgeDocumentSearchRequest`
|
|
4138
|
-
|
|
4511
|
+
**request:** `MavenAGI.KnowledgeDocumentSearchRequest`
|
|
4512
|
+
|
|
4139
4513
|
</dd>
|
|
4140
4514
|
</dl>
|
|
4141
4515
|
|
|
4142
4516
|
<dl>
|
|
4143
4517
|
<dd>
|
|
4144
4518
|
|
|
4145
|
-
**requestOptions:** `Knowledge.RequestOptions`
|
|
4146
|
-
|
|
4519
|
+
**requestOptions:** `Knowledge.RequestOptions`
|
|
4520
|
+
|
|
4147
4521
|
</dd>
|
|
4148
4522
|
</dl>
|
|
4149
4523
|
</dd>
|
|
4150
4524
|
</dl>
|
|
4151
4525
|
|
|
4526
|
+
|
|
4152
4527
|
</dd>
|
|
4153
4528
|
</dl>
|
|
4154
4529
|
</details>
|
|
@@ -4188,22 +4563,22 @@ have changed, a new document version will not be created. The existing version w
|
|
|
4188
4563
|
```typescript
|
|
4189
4564
|
await client.knowledge.createKnowledgeDocument("help-center", {
|
|
4190
4565
|
knowledgeDocumentId: {
|
|
4191
|
-
referenceId: "getting-started"
|
|
4566
|
+
referenceId: "getting-started"
|
|
4192
4567
|
},
|
|
4193
4568
|
versionId: {
|
|
4194
4569
|
type: "KNOWLEDGE_BASE_VERSION",
|
|
4195
4570
|
referenceId: "versionId",
|
|
4196
|
-
appId: "maven"
|
|
4571
|
+
appId: "maven"
|
|
4197
4572
|
},
|
|
4198
4573
|
contentType: "MARKDOWN",
|
|
4199
4574
|
content: "## Getting started\\nThis is a getting started guide for the help center.",
|
|
4200
4575
|
title: "Getting started",
|
|
4201
4576
|
metadata: {
|
|
4202
|
-
category: "getting-started"
|
|
4203
|
-
}
|
|
4577
|
+
"category": "getting-started"
|
|
4578
|
+
}
|
|
4204
4579
|
});
|
|
4205
|
-
```
|
|
4206
4580
|
|
|
4581
|
+
```
|
|
4207
4582
|
</dd>
|
|
4208
4583
|
</dl>
|
|
4209
4584
|
</dd>
|
|
@@ -4218,28 +4593,29 @@ await client.knowledge.createKnowledgeDocument("help-center", {
|
|
|
4218
4593
|
<dd>
|
|
4219
4594
|
|
|
4220
4595
|
**knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base to create a document for. All other entity ID fields are inferred from the request.
|
|
4221
|
-
|
|
4596
|
+
|
|
4222
4597
|
</dd>
|
|
4223
4598
|
</dl>
|
|
4224
4599
|
|
|
4225
4600
|
<dl>
|
|
4226
4601
|
<dd>
|
|
4227
4602
|
|
|
4228
|
-
**request:** `MavenAGI.KnowledgeDocumentRequest`
|
|
4229
|
-
|
|
4603
|
+
**request:** `MavenAGI.KnowledgeDocumentRequest`
|
|
4604
|
+
|
|
4230
4605
|
</dd>
|
|
4231
4606
|
</dl>
|
|
4232
4607
|
|
|
4233
4608
|
<dl>
|
|
4234
4609
|
<dd>
|
|
4235
4610
|
|
|
4236
|
-
**requestOptions:** `Knowledge.RequestOptions`
|
|
4237
|
-
|
|
4611
|
+
**requestOptions:** `Knowledge.RequestOptions`
|
|
4612
|
+
|
|
4238
4613
|
</dd>
|
|
4239
4614
|
</dl>
|
|
4240
4615
|
</dd>
|
|
4241
4616
|
</dl>
|
|
4242
4617
|
|
|
4618
|
+
|
|
4243
4619
|
</dd>
|
|
4244
4620
|
</dl>
|
|
4245
4621
|
</details>
|
|
@@ -4258,7 +4634,6 @@ await client.knowledge.createKnowledgeDocument("help-center", {
|
|
|
4258
4634
|
|
|
4259
4635
|
Delete knowledge document from a specific version.
|
|
4260
4636
|
Requires an existing knowledge base with an in progress version of type PARTIAL. Will throw an exception if the version is not in progress.
|
|
4261
|
-
|
|
4262
4637
|
</dd>
|
|
4263
4638
|
</dl>
|
|
4264
4639
|
</dd>
|
|
@@ -4277,11 +4652,11 @@ await client.knowledge.deleteKnowledgeDocument("help-center", "getting-started",
|
|
|
4277
4652
|
versionId: {
|
|
4278
4653
|
type: "KNOWLEDGE_BASE_VERSION",
|
|
4279
4654
|
appId: "maven",
|
|
4280
|
-
referenceId: "versionId"
|
|
4281
|
-
}
|
|
4655
|
+
referenceId: "versionId"
|
|
4656
|
+
}
|
|
4282
4657
|
});
|
|
4283
|
-
```
|
|
4284
4658
|
|
|
4659
|
+
```
|
|
4285
4660
|
</dd>
|
|
4286
4661
|
</dl>
|
|
4287
4662
|
</dd>
|
|
@@ -4296,7 +4671,7 @@ await client.knowledge.deleteKnowledgeDocument("help-center", "getting-started",
|
|
|
4296
4671
|
<dd>
|
|
4297
4672
|
|
|
4298
4673
|
**knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base that contains the document to delete. All other entity ID fields are inferred from the request
|
|
4299
|
-
|
|
4674
|
+
|
|
4300
4675
|
</dd>
|
|
4301
4676
|
</dl>
|
|
4302
4677
|
|
|
@@ -4304,28 +4679,29 @@ await client.knowledge.deleteKnowledgeDocument("help-center", "getting-started",
|
|
|
4304
4679
|
<dd>
|
|
4305
4680
|
|
|
4306
4681
|
**knowledgeDocumentReferenceId:** `string` — The reference ID of the knowledge document to delete. All other entity ID fields are inferred from the request.
|
|
4307
|
-
|
|
4682
|
+
|
|
4308
4683
|
</dd>
|
|
4309
4684
|
</dl>
|
|
4310
4685
|
|
|
4311
4686
|
<dl>
|
|
4312
4687
|
<dd>
|
|
4313
4688
|
|
|
4314
|
-
**request:** `MavenAGI.KnowledgeDeleteRequest`
|
|
4315
|
-
|
|
4689
|
+
**request:** `MavenAGI.KnowledgeDeleteRequest`
|
|
4690
|
+
|
|
4316
4691
|
</dd>
|
|
4317
4692
|
</dl>
|
|
4318
4693
|
|
|
4319
4694
|
<dl>
|
|
4320
4695
|
<dd>
|
|
4321
4696
|
|
|
4322
|
-
**requestOptions:** `Knowledge.RequestOptions`
|
|
4323
|
-
|
|
4697
|
+
**requestOptions:** `Knowledge.RequestOptions`
|
|
4698
|
+
|
|
4324
4699
|
</dd>
|
|
4325
4700
|
</dl>
|
|
4326
4701
|
</dd>
|
|
4327
4702
|
</dl>
|
|
4328
4703
|
|
|
4704
|
+
|
|
4329
4705
|
</dd>
|
|
4330
4706
|
</dl>
|
|
4331
4707
|
</details>
|
|
@@ -4343,7 +4719,6 @@ await client.knowledge.deleteKnowledgeDocument("help-center", "getting-started",
|
|
|
4343
4719
|
<dd>
|
|
4344
4720
|
|
|
4345
4721
|
Get a knowledge document by its supplied version and document IDs. Response includes document content in markdown format.
|
|
4346
|
-
|
|
4347
4722
|
</dd>
|
|
4348
4723
|
</dl>
|
|
4349
4724
|
</dd>
|
|
@@ -4359,10 +4734,10 @@ Get a knowledge document by its supplied version and document IDs. Response incl
|
|
|
4359
4734
|
|
|
4360
4735
|
```typescript
|
|
4361
4736
|
await client.knowledge.getKnowledgeDocument("knowledgeBaseVersionReferenceId", "knowledgeDocumentReferenceId", {
|
|
4362
|
-
knowledgeBaseVersionAppId: "knowledgeBaseVersionAppId"
|
|
4737
|
+
knowledgeBaseVersionAppId: "knowledgeBaseVersionAppId"
|
|
4363
4738
|
});
|
|
4364
|
-
```
|
|
4365
4739
|
|
|
4740
|
+
```
|
|
4366
4741
|
</dd>
|
|
4367
4742
|
</dl>
|
|
4368
4743
|
</dd>
|
|
@@ -4377,7 +4752,7 @@ await client.knowledge.getKnowledgeDocument("knowledgeBaseVersionReferenceId", "
|
|
|
4377
4752
|
<dd>
|
|
4378
4753
|
|
|
4379
4754
|
**knowledgeBaseVersionReferenceId:** `string` — The reference ID of the knowledge base version that contains the document. All other entity ID fields are inferred from the request.
|
|
4380
|
-
|
|
4755
|
+
|
|
4381
4756
|
</dd>
|
|
4382
4757
|
</dl>
|
|
4383
4758
|
|
|
@@ -4385,28 +4760,29 @@ await client.knowledge.getKnowledgeDocument("knowledgeBaseVersionReferenceId", "
|
|
|
4385
4760
|
<dd>
|
|
4386
4761
|
|
|
4387
4762
|
**knowledgeDocumentReferenceId:** `string` — The reference ID of the knowledge document to get. All other entity ID fields are inferred from the request.
|
|
4388
|
-
|
|
4763
|
+
|
|
4389
4764
|
</dd>
|
|
4390
4765
|
</dl>
|
|
4391
4766
|
|
|
4392
4767
|
<dl>
|
|
4393
4768
|
<dd>
|
|
4394
4769
|
|
|
4395
|
-
**request:** `MavenAGI.KnowledgeDocumentGetRequest`
|
|
4396
|
-
|
|
4770
|
+
**request:** `MavenAGI.KnowledgeDocumentGetRequest`
|
|
4771
|
+
|
|
4397
4772
|
</dd>
|
|
4398
4773
|
</dl>
|
|
4399
4774
|
|
|
4400
4775
|
<dl>
|
|
4401
4776
|
<dd>
|
|
4402
4777
|
|
|
4403
|
-
**requestOptions:** `Knowledge.RequestOptions`
|
|
4404
|
-
|
|
4778
|
+
**requestOptions:** `Knowledge.RequestOptions`
|
|
4779
|
+
|
|
4405
4780
|
</dd>
|
|
4406
4781
|
</dl>
|
|
4407
4782
|
</dd>
|
|
4408
4783
|
</dl>
|
|
4409
4784
|
|
|
4785
|
+
|
|
4410
4786
|
</dd>
|
|
4411
4787
|
</dl>
|
|
4412
4788
|
</details>
|
|
@@ -4429,7 +4805,6 @@ For any changes in document content see the `createKnowledgeBaseVersion` and `cr
|
|
|
4429
4805
|
|
|
4430
4806
|
The `knowledgeBaseAppId` field can be provided to update a knowledge document in a knowledge base owned by a different app.
|
|
4431
4807
|
All other fields will overwrite the existing value on the knowledge document only if provided.
|
|
4432
|
-
|
|
4433
4808
|
</dd>
|
|
4434
4809
|
</dl>
|
|
4435
4810
|
</dd>
|
|
@@ -4445,10 +4820,10 @@ All other fields will overwrite the existing value on the knowledge document onl
|
|
|
4445
4820
|
|
|
4446
4821
|
```typescript
|
|
4447
4822
|
await client.knowledge.patchKnowledgeDocument("help-center", "how-it-works", {
|
|
4448
|
-
llmInclusionStatus: "ALWAYS"
|
|
4823
|
+
llmInclusionStatus: "ALWAYS"
|
|
4449
4824
|
});
|
|
4450
|
-
```
|
|
4451
4825
|
|
|
4826
|
+
```
|
|
4452
4827
|
</dd>
|
|
4453
4828
|
</dl>
|
|
4454
4829
|
</dd>
|
|
@@ -4463,7 +4838,7 @@ await client.knowledge.patchKnowledgeDocument("help-center", "how-it-works", {
|
|
|
4463
4838
|
<dd>
|
|
4464
4839
|
|
|
4465
4840
|
**knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base to patch.
|
|
4466
|
-
|
|
4841
|
+
|
|
4467
4842
|
</dd>
|
|
4468
4843
|
</dl>
|
|
4469
4844
|
|
|
@@ -4471,34 +4846,34 @@ await client.knowledge.patchKnowledgeDocument("help-center", "how-it-works", {
|
|
|
4471
4846
|
<dd>
|
|
4472
4847
|
|
|
4473
4848
|
**knowledgeDocumentReferenceId:** `string` — The reference ID of the knowledge document to patch.
|
|
4474
|
-
|
|
4849
|
+
|
|
4475
4850
|
</dd>
|
|
4476
4851
|
</dl>
|
|
4477
4852
|
|
|
4478
4853
|
<dl>
|
|
4479
4854
|
<dd>
|
|
4480
4855
|
|
|
4481
|
-
**request:** `MavenAGI.KnowledgeDocumentPatchRequest`
|
|
4482
|
-
|
|
4856
|
+
**request:** `MavenAGI.KnowledgeDocumentPatchRequest`
|
|
4857
|
+
|
|
4483
4858
|
</dd>
|
|
4484
4859
|
</dl>
|
|
4485
4860
|
|
|
4486
4861
|
<dl>
|
|
4487
4862
|
<dd>
|
|
4488
4863
|
|
|
4489
|
-
**requestOptions:** `Knowledge.RequestOptions`
|
|
4490
|
-
|
|
4864
|
+
**requestOptions:** `Knowledge.RequestOptions`
|
|
4865
|
+
|
|
4491
4866
|
</dd>
|
|
4492
4867
|
</dl>
|
|
4493
4868
|
</dd>
|
|
4494
4869
|
</dl>
|
|
4495
4870
|
|
|
4871
|
+
|
|
4496
4872
|
</dd>
|
|
4497
4873
|
</dl>
|
|
4498
4874
|
</details>
|
|
4499
4875
|
|
|
4500
4876
|
## Organizations
|
|
4501
|
-
|
|
4502
4877
|
<details><summary><code>client.organizations.<a href="/src/api/resources/organizations/client/Client.ts">create</a>(organizationReferenceId, { ...params }) -> MavenAGI.Organization</code></summary>
|
|
4503
4878
|
<dl>
|
|
4504
4879
|
<dd>
|
|
@@ -4532,10 +4907,10 @@ This endpoint requires additional permissions. Contact support to request access
|
|
|
4532
4907
|
```typescript
|
|
4533
4908
|
await client.organizations.create("organizationReferenceId", {
|
|
4534
4909
|
name: "name",
|
|
4535
|
-
defaultLanguage: "defaultLanguage"
|
|
4910
|
+
defaultLanguage: "defaultLanguage"
|
|
4536
4911
|
});
|
|
4537
|
-
```
|
|
4538
4912
|
|
|
4913
|
+
```
|
|
4539
4914
|
</dd>
|
|
4540
4915
|
</dl>
|
|
4541
4916
|
</dd>
|
|
@@ -4550,28 +4925,29 @@ await client.organizations.create("organizationReferenceId", {
|
|
|
4550
4925
|
<dd>
|
|
4551
4926
|
|
|
4552
4927
|
**organizationReferenceId:** `string` — The reference ID of the organization.
|
|
4553
|
-
|
|
4928
|
+
|
|
4554
4929
|
</dd>
|
|
4555
4930
|
</dl>
|
|
4556
4931
|
|
|
4557
4932
|
<dl>
|
|
4558
4933
|
<dd>
|
|
4559
4934
|
|
|
4560
|
-
**request:** `MavenAGI.CreateOrganizationRequest`
|
|
4561
|
-
|
|
4935
|
+
**request:** `MavenAGI.CreateOrganizationRequest`
|
|
4936
|
+
|
|
4562
4937
|
</dd>
|
|
4563
4938
|
</dl>
|
|
4564
4939
|
|
|
4565
4940
|
<dl>
|
|
4566
4941
|
<dd>
|
|
4567
4942
|
|
|
4568
|
-
**requestOptions:** `Organizations.RequestOptions`
|
|
4569
|
-
|
|
4943
|
+
**requestOptions:** `Organizations.RequestOptions`
|
|
4944
|
+
|
|
4570
4945
|
</dd>
|
|
4571
4946
|
</dl>
|
|
4572
4947
|
</dd>
|
|
4573
4948
|
</dl>
|
|
4574
4949
|
|
|
4950
|
+
|
|
4575
4951
|
</dd>
|
|
4576
4952
|
</dl>
|
|
4577
4953
|
</details>
|
|
@@ -4589,7 +4965,6 @@ await client.organizations.create("organizationReferenceId", {
|
|
|
4589
4965
|
<dd>
|
|
4590
4966
|
|
|
4591
4967
|
Get an organization by ID
|
|
4592
|
-
|
|
4593
4968
|
</dd>
|
|
4594
4969
|
</dl>
|
|
4595
4970
|
</dd>
|
|
@@ -4605,8 +4980,8 @@ Get an organization by ID
|
|
|
4605
4980
|
|
|
4606
4981
|
```typescript
|
|
4607
4982
|
await client.organizations.get("organizationReferenceId");
|
|
4608
|
-
```
|
|
4609
4983
|
|
|
4984
|
+
```
|
|
4610
4985
|
</dd>
|
|
4611
4986
|
</dl>
|
|
4612
4987
|
</dd>
|
|
@@ -4621,20 +4996,21 @@ await client.organizations.get("organizationReferenceId");
|
|
|
4621
4996
|
<dd>
|
|
4622
4997
|
|
|
4623
4998
|
**organizationReferenceId:** `string` — The reference ID of the organization.
|
|
4624
|
-
|
|
4999
|
+
|
|
4625
5000
|
</dd>
|
|
4626
5001
|
</dl>
|
|
4627
5002
|
|
|
4628
5003
|
<dl>
|
|
4629
5004
|
<dd>
|
|
4630
5005
|
|
|
4631
|
-
**requestOptions:** `Organizations.RequestOptions`
|
|
4632
|
-
|
|
5006
|
+
**requestOptions:** `Organizations.RequestOptions`
|
|
5007
|
+
|
|
4633
5008
|
</dd>
|
|
4634
5009
|
</dl>
|
|
4635
5010
|
</dd>
|
|
4636
5011
|
</dl>
|
|
4637
5012
|
|
|
5013
|
+
|
|
4638
5014
|
</dd>
|
|
4639
5015
|
</dl>
|
|
4640
5016
|
</details>
|
|
@@ -4672,8 +5048,8 @@ This endpoint requires additional permissions. Contact support to request access
|
|
|
4672
5048
|
|
|
4673
5049
|
```typescript
|
|
4674
5050
|
await client.organizations.patch("organizationReferenceId", {});
|
|
4675
|
-
```
|
|
4676
5051
|
|
|
5052
|
+
```
|
|
4677
5053
|
</dd>
|
|
4678
5054
|
</dl>
|
|
4679
5055
|
</dd>
|
|
@@ -4688,28 +5064,29 @@ await client.organizations.patch("organizationReferenceId", {});
|
|
|
4688
5064
|
<dd>
|
|
4689
5065
|
|
|
4690
5066
|
**organizationReferenceId:** `string` — The reference ID of the organization.
|
|
4691
|
-
|
|
5067
|
+
|
|
4692
5068
|
</dd>
|
|
4693
5069
|
</dl>
|
|
4694
5070
|
|
|
4695
5071
|
<dl>
|
|
4696
5072
|
<dd>
|
|
4697
5073
|
|
|
4698
|
-
**request:** `MavenAGI.OrganizationPatchRequest`
|
|
4699
|
-
|
|
5074
|
+
**request:** `MavenAGI.OrganizationPatchRequest`
|
|
5075
|
+
|
|
4700
5076
|
</dd>
|
|
4701
5077
|
</dl>
|
|
4702
5078
|
|
|
4703
5079
|
<dl>
|
|
4704
5080
|
<dd>
|
|
4705
5081
|
|
|
4706
|
-
**requestOptions:** `Organizations.RequestOptions`
|
|
4707
|
-
|
|
5082
|
+
**requestOptions:** `Organizations.RequestOptions`
|
|
5083
|
+
|
|
4708
5084
|
</dd>
|
|
4709
5085
|
</dl>
|
|
4710
5086
|
</dd>
|
|
4711
5087
|
</dl>
|
|
4712
5088
|
|
|
5089
|
+
|
|
4713
5090
|
</dd>
|
|
4714
5091
|
</dl>
|
|
4715
5092
|
</details>
|
|
@@ -4746,8 +5123,8 @@ This endpoint requires additional permissions. Contact support to request access
|
|
|
4746
5123
|
|
|
4747
5124
|
```typescript
|
|
4748
5125
|
await client.organizations.delete("organizationReferenceId");
|
|
4749
|
-
```
|
|
4750
5126
|
|
|
5127
|
+
```
|
|
4751
5128
|
</dd>
|
|
4752
5129
|
</dl>
|
|
4753
5130
|
</dd>
|
|
@@ -4762,20 +5139,21 @@ await client.organizations.delete("organizationReferenceId");
|
|
|
4762
5139
|
<dd>
|
|
4763
5140
|
|
|
4764
5141
|
**organizationReferenceId:** `string` — The reference ID of the organization.
|
|
4765
|
-
|
|
5142
|
+
|
|
4766
5143
|
</dd>
|
|
4767
5144
|
</dl>
|
|
4768
5145
|
|
|
4769
5146
|
<dl>
|
|
4770
5147
|
<dd>
|
|
4771
5148
|
|
|
4772
|
-
**requestOptions:** `Organizations.RequestOptions`
|
|
4773
|
-
|
|
5149
|
+
**requestOptions:** `Organizations.RequestOptions`
|
|
5150
|
+
|
|
4774
5151
|
</dd>
|
|
4775
5152
|
</dl>
|
|
4776
5153
|
</dd>
|
|
4777
5154
|
</dl>
|
|
4778
5155
|
|
|
5156
|
+
|
|
4779
5157
|
</dd>
|
|
4780
5158
|
</dl>
|
|
4781
5159
|
</details>
|
|
@@ -4792,7 +5170,7 @@ await client.organizations.delete("organizationReferenceId");
|
|
|
4792
5170
|
<dl>
|
|
4793
5171
|
<dd>
|
|
4794
5172
|
|
|
4795
|
-
Retrieves structured conversation data across all organizations, formatted as a table,
|
|
5173
|
+
Retrieves structured conversation data across all organizations, formatted as a table,
|
|
4796
5174
|
allowing users to group, filter, and define specific metrics to display as columns.
|
|
4797
5175
|
|
|
4798
5176
|
<Tip>
|
|
@@ -4814,40 +5192,34 @@ This endpoint requires additional permissions. Contact support to request access
|
|
|
4814
5192
|
```typescript
|
|
4815
5193
|
await client.organizations.getConversationTable({
|
|
4816
5194
|
conversationFilter: {
|
|
4817
|
-
languages: ["en", "es"]
|
|
5195
|
+
languages: ["en", "es"]
|
|
4818
5196
|
},
|
|
4819
5197
|
timeGrouping: "DAY",
|
|
4820
|
-
fieldGroupings: [
|
|
4821
|
-
|
|
4822
|
-
|
|
4823
|
-
|
|
4824
|
-
],
|
|
4825
|
-
columnDefinitions: [
|
|
4826
|
-
{
|
|
5198
|
+
fieldGroupings: [{
|
|
5199
|
+
field: "Category"
|
|
5200
|
+
}],
|
|
5201
|
+
columnDefinitions: [{
|
|
4827
5202
|
header: "count",
|
|
4828
5203
|
metric: {
|
|
4829
|
-
type: "count"
|
|
4830
|
-
}
|
|
4831
|
-
},
|
|
4832
|
-
{
|
|
5204
|
+
type: "count"
|
|
5205
|
+
}
|
|
5206
|
+
}, {
|
|
4833
5207
|
header: "avg_first_response_time",
|
|
4834
5208
|
metric: {
|
|
4835
5209
|
type: "average",
|
|
4836
|
-
targetField: "FirstResponseTime"
|
|
4837
|
-
}
|
|
4838
|
-
},
|
|
4839
|
-
{
|
|
5210
|
+
targetField: "FirstResponseTime"
|
|
5211
|
+
}
|
|
5212
|
+
}, {
|
|
4840
5213
|
header: "percentile_handle_time",
|
|
4841
5214
|
metric: {
|
|
4842
5215
|
type: "percentile",
|
|
4843
5216
|
targetField: "HandleTime",
|
|
4844
|
-
percentile: 25
|
|
4845
|
-
}
|
|
4846
|
-
}
|
|
4847
|
-
],
|
|
5217
|
+
percentile: 25
|
|
5218
|
+
}
|
|
5219
|
+
}]
|
|
4848
5220
|
});
|
|
4849
|
-
```
|
|
4850
5221
|
|
|
5222
|
+
```
|
|
4851
5223
|
</dd>
|
|
4852
5224
|
</dl>
|
|
4853
5225
|
</dd>
|
|
@@ -4861,21 +5233,22 @@ await client.organizations.getConversationTable({
|
|
|
4861
5233
|
<dl>
|
|
4862
5234
|
<dd>
|
|
4863
5235
|
|
|
4864
|
-
**request:** `MavenAGI.ConversationTableRequest`
|
|
4865
|
-
|
|
5236
|
+
**request:** `MavenAGI.ConversationTableRequest`
|
|
5237
|
+
|
|
4866
5238
|
</dd>
|
|
4867
5239
|
</dl>
|
|
4868
5240
|
|
|
4869
5241
|
<dl>
|
|
4870
5242
|
<dd>
|
|
4871
5243
|
|
|
4872
|
-
**requestOptions:** `Organizations.RequestOptions`
|
|
4873
|
-
|
|
5244
|
+
**requestOptions:** `Organizations.RequestOptions`
|
|
5245
|
+
|
|
4874
5246
|
</dd>
|
|
4875
5247
|
</dl>
|
|
4876
5248
|
</dd>
|
|
4877
5249
|
</dl>
|
|
4878
5250
|
|
|
5251
|
+
|
|
4879
5252
|
</dd>
|
|
4880
5253
|
</dl>
|
|
4881
5254
|
</details>
|
|
@@ -4892,7 +5265,7 @@ await client.organizations.getConversationTable({
|
|
|
4892
5265
|
<dl>
|
|
4893
5266
|
<dd>
|
|
4894
5267
|
|
|
4895
|
-
Fetches conversation data across all organizations, visualized in a chart format.
|
|
5268
|
+
Fetches conversation data across all organizations, visualized in a chart format.
|
|
4896
5269
|
Supported chart types include pie chart, date histogram, and stacked bar charts.
|
|
4897
5270
|
|
|
4898
5271
|
<Tip>
|
|
@@ -4915,17 +5288,17 @@ This endpoint requires additional permissions. Contact support to request access
|
|
|
4915
5288
|
await client.organizations.getConversationChart({
|
|
4916
5289
|
type: "pieChart",
|
|
4917
5290
|
conversationFilter: {
|
|
4918
|
-
languages: ["en", "es"]
|
|
5291
|
+
languages: ["en", "es"]
|
|
4919
5292
|
},
|
|
4920
5293
|
groupBy: {
|
|
4921
|
-
field: "Category"
|
|
5294
|
+
field: "Category"
|
|
4922
5295
|
},
|
|
4923
5296
|
metric: {
|
|
4924
|
-
type: "count"
|
|
4925
|
-
}
|
|
5297
|
+
type: "count"
|
|
5298
|
+
}
|
|
4926
5299
|
});
|
|
4927
|
-
```
|
|
4928
5300
|
|
|
5301
|
+
```
|
|
4929
5302
|
</dd>
|
|
4930
5303
|
</dl>
|
|
4931
5304
|
</dd>
|
|
@@ -4939,27 +5312,27 @@ await client.organizations.getConversationChart({
|
|
|
4939
5312
|
<dl>
|
|
4940
5313
|
<dd>
|
|
4941
5314
|
|
|
4942
|
-
**request:** `MavenAGI.ConversationChartRequest`
|
|
4943
|
-
|
|
5315
|
+
**request:** `MavenAGI.ConversationChartRequest`
|
|
5316
|
+
|
|
4944
5317
|
</dd>
|
|
4945
5318
|
</dl>
|
|
4946
5319
|
|
|
4947
5320
|
<dl>
|
|
4948
5321
|
<dd>
|
|
4949
5322
|
|
|
4950
|
-
**requestOptions:** `Organizations.RequestOptions`
|
|
4951
|
-
|
|
5323
|
+
**requestOptions:** `Organizations.RequestOptions`
|
|
5324
|
+
|
|
4952
5325
|
</dd>
|
|
4953
5326
|
</dl>
|
|
4954
5327
|
</dd>
|
|
4955
5328
|
</dl>
|
|
4956
5329
|
|
|
5330
|
+
|
|
4957
5331
|
</dd>
|
|
4958
5332
|
</dl>
|
|
4959
5333
|
</details>
|
|
4960
5334
|
|
|
4961
5335
|
## Segments
|
|
4962
|
-
|
|
4963
5336
|
<details><summary><code>client.segments.<a href="/src/api/resources/segments/client/Client.ts">search</a>({ ...params }) -> MavenAGI.SegmentsSearchResponse</code></summary>
|
|
4964
5337
|
<dl>
|
|
4965
5338
|
<dd>
|
|
@@ -4974,8 +5347,8 @@ await client.organizations.getConversationChart({
|
|
|
4974
5347
|
|
|
4975
5348
|
```typescript
|
|
4976
5349
|
await client.segments.search({});
|
|
4977
|
-
```
|
|
4978
5350
|
|
|
5351
|
+
```
|
|
4979
5352
|
</dd>
|
|
4980
5353
|
</dl>
|
|
4981
5354
|
</dd>
|
|
@@ -4989,21 +5362,22 @@ await client.segments.search({});
|
|
|
4989
5362
|
<dl>
|
|
4990
5363
|
<dd>
|
|
4991
5364
|
|
|
4992
|
-
**request:** `MavenAGI.SegmentsSearchRequest`
|
|
4993
|
-
|
|
5365
|
+
**request:** `MavenAGI.SegmentsSearchRequest`
|
|
5366
|
+
|
|
4994
5367
|
</dd>
|
|
4995
5368
|
</dl>
|
|
4996
5369
|
|
|
4997
5370
|
<dl>
|
|
4998
5371
|
<dd>
|
|
4999
5372
|
|
|
5000
|
-
**requestOptions:** `Segments.RequestOptions`
|
|
5001
|
-
|
|
5373
|
+
**requestOptions:** `Segments.RequestOptions`
|
|
5374
|
+
|
|
5002
5375
|
</dd>
|
|
5003
5376
|
</dl>
|
|
5004
5377
|
</dd>
|
|
5005
5378
|
</dl>
|
|
5006
5379
|
|
|
5380
|
+
|
|
5007
5381
|
</dd>
|
|
5008
5382
|
</dl>
|
|
5009
5383
|
</details>
|
|
@@ -5021,7 +5395,6 @@ await client.segments.search({});
|
|
|
5021
5395
|
<dd>
|
|
5022
5396
|
|
|
5023
5397
|
Update a segment or create it if it doesn't exist.
|
|
5024
|
-
|
|
5025
5398
|
</dd>
|
|
5026
5399
|
</dl>
|
|
5027
5400
|
</dd>
|
|
@@ -5038,26 +5411,23 @@ Update a segment or create it if it doesn't exist.
|
|
|
5038
5411
|
```typescript
|
|
5039
5412
|
await client.segments.createOrUpdate({
|
|
5040
5413
|
segmentId: {
|
|
5041
|
-
referenceId: "admin-users"
|
|
5414
|
+
referenceId: "admin-users"
|
|
5042
5415
|
},
|
|
5043
5416
|
name: "Admin users",
|
|
5044
5417
|
precondition: {
|
|
5045
5418
|
preconditionType: "group",
|
|
5046
5419
|
operator: "AND",
|
|
5047
|
-
preconditions: [
|
|
5048
|
-
|
|
5049
|
-
|
|
5050
|
-
|
|
5051
|
-
|
|
5052
|
-
|
|
5053
|
-
|
|
5054
|
-
|
|
5055
|
-
},
|
|
5056
|
-
],
|
|
5057
|
-
},
|
|
5420
|
+
preconditions: [{
|
|
5421
|
+
"preconditionType": "user",
|
|
5422
|
+
"key": "userKey"
|
|
5423
|
+
}, {
|
|
5424
|
+
"preconditionType": "user",
|
|
5425
|
+
"key": "userKey2"
|
|
5426
|
+
}]
|
|
5427
|
+
}
|
|
5058
5428
|
});
|
|
5059
|
-
```
|
|
5060
5429
|
|
|
5430
|
+
```
|
|
5061
5431
|
</dd>
|
|
5062
5432
|
</dl>
|
|
5063
5433
|
</dd>
|
|
@@ -5071,21 +5441,22 @@ await client.segments.createOrUpdate({
|
|
|
5071
5441
|
<dl>
|
|
5072
5442
|
<dd>
|
|
5073
5443
|
|
|
5074
|
-
**request:** `MavenAGI.SegmentRequest`
|
|
5075
|
-
|
|
5444
|
+
**request:** `MavenAGI.SegmentRequest`
|
|
5445
|
+
|
|
5076
5446
|
</dd>
|
|
5077
5447
|
</dl>
|
|
5078
5448
|
|
|
5079
5449
|
<dl>
|
|
5080
5450
|
<dd>
|
|
5081
5451
|
|
|
5082
|
-
**requestOptions:** `Segments.RequestOptions`
|
|
5083
|
-
|
|
5452
|
+
**requestOptions:** `Segments.RequestOptions`
|
|
5453
|
+
|
|
5084
5454
|
</dd>
|
|
5085
5455
|
</dl>
|
|
5086
5456
|
</dd>
|
|
5087
5457
|
</dl>
|
|
5088
5458
|
|
|
5459
|
+
|
|
5089
5460
|
</dd>
|
|
5090
5461
|
</dl>
|
|
5091
5462
|
</details>
|
|
@@ -5103,7 +5474,6 @@ await client.segments.createOrUpdate({
|
|
|
5103
5474
|
<dd>
|
|
5104
5475
|
|
|
5105
5476
|
Get a segment by its supplied ID
|
|
5106
|
-
|
|
5107
5477
|
</dd>
|
|
5108
5478
|
</dl>
|
|
5109
5479
|
</dd>
|
|
@@ -5119,8 +5489,8 @@ Get a segment by its supplied ID
|
|
|
5119
5489
|
|
|
5120
5490
|
```typescript
|
|
5121
5491
|
await client.segments.get("admin-users");
|
|
5122
|
-
```
|
|
5123
5492
|
|
|
5493
|
+
```
|
|
5124
5494
|
</dd>
|
|
5125
5495
|
</dl>
|
|
5126
5496
|
</dd>
|
|
@@ -5135,28 +5505,29 @@ await client.segments.get("admin-users");
|
|
|
5135
5505
|
<dd>
|
|
5136
5506
|
|
|
5137
5507
|
**segmentReferenceId:** `string` — The reference ID of the segment to get. All other entity ID fields are inferred from the request.
|
|
5138
|
-
|
|
5508
|
+
|
|
5139
5509
|
</dd>
|
|
5140
5510
|
</dl>
|
|
5141
5511
|
|
|
5142
5512
|
<dl>
|
|
5143
5513
|
<dd>
|
|
5144
5514
|
|
|
5145
|
-
**request:** `MavenAGI.SegmentGetRequest`
|
|
5146
|
-
|
|
5515
|
+
**request:** `MavenAGI.SegmentGetRequest`
|
|
5516
|
+
|
|
5147
5517
|
</dd>
|
|
5148
5518
|
</dl>
|
|
5149
5519
|
|
|
5150
5520
|
<dl>
|
|
5151
5521
|
<dd>
|
|
5152
5522
|
|
|
5153
|
-
**requestOptions:** `Segments.RequestOptions`
|
|
5154
|
-
|
|
5523
|
+
**requestOptions:** `Segments.RequestOptions`
|
|
5524
|
+
|
|
5155
5525
|
</dd>
|
|
5156
5526
|
</dl>
|
|
5157
5527
|
</dd>
|
|
5158
5528
|
</dl>
|
|
5159
5529
|
|
|
5530
|
+
|
|
5160
5531
|
</dd>
|
|
5161
5532
|
</dl>
|
|
5162
5533
|
</details>
|
|
@@ -5175,9 +5546,8 @@ await client.segments.get("admin-users");
|
|
|
5175
5546
|
|
|
5176
5547
|
Update mutable segment fields
|
|
5177
5548
|
|
|
5178
|
-
The `appId` field can be provided to update a segment owned by a different app.
|
|
5549
|
+
The `appId` field can be provided to update a segment owned by a different app.
|
|
5179
5550
|
All other fields will overwrite the existing value on the segment only if provided.
|
|
5180
|
-
|
|
5181
5551
|
</dd>
|
|
5182
5552
|
</dl>
|
|
5183
5553
|
</dd>
|
|
@@ -5193,8 +5563,8 @@ All other fields will overwrite the existing value on the segment only if provid
|
|
|
5193
5563
|
|
|
5194
5564
|
```typescript
|
|
5195
5565
|
await client.segments.patch("segmentReferenceId", {});
|
|
5196
|
-
```
|
|
5197
5566
|
|
|
5567
|
+
```
|
|
5198
5568
|
</dd>
|
|
5199
5569
|
</dl>
|
|
5200
5570
|
</dd>
|
|
@@ -5209,34 +5579,34 @@ await client.segments.patch("segmentReferenceId", {});
|
|
|
5209
5579
|
<dd>
|
|
5210
5580
|
|
|
5211
5581
|
**segmentReferenceId:** `string` — The reference ID of the segment to update. All other entity ID fields are inferred from the request.
|
|
5212
|
-
|
|
5582
|
+
|
|
5213
5583
|
</dd>
|
|
5214
5584
|
</dl>
|
|
5215
5585
|
|
|
5216
5586
|
<dl>
|
|
5217
5587
|
<dd>
|
|
5218
5588
|
|
|
5219
|
-
**request:** `MavenAGI.SegmentPatchRequest`
|
|
5220
|
-
|
|
5589
|
+
**request:** `MavenAGI.SegmentPatchRequest`
|
|
5590
|
+
|
|
5221
5591
|
</dd>
|
|
5222
5592
|
</dl>
|
|
5223
5593
|
|
|
5224
5594
|
<dl>
|
|
5225
5595
|
<dd>
|
|
5226
5596
|
|
|
5227
|
-
**requestOptions:** `Segments.RequestOptions`
|
|
5228
|
-
|
|
5597
|
+
**requestOptions:** `Segments.RequestOptions`
|
|
5598
|
+
|
|
5229
5599
|
</dd>
|
|
5230
5600
|
</dl>
|
|
5231
5601
|
</dd>
|
|
5232
5602
|
</dl>
|
|
5233
5603
|
|
|
5604
|
+
|
|
5234
5605
|
</dd>
|
|
5235
5606
|
</dl>
|
|
5236
5607
|
</details>
|
|
5237
5608
|
|
|
5238
5609
|
## Translations
|
|
5239
|
-
|
|
5240
5610
|
<details><summary><code>client.translations.<a href="/src/api/resources/translations/client/Client.ts">translate</a>({ ...params }) -> MavenAGI.TranslationResponse</code></summary>
|
|
5241
5611
|
<dl>
|
|
5242
5612
|
<dd>
|
|
@@ -5250,7 +5620,6 @@ await client.segments.patch("segmentReferenceId", {});
|
|
|
5250
5620
|
<dd>
|
|
5251
5621
|
|
|
5252
5622
|
Translate text from one language to another
|
|
5253
|
-
|
|
5254
5623
|
</dd>
|
|
5255
5624
|
</dl>
|
|
5256
5625
|
</dd>
|
|
@@ -5267,10 +5636,10 @@ Translate text from one language to another
|
|
|
5267
5636
|
```typescript
|
|
5268
5637
|
await client.translations.translate({
|
|
5269
5638
|
text: "Hello world",
|
|
5270
|
-
targetLanguage: "es"
|
|
5639
|
+
targetLanguage: "es"
|
|
5271
5640
|
});
|
|
5272
|
-
```
|
|
5273
5641
|
|
|
5642
|
+
```
|
|
5274
5643
|
</dd>
|
|
5275
5644
|
</dl>
|
|
5276
5645
|
</dd>
|
|
@@ -5284,27 +5653,27 @@ await client.translations.translate({
|
|
|
5284
5653
|
<dl>
|
|
5285
5654
|
<dd>
|
|
5286
5655
|
|
|
5287
|
-
**request:** `MavenAGI.TranslationRequest`
|
|
5288
|
-
|
|
5656
|
+
**request:** `MavenAGI.TranslationRequest`
|
|
5657
|
+
|
|
5289
5658
|
</dd>
|
|
5290
5659
|
</dl>
|
|
5291
5660
|
|
|
5292
5661
|
<dl>
|
|
5293
5662
|
<dd>
|
|
5294
5663
|
|
|
5295
|
-
**requestOptions:** `Translations.RequestOptions`
|
|
5296
|
-
|
|
5664
|
+
**requestOptions:** `Translations.RequestOptions`
|
|
5665
|
+
|
|
5297
5666
|
</dd>
|
|
5298
5667
|
</dl>
|
|
5299
5668
|
</dd>
|
|
5300
5669
|
</dl>
|
|
5301
5670
|
|
|
5671
|
+
|
|
5302
5672
|
</dd>
|
|
5303
5673
|
</dl>
|
|
5304
5674
|
</details>
|
|
5305
5675
|
|
|
5306
5676
|
## Triggers
|
|
5307
|
-
|
|
5308
5677
|
<details><summary><code>client.triggers.<a href="/src/api/resources/triggers/client/Client.ts">search</a>({ ...params }) -> MavenAGI.EventTriggersSearchResponse</code></summary>
|
|
5309
5678
|
<dl>
|
|
5310
5679
|
<dd>
|
|
@@ -5319,8 +5688,8 @@ await client.translations.translate({
|
|
|
5319
5688
|
|
|
5320
5689
|
```typescript
|
|
5321
5690
|
await client.triggers.search({});
|
|
5322
|
-
```
|
|
5323
5691
|
|
|
5692
|
+
```
|
|
5324
5693
|
</dd>
|
|
5325
5694
|
</dl>
|
|
5326
5695
|
</dd>
|
|
@@ -5334,21 +5703,22 @@ await client.triggers.search({});
|
|
|
5334
5703
|
<dl>
|
|
5335
5704
|
<dd>
|
|
5336
5705
|
|
|
5337
|
-
**request:** `MavenAGI.EventTriggersSearchRequest`
|
|
5338
|
-
|
|
5706
|
+
**request:** `MavenAGI.EventTriggersSearchRequest`
|
|
5707
|
+
|
|
5339
5708
|
</dd>
|
|
5340
5709
|
</dl>
|
|
5341
5710
|
|
|
5342
5711
|
<dl>
|
|
5343
5712
|
<dd>
|
|
5344
5713
|
|
|
5345
|
-
**requestOptions:** `Triggers.RequestOptions`
|
|
5346
|
-
|
|
5714
|
+
**requestOptions:** `Triggers.RequestOptions`
|
|
5715
|
+
|
|
5347
5716
|
</dd>
|
|
5348
5717
|
</dl>
|
|
5349
5718
|
</dd>
|
|
5350
5719
|
</dl>
|
|
5351
5720
|
|
|
5721
|
+
|
|
5352
5722
|
</dd>
|
|
5353
5723
|
</dl>
|
|
5354
5724
|
</details>
|
|
@@ -5366,7 +5736,6 @@ await client.triggers.search({});
|
|
|
5366
5736
|
<dd>
|
|
5367
5737
|
|
|
5368
5738
|
Update an event trigger or create it if it doesn't exist.
|
|
5369
|
-
|
|
5370
5739
|
</dd>
|
|
5371
5740
|
</dl>
|
|
5372
5741
|
</dd>
|
|
@@ -5383,13 +5752,13 @@ Update an event trigger or create it if it doesn't exist.
|
|
|
5383
5752
|
```typescript
|
|
5384
5753
|
await client.triggers.createOrUpdate({
|
|
5385
5754
|
triggerId: {
|
|
5386
|
-
referenceId: "store-in-snowflake"
|
|
5755
|
+
referenceId: "store-in-snowflake"
|
|
5387
5756
|
},
|
|
5388
5757
|
description: "Stores conversation data in Snowflake",
|
|
5389
|
-
type: "CONVERSATION_CREATED"
|
|
5758
|
+
type: "CONVERSATION_CREATED"
|
|
5390
5759
|
});
|
|
5391
|
-
```
|
|
5392
5760
|
|
|
5761
|
+
```
|
|
5393
5762
|
</dd>
|
|
5394
5763
|
</dl>
|
|
5395
5764
|
</dd>
|
|
@@ -5403,21 +5772,22 @@ await client.triggers.createOrUpdate({
|
|
|
5403
5772
|
<dl>
|
|
5404
5773
|
<dd>
|
|
5405
5774
|
|
|
5406
|
-
**request:** `MavenAGI.EventTriggerRequest`
|
|
5407
|
-
|
|
5775
|
+
**request:** `MavenAGI.EventTriggerRequest`
|
|
5776
|
+
|
|
5408
5777
|
</dd>
|
|
5409
5778
|
</dl>
|
|
5410
5779
|
|
|
5411
5780
|
<dl>
|
|
5412
5781
|
<dd>
|
|
5413
5782
|
|
|
5414
|
-
**requestOptions:** `Triggers.RequestOptions`
|
|
5415
|
-
|
|
5783
|
+
**requestOptions:** `Triggers.RequestOptions`
|
|
5784
|
+
|
|
5416
5785
|
</dd>
|
|
5417
5786
|
</dl>
|
|
5418
5787
|
</dd>
|
|
5419
5788
|
</dl>
|
|
5420
5789
|
|
|
5790
|
+
|
|
5421
5791
|
</dd>
|
|
5422
5792
|
</dl>
|
|
5423
5793
|
</details>
|
|
@@ -5435,7 +5805,6 @@ await client.triggers.createOrUpdate({
|
|
|
5435
5805
|
<dd>
|
|
5436
5806
|
|
|
5437
5807
|
Get an event trigger by its supplied ID
|
|
5438
|
-
|
|
5439
5808
|
</dd>
|
|
5440
5809
|
</dl>
|
|
5441
5810
|
</dd>
|
|
@@ -5451,8 +5820,8 @@ Get an event trigger by its supplied ID
|
|
|
5451
5820
|
|
|
5452
5821
|
```typescript
|
|
5453
5822
|
await client.triggers.get("store-in-snowflake");
|
|
5454
|
-
```
|
|
5455
5823
|
|
|
5824
|
+
```
|
|
5456
5825
|
</dd>
|
|
5457
5826
|
</dl>
|
|
5458
5827
|
</dd>
|
|
@@ -5467,20 +5836,21 @@ await client.triggers.get("store-in-snowflake");
|
|
|
5467
5836
|
<dd>
|
|
5468
5837
|
|
|
5469
5838
|
**triggerReferenceId:** `string` — The reference ID of the event trigger to get. All other entity ID fields are inferred from the request.
|
|
5470
|
-
|
|
5839
|
+
|
|
5471
5840
|
</dd>
|
|
5472
5841
|
</dl>
|
|
5473
5842
|
|
|
5474
5843
|
<dl>
|
|
5475
5844
|
<dd>
|
|
5476
5845
|
|
|
5477
|
-
**requestOptions:** `Triggers.RequestOptions`
|
|
5478
|
-
|
|
5846
|
+
**requestOptions:** `Triggers.RequestOptions`
|
|
5847
|
+
|
|
5479
5848
|
</dd>
|
|
5480
5849
|
</dl>
|
|
5481
5850
|
</dd>
|
|
5482
5851
|
</dl>
|
|
5483
5852
|
|
|
5853
|
+
|
|
5484
5854
|
</dd>
|
|
5485
5855
|
</dl>
|
|
5486
5856
|
</details>
|
|
@@ -5498,7 +5868,6 @@ await client.triggers.get("store-in-snowflake");
|
|
|
5498
5868
|
<dd>
|
|
5499
5869
|
|
|
5500
5870
|
Delete an event trigger
|
|
5501
|
-
|
|
5502
5871
|
</dd>
|
|
5503
5872
|
</dl>
|
|
5504
5873
|
</dd>
|
|
@@ -5514,8 +5883,8 @@ Delete an event trigger
|
|
|
5514
5883
|
|
|
5515
5884
|
```typescript
|
|
5516
5885
|
await client.triggers.delete("store-in-snowflake");
|
|
5517
|
-
```
|
|
5518
5886
|
|
|
5887
|
+
```
|
|
5519
5888
|
</dd>
|
|
5520
5889
|
</dl>
|
|
5521
5890
|
</dd>
|
|
@@ -5530,20 +5899,21 @@ await client.triggers.delete("store-in-snowflake");
|
|
|
5530
5899
|
<dd>
|
|
5531
5900
|
|
|
5532
5901
|
**triggerReferenceId:** `string` — The reference ID of the event trigger to delete. All other entity ID fields are inferred from the request.
|
|
5533
|
-
|
|
5902
|
+
|
|
5534
5903
|
</dd>
|
|
5535
5904
|
</dl>
|
|
5536
5905
|
|
|
5537
5906
|
<dl>
|
|
5538
5907
|
<dd>
|
|
5539
5908
|
|
|
5540
|
-
**requestOptions:** `Triggers.RequestOptions`
|
|
5541
|
-
|
|
5909
|
+
**requestOptions:** `Triggers.RequestOptions`
|
|
5910
|
+
|
|
5542
5911
|
</dd>
|
|
5543
5912
|
</dl>
|
|
5544
5913
|
</dd>
|
|
5545
5914
|
</dl>
|
|
5546
5915
|
|
|
5916
|
+
|
|
5547
5917
|
</dd>
|
|
5548
5918
|
</dl>
|
|
5549
5919
|
</details>
|
|
@@ -5561,7 +5931,6 @@ await client.triggers.delete("store-in-snowflake");
|
|
|
5561
5931
|
<dd>
|
|
5562
5932
|
|
|
5563
5933
|
Updates an event trigger. Only the enabled field is editable.
|
|
5564
|
-
|
|
5565
5934
|
</dd>
|
|
5566
5935
|
</dl>
|
|
5567
5936
|
</dd>
|
|
@@ -5577,10 +5946,10 @@ Updates an event trigger. Only the enabled field is editable.
|
|
|
5577
5946
|
|
|
5578
5947
|
```typescript
|
|
5579
5948
|
await client.triggers.partialUpdate("triggerReferenceId", {
|
|
5580
|
-
body: {}
|
|
5949
|
+
body: {}
|
|
5581
5950
|
});
|
|
5582
|
-
```
|
|
5583
5951
|
|
|
5952
|
+
```
|
|
5584
5953
|
</dd>
|
|
5585
5954
|
</dl>
|
|
5586
5955
|
</dd>
|
|
@@ -5595,34 +5964,34 @@ await client.triggers.partialUpdate("triggerReferenceId", {
|
|
|
5595
5964
|
<dd>
|
|
5596
5965
|
|
|
5597
5966
|
**triggerReferenceId:** `string` — The reference ID of the event trigger to update. All other entity ID fields are inferred from the request.
|
|
5598
|
-
|
|
5967
|
+
|
|
5599
5968
|
</dd>
|
|
5600
5969
|
</dl>
|
|
5601
5970
|
|
|
5602
5971
|
<dl>
|
|
5603
5972
|
<dd>
|
|
5604
5973
|
|
|
5605
|
-
**request:** `MavenAGI.PartialUpdateRequest`
|
|
5606
|
-
|
|
5974
|
+
**request:** `MavenAGI.PartialUpdateRequest`
|
|
5975
|
+
|
|
5607
5976
|
</dd>
|
|
5608
5977
|
</dl>
|
|
5609
5978
|
|
|
5610
5979
|
<dl>
|
|
5611
5980
|
<dd>
|
|
5612
5981
|
|
|
5613
|
-
**requestOptions:** `Triggers.RequestOptions`
|
|
5614
|
-
|
|
5982
|
+
**requestOptions:** `Triggers.RequestOptions`
|
|
5983
|
+
|
|
5615
5984
|
</dd>
|
|
5616
5985
|
</dl>
|
|
5617
5986
|
</dd>
|
|
5618
5987
|
</dl>
|
|
5619
5988
|
|
|
5989
|
+
|
|
5620
5990
|
</dd>
|
|
5621
5991
|
</dl>
|
|
5622
5992
|
</details>
|
|
5623
5993
|
|
|
5624
5994
|
## Users
|
|
5625
|
-
|
|
5626
5995
|
<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">search</a>({ ...params }) -> MavenAGI.AgentUserSearchResponse</code></summary>
|
|
5627
5996
|
<dl>
|
|
5628
5997
|
<dd>
|
|
@@ -5638,7 +6007,6 @@ await client.triggers.partialUpdate("triggerReferenceId", {
|
|
|
5638
6007
|
Search across all agent users on an agent.
|
|
5639
6008
|
|
|
5640
6009
|
Agent users are a merged view of the users created by individual apps.
|
|
5641
|
-
|
|
5642
6010
|
</dd>
|
|
5643
6011
|
</dl>
|
|
5644
6012
|
</dd>
|
|
@@ -5654,8 +6022,8 @@ Agent users are a merged view of the users created by individual apps.
|
|
|
5654
6022
|
|
|
5655
6023
|
```typescript
|
|
5656
6024
|
await client.users.search({});
|
|
5657
|
-
```
|
|
5658
6025
|
|
|
6026
|
+
```
|
|
5659
6027
|
</dd>
|
|
5660
6028
|
</dl>
|
|
5661
6029
|
</dd>
|
|
@@ -5669,21 +6037,22 @@ await client.users.search({});
|
|
|
5669
6037
|
<dl>
|
|
5670
6038
|
<dd>
|
|
5671
6039
|
|
|
5672
|
-
**request:** `MavenAGI.AgentUserSearchRequest`
|
|
5673
|
-
|
|
6040
|
+
**request:** `MavenAGI.AgentUserSearchRequest`
|
|
6041
|
+
|
|
5674
6042
|
</dd>
|
|
5675
6043
|
</dl>
|
|
5676
6044
|
|
|
5677
6045
|
<dl>
|
|
5678
6046
|
<dd>
|
|
5679
6047
|
|
|
5680
|
-
**requestOptions:** `Users.RequestOptions`
|
|
5681
|
-
|
|
6048
|
+
**requestOptions:** `Users.RequestOptions`
|
|
6049
|
+
|
|
5682
6050
|
</dd>
|
|
5683
6051
|
</dl>
|
|
5684
6052
|
</dd>
|
|
5685
6053
|
</dl>
|
|
5686
6054
|
|
|
6055
|
+
|
|
5687
6056
|
</dd>
|
|
5688
6057
|
</dl>
|
|
5689
6058
|
</details>
|
|
@@ -5703,7 +6072,6 @@ await client.users.search({});
|
|
|
5703
6072
|
Get an agent user by its supplied ID.
|
|
5704
6073
|
|
|
5705
6074
|
Agent users are a merged view of the users created by individual apps.
|
|
5706
|
-
|
|
5707
6075
|
</dd>
|
|
5708
6076
|
</dl>
|
|
5709
6077
|
</dd>
|
|
@@ -5719,8 +6087,8 @@ Agent users are a merged view of the users created by individual apps.
|
|
|
5719
6087
|
|
|
5720
6088
|
```typescript
|
|
5721
6089
|
await client.users.getAgentUser("aus_1234567890");
|
|
5722
|
-
```
|
|
5723
6090
|
|
|
6091
|
+
```
|
|
5724
6092
|
</dd>
|
|
5725
6093
|
</dl>
|
|
5726
6094
|
</dd>
|
|
@@ -5735,20 +6103,21 @@ await client.users.getAgentUser("aus_1234567890");
|
|
|
5735
6103
|
<dd>
|
|
5736
6104
|
|
|
5737
6105
|
**agentUserId:** `string` — The ID of the agent user to get.
|
|
5738
|
-
|
|
6106
|
+
|
|
5739
6107
|
</dd>
|
|
5740
6108
|
</dl>
|
|
5741
6109
|
|
|
5742
6110
|
<dl>
|
|
5743
6111
|
<dd>
|
|
5744
6112
|
|
|
5745
|
-
**requestOptions:** `Users.RequestOptions`
|
|
5746
|
-
|
|
6113
|
+
**requestOptions:** `Users.RequestOptions`
|
|
6114
|
+
|
|
5747
6115
|
</dd>
|
|
5748
6116
|
</dl>
|
|
5749
6117
|
</dd>
|
|
5750
6118
|
</dl>
|
|
5751
6119
|
|
|
6120
|
+
|
|
5752
6121
|
</dd>
|
|
5753
6122
|
</dl>
|
|
5754
6123
|
</details>
|
|
@@ -5766,7 +6135,6 @@ await client.users.getAgentUser("aus_1234567890");
|
|
|
5766
6135
|
<dd>
|
|
5767
6136
|
|
|
5768
6137
|
Update an app user or create it if it doesn't exist.
|
|
5769
|
-
|
|
5770
6138
|
</dd>
|
|
5771
6139
|
</dl>
|
|
5772
6140
|
</dd>
|
|
@@ -5783,23 +6151,21 @@ Update an app user or create it if it doesn't exist.
|
|
|
5783
6151
|
```typescript
|
|
5784
6152
|
await client.users.createOrUpdate({
|
|
5785
6153
|
userId: {
|
|
5786
|
-
referenceId: "user-0"
|
|
6154
|
+
referenceId: "user-0"
|
|
5787
6155
|
},
|
|
5788
|
-
identifiers: [
|
|
5789
|
-
{
|
|
6156
|
+
identifiers: [{
|
|
5790
6157
|
value: "joe@myapp.com",
|
|
5791
|
-
type: "EMAIL"
|
|
5792
|
-
},
|
|
5793
|
-
],
|
|
6158
|
+
type: "EMAIL"
|
|
6159
|
+
}],
|
|
5794
6160
|
data: {
|
|
5795
|
-
name: {
|
|
6161
|
+
"name": {
|
|
5796
6162
|
value: "Joe",
|
|
5797
|
-
visibility: "VISIBLE"
|
|
5798
|
-
}
|
|
5799
|
-
}
|
|
6163
|
+
visibility: "VISIBLE"
|
|
6164
|
+
}
|
|
6165
|
+
}
|
|
5800
6166
|
});
|
|
5801
|
-
```
|
|
5802
6167
|
|
|
6168
|
+
```
|
|
5803
6169
|
</dd>
|
|
5804
6170
|
</dl>
|
|
5805
6171
|
</dd>
|
|
@@ -5813,21 +6179,22 @@ await client.users.createOrUpdate({
|
|
|
5813
6179
|
<dl>
|
|
5814
6180
|
<dd>
|
|
5815
6181
|
|
|
5816
|
-
**request:** `MavenAGI.AppUserRequest`
|
|
5817
|
-
|
|
6182
|
+
**request:** `MavenAGI.AppUserRequest`
|
|
6183
|
+
|
|
5818
6184
|
</dd>
|
|
5819
6185
|
</dl>
|
|
5820
6186
|
|
|
5821
6187
|
<dl>
|
|
5822
6188
|
<dd>
|
|
5823
6189
|
|
|
5824
|
-
**requestOptions:** `Users.RequestOptions`
|
|
5825
|
-
|
|
6190
|
+
**requestOptions:** `Users.RequestOptions`
|
|
6191
|
+
|
|
5826
6192
|
</dd>
|
|
5827
6193
|
</dl>
|
|
5828
6194
|
</dd>
|
|
5829
6195
|
</dl>
|
|
5830
6196
|
|
|
6197
|
+
|
|
5831
6198
|
</dd>
|
|
5832
6199
|
</dl>
|
|
5833
6200
|
</details>
|
|
@@ -5845,7 +6212,6 @@ await client.users.createOrUpdate({
|
|
|
5845
6212
|
<dd>
|
|
5846
6213
|
|
|
5847
6214
|
Get an app user by its supplied ID
|
|
5848
|
-
|
|
5849
6215
|
</dd>
|
|
5850
6216
|
</dl>
|
|
5851
6217
|
</dd>
|
|
@@ -5861,8 +6227,8 @@ Get an app user by its supplied ID
|
|
|
5861
6227
|
|
|
5862
6228
|
```typescript
|
|
5863
6229
|
await client.users.get("user-0");
|
|
5864
|
-
```
|
|
5865
6230
|
|
|
6231
|
+
```
|
|
5866
6232
|
</dd>
|
|
5867
6233
|
</dl>
|
|
5868
6234
|
</dd>
|
|
@@ -5877,28 +6243,29 @@ await client.users.get("user-0");
|
|
|
5877
6243
|
<dd>
|
|
5878
6244
|
|
|
5879
6245
|
**userId:** `string` — The reference ID of the app user to get. All other entity ID fields are inferred from the request.
|
|
5880
|
-
|
|
6246
|
+
|
|
5881
6247
|
</dd>
|
|
5882
6248
|
</dl>
|
|
5883
6249
|
|
|
5884
6250
|
<dl>
|
|
5885
6251
|
<dd>
|
|
5886
6252
|
|
|
5887
|
-
**request:** `MavenAGI.UserGetRequest`
|
|
5888
|
-
|
|
6253
|
+
**request:** `MavenAGI.UserGetRequest`
|
|
6254
|
+
|
|
5889
6255
|
</dd>
|
|
5890
6256
|
</dl>
|
|
5891
6257
|
|
|
5892
6258
|
<dl>
|
|
5893
6259
|
<dd>
|
|
5894
6260
|
|
|
5895
|
-
**requestOptions:** `Users.RequestOptions`
|
|
5896
|
-
|
|
6261
|
+
**requestOptions:** `Users.RequestOptions`
|
|
6262
|
+
|
|
5897
6263
|
</dd>
|
|
5898
6264
|
</dl>
|
|
5899
6265
|
</dd>
|
|
5900
6266
|
</dl>
|
|
5901
6267
|
|
|
6268
|
+
|
|
5902
6269
|
</dd>
|
|
5903
6270
|
</dl>
|
|
5904
6271
|
</details>
|
|
@@ -5921,7 +6288,6 @@ Does not modify data or identifiers saved by other apps.
|
|
|
5921
6288
|
If this user is linked to a user from another app, it will not be unlinked. Unlinking of users is not yet supported.
|
|
5922
6289
|
|
|
5923
6290
|
<Warning>This is a destructive operation and cannot be undone.</Warning>
|
|
5924
|
-
|
|
5925
6291
|
</dd>
|
|
5926
6292
|
</dl>
|
|
5927
6293
|
</dd>
|
|
@@ -5937,8 +6303,8 @@ If this user is linked to a user from another app, it will not be unlinked. Unli
|
|
|
5937
6303
|
|
|
5938
6304
|
```typescript
|
|
5939
6305
|
await client.users.delete("user-0");
|
|
5940
|
-
```
|
|
5941
6306
|
|
|
6307
|
+
```
|
|
5942
6308
|
</dd>
|
|
5943
6309
|
</dl>
|
|
5944
6310
|
</dd>
|
|
@@ -5953,28 +6319,29 @@ await client.users.delete("user-0");
|
|
|
5953
6319
|
<dd>
|
|
5954
6320
|
|
|
5955
6321
|
**userId:** `string` — The reference ID of the app user to delete. All other entity ID fields are inferred from the request.
|
|
5956
|
-
|
|
6322
|
+
|
|
5957
6323
|
</dd>
|
|
5958
6324
|
</dl>
|
|
5959
6325
|
|
|
5960
6326
|
<dl>
|
|
5961
6327
|
<dd>
|
|
5962
6328
|
|
|
5963
|
-
**request:** `MavenAGI.UserDeleteRequest`
|
|
5964
|
-
|
|
6329
|
+
**request:** `MavenAGI.UserDeleteRequest`
|
|
6330
|
+
|
|
5965
6331
|
</dd>
|
|
5966
6332
|
</dl>
|
|
5967
6333
|
|
|
5968
6334
|
<dl>
|
|
5969
6335
|
<dd>
|
|
5970
6336
|
|
|
5971
|
-
**requestOptions:** `Users.RequestOptions`
|
|
5972
|
-
|
|
6337
|
+
**requestOptions:** `Users.RequestOptions`
|
|
6338
|
+
|
|
5973
6339
|
</dd>
|
|
5974
6340
|
</dl>
|
|
5975
6341
|
</dd>
|
|
5976
6342
|
</dl>
|
|
5977
6343
|
|
|
6344
|
+
|
|
5978
6345
|
</dd>
|
|
5979
6346
|
</dl>
|
|
5980
6347
|
</details>
|