@credal/sdk 0.0.16 → 0.0.18

package/Client.d.ts

@@ -3,6 +3,7 @@
  */
 import * as environments from "./environments";
 import * as core from "./core";
+import { Actions } from "./api/resources/actions/client/Client";
 import { Copilots } from "./api/resources/copilots/client/Client";
 import { DocumentCatalog } from "./api/resources/documentCatalog/client/Client";
 import { DocumentCollections } from "./api/resources/documentCollections/client/Client";
@@ -27,6 +28,8 @@ export declare namespace CredalClient {
 export declare class CredalClient {
     protected readonly _options: CredalClient.Options;
     constructor(_options?: CredalClient.Options);
+    protected _actions: Actions | undefined;
+    get actions(): Actions;
     protected _copilots: Copilots | undefined;
     get copilots(): Copilots;
     protected _documentCatalog: DocumentCatalog | undefined;

package/Client.js

@@ -4,39 +4,44 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CredalClient = void 0;
-const Client_1 = require("./api/resources/copilots/client/Client");
-const Client_2 = require("./api/resources/documentCatalog/client/Client");
-const Client_3 = require("./api/resources/documentCollections/client/Client");
-const Client_4 = require("./api/resources/permissionsService/client/Client");
-const Client_5 = require("./api/resources/search/client/Client");
-const Client_6 = require("./api/resources/users/client/Client");
+const Client_1 = require("./api/resources/actions/client/Client");
+const Client_2 = require("./api/resources/copilots/client/Client");
+const Client_3 = require("./api/resources/documentCatalog/client/Client");
+const Client_4 = require("./api/resources/documentCollections/client/Client");
+const Client_5 = require("./api/resources/permissionsService/client/Client");
+const Client_6 = require("./api/resources/search/client/Client");
+const Client_7 = require("./api/resources/users/client/Client");
 class CredalClient {
     constructor(_options = {}) {
         this._options = _options;
     }
+    get actions() {
+        var _a;
+        return ((_a = this._actions) !== null && _a !== void 0 ? _a : (this._actions = new Client_1.Actions(this._options)));
+    }
     get copilots() {
         var _a;
-        return ((_a = this._copilots) !== null && _a !== void 0 ? _a : (this._copilots = new Client_1.Copilots(this._options)));
+        return ((_a = this._copilots) !== null && _a !== void 0 ? _a : (this._copilots = new Client_2.Copilots(this._options)));
     }
     get documentCatalog() {
         var _a;
-        return ((_a = this._documentCatalog) !== null && _a !== void 0 ? _a : (this._documentCatalog = new Client_2.DocumentCatalog(this._options)));
+        return ((_a = this._documentCatalog) !== null && _a !== void 0 ? _a : (this._documentCatalog = new Client_3.DocumentCatalog(this._options)));
     }
     get documentCollections() {
         var _a;
-        return ((_a = this._documentCollections) !== null && _a !== void 0 ? _a : (this._documentCollections = new Client_3.DocumentCollections(this._options)));
+        return ((_a = this._documentCollections) !== null && _a !== void 0 ? _a : (this._documentCollections = new Client_4.DocumentCollections(this._options)));
     }
     get permissionsService() {
         var _a;
-        return ((_a = this._permissionsService) !== null && _a !== void 0 ? _a : (this._permissionsService = new Client_4.PermissionsService(this._options)));
+        return ((_a = this._permissionsService) !== null && _a !== void 0 ? _a : (this._permissionsService = new Client_5.PermissionsService(this._options)));
     }
     get search() {
         var _a;
-        return ((_a = this._search) !== null && _a !== void 0 ? _a : (this._search = new Client_5.Search(this._options)));
+        return ((_a = this._search) !== null && _a !== void 0 ? _a : (this._search = new Client_6.Search(this._options)));
     }
     get users() {
         var _a;
-        return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_6.Users(this._options)));
+        return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_7.Users(this._options)));
     }
 }
 exports.CredalClient = CredalClient;

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

