@robosystems/client 1.15.0 → 1.17.0

package/types.gen.ts

@@ -2074,7 +2074,7 @@ export type ConnectionProviderInfo = {
      *
      * Provider identifier
      */
-    provider: 'quickbooks' | 'external';
+    provider: 'quickbooks' | 'external' | 'mercury';
     /**
      * Display Name
      *
@@ -2475,7 +2475,7 @@ export type CreateConnectionRequest = {
      *
      * Connection provider type
      */
-    provider: 'quickbooks' | 'external';
+    provider: 'quickbooks' | 'external' | 'mercury';
     /**
      * Entity Id
      *
@@ -2484,6 +2484,7 @@ export type CreateConnectionRequest = {
     entity_id?: string | null;
     quickbooks_config?: QuickBooksConnectionConfig | null;
     external_config?: ExternalConnectionConfig | null;
+    mercury_config?: MercuryConnectionConfig | null;
 };
 
 /**
@@ -4759,6 +4760,12 @@ export type ElementUpdatePatch = {
     metadata?: {
         [key: string]: unknown;
     } | null;
+    /**
+     * Is Active
+     *
+     * Retire (`false`) or reactivate (`true`) a chart account. Retiring keeps its history and hides it from account pickers and the chart tree, and new line items on it are refused — the way to take an account with activity out of use, since removal needs no facts and no line items.
+     */
+    is_active?: boolean | null;
 };
 
 /**
@@ -7391,6 +7398,84 @@ export type InitialEntityData = {
     reporting_style_id?: string | null;
 };
 
+/**
+ * InitializeChartOfAccountsRequest
+ *
+ * Create the graph's chart of accounts from a shipped template.
+ *
+ * Refused (409) when the graph already has an active ``chart_of_accounts``
+ * taxonomy — a QuickBooks-synced tenant never needs this, and a chart is
+ * never replaced. The template's equity rows are mapped by the entity's
+ * legal form (``entity_type``: corporation / llc / partnership); omit it
+ * to use the graph's primary entity, falling back to corporation.
+ */
+export type InitializeChartOfAccountsRequest = {
+    /**
+     * Template
+     *
+     * Template key: `saas` (subscription software — deferred revenue, cost of revenue, R&D / S&M / G&A), `services` (professional services — no inventory, no COGS), `product` (inventory and cost of goods sold, direct + wholesale + subscription revenue).
+     */
+    template: 'saas' | 'services' | 'product';
+    /**
+     * Entity Type
+     *
+     * Legal form for the equity mapping: `corporation`, `llc` or `partnership`. Defaults to the graph's primary entity, then to corporation.
+     */
+    entity_type?: string | null;
+    /**
+     * Name
+     *
+     * Chart display name. Defaults to 'Chart of Accounts'.
+     */
+    name?: string | null;
+};
+
+/**
+ * InitializeChartOfAccountsResponse
+ */
+export type InitializeChartOfAccountsResponse = {
+    /**
+     * Taxonomy Id
+     *
+     * The new chart's taxonomy id.
+     */
+    taxonomy_id: string;
+    /**
+     * Name
+     */
+    name: string;
+    /**
+     * Template
+     */
+    template: 'saas' | 'services' | 'product';
+    /**
+     * Entity Type
+     *
+     * Legal form the equity rows were mapped for.
+     */
+    entity_type: string;
+    /**
+     * Elements Created
+     */
+    elements_created: number;
+    /**
+     * Mappings Created
+     */
+    mappings_created: number;
+    /**
+     * Frameworks
+     *
+     * Frameworks the chart was mapped into — each template mapping set whose framework this graph's library carries (rs-gaap today; every framework in the graph's pin once it is plural).
+     */
+    frameworks?: Array<string>;
+    /**
+     * Unresolved
+     *
+     * What could not be mapped, never fatal — the accounts exist and can be mapped by hand: a target qname the framework's library copy did not resolve, `<framework>: not in this graph's library` for a template mapping set whose framework this graph does not carry, or a template row naming an account it does not declare.
+     */
+    unresolved?: Array<string>;
+};
+
 /**
  * InitializeLedgerRequest
  *
@@ -8827,6 +8912,40 @@ export type MemoryRecord = {
     updated_at?: string | null;
 };
 
+/**
+ * MercuryConnectionConfig
+ *
+ * Mercury bank-feed connection configuration.
+ *
+ * A bank feed is native accounting: the graph must already have a chart of
+ * accounts and no live QuickBooks connection. Over OAuth (the hosted
+ * default) the connection is created ``pending_oauth`` and activated by the
+ * callback. ``api_key`` — a personal **read-only** Mercury token — connects
+ * at once without a browser round-trip, but only on deployments that turn
+ * on ``MERCURY_API_KEY_CONNECTIONS_ENABLED`` (self-hosted and local); the
+ * hosted product refuses it.
+ */
+export type MercuryConnectionConfig = {
+    /**
+     * Since Date
+     *
+     * First day of the backfill (ISO 8601). Defaults to 1 January of last year. Incremental syncs never look back before it.
+     */
+    since_date?: string | null;
+    /**
+     * Include Treasury
+     *
+     * Capture treasury-account activity alongside checking/savings.
+     */
+    include_treasury?: boolean;
+    /**
+     * Api Key
+     *
+     * A personal read-only Mercury API token, for deployments that allow the api_key credential mode. Omit to connect over OAuth.
+     */
+    api_key?: string | null;
+};
+
 /**
  * MetricMechanics
  *
@@ -10407,6 +10526,52 @@ export type OperationEnvelopeInformationBlockEnvelope = {
     idempotentReplay?: boolean;
 };
 
+/**
+ * OperationEnvelope[InitializeChartOfAccountsResponse]
+ */
+export type OperationEnvelopeInitializeChartOfAccountsResponse = {
+    /**
+     * Operation
+     *
+     * Kebab-case operation name
+     */
+    operation: string;
+    /**
+     * Operationid
+     *
+     * op_-prefixed ULID for audit and SSE correlation
+     */
+    operationId: string;
+    /**
+     * Status
+     *
+     * Operation lifecycle state
+     */
+    status: 'completed' | 'pending' | 'failed';
+    /**
+     * Command-specific result payload
+     */
+    result?: InitializeChartOfAccountsResponse | null;
+    /**
+     * At
+     *
+     * ISO-8601 UTC timestamp
+     */
+    at: string;
+    /**
+     * Createdby
+     *
+     * User ID that initiated the operation (null for legacy callers)
+     */
+    createdBy?: string | null;
+    /**
+     * Idempotentreplay
+     *
+     * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
+     */
+    idempotentReplay?: boolean;
+};
+
 /**
  * OperationEnvelope[InitializeLedgerResponse]
  */
