@robosystems/client 1.16.0 → 1.17.1

package/types.gen.d.ts

@@ -2018,7 +2018,7 @@ export type ConnectionProviderInfo = {
      *
      * Provider identifier
      */
-    provider: 'quickbooks' | 'external';
+    provider: 'quickbooks' | 'external' | 'mercury' | 'plaid';
     /**
      * Display Name
      *
@@ -2411,7 +2411,7 @@ export type CreateConnectionRequest = {
      *
      * Connection provider type
      */
-    provider: 'quickbooks' | 'external';
+    provider: 'quickbooks' | 'external' | 'mercury' | 'plaid';
     /**
      * Entity Id
      *
@@ -2420,6 +2420,8 @@ export type CreateConnectionRequest = {
     entity_id?: string | null;
     quickbooks_config?: QuickBooksConnectionConfig | null;
     external_config?: ExternalConnectionConfig | null;
+    mercury_config?: MercuryConnectionConfig | null;
+    plaid_config?: PlaidConnectionConfig | null;
 };
 /**
  * CreateEventBlockRequest
@@ -4211,6 +4213,96 @@ export type Dimension = {
  * DimensionType
  */
 export type DimensionType = 'element' | 'period' | 'entity';
+/**
+ * DisclosuresRequest
+ *
+ * Request for the disclosures view op — the map of a report's sections.
+ */
+export type DisclosuresRequest = {
+    /**
+     * Ticker
+     *
+     * Company ticker. On shared-repository graphs (SEC) it resolves the latest matching filing when report_id is not given; ignored on tenant graphs.
+     */
+    ticker?: string | null;
+    /**
+     * Report Id
+     *
+     * Specific report identifier. Required on tenant graphs; on SEC, optional when ticker is given.
+     */
+    report_id?: string | null;
+    /**
+     * Fiscal Year
+     *
+     * Narrow auto-resolution to this fiscal year focus
+     */
+    fiscal_year?: number | null;
+    /**
+     * Period Type
+     *
+     * Which forms auto-resolution considers: annual (10-K / 20-F / 40-F, the default) or quarterly (10-Q as well)
+     */
+    period_type?: string | null;
+    /**
+     * Topic
+     *
+     * A disclosure family's name, or part of it ("leases", "income taxes"), for that family's blocks. Omit for the whole map.
+     */
+    topic?: string | null;
+};
+/**
+ * DisclosuresResponse
+ *
+ * The disclosures view op's result: xbrlkit's map, stamped with the graph
+ * and report it was read from.
+ *
+ * Without ``topic``: ``disclosures`` / ``count``. With ``topic``:
+ * ``disclosure`` / ``category`` / ``blocks`` / ``block_count``.
+ */
+export type DisclosuresResponse = {
+    /**
+     * Graph Id
+     */
+    graph_id: string;
+    /**
+     * Report Id
+     */
+    report_id: string;
+    resolved_report?: ResolvedReportInfo | null;
+    /**
+     * Disclosures
+     */
+    disclosures?: Array<{
+        [key: string]: unknown;
+    }> | null;
+    /**
+     * Count
+     */
+    count?: number | null;
+    /**
+     * Disclosure
+     */
+    disclosure?: string | null;
+    /**
+     * Category
+     */
+    category?: string | null;
+    /**
+     * Blocks
+     */
+    blocks?: Array<{
+        [key: string]: unknown;
+    }> | null;
+    /**
+     * Block Count
+     */
+    block_count?: number | null;
+    /**
+     * Note
+     */
+    note?: string | null;
+    [key: string]: unknown;
+};
 /**
  * DocumentDetailResponse
  *
@@ -4639,6 +4731,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;
 };
 /**
  * EmailVerificationRequest
@@ -7092,6 +7190,152 @@ export type InformationBlockEnvelope = {
      */
     view?: ViewProjections;
 };
