@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.d.ts CHANGED
@@ -1528,6 +1528,53 @@ export type CreateGraphRequest = {
1528
1528
  */
1529
1529
  tags?: Array<string>;
1530
1530
  };
1531
+ /**
1532
+ * CreateReportRequest
1533
+ */
1534
+ export type CreateReportRequest = {
1535
+ /**
1536
+ * Name
1537
+ *
1538
+ * Report name
1539
+ */
1540
+ name: string;
1541
+ /**
1542
+ * Taxonomy Id
1543
+ *
1544
+ * Taxonomy ID — determines which structures are available
1545
+ */
1546
+ taxonomy_id?: string;
1547
+ /**
1548
+ * Mapping Id
1549
+ *
1550
+ * Mapping structure ID for CoA→GAAP rollup
1551
+ */
1552
+ mapping_id: string;
1553
+ /**
1554
+ * Period Start
1555
+ *
1556
+ * Period start date (inclusive)
1557
+ */
1558
+ period_start: string;
1559
+ /**
1560
+ * Period End
1561
+ *
1562
+ * Period end date (inclusive)
1563
+ */
1564
+ period_end: string;
1565
+ /**
1566
+ * Period Type
1567
+ *
1568
+ * Period type: monthly, quarterly, annual
1569
+ */
1570
+ period_type?: string;
1571
+ /**
1572
+ * Comparative
1573
+ *
1574
+ * Include prior period comparison
1575
+ */
1576
+ comparative?: boolean;
1577
+ };
1531
1578
  /**
1532
1579
  * CreateRepositorySubscriptionRequest
1533
1580
  *
@@ -2707,6 +2754,43 @@ export type ErrorResponse = {
2707
2754
  */
2708
2755
  timestamp?: string | null;
2709
2756
  };
2757
+ /**
2758
+ * FactRowResponse
2759
+ */
2760
+ export type FactRowResponse = {
2761
+ /**
2762
+ * Element Id
2763
+ */
2764
+ element_id: string;
2765
+ /**
2766
+ * Element Qname
2767
+ */
2768
+ element_qname: string;
2769
+ /**
2770
+ * Element Name
2771
+ */
2772
+ element_name: string;
2773
+ /**
2774
+ * Classification
2775
+ */
2776
+ classification: string;
2777
+ /**
2778
+ * Current Value
2779
+ */
2780
+ current_value: number;
2781
+ /**
2782
+ * Prior Value
2783
+ */
2784
+ prior_value?: number | null;
2785
+ /**
2786
+ * Is Subtotal
2787
+ */
2788
+ is_subtotal?: boolean;
2789
+ /**
2790
+ * Depth
2791
+ */
2792
+ depth?: number;
2793
+ };
2710
2794
  /**
2711
2795
  * FileInfo
2712
2796
  */
@@ -5401,6 +5485,23 @@ export type RateLimits = {
5401
5485
  */
5402
5486
  burst_capacity: number;
5403
5487
  };
5488
+ /**
5489
+ * RegenerateReportRequest
5490
+ */
5491
+ export type RegenerateReportRequest = {
5492
+ /**
5493
+ * Period Start
5494
+ *
5495
+ * New period start date
5496
+ */
5497
+ period_start: string;
5498
+ /**
5499
+ * Period End
5500
+ *
5501
+ * New period end date
5502
+ */
5503
+ period_end: string;
5504
+ };
5404
5505
  /**
5405
5506
  * RegisterRequest
5406
5507
  *
@@ -5432,6 +5533,86 @@ export type RegisterRequest = {
5432
5533
  */
5433
5534
  captcha_token?: string | null;
5434
5535
  };
