@credal/sdk 0.0.10 → 0.0.12

package/dist/api/resources/documentCollections/client/Client.d.ts

@@ -20,7 +20,7 @@ export declare class DocumentCollections {
     protected readonly _options: DocumentCollections.Options;
     constructor(_options?: DocumentCollections.Options);
     /**
-     * Add documents to a document collection. Note that the documents must already exist in the document catalog to use this endpoint. If you want to upload a new document to a collection, use the uploadDocumentContents endpoint.
+     * Add documents to a document collection. Note that the documents must already exist in the document catalog to use this endpoint. If you want to upload a new document to a collection, use the `uploadDocumentContents` endpoint.
      *
      * @param {Credal.AddDocumentsToCollectionRequest} request
      * @param {DocumentCollections.RequestOptions} requestOptions - Request-specific configuration.
@@ -40,5 +40,111 @@ export declare class DocumentCollections {
      *     })
      */
     addDocumentsToCollection(request: Credal.AddDocumentsToCollectionRequest, requestOptions?: DocumentCollections.RequestOptions): Promise<void>;
+    /**
+     * Remove documents from a collection
+     *
+     * @param {Credal.RemoveDocumentsFromCollectionRequest} request
+     * @param {DocumentCollections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.documentCollections.removeDocumentsFromCollection({
+     *         collectionId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
+     *         resourceIdentifiers: [{
+     *                 type: "external-resource-id",
+     *                 externalResourceId: "170NrBm0Do7gdzvr54UvyslPVWkQFOA0lgNycFmdZJQr",
+     *                 resourceType: Credal.ResourceType.GoogleDriveItem
+     *             }, {
+     *                 type: "external-resource-id",
+     *                 externalResourceId: "398KAHdfkjsdf09r54UvyslPVWkQFOA0lOiu34in923",
+     *                 resourceType: Credal.ResourceType.GoogleDriveItem
+     *             }]
+     *     })
+     */
+    removeDocumentsFromCollection(request: Credal.RemoveDocumentsFromCollectionRequest, requestOptions?: DocumentCollections.RequestOptions): Promise<void>;
+    /**
+     * Create a new copilot. The API key used will be added to the copilot for future Requests
+     *
+     * @param {Credal.CreateCollectionRequest} request
+     * @param {DocumentCollections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.documentCollections.createCollection({
+     *         name: "Customer Collection",
+     *         description: "This collection is used to answer customer requests based on internal documentation.",
+     *         collaborators: [{
+     *                 email: "test@gmail.com",
+     *                 role: Credal.Role.Editor
+     *             }]
+     *     })
+     */
+    createCollection(request: Credal.CreateCollectionRequest, requestOptions?: DocumentCollections.RequestOptions): Promise<Credal.CreateCollectionResponse>;
+    /**
+     * Delete the collection.
+     *
+     * @param {Credal.DeleteCollectionRequest} request
+     * @param {DocumentCollections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.documentCollections.deleteCollection({
+     *         collectionId: "ac20e6ba-0bae-11ef-b25a-efca73df4c3a"
+     *     })
+     */
+    deleteCollection(request: Credal.DeleteCollectionRequest, requestOptions?: DocumentCollections.RequestOptions): Promise<Credal.DeleteCollectionResponse>;
+    /**
+     * Credal lets you easily sync your MongoDB data for use in Collections and Copilots. Create a new sync from a MongoDB collection to a Credal collection.
+     *
+     * @param {Credal.CreateMongoCollectionSyncRequest} request
+     * @param {DocumentCollections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.documentCollections.createMongoCollectionSync({
+     *         mongoUri: "mongodb+srv://cluster0.hzwklqn.mongodb.net/Cluster0?retryWrites=true&w=majority",
+     *         collectionId: "ac20e6ba-0bae-11ef-b25a-efca73df4c3a",
+     *         config: {
+     *             syncName: "My sales transcripts",
+     *             collectionName: "myCollection",
+     *             filterExpression: {
+     *                 "status": {
+     *                     "$ne": "disabled"
+     *                 }
+     *             },
+     *             sourceFields: {
+     *                 body: "body",
+     *                 sourceName: "meetingName",
+     *                 sourceSystemUpdated: "transcriptDatetime",
+     *                 sourceUrl: "link"
+     *             }
+     *         }
+     *     })
+     */
+    createMongoCollectionSync(request: Credal.CreateMongoCollectionSyncRequest, requestOptions?: DocumentCollections.RequestOptions): Promise<Credal.MongoCollectionSyncResponse>;
+    /**
+     * Credal lets you easily sync your MongoDB data for use in Collections and Copilots. Update an existing sync from a MongoDB collection to a Credal collection via the `mongoCredentialId`, to disambiguate between multiple potential syncs to a given collection.
+     *
+     * @param {Credal.UpdateMongoCollectionSyncRequest} request
+     * @param {DocumentCollections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.documentCollections.updateMongoCollectionSync({
+     *         mongoUri: "mongodb+srv://cluster0.hzwklqn.mongodb.net/Cluster0?retryWrites=true&w=majority",
+     *         mongoCredentialId: "5988ed76-6ee1-11ef-97dd-1fca54b7c4bc",
+     *         config: {
+     *             syncName: "My recent summarized sales transcripts",
+     *             collectionName: "myCollection",
+     *             filterExpression: {
+     *                 "transcriptDatetime": {
+     *                     "$gt": "2023-01-01T00:00:00.000Z"
+     *                 }
+     *             },
+     *             sourceFields: {
+     *                 body: "transcriptSummary",
+     *                 sourceName: "meetingName",
+     *                 sourceSystemUpdated: "transcriptDatetime",
+     *                 sourceUrl: "link"
+     *             }
+     *         }
+     *     })
+     */
+    updateMongoCollectionSync(request: Credal.UpdateMongoCollectionSyncRequest, requestOptions?: DocumentCollections.RequestOptions): Promise<Credal.MongoCollectionSyncResponse>;
     protected _getAuthorizationHeader(): Promise<string>;
 }

