@robosystems/client 0.3.39 → 0.3.41
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 +35 -41
- package/artifacts/LedgerClient.js +61 -102
- package/artifacts/LedgerClient.ts +82 -119
- package/artifacts/graphql/generated/graphql.d.ts +48 -3
- package/artifacts/graphql/generated/graphql.js +70 -2
- package/artifacts/graphql/generated/graphql.ts +123 -3
- package/artifacts/graphql/queries/ledger/reportDownloadUrl.d.ts +11 -0
- package/artifacts/graphql/queries/ledger/reportDownloadUrl.js +29 -0
- package/artifacts/graphql/queries/ledger/reportDownloadUrl.ts +27 -0
- package/bin/create-feature.sh +5 -3
- package/index.ts +2 -2
- package/package.json +1 -2
- package/sdk/index.d.ts +2 -2
- package/sdk/index.js +3 -3
- package/sdk/index.ts +2 -2
- package/sdk/sdk.gen.d.ts +13 -11
- package/sdk/sdk.gen.js +23 -17
- package/sdk/sdk.gen.ts +22 -16
- package/sdk/types.gen.d.ts +191 -110
- package/sdk/types.gen.ts +199 -115
- package/sdk.gen.d.ts +13 -11
- package/sdk.gen.js +23 -17
- package/sdk.gen.ts +22 -16
- package/types.gen.d.ts +191 -110
- package/types.gen.ts +199 -115
package/sdk/types.gen.ts
CHANGED
|
@@ -763,7 +763,7 @@ export type CancelSubscriptionRequest = {
|
|
|
763
763
|
/**
|
|
764
764
|
* ChangeReportingStyleOp
|
|
765
765
|
*
|
|
766
|
-
* Body for the change-reporting-style operation
|
|
766
|
+
* Body for the change-reporting-style operation.
|
|
767
767
|
*
|
|
768
768
|
* Switches the graph to a different Reporting Style. The target Style
|
|
769
769
|
* must be a library- or customer-authored Structure with
|
|
@@ -980,7 +980,7 @@ export type ClosePeriodResponse = {
|
|
|
980
980
|
/**
|
|
981
981
|
* Rule Summary
|
|
982
982
|
*
|
|
983
|
-
* Aggregated rule-eval outcome across every schedule Structure with facts in the closed period — keys: pass/fail/error/skipped. None when no schedules had facts in the period (
|
|
983
|
+
* Aggregated rule-eval outcome across every schedule Structure with facts in the closed period — keys: pass/fail/error/skipped. None when no schedules had facts in the period (auto-run on close).
|
|
984
984
|
*/
|
|
985
985
|
rule_summary?: {
|
|
986
986
|
[key: string]: number;
|
|
@@ -2017,7 +2017,7 @@ export type CreateScheduleRequest = {
|
|
|
2017
2017
|
/**
|
|
2018
2018
|
* Element Ids
|
|
2019
2019
|
*
|
|
2020
|
-
*
|
|
2020
|
+
* CoA element ids the schedule touches (the `id` from get-unmapped-elements, not taxonomy qnames) — typically the same debit + credit ids used in entry_template.
|
|
2021
2021
|
*/
|
|
2022
2022
|
element_ids: Array<string>;
|
|
2023
2023
|
/**
|
|
@@ -2043,7 +2043,7 @@ export type CreateScheduleRequest = {
|
|
|
2043
2043
|
/**
|
|
2044
2044
|
* Closed Through
|
|
2045
2045
|
*
|
|
2046
|
-
*
|
|
2046
|
+
* Watermark for onboarding. Facts with period_end ≤ this date are flagged 'historical' and their schedule_entry_due obligations are emitted 'voided', so the close workflow starts drafting at the first open period. Set this to the last day of the fiscal calendar's closed_through month (calendar '2026-05' → '2026-05-31') whether those months were actually closed in RoboLedger or just baseline-watermarked at initialization. Omitting it (when prior periods exist) leaves pre-watermark periods as 'pending' obligations that block the first close.
|
|
2047
2047
|
*/
|
|
2048
2048
|
closed_through?: string | null;
|
|
2049
2049
|
/**
|
|
@@ -3756,13 +3756,13 @@ export type EntryTemplateRequest = {
|
|
|
3756
3756
|
/**
|
|
3757
3757
|
* Debit Element Id
|
|
3758
3758
|
*
|
|
3759
|
-
*
|
|
3759
|
+
* CoA element id to debit (e.g. Depreciation Expense). This is a chart-of-accounts element id — the `id` returned by get-unmapped-elements / get-graph-schema — NOT a taxonomy qname.
|
|
3760
3760
|
*/
|
|
3761
3761
|
debit_element_id: string;
|
|
3762
3762
|
/**
|
|
3763
3763
|
* Credit Element Id
|
|
3764
3764
|
*
|
|
3765
|
-
*
|
|
3765
|
+
* CoA element id to credit (e.g. Accumulated Depreciation). A chart-of-accounts element id (see get-unmapped-elements), not a taxonomy qname. One template = one debit/credit pair; model a multi-account entry as several schedules.
|
|
3766
3766
|
*/
|
|
3767
3767
|
credit_element_id: string;
|
|
3768
3768
|
/**
|
|
@@ -6541,7 +6541,7 @@ export type ListSubgraphsResponse = {
|
|
|
6541
6541
|
/**
|
|
6542
6542
|
* Subgraphs Enabled
|
|
6543
6543
|
*
|
|
6544
|
-
* Whether subgraphs are enabled for this tier (requires
|
|
6544
|
+
* Whether subgraphs are enabled for this tier (requires Large/XLarge tier)
|
|
6545
6545
|
*/
|
|
6546
6546
|
subgraphs_enabled: boolean;
|
|
6547
6547
|
/**
|
|
@@ -8080,6 +8080,52 @@ export type OperationEnvelopeReportResponse = {
|
|
|
8080
8080
|
idempotentReplay?: boolean;
|
|
8081
8081
|
};
|
|
8082
8082
|
|
|
8083
|
+
/**
|
|
8084
|
+
* OperationEnvelope[ScheduleCreatedResponse]
|
|
8085
|
+
*/
|
|
8086
|
+
export type OperationEnvelopeScheduleCreatedResponse = {
|
|
8087
|
+
/**
|
|
8088
|
+
* Operation
|
|
8089
|
+
*
|
|
8090
|
+
* Kebab-case operation name
|
|
8091
|
+
*/
|
|
8092
|
+
operation: string;
|
|
8093
|
+
/**
|
|
8094
|
+
* Operationid
|
|
8095
|
+
*
|
|
8096
|
+
* op_-prefixed ULID for audit and SSE correlation
|
|
8097
|
+
*/
|
|
8098
|
+
operationId: string;
|
|
8099
|
+
/**
|
|
8100
|
+
* Status
|
|
8101
|
+
*
|
|
8102
|
+
* Operation lifecycle state
|
|
8103
|
+
*/
|
|
8104
|
+
status: 'completed' | 'pending' | 'failed';
|
|
8105
|
+
/**
|
|
8106
|
+
* Command-specific result payload
|
|
8107
|
+
*/
|
|
8108
|
+
result?: ScheduleCreatedResponse | null;
|
|
8109
|
+
/**
|
|
8110
|
+
* At
|
|
8111
|
+
*
|
|
8112
|
+
* ISO-8601 UTC timestamp
|
|
8113
|
+
*/
|
|
8114
|
+
at: string;
|
|
8115
|
+
/**
|
|
8116
|
+
* Createdby
|
|
8117
|
+
*
|
|
8118
|
+
* User ID that initiated the operation (null for legacy callers)
|
|
8119
|
+
*/
|
|
8120
|
+
createdBy?: string | null;
|
|
8121
|
+
/**
|
|
8122
|
+
* Idempotentreplay
|
|
8123
|
+
*
|
|
8124
|
+
* True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
|
|
8125
|
+
*/
|
|
8126
|
+
idempotentReplay?: boolean;
|
|
8127
|
+
};
|
|
8128
|
+
|
|
8083
8129
|
/**
|
|
8084
8130
|
* OperationEnvelope[SecurityResponse]
|
|
8085
8131
|
*/
|
|
@@ -9820,6 +9866,32 @@ export type RateLimits = {
|
|
|
9820
9866
|
burst_capacity: number;
|
|
9821
9867
|
};
|
|
9822
9868
|
|
|
9869
|
+
/**
|
|
9870
|
+
* RebuildScheduleRequest
|
|
9871
|
+
*
|
|
9872
|
+
* Re-run the schedule generator in place on an existing schedule.
|
|
9873
|
+
*
|
|
9874
|
+
* Atomic alternative to delete-then-recreate: the structure id and its
|
|
9875
|
+
* element associations are preserved, the old pending obligation chain
|
|
9876
|
+
* is voided, the old facts + rules are deleted, and a fresh set of
|
|
9877
|
+
* forward facts + a fresh obligation chain are regenerated from the
|
|
9878
|
+
* schedule's stored definition (entry_template / schedule_metadata /
|
|
9879
|
+
* monthly_amount / period bounds on the Structure's metadata).
|
|
9880
|
+
*
|
|
9881
|
+
* The historical-vs-in-scope split is re-derived from the CURRENT fiscal
|
|
9882
|
+
* calendar `closed_through`, so a rebuild re-scopes the schedule to
|
|
9883
|
+
* today's close state. Use this to pick up a fixed generator (e.g. the
|
|
9884
|
+
* roll-forward direction fix) without orphaning obligations.
|
|
9885
|
+
*/
|
|
9886
|
+
export type RebuildScheduleRequest = {
|
|
9887
|
+
/**
|
|
9888
|
+
* Structure Id
|
|
9889
|
+
*
|
|
9890
|
+
* The schedule structure to regenerate in place.
|
|
9891
|
+
*/
|
|
9892
|
+
structure_id: string;
|
|
9893
|
+
};
|
|
9894
|
+
|
|
9823
9895
|
/**
|
|
9824
9896
|
* RegenerateReportOperation
|
|
9825
9897
|
*
|
|
@@ -10343,18 +10415,17 @@ export type RestoreBackupOp = {
|
|
|
10343
10415
|
*
|
|
10344
10416
|
* Filter-based attribution mechanics for ``block_type='rollforward'``.
|
|
10345
10417
|
*
|
|
10346
|
-
*
|
|
10347
|
-
*
|
|
10348
|
-
*
|
|
10349
|
-
*
|
|
10350
|
-
*
|
|
10351
|
-
*
|
|
10352
|
-
* any residual against the default change tag (Tier 1 fallback).
|
|
10418
|
+
* Filter-based attribution: each block decomposes one BS source
|
|
10419
|
+
* element's period delta into a list of flow concepts via declared
|
|
10420
|
+
* :class:`AttributionFilter` predicates. The renderer evaluates the
|
|
10421
|
+
* filters against ledger LineItems at envelope-build time, emits one
|
|
10422
|
+
* attributed fact per filter per period, and arbitrates any residual
|
|
10423
|
+
* against the default change tag fallback.
|
|
10353
10424
|
*
|
|
10354
10425
|
* Reads directly from the typed ``structures.artifact_mechanics`` JSONB
|
|
10355
10426
|
* column. ``attribution_filters`` rides as nested JSON; the predicate
|
|
10356
|
-
* union widens as new predicate shapes
|
|
10357
|
-
* ``line_item_metadata_field``
|
|
10427
|
+
* union widens as new predicate shapes are added — currently only
|
|
10428
|
+
* ``line_item_metadata_field`` is carried.
|
|
10358
10429
|
*/
|
|
10359
10430
|
export type RollforwardMechanics = {
|
|
10360
10431
|
/**
|
|
@@ -10376,13 +10447,13 @@ export type RollforwardMechanics = {
|
|
|
10376
10447
|
/**
|
|
10377
10448
|
* Default Change Tag Element Id
|
|
10378
10449
|
*
|
|
10379
|
-
* Element id of the
|
|
10450
|
+
* 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``.
|
|
10380
10451
|
*/
|
|
10381
10452
|
default_change_tag_element_id?: string | null;
|
|
10382
10453
|
/**
|
|
10383
10454
|
* Default Change Tag Qname
|
|
10384
10455
|
*
|
|
10385
|
-
* QName of the
|
|
10456
|
+
* 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.
|
|
10386
10457
|
*/
|
|
10387
10458
|
default_change_tag_qname?: string | null;
|
|
10388
10459
|
/**
|
|
@@ -10612,6 +10683,46 @@ export type SsoTokenResponse = {
|
|
|
10612
10683
|
apps: Array<string>;
|
|
10613
10684
|
};
|
|
10614
10685
|
|
|
10686
|
+
/**
|
|
10687
|
+
* ScheduleCreatedResponse
|
|
10688
|
+
*/
|
|
10689
|
+
export type ScheduleCreatedResponse = {
|
|
10690
|
+
/**
|
|
10691
|
+
* Structure Id
|
|
10692
|
+
*/
|
|
10693
|
+
structure_id: string;
|
|
10694
|
+
/**
|
|
10695
|
+
* Name
|
|
10696
|
+
*/
|
|
10697
|
+
name: string;
|
|
10698
|
+
/**
|
|
10699
|
+
* Taxonomy Id
|
|
10700
|
+
*/
|
|
10701
|
+
taxonomy_id: string;
|
|
10702
|
+
/**
|
|
10703
|
+
* Total Periods
|
|
10704
|
+
*/
|
|
10705
|
+
total_periods: number;
|
|
10706
|
+
/**
|
|
10707
|
+
* Total Facts
|
|
10708
|
+
*/
|
|
10709
|
+
total_facts: number;
|
|
10710
|
+
/**
|
|
10711
|
+
* Rule Summary
|
|
10712
|
+
*/
|
|
10713
|
+
rule_summary?: {
|
|
10714
|
+
[key: string]: number;
|
|
10715
|
+
} | null;
|
|
10716
|
+
/**
|
|
10717
|
+
* Schedule Created Event Id
|
|
10718
|
+
*/
|
|
10719
|
+
schedule_created_event_id?: string | null;
|
|
10720
|
+
/**
|
|
10721
|
+
* Pending Event Count
|
|
10722
|
+
*/
|
|
10723
|
+
pending_event_count?: number;
|
|
10724
|
+
};
|
|
10725
|
+
|
|
10615
10726
|
/**
|
|
10616
10727
|
* ScheduleMechanics
|
|
10617
10728
|
*
|
|
@@ -12231,8 +12342,7 @@ export type TaxonomyBlockEnvelope = {
|
|
|
12231
12342
|
*
|
|
12232
12343
|
* Exactly one of ``rule_pattern`` (arithmetic) or ``rule_check_kind``
|
|
12233
12344
|
* (model-structure) is non-null per row, enforced by the
|
|
12234
|
-
* ``check_rule_pattern_kind_xor`` DB constraint.
|
|
12235
|
-
* information-block.md §5.2.2.
|
|
12345
|
+
* ``check_rule_pattern_kind_xor`` DB constraint.
|
|
12236
12346
|
*/
|
|
12237
12347
|
export type TaxonomyBlockRule = {
|
|
12238
12348
|
/**
|
|
@@ -12296,8 +12406,7 @@ export type TaxonomyBlockRule = {
|
|
|
12296
12406
|
* ``LeafHasClassification``, ``LibraryOriginImmutability``,
|
|
12297
12407
|
* ``UniqueQNameInTaxonomy``) are system-managed — they're auto-emitted
|
|
12298
12408
|
* by :func:`emit_auto_rules` at taxonomy-block creation time and
|
|
12299
|
-
* populate ``rules.rule_check_kind`` instead of ``rule_pattern``.
|
|
12300
|
-
* information-block.md §5.2.2 for the axis split.
|
|
12409
|
+
* populate ``rules.rule_check_kind`` instead of ``rule_pattern``.
|
|
12301
12410
|
*/
|
|
12302
12411
|
export type TaxonomyBlockRuleRequest = {
|
|
12303
12412
|
/**
|
|
@@ -13243,7 +13352,7 @@ export type UpdateRollforwardRequest = {
|
|
|
13243
13352
|
* NOT editable via this op: period_start, period_end, monthly_amount.
|
|
13244
13353
|
* Those require fact regeneration — fire an event block that terminates
|
|
13245
13354
|
* the schedule (e.g., `asset_disposed`) and create a fresh schedule via
|
|
13246
|
-
* `create-schedule
|
|
13355
|
+
* `create-information-block` (`block_type='schedule'`).
|
|
13247
13356
|
*
|
|
13248
13357
|
* Omitted fields are left unchanged.
|
|
13249
13358
|
*/
|
|
@@ -13562,8 +13671,8 @@ export type ValidationLite = {
|
|
|
13562
13671
|
* Pass/fail/skip counts for one ``rule_category`` within a block's
|
|
13563
13672
|
* verification results.
|
|
13564
13673
|
*
|
|
13565
|
-
* Drives the per-category accordions in the Verification Results panel
|
|
13566
|
-
*
|
|
13674
|
+
* Drives the per-category accordions in the Verification Results panel.
|
|
13675
|
+
* ``category`` is the rule's ``rule_category``
|
|
13567
13676
|
* (one of the cm:VerificationRule subclasses), resolved by joining each
|
|
13568
13677
|
* result to its Rule.
|
|
13569
13678
|
*/
|
|
@@ -13651,7 +13760,7 @@ export type VerificationResultLite = {
|
|
|
13651
13760
|
* Server-computed aggregate of a block's ``verification_results``.
|
|
13652
13761
|
*
|
|
13653
13762
|
* Overall counts plus a per-``rule_category`` breakdown, so the viewer
|
|
13654
|
-
* renders the grouped Verification Results panel
|
|
13763
|
+
* renders the grouped Verification Results panel
|
|
13655
13764
|
* without a client-side results→rules join. Status closure is
|
|
13656
13765
|
* ``pass | fail | error | skipped`` (the ``public.verification_results``
|
|
13657
13766
|
* CHECK); ``total`` is their sum.
|
|
@@ -21863,6 +21972,70 @@ export type OpPromoteObligationsResponses = {
|
|
|
21863
21972
|
|
|
21864
21973
|
export type OpPromoteObligationsResponse = OpPromoteObligationsResponses[keyof OpPromoteObligationsResponses];
|
|
21865
21974
|
|
|
21975
|
+
export type OpRebuildScheduleData = {
|
|
21976
|
+
body: RebuildScheduleRequest;
|
|
21977
|
+
headers?: {
|
|
21978
|
+
/**
|
|
21979
|
+
* Idempotency-Key
|
|
21980
|
+
*/
|
|
21981
|
+
'Idempotency-Key'?: string | null;
|
|
21982
|
+
};
|
|
21983
|
+
path: {
|
|
21984
|
+
/**
|
|
21985
|
+
* Graph Id
|
|
21986
|
+
*/
|
|
21987
|
+
graph_id: string;
|
|
21988
|
+
};
|
|
21989
|
+
query?: never;
|
|
21990
|
+
url: '/extensions/roboledger/{graph_id}/operations/rebuild-schedule';
|
|
21991
|
+
};
|
|
21992
|
+
|
|
21993
|
+
export type OpRebuildScheduleErrors = {
|
|
21994
|
+
/**
|
|
21995
|
+
* Invalid request
|
|
21996
|
+
*/
|
|
21997
|
+
400: ErrorResponse;
|
|
21998
|
+
/**
|
|
21999
|
+
* Authentication required
|
|
22000
|
+
*/
|
|
22001
|
+
401: ErrorResponse;
|
|
22002
|
+
/**
|
|
22003
|
+
* Access denied
|
|
22004
|
+
*/
|
|
22005
|
+
403: ErrorResponse;
|
|
22006
|
+
/**
|
|
22007
|
+
* Resource not found
|
|
22008
|
+
*/
|
|
22009
|
+
404: ErrorResponse;
|
|
22010
|
+
/**
|
|
22011
|
+
* Idempotency-Key conflict — key reused with different body
|
|
22012
|
+
*/
|
|
22013
|
+
409: ErrorResponse;
|
|
22014
|
+
/**
|
|
22015
|
+
* Validation error
|
|
22016
|
+
*/
|
|
22017
|
+
422: ErrorResponse;
|
|
22018
|
+
/**
|
|
22019
|
+
* Rate limit exceeded
|
|
22020
|
+
*/
|
|
22021
|
+
429: ErrorResponse;
|
|
22022
|
+
/**
|
|
22023
|
+
* Internal server error
|
|
22024
|
+
*/
|
|
22025
|
+
500: ErrorResponse;
|
|
22026
|
+
};
|
|
22027
|
+
|
|
22028
|
+
export type OpRebuildScheduleError = OpRebuildScheduleErrors[keyof OpRebuildScheduleErrors];
|
|
22029
|
+
|
|
22030
|
+
export type OpRebuildScheduleResponses = {
|
|
22031
|
+
/**
|
|
22032
|
+
* Successful Response
|
|
22033
|
+
*/
|
|
22034
|
+
200: OperationEnvelopeScheduleCreatedResponse;
|
|
22035
|
+
};
|
|
22036
|
+
|
|
22037
|
+
export type OpRebuildScheduleResponse = OpRebuildScheduleResponses[keyof OpRebuildScheduleResponses];
|
|
22038
|
+
|
|
21866
22039
|
export type OpSetCloseTargetData = {
|
|
21867
22040
|
body: SetCloseTargetOperation;
|
|
21868
22041
|
headers?: {
|
|
@@ -22823,95 +22996,6 @@ export type OpLiveFinancialStatementResponses = {
|
|
|
22823
22996
|
|
|
22824
22997
|
export type OpLiveFinancialStatementResponse = OpLiveFinancialStatementResponses[keyof OpLiveFinancialStatementResponses];
|
|
22825
22998
|
|
|
22826
|
-
export type GetReportBundleDownloadUrlData = {
|
|
22827
|
-
body?: never;
|
|
22828
|
-
path: {
|
|
22829
|
-
/**
|
|
22830
|
-
* Graph Id
|
|
22831
|
-
*/
|
|
22832
|
-
graph_id: string;
|
|
22833
|
-
/**
|
|
22834
|
-
* Report Id
|
|
22835
|
-
*
|
|
22836
|
-
* Report identifier (rpt_-prefixed ULID).
|
|
22837
|
-
*/
|
|
22838
|
-
report_id: string;
|
|
22839
|
-
};
|
|
22840
|
-
query?: {
|
|
22841
|
-
/**
|
|
22842
|
-
* Format
|
|
22843
|
-
*
|
|
22844
|
-
* Serialization flavor. ``jsonld`` returns a presigned URL to the stored JSON-LD bundle; ``xbrl-2.1`` streams a freshly-emitted XBRL zip directly. Other RDF / XBRL flavors slot in as their producers ship.
|
|
22845
|
-
*/
|
|
22846
|
-
format?: string;
|
|
22847
|
-
/**
|
|
22848
|
-
* Expires In
|
|
22849
|
-
*
|
|
22850
|
-
* Presigned URL lifetime in seconds (min 60, max 3600). Ignored for XBRL flavors (streamed directly, no URL).
|
|
22851
|
-
*/
|
|
22852
|
-
expires_in?: number;
|
|
22853
|
-
};
|
|
22854
|
-
url: '/extensions/roboledger/{graph_id}/reports/{report_id}/download';
|
|
22855
|
-
};
|
|
22856
|
-
|
|
22857
|
-
export type GetReportBundleDownloadUrlErrors = {
|
|
22858
|
-
/**
|
|
22859
|
-
* Validation Error
|
|
22860
|
-
*/
|
|
22861
|
-
422: HttpValidationError;
|
|
22862
|
-
};
|
|
22863
|
-
|
|
22864
|
-
export type GetReportBundleDownloadUrlError = GetReportBundleDownloadUrlErrors[keyof GetReportBundleDownloadUrlErrors];
|
|
22865
|
-
|
|
22866
|
-
export type GetReportBundleDownloadUrlResponses = {
|
|
22867
|
-
/**
|
|
22868
|
-
* ReportBundleDownloadResponse
|
|
22869
|
-
*
|
|
22870
|
-
* Presigned-URL response for a Report bundle download.
|
|
22871
|
-
*
|
|
22872
|
-
* Mirrors :class:`BackupDownloadUrlResponse` in shape — the frontend
|
|
22873
|
-
* treats both the same way (fetch, follow URL, GET the artifact).
|
|
22874
|
-
*
|
|
22875
|
-
* Only returned for RDF-family flavors (JSON-LD) where the artifact
|
|
22876
|
-
* is stored in S3. XBRL flavors stream the binary content directly
|
|
22877
|
-
* in the response body (no JSON wrapper).
|
|
22878
|
-
*/
|
|
22879
|
-
200: {
|
|
22880
|
-
/**
|
|
22881
|
-
* Download Url
|
|
22882
|
-
*
|
|
22883
|
-
* Presigned URL that streams the bundle directly from S3.
|
|
22884
|
-
*/
|
|
22885
|
-
download_url: string;
|
|
22886
|
-
/**
|
|
22887
|
-
* Expires At
|
|
22888
|
-
*
|
|
22889
|
-
* UTC timestamp at which the presigned URL stops working.
|
|
22890
|
-
*/
|
|
22891
|
-
expires_at: string;
|
|
22892
|
-
/**
|
|
22893
|
-
* Content Type
|
|
22894
|
-
*
|
|
22895
|
-
* MIME type of the artifact behind the URL.
|
|
22896
|
-
*/
|
|
22897
|
-
content_type: string;
|
|
22898
|
-
/**
|
|
22899
|
-
* Format
|
|
22900
|
-
*
|
|
22901
|
-
* Serialization flavor delivered by this URL — matches the ``format`` query parameter.
|
|
22902
|
-
*/
|
|
22903
|
-
format: string;
|
|
22904
|
-
/**
|
|
22905
|
-
* Generation Count
|
|
22906
|
-
*
|
|
22907
|
-
* Bundle generation number stamped on the Report.
|
|
22908
|
-
*/
|
|
22909
|
-
generation_count: number;
|
|
22910
|
-
};
|
|
22911
|
-
};
|
|
22912
|
-
|
|
22913
|
-
export type GetReportBundleDownloadUrlResponse = GetReportBundleDownloadUrlResponses[keyof GetReportBundleDownloadUrlResponses];
|
|
22914
|
-
|
|
22915
22999
|
export type OpBuildFactGridData = {
|
|
22916
23000
|
body: CreateViewRequest;
|
|
22917
23001
|
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 { AutoSelectOperatorData, AutoSelectOperatorErrors, AutoSelectOperatorResponses, BatchProcessQueriesData, BatchProcessQueriesErrors, BatchProcessQueriesResponses, CallMcpToolData, CallMcpToolErrors, CallMcpToolResponses, CancelOperationData, CancelOperationErrors, CancelOperationResponses, CancelOrgSubscriptionData, CancelOrgSubscriptionErrors, CancelOrgSubscriptionResponses, CancelRepositorySubscriptionData, CancelRepositorySubscriptionErrors, CancelRepositorySubscriptionResponses, ChangeSubscriptionPlanData, ChangeSubscriptionPlanErrors, ChangeSubscriptionPlanResponses, CheckPasswordStrengthData, CheckPasswordStrengthErrors, CheckPasswordStrengthResponses, CompleteSsoAuthData, CompleteSsoAuthErrors, CompleteSsoAuthResponses, CreateCheckoutSessionData, CreateCheckoutSessionErrors, CreateCheckoutSessionResponses, CreateConnectionData, CreateConnectionErrors, CreateConnectionResponses, CreateFileUploadData, CreateFileUploadErrors, CreateFileUploadResponses, CreateGraphData, CreateGraphErrors, CreateGraphResponses, CreatePortalSessionData, CreatePortalSessionErrors, CreatePortalSessionResponses, CreateRepositorySubscriptionData, CreateRepositorySubscriptionErrors, CreateRepositorySubscriptionResponses, CreateUserApiKeyData, CreateUserApiKeyErrors, CreateUserApiKeyResponses, DeleteConnectionData, DeleteConnectionErrors, DeleteConnectionResponses, DeleteDocumentData, DeleteDocumentErrors, DeleteDocumentResponses, DeleteFileData, DeleteFileErrors, DeleteFileResponses, ExecuteCypherQueryData, ExecuteCypherQueryErrors, ExecuteCypherQueryResponses, ExecuteSpecificOperatorData, ExecuteSpecificOperatorErrors, ExecuteSpecificOperatorResponses, ExportGraphSchemaData, ExportGraphSchemaErrors, ExportGraphSchemaResponses, 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, 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, GetReportBundleDownloadUrlData, GetReportBundleDownloadUrlErrors, GetReportBundleDownloadUrlResponses, GetServiceOfferingsData, GetServiceOfferingsErrors, GetServiceOfferingsResponses, GetServiceStatusData, GetServiceStatusResponses, GetSubgraphInfoData, GetSubgraphInfoErrors, GetSubgraphInfoResponses, GetSubgraphQuotaData, GetSubgraphQuotaErrors, GetSubgraphQuotaResponses, HandleHttpGetExtensionsGraphIdGraphqlGetData, HandleHttpGetExtensionsGraphIdGraphqlGetErrors, HandleHttpGetExtensionsGraphIdGraphqlGetResponses, HandleHttpPostExtensionsGraphIdGraphqlPostData, HandleHttpPostExtensionsGraphIdGraphqlPostErrors, HandleHttpPostExtensionsGraphIdGraphqlPostResponses, InitOAuthData, InitOAuthErrors, InitOAuthResponses, InviteOrgMemberData, InviteOrgMemberErrors, InviteOrgMemberResponses, ListBackupsData, ListBackupsErrors, ListBackupsResponses, ListConnectionsData, ListConnectionsErrors, ListConnectionsResponses, ListCreditTransactionsData, ListCreditTransactionsErrors, ListCreditTransactionsResponses, ListDocumentsData, ListDocumentsErrors, ListDocumentsResponses, ListFilesData, ListFilesErrors, ListFilesResponses, ListMcpToolsData, ListMcpToolsErrors, ListMcpToolsResponses, 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, LoginUserData, LoginUserErrors, LoginUserResponses, LogoutUserData, LogoutUserErrors, LogoutUserResponses, OauthCallbackData, OauthCallbackErrors, OauthCallbackResponses, OpAddPublishListMembersData, OpAddPublishListMembersErrors, OpAddPublishListMembersResponses, OpAutoMapElementsData, OpAutoMapElementsErrors, OpAutoMapElementsResponses, OpBuildFactGridData, OpBuildFactGridErrors, OpBuildFactGridResponses, OpChangeReportingStyleData, OpChangeReportingStyleErrors, OpChangeReportingStyleResponses, OpChangeTierData, OpChangeTierErrors, OpChangeTierResponses, OpClosePeriodData, OpClosePeriodErrors, OpClosePeriodResponses, OpCreateAgentData, OpCreateAgentErrors, OpCreateAgentResponses, OpCreateBackupData, OpCreateBackupErrors, OpCreateBackupResponses, OpCreateEventBlockData, OpCreateEventBlockErrors, OpCreateEventBlockResponses, OpCreateEventHandlerData, OpCreateEventHandlerErrors, OpCreateEventHandlerResponses, OpCreateInformationBlockData, OpCreateInformationBlockErrors, OpCreateInformationBlockResponses, OpCreateMappingAssociationData, OpCreateMappingAssociationErrors, OpCreateMappingAssociationResponses, OpCreatePortfolioBlockData, OpCreatePortfolioBlockErrors, OpCreatePortfolioBlockResponses, OpCreatePublishListData, OpCreatePublishListErrors, OpCreatePublishListResponses, OpCreateReportData, OpCreateReportErrors, OpCreateReportResponses, OpCreateSecurityData, OpCreateSecurityErrors, OpCreateSecurityResponses, OpCreateSubgraphData, OpCreateSubgraphErrors, OpCreateSubgraphResponses, OpCreateTaxonomyBlockData, OpCreateTaxonomyBlockErrors, OpCreateTaxonomyBlockResponses, OpDeleteGraphData, OpDeleteGraphErrors, OpDeleteGraphResponses, OpDeleteInformationBlockData, OpDeleteInformationBlockErrors, OpDeleteInformationBlockResponses, OpDeleteJournalEntryData, OpDeleteJournalEntryErrors, OpDeleteJournalEntryResponses, OpDeleteMappingAssociationData, OpDeleteMappingAssociationErrors, OpDeleteMappingAssociationResponses, OpDeletePortfolioBlockData, OpDeletePortfolioBlockErrors, OpDeletePortfolioBlockResponses, OpDeletePublishListData, OpDeletePublishListErrors, OpDeletePublishListResponses, OpDeleteReportData, OpDeleteReportErrors, OpDeleteReportResponses, OpDeleteSecurityData, OpDeleteSecurityErrors, OpDeleteSecurityResponses, OpDeleteSubgraphData, OpDeleteSubgraphErrors, OpDeleteSubgraphResponses, OpDeleteTaxonomyBlockData, OpDeleteTaxonomyBlockErrors, OpDeleteTaxonomyBlockResponses, OpEvaluateRulesData, OpEvaluateRulesErrors, OpEvaluateRulesResponses, OpExecuteEventBlockData, OpExecuteEventBlockErrors, OpExecuteEventBlockResponses, OpFileReportData, OpFileReportErrors, OpFileReportResponses, OpFinancialStatementAnalysisData, OpFinancialStatementAnalysisErrors, OpFinancialStatementAnalysisResponses, OpInitializeLedgerData, OpInitializeLedgerErrors, OpInitializeLedgerResponses, OpLinkEntityTaxonomyData, OpLinkEntityTaxonomyErrors, OpLinkEntityTaxonomyResponses, OpLiveFinancialStatementData, OpLiveFinancialStatementErrors, OpLiveFinancialStatementResponses, OpMaterializeData, OpMaterializeErrors, OpMaterializeResponses, OpPreviewEventBlockData, OpPreviewEventBlockErrors, OpPreviewEventBlockResponses, OpPromoteObligationsData, OpPromoteObligationsErrors, OpPromoteObligationsResponses, OpRegenerateReportData, OpRegenerateReportErrors, OpRegenerateReportResponses, OpRemovePublishListMemberData, OpRemovePublishListMemberErrors, OpRemovePublishListMemberResponses, OpReopenPeriodData, OpReopenPeriodErrors, OpReopenPeriodResponses, OpRestoreBackupData, OpRestoreBackupErrors, OpRestoreBackupResponses, OpSetCloseTargetData, OpSetCloseTargetErrors, OpSetCloseTargetResponses, OpShareReportData, OpShareReportErrors, OpShareReportResponses, OpTransitionFilingStatusData, OpTransitionFilingStatusErrors, OpTransitionFilingStatusResponses, OpUpdateAgentData, OpUpdateAgentErrors, OpUpdateAgentResponses, OpUpdateEntityData, OpUpdateEntityErrors, OpUpdateEntityResponses, OpUpdateEventBlockData, OpUpdateEventBlockErrors, OpUpdateEventBlockResponses, OpUpdateEventHandlerData, OpUpdateEventHandlerErrors, OpUpdateEventHandlerResponses, OpUpdateInformationBlockData, OpUpdateInformationBlockErrors, OpUpdateInformationBlockResponses, OpUpdateJournalEntryData, OpUpdateJournalEntryErrors, OpUpdateJournalEntryResponses, OpUpdatePortfolioBlockData, OpUpdatePortfolioBlockErrors, OpUpdatePortfolioBlockResponses, OpUpdatePublishListData, OpUpdatePublishListErrors, OpUpdatePublishListResponses, OpUpdateSecurityData, OpUpdateSecurityErrors, OpUpdateSecurityResponses, OpUpdateTaxonomyBlockData, OpUpdateTaxonomyBlockErrors, OpUpdateTaxonomyBlockResponses, QueryTablesData, QueryTablesErrors, QueryTablesResponses, RecommendOperatorData, RecommendOperatorErrors, RecommendOperatorResponses, RefreshAuthSessionData, RefreshAuthSessionErrors, RefreshAuthSessionResponses, RegisterUserData, RegisterUserErrors, RegisterUserResponses, RemoveOrgMemberData, RemoveOrgMemberErrors, RemoveOrgMemberResponses, ResendVerificationEmailData, ResendVerificationEmailErrors, ResendVerificationEmailResponses, ResetPasswordData, ResetPasswordErrors, ResetPasswordResponses, RevokeUserApiKeyData, RevokeUserApiKeyErrors, RevokeUserApiKeyResponses, SearchDocumentsData, SearchDocumentsErrors, SearchDocumentsResponses, SelectGraphData, SelectGraphErrors, SelectGraphResponses, SetConnectionWritePolicyData, SetConnectionWritePolicyErrors, SetConnectionWritePolicyResponses, SsoTokenExchangeData, SsoTokenExchangeErrors, SsoTokenExchangeResponses, StreamOperationEventsData, StreamOperationEventsErrors, StreamOperationEventsResponses, SyncConnectionData, SyncConnectionErrors, SyncConnectionResponses, UpdateDocumentData, UpdateDocumentErrors, UpdateDocumentResponses, UpdateFileData, UpdateFileErrors, UpdateFileResponses, UpdateOrgData, UpdateOrgErrors, UpdateOrgMemberRoleData, UpdateOrgMemberRoleErrors, UpdateOrgMemberRoleResponses, UpdateOrgResponses, UpdateUserApiKeyData, UpdateUserApiKeyErrors, UpdateUserApiKeyResponses, UpdateUserData, UpdateUserErrors, UpdateUserPasswordData, UpdateUserPasswordErrors, UpdateUserPasswordResponses, UpdateUserResponses, UploadDocumentData, UploadDocumentErrors, UploadDocumentResponses, ValidateResetTokenData, ValidateResetTokenErrors, ValidateResetTokenResponses, ValidateSchemaData, ValidateSchemaErrors, ValidateSchemaResponses, VerifyEmailData, VerifyEmailErrors, VerifyEmailResponses } from './types.gen';
|
|
2
|
+
import type { AutoSelectOperatorData, AutoSelectOperatorErrors, AutoSelectOperatorResponses, BatchProcessQueriesData, BatchProcessQueriesErrors, BatchProcessQueriesResponses, CallMcpToolData, CallMcpToolErrors, CallMcpToolResponses, CancelOperationData, CancelOperationErrors, CancelOperationResponses, CancelOrgSubscriptionData, CancelOrgSubscriptionErrors, CancelOrgSubscriptionResponses, CancelRepositorySubscriptionData, CancelRepositorySubscriptionErrors, CancelRepositorySubscriptionResponses, ChangeSubscriptionPlanData, ChangeSubscriptionPlanErrors, ChangeSubscriptionPlanResponses, CheckPasswordStrengthData, CheckPasswordStrengthErrors, CheckPasswordStrengthResponses, CompleteSsoAuthData, CompleteSsoAuthErrors, CompleteSsoAuthResponses, CreateCheckoutSessionData, CreateCheckoutSessionErrors, CreateCheckoutSessionResponses, CreateConnectionData, CreateConnectionErrors, CreateConnectionResponses, CreateFileUploadData, CreateFileUploadErrors, CreateFileUploadResponses, CreateGraphData, CreateGraphErrors, CreateGraphResponses, CreatePortalSessionData, CreatePortalSessionErrors, CreatePortalSessionResponses, CreateRepositorySubscriptionData, CreateRepositorySubscriptionErrors, CreateRepositorySubscriptionResponses, CreateUserApiKeyData, CreateUserApiKeyErrors, CreateUserApiKeyResponses, DeleteConnectionData, DeleteConnectionErrors, DeleteConnectionResponses, DeleteDocumentData, DeleteDocumentErrors, DeleteDocumentResponses, DeleteFileData, DeleteFileErrors, DeleteFileResponses, ExecuteCypherQueryData, ExecuteCypherQueryErrors, ExecuteCypherQueryResponses, ExecuteSpecificOperatorData, ExecuteSpecificOperatorErrors, ExecuteSpecificOperatorResponses, ExportGraphSchemaData, ExportGraphSchemaErrors, ExportGraphSchemaResponses, 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, 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, InitOAuthData, InitOAuthErrors, InitOAuthResponses, InviteOrgMemberData, InviteOrgMemberErrors, InviteOrgMemberResponses, ListBackupsData, ListBackupsErrors, ListBackupsResponses, ListConnectionsData, ListConnectionsErrors, ListConnectionsResponses, ListCreditTransactionsData, ListCreditTransactionsErrors, ListCreditTransactionsResponses, ListDocumentsData, ListDocumentsErrors, ListDocumentsResponses, ListFilesData, ListFilesErrors, ListFilesResponses, ListMcpToolsData, ListMcpToolsErrors, ListMcpToolsResponses, 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, LoginUserData, LoginUserErrors, LoginUserResponses, LogoutUserData, LogoutUserErrors, LogoutUserResponses, OauthCallbackData, OauthCallbackErrors, OauthCallbackResponses, OpAddPublishListMembersData, OpAddPublishListMembersErrors, OpAddPublishListMembersResponses, OpAutoMapElementsData, OpAutoMapElementsErrors, OpAutoMapElementsResponses, OpBuildFactGridData, OpBuildFactGridErrors, OpBuildFactGridResponses, OpChangeReportingStyleData, OpChangeReportingStyleErrors, OpChangeReportingStyleResponses, OpChangeTierData, OpChangeTierErrors, OpChangeTierResponses, OpClosePeriodData, OpClosePeriodErrors, OpClosePeriodResponses, OpCreateAgentData, OpCreateAgentErrors, OpCreateAgentResponses, OpCreateBackupData, OpCreateBackupErrors, OpCreateBackupResponses, OpCreateEventBlockData, OpCreateEventBlockErrors, OpCreateEventBlockResponses, OpCreateEventHandlerData, OpCreateEventHandlerErrors, OpCreateEventHandlerResponses, OpCreateInformationBlockData, OpCreateInformationBlockErrors, OpCreateInformationBlockResponses, OpCreateMappingAssociationData, OpCreateMappingAssociationErrors, OpCreateMappingAssociationResponses, OpCreatePortfolioBlockData, OpCreatePortfolioBlockErrors, OpCreatePortfolioBlockResponses, OpCreatePublishListData, OpCreatePublishListErrors, OpCreatePublishListResponses, OpCreateReportData, OpCreateReportErrors, OpCreateReportResponses, OpCreateSecurityData, OpCreateSecurityErrors, OpCreateSecurityResponses, OpCreateSubgraphData, OpCreateSubgraphErrors, OpCreateSubgraphResponses, OpCreateTaxonomyBlockData, OpCreateTaxonomyBlockErrors, OpCreateTaxonomyBlockResponses, OpDeleteGraphData, OpDeleteGraphErrors, OpDeleteGraphResponses, OpDeleteInformationBlockData, OpDeleteInformationBlockErrors, OpDeleteInformationBlockResponses, OpDeleteJournalEntryData, OpDeleteJournalEntryErrors, OpDeleteJournalEntryResponses, OpDeleteMappingAssociationData, OpDeleteMappingAssociationErrors, OpDeleteMappingAssociationResponses, OpDeletePortfolioBlockData, OpDeletePortfolioBlockErrors, OpDeletePortfolioBlockResponses, OpDeletePublishListData, OpDeletePublishListErrors, OpDeletePublishListResponses, OpDeleteReportData, OpDeleteReportErrors, OpDeleteReportResponses, OpDeleteSecurityData, OpDeleteSecurityErrors, OpDeleteSecurityResponses, OpDeleteSubgraphData, OpDeleteSubgraphErrors, OpDeleteSubgraphResponses, OpDeleteTaxonomyBlockData, OpDeleteTaxonomyBlockErrors, OpDeleteTaxonomyBlockResponses, OpEvaluateRulesData, OpEvaluateRulesErrors, OpEvaluateRulesResponses, OpExecuteEventBlockData, OpExecuteEventBlockErrors, OpExecuteEventBlockResponses, OpFileReportData, OpFileReportErrors, OpFileReportResponses, OpFinancialStatementAnalysisData, OpFinancialStatementAnalysisErrors, OpFinancialStatementAnalysisResponses, OpInitializeLedgerData, OpInitializeLedgerErrors, OpInitializeLedgerResponses, OpLinkEntityTaxonomyData, OpLinkEntityTaxonomyErrors, OpLinkEntityTaxonomyResponses, OpLiveFinancialStatementData, OpLiveFinancialStatementErrors, OpLiveFinancialStatementResponses, OpMaterializeData, OpMaterializeErrors, OpMaterializeResponses, OpPreviewEventBlockData, OpPreviewEventBlockErrors, OpPreviewEventBlockResponses, OpPromoteObligationsData, OpPromoteObligationsErrors, OpPromoteObligationsResponses, OpRebuildScheduleData, OpRebuildScheduleErrors, OpRebuildScheduleResponses, OpRegenerateReportData, OpRegenerateReportErrors, OpRegenerateReportResponses, OpRemovePublishListMemberData, OpRemovePublishListMemberErrors, OpRemovePublishListMemberResponses, OpReopenPeriodData, OpReopenPeriodErrors, OpReopenPeriodResponses, OpRestoreBackupData, OpRestoreBackupErrors, OpRestoreBackupResponses, OpSetCloseTargetData, OpSetCloseTargetErrors, OpSetCloseTargetResponses, OpShareReportData, OpShareReportErrors, OpShareReportResponses, OpTransitionFilingStatusData, OpTransitionFilingStatusErrors, OpTransitionFilingStatusResponses, OpUpdateAgentData, OpUpdateAgentErrors, OpUpdateAgentResponses, OpUpdateEntityData, OpUpdateEntityErrors, OpUpdateEntityResponses, OpUpdateEventBlockData, OpUpdateEventBlockErrors, OpUpdateEventBlockResponses, OpUpdateEventHandlerData, OpUpdateEventHandlerErrors, OpUpdateEventHandlerResponses, OpUpdateInformationBlockData, OpUpdateInformationBlockErrors, OpUpdateInformationBlockResponses, OpUpdateJournalEntryData, OpUpdateJournalEntryErrors, OpUpdateJournalEntryResponses, OpUpdatePortfolioBlockData, OpUpdatePortfolioBlockErrors, OpUpdatePortfolioBlockResponses, OpUpdatePublishListData, OpUpdatePublishListErrors, OpUpdatePublishListResponses, OpUpdateSecurityData, OpUpdateSecurityErrors, OpUpdateSecurityResponses, OpUpdateTaxonomyBlockData, OpUpdateTaxonomyBlockErrors, OpUpdateTaxonomyBlockResponses, QueryTablesData, QueryTablesErrors, QueryTablesResponses, RecommendOperatorData, RecommendOperatorErrors, RecommendOperatorResponses, RefreshAuthSessionData, RefreshAuthSessionErrors, RefreshAuthSessionResponses, RegisterUserData, RegisterUserErrors, RegisterUserResponses, RemoveOrgMemberData, RemoveOrgMemberErrors, RemoveOrgMemberResponses, ResendVerificationEmailData, ResendVerificationEmailErrors, ResendVerificationEmailResponses, ResetPasswordData, ResetPasswordErrors, ResetPasswordResponses, RevokeUserApiKeyData, RevokeUserApiKeyErrors, RevokeUserApiKeyResponses, SearchDocumentsData, SearchDocumentsErrors, SearchDocumentsResponses, SelectGraphData, SelectGraphErrors, SelectGraphResponses, SetConnectionWritePolicyData, SetConnectionWritePolicyErrors, SetConnectionWritePolicyResponses, SsoTokenExchangeData, SsoTokenExchangeErrors, SsoTokenExchangeResponses, StreamOperationEventsData, StreamOperationEventsErrors, StreamOperationEventsResponses, SyncConnectionData, SyncConnectionErrors, SyncConnectionResponses, UpdateDocumentData, UpdateDocumentErrors, UpdateDocumentResponses, UpdateFileData, UpdateFileErrors, UpdateFileResponses, UpdateOrgData, UpdateOrgErrors, UpdateOrgMemberRoleData, UpdateOrgMemberRoleErrors, UpdateOrgMemberRoleResponses, UpdateOrgResponses, UpdateUserApiKeyData, UpdateUserApiKeyErrors, UpdateUserApiKeyResponses, UpdateUserData, UpdateUserErrors, UpdateUserPasswordData, UpdateUserPasswordErrors, UpdateUserPasswordResponses, UpdateUserResponses, UploadDocumentData, UploadDocumentErrors, UploadDocumentResponses, 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> = Options2<TData, ThrowOnError> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -492,7 +492,7 @@ export declare const opChangeTier: <ThrowOnError extends boolean = false>(option
|
|
|
492
492
|
/**
|
|
493
493
|
* Change Reporting Style
|
|
494
494
|
*
|
|
495
|
-
* Switches the graph's Reporting Style
|
|
495
|
+
* Switches the graph's Reporting Style. Synchronous: validates the target Style has a complete composition in the tenant schema, then updates `graphs.reporting_style_id`. Filed Reports are unaffected; new reports use the new Style. Idempotent on the same id.
|
|
496
496
|
*
|
|
497
497
|
* **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.
|
|
498
498
|
*/
|
|
@@ -676,7 +676,7 @@ export declare const opUpdateEntity: <ThrowOnError extends boolean = false>(opti
|
|
|
676
676
|
/**
|
|
677
677
|
* Create Taxonomy Block
|
|
678
678
|
*
|
|
679
|
-
* Create a taxonomy block atomically: one envelope carrying the taxonomy row plus its structures, elements, associations, and rules. Dispatches by `taxonomy_type` — `chart_of_accounts` (declarative tenant CoA) is
|
|
679
|
+
* Create a taxonomy block atomically: one envelope carrying the taxonomy row plus its structures, elements, associations, and rules. Dispatches by `taxonomy_type` — `chart_of_accounts` (declarative tenant CoA) is supported; `reporting_extension` / `custom_ontology` / `reporting_standard` are not yet implemented. NOT the path for a functional close schedule: a structure with block_type='schedule' here is a bare ontology row with none of the schedule machinery (per-period facts, schedule_entry_due obligations, closing-entry generator). To create a working schedule use create-information-block(block_type='schedule').
|
|
680
680
|
*
|
|
681
681
|
* **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.
|
|
682
682
|
*/
|
|
@@ -732,7 +732,7 @@ export declare const opAutoMapElements: <ThrowOnError extends boolean = false>(o
|
|
|
732
732
|
/**
|
|
733
733
|
* Create Information Block
|
|
734
734
|
*
|
|
735
|
-
* Generic Information Block construction entry. `block_type` selects the registered block type; `payload` is validated against that type's creation schema at dispatch. Schedule dispatches to the existing Schedule machinery; statement block types raise 501 (use create-report instead).
|
|
735
|
+
* Generic Information Block construction entry. `block_type` selects the registered block type; `payload` is validated against that type's creation schema at dispatch. Schedule dispatches to the existing Schedule machinery; statement block types raise 501 (use create-report instead). Authoring schedules for a close? Call `get-close-playbook` (mode='initiate') first — one schedule is a single debit/credit element pair, so multi-line entries become multiple schedules, and element ids must be real (discover via get-graph-schema / get-unmapped-elements / suggest-mapping).
|
|
736
736
|
*
|
|
737
737
|
* **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.
|
|
738
738
|
*/
|
|
@@ -756,7 +756,7 @@ export declare const opDeleteInformationBlock: <ThrowOnError extends boolean = f
|
|
|
756
756
|
/**
|
|
757
757
|
* Evaluate Rules for an Information Block
|
|
758
758
|
*
|
|
759
|
-
* Runs every rule targeting the given structure (plus element- and association-scoped rules for the structure's atoms), binds $Variable references to in-scope facts via qname lookup, writes one VerificationResult row per rule, and returns the results plus a status-keyed summary.
|
|
759
|
+
* Runs every rule targeting the given structure (plus element- and association-scoped rules for the structure's atoms), binds $Variable references to in-scope facts via qname lookup, writes one VerificationResult row per rule, and returns the results plus a status-keyed summary. Decoding mode, 5 patterns (EqualTo, RollUp, RollForward, Exists, CoExists).
|
|
760
760
|
*
|
|
761
761
|
* **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.
|
|
762
762
|
*/
|
|
@@ -849,6 +849,14 @@ export declare const opDeleteJournalEntry: <ThrowOnError extends boolean = false
|
|
|
849
849
|
* **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.
|
|
850
850
|
*/
|
|
851
851
|
export declare const opPromoteObligations: <ThrowOnError extends boolean = false>(options: Options<OpPromoteObligationsData, ThrowOnError>) => import("./client").RequestResult<OpPromoteObligationsResponses, OpPromoteObligationsErrors, ThrowOnError, "fields">;
|
|
852
|
+
/**
|
|
853
|
+
* Rebuild Schedule In Place
|
|
854
|
+
*
|
|
855
|
+
* Re-run the schedule generator in place on an existing schedule. Atomic alternative to delete-then-recreate (which orphans pending obligations): preserves the structure id + element associations + taxonomy, voids the old pending obligation chain, deletes the old facts and SumEquals rules, and regenerates fresh forward facts + a fresh obligation chain from the schedule's stored definition (entry_template / schedule_metadata / monthly_amount / period bounds). The historical-vs-in-scope split is re-derived from the CURRENT fiscal calendar closed_through. Use this to pick up a fixed generator (e.g. the roll-forward direction fix) without orphaning obligations.
|
|
856
|
+
*
|
|
857
|
+
* **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.
|
|
858
|
+
*/
|
|
859
|
+
export declare const opRebuildSchedule: <ThrowOnError extends boolean = false>(options: Options<OpRebuildScheduleData, ThrowOnError>) => import("./client").RequestResult<OpRebuildScheduleResponses, OpRebuildScheduleErrors, ThrowOnError, "fields">;
|
|
852
860
|
/**
|
|
853
861
|
* Set Close Target
|
|
854
862
|
*
|
|
@@ -969,12 +977,6 @@ export declare const opRemovePublishListMember: <ThrowOnError extends boolean =
|
|
|
969
977
|
* **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.
|
|
970
978
|
*/
|
|
971
979
|
export declare const opLiveFinancialStatement: <ThrowOnError extends boolean = false>(options: Options<OpLiveFinancialStatementData, ThrowOnError>) => import("./client").RequestResult<OpLiveFinancialStatementResponses, OpLiveFinancialStatementErrors, ThrowOnError, "fields">;
|
|
972
|
-
/**
|
|
973
|
-
* Download Report bundle
|
|
974
|
-
*
|
|
975
|
-
* Return the published Report's serialization bundle. ``format=jsonld`` (default) returns a JSON envelope containing a short-lived presigned URL to the stamped JSON-LD bundle in S3. ``format=xbrl-2.1`` rebuilds the bundle on-demand and streams an XBRL 2.1 zip directly. 404 when the Report has no stamped bundle (published before the serialization feature shipped — JSON-LD only).
|
|
976
|
-
*/
|
|
977
|
-
export declare const getReportBundleDownloadUrl: <ThrowOnError extends boolean = false>(options: Options<GetReportBundleDownloadUrlData, ThrowOnError>) => import("./client").RequestResult<GetReportBundleDownloadUrlResponses, GetReportBundleDownloadUrlErrors, ThrowOnError, "fields">;
|
|
978
980
|
/**
|
|
979
981
|
* Build Fact Grid
|
|
980
982
|
*
|