parlant-client 3.0.1 → 3.3.1

package/src/api/resources/guidelines/client/requests/GuidelineCreationParams.d.ts

@@ -1,6 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Parlant from "../../../../index";
 /**
  * @example
  *     {
@@ -10,18 +11,30 @@
  *             "key1": "value1",
  *             "key2": "value2"
  *         },
- *         enabled: false
+ *         enabled: false,
+ *         compositionMode: "strict_canned",
+ *         labels: ["vip", "priority"]
  *     }
  */
 export interface GuidelineCreationParams {
+    /** Unique identifier for the guideline */
+    id?: string;
     /** If this condition is satisfied, the action will be performed */
     condition: string;
     /** This action will be performed if the condition is satisfied */
     action?: string;
+    /** Optional description providing additional context for the guideline */
+    description?: string;
+    criticality?: Parlant.CriticalityDto;
     /** Metadata for the guideline */
     metadata?: Record<string, unknown>;
     /** Whether the guideline is enabled */
     enabled?: boolean;
     /** The tags associated with the guideline */
     tags?: string[];
+    compositionMode?: Parlant.CompositionModeDto;
+    track?: boolean;
+    /** The labels associated with the guideline */
+    labels?: string[];
+    priority?: number;
 }

package/src/api/resources/guidelines/client/requests/GuidelineUpdateParams.d.ts

@@ -17,7 +17,14 @@ import * as Parlant from "../../../../index";
  *                     toolName: "old_tool"
  *                 }]
  *         },
