@robosystems/client 2.0.0 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- 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/sdk/types.gen.ts
CHANGED
|
@@ -229,17 +229,17 @@ export type ArtifactResponse = {
|
|
|
229
229
|
/**
|
|
230
230
|
* AssertMetricsRequest
|
|
231
231
|
*
|
|
232
|
-
* Request body for the
|
|
232
|
+
* Request body for the `assert-metrics` operation.
|
|
233
233
|
*
|
|
234
|
-
* The observation sibling of
|
|
234
|
+
* The observation sibling of `compute-metrics`: writes externally-
|
|
235
235
|
* observed values (usage counts, marketing numbers, hand-carried
|
|
236
|
-
* figures) into the period's standing
|
|
237
|
-
* with
|
|
236
|
+
* figures) into the period's standing `factset_type='metric'` FactSet
|
|
237
|
+
* with `AssertedProvenance`. Re-asserting a period replaces its facts
|
|
238
238
|
* — one standing FactSet per (structure, entity, period_end), the
|
|
239
239
|
* accumulating time series.
|
|
240
240
|
*
|
|
241
|
-
* Structures carrying
|
|
242
|
-
* (
|
|
241
|
+
* Structures carrying `Derive` rules are compute-owned
|
|
242
|
+
* (`compute-metrics`) and rejected — asserted and derived metric
|
|
243
243
|
* series keep disjoint structures. Asserted series are actuals; there
|
|
244
244
|
* is no scenario axis.
|
|
245
245
|
*/
|
|
@@ -291,7 +291,7 @@ export type AssertMetricsRequest = {
|
|
|
291
291
|
/**
|
|
292
292
|
* AssertMetricsResponse
|
|
293
293
|
*
|
|
294
|
-
* Response for the
|
|
294
|
+
* Response for the `assert-metrics` operation.
|
|
295
295
|
*/
|
|
296
296
|
export type AssertMetricsResponse = {
|
|
297
297
|
/**
|
|
@@ -327,7 +327,7 @@ export type AssertMetricsResponse = {
|
|
|
327
327
|
/**
|
|
328
328
|
* AssertedMetricLite
|
|
329
329
|
*
|
|
330
|
-
* One metric written by an
|
|
330
|
+
* One metric written by an `assert-metrics` run.
|
|
331
331
|
*/
|
|
332
332
|
export type AssertedMetricLite = {
|
|
333
333
|
/**
|
|
@@ -380,10 +380,10 @@ export type AssertedMetricLite = {
|
|
|
380
380
|
* One edge between two elements within a structure (parent/child
|
|
381
381
|
* presentation, calculation rollup, mapping, equivalence).
|
|
382
382
|
*
|
|
383
|
-
*
|
|
383
|
+
* `association_type` discriminates the edge semantics. Mapping edges
|
|
384
384
|
* are the user-facing path (CoA → reporting concept); presentation /
|
|
385
385
|
* calculation edges express structure layout and roll-ups.
|
|
386
|
-
*
|
|
386
|
+
* `confidence` is set on AI-suggested mappings (≥0.90 auto-approved,
|
|
387
387
|
* 0.70-0.89 flagged for review).
|
|
388
388
|
*/
|
|
389
389
|
export type AssociationResponse = {
|
|
@@ -452,11 +452,11 @@ export type AssociationResponse = {
|
|
|
452
452
|
*
|
|
453
453
|
* Pairs a target concept (the flow leaf the matched amount counts
|
|
454
454
|
* toward) with a predicate (which LineItems match). The rollforward's
|
|
455
|
-
*
|
|
455
|
+
* `attribution_filters: list[AttributionFilter]` declares every flow
|
|
456
456
|
* the BS source decomposes into; the renderer evaluates them all per
|
|
457
457
|
* period.
|
|
458
458
|
*
|
|
459
|
-
*
|
|
459
|
+
* `target_element_id` is resolved at create time from `target_qname`
|
|
460
460
|
* via the rs-gaap library + tenant taxonomy lookup. Authors only need
|
|
461
461
|
* to provide the qname; the element_id is filled in by the create
|
|
462
462
|
* handler and the resolved value is what the envelope round-trips.
|
|
@@ -465,13 +465,13 @@ export type AttributionFilter = {
|
|
|
465
465
|
/**
|
|
466
466
|
* Target Qname
|
|
467
467
|
*
|
|
468
|
-
* QName of the flow concept this filter produces facts for — e.g.
|
|
468
|
+
* QName of the flow concept this filter produces facts for — e.g. `rs-gaap:ProceedsFromIssuanceOfCommonStock`. Resolved to `target_element_id` at create time.
|
|
469
469
|
*/
|
|
470
470
|
target_qname: string;
|
|
471
471
|
/**
|
|
472
472
|
* Target Element Id
|
|
473
473
|
*
|
|
474
|
-
* Resolved element id for
|
|
474
|
+
* Resolved element id for `target_qname`. Null at create time; populated by the handler before persistence. Round-tripped in the envelope.
|
|
475
475
|
*/
|
|
476
476
|
target_element_id?: string | null;
|
|
477
477
|
/**
|
|
@@ -1440,9 +1440,9 @@ export type ChangeTierOp = {
|
|
|
1440
1440
|
*
|
|
1441
1441
|
* Server-shaped chart projection — panel/series CONFIG, never values.
|
|
1442
1442
|
*
|
|
1443
|
-
* The second real server-computed View arm (after
|
|
1444
|
-
* come from
|
|
1445
|
-
*
|
|
1443
|
+
* The second real server-computed View arm (after `rendering`). Values
|
|
1444
|
+
* come from `rendering.rows` joined by `element_id`; the x-axis is
|
|
1445
|
+
* `rendering.periods`. Renderers (report-components) turn one panel
|
|
1446
1446
|
* into one chart.
|
|
1447
1447
|
*/
|
|
1448
1448
|
export type ChartLite = {
|
|
@@ -1458,8 +1458,8 @@ export type ChartLite = {
|
|
|
1458
1458
|
* One chart panel — series sharing a y-axis format family.
|
|
1459
1459
|
*
|
|
1460
1460
|
* Mixed-unit catalogs are unplottable on one axis, so the server groups
|
|
1461
|
-
* rows into panels by
|
|
1462
|
-
*
|
|
1461
|
+
* rows into panels by `item_type` family (NULL falls back to
|
|
1462
|
+
* `is_monetary`). The x-axis is always `rendering.periods`.
|
|
1463
1463
|
*/
|
|
1464
1464
|
export type ChartPanelLite = {
|
|
1465
1465
|
/**
|
|
@@ -1492,9 +1492,9 @@ export type ChartPanelLite = {
|
|
|
1492
1492
|
* One plottable series in a chart panel.
|
|
1493
1493
|
*
|
|
1494
1494
|
* Carries structure and identity only — the values live in the sibling
|
|
1495
|
-
*
|
|
1496
|
-
* duplicates the value matrix.
|
|
1497
|
-
* client state (colors, toggles); today it equals
|
|
1495
|
+
* `rendering.rows` (join on `element_id`), so the chart arm never
|
|
1496
|
+
* duplicates the value matrix. `key` is the stable series identity for
|
|
1497
|
+
* client state (colors, toggles); today it equals `element_id`, and
|
|
1498
1498
|
* future axes (the forecast scenario) arrive as new fields on this
|
|
1499
1499
|
* model, never a new arm shape.
|
|
1500
1500
|
*/
|
|
@@ -1769,14 +1769,14 @@ export type ClosePeriodResponse = {
|
|
|
1769
1769
|
/**
|
|
1770
1770
|
* ComputeForecastRequest
|
|
1771
1771
|
*
|
|
1772
|
-
* Request body for the
|
|
1772
|
+
* Request body for the `compute-forecast` operation.
|
|
1773
1773
|
*
|
|
1774
1774
|
* Walks the scenario's driver cascade month-by-month forward from the
|
|
1775
|
-
* forecast block's
|
|
1775
|
+
* forecast block's `base_period`: lever-driven Derive rules in
|
|
1776
1776
|
* dependency order, carry-forward for unmodeled IS lines, calc-DAG
|
|
1777
1777
|
* subtotals — upserting one scenario IS FactSet (+ a working-capital BS
|
|
1778
1778
|
* set) per forward month, all keyed by the forecast block's
|
|
1779
|
-
*
|
|
1779
|
+
* `scenario_id`. Re-running replaces each month's values (the
|
|
1780
1780
|
* compute-metrics drift semantics). Deterministic and non-AI — no
|
|
1781
1781
|
* credits consumed.
|
|
1782
1782
|
*/
|
|
@@ -1804,7 +1804,7 @@ export type ComputeForecastRequest = {
|
|
|
1804
1804
|
/**
|
|
1805
1805
|
* ComputeForecastResponse
|
|
1806
1806
|
*
|
|
1807
|
-
* Response for the
|
|
1807
|
+
* Response for the `compute-forecast` operation.
|
|
1808
1808
|
*/
|
|
1809
1809
|
export type ComputeForecastResponse = {
|
|
1810
1810
|
/**
|
|
@@ -1824,13 +1824,13 @@ export type ComputeForecastResponse = {
|
|
|
1824
1824
|
/**
|
|
1825
1825
|
* Base Period
|
|
1826
1826
|
*
|
|
1827
|
-
* Origin month of the block's authored horizon window — where its levers are keyed from. Equal to
|
|
1827
|
+
* 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.
|
|
1828
1828
|
*/
|
|
1829
1829
|
base_period: string;
|
|
1830
1830
|
/**
|
|
1831
1831
|
* Anchor Period
|
|
1832
1832
|
*
|
|
1833
|
-
* Month the walk actually seeded its opening balances from. With
|
|
1833
|
+
* 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`.
|
|
1834
1834
|
*/
|
|
1835
1835
|
anchor_period: string;
|
|
1836
1836
|
/**
|
|
@@ -1846,7 +1846,7 @@ export type ComputeForecastResponse = {
|
|
|
1846
1846
|
/**
|
|
1847
1847
|
* Halted At
|
|
1848
1848
|
*
|
|
1849
|
-
* Month (
|
|
1849
|
+
* 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.
|
|
1850
1850
|
*/
|
|
1851
1851
|
halted_at?: string | null;
|
|
1852
1852
|
/**
|
|
@@ -1864,12 +1864,12 @@ export type ComputeForecastResponse = {
|
|
|
1864
1864
|
/**
|
|
1865
1865
|
* ComputeMetricsRequest
|
|
1866
1866
|
*
|
|
1867
|
-
* Request body for the
|
|
1867
|
+
* Request body for the `compute-metrics` operation.
|
|
1868
1868
|
*
|
|
1869
|
-
* Resolves the
|
|
1869
|
+
* Resolves the `Derive` rules scoped to the metric block, binds each
|
|
1870
1870
|
* rule's operands to the entity's most recent persisted report facts at
|
|
1871
|
-
*
|
|
1872
|
-
*
|
|
1871
|
+
* `period_end`, evaluates, and upserts the period's standing
|
|
1872
|
+
* `factset_type='metric'` FactSet (re-running a period replaces its
|
|
1873
1873
|
* facts). One standing FactSet per (structure, entity, period_end) — the
|
|
1874
1874
|
* accumulating time series.
|
|
1875
1875
|
*/
|
|
@@ -1909,7 +1909,7 @@ export type ComputeMetricsRequest = {
|
|
|
1909
1909
|
/**
|
|
1910
1910
|
* ComputeMetricsResponse
|
|
1911
1911
|
*
|
|
1912
|
-
* Response for the
|
|
1912
|
+
* Response for the `compute-metrics` operation.
|
|
1913
1913
|
*/
|
|
1914
1914
|
export type ComputeMetricsResponse = {
|
|
1915
1915
|
/**
|
|
@@ -1943,7 +1943,7 @@ export type ComputeMetricsResponse = {
|
|
|
1943
1943
|
/**
|
|
1944
1944
|
* ComputedMetricLite
|
|
1945
1945
|
*
|
|
1946
|
-
* One metric computed by a
|
|
1946
|
+
* One metric computed by a `compute-metrics` run.
|
|
1947
1947
|
*/
|
|
1948
1948
|
export type ComputedMetricLite = {
|
|
1949
1949
|
/**
|
|
@@ -2002,7 +2002,7 @@ export type ComputedMetricLite = {
|
|
|
2002
2002
|
* Connection (= Association) projection.
|
|
2003
2003
|
*
|
|
2004
2004
|
* "Connection" is the ontology term used on the wire; the storage table is
|
|
2005
|
-
*
|
|
2005
|
+
* `associations` (`models/extensions/association.py`).
|
|
2006
2006
|
*/
|
|
2007
2007
|
export type ConnectionLite = {
|
|
2008
2008
|
/**
|
|
@@ -2338,11 +2338,11 @@ export type CreateApiKeyResponse = {
|
|
|
2338
2338
|
*
|
|
2339
2339
|
* Create a new economic counterparty.
|
|
2340
2340
|
*
|
|
2341
|
-
*
|
|
2341
|
+
* `agent_type` is the relationship category (customer, vendor,
|
|
2342
2342
|
* employee, etc.) — the same legal entity may have multiple Agent rows
|
|
2343
2343
|
* if they play multiple roles (e.g. a vendor who also became a
|
|
2344
|
-
* customer).
|
|
2345
|
-
* native-created ones;
|
|
2344
|
+
* customer). `source` distinguishes integration-imported rows from
|
|
2345
|
+
* native-created ones; `external_id` carries the source-system's
|
|
2346
2346
|
* primary key for sync.
|
|
2347
2347
|
*/
|
|
2348
2348
|
export type CreateAgentRequest = {
|
|
@@ -2623,16 +2623,16 @@ export type CreateEventBlockRequest = {
|
|
|
2623
2623
|
*
|
|
2624
2624
|
* Register a new event-type → transaction-template rule.
|
|
2625
2625
|
*
|
|
2626
|
-
* When
|
|
2626
|
+
* When `create-event-block` runs with `apply_handlers=True`, the
|
|
2627
2627
|
* registry resolves the *highest-priority active* handler whose match
|
|
2628
2628
|
* criteria all match the event, then evaluates the
|
|
2629
|
-
*
|
|
2630
|
-
* active handlers for the same
|
|
2629
|
+
* `transaction_template` to produce GL rows. Match precedence: among
|
|
2630
|
+
* active handlers for the same `event_type`, the one with the most
|
|
2631
2631
|
* specific match (more match fields satisfied) wins; ties broken by
|
|
2632
|
-
*
|
|
2632
|
+
* `priority` desc, then `created_at` asc.
|
|
2633
2633
|
*
|
|
2634
|
-
* All match fields except
|
|
2635
|
-
* unset matches anything. Use
|
|
2634
|
+
* All match fields except `event_type` are optional — leaving them
|
|
2635
|
+
* unset matches anything. Use `match_metadata_expression` for
|
|
2636
2636
|
* fine-grained discrimination (e.g. only payroll categories).
|
|
2637
2637
|
*/
|
|
2638
2638
|
export type CreateEventHandlerRequest = {
|
|
@@ -2723,8 +2723,8 @@ export type CreateEventHandlerRequest = {
|
|
|
2723
2723
|
*
|
|
2724
2724
|
* Create a forecast block — the authored scenario container.
|
|
2725
2725
|
*
|
|
2726
|
-
*
|
|
2727
|
-
*
|
|
2726
|
+
* `base_period` defaults to the fiscal calendar's
|
|
2727
|
+
* `closed_through_period` (else the newest actual report month) —
|
|
2728
2728
|
* the walk projects forward from the last closed actuals. The resolved
|
|
2729
2729
|
* value is stored in the mechanics so recompute is deterministic.
|
|
2730
2730
|
*/
|
|
@@ -2750,13 +2750,13 @@ export type CreateForecastRequest = {
|
|
|
2750
2750
|
/**
|
|
2751
2751
|
* Base Period
|
|
2752
2752
|
*
|
|
2753
|
-
* Seed month (
|
|
2753
|
+
* 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.
|
|
2754
2754
|
*/
|
|
2755
2755
|
base_period?: string | null;
|
|
2756
2756
|
/**
|
|
2757
2757
|
* Base Anchor
|
|
2758
2758
|
*
|
|
2759
|
-
* Where the walk takes its opening balances as periods close.
|
|
2759
|
+
* 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.
|
|
2760
2760
|
*/
|
|
2761
2761
|
base_anchor?: 'seam' | 'fixed';
|
|
2762
2762
|
/**
|
|
@@ -2971,15 +2971,15 @@ export type CreatePublishListRequest = {
|
|
|
2971
2971
|
*
|
|
2972
2972
|
* The report is materialized synchronously: we resolve the taxonomy +
|
|
2973
2973
|
* CoA mapping, roll up GL facts into reportable concepts, attach them
|
|
2974
|
-
* to a fresh
|
|
2975
|
-
* (cell-level checks), and stamp
|
|
2976
|
-
* Subsequent
|
|
2974
|
+
* to a fresh `Report` row, evaluate any reporting-rule structures
|
|
2975
|
+
* (cell-level checks), and stamp `generation_status='published'`.
|
|
2976
|
+
* Subsequent `regenerate-report` calls re-run the same pipeline against
|
|
2977
2977
|
* the latest ledger state without creating a new Report row.
|
|
2978
2978
|
*
|
|
2979
|
-
*
|
|
2979
|
+
* `period_start`/`period_end`/`comparative` is the simple path
|
|
2980
2980
|
* (auto-derives current + prior period). For multi-column reports
|
|
2981
|
-
* (YTD-by-quarter, multi-year) supply
|
|
2982
|
-
* set,
|
|
2981
|
+
* (YTD-by-quarter, multi-year) supply `periods` explicitly — when
|
|
2982
|
+
* set, `period_start`/`period_end`/`comparative` are ignored as
|
|
2983
2983
|
* inputs to period generation.
|
|
2984
2984
|
*/
|
|
2985
2985
|
export type CreateReportRequest = {
|
|
@@ -3059,7 +3059,7 @@ export type CreateRepositorySubscriptionRequest = {
|
|
|
3059
3059
|
* Create a rollforward Information Block.
|
|
3060
3060
|
*
|
|
3061
3061
|
* Mirrors :class:`CreateScheduleRequest` in shape. The block decomposes
|
|
3062
|
-
* the period change in
|
|
3062
|
+
* the period change in `bs_source_qname` across the declared
|
|
3063
3063
|
* attribution filters. Residual (Δ BS - Σ filter matches) falls back to
|
|
3064
3064
|
* the default change tag — or, if no default is declared, surfaces as
|
|
3065
3065
|
* an unattributed fact tagged with a synthetic residual concept.
|
|
@@ -3074,7 +3074,7 @@ export type CreateRollforwardRequest = {
|
|
|
3074
3074
|
/**
|
|
3075
3075
|
* Bs Source Qname
|
|
3076
3076
|
*
|
|
3077
|
-
* QName of the balance-sheet element whose period delta this block decomposes. Resolved to
|
|
3077
|
+
* QName of the balance-sheet element whose period delta this block decomposes. Resolved to `bs_source_element_id` at create time.
|
|
3078
3078
|
*/
|
|
3079
3079
|
bs_source_qname: string;
|
|
3080
3080
|
/**
|
|
@@ -3092,13 +3092,13 @@ export type CreateRollforwardRequest = {
|
|
|
3092
3092
|
/**
|
|
3093
3093
|
* Validation Mode
|
|
3094
3094
|
*
|
|
3095
|
-
* How the renderer arbitrates when Σ filter matches != Δ BS.
|
|
3095
|
+
* 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.
|
|
3096
3096
|
*/
|
|
3097
3097
|
validation_mode?: 'strict' | 'residual_as_default' | 'warn_only';
|
|
3098
3098
|
/**
|
|
3099
3099
|
* Taxonomy Id
|
|
3100
3100
|
*
|
|
3101
|
-
* Owning taxonomy id (auto-resolved from
|
|
3101
|
+
* Owning taxonomy id (auto-resolved from `bs_source_qname` when omitted).
|
|
3102
3102
|
*/
|
|
3103
3103
|
taxonomy_id?: string | null;
|
|
3104
3104
|
};
|
|
@@ -3275,14 +3275,14 @@ export type CreateSubgraphRequest = {
|
|
|
3275
3275
|
/**
|
|
3276
3276
|
* CreateTaxonomyBlockRequest
|
|
3277
3277
|
*
|
|
3278
|
-
* Request body for the
|
|
3278
|
+
* Request body for the `create-taxonomy-block` operation.
|
|
3279
3279
|
*
|
|
3280
|
-
* One envelope per taxonomy instance.
|
|
3280
|
+
* One envelope per taxonomy instance. `taxonomy_type` discriminates
|
|
3281
3281
|
* which block-type handler the command dispatcher routes to.
|
|
3282
|
-
*
|
|
3282
|
+
* `parent_taxonomy_id` is required for `reporting_extension` (which
|
|
3283
3283
|
* extends a library taxonomy) and ignored otherwise.
|
|
3284
3284
|
*
|
|
3285
|
-
* The library path (seeding
|
|
3285
|
+
* The library path (seeding `reporting_standard` rows) does NOT flow
|
|
3286
3286
|
* through this envelope; library content is not tenant-writable here.
|
|
3287
3287
|
*/
|
|
3288
3288
|
export type CreateTaxonomyBlockRequest = {
|
|
@@ -3295,13 +3295,13 @@ export type CreateTaxonomyBlockRequest = {
|
|
|
3295
3295
|
/**
|
|
3296
3296
|
* Taxonomy Type
|
|
3297
3297
|
*
|
|
3298
|
-
* Block-type discriminator.
|
|
3298
|
+
* Block-type discriminator. `chart_of_accounts` and `custom_ontology` construct from scratch; `reporting_extension` extends an existing library `reporting_standard`.
|
|
3299
3299
|
*/
|
|
3300
3300
|
taxonomy_type: 'reporting_standard' | 'reporting_extension' | 'custom_ontology' | 'chart_of_accounts' | 'schedule';
|
|
3301
3301
|
/**
|
|
3302
3302
|
* Parent Taxonomy Id
|
|
3303
3303
|
*
|
|
3304
|
-
* Required when
|
|
3304
|
+
* Required when `taxonomy_type == 'reporting_extension'` — the id of the library `reporting_standard` being extended.
|
|
3305
3305
|
*/
|
|
3306
3306
|
parent_taxonomy_id?: string | null;
|
|
3307
3307
|
/**
|
|
@@ -3538,7 +3538,7 @@ export type CreditSummaryResponse = {
|
|
|
3538
3538
|
* Custom node and relationship types for a generic graph.
|
|
3539
3539
|
*
|
|
3540
3540
|
* For graphs that don't fit the entity-based schema — inventory, org charts,
|
|
3541
|
-
* project management.
|
|
3541
|
+
* project management. `extends` names a base schema to build on, or is
|
|
3542
3542
|
* omitted for a bare database.
|
|
3543
3543
|
*/
|
|
3544
3544
|
export type CustomSchemaDefinition = {
|
|
@@ -3966,7 +3966,7 @@ export type DeleteInformationBlockRequest = ({
|
|
|
3966
3966
|
/**
|
|
3967
3967
|
* DeleteInformationBlockResponse
|
|
3968
3968
|
*
|
|
3969
|
-
* Response for
|
|
3969
|
+
* Response for `delete-information-block`.
|
|
3970
3970
|
*
|
|
3971
3971
|
* The envelope is gone once the block is deleted, so the response is a
|
|
3972
3972
|
* thin confirmation instead — structure_id + block_type + name for
|
|
@@ -4113,7 +4113,7 @@ export type DeleteReportOperation = {
|
|
|
4113
4113
|
*
|
|
4114
4114
|
* Shared response shape for delete / soft-delete operations.
|
|
4115
4115
|
*
|
|
4116
|
-
*
|
|
4116
|
+
* `deleted=True` means the operation succeeded (a row was deleted or
|
|
4117
4117
|
* flipped). A row that never existed gets a 404 — this shape never carries
|
|
4118
4118
|
* "not found".
|
|
4119
4119
|
*
|
|
@@ -4210,12 +4210,12 @@ export type DeleteSubgraphOp = {
|
|
|
4210
4210
|
/**
|
|
4211
4211
|
* DeleteTaxonomyBlockRequest
|
|
4212
4212
|
*
|
|
4213
|
-
* Request body for the
|
|
4213
|
+
* Request body for the `delete-taxonomy-block` operation.
|
|
4214
4214
|
*
|
|
4215
|
-
*
|
|
4216
|
-
* reference elements in this taxonomy.
|
|
4215
|
+
* `cascade_facts=False` (default) fails the delete if any Fact rows
|
|
4216
|
+
* reference elements in this taxonomy. `cascade_facts=True` deletes the
|
|
4217
4217
|
* referencing facts alongside the taxonomy; the response reports
|
|
4218
|
-
*
|
|
4218
|
+
* `facts_deleted`.
|
|
4219
4219
|
*/
|
|
4220
4220
|
export type DeleteTaxonomyBlockRequest = {
|
|
4221
4221
|
/**
|
|
@@ -4241,7 +4241,7 @@ export type DeleteTaxonomyBlockRequest = {
|
|
|
4241
4241
|
/**
|
|
4242
4242
|
* DeleteTaxonomyBlockResponse
|
|
4243
4243
|
*
|
|
4244
|
-
* Response for
|
|
4244
|
+
* Response for `delete-taxonomy-block`.
|
|
4245
4245
|
*/
|
|
4246
4246
|
export type DeleteTaxonomyBlockResponse = {
|
|
4247
4247
|
/**
|
|
@@ -4369,8 +4369,8 @@ export type DisclosuresRequest = {
|
|
|
4369
4369
|
* The disclosures view op's result: xbrlkit's map, stamped with the graph
|
|
4370
4370
|
* and report it was read from.
|
|
4371
4371
|
*
|
|
4372
|
-
* Without
|
|
4373
|
-
*
|
|
4372
|
+
* Without `topic`: `disclosures` / `count`. With `topic`:
|
|
4373
|
+
* `disclosure` / `category` / `blocks` / `block_count`.
|
|
4374
4374
|
*/
|
|
4375
4375
|
export type DisclosuresResponse = {
|
|
4376
4376
|
/**
|
|
@@ -4567,7 +4567,7 @@ export type DocumentListResponse = {
|
|
|
4567
4567
|
* DocumentSection
|
|
4568
4568
|
*
|
|
4569
4569
|
* Full document section retrieved by ID — one part of it when the section
|
|
4570
|
-
* is long;
|
|
4570
|
+
* is long; `next_document_id` continues it.
|
|
4571
4571
|
*/
|
|
4572
4572
|
export type DocumentSection = {
|
|
4573
4573
|
/**
|
|
@@ -5080,15 +5080,15 @@ export type ErrorResponse = {
|
|
|
5080
5080
|
/**
|
|
5081
5081
|
* EvaluateRulesRequest
|
|
5082
5082
|
*
|
|
5083
|
-
* Request body for the
|
|
5083
|
+
* Request body for the `evaluate-rules` operation.
|
|
5084
5084
|
*
|
|
5085
|
-
* Runs every rule scoped to
|
|
5086
|
-
* scoped rules for the structure's atoms), binds
|
|
5085
|
+
* Runs every rule scoped to `structure_id` (plus element/association-
|
|
5086
|
+
* scoped rules for the structure's atoms), binds `$Variable` references
|
|
5087
5087
|
* to facts via qname lookup, and writes one
|
|
5088
5088
|
* :class:`VerificationResult` row per rule.
|
|
5089
5089
|
*
|
|
5090
|
-
* Optional
|
|
5091
|
-
* window; without them the engine uses the most recent
|
|
5090
|
+
* Optional `period_start` / `period_end` narrow the fact-binding
|
|
5091
|
+
* window; without them the engine uses the most recent `in_scope` fact
|
|
5092
5092
|
* for each element regardless of period.
|
|
5093
5093
|
*/
|
|
5094
5094
|
export type EvaluateRulesRequest = {
|
|
@@ -5121,10 +5121,10 @@ export type EvaluateRulesRequest = {
|
|
|
5121
5121
|
/**
|
|
5122
5122
|
* EvaluateRulesResponse
|
|
5123
5123
|
*
|
|
5124
|
-
* Response for the
|
|
5124
|
+
* Response for the `evaluate-rules` operation.
|
|
5125
5125
|
*
|
|
5126
|
-
*
|
|
5127
|
-
* written by this evaluation run.
|
|
5126
|
+
* `results` is the full list of :class:`VerificationResultLite` rows
|
|
5127
|
+
* written by this evaluation run. `summary` gives counts keyed by
|
|
5128
5128
|
* status for quick display without iterating the list.
|
|
5129
5129
|
*/
|
|
5130
5130
|
export type EvaluateRulesResponse = {
|
|
@@ -5139,7 +5139,7 @@ export type EvaluateRulesResponse = {
|
|
|
5139
5139
|
/**
|
|
5140
5140
|
* Summary
|
|
5141
5141
|
*
|
|
5142
|
-
* Status counts keyed by outcome string:
|
|
5142
|
+
* Status counts keyed by outcome string: `{'pass': N, 'fail': N, 'error': N, 'skipped': N}`.
|
|
5143
5143
|
*/
|
|
5144
5144
|
summary?: {
|
|
5145
5145
|
[key: string]: number;
|
|
@@ -5480,7 +5480,7 @@ export type ExecuteEventBlockResponse = {
|
|
|
5480
5480
|
* run: the connection is registration + telemetry, not execution config.
|
|
5481
5481
|
* The platform holds no credentials for the external source — the
|
|
5482
5482
|
* integration authenticates to its own source and writes here through
|
|
5483
|
-
* the public API, stamping
|
|
5483
|
+
* the public API, stamping `source_name` on everything it emits.
|
|
5484
5484
|
*/
|
|
5485
5485
|
export type ExternalConnectionConfig = {
|
|
5486
5486
|
/**
|
|
@@ -5636,8 +5636,8 @@ export type FactRecord = {
|
|
|
5636
5636
|
*
|
|
5637
5637
|
* FactSet projection — period-specific instantiation of the Structure.
|
|
5638
5638
|
*
|
|
5639
|
-
* The envelope carries one
|
|
5640
|
-
* for the requested period, and leaves
|
|
5639
|
+
* The envelope carries one `FactSetLite` per block when a FactSet row exists
|
|
5640
|
+
* for the requested period, and leaves `fact_set` null when none does.
|
|
5641
5641
|
*/
|
|
5642
5642
|
export type FactSetLite = {
|
|
5643
5643
|
/**
|
|
@@ -5659,7 +5659,7 @@ export type FactSetLite = {
|
|
|
5659
5659
|
/**
|
|
5660
5660
|
* Factset Type
|
|
5661
5661
|
*
|
|
5662
|
-
* 'report' | 'schedule' | 'custom' | 'disclosure' | 'metric'. Enum closure enforced by the
|
|
5662
|
+
* 'report' | 'schedule' | 'custom' | 'disclosure' | 'metric'. Enum closure enforced by the `public.fact_sets` CHECK constraint.
|
|
5663
5663
|
*/
|
|
5664
5664
|
factset_type: string;
|
|
5665
5665
|
/**
|
|
@@ -5669,7 +5669,7 @@ export type FactSetLite = {
|
|
|
5669
5669
|
/**
|
|
5670
5670
|
* Report Id
|
|
5671
5671
|
*
|
|
5672
|
-
* Back-pointer to the parent row in
|
|
5672
|
+
* Back-pointer to the parent row in `reports`. Null when the FactSet does not belong to a report package.
|
|
5673
5673
|
*/
|
|
5674
5674
|
report_id?: string | null;
|
|
5675
5675
|
/**
|
|
@@ -5681,7 +5681,7 @@ export type FactSetLite = {
|
|
|
5681
5681
|
/**
|
|
5682
5682
|
* Provenance
|
|
5683
5683
|
*
|
|
5684
|
-
* Typed
|
|
5684
|
+
* 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.
|
|
5685
5685
|
*/
|
|
5686
5686
|
provenance?: {
|
|
5687
5687
|
[key: string]: unknown;
|
|
@@ -5787,13 +5787,13 @@ export type FileLayerStatus = {
|
|
|
5787
5787
|
/**
|
|
5788
5788
|
* FileReportRequest
|
|
5789
5789
|
*
|
|
5790
|
-
* Transition a Report to
|
|
5790
|
+
* Transition a Report to `filed` — locks the package.
|
|
5791
5791
|
*
|
|
5792
|
-
* Acceptable from
|
|
5793
|
-
*
|
|
5792
|
+
* Acceptable from `draft` or `under_review`. `filed_by` and
|
|
5793
|
+
* `filed_at` are stamped from the auth context + server clock; the
|
|
5794
5794
|
* request itself carries no fields today (kept as a model for OpenAPI
|
|
5795
5795
|
* shape consistency and to avoid breaking changes if we add fields).
|
|
5796
|
-
* Use
|
|
5796
|
+
* Use `transition-filing-status` for the non-file legs of the
|
|
5797
5797
|
* lifecycle (`draft ↔ under_review`, `filed → archived`).
|
|
5798
5798
|
*/
|
|
5799
5799
|
export type FileReportRequest = {
|
|
@@ -6035,8 +6035,8 @@ export type FiscalCalendarResponse = {
|
|
|
6035
6035
|
*
|
|
6036
6036
|
* One fiscal period row — header view used in calendar listings.
|
|
6037
6037
|
*
|
|
6038
|
-
* Status lifecycle:
|
|
6039
|
-
* is the transient state during a close run;
|
|
6038
|
+
* Status lifecycle: `open` → `closing` → `closed`. `closing`
|
|
6039
|
+
* is the transient state during a close run; `closed_at` stamps when
|
|
6040
6040
|
* the lock landed.
|
|
6041
6041
|
*/
|
|
6042
6042
|
export type FiscalPeriodSummary = {
|
|
@@ -6075,17 +6075,17 @@ export type FiscalPeriodSummary = {
|
|
|
6075
6075
|
/**
|
|
6076
6076
|
* ForecastMechanics
|
|
6077
6077
|
*
|
|
6078
|
-
* Authored scenario container for
|
|
6078
|
+
* Authored scenario container for `block_type='forecast'`.
|
|
6079
6079
|
*
|
|
6080
|
-
* The block IS the scenario: its structure id is the
|
|
6080
|
+
* The block IS the scenario: its structure id is the `scenario_id`
|
|
6081
6081
|
* every derived forward FactSet carries (NULL = actuals). The authored
|
|
6082
6082
|
* surface is exactly this — scenario identity, horizon, base period,
|
|
6083
6083
|
* lever assertions; everything downstream is derived by
|
|
6084
|
-
*
|
|
6084
|
+
* `compute-forecast` (levers → driven rs-gaap anchors via the
|
|
6085
6085
|
* rs-driver Derive rules → carry-forward for unmodeled IS lines →
|
|
6086
6086
|
* calc-DAG subtotals), landing in the EXISTING statement/metric block
|
|
6087
6087
|
* types stamped with the scenario. Reads directly from the typed
|
|
6088
|
-
*
|
|
6088
|
+
* `structures.artifact_mechanics` JSONB column.
|
|
6089
6089
|
*/
|
|
6090
6090
|
export type ForecastMechanics = {
|
|
6091
6091
|
/**
|
|
@@ -6107,13 +6107,13 @@ export type ForecastMechanics = {
|
|
|
6107
6107
|
/**
|
|
6108
6108
|
* Base Period
|
|
6109
6109
|
*
|
|
6110
|
-
* Origin month (
|
|
6110
|
+
* 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.
|
|
6111
6111
|
*/
|
|
6112
6112
|
base_period: string;
|
|
6113
6113
|
/**
|
|
6114
6114
|
* Base Anchor
|
|
6115
6115
|
*
|
|
6116
|
-
* Where the walk takes its opening balances.
|
|
6116
|
+
* 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.
|
|
6117
6117
|
*/
|
|
6118
6118
|
base_anchor?: 'seam' | 'fixed';
|
|
6119
6119
|
/**
|
|
@@ -6145,13 +6145,13 @@ export type ForecastMechanics = {
|
|
|
6145
6145
|
/**
|
|
6146
6146
|
* ForecastMonthLite
|
|
6147
6147
|
*
|
|
6148
|
-
* One computed forward month in a
|
|
6148
|
+
* One computed forward month in a `compute-forecast` response.
|
|
6149
6149
|
*/
|
|
6150
6150
|
export type ForecastMonthLite = {
|
|
6151
6151
|
/**
|
|
6152
6152
|
* Period
|
|
6153
6153
|
*
|
|
6154
|
-
* Month key (
|
|
6154
|
+
* Month key (`YYYY-MM`).
|
|
6155
6155
|
*/
|
|
6156
6156
|
period: string;
|
|
6157
6157
|
/**
|
|
@@ -6189,7 +6189,7 @@ export type ForecastMonthLite = {
|
|
|
6189
6189
|
/**
|
|
6190
6190
|
* Verification Passed
|
|
6191
6191
|
*
|
|
6192
|
-
* Whether every rule evaluated against the month's scenario sets passed. Three states, and the third is not the first:
|
|
6192
|
+
* 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.
|
|
6193
6193
|
*/
|
|
6194
6194
|
verification_passed?: boolean | null;
|
|
6195
6195
|
/**
|
|
@@ -7224,7 +7224,7 @@ export type HealthStatus = {
|
|
|
7224
7224
|
*
|
|
7225
7225
|
* Body for index-document (corpus content-op).
|
|
7226
7226
|
*
|
|
7227
|
-
* Create a new document when
|
|
7227
|
+
* Create a new document when `document_id` is absent; update the named
|
|
7228
7228
|
* document (partial — only supplied fields) when present.
|
|
7229
7229
|
*/
|
|
7230
7230
|
export type IndexDocumentOp = {
|
|
@@ -7356,11 +7356,11 @@ export type InformationBlockEnvelope = {
|
|
|
7356
7356
|
*/
|
|
7357
7357
|
verification_results?: Array<VerificationResultLite>;
|
|
7358
7358
|
/**
|
|
7359
|
-
* Server-computed aggregate over
|
|
7359
|
+
* 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.
|
|
7360
7360
|
*/
|
|
7361
7361
|
verification_summary?: VerificationSummary | null;
|
|
7362
7362
|
/**
|
|
7363
|
-
* Server-computed view projections (Charlie's six type-of View arms).
|
|
7363
|
+
* 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`.
|
|
7364
7364
|
*/
|
|
7365
7365
|
view?: ViewProjections;
|
|
7366
7366
|
};
|
|
@@ -7539,7 +7539,7 @@ export type InformationModelResponse = {
|
|
|
7539
7539
|
* Body for ingest-file (raw→staging content flow).
|
|
7540
7540
|
*
|
|
7541
7541
|
* Marks an uploaded file ready and triggers DuckDB staging. Set
|
|
7542
|
-
*
|
|
7542
|
+
* `ingest_to_graph` to auto-chain graph materialization after staging.
|
|
7543
7543
|
*/
|
|
7544
7544
|
export type IngestFileOp = {
|
|
7545
7545
|
/**
|
|
@@ -7644,10 +7644,10 @@ export type InitialEntityData = {
|
|
|
7644
7644
|
*
|
|
7645
7645
|
* Create the graph's chart of accounts from a shipped template.
|
|
7646
7646
|
*
|
|
7647
|
-
* Refused (409) when the graph already has an active
|
|
7647
|
+
* Refused (409) when the graph already has an active `chart_of_accounts`
|
|
7648
7648
|
* taxonomy — a QuickBooks-synced tenant never needs this, and a chart is
|
|
7649
7649
|
* never replaced. The template's equity rows are mapped by the entity's
|
|
7650
|
-
* legal form (
|
|
7650
|
+
* legal form (`entity_type`: corporation / llc / partnership); omit it
|
|
7651
7651
|
* to use the graph's primary entity, falling back to corporation.
|
|
7652
7652
|
*/
|
|
7653
7653
|
export type InitializeChartOfAccountsRequest = {
|
|
@@ -7723,16 +7723,16 @@ export type InitializeChartOfAccountsResponse = {
|
|
|
7723
7723
|
* One-time setup for a graph's fiscal calendar.
|
|
7724
7724
|
*
|
|
7725
7725
|
* Creates the `FiscalCalendar` row, seeds `FiscalPeriod` rows from
|
|
7726
|
-
*
|
|
7727
|
-
* and stamps periods on or before
|
|
7726
|
+
* `earliest_data_period` (or 24 months ago) through the current month,
|
|
7727
|
+
* and stamps periods on or before `closed_through` as already closed.
|
|
7728
7728
|
* Subsequent calls return 409 — there's no re-initialize.
|
|
7729
7729
|
*
|
|
7730
7730
|
* The two pointers it sets up:
|
|
7731
7731
|
*
|
|
7732
|
-
* -
|
|
7732
|
+
* - `closed_through` (system-maintained): the latest period whose
|
|
7733
7733
|
* books are locked. Set on init for businesses with prior close
|
|
7734
7734
|
* history; null for a fresh start.
|
|
7735
|
-
* -
|
|
7735
|
+
* - `close_target` (user-controlled): the goal date the user is
|
|
7736
7736
|
* closing toward. Set independently via `set-close-target`.
|
|
7737
7737
|
*/
|
|
7738
7738
|
export type InitializeLedgerRequest = {
|
|
@@ -8046,7 +8046,7 @@ export type JournalEntryLineItemInput = {
|
|
|
8046
8046
|
/**
|
|
8047
8047
|
* Metadata
|
|
8048
8048
|
*
|
|
8049
|
-
* Optional per-line metadata stamped on
|
|
8049
|
+
* 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.
|
|
8050
8050
|
*/
|
|
8051
8051
|
metadata?: {
|
|
8052
8052
|
[key: string]: unknown;
|
|
@@ -8418,14 +8418,14 @@ export type LedgerEntityResponse = {
|
|
|
8418
8418
|
/**
|
|
8419
8419
|
* LeverAssertionLite
|
|
8420
8420
|
*
|
|
8421
|
-
* One lever's persisted assertion inside
|
|
8421
|
+
* One lever's persisted assertion inside `ForecastMechanics`.
|
|
8422
8422
|
*
|
|
8423
|
-
* The create handler expands the wire-level assertion (uniform
|
|
8424
|
-
* + per-month overrides) into the explicit
|
|
8423
|
+
* The create handler expands the wire-level assertion (uniform `value`
|
|
8424
|
+
* + per-month overrides) into the explicit `values_by_period` map so
|
|
8425
8425
|
* compute never interpolates — every asserted month is stated. The
|
|
8426
8426
|
* values are duplicated as authored facts in the scenario's lever
|
|
8427
8427
|
* FactSet (rules for mechanics, **facts for values** — the facts are
|
|
8428
|
-
* what
|
|
8428
|
+
* what `compute-forecast` binds); this mechanics copy is the
|
|
8429
8429
|
* operator-legible round-trip shape.
|
|
8430
8430
|
*/
|
|
8431
8431
|
export type LeverAssertionLite = {
|
|
@@ -8450,7 +8450,7 @@ export type LeverAssertionLite = {
|
|
|
8450
8450
|
/**
|
|
8451
8451
|
* Values By Period
|
|
8452
8452
|
*
|
|
8453
|
-
* Expanded per-month assertions keyed by
|
|
8453
|
+
* Expanded per-month assertions keyed by `YYYY-MM`.
|
|
8454
8454
|
*/
|
|
8455
8455
|
values_by_period: {
|
|
8456
8456
|
[key: string]: number;
|
|
@@ -8462,20 +8462,20 @@ export type LeverAssertionLite = {
|
|
|
8462
8462
|
*
|
|
8463
8463
|
* One lever's asserted values for the scenario.
|
|
8464
8464
|
*
|
|
8465
|
-
*
|
|
8465
|
+
* `qname` must resolve to an `rs-driver:*` catalog element (the
|
|
8466
8466
|
* create handler rejects anything else). Each lever's value semantics
|
|
8467
8467
|
* are defined by its catalog element's documentation — surfaced as
|
|
8468
|
-
*
|
|
8469
|
-
* envelope (
|
|
8468
|
+
* `documentation` on the elements bundled in the forecast block's
|
|
8469
|
+
* envelope (`get-information-block`). Percent levers are decimals but
|
|
8470
8470
|
* their *meaning* varies by lever: growth levers are month-over-month
|
|
8471
|
-
* rates (
|
|
8471
|
+
* rates (`RevenueGrowthRate` 0.03 = +3%/month, compounding), while
|
|
8472
8472
|
* rate-on-base levers are fractions of the same month's base
|
|
8473
|
-
* (
|
|
8474
|
-
* revenues — not a growth rate). Days levers (
|
|
8475
|
-
*
|
|
8473
|
+
* (`CostOfRevenueRate` 0.62 = cost of revenue at 62% of that month's
|
|
8474
|
+
* revenues — not a growth rate). Days levers (`DaysSalesOutstanding`,
|
|
8475
|
+
* `DaysPayableOutstanding`) are day counts.
|
|
8476
8476
|
*
|
|
8477
|
-
*
|
|
8478
|
-
*
|
|
8477
|
+
* `value` is a uniform fill across the whole horizon;
|
|
8478
|
+
* `values_by_period` overrides individual months (`"YYYY-MM"`
|
|
8479
8479
|
* keys) — e.g. a margin-compression ramp asserts a different rate each
|
|
8480
8480
|
* month. At least one of the two must be provided. Months covered by
|
|
8481
8481
|
* neither carry no assertion — the lever's rule is inactive for that
|
|
@@ -8485,7 +8485,7 @@ export type LeverAssertionRequest = {
|
|
|
8485
8485
|
/**
|
|
8486
8486
|
* Qname
|
|
8487
8487
|
*
|
|
8488
|
-
* QName of the rs-driver lever element (e.g.
|
|
8488
|
+
* QName of the rs-driver lever element (e.g. `rs-driver:RevenueGrowthRate`).
|
|
8489
8489
|
*/
|
|
8490
8490
|
qname: string;
|
|
8491
8491
|
/**
|
|
@@ -8497,7 +8497,7 @@ export type LeverAssertionRequest = {
|
|
|
8497
8497
|
/**
|
|
8498
8498
|
* Values By Period
|
|
8499
8499
|
*
|
|
8500
|
-
* Per-month overrides keyed by
|
|
8500
|
+
* Per-month overrides keyed by `YYYY-MM`. Wins over `value` for the months it names.
|
|
8501
8501
|
*/
|
|
8502
8502
|
values_by_period?: {
|
|
8503
8503
|
[key: string]: number;
|
|
@@ -8508,20 +8508,20 @@ export type LeverAssertionRequest = {
|
|
|
8508
8508
|
* LineAssertionLite
|
|
8509
8509
|
*
|
|
8510
8510
|
* One statement line's persisted direct assertion inside
|
|
8511
|
-
*
|
|
8511
|
+
* `ForecastMechanics`.
|
|
8512
8512
|
*
|
|
8513
8513
|
* The manual-override sibling of :class:`LeverAssertionLite`: a lever
|
|
8514
8514
|
* asserts a *driver* whose rule derives a line; a line assertion pins
|
|
8515
8515
|
* the **line itself** (a calc-DAG leaf) to typed values for the months
|
|
8516
8516
|
* it names — winning over driver rules and carry-forward for exactly
|
|
8517
8517
|
* those months (a displaced rule surfaces in the compute response's
|
|
8518
|
-
*
|
|
8518
|
+
* `skipped` list). Subtotals stay calc-DAG-derived, so a manual line
|
|
8519
8519
|
* still articulates through RollUps, RE, balancing cash, and derived
|
|
8520
8520
|
* CF, and stays verification-gated.
|
|
8521
8521
|
*
|
|
8522
8522
|
* Same persistence doctrine as levers: values are duplicated as
|
|
8523
8523
|
* authored facts in the scenario's lever FactSet (facts are what
|
|
8524
|
-
*
|
|
8524
|
+
* `compute-forecast` binds); this mechanics copy is the
|
|
8525
8525
|
* operator-legible round-trip shape.
|
|
8526
8526
|
*/
|
|
8527
8527
|
export type LineAssertionLite = {
|
|
@@ -8552,7 +8552,7 @@ export type LineAssertionLite = {
|
|
|
8552
8552
|
/**
|
|
8553
8553
|
* Values By Period
|
|
8554
8554
|
*
|
|
8555
|
-
* Expanded per-month assertions keyed by
|
|
8555
|
+
* Expanded per-month assertions keyed by `YYYY-MM`.
|
|
8556
8556
|
*/
|
|
8557
8557
|
values_by_period: {
|
|
8558
8558
|
[key: string]: number;
|
|
@@ -8569,7 +8569,7 @@ export type LineAssertionLite = {
|
|
|
8569
8569
|
* line assertion asserts the **line itself** — an rs-gaap (or tenant
|
|
8570
8570
|
* extension) statement leaf pinned to typed values for the months it
|
|
8571
8571
|
* names. Assertions win over driver rules and carry-forward for those
|
|
8572
|
-
* months (a displaced rule lands in
|
|
8572
|
+
* months (a displaced rule lands in `skipped`, legibly); months the
|
|
8573
8573
|
* assertion doesn't name keep the engine's normal derivation.
|
|
8574
8574
|
*
|
|
8575
8575
|
* **Leaves only** — subtotals stay calc-DAG-derived, so a manually set
|
|
@@ -8577,8 +8577,8 @@ export type LineAssertionLite = {
|
|
|
8577
8577
|
* derived CF, and stays verification-gated (the whole pitch vs a
|
|
8578
8578
|
* spreadsheet cell). The create handler rejects calc-parent qnames.
|
|
8579
8579
|
*
|
|
8580
|
-
* Value/period grammar is identical to levers:
|
|
8581
|
-
* fill across the horizon,
|
|
8580
|
+
* Value/period grammar is identical to levers: `value` is a uniform
|
|
8581
|
+
* fill across the horizon, `values_by_period` overrides individual
|
|
8582
8582
|
* months. The canonical uses: zero out a base-month one-off so
|
|
8583
8583
|
* carry-forward stops replicating it, or hold a line at a known budget
|
|
8584
8584
|
* number no driver models.
|
|
@@ -8587,7 +8587,7 @@ export type LineAssertionRequest = {
|
|
|
8587
8587
|
/**
|
|
8588
8588
|
* Qname
|
|
8589
8589
|
*
|
|
8590
|
-
* QName of the statement leaf to assert (e.g.
|
|
8590
|
+
* QName of the statement leaf to assert (e.g. `rs-gaap:NonoperatingIncomeExpense`). Must be a calc-DAG leaf; rs-driver concepts belong in `levers`.
|
|
8591
8591
|
*/
|
|
8592
8592
|
qname: string;
|
|
8593
8593
|
/**
|
|
@@ -8599,7 +8599,7 @@ export type LineAssertionRequest = {
|
|
|
8599
8599
|
/**
|
|
8600
8600
|
* Values By Period
|
|
8601
8601
|
*
|
|
8602
|
-
* Per-month overrides keyed by
|
|
8602
|
+
* Per-month overrides keyed by `YYYY-MM`. Wins over `value` for the months it names.
|
|
8603
8603
|
*/
|
|
8604
8604
|
values_by_period?: {
|
|
8605
8605
|
[key: string]: number;
|
|
@@ -8610,19 +8610,19 @@ export type LineAssertionRequest = {
|
|
|
8610
8610
|
* LineGrowthLite
|
|
8611
8611
|
*
|
|
8612
8612
|
* One statement line's persisted growth trajectory inside
|
|
8613
|
-
*
|
|
8613
|
+
* `ForecastMechanics`.
|
|
8614
8614
|
*
|
|
8615
8615
|
* The generic per-line form of the revenue growth lever: grows an
|
|
8616
8616
|
* income-statement leaf month-over-month at the asserted rate
|
|
8617
|
-
* (
|
|
8617
|
+
* (`line[t] = line[t-1] * (1 + rate[t])`), compounding from the base
|
|
8618
8618
|
* month's value. Months without a rate keep the engine's carry-forward.
|
|
8619
|
-
* Duration leaves only; disjoint from
|
|
8619
|
+
* Duration leaves only; disjoint from `line_assertions` and from any
|
|
8620
8620
|
* active catalog rule's target (one owner per line).
|
|
8621
8621
|
*
|
|
8622
8622
|
* Persistence deviates from levers/assertions deliberately: rates are
|
|
8623
8623
|
* NOT duplicated as facts in the scenario FactSet — a growth rate on a
|
|
8624
8624
|
* monetary statement element would be a unit-lying fact. This mechanics
|
|
8625
|
-
* copy is the single authored store;
|
|
8625
|
+
* copy is the single authored store; `compute-forecast` binds rates
|
|
8626
8626
|
* from here.
|
|
8627
8627
|
*/
|
|
8628
8628
|
export type LineGrowthLite = {
|
|
@@ -8647,7 +8647,7 @@ export type LineGrowthLite = {
|
|
|
8647
8647
|
/**
|
|
8648
8648
|
* Values By Period
|
|
8649
8649
|
*
|
|
8650
|
-
* Expanded per-month growth rates keyed by
|
|
8650
|
+
* Expanded per-month growth rates keyed by `YYYY-MM`.
|
|
8651
8651
|
*/
|
|
8652
8652
|
values_by_period: {
|
|
8653
8653
|
[key: string]: number;
|
|
@@ -8659,27 +8659,27 @@ export type LineGrowthLite = {
|
|
|
8659
8659
|
*
|
|
8660
8660
|
* One statement line's asserted growth trajectory for the scenario.
|
|
8661
8661
|
*
|
|
8662
|
-
* The generic per-line sibling of
|
|
8662
|
+
* The generic per-line sibling of `rs-driver:RevenueGrowthRate`: where
|
|
8663
8663
|
* the catalog lever grows *revenue* through its seeded rule, a line
|
|
8664
8664
|
* growth entry grows **any income-statement leaf** at a month-over-month
|
|
8665
|
-
* rate —
|
|
8665
|
+
* rate — `value` -0.05 cuts the line 5% per month, compounding from
|
|
8666
8666
|
* the base month's value. This is what expense trajectories ("opex +2%/mo
|
|
8667
8667
|
* with inflation", "cut costs 5%/mo starting October") use; without it
|
|
8668
8668
|
* every unmodeled line just carries flat.
|
|
8669
8669
|
*
|
|
8670
|
-
* Semantics per month:
|
|
8670
|
+
* Semantics per month: `line[t] = line[t-1] * (1 + rate[t])`. Months
|
|
8671
8671
|
* the entry doesn't name keep the engine's carry-forward (grow-then-hold
|
|
8672
|
-
* ramps fall out of
|
|
8672
|
+
* ramps fall out of `values_by_period` naturally). **Duration leaves
|
|
8673
8673
|
* only**: balance-sheet lines roll from the IS and the working-capital
|
|
8674
8674
|
* levers — grow the driving IS line instead. A line already driven by an
|
|
8675
|
-
* active catalog rule (e.g. Revenues with
|
|
8676
|
-
* named by a
|
|
8675
|
+
* active catalog rule (e.g. Revenues with `RevenueGrowthRate` set) or
|
|
8676
|
+
* named by a `line_assertions` entry is rejected — one owner per line.
|
|
8677
8677
|
*/
|
|
8678
8678
|
export type LineGrowthRequest = {
|
|
8679
8679
|
/**
|
|
8680
8680
|
* Qname
|
|
8681
8681
|
*
|
|
8682
|
-
* QName of the income-statement leaf to grow (e.g.
|
|
8682
|
+
* QName of the income-statement leaf to grow (e.g. `rs-gaap:ResearchAndDevelopmentExpense`). Must be a calc-DAG duration leaf.
|
|
8683
8683
|
*/
|
|
8684
8684
|
qname: string;
|
|
8685
8685
|
/**
|
|
@@ -8691,7 +8691,7 @@ export type LineGrowthRequest = {
|
|
|
8691
8691
|
/**
|
|
8692
8692
|
* Values By Period
|
|
8693
8693
|
*
|
|
8694
|
-
* Per-month rate overrides keyed by
|
|
8694
|
+
* 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).
|
|
8695
8695
|
*/
|
|
8696
8696
|
values_by_period?: {
|
|
8697
8697
|
[key: string]: number;
|
|
@@ -8703,16 +8703,16 @@ export type LineGrowthRequest = {
|
|
|
8703
8703
|
*
|
|
8704
8704
|
* Filter ledger LineItems by flow concept.
|
|
8705
8705
|
*
|
|
8706
|
-
* The single predicate kind shipped to date.
|
|
8707
|
-
* qnames — mini's
|
|
8706
|
+
* The single predicate kind shipped to date. `values` are flow-concept
|
|
8707
|
+
* qnames — mini's `TransactionDescriptionCode` values, rs-gaap flow
|
|
8708
8708
|
* concepts (what the enrichment classifier emits for QuickBooks data),
|
|
8709
|
-
* future XBRL GL
|
|
8710
|
-
* to element_ids and matches the first-class
|
|
8709
|
+
* future XBRL GL `GenericFlowCategory` codes. The engine resolves them
|
|
8710
|
+
* to element_ids and matches the first-class `LineItem.flow_element_id`
|
|
8711
8711
|
* FK; matched lines aggregate signed into the attributed fact for the
|
|
8712
8712
|
* period.
|
|
8713
8713
|
*
|
|
8714
|
-
*
|
|
8715
|
-
*
|
|
8714
|
+
* `field` is accepted but ignored: the flow tag lives in the typed
|
|
8715
|
+
* `flow_element_id` FK, not in JSONB metadata. It stays on the wire so
|
|
8716
8716
|
* existing request bodies keep validating.
|
|
8717
8717
|
*/
|
|
8718
8718
|
export type LineItemMetadataPredicate = {
|
|
@@ -8725,13 +8725,13 @@ export type LineItemMetadataPredicate = {
|
|
|
8725
8725
|
/**
|
|
8726
8726
|
* Field
|
|
8727
8727
|
*
|
|
8728
|
-
* Accepted but ignored. The flow tag lives in the typed
|
|
8728
|
+
* Accepted but ignored. The flow tag lives in the typed `flow_element_id` FK, not JSONB metadata. Retained for wire-compatibility.
|
|
8729
8729
|
*/
|
|
8730
8730
|
field?: string;
|
|
8731
8731
|
/**
|
|
8732
8732
|
* Values
|
|
8733
8733
|
*
|
|
8734
|
-
* Flow-concept qnames that route to this filter's target concept. A LineItem matches when its
|
|
8734
|
+
* 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.
|
|
8735
8735
|
*/
|
|
8736
8736
|
values: Array<string>;
|
|
8737
8737
|
};
|
|
@@ -8742,7 +8742,7 @@ export type LineItemMetadataPredicate = {
|
|
|
8742
8742
|
* Link an entity to a taxonomy (creates the ENTITY_HAS_TAXONOMY edge).
|
|
8743
8743
|
*
|
|
8744
8744
|
* This is how a graph declares "this entity reports under this taxonomy."
|
|
8745
|
-
* For
|
|
8745
|
+
* For `chart_of_accounts` taxonomies, this tells the platform which CoA
|
|
8746
8746
|
* the entity uses. For reporting taxonomies, which standard (us-gaap,
|
|
8747
8747
|
* ifrs). Idempotent — re-linking returns the existing edge unchanged.
|
|
8748
8748
|
*
|
|
@@ -8884,7 +8884,7 @@ export type LiveFinancialStatementRequest = {
|
|
|
8884
8884
|
/**
|
|
8885
8885
|
* Statement Type
|
|
8886
8886
|
*
|
|
8887
|
-
* income_statement | balance_sheet | cash_flow_statement | equity_statement.
|
|
8887
|
+
* 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.
|
|
8888
8888
|
*/
|
|
8889
8889
|
statement_type: string;
|
|
8890
8890
|
/**
|
|
@@ -8936,7 +8936,7 @@ export type LiveFinancialStatementResponse = {
|
|
|
8936
8936
|
/**
|
|
8937
8937
|
* Periods
|
|
8938
8938
|
*
|
|
8939
|
-
* Rendered columns, aligned with each row's
|
|
8939
|
+
* 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.
|
|
8940
8940
|
*/
|
|
8941
8941
|
periods: Array<PeriodSpec>;
|
|
8942
8942
|
/**
|
|
@@ -9160,10 +9160,10 @@ export type MemoryRecord = {
|
|
|
9160
9160
|
*
|
|
9161
9161
|
* A bank feed is native accounting: the graph must already have a chart of
|
|
9162
9162
|
* accounts and no live QuickBooks connection. Over OAuth (the hosted
|
|
9163
|
-
* default) the connection is created
|
|
9164
|
-
* callback.
|
|
9163
|
+
* default) the connection is created `pending_oauth` and activated by the
|
|
9164
|
+
* callback. `api_key` — a personal **read-only** Mercury token — connects
|
|
9165
9165
|
* at once without a browser round-trip, but only on deployments that turn
|
|
9166
|
-
* on
|
|
9166
|
+
* on `MERCURY_API_KEY_CONNECTIONS_ENABLED` (self-hosted and local); the
|
|
9167
9167
|
* hosted product refuses it.
|
|
9168
9168
|
*/
|
|
9169
9169
|
export type MercuryConnectionConfig = {
|
|
@@ -9190,7 +9190,7 @@ export type MercuryConnectionConfig = {
|
|
|
9190
9190
|
/**
|
|
9191
9191
|
* MetricMechanics
|
|
9192
9192
|
*
|
|
9193
|
-
* Derivative mechanics for
|
|
9193
|
+
* Derivative mechanics for `block_type='metric'`.
|
|
9194
9194
|
*
|
|
9195
9195
|
* A metric block composes its facts from one or more source blocks at
|
|
9196
9196
|
* read time — covenant tests, ratios, KPI trend computations. The typed
|
|
@@ -9199,10 +9199,10 @@ export type MercuryConnectionConfig = {
|
|
|
9199
9199
|
* derivation evaluator that actually computes facts from source-block
|
|
9200
9200
|
* FactSets is not yet implemented.
|
|
9201
9201
|
*
|
|
9202
|
-
*
|
|
9203
|
-
* derives from;
|
|
9204
|
-
* (
|
|
9205
|
-
*
|
|
9202
|
+
* `source_block_ids` is the ordered list of Structure ids this metric
|
|
9203
|
+
* derives from; `derivation_type` names the kind of computation
|
|
9204
|
+
* (`ratio`, `trailing_twelve_month`, `covenant_test`, …), and
|
|
9205
|
+
* `expression` carries the agent-authored derivation string that the
|
|
9206
9206
|
* evaluator will consume at envelope build time.
|
|
9207
9207
|
*/
|
|
9208
9208
|
export type MetricMechanics = {
|
|
@@ -9239,7 +9239,7 @@ export type MetricMechanics = {
|
|
|
9239
9239
|
/**
|
|
9240
9240
|
* MetricObservation
|
|
9241
9241
|
*
|
|
9242
|
-
* One externally-observed value in an
|
|
9242
|
+
* One externally-observed value in an `assert-metrics` request.
|
|
9243
9243
|
*/
|
|
9244
9244
|
export type MetricObservation = {
|
|
9245
9245
|
/**
|
|
@@ -9655,20 +9655,20 @@ export type OperationCosts = {
|
|
|
9655
9655
|
*
|
|
9656
9656
|
* Uniform response shape for every operation endpoint.
|
|
9657
9657
|
*
|
|
9658
|
-
* Every dispatch carries an
|
|
9658
|
+
* Every dispatch carries an `op_<ULID>` operation_id, which is the bridge
|
|
9659
9659
|
* to the monitoring surface: pass it to
|
|
9660
|
-
*
|
|
9660
|
+
* `GET /v1/operations/{operation_id}/stream` (see `routers/operations.py`)
|
|
9661
9661
|
* to subscribe to SSE progress events. Sync commands complete in the envelope
|
|
9662
|
-
* itself (
|
|
9663
|
-
* (
|
|
9662
|
+
* itself (`status: "completed"`, HTTP 200); async commands
|
|
9663
|
+
* (`status: "pending"`, HTTP 202) hand off to a background worker and stream
|
|
9664
9664
|
* their tail through that SSE endpoint. Failed dispatches still mint an
|
|
9665
|
-
*
|
|
9665
|
+
* `operation_id` so the audit log and any partial SSE events stay
|
|
9666
9666
|
* correlatable.
|
|
9667
9667
|
*
|
|
9668
|
-
*
|
|
9669
|
-
* OpenAPI. Operations that pin
|
|
9670
|
-
*
|
|
9671
|
-
* the default
|
|
9668
|
+
* `TResult` parameterizes `result` so per-op response shapes surface in
|
|
9669
|
+
* OpenAPI. Operations that pin `OperationSpec.result_type` get
|
|
9670
|
+
* `OperationEnvelope[YourEnvelope]` as their response model; the rest keep
|
|
9671
|
+
* the default `Any` shape (`result: any | null` on the wire).
|
|
9672
9672
|
*/
|
|
9673
9673
|
export type OperationEnvelope = {
|
|
9674
9674
|
/**
|
|
@@ -12534,10 +12534,10 @@ export type PasskeyLoginVerifyRequest = {
|
|
|
12534
12534
|
*
|
|
12535
12535
|
* Begin enrollment.
|
|
12536
12536
|
*
|
|
12537
|
-
* Two disjoint lanes:
|
|
12537
|
+
* Two disjoint lanes: `mfa_token` (forced enrollment — the token was minted
|
|
12538
12538
|
* seconds after a password verify, so it is its own freshness proof) or an
|
|
12539
12539
|
* authenticated settings-flow enrollment, which must carry a fresh re-auth
|
|
12540
|
-
* proof —
|
|
12540
|
+
* proof — `password`, or a `reauth`-ceremony `assertion` when adding a
|
|
12541
12541
|
* passkey beside an existing one.
|
|
12542
12542
|
*/
|
|
12543
12543
|
export type PasskeyRegisterOptionsRequest = {
|
|
@@ -12823,8 +12823,8 @@ export type PerformanceInsights = {
|
|
|
12823
12823
|
* A single reporting period column.
|
|
12824
12824
|
*
|
|
12825
12825
|
* Reports render facts in N period columns side-by-side. Each
|
|
12826
|
-
*
|
|
12827
|
-
* window the report's facts roll up into;
|
|
12826
|
+
* `PeriodSpec` is one column — its `start`/`end` define the
|
|
12827
|
+
* window the report's facts roll up into; `label` is what the renderer
|
|
12828
12828
|
* prints in the column header. For year-over-year statements, supply two
|
|
12829
12829
|
* PeriodSpecs (current + comparative); for YTD by quarter, supply four.
|
|
12830
12830
|
*/
|
|
@@ -12856,9 +12856,9 @@ export type PeriodSpec = {
|
|
|
12856
12856
|
*
|
|
12857
12857
|
* A bank feed is native accounting: the graph must already have a chart of
|
|
12858
12858
|
* accounts and no live QuickBooks connection. The connection is created
|
|
12859
|
-
*
|
|
12860
|
-
* Link, and the
|
|
12861
|
-
*
|
|
12859
|
+
* `pending_oauth`; `POST /oauth/init` returns a `link_token` for Plaid
|
|
12860
|
+
* Link, and the `public_token` Link hands back completes it through
|
|
12861
|
+
* `POST /oauth/callback/plaid` (as `code`). One connection per institution
|
|
12862
12862
|
* login; a graph can hold several.
|
|
12863
12863
|
*/
|
|
12864
12864
|
export type PlaidConnectionConfig = {
|
|
@@ -13378,15 +13378,15 @@ export type PreviewReconcilingItemRequest = {
|
|
|
13378
13378
|
*
|
|
13379
13379
|
* On-demand trigger for the obligation-promotion sweep.
|
|
13380
13380
|
*
|
|
13381
|
-
* Mirrors what the
|
|
13381
|
+
* Mirrors what the `scheduled_obligation_promoter` Dagster sensor does
|
|
13382
13382
|
* on its tick, but lets an interactive caller or an MCP close co-pilot
|
|
13383
13383
|
* run it now instead of waiting for the background cadence — required to
|
|
13384
13384
|
* drive a schedule-driven close to completion in a single session.
|
|
13385
|
-
* Flips matured
|
|
13386
|
-
* passed) to
|
|
13385
|
+
* Flips matured `pending` `schedule_entry_due` events (period boundary
|
|
13386
|
+
* passed) to `classified`; with `dispatch_handlers` it also drafts the
|
|
13387
13387
|
* closing entries in the same transaction (idempotent — reconciles to an
|
|
13388
13388
|
* existing draft). The sweep also reaches *stranded* obligations —
|
|
13389
|
-
* already
|
|
13389
|
+
* already `classified` (by an earlier flip-only sweep) but with no
|
|
13390
13390
|
* closing entry ever drafted — dispatching them in the same pass.
|
|
13391
13391
|
*/
|
|
13392
13392
|
export type PromoteObligationsRequest = {
|
|
@@ -13680,7 +13680,7 @@ export type ReconcilingItemCatchUp = {
|
|
|
13680
13680
|
* One account's net change between the posted entries and the new payload.
|
|
13681
13681
|
*
|
|
13682
13682
|
* Amounts are signed minor units in debit-positive convention: a positive
|
|
13683
|
-
* figure is a net debit, a negative one a net credit.
|
|
13683
|
+
* figure is a net debit, a negative one a net credit. `delta` is what a
|
|
13684
13684
|
* catch-up entry would post to bring the books level.
|
|
13685
13685
|
*/
|
|
13686
13686
|
export type ReconcilingItemDeltaLine = {
|
|
@@ -14055,8 +14055,8 @@ export type RemovePublishListMemberOperation = {
|
|
|
14055
14055
|
*
|
|
14056
14056
|
* Computed server-side at envelope-build time for blocks where rendering
|
|
14057
14057
|
* is deterministic (the statement family today; future block types add
|
|
14058
|
-
* their own rendering builders). The frontend's
|
|
14059
|
-
*
|
|
14058
|
+
* their own rendering builders). The frontend's `BlockView`
|
|
14059
|
+
* `Rendering` projection consumes this directly — no client-side
|
|
14060
14060
|
* rollup, depth computation, or calculation walk needed.
|
|
14061
14061
|
*/
|
|
14062
14062
|
export type RenderingLite = {
|
|
@@ -14108,7 +14108,7 @@ export type RenderingPeriodLite = {
|
|
|
14108
14108
|
*
|
|
14109
14109
|
* Mirrors :class:`FactRow` in
|
|
14110
14110
|
* :mod:`robosystems.operations.roboledger.reports.fact_grid`, restated at the
|
|
14111
|
-
* API boundary so envelope consumers don't depend on that module.
|
|
14111
|
+
* API boundary so envelope consumers don't depend on that module. `values`
|
|
14112
14112
|
* holds one entry per period column in :class:`RenderingLite.periods`.
|
|
14113
14113
|
*/
|
|
14114
14114
|
export type RenderingRowLite = {
|
|
@@ -14191,10 +14191,10 @@ export type ReopenPeriodOperation = {
|
|
|
14191
14191
|
*
|
|
14192
14192
|
* Report definition summary — header metadata, no facts.
|
|
14193
14193
|
*
|
|
14194
|
-
* Returned by
|
|
14195
|
-
*
|
|
14194
|
+
* Returned by `create-report`, `regenerate-report`,
|
|
14195
|
+
* `file-report`, and `transition-filing-status`. Use the package
|
|
14196
14196
|
* read endpoint to retrieve a Report rehydrated with its rendered
|
|
14197
|
-
*
|
|
14197
|
+
* `InformationBlockEnvelope` items.
|
|
14198
14198
|
*/
|
|
14199
14199
|
export type ReportResponse = {
|
|
14200
14200
|
/**
|
|
@@ -14650,7 +14650,7 @@ export type RevokeReportShareResponse = {
|
|
|
14650
14650
|
/**
|
|
14651
14651
|
* RollforwardMechanics
|
|
14652
14652
|
*
|
|
14653
|
-
* Filter-based attribution mechanics for
|
|
14653
|
+
* Filter-based attribution mechanics for `block_type='rollforward'`.
|
|
14654
14654
|
*
|
|
14655
14655
|
* Filter-based attribution: each block decomposes one BS source
|
|
14656
14656
|
* element's period delta into a list of flow concepts via declared
|
|
@@ -14659,10 +14659,10 @@ export type RevokeReportShareResponse = {
|
|
|
14659
14659
|
* attributed fact per filter per period, and arbitrates any residual
|
|
14660
14660
|
* against the default change tag fallback.
|
|
14661
14661
|
*
|
|
14662
|
-
* Reads directly from the typed
|
|
14663
|
-
* column.
|
|
14662
|
+
* Reads directly from the typed `structures.artifact_mechanics` JSONB
|
|
14663
|
+
* column. `attribution_filters` rides as nested JSON; the predicate
|
|
14664
14664
|
* union widens as new predicate shapes are added — currently only
|
|
14665
|
-
*
|
|
14665
|
+
* `line_item_metadata_field` is carried.
|
|
14666
14666
|
*/
|
|
14667
14667
|
export type RollforwardMechanics = {
|
|
14668
14668
|
/**
|
|
@@ -14672,25 +14672,25 @@ export type RollforwardMechanics = {
|
|
|
14672
14672
|
/**
|
|
14673
14673
|
* Bs Source Element Id
|
|
14674
14674
|
*
|
|
14675
|
-
* Element id of the balance-sheet source whose period delta this block decomposes. Resolved from
|
|
14675
|
+
* Element id of the balance-sheet source whose period delta this block decomposes. Resolved from `bs_source_qname` at create time.
|
|
14676
14676
|
*/
|
|
14677
14677
|
bs_source_element_id: string;
|
|
14678
14678
|
/**
|
|
14679
14679
|
* Bs Source Qname
|
|
14680
14680
|
*
|
|
14681
|
-
* QName of the BS source element (e.g.
|
|
14681
|
+
* QName of the BS source element (e.g. `mini:CashAndCashEquivalents`). Round-tripped for caller convenience; `bs_source_element_id` is authoritative.
|
|
14682
14682
|
*/
|
|
14683
14683
|
bs_source_qname: string;
|
|
14684
14684
|
/**
|
|
14685
14685
|
* Default Change Tag Element Id
|
|
14686
14686
|
*
|
|
14687
|
-
* 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
|
|
14687
|
+
* 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`.
|
|
14688
14688
|
*/
|
|
14689
14689
|
default_change_tag_element_id?: string | null;
|
|
14690
14690
|
/**
|
|
14691
14691
|
* Default Change Tag Qname
|
|
14692
14692
|
*
|
|
14693
|
-
* QName of the default change tag (e.g.
|
|
14693
|
+
* 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.
|
|
14694
14694
|
*/
|
|
14695
14695
|
default_change_tag_qname?: string | null;
|
|
14696
14696
|
/**
|
|
@@ -14702,7 +14702,7 @@ export type RollforwardMechanics = {
|
|
|
14702
14702
|
/**
|
|
14703
14703
|
* Validation Mode
|
|
14704
14704
|
*
|
|
14705
|
-
* Renderer arbitration policy when Σ filter matches != Δ BS.
|
|
14705
|
+
* 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.
|
|
14706
14706
|
*/
|
|
14707
14707
|
validation_mode?: 'strict' | 'residual_as_default' | 'warn_only';
|
|
14708
14708
|
};
|
|
@@ -14712,8 +14712,8 @@ export type RollforwardMechanics = {
|
|
|
14712
14712
|
*
|
|
14713
14713
|
* Rule projection for the Information Block envelope.
|
|
14714
14714
|
*
|
|
14715
|
-
* One row per
|
|
14716
|
-
* engine consumes
|
|
14715
|
+
* One row per `public.rules` entry scoped to this block. The rule
|
|
14716
|
+
* engine consumes `rule_expression` + `rule_variables` to evaluate
|
|
14717
14717
|
* against the in-scope fact set; the envelope surfaces the rules so
|
|
14718
14718
|
* the UI can render them as a checklist alongside any persisted
|
|
14719
14719
|
* verification results.
|
|
@@ -14757,13 +14757,13 @@ export type RuleLite = {
|
|
|
14757
14757
|
/**
|
|
14758
14758
|
* Rule Severity
|
|
14759
14759
|
*
|
|
14760
|
-
* Failure severity — 'info' | 'warning' | 'error'. Enum closure enforced by the
|
|
14760
|
+
* Failure severity — 'info' | 'warning' | 'error'. Enum closure enforced by the `public.rules` CHECK constraint.
|
|
14761
14761
|
*/
|
|
14762
14762
|
rule_severity?: string;
|
|
14763
14763
|
/**
|
|
14764
14764
|
* Rule Origin
|
|
14765
14765
|
*
|
|
14766
|
-
* 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
|
|
14766
|
+
* 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.
|
|
14767
14767
|
*/
|
|
14768
14768
|
rule_origin?: string;
|
|
14769
14769
|
};
|
|
@@ -14777,13 +14777,13 @@ export type RuleTargetLite = {
|
|
|
14777
14777
|
/**
|
|
14778
14778
|
* Target Kind
|
|
14779
14779
|
*
|
|
14780
|
-
* Which atom type the rule targets — 'structure' | 'element' | 'association' | 'taxonomy'. Enum closure enforced by the
|
|
14780
|
+
* Which atom type the rule targets — 'structure' | 'element' | 'association' | 'taxonomy'. Enum closure enforced by the `public.rules` CHECK constraint.
|
|
14781
14781
|
*/
|
|
14782
14782
|
target_kind: string;
|
|
14783
14783
|
/**
|
|
14784
14784
|
* Target Ref Id
|
|
14785
14785
|
*
|
|
14786
|
-
* UUID of the target atom — structure_id, element_id, association_id, or taxonomy_id depending on
|
|
14786
|
+
* UUID of the target atom — structure_id, element_id, association_id, or taxonomy_id depending on `target_kind`.
|
|
14787
14787
|
*/
|
|
14788
14788
|
target_ref_id: string;
|
|
14789
14789
|
};
|
|
@@ -14949,11 +14949,11 @@ export type ScheduleCreatedResponse = {
|
|
|
14949
14949
|
/**
|
|
14950
14950
|
* ScheduleMechanics
|
|
14951
14951
|
*
|
|
14952
|
-
* Closing-entry generator mechanics for
|
|
14952
|
+
* Closing-entry generator mechanics for `block_type='schedule'`.
|
|
14953
14953
|
*
|
|
14954
|
-
* Reads the typed
|
|
14955
|
-
* to
|
|
14956
|
-
*
|
|
14954
|
+
* Reads the typed `structures.artifact_mechanics` JSONB column, falling back
|
|
14955
|
+
* to `structures.metadata_` for Schedule rows that lack it.
|
|
14956
|
+
* `entry_template` and `schedule_metadata` reuse the wire-level request
|
|
14957
14957
|
* shapes so OpenAPI emits one canonical type per concept.
|
|
14958
14958
|
*/
|
|
14959
14959
|
export type ScheduleMechanics = {
|
|
@@ -15168,10 +15168,10 @@ export type SchemaValidationResponse = {
|
|
|
15168
15168
|
* A single search result with snippet.
|
|
15169
15169
|
*
|
|
15170
15170
|
* A long SEC section (an MD&A, a commitments note) is indexed in parts, each
|
|
15171
|
-
* a document of its own:
|
|
15172
|
-
* shared by the section's parts,
|
|
15171
|
+
* a document of its own: `part` of `part_count`, `parent_document_id`
|
|
15172
|
+
* shared by the section's parts, `next_document_id` to read on.
|
|
15173
15173
|
*
|
|
15174
|
-
* On a grouped search,
|
|
15174
|
+
* On a grouped search, `also_in_filings` counts the other filings of the
|
|
15175
15175
|
* same filer whose same section (and part) matched and were folded into
|
|
15176
15176
|
* this hit.
|
|
15177
15177
|
*/
|
|
@@ -15734,7 +15734,7 @@ export type ShareResultItem = {
|
|
|
15734
15734
|
/**
|
|
15735
15735
|
* SkippedForecastLite
|
|
15736
15736
|
*
|
|
15737
|
-
* One rule/month soft-skip in a
|
|
15737
|
+
* One rule/month soft-skip in a `compute-forecast` response.
|
|
15738
15738
|
*
|
|
15739
15739
|
* A skipped rule never aborts the walk — its target falls back to the
|
|
15740
15740
|
* carry-forward value for that month (when a prior value exists).
|
|
@@ -15751,7 +15751,7 @@ export type SkippedForecastLite = {
|
|
|
15751
15751
|
/**
|
|
15752
15752
|
* Period
|
|
15753
15753
|
*
|
|
15754
|
-
* Month key (
|
|
15754
|
+
* Month key (`YYYY-MM`) of the skip.
|
|
15755
15755
|
*/
|
|
15756
15756
|
period: string;
|
|
15757
15757
|
/**
|
|
@@ -15767,7 +15767,7 @@ export type SkippedForecastLite = {
|
|
|
15767
15767
|
/**
|
|
15768
15768
|
* SkippedMetricLite
|
|
15769
15769
|
*
|
|
15770
|
-
* One metric a
|
|
15770
|
+
* One metric a `compute-metrics` run could not compute.
|
|
15771
15771
|
*
|
|
15772
15772
|
* Soft-fail by design: a missing operand fact (e.g. InterestExpense for a
|
|
15773
15773
|
* debt-free entity) or an undefined ratio (division by zero) skips the
|
|
@@ -15855,10 +15855,10 @@ export type SqlStatementResponse = {
|
|
|
15855
15855
|
*
|
|
15856
15856
|
* Renderer mechanics for the statement family of block types.
|
|
15857
15857
|
*
|
|
15858
|
-
* Covers
|
|
15859
|
-
* and
|
|
15858
|
+
* Covers `balance_sheet`, `income_statement`, `cash_flow_statement`,
|
|
15859
|
+
* and `equity_statement`. All fields are optional so library-seeded
|
|
15860
15860
|
* rows that haven't been enriched yet still validate against an empty
|
|
15861
|
-
* tagged body. The existing
|
|
15861
|
+
* tagged body. The existing `statement(...)` GraphQL field continues
|
|
15862
15862
|
* to serve rendered output; this mechanics model is the source of truth
|
|
15863
15863
|
* for future renderer configuration.
|
|
15864
15864
|
*/
|
|
@@ -16012,9 +16012,9 @@ export type StructureSummary = {
|
|
|
16012
16012
|
*
|
|
16013
16013
|
* Partial-update patch for a single structure, keyed by structure_id.
|
|
16014
16014
|
*
|
|
16015
|
-
*
|
|
16016
|
-
* place (e.g. promoting a
|
|
16017
|
-
* footing rule);
|
|
16015
|
+
* `concept_arrangement` makes a mis-CAP'd structure repairable in
|
|
16016
|
+
* place (e.g. promoting a `set` note to `roll_up` so it gains a
|
|
16017
|
+
* footing rule); `block_type` stays immutable — it drives block-type
|
|
16018
16018
|
* routing, so changing it is a re-create, not an edit.
|
|
16019
16019
|
*/
|
|
16020
16020
|
export type StructureUpdatePatch = {
|
|
@@ -16054,7 +16054,7 @@ export type StructureUpdatePatch = {
|
|
|
16054
16054
|
* Subgraph count against the parent graph tier's cap.
|
|
16055
16055
|
*
|
|
16056
16056
|
* Subgraphs are refused at the tier cap regardless of how small they are,
|
|
16057
|
-
* so this is a count axis independent of the storage one —
|
|
16057
|
+
* so this is a count axis independent of the storage one — `instance`
|
|
16058
16058
|
* already itemizes their footprint.
|
|
16059
16059
|
*/
|
|
16060
16060
|
export type SubgraphLimits = {
|
|
@@ -16432,7 +16432,7 @@ export type TaxonomyBlockAssociationRequest = {
|
|
|
16432
16432
|
/**
|
|
16433
16433
|
* Association Type
|
|
16434
16434
|
*
|
|
16435
|
-
* DB
|
|
16435
|
+
* DB `associations.association_type` enum. `presentation` = parent-child hierarchy; `calculation` = summation arc.
|
|
16436
16436
|
*/
|
|
16437
16437
|
association_type: 'presentation' | 'calculation' | 'mapping' | 'equivalence' | 'general-special' | 'essence-alias';
|
|
16438
16438
|
/**
|
|
@@ -16506,7 +16506,7 @@ export type TaxonomyBlockElement = {
|
|
|
16506
16506
|
/**
|
|
16507
16507
|
* Origin
|
|
16508
16508
|
*
|
|
16509
|
-
* Provenance — 'library' if the element's taxonomy is locked (
|
|
16509
|
+
* Provenance — 'library' if the element's taxonomy is locked (`is_locked=true`), else 'tenant'.
|
|
16510
16510
|
*/
|
|
16511
16511
|
origin: 'library' | 'tenant';
|
|
16512
16512
|
};
|
|
@@ -16516,17 +16516,17 @@ export type TaxonomyBlockElement = {
|
|
|
16516
16516
|
*
|
|
16517
16517
|
* Element definition inside a Taxonomy Block envelope.
|
|
16518
16518
|
*
|
|
16519
|
-
*
|
|
16520
|
-
* envelope's
|
|
16521
|
-
* payloads as the reference token.
|
|
16522
|
-
* envelope-local qname or, for
|
|
16519
|
+
* `qname` is the envelope-local identifier — must be unique within the
|
|
16520
|
+
* envelope's `elements` list and is used by association / rule / patch
|
|
16521
|
+
* payloads as the reference token. `parent_ref` may reference another
|
|
16522
|
+
* envelope-local qname or, for `reporting_extension` blocks, a library
|
|
16523
16523
|
* element qname.
|
|
16524
16524
|
*/
|
|
16525
16525
|
export type TaxonomyBlockElementRequest = {
|
|
16526
16526
|
/**
|
|
16527
16527
|
* Qname
|
|
16528
16528
|
*
|
|
16529
|
-
* Envelope-local element identifier. Must be unique within the envelope's
|
|
16529
|
+
* Envelope-local element identifier. Must be unique within the envelope's `elements` list. Used as the reference token for associations, rules, and update patches.
|
|
16530
16530
|
*/
|
|
16531
16531
|
qname: string;
|
|
16532
16532
|
/**
|
|
@@ -16538,7 +16538,7 @@ export type TaxonomyBlockElementRequest = {
|
|
|
16538
16538
|
/**
|
|
16539
16539
|
* Trait
|
|
16540
16540
|
*
|
|
16541
|
-
* FASB metamodel trait for the element. Required for
|
|
16541
|
+
* FASB metamodel trait for the element. Required for `chart_of_accounts` blocks; optional for `custom_ontology`.
|
|
16542
16542
|
*/
|
|
16543
16543
|
trait?: string | null;
|
|
16544
16544
|
/**
|
|
@@ -16572,7 +16572,7 @@ export type TaxonomyBlockElementRequest = {
|
|
|
16572
16572
|
/**
|
|
16573
16573
|
* Code
|
|
16574
16574
|
*
|
|
16575
|
-
* Optional chart-of-accounts code (e.g. '1000', '4100-02'). Only meaningful for
|
|
16575
|
+
* Optional chart-of-accounts code (e.g. '1000', '4100-02'). Only meaningful for `chart_of_accounts` blocks.
|
|
16576
16576
|
*/
|
|
16577
16577
|
code?: string | null;
|
|
16578
16578
|
/**
|
|
@@ -16582,7 +16582,7 @@ export type TaxonomyBlockElementRequest = {
|
|
|
16582
16582
|
/**
|
|
16583
16583
|
* Parent Ref
|
|
16584
16584
|
*
|
|
16585
|
-
* qname of the parent element — either another envelope-local qname or, for
|
|
16585
|
+
* qname of the parent element — either another envelope-local qname or, for `reporting_extension` blocks, a library element qname.
|
|
16586
16586
|
*/
|
|
16587
16587
|
parent_ref?: string | null;
|
|
16588
16588
|
/**
|
|
@@ -16600,7 +16600,7 @@ export type TaxonomyBlockElementRequest = {
|
|
|
16600
16600
|
*
|
|
16601
16601
|
* One envelope per taxonomy instance. Carries identity + type,
|
|
16602
16602
|
* registry-sourced display metadata, the parent taxonomy pointer (for
|
|
16603
|
-
*
|
|
16603
|
+
* `reporting_extension` blocks), and bundled atoms (elements,
|
|
16604
16604
|
* structures, associations, rules, verification results).
|
|
16605
16605
|
*/
|
|
16606
16606
|
export type TaxonomyBlockEnvelope = {
|
|
@@ -16697,9 +16697,9 @@ export type TaxonomyBlockEnvelope = {
|
|
|
16697
16697
|
*
|
|
16698
16698
|
* Rule projection for the Taxonomy Block envelope.
|
|
16699
16699
|
*
|
|
16700
|
-
* Exactly one of
|
|
16700
|
+
* Exactly one of `rule_pattern` (arithmetic) or `rule_check_kind`
|
|
16701
16701
|
* (model-structure) is non-null per row, enforced by the
|
|
16702
|
-
*
|
|
16702
|
+
* `check_rule_pattern_kind_xor` DB constraint.
|
|
16703
16703
|
*/
|
|
16704
16704
|
export type TaxonomyBlockRule = {
|
|
16705
16705
|
/**
|
|
@@ -16743,7 +16743,7 @@ export type TaxonomyBlockRule = {
|
|
|
16743
16743
|
/**
|
|
16744
16744
|
* Target Ref
|
|
16745
16745
|
*
|
|
16746
|
-
* Polymorphic display string — structure_id, element qname, association_id, or taxonomy_id depending on
|
|
16746
|
+
* Polymorphic display string — structure_id, element qname, association_id, or taxonomy_id depending on `target_kind`.
|
|
16747
16747
|
*/
|
|
16748
16748
|
target_ref?: string | null;
|
|
16749
16749
|
};
|
|
@@ -16753,17 +16753,17 @@ export type TaxonomyBlockRule = {
|
|
|
16753
16753
|
*
|
|
16754
16754
|
* Rule definition inside a Taxonomy Block envelope.
|
|
16755
16755
|
*
|
|
16756
|
-
* Exactly one of
|
|
16757
|
-
*
|
|
16758
|
-
* The
|
|
16756
|
+
* Exactly one of `target_structure_ref`, `target_element_qname`, or
|
|
16757
|
+
* `target_taxonomy_self` must be set (or all null for a global rule).
|
|
16758
|
+
* The `model_validator` enforces this contract at the Pydantic layer.
|
|
16759
16759
|
*
|
|
16760
16760
|
* Only **arithmetic** rule patterns are user-creatable via this API
|
|
16761
|
-
* (the
|
|
16762
|
-
* kinds (
|
|
16763
|
-
*
|
|
16764
|
-
*
|
|
16761
|
+
* (the `rule_pattern` Literal below). The 6 model-structure check
|
|
16762
|
+
* kinds (`NoCycles`, `NoOrphanArcs`, `ParentBeforeChild`,
|
|
16763
|
+
* `LeafHasClassification`, `LibraryOriginImmutability`,
|
|
16764
|
+
* `UniqueQNameInTaxonomy`) are system-managed — they're auto-emitted
|
|
16765
16765
|
* by :func:`emit_auto_rules` at taxonomy-block creation time and
|
|
16766
|
-
* populate
|
|
16766
|
+
* populate `rules.rule_check_kind` instead of `rule_pattern`.
|
|
16767
16767
|
*/
|
|
16768
16768
|
export type TaxonomyBlockRuleRequest = {
|
|
16769
16769
|
/**
|
|
@@ -16797,7 +16797,7 @@ export type TaxonomyBlockRuleRequest = {
|
|
|
16797
16797
|
/**
|
|
16798
16798
|
* Variables
|
|
16799
16799
|
*
|
|
16800
|
-
*
|
|
16800
|
+
* `$Variable` → qname bindings. Each entry is `{'variable_name': str, 'variable_qname': str}`.
|
|
16801
16801
|
*/
|
|
16802
16802
|
variables?: Array<{
|
|
16803
16803
|
[key: string]: unknown;
|
|
@@ -16821,7 +16821,7 @@ export type TaxonomyBlockRuleRequest = {
|
|
|
16821
16821
|
/**
|
|
16822
16822
|
* Target Taxonomy Self
|
|
16823
16823
|
*
|
|
16824
|
-
* True iff the rule targets the envelope's own taxonomy row (
|
|
16824
|
+
* True iff the rule targets the envelope's own taxonomy row (`target_kind='taxonomy'`). Mutually exclusive with the other target_* fields.
|
|
16825
16825
|
*/
|
|
16826
16826
|
target_taxonomy_self?: boolean;
|
|
16827
16827
|
/**
|
|
@@ -16879,13 +16879,13 @@ export type TaxonomyBlockStructureRequest = {
|
|
|
16879
16879
|
/**
|
|
16880
16880
|
* Block Type
|
|
16881
16881
|
*
|
|
16882
|
-
* DB
|
|
16882
|
+
* 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`.
|
|
16883
16883
|
*/
|
|
16884
16884
|
block_type: 'chart_of_accounts' | 'custom' | 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'coa_mapping' | 'schedule' | 'rollforward' | 'reconciliation' | 'policy' | 'metric' | 'regulatory_disclosure';
|
|
16885
16885
|
/**
|
|
16886
16886
|
* Concept Arrangement
|
|
16887
16887
|
*
|
|
16888
|
-
* Concept Arrangement Pattern (CAP) — how the structure's concepts relate (mirrors the
|
|
16888
|
+
* 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.
|
|
16889
16889
|
*/
|
|
16890
16890
|
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;
|
|
16891
16891
|
/**
|
|
@@ -17161,9 +17161,9 @@ export type TransactionTemplateLeg = {
|
|
|
17161
17161
|
*
|
|
17162
17162
|
* Generic filing-status transition — escape hatch for non-file moves.
|
|
17163
17163
|
*
|
|
17164
|
-
* Used for
|
|
17165
|
-
*
|
|
17166
|
-
* through :class:`FileReportRequest` so
|
|
17164
|
+
* Used for `draft → under_review` (submit for review) and
|
|
17165
|
+
* `filed → archived` (supersede / retire). Filing the package goes
|
|
17166
|
+
* through :class:`FileReportRequest` so `filed_at` / `filed_by`
|
|
17167
17167
|
* audit fields land cleanly.
|
|
17168
17168
|
*/
|
|
17169
17169
|
export type TransitionFilingStatusRequest = {
|
|
@@ -17262,8 +17262,8 @@ export type UpdateApiKeyRequest = {
|
|
|
17262
17262
|
/**
|
|
17263
17263
|
* UpdateAgentRequest
|
|
17264
17264
|
*
|
|
17265
|
-
* Patch an agent. All fields except
|
|
17266
|
-
* pass only what changes.
|
|
17265
|
+
* Patch an agent. All fields except `agent_id` are optional —
|
|
17266
|
+
* pass only what changes. `metadata_patch` is deep-merged into the
|
|
17267
17267
|
* existing metadata dict.
|
|
17268
17268
|
*/
|
|
17269
17269
|
export type UpdateAgentRequest = {
|
|
@@ -17505,12 +17505,12 @@ export type UpdateEventBlockRequest = {
|
|
|
17505
17505
|
* UpdateEventHandlerRequest
|
|
17506
17506
|
*
|
|
17507
17507
|
* Update an existing event handler. All fields except
|
|
17508
|
-
*
|
|
17508
|
+
* `event_handler_id` are optional — pass only what changes.
|
|
17509
17509
|
*
|
|
17510
|
-
*
|
|
17511
|
-
* partial template patches).
|
|
17512
|
-
* the existing metadata.
|
|
17513
|
-
*
|
|
17510
|
+
* `transaction_template` is **fully replaced** when supplied (no
|
|
17511
|
+
* partial template patches). `metadata_patch` does deep-merge into
|
|
17512
|
+
* the existing metadata. `approve=true` sets `approved_by` and
|
|
17513
|
+
* `approved_at`; `approve=false` clears them.
|
|
17514
17514
|
*/
|
|
17515
17515
|
export type UpdateEventHandlerRequest = {
|
|
17516
17516
|
/**
|
|
@@ -17589,11 +17589,11 @@ export type UpdateEventHandlerRequest = {
|
|
|
17589
17589
|
* Update a forecast block in place.
|
|
17590
17590
|
*
|
|
17591
17591
|
* Mutable: name, scenario_kind, horizon_months, base_period, levers,
|
|
17592
|
-
* line_assertions.
|
|
17592
|
+
* line_assertions. `levers` and `line_assertions` are each a
|
|
17593
17593
|
* **full replace** when provided (partial edits would make the asserted
|
|
17594
17594
|
* set ambiguous); replacing one leaves the other as stored. Updating
|
|
17595
17595
|
* does NOT recompute — previously computed scenario months go stale
|
|
17596
|
-
* until the next
|
|
17596
|
+
* until the next `compute-forecast` run (the compute-metrics drift
|
|
17597
17597
|
* semantics).
|
|
17598
17598
|
*/
|
|
17599
17599
|
export type UpdateForecastRequest = {
|
|
@@ -17622,7 +17622,7 @@ export type UpdateForecastRequest = {
|
|
|
17622
17622
|
/**
|
|
17623
17623
|
* Base Anchor
|
|
17624
17624
|
*
|
|
17625
|
-
* Switch the walk between seam-anchored (default) and pinned to
|
|
17625
|
+
* 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.
|
|
17626
17626
|
*/
|
|
17627
17627
|
base_anchor?: 'seam' | 'fixed' | null;
|
|
17628
17628
|
/**
|
|
@@ -17661,14 +17661,14 @@ export type UpdateGraphMemberRoleRequest = {
|
|
|
17661
17661
|
*
|
|
17662
17662
|
* Partial update — only supplied (non-null) fields change, so a caller
|
|
17663
17663
|
* editing just the display name need not resend the description and tags.
|
|
17664
|
-
* Because
|
|
17665
|
-
* value instead: pass
|
|
17666
|
-
* the tags.
|
|
17664
|
+
* Because `None` means "leave alone", clearing a field uses its empty
|
|
17665
|
+
* value instead: pass `""` to clear the description and `[]` to clear
|
|
17666
|
+
* the tags. `graph_name` cannot be cleared; it is the graph's label
|
|
17667
17667
|
* everywhere it is listed.
|
|
17668
17668
|
*
|
|
17669
17669
|
* This is the platform-level label for the graph, independent of the
|
|
17670
17670
|
* entity name shown on financial statements — change that through
|
|
17671
|
-
*
|
|
17671
|
+
* `POST /extensions/roboledger/{graph_id}/operations/update-entity`.
|
|
17672
17672
|
*/
|
|
17673
17673
|
export type UpdateGraphMetadataOp = {
|
|
17674
17674
|
/**
|
|
@@ -17768,7 +17768,7 @@ export type UpdateMemberRoleRequest = {
|
|
|
17768
17768
|
*
|
|
17769
17769
|
* Body for the update-memory operation (partial update of a stored memory).
|
|
17770
17770
|
*
|
|
17771
|
-
* Only supplied fields are changed; the memory is re-embedded when
|
|
17771
|
+
* Only supplied fields are changed; the memory is re-embedded when `text`
|
|
17772
17772
|
* changes.
|
|
17773
17773
|
*/
|
|
17774
17774
|
export type UpdateMemoryOp = {
|
|
@@ -17913,7 +17913,7 @@ export type UpdatePublishListOperation = {
|
|
|
17913
17913
|
* invalidate every period already rendered — so switching BS source means
|
|
17914
17914
|
* delete and re-create.
|
|
17915
17915
|
*
|
|
17916
|
-
* **Partial-update semantics**: an omitted (
|
|
17916
|
+
* **Partial-update semantics**: an omitted (`None`) field means "leave
|
|
17917
17917
|
* unchanged". There is no wire-level way to *clear* the default change tag or
|
|
17918
17918
|
* empty the attribution_filters list; delete and re-create the block instead.
|
|
17919
17919
|
* The asymmetry is deliberate — a clear-sentinel costs wire-shape complexity
|
|
@@ -17934,7 +17934,7 @@ export type UpdateRollforwardRequest = {
|
|
|
17934
17934
|
/**
|
|
17935
17935
|
* Default Change Tag Qname
|
|
17936
17936
|
*
|
|
17937
|
-
* New default change tag qname. Pass a value to *change* the default; omit (
|
|
17937
|
+
* 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.
|
|
17938
17938
|
*/
|
|
17939
17939
|
default_change_tag_qname?: string | null;
|
|
17940
17940
|
/**
|
|
@@ -18050,7 +18050,7 @@ export type UpdateSecurityOperation = {
|
|
|
18050
18050
|
/**
|
|
18051
18051
|
* UpdateTaxonomyBlockRequest
|
|
18052
18052
|
*
|
|
18053
|
-
* Request body for the
|
|
18053
|
+
* Request body for the `update-taxonomy-block` operation.
|
|
18054
18054
|
*
|
|
18055
18055
|
* Top-level fields (name / description / version) apply to the taxonomy
|
|
18056
18056
|
* row itself. The delta lists mutate atoms incrementally — the validator
|
|
@@ -18129,8 +18129,8 @@ export type UpdateTaxonomyBlockRequest = {
|
|
|
18129
18129
|
*
|
|
18130
18130
|
* Request model for updating user profile.
|
|
18131
18131
|
*
|
|
18132
|
-
* Changing
|
|
18133
|
-
*
|
|
18132
|
+
* Changing `email` re-authenticates: a fresh proof (password re-entry or a
|
|
18133
|
+
* `mgmt`-flow passkey assertion) must accompany the request, exactly as
|
|
18134
18134
|
* passkey enrollment and removal require. Name-only updates need no proof.
|
|
18135
18135
|
*/
|
|
18136
18136
|
export type UpdateUserRequest = {
|
|
@@ -18247,7 +18247,7 @@ export type UserResponse = {
|
|
|
18247
18247
|
*
|
|
18248
18248
|
* Every rule runs once per rendered period column; on a multi-column
|
|
18249
18249
|
* statement each failure and warning is prefixed with the column it was
|
|
18250
|
-
* found in (
|
|
18250
|
+
* found in (`[Prior] …`).
|
|
18251
18251
|
*/
|
|
18252
18252
|
export type ValidationCheckResponse = {
|
|
18253
18253
|
/**
|
|
@@ -18316,7 +18316,7 @@ export type ValidationError = {
|
|
|
18316
18316
|
* Outcome of guard-rail validation on a rendered statement.
|
|
18317
18317
|
*
|
|
18318
18318
|
* Distinct from :class:`VerificationResultLite` (which surfaces the
|
|
18319
|
-
* rule-engine outcomes from
|
|
18319
|
+
* rule-engine outcomes from `public.verification_results`). This lite
|
|
18320
18320
|
* type carries the synchronous guard-rail checks computed at
|
|
18321
18321
|
* envelope-build time — accounting equation, totals foot, etc.
|
|
18322
18322
|
*/
|
|
@@ -18346,11 +18346,11 @@ export type ValidationLite = {
|
|
|
18346
18346
|
/**
|
|
18347
18347
|
* VerificationCategorySummary
|
|
18348
18348
|
*
|
|
18349
|
-
* Pass/fail/skip counts for one
|
|
18349
|
+
* Pass/fail/skip counts for one `rule_category` within a block's
|
|
18350
18350
|
* verification results.
|
|
18351
18351
|
*
|
|
18352
18352
|
* Drives the per-category accordions in the Verification Results panel.
|
|
18353
|
-
*
|
|
18353
|
+
* `category` is the rule's `rule_category`
|
|
18354
18354
|
* (one of the cm:VerificationRule subclasses), resolved by joining each
|
|
18355
18355
|
* result to its Rule.
|
|
18356
18356
|
*/
|
|
@@ -18386,9 +18386,9 @@ export type VerificationCategorySummary = {
|
|
|
18386
18386
|
*
|
|
18387
18387
|
* Persisted outcome of one Rule evaluation.
|
|
18388
18388
|
*
|
|
18389
|
-
* One row per
|
|
18389
|
+
* One row per `public.verification_results` entry the rule engine
|
|
18390
18390
|
* writes. The envelope surfaces them so the block viewer's
|
|
18391
|
-
* "Verification Results" tab and MCP
|
|
18391
|
+
* "Verification Results" tab and MCP `list-verification-failures`
|
|
18392
18392
|
* tool can render + aggregate without a second round-trip.
|
|
18393
18393
|
*/
|
|
18394
18394
|
export type VerificationResultLite = {
|
|
@@ -18411,7 +18411,7 @@ export type VerificationResultLite = {
|
|
|
18411
18411
|
/**
|
|
18412
18412
|
* Status
|
|
18413
18413
|
*
|
|
18414
|
-
* 'pass' | 'fail' | 'error' | 'skipped'. Enum closure enforced by the
|
|
18414
|
+
* 'pass' | 'fail' | 'error' | 'skipped'. Enum closure enforced by the `public.verification_results` CHECK constraint.
|
|
18415
18415
|
*/
|
|
18416
18416
|
status: string;
|
|
18417
18417
|
/**
|
|
@@ -18435,13 +18435,13 @@ export type VerificationResultLite = {
|
|
|
18435
18435
|
/**
|
|
18436
18436
|
* VerificationSummary
|
|
18437
18437
|
*
|
|
18438
|
-
* Server-computed aggregate of a block's
|
|
18438
|
+
* Server-computed aggregate of a block's `verification_results`.
|
|
18439
18439
|
*
|
|
18440
|
-
* Overall counts plus a per
|
|
18440
|
+
* Overall counts plus a per-`rule_category` breakdown, so the viewer
|
|
18441
18441
|
* renders the grouped Verification Results panel
|
|
18442
18442
|
* without a client-side results→rules join. Status closure is
|
|
18443
|
-
*
|
|
18444
|
-
* CHECK);
|
|
18443
|
+
* `pass | fail | error | skipped` (the `public.verification_results`
|
|
18444
|
+
* CHECK); `total` is their sum.
|
|
18445
18445
|
*/
|
|
18446
18446
|
export type VerificationSummary = {
|
|
18447
18447
|
/**
|
|
@@ -18568,21 +18568,21 @@ export type ViewMetadata = {
|
|
|
18568
18568
|
/**
|
|
18569
18569
|
* ViewProjections
|
|
18570
18570
|
*
|
|
18571
|
-
* Charlie's six
|
|
18571
|
+
* Charlie's six `type-of View` arms, surfaced at the envelope boundary.
|
|
18572
18572
|
*
|
|
18573
18573
|
* Each projection is computed server-side at envelope-build time when
|
|
18574
|
-
* its source data is available. The frontend's
|
|
18574
|
+
* its source data is available. The frontend's `BlockView` dispatcher
|
|
18575
18575
|
* routes to the projection component matching the user's selected view
|
|
18576
18576
|
* mode; missing projections (those still in backlog) render as empty
|
|
18577
18577
|
* states without breaking the dispatcher.
|
|
18578
18578
|
*
|
|
18579
|
-
* Today:
|
|
18580
|
-
*
|
|
18579
|
+
* Today: `rendering` is computed for the statement family, and
|
|
18580
|
+
* `chart` (the 7th arm — panel/series config over the rendering's
|
|
18581
18581
|
* rows and periods) for metric blocks.
|
|
18582
|
-
* Other arms (
|
|
18583
|
-
*
|
|
18584
|
-
* support lands;
|
|
18585
|
-
*
|
|
18582
|
+
* Other arms (`fact_table`, `model_structure`, `verification_results`,
|
|
18583
|
+
* `report_elements`, `business_rules`) come online as their backend
|
|
18584
|
+
* support lands; `fact_table` is trivially derivable from
|
|
18585
|
+
* `InformationBlockEnvelope.facts` and may stay as a frontend-only
|
|
18586
18586
|
* projection.
|
|
18587
18587
|
*/
|
|
18588
18588
|
export type ViewProjections = {
|
|
@@ -18630,11 +18630,11 @@ export type ViewResponse = {
|
|
|
18630
18630
|
/**
|
|
18631
18631
|
* _CreateForecastArm
|
|
18632
18632
|
*
|
|
18633
|
-
* Create-information-block body for
|
|
18633
|
+
* Create-information-block body for `block_type="forecast"`.
|
|
18634
18634
|
*
|
|
18635
18635
|
* Carries a typed forecast payload — the authored scenario container:
|
|
18636
18636
|
* scenario identity, horizon, base period, lever assertions on
|
|
18637
|
-
*
|
|
18637
|
+
* `rs-driver:*` catalog elements. Run `compute-forecast` after
|
|
18638
18638
|
* creating to derive the forward months.
|
|
18639
18639
|
*/
|
|
18640
18640
|
export type CreateForecastArm = {
|
|
@@ -18686,7 +18686,7 @@ export type CreateLegacyArm = {
|
|
|
18686
18686
|
/**
|
|
18687
18687
|
* _CreateRollforwardArm
|
|
18688
18688
|
*
|
|
18689
|
-
* Create-information-block body for
|
|
18689
|
+
* Create-information-block body for `block_type="rollforward"`.
|
|
18690
18690
|
*
|
|
18691
18691
|
* Carries a typed rollforward payload. The block decomposes the period
|
|
18692
18692
|
* change in a BS source element across the declared attribution
|
|
@@ -18729,7 +18729,7 @@ export type CreateScheduleArm = {
|
|
|
18729
18729
|
/**
|
|
18730
18730
|
* _DeleteForecastArm
|
|
18731
18731
|
*
|
|
18732
|
-
* Delete-information-block body for
|
|
18732
|
+
* Delete-information-block body for `block_type="forecast"`.
|
|
18733
18733
|
*
|
|
18734
18734
|
* Removes the scenario's entire parallel universe — the lever FactSet
|
|
18735
18735
|
* and every computed scenario FactSet. Actuals are never touched.
|
|
@@ -18777,7 +18777,7 @@ export type DeleteLegacyArm = {
|
|
|
18777
18777
|
/**
|
|
18778
18778
|
* _DeleteRollforwardArm
|
|
18779
18779
|
*
|
|
18780
|
-
* Delete-information-block body for
|
|
18780
|
+
* Delete-information-block body for `block_type="rollforward"`.
|
|
18781
18781
|
*
|
|
18782
18782
|
* Cascades through any synthetic facts produced by this block's filter
|
|
18783
18783
|
* evaluations. The underlying ledger LineItems are not touched.
|
|
@@ -18818,10 +18818,10 @@ export type DeleteScheduleArm = {
|
|
|
18818
18818
|
/**
|
|
18819
18819
|
* _UpdateForecastArm
|
|
18820
18820
|
*
|
|
18821
|
-
* Update-information-block body for
|
|
18821
|
+
* Update-information-block body for `block_type="forecast"`.
|
|
18822
18822
|
*
|
|
18823
18823
|
* Mutable: name, scenario_kind, horizon_months, base_period, levers
|
|
18824
|
-
* (full replace). Updating does not recompute — run
|
|
18824
|
+
* (full replace). Updating does not recompute — run `compute-forecast`
|
|
18825
18825
|
* to refresh the scenario's derived months.
|
|
18826
18826
|
*/
|
|
18827
18827
|
export type UpdateForecastArm = {
|
|
@@ -18867,7 +18867,7 @@ export type UpdateLegacyArm = {
|
|
|
18867
18867
|
/**
|
|
18868
18868
|
* _UpdateRollforwardArm
|
|
18869
18869
|
*
|
|
18870
|
-
* Update-information-block body for
|
|
18870
|
+
* Update-information-block body for `block_type="rollforward"`.
|
|
18871
18871
|
*
|
|
18872
18872
|
* Carries a typed rollforward update payload. Mutable fields: name,
|
|
18873
18873
|
* default_change_tag_qname, attribution_filters, validation_mode.
|
|
@@ -26242,7 +26242,22 @@ export type HandleHttpGetExtensionsGraphIdGraphqlGetResponses = {
|
|
|
26242
26242
|
};
|
|
26243
26243
|
|
|
26244
26244
|
export type HandleHttpPostExtensionsGraphIdGraphqlPostData = {
|
|
26245
|
-
body
|
|
26245
|
+
body: {
|
|
26246
|
+
/**
|
|
26247
|
+
* The GraphQL document to execute.
|
|
26248
|
+
*/
|
|
26249
|
+
query: string;
|
|
26250
|
+
/**
|
|
26251
|
+
* Values for the document's variables.
|
|
26252
|
+
*/
|
|
26253
|
+
variables?: {
|
|
26254
|
+
[key: string]: unknown;
|
|
26255
|
+
};
|
|
26256
|
+
/**
|
|
26257
|
+
* Which operation to run, when the document declares more than one.
|
|
26258
|
+
*/
|
|
26259
|
+
operationName?: string;
|
|
26260
|
+
};
|
|
26246
26261
|
path: {
|
|
26247
26262
|
/**
|
|
26248
26263
|
* Graph Id
|
|
@@ -29609,8 +29624,8 @@ export type UnblockSourceGraphResponses = {
|
|
|
29609
29624
|
|
|
29610
29625
|
export type UnblockSourceGraphResponse = UnblockSourceGraphResponses[keyof UnblockSourceGraphResponses];
|
|
29611
29626
|
|
|
29612
|
-
export type
|
|
29613
|
-
body:
|
|
29627
|
+
export type BuildFactGridData = {
|
|
29628
|
+
body: CreateViewRequest;
|
|
29614
29629
|
headers?: {
|
|
29615
29630
|
/**
|
|
29616
29631
|
* Idempotency-Key
|
|
@@ -29624,10 +29639,10 @@ export type LiveFinancialStatementData = {
|
|
|
29624
29639
|
graph_id: string;
|
|
29625
29640
|
};
|
|
29626
29641
|
query?: never;
|
|
29627
|
-
url: '/extensions/roboledger/{graph_id}/operations/
|
|
29642
|
+
url: '/extensions/roboledger/{graph_id}/operations/build-fact-grid';
|
|
29628
29643
|
};
|
|
29629
29644
|
|
|
29630
|
-
export type
|
|
29645
|
+
export type BuildFactGridErrors = {
|
|
29631
29646
|
/**
|
|
29632
29647
|
* Invalid request
|
|
29633
29648
|
*/
|
|
@@ -29662,19 +29677,19 @@ export type LiveFinancialStatementErrors = {
|
|
|
29662
29677
|
500: ErrorResponse;
|
|
29663
29678
|
};
|
|
29664
29679
|
|
|
29665
|
-
export type
|
|
29680
|
+
export type BuildFactGridError = BuildFactGridErrors[keyof BuildFactGridErrors];
|
|
29666
29681
|
|
|
29667
|
-
export type
|
|
29682
|
+
export type BuildFactGridResponses = {
|
|
29668
29683
|
/**
|
|
29669
29684
|
* Successful Response
|
|
29670
29685
|
*/
|
|
29671
|
-
200:
|
|
29686
|
+
200: OperationEnvelopeViewResponse;
|
|
29672
29687
|
};
|
|
29673
29688
|
|
|
29674
|
-
export type
|
|
29689
|
+
export type BuildFactGridResponse = BuildFactGridResponses[keyof BuildFactGridResponses];
|
|
29675
29690
|
|
|
29676
|
-
export type
|
|
29677
|
-
body:
|
|
29691
|
+
export type FinancialStatementAnalysisData = {
|
|
29692
|
+
body: FinancialStatementAnalysisRequest;
|
|
29678
29693
|
headers?: {
|
|
29679
29694
|
/**
|
|
29680
29695
|
* Idempotency-Key
|
|
@@ -29688,10 +29703,10 @@ export type BuildFactGridData = {
|
|
|
29688
29703
|
graph_id: string;
|
|
29689
29704
|
};
|
|
29690
29705
|
query?: never;
|
|
29691
|
-
url: '/extensions/roboledger/{graph_id}/operations/
|
|
29706
|
+
url: '/extensions/roboledger/{graph_id}/operations/financial-statement-analysis';
|
|
29692
29707
|
};
|
|
29693
29708
|
|
|
29694
|
-
export type
|
|
29709
|
+
export type FinancialStatementAnalysisErrors = {
|
|
29695
29710
|
/**
|
|
29696
29711
|
* Invalid request
|
|
29697
29712
|
*/
|
|
@@ -29726,19 +29741,19 @@ export type BuildFactGridErrors = {
|
|
|
29726
29741
|
500: ErrorResponse;
|
|
29727
29742
|
};
|
|
29728
29743
|
|
|
29729
|
-
export type
|
|
29744
|
+
export type FinancialStatementAnalysisError = FinancialStatementAnalysisErrors[keyof FinancialStatementAnalysisErrors];
|
|
29730
29745
|
|
|
29731
|
-
export type
|
|
29746
|
+
export type FinancialStatementAnalysisResponses = {
|
|
29732
29747
|
/**
|
|
29733
29748
|
* Successful Response
|
|
29734
29749
|
*/
|
|
29735
|
-
200:
|
|
29750
|
+
200: OperationEnvelopeFinancialStatementAnalysisResponse;
|
|
29736
29751
|
};
|
|
29737
29752
|
|
|
29738
|
-
export type
|
|
29753
|
+
export type FinancialStatementAnalysisResponse2 = FinancialStatementAnalysisResponses[keyof FinancialStatementAnalysisResponses];
|
|
29739
29754
|
|
|
29740
|
-
export type
|
|
29741
|
-
body:
|
|
29755
|
+
export type DisclosuresData = {
|
|
29756
|
+
body: DisclosuresRequest;
|
|
29742
29757
|
headers?: {
|
|
29743
29758
|
/**
|
|
29744
29759
|
* Idempotency-Key
|
|
@@ -29752,10 +29767,10 @@ export type FinancialStatementAnalysisData = {
|
|
|
29752
29767
|
graph_id: string;
|
|
29753
29768
|
};
|
|
29754
29769
|
query?: never;
|
|
29755
|
-
url: '/extensions/roboledger/{graph_id}/operations/
|
|
29770
|
+
url: '/extensions/roboledger/{graph_id}/operations/disclosures';
|
|
29756
29771
|
};
|
|
29757
29772
|
|
|
29758
|
-
export type
|
|
29773
|
+
export type DisclosuresErrors = {
|
|
29759
29774
|
/**
|
|
29760
29775
|
* Invalid request
|
|
29761
29776
|
*/
|
|
@@ -29790,19 +29805,19 @@ export type FinancialStatementAnalysisErrors = {
|
|
|
29790
29805
|
500: ErrorResponse;
|
|
29791
29806
|
};
|
|
29792
29807
|
|
|
29793
|
-
export type
|
|
29808
|
+
export type DisclosuresError = DisclosuresErrors[keyof DisclosuresErrors];
|
|
29794
29809
|
|
|
29795
|
-
export type
|
|
29810
|
+
export type DisclosuresResponses = {
|
|
29796
29811
|
/**
|
|
29797
29812
|
* Successful Response
|
|
29798
29813
|
*/
|
|
29799
|
-
200:
|
|
29814
|
+
200: OperationEnvelopeDisclosuresResponse;
|
|
29800
29815
|
};
|
|
29801
29816
|
|
|
29802
|
-
export type
|
|
29817
|
+
export type DisclosuresResponse2 = DisclosuresResponses[keyof DisclosuresResponses];
|
|
29803
29818
|
|
|
29804
|
-
export type
|
|
29805
|
-
body:
|
|
29819
|
+
export type InformationBlockData = {
|
|
29820
|
+
body: InformationBlockRequest;
|
|
29806
29821
|
headers?: {
|
|
29807
29822
|
/**
|
|
29808
29823
|
* Idempotency-Key
|
|
@@ -29816,10 +29831,10 @@ export type DisclosuresData = {
|
|
|
29816
29831
|
graph_id: string;
|
|
29817
29832
|
};
|
|
29818
29833
|
query?: never;
|
|
29819
|
-
url: '/extensions/roboledger/{graph_id}/operations/
|
|
29834
|
+
url: '/extensions/roboledger/{graph_id}/operations/information-block';
|
|
29820
29835
|
};
|
|
29821
29836
|
|
|
29822
|
-
export type
|
|
29837
|
+
export type InformationBlockErrors = {
|
|
29823
29838
|
/**
|
|
29824
29839
|
* Invalid request
|
|
29825
29840
|
*/
|
|
@@ -29854,19 +29869,19 @@ export type DisclosuresErrors = {
|
|
|
29854
29869
|
500: ErrorResponse;
|
|
29855
29870
|
};
|
|
29856
29871
|
|
|
29857
|
-
export type
|
|
29872
|
+
export type InformationBlockError = InformationBlockErrors[keyof InformationBlockErrors];
|
|
29858
29873
|
|
|
29859
|
-
export type
|
|
29874
|
+
export type InformationBlockResponses = {
|
|
29860
29875
|
/**
|
|
29861
29876
|
* Successful Response
|
|
29862
29877
|
*/
|
|
29863
|
-
200:
|
|
29878
|
+
200: OperationEnvelopeInformationBlockResponse;
|
|
29864
29879
|
};
|
|
29865
29880
|
|
|
29866
|
-
export type
|
|
29881
|
+
export type InformationBlockResponse2 = InformationBlockResponses[keyof InformationBlockResponses];
|
|
29867
29882
|
|
|
29868
|
-
export type
|
|
29869
|
-
body:
|
|
29883
|
+
export type LiveFinancialStatementData = {
|
|
29884
|
+
body: LiveFinancialStatementRequest;
|
|
29870
29885
|
headers?: {
|
|
29871
29886
|
/**
|
|
29872
29887
|
* Idempotency-Key
|
|
@@ -29880,10 +29895,10 @@ export type InformationBlockData = {
|
|
|
29880
29895
|
graph_id: string;
|
|
29881
29896
|
};
|
|
29882
29897
|
query?: never;
|
|
29883
|
-
url: '/extensions/roboledger/{graph_id}/operations/
|
|
29898
|
+
url: '/extensions/roboledger/{graph_id}/operations/live-financial-statement';
|
|
29884
29899
|
};
|
|
29885
29900
|
|
|
29886
|
-
export type
|
|
29901
|
+
export type LiveFinancialStatementErrors = {
|
|
29887
29902
|
/**
|
|
29888
29903
|
* Invalid request
|
|
29889
29904
|
*/
|
|
@@ -29918,16 +29933,16 @@ export type InformationBlockErrors = {
|
|
|
29918
29933
|
500: ErrorResponse;
|
|
29919
29934
|
};
|
|
29920
29935
|
|
|
29921
|
-
export type
|
|
29936
|
+
export type LiveFinancialStatementError = LiveFinancialStatementErrors[keyof LiveFinancialStatementErrors];
|
|
29922
29937
|
|
|
29923
|
-
export type
|
|
29938
|
+
export type LiveFinancialStatementResponses = {
|
|
29924
29939
|
/**
|
|
29925
29940
|
* Successful Response
|
|
29926
29941
|
*/
|
|
29927
|
-
200:
|
|
29942
|
+
200: OperationEnvelopeLiveFinancialStatementResponse;
|
|
29928
29943
|
};
|
|
29929
29944
|
|
|
29930
|
-
export type
|
|
29945
|
+
export type LiveFinancialStatementResponse2 = LiveFinancialStatementResponses[keyof LiveFinancialStatementResponses];
|
|
29931
29946
|
|
|
29932
29947
|
export type CreatePortfolioBlockData = {
|
|
29933
29948
|
body: CreatePortfolioBlockRequest;
|