parlant-client 3.0.1 → 3.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "parlant-client",
-  "version": "3.0.1",
+  "version": "3.2.0",
   "main": "src/index.js",
   "types": "src/index.d.ts",
   "files": [

package/src/Client.d.ts

@@ -61,4 +61,11 @@ export declare class ParlantClient {
     get journeys(): Journeys;
     get evaluations(): Evaluations;
     get capabilities(): Capabilities;
+    /**
+     * @param {ParlantClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.healthCheckHealthzGet()
+     */
+    healthCheckHealthzGet(requestOptions?: ParlantClient.RequestOptions): Promise<Record<string, string>>;
 }

package/src/Client.js

@@ -2,8 +2,57 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ParlantClient = void 0;
+const core = __importStar(require("./core"));
+const url_join_1 = __importDefault(require("url-join"));
+const serializers = __importStar(require("./serialization/index"));
+const errors = __importStar(require("./errors/index"));
 const Client_1 = require("./api/resources/agents/client/Client");
 const Client_2 = require("./api/resources/sessions/client/Client");
 const Client_3 = require("./api/resources/services/client/Client");
@@ -73,5 +122,53 @@ class ParlantClient {
         var _a;
         return ((_a = this._capabilities) !== null && _a !== void 0 ? _a : (this._capabilities = new Client_13.Capabilities(this._options)));
     }
+    /**
+     * @param {ParlantClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.healthCheckHealthzGet()
+     */
+    healthCheckHealthzGet(requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const _response = yield core.fetcher({
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment)), "healthz"),
+                method: "GET",
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                contentType: "application/json",
+                requestType: "json",
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return serializers.healthCheckHealthzGet.Response.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    breadcrumbsPrefix: ["response"],
+                });
+            }
+            if (_response.error.reason === "status-code") {
+                throw new errors.ParlantError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.body,
+                });
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.ParlantError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.ParlantTimeoutError("Timeout exceeded when calling GET /healthz.");
+                case "unknown":
+                    throw new errors.ParlantError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
 }
 exports.ParlantClient = ParlantClient;

package/src/api/index.d.ts

@@ -1,3 +1,3 @@
+export * from "./resources";
 export * from "./types";
 export * from "./errors";
-export * from "./resources";

package/src/api/index.js

@@ -14,6 +14,6 @@ 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 });
+__exportStar(require("./resources"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./errors"), exports);
-__exportStar(require("./resources"), exports);

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

@@ -39,10 +39,11 @@ export declare class Agents {
      * Creates a new agent in the system.
      *
      * The agent will be initialized with the provided name and optional settings.
-     * A unique identifier will be automatically generated.
+     * A unique identifier will be automatically generated unless a custom ID is provided.
      *
      * Default behaviors:
      * - `name` defaults to `"Unnamed Agent"` if not provided
+     * - `id` is auto-generated if not provided
      * - `description` defaults to `None`
      * - `max_engine_iterations` defaults to `None` (uses system default)
      *
@@ -57,6 +58,7 @@ export declare class Agents {
      *         description: "Technical Support Assistant",
      *         maxEngineIterations: 3,
      *         compositionMode: "fluid",
+     *         messageOutputMode: "block",
      *         tags: ["tag1", "tag2"]
      *     })
      */
@@ -108,7 +110,8 @@ export declare class Agents {
      *         name: "Haxon",
      *         description: "Technical Support Assistant",
      *         maxEngineIterations: 3,
-     *         compositionMode: "fluid"
+     *         compositionMode: "fluid",
+     *         messageOutputMode: "block"
      *     })
      */
     update(agentId: string, request?: Parlant.AgentUpdateParams, requestOptions?: Agents.RequestOptions): Promise<Parlant.Agent>;

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

@@ -115,10 +115,11 @@ class Agents {
      * Creates a new agent in the system.
      *
      * The agent will be initialized with the provided name and optional settings.
-     * A unique identifier will be automatically generated.
+     * A unique identifier will be automatically generated unless a custom ID is provided.
      *
      * Default behaviors:
      * - `name` defaults to `"Unnamed Agent"` if not provided
+     * - `id` is auto-generated if not provided
      * - `description` defaults to `None`
      * - `max_engine_iterations` defaults to `None` (uses system default)
      *
@@ -133,6 +134,7 @@ class Agents {
      *         description: "Technical Support Assistant",
      *         maxEngineIterations: 3,
      *         compositionMode: "fluid",
+     *         messageOutputMode: "block",
      *         tags: ["tag1", "tag2"]
      *     })
      */
@@ -322,7 +324,8 @@ class Agents {
      *         name: "Haxon",
      *         description: "Technical Support Assistant",
      *         maxEngineIterations: 3,
-     *         compositionMode: "fluid"
+     *         compositionMode: "fluid",
+     *         messageOutputMode: "block"
      *     })
      */
     update(agentId_1) {

package/src/api/resources/agents/client/requests/AgentCreationParams.d.ts

@@ -9,17 +9,21 @@ import * as Parlant from "../../../../index";
  *         description: "Technical Support Assistant",
  *         maxEngineIterations: 3,
  *         compositionMode: "fluid",
+ *         messageOutputMode: "block",
  *         tags: ["tag1", "tag2"]
  *     }
  */
 export interface AgentCreationParams {
     /** The display name of the agent, mainly for management purposes */
     name: string;
+    /** Unique identifier for the agent */
+    id?: string;
     /** Detailed description of the agent's purpose and capabilities */
     description?: string;
     /** Maximum number of processing iterations the agent can perform per request */
     maxEngineIterations?: number;
     compositionMode?: Parlant.CompositionModeDto;
+    messageOutputMode?: Parlant.MessageOutputModeDto;
     /** List of tag IDs associated with the agent */
     tags?: string[];
 }

