@athenaintel/sdk 4.3.2240 → 4.3.2241

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.
@@ -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.2240",
47
- "User-Agent": "@athenaintel/sdk/4.3.2240",
46
+ "X-Fern-SDK-Version": "4.3.2241",
47
+ "User-Agent": "@athenaintel/sdk/4.3.2241",
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,
@@ -28,7 +28,7 @@ export declare class AssetsClient {
28
28
  list(request?: AthenaIntelligence.ListAssetsRequest, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.PaginatedAssetsOut>;
29
29
  private __list;
30
30
  /**
31
- * Convert an uploaded Excel (.xlsx) asset into a new, editable Athena sheet asset — the same conversion the Athena UI performs. The new sheet is created alongside the source Excel asset. Pass run_async for large workbooks to get the sheet immediately and poll athena_metadata.conversionStatus for completion.
31
+ * Convert an uploaded Excel (.xlsx) asset into an editable Athena sheet — the same conversion the Athena UI performs. By default a new sheet asset is created alongside the source Excel asset; pass run_async for large workbooks to get the sheet immediately and poll its athena_metadata.conversionStatus for completion. With in_place the uploaded file itself becomes the sheet and keeps its asset id (sheet_asset_id is excel_asset_id, and no second asset is created); poll that asset until its media_type is 'athena/spreadsheet', or until athena_metadata.sheet_upload_conversion.status is 'failed' or 'skipped'.
32
32
  *
33
33
  * @param {AthenaIntelligence.ConvertExcelToSheetRequestIn} request
34
34
  * @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -38,10 +38,12 @@ export declare class AssetsClient {
38
38
  * @throws {@link AthenaIntelligence.NotFoundError}
39
39
  * @throws {@link AthenaIntelligence.UnprocessableEntityError}
40
40
  * @throws {@link AthenaIntelligence.InternalServerError}
41
+ * @throws {@link AthenaIntelligence.ServiceUnavailableError}
41
42
  *
42
43
  * @example
43
44
  * await client.assets.convertExcelToSheet({
44
45
  * excel_asset_id: "asset_92492920-d118-42d3-95b4-00eccfe0754f",
46
+ * in_place: false,
45
47
  * run_async: false
46
48
  * })
47
49
  */
@@ -158,7 +158,7 @@ class AssetsClient {
158
158
  });
159
159
  }
160
160
  /**
161
- * Convert an uploaded Excel (.xlsx) asset into a new, editable Athena sheet asset — the same conversion the Athena UI performs. The new sheet is created alongside the source Excel asset. Pass run_async for large workbooks to get the sheet immediately and poll athena_metadata.conversionStatus for completion.
161
+ * Convert an uploaded Excel (.xlsx) asset into an editable Athena sheet — the same conversion the Athena UI performs. By default a new sheet asset is created alongside the source Excel asset; pass run_async for large workbooks to get the sheet immediately and poll its athena_metadata.conversionStatus for completion. With in_place the uploaded file itself becomes the sheet and keeps its asset id (sheet_asset_id is excel_asset_id, and no second asset is created); poll that asset until its media_type is 'athena/spreadsheet', or until athena_metadata.sheet_upload_conversion.status is 'failed' or 'skipped'.
162
162
  *
163
163
  * @param {AthenaIntelligence.ConvertExcelToSheetRequestIn} request
164
164
  * @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -168,10 +168,12 @@ class AssetsClient {
168
168
  * @throws {@link AthenaIntelligence.NotFoundError}
169
169
  * @throws {@link AthenaIntelligence.UnprocessableEntityError}
170
170
  * @throws {@link AthenaIntelligence.InternalServerError}
171
+ * @throws {@link AthenaIntelligence.ServiceUnavailableError}
171
172
  *
172
173
  * @example
173
174
  * await client.assets.convertExcelToSheet({
174
175
  * excel_asset_id: "asset_92492920-d118-42d3-95b4-00eccfe0754f",
176
+ * in_place: false,
175
177
  * run_async: false
176
178
  * })
177
179
  */
