@robosystems/client 2.16.0 → 2.17.0

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.
@@ -2532,6 +2532,112 @@ export type ConnectionResponse = {
2532
2532
  [key: string]: unknown;
2533
2533
  };
2534
2534
  };
2535
+ /**
2536
+ * ConsolidationWorksheetRequest
2537
+ *
2538
+ * Request for consolidation-worksheet (OLTP, entity graphs only).
2539
+ */
2540
+ export type ConsolidationWorksheetRequest = {
2541
+ /**
2542
+ * Statement Type
2543
+ *
2544
+ * income_statement | balance_sheet | cash_flow_statement | equity_statement.
2545
+ */
2546
+ statement_type: string;
2547
+ /**
2548
+ * Period Start
2549
+ *
2550
+ * Explicit window start. Overrides period_type/fiscal_year.
2551
+ */
2552
+ period_start?: string | null;
2553
+ /**
2554
+ * Period End
2555
+ *
2556
+ * Explicit window end. Overrides period_type/fiscal_year.
2557
+ */
2558
+ period_end?: string | null;
2559
+ /**
2560
+ * Period Type
2561
+ *
2562
+ * annual | quarterly | instant (ignored when dates supplied)
2563
+ */
2564
+ period_type?: string | null;
2565
+ /**
2566
+ * Fiscal Year
2567
+ *
2568
+ * Fiscal year for annual window (anchored on FiscalCalendar)
2569
+ */
2570
+ fiscal_year?: number | null;
2571
+ /**
2572
+ * Limit
2573
+ *
2574
+ * Max rows returned. Defaults to the ceiling: the whole statement.
2575
+ */
2576
+ limit?: number;
2577
+ };
2578
+ /**
2579
+ * ConsolidationWorksheetResponse
2580
+ *
2581
+ * The group's statement with the entity as the column.
2582
+ */
2583
+ export type ConsolidationWorksheetResponse = {
2584
+ /**
2585
+ * Graph Id
2586
+ *
2587
+ * The graph read.
2588
+ */
2589
+ graph_id: string;
2590
+ /**
2591
+ * Entity Id
2592
+ *
2593
+ * The group parent.
2594
+ */
2595
+ entity_id: string;
2596
+ /**
2597
+ * Statement Type
2598
+ *
2599
+ * The statement rendered.
2600
+ */
2601
+ statement_type: string;
2602
+ /**
2603
+ * The window every column reads. The cash flow also pivots the prior window of equal length as its delta basis; it is not rendered.
2604
+ */
2605
+ period: PeriodSpec;
2606
+ /**
2607
+ * Columns
2608
+ *
2609
+ * The parent, each member consolidated in full, `combined`, the consolidation entity's adjustments (when the group has one), `consolidated`, then the equity-method and cost members outside the sum. A member outside its membership interval for the period has no column.
2610
+ */
2611
+ columns: Array<WorksheetColumn>;
2612
+ /**
2613
+ * Rows
2614
+ *
2615
+ * The union of every column's lines in the parent's Style order; a line zero in every column is left out.
2616
+ */
2617
+ rows: Array<WorksheetRow>;
2618
+ /**
2619
+ * The guard-rail outcome for the consolidated column, the same checks live-financial-statement runs.
2620
+ */
2621
+ validation?: ValidationCheckResponse | null;
2622
+ /**
2623
+ * Unmapped Entity Ids
2624
+ *
2625
+ * Entities with no CoA mapping yet, so with no column.
2626
+ */
2627
+ unmapped_entity_ids?: Array<string>;
2628
+ /**
2629
+ * Unmapped Count
2630
+ *
2631
+ * Unmapped accounts across the summed columns.
2632
+ */
2633
+ unmapped_count?: number;
2634
+ /**
2635
+ * Truncated
2636
+ *
2637
+ * Whether `limit` cut rows.
2638
+ */
2639
+ truncated?: boolean;
2640
+ };
2535
2641
  /**
2536
2642
  * ContentLimits
2537
2643
  *
@@ -11313,6 +11419,51 @@ export type OperationEnvelopeComputeMetricsResponse = {
11313
11419
  */