5536
+ /**
5537
+ * ReportListResponse
5538
+ */
5539
+ export type ReportListResponse = {
5540
+ /**
5541
+ * Reports
5542
+ */
5543
+ reports: Array<ReportResponse>;
5544
+ };
5545
+ /**
5546
+ * ReportResponse
5547
+ *
5548
+ * Report definition summary.
5549
+ */
5550
+ export type ReportResponse = {
5551
+ /**
5552
+ * Id
5553
+ */
5554
+ id: string;
5555
+ /**
5556
+ * Name
5557
+ */
5558
+ name: string;
5559
+ /**
5560
+ * Taxonomy Id
5561
+ */
5562
+ taxonomy_id: string;
5563
+ /**
5564
+ * Generation Status
5565
+ */
5566
+ generation_status: string;
5567
+ /**
5568
+ * Period Type
5569
+ */
5570
+ period_type: string;
5571
+ /**
5572
+ * Period Start
5573
+ */
5574
+ period_start?: string | null;
5575
+ /**
5576
+ * Period End
5577
+ */
5578
+ period_end?: string | null;
5579
+ /**
5580
+ * Comparative
5581
+ */
5582
+ comparative: boolean;
5583
+ /**
5584
+ * Mapping Id
5585
+ */
5586
+ mapping_id?: string | null;
5587
+ /**
5588
+ * Ai Generated
5589
+ */
5590
+ ai_generated?: boolean;
5591
+ /**
5592
+ * Created At
5593
+ */
5594
+ created_at: string;
5595
+ /**
5596
+ * Last Generated
5597
+ */
5598
+ last_generated?: string | null;
5599
+ /**
5600
+ * Structures
5601
+ */
5602
+ structures?: Array<StructureSummary>;
5603
+ /**
5604
+ * Source Graph Id
5605
+ */
5606
+ source_graph_id?: string | null;
5607
+ /**
5608
+ * Source Report Id
5609
+ */
5610
+ source_report_id?: string | null;
5611
+ /**
5612
+ * Shared At
5613
+ */
5614
+ shared_at?: string | null;
5615
+ };
5435
5616
  /**
5436
5617
  * RepositoryInfo
5437
5618
  *
@@ -6063,6 +6244,99 @@ export type ServiceOfferingsResponse = {
6063
6244
  */
6064
6245
  summary: ServiceOfferingSummary;
6065
6246
  };
6247
+ /**
6248
+ * ShareReportRequest
6249
+ */
6250
+ export type ShareReportRequest = {
6251
+ /**
6252
+ * Target Graph Ids
6253
+ *
6254
+ * Graph IDs to share the report to
6255
+ */
6256
+ target_graph_ids: Array<string>;
6257
+ };
6258
+ /**
6259
+ * ShareReportResponse
6260
+ */
6261
+ export type ShareReportResponse = {
6262
+ /**
6263
+ * Report Id
6264
+ */
6265
+ report_id: string;
6266
+ /**
6267
+ * Results
6268
+ */
6269
+ results: Array<ShareResultItem>;
6270
+ };
6271
+ /**
6272
+ * ShareResultItem
6273
+ */
6274
+ export type ShareResultItem = {
6275
+ /**
6276
+ * Target Graph Id
6277
+ */
6278
+ target_graph_id: string;
6279
+ /**
6280
+ * Status
6281
+ */
6282
+ status: string;
6283
+ /**
6284
+ * Error
6285
+ */
6286
+ error?: string | null;
6287
+ /**
6288
+ * Fact Count
6289
+ */
6290
+ fact_count?: number;
6291
+ };
6292
+ /**
6293
+ * StatementResponse
6294
+ *
6295
+ * Rendered financial statement — facts viewed through a structure.
6296
+ */
6297
+ export type StatementResponse = {
6298
+ /**
6299
+ * Report Id
6300
+ */
6301
+ report_id: string;
6302
+ /**
6303
+ * Structure Id
6304
+ */
6305
+ structure_id: string;
6306
+ /**
6307
+ * Structure Name
6308
+ */
6309
+ structure_name: string;
6310
+ /**
6311
+ * Structure Type
6312
+ */
6313
+ structure_type: string;
6314
+ /**
6315
+ * Period Start
6316
+ */
6317
+ period_start: string;
6318
+ /**
6319
+ * Period End
6320
+ */
6321
+ period_end: string;
6322
+ /**
6323
+ * Comparative Period Start
6324
+ */
6325
+ comparative_period_start?: string | null;
6326
+ /**
6327
+ * Comparative Period End
6328
+ */
6329
+ comparative_period_end?: string | null;
6330
+ /**
6331
+ * Rows
6332
+ */
6333
+ rows?: Array<FactRowResponse>;
6334
+ validation?: ValidationCheckResponse | null;
6335
+ /**
6336
+ * Unmapped Count
6337
+ */
6338
+ unmapped_count?: number;
6339
+ };
6066
6340
  /**
6067
6341
  * StorageLimitResponse
6068
6342
  *
@@ -6212,6 +6486,25 @@ export type StructureResponse = {
6212
6486
  */
6213
6487
  is_active: boolean;
6214
6488
  };
