@robosystems/client 0.5.13 → 0.6.1

package/types.gen.ts

@@ -120,6 +120,42 @@ export type AddPublishListMembersOperation = {
     list_id: string;
 };
 
+/**
+ * AnalyticalStatementFactRow
+ *
+ * A single fact row from the graph-backed statement analysis.
+ */
+export type AnalyticalStatementFactRow = {
+    /**
+     * Canonical Concept
+     */
+    canonical_concept?: string | null;
+    /**
+     * Qname
+     */
+    qname: string;
+    /**
+     * Name
+     */
+    name: string;
+    /**
+     * Value
+     */
+    value?: number | null;
+    /**
+     * End Date
+     */
+    end_date?: string | null;
+    /**
+     * Period Type
+     */
+    period_type?: string | null;
+    /**
+     * Duration Type
+     */
+    duration_type?: string | null;
+};
+
 /**
  * ArtifactResponse
  *
@@ -162,6 +198,154 @@ export type ArtifactResponse = {
     } & ForecastMechanics);
 };
 
+/**
+ * AssertMetricsRequest
+ *
+ * Request body for the ``assert-metrics`` operation.
+ *
+ * The observation sibling of ``compute-metrics``: writes externally-
+ * observed values (usage counts, marketing numbers, hand-carried
+ * figures) into the period's standing ``factset_type='metric'`` FactSet
+ * with ``AssertedProvenance``. Re-asserting a period replaces its facts
+ * — one standing FactSet per (structure, entity, period_end), the
+ * accumulating time series.
+ *
+ * Structures carrying ``Derive`` rules are compute-owned
+ * (``compute-metrics``) and rejected — asserted and derived metric
+ * series keep disjoint structures. Asserted series are actuals; there
+ * is no scenario axis.
+ */
+export type AssertMetricsRequest = {
+    /**
+     * Structure Id
+     *
+     * Metric block structure (block_type='metric') to assert into.
+     */
+    structure_id: string;
+    /**
+     * Period End
+     *
+     * Period end the observations are for — instant concepts (a follower count at month end) land as of this date; duration concepts (monthly downloads) end on it.
+     */
+    period_end: string;
+    /**
+     * Period Start
+     *
+     * Window start for duration concepts and the standing FactSet's period_start. Instant concepts ignore it.
+     */
+    period_start?: string | null;
+    /**
+     * Entity Id
+     *
+     * Entity to assert for. Defaults to the graph's earliest-created entity (the primary entity for single-entity graphs).
+     */
+    entity_id?: string | null;
+    /**
+     * Source System
+     *
+     * Identifier of the asserting system (e.g. 'content-machine') — recorded as the AssertedProvenance source_system.
+     */
+    source_system: string;
+    /**
+     * Basis Note
+     *
+     * Free-text basis / source reference for the observations.
+     */
+    basis_note?: string | null;
+    /**
+     * Observations
+     *
+     * Observed values, one per metric concept — duplicates rejected.
+     */
+    observations: Array<MetricObservation>;
+};
+
+/**
+ * AssertMetricsResponse
+ *
+ * Response for the ``assert-metrics`` operation.
+ */
+export type AssertMetricsResponse = {
+    /**
+     * Structure Id
+     */
+    structure_id: string;
+    /**
+     * Entity Id
+     */
+    entity_id: string;
+    /**
+     * Period End
+     */
+    period_end: string;
+    /**
+     * Fact Set Id
+     *
+     * Standing metric FactSet the observations were written to.
+     */
+    fact_set_id: string;
+    /**
+     * Asserted
+     */
+    asserted?: Array<AssertedMetricLite>;
+    /**
+     * Replaced
+     *
+     * True when a prior standing set existed for the period and its facts were replaced.
+     */
+    replaced?: boolean;
+};
+
+/**
+ * AssertedMetricLite
+ *
+ * One metric written by an ``assert-metrics`` run.
+ */
+export type AssertedMetricLite = {
+    /**
+     * Element Id
+     *
+     * Metric element the fact was written for.
+     */
+    element_id: string;
+    /**
+     * Element Qname
+     *
+     * Metric element qname.
+     */
+    element_qname: string;
+    /**
+     * Name
+     *
+     * Metric display name.
+     */
+    name: string;
+    /**
+     * Value
+     *
+     * Asserted value.
+     */
+    value: number;
+    /**
+     * Unit
+     *
+     * Fact unit — 'USD' for monetary, 'days' for days, else 'pure'.
+     */
+    unit: string;
+    /**
+     * Period Type
+     *
+     * 'instant' or 'duration'.
+     */
+    period_type: string;
+    /**
+     * Item Type
+     *
+     * Format family from the metric element (monetary | ratio | percent | multiple | days). None means untyped; fall back to unit.
+     */
+    item_type?: string | null;
+};
+
 /**
  * AssociationResponse
  *
@@ -1685,7 +1869,7 @@ export type ConnectionProviderInfo = {
      *
      * Provider identifier
      */
