@robosystems/client 0.5.7 → 0.5.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/artifacts/LedgerClient.d.ts +7 -0
- package/artifacts/LedgerClient.js +11 -1
- package/artifacts/LedgerClient.ts +12 -2
- package/artifacts/graphql/generated/graphql.d.ts +9 -0
- package/artifacts/graphql/generated/graphql.js +20 -0
- package/artifacts/graphql/generated/graphql.ts +29 -3
- package/artifacts/graphql/queries/ledger/informationBlock.js +4 -2
- package/artifacts/graphql/queries/ledger/informationBlock.ts +4 -2
- package/artifacts/graphql/queries/ledger/reportPackage.js +1 -0
- package/artifacts/graphql/queries/ledger/reportPackage.ts +1 -0
- package/index.ts +2 -2
- package/package.json +1 -1
- package/sdk/index.d.ts +2 -2
- package/sdk/index.js +5 -4
- package/sdk/index.ts +2 -2
- package/sdk/sdk.gen.d.ts +11 -3
- package/sdk/sdk.gen.js +20 -3
- package/sdk/sdk.gen.ts +20 -3
- package/sdk/types.gen.d.ts +428 -12
- package/sdk/types.gen.ts +439 -12
- package/sdk.gen.d.ts +11 -3
- package/sdk.gen.js +20 -3
- package/sdk.gen.ts +20 -3
- package/types.gen.d.ts +428 -12
- package/types.gen.ts +439 -12
package/sdk/types.gen.ts
CHANGED
|
@@ -379,6 +379,129 @@ export type AvailableGraphTiersResponse = {
|
|
|
379
379
|
tiers: Array<GraphTierInfo>;
|
|
380
380
|
};
|
|
381
381
|
|
|
382
|
+
/**
|
|
383
|
+
* BackfillPeriodOutcome
|
|
384
|
+
*
|
|
385
|
+
* Per-month result of a plan-history backfill pass.
|
|
386
|
+
*/
|
|
387
|
+
export type BackfillPeriodOutcome = {
|
|
388
|
+
/**
|
|
389
|
+
* Period
|
|
390
|
+
*
|
|
391
|
+
* The month, in YYYY-MM
|
|
392
|
+
*/
|
|
393
|
+
period: string;
|
|
394
|
+
/**
|
|
395
|
+
* Status
|
|
396
|
+
*
|
|
397
|
+
* stamped: reopen → reclose completed. skipped_drafts: the month holds draft entries the backfill refuses to post — review via list-period-drafts, then close-period or re-run. failed: the reclose raised; processing halted (see detail).
|
|
398
|
+
*/
|
|
399
|
+
status: string;
|
|
400
|
+
/**
|
|
401
|
+
* Statements Stamped
|
|
402
|
+
*
|
|
403
|
+
* Whether the reclose stamped canonical statement FactSets. False with a statement_stamp_note soft-skip when reporting isn't set up.
|
|
404
|
+
*/
|
|
405
|
+
statements_stamped?: boolean;
|
|
406
|
+
/**
|
|
407
|
+
* Statement Stamp Note
|
|
408
|
+
*
|
|
409
|
+
* Soft-skip reason when statements_stamped is false
|
|
410
|
+
*/
|
|
411
|
+
statement_stamp_note?: string | null;
|
|
412
|
+
/**
|
|
413
|
+
* Statement Rule Summary
|
|
414
|
+
*
|
|
415
|
+
* Statement-rule verification tally for the month's stamped sets (pass/fail/error/skipped); None when no rules ran.
|
|
416
|
+
*/
|
|
417
|
+
statement_rule_summary?: {
|
|
418
|
+
[key: string]: number;
|
|
419
|
+
} | null;
|
|
420
|
+
/**
|
|
421
|
+
* Detail
|
|
422
|
+
*
|
|
423
|
+
* Human-readable detail for skipped/failed months
|
|
424
|
+
*/
|
|
425
|
+
detail?: string | null;
|
|
426
|
+
};
|
|
427
|
+
|
|
428
|
+
/**
|
|
429
|
+
* BackfillPlanHistoryOperation
|
|
430
|
+
*
|
|
431
|
+
* Compile monthly statement history behind the close boundary.
|
|
432
|
+
*/
|
|
433
|
+
export type BackfillPlanHistoryOperation = {
|
|
434
|
+
/**
|
|
435
|
+
* Start Period
|
|
436
|
+
*
|
|
437
|
+
* YYYY-MM period to backfill from. Clamped to the earliest month with ledger data; defaults to that month when omitted. Must be on or before `closed_through`.
|
|
438
|
+
*/
|
|
439
|
+
start_period?: string | null;
|
|
440
|
+
/**
|
|
441
|
+
* Max Periods
|
|
442
|
+
*
|
|
443
|
+
* Maximum months to restamp in this call. Each month runs a full reopen → reclose cycle; keep chunks modest and loop on `remaining_periods`.
|
|
444
|
+
*/
|
|
445
|
+
max_periods?: number;
|
|
446
|
+
/**
|
|
447
|
+
* Allow Stale Sync
|
|
448
|
+
*
|
|
449
|
+
* Override the sync-currency gate on each reclose. Historical months predate the last sync in the normal case, so this is rarely needed.
|
|
450
|
+
*/
|
|
451
|
+
allow_stale_sync?: boolean;
|
|
452
|
+
/**
|
|
453
|
+
* Note
|
|
454
|
+
*
|
|
455
|
+
* Free-form note attached to each close audit event
|
|
456
|
+
*/
|
|
457
|
+
note?: string | null;
|
|
458
|
+
};
|
|
459
|
+
|
|
460
|
+
/**
|
|
461
|
+
* BackfillPlanHistoryResponse
|
|
462
|
+
*
|
|
463
|
+
* Response from one chunked plan-history backfill call.
|
|
464
|
+
*/
|
|
465
|
+
export type BackfillPlanHistoryResponse = {
|
|
466
|
+
fiscal_calendar: FiscalCalendarResponse;
|
|
467
|
+
/**
|
|
468
|
+
* Earliest Available Period
|
|
469
|
+
*
|
|
470
|
+
* First month with ledger data — the hard floor for backfill
|
|
471
|
+
*/
|
|
472
|
+
earliest_available_period: string;
|
|
473
|
+
/**
|
|
474
|
+
* Effective Start Period
|
|
475
|
+
*
|
|
476
|
+
* The start actually used after clamping to earliest_available_period
|
|
477
|
+
*/
|
|
478
|
+
effective_start_period: string;
|
|
479
|
+
/**
|
|
480
|
+
* Closed Through
|
|
481
|
+
*
|
|
482
|
+
* The close boundary the backfill runs up to (inclusive)
|
|
483
|
+
*/
|
|
484
|
+
closed_through: string;
|
|
485
|
+
/**
|
|
486
|
+
* Period Rows Created
|
|
487
|
+
*
|
|
488
|
+
* FiscalPeriod rows seeded (baseline-closed) for months the calendar didn't cover yet
|
|
489
|
+
*/
|
|
490
|
+
period_rows_created?: number;
|
|
491
|
+
/**
|
|
492
|
+
* Processed
|
|
493
|
+
*
|
|
494
|
+
* Months this call attempted, oldest first
|
|
495
|
+
*/
|
|
496
|
+
processed?: Array<BackfillPeriodOutcome>;
|
|
497
|
+
/**
|
|
498
|
+
* Remaining Periods
|
|
499
|
+
*
|
|
500
|
+
* Months still lacking canonical statement sets that this call did not attempt (beyond max_periods, or after a failure halt). Loop until empty.
|
|
501
|
+
*/
|
|
502
|
+
remaining_periods?: Array<string>;
|
|
503
|
+
};
|
|
504
|
+
|
|
382
505
|
/**
|
|
383
506
|
* BackupCreateRequest
|
|
384
507
|
*
|
|
@@ -1230,6 +1353,34 @@ export type ClosePeriodResponse = {
|
|
|
1230
1353
|
* ids of schedule Structures whose rules were evaluated during the close. Pairs with rule_summary.
|
|
1231
1354
|
*/
|
|
1232
1355
|
evaluated_structure_ids?: Array<string>;
|
|
1356
|
+
/**
|
|
1357
|
+
* Statements Stamped
|
|
1358
|
+
*
|
|
1359
|
+
* Whether the close stamped the period's canonical statement FactSets (the close-time pivot). False when the tenant hasn't set up reporting yet — see statement_stamp_note.
|
|
1360
|
+
*/
|
|
1361
|
+
statements_stamped?: boolean;
|
|
1362
|
+
/**
|
|
1363
|
+
* Statement Stamp Note
|
|
1364
|
+
*
|
|
1365
|
+
* Soft-skip reason when statements_stamped is false: no_coa_mapping | no_entity | no_statement_structures | no_taxonomy.
|
|
1366
|
+
*/
|
|
1367
|
+
statement_stamp_note?: string | null;
|
|
1368
|
+
/**
|
|
1369
|
+
* Stamped Statement Sets
|
|
1370
|
+
*
|
|
1371
|
+
* structure_id -> fact_set_id for every canonical statement FactSet minted by this close (report_id NULL; replaced on reclose).
|
|
1372
|
+
*/
|
|
1373
|
+
stamped_statement_sets?: {
|
|
1374
|
+
[key: string]: string;
|
|
1375
|
+
};
|
|
1376
|
+
/**
|
|
1377
|
+
* Statement Rule Summary
|
|
1378
|
+
*
|
|
1379
|
+
* Aggregated statement-rule verification outcome across the stamped structures — keys: pass/fail/error/skipped. None when no statement rules exist. Distinct from rule_summary (the schedule-rule pass).
|
|
1380
|
+
*/
|
|
1381
|
+
statement_rule_summary?: {
|
|
1382
|
+
[key: string]: number;
|
|
1383
|
+
} | null;
|
|
1233
1384
|
};
|
|
1234
1385
|
|
|
1235
1386
|
/**
|
|
@@ -1307,6 +1458,12 @@ export type ComputeForecastResponse = {
|
|
|
1307
1458
|
* Skipped
|
|
1308
1459
|
*/
|
|
1309
1460
|
skipped?: Array<SkippedForecastLite>;
|
|
1461
|
+
/**
|
|
1462
|
+
* Diagnostics
|
|
1463
|
+
*
|
|
1464
|
+
* Articulation notes — a missing cash/earnings anchor, schedule contributions with no base-set landing spot, an absent cash-flow structure. Informational; the walk still computed.
|
|
1465
|
+
*/
|
|
1466
|
+
diagnostics?: Array<string>;
|
|
1310
1467
|
};
|
|
1311
1468
|
|
|
1312
1469
|
/**
|
|
@@ -2193,6 +2350,12 @@ export type CreateForecastRequest = {
|
|
|
2193
2350
|
* Lever assertions — at least one.
|
|
2194
2351
|
*/
|
|
2195
2352
|
levers: Array<LeverAssertionRequest>;
|
|
2353
|
+
/**
|
|
2354
|
+
* Line Assertions
|
|
2355
|
+
*
|
|
2356
|
+
* Direct statement-line assertions (manual overrides). Each names a calc-DAG leaf and wins over driver rules and carry-forward for the months it asserts.
|
|
2357
|
+
*/
|
|
2358
|
+
line_assertions?: Array<LineAssertionRequest>;
|
|
2196
2359
|
/**
|
|
2197
2360
|
* Entity Id
|
|
2198
2361
|
*
|
|
@@ -3971,6 +4134,12 @@ export type ElementLite = {
|
|
|
3971
4134
|
* Value-domain vocabulary (monetary | ratio | percent | multiple | days | string | …). None means untyped; fall back to is_monetary.
|
|
3972
4135
|
*/
|
|
3973
4136
|
item_type?: string | null;
|
|
4137
|
+
/**
|
|
4138
|
+
* Documentation
|
|
4139
|
+
*
|
|
4140
|
+
* The element's documentation-role label — the catalog's authoritative value semantics (e.g. whether a percent driver is a growth rate or a rate-on-base fraction). None when the element carries no documentation label.
|
|
4141
|
+
*/
|
|
4142
|
+
documentation?: string | null;
|
|
3974
4143
|
};
|
|
3975
4144
|
|
|
3976
4145
|
/**
|
|
@@ -5124,6 +5293,12 @@ export type ForecastMechanics = {
|
|
|
5124
5293
|
* Expanded lever assertions (authoring order).
|
|
5125
5294
|
*/
|
|
5126
5295
|
levers: Array<LeverAssertionLite>;
|
|
5296
|
+
/**
|
|
5297
|
+
* Line Assertions
|
|
5298
|
+
*
|
|
5299
|
+
* Direct statement-line assertions (authoring order) — manual overrides that win over driver rules and carry-forward for the months they name.
|
|
5300
|
+
*/
|
|
5301
|
+
line_assertions?: Array<LineAssertionLite>;
|
|
5127
5302
|
/**
|
|
5128
5303
|
* Computed Months
|
|
5129
5304
|
*
|
|
@@ -5161,15 +5336,33 @@ export type ForecastMonthLite = {
|
|
|
5161
5336
|
/**
|
|
5162
5337
|
* Balance Sheet Fact Set Id
|
|
5163
5338
|
*
|
|
5164
|
-
* Scenario BS FactSet upserted for the month
|
|
5339
|
+
* Scenario BS FactSet upserted for the month — the full roll: carry-forward, rule-driven working capital, schedule movements, RE roll, balancing cash (A = L + E by construction).
|
|
5165
5340
|
*/
|
|
5166
5341
|
balance_sheet_fact_set_id?: string | null;
|
|
5342
|
+
/**
|
|
5343
|
+
* Cash Flow Fact Set Id
|
|
5344
|
+
*
|
|
5345
|
+
* Scenario CF FactSet upserted for the month — indirect-method, derived from BS deltas + NI, reconciled to the balancing ΔCash.
|
|
5346
|
+
*/
|
|
5347
|
+
cash_flow_fact_set_id?: string | null;
|
|
5167
5348
|
/**
|
|
5168
5349
|
* Computed Count
|
|
5169
5350
|
*
|
|
5170
|
-
* Number of facts emitted for the month across
|
|
5351
|
+
* Number of facts emitted for the month across all sets.
|
|
5171
5352
|
*/
|
|
5172
5353
|
computed_count?: number;
|
|
5354
|
+
/**
|
|
5355
|
+
* Verification Passed
|
|
5356
|
+
*
|
|
5357
|
+
* Whether every rule evaluated against the month's scenario sets passed (None = no rules ran for the month).
|
|
5358
|
+
*/
|
|
5359
|
+
verification_passed?: boolean | null;
|
|
5360
|
+
/**
|
|
5361
|
+
* Verification Failures
|
|
5362
|
+
*
|
|
5363
|
+
* Failed/errored rule messages for the month (capped).
|
|
5364
|
+
*/
|
|
5365
|
+
verification_failures?: Array<string>;
|
|
5173
5366
|
};
|
|
5174
5367
|
|
|
5175
5368
|
/**
|
|
@@ -7066,13 +7259,21 @@ export type LeverAssertionLite = {
|
|
|
7066
7259
|
* One lever's asserted values for the scenario.
|
|
7067
7260
|
*
|
|
7068
7261
|
* ``qname`` must resolve to an ``rs-driver:*`` catalog element (the
|
|
7069
|
-
* create handler rejects anything else).
|
|
7070
|
-
*
|
|
7071
|
-
*
|
|
7262
|
+
* create handler rejects anything else). Each lever's value semantics
|
|
7263
|
+
* are defined by its catalog element's documentation — surfaced as
|
|
7264
|
+
* ``documentation`` on the elements bundled in the forecast block's
|
|
7265
|
+
* envelope (``get-information-block``). Percent levers are decimals but
|
|
7266
|
+
* their *meaning* varies by lever: growth levers are month-over-month
|
|
7267
|
+
* rates (``RevenueGrowthRate`` 0.03 = +3%/month, compounding), while
|
|
7268
|
+
* rate-on-base levers are fractions of the same month's base
|
|
7269
|
+
* (``CostOfRevenueRate`` 0.62 = cost of revenue at 62% of that month's
|
|
7270
|
+
* revenues — not a growth rate). Days levers (``DaysSalesOutstanding``,
|
|
7271
|
+
* ``DaysPayableOutstanding``) are day counts.
|
|
7072
7272
|
*
|
|
7073
7273
|
* ``value`` is a uniform fill across the whole horizon;
|
|
7074
7274
|
* ``values_by_period`` overrides individual months (``"YYYY-MM"``
|
|
7075
|
-
* keys)
|
|
7275
|
+
* keys) — e.g. a margin-compression ramp asserts a different rate each
|
|
7276
|
+
* month. At least one of the two must be provided. Months covered by
|
|
7076
7277
|
* neither carry no assertion — the lever's rule is inactive for that
|
|
7077
7278
|
* month and its target falls to the engine's carry-forward default.
|
|
7078
7279
|
*/
|
|
@@ -7099,6 +7300,108 @@ export type LeverAssertionRequest = {
|
|
|
7099
7300
|
} | null;
|
|
7100
7301
|
};
|
|
7101
7302
|
|
|
7303
|
+
/**
|
|
7304
|
+
* LineAssertionLite
|
|
7305
|
+
*
|
|
7306
|
+
* One statement line's persisted direct assertion inside
|
|
7307
|
+
* ``ForecastMechanics``.
|
|
7308
|
+
*
|
|
7309
|
+
* The manual-override sibling of :class:`LeverAssertionLite`: a lever
|
|
7310
|
+
* asserts a *driver* whose rule derives a line; a line assertion pins
|
|
7311
|
+
* the **line itself** (a calc-DAG leaf) to typed values for the months
|
|
7312
|
+
* it names — winning over driver rules and carry-forward for exactly
|
|
7313
|
+
* those months (a displaced rule surfaces in the compute response's
|
|
7314
|
+
* ``skipped`` list). Subtotals stay calc-DAG-derived, so a manual line
|
|
7315
|
+
* still articulates through RollUps, RE, balancing cash, and derived
|
|
7316
|
+
* CF, and stays verification-gated.
|
|
7317
|
+
*
|
|
7318
|
+
* Same persistence doctrine as levers: values are duplicated as
|
|
7319
|
+
* authored facts in the scenario's lever FactSet (facts are what
|
|
7320
|
+
* ``compute-forecast`` binds); this mechanics copy is the
|
|
7321
|
+
* operator-legible round-trip shape.
|
|
7322
|
+
*/
|
|
7323
|
+
export type LineAssertionLite = {
|
|
7324
|
+
/**
|
|
7325
|
+
* Qname
|
|
7326
|
+
*
|
|
7327
|
+
* Asserted statement-leaf qname.
|
|
7328
|
+
*/
|
|
7329
|
+
qname: string;
|
|
7330
|
+
/**
|
|
7331
|
+
* Element Id
|
|
7332
|
+
*
|
|
7333
|
+
* Resolved tenant element id.
|
|
7334
|
+
*/
|
|
7335
|
+
element_id: string;
|
|
7336
|
+
/**
|
|
7337
|
+
* Item Type
|
|
7338
|
+
*
|
|
7339
|
+
* Format family from the element (monetary | ...).
|
|
7340
|
+
*/
|
|
7341
|
+
item_type?: string | null;
|
|
7342
|
+
/**
|
|
7343
|
+
* Period Type
|
|
7344
|
+
*
|
|
7345
|
+
* The element's period type — duration assertions pin IS lines; instant assertions pin BS lines through the roll.
|
|
7346
|
+
*/
|
|
7347
|
+
period_type?: string;
|
|
7348
|
+
/**
|
|
7349
|
+
* Values By Period
|
|
7350
|
+
*
|
|
7351
|
+
* Expanded per-month assertions keyed by ``YYYY-MM``.
|
|
7352
|
+
*/
|
|
7353
|
+
values_by_period: {
|
|
7354
|
+
[key: string]: number;
|
|
7355
|
+
};
|
|
7356
|
+
};
|
|
7357
|
+
|
|
7358
|
+
/**
|
|
7359
|
+
* LineAssertionRequest
|
|
7360
|
+
*
|
|
7361
|
+
* One statement line's directly asserted values for the scenario.
|
|
7362
|
+
*
|
|
7363
|
+
* The manual-override half of the authored surface: where a lever
|
|
7364
|
+
* asserts a *driver* (growth %, DSO) whose rule derives the line, a
|
|
7365
|
+
* line assertion asserts the **line itself** — an rs-gaap (or tenant
|
|
7366
|
+
* extension) statement leaf pinned to typed values for the months it
|
|
7367
|
+
* names. Assertions win over driver rules and carry-forward for those
|
|
7368
|
+
* months (a displaced rule lands in ``skipped``, legibly); months the
|
|
7369
|
+
* assertion doesn't name keep the engine's normal derivation.
|
|
7370
|
+
*
|
|
7371
|
+
* **Leaves only** — subtotals stay calc-DAG-derived, so a manually set
|
|
7372
|
+
* line still articulates through RollUps, RE, balancing cash, and the
|
|
7373
|
+
* derived CF, and stays verification-gated (the whole pitch vs a
|
|
7374
|
+
* spreadsheet cell). The create handler rejects calc-parent qnames.
|
|
7375
|
+
*
|
|
7376
|
+
* Value/period grammar is identical to levers: ``value`` is a uniform
|
|
7377
|
+
* fill across the horizon, ``values_by_period`` overrides individual
|
|
7378
|
+
* months. The canonical uses: zero out a base-month one-off so
|
|
7379
|
+
* carry-forward stops replicating it, or hold a line at a known budget
|
|
7380
|
+
* number no driver models.
|
|
7381
|
+
*/
|
|
7382
|
+
export type LineAssertionRequest = {
|
|
7383
|
+
/**
|
|
7384
|
+
* Qname
|
|
7385
|
+
*
|
|
7386
|
+
* QName of the statement leaf to assert (e.g. ``rs-gaap:NonoperatingIncomeExpense``). Must be a calc-DAG leaf; rs-driver concepts belong in ``levers``.
|
|
7387
|
+
*/
|
|
7388
|
+
qname: string;
|
|
7389
|
+
/**
|
|
7390
|
+
* Value
|
|
7391
|
+
*
|
|
7392
|
+
* Uniform value asserted for every month of the horizon.
|
|
7393
|
+
*/
|
|
7394
|
+
value?: number | null;
|
|
7395
|
+
/**
|
|
7396
|
+
* Values By Period
|
|
7397
|
+
*
|
|
7398
|
+
* Per-month overrides keyed by ``YYYY-MM``. Wins over ``value`` for the months it names.
|
|
7399
|
+
*/
|
|
7400
|
+
values_by_period?: {
|
|
7401
|
+
[key: string]: number;
|
|
7402
|
+
} | null;
|
|
7403
|
+
};
|
|
7404
|
+
|
|
7102
7405
|
/**
|
|
7103
7406
|
* LineItemMetadataPredicate
|
|
7104
7407
|
*
|
|
@@ -7881,6 +8184,52 @@ export type OperationEnvelopeAssociationResponse = {
|
|
|
7881
8184
|
idempotentReplay?: boolean;
|
|
7882
8185
|
};
|
|
7883
8186
|
|
|
8187
|
+
/**
|
|
8188
|
+
* OperationEnvelope[BackfillPlanHistoryResponse]
|
|
8189
|
+
*/
|
|
8190
|
+
export type OperationEnvelopeBackfillPlanHistoryResponse = {
|
|
8191
|
+
/**
|
|
8192
|
+
* Operation
|
|
8193
|
+
*
|
|
8194
|
+
* Kebab-case operation name
|
|
8195
|
+
*/
|
|
8196
|
+
operation: string;
|
|
8197
|
+
/**
|
|
8198
|
+
* Operationid
|
|
8199
|
+
*
|
|
8200
|
+
* op_-prefixed ULID for audit and SSE correlation
|
|
8201
|
+
*/
|
|
8202
|
+
operationId: string;
|
|
8203
|
+
/**
|
|
8204
|
+
* Status
|
|
8205
|
+
*
|
|
8206
|
+
* Operation lifecycle state
|
|
8207
|
+
*/
|
|
8208
|
+
status: 'completed' | 'pending' | 'failed';
|
|
8209
|
+
/**
|
|
8210
|
+
* Command-specific result payload
|
|
8211
|
+
*/
|
|
8212
|
+
result?: BackfillPlanHistoryResponse | null;
|
|
8213
|
+
/**
|
|
8214
|
+
* At
|
|
8215
|
+
*
|
|
8216
|
+
* ISO-8601 UTC timestamp
|
|
8217
|
+
*/
|
|
8218
|
+
at: string;
|
|
8219
|
+
/**
|
|
8220
|
+
* Createdby
|
|
8221
|
+
*
|
|
8222
|
+
* User ID that initiated the operation (null for legacy callers)
|
|
8223
|
+
*/
|
|
8224
|
+
createdBy?: string | null;
|
|
8225
|
+
/**
|
|
8226
|
+
* Idempotentreplay
|
|
8227
|
+
*
|
|
8228
|
+
* True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
|
|
8229
|
+
*/
|
|
8230
|
+
idempotentReplay?: boolean;
|
|
8231
|
+
};
|
|
8232
|
+
|
|
7884
8233
|
/**
|
|
7885
8234
|
* OperationEnvelope[BindTextBlockResponse]
|
|
7886
8235
|
*/
|
|
@@ -11020,6 +11369,12 @@ export type RenderingPeriodLite = {
|
|
|
11020
11369
|
* Label
|
|
11021
11370
|
*/
|
|
11022
11371
|
label?: string | null;
|
|
11372
|
+
/**
|
|
11373
|
+
* Forecast
|
|
11374
|
+
*
|
|
11375
|
+
* True when this column comes from a forecast scenario's FactSet — the machine-readable seam marker (labels also carry a '(forecast)' suffix, but consumers should key styling off this flag, not label parsing). None/absent = an actuals column.
|
|
11376
|
+
*/
|
|
11377
|
+
forecast?: boolean | null;
|
|
11023
11378
|
};
|
|
11024
11379
|
|
|
11025
11380
|
/**
|
|
@@ -14232,11 +14587,13 @@ export type UpdateEventHandlerRequest = {
|
|
|
14232
14587
|
*
|
|
14233
14588
|
* Update a forecast block in place.
|
|
14234
14589
|
*
|
|
14235
|
-
* Mutable: name, scenario_kind, horizon_months, base_period, levers
|
|
14236
|
-
* ``levers``
|
|
14237
|
-
*
|
|
14238
|
-
*
|
|
14239
|
-
*
|
|
14590
|
+
* Mutable: name, scenario_kind, horizon_months, base_period, levers,
|
|
14591
|
+
* line_assertions. ``levers`` and ``line_assertions`` are each a
|
|
14592
|
+
* **full replace** when provided (partial edits would make the asserted
|
|
14593
|
+
* set ambiguous); replacing one leaves the other as stored. Updating
|
|
14594
|
+
* does NOT recompute — previously computed scenario months go stale
|
|
14595
|
+
* until the next ``compute-forecast`` run (the compute-metrics drift
|
|
14596
|
+
* semantics).
|
|
14240
14597
|
*/
|
|
14241
14598
|
export type UpdateForecastRequest = {
|
|
14242
14599
|
/**
|
|
@@ -14267,6 +14624,12 @@ export type UpdateForecastRequest = {
|
|
|
14267
14624
|
* Full replacement of the lever set when provided.
|
|
14268
14625
|
*/
|
|
14269
14626
|
levers?: Array<LeverAssertionRequest> | null;
|
|
14627
|
+
/**
|
|
14628
|
+
* Line Assertions
|
|
14629
|
+
*
|
|
14630
|
+
* Full replacement of the line-assertion set when provided. Pass an empty list to clear every assertion.
|
|
14631
|
+
*/
|
|
14632
|
+
line_assertions?: Array<LineAssertionRequest> | null;
|
|
14270
14633
|
};
|
|
14271
14634
|
|
|
14272
14635
|
/**
|
|
@@ -15302,7 +15665,7 @@ export type UpdateForecastArm = {
|
|
|
15302
15665
|
*/
|
|
15303
15666
|
block_type: 'forecast';
|
|
15304
15667
|
/**
|
|
15305
|
-
* Forecast update payload.
|
|
15668
|
+
* Forecast update payload. Updating does NOT recompute — lever, horizon, or base-period changes leave the scenario's computed months stale until the next `compute-forecast` run.
|
|
15306
15669
|
*/
|
|
15307
15670
|
payload: UpdateForecastRequest;
|
|
15308
15671
|
};
|
|
@@ -24015,6 +24378,70 @@ export type ReopenPeriodResponses = {
|
|
|
24015
24378
|
|
|
24016
24379
|
export type ReopenPeriodResponse = ReopenPeriodResponses[keyof ReopenPeriodResponses];
|
|
24017
24380
|
|
|
24381
|
+
export type BackfillPlanHistoryData = {
|
|
24382
|
+
body: BackfillPlanHistoryOperation;
|
|
24383
|
+
headers?: {
|
|
24384
|
+
/**
|
|
24385
|
+
* Idempotency-Key
|
|
24386
|
+
*/
|
|
24387
|
+
'Idempotency-Key'?: string | null;
|
|
24388
|
+
};
|
|
24389
|
+
path: {
|
|
24390
|
+
/**
|
|
24391
|
+
* Graph Id
|
|
24392
|
+
*/
|
|
24393
|
+
graph_id: string;
|
|
24394
|
+
};
|
|
24395
|
+
query?: never;
|
|
24396
|
+
url: '/extensions/roboledger/{graph_id}/operations/backfill-plan-history';
|
|
24397
|
+
};
|
|
24398
|
+
|
|
24399
|
+
export type BackfillPlanHistoryErrors = {
|
|
24400
|
+
/**
|
|
24401
|
+
* Invalid request
|
|
24402
|
+
*/
|
|
24403
|
+
400: ErrorResponse;
|
|
24404
|
+
/**
|
|
24405
|
+
* Authentication required
|
|
24406
|
+
*/
|
|
24407
|
+
401: ErrorResponse;
|
|
24408
|
+
/**
|
|
24409
|
+
* Access denied
|
|
24410
|
+
*/
|
|
24411
|
+
403: ErrorResponse;
|
|
24412
|
+
/**
|
|
24413
|
+
* Resource not found
|
|
24414
|
+
*/
|
|
24415
|
+
404: ErrorResponse;
|
|
24416
|
+
/**
|
|
24417
|
+
* Idempotency-Key conflict — key reused with different body
|
|
24418
|
+
*/
|
|
24419
|
+
409: ErrorResponse;
|
|
24420
|
+
/**
|
|
24421
|
+
* Validation error
|
|
24422
|
+
*/
|
|
24423
|
+
422: ErrorResponse;
|
|
24424
|
+
/**
|
|
24425
|
+
* Rate limit exceeded
|
|
24426
|
+
*/
|
|
24427
|
+
429: ErrorResponse;
|
|
24428
|
+
/**
|
|
24429
|
+
* Internal server error
|
|
24430
|
+
*/
|
|
24431
|
+
500: ErrorResponse;
|
|
24432
|
+
};
|
|
24433
|
+
|
|
24434
|
+
export type BackfillPlanHistoryError = BackfillPlanHistoryErrors[keyof BackfillPlanHistoryErrors];
|
|
24435
|
+
|
|
24436
|
+
export type BackfillPlanHistoryResponses = {
|
|
24437
|
+
/**
|
|
24438
|
+
* Successful Response
|
|
24439
|
+
*/
|
|
24440
|
+
200: OperationEnvelopeBackfillPlanHistoryResponse;
|
|
24441
|
+
};
|
|
24442
|
+
|
|
24443
|
+
export type BackfillPlanHistoryResponse2 = BackfillPlanHistoryResponses[keyof BackfillPlanHistoryResponses];
|
|
24444
|
+
|
|
24018
24445
|
export type CreateReportData = {
|
|
24019
24446
|
body: CreateReportRequest;
|
|
24020
24447
|
headers?: {
|
package/sdk.gen.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Client, Options as Options2, TDataShape } from './client';
|
|
2
|
-
import type { AddPublishListMembersData, AddPublishListMembersErrors, AddPublishListMembersResponses, AutoMapElementsData, AutoMapElementsErrors, AutoMapElementsResponses, AutoSelectOperatorData, AutoSelectOperatorErrors, AutoSelectOperatorResponses, BatchProcessQueriesData, BatchProcessQueriesErrors, BatchProcessQueriesResponses, BindTextBlockData, BindTextBlockErrors, BindTextBlockResponses, BuildFactGridData, BuildFactGridErrors, BuildFactGridResponses, CallMcpToolData, CallMcpToolErrors, CallMcpToolResponses, CancelOperationData, CancelOperationErrors, CancelOperationResponses, CancelOrgSubscriptionData, CancelOrgSubscriptionErrors, CancelOrgSubscriptionResponses, CancelRepositorySubscriptionData, CancelRepositorySubscriptionErrors, CancelRepositorySubscriptionResponses, ChangeReportingStyleData, ChangeReportingStyleErrors, ChangeReportingStyleResponses, ChangeSubscriptionPlanData, ChangeSubscriptionPlanErrors, ChangeSubscriptionPlanResponses, ChangeTierData, ChangeTierErrors, ChangeTierResponses, CheckPasswordStrengthData, CheckPasswordStrengthErrors, CheckPasswordStrengthResponses, ClosePeriodData, ClosePeriodErrors, ClosePeriodResponses, CompleteSsoAuthData, CompleteSsoAuthErrors, CompleteSsoAuthResponses, ComputeForecastData, ComputeForecastErrors, ComputeForecastResponses, ComputeMetricsData, ComputeMetricsErrors, ComputeMetricsResponses, CreateAgentData, CreateAgentErrors, CreateAgentResponses, CreateBackupData, CreateBackupErrors, CreateBackupResponses, CreateCheckoutSessionData, CreateCheckoutSessionErrors, CreateCheckoutSessionResponses, CreateConnectionData, CreateConnectionErrors, CreateConnectionResponses, CreateEventBlockData, CreateEventBlockErrors, CreateEventBlockResponses, CreateEventHandlerData, CreateEventHandlerErrors, CreateEventHandlerResponses, CreateFileUploadData, CreateFileUploadErrors, CreateFileUploadResponses, CreateGraphData, CreateGraphErrors, CreateGraphResponses, CreateInformationBlockData, CreateInformationBlockErrors, CreateInformationBlockResponses, CreateMappingAssociationData, CreateMappingAssociationErrors, CreateMappingAssociationResponses, CreatePortalSessionData, CreatePortalSessionErrors, CreatePortalSessionResponses, CreatePortfolioBlockData, CreatePortfolioBlockErrors, CreatePortfolioBlockResponses, CreatePublishListData, CreatePublishListErrors, CreatePublishListResponses, CreateReportData, CreateReportErrors, CreateReportResponses, CreateRepositorySubscriptionData, CreateRepositorySubscriptionErrors, CreateRepositorySubscriptionResponses, CreateSecurityData, CreateSecurityErrors, CreateSecurityResponses, CreateSubgraphData, CreateSubgraphErrors, CreateSubgraphResponses, CreateTaxonomyBlockData, CreateTaxonomyBlockErrors, CreateTaxonomyBlockResponses, CreateUserApiKeyData, CreateUserApiKeyErrors, CreateUserApiKeyResponses, DeleteConnectionData, DeleteConnectionErrors, DeleteConnectionResponses, DeleteDocumentData, DeleteDocumentErrors, DeleteDocumentResponses, DeleteFileData, DeleteFileErrors, DeleteFileResponses, DeleteGraphData, DeleteGraphErrors, DeleteGraphResponses, DeleteInformationBlockData, DeleteInformationBlockErrors, DeleteInformationBlockResponses, DeleteJournalEntryData, DeleteJournalEntryErrors, DeleteJournalEntryResponses, DeleteMappingAssociationData, DeleteMappingAssociationErrors, DeleteMappingAssociationResponses, DeletePortfolioBlockData, DeletePortfolioBlockErrors, DeletePortfolioBlockResponses, DeletePublishListData, DeletePublishListErrors, DeletePublishListResponses, DeleteReportData, DeleteReportErrors, DeleteReportResponses, DeleteSecurityData, DeleteSecurityErrors, DeleteSecurityResponses, DeleteSubgraphData, DeleteSubgraphErrors, DeleteSubgraphResponses, DeleteTaxonomyBlockData, DeleteTaxonomyBlockErrors, DeleteTaxonomyBlockResponses, EvaluateRulesData, EvaluateRulesErrors, EvaluateRulesResponses, ExecuteCypherData, ExecuteCypherErrors, ExecuteCypherResponses, ExecuteEventBlockData, ExecuteEventBlockErrors, ExecuteEventBlockResponses, ExecuteSpecificOperatorData, ExecuteSpecificOperatorErrors, ExecuteSpecificOperatorResponses, ExecuteSqlData, ExecuteSqlErrors, ExecuteSqlResponses, ExportGraphSchemaData, ExportGraphSchemaErrors, ExportGraphSchemaResponses, FileReportData, FileReportErrors, FileReportResponses, FinancialStatementAnalysisData, FinancialStatementAnalysisErrors, FinancialStatementAnalysisResponses, ForgetData, ForgetErrors, ForgetResponses, ForgotPasswordData, ForgotPasswordErrors, ForgotPasswordResponses, GenerateSsoTokenData, GenerateSsoTokenErrors, GenerateSsoTokenResponses, GetAvailableExtensionsData, GetAvailableExtensionsErrors, GetAvailableExtensionsResponses, GetAvailableGraphTiersData, GetAvailableGraphTiersErrors, GetAvailableGraphTiersResponses, GetBackupDownloadUrlData, GetBackupDownloadUrlErrors, GetBackupDownloadUrlResponses, GetBackupStatsData, GetBackupStatsErrors, GetBackupStatsResponses, GetCaptchaConfigData, GetCaptchaConfigErrors, GetCaptchaConfigResponses, GetCheckoutStatusData, GetCheckoutStatusErrors, GetCheckoutStatusResponses, GetConnectionData, GetConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsErrors, GetConnectionOptionsResponses, GetConnectionResponses, GetCreditSummaryData, GetCreditSummaryErrors, GetCreditSummaryResponses, GetCurrentAuthUserData, GetCurrentAuthUserErrors, GetCurrentAuthUserResponses, GetCurrentUserData, GetCurrentUserErrors, GetCurrentUserResponses, GetDatabaseHealthData, GetDatabaseHealthErrors, GetDatabaseHealthResponses, GetDatabaseInfoData, GetDatabaseInfoErrors, GetDatabaseInfoResponses, GetDocumentData, GetDocumentErrors, GetDocumentResponses, GetDocumentSectionData, GetDocumentSectionErrors, GetDocumentSectionResponses, GetFileData, GetFileErrors, GetFileResponses, GetGraphCapacityData, GetGraphCapacityErrors, GetGraphCapacityResponses, GetGraphLimitsData, GetGraphLimitsErrors, GetGraphLimitsResponses, GetGraphMetricsData, GetGraphMetricsErrors, GetGraphMetricsResponses, GetGraphSchemaData, GetGraphSchemaErrors, GetGraphSchemaResponses, GetGraphsData, GetGraphsErrors, GetGraphsResponses, GetGraphSubscriptionData, GetGraphSubscriptionErrors, GetGraphSubscriptionResponses, GetGraphUsageAnalyticsData, GetGraphUsageAnalyticsErrors, GetGraphUsageAnalyticsResponses, GetMemoryData, GetMemoryErrors, GetMemoryResponses, GetOperationStatusData, GetOperationStatusErrors, GetOperationStatusResponses, GetOperatorMetadataData, GetOperatorMetadataErrors, GetOperatorMetadataResponses, GetOrgBillingCustomerData, GetOrgBillingCustomerErrors, GetOrgBillingCustomerResponses, GetOrgData, GetOrgErrors, GetOrgLimitsData, GetOrgLimitsErrors, GetOrgLimitsResponses, GetOrgResponses, GetOrgSubscriptionData, GetOrgSubscriptionErrors, GetOrgSubscriptionResponses, GetOrgUpcomingInvoiceData, GetOrgUpcomingInvoiceErrors, GetOrgUpcomingInvoiceResponses, GetOrgUsageData, GetOrgUsageErrors, GetOrgUsageResponses, GetPasswordPolicyData, GetPasswordPolicyErrors, GetPasswordPolicyResponses, GetServiceOfferingsData, GetServiceOfferingsErrors, GetServiceOfferingsResponses, GetServiceStatusData, GetServiceStatusResponses, GetSubgraphInfoData, GetSubgraphInfoErrors, GetSubgraphInfoResponses, GetSubgraphQuotaData, GetSubgraphQuotaErrors, GetSubgraphQuotaResponses, HandleHttpGetExtensionsGraphIdGraphqlGetData, HandleHttpGetExtensionsGraphIdGraphqlGetErrors, HandleHttpGetExtensionsGraphIdGraphqlGetResponses, HandleHttpPostExtensionsGraphIdGraphqlPostData, HandleHttpPostExtensionsGraphIdGraphqlPostErrors, HandleHttpPostExtensionsGraphIdGraphqlPostResponses, IndexDocumentData, IndexDocumentErrors, IndexDocumentResponses, IngestFileData, IngestFileErrors, IngestFileResponses, InitializeLedgerData, InitializeLedgerErrors, InitializeLedgerResponses, InitOAuthData, InitOAuthErrors, InitOAuthResponses, InviteOrgMemberData, InviteOrgMemberErrors, InviteOrgMemberResponses, LinkEntityTaxonomyData, LinkEntityTaxonomyErrors, LinkEntityTaxonomyResponses, ListBackupsData, ListBackupsErrors, ListBackupsResponses, ListConnectionsData, ListConnectionsErrors, ListConnectionsResponses, ListCreditTransactionsData, ListCreditTransactionsErrors, ListCreditTransactionsResponses, ListDocumentsData, ListDocumentsErrors, ListDocumentsResponses, ListFilesData, ListFilesErrors, ListFilesResponses, ListMcpToolsData, ListMcpToolsErrors, ListMcpToolsResponses, ListMemoriesData, ListMemoriesErrors, ListMemoriesResponses, ListOperatorsData, ListOperatorsErrors, ListOperatorsResponses, ListOrgGraphsData, ListOrgGraphsErrors, ListOrgGraphsResponses, ListOrgInvoicesData, ListOrgInvoicesErrors, ListOrgInvoicesResponses, ListOrgMembersData, ListOrgMembersErrors, ListOrgMembersResponses, ListOrgSubscriptionsData, ListOrgSubscriptionsErrors, ListOrgSubscriptionsResponses, ListSubgraphsData, ListSubgraphsErrors, ListSubgraphsResponses, ListTablesData, ListTablesErrors, ListTablesResponses, ListUserApiKeysData, ListUserApiKeysErrors, ListUserApiKeysResponses, ListUserOrgsData, ListUserOrgsErrors, ListUserOrgsResponses, LiveFinancialStatementData, LiveFinancialStatementErrors, LiveFinancialStatementResponses, LoginUserData, LoginUserErrors, LoginUserResponses, LogoutUserData, LogoutUserErrors, LogoutUserResponses, MaterializeData, MaterializeErrors, MaterializeResponses, OauthCallbackData, OauthCallbackErrors, OauthCallbackResponses, PreviewEventBlockData, PreviewEventBlockErrors, PreviewEventBlockResponses, PromoteObligationsData, PromoteObligationsErrors, PromoteObligationsResponses, RebuildScheduleData, RebuildScheduleErrors, RebuildScheduleResponses, RecallMemoryData, RecallMemoryErrors, RecallMemoryResponses, RecommendOperatorData, RecommendOperatorErrors, RecommendOperatorResponses, RefreshAuthSessionData, RefreshAuthSessionErrors, RefreshAuthSessionResponses, RegenerateReportData, RegenerateReportErrors, RegenerateReportResponses, RegisterUserData, RegisterUserErrors, RegisterUserResponses, RememberData, RememberErrors, RememberResponses, RemoveOrgMemberData, RemoveOrgMemberErrors, RemoveOrgMemberResponses, RemovePublishListMemberData, RemovePublishListMemberErrors, RemovePublishListMemberResponses, ReopenPeriodData, ReopenPeriodErrors, ReopenPeriodResponses, ResendVerificationEmailData, ResendVerificationEmailErrors, ResendVerificationEmailResponses, ResetPasswordData, ResetPasswordErrors, ResetPasswordResponses, RestoreBackupData, RestoreBackupErrors, RestoreBackupResponses, RevokeUserApiKeyData, RevokeUserApiKeyErrors, RevokeUserApiKeyResponses, SearchDocumentsData, SearchDocumentsErrors, SearchDocumentsResponses, SelectGraphData, SelectGraphErrors, SelectGraphResponses, SetCloseTargetData, SetCloseTargetErrors, SetCloseTargetResponses, SetConnectionWritePolicyData, SetConnectionWritePolicyErrors, SetConnectionWritePolicyResponses, ShareReportData, ShareReportErrors, ShareReportResponses, SsoTokenExchangeData, SsoTokenExchangeErrors, SsoTokenExchangeResponses, StreamOperationEventsData, StreamOperationEventsErrors, StreamOperationEventsResponses, SyncConnectionData, SyncConnectionErrors, SyncConnectionResponses, TransitionFilingStatusData, TransitionFilingStatusErrors, TransitionFilingStatusResponses, UpdateAgentData, UpdateAgentErrors, UpdateAgentResponses, UpdateEntityData, UpdateEntityErrors, UpdateEntityResponses, UpdateEventBlockData, UpdateEventBlockErrors, UpdateEventBlockResponses, UpdateEventHandlerData, UpdateEventHandlerErrors, UpdateEventHandlerResponses, UpdateInformationBlockData, UpdateInformationBlockErrors, UpdateInformationBlockResponses, UpdateJournalEntryData, UpdateJournalEntryErrors, UpdateJournalEntryResponses, UpdateMemoryData, UpdateMemoryErrors, UpdateMemoryResponses, UpdateOrgData, UpdateOrgErrors, UpdateOrgMemberRoleData, UpdateOrgMemberRoleErrors, UpdateOrgMemberRoleResponses, UpdateOrgResponses, UpdatePortfolioBlockData, UpdatePortfolioBlockErrors, UpdatePortfolioBlockResponses, UpdatePublishListData, UpdatePublishListErrors, UpdatePublishListResponses, UpdateSecurityData, UpdateSecurityErrors, UpdateSecurityResponses, UpdateTaxonomyBlockData, UpdateTaxonomyBlockErrors, UpdateTaxonomyBlockResponses, UpdateUserApiKeyData, UpdateUserApiKeyErrors, UpdateUserApiKeyResponses, UpdateUserData, UpdateUserErrors, UpdateUserPasswordData, UpdateUserPasswordErrors, UpdateUserPasswordResponses, UpdateUserResponses, ValidateResetTokenData, ValidateResetTokenErrors, ValidateResetTokenResponses, ValidateSchemaData, ValidateSchemaErrors, ValidateSchemaResponses, VerifyEmailData, VerifyEmailErrors, VerifyEmailResponses } from './types.gen';
|
|
2
|
+
import type { AddPublishListMembersData, AddPublishListMembersErrors, AddPublishListMembersResponses, AutoMapElementsData, AutoMapElementsErrors, AutoMapElementsResponses, AutoSelectOperatorData, AutoSelectOperatorErrors, AutoSelectOperatorResponses, BackfillPlanHistoryData, BackfillPlanHistoryErrors, BackfillPlanHistoryResponses, BatchProcessQueriesData, BatchProcessQueriesErrors, BatchProcessQueriesResponses, BindTextBlockData, BindTextBlockErrors, BindTextBlockResponses, BuildFactGridData, BuildFactGridErrors, BuildFactGridResponses, CallMcpToolData, CallMcpToolErrors, CallMcpToolResponses, CancelOperationData, CancelOperationErrors, CancelOperationResponses, CancelOrgSubscriptionData, CancelOrgSubscriptionErrors, CancelOrgSubscriptionResponses, CancelRepositorySubscriptionData, CancelRepositorySubscriptionErrors, CancelRepositorySubscriptionResponses, ChangeReportingStyleData, ChangeReportingStyleErrors, ChangeReportingStyleResponses, ChangeSubscriptionPlanData, ChangeSubscriptionPlanErrors, ChangeSubscriptionPlanResponses, ChangeTierData, ChangeTierErrors, ChangeTierResponses, CheckPasswordStrengthData, CheckPasswordStrengthErrors, CheckPasswordStrengthResponses, ClosePeriodData, ClosePeriodErrors, ClosePeriodResponses, CompleteSsoAuthData, CompleteSsoAuthErrors, CompleteSsoAuthResponses, ComputeForecastData, ComputeForecastErrors, ComputeForecastResponses, ComputeMetricsData, ComputeMetricsErrors, ComputeMetricsResponses, CreateAgentData, CreateAgentErrors, CreateAgentResponses, CreateBackupData, CreateBackupErrors, CreateBackupResponses, CreateCheckoutSessionData, CreateCheckoutSessionErrors, CreateCheckoutSessionResponses, CreateConnectionData, CreateConnectionErrors, CreateConnectionResponses, CreateEventBlockData, CreateEventBlockErrors, CreateEventBlockResponses, CreateEventHandlerData, CreateEventHandlerErrors, CreateEventHandlerResponses, CreateFileUploadData, CreateFileUploadErrors, CreateFileUploadResponses, CreateGraphData, CreateGraphErrors, CreateGraphResponses, CreateInformationBlockData, CreateInformationBlockErrors, CreateInformationBlockResponses, CreateMappingAssociationData, CreateMappingAssociationErrors, CreateMappingAssociationResponses, CreatePortalSessionData, CreatePortalSessionErrors, CreatePortalSessionResponses, CreatePortfolioBlockData, CreatePortfolioBlockErrors, CreatePortfolioBlockResponses, CreatePublishListData, CreatePublishListErrors, CreatePublishListResponses, CreateReportData, CreateReportErrors, CreateReportResponses, CreateRepositorySubscriptionData, CreateRepositorySubscriptionErrors, CreateRepositorySubscriptionResponses, CreateSecurityData, CreateSecurityErrors, CreateSecurityResponses, CreateSubgraphData, CreateSubgraphErrors, CreateSubgraphResponses, CreateTaxonomyBlockData, CreateTaxonomyBlockErrors, CreateTaxonomyBlockResponses, CreateUserApiKeyData, CreateUserApiKeyErrors, CreateUserApiKeyResponses, DeleteConnectionData, DeleteConnectionErrors, DeleteConnectionResponses, DeleteDocumentData, DeleteDocumentErrors, DeleteDocumentResponses, DeleteFileData, DeleteFileErrors, DeleteFileResponses, DeleteGraphData, DeleteGraphErrors, DeleteGraphResponses, DeleteInformationBlockData, DeleteInformationBlockErrors, DeleteInformationBlockResponses, DeleteJournalEntryData, DeleteJournalEntryErrors, DeleteJournalEntryResponses, DeleteMappingAssociationData, DeleteMappingAssociationErrors, DeleteMappingAssociationResponses, DeletePortfolioBlockData, DeletePortfolioBlockErrors, DeletePortfolioBlockResponses, DeletePublishListData, DeletePublishListErrors, DeletePublishListResponses, DeleteReportData, DeleteReportErrors, DeleteReportResponses, DeleteSecurityData, DeleteSecurityErrors, DeleteSecurityResponses, DeleteSubgraphData, DeleteSubgraphErrors, DeleteSubgraphResponses, DeleteTaxonomyBlockData, DeleteTaxonomyBlockErrors, DeleteTaxonomyBlockResponses, EvaluateRulesData, EvaluateRulesErrors, EvaluateRulesResponses, ExecuteCypherData, ExecuteCypherErrors, ExecuteCypherResponses, ExecuteEventBlockData, ExecuteEventBlockErrors, ExecuteEventBlockResponses, ExecuteSpecificOperatorData, ExecuteSpecificOperatorErrors, ExecuteSpecificOperatorResponses, ExecuteSqlData, ExecuteSqlErrors, ExecuteSqlResponses, ExportGraphSchemaData, ExportGraphSchemaErrors, ExportGraphSchemaResponses, FileReportData, FileReportErrors, FileReportResponses, FinancialStatementAnalysisData, FinancialStatementAnalysisErrors, FinancialStatementAnalysisResponses, ForgetData, ForgetErrors, ForgetResponses, ForgotPasswordData, ForgotPasswordErrors, ForgotPasswordResponses, GenerateSsoTokenData, GenerateSsoTokenErrors, GenerateSsoTokenResponses, GetAvailableExtensionsData, GetAvailableExtensionsErrors, GetAvailableExtensionsResponses, GetAvailableGraphTiersData, GetAvailableGraphTiersErrors, GetAvailableGraphTiersResponses, GetBackupDownloadUrlData, GetBackupDownloadUrlErrors, GetBackupDownloadUrlResponses, GetBackupStatsData, GetBackupStatsErrors, GetBackupStatsResponses, GetCaptchaConfigData, GetCaptchaConfigErrors, GetCaptchaConfigResponses, GetCheckoutStatusData, GetCheckoutStatusErrors, GetCheckoutStatusResponses, GetConnectionData, GetConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsErrors, GetConnectionOptionsResponses, GetConnectionResponses, GetCreditSummaryData, GetCreditSummaryErrors, GetCreditSummaryResponses, GetCurrentAuthUserData, GetCurrentAuthUserErrors, GetCurrentAuthUserResponses, GetCurrentUserData, GetCurrentUserErrors, GetCurrentUserResponses, GetDatabaseHealthData, GetDatabaseHealthErrors, GetDatabaseHealthResponses, GetDatabaseInfoData, GetDatabaseInfoErrors, GetDatabaseInfoResponses, GetDocumentData, GetDocumentErrors, GetDocumentResponses, GetDocumentSectionData, GetDocumentSectionErrors, GetDocumentSectionResponses, GetFileData, GetFileErrors, GetFileResponses, GetGraphCapacityData, GetGraphCapacityErrors, GetGraphCapacityResponses, GetGraphLimitsData, GetGraphLimitsErrors, GetGraphLimitsResponses, GetGraphMetricsData, GetGraphMetricsErrors, GetGraphMetricsResponses, GetGraphSchemaData, GetGraphSchemaErrors, GetGraphSchemaResponses, GetGraphsData, GetGraphsErrors, GetGraphsResponses, GetGraphSubscriptionData, GetGraphSubscriptionErrors, GetGraphSubscriptionResponses, GetGraphUsageAnalyticsData, GetGraphUsageAnalyticsErrors, GetGraphUsageAnalyticsResponses, GetMemoryData, GetMemoryErrors, GetMemoryResponses, GetOperationStatusData, GetOperationStatusErrors, GetOperationStatusResponses, GetOperatorMetadataData, GetOperatorMetadataErrors, GetOperatorMetadataResponses, GetOrgBillingCustomerData, GetOrgBillingCustomerErrors, GetOrgBillingCustomerResponses, GetOrgData, GetOrgErrors, GetOrgLimitsData, GetOrgLimitsErrors, GetOrgLimitsResponses, GetOrgResponses, GetOrgSubscriptionData, GetOrgSubscriptionErrors, GetOrgSubscriptionResponses, GetOrgUpcomingInvoiceData, GetOrgUpcomingInvoiceErrors, GetOrgUpcomingInvoiceResponses, GetOrgUsageData, GetOrgUsageErrors, GetOrgUsageResponses, GetPasswordPolicyData, GetPasswordPolicyErrors, GetPasswordPolicyResponses, GetServiceOfferingsData, GetServiceOfferingsErrors, GetServiceOfferingsResponses, GetServiceStatusData, GetServiceStatusResponses, GetSubgraphInfoData, GetSubgraphInfoErrors, GetSubgraphInfoResponses, GetSubgraphQuotaData, GetSubgraphQuotaErrors, GetSubgraphQuotaResponses, HandleHttpGetExtensionsGraphIdGraphqlGetData, HandleHttpGetExtensionsGraphIdGraphqlGetErrors, HandleHttpGetExtensionsGraphIdGraphqlGetResponses, HandleHttpPostExtensionsGraphIdGraphqlPostData, HandleHttpPostExtensionsGraphIdGraphqlPostErrors, HandleHttpPostExtensionsGraphIdGraphqlPostResponses, IndexDocumentData, IndexDocumentErrors, IndexDocumentResponses, IngestFileData, IngestFileErrors, IngestFileResponses, InitializeLedgerData, InitializeLedgerErrors, InitializeLedgerResponses, InitOAuthData, InitOAuthErrors, InitOAuthResponses, InviteOrgMemberData, InviteOrgMemberErrors, InviteOrgMemberResponses, LinkEntityTaxonomyData, LinkEntityTaxonomyErrors, LinkEntityTaxonomyResponses, ListBackupsData, ListBackupsErrors, ListBackupsResponses, ListConnectionsData, ListConnectionsErrors, ListConnectionsResponses, ListCreditTransactionsData, ListCreditTransactionsErrors, ListCreditTransactionsResponses, ListDocumentsData, ListDocumentsErrors, ListDocumentsResponses, ListFilesData, ListFilesErrors, ListFilesResponses, ListMcpToolsData, ListMcpToolsErrors, ListMcpToolsResponses, ListMemoriesData, ListMemoriesErrors, ListMemoriesResponses, ListOperatorsData, ListOperatorsErrors, ListOperatorsResponses, ListOrgGraphsData, ListOrgGraphsErrors, ListOrgGraphsResponses, ListOrgInvoicesData, ListOrgInvoicesErrors, ListOrgInvoicesResponses, ListOrgMembersData, ListOrgMembersErrors, ListOrgMembersResponses, ListOrgSubscriptionsData, ListOrgSubscriptionsErrors, ListOrgSubscriptionsResponses, ListSubgraphsData, ListSubgraphsErrors, ListSubgraphsResponses, ListTablesData, ListTablesErrors, ListTablesResponses, ListUserApiKeysData, ListUserApiKeysErrors, ListUserApiKeysResponses, ListUserOrgsData, ListUserOrgsErrors, ListUserOrgsResponses, LiveFinancialStatementData, LiveFinancialStatementErrors, LiveFinancialStatementResponses, LoginUserData, LoginUserErrors, LoginUserResponses, LogoutUserData, LogoutUserErrors, LogoutUserResponses, MaterializeData, MaterializeErrors, MaterializeResponses, OauthCallbackData, OauthCallbackErrors, OauthCallbackResponses, PreviewEventBlockData, PreviewEventBlockErrors, PreviewEventBlockResponses, PromoteObligationsData, PromoteObligationsErrors, PromoteObligationsResponses, RebuildScheduleData, RebuildScheduleErrors, RebuildScheduleResponses, RecallMemoryData, RecallMemoryErrors, RecallMemoryResponses, RecommendOperatorData, RecommendOperatorErrors, RecommendOperatorResponses, RefreshAuthSessionData, RefreshAuthSessionErrors, RefreshAuthSessionResponses, RegenerateReportData, RegenerateReportErrors, RegenerateReportResponses, RegisterUserData, RegisterUserErrors, RegisterUserResponses, RememberData, RememberErrors, RememberResponses, RemoveOrgMemberData, RemoveOrgMemberErrors, RemoveOrgMemberResponses, RemovePublishListMemberData, RemovePublishListMemberErrors, RemovePublishListMemberResponses, ReopenPeriodData, ReopenPeriodErrors, ReopenPeriodResponses, ResendVerificationEmailData, ResendVerificationEmailErrors, ResendVerificationEmailResponses, ResetPasswordData, ResetPasswordErrors, ResetPasswordResponses, RestoreBackupData, RestoreBackupErrors, RestoreBackupResponses, RevokeUserApiKeyData, RevokeUserApiKeyErrors, RevokeUserApiKeyResponses, SearchDocumentsData, SearchDocumentsErrors, SearchDocumentsResponses, SelectGraphData, SelectGraphErrors, SelectGraphResponses, SetCloseTargetData, SetCloseTargetErrors, SetCloseTargetResponses, SetConnectionWritePolicyData, SetConnectionWritePolicyErrors, SetConnectionWritePolicyResponses, ShareReportData, ShareReportErrors, ShareReportResponses, SsoTokenExchangeData, SsoTokenExchangeErrors, SsoTokenExchangeResponses, StreamOperationEventsData, StreamOperationEventsErrors, StreamOperationEventsResponses, SyncConnectionData, SyncConnectionErrors, SyncConnectionResponses, TransitionFilingStatusData, TransitionFilingStatusErrors, TransitionFilingStatusResponses, UpdateAgentData, UpdateAgentErrors, UpdateAgentResponses, UpdateEntityData, UpdateEntityErrors, UpdateEntityResponses, UpdateEventBlockData, UpdateEventBlockErrors, UpdateEventBlockResponses, UpdateEventHandlerData, UpdateEventHandlerErrors, UpdateEventHandlerResponses, UpdateInformationBlockData, UpdateInformationBlockErrors, UpdateInformationBlockResponses, UpdateJournalEntryData, UpdateJournalEntryErrors, UpdateJournalEntryResponses, UpdateMemoryData, UpdateMemoryErrors, UpdateMemoryResponses, UpdateOrgData, UpdateOrgErrors, UpdateOrgMemberRoleData, UpdateOrgMemberRoleErrors, UpdateOrgMemberRoleResponses, UpdateOrgResponses, UpdatePortfolioBlockData, UpdatePortfolioBlockErrors, UpdatePortfolioBlockResponses, UpdatePublishListData, UpdatePublishListErrors, UpdatePublishListResponses, UpdateSecurityData, UpdateSecurityErrors, UpdateSecurityResponses, UpdateTaxonomyBlockData, UpdateTaxonomyBlockErrors, UpdateTaxonomyBlockResponses, UpdateUserApiKeyData, UpdateUserApiKeyErrors, UpdateUserApiKeyResponses, UpdateUserData, UpdateUserErrors, UpdateUserPasswordData, UpdateUserPasswordErrors, UpdateUserPasswordResponses, UpdateUserResponses, ValidateResetTokenData, ValidateResetTokenErrors, ValidateResetTokenResponses, ValidateSchemaData, ValidateSchemaErrors, ValidateSchemaResponses, VerifyEmailData, VerifyEmailErrors, VerifyEmailResponses } from './types.gen';
|
|
3
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -936,7 +936,7 @@ export declare const setCloseTarget: <ThrowOnError extends boolean = false>(opti
|
|
|
936
936
|
/**
|
|
937
937
|
* Close Fiscal Period
|
|
938
938
|
*
|
|
939
|
-
* Lock a single fiscal period. Posts draft entries, runs the balance-sheet equation check, advances `closed_through` by one,
|
|
939
|
+
* Lock a single fiscal period. Posts draft entries, runs the balance-sheet equation check, advances `closed_through` by one, auto-advances `close_target` if this close caught up to it, and stamps the period's canonical statement FactSets from the posted ledger (`statements_stamped` / `stamped_statement_sets` in the response; soft-skipped with `statement_stamp_note` when reporting isn't set up). Period must be exactly `closed_through + 1` — sequence violations return 422 with structured `blockers`. Common blockers: `sync_stale` (override with `allow_stale_sync=true` after manual verification), `period_incomplete` (draft entries unbalanced), `sequence_violation` (out-of-order).
|
|
940
940
|
*
|
|
941
941
|
* **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
|
|
942
942
|
*/
|
|
@@ -944,11 +944,19 @@ export declare const closePeriod: <ThrowOnError extends boolean = false>(options
|
|
|
944
944
|
/**
|
|
945
945
|
* Reopen Fiscal Period
|
|
946
946
|
*
|
|
947
|
-
* Decrement `closed_through` by one. Only the most recently closed period can be reopened (no reach-back). The required `reason` is captured in the audit log. Use sparingly — reopen invalidates downstream artifacts that trusted the closed state (reports, shared filings).
|
|
947
|
+
* Decrement `closed_through` by one. Only the most recently closed period can be reopened (no reach-back). Retracts the month's canonical statement FactSets (a reopened month is no longer a closed assertion; re-closing restamps them). The required `reason` is captured in the audit log. Use sparingly — reopen invalidates downstream artifacts that trusted the closed state (reports, shared filings).
|
|
948
948
|
*
|
|
949
949
|
* **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
|
|
950
950
|
*/
|
|
951
951
|
export declare const reopenPeriod: <ThrowOnError extends boolean = false>(options: Options<ReopenPeriodData, ThrowOnError>) => import("./client").RequestResult<ReopenPeriodResponses, ReopenPeriodErrors, ThrowOnError, "fields">;
|
|
952
|
+
/**
|
|
953
|
+
* Backfill Plan History
|
|
954
|
+
*
|
|
955
|
+
* Compile monthly statement history behind the close boundary — the plan's historical columns. Seeds any missing FiscalPeriod rows (baseline-closed) back to the clamped `start_period`, then restamps each month lacking canonical statement FactSets by running the real reopen → reclose cycle (balance validation, statement rules, and audit events per month). Chunked: at most `max_periods` months per call, oldest first — loop until `remaining_periods` comes back empty. Idempotent: already-stamped months are never touched. Months holding draft entries are skipped, never posted. `start_period` is clamped to the earliest month with ledger data, so deep-history tenants only backfill what actually exists.
|
|
956
|
+
*
|
|
957
|
+
* **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
|
|
958
|
+
*/
|
|
959
|
+
export declare const backfillPlanHistory: <ThrowOnError extends boolean = false>(options: Options<BackfillPlanHistoryData, ThrowOnError>) => import("./client").RequestResult<BackfillPlanHistoryResponses, BackfillPlanHistoryErrors, ThrowOnError, "fields">;
|
|
952
960
|
/**
|
|
953
961
|
* Create Report
|
|
954
962
|
*
|