@robosystems/client 0.3.39 → 0.3.40
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 +19 -41
- package/artifacts/LedgerClient.js +29 -102
- package/artifacts/LedgerClient.ts +40 -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 -4
- package/sdk/index.ts +2 -2
- package/sdk/sdk.gen.d.ts +5 -11
- package/sdk/sdk.gen.js +5 -16
- package/sdk/sdk.gen.ts +5 -16
- package/sdk/types.gen.d.ts +22 -109
- package/sdk/types.gen.ts +22 -114
- package/sdk.gen.d.ts +5 -11
- package/sdk.gen.js +5 -16
- package/sdk.gen.ts +5 -16
- package/types.gen.d.ts +22 -109
- package/types.gen.ts +22 -114
package/sdk/types.gen.d.ts
CHANGED
|
@@ -738,7 +738,7 @@ export type CancelSubscriptionRequest = {
|
|
|
738
738
|
/**
|
|
739
739
|
* ChangeReportingStyleOp
|
|
740
740
|
*
|
|
741
|
-
* Body for the change-reporting-style operation
|
|
741
|
+
* Body for the change-reporting-style operation.
|
|
742
742
|
*
|
|
743
743
|
* Switches the graph to a different Reporting Style. The target Style
|
|
744
744
|
* must be a library- or customer-authored Structure with
|
|
@@ -949,7 +949,7 @@ export type ClosePeriodResponse = {
|
|
|
949
949
|
/**
|
|
950
950
|
* Rule Summary
|
|
951
951
|
*
|
|
952
|
-
* 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 (
|
|
952
|
+
* 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).
|
|
953
953
|
*/
|
|
954
954
|
rule_summary?: {
|
|
955
955
|
[key: string]: number;
|
|
@@ -1964,7 +1964,7 @@ export type CreateScheduleRequest = {
|
|
|
1964
1964
|
/**
|
|
1965
1965
|
* Element Ids
|
|
1966
1966
|
*
|
|
1967
|
-
*
|
|
1967
|
+
* 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.
|
|
1968
1968
|
*/
|
|
1969
1969
|
element_ids: Array<string>;
|
|
1970
1970
|
/**
|
|
@@ -1990,7 +1990,7 @@ export type CreateScheduleRequest = {
|
|
|
1990
1990
|
/**
|
|
1991
1991
|
* Closed Through
|
|
1992
1992
|
*
|
|
1993
|
-
*
|
|
1993
|
+
* 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.
|
|
1994
1994
|
*/
|
|
1995
1995
|
closed_through?: string | null;
|
|
1996
1996
|
/**
|
|
@@ -3657,13 +3657,13 @@ export type EntryTemplateRequest = {
|
|
|
3657
3657
|
/**
|
|
3658
3658
|
* Debit Element Id
|
|
3659
3659
|
*
|
|
3660
|
-
*
|
|
3660
|
+
* 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.
|
|
3661
3661
|
*/
|
|
3662
3662
|
debit_element_id: string;
|
|
3663
3663
|
/**
|
|
3664
3664
|
* Credit Element Id
|
|
3665
3665
|
*
|
|
3666
|
-
*
|
|
3666
|
+
* 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.
|
|
3667
3667
|
*/
|
|
3668
3668
|
credit_element_id: string;
|
|
3669
3669
|
/**
|
|
@@ -6388,7 +6388,7 @@ export type ListSubgraphsResponse = {
|
|
|
6388
6388
|
/**
|
|
6389
6389
|
* Subgraphs Enabled
|
|
6390
6390
|
*
|
|
6391
|
-
* Whether subgraphs are enabled for this tier (requires
|
|
6391
|
+
* Whether subgraphs are enabled for this tier (requires Large/XLarge tier)
|
|
6392
6392
|
*/
|
|
6393
6393
|
subgraphs_enabled: boolean;
|
|
6394
6394
|
/**
|
|
@@ -10093,18 +10093,17 @@ export type RestoreBackupOp = {
|
|
|
10093
10093
|
*
|
|
10094
10094
|
* Filter-based attribution mechanics for ``block_type='rollforward'``.
|
|
10095
10095
|
*
|
|
10096
|
-
*
|
|
10097
|
-
*
|
|
10098
|
-
*
|
|
10099
|
-
*
|
|
10100
|
-
*
|
|
10101
|
-
*
|
|
10102
|
-
* any residual against the default change tag (Tier 1 fallback).
|
|
10096
|
+
* Filter-based attribution: each block decomposes one BS source
|
|
10097
|
+
* element's period delta into a list of flow concepts via declared
|
|
10098
|
+
* :class:`AttributionFilter` predicates. The renderer evaluates the
|
|
10099
|
+
* filters against ledger LineItems at envelope-build time, emits one
|
|
10100
|
+
* attributed fact per filter per period, and arbitrates any residual
|
|
10101
|
+
* against the default change tag fallback.
|
|
10103
10102
|
*
|
|
10104
10103
|
* Reads directly from the typed ``structures.artifact_mechanics`` JSONB
|
|
10105
10104
|
* column. ``attribution_filters`` rides as nested JSON; the predicate
|
|
10106
|
-
* union widens as new predicate shapes
|
|
10107
|
-
* ``line_item_metadata_field``
|
|
10105
|
+
* union widens as new predicate shapes are added — currently only
|
|
10106
|
+
* ``line_item_metadata_field`` is carried.
|
|
10108
10107
|
*/
|
|
10109
10108
|
export type RollforwardMechanics = {
|
|
10110
10109
|
/**
|
|
@@ -10126,13 +10125,13 @@ export type RollforwardMechanics = {
|
|
|
10126
10125
|
/**
|
|
10127
10126
|
* Default Change Tag Element Id
|
|
10128
10127
|
*
|
|
10129
|
-
* Element id of the
|
|
10128
|
+
* 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``.
|
|
10130
10129
|
*/
|
|
10131
10130
|
default_change_tag_element_id?: string | null;
|
|
10132
10131
|
/**
|
|
10133
10132
|
* Default Change Tag Qname
|
|
10134
10133
|
*
|
|
10135
|
-
* QName of the
|
|
10134
|
+
* 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.
|
|
10136
10135
|
*/
|
|
10137
10136
|
default_change_tag_qname?: string | null;
|
|
10138
10137
|
/**
|
|
@@ -11933,8 +11932,7 @@ export type TaxonomyBlockEnvelope = {
|
|
|
11933
11932
|
*
|
|
11934
11933
|
* Exactly one of ``rule_pattern`` (arithmetic) or ``rule_check_kind``
|
|
11935
11934
|
* (model-structure) is non-null per row, enforced by the
|
|
11936
|
-
* ``check_rule_pattern_kind_xor`` DB constraint.
|
|
11937
|
-
* information-block.md §5.2.2.
|
|
11935
|
+
* ``check_rule_pattern_kind_xor`` DB constraint.
|
|
11938
11936
|
*/
|
|
11939
11937
|
export type TaxonomyBlockRule = {
|
|
11940
11938
|
/**
|
|
@@ -11997,8 +11995,7 @@ export type TaxonomyBlockRule = {
|
|
|
11997
11995
|
* ``LeafHasClassification``, ``LibraryOriginImmutability``,
|
|
11998
11996
|
* ``UniqueQNameInTaxonomy``) are system-managed — they're auto-emitted
|
|
11999
11997
|
* by :func:`emit_auto_rules` at taxonomy-block creation time and
|
|
12000
|
-
* populate ``rules.rule_check_kind`` instead of ``rule_pattern``.
|
|
12001
|
-
* information-block.md §5.2.2 for the axis split.
|
|
11998
|
+
* populate ``rules.rule_check_kind`` instead of ``rule_pattern``.
|
|
12002
11999
|
*/
|
|
12003
12000
|
export type TaxonomyBlockRuleRequest = {
|
|
12004
12001
|
/**
|
|
@@ -13228,8 +13225,8 @@ export type ValidationLite = {
|
|
|
13228
13225
|
* Pass/fail/skip counts for one ``rule_category`` within a block's
|
|
13229
13226
|
* verification results.
|
|
13230
13227
|
*
|
|
13231
|
-
* Drives the per-category accordions in the Verification Results panel
|
|
13232
|
-
*
|
|
13228
|
+
* Drives the per-category accordions in the Verification Results panel.
|
|
13229
|
+
* ``category`` is the rule's ``rule_category``
|
|
13233
13230
|
* (one of the cm:VerificationRule subclasses), resolved by joining each
|
|
13234
13231
|
* result to its Rule.
|
|
13235
13232
|
*/
|
|
@@ -13315,7 +13312,7 @@ export type VerificationResultLite = {
|
|
|
13315
13312
|
* Server-computed aggregate of a block's ``verification_results``.
|
|
13316
13313
|
*
|
|
13317
13314
|
* Overall counts plus a per-``rule_category`` breakdown, so the viewer
|
|
13318
|
-
* renders the grouped Verification Results panel
|
|
13315
|
+
* renders the grouped Verification Results panel
|
|
13319
13316
|
* without a client-side results→rules join. Status closure is
|
|
13320
13317
|
* ``pass | fail | error | skipped`` (the ``public.verification_results``
|
|
13321
13318
|
* CHECK); ``total`` is their sum.
|
|
@@ -21712,90 +21709,6 @@ export type OpLiveFinancialStatementResponses = {
|
|
|
21712
21709
|
200: OperationEnvelope;
|
|
21713
21710
|
};
|
|
21714
21711
|
export type OpLiveFinancialStatementResponse = OpLiveFinancialStatementResponses[keyof OpLiveFinancialStatementResponses];
|
|
21715
|
-
export type GetReportBundleDownloadUrlData = {
|
|
21716
|
-
body?: never;
|
|
21717
|
-
path: {
|
|
21718
|
-
/**
|
|
21719
|
-
* Graph Id
|
|
21720
|
-
*/
|
|
21721
|
-
graph_id: string;
|
|
21722
|
-
/**
|
|
21723
|
-
* Report Id
|
|
21724
|
-
*
|
|
21725
|
-
* Report identifier (rpt_-prefixed ULID).
|
|
21726
|
-
*/
|
|
21727
|
-
report_id: string;
|
|
21728
|
-
};
|
|
21729
|
-
query?: {
|
|
21730
|
-
/**
|
|
21731
|
-
* Format
|
|
21732
|
-
*
|
|
21733
|
-
* 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.
|
|
21734
|
-
*/
|
|
21735
|
-
format?: string;
|
|
21736
|
-
/**
|
|
21737
|
-
* Expires In
|
|
21738
|
-
*
|
|
21739
|
-
* Presigned URL lifetime in seconds (min 60, max 3600). Ignored for XBRL flavors (streamed directly, no URL).
|
|
21740
|
-
*/
|
|
21741
|
-
expires_in?: number;
|
|
21742
|
-
};
|
|
21743
|
-
url: '/extensions/roboledger/{graph_id}/reports/{report_id}/download';
|
|
21744
|
-
};
|
|
21745
|
-
export type GetReportBundleDownloadUrlErrors = {
|
|
21746
|
-
/**
|
|
21747
|
-
* Validation Error
|
|
21748
|
-
*/
|
|
21749
|
-
422: HttpValidationError;
|
|
21750
|
-
};
|
|
21751
|
-
export type GetReportBundleDownloadUrlError = GetReportBundleDownloadUrlErrors[keyof GetReportBundleDownloadUrlErrors];
|
|
21752
|
-
export type GetReportBundleDownloadUrlResponses = {
|
|
21753
|
-
/**
|
|
21754
|
-
* ReportBundleDownloadResponse
|
|
21755
|
-
*
|
|
21756
|
-
* Presigned-URL response for a Report bundle download.
|
|
21757
|
-
*
|
|
21758
|
-
* Mirrors :class:`BackupDownloadUrlResponse` in shape — the frontend
|
|
21759
|
-
* treats both the same way (fetch, follow URL, GET the artifact).
|
|
21760
|
-
*
|
|
21761
|
-
* Only returned for RDF-family flavors (JSON-LD) where the artifact
|
|
21762
|
-
* is stored in S3. XBRL flavors stream the binary content directly
|
|
21763
|
-
* in the response body (no JSON wrapper).
|
|
21764
|
-
*/
|
|
21765
|
-
200: {
|
|
21766
|
-
/**
|
|
21767
|
-
* Download Url
|
|
21768
|
-
*
|
|
21769
|
-
* Presigned URL that streams the bundle directly from S3.
|
|
21770
|
-
*/
|
|
21771
|
-
download_url: string;
|
|
21772
|
-
/**
|
|
21773
|
-
* Expires At
|
|
21774
|
-
*
|
|
21775
|
-
* UTC timestamp at which the presigned URL stops working.
|
|
21776
|
-
*/
|
|
21777
|
-
expires_at: string;
|
|
21778
|
-
/**
|
|
21779
|
-
* Content Type
|
|
21780
|
-
*
|
|
21781
|
-
* MIME type of the artifact behind the URL.
|
|
21782
|
-
*/
|
|
21783
|
-
content_type: string;
|
|
21784
|
-
/**
|
|
21785
|
-
* Format
|
|
21786
|
-
*
|
|
21787
|
-
* Serialization flavor delivered by this URL — matches the ``format`` query parameter.
|
|
21788
|
-
*/
|
|
21789
|
-
format: string;
|
|
21790
|
-
/**
|
|
21791
|
-
* Generation Count
|
|
21792
|
-
*
|
|
21793
|
-
* Bundle generation number stamped on the Report.
|
|
21794
|
-
*/
|
|
21795
|
-
generation_count: number;
|
|
21796
|
-
};
|
|
21797
|
-
};
|
|
21798
|
-
export type GetReportBundleDownloadUrlResponse = GetReportBundleDownloadUrlResponses[keyof GetReportBundleDownloadUrlResponses];
|
|
21799
21712
|
export type OpBuildFactGridData = {
|
|
21800
21713
|
body: CreateViewRequest;
|
|
21801
21714
|
headers?: {
|
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
|
/**
|
|
@@ -10343,18 +10343,17 @@ export type RestoreBackupOp = {
|
|
|
10343
10343
|
*
|
|
10344
10344
|
* Filter-based attribution mechanics for ``block_type='rollforward'``.
|
|
10345
10345
|
*
|
|
10346
|
-
*
|
|
10347
|
-
*
|
|
10348
|
-
*
|
|
10349
|
-
*
|
|
10350
|
-
*
|
|
10351
|
-
*
|
|
10352
|
-
* any residual against the default change tag (Tier 1 fallback).
|
|
10346
|
+
* Filter-based attribution: each block decomposes one BS source
|
|
10347
|
+
* element's period delta into a list of flow concepts via declared
|
|
10348
|
+
* :class:`AttributionFilter` predicates. The renderer evaluates the
|
|
10349
|
+
* filters against ledger LineItems at envelope-build time, emits one
|
|
10350
|
+
* attributed fact per filter per period, and arbitrates any residual
|
|
10351
|
+
* against the default change tag fallback.
|
|
10353
10352
|
*
|
|
10354
10353
|
* Reads directly from the typed ``structures.artifact_mechanics`` JSONB
|
|
10355
10354
|
* column. ``attribution_filters`` rides as nested JSON; the predicate
|
|
10356
|
-
* union widens as new predicate shapes
|
|
10357
|
-
* ``line_item_metadata_field``
|
|
10355
|
+
* union widens as new predicate shapes are added — currently only
|
|
10356
|
+
* ``line_item_metadata_field`` is carried.
|
|
10358
10357
|
*/
|
|
10359
10358
|
export type RollforwardMechanics = {
|
|
10360
10359
|
/**
|
|
@@ -10376,13 +10375,13 @@ export type RollforwardMechanics = {
|
|
|
10376
10375
|
/**
|
|
10377
10376
|
* Default Change Tag Element Id
|
|
10378
10377
|
*
|
|
10379
|
-
* Element id of the
|
|
10378
|
+
* 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
10379
|
*/
|
|
10381
10380
|
default_change_tag_element_id?: string | null;
|
|
10382
10381
|
/**
|
|
10383
10382
|
* Default Change Tag Qname
|
|
10384
10383
|
*
|
|
10385
|
-
* QName of the
|
|
10384
|
+
* 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
10385
|
*/
|
|
10387
10386
|
default_change_tag_qname?: string | null;
|
|
10388
10387
|
/**
|
|
@@ -12231,8 +12230,7 @@ export type TaxonomyBlockEnvelope = {
|
|
|
12231
12230
|
*
|
|
12232
12231
|
* Exactly one of ``rule_pattern`` (arithmetic) or ``rule_check_kind``
|
|
12233
12232
|
* (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.
|
|
12233
|
+
* ``check_rule_pattern_kind_xor`` DB constraint.
|
|
12236
12234
|
*/
|
|
12237
12235
|
export type TaxonomyBlockRule = {
|
|
12238
12236
|
/**
|
|
@@ -12296,8 +12294,7 @@ export type TaxonomyBlockRule = {
|
|
|
12296
12294
|
* ``LeafHasClassification``, ``LibraryOriginImmutability``,
|
|
12297
12295
|
* ``UniqueQNameInTaxonomy``) are system-managed — they're auto-emitted
|
|
12298
12296
|
* 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.
|
|
12297
|
+
* populate ``rules.rule_check_kind`` instead of ``rule_pattern``.
|
|
12301
12298
|
*/
|
|
12302
12299
|
export type TaxonomyBlockRuleRequest = {
|
|
12303
12300
|
/**
|
|
@@ -13562,8 +13559,8 @@ export type ValidationLite = {
|
|
|
13562
13559
|
* Pass/fail/skip counts for one ``rule_category`` within a block's
|
|
13563
13560
|
* verification results.
|
|
13564
13561
|
*
|
|
13565
|
-
* Drives the per-category accordions in the Verification Results panel
|
|
13566
|
-
*
|
|
13562
|
+
* Drives the per-category accordions in the Verification Results panel.
|
|
13563
|
+
* ``category`` is the rule's ``rule_category``
|
|
13567
13564
|
* (one of the cm:VerificationRule subclasses), resolved by joining each
|
|
13568
13565
|
* result to its Rule.
|
|
13569
13566
|
*/
|
|
@@ -13651,7 +13648,7 @@ export type VerificationResultLite = {
|
|
|
13651
13648
|
* Server-computed aggregate of a block's ``verification_results``.
|
|
13652
13649
|
*
|
|
13653
13650
|
* Overall counts plus a per-``rule_category`` breakdown, so the viewer
|
|
13654
|
-
* renders the grouped Verification Results panel
|
|
13651
|
+
* renders the grouped Verification Results panel
|
|
13655
13652
|
* without a client-side results→rules join. Status closure is
|
|
13656
13653
|
* ``pass | fail | error | skipped`` (the ``public.verification_results``
|
|
13657
13654
|
* CHECK); ``total`` is their sum.
|
|
@@ -22823,95 +22820,6 @@ export type OpLiveFinancialStatementResponses = {
|
|
|
22823
22820
|
|
|
22824
22821
|
export type OpLiveFinancialStatementResponse = OpLiveFinancialStatementResponses[keyof OpLiveFinancialStatementResponses];
|
|
22825
22822
|
|
|
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
22823
|
export type OpBuildFactGridData = {
|
|
22916
22824
|
body: CreateViewRequest;
|
|
22917
22825
|
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, 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
|
*/
|
|
@@ -969,12 +969,6 @@ export declare const opRemovePublishListMember: <ThrowOnError extends boolean =
|
|
|
969
969
|
* **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
970
|
*/
|
|
971
971
|
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
972
|
/**
|
|
979
973
|
* Build Fact Grid
|
|
980
974
|
*
|