package/src/api/resources/agents/client/requests/AgentUpdateParams.d.ts

@@ -8,7 +8,8 @@ import * as Parlant from "../../../../index";
  *         name: "Haxon",
  *         description: "Technical Support Assistant",
  *         maxEngineIterations: 3,
- *         compositionMode: "fluid"
+ *         compositionMode: "fluid",
+ *         messageOutputMode: "block"
  *     }
  */
 export interface AgentUpdateParams {
@@ -19,5 +20,6 @@ export interface AgentUpdateParams {
     /** Maximum number of processing iterations the agent can perform per request */
     maxEngineIterations?: number;
     compositionMode?: Parlant.CompositionModeDto;
+    messageOutputMode?: Parlant.MessageOutputModeDto;
     tags?: Parlant.AgentTagUpdateParams;
 }

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

@@ -48,7 +48,12 @@ export declare class CannedResponses {
      *                 name: "balance",
      *                 description: "Account's balance",
      *                 examples: ["9000"]
-     *             }]
+     *             }],
+     *         metadata: {
+     *             "category": "account",
+     *             "priority": 1
+     *         },
+     *         fieldDependencies: ["account"]
      *     })
      */
     create(request: Parlant.CannedResponseCreationParams, requestOptions?: CannedResponses.RequestOptions): Promise<Parlant.CannedResponse>;
@@ -97,7 +102,14 @@ export declare class CannedResponses {
      *                 name: "balance",
      *                 description: "Updated account balance",
      *                 examples: ["10000"]
-     *             }]
+     *             }],
+     *         metadata: {
+     *             set: {
+     *                 "category": "account",
+     *                 "priority": 2
+     *             },
+     *             unset: ["old_field"]
+     *         }
      *     })
      */
     update(cannedResponseId: string, request?: Parlant.CannedResponseUpdateParams, requestOptions?: CannedResponses.RequestOptions): Promise<Parlant.CannedResponse>;

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

