@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.ts CHANGED
@@ -1006,7 +1006,7 @@ export type ConnectionProviderInfo = {
1006
1006
  *
1007
1007
  * Provider identifier
1008
1008
  */
1009
- provider: 'sec' | 'quickbooks' | 'plaid';
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: string;
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' | 'plaid';
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: string;
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
- * 10-digit CIK number
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
  /**
@@ -5611,7 +5632,7 @@ export type UpgradeSubscriptionRequest = {
5611
5632
  /**
5612
5633
  * New Plan Name
5613
5634
  *
5614
- * New plan name to upgrade to
5635
+ * New plan name to change to
5615
5636
  */
5616
5637
  new_plan_name: string;
5617
5638
  };
@@ -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' | 'plaid' | null;
6790
+ provider?: 'sec' | 'quickbooks' | null;
6676
6791
  };
6677
6792
  url: '/v1/graphs/{graph_id}/connections';
6678
6793
  };
@@ -8634,13 +8749,13 @@ export type GetGraphSubscriptionResponses = {
8634
8749
 
8635
8750
  export type GetGraphSubscriptionResponse = GetGraphSubscriptionResponses[keyof GetGraphSubscriptionResponses];
8636
8751
 
8637
- export type CreateRepositorySubscriptionData = {
8638
- body: CreateRepositorySubscriptionRequest;
8752
+ export type ChangeRepositoryPlanData = {
8753
+ body: UpgradeSubscriptionRequest;
8639
8754
  path: {
8640
8755
  /**
8641
8756
  * Graph Id
8642
8757
  *
8643
- * Repository name (e.g., 'sec', 'industry')
8758
+ * Repository name (e.g., 'sec')
8644
8759
  */
8645
8760
  graph_id: string;
8646
8761
  };
@@ -8648,67 +8763,71 @@ export type CreateRepositorySubscriptionData = {
8648
8763
  url: '/v1/graphs/{graph_id}/subscriptions';
8649
8764
  };
8650
8765
 
8651
- export type CreateRepositorySubscriptionErrors = {
8766
+ export type ChangeRepositoryPlanErrors = {
8652
8767
  /**
8653
- * Invalid request - cannot create subscription for user graphs
8768
+ * Invalid plan or not a repository subscription
8654
8769
  */
8655
8770
  400: unknown;
8656
8771
  /**
8657
- * User already has a subscription to this repository
8772
+ * No subscription found
8658
8773
  */
8659
- 409: unknown;
8774
+ 404: unknown;
8660
8775
  /**
8661
8776
  * Validation Error
8662
8777
  */
8663
8778
  422: HttpValidationError;
8664
8779
  };
8665
8780
 
8666
- export type CreateRepositorySubscriptionError = CreateRepositorySubscriptionErrors[keyof CreateRepositorySubscriptionErrors];
8781
+ export type ChangeRepositoryPlanError = ChangeRepositoryPlanErrors[keyof ChangeRepositoryPlanErrors];
8667
8782
 
8668
- export type CreateRepositorySubscriptionResponses = {
8783
+ export type ChangeRepositoryPlanResponses = {
8669
8784
  /**
8670
- * Repository subscription created successfully
8785
+ * Plan changed successfully
8671
8786
  */
8672
- 201: GraphSubscriptionResponse;
8787
+ 200: GraphSubscriptionResponse;
8673
8788
  };
8674
8789
 
8675
- export type CreateRepositorySubscriptionResponse = CreateRepositorySubscriptionResponses[keyof CreateRepositorySubscriptionResponses];
8790
+ export type ChangeRepositoryPlanResponse = ChangeRepositoryPlanResponses[keyof ChangeRepositoryPlanResponses];
8676
8791
 
8677
- export type UpgradeSubscriptionData = {
8678
- body: UpgradeSubscriptionRequest;
8792
+ export type CreateRepositorySubscriptionData = {
8793
+ body: CreateRepositorySubscriptionRequest;
8679
8794
  path: {
8680
8795
  /**
8681
8796
  * Graph Id
8682
8797
  *
8683
- * Graph ID or repository name
8798
+ * Repository name (e.g., 'sec', 'industry')
8684
8799
  */
8685
8800
  graph_id: string;
8686
8801
  };
8687
8802
  query?: never;
8688
- url: '/v1/graphs/{graph_id}/subscriptions/upgrade';
8803
+ url: '/v1/graphs/{graph_id}/subscriptions';
8689
8804
  };
8690
8805
 
8691
- export type UpgradeSubscriptionErrors = {
8806
+ export type CreateRepositorySubscriptionErrors = {
8692
8807
  /**
8693
- * No subscription found
8808
+ * Invalid request - cannot create subscription for user graphs
8694
8809
  */
8695
- 404: unknown;
8810
+ 400: unknown;
8811
+ /**
8812
+ * User already has a subscription to this repository
8813
+ */
8814
+ 409: unknown;
8696
8815
  /**
8697
8816
  * Validation Error
8698
8817
  */
8699
8818
  422: HttpValidationError;
8700
8819
  };
8701
8820
 
8702
- export type UpgradeSubscriptionError = UpgradeSubscriptionErrors[keyof UpgradeSubscriptionErrors];
8821
+ export type CreateRepositorySubscriptionError = CreateRepositorySubscriptionErrors[keyof CreateRepositorySubscriptionErrors];
8703
8822
 
8704
- export type UpgradeSubscriptionResponses = {
8823
+ export type CreateRepositorySubscriptionResponses = {
8705
8824
  /**
8706
- * Subscription upgraded successfully
8825
+ * Repository subscription created successfully
8707
8826
  */
8708
- 200: GraphSubscriptionResponse;
8827
+ 201: GraphSubscriptionResponse;
8709
8828
  };
8710
8829
 
8711
- export type UpgradeSubscriptionResponse = UpgradeSubscriptionResponses[keyof UpgradeSubscriptionResponses];
8830
+ export type CreateRepositorySubscriptionResponse = CreateRepositorySubscriptionResponses[keyof CreateRepositorySubscriptionResponses];
8712
8831
 
8713
8832
  export type ListTablesData = {
8714
8833
  body?: never;
@@ -8813,6 +8932,34 @@ export type QueryTablesResponses = {
8813
8932
 
8814
8933
  export type QueryTablesResponse = QueryTablesResponses[keyof QueryTablesResponses];
8815
8934
 
8935
+ export type CreateViewData = {
8936
+ body: CreateViewRequest;
8937
+ path: {
8938
+ /**
8939
+ * Graph Id
8940
+ */
8941
+ graph_id: string;
8942
+ };
8943
+ query?: never;
8944
+ url: '/v1/graphs/{graph_id}/views';
8945
+ };
8946
+
8947
+ export type CreateViewErrors = {
8948
+ /**
8949
+ * Validation Error
8950
+ */
8951
+ 422: HttpValidationError;
8952
+ };
8953
+
8954
+ export type CreateViewError = CreateViewErrors[keyof CreateViewErrors];
8955
+
8956
+ export type CreateViewResponses = {
8957
+ /**
8958
+ * Successful Response
8959
+ */
8960
+ 200: unknown;
8961
+ };
8962
+
8816
8963
  export type GetMaterializationStatusData = {
8817
8964
  body?: never;
8818
8965
  path: {