6489
+ /**
6490
+ * StructureSummary
6491
+ *
6492
+ * A structure available within this report's taxonomy.
6493
+ */
6494
+ export type StructureSummary = {
6495
+ /**
6496
+ * Id
6497
+ */
6498
+ id: string;
6499
+ /**
6500
+ * Name
6501
+ */
6502
+ name: string;
6503
+ /**
6504
+ * Structure Type
6505
+ */
6506
+ structure_type: string;
6507
+ };
6215
6508
  /**
6216
6509
  * SubgraphQuotaResponse
6217
6510
  *
@@ -7108,6 +7401,27 @@ export type UserResponse = {
7108
7401
  */
7109
7402
  accounts?: Array<AccountInfo>;
7110
7403
  };
7404
+ /**
7405
+ * ValidationCheckResponse
7406
+ */
7407
+ export type ValidationCheckResponse = {
7408
+ /**
7409
+ * Passed
7410
+ */
7411
+ passed: boolean;
7412
+ /**
7413
+ * Checks
7414
+ */
7415
+ checks: Array<string>;
7416
+ /**
7417
+ * Failures
7418
+ */
7419
+ failures: Array<string>;
7420
+ /**
7421
+ * Warnings
7422
+ */
7423
+ warnings: Array<string>;
7424
+ };
7111
7425
  /**
7112
7426
  * ValidationError
7113
7427
  */
@@ -11754,3 +12068,214 @@ export type GetLedgerSummaryResponses = {
11754
12068
  200: LedgerSummaryResponse;
11755
12069
  };
11756
12070
  export type GetLedgerSummaryResponse = GetLedgerSummaryResponses[keyof GetLedgerSummaryResponses];
