@robosystems/client 0.2.39 → 0.2.40

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
@@ -1576,6 +1576,54 @@ export type CreateGraphRequest = {
1576
1576
  tags?: Array<string>;
1577
1577
  };
1578
1578
 
1579
+ /**
1580
+ * CreateReportRequest
1581
+ */
1582
+ export type CreateReportRequest = {
1583
+ /**
1584
+ * Name
1585
+ *
1586
+ * Report name
1587
+ */
1588
+ name: string;
1589
+ /**
1590
+ * Taxonomy Id
1591
+ *
1592
+ * Taxonomy ID — determines which structures are available
1593
+ */
1594
+ taxonomy_id?: string;
1595
+ /**
1596
+ * Mapping Id
1597
+ *
1598
+ * Mapping structure ID for CoA→GAAP rollup
1599
+ */
1600
+ mapping_id: string;
1601
+ /**
1602
+ * Period Start
1603
+ *
1604
+ * Period start date (inclusive)
1605
+ */
1606
+ period_start: string;
1607
+ /**
1608
+ * Period End
1609
+ *
1610
+ * Period end date (inclusive)
1611
+ */
1612
+ period_end: string;
1613
+ /**
1614
+ * Period Type
1615
+ *
1616
+ * Period type: monthly, quarterly, annual
1617
+ */
1618
+ period_type?: string;
1619
+ /**
1620
+ * Comparative
1621
+ *
1622
+ * Include prior period comparison
1623
+ */
1624
+ comparative?: boolean;
1625
+ };
1626
+
1579
1627
  /**
1580
1628
  * CreateRepositorySubscriptionRequest
1581
1629
  *
@@ -2784,6 +2832,44 @@ export type ErrorResponse = {
2784
2832
  timestamp?: string | null;
2785
2833
  };
2786
2834
 
2835
+ /**
2836
+ * FactRowResponse
2837
+ */
2838
+ export type FactRowResponse = {
2839
+ /**
2840
+ * Element Id
2841
+ */
2842
+ element_id: string;
2843
+ /**
2844
+ * Element Qname
2845
+ */
2846
+ element_qname: string;
2847
+ /**
2848
+ * Element Name
2849
+ */
2850
+ element_name: string;
2851
+ /**
2852
+ * Classification
2853
+ */
2854
+ classification: string;
2855
+ /**
2856
+ * Current Value
2857
+ */
2858
+ current_value: number;
2859
+ /**
2860
+ * Prior Value
2861
+ */
2862
+ prior_value?: number | null;
2863
+ /**
2864
+ * Is Subtotal
2865
+ */
2866
+ is_subtotal?: boolean;
2867
+ /**
2868
+ * Depth
2869
+ */
2870
+ depth?: number;
2871
+ };
2872
+
2787
2873
  /**
2788
2874
  * FileInfo
2789
2875
  */
@@ -5548,6 +5634,24 @@ export type RateLimits = {
5548
5634
  burst_capacity: number;
5549
5635
  };
5550
5636
 
