@robosystems/client 1.4.2 → 1.6.0

package/types.gen.d.ts

@@ -729,12 +729,6 @@ export type BackupCreateRequest = {
      * Enable compression (always enabled for optimal storage)
      */
     compression?: boolean;
-    /**
-     * Encryption
-     *
-     * Enable encryption (encrypted backups cannot be downloaded)
-     */
-    encryption?: boolean;
     /**
      * Schedule
      *
@@ -828,6 +822,12 @@ export type BackupListResponse = {
      * Whether this is a shared repository (limits apply)
      */
     is_shared_repository?: boolean;
+    /**
+     * Restore Supported
+     *
+     * Whether backups on this graph can be restored. False for entity graphs, which are materialized from the extensions database (use the materialize operation instead), and for shared repositories, which are platform-managed and download-only.
+     */
+    restore_supported?: boolean;
     /**
      * Download quota for shared repositories
      */
@@ -883,22 +883,14 @@ export type BackupResponse = {
      * Backup Duration Seconds
      */
     backup_duration_seconds: number;
-    /**
-     * Encryption Enabled
-     */
-    encryption_enabled: boolean;
     /**
      * Compression Enabled
      */
     compression_enabled: boolean;
-    /**
-     * Allow Export
-     */
-    allow_export: boolean;
     /**
      * Download Extension
      *
-     * Extension the download will carry, and therefore how to unpack it: '.lbug.zip' is a ZIP holding the LadybugDB database file, '.lbug.zst' is zstd-compressed (`zstd -d`). Null when the backup is encrypted and so cannot be downloaded.
+     * Extension the download will carry, and therefore how to unpack it: '.lbug.zip' is a ZIP holding the LadybugDB database file, '.lbug.zst' is zstd-compressed (`zstd -d`). Null only when the backup has no stored object yet.
      */
     download_extension?: string | null;
     /**
@@ -5235,7 +5227,7 @@ export type FactSetLite = {
     /**
      * Provenance
      *
-     * Typed ``FactProvenance`` descriptor (discriminated on ``origin``: pivot | schedule | derived | asserted) recording how this FactSet's facts were constructed. Surfaced as JSON, mirroring how mechanics is exposed. Null when the FactSet carries no descriptor.
+     * Typed ``FactProvenance`` descriptor (discriminated on ``origin``: pivot | schedule | derived | asserted | document | forecast | filed) recording how this FactSet's facts were constructed. Surfaced as JSON, mirroring how mechanics is exposed. Null when the FactSet carries no descriptor.
      */
     provenance?: {
         [key: string]: unknown;
@@ -5857,6 +5849,18 @@ export type GraphInfo = {
      * Display name for the graph
      */
     graphName: string;
+    /**
+     * Description
+     *
+     * Free-form description ('' when unset)
+     */
+    description?: string;
+    /**
+     * Tags
+     *
+     * Organizational tags for the graph
+     */
+    tags?: Array<string>;
     /**
      * Role
      *
@@ -6071,6 +6075,43 @@ export type GraphMetadata = {
      */
     tags?: Array<string>;
 };
+/**
+ * GraphMetadataResult
+ *
+ * Result payload for the update-graph-metadata operation.
+ */
+export type GraphMetadataResult = {
+    /**
+     * Graph Id
+     *
+     * Graph the metadata belongs to
+     */
+    graph_id: string;
+    /**
+     * Graph Name
+     *
+     * Display name after the update
+     */
+    graph_name: string;
+    /**
+     * Description
+     *
+     * Description after the update ('' when unset)
+     */
+    description?: string;
+    /**
+     * Tags
+     *
+     * Tags after the update (empty when unset)
+     */
+    tags?: Array<string>;
+    /**
+     * Updated Fields
+     *
+     * Fields this call actually changed. Empty when the submitted values already matched what was stored.
+     */
+    updated_fields?: Array<string>;
+};
 /**
  * GraphMetricsResponse
  *
@@ -9567,6 +9608,51 @@ export type OperationEnvelopeFiscalCalendarResponse = {
      */
     idempotentReplay?: boolean;
 };
+/**
+ * OperationEnvelope[GraphMetadataResult]
+ */
+export type OperationEnvelopeGraphMetadataResult = {
+    /**
+     * 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?: GraphMetadataResult | 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[InformationBlockEnvelope]
  */
@@ -15291,6 +15377,42 @@ export type UpdateForecastRequest = {
 export type UpdateGraphMemberRoleRequest = {
     role: GraphRole;
 };
+/**
+ * UpdateGraphMetadataOp
+ *
+ * Body for the update-graph-metadata operation.
+ *
+ * Partial update — only supplied (non-null) fields change, so a caller
+ * editing just the display name need not resend the description and tags.
+ * Because ``None`` means "leave alone", clearing a field uses its empty
+ * value instead: pass ``""`` to clear the description and ``[]`` to clear
+ * the tags. ``graph_name`` cannot be cleared; it is the graph's label
+ * everywhere it is listed.
+ *
+ * This is the platform-level label for the graph, independent of the
+ * entity name shown on financial statements — change that through
+ * ``POST /extensions/roboledger/{graph_id}/operations/update-entity``.
+ */
+export type UpdateGraphMetadataOp = {
+    /**
+     * Graph Name
+     *
+     * New display name. Omit to leave unchanged; cannot be cleared.
+     */
+    graph_name?: string | null;
+    /**
+     * Description
+     *
+     * New description. Omit to leave unchanged; pass '' to clear.
+     */
+    description?: string | null;
+    /**
+     * Tags
+     *
+     * Replaces the full tag list (not a merge). Omit to leave unchanged; pass [] to clear. Tags are trimmed, de-duplicated, and capped at 50 characters each.
+     */
+    tags?: Array<string> | null;
+};
 /**
  * UpdateInformationBlockRequest
  *
@@ -18905,7 +19027,7 @@ export type GetBackupDownloadUrlData = {
 };
 export type GetBackupDownloadUrlErrors = {
     /**
-     * Access denied or backup is encrypted
+     * Access denied
      */
     403: unknown;
     /**
@@ -20967,6 +21089,65 @@ export type ChangeTierResponses = {
     202: OperationEnvelope;
 };
 export type ChangeTierResponse = ChangeTierResponses[keyof ChangeTierResponses];
+export type UpdateGraphMetadataData = {
+    body: UpdateGraphMetadataOp;
+    headers?: {
+        /**
+         * Idempotency-Key
+         */
+        'Idempotency-Key'?: string | null;
+    };
+    path: {
+        /**
+         * Graph Id
+         */
+        graph_id: string;
+    };
+    query?: never;
+    url: '/v1/graphs/{graph_id}/operations/update-graph-metadata';
+};
+export type UpdateGraphMetadataErrors = {
+    /**
+     * 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 UpdateGraphMetadataError = UpdateGraphMetadataErrors[keyof UpdateGraphMetadataErrors];
+export type UpdateGraphMetadataResponses = {
+    /**
+     * Successful Response
+     */
+    200: OperationEnvelopeGraphMetadataResult;
+};
+export type UpdateGraphMetadataResponse = UpdateGraphMetadataResponses[keyof UpdateGraphMetadataResponses];
 export type MaterializeData = {
     body: MaterializeOp;
     headers?: {

package/types.gen.ts

@@ -752,12 +752,6 @@ export type BackupCreateRequest = {
      * Enable compression (always enabled for optimal storage)
      */
     compression?: boolean;
-    /**
-     * Encryption
-     *
-     * Enable encryption (encrypted backups cannot be downloaded)
-     */
-    encryption?: boolean;
     /**
      * Schedule
      *
@@ -854,6 +848,12 @@ export type BackupListResponse = {
      * Whether this is a shared repository (limits apply)
      */
     is_shared_repository?: boolean;
+    /**
+     * Restore Supported
+     *
+     * Whether backups on this graph can be restored. False for entity graphs, which are materialized from the extensions database (use the materialize operation instead), and for shared repositories, which are platform-managed and download-only.
+     */
+    restore_supported?: boolean;
     /**
      * Download quota for shared repositories
      */
@@ -910,22 +910,14 @@ export type BackupResponse = {
      * Backup Duration Seconds
      */
     backup_duration_seconds: number;
-    /**
-     * Encryption Enabled
-     */
-    encryption_enabled: boolean;
     /**
      * Compression Enabled
      */
     compression_enabled: boolean;
-    /**
-     * Allow Export
-     */
-    allow_export: boolean;
     /**
      * Download Extension
      *
-     * Extension the download will carry, and therefore how to unpack it: '.lbug.zip' is a ZIP holding the LadybugDB database file, '.lbug.zst' is zstd-compressed (`zstd -d`). Null when the backup is encrypted and so cannot be downloaded.
+     * Extension the download will carry, and therefore how to unpack it: '.lbug.zip' is a ZIP holding the LadybugDB database file, '.lbug.zst' is zstd-compressed (`zstd -d`). Null only when the backup has no stored object yet.
      */
     download_extension?: string | null;
     /**
@@ -5367,7 +5359,7 @@ export type FactSetLite = {
     /**
      * Provenance
      *
-     * Typed ``FactProvenance`` descriptor (discriminated on ``origin``: pivot | schedule | derived | asserted) recording how this FactSet's facts were constructed. Surfaced as JSON, mirroring how mechanics is exposed. Null when the FactSet carries no descriptor.
+     * Typed ``FactProvenance`` descriptor (discriminated on ``origin``: pivot | schedule | derived | asserted | document | forecast | filed) recording how this FactSet's facts were constructed. Surfaced as JSON, mirroring how mechanics is exposed. Null when the FactSet carries no descriptor.
      */
     provenance?: {
         [key: string]: unknown;
@@ -6004,6 +5996,18 @@ export type GraphInfo = {
      * Display name for the graph
      */
     graphName: string;
+    /**
+     * Description
+     *
+     * Free-form description ('' when unset)
+     */
+    description?: string;
+    /**
+     * Tags
+     *
+     * Organizational tags for the graph
+     */
+    tags?: Array<string>;
     /**
      * Role
      *
@@ -6223,6 +6227,44 @@ export type GraphMetadata = {
     tags?: Array<string>;
 };
 
+/**
+ * GraphMetadataResult
+ *
+ * Result payload for the update-graph-metadata operation.
+ */
+export type GraphMetadataResult = {
+    /**
+     * Graph Id
+     *
+     * Graph the metadata belongs to
+     */
+    graph_id: string;
+    /**
+     * Graph Name
+     *
+     * Display name after the update
+     */
+    graph_name: string;
+    /**
+     * Description
+     *
+     * Description after the update ('' when unset)
+     */
+    description?: string;
+    /**
+     * Tags
+     *
+     * Tags after the update (empty when unset)
+     */
+    tags?: Array<string>;
+    /**
+     * Updated Fields
+     *
+     * Fields this call actually changed. Empty when the submitted values already matched what was stored.
+     */
+    updated_fields?: Array<string>;
+};
+
 /**
  * GraphMetricsResponse
  *
@@ -9797,6 +9839,52 @@ export type OperationEnvelopeFiscalCalendarResponse = {
     idempotentReplay?: boolean;
 };
 
+/**
+ * OperationEnvelope[GraphMetadataResult]
+ */
+export type OperationEnvelopeGraphMetadataResult = {
+    /**
+     * 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?: GraphMetadataResult | 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[InformationBlockEnvelope]
  */
@@ -15670,6 +15758,43 @@ export type UpdateGraphMemberRoleRequest = {
     role: GraphRole;
 };
 
+/**
+ * UpdateGraphMetadataOp
+ *
+ * Body for the update-graph-metadata operation.
+ *
+ * Partial update — only supplied (non-null) fields change, so a caller
+ * editing just the display name need not resend the description and tags.
+ * Because ``None`` means "leave alone", clearing a field uses its empty
+ * value instead: pass ``""`` to clear the description and ``[]`` to clear
+ * the tags. ``graph_name`` cannot be cleared; it is the graph's label
+ * everywhere it is listed.
+ *
+ * This is the platform-level label for the graph, independent of the
+ * entity name shown on financial statements — change that through
+ * ``POST /extensions/roboledger/{graph_id}/operations/update-entity``.
+ */
+export type UpdateGraphMetadataOp = {
+    /**
+     * Graph Name
+     *
+     * New display name. Omit to leave unchanged; cannot be cleared.
+     */
+    graph_name?: string | null;
+    /**
+     * Description
+     *
+     * New description. Omit to leave unchanged; pass '' to clear.
+     */
+    description?: string | null;
+    /**
+     * Tags
+     *
+     * Replaces the full tag list (not a merge). Omit to leave unchanged; pass [] to clear. Tags are trimmed, de-duplicated, and capped at 50 characters each.
+     */
+    tags?: Array<string> | null;
+};
+
 /**
  * UpdateInformationBlockRequest
  *
@@ -19590,7 +19715,7 @@ export type GetBackupDownloadUrlData = {
 
 export type GetBackupDownloadUrlErrors = {
     /**
-     * Access denied or backup is encrypted
+     * Access denied
      */
     403: unknown;
     /**
@@ -21835,6 +21960,70 @@ export type ChangeTierResponses = {
 
 export type ChangeTierResponse = ChangeTierResponses[keyof ChangeTierResponses];
 
+export type UpdateGraphMetadataData = {
+    body: UpdateGraphMetadataOp;
+    headers?: {
+        /**
+         * Idempotency-Key
+         */
+        'Idempotency-Key'?: string | null;
+    };
+    path: {
+        /**
+         * Graph Id
+         */
+        graph_id: string;
+    };
+    query?: never;
+    url: '/v1/graphs/{graph_id}/operations/update-graph-metadata';
+};
+
+export type UpdateGraphMetadataErrors = {
+    /**
+     * 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 UpdateGraphMetadataError = UpdateGraphMetadataErrors[keyof UpdateGraphMetadataErrors];
+
+export type UpdateGraphMetadataResponses = {
+    /**
+     * Successful Response
+     */
+    200: OperationEnvelopeGraphMetadataResult;
+};
+
+export type UpdateGraphMetadataResponse = UpdateGraphMetadataResponses[keyof UpdateGraphMetadataResponses];
+
 export type MaterializeData = {
     body: MaterializeOp;
     headers?: {