@@ -217,6 +219,8 @@ class AssetsClient {
217
219
  throw new AthenaIntelligence.UnprocessableEntityError(_response.error.body, _response.rawResponse);
218
220
  case 500:
219
221
  throw new AthenaIntelligence.InternalServerError(_response.error.body, _response.rawResponse);
222
+ case 503:
223
+ throw new AthenaIntelligence.ServiceUnavailableError(_response.error.body, _response.rawResponse);
220
224
  default:
221
225
  throw new errors.AthenaIntelligenceError({
222
226
  statusCode: _response.error.statusCode,
@@ -2,12 +2,15 @@
2
2
  * @example
3
3
  * {
4
4
  * excel_asset_id: "asset_92492920-d118-42d3-95b4-00eccfe0754f",
5
+ * in_place: false,
5
6
  * run_async: false
6
7
  * }
7
8
  */
8
9
  export interface ConvertExcelToSheetRequestIn {
9
10
  /** ID of the Excel (.xlsx) asset to convert into an Athena sheet */
10
11
  excel_asset_id: string;
12
+ /** Make the uploaded file itself the Athena sheet, keeping its asset id: sheet_asset_id is excel_asset_id and no second asset is created. Needs edit access to the upload, and takes an .xlsx/.xlsm/.xlsb workbook or a .csv/.tsv file. A password-protected workbook is refused (convert it into a new sheet with `password` instead), and the sheet is always on the rnc engine. Without run_async the request waits up to about 50 seconds for the conversion; conversion_status 'converting' means it is still running. Poll the asset until its media_type is 'athena/spreadsheet', or until athena_metadata.sheet_upload_conversion.status is 'failed' or 'skipped' (with its reason). */
13
+ in_place?: boolean;
11
14
  /** Optional password used to decrypt a password-protected workbook. Password-protected workbooks convert on either engine (they are decrypted server-side before an rnc import). */
12
15
  password?: string | null;
13
16
  /** Return the sheet asset immediately and convert in the background. Large workbooks outlive the gateway's ~60s response window on the synchronous path — with run_async the caller polls athena_metadata.conversionStatus ('converting' | 'completed' | 'failed', with conversionError on failure) instead. */
@@ -4,13 +4,13 @@
4
4
  export interface ConvertExcelToSheetResponseOut {
5
5
  /** Type of the created sheet asset */
6
6
  asset_type: string;
7
- /** Conversion status for background (run_async) conversions: 'converting' immediately after the request. Poll the asset's athena_metadata.conversionStatus for 'completed' | 'failed'. Null for synchronous conversions, which have already completed. */
7
+ /** Conversion status for background (run_async) conversions: 'converting' immediately after the request. Poll the asset's athena_metadata.conversionStatus for 'completed' | 'failed'. Null for synchronous conversions, which have already completed. An in_place conversion still running answers 'converting' too; see in_place for how to poll it. */
8
8
  conversion_status?: string | null;
9
9
  /** ID of the source Excel asset */
10
10
  excel_asset_id: string;
11
11
  /** ID of the sheet asset's parent folder */
12
12
  parent_folder_id?: string | null;
13
- /** ID of the newly created Athena sheet asset */
13
+ /** ID of the Athena sheet: a new asset, or excel_asset_id itself for an in_place conversion */
14
14
  sheet_asset_id: string;
15
15
  /** Title of the created sheet asset */
16
16
  title: string;
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "4.3.2240";
1
+ export declare const SDK_VERSION = "4.3.2241";
@@ -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.2240";
4
+ exports.SDK_VERSION = "4.3.2241";
@@ -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.2240",
10
- "User-Agent": "@athenaintel/sdk/4.3.2240",
9
+ "X-Fern-SDK-Version": "4.3.2241",
10
+ "User-Agent": "@athenaintel/sdk/4.3.2241",
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,
@@ -28,7 +28,7 @@ export declare class AssetsClient {
28
28
  list(request?: AthenaIntelligence.ListAssetsRequest, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.PaginatedAssetsOut>;
29
29
  private __list;
30
30
  /**
31
- * Convert an uploaded Excel (.xlsx) asset into a new, editable Athena sheet asset — the same conversion the Athena UI performs. The new sheet is created alongside the source Excel asset. Pass run_async for large workbooks to get the sheet immediately and poll athena_metadata.conversionStatus for completion.
31
+ * Convert an uploaded Excel (.xlsx) asset into an editable Athena sheet — the same conversion the Athena UI performs. By default a new sheet asset is created alongside the source Excel asset; pass run_async for large workbooks to get the sheet immediately and poll its athena_metadata.conversionStatus for completion. With in_place the uploaded file itself becomes the sheet and keeps its asset id (sheet_asset_id is excel_asset_id, and no second asset is created); poll that asset until its media_type is 'athena/spreadsheet', or until athena_metadata.sheet_upload_conversion.status is 'failed' or 'skipped'.
32
32
  *
33
33
  * @param {AthenaIntelligence.ConvertExcelToSheetRequestIn} request
34
34
  * @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -38,10 +38,12 @@ export declare class AssetsClient {
38
38
  * @throws {@link AthenaIntelligence.NotFoundError}
39
39
  * @throws {@link AthenaIntelligence.UnprocessableEntityError}
40
40
  * @throws {@link AthenaIntelligence.InternalServerError}
41
+ * @throws {@link AthenaIntelligence.ServiceUnavailableError}
41
42
  *
42
43
  * @example
43
44
  * await client.assets.convertExcelToSheet({
44
45
  * excel_asset_id: "asset_92492920-d118-42d3-95b4-00eccfe0754f",
46
+ * in_place: false,
45
47
  * run_async: false
46
48
  * })
47
49
  */
@@ -122,7 +122,7 @@ export class AssetsClient {
122
122
  });
123
123
  }
124
124
  /**
125
- * Convert an uploaded Excel (.xlsx) asset into a new, editable Athena sheet asset — the same conversion the Athena UI performs. The new sheet is created alongside the source Excel asset. Pass run_async for large workbooks to get the sheet immediately and poll athena_metadata.conversionStatus for completion.
125
+ * Convert an uploaded Excel (.xlsx) asset into an editable Athena sheet — the same conversion the Athena UI performs. By default a new sheet asset is created alongside the source Excel asset; pass run_async for large workbooks to get the sheet immediately and poll its athena_metadata.conversionStatus for completion. With in_place the uploaded file itself becomes the sheet and keeps its asset id (sheet_asset_id is excel_asset_id, and no second asset is created); poll that asset until its media_type is 'athena/spreadsheet', or until athena_metadata.sheet_upload_conversion.status is 'failed' or 'skipped'.
126
126
  *
127
127
  * @param {AthenaIntelligence.ConvertExcelToSheetRequestIn} request
128
128
  * @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -132,10 +132,12 @@ export class AssetsClient {
132
132
  * @throws {@link AthenaIntelligence.NotFoundError}
133
133
  * @throws {@link AthenaIntelligence.UnprocessableEntityError}
134
134
  * @throws {@link AthenaIntelligence.InternalServerError}
135
+ * @throws {@link AthenaIntelligence.ServiceUnavailableError}
135
136
  *
136
137
  * @example
137
138
  * await client.assets.convertExcelToSheet({
138
139
  * excel_asset_id: "asset_92492920-d118-42d3-95b4-00eccfe0754f",
140
+ * in_place: false,
139
141
  * run_async: false
140
142
  * })
141
143
  */
@@ -181,6 +183,8 @@ export class AssetsClient {
181
183
  throw new AthenaIntelligence.UnprocessableEntityError(_response.error.body, _response.rawResponse);
182
184
  case 500:
183
185
  throw new AthenaIntelligence.InternalServerError(_response.error.body, _response.rawResponse);
186
+ case 503:
187
+ throw new AthenaIntelligence.ServiceUnavailableError(_response.error.body, _response.rawResponse);
184
188
  default:
185
189
  throw new errors.AthenaIntelligenceError({
186
190
  statusCode: _response.error.statusCode,
@@ -2,12 +2,15 @@
2
2
  * @example
3
3
  * {
4
4
  * excel_asset_id: "asset_92492920-d118-42d3-95b4-00eccfe0754f",
5
+ * in_place: false,
5
6
  * run_async: false
6
7
  * }
7
8
  */
8
9
  export interface ConvertExcelToSheetRequestIn {
9
10
  /** ID of the Excel (.xlsx) asset to convert into an Athena sheet */
10
11
  excel_asset_id: string;
12
+ /** Make the uploaded file itself the Athena sheet, keeping its asset id: sheet_asset_id is excel_asset_id and no second asset is created. Needs edit access to the upload, and takes an .xlsx/.xlsm/.xlsb workbook or a .csv/.tsv file. A password-protected workbook is refused (convert it into a new sheet with `password` instead), and the sheet is always on the rnc engine. Without run_async the request waits up to about 50 seconds for the conversion; conversion_status 'converting' means it is still running. Poll the asset until its media_type is 'athena/spreadsheet', or until athena_metadata.sheet_upload_conversion.status is 'failed' or 'skipped' (with its reason). */
13
+ in_place?: boolean;
11
14
  /** Optional password used to decrypt a password-protected workbook. Password-protected workbooks convert on either engine (they are decrypted server-side before an rnc import). */
12
15
  password?: string | null;
13
16
  /** Return the sheet asset immediately and convert in the background. Large workbooks outlive the gateway's ~60s response window on the synchronous path — with run_async the caller polls athena_metadata.conversionStatus ('converting' | 'completed' | 'failed', with conversionError on failure) instead. */
@@ -4,13 +4,13 @@
4
4
  export interface ConvertExcelToSheetResponseOut {
5
5
  /** Type of the created sheet asset */
6
6
  asset_type: string;
7
- /** Conversion status for background (run_async) conversions: 'converting' immediately after the request. Poll the asset's athena_metadata.conversionStatus for 'completed' | 'failed'. Null for synchronous conversions, which have already completed. */
7
+ /** Conversion status for background (run_async) conversions: 'converting' immediately after the request. Poll the asset's athena_metadata.conversionStatus for 'completed' | 'failed'. Null for synchronous conversions, which have already completed. An in_place conversion still running answers 'converting' too; see in_place for how to poll it. */
8
8
  conversion_status?: string | null;
9
9
  /** ID of the source Excel asset */
10
10
  excel_asset_id: string;
11
11
  /** ID of the sheet asset's parent folder */
12
12
  parent_folder_id?: string | null;
13
- /** ID of the newly created Athena sheet asset */
13
+ /** ID of the Athena sheet: a new asset, or excel_asset_id itself for an in_place conversion */
14
14
  sheet_asset_id: string;
15
15
  /** Title of the created sheet asset */
16
16
  title: string;
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "4.3.2240";
1
+ export declare const SDK_VERSION = "4.3.2241";
@@ -1 +1 @@
1
- export const SDK_VERSION = "4.3.2240";
1
+ export const SDK_VERSION = "4.3.2241";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@athenaintel/sdk",
3
- "version": "4.3.2240",
3
+ "version": "4.3.2241",
4
4
  "private": false,
5
5
  "repository": "github:Athena-Intel/athena-typescript",
6
6
  "type": "commonjs",
package/reference.md CHANGED
@@ -581,7 +581,7 @@ await client.assets.list({
581
581
  <dl>
582
582
  <dd>
583
583
 
584
- Convert an uploaded Excel (.xlsx) asset into a new, editable Athena sheet asset — the same conversion the Athena UI performs. The new sheet is created alongside the source Excel asset. Pass run_async for large workbooks to get the sheet immediately and poll athena_metadata.conversionStatus for completion.
584
+ Convert an uploaded Excel (.xlsx) asset into an editable Athena sheet — the same conversion the Athena UI performs. By default a new sheet asset is created alongside the source Excel asset; pass run_async for large workbooks to get the sheet immediately and poll its athena_metadata.conversionStatus for completion. With in_place the uploaded file itself becomes the sheet and keeps its asset id (sheet_asset_id is excel_asset_id, and no second asset is created); poll that asset until its media_type is 'athena/spreadsheet', or until athena_metadata.sheet_upload_conversion.status is 'failed' or 'skipped'.
585
585
  </dd>
586
586
  </dl>
587
587
  </dd>
@@ -598,6 +598,7 @@ Convert an uploaded Excel (.xlsx) asset into a new, editable Athena sheet asset
598
598
  ```typescript
599
599
  await client.assets.convertExcelToSheet({
600
600
  excel_asset_id: "asset_92492920-d118-42d3-95b4-00eccfe0754f",
601
+ in_place: false,
601
602
  run_async: false
602
603
  });
603
604