11314
11420
  idempotentReplay?: boolean;
11315
11421
  };
11422
+ /**
11423
+ * OperationEnvelope[ConsolidationWorksheetResponse]
11424
+ */
11425
+ export type OperationEnvelopeConsolidationWorksheetResponse = {
11426
+ /**
11427
+ * Operation
11428
+ *
11429
+ * Kebab-case operation name
11430
+ */
11431
+ operation: string;
11432
+ /**
11433
+ * Operationid
11434
+ *
11435
+ * op_-prefixed ULID for audit and SSE correlation
11436
+ */
11437
+ operationId: string;
11438
+ /**
11439
+ * Status
11440
+ *
11441
+ * Operation lifecycle state
11442
+ */
11443
+ status: 'completed' | 'pending' | 'failed';
11444
+ /**
11445
+ * Command-specific result payload
11446
+ */
11447
+ result?: ConsolidationWorksheetResponse | null;
11448
+ /**
11449
+ * At
11450
+ *
11451
+ * ISO-8601 UTC timestamp
11452
+ */
11453
+ at: string;
11454
+ /**
11455
+ * Createdby
11456
+ *
11457
+ * User ID that initiated the operation
11458
+ */
11459
+ createdBy?: string | null;
11460
+ /**
11461
+ * Idempotentreplay
11462
+ *
11463
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
11464
+ */
11465
+ idempotentReplay?: boolean;
11466
+ };
11316
11467
  /**
11317
11468
  * OperationEnvelope[DeleteInformationBlockResponse]
11318
11469
  */
@@ -21079,6 +21230,104 @@ export type ViewResponse = {
21079
21230
  [key: string]: ElementSummary;
21080
21231
  } | null;
21081
21232
  };
