@robosystems/client 1.17.2 → 2.1.0
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/package.json +1 -1
- package/sdk/sdk.gen.d.ts +64 -54
- package/sdk/sdk.gen.js +111 -97
- package/sdk/sdk.gen.ts +97 -83
- package/sdk/types.gen.d.ts +486 -471
- package/sdk/types.gen.ts +486 -471
- package/sdk.gen.d.ts +64 -54
- package/sdk.gen.js +111 -97
- package/sdk.gen.ts +97 -83
- package/types.gen.d.ts +486 -471
- package/types.gen.ts +486 -471
package/sdk.gen.d.ts
CHANGED
|
@@ -784,23 +784,33 @@ export declare const createCheckoutSession: <ThrowOnError extends boolean = fals
|
|
|
784
784
|
*/
|
|
785
785
|
export declare const getCheckoutStatus: <ThrowOnError extends boolean = false>(options: Options<GetCheckoutStatusData, ThrowOnError>) => RequestResult<GetCheckoutStatusResponses, GetCheckoutStatusErrors, ThrowOnError>;
|
|
786
786
|
/**
|
|
787
|
-
*
|
|
787
|
+
* GraphQL explorer (development only)
|
|
788
788
|
*
|
|
789
|
+
* Serves the in-browser GraphiQL explorer on deployments that enable it, which is development only — it is not mounted on the hosted API. Run queries with `POST` to the same URL.
|
|
789
790
|
*
|
|
791
|
+
* Queries are scoped by the URL: `graph_id` is a path parameter and never a query argument, so a document cannot name a graph that disagrees with the path it was sent to. Reads hit the operational (OLTP) extensions database, so they reflect the books as they stand now; the analytical projection is Cypher at `POST /v1/graphs/{graph_id}/query/cypher`.
|
|
792
|
+
*
|
|
793
|
+
* The schema is composed per deployment: ledger fields require RoboLedger and investor fields require RoboInvestor, and a disabled domain is absent from introspection rather than failing at runtime. Every field carries a description, so introspection is the authoritative, deployment-specific reference.
|
|
790
794
|
*
|
|
791
795
|
* **Auth**: pass `X-API-Key` (or a JWT `Authorization: Bearer` header). Unauthenticated introspection queries are deliberately allowed for SDK codegen; data queries require credentials and raise `UNAUTHENTICATED`.
|
|
792
796
|
*
|
|
793
|
-
* **Error codes**: `LEDGER_NOT_INITIALIZED`, `INVESTOR_NOT_INITIALIZED`, and `UNAUTHENTICATED` surface in the GraphQL `errors[].extensions.code` field
|
|
797
|
+
* **Error codes**: `LEDGER_NOT_INITIALIZED`, `INVESTOR_NOT_INITIALIZED`, and `UNAUTHENTICATED` surface in the GraphQL `errors[].extensions.code` field. GraphQL reports errors with HTTP 200 and a populated `errors[]`, so check that array rather than the status code.
|
|
794
798
|
*/
|
|
795
799
|
export declare const handleHttpGetExtensionsGraphIdGraphqlGet: <ThrowOnError extends boolean = false>(options: Options<HandleHttpGetExtensionsGraphIdGraphqlGetData, ThrowOnError>) => RequestResult<HandleHttpGetExtensionsGraphIdGraphqlGetResponses, HandleHttpGetExtensionsGraphIdGraphqlGetErrors, ThrowOnError>;
|
|
796
800
|
/**
|
|
797
|
-
*
|
|
801
|
+
* Run a GraphQL query
|
|
802
|
+
*
|
|
803
|
+
* The typed read surface for a graph's extensions data — RoboLedger and RoboInvestor records as they stand right now. Writes are not here: they are the named operations at `POST /extensions/{domain}/{graph_id}/operations/{name}`.
|
|
798
804
|
*
|
|
805
|
+
* Send a standard GraphQL POST body: a `query` document, with optional `variables` and `operationName`.
|
|
799
806
|
*
|
|
807
|
+
* Queries are scoped by the URL: `graph_id` is a path parameter and never a query argument, so a document cannot name a graph that disagrees with the path it was sent to. Reads hit the operational (OLTP) extensions database, so they reflect the books as they stand now; the analytical projection is Cypher at `POST /v1/graphs/{graph_id}/query/cypher`.
|
|
808
|
+
*
|
|
809
|
+
* The schema is composed per deployment: ledger fields require RoboLedger and investor fields require RoboInvestor, and a disabled domain is absent from introspection rather than failing at runtime. Every field carries a description, so introspection is the authoritative, deployment-specific reference.
|
|
800
810
|
*
|
|
801
811
|
* **Auth**: pass `X-API-Key` (or a JWT `Authorization: Bearer` header). Unauthenticated introspection queries are deliberately allowed for SDK codegen; data queries require credentials and raise `UNAUTHENTICATED`.
|
|
802
812
|
*
|
|
803
|
-
* **Error codes**: `LEDGER_NOT_INITIALIZED`, `INVESTOR_NOT_INITIALIZED`, and `UNAUTHENTICATED` surface in the GraphQL `errors[].extensions.code` field
|
|
813
|
+
* **Error codes**: `LEDGER_NOT_INITIALIZED`, `INVESTOR_NOT_INITIALIZED`, and `UNAUTHENTICATED` surface in the GraphQL `errors[].extensions.code` field. GraphQL reports errors with HTTP 200 and a populated `errors[]`, so check that array rather than the status code.
|
|
804
814
|
*/
|
|
805
815
|
export declare const handleHttpPostExtensionsGraphIdGraphqlPost: <ThrowOnError extends boolean = false>(options: Options<HandleHttpPostExtensionsGraphIdGraphqlPostData, ThrowOnError>) => RequestResult<HandleHttpPostExtensionsGraphIdGraphqlPostResponses, HandleHttpPostExtensionsGraphIdGraphqlPostErrors, ThrowOnError>;
|
|
806
816
|
/**
|
|
@@ -811,6 +821,14 @@ export declare const handleHttpPostExtensionsGraphIdGraphqlPost: <ThrowOnError e
|
|
|
811
821
|
* **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.
|
|
812
822
|
*/
|
|
813
823
|
export declare const initializeLedger: <ThrowOnError extends boolean = false>(options: Options<InitializeLedgerData, ThrowOnError>) => RequestResult<InitializeLedgerResponses, InitializeLedgerErrors, ThrowOnError>;
|
|
824
|
+
/**
|
|
825
|
+
* Initialize Chart of Accounts
|
|
826
|
+
*
|
|
827
|
+
* 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.
|
|
828
|
+
*
|
|
829
|
+
* **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.
|
|
830
|
+
*/
|
|
831
|
+
export declare const initializeChartOfAccounts: <ThrowOnError extends boolean = false>(options: Options<InitializeChartOfAccountsData, ThrowOnError>) => RequestResult<InitializeChartOfAccountsResponses, InitializeChartOfAccountsErrors, ThrowOnError>;
|
|
814
832
|
/**
|
|
815
833
|
* Update Entity
|
|
816
834
|
*
|
|
@@ -835,14 +853,6 @@ export declare const changeReportingStyle: <ThrowOnError extends boolean = false
|
|
|
835
853
|
* **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.
|
|
836
854
|
*/
|
|
837
855
|
export declare const createTaxonomyBlock: <ThrowOnError extends boolean = false>(options: Options<CreateTaxonomyBlockData, ThrowOnError>) => RequestResult<CreateTaxonomyBlockResponses, CreateTaxonomyBlockErrors, ThrowOnError>;
|
|
838
|
-
/**
|
|
839
|
-
* Initialize Chart of Accounts
|
|
840
|
-
*
|
|
841
|
-
* 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.
|
|
842
|
-
*
|
|
843
|
-
* **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.
|
|
844
|
-
*/
|
|
845
|
-
export declare const initializeChartOfAccounts: <ThrowOnError extends boolean = false>(options: Options<InitializeChartOfAccountsData, ThrowOnError>) => RequestResult<InitializeChartOfAccountsResponses, InitializeChartOfAccountsErrors, ThrowOnError>;
|
|
846
856
|
/**
|
|
847
857
|
* Update Taxonomy Block
|
|
848
858
|
*
|
|
@@ -982,7 +992,7 @@ export declare const createEventBlock: <ThrowOnError extends boolean = false>(op
|
|
|
982
992
|
/**
|
|
983
993
|
* Update Event Block
|
|
984
994
|
*
|
|
985
|
-
* 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.
|
|
995
|
+
* 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.
|
|
986
996
|
*
|
|
987
997
|
* **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.
|
|
988
998
|
*/
|
|
@@ -1052,61 +1062,61 @@ export declare const updateJournalEntry: <ThrowOnError extends boolean = false>(
|
|
|
1052
1062
|
*/
|
|
1053
1063
|
export declare const deleteJournalEntry: <ThrowOnError extends boolean = false>(options: Options<DeleteJournalEntryData, ThrowOnError>) => RequestResult<DeleteJournalEntryResponses, DeleteJournalEntryErrors, ThrowOnError>;
|
|
1054
1064
|
/**
|
|
1055
|
-
*
|
|
1065
|
+
* Set Close Target
|
|
1056
1066
|
*
|
|
1057
|
-
*
|
|
1067
|
+
* 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`.
|
|
1058
1068
|
*
|
|
1059
1069
|
* **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.
|
|
1060
1070
|
*/
|
|
1061
|
-
export declare const
|
|
1071
|
+
export declare const setCloseTarget: <ThrowOnError extends boolean = false>(options: Options<SetCloseTargetData, ThrowOnError>) => RequestResult<SetCloseTargetResponses, SetCloseTargetErrors, ThrowOnError>;
|
|
1062
1072
|
/**
|
|
1063
|
-
*
|
|
1073
|
+
* Close Fiscal Period
|
|
1064
1074
|
*
|
|
1065
|
-
*
|
|
1075
|
+
* 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).
|
|
1066
1076
|
*
|
|
1067
1077
|
* **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.
|
|
1068
1078
|
*/
|
|
1069
|
-
export declare const
|
|
1079
|
+
export declare const closePeriod: <ThrowOnError extends boolean = false>(options: Options<ClosePeriodData, ThrowOnError>) => RequestResult<ClosePeriodResponses, ClosePeriodErrors, ThrowOnError>;
|
|
1070
1080
|
/**
|
|
1071
|
-
*
|
|
1081
|
+
* Reopen Fiscal Period
|
|
1072
1082
|
*
|
|
1073
|
-
*
|
|
1083
|
+
* 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).
|
|
1074
1084
|
*
|
|
1075
1085
|
* **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.
|
|
1076
1086
|
*/
|
|
1077
|
-
export declare const
|
|
1087
|
+
export declare const reopenPeriod: <ThrowOnError extends boolean = false>(options: Options<ReopenPeriodData, ThrowOnError>) => RequestResult<ReopenPeriodResponses, ReopenPeriodErrors, ThrowOnError>;
|
|
1078
1088
|
/**
|
|
1079
|
-
*
|
|
1089
|
+
* Backfill Plan History
|
|
1080
1090
|
*
|
|
1081
|
-
*
|
|
1091
|
+
* 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.
|
|
1082
1092
|
*
|
|
1083
1093
|
* **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.
|
|
1084
1094
|
*/
|
|
1085
|
-
export declare const
|
|
1095
|
+
export declare const backfillPlanHistory: <ThrowOnError extends boolean = false>(options: Options<BackfillPlanHistoryData, ThrowOnError>) => RequestResult<BackfillPlanHistoryResponses, BackfillPlanHistoryErrors, ThrowOnError>;
|
|
1086
1096
|
/**
|
|
1087
|
-
*
|
|
1097
|
+
* Promote Due Schedule Obligations
|
|
1088
1098
|
*
|
|
1089
|
-
*
|
|
1099
|
+
* 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.
|
|
1090
1100
|
*
|
|
1091
1101
|
* **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.
|
|
1092
1102
|
*/
|
|
1093
|
-
export declare const
|
|
1103
|
+
export declare const promoteObligations: <ThrowOnError extends boolean = false>(options: Options<PromoteObligationsData, ThrowOnError>) => RequestResult<PromoteObligationsResponses, PromoteObligationsErrors, ThrowOnError>;
|
|
1094
1104
|
/**
|
|
1095
|
-
*
|
|
1105
|
+
* Rebuild Schedule In Place
|
|
1096
1106
|
*
|
|
1097
|
-
*
|
|
1107
|
+
* 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.
|
|
1098
1108
|
*
|
|
1099
1109
|
* **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.
|
|
1100
1110
|
*/
|
|
1101
|
-
export declare const
|
|
1111
|
+
export declare const rebuildSchedule: <ThrowOnError extends boolean = false>(options: Options<RebuildScheduleData, ThrowOnError>) => RequestResult<RebuildScheduleResponses, RebuildScheduleErrors, ThrowOnError>;
|
|
1102
1112
|
/**
|
|
1103
|
-
*
|
|
1113
|
+
* Terminate Schedule Early
|
|
1104
1114
|
*
|
|
1105
|
-
*
|
|
1115
|
+
* 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.
|
|
1106
1116
|
*
|
|
1107
1117
|
* **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.
|
|
1108
1118
|
*/
|
|
1109
|
-
export declare const
|
|
1119
|
+
export declare const terminateSchedule: <ThrowOnError extends boolean = false>(options: Options<TerminateScheduleData, ThrowOnError>) => RequestResult<TerminateScheduleResponses, TerminateScheduleErrors, ThrowOnError>;
|
|
1110
1120
|
/**
|
|
1111
1121
|
* Create Report
|
|
1112
1122
|
*
|
|
@@ -1132,37 +1142,37 @@ export declare const regenerateReport: <ThrowOnError extends boolean = false>(op
|
|
|
1132
1142
|
*/
|
|
1133
1143
|
export declare const deleteReport: <ThrowOnError extends boolean = false>(options: Options<DeleteReportData, ThrowOnError>) => RequestResult<DeleteReportResponses, DeleteReportErrors, ThrowOnError>;
|
|
1134
1144
|
/**
|
|
1135
|
-
*
|
|
1145
|
+
* File Report
|
|
1136
1146
|
*
|
|
1137
|
-
*
|
|
1147
|
+
* Transitions the Report's filing_status to 'filed' — locks the package. Allowed from 'draft' or 'under_review'. Stamps filed_at + filed_by.
|
|
1138
1148
|
*
|
|
1139
1149
|
* **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.
|
|
1140
1150
|
*/
|
|
1141
|
-
export declare const
|
|
1151
|
+
export declare const fileReport: <ThrowOnError extends boolean = false>(options: Options<FileReportData, ThrowOnError>) => RequestResult<FileReportResponses, FileReportErrors, ThrowOnError>;
|
|
1142
1152
|
/**
|
|
1143
|
-
*
|
|
1153
|
+
* Transition Filing Status
|
|
1144
1154
|
*
|
|
1145
|
-
*
|
|
1155
|
+
* 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.
|
|
1146
1156
|
*
|
|
1147
1157
|
* **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.
|
|
1148
1158
|
*/
|
|
1149
|
-
export declare const
|
|
1159
|
+
export declare const transitionFilingStatus: <ThrowOnError extends boolean = false>(options: Options<TransitionFilingStatusData, ThrowOnError>) => RequestResult<TransitionFilingStatusResponses, TransitionFilingStatusErrors, ThrowOnError>;
|
|
1150
1160
|
/**
|
|
1151
|
-
*
|
|
1161
|
+
* Share Report
|
|
1152
1162
|
*
|
|
1153
|
-
*
|
|
1163
|
+
* 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`.
|
|
1154
1164
|
*
|
|
1155
1165
|
* **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.
|
|
1156
1166
|
*/
|
|
1157
|
-
export declare const
|
|
1167
|
+
export declare const shareReport: <ThrowOnError extends boolean = false>(options: Options<ShareReportData, ThrowOnError>) => RequestResult<ShareReportResponses, ShareReportErrors, ThrowOnError>;
|
|
1158
1168
|
/**
|
|
1159
|
-
*
|
|
1169
|
+
* Revoke Report Share
|
|
1160
1170
|
*
|
|
1161
|
-
*
|
|
1171
|
+
* 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.
|
|
1162
1172
|
*
|
|
1163
1173
|
* **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.
|
|
1164
1174
|
*/
|
|
1165
|
-
export declare const
|
|
1175
|
+
export declare const revokeReportShare: <ThrowOnError extends boolean = false>(options: Options<RevokeReportShareData, ThrowOnError>) => RequestResult<RevokeReportShareResponses, RevokeReportShareErrors, ThrowOnError>;
|
|
1166
1176
|
/**
|
|
1167
1177
|
* Create Publish List
|
|
1168
1178
|
*
|
|
@@ -1219,14 +1229,6 @@ export declare const blockSourceGraph: <ThrowOnError extends boolean = false>(op
|
|
|
1219
1229
|
* **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.
|
|
1220
1230
|
*/
|
|
1221
1231
|
export declare const unblockSourceGraph: <ThrowOnError extends boolean = false>(options: Options<UnblockSourceGraphData, ThrowOnError>) => RequestResult<UnblockSourceGraphResponses, UnblockSourceGraphErrors, ThrowOnError>;
|
|
1222
|
-
/**
|
|
1223
|
-
* Live Financial Statement
|
|
1224
|
-
*
|
|
1225
|
-
* Generate an ad-hoc financial statement directly from the tenant's OLTP ledger data using the active CoA→GAAP mapping. This is the authoritative source for RoboLedger entity graphs — no graph materialization required. Rejected on shared-repository graphs; those should use `financial-statement-analysis` instead.
|
|
1226
|
-
*
|
|
1227
|
-
* **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.
|
|
1228
|
-
*/
|
|
1229
|
-
export declare const liveFinancialStatement: <ThrowOnError extends boolean = false>(options: Options<LiveFinancialStatementData, ThrowOnError>) => RequestResult<LiveFinancialStatementResponses, LiveFinancialStatementErrors, ThrowOnError>;
|
|
1230
1232
|
/**
|
|
1231
1233
|
* Build Fact Grid
|
|
1232
1234
|
*
|
|
@@ -1259,6 +1261,14 @@ export declare const disclosures: <ThrowOnError extends boolean = false>(options
|
|
|
1259
1261
|
* **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.
|
|
1260
1262
|
*/
|
|
1261
1263
|
export declare const informationBlock: <ThrowOnError extends boolean = false>(options: Options<InformationBlockData, ThrowOnError>) => RequestResult<InformationBlockResponses, InformationBlockErrors, ThrowOnError>;
|
|
1264
|
+
/**
|
|
1265
|
+
* Live Financial Statement
|
|
1266
|
+
*
|
|
1267
|
+
* Generate an ad-hoc financial statement directly from the tenant's OLTP ledger data using the active CoA→GAAP mapping. This is the authoritative source for RoboLedger entity graphs — no graph materialization required. Rejected on shared-repository graphs; those should use `financial-statement-analysis` instead.
|
|
1268
|
+
*
|
|
1269
|
+
* **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.
|
|
1270
|
+
*/
|
|
1271
|
+
export declare const liveFinancialStatement: <ThrowOnError extends boolean = false>(options: Options<LiveFinancialStatementData, ThrowOnError>) => RequestResult<LiveFinancialStatementResponses, LiveFinancialStatementErrors, ThrowOnError>;
|
|
1262
1272
|
/**
|
|
1263
1273
|
* Create Portfolio Block
|
|
1264
1274
|
*
|