@cognigy/rest-api-client 2025.12.0 → 2025.13.0

package/types/index.d.ts

@@ -464,7 +464,8 @@ declare const projectWidePermissions: readonly [
 	"tasks",
 	"tokens",
 	"yesNoIntents",
-	"dataPrivacySettings"
+	"dataPrivacySettings",
+	"simulator"
 ];
 export declare type TProjectWidePermissions = typeof projectWidePermissions[number];
 export declare type TMongoId = string;
@@ -1053,7 +1054,8 @@ declare const projectWideRoles: readonly [
 	"tokenEditor",
 	"data_privacy_admin",
 	"data_privacy_editor",
-	"data_privacy_viewer"
+	"data_privacy_viewer",
+	"simulator_admin"
 ];
 export declare type TProjectWideRole = typeof projectWideRoles[number];
 /**
@@ -1253,6 +1255,8 @@ export interface IOrganisationWideAcl {
  *               $ref: '#/components/schemas/ICrudPermissions'
  *             users:
  *               $ref: '#/components/schemas/ICrudPermissions'
+ *             simulator:
+ *               $ref: '#/components/schemas/ICrudPermissions'
  *           additionalProperties:
  *             $ref: '#/components/schemas/ICrudPermissions'
  *         roles:
@@ -4348,6 +4352,9 @@ declare const generativeAIModels: readonly [
 	"gpt-4",
 	"gpt-4o",
 	"gpt-4o-mini",
+	"gpt-4.1",
+	"gpt-4.1-mini",
+	"gpt-4.1-nano",
 	"luminous-extended-control",
 	"claude-v1-100k",
 	"claude-instant-v1",
@@ -4355,6 +4362,11 @@ declare const generativeAIModels: readonly [
 	"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",
 	"gemini-1.0-pro",
@@ -4366,11 +4378,14 @@ declare const generativeAIModels: readonly [
 	"amazon.nova-pro-v1:0",
 	"amazon.nova-micro-v1:0",
 	"anthropic.claude-3-5-sonnet-20240620-v1:0",
-	"claude-3-7-sonnet-20250219",
 	"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-embedding-3-small",
 	"text-embedding-3-large",
 	"text-embedding-ada-002",
@@ -4462,6 +4477,13 @@ declare const modeType: readonly [
 	"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;
@@ -5307,6 +5329,7 @@ export interface IAudioPreviewSettings_2_0 {
  *         - mistral
  */
 export declare type TGenerativeAIProviders_2_0 = TGenerativeAIProviders;
