@credal/sdk 0.0.3

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

@@ -0,0 +1,183 @@
+"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;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Copilots = void 0;
+const environments = __importStar(require("../../../../environments"));
+const core = __importStar(require("../../../../core"));
+const serializers = __importStar(require("../../../../serialization/index"));
+const url_join_1 = __importDefault(require("url-join"));
+const errors = __importStar(require("../../../../errors/index"));
+class Copilots {
+    constructor(_options = {}) {
+        this._options = _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.
+     *
+     * @param {Credal.CreateConversationRequest} request
+     * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.copilots.createConversation({
+     *         userEmail: "ravin@credal.ai"
+     *     })
+     */
+    createConversation(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/copilots/createConversation"),
+                method: "POST",
+                headers: {
+                    Authorization: yield this._getAuthorizationHeader(),
+                    "X-Fern-Language": "JavaScript",
+                    "X-Fern-SDK-Name": "@credal/sdk",
+                    "X-Fern-SDK-Version": "0.0.3",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
+                },
+                contentType: "application/json",
+                body: yield serializers.CreateConversationRequest.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.CreateConversationResponse.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,
+                    });
+            }
+        });
+    }
+    /**
+     * @param {Credal.SendMessageRequest} request
+     * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.copilots.sendMessage({
+     *         message: "Is Credal SOC 2 compliant?",
+     *         userEmail: "ravin@credal.ai"
+     *     })
+     */
+    sendMessage(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/copilots/sendMessage"),
+                method: "POST",
+                headers: {
+                    Authorization: yield this._getAuthorizationHeader(),
+                    "X-Fern-Language": "JavaScript",
+                    "X-Fern-SDK-Name": "@credal/sdk",
+                    "X-Fern-SDK-Version": "0.0.3",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
+                },
+                contentType: "application/json",
+                body: yield serializers.SendMessageRequest.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.SendAgentMessageResponse.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* () {
+            const bearer = (_a = (yield core.Supplier.get(this._options.apiKey))) !== null && _a !== void 0 ? _a : process === null || process === void 0 ? void 0 : process.env["CREDAL_API_KEY"];
+            if (bearer == null) {
+                throw new errors.CredalError({
+                    message: "Please specify CREDAL_API_KEY when instantiating the client.",
+                });
+            }
+            return `Bearer ${bearer}`;
+        });
+    }
+}
+exports.Copilots = Copilots;

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

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

package/dist/api/resources/copilots/client/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./requests"), exports);

package/dist/api/resources/copilots/client/requests/CreateConversationRequest.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         userEmail: "ravin@credal.ai"
+ *     }
+ */
+export interface CreateConversationRequest {
+    /**
+     * End-user for the conversation.
+     *
+     */
+    userEmail: string;
+}

package/dist/api/resources/copilots/client/requests/CreateConversationRequest.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/copilots/client/requests/SendMessageRequest.d.ts

@@ -0,0 +1,27 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         message: "Is Credal SOC 2 compliant?",
+ *         userEmail: "ravin@credal.ai"
+ *     }
+ */
+export interface SendMessageRequest {
+    /**
+     * The message you want to send to your copilot.
+     *
+     */
+    message: string;
+    /**
+     * The user profile you want to use when sending the message.
+     *
+     */
+    userEmail: string;
+    /**
+     * Credal-generated conversation ID for sending follow up messages. Conversation ID is returned after initial message. Optional, to be left off for first messages on new conversations.
+     *
+     */
+    conversationId?: string;
+}

package/dist/api/resources/copilots/client/requests/SendMessageRequest.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/copilots/client/requests/index.d.ts

@@ -0,0 +1,2 @@
+export { type CreateConversationRequest } from "./CreateConversationRequest";
+export { type SendMessageRequest } from "./SendMessageRequest";

package/dist/api/resources/copilots/client/requests/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/copilots/index.d.ts

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

package/dist/api/resources/copilots/index.js

@@ -0,0 +1,18 @@
+"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("./types"), exports);
+__exportStar(require("./client"), exports);

package/dist/api/resources/copilots/types/CreateConversationResponse.d.ts

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

package/dist/api/resources/copilots/types/CreateConversationResponse.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/copilots/types/InsertedAuditLog.d.ts

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

package/dist/api/resources/copilots/types/InsertedAuditLog.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/copilots/types/MessageBlocked.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index";
+export interface MessageBlocked {
+    policyTriggers: Credal.PolicyTrigger[];
+    conversationId: string;
+    blocks: string[];
+    warnings: string[];
+    insertedAuditLog: Credal.InsertedAuditLog;
+}

package/dist/api/resources/copilots/types/MessageBlocked.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/copilots/types/MessageReply.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index";
+export interface MessageReply {
+    policyTriggers: Credal.PolicyTrigger[];
+    conversationId: string;
+    response: Credal.ResponseChunk;
+    warnings: string[];
+    activitySourceIdsForAudit: string[];
+    insertedAuditLog: Credal.InsertedAuditLog;
+}

