@athenaintel/sdk 4.3.2269 → 4.3.2271
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/README.md +1 -1
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/errors/ContentTooLargeError.d.ts +1 -2
- package/dist/cjs/api/errors/UnsupportedMediaTypeError.d.ts +1 -2
- package/dist/cjs/api/resources/assets/client/Client.d.ts +43 -2
- package/dist/cjs/api/resources/assets/client/Client.js +199 -2
- package/dist/cjs/api/resources/assets/client/requests/BodyCreateAssetFromFilePublicApiV0AssetsCreateFromFilePost.d.ts +19 -0
- package/dist/cjs/api/resources/assets/client/requests/CreateAssetRequestIn.d.ts +1 -1
- package/dist/cjs/api/resources/assets/client/requests/GetWorkbookAssetsRequest.d.ts +10 -0
- package/dist/cjs/api/resources/assets/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/types/CreatableAssetType.d.ts +2 -0
- package/dist/cjs/api/types/CreatableAssetType.js +2 -0
- package/dist/cjs/api/types/FileBackedSheetResponseOut.d.ts +9 -0
- package/dist/cjs/api/types/FileBackedSheetResponseOut.js +3 -0
- package/dist/cjs/api/types/FileBackedWorkbookResponseOut.d.ts +10 -0
- package/dist/cjs/api/types/FileBackedWorkbookResponseOut.js +3 -0
- package/dist/cjs/api/types/StudioTokenRequestIn.d.ts +6 -0
- package/dist/cjs/api/types/StudioTokenRequestIn.js +3 -0
- package/dist/cjs/api/types/StudioTokenResponseOut.d.ts +3 -2
- package/dist/cjs/api/types/StudioTokenResponseOut.js +2 -1
- package/dist/cjs/api/types/index.d.ts +2 -2
- package/dist/cjs/api/types/index.js +2 -2
- 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/errors/ContentTooLargeError.d.mts +1 -2
- package/dist/esm/api/errors/UnsupportedMediaTypeError.d.mts +1 -2
- package/dist/esm/api/resources/assets/client/Client.d.mts +43 -2
- package/dist/esm/api/resources/assets/client/Client.mjs +199 -2
- package/dist/esm/api/resources/assets/client/requests/BodyCreateAssetFromFilePublicApiV0AssetsCreateFromFilePost.d.mts +19 -0
- package/dist/esm/api/resources/assets/client/requests/CreateAssetRequestIn.d.mts +1 -1
- package/dist/esm/api/resources/assets/client/requests/GetWorkbookAssetsRequest.d.mts +10 -0
- package/dist/esm/api/resources/assets/client/requests/index.d.mts +2 -0
- package/dist/esm/api/types/CreatableAssetType.d.mts +2 -0
- package/dist/esm/api/types/CreatableAssetType.mjs +2 -0
- package/dist/esm/api/types/FileBackedSheetResponseOut.d.mts +9 -0
- package/dist/esm/api/types/FileBackedSheetResponseOut.mjs +2 -0
- package/dist/esm/api/types/FileBackedWorkbookResponseOut.d.mts +10 -0
- package/dist/esm/api/types/FileBackedWorkbookResponseOut.mjs +2 -0
- package/dist/esm/api/types/StudioTokenRequestIn.d.mts +6 -0
- package/dist/esm/api/types/StudioTokenRequestIn.mjs +3 -0
- package/dist/esm/api/types/StudioTokenResponseOut.d.mts +3 -2
- package/dist/esm/api/types/StudioTokenResponseOut.mjs +2 -1
- package/dist/esm/api/types/index.d.mts +2 -2
- package/dist/esm/api/types/index.mjs +2 -2
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +132 -2
- package/dist/cjs/api/types/DataFrameUnknownFormatError.d.ts +0 -5
- package/dist/cjs/api/types/FileTooLargeError.d.ts +0 -3
- package/dist/esm/api/types/DataFrameUnknownFormatError.d.mts +0 -5
- package/dist/esm/api/types/FileTooLargeError.d.mts +0 -3
- /package/dist/cjs/api/{types/DataFrameUnknownFormatError.js → resources/assets/client/requests/BodyCreateAssetFromFilePublicApiV0AssetsCreateFromFilePost.js} +0 -0
- /package/dist/cjs/api/{types/FileTooLargeError.js → resources/assets/client/requests/GetWorkbookAssetsRequest.js} +0 -0
- /package/dist/esm/api/{types/DataFrameUnknownFormatError.mjs → resources/assets/client/requests/BodyCreateAssetFromFilePublicApiV0AssetsCreateFromFilePost.mjs} +0 -0
- /package/dist/esm/api/{types/FileTooLargeError.mjs → resources/assets/client/requests/GetWorkbookAssetsRequest.mjs} +0 -0
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, 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.
|
|
651
|
+
Create a new asset such as a spreadsheet, document, folder, database, computer, user interface, skill, collab agent, figure, Word document, presentation, 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. A word_document is a Word document holding Athena's default template, and a presentation is a blank widescreen PPTX Studio deck (the workspace's default template is not applied): Athena creates each with its own studio credential, as your write, and answers once the studio has seeded it (502, keeping nothing, when PPTX Studio could not seed a deck). Edit them through DOCX Studio or PPTX Studio with a token from POST /api/v0/assets/{asset_id}/studio-token. From an agent run (a verified X-Athena-Session-Credential), their first write also records the run, and a presentation takes the create_presentation_pptx_studio tool policy. 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>
|
|
@@ -699,6 +699,71 @@ await client.assets.create({
|
|
|
699
699
|
</dl>
|
|
700
700
|
|
|
701
701
|
|
|
702
|
+
</dd>
|
|
703
|
+
</dl>
|
|
704
|
+
</details>
|
|
705
|
+
|
|
706
|
+
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">createFromFile</a>({ ...params }) -> AthenaIntelligence.CreateAssetResponseOut</code></summary>
|
|
707
|
+
<dl>
|
|
708
|
+
<dd>
|
|
709
|
+
|
|
710
|
+
#### 📝 Description
|
|
711
|
+
|
|
712
|
+
<dl>
|
|
713
|
+
<dd>
|
|
714
|
+
|
|
715
|
+
<dl>
|
|
716
|
+
<dd>
|
|
717
|
+
|
|
718
|
+
Create a Word document from a .docx file, or a presentation from a .pptx or .potx file, holding that file's content: the asset Athena makes when you create one from a file in the app. Athena imports the file through DOCX Studio or PPTX Studio with its own studio credential, as your write, and answers once the asset is ready (a large deck can take a few minutes). Nothing is left behind when the import fails. The file's name decides the type; the title defaults to the name without its extension. Gates are those of POST /api/v0/assets/create: membership in the workspace (workspace_id, else parent_folder_id's, else your current one) and EDIT on parent_folder_id. With source_asset_id (an asset you can read, for example the document the file was exported from) and no parent_folder_id, the new asset goes into the source's folder when you may create there, otherwise at your root. Unlike POST /api/v0/tools/file/save, which stores the file itself and turns an Office upload into its editable type in the background, this makes the editable asset in the request and keeps no file asset. A Word file may be up to 18.75 MiB, a PowerPoint file up to 100 MiB. From an agent run (a verified X-Athena-Session-Credential), a Word document's first write also records the run, and a presentation takes the create_presentation_pptx_studio tool policy.
|
|
719
|
+
</dd>
|
|
720
|
+
</dl>
|
|
721
|
+
</dd>
|
|
722
|
+
</dl>
|
|
723
|
+
|
|
724
|
+
#### 🔌 Usage
|
|
725
|
+
|
|
726
|
+
<dl>
|
|
727
|
+
<dd>
|
|
728
|
+
|
|
729
|
+
<dl>
|
|
730
|
+
<dd>
|
|
731
|
+
|
|
732
|
+
```typescript
|
|
733
|
+
await client.assets.createFromFile({
|
|
734
|
+
file: fs.createReadStream("/path/to/your/file")
|
|
735
|
+
});
|
|
736
|
+
|
|
737
|
+
```
|
|
738
|
+
</dd>
|
|
739
|
+
</dl>
|
|
740
|
+
</dd>
|
|
741
|
+
</dl>
|
|
742
|
+
|
|
743
|
+
#### ⚙️ Parameters
|
|
744
|
+
|
|
745
|
+
<dl>
|
|
746
|
+
<dd>
|
|
747
|
+
|
|
748
|
+
<dl>
|
|
749
|
+
<dd>
|
|
750
|
+
|
|
751
|
+
**request:** `AthenaIntelligence.BodyCreateAssetFromFilePublicApiV0AssetsCreateFromFilePost`
|
|
752
|
+
|
|
753
|
+
</dd>
|
|
754
|
+
</dl>
|
|
755
|
+
|
|
756
|
+
<dl>
|
|
757
|
+
<dd>
|
|
758
|
+
|
|
759
|
+
**requestOptions:** `AssetsClient.RequestOptions`
|
|
760
|
+
|
|
761
|
+
</dd>
|
|
762
|
+
</dl>
|
|
763
|
+
</dd>
|
|
764
|
+
</dl>
|
|
765
|
+
|
|
766
|
+
|
|
702
767
|
</dd>
|
|
703
768
|
</dl>
|
|
704
769
|
</details>
|
|
@@ -1858,7 +1923,7 @@ await client.assets.updateSkillConfig({
|
|
|
1858
1923
|
<dl>
|
|
1859
1924
|
<dd>
|
|
1860
1925
|
|
|
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.
|
|
1926
|
+
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. With audience 'pptx-studio-source' it mints the read-only token the deck editing service reads a spreadsheet, figure or semantic model with for a linked table, OLE object or chart; a recording's token is always that one. Any other asset (another type, a live provider file, or one outside every workspace) is refused with 422.
|
|
1862
1927
|
</dd>
|
|
1863
1928
|
</dl>
|
|
1864
1929
|
</dd>
|
|
@@ -1910,6 +1975,71 @@ await client.assets.createStudioToken({
|
|
|
1910
1975
|
</dl>
|
|
1911
1976
|
|
|
1912
1977
|
|
|
1978
|
+
</dd>
|
|
1979
|
+
</dl>
|
|
1980
|
+
</details>
|
|
1981
|
+
|
|
1982
|
+
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">getWorkbook</a>({ ...params }) -> AthenaIntelligence.FileBackedWorkbookResponseOut</code></summary>
|
|
1983
|
+
<dl>
|
|
1984
|
+
<dd>
|
|
1985
|
+
|
|
1986
|
+
#### 📝 Description
|
|
1987
|
+
|
|
1988
|
+
<dl>
|
|
1989
|
+
<dd>
|
|
1990
|
+
|
|
1991
|
+
<dl>
|
|
1992
|
+
<dd>
|
|
1993
|
+
|
|
1994
|
+
Read a spreadsheet file's contents as rows, every tab: an uploaded .xlsx, .xlsm, .xls, .csv, .tsv or Parquet file, or a linked file in SharePoint, Google Drive, OneDrive or iManage. Excel and Parquet cells keep their types; a CSV or TSV field that reads as a number becomes one. A sheet is read whole up to a safety ceiling, and a file over 40 MB is refused (413). A native Athena spreadsheet answers 409: its contents are the collaborative sheet, which the spreadsheet SDK opens directly. Nothing is written.
|
|
1995
|
+
</dd>
|
|
1996
|
+
</dl>
|
|
1997
|
+
</dd>
|
|
1998
|
+
</dl>
|
|
1999
|
+
|
|
2000
|
+
#### 🔌 Usage
|
|
2001
|
+
|
|
2002
|
+
<dl>
|
|
2003
|
+
<dd>
|
|
2004
|
+
|
|
2005
|
+
<dl>
|
|
2006
|
+
<dd>
|
|
2007
|
+
|
|
2008
|
+
```typescript
|
|
2009
|
+
await client.assets.getWorkbook({
|
|
2010
|
+
asset_id: "asset_92492920-d118-42d3-95b4-00eccfe0754f"
|
|
2011
|
+
});
|
|
2012
|
+
|
|
2013
|
+
```
|
|
2014
|
+
</dd>
|
|
2015
|
+
</dl>
|
|
2016
|
+
</dd>
|
|
2017
|
+
</dl>
|
|
2018
|
+
|
|
2019
|
+
#### ⚙️ Parameters
|
|
2020
|
+
|
|
2021
|
+
<dl>
|
|
2022
|
+
<dd>
|
|
2023
|
+
|
|
2024
|
+
<dl>
|
|
2025
|
+
<dd>
|
|
2026
|
+
|
|
2027
|
+
**request:** `AthenaIntelligence.GetWorkbookAssetsRequest`
|
|
2028
|
+
|
|
2029
|
+
</dd>
|
|
2030
|
+
</dl>
|
|
2031
|
+
|
|
2032
|
+
<dl>
|
|
2033
|
+
<dd>
|
|
2034
|
+
|
|
2035
|
+
**requestOptions:** `AssetsClient.RequestOptions`
|
|
2036
|
+
|
|
2037
|
+
</dd>
|
|
2038
|
+
</dl>
|
|
2039
|
+
</dd>
|
|
2040
|
+
</dl>
|
|
2041
|
+
|
|
2042
|
+
|
|
1913
2043
|
</dd>
|
|
1914
2044
|
</dl>
|
|
1915
2045
|
</details>
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|