@scalix-world/sdk 1.3.5 → 1.4.1

package/dist/esm/generated/sdk.gen.js

@@ -239,6 +239,22 @@ export const realtimeWebsocket = (options) => (options.client ?? client).get({
     url: '/api/v1/tenants/{tenant_id}/realtime/ws',
     ...options
 });
+/**
+ * Branch a timeline.
+ *
+ * Restores the parent timeline's durable base backup + archived WAL into a
+ * NEW compute worker replayed to `branch_lsn` (`0` = latest), then routes the
+ * branch endpoint. The branch archives onto its own timeline from that point.
+ */
+export const branchTimeline = (options) => (options.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/api/v1/tenants/{tenant_id}/timelines/{timeline_id}/branch',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
 /**
  * Batch upsert vectors.
  *
@@ -1075,6 +1091,9 @@ export const listBuilds = (options) => (options?.client ?? client).get({
  * Start a build.
  *
  * Starts a container image build and returns the build record.
+ *
+ * For a private repository, either install the Scalix GitHub App for the
+ * project (builds then authenticate themselves) or pass `auth_token`.
  */
 export const createBuild = (options) => (options.client ?? client).post({
     security: [{ scheme: 'bearer', type: 'http' }],
@@ -1085,6 +1104,23 @@ export const createBuild = (options) => (options.client ?? client).post({
         ...options.headers
     }
 });
+/**
+ * Upload source and build.
+ *
+ * Builds from an uploaded source tree instead of a URL, so the source never
+ * has to be reachable from the internet. The request body IS the gzipped
+ * tarball (`Content-Type: application/gzip`); metadata goes in the query
+ * string. Multipart is not accepted.
+ */
+export const uploadBuild = (options) => (options.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/build/upload',
+    ...options,
+    headers: {
+        'Content-Type': 'application/gzip',
+        ...options.headers
+    }
+});
 /**
  * Get a build.
  *
@@ -1315,6 +1351,138 @@ export const listDeploymentVersions = (options) => (options.client ?? client).ge
     url: '/v1/compute/deployments/{id}/versions',
     ...options
 });
+/**
+ * List your Computers.
+ */
+export const computerList = (options) => (options?.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/computers',
+    ...options
+});
+/**
+ * Create a Computer.
+ *
+ * Boots a persistent Linux machine and returns once it is provisioning. The
+ * root disk survives stop/start and is only reclaimed by DELETE. Billed per
+ * start, per vCPU-hour and GB-hour while running, and per GB-month of disk
+ * for as long as the Computer exists.
+ */
+export const computerCreate = (options) => (options.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/computers',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+/**
+ * Get or create a Computer by name.
+ *
+ * Idempotent: the first call creates the machine (201), every identical
+ * repeat returns the existing one (200). Resource changes on a repeat are
+ * ignored — the existing machine wins. Use this instead of create when an
+ * agent may retry.
+ */
+export const computerGetOrCreateByName = (options) => (options.client ?? client).put({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/computers/by-name/{name}',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+/**
+ * Delete a Computer.
+ *
+ * The only operation that reclaims the root disk. Irreversible — stop the
+ * Computer instead if you want the files back later.
+ */
+export const computerDelete = (options) => (options.client ?? client).delete({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/computers/{id}',
+    ...options
+});
+/**
+ * Get one Computer.
+ */
+export const computerGet = (options) => (options.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/computers/{id}',
+    ...options
+});
+/**
+ * Run a command inside a Computer.
+ */
+export const computerExec = (options) => (options.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/computers/{id}/exec',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+/**
+ * Read one file out of a Computer.
+ */
+export const computerReadFile = (options) => (options.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/computers/{id}/files',
+    ...options
+});
+/**
+ * Write files into a Computer.
+ */
+export const computerWriteFiles = (options) => (options.client ?? client).put({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/computers/{id}/files',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+/**
+ * Replace a Computer's authorised ssh keys.
+ *
+ * Sends the whole list every time, so removing a key is the same operation as
+ * adding one. On a RUNNING machine the change applies immediately — a
+ * revoked key stops working now, not at the next restart. On a stopped
+ * machine it is stored and delivered when it next boots.
+ */
+export const computerSetSshKeys = (options) => (options.client ?? client).put({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/computers/{id}/ssh-keys',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+/**
+ * Start a stopped Computer.
+ *
+ * Boots the same disk on the same host and reclaims the same address.
+ */
+export const computerStart = (options) => (options.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/computers/{id}/start',
+    ...options
+});
+/**
+ * Stop a Computer.
+ *
+ * Halts the machine. The root disk and the network address are kept, so a
+ * later start comes back to the same files at the same address. Runtime
+ * billing stops; disk billing continues at the parked rate.
+ */
+export const computerStop = (options) => (options.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/computers/{id}/stop',
+    ...options
+});
 /**
  * List cron schedules.
  *
@@ -1393,6 +1561,77 @@ export const triggerCronSchedule = (options) => (options.client ?? client).post(
     url: '/v1/cron/schedules/{id}/trigger',
     ...options
 });
+/**
+ * List databases.
+ *
+ * Lists the project's databases. `include_deleted=true` also returns
+ * soft-deleted databases still inside the recovery grace window.
+ */
+export const listDatabases = (options) => (options?.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/databases',
+    ...options
+});
+/**
+ * Create a database.
+ *
+ * Creates a ScalixNova database in the project on the requested PostgreSQL
+ * major version (16 default, 17, or 18). The version is fixed at creation;
+ * branches and point-in-time restores keep it.
+ */
+export const createDatabase = (options) => (options.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/databases',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+/**
+ * Get or create the project's default database.
+ *
+ * Idempotent: returns the project's default database connection info,
+ * creating the database (on the default PostgreSQL version) if none exists.
+ */
+export const provisionDatabase = (options) => (options?.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/databases/provision',
+    ...options
+});
+/**
+ * Delete a database.
+ *
+ * Soft-deletes the database: it is hidden from listings and restorable via
+ * `POST /v1/databases/{id}/restore` until the grace window ends, after which
+ * it is purged permanently.
+ */
+export const deleteDatabase = (options) => (options.client ?? client).delete({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/databases/{id}',
+    ...options
+});
+/**
+ * Get a database.
+ *
+ * Fetches one database by id, including its PostgreSQL version and isolation tier.
+ */
+export const getDatabase = (options) => (options.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/databases/{id}',
+    ...options
+});
+/**
+ * Restore a soft-deleted database.
+ *
+ * Undoes a delete within the recovery grace window; the database returns to
+ * `active` with its data, version, and tier intact.
+ */
+export const restoreDatabase = (options) => (options.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/databases/{id}/restore',
+    ...options
+});
 /**
  * List custom domains.
  *
@@ -1463,6 +1702,213 @@ export const verifyDomain = (options) => (options.client ?? client).post({
     url: '/v1/domains/{id}/verify',
     ...options
 });
+/**
+ * Get campaign analytics.
+ *
+ * Returns engagement metrics for a single template. Requires the `email:read`
+ * scope.
+ */
+export const getEmailCampaignAnalytics = (options) => (options.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/analytics/campaign/{template_name}',
+    ...options
+});
+/**
+ * Get analytics summary.
+ *
+ * Returns aggregate open, click, bounce, and complaint rates for the org.
+ * Requires the `email:read` scope.
+ */
+export const getEmailAnalyticsSummary = (options) => (options?.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/analytics/summary',
+    ...options
+});
+/**
+ * List sending domains.
+ *
+ * Returns the org's bring-your-own sending domains and their verification
+ * state. Requires the `email:read` scope.
+ */
+export const listEmailDomains = (options) => (options?.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/domains',
+    ...options
+});
+/**
+ * Add a sending domain.
+ *
+ * Registers a domain and returns the DNS records required to verify it.
+ * Requires the `email:send` scope.
+ */
+export const addEmailDomain = (options) => (options.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/domains',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+/**
+ * Delete a sending domain.
+ *
+ * Removes a sending domain from the org. Requires the `email:send` scope.
+ */
+export const deleteEmailDomain = (options) => (options.client ?? client).delete({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/domains/{id}',
+    ...options
+});
+/**
+ * Verify a sending domain.
+ *
+ * Re-checks the domain's DNS records and updates its verification state.
+ * Verifying a domain proves ownership; it does not by itself enable delivery.
+ * Requires the `email:send` scope.
+ */
+export const verifyEmailDomain = (options) => (options.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/domains/{id}/verify',
+    ...options
+});
+/**
+ * List delivery events.
+ *
+ * Returns recent per-message delivery events (delivered, bounced, opened,
+ * clicked). Requires the `email:read` scope.
+ */
+export const listEmailEvents = (options) => (options?.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/events',
+    ...options
+});
+/**
+ * Send a raw email.
+ *
+ * Sends an HTML email without a stored template. Requires the `email:send`
+ * scope.
+ */
+export const sendRawEmail = (options) => (options.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/send/raw',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+/**
+ * Send a templated email.
+ *
+ * Renders `template` with `data` and sends it to `to`. Requires the
+ * `email:send` scope.
+ */
+export const sendTransactionalEmail = (options) => (options.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/send/tx',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+/**
+ * Get email settings.
+ *
+ * Returns the org's sender identity and delivery configuration, including
+ * whether bring-your-own delivery is enabled. Requires the `email:read` scope.
+ */
+export const getEmailSettings = (options) => (options?.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/settings',
+    ...options
+});
+/**
+ * Update email settings.
+ *
+ * Updates the org's sender identity and delivery configuration. Requires the
+ * `email:send` scope.
+ */
+export const updateEmailSettings = (options) => (options.client ?? client).put({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/settings',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+/**
+ * Get email stats.
+ *
+ * Returns send counts and delivery health for the org. Requires the
+ * `email:read` scope.
+ */
+export const getEmailStats = (options) => (options?.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/stats',
+    ...options
+});
+/**
+ * List suppressed addresses.
+ *
+ * Returns addresses excluded from sending after a hard bounce or complaint.
+ * Requires the `email:read` scope.
+ */
+export const listEmailSuppression = (options) => (options?.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/suppression',
+    ...options
+});
+/**
+ * List email templates.
+ *
+ * Returns the org's stored templates. Requires the `email:read` scope.
+ */
+export const listEmailTemplates = (options) => (options?.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/templates',
+    ...options
+});
+/**
+ * Create an email template.
+ *
+ * Stores a new template for the org. Requires the `email:write` scope.
+ */
+export const createEmailTemplate = (options) => (options.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/templates',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+/**
+ * Delete an email template.
+ *
+ * Removes a stored template. Requires the `email:write` scope.
+ */
+export const deleteEmailTemplate = (options) => (options.client ?? client).delete({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/templates/{id}',
+    ...options
+});
+/**
+ * Update an email template.
+ *
+ * Replaces a stored template. Requires the `email:write` scope.
+ */
+export const updateEmailTemplate = (options) => (options.client ?? client).put({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/email/templates/{id}',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
 /**
  * List environment variables.
  *
@@ -2175,6 +2621,102 @@ export const rollbackService = (options) => (options.client ?? client).post({
         ...options.headers
     }
 });
+/**
+ * List your sandboxes.
+ */
+export const sandboxList = (options) => (options?.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/sandboxes',
+    ...options
+});
+/**
+ * Create an ephemeral sandbox.
+ *
+ * Boots an isolated microVM. Ephemeral sandboxes are disposable: they stop
+ * at their idle or hard timeout and nothing on the rootfs persists past
+ * stop. Compute is billed per vCPU-hour and GB-hour of allocation while
+ * running.
+ */
+export const sandboxCreate = (options) => (options.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/sandboxes',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+/**
+ * Delete a sandbox and tear down its microVM.
+ */
+export const sandboxDelete = (options) => (options.client ?? client).delete({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/sandboxes/{id}',
+    ...options
+});
+/**
+ * Get a sandbox by id.
+ */
+export const sandboxGet = (options) => (options.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/sandboxes/{id}',
+    ...options
+});
+/**
+ * Run a command inside a running sandbox (synchronous).
+ */
+export const sandboxRunCommand = (options) => (options.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/sandboxes/{id}/commands',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+/**
+ * Extend a sandbox's hard deadline.
+ */
+export const sandboxExtend = (options) => (options.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/sandboxes/{id}/extend',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+/**
+ * Write files into a sandbox.
+ */
+export const sandboxWriteFiles = (options) => (options.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/sandboxes/{id}/files',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+/**
+ * Read a file from a sandbox. The guest path follows `/files/`.
+ */
+export const sandboxReadFile = (options) => (options.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/sandboxes/{id}/files/{path}',
+    ...options
+});
+/**
+ * Snapshot a sandbox - not available.
+ *
+ * Ephemeral sandboxes are disposable; state does not persist past stop.
+ * This endpoint returns 501 until snapshots ship (demand-gated).
+ */
+export const sandboxSnapshot = (options) => (options.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/v1/sandboxes/{id}/snapshot',
+    ...options
+});
 /**
  * Run a search.
  *
@@ -2360,8 +2902,12 @@ export const listShieldEvents = (options) => (options?.client ?? client).get({
 /**
  * Generate robots.txt.
  *
- * Returns a `robots.txt` file generated from the project's Shield crawler
- * policies.
+ * Returns a `robots.txt` generated from the project's Shield crawler policies.
+ *
+ * This is what Shield serves for apps that have NO robots.txt of their own.
+ * An app that ships one has it served verbatim with these crawler rules
+ * appended instead, so this is not necessarily the file a crawler receives.
+ * You do not need to copy this into your project.
  */
 export const getShieldRobotsTxt = (options) => (options?.client ?? client).get({
     security: [{ scheme: 'bearer', type: 'http' }],