@robosystems/client 0.5.12 → 0.6.0

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
  *
@@ -529,7 +565,7 @@ export type BackupCreateRequest = {
     /**
      * Retention Days
      *
-     * Retention period in days
+     * Retention period in days, further capped to the graph tier's maximum (7/30/90). 90 is the hard ceiling: the storage lifecycle expires backup objects then regardless of the requested value.
      */
     retention_days?: number;
     /**
@@ -5147,6 +5183,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
  *
@@ -5626,7 +5695,7 @@ export type GraphLimitsResponse = {
     /**
      * Subscription Tier
      *
-     * User's subscription tier
+     * Rate-limit tier enforced for requests to this graph
      */
     subscription_tier: string;
     /**
@@ -6173,7 +6242,7 @@ export type GraphTierInstance = {
     /**
      * Memory Mb
      *
-     * Memory allocated to your graph in megabytes
+     * LadybugDB memory budget for the whole instance in megabytes (below physical RAM after OS overhead; not a per-graph allocation)
      */
     memory_mb: number;
     /**
@@ -7649,7 +7718,7 @@ export type ListSubgraphsResponse = {
     /**
      * Subgraphs Enabled
      *
-     * Whether subgraphs are enabled for this tier (requires Large/XLarge tier)
+     * Whether subgraphs are enabled for this tier
      */
     subgraphs_enabled: boolean;
     /**
@@ -7758,6 +7827,74 @@ export type LiveFinancialStatementRequest = {
     limit?: number;
 };
 
+/**
+ * LiveFinancialStatementResponse
+ *
+ * Rendered OLTP-backed ad-hoc statement.
+ */
+export type LiveFinancialStatementResponse = {
+    /**
+     * Graph Id
+     */
+    graph_id: string;
+    /**
+     * Statement Type
+     */
+    statement_type: string;
+    /**
+     * Periods
+     */
+    periods: Array<PeriodSpec>;
+    /**
+     * Facts
+     */
+    facts: Array<LiveStatementFactRow>;
+    /**
+     * Fact Count
+     */
+    fact_count: number;
+    /**
+     * Unmapped Count
+     */
+    unmapped_count?: number;
+    /**
+     * Truncated
+     */
+    truncated?: boolean;
+};
+
+/**
+ * LiveStatementFactRow
+ *
+ * A single row of an OLTP-backed ad-hoc statement.
+ */
+export type LiveStatementFactRow = {
+    /**
+     * Qname
+     */
+    qname: string;
+    /**
+     * Name
+     */
+    name: string;
+    /**
+     * Trait
+     */
+    trait?: string | null;
+    /**
+     * Values
+     */
+    values: Array<number | null>;
+    /**
+     * Depth
+     */
+    depth?: number;
+    /**
+     * Is Subtotal
+     */
+    is_subtotal?: boolean;
+};
+
 /**
  * LoginRequest
  *
@@ -8049,6 +8186,38 @@ export type OAuthCallbackRequest = {
     error_description?: string | null;
 };
 
+/**
+ * OAuthCallbackResponse
+ *
+ * Result of completing an OAuth authorization flow.
+ */
+export type OAuthCallbackResponse = {
+    /**
+     * Success
+     *
+     * Whether the connection was established
+     */
+    success: boolean;
+    /**
+     * Message
+     *
+     * Human-readable outcome of the exchange
+     */
+    message: string;
+    /**
+     * Connection Id
+     *
+     * Connection the authorization was linked to
+     */
+    connection_id: string;
+    /**
+     * Auto Sync Task Id
+     *
+     * Task id of the initial sync started after connecting, or null when no sync was kicked off
+     */
+    auto_sync_task_id?: string | null;
+};
+
 /**
  * OAuthInitRequest
  *
@@ -9014,6 +9183,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]
  */
@@ -9290,6 +9505,52 @@ export type OperationEnvelopeLedgerEntityResponse = {
     idempotentReplay?: boolean;
 };
 
+/**
+ * OperationEnvelope[LiveFinancialStatementResponse]
+ */
+export type OperationEnvelopeLiveFinancialStatementResponse = {
+    /**
+     * 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?: LiveFinancialStatementResponse | 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[PortfolioBlockEnvelope]
  */
@@ -9704,6 +9965,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]]
  */
@@ -11881,6 +12188,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
  *
@@ -15607,6 +15942,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
  *
@@ -15632,6 +16009,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
  *
@@ -17662,9 +18057,11 @@ export type OauthCallbackResponses = {
     /**
      * Successful Response
      */
-    200: unknown;
+    200: OAuthCallbackResponse;
 };
 
+export type OauthCallbackResponse = OauthCallbackResponses[keyof OauthCallbackResponses];
+
 export type ListConnectionsData = {
     body?: never;
     path: {
@@ -25377,10 +25774,10 @@ export type LiveFinancialStatementResponses = {
     /**
      * Successful Response
      */
-    200: OperationEnvelope;
+    200: OperationEnvelopeLiveFinancialStatementResponse;
 };
 
-export type LiveFinancialStatementResponse = LiveFinancialStatementResponses[keyof LiveFinancialStatementResponses];
+export type LiveFinancialStatementResponse2 = LiveFinancialStatementResponses[keyof LiveFinancialStatementResponses];
 
 export type BuildFactGridData = {
     body: CreateViewRequest;
@@ -25441,7 +25838,7 @@ export type BuildFactGridResponses = {
     /**
      * Successful Response
      */
-    200: OperationEnvelope;
+    200: OperationEnvelopeViewResponse;
 };
 
 export type BuildFactGridResponse = BuildFactGridResponses[keyof BuildFactGridResponses];
@@ -25505,10 +25902,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;