+export declare type TConfigurableGenerativeAIUseCases = Exclude<TGenerativeAIUseCases, "intentSentenceGeneration" | "flowGeneration" | "generateNodeOutput" | "lexiconGeneration">;
 /**
  * @openapi
  *
@@ -5322,27 +5345,19 @@ export declare type TGenerativeAIProviders_2_0 = TGenerativeAIProviders;
  *           properties:
  *             designTimeGeneration:
  *               $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
- *             intentSentenceGeneration:
- *               $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
  *             aiEnhancedOutputs:
  *               $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
- *             lexiconGeneration:
- *               $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
- *             flowGeneration:
- *               $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
  *             gptConversation:
  *               $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
  *             gptPromptNode:
  *               $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
- *             generateNodeOutput:
- *               $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
  *             knowledgeSearch:
  *               $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
  */
 export interface IGenerativeAISettings_2_0 {
 	enabled: boolean;
 	useCasesSettings: {
-		[key in TGenerativeAIUseCases]: IGenerativeAIUseCaseSettings;
+		[key in TConfigurableGenerativeAIUseCases]: IGenerativeAIUseCaseSettings;
 	};
 }
 /**
@@ -9030,7 +9045,8 @@ declare const arrayTDebugEventTypes: readonly [
 	"switchedFlow",
 	"nluWarning",
 	"debugMessage",
-	"debugError"
+	"debugError",
+	"goalCompleted"
 ];
 export declare type TDebugEventType = typeof arrayTDebugEventTypes[number];
 export interface IInputChangedEventPayload {
@@ -9127,7 +9143,28 @@ export interface IDebugEventJsonMessagePayload extends IDebugEventMessagePayload
 	message: object;
 }
 export declare type TDebugEventMessagePayload = IDebugEventTextMessagePayload | IDebugEventJsonMessagePayload;
-export declare type TDebugEventPayload = IInputChangedEventPayload | IContextChangedEventPayload | IActiveEntrypointsChangedEventPayload | IProfileChangedEventPayload | INodeExecutedEventPayload | INodeErrorEventPayload | IFinalPingEventPayload | IOutputEventPayload | ISwitchedFlowEventPayload | INluWarningEventPayload | TDebugEventMessagePayload;
+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",
@@ -9586,6 +9623,15 @@ export interface IGraphAiAgent {
 	properties: Pick<IAiAgent, "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy" | "knowledgeReferenceId">;
 	dependencies?: IAiAgentDependencies[];
 }
+export interface ILoadAiAgentNodeParams extends INodeFunctionBaseParams {
+	config: {
+		aiAgent: IAiAgent;
+		storeLocation: string;
+		contextKey: string;
+		inputKey: string;
+		keyWarning: string;
+	};
+}
 export interface ISendTileUpdateParams extends INodeFunctionBaseParams {
 	tile: any;
 }
@@ -10477,23 +10523,6 @@ export interface IGenerativeSlotFillerParams extends INodeFunctionBaseParams {
 		timeout: number;
 	};
 }
-export interface IGoalAnalyticsPayload {
-	analyticsdata: IGoalEscalations;
-	data: IPayloadBaseMetaData;
-}
-export interface IGoalAnalyticsData {
-	projectId: string;
-	organisationId: string;
-	sessionId: string;
-	version: string;
-	timestamp: Date;
-	goalCycleId: string;
-	stepId: string;
-	goalId: string;
-	contactId: string;
-}
-export interface IGoalEscalations extends IGoalAnalyticsData, IAnalyticsEndpointMeta, IAnalyticsLocaleMeta, IAnalyticsSnapshotMeta {
-}
 export interface IEndpointSettings {
 	isFeatureAccmEnabled?: boolean;
 }
@@ -10692,7 +10721,6 @@ export interface IActions {
 	getAgentAssistConfigId: () => string;
 	getNluEmbeddingCredentials: () => Promise<INluEmbeddingCredentials>;
 	getMetadata: () => IGetMetaDataActionValue;
-	sendTrackGoal: (payload: IGoalAnalyticsPayload) => Promise<void>;
 	getEndpointSettings: () => IEndpointSettings;
 	getTranscript: (options: TReadTranscriptOptions) => Promise<TTranscriptEntry[]>;
 	addTranscriptStep: (content: TTranscriptEntryContent) => Promise<void>;
@@ -11354,6 +11382,7 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
 	}) => Promise<{
 		[x: string]: unknown;
 	}>;
+	sendTrackGoal: (payload: IGoalAnalyticsPayload) => Promise<void>;
 }
 export interface INodeExecutionCognigyObject extends IExecutionObjects {
 	api: INodeExecutionAPI;
@@ -16006,13 +16035,6 @@ export interface IComposePackageDownloadLinkRestData_2_0 extends IComposePackage
 export interface IComposePackageDownloadLinkRestReturnValue_2_0 {
 	downloadLink: string;
 }
-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 ICreateChartNodeBasicNodesData<T extends string = string, D extends INodeFunctionBaseParams = any, E extends string = string> extends Partial<Omit<IChartNode<T, D, E>, TReferenceAndEntityMetaKeys | "type" | "extension">> {
 	type: T;
 	extension?: E;
@@ -16358,6 +16380,7 @@ export interface ITrackGoalNodeParams extends INodeFunctionBaseParams {
 		goal: {
 			goalId: string;
 			name: string;
+			referenceId: string;
 			version: string;
 			selectedSteps: {
 				stepId: string;
@@ -16835,6 +16858,7 @@ export interface ICognigyBasicNodes {
 	sendMetadata: ICreateChartNodeBasicNodesData<"sendMetadata", ISendMetadataParams, TBASIC_EXTENSION>;
 	assistInfo: ICreateChartNodeBasicNodesData<"assistInfo", IAssistInfoNodeParams, TBASIC_EXTENSION>;
 	searchExtractOutput: ICreateChartNodeBasicNodesData<"searchExtractOutput", ISearchExtractOutputNodeParams, TBASIC_EXTENSION>;
+	extractAiAgent: ICreateChartNodeBasicNodesData<"extractAiAgent", ILoadAiAgentNodeParams, TBASIC_EXTENSION>;
 }
 export interface ICognigyNodes {
 	"@cognigy/basic-nodes": ICognigyBasicNodes;
@@ -18443,6 +18467,22 @@ export interface IGenerateNluScoresRestData_2_0 extends IGenerateNluScoresRestDa
 }
 export interface IGenerateNluScoresRestReturnValue_2_0 {
 }
+export interface IGenerateDesignTimeLLMOutputRestDataBody_2_0 {
+	useCase: string;
+	params?: Record<string, string>;
+	messages?: {
+		role: "user" | "assistant";
+		content: string;
+	}[];
+}
+export interface IGenerateDesignTimeLLMOutputRestDataParams_2_0 {
+	projectId: string;
+}
+export interface IGenerateDesignTimeLLMOutputRestData_2_0 extends IGenerateDesignTimeLLMOutputRestDataBody_2_0, IGenerateDesignTimeLLMOutputRestDataParams_2_0 {
+}
+export interface IGenerateDesignTimeLLMOutputRestReturnValue_2_0 {
+	output: string;
+}
 /**
  * @openapi
  *
@@ -18914,6 +18954,7 @@ export interface ResourcesAPIGroup_2_0 {
 	updateKnowledgeChunk: TRestAPIOperation<IUpdateKnowledgeChunkRestData_2_0, IUpdateKnowledgeChunkRestReturnValue_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>;
 }
 declare const ResourcesAPIGroup_2_0: (instance: Base) => ResourcesAPIGroup_2_0;
 /**
@@ -22770,7 +22811,7 @@ export interface ISimulationRest_2_0 extends IProjectMetadataRest_2_0 {
 }
 export interface IIndexSimulationsRestDataQuery_2_0 {
 	projectId?: string;
-	filter?: number;
+	filter?: string;
 	limit?: number;
 	skip?: number;
 	sort?: string;
@@ -22904,7 +22945,7 @@ export interface IIndexSimulationRunBatchesRestReturnValue_2_0 {
 }
 export interface IGetAllSimulationRunBatchesRestDataQuery_2_0 {
 	projectId: string;
-	filter?: number;
+	filter?: string;
 	limit?: number;
 	skip?: number;
 	sort?: string;
@@ -22975,7 +23016,7 @@ export interface ISimulationRunRest_2_0 {
 }
 export interface IIndexSimulationRunsRestDataQuery_2_0 {
 	projectId: string;
-	filter?: number;
+	filter?: string;
 	limit?: number;
 	skip?: number;
 	sort?: string;