5637
+ /**
5638
+ * RegenerateReportRequest
5639
+ */
5640
+ export type RegenerateReportRequest = {
5641
+ /**
5642
+ * Period Start
5643
+ *
5644
+ * New period start date
5645
+ */
5646
+ period_start: string;
5647
+ /**
5648
+ * Period End
5649
+ *
5650
+ * New period end date
5651
+ */
5652
+ period_end: string;
5653
+ };
5654
+
5551
5655
  /**
5552
5656
  * RegisterRequest
5553
5657
  *
@@ -5580,6 +5684,88 @@ export type RegisterRequest = {
5580
5684
  captcha_token?: string | null;
5581
5685
  };
5582
5686
 
5687
+ /**
5688
+ * ReportListResponse
5689
+ */
5690
+ export type ReportListResponse = {
5691
+ /**
5692
+ * Reports
5693
+ */
5694
+ reports: Array<ReportResponse>;
5695
+ };
5696
+
5697
+ /**
5698
+ * ReportResponse
5699
+ *
5700
+ * Report definition summary.
5701
+ */
5702
+ export type ReportResponse = {
5703
+ /**
5704
+ * Id
5705
+ */
5706
+ id: string;
5707
+ /**
5708
+ * Name
5709
+ */
5710
+ name: string;
5711
+ /**
5712
+ * Taxonomy Id
5713
+ */
5714
+ taxonomy_id: string;
5715
+ /**
5716
+ * Generation Status
5717
+ */
5718
+ generation_status: string;
5719
+ /**
5720
+ * Period Type
5721
+ */
5722
+ period_type: string;
5723
+ /**
5724
+ * Period Start
5725
+ */
5726
+ period_start?: string | null;
5727
+ /**
5728
+ * Period End
5729
+ */
5730
+ period_end?: string | null;
5731
+ /**
5732
+ * Comparative
5733
+ */
5734
+ comparative: boolean;
5735
+ /**
5736
+ * Mapping Id
5737
+ */
5738
+ mapping_id?: string | null;
5739
+ /**
5740
+ * Ai Generated
5741
+ */
5742
+ ai_generated?: boolean;
5743
+ /**
5744
+ * Created At
5745
+ */
5746
+ created_at: string;
5747
+ /**
5748
+ * Last Generated
5749
+ */
5750
+ last_generated?: string | null;
5751
+ /**
5752
+ * Structures
5753
+ */
5754
+ structures?: Array<StructureSummary>;
5755
+ /**
5756
+ * Source Graph Id
5757
+ */
5758
+ source_graph_id?: string | null;
5759
+ /**
5760
+ * Source Report Id
5761
+ */
5762
+ source_report_id?: string | null;
5763
+ /**
5764
+ * Shared At
5765
+ */
5766
+ shared_at?: string | null;
5767
+ };
5768
+
5583
5769
  /**
5584
5770
  * RepositoryInfo
5585
5771
  *
@@ -6231,6 +6417,103 @@ export type ServiceOfferingsResponse = {
6231
6417
  summary: ServiceOfferingSummary;
6232
6418
  };
6233
6419
 
6420
+ /**
6421
+ * ShareReportRequest
6422
+ */
6423
+ export type ShareReportRequest = {
6424
+ /**
6425
+ * Target Graph Ids
6426
+ *
6427
+ * Graph IDs to share the report to
6428
+ */
6429
+ target_graph_ids: Array<string>;
6430
+ };
6431
+
6432
+ /**
6433
+ * ShareReportResponse
6434
+ */
6435
+ export type ShareReportResponse = {
6436
+ /**
6437
+ * Report Id
6438
+ */
6439
+ report_id: string;
6440
+ /**
6441
+ * Results
6442
+ */
6443
+ results: Array<ShareResultItem>;
6444
+ };
6445
+
6446
+ /**
6447
+ * ShareResultItem
6448
+ */
6449
+ export type ShareResultItem = {
6450
+ /**
6451
+ * Target Graph Id
6452
+ */
6453
+ target_graph_id: string;
6454
+ /**
6455
+ * Status
6456
+ */
6457
+ status: string;
6458
+ /**
6459
+ * Error
6460
+ */
6461
+ error?: string | null;
6462
+ /**
6463
+ * Fact Count
6464
+ */
6465
+ fact_count?: number;
6466
+ };
6467
+
6468
+ /**
6469
+ * StatementResponse
6470
+ *
6471
+ * Rendered financial statement — facts viewed through a structure.
6472
+ */
6473
+ export type StatementResponse = {
6474
+ /**
6475
+ * Report Id
6476
+ */
6477
+ report_id: string;
6478
+ /**
6479
+ * Structure Id
6480
+ */
6481
+ structure_id: string;
6482
+ /**
6483
+ * Structure Name
6484
+ */
6485
+ structure_name: string;
6486
+ /**
6487
+ * Structure Type
6488
+ */
6489
+ structure_type: string;
6490
+ /**
6491
+ * Period Start
6492
+ */
6493
+ period_start: string;
6494
+ /**
6495
+ * Period End
6496
+ */
6497
+ period_end: string;
6498
+ /**
6499
+ * Comparative Period Start
6500
+ */
6501
+ comparative_period_start?: string | null;
6502
+ /**
6503
+ * Comparative Period End
6504
+ */
6505
+ comparative_period_end?: string | null;
6506
+ /**
6507
+ * Rows
6508
+ */
6509
+ rows?: Array<FactRowResponse>;
6510
+ validation?: ValidationCheckResponse | null;
6511
+ /**
6512
+ * Unmapped Count
6513
+ */
6514
+ unmapped_count?: number;
6515
+ };
6516
+
6234
6517
  /**
6235
6518
  * StorageLimitResponse
6236
6519
  *
@@ -6385,6 +6668,26 @@ export type StructureResponse = {
6385
6668
  is_active: boolean;
6386
6669
  };
6387
6670
 
6671
+ /**
6672
+ * StructureSummary
6673
+ *
6674
+ * A structure available within this report's taxonomy.
6675
+ */
6676
+ export type StructureSummary = {
6677
+ /**
6678
+ * Id
6679
+ */
6680
+ id: string;
6681
+ /**
6682
+ * Name
6683
+ */
6684
+ name: string;
6685
+ /**
6686
+ * Structure Type
6687
+ */
6688
+ structure_type: string;
6689
+ };
6690
+
6388
6691
  /**
6389
6692
  * SubgraphQuotaResponse
6390
6693
  *
@@ -7310,6 +7613,28 @@ export type UserResponse = {
7310
7613
  accounts?: Array<AccountInfo>;
7311
7614
  };
7312
7615
 
7616
+ /**
7617
+ * ValidationCheckResponse
7618
+ */
7619
+ export type ValidationCheckResponse = {
7620
+ /**
7621
+ * Passed
7622
+ */
7623
+ passed: boolean;
7624
+ /**
7625
+ * Checks
7626
+ */
7627
+ checks: Array<string>;
7628
+ /**
7629
+ * Failures
7630
+ */
7631
+ failures: Array<string>;
7632
+ /**
7633
+ * Warnings
7634
+ */
7635
+ warnings: Array<string>;
7636
+ };
7637
+
7313
7638
  /**
7314
7639
  * ValidationError
7315
7640
  */
