@cognigy/rest-api-client 4.98.0 → 4.99.0

package/types/index.d.ts

@@ -1315,6 +1315,9 @@ export interface IAllowedLocale {
  *         idpCertificate:
  *           type: string
  *           description: The certificate from the ID used to sign the SAML requests. It is base64 encoded.
+ *         wantAuthnResponseSigned:
+ *           type: boolean
+ *           description: If the SAML authentification response should be signed, not all providers support this.
  *         decryptionPrivateKey:
  *           type: string
  *           description: An optional decryption key. This is necessary if the SAML request is encoded.
@@ -1362,6 +1365,11 @@ export interface ISamlIdentityProvider {
 	 * Reference the organisation this identity provider belongs to.
 	 */
 	organisationReference: TMongoId;
+	/**
+	 * If the SAML authentification response should be signed,
+	 * not all providers support this.
+	 */
+	wantAuthnResponseSigned?: boolean;
 }
 declare const idpTokenEndpointAuthMethods: readonly [
 	"client_secret_basic",
@@ -1605,6 +1613,7 @@ export interface IRestAPIClientVersionConfiguration {
 	insights: "2.0";
 	analytics: "2.0";
 	jwt: "2.0";
+	opsCenter: "2.0";
 }
 export declare type THttpLib = "axios";
 /**
@@ -3439,6 +3448,12 @@ export interface IWebchat3EndpointBehaviorSettings {
 	 * This setting enables output messages to appear progressively.
 	 */
 	progressiveMessageRendering: boolean;
+	/**
+	 * This setting enables scroll-to-bottom button.
+	 *
+	 * Default: true
+	 */
+	enableScrollButton: boolean;
 	/**
 	 * Whether the webchat renders Text messages as markdown
 	 */
@@ -3566,6 +3581,10 @@ export interface IWebchat3EndpointHomeScreenSettings {
 	*/
 	startConversationButtonText: string;
 	previousConversations: {
+		/**
+		 * Enable the delete all conversations button
+		 */
+		enableDeleteAllConversations: boolean;
 		/**
 		 * The text of the start new conversation button
 		*/
@@ -3673,6 +3692,10 @@ export interface IWebchat3EndpointChatOptionsSettings {
 		submitButtonText: string;
 		eventBannerText: string;
 	};
+	/**
+	 * Enable to delete conversation
+	 */
+	enableDeleteConversation: boolean;
 	/**
 	 * The configuration of the chat options footer
 	*/
@@ -4298,11 +4321,17 @@ declare const generativeAIModels: readonly [
 	"gemini-1.0-pro",
 	"gemini-1.5-pro",
 	"gemini-1.5-flash",
+	"gemini-2.0-flash",
+	"gemini-2.0-flash-lite",
 	"amazon.nova-lite-v1:0",
 	"amazon.nova-pro-v1:0",
 	"amazon.nova-micro-v1:0",
 	"anthropic.claude-3-5-sonnet-20240620-v1:0",
 	"claude-3-7-sonnet-20250219",
+	"mistral-large-2411",
+	"mistral-small-2503",
+	"pixtral-large-2411",
+	"pixtral-12b-2409",
 	"text-embedding-3-small",
 	"text-embedding-3-large",
 	"text-embedding-ada-002",
@@ -4333,6 +4362,12 @@ declare const generativeAIModels: readonly [
  *         - gemini-1.0-pro
  *         - gemini-1.5-pro
  *         - gemini-1.5-flash
+ *         - gemini-2.0-flash
+ *         - gemini-2.0-flash-lite
+ *         - mistral-large-2411
+ *         - mistral-small-2503
+ *         - pixtral-large-2411
+ *         - pixtral-12b-2409
  */
 export declare type TGenerativeAIModels = (typeof generativeAIModels)[number];
 declare const generativeAIProviders: readonly [
@@ -4343,7 +4378,8 @@ declare const generativeAIProviders: readonly [
 	"anthropic",
 	"googleVertexAI",
 	"googleGemini",
-	"awsBedrock"
+	"awsBedrock",
+	"mistral"
 ];
 /**
  * @openapi
@@ -4360,6 +4396,7 @@ declare const generativeAIProviders: readonly [
  *         - googleGemini
  *         - alephAlpha
  *         - awsBedrock
+ *         - mistral
  */
 export declare type TGenerativeAIProviders = (typeof generativeAIProviders)[number];
 declare const generativeAIUseCases: readonly [
@@ -5226,6 +5263,7 @@ export interface IAudioPreviewSettings_2_0 {
  *         - googleGemini
  *         - alephAlpha
  *         - awsBedrock
+ *         - mistral
  */
 export declare type TGenerativeAIProviders_2_0 = TGenerativeAIProviders;
 /**
@@ -8658,6 +8696,9 @@ export interface IAlephAlphaMeta {
 export interface IAnthropicMeta {
 	customModel?: string;
 }
+export interface IMistralMeta {
+	customModel?: string;
+}
 export interface IAwsBedrockMeta {
 	region: string;
 	customModel?: string;
@@ -8710,6 +8751,7 @@ export interface ILargeLanguageModel extends IEntityMeta, IGlobalResource {
 	openAICompatible?: IOpenAICompatibleMeta;
 	alephAlpha?: IAlephAlphaMeta;
 	anthropic?: IAnthropicMeta;
+	mistral?: IMistralMeta;
 	awsBedrock?: IAwsBedrockMeta;
 	fallbacks?: TLLMFallback[];
 }
@@ -9911,6 +9953,9 @@ export interface ISessionStateWithoutMeta {
 			flow: string;
 			node: string;
 		};
+		mcpServerUrl?: string;
+		mcpToolNode?: string;
+		timeout?: number;
 	};
 	tokenUsage?: TSessionUsageInformation;
 }
@@ -11199,6 +11244,21 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
 		title: string;
 		subComponent?: string;
 	}) => void;
+	fetchMcpTools: (params: {
+		mcpServerUrl: string;
+		timeout: number;
+		cacheTools: boolean;
+	}) => Promise<any[]>;
+	executeMcpTool: (params: {
+		toolName: string;
+		toolArgs: {
+			[x: string]: unknown;
+		};
+		mcpServerUrl: string;
+		timeout: number;
+	}) => Promise<{
+		[x: string]: unknown;
+	}>;
 }
 export interface INodeExecutionCognigyObject extends IExecutionObjects {
 	api: INodeExecutionAPI;
@@ -15089,7 +15149,7 @@ export interface IBatchConnectionsRestData_2_0 extends IBatchConnectionsRestData
 }
 export interface IBatchConnectionsRestReturnValue_2_0 {
 }
-export interface ICreateConnectionRestDataBody_2_0 extends IProjectScope, Partial<Omit<IConnection_2_0, keyof IEntityMeta>> {
+export interface ICreateConnectionRestDataBody_2_0 extends Partial<IProjectScope>, Partial<Omit<IConnection_2_0, keyof IEntityMeta>> {
 }
 export interface ICreateConnectionRestData_2_0 extends ICreateConnectionRestDataBody_2_0 {
 }
@@ -16519,6 +16579,7 @@ export interface IDtmfParams extends INodeFunctionBaseParams {
 export interface IHangupParams extends INodeFunctionBaseParams {
 	config: {
 		hangupReason: string;
+		hangupImmediately: boolean;
 	};
 }
 export interface IPlayParamsConfig extends IVoiceConfigParams {
@@ -17072,6 +17133,9 @@ export interface IGoogleVertexAIMeta_2_0 {
 	apiEndPoint: string;
 	publisher?: string;
 }
+export interface IMistralMeta_2_0 {
+	customModel?: string;
+}
 /**
  * @openapi
  *
@@ -17291,6 +17355,8 @@ export interface ILargeLanguageModel_2_0 extends IGlobalResource {
 	anthropic?: IAnthropicMeta_2_0;
 	/** Meta data for the AwsBedrock connection */
 	awsBedrock?: IAwsBedrockMeta_2_0;
+	/** Meta data for the Mistral connection */
+	mistral?: IMistralMeta_2_0;
 	/** Fallback LLM configuration */
 	fallbacks?: ILLMFallback_2_0[];
 }
@@ -22349,7 +22415,242 @@ export interface AnalyticsAPIGroup_2_0 {
 	updateAnalyticsRecords: TRestAPIOperation<IUpdateAnalyticsRecordsRestData_2_0, IUpdateAnalyticsRecordsRestReturnValue_2_0>;
 }
 declare function AnalyticsAPIGroup_2_0(instance: Base): AnalyticsAPIGroup_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>;
+export declare type PrometheusResponsePayload = {
+	status: "success" | "error";
+	/** Actual response data */
+	data: unknown;
+	/** Only set if the status is "error". */
+	errorType?: string;
+	/** Only set if the status is "error" */
+	error?: string;
+	/** Only set if there were warnings while executing the request */
+	warnings?: string[];
+	/** Only set if there were info-level annotations while executing the request */
+	infos?: string[];
+};
+export interface IGetOpsCenterMetrics extends PrometheusResponsePayload {
+}
+export interface IGetOpsCenterMetricsRestDataQuery_2_0 {
+	identifier: string;
+	time: string;
+	projectIds?: string[];
+}
+export interface IGetOpsCenterMetricsRestData_2_0 extends IGetOpsCenterMetricsRestDataQuery_2_0 {
+}
+export interface IGetOpsCenterMetricsRestReturnValue_2_0 extends IGetOpsCenterMetrics {
+}
+declare const chartTypes: readonly [
+	"bar-chart",
+	"heat-map",
+	"line-chart",
+	"alerts-errors",
+	"health-status-monitor"
+];
+declare const segmentConfigArray: readonly [
+	"voice-gateway",
+	"endpoints",
+	"flows",
+	"overview",
+	"handover-provider"
+];
+declare const availableColorsArray: readonly [
+	"default",
+	"blue",
+	"yellow",
+	"green",
+	"purple",
+	"red"
+];
+export declare type Segment = (typeof segmentConfigArray)[number];
+export declare type ChartType = (typeof chartTypes)[number];
+export declare type AvailableColors = (typeof availableColorsArray)[number];
+export declare type GridSize = "auto" | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
+export interface ChartConfig {
+	color?: string;
+	height: number;
+}
+export interface ChartMeta {
+	xs: GridSize;
+	sm: GridSize;
+	md: GridSize;
+	lg: GridSize;
+	xl: GridSize;
+}
+export interface ChartQueryConfig {
+	metric: string;
+	isPositiveTrend: boolean;
+	identifier?: string;
+	queryTemplate: string;
+}
+export interface ChartSegmentConfig {
+	type: ChartType;
+	title?: string;
+	description?: string;
+	queryConfig?: ChartQueryConfig;
+	showCounts?: boolean;
+	chartConfig?: ChartConfig;
+	meta?: ChartMeta;
+}
+export declare type TColorConfig = {
+	[key in AvailableColors]: string[];
+};
+export interface IGetOpsCenterMetricsConfig {
+	meta: Record<string, never>;
+	config: {
+		[key in Segment]: ChartSegmentConfig[];
+	};
+	colorConfig: TColorConfig;
+}
+export interface IGetOpsCenterMetricsConfigRestReturnValue_2_0 extends IGetOpsCenterMetricsConfig {
+}
+export interface IGetOpsCenterMetricsRangeRestDataQuery_2_0 {
+	identifier: string;
+	projectIds?: string[];
+	start: string;
+	end: string;
+	step: string;
+}
+export interface IGetOpsCenterMetricsRangeRestData_2_0 extends IGetOpsCenterMetricsRangeRestDataQuery_2_0 {
+}
+export interface IGetOpsCenterMetricsRangeRestReturnValue_2_0 extends IGetOpsCenterMetrics {
+}
+export interface IDeleteOpsCenterErrorRestDataParams_2_0 {
+	errorId: string;
+}
+export interface IDeleteOpsCenterErrorRestData_2_0 extends IDeleteOpsCenterErrorRestDataParams_2_0 {
+}
+export interface IDeleteOpsCenterErrorRestReturnValue_2_0 {
+}
+declare const arrayOfTMainComponent: readonly [
+	"VoiceGateway",
+	"Endpoint",
+	"Flow",
+	"HandoverProvider"
+];
+/**
+ * Errors and Alerts always belong to one of the main components.
+ */
+export declare type MainComponent = (typeof arrayOfTMainComponent)[number];
+declare const arrayOfTSubComponent: readonly [
+	"SpeechToText",
+	"TextToSpeech",
+	"InputTransformer",
+	"OutputTransformer",
+	"ExecutionFinishedTransformer",
+	"InjectTransformer",
+	"NotifyTransformer",
+	"RealtimeTranslation",
+	"MessageRoundtrip",
+	"FlowNodeExecution",
+	"NaturalLanguageUnderstanding",
+	"OutboundHTTPCalls",
+	"LargeLanguageModelCalls",
+	"KnowledgeAIQueries",
+	"OutboundHTTPCalls"
+];
+/**
+ * Each subcomponent belongs to a main component
+ */
+export declare type SubComponent = (typeof arrayOfTSubComponent)[number];
+export interface IOpsCenterError {
+	id: string;
+	organisationId: string;
+	projectId?: string;
+	title: string;
+	firstOccurredAt: Date;
+	lastOccurredAt: Date;
+	component?: MainComponent;
+	subComponent?: SubComponent;
+	count: number;
+}
+export interface IGetOpsCenterError extends Partial<IOpsCenterError> {
+}
+export interface IGetOpsCenterErrorRestDataParams_2_0 {
+	errorId: string;
+}
+export interface IGetOpsCenterErrorRestData_2_0 extends IGetOpsCenterErrorRestDataParams_2_0 {
+}
+export interface IGetOpsCenterErrorRestReturnValue_2_0 extends IGetOpsCenterError {
+}
+export interface IIndexOpsCenterErrorsRestDataQuery_2_0 {
+	projectIds?: string[];
+	component?: MainComponent;
+	subComponent?: SubComponent;
+	offset?: number;
+	limit?: number;
+	totalCountOnly?: string;
+	sort?: string;
+}
+export interface IIndexOpsCenterErrorsRestData_2_0 extends IIndexOpsCenterErrorsRestDataQuery_2_0 {
+}
+export interface IIndexOpsCenterErrorsRestReturnValue_2_0 {
+	total?: number;
+	totalErrorCount?: number;
+	items?: IGetOpsCenterError[];
+}
+declare const notificationChannels: readonly [
+	"email"
+];
+export declare type NotificationChannel = (typeof notificationChannels)[number];
+export interface NotificationConfig {
+	channel: NotificationChannel;
+	/** List of email addresses to send notifications to. */
+	addresses: string[];
+}
+export interface AlertingConfig {
+	configuredAlerts: {
+		[K in string]: boolean;
+	};
+}
+export interface IOpsCenterObservationConfig {
+	organisationId: string;
+	observationActive: boolean;
+	notificationConfig: NotificationConfig;
+	alertingConfig: AlertingConfig;
+}
+export interface IGetOpsCenterObservationConfigRestReturnValue_2_0 extends IOpsCenterObservationConfig {
+}
+export interface IPatchOpsCenterObservationConfigRestDataBody_2_0 extends Partial<Omit<IOpsCenterObservationConfig, "organisationId">> {
+}
+export interface IPatchOpsCenterObservationConfigRestData_2_0 extends IPatchOpsCenterObservationConfigRestDataBody_2_0 {
+}
+export interface IPatchOpsCenterObservationConfigRestReturnValue_2_0 extends IOpsCenterObservationConfig {
+}
+export interface ISetupOpsCenterObservationConfigRestReturnValue_2_0 extends IOpsCenterObservationConfig {
+}
+export interface IOpsCenterAlert {
+	type: string;
+	name: string;
+	description: string;
+	component: MainComponent;
+	subComponent: SubComponent;
+	state: string;
+	activeAt: string;
+}
+export interface IIndexOpsCenterAlertsRestDataQuery_2_0 {
+	component?: MainComponent;
+	subComponent?: SubComponent;
+}
+export interface IIndexOpsCenterAlertsRestData_2_0 extends IIndexOpsCenterAlertsRestDataQuery_2_0 {
+}
+export interface IIndexOpsCenterAlertsRestReturnValue_2_0 {
+	items: IOpsCenterAlert[];
+	total: number;
+}
+export interface AIOpsCenterAPIGroup_2_0 {
+	indexOpsCenterErrors: TRestAPIOperation<IIndexOpsCenterErrorsRestData_2_0, IIndexOpsCenterErrorsRestReturnValue_2_0>;
+	getOpsCenterErrorById: TRestAPIOperation<IGetOpsCenterErrorRestData_2_0, IGetOpsCenterErrorRestReturnValue_2_0>;
+	deleteOpsCenterErrorById: TRestAPIOperation<IDeleteOpsCenterErrorRestData_2_0, IDeleteOpsCenterErrorRestReturnValue_2_0>;
+	getOpsCenterMetrics: TRestAPIOperation<IGetOpsCenterMetricsRestData_2_0, IGetOpsCenterMetricsRestReturnValue_2_0>;
+	getOpsCenterMetricsConfig: TRestAPIOperation<void, IGetOpsCenterMetricsConfigRestReturnValue_2_0>;
+	getOpsCenterMetricsRange: TRestAPIOperation<IGetOpsCenterMetricsRangeRestData_2_0, IGetOpsCenterMetricsRangeRestReturnValue_2_0>;
+	getOpsCenterObservationConfig: TRestAPIOperation<void, IGetOpsCenterObservationConfigRestReturnValue_2_0>;
+	setupOpsCenterObservationConfig: TRestAPIOperation<void, ISetupOpsCenterObservationConfigRestReturnValue_2_0>;
+	patchOpsCenterObservationConfig: TRestAPIOperation<IPatchOpsCenterObservationConfigRestData_2_0, IPatchOpsCenterObservationConfigRestReturnValue_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>;
 export declare type TResourceAPIVersionType<T> = T extends {
 	versions: {
 		resources: "2.0";
@@ -22395,6 +22696,11 @@ export declare type TAnalyticsAPIVersionType<T> = T extends {
 		analytics: "2.0";
 	};
 } ? AnalyticsAPIGroup_2_0 : AnalyticsAPIGroup_2_0;
+export declare type TAIOpsCenterAPIVersionType<T> = T extends {
+	versions: {
+		aiops: "1.0";
+	};
+} ? AIOpsCenterAPIGroup_2_0 : AIOpsCenterAPIGroup_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>;