@epilot/sdk 2.11.4 → 2.11.5

package/dist/{snapshot.d-CqefmvuB.d.ts → snapshot.d-DT0zg2CS.d.ts}

@@ -8,13 +8,6 @@ declare namespace Components {
         export type BadRequest = Schemas.Error;
         export type NotFound = Schemas.Error;
         export type Unauthorized = Schemas.Error;
-        export type UnprocessableEntity = /**
-         * Returned (422) when the org inventory contains no capturable resources
-         * after filtering out sensitive, unsupported, and excluded types. The
-         * `skipped_types` array explains why every type was dropped.
-         *
-         */
-        Schemas.EmptyInventoryError;
     }
     namespace Schemas {
         export interface CallerIdentity {
@@ -83,23 +76,6 @@ declare namespace Components {
             status: "creating";
             created_at: string; // date-time
         }
-        /**
-         * Returned (422) when the org inventory contains no capturable resources
-         * after filtering out sensitive, unsupported, and excluded types. The
-         * `skipped_types` array explains why every type was dropped.
-         *
-         */
-        export interface EmptyInventoryError {
-            /**
-             * example:
-             * No capturable resources in the org inventory
-             */
-            message: string;
-            skipped_types: {
-                type: string;
-                reason: string;
-            }[];
-        }
         export interface Error {
             status: number;
             error: string;
@@ -118,6 +94,89 @@ declare namespace Components {
             error?: string;
             triggered_by: CallerIdentity;
         }
+        /**
+         * Enrollment record for a scheduled org snapshot. One row per org.
+         * This table — not EventBridge — is the source of truth; the EventBridge
+         * schedule entry is the materialization of this row (reconciled on write
+         * by Task 6).
+         *
+         */
+        export interface OrgSnapshotSchedule {
+            org_id: string;
+            enabled: boolean;
+            /**
+             * Validated 6-field EventBridge cron. Default `cron(0 2 * * ? *)`.
+             * example:
+             * cron(0 2 * * ? *)
+             */
+            cron_expression: string;
+            /**
+             * IANA timezone. Default `Europe/Berlin`.
+             */
+            timezone: string;
+            retention: /**
+             * Flat retention window for a scheduled snapshot.
+             * Converted to a `ttl` epoch at capture time. Capped at ~24 months.
+             *
+             */
+            RetentionConfig;
+            excluded_types?: string[];
+            /**
+             * Name of the EventBridge Scheduler entry this row owns.
+             * Set at enrollment time as `org-snapshot-{orgId}`.
+             *
+             */
+            schedule_name: string;
+            last_started_at?: string; // date-time
+            last_completed_at?: string; // date-time
+            last_status?: "completed" | "partial" | "failed";
+            created_by: string;
+            created_at: string; // date-time
+            updated_at: string; // date-time
+        }
+        /**
+         * Body for `putOrgSnapshotSchedule`. All fields optional; unset fields
+         * receive defaults on first create and are left unchanged on updates
+         * (except `updated_at`).
+         *
+         */
+        export interface PutOrgSnapshotScheduleRequest {
+            /**
+             * Whether the schedule is active.
+             */
+            enabled?: boolean;
+            /**
+             * 6-field EventBridge cron expression, e.g. `cron(0 2 * * ? *)`.
+             * Validated server-side: minute + hour must be concrete single integers
+             * (no `*`, lists, ranges, or steps) to cap cadence at ≤ once/day.
+             * Exactly one of day-of-month / day-of-week must be `?`.
+             *
+             * example:
+             * cron(0 2 * * ? *)
+             */
+            cron_expression?: string;
+            /**
+             * IANA timezone string passed to EventBridge `ScheduleExpressionTimezone`,
+             * e.g. `Europe/Berlin`. AWS handles DST natively.
+             *
+             * example:
+             * Europe/Berlin
+             */
+            timezone?: string;
+            retention?: /**
+             * Flat retention window for a scheduled snapshot.
+             * Converted to a `ttl` epoch at capture time. Capped at ~24 months.
+             *
+             */
+            RetentionConfig;
+            /**
+             * Resource types to exclude from the scheduled capture, in addition
+             * to the always-excluded sensitive types (`access_token`,
+             * `environment_variable`).
+             *
+             */
+            excluded_types?: string[];
+        }
         export interface ResourceRef {
             /**
              * Resource type (e.g., custom_variable, journey, automation_flow)
@@ -146,6 +205,18 @@ declare namespace Components {
             id: string;
             status: "restoring";
         }
+        /**
+         * Flat retention window for a scheduled snapshot.
+         * Converted to a `ttl` epoch at capture time. Capped at ~24 months.
+         *
+         */
+        export interface RetentionConfig {
+            /**
+             * Numeric quantity of retention (e.g. 90 for "90 days").
+             */
+            value: number;
+            unit: "days" | "weeks" | "months";
+        }
         export interface Snapshot {
             id: string;
             org_id: string;
@@ -284,7 +355,6 @@ declare namespace Paths {
         namespace Responses {
             export type $202 = Components.Schemas.CreateSnapshotResponse;
             export type $401 = Components.Responses.Unauthorized;
-            export type $422 = Components.Responses.UnprocessableEntity;
         }
     }
     namespace CreateSnapshot {
@@ -295,6 +365,14 @@ declare namespace Paths {
             export type $401 = Components.Responses.Unauthorized;
         }
     }
+    namespace DeleteOrgSnapshotSchedule {
+        namespace Responses {
+            export interface $204 {
+            }
+            export type $401 = Components.Responses.Unauthorized;
+            export type $404 = Components.Responses.NotFound;
+        }
+    }
     namespace DeleteSnapshot {
         namespace Responses {
             export interface $204 {
@@ -303,6 +381,20 @@ declare namespace Paths {
             export type $404 = Components.Responses.NotFound;
         }
     }
+    namespace GetOrgSnapshotSchedule {
+        namespace Responses {
+            export type $200 = /**
+             * Enrollment record for a scheduled org snapshot. One row per org.
+             * This table — not EventBridge — is the source of truth; the EventBridge
+             * schedule entry is the materialization of this row (reconciled on write
+             * by Task 6).
+             *
+             */
+            Components.Schemas.OrgSnapshotSchedule;
+            export type $401 = Components.Responses.Unauthorized;
+            export type $404 = Components.Responses.NotFound;
+        }
+    }
     namespace GetSnapshot {
         namespace Responses {
             export type $200 = Components.Schemas.Snapshot;
@@ -370,6 +462,27 @@ declare namespace Paths {
             export type $401 = Components.Responses.Unauthorized;
         }
     }
+    namespace PutOrgSnapshotSchedule {
+        export type RequestBody = /**
+         * Body for `putOrgSnapshotSchedule`. All fields optional; unset fields
+         * receive defaults on first create and are left unchanged on updates
+         * (except `updated_at`).
+         *
+         */
+        Components.Schemas.PutOrgSnapshotScheduleRequest;
+        namespace Responses {
+            export type $200 = /**
+             * Enrollment record for a scheduled org snapshot. One row per org.
+             * This table — not EventBridge — is the source of truth; the EventBridge
+             * schedule entry is the materialization of this row (reconciled on write
+             * by Task 6).
+             *
+             */
+            Components.Schemas.OrgSnapshotSchedule;
+            export type $400 = Components.Responses.BadRequest;
+            export type $401 = Components.Responses.Unauthorized;
+        }
+    }
     namespace RestoreSnapshot {
         export type RequestBody = /**
          * Apply a captured snapshot to its source org. snapshot-api applies the
@@ -457,12 +570,14 @@ interface OperationMethods {
   /**
    * captureOrgSnapshot - captureOrgSnapshot
    * 
-   * Snapshot the caller's whole organization now. Fetches a fresh inventory
-   * of the org's configuration resources from configuration-hub-api, persists
-   * it as an inventory artifact, and starts a `scope: "org"` chunked capture.
-   * Async — returns immediately with a snapshot ID; client polls `getSnapshot`
-   * and watches `capture_summary` fill in until `create.status` moves from
-   * `in_progress` to `completed` or `failed`.
+   * Snapshot the caller's whole organization now. Creates a `scope: "org"`
+   * snapshot row and starts a chunked capture Step Function, then returns
+   * immediately. The capture asynchronously fetches a fresh inventory of the
+   * org's configuration resources from configuration-hub-api, persists it as
+   * an inventory artifact, and captures each resource. Client polls
+   * `getSnapshot` and watches `capture_summary` fill in until `create.status`
+   * moves from `in_progress` to `completed` or `failed`. An org with no
+   * capturable resources finalizes as a completed 0-resource snapshot.
    * 
    * Sensitive types (`access_token`, `environment_variable`), types with no
    * engine adapter, and any `excluded_types` are dropped from the capture and
@@ -539,6 +654,55 @@ interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.GetSnapshotResource.Responses.$200>
+  /**
+   * getOrgSnapshotSchedule - getOrgSnapshotSchedule
+   * 
+   * Return the scheduled-snapshot enrollment config for the caller's org.
+   * Returns 404 when the org has not yet enrolled.
+   * 
+   */
+  'getOrgSnapshotSchedule'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetOrgSnapshotSchedule.Responses.$200>
+  /**
+   * putOrgSnapshotSchedule - putOrgSnapshotSchedule
+   * 
+   * Create or update the scheduled-snapshot enrollment config for the
+   * caller's org (upsert). The cron expression and retention window are
+   * validated server-side; invalid values are rejected with 400.
+   * 
+   * Defaults applied when a field is omitted on first create:
+   *   - `cron_expression`: `cron(0 2 * * ? *)` (daily at 02:00)
+   *   - `timezone`: `Europe/Berlin`
+   *   - `retention`: `{ value: 90, unit: "days" }`
+   *   - `enabled`: `true`
+   * 
+   * **Note:** this call persists the row only. EventBridge schedule
+   * materialization is performed by a subsequent reconcile step (Task 6).
+   * The row is the authoritative source of truth for the UI.
+   * 
+   */
+  'putOrgSnapshotSchedule'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.PutOrgSnapshotSchedule.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.PutOrgSnapshotSchedule.Responses.$200>
+  /**
+   * deleteOrgSnapshotSchedule - deleteOrgSnapshotSchedule
+   * 
+   * Remove the scheduled-snapshot enrollment for the caller's org.
+   * Returns 404 when no schedule exists.
+   * The corresponding EventBridge schedule is removed by a reconcile
+   * step (Task 6).
+   * 
+   */
+  'deleteOrgSnapshotSchedule'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.DeleteOrgSnapshotSchedule.Responses.$204>
   /**
    * listDependencies - listDependencies
    * 
@@ -593,12 +757,14 @@ interface PathsDictionary {
     /**
      * captureOrgSnapshot - captureOrgSnapshot
      * 
-     * Snapshot the caller's whole organization now. Fetches a fresh inventory
-     * of the org's configuration resources from configuration-hub-api, persists
-     * it as an inventory artifact, and starts a `scope: "org"` chunked capture.
-     * Async — returns immediately with a snapshot ID; client polls `getSnapshot`
-     * and watches `capture_summary` fill in until `create.status` moves from
-     * `in_progress` to `completed` or `failed`.
+     * Snapshot the caller's whole organization now. Creates a `scope: "org"`
+     * snapshot row and starts a chunked capture Step Function, then returns
+     * immediately. The capture asynchronously fetches a fresh inventory of the
+     * org's configuration resources from configuration-hub-api, persists it as
+     * an inventory artifact, and captures each resource. Client polls
+     * `getSnapshot` and watches `capture_summary` fill in until `create.status`
+     * moves from `in_progress` to `completed` or `failed`. An org with no
+     * capturable resources finalizes as a completed 0-resource snapshot.
      * 
      * Sensitive types (`access_token`, `environment_variable`), types with no
      * engine adapter, and any `excluded_types` are dropped from the capture and
@@ -684,6 +850,57 @@ interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.GetSnapshotResource.Responses.$200>
   }
+  ['/v1/org-snapshot-schedule']: {
+    /**
+     * getOrgSnapshotSchedule - getOrgSnapshotSchedule
+     * 
+     * Return the scheduled-snapshot enrollment config for the caller's org.
+     * Returns 404 when the org has not yet enrolled.
+     * 
+     */
+    'get'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetOrgSnapshotSchedule.Responses.$200>
+    /**
+     * putOrgSnapshotSchedule - putOrgSnapshotSchedule
+     * 
+     * Create or update the scheduled-snapshot enrollment config for the
+     * caller's org (upsert). The cron expression and retention window are
+     * validated server-side; invalid values are rejected with 400.
+     * 
+     * Defaults applied when a field is omitted on first create:
+     *   - `cron_expression`: `cron(0 2 * * ? *)` (daily at 02:00)
+     *   - `timezone`: `Europe/Berlin`
+     *   - `retention`: `{ value: 90, unit: "days" }`
+     *   - `enabled`: `true`
+     * 
+     * **Note:** this call persists the row only. EventBridge schedule
+     * materialization is performed by a subsequent reconcile step (Task 6).
+     * The row is the authoritative source of truth for the UI.
+     * 
+     */
+    'put'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.PutOrgSnapshotSchedule.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.PutOrgSnapshotSchedule.Responses.$200>
+    /**
+     * deleteOrgSnapshotSchedule - deleteOrgSnapshotSchedule
+     * 
+     * Remove the scheduled-snapshot enrollment for the caller's org.
+     * Returns 404 when no schedule exists.
+     * The corresponding EventBridge schedule is removed by a reconcile
+     * step (Task 6).
+     * 
+     */
+    'delete'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.DeleteOrgSnapshotSchedule.Responses.$204>
+  }
   ['/v1/snapshots:list-dependencies']: {
     /**
      * listDependencies - listDependencies
@@ -710,15 +927,17 @@ type CallerIdentity = Components.Schemas.CallerIdentity;
 type CreateOrgSnapshotRequest = Components.Schemas.CreateOrgSnapshotRequest;
 type CreateSnapshotRequest = Components.Schemas.CreateSnapshotRequest;
 type CreateSnapshotResponse = Components.Schemas.CreateSnapshotResponse;
-type EmptyInventoryError = Components.Schemas.EmptyInventoryError;
 type Error = Components.Schemas.Error;
 type Operation = Components.Schemas.Operation;
+type OrgSnapshotSchedule = Components.Schemas.OrgSnapshotSchedule;
+type PutOrgSnapshotScheduleRequest = Components.Schemas.PutOrgSnapshotScheduleRequest;
 type ResourceRef = Components.Schemas.ResourceRef;
 type RestoreSnapshotRequest = Components.Schemas.RestoreSnapshotRequest;
 type RestoreSnapshotResponse = Components.Schemas.RestoreSnapshotResponse;
+type RetentionConfig = Components.Schemas.RetentionConfig;
 type Snapshot = Components.Schemas.Snapshot;
 type SnapshotResourceDetail = Components.Schemas.SnapshotResourceDetail;
 type SnapshotResourceList = Components.Schemas.SnapshotResourceList;
 type SnapshotResourceSummary = Components.Schemas.SnapshotResourceSummary;
 
-export { type Client as C, type EmptyInventoryError as E, type OperationMethods as O, Paths as P, type ResourceRef as R, type Snapshot as S, Components as a, type PathsDictionary as b, type CallerIdentity as c, type CreateOrgSnapshotRequest as d, type CreateSnapshotRequest as e, type CreateSnapshotResponse as f, type Error as g, type Operation as h, type RestoreSnapshotRequest as i, type RestoreSnapshotResponse as j, type SnapshotResourceDetail as k, type SnapshotResourceList as l, type SnapshotResourceSummary as m };
+export { type Client as C, type Error as E, type OperationMethods as O, Paths as P, type ResourceRef as R, type Snapshot as S, Components as a, type PathsDictionary as b, type CallerIdentity as c, type CreateOrgSnapshotRequest as d, type CreateSnapshotRequest as e, type CreateSnapshotResponse as f, type Operation as g, type OrgSnapshotSchedule as h, type PutOrgSnapshotScheduleRequest as i, type RestoreSnapshotRequest as j, type RestoreSnapshotResponse as k, type RetentionConfig as l, type SnapshotResourceDetail as m, type SnapshotResourceList as n, type SnapshotResourceSummary as o };

package/docs/snapshot.md

@@ -35,9 +35,13 @@ const { data } = await snapshotClient.createSnapshot(...)
 - [`getSnapshotResource`](#getsnapshotresource)
 - [`listDependencies`](#listdependencies)
 
+**ScheduledSnapshots**
+- [`getOrgSnapshotSchedule`](#getorgsnapshotschedule)
+- [`putOrgSnapshotSchedule`](#putorgsnapshotschedule)
+- [`deleteOrgSnapshotSchedule`](#deleteorgsnapshotschedule)
+
 **Schemas**
 - [`Error`](#error)
-- [`EmptyInventoryError`](#emptyinventoryerror)
 - [`ResourceRef`](#resourceref)
 - [`SnapshotResourceSummary`](#snapshotresourcesummary)
 - [`SnapshotResourceList`](#snapshotresourcelist)
@@ -50,6 +54,9 @@ const { data } = await snapshotClient.createSnapshot(...)
 - [`Snapshot`](#snapshot)
 - [`Operation`](#operation)
 - [`CallerIdentity`](#calleridentity)
+- [`RetentionConfig`](#retentionconfig)
+- [`PutOrgSnapshotScheduleRequest`](#putorgsnapshotschedulerequest)
+- [`OrgSnapshotSchedule`](#orgsnapshotschedule)
 
 ### `createSnapshot`
 
@@ -156,9 +163,9 @@ const { data } = await client.listSnapshots({
 
 ### `captureOrgSnapshot`
 
-Snapshot the caller's whole organization now. Fetches a fresh inventory
-of the org's configuration resources from configuration-hub-api, persists
-it as an inventory artifact, and starts a `scope: "org
+Snapshot the caller's whole organization now. Creates a `scope: "org"`
+snapshot row and starts a chunked capture Step Function, then returns
+immediately. The capture asynchronously fetches a fresh inv
 
 `POST /v1/snapshots:capture-org`
 
@@ -344,6 +351,112 @@ const { data } = await client.getSnapshotResource({
 
 ---
 
+### `getOrgSnapshotSchedule`
+
+Return the scheduled-snapshot enrollment config for the caller's org.
+Returns 404 when the org has not yet enrolled.
+
+`GET /v1/org-snapshot-schedule`
+
+```ts
+const { data } = await client.getOrgSnapshotSchedule()
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "org_id": "string",
+  "enabled": true,
+  "cron_expression": "cron(0 2 * * ? *)",
+  "timezone": "string",
+  "retention": {
+    "value": 1,
+    "unit": "days"
+  },
+  "excluded_types": ["string"],
+  "schedule_name": "string",
+  "last_started_at": "1970-01-01T00:00:00.000Z",
+  "last_completed_at": "1970-01-01T00:00:00.000Z",
+  "last_status": "completed",
+  "created_by": "string",
+  "created_at": "1970-01-01T00:00:00.000Z",
+  "updated_at": "1970-01-01T00:00:00.000Z"
+}
+```
+
+</details>
+
+---
+
+### `putOrgSnapshotSchedule`
+
+Create or update the scheduled-snapshot enrollment config for the
+caller's org (upsert). The cron expression and retention window are
+validated server-side; invalid values are rejected with 400.
+
+`PUT /v1/org-snapshot-schedule`
+
+```ts
+const { data } = await client.putOrgSnapshotSchedule(
+  null,
+  {
+    enabled: true,
+    cron_expression: 'cron(0 2 * * ? *)',
+    timezone: 'Europe/Berlin',
+    retention: {
+      value: 1,
+      unit: 'days'
+    },
+    excluded_types: ['string']
+  },
+)
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "org_id": "string",
+  "enabled": true,
+  "cron_expression": "cron(0 2 * * ? *)",
+  "timezone": "string",
+  "retention": {
+    "value": 1,
+    "unit": "days"
+  },
+  "excluded_types": ["string"],
+  "schedule_name": "string",
+  "last_started_at": "1970-01-01T00:00:00.000Z",
+  "last_completed_at": "1970-01-01T00:00:00.000Z",
+  "last_status": "completed",
+  "created_by": "string",
+  "created_at": "1970-01-01T00:00:00.000Z",
+  "updated_at": "1970-01-01T00:00:00.000Z"
+}
+```
+
+</details>
+
+---
+
+### `deleteOrgSnapshotSchedule`
+
+Remove the scheduled-snapshot enrollment for the caller's org.
+Returns 404 when no schedule exists.
+The corresponding EventBridge schedule is removed by a reconcile
+step (Task 6).
+
+`DELETE /v1/org-snapshot-schedule`
+
+```ts
+const { data } = await client.deleteOrgSnapshotSchedule()
+```
+
+---
+
 ### `listDependencies`
 
 Walk the dependency tree for a set of resources and return the full
@@ -394,23 +507,6 @@ type Error = {
 }
 ```
 
-### `EmptyInventoryError`
-
-Returned (422) when the org inventory contains no capturable resources
-after filtering out sensitive, unsupported, and excluded types. The
-`skipped_types` array explains why every type was dropped.
-
-
-```ts
-type EmptyInventoryError = {
-  message: string
-  skipped_types: Array<{
-    type: string
-    reason: string
-  }>
-}
-```
-
 ### `ResourceRef`
 
 ```ts
@@ -605,3 +701,65 @@ type CallerIdentity = {
   token_id?: string
 }
 ```
+
+### `RetentionConfig`
+
+Flat retention window for a scheduled snapshot.
+Converted to a `ttl` epoch at capture time. Capped at ~24 months.
+
+
+```ts
+type RetentionConfig = {
+  value: number
+  unit: "days" | "weeks" | "months"
+}
+```
+
+### `PutOrgSnapshotScheduleRequest`
+
+Body for `putOrgSnapshotSchedule`. All fields optional; unset fields
+receive defaults on first create and are left unchanged on updates
+(except `updated_at`).
+
+
+```ts
+type PutOrgSnapshotScheduleRequest = {
+  enabled?: boolean
+  cron_expression?: string
+  timezone?: string
+  retention?: {
+    value: number
+    unit: "days" | "weeks" | "months"
+  }
+  excluded_types?: string[]
+}
+```
+
+### `OrgSnapshotSchedule`
+
+Enrollment record for a scheduled org snapshot. One row per org.
+This table — not EventBridge — is the source of truth; the EventBridge
+schedule entry is the materialization of this row (reconciled on write
+by Task 6).
+
+
+```ts
+type OrgSnapshotSchedule = {
+  org_id: string
+  enabled: boolean
+  cron_expression: string
+  timezone: string
+  retention: {
+    value: number
+    unit: "days" | "weeks" | "months"
+  }
+  excluded_types?: string[]
+  schedule_name: string
+  last_started_at?: string // date-time
+  last_completed_at?: string // date-time
+  last_status?: "completed" | "partial" | "failed"
+  created_by: string
+  created_at: string // date-time
+  updated_at: string // date-time
+}
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/sdk",
-  "version": "2.11.4",
+  "version": "2.11.5",
   "description": "JavaScript/TypeScript SDK for epilot APIs",
   "type": "module",
   "main": "./dist/index.cjs",

package/dist/snapshot-2HFERXRQ.js

@@ -1,7 +0,0 @@
-import "./chunk-YPSWSI3M.js";
-
-// src/docs/snapshot.json
-var snapshot_default = '# Snapshot API\n\n- **Base URL:** `https://snapshot.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/snapshot](https://docs.epilot.io/api/snapshot)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.snapshot.createSnapshot(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/snapshot\'\n\nconst snapshotClient = getClient()\nauthorize(snapshotClient, () => \'<token>\')\nconst { data } = await snapshotClient.createSnapshot(...)\n```\n\n## Operations\n\n**Snapshots**\n- [`createSnapshot`](#createsnapshot)\n- [`listSnapshots`](#listsnapshots)\n- [`captureOrgSnapshot`](#captureorgsnapshot)\n- [`getSnapshot`](#getsnapshot)\n- [`deleteSnapshot`](#deletesnapshot)\n- [`restoreSnapshot`](#restoresnapshot)\n- [`listSnapshotResources`](#listsnapshotresources)\n- [`getSnapshotResource`](#getsnapshotresource)\n- [`listDependencies`](#listdependencies)\n\n**Schemas**\n- [`Error`](#error)\n- [`EmptyInventoryError`](#emptyinventoryerror)\n- [`ResourceRef`](#resourceref)\n- [`SnapshotResourceSummary`](#snapshotresourcesummary)\n- [`SnapshotResourceList`](#snapshotresourcelist)\n- [`SnapshotResourceDetail`](#snapshotresourcedetail)\n- [`CreateSnapshotRequest`](#createsnapshotrequest)\n- [`CreateOrgSnapshotRequest`](#createorgsnapshotrequest)\n- [`CreateSnapshotResponse`](#createsnapshotresponse)\n- [`RestoreSnapshotRequest`](#restoresnapshotrequest)\n- [`RestoreSnapshotResponse`](#restoresnapshotresponse)\n- [`Snapshot`](#snapshot)\n- [`Operation`](#operation)\n- [`CallerIdentity`](#calleridentity)\n\n### `createSnapshot`\n\nCreate a new snapshot of the given resources. Async \u2014 returns immediately\nwith a snapshot ID; client polls `getSnapshot` until `create.status`\nmoves from `in_progress` to `completed` or `failed`.\n\n`POST /v1/snapshots`\n\n```ts\nconst { data } = await client.createSnapshot(\n  null,\n  {\n    name: \'string\',\n    description: \'string\',\n    trigger: \'manual\',\n    blueprint_instance_id: \'string\',\n    resources: [\n      {\n        type: \'string\',\n        id: \'string\'\n      }\n    ]\n  },\n)\n```\n\n---\n\n### `listSnapshots`\n\nList snapshots for the caller\'s organization, newest first.\n\n`GET /v1/snapshots`\n\n```ts\nconst { data } = await client.listSnapshots({\n  cursor: \'example\',\n  size: 1,\n  resource: [\'...\'],\n  trigger: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "page_size": 0,\n  "cursor": "string",\n  "results": [\n    {\n      "id": "string",\n      "org_id": "string",\n      "name": "string",\n      "description": "string",\n      "trigger": "manual",\n      "blueprint_instance_id": "string",\n      "resource_counts": {},\n      "create": {\n        "type": "create",\n        "started_at": "1970-01-01T00:00:00.000Z",\n        "completed_at": "1970-01-01T00:00:00.000Z",\n        "status": "in_progress",\n        "error": "string",\n        "triggered_by": {\n          "name": "string",\n          "user_id": "string",\n          "token_id": "string"\n        }\n      },\n      "restores": [\n        {\n          "type": "create",\n          "started_at": "1970-01-01T00:00:00.000Z",\n          "completed_at": "1970-01-01T00:00:00.000Z",\n          "status": "in_progress",\n          "error": "string",\n          "triggered_by": {\n            "name": "string",\n            "user_id": "string",\n            "token_id": "string"\n          }\n        }\n      ],\n      "matched_count": 0,\n      "scope": "selection",\n      "expires_at": "1970-01-01T00:00:00.000Z",\n      "capture_summary": {\n        "total": 0,\n        "captured": 0,\n        "skipped": 0,\n        "failed": 0\n      }\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `captureOrgSnapshot`\n\nSnapshot the caller\'s whole organization now. Fetches a fresh inventory\nof the org\'s configuration resources from configuration-hub-api, persists\nit as an inventory artifact, and starts a `scope: "org\n\n`POST /v1/snapshots:capture-org`\n\n```ts\nconst { data } = await client.captureOrgSnapshot(\n  null,\n  {\n    name: \'string\',\n    retention: {\n      value: 1,\n      unit: \'days\'\n    },\n    excluded_types: [\'string\']\n  },\n)\n```\n\n---\n\n### `getSnapshot`\n\nFetch a snapshot\'s metadata. Poll this endpoint to track create/restore progress.\n\n`GET /v1/snapshots/{id}`\n\n```ts\nconst { data } = await client.getSnapshot({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "string",\n  "org_id": "string",\n  "name": "string",\n  "description": "string",\n  "trigger": "manual",\n  "blueprint_instance_id": "string",\n  "resource_counts": {},\n  "create": {\n    "type": "create",\n    "started_at": "1970-01-01T00:00:00.000Z",\n    "completed_at": "1970-01-01T00:00:00.000Z",\n    "status": "in_progress",\n    "error": "string",\n    "triggered_by": {\n      "name": "string",\n      "user_id": "string",\n      "token_id": "string"\n    }\n  },\n  "restores": [\n    {\n      "type": "create",\n      "started_at": "1970-01-01T00:00:00.000Z",\n      "completed_at": "1970-01-01T00:00:00.000Z",\n      "status": "in_progress",\n      "error": "string",\n      "triggered_by": {\n        "name": "string",\n        "user_id": "string",\n        "token_id": "string"\n      }\n    }\n  ],\n  "matched_count": 0,\n  "scope": "selection",\n  "expires_at": "1970-01-01T00:00:00.000Z",\n  "capture_summary": {\n    "total": 0,\n    "captured": 0,\n    "skipped": 0,\n    "failed": 0\n  }\n}\n```\n\n</details>\n\n---\n\n### `deleteSnapshot`\n\nDelete a snapshot\'s metadata and S3 manifest.\n\n`DELETE /v1/snapshots/{id}`\n\n```ts\nconst { data } = await client.deleteSnapshot({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `restoreSnapshot`\n\nRestore a snapshot to the org. Async \u2014 returns immediately; client polls\n`getSnapshot` until the latest entry in `restores` moves from\n`in_progress` to one of `completed | partial | failed`.\n\n`POST /v1/snapshots/{id}:restore`\n\n```ts\nconst { data } = await client.restoreSnapshot(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    exclude_target_ids: [\'string\']\n  },\n)\n```\n\n---\n\n### `listSnapshotResources`\n\nList the resources captured in this snapshot. Returns lightweight\nidentity fields per resource \u2014 payloads are fetched via the\nsingle-resource endpoint when needed.\n\n`GET /v1/snapshots/{id}/resources`\n\n```ts\nconst { data } = await client.listSnapshotResources({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "resources": [\n    {\n      "lineage_id": "string",\n      "target_id": "string",\n      "type": "string",\n      "name": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getSnapshotResource`\n\nFetch one captured resource with its full payload. For UI views\nthat diff the captured state against the current destination.\n\n`GET /v1/snapshots/{id}/resources/{lineage_id}`\n\n```ts\nconst { data } = await client.getSnapshotResource({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n  lineage_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "lineage_id": "string",\n  "target_id": "string",\n  "type": "string",\n  "name": "string",\n  "captured": {}\n}\n```\n\n</details>\n\n---\n\n### `listDependencies`\n\nWalk the dependency tree for a set of resources and return the full\ntransitive closure, topologically sorted.\n\n`POST /v1/snapshots:list-dependencies`\n\n```ts\nconst { data } = await client.listDependencies(\n  null,\n  {\n    resources: [\n      {\n        type: \'string\',\n        id: \'string\'\n      }\n    ]\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "dependencies": [\n    {\n      "type": "string",\n      "id": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `Error`\n\n```ts\ntype Error = {\n  status: number\n  error: string\n}\n```\n\n### `EmptyInventoryError`\n\nReturned (422) when the org inventory contains no capturable resources\nafter filtering out sensitive, unsupported, and excluded types. The\n`skipped_types` array explains why every type was dropped.\n\n\n```ts\ntype EmptyInventoryError = {\n  message: string\n  skipped_types: Array<{\n    type: string\n    reason: string\n  }>\n}\n```\n\n### `ResourceRef`\n\n```ts\ntype ResourceRef = {\n  type: string\n  id: string\n}\n```\n\n### `SnapshotResourceSummary`\n\nLightweight identity for a captured resource. Returned by\n`listSnapshotResources`; the full payload is fetched separately via\n`getSnapshotResource` when needed.\n\n\n```ts\ntype SnapshotResourceSummary = {\n  lineage_id: string\n  target_id: string\n  type: string\n  name?: string\n}\n```\n\n### `SnapshotResourceList`\n\n```ts\ntype SnapshotResourceList = {\n  resources: Array<{\n    lineage_id: string\n    target_id: string\n    type: string\n    name?: string\n  }>\n}\n```\n\n### `SnapshotResourceDetail`\n\nA single captured resource with its full payload. The identity fields\nmatch `SnapshotResourceSummary`; the `captured` payload is the\npre-install state at snapshot time.\n\n\n```ts\ntype SnapshotResourceDetail = {\n  lineage_id: string\n  target_id: string\n  type: string\n  name?: string\n  captured: Record<string, unknown>\n}\n```\n\n### `CreateSnapshotRequest`\n\n```ts\ntype CreateSnapshotRequest = {\n  name: string\n  description?: string\n  trigger?: "manual" | "sync" | "blueprint_install" | "scheduled"\n  blueprint_instance_id?: string\n  resources: Array<{\n    type: string\n    id: string\n  }>\n}\n```\n\n### `CreateOrgSnapshotRequest`\n\nRequest body for `captureOrgSnapshot`. All fields optional \u2014 an empty body\nsnapshots the whole org with a default name and the 90-day default TTL.\n\n\n```ts\ntype CreateOrgSnapshotRequest = {\n  name?: string\n  retention?: {\n    value: number\n    unit: "days" | "weeks" | "months"\n  }\n  excluded_types?: string[]\n}\n```\n\n### `CreateSnapshotResponse`\n\n```ts\ntype CreateSnapshotResponse = {\n  id: string\n  name: string\n  status: "creating"\n  created_at: string // date-time\n}\n```\n\n### `RestoreSnapshotRequest`\n\nApply a captured snapshot to its source org. snapshot-api applies the\nmanifest verbatim minus any target ids the caller pre-decided to skip.\nDrift detection (skip modified-since-install) is the caller\'s\nresponsibility \u2014 blueprint-manifest-api owns that logic for blueprint\nrestores; Config Hub\'s manu\n\n```ts\ntype RestoreSnapshotRequest = {\n  exclude_target_ids?: string[]\n}\n```\n\n### `RestoreSnapshotResponse`\n\n```ts\ntype RestoreSnapshotResponse = {\n  id: string\n  status: "restoring"\n}\n```\n\n### `Snapshot`\n\n```ts\ntype Snapshot = {\n  id: string\n  org_id: string\n  name: string\n  description?: string\n  trigger: "manual" | "sync" | "blueprint_install" | "scheduled"\n  blueprint_instance_id?: string\n  resource_counts: Record<string, number>\n  create: {\n    type: "create" | "restore"\n    started_at: string // date-time\n    completed_at?: string // date-time\n    status: "in_progress" | "completed" | "partial" | "failed"\n    error?: string\n    triggered_by: {\n      name: { ... }\n      user_id?: { ... }\n      token_id?: { ... }\n    }\n  }\n  restores: Array<{\n    type: "create" | "restore"\n    started_at: string // date-time\n    completed_at?: string // date-time\n    status: "in_progress" | "completed" | "partial" | "failed"\n    error?: string\n    triggered_by: {\n      name: { ... }\n      user_id?: { ... }\n      token_id?: { ... }\n    }\n  }>\n  matched_count?: number\n  scope?: "selection" | "org"\n  expires_at?: string // date-time\n  capture_summary?: {\n    total: number\n    captured: number\n    skipped: number\n    failed: number\n  }\n}\n```\n\n### `Operation`\n\n```ts\ntype Operation = {\n  type: "create" | "restore"\n  started_at: string // date-time\n  completed_at?: string // date-time\n  status: "in_progress" | "completed" | "partial" | "failed"\n  error?: string\n  triggered_by: {\n    name: string\n    user_id?: string\n    token_id?: string\n  }\n}\n```\n\n### `CallerIdentity`\n\n```ts\ntype CallerIdentity = {\n  name: string\n  user_id?: string\n  token_id?: string\n}\n```\n';
-export {
-  snapshot_default as default
-};