@robosystems/client 0.3.38 → 0.3.40

package/types.gen.d.ts

@@ -738,7 +738,7 @@ export type CancelSubscriptionRequest = {
 /**
  * ChangeReportingStyleOp
  *
- * Body for the change-reporting-style operation (Phase 2 of §3.2).
+ * Body for the change-reporting-style operation.
  *
  * Switches the graph to a different Reporting Style. The target Style
  * must be a library- or customer-authored Structure with
@@ -949,7 +949,7 @@ export type ClosePeriodResponse = {
     /**
      * Rule Summary
      *
-     * 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 (§3.8 auto-run on close).
+     * 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).
      */
     rule_summary?: {
         [key: string]: number;
@@ -1964,7 +1964,7 @@ export type CreateScheduleRequest = {
     /**
      * Element Ids
      *
-     * Element IDs to include
+     * 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.
      */
     element_ids: Array<string>;
     /**
@@ -1990,7 +1990,7 @@ export type CreateScheduleRequest = {
     /**
      * Closed Through
      *
-     * If provided, facts with period_end ≤ this date are flagged as 'historical' (already reflected in opening balances, ignored by the close workflow). Used during initial ledger setup to create schedules whose early facts have already been captured elsewhere.
+     * 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.
      */
     closed_through?: string | null;
     /**
@@ -3657,13 +3657,13 @@ export type EntryTemplateRequest = {
     /**
      * Debit Element Id
      *
-     * Element to debit (e.g., Depreciation Expense)
+     * 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.
      */
     debit_element_id: string;
     /**
      * Credit Element Id
      *
-     * Element to credit (e.g., Accumulated Depreciation)
+     * 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.
      */
     credit_element_id: string;
     /**
@@ -6388,7 +6388,7 @@ export type ListSubgraphsResponse = {
     /**
      * Subgraphs Enabled
      *
-     * Whether subgraphs are enabled for this tier (requires LadybugDB Large/XLarge)
+     * Whether subgraphs are enabled for this tier (requires Large/XLarge tier)
      */
     subgraphs_enabled: boolean;
     /**
@@ -10093,18 +10093,17 @@ export type RestoreBackupOp = {
  *
  * Filter-based attribution mechanics for ``block_type='rollforward'``.
  *
- * Implements Tier 2 of the rollforward attribution design
- * (``information-block.md`` §4.5). Each block decomposes one BS
- * source element's period delta into a list of flow concepts via
- * declared :class:`AttributionFilter` predicates. The renderer
- * evaluates the filters against ledger LineItems at envelope-build
- * time, emits one attributed fact per filter per period, and arbitrates
- * any residual against the default change tag (Tier 1 fallback).
+ * Filter-based attribution: each block decomposes one BS source
+ * element's period delta into a list of flow concepts via declared
+ * :class:`AttributionFilter` predicates. The renderer evaluates the
+ * filters against ledger LineItems at envelope-build time, emits one
+ * attributed fact per filter per period, and arbitrates any residual
+ * against the default change tag fallback.
  *
  * Reads directly from the typed ``structures.artifact_mechanics`` JSONB
  * column. ``attribution_filters`` rides as nested JSON; the predicate
- * union widens as new predicate shapes ship (Phase 2 MVP carries only
- * ``line_item_metadata_field``).
+ * union widens as new predicate shapes are added — currently only
+ * ``line_item_metadata_field`` is carried.
  */
 export type RollforwardMechanics = {
     /**
@@ -10126,13 +10125,13 @@ export type RollforwardMechanics = {
     /**
      * Default Change Tag Element Id
      *
-     * Element id of the Tier 1 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``.
+     * 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``.
      */
     default_change_tag_element_id?: string | null;
     /**
      * Default Change Tag Qname
      *
-     * QName of the Tier 1 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.
+     * 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.
      */
     default_change_tag_qname?: string | null;
     /**
@@ -11933,8 +11932,7 @@ export type TaxonomyBlockEnvelope = {
  *
  * Exactly one of ``rule_pattern`` (arithmetic) or ``rule_check_kind``
  * (model-structure) is non-null per row, enforced by the
- * ``check_rule_pattern_kind_xor`` DB constraint. See
- * information-block.md §5.2.2.
+ * ``check_rule_pattern_kind_xor`` DB constraint.
  */
 export type TaxonomyBlockRule = {
     /**
@@ -11997,8 +11995,7 @@ export type TaxonomyBlockRule = {
  * ``LeafHasClassification``, ``LibraryOriginImmutability``,
  * ``UniqueQNameInTaxonomy``) are system-managed — they're auto-emitted
  * by :func:`emit_auto_rules` at taxonomy-block creation time and
- * populate ``rules.rule_check_kind`` instead of ``rule_pattern``. See
- * information-block.md §5.2.2 for the axis split.
+ * populate ``rules.rule_check_kind`` instead of ``rule_pattern``.
  */
 export type TaxonomyBlockRuleRequest = {
     /**
@@ -13228,8 +13225,8 @@ export type ValidationLite = {
  * Pass/fail/skip counts for one ``rule_category`` within a block's
  * verification results.
  *
- * Drives the per-category accordions in the Verification Results panel
- * (financial-viewer §7.12). ``category`` is the rule's ``rule_category``
+ * Drives the per-category accordions in the Verification Results panel.
+ * ``category`` is the rule's ``rule_category``
  * (one of the cm:VerificationRule subclasses), resolved by joining each
  * result to its Rule.
  */
@@ -13315,7 +13312,7 @@ export type VerificationResultLite = {
  * Server-computed aggregate of a block's ``verification_results``.
  *
  * Overall counts plus a per-``rule_category`` breakdown, so the viewer
- * renders the grouped Verification Results panel (financial-viewer §7.12)
+ * renders the grouped Verification Results panel
  * without a client-side results→rules join. Status closure is
  * ``pass | fail | error | skipped`` (the ``public.verification_results``
  * CHECK); ``total`` is their sum.
@@ -21712,90 +21709,6 @@ export type OpLiveFinancialStatementResponses = {
     200: OperationEnvelope;
 };
 export type OpLiveFinancialStatementResponse = OpLiveFinancialStatementResponses[keyof OpLiveFinancialStatementResponses];
-export type GetReportBundleDownloadUrlData = {
-    body?: never;
-    path: {
-        /**
-         * Graph Id
-         */
-        graph_id: string;
-        /**
-         * Report Id
-         *
-         * Report identifier (rpt_-prefixed ULID).
-         */
-        report_id: string;
-    };
-    query?: {
-        /**
-         * Format
-         *
-         * 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.
-         */
-        format?: string;
-        /**
-         * Expires In
-         *
-         * Presigned URL lifetime in seconds (min 60, max 3600). Ignored for XBRL flavors (streamed directly, no URL).
-         */
-        expires_in?: number;
-    };
-    url: '/extensions/roboledger/{graph_id}/reports/{report_id}/download';
-};
-export type GetReportBundleDownloadUrlErrors = {
-    /**
-     * Validation Error
-     */
-    422: HttpValidationError;
-};
-export type GetReportBundleDownloadUrlError = GetReportBundleDownloadUrlErrors[keyof GetReportBundleDownloadUrlErrors];
-export type GetReportBundleDownloadUrlResponses = {
-    /**
-     * ReportBundleDownloadResponse
-     *
-     * Presigned-URL response for a Report bundle download.
-     *
-     * Mirrors :class:`BackupDownloadUrlResponse` in shape — the frontend
-     * treats both the same way (fetch, follow URL, GET the artifact).
-     *
-     * Only returned for RDF-family flavors (JSON-LD) where the artifact
-     * is stored in S3. XBRL flavors stream the binary content directly
-     * in the response body (no JSON wrapper).
-     */
-    200: {
-        /**
-         * Download Url
-         *
-         * Presigned URL that streams the bundle directly from S3.
-         */
-        download_url: string;
-        /**
-         * Expires At
-         *
-         * UTC timestamp at which the presigned URL stops working.
-         */
-        expires_at: string;
-        /**
-         * Content Type
-         *
-         * MIME type of the artifact behind the URL.
-         */
-        content_type: string;
-        /**
-         * Format
-         *
-         * Serialization flavor delivered by this URL — matches the ``format`` query parameter.
-         */
-        format: string;
-        /**
-         * Generation Count
-         *
-         * Bundle generation number stamped on the Report.
-         */
-        generation_count: number;
-    };
-};
-export type GetReportBundleDownloadUrlResponse = GetReportBundleDownloadUrlResponses[keyof GetReportBundleDownloadUrlResponses];
 export type OpBuildFactGridData = {
     body: CreateViewRequest;
     headers?: {

package/types.gen.ts

@@ -763,7 +763,7 @@ export type CancelSubscriptionRequest = {
 /**
  * ChangeReportingStyleOp
  *
- * Body for the change-reporting-style operation (Phase 2 of §3.2).
+ * Body for the change-reporting-style operation.
  *
  * Switches the graph to a different Reporting Style. The target Style
  * must be a library- or customer-authored Structure with
@@ -980,7 +980,7 @@ export type ClosePeriodResponse = {
     /**
      * Rule Summary
      *
-     * 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 (§3.8 auto-run on close).
+     * 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).
      */
     rule_summary?: {
         [key: string]: number;
@@ -2017,7 +2017,7 @@ export type CreateScheduleRequest = {
     /**
      * Element Ids
      *
-     * Element IDs to include
+     * 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.
      */
     element_ids: Array<string>;
     /**
@@ -2043,7 +2043,7 @@ export type CreateScheduleRequest = {
     /**
      * Closed Through
      *
-     * If provided, facts with period_end ≤ this date are flagged as 'historical' (already reflected in opening balances, ignored by the close workflow). Used during initial ledger setup to create schedules whose early facts have already been captured elsewhere.
+     * 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.
      */
     closed_through?: string | null;
     /**
@@ -3756,13 +3756,13 @@ export type EntryTemplateRequest = {
     /**
      * Debit Element Id
      *
-     * Element to debit (e.g., Depreciation Expense)
+     * 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.
      */
     debit_element_id: string;
     /**
      * Credit Element Id
      *
-     * Element to credit (e.g., Accumulated Depreciation)
+     * 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.
      */
     credit_element_id: string;
     /**
@@ -6541,7 +6541,7 @@ export type ListSubgraphsResponse = {
     /**
      * Subgraphs Enabled
      *
-     * Whether subgraphs are enabled for this tier (requires LadybugDB Large/XLarge)
+     * Whether subgraphs are enabled for this tier (requires Large/XLarge tier)
      */
     subgraphs_enabled: boolean;
     /**
@@ -10343,18 +10343,17 @@ export type RestoreBackupOp = {
  *
  * Filter-based attribution mechanics for ``block_type='rollforward'``.
  *
- * Implements Tier 2 of the rollforward attribution design
- * (``information-block.md`` §4.5). Each block decomposes one BS
- * source element's period delta into a list of flow concepts via
- * declared :class:`AttributionFilter` predicates. The renderer
- * evaluates the filters against ledger LineItems at envelope-build
- * time, emits one attributed fact per filter per period, and arbitrates
- * any residual against the default change tag (Tier 1 fallback).
+ * Filter-based attribution: each block decomposes one BS source
+ * element's period delta into a list of flow concepts via declared
+ * :class:`AttributionFilter` predicates. The renderer evaluates the
+ * filters against ledger LineItems at envelope-build time, emits one
+ * attributed fact per filter per period, and arbitrates any residual
+ * against the default change tag fallback.
  *
  * Reads directly from the typed ``structures.artifact_mechanics`` JSONB
  * column. ``attribution_filters`` rides as nested JSON; the predicate
- * union widens as new predicate shapes ship (Phase 2 MVP carries only
- * ``line_item_metadata_field``).
+ * union widens as new predicate shapes are added — currently only
+ * ``line_item_metadata_field`` is carried.
  */
 export type RollforwardMechanics = {
     /**
@@ -10376,13 +10375,13 @@ export type RollforwardMechanics = {
     /**
      * Default Change Tag Element Id
      *
-     * Element id of the Tier 1 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``.
+     * 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``.
      */
     default_change_tag_element_id?: string | null;
     /**
      * Default Change Tag Qname
      *
-     * QName of the Tier 1 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.
+     * 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.
      */
     default_change_tag_qname?: string | null;
     /**
@@ -12231,8 +12230,7 @@ export type TaxonomyBlockEnvelope = {
  *
  * Exactly one of ``rule_pattern`` (arithmetic) or ``rule_check_kind``
  * (model-structure) is non-null per row, enforced by the
- * ``check_rule_pattern_kind_xor`` DB constraint. See
- * information-block.md §5.2.2.
+ * ``check_rule_pattern_kind_xor`` DB constraint.
  */
 export type TaxonomyBlockRule = {
     /**
@@ -12296,8 +12294,7 @@ export type TaxonomyBlockRule = {
  * ``LeafHasClassification``, ``LibraryOriginImmutability``,
  * ``UniqueQNameInTaxonomy``) are system-managed — they're auto-emitted
  * by :func:`emit_auto_rules` at taxonomy-block creation time and
- * populate ``rules.rule_check_kind`` instead of ``rule_pattern``. See
- * information-block.md §5.2.2 for the axis split.
+ * populate ``rules.rule_check_kind`` instead of ``rule_pattern``.
  */
 export type TaxonomyBlockRuleRequest = {
     /**
@@ -13562,8 +13559,8 @@ export type ValidationLite = {
  * Pass/fail/skip counts for one ``rule_category`` within a block's
  * verification results.
  *
- * Drives the per-category accordions in the Verification Results panel
- * (financial-viewer §7.12). ``category`` is the rule's ``rule_category``
+ * Drives the per-category accordions in the Verification Results panel.
+ * ``category`` is the rule's ``rule_category``
  * (one of the cm:VerificationRule subclasses), resolved by joining each
  * result to its Rule.
  */
@@ -13651,7 +13648,7 @@ export type VerificationResultLite = {
  * Server-computed aggregate of a block's ``verification_results``.
  *
  * Overall counts plus a per-``rule_category`` breakdown, so the viewer
- * renders the grouped Verification Results panel (financial-viewer §7.12)
+ * renders the grouped Verification Results panel
  * without a client-side results→rules join. Status closure is
  * ``pass | fail | error | skipped`` (the ``public.verification_results``
  * CHECK); ``total`` is their sum.
@@ -22823,95 +22820,6 @@ export type OpLiveFinancialStatementResponses = {
 
 export type OpLiveFinancialStatementResponse = OpLiveFinancialStatementResponses[keyof OpLiveFinancialStatementResponses];
 
-export type GetReportBundleDownloadUrlData = {
-    body?: never;
-    path: {
-        /**
-         * Graph Id
-         */
-        graph_id: string;
-        /**
-         * Report Id
-         *
-         * Report identifier (rpt_-prefixed ULID).
-         */
-        report_id: string;
-    };
-    query?: {
-        /**
-         * Format
-         *
-         * 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.
-         */
-        format?: string;
-        /**
-         * Expires In
-         *
-         * Presigned URL lifetime in seconds (min 60, max 3600). Ignored for XBRL flavors (streamed directly, no URL).
-         */
-        expires_in?: number;
-    };
-    url: '/extensions/roboledger/{graph_id}/reports/{report_id}/download';
-};
-
-export type GetReportBundleDownloadUrlErrors = {
-    /**
-     * Validation Error
-     */
-    422: HttpValidationError;
-};
-
-export type GetReportBundleDownloadUrlError = GetReportBundleDownloadUrlErrors[keyof GetReportBundleDownloadUrlErrors];
-
-export type GetReportBundleDownloadUrlResponses = {
-    /**
-     * ReportBundleDownloadResponse
-     *
-     * Presigned-URL response for a Report bundle download.
-     *
-     * Mirrors :class:`BackupDownloadUrlResponse` in shape — the frontend
-     * treats both the same way (fetch, follow URL, GET the artifact).
-     *
-     * Only returned for RDF-family flavors (JSON-LD) where the artifact
-     * is stored in S3. XBRL flavors stream the binary content directly
-     * in the response body (no JSON wrapper).
-     */
-    200: {
-        /**
-         * Download Url
-         *
-         * Presigned URL that streams the bundle directly from S3.
-         */
-        download_url: string;
-        /**
-         * Expires At
-         *
-         * UTC timestamp at which the presigned URL stops working.
-         */
-        expires_at: string;
-        /**
-         * Content Type
-         *
-         * MIME type of the artifact behind the URL.
-         */
-        content_type: string;
-        /**
-         * Format
-         *
-         * Serialization flavor delivered by this URL — matches the ``format`` query parameter.
-         */
-        format: string;
-        /**
-         * Generation Count
-         *
-         * Bundle generation number stamped on the Report.
-         */
-        generation_count: number;
-    };
-};
-
-export type GetReportBundleDownloadUrlResponse = GetReportBundleDownloadUrlResponses[keyof GetReportBundleDownloadUrlResponses];
-
 export type OpBuildFactGridData = {
     body: CreateViewRequest;
     headers?: {