12071
+ export type ListReportsData = {
12072
+ body?: never;
12073
+ path: {
12074
+ /**
12075
+ * Graph Id
12076
+ */
12077
+ graph_id: string;
12078
+ };
12079
+ query?: never;
12080
+ url: '/v1/ledger/{graph_id}/reports';
12081
+ };
12082
+ export type ListReportsErrors = {
12083
+ /**
12084
+ * Validation Error
12085
+ */
12086
+ 422: HttpValidationError;
12087
+ };
12088
+ export type ListReportsError = ListReportsErrors[keyof ListReportsErrors];
12089
+ export type ListReportsResponses = {
12090
+ /**
12091
+ * Successful Response
12092
+ */
12093
+ 200: ReportListResponse;
12094
+ };
12095
+ export type ListReportsResponse = ListReportsResponses[keyof ListReportsResponses];
12096
+ export type CreateReportData = {
12097
+ body: CreateReportRequest;
12098
+ path: {
12099
+ /**
12100
+ * Graph Id
12101
+ */
12102
+ graph_id: string;
12103
+ };
12104
+ query?: never;
12105
+ url: '/v1/ledger/{graph_id}/reports';
12106
+ };
12107
+ export type CreateReportErrors = {
12108
+ /**
12109
+ * Validation Error
12110
+ */
12111
+ 422: HttpValidationError;
12112
+ };
12113
+ export type CreateReportError = CreateReportErrors[keyof CreateReportErrors];
12114
+ export type CreateReportResponses = {
12115
+ /**
12116
+ * Successful Response
12117
+ */
12118
+ 201: ReportResponse;
12119
+ };
12120
+ export type CreateReportResponse = CreateReportResponses[keyof CreateReportResponses];
12121
+ export type DeleteReportData = {
12122
+ body?: never;
12123
+ path: {
12124
+ /**
12125
+ * Graph Id
12126
+ */
12127
+ graph_id: string;
12128
+ /**
12129
+ * Report Id
12130
+ *
12131
+ * Report definition ID
12132
+ */
12133
+ report_id: string;
12134
+ };
12135
+ query?: never;
12136
+ url: '/v1/ledger/{graph_id}/reports/{report_id}';
12137
+ };
12138
+ export type DeleteReportErrors = {
12139
+ /**
12140
+ * Validation Error
12141
+ */
12142
+ 422: HttpValidationError;
12143
+ };
12144
+ export type DeleteReportError = DeleteReportErrors[keyof DeleteReportErrors];
12145
+ export type DeleteReportResponses = {
12146
+ /**
12147
+ * Successful Response
12148
+ */
12149
+ 204: void;
12150
+ };
12151
+ export type DeleteReportResponse = DeleteReportResponses[keyof DeleteReportResponses];
12152
+ export type GetReportData = {
12153
+ body?: never;
12154
+ path: {
12155
+ /**
12156
+ * Graph Id
12157
+ */
12158
+ graph_id: string;
12159
+ /**
12160
+ * Report Id
12161
+ *
12162
+ * Report definition ID
12163
+ */
12164
+ report_id: string;
12165
+ };
12166
+ query?: never;
12167
+ url: '/v1/ledger/{graph_id}/reports/{report_id}';
12168
+ };
12169
+ export type GetReportErrors = {
12170
+ /**
12171
+ * Validation Error
12172
+ */
12173
+ 422: HttpValidationError;
12174
+ };
12175
+ export type GetReportError = GetReportErrors[keyof GetReportErrors];
12176
+ export type GetReportResponses = {
12177
+ /**
12178
+ * Successful Response
12179
+ */
12180
+ 200: ReportResponse;
12181
+ };
12182
+ export type GetReportResponse = GetReportResponses[keyof GetReportResponses];
12183
+ export type GetStatementData = {
12184
+ body?: never;
12185
+ path: {
12186
+ /**
12187
+ * Graph Id
12188
+ */
12189
+ graph_id: string;
12190
+ /**
12191
+ * Report Id
12192
+ *
12193
+ * Report definition ID
12194
+ */
12195
+ report_id: string;
12196
+ /**
12197
+ * Structure Type
12198
+ *
12199
+ * Structure type: income_statement, balance_sheet, cash_flow_statement
12200
+ */
12201
+ structure_type: string;
12202
+ };
12203
+ query?: never;
12204
+ url: '/v1/ledger/{graph_id}/reports/{report_id}/statements/{structure_type}';
12205
+ };
12206
+ export type GetStatementErrors = {
12207
+ /**
12208
+ * Validation Error
12209
+ */
12210
+ 422: HttpValidationError;
12211
+ };
12212
+ export type GetStatementError = GetStatementErrors[keyof GetStatementErrors];
12213
+ export type GetStatementResponses = {
12214
+ /**
12215
+ * Successful Response
12216
+ */
12217
+ 200: StatementResponse;
12218
+ };
12219
+ export type GetStatementResponse = GetStatementResponses[keyof GetStatementResponses];
12220
+ export type RegenerateReportData = {
12221
+ body: RegenerateReportRequest;
12222
+ path: {
12223
+ /**
12224
+ * Graph Id
12225
+ */
12226
+ graph_id: string;
12227
+ /**
12228
+ * Report Id
12229
+ *
12230
+ * Report definition ID
12231
+ */
12232
+ report_id: string;
12233
+ };
12234
+ query?: never;
12235
+ url: '/v1/ledger/{graph_id}/reports/{report_id}/regenerate';
12236
+ };
12237
+ export type RegenerateReportErrors = {
12238
+ /**
12239
+ * Validation Error
12240
+ */
12241
+ 422: HttpValidationError;
12242
+ };
12243
+ export type RegenerateReportError = RegenerateReportErrors[keyof RegenerateReportErrors];
12244
+ export type RegenerateReportResponses = {
12245
+ /**
12246
+ * Successful Response
12247
+ */
12248
+ 200: ReportResponse;
12249
+ };
12250
+ export type RegenerateReportResponse = RegenerateReportResponses[keyof RegenerateReportResponses];
12251
+ export type ShareReportData = {
12252
+ body: ShareReportRequest;
12253
+ path: {
12254
+ /**
12255
+ * Graph Id
12256
+ */
12257
+ graph_id: string;
12258
+ /**
12259
+ * Report Id
12260
+ *
12261
+ * Report definition ID
12262
+ */
12263
+ report_id: string;
12264
+ };
12265
+ query?: never;
12266
+ url: '/v1/ledger/{graph_id}/reports/{report_id}/share';
12267
+ };
12268
+ export type ShareReportErrors = {
12269
+ /**
12270
+ * Validation Error
12271
+ */
12272
+ 422: HttpValidationError;
12273
+ };
12274
+ export type ShareReportError = ShareReportErrors[keyof ShareReportErrors];
12275
+ export type ShareReportResponses = {
12276
+ /**
12277
+ * Successful Response
12278
+ */
12279
+ 200: ShareReportResponse;
12280
+ };
12281
+ export type ShareReportResponse2 = ShareReportResponses[keyof ShareReportResponses];