@@ -0,0 +1,50 @@
+/**
+ * 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 Actions {
+    interface Options {
+        environment?: core.Supplier<environments.CredalEnvironment | string>;
+        apiKey?: core.Supplier<core.BearerToken | undefined>;
+        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;
+    }
+}
+export declare class Actions {
+    protected readonly _options: Actions.Options;
+    constructor(_options?: Actions.Options);
+    /**
+     * Invoke an action, asking for human confirmation if necessary
+     *
+     * @param {Credal.InvokeActionRequest} request
+     * @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.actions.invokeAction({
+     *         actionId: "2b5cf2b8-3df3-11ef-9a96-332d4470d189",
+     *         actionInputs: {
+     *             "textToAppend": "If you need more help, please contact your direct manager."
+     *         },
+     *         userEmail: "ben@credal.ai",
+     *         requireHumanConfirmation: true,
+     *         humanConfirmationChannel: {
+     *             type: "slackThread",
+     *             channelId: "ABC123",
+     *             threadTimestamp: "123456789"
+     *         },
+     *         justification: "The user directly asked to update the Relocations Confluence document with this text.",
+     *         auditLogId: "3df3f2b8-3df3-11ef-9a96-332d447011ef"
+     *     })
+     */
+    invokeAction(request: Credal.InvokeActionRequest, requestOptions?: Actions.RequestOptions): Promise<Credal.InvokeActionResponse>;
+    protected _getAuthorizationHeader(): Promise<string>;
+}

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

