@cognigy/rest-api-client 2025.10.0 → 2025.12.0

package/types/index.d.ts

@@ -958,7 +958,8 @@ declare const arrayTResourceType: readonly [
 	"slotFiller",
 	"snapshot",
 	"snippet",
-	"aiAgent"
+	"aiAgent",
+	"simulation"
 ];
 export declare type TResourceType = (typeof arrayTResourceType)[number];
 declare const arrayTChartableResourceType: readonly [
@@ -1614,6 +1615,7 @@ export interface IRestAPIClientVersionConfiguration {
 	analytics: "2.0";
 	jwt: "2.0";
 	opsCenter: "2.0";
+	simulation: "2.0";
 }
 export declare type THttpLib = "axios";
 /**
@@ -1891,7 +1893,8 @@ declare const webhookChannelTypes: readonly [
 	"intercom",
 	"whatsapp",
 	"eightByEight",
-	"agentAssistVoice"
+	"agentAssistVoice",
+	"zoomContactCenter"
 ];
 export declare type TWebhookChannelType = typeof webhookChannelTypes[number];
 declare const restChannelTypes: readonly [
@@ -1910,7 +1913,8 @@ declare const restChannelTypes: readonly [
 	"amazonLex",
 	"genesysBotConnector",
 	"niceCXOne",
-	"niceCXOneAAH"
+	"niceCXOneAAH",
+	"zoomContactCenter"
 ];
 export declare type TRestChannelType = typeof restChannelTypes[number];
 declare const socketChannelTypes: readonly [
@@ -2554,6 +2558,7 @@ export interface IGraphEndpointDependency {
  *         - agentAssistVoice
  *         - webchat3
  *         - niceCXOneAAH
+ *         - zoomContactCenter
  */
 export declare type TChannelType = TWebhookChannelType | TRestChannelType | TSocketChannelType | "inject" | "abstract-rest" | "adminconsole" | "voiceGateway2";
 declare const endpointTypes: readonly [
@@ -2589,7 +2594,8 @@ declare const endpointTypes: readonly [
 	"niceCXOne",
 	"niceCXOneAAH",
 	"agentAssistVoice",
-	"webchat3"
+	"webchat3",
+	"zoomContactCenter"
 ];
 export declare type TEndpointType = typeof endpointTypes[number];
 declare const transferTypes: readonly [
@@ -2694,7 +2700,7 @@ export interface IVoiceGatewayEndpointSettings extends IEndpointSessionSettings
 		cancelButtonText: string;
 	};
 }
-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 | {};
+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;
 declare const avayaSttTtsLanguages: readonly [
 	"cy-GB",
@@ -4319,6 +4325,9 @@ export interface INiceCXOneEndpointSettings {
 export interface INiceCXOneAAHEndpointSettings {
 	niceCXOneAAHConnection: string;
 }
+export interface IZoomContactCenterEndpointSettings {
+	verifyToken: string;
+}
 declare const arrayNLUConnectorType_2_0: readonly [
 	"alexa",
 	"dialogflow",
@@ -8731,6 +8740,7 @@ export interface IOpenAIMeta {
 export interface IOpenAICompatibleMeta {
 	customModel: string;
 	baseCustomUrl: string;
+	customAuthHeader?: string;
 }
 export interface IAlephAlphaMeta {
 	customModel?: string;
@@ -9471,7 +9481,6 @@ export interface IHandoverNodeV2Params extends INodeFunctionBaseParams {
 		sendResolveEvent: boolean;
 		resolveBehavior: "resetEntrypoint" | "continueEntrypoint";
 		allowAgentInject: boolean;
-		agentAssistInitMessage: string;
 		sendOnQueueEvent: boolean;
 		sendOnActiveEvent: boolean;
 		getQueuePosition: boolean;
@@ -9717,7 +9726,6 @@ export interface IQuestionNodeSharedConfig extends INodeWithAiRephraseConfig {
 	escalateAnswersHandoverEightByEightJSONProps: object;
 	escalateAnswersHandoverSendResolveEvent: boolean;
 	escalateAnswersHandoverResolveBehavior: "resetEntrypoint" | "continueEntrypoint";
-	escalateAnswersAgentAssistInitMessage: string;
 	escalateAnswersAllowAgentInject: boolean;
 	escalateAnswersSendOnQueueEvent: boolean;
 	escalateAnswersSendOnActiveEvent: boolean;
@@ -10640,7 +10648,7 @@ export interface IActions {
 	removeFromContext?: (key: string, value: string, mode: string) => void;
 	rephraseSentenceWithAI(sentence: string, options: IRephraseSentenceWithAIOptions): Promise<string>;
 	rephraseMultipleSentencesWithAI(sentences: string[], options: IRephraseSentenceWithAIOptions): Promise<string[]>;
-	requestHandover?: (text: string, cancel: string, userId: string, sessionId: string, requestHandover: string, inputAnalyticsData: IAnalyticsSourceData, handoverVersion?: IHandoverRequestStatus["handoverVersion"], repeatHandoverMessage?: boolean, sendResolveEvent?: boolean, resolveBehavior?: IHandoverRequestStatus["resolveBehavior"], nodeType?: IHandoverRequestStatus["nodeType"], agentAssistInitMessage?: string, providerResponse?: any, sendOnQueueEvent?: boolean, sendOnActiveEvent?: boolean) => void;
+	requestHandover?: (text: string, cancel: string, userId: string, sessionId: string, requestHandover: string, inputAnalyticsData: IAnalyticsSourceData, handoverVersion?: IHandoverRequestStatus["handoverVersion"], repeatHandoverMessage?: boolean, sendResolveEvent?: boolean, resolveBehavior?: IHandoverRequestStatus["resolveBehavior"], nodeType?: IHandoverRequestStatus["nodeType"], providerResponse?: any, sendOnQueueEvent?: boolean, sendOnActiveEvent?: boolean) => void;
 	runGenerativeAIPrompt?: (options: IRunGenerativeAIPromptOptions, useCase: TGenerativeAIUseCases, nodeAnalyticsParams?: TNodeAnalyticsParams) => Promise<any>;
 	resetContext?: () => object;
 	resetFormBrain?: () => Promise<void>;
@@ -10682,7 +10690,7 @@ export interface IActions {
 	knowledgeSearch: (data: IKnowledgeSearchData, nodeAnalyticsParams?: TNodeAnalyticsParams) => Promise<IKnowledgeSearchReturnValue>;
 	matchPattern: (patternType: IPatternTypes, phrase: string, locale?: string) => IPatternMatchResult;
 	getAgentAssistConfigId: () => string;
-	getNluEmbeddingCredentials: () => INluEmbeddingCredentials;
+	getNluEmbeddingCredentials: () => Promise<INluEmbeddingCredentials>;
 	getMetadata: () => IGetMetaDataActionValue;
 	sendTrackGoal: (payload: IGoalAnalyticsPayload) => Promise<void>;
 	getEndpointSettings: () => IEndpointSettings;
@@ -17167,6 +17175,7 @@ export interface IOpenAIMeta_2_0 {
 export interface IOpenAICompatibleMeta_2_0 {
 	customModel: string;
 	baseCustomUrl: string;
+	customAuthHeader?: string;
 }
 export interface IAnthropicMeta_2_0 {
 	customModel?: string;
@@ -17330,6 +17339,21 @@ export interface IGoogleGeminiMeta_2_0 {
  *             baseCustomUrl:
  *               type: string
  *               example: https://api.aleph-alpha.com
+ *         openAICompatible:
+ *           type: object
+ *           description: OpenAI compatible provider
+ *           properties:
+ *             customModel:
+ *               type: string
+ *               example: luminous-003
+ *               description: The custom model name. This does not work with embedding models
+ *             baseCustomUrl:
+ *               type: string
+ *               example: https://own-llm-deployment.company.com/openai/v1
+ *             customAuthHeader:
+ *               type: string
+ *               example: Ocp-Apim-Subscription-Key
+ *               description: The api key will be sent via this http header if specified
  *
  *     ILargeLanguageModelFields_2_0:
  *       allOf:
@@ -20784,7 +20808,10 @@ declare const actionTypes: readonly [
 	"updateFlowSettings",
 	"optionsResolver",
 	"processKnowledgeSourceUrl",
-	"processKnowledgeSourceFile"
+	"processKnowledgeSourceFile",
+	"setupObservationConfig",
+	"updateObservationConfig",
+	"resolveAiOpsCenterError"
 ];
 export declare type TActionType = typeof actionTypes[number];
 /**
@@ -20837,7 +20864,7 @@ export declare type TResourceTypeAdditional = "aicopilotconfig" | "apiKey" | "an
  *         - $ref: '#/components/schemas/TResourceType'
  *         - $ref: '#/components/schemas/TResourceTypeAdditional'
  */
-export declare type TAuditEventChainElementType = TResourceType | TResourceTypeAdditional;
+export declare type TAuditEventChainElementType = TResourceType | TResourceTypeAdditional | "AiOpsCenterError";
 /***
  * @openapi
  * components:
@@ -22646,13 +22673,18 @@ export interface IIndexOpsCenterErrorsRestReturnValue_2_0 {
 	items?: IGetOpsCenterError[];
 }
 declare const notificationChannels: readonly [
-	"email"
+	"email",
+	"webhook"
 ];
 export declare type NotificationChannel = (typeof notificationChannels)[number];
 export interface NotificationConfig {
 	channel: NotificationChannel;
 	/** List of email addresses to send notifications to. */
 	addresses: string[];
+	webhook?: {
+		url: string;
+		connectionId: string;
+	};
 }
 export interface AlertingConfig {
 	configuredAlerts: {
@@ -22707,7 +22739,282 @@ export interface AIOpsCenterAPIGroup_2_0 {
 	indexOpsCenterAlerts: TRestAPIOperation<IIndexOpsCenterAlertsRestData_2_0, IIndexOpsCenterAlertsRestReturnValue_2_0>;
 }
 declare function AIOpsCenterAPIGroup_2_0(instance: Base): AIOpsCenterAPIGroup_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>;
+declare enum ESuccessCriterionTypeRest_2_0 {
+	TEXT = "text",
+	GOAL_COMPLETED = "goalCompleted"
+}
+export interface ISuccessCriteriaRest_2_0 {
+	type: ESuccessCriterionTypeRest_2_0;
+	params: Record<string, unknown>;
+}
+export interface IProjectMetadataRest_2_0 {
+	projectReference: string;
+	organisationReference: string;
+}
+export interface ISimulationRest_2_0 extends IProjectMetadataRest_2_0 {
+	id: string;
+	name: string;
+	persona: string;
+	personaName: string;
+	mission: string;
+	successCriteria: ISuccessCriteriaRest_2_0[];
+	maxTurns?: number;
+	timeout?: number;
+	createdAt?: number;
+	createdBy: string;
+	updatedAt?: number;
+	updatedBy: string;
+	lastChanged: number;
+	lastChangedBy?: string;
+	expiresAt?: Date;
+}
+export interface IIndexSimulationsRestDataQuery_2_0 {
+	projectId?: string;
+	filter?: number;
+	limit?: number;
+	skip?: number;
+	sort?: string;
+	next?: string;
+	previous?: string;
+}
+export interface IIndexSimulationsRestData_2_0 extends IIndexSimulationsRestDataQuery_2_0 {
+}
+export interface IIndexSimulationsRestReturnValue_2_0 {
+	data: ISimulationRest_2_0[];
+	pagination: {
+		total: number;
+		limit: number;
+		skip: number;
+		hasMore: boolean;
+		next?: string;
+		previous?: string;
+	};
+}
+export interface ICreateSimulationRestData_2_0 {
+	name: string;
+	persona: string;
+	personaName: string;
+	mission: string;
+	successCriteria: ISuccessCriteriaRest_2_0[];
+	maxTurns?: number;
+	timeout?: number;
+	projectReference: string;
+	organisationReference: string;
+}
+export interface ICreateSimulationRestReturnValue_2_0 {
+	simulation: ISimulationRest_2_0;
+}
+export interface IUpdateSimulationsRestDataQuery_2_0 {
+	projectId: string;
+}
+export interface IUpdateSimulationsRestDataParams_2_0 {
+	simulationReference: string;
+}
+export interface IUpdateSimulationsRestDataBody_2_0 {
+	name?: string;
+	persona?: string;
+	personaName?: string;
+	mission?: string;
+	successCriteria?: ISuccessCriteriaRest_2_0[];
+	maxTurns?: number;
+	timeout?: number;
+}
+export interface IUpdateSimulationRestData_2_0 extends IUpdateSimulationsRestDataQuery_2_0, IUpdateSimulationsRestDataParams_2_0, IUpdateSimulationsRestDataBody_2_0 {
+}
+export interface IUpdateSimulationRestReturnValue_2_0 {
+	simulation: ISimulationRest_2_0;
+}
+export interface IDeleteSimulationsRestDataQuery_2_0 {
+	projectId: string;
+}
+export interface IDeleteSimulationRestData_2_0 extends IDeleteSimulationsRestDataQuery_2_0 {
+	simulationReference: string;
+}
+export interface IDeleteSimulationRestReturnValue_2_0 {
+}
+export interface IReadSimulationsRestDataQuery_2_0 {
+	projectId: string;
+}
+export interface IReadSimulationRestData_2_0 extends IReadSimulationsRestDataQuery_2_0 {
+	simulationReference: string;
+}
+export interface IReadSimulationRestReturnValue_2_0 {
+	simulation: ISimulationRest_2_0;
+}
+export interface IScheduleSimulationRestDataParams_2_0 {
+	simulationReference: string;
+}
+export interface IScheduleSimulationRestDataBody_2_0 {
+	name: string;
+	largeLanguageModelReferenceId: string;
+	runConfig: {
+		flowReferenceId: string;
+		localeReferenceId?: string;
+		entrypoint: string;
+	};
+	projectReference: string;
+	numberOfExecutions: number;
+}
+export interface IScheduleSimulationRestData_2_0 extends IScheduleSimulationRestDataParams_2_0, IScheduleSimulationRestDataBody_2_0 {
+}
+export interface IScheduleSimulationRestReturnValue_2_0 {
+	simulation: ISimulationRest_2_0;
+}
+declare const SimulationRunBatchStatus: readonly [
+	"IN_PROGRESS",
+	"COMPLETED",
+	"FAILED"
+];
+export declare type TSimulationRunBatchStatusRest_2_0 = typeof SimulationRunBatchStatus[number];
+export interface ISimulationRunBatchRest_2_0 {
+	id: string;
+	name: string;
+	status: TSimulationRunBatchStatusRest_2_0;
+	numberOfExecutions: number;
+	successRate?: number;
+	efficiency?: number;
+	simulationReference: string;
+	projectReference: string;
+	organisationReference: string;
+	runConfig: {
+		flowReferenceId: string;
+		localeReferenceId?: string;
+		entrypoint: string;
+	};
+	createdAt: number;
+	createdBy: string;
+	largeLanguageModelReferenceId: string;
+	updatedAt?: number;
+	completedAt?: number;
+	expiresAt?: Date;
+}
+export interface IIndexSimulationRunBatchesRestDataQuery_2_0 {
+	projectId: string;
+	filter?: number;
+	limit?: number;
+	skip?: number;
+	sort?: string;
+	next?: string;
+	previous?: string;
+}
+export interface IIndexSimulationRunBatchesRestData_2_0 extends IIndexSimulationRunBatchesRestDataQuery_2_0 {
+}
+export interface IIndexSimulationRunBatchesRestReturnValue_2_0 {
+	simulationRunBatches: ISimulationRunBatchRest_2_0[];
+}
+export interface IGetAllSimulationRunBatchesRestDataQuery_2_0 {
+	projectId: string;
+	filter?: number;
+	limit?: number;
+	skip?: number;
+	sort?: string;
+	next?: string;
+	previous?: string;
+}
+export interface IGetAllSimulationRunBatchesRestData_2_0 extends IGetAllSimulationRunBatchesRestDataQuery_2_0 {
+	simulationReference: string;
+}
+export interface IGetAllSimulationRunBatchesRestReturnValue_2_0 {
+	simulationRunBatches: ISimulationRunBatchRest_2_0[];
+}
+export interface IReadSimulationRunBatchRestDataQuery_2_0 {
+	projectId: string;
+}
+export interface IReadSimulationRunBatchRestData_2_0 extends IReadSimulationRunBatchRestDataQuery_2_0 {
+	simulationReference: string;
+	simulationRunBatchReference: string;
+}
+export interface IReadSimulationRunBatchRestReturnValue_2_0 {
+	simulationRunBatch: ISimulationRunBatchRest_2_0;
+}
+declare enum ETurnTypeRest_2_0 {
+	INPUT = "input",
+	OUTPUT = "output"
+}
+export interface ITurnRest_2_0 {
+	type: ETurnTypeRest_2_0;
+	text: string;
+	data?: Record<string, unknown>;
+}
+declare enum ESuccessCriteriaTypeRest_2_0 {
+	TEXT = "text"
+}
+export interface ISuccessCriteriaRest_2_0 {
+	type: ESuccessCriteriaTypeRest_2_0;
+	params: {
+		text: string;
+	};
+}
+declare enum ESentimentTypeRest_2_0 {
+	POSITIVE = "POSITIVE",
+	NEUTRAL = "NEUTRAL",
+	NEGATIVE = "NEGATIVE"
+}
+export interface ISimulationRunRest_2_0 {
+	id: string;
+	organisationReference: string;
+	projectReference: string;
+	simulationReference: string;
+	simulationRunBatchReference: string;
+	sequence: number;
+	largeLanguageModelReferenceId: string;
+	turns: ITurnRest_2_0[];
+	totalTurns: number;
+	successCriteria: ISuccessCriteriaRest_2_0[];
+	metrics: {
+		sentiment: ESentimentTypeRest_2_0;
+		outOfScope: string;
+		efficiency: number;
+		topic: string;
+		success: boolean;
+	};
+	createdAt: number;
+	createdBy: string;
+	duration?: number;
+	expiresAt?: Date;
+}
+export interface IIndexSimulationRunsRestDataQuery_2_0 {
+	projectId: string;
+	filter?: number;
+	limit?: number;
+	skip?: number;
+	sort?: string;
+	next?: string;
+	previous?: string;
+}
+export interface IIndexSimulationRunsRestData_2_0 extends IIndexSimulationRunsRestDataQuery_2_0 {
+	simulationRunBatchReference: string;
+	simulationReference: string;
+}
+export interface IIndexSimulationRunsRestReturnValue_2_0 {
+	simulationRuns: ISimulationRunRest_2_0[];
+}
+export interface IReadSimulationRunRestDataQuery_2_0 {
+	projectId: string;
+}
+export interface IReadSimulationRunRestData_2_0 extends IReadSimulationRunRestDataQuery_2_0 {
+	simulationRunReference: string;
+	simulationRunBatchReference: string;
+	simulationReference: string;
+}
+export interface IReadSimulationRunRestReturnValue_2_0 {
+	simulationRun: ISimulationRunRest_2_0;
+}
+export interface SimulationAPIGroup_2_0 {
+	indexSimulations: TRestAPIOperation<IIndexSimulationsRestData_2_0, IIndexSimulationsRestReturnValue_2_0>;
+	createSimulation: TRestAPIOperation<ICreateSimulationRestData_2_0, ICreateSimulationRestReturnValue_2_0>;
+	updateSimulation: TRestAPIOperation<IUpdateSimulationRestData_2_0, IUpdateSimulationRestReturnValue_2_0>;
+	deleteSimulation: TRestAPIOperation<IDeleteSimulationRestData_2_0, IDeleteSimulationRestReturnValue_2_0>;
+	readSimulation: TRestAPIOperation<IReadSimulationRestData_2_0, IReadSimulationRestReturnValue_2_0>;
+	scheduleSimulation: TRestAPIOperation<IScheduleSimulationRestData_2_0, IScheduleSimulationRestReturnValue_2_0>;
+	indexSimulationRunBatches: TRestAPIOperation<IIndexSimulationRunBatchesRestData_2_0, IIndexSimulationRunBatchesRestReturnValue_2_0>;
+	getAllSimulationRunBatches: TRestAPIOperation<IGetAllSimulationRunBatchesRestData_2_0, IGetAllSimulationRunBatchesRestReturnValue_2_0>;
+	readSimulationRunBatch: TRestAPIOperation<IReadSimulationRunBatchRestData_2_0, IReadSimulationRunBatchRestReturnValue_2_0>;
+	indexSimulationRuns: TRestAPIOperation<IIndexSimulationRunsRestData_2_0, IIndexSimulationRunsRestReturnValue_2_0>;
+	readSimulationRun: TRestAPIOperation<IReadSimulationRunRestData_2_0, IReadSimulationRunRestReturnValue_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>;
 export declare type TResourceAPIVersionType<T> = T extends {
 	versions: {
 		resources: "2.0";
@@ -22758,6 +23065,11 @@ export declare type TAIOpsCenterAPIVersionType<T> = T extends {
 		aiops: "1.0";
 	};
 } ? AIOpsCenterAPIGroup_2_0 : AIOpsCenterAPIGroup_2_0;
+export declare type TSimulationAPIVersionType<T> = T extends {
+	versions: {
+		simulation: "2.0";
+	};
+} ? SimulationAPIGroup_2_0 : SimulationAPIGroup_2_0;
 export declare type TRestAPIClient<T extends IRestAPIClientConfig = IRestAPIClientConfig> = TRestAPIGroupsTypeByConfiguration<T> & AuthenticationAPI & IRestAPIClientProperties<T> & IHttpAdapterAPI;
 export interface IRestAPIClientConstructor {
 	new <T extends IRestAPIClientConfig>(config?: T): TRestAPIClient<T>;