@robosystems/client 2.0.0 → 2.1.1
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/package.json +2 -2
- package/sdk/sdk.gen.d.ts +22 -12
- package/sdk/sdk.gen.js +37 -23
- package/sdk/sdk.gen.ts +36 -22
- package/sdk/types.gen.d.ts +366 -351
- package/sdk/types.gen.ts +366 -351
- package/sdk.gen.d.ts +22 -12
- package/sdk.gen.js +37 -23
- package/sdk.gen.ts +36 -22
- package/types.gen.d.ts +366 -351
- package/types.gen.ts +366 -351
package/types.gen.d.ts
CHANGED
|
@@ -219,17 +219,17 @@ export type ArtifactResponse = {
|
|
|
219
219
|
/**
|
|
220
220
|
* AssertMetricsRequest
|
|
221
221
|
*
|
|
222
|
-
* Request body for the
|
|
222
|
+
* Request body for the `assert-metrics` operation.
|
|
223
223
|
*
|
|
224
|
-
* The observation sibling of
|
|
224
|
+
* The observation sibling of `compute-metrics`: writes externally-
|
|
225
225
|
* observed values (usage counts, marketing numbers, hand-carried
|
|
226
|
-
* figures) into the period's standing
|
|
227
|
-
* with
|
|
226
|
+
* figures) into the period's standing `factset_type='metric'` FactSet
|
|
227
|
+
* with `AssertedProvenance`. Re-asserting a period replaces its facts
|
|
228
228
|
* — one standing FactSet per (structure, entity, period_end), the
|
|
229
229
|
* accumulating time series.
|
|
230
230
|
*
|
|
231
|
-
* Structures carrying
|
|
232
|
-
* (
|
|
231
|
+
* Structures carrying `Derive` rules are compute-owned
|
|
232
|
+
* (`compute-metrics`) and rejected — asserted and derived metric
|
|
233
233
|
* series keep disjoint structures. Asserted series are actuals; there
|
|
234
234
|
* is no scenario axis.
|
|
235
235
|
*/
|
|
@@ -280,7 +280,7 @@ export type AssertMetricsRequest = {
|
|
|
280
280
|
/**
|
|
281
281
|
* AssertMetricsResponse
|
|
282
282
|
*
|
|
283
|
-
* Response for the
|
|
283
|
+
* Response for the `assert-metrics` operation.
|
|
284
284
|
*/
|
|
285
285
|
export type AssertMetricsResponse = {
|
|
286
286
|
/**
|
|
@@ -315,7 +315,7 @@ export type AssertMetricsResponse = {
|
|
|
315
315
|
/**
|
|
316
316
|
* AssertedMetricLite
|
|
317
317
|
*
|
|
318
|
-
* One metric written by an
|
|
318
|
+
* One metric written by an `assert-metrics` run.
|
|
319
319
|
*/
|
|
320
320
|
export type AssertedMetricLite = {
|
|
321
321
|
/**
|
|
@@ -367,10 +367,10 @@ export type AssertedMetricLite = {
|
|
|
367
367
|
* One edge between two elements within a structure (parent/child
|
|
368
368
|
* presentation, calculation rollup, mapping, equivalence).
|
|
369
369
|
*
|
|
370
|
-
*
|
|
370
|
+
* `association_type` discriminates the edge semantics. Mapping edges
|
|
371
371
|
* are the user-facing path (CoA → reporting concept); presentation /
|
|
372
372
|
* calculation edges express structure layout and roll-ups.
|
|
373
|
-
*
|
|
373
|
+
* `confidence` is set on AI-suggested mappings (≥0.90 auto-approved,
|
|
374
374
|
* 0.70-0.89 flagged for review).
|
|
375
375
|
*/
|
|
376
376
|
export type AssociationResponse = {
|
|
@@ -438,11 +438,11 @@ export type AssociationResponse = {
|
|
|
438
438
|
*
|
|
439
439
|
* Pairs a target concept (the flow leaf the matched amount counts
|
|
440
440
|
* toward) with a predicate (which LineItems match). The rollforward's
|
|
441
|
-
*
|
|
441
|
+
* `attribution_filters: list[AttributionFilter]` declares every flow
|
|
442
442
|
* the BS source decomposes into; the renderer evaluates them all per
|
|
443
443
|
* period.
|
|
444
444
|
*
|
|
445
|
-
*
|
|
445
|
+
* `target_element_id` is resolved at create time from `target_qname`
|
|
446
446
|
* via the rs-gaap library + tenant taxonomy lookup. Authors only need
|
|
447
447
|
* to provide the qname; the element_id is filled in by the create
|
|
448
448
|
* handler and the resolved value is what the envelope round-trips.
|
|
@@ -451,13 +451,13 @@ export type AttributionFilter = {
|
|
|
451
451
|
/**
|
|
452
452
|
* Target Qname
|
|
453
453
|
*
|
|
454
|
-
* QName of the flow concept this filter produces facts for — e.g.
|
|
454
|
+
* QName of the flow concept this filter produces facts for — e.g. `rs-gaap:ProceedsFromIssuanceOfCommonStock`. Resolved to `target_element_id` at create time.
|
|
455
455
|
*/
|
|
456
456
|
target_qname: string;
|
|
457
457
|
/**
|
|
458
458
|
* Target Element Id
|
|
459
459
|
*
|
|
460
|
-
* Resolved element id for
|
|
460
|
+
* Resolved element id for `target_qname`. Null at create time; populated by the handler before persistence. Round-tripped in the envelope.
|
|
461
461
|
*/
|
|
462
462
|
target_element_id?: string | null;
|
|
463
463
|
/**
|
|
@@ -1399,9 +1399,9 @@ export type ChangeTierOp = {
|
|
|
1399
1399
|
*
|
|
1400
1400
|
* Server-shaped chart projection — panel/series CONFIG, never values.
|
|
1401
1401
|
*
|
|
1402
|
-
* The second real server-computed View arm (after
|
|
1403
|
-
* come from
|
|
1404
|
-
*
|
|
1402
|
+
* The second real server-computed View arm (after `rendering`). Values
|
|
1403
|
+
* come from `rendering.rows` joined by `element_id`; the x-axis is
|
|
1404
|
+
* `rendering.periods`. Renderers (report-components) turn one panel
|
|
1405
1405
|
* into one chart.
|
|
1406
1406
|
*/
|
|
1407
1407
|
export type ChartLite = {
|
|
@@ -1416,8 +1416,8 @@ export type ChartLite = {
|
|
|
1416
1416
|
* One chart panel — series sharing a y-axis format family.
|
|
1417
1417
|
*
|
|
1418
1418
|
* Mixed-unit catalogs are unplottable on one axis, so the server groups
|
|
1419
|
-
* rows into panels by
|
|
1420
|
-
*
|
|
1419
|
+
* rows into panels by `item_type` family (NULL falls back to
|
|
1420
|
+
* `is_monetary`). The x-axis is always `rendering.periods`.
|
|
1421
1421
|
*/
|
|
1422
1422
|
export type ChartPanelLite = {
|
|
1423
1423
|
/**
|
|
@@ -1449,9 +1449,9 @@ export type ChartPanelLite = {
|
|
|
1449
1449
|
* One plottable series in a chart panel.
|
|
1450
1450
|
*
|
|
1451
1451
|
* Carries structure and identity only — the values live in the sibling
|
|
1452
|
-
*
|
|
1453
|
-
* duplicates the value matrix.
|
|
1454
|
-
* client state (colors, toggles); today it equals
|
|
1452
|
+
* `rendering.rows` (join on `element_id`), so the chart arm never
|
|
1453
|
+
* duplicates the value matrix. `key` is the stable series identity for
|
|
1454
|
+
* client state (colors, toggles); today it equals `element_id`, and
|
|
1455
1455
|
* future axes (the forecast scenario) arrive as new fields on this
|
|
1456
1456
|
* model, never a new arm shape.
|
|
1457
1457
|
*/
|
|
@@ -1720,14 +1720,14 @@ export type ClosePeriodResponse = {
|
|
|
1720
1720
|
/**
|
|
1721
1721
|
* ComputeForecastRequest
|
|
1722
1722
|
*
|
|
1723
|
-
* Request body for the
|
|
1723
|
+
* Request body for the `compute-forecast` operation.
|
|
1724
1724
|
*
|
|
1725
1725
|
* Walks the scenario's driver cascade month-by-month forward from the
|
|
1726
|
-
* forecast block's
|
|
1726
|
+
* forecast block's `base_period`: lever-driven Derive rules in
|
|
1727
1727
|
* dependency order, carry-forward for unmodeled IS lines, calc-DAG
|
|
1728
1728
|
* subtotals — upserting one scenario IS FactSet (+ a working-capital BS
|
|
1729
1729
|
* set) per forward month, all keyed by the forecast block's
|
|
1730
|
-
*
|
|
1730
|
+
* `scenario_id`. Re-running replaces each month's values (the
|
|
1731
1731
|
* compute-metrics drift semantics). Deterministic and non-AI — no
|
|
1732
1732
|
* credits consumed.
|
|
1733
1733
|
*/
|
|
@@ -1754,7 +1754,7 @@ export type ComputeForecastRequest = {
|
|
|
1754
1754
|
/**
|
|
1755
1755
|
* ComputeForecastResponse
|
|
1756
1756
|
*
|
|
1757
|
-
* Response for the
|
|
1757
|
+
* Response for the `compute-forecast` operation.
|
|
1758
1758
|
*/
|
|
1759
1759
|
export type ComputeForecastResponse = {
|
|
1760
1760
|
/**
|
|
@@ -1774,13 +1774,13 @@ export type ComputeForecastResponse = {
|
|
|
1774
1774
|
/**
|
|
1775
1775
|
* Base Period
|
|
1776
1776
|
*
|
|
1777
|
-
* Origin month of the block's authored horizon window — where its levers are keyed from. Equal to
|
|
1777
|
+
* Origin month of the block's authored horizon window — where its levers are keyed from. Equal to `anchor_period` unless the walk re-anchored at the seam.
|
|
1778
1778
|
*/
|
|
1779
1779
|
base_period: string;
|
|
1780
1780
|
/**
|
|
1781
1781
|
* Anchor Period
|
|
1782
1782
|
*
|
|
1783
|
-
* Month the walk actually seeded its opening balances from. With
|
|
1783
|
+
* Month the walk actually seeded its opening balances from. With `base_anchor='seam'` this advances to the newest closed month as periods close, so the first forward month rolls off real balances instead of a stale base; with `'fixed'` it always equals `base_period`.
|
|
1784
1784
|
*/
|
|
1785
1785
|
anchor_period: string;
|
|
1786
1786
|
/**
|
|
@@ -1796,7 +1796,7 @@ export type ComputeForecastResponse = {
|
|
|
1796
1796
|
/**
|
|
1797
1797
|
* Halted At
|
|
1798
1798
|
*
|
|
1799
|
-
* Month (
|
|
1799
|
+
* Month (`YYYY-MM`) where the walk stopped because verification failed, or null if it ran the full horizon. Each month's opening balances are the previous month's closing balances, so computing past a failure yields months derived from a known-wrong one rather than merely unverified months. When set, `months_computed` ends at this month and is shorter than `months`; the failing month's facts are kept so the failure can be inspected.
|
|
1800
1800
|
*/
|
|
1801
1801
|
halted_at?: string | null;
|
|
1802
1802
|
/**
|
|
@@ -1813,12 +1813,12 @@ export type ComputeForecastResponse = {
|
|
|
1813
1813
|
/**
|
|
1814
1814
|
* ComputeMetricsRequest
|
|
1815
1815
|
*
|
|
1816
|
-
* Request body for the
|
|
1816
|
+
* Request body for the `compute-metrics` operation.
|
|
1817
1817
|
*
|
|
1818
|
-
* Resolves the
|
|
1818
|
+
* Resolves the `Derive` rules scoped to the metric block, binds each
|
|
1819
1819
|
* rule's operands to the entity's most recent persisted report facts at
|
|
1820
|
-
*
|
|
1821
|
-
*
|
|
1820
|
+
* `period_end`, evaluates, and upserts the period's standing
|
|
1821
|
+
* `factset_type='metric'` FactSet (re-running a period replaces its
|
|
1822
1822
|
* facts). One standing FactSet per (structure, entity, period_end) — the
|
|
1823
1823
|
* accumulating time series.
|
|
1824
1824
|
*/
|
|
@@ -1857,7 +1857,7 @@ export type ComputeMetricsRequest = {
|
|
|
1857
1857
|
/**
|
|
1858
1858
|
* ComputeMetricsResponse
|
|
1859
1859
|
*
|
|
1860
|
-
* Response for the
|
|
1860
|
+
* Response for the `compute-metrics` operation.
|
|
1861
1861
|
*/
|
|
1862
1862
|
export type ComputeMetricsResponse = {
|
|
1863
1863
|
/**
|
|
@@ -1890,7 +1890,7 @@ export type ComputeMetricsResponse = {
|
|
|
1890
1890
|
/**
|
|
1891
1891
|
* ComputedMetricLite
|
|
1892
1892
|
*
|
|
1893
|
-
* One metric computed by a
|
|
1893
|
+
* One metric computed by a `compute-metrics` run.
|
|
1894
1894
|
*/
|
|
1895
1895
|
export type ComputedMetricLite = {
|
|
1896
1896
|
/**
|
|
@@ -1948,7 +1948,7 @@ export type ComputedMetricLite = {
|
|
|
1948
1948
|
* Connection (= Association) projection.
|
|
1949
1949
|
*
|
|
1950
1950
|
* "Connection" is the ontology term used on the wire; the storage table is
|
|
1951
|
-
*
|
|
1951
|
+
* `associations` (`models/extensions/association.py`).
|
|
1952
1952
|
*/
|
|
1953
1953
|
export type ConnectionLite = {
|
|
1954
1954
|
/**
|
|
@@ -2276,11 +2276,11 @@ export type CreateApiKeyResponse = {
|
|
|
2276
2276
|
*
|
|
2277
2277
|
* Create a new economic counterparty.
|
|
2278
2278
|
*
|
|
2279
|
-
*
|
|
2279
|
+
* `agent_type` is the relationship category (customer, vendor,
|
|
2280
2280
|
* employee, etc.) — the same legal entity may have multiple Agent rows
|
|
2281
2281
|
* if they play multiple roles (e.g. a vendor who also became a
|
|
2282
|
-
* customer).
|
|
2283
|
-
* native-created ones;
|
|
2282
|
+
* customer). `source` distinguishes integration-imported rows from
|
|
2283
|
+
* native-created ones; `external_id` carries the source-system's
|
|
2284
2284
|
* primary key for sync.
|
|
2285
2285
|
*/
|
|
2286
2286
|
export type CreateAgentRequest = {
|
|
@@ -2557,16 +2557,16 @@ export type CreateEventBlockRequest = {
|
|
|
2557
2557
|
*
|
|
2558
2558
|
* Register a new event-type → transaction-template rule.
|
|
2559
2559
|
*
|
|
2560
|
-
* When
|
|
2560
|
+
* When `create-event-block` runs with `apply_handlers=True`, the
|
|
2561
2561
|
* registry resolves the *highest-priority active* handler whose match
|
|
2562
2562
|
* criteria all match the event, then evaluates the
|
|
2563
|
-
*
|
|
2564
|
-
* active handlers for the same
|
|
2563
|
+
* `transaction_template` to produce GL rows. Match precedence: among
|
|
2564
|
+
* active handlers for the same `event_type`, the one with the most
|
|
2565
2565
|
* specific match (more match fields satisfied) wins; ties broken by
|
|
2566
|
-
*
|
|
2566
|
+
* `priority` desc, then `created_at` asc.
|
|
2567
2567
|
*
|
|
2568
|
-
* All match fields except
|
|
2569
|
-
* unset matches anything. Use
|
|
2568
|
+
* All match fields except `event_type` are optional — leaving them
|
|
2569
|
+
* unset matches anything. Use `match_metadata_expression` for
|
|
2570
2570
|
* fine-grained discrimination (e.g. only payroll categories).
|
|
2571
2571
|
*/
|
|
2572
2572
|
export type CreateEventHandlerRequest = {
|
|
@@ -2656,8 +2656,8 @@ export type CreateEventHandlerRequest = {
|
|
|
2656
2656
|
*
|
|
2657
2657
|
* Create a forecast block — the authored scenario container.
|
|
2658
2658
|
*
|
|
2659
|
-
*
|
|
2660
|
-
*
|
|
2659
|
+
* `base_period` defaults to the fiscal calendar's
|
|
2660
|
+
* `closed_through_period` (else the newest actual report month) —
|
|
2661
2661
|
* the walk projects forward from the last closed actuals. The resolved
|
|
2662
2662
|
* value is stored in the mechanics so recompute is deterministic.
|
|
2663
2663
|
*/
|
|
@@ -2683,13 +2683,13 @@ export type CreateForecastRequest = {
|
|
|
2683
2683
|
/**
|
|
2684
2684
|
* Base Period
|
|
2685
2685
|
*
|
|
2686
|
-
* Seed month (
|
|
2686
|
+
* 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.
|
|
2687
2687
|
*/
|
|
2688
2688
|
base_period?: string | null;
|
|
2689
2689
|
/**
|
|
2690
2690
|
* Base Anchor
|
|
2691
2691
|
*
|
|
2692
|
-
* Where the walk takes its opening balances as periods close.
|
|
2692
|
+
* Where the walk takes its opening balances as periods close. `seam` (default) re-anchors on the newest closed month inside the horizon, so the scenario survives a close untouched and its first forward month rolls off real balances. `fixed` pins the walk to `base_period` — the deliberate counterfactual, whose balances are meant to diverge from actuals.
|
|
2693
2693
|
*/
|
|
2694
2694
|
base_anchor?: 'seam' | 'fixed';
|
|
2695
2695
|
/**
|
|
@@ -2897,15 +2897,15 @@ export type CreatePublishListRequest = {
|
|
|
2897
2897
|
*
|
|
2898
2898
|
* The report is materialized synchronously: we resolve the taxonomy +
|
|
2899
2899
|
* CoA mapping, roll up GL facts into reportable concepts, attach them
|
|
2900
|
-
* to a fresh
|
|
2901
|
-
* (cell-level checks), and stamp
|
|
2902
|
-
* Subsequent
|
|
2900
|
+
* to a fresh `Report` row, evaluate any reporting-rule structures
|
|
2901
|
+
* (cell-level checks), and stamp `generation_status='published'`.
|
|
2902
|
+
* Subsequent `regenerate-report` calls re-run the same pipeline against
|
|
2903
2903
|
* the latest ledger state without creating a new Report row.
|
|
2904
2904
|
*
|
|
2905
|
-
*
|
|
2905
|
+
* `period_start`/`period_end`/`comparative` is the simple path
|
|
2906
2906
|
* (auto-derives current + prior period). For multi-column reports
|
|
2907
|
-
* (YTD-by-quarter, multi-year) supply
|
|
2908
|
-
* set,
|
|
2907
|
+
* (YTD-by-quarter, multi-year) supply `periods` explicitly — when
|
|
2908
|
+
* set, `period_start`/`period_end`/`comparative` are ignored as
|
|
2909
2909
|
* inputs to period generation.
|
|
2910
2910
|
*/
|
|
2911
2911
|
export type CreateReportRequest = {
|
|
@@ -2983,7 +2983,7 @@ export type CreateRepositorySubscriptionRequest = {
|
|
|
2983
2983
|
* Create a rollforward Information Block.
|
|
2984
2984
|
*
|
|
2985
2985
|
* Mirrors :class:`CreateScheduleRequest` in shape. The block decomposes
|
|
2986
|
-
* the period change in
|
|
2986
|
+
* the period change in `bs_source_qname` across the declared
|
|
2987
2987
|
* attribution filters. Residual (Δ BS - Σ filter matches) falls back to
|
|
2988
2988
|
* the default change tag — or, if no default is declared, surfaces as
|
|
2989
2989
|
* an unattributed fact tagged with a synthetic residual concept.
|
|
@@ -2998,7 +2998,7 @@ export type CreateRollforwardRequest = {
|
|
|
2998
2998
|
/**
|
|
2999
2999
|
* Bs Source Qname
|
|
3000
3000
|
*
|
|
3001
|
-
* QName of the balance-sheet element whose period delta this block decomposes. Resolved to
|
|
3001
|
+
* QName of the balance-sheet element whose period delta this block decomposes. Resolved to `bs_source_element_id` at create time.
|
|
3002
3002
|
*/
|
|
3003
3003
|
bs_source_qname: string;
|
|
3004
3004
|
/**
|
|
@@ -3016,13 +3016,13 @@ export type CreateRollforwardRequest = {
|
|
|
3016
3016
|
/**
|
|
3017
3017
|
* Validation Mode
|
|
3018
3018
|
*
|
|
3019
|
-
* How the renderer arbitrates when Σ filter matches != Δ BS.
|
|
3019
|
+
* How the renderer arbitrates when Σ filter matches != Δ BS. `strict` raises; `residual_as_default` emits the residual as a default-tag fact (the common case); `warn_only` logs and lets the imbalance pass.
|
|
3020
3020
|
*/
|
|
3021
3021
|
validation_mode?: 'strict' | 'residual_as_default' | 'warn_only';
|
|
3022
3022
|
/**
|
|
3023
3023
|
* Taxonomy Id
|
|
3024
3024
|
*
|
|
3025
|
-
* Owning taxonomy id (auto-resolved from
|
|
3025
|
+
* Owning taxonomy id (auto-resolved from `bs_source_qname` when omitted).
|
|
3026
3026
|
*/
|
|
3027
3027
|
taxonomy_id?: string | null;
|
|
3028
3028
|
};
|
|
@@ -3195,14 +3195,14 @@ export type CreateSubgraphRequest = {
|
|
|
3195
3195
|
/**
|
|
3196
3196
|
* CreateTaxonomyBlockRequest
|
|
3197
3197
|
*
|
|
3198
|
-
* Request body for the
|
|
3198
|
+
* Request body for the `create-taxonomy-block` operation.
|
|
3199
3199
|
*
|
|
3200
|
-
* One envelope per taxonomy instance.
|
|
3200
|
+
* One envelope per taxonomy instance. `taxonomy_type` discriminates
|
|
3201
3201
|
* which block-type handler the command dispatcher routes to.
|
|
3202
|
-
*
|
|
3202
|
+
* `parent_taxonomy_id` is required for `reporting_extension` (which
|
|
3203
3203
|
* extends a library taxonomy) and ignored otherwise.
|
|
3204
3204
|
*
|
|
3205
|
-
* The library path (seeding
|
|
3205
|
+
* The library path (seeding `reporting_standard` rows) does NOT flow
|
|
3206
3206
|
* through this envelope; library content is not tenant-writable here.
|
|
3207
3207
|
*/
|
|
3208
3208
|
export type CreateTaxonomyBlockRequest = {
|
|
@@ -3215,13 +3215,13 @@ export type CreateTaxonomyBlockRequest = {
|
|
|
3215
3215
|
/**
|
|
3216
3216
|
* Taxonomy Type
|
|
3217
3217
|
*
|
|
3218
|
-
* Block-type discriminator.
|
|
3218
|
+
* Block-type discriminator. `chart_of_accounts` and `custom_ontology` construct from scratch; `reporting_extension` extends an existing library `reporting_standard`.
|
|
3219
3219
|
*/
|
|
3220
3220
|
taxonomy_type: 'reporting_standard' | 'reporting_extension' | 'custom_ontology' | 'chart_of_accounts' | 'schedule';
|
|
3221
3221
|
/**
|
|
3222
3222
|
* Parent Taxonomy Id
|
|
3223
3223
|
*
|
|
3224
|
-
* Required when
|
|
3224
|
+
* Required when `taxonomy_type == 'reporting_extension'` — the id of the library `reporting_standard` being extended.
|
|
3225
3225
|
*/
|
|
3226
3226
|
parent_taxonomy_id?: string | null;
|
|
3227
3227
|
/**
|
|
@@ -3453,7 +3453,7 @@ export type CreditSummaryResponse = {
|
|
|
3453
3453
|
* Custom node and relationship types for a generic graph.
|
|
3454
3454
|
*
|
|
3455
3455
|
* For graphs that don't fit the entity-based schema — inventory, org charts,
|
|
3456
|
-
* project management.
|
|
3456
|
+
* project management. `extends` names a base schema to build on, or is
|
|
3457
3457
|
* omitted for a bare database.
|
|
3458
3458
|
*/
|
|
3459
3459
|
export type CustomSchemaDefinition = {
|
|
@@ -3871,7 +3871,7 @@ export type DeleteInformationBlockRequest = ({
|
|
|
3871
3871
|
/**
|
|
3872
3872
|
* DeleteInformationBlockResponse
|
|
3873
3873
|
*
|
|
3874
|
-
* Response for
|
|
3874
|
+
* Response for `delete-information-block`.
|
|
3875
3875
|
*
|
|
3876
3876
|
* The envelope is gone once the block is deleted, so the response is a
|
|
3877
3877
|
* thin confirmation instead — structure_id + block_type + name for
|
|
@@ -4011,7 +4011,7 @@ export type DeleteReportOperation = {
|
|
|
4011
4011
|
*
|
|
4012
4012
|
* Shared response shape for delete / soft-delete operations.
|
|
4013
4013
|
*
|
|
4014
|
-
*
|
|
4014
|
+
* `deleted=True` means the operation succeeded (a row was deleted or
|
|
4015
4015
|
* flipped). A row that never existed gets a 404 — this shape never carries
|
|
4016
4016
|
* "not found".
|
|
4017
4017
|
*
|
|
@@ -4103,12 +4103,12 @@ export type DeleteSubgraphOp = {
|
|
|
4103
4103
|
/**
|
|
4104
4104
|
* DeleteTaxonomyBlockRequest
|
|
4105
4105
|
*
|
|
4106
|
-
* Request body for the
|
|
4106
|
+
* Request body for the `delete-taxonomy-block` operation.
|
|
4107
4107
|
*
|
|
4108
|
-
*
|
|
4109
|
-
* reference elements in this taxonomy.
|
|
4108
|
+
* `cascade_facts=False` (default) fails the delete if any Fact rows
|
|
4109
|
+
* reference elements in this taxonomy. `cascade_facts=True` deletes the
|
|
4110
4110
|
* referencing facts alongside the taxonomy; the response reports
|
|
4111
|
-
*
|
|
4111
|
+
* `facts_deleted`.
|
|
4112
4112
|
*/
|
|
4113
4113
|
export type DeleteTaxonomyBlockRequest = {
|
|
4114
4114
|
/**
|
|
@@ -4133,7 +4133,7 @@ export type DeleteTaxonomyBlockRequest = {
|
|
|
4133
4133
|
/**
|
|
4134
4134
|
* DeleteTaxonomyBlockResponse
|
|
4135
4135
|
*
|
|
4136
|
-
* Response for
|
|
4136
|
+
* Response for `delete-taxonomy-block`.
|
|
4137
4137
|
*/
|
|
4138
4138
|
export type DeleteTaxonomyBlockResponse = {
|
|
4139
4139
|
/**
|
|
@@ -4256,8 +4256,8 @@ export type DisclosuresRequest = {
|
|
|
4256
4256
|
* The disclosures view op's result: xbrlkit's map, stamped with the graph
|
|
4257
4257
|
* and report it was read from.
|
|
4258
4258
|
*
|
|
4259
|
-
* Without
|
|
4260
|
-
*
|
|
4259
|
+
* Without `topic`: `disclosures` / `count`. With `topic`:
|
|
4260
|
+
* `disclosure` / `category` / `blocks` / `block_count`.
|
|
4261
4261
|
*/
|
|
4262
4262
|
export type DisclosuresResponse = {
|
|
4263
4263
|
/**
|
|
@@ -4449,7 +4449,7 @@ export type DocumentListResponse = {
|
|
|
4449
4449
|
* DocumentSection
|
|
4450
4450
|
*
|
|
4451
4451
|
* Full document section retrieved by ID — one part of it when the section
|
|
4452
|
-
* is long;
|
|
4452
|
+
* is long; `next_document_id` continues it.
|
|
4453
4453
|
*/
|
|
4454
4454
|
export type DocumentSection = {
|
|
4455
4455
|
/**
|
|
@@ -4950,15 +4950,15 @@ export type ErrorResponse = {
|
|
|
4950
4950
|
/**
|
|
4951
4951
|
* EvaluateRulesRequest
|
|
4952
4952
|
*
|
|
4953
|
-
* Request body for the
|
|
4953
|
+
* Request body for the `evaluate-rules` operation.
|
|
4954
4954
|
*
|
|
4955
|
-
* Runs every rule scoped to
|
|
4956
|
-
* scoped rules for the structure's atoms), binds
|
|
4955
|
+
* Runs every rule scoped to `structure_id` (plus element/association-
|
|
4956
|
+
* scoped rules for the structure's atoms), binds `$Variable` references
|
|
4957
4957
|
* to facts via qname lookup, and writes one
|
|
4958
4958
|
* :class:`VerificationResult` row per rule.
|
|
4959
4959
|
*
|
|
4960
|
-
* Optional
|
|
4961
|
-
* window; without them the engine uses the most recent
|
|
4960
|
+
* Optional `period_start` / `period_end` narrow the fact-binding
|
|
4961
|
+
* window; without them the engine uses the most recent `in_scope` fact
|
|
4962
4962
|
* for each element regardless of period.
|
|
4963
4963
|
*/
|
|
4964
4964
|
export type EvaluateRulesRequest = {
|
|
@@ -4990,10 +4990,10 @@ export type EvaluateRulesRequest = {
|
|
|
4990
4990
|
/**
|
|
4991
4991
|
* EvaluateRulesResponse
|
|
4992
4992
|
*
|
|
4993
|
-
* Response for the
|
|
4993
|
+
* Response for the `evaluate-rules` operation.
|
|
4994
4994
|
*
|
|
4995
|
-
*
|
|
4996
|
-
* written by this evaluation run.
|
|
4995
|
+
* `results` is the full list of :class:`VerificationResultLite` rows
|
|
4996
|
+
* written by this evaluation run. `summary` gives counts keyed by
|
|
4997
4997
|
* status for quick display without iterating the list.
|
|
4998
4998
|
*/
|
|
4999
4999
|
export type EvaluateRulesResponse = {
|
|
@@ -5008,7 +5008,7 @@ export type EvaluateRulesResponse = {
|
|
|
5008
5008
|
/**
|
|
5009
5009
|
* Summary
|
|
5010
5010
|
*
|
|
5011
|
-
* Status counts keyed by outcome string:
|
|
5011
|
+
* Status counts keyed by outcome string: `{'pass': N, 'fail': N, 'error': N, 'skipped': N}`.
|
|
5012
5012
|
*/
|
|
5013
5013
|
summary?: {
|
|
5014
5014
|
[key: string]: number;
|
|
@@ -5344,7 +5344,7 @@ export type ExecuteEventBlockResponse = {
|
|
|
5344
5344
|
* run: the connection is registration + telemetry, not execution config.
|
|
5345
5345
|
* The platform holds no credentials for the external source — the
|
|
5346
5346
|
* integration authenticates to its own source and writes here through
|
|
5347
|
-
* the public API, stamping
|
|
5347
|
+
* the public API, stamping `source_name` on everything it emits.
|
|
5348
5348
|
*/
|
|
5349
5349
|
export type ExternalConnectionConfig = {
|
|
5350
5350
|
/**
|
|
@@ -5497,8 +5497,8 @@ export type FactRecord = {
|
|
|
5497
5497
|
*
|
|
5498
5498
|
* FactSet projection — period-specific instantiation of the Structure.
|
|
5499
5499
|
*
|
|
5500
|
-
* The envelope carries one
|
|
5501
|
-
* for the requested period, and leaves
|
|
5500
|
+
* The envelope carries one `FactSetLite` per block when a FactSet row exists
|
|
5501
|
+
* for the requested period, and leaves `fact_set` null when none does.
|
|
5502
5502
|
*/
|
|
5503
5503
|
export type FactSetLite = {
|
|
5504
5504
|
/**
|
|
@@ -5520,7 +5520,7 @@ export type FactSetLite = {
|
|
|
5520
5520
|
/**
|
|
5521
5521
|
* Factset Type
|
|
5522
5522
|
*
|
|
5523
|
-
* 'report' | 'schedule' | 'custom' | 'disclosure' | 'metric'. Enum closure enforced by the
|
|
5523
|
+
* 'report' | 'schedule' | 'custom' | 'disclosure' | 'metric'. Enum closure enforced by the `public.fact_sets` CHECK constraint.
|
|
5524
5524
|
*/
|
|
5525
5525
|
factset_type: string;
|
|
5526
5526
|
/**
|
|
@@ -5530,7 +5530,7 @@ export type FactSetLite = {
|
|
|
5530
5530
|
/**
|
|
5531
5531
|
* Report Id
|
|
5532
5532
|
*
|
|
5533
|
-
* Back-pointer to the parent row in
|
|
5533
|
+
* Back-pointer to the parent row in `reports`. Null when the FactSet does not belong to a report package.
|
|
5534
5534
|
*/
|
|
5535
5535
|
report_id?: string | null;
|
|
5536
5536
|
/**
|
|
@@ -5542,7 +5542,7 @@ export type FactSetLite = {
|
|
|
5542
5542
|
/**
|
|
5543
5543
|
* Provenance
|
|
5544
5544
|
*
|
|
5545
|
-
* Typed
|
|
5545
|
+
* Typed `FactProvenance` descriptor (discriminated on `origin`: pivot | schedule | derived | asserted | document | forecast | filed) recording how this FactSet's facts were constructed. Surfaced as JSON, mirroring how mechanics is exposed. Null when the FactSet carries no descriptor.
|
|
5546
5546
|
*/
|
|
5547
5547
|
provenance?: {
|
|
5548
5548
|
[key: string]: unknown;
|
|
@@ -5645,13 +5645,13 @@ export type FileLayerStatus = {
|
|
|
5645
5645
|
/**
|
|
5646
5646
|
* FileReportRequest
|
|
5647
5647
|
*
|
|
5648
|
-
* Transition a Report to
|
|
5648
|
+
* Transition a Report to `filed` — locks the package.
|
|
5649
5649
|
*
|
|
5650
|
-
* Acceptable from
|
|
5651
|
-
*
|
|
5650
|
+
* Acceptable from `draft` or `under_review`. `filed_by` and
|
|
5651
|
+
* `filed_at` are stamped from the auth context + server clock; the
|
|
5652
5652
|
* request itself carries no fields today (kept as a model for OpenAPI
|
|
5653
5653
|
* shape consistency and to avoid breaking changes if we add fields).
|
|
5654
|
-
* Use
|
|
5654
|
+
* Use `transition-filing-status` for the non-file legs of the
|
|
5655
5655
|
* lifecycle (`draft ↔ under_review`, `filed → archived`).
|
|
5656
5656
|
*/
|
|
5657
5657
|
export type FileReportRequest = {
|
|
@@ -5888,8 +5888,8 @@ export type FiscalCalendarResponse = {
|
|
|
5888
5888
|
*
|
|
5889
5889
|
* One fiscal period row — header view used in calendar listings.
|
|
5890
5890
|
*
|
|
5891
|
-
* Status lifecycle:
|
|
5892
|
-
* is the transient state during a close run;
|
|
5891
|
+
* Status lifecycle: `open` → `closing` → `closed`. `closing`
|
|
5892
|
+
* is the transient state during a close run; `closed_at` stamps when
|
|
5893
5893
|
* the lock landed.
|
|
5894
5894
|
*/
|
|
5895
5895
|
export type FiscalPeriodSummary = {
|
|
@@ -5927,17 +5927,17 @@ export type FiscalPeriodSummary = {
|
|
|
5927
5927
|
/**
|
|
5928
5928
|
* ForecastMechanics
|
|
5929
5929
|
*
|
|
5930
|
-
* Authored scenario container for
|
|
5930
|
+
* Authored scenario container for `block_type='forecast'`.
|
|
5931
5931
|
*
|
|
5932
|
-
* The block IS the scenario: its structure id is the
|
|
5932
|
+
* The block IS the scenario: its structure id is the `scenario_id`
|
|
5933
5933
|
* every derived forward FactSet carries (NULL = actuals). The authored
|
|
5934
5934
|
* surface is exactly this — scenario identity, horizon, base period,
|
|
5935
5935
|
* lever assertions; everything downstream is derived by
|
|
5936
|
-
*
|
|
5936
|
+
* `compute-forecast` (levers → driven rs-gaap anchors via the
|
|
5937
5937
|
* rs-driver Derive rules → carry-forward for unmodeled IS lines →
|
|
5938
5938
|
* calc-DAG subtotals), landing in the EXISTING statement/metric block
|
|
5939
5939
|
* types stamped with the scenario. Reads directly from the typed
|
|
5940
|
-
*
|
|
5940
|
+
* `structures.artifact_mechanics` JSONB column.
|
|
5941
5941
|
*/
|
|
5942
5942
|
export type ForecastMechanics = {
|
|
5943
5943
|
/**
|
|
@@ -5959,13 +5959,13 @@ export type ForecastMechanics = {
|
|
|
5959
5959
|
/**
|
|
5960
5960
|
* Base Period
|
|
5961
5961
|
*
|
|
5962
|
-
* Origin month (
|
|
5962
|
+
* Origin month (`YYYY-MM`) of the authored horizon window — resolved at create time (request → fiscal calendar closed-through → newest actual report month) and stored so recompute is deterministic. Every lever, line assertion and growth rate is keyed to a month in `base_period + 1 … base_period + horizon_months`, so this never moves on its own; `base_anchor` decides whether the *walk* still seeds here.
|
|
5963
5963
|
*/
|
|
5964
5964
|
base_period: string;
|
|
5965
5965
|
/**
|
|
5966
5966
|
* Base Anchor
|
|
5967
5967
|
*
|
|
5968
|
-
* Where the walk takes its opening balances.
|
|
5968
|
+
* Where the walk takes its opening balances. `seam` (default) re-anchors on the newest closed month at or after `base_period`, so a scenario survives a period close without being rebuilt and its first forward month rolls off real balances. `fixed` pins the walk to `base_period` — the deliberate counterfactual (“if we had restarted in July”), whose balances diverge from actuals on purpose.
|
|
5969
5969
|
*/
|
|
5970
5970
|
base_anchor?: 'seam' | 'fixed';
|
|
5971
5971
|
/**
|
|
@@ -5996,13 +5996,13 @@ export type ForecastMechanics = {
|
|
|
5996
5996
|
/**
|
|
5997
5997
|
* ForecastMonthLite
|
|
5998
5998
|
*
|
|
5999
|
-
* One computed forward month in a
|
|
5999
|
+
* One computed forward month in a `compute-forecast` response.
|
|
6000
6000
|
*/
|
|
6001
6001
|
export type ForecastMonthLite = {
|
|
6002
6002
|
/**
|
|
6003
6003
|
* Period
|
|
6004
6004
|
*
|
|
6005
|
-
* Month key (
|
|
6005
|
+
* Month key (`YYYY-MM`).
|
|
6006
6006
|
*/
|
|
6007
6007
|
period: string;
|
|
6008
6008
|
/**
|
|
@@ -6040,7 +6040,7 @@ export type ForecastMonthLite = {
|
|
|
6040
6040
|
/**
|
|
6041
6041
|
* Verification Passed
|
|
6042
6042
|
*
|
|
6043
|
-
* Whether every rule evaluated against the month's scenario sets passed. Three states, and the third is not the first:
|
|
6043
|
+
* Whether every rule evaluated against the month's scenario sets passed. Three states, and the third is not the first: `true` = rules ran and all passed; `false` = at least one failed or errored, which halts the walk (see `halted_at`); `null` = **no rules ran**, so the month is unverified rather than verified. Treat null as absence of evidence, never as a pass.
|
|
6044
6044
|
*/
|
|
6045
6045
|
verification_passed?: boolean | null;
|
|
6046
6046
|
/**
|
|
@@ -7051,7 +7051,7 @@ export type HealthStatus = {
|
|
|
7051
7051
|
*
|
|
7052
7052
|
* Body for index-document (corpus content-op).
|
|
7053
7053
|
*
|
|
7054
|
-
* Create a new document when
|
|
7054
|
+
* Create a new document when `document_id` is absent; update the named
|
|
7055
7055
|
* document (partial — only supplied fields) when present.
|
|
7056
7056
|
*/
|
|
7057
7057
|
export type IndexDocumentOp = {
|
|
@@ -7182,11 +7182,11 @@ export type InformationBlockEnvelope = {
|
|
|
7182
7182
|
*/
|
|
7183
7183
|
verification_results?: Array<VerificationResultLite>;
|
|
7184
7184
|
/**
|
|
7185
|
-
* Server-computed aggregate over
|
|
7185
|
+
* Server-computed aggregate over `verification_results` — overall pass/fail/error/skip counts plus a per-rule_category breakdown for the grouped Verification Results panel. Null when the block has no verification results.
|
|
7186
7186
|
*/
|
|
7187
7187
|
verification_summary?: VerificationSummary | null;
|
|
7188
7188
|
/**
|
|
7189
|
-
* Server-computed view projections (Charlie's six type-of View arms).
|
|
7189
|
+
* Server-computed view projections (Charlie's six type-of View arms). `view.rendering` carries pre-computed rows + periods + validation for blocks where rendering is deterministic (the statement family today). Other projections come online as their backend support lands — see :class:`ViewProjections`.
|
|
7190
7190
|
*/
|
|
7191
7191
|
view?: ViewProjections;
|
|
7192
7192
|
};
|
|
@@ -7361,7 +7361,7 @@ export type InformationModelResponse = {
|
|
|
7361
7361
|
* Body for ingest-file (raw→staging content flow).
|
|
7362
7362
|
*
|
|
7363
7363
|
* Marks an uploaded file ready and triggers DuckDB staging. Set
|
|
7364
|
-
*
|
|
7364
|
+
* `ingest_to_graph` to auto-chain graph materialization after staging.
|
|
7365
7365
|
*/
|
|
7366
7366
|
export type IngestFileOp = {
|
|
7367
7367
|
/**
|
|
@@ -7464,10 +7464,10 @@ export type InitialEntityData = {
|
|
|
7464
7464
|
*
|
|
7465
7465
|
* Create the graph's chart of accounts from a shipped template.
|
|
7466
7466
|
*
|
|
7467
|
-
* Refused (409) when the graph already has an active
|
|
7467
|
+
* Refused (409) when the graph already has an active `chart_of_accounts`
|
|
7468
7468
|
* taxonomy — a QuickBooks-synced tenant never needs this, and a chart is
|
|
7469
7469
|
* never replaced. The template's equity rows are mapped by the entity's
|
|
7470
|
-
* legal form (
|
|
7470
|
+
* legal form (`entity_type`: corporation / llc / partnership); omit it
|
|
7471
7471
|
* to use the graph's primary entity, falling back to corporation.
|
|
7472
7472
|
*/
|
|
7473
7473
|
export type InitializeChartOfAccountsRequest = {
|
|
@@ -7541,16 +7541,16 @@ export type InitializeChartOfAccountsResponse = {
|
|
|
7541
7541
|
* One-time setup for a graph's fiscal calendar.
|
|
7542
7542
|
*
|
|
7543
7543
|
* Creates the `FiscalCalendar` row, seeds `FiscalPeriod` rows from
|
|
7544
|
-
*
|
|
7545
|
-
* and stamps periods on or before
|
|
7544
|
+
* `earliest_data_period` (or 24 months ago) through the current month,
|
|
7545
|
+
* and stamps periods on or before `closed_through` as already closed.
|
|
7546
7546
|
* Subsequent calls return 409 — there's no re-initialize.
|
|
7547
7547
|
*
|
|
7548
7548
|
* The two pointers it sets up:
|
|
7549
7549
|
*
|
|
7550
|
-
* -
|
|
7550
|
+
* - `closed_through` (system-maintained): the latest period whose
|
|
7551
7551
|
* books are locked. Set on init for businesses with prior close
|
|
7552
7552
|
* history; null for a fresh start.
|
|
7553
|
-
* -
|
|
7553
|
+
* - `close_target` (user-controlled): the goal date the user is
|
|
7554
7554
|
* closing toward. Set independently via `set-close-target`.
|
|
7555
7555
|
*/
|
|
7556
7556
|
export type InitializeLedgerRequest = {
|
|
@@ -7857,7 +7857,7 @@ export type JournalEntryLineItemInput = {
|
|
|
7857
7857
|
/**
|
|
7858
7858
|
* Metadata
|
|
7859
7859
|
*
|
|
7860
|
-
* Optional per-line metadata stamped on
|
|
7860
|
+
* 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.
|
|
7861
7861
|
*/
|
|
7862
7862
|
metadata?: {
|
|
7863
7863
|
[key: string]: unknown;
|
|
@@ -8224,14 +8224,14 @@ export type LedgerEntityResponse = {
|
|
|
8224
8224
|
/**
|
|
8225
8225
|
* LeverAssertionLite
|
|
8226
8226
|
*
|
|
8227
|
-
* One lever's persisted assertion inside
|
|
8227
|
+
* One lever's persisted assertion inside `ForecastMechanics`.
|
|
8228
8228
|
*
|
|
8229
|
-
* The create handler expands the wire-level assertion (uniform
|
|
8230
|
-
* + per-month overrides) into the explicit
|
|
8229
|
+
* The create handler expands the wire-level assertion (uniform `value`
|
|
8230
|
+
* + per-month overrides) into the explicit `values_by_period` map so
|
|
8231
8231
|
* compute never interpolates — every asserted month is stated. The
|
|
8232
8232
|
* values are duplicated as authored facts in the scenario's lever
|
|
8233
8233
|
* FactSet (rules for mechanics, **facts for values** — the facts are
|
|
8234
|
-
* what
|
|
8234
|
+
* what `compute-forecast` binds); this mechanics copy is the
|
|
8235
8235
|
* operator-legible round-trip shape.
|
|
8236
8236
|
*/
|
|
8237
8237
|
export type LeverAssertionLite = {
|
|
@@ -8256,7 +8256,7 @@ export type LeverAssertionLite = {
|
|
|
8256
8256
|
/**
|
|
8257
8257
|
* Values By Period
|
|
8258
8258
|
*
|
|
8259
|
-
* Expanded per-month assertions keyed by
|
|
8259
|
+
* Expanded per-month assertions keyed by `YYYY-MM`.
|
|
8260
8260
|
*/
|
|
8261
8261
|
values_by_period: {
|
|
8262
8262
|
[key: string]: number;
|
|
@@ -8267,20 +8267,20 @@ export type LeverAssertionLite = {
|
|
|
8267
8267
|
*
|
|
8268
8268
|
* One lever's asserted values for the scenario.
|
|
8269
8269
|
*
|
|
8270
|
-
*
|
|
8270
|
+
* `qname` must resolve to an `rs-driver:*` catalog element (the
|
|
8271
8271
|
* create handler rejects anything else). Each lever's value semantics
|
|
8272
8272
|
* are defined by its catalog element's documentation — surfaced as
|
|
8273
|
-
*
|
|
8274
|
-
* envelope (
|
|
8273
|
+
* `documentation` on the elements bundled in the forecast block's
|
|
8274
|
+
* envelope (`get-information-block`). Percent levers are decimals but
|
|
8275
8275
|
* their *meaning* varies by lever: growth levers are month-over-month
|
|
8276
|
-
* rates (
|
|
8276
|
+
* rates (`RevenueGrowthRate` 0.03 = +3%/month, compounding), while
|
|
8277
8277
|
* rate-on-base levers are fractions of the same month's base
|
|
8278
|
-
* (
|
|
8279
|
-
* revenues — not a growth rate). Days levers (
|
|
8280
|
-
*
|
|
8278
|
+
* (`CostOfRevenueRate` 0.62 = cost of revenue at 62% of that month's
|
|
8279
|
+
* revenues — not a growth rate). Days levers (`DaysSalesOutstanding`,
|
|
8280
|
+
* `DaysPayableOutstanding`) are day counts.
|
|
8281
8281
|
*
|
|
8282
|
-
*
|
|
8283
|
-
*
|
|
8282
|
+
* `value` is a uniform fill across the whole horizon;
|
|
8283
|
+
* `values_by_period` overrides individual months (`"YYYY-MM"`
|
|
8284
8284
|
* keys) — e.g. a margin-compression ramp asserts a different rate each
|
|
8285
8285
|
* month. At least one of the two must be provided. Months covered by
|
|
8286
8286
|
* neither carry no assertion — the lever's rule is inactive for that
|
|
@@ -8290,7 +8290,7 @@ export type LeverAssertionRequest = {
|
|
|
8290
8290
|
/**
|
|
8291
8291
|
* Qname
|
|
8292
8292
|
*
|
|
8293
|
-
* QName of the rs-driver lever element (e.g.
|
|
8293
|
+
* QName of the rs-driver lever element (e.g. `rs-driver:RevenueGrowthRate`).
|
|
8294
8294
|
*/
|
|
8295
8295
|
qname: string;
|
|
8296
8296
|
/**
|
|
@@ -8302,7 +8302,7 @@ export type LeverAssertionRequest = {
|
|
|
8302
8302
|
/**
|
|
8303
8303
|
* Values By Period
|
|
8304
8304
|
*
|
|
8305
|
-
* Per-month overrides keyed by
|
|
8305
|
+
* Per-month overrides keyed by `YYYY-MM`. Wins over `value` for the months it names.
|
|
8306
8306
|
*/
|
|
8307
8307
|
values_by_period?: {
|
|
8308
8308
|
[key: string]: number;
|
|
@@ -8312,20 +8312,20 @@ export type LeverAssertionRequest = {
|
|
|
8312
8312
|
* LineAssertionLite
|
|
8313
8313
|
*
|
|
8314
8314
|
* One statement line's persisted direct assertion inside
|
|
8315
|
-
*
|
|
8315
|
+
* `ForecastMechanics`.
|
|
8316
8316
|
*
|
|
8317
8317
|
* The manual-override sibling of :class:`LeverAssertionLite`: a lever
|
|
8318
8318
|
* asserts a *driver* whose rule derives a line; a line assertion pins
|
|
8319
8319
|
* the **line itself** (a calc-DAG leaf) to typed values for the months
|
|
8320
8320
|
* it names — winning over driver rules and carry-forward for exactly
|
|
8321
8321
|
* those months (a displaced rule surfaces in the compute response's
|
|
8322
|
-
*
|
|
8322
|
+
* `skipped` list). Subtotals stay calc-DAG-derived, so a manual line
|
|
8323
8323
|
* still articulates through RollUps, RE, balancing cash, and derived
|
|
8324
8324
|
* CF, and stays verification-gated.
|
|
8325
8325
|
*
|
|
8326
8326
|
* Same persistence doctrine as levers: values are duplicated as
|
|
8327
8327
|
* authored facts in the scenario's lever FactSet (facts are what
|
|
8328
|
-
*
|
|
8328
|
+
* `compute-forecast` binds); this mechanics copy is the
|
|
8329
8329
|
* operator-legible round-trip shape.
|
|
8330
8330
|
*/
|
|
8331
8331
|
export type LineAssertionLite = {
|
|
@@ -8356,7 +8356,7 @@ export type LineAssertionLite = {
|
|
|
8356
8356
|
/**
|
|
8357
8357
|
* Values By Period
|
|
8358
8358
|
*
|
|
8359
|
-
* Expanded per-month assertions keyed by
|
|
8359
|
+
* Expanded per-month assertions keyed by `YYYY-MM`.
|
|
8360
8360
|
*/
|
|
8361
8361
|
values_by_period: {
|
|
8362
8362
|
[key: string]: number;
|
|
@@ -8372,7 +8372,7 @@ export type LineAssertionLite = {
|
|
|
8372
8372
|
* line assertion asserts the **line itself** — an rs-gaap (or tenant
|
|
8373
8373
|
* extension) statement leaf pinned to typed values for the months it
|
|
8374
8374
|
* names. Assertions win over driver rules and carry-forward for those
|
|
8375
|
-
* months (a displaced rule lands in
|
|
8375
|
+
* months (a displaced rule lands in `skipped`, legibly); months the
|
|
8376
8376
|
* assertion doesn't name keep the engine's normal derivation.
|
|
8377
8377
|
*
|
|
8378
8378
|
* **Leaves only** — subtotals stay calc-DAG-derived, so a manually set
|
|
@@ -8380,8 +8380,8 @@ export type LineAssertionLite = {
|
|
|
8380
8380
|
* derived CF, and stays verification-gated (the whole pitch vs a
|
|
8381
8381
|
* spreadsheet cell). The create handler rejects calc-parent qnames.
|
|
8382
8382
|
*
|
|
8383
|
-
* Value/period grammar is identical to levers:
|
|
8384
|
-
* fill across the horizon,
|
|
8383
|
+
* Value/period grammar is identical to levers: `value` is a uniform
|
|
8384
|
+
* fill across the horizon, `values_by_period` overrides individual
|
|
8385
8385
|
* months. The canonical uses: zero out a base-month one-off so
|
|
8386
8386
|
* carry-forward stops replicating it, or hold a line at a known budget
|
|
8387
8387
|
* number no driver models.
|
|
@@ -8390,7 +8390,7 @@ export type LineAssertionRequest = {
|
|
|
8390
8390
|
/**
|
|
8391
8391
|
* Qname
|
|
8392
8392
|
*
|
|
8393
|
-
* QName of the statement leaf to assert (e.g.
|
|
8393
|
+
* QName of the statement leaf to assert (e.g. `rs-gaap:NonoperatingIncomeExpense`). Must be a calc-DAG leaf; rs-driver concepts belong in `levers`.
|
|
8394
8394
|
*/
|
|
8395
8395
|
qname: string;
|
|
8396
8396
|
/**
|
|
@@ -8402,7 +8402,7 @@ export type LineAssertionRequest = {
|
|
|
8402
8402
|
/**
|
|
8403
8403
|
* Values By Period
|
|
8404
8404
|
*
|
|
8405
|
-
* Per-month overrides keyed by
|
|
8405
|
+
* Per-month overrides keyed by `YYYY-MM`. Wins over `value` for the months it names.
|
|
8406
8406
|
*/
|
|
8407
8407
|
values_by_period?: {
|
|
8408
8408
|
[key: string]: number;
|
|
@@ -8412,19 +8412,19 @@ export type LineAssertionRequest = {
|
|
|
8412
8412
|
* LineGrowthLite
|
|
8413
8413
|
*
|
|
8414
8414
|
* One statement line's persisted growth trajectory inside
|
|
8415
|
-
*
|
|
8415
|
+
* `ForecastMechanics`.
|
|
8416
8416
|
*
|
|
8417
8417
|
* The generic per-line form of the revenue growth lever: grows an
|
|
8418
8418
|
* income-statement leaf month-over-month at the asserted rate
|
|
8419
|
-
* (
|
|
8419
|
+
* (`line[t] = line[t-1] * (1 + rate[t])`), compounding from the base
|
|
8420
8420
|
* month's value. Months without a rate keep the engine's carry-forward.
|
|
8421
|
-
* Duration leaves only; disjoint from
|
|
8421
|
+
* Duration leaves only; disjoint from `line_assertions` and from any
|
|
8422
8422
|
* active catalog rule's target (one owner per line).
|
|
8423
8423
|
*
|
|
8424
8424
|
* Persistence deviates from levers/assertions deliberately: rates are
|
|
8425
8425
|
* NOT duplicated as facts in the scenario FactSet — a growth rate on a
|
|
8426
8426
|
* monetary statement element would be a unit-lying fact. This mechanics
|
|
8427
|
-
* copy is the single authored store;
|
|
8427
|
+
* copy is the single authored store; `compute-forecast` binds rates
|
|
8428
8428
|
* from here.
|
|
8429
8429
|
*/
|
|
8430
8430
|
export type LineGrowthLite = {
|
|
@@ -8449,7 +8449,7 @@ export type LineGrowthLite = {
|
|
|
8449
8449
|
/**
|
|
8450
8450
|
* Values By Period
|
|
8451
8451
|
*
|
|
8452
|
-
* Expanded per-month growth rates keyed by
|
|
8452
|
+
* Expanded per-month growth rates keyed by `YYYY-MM`.
|
|
8453
8453
|
*/
|
|
8454
8454
|
values_by_period: {
|
|
8455
8455
|
[key: string]: number;
|
|
@@ -8460,27 +8460,27 @@ export type LineGrowthLite = {
|
|
|
8460
8460
|
*
|
|
8461
8461
|
* One statement line's asserted growth trajectory for the scenario.
|
|
8462
8462
|
*
|
|
8463
|
-
* The generic per-line sibling of
|
|
8463
|
+
* The generic per-line sibling of `rs-driver:RevenueGrowthRate`: where
|
|
8464
8464
|
* the catalog lever grows *revenue* through its seeded rule, a line
|
|
8465
8465
|
* growth entry grows **any income-statement leaf** at a month-over-month
|
|
8466
|
-
* rate —
|
|
8466
|
+
* rate — `value` -0.05 cuts the line 5% per month, compounding from
|
|
8467
8467
|
* the base month's value. This is what expense trajectories ("opex +2%/mo
|
|
8468
8468
|
* with inflation", "cut costs 5%/mo starting October") use; without it
|
|
8469
8469
|
* every unmodeled line just carries flat.
|
|
8470
8470
|
*
|
|
8471
|
-
* Semantics per month:
|
|
8471
|
+
* Semantics per month: `line[t] = line[t-1] * (1 + rate[t])`. Months
|
|
8472
8472
|
* the entry doesn't name keep the engine's carry-forward (grow-then-hold
|
|
8473
|
-
* ramps fall out of
|
|
8473
|
+
* ramps fall out of `values_by_period` naturally). **Duration leaves
|
|
8474
8474
|
* only**: balance-sheet lines roll from the IS and the working-capital
|
|
8475
8475
|
* levers — grow the driving IS line instead. A line already driven by an
|
|
8476
|
-
* active catalog rule (e.g. Revenues with
|
|
8477
|
-
* named by a
|
|
8476
|
+
* active catalog rule (e.g. Revenues with `RevenueGrowthRate` set) or
|
|
8477
|
+
* named by a `line_assertions` entry is rejected — one owner per line.
|
|
8478
8478
|
*/
|
|
8479
8479
|
export type LineGrowthRequest = {
|
|
8480
8480
|
/**
|
|
8481
8481
|
* Qname
|
|
8482
8482
|
*
|
|
8483
|
-
* QName of the income-statement leaf to grow (e.g.
|
|
8483
|
+
* QName of the income-statement leaf to grow (e.g. `rs-gaap:ResearchAndDevelopmentExpense`). Must be a calc-DAG duration leaf.
|
|
8484
8484
|
*/
|
|
8485
8485
|
qname: string;
|
|
8486
8486
|
/**
|
|
@@ -8492,7 +8492,7 @@ export type LineGrowthRequest = {
|
|
|
8492
8492
|
/**
|
|
8493
8493
|
* Values By Period
|
|
8494
8494
|
*
|
|
8495
|
-
* Per-month rate overrides keyed by
|
|
8495
|
+
* Per-month rate overrides keyed by `YYYY-MM`. Wins over `value` for the months it names; months named by neither carry the line's prior value (rate 0).
|
|
8496
8496
|
*/
|
|
8497
8497
|
values_by_period?: {
|
|
8498
8498
|
[key: string]: number;
|
|
@@ -8503,16 +8503,16 @@ export type LineGrowthRequest = {
|
|
|
8503
8503
|
*
|
|
8504
8504
|
* Filter ledger LineItems by flow concept.
|
|
8505
8505
|
*
|
|
8506
|
-
* The single predicate kind shipped to date.
|
|
8507
|
-
* qnames — mini's
|
|
8506
|
+
* The single predicate kind shipped to date. `values` are flow-concept
|
|
8507
|
+
* qnames — mini's `TransactionDescriptionCode` values, rs-gaap flow
|
|
8508
8508
|
* concepts (what the enrichment classifier emits for QuickBooks data),
|
|
8509
|
-
* future XBRL GL
|
|
8510
|
-
* to element_ids and matches the first-class
|
|
8509
|
+
* future XBRL GL `GenericFlowCategory` codes. The engine resolves them
|
|
8510
|
+
* to element_ids and matches the first-class `LineItem.flow_element_id`
|
|
8511
8511
|
* FK; matched lines aggregate signed into the attributed fact for the
|
|
8512
8512
|
* period.
|
|
8513
8513
|
*
|
|
8514
|
-
*
|
|
8515
|
-
*
|
|
8514
|
+
* `field` is accepted but ignored: the flow tag lives in the typed
|
|
8515
|
+
* `flow_element_id` FK, not in JSONB metadata. It stays on the wire so
|
|
8516
8516
|
* existing request bodies keep validating.
|
|
8517
8517
|
*/
|
|
8518
8518
|
export type LineItemMetadataPredicate = {
|
|
@@ -8525,13 +8525,13 @@ export type LineItemMetadataPredicate = {
|
|
|
8525
8525
|
/**
|
|
8526
8526
|
* Field
|
|
8527
8527
|
*
|
|
8528
|
-
* Accepted but ignored. The flow tag lives in the typed
|
|
8528
|
+
* Accepted but ignored. The flow tag lives in the typed `flow_element_id` FK, not JSONB metadata. Retained for wire-compatibility.
|
|
8529
8529
|
*/
|
|
8530
8530
|
field?: string;
|
|
8531
8531
|
/**
|
|
8532
8532
|
* Values
|
|
8533
8533
|
*
|
|
8534
|
-
* Flow-concept qnames that route to this filter's target concept. A LineItem matches when its
|
|
8534
|
+
* Flow-concept qnames that route to this filter's target concept. A LineItem matches when its `flow_element_id` is one of the elements named here AND the line falls within the rollforward's period.
|
|
8535
8535
|
*/
|
|
8536
8536
|
values: Array<string>;
|
|
8537
8537
|
};
|
|
@@ -8541,7 +8541,7 @@ export type LineItemMetadataPredicate = {
|
|
|
8541
8541
|
* Link an entity to a taxonomy (creates the ENTITY_HAS_TAXONOMY edge).
|
|
8542
8542
|
*
|
|
8543
8543
|
* This is how a graph declares "this entity reports under this taxonomy."
|
|
8544
|
-
* For
|
|
8544
|
+
* For `chart_of_accounts` taxonomies, this tells the platform which CoA
|
|
8545
8545
|
* the entity uses. For reporting taxonomies, which standard (us-gaap,
|
|
8546
8546
|
* ifrs). Idempotent — re-linking returns the existing edge unchanged.
|
|
8547
8547
|
*
|
|
@@ -8680,7 +8680,7 @@ export type LiveFinancialStatementRequest = {
|
|
|
8680
8680
|
/**
|
|
8681
8681
|
* Statement Type
|
|
8682
8682
|
*
|
|
8683
|
-
* income_statement | balance_sheet | cash_flow_statement | equity_statement.
|
|
8683
|
+
* income_statement | balance_sheet | cash_flow_statement | equity_statement. `equity_statement` is provisional — equity balances, not a rollforward — and is not offered on the MCP surface until it articulates.
|
|
8684
8684
|
*/
|
|
8685
8685
|
statement_type: string;
|
|
8686
8686
|
/**
|
|
@@ -8731,7 +8731,7 @@ export type LiveFinancialStatementResponse = {
|
|
|
8731
8731
|
/**
|
|
8732
8732
|
* Periods
|
|
8733
8733
|
*
|
|
8734
|
-
* Rendered columns, aligned with each row's
|
|
8734
|
+
* Rendered columns, aligned with each row's `values`. Current and prior for income_statement and balance_sheet; current only for cash_flow_statement — the prior period is pivoted as the indirect-method delta basis and not rendered.
|
|
8735
8735
|
*/
|
|
8736
8736
|
periods: Array<PeriodSpec>;
|
|
8737
8737
|
/**
|
|
@@ -8948,10 +8948,10 @@ export type MemoryRecord = {
|
|
|
8948
8948
|
*
|
|
8949
8949
|
* A bank feed is native accounting: the graph must already have a chart of
|
|
8950
8950
|
* accounts and no live QuickBooks connection. Over OAuth (the hosted
|
|
8951
|
-
* default) the connection is created
|
|
8952
|
-
* callback.
|
|
8951
|
+
* default) the connection is created `pending_oauth` and activated by the
|
|
8952
|
+
* callback. `api_key` — a personal **read-only** Mercury token — connects
|
|
8953
8953
|
* at once without a browser round-trip, but only on deployments that turn
|
|
8954
|
-
* on
|
|
8954
|
+
* on `MERCURY_API_KEY_CONNECTIONS_ENABLED` (self-hosted and local); the
|
|
8955
8955
|
* hosted product refuses it.
|
|
8956
8956
|
*/
|
|
8957
8957
|
export type MercuryConnectionConfig = {
|
|
@@ -8977,7 +8977,7 @@ export type MercuryConnectionConfig = {
|
|
|
8977
8977
|
/**
|
|
8978
8978
|
* MetricMechanics
|
|
8979
8979
|
*
|
|
8980
|
-
* Derivative mechanics for
|
|
8980
|
+
* Derivative mechanics for `block_type='metric'`.
|
|
8981
8981
|
*
|
|
8982
8982
|
* A metric block composes its facts from one or more source blocks at
|
|
8983
8983
|
* read time — covenant tests, ratios, KPI trend computations. The typed
|
|
@@ -8986,10 +8986,10 @@ export type MercuryConnectionConfig = {
|
|
|
8986
8986
|
* derivation evaluator that actually computes facts from source-block
|
|
8987
8987
|
* FactSets is not yet implemented.
|
|
8988
8988
|
*
|
|
8989
|
-
*
|
|
8990
|
-
* derives from;
|
|
8991
|
-
* (
|
|
8992
|
-
*
|
|
8989
|
+
* `source_block_ids` is the ordered list of Structure ids this metric
|
|
8990
|
+
* derives from; `derivation_type` names the kind of computation
|
|
8991
|
+
* (`ratio`, `trailing_twelve_month`, `covenant_test`, …), and
|
|
8992
|
+
* `expression` carries the agent-authored derivation string that the
|
|
8993
8993
|
* evaluator will consume at envelope build time.
|
|
8994
8994
|
*/
|
|
8995
8995
|
export type MetricMechanics = {
|
|
@@ -9025,7 +9025,7 @@ export type MetricMechanics = {
|
|
|
9025
9025
|
/**
|
|
9026
9026
|
* MetricObservation
|
|
9027
9027
|
*
|
|
9028
|
-
* One externally-observed value in an
|
|
9028
|
+
* One externally-observed value in an `assert-metrics` request.
|
|
9029
9029
|
*/
|
|
9030
9030
|
export type MetricObservation = {
|
|
9031
9031
|
/**
|
|
@@ -9428,20 +9428,20 @@ export type OperationCosts = {
|
|
|
9428
9428
|
*
|
|
9429
9429
|
* Uniform response shape for every operation endpoint.
|
|
9430
9430
|
*
|
|
9431
|
-
* Every dispatch carries an
|
|
9431
|
+
* Every dispatch carries an `op_<ULID>` operation_id, which is the bridge
|
|
9432
9432
|
* to the monitoring surface: pass it to
|
|
9433
|
-
*
|
|
9433
|
+
* `GET /v1/operations/{operation_id}/stream` (see `routers/operations.py`)
|
|
9434
9434
|
* to subscribe to SSE progress events. Sync commands complete in the envelope
|
|
9435
|
-
* itself (
|
|
9436
|
-
* (
|
|
9435
|
+
* itself (`status: "completed"`, HTTP 200); async commands
|
|
9436
|
+
* (`status: "pending"`, HTTP 202) hand off to a background worker and stream
|
|
9437
9437
|
* their tail through that SSE endpoint. Failed dispatches still mint an
|
|
9438
|
-
*
|
|
9438
|
+
* `operation_id` so the audit log and any partial SSE events stay
|
|
9439
9439
|
* correlatable.
|
|
9440
9440
|
*
|
|
9441
|
-
*
|
|
9442
|
-
* OpenAPI. Operations that pin
|
|
9443
|
-
*
|
|
9444
|
-
* the default
|
|
9441
|
+
* `TResult` parameterizes `result` so per-op response shapes surface in
|
|
9442
|
+
* OpenAPI. Operations that pin `OperationSpec.result_type` get
|
|
9443
|
+
* `OperationEnvelope[YourEnvelope]` as their response model; the rest keep
|
|
9444
|
+
* the default `Any` shape (`result: any | null` on the wire).
|
|
9445
9445
|
*/
|
|
9446
9446
|
export type OperationEnvelope = {
|
|
9447
9447
|
/**
|
|
@@ -12237,10 +12237,10 @@ export type PasskeyLoginVerifyRequest = {
|
|
|
12237
12237
|
*
|
|
12238
12238
|
* Begin enrollment.
|
|
12239
12239
|
*
|
|
12240
|
-
* Two disjoint lanes:
|
|
12240
|
+
* Two disjoint lanes: `mfa_token` (forced enrollment — the token was minted
|
|
12241
12241
|
* seconds after a password verify, so it is its own freshness proof) or an
|
|
12242
12242
|
* authenticated settings-flow enrollment, which must carry a fresh re-auth
|
|
12243
|
-
* proof —
|
|
12243
|
+
* proof — `password`, or a `reauth`-ceremony `assertion` when adding a
|
|
12244
12244
|
* passkey beside an existing one.
|
|
12245
12245
|
*/
|
|
12246
12246
|
export type PasskeyRegisterOptionsRequest = {
|
|
@@ -12517,8 +12517,8 @@ export type PerformanceInsights = {
|
|
|
12517
12517
|
* A single reporting period column.
|
|
12518
12518
|
*
|
|
12519
12519
|
* Reports render facts in N period columns side-by-side. Each
|
|
12520
|
-
*
|
|
12521
|
-
* window the report's facts roll up into;
|
|
12520
|
+
* `PeriodSpec` is one column — its `start`/`end` define the
|
|
12521
|
+
* window the report's facts roll up into; `label` is what the renderer
|
|
12522
12522
|
* prints in the column header. For year-over-year statements, supply two
|
|
12523
12523
|
* PeriodSpecs (current + comparative); for YTD by quarter, supply four.
|
|
12524
12524
|
*/
|
|
@@ -12549,9 +12549,9 @@ export type PeriodSpec = {
|
|
|
12549
12549
|
*
|
|
12550
12550
|
* A bank feed is native accounting: the graph must already have a chart of
|
|
12551
12551
|
* accounts and no live QuickBooks connection. The connection is created
|
|
12552
|
-
*
|
|
12553
|
-
* Link, and the
|
|
12554
|
-
*
|
|
12552
|
+
* `pending_oauth`; `POST /oauth/init` returns a `link_token` for Plaid
|
|
12553
|
+
* Link, and the `public_token` Link hands back completes it through
|
|
12554
|
+
* `POST /oauth/callback/plaid` (as `code`). One connection per institution
|
|
12555
12555
|
* login; a graph can hold several.
|
|
12556
12556
|
*/
|
|
12557
12557
|
export type PlaidConnectionConfig = {
|
|
@@ -13059,15 +13059,15 @@ export type PreviewReconcilingItemRequest = {
|
|
|
13059
13059
|
*
|
|
13060
13060
|
* On-demand trigger for the obligation-promotion sweep.
|
|
13061
13061
|
*
|
|
13062
|
-
* Mirrors what the
|
|
13062
|
+
* Mirrors what the `scheduled_obligation_promoter` Dagster sensor does
|
|
13063
13063
|
* on its tick, but lets an interactive caller or an MCP close co-pilot
|
|
13064
13064
|
* run it now instead of waiting for the background cadence — required to
|
|
13065
13065
|
* drive a schedule-driven close to completion in a single session.
|
|
13066
|
-
* Flips matured
|
|
13067
|
-
* passed) to
|
|
13066
|
+
* Flips matured `pending` `schedule_entry_due` events (period boundary
|
|
13067
|
+
* passed) to `classified`; with `dispatch_handlers` it also drafts the
|
|
13068
13068
|
* closing entries in the same transaction (idempotent — reconciles to an
|
|
13069
13069
|
* existing draft). The sweep also reaches *stranded* obligations —
|
|
13070
|
-
* already
|
|
13070
|
+
* already `classified` (by an earlier flip-only sweep) but with no
|
|
13071
13071
|
* closing entry ever drafted — dispatching them in the same pass.
|
|
13072
13072
|
*/
|
|
13073
13073
|
export type PromoteObligationsRequest = {
|
|
@@ -13352,7 +13352,7 @@ export type ReconcilingItemCatchUp = {
|
|
|
13352
13352
|
* One account's net change between the posted entries and the new payload.
|
|
13353
13353
|
*
|
|
13354
13354
|
* Amounts are signed minor units in debit-positive convention: a positive
|
|
13355
|
-
* figure is a net debit, a negative one a net credit.
|
|
13355
|
+
* figure is a net debit, a negative one a net credit. `delta` is what a
|
|
13356
13356
|
* catch-up entry would post to bring the books level.
|
|
13357
13357
|
*/
|
|
13358
13358
|
export type ReconcilingItemDeltaLine = {
|
|
@@ -13717,8 +13717,8 @@ export type RemovePublishListMemberOperation = {
|
|
|
13717
13717
|
*
|
|
13718
13718
|
* Computed server-side at envelope-build time for blocks where rendering
|
|
13719
13719
|
* is deterministic (the statement family today; future block types add
|
|
13720
|
-
* their own rendering builders). The frontend's
|
|
13721
|
-
*
|
|
13720
|
+
* their own rendering builders). The frontend's `BlockView`
|
|
13721
|
+
* `Rendering` projection consumes this directly — no client-side
|
|
13722
13722
|
* rollup, depth computation, or calculation walk needed.
|
|
13723
13723
|
*/
|
|
13724
13724
|
export type RenderingLite = {
|
|
@@ -13768,7 +13768,7 @@ export type RenderingPeriodLite = {
|
|
|
13768
13768
|
*
|
|
13769
13769
|
* Mirrors :class:`FactRow` in
|
|
13770
13770
|
* :mod:`robosystems.operations.roboledger.reports.fact_grid`, restated at the
|
|
13771
|
-
* API boundary so envelope consumers don't depend on that module.
|
|
13771
|
+
* API boundary so envelope consumers don't depend on that module. `values`
|
|
13772
13772
|
* holds one entry per period column in :class:`RenderingLite.periods`.
|
|
13773
13773
|
*/
|
|
13774
13774
|
export type RenderingRowLite = {
|
|
@@ -13849,10 +13849,10 @@ export type ReopenPeriodOperation = {
|
|
|
13849
13849
|
*
|
|
13850
13850
|
* Report definition summary — header metadata, no facts.
|
|
13851
13851
|
*
|
|
13852
|
-
* Returned by
|
|
13853
|
-
*
|
|
13852
|
+
* Returned by `create-report`, `regenerate-report`,
|
|
13853
|
+
* `file-report`, and `transition-filing-status`. Use the package
|
|
13854
13854
|
* read endpoint to retrieve a Report rehydrated with its rendered
|
|
13855
|
-
*
|
|
13855
|
+
* `InformationBlockEnvelope` items.
|
|
13856
13856
|
*/
|
|
13857
13857
|
export type ReportResponse = {
|
|
13858
13858
|
/**
|
|
@@ -14297,7 +14297,7 @@ export type RevokeReportShareResponse = {
|
|
|
14297
14297
|
/**
|
|
14298
14298
|
* RollforwardMechanics
|
|
14299
14299
|
*
|
|
14300
|
-
* Filter-based attribution mechanics for
|
|
14300
|
+
* Filter-based attribution mechanics for `block_type='rollforward'`.
|
|
14301
14301
|
*
|
|
14302
14302
|
* Filter-based attribution: each block decomposes one BS source
|
|
14303
14303
|
* element's period delta into a list of flow concepts via declared
|
|
@@ -14306,10 +14306,10 @@ export type RevokeReportShareResponse = {
|
|
|
14306
14306
|
* attributed fact per filter per period, and arbitrates any residual
|
|
14307
14307
|
* against the default change tag fallback.
|
|
14308
14308
|
*
|
|
14309
|
-
* Reads directly from the typed
|
|
14310
|
-
* column.
|
|
14309
|
+
* Reads directly from the typed `structures.artifact_mechanics` JSONB
|
|
14310
|
+
* column. `attribution_filters` rides as nested JSON; the predicate
|
|
14311
14311
|
* union widens as new predicate shapes are added — currently only
|
|
14312
|
-
*
|
|
14312
|
+
* `line_item_metadata_field` is carried.
|
|
14313
14313
|
*/
|
|
14314
14314
|
export type RollforwardMechanics = {
|
|
14315
14315
|
/**
|
|
@@ -14319,25 +14319,25 @@ export type RollforwardMechanics = {
|
|
|
14319
14319
|
/**
|
|
14320
14320
|
* Bs Source Element Id
|
|
14321
14321
|
*
|
|
14322
|
-
* Element id of the balance-sheet source whose period delta this block decomposes. Resolved from
|
|
14322
|
+
* Element id of the balance-sheet source whose period delta this block decomposes. Resolved from `bs_source_qname` at create time.
|
|
14323
14323
|
*/
|
|
14324
14324
|
bs_source_element_id: string;
|
|
14325
14325
|
/**
|
|
14326
14326
|
* Bs Source Qname
|
|
14327
14327
|
*
|
|
14328
|
-
* QName of the BS source element (e.g.
|
|
14328
|
+
* QName of the BS source element (e.g. `mini:CashAndCashEquivalents`). Round-tripped for caller convenience; `bs_source_element_id` is authoritative.
|
|
14329
14329
|
*/
|
|
14330
14330
|
bs_source_qname: string;
|
|
14331
14331
|
/**
|
|
14332
14332
|
* Default Change Tag Element Id
|
|
14333
14333
|
*
|
|
14334
|
-
* Element id of the default change tag — the fallback flow concept that receives any residual (Δ BS − Σ filter matches). Null when no default is declared; behavior on residual then follows
|
|
14334
|
+
* Element id of the default change tag — the fallback flow concept that receives any residual (Δ BS − Σ filter matches). Null when no default is declared; behavior on residual then follows `validation_mode`.
|
|
14335
14335
|
*/
|
|
14336
14336
|
default_change_tag_element_id?: string | null;
|
|
14337
14337
|
/**
|
|
14338
14338
|
* Default Change Tag Qname
|
|
14339
14339
|
*
|
|
14340
|
-
* QName of the default change tag (e.g.
|
|
14340
|
+
* QName of the default change tag (e.g. `rs-gaap:IncreaseDecreaseInCashAndCashEquivalents`). Round-tripped for caller convenience and operator-readable envelopes; `default_change_tag_element_id` is authoritative. Null iff `default_change_tag_element_id` is null.
|
|
14341
14341
|
*/
|
|
14342
14342
|
default_change_tag_qname?: string | null;
|
|
14343
14343
|
/**
|
|
@@ -14349,7 +14349,7 @@ export type RollforwardMechanics = {
|
|
|
14349
14349
|
/**
|
|
14350
14350
|
* Validation Mode
|
|
14351
14351
|
*
|
|
14352
|
-
* Renderer arbitration policy when Σ filter matches != Δ BS.
|
|
14352
|
+
* Renderer arbitration policy when Σ filter matches != Δ BS. `strict` raises; `residual_as_default` emits the residual as a default-tag fact (the common case); `warn_only` logs and lets the imbalance pass.
|
|
14353
14353
|
*/
|
|
14354
14354
|
validation_mode?: 'strict' | 'residual_as_default' | 'warn_only';
|
|
14355
14355
|
};
|
|
@@ -14358,8 +14358,8 @@ export type RollforwardMechanics = {
|
|
|
14358
14358
|
*
|
|
14359
14359
|
* Rule projection for the Information Block envelope.
|
|
14360
14360
|
*
|
|
14361
|
-
* One row per
|
|
14362
|
-
* engine consumes
|
|
14361
|
+
* One row per `public.rules` entry scoped to this block. The rule
|
|
14362
|
+
* engine consumes `rule_expression` + `rule_variables` to evaluate
|
|
14363
14363
|
* against the in-scope fact set; the envelope surfaces the rules so
|
|
14364
14364
|
* the UI can render them as a checklist alongside any persisted
|
|
14365
14365
|
* verification results.
|
|
@@ -14403,13 +14403,13 @@ export type RuleLite = {
|
|
|
14403
14403
|
/**
|
|
14404
14404
|
* Rule Severity
|
|
14405
14405
|
*
|
|
14406
|
-
* Failure severity — 'info' | 'warning' | 'error'. Enum closure enforced by the
|
|
14406
|
+
* Failure severity — 'info' | 'warning' | 'error'. Enum closure enforced by the `public.rules` CHECK constraint.
|
|
14407
14407
|
*/
|
|
14408
14408
|
rule_severity?: string;
|
|
14409
14409
|
/**
|
|
14410
14410
|
* Rule Origin
|
|
14411
14411
|
*
|
|
14412
|
-
* Provenance — 'forked' (from an upstream artifact, e.g. Seattle Method) or 'native' (authored in this seed or by a tenant). Enum closure enforced by the
|
|
14412
|
+
* Provenance — 'forked' (from an upstream artifact, e.g. Seattle Method) or 'native' (authored in this seed or by a tenant). Enum closure enforced by the `public.rules` CHECK constraint.
|
|
14413
14413
|
*/
|
|
14414
14414
|
rule_origin?: string;
|
|
14415
14415
|
};
|
|
@@ -14422,13 +14422,13 @@ export type RuleTargetLite = {
|
|
|
14422
14422
|
/**
|
|
14423
14423
|
* Target Kind
|
|
14424
14424
|
*
|
|
14425
|
-
* Which atom type the rule targets — 'structure' | 'element' | 'association' | 'taxonomy'. Enum closure enforced by the
|
|
14425
|
+
* Which atom type the rule targets — 'structure' | 'element' | 'association' | 'taxonomy'. Enum closure enforced by the `public.rules` CHECK constraint.
|
|
14426
14426
|
*/
|
|
14427
14427
|
target_kind: string;
|
|
14428
14428
|
/**
|
|
14429
14429
|
* Target Ref Id
|
|
14430
14430
|
*
|
|
14431
|
-
* UUID of the target atom — structure_id, element_id, association_id, or taxonomy_id depending on
|
|
14431
|
+
* UUID of the target atom — structure_id, element_id, association_id, or taxonomy_id depending on `target_kind`.
|
|
14432
14432
|
*/
|
|
14433
14433
|
target_ref_id: string;
|
|
14434
14434
|
};
|
|
@@ -14587,11 +14587,11 @@ export type ScheduleCreatedResponse = {
|
|
|
14587
14587
|
/**
|
|
14588
14588
|
* ScheduleMechanics
|
|
14589
14589
|
*
|
|
14590
|
-
* Closing-entry generator mechanics for
|
|
14590
|
+
* Closing-entry generator mechanics for `block_type='schedule'`.
|
|
14591
14591
|
*
|
|
14592
|
-
* Reads the typed
|
|
14593
|
-
* to
|
|
14594
|
-
*
|
|
14592
|
+
* Reads the typed `structures.artifact_mechanics` JSONB column, falling back
|
|
14593
|
+
* to `structures.metadata_` for Schedule rows that lack it.
|
|
14594
|
+
* `entry_template` and `schedule_metadata` reuse the wire-level request
|
|
14595
14595
|
* shapes so OpenAPI emits one canonical type per concept.
|
|
14596
14596
|
*/
|
|
14597
14597
|
export type ScheduleMechanics = {
|
|
@@ -14800,10 +14800,10 @@ export type SchemaValidationResponse = {
|
|
|
14800
14800
|
* A single search result with snippet.
|
|
14801
14801
|
*
|
|
14802
14802
|
* A long SEC section (an MD&A, a commitments note) is indexed in parts, each
|
|
14803
|
-
* a document of its own:
|
|
14804
|
-
* shared by the section's parts,
|
|
14803
|
+
* a document of its own: `part` of `part_count`, `parent_document_id`
|
|
14804
|
+
* shared by the section's parts, `next_document_id` to read on.
|
|
14805
14805
|
*
|
|
14806
|
-
* On a grouped search,
|
|
14806
|
+
* On a grouped search, `also_in_filings` counts the other filings of the
|
|
14807
14807
|
* same filer whose same section (and part) matched and were folded into
|
|
14808
14808
|
* this hit.
|
|
14809
14809
|
*/
|
|
@@ -15353,7 +15353,7 @@ export type ShareResultItem = {
|
|
|
15353
15353
|
/**
|
|
15354
15354
|
* SkippedForecastLite
|
|
15355
15355
|
*
|
|
15356
|
-
* One rule/month soft-skip in a
|
|
15356
|
+
* One rule/month soft-skip in a `compute-forecast` response.
|
|
15357
15357
|
*
|
|
15358
15358
|
* A skipped rule never aborts the walk — its target falls back to the
|
|
15359
15359
|
* carry-forward value for that month (when a prior value exists).
|
|
@@ -15370,7 +15370,7 @@ export type SkippedForecastLite = {
|
|
|
15370
15370
|
/**
|
|
15371
15371
|
* Period
|
|
15372
15372
|
*
|
|
15373
|
-
* Month key (
|
|
15373
|
+
* Month key (`YYYY-MM`) of the skip.
|
|
15374
15374
|
*/
|
|
15375
15375
|
period: string;
|
|
15376
15376
|
/**
|
|
@@ -15385,7 +15385,7 @@ export type SkippedForecastLite = {
|
|
|
15385
15385
|
/**
|
|
15386
15386
|
* SkippedMetricLite
|
|
15387
15387
|
*
|
|
15388
|
-
* One metric a
|
|
15388
|
+
* One metric a `compute-metrics` run could not compute.
|
|
15389
15389
|
*
|
|
15390
15390
|
* Soft-fail by design: a missing operand fact (e.g. InterestExpense for a
|
|
15391
15391
|
* debt-free entity) or an undefined ratio (division by zero) skips the
|
|
@@ -15470,10 +15470,10 @@ export type SqlStatementResponse = {
|
|
|
15470
15470
|
*
|
|
15471
15471
|
* Renderer mechanics for the statement family of block types.
|
|
15472
15472
|
*
|
|
15473
|
-
* Covers
|
|
15474
|
-
* and
|
|
15473
|
+
* Covers `balance_sheet`, `income_statement`, `cash_flow_statement`,
|
|
15474
|
+
* and `equity_statement`. All fields are optional so library-seeded
|
|
15475
15475
|
* rows that haven't been enriched yet still validate against an empty
|
|
15476
|
-
* tagged body. The existing
|
|
15476
|
+
* tagged body. The existing `statement(...)` GraphQL field continues
|
|
15477
15477
|
* to serve rendered output; this mechanics model is the source of truth
|
|
15478
15478
|
* for future renderer configuration.
|
|
15479
15479
|
*/
|
|
@@ -15622,9 +15622,9 @@ export type StructureSummary = {
|
|
|
15622
15622
|
*
|
|
15623
15623
|
* Partial-update patch for a single structure, keyed by structure_id.
|
|
15624
15624
|
*
|
|
15625
|
-
*
|
|
15626
|
-
* place (e.g. promoting a
|
|
15627
|
-
* footing rule);
|
|
15625
|
+
* `concept_arrangement` makes a mis-CAP'd structure repairable in
|
|
15626
|
+
* place (e.g. promoting a `set` note to `roll_up` so it gains a
|
|
15627
|
+
* footing rule); `block_type` stays immutable — it drives block-type
|
|
15628
15628
|
* routing, so changing it is a re-create, not an edit.
|
|
15629
15629
|
*/
|
|
15630
15630
|
export type StructureUpdatePatch = {
|
|
@@ -15663,7 +15663,7 @@ export type StructureUpdatePatch = {
|
|
|
15663
15663
|
* Subgraph count against the parent graph tier's cap.
|
|
15664
15664
|
*
|
|
15665
15665
|
* Subgraphs are refused at the tier cap regardless of how small they are,
|
|
15666
|
-
* so this is a count axis independent of the storage one —
|
|
15666
|
+
* so this is a count axis independent of the storage one — `instance`
|
|
15667
15667
|
* already itemizes their footprint.
|
|
15668
15668
|
*/
|
|
15669
15669
|
export type SubgraphLimits = {
|
|
@@ -16032,7 +16032,7 @@ export type TaxonomyBlockAssociationRequest = {
|
|
|
16032
16032
|
/**
|
|
16033
16033
|
* Association Type
|
|
16034
16034
|
*
|
|
16035
|
-
* DB
|
|
16035
|
+
* DB `associations.association_type` enum. `presentation` = parent-child hierarchy; `calculation` = summation arc.
|
|
16036
16036
|
*/
|
|
16037
16037
|
association_type: 'presentation' | 'calculation' | 'mapping' | 'equivalence' | 'general-special' | 'essence-alias';
|
|
16038
16038
|
/**
|
|
@@ -16105,7 +16105,7 @@ export type TaxonomyBlockElement = {
|
|
|
16105
16105
|
/**
|
|
16106
16106
|
* Origin
|
|
16107
16107
|
*
|
|
16108
|
-
* Provenance — 'library' if the element's taxonomy is locked (
|
|
16108
|
+
* Provenance — 'library' if the element's taxonomy is locked (`is_locked=true`), else 'tenant'.
|
|
16109
16109
|
*/
|
|
16110
16110
|
origin: 'library' | 'tenant';
|
|
16111
16111
|
};
|
|
@@ -16114,17 +16114,17 @@ export type TaxonomyBlockElement = {
|
|
|
16114
16114
|
*
|
|
16115
16115
|
* Element definition inside a Taxonomy Block envelope.
|
|
16116
16116
|
*
|
|
16117
|
-
*
|
|
16118
|
-
* envelope's
|
|
16119
|
-
* payloads as the reference token.
|
|
16120
|
-
* envelope-local qname or, for
|
|
16117
|
+
* `qname` is the envelope-local identifier — must be unique within the
|
|
16118
|
+
* envelope's `elements` list and is used by association / rule / patch
|
|
16119
|
+
* payloads as the reference token. `parent_ref` may reference another
|
|
16120
|
+
* envelope-local qname or, for `reporting_extension` blocks, a library
|
|
16121
16121
|
* element qname.
|
|
16122
16122
|
*/
|
|
16123
16123
|
export type TaxonomyBlockElementRequest = {
|
|
16124
16124
|
/**
|
|
16125
16125
|
* Qname
|
|
16126
16126
|
*
|
|
16127
|
-
* Envelope-local element identifier. Must be unique within the envelope's
|
|
16127
|
+
* Envelope-local element identifier. Must be unique within the envelope's `elements` list. Used as the reference token for associations, rules, and update patches.
|
|
16128
16128
|
*/
|
|
16129
16129
|
qname: string;
|
|
16130
16130
|
/**
|
|
@@ -16136,7 +16136,7 @@ export type TaxonomyBlockElementRequest = {
|
|
|
16136
16136
|
/**
|
|
16137
16137
|
* Trait
|
|
16138
16138
|
*
|
|
16139
|
-
* FASB metamodel trait for the element. Required for
|
|
16139
|
+
* FASB metamodel trait for the element. Required for `chart_of_accounts` blocks; optional for `custom_ontology`.
|
|
16140
16140
|
*/
|
|
16141
16141
|
trait?: string | null;
|
|
16142
16142
|
/**
|
|
@@ -16170,7 +16170,7 @@ export type TaxonomyBlockElementRequest = {
|
|
|
16170
16170
|
/**
|
|
16171
16171
|
* Code
|
|
16172
16172
|
*
|
|
16173
|
-
* Optional chart-of-accounts code (e.g. '1000', '4100-02'). Only meaningful for
|
|
16173
|
+
* Optional chart-of-accounts code (e.g. '1000', '4100-02'). Only meaningful for `chart_of_accounts` blocks.
|
|
16174
16174
|
*/
|
|
16175
16175
|
code?: string | null;
|
|
16176
16176
|
/**
|
|
@@ -16180,7 +16180,7 @@ export type TaxonomyBlockElementRequest = {
|
|
|
16180
16180
|
/**
|
|
16181
16181
|
* Parent Ref
|
|
16182
16182
|
*
|
|
16183
|
-
* qname of the parent element — either another envelope-local qname or, for
|
|
16183
|
+
* qname of the parent element — either another envelope-local qname or, for `reporting_extension` blocks, a library element qname.
|
|
16184
16184
|
*/
|
|
16185
16185
|
parent_ref?: string | null;
|
|
16186
16186
|
/**
|
|
@@ -16197,7 +16197,7 @@ export type TaxonomyBlockElementRequest = {
|
|
|
16197
16197
|
*
|
|
16198
16198
|
* One envelope per taxonomy instance. Carries identity + type,
|
|
16199
16199
|
* registry-sourced display metadata, the parent taxonomy pointer (for
|
|
16200
|
-
*
|
|
16200
|
+
* `reporting_extension` blocks), and bundled atoms (elements,
|
|
16201
16201
|
* structures, associations, rules, verification results).
|
|
16202
16202
|
*/
|
|
16203
16203
|
export type TaxonomyBlockEnvelope = {
|
|
@@ -16293,9 +16293,9 @@ export type TaxonomyBlockEnvelope = {
|
|
|
16293
16293
|
*
|
|
16294
16294
|
* Rule projection for the Taxonomy Block envelope.
|
|
16295
16295
|
*
|
|
16296
|
-
* Exactly one of
|
|
16296
|
+
* Exactly one of `rule_pattern` (arithmetic) or `rule_check_kind`
|
|
16297
16297
|
* (model-structure) is non-null per row, enforced by the
|
|
16298
|
-
*
|
|
16298
|
+
* `check_rule_pattern_kind_xor` DB constraint.
|
|
16299
16299
|
*/
|
|
16300
16300
|
export type TaxonomyBlockRule = {
|
|
16301
16301
|
/**
|
|
@@ -16339,7 +16339,7 @@ export type TaxonomyBlockRule = {
|
|
|
16339
16339
|
/**
|
|
16340
16340
|
* Target Ref
|
|
16341
16341
|
*
|
|
16342
|
-
* Polymorphic display string — structure_id, element qname, association_id, or taxonomy_id depending on
|
|
16342
|
+
* Polymorphic display string — structure_id, element qname, association_id, or taxonomy_id depending on `target_kind`.
|
|
16343
16343
|
*/
|
|
16344
16344
|
target_ref?: string | null;
|
|
16345
16345
|
};
|
|
@@ -16348,17 +16348,17 @@ export type TaxonomyBlockRule = {
|
|
|
16348
16348
|
*
|
|
16349
16349
|
* Rule definition inside a Taxonomy Block envelope.
|
|
16350
16350
|
*
|
|
16351
|
-
* Exactly one of
|
|
16352
|
-
*
|
|
16353
|
-
* The
|
|
16351
|
+
* Exactly one of `target_structure_ref`, `target_element_qname`, or
|
|
16352
|
+
* `target_taxonomy_self` must be set (or all null for a global rule).
|
|
16353
|
+
* The `model_validator` enforces this contract at the Pydantic layer.
|
|
16354
16354
|
*
|
|
16355
16355
|
* Only **arithmetic** rule patterns are user-creatable via this API
|
|
16356
|
-
* (the
|
|
16357
|
-
* kinds (
|
|
16358
|
-
*
|
|
16359
|
-
*
|
|
16356
|
+
* (the `rule_pattern` Literal below). The 6 model-structure check
|
|
16357
|
+
* kinds (`NoCycles`, `NoOrphanArcs`, `ParentBeforeChild`,
|
|
16358
|
+
* `LeafHasClassification`, `LibraryOriginImmutability`,
|
|
16359
|
+
* `UniqueQNameInTaxonomy`) are system-managed — they're auto-emitted
|
|
16360
16360
|
* by :func:`emit_auto_rules` at taxonomy-block creation time and
|
|
16361
|
-
* populate
|
|
16361
|
+
* populate `rules.rule_check_kind` instead of `rule_pattern`.
|
|
16362
16362
|
*/
|
|
16363
16363
|
export type TaxonomyBlockRuleRequest = {
|
|
16364
16364
|
/**
|
|
@@ -16392,7 +16392,7 @@ export type TaxonomyBlockRuleRequest = {
|
|
|
16392
16392
|
/**
|
|
16393
16393
|
* Variables
|
|
16394
16394
|
*
|
|
16395
|
-
*
|
|
16395
|
+
* `$Variable` → qname bindings. Each entry is `{'variable_name': str, 'variable_qname': str}`.
|
|
16396
16396
|
*/
|
|
16397
16397
|
variables?: Array<{
|
|
16398
16398
|
[key: string]: unknown;
|
|
@@ -16416,7 +16416,7 @@ export type TaxonomyBlockRuleRequest = {
|
|
|
16416
16416
|
/**
|
|
16417
16417
|
* Target Taxonomy Self
|
|
16418
16418
|
*
|
|
16419
|
-
* True iff the rule targets the envelope's own taxonomy row (
|
|
16419
|
+
* True iff the rule targets the envelope's own taxonomy row (`target_kind='taxonomy'`). Mutually exclusive with the other target_* fields.
|
|
16420
16420
|
*/
|
|
16421
16421
|
target_taxonomy_self?: boolean;
|
|
16422
16422
|
/**
|
|
@@ -16472,13 +16472,13 @@ export type TaxonomyBlockStructureRequest = {
|
|
|
16472
16472
|
/**
|
|
16473
16473
|
* Block Type
|
|
16474
16474
|
*
|
|
16475
|
-
* DB
|
|
16475
|
+
* DB `structures.block_type` enum. CoA blocks use `chart_of_accounts`; reporting extensions use the statement family, `regulatory_disclosure` (disclosure notes), or `custom`; custom ontology uses `custom`.
|
|
16476
16476
|
*/
|
|
16477
16477
|
block_type: 'chart_of_accounts' | 'custom' | 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'coa_mapping' | 'schedule' | 'rollforward' | 'reconciliation' | 'policy' | 'metric' | 'regulatory_disclosure';
|
|
16478
16478
|
/**
|
|
16479
16479
|
* Concept Arrangement
|
|
16480
16480
|
*
|
|
16481
|
-
* Concept Arrangement Pattern (CAP) — how the structure's concepts relate (mirrors the
|
|
16481
|
+
* Concept Arrangement Pattern (CAP) — how the structure's concepts relate (mirrors the `structures.concept_arrangement` CHECK vocabulary). A disclosure note footing members to a total is `roll_up`. Null leaves the pattern unset.
|
|
16482
16482
|
*/
|
|
16483
16483
|
concept_arrangement?: 'set' | 'roll_up' | 'roll_forward' | 'roll_forward_info' | 'adjustment' | 'variance' | 'arithmetic' | 'text_block' | 'level1_textblock' | 'level2_textblock' | 'level3_textblock' | 'level4_detail' | 'table_equivalent_textblock' | 'grid' | 'compound_fact' | null;
|
|
16484
16484
|
/**
|
|
@@ -16743,9 +16743,9 @@ export type TransactionTemplateLeg = {
|
|
|
16743
16743
|
*
|
|
16744
16744
|
* Generic filing-status transition — escape hatch for non-file moves.
|
|
16745
16745
|
*
|
|
16746
|
-
* Used for
|
|
16747
|
-
*
|
|
16748
|
-
* through :class:`FileReportRequest` so
|
|
16746
|
+
* Used for `draft → under_review` (submit for review) and
|
|
16747
|
+
* `filed → archived` (supersede / retire). Filing the package goes
|
|
16748
|
+
* through :class:`FileReportRequest` so `filed_at` / `filed_by`
|
|
16749
16749
|
* audit fields land cleanly.
|
|
16750
16750
|
*/
|
|
16751
16751
|
export type TransitionFilingStatusRequest = {
|
|
@@ -16840,8 +16840,8 @@ export type UpdateApiKeyRequest = {
|
|
|
16840
16840
|
/**
|
|
16841
16841
|
* UpdateAgentRequest
|
|
16842
16842
|
*
|
|
16843
|
-
* Patch an agent. All fields except
|
|
16844
|
-
* pass only what changes.
|
|
16843
|
+
* Patch an agent. All fields except `agent_id` are optional —
|
|
16844
|
+
* pass only what changes. `metadata_patch` is deep-merged into the
|
|
16845
16845
|
* existing metadata dict.
|
|
16846
16846
|
*/
|
|
16847
16847
|
export type UpdateAgentRequest = {
|
|
@@ -17080,12 +17080,12 @@ export type UpdateEventBlockRequest = {
|
|
|
17080
17080
|
* UpdateEventHandlerRequest
|
|
17081
17081
|
*
|
|
17082
17082
|
* Update an existing event handler. All fields except
|
|
17083
|
-
*
|
|
17083
|
+
* `event_handler_id` are optional — pass only what changes.
|
|
17084
17084
|
*
|
|
17085
|
-
*
|
|
17086
|
-
* partial template patches).
|
|
17087
|
-
* the existing metadata.
|
|
17088
|
-
*
|
|
17085
|
+
* `transaction_template` is **fully replaced** when supplied (no
|
|
17086
|
+
* partial template patches). `metadata_patch` does deep-merge into
|
|
17087
|
+
* the existing metadata. `approve=true` sets `approved_by` and
|
|
17088
|
+
* `approved_at`; `approve=false` clears them.
|
|
17089
17089
|
*/
|
|
17090
17090
|
export type UpdateEventHandlerRequest = {
|
|
17091
17091
|
/**
|
|
@@ -17163,11 +17163,11 @@ export type UpdateEventHandlerRequest = {
|
|
|
17163
17163
|
* Update a forecast block in place.
|
|
17164
17164
|
*
|
|
17165
17165
|
* Mutable: name, scenario_kind, horizon_months, base_period, levers,
|
|
17166
|
-
* line_assertions.
|
|
17166
|
+
* line_assertions. `levers` and `line_assertions` are each a
|
|
17167
17167
|
* **full replace** when provided (partial edits would make the asserted
|
|
17168
17168
|
* set ambiguous); replacing one leaves the other as stored. Updating
|
|
17169
17169
|
* does NOT recompute — previously computed scenario months go stale
|
|
17170
|
-
* until the next
|
|
17170
|
+
* until the next `compute-forecast` run (the compute-metrics drift
|
|
17171
17171
|
* semantics).
|
|
17172
17172
|
*/
|
|
17173
17173
|
export type UpdateForecastRequest = {
|
|
@@ -17196,7 +17196,7 @@ export type UpdateForecastRequest = {
|
|
|
17196
17196
|
/**
|
|
17197
17197
|
* Base Anchor
|
|
17198
17198
|
*
|
|
17199
|
-
* Switch the walk between seam-anchored (default) and pinned to
|
|
17199
|
+
* Switch the walk between seam-anchored (default) and pinned to `base_period`. Changes nothing about the authored window, so unlike `base_period` it needs no levers re-supplied.
|
|
17200
17200
|
*/
|
|
17201
17201
|
base_anchor?: 'seam' | 'fixed' | null;
|
|
17202
17202
|
/**
|
|
@@ -17233,14 +17233,14 @@ export type UpdateGraphMemberRoleRequest = {
|
|
|
17233
17233
|
*
|
|
17234
17234
|
* Partial update — only supplied (non-null) fields change, so a caller
|
|
17235
17235
|
* editing just the display name need not resend the description and tags.
|
|
17236
|
-
* Because
|
|
17237
|
-
* value instead: pass
|
|
17238
|
-
* the tags.
|
|
17236
|
+
* Because `None` means "leave alone", clearing a field uses its empty
|
|
17237
|
+
* value instead: pass `""` to clear the description and `[]` to clear
|
|
17238
|
+
* the tags. `graph_name` cannot be cleared; it is the graph's label
|
|
17239
17239
|
* everywhere it is listed.
|
|
17240
17240
|
*
|
|
17241
17241
|
* This is the platform-level label for the graph, independent of the
|
|
17242
17242
|
* entity name shown on financial statements — change that through
|
|
17243
|
-
*
|
|
17243
|
+
* `POST /extensions/roboledger/{graph_id}/operations/update-entity`.
|
|
17244
17244
|
*/
|
|
17245
17245
|
export type UpdateGraphMetadataOp = {
|
|
17246
17246
|
/**
|
|
@@ -17336,7 +17336,7 @@ export type UpdateMemberRoleRequest = {
|
|
|
17336
17336
|
*
|
|
17337
17337
|
* Body for the update-memory operation (partial update of a stored memory).
|
|
17338
17338
|
*
|
|
17339
|
-
* Only supplied fields are changed; the memory is re-embedded when
|
|
17339
|
+
* Only supplied fields are changed; the memory is re-embedded when `text`
|
|
17340
17340
|
* changes.
|
|
17341
17341
|
*/
|
|
17342
17342
|
export type UpdateMemoryOp = {
|
|
@@ -17476,7 +17476,7 @@ export type UpdatePublishListOperation = {
|
|
|
17476
17476
|
* invalidate every period already rendered — so switching BS source means
|
|
17477
17477
|
* delete and re-create.
|
|
17478
17478
|
*
|
|
17479
|
-
* **Partial-update semantics**: an omitted (
|
|
17479
|
+
* **Partial-update semantics**: an omitted (`None`) field means "leave
|
|
17480
17480
|
* unchanged". There is no wire-level way to *clear* the default change tag or
|
|
17481
17481
|
* empty the attribution_filters list; delete and re-create the block instead.
|
|
17482
17482
|
* The asymmetry is deliberate — a clear-sentinel costs wire-shape complexity
|
|
@@ -17497,7 +17497,7 @@ export type UpdateRollforwardRequest = {
|
|
|
17497
17497
|
/**
|
|
17498
17498
|
* Default Change Tag Qname
|
|
17499
17499
|
*
|
|
17500
|
-
* New default change tag qname. Pass a value to *change* the default; omit (
|
|
17500
|
+
* New default change tag qname. Pass a value to *change* the default; omit (`None`) to leave unchanged. There is no wire-level way to clear the default — see the class docstring.
|
|
17501
17501
|
*/
|
|
17502
17502
|
default_change_tag_qname?: string | null;
|
|
17503
17503
|
/**
|
|
@@ -17610,7 +17610,7 @@ export type UpdateSecurityOperation = {
|
|
|
17610
17610
|
/**
|
|
17611
17611
|
* UpdateTaxonomyBlockRequest
|
|
17612
17612
|
*
|
|
17613
|
-
* Request body for the
|
|
17613
|
+
* Request body for the `update-taxonomy-block` operation.
|
|
17614
17614
|
*
|
|
17615
17615
|
* Top-level fields (name / description / version) apply to the taxonomy
|
|
17616
17616
|
* row itself. The delta lists mutate atoms incrementally — the validator
|
|
@@ -17688,8 +17688,8 @@ export type UpdateTaxonomyBlockRequest = {
|
|
|
17688
17688
|
*
|
|
17689
17689
|
* Request model for updating user profile.
|
|
17690
17690
|
*
|
|
17691
|
-
* Changing
|
|
17692
|
-
*
|
|
17691
|
+
* Changing `email` re-authenticates: a fresh proof (password re-entry or a
|
|
17692
|
+
* `mgmt`-flow passkey assertion) must accompany the request, exactly as
|
|
17693
17693
|
* passkey enrollment and removal require. Name-only updates need no proof.
|
|
17694
17694
|
*/
|
|
17695
17695
|
export type UpdateUserRequest = {
|
|
@@ -17802,7 +17802,7 @@ export type UserResponse = {
|
|
|
17802
17802
|
*
|
|
17803
17803
|
* Every rule runs once per rendered period column; on a multi-column
|
|
17804
17804
|
* statement each failure and warning is prefixed with the column it was
|
|
17805
|
-
* found in (
|
|
17805
|
+
* found in (`[Prior] …`).
|
|
17806
17806
|
*/
|
|
17807
17807
|
export type ValidationCheckResponse = {
|
|
17808
17808
|
/**
|
|
@@ -17869,7 +17869,7 @@ export type ValidationError = {
|
|
|
17869
17869
|
* Outcome of guard-rail validation on a rendered statement.
|
|
17870
17870
|
*
|
|
17871
17871
|
* Distinct from :class:`VerificationResultLite` (which surfaces the
|
|
17872
|
-
* rule-engine outcomes from
|
|
17872
|
+
* rule-engine outcomes from `public.verification_results`). This lite
|
|
17873
17873
|
* type carries the synchronous guard-rail checks computed at
|
|
17874
17874
|
* envelope-build time — accounting equation, totals foot, etc.
|
|
17875
17875
|
*/
|
|
@@ -17898,11 +17898,11 @@ export type ValidationLite = {
|
|
|
17898
17898
|
/**
|
|
17899
17899
|
* VerificationCategorySummary
|
|
17900
17900
|
*
|
|
17901
|
-
* Pass/fail/skip counts for one
|
|
17901
|
+
* Pass/fail/skip counts for one `rule_category` within a block's
|
|
17902
17902
|
* verification results.
|
|
17903
17903
|
*
|
|
17904
17904
|
* Drives the per-category accordions in the Verification Results panel.
|
|
17905
|
-
*
|
|
17905
|
+
* `category` is the rule's `rule_category`
|
|
17906
17906
|
* (one of the cm:VerificationRule subclasses), resolved by joining each
|
|
17907
17907
|
* result to its Rule.
|
|
17908
17908
|
*/
|
|
@@ -17937,9 +17937,9 @@ export type VerificationCategorySummary = {
|
|
|
17937
17937
|
*
|
|
17938
17938
|
* Persisted outcome of one Rule evaluation.
|
|
17939
17939
|
*
|
|
17940
|
-
* One row per
|
|
17940
|
+
* One row per `public.verification_results` entry the rule engine
|
|
17941
17941
|
* writes. The envelope surfaces them so the block viewer's
|
|
17942
|
-
* "Verification Results" tab and MCP
|
|
17942
|
+
* "Verification Results" tab and MCP `list-verification-failures`
|
|
17943
17943
|
* tool can render + aggregate without a second round-trip.
|
|
17944
17944
|
*/
|
|
17945
17945
|
export type VerificationResultLite = {
|
|
@@ -17962,7 +17962,7 @@ export type VerificationResultLite = {
|
|
|
17962
17962
|
/**
|
|
17963
17963
|
* Status
|
|
17964
17964
|
*
|
|
17965
|
-
* 'pass' | 'fail' | 'error' | 'skipped'. Enum closure enforced by the
|
|
17965
|
+
* 'pass' | 'fail' | 'error' | 'skipped'. Enum closure enforced by the `public.verification_results` CHECK constraint.
|
|
17966
17966
|
*/
|
|
17967
17967
|
status: string;
|
|
17968
17968
|
/**
|
|
@@ -17985,13 +17985,13 @@ export type VerificationResultLite = {
|
|
|
17985
17985
|
/**
|
|
17986
17986
|
* VerificationSummary
|
|
17987
17987
|
*
|
|
17988
|
-
* Server-computed aggregate of a block's
|
|
17988
|
+
* Server-computed aggregate of a block's `verification_results`.
|
|
17989
17989
|
*
|
|
17990
|
-
* Overall counts plus a per
|
|
17990
|
+
* Overall counts plus a per-`rule_category` breakdown, so the viewer
|
|
17991
17991
|
* renders the grouped Verification Results panel
|
|
17992
17992
|
* without a client-side results→rules join. Status closure is
|
|
17993
|
-
*
|
|
17994
|
-
* CHECK);
|
|
17993
|
+
* `pass | fail | error | skipped` (the `public.verification_results`
|
|
17994
|
+
* CHECK); `total` is their sum.
|
|
17995
17995
|
*/
|
|
17996
17996
|
export type VerificationSummary = {
|
|
17997
17997
|
/**
|
|
@@ -18114,21 +18114,21 @@ export type ViewMetadata = {
|
|
|
18114
18114
|
/**
|
|
18115
18115
|
* ViewProjections
|
|
18116
18116
|
*
|
|
18117
|
-
* Charlie's six
|
|
18117
|
+
* Charlie's six `type-of View` arms, surfaced at the envelope boundary.
|
|
18118
18118
|
*
|
|
18119
18119
|
* Each projection is computed server-side at envelope-build time when
|
|
18120
|
-
* its source data is available. The frontend's
|
|
18120
|
+
* its source data is available. The frontend's `BlockView` dispatcher
|
|
18121
18121
|
* routes to the projection component matching the user's selected view
|
|
18122
18122
|
* mode; missing projections (those still in backlog) render as empty
|
|
18123
18123
|
* states without breaking the dispatcher.
|
|
18124
18124
|
*
|
|
18125
|
-
* Today:
|
|
18126
|
-
*
|
|
18125
|
+
* Today: `rendering` is computed for the statement family, and
|
|
18126
|
+
* `chart` (the 7th arm — panel/series config over the rendering's
|
|
18127
18127
|
* rows and periods) for metric blocks.
|
|
18128
|
-
* Other arms (
|
|
18129
|
-
*
|
|
18130
|
-
* support lands;
|
|
18131
|
-
*
|
|
18128
|
+
* Other arms (`fact_table`, `model_structure`, `verification_results`,
|
|
18129
|
+
* `report_elements`, `business_rules`) come online as their backend
|
|
18130
|
+
* support lands; `fact_table` is trivially derivable from
|
|
18131
|
+
* `InformationBlockEnvelope.facts` and may stay as a frontend-only
|
|
18132
18132
|
* projection.
|
|
18133
18133
|
*/
|
|
18134
18134
|
export type ViewProjections = {
|
|
@@ -18174,11 +18174,11 @@ export type ViewResponse = {
|
|
|
18174
18174
|
/**
|
|
18175
18175
|
* _CreateForecastArm
|
|
18176
18176
|
*
|
|
18177
|
-
* Create-information-block body for
|
|
18177
|
+
* Create-information-block body for `block_type="forecast"`.
|
|
18178
18178
|
*
|
|
18179
18179
|
* Carries a typed forecast payload — the authored scenario container:
|
|
18180
18180
|
* scenario identity, horizon, base period, lever assertions on
|
|
18181
|
-
*
|
|
18181
|
+
* `rs-driver:*` catalog elements. Run `compute-forecast` after
|
|
18182
18182
|
* creating to derive the forward months.
|
|
18183
18183
|
*/
|
|
18184
18184
|
export type CreateForecastArm = {
|
|
@@ -18228,7 +18228,7 @@ export type CreateLegacyArm = {
|
|
|
18228
18228
|
/**
|
|
18229
18229
|
* _CreateRollforwardArm
|
|
18230
18230
|
*
|
|
18231
|
-
* Create-information-block body for
|
|
18231
|
+
* Create-information-block body for `block_type="rollforward"`.
|
|
18232
18232
|
*
|
|
18233
18233
|
* Carries a typed rollforward payload. The block decomposes the period
|
|
18234
18234
|
* change in a BS source element across the declared attribution
|
|
@@ -18269,7 +18269,7 @@ export type CreateScheduleArm = {
|
|
|
18269
18269
|
/**
|
|
18270
18270
|
* _DeleteForecastArm
|
|
18271
18271
|
*
|
|
18272
|
-
* Delete-information-block body for
|
|
18272
|
+
* Delete-information-block body for `block_type="forecast"`.
|
|
18273
18273
|
*
|
|
18274
18274
|
* Removes the scenario's entire parallel universe — the lever FactSet
|
|
18275
18275
|
* and every computed scenario FactSet. Actuals are never touched.
|
|
@@ -18315,7 +18315,7 @@ export type DeleteLegacyArm = {
|
|
|
18315
18315
|
/**
|
|
18316
18316
|
* _DeleteRollforwardArm
|
|
18317
18317
|
*
|
|
18318
|
-
* Delete-information-block body for
|
|
18318
|
+
* Delete-information-block body for `block_type="rollforward"`.
|
|
18319
18319
|
*
|
|
18320
18320
|
* Cascades through any synthetic facts produced by this block's filter
|
|
18321
18321
|
* evaluations. The underlying ledger LineItems are not touched.
|
|
@@ -18354,10 +18354,10 @@ export type DeleteScheduleArm = {
|
|
|
18354
18354
|
/**
|
|
18355
18355
|
* _UpdateForecastArm
|
|
18356
18356
|
*
|
|
18357
|
-
* Update-information-block body for
|
|
18357
|
+
* Update-information-block body for `block_type="forecast"`.
|
|
18358
18358
|
*
|
|
18359
18359
|
* Mutable: name, scenario_kind, horizon_months, base_period, levers
|
|
18360
|
-
* (full replace). Updating does not recompute — run
|
|
18360
|
+
* (full replace). Updating does not recompute — run `compute-forecast`
|
|
18361
18361
|
* to refresh the scenario's derived months.
|
|
18362
18362
|
*/
|
|
18363
18363
|
export type UpdateForecastArm = {
|
|
@@ -18401,7 +18401,7 @@ export type UpdateLegacyArm = {
|
|
|
18401
18401
|
/**
|
|
18402
18402
|
* _UpdateRollforwardArm
|
|
18403
18403
|
*
|
|
18404
|
-
* Update-information-block body for
|
|
18404
|
+
* Update-information-block body for `block_type="rollforward"`.
|
|
18405
18405
|
*
|
|
18406
18406
|
* Carries a typed rollforward update payload. Mutable fields: name,
|
|
18407
18407
|
* default_change_tag_qname, attribution_filters, validation_mode.
|
|
@@ -25099,7 +25099,22 @@ export type HandleHttpGetExtensionsGraphIdGraphqlGetResponses = {
|
|
|
25099
25099
|
200: unknown;
|
|
25100
25100
|
};
|
|
25101
25101
|
export type HandleHttpPostExtensionsGraphIdGraphqlPostData = {
|
|
25102
|
-
body
|
|
25102
|
+
body: {
|
|
25103
|
+
/**
|
|
25104
|
+
* The GraphQL document to execute.
|
|
25105
|
+
*/
|
|
25106
|
+
query: string;
|
|
25107
|
+
/**
|
|
25108
|
+
* Values for the document's variables.
|
|
25109
|
+
*/
|
|
25110
|
+
variables?: {
|
|
25111
|
+
[key: string]: unknown;
|
|
25112
|
+
};
|
|
25113
|
+
/**
|
|
25114
|
+
* Which operation to run, when the document declares more than one.
|
|
25115
|
+
*/
|
|
25116
|
+
operationName?: string;
|
|
25117
|
+
};
|
|
25103
25118
|
path: {
|
|
25104
25119
|
/**
|
|
25105
25120
|
* Graph Id
|
|
@@ -28202,8 +28217,8 @@ export type UnblockSourceGraphResponses = {
|
|
|
28202
28217
|
200: OperationEnvelopeBlockedSourceGraphResponse;
|
|
28203
28218
|
};
|
|
28204
28219
|
export type UnblockSourceGraphResponse = UnblockSourceGraphResponses[keyof UnblockSourceGraphResponses];
|
|
28205
|
-
export type
|
|
28206
|
-
body:
|
|
28220
|
+
export type BuildFactGridData = {
|
|
28221
|
+
body: CreateViewRequest;
|
|
28207
28222
|
headers?: {
|
|
28208
28223
|
/**
|
|
28209
28224
|
* Idempotency-Key
|
|
@@ -28217,9 +28232,9 @@ export type LiveFinancialStatementData = {
|
|
|
28217
28232
|
graph_id: string;
|
|
28218
28233
|
};
|
|
28219
28234
|
query?: never;
|
|
28220
|
-
url: '/extensions/roboledger/{graph_id}/operations/
|
|
28235
|
+
url: '/extensions/roboledger/{graph_id}/operations/build-fact-grid';
|
|
28221
28236
|
};
|
|
28222
|
-
export type
|
|
28237
|
+
export type BuildFactGridErrors = {
|
|
28223
28238
|
/**
|
|
28224
28239
|
* Invalid request
|
|
28225
28240
|
*/
|
|
@@ -28253,16 +28268,16 @@ export type LiveFinancialStatementErrors = {
|
|
|
28253
28268
|
*/
|
|
28254
28269
|
500: ErrorResponse;
|
|
28255
28270
|
};
|
|
28256
|
-
export type
|
|
28257
|
-
export type
|
|
28271
|
+
export type BuildFactGridError = BuildFactGridErrors[keyof BuildFactGridErrors];
|
|
28272
|
+
export type BuildFactGridResponses = {
|
|
28258
28273
|
/**
|
|
28259
28274
|
* Successful Response
|
|
28260
28275
|
*/
|
|
28261
|
-
200:
|
|
28276
|
+
200: OperationEnvelopeViewResponse;
|
|
28262
28277
|
};
|
|
28263
|
-
export type
|
|
28264
|
-
export type
|
|
28265
|
-
body:
|
|
28278
|
+
export type BuildFactGridResponse = BuildFactGridResponses[keyof BuildFactGridResponses];
|
|
28279
|
+
export type FinancialStatementAnalysisData = {
|
|
28280
|
+
body: FinancialStatementAnalysisRequest;
|
|
28266
28281
|
headers?: {
|
|
28267
28282
|
/**
|
|
28268
28283
|
* Idempotency-Key
|
|
@@ -28276,9 +28291,9 @@ export type BuildFactGridData = {
|
|
|
28276
28291
|
graph_id: string;
|
|
28277
28292
|
};
|
|
28278
28293
|
query?: never;
|
|
28279
|
-
url: '/extensions/roboledger/{graph_id}/operations/
|
|
28294
|
+
url: '/extensions/roboledger/{graph_id}/operations/financial-statement-analysis';
|
|
28280
28295
|
};
|
|
28281
|
-
export type
|
|
28296
|
+
export type FinancialStatementAnalysisErrors = {
|
|
28282
28297
|
/**
|
|
28283
28298
|
* Invalid request
|
|
28284
28299
|
*/
|
|
@@ -28312,16 +28327,16 @@ export type BuildFactGridErrors = {
|
|
|
28312
28327
|
*/
|
|
28313
28328
|
500: ErrorResponse;
|
|
28314
28329
|
};
|
|
28315
|
-
export type
|
|
28316
|
-
export type
|
|
28330
|
+
export type FinancialStatementAnalysisError = FinancialStatementAnalysisErrors[keyof FinancialStatementAnalysisErrors];
|
|
28331
|
+
export type FinancialStatementAnalysisResponses = {
|
|
28317
28332
|
/**
|
|
28318
28333
|
* Successful Response
|
|
28319
28334
|
*/
|
|
28320
|
-
200:
|
|
28335
|
+
200: OperationEnvelopeFinancialStatementAnalysisResponse;
|
|
28321
28336
|
};
|
|
28322
|
-
export type
|
|
28323
|
-
export type
|
|
28324
|
-
body:
|
|
28337
|
+
export type FinancialStatementAnalysisResponse2 = FinancialStatementAnalysisResponses[keyof FinancialStatementAnalysisResponses];
|
|
28338
|
+
export type DisclosuresData = {
|
|
28339
|
+
body: DisclosuresRequest;
|
|
28325
28340
|
headers?: {
|
|
28326
28341
|
/**
|
|
28327
28342
|
* Idempotency-Key
|
|
@@ -28335,9 +28350,9 @@ export type FinancialStatementAnalysisData = {
|
|
|
28335
28350
|
graph_id: string;
|
|
28336
28351
|
};
|
|
28337
28352
|
query?: never;
|
|
28338
|
-
url: '/extensions/roboledger/{graph_id}/operations/
|
|
28353
|
+
url: '/extensions/roboledger/{graph_id}/operations/disclosures';
|
|
28339
28354
|
};
|
|
28340
|
-
export type
|
|
28355
|
+
export type DisclosuresErrors = {
|
|
28341
28356
|
/**
|
|
28342
28357
|
* Invalid request
|
|
28343
28358
|
*/
|
|
@@ -28371,16 +28386,16 @@ export type FinancialStatementAnalysisErrors = {
|
|
|
28371
28386
|
*/
|
|
28372
28387
|
500: ErrorResponse;
|
|
28373
28388
|
};
|
|
28374
|
-
export type
|
|
28375
|
-
export type
|
|
28389
|
+
export type DisclosuresError = DisclosuresErrors[keyof DisclosuresErrors];
|
|
28390
|
+
export type DisclosuresResponses = {
|
|
28376
28391
|
/**
|
|
28377
28392
|
* Successful Response
|
|
28378
28393
|
*/
|
|
28379
|
-
200:
|
|
28394
|
+
200: OperationEnvelopeDisclosuresResponse;
|
|
28380
28395
|
};
|
|
28381
|
-
export type
|
|
28382
|
-
export type
|
|
28383
|
-
body:
|
|
28396
|
+
export type DisclosuresResponse2 = DisclosuresResponses[keyof DisclosuresResponses];
|
|
28397
|
+
export type InformationBlockData = {
|
|
28398
|
+
body: InformationBlockRequest;
|
|
28384
28399
|
headers?: {
|
|
28385
28400
|
/**
|
|
28386
28401
|
* Idempotency-Key
|
|
@@ -28394,9 +28409,9 @@ export type DisclosuresData = {
|
|
|
28394
28409
|
graph_id: string;
|
|
28395
28410
|
};
|
|
28396
28411
|
query?: never;
|
|
28397
|
-
url: '/extensions/roboledger/{graph_id}/operations/
|
|
28412
|
+
url: '/extensions/roboledger/{graph_id}/operations/information-block';
|
|
28398
28413
|
};
|
|
28399
|
-
export type
|
|
28414
|
+
export type InformationBlockErrors = {
|
|
28400
28415
|
/**
|
|
28401
28416
|
* Invalid request
|
|
28402
28417
|
*/
|
|
@@ -28430,16 +28445,16 @@ export type DisclosuresErrors = {
|
|
|
28430
28445
|
*/
|
|
28431
28446
|
500: ErrorResponse;
|
|
28432
28447
|
};
|
|
28433
|
-
export type
|
|
28434
|
-
export type
|
|
28448
|
+
export type InformationBlockError = InformationBlockErrors[keyof InformationBlockErrors];
|
|
28449
|
+
export type InformationBlockResponses = {
|
|
28435
28450
|
/**
|
|
28436
28451
|
* Successful Response
|
|
28437
28452
|
*/
|
|
28438
|
-
200:
|
|
28453
|
+
200: OperationEnvelopeInformationBlockResponse;
|
|
28439
28454
|
};
|
|
28440
|
-
export type
|
|
28441
|
-
export type
|
|
28442
|
-
body:
|
|
28455
|
+
export type InformationBlockResponse2 = InformationBlockResponses[keyof InformationBlockResponses];
|
|
28456
|
+
export type LiveFinancialStatementData = {
|
|
28457
|
+
body: LiveFinancialStatementRequest;
|
|
28443
28458
|
headers?: {
|
|
28444
28459
|
/**
|
|
28445
28460
|
* Idempotency-Key
|
|
@@ -28453,9 +28468,9 @@ export type InformationBlockData = {
|
|
|
28453
28468
|
graph_id: string;
|
|
28454
28469
|
};
|
|
28455
28470
|
query?: never;
|
|
28456
|
-
url: '/extensions/roboledger/{graph_id}/operations/
|
|
28471
|
+
url: '/extensions/roboledger/{graph_id}/operations/live-financial-statement';
|
|
28457
28472
|
};
|
|
28458
|
-
export type
|
|
28473
|
+
export type LiveFinancialStatementErrors = {
|
|
28459
28474
|
/**
|
|
28460
28475
|
* Invalid request
|
|
28461
28476
|
*/
|
|
@@ -28489,14 +28504,14 @@ export type InformationBlockErrors = {
|
|
|
28489
28504
|
*/
|
|
28490
28505
|
500: ErrorResponse;
|
|
28491
28506
|
};
|
|
28492
|
-
export type
|
|
28493
|
-
export type
|
|
28507
|
+
export type LiveFinancialStatementError = LiveFinancialStatementErrors[keyof LiveFinancialStatementErrors];
|
|
28508
|
+
export type LiveFinancialStatementResponses = {
|
|
28494
28509
|
/**
|
|
28495
28510
|
* Successful Response
|
|
28496
28511
|
*/
|
|
28497
|
-
200:
|
|
28512
|
+
200: OperationEnvelopeLiveFinancialStatementResponse;
|
|
28498
28513
|
};
|
|
28499
|
-
export type
|
|
28514
|
+
export type LiveFinancialStatementResponse2 = LiveFinancialStatementResponses[keyof LiveFinancialStatementResponses];
|
|
28500
28515
|
export type CreatePortfolioBlockData = {
|
|
28501
28516
|
body: CreatePortfolioBlockRequest;
|
|
28502
28517
|
headers?: {
|