@cognigy/rest-api-client 2025.24.0 → 2026.1.0

package/types/index.d.ts

@@ -935,6 +935,7 @@ declare const referenceKeys: readonly [
 	"resourceReference",
 	"snapshotReference",
 	"subResourceReference",
+	"connectorReference",
 	"storeReference",
 	"sourceReference"
 ];
@@ -965,6 +966,7 @@ declare const arrayTResourceType: readonly [
 	"knowledgeStore",
 	"knowledgeSource",
 	"knowledgeChunk",
+	"knowledgeConnector",
 	"lexicon",
 	"lexiconEntry",
 	"lexiconKeyphrase",
@@ -1609,6 +1611,20 @@ export interface IExchangeOneTimeTokenForRefreshTokenRestData_2_0 extends IExcha
 export interface IExchangeOneTimeTokenForRefreshTokenRestReturnValue_2_0 {
 	refreshToken: string;
 }
+/**
+ * @openapi
+ *
+ * components:
+ *   schemas:
+ *     IExchangeCXoneTokenRestReturnValue_2_0:
+ *       type: object
+ *       properties:
+ *         refreshToken:
+ *           type: string
+ */
+export interface IExchangeCXoneTokenRestReturnValue_2_0 {
+	refreshToken: string;
+}
 export interface AuthenticationAPI {
 	authenticationHandler?: IAuthenticationAdapter;
 	setCredentials: (credentials: TAuthenticationCredentials) => void;
@@ -1621,6 +1637,7 @@ export interface AuthenticationAPI {
 	webfinger: TRestAPIOperation<IWebfingerRestData, IWebfingerRestReturnValue>;
 	getAuthorizationCode?: (data: IGetAuthorizationCodeParameters) => Promise<IGetAuthorizationCodeResponse>;
 	exchangeOneTimeTokenForRefreshToken: TRestAPIOperation<IExchangeOneTimeTokenForRefreshTokenRestData_2_0, IExchangeOneTimeTokenForRefreshTokenRestReturnValue_2_0>;
+	exchangeCXoneToken: TRestAPIOperation<{}, IExchangeCXoneTokenRestReturnValue_2_0>;
 	generateManagementUIAuthToken: TRestAPIOperation<void, {
 		token: string;
 	}>;
@@ -2530,6 +2547,10 @@ export interface IEndpoint extends IEntityMeta {
 		label: string;
 		active: boolean;
 	};
+	/**
+	 * Whether to enable mocking code for the node execution
+	 */
+	enableMocking?: boolean;
 }
 export interface IGraphEndpoint {
 	type: "endpoint";
@@ -3028,9 +3049,8 @@ export interface IVoiceGateway2VadParams {
 	voiceMs?: number;
 	mode?: number;
 }
-export declare type TVoiceGateway2TTSVendor = "aws" | "deepgram" | "elevenlabs" | "google" | "microsoft" | "nuance" | "default" | "custom";
 export interface IVoiceGateway2SynthesizerParams {
-	vendor?: TVoiceGateway2TTSVendor | "default" | "none";
+	vendor?: string;
 	language?: string;
 	voice?: string;
 	label?: string;
@@ -3045,11 +3065,9 @@ export interface IVoiceGateway2SynthesizerParams {
 	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";
+	vendor?: string;
 	language?: string;
 	label?: string;
 	fallbackVendor?: string;
@@ -3089,7 +3107,8 @@ export interface IVoiceGateway2RecognizerParams {
 	ibmOptions?: TVoiceGateway2IbmOptions;
 	nvidiaOptions?: TVoiceGateway2NvidiaOptions;
 	sonioxOptions?: TVoiceGateway2SonioxOptions;
-	model?: TVoiceGateway2GoogleModel | VoiceGatewayDeepgramModel | string;
+	openaiOptions?: TVoiceGateway2OpenaiOptions;
+	model?: string;
 }
 export declare type TVoiceGateway2NuanceOptions = {
 	clientId?: string;
@@ -3165,6 +3184,10 @@ export declare type TVoiceGateway2SonioxOptions = {
 	metadata?: object;
 	storage?: object;
 };
+export declare type TVoiceGateway2OpenaiOptions = {
+	model?: string;
+	apiKey?: string;
+};
 export declare type TVoiceGateway2IbmOptions = {
 	sttApiKey?: string;
 	sttRegion?: string;
@@ -3445,6 +3468,9 @@ export interface IVoiceGatewayEndpointSettings extends IEndpointSessionSettings
 	privacyNotice: Omit<IWebchat3EndpointPrivacyNoticeSettings, "title"> & {
 		cancelButtonText: string;
 	};
+	transcription: {
+		enabled: boolean;
+	};
 }
 export declare type AnyEndpointSettings = IFacebookEndpointSettings | IWorkplaceEndpointSettings | ISlackEndpointSettings | IGenericEndpointSettings | IAlexaEndpointSettings | IWebchat2EndpointSettings | IWebchat3EndpointSettings | ILineEndpointSettings | ITwilioEndpointSettings | ITwilioSmsEndpointSettings | IIntercomEndpointSettings | IRealtimeEndpointSettings | ISunshineConversationsEndpointSettings | IAvayaEndpointSettings | IUserlikeEndpointSettings | IBandwidthEndpointSettings | IAudioCodesEndpointSettings | IWhatsAppEndpointSettings | IAmazonLexEndpointSettings | IEightByEightEndpointSettings | IMicrosoftBotFrameworkEndpointSettings | IVoiceGatewayEndpointSettings | IGenesysBotConnectorEndpointSettings | INiceCXOneEndpointSettings | INiceCXOneAAHEndpointSettings | IAgentAssistVoiceEndpointSettings | IZoomContactCenterEndpointSettings | {};
 export declare type TAvayaVoice = "man" | "woman" | string;
@@ -7844,6 +7870,8 @@ export interface IEndpoint_2_0 {
 	sipConnectivityInfo?: ISipConnectivityInfo;
 	/** The label of the webrtc widget */
 	webrtcWidgetConfig?: IWebrtcWidgetConfig;
+	/** Whether to enable mocking code for the node execution */
+	enableMocking: boolean;
 }
 export interface ITransformerFunction_2_0 {
 	/**
@@ -9208,6 +9236,10 @@ export interface IGraphAgentAssistConfig {
  *           items:
  *             type: string
  *             description: MongoDB ObjectId representing a project
+ *           example:
+ *             - "68edf5dd4c931f68d31111"
+ *             - "690b02fc100e454245adde111"
+ *             - "68e6eda61ff68d2111"
  *
  *     IGlobalResourceFields_2_0:
  *       allOf:
@@ -9439,6 +9471,7 @@ export interface ICodeNodeParams extends ICodeNodeBasicParams {
 		hasError?: boolean;
 		transpiled?: string;
 	};
+	IsMockCodeExecution?: boolean;
 }
 export interface ICodeNodeBasicParams extends INodeFunctionBaseParams {
 	config: {
@@ -9677,7 +9710,7 @@ export interface ISpeakingStyle {
 export interface IVoiceConfigParams {
 	ttsVoice: string;
 	ttsLanguage: string;
-	ttsVendor: TVoiceGateway2TTSVendor | "none";
+	ttsVendor: string;
 	ttsModel: string;
 	ttsLabel: string;
 	ttsDisableCache: boolean;
@@ -10658,6 +10691,10 @@ export interface IGenerativeSlotFillerParams extends INodeFunctionBaseParams {
 }
 export interface IEndpointSettings {
 	isFeatureAccmEnabled?: boolean;
+	/**
+	 * Whether to enable mocking code for the node execution
+	 */
+	enableMocking?: boolean;
 }
 export interface IChartExecutableNode<C extends INodeFunctionBaseParams = INodeFunctionBaseParams> extends IProjectScope, IOrganisationScope {
 	id: string;
@@ -10690,6 +10727,111 @@ export interface IChartExecutableNode<C extends INodeFunctionBaseParams = INodeF
 	 */
 	isDisabled: boolean;
 	analyticsLabel?: string;
+	/**
+	 * Mock object to replace the node function with a mock function,
+	 * when the mock mode is enabled for the node and the endpoint settings allow it.
+	 */
+	mock: {
+		isEnabled: boolean;
+		code: string;
+		transpiled?: string;
+		hasError?: boolean;
+	};
+}
+/**
+ * @param meta.contactNumber DirectQuery views this is as an identifier similar to a session ID
+ */
+export interface ICXoneKnowledgehubRequestBody {
+	schemaVersion?: string;
+	timestamp: string;
+	meta: {
+		tenantId?: string;
+		contactNumber: string;
+		agentUid?: string;
+		provider: string;
+	};
+	query: {
+		uid: string;
+		text: string;
+		persona?: string;
+		language?: string;
+	};
+	kbFiltering?: {
+		conversationContextRefId?: string;
+		filters?: string;
+	};
+	config: {
+		kbAnswers: {
+			promptEditorProfileId?: string;
+			answers: {
+				enabled: boolean;
+				maxWords: number;
+			};
+			images: {
+				enabled: boolean;
+				maxImages: number;
+			};
+			links: {
+				enabled: boolean;
+				maxLinks: number;
+			};
+		};
+		kbProcessSteps: {
+			enabled: boolean;
+			maxSteps: number;
+			maxTitleWords: number;
+			maxStepWords: number;
+		};
+		awsBedrock: {
+			knowledgeHubId: string;
+			awsBedrockKbId: string;
+			maxKernels: number;
+			shareable: boolean;
+			promptTemplate?: {
+				textPromptTemplate: string;
+				modelArn: string;
+			};
+		};
+	};
+}
+export interface ICXoneKnowledgehubResponseBody {
+	timestamp: string;
+	kbAnswers: {
+		uid: string;
+		conversationContextRefId?: string;
+		kbCompletions: Array<{
+			uid: string;
+			kbCompletion: string;
+			restriction: "Public" | "Private" | "Combine";
+			citations: Array<{
+				text: string;
+				start: number;
+				end: number;
+			}>;
+		}>;
+		kbImages: Array<{
+			uid: string;
+			pageId: number;
+			title: string;
+			link: string;
+			thumbnail: string;
+			restriction: "Public" | "Private";
+		}>;
+		kbLinks: Array<{
+			uid: string;
+			pageId: number;
+			title: string;
+			link: string;
+			restriction: "Public" | "Private";
+		}>;
+	};
+}
+export interface INiceCXoneKnowledgehubFields {
+	accessKey: string;
+	secretKey: string;
+	clientId?: string;
+	clientSecret?: string;
+	endpointUrl?: string;
 }
 export interface IGetConversationTranscriptParams {
 	turnLimit: number;
@@ -10858,6 +11000,7 @@ export interface IActions {
 	getEndpointSettings: () => IEndpointSettings;
 	getTranscript: (options: TReadTranscriptOptions) => Promise<TTranscriptEntry[]>;
 	addTranscriptStep: (content: TTranscriptEntryContent) => Promise<void>;
+	executeNiceCxoneKnowledgehubApiRequest(knowledgehubConnection: INiceCXoneKnowledgehubFields, requestBody: ICXoneKnowledgehubRequestBody): Promise<ICXoneKnowledgehubResponseBody>;
 }
 export interface IGetMetaDataActionValue {
 	sessionId: string;
@@ -10874,6 +11017,7 @@ export interface IGetMetaDataActionValue {
 	snapshotName: string;
 	isFollowSessionActive: boolean;
 	contactId: string;
+	enableMocking: boolean;
 }
 export interface ICognigyNLPProperties {
 	/** The original text of the user */
@@ -11149,6 +11293,7 @@ export interface ISendEmailNodeParams extends INodeFunctionBaseParams {
 		googleWarning: string;
 		recipient: string;
 		from: string;
+		senderName: string;
 		message: string;
 		subject: string;
 		replyTo: string;
@@ -11172,7 +11317,7 @@ export interface ISendEmailNodeParams extends INodeFunctionBaseParams {
 	} & (ISMTPEmailConnection);
 }
 export interface IEmailNotificationNodeParams extends INodeFunctionBaseParams {
-	config: Pick<ISendEmailNodeParams["config"], "recipient" | "message" | "subject" | "cc" | "bcc" | "priority" | "async" | "storeLocation" | "inputKey" | "contextKey" | "stopOnError">;
+	config: Pick<ISendEmailNodeParams["config"], "senderName" | "recipient" | "message" | "subject" | "cc" | "bcc" | "priority" | "async" | "storeLocation" | "inputKey" | "contextKey" | "stopOnError">;
 }
 export interface ISQLConnectionFields {
 	host: string;
@@ -11677,6 +11822,7 @@ declare const nodeFieldTypes: readonly [
 	"checkAgentAvailabilityConfig",
 	"chipInput",
 	"code",
+	"mockCode",
 	"cognigyLLMText",
 	"cognigyText",
 	"cognigyTextArray",
@@ -11839,6 +11985,9 @@ export interface INodeDescriptor<T extends INodeFunctionBaseParams = any, U exte
 	sections?: INodeSection[];
 	/** The form defines how fields and sections should be render in order */
 	form?: INodeFieldAndSectionFormElement[];
+	mocking?: {
+		defaultMockCode?: string;
+	};
 }
 export interface IAppTemplate extends IEntityMeta {
 	/** The object id of this app template */
@@ -13377,7 +13526,17 @@ export interface IChart_2_0 {
  *         analyticsLabel:
  *           type: string
  *           example: "condition"
-
+ *         mock:
+ *           type: object
+ *           properties:
+ *             isEnabled:
+ *               type: boolean
+ *               example: false
+ *             code:
+ *               type: string
+ *               example: "console.log('Hello, world!');"
+ *               description: Mock code to be executed when the mock mode is enabled.
+ *               nullable: false
  *
  *     IChartNode_2_0:
  *       allOf:
@@ -13401,6 +13560,10 @@ export interface IChartNode_2_0<T extends INodeFunctionBaseParams = any> {
 	extension: string;
 	localeReference: string;
 	analyticsLabel?: string;
+	mock: {
+		isEnabled: boolean;
+		code: string;
+	};
 }
 declare enum ConvertActionType {
 	ADDED = "added",
@@ -13409,6 +13572,12 @@ declare enum ConvertActionType {
 }
 export declare type TConvertAction = (typeof ConvertActionType)[keyof typeof ConvertActionType];
 export declare type TNodeConversionMetadata = Record<string, TConvertAction>;
+export interface IMockData {
+	isEnabled: boolean;
+	code: string;
+	transpiled?: string;
+	hasError?: boolean;
+}
 export interface IChartNodeBase {
 	_id: TMongoId;
 	referenceId: string;
@@ -13436,6 +13605,7 @@ export interface IChartNodeBase {
 	resourceReference: TMongoId;
 	projectReference: TMongoId;
 	organisationReference: TMongoId;
+	mock: IMockData;
 }
 export interface IChartNode<T extends string = string, D extends INodeFunctionBaseParams = any, E extends string = string> extends IChartNodeBase {
 	type: T;
@@ -14383,7 +14553,7 @@ export interface INodeField_2_0 {
 	};
 }
 export declare type TNodeTag = "basic" | "logic" | "message" | "profile" | "service" | "nlu" | "data" | string;
-export declare type TNodeFieldType_2_0 = "text" | "rule" | "select" | "xml" | "typescript" | "json" | "textArray" | "chipInput" | "date" | "datetime" | "time" | "cognigyText" | "checkbox" | "toggle" | "slider" | "number" | "daterange" | "say" | "code" | "connection" | "condition" | "flow" | "node" | "flowNode" | "lexicon" | "switchNode" | "caseNode" | "sttSelect" | "sttTierModelSelect" | "ttsSelect" | "sttLanguageAzureSelect" | "sttLanguageGoogleSelect";
+export declare type TNodeFieldType_2_0 = "text" | "rule" | "select" | "xml" | "typescript" | "json" | "textArray" | "chipInput" | "date" | "datetime" | "time" | "cognigyText" | "checkbox" | "toggle" | "slider" | "number" | "daterange" | "say" | "code" | "connection" | "condition" | "flow" | "node" | "flowNode" | "lexicon" | "switchNode" | "caseNode" | "sttSelect" | "sttTierModelSelect" | "ttsSelect" | "sttLanguageAzureSelect" | "sttLanguageGoogleSelect" | "mock";
 export interface INodeDependencies_2_0 {
 	/** A list of Node types */
 	children: string[];
@@ -16803,7 +16973,7 @@ export interface IVoiceConfigParams {
 	ttsVoice: string;
 	ttsLanguage: string;
 	ttsModel: string;
-	ttsVendor: TVoiceGateway2TTSVendor | "default" | "none";
+	ttsVendor: string;
 	ttsLabel: string;
 	azureSttContextId: string;
 	azureSpeechRecognitionMode: string;
@@ -16846,7 +17016,7 @@ export interface IVoiceConfigParams {
 	sttGoogleLang1: string;
 	sttGoogleLang2: string;
 	sttGoogleLang3: string;
-	sttDeepgramModel: VoiceGatewayDeepgramModel;
+	sttModel: string;
 	deepgramEndpointing: boolean;
 	deepgramEndpointingValue: number;
 	deepgramSmartFormatting: boolean;
@@ -16916,13 +17086,13 @@ export interface IVoiceConfigParams {
 	sttHintsDynamicHints: string[] | undefined;
 	ttsVoice: string;
 	ttsLanguage: string;
-	ttsVendor: TVoiceGateway2TTSVendor;
+	ttsVendor: string;
 	ttsModel: string;
 	sttDisablePunctuation: boolean;
 	azureSttContextId: string;
 	azureEnableAudioLogging: boolean;
 	googleModel: TVoiceGateway2GoogleModel;
-	sttDeepgramModel: VoiceGatewayDeepgramModel;
+	sttModel: string;
 	deepgramEndpointing: boolean;
 	deepgramEndpointingValue: number;
 	deepgramSmartFormatting: boolean;
@@ -17338,7 +17508,7 @@ export interface ITransferNodeParams extends INodeFunctionBaseParams {
 		recognitionChannel: number;
 		sttLanguage: string;
 		sttVendor: string;
-		sttDeepgramModel: VoiceGatewayDeepgramModel;
+		sttModel: string;
 		sttDisablePunctuation: boolean;
 		googleModel: TVoiceGateway2GoogleModel;
 		sttLabel: string;
@@ -18072,9 +18242,13 @@ export interface IGoogleGeminiMeta_2_0 {
  *         - $ref: '#/components/schemas/IGlobalLargeLanguageModelData_2_0'
  *         - $ref: '#/components/schemas/IEntityMeta'
  *     ILargeLanguageModel_2_0:
- *       allOf:
- *         - $ref: '#/components/schemas/ILargeLanguageModelData_2_0'
- *         - $ref: '#/components/schemas/IEntityMeta'
+ *       oneOf:
+ *         - allOf:
+ *             - $ref: '#/components/schemas/ILargeLanguageModelData_2_0'
+ *             - $ref: '#/components/schemas/IEntityMeta'
+ *         - allOf:
+ *             - $ref: '#/components/schemas/IGlobalLargeLanguageModelData_2_0'
+ *             - $ref: '#/components/schemas/IEntityMeta'
  */
 export interface ILargeLanguageModel_2_0 extends IGlobalResource {
 	referenceId: string;
@@ -18404,6 +18578,7 @@ export interface IKnowledgeSourceMetaData {
 		id: string;
 		type: string;
 	};
+	contentHashOrTimestamp?: string;
 }
 /**
  * @openapi
@@ -18430,6 +18605,7 @@ export interface IKnowledgeSourceMetaData {
  *                 - pdf
  *                 - txt
  *                 - ctxt
+ *                 - extension
  *               description: The type of source for the Knowledge store
  *             metaData:
  *               type: object
@@ -18482,6 +18658,15 @@ export interface IKnowledgeSourceMetaData {
  *           properties:
  *             metaData:
  *               type: object
+ *             data:
+ *               type: object
+ *               additionalProperties: true
+ *               description: Custom metadata object to store additional information in the KnowledgeSource
+ *               example:
+ *                 _id: "x4xU6hMntv23p"
+ *                 sys_CreatedAt: "2019-12-16T11:40:45.7212"
+ *                 sys_UpdatedAt: "2025-10-01T07:46:04.5932"
+ *                 Type: "FAQ"
  *             chunkCount:
  *               type: integer
  *             status:
@@ -18490,6 +18675,10 @@ export interface IKnowledgeSourceMetaData {
  *                 - ready
  *                 - ingesting
  *                 - disabled
+ *             connectorReference:
+ *               type: string
+ *               format: uuid
+ *               description: The connector Id associated with the KnowledgeSource. This is only applicable for KnowledgeSources of type "extension"
  *
  *     IKnowledgeSourceGeneratedData_2_0:
  *       type: object
@@ -18498,6 +18687,20 @@ export interface IKnowledgeSourceMetaData {
  *           type: string
  *           format: uuid
  *
+ *     IKnowledgeSourceDataTypeExtension_2_0:
+ *       type: object
+ *       properties:
+ *         connectorId:
+ *           type: string
+ *           format: uuid
+ *           description: The connector Id associated with the KnowledgeSource. This is only applicable for KnowledgeSources of type "extension"
+ *       example:
+ *         name: "mysource"
+ *         description: "mysource description"
+ *         type: "extension"
+ *         metaData:
+ *           tags: ["tag1"]
+ *         connectorId: "uuid"
  *     IKnowledgeSource_2_0:
  *       allOf:
  *         - $ref: '#/components/schemas/IKnowledgeSourceData_2_0'
@@ -18515,6 +18718,7 @@ export interface IKnowledgeSource_2_0 {
 	metaData: IKnowledgeSourceMetaData;
 	data: Record<string, unknown>;
 	storeReference: TMongoId;
+	connectorReference?: TMongoId;
 	projectReference: TMongoId;
 	organisationReference: TMongoId;
 	createdAt: number;
@@ -18701,6 +18905,241 @@ export interface IRunKnowledgeExtensionRestData_2_0 extends IRunKnowledgeExtensi
 }
 export interface IRunKnowledgeExtensionRestReturnValue_2_0 extends ICreatedTask_2_0 {
 }
+declare const knowledgeConnectorExecutionStatus: readonly [
+	"none",
+	"queued",
+	"active",
+	"done",
+	"error"
+];
+export declare type KnowledgeConnectorExecutionStatus = typeof knowledgeConnectorExecutionStatus[number];
+/**
+ * @openapi
+ *
+ * components:
+ *   schemas:
+ *     IKnowledgeConnectorCreatePayload_2_0:
+ *       allOf:
+ *         - $ref: '#/components/schemas/IKnowledgeConnectorExtensionReference_2_0'
+ *         - $ref: '#/components/schemas/IKnowledgeConnectorData_2_0'
+ *
+ *     IKnowledgeConnectorUpdatePayload_2_0:
+ *       allOf:
+ *         - $ref: '#/components/schemas/IKnowledgeConnectorData_2_0'
+ *
+ *     IKnowledgeConnectorExtensionReference_2_0:
+ *       type: object
+ *       properties:
+ *         extension:
+ *           type: string
+ *           description: The name of the extension
+ *           example: "confluence"
+ *         version:
+ *           type: string
+ *           description: The version of extension identifier
+ *           example: "1.1.0"
+ *         type:
+ *           type: string
+ *           description: The Knowledge Connector type identifier within an extension
+ *           example: "MyConfluenceConnector"
+ *
+ *     IKnowledgeConnectorData_2_0:
+ *       type: object
+ *       properties:
+ *         config:
+ *           type: object
+ *           description: The configuration of the KnowledgeConnector
+ *         name:
+ *           type: string
+ *           description: The name of the KnowledgeConnector
+ *           example: "My Knowledge Connector"
+ *         schedule:
+ *           type: object
+ *           properties:
+ *             enabled:
+ *               type: boolean
+ *               description: If scheduled execution is enabled or not
+ *               example: true
+ *             start:
+ *               $ref: '#/components/schemas/TTimestamp'
+ *               description: Start date and time to calculate scheduled execution
+ *             hour:
+ *               type: number
+ *               description: Hour to start the scheduled execution
+ *               example: 1
+ *             minute:
+ *               type: number
+ *               description: Minute to start the scheduled execution
+ *               example: 1
+ *             weekDays:
+ *               type: array
+ *               items:
+ *                 type: number
+ *               description: Repeat x days of the week, Monday = 0 ... Sunday = 6
+ *               example: [0,3]
+ *
+ *     IKnowledgeConnectorExecution_2_0:
+ *       type: object
+ *       properties:
+ *         lastExecution:
+ *           $ref: '#/components/schemas/TTimestamp'
+ *           description: Unix-timestamp when the last execution was triggered
+ *         lastExecutionStatus:
+ *           type: string
+ *           description: Last execution status of the KnowledgeConnector
+ *           enum:
+ *             - none
+ *             - queued
+ *             - active
+ *             - done
+ *             - error
+ *
+ *     IKnowledgeConnector_2_0:
+ *       allOf:
+ *         - $ref: '#/components/schemas/IKnowledgeConnectorExtensionReference_2_0'
+ *         - $ref: '#/components/schemas/IKnowledgeConnectorData_2_0'
+ *         - $ref: '#/components/schemas/IKnowledgeConnectorExecution_2_0'
+ *         - $ref: '#/components/schemas/IEntityMeta'
+ */
+export interface IKnowledgeConnector_2_0 {
+	/**
+	 * Extension nam
+	 */
+	extension: string;
+	/**
+	 * The type identifier of Knowledge Connector within an Extension
+	 */
+	type: string;
+	/**
+	 * The version of the Knowledge Connector Extension
+	 */
+	version: string;
+	/**
+	 * The configuration of the KnowledgeConnector
+	 */
+	config: Record<string, unknown>;
+	/**
+	 * The name of the KnowledgeConnector
+	 */
+	name: string;
+	/**
+	 * Schedule configuration
+	 */
+	schedule: {
+		/**
+		 * If scheduled execution is enabled or not
+		 */
+		enabled: boolean;
+		/**
+		 * Start date and time to calculate scheduled execution
+		 */
+		start: number;
+		/**
+		 * Hour to start the scheduled execution
+		 */
+		hour: number;
+		/**
+		 * Minute to start the scheduled execution
+		 */
+		minute: number;
+		/**
+		 * Repeat x days of the week
+		 */
+		weekDays: Array<number>;
+	};
+	_id: TMongoId;
+	referenceId: TMongoId;
+	/**
+	 * The knowledge store Id to which the KnowledgeSource belongs to
+	 */
+	storeReference: TMongoId;
+	/**
+	 * The project Id to which the KnowledgeSource belongs to
+	 */
+	projectReference: TMongoId;
+	/**
+	 * The organisation Id to which the KnowledgeSource belongs to
+	 */
+	organisationReference: TMongoId;
+	/**
+	 * Time of last execution
+	 */
+	lastExecution: number;
+	/**
+	 * Last execution status of the KnowledgeConnector
+	 */
+	lastExecutionStatus: KnowledgeConnectorExecutionStatus;
+	/**
+	 * Unix-timestamp when the enKnowledgeSourcetity was created initially
+	 */
+	createdAt: number;
+	/**
+	 * Unix-timestamp when the KnowledgeSource was changed last time
+	 */
+	lastChanged: number;
+	/**
+	 * Id of the user who created the KnowledgeSource initially
+	 */
+	createdBy: TMongoId;
+	/**
+	 * Id of the user who did the last modification
+	 */
+	lastChangedBy: TMongoId;
+}
+export interface ICreateKnowledgeConnectorRestDataParams_2_0 {
+	knowledgeStoreId: string;
+}
+export interface ICreateKnowledgeConnectorRestDataBody_2_0 {
+	extension: string;
+	type: string;
+	version: string;
+	config: object;
+	name: string;
+	schedule: {
+		enabled: boolean;
+		start: number;
+		hour: number;
+		minute: number;
+		weekDays: Array<number>;
+	};
+}
+export interface ICreateKnowledgeConnectorRestData_2_0 extends ICreateKnowledgeConnectorRestDataParams_2_0, ICreateKnowledgeConnectorRestDataBody_2_0 {
+}
+export interface ICreateKnowledgeConnectorRestReturnValue_2_0 extends IKnowledgeConnector_2_0 {
+}
+export interface IIndexKnowledgeConnectorsRestDataParams_2_0 {
+	knowledgeStoreId: string;
+}
+export interface IIndexKnowledgeConnectorsRestData_2_0 extends IIndexKnowledgeConnectorsRestDataParams_2_0, IRestPagination<IKnowledgeConnector_2_0> {
+}
+export interface IIndexKnowledgeConnectorsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IKnowledgeConnector_2_0> {
+}
+export interface IReadKnowledgeConnectorRestDataParams_2_0 {
+	knowledgeStoreId: string;
+	connectorId: string;
+}
+export interface IReadKnowledgeConnectorRestData_2_0 extends IReadKnowledgeConnectorRestDataParams_2_0 {
+}
+export interface IReadKnowledgeConnectorRestReturnValue_2_0 extends IKnowledgeConnector_2_0 {
+}
+export interface IDeleteKnowledgeConnectorRestDataParams_2_0 {
+	knowledgeStoreId: string;
+	connectorId: string;
+}
+export interface IDeleteKnowledgeConnectorRestData_2_0 extends IDeleteKnowledgeConnectorRestDataParams_2_0 {
+}
+export interface IDeleteKnowledgeConnectorRestReturnValue_2_0 {
+}
+export interface IUpdateKnowledgeConnectorRestDataBody_2_0 extends Partial<Pick<IKnowledgeConnector_2_0, "version" | "name" | "config" | "schedule">> {
+}
+export interface IUpdateKnowledgeConnectorRestDataParams_2_0 {
+	knowledgeStoreId: string;
+	connectorId: string;
+}
+export interface IUpdateKnowledgeConnectorRestData_2_0 extends IUpdateKnowledgeConnectorRestDataBody_2_0, IUpdateKnowledgeConnectorRestDataParams_2_0 {
+}
+export interface IUpdateKnowledgeConnectorRestReturnValue_2_0 {
+}
 /**
  * @openapi
  *
@@ -19415,6 +19854,11 @@ export interface ResourcesAPIGroup_2_0 {
 	readKnowledgeChunk: TRestAPIOperation<IReadKnowledgeChunkRestData_2_0, IReadKnowledgeChunkRestReturnValue_2_0>;
 	deleteKnowledgeChunk: TRestAPIOperation<IDeleteKnowledgeChunkRestData_2_0, IDeleteKnowledgeChunkRestReturnValue_2_0>;
 	updateKnowledgeChunk: TRestAPIOperation<IUpdateKnowledgeChunkRestData_2_0, IUpdateKnowledgeChunkRestReturnValue_2_0>;
+	indexKnowledgeConnectors: TRestAPIOperation<IIndexKnowledgeConnectorsRestData_2_0, IIndexKnowledgeConnectorsRestReturnValue_2_0>;
+	createKnowledgeConnector: TRestAPIOperation<ICreateKnowledgeConnectorRestData_2_0, ICreateKnowledgeConnectorRestReturnValue_2_0>;
+	readKnowledgeConnector: TRestAPIOperation<IReadKnowledgeConnectorRestData_2_0, IReadKnowledgeConnectorRestReturnValue_2_0>;
+	updateKnowledgeConnector: TRestAPIOperation<IUpdateKnowledgeConnectorRestData_2_0, IUpdateKnowledgeConnectorRestReturnValue_2_0>;
+	deleteKnowledgeConnector: TRestAPIOperation<IDeleteKnowledgeConnectorRestData_2_0, IDeleteKnowledgeConnectorRestReturnValue_2_0>;
 	uploadResumable: TTusAPIOperation<IUploadResumableRestData_2_0, IUploadResumableRestReturnValue_2_0>;
 	generateNluScores: TRestAPIOperation<IGenerateNluScoresRestData_2_0, IGenerateNluScoresRestReturnValue_2_0>;
 	generateDesignTimeLLMOutput: TRestAPIOperation<IGenerateDesignTimeLLMOutputRestData_2_0, IGenerateDesignTimeLLMOutputRestReturnValue_2_0>;
@@ -21475,7 +21919,8 @@ declare const actionTypes: readonly [
 	"loginSucceeded",
 	"loginFailed",
 	"loginError",
-	"unauthorized"
+	"unauthorized",
+	"disableCreditCardRedaction"
 ];
 export declare type TActionType = typeof actionTypes[number];
 /**
@@ -22442,6 +22887,9 @@ export interface ISetupVoiceGatewayRestData_2_0 extends ISetupVoiceGatewayRestDa
  *         businessUnitId:
  *           type: string
  *           description: The business unit ID
+ *         tenantId:
+ *           type: string
+ *           description: The tenant ID
  *     IOrganisation_2_0:
  *       allOf:
  *         - $ref: '#/components/schemas/IOrganisationData_2_0'
@@ -22465,6 +22913,8 @@ export interface IOrganisation_2_0 {
 	name: string;
 	/** The business unit ID */
 	businessUnitId?: string;
+	/** The tenant ID */
+	tenantId?: string;
 	/** Flag whether this organisation is currently disabled */
 	disabled: boolean;
 	/** Optional quota information */
@@ -22565,6 +23015,9 @@ export interface IOrganisationDataPrivacySettings_2_0 {
  *         businessUnitId:
  *           type: string
  *           description: The business unit ID
+ *         tenantId:
+ *           type: string
+ *           description: The tenant ID
  *         name:
  *           type: string
  *           description: The name of this organisation
@@ -22605,6 +23058,8 @@ export interface IOrganisationIndexItem_2_0 {
 	name: string;
 	/** The business unit ID */
 	businessUnitId?: string;
+	/** The tenant ID */
+	tenantId?: string;
 	/** Flag whether this organisation is currently disabled */
 	disabled: boolean;
 	/** Optional quota information */
@@ -23454,6 +23909,8 @@ export interface IProjectMetadataRest_2_0 {
 }
 export interface ISimulationRest_2_0 extends IProjectMetadataRest_2_0 {
 	id: string;
+	_id: string;
+	referenceId: string;
 	name: string;
 	persona: string;
 	personaName: string;
@@ -23461,13 +23918,17 @@ export interface ISimulationRest_2_0 extends IProjectMetadataRest_2_0 {
 	successCriteria: ISuccessCriteriaRest_2_0[];
 	maxTurns?: number;
 	timeout?: number;
+	aiAgentReferenceId?: string;
+	aiAgentId?: string;
+	flowReferenceId?: string;
+	flowId?: string;
+	jobNodeId?: string;
 	createdAt?: number;
 	createdBy: string;
 	updatedAt?: number;
 	updatedBy: string;
 	lastChanged: number;
 	lastChangedBy?: string;
-	expiresAt?: Date;
 }
 export interface IIndexSimulationsRestDataQuery_2_0 {
 	projectId?: string;
@@ -23555,6 +24016,7 @@ export interface IScheduleSimulationRestDataBody_2_0 {
 		userId?: string;
 		finalPing?: number;
 		data?: Record<string, unknown>;
+		enableMocking?: boolean;
 	};
 	projectReference: string;
 	numberOfExecutions: number;
@@ -23608,6 +24070,72 @@ declare enum ESentimentTypeRest_2_0 {
 	NEUTRAL = "NEUTRAL",
 	NEGATIVE = "NEGATIVE"
 }
+declare enum ESimulationStatusRest_2_0 {
+	SUCCESS = "success",
+	FAILED = "failed",
+	ERROR = "error"
+}
+declare enum ESimulationErrorCategoryRest_2_0 {
+	NONE = "none",
+	AI_AGENT_TIMEOUT = "ai_agent_timeout",
+	LLM_PROVIDER_ERROR = "llm_provider_error",
+	AI_AGENT_ERROR = "ai_agent_error",
+	UNKNOWN = "unknown"
+}
+export interface ISimulationErrorInfoRest_2_0 {
+	category: ESimulationErrorCategoryRest_2_0;
+	message?: string;
+	technicalDetails?: string;
+}
+/**
+ * Token usage for a specific purpose (user message generation, success criteria evaluation, etc.)
+ */
+export interface ITokenUsageByPurposeItemRest_2_0 {
+	inputTokens: number;
+	outputTokens: number;
+	totalTokens: number;
+}
+/**
+ * Token usage breakdown by purpose/category
+ */
+export interface ITokensByPurposeRest_2_0 {
+	/** Tokens used for generating user messages during conversation */
+	userMessageGeneration: ITokenUsageByPurposeItemRest_2_0;
+	/** Tokens used for evaluating success criteria */
+	successCriteriaEvaluation: ITokenUsageByPurposeItemRest_2_0;
+	/** Tokens used for sentiment analysis */
+	sentimentAnalysis: ITokenUsageByPurposeItemRest_2_0;
+}
+export interface ITokenUsageRest_2_0 {
+	inputTokens: number;
+	outputTokens: number;
+	totalTokens: number;
+	calculationMethod: "api" | "estimate";
+	llmReferenceId: string;
+	/** Human-readable name of the LLM (e.g., "Production GPT-4") */
+	llmName: string;
+	/** LLM provider (e.g., "openAI", "anthropic", "azureOpenAI") */
+	llmProvider: string;
+	/** LLM model type (e.g., "gpt-4", "claude-3") */
+	llmModelType: string;
+	/** Human-readable name of the simulation */
+	simulationName: string;
+	turnsWithTokenUsage: number;
+	averageTokensPerTurn: number;
+	/** Detailed breakdown of token usage by purpose (user message generation, success criteria, sentiment analysis) */
+	tokensByPurpose?: ITokensByPurposeRest_2_0;
+}
+export interface ISuccessRateRest_2_0 {
+	percentage: number;
+	fraction: string;
+	achieved: number;
+	total: number;
+}
+export interface ISuccessCriterionResultRest_2_0 {
+	criterion: ISuccessCriteriaRest_2_0;
+	achieved: boolean;
+	reason: string;
+}
 export interface ISimulationRunRest_2_0 {
 	id: string;
 	organisationReference: string;
@@ -23616,15 +24144,22 @@ export interface ISimulationRunRest_2_0 {
 	simulationRunBatchReference: string;
 	sequence: number;
 	largeLanguageModelReferenceId: string;
+	endPointType?: string;
 	turns: ITurnRest_2_0[];
 	totalTurns: number;
+	maxTurns?: number;
 	successCriteria: ISuccessCriteriaRest_2_0[];
 	metrics: {
 		sentiment: ESentimentTypeRest_2_0;
-		outOfScope: string;
-		efficiency: number;
-		topic: string;
 		success: boolean;
+		results?: ISuccessCriterionResultRest_2_0[];
+		successRate?: ISuccessRateRest_2_0;
+		summary?: string;
+		isBatchStopped?: boolean;
+		isConversationEnded?: boolean;
+		errorInfo?: ISimulationErrorInfoRest_2_0;
+		status?: ESimulationStatusRest_2_0;
+		tokenUsage?: ITokenUsageRest_2_0;
 	};
 	createdAt: number;
 	createdBy: string;
@@ -23640,30 +24175,105 @@ export declare type TSimulationRunBatchStatusRest_2_0 = typeof SimulationRunBatc
 export interface IBatchSuccessCriteriaOverview_2_0 extends ISuccessCriteriaRest_2_0 {
 	percentage: number;
 }
+export interface IEfficiencyScoreRest_2_0 {
+	label: string;
+	start: number;
+	end: number;
+	counter: number;
+}
+export interface IAverageSuccessRateForRunsRest_2_0 {
+	percentage: number;
+	fraction: string;
+	achieved: number;
+	total: number;
+	average: number;
+}
+/**
+ * Token usage breakdown for a specific purpose
+ */
+export interface ITokenUsageByPurposeRest_2_0 {
+	inputTokens: number;
+	outputTokens: number;
+	totalTokens: number;
+}
+/**
+ * Aggregated token usage breakdown by purpose for batch
+ */
+export interface IBatchTokensByPurposeRest_2_0 {
+	/** Tokens used for generating user messages during conversation */
+	userMessageGeneration: ITokenUsageByPurposeRest_2_0;
+	/** Tokens used for evaluating success criteria */
+	successCriteriaEvaluation: ITokenUsageByPurposeRest_2_0;
+	/** Tokens used for sentiment analysis */
+	sentimentAnalysis: ITokenUsageByPurposeRest_2_0;
+}
+export interface IBatchTokenUsageRest_2_0 {
+	totalInputTokens: number;
+	totalOutputTokens: number;
+	totalTokens: number;
+	averageInputTokensPerRun: number;
+	averageOutputTokensPerRun: number;
+	averageTokensPerRun: number;
+	averageTokensPerTurn: number;
+	runsWithTokenUsage: number;
+	calculationMethod: "api" | "estimate" | "mixed";
+	llmReferenceId: string;
+	/** Human-readable name of the LLM (e.g., "Production GPT-4") */
+	llmName: string;
+	/** LLM provider (e.g., "openAI", "anthropic", "azureOpenAI") */
+	llmProvider: string;
+	/** LLM model type (e.g., "gpt-4", "claude-3") */
+	llmModelType: string;
+	/** Human-readable name of the simulation */
+	simulationName: string;
+	/** Detailed breakdown of token usage by purpose (aggregated across all runs) */
+	tokensByPurpose?: IBatchTokensByPurposeRest_2_0;
+}
+export interface IBatchMetricsRest_2_0 {
+	_v: number;
+	efficiencyScore?: IEfficiencyScoreRest_2_0[];
+	turnsDistribution?: IEfficiencyScoreRest_2_0[];
+	successRate?: number;
+	averageSuccessRateForRuns?: IAverageSuccessRateForRunsRest_2_0;
+	successCriterias?: IBatchSuccessCriteriaOverview_2_0[];
+	averageTurns?: number;
+	averageSentiment?: string;
+	runResults?: {
+		succeeded: number;
+		failed: number;
+		notExecuted?: number;
+	};
+	tokenUsage?: IBatchTokenUsageRest_2_0;
+}
 export interface ISimulationRunBatchRest_2_0 {
 	id: string;
+	_id: string;
 	name: string;
 	status: TSimulationRunBatchStatusRest_2_0;
 	numberOfExecutions: number;
-	successRate?: number;
-	efficiency?: number;
 	simulationReference: string;
 	projectReference: string;
 	organisationReference: string;
+	endPointType?: string;
 	runConfig: {
 		flowReferenceId: string;
 		localeReferenceId?: string;
 		entrypoint: string;
+		largeLanguageModelReferenceId: string;
+		userId?: string;
+		finalPing?: number;
+	};
+	simulationFrozen: {
+		persona: string;
+		personaName: string;
+		mission: string;
 	};
 	createdAt: number;
 	createdBy: string;
-	largeLanguageModelReferenceId: string;
 	updatedAt?: number;
 	completedAt?: number;
 	expiresAt?: Date;
-	batchMetrics?: {
-		results?: IBatchSuccessCriteriaOverview_2_0[];
-	};
+	batchMetrics?: IBatchMetricsRest_2_0;
 }
 export interface IIndexSimulationRunBatchesRestDataQuery_2_0 {
 	projectId: string;
@@ -24023,6 +24633,91 @@ export interface IStopSimulationRunBatchRestData_2_0 extends IStopSimulationRunB
 export interface IStopSimulationRunBatchRestReturnValue_2_0 {
 	simulationRunBatchId: ISimulationRunBatchRest_2_0;
 }
+declare enum ESchedulerFrequencyRest_2_0 {
+	DAILY = "daily",
+	EVERY_THREE_DAYS = "every three days",
+	WEEKLY = "weekly",
+	BIWEEKLY = "biweekly",
+	MONTHLY = "monthly"
+}
+export interface ISchedulerRunConfigRest_2_0 {
+	flowReferenceId: string;
+	localeReferenceId?: string;
+	entrypoint: string;
+	largeLanguageModelReferenceId: string;
+	userId?: string;
+	finalPing?: number;
+	data?: Record<string, unknown>;
+	enableMocking?: boolean;
+}
+export interface ISchedulerRest_2_0 extends IProjectMetadataRest_2_0 {
+	id: string;
+	runConfig: ISchedulerRunConfigRest_2_0;
+	enableSchedule: boolean;
+	frequency: ESchedulerFrequencyRest_2_0;
+	time: string;
+	numberOfRuns: number;
+	nextScheduledRun: string;
+	emailNotifications: string[];
+	scenarioName: string;
+	runName: string;
+	simulationReference: string;
+	endDate?: string;
+	createdAt: number;
+	lastChanged: number;
+	createdBy: string;
+	lastChangedBy: string;
+}
+export interface ICreateSchedulerRestDataParams_2_0 {
+	simulationReference: string;
+}
+export interface ICreateSchedulerRestDataBody_2_0 {
+	runConfig: ISchedulerRunConfigRest_2_0;
+	enableSchedule: boolean;
+	frequency: ESchedulerFrequencyRest_2_0;
+	time: string;
+	numberOfRuns: number;
+	emailNotifications?: string[];
+	scenarioName?: string;
+	runName: string;
+	endDate?: string;
+}
+export interface ICreateSchedulerRestData_2_0 extends ICreateSchedulerRestDataParams_2_0, ICreateSchedulerRestDataBody_2_0 {
+}
+export interface ICreateSchedulerRestReturnValue_2_0 {
+	scheduler: ISchedulerRest_2_0;
+}
+export interface IUpdateSchedulerRestDataParams_2_0 {
+	simulationReference: string;
+	schedulerId: string;
+}
+export interface IUpdateSchedulerRestDataBody_2_0 {
+	runConfig?: ISchedulerRunConfigRest_2_0;
+	enableSchedule?: boolean;
+	frequency?: ESchedulerFrequencyRest_2_0;
+	time?: string;
+	numberOfRuns?: number;
+	nextScheduledRun?: string;
+	emailNotifications?: string[];
+	scenarioName?: string;
+	runName?: string;
+	endDate?: string;
+}
+export interface IUpdateSchedulerRestData_2_0 extends IUpdateSchedulerRestDataParams_2_0, IUpdateSchedulerRestDataBody_2_0 {
+	projectId?: string;
+}
+export interface IUpdateSchedulerRestReturnValue_2_0 {
+	scheduler: ISchedulerRest_2_0;
+}
+export interface IGetSchedulerRestDataParams_2_0 {
+	simulationReference: string;
+}
+export interface IGetSchedulerRestData_2_0 extends IGetSchedulerRestDataParams_2_0 {
+	projectId?: string;
+}
+export interface IGetSchedulerRestReturnValue_2_0 {
+	scheduler: ISchedulerRest_2_0 | null;
+}
 export interface SimulationAPIGroup_2_0 {
 	indexSimulations: TRestAPIOperation<IIndexSimulationsRestData_2_0, IIndexSimulationsRestReturnValue_2_0>;
 	createSimulation: TRestAPIOperation<ICreateSimulationRestData_2_0, ICreateSimulationRestReturnValue_2_0>;
@@ -24042,6 +24737,9 @@ export interface SimulationAPIGroup_2_0 {
 	regeneratePersonaField: TRestAPIOperation<IRegeneratePersonaFieldRestData_2_0, IRegeneratePersonaFieldRestReturnValue_2_0>;
 	generateBulkPersona: TRestAPIOperation<IGenerateBulkPersonaRestData_2_0, IGenerateBulkPersonaRestReturnValue_2_0>;
 	generatePersonaFromTranscript: TRestAPIOperation<IGeneratePersonaFromTranscriptRestData_2_0, IGeneratePersonaFromTranscriptRestReturnValue_2_0>;
+	getScheduler: TRestAPIOperation<IGetSchedulerRestData_2_0, IGetSchedulerRestReturnValue_2_0>;
+	createScheduler: TRestAPIOperation<ICreateSchedulerRestData_2_0, ICreateSchedulerRestReturnValue_2_0>;
+	updateScheduler: TRestAPIOperation<IUpdateSchedulerRestData_2_0, IUpdateSchedulerRestReturnValue_2_0>;
 }
 declare function SimulationAPIGroup_2_0(instance: Base): SimulationAPIGroup_2_0;
 export declare type TRestAPIGroupsTypeByConfiguration<T extends IRestAPIClientConfig> = TResourceAPIVersionType<T> & TJWTAuthAPIVersionType<T> & TInsightsAPIVersionType<T> & TMetricsAPIVersionType<T> & TSessionAPIVersionType<T> & TExternalAPIVersionType<T> & TAdministrationAPIVersionType<T> & TManagementAPIVersionType<T> & TAnalyticsAPIVersionType<T> & TAIOpsCenterAPIVersionType<T> & TSimulationAPIVersionType<T>;