@@ -0,0 +1,138 @@
+"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.Actions = 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 Actions {
+    constructor(_options = {}) {
+        this._options = _options;
+    }
+    /**
+     * Invoke an action, asking for human confirmation if necessary
+     *
+     * @param {Credal.InvokeActionRequest} request
+     * @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.actions.invokeAction({
+     *         actionId: "2b5cf2b8-3df3-11ef-9a96-332d4470d189",
+     *         actionInputs: {
+     *             "textToAppend": "If you need more help, please contact your direct manager."
+     *         },
+     *         userEmail: "ben@credal.ai",
+     *         requireHumanConfirmation: true,
+     *         humanConfirmationChannel: {
+     *             type: "slackThread",
+     *             channelId: "ABC123",
+     *             threadTimestamp: "123456789"
+     *         },
+     *         justification: "The user directly asked to update the Relocations Confluence document with this text.",
+     *         auditLogId: "3df3f2b8-3df3-11ef-9a96-332d447011ef"
+     *     })
+     */
+    invokeAction(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/actions/invokeAction"),
+                method: "POST",
+                headers: {
+                    Authorization: yield this._getAuthorizationHeader(),
+                    "X-Fern-Language": "JavaScript",
+                    "X-Fern-SDK-Name": "@credal/sdk",
+                    "X-Fern-SDK-Version": "0.0.18",
+                    "User-Agent": "@credal/sdk/0.0.18",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
+                },
+                contentType: "application/json",
+                requestType: "json",
+                body: serializers.InvokeActionRequest.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 serializers.InvokeActionResponse.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.Actions = Actions;

package/api/resources/actions/client/index.d.ts

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

package/api/resources/actions/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/api/resources/actions/client/requests/InvokeActionRequest.d.ts

@@ -0,0 +1,55 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../../index";
+/**
+ * @example
+ *     {
+ *         actionId: "2b5cf2b8-3df3-11ef-9a96-332d4470d189",
+ *         actionInputs: {
+ *             "textToAppend": "If you need more help, please contact your direct manager."
+ *         },
+ *         userEmail: "ben@credal.ai",
+ *         requireHumanConfirmation: true,
+ *         humanConfirmationChannel: {
+ *             type: "slackThread",
+ *             channelId: "ABC123",
+ *             threadTimestamp: "123456789"
+ *         },
+ *         justification: "The user directly asked to update the Relocations Confluence document with this text.",
+ *         auditLogId: "3df3f2b8-3df3-11ef-9a96-332d447011ef"
+ *     }
+ */
+export interface InvokeActionRequest {
+    actionId: string;
+    /**
+     * The inputs needed to execute the action
+     *
+     */
+    actionInputs?: unknown;
+    /**
+     * The user who we should take the action on behalf of
+     *
+     */
+    userEmail: string;
+    /**
+     * If true, then before executing the action we will ask for a human confirmation in Slack.  If false, we may still ask for human confirmation if it's required by your organization admin.
+     *
+     */
+    requireHumanConfirmation?: boolean;
+    /**
+     * Where we should ask for human confirmation if necessary
+     *
+     */
+    humanConfirmationChannel: Credal.HumanConfirmationChannel;
+    /**
+     * The justification for requesting this action.  This is likely generated by the LLM that requested the action.
+     *
+     */
+    justification: string;
+    /**
+     * Audit log for the message that called for this action
+     *
+     */
+    auditLogId: string;
+}

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

@@ -0,0 +1 @@
+export { type InvokeActionRequest } from "./InvokeActionRequest";

package/api/resources/actions/client/requests/index.js

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

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

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

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type ActionStatus = "PENDING_APPROVAL" | "APPROVED_IN_PROGRESS" | "NO_APPROVAL_NEEDED_IN_PROGRESS" | "APPROVED_SUCCEEDED" | "APPROVED_FAILED" | "NO_APPROVAL_NEEDED_SUCCEEDED" | "NO_APPROVAL_NEEDED_FAILED";
+export declare const ActionStatus: {
+    readonly PendingApproval: "PENDING_APPROVAL";
+    readonly ApprovedInProgress: "APPROVED_IN_PROGRESS";
+    readonly NoApprovalNeededInProgress: "NO_APPROVAL_NEEDED_IN_PROGRESS";
+    readonly ApprovedSucceeded: "APPROVED_SUCCEEDED";
+    readonly ApprovedFailed: "APPROVED_FAILED";
+    readonly NoApprovalNeededSucceeded: "NO_APPROVAL_NEEDED_SUCCEEDED";
+    readonly NoApprovalNeededFailed: "NO_APPROVAL_NEEDED_FAILED";
+};

package/api/resources/actions/types/ActionStatus.js

@@ -0,0 +1,15 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActionStatus = void 0;
+exports.ActionStatus = {
+    PendingApproval: "PENDING_APPROVAL",
+    ApprovedInProgress: "APPROVED_IN_PROGRESS",
+    NoApprovalNeededInProgress: "NO_APPROVAL_NEEDED_IN_PROGRESS",
+    ApprovedSucceeded: "APPROVED_SUCCEEDED",
+    ApprovedFailed: "APPROVED_FAILED",
+    NoApprovalNeededSucceeded: "NO_APPROVAL_NEEDED_SUCCEEDED",
+    NoApprovalNeededFailed: "NO_APPROVAL_NEEDED_FAILED",
+};

package/api/resources/actions/types/Conversation.d.ts

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

package/api/resources/actions/types/Conversation.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/actions/types/DirectMessage.d.ts

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

package/api/resources/actions/types/DirectMessage.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/actions/types/HumanConfirmationChannel.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index";
+export declare type HumanConfirmationChannel = Credal.HumanConfirmationChannel.DirectMessage | Credal.HumanConfirmationChannel.SlackThread | Credal.HumanConfirmationChannel.Conversation;
+export declare namespace HumanConfirmationChannel {
+    interface DirectMessage extends Credal.DirectMessage {
+        type: "directMessage";
+    }
+    interface SlackThread extends Credal.SlackThread {
+        type: "slackThread";
+    }
+    interface Conversation extends Credal.Conversation {
+        type: "conversation";
+    }
+}

package/api/resources/actions/types/HumanConfirmationChannel.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/actions/types/InvokeActionResponse.d.ts

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

package/api/resources/actions/types/InvokeActionResponse.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/actions/types/SlackThread.d.ts

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

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

@@ -0,0 +1,6 @@
+export * from "./HumanConfirmationChannel";
+export * from "./DirectMessage";
+export * from "./SlackThread";
+export * from "./Conversation";
+export * from "./InvokeActionResponse";
+export * from "./ActionStatus";

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

@@ -0,0 +1,22 @@
+"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("./HumanConfirmationChannel"), exports);
+__exportStar(require("./DirectMessage"), exports);
+__exportStar(require("./SlackThread"), exports);
+__exportStar(require("./Conversation"), exports);
+__exportStar(require("./InvokeActionResponse"), exports);
+__exportStar(require("./ActionStatus"), exports);

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

@@ -79,10 +79,10 @@ export declare class Copilots {
      *         userEmail: "ravin@credal.ai",
      *         inputVariables: [{
      *                 name: "input1",
-     *                 urls: ["https://drive.google.com/file/d/123456/view"]
+     *                 ids: ["82e4b12a-6990-45d4-8ebd-85c00e030c24"]
      *             }, {
      *                 name: "input2",
-     *                 urls: ["https://drive.google.com/file/d/123457/view", "https://drive.google.com/file/d/123458/view"]
+     *                 ids: ["82e4b12a-6990-45d4-8ebd-85c00e030c25", "82e4b12a-6990-45d4-8ebd-85c00e030c26"]
      *             }]
      *     })
      */