@athenaintel/sdk 4.3.2266 → 4.3.2268

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.
Files changed (40) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/assets/client/Client.d.ts +23 -1
  3. package/dist/cjs/api/resources/assets/client/Client.js +94 -1
  4. package/dist/cjs/api/resources/assets/client/requests/CreateAssetRequestIn.d.ts +3 -1
  5. package/dist/cjs/api/resources/assets/client/requests/CreateStudioTokenAssetsRequest.d.ts +15 -0
  6. package/dist/cjs/api/resources/assets/client/requests/CreateStudioTokenAssetsRequest.js +3 -0
  7. package/dist/cjs/api/resources/assets/client/requests/index.d.ts +1 -0
  8. package/dist/cjs/api/types/CreatableAssetType.d.ts +1 -0
  9. package/dist/cjs/api/types/CreatableAssetType.js +1 -0
  10. package/dist/cjs/api/types/PublicFigureConfigIn.d.ts +28 -0
  11. package/dist/cjs/api/types/PublicFigureConfigIn.js +3 -0
  12. package/dist/cjs/api/types/StudioTokenRequestIn.d.ts +15 -0
  13. package/dist/cjs/api/types/StudioTokenRequestIn.js +12 -0
  14. package/dist/cjs/api/types/StudioTokenResponseOut.d.ts +32 -0
  15. package/dist/cjs/api/types/StudioTokenResponseOut.js +18 -0
  16. package/dist/cjs/api/types/index.d.ts +3 -0
  17. package/dist/cjs/api/types/index.js +3 -0
  18. package/dist/cjs/version.d.ts +1 -1
  19. package/dist/cjs/version.js +1 -1
  20. package/dist/esm/BaseClient.mjs +2 -2
  21. package/dist/esm/api/resources/assets/client/Client.d.mts +23 -1
  22. package/dist/esm/api/resources/assets/client/Client.mjs +94 -1
  23. package/dist/esm/api/resources/assets/client/requests/CreateAssetRequestIn.d.mts +3 -1
  24. package/dist/esm/api/resources/assets/client/requests/CreateStudioTokenAssetsRequest.d.mts +15 -0
  25. package/dist/esm/api/resources/assets/client/requests/CreateStudioTokenAssetsRequest.mjs +2 -0
  26. package/dist/esm/api/resources/assets/client/requests/index.d.mts +1 -0
  27. package/dist/esm/api/types/CreatableAssetType.d.mts +1 -0
  28. package/dist/esm/api/types/CreatableAssetType.mjs +1 -0
  29. package/dist/esm/api/types/PublicFigureConfigIn.d.mts +28 -0
  30. package/dist/esm/api/types/PublicFigureConfigIn.mjs +2 -0
  31. package/dist/esm/api/types/StudioTokenRequestIn.d.mts +15 -0
  32. package/dist/esm/api/types/StudioTokenRequestIn.mjs +9 -0
  33. package/dist/esm/api/types/StudioTokenResponseOut.d.mts +32 -0
  34. package/dist/esm/api/types/StudioTokenResponseOut.mjs +15 -0
  35. package/dist/esm/api/types/index.d.mts +3 -0
  36. package/dist/esm/api/types/index.mjs +3 -0
  37. package/dist/esm/version.d.mts +1 -1
  38. package/dist/esm/version.mjs +1 -1
  39. package/package.json +1 -1
  40. package/reference.md +69 -1