+/**
+ * InformationBlockRequest
+ *
+ * Request for the information-block view op — one section read whole.
+ */
+export type InformationBlockRequest = {
+    /**
+     * Ticker
+     *
+     * Company ticker. On shared-repository graphs (SEC) it resolves the latest matching filing when report_id is not given; ignored on tenant graphs.
+     */
+    ticker?: string | null;
+    /**
+     * Report Id
+     *
+     * Specific report identifier. Required on tenant graphs; on SEC, optional when ticker is given.
+     */
+    report_id?: string | null;
+    /**
+     * Fiscal Year
+     *
+     * Narrow auto-resolution to this fiscal year focus
+     */
+    fiscal_year?: number | null;
+    /**
+     * Period Type
+     *
+     * Which forms auto-resolution considers: annual (10-K / 20-F / 40-F, the default) or quarterly (10-Q as well)
+     */
+    period_type?: string | null;
+    /**
+     * Block
+     *
+     * The block id from disclosures (a role name or its last segment also resolves)
+     */
+    block: string;
+    /**
+     * Periods
+     *
+     * Period keys to keep, from a previous call's columns. Default keeps the budgeted set, year and balance columns first on an annual form.
+     */
+    periods?: Array<string> | null;
+    /**
+     * Member
+     *
+     * Keep only breakdowns whose member key contains this text (a segment name)
+     */
+    member?: string | null;
+    /**
+     * Max Rows
+     *
+     * Cap on presentation rows (default 400)
+     */
+    max_rows?: number | null;
+    /**
+     * Max Members
+     *
+     * An explicit cap on member breakdowns, instead of the response budget
+     */
+    max_members?: number | null;
+    /**
+     * Offset
+     *
+     * Rows to skip: the next_offset a truncated response returned
+     */
+    offset?: number | null;
+};
+/**
+ * InformationBlockResponse
+ *
+ * The information-block view op's result: xbrlkit's block, stamped.
+ */
+export type InformationBlockResponse = {
+    /**
+     * Graph Id
+     */
+    graph_id: string;
+    /**
+     * Report Id
+     */
+    report_id: string;
+    resolved_report?: ResolvedReportInfo | null;
+    /**
+     * Block
+     */
+    block: {
+        [key: string]: unknown;
+    };
+    /**
+     * Columns
+     */
+    columns?: Array<{
+        [key: string]: unknown;
+    }>;
+    /**
+     * Axes
+     */
+    axes?: Array<{
+        [key: string]: unknown;
+    }> | null;
+    /**
+     * Rows
+     */
+    rows?: Array<{
+        [key: string]: unknown;
+    }>;
+    /**
+     * Row Count
+     */
+    row_count?: number | null;
+    /**
+     * Truncated
+     */
+    truncated?: boolean | null;
+    /**
+     * Offset
+     */
+    offset?: number | null;
+    /**
+     * Ancestors
+     */
+    ancestors?: Array<{
+        [key: string]: unknown;
+    }> | null;
+    /**
+     * Next Offset
+     */
+    next_offset?: number | null;
+    /**
+     * Calculation
+     */
+    calculation?: Array<{
+        [key: string]: unknown;
+    }> | null;
+    /**
+     * Text
+     */
+    text?: Array<{
+        [key: string]: unknown;
+    }> | null;
+    /**
+     * Note
+     */
+    note?: string | null;
+    [key: string]: unknown;
+};
 /**
  * InformationModelResponse
  *
@@ -8697,6 +8941,39 @@ 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
  *
@@ -8838,7 +9115,7 @@ export type OAuthCallbackRequest = {
     /**
      * Code
      *
-     * Authorization code from OAuth provider
+     * Authorization code from the OAuth provider (Plaid: the public_token Link returned)
      */
     code: string;
     /**
@@ -9007,15 +9284,21 @@ export type OAuthInitRequest = {
 /**
  * OAuthInitResponse
  *
- * Response with OAuth authorization URL.
+ * Where the user authorizes: a redirect URL, or a token for an embedded widget.
  */
 export type OAuthInitResponse = {
     /**
      * Auth Url
      *
-     * URL to redirect user for authorization
+     * URL to redirect the user to for authorization. Null for providers that authorize in an embedded widget (Plaid: see link_token).
+     */
+    auth_url?: string | null;
+    /**
+     * Link Token
+     *
+     * Plaid only: the token that opens Plaid Link. Link's public_token completes the flow through the callback, as code.
      */
-    auth_url: string;
+    link_token?: string | null;
     /**
      * State
      *
@@ -9834,6 +10117,51 @@ export type OperationEnvelopeDeleteTaxonomyBlockResponse = {
      */
     idempotentReplay?: boolean;
 };
