@lizard-build/sdk 0.1.62 → 0.1.64

package/dist/index.d.mts

@@ -124,6 +124,10 @@ declare class AddonsAPI {
     pause(projectId: string, addonId: string): Promise<PauseState>;
     /** Resume a paused database: same host, port, password and data. */
     resume(projectId: string, addonId: string): Promise<PauseState>;
+    /** Serverless setting of a database (Postgres, Redis). */
+    getSleep(projectId: string, addonId: string): Promise<SleepSetting>;
+    /** Make a database serverless (sleep when idle, wake on the next connection) or always on. */
+    setSleep(projectId: string, addonId: string, opts: SleepOpts): Promise<SleepSetting>;
     rename(projectId: string, addonId: string, name: string): Promise<unknown>;
     secrets(projectId: string, addonId: string): Promise<Array<{
         key: string;
@@ -157,6 +161,26 @@ interface PauseResult {
         reason: string;
     }>;
 }
+/**
+ * Serverless ("sleep when idle"): after `idleMinutes` with no traffic the service sleeps with
+ * its memory saved, and the next request or connection wakes it in about a second.
+ */
+interface SleepSetting {
+    enabled: boolean;
+    idleMinutes: number;
+    lastSleptAt: number | null;
+    lastWokeAt: number | null;
+    lastError: string | null;
+    sleeps: number;
+    wakes: number;
+    /** On a change: whether the service restarted to apply it. */
+    restarted?: boolean;
+}
+/** Turn serverless on (`idleMinutes` 5-1440, default 15) or off. */
+interface SleepOpts {
+    enabled: boolean;
+    idleMinutes?: number;
+}
 /** What pausing or resuming one service answers. */
 interface PauseState {
     ok: boolean;
@@ -363,6 +387,13 @@ declare class ServicesAPI {
     pause(id: string): Promise<PauseState>;
     /** Resume a paused service: it starts again from the same image, with its data. */
     resume(id: string): Promise<PauseState>;
+    /** Serverless setting of a service: whether it sleeps when idle, and how often it did. */
+    getSleep(id: string): Promise<SleepSetting>;
+    /**
+     * Make a service serverless (sleep when idle, wake in about a second on the next request) or
+     * always on. Turning it on restarts it once. Needs one replica and a port.
+     */
+    setSleep(id: string, opts: SleepOpts): Promise<SleepSetting>;
     /** Scale a service. */
     scale(id: string, opts: ScaleOpts): Promise<void>;
     /**
@@ -1434,6 +1465,25 @@ interface Workspace {
     plan?: string;
     createdAt?: number | string;
 }
+/**
+ * Resale prices: each resource's price as a multiple of Lizard's (1-100). API keys scoped
+ * to the workspace see prices and costs multiplied by these; the owner's bill does not change.
+ */
+interface ResaleMultipliers {
+    cpu: number;
+    memory: number;
+    /** Volumes. */
+    storage: number;
+    egress: number;
+    objectStorage: number;
+    /** Sized sandboxes' flat price. */
+    sandbox: number;
+}
+interface ResalePricing {
+    /** False when every multiplier is 1: scoped keys see Lizard's prices. */
+    enabled: boolean;
+    multipliers: ResaleMultipliers;
+}
 interface CreateWorkspaceOpts {
     name: string;
 }
@@ -1479,6 +1529,26 @@ declare class WorkspacesAPI {
     pause(id: string): Promise<PauseResult>;
     /** Resume what was paused in a workspace (owner only; not what a billing freeze paused). */
     resume(id: string): Promise<PauseResult>;
+    /**
+     * The workspace's resale prices (owner only, key with no scopes).
+     *
+     * A scoped key gets HTTP 403 with `code: 'ACCOUNT_SCOPE_REQUIRED'`: the keys that see these
+     * prices can neither read nor change them.
+     */
+    getResalePricing(id: string): Promise<ResalePricing>;
+    /**
+     * Set the workspace's resale prices (owner only, key with no scopes). Replaces them all:
+     * a resource left out is 1. Every API key scoped to the workspace, or to one of its
+     * projects, then sees each price and cost multiplied (sandbox `pricePerHour`, `metrics`
+     * costs, billing summaries). Display only: what Lizard bills you is unchanged.
+     *
+     * ```ts
+     * await lizard.workspaces.setResalePricing(ws.id, { cpu: 4, memory: 4, sandbox: 4 })
+     * ```
+     */
+    setResalePricing(id: string, multipliers: Partial<ResaleMultipliers>): Promise<ResalePricing>;
+    /** Turn resale prices off: scoped keys see Lizard's prices again (owner only). */
+    clearResalePricing(id: string): Promise<ResalePricing>;
     /**
      * Delete a workspace.
      *
@@ -2313,4 +2383,4 @@ declare class LizardCLI {
     }): Promise<CLIResult>;
 }
 
-export { type Account, type Addon, type AddonType, AddonsAPI, type ApiKey, type ApiKeyScope, ApiKeysAPI, AuthenticationError, type Balance, BillingAPI, type CLIOptions, type CLIResult, type CheckoutSession, type ClickOpts, type CodeContext, CodeSandbox, ConfigApplyError, type ConfigResult, ConflictError, type ConnectionOpts, type CostMetrics, type CreateAddonOpts, type CreateApiKeyOpts, type CreateContextOpts, type CreateProjectOpts, type CreateServiceOpts, type CreateVolumeOpts, type CreateWorkspaceOpts, type CreatedApiKey, type DeployEvent, DeployHandle, Desktop, type DesktopInfo, type DesktopStartOpts, type DomainInfo, type DomainStatus, DomainsAPI, Execution, ExecutionError, type ExposedPort, type FileInfo, type ForkResult, type FsEvent, type FsOpts, GitHubAPI, type ListTransactionsOpts, Lizard, LizardCLI, LizardError, type LizardOpts, type LogLine, type MetricPoint, type MetricRange, MetricsAPI, type MouseButton, NotFoundError, PaymentRequiredError, type Plan, PlatformClient, type ProcessInfo, type ProcessOpts, type ProcessResult, type ProcessSignal, type Project, type ProjectConfig, type ProjectCost, ProjectsAPI, type PromoRedemption, type RawMetrics, type Region, RegionsAPI, type RunCodeLanguage, type RunCodeOpts, Sandbox, type SandboxInfo, type SandboxOpts, type SandboxSnapshot, type ScaleOpts, type ScrollDirection, type Secret, SecretsAPI, type Service, type ServiceMetrics, type ServiceUpdate, ServicesAPI, type SetSecretOpts, type SnapshotOpts, type SnapshotScope, type SnapshotWaitOpts, type StartCheckoutOpts, type StartProNowResult, StorageAPI, type StreamEvent, type Subscription, type SubscriptionStatus, TimeoutError, type Transaction, type TransactionPage, Volume, type VolumeInfo, type Workspace, WorkspacesAPI, resolveProjectId };
+export { type Account, type Addon, type AddonType, AddonsAPI, type ApiKey, type ApiKeyScope, ApiKeysAPI, AuthenticationError, type Balance, BillingAPI, type CLIOptions, type CLIResult, type CheckoutSession, type ClickOpts, type CodeContext, CodeSandbox, ConfigApplyError, type ConfigResult, ConflictError, type ConnectionOpts, type CostMetrics, type CreateAddonOpts, type CreateApiKeyOpts, type CreateContextOpts, type CreateProjectOpts, type CreateServiceOpts, type CreateVolumeOpts, type CreateWorkspaceOpts, type CreatedApiKey, type DeployEvent, DeployHandle, Desktop, type DesktopInfo, type DesktopStartOpts, type DomainInfo, type DomainStatus, DomainsAPI, Execution, ExecutionError, type ExposedPort, type FileInfo, type ForkResult, type FsEvent, type FsOpts, GitHubAPI, type ListTransactionsOpts, Lizard, LizardCLI, LizardError, type LizardOpts, type LogLine, type MetricPoint, type MetricRange, MetricsAPI, type MouseButton, NotFoundError, PaymentRequiredError, type Plan, PlatformClient, type ProcessInfo, type ProcessOpts, type ProcessResult, type ProcessSignal, type Project, type ProjectConfig, type ProjectCost, ProjectsAPI, type PromoRedemption, type RawMetrics, type Region, RegionsAPI, type ResaleMultipliers, type ResalePricing, type RunCodeLanguage, type RunCodeOpts, Sandbox, type SandboxInfo, type SandboxOpts, type SandboxSnapshot, type ScaleOpts, type ScrollDirection, type Secret, SecretsAPI, type Service, type ServiceMetrics, type ServiceUpdate, ServicesAPI, type SetSecretOpts, type SnapshotOpts, type SnapshotScope, type SnapshotWaitOpts, type StartCheckoutOpts, type StartProNowResult, StorageAPI, type StreamEvent, type Subscription, type SubscriptionStatus, TimeoutError, type Transaction, type TransactionPage, Volume, type VolumeInfo, type Workspace, WorkspacesAPI, resolveProjectId };

package/dist/index.d.ts

@@ -124,6 +124,10 @@ declare class AddonsAPI {
     pause(projectId: string, addonId: string): Promise<PauseState>;
     /** Resume a paused database: same host, port, password and data. */
     resume(projectId: string, addonId: string): Promise<PauseState>;
+    /** Serverless setting of a database (Postgres, Redis). */
+    getSleep(projectId: string, addonId: string): Promise<SleepSetting>;
+    /** Make a database serverless (sleep when idle, wake on the next connection) or always on. */
+    setSleep(projectId: string, addonId: string, opts: SleepOpts): Promise<SleepSetting>;
     rename(projectId: string, addonId: string, name: string): Promise<unknown>;
     secrets(projectId: string, addonId: string): Promise<Array<{
         key: string;
@@ -157,6 +161,26 @@ interface PauseResult {
         reason: string;
     }>;
 }
+/**
+ * Serverless ("sleep when idle"): after `idleMinutes` with no traffic the service sleeps with
+ * its memory saved, and the next request or connection wakes it in about a second.
+ */
+interface SleepSetting {
+    enabled: boolean;
+    idleMinutes: number;
+    lastSleptAt: number | null;
+    lastWokeAt: number | null;
+    lastError: string | null;
+    sleeps: number;
+    wakes: number;
+    /** On a change: whether the service restarted to apply it. */
+    restarted?: boolean;
+}
+/** Turn serverless on (`idleMinutes` 5-1440, default 15) or off. */
+interface SleepOpts {
+    enabled: boolean;
+    idleMinutes?: number;
+}
 /** What pausing or resuming one service answers. */
 interface PauseState {
     ok: boolean;
@@ -363,6 +387,13 @@ declare class ServicesAPI {
     pause(id: string): Promise<PauseState>;
     /** Resume a paused service: it starts again from the same image, with its data. */
     resume(id: string): Promise<PauseState>;
+    /** Serverless setting of a service: whether it sleeps when idle, and how often it did. */
+    getSleep(id: string): Promise<SleepSetting>;
+    /**
+     * Make a service serverless (sleep when idle, wake in about a second on the next request) or
+     * always on. Turning it on restarts it once. Needs one replica and a port.
+     */
+    setSleep(id: string, opts: SleepOpts): Promise<SleepSetting>;
     /** Scale a service. */
     scale(id: string, opts: ScaleOpts): Promise<void>;
     /**
@@ -1434,6 +1465,25 @@ interface Workspace {
     plan?: string;
     createdAt?: number | string;
 }
+/**
+ * Resale prices: each resource's price as a multiple of Lizard's (1-100). API keys scoped
+ * to the workspace see prices and costs multiplied by these; the owner's bill does not change.
+ */
+interface ResaleMultipliers {
+    cpu: number;
+    memory: number;
+    /** Volumes. */
+    storage: number;
+    egress: number;
+    objectStorage: number;
+    /** Sized sandboxes' flat price. */
+    sandbox: number;
+}
+interface ResalePricing {
+    /** False when every multiplier is 1: scoped keys see Lizard's prices. */
+    enabled: boolean;
+    multipliers: ResaleMultipliers;
+}
 interface CreateWorkspaceOpts {
     name: string;
 }
@@ -1479,6 +1529,26 @@ declare class WorkspacesAPI {
     pause(id: string): Promise<PauseResult>;
     /** Resume what was paused in a workspace (owner only; not what a billing freeze paused). */
     resume(id: string): Promise<PauseResult>;
+    /**
+     * The workspace's resale prices (owner only, key with no scopes).
+     *
+     * A scoped key gets HTTP 403 with `code: 'ACCOUNT_SCOPE_REQUIRED'`: the keys that see these
+     * prices can neither read nor change them.
+     */
+    getResalePricing(id: string): Promise<ResalePricing>;
+    /**
+     * Set the workspace's resale prices (owner only, key with no scopes). Replaces them all:
+     * a resource left out is 1. Every API key scoped to the workspace, or to one of its
+     * projects, then sees each price and cost multiplied (sandbox `pricePerHour`, `metrics`
+     * costs, billing summaries). Display only: what Lizard bills you is unchanged.
+     *
+     * ```ts
+     * await lizard.workspaces.setResalePricing(ws.id, { cpu: 4, memory: 4, sandbox: 4 })
+     * ```
+     */
+    setResalePricing(id: string, multipliers: Partial<ResaleMultipliers>): Promise<ResalePricing>;
+    /** Turn resale prices off: scoped keys see Lizard's prices again (owner only). */
+    clearResalePricing(id: string): Promise<ResalePricing>;
     /**
      * Delete a workspace.
      *
@@ -2313,4 +2383,4 @@ declare class LizardCLI {
     }): Promise<CLIResult>;
 }
 
-export { type Account, type Addon, type AddonType, AddonsAPI, type ApiKey, type ApiKeyScope, ApiKeysAPI, AuthenticationError, type Balance, BillingAPI, type CLIOptions, type CLIResult, type CheckoutSession, type ClickOpts, type CodeContext, CodeSandbox, ConfigApplyError, type ConfigResult, ConflictError, type ConnectionOpts, type CostMetrics, type CreateAddonOpts, type CreateApiKeyOpts, type CreateContextOpts, type CreateProjectOpts, type CreateServiceOpts, type CreateVolumeOpts, type CreateWorkspaceOpts, type CreatedApiKey, type DeployEvent, DeployHandle, Desktop, type DesktopInfo, type DesktopStartOpts, type DomainInfo, type DomainStatus, DomainsAPI, Execution, ExecutionError, type ExposedPort, type FileInfo, type ForkResult, type FsEvent, type FsOpts, GitHubAPI, type ListTransactionsOpts, Lizard, LizardCLI, LizardError, type LizardOpts, type LogLine, type MetricPoint, type MetricRange, MetricsAPI, type MouseButton, NotFoundError, PaymentRequiredError, type Plan, PlatformClient, type ProcessInfo, type ProcessOpts, type ProcessResult, type ProcessSignal, type Project, type ProjectConfig, type ProjectCost, ProjectsAPI, type PromoRedemption, type RawMetrics, type Region, RegionsAPI, type RunCodeLanguage, type RunCodeOpts, Sandbox, type SandboxInfo, type SandboxOpts, type SandboxSnapshot, type ScaleOpts, type ScrollDirection, type Secret, SecretsAPI, type Service, type ServiceMetrics, type ServiceUpdate, ServicesAPI, type SetSecretOpts, type SnapshotOpts, type SnapshotScope, type SnapshotWaitOpts, type StartCheckoutOpts, type StartProNowResult, StorageAPI, type StreamEvent, type Subscription, type SubscriptionStatus, TimeoutError, type Transaction, type TransactionPage, Volume, type VolumeInfo, type Workspace, WorkspacesAPI, resolveProjectId };
+export { type Account, type Addon, type AddonType, AddonsAPI, type ApiKey, type ApiKeyScope, ApiKeysAPI, AuthenticationError, type Balance, BillingAPI, type CLIOptions, type CLIResult, type CheckoutSession, type ClickOpts, type CodeContext, CodeSandbox, ConfigApplyError, type ConfigResult, ConflictError, type ConnectionOpts, type CostMetrics, type CreateAddonOpts, type CreateApiKeyOpts, type CreateContextOpts, type CreateProjectOpts, type CreateServiceOpts, type CreateVolumeOpts, type CreateWorkspaceOpts, type CreatedApiKey, type DeployEvent, DeployHandle, Desktop, type DesktopInfo, type DesktopStartOpts, type DomainInfo, type DomainStatus, DomainsAPI, Execution, ExecutionError, type ExposedPort, type FileInfo, type ForkResult, type FsEvent, type FsOpts, GitHubAPI, type ListTransactionsOpts, Lizard, LizardCLI, LizardError, type LizardOpts, type LogLine, type MetricPoint, type MetricRange, MetricsAPI, type MouseButton, NotFoundError, PaymentRequiredError, type Plan, PlatformClient, type ProcessInfo, type ProcessOpts, type ProcessResult, type ProcessSignal, type Project, type ProjectConfig, type ProjectCost, ProjectsAPI, type PromoRedemption, type RawMetrics, type Region, RegionsAPI, type ResaleMultipliers, type ResalePricing, type RunCodeLanguage, type RunCodeOpts, Sandbox, type SandboxInfo, type SandboxOpts, type SandboxSnapshot, type ScaleOpts, type ScrollDirection, type Secret, SecretsAPI, type Service, type ServiceMetrics, type ServiceUpdate, ServicesAPI, type SetSecretOpts, type SnapshotOpts, type SnapshotScope, type SnapshotWaitOpts, type StartCheckoutOpts, type StartProNowResult, StorageAPI, type StreamEvent, type Subscription, type SubscriptionStatus, TimeoutError, type Transaction, type TransactionPage, Volume, type VolumeInfo, type Workspace, WorkspacesAPI, resolveProjectId };

package/dist/index.js

@@ -418,6 +418,17 @@ var ServicesAPI = class {
   resume(id) {
     return this.client.post(`/api/apps/${id}/resume`, {});
   }
+  /** Serverless setting of a service: whether it sleeps when idle, and how often it did. */
+  getSleep(id) {
+    return this.client.get(`/api/apps/${id}/sleep`);
+  }
+  /**
+   * Make a service serverless (sleep when idle, wake in about a second on the next request) or
+   * always on. Turning it on restarts it once. Needs one replica and a port.
+   */
+  setSleep(id, opts) {
+    return this.client.put(`/api/apps/${id}/sleep`, opts);
+  }
   /** Scale a service. */
   async scale(id, opts) {
     if (opts.storageMi !== void 0) throw new LizardError("Storage scaling is only supported for addons");
@@ -1506,6 +1517,14 @@ var AddonsAPI = class {
   resume(projectId, addonId) {
     return this.client.post(`/api/projects/${projectId}/addons/${addonId}/resume`, {});
   }
+  /** Serverless setting of a database (Postgres, Redis). */
+  getSleep(projectId, addonId) {
+    return this.client.get(`/api/projects/${projectId}/addons/${addonId}/sleep`);
+  }
+  /** Make a database serverless (sleep when idle, wake on the next connection) or always on. */
+  setSleep(projectId, addonId, opts) {
+    return this.client.put(`/api/projects/${projectId}/addons/${addonId}/sleep`, opts);
+  }
   rename(projectId, addonId, name) {
     return this.client.patch(`/api/projects/${projectId}/addons/${addonId}`, { name });
   }
@@ -1707,6 +1726,32 @@ var WorkspacesAPI = class {
   resume(id) {
     return this.client.post(`/api/workspaces/${id}/resume`, {});
   }
+  /**
+   * The workspace's resale prices (owner only, key with no scopes).
+   *
+   * A scoped key gets HTTP 403 with `code: 'ACCOUNT_SCOPE_REQUIRED'`: the keys that see these
+   * prices can neither read nor change them.
+   */
+  getResalePricing(id) {
+    return this.client.get(`/api/workspaces/${id}/resale-pricing`);
+  }
+  /**
+   * Set the workspace's resale prices (owner only, key with no scopes). Replaces them all:
+   * a resource left out is 1. Every API key scoped to the workspace, or to one of its
+   * projects, then sees each price and cost multiplied (sandbox `pricePerHour`, `metrics`
+   * costs, billing summaries). Display only: what Lizard bills you is unchanged.
+   *
+   * ```ts
+   * await lizard.workspaces.setResalePricing(ws.id, { cpu: 4, memory: 4, sandbox: 4 })
+   * ```
+   */
+  setResalePricing(id, multipliers) {
+    return this.client.put(`/api/workspaces/${id}/resale-pricing`, multipliers);
+  }
+  /** Turn resale prices off: scoped keys see Lizard's prices again (owner only). */
+  clearResalePricing(id) {
+    return this.client.put(`/api/workspaces/${id}/resale-pricing`, {});
+  }
   /**
    * Delete a workspace.
    *

package/dist/index.mjs

@@ -365,6 +365,17 @@ var ServicesAPI = class {
   resume(id) {
     return this.client.post(`/api/apps/${id}/resume`, {});
   }
+  /** Serverless setting of a service: whether it sleeps when idle, and how often it did. */
+  getSleep(id) {
+    return this.client.get(`/api/apps/${id}/sleep`);
+  }
+  /**
+   * Make a service serverless (sleep when idle, wake in about a second on the next request) or
+   * always on. Turning it on restarts it once. Needs one replica and a port.
+   */
+  setSleep(id, opts) {
+    return this.client.put(`/api/apps/${id}/sleep`, opts);
+  }
   /** Scale a service. */
   async scale(id, opts) {
     if (opts.storageMi !== void 0) throw new LizardError("Storage scaling is only supported for addons");
@@ -1453,6 +1464,14 @@ var AddonsAPI = class {
   resume(projectId, addonId) {
     return this.client.post(`/api/projects/${projectId}/addons/${addonId}/resume`, {});
   }
+  /** Serverless setting of a database (Postgres, Redis). */
+  getSleep(projectId, addonId) {
+    return this.client.get(`/api/projects/${projectId}/addons/${addonId}/sleep`);
+  }
+  /** Make a database serverless (sleep when idle, wake on the next connection) or always on. */
+  setSleep(projectId, addonId, opts) {
+    return this.client.put(`/api/projects/${projectId}/addons/${addonId}/sleep`, opts);
+  }
   rename(projectId, addonId, name) {
     return this.client.patch(`/api/projects/${projectId}/addons/${addonId}`, { name });
   }
@@ -1654,6 +1673,32 @@ var WorkspacesAPI = class {
   resume(id) {
     return this.client.post(`/api/workspaces/${id}/resume`, {});
   }
+  /**
+   * The workspace's resale prices (owner only, key with no scopes).
+   *
+   * A scoped key gets HTTP 403 with `code: 'ACCOUNT_SCOPE_REQUIRED'`: the keys that see these
+   * prices can neither read nor change them.
+   */
+  getResalePricing(id) {
+    return this.client.get(`/api/workspaces/${id}/resale-pricing`);
+  }
+  /**
+   * Set the workspace's resale prices (owner only, key with no scopes). Replaces them all:
+   * a resource left out is 1. Every API key scoped to the workspace, or to one of its
+   * projects, then sees each price and cost multiplied (sandbox `pricePerHour`, `metrics`
+   * costs, billing summaries). Display only: what Lizard bills you is unchanged.
+   *
+   * ```ts
+   * await lizard.workspaces.setResalePricing(ws.id, { cpu: 4, memory: 4, sandbox: 4 })
+   * ```
+   */
+  setResalePricing(id, multipliers) {
+    return this.client.put(`/api/workspaces/${id}/resale-pricing`, multipliers);
+  }
+  /** Turn resale prices off: scoped keys see Lizard's prices again (owner only). */
+  clearResalePricing(id) {
+    return this.client.put(`/api/workspaces/${id}/resale-pricing`, {});
+  }
   /**
    * Delete a workspace.
    *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lizard-build/sdk",
-  "version": "0.1.62",
+  "version": "0.1.64",
   "description": "TypeScript SDK for Lizard: Firecracker microVM sandboxes, code execution and cloud apps.",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",