@@ -140,7 +140,12 @@ class CannedResponses {
      *                 name: "balance",
      *                 description: "Account's balance",
      *                 examples: ["9000"]
-     *             }]
+     *             }],
+     *         metadata: {
+     *             "category": "account",
+     *             "priority": 1
+     *         },
+     *         fieldDependencies: ["account"]
      *     })
      */
     create(request, requestOptions) {
@@ -327,7 +332,14 @@ class CannedResponses {
      *                 name: "balance",
      *                 description: "Updated account balance",
      *                 examples: ["10000"]
-     *             }]
+     *             }],
+     *         metadata: {
+     *             set: {
+     *                 "category": "account",
+     *                 "priority": 2
+     *             },
+     *             unset: ["old_field"]
+     *         }
      *     })
      */
     update(cannedResponseId_1) {

package/src/api/resources/cannedResponses/client/requests/CannedResponseCreationParams.d.ts

@@ -10,7 +10,12 @@ import * as Parlant from "../../../../index";
  *                 name: "balance",
  *                 description: "Account's balance",
  *                 examples: ["9000"]
- *             }]
+ *             }],
+ *         metadata: {
+ *             "category": "account",
+ *             "priority": 1
+ *         },
+ *         fieldDependencies: ["account"]
  *     }
  */
 export interface CannedResponseCreationParams {
@@ -22,4 +27,8 @@ export interface CannedResponseCreationParams {
     tags?: string[];
     /** A sequence of signals associated with the canned response, to help with filtering and matching. */
     signals?: string[];
+    /** Additional metadata associated with the canned response. */
+    metadata?: Record<string, unknown>;
+    /** A sequence of field names that must be available in context for this response to be considered. */
+    fieldDependencies?: string[];
 }

package/src/api/resources/cannedResponses/client/requests/CannedResponseUpdateParams.d.ts

@@ -10,7 +10,14 @@ import * as Parlant from "../../../../index";
  *                 name: "balance",
  *                 description: "Updated account balance",
  *                 examples: ["10000"]
- *             }]
+ *             }],
+ *         metadata: {
+ *             set: {
+ *                 "category": "account",
+ *                 "priority": 2
+ *             },
+ *             unset: ["old_field"]
+ *         }
  *     }
  */
 export interface CannedResponseUpdateParams {
@@ -19,4 +26,5 @@ export interface CannedResponseUpdateParams {
     /** A sequence of canned response fields associated with the canned response. */
     fields?: Parlant.CannedResponseField[];
     tags?: Parlant.CannedResponseTagUpdateParams;
+    metadata?: Parlant.CannedResponseMetadataUpdateParams;
 }

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

@@ -24,17 +24,30 @@ export declare class Customers {
     protected readonly _options: Customers.Options;
     constructor(_options: Customers.Options);
     /**
-     * Retrieves a list of all customers in the system.
+     * Retrieves a list of customers from the system.
+     *
+     * If a cursor is provided, the results are returned using cursor-based pagination
+     * with a configurable sort direction. If no cursor is provided, the full list of
+     * customers is returned.
      *
      * Returns an empty list if no customers exist.
-     * Customers are returned in no guaranteed order.
      *
+     * Note:
+     *     When using paginated results, the first page will always include the special
+     *     'guest' customer as first item.
+     *
+     * @param {Parlant.CustomersListRequest} request
      * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Parlant.UnprocessableEntityError}
+     *
      * @example
-     *     await client.customers.list()
+     *     await client.customers.list({
+     *         limit: 10,
+     *         cursor: "AAABjnBU9gBl/0BQt1axI0VniQI="
+     *     })
      */
-    list(requestOptions?: Customers.RequestOptions): Promise<Parlant.Customer[]>;
+    list(request?: Parlant.CustomersListRequest, requestOptions?: Customers.RequestOptions): Promise<Parlant.CustomersListResponse>;
     /**
      * Creates a new customer in the system.
      *

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

@@ -51,39 +51,64 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Customers = void 0;
 const core = __importStar(require("../../../../core"));
 const Parlant = __importStar(require("../../../index"));
-const url_join_1 = __importDefault(require("url-join"));
 const serializers = __importStar(require("../../../../serialization/index"));
+const url_join_1 = __importDefault(require("url-join"));
 const errors = __importStar(require("../../../../errors/index"));
 class Customers {
     constructor(_options) {
         this._options = _options;
     }
     /**
-     * Retrieves a list of all customers in the system.
+     * Retrieves a list of customers from the system.
+     *
+     * If a cursor is provided, the results are returned using cursor-based pagination
+     * with a configurable sort direction. If no cursor is provided, the full list of
+     * customers is returned.
      *
      * Returns an empty list if no customers exist.
-     * Customers are returned in no guaranteed order.
      *
+     * Note:
+     *     When using paginated results, the first page will always include the special
+     *     'guest' customer as first item.
+     *
+     * @param {Parlant.CustomersListRequest} request
      * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Parlant.UnprocessableEntityError}
+     *
      * @example
-     *     await client.customers.list()
+     *     await client.customers.list({
+     *         limit: 10,
+     *         cursor: "AAABjnBU9gBl/0BQt1axI0VniQI="
+     *     })
      */
-    list(requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
+    list() {
+        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
             var _a;
+            const { limit, cursor, sort } = request;
+            const _queryParams = {};
+            if (limit != null) {
+                _queryParams["limit"] = limit.toString();
+            }
+            if (cursor != null) {
+                _queryParams["cursor"] = cursor;
+            }
+            if (sort != null) {
+                _queryParams["sort"] = serializers.SortDirectionDto.jsonOrThrow(sort, { unrecognizedObjectKeys: "strip" });
+            }
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment)), "customers"),
                 method: "GET",
                 headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
+                queryParameters: _queryParams,
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
-                return serializers.customers.list.Response.parseOrThrow(_response.body, {
+                return serializers.CustomersListResponse.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -91,10 +116,15 @@ class Customers {
                 });
             }
             if (_response.error.reason === "status-code") {
-                throw new errors.ParlantError({
-                    statusCode: _response.error.statusCode,
-                    body: _response.error.body,
-                });
+                switch (_response.error.statusCode) {
+                    case 422:
+                        throw new Parlant.UnprocessableEntityError(_response.error.body);
+                    default:
+                        throw new errors.ParlantError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                        });
+                }
             }
             switch (_response.error.reason) {
                 case "non-json":

package/src/api/resources/customers/client/requests/CustomerCreationParams.d.ts

@@ -14,6 +14,8 @@
 export interface CustomerCreationParams {
     /** An arbitrary string that identifies and/or describes the customer */
     name: string;
+    /** Unique identifier for the customer */
+    id?: string;
     /** Key-value pairs (`str: str`) to describe the customer */
     metadata?: Record<string, string | undefined>;
     /** Collection of ids of tags that describe the customer */

package/src/api/resources/customers/client/requests/CustomersListRequest.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Parlant from "../../../../index";
+/**
+ * @example
+ *     {
+ *         limit: 10,
+ *         cursor: "AAABjnBU9gBl/0BQt1axI0VniQI="
+ *     }
+ */
+export interface CustomersListRequest {
+    limit?: number;
+    cursor?: string;
+    sort?: Parlant.SortDirectionDto;
+}

package/src/api/resources/customers/client/requests/index.d.ts

@@ -1,2 +1,3 @@
+export { type CustomersListRequest } from "./CustomersListRequest";
 export { type CustomerCreationParams } from "./CustomerCreationParams";
 export { type CustomerUpdateParams } from "./CustomerUpdateParams";

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

@@ -1 +1,2 @@
+export * from "./types";
 export * from "./client";

package/src/api/resources/customers/index.js

@@ -14,4 +14,5 @@ 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 });
+__exportStar(require("./types"), exports);
 __exportStar(require("./client"), exports);