21233
+ /**
21234
+ * WorksheetColumn
21235
+ *
21236
+ * One column of the consolidation worksheet.
21237
+ */
21238
+ export type WorksheetColumn = {
21239
+ /**
21240
+ * Key
21241
+ *
21242
+ * The entity id for an entity's column; `combined` and `consolidated` for the two totals.
21243
+ */
21244
+ key: string;
21245
+ /**
21246
+ * Label
21247
+ *
21248
+ * The entity's name, or the total's.
21249
+ */
21250
+ label: string;
21251
+ /**
21252
+ * Kind
21253
+ *
21254
+ * `member`: the parent or a member consolidated in full. `combined`: the members' sum, nothing eliminated. `adjustments`: the consolidation entity's entries. `consolidated`: combined plus the adjustments. `not_summed`: an equity-method or cost member, shown beside the sum and never in it.
21255
+ */
21256
+ kind: 'member' | 'combined' | 'adjustments' | 'consolidated' | 'not_summed';
21257
+ /**
21258
+ * Entity Id
21259
+ *
21260
+ * The entity the column reads; null on a total.
21261
+ */
21262
+ entity_id?: string | null;
21263
+ /**
21264
+ * Consolidation Method
21265
+ *
21266
+ * The entity's `consolidation_method`; null on a total.
21267
+ */
21268
+ consolidation_method?: string | null;
21269
+ /**
21270
+ * Ownership Pct
21271
+ *
21272
+ * The parent's share of the entity, where it has one.
21273
+ */
21274
+ ownership_pct?: number | null;
21275
+ /**
21276
+ * In Sum
21277
+ *
21278
+ * Whether the column is part of the consolidated total.
21279
+ */
21280
+ in_sum: boolean;
21281
+ };
21282
+ /**
21283
+ * WorksheetRow
21284
+ *
21285
+ * One line of the consolidation worksheet, a value per column.
21286
+ */
21287
+ export type WorksheetRow = {
21288
+ /**
21289
+ * Qname
21290
+ *
21291
+ * The rs-gaap concept of the line.
21292
+ */
21293
+ qname: string;
21294
+ /**
21295
+ * Name
21296
+ *
21297
+ * The line's label.
21298
+ */
21299
+ name: string;
21300
+ /**
21301
+ * Trait
21302
+ *
21303
+ * The concept's classification.
21304
+ */
21305
+ trait?: string | null;
21306
+ /**
21307
+ * Values
21308
+ *
21309
+ * One value per column, aligned with `columns`.
21310
+ */
21311
+ values: Array<number | null>;
21312
+ /**
21313
+ * Depth
21314
+ *
21315
+ * Indentation in the statement.
21316
+ */
21317
+ depth?: number;
21318
+ /**
21319
+ * Is Subtotal
21320
+ *
21321
+ * Whether the line is a total.
21322
+ */
21323
+ is_subtotal?: boolean;
21324
+ /**
21325
+ * Period Role
21326
+ *
21327
+ * On the equity roll-forward, `start` for the beginning-balance row and `end` for the ending-balance row. Null elsewhere.
21328
+ */
21329
+ period_role?: string | null;
21330
+ };
21082
21331
  /**
21083
21332
  * _CreateForecastArm
21084
21333
  *
@@ -32453,6 +32702,65 @@ export type LiveFinancialStatementResponses = {
32453
32702
  200: OperationEnvelopeLiveFinancialStatementResponse;
32454
32703
  };
32455
32704
  export type LiveFinancialStatementResponse2 = LiveFinancialStatementResponses[keyof LiveFinancialStatementResponses];
32705
+ export type ConsolidationWorksheetData = {
32706
+ body: ConsolidationWorksheetRequest;
32707
+ headers?: {
32708
+ /**
32709
+ * Idempotency-Key
32710
+ */
32711
+ 'Idempotency-Key'?: string | null;
32712
+ };
32713
+ path: {
32714
+ /**
32715
+ * Graph Id
32716
+ */
32717
+ graph_id: string;
32718
+ };
32719
+ query?: never;
32720
+ url: '/extensions/roboledger/{graph_id}/operations/consolidation-worksheet';
32721
+ };
32722
+ export type ConsolidationWorksheetErrors = {
32723
+ /**
32724
+ * Invalid request
32725
+ */
32726
+ 400: ErrorResponse;
32727
+ /**
32728
+ * Authentication required
32729
+ */
32730
+ 401: ErrorResponse;
32731
+ /**
32732
+ * Access denied
32733
+ */
32734
+ 403: ErrorResponse;
32735
+ /**
32736
+ * Resource not found
32737
+ */
32738
+ 404: ErrorResponse;
32739
+ /**
32740
+ * Idempotency-Key conflict — key reused with different body
32741
+ */
32742
+ 409: ErrorResponse;
32743
+ /**
32744
+ * Validation error
32745
+ */
32746
+ 422: ErrorResponse;
32747
+ /**
32748
+ * Rate limit exceeded
32749
+ */
32750
+ 429: ErrorResponse;
32751
+ /**
32752
+ * Internal server error
32753
+ */
32754
+ 500: ErrorResponse;
32755
+ };
32756
+ export type ConsolidationWorksheetError = ConsolidationWorksheetErrors[keyof ConsolidationWorksheetErrors];
32757
+ export type ConsolidationWorksheetResponses = {
32758
+ /**
32759
+ * Successful Response
32760
+ */
32761
+ 200: OperationEnvelopeConsolidationWorksheetResponse;
32762
+ };
32763
+ export type ConsolidationWorksheetResponse2 = ConsolidationWorksheetResponses[keyof ConsolidationWorksheetResponses];
32456
32764
  export type CreatePortfolioBlockData = {
32457
32765
  body: CreatePortfolioBlockRequest;
32458
32766
  headers?: {
package/sdk/types.gen.ts CHANGED
@@ -2597,6 +2597,114 @@ export type ConnectionResponse = {
2597
2597
  };
2598
2598
  };
2599
2599
 
2600
+ /**
2601
+ * ConsolidationWorksheetRequest
2602
+ *
2603
+ * Request for consolidation-worksheet (OLTP, entity graphs only).
2604
+ */
2605
+ export type ConsolidationWorksheetRequest = {
2606
+ /**
2607
+ * Statement Type
2608
+ *
2609
+ * income_statement | balance_sheet | cash_flow_statement | equity_statement.
2610
+ */
2611
+ statement_type: string;
2612
+ /**
2613
+ * Period Start
2614
+ *
2615
+ * Explicit window start. Overrides period_type/fiscal_year.
2616
+ */
2617
+ period_start?: string | null;
2618
+ /**
2619
+ * Period End
2620
+ *
2621
+ * Explicit window end. Overrides period_type/fiscal_year.
2622
+ */
2623
+ period_end?: string | null;
2624
+ /**
2625
+ * Period Type
2626
+ *
2627
+ * annual | quarterly | instant (ignored when dates supplied)
2628
+ */
2629
+ period_type?: string | null;
2630
+ /**
2631
+ * Fiscal Year
2632
+ *
2633
+ * Fiscal year for annual window (anchored on FiscalCalendar)
2634
+ */
2635
+ fiscal_year?: number | null;
2636
+ /**
2637
+ * Limit
2638
+ *
2639
+ * Max rows returned. Defaults to the ceiling: the whole statement.
2640
+ */
2641
+ limit?: number;
2642
+ };
2643
+
2644
+ /**
2645
+ * ConsolidationWorksheetResponse
2646
+ *
2647
+ * The group's statement with the entity as the column.
2648
+ */
2649
+ export type ConsolidationWorksheetResponse = {
2650
+ /**
2651
+ * Graph Id
2652
+ *
2653
+ * The graph read.
2654
+ */
2655
+ graph_id: string;
2656
+ /**
2657
+ * Entity Id
2658
+ *
2659
+ * The group parent.
2660
+ */
2661
+ entity_id: string;
2662
+ /**
2663
+ * Statement Type
2664
+ *
2665
+ * The statement rendered.
2666
+ */
2667
+ statement_type: string;
2668
+ /**
2669
+ * The window every column reads. The cash flow also pivots the prior window of equal length as its delta basis; it is not rendered.
2670
+ */
2671
+ period: PeriodSpec;
2672
+ /**
2673
+ * Columns
2674
+ *
2675
+ * The parent, each member consolidated in full, `combined`, the consolidation entity's adjustments (when the group has one), `consolidated`, then the equity-method and cost members outside the sum. A member outside its membership interval for the period has no column.
2676
+ */
2677
+ columns: Array<WorksheetColumn>;
2678
+ /**
2679
+ * Rows
2680
+ *
2681
+ * The union of every column's lines in the parent's Style order; a line zero in every column is left out.
2682
+ */
2683
+ rows: Array<WorksheetRow>;
2684
+ /**
2685
+ * The guard-rail outcome for the consolidated column, the same checks live-financial-statement runs.
2686
+ */
2687
+ validation?: ValidationCheckResponse | null;
2688
+ /**
2689
+ * Unmapped Entity Ids
2690
+ *
2691
+ * Entities with no CoA mapping yet, so with no column.
2692
+ */
2693
+ unmapped_entity_ids?: Array<string>;
2694
+ /**
2695
+ * Unmapped Count
2696
+ *
2697
+ * Unmapped accounts across the summed columns.
2698
+ */
2699
+ unmapped_count?: number;
2700
+ /**
2701
+ * Truncated
2702
+ *
2703
+ * Whether `limit` cut rows.
2704
+ */
2705
+ truncated?: boolean;
2706
+ };
2707
+
2600
2708
  /**
2601
2709
  * ContentLimits
2602
2710
  *
@@ -11575,6 +11683,52 @@ export type OperationEnvelopeComputeMetricsResponse = {
11575
11683
  idempotentReplay?: boolean;
11576
11684
  };
11577
11685
 
11686
+ /**
11687
+ * OperationEnvelope[ConsolidationWorksheetResponse]
11688
+ */
11689
+ export type OperationEnvelopeConsolidationWorksheetResponse = {
11690
+ /**
11691
+ * Operation
11692
+ *
11693
+ * Kebab-case operation name
11694
+ */
11695
+ operation: string;
11696
+ /**
11697
+ * Operationid
11698
+ *
11699
+ * op_-prefixed ULID for audit and SSE correlation
11700
+ */
11701
+ operationId: string;
11702
+ /**
11703
+ * Status
11704
+ *
11705
+ * Operation lifecycle state
11706
+ */
11707
+ status: 'completed' | 'pending' | 'failed';
11708
+ /**
11709
+ * Command-specific result payload
11710
+ */
11711
+ result?: ConsolidationWorksheetResponse | null;
11712
+ /**
11713
+ * At
11714
+ *
11715
+ * ISO-8601 UTC timestamp
11716
+ */
11717
+ at: string;
11718
+ /**
11719
+ * Createdby
11720
+ *
11721
+ * User ID that initiated the operation
11722
+ */
11723
+ createdBy?: string | null;
11724
+ /**
11725
+ * Idempotentreplay
11726
+ *
11727
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
11728
+ */
11729
+ idempotentReplay?: boolean;
11730
+ };
11731
+
11578
11732
  /**
11579
11733
  * OperationEnvelope[DeleteInformationBlockResponse]
11580
11734
  */
@@ -21586,6 +21740,106 @@ export type ViewResponse = {
21586
21740
  } | null;
21587
21741
  };
