@getzep/zep-cloud 2.2.0 → 2.3.0

package/Client.d.ts

@@ -15,22 +15,27 @@ export declare namespace ZepClient {
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
         timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
         maxRetries?: number;
+        /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
     }
 }
 export declare class ZepClient {
     protected readonly _options: ZepClient.Options;
-    constructor(_options?: ZepClient.Options);
     protected _document: Document | undefined;
-    get document(): Document;
     protected _memory: Memory | undefined;
-    get memory(): Memory;
     protected _graph: Graph | undefined;
-    get graph(): Graph;
     protected _group: Group | undefined;
-    get group(): Group;
     protected _user: User | undefined;
+    constructor(_options?: ZepClient.Options);
+    get document(): Document;
+    get memory(): Memory;
+    get graph(): Graph;
+    get group(): Group;
     get user(): User;
 }

package/api/errors/BadRequestError.js

@@ -18,13 +18,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : 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 __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;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BadRequestError = void 0;
 const errors = __importStar(require("../../errors/index"));

package/api/errors/ConflictError.js

@@ -18,13 +18,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : 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 __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;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConflictError = void 0;
 const errors = __importStar(require("../../errors/index"));

package/api/errors/InternalServerError.js

@@ -18,13 +18,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : 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 __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;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InternalServerError = void 0;
 const errors = __importStar(require("../../errors/index"));

package/api/errors/NotFoundError.js

@@ -18,13 +18,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : 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 __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;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NotFoundError = void 0;
 const errors = __importStar(require("../../errors/index"));

package/api/errors/UnauthorizedError.js

@@ -18,13 +18,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : 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 __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;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UnauthorizedError = void 0;
 const errors = __importStar(require("../../errors/index"));

package/api/resources/document/client/Client.d.ts

@@ -11,9 +11,14 @@ export declare namespace Document {
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
         timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
         maxRetries?: number;
+        /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
     }
 }
 export declare class Document {
@@ -28,7 +33,7 @@ export declare class Document {
      * @throws {@link Zep.InternalServerError}
      *
      * @example
-     *     await zep.document.listCollections()
+     *     await client.document.listCollections()
      */
     listCollections(requestOptions?: Document.RequestOptions): Promise<Zep.ApidataDocumentCollection[][]>;
     /**
@@ -43,7 +48,7 @@ export declare class Document {
      * @throws {@link Zep.InternalServerError}
      *
      * @example
-     *     await zep.document.getCollection("collectionName")
+     *     await client.document.getCollection("collectionName")
      */
     getCollection(collectionName: string, requestOptions?: Document.RequestOptions): Promise<Zep.ApidataDocumentCollection>;
     /**
@@ -59,7 +64,7 @@ export declare class Document {
      * @throws {@link Zep.InternalServerError}
      *
      * @example
-     *     await zep.document.addCollection("collectionName")
+     *     await client.document.addCollection("collectionName")
      */
     addCollection(collectionName: string, request?: Zep.CreateDocumentCollectionRequest, requestOptions?: Document.RequestOptions): Promise<Zep.SuccessResponse>;
     /**
@@ -74,7 +79,7 @@ export declare class Document {
      * @throws {@link Zep.InternalServerError}
      *
      * @example
-     *     await zep.document.deleteCollection("collectionName")
+     *     await client.document.deleteCollection("collectionName")
      */
     deleteCollection(collectionName: string, requestOptions?: Document.RequestOptions): Promise<Zep.SuccessResponse>;
     /**
@@ -90,7 +95,7 @@ export declare class Document {
      * @throws {@link Zep.InternalServerError}
      *
      * @example
-     *     await zep.document.updateCollection("collectionName")
+     *     await client.document.updateCollection("collectionName")
      */
     updateCollection(collectionName: string, request?: Zep.UpdateDocumentCollectionRequest, requestOptions?: Document.RequestOptions): Promise<Zep.SuccessResponse>;
     /**
@@ -105,7 +110,7 @@ export declare class Document {
      * @throws {@link Zep.InternalServerError}
      *
      * @example
-     *     await zep.document.addDocuments("collectionName", [{
+     *     await client.document.addDocuments("collectionName", [{
      *             content: "content"
      *         }])
      */
@@ -122,7 +127,7 @@ export declare class Document {
      * @throws {@link Zep.InternalServerError}
      *
      * @example
-     *     await zep.document.batchDeleteDocuments("collectionName", ["string"])
+     *     await client.document.batchDeleteDocuments("collectionName", ["string"])
      */
     batchDeleteDocuments(collectionName: string, request: string[], requestOptions?: Document.RequestOptions): Promise<Zep.SuccessResponse>;
     /**
@@ -137,7 +142,7 @@ export declare class Document {
      * @throws {@link Zep.InternalServerError}
      *
      * @example
-     *     await zep.document.batchGetDocuments("collectionName")
+     *     await client.document.batchGetDocuments("collectionName")
      */
     batchGetDocuments(collectionName: string, request?: Zep.GetDocumentListRequest, requestOptions?: Document.RequestOptions): Promise<Zep.ApidataDocument[][]>;
     /**
@@ -152,7 +157,7 @@ export declare class Document {
      * @throws {@link Zep.InternalServerError}
      *
      * @example
-     *     await zep.document.batchUpdateDocuments("collectionName", [{
+     *     await client.document.batchUpdateDocuments("collectionName", [{
      *             uuid: "uuid"
      *         }])
      */
@@ -169,7 +174,7 @@ export declare class Document {
      * @throws {@link Zep.InternalServerError}
      *
      * @example
-     *     await zep.document.getsADocumentFromADocumentCollectionByUuidCloudOnly("collectionName", "documentUUID")
+     *     await client.document.getsADocumentFromADocumentCollectionByUuidCloudOnly("collectionName", "documentUUID")
      */
     getsADocumentFromADocumentCollectionByUuidCloudOnly(collectionName: string, documentUuid: string, requestOptions?: Document.RequestOptions): Promise<Zep.ApidataDocument>;
     /**
@@ -185,7 +190,7 @@ export declare class Document {
      * @throws {@link Zep.InternalServerError}
      *
      * @example
-     *     await zep.document.deleteDocument("collectionName", "documentUUID")
+     *     await client.document.deleteDocument("collectionName", "documentUUID")
      */
     deleteDocument(collectionName: string, documentUuid: string, requestOptions?: Document.RequestOptions): Promise<Zep.SuccessResponse>;
     /**
@@ -202,7 +207,7 @@ export declare class Document {
      * @throws {@link Zep.InternalServerError}
      *
      * @example
-     *     await zep.document.updatesADocumentCloudOnly("collectionName", "documentUUID")
+     *     await client.document.updatesADocumentCloudOnly("collectionName", "documentUUID")
      */
     updatesADocumentCloudOnly(collectionName: string, documentUuid: string, request?: Zep.UpdateDocumentRequest, requestOptions?: Document.RequestOptions): Promise<Zep.SuccessResponse>;
     /**
@@ -217,7 +222,7 @@ export declare class Document {
      * @throws {@link Zep.InternalServerError}
      *
      * @example
-     *     await zep.document.search("collectionName")
+     *     await client.document.search("collectionName")
      */
     search(collectionName: string, request?: Zep.DocumentSearchPayload, requestOptions?: Document.RequestOptions): Promise<Zep.ApidataDocumentSearchResponse>;
     protected _getCustomAuthorizationHeaders(): Promise<{