@robosystems/client 1.17.2 → 2.0.0

package/sdk.gen.d.ts

@@ -811,6 +811,14 @@ export declare const handleHttpPostExtensionsGraphIdGraphqlPost: <ThrowOnError e
  * **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.
  */
 export declare const initializeLedger: <ThrowOnError extends boolean = false>(options: Options<InitializeLedgerData, ThrowOnError>) => RequestResult<InitializeLedgerResponses, InitializeLedgerErrors, ThrowOnError>;
+/**
+ * Initialize Chart of Accounts
+ *
+ * Create the graph's chart of accounts from a shipped template — the fresh-company path to native books. Use when the graph has NO chart (a QuickBooks-synced tenant never needs this: its chart arrives with the sync and stays after a sever) and before connecting a bank feed, which needs a chart to resolve against. Templates: `saas` (subscription software), `services` (professional services), `product` (inventory and COGS) — the `chartTemplates` GraphQL field lists them with names and account counts. Creates the chart, its `coa_mapping` structure and the template's CoA → rs-gaap mapping associations in one transaction, with the equity rows mapped by the entity's legal form (`entity_type`, defaulting to the graph's primary entity). One-time: 409 once a chart exists — a chart is never replaced. Customize afterwards with update-taxonomy-block; accounts that carry activity are never deleted.
+ *
+ * **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.
+ */
+export declare const initializeChartOfAccounts: <ThrowOnError extends boolean = false>(options: Options<InitializeChartOfAccountsData, ThrowOnError>) => RequestResult<InitializeChartOfAccountsResponses, InitializeChartOfAccountsErrors, ThrowOnError>;
 /**
  * Update Entity
  *
@@ -835,14 +843,6 @@ export declare const changeReportingStyle: <ThrowOnError extends boolean = false
  * **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.
  */
 export declare const createTaxonomyBlock: <ThrowOnError extends boolean = false>(options: Options<CreateTaxonomyBlockData, ThrowOnError>) => RequestResult<CreateTaxonomyBlockResponses, CreateTaxonomyBlockErrors, ThrowOnError>;
-/**
- * Initialize Chart of Accounts
- *
- * Create the graph's chart of accounts from a shipped template — the fresh-company path to native books. Use when the graph has NO chart (a QuickBooks-synced tenant never needs this: its chart arrives with the sync and stays after a sever) and before connecting a bank feed, which needs a chart to resolve against. Templates: `saas` (subscription software), `services` (professional services), `product` (inventory and COGS) — the `chartTemplates` GraphQL field lists them with names and account counts. Creates the chart, its `coa_mapping` structure and the template's CoA → rs-gaap mapping associations in one transaction, with the equity rows mapped by the entity's legal form (`entity_type`, defaulting to the graph's primary entity). One-time: 409 once a chart exists — a chart is never replaced. Customize afterwards with update-taxonomy-block; accounts that carry activity are never deleted.
- *
- * **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.
- */
-export declare const initializeChartOfAccounts: <ThrowOnError extends boolean = false>(options: Options<InitializeChartOfAccountsData, ThrowOnError>) => RequestResult<InitializeChartOfAccountsResponses, InitializeChartOfAccountsErrors, ThrowOnError>;
 /**
  * Update Taxonomy Block
  *
@@ -982,7 +982,7 @@ export declare const createEventBlock: <ThrowOnError extends boolean = false>(op
 /**
  * Update Event Block
  *
- * Apply a status transition (captured → classified | committed | voided) and/or field corrections (description, effective_at, metadata_patch) to an existing event block. Only supplied fields are updated. captured → classified records an account choice without posting — for a bank-feed line, patch metadata.classified_element_id (or accept_suggestion: true) in the same call. When the transition is captured/classified → committed, the registered Python handler fires against the captured metadata to produce the GL rows; a bank-feed line with no account chosen and no matching rule is refused. Errors from the handler (validation, element resolution, closed period, unbalanced lines) surface as 422 here so the inbox UI can display the failure reason without retry.
+ * Apply a status transition (captured → classified | committed | voided) and/or field corrections (description, effective_at, metadata_patch) to an existing event block. Only supplied fields are updated. captured → classified records an account choice without posting — for a bank-feed line, patch metadata.classified_element_id (or accept_suggestion: true) in the same call. When the transition is captured/classified → committed, the registered Python handler fires against the captured metadata to produce the GL rows, unless it already wrote them when the event was created; a bank-feed line with no account chosen and no matching rule is refused. Errors from the handler (validation, element resolution, closed period, unbalanced lines) surface as 422 here so the inbox UI can display the failure reason without retry.
  *
  * **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.
  */
