@robosystems/client 2.38.0 → 2.39.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/README.md +1 -1
- package/artifacts/InvestorClient.d.ts +4 -2
- package/artifacts/InvestorClient.js +4 -2
- package/artifacts/InvestorClient.ts +4 -2
- package/artifacts/LedgerClient.d.ts +31 -23
- package/artifacts/LedgerClient.js +27 -19
- package/artifacts/LedgerClient.ts +34 -26
- package/artifacts/LibraryClient.d.ts +4 -4
- package/artifacts/LibraryClient.js +4 -4
- package/artifacts/LibraryClient.ts +5 -5
- package/artifacts/OperatorClient.d.ts +2 -2
- package/artifacts/OperatorClient.js +2 -2
- package/artifacts/OperatorClient.ts +2 -2
- package/artifacts/graphql/queries/ledger/flowCandidates.d.ts +1 -1
- package/artifacts/graphql/queries/ledger/flowCandidates.js +1 -1
- package/artifacts/graphql/queries/ledger/flowCandidates.ts +1 -1
- package/artifacts/graphql/queries/ledger/informationBlock.d.ts +3 -5
- package/artifacts/graphql/queries/ledger/informationBlock.js +3 -5
- package/artifacts/graphql/queries/ledger/informationBlock.ts +3 -5
- package/artifacts/graphql/queries/ledger/mappedTrialBalance.d.ts +1 -1
- package/artifacts/graphql/queries/ledger/mappedTrialBalance.js +1 -1
- package/artifacts/graphql/queries/ledger/mappedTrialBalance.ts +1 -1
- package/artifacts/graphql/queries/ledger/mappingCoverage.d.ts +1 -1
- package/artifacts/graphql/queries/ledger/mappingCoverage.js +1 -1
- package/artifacts/graphql/queries/ledger/mappingCoverage.ts +1 -1
- package/artifacts/graphql/queries/ledger/reportDownloadUrl.d.ts +3 -2
- package/artifacts/graphql/queries/ledger/reportDownloadUrl.js +3 -2
- package/artifacts/graphql/queries/ledger/reportDownloadUrl.ts +3 -2
- package/artifacts/graphql/queries/ledger/reportingTaxonomy.d.ts +3 -3
- package/artifacts/graphql/queries/ledger/reportingTaxonomy.js +3 -3
- package/artifacts/graphql/queries/ledger/reportingTaxonomy.ts +3 -3
- package/artifacts/graphql/queries/ledger/statement.d.ts +5 -4
- package/artifacts/graphql/queries/ledger/statement.js +5 -4
- package/artifacts/graphql/queries/ledger/statement.ts +5 -4
- package/artifacts/graphql/queries/ledger/structures.d.ts +1 -1
- package/artifacts/graphql/queries/ledger/structures.js +1 -1
- package/artifacts/graphql/queries/ledger/structures.ts +1 -1
- package/artifacts/graphql/queries/ledger/unmappedElements.d.ts +1 -1
- package/artifacts/graphql/queries/ledger/unmappedElements.js +1 -1
- package/artifacts/graphql/queries/ledger/unmappedElements.ts +1 -1
- package/artifacts/graphql/queries/library/arcs.d.ts +1 -1
- package/artifacts/graphql/queries/library/arcs.js +1 -1
- package/artifacts/graphql/queries/library/arcs.ts +1 -1
- package/artifacts/graphql/queries/library/elements.d.ts +1 -1
- package/artifacts/graphql/queries/library/elements.js +1 -1
- package/artifacts/graphql/queries/library/elements.ts +1 -1
- package/artifacts/hooks.d.ts +8 -8
- package/artifacts/hooks.js +8 -8
- package/artifacts/hooks.ts +8 -8
- package/package.json +2 -2
- package/sdk/sdk.gen.d.ts +13 -13
- package/sdk/sdk.gen.js +13 -13
- package/sdk/sdk.gen.ts +13 -13
- package/sdk/types.gen.d.ts +76 -67
- package/sdk/types.gen.ts +76 -67
- package/sdk.gen.d.ts +13 -13
- package/sdk.gen.js +13 -13
- package/sdk.gen.ts +13 -13
- package/types.gen.d.ts +76 -67
- package/types.gen.ts +76 -67
package/types.gen.ts
CHANGED
|
@@ -389,7 +389,7 @@ export type AddPublishListMembersOperation = {
|
|
|
389
389
|
/**
|
|
390
390
|
* Target Graph Ids
|
|
391
391
|
*
|
|
392
|
-
* Graph IDs to add. Each must exist and
|
|
392
|
+
* Graph IDs to add. Each must exist and carry the roboledger or roboinvestor extension. Self-graph rejected.
|
|
393
393
|
*/
|
|
394
394
|
target_graph_ids: Array<string>;
|
|
395
395
|
/**
|
|
@@ -2195,14 +2195,18 @@ export type CompleteDocumentUploadOp = {
|
|
|
2195
2195
|
*
|
|
2196
2196
|
* Request body for the `compute-forecast` operation.
|
|
2197
2197
|
*
|
|
2198
|
-
* Walks the scenario's driver cascade month-by-month forward from
|
|
2199
|
-
*
|
|
2200
|
-
*
|
|
2201
|
-
*
|
|
2202
|
-
*
|
|
2203
|
-
*
|
|
2204
|
-
*
|
|
2205
|
-
*
|
|
2198
|
+
* Walks the scenario's driver cascade month-by-month forward from its
|
|
2199
|
+
* anchor — the newest closed month inside the horizon under
|
|
2200
|
+
* `base_anchor='seam'` (the default), the block's `base_period` under
|
|
2201
|
+
* `'fixed'`: lever-driven Derive rules in dependency order, carry-forward
|
|
2202
|
+
* for unmodeled IS lines, calc-DAG subtotals — upserting per forward
|
|
2203
|
+
* month a scenario IS FactSet, a BS set (the full roll when the anchor
|
|
2204
|
+
* month has an actual balance sheet, else the rule-driven working-capital
|
|
2205
|
+
* instants) and a derived CF set when an actual one exists, all keyed by
|
|
2206
|
+
* the forecast block's `scenario_id`. Re-running replaces each month's
|
|
2207
|
+
* values (the compute-metrics drift semantics). A month that fails
|
|
2208
|
+
* verification halts the walk (`halted_at`). Deterministic and non-AI —
|
|
2209
|
+
* no credits consumed.
|
|
2206
2210
|
*/
|
|
2207
2211
|
export type ComputeForecastRequest = {
|
|
2208
2212
|
/**
|
|
@@ -3677,7 +3681,7 @@ export type CreateForecastRequest = {
|
|
|
3677
3681
|
/**
|
|
3678
3682
|
* Base Period
|
|
3679
3683
|
*
|
|
3680
|
-
*
|
|
3684
|
+
* Origin month (`YYYY-MM`) of the authored window. Defaults to the fiscal calendar's closed-through period, else the newest actual report month. Resolved and stored at create time, and it never moves afterwards — every lever is keyed to a month inside `base_period + 1 … + horizon_months`, so moving it would mean restating all of them. `base_anchor` decides whether the walk still *seeds* here once months close under it.
|
|
3681
3685
|
*/
|
|
3682
3686
|
base_period?: string | null;
|
|
3683
3687
|
/**
|
|
@@ -3759,10 +3763,11 @@ export type CreateGraphRequest = {
|
|
|
3759
3763
|
*
|
|
3760
3764
|
* Create an Information Block. The body is a discriminated union on
|
|
3761
3765
|
* `block_type`: pick the arm matching the block type you want to
|
|
3762
|
-
* create. The schedule
|
|
3763
|
-
*
|
|
3764
|
-
*
|
|
3765
|
-
*
|
|
3766
|
+
* create. The schedule and forecast arms carry fully typed payloads;
|
|
3767
|
+
* the remaining arms accept an untyped payload and return HTTP 501
|
|
3768
|
+
* with a hint naming the operation that constructs them (statements
|
|
3769
|
+
* via `create-report`, disclosure and metric structures via
|
|
3770
|
+
* `create-taxonomy-block`).
|
|
3766
3771
|
*/
|
|
3767
3772
|
export type CreateInformationBlockRequest = ({
|
|
3768
3773
|
block_type: 'schedule';
|
|
@@ -4927,8 +4932,8 @@ export type DeleteGraphOp = {
|
|
|
4927
4932
|
*
|
|
4928
4933
|
* Delete an Information Block. The body is a discriminated union on
|
|
4929
4934
|
* `block_type` mirroring `CreateInformationBlockRequest`. The schedule
|
|
4930
|
-
*
|
|
4931
|
-
* return HTTP 501.
|
|
4935
|
+
* and forecast arms carry fully typed delete payloads; the remaining
|
|
4936
|
+
* arms return HTTP 501.
|
|
4932
4937
|
*/
|
|
4933
4938
|
export type DeleteInformationBlockRequest = ({
|
|
4934
4939
|
block_type: 'schedule';
|
|
@@ -6744,11 +6749,11 @@ export type EventHandlerResponse = {
|
|
|
6744
6749
|
* each draft entry posts as its own JournalEntry, with the entry id as
|
|
6745
6750
|
* the RequestId, and its QuickBooks id is recorded per entry on
|
|
6746
6751
|
* `event.metadata.qb_entry_ids`. The event goes `fulfilled` once no
|
|
6747
|
-
* draft remains
|
|
6748
|
-
*
|
|
6752
|
+
* draft remains. When QuickBooks rejects an entry, what landed is kept,
|
|
6753
|
+
* the status is unchanged, and the error is stamped on
|
|
6754
|
+
* `event.metadata.last_outbound_error` and returned as `qb_error`.
|
|
6749
6755
|
*
|
|
6750
|
-
* `'native'
|
|
6751
|
-
* RoboSystems IS the source of truth, no outbound publish needed.
|
|
6756
|
+
* Events on `'native'` or `'shadow'` books pass through with no QB write.
|
|
6752
6757
|
*/
|
|
6753
6758
|
export type ExecuteEventBlockRequest = {
|
|
6754
6759
|
/**
|
|
@@ -6780,7 +6785,7 @@ export type ExecuteEventBlockResponse = {
|
|
|
6780
6785
|
/**
|
|
6781
6786
|
* Status
|
|
6782
6787
|
*
|
|
6783
|
-
* The event's status after the call. Unchanged when no write fired (native policy, a source that does not publish) or when drafts in a later period are still unpublished. `'fulfilled'` once every draft entry of the event is in QuickBooks and posted.
|
|
6788
|
+
* The event's status after the call. Unchanged when no write fired (native policy, a source that does not publish) or when drafts in a later period are still unpublished. `'fulfilled'` once every draft entry of the event is in QuickBooks and posted. Also unchanged when QuickBooks rejected an entry — see `qb_error`; retry after fixing the underlying issue.
|
|
6784
6789
|
*/
|
|
6785
6790
|
status: string;
|
|
6786
6791
|
/**
|
|
@@ -9038,7 +9043,7 @@ export type InformationModelResponse = {
|
|
|
9038
9043
|
/**
|
|
9039
9044
|
* Concept Arrangement
|
|
9040
9045
|
*
|
|
9041
|
-
* roll_up | roll_forward |
|
|
9046
|
+
* A Concept Arrangement Pattern: set | roll_up | roll_forward | roll_forward_info | adjustment | variance | arithmetic | text_block, a text-block or detail level (level1_textblock … level4_detail, table_equivalent_textblock), or grid | compound_fact. Null for block types where the concept arrangement is implicit in their mechanics.
|
|
9042
9047
|
*/
|
|
9043
9048
|
concept_arrangement?: string | null;
|
|
9044
9049
|
/**
|
|
@@ -9615,7 +9620,7 @@ export type JournalEntryLineItemInput = {
|
|
|
9615
9620
|
/**
|
|
9616
9621
|
* Flow Qname
|
|
9617
9622
|
*
|
|
9618
|
-
* The cash flow row this line's cash belongs to, an rs-gaap flow qname (`flowCandidates
|
|
9623
|
+
* The cash flow row this line's cash belongs to, an rs-gaap flow qname (`list-flow-candidates` over MCP and `flowCandidates` over GraphQL list the rows this company's statement offers). Only for a loan drawn or repaid, capital put in or taken out, an asset bought or sold; omitted, the account's default flow applies. A flow set on one side of the entry tags the untagged lines on the other: the cash flow statement reads the cash line and the roll-forwards read the account line. On the group's consolidation entity, which moves no cash, every tagged line counts on its own, cash-effect signed (a credit is an inflow), so an elimination offsets the flow a member's line produced, and a tag does not spread to the other side. Refused when it is not a row of the entity's cash flow statement.
|
|
9619
9624
|
*/
|
|
9620
9625
|
flow_qname?: string | null;
|
|
9621
9626
|
/**
|
|
@@ -9627,7 +9632,7 @@ export type JournalEntryLineItemInput = {
|
|
|
9627
9632
|
/**
|
|
9628
9633
|
* Metadata
|
|
9629
9634
|
*
|
|
9630
|
-
* Optional per-line metadata stamped on `LineItem.metadata_`. Used to carry source-system fields the standard columns don't cover — e.g. an external
|
|
9635
|
+
* Optional per-line metadata stamped on `LineItem.metadata_`. Used to carry source-system fields the standard columns don't cover — e.g. an external memo or a cost-center hint. A flow tag goes in `flow_qname`, not here. Pass-through is non-validating; the renderer / filter engine reads keys it knows about and ignores the rest. `None` is normalized to `{}` at persist time.
|
|
9631
9636
|
*/
|
|
9632
9637
|
metadata?: {
|
|
9633
9638
|
[key: string]: unknown;
|
|
@@ -15188,7 +15193,7 @@ export type OperatorRunDetail = {
|
|
|
15188
15193
|
/**
|
|
15189
15194
|
* Transcript
|
|
15190
15195
|
*
|
|
15191
|
-
* One entry per model call, in order: the input added since the previous call (the question, then each turn's tool results), the model's output blocks (text and tool calls), stop reason, token usage and
|
|
15196
|
+
* One entry per model call, in order: the input added since the previous call (the question, then each turn's tool results), the model's output blocks (text and tool calls), stop reason, token usage, credits and sampling settings. The first entry also carries the SHA-256 and size of the system prompt and the SHA-256 and names of the tools offered; later entries repeat them only when they change
|
|
15192
15197
|
*/
|
|
15193
15198
|
transcript?: Array<{
|
|
15194
15199
|
[key: string]: unknown;
|
|
@@ -16344,19 +16349,19 @@ export type PortfolioBlockEnvelope = {
|
|
|
16344
16349
|
/**
|
|
16345
16350
|
* Positions
|
|
16346
16351
|
*
|
|
16347
|
-
*
|
|
16352
|
+
* The portfolio's active positions; disposed ones are not included.
|
|
16348
16353
|
*/
|
|
16349
16354
|
positions: Array<PositionBlock>;
|
|
16350
16355
|
/**
|
|
16351
16356
|
* Total Cost Basis Dollars
|
|
16352
16357
|
*
|
|
16353
|
-
* Sum of `cost_basis_dollars` across
|
|
16358
|
+
* Sum of `cost_basis_dollars` across the active positions.
|
|
16354
16359
|
*/
|
|
16355
16360
|
total_cost_basis_dollars: number;
|
|
16356
16361
|
/**
|
|
16357
16362
|
* Total Current Value Dollars
|
|
16358
16363
|
*
|
|
16359
|
-
* Sum of `current_value_dollars` across
|
|
16364
|
+
* Sum of `current_value_dollars` across the marked active positions; an unmarked one adds nothing. `null` only when no active position has a mark.
|
|
16360
16365
|
*/
|
|
16361
16366
|
total_current_value_dollars?: number | null;
|
|
16362
16367
|
/**
|
|
@@ -16714,7 +16719,7 @@ export type PositionBlock = {
|
|
|
16714
16719
|
/**
|
|
16715
16720
|
* Status
|
|
16716
16721
|
*
|
|
16717
|
-
* Lifecycle state (`active`, `disposed
|
|
16722
|
+
* Lifecycle state (`active`, `disposed`). See `PositionResponse.status` for the full vocabulary.
|
|
16718
16723
|
*/
|
|
16719
16724
|
status: string;
|
|
16720
16725
|
/**
|
|
@@ -18759,10 +18764,12 @@ export type RenderingPeriodLite = {
|
|
|
18759
18764
|
*
|
|
18760
18765
|
* One row of a server-side rendered statement.
|
|
18761
18766
|
*
|
|
18762
|
-
*
|
|
18767
|
+
* Drawn from :class:`FactRow` in
|
|
18763
18768
|
* :mod:`robosystems.operations.roboledger.reports.fact_grid`, restated at the
|
|
18764
|
-
* API boundary so envelope consumers don't depend on that module.
|
|
18765
|
-
*
|
|
18769
|
+
* API boundary so envelope consumers don't depend on that module. It does not
|
|
18770
|
+
* carry FactRow's `is_abstract`, `position` or `period_role` (the start/end
|
|
18771
|
+
* role that tells a roll-forward's two balance rows apart).
|
|
18772
|
+
* `values` holds one entry per period column in :class:`RenderingLite.periods`.
|
|
18766
18773
|
*/
|
|
18767
18774
|
export type RenderingRowLite = {
|
|
18768
18775
|
/**
|
|
@@ -22806,7 +22813,7 @@ export type UpdateEventBlockRequest = {
|
|
|
22806
22813
|
/**
|
|
22807
22814
|
* Discharge Allocations
|
|
22808
22815
|
*
|
|
22809
|
-
* What this payment settles, document by document: one row per invoice or bill with the positive cents applied to it, together at most the payment's amount (the rest is unapplied). Replaces any held; an empty list clears them, and the settlement link becomes the first row's. Each must be an obligation of this event's entity, not voided: an invoice for money in, a bill for money out. A person chooses them; the open items a bank line may settle are `dischargeCandidates` over GraphQL.
|
|
22816
|
+
* What this payment settles, document by document: one row per invoice or bill with the positive cents applied to it, together at most the payment's amount (the rest is unapplied). Replaces any held; an empty list clears them, and the settlement link becomes the first row's. Each must be an obligation of this event's entity, not voided: an invoice for money in, a bill for money out. A person chooses them; the open items a bank line may settle are `list-discharge-candidates` over MCP and `dischargeCandidates` over GraphQL.
|
|
22810
22817
|
*/
|
|
22811
22818
|
discharge_allocations?: Array<DischargeAllocation> | null;
|
|
22812
22819
|
/**
|
|
@@ -23018,9 +23025,9 @@ export type UpdateGraphMetadataOp = {
|
|
|
23018
23025
|
*
|
|
23019
23026
|
* Update an Information Block. The body is a discriminated union on
|
|
23020
23027
|
* `block_type` mirroring `CreateInformationBlockRequest`. The schedule
|
|
23021
|
-
*
|
|
23022
|
-
* return HTTP 501 (statements are library-seeded;
|
|
23023
|
-
*
|
|
23028
|
+
* and forecast arms carry fully typed update payloads; the remaining
|
|
23029
|
+
* arms return HTTP 501 (statements are library-seeded; the others
|
|
23030
|
+
* change through their own operations).
|
|
23024
23031
|
*/
|
|
23025
23032
|
export type UpdateInformationBlockRequest = ({
|
|
23026
23033
|
block_type: 'schedule';
|
|
@@ -23308,7 +23315,7 @@ export type UpdateSecurityOperation = {
|
|
|
23308
23315
|
/**
|
|
23309
23316
|
* Terms
|
|
23310
23317
|
*
|
|
23311
|
-
* Replacement terms blob.
|
|
23318
|
+
* Replacement terms blob. Omit to leave existing terms unchanged; pass `{}` to clear them.
|
|
23312
23319
|
*/
|
|
23313
23320
|
terms?: {
|
|
23314
23321
|
[key: string]: unknown;
|
|
@@ -23864,20 +23871,17 @@ export type ViewMetadata = {
|
|
|
23864
23871
|
/**
|
|
23865
23872
|
* ViewProjections
|
|
23866
23873
|
*
|
|
23867
|
-
* The
|
|
23868
|
-
*
|
|
23869
|
-
* BusinessRules), surfaced at the envelope boundary.
|
|
23874
|
+
* The server-computed View projections of an Information Block,
|
|
23875
|
+
* surfaced at the envelope boundary.
|
|
23870
23876
|
*
|
|
23871
|
-
*
|
|
23872
|
-
*
|
|
23873
|
-
*
|
|
23874
|
-
*
|
|
23875
|
-
*
|
|
23876
|
-
*
|
|
23877
|
-
*
|
|
23878
|
-
*
|
|
23879
|
-
* for metric blocks. Projections without backend support yet are empty;
|
|
23880
|
-
* `fact_table` is derivable from `InformationBlockEnvelope.facts`.
|
|
23877
|
+
* Two are computed at envelope-build time when their source data is
|
|
23878
|
+
* available: `rendering` (the rendered rows and periods) for the
|
|
23879
|
+
* statement family, disclosures, metrics, forecasts and reconciliations,
|
|
23880
|
+
* and `chart` (panel/series config over the rendering's rows and
|
|
23881
|
+
* periods) for metric blocks. The other views a client shows are
|
|
23882
|
+
* derived from the envelope itself — a fact table from
|
|
23883
|
+
* `InformationBlockEnvelope.facts`, rule outcomes from its rules and
|
|
23884
|
+
* verification results.
|
|
23881
23885
|
*/
|
|
23882
23886
|
export type ViewProjections = {
|
|
23883
23887
|
rendering?: RenderingLite | null;
|
|
@@ -24047,24 +24051,26 @@ export type CreateForecastArm = {
|
|
|
24047
24051
|
/**
|
|
24048
24052
|
* _CreateLegacyArm
|
|
24049
24053
|
*
|
|
24050
|
-
* Create-information-block body for block types
|
|
24051
|
-
*
|
|
24054
|
+
* Create-information-block body for block types constructed through
|
|
24055
|
+
* another operation.
|
|
24052
24056
|
*
|
|
24053
24057
|
* Statement-family blocks (balance_sheet, income_statement,
|
|
24054
24058
|
* cash_flow_statement, equity_statement, comprehensive_income) are
|
|
24055
24059
|
* constructed via `create-report`, not this endpoint. Disclosure
|
|
24056
24060
|
* structures (regulatory_disclosure) are vocabulary, authored via
|
|
24057
24061
|
* `create-taxonomy-block`; their facts land when `create-report`
|
|
24058
|
-
* picks them. Metric
|
|
24059
|
-
*
|
|
24060
|
-
*
|
|
24061
|
-
*
|
|
24062
|
+
* picks them. Metric structures are authored via
|
|
24063
|
+
* `create-taxonomy-block` and their facts written by `compute-metrics`
|
|
24064
|
+
* or `assert-metrics`. Reconciliation blocks are created by
|
|
24065
|
+
* `refresh-reconciliations`. Calling this endpoint with one of these
|
|
24066
|
+
* block types returns HTTP 501 with a hint pointing to the correct
|
|
24067
|
+
* construction path.
|
|
24062
24068
|
*/
|
|
24063
24069
|
export type CreateLegacyArm = {
|
|
24064
24070
|
/**
|
|
24065
24071
|
* Block Type
|
|
24066
24072
|
*
|
|
24067
|
-
* Statement-family
|
|
24073
|
+
* Statement-family, disclosure, metric or reconciliation block type. The endpoint returns 501 for these values with a hint naming the operation that constructs each.
|
|
24068
24074
|
*/
|
|
24069
24075
|
block_type: 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'comprehensive_income' | 'regulatory_disclosure' | 'metric' | 'reconciliation';
|
|
24070
24076
|
/**
|
|
@@ -24126,14 +24132,16 @@ export type DeleteForecastArm = {
|
|
|
24126
24132
|
* a typed delete path at the API boundary.
|
|
24127
24133
|
*
|
|
24128
24134
|
* Statement-family blocks cannot be deleted per tenant (the underlying
|
|
24129
|
-
* Report should be archived via the report APIs instead).
|
|
24130
|
-
*
|
|
24135
|
+
* Report should be archived via the report APIs instead). Disclosure
|
|
24136
|
+
* and metric structures are removed through the taxonomy-block
|
|
24137
|
+
* operations; a reconciliation stops holding the close through
|
|
24138
|
+
* `set-reconciliation-policy`. Calls return HTTP 501.
|
|
24131
24139
|
*/
|
|
24132
24140
|
export type DeleteLegacyArm = {
|
|
24133
24141
|
/**
|
|
24134
24142
|
* Block Type
|
|
24135
24143
|
*
|
|
24136
|
-
* Statement-family
|
|
24144
|
+
* Statement-family, disclosure, metric or reconciliation block type. Deletion returns 501 — statements are library-seeded (archive the underlying Report instead); the others are managed through their own operations, named in the 501's hint.
|
|
24137
24145
|
*/
|
|
24138
24146
|
block_type: 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'comprehensive_income' | 'regulatory_disclosure' | 'metric' | 'reconciliation';
|
|
24139
24147
|
/**
|
|
@@ -24191,18 +24199,19 @@ export type UpdateForecastArm = {
|
|
|
24191
24199
|
/**
|
|
24192
24200
|
* _UpdateLegacyArm
|
|
24193
24201
|
*
|
|
24194
|
-
* Update-information-block body for block types
|
|
24195
|
-
*
|
|
24202
|
+
* Update-information-block body for block types updated through
|
|
24203
|
+
* another operation.
|
|
24196
24204
|
*
|
|
24197
|
-
* Statement-family blocks are library-seeded and immutable.
|
|
24198
|
-
*
|
|
24199
|
-
*
|
|
24205
|
+
* Statement-family blocks are library-seeded and immutable. Disclosure
|
|
24206
|
+
* and metric structures change through the taxonomy-block operations;
|
|
24207
|
+
* a reconciliation's policy through `set-reconciliation-policy`.
|
|
24208
|
+
* Calling this endpoint with one of these block types returns HTTP 501.
|
|
24200
24209
|
*/
|
|
24201
24210
|
export type UpdateLegacyArm = {
|
|
24202
24211
|
/**
|
|
24203
24212
|
* Block Type
|
|
24204
24213
|
*
|
|
24205
|
-
* Statement-family
|
|
24214
|
+
* Statement-family, disclosure, metric or reconciliation block type. Updates return 501 — statement Structures are library-seeded; the others change through their own operations, named in the 501's hint.
|
|
24206
24215
|
*/
|
|
24207
24216
|
block_type: 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'comprehensive_income' | 'regulatory_disclosure' | 'metric' | 'reconciliation';
|
|
24208
24217
|
/**
|
|
@@ -27271,7 +27280,7 @@ export type GetOperatorMetadataData = {
|
|
|
27271
27280
|
/**
|
|
27272
27281
|
* Operator Type
|
|
27273
27282
|
*
|
|
27274
|
-
* Operator type identifier
|
|
27283
|
+
* Operator type identifier: 'analyst', 'mapping' or 'author'
|
|
27275
27284
|
*/
|
|
27276
27285
|
operator_type: string;
|
|
27277
27286
|
};
|