@robosystems/client 2.31.0 → 2.33.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 +206 -23
- package/artifacts/LedgerClient.js +122 -26
- package/artifacts/LedgerClient.ts +330 -47
- package/index.ts +2 -2
- package/package.json +1 -1
- package/sdk/index.d.ts +2 -2
- package/sdk/index.js +3 -2
- package/sdk/index.ts +2 -2
- package/sdk/sdk.gen.d.ts +10 -2
- package/sdk/sdk.gen.js +20 -3
- package/sdk/sdk.gen.ts +19 -2
- package/sdk/types.gen.d.ts +295 -10
- package/sdk/types.gen.ts +305 -10
- package/sdk.gen.d.ts +10 -2
- package/sdk.gen.js +20 -3
- package/sdk.gen.ts +19 -2
- package/types.gen.d.ts +295 -10
- package/types.gen.ts +305 -10
package/sdk/types.gen.d.ts
CHANGED
|
@@ -4654,6 +4654,73 @@ export type DatabaseStorageEntry = {
|
|
|
4654
4654
|
*/
|
|
4655
4655
|
size_mb?: number | null;
|
|
4656
4656
|
};
|
|
4657
|
+
/**
|
|
4658
|
+
* DeconsolidationResponse
|
|
4659
|
+
*
|
|
4660
|
+
* A member's leaving as recorded: the draft in the consolidation entity
|
|
4661
|
+
* its close posts, dated the first day of the month after the member's
|
|
4662
|
+
* last.
|
|
4663
|
+
*/
|
|
4664
|
+
export type DeconsolidationResponse = {
|
|
4665
|
+
/**
|
|
4666
|
+
* Entity Id
|
|
4667
|
+
*
|
|
4668
|
+
* The member that left.
|
|
4669
|
+
*/
|
|
4670
|
+
entity_id: string;
|
|
4671
|
+
/**
|
|
4672
|
+
* Entity Name
|
|
4673
|
+
*
|
|
4674
|
+
* The member's name.
|
|
4675
|
+
*/
|
|
4676
|
+
entity_name: string;
|
|
4677
|
+
/**
|
|
4678
|
+
* Left On
|
|
4679
|
+
*
|
|
4680
|
+
* The day it left, as the entity records.
|
|
4681
|
+
*/
|
|
4682
|
+
left_on: string;
|
|
4683
|
+
/**
|
|
4684
|
+
* Period
|
|
4685
|
+
*
|
|
4686
|
+
* The month the entry is dated in, as YYYY-MM: the first the group reads without the member.
|
|
4687
|
+
*/
|
|
4688
|
+
period: string;
|
|
4689
|
+
/**
|
|
4690
|
+
* Consideration
|
|
4691
|
+
*
|
|
4692
|
+
* Cents the parent received.
|
|
4693
|
+
*/
|
|
4694
|
+
consideration: number;
|
|
4695
|
+
/**
|
|
4696
|
+
* Derecognized
|
|
4697
|
+
*
|
|
4698
|
+
* What the consolidation entity held for the member beyond the eliminations its leaving reverses on their own, each taken off.
|
|
4699
|
+
*/
|
|
4700
|
+
derecognized?: Array<DerecognizedBalance>;
|
|
4701
|
+
/**
|
|
4702
|
+
* Earnings Restored
|
|
4703
|
+
*
|
|
4704
|
+
* Cents: the member's results since it joined, credited to the group's equity as they leave with its books; they were the group's income. Zero for an equity-method member, whose books were never summed.
|
|
4705
|
+
*/
|
|
4706
|
+
earnings_restored?: number;
|
|
4707
|
+
/**
|
|
4708
|
+
* Gain Loss
|
|
4709
|
+
*
|
|
4710
|
+
* Cents, a gain positive: the group's adjustment to the parent's own gain or loss on the sale, so the consolidated gain is the consideration less the carrying amount of what left (ASC 810).
|
|
4711
|
+
*/
|
|
4712
|
+
gain_loss: number;
|
|
4713
|
+
/**
|
|
4714
|
+
* The deconsolidation entry, a draft the close posts.
|
|
4715
|
+
*/
|
|
4716
|
+
entry: JournalEntryResponse;
|
|
4717
|
+
/**
|
|
4718
|
+
* Replaced
|
|
4719
|
+
*
|
|
4720
|
+
* True when it replaced an earlier draft of the deconsolidation.
|
|
4721
|
+
*/
|
|
4722
|
+
replaced?: boolean;
|
|
4723
|
+
};
|
|
4657
4724
|
/**
|
|
4658
4725
|
* DeleteDocumentOp
|
|
4659
4726
|
*
|
|
@@ -5021,6 +5088,26 @@ export type DeleteTaxonomyBlockResponse = {
|
|
|
5021
5088
|
*/
|
|
5022
5089
|
cascade_applied?: boolean;
|
|
5023
5090
|
};
|
|
5091
|
+
/**
|
|
5092
|
+
* DerecognizedBalance
|
|
5093
|
+
*
|
|
5094
|
+
* A balance the consolidation entity held for a member that left, taken
|
|
5095
|
+
* off by the deconsolidation.
|
|
5096
|
+
*/
|
|
5097
|
+
export type DerecognizedBalance = {
|
|
5098
|
+
/**
|
|
5099
|
+
* Concept
|
|
5100
|
+
*
|
|
5101
|
+
* The rs-gaap concept.
|
|
5102
|
+
*/
|
|
5103
|
+
concept: string;
|
|
5104
|
+
/**
|
|
5105
|
+
* Amount
|
|
5106
|
+
*
|
|
5107
|
+
* Cents as held: positive a debit (goodwill, a step-up), negative a credit (the outside owners' interest, the price above book of the parent's investment).
|
|
5108
|
+
*/
|
|
5109
|
+
amount: number;
|
|
5110
|
+
};
|
|
5024
5111
|
/**
|
|
5025
5112
|
* DescribeFilingRequest
|
|
5026
5113
|
*
|
|
@@ -7059,6 +7146,10 @@ export type FinancialStatementAnalysisResponse = {
|
|
|
7059
7146
|
* Fact Count
|
|
7060
7147
|
*/
|
|
7061
7148
|
fact_count: number;
|
|
7149
|
+
/**
|
|
7150
|
+
* On a ledger's graph, whether the graph is current with the books; null on shared repositories, which are not rebuilt from a ledger.
|
|
7151
|
+
*/
|
|
7152
|
+
graph_freshness?: GraphFreshness | null;
|
|
7062
7153
|
};
|
|
7063
7154
|
/**
|
|
7064
7155
|
* FiscalCalendarResponse
|
|
@@ -7538,6 +7629,40 @@ export type GraphCapacityResponse = {
|
|
|
7538
7629
|
*/
|
|
7539
7630
|
tiers: Array<TierCapacity>;
|
|
7540
7631
|
};
|
|
7632
|
+
/**
|
|
7633
|
+
* GraphFreshness
|
|
7634
|
+
*
|
|
7635
|
+
* Whether a ledger's graph is current with its books.
|
|
7636
|
+
*
|
|
7637
|
+
* A ledger's graph is a projection of its database, rebuilt after writes;
|
|
7638
|
+
* until a rebuild finishes, graph-backed reads answer from the previous one.
|
|
7639
|
+
*/
|
|
7640
|
+
export type GraphFreshness = {
|
|
7641
|
+
/**
|
|
7642
|
+
* Stale
|
|
7643
|
+
*
|
|
7644
|
+
* True when the books have changed since the graph was last rebuilt, so this answer can be behind them. A rebuild is queued automatically.
|
|
7645
|
+
*/
|
|
7646
|
+
stale: boolean;
|
|
7647
|
+
/**
|
|
7648
|
+
* Stale Since
|
|
7649
|
+
*
|
|
7650
|
+
* When the graph first fell behind the books (ISO 8601); null when current.
|
|
7651
|
+
*/
|
|
7652
|
+
stale_since?: string | null;
|
|
7653
|
+
/**
|
|
7654
|
+
* Stale Reason
|
|
7655
|
+
*
|
|
7656
|
+
* The latest write that left the graph behind (e.g. 'period_closed').
|
|
7657
|
+
*/
|
|
7658
|
+
stale_reason?: string | null;
|
|
7659
|
+
/**
|
|
7660
|
+
* Last Materialized At
|
|
7661
|
+
*
|
|
7662
|
+
* When the graph was last rebuilt (ISO 8601).
|
|
7663
|
+
*/
|
|
7664
|
+
last_materialized_at?: string | null;
|
|
7665
|
+
};
|
|
7541
7666
|
/**
|
|
7542
7667
|
* GraphInfo
|
|
7543
7668
|
*
|
|
@@ -9677,6 +9802,12 @@ export type LedgerEntityResponse = {
|
|
|
9677
9802
|
* The month this entity left the group, as any date in it; null is a member still. The consolidated statements include it through that month and leave it out after. Membership is by month: a period column wider than a month that overlaps the interval is summed whole, so a member's books in this graph should hold only the months it belonged.
|
|
9678
9803
|
*/
|
|
9679
9804
|
left_on?: string | null;
|
|
9805
|
+
/**
|
|
9806
|
+
* Is Former
|
|
9807
|
+
*
|
|
9808
|
+
* True once the month this entity left the group is over: its months in the group are history, readable under it, and it is no longer current. False for a member still in, and through the month it leaves.
|
|
9809
|
+
*/
|
|
9810
|
+
is_former?: boolean;
|
|
9680
9811
|
/**
|
|
9681
9812
|
* Source
|
|
9682
9813
|
*
|
|
@@ -12012,6 +12143,51 @@ export type OperationEnvelopeConsolidationWorksheetResponse = {
|
|
|
12012
12143
|
*/
|
|
12013
12144
|
idempotentReplay?: boolean;
|
|
12014
12145
|
};
|
|
12146
|
+
/**
|
|
12147
|
+
* OperationEnvelope[DeconsolidationResponse]
|
|
12148
|
+
*/
|
|
12149
|
+
export type OperationEnvelopeDeconsolidationResponse = {
|
|
12150
|
+
/**
|
|
12151
|
+
* Operation
|
|
12152
|
+
*
|
|
12153
|
+
* Kebab-case operation name
|
|
12154
|
+
*/
|
|
12155
|
+
operation: string;
|
|
12156
|
+
/**
|
|
12157
|
+
* Operationid
|
|
12158
|
+
*
|
|
12159
|
+
* op_-prefixed ULID for audit and SSE correlation
|
|
12160
|
+
*/
|
|
12161
|
+
operationId: string;
|
|
12162
|
+
/**
|
|
12163
|
+
* Status
|
|
12164
|
+
*
|
|
12165
|
+
* Operation lifecycle state
|
|
12166
|
+
*/
|
|
12167
|
+
status: 'completed' | 'pending' | 'failed';
|
|
12168
|
+
/**
|
|
12169
|
+
* Command-specific result payload
|
|
12170
|
+
*/
|
|
12171
|
+
result?: DeconsolidationResponse | null;
|
|
12172
|
+
/**
|
|
12173
|
+
* At
|
|
12174
|
+
*
|
|
12175
|
+
* ISO-8601 UTC timestamp
|
|
12176
|
+
*/
|
|
12177
|
+
at: string;
|
|
12178
|
+
/**
|
|
12179
|
+
* Createdby
|
|
12180
|
+
*
|
|
12181
|
+
* User ID that initiated the operation
|
|
12182
|
+
*/
|
|
12183
|
+
createdBy?: string | null;
|
|
12184
|
+
/**
|
|
12185
|
+
* Idempotentreplay
|
|
12186
|
+
*
|
|
12187
|
+
* True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
|
|
12188
|
+
*/
|
|
12189
|
+
idempotentReplay?: boolean;
|
|
12190
|
+
};
|
|
12015
12191
|
/**
|
|
12016
12192
|
* OperationEnvelope[DeleteInformationBlockResponse]
|
|
12017
12193
|
*/
|
|
@@ -14885,25 +15061,43 @@ export type OwnershipChangeResponse = {
|
|
|
14885
15061
|
/**
|
|
14886
15062
|
* Consideration
|
|
14887
15063
|
*
|
|
14888
|
-
* Cents paid to the outside owners.
|
|
15064
|
+
* Cents paid to the outside owners, or received from them for shares sold.
|
|
14889
15065
|
*/
|
|
14890
15066
|
consideration: number;
|
|
14891
15067
|
/**
|
|
14892
15068
|
* Book Value
|
|
14893
15069
|
*
|
|
14894
|
-
* Cents: the share bought of the member's capital, which the investment elimination moves from the outside owners to the parent.
|
|
15070
|
+
* Cents: the share bought of the member's capital, which the investment elimination moves from the outside owners to the parent; negative for a share sold, moved the other way.
|
|
14895
15071
|
*/
|
|
14896
15072
|
book_value: number;
|
|
14897
15073
|
/**
|
|
14898
15074
|
* Earnings Transferred
|
|
14899
15075
|
*
|
|
14900
|
-
* Cents: the share bought of the member's results since it joined, moved from the outside owners' interest to the parent.
|
|
15076
|
+
* Cents: the share bought of the member's results since it joined, moved from the outside owners' interest to the parent; negative for a share sold.
|
|
14901
15077
|
*/
|
|
14902
15078
|
earnings_transferred: number;
|
|
15079
|
+
/**
|
|
15080
|
+
* Premium Transferred
|
|
15081
|
+
*
|
|
15082
|
+
* Cents: the share bought of the outside owners' interest beyond their share of book value (from the acquisition at fair value, or its step-ups), moved to the parent; negative for a share sold.
|
|
15083
|
+
*/
|
|
15084
|
+
premium_transferred?: number;
|
|
15085
|
+
/**
|
|
15086
|
+
* Carrying Released
|
|
15087
|
+
*
|
|
15088
|
+
* Cents, for a sale: the carrying amount of the shares sold on the parent's books, its cost pro rata, which its sale entry credits against the investment. Zero for a purchase.
|
|
15089
|
+
*/
|
|
15090
|
+
carrying_released?: number;
|
|
15091
|
+
/**
|
|
15092
|
+
* Gain Reversed
|
|
15093
|
+
*
|
|
15094
|
+
* Cents, for a sale: the gain (a loss negative) the parent's own books take, the price less the carrying amount released, which the entry reverses — the group has none while control is kept. Zero for a purchase.
|
|
15095
|
+
*/
|
|
15096
|
+
gain_reversed?: number;
|
|
14903
15097
|
/**
|
|
14904
15098
|
* Equity Adjustment
|
|
14905
15099
|
*
|
|
14906
|
-
* Cents taken from the parent's equity: the price above the carrying amount of what was bought
|
|
15100
|
+
* Cents taken from the parent's equity (negative: added to it): for a purchase, the price above the carrying amount of what was bought; for a sale, the carrying amount given up above the price.
|
|
14907
15101
|
*/
|
|
14908
15102
|
equity_adjustment: number;
|
|
14909
15103
|
/**
|
|
@@ -17385,6 +17579,34 @@ export type RecordAcquisitionRequest = {
|
|
|
17385
17579
|
*/
|
|
17386
17580
|
confirm_bargain_purchase?: boolean;
|
|
17387
17581
|
};
|
|
17582
|
+
/**
|
|
17583
|
+
* RecordDeconsolidationRequest
|
|
17584
|
+
*
|
|
17585
|
+
* A member has left the group (`left_on` set): what the parent received
|
|
17586
|
+
* for its shares, and the basis. The entry derecognizes what the
|
|
17587
|
+
* consolidation entity still holds for the member and takes the gain or
|
|
17588
|
+
* loss on its leaving; the parent's own sale entry stays on its books.
|
|
17589
|
+
*/
|
|
17590
|
+
export type RecordDeconsolidationRequest = {
|
|
17591
|
+
/**
|
|
17592
|
+
* Entity Id
|
|
17593
|
+
*
|
|
17594
|
+
* The member that left: its `left_on` is set.
|
|
17595
|
+
*/
|
|
17596
|
+
entity_id: string;
|
|
17597
|
+
/**
|
|
17598
|
+
* Consideration
|
|
17599
|
+
*
|
|
17600
|
+
* Cents the parent received for its shares; 0 for a dissolution or an abandonment. Recorded with the entry for the record: the parent's own books hold the sale, cash against its investment and its own gain or loss, which this entry adjusts to the group's.
|
|
17601
|
+
*/
|
|
17602
|
+
consideration: number;
|
|
17603
|
+
/**
|
|
17604
|
+
* Basis
|
|
17605
|
+
*
|
|
17606
|
+
* The sale agreement, the dissolution, or what sets the price.
|
|
17607
|
+
*/
|
|
17608
|
+
basis: string;
|
|
17609
|
+
};
|
|
17388
17610
|
/**
|
|
17389
17611
|
* RecordOpeningBalanceRequest
|
|
17390
17612
|
*
|
|
@@ -17419,9 +17641,9 @@ export type RecordOpeningBalanceRequest = {
|
|
|
17419
17641
|
/**
|
|
17420
17642
|
* RecordOwnershipChangeRequest
|
|
17421
17643
|
*
|
|
17422
|
-
* The parent buys more of a member from its outside owners,
|
|
17423
|
-
*
|
|
17424
|
-
*
|
|
17644
|
+
* The parent buys more of a member from its outside owners, or sells some
|
|
17645
|
+
* of it to them while keeping control: the share it holds from a month, and
|
|
17646
|
+
* the price. ASC 810 makes it an equity transaction, never a gain or loss.
|
|
17425
17647
|
*/
|
|
17426
17648
|
export type RecordOwnershipChangeRequest = {
|
|
17427
17649
|
/**
|
|
@@ -17439,19 +17661,19 @@ export type RecordOwnershipChangeRequest = {
|
|
|
17439
17661
|
/**
|
|
17440
17662
|
* Ownership Pct
|
|
17441
17663
|
*
|
|
17442
|
-
* The parent's share from `period`, as a percentage: above its share the month before, and 50 or more, so the member stays consolidated in full.
|
|
17664
|
+
* The parent's share from `period`, as a percentage: above its share the month before for a purchase, below it for a sale, and 50 or more either way, so the member stays consolidated in full.
|
|
17443
17665
|
*/
|
|
17444
17666
|
ownership_pct: number;
|
|
17445
17667
|
/**
|
|
17446
17668
|
* Consideration
|
|
17447
17669
|
*
|
|
17448
|
-
* Cents the parent paid the outside owners for the shares. Its line names them, not the member, which is why it is given here.
|
|
17670
|
+
* Cents the parent paid the outside owners for the shares, or received from them for shares sold. Its line names them, not the member, which is why it is given here.
|
|
17449
17671
|
*/
|
|
17450
17672
|
consideration: number;
|
|
17451
17673
|
/**
|
|
17452
17674
|
* Basis
|
|
17453
17675
|
*
|
|
17454
|
-
* The purchase agreement, or what sets the price.
|
|
17676
|
+
* The purchase or sale agreement, or what sets the price.
|
|
17455
17677
|
*/
|
|
17456
17678
|
basis: string;
|
|
17457
17679
|
};
|
|
@@ -22700,6 +22922,10 @@ export type ViewMetadata = {
|
|
|
22700
22922
|
* True when more facts matched than `limit` allowed. The returned facts are the most recent by period; narrow the filters or raise `limit` to see the rest.
|
|
22701
22923
|
*/
|
|
22702
22924
|
truncated?: boolean;
|
|
22925
|
+
/**
|
|
22926
|
+
* On a ledger's graph, whether the graph is current with the books; null on shared repositories, which are not rebuilt from a ledger.
|
|
22927
|
+
*/
|
|
22928
|
+
graph_freshness?: GraphFreshness | null;
|
|
22703
22929
|
};
|
|
22704
22930
|
/**
|
|
22705
22931
|
* ViewProjections
|
|
@@ -32754,6 +32980,65 @@ export type RecordOwnershipChangeResponses = {
|
|
|
32754
32980
|
200: OperationEnvelopeOwnershipChangeResponse;
|
|
32755
32981
|
};
|
|
32756
32982
|
export type RecordOwnershipChangeResponse = RecordOwnershipChangeResponses[keyof RecordOwnershipChangeResponses];
|
|
32983
|
+
export type RecordDeconsolidationData = {
|
|
32984
|
+
body: RecordDeconsolidationRequest;
|
|
32985
|
+
headers?: {
|
|
32986
|
+
/**
|
|
32987
|
+
* Idempotency-Key
|
|
32988
|
+
*/
|
|
32989
|
+
'Idempotency-Key'?: string | null;
|
|
32990
|
+
};
|
|
32991
|
+
path: {
|
|
32992
|
+
/**
|
|
32993
|
+
* Graph Id
|
|
32994
|
+
*/
|
|
32995
|
+
graph_id: string;
|
|
32996
|
+
};
|
|
32997
|
+
query?: never;
|
|
32998
|
+
url: '/extensions/roboledger/{graph_id}/operations/record-deconsolidation';
|
|
32999
|
+
};
|
|
33000
|
+
export type RecordDeconsolidationErrors = {
|
|
33001
|
+
/**
|
|
33002
|
+
* Invalid request
|
|
33003
|
+
*/
|
|
33004
|
+
400: ErrorResponse;
|
|
33005
|
+
/**
|
|
33006
|
+
* Authentication required
|
|
33007
|
+
*/
|
|
33008
|
+
401: ErrorResponse;
|
|
33009
|
+
/**
|
|
33010
|
+
* Access denied
|
|
33011
|
+
*/
|
|
33012
|
+
403: ErrorResponse;
|
|
33013
|
+
/**
|
|
33014
|
+
* Resource not found
|
|
33015
|
+
*/
|
|
33016
|
+
404: ErrorResponse;
|
|
33017
|
+
/**
|
|
33018
|
+
* Idempotency-Key conflict — key reused with different body
|
|
33019
|
+
*/
|
|
33020
|
+
409: ErrorResponse;
|
|
33021
|
+
/**
|
|
33022
|
+
* Validation error
|
|
33023
|
+
*/
|
|
33024
|
+
422: ErrorResponse;
|
|
33025
|
+
/**
|
|
33026
|
+
* Rate limit exceeded
|
|
33027
|
+
*/
|
|
33028
|
+
429: ErrorResponse;
|
|
33029
|
+
/**
|
|
33030
|
+
* Internal server error
|
|
33031
|
+
*/
|
|
33032
|
+
500: ErrorResponse;
|
|
33033
|
+
};
|
|
33034
|
+
export type RecordDeconsolidationError = RecordDeconsolidationErrors[keyof RecordDeconsolidationErrors];
|
|
33035
|
+
export type RecordDeconsolidationResponses = {
|
|
33036
|
+
/**
|
|
33037
|
+
* Successful Response
|
|
33038
|
+
*/
|
|
33039
|
+
200: OperationEnvelopeDeconsolidationResponse;
|
|
33040
|
+
};
|
|
33041
|
+
export type RecordDeconsolidationResponse = RecordDeconsolidationResponses[keyof RecordDeconsolidationResponses];
|
|
32757
33042
|
export type UpdateJournalEntryData = {
|
|
32758
33043
|
body: UpdateJournalEntryRequest;
|
|
32759
33044
|
headers?: {
|