+/**
+ * OperationEnvelope[DisclosuresResponse]
+ */
+export type OperationEnvelopeDisclosuresResponse = {
+    /**
+     * 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?: DisclosuresResponse | 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[EntityTaxonomyResponse]
  */
@@ -10239,6 +10567,51 @@ export type OperationEnvelopeInformationBlockEnvelope = {
      */
     idempotentReplay?: boolean;
 };
+/**
+ * OperationEnvelope[InformationBlockResponse]
+ */
+export type OperationEnvelopeInformationBlockResponse = {
+    /**
+     * 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?: InformationBlockResponse | 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[InitializeChartOfAccountsResponse]
  */
@@ -12169,6 +12542,26 @@ export type PeriodSpec = {
      */
     label: string;
 };
+/**
+ * PlaidConnectionConfig
+ *
+ * Plaid bank-feed connection configuration.
+ *
+ * A bank feed is native accounting: the graph must already have a chart of
+ * accounts and no live QuickBooks connection. The connection is created
+ * ``pending_oauth``; ``POST /oauth/init`` returns a ``link_token`` for Plaid
+ * Link, and the ``public_token`` Link hands back completes it through
+ * ``POST /oauth/callback/plaid`` (as ``code``). One connection per institution
+ * login; a graph can hold several.
+ */
+export type PlaidConnectionConfig = {
+    /**
+     * Since Date
+     *
+     * First day of the backfill (ISO 8601), and how much history Plaid is asked to pull for the new Item (at most two years). Defaults to 1 January of last year.
+     */
+    since_date?: string | null;
+};
 /**
  * PortalSessionResponse
  *
@@ -13080,7 +13473,7 @@ export type ReconcilingItemPlan = {
     /**
      * Default Disposition
      *
-     * What resolve would do with no disposition given: restate while every affected period is open, catch_up once one is closed.
+     * What resolve would do with no disposition given: restate while every affected period is open and nothing blocks it, catch_up otherwise.
      */
     default_disposition: 'restate' | 'catch_up' | 'acknowledge';
     /**
@@ -13561,13 +13954,13 @@ export type ReportResponse = {
     /**
      * Filed At
      *
-     * When the report was transitioned to `filed`.
+     * When the report was transitioned to `filed`. On a report shared in from another graph this is the sender's filing time, carried over with `filing_status` so a recipient can tell a draft they were sent from final statements.
      */
     filed_at?: string | null;
     /**
      * Filed By
      *
-     * User ID that transitioned the report to `filed`.
+     * User ID that transitioned the report to `filed`. Always null on a report shared in from another graph: the sender's user id resolves to nobody in the recipient's graph, so it is deliberately not carried across with `filing_status` and `filed_at`.
      */
     filed_by?: string | null;
     /**
@@ -14409,6 +14802,10 @@ export type SchemaValidationResponse = {
  * A long SEC section (an MD&A, a commitments note) is indexed in parts, each
  * a document of its own: ``part`` of ``part_count``, ``parent_document_id``
  * shared by the section's parts, ``next_document_id`` to read on.
+ *
+ * On a grouped search, ``also_in_filings`` counts the other filings of the
+ * same filer whose same section (and part) matched and were folded into
+ * this hit.
  */
 export type SearchHit = {
     /**
@@ -14499,6 +14896,10 @@ export type SearchHit = {
      * Folder
      */
     folder?: string | null;
+    /**
+     * Also In Filings
+     */
+    also_in_filings?: number | null;
 };
 /**
  * SearchRequest
@@ -14515,7 +14916,7 @@ export type SearchRequest = {
     /**
      * Entity
      *
-     * Filter by ticker, CIK, or entity name
+     * Filter by CIK (exactly one filer), ticker, or entity name. A name, or a ticker that is also a word, is a loose word match that can include other filers
      */
     entity?: string | null;
     /**
@@ -14566,6 +14967,12 @@ export type SearchRequest = {
      * Enable hybrid semantic search (BM25 + KNN). Default is BM25-only for speed.
      */
     semantic?: boolean;
+    /**
+     * Group
+     *
+     * Fold hits from successive filings of the same filer and section into the best-ranked one; also_in_filings counts the others. Ignored when entity is set, where a filer's filing history is the point. A grouped page is drawn from the first 100 hits.
+     */
+    group?: boolean;
     /**
      * Size
      *
@@ -14593,6 +15000,8 @@ export type SearchRequest = {
 export type SearchResponse = {
     /**
      * Total
+     *
+     * Matching documents before any grouping, as OpenSearch counts them (it stops counting at 10,000). Not the number of distinct results a grouped search can page through.
      */
     total: number;
     /**
@@ -16619,9 +17028,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
      *
@@ -20303,7 +20712,7 @@ export type ListConnectionsData = {
          *
          * Filter by provider type
          */
-        provider?: 'quickbooks' | 'external' | null;
+        provider?: 'quickbooks' | 'external' | 'mercury' | 'plaid' | null;
     };
     url: '/v1/graphs/{graph_id}/connections';
 };
