@athenaintel/sdk 4.3.2296 → 4.3.2297
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/assets/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/assets/client/Client.js +5 -2
- package/dist/cjs/api/resources/assets/client/requests/DownloadAssetsRequest.d.ts +3 -1
- 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/assets/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/assets/client/Client.mjs +5 -2
- package/dist/esm/api/resources/assets/client/requests/DownloadAssetsRequest.d.mts +3 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +1 -1
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.2297",
|
|
47
|
+
"User-Agent": "@athenaintel/sdk/4.3.2297",
|
|
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,
|
|
@@ -349,7 +349,7 @@ export declare class AssetsClient {
|
|
|
349
349
|
convertToUserInterface(request: AthenaIntelligence.ConvertToUserInterfaceAssetsRequest, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.ConvertToUserInterfaceResponseOut>;
|
|
350
350
|
private __convertToUserInterface;
|
|
351
351
|
/**
|
|
352
|
-
* Download an asset's file exactly as Athena stores or serves it — no type coercion, no pagination. Native collaborative assets are converted from live content to their canonical Office format: Athena documents download as .docx, spreadsheets as .xlsx (round-trip faithful — string identifiers, leading zeros, and number formats are preserved), PPTX Studio presentations and Word documents export their live studio content as .pptx/.docx. Uploaded files stream their original bytes. The response sets Content-Disposition with a filename derived from the asset title and media type. With `live_sync=true`, a spreadsheet's .xlsx, a PPTX Studio presentation's .pptx or a Word document's .docx also carries the Athena for Office add-in's link record, so opening it in Excel, PowerPoint or Word with the add-in installed starts syncing it with the asset; other asset types ignore the flag.
|
|
352
|
+
* Download an asset's file exactly as Athena stores or serves it — no type coercion, no pagination. Native collaborative assets are converted from live content to their canonical Office format: Athena documents download as .docx, spreadsheets as .xlsx (round-trip faithful — string identifiers, leading zeros, and number formats are preserved), PPTX Studio presentations and Word documents export their live studio content as .pptx/.docx. Uploaded files stream their original bytes. The response sets Content-Disposition with a filename derived from the asset title and media type. With `live_sync=true`, a spreadsheet's .xlsx, a PPTX Studio presentation's .pptx or a Word document's .docx also carries the Athena for Office add-in's link record, so opening it in Excel, PowerPoint or Word with the add-in installed starts syncing it with the asset; other asset types ignore the flag. A Word document's live-sync copy requires EDIT. With `read_only=true`, a Word document downloads as a plain .docx that Word offers to open read-only (Read-only recommended) and that carries no live-sync link; it requires VIEW, like every download, and cannot be combined with `live_sync`.
|
|
353
353
|
* @throws {@link AthenaIntelligence.BadRequestError}
|
|
354
354
|
* @throws {@link AthenaIntelligence.ForbiddenError}
|
|
355
355
|
* @throws {@link AthenaIntelligence.NotFoundError}
|
|
@@ -1594,7 +1594,7 @@ class AssetsClient {
|
|
|
1594
1594
|
});
|
|
1595
1595
|
}
|
|
1596
1596
|
/**
|
|
1597
|
-
* Download an asset's file exactly as Athena stores or serves it — no type coercion, no pagination. Native collaborative assets are converted from live content to their canonical Office format: Athena documents download as .docx, spreadsheets as .xlsx (round-trip faithful — string identifiers, leading zeros, and number formats are preserved), PPTX Studio presentations and Word documents export their live studio content as .pptx/.docx. Uploaded files stream their original bytes. The response sets Content-Disposition with a filename derived from the asset title and media type. With `live_sync=true`, a spreadsheet's .xlsx, a PPTX Studio presentation's .pptx or a Word document's .docx also carries the Athena for Office add-in's link record, so opening it in Excel, PowerPoint or Word with the add-in installed starts syncing it with the asset; other asset types ignore the flag.
|
|
1597
|
+
* Download an asset's file exactly as Athena stores or serves it — no type coercion, no pagination. Native collaborative assets are converted from live content to their canonical Office format: Athena documents download as .docx, spreadsheets as .xlsx (round-trip faithful — string identifiers, leading zeros, and number formats are preserved), PPTX Studio presentations and Word documents export their live studio content as .pptx/.docx. Uploaded files stream their original bytes. The response sets Content-Disposition with a filename derived from the asset title and media type. With `live_sync=true`, a spreadsheet's .xlsx, a PPTX Studio presentation's .pptx or a Word document's .docx also carries the Athena for Office add-in's link record, so opening it in Excel, PowerPoint or Word with the add-in installed starts syncing it with the asset; other asset types ignore the flag. A Word document's live-sync copy requires EDIT. With `read_only=true`, a Word document downloads as a plain .docx that Word offers to open read-only (Read-only recommended) and that carries no live-sync link; it requires VIEW, like every download, and cannot be combined with `live_sync`.
|
|
1598
1598
|
* @throws {@link AthenaIntelligence.BadRequestError}
|
|
1599
1599
|
* @throws {@link AthenaIntelligence.ForbiddenError}
|
|
1600
1600
|
* @throws {@link AthenaIntelligence.NotFoundError}
|
|
@@ -1606,11 +1606,14 @@ class AssetsClient {
|
|
|
1606
1606
|
__download(request, requestOptions) {
|
|
1607
1607
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1608
1608
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
|
|
1609
|
-
const { asset_id: assetId, live_sync: liveSync, addin_id: addinId } = request;
|
|
1609
|
+
const { asset_id: assetId, live_sync: liveSync, read_only: readOnly, addin_id: addinId } = request;
|
|
1610
1610
|
const _queryParams = {};
|
|
1611
1611
|
if (liveSync != null) {
|
|
1612
1612
|
_queryParams.live_sync = liveSync.toString();
|
|
1613
1613
|
}
|
|
1614
|
+
if (readOnly != null) {
|
|
1615
|
+
_queryParams.read_only = readOnly.toString();
|
|
1616
|
+
}
|
|
1614
1617
|
if (addinId !== undefined) {
|
|
1615
1618
|
_queryParams.addin_id = addinId;
|
|
1616
1619
|
}
|
|
@@ -7,8 +7,10 @@
|
|
|
7
7
|
export interface DownloadAssetsRequest {
|
|
8
8
|
/** Unique identifier of the asset to download */
|
|
9
9
|
asset_id: string;
|
|
10
|
-
/** Office live sync: when true and the asset is an Athena spreadsheet, a PPTX Studio presentation or a Word document, the downloaded .xlsx / .pptx / .docx carries the Athena for Office add-in's link record and opens already syncing with this asset. Ignored for every other asset type. */
|
|
10
|
+
/** Office live sync: when true and the asset is an Athena spreadsheet, a PPTX Studio presentation or a Word document, the downloaded .xlsx / .pptx / .docx carries the Athena for Office add-in's link record and opens already syncing with this asset; a Word document's requires EDIT access. Ignored for every other asset type. */
|
|
11
11
|
live_sync?: boolean;
|
|
12
|
+
/** Read-only copy: when true and the asset is a Word document, the downloaded .docx carries no live-sync link and Word's Read-only recommended setting, so Word offers to open it read-only. Cannot be combined with `live_sync`. Ignored for every other asset type. */
|
|
13
|
+
read_only?: boolean;
|
|
12
14
|
/** GUID of the installed add-in manifest the live-sync record should reference (defaults to this deployment's Athena add-in). Only read together with `live_sync`; use it to target a preview-channel sideload. */
|
|
13
15
|
addin_id?: string | null;
|
|
14
16
|
}
|
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.2297";
|
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.2297",
|
|
10
|
+
"User-Agent": "@athenaintel/sdk/4.3.2297",
|
|
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,
|
|
@@ -349,7 +349,7 @@ export declare class AssetsClient {
|
|
|
349
349
|
convertToUserInterface(request: AthenaIntelligence.ConvertToUserInterfaceAssetsRequest, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.ConvertToUserInterfaceResponseOut>;
|
|
350
350
|
private __convertToUserInterface;
|
|
351
351
|
/**
|
|
352
|
-
* Download an asset's file exactly as Athena stores or serves it — no type coercion, no pagination. Native collaborative assets are converted from live content to their canonical Office format: Athena documents download as .docx, spreadsheets as .xlsx (round-trip faithful — string identifiers, leading zeros, and number formats are preserved), PPTX Studio presentations and Word documents export their live studio content as .pptx/.docx. Uploaded files stream their original bytes. The response sets Content-Disposition with a filename derived from the asset title and media type. With `live_sync=true`, a spreadsheet's .xlsx, a PPTX Studio presentation's .pptx or a Word document's .docx also carries the Athena for Office add-in's link record, so opening it in Excel, PowerPoint or Word with the add-in installed starts syncing it with the asset; other asset types ignore the flag.
|
|
352
|
+
* Download an asset's file exactly as Athena stores or serves it — no type coercion, no pagination. Native collaborative assets are converted from live content to their canonical Office format: Athena documents download as .docx, spreadsheets as .xlsx (round-trip faithful — string identifiers, leading zeros, and number formats are preserved), PPTX Studio presentations and Word documents export their live studio content as .pptx/.docx. Uploaded files stream their original bytes. The response sets Content-Disposition with a filename derived from the asset title and media type. With `live_sync=true`, a spreadsheet's .xlsx, a PPTX Studio presentation's .pptx or a Word document's .docx also carries the Athena for Office add-in's link record, so opening it in Excel, PowerPoint or Word with the add-in installed starts syncing it with the asset; other asset types ignore the flag. A Word document's live-sync copy requires EDIT. With `read_only=true`, a Word document downloads as a plain .docx that Word offers to open read-only (Read-only recommended) and that carries no live-sync link; it requires VIEW, like every download, and cannot be combined with `live_sync`.
|
|
353
353
|
* @throws {@link AthenaIntelligence.BadRequestError}
|
|
354
354
|
* @throws {@link AthenaIntelligence.ForbiddenError}
|
|
355
355
|
* @throws {@link AthenaIntelligence.NotFoundError}
|
|
@@ -1558,7 +1558,7 @@ export class AssetsClient {
|
|
|
1558
1558
|
});
|
|
1559
1559
|
}
|
|
1560
1560
|
/**
|
|
1561
|
-
* Download an asset's file exactly as Athena stores or serves it — no type coercion, no pagination. Native collaborative assets are converted from live content to their canonical Office format: Athena documents download as .docx, spreadsheets as .xlsx (round-trip faithful — string identifiers, leading zeros, and number formats are preserved), PPTX Studio presentations and Word documents export their live studio content as .pptx/.docx. Uploaded files stream their original bytes. The response sets Content-Disposition with a filename derived from the asset title and media type. With `live_sync=true`, a spreadsheet's .xlsx, a PPTX Studio presentation's .pptx or a Word document's .docx also carries the Athena for Office add-in's link record, so opening it in Excel, PowerPoint or Word with the add-in installed starts syncing it with the asset; other asset types ignore the flag.
|
|
1561
|
+
* Download an asset's file exactly as Athena stores or serves it — no type coercion, no pagination. Native collaborative assets are converted from live content to their canonical Office format: Athena documents download as .docx, spreadsheets as .xlsx (round-trip faithful — string identifiers, leading zeros, and number formats are preserved), PPTX Studio presentations and Word documents export their live studio content as .pptx/.docx. Uploaded files stream their original bytes. The response sets Content-Disposition with a filename derived from the asset title and media type. With `live_sync=true`, a spreadsheet's .xlsx, a PPTX Studio presentation's .pptx or a Word document's .docx also carries the Athena for Office add-in's link record, so opening it in Excel, PowerPoint or Word with the add-in installed starts syncing it with the asset; other asset types ignore the flag. A Word document's live-sync copy requires EDIT. With `read_only=true`, a Word document downloads as a plain .docx that Word offers to open read-only (Read-only recommended) and that carries no live-sync link; it requires VIEW, like every download, and cannot be combined with `live_sync`.
|
|
1562
1562
|
* @throws {@link AthenaIntelligence.BadRequestError}
|
|
1563
1563
|
* @throws {@link AthenaIntelligence.ForbiddenError}
|
|
1564
1564
|
* @throws {@link AthenaIntelligence.NotFoundError}
|
|
@@ -1570,11 +1570,14 @@ export class AssetsClient {
|
|
|
1570
1570
|
__download(request, requestOptions) {
|
|
1571
1571
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1572
1572
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
|
|
1573
|
-
const { asset_id: assetId, live_sync: liveSync, addin_id: addinId } = request;
|
|
1573
|
+
const { asset_id: assetId, live_sync: liveSync, read_only: readOnly, addin_id: addinId } = request;
|
|
1574
1574
|
const _queryParams = {};
|
|
1575
1575
|
if (liveSync != null) {
|
|
1576
1576
|
_queryParams.live_sync = liveSync.toString();
|
|
1577
1577
|
}
|
|
1578
|
+
if (readOnly != null) {
|
|
1579
|
+
_queryParams.read_only = readOnly.toString();
|
|
1580
|
+
}
|
|
1578
1581
|
if (addinId !== undefined) {
|
|
1579
1582
|
_queryParams.addin_id = addinId;
|
|
1580
1583
|
}
|
|
@@ -7,8 +7,10 @@
|
|
|
7
7
|
export interface DownloadAssetsRequest {
|
|
8
8
|
/** Unique identifier of the asset to download */
|
|
9
9
|
asset_id: string;
|
|
10
|
-
/** Office live sync: when true and the asset is an Athena spreadsheet, a PPTX Studio presentation or a Word document, the downloaded .xlsx / .pptx / .docx carries the Athena for Office add-in's link record and opens already syncing with this asset. Ignored for every other asset type. */
|
|
10
|
+
/** Office live sync: when true and the asset is an Athena spreadsheet, a PPTX Studio presentation or a Word document, the downloaded .xlsx / .pptx / .docx carries the Athena for Office add-in's link record and opens already syncing with this asset; a Word document's requires EDIT access. Ignored for every other asset type. */
|
|
11
11
|
live_sync?: boolean;
|
|
12
|
+
/** Read-only copy: when true and the asset is a Word document, the downloaded .docx carries no live-sync link and Word's Read-only recommended setting, so Word offers to open it read-only. Cannot be combined with `live_sync`. Ignored for every other asset type. */
|
|
13
|
+
read_only?: boolean;
|
|
12
14
|
/** GUID of the installed add-in manifest the live-sync record should reference (defaults to this deployment's Athena add-in). Only read together with `live_sync`; use it to target a preview-channel sideload. */
|
|
13
15
|
addin_id?: string | null;
|
|
14
16
|
}
|
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.2297";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "4.3.
|
|
1
|
+
export const SDK_VERSION = "4.3.2297";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -1640,7 +1640,7 @@ await client.assets.convertToUserInterface({
|
|
|
1640
1640
|
<dl>
|
|
1641
1641
|
<dd>
|
|
1642
1642
|
|
|
1643
|
-
Download an asset's file exactly as Athena stores or serves it — no type coercion, no pagination. Native collaborative assets are converted from live content to their canonical Office format: Athena documents download as .docx, spreadsheets as .xlsx (round-trip faithful — string identifiers, leading zeros, and number formats are preserved), PPTX Studio presentations and Word documents export their live studio content as .pptx/.docx. Uploaded files stream their original bytes. The response sets Content-Disposition with a filename derived from the asset title and media type. With `live_sync=true`, a spreadsheet's .xlsx, a PPTX Studio presentation's .pptx or a Word document's .docx also carries the Athena for Office add-in's link record, so opening it in Excel, PowerPoint or Word with the add-in installed starts syncing it with the asset; other asset types ignore the flag.
|
|
1643
|
+
Download an asset's file exactly as Athena stores or serves it — no type coercion, no pagination. Native collaborative assets are converted from live content to their canonical Office format: Athena documents download as .docx, spreadsheets as .xlsx (round-trip faithful — string identifiers, leading zeros, and number formats are preserved), PPTX Studio presentations and Word documents export their live studio content as .pptx/.docx. Uploaded files stream their original bytes. The response sets Content-Disposition with a filename derived from the asset title and media type. With `live_sync=true`, a spreadsheet's .xlsx, a PPTX Studio presentation's .pptx or a Word document's .docx also carries the Athena for Office add-in's link record, so opening it in Excel, PowerPoint or Word with the add-in installed starts syncing it with the asset; other asset types ignore the flag. A Word document's live-sync copy requires EDIT. With `read_only=true`, a Word document downloads as a plain .docx that Word offers to open read-only (Read-only recommended) and that carries no live-sync link; it requires VIEW, like every download, and cannot be combined with `live_sync`.
|
|
1644
1644
|
</dd>
|
|
1645
1645
|
</dl>
|
|
1646
1646
|
</dd>
|