@robosystems/client 2.38.1 → 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.
Files changed (59) hide show
  1. package/artifacts/InvestorClient.d.ts +4 -2
  2. package/artifacts/InvestorClient.js +4 -2
  3. package/artifacts/InvestorClient.ts +4 -2
  4. package/artifacts/LedgerClient.d.ts +31 -23
  5. package/artifacts/LedgerClient.js +27 -19
  6. package/artifacts/LedgerClient.ts +34 -26
  7. package/artifacts/LibraryClient.d.ts +4 -4
  8. package/artifacts/LibraryClient.js +4 -4
  9. package/artifacts/LibraryClient.ts +5 -5
  10. package/artifacts/OperatorClient.d.ts +2 -2
  11. package/artifacts/OperatorClient.js +2 -2
  12. package/artifacts/OperatorClient.ts +2 -2
  13. package/artifacts/graphql/queries/ledger/flowCandidates.d.ts +1 -1
  14. package/artifacts/graphql/queries/ledger/flowCandidates.js +1 -1
  15. package/artifacts/graphql/queries/ledger/flowCandidates.ts +1 -1
  16. package/artifacts/graphql/queries/ledger/informationBlock.d.ts +3 -5
  17. package/artifacts/graphql/queries/ledger/informationBlock.js +3 -5
  18. package/artifacts/graphql/queries/ledger/informationBlock.ts +3 -5
  19. package/artifacts/graphql/queries/ledger/mappedTrialBalance.d.ts +1 -1
  20. package/artifacts/graphql/queries/ledger/mappedTrialBalance.js +1 -1
  21. package/artifacts/graphql/queries/ledger/mappedTrialBalance.ts +1 -1
  22. package/artifacts/graphql/queries/ledger/mappingCoverage.d.ts +1 -1
  23. package/artifacts/graphql/queries/ledger/mappingCoverage.js +1 -1
  24. package/artifacts/graphql/queries/ledger/mappingCoverage.ts +1 -1
  25. package/artifacts/graphql/queries/ledger/reportDownloadUrl.d.ts +3 -2
  26. package/artifacts/graphql/queries/ledger/reportDownloadUrl.js +3 -2
  27. package/artifacts/graphql/queries/ledger/reportDownloadUrl.ts +3 -2
  28. package/artifacts/graphql/queries/ledger/reportingTaxonomy.d.ts +3 -3
  29. package/artifacts/graphql/queries/ledger/reportingTaxonomy.js +3 -3
  30. package/artifacts/graphql/queries/ledger/reportingTaxonomy.ts +3 -3
  31. package/artifacts/graphql/queries/ledger/statement.d.ts +5 -4
  32. package/artifacts/graphql/queries/ledger/statement.js +5 -4
  33. package/artifacts/graphql/queries/ledger/statement.ts +5 -4
  34. package/artifacts/graphql/queries/ledger/structures.d.ts +1 -1
  35. package/artifacts/graphql/queries/ledger/structures.js +1 -1
  36. package/artifacts/graphql/queries/ledger/structures.ts +1 -1
  37. package/artifacts/graphql/queries/ledger/unmappedElements.d.ts +1 -1
  38. package/artifacts/graphql/queries/ledger/unmappedElements.js +1 -1
  39. package/artifacts/graphql/queries/ledger/unmappedElements.ts +1 -1
  40. package/artifacts/graphql/queries/library/arcs.d.ts +1 -1
  41. package/artifacts/graphql/queries/library/arcs.js +1 -1
  42. package/artifacts/graphql/queries/library/arcs.ts +1 -1
  43. package/artifacts/graphql/queries/library/elements.d.ts +1 -1
  44. package/artifacts/graphql/queries/library/elements.js +1 -1
  45. package/artifacts/graphql/queries/library/elements.ts +1 -1
  46. package/artifacts/hooks.d.ts +8 -8
  47. package/artifacts/hooks.js +8 -8
  48. package/artifacts/hooks.ts +8 -8
  49. package/package.json +1 -1
  50. package/sdk/sdk.gen.d.ts +13 -13
  51. package/sdk/sdk.gen.js +13 -13
  52. package/sdk/sdk.gen.ts +13 -13
  53. package/sdk/types.gen.d.ts +76 -67
  54. package/sdk/types.gen.ts +76 -67
  55. package/sdk.gen.d.ts +13 -13
  56. package/sdk.gen.js +13 -13
  57. package/sdk.gen.ts +13 -13
  58. package/types.gen.d.ts +76 -67
  59. package/types.gen.ts +76 -67
