parlant-client 0.5.0 → 0.8.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 Emcie Co Ltd.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "parlant-client",
-  "version": "0.5.0",
+  "version": "0.8.0",
   "main": "src/index.js",
   "types": "src/index.d.ts",
   "files": [
@@ -11,8 +11,8 @@
     "test": "jest --detectOpenHandles"
   },
   "keywords": [],
-  "author": "yam@emcie.co",
-  "license": "MIT",
+  "author": "Yam Marcovitz <yam@emcie.co>",
+  "license": "Apache-2.0",
   "description": "",
   "devDependencies": {
     "@types/jest": "^29.5.14",

package/src/Client.d.ts

@@ -27,13 +27,6 @@ export declare namespace ParlantClient {
 export declare class ParlantClient {
     protected readonly _options: ParlantClient.Options;
     constructor(_options: ParlantClient.Options);
-    /**
-     * @param {ParlantClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.rootGet()
-     */
-    rootGet(requestOptions?: ParlantClient.RequestOptions): Promise<unknown>;
     protected _agents: Agents | undefined;
     get agents(): Agents;
     protected _guidelines: Guidelines | undefined;

package/src/Client.js

@@ -2,42 +2,8 @@
 /**
  * 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 (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __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());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ParlantClient = void 0;
-const core = __importStar(require("./core"));
-const errors = __importStar(require("./errors/index"));
 const Client_1 = require("./api/resources/agents/client/Client");
 const Client_2 = require("./api/resources/guidelines/client/Client");
 const Client_3 = require("./api/resources/glossary/client/Client");
@@ -51,52 +17,6 @@ class ParlantClient {
     constructor(_options) {
         this._options = _options;
     }
-    /**
-     * @param {ParlantClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.rootGet()
-     */
-    rootGet(requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const _response = yield core.fetcher({
-                url: yield core.Supplier.get(this._options.environment),
-                method: "GET",
-                headers: {
-                    "X-Fern-Language": "JavaScript",
-                    "X-Fern-Runtime": core.RUNTIME.type,
-                    "X-Fern-Runtime-Version": core.RUNTIME.version,
-                },
-                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 _response.body;
-            }
-            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();
-                case "unknown":
-                    throw new errors.ParlantError({
-                        message: _response.error.errorMessage,
-                    });
-            }
-        });
-    }
     get agents() {
         var _a;
         return ((_a = this._agents) !== null && _a !== void 0 ? _a : (this._agents = new Client_1.Agents(this._options)));

package/src/api/errors/GatewayTimeoutError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors/index";
+export declare class GatewayTimeoutError extends errors.ParlantError {
+    constructor(body?: unknown);
+}

package/src/{serialization/types/FreshnessRules.js → api/errors/GatewayTimeoutError.js}

@@ -26,14 +26,16 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FreshnessRules = void 0;
-const core = __importStar(require("../../core"));
-const DayOfWeekDto_1 = require("./DayOfWeekDto");
-exports.FreshnessRules = core.serialization.object({
-    months: core.serialization.list(core.serialization.number()).optional(),
-    daysOfMonth: core.serialization.property("days_of_month", core.serialization.list(core.serialization.number()).optional()),
-    daysOfWeek: core.serialization.property("days_of_week", core.serialization.list(DayOfWeekDto_1.DayOfWeekDto).optional()),
-    hours: core.serialization.list(core.serialization.number()).optional(),
-    minutes: core.serialization.list(core.serialization.number()).optional(),
-    seconds: core.serialization.list(core.serialization.number()).optional(),
-});
+exports.GatewayTimeoutError = void 0;
+const errors = __importStar(require("../../errors/index"));
+class GatewayTimeoutError extends errors.ParlantError {
+    constructor(body) {
+        super({
+            message: "GatewayTimeoutError",
+            statusCode: 504,
+            body: body,
+        });
+        Object.setPrototypeOf(this, GatewayTimeoutError.prototype);
+    }
+}
+exports.GatewayTimeoutError = GatewayTimeoutError;

package/src/api/errors/NotFoundError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors/index";
+export declare class NotFoundError extends errors.ParlantError {
+    constructor(body?: unknown);
+}

package/src/{serialization/types/DayOfWeekDto.js → api/errors/NotFoundError.js}

@@ -26,6 +26,16 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DayOfWeekDto = void 0;
-const core = __importStar(require("../../core"));
-exports.DayOfWeekDto = core.serialization.enum_(["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"]);
+exports.NotFoundError = void 0;
+const errors = __importStar(require("../../errors/index"));
+class NotFoundError extends errors.ParlantError {
+    constructor(body) {
+        super({
+            message: "NotFoundError",
+            statusCode: 404,
+            body: body,
+        });
+        Object.setPrototypeOf(this, NotFoundError.prototype);
+    }
+}
+exports.NotFoundError = NotFoundError;

package/src/api/errors/ServiceUnavailableError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors/index";
+export declare class ServiceUnavailableError extends errors.ParlantError {
+    constructor(body?: unknown);
+}

package/src/api/errors/ServiceUnavailableError.js

@@ -0,0 +1,41 @@
+"use strict";
+/**
+ * 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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServiceUnavailableError = void 0;
+const errors = __importStar(require("../../errors/index"));
+class ServiceUnavailableError extends errors.ParlantError {
+    constructor(body) {
+        super({
+            message: "ServiceUnavailableError",
+            statusCode: 503,
+            body: body,
+        });
+        Object.setPrototypeOf(this, ServiceUnavailableError.prototype);
+    }
+}
+exports.ServiceUnavailableError = ServiceUnavailableError;

package/src/api/errors/UnprocessableEntityError.d.ts

@@ -2,7 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as errors from "../../errors/index";
-import * as Parlant from "../index";
 export declare class UnprocessableEntityError extends errors.ParlantError {
-    constructor(body: Parlant.HttpValidationError);
+    constructor(body?: unknown);
 }

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

@@ -1 +1,4 @@
 export * from "./UnprocessableEntityError";
+export * from "./NotFoundError";
+export * from "./GatewayTimeoutError";
+export * from "./ServiceUnavailableError";

package/src/api/errors/index.js

@@ -15,3 +15,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./UnprocessableEntityError"), exports);
+__exportStar(require("./NotFoundError"), exports);
+__exportStar(require("./GatewayTimeoutError"), exports);
+__exportStar(require("./ServiceUnavailableError"), exports);

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

@@ -20,6 +20,11 @@ export declare class Agents {
     protected readonly _options: Agents.Options;
     constructor(_options: Agents.Options);
     /**
+     * Retrieves a list of all agents in the system.
+     *
+     * Returns an empty list if no agents exist.
+     * Agents are returned in no guaranteed order.
+     *
      * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -27,6 +32,17 @@ export declare class Agents {
      */
     list(requestOptions?: Agents.RequestOptions): Promise<Parlant.Agent[]>;
     /**
+     * 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.
+     *
+     * Default behaviors:
+     *
+     * - `name` defaults to `"Unnamed Agent"` if not provided
+     * - `description` defaults to `None`
+     * - `max_engine_iterations` defaults to `None` (uses system default)
+     *
      * @param {Parlant.AgentCreationParams} request
      * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -34,14 +50,19 @@ export declare class Agents {
      *
      * @example
      *     await client.agents.create({
-     *         name: "name"
+     *         name: "Haxon",
+     *         description: "Technical Support Assistant",
+     *         maxEngineIterations: 3
      *     })
      */
     create(request: Parlant.AgentCreationParams, requestOptions?: Agents.RequestOptions): Promise<Parlant.Agent>;
     /**
-     * @param {string} agentId
+     * Retrieves details of a specific agent by ID.
+     *
+     * @param {string} agentId - Unique identifier for the agent
      * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Parlant.NotFoundError}
      * @throws {@link Parlant.UnprocessableEntityError}
      *
      * @example
@@ -49,9 +70,15 @@ export declare class Agents {
      */
     retrieve(agentId: string, requestOptions?: Agents.RequestOptions): Promise<Parlant.Agent>;
     /**
-     * @param {string} agentId
+     * Deletes an agent from the agent.
+     *
+     * Deleting a non-existent agent will return 404.
+     * No content will be returned from a successful deletion.
+     *
+     * @param {string} agentId - Unique identifier for the agent
      * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Parlant.NotFoundError}
      * @throws {@link Parlant.UnprocessableEntityError}
      *
      * @example
@@ -59,14 +86,24 @@ export declare class Agents {
      */
     delete(agentId: string, requestOptions?: Agents.RequestOptions): Promise<void>;
     /**
-     * @param {string} agentId
+     * Updates an existing agent's attributes.
+     *
+     * Only the provided attributes will be updated; others will remain unchanged.
+     * The agent's ID and creation timestamp cannot be modified.
+     *
+     * @param {string} agentId - Unique identifier for the agent
      * @param {Parlant.AgentUpdateParams} request
      * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Parlant.NotFoundError}
      * @throws {@link Parlant.UnprocessableEntityError}
      *
      * @example
-     *     await client.agents.update("agent_id")
+     *     await client.agents.update("agent_id", {
+     *         name: "Haxon",
+     *         description: "Technical Support Assistant",
+     *         maxEngineIterations: 3
+     *     })
      */
     update(agentId: string, request?: Parlant.AgentUpdateParams, requestOptions?: Agents.RequestOptions): Promise<Parlant.Agent>;
 }