@cognigy/rest-api-client 2025.22.0 → 2025.24.0

package/dist/esm/shared/interfaces/resources/settings/IPiiDataRedactionSettings.js

@@ -0,0 +1,139 @@
+export var EPiiBehaviorType;
+(function (EPiiBehaviorType) {
+    EPiiBehaviorType["PREDEFINED_ALIAS"] = "predefined-alias";
+    EPiiBehaviorType["CUSTOM_ALIAS"] = "custom-alias";
+})(EPiiBehaviorType || (EPiiBehaviorType = {}));
+export const piiFieldSettingsSchema = {
+    title: "piiFieldSettingsSchema",
+    type: "object",
+    additionalProperties: false,
+    required: ["enabled", "name"],
+    properties: {
+        enabled: { type: "boolean" },
+        behavior: {
+            oneOf: [
+                {
+                    type: "object",
+                    additionalProperties: false,
+                    required: ["type"],
+                    properties: {
+                        type: {
+                            type: "string",
+                            enum: [EPiiBehaviorType.PREDEFINED_ALIAS],
+                        },
+                        customAlias: { type: "null" },
+                    },
+                },
+                {
+                    type: "object",
+                    additionalProperties: false,
+                    // @ts-ignore
+                    required: ["type", "customAlias"],
+                    properties: {
+                        type: {
+                            type: "string",
+                            enum: [EPiiBehaviorType.CUSTOM_ALIAS],
+                        },
+                        customAlias: {
+                            type: "string",
+                            minLength: 3,
+                            maxLength: 100
+                        },
+                    },
+                },
+            ],
+        },
+        scope: {
+            type: ["object", "null"],
+            additionalProperties: false,
+            required: ["logs", "analytics"],
+            properties: {
+                logs: { type: "boolean" },
+                analytics: { type: "boolean" },
+            },
+        },
+        name: { type: "string", minLength: 3, maxLength: 100, pattern: "^[a-zA-Z0-9_\\s]+$" },
+    },
+    if: {
+        properties: {
+            enabled: { const: true }
+        }
+    },
+    then: {
+        required: ["enabled", "name", "behavior", "scope"]
+    },
+    else: {
+        required: ["enabled", "name"]
+    }
+};
+export const customPatternSettingsSchema = {
+    title: "customPatternSettingsSchema",
+    type: "object",
+    additionalProperties: false,
+    required: ["name", "regex", "behavior", "scope"],
+    properties: {
+        regex: {
+            type: "string",
+            minLength: 1,
+            maxLength: 1000
+        },
+        behavior: {
+            type: "object",
+            additionalProperties: false,
+            // @ts-ignore
+            required: ["type", "customAlias"],
+            properties: {
+                type: {
+                    type: "string",
+                    enum: [EPiiBehaviorType.CUSTOM_ALIAS],
+                },
+                customAlias: {
+                    type: "string",
+                    minLength: 3,
+                    maxLength: 100
+                },
+            },
+        },
+        scope: {
+            type: ["object", "null"],
+            additionalProperties: false,
+            required: ["logs", "analytics"],
+            properties: {
+                logs: { type: "boolean" },
+                analytics: { type: "boolean" },
+            },
+        },
+        name: {
+            type: "string",
+            minLength: 3,
+            maxLength: 100,
+            pattern: "^[a-zA-Z0-9_\\s]+$"
+        },
+    },
+};
+export const piiDataRedactionSettingsSchema = {
+    title: "piiDataRedactionSettingsSchema",
+    type: "object",
+    additionalProperties: false,
+    required: [
+        "emailAddress",
+        "phoneNumber",
+        "creditCard",
+        "ssn",
+        "ipAddressV4",
+        "ipAddressV6",
+    ],
+    properties: {
+        emailAddress: piiFieldSettingsSchema,
+        phoneNumber: piiFieldSettingsSchema,
+        creditCard: piiFieldSettingsSchema,
+        ssn: piiFieldSettingsSchema,
+        ipAddressV4: piiFieldSettingsSchema,
+        ipAddressV6: piiFieldSettingsSchema,
+        customTypes: {
+            type: ["object", "null"],
+            additionalProperties: customPatternSettingsSchema
+        },
+    },
+};
+//# sourceMappingURL=IPiiDataRedactionSettings.js.map

package/dist/esm/shared/interfaces/resources/settings/index.js

@@ -1,8 +1,9 @@
 export { agentSettingsDataSchema, agentSettingsSchema, } from "./IAgentSettings";
-export { flowIntentMappingOrderType, flowSettingsDataSchema, flowSettingsSchema } from "./IFlowSettings";
+export { flowIntentMappingOrderType, flowSettingsDataSchema, flowSettingsSchema, } from "./IFlowSettings";
 export { sharedSettingsSchema } from "./ISharedSettings";
