@athenaintel/sdk 4.3.2335 → 4.3.2337
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/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/resources/bundles/client/Client.d.ts +17 -0
- package/dist/cjs/api/resources/bundles/client/Client.js +88 -0
- package/dist/cjs/api/resources/bundles/client/requests/GetDescriptorBundlesRequest.d.ts +14 -0
- package/dist/cjs/api/resources/bundles/client/requests/GetDescriptorBundlesRequest.js +3 -0
- package/dist/cjs/api/resources/bundles/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/types/BundleDescriptorMemberOut.d.ts +9 -0
- package/dist/cjs/api/types/BundleDescriptorMemberOut.js +3 -0
- package/dist/cjs/api/types/BundleDescriptorOut.d.ts +18 -0
- package/dist/cjs/api/types/BundleDescriptorOut.js +3 -0
- package/dist/cjs/api/types/BundleDescriptorSlotOut.d.ts +9 -0
- package/dist/cjs/api/types/BundleDescriptorSlotOut.js +3 -0
- package/dist/cjs/api/types/SheetOperationResponse.d.ts +2 -0
- package/dist/cjs/api/types/index.d.ts +3 -0
- package/dist/cjs/api/types/index.js +3 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/api/resources/bundles/client/Client.d.mts +17 -0
- package/dist/esm/api/resources/bundles/client/Client.mjs +88 -0
- package/dist/esm/api/resources/bundles/client/requests/GetDescriptorBundlesRequest.d.mts +14 -0
- package/dist/esm/api/resources/bundles/client/requests/GetDescriptorBundlesRequest.mjs +2 -0
- package/dist/esm/api/resources/bundles/client/requests/index.d.mts +1 -0
- package/dist/esm/api/types/BundleDescriptorMemberOut.d.mts +9 -0
- package/dist/esm/api/types/BundleDescriptorMemberOut.mjs +2 -0
- package/dist/esm/api/types/BundleDescriptorOut.d.mts +18 -0
- package/dist/esm/api/types/BundleDescriptorOut.mjs +2 -0
- package/dist/esm/api/types/BundleDescriptorSlotOut.d.mts +9 -0
- package/dist/esm/api/types/BundleDescriptorSlotOut.mjs +2 -0
- package/dist/esm/api/types/SheetOperationResponse.d.mts +2 -0
- package/dist/esm/api/types/index.d.mts +3 -0
- package/dist/esm/api/types/index.mjs +3 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +65 -0
package/dist/cjs/BaseClient.js
CHANGED
|
@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
|
|
|
43
43
|
const headers = (0, headers_js_1.mergeHeaders)({
|
|
44
44
|
"X-Fern-Language": "JavaScript",
|
|
45
45
|
"X-Fern-SDK-Name": "@athenaintel/sdk",
|
|
46
|
-
"X-Fern-SDK-Version": "4.3.
|
|
47
|
-
"User-Agent": "@athenaintel/sdk/4.3.
|
|
46
|
+
"X-Fern-SDK-Version": "4.3.2337",
|
|
47
|
+
"User-Agent": "@athenaintel/sdk/4.3.2337",
|
|
48
48
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
49
49
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
50
50
|
"X-Athena-Session-Credential": options === null || options === void 0 ? void 0 : options.sessionCredential,
|
|
@@ -11,6 +11,23 @@ export declare namespace BundlesClient {
|
|
|
11
11
|
export declare class BundlesClient {
|
|
12
12
|
protected readonly _options: NormalizedClientOptionsWithAuth<BundlesClient.Options>;
|
|
13
13
|
constructor(options?: BundlesClient.Options);
|
|
14
|
+
/**
|
|
15
|
+
* Read what a bundle's track serves in this workspace: the asset and type behind each member key, and each slot's kind and state (filled, not_used or waiting; never a value). Production unless track names another. The caller needs view access to the bundle as a member of its workspace; a member the caller can't open is left out. Every refusal is 404, the same answer a key that names nothing gets.
|
|
16
|
+
*
|
|
17
|
+
* @param {AthenaIntelligence.GetDescriptorBundlesRequest} request
|
|
18
|
+
* @param {BundlesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
19
|
+
*
|
|
20
|
+
* @throws {@link AthenaIntelligence.BadRequestError}
|
|
21
|
+
* @throws {@link AthenaIntelligence.NotFoundError}
|
|
22
|
+
* @throws {@link AthenaIntelligence.UnprocessableEntityError}
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* await client.bundles.getDescriptor({
|
|
26
|
+
* bundle_key: "support-desk"
|
|
27
|
+
* })
|
|
28
|
+
*/
|
|
29
|
+
getDescriptor(request: AthenaIntelligence.GetDescriptorBundlesRequest, requestOptions?: BundlesClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.BundleDescriptorOut>;
|
|
30
|
+
private __getDescriptor;
|
|
14
31
|
/**
|
|
15
32
|
* Resolve a bundle member's name, support-desk/support_agent, to this workspace's own asset: its id, type and link, and with track the revision that track serves. The caller needs view access to the bundle as a member of its workspace, and to the member. Every refusal is 404, the same answer a name that doesn't exist gets.
|
|
16
33
|
*
|
|
@@ -54,6 +54,94 @@ class BundlesClient {
|
|
|
54
54
|
constructor(options = {}) {
|
|
55
55
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
56
56
|
}
|
|
57
|
+
/**
|
|
58
|
+
* Read what a bundle's track serves in this workspace: the asset and type behind each member key, and each slot's kind and state (filled, not_used or waiting; never a value). Production unless track names another. The caller needs view access to the bundle as a member of its workspace; a member the caller can't open is left out. Every refusal is 404, the same answer a key that names nothing gets.
|
|
59
|
+
*
|
|
60
|
+
* @param {AthenaIntelligence.GetDescriptorBundlesRequest} request
|
|
61
|
+
* @param {BundlesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link AthenaIntelligence.BadRequestError}
|
|
64
|
+
* @throws {@link AthenaIntelligence.NotFoundError}
|
|
65
|
+
* @throws {@link AthenaIntelligence.UnprocessableEntityError}
|
|
66
|
+
*
|
|
67
|
+
* @example
|
|
68
|
+
* await client.bundles.getDescriptor({
|
|
69
|
+
* bundle_key: "support-desk"
|
|
70
|
+
* })
|
|
71
|
+
*/
|
|
72
|
+
getDescriptor(request, requestOptions) {
|
|
73
|
+
return core.HttpResponsePromise.fromPromise(this.__getDescriptor(request, requestOptions));
|
|
74
|
+
}
|
|
75
|
+
__getDescriptor(request, requestOptions) {
|
|
76
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
77
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
|
|
78
|
+
const { bundle_key: bundleKey, workspace_id: workspaceId, track } = request;
|
|
79
|
+
const _queryParams = {};
|
|
80
|
+
if (workspaceId !== undefined) {
|
|
81
|
+
_queryParams.workspace_id = workspaceId;
|
|
82
|
+
}
|
|
83
|
+
if (track !== undefined) {
|
|
84
|
+
_queryParams.track = track;
|
|
85
|
+
}
|
|
86
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
87
|
+
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
|
|
88
|
+
"X-Athena-Session-Credential": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.sessionCredential) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.sessionCredential,
|
|
89
|
+
}), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
90
|
+
const _response = yield ((_d = this._options.fetcher) !== null && _d !== void 0 ? _d : core.fetcher)({
|
|
91
|
+
url: core.url.join((_f = (_e = (yield core.Supplier.get(this._options.baseUrl))) !== null && _e !== void 0 ? _e : (yield core.Supplier.get(this._options.environment))) !== null && _f !== void 0 ? _f : environments.AthenaIntelligenceEnvironment.Production, `api/v0/bundles/${core.url.encodePathParam(bundleKey)}/descriptor`),
|
|
92
|
+
method: "GET",
|
|
93
|
+
headers: _headers,
|
|
94
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
95
|
+
timeoutMs: ((_j = (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.timeoutInSeconds) !== null && _j !== void 0 ? _j : 60) * 1000,
|
|
96
|
+
maxRetries: (_k = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _k !== void 0 ? _k : (_l = this._options) === null || _l === void 0 ? void 0 : _l.maxRetries,
|
|
97
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
98
|
+
fetchFn: (_m = this._options) === null || _m === void 0 ? void 0 : _m.fetch,
|
|
99
|
+
logging: this._options.logging,
|
|
100
|
+
});
|
|
101
|
+
if (_response.ok) {
|
|
102
|
+
return {
|
|
103
|
+
data: _response.body,
|
|
104
|
+
rawResponse: _response.rawResponse,
|
|
105
|
+
};
|
|
106
|
+
}
|
|
107
|
+
if (_response.error.reason === "status-code") {
|
|
108
|
+
switch (_response.error.statusCode) {
|
|
109
|
+
case 400:
|
|
110
|
+
throw new AthenaIntelligence.BadRequestError(_response.error.body, _response.rawResponse);
|
|
111
|
+
case 404:
|
|
112
|
+
throw new AthenaIntelligence.NotFoundError(_response.error.body, _response.rawResponse);
|
|
113
|
+
case 422:
|
|
114
|
+
throw new AthenaIntelligence.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
115
|
+
default:
|
|
116
|
+
throw new errors.AthenaIntelligenceError({
|
|
117
|
+
statusCode: _response.error.statusCode,
|
|
118
|
+
body: _response.error.body,
|
|
119
|
+
rawResponse: _response.rawResponse,
|
|
120
|
+
});
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
switch (_response.error.reason) {
|
|
124
|
+
case "non-json":
|
|
125
|
+
throw new errors.AthenaIntelligenceError({
|
|
126
|
+
statusCode: _response.error.statusCode,
|
|
127
|
+
body: _response.error.rawBody,
|
|
128
|
+
rawResponse: _response.rawResponse,
|
|
129
|
+
});
|
|
130
|
+
case "body-is-null":
|
|
131
|
+
throw new errors.AthenaIntelligenceError({
|
|
132
|
+
statusCode: _response.error.statusCode,
|
|
133
|
+
rawResponse: _response.rawResponse,
|
|
134
|
+
});
|
|
135
|
+
case "timeout":
|
|
136
|
+
throw new errors.AthenaIntelligenceTimeoutError("Timeout exceeded when calling GET /api/v0/bundles/{bundle_key}/descriptor.");
|
|
137
|
+
case "unknown":
|
|
138
|
+
throw new errors.AthenaIntelligenceError({
|
|
139
|
+
message: _response.error.errorMessage,
|
|
140
|
+
rawResponse: _response.rawResponse,
|
|
141
|
+
});
|
|
142
|
+
}
|
|
143
|
+
});
|
|
144
|
+
}
|
|
57
145
|
/**
|
|
58
146
|
* Resolve a bundle member's name, support-desk/support_agent, to this workspace's own asset: its id, type and link, and with track the revision that track serves. The caller needs view access to the bundle as a member of its workspace, and to the member. Every refusal is 404, the same answer a name that doesn't exist gets.
|
|
59
147
|
*
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* bundle_key: "support-desk"
|
|
5
|
+
* }
|
|
6
|
+
*/
|
|
7
|
+
export interface GetDescriptorBundlesRequest {
|
|
8
|
+
/** The bundle's permanent key. */
|
|
9
|
+
bundle_key: string;
|
|
10
|
+
/** The workspace to read in. Optional for a caller with one workspace, and for a credential bound to one; a caller in several names it. The caller must be a member. */
|
|
11
|
+
workspace_id?: string | null;
|
|
12
|
+
/** A track's key (production, pilot…): answer what it serves. Production when omitted. The caller must be on the track. */
|
|
13
|
+
track?: string | null;
|
|
14
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type * as AthenaIntelligence from "../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* What a bundle's track serves, as an app reads it.
|
|
4
|
+
*/
|
|
5
|
+
export interface BundleDescriptorOut {
|
|
6
|
+
/** The bundle's permanent key. */
|
|
7
|
+
bundle_key: string;
|
|
8
|
+
/** The shape's version: 1. */
|
|
9
|
+
descriptor: number;
|
|
10
|
+
/** By member key: each member the caller may open. A member the caller can't open is absent. */
|
|
11
|
+
members: Record<string, AthenaIntelligence.BundleDescriptorMemberOut>;
|
|
12
|
+
/** By slot key: every slot the served version declares. */
|
|
13
|
+
slots: Record<string, AthenaIntelligence.BundleDescriptorSlotOut>;
|
|
14
|
+
/** The track the answer read, e.g. production. */
|
|
15
|
+
track: string;
|
|
16
|
+
/** The version the track serves, major.minor. */
|
|
17
|
+
version: string;
|
|
18
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* One slot of a deployment: what it asks for and where the track stands.
|
|
3
|
+
*/
|
|
4
|
+
export interface BundleDescriptorSlotOut {
|
|
5
|
+
/** What the slot asks for: phone_number, mailbox, database, connection, computer_image, place, lakehouse_namespace, outside_source, text, secret or slack_install. */
|
|
6
|
+
kind: string;
|
|
7
|
+
/** filled (the track's fill is in force), not_used (the track doesn't use it) or waiting (nothing in force). Never a value. */
|
|
8
|
+
state: string;
|
|
9
|
+
}
|
|
@@ -7,4 +7,6 @@ export interface SheetOperationResponse {
|
|
|
7
7
|
new_sheet_id?: number | null;
|
|
8
8
|
/** Whether the operation was successful */
|
|
9
9
|
success: boolean;
|
|
10
|
+
/** Things the caller should know about an operation that succeeded. Each entry starts with a stable code and a colon, e.g. 'formula_dependents_not_recalculated: ...' when a write landed on a workbook past the calculation engine's size caps, so formulas that depend on the written cells kept their previous values until they are next read. Absent when there is nothing to report. */
|
|
11
|
+
warnings?: string[] | null;
|
|
10
12
|
}
|
|
@@ -32,6 +32,9 @@ export * from "./AssetScreenshotResponseOut.js";
|
|
|
32
32
|
export * from "./BorderModel.js";
|
|
33
33
|
export * from "./BorderStyle.js";
|
|
34
34
|
export * from "./BordersModel.js";
|
|
35
|
+
export * from "./BundleDescriptorMemberOut.js";
|
|
36
|
+
export * from "./BundleDescriptorOut.js";
|
|
37
|
+
export * from "./BundleDescriptorSlotOut.js";
|
|
35
38
|
export * from "./BundleMemberOut.js";
|
|
36
39
|
export * from "./BundleMemberRevisionOut.js";
|
|
37
40
|
export * from "./CalendarAttendeeOut.js";
|
|
@@ -48,6 +48,9 @@ __exportStar(require("./AssetScreenshotResponseOut.js"), exports);
|
|
|
48
48
|
__exportStar(require("./BorderModel.js"), exports);
|
|
49
49
|
__exportStar(require("./BorderStyle.js"), exports);
|
|
50
50
|
__exportStar(require("./BordersModel.js"), exports);
|
|
51
|
+
__exportStar(require("./BundleDescriptorMemberOut.js"), exports);
|
|
52
|
+
__exportStar(require("./BundleDescriptorOut.js"), exports);
|
|
53
|
+
__exportStar(require("./BundleDescriptorSlotOut.js"), exports);
|
|
51
54
|
__exportStar(require("./BundleMemberOut.js"), exports);
|
|
52
55
|
__exportStar(require("./BundleMemberRevisionOut.js"), exports);
|
|
53
56
|
__exportStar(require("./CalendarAttendeeOut.js"), exports);
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "4.3.
|
|
1
|
+
export declare const SDK_VERSION = "4.3.2337";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/BaseClient.mjs
CHANGED
|
@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
|
|
|
6
6
|
const headers = mergeHeaders({
|
|
7
7
|
"X-Fern-Language": "JavaScript",
|
|
8
8
|
"X-Fern-SDK-Name": "@athenaintel/sdk",
|
|
9
|
-
"X-Fern-SDK-Version": "4.3.
|
|
10
|
-
"User-Agent": "@athenaintel/sdk/4.3.
|
|
9
|
+
"X-Fern-SDK-Version": "4.3.2337",
|
|
10
|
+
"User-Agent": "@athenaintel/sdk/4.3.2337",
|
|
11
11
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
12
12
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
13
13
|
"X-Athena-Session-Credential": options === null || options === void 0 ? void 0 : options.sessionCredential,
|
|
@@ -11,6 +11,23 @@ export declare namespace BundlesClient {
|
|
|
11
11
|
export declare class BundlesClient {
|
|
12
12
|
protected readonly _options: NormalizedClientOptionsWithAuth<BundlesClient.Options>;
|
|
13
13
|
constructor(options?: BundlesClient.Options);
|
|
14
|
+
/**
|
|
15
|
+
* Read what a bundle's track serves in this workspace: the asset and type behind each member key, and each slot's kind and state (filled, not_used or waiting; never a value). Production unless track names another. The caller needs view access to the bundle as a member of its workspace; a member the caller can't open is left out. Every refusal is 404, the same answer a key that names nothing gets.
|
|
16
|
+
*
|
|
17
|
+
* @param {AthenaIntelligence.GetDescriptorBundlesRequest} request
|
|
18
|
+
* @param {BundlesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
19
|
+
*
|
|
20
|
+
* @throws {@link AthenaIntelligence.BadRequestError}
|
|
21
|
+
* @throws {@link AthenaIntelligence.NotFoundError}
|
|
22
|
+
* @throws {@link AthenaIntelligence.UnprocessableEntityError}
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* await client.bundles.getDescriptor({
|
|
26
|
+
* bundle_key: "support-desk"
|
|
27
|
+
* })
|
|
28
|
+
*/
|
|
29
|
+
getDescriptor(request: AthenaIntelligence.GetDescriptorBundlesRequest, requestOptions?: BundlesClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.BundleDescriptorOut>;
|
|
30
|
+
private __getDescriptor;
|
|
14
31
|
/**
|
|
15
32
|
* Resolve a bundle member's name, support-desk/support_agent, to this workspace's own asset: its id, type and link, and with track the revision that track serves. The caller needs view access to the bundle as a member of its workspace, and to the member. Every refusal is 404, the same answer a name that doesn't exist gets.
|
|
16
33
|
*
|
|
@@ -18,6 +18,94 @@ export class BundlesClient {
|
|
|
18
18
|
constructor(options = {}) {
|
|
19
19
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
20
20
|
}
|
|
21
|
+
/**
|
|
22
|
+
* Read what a bundle's track serves in this workspace: the asset and type behind each member key, and each slot's kind and state (filled, not_used or waiting; never a value). Production unless track names another. The caller needs view access to the bundle as a member of its workspace; a member the caller can't open is left out. Every refusal is 404, the same answer a key that names nothing gets.
|
|
23
|
+
*
|
|
24
|
+
* @param {AthenaIntelligence.GetDescriptorBundlesRequest} request
|
|
25
|
+
* @param {BundlesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
26
|
+
*
|
|
27
|
+
* @throws {@link AthenaIntelligence.BadRequestError}
|
|
28
|
+
* @throws {@link AthenaIntelligence.NotFoundError}
|
|
29
|
+
* @throws {@link AthenaIntelligence.UnprocessableEntityError}
|
|
30
|
+
*
|
|
31
|
+
* @example
|
|
32
|
+
* await client.bundles.getDescriptor({
|
|
33
|
+
* bundle_key: "support-desk"
|
|
34
|
+
* })
|
|
35
|
+
*/
|
|
36
|
+
getDescriptor(request, requestOptions) {
|
|
37
|
+
return core.HttpResponsePromise.fromPromise(this.__getDescriptor(request, requestOptions));
|
|
38
|
+
}
|
|
39
|
+
__getDescriptor(request, requestOptions) {
|
|
40
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
41
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
|
|
42
|
+
const { bundle_key: bundleKey, workspace_id: workspaceId, track } = request;
|
|
43
|
+
const _queryParams = {};
|
|
44
|
+
if (workspaceId !== undefined) {
|
|
45
|
+
_queryParams.workspace_id = workspaceId;
|
|
46
|
+
}
|
|
47
|
+
if (track !== undefined) {
|
|
48
|
+
_queryParams.track = track;
|
|
49
|
+
}
|
|
50
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
51
|
+
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({
|
|
52
|
+
"X-Athena-Session-Credential": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.sessionCredential) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.sessionCredential,
|
|
53
|
+
}), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
54
|
+
const _response = yield ((_d = this._options.fetcher) !== null && _d !== void 0 ? _d : core.fetcher)({
|
|
55
|
+
url: core.url.join((_f = (_e = (yield core.Supplier.get(this._options.baseUrl))) !== null && _e !== void 0 ? _e : (yield core.Supplier.get(this._options.environment))) !== null && _f !== void 0 ? _f : environments.AthenaIntelligenceEnvironment.Production, `api/v0/bundles/${core.url.encodePathParam(bundleKey)}/descriptor`),
|
|
56
|
+
method: "GET",
|
|
57
|
+
headers: _headers,
|
|
58
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
59
|
+
timeoutMs: ((_j = (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.timeoutInSeconds) !== null && _j !== void 0 ? _j : 60) * 1000,
|
|
60
|
+
maxRetries: (_k = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _k !== void 0 ? _k : (_l = this._options) === null || _l === void 0 ? void 0 : _l.maxRetries,
|
|
61
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
62
|
+
fetchFn: (_m = this._options) === null || _m === void 0 ? void 0 : _m.fetch,
|
|
63
|
+
logging: this._options.logging,
|
|
64
|
+
});
|
|
65
|
+
if (_response.ok) {
|
|
66
|
+
return {
|
|
67
|
+
data: _response.body,
|
|
68
|
+
rawResponse: _response.rawResponse,
|
|
69
|
+
};
|
|
70
|
+
}
|
|
71
|
+
if (_response.error.reason === "status-code") {
|
|
72
|
+
switch (_response.error.statusCode) {
|
|
73
|
+
case 400:
|
|
74
|
+
throw new AthenaIntelligence.BadRequestError(_response.error.body, _response.rawResponse);
|
|
75
|
+
case 404:
|
|
76
|
+
throw new AthenaIntelligence.NotFoundError(_response.error.body, _response.rawResponse);
|
|
77
|
+
case 422:
|
|
78
|
+
throw new AthenaIntelligence.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
79
|
+
default:
|
|
80
|
+
throw new errors.AthenaIntelligenceError({
|
|
81
|
+
statusCode: _response.error.statusCode,
|
|
82
|
+
body: _response.error.body,
|
|
83
|
+
rawResponse: _response.rawResponse,
|
|
84
|
+
});
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
switch (_response.error.reason) {
|
|
88
|
+
case "non-json":
|
|
89
|
+
throw new errors.AthenaIntelligenceError({
|
|
90
|
+
statusCode: _response.error.statusCode,
|
|
91
|
+
body: _response.error.rawBody,
|
|
92
|
+
rawResponse: _response.rawResponse,
|
|
93
|
+
});
|
|
94
|
+
case "body-is-null":
|
|
95
|
+
throw new errors.AthenaIntelligenceError({
|
|
96
|
+
statusCode: _response.error.statusCode,
|
|
97
|
+
rawResponse: _response.rawResponse,
|
|
98
|
+
});
|
|
99
|
+
case "timeout":
|
|
100
|
+
throw new errors.AthenaIntelligenceTimeoutError("Timeout exceeded when calling GET /api/v0/bundles/{bundle_key}/descriptor.");
|
|
101
|
+
case "unknown":
|
|
102
|
+
throw new errors.AthenaIntelligenceError({
|
|
103
|
+
message: _response.error.errorMessage,
|
|
104
|
+
rawResponse: _response.rawResponse,
|
|
105
|
+
});
|
|
106
|
+
}
|
|
107
|
+
});
|
|
108
|
+
}
|
|
21
109
|
/**
|
|
22
110
|
* Resolve a bundle member's name, support-desk/support_agent, to this workspace's own asset: its id, type and link, and with track the revision that track serves. The caller needs view access to the bundle as a member of its workspace, and to the member. Every refusal is 404, the same answer a name that doesn't exist gets.
|
|
23
111
|
*
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* bundle_key: "support-desk"
|
|
5
|
+
* }
|
|
6
|
+
*/
|
|
7
|
+
export interface GetDescriptorBundlesRequest {
|
|
8
|
+
/** The bundle's permanent key. */
|
|
9
|
+
bundle_key: string;
|
|
10
|
+
/** The workspace to read in. Optional for a caller with one workspace, and for a credential bound to one; a caller in several names it. The caller must be a member. */
|
|
11
|
+
workspace_id?: string | null;
|
|
12
|
+
/** A track's key (production, pilot…): answer what it serves. Production when omitted. The caller must be on the track. */
|
|
13
|
+
track?: string | null;
|
|
14
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type * as AthenaIntelligence from "../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* What a bundle's track serves, as an app reads it.
|
|
4
|
+
*/
|
|
5
|
+
export interface BundleDescriptorOut {
|
|
6
|
+
/** The bundle's permanent key. */
|
|
7
|
+
bundle_key: string;
|
|
8
|
+
/** The shape's version: 1. */
|
|
9
|
+
descriptor: number;
|
|
10
|
+
/** By member key: each member the caller may open. A member the caller can't open is absent. */
|
|
11
|
+
members: Record<string, AthenaIntelligence.BundleDescriptorMemberOut>;
|
|
12
|
+
/** By slot key: every slot the served version declares. */
|
|
13
|
+
slots: Record<string, AthenaIntelligence.BundleDescriptorSlotOut>;
|
|
14
|
+
/** The track the answer read, e.g. production. */
|
|
15
|
+
track: string;
|
|
16
|
+
/** The version the track serves, major.minor. */
|
|
17
|
+
version: string;
|
|
18
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* One slot of a deployment: what it asks for and where the track stands.
|
|
3
|
+
*/
|
|
4
|
+
export interface BundleDescriptorSlotOut {
|
|
5
|
+
/** What the slot asks for: phone_number, mailbox, database, connection, computer_image, place, lakehouse_namespace, outside_source, text, secret or slack_install. */
|
|
6
|
+
kind: string;
|
|
7
|
+
/** filled (the track's fill is in force), not_used (the track doesn't use it) or waiting (nothing in force). Never a value. */
|
|
8
|
+
state: string;
|
|
9
|
+
}
|
|
@@ -7,4 +7,6 @@ export interface SheetOperationResponse {
|
|
|
7
7
|
new_sheet_id?: number | null;
|
|
8
8
|
/** Whether the operation was successful */
|
|
9
9
|
success: boolean;
|
|
10
|
+
/** Things the caller should know about an operation that succeeded. Each entry starts with a stable code and a colon, e.g. 'formula_dependents_not_recalculated: ...' when a write landed on a workbook past the calculation engine's size caps, so formulas that depend on the written cells kept their previous values until they are next read. Absent when there is nothing to report. */
|
|
11
|
+
warnings?: string[] | null;
|
|
10
12
|
}
|
|
@@ -32,6 +32,9 @@ export * from "./AssetScreenshotResponseOut.mjs";
|
|
|
32
32
|
export * from "./BorderModel.mjs";
|
|
33
33
|
export * from "./BorderStyle.mjs";
|
|
34
34
|
export * from "./BordersModel.mjs";
|
|
35
|
+
export * from "./BundleDescriptorMemberOut.mjs";
|
|
36
|
+
export * from "./BundleDescriptorOut.mjs";
|
|
37
|
+
export * from "./BundleDescriptorSlotOut.mjs";
|
|
35
38
|
export * from "./BundleMemberOut.mjs";
|
|
36
39
|
export * from "./BundleMemberRevisionOut.mjs";
|
|
37
40
|
export * from "./CalendarAttendeeOut.mjs";
|
|
@@ -32,6 +32,9 @@ export * from "./AssetScreenshotResponseOut.mjs";
|
|
|
32
32
|
export * from "./BorderModel.mjs";
|
|
33
33
|
export * from "./BorderStyle.mjs";
|
|
34
34
|
export * from "./BordersModel.mjs";
|
|
35
|
+
export * from "./BundleDescriptorMemberOut.mjs";
|
|
36
|
+
export * from "./BundleDescriptorOut.mjs";
|
|
37
|
+
export * from "./BundleDescriptorSlotOut.mjs";
|
|
35
38
|
export * from "./BundleMemberOut.mjs";
|
|
36
39
|
export * from "./BundleMemberRevisionOut.mjs";
|
|
37
40
|
export * from "./CalendarAttendeeOut.mjs";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "4.3.
|
|
1
|
+
export declare const SDK_VERSION = "4.3.2337";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "4.3.
|
|
1
|
+
export const SDK_VERSION = "4.3.2337";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -2298,6 +2298,71 @@ await client.assets.removeWorkspaceAccess({
|
|
|
2298
2298
|
</details>
|
|
2299
2299
|
|
|
2300
2300
|
## Bundles
|
|
2301
|
+
<details><summary><code>client.bundles.<a href="/src/api/resources/bundles/client/Client.ts">getDescriptor</a>({ ...params }) -> AthenaIntelligence.BundleDescriptorOut</code></summary>
|
|
2302
|
+
<dl>
|
|
2303
|
+
<dd>
|
|
2304
|
+
|
|
2305
|
+
#### 📝 Description
|
|
2306
|
+
|
|
2307
|
+
<dl>
|
|
2308
|
+
<dd>
|
|
2309
|
+
|
|
2310
|
+
<dl>
|
|
2311
|
+
<dd>
|
|
2312
|
+
|
|
2313
|
+
Read what a bundle's track serves in this workspace: the asset and type behind each member key, and each slot's kind and state (filled, not_used or waiting; never a value). Production unless track names another. The caller needs view access to the bundle as a member of its workspace; a member the caller can't open is left out. Every refusal is 404, the same answer a key that names nothing gets.
|
|
2314
|
+
</dd>
|
|
2315
|
+
</dl>
|
|
2316
|
+
</dd>
|
|
2317
|
+
</dl>
|
|
2318
|
+
|
|
2319
|
+
#### 🔌 Usage
|
|
2320
|
+
|
|
2321
|
+
<dl>
|
|
2322
|
+
<dd>
|
|
2323
|
+
|
|
2324
|
+
<dl>
|
|
2325
|
+
<dd>
|
|
2326
|
+
|
|
2327
|
+
```typescript
|
|
2328
|
+
await client.bundles.getDescriptor({
|
|
2329
|
+
bundle_key: "support-desk"
|
|
2330
|
+
});
|
|
2331
|
+
|
|
2332
|
+
```
|
|
2333
|
+
</dd>
|
|
2334
|
+
</dl>
|
|
2335
|
+
</dd>
|
|
2336
|
+
</dl>
|
|
2337
|
+
|
|
2338
|
+
#### ⚙️ Parameters
|
|
2339
|
+
|
|
2340
|
+
<dl>
|
|
2341
|
+
<dd>
|
|
2342
|
+
|
|
2343
|
+
<dl>
|
|
2344
|
+
<dd>
|
|
2345
|
+
|
|
2346
|
+
**request:** `AthenaIntelligence.GetDescriptorBundlesRequest`
|
|
2347
|
+
|
|
2348
|
+
</dd>
|
|
2349
|
+
</dl>
|
|
2350
|
+
|
|
2351
|
+
<dl>
|
|
2352
|
+
<dd>
|
|
2353
|
+
|
|
2354
|
+
**requestOptions:** `BundlesClient.RequestOptions`
|
|
2355
|
+
|
|
2356
|
+
</dd>
|
|
2357
|
+
</dl>
|
|
2358
|
+
</dd>
|
|
2359
|
+
</dl>
|
|
2360
|
+
|
|
2361
|
+
|
|
2362
|
+
</dd>
|
|
2363
|
+
</dl>
|
|
2364
|
+
</details>
|
|
2365
|
+
|
|
2301
2366
|
<details><summary><code>client.bundles.<a href="/src/api/resources/bundles/client/Client.ts">getMember</a>({ ...params }) -> AthenaIntelligence.BundleMemberOut</code></summary>
|
|
2302
2367
|
<dl>
|
|
2303
2368
|
<dd>
|