-    provider: 'sec' | 'quickbooks';
+    provider: 'sec' | 'quickbooks' | 'external';
     /**
      * Display Name
      *
@@ -1808,6 +1992,12 @@ export type ConnectionResponse = {
      * Source-of-truth write policy: 'native' (RoboSystems is authoritative; no outbound write-back) or 'qb_authoritative' (QuickBooks is authoritative; RoboSystems-originated entries publish to QB). Set via the write-policy endpoint.
      */
     write_policy?: string | null;
+    /**
+     * Source Name
+     *
+     * External-provider registered source slug — the value the integration stamps on the events it emits. Null for platform providers.
+     */
+    source_name?: string | null;
     /**
      * Metadata
      *
@@ -2074,7 +2264,7 @@ export type CreateConnectionRequest = {
      *
      * Connection provider type
      */
-    provider: 'sec' | 'quickbooks';
+    provider: 'sec' | 'quickbooks' | 'external';
     /**
      * Entity Id
      *
@@ -2083,6 +2273,7 @@ export type CreateConnectionRequest = {
     entity_id?: string | null;
     sec_config?: SecConnectionConfig | null;
     quickbooks_config?: QuickBooksConnectionConfig | null;
+    external_config?: ExternalConnectionConfig | null;
 };
 
 /**
@@ -2148,7 +2339,7 @@ export type CreateEventBlockRequest = {
     /**
      * Source
      *
-     * 'manual' | 'system' | 'schedule' | 'quickbooks' | 'xero' | 'plaid'
+     * 'manual' | 'system' | 'schedule', a connected provider name (e.g. 'quickbooks'), or a source_name registered via an 'external' connection. Validated against the graph's registered connections.
      */
     source: string;
     /**
@@ -4562,7 +4753,7 @@ export type EventBlockEnvelope = {
     /**
      * Source
      *
-     * Capture source (`manual`, `system`, `schedule`, `quickbooks`, `xero`, `plaid`). Used for adapter routing.
+     * Capture source: `manual`, `system`, `schedule`, a connected provider name (e.g. `quickbooks`), or a registered external source_name. Used for adapter routing.
      */
     source: string;
     /**
@@ -4831,6 +5022,32 @@ export type ExecuteEventBlockResponse = {
     } | null;
 };
 
+/**
+ * ExternalConnectionConfig
+ *
+ * External-integration connection configuration.
+ *
+ * Registers a source namespace for an integration the platform does not
+ * run: the connection is registration + telemetry, not execution config.
+ * The platform holds no credentials for the external source — the
+ * integration authenticates to its own source and writes here through
+ * the public API, stamping ``source_name`` on everything it emits.
+ */
+export type ExternalConnectionConfig = {
+    /**
+     * Source Name
+     *
+     * Source slug the integration stamps on the events it emits (lowercase letters, digits, '-', '_'; must start with a letter). Unique per graph among live connections.
+     */
+    source_name: string;
+    /**
+     * Display Name
+     *
+     * Human-readable label for the connections UI.
+     */
+    display_name?: string | null;
+};
+
 /**
  * FactLite
  *
@@ -5147,6 +5364,39 @@ export type FinancialStatementAnalysisRequest = {
     limit?: number;
 };
 
+/**
+ * FinancialStatementAnalysisResponse
+ *
+ * Results of the financial-statement-analysis view op.
+ */
+export type FinancialStatementAnalysisResponse = {
+    /**
+     * Graph Id
+     */
+    graph_id: string;
+    /**
+     * Statement Type
+     */
+    statement_type: string;
+    /**
+     * Ticker
+     */
+    ticker?: string | null;
+    /**
+     * Report Id
+     */
+    report_id?: string | null;
+    resolved_report?: ResolvedReportInfo | null;
+    /**
+     * Facts
+     */
+    facts: Array<AnalyticalStatementFactRow>;
+    /**
+     * Fact Count
+     */
+    fact_count: number;
+};
+
 /**
  * FiscalCalendarResponse
  *
@@ -7905,7 +8155,7 @@ export type MaterializeOp = {
     /**
      * Rebuild
      *
-     * Rebuild the graph from scratch, dropping existing data
+     * Rebuild the graph from scratch, dropping existing data. Required (staged source) when materializing new uploads into a graph that already contains materialized data — staging replays all uploaded files, so a non-rebuild pass would re-copy ingested rows (409).
      */
     rebuild?: boolean;
     /**
@@ -8079,6 +8329,26 @@ export type MetricMechanics = {
     unit?: string;
 };
 
+/**
+ * MetricObservation
+ *
+ * One externally-observed value in an ``assert-metrics`` request.
+ */
+export type MetricObservation = {
+    /**
+     * Qname
+     *
+     * Metric element qname (e.g. rsx:GithubStars). Must resolve to a concept on the structure's presentation catalog.
+     */
+    qname: string;
+    /**
+     * Value
+     *
+     * Observed value.
+     */
+    value: number;
+};
+
 /**
  * OAuthCallbackRequest
  *
@@ -8378,6 +8648,52 @@ export type OperationEnvelope = {
     idempotentReplay?: boolean;
 };
 
+/**
+ * OperationEnvelope[AssertMetricsResponse]
+ */
+export type OperationEnvelopeAssertMetricsResponse = {
+    /**
+     * 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?: AssertMetricsResponse | 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[AssociationResponse]
  */
@@ -9114,6 +9430,52 @@ export type OperationEnvelopeExecuteEventBlockResponse = {
     idempotentReplay?: boolean;
 };
 
+/**
+ * OperationEnvelope[FinancialStatementAnalysisResponse]
+ */
+export type OperationEnvelopeFinancialStatementAnalysisResponse = {
+    /**
+     * 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?: FinancialStatementAnalysisResponse | 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[FiscalCalendarResponse]
  */
@@ -9850,6 +10212,52 @@ export type OperationEnvelopeTaxonomyBlockEnvelope = {
     idempotentReplay?: boolean;
 };
 
+/**
+ * OperationEnvelope[ViewResponse]
+ */
+export type OperationEnvelopeViewResponse = {
+    /**
+     * 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?: ViewResponse | 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[list[PublishListMemberResponse]]
  */
@@ -12027,6 +12435,34 @@ export type ResetPasswordValidateResponse = {
     email?: string | null;
 };
 
+/**
+ * ResolvedReportInfo
+ *
+ * Information about the auto-resolved report.
+ */
+export type ResolvedReportInfo = {
+    /**
+     * Report Id
+     */
+    report_id: string;
+    /**
+     * Form
+     */
+    form?: string | null;
+    /**
+     * Filing Date
+     */
+    filing_date?: string | null;
+    /**
+     * Fiscal Year
+     */
+    fiscal_year?: number | null;
+    /**
+     * Fiscal Period
+     */
+    fiscal_period?: string | null;
+};
+
 /**
  * ResponseMode
  *
@@ -15753,6 +16189,48 @@ export type ViewConfig = {
     fill_value?: number;
 };
 
+/**
+ * ViewMetadata
+ */
+export type ViewMetadata = {
+    /**
+     * View Id
+     *
+     * Unique view identifier
+     */
+    view_id: string;
+    /**
+     * Facts Processed
+     *
+     * Number of facts processed
+     */
+    facts_processed: number;
+    /**
+     * Construction Time Ms
+     *
+     * Time to build view in milliseconds
+     */
+    construction_time_ms: number;
+    /**
+     * Source
+     *
+     * Data source type
+     */
+    source: string;
+    /**
+     * Period Start
+     *
+     * Period start date
+     */
+    period_start?: string | null;
+    /**
+     * Period End
+     *
+     * Period end date
+     */
+    period_end?: string | null;
+};
+
 /**
  * ViewProjections
  *
@@ -15778,6 +16256,24 @@ export type ViewProjections = {
     chart?: ChartLite | null;
 };
 
+/**
+ * ViewResponse
+ */
+export type ViewResponse = {
+    /**
+     * View metadata
+     */
+    metadata: ViewMetadata;
+    /**
+     * Presentations
+     *
+     * Presentation formats (pivot_table, narrative, etc.)
+     */
+    presentations: {
+        [key: string]: unknown;
+    };
+};
+
 /**
  * _CreateForecastArm
  *
@@ -17833,7 +18329,7 @@ export type ListConnectionsData = {
          *
          * Filter by provider type
          */
-        provider?: 'sec' | 'quickbooks' | null;
+        provider?: 'sec' | 'quickbooks' | 'external' | null;
     };
     url: '/v1/graphs/{graph_id}/connections';
 };
@@ -23610,6 +24106,70 @@ export type ComputeMetricsResponses = {
 
 export type ComputeMetricsResponse2 = ComputeMetricsResponses[keyof ComputeMetricsResponses];
 
+export type AssertMetricsData = {
+    body: AssertMetricsRequest;
+    headers?: {
+        /**
+         * Idempotency-Key
+         */
+        'Idempotency-Key'?: string | null;
+    };
+    path: {
+        /**
+         * Graph Id
+         */
+        graph_id: string;
+    };
+    query?: never;
+    url: '/extensions/roboledger/{graph_id}/operations/assert-metrics';
+};
+
+export type AssertMetricsErrors = {
+    /**
+     * 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 AssertMetricsError = AssertMetricsErrors[keyof AssertMetricsErrors];
+
+export type AssertMetricsResponses = {
+    /**
+     * Successful Response
+     */
+    200: OperationEnvelopeAssertMetricsResponse;
+};
+
+export type AssertMetricsResponse2 = AssertMetricsResponses[keyof AssertMetricsResponses];
+
 export type ComputeForecastData = {
     body: ComputeForecastRequest;
     headers?: {
@@ -25589,7 +26149,7 @@ export type BuildFactGridResponses = {
     /**
      * Successful Response
      */
-    200: OperationEnvelope;
+    200: OperationEnvelopeViewResponse;
 };
 
 export type BuildFactGridResponse = BuildFactGridResponses[keyof BuildFactGridResponses];
@@ -25653,10 +26213,10 @@ export type FinancialStatementAnalysisResponses = {
     /**
      * Successful Response
      */
-    200: OperationEnvelope;
+    200: OperationEnvelopeFinancialStatementAnalysisResponse;
 };
 
-export type FinancialStatementAnalysisResponse = FinancialStatementAnalysisResponses[keyof FinancialStatementAnalysisResponses];
+export type FinancialStatementAnalysisResponse2 = FinancialStatementAnalysisResponses[keyof FinancialStatementAnalysisResponses];
 
 export type CreatePortfolioBlockData = {
     body: CreatePortfolioBlockRequest;