@@ -14815,6 +14980,12 @@ export type SearchRequest = {
      * Pagination offset
      */
     offset?: number;
+    /**
+     * Snippet Chars
+     *
+     * Approximate snippet budget per hit in characters; the default is three highlight fragments of about 200
+     */
+    snippet_chars?: number | null;
 };
 
 /**
@@ -16905,9 +17076,9 @@ export type UpdateEventBlockRequest = {
     /**
      * Transition To
      *
-     * Status transition. Valid moves depend on current status: captured → committed | voided | superseded; classified → committed | pending | fulfilled | voided | superseded; committed → pending | fulfilled | voided | superseded; pending → fulfilled | voided | superseded; fulfilled → voided | superseded. A retraction (voided, superseded) is final and is refused from any status once the event's ledger rows have posted or it has published to QuickBooks — reverse the posted entries instead. Note: classified and fulfilled are usually set by handlers, not by callers, but the transition is allowed for corrections.
+     * Status transition. Valid moves depend on current status: captured → classified | committed | voided | superseded; classified → committed | pending | fulfilled | voided | superseded; committed → pending | fulfilled | voided | superseded; pending → fulfilled | voided | superseded; fulfilled → voided | superseded. A retraction (voided, superseded) is final and is refused from any status once the event's ledger rows have posted or it has published to QuickBooks — reverse the posted entries instead. captured → classified records an account choice without posting (bank-feed lines: patch classified_element_id, or accept_suggestion: true, in the same call); the later commit fires the handler. Note: classified and fulfilled are otherwise set by handlers, not by callers, but the transition is allowed for corrections.
      */
-    transition_to?: 'committed' | 'pending' | 'fulfilled' | 'voided' | 'superseded' | null;
+    transition_to?: 'classified' | 'committed' | 'pending' | 'fulfilled' | 'voided' | 'superseded' | null;
     /**
      * Superseded By Id
      *
@@ -20911,7 +21082,7 @@ export type ListConnectionsData = {
          *
          * Filter by provider type
          */
-        provider?: 'quickbooks' | 'external' | null;
+        provider?: 'quickbooks' | 'external' | 'mercury' | null;
     };
     url: '/v1/graphs/{graph_id}/connections';
 };
@@ -21032,7 +21203,14 @@ export type DeleteConnectionData = {
          */
         connection_id: string;
     };
-    query?: never;
+    query?: {
+        /**
+         * Disposition
+         *
+         * `disconnect` (default): soft-delete; a later re-OAuth to the same realm revives the connection. `sever`: the native-accounting cutover — QuickBooks only; the chart it created is stamped native-owned, write_policy drops to native, and the connection is never revived.
+         */
+        disposition?: 'disconnect' | 'sever';
+    };
     url: '/v1/graphs/{graph_id}/connections/{connection_id}';
 };
 
@@ -25983,6 +26161,70 @@ export type CreateTaxonomyBlockResponses = {
 
 export type CreateTaxonomyBlockResponse = CreateTaxonomyBlockResponses[keyof CreateTaxonomyBlockResponses];
 
+export type InitializeChartOfAccountsData = {
+    body: InitializeChartOfAccountsRequest;
+    headers?: {
+        /**
+         * Idempotency-Key
+         */
+        'Idempotency-Key'?: string | null;
+    };
+    path: {
+        /**
+         * Graph Id
+         */
+        graph_id: string;
+    };
+    query?: never;
+    url: '/extensions/roboledger/{graph_id}/operations/initialize-chart-of-accounts';
+};
+
+export type InitializeChartOfAccountsErrors = {
+    /**
+     * Invalid request
+     */
+    400: ErrorResponse;
+    /**
+     * Authentication required
+     */
+    401: ErrorResponse;
+    /**
+     * Access denied
+     */
+    403: ErrorResponse;
+    /**
+     * Resource not found
+     */
+    404: ErrorResponse;
+    /**
+     * Idempotency-Key conflict — key reused with different body
+     */
+    409: ErrorResponse;
+    /**
+     * Validation error
+     */
+    422: ErrorResponse;
+    /**
+     * Rate limit exceeded
+     */
+    429: ErrorResponse;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+};
+
+export type InitializeChartOfAccountsError = InitializeChartOfAccountsErrors[keyof InitializeChartOfAccountsErrors];
+
+export type InitializeChartOfAccountsResponses = {
+    /**
+     * Successful Response
+     */
+    200: OperationEnvelopeInitializeChartOfAccountsResponse;
+};
+
+export type InitializeChartOfAccountsResponse2 = InitializeChartOfAccountsResponses[keyof InitializeChartOfAccountsResponses];
+
 export type UpdateTaxonomyBlockData = {
     body: UpdateTaxonomyBlockRequest;
     headers?: {