21588
21742
 
21743
+ /**
21744
+ * WorksheetColumn
21745
+ *
21746
+ * One column of the consolidation worksheet.
21747
+ */
21748
+ export type WorksheetColumn = {
21749
+ /**
21750
+ * Key
21751
+ *
21752
+ * The entity id for an entity's column; `combined` and `consolidated` for the two totals.
21753
+ */
21754
+ key: string;
21755
+ /**
21756
+ * Label
21757
+ *
21758
+ * The entity's name, or the total's.
21759
+ */
21760
+ label: string;
21761
+ /**
21762
+ * Kind
21763
+ *
21764
+ * `member`: the parent or a member consolidated in full. `combined`: the members' sum, nothing eliminated. `adjustments`: the consolidation entity's entries. `consolidated`: combined plus the adjustments. `not_summed`: an equity-method or cost member, shown beside the sum and never in it.
21765
+ */
21766
+ kind: 'member' | 'combined' | 'adjustments' | 'consolidated' | 'not_summed';
21767
+ /**
21768
+ * Entity Id
21769
+ *
21770
+ * The entity the column reads; null on a total.
21771
+ */
21772
+ entity_id?: string | null;
21773
+ /**
21774
+ * Consolidation Method
21775
+ *
21776
+ * The entity's `consolidation_method`; null on a total.
21777
+ */
21778
+ consolidation_method?: string | null;
21779
+ /**
21780
+ * Ownership Pct
21781
+ *
21782
+ * The parent's share of the entity, where it has one.
21783
+ */
21784
+ ownership_pct?: number | null;
21785
+ /**
21786
+ * In Sum
21787
+ *
21788
+ * Whether the column is part of the consolidated total.
21789
+ */
21790
+ in_sum: boolean;
21791
+ };
21792
+
21793
+ /**
21794
+ * WorksheetRow
21795
+ *
21796
+ * One line of the consolidation worksheet, a value per column.
21797
+ */
21798
+ export type WorksheetRow = {
21799
+ /**
21800
+ * Qname
21801
+ *
21802
+ * The rs-gaap concept of the line.
21803
+ */
21804
+ qname: string;
21805
+ /**
21806
+ * Name
21807
+ *
21808
+ * The line's label.
21809
+ */
21810
+ name: string;
21811
+ /**
21812
+ * Trait
21813
+ *
21814
+ * The concept's classification.
21815
+ */
21816
+ trait?: string | null;
21817
+ /**
21818
+ * Values
21819
+ *
21820
+ * One value per column, aligned with `columns`.
21821
+ */
21822
+ values: Array<number | null>;
21823
+ /**
21824
+ * Depth
21825
+ *
21826
+ * Indentation in the statement.
21827
+ */
21828
+ depth?: number;
21829
+ /**
21830
+ * Is Subtotal
21831
+ *
21832
+ * Whether the line is a total.
21833
+ */
21834
+ is_subtotal?: boolean;
21835
+ /**
21836
+ * Period Role
21837
+ *
21838
+ * On the equity roll-forward, `start` for the beginning-balance row and `end` for the ending-balance row. Null elsewhere.
21839
+ */
21840
+ period_role?: string | null;
21841
+ };
21842
+
21589
21843
  /**
21590
21844
  * _CreateForecastArm
21591
21845
  *
@@ -34021,6 +34275,70 @@ export type LiveFinancialStatementResponses = {
34021
34275
 
34022
34276
  export type LiveFinancialStatementResponse2 = LiveFinancialStatementResponses[keyof LiveFinancialStatementResponses];
34023
34277
 
34278
+ export type ConsolidationWorksheetData = {
34279
+ body: ConsolidationWorksheetRequest;
34280
+ headers?: {
34281
+ /**
34282
+ * Idempotency-Key
34283
+ */
34284
+ 'Idempotency-Key'?: string | null;
34285
+ };
34286
+ path: {
34287
+ /**
34288
+ * Graph Id
34289
+ */
34290
+ graph_id: string;
34291
+ };
34292
+ query?: never;
34293
+ url: '/extensions/roboledger/{graph_id}/operations/consolidation-worksheet';
34294
+ };
34295
+
34296
+ export type ConsolidationWorksheetErrors = {
34297
+ /**
34298
+ * Invalid request
34299
+ */
34300
+ 400: ErrorResponse;
34301
+ /**
34302
+ * Authentication required
34303
+ */
34304
+ 401: ErrorResponse;
34305
+ /**
34306
+ * Access denied
34307
+ */
34308
+ 403: ErrorResponse;
34309
+ /**
34310
+ * Resource not found
34311
+ */
34312
+ 404: ErrorResponse;
34313
+ /**
34314
+ * Idempotency-Key conflict — key reused with different body
34315
+ */
34316
+ 409: ErrorResponse;
34317
+ /**
34318
+ * Validation error
34319
+ */
34320
+ 422: ErrorResponse;
34321
+ /**
34322
+ * Rate limit exceeded
34323
+ */
34324
+ 429: ErrorResponse;
34325
+ /**
34326
+ * Internal server error
34327
+ */
34328
+ 500: ErrorResponse;
34329
+ };
34330
+
34331
+ export type ConsolidationWorksheetError = ConsolidationWorksheetErrors[keyof ConsolidationWorksheetErrors];
34332
+
34333
+ export type ConsolidationWorksheetResponses = {
34334
+ /**
34335
+ * Successful Response
34336
+ */
34337
+ 200: OperationEnvelopeConsolidationWorksheetResponse;
34338
+ };
34339
+
34340
+ export type ConsolidationWorksheetResponse2 = ConsolidationWorksheetResponses[keyof ConsolidationWorksheetResponses];
34341
+
34024
34342
  export type CreatePortfolioBlockData = {
34025
34343
  body: CreatePortfolioBlockRequest;
34026
34344
  headers?: {