@athenaintel/sdk 4.3.1117 → 4.3.1119
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/Client.d.ts +3 -0
- package/dist/cjs/Client.js +9 -4
- package/dist/cjs/api/errors/BadGatewayError.d.ts +6 -0
- package/dist/cjs/api/errors/BadGatewayError.js +50 -0
- package/dist/cjs/api/errors/index.d.ts +1 -0
- package/dist/cjs/api/errors/index.js +1 -0
- package/dist/cjs/api/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/index.js +3 -1
- package/dist/cjs/api/resources/semanticModel/client/Client.d.ts +65 -0
- package/dist/cjs/api/resources/semanticModel/client/Client.js +301 -0
- package/dist/cjs/api/resources/semanticModel/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/semanticModel/client/index.js +17 -0
- package/dist/cjs/api/resources/semanticModel/client/requests/SemanticModelQueryRequestIn.d.ts +18 -0
- package/dist/cjs/api/resources/semanticModel/client/requests/SemanticModelQueryRequestIn.js +3 -0
- package/dist/cjs/api/resources/semanticModel/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/semanticModel/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/semanticModel/index.d.ts +1 -0
- package/dist/cjs/api/resources/semanticModel/index.js +17 -0
- package/dist/cjs/api/types/SemanticModelErrorResponse.d.ts +6 -0
- package/dist/cjs/api/types/SemanticModelErrorResponse.js +3 -0
- package/dist/cjs/api/types/SemanticModelMetaResponseOut.d.ts +7 -0
- package/dist/cjs/api/types/SemanticModelMetaResponseOut.js +3 -0
- package/dist/cjs/api/types/SemanticModelQueryResponseOut.d.ts +9 -0
- package/dist/cjs/api/types/SemanticModelQueryResponseOut.js +3 -0
- package/dist/cjs/api/types/SemanticModelTokenResponseOut.d.ts +11 -0
- package/dist/cjs/api/types/SemanticModelTokenResponseOut.js +3 -0
- package/dist/cjs/api/types/index.d.ts +4 -0
- package/dist/cjs/api/types/index.js +4 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/Client.d.mts +3 -0
- package/dist/esm/Client.mjs +5 -0
- package/dist/esm/api/errors/BadGatewayError.d.mts +6 -0
- package/dist/esm/api/errors/BadGatewayError.mjs +13 -0
- package/dist/esm/api/errors/index.d.mts +1 -0
- package/dist/esm/api/errors/index.mjs +1 -0
- package/dist/esm/api/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/index.mjs +2 -0
- package/dist/esm/api/resources/semanticModel/client/Client.d.mts +65 -0
- package/dist/esm/api/resources/semanticModel/client/Client.mjs +264 -0
- package/dist/esm/api/resources/semanticModel/client/index.d.mts +1 -0
- package/dist/esm/api/resources/semanticModel/client/index.mjs +1 -0
- package/dist/esm/api/resources/semanticModel/client/requests/SemanticModelQueryRequestIn.d.mts +18 -0
- package/dist/esm/api/resources/semanticModel/client/requests/SemanticModelQueryRequestIn.mjs +2 -0
- package/dist/esm/api/resources/semanticModel/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/semanticModel/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/semanticModel/index.d.mts +1 -0
- package/dist/esm/api/resources/semanticModel/index.mjs +1 -0
- package/dist/esm/api/types/SemanticModelErrorResponse.d.mts +6 -0
- package/dist/esm/api/types/SemanticModelErrorResponse.mjs +2 -0
- package/dist/esm/api/types/SemanticModelMetaResponseOut.d.mts +7 -0
- package/dist/esm/api/types/SemanticModelMetaResponseOut.mjs +2 -0
- package/dist/esm/api/types/SemanticModelQueryResponseOut.d.mts +9 -0
- package/dist/esm/api/types/SemanticModelQueryResponseOut.mjs +2 -0
- package/dist/esm/api/types/SemanticModelTokenResponseOut.d.mts +11 -0
- package/dist/esm/api/types/SemanticModelTokenResponseOut.mjs +2 -0
- package/dist/esm/api/types/index.d.mts +4 -0
- package/dist/esm/api/types/index.mjs +4 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +200 -0
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.1119";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "4.3.
|
|
1
|
+
export const SDK_VERSION = "4.3.1119";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -1280,6 +1280,206 @@ await client.query.executeSnippet({
|
|
|
1280
1280
|
</dl>
|
|
1281
1281
|
|
|
1282
1282
|
|
|
1283
|
+
</dd>
|
|
1284
|
+
</dl>
|
|
1285
|
+
</details>
|
|
1286
|
+
|
|
1287
|
+
## SemanticModel
|
|
1288
|
+
<details><summary><code>client.semanticModel.<a href="/src/api/resources/semanticModel/client/Client.ts">generateToken</a>(asset_id) -> AthenaIntelligence.SemanticModelTokenResponseOut</code></summary>
|
|
1289
|
+
<dl>
|
|
1290
|
+
<dd>
|
|
1291
|
+
|
|
1292
|
+
#### 📝 Description
|
|
1293
|
+
|
|
1294
|
+
<dl>
|
|
1295
|
+
<dd>
|
|
1296
|
+
|
|
1297
|
+
<dl>
|
|
1298
|
+
<dd>
|
|
1299
|
+
|
|
1300
|
+
Generate a short-lived JWT token for direct access to the semantic model's Cube REST API. Use this token to query /cubejs-api/v1/load and /cubejs-api/v1/meta directly. Token expires after 1 hour. The token carries only the model ID and schema hash — database credentials are NOT included and are resolved server-side by Cube via callback.
|
|
1301
|
+
</dd>
|
|
1302
|
+
</dl>
|
|
1303
|
+
</dd>
|
|
1304
|
+
</dl>
|
|
1305
|
+
|
|
1306
|
+
#### 🔌 Usage
|
|
1307
|
+
|
|
1308
|
+
<dl>
|
|
1309
|
+
<dd>
|
|
1310
|
+
|
|
1311
|
+
<dl>
|
|
1312
|
+
<dd>
|
|
1313
|
+
|
|
1314
|
+
```typescript
|
|
1315
|
+
await client.semanticModel.generateToken("asset_id");
|
|
1316
|
+
|
|
1317
|
+
```
|
|
1318
|
+
</dd>
|
|
1319
|
+
</dl>
|
|
1320
|
+
</dd>
|
|
1321
|
+
</dl>
|
|
1322
|
+
|
|
1323
|
+
#### ⚙️ Parameters
|
|
1324
|
+
|
|
1325
|
+
<dl>
|
|
1326
|
+
<dd>
|
|
1327
|
+
|
|
1328
|
+
<dl>
|
|
1329
|
+
<dd>
|
|
1330
|
+
|
|
1331
|
+
**asset_id:** `string`
|
|
1332
|
+
|
|
1333
|
+
</dd>
|
|
1334
|
+
</dl>
|
|
1335
|
+
|
|
1336
|
+
<dl>
|
|
1337
|
+
<dd>
|
|
1338
|
+
|
|
1339
|
+
**requestOptions:** `SemanticModelClient.RequestOptions`
|
|
1340
|
+
|
|
1341
|
+
</dd>
|
|
1342
|
+
</dl>
|
|
1343
|
+
</dd>
|
|
1344
|
+
</dl>
|
|
1345
|
+
|
|
1346
|
+
|
|
1347
|
+
</dd>
|
|
1348
|
+
</dl>
|
|
1349
|
+
</details>
|
|
1350
|
+
|
|
1351
|
+
<details><summary><code>client.semanticModel.<a href="/src/api/resources/semanticModel/client/Client.ts">getMeta</a>(asset_id) -> AthenaIntelligence.SemanticModelMetaResponseOut</code></summary>
|
|
1352
|
+
<dl>
|
|
1353
|
+
<dd>
|
|
1354
|
+
|
|
1355
|
+
#### 📝 Description
|
|
1356
|
+
|
|
1357
|
+
<dl>
|
|
1358
|
+
<dd>
|
|
1359
|
+
|
|
1360
|
+
<dl>
|
|
1361
|
+
<dd>
|
|
1362
|
+
|
|
1363
|
+
Get metadata for a semantic model including all cubes, measures, dimensions, segments, and joins.
|
|
1364
|
+
</dd>
|
|
1365
|
+
</dl>
|
|
1366
|
+
</dd>
|
|
1367
|
+
</dl>
|
|
1368
|
+
|
|
1369
|
+
#### 🔌 Usage
|
|
1370
|
+
|
|
1371
|
+
<dl>
|
|
1372
|
+
<dd>
|
|
1373
|
+
|
|
1374
|
+
<dl>
|
|
1375
|
+
<dd>
|
|
1376
|
+
|
|
1377
|
+
```typescript
|
|
1378
|
+
await client.semanticModel.getMeta("asset_id");
|
|
1379
|
+
|
|
1380
|
+
```
|
|
1381
|
+
</dd>
|
|
1382
|
+
</dl>
|
|
1383
|
+
</dd>
|
|
1384
|
+
</dl>
|
|
1385
|
+
|
|
1386
|
+
#### ⚙️ Parameters
|
|
1387
|
+
|
|
1388
|
+
<dl>
|
|
1389
|
+
<dd>
|
|
1390
|
+
|
|
1391
|
+
<dl>
|
|
1392
|
+
<dd>
|
|
1393
|
+
|
|
1394
|
+
**asset_id:** `string`
|
|
1395
|
+
|
|
1396
|
+
</dd>
|
|
1397
|
+
</dl>
|
|
1398
|
+
|
|
1399
|
+
<dl>
|
|
1400
|
+
<dd>
|
|
1401
|
+
|
|
1402
|
+
**requestOptions:** `SemanticModelClient.RequestOptions`
|
|
1403
|
+
|
|
1404
|
+
</dd>
|
|
1405
|
+
</dl>
|
|
1406
|
+
</dd>
|
|
1407
|
+
</dl>
|
|
1408
|
+
|
|
1409
|
+
|
|
1410
|
+
</dd>
|
|
1411
|
+
</dl>
|
|
1412
|
+
</details>
|
|
1413
|
+
|
|
1414
|
+
<details><summary><code>client.semanticModel.<a href="/src/api/resources/semanticModel/client/Client.ts">query</a>(asset_id, { ...params }) -> AthenaIntelligence.SemanticModelQueryResponseOut</code></summary>
|
|
1415
|
+
<dl>
|
|
1416
|
+
<dd>
|
|
1417
|
+
|
|
1418
|
+
#### 📝 Description
|
|
1419
|
+
|
|
1420
|
+
<dl>
|
|
1421
|
+
<dd>
|
|
1422
|
+
|
|
1423
|
+
<dl>
|
|
1424
|
+
<dd>
|
|
1425
|
+
|
|
1426
|
+
Execute a metric query against a semantic model. Specify measures, optional dimensions, filters, and time dimensions. Returns structured data rows.
|
|
1427
|
+
</dd>
|
|
1428
|
+
</dl>
|
|
1429
|
+
</dd>
|
|
1430
|
+
</dl>
|
|
1431
|
+
|
|
1432
|
+
#### 🔌 Usage
|
|
1433
|
+
|
|
1434
|
+
<dl>
|
|
1435
|
+
<dd>
|
|
1436
|
+
|
|
1437
|
+
<dl>
|
|
1438
|
+
<dd>
|
|
1439
|
+
|
|
1440
|
+
```typescript
|
|
1441
|
+
await client.semanticModel.query("asset_id", {
|
|
1442
|
+
measures: ["orders.count", "orders.total_revenue"]
|
|
1443
|
+
});
|
|
1444
|
+
|
|
1445
|
+
```
|
|
1446
|
+
</dd>
|
|
1447
|
+
</dl>
|
|
1448
|
+
</dd>
|
|
1449
|
+
</dl>
|
|
1450
|
+
|
|
1451
|
+
#### ⚙️ Parameters
|
|
1452
|
+
|
|
1453
|
+
<dl>
|
|
1454
|
+
<dd>
|
|
1455
|
+
|
|
1456
|
+
<dl>
|
|
1457
|
+
<dd>
|
|
1458
|
+
|
|
1459
|
+
**asset_id:** `string`
|
|
1460
|
+
|
|
1461
|
+
</dd>
|
|
1462
|
+
</dl>
|
|
1463
|
+
|
|
1464
|
+
<dl>
|
|
1465
|
+
<dd>
|
|
1466
|
+
|
|
1467
|
+
**request:** `AthenaIntelligence.SemanticModelQueryRequestIn`
|
|
1468
|
+
|
|
1469
|
+
</dd>
|
|
1470
|
+
</dl>
|
|
1471
|
+
|
|
1472
|
+
<dl>
|
|
1473
|
+
<dd>
|
|
1474
|
+
|
|
1475
|
+
**requestOptions:** `SemanticModelClient.RequestOptions`
|
|
1476
|
+
|
|
1477
|
+
</dd>
|
|
1478
|
+
</dl>
|
|
1479
|
+
</dd>
|
|
1480
|
+
</dl>
|
|
1481
|
+
|
|
1482
|
+
|
|
1283
1483
|
</dd>
|
|
1284
1484
|
</dl>
|
|
1285
1485
|
</details>
|