@robosystems/client 1.5.0 → 1.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@robosystems/client",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "description": "TypeScript client library for RoboSystems Financial Knowledge Graph API",
   "main": "index.js",
   "types": "index.d.ts",

package/sdk/sdk.gen.d.ts

@@ -304,7 +304,7 @@ export declare const listBackups: <ThrowOnError extends boolean = false>(options
 /**
  * Get temporary download URL for backup
  *
- * Generate a temporary download URL for a backup (unencrypted backups only). The filename carries the extension listed as `download_extension` on the backup: `.lbug.zip` is a ZIP holding the LadybugDB database file `{graph_id}.lbug`; `.lbug.zst` (shared repository snapshots) is a single zstd-compressed database file. Decompress the latter with `zstd -d <file>.lbug.zst` (install zstd first: `brew install zstd`, `apt-get install zstd`, or `dnf install zstd`) — no `--long` flag is needed.
+ * Generate a temporary download URL for a backup. The filename carries the extension listed as `download_extension` on the backup: `.lbug.zip` is a ZIP holding the LadybugDB database file `{graph_id}.lbug`; `.lbug.zst` (shared repository snapshots) is a single zstd-compressed database file. Decompress the latter with `zstd -d <file>.lbug.zst` (install zstd first: `brew install zstd`, `apt-get install zstd`, or `dnf install zstd`) — no `--long` flag is needed.
  */
 export declare const getBackupDownloadUrl: <ThrowOnError extends boolean = false>(options: Options<GetBackupDownloadUrlData, ThrowOnError>) => import("./client").RequestResult<GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, ThrowOnError, "fields">;
 /**
@@ -498,7 +498,7 @@ export declare const createBackup: <ThrowOnError extends boolean = false>(option
 /**
  * Restore Backup
  *
- * Only encrypted backups can be restored. Not allowed on entity graphs (use `materialize` instead) or shared repositories.
+ * Not allowed on entity graphs (use `materialize` instead) or shared repositories. Destructive: the existing database is snapshotted, then overwritten. Monitor progress via SSE at `/v1/operations/{operation_id}/stream`.
  *
  * **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/sdk.gen.js

@@ -611,7 +611,7 @@ exports.listBackups = listBackups;
 /**
  * Get temporary download URL for backup
  *
- * Generate a temporary download URL for a backup (unencrypted backups only). The filename carries the extension listed as `download_extension` on the backup: `.lbug.zip` is a ZIP holding the LadybugDB database file `{graph_id}.lbug`; `.lbug.zst` (shared repository snapshots) is a single zstd-compressed database file. Decompress the latter with `zstd -d <file>.lbug.zst` (install zstd first: `brew install zstd`, `apt-get install zstd`, or `dnf install zstd`) — no `--long` flag is needed.
+ * Generate a temporary download URL for a backup. The filename carries the extension listed as `download_extension` on the backup: `.lbug.zip` is a ZIP holding the LadybugDB database file `{graph_id}.lbug`; `.lbug.zst` (shared repository snapshots) is a single zstd-compressed database file. Decompress the latter with `zstd -d <file>.lbug.zst` (install zstd first: `brew install zstd`, `apt-get install zstd`, or `dnf install zstd`) — no `--long` flag is needed.
  */
 const getBackupDownloadUrl = (options) => (options.client ?? client_gen_1.client).get({
     security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -1032,7 +1032,7 @@ exports.createBackup = createBackup;
 /**
  * Restore Backup
  *
- * Only encrypted backups can be restored. Not allowed on entity graphs (use `materialize` instead) or shared repositories.
+ * Not allowed on entity graphs (use `materialize` instead) or shared repositories. Destructive: the existing database is snapshotted, then overwritten. Monitor progress via SSE at `/v1/operations/{operation_id}/stream`.
  *
  * **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/sdk.gen.ts

@@ -623,7 +623,7 @@ export const listBackups = <ThrowOnError extends boolean = false>(options: Optio
 /**
  * Get temporary download URL for backup
  *
- * Generate a temporary download URL for a backup (unencrypted backups only). The filename carries the extension listed as `download_extension` on the backup: `.lbug.zip` is a ZIP holding the LadybugDB database file `{graph_id}.lbug`; `.lbug.zst` (shared repository snapshots) is a single zstd-compressed database file. Decompress the latter with `zstd -d <file>.lbug.zst` (install zstd first: `brew install zstd`, `apt-get install zstd`, or `dnf install zstd`) — no `--long` flag is needed.
+ * Generate a temporary download URL for a backup. The filename carries the extension listed as `download_extension` on the backup: `.lbug.zip` is a ZIP holding the LadybugDB database file `{graph_id}.lbug`; `.lbug.zst` (shared repository snapshots) is a single zstd-compressed database file. Decompress the latter with `zstd -d <file>.lbug.zst` (install zstd first: `brew install zstd`, `apt-get install zstd`, or `dnf install zstd`) — no `--long` flag is needed.
  */
 export const getBackupDownloadUrl = <ThrowOnError extends boolean = false>(options: Options<GetBackupDownloadUrlData, ThrowOnError>) => (options.client ?? client).get<GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, ThrowOnError>({
     security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -1044,7 +1044,7 @@ export const createBackup = <ThrowOnError extends boolean = false>(options: Opti
 /**
  * Restore Backup
  *
- * Only encrypted backups can be restored. Not allowed on entity graphs (use `materialize` instead) or shared repositories.
+ * Not allowed on entity graphs (use `materialize` instead) or shared repositories. Destructive: the existing database is snapshotted, then overwritten. Monitor progress via SSE at `/v1/operations/{operation_id}/stream`.
  *
  * **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/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;
     /**
@@ -19035,7 +19027,7 @@ export type GetBackupDownloadUrlData = {
 };
 export type GetBackupDownloadUrlErrors = {
     /**
-     * Access denied or backup is encrypted
+     * Access denied
      */
     403: unknown;
     /**

package/sdk/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;
     /**
@@ -19723,7 +19715,7 @@ export type GetBackupDownloadUrlData = {
 
 export type GetBackupDownloadUrlErrors = {
     /**
-     * Access denied or backup is encrypted
+     * Access denied
      */
     403: unknown;
     /**

package/sdk.gen.d.ts

@@ -304,7 +304,7 @@ export declare const listBackups: <ThrowOnError extends boolean = false>(options
 /**
  * Get temporary download URL for backup
  *
- * Generate a temporary download URL for a backup (unencrypted backups only). The filename carries the extension listed as `download_extension` on the backup: `.lbug.zip` is a ZIP holding the LadybugDB database file `{graph_id}.lbug`; `.lbug.zst` (shared repository snapshots) is a single zstd-compressed database file. Decompress the latter with `zstd -d <file>.lbug.zst` (install zstd first: `brew install zstd`, `apt-get install zstd`, or `dnf install zstd`) — no `--long` flag is needed.
+ * Generate a temporary download URL for a backup. The filename carries the extension listed as `download_extension` on the backup: `.lbug.zip` is a ZIP holding the LadybugDB database file `{graph_id}.lbug`; `.lbug.zst` (shared repository snapshots) is a single zstd-compressed database file. Decompress the latter with `zstd -d <file>.lbug.zst` (install zstd first: `brew install zstd`, `apt-get install zstd`, or `dnf install zstd`) — no `--long` flag is needed.
  */
 export declare const getBackupDownloadUrl: <ThrowOnError extends boolean = false>(options: Options<GetBackupDownloadUrlData, ThrowOnError>) => import("./client").RequestResult<GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, ThrowOnError, "fields">;
 /**
@@ -498,7 +498,7 @@ export declare const createBackup: <ThrowOnError extends boolean = false>(option
 /**
  * Restore Backup
  *
- * Only encrypted backups can be restored. Not allowed on entity graphs (use `materialize` instead) or shared repositories.
+ * Not allowed on entity graphs (use `materialize` instead) or shared repositories. Destructive: the existing database is snapshotted, then overwritten. Monitor progress via SSE at `/v1/operations/{operation_id}/stream`.
  *
  * **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

@@ -611,7 +611,7 @@ exports.listBackups = listBackups;
 /**
  * Get temporary download URL for backup
  *
- * Generate a temporary download URL for a backup (unencrypted backups only). The filename carries the extension listed as `download_extension` on the backup: `.lbug.zip` is a ZIP holding the LadybugDB database file `{graph_id}.lbug`; `.lbug.zst` (shared repository snapshots) is a single zstd-compressed database file. Decompress the latter with `zstd -d <file>.lbug.zst` (install zstd first: `brew install zstd`, `apt-get install zstd`, or `dnf install zstd`) — no `--long` flag is needed.
+ * Generate a temporary download URL for a backup. The filename carries the extension listed as `download_extension` on the backup: `.lbug.zip` is a ZIP holding the LadybugDB database file `{graph_id}.lbug`; `.lbug.zst` (shared repository snapshots) is a single zstd-compressed database file. Decompress the latter with `zstd -d <file>.lbug.zst` (install zstd first: `brew install zstd`, `apt-get install zstd`, or `dnf install zstd`) — no `--long` flag is needed.
  */
 const getBackupDownloadUrl = (options) => (options.client ?? client_gen_1.client).get({
     security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -1032,7 +1032,7 @@ exports.createBackup = createBackup;
 /**
  * Restore Backup
  *
- * Only encrypted backups can be restored. Not allowed on entity graphs (use `materialize` instead) or shared repositories.
+ * Not allowed on entity graphs (use `materialize` instead) or shared repositories. Destructive: the existing database is snapshotted, then overwritten. Monitor progress via SSE at `/v1/operations/{operation_id}/stream`.
  *
  * **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

@@ -623,7 +623,7 @@ export const listBackups = <ThrowOnError extends boolean = false>(options: Optio
 /**
  * Get temporary download URL for backup
  *
- * Generate a temporary download URL for a backup (unencrypted backups only). The filename carries the extension listed as `download_extension` on the backup: `.lbug.zip` is a ZIP holding the LadybugDB database file `{graph_id}.lbug`; `.lbug.zst` (shared repository snapshots) is a single zstd-compressed database file. Decompress the latter with `zstd -d <file>.lbug.zst` (install zstd first: `brew install zstd`, `apt-get install zstd`, or `dnf install zstd`) — no `--long` flag is needed.
+ * Generate a temporary download URL for a backup. The filename carries the extension listed as `download_extension` on the backup: `.lbug.zip` is a ZIP holding the LadybugDB database file `{graph_id}.lbug`; `.lbug.zst` (shared repository snapshots) is a single zstd-compressed database file. Decompress the latter with `zstd -d <file>.lbug.zst` (install zstd first: `brew install zstd`, `apt-get install zstd`, or `dnf install zstd`) — no `--long` flag is needed.
  */
 export const getBackupDownloadUrl = <ThrowOnError extends boolean = false>(options: Options<GetBackupDownloadUrlData, ThrowOnError>) => (options.client ?? client).get<GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, ThrowOnError>({
     security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -1044,7 +1044,7 @@ export const createBackup = <ThrowOnError extends boolean = false>(options: Opti
 /**
  * Restore Backup
  *
- * Only encrypted backups can be restored. Not allowed on entity graphs (use `materialize` instead) or shared repositories.
+ * Not allowed on entity graphs (use `materialize` instead) or shared repositories. Destructive: the existing database is snapshotted, then overwritten. Monitor progress via SSE at `/v1/operations/{operation_id}/stream`.
  *
  * **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/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;
     /**
@@ -19035,7 +19027,7 @@ export type GetBackupDownloadUrlData = {
 };
 export type GetBackupDownloadUrlErrors = {
     /**
-     * Access denied or backup is encrypted
+     * Access denied
      */
     403: unknown;
     /**

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;
     /**
@@ -19723,7 +19715,7 @@ export type GetBackupDownloadUrlData = {
 
 export type GetBackupDownloadUrlErrors = {
     /**
-     * Access denied or backup is encrypted
+     * Access denied
      */
     403: unknown;
     /**