@cognigy/rest-api-client 4.96.0 → 4.98.0

package/types/index.d.ts

@@ -59,7 +59,11 @@ export interface IOAuth2Authentication {
 	 */
 	clientSecret: string;
 }
-export declare type TAuthenticationCredentials = IApiKeyAuthentication | IBasicAuthentication | IOAuth2Authentication;
+export interface IJwtTokenAuthentication {
+	type: "JWT";
+	token: string;
+}
+export declare type TAuthenticationCredentials = IApiKeyAuthentication | IBasicAuthentication | IOAuth2Authentication | IJwtTokenAuthentication;
 export interface ILoginByPasswordParameters {
 	type: "password";
 	/**
@@ -449,6 +453,7 @@ declare const projectWidePermissions: readonly [
 	"memberDetails",
 	"members",
 	"goals",
+	"handoverProviders",
 	"nluConnectors",
 	"packages",
 	"playbooks",
@@ -927,6 +932,7 @@ declare const arrayTResourceType: readonly [
 	"flowSettings",
 	"flowState",
 	"function",
+	"handoverProvider",
 	"intent",
 	"intentDefaultReply",
 	"intentLearningSentence",
@@ -1027,6 +1033,7 @@ declare const projectWideRoles: readonly [
 	"followUser",
 	"function_admin",
 	"function_editor",
+	"handoverProviderAdmin",
 	"intents",
 	"knowledgeAdmin",
 	"large_language_model_admin",
@@ -1197,6 +1204,8 @@ export interface IOrganisationWideAcl {
  *               $ref: '#/components/schemas/ICrudPermissions'
  *             flows:
  *               $ref: '#/components/schemas/ICrudPermissions'
+ *             handoverProviders:
+ *               $ref: '#/components/schemas/ICrudPermissions'
  *             intents:
  *               $ref: '#/components/schemas/ICrudPermissions'
  *             largeLanguageModels:
@@ -1575,6 +1584,9 @@ export interface AuthenticationAPI {
 	webfinger: TRestAPIOperation<IWebfingerRestData, IWebfingerRestReturnValue>;
 	getAuthorizationCode?: (data: IGetAuthorizationCodeParameters) => Promise<IGetAuthorizationCodeResponse>;
 	exchangeOneTimeTokenForRefreshToken: TRestAPIOperation<IExchangeOneTimeTokenForRefreshTokenRestData_2_0, IExchangeOneTimeTokenForRefreshTokenRestReturnValue_2_0>;
+	generateManagementUIAuthToken: TRestAPIOperation<void, {
+		token: string;
+	}>;
 }
 declare function AuthenticationAPI(instance: Base): AuthenticationAPI;
 export interface IHttpResponse {
@@ -2089,6 +2101,7 @@ declare const handoverProviders: readonly [
 	"rce",
 	"chatwoot",
 	"salesforce",
+	"salesforceMIAW",
 	"liveAgent",
 	"genesysCloud",
 	"genesysCloudOM",
@@ -2112,7 +2125,7 @@ declare const copilotType: readonly [
 	"whisper"
 ];
 export declare type TCopilotType = typeof copilotType[number];
-export declare type TProviderSettings = IRCEHandoverSettings | IChatwootHandoverSettings | ICognigyHandoverSettings | ISalesForceHandoverSettings | ILiveAgentHandoverSettings | IEightByEightHandoverSettings | IGenesysCloudHandoverSettings | IGenesysCloudOMHandoverSettings;
+export declare type TProviderSettings = IRCEHandoverSettings | IChatwootHandoverSettings | ICognigyHandoverSettings | ISalesForceHandoverSettings | ISalesforceMIAWHandoverSettings | ILiveAgentHandoverSettings | IEightByEightHandoverSettings | IGenesysCloudHandoverSettings | IGenesysCloudOMHandoverSettings;
 export interface IRCEHandoverSettings {
 	/**
 	 * Whether to forward all conversations
@@ -2130,6 +2143,8 @@ export interface IRCEHandoverSettings {
 	/**
 	 * The API access token
 	 * you can create within RCE
+	 *
+	 * @deprecated It will be removed in the future, used if rceConnection is not set
 	 */
 	apiAccessToken: string;
 	/**
@@ -2140,6 +2155,8 @@ export interface IRCEHandoverSettings {
 	/**
 	 * The access token for your
 	 * rce source sdk source
+	 *
+	 * @deprecated It will be removed in the future, used if rceConnection is not set
 	 */
 	realtimeAccessToken: string;
 	/**
@@ -2150,6 +2167,8 @@ export interface IRCEHandoverSettings {
 	/**
 	 * The secret used to secure
 	 * webhooks in RCE
+	 *
+	 * @deprecated It will be removed in the future, used if rceConnection is not set
 	 */
 	webhookSecret: string;
 	/**
@@ -2162,6 +2181,10 @@ export interface IRCEHandoverSettings {
 	* as the 'bot category' within RCE
 	*/
 	agentCategoryId: string;
+	/**
+	 * The connection id of the RCE connection to retrieve webhook secret from
+	 */
+	rceConnection: string;
 }
 export interface IEightByEightHandoverSettings {
 	/**
@@ -2175,6 +2198,8 @@ export interface IEightByEightHandoverSettings {
 	/**
 	 * The API access token
 	 * you can create within 8x8
+	 *
+	 * @deprecated It will be removed in the future, used if eightByEightConnection is not set
 	 */
 	apiKey: string;
 	/**
@@ -2189,10 +2214,17 @@ export interface IEightByEightHandoverSettings {
 	 * is therefore set to 'true'
 	 */
 	forwardOnlyHandoverConversations: true;
+	/**
+	 * The connection id of the 8x8 connection to retrieve apiKey from
+	 */
+	eightByEightConnection: string;
 }
 export interface IChatwootHandoverSettings {
 	baseUrl: string;
 	accountId: string;
+	/**
+	 * @deprecated It will be removed in the future, used if chatwootConnection is not set
+	 */
 	apiKey: string;
 	chatwootInboxId: string;
 	/**
@@ -2202,10 +2234,17 @@ export interface IChatwootHandoverSettings {
 	 * is therefore set to 'true'
 	 */
 	forwardOnlyHandoverConversations: true;
+	/**
+	 * The connection id of the Chatwoot connection to retrieve apiKey secret from
+	 */
+	chatwootConnection: string;
 }
 export interface ILiveAgentHandoverSettings {
 	baseUrl: string;
 	accountId: string;
+	/**
+	 * Used for legacy and platform settings
+	 */
 	apiKey: string;
 	liveAgentInboxId: string;
 	/** if this is set to "true", the apiKey and baseUrl will be automatically picked from the system configuration as overrides */
@@ -2217,6 +2256,10 @@ export interface ILiveAgentHandoverSettings {
 	 * is therefore set to 'true'
 	 */
 	forwardOnlyHandoverConversations: true;
+	/**
+	 * The connection id of the Live Agent connection to retrieve apiKey secret from
+	 */
+	liveAgentConnection: string;
 }
 export interface ICognigyHandoverSettings {
 	/**
@@ -2244,6 +2287,22 @@ export interface ISalesForceHandoverSettings {
 	 */
 	forwardUnknownEventsToFlow: boolean;
 }
+export interface ISalesforceMIAWHandoverSettings {
+	baseUrl: string;
+	capabilitiesVersion: string;
+	organizationId: string;
+	esDeveloperName: string;
+	/**
+	 * Same as other clients, this setting cannot be changed,
+	 * and is therefore set to 'true'
+	 */
+	forwardOnlyHandoverConversations: true;
+	/**
+	 * Whether to forward any unknown event to the flow as an
+	 * agentInject message
+	 */
+	forwardUnknownEventsToFlow: boolean;
+}
 export interface IAgentAssistSettings {
 	copilotType: TCopilotType;
 	agentAssistFlowId: string;
@@ -2262,7 +2321,16 @@ export interface IGenesysCloudHandoverSettings {
 	queueId: string;
 	sessionDuration: number;
 	sendProfile: boolean;
-	oAuth2Connection: string;
+	/**
+	 * The connection id of the Genesys Cloud connection to retrieve clientId and clientSecret from
+	 *
+	 * @deprecated It will be removed in the future, used if genesysCloudConnection is not set
+	 */
+	oAuth2Connection?: string;
+	/**
+	 * The connection id of the Genesys Cloud connection to retrieve clientId and clientSecret from
+	 */
+	genesysCloudConnection: string;
 	/**
 	 * This setting cannot be changed,
 	 * since the cognigy client only supports
@@ -2277,8 +2345,12 @@ export interface IGenesysCloudOMHandoverSettings {
 	queue: string;
 	webhookSecret: string;
 	sendProfile: boolean;
-	clientId: string;
-	clientSecret: string;
+	clientId?: string;
+	clientSecret?: string;
+	/**
+	 * The connection id of the Genesys Cloud OM connection to retrieve clientId and clientSecret from
+	 */
+	genesysCloudOMConnection: string;
 	/**
 	 * This setting cannot be changed,
 	 * since the cognigy client only supports
@@ -2413,7 +2485,7 @@ export interface IGraphEndpointDependency {
  *   schemas:
  *     TChannelType:
  *       type: string
- *       example: webchat2
+ *       example: webchat3
  *       enum:
  *         - facebook
  *         - alexa
@@ -3494,6 +3566,10 @@ export interface IWebchat3EndpointHomeScreenSettings {
 	*/
 	startConversationButtonText: string;
 	previousConversations: {
+		/**
+		 * The text of the start new conversation button
+		*/
+		startNewConversationButtonText: string;
 		/**
 		 * Whether the previous conversations are enabled
 		*/
@@ -4262,6 +4338,7 @@ export declare type TGenerativeAIModels = (typeof generativeAIModels)[number];
 declare const generativeAIProviders: readonly [
 	"azureOpenAI",
 	"openAI",
+	"openAICompatible",
 	"alephAlpha",
 	"anthropic",
 	"googleVertexAI",
@@ -4292,6 +4369,7 @@ declare const generativeAIUseCases: readonly [
 	"gptPromptNode",
 	"aiEnhancedOutputs",
 	"sentimentAnalysis",
+	"designTimeGeneration",
 	"intentSentenceGeneration",
 	"flowGeneration",
 	"generateNodeOutput",
@@ -5082,7 +5160,7 @@ export interface IAgentTranslationSettings_2_0 {
  *         - google
  *         - aws
  */
-export declare type TAudioPreviewProvider_2_0 = "microsoft" | "google" | "aws" | null;
+export declare type TAudioPreviewProvider_2_0 = "microsoft" | "google" | "aws" | "deepgram" | null;
 /**
  * @openapi
  *
@@ -5126,6 +5204,9 @@ export interface IAudioPreviewSettings_2_0 {
 		aws: {
 			connectionId: string;
 		};
+		deepgram: {
+			connectionId: string;
+		};
 	};
 }
 /**
@@ -5138,6 +5219,7 @@ export interface IAudioPreviewSettings_2_0 {
  *       description: Supported Generative AI Providers
  *       enum:
  *         - openAI
+ *         - openAICompatible
  *         - azureOpenAI
  *         - anthropic
  *         - googleVertexAI
@@ -5159,6 +5241,8 @@ export declare type TGenerativeAIProviders_2_0 = TGenerativeAIProviders;
  *         useCasesSettings:
  *           type: object
  *           properties:
+ *             designTimeGeneration:
+ *               $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
  *             intentSentenceGeneration:
  *               $ref: '#/components/schemas/IGenerativeAIMeta_2_0'
  *             aiEnhancedOutputs:
@@ -7437,6 +7521,7 @@ export interface ICreatePlaybookRestDataQuery_2_0 {
 	resourceId?: string;
 }
 export interface ICreatePlaybookRestDataBody_2_0 extends IProjectScope, Partial<Omit<IPlaybook_2_0, keyof IEntityMeta>> {
+	resourceType?: TResourceType;
 }
 export interface ICreatePlaybookRestData_2_0 extends ICreatePlaybookRestDataBody_2_0, ICreatePlaybookRestDataQuery_2_0 {
 }
@@ -8560,6 +8645,11 @@ export interface IGraphConnection {
 }
 export interface IOpenAIMeta {
 	customModel?: string;
+	baseCustomUrl?: string | null;
+}
+export interface IOpenAICompatibleMeta {
+	customModel: string;
+	baseCustomUrl: string;
 }
 export interface IAlephAlphaMeta {
 	customModel?: string;
@@ -8617,6 +8707,7 @@ export interface ILargeLanguageModel extends IEntityMeta, IGlobalResource {
 	googleVertexAI?: IGoogleVertexAIMeta;
 	googleGemini?: IGoogleGeminiMeta;
 	openAI?: IOpenAIMeta;
+	openAICompatible?: IOpenAICompatibleMeta;
 	alephAlpha?: IAlephAlphaMeta;
 	anthropic?: IAnthropicMeta;
 	awsBedrock?: IAwsBedrockMeta;
@@ -8746,6 +8837,8 @@ export interface IHandoverNodeParams extends INodeFunctionBaseParams {
 		quickReply: string;
 		chatwootInboxId: string;
 		liveAgentInboxId: string;
+		handoverProviderConfig: object;
+		handoverProvider: string;
 	};
 }
 export interface IHttpBasicAuthConnectionFields {
@@ -8943,7 +9036,8 @@ export declare type TDebugEventPayload = IInputChangedEventPayload | IContextCha
 declare const audioPreviewProviders: readonly [
 	"microsoft",
 	"google",
-	"aws"
+	"aws",
+	"deepgram"
 ];
 export declare type TAudioPreviewProvider = typeof audioPreviewProviders[number];
 /**
@@ -8955,6 +9049,7 @@ export declare type TAudioPreviewProvider = typeof audioPreviewProviders[number]
  *       properties:
  *         useCase:
  *           enum:
+ *             - designTimeGeneration
  *             - intentSentenceGeneration
  *             - aiEnhancedOutputs
  *             - lexiconGeneration
@@ -9265,6 +9360,8 @@ export interface IHandoverRequestStatus {
 }
 export interface IHandoverNodeV2Params extends INodeFunctionBaseParams {
 	config: {
+		handoverProvider: THandoverProvider | "legacyEndpoint" | null;
+		handoverProviderConfig: Record<string, any>;
 		text: string;
 		cancelIntent: string;
 		quickReply: string;
@@ -9278,10 +9375,6 @@ export interface IHandoverNodeV2Params extends INodeFunctionBaseParams {
 		buttonId: string;
 		salesforcePrechatDetails: object[];
 		salesforcePrechatEntities: object[];
-		buttonIdMIAW: string;
-		sendTranscriptAsFirstMessageMIAW: boolean;
-		salesforcePrechatDetailsMIAW: object[];
-		salesforcePrechatEntitiesMIAW: object;
 		eightByEightChannelId: string;
 		eightByEightQueueId: string;
 		eightByEightJSONProps: object;
@@ -9328,6 +9421,8 @@ export interface ICheckAgentAvailabilityNodeParams extends INodeFunctionBasePara
 		abortOnError: boolean;
 		errorLogging: "none" | "basic" | "full";
 		logWarning: string;
+		checkAgentAvailabilityProvider: THandoverProvider | "legacyEndpoint" | null;
+		checkAgentAvailabilityConfig: Record<string, any>;
 	};
 }
 export interface ITriggerFunctionNodeParams extends INodeFunctionBaseParams {
@@ -9352,6 +9447,8 @@ export interface IVoiceConfigParams {
 	ttsLanguage: string;
 	ttsVendor: TVoiceGateway2TTSVendor | "none";
 	ttsModel: string;
+	ttsLabel: string;
+	ttsDisableCache: boolean;
 }
 declare const contactProfileOptions: readonly [
 	"none",
@@ -9439,6 +9536,7 @@ export interface ISayNodeConfigParams {
 export interface ISayNodeConfig extends INodeWithAiRephraseConfig {
 	say: ISayNodeConfigParams;
 	handoverOutput: ISayNodeSettings["liveAgentSettings"]["outputDestination"];
+	preventTranscript: boolean;
 }
 export interface ISayParams extends INodeFunctionBaseParams {
 	config: ISayNodeConfig;
@@ -9504,6 +9602,7 @@ export interface IQuestionNodeSharedConfig extends INodeWithAiRephraseConfig {
 	maxExecutionDiff: number;
 	resultLocation: string;
 	skipRepromptOnIntent: boolean;
+	preventTranscript: boolean;
 	escalateAnswersAction: "none" | "goto" | "execute" | "skip" | "text" | "handover";
 	escalateAnswersThreshold: number;
 	escalateAnswersGotoTarget: string;
@@ -10441,6 +10540,10 @@ export interface IActions {
 	setTimezoneOffset?: (offset: number | string) => void;
 	setTranslationSettings?: (translationSettings: IEndpointTranslationSettings) => void;
 	switchFlow?: (id: string, text: string, data: any, version?: number, absorbContext?: boolean) => void;
+	/**
+	 * @deprecated since 4.98.0
+	 * Use thinkV2 instead
+	 * */
 	think?: (nodeId: string) => (text: string, data: any) => void;
 	thinkV2?: (nodeId: string) => (text: string, data: any) => void;
 	trackAnalyticsStep?: (stepLabel: string) => (trackArgs?: ITrackAnalyticsStepsArguments) => void;
@@ -10942,6 +11045,10 @@ export interface ISetStateNodeParams extends INodeFunctionBaseParams {
 		};
 	};
 }
+/**
+ * @deprecated since 4.98.0.
+ * Use THINK_V2 instead
+ */
 export interface IThinkNodeParams extends INodeFunctionBaseParams {
 	config: {
 		thinkType: "default" | "intent";
@@ -10994,6 +11101,10 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
 	parseCognigyScriptText: (text: string) => string;
 	parseCognigyScriptResultLocation?: (text: string) => any;
 	evaluateRule: (rule: IRule) => boolean;
+	/**
+	 * @deprecated since 4.98.0.
+	 * Use thinkV2 instead
+	 * */
 	think: (text: string, data: {
 		[key: string]: any;
 	}) => void;
@@ -11084,6 +11195,10 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
 	updateSessionStateValues(values: Partial<ISessionState>): void;
 	getLLMTokenUsageForSession(): TSessionUsageInformation | null;
 	loadSessionState: () => Promise<Partial<ISessionStateWithoutMeta>>;
+	emitToOpsCenter: (params: {
+		title: string;
+		subComponent?: string;
+	}) => void;
 }
 export interface INodeExecutionCognigyObject extends IExecutionObjects {
 	api: INodeExecutionAPI;
@@ -11252,10 +11367,13 @@ export interface INodeDependencies {
 declare const nodeFieldTypes: readonly [
 	"adaptivecard",
 	"agentAssistConfig",
+	"aiAgentSelect",
 	"appTemplate",
 	"backgroundSelector",
 	"caseNode",
 	"checkbox",
+	"checkAgentAvailabilityProvider",
+	"checkAgentAvailabilityConfig",
 	"chipInput",
 	"code",
 	"cognigyLLMText",
@@ -11270,16 +11388,16 @@ declare const nodeFieldTypes: readonly [
 	"flow",
 	"flowNode",
 	"function",
+	"goalAndStepsSelect",
+	"handoverProvider",
+	"handoverProviderConfig",
 	"json",
 	"keyValuePairs",
-	"toolParameters",
+	"knowledgeSourceTags",
 	"knowledgeStore",
 	"knowledgeStoreSelect",
-	"knowledgeSourceTags",
-	"llmSelect",
-	"aiAgentSelect",
-	"goalAndStepsSelect",
 	"lexicon",
+	"llmSelect",
 	"localeField",
 	"node",
 	"number",
@@ -11299,6 +11417,7 @@ declare const nodeFieldTypes: readonly [
 	"textArray",
 	"time",
 	"toggle",
+	"toolParameters",
 	"ttsSelect",
 	"typescript",
 	"xml"
@@ -11717,7 +11836,247 @@ export interface IGraphGoal {
 	name: string;
 	properties: Pick<IGoal, "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy">;
 }
-export declare type IGraphResourceWithReferenceId = IGraphAgentAssistConfig | IGraphConnection | IGraphFlow | IGraphFunction | IGraphLargeLanguageModel | IGraphLexicon | IGraphLocale | IGraphNLUConnector | IGraphSnippet | IGraphAgentAssistConfig | IGraphKnowledgeStore | IGraphGoal | IGraphAiAgent;
+declare const handoverServices: readonly [
+	"cognigy",
+	"none",
+	"rce",
+	"chatwoot",
+	"salesforce",
+	"liveAgent",
+	"genesysCloud",
+	"genesysCloudOM",
+	"eightByEight",
+	"salesforceMIAW"
+];
+export declare type THandoverService = typeof handoverServices[number];
+export declare type TServiceSettings = IRCEHandoverSettings | IChatwootHandoverSettings | ICognigyHandoverSettings | ISalesForceHandoverSettings | ILiveAgentHandoverSettings | IEightByEightHandoverSettings | IGenesysCloudHandoverSettings | IGenesysCloudOMHandoverSettings | ISalesforceMIAWHandoverSettings;
+export interface IHandoverServiceProperties {
+	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 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 interface IRCEHandoverSettings {
+	/**
+	 * Whether to forward all conversations
+	 * to the Service, or only the conversations
+	 * that trigger a handover. If this setting is true,
+	 * then we will only forward conversations were handover
+	 * was triggered.
+	 */
+	forwardOnlyHandoverConversations?: boolean;
+	/**
+	 * Indicates if queue updates should be enabled
+	 * to receive events about the estimated wait time
+	 */
+	getQueueUpdates?: boolean;
+	/**
+	 * The API access token
+	 * you can create within RCE
+	 */
+	apiAccessToken: string;
+	/**
+	 * The API URL to your
+	 * RCE installation
+	 */
+	baseApiUrl: string;
+	/**
+	 * The access token for your
+	 * rce source sdk source
+	 */
+	realtimeAccessToken: string;
+	/**
+	 * The endpoint URL of your
+	 * rce source sdk source
+	 */
+	realtimeEndpointUrl: string;
+	/**
+	 * The secret used to secure
+	 * webhooks in RCE
+	 */
+	webhookSecret: string;
+	/**
+	 * The ID of the category you use
+	 * as the 'bot category' within RCE
+	 */
+	botCategoryId: string;
+	/**
+	* The ID of the category you use
+	* as the 'bot category' within RCE
+	*/
+	agentCategoryId: string;
+}
+export interface IEightByEightHandoverSettings {
+	/**
+	 * The API access token
+	 * you can create within 8x8
+	 */
+	/**
+	 * The API URL to the 8x8 environment
+	 */
+	baseUrl: string;
+	/**
+	 * The API access token
+	 * you can create within 8x8
+	 */
+	apiKey: string;
+	/**
+	 * It is a key which has
+	 * to be included in the header
+	 */
+	apiTenant: string;
+	/**
+	 * This setting cannot be changed,
+	 * since the chatwoot client only supports
+	 * forwarding handover conversations. The value
+	 * is therefore set to 'true'
+	 */
+	forwardOnlyHandoverConversations: true;
+}
+export interface IChatwootHandoverSettings {
+	baseUrl: string;
+	accountId: string;
+	apiKey: string;
+	chatwootInboxId: string;
+	/**
+	 * This setting cannot be changed,
+	 * since the chatwoot client only supports
+	 * forwarding handover conversations. The value
+	 * is therefore set to 'true'
+	 */
+	forwardOnlyHandoverConversations: true;
+}
+export interface ILiveAgentHandoverSettings {
+	baseUrl: string;
+	accountId: string;
+	apiKey: string;
+	liveAgentInboxId: string;
+	/** if this is set to "true", the apiKey and baseUrl will be automatically picked from the system configuration as overrides */
+	usePlatformToken: boolean;
+	/**
+	 * This setting cannot be changed,
+	 * since the chatwoot client only supports
+	 * forwarding handover conversations. The value
+	 * is therefore set to 'true'
+	 */
+	forwardOnlyHandoverConversations: true;
+}
+export interface ICognigyHandoverSettings {
+	/**
+	 * This setting cannot be changed,
+	 * since the cognigy client only supports
+	 * forwarding handover conversations. The value
+	 * is therefore set to 'true'
+	 */
+	forwardOnlyHandoverConversations: true;
+}
+export interface ISalesForceHandoverSettings {
+	apiVersion: string;
+	baseUrl: string;
+	organizationId: string;
+	deploymentId: string;
+	buttonId: string;
+	/**
+	 * Same as other clients, this setting cannot be changed,
+	 * and is therefore set to 'true'
+	 */
+	forwardOnlyHandoverConversations: true;
+	/**
+	 * Whether to forward any unknown event to the flow as an
+	 * agentInject message
+	 */
+	forwardUnknownEventsToFlow: boolean;
+}
+export interface IGenesysCloudHandoverSettings {
+	host: string;
+	organizationId: string;
+	deploymentId: string;
+	queue: string;
+	queueId: string;
+	sessionDuration: number;
+	sendProfile: boolean;
+	oAuth2Connection: string;
+	/**
+	 * This setting cannot be changed,
+	 * since the cognigy client only supports
+	 * forwarding handover conversations. The value
+	 * is therefore set to 'true'
+	 */
+	forwardOnlyHandoverConversations: true;
+}
+export interface IGenesysCloudOMHandoverSettings {
+	host: string;
+	deploymentName: string;
+	queue: string;
+	webhookSecret: string;
+	sendProfile: boolean;
+	clientId: string;
+	clientSecret: string;
+	/**
+	 * This setting cannot be changed,
+	 * since the cognigy client only supports
+	 * forwarding handover conversations. The value
+	 * is therefore set to 'true'
+	 */
+	forwardOnlyHandoverConversations: true;
+}
+export interface ISalesforceMIAWHandoverSettings {
+	baseUrl: string;
+	capabilitiesVersion: string;
+	organizationId: string;
+	esDeveloperName: string;
+	/**
+	 * Same as other clients, this setting cannot be changed,
+	 * and is therefore set to 'true'
+	 */
+	forwardOnlyHandoverConversations: true;
+	/**
+	 * Whether to forward any unknown event to the flow as an
+	 * agentInject message
+	 */
+	forwardUnknownEventsToFlow: boolean;
+}
+export interface IHandoverProvider {
+	_id: TMongoId;
+	referenceId: string;
+	organisationId: string;
+	serviceId: string;
+	service: THandoverService;
+	/** The referenceId of the locale to use */
+	localeId: string;
+	/** The name of the handover provider resource */
+	name: string;
+	createdAt: number;
+	lastChanged: number;
+	createdBy: TMongoId;
+	lastChangedBy: TMongoId;
+	properties: IHandoverProviderProperties[];
+	settings: IHandoverProviderSettings;
+}
+export interface IGraphHandoverProvider extends IHandoverProvider {
+	type: "handoverProvider";
+}
+export interface IHandoverProviderSettings {
+	service: THandoverService;
+	serviceSettings?: TServiceSettings;
+}
+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;
 export declare type IGraphResource = IGraphResourceWithReferenceId | IGraphResourceWithoutReferenceId;
 /**
@@ -16362,7 +16721,7 @@ export interface ICognigyNodes {
 }
 export interface IUploadFileRestDataQuery_2_0 extends IProjectScope {
 }
-export interface IUploadFileRestDataBody_2_0 {
+export interface IUploadFileRestDataBody_2_0 extends Pick<IGlobalResource, "resourceLevel"> {
 	file: File | Buffer;
 }
 export interface IUploadFileRestData_2_0 extends IUploadFileRestDataBody_2_0, IUploadFileRestDataQuery_2_0 {
@@ -16685,6 +17044,11 @@ export interface IIndexAgentAssistConfigsRestReturnValue_2_0 extends ICursorBase
 }
 export interface IOpenAIMeta_2_0 {
 	customModel?: string;
+	baseCustomUrl?: string;
+}
+export interface IOpenAICompatibleMeta_2_0 {
+	customModel: string;
+	baseCustomUrl: string;
 }
 export interface IAnthropicMeta_2_0 {
 	customModel?: string;
@@ -16915,6 +17279,8 @@ export interface ILargeLanguageModel_2_0 extends IGlobalResource {
 	azureOpenAI?: IAzureOpenAIMeta_2_0;
 	/** Meta data for the OpenAI LLM */
 	openAI?: IOpenAIMeta_2_0;
+	/** Meta data for OpenAI Compatible LLMs */
+	openAICompatible?: IOpenAICompatibleMeta_2_0;
 	/** Meta Data for the AlephAlpha LLM */
 	alephAlpha?: IAlephAlphaMeta_2_0;
 	/** Meta data for the GoogleVertexAI connection */
@@ -17654,6 +18020,177 @@ export interface IDeleteGoalRestData_2_0 extends IDeleteGoalRestDataParams_2_0 {
 }
 export interface IDeleteGoalRestReturnValue_2_0 {
 }
+/**
+ * @openapi
+ *
+ * components:
+ *   schemas:
+ *     IHandoverProvider_2_0:
+ *       type: object
+ *       properties:
+ *         _id:
+ *           type: string
+ *           format: mongoId
+ *           description: The object id of the handover provider
+ *         referenceId:
+ *           type: string
+ *           description: The referenceId of the handover provider
+ *         organisationId:
+ *           type: string
+ *           description: The organisation Id associated with the handover provider
+ *         serviceId:
+ *           type: string
+ *           description: The id of the service
+ *         service:
+ *           type: string
+ *           description: The handover provider's specified service; e.g., Live Agent, Genesys
+ *         localeId:
+ *           type: string
+ *           description: The referenceId of the locale to use
+ *         name:
+ *           type: string
+ *           description: The name of the handover provider resource
+ *         createdAt:
+ *           type: integer
+ *           format: int64
+ *           description: Unix-timestamp when the entity was created initially
+ *         lastChangedAt:
+ *           type: integer
+ *           format: int64
+ *           description: Unix-timestamp when the entity was last modified
+ *         createdBy:
+ *           type: string
+ *           format: mongoId
+ *           description: Id of the user who created the entity initially
+ *         lastChangedBy:
+ *           type: string
+ *           format: mongoId
+ *           description: Id of the user who made the last modification
+ *         properties:
+ *           type: array
+ *           items:
+ *             type: object
+ *             description: Properties associated with the handover provider
+ *             additionalProperties:
+ *               type: string
+ *           description: A list of properties associated with the handover provider
+ *         settings:
+ *           type: object
+ *           description: Settings related to the handover provider
+ *           additionalProperties:
+ *             type: string
+ */
+export interface IHandoverProvider_2_0 {
+	_id: TMongoId;
+	referenceId: string;
+	organisationId: string;
+	serviceId: string;
+	service: THandoverService;
+	/** The referenceId of the locale to use */
+	localeId: string;
+	/** The name of the handover provider resource */
+	name: string;
+	createdAt: number;
+	lastChangedAt: number;
+	createdBy: TMongoId;
+	lastChangedBy: TMongoId;
+	properties: IHandoverProviderProperties[];
+	settings: IHandoverProviderSettings_2_0;
+}
+export interface IHandoverProviderSettings_2_0 {
+	service: THandoverService;
+	serviceSettings?: TServiceSettings;
+}
+export interface IIndexHandoverProvidersRestData_2_0 extends IRestPagination<IHandoverProvider_2_0>, Partial<IProjectScope> {
+}
+export interface IIndexHandoverProvidersRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IHandoverProvider_2_0> {
+}
+export interface ICreateHandoverProviderRestDataBody_2_0 extends IProjectScope, Partial<Omit<IHandoverProvider_2_0, keyof IEntityMeta | "URLToken">> {
+}
+export interface ICreateHandoverProviderRestDataQuery_2_0 {
+	resourceId?: string;
+}
+export interface ICreateHandoverProviderRestData_2_0 extends ICreateHandoverProviderRestDataBody_2_0, ICreateHandoverProviderRestDataQuery_2_0 {
+}
+export interface ICreateHandoverProviderRestReturnValue_2_0 extends IHandoverProvider_2_0 {
+}
+export interface IReadHandoverProviderRestDataParams_2_0 {
+	handoverProviderId: string;
+}
+export interface IReadHandoverProviderRestData_2_0 extends IReadHandoverProviderRestDataParams_2_0 {
+}
+export interface IReadHandoverProviderRestReturnValue_2_0 extends IHandoverProvider_2_0 {
+}
+export interface IUpdateHandoverProviderRestDataBody_2_0 extends Partial<Omit<IHandoverProvider_2_0, keyof IEntityMeta | "URLToken">> {
+}
+export interface IUpdateHandoverProviderRestDataParams_2_0 {
+	handoverProviderId: string;
+	projectId: string;
+}
+export interface IUpdateHandoverProviderRestData_2_0 extends IUpdateHandoverProviderRestDataBody_2_0, IUpdateHandoverProviderRestDataParams_2_0 {
+}
+export interface IUpdateHandoverProviderRestReturnValue_2_0 extends IHandoverProvider_2_0 {
+}
+export interface IDeleteHandoverProviderRestDataParams_2_0 {
+	handoverProviderId: string;
+	projectId: string;
+}
+export interface IDeleteHandoverProviderRestData_2_0 extends IDeleteHandoverProviderRestDataParams_2_0 {
+}
+export interface IDeleteHandoverProviderRestReturnValue_2_0 {
+}
+/**
+ * @openapi
+ *
+ * components:
+ *   schemas:
+ *     IHandoverService_2_0:
+ *       type: object
+ *       properties:
+ *         _id:
+ *           type: string
+ *           format: mongoId
+ *           description: The object id of the handover service
+ *         referenceId:
+ *           type: string
+ *           format: uuid
+ *           description: The referenceId of the handover service
+ *         version:
+ *           type: string
+ *           description: The version of the handover service
+ *         name:
+ *           type: string
+ *           description: The name of the handover service
+ *         serviceUrl:
+ *           type: string
+ *           format: uri
+ *           description: The service URL of the handover service
+ *         logoUrl:
+ *           type: string
+ *           format: uri
+ *           description: The logo URL of the handover service
+ *         properties:
+ *           type: array
+ *           items:
+ *             type: object
+ *             description: Properties associated with the handover service
+ *             additionalProperties:
+ *               type: string
+ *           description: A list of properties for the handover service
+ */
+export interface IHandoverService_2_0 {
+	_id: TMongoId;
+	referenceId: string;
+	version: string;
+	name: string;
+	serviceUrl: string;
+	logoUrl: string;
+	properties: IHandoverServiceProperties[];
+}
+export interface IIndexHandoverServicesRestData_2_0 extends IRestPagination<IHandoverService_2_0>, Partial<IProjectScope> {
+}
+export interface IIndexHandoverServicesRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IHandoverService_2_0> {
+}
 declare const uploadResumableTypes: readonly [
 	"snapshots",
 	"packages"
@@ -17808,7 +18345,11 @@ export interface IGenerateNluScoresRestReturnValue_2_0 {
  *               type: string
  *             ttsModel:
  *               type: string
- *           example: { "ttsVoice": "Xb7hH8MSUJpSbSDYk0k2", "ttsLanguage": "zh", "ttsVendor": "Elevenlabs", "ttsModel": "eleven_multilingual_v2" }
+ *             ttsLabel:
+ *               type: string
+ *             ttsDisableCache:
+ *               type: boolean
+ *           example: { "ttsVoice": "Xb7hH8MSUJpSbSDYk0k2", "ttsLanguage": "zh", "ttsVendor": "Elevenlabs", "ttsModel": "eleven_multilingual_v2", "ttsLabel": "microsoft US", "ttsDisableCache": false }
  *         enableVoiceConfigs:
  *           type: boolean
  *           description: Enables the use of voice configuration.
@@ -18047,6 +18588,12 @@ export interface ResourcesAPIGroup_2_0 {
 	readGoal: TRestAPIOperation<IReadGoalRestData_2_0, IReadGoalRestReturnValue_2_0>;
 	updateGoal: TRestAPIOperation<IUpdateGoalRestData_2_0, IUpdateGoalRestReturnValue_2_0>;
 	deleteGoal: TRestAPIOperation<IDeleteGoalRestData_2_0, IDeleteGoalRestReturnValue_2_0>;
+	indexHandoverServices: TRestAPIOperation<TRestAPIOptionalParameter<IIndexHandoverServicesRestData_2_0>, IIndexHandoverServicesRestReturnValue_2_0>;
+	indexHandoverProviders: TRestAPIOperation<TRestAPIOptionalParameter<IIndexHandoverProvidersRestData_2_0>, IIndexHandoverProvidersRestReturnValue_2_0>;
+	createHandoverProvider: TRestAPIOperation<ICreateHandoverProviderRestData_2_0, ICreateHandoverProviderRestReturnValue_2_0>;
+	readHandoverProvider: TRestAPIOperation<IReadHandoverProviderRestData_2_0, IReadHandoverProviderRestReturnValue_2_0>;
+	updateHandoverProvider: TRestAPIOperation<IUpdateHandoverProviderRestData_2_0, IUpdateHandoverProviderRestReturnValue_2_0>;
+	deleteHandoverProvider: TRestAPIOperation<IDeleteHandoverProviderRestData_2_0, IDeleteHandoverProviderRestReturnValue_2_0>;
 	indexPlaybooks: TRestAPIOperation<TRestAPIOptionalParameter<IIndexPlaybooksRestData_2_0>, IIndexPlaybooksRestReturnValue_2_0>;
 	batchPlaybooks: TRestAPIOperation<IBatchPlaybooksRestData_2_0, IBatchPlaybooksRestReturnValue_2_0>;
 	createPlaybook: TRestAPIOperation<ICreatePlaybookRestData_2_0, ICreatePlaybookRestReturnValue_2_0>;
@@ -18873,7 +19420,7 @@ export interface IProfile_2_0 {
  *           type: boolean
  *         privacy_policy:
  *           type: object
- *         goals:
+ *         tasks:
  *           type: array
  *           items:
  *             type: string
@@ -18900,7 +19447,7 @@ export interface IFlattenedProfile_2_0 {
 	prevent_data_collection: boolean;
 	accepted_gdpr: boolean;
 	privacy_policy: IProfilePrivacyPolicy;
-	goals?: string[];
+	tasks?: string[];
 	memories?: IMemory[];
 	firstname?: string;
 	lastname?: string;
@@ -19006,7 +19553,7 @@ export interface IProfileSchema_2_0 {
 		prevent_data_collection: "boolean";
 		accepted_gdpr: "boolean";
 		privacy_policy: "object";
-		goals: "object";
+		tasks: "object";
 		memories: "object";
 		[key: string]: "string" | "boolean" | "number" | "object";
 	};
@@ -21709,6 +22256,9 @@ export interface ManagementAPIGroup_2_0 {
 	impersonateUserManagement: TRestAPIOperation<IImpersonateUserRestManagementData_2_0, IImpersonateUserRestManagementReturnValue_2_0>;
 	createApiKeyManagement: TRestAPIOperation<ICreateApiKeyRestManagementData_2_0, ICreateApiKeyRestManagementReturnValue_2_0>;
 	createSystemMessage: TRestAPIOperation<ICreateSystemMessageRestData_2_0, ICreateSystemMessageRestReturnValue_2_0>;
+	generateAuthenticationToken: TRestAPIOperation<void, {
+		token: string;
+	}>;
 }
 declare function ManagementAPIGroup_2_0(instance: Base): ManagementAPIGroup_2_0;
 /**