@credal/sdk 0.0.10 → 0.0.12

package/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/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/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/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/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/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/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/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/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;
+}

package/api/resources/documentCollections/client/requests/UpdateMongoCollectionSyncRequest.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/api/resources/documentCollections/client/requests/index.d.ts

@@ -1 +1,6 @@
 export { type AddDocumentsToCollectionRequest } from "./AddDocumentsToCollectionRequest";
+export { type RemoveDocumentsFromCollectionRequest } from "./RemoveDocumentsFromCollectionRequest";
+export { type CreateCollectionRequest } from "./CreateCollectionRequest";
+export { type DeleteCollectionRequest } from "./DeleteCollectionRequest";
+export { type CreateMongoCollectionSyncRequest } from "./CreateMongoCollectionSyncRequest";
+export { type UpdateMongoCollectionSyncRequest } from "./UpdateMongoCollectionSyncRequest";

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

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

package/api/resources/documentCollections/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/api/resources/documentCollections/types/CreateCollectionResponse.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CreateCollectionResponse {
+    collectionId: string;
+}

package/api/resources/documentCollections/types/CreateCollectionResponse.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/api/resources/documentCollections/types/DeleteCollectionResponse.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface DeleteCollectionResponse {
+    collectionId: string;
+}

package/api/resources/documentCollections/types/DeleteCollectionResponse.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/api/resources/documentCollections/types/MongoCollectionSyncConfig.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index";
+export interface MongoCollectionSyncConfig {
+    syncName: string;
+    collectionName: string;
+    filterExpression?: unknown;
+    sourceFields: Credal.MongoSourceFieldsConfig;
+}

package/api/resources/documentCollections/types/MongoCollectionSyncConfig.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/api/resources/documentCollections/types/MongoCollectionSyncResponse.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface MongoCollectionSyncResponse {
+    mongoCredentialId: string;
+    resourceId: string;
+    syncLaunched: boolean;
+}

package/api/resources/documentCollections/types/MongoCollectionSyncResponse.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/api/resources/documentCollections/types/MongoSourceFieldsConfig.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface MongoSourceFieldsConfig {
+    body: string;
+    sourceName: string;
+    sourceSystemUpdated?: string;
+    sourceUrl?: string;
+}

package/api/resources/documentCollections/types/MongoSourceFieldsConfig.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/api/resources/documentCollections/types/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./CreateCollectionResponse";
+export * from "./DeleteCollectionResponse";
+export * from "./MongoSourceFieldsConfig";
+export * from "./MongoCollectionSyncConfig";
+export * from "./MongoCollectionSyncResponse";

package/api/resources/documentCollections/types/index.js

@@ -0,0 +1,21 @@
+"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("./CreateCollectionResponse"), exports);
+__exportStar(require("./DeleteCollectionResponse"), exports);
+__exportStar(require("./MongoSourceFieldsConfig"), exports);
+__exportStar(require("./MongoCollectionSyncConfig"), exports);
+__exportStar(require("./MongoCollectionSyncResponse"), exports);

package/api/resources/index.d.ts

@@ -4,13 +4,14 @@ export * as copilots from "./copilots";
 export * from "./copilots/types";
 export * as documentCatalog from "./documentCatalog";
 export * from "./documentCatalog/types";
+export * as documentCollections from "./documentCollections";
+export * from "./documentCollections/types";
 export * as permissionsService from "./permissionsService";
 export * from "./permissionsService/types";
 export * as search from "./search";
 export * from "./search/types";
 export * as users from "./users";
 export * from "./users/types";
-export * as documentCollections from "./documentCollections";
 export * from "./copilots/client/requests";
 export * from "./documentCatalog/client/requests";
 export * from "./documentCollections/client/requests";

package/api/resources/index.js

@@ -26,20 +26,21 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.documentCollections = exports.users = exports.search = exports.permissionsService = exports.documentCatalog = exports.copilots = exports.common = void 0;
+exports.users = exports.search = exports.permissionsService = exports.documentCollections = exports.documentCatalog = exports.copilots = exports.common = void 0;
 exports.common = __importStar(require("./common"));
 __exportStar(require("./common/types"), exports);
 exports.copilots = __importStar(require("./copilots"));
 __exportStar(require("./copilots/types"), exports);
 exports.documentCatalog = __importStar(require("./documentCatalog"));
 __exportStar(require("./documentCatalog/types"), exports);
+exports.documentCollections = __importStar(require("./documentCollections"));
+__exportStar(require("./documentCollections/types"), exports);
 exports.permissionsService = __importStar(require("./permissionsService"));
 __exportStar(require("./permissionsService/types"), exports);
 exports.search = __importStar(require("./search"));
 __exportStar(require("./search/types"), exports);
 exports.users = __importStar(require("./users"));
 __exportStar(require("./users/types"), exports);
-exports.documentCollections = __importStar(require("./documentCollections"));
 __exportStar(require("./copilots/client/requests"), exports);
 __exportStar(require("./documentCatalog/client/requests"), exports);
 __exportStar(require("./documentCollections/client/requests"), exports);

package/api/resources/permissionsService/client/Client.js

@@ -74,7 +74,7 @@ class PermissionsService {
                     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,
                 },
@@ -144,7 +144,7 @@ class PermissionsService {
                     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,
                 },
@@ -206,7 +206,7 @@ class PermissionsService {
                     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,
                 },

package/api/resources/search/client/Client.js

