@credal/sdk 0.0.16 → 0.0.18
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Client.d.ts +3 -0
- package/Client.js +17 -12
- package/api/resources/actions/client/Client.d.ts +50 -0
- package/api/resources/actions/client/Client.js +138 -0
- package/api/resources/actions/client/index.d.ts +1 -0
- package/api/resources/actions/client/index.js +17 -0
- package/api/resources/actions/client/requests/InvokeActionRequest.d.ts +55 -0
- package/api/resources/actions/client/requests/InvokeActionRequest.js +5 -0
- package/api/resources/actions/client/requests/index.d.ts +1 -0
- package/api/resources/actions/client/requests/index.js +2 -0
- package/api/resources/actions/index.d.ts +2 -0
- package/api/resources/actions/index.js +18 -0
- package/api/resources/actions/types/ActionStatus.d.ts +13 -0
- package/api/resources/actions/types/ActionStatus.js +15 -0
- package/api/resources/actions/types/Conversation.d.ts +6 -0
- package/api/resources/actions/types/Conversation.js +5 -0
- package/api/resources/actions/types/DirectMessage.d.ts +6 -0
- package/api/resources/actions/types/DirectMessage.js +5 -0
- package/api/resources/actions/types/HumanConfirmationChannel.d.ts +16 -0
- package/api/resources/actions/types/HumanConfirmationChannel.js +5 -0
- package/api/resources/actions/types/InvokeActionResponse.d.ts +8 -0
- package/api/resources/actions/types/InvokeActionResponse.js +5 -0
- package/api/resources/actions/types/SlackThread.d.ts +7 -0
- package/api/resources/actions/types/SlackThread.js +5 -0
- package/api/resources/actions/types/index.d.ts +6 -0
- package/api/resources/actions/types/index.js +22 -0
- package/api/resources/copilots/client/Client.d.ts +2 -2
- package/api/resources/copilots/client/Client.js +20 -20
- package/api/resources/copilots/client/requests/SendMessageRequest.d.ts +2 -2
- package/api/resources/copilots/client/requests/StreamMessageRequest.d.ts +4 -4
- package/api/resources/copilots/types/InputVariable.d.ts +1 -1
- package/api/resources/documentCatalog/client/Client.d.ts +13 -0
- package/api/resources/documentCatalog/client/Client.js +67 -4
- package/api/resources/documentCatalog/types/SyncSourceByUrlRequest.d.ts +7 -0
- package/api/resources/documentCatalog/types/SyncSourceByUrlRequest.js +5 -0
- package/api/resources/documentCatalog/types/SyncSourceByUrlResponse.d.ts +6 -0
- package/api/resources/documentCatalog/types/SyncSourceByUrlResponse.js +5 -0
- package/api/resources/documentCatalog/types/index.d.ts +2 -0
- package/api/resources/documentCatalog/types/index.js +2 -0
- package/api/resources/documentCollections/client/Client.js +12 -12
- package/api/resources/index.d.ts +3 -0
- package/api/resources/index.js +4 -1
- package/api/resources/permissionsService/client/Client.js +6 -6
- package/api/resources/search/client/Client.js +2 -2
- package/api/resources/users/client/Client.js +2 -2
- package/credal-dark-logo.svg +57 -0
- package/dist/Client.d.ts +3 -0
- package/dist/Client.js +17 -12
- package/dist/api/resources/actions/client/Client.d.ts +50 -0
- package/dist/api/resources/actions/client/Client.js +138 -0
- package/dist/api/resources/actions/client/index.d.ts +1 -0
- package/dist/api/resources/actions/client/index.js +17 -0
- package/dist/api/resources/actions/client/requests/InvokeActionRequest.d.ts +55 -0
- package/dist/api/resources/actions/client/requests/InvokeActionRequest.js +5 -0
- package/dist/api/resources/actions/client/requests/index.d.ts +1 -0
- package/dist/api/resources/actions/client/requests/index.js +2 -0
- package/dist/api/resources/actions/index.d.ts +2 -0
- package/dist/api/resources/actions/index.js +18 -0
- package/dist/api/resources/actions/types/ActionStatus.d.ts +13 -0
- package/dist/api/resources/actions/types/ActionStatus.js +15 -0
- package/dist/api/resources/actions/types/Conversation.d.ts +6 -0
- package/dist/api/resources/actions/types/Conversation.js +5 -0
- package/dist/api/resources/actions/types/DirectMessage.d.ts +6 -0
- package/dist/api/resources/actions/types/DirectMessage.js +5 -0
- package/dist/api/resources/actions/types/HumanConfirmationChannel.d.ts +16 -0
- package/dist/api/resources/actions/types/HumanConfirmationChannel.js +5 -0
- package/dist/api/resources/actions/types/InvokeActionResponse.d.ts +8 -0
- package/dist/api/resources/actions/types/InvokeActionResponse.js +5 -0
- package/dist/api/resources/actions/types/SlackThread.d.ts +7 -0
- package/dist/api/resources/actions/types/SlackThread.js +5 -0
- package/dist/api/resources/actions/types/index.d.ts +6 -0
- package/dist/api/resources/actions/types/index.js +22 -0
- package/dist/api/resources/copilots/client/Client.d.ts +2 -2
- package/dist/api/resources/copilots/client/Client.js +20 -20
- package/dist/api/resources/copilots/client/requests/SendMessageRequest.d.ts +2 -2
- package/dist/api/resources/copilots/client/requests/StreamMessageRequest.d.ts +4 -4
- package/dist/api/resources/copilots/types/InputVariable.d.ts +1 -1
- package/dist/api/resources/documentCatalog/client/Client.d.ts +13 -0
- package/dist/api/resources/documentCatalog/client/Client.js +67 -4
- package/dist/api/resources/documentCatalog/types/SyncSourceByUrlRequest.d.ts +7 -0
- package/dist/api/resources/documentCatalog/types/SyncSourceByUrlRequest.js +5 -0
- package/dist/api/resources/documentCatalog/types/SyncSourceByUrlResponse.d.ts +6 -0
- package/dist/api/resources/documentCatalog/types/SyncSourceByUrlResponse.js +5 -0
- package/dist/api/resources/documentCatalog/types/index.d.ts +2 -0
- package/dist/api/resources/documentCatalog/types/index.js +2 -0
- package/dist/api/resources/documentCollections/client/Client.js +12 -12
- package/dist/api/resources/index.d.ts +3 -0
- package/dist/api/resources/index.js +4 -1
- package/dist/api/resources/permissionsService/client/Client.js +6 -6
- package/dist/api/resources/search/client/Client.js +2 -2
- package/dist/api/resources/users/client/Client.js +2 -2
- package/dist/serialization/resources/actions/client/index.d.ts +1 -0
- package/dist/serialization/resources/actions/client/index.js +17 -0
- package/dist/serialization/resources/actions/client/requests/InvokeActionRequest.d.ts +19 -0
- package/dist/serialization/resources/actions/client/requests/InvokeActionRequest.js +40 -0
- package/dist/serialization/resources/actions/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/actions/client/requests/index.js +5 -0
- package/dist/serialization/resources/actions/index.d.ts +2 -0
- package/dist/serialization/resources/actions/index.js +18 -0
- package/dist/serialization/resources/actions/types/ActionStatus.d.ts +10 -0
- package/dist/serialization/resources/actions/types/ActionStatus.js +39 -0
- package/dist/serialization/resources/actions/types/Conversation.d.ts +12 -0
- package/dist/serialization/resources/actions/types/Conversation.js +33 -0
- package/dist/serialization/resources/actions/types/DirectMessage.d.ts +12 -0
- package/dist/serialization/resources/actions/types/DirectMessage.js +33 -0
- package/dist/serialization/resources/actions/types/HumanConfirmationChannel.d.ts +22 -0
- package/dist/serialization/resources/actions/types/HumanConfirmationChannel.js +43 -0
- package/dist/serialization/resources/actions/types/InvokeActionResponse.d.ts +14 -0
- package/dist/serialization/resources/actions/types/InvokeActionResponse.js +35 -0
- package/dist/serialization/resources/actions/types/SlackThread.d.ts +13 -0
- package/dist/serialization/resources/actions/types/SlackThread.js +34 -0
- package/dist/serialization/resources/actions/types/index.d.ts +6 -0
- package/dist/serialization/resources/actions/types/index.js +22 -0
- package/dist/serialization/resources/copilots/types/InputVariable.d.ts +1 -1
- package/dist/serialization/resources/copilots/types/InputVariable.js +1 -1
- package/dist/serialization/resources/documentCatalog/types/SyncSourceByUrlRequest.d.ts +13 -0
- package/dist/serialization/resources/documentCatalog/types/SyncSourceByUrlRequest.js +34 -0
- package/dist/serialization/resources/documentCatalog/types/SyncSourceByUrlResponse.d.ts +12 -0
- package/dist/serialization/resources/documentCatalog/types/SyncSourceByUrlResponse.js +33 -0
- package/dist/serialization/resources/documentCatalog/types/index.d.ts +2 -0
- package/dist/serialization/resources/documentCatalog/types/index.js +2 -0
- package/dist/serialization/resources/index.d.ts +3 -0
- package/dist/serialization/resources/index.js +4 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
- package/reference.md +149 -4
- package/serialization/resources/actions/client/index.d.ts +1 -0
- package/serialization/resources/actions/client/index.js +17 -0
- package/serialization/resources/actions/client/requests/InvokeActionRequest.d.ts +19 -0
- package/serialization/resources/actions/client/requests/InvokeActionRequest.js +40 -0
- package/serialization/resources/actions/client/requests/index.d.ts +1 -0
- package/serialization/resources/actions/client/requests/index.js +5 -0
- package/serialization/resources/actions/index.d.ts +2 -0
- package/serialization/resources/actions/index.js +18 -0
- package/serialization/resources/actions/types/ActionStatus.d.ts +10 -0
- package/serialization/resources/actions/types/ActionStatus.js +39 -0
- package/serialization/resources/actions/types/Conversation.d.ts +12 -0
- package/serialization/resources/actions/types/Conversation.js +33 -0
- package/serialization/resources/actions/types/DirectMessage.d.ts +12 -0
- package/serialization/resources/actions/types/DirectMessage.js +33 -0
- package/serialization/resources/actions/types/HumanConfirmationChannel.d.ts +22 -0
- package/serialization/resources/actions/types/HumanConfirmationChannel.js +43 -0
- package/serialization/resources/actions/types/InvokeActionResponse.d.ts +14 -0
- package/serialization/resources/actions/types/InvokeActionResponse.js +35 -0
- package/serialization/resources/actions/types/SlackThread.d.ts +13 -0
- package/serialization/resources/actions/types/SlackThread.js +34 -0
- package/serialization/resources/actions/types/index.d.ts +6 -0
- package/serialization/resources/actions/types/index.js +22 -0
- package/serialization/resources/copilots/types/InputVariable.d.ts +1 -1
- package/serialization/resources/copilots/types/InputVariable.js +1 -1
- package/serialization/resources/documentCatalog/types/SyncSourceByUrlRequest.d.ts +13 -0
- package/serialization/resources/documentCatalog/types/SyncSourceByUrlRequest.js +34 -0
- package/serialization/resources/documentCatalog/types/SyncSourceByUrlResponse.d.ts +12 -0
- package/serialization/resources/documentCatalog/types/SyncSourceByUrlResponse.js +33 -0
- package/serialization/resources/documentCatalog/types/index.d.ts +2 -0
- package/serialization/resources/documentCatalog/types/index.js +2 -0
- package/serialization/resources/index.d.ts +3 -0
- package/serialization/resources/index.js +4 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
package/dist/Client.js
CHANGED
|
@@ -4,39 +4,44 @@
|
|
|
4
4
|
*/
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
6
|
exports.CredalClient = void 0;
|
|
7
|
-
const Client_1 = require("./api/resources/
|
|
8
|
-
const Client_2 = require("./api/resources/
|
|
9
|
-
const Client_3 = require("./api/resources/
|
|
10
|
-
const Client_4 = require("./api/resources/
|
|
11
|
-
const Client_5 = require("./api/resources/
|
|
12
|
-
const Client_6 = require("./api/resources/
|
|
7
|
+
const Client_1 = require("./api/resources/actions/client/Client");
|
|
8
|
+
const Client_2 = require("./api/resources/copilots/client/Client");
|
|
9
|
+
const Client_3 = require("./api/resources/documentCatalog/client/Client");
|
|
10
|
+
const Client_4 = require("./api/resources/documentCollections/client/Client");
|
|
11
|
+
const Client_5 = require("./api/resources/permissionsService/client/Client");
|
|
12
|
+
const Client_6 = require("./api/resources/search/client/Client");
|
|
13
|
+
const Client_7 = require("./api/resources/users/client/Client");
|
|
13
14
|
class CredalClient {
|
|
14
15
|
constructor(_options = {}) {
|
|
15
16
|
this._options = _options;
|
|
16
17
|
}
|
|
18
|
+
get actions() {
|
|
19
|
+
var _a;
|
|
20
|
+
return ((_a = this._actions) !== null && _a !== void 0 ? _a : (this._actions = new Client_1.Actions(this._options)));
|
|
21
|
+
}
|
|
17
22
|
get copilots() {
|
|
18
23
|
var _a;
|
|
19
|
-
return ((_a = this._copilots) !== null && _a !== void 0 ? _a : (this._copilots = new
|
|
24
|
+
return ((_a = this._copilots) !== null && _a !== void 0 ? _a : (this._copilots = new Client_2.Copilots(this._options)));
|
|
20
25
|
}
|
|
21
26
|
get documentCatalog() {
|
|
22
27
|
var _a;
|
|
23
|
-
return ((_a = this._documentCatalog) !== null && _a !== void 0 ? _a : (this._documentCatalog = new
|
|
28
|
+
return ((_a = this._documentCatalog) !== null && _a !== void 0 ? _a : (this._documentCatalog = new Client_3.DocumentCatalog(this._options)));
|
|
24
29
|
}
|
|
25
30
|
get documentCollections() {
|
|
26
31
|
var _a;
|
|
27
|
-
return ((_a = this._documentCollections) !== null && _a !== void 0 ? _a : (this._documentCollections = new
|
|
32
|
+
return ((_a = this._documentCollections) !== null && _a !== void 0 ? _a : (this._documentCollections = new Client_4.DocumentCollections(this._options)));
|
|
28
33
|
}
|
|
29
34
|
get permissionsService() {
|
|
30
35
|
var _a;
|
|
31
|
-
return ((_a = this._permissionsService) !== null && _a !== void 0 ? _a : (this._permissionsService = new
|
|
36
|
+
return ((_a = this._permissionsService) !== null && _a !== void 0 ? _a : (this._permissionsService = new Client_5.PermissionsService(this._options)));
|
|
32
37
|
}
|
|
33
38
|
get search() {
|
|
34
39
|
var _a;
|
|
35
|
-
return ((_a = this._search) !== null && _a !== void 0 ? _a : (this._search = new
|
|
40
|
+
return ((_a = this._search) !== null && _a !== void 0 ? _a : (this._search = new Client_6.Search(this._options)));
|
|
36
41
|
}
|
|
37
42
|
get users() {
|
|
38
43
|
var _a;
|
|
39
|
-
return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new
|
|
44
|
+
return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_7.Users(this._options)));
|
|
40
45
|
}
|
|
41
46
|
}
|
|
42
47
|
exports.CredalClient = CredalClient;
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as environments from "../../../../environments";
|
|
5
|
+
import * as core from "../../../../core";
|
|
6
|
+
import * as Credal from "../../../index";
|
|
7
|
+
export declare namespace Actions {
|
|
8
|
+
interface Options {
|
|
9
|
+
environment?: core.Supplier<environments.CredalEnvironment | string>;
|
|
10
|
+
apiKey?: core.Supplier<core.BearerToken | undefined>;
|
|
11
|
+
fetcher?: core.FetchFunction;
|
|
12
|
+
}
|
|
13
|
+
interface RequestOptions {
|
|
14
|
+
/** The maximum time to wait for a response in seconds. */
|
|
15
|
+
timeoutInSeconds?: number;
|
|
16
|
+
/** The number of times to retry the request. Defaults to 2. */
|
|
17
|
+
maxRetries?: number;
|
|
18
|
+
/** A hook to abort the request. */
|
|
19
|
+
abortSignal?: AbortSignal;
|
|
20
|
+
}
|
|
21
|
+
}
|
|
22
|
+
export declare class Actions {
|
|
23
|
+
protected readonly _options: Actions.Options;
|
|
24
|
+
constructor(_options?: Actions.Options);
|
|
25
|
+
/**
|
|
26
|
+
* Invoke an action, asking for human confirmation if necessary
|
|
27
|
+
*
|
|
28
|
+
* @param {Credal.InvokeActionRequest} request
|
|
29
|
+
* @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
|
|
30
|
+
*
|
|
31
|
+
* @example
|
|
32
|
+
* await client.actions.invokeAction({
|
|
33
|
+
* actionId: "2b5cf2b8-3df3-11ef-9a96-332d4470d189",
|
|
34
|
+
* actionInputs: {
|
|
35
|
+
* "textToAppend": "If you need more help, please contact your direct manager."
|
|
36
|
+
* },
|
|
37
|
+
* userEmail: "ben@credal.ai",
|
|
38
|
+
* requireHumanConfirmation: true,
|
|
39
|
+
* humanConfirmationChannel: {
|
|
40
|
+
* type: "slackThread",
|
|
41
|
+
* channelId: "ABC123",
|
|
42
|
+
* threadTimestamp: "123456789"
|
|
43
|
+
* },
|
|
44
|
+
* justification: "The user directly asked to update the Relocations Confluence document with this text.",
|
|
45
|
+
* auditLogId: "3df3f2b8-3df3-11ef-9a96-332d447011ef"
|
|
46
|
+
* })
|
|
47
|
+
*/
|
|
48
|
+
invokeAction(request: Credal.InvokeActionRequest, requestOptions?: Actions.RequestOptions): Promise<Credal.InvokeActionResponse>;
|
|
49
|
+
protected _getAuthorizationHeader(): Promise<string>;
|
|
50
|
+
}
|
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
4
|
+
*/
|
|
5
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
6
|
+
if (k2 === undefined) k2 = k;
|
|
7
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
8
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
9
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
10
|
+
}
|
|
11
|
+
Object.defineProperty(o, k2, desc);
|
|
12
|
+
}) : (function(o, m, k, k2) {
|
|
13
|
+
if (k2 === undefined) k2 = k;
|
|
14
|
+
o[k2] = m[k];
|
|
15
|
+
}));
|
|
16
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
17
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
18
|
+
}) : function(o, v) {
|
|
19
|
+
o["default"] = v;
|
|
20
|
+
});
|
|
21
|
+
var __importStar = (this && this.__importStar) || function (mod) {
|
|
22
|
+
if (mod && mod.__esModule) return mod;
|
|
23
|
+
var result = {};
|
|
24
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
25
|
+
__setModuleDefault(result, mod);
|
|
26
|
+
return result;
|
|
27
|
+
};
|
|
28
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
29
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
30
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
31
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
32
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
33
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
34
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
35
|
+
});
|
|
36
|
+
};
|
|
37
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
38
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
39
|
+
};
|
|
40
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
41
|
+
exports.Actions = void 0;
|
|
42
|
+
const environments = __importStar(require("../../../../environments"));
|
|
43
|
+
const core = __importStar(require("../../../../core"));
|
|
44
|
+
const serializers = __importStar(require("../../../../serialization/index"));
|
|
45
|
+
const url_join_1 = __importDefault(require("url-join"));
|
|
46
|
+
const errors = __importStar(require("../../../../errors/index"));
|
|
47
|
+
class Actions {
|
|
48
|
+
constructor(_options = {}) {
|
|
49
|
+
this._options = _options;
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* Invoke an action, asking for human confirmation if necessary
|
|
53
|
+
*
|
|
54
|
+
* @param {Credal.InvokeActionRequest} request
|
|
55
|
+
* @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
|
|
56
|
+
*
|
|
57
|
+
* @example
|
|
58
|
+
* await client.actions.invokeAction({
|
|
59
|
+
* actionId: "2b5cf2b8-3df3-11ef-9a96-332d4470d189",
|
|
60
|
+
* actionInputs: {
|
|
61
|
+
* "textToAppend": "If you need more help, please contact your direct manager."
|
|
62
|
+
* },
|
|
63
|
+
* userEmail: "ben@credal.ai",
|
|
64
|
+
* requireHumanConfirmation: true,
|
|
65
|
+
* humanConfirmationChannel: {
|
|
66
|
+
* type: "slackThread",
|
|
67
|
+
* channelId: "ABC123",
|
|
68
|
+
* threadTimestamp: "123456789"
|
|
69
|
+
* },
|
|
70
|
+
* justification: "The user directly asked to update the Relocations Confluence document with this text.",
|
|
71
|
+
* auditLogId: "3df3f2b8-3df3-11ef-9a96-332d447011ef"
|
|
72
|
+
* })
|
|
73
|
+
*/
|
|
74
|
+
invokeAction(request, requestOptions) {
|
|
75
|
+
var _a, _b;
|
|
76
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
77
|
+
const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
|
|
78
|
+
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"),
|
|
79
|
+
method: "POST",
|
|
80
|
+
headers: {
|
|
81
|
+
Authorization: yield this._getAuthorizationHeader(),
|
|
82
|
+
"X-Fern-Language": "JavaScript",
|
|
83
|
+
"X-Fern-SDK-Name": "@credal/sdk",
|
|
84
|
+
"X-Fern-SDK-Version": "0.0.18",
|
|
85
|
+
"User-Agent": "@credal/sdk/0.0.18",
|
|
86
|
+
"X-Fern-Runtime": core.RUNTIME.type,
|
|
87
|
+
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
88
|
+
},
|
|
89
|
+
contentType: "application/json",
|
|
90
|
+
requestType: "json",
|
|
91
|
+
body: serializers.InvokeActionRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
|
|
92
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
93
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
94
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
95
|
+
});
|
|
96
|
+
if (_response.ok) {
|
|
97
|
+
return serializers.InvokeActionResponse.parseOrThrow(_response.body, {
|
|
98
|
+
unrecognizedObjectKeys: "passthrough",
|
|
99
|
+
allowUnrecognizedUnionMembers: true,
|
|
100
|
+
allowUnrecognizedEnumValues: true,
|
|
101
|
+
breadcrumbsPrefix: ["response"],
|
|
102
|
+
});
|
|
103
|
+
}
|
|
104
|
+
if (_response.error.reason === "status-code") {
|
|
105
|
+
throw new errors.CredalError({
|
|
106
|
+
statusCode: _response.error.statusCode,
|
|
107
|
+
body: _response.error.body,
|
|
108
|
+
});
|
|
109
|
+
}
|
|
110
|
+
switch (_response.error.reason) {
|
|
111
|
+
case "non-json":
|
|
112
|
+
throw new errors.CredalError({
|
|
113
|
+
statusCode: _response.error.statusCode,
|
|
114
|
+
body: _response.error.rawBody,
|
|
115
|
+
});
|
|
116
|
+
case "timeout":
|
|
117
|
+
throw new errors.CredalTimeoutError();
|
|
118
|
+
case "unknown":
|
|
119
|
+
throw new errors.CredalError({
|
|
120
|
+
message: _response.error.errorMessage,
|
|
121
|
+
});
|
|
122
|
+
}
|
|
123
|
+
});
|
|
124
|
+
}
|
|
125
|
+
_getAuthorizationHeader() {
|
|
126
|
+
var _a;
|
|
127
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
128
|
+
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"];
|
|
129
|
+
if (bearer == null) {
|
|
130
|
+
throw new errors.CredalError({
|
|
131
|
+
message: "Please specify CREDAL_API_KEY when instantiating the client.",
|
|
132
|
+
});
|
|
133
|
+
}
|
|
134
|
+
return `Bearer ${bearer}`;
|
|
135
|
+
});
|
|
136
|
+
}
|
|
137
|
+
}
|
|
138
|
+
exports.Actions = Actions;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./requests";
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./requests"), exports);
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Credal from "../../../../index";
|
|
5
|
+
/**
|
|
6
|
+
* @example
|
|
7
|
+
* {
|
|
8
|
+
* actionId: "2b5cf2b8-3df3-11ef-9a96-332d4470d189",
|
|
9
|
+
* actionInputs: {
|
|
10
|
+
* "textToAppend": "If you need more help, please contact your direct manager."
|
|
11
|
+
* },
|
|
12
|
+
* userEmail: "ben@credal.ai",
|
|
13
|
+
* requireHumanConfirmation: true,
|
|
14
|
+
* humanConfirmationChannel: {
|
|
15
|
+
* type: "slackThread",
|
|
16
|
+
* channelId: "ABC123",
|
|
17
|
+
* threadTimestamp: "123456789"
|
|
18
|
+
* },
|
|
19
|
+
* justification: "The user directly asked to update the Relocations Confluence document with this text.",
|
|
20
|
+
* auditLogId: "3df3f2b8-3df3-11ef-9a96-332d447011ef"
|
|
21
|
+
* }
|
|
22
|
+
*/
|
|
23
|
+
export interface InvokeActionRequest {
|
|
24
|
+
actionId: string;
|
|
25
|
+
/**
|
|
26
|
+
* The inputs needed to execute the action
|
|
27
|
+
*
|
|
28
|
+
*/
|
|
29
|
+
actionInputs?: unknown;
|
|
30
|
+
/**
|
|
31
|
+
* The user who we should take the action on behalf of
|
|
32
|
+
*
|
|
33
|
+
*/
|
|
34
|
+
userEmail: string;
|
|
35
|
+
/**
|
|
36
|
+
* 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.
|
|
37
|
+
*
|
|
38
|
+
*/
|
|
39
|
+
requireHumanConfirmation?: boolean;
|
|
40
|
+
/**
|
|
41
|
+
* Where we should ask for human confirmation if necessary
|
|
42
|
+
*
|
|
43
|
+
*/
|
|
44
|
+
humanConfirmationChannel: Credal.HumanConfirmationChannel;
|
|
45
|
+
/**
|
|
46
|
+
* The justification for requesting this action. This is likely generated by the LLM that requested the action.
|
|
47
|
+
*
|
|
48
|
+
*/
|
|
49
|
+
justification: string;
|
|
50
|
+
/**
|
|
51
|
+
* Audit log for the message that called for this action
|
|
52
|
+
*
|
|
53
|
+
*/
|
|
54
|
+
auditLogId: string;
|
|
55
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { type InvokeActionRequest } from "./InvokeActionRequest";
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./types"), exports);
|
|
18
|
+
__exportStar(require("./client"), exports);
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
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";
|
|
5
|
+
export declare const ActionStatus: {
|
|
6
|
+
readonly PendingApproval: "PENDING_APPROVAL";
|
|
7
|
+
readonly ApprovedInProgress: "APPROVED_IN_PROGRESS";
|
|
8
|
+
readonly NoApprovalNeededInProgress: "NO_APPROVAL_NEEDED_IN_PROGRESS";
|
|
9
|
+
readonly ApprovedSucceeded: "APPROVED_SUCCEEDED";
|
|
10
|
+
readonly ApprovedFailed: "APPROVED_FAILED";
|
|
11
|
+
readonly NoApprovalNeededSucceeded: "NO_APPROVAL_NEEDED_SUCCEEDED";
|
|
12
|
+
readonly NoApprovalNeededFailed: "NO_APPROVAL_NEEDED_FAILED";
|
|
13
|
+
};
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
4
|
+
*/
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.ActionStatus = void 0;
|
|
7
|
+
exports.ActionStatus = {
|
|
8
|
+
PendingApproval: "PENDING_APPROVAL",
|
|
9
|
+
ApprovedInProgress: "APPROVED_IN_PROGRESS",
|
|
10
|
+
NoApprovalNeededInProgress: "NO_APPROVAL_NEEDED_IN_PROGRESS",
|
|
11
|
+
ApprovedSucceeded: "APPROVED_SUCCEEDED",
|
|
12
|
+
ApprovedFailed: "APPROVED_FAILED",
|
|
13
|
+
NoApprovalNeededSucceeded: "NO_APPROVAL_NEEDED_SUCCEEDED",
|
|
14
|
+
NoApprovalNeededFailed: "NO_APPROVAL_NEEDED_FAILED",
|
|
15
|
+
};
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Credal from "../../../index";
|
|
5
|
+
export declare type HumanConfirmationChannel = Credal.HumanConfirmationChannel.DirectMessage | Credal.HumanConfirmationChannel.SlackThread | Credal.HumanConfirmationChannel.Conversation;
|
|
6
|
+
export declare namespace HumanConfirmationChannel {
|
|
7
|
+
interface DirectMessage extends Credal.DirectMessage {
|
|
8
|
+
type: "directMessage";
|
|
9
|
+
}
|
|
10
|
+
interface SlackThread extends Credal.SlackThread {
|
|
11
|
+
type: "slackThread";
|
|
12
|
+
}
|
|
13
|
+
interface Conversation extends Credal.Conversation {
|
|
14
|
+
type: "conversation";
|
|
15
|
+
}
|
|
16
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./HumanConfirmationChannel"), exports);
|
|
18
|
+
__exportStar(require("./DirectMessage"), exports);
|
|
19
|
+
__exportStar(require("./SlackThread"), exports);
|
|
20
|
+
__exportStar(require("./Conversation"), exports);
|
|
21
|
+
__exportStar(require("./InvokeActionResponse"), exports);
|
|
22
|
+
__exportStar(require("./ActionStatus"), exports);
|
|
@@ -79,10 +79,10 @@ export declare class Copilots {
|
|
|
79
79
|
* userEmail: "ravin@credal.ai",
|
|
80
80
|
* inputVariables: [{
|
|
81
81
|
* name: "input1",
|
|
82
|
-
*
|
|
82
|
+
* ids: ["82e4b12a-6990-45d4-8ebd-85c00e030c24"]
|
|
83
83
|
* }, {
|
|
84
84
|
* name: "input2",
|
|
85
|
-
*
|
|
85
|
+
* ids: ["82e4b12a-6990-45d4-8ebd-85c00e030c25", "82e4b12a-6990-45d4-8ebd-85c00e030c26"]
|
|
86
86
|
* }]
|
|
87
87
|
* })
|
|
88
88
|
*/
|
|
@@ -74,8 +74,8 @@ class Copilots {
|
|
|
74
74
|
Authorization: yield this._getAuthorizationHeader(),
|
|
75
75
|
"X-Fern-Language": "JavaScript",
|
|
76
76
|
"X-Fern-SDK-Name": "@credal/sdk",
|
|
77
|
-
"X-Fern-SDK-Version": "0.0.
|
|
78
|
-
"User-Agent": "@credal/sdk/0.0.
|
|
77
|
+
"X-Fern-SDK-Version": "0.0.18",
|
|
78
|
+
"User-Agent": "@credal/sdk/0.0.18",
|
|
79
79
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
80
80
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
81
81
|
},
|
|
@@ -137,8 +137,8 @@ class Copilots {
|
|
|
137
137
|
Authorization: yield this._getAuthorizationHeader(),
|
|
138
138
|
"X-Fern-Language": "JavaScript",
|
|
139
139
|
"X-Fern-SDK-Name": "@credal/sdk",
|
|
140
|
-
"X-Fern-SDK-Version": "0.0.
|
|
141
|
-
"User-Agent": "@credal/sdk/0.0.
|
|
140
|
+
"X-Fern-SDK-Version": "0.0.18",
|
|
141
|
+
"User-Agent": "@credal/sdk/0.0.18",
|
|
142
142
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
143
143
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
144
144
|
},
|
|
@@ -203,8 +203,8 @@ class Copilots {
|
|
|
203
203
|
Authorization: yield this._getAuthorizationHeader(),
|
|
204
204
|
"X-Fern-Language": "JavaScript",
|
|
205
205
|
"X-Fern-SDK-Name": "@credal/sdk",
|
|
206
|
-
"X-Fern-SDK-Version": "0.0.
|
|
207
|
-
"User-Agent": "@credal/sdk/0.0.
|
|
206
|
+
"X-Fern-SDK-Version": "0.0.18",
|
|
207
|
+
"User-Agent": "@credal/sdk/0.0.18",
|
|
208
208
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
209
209
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
210
210
|
},
|
|
@@ -250,10 +250,10 @@ class Copilots {
|
|
|
250
250
|
* userEmail: "ravin@credal.ai",
|
|
251
251
|
* inputVariables: [{
|
|
252
252
|
* name: "input1",
|
|
253
|
-
*
|
|
253
|
+
* ids: ["82e4b12a-6990-45d4-8ebd-85c00e030c24"]
|
|
254
254
|
* }, {
|
|
255
255
|
* name: "input2",
|
|
256
|
-
*
|
|
256
|
+
* ids: ["82e4b12a-6990-45d4-8ebd-85c00e030c25", "82e4b12a-6990-45d4-8ebd-85c00e030c26"]
|
|
257
257
|
* }]
|
|
258
258
|
* })
|
|
259
259
|
*/
|
|
@@ -267,8 +267,8 @@ class Copilots {
|
|
|
267
267
|
Authorization: yield this._getAuthorizationHeader(),
|
|
268
268
|
"X-Fern-Language": "JavaScript",
|
|
269
269
|
"X-Fern-SDK-Name": "@credal/sdk",
|
|
270
|
-
"X-Fern-SDK-Version": "0.0.
|
|
271
|
-
"User-Agent": "@credal/sdk/0.0.
|
|
270
|
+
"X-Fern-SDK-Version": "0.0.18",
|
|
271
|
+
"User-Agent": "@credal/sdk/0.0.18",
|
|
272
272
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
273
273
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
274
274
|
},
|
|
@@ -321,8 +321,8 @@ class Copilots {
|
|
|
321
321
|
Authorization: yield this._getAuthorizationHeader(),
|
|
322
322
|
"X-Fern-Language": "JavaScript",
|
|
323
323
|
"X-Fern-SDK-Name": "@credal/sdk",
|
|
324
|
-
"X-Fern-SDK-Version": "0.0.
|
|
325
|
-
"User-Agent": "@credal/sdk/0.0.
|
|
324
|
+
"X-Fern-SDK-Version": "0.0.18",
|
|
325
|
+
"User-Agent": "@credal/sdk/0.0.18",
|
|
326
326
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
327
327
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
328
328
|
},
|
|
@@ -395,8 +395,8 @@ class Copilots {
|
|
|
395
395
|
Authorization: yield this._getAuthorizationHeader(),
|
|
396
396
|
"X-Fern-Language": "JavaScript",
|
|
397
397
|
"X-Fern-SDK-Name": "@credal/sdk",
|
|
398
|
-
"X-Fern-SDK-Version": "0.0.
|
|
399
|
-
"User-Agent": "@credal/sdk/0.0.
|
|
398
|
+
"X-Fern-SDK-Version": "0.0.18",
|
|
399
|
+
"User-Agent": "@credal/sdk/0.0.18",
|
|
400
400
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
401
401
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
402
402
|
},
|
|
@@ -453,8 +453,8 @@ class Copilots {
|
|
|
453
453
|
Authorization: yield this._getAuthorizationHeader(),
|
|
454
454
|
"X-Fern-Language": "JavaScript",
|
|
455
455
|
"X-Fern-SDK-Name": "@credal/sdk",
|
|
456
|
-
"X-Fern-SDK-Version": "0.0.
|
|
457
|
-
"User-Agent": "@credal/sdk/0.0.
|
|
456
|
+
"X-Fern-SDK-Version": "0.0.18",
|
|
457
|
+
"User-Agent": "@credal/sdk/0.0.18",
|
|
458
458
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
459
459
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
460
460
|
},
|
|
@@ -521,8 +521,8 @@ class Copilots {
|
|
|
521
521
|
Authorization: yield this._getAuthorizationHeader(),
|
|
522
522
|
"X-Fern-Language": "JavaScript",
|
|
523
523
|
"X-Fern-SDK-Name": "@credal/sdk",
|
|
524
|
-
"X-Fern-SDK-Version": "0.0.
|
|
525
|
-
"User-Agent": "@credal/sdk/0.0.
|
|
524
|
+
"X-Fern-SDK-Version": "0.0.18",
|
|
525
|
+
"User-Agent": "@credal/sdk/0.0.18",
|
|
526
526
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
527
527
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
528
528
|
},
|
|
@@ -576,8 +576,8 @@ class Copilots {
|
|
|
576
576
|
Authorization: yield this._getAuthorizationHeader(),
|
|
577
577
|
"X-Fern-Language": "JavaScript",
|
|
578
578
|
"X-Fern-SDK-Name": "@credal/sdk",
|
|
579
|
-
"X-Fern-SDK-Version": "0.0.
|
|
580
|
-
"User-Agent": "@credal/sdk/0.0.
|
|
579
|
+
"X-Fern-SDK-Version": "0.0.18",
|
|
580
|
+
"User-Agent": "@credal/sdk/0.0.18",
|
|
581
581
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
582
582
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
583
583
|
},
|