@@ -1052,61 +1052,61 @@ export declare const updateJournalEntry: <ThrowOnError extends boolean = false>(
  */
 export declare const deleteJournalEntry: <ThrowOnError extends boolean = false>(options: Options<DeleteJournalEntryData, ThrowOnError>) => RequestResult<DeleteJournalEntryResponses, DeleteJournalEntryErrors, ThrowOnError>;
 /**
- * Promote Due Schedule Obligations
+ * Set Close Target
  *
- * Promote matured pending schedule obligations (schedule_entry_due events whose period boundary has passed) to 'classified', and — when dispatch_handlers=true (default) — draft their closing entries in the same transaction. Also reaches stranded obligations: events already 'classified' (by an earlier flip-only sweep) whose closing entry was never drafted are dispatched in the same pass, and reported via stranded_count. This is the on-demand form of the background obligation-promotion sweep; run it before close-period when a schedule was just created or when you can't wait for the Dagster sensor. Idempotent: re-running skips already-classified obligations and reconciles to existing drafts.
+ * Set the user-controlled goal period for closing (`close_target`). Format: YYYY-MM. Distinct from `closed_through` (what's actually locked) — setting a target doesn't close anything; call `close-period` for that. The catch-up sequence between `closed_through` and this target appears on the response's `fiscal_calendar.catch_up_sequence`.
  *
  * **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.
  */
-export declare const promoteObligations: <ThrowOnError extends boolean = false>(options: Options<PromoteObligationsData, ThrowOnError>) => RequestResult<PromoteObligationsResponses, PromoteObligationsErrors, ThrowOnError>;
+export declare const setCloseTarget: <ThrowOnError extends boolean = false>(options: Options<SetCloseTargetData, ThrowOnError>) => RequestResult<SetCloseTargetResponses, SetCloseTargetErrors, ThrowOnError>;
 /**
- * Rebuild Schedule In Place
+ * Close Fiscal Period
  *
- * 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.
+ * Lock a single fiscal period. Posts draft entries, runs the balance-sheet equation check, advances `closed_through` by one, auto-advances `close_target` if this close caught up to it, and stamps the period's canonical statement FactSets from the posted ledger (`statements_stamped` / `stamped_statement_sets` in the response; soft-skipped with `statement_stamp_note` when reporting isn't set up). Period must be exactly `closed_through + 1` — sequence violations return 422 with structured `blockers`. Common blockers: `sync_stale` (override with `allow_stale_sync=true` after manual verification), `period_incomplete` (draft entries unbalanced), `sequence_violation` (out-of-order).
  *
  * **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.
  */
-export declare const rebuildSchedule: <ThrowOnError extends boolean = false>(options: Options<RebuildScheduleData, ThrowOnError>) => RequestResult<RebuildScheduleResponses, RebuildScheduleErrors, ThrowOnError>;
+export declare const closePeriod: <ThrowOnError extends boolean = false>(options: Options<ClosePeriodData, ThrowOnError>) => RequestResult<ClosePeriodResponses, ClosePeriodErrors, ThrowOnError>;
 /**
- * Terminate Schedule Early
+ * Reopen Fiscal Period
  *
- * End a schedule early at a month-end cutoff without booking any entry. In one transaction: deletes forward facts past the cutoff (refusing when posted entries exist past it; stale drafts past it are deleted), voids the remaining obligation chain past the cutoff (pending and classified rows), and rewrites the SumEquals rule to prove the truncated curve. History at or before the cutoff is untouched, so open months the schedule still covers close normally. Use this when the termination's GL effect is already booked (an asset transferred via a manual entry, a prepaid refunded in the source system) or none is wanted; when the derecognition entry still needs to be booked, use create-event-block(event_type='asset_disposed') instead — the disposal handler posts it atomically with the same obligation void. Run BEFORE promote-obligations at close so terminated periods are never drafted.
+ * Reopen a closed period for adjustment. Only the latest closed period (`closed_through`) can be reopened; it decrements by one and the period's entries become writable again. To reach an earlier month, reopen latest-first down to it, then re-close forward — an out-of-order reopen is refused (422) with the ordered list, because every later closed month carries statements stamped from the earlier month's numbers. Retracts the month's canonical statement FactSets (a reopened month is no longer a closed assertion; re-closing restamps them). The required `reason` is captured in the audit log. Use sparingly — reopen invalidates downstream artifacts that trusted the closed state (reports, shared filings).
  *
  * **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.
  */
-export declare const terminateSchedule: <ThrowOnError extends boolean = false>(options: Options<TerminateScheduleData, ThrowOnError>) => RequestResult<TerminateScheduleResponses, TerminateScheduleErrors, ThrowOnError>;
+export declare const reopenPeriod: <ThrowOnError extends boolean = false>(options: Options<ReopenPeriodData, ThrowOnError>) => RequestResult<ReopenPeriodResponses, ReopenPeriodErrors, ThrowOnError>;
 /**
- * Set Close Target
+ * Backfill Plan History
  *
- * Set the user-controlled goal period for closing (`close_target`). Format: YYYY-MM. Distinct from `closed_through` (what's actually locked) — setting a target doesn't close anything; call `close-period` for that. The catch-up sequence between `closed_through` and this target appears on the response's `fiscal_calendar.catch_up_sequence`.
+ * Compile monthly statement history behind the close boundary — the plan's historical columns. Seeds any missing FiscalPeriod rows (baseline-closed) back to the clamped `start_period`, then restamps each month lacking canonical statement FactSets by running the real reopen → reclose cycle (balance validation, statement rules, and audit events per month). Chunked: at most `max_periods` months per call, oldest first — loop until `remaining_periods` comes back empty. Idempotent: already-stamped months are never touched. Months holding draft entries are skipped, never posted. `start_period` is clamped to the earliest month with ledger data, so deep-history tenants only backfill what actually exists.
  *
  * **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.
  */
-export declare const setCloseTarget: <ThrowOnError extends boolean = false>(options: Options<SetCloseTargetData, ThrowOnError>) => RequestResult<SetCloseTargetResponses, SetCloseTargetErrors, ThrowOnError>;
+export declare const backfillPlanHistory: <ThrowOnError extends boolean = false>(options: Options<BackfillPlanHistoryData, ThrowOnError>) => RequestResult<BackfillPlanHistoryResponses, BackfillPlanHistoryErrors, ThrowOnError>;
 /**
- * Close Fiscal Period
+ * Promote Due Schedule Obligations
  *
- * Lock a single fiscal period. Posts draft entries, runs the balance-sheet equation check, advances `closed_through` by one, auto-advances `close_target` if this close caught up to it, and stamps the period's canonical statement FactSets from the posted ledger (`statements_stamped` / `stamped_statement_sets` in the response; soft-skipped with `statement_stamp_note` when reporting isn't set up). Period must be exactly `closed_through + 1` — sequence violations return 422 with structured `blockers`. Common blockers: `sync_stale` (override with `allow_stale_sync=true` after manual verification), `period_incomplete` (draft entries unbalanced), `sequence_violation` (out-of-order).
+ * Promote matured pending schedule obligations (schedule_entry_due events whose period boundary has passed) to 'classified', and — when dispatch_handlers=true (default) — draft their closing entries in the same transaction. Also reaches stranded obligations: events already 'classified' (by an earlier flip-only sweep) whose closing entry was never drafted are dispatched in the same pass, and reported via stranded_count. This is the on-demand form of the background obligation-promotion sweep; run it before close-period when a schedule was just created or when you can't wait for the Dagster sensor. Idempotent: re-running skips already-classified obligations and reconciles to existing drafts.
  *
  * **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.
  */
-export declare const closePeriod: <ThrowOnError extends boolean = false>(options: Options<ClosePeriodData, ThrowOnError>) => RequestResult<ClosePeriodResponses, ClosePeriodErrors, ThrowOnError>;
+export declare const promoteObligations: <ThrowOnError extends boolean = false>(options: Options<PromoteObligationsData, ThrowOnError>) => RequestResult<PromoteObligationsResponses, PromoteObligationsErrors, ThrowOnError>;
 /**
- * Reopen Fiscal Period
+ * Rebuild Schedule In Place
  *
- * Reopen a closed period for adjustment. Only the latest closed period (`closed_through`) can be reopened; it decrements by one and the period's entries become writable again. To reach an earlier month, reopen latest-first down to it, then re-close forward — an out-of-order reopen is refused (422) with the ordered list, because every later closed month carries statements stamped from the earlier month's numbers. Retracts the month's canonical statement FactSets (a reopened month is no longer a closed assertion; re-closing restamps them). The required `reason` is captured in the audit log. Use sparingly — reopen invalidates downstream artifacts that trusted the closed state (reports, shared filings).
+ * 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.
  *
  * **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.
  */
-export declare const reopenPeriod: <ThrowOnError extends boolean = false>(options: Options<ReopenPeriodData, ThrowOnError>) => RequestResult<ReopenPeriodResponses, ReopenPeriodErrors, ThrowOnError>;
+export declare const rebuildSchedule: <ThrowOnError extends boolean = false>(options: Options<RebuildScheduleData, ThrowOnError>) => RequestResult<RebuildScheduleResponses, RebuildScheduleErrors, ThrowOnError>;
 /**
- * Backfill Plan History
+ * Terminate Schedule Early
  *
- * Compile monthly statement history behind the close boundary — the plan's historical columns. Seeds any missing FiscalPeriod rows (baseline-closed) back to the clamped `start_period`, then restamps each month lacking canonical statement FactSets by running the real reopen → reclose cycle (balance validation, statement rules, and audit events per month). Chunked: at most `max_periods` months per call, oldest first — loop until `remaining_periods` comes back empty. Idempotent: already-stamped months are never touched. Months holding draft entries are skipped, never posted. `start_period` is clamped to the earliest month with ledger data, so deep-history tenants only backfill what actually exists.
+ * End a schedule early at a month-end cutoff without booking any entry. In one transaction: deletes forward facts past the cutoff (refusing when posted entries exist past it; stale drafts past it are deleted), voids the remaining obligation chain past the cutoff (pending and classified rows), and rewrites the SumEquals rule to prove the truncated curve. History at or before the cutoff is untouched, so open months the schedule still covers close normally. Use this when the termination's GL effect is already booked (an asset transferred via a manual entry, a prepaid refunded in the source system) or none is wanted; when the derecognition entry still needs to be booked, use create-event-block(event_type='asset_disposed') instead — the disposal handler posts it atomically with the same obligation void. Run BEFORE promote-obligations at close so terminated periods are never drafted.
  *
  * **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.
  */
-export declare const backfillPlanHistory: <ThrowOnError extends boolean = false>(options: Options<BackfillPlanHistoryData, ThrowOnError>) => RequestResult<BackfillPlanHistoryResponses, BackfillPlanHistoryErrors, ThrowOnError>;
+export declare const terminateSchedule: <ThrowOnError extends boolean = false>(options: Options<TerminateScheduleData, ThrowOnError>) => RequestResult<TerminateScheduleResponses, TerminateScheduleErrors, ThrowOnError>;
 /**
  * Create Report
  *
@@ -1132,37 +1132,37 @@ export declare const regenerateReport: <ThrowOnError extends boolean = false>(op
  */
 export declare const deleteReport: <ThrowOnError extends boolean = false>(options: Options<DeleteReportData, ThrowOnError>) => RequestResult<DeleteReportResponses, DeleteReportErrors, ThrowOnError>;
 /**
- * Share Report
+ * File Report
  *
- * Pushes a published report to every member of the target publish list. Each share is an independent copy: the report row + all its facts are cloned into the recipient's tenant schema with `source_graph_id` / `source_report_id` provenance fields populated. Per-target outcomes (success or error) surface in the response — share does not fail-fast across targets. Recipients that have blocked this graph come back as an error for that target; withdraw a delivered copy with `revoke-report-share`.
+ * Transitions the Report's filing_status to 'filed' — locks the package. Allowed from 'draft' or 'under_review'. Stamps filed_at + filed_by.
  *
  * **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.
  */
-export declare const shareReport: <ThrowOnError extends boolean = false>(options: Options<ShareReportData, ThrowOnError>) => RequestResult<ShareReportResponses, ShareReportErrors, ThrowOnError>;
+export declare const fileReport: <ThrowOnError extends boolean = false>(options: Options<FileReportData, ThrowOnError>) => RequestResult<FileReportResponses, FileReportErrors, ThrowOnError>;
 /**
- * Revoke Report Share
+ * Transition Filing Status
  *
- * Withdraws a report previously shared to one recipient graph: deletes the copy from that recipient's schema and stamps the share record revoked. Scoped to a single recipient — withdrawing a distribution to a whole publish list is one call per member. A recipient who already deleted the copy is not an error; the share is still marked revoked and `copy_deleted` returns false. The linked entity in the recipient's graph is left in place, so an investor's declared holding survives.
+ * Move a Report along the non-file legs of the filing lifecycle (draft ↔ under_review, filed → archived). Use 'file-report' to reach 'filed' so audit fields land cleanly.
  *
  * **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.
  */
-export declare const revokeReportShare: <ThrowOnError extends boolean = false>(options: Options<RevokeReportShareData, ThrowOnError>) => RequestResult<RevokeReportShareResponses, RevokeReportShareErrors, ThrowOnError>;
+export declare const transitionFilingStatus: <ThrowOnError extends boolean = false>(options: Options<TransitionFilingStatusData, ThrowOnError>) => RequestResult<TransitionFilingStatusResponses, TransitionFilingStatusErrors, ThrowOnError>;
 /**
- * File Report
+ * Share Report
  *
- * Transitions the Report's filing_status to 'filed' — locks the package. Allowed from 'draft' or 'under_review'. Stamps filed_at + filed_by.
+ * Pushes a published report to every member of the target publish list. Each share is an independent copy: the report row + all its facts are cloned into the recipient's tenant schema with `source_graph_id` / `source_report_id` provenance fields populated. Per-target outcomes (success or error) surface in the response — share does not fail-fast across targets. Recipients that have blocked this graph come back as an error for that target; withdraw a delivered copy with `revoke-report-share`.
  *
  * **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.
  */
-export declare const fileReport: <ThrowOnError extends boolean = false>(options: Options<FileReportData, ThrowOnError>) => RequestResult<FileReportResponses, FileReportErrors, ThrowOnError>;
+export declare const shareReport: <ThrowOnError extends boolean = false>(options: Options<ShareReportData, ThrowOnError>) => RequestResult<ShareReportResponses, ShareReportErrors, ThrowOnError>;
 /**
- * Transition Filing Status
+ * Revoke Report Share
  *
- * Move a Report along the non-file legs of the filing lifecycle (draft ↔ under_review, filed → archived). Use 'file-report' to reach 'filed' so audit fields land cleanly.
+ * Withdraws a report previously shared to one recipient graph: deletes the copy from that recipient's schema and stamps the share record revoked. Scoped to a single recipient — withdrawing a distribution to a whole publish list is one call per member. A recipient who already deleted the copy is not an error; the share is still marked revoked and `copy_deleted` returns false. The linked entity in the recipient's graph is left in place, so an investor's declared holding survives.
  *
  * **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.
  */
-export declare const transitionFilingStatus: <ThrowOnError extends boolean = false>(options: Options<TransitionFilingStatusData, ThrowOnError>) => RequestResult<TransitionFilingStatusResponses, TransitionFilingStatusErrors, ThrowOnError>;
+export declare const revokeReportShare: <ThrowOnError extends boolean = false>(options: Options<RevokeReportShareData, ThrowOnError>) => RequestResult<RevokeReportShareResponses, RevokeReportShareErrors, ThrowOnError>;
 /**
  * Create Publish List
  *