@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.
- package/artifacts/LedgerClient.d.ts +8 -1
- package/artifacts/LedgerClient.js +10 -0
- package/artifacts/LedgerClient.ts +19 -0
- package/index.ts +2 -2
- package/package.json +1 -1
- package/sdk/index.d.ts +2 -2
- package/sdk/index.js +6 -5
- package/sdk/index.ts +2 -2
- package/sdk/sdk.gen.d.ts +9 -1
- package/sdk/sdk.gen.js +18 -1
- package/sdk/sdk.gen.ts +18 -1
- package/sdk/types.gen.d.ts +308 -0
- package/sdk/types.gen.ts +318 -0
- package/sdk.gen.d.ts +9 -1
- package/sdk.gen.js +18 -1
- package/sdk.gen.ts +18 -1
- package/types.gen.d.ts +308 -0
- package/types.gen.ts +318 -0
package/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?: {
|