@cognigy/rest-api-client 4.99.0 → 2025.10.0

package/types/index.d.ts

@@ -2114,7 +2114,8 @@ declare const handoverProviders: readonly [
 	"liveAgent",
 	"genesysCloud",
 	"genesysCloudOM",
-	"eightByEight"
+	"eightByEight",
+	"salesforceMIAW"
 ];
 export declare type THandoverProvider = typeof handoverProviders[number];
 export interface IHandoverSettings {
@@ -2391,6 +2392,14 @@ export interface IEndpointTranslationSettings {
 	alwaysRemoveNoTranslateMarker: boolean;
 	setInputLanguageOnExecutionCount: number;
 }
+export interface ISipConnectivityInfo {
+	realm: string;
+	username: string;
+	password: string;
+	applicationSid: string;
+	wsUri?: string;
+	clientSid: string;
+}
 export interface IEndpoint extends IEntityMeta {
 	channel: TChannelType;
 	/**
@@ -2402,6 +2411,10 @@ export interface IEndpoint extends IEntityMeta {
 	 * The ID of the Snapshot or Project to target
 	 */
 	entrypoint: TMongoId;
+	/**
+	 * The custom icon for the endpoint.
+	 */
+	customIcon: string;
 	/** The URL Token we publish on the endpoints and use to retrieve the correct endpoint configurations */
 	URLToken: string;
 	/** The name of the endpoint resource */
@@ -2417,8 +2430,8 @@ export interface IEndpoint extends IEntityMeta {
 	 */
 	useConversations: boolean;
 	/**
-	* Whether to mask sensitive IP address in input object and analytics data for this endpoint
-	*/
+	 * Whether to mask sensitive IP address in input object and analytics data for this endpoint
+	 */
 	maskIPAddress: boolean;
 	/**
 	 * Whether to mask sensitive data in analytics for this endpoint
@@ -2473,6 +2486,14 @@ export interface IEndpoint extends IEntityMeta {
 	 * with those of the Agent */
 	overrideSnapshotConnections: boolean;
 	fileStorageSettings: IFileStorageSettings;
+	/** Whether to use the webrtc application exists for this endpoint */
+	webrtcClient?: boolean;
+	sipConnectivityInfo?: ISipConnectivityInfo;
+	/** The label of the webrtc widget */
+	webrtcWidgetConfig?: {
+		label: string;
+		active: boolean;
+	};
 }
 export interface IGraphEndpoint {
 	type: "endpoint";
@@ -2666,8 +2687,14 @@ export interface IVoiceGatewayEndpointSettings extends IEndpointSessionSettings
 	failover?: ICallEventFailoverSettings;
 	genericSettings?: IVGGenericSettings;
 	isFeatureAccmEnabled?: boolean;
+	/**
+ * Control the privacy notice of the Webrtc Widget
+ */
+	privacyNotice: Omit<IWebchat3EndpointPrivacyNoticeSettings, "title"> & {
+		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 | 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 | {};
 export declare type TAvayaVoice = "man" | "woman" | string;
 declare const avayaSttTtsLanguages: readonly [
 	"cy-GB",
@@ -4289,6 +4316,9 @@ export interface IGenesysBotConnectorEndpointSettings {
 export interface INiceCXOneEndpointSettings {
 	verifyToken: string;
 }
+export interface INiceCXOneAAHEndpointSettings {
+	niceCXOneAAHConnection: string;
+}
 declare const arrayNLUConnectorType_2_0: readonly [
 	"alexa",
 	"dialogflow",
@@ -4336,7 +4366,8 @@ declare const generativeAIModels: readonly [
 	"text-embedding-3-large",
 	"text-embedding-ada-002",
 	"luminous-embedding-128",
-	"amazon.titan-embed-text-v2:0"
+	"amazon.titan-embed-text-v2:0",
+	"Pharia-1-Embedding-4608"
 ];
 /**
  * @openapi
@@ -4354,6 +4385,7 @@ declare const generativeAIModels: readonly [
  *         - text-embedding-ada-002
  *         - luminous-extended-control
  *         - luminous-embedding-128
+ *         - Pharia-1-Embedding-4608
  *         - claude-v1-100k
  *         - claude-instant-v1
  *         - claude-3-opus-20240229
@@ -6777,6 +6809,10 @@ export interface IIndexEndpointsRestData_2_0 extends IRestPagination<IEndpointIn
 }
 export interface IIndexEndpointsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IEndpointIndexItem_2_0> {
 }
+export interface IWebrtcWidgetConfig {
+	label: string;
+	active: boolean;
+}
 /**
  * @openapi
  *
@@ -7232,6 +7268,11 @@ export interface IEndpoint_2_0 {
 	overrideSnapshotConnections: boolean;
 	fileStorageSettings: IEndpointFileStorageSettings_2_0;
 	orgDataPrivacySettings?: IEndpoitOrgDataPrivacySettings_2_0;
+	/** Whether to use the webrtc application exists for this endpoint */
+	webrtcClient?: boolean;
+	sipConnectivityInfo?: ISipConnectivityInfo;
+	/** The label of the webrtc widget */
+	webrtcWidgetConfig?: IWebrtcWidgetConfig;
 }
 export interface ITransformerFunction_2_0 {
 	/**
@@ -7389,6 +7430,7 @@ export interface IReadEndpointRestData_2_0 extends IReadEndpointRestDataParams_2
 export interface IReadEndpointRestReturnValue_2_0 extends IEndpoint_2_0 {
 }
 export interface IUpdateEndpointRestDataBody_2_0 extends Partial<Omit<IEndpoint_2_0, keyof IEntityMeta | "URLToken">> {
+	createWebrtcClient?: boolean;
 }
 export interface IUpdateEndpointRestDataParams_2_0 {
 	endpointId: string;
@@ -7399,6 +7441,7 @@ export interface IUpdateEndpointRestReturnValue_2_0 {
 }
 export interface IDeleteEndpointRestDataParams_2_0 {
 	endpointId: string;
+	channelType?: TChannelType;
 }
 export interface IDeleteEndpointRestData_2_0 extends IDeleteEndpointRestDataParams_2_0 {
 }
@@ -10264,10 +10307,16 @@ export interface IAzureOpenAIProviderOauth2Fields {
 	oauthUrl: string;
 	scope: string;
 }
+export interface IAlephAlphaProviderFields {
+	token: string;
+}
 export interface IAwsBedrockProviderFields {
 	accessKeyId: string;
 	secretAccessKey: string;
 }
+export interface IAwsBedrockIamProviderFields {
+	roleArn: string;
+}
 export interface IParams {
 	[key: string]: any;
 }
@@ -10300,7 +10349,7 @@ export interface IProviderOauth2Fields extends IAzureOpenAIProviderOauth2Fields
 }
 export interface ISearchLLMCredentials {
 	provider: TGenerativeAIProviders;
-	connectionFields: IAzureOpenAIProviderFieldsV2 | IProviderOauth2Fields | IAwsBedrockProviderFields;
+	connectionFields: IAzureOpenAIProviderFieldsV2 | IProviderOauth2Fields | IAwsBedrockProviderFields | IAwsBedrockIamProviderFields | IAlephAlphaProviderFields;
 	providerMetaData: IAzureOpenAIMeta;
 }
 export interface ISearchTagsData {
@@ -10440,6 +10489,38 @@ export interface IGoalEscalations extends IGoalAnalyticsData, IAnalyticsEndpoint
 export interface IEndpointSettings {
 	isFeatureAccmEnabled?: boolean;
 }
+export interface IChartExecutableNode<C extends INodeFunctionBaseParams = INodeFunctionBaseParams> extends IProjectScope, IOrganisationScope {
+	id: string;
+	_id?: string;
+	type: string;
+	label?: string;
+	extension: string;
+	behavior: {
+		stopping: boolean;
+	};
+	fields: INodeFieldSet;
+	children: string[];
+	next: string | null;
+	config: C["config"];
+	/**
+	 * Whether the node contain trustedCode.
+	 * Our cognigy nodes have trustedCodes - custom modules do not
+	 * have trusted-codes by default. This determines whether the nodes
+	 * function is executed in service-ai or service-execution.
+	 */
+	trustedCode: boolean;
+	pathToPackageExecutable: string;
+	/**
+	 * Whether the node is a standard
+	 * Cognigy node, e.g. a sendText node.
+	 */
+	isCognigy: boolean;
+	/**
+	 * Whether the node is disabled
+	 */
+	isDisabled: boolean;
+	analyticsLabel?: string;
+}
 export interface IGetConversationTranscriptParams {
 	turnLimit: number;
 }
@@ -10482,6 +10563,11 @@ export interface IRephraseSentenceWithAIOptions {
 	answer?: string;
 }
 export declare type TBrainSessionState = Partial<Pick<ISessionState, "frustration" | "lastFlowPath" | "apps" | "lastConversationEntries" | "analytics" | "lastToolCall" | "tokenUsage">>;
+export declare type TNodeAnalyticsParams = {
+	nodeId: IChartExecutableNode["id"];
+	nodeLabel: IChartExecutableNode["label"];
+	nodeType: IChartExecutableNode["type"];
+};
 export interface IActions {
 	addConditionalEntrypoint?: (actions: IActions, flowId: string) => (addConditionalEntrypointParams: IAddConditionalEntrypointParams) => void;
 	addHandoverInactivityTimer?: (params: {
@@ -10555,7 +10641,7 @@ export interface IActions {
 	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;
-	runGenerativeAIPrompt?: (options: IRunGenerativeAIPromptOptions, useCase: TGenerativeAIUseCases) => Promise<any>;
+	runGenerativeAIPrompt?: (options: IRunGenerativeAIPromptOptions, useCase: TGenerativeAIUseCases, nodeAnalyticsParams?: TNodeAnalyticsParams) => Promise<any>;
 	resetContext?: () => object;
 	resetFormBrain?: () => Promise<void>;
 	resetState?: () => Promise<string>;
@@ -10593,7 +10679,7 @@ export interface IActions {
 	thinkV2?: (nodeId: string) => (text: string, data: any) => void;
 	trackAnalyticsStep?: (stepLabel: string) => (trackArgs?: ITrackAnalyticsStepsArguments) => void;
 	updateProfile?: (profileSchemaField: string, value: any) => Promise<any>;
-	knowledgeSearch: (data: IKnowledgeSearchData) => Promise<IKnowledgeSearchReturnValue>;
+	knowledgeSearch: (data: IKnowledgeSearchData, nodeAnalyticsParams?: TNodeAnalyticsParams) => Promise<IKnowledgeSearchReturnValue>;
 	matchPattern: (patternType: IPatternTypes, phrase: string, locale?: string) => IPatternMatchResult;
 	getAgentAssistConfigId: () => string;
 	getNluEmbeddingCredentials: () => INluEmbeddingCredentials;
@@ -11231,7 +11317,8 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
 	getAppSessionPin: () => Promise<string>;
 	validateDatepickerFunctionInSecureContext?: (codeToValidate: string) => string | null;
 	completeGoal: (goal: string) => void;
-	knowledgeSearch: (data: IKnowledgeSearchData) => Promise<IKnowledgeSearchReturnValue>;
+	knowledgeSearch: (data: IKnowledgeSearchData, nodeAnalyticsParams?: TNodeAnalyticsParams) => Promise<IKnowledgeSearchReturnValue>;
+	runGenerativeAIPrompt: (options: IRunGenerativeAIPromptOptions, useCase: TGenerativeAIUseCases, nodeAnalyticsParams?: TNodeAnalyticsParams) => Promise<any>;
 	matchPattern: (patternType: IPatternTypes, phrase: string, locale?: string) => IPatternMatchResult;
 	getAgentAssistConfigId: () => string;
 	countGPTTokens: (prompt: string) => number;
@@ -11264,38 +11351,6 @@ export interface INodeExecutionCognigyObject extends IExecutionObjects {
 	api: INodeExecutionAPI;
 	flowReferenceId?: string;
 }
-export interface IChartExecutableNode<C extends INodeFunctionBaseParams = INodeFunctionBaseParams> extends IProjectScope, IOrganisationScope {
-	id: string;
-	_id?: string;
-	type: string;
-	label?: string;
-	extension: string;
-	behavior: {
-		stopping: boolean;
-	};
-	fields: INodeFieldSet;
-	children: string[];
-	next: string | null;
-	config: C["config"];
-	/**
-	 * Whether the node contain trustedCode.
-	 * Our cognigy nodes have trustedCodes - custom modules do not
-	 * have trusted-codes by default. This determines whether the nodes
-	 * function is executed in service-ai or service-execution.
-	 */
-	trustedCode: boolean;
-	pathToPackageExecutable: string;
-	/**
-	 * Whether the node is a standard
-	 * Cognigy node, e.g. a sendText node.
-	 */
-	isCognigy: boolean;
-	/**
-	 * Whether the node is disabled
-	 */
-	isDisabled: boolean;
-	analyticsLabel?: string;
-}
 export interface INodeFunctionInputOptions {
 	handledIntentReconfirmation?: boolean;
 	nluLanguage?: TNluLanguage;
@@ -16077,6 +16132,7 @@ export interface IVoiceConfigParams {
 	sttVadMode: number;
 	sttVadVoiceMs: number;
 	sttLabel: string;
+	sttListenDuringPrompt: boolean;
 	ttsDisableCache: boolean;
 	ttsVoice: string;
 	ttsLanguage: string;
@@ -16087,6 +16143,7 @@ export interface IVoiceConfigParams {
 	azureSpeechRecognitionMode: string;
 	azureEnableAudioLogging: boolean;
 	azureHintsBoost: number;
+	azureProfanityOption: "masked" | "removed" | "raw";
 	googleDisablePunctuation: boolean;
 	googleInteractionType: string;
 	googleHintsBoost: number;