@cognigy/rest-api-client 2026.1.0 → 2026.3.0

package/types/index.d.ts

@@ -983,7 +983,9 @@ declare const arrayTResourceType: readonly [
 	"snapshot",
 	"snippet",
 	"aiAgent",
-	"simulation"
+	"simulation",
+	"scheduler",
+	"personaGeneration"
 ];
 export declare type TResourceType = (typeof arrayTResourceType)[number];
 declare const arrayTChartableResourceType: readonly [
@@ -2857,7 +2859,8 @@ declare const generativeAIModels: readonly [
 	"text-embedding-ada-002",
 	"luminous-embedding-128",
 	"amazon.titan-embed-text-v2:0",
-	"Pharia-1-Embedding-4608"
+	"Pharia-1-Embedding-4608",
+	"gemini-embedding-001"
 ];
 /**
  * @openapi
@@ -2883,6 +2886,7 @@ declare const generativeAIModels: readonly [
  *         - luminous-extended-control
  *         - luminous-embedding-128
  *         - Pharia-1-Embedding-4608
+ *         - gemini-embedding-001
  *         - claude-3-opus-20240229
  *         - custom-model
  *         - custom-embedding-model
@@ -2963,7 +2967,8 @@ declare const audioPreviewProviders: readonly [
 	"microsoft",
 	"google",
 	"aws",
-	"deepgram"
+	"deepgram",
+	"elevenlabs"
 ];
 export declare type TAudioPreviewProvider = typeof audioPreviewProviders[number];
 /**
@@ -3104,9 +3109,11 @@ export interface IVoiceGateway2RecognizerParams {
 	asrTimeout?: number;
 	nuanceOptions?: TVoiceGateway2NuanceOptions;
 	deepgramOptions?: TVoiceGateway2DeepgramOptions;
+	deepgramfluxOptions?: TVoiceGateway2DeepgramfluxOptions;
 	ibmOptions?: TVoiceGateway2IbmOptions;
 	nvidiaOptions?: TVoiceGateway2NvidiaOptions;
 	sonioxOptions?: TVoiceGateway2SonioxOptions;
+	speechmaticsOptions?: TVoiceGateway2SpeechmaticsOptions;
 	openaiOptions?: TVoiceGateway2OpenaiOptions;
 	model?: string;
 }
@@ -3166,6 +3173,53 @@ export declare type TVoiceGateway2DeepgramOptions = {
 	vadTurnoff?: number;
 	tag?: string;
 };
+export declare type TVoiceGateway2DeepgramfluxOptions = {
+	apiKey?: string;
+	keywords?: string[];
+	endpointing?: number | boolean;
+	endOfTurnThreshold?: number;
+	endOfTurnTimeoutMs?: number;
+};
+export declare type TVoiceGateway2SpeechmaticsOptions = {
+	transcription_config?: {
+		language?: string;
+		additional_vocab?: string[];
+		diarization?: string;
+		speaker_diarization_config?: {
+			speaker_sensitivity?: number;
+			max_speakers?: number;
+		};
+		enable_partials?: boolean;
+		max_delay?: number;
+		max_delay_mode?: "fixed" | "flexible";
+		output_locale?: string;
+		punctuation_overrides?: {
+			permitted_marks?: string[];
+			sensitivity?: number;
+		};
+		operating_point?: string;
+		enable_entities?: boolean;
+		audio_filtering_config?: {
+			volume_threshold: number;
+		};
+		transcript_filtering_config?: {
+			remove_disfluencies: boolean;
+		};
+	};
+	translation_config?: {
+		target_languages: string[];
+		enable_partials?: boolean;
+	};
+	audio_events_config?: {
+		types?: string[];
+	};
+	endpointing?: number;
+};
+export declare type TVoiceGateway2OpenaiOptions = {
+	model?: string;
+	apiKey?: string;
+	endpointing?: number;
+};
 export declare type TVoiceGateway2NvidiaOptions = {
 	rivaUri?: string;
 	maxAlternatives?: number;
@@ -3184,10 +3238,6 @@ export declare type TVoiceGateway2SonioxOptions = {
 	metadata?: object;
 	storage?: object;
 };
-export declare type TVoiceGateway2OpenaiOptions = {
-	model?: string;
-	apiKey?: string;
-};
 export declare type TVoiceGateway2IbmOptions = {
 	sttApiKey?: string;
 	sttRegion?: string;
@@ -3427,6 +3477,9 @@ export interface ICallEventFailoverSettings {
 	deepgramEndpointing?: boolean;
 	deepgramEndpointingValue?: number;
 	dialTranscribeDeepgramTier?: string;
+	deepgramfluxEndpointing?: boolean;
+	deepgramfluxEndOfTurnThreshold?: number;
+	deepgramfluxEndOfTurnTimeoutMs?: number;
 	mediaPath?: TVoiceGateway2MediaPath;
 	anchorMedia?: boolean;
 }
@@ -9519,8 +9572,8 @@ export interface IOutputEventPayload {
 	disableSensitiveLogging?: boolean;
 }
 export interface IOutputEventMetadata {
-	flowReferenceId: string;
-	outputType: "node" | "intent";
+	flowReferenceId?: string;
+	outputType?: "node" | "intent";
 	nodeLabel?: string;
 	nodeType?: string;
 	nodeId?: string;
@@ -9528,6 +9581,7 @@ export interface IOutputEventMetadata {
 	intentId?: string;
 	intentReferenceId?: string;
 	intent?: string;
+	isMockedCodeExecution?: boolean;
 }
 export interface ISwitchedFlowEventPayload {
 	fromFlowId: string;
@@ -9766,6 +9820,13 @@ export interface ILoadAiAgentNodeParams extends INodeFunctionBaseParams {
 		keyWarning: string;
 	};
 }
+export interface IAiAgentV2TurnReply {
+	response?: string;
+	toolCalls?: Array<{
+		arguments?: Record<string, any>;
+		name?: string;
+	}>;
+}
 export interface ISendTileUpdateParams extends INodeFunctionBaseParams {
 	tile: any;
 }
@@ -9910,6 +9971,10 @@ export interface IQuestionNodeSharedConfig extends INodeWithAiRephraseConfig {
 	escalateAnswersSendOnQueueEvent: boolean;
 	escalateAnswersSendOnActiveEvent: boolean;
 	escalateIntentsAction: "none" | "goto" | "execute" | "skip" | "text" | "handover";
+	escalateIntentsHandoverProvider: THandoverProvider | "legacyEndpoint" | null;
+	escalateIntentsHandoverProviderConfig: Record<string, any>;
+	escalateAnswersHandoverProvider: THandoverProvider | "legacyEndpoint" | null;
+	escalateAnswersHandoverProviderConfig: Record<string, any>;
 	escalateIntentsValidIntents: string[];
 	escalateIntentsThreshold: number;
 	escalateIntentsGotoTarget: string;
@@ -10206,6 +10271,13 @@ export interface ISessionStateWithoutMeta {
 		mcpToolNode?: string;
 		mcpHeaders?: Record<string, string>;
 		timeout?: number;
+		authType?: "none" | "oAuth2";
+		oAuth2Connection?: {
+			oAuth2Url: string;
+			oAuth2ClientId: string;
+			oAuth2ClientSecret: string;
+			oAuth2Scope?: string;
+		};
 	};
 	tokenUsage?: TSessionUsageInformation;
 }
@@ -10524,6 +10596,14 @@ export interface IAzureOpenAIProviderOauth2Fields {
 	additionalHeaderName?: string;
 	additionalHeaderValue?: string;
 }
+export interface IGoogleVertexAIProviderFields {
+	googleCredentialsFileName: string;
+	credentialsStringified: string;
+	fileToken: string;
+	clientEmail: string;
+	privateKey: string;
+	projectId: string;
+}
 export interface IAlephAlphaProviderFields {
 	token: string;
 }
@@ -10569,7 +10649,7 @@ export interface ILLMProviderMeta extends IAzureOpenAIMeta {
 }
 export interface ISearchLLMCredentials {
 	provider: TGenerativeAIProviders;
-	connectionFields: IAzureOpenAIProviderFieldsV2 | IProviderOauth2Fields | IAwsBedrockProviderFields | IAwsBedrockIamProviderFields | IAlephAlphaProviderFields;
+	connectionFields: IAzureOpenAIProviderFieldsV2 | IProviderOauth2Fields | IAwsBedrockProviderFields | IAwsBedrockIamProviderFields | IAlephAlphaProviderFields | IGoogleVertexAIProviderFields;
 	providerMetaData: ILLMProviderMeta;
 }
 export interface ISearchTagsData {
@@ -11278,10 +11358,24 @@ export interface IEmailServiceOAuth2ConnectionFields {
 	expiryDate?: string;
 	accessUrl?: string;
 }
+export interface IEmailServiceOAuth2ClientCredentialsConnectionFields {
+	tokenEndpointUrl: string;
+	clientId: string;
+	clientSecret: string;
+	scope?: string;
+	user: string;
+}
+export interface IEmailServiceOAuth2JwtBearerConnectionFields {
+	tokenEndpointUrl: string;
+	jwt: string;
+	user: string;
+}
 export interface ISMTPEmailConnection {
 	smtpType: "otherSmtp" | "126" | "163" | "1und1" | "AOL" | "DebugMail" | "DynectEmail" | "FastMail" | "GandiMail" | "Gmail" | "Godaddy" | "GodaddyAsia" | "GodaddyEurope" | "hot.ee" | "Hotmail" | "iCloud" | "mail.ee" | "Mail.ru" | "Maildev" | "Mailgun" | "Mailjet" | "Mailosaur" | "Mandrill" | "Naver" | "OpenMailBox" | "Outlook365" | "Postmark" | "QQ" | "QQex" | "SendCloud" | "SendGrid" | "SendinBlue" | "SendPulse" | "SES" | "SES-US-EAST-1" | "SES-US-WEST-2" | "SES-EU-WEST-1" | "Sparkpost" | "Yahoo" | "Yandex" | "Zoho" | "qiye.aliyun";
-	authType: "basic" | "oauth2";
+	authType: "basic" | "oauth2" | "oauth2_client_credentials" | "oauth2_jwt_bearer";
 	oAuth2Connection?: IEmailServiceOAuth2ConnectionFields;
+	oAuth2ClientCredentialsConnection?: IEmailServiceOAuth2ClientCredentialsConnectionFields;
+	oAuth2JwtBearerConnection?: IEmailServiceOAuth2JwtBearerConnectionFields;
 	connection: ISMTPConnectionFields;
 	serviceConnection: IEmailServiceConnectionFields;
 	organisationId?: string;
@@ -11661,6 +11755,13 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
 		timeout: number;
 		cacheTools: boolean;
 		mcpHeaders?: Record<string, string>;
+		authType?: "none" | "oAuth2";
+		oAuth2Connection?: {
+			oAuth2Url: string;
+			oAuth2ClientId: string;
+			oAuth2ClientSecret: string;
+			oAuth2Scope?: string;
+		};
 	}) => Promise<{
 		tools: any[];
 		fromCache: boolean;
@@ -11673,10 +11774,26 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
 		mcpServerUrl: string;
 		timeout: number;
 		mcpHeaders?: Record<string, string>;
+		authType?: "none" | "oAuth2";
+		oAuth2Connection?: {
+			oAuth2Url: string;
+			oAuth2ClientId: string;
+			oAuth2ClientSecret: string;
+			oAuth2Scope?: string;
+		};
 	}) => Promise<{
 		[x: string]: unknown;
 	}>;
 	sendTrackGoal: (payload: IGoalAnalyticsPayload) => Promise<void>;
+	/**
+	* POC for AI Agent V2 service
+	*/
+	sendAiAgentV2Turn: (params: {
+		agentReferenceId: string;
+		userInput: string;
+		conversationHistory: string;
+		openaiApiKey: string;
+	}) => Promise<IAiAgentV2TurnReply>;
 }
 export interface INodeExecutionCognigyObject extends IExecutionObjects {
 	api: INodeExecutionAPI;
@@ -12167,6 +12284,9 @@ export interface IKnowledgeDescriptor {
  *             extension:
  *               type: string
  *               description: The extension name that this knowledge descriptor belongs to
+ *             version:
+ *               type: string
+ *               description: The version of the extension that this knowledge descriptor belongs to
  *             extensionImg:
  *               type: string
  *               description: The image URL of the extension that this knowledge descriptor belongs to
@@ -12174,6 +12294,7 @@ export interface IKnowledgeDescriptor {
 export interface IKnowledgeDescriptorAggregatedItem extends IKnowledgeDescriptor {
 	extension: string;
 	extensionImg: string;
+	version: string;
 }
 export declare type IExtensionType = "nodes";
 export interface IExtension extends IExtensionData, IExtensionNodePackage {
@@ -12485,16 +12606,10 @@ export interface IHandoverServiceProperties {
 		value: "basic";
 	};
 }
-export interface IHandoverProviderProperties {
-	key: "basicActionTile";
-	type: "cognigyText";
-	label: "UI__NODE_EDITOR__ASSIST_INFO__ACTION_TITLE__LABEL";
-	description: "UI__NODE_EDITOR__ASSIST_INFO__ACTION_TITLE__DESCRIPTION";
-	defaultValue: "";
-	condition: {
-		key: "cardType";
-		value: "basic";
-	};
+export declare type HandoverProviderPropertyValue = string | boolean;
+export interface IHandoverProviderProperty {
+	key: string;
+	value: HandoverProviderPropertyValue;
 }
 export interface IRCEHandoverSettings {
 	/**
@@ -12690,7 +12805,7 @@ export interface IHandoverProvider {
 	lastChanged: number;
 	createdBy: TMongoId;
 	lastChangedBy: TMongoId;
-	properties: IHandoverProviderProperties[];
+	properties: IHandoverProviderProperty[];
 	settings: IHandoverProviderSettings;
 }
 export interface IGraphHandoverProvider extends IHandoverProvider {
@@ -12741,8 +12856,8 @@ export interface ISimulation extends IProjectMetadata {
 export interface IGraphSimulation extends ISimulation {
 	type: "simulation";
 }
-export declare type IGraphResourceWithReferenceId = IGraphAgentAssistConfig | IGraphConnection | IGraphFlow | IGraphFunction | IGraphLargeLanguageModel | IGraphLexicon | IGraphLocale | IGraphNLUConnector | IGraphSnippet | IGraphAgentAssistConfig | IGraphKnowledgeStore | IGraphGoal | IGraphHandoverProvider | IGraphAiAgent;
-export declare type IGraphResourceWithoutReferenceId = IGraphEndpoint | IGraphExtension | IGraphFile | IGraphPlaybook | IGraphSimulation;
+export declare type IGraphResourceWithReferenceId = IGraphAgentAssistConfig | IGraphConnection | IGraphFlow | IGraphFunction | IGraphLargeLanguageModel | IGraphLexicon | IGraphLocale | IGraphNLUConnector | IGraphSnippet | IGraphAgentAssistConfig | IGraphKnowledgeStore | IGraphGoal | IGraphHandoverProvider | IGraphAiAgent | IGraphSimulation;
+export declare type IGraphResourceWithoutReferenceId = IGraphEndpoint | IGraphExtension | IGraphFile | IGraphPlaybook;
 export declare type IGraphResource = IGraphResourceWithReferenceId | IGraphResourceWithoutReferenceId;
 /**
  * @openapi
@@ -17020,6 +17135,13 @@ export interface IVoiceConfigParams {
 	deepgramEndpointing: boolean;
 	deepgramEndpointingValue: number;
 	deepgramSmartFormatting: boolean;
+	deepgramfluxEndpointing: boolean;
+	deepgramfluxEndOfTurnThreshold: number;
+	deepgramfluxEndOfTurnTimeoutMs: number;
+	speechmaticsEndpointing: boolean;
+	speechmaticsEndpointingValue: number;
+	openaiEndpointing: boolean;
+	openaiEndpointingValue: number;
 	atmosphereAction: TVoiceGateway2DubActionType;
 	atmosphereUrl: string;
 	atmosphereLoop: boolean;
@@ -17096,6 +17218,9 @@ export interface IVoiceConfigParams {
 	deepgramEndpointing: boolean;
 	deepgramEndpointingValue: number;
 	deepgramSmartFormatting: boolean;
+	deepgramfluxEndpointing: boolean;
+	deepgramfluxEndOfTurnThreshold: number;
+	deepgramfluxEndOfTurnTimeoutMs: number;
 }
 export interface ISessionSpeechParams extends INodeFunctionBaseParams {
 	config: IVoiceConfigParams;
@@ -17515,6 +17640,13 @@ export interface ITransferNodeParams extends INodeFunctionBaseParams {
 		deepgramEndpointing: boolean;
 		deepgramEndpointingValue: number;
 		deepgramSmartFormatting: boolean;
+		deepgramfluxEndpointing: boolean;
+		deepgramfluxEndOfTurnThreshold: number;
+		deepgramfluxEndOfTurnTimeoutMs: number;
+		speechmaticsEndpointing: boolean;
+		speechmaticsEndpointingValue: number;
+		openaiEndpointing: boolean;
+		openaiEndpointingValue: number;
 		amdEnabled: boolean;
 		amdRedirectOnMachineDetected: boolean;
 		amdRedirectText: string;
@@ -18136,7 +18268,7 @@ export interface IGoogleGeminiMeta_2_0 {
  *           properties:
  *             customModel:
  *               type: string
- *               example: claude-3-opus-20240229
+ *               example: claude-opus-4-0
  *               description: The custom model name. This does not work with embedding models
  *         azureOpenAI:
  *           type: object
@@ -18579,6 +18711,7 @@ export interface IKnowledgeSourceMetaData {
 		type: string;
 	};
 	contentHashOrTimestamp?: string;
+	externalIdentifier?: string;
 }
 /**
  * @openapi
@@ -18718,7 +18851,7 @@ export interface IKnowledgeSource_2_0 {
 	metaData: IKnowledgeSourceMetaData;
 	data: Record<string, unknown>;
 	storeReference: TMongoId;
-	connectorReference?: TMongoId;
+	connectorReference?: TMongoId | null;
 	projectReference: TMongoId;
 	organisationReference: TMongoId;
 	createdAt: number;
@@ -19140,6 +19273,14 @@ export interface IUpdateKnowledgeConnectorRestData_2_0 extends IUpdateKnowledgeC
 }
 export interface IUpdateKnowledgeConnectorRestReturnValue_2_0 {
 }
+export interface IRunKnowledgeConnectorRestDataParams_2_0 {
+	knowledgeStoreId: string;
+	connectorId: string;
+}
+export interface IRunKnowledgeConnectorRestData_2_0 extends IRunKnowledgeConnectorRestDataParams_2_0 {
+}
+export interface IRunKnowledgeConnectorRestReturnValue_2_0 extends ICreatedTask_2_0 {
+}
 /**
  * @openapi
  *
@@ -19378,7 +19519,7 @@ export interface IHandoverProvider_2_0 {
 	lastChangedAt: number;
 	createdBy: TMongoId;
 	lastChangedBy: TMongoId;
-	properties: IHandoverProviderProperties[];
+	properties: IHandoverProviderProperty[];
 	settings: IHandoverProviderSettings_2_0;
 }
 export interface IHandoverProviderSettings_2_0 {
@@ -19859,6 +20000,7 @@ export interface ResourcesAPIGroup_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>;
+	runKnowledgeConnector: TRestAPIOperation<IRunKnowledgeConnectorRestData_2_0, IRunKnowledgeConnectorRestReturnValue_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>;
@@ -21920,7 +22062,20 @@ declare const actionTypes: readonly [
 	"loginFailed",
 	"loginError",
 	"unauthorized",
-	"disableCreditCardRedaction"
+	"disableCreditCardRedaction",
+	"runKnowledgeConnector",
+	"createSimulation",
+	"updateSimulation",
+	"deleteSimulation",
+	"scheduleSimulation",
+	"cloneSimulation",
+	"createScheduler",
+	"updateScheduler",
+	"deleteScheduler",
+	"generatePersonaPackages",
+	"regeneratePersonaField",
+	"bulkGeneratePersonaPackages",
+	"createScenarioFromTranscript"
 ];
 export declare type TActionType = typeof actionTypes[number];
 /**
@@ -23392,6 +23547,12 @@ export interface ICreateSystemMessageRestReturnValue_2_0 {
  *           type: string
  *         password:
  *           type: string
+ *         cxoneEmail:
+ *           type: string
+ *           description: "The email address of the CXOne user, only required for NiCE CXOne users"
+ *         cxoneId:
+ *           type: string
+ *           description: "The CXOne ID of the user, only required for NiCE CXOne users"
  *         organisation:
  *           $ref: '#/components/schemas/TMongoId'
  *         roles:
@@ -23414,6 +23575,12 @@ export interface ICreateSystemMessageRestReturnValue_2_0 {
  *           type: boolean
  *         disabled:
  *           type: boolean
+ *         cxoneEmail:
+ *           type: string
+ *           description: "The email address of the CXOne user, only required for NiCE CXOne users"
+ *         cxoneId:
+ *           type: string
+ *           description: "The CXOne ID of the user, only required for NiCE CXOne users"
  *
  *     IManagementUserAdditional_2_0:
  *       type: object
@@ -23438,6 +23605,10 @@ export interface IUserManagement_2_0 {
 	id: string;
 	/** The name of the user */
 	name: string;
+	/** The email address of the CXOne user, only required for NiCE CXOne users */
+	cxoneEmail?: string;
+	/** The CXOne ID of the user, only required for NiCE CXOne users */
+	cxoneId?: string;
 	/** The organisation id of the user */
 	organisation: string;
 	/** The org-wide roles assigned to this user */
@@ -23464,6 +23635,12 @@ export interface IUserManagement_2_0 {
  *               type: string
  *             name:
  *               type: string
+ *             cxoneEmail:
+ *               type: string
+ *               description: "The email address of the CXOne user, only required for NiCE CXOne users"
+ *             cxoneId:
+ *               type: string
+ *               description: "The CXOne ID of the user, only required for NiCE CXOne users"
  *         - $ref: '#/components/schemas/IEntityMeta'
  */
 export interface IUserManagementIndexItem_2_0 {
@@ -23473,6 +23650,10 @@ export interface IUserManagementIndexItem_2_0 {
 	id: string;
 	/** The name of the user */
 	name: string;
+	/** The email address of the CXOne user, only required for NiCE CXOne users */
+	cxoneEmail?: string;
+	/** The CXOne ID of the user, only required for NiCE CXOne users */
+	cxoneId?: string;
 	/** The organisation id the user belongs to */
 	organisation: TMongoId;
 	createdAt: number;
@@ -24283,11 +24464,16 @@ export interface IIndexSimulationRunBatchesRestDataQuery_2_0 {
 	sort?: string;
 	next?: string;
 	previous?: string;
+	scenariosIds?: string[];
+	status?: string;
+	timespan?: string;
+	timezone?: string;
+	endPointType?: string;
 }
 export interface IIndexSimulationRunBatchesRestData_2_0 extends IIndexSimulationRunBatchesRestDataQuery_2_0 {
 }
 export interface IIndexSimulationRunBatchesRestReturnValue_2_0 {
-	simulationRunBatches: ISimulationRunBatchRest_2_0[];
+	data: ISimulationRunBatchRest_2_0[];
 }
 export interface IGetAllSimulationRunBatchesRestDataQuery_2_0 {
 	projectId: string;
@@ -24633,6 +24819,73 @@ export interface IStopSimulationRunBatchRestData_2_0 extends IStopSimulationRunB
 export interface IStopSimulationRunBatchRestReturnValue_2_0 {
 	simulationRunBatchId: ISimulationRunBatchRest_2_0;
 }
+export interface IGetSimulationOverviewMetricsRestDataQuery_2_0 {
+	projectId: string;
+	scenarioIds?: string[];
+	timeWindow?: "7d" | "30d" | "3m";
+}
+export interface IGetSimulationOverviewMetricsRestData_2_0 extends IGetSimulationOverviewMetricsRestDataQuery_2_0 {
+}
+export interface IGetSimulationOverviewMetricsRestReturnValue_2_0 {
+	totalScenarios: number;
+	totalSimulations: number;
+	avgSuccessRate: number;
+	scheduledRuns: number;
+}
+export interface IGetSuccessRateTrendRestDataQuery_2_0 {
+	projectId: string;
+	scenarioIds?: string[];
+	timeWindow?: "7d" | "30d" | "3m";
+}
+export interface IGetSuccessRateTrendRestData_2_0 extends IGetSuccessRateTrendRestDataQuery_2_0 {
+}
+export interface IGetSuccessRateTrendRestReturnValue_2_0 {
+	data: Array<{
+		date: string;
+		totalRuns: number;
+		successfulRuns: number;
+		failedRuns: number;
+		successRate: number;
+		successPercentage: number;
+	}>;
+}
+export interface IGetUpcomingScheduledRunsRestDataQuery_2_0 {
+	projectId: string;
+	scenarioIds?: string[];
+	limit?: number;
+}
+export interface IGetUpcomingScheduledRunsRestData_2_0 extends IGetUpcomingScheduledRunsRestDataQuery_2_0 {
+}
+export interface IGetUpcomingScheduledRunsRestReturnValue_2_0 {
+	data: Array<{
+		_id: string;
+		id: string;
+		simulationReference: string;
+		scenarioName?: string;
+		runName?: string;
+		nextScheduledRun: string;
+		frequency: string;
+		time?: string;
+		enableSchedule?: boolean;
+		numberOfRuns?: number;
+		cronScheduler?: string;
+		emailNotifications?: string[];
+		projectReference?: string;
+		organisationReference?: string;
+		createdBy?: string;
+		lastChangedBy?: string;
+		createdAt?: number;
+		lastChanged?: number;
+		runConfig?: {
+			flowReferenceId?: string;
+			localeReferenceId?: string;
+			entrypoint?: string;
+			largeLanguageModelReferenceId?: string;
+			finalPing?: number;
+			enableMocking?: boolean;
+		};
+	}>;
+}
 declare enum ESchedulerFrequencyRest_2_0 {
 	DAILY = "daily",
 	EVERY_THREE_DAYS = "every three days",
@@ -24737,6 +24990,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>;
+	getSimulationOverviewMetrics: TRestAPIOperation<IGetSimulationOverviewMetricsRestData_2_0, IGetSimulationOverviewMetricsRestReturnValue_2_0>;
+	getSuccessRateTrend: TRestAPIOperation<IGetSuccessRateTrendRestData_2_0, IGetSuccessRateTrendRestReturnValue_2_0>;
+	getUpcomingScheduledRuns: TRestAPIOperation<IGetUpcomingScheduledRunsRestData_2_0, IGetUpcomingScheduledRunsRestReturnValue_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>;