@cognigy/rest-api-client 2025.22.0 → 2025.23.0

package/types/index.d.ts

@@ -4137,6 +4137,23 @@ export interface IWebchat3EndpointLayoutSettings {
 	 * Configure the width of the Webchat in px
 	 */
 	chatWindowWidth: number;
+	/**
+	 * The URL that links to the logo
+	 * we display as the chatbot icon when using bottom right position
+	 */
+	iconUrl: string;
+	/**
+	 * The animation to apply to the chatbot icon
+	 */
+	iconAnimation: string;
+	/**
+	 * The interval to apply to the chatbot icon animation when using bottom right position
+	 */
+	iconAnimationInterval: number;
+	/**
+	 * The speed to apply to the chatbot icon animation when using bottom right position
+	 */
+	iconAnimationSpeed: number;
 }
 export interface IWebchat3EndpointColorsSettings {
 	/**
@@ -5638,6 +5655,8 @@ export interface ISharedSettings_2_0 {
  *               example: "USD"
  *         knowledgeAISettings:
  *           $ref: '#/components/schemas/IKnowledgeAISettings_2_0'
+ *         piiDataRedactionSettings:
+ *           $ref: '#/components/schemas/IPiiDataRedactionSettings_2_0'
  *
  *     IAgentSettings_2_0:
  *       allOf:
@@ -5666,6 +5685,7 @@ export interface IAgentSettings_2_0 extends ISharedSettings_2_0 {
 		currency: string;
 	};
 	knowledgeAISettings: IKnowledgeAISettings_2_0;
+	piiDataRedactionSettings?: IPiiDataRedactionSettings_2_0;
 }
 /**
  * @openapi
@@ -5784,7 +5804,7 @@ export declare type TAudioPreviewProvider_2_0 = "microsoft" | "google" | "aws" |
 /**
  * The supporting optional fields are not shown in Open API documentation
  * as those are just place holders and not supported in iteration 1
-*/
+ */
 export interface IAudioPreviewSettings_2_0 {
 	provider: TAudioPreviewProvider_2_0;
 	connections: {
@@ -5887,6 +5907,39 @@ export interface IKnowledgeAISettings_2_0 {
 	fileExtractor: TFileExtractorOptions_2_0;
 	azureDIConnectionId?: string;
 }
+declare enum EPiiBehaviorType {
+	PREDEFINED_ALIAS = "predefined-alias",
+	CUSTOM_ALIAS = "custom-alias"
+}
+export declare type IRedactionBehavior = {
+	type: EPiiBehaviorType.PREDEFINED_ALIAS;
+	customAlias: null;
+} | {
+	type: EPiiBehaviorType.CUSTOM_ALIAS;
+	customAlias: string;
+};
+export declare type IRedactionScope = {
+	logs: boolean;
+	analytics: boolean;
+};
+export interface IPiiFieldSettings {
+	enabled: boolean;
+	behavior: IRedactionBehavior;
+	scope: IRedactionScope;
+	name: string;
+}
+export interface ICustomPatternSettings extends Omit<IPiiFieldSettings, "enabled"> {
+	regex: string;
+}
+export interface IPiiDataRedactionSettings_2_0 {
+	emailAddress: IPiiFieldSettings;
+	phoneNumber: IPiiFieldSettings;
+	creditCard: IPiiFieldSettings;
+	ssn: IPiiFieldSettings;
+	ipAddressV4: IPiiFieldSettings;
+	ipAddressV6: IPiiFieldSettings;
+	customTypes?: Record<string, ICustomPatternSettings>;
+}
 /**
  * @openapi
  *
@@ -6017,12 +6070,12 @@ export interface IMongoosePaginationPluginReturnValue<T = any> {
  *         total:
  *           type: integer
  *           example: 1
- *         next:
+ *         nextCursor:
  *           allOf:
  *             - $ref: '#/components/schemas/TMongoId'
  *           nullable: true
  *           example: 5ce7c2d833ea1e04d7e6c432
- *         previous:
+ *         previousCursor:
  *           allOf:
  *             - $ref: '#/components/schemas/TMongoId'
  *           nullable: true
@@ -10148,6 +10201,7 @@ export declare type ValueOf<T> = T[keyof T];
  * @param excludeDataOnlyMessagesFilter: (optional) the roles for which data only messages (emtpy text field) will be excluded if type is input/output
  * @param useTextAlternativeForLLM: (optional) if true, graphical outputs will be included in the transcript, either using the value from the graphical description / fallbackText field, or by converting the data where possible
  * @param includeTextAlternativeInTranscript: (optional) if true, the text alternative for LLM will be included in the transcript
+ * @param excludeUserEventMessages: (optional) if true, user event messages will be excluded from the transcript
  */
 export declare type TReadTranscriptOptions = {
 	limit: number;
@@ -10155,6 +10209,7 @@ export declare type TReadTranscriptOptions = {
 	excludeDataOnlyMessagesFilter?: (TranscriptRole.USER | TranscriptRole.AGENT | TranscriptRole.ASSISTANT)[];
 	useTextAlternativeForLLM?: boolean;
 	includeTextAlternativeInTranscript?: boolean;
+	excludeUserEventMessages?: boolean;
 };
 declare enum TranscriptRole {
 	ASSISTANT = "assistant",
@@ -10435,6 +10490,8 @@ export interface IAzureOpenAIProviderOauth2Fields {
 	clientSecret: string;
 	oauthUrl: string;
 	scope: string;
+	additionalHeaderName?: string;
+	additionalHeaderValue?: string;
 }
 export interface IAlephAlphaProviderFields {
 	token: string;
@@ -11752,7 +11809,7 @@ export declare type TNodeTagType = TCognigyNodeTagType | string;
 export interface INodeDescriptor<T extends INodeFunctionBaseParams = any, U extends string = string, FunctionParams extends INodeFunctionBaseParams = any> {
 	_id?: TMongoId;
 	type: U;
-	parentType?: string | null;
+	parentType?: string | string[] | null;
 	defaultLabel: string | INodeFieldTranslations;
 	summary?: string | INodeFieldTranslations;
 	appearance: INodeAppearance;
@@ -13292,14 +13349,6 @@ export interface IChart_2_0 {
  *         extension:
  *           type: string
  *           example: "@cognigy/basic-nodes"
- *           enum:
- *             - "@cognigy/basic-nodes"
- *             - "@cognigy/mongodb"
- *             - "@cognigy/mssql"
- *             - "@cognigy/smtp"
- *             - "@cognigy/voicegateway"
- *             - "@cognigy/microsoft"
- *             - "@cognigy/voiceGateway2"
  *         label:
  *           type: string
  *           example: A new Node
@@ -13361,6 +13410,7 @@ declare enum ConvertActionType {
 	UPDATED = "updated"
 }
 export declare type TConvertAction = (typeof ConvertActionType)[keyof typeof ConvertActionType];
+export declare type TNodeConversionMetadata = Record<string, TConvertAction>;
 export interface IChartNodeBase {
 	_id: TMongoId;
 	referenceId: string;
@@ -13408,7 +13458,7 @@ export interface IChartNodeInDB extends Omit<IChartNode, "config" | "preview" |
 }
 export interface IReadChartNodeRestDataQuery_2_0 {
 	preferredLocaleId?: string;
-	includeConversionMetadata?: boolean;
+	includeConversionMetadata?: string;
 }
 export declare type IReadChartNodeRestDataParams_2_0<P extends string = "resourceId"> = {
 	[key in P]: string;
@@ -13419,7 +13469,7 @@ export interface IReadChartNodeRestData_2_0 extends IReadChartNodeRestDataParams
 	resourceType: TChartableResourceType;
 }
 export interface IReadChartNodeRestReturnValue_2_0<T extends INodeFunctionBaseParams = any> extends IChartNode_2_0<T> {
-	conversionMetadata?: Record<TNodeFieldType, TConvertAction>;
+	conversionMetadata?: TNodeConversionMetadata;
 }
 export interface IReadChartRestData_2_0 extends IReadChartNodeRestDataQuery_2_0 {
 	resourceId: string;
@@ -14270,7 +14320,7 @@ export declare type IGetAiAgentJobAndToolsRestReturnValue_2_0 = IAiAgentJobNodeW
  */
 export interface INodeDescriptor_2_0 {
 	type: string;
-	parentType?: string;
+	parentType?: string | string[];
 	defaultLabel: string | INodeFieldTranslations;
 	summary: string | INodeFieldTranslations;
 	extension: string;
@@ -19966,6 +20016,10 @@ export interface IMemory {
 	timestamp: string;
 	text: string;
 }
+declare const profileTypes: readonly [
+	"simulator"
+];
+export declare type TProfileTypes = (typeof profileTypes)[number];
 /**
  * @openapi
  *
@@ -20079,6 +20133,10 @@ export interface IFlattenedProfile_2_0 {
  *           $ref: '#/components/schemas/IFlattenedProfile_2_0'
  *         active:
  *           type: boolean
+ *         type:
+ *           type: string
+ *           enum:
+ *             - simulator
  *         contactIds:
  *           type: array
  *           items:
@@ -20091,6 +20149,7 @@ export interface IFlattenedProfile_2_0 {
 export interface IProfileIndexItem_2_0 {
 	_id: TMongoId;
 	active: boolean;
+	type?: TProfileTypes;
 	profile: Partial<IFlattenedProfile_2_0>;
 	projectId: TMongoId;
 	lastChanged: number;
@@ -20946,10 +21005,14 @@ export interface IGetConversationCounterOrganisationRestReturnValue_3_0 {
  *           type: number
  *         processedCalls:
  *           type: number
+ *         billableCalls:
+ *           type: number
  */
 export interface ICallCounterPreAggregatedValue_3_0 {
 	/** The number of calls in the time-span */
 	processedCalls: number;
+	/** The number of billable calls in the time-span */
+	billableCalls: number;
 	/** The day, e.g., 1 for the first day in the month */
 	day: number;
 	/** The month of the year, e.g., 1 for January */
@@ -23492,6 +23555,7 @@ export interface IScheduleSimulationRestDataBody_2_0 {
 		largeLanguageModelReferenceId?: string;
 		userId?: string;
 		finalPing?: number;
+		data?: Record<string, unknown>;
 	};
 	projectReference: string;
 	numberOfExecutions: number;
@@ -23787,6 +23851,167 @@ export interface IGenerateBulkPersonaRestReturnValue_2_0 {
 		missionTypesCount: number;
 	};
 }
+/**
+ * POST /testing/beta/personas/from-transcript
+ *
+ * Create a scenario draft by analyzing a conversation transcript. The system uses LLM to extract user intent,
+ * conversation goals, and user characteristics from the transcript, then generates an appropriate persona package.
+ *
+ * The endpoint supports:
+ * - Fetching transcript via sessionId from analytics service (RPC call)
+ * - Direct transcript content via transcriptContent
+ * - Optional flow context for enhanced persona generation
+ * - Content safety validation (warnings only, non-blocking)
+ *
+ * Priority: If both sessionId and transcriptContent are provided, sessionId takes precedence.
+ *
+ * operationId: createScenarioFromTranscript
+ * tags: Personas
+ */
+export interface IGeneratePersonaFromTranscriptRestData_2_0 {
+	/**
+	 * Project reference for context identification (alternative to projectId query parameter)
+	 */
+	projectReference?: string;
+	/**
+	 * Session identifier to retrieve transcript from analytics service.
+	 * If provided, takes precedence over transcriptContent.
+	 */
+	sessionId?: string;
+	/**
+	 * Direct transcript content. Optional if sessionId is provided.
+	 */
+	transcriptContent?: {
+		/**
+		 * Array of conversation messages
+		 */
+		messages: Array<{
+			/**
+			 * Message source type:
+			 * - 'user' (customer)
+			 * - 'bot' (AI agent)
+			 * - 'agent' (live human agent)
+			 * - 'suggestion' (system suggestion)
+			 */
+			source: "user" | "bot" | "agent" | "suggestion";
+			/**
+			 * Message content
+			 */
+			content: string;
+			/**
+			 * Message timestamp (ISO 8601 format)
+			 */
+			timestamp: string;
+		}>;
+	};
+	/**
+	 * Optional: Flow ID to associate with and extract agent context for enhanced generation
+	 */
+	flowId?: string;
+	/**
+	 * Optional: Number of success criteria to generate
+	 * @default 3
+	 * @minimum 1
+	 * @maximum 10
+	 */
+	numberOfSuccessCriteria?: number;
+	/**
+	 * Optional analysis configuration
+	 */
+	analysisOptions?: {
+		/**
+		 * Limit transcript to first N turns (default: no limit)
+		 * @minimum 1
+		 */
+		maxTurns?: number;
+		/**
+		 * Focus analysis on extracting user goals (default: true)
+		 */
+		focusOnUserGoals?: boolean;
+	};
+}
+export interface IGeneratePersonaFromTranscriptRestReturnValue_2_0 {
+	/**
+	 * Whether the generation was successful
+	 */
+	success: boolean;
+	/**
+	 * Generated persona package
+	 */
+	personaPackage: {
+		/**
+		 * Generated simulation name
+		 */
+		simulationName: string;
+		/**
+		 * Generated persona name
+		 */
+		personaName: string;
+		/**
+		 * Generated persona description capturing user characteristics
+		 */
+		personaDescription: string;
+		/**
+		 * Generated mission based on user goals
+		 */
+		mission: string;
+		/**
+		 * Generated success criteria
+		 */
+		successCriteria: Array<{
+			/**
+			 * Success criterion name
+			 */
+			name: string;
+			/**
+			 * Success criterion description
+			 */
+			text: string;
+		}>;
+	};
+	/**
+	 * Analysis metadata
+	 */
+	metadata: {
+		/**
+		 * Brief summary of the analyzed transcript
+		 */
+		transcriptSummary: string;
+		/**
+		 * When the analysis was performed (ISO 8601 format)
+		 */
+		analysisTimestamp: string;
+		/**
+		 * Content safety warnings (if any)
+		 */
+		warnings?: string[];
+		/**
+		 * Number of turns in the transcript
+		 */
+		turnCount: number;
+		/**
+		 * User intents/goals extracted from transcript
+		 */
+		extractedIntents: string[];
+		/**
+		 * Original transcript messages
+		 */
+		messages: Array<{
+			/**
+			 * Message source: 'user', 'bot', 'agent', or 'suggestion'
+			 */
+			source: "user" | "bot" | "agent" | "suggestion";
+			/**
+			 * Message content
+			 */
+			content: string;
+			/**
+			 * Message timestamp (ISO 8601 format)
+			 */
+			timestamp: string;
+		}>;
+	};
+}
 export interface IStopSimulationRunBatchRestDataQuery_2_0 {
 	projectId: string;
 }
@@ -23815,6 +24040,7 @@ export interface SimulationAPIGroup_2_0 {
 	generatePersona: TRestAPIOperation<IGeneratePersonaRestData_2_0, IGeneratePersonaRestReturnValue_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>;
 }
 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>;