@cognigy/rest-api-client 2025.18.1 → 2025.20.0

package/types/index.d.ts

@@ -2354,6 +2354,10 @@ export interface IAgentAssistSettings {
 	redactTranscriptTileMessages?: boolean;
 	enableAgentCopilotAuthentication?: boolean;
 	agentCopilotAuthentication?: string;
+	/**
+	 * Optional OAuth2 connection id for providers that require it (e.g., Genesys)
+	 */
+	oAuth2Connection?: string;
 }
 export interface IGenesysCloudHandoverSettings {
 	host: string;
@@ -2527,16 +2531,718 @@ export interface IEndpoint extends IEntityMeta {
 		active: boolean;
 	};
 }
-export interface IGraphEndpoint {
-	type: "endpoint";
-	_id: TMongoId;
-	name: string;
-	properties: Pick<IEndpoint, "active" | "URLToken" | "channel" | "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy">;
-	dependencies?: IGraphEndpointDependency[];
+export interface IGraphEndpoint {
+	type: "endpoint";
+	_id: TMongoId;
+	name: string;
+	properties: Pick<IEndpoint, "active" | "URLToken" | "channel" | "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy">;
+	dependencies?: IGraphEndpointDependency[];
+}
+export interface IGraphEndpointDependency {
+	_id: string;
+	type: "endpointFlow" | "endpointNluConnector";
+}
+export interface ISystemSlots {
+	DATE: IDateSlot[] | null;
+	NUMBER: INumberSlot[] | null;
+	DURATION: IDurationSlot[] | null;
+	TEMPERATURE: ITemperatureSlot[] | null;
+	AGE: IAgeSlot[] | null;
+	PERCENTAGE: IPercentageSlot[] | null;
+	EMAIL: IEmailSlot[] | null;
+	URL: IUrlSlot[] | null;
+	MONEY: IMoneySlot[] | null;
+	DISTANCE: IDistanceSlot[] | null;
+}
+export interface IBaseSlot {
+	text: string;
+	data: any;
+	offset: {
+		start: number;
+		end: number;
+	};
+}
+export interface IPercentageSlot extends IBaseSlot {
+	data: {
+		value: number;
+	};
+}
+export interface IAgeSlot extends IBaseSlot {
+	data: {
+		value: number;
+		unit: TTimeGrain;
+	};
+}
+export interface INumberSlot extends IBaseSlot {
+	data: {
+		value: number;
+	};
+}
+export interface IEmailSlot extends IBaseSlot {
+	data: {
+		value: string;
+	};
+}
+export declare type ITemperatureUnit = "celsius" | "fahrenheit" | "degree" | "kelvin";
+export interface ITemperatureSlot extends IBaseSlot {
+	data: {
+		value: number;
+		unit: ITemperatureUnit;
+	};
+}
+export declare type TTimeGrain = "second" | "minute" | "hour" | "day" | "week" | "month" | "quarter" | "year";
+export interface IDateObject {
+	day: number;
+	hour: number;
+	minute: number;
+	month: number;
+	second: number;
+	milliseconds: number;
+	weekday: number;
+	dayOfWeek: string;
+	year: number;
+	ISODate: string;
+	grain: TTimeGrain | null;
+	plain: string;
+	timezoneOffset?: string;
+}
+export interface IDateSlot extends IBaseSlot {
+	data: {
+		start?: IDateObject;
+		end?: IDateObject;
+	};
+}
+export interface IDurationSlot extends IBaseSlot {
+	data: {
+		unit?: TTimeGrain;
+		value?: number;
+		inSeconds?: number;
+		years?: number;
+		quarters?: number;
+		months?: number;
+		weeks?: number;
+		days?: number;
+		hours?: number;
+		minutes?: number;
+		seconds?: number;
+	};
+}
+export interface IMoneySlot extends IBaseSlot {
+	data: {
+		value: number;
+		unit: string;
+	};
+}
+export interface IUrlSlot extends IBaseSlot {
+	data: {
+		domain: string;
+		value: string;
+	};
+}
+export interface IDistanceSlot extends IBaseSlot {
+	data: {
+		unit: string;
+		value: number;
+	};
+}
+declare const arrayTDebugEventTypes: readonly [
+	"inputChanged",
+	"contextChanged",
+	"profileChanged",
+	"activeEntrypointsChanged",
+	"nodeExecuted",
+	"nodeError",
+	"finalPing",
+	"input",
+	"output",
+	"switchedFlow",
+	"nluWarning",
+	"debugMessage",
+	"debugError",
+	"goalCompleted"
+];
+export declare type TDebugEventType = typeof arrayTDebugEventTypes[number];
+export interface IErrorEventPayload extends ILoggerStack {
+	message: string;
+	flowId: string;
+	nodeId?: string;
+}
+export interface IFinalPingEventPayload {
+	type: "regular" | "preventFinalPingToEndpoint" | "cognigyStopFlow" | "error";
+	analyticsData?: IAnalyticsSourceData;
+	error?: IErrorEventPayload;
+	sessionId?: string;
+}
+export interface IGenericIntentFeedbackFinding {
+	type: IGenericIntentFeedbackFindingType;
+}
+export interface IOverlapIntentFeedbackFinding {
+	type: IOverlapIntentFeedbackFindingType;
+	overlappingIntentReferenceId: string;
+	overlappingIntentName: string;
+	overlappingIntentId: TMongoId;
+	overlappingFlowName: string;
+	overlappingFlowId: TMongoId;
+}
+export interface ILowDataIntentFeedbackFinding {
+	type: "lowDataIntents";
+	intents: {
+		intentReferenceId: string;
+		intentName: string;
+		intentId: string;
+		flowId: string;
+		flowName: string;
+	}[];
+}
+declare const overlapIntentFeedbackFindingArrayType: readonly [
+	"strongOverlap",
+	"someOverlap"
+];
+export declare type IOverlapIntentFeedbackFindingType = typeof overlapIntentFeedbackFindingArrayType[number];
+declare const genericIntentFeedbackFindingArrayType: readonly [
+	"poorFScore",
+	"fairFScore",
+	"goodFScore",
+	"fewSentences",
+	"unclearIntent",
+	"noSiblings"
+];
+export declare type IGenericIntentFeedbackFindingType = typeof genericIntentFeedbackFindingArrayType[number];
+export declare type IntentFeedbackFinding = IGenericIntentFeedbackFinding | IOverlapIntentFeedbackFinding | ILowDataIntentFeedbackFinding;
+export interface IIntentFeedbackInDBReport {
+	findings: IntentFeedbackFinding[];
+	info: {
+		fScore: number;
+	};
+}
+declare const biasTowardsParentOrChildIntentsTypes: readonly [
+	"parents",
+	"children"
+];
+export declare type TBiasTowardsParentOrChildIntentsTypes = typeof biasTowardsParentOrChildIntentsTypes[number];
+declare const intentTypes: readonly [
+	"yesNoIntent",
+	"default"
+];
+export declare type TIntentTypes = typeof intentTypes[number];
+export interface ILocalizedIntentData {
+	rules: string[];
+	condition: string;
+	confirmationSentences: string[];
+	disambiguationSentence: string;
+	localeReference: TMongoId;
+}
+export interface IIntentInDB extends Omit<IIntent, keyof ILocalizedIntentData> {
+	localizedData: ILocalizedIntentData[];
+	/**
+	 * A list of all of the locales
+	 * that are not disabled. Used to return
+	 * the correct isDisabled value for the
+	 * given locale
+	 */
+	enabledLocaleReferences: TMongoId[];
+}
+export interface IIntent extends IEntityMeta, ILocalizedIntentData {
+	name: string;
+	description?: string;
+	referenceId: string;
+	isRejectIntent: boolean;
+	isDisabled: boolean;
+	tags: string[];
+	data: any;
+	nodeReferenceId: string;
+	childFeatures?: boolean | string[];
+	biasTowardsParentOrChildIntents: TBiasTowardsParentOrChildIntentsTypes;
+	parentIntentId?: string;
+	feedbackReport: IIntentFeedbackInDBReport;
+	intentRelationReferences: TMongoId[];
+	flowReference?: TMongoId;
+	projectReference: TMongoId;
+	organisationReference: TMongoId;
+	flowReferenceId?: string;
+	/**
+	 * A label we use in analytics
+	 * to track when an intent was triggered
+	 */
+	analyticsLabel?: string;
+	/**
+	 * Enable the usage of default replies as example sentences
+	 */
+	overrideIntentDefaultRepliesAsExamples?: string;
+	intentType: TIntentTypes;
+}
+export interface IYesNoData {
+	_id: string;
+	rules: string[];
+	name: string;
+	isDisabled: boolean;
+}
+export interface IYesNoItem {
+	yesIntent: IYesNoData | IIntentInDB;
+	noIntent: IYesNoData | IIntentInDB;
+	rejectIntent: IYesNoData | IIntentInDB;
+}
+declare const generativeAIModels: readonly [
+	"gpt-3.5-turbo",
+	"gpt-3.5-turbo-instruct",
+	"gpt-4",
+	"gpt-4o",
+	"gpt-4o-mini",
+	"gpt-4.1",
+	"gpt-4.1-mini",
+	"gpt-4.1-nano",
+	"gpt-5",
+	"gpt-5-nano",
+	"gpt-5-mini",
+	"gpt-5-chat-latest",
+	"luminous-extended-control",
+	"claude-v1-100k",
+	"claude-instant-v1",
+	"claude-3-opus-20240229",
+	"claude-3-haiku-20240307",
+	"claude-3-sonnet-20240229",
+	"claude-3-5-sonnet-20241022",
+	"claude-3-7-sonnet-20250219",
+	"claude-3-5-sonnet-latest",
+	"claude-3-7-sonnet-latest",
+	"claude-opus-4-0",
+	"claude-sonnet-4-0",
+	"text-bison@001",
+	"custom-model",
+	"custom-embedding-model",
+	"gemini-1.0-pro",
+	"gemini-1.5-pro",
+	"gemini-1.5-flash",
+	"gemini-2.0-flash",
+	"gemini-2.0-flash-lite",
+	"amazon.nova-lite-v1:0",
+	"amazon.nova-pro-v1:0",
+	"amazon.nova-micro-v1:0",
+	"anthropic.claude-3-5-sonnet-20240620-v1:0",
+	"mistral-large-2411",
+	"mistral-small-2503",
+	"pixtral-large-2411",
+	"pixtral-12b-2409",
+	"mistral-large-latest",
+	"pixtral-large-latest",
+	"mistral-medium-latest",
+	"mistral-small-latest",
+	"text-davinci-003",
+	"text-embedding-3-small",
+	"text-embedding-3-large",
+	"text-embedding-ada-002",
+	"luminous-embedding-128",
+	"amazon.titan-embed-text-v2:0",
+	"Pharia-1-Embedding-4608"
+];
+/**
+ * @openapi
+ *
+ * components:
+ *   schemas:
+ *     TGenerativeAIModels:
+ *       type: string
+ *       enum:
+ *         - gpt-3.5-turbo
+ *         - gpt-3.5-turbo-instruct
+ *         - gpt-4
+ *         - gpt-4o
+ *         - gpt-4o-mini
+ *         - text-embedding-ada-002
+ *         - luminous-extended-control
+ *         - luminous-embedding-128
+ *         - Pharia-1-Embedding-4608
+ *         - claude-v1-100k
+ *         - claude-instant-v1
+ *         - claude-3-opus-20240229
+ *         - custom-model
+ *         - custom-embedding-model
+ *         - gemini-2.0-flash
+ *         - gemini-2.0-flash-lite
+ *         - mistral-large-2411
+ *         - mistral-small-2503
+ *         - pixtral-large-2411
+ *         - pixtral-12b-2409
+ */
+export declare type TGenerativeAIModels = (typeof generativeAIModels)[number];
+declare const generativeAIProviders: readonly [
+	"azureOpenAI",
+	"openAI",
+	"openAICompatible",
+	"alephAlpha",
+	"anthropic",
+	"googleVertexAI",
+	"googleGemini",
+	"awsBedrock",
+	"mistral"
+];
+/**
+ * @openapi
+ *
+ * components:
+ *   schemas:
+ *     TGenerativeAIProviders:
+ *       type: string
+ *       enum:
+ *         - azureOpenAI
+ *         - openAI
+ *         - anthropic
+ *         - googleVertexAI
+ *         - googleGemini
+ *         - alephAlpha
+ *         - awsBedrock
+ *         - mistral
+ */
+export declare type TGenerativeAIProviders = (typeof generativeAIProviders)[number];
+declare const generativeAIUseCases: readonly [
+	"nlu",
+	"knowledgeSearch",
+	"aiAgent",
+	"gptPromptNode",
+	"aiEnhancedOutputs",
+	"sentimentAnalysis",
+	"designTimeGeneration",
+	"intentSentenceGeneration",
+	"flowGeneration",
+	"generateNodeOutput",
+	"lexiconGeneration",
+	"answerExtraction",
+	"gptConversation"
+];
+export declare type TGenerativeAIUseCases = typeof generativeAIUseCases[number];
+declare const modeType: readonly [
+	"chat",
+	"completion",
+	"embedding"
+];
+export declare type TModeType = typeof modeType[number];
+export declare type TBASIC_EXTENSION = "@cognigy/basic-nodes";
+export declare type TMONGO_DB_EXTENSION = "@cognigy/mongodb";
+export declare type TSQL_EXTENSION = "@cognigy/mssql";
+export declare type TSMTP_EXTENSION = "@cognigy/smtp";
+export declare type TVOICE_GATEWAY_EXTENSION = "@cognigy/voicegateway";
+export declare type TMICROSOFT_EXTENSION = "@cognigy/microsoft";
+export declare type TVOICE_GATEWAY_2_EXTENSION = "@cognigy/voicegateway2";
+export interface IGenerativeAIUseCaseSettings {
+	largeLanguageModelId: string | null;
+	temperature: number;
+}
+declare const audioPreviewProviders: readonly [
+	"microsoft",
+	"google",
+	"aws",
+	"deepgram"
+];
+export declare type TAudioPreviewProvider = typeof audioPreviewProviders[number];
+/**
+ * @openapi
+ * components:
+ *   schemas:
+ *     IGenerativeAIUseCase:
+ *       type: object
+ *       properties:
+ *         useCase:
+ *           enum:
+ *             - designTimeGeneration
+ *             - intentSentenceGeneration
+ *             - aiEnhancedOutputs
+ *             - lexiconGeneration
+ *             - flowGeneration
+ *             - gptConversation
+ *             - gptPromptNode
+ *             - generateNodeOutput
+ *             - knowledgeSearch
+ *             - sentimentAnalysis
+ */
+export interface IGenerativeAIUseCase {
+	useCase: TGenerativeAIUseCases;
+}
+export declare const nluLanguages: readonly [
+	"ar-AE",
+	"bn-IN",
+	"da-DK",
+	"en-AU",
+	"en-CA",
+	"en-GB",
+	"en-IN",
+	"en-US",
+	"es-ES",
+	"fi-FI",
+	"fr-FR",
+	"de-DE",
+	"hi-IN",
+	"it-IT",
+	"ja-JP",
+	"ko-KR",
+	"nn-NO",
+	"nl-NL",
+	"pl-PL",
+	"pt-BR",
+	"pt-PT",
+	"ru-RU",
+	"sv-SE",
+	"ta-IN",
+	"th-TH",
+	"tr-TR",
+	"vi-VN",
+	"zh-CN",
+	"ge-GE"
+];
+export declare type TNluLanguage = typeof nluLanguages[number];
+export interface INluEmbeddingCredentials {
+	apiType: TGenerativeAIProviders;
+	apiKey: string;
+	apiModel: TGenerativeAIModels;
+	apiCustomBaseUrl?: string;
+	apiResourceName?: string;
+	apiDeploymentName?: string;
+	apiVersion?: string;
+}
+export interface ISetAppStateOverlaySettings {
+	autoOpen: boolean;
+	closeOnSubmit: boolean;
+	feedbackMessage: string;
+	screenTitle: string;
+	sendEventOnCloseIconClick: boolean;
+	showCloseIcon: boolean;
+}
+export interface ISetAppStateOverlaySettingsMetaData {
+	overlaySettings: ISetAppStateOverlaySettings;
+	endpointType: TEndpointType;
+	url: string;
+	URLToken: string;
+}
+export interface IVoiceGateway2VadParams {
+	enable?: boolean;
+	voiceMs?: number;
+	mode?: number;
+}
+export declare type TVoiceGateway2TTSVendor = "aws" | "deepgram" | "elevenlabs" | "google" | "microsoft" | "nuance" | "default" | "custom";
+export interface IVoiceGateway2SynthesizerParams {
+	vendor?: TVoiceGateway2TTSVendor | "default" | "none";
+	language?: string;
+	voice?: string;
+	label?: string;
+	fallbackVendor?: string;
+	fallbackLabel?: string;
+	fallbackLanguage?: string;
+	fallbackVoice?: string;
+	engine?: "standard" | "neural";
+	gender?: "MALE" | "FEMALE" | "NEUTRAL";
+	azureServiceEndpoint?: string;
+	options?: object;
+	disableCache?: boolean;
+	model?: string;
+}
+export declare type TVoiceGateway2STTVendor = "aws" | "deepgram" | "google" | "microsoft" | "nuance" | "soniox" | "default" | "custom";
+export declare type TVoiceGateway2GoogleModel = "latest_short" | "latest_long" | "command_and_search" | "phone_call" | "video" | "medical_dictation" | "medical_conversation" | "default";
+export declare type VoiceGatewayDeepgramModel = "base" | "base-phonecall" | "base-meeting" | "base-finance" | "base-voicemail" | "base-conversationalai" | "base-video" | "enhanced" | "enhanced-phonecall" | "enhanced-meeting" | "enhanced-finance" | "nova" | "nova-phonecall" | "nova-2" | "nova-2-meeting" | "nova-2-phonecall" | "nova-2-voicemail" | "nova-2-finance" | "nova-2-conversationalai" | "nova-2-medical" | "nova-2-drivethru" | "nova-2-automotive" | "whisper" | "whisper-tiny" | "whisper-base" | "whisper-small" | "whisper-large";
+export interface IVoiceGateway2RecognizerParams {
+	vendor?: TVoiceGateway2STTVendor | "default" | "none";
+	language?: string;
+	label?: string;
+	fallbackVendor?: string;
+	fallbackLabel?: string;
+	fallbackLanguage?: string;
+	vad?: IVoiceGateway2VadParams;
+	hints?: string[];
+	hintsBoost?: number;
+	altLanguages?: string[];
+	profanityFilter?: boolean;
+	interim?: boolean;
+	singleUtterance?: boolean;
+	dualChannel?: boolean;
+	separateRecognitionPerChannel?: boolean;
+	punctuation?: boolean;
+	enhancedModel?: boolean;
+	words?: boolean;
+	diarization?: boolean;
+	diarizationMinSpeakers?: number;
+	diarizationMaxSpeakers?: number;
+	interactionType?: "unspecified" | "discussion" | "presentation" | "phone_call" | "voicemail" | "voice_search" | "voice_command" | "dictation";
+	naicsCod?: number;
+	identifyChannels?: boolean;
+	vocabularyName?: string;
+	vocabularyFilterName?: string;
+	filterMethod?: "remove" | "mask" | "tag";
+	outputFormat?: "simple" | "detailed";
+	profanityOption?: "masked" | "removed" | "raw";
+	requestSnr?: boolean;
+	initialSpeechTimeoutMs?: number;
+	azureSttEndpointId?: string;
+	audioLogging?: boolean;
+	asrDtmfTerminationDigit?: string;
+	asrTimeout?: number;
+	nuanceOptions?: TVoiceGateway2NuanceOptions;
+	deepgramOptions?: TVoiceGateway2DeepgramOptions;
+	ibmOptions?: TVoiceGateway2IbmOptions;
+	nvidiaOptions?: TVoiceGateway2NvidiaOptions;
+	sonioxOptions?: TVoiceGateway2SonioxOptions;
+	model?: TVoiceGateway2GoogleModel | VoiceGatewayDeepgramModel | string;
+}
+export declare type TVoiceGateway2NuanceOptions = {
+	clientId?: string;
+	secret?: string;
+	kryptonEndpoint?: string;
+	topic?: string;
+	utteranceDetectionMode?: string;
+	punctuation?: boolean;
+	profanityFilter?: boolean;
+	includeTokenization?: boolean;
+	discardSpeakerAdaptation?: boolean;
+	suppressCallRecording?: boolean;
+	maskLoadFailures?: boolean;
+	suppressInitialCapitalization?: boolean;
+	allowZeroBaseLmWeight?: boolean;
+	filterWakeupWord?: boolean;
+	resultType?: string;
+	noInputTimeoutMs?: number;
+	recognitionTimeoutMs?: number;
+	utteranceEndSilenceMs?: number;
+	maxHypotheses?: number;
+	speechDomain?: string;
+	formatting?: TVoiceGatewayNuanceFormatting;
+	clientData?: object;
+	userId?: string;
+	speechDetectionSensitivity?: number;
+	resources?: [
+		TVoiceGatewayNuanceResources
+	];
+};
+export declare type TVoiceGateway2DeepgramOptions = {
+	deepgramSttUri?: string;
+	deepgramSttUseTls?: boolean;
+	apiKey?: string;
+	tier?: string;
+	model?: string;
+	customModel?: string;
+	version?: string;
+	punctuate?: boolean;
+	smartFormatting?: boolean;
+	profanityFilter?: boolean;
+	redact?: string;
+	diarize?: boolean;
+	diarizeVersion?: string;
+	ner?: boolean;
+	multichannel?: boolean;
+	alternatives?: number;
+	numerals?: boolean;
+	search?: string[];
+	replace?: string[];
+	keywords?: string[];
+	endpointing?: number | boolean;
+	utteranceEndMs?: number;
+	shortUtterance?: boolean;
+	vadTurnoff?: number;
+	tag?: string;
+};
+export declare type TVoiceGateway2NvidiaOptions = {
+	rivaUri?: string;
+	maxAlternatives?: number;
+	profanityFilter?: boolean;
+	punctuation?: boolean;
+	wordTimeOffsets?: boolean;
+	verbatimTranscripts?: boolean;
+	customConfiguration?: object;
+};
+export declare type TVoiceGateway2SonioxOptions = {
+	id?: string;
+	title?: string;
+	disableStoreAudio?: boolean;
+	disableStoreTranscript?: boolean;
+	disableSearch?: boolean;
+	metadata?: object;
+	storage?: object;
+};
+export declare type TVoiceGateway2IbmOptions = {
+	sttApiKey?: string;
+	sttRegion?: string;
+	ttsApiKey?: string;
+	ttsRegion?: string;
+	instanceId?: string;
+	model?: string;
+	languageCustomizationId?: string;
+	acousticCustomizationId?: string;
+	baseModelVersion?: string;
+	watsonMetadata?: string;
+	watsonLearningOptOut?: boolean;
+};
+export declare type TVoiceGatewayNuanceResourceReference = {
+	type?: string;
+	uri?: string;
+	maxLoadFailures?: boolean;
+	requestTimeoutMs?: number;
+	headers?: object;
+};
+export declare type TVoiceGatewayNuanceResources = {
+	externalReference?: TVoiceGatewayNuanceResourceReference;
+	inlineWordset?: string;
+	builtin?: string;
+	inlineGrammar?: string;
+	wakeupWord?: Array<string>;
+	weightName?: string;
+	weightValue?: number;
+	reuse?: string;
+};
+export declare type TVoiceGatewayNuanceFormatting = {
+	scheme?: string;
+	options?: object;
+};
+export declare type TVoiceGateway2InputType = "digits" | "speech";
+export declare type TVoiceGateway2UserNoInputMode = "event" | "speech" | "play";
+export declare type TVoiceGateway2FlowNoInputMode = "speech" | "play";
+export interface IVoiceGateway2BargeInParams {
+	enable?: boolean;
+	sticky?: boolean;
+	dtmfBargein?: boolean;
+	actionHook?: object | string;
+	input?: TVoiceGateway2InputType[];
+	finishOnKey?: string;
+	numDigits?: number;
+	minDigits?: number;
+	maxDigits?: number;
+	interDigitTimeout?: number;
+	minBargeinWordCount?: number;
+}
+export interface IVoiceGateway2ActivityParams {
+	synthesizer?: IVoiceGateway2SynthesizerParams;
+	recognizer?: IVoiceGateway2RecognizerParams;
+	bargeIn?: IVoiceGateway2BargeInParams;
+	user?: IVoiceGateway2CognigyUserInputConfigParams;
+	dtmf?: boolean;
+	sessionParams?: IVoiceGateway2ActivityParams;
+	fillerNoise?: IVoiceGateway2FillerNoiseParams;
+	flow?: IVoiceGateway2CognigyFlowInputConfigParams;
 }
-export interface IGraphEndpointDependency {
-	_id: string;
-	type: "endpointFlow" | "endpointNluConnector";
+export interface IVoiceGateway2FillerNoiseParams {
+	enable: boolean;
+	url?: string;
+	startDelaySecs?: number;
+}
+export declare type TVoiceGateway2DubActionType = "addTrack" | "removeTrack" | "silenceTrack" | "playOnTrack" | "sayOnTrack";
+export declare type TVoiceGateway2MediaPath = "fullMedia" | "partialMedia" | "noMedia";
+export interface IVoiceGateway2CognigyUserInputConfigParams {
+	noInputMode?: TVoiceGateway2UserNoInputMode;
+	noInputTimeout?: number;
+	noInputRetries?: number;
+	noInputSpeech?: string;
+	noInputUrl?: string;
+	userNoInputAutoHangup?: boolean;
+}
+export interface IVoiceGateway2CognigyFlowInputConfigParams {
+	flowNoInputEnable?: boolean;
+	flowNoInputMode?: TVoiceGateway2FlowNoInputMode;
+	flowNoInputTimeout?: number;
+	flowNoInputRetries?: number;
+	flowNoInputSpeech?: string;
+	flowNoInputUrl?: string;
+	flowNoInputFail?: boolean;
+}
+export interface IGetNluPipelineParams {
+	parseIntents?: boolean;
+	parseSlots?: boolean;
+	parseSystemSlots?: boolean;
+	findType?: boolean;
 }
 /**
  * The supported endpoint channels
@@ -2687,6 +3393,7 @@ export interface ICallEventFailoverSettings {
 	deepgramEndpointing?: boolean;
 	deepgramEndpointingValue?: number;
 	dialTranscribeDeepgramTier?: string;
+	mediaPath?: TVoiceGateway2MediaPath;
 	anchorMedia?: boolean;
 }
 export interface ICallEvents {
@@ -4297,333 +5004,79 @@ export interface IContactAttachment {
  *         address:
  *           type: string
  *       required:
- *         - type
- *         - latitude
- *         - longitude
- */
-export interface ILocationAttachment {
-	type: "location";
-	latitude: number;
-	longitude: number;
-	name?: string;
-	title?: string;
-	address?: string;
-}
-export declare type TGenericAttachments = IFileAttachment | IImageAttachment | IVideoAttachment | IAudioAttachment;
-/**
- * @openapi
- *
- * components:
- *  schemas:
- *     TAttachments:
- *       oneOf:
- *         - $ref: '#/components/schemas/IFileAttachment'
- *         - $ref: '#/components/schemas/IImageAttachment'
- *         - $ref: '#/components/schemas/IVideoAttachment'
- *         - $ref: '#/components/schemas/IAudioAttachment'
- *         - $ref: '#/components/schemas/IStickerAttachment'
- *         - $ref: '#/components/schemas/IContactAttachment'
- *         - $ref: '#/components/schemas/ILocationAttachment'
- */
-export declare type TAttachments = TGenericAttachments | IStickerAttachment | IContactAttachment | ILocationAttachment;
-export interface IEightByEightEndpointSettings extends IEndpointSessionSettings {
-	/** The base 8x8 server url */
-	baseUrl: string;
-	/** The API Key which we use to access/authorize the 8x8 API calls */
-	apiKey: string;
-	/**
-	 * The API Tenant Id which we use as a 8x8 tenant header for the 8x8 API calls.
-	 * Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.
-	 */
-	apiTenant: string;
-	/**
-	 * If activated, CONVERSATION UPDATE EVENTS of state ACTIVE will be accepted & sent to the Flow. Users will be able to access the event payload via the Input data object.
-	 * If deactivated, CONVERSATION UPDATE EVENTS of state ACTIVE will not be accepted & will not be sent to the Flow.
-	 */
-	acceptConversationActiveEvent?: boolean;
-	/** Settings to store attachments at a cloud provider */
-	fileStorageSettings?: IFileStorageSettings;
-}
-export interface IGenesysBotConnectorEndpointSettings {
-	verifyToken: string;
-}
-export interface INiceCXOneEndpointSettings {
-	verifyToken: string;
-}
-export interface INiceCXOneAAHEndpointSettings {
-	niceCXOneAAHConnection: string;
-}
-export interface IZoomContactCenterEndpointSettings {
-	verifyToken: string;
-}
-declare const arrayNLUConnectorType_2_0: readonly [
-	"alexa",
-	"dialogflow",
-	"dialogflowBuiltIn",
-	"amazonLexBuiltIn",
-	"luis",
-	"watson",
-	"noNlu",
-	"cognigy",
-	"code",
-	"lex",
-	"generativeAI"
-];
-export declare type TNLUConnectorType_2_0 = typeof arrayNLUConnectorType_2_0[number];
-declare const generativeAIModels: readonly [
-	"gpt-3.5-turbo",
-	"gpt-3.5-turbo-instruct",
-	"gpt-4",
-	"gpt-4o",
-	"gpt-4o-mini",
-	"gpt-4.1",
-	"gpt-4.1-mini",
-	"gpt-4.1-nano",
-	"gpt-5",
-	"gpt-5-nano",
-	"gpt-5-mini",
-	"gpt-5-chat-latest",
-	"luminous-extended-control",
-	"claude-v1-100k",
-	"claude-instant-v1",
-	"claude-3-opus-20240229",
-	"claude-3-haiku-20240307",
-	"claude-3-sonnet-20240229",
-	"claude-3-5-sonnet-20241022",
-	"claude-3-7-sonnet-20250219",
-	"claude-3-5-sonnet-latest",
-	"claude-3-7-sonnet-latest",
-	"claude-opus-4-0",
-	"claude-sonnet-4-0",
-	"text-bison@001",
-	"custom-model",
-	"custom-embedding-model",
-	"gemini-1.0-pro",
-	"gemini-1.5-pro",
-	"gemini-1.5-flash",
-	"gemini-2.0-flash",
-	"gemini-2.0-flash-lite",
-	"amazon.nova-lite-v1:0",
-	"amazon.nova-pro-v1:0",
-	"amazon.nova-micro-v1:0",
-	"anthropic.claude-3-5-sonnet-20240620-v1:0",
-	"mistral-large-2411",
-	"mistral-small-2503",
-	"pixtral-large-2411",
-	"pixtral-12b-2409",
-	"mistral-large-latest",
-	"pixtral-large-latest",
-	"mistral-medium-latest",
-	"mistral-small-latest",
-	"text-davinci-003",
-	"text-embedding-3-small",
-	"text-embedding-3-large",
-	"text-embedding-ada-002",
-	"luminous-embedding-128",
-	"amazon.titan-embed-text-v2:0",
-	"Pharia-1-Embedding-4608"
-];
-/**
- * @openapi
- *
- * components:
- *   schemas:
- *     TGenerativeAIModels:
- *       type: string
- *       enum:
- *         - gpt-3.5-turbo
- *         - gpt-3.5-turbo-instruct
- *         - gpt-4
- *         - gpt-4o
- *         - gpt-4o-mini
- *         - text-embedding-ada-002
- *         - luminous-extended-control
- *         - luminous-embedding-128
- *         - Pharia-1-Embedding-4608
- *         - claude-v1-100k
- *         - claude-instant-v1
- *         - claude-3-opus-20240229
- *         - custom-model
- *         - custom-embedding-model
- *         - gemini-2.0-flash
- *         - gemini-2.0-flash-lite
- *         - mistral-large-2411
- *         - mistral-small-2503
- *         - pixtral-large-2411
- *         - pixtral-12b-2409
+ *         - type
+ *         - latitude
+ *         - longitude
  */
-export declare type TGenerativeAIModels = (typeof generativeAIModels)[number];
-declare const generativeAIProviders: readonly [
-	"azureOpenAI",
-	"openAI",
-	"openAICompatible",
-	"alephAlpha",
-	"anthropic",
-	"googleVertexAI",
-	"googleGemini",
-	"awsBedrock",
-	"mistral"
-];
+export interface ILocationAttachment {
+	type: "location";
+	latitude: number;
+	longitude: number;
+	name?: string;
+	title?: string;
+	address?: string;
+}
+export declare type TGenericAttachments = IFileAttachment | IImageAttachment | IVideoAttachment | IAudioAttachment;
 /**
  * @openapi
  *
  * components:
- *   schemas:
- *     TGenerativeAIProviders:
- *       type: string
- *       enum:
- *         - azureOpenAI
- *         - openAI
- *         - anthropic
- *         - googleVertexAI
- *         - googleGemini
- *         - alephAlpha
- *         - awsBedrock
- *         - mistral
+ *  schemas:
+ *     TAttachments:
+ *       oneOf:
+ *         - $ref: '#/components/schemas/IFileAttachment'
+ *         - $ref: '#/components/schemas/IImageAttachment'
+ *         - $ref: '#/components/schemas/IVideoAttachment'
+ *         - $ref: '#/components/schemas/IAudioAttachment'
+ *         - $ref: '#/components/schemas/IStickerAttachment'
+ *         - $ref: '#/components/schemas/IContactAttachment'
+ *         - $ref: '#/components/schemas/ILocationAttachment'
  */
-export declare type TGenerativeAIProviders = (typeof generativeAIProviders)[number];
-declare const generativeAIUseCases: readonly [
-	"nlu",
-	"knowledgeSearch",
-	"aiAgent",
-	"gptPromptNode",
-	"aiEnhancedOutputs",
-	"sentimentAnalysis",
-	"designTimeGeneration",
-	"intentSentenceGeneration",
-	"flowGeneration",
-	"generateNodeOutput",
-	"lexiconGeneration",
-	"answerExtraction",
-	"gptConversation"
-];
-export declare type TGenerativeAIUseCases = typeof generativeAIUseCases[number];
-declare const modeType: readonly [
-	"chat",
-	"completion",
-	"embedding"
-];
-export declare type TModeType = typeof modeType[number];
-export declare type TBASIC_EXTENSION = "@cognigy/basic-nodes";
-export declare type TMONGO_DB_EXTENSION = "@cognigy/mongodb";
-export declare type TSQL_EXTENSION = "@cognigy/mssql";
-export declare type TSMTP_EXTENSION = "@cognigy/smtp";
-export declare type TVOICE_GATEWAY_EXTENSION = "@cognigy/voicegateway";
-export declare type TMICROSOFT_EXTENSION = "@cognigy/microsoft";
-export declare type TVOICE_GATEWAY_2_EXTENSION = "@cognigy/voicegateway2";
-export interface IGenerativeAIUseCaseSettings {
-	largeLanguageModelId: string | null;
-	temperature: number;
-}
-export interface IGenericIntentFeedbackFinding {
-	type: IGenericIntentFeedbackFindingType;
-}
-export interface IOverlapIntentFeedbackFinding {
-	type: IOverlapIntentFeedbackFindingType;
-	overlappingIntentReferenceId: string;
-	overlappingIntentName: string;
-	overlappingIntentId: TMongoId;
-	overlappingFlowName: string;
-	overlappingFlowId: TMongoId;
-}
-export interface ILowDataIntentFeedbackFinding {
-	type: "lowDataIntents";
-	intents: {
-		intentReferenceId: string;
-		intentName: string;
-		intentId: string;
-		flowId: string;
-		flowName: string;
-	}[];
-}
-declare const overlapIntentFeedbackFindingArrayType: readonly [
-	"strongOverlap",
-	"someOverlap"
-];
-export declare type IOverlapIntentFeedbackFindingType = typeof overlapIntentFeedbackFindingArrayType[number];
-declare const genericIntentFeedbackFindingArrayType: readonly [
-	"poorFScore",
-	"fairFScore",
-	"goodFScore",
-	"fewSentences",
-	"unclearIntent",
-	"noSiblings"
-];
-export declare type IGenericIntentFeedbackFindingType = typeof genericIntentFeedbackFindingArrayType[number];
-export declare type IntentFeedbackFinding = IGenericIntentFeedbackFinding | IOverlapIntentFeedbackFinding | ILowDataIntentFeedbackFinding;
-export interface IIntentFeedbackInDBReport {
-	findings: IntentFeedbackFinding[];
-	info: {
-		fScore: number;
-	};
-}
-declare const biasTowardsParentOrChildIntentsTypes: readonly [
-	"parents",
-	"children"
-];
-export declare type TBiasTowardsParentOrChildIntentsTypes = typeof biasTowardsParentOrChildIntentsTypes[number];
-declare const intentTypes: readonly [
-	"yesNoIntent",
-	"default"
-];
-export declare type TIntentTypes = typeof intentTypes[number];
-export interface ILocalizedIntentData {
-	rules: string[];
-	condition: string;
-	confirmationSentences: string[];
-	disambiguationSentence: string;
-	localeReference: TMongoId;
-}
-export interface IIntentInDB extends Omit<IIntent, keyof ILocalizedIntentData> {
-	localizedData: ILocalizedIntentData[];
-	/**
-	 * A list of all of the locales
-	 * that are not disabled. Used to return
-	 * the correct isDisabled value for the
-	 * given locale
-	 */
-	enabledLocaleReferences: TMongoId[];
-}
-export interface IIntent extends IEntityMeta, ILocalizedIntentData {
-	name: string;
-	description?: string;
-	referenceId: string;
-	isRejectIntent: boolean;
-	isDisabled: boolean;
-	tags: string[];
-	data: any;
-	nodeReferenceId: string;
-	childFeatures?: boolean | string[];
-	biasTowardsParentOrChildIntents: TBiasTowardsParentOrChildIntentsTypes;
-	parentIntentId?: string;
-	feedbackReport: IIntentFeedbackInDBReport;
-	intentRelationReferences: TMongoId[];
-	flowReference?: TMongoId;
-	projectReference: TMongoId;
-	organisationReference: TMongoId;
-	flowReferenceId?: string;
+export declare type TAttachments = TGenericAttachments | IStickerAttachment | IContactAttachment | ILocationAttachment;
+export interface IEightByEightEndpointSettings extends IEndpointSessionSettings {
+	/** The base 8x8 server url */
+	baseUrl: string;
+	/** The API Key which we use to access/authorize the 8x8 API calls */
+	apiKey: string;
 	/**
-	 * A label we use in analytics
-	 * to track when an intent was triggered
+	 * The API Tenant Id which we use as a 8x8 tenant header for the 8x8 API calls.
+	 * Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.
 	 */
-	analyticsLabel?: string;
+	apiTenant: string;
 	/**
-	 * Enable the usage of default replies as example sentences
+	 * If activated, CONVERSATION UPDATE EVENTS of state ACTIVE will be accepted & sent to the Flow. Users will be able to access the event payload via the Input data object.
+	 * If deactivated, CONVERSATION UPDATE EVENTS of state ACTIVE will not be accepted & will not be sent to the Flow.
 	 */
-	overrideIntentDefaultRepliesAsExamples?: string;
-	intentType: TIntentTypes;
+	acceptConversationActiveEvent?: boolean;
+	/** Settings to store attachments at a cloud provider */
+	fileStorageSettings?: IFileStorageSettings;
 }
-export interface IYesNoData {
-	_id: string;
-	rules: string[];
-	name: string;
-	isDisabled: boolean;
+export interface IGenesysBotConnectorEndpointSettings {
+	verifyToken: string;
 }
-export interface IYesNoItem {
-	yesIntent: IYesNoData | IIntentInDB;
-	noIntent: IYesNoData | IIntentInDB;
-	rejectIntent: IYesNoData | IIntentInDB;
+export interface INiceCXOneEndpointSettings {
+	verifyToken: string;
 }
+export interface INiceCXOneAAHEndpointSettings {
+	niceCXOneAAHConnection: string;
+}
+export interface IZoomContactCenterEndpointSettings {
+	verifyToken: string;
+}
+declare const arrayNLUConnectorType_2_0: readonly [
+	"alexa",
+	"dialogflow",
+	"dialogflowBuiltIn",
+	"amazonLexBuiltIn",
+	"luis",
+	"watson",
+	"noNlu",
+	"cognigy",
+	"code",
+	"lex",
+	"generativeAI"
+];
+export declare type TNLUConnectorType_2_0 = typeof arrayNLUConnectorType_2_0[number];
 /**
  * @openapi
  *
@@ -7239,6 +7692,9 @@ export interface IWebrtcWidgetConfig {
  *                 agentCopilotAuthentication:
  *                   type: string
  *                   description: Authentication connection reference Id for agent copilot
+ *                 oAuth2Connection:
+ *                   type: string
+ *                   description: OAuth2 Connection for Genesys Cloud
  *         orgDataPrivacySettings:
  *           $ref: '#/components/schemas/IEndpoitOrgDataPrivacySettings_2_0'
  *     IEndpoint_2_0:
@@ -8531,41 +8987,9 @@ export interface IProjectIndexItem_2_0 {
 }
 export interface IIndexProjectsRestData_2_0 extends IRestPagination<IProjectIndexItem_2_0> {
 	ignoreOwnership?: boolean;
-}
-export interface IIndexProjectsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IProjectIndexItem_2_0> {
-}
-export declare const nluLanguages: readonly [
-	"ar-AE",
-	"bn-IN",
-	"da-DK",
-	"en-AU",
-	"en-CA",
-	"en-GB",
-	"en-IN",
-	"en-US",
-	"es-ES",
-	"fi-FI",
-	"fr-FR",
-	"de-DE",
-	"hi-IN",
-	"it-IT",
-	"ja-JP",
-	"ko-KR",
-	"nn-NO",
-	"nl-NL",
-	"pl-PL",
-	"pt-BR",
-	"pt-PT",
-	"ru-RU",
-	"sv-SE",
-	"ta-IN",
-	"th-TH",
-	"tr-TR",
-	"vi-VN",
-	"zh-CN",
-	"ge-GE"
-];
-export declare type TNluLanguage = typeof nluLanguages[number];
+}
+export interface IIndexProjectsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IProjectIndexItem_2_0> {
+}
 /**
  * @openapi
  *
@@ -8863,109 +9287,6 @@ export interface IGraphLargeLanguageModel {
 	properties: Pick<ILargeLanguageModel, "modelType" | "connectionId" | "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy">;
 	dependencies?: IGraphLargeLanguageModelDependencyAttachment[];
 }
-export interface ISystemSlots {
-	DATE: IDateSlot[] | null;
-	NUMBER: INumberSlot[] | null;
-	DURATION: IDurationSlot[] | null;
-	TEMPERATURE: ITemperatureSlot[] | null;
-	AGE: IAgeSlot[] | null;
-	PERCENTAGE: IPercentageSlot[] | null;
-	EMAIL: IEmailSlot[] | null;
-	URL: IUrlSlot[] | null;
-	MONEY: IMoneySlot[] | null;
-	DISTANCE: IDistanceSlot[] | null;
-}
-export interface IBaseSlot {
-	text: string;
-	data: any;
-	offset: {
-		start: number;
-		end: number;
-	};
-}
-export interface IPercentageSlot extends IBaseSlot {
-	data: {
-		value: number;
-	};
-}
-export interface IAgeSlot extends IBaseSlot {
-	data: {
-		value: number;
-		unit: TTimeGrain;
-	};
-}
-export interface INumberSlot extends IBaseSlot {
-	data: {
-		value: number;
-	};
-}
-export interface IEmailSlot extends IBaseSlot {
-	data: {
-		value: string;
-	};
-}
-export declare type ITemperatureUnit = "celsius" | "fahrenheit" | "degree" | "kelvin";
-export interface ITemperatureSlot extends IBaseSlot {
-	data: {
-		value: number;
-		unit: ITemperatureUnit;
-	};
-}
-export declare type TTimeGrain = "second" | "minute" | "hour" | "day" | "week" | "month" | "quarter" | "year";
-export interface IDateObject {
-	day: number;
-	hour: number;
-	minute: number;
-	month: number;
-	second: number;
-	milliseconds: number;
-	weekday: number;
-	dayOfWeek: string;
-	year: number;
-	ISODate: string;
-	grain: TTimeGrain | null;
-	plain: string;
-	timezoneOffset?: string;
-}
-export interface IDateSlot extends IBaseSlot {
-	data: {
-		start?: IDateObject;
-		end?: IDateObject;
-	};
-}
-export interface IDurationSlot extends IBaseSlot {
-	data: {
-		unit?: TTimeGrain;
-		value?: number;
-		inSeconds?: number;
-		years?: number;
-		quarters?: number;
-		months?: number;
-		weeks?: number;
-		days?: number;
-		hours?: number;
-		minutes?: number;
-		seconds?: number;
-	};
-}
-export interface IMoneySlot extends IBaseSlot {
-	data: {
-		value: number;
-		unit: string;
-	};
-}
-export interface IUrlSlot extends IBaseSlot {
-	data: {
-		domain: string;
-		value: string;
-	};
-}
-export interface IDistanceSlot extends IBaseSlot {
-	data: {
-		unit: string;
-		value: number;
-	};
-}
 export interface IHandoverNodeParams extends INodeFunctionBaseParams {
 	config: {
 		text: string;
@@ -9060,23 +9381,6 @@ export interface ICodeNodeBasicParams extends INodeFunctionBaseParams {
 		code: string;
 	};
 }
-declare const arrayTDebugEventTypes: readonly [
-	"inputChanged",
-	"contextChanged",
-	"profileChanged",
-	"activeEntrypointsChanged",
-	"nodeExecuted",
-	"nodeError",
-	"finalPing",
-	"input",
-	"output",
-	"switchedFlow",
-	"nluWarning",
-	"debugMessage",
-	"debugError",
-	"goalCompleted"
-];
-export declare type TDebugEventType = typeof arrayTDebugEventTypes[number];
 export interface IInputChangedEventPayload {
 	input: {
 		[key: string]: any;
@@ -9106,17 +9410,6 @@ export interface INodeErrorEventPayload {
 	errorMessage: string;
 	sessionId?: string;
 }
-export interface IErrorEventPayload extends ILoggerStack {
-	message: string;
-	flowId: string;
-	nodeId?: string;
-}
-export interface IFinalPingEventPayload {
-	type: "regular" | "preventFinalPingToEndpoint" | "cognigyStopFlow" | "error";
-	analyticsData?: IAnalyticsSourceData;
-	error?: IErrorEventPayload;
-	sessionId?: string;
-}
 export interface IOutputEventPayload {
 	text?: string;
 	data?: {
@@ -9145,338 +9438,54 @@ export interface ISwitchedFlowEventPayload {
 	sessionId?: string;
 }
 export interface IActiveEntrypointsChangedEventPayload {
-	entrypoints: IActiveEntrypoint[];
-	sessionId?: string;
-}
-export interface IActiveEntrypoint {
-	flowId: string;
-	nodeReferenceId: string;
-	primary?: boolean;
-}
-export interface INluWarningEventPayload {
-	errorMessage: string;
-	sessionId?: string;
-}
-export interface IDebugEventMessagePayloadBase {
-	sessionId?: string;
-	header?: string;
-	metadata?: IOutputEventMetadata;
-}
-export interface IDebugEventTextMessagePayload extends IDebugEventMessagePayloadBase {
-	type: "text";
-	message: string;
-}
-export interface IDebugEventJsonMessagePayload extends IDebugEventMessagePayloadBase {
-	type: "json";
-	message: object;
-}
-export declare type TDebugEventMessagePayload = IDebugEventTextMessagePayload | IDebugEventJsonMessagePayload;
-export interface IGoalAnalyticsPayload {
-	analyticsdata: IGoalEscalations;
-	data: IPayloadBaseMetaData;
-}
-export interface IGoalAnalyticsData {
-	projectId: string;
-	organisationId: string;
-	sessionId: string;
-	referenceId: string;
-	version: string;
-	timestamp: Date;
-	goalCycleId: string;
-	stepId: string;
-	goalId: string;
-	contactId: string;
-	stepType?: string;
-}
-export interface IGoalEscalations extends IGoalAnalyticsData, IAnalyticsEndpointMeta, IAnalyticsLocaleMeta, IAnalyticsSnapshotMeta {
-}
-export interface IGoalCompletedEventPayload extends IGoalAnalyticsPayload {
-}
-export declare type TDebugEventPayload = IInputChangedEventPayload | IContextChangedEventPayload | IActiveEntrypointsChangedEventPayload | IProfileChangedEventPayload | INodeExecutedEventPayload | INodeErrorEventPayload | IFinalPingEventPayload | IOutputEventPayload | ISwitchedFlowEventPayload | INluWarningEventPayload | TDebugEventMessagePayload | IGoalCompletedEventPayload;
-declare const audioPreviewProviders: readonly [
-	"microsoft",
-	"google",
-	"aws",
-	"deepgram"
-];
-export declare type TAudioPreviewProvider = typeof audioPreviewProviders[number];
-/**
- * @openapi
- * components:
- *   schemas:
- *     IGenerativeAIUseCase:
- *       type: object
- *       properties:
- *         useCase:
- *           enum:
- *             - designTimeGeneration
- *             - intentSentenceGeneration
- *             - aiEnhancedOutputs
- *             - lexiconGeneration
- *             - flowGeneration
- *             - gptConversation
- *             - gptPromptNode
- *             - generateNodeOutput
- *             - knowledgeSearch
- *             - sentimentAnalysis
- */
-export interface IGenerativeAIUseCase {
-	useCase: TGenerativeAIUseCases;
-}
-export interface INluEmbeddingCredentials {
-	apiType: TGenerativeAIProviders;
-	apiKey: string;
-	apiModel: TGenerativeAIModels;
-	apiCustomBaseUrl?: string;
-	apiResourceName?: string;
-	apiDeploymentName?: string;
-	apiVersion?: string;
-}
-export interface ISetAppStateOverlaySettings {
-	autoOpen: boolean;
-	closeOnSubmit: boolean;
-	feedbackMessage: string;
-	screenTitle: string;
-	sendEventOnCloseIconClick: boolean;
-	showCloseIcon: boolean;
-}
-export interface ISetAppStateOverlaySettingsMetaData {
-	overlaySettings: ISetAppStateOverlaySettings;
-	endpointType: TEndpointType;
-	url: string;
-	URLToken: string;
-}
-export interface IVoiceGateway2VadParams {
-	enable?: boolean;
-	voiceMs?: number;
-	mode?: number;
-}
-export declare type TVoiceGateway2TTSVendor = "aws" | "deepgram" | "elevenlabs" | "google" | "microsoft" | "nuance" | "default" | "custom";
-export interface IVoiceGateway2SynthesizerParams {
-	vendor?: TVoiceGateway2TTSVendor | "default" | "none";
-	language?: string;
-	voice?: string;
-	label?: string;
-	fallbackVendor?: string;
-	fallbackLabel?: string;
-	fallbackLanguage?: string;
-	fallbackVoice?: string;
-	engine?: "standard" | "neural";
-	gender?: "MALE" | "FEMALE" | "NEUTRAL";
-	azureServiceEndpoint?: string;
-	options?: object;
-	disableCache?: boolean;
-	model?: string;
+	entrypoints: IActiveEntrypoint[];
+	sessionId?: string;
 }
-export declare type TVoiceGateway2STTVendor = "aws" | "deepgram" | "google" | "microsoft" | "nuance" | "soniox" | "default" | "custom";
-export declare type TVoiceGateway2GoogleModel = "latest_short" | "latest_long" | "command_and_search" | "phone_call" | "video" | "medical_dictation" | "medical_conversation" | "default";
-export declare type VoiceGatewayDeepgramModel = "base" | "base-phonecall" | "base-meeting" | "base-finance" | "base-voicemail" | "base-conversationalai" | "base-video" | "enhanced" | "enhanced-phonecall" | "enhanced-meeting" | "enhanced-finance" | "nova" | "nova-phonecall" | "nova-2" | "nova-2-meeting" | "nova-2-phonecall" | "nova-2-voicemail" | "nova-2-finance" | "nova-2-conversationalai" | "nova-2-medical" | "nova-2-drivethru" | "nova-2-automotive" | "whisper" | "whisper-tiny" | "whisper-base" | "whisper-small" | "whisper-large";
-export interface IVoiceGateway2RecognizerParams {
-	vendor?: TVoiceGateway2STTVendor | "default" | "none";
-	language?: string;
-	label?: string;
-	fallbackVendor?: string;
-	fallbackLabel?: string;
-	fallbackLanguage?: string;
-	vad?: IVoiceGateway2VadParams;
-	hints?: string[];
-	hintsBoost?: number;
-	altLanguages?: string[];
-	profanityFilter?: boolean;
-	interim?: boolean;
-	singleUtterance?: boolean;
-	dualChannel?: boolean;
-	separateRecognitionPerChannel?: boolean;
-	punctuation?: boolean;
-	enhancedModel?: boolean;
-	words?: boolean;
-	diarization?: boolean;
-	diarizationMinSpeakers?: number;
-	diarizationMaxSpeakers?: number;
-	interactionType?: "unspecified" | "discussion" | "presentation" | "phone_call" | "voicemail" | "voice_search" | "voice_command" | "dictation";
-	naicsCod?: number;
-	identifyChannels?: boolean;
-	vocabularyName?: string;
-	vocabularyFilterName?: string;
-	filterMethod?: "remove" | "mask" | "tag";
-	outputFormat?: "simple" | "detailed";
-	profanityOption?: "masked" | "removed" | "raw";
-	requestSnr?: boolean;
-	initialSpeechTimeoutMs?: number;
-	azureSttEndpointId?: string;
-	audioLogging?: boolean;
-	asrDtmfTerminationDigit?: string;
-	asrTimeout?: number;
-	nuanceOptions?: TVoiceGateway2NuanceOptions;
-	deepgramOptions?: TVoiceGateway2DeepgramOptions;
-	ibmOptions?: TVoiceGateway2IbmOptions;
-	nvidiaOptions?: TVoiceGateway2NvidiaOptions;
-	sonioxOptions?: TVoiceGateway2SonioxOptions;
-	model?: TVoiceGateway2GoogleModel | VoiceGatewayDeepgramModel | string;
+export interface IActiveEntrypoint {
+	flowId: string;
+	nodeReferenceId: string;
+	primary?: boolean;
 }
-export declare type TVoiceGateway2NuanceOptions = {
-	clientId?: string;
-	secret?: string;
-	kryptonEndpoint?: string;
-	topic?: string;
-	utteranceDetectionMode?: string;
-	punctuation?: boolean;
-	profanityFilter?: boolean;
-	includeTokenization?: boolean;
-	discardSpeakerAdaptation?: boolean;
-	suppressCallRecording?: boolean;
-	maskLoadFailures?: boolean;
-	suppressInitialCapitalization?: boolean;
-	allowZeroBaseLmWeight?: boolean;
-	filterWakeupWord?: boolean;
-	resultType?: string;
-	noInputTimeoutMs?: number;
-	recognitionTimeoutMs?: number;
-	utteranceEndSilenceMs?: number;
-	maxHypotheses?: number;
-	speechDomain?: string;
-	formatting?: TVoiceGatewayNuanceFormatting;
-	clientData?: object;
-	userId?: string;
-	speechDetectionSensitivity?: number;
-	resources?: [
-		TVoiceGatewayNuanceResources
-	];
-};
-export declare type TVoiceGateway2DeepgramOptions = {
-	deepgramSttUri?: string;
-	deepgramSttUseTls?: boolean;
-	apiKey?: string;
-	tier?: string;
-	model?: string;
-	customModel?: string;
-	version?: string;
-	punctuate?: boolean;
-	smartFormatting?: boolean;
-	profanityFilter?: boolean;
-	redact?: string;
-	diarize?: boolean;
-	diarizeVersion?: string;
-	ner?: boolean;
-	multichannel?: boolean;
-	alternatives?: number;
-	numerals?: boolean;
-	search?: string[];
-	replace?: string[];
-	keywords?: string[];
-	endpointing?: number | boolean;
-	utteranceEndMs?: number;
-	shortUtterance?: boolean;
-	vadTurnoff?: number;
-	tag?: string;
-};
-export declare type TVoiceGateway2NvidiaOptions = {
-	rivaUri?: string;
-	maxAlternatives?: number;
-	profanityFilter?: boolean;
-	punctuation?: boolean;
-	wordTimeOffsets?: boolean;
-	verbatimTranscripts?: boolean;
-	customConfiguration?: object;
-};
-export declare type TVoiceGateway2SonioxOptions = {
-	id?: string;
-	title?: string;
-	disableStoreAudio?: boolean;
-	disableStoreTranscript?: boolean;
-	disableSearch?: boolean;
-	metadata?: object;
-	storage?: object;
-};
-export declare type TVoiceGateway2IbmOptions = {
-	sttApiKey?: string;
-	sttRegion?: string;
-	ttsApiKey?: string;
-	ttsRegion?: string;
-	instanceId?: string;
-	model?: string;
-	languageCustomizationId?: string;
-	acousticCustomizationId?: string;
-	baseModelVersion?: string;
-	watsonMetadata?: string;
-	watsonLearningOptOut?: boolean;
-};
-export declare type TVoiceGatewayNuanceResourceReference = {
-	type?: string;
-	uri?: string;
-	maxLoadFailures?: boolean;
-	requestTimeoutMs?: number;
-	headers?: object;
-};
-export declare type TVoiceGatewayNuanceResources = {
-	externalReference?: TVoiceGatewayNuanceResourceReference;
-	inlineWordset?: string;
-	builtin?: string;
-	inlineGrammar?: string;
-	wakeupWord?: Array<string>;
-	weightName?: string;
-	weightValue?: number;
-	reuse?: string;
-};
-export declare type TVoiceGatewayNuanceFormatting = {
-	scheme?: string;
-	options?: object;
-};
-export declare type TVoiceGateway2InputType = "digits" | "speech";
-export declare type TVoiceGateway2UserNoInputMode = "event" | "speech" | "play";
-export declare type TVoiceGateway2FlowNoInputMode = "speech" | "play";
-export interface IVoiceGateway2BargeInParams {
-	enable?: boolean;
-	sticky?: boolean;
-	dtmfBargein?: boolean;
-	actionHook?: object | string;
-	input?: TVoiceGateway2InputType[];
-	finishOnKey?: string;
-	numDigits?: number;
-	minDigits?: number;
-	maxDigits?: number;
-	interDigitTimeout?: number;
-	minBargeinWordCount?: number;
+export interface INluWarningEventPayload {
+	errorMessage: string;
+	sessionId?: string;
 }
-export interface IVoiceGateway2ActivityParams {
-	synthesizer?: IVoiceGateway2SynthesizerParams;
-	recognizer?: IVoiceGateway2RecognizerParams;
-	bargeIn?: IVoiceGateway2BargeInParams;
-	user?: IVoiceGateway2CognigyUserInputConfigParams;
-	dtmf?: boolean;
-	sessionParams?: IVoiceGateway2ActivityParams;
-	fillerNoise?: IVoiceGateway2FillerNoiseParams;
-	flow?: IVoiceGateway2CognigyFlowInputConfigParams;
+export interface IDebugEventMessagePayloadBase {
+	sessionId?: string;
+	header?: string;
+	metadata?: IOutputEventMetadata;
 }
-export interface IVoiceGateway2FillerNoiseParams {
-	enable: boolean;
-	url?: string;
-	startDelaySecs?: number;
+export interface IDebugEventTextMessagePayload extends IDebugEventMessagePayloadBase {
+	type: "text";
+	message: string;
 }
-export declare type TVoiceGateway2DubActionType = "addTrack" | "removeTrack" | "silenceTrack" | "playOnTrack" | "sayOnTrack";
-export interface IVoiceGateway2CognigyUserInputConfigParams {
-	noInputMode?: TVoiceGateway2UserNoInputMode;
-	noInputTimeout?: number;
-	noInputRetries?: number;
-	noInputSpeech?: string;
-	noInputUrl?: string;
-	userNoInputAutoHangup?: boolean;
+export interface IDebugEventJsonMessagePayload extends IDebugEventMessagePayloadBase {
+	type: "json";
+	message: object;
 }
-export interface IVoiceGateway2CognigyFlowInputConfigParams {
-	flowNoInputEnable?: boolean;
-	flowNoInputMode?: TVoiceGateway2FlowNoInputMode;
-	flowNoInputTimeout?: number;
-	flowNoInputRetries?: number;
-	flowNoInputSpeech?: string;
-	flowNoInputUrl?: string;
-	flowNoInputFail?: boolean;
+export declare type TDebugEventMessagePayload = IDebugEventTextMessagePayload | IDebugEventJsonMessagePayload;
+export interface IGoalAnalyticsPayload {
+	analyticsdata: IGoalEscalations;
+	data: IPayloadBaseMetaData;
 }
-export interface IGetNluPipelineParams {
-	parseIntents?: boolean;
-	parseSlots?: boolean;
-	parseSystemSlots?: boolean;
-	findType?: boolean;
+export interface IGoalAnalyticsData {
+	projectId: string;
+	organisationId: string;
+	sessionId: string;
+	referenceId: string;
+	version: string;
+	timestamp: Date;
+	goalCycleId: string;
+	stepId: string;
+	goalId: string;
+	contactId: string;
+	stepType?: string;
+}
+export interface IGoalEscalations extends IGoalAnalyticsData, IAnalyticsEndpointMeta, IAnalyticsLocaleMeta, IAnalyticsSnapshotMeta {
+}
+export interface IGoalCompletedEventPayload extends IGoalAnalyticsPayload {
 }
+export declare type TDebugEventPayload = IInputChangedEventPayload | IContextChangedEventPayload | IActiveEntrypointsChangedEventPayload | IProfileChangedEventPayload | INodeExecutedEventPayload | INodeErrorEventPayload | IFinalPingEventPayload | IOutputEventPayload | ISwitchedFlowEventPayload | INluWarningEventPayload | TDebugEventMessagePayload | IGoalCompletedEventPayload;
 export interface ITrackAnalyticsStepsArguments {
 	nodeId?: string;
 	flowReferenceId: string;
@@ -10098,6 +10107,7 @@ export interface ISessionStateWithoutMeta {
 		};
 		mcpServerUrl?: string;
 		mcpToolNode?: string;
+		mcpHeaders?: Record<string, string>;
 		timeout?: number;
 	};
 	tokenUsage?: TSessionUsageInformation;
@@ -10388,6 +10398,21 @@ export interface IRunGenerativeAIPromptOptions {
 	   * Option to prevent the replacing of \n with " " in streamed outputs
 	   */
 	preventNewLineRemoval?: boolean;
+	/**
+	 * Optional logging configuration
+	 */
+	logging?: {
+		/** Webhook URL to receive request/response payloads */
+		webhookUrl?: string;
+		/** Custom data to be sent alongside the logging payloads */
+		customData?: unknown;
+		/**
+		 * Optional headers to be sent with the webhook request
+		 */
+		headers?: Record<string, unknown> | JSON;
+		/** Any additional fields are forwarded into logging meta */
+		[key: string]: unknown;
+	};
 }
 export interface IAzureOpenAIProviderFieldsV2 {
 	apiKey: string;
@@ -11422,6 +11447,7 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
 		mcpServerUrl: string;
 		timeout: number;
 		cacheTools: boolean;
+		mcpHeaders?: Record<string, string>;
 	}) => Promise<any[]>;
 	executeMcpTool: (params: {
 		toolName: string;
@@ -11430,6 +11456,7 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
 		};
 		mcpServerUrl: string;
 		timeout: number;
+		mcpHeaders?: Record<string, string>;
 	}) => Promise<{
 		[x: string]: unknown;
 	}>;
@@ -17222,7 +17249,8 @@ export interface ITransferNodeParams extends INodeFunctionBaseParams {
 		transferReason: string;
 		transferTarget: string;
 		referredBy: string;
-		anchorMedia: boolean;
+		mediaPath: TVoiceGateway2MediaPath;
+		anchorMedia?: boolean;
 		useTransferSipHeaders: boolean;
 		transferSipHeaders: {
 			[key: string]: string | object;
@@ -18276,7 +18304,8 @@ declare const knowledgeSourceType: readonly [
 	"png",
 	"bmp",
 	"heif",
-	"tiff"
+	"tiff",
+	"extension"
 ];
 export declare type TKnowledgeSourceType = typeof knowledgeSourceType[number];
 export interface IKnowledgeSourceMetaData {
@@ -20229,6 +20258,8 @@ export interface IIndexLogEntriesRestData_2_0 extends IRestPagination<ILogEntryI
 	type?: Array<TLogLevel>;
 	userId?: string;
 	flowName?: string;
+	startDate?: string;
+	endDate?: string;
 }
 export interface IIndexLogEntriesRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<ILogEntryIndexItem_2_0> {
 }
@@ -20269,6 +20300,19 @@ export interface IReadLogEntryRestData_2_0 extends IReadLogEntryRestDataParams_2
 }
 export interface IReadLogEntryRestReturnValue_2_0 extends ILogEntry_2_0 {
 }
+export interface ITailLogEntriesRestDataParams_2_0 extends IProjectScope {
+}
+export interface ITailLogEntriesRestData_2_0 extends IRestPagination<ILogEntryIndexItem_2_0>, ITailLogEntriesRestDataParams_2_0 {
+	type?: TLogLevel[];
+	userId?: string;
+	flowName?: string;
+}
+export interface ITailLogEntriesRestReturnValue_2_0 {
+	items: ILogEntryIndexItem_2_0[];
+	total: number;
+	nextCursor: string | null;
+	previousCursor: string | null;
+}
 /**
  * @openapi
  *
@@ -20916,6 +20960,7 @@ export interface MetricsAPIGroup_2_0 {
 	removeProfileData: TRestAPIOperation<IRemoveProfileDataRestData_2_0, IRemoveProfileDataRestReturnValue_2_0>;
 	removeContactIdFromProfile: TRestAPIOperation<IRemoveContactIdFromProfileRestData_2_0, IRemoveContactIdFromProfileRestReturnValue_2_0>;
 	indexLogEntries: TRestAPIOperation<IIndexLogEntriesRestData_2_0, IIndexLogEntriesRestReturnValue_2_0>;
+	tailLogEntries: TRestAPIOperation<ITailLogEntriesRestData_2_0, ITailLogEntriesRestReturnValue_2_0>;
 	readLogEntry: TRestAPIOperation<IReadLogEntryRestData_2_0, IReadLogEntryRestReturnValue_2_0>;
 	indexTrainerRecords: TRestAPIOperation<IIndexTrainerRecordsRestData_2_0, IIndexTrainerRecordsRestReturnValue_2_0>;
 	readTrainerRecord: TRestAPIOperation<IReadTrainerRecordRestData_2_0, IReadTrainerRecordRestReturnValue_2_0>;
@@ -21326,7 +21371,8 @@ declare const actionTypes: readonly [
 	"processKnowledgeSourceFile",
 	"setupObservationConfig",
 	"updateObservationConfig",
-	"resolveAiOpsCenterError"
+	"resolveAiOpsCenterError",
+	"odataRequest"
 ];
 export declare type TActionType = typeof actionTypes[number];
 /**
@@ -22284,6 +22330,9 @@ export interface ISetupVoiceGatewayRestData_2_0 extends ISetupVoiceGatewayRestDa
  *           $ref: '#/components/schemas/TTimezone'
  *         dataPrivacySettings:
  *           $ref: '#/components/schemas/IOrganisationDataPrivacySettings_2_0'
+ *         businessUnitId:
+ *           type: string
+ *           description: The business unit ID
  *     IOrganisation_2_0:
  *       allOf:
  *         - $ref: '#/components/schemas/IOrganisationData_2_0'
@@ -22305,6 +22354,8 @@ export interface IOrganisation_2_0 {
 	_id: TMongoId;
 	/** The name of this organisation, e.g. 'cognigy' */
 	name: string;
+	/** The business unit ID */
+	businessUnitId?: string;
 	/** Flag whether this organisation is currently disabled */
 	disabled: boolean;
 	/** Optional quota information */
@@ -22401,6 +22452,9 @@ export interface IOrganisationDataPrivacySettings_2_0 {
  *       properties:
  *         _id:
  *           $ref: '#/components/schemas/TMongoId'
+ *         businessUnitId:
+ *           type: string
+ *           description: The business unit ID
  *         name:
  *           type: string
  *           description: The name of this organisation
@@ -22437,6 +22491,8 @@ export interface IOrganisationIndexItem_2_0 {
 	_id: TMongoId;
 	/** The name of this organisation, e.g. 'cognigy' */
 	name: string;
+	/** The business unit ID */
+	businessUnitId?: string;
 	/** Flag whether this organisation is currently disabled */
 	disabled: boolean;
 	/** Optional quota information */
@@ -23226,6 +23282,7 @@ export interface IOpsCenterObservationConfig {
 	observationActive: boolean;
 	notificationConfig: NotificationConfig;
 	alertingConfig: AlertingConfig;
+	recordVersion: number;
 }
 export interface IGetOpsCenterObservationConfigRestReturnValue_2_0 extends IOpsCenterObservationConfig {
 }