@@ -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.2266",
47
- "User-Agent": "@athenaintel/sdk/4.3.2266",
46
+ "X-Fern-SDK-Version": "4.3.2268",
47
+ "User-Agent": "@athenaintel/sdk/4.3.2268",
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,
@@ -50,7 +50,7 @@ export declare class AssetsClient {
50
50
  convertExcelToSheet(request: AthenaIntelligence.ConvertExcelToSheetRequestIn, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.ConvertExcelToSheetResponseOut>;
51
51
  private __convertExcelToSheet;
52
52
  /**
53
- * Create a new asset such as a spreadsheet, document, folder, database, computer, user interface, skill, collab agent, or generic doc (admin-only) in your workspace with your current permissions. Computer assets return 202 after durable submission, which commits the asset and initialization delivery intent together. Runtime provisioning continues asynchronously. Inspect the returned asset ID for progress instead of repeating creation. Computers accept the same configuration as the Athena UI's creation dialog: template, provider, cpu, memory (GiB), disk (GiB) and env_vars. Sizes must be offered by the environment's computer resource policy, and only admins may pick a size other than the template default (403 otherwise). In capability enforce mode, computer creation requires computer.create and returns 403 when denied. Databases accept suspend_timeout_seconds, the auto-suspend window from the database's Settings in Athena: 0 keeps the database running (it never suspends, and keeps using capacity), otherwise 60 to 86400 seconds. A database is provisioned in the background: poll GET /api/v0/databases/{asset_id}/compute-status until it reports running or suspended. Without workspace_id the asset is created in the workspace of parent_folder_id when one is given, otherwise in your current workspace; you must be a member of that workspace.
53
+ * Create a new asset such as a spreadsheet, document, folder, database, computer, user interface, skill, collab agent, figure, or generic doc (admin-only) in your workspace with your current permissions. Computer assets return 202 after durable submission, which commits the asset and initialization delivery intent together. Runtime provisioning continues asynchronously. Inspect the returned asset ID for progress instead of repeating creation. Computers accept the same configuration as the Athena UI's creation dialog: template, provider, cpu, memory (GiB), disk (GiB) and env_vars. Sizes must be offered by the environment's computer resource policy, and only admins may pick a size other than the template default (403 otherwise). In capability enforce mode, computer creation requires computer.create and returns 403 when denied. Databases accept suspend_timeout_seconds, the auto-suspend window from the database's Settings in Athena: 0 keeps the database running (it never suspends, and keeps using capacity), otherwise 60 to 86400 seconds. A database is provisioned in the background: poll GET /api/v0/databases/{asset_id}/compute-status until it reports running or suspended. Figures take figure_config, a FigureSpec (kind, rendered and provenance, plus spec or chart), validated as the Athena UI's figures are. Without workspace_id the asset is created in the workspace of parent_folder_id when one is given, otherwise in your current workspace; you must be a member of that workspace.
54
54
  *
55
55
  * @param {AthenaIntelligence.CreateAssetRequestIn} request
56
56
  * @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -413,6 +413,28 @@ export declare class AssetsClient {
413
413
  */
414
414
  updateSkillConfig(request: AthenaIntelligence.UpdateSkillConfigRequestIn, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.UpdateAssetConfigResponseOut>;
415
415
  private __updateSkillConfig;
416
+ /**
417
+ * Mint a short-lived asset token for the service that edits an asset: a spreadsheet's, a Word document's or a deck's, named in ``audience``. The token names the caller, this asset and one access level, lasts 15 minutes and is good only on that service's routes for this asset, so code (an SDK in a computer, for example) never sends the service a long-lived credential. The caller must be able to view the asset and be a member of its workspace; the token is read-write only when the caller can edit the asset and asked for edit. A computer's or session's credential mints tokens for assets of its own workspace only. Any other asset (another type, a live provider file, or one outside every workspace) is refused with 422.
418
+ *
419
+ * @param {AthenaIntelligence.CreateStudioTokenAssetsRequest} request
420
+ * @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
421
+ *
422
+ * @throws {@link AthenaIntelligence.BadRequestError}
423
+ * @throws {@link AthenaIntelligence.ForbiddenError}
424
+ * @throws {@link AthenaIntelligence.NotFoundError}
425
+ * @throws {@link AthenaIntelligence.UnprocessableEntityError}
426
+ * @throws {@link AthenaIntelligence.ServiceUnavailableError}
427
+ *
428
+ * @example
429
+ * await client.assets.createStudioToken({
430
+ * asset_id: "asset_92492920-d118-42d3-95b4-00eccfe0754f",
431
+ * body: {
432
+ * access: "edit"
433
+ * }
434
+ * })
435
+ */
436
+ createStudioToken(request: AthenaIntelligence.CreateStudioTokenAssetsRequest, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.StudioTokenResponseOut>;
437
+ private __createStudioToken;
416
438
  /**
417
439
  * Update the workspace-level access on an asset. Needs edit access to the asset. Set 'view' or 'edit' to grant workspace-wide access, which also needs permission to share with the workspace. Set 'none' (or null) to remove the workspace-wide share, as DELETE does; removing a folder's share also removes it from the assets inside the folder. People and groups the asset is shared with directly keep their access.
418
440
  *
@@ -255,7 +255,7 @@ class AssetsClient {
255
255
  });
256
256
  }
257
257
  /**
258
- * Create a new asset such as a spreadsheet, document, folder, database, computer, user interface, skill, collab agent, or generic doc (admin-only) in your workspace with your current permissions. Computer assets return 202 after durable submission, which commits the asset and initialization delivery intent together. Runtime provisioning continues asynchronously. Inspect the returned asset ID for progress instead of repeating creation. Computers accept the same configuration as the Athena UI's creation dialog: template, provider, cpu, memory (GiB), disk (GiB) and env_vars. Sizes must be offered by the environment's computer resource policy, and only admins may pick a size other than the template default (403 otherwise). In capability enforce mode, computer creation requires computer.create and returns 403 when denied. Databases accept suspend_timeout_seconds, the auto-suspend window from the database's Settings in Athena: 0 keeps the database running (it never suspends, and keeps using capacity), otherwise 60 to 86400 seconds. A database is provisioned in the background: poll GET /api/v0/databases/{asset_id}/compute-status until it reports running or suspended. Without workspace_id the asset is created in the workspace of parent_folder_id when one is given, otherwise in your current workspace; you must be a member of that workspace.
258
+ * Create a new asset such as a spreadsheet, document, folder, database, computer, user interface, skill, collab agent, figure, or generic doc (admin-only) in your workspace with your current permissions. Computer assets return 202 after durable submission, which commits the asset and initialization delivery intent together. Runtime provisioning continues asynchronously. Inspect the returned asset ID for progress instead of repeating creation. Computers accept the same configuration as the Athena UI's creation dialog: template, provider, cpu, memory (GiB), disk (GiB) and env_vars. Sizes must be offered by the environment's computer resource policy, and only admins may pick a size other than the template default (403 otherwise). In capability enforce mode, computer creation requires computer.create and returns 403 when denied. Databases accept suspend_timeout_seconds, the auto-suspend window from the database's Settings in Athena: 0 keeps the database running (it never suspends, and keeps using capacity), otherwise 60 to 86400 seconds. A database is provisioned in the background: poll GET /api/v0/databases/{asset_id}/compute-status until it reports running or suspended. Figures take figure_config, a FigureSpec (kind, rendered and provenance, plus spec or chart), validated as the Athena UI's figures are. Without workspace_id the asset is created in the workspace of parent_folder_id when one is given, otherwise in your current workspace; you must be a member of that workspace.
259
259
  *
260
260
  * @param {AthenaIntelligence.CreateAssetRequestIn} request
261
261
  * @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -1867,6 +1867,99 @@ class AssetsClient {
1867
1867
  }
1868
1868
  });
1869
1869
  }
1870
+ /**
1871
+ * Mint a short-lived asset token for the service that edits an asset: a spreadsheet's, a Word document's or a deck's, named in ``audience``. The token names the caller, this asset and one access level, lasts 15 minutes and is good only on that service's routes for this asset, so code (an SDK in a computer, for example) never sends the service a long-lived credential. The caller must be able to view the asset and be a member of its workspace; the token is read-write only when the caller can edit the asset and asked for edit. A computer's or session's credential mints tokens for assets of its own workspace only. Any other asset (another type, a live provider file, or one outside every workspace) is refused with 422.
1872
+ *
1873
+ * @param {AthenaIntelligence.CreateStudioTokenAssetsRequest} request
1874
+ * @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
1875
+ *
1876
+ * @throws {@link AthenaIntelligence.BadRequestError}
1877
+ * @throws {@link AthenaIntelligence.ForbiddenError}
1878
+ * @throws {@link AthenaIntelligence.NotFoundError}
1879
+ * @throws {@link AthenaIntelligence.UnprocessableEntityError}
1880
+ * @throws {@link AthenaIntelligence.ServiceUnavailableError}
1881
+ *
1882
+ * @example
1883
+ * await client.assets.createStudioToken({
1884
+ * asset_id: "asset_92492920-d118-42d3-95b4-00eccfe0754f",
1885
+ * body: {
1886
+ * access: "edit"
1887
+ * }
1888
+ * })
1889
+ */
1890
+ createStudioToken(request, requestOptions) {
1891
+ return core.HttpResponsePromise.fromPromise(this.__createStudioToken(request, requestOptions));
1892
+ }
1893
+ __createStudioToken(request, requestOptions) {
1894
+ return __awaiter(this, void 0, void 0, function* () {
1895
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
1896
+ const { asset_id: assetId, body: _body } = request;
1897
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
1898
+ 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)({
1899
+ "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,
1900
+ }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
1901
+ const _response = yield ((_d = this._options.fetcher) !== null && _d !== void 0 ? _d : core.fetcher)({
1902
+ 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/assets/${core.url.encodePathParam(assetId)}/studio-token`),
1903
+ method: "POST",
1904
+ headers: _headers,
1905
+ contentType: "application/json",
1906
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
1907
+ requestType: "json",
1908
+ body: _body != null ? _body : undefined,
1909
+ 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,
1910
+ 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,
1911
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
1912
+ fetchFn: (_m = this._options) === null || _m === void 0 ? void 0 : _m.fetch,
1913
+ logging: this._options.logging,
1914
+ });
1915
+ if (_response.ok) {
1916
+ return {
1917
+ data: _response.body,
1918
+ rawResponse: _response.rawResponse,
1919
+ };
1920
+ }
1921
+ if (_response.error.reason === "status-code") {
1922
+ switch (_response.error.statusCode) {
1923
+ case 400:
1924
+ throw new AthenaIntelligence.BadRequestError(_response.error.body, _response.rawResponse);
1925
+ case 403:
1926
+ throw new AthenaIntelligence.ForbiddenError(_response.error.body, _response.rawResponse);
1927
+ case 404:
1928
+ throw new AthenaIntelligence.NotFoundError(_response.error.body, _response.rawResponse);
1929
+ case 422:
1930
+ throw new AthenaIntelligence.UnprocessableEntityError(_response.error.body, _response.rawResponse);
1931
+ case 503:
1932
+ throw new AthenaIntelligence.ServiceUnavailableError(_response.error.body, _response.rawResponse);
1933
+ default:
1934
+ throw new errors.AthenaIntelligenceError({
1935
+ statusCode: _response.error.statusCode,
1936
+ body: _response.error.body,
1937
+ rawResponse: _response.rawResponse,
1938
+ });
1939
+ }
1940
+ }
1941
+ switch (_response.error.reason) {
1942
+ case "non-json":
1943
+ throw new errors.AthenaIntelligenceError({
1944
+ statusCode: _response.error.statusCode,
1945
+ body: _response.error.rawBody,
1946
+ rawResponse: _response.rawResponse,
1947
+ });
1948
+ case "body-is-null":
1949
+ throw new errors.AthenaIntelligenceError({
1950
+ statusCode: _response.error.statusCode,
1951
+ rawResponse: _response.rawResponse,
1952
+ });
1953
+ case "timeout":
1954
+ throw new errors.AthenaIntelligenceTimeoutError("Timeout exceeded when calling POST /api/v0/assets/{asset_id}/studio-token.");
1955
+ case "unknown":
1956
+ throw new errors.AthenaIntelligenceError({
1957
+ message: _response.error.errorMessage,
1958
+ rawResponse: _response.rawResponse,
1959
+ });
1960
+ }
1961
+ });
1962
+ }
1870
1963
  /**
1871
1964
  * Update the workspace-level access on an asset. Needs edit access to the asset. Set 'view' or 'edit' to grant workspace-wide access, which also needs permission to share with the workspace. Set 'none' (or null) to remove the workspace-wide share, as DELETE does; removing a folder's share also removes it from the assets inside the folder. People and groups the asset is shared with directly keep their access.
1872
1965
  *
@@ -10,7 +10,7 @@ import type * as AthenaIntelligence from "../../../../index.js";
10
10
  export interface CreateAssetRequestIn {
11
11
  /** collab_agent only. Initial agent configuration. Created as a draft; publish it with POST /api/v0/assets/{asset_id}/publish. */
12
12
  agent_config?: AthenaIntelligence.PublicCollabAgentConfigIn | null;
13
- /** Type of asset to create. Supported types: 'spreadsheet' (or 'sheet'), 'document' (or 'doc'), 'folder', 'database' (or 'db'), 'computer', 'generic_doc', 'user_interface' (or 'ui'), 'skill', 'collab_agent' (or 'agent') */
13
+ /** Type of asset to create. Supported types: 'spreadsheet' (or 'sheet'), 'document' (or 'doc'), 'folder', 'database' (or 'db'), 'computer', 'generic_doc', 'user_interface' (or 'ui'), 'skill', 'collab_agent' (or 'agent'), 'figure' */
14
14
  asset_type: AthenaIntelligence.CreatableAssetType;
15
15
  /** Computer only. vCPU count. Defaults to the template's default. Must be a size the environment's computer resource policy offers; sizes other than the template default require an admin. */
16
16
  cpu?: number | null;
@@ -18,6 +18,8 @@ export interface CreateAssetRequestIn {
18
18
  disk?: number | null;
19
19
  /** Computer only. Environment variables to set on the computer. Must include every key the template or environment requires. Also accepted as 'envVars'. */
20
20
  env_vars?: Record<string, string | null> | null;
21
+ /** figure only. The figure's FigureSpec: kind, rendered and provenance, plus spec (plotly, vega-lite) or chart (chart, mixed) and the optional fields. */
22
+ figure_config?: AthenaIntelligence.PublicFigureConfigIn | null;
21
23
  /** user_interface only. HTML used as the interface's initial index.html; without it the interface starts from Athena's starter page. */
22
24
  html_content?: string | null;
23
25
  /** Computer only. Memory in GiB. Defaults to the template's default. Same policy and admin rules as cpu. */
@@ -0,0 +1,15 @@
1
+ import type * as AthenaIntelligence from "../../../../index.js";
2
+ /**
3
+ * @example
4
+ * {
5
+ * asset_id: "asset_92492920-d118-42d3-95b4-00eccfe0754f",
6
+ * body: {
7
+ * access: "edit"
8
+ * }
9
+ * }
10
+ */
11
+ export interface CreateStudioTokenAssetsRequest {
12
+ /** The spreadsheet, Word document or deck to mint a token for */
13
+ asset_id: string;
14
+ body: AthenaIntelligence.StudioTokenRequestIn | null;
15
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -5,6 +5,7 @@ export type { ConvertExcelToSheetRequestIn } from "./ConvertExcelToSheetRequestI
5
5
  export type { ConvertToUserInterfaceAssetsRequest } from "./ConvertToUserInterfaceAssetsRequest.js";
6
6
  export type { CreateAssetRequestIn } from "./CreateAssetRequestIn.js";
7
7
  export type { CreateProjectRequestIn } from "./CreateProjectRequestIn.js";
8
+ export type { CreateStudioTokenAssetsRequest } from "./CreateStudioTokenAssetsRequest.js";
8
9
  export type { DownloadAssetsRequest } from "./DownloadAssetsRequest.js";
9
10
  export type { DuplicateAssetRequestIn } from "./DuplicateAssetRequestIn.js";
10
11
  export type { GetAccessAssetsRequest } from "./GetAccessAssetsRequest.js";
@@ -9,5 +9,6 @@ export declare const CreatableAssetType: {
9
9
  readonly UserInterface: "user_interface";
10
10
  readonly Skill: "skill";
11
11
  readonly CollabAgent: "collab_agent";
12
+ readonly Figure: "figure";
12
13
  };
13
14
  export type CreatableAssetType = (typeof CreatableAssetType)[keyof typeof CreatableAssetType];
@@ -13,4 +13,5 @@ exports.CreatableAssetType = {
13
13
  UserInterface: "user_interface",
14
14
  Skill: "skill",
15
15
  CollabAgent: "collab_agent",
16
+ Figure: "figure",
16
17
  };
@@ -0,0 +1,28 @@
1
+ /**
2
+ * A figure's FigureSpec for ``POST /api/v0/assets/create``.
3
+ *
4
+ * The unified shape only (``kind`` set); the create service validates it
5
+ * against the FigureSpec union, the same check ``createFigureTyped`` runs.
6
+ */
7
+ export interface PublicFigureConfigIn {
8
+ /** Alt text (image figures) */
9
+ alt_text?: string | null;
10
+ /** chart / mixed only: the chart spec */
11
+ chart?: Record<string, unknown> | null;
12
+ /** Optional tabular snapshot supporting edit-later flows */
13
+ data_snapshot?: Record<string, unknown> | null;
14
+ /** Description */
15
+ description?: string | null;
16
+ /** FigureSpec discriminator: plotly, vega-lite, chart, mixed or image */
17
+ kind: string;
18
+ /** Where the figure came from (runtime, library, versions) */
19
+ provenance: Record<string, unknown>;
20
+ /** The rendered preview every FigureSpec carries */
21
+ rendered: Record<string, unknown>;
22
+ /** Where the data came from */
23
+ source?: Record<string, unknown> | null;
24
+ /** plotly / vega-lite only: the library spec */
25
+ spec?: Record<string, unknown> | null;
26
+ /** Overrides a person applied on top of the spec */
27
+ user_overrides?: Record<string, unknown> | null;
28
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,15 @@
1
+ /**
2
+ * The access a studio token is asked for: a ceiling, not a grant.
3
+ */
4
+ export interface StudioTokenRequestIn {
5
+ /** 'edit' asks for a read-write token and gets one only when the caller can edit the asset (and it is not archived); 'view' always gets a read-only token. Omitted, the token carries the caller's own access. */
6
+ access?: StudioTokenRequestIn.Access;
7
+ }
8
+ export declare namespace StudioTokenRequestIn {
9
+ /** 'edit' asks for a read-write token and gets one only when the caller can edit the asset (and it is not archived); 'view' always gets a read-only token. Omitted, the token carries the caller's own access. */
10
+ const Access: {
11
+ readonly View: "view";
12
+ readonly Edit: "edit";
13
+ };
14
+ type Access = (typeof Access)[keyof typeof Access];
15
+ }
@@ -0,0 +1,12 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.StudioTokenRequestIn = void 0;
5
+ var StudioTokenRequestIn;
6
+ (function (StudioTokenRequestIn) {
7
+ /** 'edit' asks for a read-write token and gets one only when the caller can edit the asset (and it is not archived); 'view' always gets a read-only token. Omitted, the token carries the caller's own access. */
8
+ StudioTokenRequestIn.Access = {
9
+ View: "view",
10
+ Edit: "edit",
11
+ };
12
+ })(StudioTokenRequestIn || (exports.StudioTokenRequestIn = StudioTokenRequestIn = {}));
@@ -0,0 +1,32 @@
1
+ /**
2
+ * An asset token for the service that edits the asset.
3
+ */
4
+ export interface StudioTokenResponseOut {
5
+ /** The access the token carries: r reads only (the service refuses its writes), rw reads and writes. The service still checks the caller's live permission on every request. */
6
+ access_type: StudioTokenResponseOut.AccessType;
7
+ /** The asset the token is for. */
8
+ asset_id: string;
9
+ /** The editing service the token is for, as the token's audience identifier: one for spreadsheets, one for Word documents, one for decks. Compare it with the service you call before sending the token. */
10
+ audience: StudioTokenResponseOut.Audience;
11
+ /** For a deck, the id the deck's editing service names it by in its routes (an older deck's own deck id, else its asset id); the token is good for that id. Null for any other asset. */
12
+ deck_id?: string | null;
13
+ /** Expiry in epoch milliseconds, at most 15 minutes from now. Mint a new token before it passes. */
14
+ expires_at_ms: number;
15
+ /** The asset token (``aat_…``). Send it as ``Authorization: Bearer <token>`` to the editing service ``audience`` names, on its routes for this asset only: it names one user, this asset, one access level and that service, and every other route and service refuses it. */
16
+ token: string;
17
+ }
18
+ export declare namespace StudioTokenResponseOut {
19
+ /** The access the token carries: r reads only (the service refuses its writes), rw reads and writes. The service still checks the caller's live permission on every request. */
20
+ const AccessType: {
21
+ readonly R: "r";
22
+ readonly Rw: "rw";
23
+ };
24
+ type AccessType = (typeof AccessType)[keyof typeof AccessType];
25
+ /** The editing service the token is for, as the token's audience identifier: one for spreadsheets, one for Word documents, one for decks. Compare it with the service you call before sending the token. */
26
+ const Audience: {
27
+ readonly DocxStudio: "docx-studio";
28
+ readonly PptxStudio: "pptx-studio";
29
+ readonly XlsxStudio: "xlsx-studio";
30
+ };
31
+ type Audience = (typeof Audience)[keyof typeof Audience];
32
+ }
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.StudioTokenResponseOut = void 0;
5
+ var StudioTokenResponseOut;
6
+ (function (StudioTokenResponseOut) {
7
+ /** The access the token carries: r reads only (the service refuses its writes), rw reads and writes. The service still checks the caller's live permission on every request. */
8
+ StudioTokenResponseOut.AccessType = {
9
+ R: "r",
10
+ Rw: "rw",
11
+ };
12
+ /** The editing service the token is for, as the token's audience identifier: one for spreadsheets, one for Word documents, one for decks. Compare it with the service you call before sending the token. */
13
+ StudioTokenResponseOut.Audience = {
14
+ DocxStudio: "docx-studio",
15
+ PptxStudio: "pptx-studio",
16
+ XlsxStudio: "xlsx-studio",
17
+ };
18
+ })(StudioTokenResponseOut || (exports.StudioTokenResponseOut = StudioTokenResponseOut = {}));
@@ -113,6 +113,7 @@ export * from "./PresenceTokenResponseOut.js";
113
113
  export * from "./PromptMessage.js";
114
114
  export * from "./PublicAssetOut.js";
115
115
  export * from "./PublicCollabAgentConfigIn.js";
116
+ export * from "./PublicFigureConfigIn.js";
116
117
  export * from "./PublicSessionComputerIn.js";
117
118
  export * from "./PublicSessionSetupStepIn.js";
118
119
  export * from "./PublicSkillConfigIn.js";
@@ -144,6 +145,8 @@ export * from "./SshAccessTokenOut.js";
144
145
  export * from "./SshKeyListResponseOut.js";
145
146
  export * from "./SshKeyOut.js";
146
147
  export * from "./StructuredDataExtractorResponse.js";
148
+ export * from "./StudioTokenRequestIn.js";
149
+ export * from "./StudioTokenResponseOut.js";
147
150
  export * from "./TableRowData.js";
148
151
  export * from "./TextContent.js";
149
152
  export * from "./TextFormatModel.js";
@@ -129,6 +129,7 @@ __exportStar(require("./PresenceTokenResponseOut.js"), exports);
129
129
  __exportStar(require("./PromptMessage.js"), exports);
130
130
  __exportStar(require("./PublicAssetOut.js"), exports);
131
131
  __exportStar(require("./PublicCollabAgentConfigIn.js"), exports);
132
+ __exportStar(require("./PublicFigureConfigIn.js"), exports);
132
133
  __exportStar(require("./PublicSessionComputerIn.js"), exports);
133
134
  __exportStar(require("./PublicSessionSetupStepIn.js"), exports);
134
135
  __exportStar(require("./PublicSkillConfigIn.js"), exports);
@@ -160,6 +161,8 @@ __exportStar(require("./SshAccessTokenOut.js"), exports);
160
161
  __exportStar(require("./SshKeyListResponseOut.js"), exports);
161
162
  __exportStar(require("./SshKeyOut.js"), exports);
162
163
  __exportStar(require("./StructuredDataExtractorResponse.js"), exports);
164
+ __exportStar(require("./StudioTokenRequestIn.js"), exports);
165
+ __exportStar(require("./StudioTokenResponseOut.js"), exports);
163
166
  __exportStar(require("./TableRowData.js"), exports);
164
167
  __exportStar(require("./TextContent.js"), exports);
165
168
  __exportStar(require("./TextFormatModel.js"), exports);
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "4.3.2266";
1
+ export declare const SDK_VERSION = "4.3.2268";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "4.3.2266";
4
+ exports.SDK_VERSION = "4.3.2268";
@@ -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.2266",
10
- "User-Agent": "@athenaintel/sdk/4.3.2266",
9
+ "X-Fern-SDK-Version": "4.3.2268",
10
+ "User-Agent": "@athenaintel/sdk/4.3.2268",
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,
@@ -50,7 +50,7 @@ export declare class AssetsClient {
50
50
  convertExcelToSheet(request: AthenaIntelligence.ConvertExcelToSheetRequestIn, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.ConvertExcelToSheetResponseOut>;
51
51
  private __convertExcelToSheet;
52
52
  /**
53
- * Create a new asset such as a spreadsheet, document, folder, database, computer, user interface, skill, collab agent, or generic doc (admin-only) in your workspace with your current permissions. Computer assets return 202 after durable submission, which commits the asset and initialization delivery intent together. Runtime provisioning continues asynchronously. Inspect the returned asset ID for progress instead of repeating creation. Computers accept the same configuration as the Athena UI's creation dialog: template, provider, cpu, memory (GiB), disk (GiB) and env_vars. Sizes must be offered by the environment's computer resource policy, and only admins may pick a size other than the template default (403 otherwise). In capability enforce mode, computer creation requires computer.create and returns 403 when denied. Databases accept suspend_timeout_seconds, the auto-suspend window from the database's Settings in Athena: 0 keeps the database running (it never suspends, and keeps using capacity), otherwise 60 to 86400 seconds. A database is provisioned in the background: poll GET /api/v0/databases/{asset_id}/compute-status until it reports running or suspended. Without workspace_id the asset is created in the workspace of parent_folder_id when one is given, otherwise in your current workspace; you must be a member of that workspace.
53
+ * Create a new asset such as a spreadsheet, document, folder, database, computer, user interface, skill, collab agent, figure, or generic doc (admin-only) in your workspace with your current permissions. Computer assets return 202 after durable submission, which commits the asset and initialization delivery intent together. Runtime provisioning continues asynchronously. Inspect the returned asset ID for progress instead of repeating creation. Computers accept the same configuration as the Athena UI's creation dialog: template, provider, cpu, memory (GiB), disk (GiB) and env_vars. Sizes must be offered by the environment's computer resource policy, and only admins may pick a size other than the template default (403 otherwise). In capability enforce mode, computer creation requires computer.create and returns 403 when denied. Databases accept suspend_timeout_seconds, the auto-suspend window from the database's Settings in Athena: 0 keeps the database running (it never suspends, and keeps using capacity), otherwise 60 to 86400 seconds. A database is provisioned in the background: poll GET /api/v0/databases/{asset_id}/compute-status until it reports running or suspended. Figures take figure_config, a FigureSpec (kind, rendered and provenance, plus spec or chart), validated as the Athena UI's figures are. Without workspace_id the asset is created in the workspace of parent_folder_id when one is given, otherwise in your current workspace; you must be a member of that workspace.
54
54
  *
55
55
  * @param {AthenaIntelligence.CreateAssetRequestIn} request
56
56
  * @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -413,6 +413,28 @@ export declare class AssetsClient {
413
413
  */
414
414
  updateSkillConfig(request: AthenaIntelligence.UpdateSkillConfigRequestIn, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.UpdateAssetConfigResponseOut>;
415
415
  private __updateSkillConfig;
416
+ /**
417
+ * Mint a short-lived asset token for the service that edits an asset: a spreadsheet's, a Word document's or a deck's, named in ``audience``. The token names the caller, this asset and one access level, lasts 15 minutes and is good only on that service's routes for this asset, so code (an SDK in a computer, for example) never sends the service a long-lived credential. The caller must be able to view the asset and be a member of its workspace; the token is read-write only when the caller can edit the asset and asked for edit. A computer's or session's credential mints tokens for assets of its own workspace only. Any other asset (another type, a live provider file, or one outside every workspace) is refused with 422.
418
+ *
419
+ * @param {AthenaIntelligence.CreateStudioTokenAssetsRequest} request
420
+ * @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
421
+ *
422
+ * @throws {@link AthenaIntelligence.BadRequestError}
423
+ * @throws {@link AthenaIntelligence.ForbiddenError}
424
+ * @throws {@link AthenaIntelligence.NotFoundError}
425
+ * @throws {@link AthenaIntelligence.UnprocessableEntityError}
426
+ * @throws {@link AthenaIntelligence.ServiceUnavailableError}
427
+ *
428
+ * @example
429
+ * await client.assets.createStudioToken({
430
+ * asset_id: "asset_92492920-d118-42d3-95b4-00eccfe0754f",
431
+ * body: {
432
+ * access: "edit"
433
+ * }
434
+ * })
435
+ */
436
+ createStudioToken(request: AthenaIntelligence.CreateStudioTokenAssetsRequest, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.StudioTokenResponseOut>;
437
+ private __createStudioToken;
416
438
  /**
417
439
  * Update the workspace-level access on an asset. Needs edit access to the asset. Set 'view' or 'edit' to grant workspace-wide access, which also needs permission to share with the workspace. Set 'none' (or null) to remove the workspace-wide share, as DELETE does; removing a folder's share also removes it from the assets inside the folder. People and groups the asset is shared with directly keep their access.
418
440
  *
@@ -219,7 +219,7 @@ export class AssetsClient {
219
219
  });
220
220
  }
221
221
  /**
222
- * Create a new asset such as a spreadsheet, document, folder, database, computer, user interface, skill, collab agent, or generic doc (admin-only) in your workspace with your current permissions. Computer assets return 202 after durable submission, which commits the asset and initialization delivery intent together. Runtime provisioning continues asynchronously. Inspect the returned asset ID for progress instead of repeating creation. Computers accept the same configuration as the Athena UI's creation dialog: template, provider, cpu, memory (GiB), disk (GiB) and env_vars. Sizes must be offered by the environment's computer resource policy, and only admins may pick a size other than the template default (403 otherwise). In capability enforce mode, computer creation requires computer.create and returns 403 when denied. Databases accept suspend_timeout_seconds, the auto-suspend window from the database's Settings in Athena: 0 keeps the database running (it never suspends, and keeps using capacity), otherwise 60 to 86400 seconds. A database is provisioned in the background: poll GET /api/v0/databases/{asset_id}/compute-status until it reports running or suspended. Without workspace_id the asset is created in the workspace of parent_folder_id when one is given, otherwise in your current workspace; you must be a member of that workspace.
222
+ * Create a new asset such as a spreadsheet, document, folder, database, computer, user interface, skill, collab agent, figure, or generic doc (admin-only) in your workspace with your current permissions. Computer assets return 202 after durable submission, which commits the asset and initialization delivery intent together. Runtime provisioning continues asynchronously. Inspect the returned asset ID for progress instead of repeating creation. Computers accept the same configuration as the Athena UI's creation dialog: template, provider, cpu, memory (GiB), disk (GiB) and env_vars. Sizes must be offered by the environment's computer resource policy, and only admins may pick a size other than the template default (403 otherwise). In capability enforce mode, computer creation requires computer.create and returns 403 when denied. Databases accept suspend_timeout_seconds, the auto-suspend window from the database's Settings in Athena: 0 keeps the database running (it never suspends, and keeps using capacity), otherwise 60 to 86400 seconds. A database is provisioned in the background: poll GET /api/v0/databases/{asset_id}/compute-status until it reports running or suspended. Figures take figure_config, a FigureSpec (kind, rendered and provenance, plus spec or chart), validated as the Athena UI's figures are. Without workspace_id the asset is created in the workspace of parent_folder_id when one is given, otherwise in your current workspace; you must be a member of that workspace.
223
223
  *
224
224
  * @param {AthenaIntelligence.CreateAssetRequestIn} request
225
225
  * @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -1831,6 +1831,99 @@ export class AssetsClient {
1831
1831
  }
1832
1832
  });
1833
1833
  }
1834
+ /**
1835
+ * Mint a short-lived asset token for the service that edits an asset: a spreadsheet's, a Word document's or a deck's, named in ``audience``. The token names the caller, this asset and one access level, lasts 15 minutes and is good only on that service's routes for this asset, so code (an SDK in a computer, for example) never sends the service a long-lived credential. The caller must be able to view the asset and be a member of its workspace; the token is read-write only when the caller can edit the asset and asked for edit. A computer's or session's credential mints tokens for assets of its own workspace only. Any other asset (another type, a live provider file, or one outside every workspace) is refused with 422.
1836
+ *
1837
+ * @param {AthenaIntelligence.CreateStudioTokenAssetsRequest} request
1838
+ * @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
1839
+ *
1840
+ * @throws {@link AthenaIntelligence.BadRequestError}
1841
+ * @throws {@link AthenaIntelligence.ForbiddenError}
1842
+ * @throws {@link AthenaIntelligence.NotFoundError}
1843
+ * @throws {@link AthenaIntelligence.UnprocessableEntityError}
1844
+ * @throws {@link AthenaIntelligence.ServiceUnavailableError}
1845
+ *
1846
+ * @example
1847
+ * await client.assets.createStudioToken({
1848
+ * asset_id: "asset_92492920-d118-42d3-95b4-00eccfe0754f",
1849
+ * body: {
1850
+ * access: "edit"
1851
+ * }
1852
+ * })
1853
+ */
1854
+ createStudioToken(request, requestOptions) {
1855
+ return core.HttpResponsePromise.fromPromise(this.__createStudioToken(request, requestOptions));
1856
+ }
1857
+ __createStudioToken(request, requestOptions) {
1858
+ return __awaiter(this, void 0, void 0, function* () {
1859
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
1860
+ const { asset_id: assetId, body: _body } = request;
1861
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
1862
+ const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({
1863
+ "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,
1864
+ }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
1865
+ const _response = yield ((_d = this._options.fetcher) !== null && _d !== void 0 ? _d : core.fetcher)({
1866
+ 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/assets/${core.url.encodePathParam(assetId)}/studio-token`),
1867
+ method: "POST",
1868
+ headers: _headers,
1869
+ contentType: "application/json",
1870
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
1871
+ requestType: "json",
1872
+ body: _body != null ? _body : undefined,
1873
+ 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,
1874
+ 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,
1875
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
1876
+ fetchFn: (_m = this._options) === null || _m === void 0 ? void 0 : _m.fetch,
1877
+ logging: this._options.logging,
1878
+ });
1879
+ if (_response.ok) {
1880
+ return {
1881
+ data: _response.body,
1882
+ rawResponse: _response.rawResponse,
1883
+ };
1884
+ }
1885
+ if (_response.error.reason === "status-code") {
1886
+ switch (_response.error.statusCode) {
1887
+ case 400:
1888
+ throw new AthenaIntelligence.BadRequestError(_response.error.body, _response.rawResponse);
1889
+ case 403:
1890
+ throw new AthenaIntelligence.ForbiddenError(_response.error.body, _response.rawResponse);
1891
+ case 404:
1892
+ throw new AthenaIntelligence.NotFoundError(_response.error.body, _response.rawResponse);
1893
+ case 422:
1894
+ throw new AthenaIntelligence.UnprocessableEntityError(_response.error.body, _response.rawResponse);
1895
+ case 503:
1896
+ throw new AthenaIntelligence.ServiceUnavailableError(_response.error.body, _response.rawResponse);
1897
+ default:
1898
+ throw new errors.AthenaIntelligenceError({
1899
+ statusCode: _response.error.statusCode,
1900
+ body: _response.error.body,
1901
+ rawResponse: _response.rawResponse,
1902
+ });
1903
+ }
1904
+ }
1905
+ switch (_response.error.reason) {
1906
+ case "non-json":
1907
+ throw new errors.AthenaIntelligenceError({
1908
+ statusCode: _response.error.statusCode,
1909
+ body: _response.error.rawBody,
1910
+ rawResponse: _response.rawResponse,
1911
+ });
1912
+ case "body-is-null":
1913
+ throw new errors.AthenaIntelligenceError({
1914
+ statusCode: _response.error.statusCode,
1915
+ rawResponse: _response.rawResponse,
1916
+ });
1917
+ case "timeout":
1918
+ throw new errors.AthenaIntelligenceTimeoutError("Timeout exceeded when calling POST /api/v0/assets/{asset_id}/studio-token.");
1919
+ case "unknown":
1920
+ throw new errors.AthenaIntelligenceError({
1921
+ message: _response.error.errorMessage,
1922
+ rawResponse: _response.rawResponse,
1923
+ });
1924
+ }
1925
+ });
1926
+ }
1834
1927
  /**
1835
1928
  * Update the workspace-level access on an asset. Needs edit access to the asset. Set 'view' or 'edit' to grant workspace-wide access, which also needs permission to share with the workspace. Set 'none' (or null) to remove the workspace-wide share, as DELETE does; removing a folder's share also removes it from the assets inside the folder. People and groups the asset is shared with directly keep their access.
1836
1929
  *
@@ -10,7 +10,7 @@ import type * as AthenaIntelligence from "../../../../index.mjs";
10
10
  export interface CreateAssetRequestIn {
11
11
  /** collab_agent only. Initial agent configuration. Created as a draft; publish it with POST /api/v0/assets/{asset_id}/publish. */
12
12
  agent_config?: AthenaIntelligence.PublicCollabAgentConfigIn | null;
13
- /** Type of asset to create. Supported types: 'spreadsheet' (or 'sheet'), 'document' (or 'doc'), 'folder', 'database' (or 'db'), 'computer', 'generic_doc', 'user_interface' (or 'ui'), 'skill', 'collab_agent' (or 'agent') */
13
+ /** Type of asset to create. Supported types: 'spreadsheet' (or 'sheet'), 'document' (or 'doc'), 'folder', 'database' (or 'db'), 'computer', 'generic_doc', 'user_interface' (or 'ui'), 'skill', 'collab_agent' (or 'agent'), 'figure' */
14
14
  asset_type: AthenaIntelligence.CreatableAssetType;
15
15
  /** Computer only. vCPU count. Defaults to the template's default. Must be a size the environment's computer resource policy offers; sizes other than the template default require an admin. */
16
16
  cpu?: number | null;
@@ -18,6 +18,8 @@ export interface CreateAssetRequestIn {
18
18
  disk?: number | null;
19
19
  /** Computer only. Environment variables to set on the computer. Must include every key the template or environment requires. Also accepted as 'envVars'. */
20
20
  env_vars?: Record<string, string | null> | null;
21
+ /** figure only. The figure's FigureSpec: kind, rendered and provenance, plus spec (plotly, vega-lite) or chart (chart, mixed) and the optional fields. */
22
+ figure_config?: AthenaIntelligence.PublicFigureConfigIn | null;
21
23
  /** user_interface only. HTML used as the interface's initial index.html; without it the interface starts from Athena's starter page. */
22
24
  html_content?: string | null;
23
25
  /** Computer only. Memory in GiB. Defaults to the template's default. Same policy and admin rules as cpu. */
@@ -0,0 +1,15 @@
1
+ import type * as AthenaIntelligence from "../../../../index.mjs";
2
+ /**
3
+ * @example
4
+ * {
5
+ * asset_id: "asset_92492920-d118-42d3-95b4-00eccfe0754f",
6
+ * body: {
7
+ * access: "edit"
8
+ * }
9
+ * }
10
+ */
11
+ export interface CreateStudioTokenAssetsRequest {
12
+ /** The spreadsheet, Word document or deck to mint a token for */
13
+ asset_id: string;
14
+ body: AthenaIntelligence.StudioTokenRequestIn | null;
15
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -5,6 +5,7 @@ export type { ConvertExcelToSheetRequestIn } from "./ConvertExcelToSheetRequestI
5
5
  export type { ConvertToUserInterfaceAssetsRequest } from "./ConvertToUserInterfaceAssetsRequest.mjs";
6
6
  export type { CreateAssetRequestIn } from "./CreateAssetRequestIn.mjs";
7
7
  export type { CreateProjectRequestIn } from "./CreateProjectRequestIn.mjs";
8
+ export type { CreateStudioTokenAssetsRequest } from "./CreateStudioTokenAssetsRequest.mjs";
8
9
  export type { DownloadAssetsRequest } from "./DownloadAssetsRequest.mjs";
9
10
  export type { DuplicateAssetRequestIn } from "./DuplicateAssetRequestIn.mjs";
10
11
  export type { GetAccessAssetsRequest } from "./GetAccessAssetsRequest.mjs";
@@ -9,5 +9,6 @@ export declare const CreatableAssetType: {
9
9
  readonly UserInterface: "user_interface";
10
10
  readonly Skill: "skill";
11
11
  readonly CollabAgent: "collab_agent";
12
+ readonly Figure: "figure";
12
13
  };
13
14
  export type CreatableAssetType = (typeof CreatableAssetType)[keyof typeof CreatableAssetType];
@@ -10,4 +10,5 @@ export const CreatableAssetType = {
10
10
  UserInterface: "user_interface",
11
11
  Skill: "skill",
12
12
  CollabAgent: "collab_agent",
13
+ Figure: "figure",
13
14
  };
@@ -0,0 +1,28 @@
1
+ /**
2
+ * A figure's FigureSpec for ``POST /api/v0/assets/create``.
3
+ *
4
+ * The unified shape only (``kind`` set); the create service validates it
5
+ * against the FigureSpec union, the same check ``createFigureTyped`` runs.
6
+ */
7
+ export interface PublicFigureConfigIn {
8
+ /** Alt text (image figures) */
9
+ alt_text?: string | null;
10
+ /** chart / mixed only: the chart spec */
11
+ chart?: Record<string, unknown> | null;
12
+ /** Optional tabular snapshot supporting edit-later flows */
13
+ data_snapshot?: Record<string, unknown> | null;
14
+ /** Description */
15
+ description?: string | null;
16
+ /** FigureSpec discriminator: plotly, vega-lite, chart, mixed or image */
17
+ kind: string;
18
+ /** Where the figure came from (runtime, library, versions) */
19
+ provenance: Record<string, unknown>;
20
+ /** The rendered preview every FigureSpec carries */
21
+ rendered: Record<string, unknown>;
22
+ /** Where the data came from */
23
+ source?: Record<string, unknown> | null;
24
+ /** plotly / vega-lite only: the library spec */
25
+ spec?: Record<string, unknown> | null;
26
+ /** Overrides a person applied on top of the spec */
27
+ user_overrides?: Record<string, unknown> | null;
28
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,15 @@
1
+ /**
2
+ * The access a studio token is asked for: a ceiling, not a grant.
3
+ */
4
+ export interface StudioTokenRequestIn {
5
+ /** 'edit' asks for a read-write token and gets one only when the caller can edit the asset (and it is not archived); 'view' always gets a read-only token. Omitted, the token carries the caller's own access. */
6
+ access?: StudioTokenRequestIn.Access;
7
+ }
8
+ export declare namespace StudioTokenRequestIn {
9
+ /** 'edit' asks for a read-write token and gets one only when the caller can edit the asset (and it is not archived); 'view' always gets a read-only token. Omitted, the token carries the caller's own access. */
10
+ const Access: {
11
+ readonly View: "view";
12
+ readonly Edit: "edit";
13
+ };
14
+ type Access = (typeof Access)[keyof typeof Access];
15
+ }
@@ -0,0 +1,9 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export var StudioTokenRequestIn;
3
+ (function (StudioTokenRequestIn) {
4
+ /** 'edit' asks for a read-write token and gets one only when the caller can edit the asset (and it is not archived); 'view' always gets a read-only token. Omitted, the token carries the caller's own access. */
5
+ StudioTokenRequestIn.Access = {
6
+ View: "view",
7
+ Edit: "edit",
8
+ };
9
+ })(StudioTokenRequestIn || (StudioTokenRequestIn = {}));
@@ -0,0 +1,32 @@
1
+ /**
2
+ * An asset token for the service that edits the asset.
3
+ */
4
+ export interface StudioTokenResponseOut {
5
+ /** The access the token carries: r reads only (the service refuses its writes), rw reads and writes. The service still checks the caller's live permission on every request. */
6
+ access_type: StudioTokenResponseOut.AccessType;
7
+ /** The asset the token is for. */
8
+ asset_id: string;
9
+ /** The editing service the token is for, as the token's audience identifier: one for spreadsheets, one for Word documents, one for decks. Compare it with the service you call before sending the token. */
10
+ audience: StudioTokenResponseOut.Audience;
11
+ /** For a deck, the id the deck's editing service names it by in its routes (an older deck's own deck id, else its asset id); the token is good for that id. Null for any other asset. */
12
+ deck_id?: string | null;
13
+ /** Expiry in epoch milliseconds, at most 15 minutes from now. Mint a new token before it passes. */
14
+ expires_at_ms: number;
15
+ /** The asset token (``aat_…``). Send it as ``Authorization: Bearer <token>`` to the editing service ``audience`` names, on its routes for this asset only: it names one user, this asset, one access level and that service, and every other route and service refuses it. */
16
+ token: string;
17
+ }
18
+ export declare namespace StudioTokenResponseOut {
19
+ /** The access the token carries: r reads only (the service refuses its writes), rw reads and writes. The service still checks the caller's live permission on every request. */
20
+ const AccessType: {
21
+ readonly R: "r";
22
+ readonly Rw: "rw";
23
+ };
24
+ type AccessType = (typeof AccessType)[keyof typeof AccessType];
25
+ /** The editing service the token is for, as the token's audience identifier: one for spreadsheets, one for Word documents, one for decks. Compare it with the service you call before sending the token. */
26
+ const Audience: {
27
+ readonly DocxStudio: "docx-studio";
28
+ readonly PptxStudio: "pptx-studio";
29
+ readonly XlsxStudio: "xlsx-studio";
30
+ };
31
+ type Audience = (typeof Audience)[keyof typeof Audience];
32
+ }
@@ -0,0 +1,15 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export var StudioTokenResponseOut;
3
+ (function (StudioTokenResponseOut) {
4
+ /** The access the token carries: r reads only (the service refuses its writes), rw reads and writes. The service still checks the caller's live permission on every request. */
5
+ StudioTokenResponseOut.AccessType = {
6
+ R: "r",
7
+ Rw: "rw",
8
+ };
9
+ /** The editing service the token is for, as the token's audience identifier: one for spreadsheets, one for Word documents, one for decks. Compare it with the service you call before sending the token. */
10
+ StudioTokenResponseOut.Audience = {
11
+ DocxStudio: "docx-studio",
12
+ PptxStudio: "pptx-studio",
13
+ XlsxStudio: "xlsx-studio",
14
+ };
15
+ })(StudioTokenResponseOut || (StudioTokenResponseOut = {}));
@@ -113,6 +113,7 @@ export * from "./PresenceTokenResponseOut.mjs";
113
113
  export * from "./PromptMessage.mjs";
114
114
  export * from "./PublicAssetOut.mjs";
115
115
  export * from "./PublicCollabAgentConfigIn.mjs";
116
+ export * from "./PublicFigureConfigIn.mjs";
116
117
  export * from "./PublicSessionComputerIn.mjs";
117
118
  export * from "./PublicSessionSetupStepIn.mjs";
118
119
  export * from "./PublicSkillConfigIn.mjs";
@@ -144,6 +145,8 @@ export * from "./SshAccessTokenOut.mjs";
144
145
  export * from "./SshKeyListResponseOut.mjs";
145
146
  export * from "./SshKeyOut.mjs";
146
147
  export * from "./StructuredDataExtractorResponse.mjs";
148
+ export * from "./StudioTokenRequestIn.mjs";
149
+ export * from "./StudioTokenResponseOut.mjs";
147
150
  export * from "./TableRowData.mjs";
148
151
  export * from "./TextContent.mjs";
149
152
  export * from "./TextFormatModel.mjs";
@@ -113,6 +113,7 @@ export * from "./PresenceTokenResponseOut.mjs";
113
113
  export * from "./PromptMessage.mjs";
114
114
  export * from "./PublicAssetOut.mjs";
115
115
  export * from "./PublicCollabAgentConfigIn.mjs";
116
+ export * from "./PublicFigureConfigIn.mjs";
116
117
  export * from "./PublicSessionComputerIn.mjs";
117
118
  export * from "./PublicSessionSetupStepIn.mjs";
118
119
  export * from "./PublicSkillConfigIn.mjs";
@@ -144,6 +145,8 @@ export * from "./SshAccessTokenOut.mjs";
144
145
  export * from "./SshKeyListResponseOut.mjs";
145
146
  export * from "./SshKeyOut.mjs";
146
147
  export * from "./StructuredDataExtractorResponse.mjs";
148
+ export * from "./StudioTokenRequestIn.mjs";
149
+ export * from "./StudioTokenResponseOut.mjs";
147
150
  export * from "./TableRowData.mjs";
148
151
  export * from "./TextContent.mjs";
149
152
  export * from "./TextFormatModel.mjs";
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "4.3.2266";
1
+ export declare const SDK_VERSION = "4.3.2268";
@@ -1 +1 @@
1
- export const SDK_VERSION = "4.3.2266";
1
+ export const SDK_VERSION = "4.3.2268";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@athenaintel/sdk",
3
- "version": "4.3.2266",
3
+ "version": "4.3.2268",
4
4
  "private": false,
5
5
  "repository": "github:Athena-Intel/athena-typescript",
6
6
  "type": "commonjs",
package/reference.md CHANGED
@@ -648,7 +648,7 @@ await client.assets.convertExcelToSheet({
648
648
  <dl>
649
649
  <dd>
650
650
 
651
- Create a new asset such as a spreadsheet, document, folder, database, computer, user interface, skill, collab agent, or generic doc (admin-only) in your workspace with your current permissions. Computer assets return 202 after durable submission, which commits the asset and initialization delivery intent together. Runtime provisioning continues asynchronously. Inspect the returned asset ID for progress instead of repeating creation. Computers accept the same configuration as the Athena UI's creation dialog: template, provider, cpu, memory (GiB), disk (GiB) and env_vars. Sizes must be offered by the environment's computer resource policy, and only admins may pick a size other than the template default (403 otherwise). In capability enforce mode, computer creation requires computer.create and returns 403 when denied. Databases accept suspend_timeout_seconds, the auto-suspend window from the database's Settings in Athena: 0 keeps the database running (it never suspends, and keeps using capacity), otherwise 60 to 86400 seconds. A database is provisioned in the background: poll GET /api/v0/databases/{asset_id}/compute-status until it reports running or suspended. Without workspace_id the asset is created in the workspace of parent_folder_id when one is given, otherwise in your current workspace; you must be a member of that workspace.
651
+ Create a new asset such as a spreadsheet, document, folder, database, computer, user interface, skill, collab agent, figure, or generic doc (admin-only) in your workspace with your current permissions. Computer assets return 202 after durable submission, which commits the asset and initialization delivery intent together. Runtime provisioning continues asynchronously. Inspect the returned asset ID for progress instead of repeating creation. Computers accept the same configuration as the Athena UI's creation dialog: template, provider, cpu, memory (GiB), disk (GiB) and env_vars. Sizes must be offered by the environment's computer resource policy, and only admins may pick a size other than the template default (403 otherwise). In capability enforce mode, computer creation requires computer.create and returns 403 when denied. Databases accept suspend_timeout_seconds, the auto-suspend window from the database's Settings in Athena: 0 keeps the database running (it never suspends, and keeps using capacity), otherwise 60 to 86400 seconds. A database is provisioned in the background: poll GET /api/v0/databases/{asset_id}/compute-status until it reports running or suspended. Figures take figure_config, a FigureSpec (kind, rendered and provenance, plus spec or chart), validated as the Athena UI's figures are. Without workspace_id the asset is created in the workspace of parent_folder_id when one is given, otherwise in your current workspace; you must be a member of that workspace.
652
652
  </dd>
653
653
  </dl>
654
654
  </dd>
@@ -1842,6 +1842,74 @@ await client.assets.updateSkillConfig({
1842
1842
  </dl>
1843
1843
 
1844
1844
 
1845
+ </dd>
1846
+ </dl>
1847
+ </details>
1848
+
1849
+ <details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">createStudioToken</a>({ ...params }) -> AthenaIntelligence.StudioTokenResponseOut</code></summary>
1850
+ <dl>
1851
+ <dd>
1852
+
1853
+ #### 📝 Description
1854
+
1855
+ <dl>
1856
+ <dd>
1857
+
1858
+ <dl>
1859
+ <dd>
1860
+
1861
+ Mint a short-lived asset token for the service that edits an asset: a spreadsheet's, a Word document's or a deck's, named in ``audience``. The token names the caller, this asset and one access level, lasts 15 minutes and is good only on that service's routes for this asset, so code (an SDK in a computer, for example) never sends the service a long-lived credential. The caller must be able to view the asset and be a member of its workspace; the token is read-write only when the caller can edit the asset and asked for edit. A computer's or session's credential mints tokens for assets of its own workspace only. Any other asset (another type, a live provider file, or one outside every workspace) is refused with 422.
1862
+ </dd>
1863
+ </dl>
1864
+ </dd>
1865
+ </dl>
1866
+
1867
+ #### 🔌 Usage
1868
+
1869
+ <dl>
1870
+ <dd>
1871
+
1872
+ <dl>
1873
+ <dd>
1874
+
1875
+ ```typescript
1876
+ await client.assets.createStudioToken({
1877
+ asset_id: "asset_92492920-d118-42d3-95b4-00eccfe0754f",
1878
+ body: {
1879
+ access: "edit"
1880
+ }
1881
+ });
1882
+
1883
+ ```
1884
+ </dd>
1885
+ </dl>
1886
+ </dd>
1887
+ </dl>
1888
+
1889
+ #### ⚙️ Parameters
1890
+
1891
+ <dl>
1892
+ <dd>
1893
+
1894
+ <dl>
1895
+ <dd>
1896
+
1897
+ **request:** `AthenaIntelligence.CreateStudioTokenAssetsRequest`
1898
+
1899
+ </dd>
1900
+ </dl>
1901
+
1902
+ <dl>
1903
+ <dd>
1904
+
1905
+ **requestOptions:** `AssetsClient.RequestOptions`
1906
+
1907
+ </dd>
1908
+ </dl>
1909
+ </dd>
1910
+ </dl>
1911
+
1912
+
1845
1913
  </dd>
1846
1914
  </dl>
1847
1915
  </details>