-export { generativeAISettingsDataSchema } from "./IGenerativeAISettings";
-export { audioPreviewSettingsDataSchema, audioPreviewProviders } from "./IAudioPreviewSettings";
-export { translationSettingsDataSchema, translationProviders } from "./ITranslationSettings";
+export { generativeAISettingsDataSchema, } from "./IGenerativeAISettings";
+export { audioPreviewSettingsDataSchema, audioPreviewProviders, } from "./IAudioPreviewSettings";
+export { translationSettingsDataSchema, translationProviders, } from "./ITranslationSettings";
 export { knowledgeAISettingsDataSchema, fileExtractorOptions, } from "./IKnowledgeAISettings";
+export { EPiiBehaviorType, piiDataRedactionSettingsSchema, } from "./IPiiDataRedactionSettings";
 //# sourceMappingURL=index.js.map

package/dist/esm/shared/interfaces/restAPI/resources/project/v2.0/settings/IAgentSettings_2_0.js

@@ -1,2 +1,104 @@
-export {};
+/**
+ * @openapi
+ *
+ * components:
+ *   schemas:
+ *     EPiiBehaviorType:
+ *       type: string
+ *       description: PII redaction behavior types
+ *       enum:
+ *         - predefined-alias
+ *         - custom-alias
+ *
+ *     IRedactionBehavior:
+ *       oneOf:
+ *         - type: object
+ *           properties:
+ *             type:
+ *               type: string
+ *               enum: [predefined-alias]
+ *             customAlias:
+ *               type: string
+ *               nullable: true
+ *           required: [type, customAlias]
+ *         - type: object
+ *           properties:
+ *             type:
+ *               type: string
+ *               enum: [custom-alias]
+ *             customAlias:
+ *               type: string
+ *               description: Custom alias to replace PII data with
+ *           required: [type, customAlias]
+ *
+ *     IRedactionScope:
+ *       type: object
+ *       properties:
+ *         logs:
+ *           type: boolean
+ *           description: Whether to redact PII in logs
+ *         analytics:
+ *           type: boolean
+ *           description: Whether to redact PII in analytics
+ *       required: [logs, analytics]
+ *
+ *     IPiiFieldSettings:
+ *       type: object
+ *       properties:
+ *         enabled:
+ *           type: boolean
+ *           description: Whether PII redaction is enabled for this field type
+ *         behavior:
+ *           $ref: '#/components/schemas/IRedactionBehavior'
+ *         scope:
+ *           $ref: '#/components/schemas/IRedactionScope'
+ *         name:
+ *           type: string
+ *           description: Display name for the PII field type
+ *       required: [enabled, behavior, scope, name]
+ *
+ *     ICustomPatternSettings:
+ *       type: object
+ *       properties:
+ *         behavior:
+ *           $ref: '#/components/schemas/IRedactionBehavior'
+ *         scope:
+ *           $ref: '#/components/schemas/IRedactionScope'
+ *         name:
+ *           type: string
+ *           description: Display name for the custom PII field type
+ *         regex:
+ *           type: string
+ *           description: Regular expression pattern to match custom PII data (RE2 syntax)
+ *           minLength: 1
+ *           maxLength: 2000
+ *       required: [behavior, scope, name, regex]
+ *
+ *     IPiiDataRedactionSettings_2_0:
+ *       type: object
+ *       properties:
+ *         emailAddress:
+ *           $ref: '#/components/schemas/IPiiFieldSettings'
+ *         phoneNumber:
+ *           $ref: '#/components/schemas/IPiiFieldSettings'
+ *         creditCard:
+ *           $ref: '#/components/schemas/IPiiFieldSettings'
+ *         ssn:
+ *           $ref: '#/components/schemas/IPiiFieldSettings'
+ *         ipAddressV4:
+ *           $ref: '#/components/schemas/IPiiFieldSettings'
+ *         ipAddressV6:
+ *           $ref: '#/components/schemas/IPiiFieldSettings'
+ *         customTypes:
+ *           type: object
+ *           additionalProperties:
+ *             $ref: '#/components/schemas/ICustomPatternSettings'
+ *           description: User-defined custom PII patterns with regex matching
+ *       required: [emailAddress, phoneNumber, creditCard, ssn, ipAddressV4, ipAddressV6]
+ */
+export var EPiiBehaviorType;
+(function (EPiiBehaviorType) {
+    EPiiBehaviorType["PREDEFINED_ALIAS"] = "predefined-alias";
+    EPiiBehaviorType["CUSTOM_ALIAS"] = "custom-alias";
+})(EPiiBehaviorType || (EPiiBehaviorType = {}));
 //# sourceMappingURL=IAgentSettings_2_0.js.map

package/dist/esm/shared/interfaces/restAPI/simulation/persona/IGeneratePersonaFromTranscriptRest_2_0.js

@@ -0,0 +1,19 @@
+/**
+ * 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 {};
+//# sourceMappingURL=IGeneratePersonaFromTranscriptRest_2_0.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@cognigy/rest-api-client",
-	"version": "2025.22.0",
+	"version": "2025.24.0",
 	"description": "Cognigy REST-Client",
 	"main": "build/index.js",
 	"module": "dist/esm/index.js",