@robosystems/client 0.2.32 → 0.2.33
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/index.ts +2 -2
- package/package.json +1 -1
- package/sdk/index.d.ts +2 -2
- package/sdk/index.js +4 -3
- package/sdk/index.ts +2 -2
- package/sdk/sdk.gen.d.ts +13 -18
- package/sdk/sdk.gen.js +23 -19
- package/sdk/sdk.gen.ts +22 -18
- package/sdk/types.gen.d.ts +192 -55
- package/sdk/types.gen.ts +199 -56
- package/sdk.gen.d.ts +13 -18
- package/sdk.gen.js +23 -19
- package/sdk.gen.ts +22 -18
- package/types.gen.d.ts +192 -55
- package/types.gen.ts +199 -56
package/sdk/types.gen.d.ts
CHANGED
|
@@ -974,7 +974,7 @@ export type ConnectionProviderInfo = {
|
|
|
974
974
|
*
|
|
975
975
|
* Provider identifier
|
|
976
976
|
*/
|
|
977
|
-
provider: 'sec' | 'quickbooks'
|
|
977
|
+
provider: 'sec' | 'quickbooks';
|
|
978
978
|
/**
|
|
979
979
|
* Display Name
|
|
980
980
|
*
|
|
@@ -1065,7 +1065,7 @@ export type ConnectionResponse = {
|
|
|
1065
1065
|
*
|
|
1066
1066
|
* Entity identifier
|
|
1067
1067
|
*/
|
|
1068
|
-
entity_id
|
|
1068
|
+
entity_id?: string | null;
|
|
1069
1069
|
/**
|
|
1070
1070
|
* Status
|
|
1071
1071
|
*
|
|
@@ -1277,16 +1277,15 @@ export type CreateConnectionRequest = {
|
|
|
1277
1277
|
*
|
|
1278
1278
|
* Connection provider type
|
|
1279
1279
|
*/
|
|
1280
|
-
provider: 'sec' | 'quickbooks'
|
|
1280
|
+
provider: 'sec' | 'quickbooks';
|
|
1281
1281
|
/**
|
|
1282
1282
|
* Entity Id
|
|
1283
1283
|
*
|
|
1284
|
-
* Entity identifier
|
|
1284
|
+
* Entity identifier. Required for QuickBooks, optional for SEC (SEC creates the entity from filing data).
|
|
1285
1285
|
*/
|
|
1286
|
-
entity_id
|
|
1286
|
+
entity_id?: string | null;
|
|
1287
1287
|
sec_config?: SecConnectionConfig | null;
|
|
1288
1288
|
quickbooks_config?: QuickBooksConnectionConfig | null;
|
|
1289
|
-
plaid_config?: PlaidConnectionConfig | null;
|
|
1290
1289
|
};
|
|
1291
1290
|
/**
|
|
1292
1291
|
* CreateGraphRequest
|
|
@@ -1391,6 +1390,75 @@ export type CreateSubgraphRequest = {
|
|
|
1391
1390
|
*/
|
|
1392
1391
|
fork_parent?: boolean;
|
|
1393
1392
|
};
|
|
1393
|
+
/**
|
|
1394
|
+
* CreateViewRequest
|
|
1395
|
+
*/
|
|
1396
|
+
export type CreateViewRequest = {
|
|
1397
|
+
/**
|
|
1398
|
+
* Elements
|
|
1399
|
+
*
|
|
1400
|
+
* Element qnames (e.g., 'us-gaap:Assets'). Can combine with canonical_concepts.
|
|
1401
|
+
*/
|
|
1402
|
+
elements?: Array<string>;
|
|
1403
|
+
/**
|
|
1404
|
+
* Canonical Concepts
|
|
1405
|
+
*
|
|
1406
|
+
* Canonical concept names (e.g., 'revenue', 'net_income'). Matches all mapped qnames.
|
|
1407
|
+
*/
|
|
1408
|
+
canonical_concepts?: Array<string>;
|
|
1409
|
+
/**
|
|
1410
|
+
* Periods
|
|
1411
|
+
*
|
|
1412
|
+
* Period end dates (YYYY-MM-DD format)
|
|
1413
|
+
*/
|
|
1414
|
+
periods?: Array<string>;
|
|
1415
|
+
/**
|
|
1416
|
+
* Entity
|
|
1417
|
+
*
|
|
1418
|
+
* Filter by entity ticker, CIK, or name
|
|
1419
|
+
*/
|
|
1420
|
+
entity?: string | null;
|
|
1421
|
+
/**
|
|
1422
|
+
* Entities
|
|
1423
|
+
*
|
|
1424
|
+
* Filter by multiple entity tickers (e.g., ['NVDA', 'AAPL'])
|
|
1425
|
+
*/
|
|
1426
|
+
entities?: Array<string>;
|
|
1427
|
+
/**
|
|
1428
|
+
* Form
|
|
1429
|
+
*
|
|
1430
|
+
* Filter by SEC filing form type (e.g., '10-K', '10-Q')
|
|
1431
|
+
*/
|
|
1432
|
+
form?: string | null;
|
|
1433
|
+
/**
|
|
1434
|
+
* Fiscal Year
|
|
1435
|
+
*
|
|
1436
|
+
* Filter by fiscal year (e.g., 2024)
|
|
1437
|
+
*/
|
|
1438
|
+
fiscal_year?: number | null;
|
|
1439
|
+
/**
|
|
1440
|
+
* Fiscal Period
|
|
1441
|
+
*
|
|
1442
|
+
* Filter by fiscal period (e.g., 'FY', 'Q1', 'Q2', 'Q3')
|
|
1443
|
+
*/
|
|
1444
|
+
fiscal_period?: string | null;
|
|
1445
|
+
/**
|
|
1446
|
+
* Period Type
|
|
1447
|
+
*
|
|
1448
|
+
* Filter by period type: 'annual', 'quarterly', or 'instant'
|
|
1449
|
+
*/
|
|
1450
|
+
period_type?: string | null;
|
|
1451
|
+
/**
|
|
1452
|
+
* Include Summary
|
|
1453
|
+
*
|
|
1454
|
+
* Include summary statistics per element
|
|
1455
|
+
*/
|
|
1456
|
+
include_summary?: boolean;
|
|
1457
|
+
/**
|
|
1458
|
+
* View/pivot configuration
|
|
1459
|
+
*/
|
|
1460
|
+
view_config?: ViewConfig;
|
|
1461
|
+
};
|
|
1394
1462
|
/**
|
|
1395
1463
|
* CreditLimits
|
|
1396
1464
|
*
|
|
@@ -4151,47 +4219,6 @@ export type PerformanceInsights = {
|
|
|
4151
4219
|
*/
|
|
4152
4220
|
performance_score: number;
|
|
4153
4221
|
};
|
|
4154
|
-
/**
|
|
4155
|
-
* PlaidConnectionConfig
|
|
4156
|
-
*
|
|
4157
|
-
* Plaid-specific connection configuration.
|
|
4158
|
-
*/
|
|
4159
|
-
export type PlaidConnectionConfig = {
|
|
4160
|
-
/**
|
|
4161
|
-
* Public Token
|
|
4162
|
-
*
|
|
4163
|
-
* Plaid public token for exchange
|
|
4164
|
-
*/
|
|
4165
|
-
public_token?: string | null;
|
|
4166
|
-
/**
|
|
4167
|
-
* Access Token
|
|
4168
|
-
*
|
|
4169
|
-
* Plaid access token (set after exchange)
|
|
4170
|
-
*/
|
|
4171
|
-
access_token?: string | null;
|
|
4172
|
-
/**
|
|
4173
|
-
* Item Id
|
|
4174
|
-
*
|
|
4175
|
-
* Plaid item ID
|
|
4176
|
-
*/
|
|
4177
|
-
item_id?: string | null;
|
|
4178
|
-
/**
|
|
4179
|
-
* Institution
|
|
4180
|
-
*
|
|
4181
|
-
* Institution information
|
|
4182
|
-
*/
|
|
4183
|
-
institution?: {
|
|
4184
|
-
[key: string]: unknown;
|
|
4185
|
-
} | null;
|
|
4186
|
-
/**
|
|
4187
|
-
* Accounts
|
|
4188
|
-
*
|
|
4189
|
-
* Connected accounts
|
|
4190
|
-
*/
|
|
4191
|
-
accounts?: Array<{
|
|
4192
|
-
[key: string]: unknown;
|
|
4193
|
-
}> | null;
|
|
4194
|
-
};
|
|
4195
4222
|
/**
|
|
4196
4223
|
* PortalSessionResponse
|
|
4197
4224
|
*
|
|
@@ -4441,15 +4468,9 @@ export type SecConnectionConfig = {
|
|
|
4441
4468
|
/**
|
|
4442
4469
|
* Cik
|
|
4443
4470
|
*
|
|
4444
|
-
*
|
|
4471
|
+
* SEC Central Index Key
|
|
4445
4472
|
*/
|
|
4446
4473
|
cik: string;
|
|
4447
|
-
/**
|
|
4448
|
-
* Entity Name
|
|
4449
|
-
*
|
|
4450
|
-
* Entity name from SEC
|
|
4451
|
-
*/
|
|
4452
|
-
entity_name?: string | null;
|
|
4453
4474
|
};
|
|
4454
4475
|
/**
|
|
4455
4476
|
* SSOCompleteRequest
|
|
@@ -5532,6 +5553,98 @@ export type ValidationError = {
|
|
|
5532
5553
|
[key: string]: unknown;
|
|
5533
5554
|
};
|
|
5534
5555
|
};
|
|
5556
|
+
/**
|
|
5557
|
+
* ViewAxisConfig
|
|
5558
|
+
*/
|
|
5559
|
+
export type ViewAxisConfig = {
|
|
5560
|
+
/**
|
|
5561
|
+
* Type
|
|
5562
|
+
*
|
|
5563
|
+
* Axis type: 'element', 'period', 'dimension', 'entity'
|
|
5564
|
+
*/
|
|
5565
|
+
type: string;
|
|
5566
|
+
/**
|
|
5567
|
+
* Dimension Axis
|
|
5568
|
+
*
|
|
5569
|
+
* Dimension axis name for dimension-type axes
|
|
5570
|
+
*/
|
|
5571
|
+
dimension_axis?: string | null;
|
|
5572
|
+
/**
|
|
5573
|
+
* Include Null Dimension
|
|
5574
|
+
*
|
|
5575
|
+
* Include facts where this dimension is NULL (default: false)
|
|
5576
|
+
*/
|
|
5577
|
+
include_null_dimension?: boolean;
|
|
5578
|
+
/**
|
|
5579
|
+
* Selected Members
|
|
5580
|
+
*
|
|
5581
|
+
* Specific members to include (e.g., ['2024-12-31', '2023-12-31'])
|
|
5582
|
+
*/
|
|
5583
|
+
selected_members?: Array<string> | null;
|
|
5584
|
+
/**
|
|
5585
|
+
* Member Order
|
|
5586
|
+
*
|
|
5587
|
+
* Explicit ordering of members (overrides default sort)
|
|
5588
|
+
*/
|
|
5589
|
+
member_order?: Array<string> | null;
|
|
5590
|
+
/**
|
|
5591
|
+
* Member Labels
|
|
5592
|
+
*
|
|
5593
|
+
* Custom labels for members (e.g., {'2024-12-31': 'Current Year'})
|
|
5594
|
+
*/
|
|
5595
|
+
member_labels?: {
|
|
5596
|
+
[key: string]: string;
|
|
5597
|
+
} | null;
|
|
5598
|
+
/**
|
|
5599
|
+
* Element Order
|
|
5600
|
+
*
|
|
5601
|
+
* Element ordering for hierarchy display (e.g., ['us-gaap:Assets', 'us-gaap:Cash', ...])
|
|
5602
|
+
*/
|
|
5603
|
+
element_order?: Array<string> | null;
|
|
5604
|
+
/**
|
|
5605
|
+
* Element Labels
|
|
5606
|
+
*
|
|
5607
|
+
* Custom labels for elements (e.g., {'us-gaap:Cash': 'Cash and Cash Equivalents'})
|
|
5608
|
+
*/
|
|
5609
|
+
element_labels?: {
|
|
5610
|
+
[key: string]: string;
|
|
5611
|
+
} | null;
|
|
5612
|
+
};
|
|
5613
|
+
/**
|
|
5614
|
+
* ViewConfig
|
|
5615
|
+
*/
|
|
5616
|
+
export type ViewConfig = {
|
|
5617
|
+
/**
|
|
5618
|
+
* Rows
|
|
5619
|
+
*
|
|
5620
|
+
* Row axis configuration
|
|
5621
|
+
*/
|
|
5622
|
+
rows?: Array<ViewAxisConfig>;
|
|
5623
|
+
/**
|
|
5624
|
+
* Columns
|
|
5625
|
+
*
|
|
5626
|
+
* Column axis configuration
|
|
5627
|
+
*/
|
|
5628
|
+
columns?: Array<ViewAxisConfig>;
|
|
5629
|
+
/**
|
|
5630
|
+
* Values
|
|
5631
|
+
*
|
|
5632
|
+
* Field to use for values (default: numeric_value)
|
|
5633
|
+
*/
|
|
5634
|
+
values?: string;
|
|
5635
|
+
/**
|
|
5636
|
+
* Aggregation Function
|
|
5637
|
+
*
|
|
5638
|
+
* Aggregation function: sum, average, count
|
|
5639
|
+
*/
|
|
5640
|
+
aggregation_function?: string;
|
|
5641
|
+
/**
|
|
5642
|
+
* Fill Value
|
|
5643
|
+
*
|
|
5644
|
+
* Value to use for missing data
|
|
5645
|
+
*/
|
|
5646
|
+
fill_value?: number;
|
|
5647
|
+
};
|
|
5535
5648
|
export type RegisterUserData = {
|
|
5536
5649
|
body: RegisterRequest;
|
|
5537
5650
|
path?: never;
|
|
@@ -6353,7 +6466,7 @@ export type ListConnectionsData = {
|
|
|
6353
6466
|
*
|
|
6354
6467
|
* Filter by provider type
|
|
6355
6468
|
*/
|
|
6356
|
-
provider?: 'sec' | 'quickbooks' |
|
|
6469
|
+
provider?: 'sec' | 'quickbooks' | null;
|
|
6357
6470
|
};
|
|
6358
6471
|
url: '/v1/graphs/{graph_id}/connections';
|
|
6359
6472
|
};
|
|
@@ -8273,6 +8386,30 @@ export type QueryTablesResponses = {
|
|
|
8273
8386
|
200: TableQueryResponse;
|
|
8274
8387
|
};
|
|
8275
8388
|
export type QueryTablesResponse = QueryTablesResponses[keyof QueryTablesResponses];
|
|
8389
|
+
export type CreateViewData = {
|
|
8390
|
+
body: CreateViewRequest;
|
|
8391
|
+
path: {
|
|
8392
|
+
/**
|
|
8393
|
+
* Graph Id
|
|
8394
|
+
*/
|
|
8395
|
+
graph_id: string;
|
|
8396
|
+
};
|
|
8397
|
+
query?: never;
|
|
8398
|
+
url: '/v1/graphs/{graph_id}/views';
|
|
8399
|
+
};
|
|
8400
|
+
export type CreateViewErrors = {
|
|
8401
|
+
/**
|
|
8402
|
+
* Validation Error
|
|
8403
|
+
*/
|
|
8404
|
+
422: HttpValidationError;
|
|
8405
|
+
};
|
|
8406
|
+
export type CreateViewError = CreateViewErrors[keyof CreateViewErrors];
|
|
8407
|
+
export type CreateViewResponses = {
|
|
8408
|
+
/**
|
|
8409
|
+
* Successful Response
|
|
8410
|
+
*/
|
|
8411
|
+
200: unknown;
|
|
8412
|
+
};
|
|
8276
8413
|
export type GetMaterializationStatusData = {
|
|
8277
8414
|
body?: never;
|
|
8278
8415
|
path: {
|
package/sdk/types.gen.ts
CHANGED
|
@@ -1006,7 +1006,7 @@ export type ConnectionProviderInfo = {
|
|
|
1006
1006
|
*
|
|
1007
1007
|
* Provider identifier
|
|
1008
1008
|
*/
|
|
1009
|
-
provider: 'sec' | 'quickbooks'
|
|
1009
|
+
provider: 'sec' | 'quickbooks';
|
|
1010
1010
|
/**
|
|
1011
1011
|
* Display Name
|
|
1012
1012
|
*
|
|
@@ -1098,7 +1098,7 @@ export type ConnectionResponse = {
|
|
|
1098
1098
|
*
|
|
1099
1099
|
* Entity identifier
|
|
1100
1100
|
*/
|
|
1101
|
-
entity_id
|
|
1101
|
+
entity_id?: string | null;
|
|
1102
1102
|
/**
|
|
1103
1103
|
* Status
|
|
1104
1104
|
*
|
|
@@ -1316,16 +1316,15 @@ export type CreateConnectionRequest = {
|
|
|
1316
1316
|
*
|
|
1317
1317
|
* Connection provider type
|
|
1318
1318
|
*/
|
|
1319
|
-
provider: 'sec' | 'quickbooks'
|
|
1319
|
+
provider: 'sec' | 'quickbooks';
|
|
1320
1320
|
/**
|
|
1321
1321
|
* Entity Id
|
|
1322
1322
|
*
|
|
1323
|
-
* Entity identifier
|
|
1323
|
+
* Entity identifier. Required for QuickBooks, optional for SEC (SEC creates the entity from filing data).
|
|
1324
1324
|
*/
|
|
1325
|
-
entity_id
|
|
1325
|
+
entity_id?: string | null;
|
|
1326
1326
|
sec_config?: SecConnectionConfig | null;
|
|
1327
1327
|
quickbooks_config?: QuickBooksConnectionConfig | null;
|
|
1328
|
-
plaid_config?: PlaidConnectionConfig | null;
|
|
1329
1328
|
};
|
|
1330
1329
|
|
|
1331
1330
|
/**
|
|
@@ -1434,6 +1433,76 @@ export type CreateSubgraphRequest = {
|
|
|
1434
1433
|
fork_parent?: boolean;
|
|
1435
1434
|
};
|
|
1436
1435
|
|
|
1436
|
+
/**
|
|
1437
|
+
* CreateViewRequest
|
|
1438
|
+
*/
|
|
1439
|
+
export type CreateViewRequest = {
|
|
1440
|
+
/**
|
|
1441
|
+
* Elements
|
|
1442
|
+
*
|
|
1443
|
+
* Element qnames (e.g., 'us-gaap:Assets'). Can combine with canonical_concepts.
|
|
1444
|
+
*/
|
|
1445
|
+
elements?: Array<string>;
|
|
1446
|
+
/**
|
|
1447
|
+
* Canonical Concepts
|
|
1448
|
+
*
|
|
1449
|
+
* Canonical concept names (e.g., 'revenue', 'net_income'). Matches all mapped qnames.
|
|
1450
|
+
*/
|
|
1451
|
+
canonical_concepts?: Array<string>;
|
|
1452
|
+
/**
|
|
1453
|
+
* Periods
|
|
1454
|
+
*
|
|
1455
|
+
* Period end dates (YYYY-MM-DD format)
|
|
1456
|
+
*/
|
|
1457
|
+
periods?: Array<string>;
|
|
1458
|
+
/**
|
|
1459
|
+
* Entity
|
|
1460
|
+
*
|
|
1461
|
+
* Filter by entity ticker, CIK, or name
|
|
1462
|
+
*/
|
|
1463
|
+
entity?: string | null;
|
|
1464
|
+
/**
|
|
1465
|
+
* Entities
|
|
1466
|
+
*
|
|
1467
|
+
* Filter by multiple entity tickers (e.g., ['NVDA', 'AAPL'])
|
|
1468
|
+
*/
|
|
1469
|
+
entities?: Array<string>;
|
|
1470
|
+
/**
|
|
1471
|
+
* Form
|
|
1472
|
+
*
|
|
1473
|
+
* Filter by SEC filing form type (e.g., '10-K', '10-Q')
|
|
1474
|
+
*/
|
|
1475
|
+
form?: string | null;
|
|
1476
|
+
/**
|
|
1477
|
+
* Fiscal Year
|
|
1478
|
+
*
|
|
1479
|
+
* Filter by fiscal year (e.g., 2024)
|
|
1480
|
+
*/
|
|
1481
|
+
fiscal_year?: number | null;
|
|
1482
|
+
/**
|
|
1483
|
+
* Fiscal Period
|
|
1484
|
+
*
|
|
1485
|
+
* Filter by fiscal period (e.g., 'FY', 'Q1', 'Q2', 'Q3')
|
|
1486
|
+
*/
|
|
1487
|
+
fiscal_period?: string | null;
|
|
1488
|
+
/**
|
|
1489
|
+
* Period Type
|
|
1490
|
+
*
|
|
1491
|
+
* Filter by period type: 'annual', 'quarterly', or 'instant'
|
|
1492
|
+
*/
|
|
1493
|
+
period_type?: string | null;
|
|
1494
|
+
/**
|
|
1495
|
+
* Include Summary
|
|
1496
|
+
*
|
|
1497
|
+
* Include summary statistics per element
|
|
1498
|
+
*/
|
|
1499
|
+
include_summary?: boolean;
|
|
1500
|
+
/**
|
|
1501
|
+
* View/pivot configuration
|
|
1502
|
+
*/
|
|
1503
|
+
view_config?: ViewConfig;
|
|
1504
|
+
};
|
|
1505
|
+
|
|
1437
1506
|
/**
|
|
1438
1507
|
* CreditLimits
|
|
1439
1508
|
*
|
|
@@ -4266,48 +4335,6 @@ export type PerformanceInsights = {
|
|
|
4266
4335
|
performance_score: number;
|
|
4267
4336
|
};
|
|
4268
4337
|
|
|
4269
|
-
/**
|
|
4270
|
-
* PlaidConnectionConfig
|
|
4271
|
-
*
|
|
4272
|
-
* Plaid-specific connection configuration.
|
|
4273
|
-
*/
|
|
4274
|
-
export type PlaidConnectionConfig = {
|
|
4275
|
-
/**
|
|
4276
|
-
* Public Token
|
|
4277
|
-
*
|
|
4278
|
-
* Plaid public token for exchange
|
|
4279
|
-
*/
|
|
4280
|
-
public_token?: string | null;
|
|
4281
|
-
/**
|
|
4282
|
-
* Access Token
|
|
4283
|
-
*
|
|
4284
|
-
* Plaid access token (set after exchange)
|
|
4285
|
-
*/
|
|
4286
|
-
access_token?: string | null;
|
|
4287
|
-
/**
|
|
4288
|
-
* Item Id
|
|
4289
|
-
*
|
|
4290
|
-
* Plaid item ID
|
|
4291
|
-
*/
|
|
4292
|
-
item_id?: string | null;
|
|
4293
|
-
/**
|
|
4294
|
-
* Institution
|
|
4295
|
-
*
|
|
4296
|
-
* Institution information
|
|
4297
|
-
*/
|
|
4298
|
-
institution?: {
|
|
4299
|
-
[key: string]: unknown;
|
|
4300
|
-
} | null;
|
|
4301
|
-
/**
|
|
4302
|
-
* Accounts
|
|
4303
|
-
*
|
|
4304
|
-
* Connected accounts
|
|
4305
|
-
*/
|
|
4306
|
-
accounts?: Array<{
|
|
4307
|
-
[key: string]: unknown;
|
|
4308
|
-
}> | null;
|
|
4309
|
-
};
|
|
4310
|
-
|
|
4311
4338
|
/**
|
|
4312
4339
|
* PortalSessionResponse
|
|
4313
4340
|
*
|
|
@@ -4567,15 +4594,9 @@ export type SecConnectionConfig = {
|
|
|
4567
4594
|
/**
|
|
4568
4595
|
* Cik
|
|
4569
4596
|
*
|
|
4570
|
-
*
|
|
4597
|
+
* SEC Central Index Key
|
|
4571
4598
|
*/
|
|
4572
4599
|
cik: string;
|
|
4573
|
-
/**
|
|
4574
|
-
* Entity Name
|
|
4575
|
-
*
|
|
4576
|
-
* Entity name from SEC
|
|
4577
|
-
*/
|
|
4578
|
-
entity_name?: string | null;
|
|
4579
4600
|
};
|
|
4580
4601
|
|
|
4581
4602
|
/**
|
|
@@ -5696,6 +5717,100 @@ export type ValidationError = {
|
|
|
5696
5717
|
};
|
|
5697
5718
|
};
|
|
5698
5719
|
|
|
5720
|
+
/**
|
|
5721
|
+
* ViewAxisConfig
|
|
5722
|
+
*/
|
|
5723
|
+
export type ViewAxisConfig = {
|
|
5724
|
+
/**
|
|
5725
|
+
* Type
|
|
5726
|
+
*
|
|
5727
|
+
* Axis type: 'element', 'period', 'dimension', 'entity'
|
|
5728
|
+
*/
|
|
5729
|
+
type: string;
|
|
5730
|
+
/**
|
|
5731
|
+
* Dimension Axis
|
|
5732
|
+
*
|
|
5733
|
+
* Dimension axis name for dimension-type axes
|
|
5734
|
+
*/
|
|
5735
|
+
dimension_axis?: string | null;
|
|
5736
|
+
/**
|
|
5737
|
+
* Include Null Dimension
|
|
5738
|
+
*
|
|
5739
|
+
* Include facts where this dimension is NULL (default: false)
|
|
5740
|
+
*/
|
|
5741
|
+
include_null_dimension?: boolean;
|
|
5742
|
+
/**
|
|
5743
|
+
* Selected Members
|
|
5744
|
+
*
|
|
5745
|
+
* Specific members to include (e.g., ['2024-12-31', '2023-12-31'])
|
|
5746
|
+
*/
|
|
5747
|
+
selected_members?: Array<string> | null;
|
|
5748
|
+
/**
|
|
5749
|
+
* Member Order
|
|
5750
|
+
*
|
|
5751
|
+
* Explicit ordering of members (overrides default sort)
|
|
5752
|
+
*/
|
|
5753
|
+
member_order?: Array<string> | null;
|
|
5754
|
+
/**
|
|
5755
|
+
* Member Labels
|
|
5756
|
+
*
|
|
5757
|
+
* Custom labels for members (e.g., {'2024-12-31': 'Current Year'})
|
|
5758
|
+
*/
|
|
5759
|
+
member_labels?: {
|
|
5760
|
+
[key: string]: string;
|
|
5761
|
+
} | null;
|
|
5762
|
+
/**
|
|
5763
|
+
* Element Order
|
|
5764
|
+
*
|
|
5765
|
+
* Element ordering for hierarchy display (e.g., ['us-gaap:Assets', 'us-gaap:Cash', ...])
|
|
5766
|
+
*/
|
|
5767
|
+
element_order?: Array<string> | null;
|
|
5768
|
+
/**
|
|
5769
|
+
* Element Labels
|
|
5770
|
+
*
|
|
5771
|
+
* Custom labels for elements (e.g., {'us-gaap:Cash': 'Cash and Cash Equivalents'})
|
|
5772
|
+
*/
|
|
5773
|
+
element_labels?: {
|
|
5774
|
+
[key: string]: string;
|
|
5775
|
+
} | null;
|
|
5776
|
+
};
|
|
5777
|
+
|
|
5778
|
+
/**
|
|
5779
|
+
* ViewConfig
|
|
5780
|
+
*/
|
|
5781
|
+
export type ViewConfig = {
|
|
5782
|
+
/**
|
|
5783
|
+
* Rows
|
|
5784
|
+
*
|
|
5785
|
+
* Row axis configuration
|
|
5786
|
+
*/
|
|
5787
|
+
rows?: Array<ViewAxisConfig>;
|
|
5788
|
+
/**
|
|
5789
|
+
* Columns
|
|
5790
|
+
*
|
|
5791
|
+
* Column axis configuration
|
|
5792
|
+
*/
|
|
5793
|
+
columns?: Array<ViewAxisConfig>;
|
|
5794
|
+
/**
|
|
5795
|
+
* Values
|
|
5796
|
+
*
|
|
5797
|
+
* Field to use for values (default: numeric_value)
|
|
5798
|
+
*/
|
|
5799
|
+
values?: string;
|
|
5800
|
+
/**
|
|
5801
|
+
* Aggregation Function
|
|
5802
|
+
*
|
|
5803
|
+
* Aggregation function: sum, average, count
|
|
5804
|
+
*/
|
|
5805
|
+
aggregation_function?: string;
|
|
5806
|
+
/**
|
|
5807
|
+
* Fill Value
|
|
5808
|
+
*
|
|
5809
|
+
* Value to use for missing data
|
|
5810
|
+
*/
|
|
5811
|
+
fill_value?: number;
|
|
5812
|
+
};
|
|
5813
|
+
|
|
5699
5814
|
export type RegisterUserData = {
|
|
5700
5815
|
body: RegisterRequest;
|
|
5701
5816
|
path?: never;
|
|
@@ -6672,7 +6787,7 @@ export type ListConnectionsData = {
|
|
|
6672
6787
|
*
|
|
6673
6788
|
* Filter by provider type
|
|
6674
6789
|
*/
|
|
6675
|
-
provider?: 'sec' | 'quickbooks' |
|
|
6790
|
+
provider?: 'sec' | 'quickbooks' | null;
|
|
6676
6791
|
};
|
|
6677
6792
|
url: '/v1/graphs/{graph_id}/connections';
|
|
6678
6793
|
};
|
|
@@ -8813,6 +8928,34 @@ export type QueryTablesResponses = {
|
|
|
8813
8928
|
|
|
8814
8929
|
export type QueryTablesResponse = QueryTablesResponses[keyof QueryTablesResponses];
|
|
8815
8930
|
|
|
8931
|
+
export type CreateViewData = {
|
|
8932
|
+
body: CreateViewRequest;
|
|
8933
|
+
path: {
|
|
8934
|
+
/**
|
|
8935
|
+
* Graph Id
|
|
8936
|
+
*/
|
|
8937
|
+
graph_id: string;
|
|
8938
|
+
};
|
|
8939
|
+
query?: never;
|
|
8940
|
+
url: '/v1/graphs/{graph_id}/views';
|
|
8941
|
+
};
|
|
8942
|
+
|
|
8943
|
+
export type CreateViewErrors = {
|
|
8944
|
+
/**
|
|
8945
|
+
* Validation Error
|
|
8946
|
+
*/
|
|
8947
|
+
422: HttpValidationError;
|
|
8948
|
+
};
|
|
8949
|
+
|
|
8950
|
+
export type CreateViewError = CreateViewErrors[keyof CreateViewErrors];
|
|
8951
|
+
|
|
8952
|
+
export type CreateViewResponses = {
|
|
8953
|
+
/**
|
|
8954
|
+
* Successful Response
|
|
8955
|
+
*/
|
|
8956
|
+
200: unknown;
|
|
8957
|
+
};
|
|
8958
|
+
|
|
8816
8959
|
export type GetMaterializationStatusData = {
|
|
8817
8960
|
body?: never;
|
|
8818
8961
|
path: {
|