@robosystems/client 0.2.32 → 0.2.34

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/types.gen.d.ts CHANGED
@@ -974,7 +974,7 @@ export type ConnectionProviderInfo = {
974
974
  *
975
975
  * Provider identifier
976
976
  */
977
- provider: 'sec' | 'quickbooks' | 'plaid';
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: string;
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' | 'plaid';
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: string;
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
- * 10-digit CIK number
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
@@ -5451,7 +5472,7 @@ export type UpgradeSubscriptionRequest = {
5451
5472
  /**
5452
5473
  * New Plan Name
5453
5474
  *
5454
- * New plan name to upgrade to
5475
+ * New plan name to change to
5455
5476
  */
5456
5477
  new_plan_name: string;
5457
5478
  };
@@ -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' | 'plaid' | null;
6469
+ provider?: 'sec' | 'quickbooks' | null;
6357
6470
  };
6358
6471
  url: '/v1/graphs/{graph_id}/connections';
6359
6472
  };
@@ -8114,72 +8227,76 @@ export type GetGraphSubscriptionResponses = {
8114
8227
  200: GraphSubscriptionResponse;
8115
8228
  };
8116
8229
  export type GetGraphSubscriptionResponse = GetGraphSubscriptionResponses[keyof GetGraphSubscriptionResponses];
8117
- export type CreateRepositorySubscriptionData = {
8118
- body: CreateRepositorySubscriptionRequest;
8230
+ export type ChangeRepositoryPlanData = {
8231
+ body: UpgradeSubscriptionRequest;
8119
8232
  path: {
8120
8233
  /**
8121
8234
  * Graph Id
8122
8235
  *
8123
- * Repository name (e.g., 'sec', 'industry')
8236
+ * Repository name (e.g., 'sec')
8124
8237
  */
8125
8238
  graph_id: string;
8126
8239
  };
8127
8240
  query?: never;
8128
8241
  url: '/v1/graphs/{graph_id}/subscriptions';
8129
8242
  };
8130
- export type CreateRepositorySubscriptionErrors = {
8243
+ export type ChangeRepositoryPlanErrors = {
8131
8244
  /**
8132
- * Invalid request - cannot create subscription for user graphs
8245
+ * Invalid plan or not a repository subscription
8133
8246
  */
8134
8247
  400: unknown;
8135
8248
  /**
8136
- * User already has a subscription to this repository
8249
+ * No subscription found
8137
8250
  */
8138
- 409: unknown;
8251
+ 404: unknown;
8139
8252
  /**
8140
8253
  * Validation Error
8141
8254
  */
8142
8255
  422: HttpValidationError;
8143
8256
  };
8144
- export type CreateRepositorySubscriptionError = CreateRepositorySubscriptionErrors[keyof CreateRepositorySubscriptionErrors];
8145
- export type CreateRepositorySubscriptionResponses = {
8257
+ export type ChangeRepositoryPlanError = ChangeRepositoryPlanErrors[keyof ChangeRepositoryPlanErrors];
8258
+ export type ChangeRepositoryPlanResponses = {
8146
8259
  /**
8147
- * Repository subscription created successfully
8260
+ * Plan changed successfully
8148
8261
  */
8149
- 201: GraphSubscriptionResponse;
8262
+ 200: GraphSubscriptionResponse;
8150
8263
  };
8151
- export type CreateRepositorySubscriptionResponse = CreateRepositorySubscriptionResponses[keyof CreateRepositorySubscriptionResponses];
8152
- export type UpgradeSubscriptionData = {
8153
- body: UpgradeSubscriptionRequest;
8264
+ export type ChangeRepositoryPlanResponse = ChangeRepositoryPlanResponses[keyof ChangeRepositoryPlanResponses];
8265
+ export type CreateRepositorySubscriptionData = {
8266
+ body: CreateRepositorySubscriptionRequest;
8154
8267
  path: {
8155
8268
  /**
8156
8269
  * Graph Id
8157
8270
  *
8158
- * Graph ID or repository name
8271
+ * Repository name (e.g., 'sec', 'industry')
8159
8272
  */
8160
8273
  graph_id: string;
8161
8274
  };
8162
8275
  query?: never;
8163
- url: '/v1/graphs/{graph_id}/subscriptions/upgrade';
8276
+ url: '/v1/graphs/{graph_id}/subscriptions';
8164
8277
  };
8165
- export type UpgradeSubscriptionErrors = {
8278
+ export type CreateRepositorySubscriptionErrors = {
8166
8279
  /**
8167
- * No subscription found
8280
+ * Invalid request - cannot create subscription for user graphs
8168
8281
  */
8169
- 404: unknown;
8282
+ 400: unknown;
8283
+ /**
8284
+ * User already has a subscription to this repository
8285
+ */
8286
+ 409: unknown;
8170
8287
  /**
8171
8288
  * Validation Error
8172
8289
  */
8173
8290
  422: HttpValidationError;
8174
8291
  };
8175
- export type UpgradeSubscriptionError = UpgradeSubscriptionErrors[keyof UpgradeSubscriptionErrors];
8176
- export type UpgradeSubscriptionResponses = {
8292
+ export type CreateRepositorySubscriptionError = CreateRepositorySubscriptionErrors[keyof CreateRepositorySubscriptionErrors];
8293
+ export type CreateRepositorySubscriptionResponses = {
8177
8294
  /**
8178
- * Subscription upgraded successfully
8295
+ * Repository subscription created successfully
8179
8296
  */
8180
- 200: GraphSubscriptionResponse;
8297
+ 201: GraphSubscriptionResponse;
8181
8298
  };
8182
- export type UpgradeSubscriptionResponse = UpgradeSubscriptionResponses[keyof UpgradeSubscriptionResponses];
8299
+ export type CreateRepositorySubscriptionResponse = CreateRepositorySubscriptionResponses[keyof CreateRepositorySubscriptionResponses];
8183
8300
  export type ListTablesData = {
8184
8301
  body?: never;
8185
8302
  path: {
@@ -8273,6 +8390,30 @@ export type QueryTablesResponses = {
8273
8390
  200: TableQueryResponse;
8274
8391
  };
8275
8392
  export type QueryTablesResponse = QueryTablesResponses[keyof QueryTablesResponses];
8393
+ export type CreateViewData = {
8394
+ body: CreateViewRequest;
8395
+ path: {
8396
+ /**
8397
+ * Graph Id
8398
+ */
8399
+ graph_id: string;
8400
+ };
8401
+ query?: never;
8402
+ url: '/v1/graphs/{graph_id}/views';
8403
+ };
8404
+ export type CreateViewErrors = {
8405
+ /**
8406
+ * Validation Error
8407
+ */
8408
+ 422: HttpValidationError;
8409
+ };
8410
+ export type CreateViewError = CreateViewErrors[keyof CreateViewErrors];
8411
+ export type CreateViewResponses = {
8412
+ /**
8413
+ * Successful Response
8414
+ */
8415
+ 200: unknown;
8416
+ };
8276
8417
  export type GetMaterializationStatusData = {
8277
8418
  body?: never;
8278
8419
  path: {