@@ -12601,3 +12926,249 @@ export type GetLedgerSummaryResponses = {
12601
12926
  };
12602
12927
 
12603
12928
  export type GetLedgerSummaryResponse = GetLedgerSummaryResponses[keyof GetLedgerSummaryResponses];
12929
+
12930
+ export type ListReportsData = {
12931
+ body?: never;
12932
+ path: {
12933
+ /**
12934
+ * Graph Id
12935
+ */
12936
+ graph_id: string;
12937
+ };
12938
+ query?: never;
12939
+ url: '/v1/ledger/{graph_id}/reports';
12940
+ };
12941
+
12942
+ export type ListReportsErrors = {
12943
+ /**
12944
+ * Validation Error
12945
+ */
12946
+ 422: HttpValidationError;
12947
+ };
12948
+
12949
+ export type ListReportsError = ListReportsErrors[keyof ListReportsErrors];
12950
+
12951
+ export type ListReportsResponses = {
12952
+ /**
12953
+ * Successful Response
12954
+ */
12955
+ 200: ReportListResponse;
12956
+ };
12957
+
12958
+ export type ListReportsResponse = ListReportsResponses[keyof ListReportsResponses];
12959
+
12960
+ export type CreateReportData = {
12961
+ body: CreateReportRequest;
12962
+ path: {
12963
+ /**
12964
+ * Graph Id
12965
+ */
12966
+ graph_id: string;
12967
+ };
12968
+ query?: never;
12969
+ url: '/v1/ledger/{graph_id}/reports';
12970
+ };
12971
+
12972
+ export type CreateReportErrors = {
12973
+ /**
12974
+ * Validation Error
12975
+ */
12976
+ 422: HttpValidationError;
12977
+ };
12978
+
12979
+ export type CreateReportError = CreateReportErrors[keyof CreateReportErrors];
12980
+
12981
+ export type CreateReportResponses = {
12982
+ /**
12983
+ * Successful Response
12984
+ */
12985
+ 201: ReportResponse;
12986
+ };
12987
+
12988
+ export type CreateReportResponse = CreateReportResponses[keyof CreateReportResponses];
12989
+
12990
+ export type DeleteReportData = {
12991
+ body?: never;
12992
+ path: {
12993
+ /**
12994
+ * Graph Id
12995
+ */
12996
+ graph_id: string;
12997
+ /**
12998
+ * Report Id
12999
+ *
13000
+ * Report definition ID
13001
+ */
13002
+ report_id: string;
13003
+ };
13004
+ query?: never;
13005
+ url: '/v1/ledger/{graph_id}/reports/{report_id}';
13006
+ };
13007
+
13008
+ export type DeleteReportErrors = {
13009
+ /**
13010
+ * Validation Error
13011
+ */
13012
+ 422: HttpValidationError;
13013
+ };
13014
+
13015
+ export type DeleteReportError = DeleteReportErrors[keyof DeleteReportErrors];
13016
+
13017
+ export type DeleteReportResponses = {
13018
+ /**
13019
+ * Successful Response
13020
+ */
13021
+ 204: void;
13022
+ };
13023
+
13024
+ export type DeleteReportResponse = DeleteReportResponses[keyof DeleteReportResponses];
13025
+
13026
+ export type GetReportData = {
13027
+ body?: never;
13028
+ path: {
13029
+ /**
13030
+ * Graph Id
13031
+ */
13032
+ graph_id: string;
13033
+ /**
13034
+ * Report Id
13035
+ *
13036
+ * Report definition ID
13037
+ */
13038
+ report_id: string;
13039
+ };
13040
+ query?: never;
13041
+ url: '/v1/ledger/{graph_id}/reports/{report_id}';
13042
+ };
13043
+
13044
+ export type GetReportErrors = {
13045
+ /**
13046
+ * Validation Error
13047
+ */
13048
+ 422: HttpValidationError;
13049
+ };
13050
+
13051
+ export type GetReportError = GetReportErrors[keyof GetReportErrors];
13052
+
13053
+ export type GetReportResponses = {
13054
+ /**
13055
+ * Successful Response
13056
+ */
13057
+ 200: ReportResponse;
13058
+ };
13059
+
13060
+ export type GetReportResponse = GetReportResponses[keyof GetReportResponses];
13061
+
13062
+ export type GetStatementData = {
13063
+ body?: never;
13064
+ path: {
13065
+ /**
13066
+ * Graph Id
13067
+ */
13068
+ graph_id: string;
13069
+ /**
13070
+ * Report Id
13071
+ *
13072
+ * Report definition ID
13073
+ */
13074
+ report_id: string;
13075
+ /**
13076
+ * Structure Type
13077
+ *
13078
+ * Structure type: income_statement, balance_sheet, cash_flow_statement
13079
+ */
13080
+ structure_type: string;
13081
+ };
13082
+ query?: never;
13083
+ url: '/v1/ledger/{graph_id}/reports/{report_id}/statements/{structure_type}';
13084
+ };
13085
+
13086
+ export type GetStatementErrors = {
13087
+ /**
13088
+ * Validation Error
13089
+ */
13090
+ 422: HttpValidationError;
13091
+ };
13092
+
13093
+ export type GetStatementError = GetStatementErrors[keyof GetStatementErrors];
13094
+
13095
+ export type GetStatementResponses = {
13096
+ /**
13097
+ * Successful Response
13098
+ */
13099
+ 200: StatementResponse;
13100
+ };
13101
+
13102
+ export type GetStatementResponse = GetStatementResponses[keyof GetStatementResponses];
13103
+
13104
+ export type RegenerateReportData = {
13105
+ body: RegenerateReportRequest;
13106
+ path: {
13107
+ /**
13108
+ * Graph Id
13109
+ */
13110
+ graph_id: string;
13111
+ /**
13112
+ * Report Id
13113
+ *
13114
+ * Report definition ID
13115
+ */
13116
+ report_id: string;
13117
+ };
13118
+ query?: never;
13119
+ url: '/v1/ledger/{graph_id}/reports/{report_id}/regenerate';
13120
+ };
13121
+
13122
+ export type RegenerateReportErrors = {
13123
+ /**
13124
+ * Validation Error
13125
+ */
13126
+ 422: HttpValidationError;
13127
+ };
13128
+
13129
+ export type RegenerateReportError = RegenerateReportErrors[keyof RegenerateReportErrors];
13130
+
13131
+ export type RegenerateReportResponses = {
13132
+ /**
13133
+ * Successful Response
13134
+ */
13135
+ 200: ReportResponse;
13136
+ };
13137
+
13138
+ export type RegenerateReportResponse = RegenerateReportResponses[keyof RegenerateReportResponses];
13139
+
13140
+ export type ShareReportData = {
13141
+ body: ShareReportRequest;
13142
+ path: {
13143
+ /**
13144
+ * Graph Id
13145
+ */
13146
+ graph_id: string;
13147
+ /**
13148
+ * Report Id
13149
+ *
13150
+ * Report definition ID
13151
+ */
13152
+ report_id: string;
13153
+ };
13154
+ query?: never;
13155
+ url: '/v1/ledger/{graph_id}/reports/{report_id}/share';
13156
+ };
13157
+
13158
+ export type ShareReportErrors = {
13159
+ /**
13160
+ * Validation Error
13161
+ */
13162
+ 422: HttpValidationError;
13163
+ };
13164
+
13165
+ export type ShareReportError = ShareReportErrors[keyof ShareReportErrors];
13166
+
13167
+ export type ShareReportResponses = {
13168
+ /**
13169
+ * Successful Response
13170
+ */
13171
+ 200: ShareReportResponse;
13172
+ };
13173
+
13174
+ export type ShareReportResponse2 = ShareReportResponses[keyof ShareReportResponses];