package/dist/api/resources/copilots/types/MessageReply.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/copilots/types/PolicyTrigger.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface PolicyTrigger {
+    id: string;
+    name: string;
+    description: string;
+}

package/dist/api/resources/copilots/types/PolicyTrigger.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/copilots/types/ResponseChunk.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ResponseChunk {
+    message: string;
+    dataChunk: string;
+}

package/dist/api/resources/copilots/types/ResponseChunk.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/copilots/types/SendAgentMessageResponse.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index";
+export interface SendAgentMessageResponse {
+    sendChatResult: Credal.SendMessageResponse;
+}

package/dist/api/resources/copilots/types/SendAgentMessageResponse.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/copilots/types/SendMessageResponse.d.ts

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index";
+export declare type SendMessageResponse = 
+/**
+ * Returned when there is a reply
+ * fetched from the copilot.
+ *  */
+Credal.SendMessageResponse.AiResponseResult
+/**
+ * Returned when Credal detects possible
+ * infosec violations and blocks the message.
+ *  */
+ | Credal.SendMessageResponse.BlockedResult;
+export declare namespace SendMessageResponse {
+    interface AiResponseResult extends Credal.MessageReply {
+        type: "ai_response_result";
+    }
+    interface BlockedResult extends Credal.MessageBlocked {
+        type: "blocked_result";
+    }
+}

package/dist/api/resources/copilots/types/SendMessageResponse.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/copilots/types/index.d.ts

@@ -0,0 +1,8 @@
+export * from "./CreateConversationResponse";
+export * from "./SendAgentMessageResponse";
+export * from "./SendMessageResponse";
+export * from "./MessageReply";
+export * from "./ResponseChunk";
+export * from "./InsertedAuditLog";
+export * from "./MessageBlocked";
+export * from "./PolicyTrigger";

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

@@ -0,0 +1,24 @@
+"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("./CreateConversationResponse"), exports);
+__exportStar(require("./SendAgentMessageResponse"), exports);
+__exportStar(require("./SendMessageResponse"), exports);
+__exportStar(require("./MessageReply"), exports);
+__exportStar(require("./ResponseChunk"), exports);
+__exportStar(require("./InsertedAuditLog"), exports);
+__exportStar(require("./MessageBlocked"), exports);
+__exportStar(require("./PolicyTrigger"), exports);

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

@@ -0,0 +1,70 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as Credal from "../../../index";
+export declare namespace DocumentCatalog {
+    interface Options {
+        environment?: core.Supplier<environments.CredalEnvironment | string>;
+        apiKey?: core.Supplier<core.BearerToken | undefined>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        timeoutInSeconds?: number;
+        maxRetries?: number;
+        abortSignal?: AbortSignal;
+    }
+}
+export declare class DocumentCatalog {
+    protected readonly _options: DocumentCatalog.Options;
+    constructor(_options?: DocumentCatalog.Options);
+    /**
+     * @param {Credal.UploadDocumentContentsRequest} request
+     * @param {DocumentCatalog.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.documentCatalog.uploadDocumentContents({
+     *         documentName: "My Document",
+     *         documentContents: "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
+     *         documentExternalId: "73eead26-d124-4940-b329-5f068a0a8db9",
+     *         allowedUsersEmailAddresses: ["jack@credal.ai", "ravin@credal.ai"],
+     *         uploadAsUserEmail: "jack@credal.ai"
+     *     })
+     */
+    uploadDocumentContents(request: Credal.UploadDocumentContentsRequest, requestOptions?: DocumentCatalog.RequestOptions): Promise<Credal.UploadDocumentResponse>;
+    /**
+     * Bulk patch metadata for documents, synced natively by Credal or manual API uploads
+     *
+     * @param {Credal.DocumentMetadataPatchRequest} request
+     * @param {DocumentCatalog.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.documentCatalog.metadata({
+     *         sources: [{
+     *                 metadata: {
+     *                     "Department": "HR",
+     *                     "Country": "United States"
+     *                 },
+     *                 resourceIdentifier: {
+     *                     type: "external-resource-id",
+     *                     externalResourceId: "170NrBm0Do7gdzvr54UvyslPVWkQFOA0lgNycFmdZJQr",
+     *                     resourceType: Credal.ResourceType.GoogleDriveItem
+     *                 }
+     *             }, {
+     *                 metadata: {
+     *                     "Department": "Sales",
+     *                     "Vertical": "Healthcare"
+     *                 },
+     *                 resourceIdentifier: {
+     *                     type: "external-resource-id",
+     *                     externalResourceId: "123456",
+     *                     resourceType: Credal.ResourceType.ZendeskTicket
+     *                 }
+     *             }],
+     *         uploadAsUserEmail: "ben@credal.ai"
+     *     })
+     */
+    metadata(request: Credal.DocumentMetadataPatchRequest, requestOptions?: DocumentCatalog.RequestOptions): Promise<void>;
+    protected _getAuthorizationHeader(): Promise<string>;
+}