package/dist/api/resources/documentCollections/client/Client.js

@@ -49,7 +49,7 @@ class DocumentCollections {
         this._options = _options;
     }
     /**
-     * Add documents to a document collection. Note that the documents must already exist in the document catalog to use this endpoint. If you want to upload a new document to a collection, use the uploadDocumentContents endpoint.
+     * Add documents to a document collection. Note that the documents must already exist in the document catalog to use this endpoint. If you want to upload a new document to a collection, use the `uploadDocumentContents` endpoint.
      *
      * @param {Credal.AddDocumentsToCollectionRequest} request
      * @param {DocumentCollections.RequestOptions} requestOptions - Request-specific configuration.
@@ -78,7 +78,7 @@ class DocumentCollections {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.10",
+                    "X-Fern-SDK-Version": "0.0.12",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -114,6 +114,353 @@ class DocumentCollections {
             }
         });
     }
+    /**
+     * Remove documents from a collection
+     *
+     * @param {Credal.RemoveDocumentsFromCollectionRequest} request
+     * @param {DocumentCollections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.documentCollections.removeDocumentsFromCollection({
+     *         collectionId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
+     *         resourceIdentifiers: [{
+     *                 type: "external-resource-id",
+     *                 externalResourceId: "170NrBm0Do7gdzvr54UvyslPVWkQFOA0lgNycFmdZJQr",
+     *                 resourceType: Credal.ResourceType.GoogleDriveItem
+     *             }, {
+     *                 type: "external-resource-id",
+     *                 externalResourceId: "398KAHdfkjsdf09r54UvyslPVWkQFOA0lOiu34in923",
+     *                 resourceType: Credal.ResourceType.GoogleDriveItem
+     *             }]
+     *     })
+     */
+    removeDocumentsFromCollection(request, requestOptions) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CredalEnvironment.Production, "/v0/documentCollections/removeDocumentsFromCollection"),
+                method: "DELETE",
+                headers: {
+                    Authorization: yield this._getAuthorizationHeader(),
+                    "X-Fern-Language": "JavaScript",
+                    "X-Fern-SDK-Name": "@credal/sdk",
+                    "X-Fern-SDK-Version": "0.0.12",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
+                },
+                contentType: "application/json",
+                body: yield serializers.RemoveDocumentsFromCollectionRequest.jsonOrThrow(request, {
+                    unrecognizedObjectKeys: "strip",
+                }),
+                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;
+            }
+            if (_response.error.reason === "status-code") {
+                throw new errors.CredalError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.body,
+                });
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.CredalError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.CredalTimeoutError();
+                case "unknown":
+                    throw new errors.CredalError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
+    /**
+     * Create a new copilot. The API key used will be added to the copilot for future Requests
+     *
+     * @param {Credal.CreateCollectionRequest} request
+     * @param {DocumentCollections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.documentCollections.createCollection({
+     *         name: "Customer Collection",
+     *         description: "This collection is used to answer customer requests based on internal documentation.",
+     *         collaborators: [{
+     *                 email: "test@gmail.com",
+     *                 role: Credal.Role.Editor
+     *             }]
+     *     })
+     */
+    createCollection(request, requestOptions) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CredalEnvironment.Production, "/v0/documentCollections/createCollection"),
+                method: "POST",
+                headers: {
+                    Authorization: yield this._getAuthorizationHeader(),
+                    "X-Fern-Language": "JavaScript",
+                    "X-Fern-SDK-Name": "@credal/sdk",
+                    "X-Fern-SDK-Version": "0.0.12",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
+                },
+                contentType: "application/json",
+                body: yield serializers.CreateCollectionRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+                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 yield serializers.CreateCollectionResponse.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    breadcrumbsPrefix: ["response"],
+                });
+            }
+            if (_response.error.reason === "status-code") {
+                throw new errors.CredalError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.body,
+                });
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.CredalError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.CredalTimeoutError();
+                case "unknown":
+                    throw new errors.CredalError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
+    /**
+     * Delete the collection.
+     *
+     * @param {Credal.DeleteCollectionRequest} request
+     * @param {DocumentCollections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.documentCollections.deleteCollection({
+     *         collectionId: "ac20e6ba-0bae-11ef-b25a-efca73df4c3a"
+     *     })
+     */
+    deleteCollection(request, requestOptions) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CredalEnvironment.Production, "/v0/documentCollections/deleteCollection"),
+                method: "DELETE",
+                headers: {
+                    Authorization: yield this._getAuthorizationHeader(),
+                    "X-Fern-Language": "JavaScript",
+                    "X-Fern-SDK-Name": "@credal/sdk",
+                    "X-Fern-SDK-Version": "0.0.12",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
+                },
+                contentType: "application/json",
+                body: yield serializers.DeleteCollectionRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+                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 yield serializers.DeleteCollectionResponse.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    breadcrumbsPrefix: ["response"],
+                });
+            }
+            if (_response.error.reason === "status-code") {
+                throw new errors.CredalError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.body,
+                });
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.CredalError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.CredalTimeoutError();
+                case "unknown":
+                    throw new errors.CredalError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
+    /**
+     * Credal lets you easily sync your MongoDB data for use in Collections and Copilots. Create a new sync from a MongoDB collection to a Credal collection.
+     *
+     * @param {Credal.CreateMongoCollectionSyncRequest} request
+     * @param {DocumentCollections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.documentCollections.createMongoCollectionSync({
+     *         mongoUri: "mongodb+srv://cluster0.hzwklqn.mongodb.net/Cluster0?retryWrites=true&w=majority",
+     *         collectionId: "ac20e6ba-0bae-11ef-b25a-efca73df4c3a",
+     *         config: {
+     *             syncName: "My sales transcripts",
+     *             collectionName: "myCollection",
+     *             filterExpression: {
+     *                 "status": {
+     *                     "$ne": "disabled"
+     *                 }
+     *             },
+     *             sourceFields: {
+     *                 body: "body",
+     *                 sourceName: "meetingName",
+     *                 sourceSystemUpdated: "transcriptDatetime",
+     *                 sourceUrl: "link"
+     *             }
+     *         }
+     *     })
+     */
+    createMongoCollectionSync(request, requestOptions) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CredalEnvironment.Production, "/v0/documentCollections/mongodb/createMongoSync"),
+                method: "POST",
+                headers: {
+                    Authorization: yield this._getAuthorizationHeader(),
+                    "X-Fern-Language": "JavaScript",
+                    "X-Fern-SDK-Name": "@credal/sdk",
+                    "X-Fern-SDK-Version": "0.0.12",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
+                },
+                contentType: "application/json",
+                body: yield serializers.CreateMongoCollectionSyncRequest.jsonOrThrow(request, {
+                    unrecognizedObjectKeys: "strip",
+                }),
+                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 yield serializers.MongoCollectionSyncResponse.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    breadcrumbsPrefix: ["response"],
+                });
+            }
+            if (_response.error.reason === "status-code") {
+                throw new errors.CredalError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.body,
+                });
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.CredalError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.CredalTimeoutError();
+                case "unknown":
+                    throw new errors.CredalError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
+    /**
+     * Credal lets you easily sync your MongoDB data for use in Collections and Copilots. Update an existing sync from a MongoDB collection to a Credal collection via the `mongoCredentialId`, to disambiguate between multiple potential syncs to a given collection.
+     *
+     * @param {Credal.UpdateMongoCollectionSyncRequest} request
+     * @param {DocumentCollections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.documentCollections.updateMongoCollectionSync({
+     *         mongoUri: "mongodb+srv://cluster0.hzwklqn.mongodb.net/Cluster0?retryWrites=true&w=majority",
+     *         mongoCredentialId: "5988ed76-6ee1-11ef-97dd-1fca54b7c4bc",
+     *         config: {
+     *             syncName: "My recent summarized sales transcripts",
+     *             collectionName: "myCollection",
+     *             filterExpression: {
+     *                 "transcriptDatetime": {
+     *                     "$gt": "2023-01-01T00:00:00.000Z"
+     *                 }
+     *             },
+     *             sourceFields: {
+     *                 body: "transcriptSummary",
+     *                 sourceName: "meetingName",
+     *                 sourceSystemUpdated: "transcriptDatetime",
+     *                 sourceUrl: "link"
+     *             }
+     *         }
+     *     })
+     */
+    updateMongoCollectionSync(request, requestOptions) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CredalEnvironment.Production, "/v0/documentCollections/mongodb/updateMongoSync"),
+                method: "POST",
+                headers: {
+                    Authorization: yield this._getAuthorizationHeader(),
+                    "X-Fern-Language": "JavaScript",
+                    "X-Fern-SDK-Name": "@credal/sdk",
+                    "X-Fern-SDK-Version": "0.0.12",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
+                },
+                contentType: "application/json",
+                body: yield serializers.UpdateMongoCollectionSyncRequest.jsonOrThrow(request, {
+                    unrecognizedObjectKeys: "strip",
+                }),
+                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 yield serializers.MongoCollectionSyncResponse.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    breadcrumbsPrefix: ["response"],
+                });
+            }
+            if (_response.error.reason === "status-code") {
+                throw new errors.CredalError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.body,
+                });
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.CredalError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.CredalTimeoutError();
+                case "unknown":
+                    throw new errors.CredalError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
     _getAuthorizationHeader() {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {

package/dist/api/resources/documentCollections/client/requests/AddDocumentsToCollectionRequest.d.ts

@@ -21,7 +21,7 @@ export interface AddDocumentsToCollectionRequest {
     /** The ID of the document collection you want to add to. */
     collectionId: string;
     /**
-     * The set of resource identifier for which you want to check authorization. Currently limited to 20 resources.
+     * The set of resource identifier for which you want to add to the collection.
      *
      */
     resourceIdentifiers: Credal.ResourceIdentifier[];

package/dist/api/resources/documentCollections/client/requests/CreateCollectionRequest.d.ts

@@ -0,0 +1,32 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../../index";
+/**
+ * @example
+ *     {
+ *         name: "Customer Collection",
+ *         description: "This collection is used to answer customer requests based on internal documentation.",
+ *         collaborators: [{
+ *                 email: "test@gmail.com",
+ *                 role: Credal.Role.Editor
+ *             }]
+ *     }
+ */
+export interface CreateCollectionRequest {
+    /**
+     * A descriptive name for the collection.
+     *
+     */
+    name: string;
+    /**
+     * An in depth name for the copilot's function. Useful for routing requests to the right copilot.
+     *
+     */
+    description: string;
+    /**
+     * A list of collaborator emails and roles that will have access to the copilot.
+     *
+     */
+    collaborators: Credal.Collaborator[];
+}

package/dist/api/resources/documentCollections/client/requests/CreateCollectionRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/documentCollections/client/requests/CreateMongoCollectionSyncRequest.d.ts

@@ -0,0 +1,31 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../../index";
+/**
+ * @example
+ *     {
+ *         mongoUri: "mongodb+srv://cluster0.hzwklqn.mongodb.net/Cluster0?retryWrites=true&w=majority",
+ *         collectionId: "ac20e6ba-0bae-11ef-b25a-efca73df4c3a",
+ *         config: {
+ *             syncName: "My sales transcripts",
+ *             collectionName: "myCollection",
+ *             filterExpression: {
+ *                 "status": {
+ *                     "$ne": "disabled"
+ *                 }
+ *             },
+ *             sourceFields: {
+ *                 body: "body",
+ *                 sourceName: "meetingName",
+ *                 sourceSystemUpdated: "transcriptDatetime",
+ *                 sourceUrl: "link"
+ *             }
+ *         }
+ *     }
+ */
+export interface CreateMongoCollectionSyncRequest {
+    collectionId: string;
+    mongoUri: string;
+    config: Credal.MongoCollectionSyncConfig;
+}

package/dist/api/resources/documentCollections/client/requests/CreateMongoCollectionSyncRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/documentCollections/client/requests/DeleteCollectionRequest.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         collectionId: "ac20e6ba-0bae-11ef-b25a-efca73df4c3a"
+ *     }
+ */
+export interface DeleteCollectionRequest {
+    collectionId: string;
+}

package/dist/api/resources/documentCollections/client/requests/DeleteCollectionRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/documentCollections/client/requests/RemoveDocumentsFromCollectionRequest.d.ts

@@ -0,0 +1,28 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../../index";
+/**
+ * @example
+ *     {
+ *         collectionId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
+ *         resourceIdentifiers: [{
+ *                 type: "external-resource-id",
+ *                 externalResourceId: "170NrBm0Do7gdzvr54UvyslPVWkQFOA0lgNycFmdZJQr",
+ *                 resourceType: Credal.ResourceType.GoogleDriveItem
+ *             }, {
+ *                 type: "external-resource-id",
+ *                 externalResourceId: "398KAHdfkjsdf09r54UvyslPVWkQFOA0lOiu34in923",
+ *                 resourceType: Credal.ResourceType.GoogleDriveItem
+ *             }]
+ *     }
+ */
+export interface RemoveDocumentsFromCollectionRequest {
+    /** The ID of the document collection you want to add to. */
+    collectionId: string;
+    /**
+     * The set of resource identifier for which you want to remove from the collection
+     *
+     */
+    resourceIdentifiers: Credal.ResourceIdentifier[];
+}

package/dist/api/resources/documentCollections/client/requests/RemoveDocumentsFromCollectionRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/documentCollections/client/requests/UpdateMongoCollectionSyncRequest.d.ts

@@ -0,0 +1,31 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../../index";
+/**
+ * @example
+ *     {
+ *         mongoUri: "mongodb+srv://cluster0.hzwklqn.mongodb.net/Cluster0?retryWrites=true&w=majority",
+ *         mongoCredentialId: "5988ed76-6ee1-11ef-97dd-1fca54b7c4bc",
+ *         config: {
+ *             syncName: "My recent summarized sales transcripts",
+ *             collectionName: "myCollection",
+ *             filterExpression: {
+ *                 "transcriptDatetime": {
+ *                     "$gt": "2023-01-01T00:00:00.000Z"
+ *                 }
+ *             },
+ *             sourceFields: {
+ *                 body: "transcriptSummary",
+ *                 sourceName: "meetingName",
+ *                 sourceSystemUpdated: "transcriptDatetime",
+ *                 sourceUrl: "link"
+ *             }
+ *         }
+ *     }
+ */
+export interface UpdateMongoCollectionSyncRequest {
+    mongoCredentialId: string;
+    mongoUri: string;
+    config: Credal.MongoCollectionSyncConfig;
+}