@robosystems/client 0.5.11 → 0.5.13

package/sdk/types.gen.d.ts

@@ -511,7 +511,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;
     /**
@@ -5489,7 +5489,7 @@ export type GraphLimitsResponse = {
     /**
      * Subscription Tier
      *
-     * User's subscription tier
+     * Rate-limit tier enforced for requests to this graph
      */
     subscription_tier: string;
     /**
@@ -5827,6 +5827,12 @@ export type GraphSubscriptionTier = {
      * Instance type
      */
     instance_type?: string | null;
+    /**
+     * Instance Storage Limit Gb
+     *
+     * Soft storage cap for the instance in GB
+     */
+    instance_storage_limit_gb?: number;
 };
 /**
  * GraphSubscriptions
@@ -6021,7 +6027,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;
     /**
@@ -7467,7 +7473,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;
     /**
@@ -7573,6 +7579,72 @@ 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
  *
@@ -7855,6 +7927,37 @@ 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
  *
@@ -9069,6 +9172,51 @@ 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]
  */
@@ -11298,7 +11446,7 @@ export type RenderingRowLite = {
 /**
  * ReopenPeriodOperation
  *
- * Reopen the most recently closed fiscal period.
+ * Reopen a closed fiscal period.
  */
 export type ReopenPeriodOperation = {
     /**
@@ -11316,7 +11464,7 @@ export type ReopenPeriodOperation = {
     /**
      * Period
      *
-     * Period to reopen, in YYYY-MM. Must equal current `closed_through` — only the most recent close can be undone.
+     * Period to reopen, in YYYY-MM. Any closed period may be reopened. Reopening the current `closed_through` retreats it by one month; reopening an earlier period leaves `closed_through` where it is (a prior-period adjustment), and its re-close restores the period without moving the pointer.
      */
     period: string;
 };
@@ -17078,8 +17226,9 @@ export type OauthCallbackResponses = {
     /**
      * Successful Response
      */
-    200: unknown;
+    200: OAuthCallbackResponse;
 };
+export type OauthCallbackResponse = OauthCallbackResponses[keyof OauthCallbackResponses];
 export type ListConnectionsData = {
     body?: never;
     path: {
@@ -24169,9 +24318,9 @@ 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;
     headers?: {

package/sdk/types.gen.ts

@@ -529,7 +529,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;
     /**
@@ -5626,7 +5626,7 @@ export type GraphLimitsResponse = {
     /**
      * Subscription Tier
      *
-     * User's subscription tier
+     * Rate-limit tier enforced for requests to this graph
      */
     subscription_tier: string;
     /**
@@ -5968,6 +5968,12 @@ export type GraphSubscriptionTier = {
      * Instance type
      */
     instance_type?: string | null;
+    /**
+     * Instance Storage Limit Gb
+     *
+     * Soft storage cap for the instance in GB
+     */
+    instance_storage_limit_gb?: number;
 };
 
 /**
@@ -6167,7 +6173,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;
     /**
@@ -7643,7 +7649,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;
     /**
@@ -7752,6 +7758,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
  *
@@ -8043,6 +8117,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
  *
@@ -9284,6 +9390,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]
  */
@@ -11574,7 +11726,7 @@ export type RenderingRowLite = {
 /**
  * ReopenPeriodOperation
  *
- * Reopen the most recently closed fiscal period.
+ * Reopen a closed fiscal period.
  */
 export type ReopenPeriodOperation = {
     /**
@@ -11592,7 +11744,7 @@ export type ReopenPeriodOperation = {
     /**
      * Period
      *
-     * Period to reopen, in YYYY-MM. Must equal current `closed_through` — only the most recent close can be undone.
+     * Period to reopen, in YYYY-MM. Any closed period may be reopened. Reopening the current `closed_through` retreats it by one month; reopening an earlier period leaves `closed_through` where it is (a prior-period adjustment), and its re-close restores the period without moving the pointer.
      */
     period: string;
 };
@@ -17656,9 +17808,11 @@ export type OauthCallbackResponses = {
     /**
      * Successful Response
      */
-    200: unknown;
+    200: OAuthCallbackResponse;
 };
 
+export type OauthCallbackResponse = OauthCallbackResponses[keyof OauthCallbackResponses];
+
 export type ListConnectionsData = {
     body?: never;
     path: {
@@ -25371,10 +25525,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;

package/sdk.gen.d.ts

@@ -944,7 +944,7 @@ export declare const closePeriod: <ThrowOnError extends boolean = false>(options
 /**
  * Reopen Fiscal Period
  *
- * Decrement `closed_through` by one. Only the most recently closed period can be reopened (no reach-back). Retracts the month's canonical statement FactSets (a reopened month is no longer a closed assertion; re-closing restamps them). The required `reason` is captured in the audit log. Use sparingly — reopen invalidates downstream artifacts that trusted the closed state (reports, shared filings).
+ * Reopen a closed period for adjustment. Reopening the current `closed_through` decrements it by one; reopening an earlier period is a prior-period adjustment and leaves `closed_through` unchanged — re-closing it restores the period without advancing the pointer. Either way the period's entries become writable again. Retracts the month's canonical statement FactSets (a reopened month is no longer a closed assertion; re-closing restamps them). The required `reason` is captured in the audit log. Use sparingly — reopen invalidates downstream artifacts that trusted the closed state (reports, shared filings).
  *
  * **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.
  */

package/sdk.gen.js

@@ -1967,7 +1967,7 @@ exports.closePeriod = closePeriod;
 /**
  * Reopen Fiscal Period
  *
- * Decrement `closed_through` by one. Only the most recently closed period can be reopened (no reach-back). Retracts the month's canonical statement FactSets (a reopened month is no longer a closed assertion; re-closing restamps them). The required `reason` is captured in the audit log. Use sparingly — reopen invalidates downstream artifacts that trusted the closed state (reports, shared filings).
+ * Reopen a closed period for adjustment. Reopening the current `closed_through` decrements it by one; reopening an earlier period is a prior-period adjustment and leaves `closed_through` unchanged — re-closing it restores the period without advancing the pointer. Either way the period's entries become writable again. Retracts the month's canonical statement FactSets (a reopened month is no longer a closed assertion; re-closing restamps them). The required `reason` is captured in the audit log. Use sparingly — reopen invalidates downstream artifacts that trusted the closed state (reports, shared filings).
  *
  * **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.
  */

package/sdk.gen.ts

@@ -1979,7 +1979,7 @@ export const closePeriod = <ThrowOnError extends boolean = false>(options: Optio
 /**
  * Reopen Fiscal Period
  *
- * Decrement `closed_through` by one. Only the most recently closed period can be reopened (no reach-back). Retracts the month's canonical statement FactSets (a reopened month is no longer a closed assertion; re-closing restamps them). The required `reason` is captured in the audit log. Use sparingly — reopen invalidates downstream artifacts that trusted the closed state (reports, shared filings).
+ * Reopen a closed period for adjustment. Reopening the current `closed_through` decrements it by one; reopening an earlier period is a prior-period adjustment and leaves `closed_through` unchanged — re-closing it restores the period without advancing the pointer. Either way the period's entries become writable again. Retracts the month's canonical statement FactSets (a reopened month is no longer a closed assertion; re-closing restamps them). The required `reason` is captured in the audit log. Use sparingly — reopen invalidates downstream artifacts that trusted the closed state (reports, shared filings).
  *
  * **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.
  */