@robosystems/client 2.38.1 → 2.39.1
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/InvestorClient.d.ts +4 -2
- package/artifacts/InvestorClient.js +4 -2
- package/artifacts/InvestorClient.ts +4 -2
- package/artifacts/LedgerClient.d.ts +31 -23
- package/artifacts/LedgerClient.js +27 -19
- package/artifacts/LedgerClient.ts +34 -26
- package/artifacts/LibraryClient.d.ts +4 -4
- package/artifacts/LibraryClient.js +4 -4
- package/artifacts/LibraryClient.ts +5 -5
- package/artifacts/OperatorClient.d.ts +2 -2
- package/artifacts/OperatorClient.js +2 -2
- package/artifacts/OperatorClient.ts +2 -2
- package/artifacts/graphql/queries/ledger/flowCandidates.d.ts +1 -1
- package/artifacts/graphql/queries/ledger/flowCandidates.js +1 -1
- package/artifacts/graphql/queries/ledger/flowCandidates.ts +1 -1
- package/artifacts/graphql/queries/ledger/informationBlock.d.ts +3 -5
- package/artifacts/graphql/queries/ledger/informationBlock.js +3 -5
- package/artifacts/graphql/queries/ledger/informationBlock.ts +3 -5
- package/artifacts/graphql/queries/ledger/mappedTrialBalance.d.ts +1 -1
- package/artifacts/graphql/queries/ledger/mappedTrialBalance.js +1 -1
- package/artifacts/graphql/queries/ledger/mappedTrialBalance.ts +1 -1
- package/artifacts/graphql/queries/ledger/mappingCoverage.d.ts +1 -1
- package/artifacts/graphql/queries/ledger/mappingCoverage.js +1 -1
- package/artifacts/graphql/queries/ledger/mappingCoverage.ts +1 -1
- package/artifacts/graphql/queries/ledger/reportDownloadUrl.d.ts +3 -2
- package/artifacts/graphql/queries/ledger/reportDownloadUrl.js +3 -2
- package/artifacts/graphql/queries/ledger/reportDownloadUrl.ts +3 -2
- package/artifacts/graphql/queries/ledger/reportingTaxonomy.d.ts +3 -3
- package/artifacts/graphql/queries/ledger/reportingTaxonomy.js +3 -3
- package/artifacts/graphql/queries/ledger/reportingTaxonomy.ts +3 -3
- package/artifacts/graphql/queries/ledger/statement.d.ts +5 -4
- package/artifacts/graphql/queries/ledger/statement.js +5 -4
- package/artifacts/graphql/queries/ledger/statement.ts +5 -4
- package/artifacts/graphql/queries/ledger/structures.d.ts +1 -1
- package/artifacts/graphql/queries/ledger/structures.js +1 -1
- package/artifacts/graphql/queries/ledger/structures.ts +1 -1
- package/artifacts/graphql/queries/ledger/unmappedElements.d.ts +1 -1
- package/artifacts/graphql/queries/ledger/unmappedElements.js +1 -1
- package/artifacts/graphql/queries/ledger/unmappedElements.ts +1 -1
- package/artifacts/graphql/queries/library/arcs.d.ts +1 -1
- package/artifacts/graphql/queries/library/arcs.js +1 -1
- package/artifacts/graphql/queries/library/arcs.ts +1 -1
- package/artifacts/graphql/queries/library/elements.d.ts +1 -1
- package/artifacts/graphql/queries/library/elements.js +1 -1
- package/artifacts/graphql/queries/library/elements.ts +1 -1
- package/artifacts/hooks.d.ts +8 -8
- package/artifacts/hooks.js +8 -8
- package/artifacts/hooks.ts +8 -8
- package/package.json +1 -1
- package/sdk/sdk.gen.d.ts +15 -15
- package/sdk/sdk.gen.js +15 -15
- package/sdk/sdk.gen.ts +15 -15
- package/sdk/types.gen.d.ts +77 -68
- package/sdk/types.gen.ts +77 -68
- package/sdk.gen.d.ts +15 -15
- package/sdk.gen.js +15 -15
- package/sdk.gen.ts +15 -15
- package/types.gen.d.ts +77 -68
- package/types.gen.ts +77 -68
package/sdk.gen.js
CHANGED
|
@@ -718,7 +718,7 @@ exports.listOperators = listOperators;
|
|
|
718
718
|
/**
|
|
719
719
|
* Auto-select Operator for Query
|
|
720
720
|
*
|
|
721
|
-
* Routes to the best operator for your query. Operators: `analyst` (answers natural-language questions over the graph — curated financial reads, documents, memory, and read-only Cypher; supports `quick`, `standard`, `extended`; `cypher` is accepted as its former name) and `mapping` (
|
|
721
|
+
* Routes to the best operator for your query. Operators: `analyst` (answers natural-language questions over the graph — curated financial reads, documents, memory, and read-only Cypher; supports `quick`, `standard`, `extended`; `cypher` is accepted as its former name) and `mapping` (automatic Chart of Accounts → rs-gaap mapping; roboledger graphs only, `extended` only). `author` makes writes, so it is never chosen here: call it by name. `GET /v1/graphs/{graph_id}/operator` lists what is registered. Credits are consumed by actual token usage, not a fixed price per mode. The run executes on the background worker: the default answer is 202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits up to 50s and answers 200 with the result.
|
|
722
722
|
*/
|
|
723
723
|
const autoSelectOperator = (options) => (options.client ?? client_gen_1.client).post({
|
|
724
724
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -742,7 +742,7 @@ exports.getOperatorMetadata = getOperatorMetadata;
|
|
|
742
742
|
/**
|
|
743
743
|
* Execute Specific Operator
|
|
744
744
|
*
|
|
745
|
-
* Available: `analyst` (natural-language questions over the graph — curated financial reads, documents, memory, and read-only Cypher; RAG retrieval is one of its capabilities, not a separate operator; `cypher` is accepted as its former name)
|
|
745
|
+
* Available: `analyst` (natural-language questions over the graph — curated financial reads, documents, memory, and read-only Cypher; RAG retrieval is one of its capabilities, not a separate operator; `cypher` is accepted as its former name), `mapping` (Chart of Accounts → rs-gaap mapping, roboledger graphs only) and `author` (makes the change a request asks for, such as metric and forecast blocks, counterparties, memories, draft reports and inbox classifications, through writes that are reversible or wait on a person's step; needs write access to the graph). `GET /v1/graphs/{graph_id}/operator` lists what is registered. The run executes on the background worker: the default answer is 202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits up to 50s and answers 200 with the result.
|
|
746
746
|
*/
|
|
747
747
|
const executeSpecificOperator = (options) => (options.client ?? client_gen_1.client).post({
|
|
748
748
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -1062,7 +1062,7 @@ exports.createRepositorySubscription = createRepositorySubscription;
|
|
|
1062
1062
|
/**
|
|
1063
1063
|
* End Repository Trial
|
|
1064
1064
|
*
|
|
1065
|
-
* End your free trial of a shared repository now and start the paid plan. The first period is charged to the payment method on file; raw queries, the AI analyst and the plan's credits open once the payment clears, usually within a minute. Returns 400 when the subscription is not on a trial.
|
|
1065
|
+
* End your free trial of a shared repository now and start the paid plan. The first period is charged to the payment method on file; raw queries, the AI analyst and the plan's credits open once the payment clears, usually within a minute. Returns 400 when the subscription is not on a trial, or when no payment method is on file yet.
|
|
1066
1066
|
*/
|
|
1067
1067
|
const endRepositorySubscriptionTrial = (options) => (options.client ?? client_gen_1.client).post({
|
|
1068
1068
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -1696,7 +1696,7 @@ exports.getOrgUpcomingInvoice = getOrgUpcomingInvoice;
|
|
|
1696
1696
|
/**
|
|
1697
1697
|
* Create Payment Checkout Session
|
|
1698
1698
|
*
|
|
1699
|
-
* Initiates a Stripe checkout session for payment collection. Creates a pending subscription; the webhook activates it and provisions the resource after payment completes. Returns billing_disabled=true with no URL when billing is off. Requires org owner role.
|
|
1699
|
+
* Initiates a Stripe checkout session for payment collection. Creates a pending subscription; the webhook activates it and provisions the resource after payment completes. Returns billing_disabled=true with no URL when billing is off. Requires org owner role. A repository's free trial asks for no card but needs a verified email: an unverified account starting one gets 403.
|
|
1700
1700
|
*/
|
|
1701
1701
|
const createCheckoutSession = (options) => (options.client ?? client_gen_1.client).post({
|
|
1702
1702
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -1800,7 +1800,7 @@ exports.changeCalendarStart = changeCalendarStart;
|
|
|
1800
1800
|
/**
|
|
1801
1801
|
* Initialize Chart of Accounts
|
|
1802
1802
|
*
|
|
1803
|
-
* 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)
|
|
1803
|
+
* 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), `consolidation` (a group's consolidation entity — the adjustments column, never an operating company's chart). 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 entity's). Each entity of the group keeps its own chart: `entity_id` names a subsidiary, omitted means the group parent. One-time per entity: 409 once that entity has a chart — a chart is never replaced. Customize afterwards with update-taxonomy-block; accounts that carry activity are never deleted.
|
|
1804
1804
|
*
|
|
1805
1805
|
* **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.
|
|
1806
1806
|
*/
|
|
@@ -1868,7 +1868,7 @@ exports.changeReportingStyle = changeReportingStyle;
|
|
|
1868
1868
|
/**
|
|
1869
1869
|
* Link Bank Account
|
|
1870
1870
|
*
|
|
1871
|
-
* Point a bank feed's account at a chart account. Name `element_id` for an existing active account, or `entity_id` alone to create one in that entity's chart. The chart the account is in decides whose books the feed's lines go into, so this is also how a feed account is bound to a subsidiary. Lines still in the inbox move with it (across an entity change their suggestion is resolved again on the new chart, and a classification that named the old entity's account is dropped); posted entries stay where they were posted. An account another connection already feeds is refused, as is an entity whose books QuickBooks keeps (the group parent, while QuickBooks is connected). An account the feed created and then left stays on its chart as an ordinary account. A sync already in flight when the link moves can still land a line or two on the old account; running this again moves them.
|
|
1871
|
+
* Point a bank feed's account at a chart account. Name `element_id` for an existing active account, or `entity_id` alone to create one in that entity's chart. The chart the account is in decides whose books the feed's lines go into, so this is also how a feed account is bound to a subsidiary. Lines still in the inbox move with it (across an entity change their suggestion is resolved again on the new chart, and a classification that named the old entity's account is dropped); posted entries stay where they were posted. An account another connection already feeds is refused, as is an entity whose books QuickBooks keeps (the group parent, while QuickBooks is connected). An account the feed created and then left stays on its chart as an ordinary account. A sync already in flight when the link moves can still land a line or two on the old account; running this again moves them. The group's accounts are `list-bank-accounts` over MCP and the `bankAccounts` GraphQL field.
|
|
1872
1872
|
*
|
|
1873
1873
|
* **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.
|
|
1874
1874
|
*/
|
|
@@ -1970,7 +1970,7 @@ exports.createMappingAssociation = createMappingAssociation;
|
|
|
1970
1970
|
/**
|
|
1971
1971
|
* Delete Mapping Association
|
|
1972
1972
|
*
|
|
1973
|
-
* Remove a single CoA → reporting-concept mapping edge by id. The mapping structure itself remains; only the association row is dropped. Use this to correct a wrong mapping — delete the bad edge, then `create-mapping-association` the right one.
|
|
1973
|
+
* Remove a single CoA → reporting-concept mapping edge by id. The mapping structure itself remains; only the association row is dropped. Use this to correct a wrong mapping — delete the bad edge, then `create-mapping-association` the right one. The association id is `list-element-arcs` over MCP and the `libraryElementArcs` GraphQL field. Library-seeded rows cannot be deleted (403). An edge for an account with landed history in a closed month cannot be removed on its own (422): move the account with `create-mapping-association` and `replaces_association_id` instead.
|
|
1974
1974
|
*
|
|
1975
1975
|
* **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.
|
|
1976
1976
|
*/
|
|
@@ -2004,7 +2004,7 @@ exports.autoMapElements = autoMapElements;
|
|
|
2004
2004
|
/**
|
|
2005
2005
|
* Create Information Block
|
|
2006
2006
|
*
|
|
2007
|
-
* Generic Information Block construction entry. `block_type` selects the registered block type; `payload` is validated against that type's creation schema at dispatch.
|
|
2007
|
+
* Generic Information Block construction entry. `block_type` selects the registered block type; `payload` is validated against that type's creation schema at dispatch. Only schedule and forecast are constructed here; the other block types raise 501 with a hint naming their own operation (statements: create-report; disclosure and metric structures: create-taxonomy-block). 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).
|
|
2008
2008
|
*
|
|
2009
2009
|
* **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.
|
|
2010
2010
|
*/
|
|
@@ -2021,7 +2021,7 @@ exports.createInformationBlock = createInformationBlock;
|
|
|
2021
2021
|
/**
|
|
2022
2022
|
* Update Information Block
|
|
2023
2023
|
*
|
|
2024
|
-
* Generic Information Block update entry. Dispatches by `block_type` to the registered mutation handler.
|
|
2024
|
+
* Generic Information Block update entry. Dispatches by `block_type` to the registered mutation handler. Only schedule and forecast blocks update here; the statement family (library-seeded and immutable), disclosure, metric and reconciliation blocks surface 501 with a hint naming the operation that changes them.
|
|
2025
2025
|
*
|
|
2026
2026
|
* **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.
|
|
2027
2027
|
*/
|
|
@@ -2038,7 +2038,7 @@ exports.updateInformationBlock = updateInformationBlock;
|
|
|
2038
2038
|
/**
|
|
2039
2039
|
* Delete Information Block
|
|
2040
2040
|
*
|
|
2041
|
-
* Generic Information Block deletion entry. Returns a thin confirmation (deleted / structure_id / block_type / name).
|
|
2041
|
+
* Generic Information Block deletion entry. Returns a thin confirmation (deleted / structure_id / block_type / name). Only schedule and forecast blocks delete here; statement, disclosure, metric and reconciliation blocks surface 501 with a hint naming the operation that manages them.
|
|
2042
2042
|
*
|
|
2043
2043
|
* **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.
|
|
2044
2044
|
*/
|
|
@@ -2106,7 +2106,7 @@ exports.assertMetrics = assertMetrics;
|
|
|
2106
2106
|
/**
|
|
2107
2107
|
* Compute Forecast for a Forecast Block
|
|
2108
2108
|
*
|
|
2109
|
-
* Walks a forecast block's driver cascade month-by-month forward from its
|
|
2109
|
+
* Walks a forecast block's driver cascade month-by-month forward from its anchor (with base_anchor='seam', the default, the newest closed month inside the horizon; with 'fixed', the block's base_period): lever-driven rs-driver Derive rules in dependency order, carry-forward for unmodeled income-statement lines, calc-DAG subtotals — upserting per forward month a scenario income-statement FactSet, a balance-sheet set (the full roll when the anchor month has an actual balance sheet, else only the rule-driven working-capital instants) and a derived cash-flow set when an actual one exists, all keyed by the block's scenario_id (NULL = actuals; scenario reads pass it as a filter). Re-running replaces each month's values. Rules with missing lever months or unbound operands are skipped with a reason (their targets fall back to carry-forward). Each month's sets are verified; a month that fails halts the walk there (halted_at), since every later month would be derived from it. Deterministic and non-AI — no credits consumed.
|
|
2110
2110
|
*
|
|
2111
2111
|
* **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.
|
|
2112
2112
|
*/
|
|
@@ -2276,7 +2276,7 @@ exports.updateEventBlock = updateEventBlock;
|
|
|
2276
2276
|
/**
|
|
2277
2277
|
* Execute Event Block
|
|
2278
2278
|
*
|
|
2279
|
-
* For events on a connection with write_policy='qb_authoritative' or 'hybrid', publish the event's draft GL entries to the source-of-truth system (QuickBooks), each as its own JournalEntry. Records the QuickBooks ids per entry on event.metadata.qb_entry_ids and promotes the published entries to 'posted'; the event goes 'fulfilled' once no draft remains
|
|
2279
|
+
* For events on a connection with write_policy='qb_authoritative' or 'hybrid', publish the event's draft GL entries to the source-of-truth system (QuickBooks), each as its own JournalEntry. Records the QuickBooks ids per entry on event.metadata.qb_entry_ids and promotes the published entries to 'posted'; the event goes 'fulfilled' once no draft remains. On rejection what landed is kept, the status is unchanged and the error is stamped on event.metadata.last_outbound_error (and returned as qb_error). Events on 'native' or 'shadow' books pass through with no QB write. Only the group parent's books are QuickBooks': an event on a subsidiary's books is refused.
|
|
2280
2280
|
*
|
|
2281
2281
|
* **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.
|
|
2282
2282
|
*/
|
|
@@ -2684,7 +2684,7 @@ exports.promoteObligations = promoteObligations;
|
|
|
2684
2684
|
/**
|
|
2685
2685
|
* Preview Schedule
|
|
2686
2686
|
*
|
|
2687
|
-
* Generate a schedule from a definition without keeping it: the same generator and guards as creating one (block_type='schedule' on create-information-block), run and rolled back. Returns the envelope create would leave (its ids provisional) and the period-by-period roll-forward: the balance the schedule carries on the account it credits (a loan's: the note), opening, the period's amount, closing, and for a loan the interest, payment, principal and current portion. Show it to the person before asking to create. A definition create would refuse (a roll-forward that climbs where it should fall, legs that do not balance) is refused here with the period that breaks. `warnings` names any active schedule already posting the same accounts in the same months. With `replaces_structure_id`, `replaces` says what the schedule being edited or recreated has posted, by month, and the path the change takes: `rebuild` (
|
|
2687
|
+
* Generate a schedule from a definition without keeping it: the same generator and guards as creating one (block_type='schedule' on create-information-block), run and rolled back. Returns the envelope create would leave (its ids provisional) and the period-by-period roll-forward: the balance the schedule carries on the account it credits (a loan's: the note), opening, the period's amount, closing, and for a loan the interest, payment, principal and current portion. Show it to the person before asking to create. A definition create would refuse (a roll-forward that climbs where it should fall, legs that do not balance) is refused here with the period that breaks. `warnings` names any active schedule already posting the same accounts in the same months. With `replaces_structure_id`, `replaces` says what the schedule being edited or recreated has posted, by month, and the path the change takes: `rebuild` (the schedule regenerated in place from the new definition) while nothing has posted, `terminate_and_succeed` after.
|
|
2688
2688
|
*
|
|
2689
2689
|
* **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.
|
|
2690
2690
|
*/
|
|
@@ -2905,7 +2905,7 @@ exports.deletePublishList = deletePublishList;
|
|
|
2905
2905
|
/**
|
|
2906
2906
|
* Add Members to Publish List
|
|
2907
2907
|
*
|
|
2908
|
-
* Add one or more recipient graphs to a publish list. Targets must exist and
|
|
2908
|
+
* Add one or more recipient graphs to a publish list. Targets must exist and carry the roboledger or roboinvestor extension. Self-graph rejected (422); already-member rejected (409).
|
|
2909
2909
|
*
|
|
2910
2910
|
* **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.
|
|
2911
2911
|
*/
|
|
@@ -3194,7 +3194,7 @@ exports.deletePortfolioBlock = deletePortfolioBlock;
|
|
|
3194
3194
|
/**
|
|
3195
3195
|
* Create Security
|
|
3196
3196
|
*
|
|
3197
|
-
* Register a security (common stock, preferred stock, warrant, convertible note, etc.)
|
|
3197
|
+
* Register a security (common stock, preferred stock, warrant, convertible note, etc.) in this graph's registry. Its `entity_id` is the issuer, not the holder; a portfolio's `entity_id` is the owner. Optionally cross-links to the issuer's own graph via `source_graph_id` for mutual-handshake attribution.
|
|
3198
3198
|
*
|
|
3199
3199
|
* **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.
|
|
3200
3200
|
*/
|
package/sdk.gen.ts
CHANGED
|
@@ -729,7 +729,7 @@ export const listOperators = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
729
729
|
/**
|
|
730
730
|
* Auto-select Operator for Query
|
|
731
731
|
*
|
|
732
|
-
* Routes to the best operator for your query. Operators: `analyst` (answers natural-language questions over the graph — curated financial reads, documents, memory, and read-only Cypher; supports `quick`, `standard`, `extended`; `cypher` is accepted as its former name) and `mapping` (
|
|
732
|
+
* Routes to the best operator for your query. Operators: `analyst` (answers natural-language questions over the graph — curated financial reads, documents, memory, and read-only Cypher; supports `quick`, `standard`, `extended`; `cypher` is accepted as its former name) and `mapping` (automatic Chart of Accounts → rs-gaap mapping; roboledger graphs only, `extended` only). `author` makes writes, so it is never chosen here: call it by name. `GET /v1/graphs/{graph_id}/operator` lists what is registered. Credits are consumed by actual token usage, not a fixed price per mode. The run executes on the background worker: the default answer is 202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits up to 50s and answers 200 with the result.
|
|
733
733
|
*/
|
|
734
734
|
export const autoSelectOperator = <ThrowOnError extends boolean = false>(options: Options<AutoSelectOperatorData, ThrowOnError>): RequestResult<AutoSelectOperatorResponses, AutoSelectOperatorErrors, ThrowOnError> => (options.client ?? client).post<AutoSelectOperatorResponses, AutoSelectOperatorErrors, ThrowOnError>({
|
|
735
735
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -753,7 +753,7 @@ export const getOperatorMetadata = <ThrowOnError extends boolean = false>(option
|
|
|
753
753
|
/**
|
|
754
754
|
* Execute Specific Operator
|
|
755
755
|
*
|
|
756
|
-
* Available: `analyst` (natural-language questions over the graph — curated financial reads, documents, memory, and read-only Cypher; RAG retrieval is one of its capabilities, not a separate operator; `cypher` is accepted as its former name)
|
|
756
|
+
* Available: `analyst` (natural-language questions over the graph — curated financial reads, documents, memory, and read-only Cypher; RAG retrieval is one of its capabilities, not a separate operator; `cypher` is accepted as its former name), `mapping` (Chart of Accounts → rs-gaap mapping, roboledger graphs only) and `author` (makes the change a request asks for, such as metric and forecast blocks, counterparties, memories, draft reports and inbox classifications, through writes that are reversible or wait on a person's step; needs write access to the graph). `GET /v1/graphs/{graph_id}/operator` lists what is registered. The run executes on the background worker: the default answer is 202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits up to 50s and answers 200 with the result.
|
|
757
757
|
*/
|
|
758
758
|
export const executeSpecificOperator = <ThrowOnError extends boolean = false>(options: Options<ExecuteSpecificOperatorData, ThrowOnError>): RequestResult<ExecuteSpecificOperatorResponses, ExecuteSpecificOperatorErrors, ThrowOnError> => (options.client ?? client).post<ExecuteSpecificOperatorResponses, ExecuteSpecificOperatorErrors, ThrowOnError>({
|
|
759
759
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -1073,7 +1073,7 @@ export const createRepositorySubscription = <ThrowOnError extends boolean = fals
|
|
|
1073
1073
|
/**
|
|
1074
1074
|
* End Repository Trial
|
|
1075
1075
|
*
|
|
1076
|
-
* End your free trial of a shared repository now and start the paid plan. The first period is charged to the payment method on file; raw queries, the AI analyst and the plan's credits open once the payment clears, usually within a minute. Returns 400 when the subscription is not on a trial.
|
|
1076
|
+
* End your free trial of a shared repository now and start the paid plan. The first period is charged to the payment method on file; raw queries, the AI analyst and the plan's credits open once the payment clears, usually within a minute. Returns 400 when the subscription is not on a trial, or when no payment method is on file yet.
|
|
1077
1077
|
*/
|
|
1078
1078
|
export const endRepositorySubscriptionTrial = <ThrowOnError extends boolean = false>(options: Options<EndRepositorySubscriptionTrialData, ThrowOnError>): RequestResult<EndRepositorySubscriptionTrialResponses, EndRepositorySubscriptionTrialErrors, ThrowOnError> => (options.client ?? client).post<EndRepositorySubscriptionTrialResponses, EndRepositorySubscriptionTrialErrors, ThrowOnError>({
|
|
1079
1079
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -1707,7 +1707,7 @@ export const getOrgUpcomingInvoice = <ThrowOnError extends boolean = false>(opti
|
|
|
1707
1707
|
/**
|
|
1708
1708
|
* Create Payment Checkout Session
|
|
1709
1709
|
*
|
|
1710
|
-
* Initiates a Stripe checkout session for payment collection. Creates a pending subscription; the webhook activates it and provisions the resource after payment completes. Returns billing_disabled=true with no URL when billing is off. Requires org owner role.
|
|
1710
|
+
* Initiates a Stripe checkout session for payment collection. Creates a pending subscription; the webhook activates it and provisions the resource after payment completes. Returns billing_disabled=true with no URL when billing is off. Requires org owner role. A repository's free trial asks for no card but needs a verified email: an unverified account starting one gets 403.
|
|
1711
1711
|
*/
|
|
1712
1712
|
export const createCheckoutSession = <ThrowOnError extends boolean = false>(options: Options<CreateCheckoutSessionData, ThrowOnError>): RequestResult<CreateCheckoutSessionResponses, CreateCheckoutSessionErrors, ThrowOnError> => (options.client ?? client).post<CreateCheckoutSessionResponses, CreateCheckoutSessionErrors, ThrowOnError>({
|
|
1713
1713
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -1811,7 +1811,7 @@ export const changeCalendarStart = <ThrowOnError extends boolean = false>(option
|
|
|
1811
1811
|
/**
|
|
1812
1812
|
* Initialize Chart of Accounts
|
|
1813
1813
|
*
|
|
1814
|
-
* 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)
|
|
1814
|
+
* 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), `consolidation` (a group's consolidation entity — the adjustments column, never an operating company's chart). 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 entity's). Each entity of the group keeps its own chart: `entity_id` names a subsidiary, omitted means the group parent. One-time per entity: 409 once that entity has a chart — a chart is never replaced. Customize afterwards with update-taxonomy-block; accounts that carry activity are never deleted.
|
|
1815
1815
|
*
|
|
1816
1816
|
* **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.
|
|
1817
1817
|
*/
|
|
@@ -1879,7 +1879,7 @@ export const changeReportingStyle = <ThrowOnError extends boolean = false>(optio
|
|
|
1879
1879
|
/**
|
|
1880
1880
|
* Link Bank Account
|
|
1881
1881
|
*
|
|
1882
|
-
* Point a bank feed's account at a chart account. Name `element_id` for an existing active account, or `entity_id` alone to create one in that entity's chart. The chart the account is in decides whose books the feed's lines go into, so this is also how a feed account is bound to a subsidiary. Lines still in the inbox move with it (across an entity change their suggestion is resolved again on the new chart, and a classification that named the old entity's account is dropped); posted entries stay where they were posted. An account another connection already feeds is refused, as is an entity whose books QuickBooks keeps (the group parent, while QuickBooks is connected). An account the feed created and then left stays on its chart as an ordinary account. A sync already in flight when the link moves can still land a line or two on the old account; running this again moves them.
|
|
1882
|
+
* Point a bank feed's account at a chart account. Name `element_id` for an existing active account, or `entity_id` alone to create one in that entity's chart. The chart the account is in decides whose books the feed's lines go into, so this is also how a feed account is bound to a subsidiary. Lines still in the inbox move with it (across an entity change their suggestion is resolved again on the new chart, and a classification that named the old entity's account is dropped); posted entries stay where they were posted. An account another connection already feeds is refused, as is an entity whose books QuickBooks keeps (the group parent, while QuickBooks is connected). An account the feed created and then left stays on its chart as an ordinary account. A sync already in flight when the link moves can still land a line or two on the old account; running this again moves them. The group's accounts are `list-bank-accounts` over MCP and the `bankAccounts` GraphQL field.
|
|
1883
1883
|
*
|
|
1884
1884
|
* **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.
|
|
1885
1885
|
*/
|
|
@@ -1981,7 +1981,7 @@ export const createMappingAssociation = <ThrowOnError extends boolean = false>(o
|
|
|
1981
1981
|
/**
|
|
1982
1982
|
* Delete Mapping Association
|
|
1983
1983
|
*
|
|
1984
|
-
* Remove a single CoA → reporting-concept mapping edge by id. The mapping structure itself remains; only the association row is dropped. Use this to correct a wrong mapping — delete the bad edge, then `create-mapping-association` the right one.
|
|
1984
|
+
* Remove a single CoA → reporting-concept mapping edge by id. The mapping structure itself remains; only the association row is dropped. Use this to correct a wrong mapping — delete the bad edge, then `create-mapping-association` the right one. The association id is `list-element-arcs` over MCP and the `libraryElementArcs` GraphQL field. Library-seeded rows cannot be deleted (403). An edge for an account with landed history in a closed month cannot be removed on its own (422): move the account with `create-mapping-association` and `replaces_association_id` instead.
|
|
1985
1985
|
*
|
|
1986
1986
|
* **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.
|
|
1987
1987
|
*/
|
|
@@ -2015,7 +2015,7 @@ export const autoMapElements = <ThrowOnError extends boolean = false>(options: O
|
|
|
2015
2015
|
/**
|
|
2016
2016
|
* Create Information Block
|
|
2017
2017
|
*
|
|
2018
|
-
* Generic Information Block construction entry. `block_type` selects the registered block type; `payload` is validated against that type's creation schema at dispatch.
|
|
2018
|
+
* Generic Information Block construction entry. `block_type` selects the registered block type; `payload` is validated against that type's creation schema at dispatch. Only schedule and forecast are constructed here; the other block types raise 501 with a hint naming their own operation (statements: create-report; disclosure and metric structures: create-taxonomy-block). 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).
|
|
2019
2019
|
*
|
|
2020
2020
|
* **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.
|
|
2021
2021
|
*/
|
|
@@ -2032,7 +2032,7 @@ export const createInformationBlock = <ThrowOnError extends boolean = false>(opt
|
|
|
2032
2032
|
/**
|
|
2033
2033
|
* Update Information Block
|
|
2034
2034
|
*
|
|
2035
|
-
* Generic Information Block update entry. Dispatches by `block_type` to the registered mutation handler.
|
|
2035
|
+
* Generic Information Block update entry. Dispatches by `block_type` to the registered mutation handler. Only schedule and forecast blocks update here; the statement family (library-seeded and immutable), disclosure, metric and reconciliation blocks surface 501 with a hint naming the operation that changes them.
|
|
2036
2036
|
*
|
|
2037
2037
|
* **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.
|
|
2038
2038
|
*/
|
|
@@ -2049,7 +2049,7 @@ export const updateInformationBlock = <ThrowOnError extends boolean = false>(opt
|
|
|
2049
2049
|
/**
|
|
2050
2050
|
* Delete Information Block
|
|
2051
2051
|
*
|
|
2052
|
-
* Generic Information Block deletion entry. Returns a thin confirmation (deleted / structure_id / block_type / name).
|
|
2052
|
+
* Generic Information Block deletion entry. Returns a thin confirmation (deleted / structure_id / block_type / name). Only schedule and forecast blocks delete here; statement, disclosure, metric and reconciliation blocks surface 501 with a hint naming the operation that manages them.
|
|
2053
2053
|
*
|
|
2054
2054
|
* **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.
|
|
2055
2055
|
*/
|
|
@@ -2117,7 +2117,7 @@ export const assertMetrics = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
2117
2117
|
/**
|
|
2118
2118
|
* Compute Forecast for a Forecast Block
|
|
2119
2119
|
*
|
|
2120
|
-
* Walks a forecast block's driver cascade month-by-month forward from its
|
|
2120
|
+
* Walks a forecast block's driver cascade month-by-month forward from its anchor (with base_anchor='seam', the default, the newest closed month inside the horizon; with 'fixed', the block's base_period): lever-driven rs-driver Derive rules in dependency order, carry-forward for unmodeled income-statement lines, calc-DAG subtotals — upserting per forward month a scenario income-statement FactSet, a balance-sheet set (the full roll when the anchor month has an actual balance sheet, else only the rule-driven working-capital instants) and a derived cash-flow set when an actual one exists, all keyed by the block's scenario_id (NULL = actuals; scenario reads pass it as a filter). Re-running replaces each month's values. Rules with missing lever months or unbound operands are skipped with a reason (their targets fall back to carry-forward). Each month's sets are verified; a month that fails halts the walk there (halted_at), since every later month would be derived from it. Deterministic and non-AI — no credits consumed.
|
|
2121
2121
|
*
|
|
2122
2122
|
* **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.
|
|
2123
2123
|
*/
|
|
@@ -2287,7 +2287,7 @@ export const updateEventBlock = <ThrowOnError extends boolean = false>(options:
|
|
|
2287
2287
|
/**
|
|
2288
2288
|
* Execute Event Block
|
|
2289
2289
|
*
|
|
2290
|
-
* For events on a connection with write_policy='qb_authoritative' or 'hybrid', publish the event's draft GL entries to the source-of-truth system (QuickBooks), each as its own JournalEntry. Records the QuickBooks ids per entry on event.metadata.qb_entry_ids and promotes the published entries to 'posted'; the event goes 'fulfilled' once no draft remains
|
|
2290
|
+
* For events on a connection with write_policy='qb_authoritative' or 'hybrid', publish the event's draft GL entries to the source-of-truth system (QuickBooks), each as its own JournalEntry. Records the QuickBooks ids per entry on event.metadata.qb_entry_ids and promotes the published entries to 'posted'; the event goes 'fulfilled' once no draft remains. On rejection what landed is kept, the status is unchanged and the error is stamped on event.metadata.last_outbound_error (and returned as qb_error). Events on 'native' or 'shadow' books pass through with no QB write. Only the group parent's books are QuickBooks': an event on a subsidiary's books is refused.
|
|
2291
2291
|
*
|
|
2292
2292
|
* **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.
|
|
2293
2293
|
*/
|
|
@@ -2695,7 +2695,7 @@ export const promoteObligations = <ThrowOnError extends boolean = false>(options
|
|
|
2695
2695
|
/**
|
|
2696
2696
|
* Preview Schedule
|
|
2697
2697
|
*
|
|
2698
|
-
* Generate a schedule from a definition without keeping it: the same generator and guards as creating one (block_type='schedule' on create-information-block), run and rolled back. Returns the envelope create would leave (its ids provisional) and the period-by-period roll-forward: the balance the schedule carries on the account it credits (a loan's: the note), opening, the period's amount, closing, and for a loan the interest, payment, principal and current portion. Show it to the person before asking to create. A definition create would refuse (a roll-forward that climbs where it should fall, legs that do not balance) is refused here with the period that breaks. `warnings` names any active schedule already posting the same accounts in the same months. With `replaces_structure_id`, `replaces` says what the schedule being edited or recreated has posted, by month, and the path the change takes: `rebuild` (
|
|
2698
|
+
* Generate a schedule from a definition without keeping it: the same generator and guards as creating one (block_type='schedule' on create-information-block), run and rolled back. Returns the envelope create would leave (its ids provisional) and the period-by-period roll-forward: the balance the schedule carries on the account it credits (a loan's: the note), opening, the period's amount, closing, and for a loan the interest, payment, principal and current portion. Show it to the person before asking to create. A definition create would refuse (a roll-forward that climbs where it should fall, legs that do not balance) is refused here with the period that breaks. `warnings` names any active schedule already posting the same accounts in the same months. With `replaces_structure_id`, `replaces` says what the schedule being edited or recreated has posted, by month, and the path the change takes: `rebuild` (the schedule regenerated in place from the new definition) while nothing has posted, `terminate_and_succeed` after.
|
|
2699
2699
|
*
|
|
2700
2700
|
* **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.
|
|
2701
2701
|
*/
|
|
@@ -2916,7 +2916,7 @@ export const deletePublishList = <ThrowOnError extends boolean = false>(options:
|
|
|
2916
2916
|
/**
|
|
2917
2917
|
* Add Members to Publish List
|
|
2918
2918
|
*
|
|
2919
|
-
* Add one or more recipient graphs to a publish list. Targets must exist and
|
|
2919
|
+
* Add one or more recipient graphs to a publish list. Targets must exist and carry the roboledger or roboinvestor extension. Self-graph rejected (422); already-member rejected (409).
|
|
2920
2920
|
*
|
|
2921
2921
|
* **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.
|
|
2922
2922
|
*/
|
|
@@ -3205,7 +3205,7 @@ export const deletePortfolioBlock = <ThrowOnError extends boolean = false>(optio
|
|
|
3205
3205
|
/**
|
|
3206
3206
|
* Create Security
|
|
3207
3207
|
*
|
|
3208
|
-
* Register a security (common stock, preferred stock, warrant, convertible note, etc.)
|
|
3208
|
+
* Register a security (common stock, preferred stock, warrant, convertible note, etc.) in this graph's registry. Its `entity_id` is the issuer, not the holder; a portfolio's `entity_id` is the owner. Optionally cross-links to the issuer's own graph via `source_graph_id` for mutual-handshake attribution.
|
|
3209
3209
|
*
|
|
3210
3210
|
* **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.
|
|
3211
3211
|
*/
|