@@ -377,7 +377,7 @@ export type AddPublishListMembersOperation = {
377
377
  /**
378
378
  * Target Graph Ids
379
379
  *
380
- * Graph IDs to add. Each must exist and have the same extension (roboledger / roboinvestor) enabled. Self-graph rejected.
380
+ * Graph IDs to add. Each must exist and carry the roboledger or roboinvestor extension. Self-graph rejected.
381
381
  */
382
382
  target_graph_ids: Array<string>;
383
383
  /**
@@ -2139,14 +2139,18 @@ export type CompleteDocumentUploadOp = {
2139
2139
  *
2140
2140
  * Request body for the `compute-forecast` operation.
2141
2141
  *
2142
- * Walks the scenario's driver cascade month-by-month forward from the
2143
- * forecast block's `base_period`: lever-driven Derive rules in
2144
- * dependency order, carry-forward for unmodeled IS lines, calc-DAG
2145
- * subtotals — upserting one scenario IS FactSet (+ a working-capital BS
2146
- * set) per forward month, all keyed by the forecast block's
2147
- * `scenario_id`. Re-running replaces each month's values (the
2148
- * compute-metrics drift semantics). Deterministic and non-AI — no
2149
- * credits consumed.
2142
+ * Walks the scenario's driver cascade month-by-month forward from its
2143
+ * anchor — the newest closed month inside the horizon under
2144
+ * `base_anchor='seam'` (the default), the block's `base_period` under
2145
+ * `'fixed'`: lever-driven Derive rules in dependency order, carry-forward
2146
+ * for unmodeled IS lines, calc-DAG subtotals — upserting per forward
2147
+ * month a scenario IS FactSet, a BS set (the full roll when the anchor
2148
+ * month has an actual balance sheet, else the rule-driven working-capital
2149
+ * instants) and a derived CF set when an actual one exists, all keyed by
2150
+ * the forecast block's `scenario_id`. Re-running replaces each month's
2151
+ * values (the compute-metrics drift semantics). A month that fails
2152
+ * verification halts the walk (`halted_at`). Deterministic and non-AI —
2153
+ * no credits consumed.
2150
2154
  */
2151
2155
  export type ComputeForecastRequest = {
2152
2156
  /**
@@ -3594,7 +3598,7 @@ export type CreateForecastRequest = {
3594
3598
  /**
3595
3599
  * Base Period
3596
3600
  *
3597
- * Seed month (`YYYY-MM`) the walk projects forward from. 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.
3601
+ * 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.
3598
3602
  */
3599
3603
  base_period?: string | null;
3600
3604
  /**
@@ -3674,10 +3678,11 @@ export type CreateGraphRequest = {
3674
3678
  *
3675
3679
  * Create an Information Block. The body is a discriminated union on
3676
3680
  * `block_type`: pick the arm matching the block type you want to
3677
- * create. The schedule arm carries a fully typed payload; statement
3678
- * and metric arms accept an untyped payload but currently return HTTP
3679
- * 501 (statements are constructed via `create-report`; metric
3680
- * construction is pending).
3681
+ * create. The schedule and forecast arms carry fully typed payloads;
3682
+ * the remaining arms accept an untyped payload and return HTTP 501
3683
+ * with a hint naming the operation that constructs them (statements
3684
+ * via `create-report`, disclosure and metric structures via
3685
+ * `create-taxonomy-block`).
3681
3686
  */
3682
3687
  export type CreateInformationBlockRequest = ({
3683
3688
  block_type: 'schedule';
@@ -4817,8 +4822,8 @@ export type DeleteGraphOp = {
4817
4822
  *
4818
4823
  * Delete an Information Block. The body is a discriminated union on
4819
4824
  * `block_type` mirroring `CreateInformationBlockRequest`. The schedule
4820
- * arm carries a fully typed delete payload; statement and metric arms
4821
- * return HTTP 501.
4825
+ * and forecast arms carry fully typed delete payloads; the remaining
4826
+ * arms return HTTP 501.
4822
4827
  */
4823
4828
  export type DeleteInformationBlockRequest = ({
4824
4829
  block_type: 'schedule';
@@ -6587,11 +6592,11 @@ export type EventHandlerResponse = {
6587
6592
  * each draft entry posts as its own JournalEntry, with the entry id as
6588
6593
  * the RequestId, and its QuickBooks id is recorded per entry on
6589
6594
  * `event.metadata.qb_entry_ids`. The event goes `fulfilled` once no
6590
- * draft remains, or `pending` when QuickBooks rejects an entry (what
6591
- * landed is kept).
6595
+ * draft remains. When QuickBooks rejects an entry, what landed is kept,
6596
+ * the status is unchanged, and the error is stamped on
6597
+ * `event.metadata.last_outbound_error` and returned as `qb_error`.
6592
6598
  *
6593
- * `'native'`-policy events fast-path through with no QB write —
6594
- * RoboSystems IS the source of truth, no outbound publish needed.
6599
+ * Events on `'native'` or `'shadow'` books pass through with no QB write.
6595
6600
  */
6596
6601
  export type ExecuteEventBlockRequest = {
6597
6602
  /**
@@ -6622,7 +6627,7 @@ export type ExecuteEventBlockResponse = {
6622
6627
  /**
6623
6628
  * Status
6624
6629
  *
6625
- * 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. `'pending'` when QuickBooks rejected an entry — see `qb_error`; retry after fixing the underlying issue.
6630
+ * 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.
6626
6631
  */
6627
6632
  status: string;
6628
6633
  /**
@@ -8836,7 +8841,7 @@ export type InformationModelResponse = {
8836
8841
  /**
8837
8842
  * Concept Arrangement
8838
8843
  *
8839
- * roll_up | roll_forward | variance | adjustment | set | arithmetic | textblock. Null for block types where the concept arrangement is implicit in their mechanics.
8844
+ * 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.
8840
8845
  */
8841
8846
  concept_arrangement?: string | null;
8842
8847
  /**
@@ -9399,7 +9404,7 @@ export type JournalEntryLineItemInput = {
9399
9404
  /**
9400
9405
  * Flow Qname
9401
9406
  *
9402
- * The cash flow row this line's cash belongs to, an rs-gaap flow qname (`flowCandidates(entityId)` lists 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.
9407
+ * 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.
9403
9408
  */
9404
9409
  flow_qname?: string | null;
9405
9410
  /**
@@ -9411,7 +9416,7 @@ export type JournalEntryLineItemInput = {
9411
9416
  /**
9412
9417
  * Metadata
9413
9418
  *
9414
- * Optional per-line metadata stamped on `LineItem.metadata_`. Used to carry source-system fields the standard columns don't cover — e.g. an external flow-tag code that drives rollforward attribution (`transaction_description_code`), an external memo, or a cost-center hint. 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.
9419
+ * 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.
9415
9420
  */
9416
9421
  metadata?: {
9417
9422
  [key: string]: unknown;
@@ -14854,7 +14859,7 @@ export type OperatorRunDetail = {
14854
14859
  /**
14855
14860
  * Transcript
14856
14861
  *
14857
- * 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 credits. The first entry also carries the system prompt's SHA-256 and size and the tool names offered; later entries repeat them only when they change
14862
+ * 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
14858
14863
  */
14859
14864
  transcript?: Array<{
14860
14865
  [key: string]: unknown;
@@ -15976,19 +15981,19 @@ export type PortfolioBlockEnvelope = {
15976
15981
  /**
15977
15982
  * Positions
15978
15983
  *
15979
- * All positions in this portfolio, including disposed ones (filter by `status` for active-only display).
15984
+ * The portfolio's active positions; disposed ones are not included.
15980
15985
  */
15981
15986
  positions: Array<PositionBlock>;
15982
15987
  /**
15983
15988
  * Total Cost Basis Dollars
15984
15989
  *
15985
- * Sum of `cost_basis_dollars` across every position.
15990
+ * Sum of `cost_basis_dollars` across the active positions.
15986
15991
  */
15987
15992
  total_cost_basis_dollars: number;
15988
15993
  /**
15989
15994
  * Total Current Value Dollars
15990
15995
  *
15991
- * Sum of `current_value_dollars` across every position. `null` when any active position lacks a mark.
15996
+ * Sum of `current_value_dollars` across the marked active positions; an unmarked one adds nothing. `null` only when no active position has a mark.
15992
15997
  */
15993
15998
  total_current_value_dollars?: number | null;
15994
15999
  /**
@@ -16339,7 +16344,7 @@ export type PositionBlock = {
16339
16344
  /**
16340
16345
  * Status
16341
16346
  *
16342
- * Lifecycle state (`active`, `disposed`, `archived`). See `PositionResponse.status` for the full vocabulary.
16347
+ * Lifecycle state (`active`, `disposed`). See `PositionResponse.status` for the full vocabulary.
16343
16348
  */
16344
16349
  status: string;
16345
16350
  /**
@@ -18337,10 +18342,12 @@ export type RenderingPeriodLite = {
18337
18342
  *
18338
18343
  * One row of a server-side rendered statement.
18339
18344
  *
18340
- * Mirrors :class:`FactRow` in
18345
+ * Drawn from :class:`FactRow` in
18341
18346
  * :mod:`robosystems.operations.roboledger.reports.fact_grid`, restated at the
18342
- * API boundary so envelope consumers don't depend on that module. `values`
18343
- * holds one entry per period column in :class:`RenderingLite.periods`.
18347
+ * API boundary so envelope consumers don't depend on that module. It does not
18348
+ * carry FactRow's `is_abstract`, `position` or `period_role` (the start/end
18349
+ * role that tells a roll-forward's two balance rows apart).
18350
+ * `values` holds one entry per period column in :class:`RenderingLite.periods`.
18344
18351
  */
18345
18352
  export type RenderingRowLite = {
18346
18353
  /**
@@ -22287,7 +22294,7 @@ export type UpdateEventBlockRequest = {
22287
22294
  /**
22288
22295
  * Discharge Allocations
22289
22296
  *
22290
- * 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.
22297
+ * 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.
22291
22298
  */
22292
22299
  discharge_allocations?: Array<DischargeAllocation> | null;
22293
22300
  /**
@@ -22494,9 +22501,9 @@ export type UpdateGraphMetadataOp = {
22494
22501
  *
22495
22502
  * Update an Information Block. The body is a discriminated union on
22496
22503
  * `block_type` mirroring `CreateInformationBlockRequest`. The schedule
22497
- * arm carries a fully typed update payload; statement and metric arms
22498
- * return HTTP 501 (statements are library-seeded; metric updates are
22499
- * pending).
22504
+ * and forecast arms carry fully typed update payloads; the remaining
22505
+ * arms return HTTP 501 (statements are library-seeded; the others
22506
+ * change through their own operations).
22500
22507
  */
22501
22508
  export type UpdateInformationBlockRequest = ({
22502
22509
  block_type: 'schedule';
@@ -22775,7 +22782,7 @@ export type UpdateSecurityOperation = {
22775
22782
  /**
22776
22783
  * Terms
22777
22784
  *
22778
- * Replacement terms blob. Pass `null`/omit to leave existing terms unchanged; pass `{}` to clear them.
22785
+ * Replacement terms blob. Omit to leave existing terms unchanged; pass `{}` to clear them.
22779
22786
  */
22780
22787
  terms?: {
22781
22788
  [key: string]: unknown;
@@ -23316,20 +23323,17 @@ export type ViewMetadata = {
23316
23323
  /**
23317
23324
  * ViewProjections
23318
23325
  *
23319
- * The six `type-of` View projections of an Information Block (Rendering,
23320
- * FactTable, ModelStructure, VerificationResults, ReportElements,
23321
- * BusinessRules), surfaced at the envelope boundary.
23326
+ * The server-computed View projections of an Information Block,
23327
+ * surfaced at the envelope boundary.
23322
23328
  *
23323
- * Each projection is computed server-side at envelope-build time when
23324
- * its source data is available. The frontend's `BlockView` dispatcher
23325
- * routes to the projection component matching the user's selected view
23326
- * mode; missing projections render as empty states without breaking the
23327
- * dispatcher.
23328
- *
23329
- * Today: `rendering` is computed for the statement family, and
23330
- * `chart` (panel/series config over the rendering's rows and periods)
23331
- * for metric blocks. Projections without backend support yet are empty;
23332
- * `fact_table` is derivable from `InformationBlockEnvelope.facts`.
23329
+ * Two are computed at envelope-build time when their source data is
23330
+ * available: `rendering` (the rendered rows and periods) for the
23331
+ * statement family, disclosures, metrics, forecasts and reconciliations,
23332
+ * and `chart` (panel/series config over the rendering's rows and
23333
+ * periods) for metric blocks. The other views a client shows are
23334
+ * derived from the envelope itself — a fact table from
23335
+ * `InformationBlockEnvelope.facts`, rule outcomes from its rules and
23336
+ * verification results.
23333
23337
  */
23334
23338
  export type ViewProjections = {
23335
23339
  rendering?: RenderingLite | null;
@@ -23494,24 +23498,26 @@ export type CreateForecastArm = {
23494
23498
  /**
23495
23499
  * _CreateLegacyArm
23496
23500
  *
23497
- * Create-information-block body for block types that don't yet have
23498
- * a typed construction path at the API boundary.
23501
+ * Create-information-block body for block types constructed through
23502
+ * another operation.
23499
23503
  *
23500
23504
  * Statement-family blocks (balance_sheet, income_statement,
23501
23505
  * cash_flow_statement, equity_statement, comprehensive_income) are
23502
23506
  * constructed via `create-report`, not this endpoint. Disclosure
23503
23507
  * structures (regulatory_disclosure) are vocabulary, authored via
23504
23508
  * `create-taxonomy-block`; their facts land when `create-report`
23505
- * picks them. Metric blocks are recognized but their evaluator has
23506
- * not shipped. Calling this endpoint with one of these block types
23507
- * returns HTTP 501 with a hint pointing to the correct construction
23508
- * path.
23509
+ * picks them. Metric structures are authored via
23510
+ * `create-taxonomy-block` and their facts written by `compute-metrics`
23511
+ * or `assert-metrics`. Reconciliation blocks are created by
23512
+ * `refresh-reconciliations`. Calling this endpoint with one of these
23513
+ * block types returns HTTP 501 with a hint pointing to the correct
23514
+ * construction path.
23509
23515
  */
23510
23516
  export type CreateLegacyArm = {
23511
23517
  /**
23512
23518
  * Block Type
23513
23519
  *
23514
- * Statement-family or metric block type. The endpoint returns 501 for these values — statements are constructed via `create-report`; metric construction is pending.
23520
+ * Statement-family, disclosure, metric or reconciliation block type. The endpoint returns 501 for these values with a hint naming the operation that constructs each.
23515
23521
  */
23516
23522
  block_type: 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'comprehensive_income' | 'regulatory_disclosure' | 'metric' | 'reconciliation';
23517
23523
  /**
@@ -23570,14 +23576,16 @@ export type DeleteForecastArm = {
23570
23576
  * a typed delete path at the API boundary.
23571
23577
  *
23572
23578
  * Statement-family blocks cannot be deleted per tenant (the underlying
23573
- * Report should be archived via the report APIs instead). Metric
23574
- * deletion is not yet implemented. Calls return HTTP 501.
23579
+ * Report should be archived via the report APIs instead). Disclosure
23580
+ * and metric structures are removed through the taxonomy-block
23581
+ * operations; a reconciliation stops holding the close through
23582
+ * `set-reconciliation-policy`. Calls return HTTP 501.
23575
23583
  */
23576
23584
  export type DeleteLegacyArm = {
23577
23585
  /**
23578
23586
  * Block Type
23579
23587
  *
23580
- * Statement-family or metric block type. Deletion returns 501 — statements are library-seeded (archive the underlying Report instead); metric deletion is pending.
23588
+ * 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.
23581
23589
  */
23582
23590
  block_type: 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'comprehensive_income' | 'regulatory_disclosure' | 'metric' | 'reconciliation';
23583
23591
  /**
@@ -23632,18 +23640,19 @@ export type UpdateForecastArm = {
23632
23640
  /**
23633
23641
  * _UpdateLegacyArm
23634
23642
  *
23635
- * Update-information-block body for block types that don't yet have
23636
- * a typed update path at the API boundary.
23643
+ * Update-information-block body for block types updated through
23644
+ * another operation.
23637
23645
  *
23638
- * Statement-family blocks are library-seeded and immutable. Metric
23639
- * block updates are not yet implemented. Calling this endpoint with
23640
- * one of these block types returns HTTP 501.
23646
+ * Statement-family blocks are library-seeded and immutable. Disclosure
23647
+ * and metric structures change through the taxonomy-block operations;
23648
+ * a reconciliation's policy through `set-reconciliation-policy`.
23649
+ * Calling this endpoint with one of these block types returns HTTP 501.
23641
23650
  */
23642
23651
  export type UpdateLegacyArm = {
23643
23652
  /**
23644
23653
  * Block Type
23645
23654
  *
23646
- * Statement-family or metric block type. Updates return 501 — statement Structures are library-seeded; metric updates are pending.
23655
+ * 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.
23647
23656
  */
23648
23657
  block_type: 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'comprehensive_income' | 'regulatory_disclosure' | 'metric' | 'reconciliation';
23649
23658
  /**
@@ -26392,7 +26401,7 @@ export type GetOperatorMetadataData = {
26392
26401
  /**
26393
26402
  * Operator Type
26394
26403
  *
26395
- * Operator type identifier (e.g., 'analyst', 'mapping')
26404
+ * Operator type identifier: 'analyst', 'mapping' or 'author'
26396
26405
  */
26397
26406
  operator_type: string;
26398
26407
  };