package/src/api/resources/customers/types/CustomersListResponse.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Parlant from "../../../index";
+export type CustomersListResponse = Parlant.PaginatedCustomers | Parlant.Customer[];

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

@@ -0,0 +1 @@
+export * from "./CustomersListResponse";

package/src/api/resources/customers/types/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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 });
+__exportStar(require("./CustomersListResponse"), exports);

package/src/api/resources/glossary/client/requests/TermCreationParams.d.ts

@@ -18,4 +18,5 @@ export interface TermCreationParams {
     synonyms?: string[];
     /** List of tag IDs associated with the term */
     tags?: string[];
+    id?: string;
 }

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

@@ -42,6 +42,9 @@ export declare class Guidelines {
     /**
      * Creates a new guideline.
      *
+     * The guideline will be initialized with the provided condition and optional action and settings.
+     * A unique identifier will be automatically generated unless a custom ID is provided.
+     *
      * See the [documentation](https://parlant.io/docs/concepts/customization/guidelines) for more information.
      *
      * @param {Parlant.GuidelineCreationParams} request
@@ -57,7 +60,9 @@ export declare class Guidelines {
      *             "key1": "value1",
      *             "key2": "value2"
      *         },
-     *         enabled: false
+     *         enabled: false,
+     *         compositionMode: "strict_canned",
+     *         labels: ["vip", "priority"]
      *     })
      */
     create(request: Parlant.GuidelineCreationParams, requestOptions?: Guidelines.RequestOptions): Promise<Parlant.Guideline>;
@@ -124,7 +129,14 @@ export declare class Guidelines {
      *                     toolName: "old_tool"
      *                 }]
      *         },
-     *         enabled: true
+     *         enabled: true,
+     *         metadata: {
+     *             set: {
+     *                 "key1": "value1",
+     *                 "key2": "value2"
+     *             },
+     *             unset: ["key3", "key4"]
+     *         }
      *     })
      */
     update(guidelineId: string, request?: Parlant.GuidelineUpdateParams, requestOptions?: Guidelines.RequestOptions): Promise<Parlant.GuidelineWithRelationshipsAndToolAssociations>;

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

@@ -129,6 +129,9 @@ class Guidelines {
     /**
      * Creates a new guideline.
      *
+     * The guideline will be initialized with the provided condition and optional action and settings.
+     * A unique identifier will be automatically generated unless a custom ID is provided.
+     *
      * See the [documentation](https://parlant.io/docs/concepts/customization/guidelines) for more information.
      *
      * @param {Parlant.GuidelineCreationParams} request
@@ -144,7 +147,9 @@ class Guidelines {
      *             "key1": "value1",
      *             "key2": "value2"
      *         },
-     *         enabled: false
+     *         enabled: false,
+     *         compositionMode: "strict_canned",
+     *         labels: ["vip", "priority"]
      *     })
      */
     create(request, requestOptions) {
@@ -349,7 +354,14 @@ class Guidelines {
      *                     toolName: "old_tool"
      *                 }]
      *         },
-     *         enabled: true
+     *         enabled: true,
+     *         metadata: {
+     *             set: {
+     *                 "key1": "value1",
+     *                 "key2": "value2"
+     *             },
+     *             unset: ["key3", "key4"]
+     *         }
      *     })
      */
     update(guidelineId_1) {