@@ -84,7 +84,7 @@ class Search {
                     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,
                 },

package/api/resources/users/client/Client.js

@@ -79,7 +79,7 @@ class Users {
                     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,
                 },

package/dist/api/resources/common/types/Collaborator.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index";
+export interface Collaborator {
+    email: string;
+    role: Credal.Role;
+}

package/dist/api/resources/common/types/Collaborator.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/common/types/Role.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type Role = "viewer" | "editor";
+export declare const Role: {
+    readonly Viewer: "viewer";
+    readonly Editor: "editor";
+};

package/dist/api/resources/common/types/Role.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Role = void 0;
+exports.Role = {
+    Viewer: "viewer",
+    Editor: "editor",
+};

package/dist/api/resources/common/types/index.d.ts

@@ -2,3 +2,5 @@ export * from "./ResourceIdentifier";
 export * from "./ExternalResourceId";
 export * from "./Url";
 export * from "./ResourceType";
+export * from "./Collaborator";
+export * from "./Role";

package/dist/api/resources/common/types/index.js

@@ -18,3 +18,5 @@ __exportStar(require("./ResourceIdentifier"), exports);
 __exportStar(require("./ExternalResourceId"), exports);
 __exportStar(require("./Url"), exports);
 __exportStar(require("./ResourceType"), exports);
+__exportStar(require("./Collaborator"), exports);
+__exportStar(require("./Role"), exports);

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

@@ -20,7 +20,24 @@ export declare class Copilots {
     protected readonly _options: Copilots.Options;
     constructor(_options?: Copilots.Options);
     /**
-     * OPTIONAL. Create a new conversation with the Copilot. The conversation ID can be used in the sendMessage endpoint. The sendMessage endpoint automatically creates new conversations upon first request, but calling this endpoint can simplify certain use cases where it is helpful for the application to have the conversation ID before the first message is sent.
+     * Create a new copilot. The API key used will be added to the copilot for future Requests
+     *
+     * @param {Credal.CreateCopilotRequest} request
+     * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.copilots.createCopilot({
+     *         name: "Customer Copilot",
+     *         description: "This copilot is used to answer customer requests based on internal documentation.",
+     *         collaborators: [{
+     *                 email: "test@gmail.com",
+     *                 role: Credal.Role.Editor
+     *             }]
+     *     })
+     */
+    createCopilot(request: Credal.CreateCopilotRequest, requestOptions?: Copilots.RequestOptions): Promise<Credal.CreateCopilotResponse>;
+    /**
+     * OPTIONAL. Create a new conversation with the Copilot. The conversation ID can be used in the `sendMessage` endpoint. The `sendMessage` endpoint automatically creates new conversations upon first request, but calling this endpoint can simplify certain use cases where it is helpful for the application to have the conversation ID before the first message is sent.
      *
      * @param {Credal.CreateConversationRequest} request
      * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
@@ -60,5 +77,62 @@ export declare class Copilots {
      *     })
      */
     sendMessage(request: Credal.SendMessageRequest, requestOptions?: Copilots.RequestOptions): Promise<Credal.SendAgentMessageResponse>;
+    /**
+     * Link a collection with a copilot. The API Key used must be added to both the collection and the copilot beforehand.
+     *
+     * @param {Credal.AddCollectionToCopilotRequest} request
+     * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.copilots.addCollectionToCopilot({
+     *         copilotId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
+     *         collectionId: "def1055f-83c5-43d6-b558-f7a38e7b299e"
+     *     })
+     */
+    addCollectionToCopilot(request: Credal.AddCollectionToCopilotRequest, requestOptions?: Copilots.RequestOptions): Promise<void>;
+    /**
+     * Unlink a collection with a copilot. The API Key used must be added to both the collection and the copilot beforehand.
+     *
+     * @param {Credal.RemoveCollectionFromCopilotRequest} request
+     * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.copilots.removeCollectionFromCopilot({
+     *         copilotId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
+     *         collectionId: "def1055f-83c5-43d6-b558-f7a38e7b299e"
+     *     })
+     */
+    removeCollectionFromCopilot(request: Credal.RemoveCollectionFromCopilotRequest, requestOptions?: Copilots.RequestOptions): Promise<void>;
+    /**
+     * Update the configuration for a copilot
+     *
+     * @param {Credal.UpdateConfigurationRequest} request
+     * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.copilots.updateConfiguration({
+     *         copilotId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
+     *         configuration: {
+     *             name: "Customer Copilot",
+     *             description: "This copilot is used to answer customer requests based on internal documentation.",
+     *             prompt: "You are a polite, helpful assistant used to answer customer requests.",
+     *             aiEndpointConfiguration: {
+     *                 baseUrl: "https://api.openai.com/v1/",
+     *                 apiKey: "<YOUR_API_KEY_HERE>"
+     *             }
+     *         }
+     *     })
+     */
+    updateConfiguration(request: Credal.UpdateConfigurationRequest, requestOptions?: Copilots.RequestOptions): Promise<void>;
+    /**
+     * @param {Credal.DeleteCopilotRequest} request
+     * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.copilots.deleteCopilot({
+     *         id: "ac20e6ba-0bae-11ef-b25a-efca73df4c3a"
+     *     })
+     */
+    deleteCopilot(request: Credal.DeleteCopilotRequest, requestOptions?: Copilots.RequestOptions): Promise<Credal.DeleteCopilotResponse>;
     protected _getAuthorizationHeader(): Promise<string>;
 }