- *         enabled: true
+ *         enabled: true,
+ *         metadata: {
+ *             set: {
+ *                 "key1": "value1",
+ *                 "key2": "value2"
+ *             },
+ *             unset: ["key3", "key4"]
+ *         }
  *     }
  */
 export interface GuidelineUpdateParams {
@@ -25,9 +32,15 @@ export interface GuidelineUpdateParams {
     condition?: string;
     /** This action will be performed if the condition is satisfied */
     action?: string;
+    /** Optional description providing additional context for the guideline */
+    description?: string;
+    criticality?: Parlant.CriticalityDto;
     toolAssociations?: Parlant.GuidelineToolAssociationUpdateParams;
     /** Whether the guideline is enabled */
     enabled?: boolean;
     tags?: Parlant.GuidelineTagsUpdateParams;
     metadata?: Parlant.GuidelineMetadataUpdateParams;
+    compositionMode?: Parlant.CompositionModeDto;
+    labels?: Parlant.GuidelineLabelsUpdateParams;
+    priority?: number;
 }

package/src/api/resources/index.d.ts

@@ -1,9 +1,11 @@
-export * as agents from "./agents";
 export * as sessions from "./sessions";
+export * from "./sessions/types";
+export * as customers from "./customers";
+export * from "./customers/types";
+export * as agents from "./agents";
 export * as services from "./services";
 export * as tags from "./tags";
 export * as glossary from "./glossary";
-export * as customers from "./customers";
 export * as cannedResponses from "./cannedResponses";
 export * as contextVariables from "./contextVariables";
 export * as guidelines from "./guidelines";

package/src/api/resources/index.js

@@ -36,13 +36,15 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.capabilities = exports.evaluations = exports.journeys = exports.relationships = exports.guidelines = exports.contextVariables = exports.cannedResponses = exports.customers = exports.glossary = exports.tags = exports.services = exports.sessions = exports.agents = void 0;
-exports.agents = __importStar(require("./agents"));
+exports.capabilities = exports.evaluations = exports.journeys = exports.relationships = exports.guidelines = exports.contextVariables = exports.cannedResponses = exports.glossary = exports.tags = exports.services = exports.agents = exports.customers = exports.sessions = void 0;
 exports.sessions = __importStar(require("./sessions"));
+__exportStar(require("./sessions/types"), exports);
+exports.customers = __importStar(require("./customers"));
+__exportStar(require("./customers/types"), exports);
+exports.agents = __importStar(require("./agents"));
 exports.services = __importStar(require("./services"));
 exports.tags = __importStar(require("./tags"));
 exports.glossary = __importStar(require("./glossary"));
-exports.customers = __importStar(require("./customers"));
 exports.cannedResponses = __importStar(require("./cannedResponses"));
 exports.contextVariables = __importStar(require("./contextVariables"));
 exports.guidelines = __importStar(require("./guidelines"));

package/src/api/resources/journeys/client/Client.d.ts

@@ -39,7 +39,7 @@ export declare class Journeys {
      * Creates a new journey in the system.
      *
      * The journey will be initialized with the provided title, description, and conditions.
-     * A unique identifier will be automatically generated.
+     * A unique identifier will be automatically generated unless a custom ID is provided.
      *
      * @param {Parlant.JourneyCreationParams} request
      * @param {Journeys.RequestOptions} requestOptions - Request-specific configuration.
@@ -51,7 +51,9 @@ export declare class Journeys {
      *         title: "Customer Onboarding",
      *         description: "1. Customer wants to lock their card\n2. Customer reports that their card doesn't work\n3. Customer suspects their card has been stolen",
      *         conditions: ["customer needs unlocking their card", "customer needs help with card"],
-     *         tags: ["tag1", "tag2"]
+     *         id: "IUCGT-lvpS",
+     *         tags: ["tag1", "tag2"],
+     *         labels: ["vip", "priority"]
      *     })
      */
     create(request: Parlant.JourneyCreationParams, requestOptions?: Journeys.RequestOptions): Promise<Parlant.Journey>;

package/src/api/resources/journeys/client/Client.js

@@ -126,7 +126,7 @@ class Journeys {
      * Creates a new journey in the system.
      *
      * The journey will be initialized with the provided title, description, and conditions.
-     * A unique identifier will be automatically generated.
+     * A unique identifier will be automatically generated unless a custom ID is provided.
      *
      * @param {Parlant.JourneyCreationParams} request
      * @param {Journeys.RequestOptions} requestOptions - Request-specific configuration.
@@ -138,7 +138,9 @@ class Journeys {
      *         title: "Customer Onboarding",
      *         description: "1. Customer wants to lock their card\n2. Customer reports that their card doesn't work\n3. Customer suspects their card has been stolen",
      *         conditions: ["customer needs unlocking their card", "customer needs help with card"],
-     *         tags: ["tag1", "tag2"]
+     *         id: "IUCGT-lvpS",
+     *         tags: ["tag1", "tag2"],
+     *         labels: ["vip", "priority"]
      *     })
      */
     create(request, requestOptions) {

package/src/api/resources/journeys/client/requests/JourneyCreationParams.d.ts

@@ -1,13 +1,16 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Parlant from "../../../../index";
 /**
  * @example
  *     {
  *         title: "Customer Onboarding",
  *         description: "1. Customer wants to lock their card\n2. Customer reports that their card doesn't work\n3. Customer suspects their card has been stolen",
  *         conditions: ["customer needs unlocking their card", "customer needs help with card"],
- *         tags: ["tag1", "tag2"]
+ *         id: "IUCGT-lvpS",
+ *         tags: ["tag1", "tag2"],
+ *         labels: ["vip", "priority"]
  *     }
  */
 export interface JourneyCreationParams {
@@ -15,6 +18,12 @@ export interface JourneyCreationParams {
     title: string;
     description: string;
     conditions: string[];
+    /** Unique identifier for the journey */
+    id?: string;
     /** List of tag IDs associated with the journey */
     tags?: string[];
+    compositionMode?: Parlant.CompositionModeDto;
+    /** Labels associated with the journey */
+    labels?: string[];
+    priority?: number;
 }

package/src/api/resources/journeys/client/requests/JourneyUpdateParams.d.ts

@@ -15,4 +15,7 @@ export interface JourneyUpdateParams {
     description?: string;
     conditions?: Parlant.JourneyConditionUpdateParams;
     tags?: Parlant.JourneyTagUpdateParams;
+    compositionMode?: Parlant.CompositionModeDto;
+    labels?: Parlant.JourneyLabelsUpdateParams;
+    priority?: number;
 }

package/src/api/resources/sessions/client/Client.d.ts

@@ -24,10 +24,10 @@ export declare class Sessions {
     protected readonly _options: Sessions.Options;
     constructor(_options: Sessions.Options);
     /**
-     * Lists all sessions matching the specified filters.
+     * Lists all sessions matching the specified filters with pagination support.
      *
-     * Can filter by agent_id and/or customer_id. Returns all sessions if no
-     * filters are provided.
+     * Can filter by agent_id and/or customer_id. Supports cursor-based pagination
+     * with configurable sort direction.
      *
      * @param {Parlant.SessionsListRequest} request
      * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
@@ -37,10 +37,12 @@ export declare class Sessions {
      * @example
      *     await client.sessions.list({
      *         agentId: "ag_123xyz",
-     *         customerId: "cust_123xy"
+     *         customerId: "cust_123xy",
+     *         limit: 10,
+     *         cursor: "AAABjnBU9gBl/0BQt1axI0VniQI="
      *     })
      */
-    list(request?: Parlant.SessionsListRequest, requestOptions?: Sessions.RequestOptions): Promise<Parlant.Session[]>;
+    list(request?: Parlant.SessionsListRequest, requestOptions?: Sessions.RequestOptions): Promise<Parlant.SessionsListResponse>;
     /**
      * Creates a new session between an agent and customer.
      *
@@ -56,7 +58,12 @@ export declare class Sessions {
      *     await client.sessions.create({
      *         agentId: "ag_123xyz",
      *         customerId: "cust_123xy",
-     *         title: "Product inquiry session"
+     *         title: "Product inquiry session",
+     *         metadata: {
+     *             "priority": "high",
+     *             "project": "demo"
+     *         },
+     *         labels: ["vip", "priority"]
      *     })
      */
     create(request: Parlant.SessionCreationParams, requestOptions?: Sessions.RequestOptions): Promise<Parlant.Session>;
@@ -123,7 +130,18 @@ export declare class Sessions {
      *         consumptionOffsets: {
      *             client: 42
      *         },
-     *         title: "Updated session title"
+     *         title: "Updated session title",
+     *         metadata: {
+     *             set: {
+     *                 "priority": "low",
+     *                 "simulation": true
+     *             },
+     *             unset: ["old_project"]
+     *         },
+     *         labels: {
+     *             upsert: ["vip", "priority"],
+     *             remove: ["old_label"]
+     *         }
      *     })
      */
     update(sessionId: string, request?: Parlant.SessionUpdateParams, requestOptions?: Sessions.RequestOptions): Promise<Parlant.Session>;
@@ -131,12 +149,13 @@ export declare class Sessions {
      * Lists events from a session with optional filtering and waiting capabilities.
      *
      * This endpoint retrieves events from a specified session and can:
-     * 1. Filter events by their offset, source, type, and correlation ID
+     * 1. Filter events by their offset, source, type, and trace ID
      * 2. Wait for new events to arrive if requested
      * 3. Return events in chronological order based on their offset
+     * 4. Stream events via Server-Sent Events (SSE) when sse=true
      *
      * Notes:
-     *     Long Polling Behavior:
+     *     Long Polling Behavior (when sse=false):
      *     - When wait_for_data = 0:
      *         Returns immediately with any existing events that match the criteria
      *     - When wait_for_data > 0:
@@ -144,6 +163,11 @@ export declare class Sessions {
      *         - If no new events arrive before timeout, raises 504 Gateway Timeout
      *         - If matching events already exist, returns immediately with those events
      *
+     *     SSE Mode (when sse=true):
+     *     - Returns a text/event-stream response
+     *     - Continuously sends events as they arrive
+     *     - wait_for_data is used as the timeout between events before closing the stream
+     *
      * @param {string} sessionId - Unique identifier for the session
      * @param {Parlant.SessionsListEventsRequest} request
      * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
@@ -156,6 +180,7 @@ export declare class Sessions {
      *     await client.sessions.listEvents("sess_123yz", {
      *         minOffset: 0,
      *         correlationId: "corr_13xyz",
+     *         traceId: "corr_13xyz",
      *         kinds: "message,tool"
      *     })
      */
@@ -198,4 +223,66 @@ export declare class Sessions {
      *     })
      */
     deleteEvents(sessionId: string, request: Parlant.SessionsDeleteEventsRequest, requestOptions?: Sessions.RequestOptions): Promise<void>;
+    /**
+     * Reads a single event from a session.
+     *
+     * This endpoint retrieves a specific event by its ID and optionally waits
+     * for the event to complete (useful for streaming messages).
+     *
+     * Args:
+     *     wait_for_completion: If true, wait for the event to complete (for streaming events,
+     *         this means waiting until chunks contains None terminator)
+     *     wait_for_data: Timeout in seconds for wait_for_completion
+     *     sse: If true, stream event updates via Server-Sent Events until completion
+     *
+     * Notes:
+     *     For streaming message events (events with 'chunks' property):
+     *     - The event is considered complete when chunks contains a None terminator
+     *     - Use wait_for_completion=true to wait for the full message
+     *     - Use sse=true to stream updates as chunks are added
+     *
+     *     SSE Mode (when sse=true):
+     *     - Returns a text/event-stream response
+     *     - Sends the event each time it's updated
+     *     - Closes when the event is complete (chunks ends with None)
+     *
+     * @param {string} sessionId - Unique identifier for the session
+     * @param {string} eventId - Unique identifier for the event
+     * @param {Parlant.SessionsReadEventRequest} request
+     * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Parlant.NotFoundError}
+     * @throws {@link Parlant.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.sessions.readEvent("sess_123yz", "evt_123xyz")
+     */
+    readEvent(sessionId: string, eventId: string, request?: Parlant.SessionsReadEventRequest, requestOptions?: Sessions.RequestOptions): Promise<Parlant.Event>;
+    /**
+     * Updates an event's properties.
+     *
+     * Currently only supports updating metadata. Other event properties cannot be modified.
+     * This API is designed to be extensible for future event property updates.
+     *
+     * @param {string} sessionId - Unique identifier for the session
+     * @param {string} eventId - Unique identifier for the event
+     * @param {Parlant.EventUpdateParams} request
+     * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Parlant.NotFoundError}
+     * @throws {@link Parlant.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.sessions.updateEvent("sess_123yz", "evt_123xyz", {
+     *         metadata: {
+     *             set: {
+     *                 "agent_id": "agent_123",
+     *                 "category": "support",
+     *                 "priority": "high"
+     *             },
+     *             unset: ["old_priority"]
+     *         }
+     *     })
+     */
+    updateEvent(sessionId: string, eventId: string, request?: Parlant.EventUpdateParams, requestOptions?: Sessions.RequestOptions): Promise<Parlant.Event>;
 }