@@ -27970,6 +28379,124 @@ export type FinancialStatementAnalysisResponses = {
     200: OperationEnvelopeFinancialStatementAnalysisResponse;
 };
 export type FinancialStatementAnalysisResponse2 = FinancialStatementAnalysisResponses[keyof FinancialStatementAnalysisResponses];
+export type DisclosuresData = {
+    body: DisclosuresRequest;
+    headers?: {
+        /**
+         * Idempotency-Key
+         */
+        'Idempotency-Key'?: string | null;
+    };
+    path: {
+        /**
+         * Graph Id
+         */
+        graph_id: string;
+    };
+    query?: never;
+    url: '/extensions/roboledger/{graph_id}/operations/disclosures';
+};
+export type DisclosuresErrors = {
+    /**
+     * 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 DisclosuresError = DisclosuresErrors[keyof DisclosuresErrors];
+export type DisclosuresResponses = {
+    /**
+     * Successful Response
+     */
+    200: OperationEnvelopeDisclosuresResponse;
+};
+export type DisclosuresResponse2 = DisclosuresResponses[keyof DisclosuresResponses];
+export type InformationBlockData = {
+    body: InformationBlockRequest;
+    headers?: {
+        /**
+         * Idempotency-Key
+         */
+        'Idempotency-Key'?: string | null;
+    };
+    path: {
+        /**
+         * Graph Id
+         */
+        graph_id: string;
+    };
+    query?: never;
+    url: '/extensions/roboledger/{graph_id}/operations/information-block';
+};
+export type InformationBlockErrors = {
+    /**
+     * 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 InformationBlockError = InformationBlockErrors[keyof InformationBlockErrors];
+export type InformationBlockResponses = {
+    /**
+     * Successful Response
+     */
+    200: OperationEnvelopeInformationBlockResponse;
+};
+export type InformationBlockResponse2 = InformationBlockResponses[keyof InformationBlockResponses];
 export type CreatePortfolioBlockData = {
     body: CreatePortfolioBlockRequest;
     headers?: {