@epilot/sdk 2.8.3 → 2.8.5

package/dist/{snapshot.d-DvoJ2n-v.d.ts → snapshot.d-C-n4wkIu.d.ts}

@@ -8,6 +8,13 @@ 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 {
@@ -15,15 +22,43 @@ declare namespace Components {
             user_id?: string;
             token_id?: string;
         }
+        /**
+         * Request body for `captureOrgSnapshot`. All fields optional — an empty body
+         * snapshots the whole org with a default name and the 90-day default TTL.
+         *
+         */
+        export interface CreateOrgSnapshotRequest {
+            /**
+             * Snapshot name. Defaults to "Org snapshot — <ISO timestamp>".
+             */
+            name?: string;
+            /**
+             * Retention window. Converted to an absolute `expires_at` at creation
+             * time. Omit for the default 90-day TTL.
+             *
+             */
+            retention?: {
+                value: number;
+                unit: "days" | "weeks" | "months";
+            };
+            /**
+             * Resource types to exclude from the capture, in addition to the
+             * always-excluded sensitive types (`access_token`,
+             * `environment_variable`).
+             *
+             */
+            excluded_types?: string[];
+        }
         export interface CreateSnapshotRequest {
             name: string;
             description?: string;
             /**
-             * What initiated this snapshot. `scheduled` may be added in a later
-             * phase for nightly backups (RFC OQ #3).
+             * What initiated this snapshot. `scheduled` is used for automatic
+             * nightly backups triggered by an org's EventBridge schedule
+             * (RFC — Scheduled org snapshots).
              *
              */
-            trigger?: "manual" | "sync" | "blueprint_install";
+            trigger?: "manual" | "sync" | "blueprint_install" | "scheduled";
             /**
              * Required iff `trigger === 'blueprint_install'`; forbidden otherwise.
              * Identifies the destination blueprint instance whose install this
@@ -48,6 +83,23 @@ 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;
@@ -56,9 +108,22 @@ declare namespace Components {
             type: "create" | "restore";
             started_at: string; // date-time
             completed_at?: string; // date-time
-            status: "in_progress" | "completed" | "failed";
+            /**
+             * `partial` indicates the operation completed but skipped at least
+             * one resource — see `skipped`. Only populated by restores triggered
+             * with `mode: 'preserve_edits'`.
+             *
+             */
+            status: "in_progress" | "completed" | "partial" | "failed";
             error?: string;
             triggered_by: CallerIdentity;
+            /**
+             * Per-resource skips, populated only for restores triggered with
+             * `mode: 'preserve_edits'`. Empty / absent for Config Hub's
+             * default overwrite-mode restores.
+             *
+             */
+            skipped?: SkippedResource[];
         }
         export interface ResourceRef {
             /**
@@ -67,16 +132,53 @@ declare namespace Components {
             type: string;
             id: string;
         }
+        /**
+         * Both flags default to `false`, which restores every captured resource —
+         * Config Hub's manual-restore semantics. blueprint-manifest-api sets
+         * both `true` when reverting a blueprint install so user edits and
+         * cross-blueprint contributions survive. Each flag is independent so a
+         * caller can preserve edits without preserving co-ownership (or vice
+         * versa). Skipped resources surface under `Operation.skipped`.
+         *
+         */
+        export interface RestoreSnapshotRequest {
+            /**
+             * When `true`, skip captured resources whose live destination payload
+             * has diverged from the install-time fingerprint stored on lineage.
+             * Surfaces under `Operation.skipped` with `reason: 'modified'`.
+             *
+             */
+            preserve_modified?: boolean;
+            /**
+             * When `true`, skip captured resources whose lineage row carries
+             * another blueprint instance's id (co-ownership ≥2). Surfaces under
+             * `Operation.skipped` with `reason: 'co_owned'`.
+             *
+             */
+            preserve_co_owned?: boolean;
+        }
         export interface RestoreSnapshotResponse {
             id: string;
             status: "restoring";
         }
+        export interface SkippedResource {
+            lineage_id: string;
+            /**
+             * - `modified` — current destination payload's fingerprint differs
+             *   from the install-time fingerprint on the lineage row.
+             * - `co_owned` — lineage row has ≥2 distinct
+             *   `blueprint_instance_ids`; restoring would unilaterally affect
+             *   another blueprint instance's contribution.
+             *
+             */
+            reason: "modified" | "co_owned";
+        }
         export interface Snapshot {
             id: string;
             org_id: string;
             name: string;
             description?: string;
-            trigger: "manual" | "sync" | "blueprint_install";
+            trigger: "manual" | "sync" | "blueprint_install" | "scheduled";
             /**
              * Set iff `trigger === 'blueprint_install'`. The destination blueprint
              * instance this snapshot covers.
@@ -100,6 +202,48 @@ declare namespace Components {
              *
              */
             matched_count?: number;
+            /**
+             * Capture scope. `selection` (default for manual/sync/blueprint_install)
+             * means only the explicitly listed resources were snapshotted.
+             * `org` means a full org inventory was discovered and captured
+             * (scheduled snapshots set this automatically).
+             *
+             */
+            scope?: "selection" | "org";
+            /**
+             * ISO-8601 timestamp after which this snapshot will be deleted.
+             * Derived from the org's retention setting at capture time for
+             * scheduled snapshots; not set for manual snapshots (which use
+             * a hardcoded 90-day TTL written directly as a DynamoDB `ttl` epoch).
+             *
+             */
+            expires_at?: string; // date-time
+            /**
+             * Per-snapshot coverage report set by the capture worker on completion.
+             * Records how many resources were attempted, captured, skipped
+             * (unsupported type or explicitly excluded), and failed.
+             *
+             */
+            capture_summary?: {
+                /**
+                 * Total resources in the inventory that were attempted.
+                 */
+                total: number;
+                /**
+                 * Resources successfully fetched and written to the manifest.
+                 */
+                captured: number;
+                /**
+                 * Resources skipped — type not supported by config-engine or
+                 * excluded from capture (e.g. access_token, environment_variable).
+                 *
+                 */
+                skipped: number;
+                /**
+                 * Resources where the fetch call returned an error.
+                 */
+                failed: number;
+            };
         }
         /**
          * A single captured resource with its full payload. The identity fields
@@ -159,6 +303,19 @@ declare namespace Components {
     }
 }
 declare namespace Paths {
+    namespace CaptureOrgSnapshot {
+        export type RequestBody = /**
+         * Request body for `captureOrgSnapshot`. All fields optional — an empty body
+         * snapshots the whole org with a default name and the 90-day default TTL.
+         *
+         */
+        Components.Schemas.CreateOrgSnapshotRequest;
+        namespace Responses {
+            export type $202 = Components.Schemas.CreateSnapshotResponse;
+            export type $401 = Components.Responses.Unauthorized;
+            export type $422 = Components.Responses.UnprocessableEntity;
+        }
+    }
     namespace CreateSnapshot {
         export type RequestBody = Components.Schemas.CreateSnapshotRequest;
         namespace Responses {
@@ -217,58 +374,7 @@ declare namespace Paths {
     namespace ListSnapshots {
         namespace Parameters {
             export type Cursor = string;
-            export type Resource = [
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?,
-                string?
-            ];
+            export type Resource = string /* ^[^:]+:.+$ */[];
             export type Size = number;
         }
         export interface QueryParameters {
@@ -292,6 +398,16 @@ declare namespace Paths {
         }
     }
     namespace RestoreSnapshot {
+        export type RequestBody = /**
+         * Both flags default to `false`, which restores every captured resource —
+         * Config Hub's manual-restore semantics. blueprint-manifest-api sets
+         * both `true` when reverting a blueprint install so user edits and
+         * cross-blueprint contributions survive. Each flag is independent so a
+         * caller can preserve edits without preserving co-ownership (or vice
+         * versa). Skipped resources surface under `Operation.skipped`.
+         *
+         */
+        Components.Schemas.RestoreSnapshotRequest;
         namespace Responses {
             export type $202 = Components.Schemas.RestoreSnapshotResponse;
             export type $401 = Components.Responses.Unauthorized;
@@ -366,6 +482,26 @@ interface OperationMethods {
     data?: Paths.CreateSnapshot.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.CreateSnapshot.Responses.$202>
+  /**
+   * 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`.
+   * 
+   * Sensitive types (`access_token`, `environment_variable`), types with no
+   * engine adapter, and any `excluded_types` are dropped from the capture and
+   * recorded in the snapshot's coverage report.
+   * 
+   */
+  'captureOrgSnapshot'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.CaptureOrgSnapshot.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.CaptureOrgSnapshot.Responses.$202>
   /**
    * getSnapshot - getSnapshot
    * 
@@ -391,7 +527,7 @@ interface OperationMethods {
    * 
    * Restore a snapshot to the org. Async — returns immediately; client polls
    * `getSnapshot` until the latest entry in `restores` moves from
-   * `in_progress` to `completed` or `failed`.
+   * `in_progress` to one of `completed | partial | failed`.
    * 
    * v1: full restore only. Cherry-pick (`resources?` body filter) is an open
    * question — see RFC OQ #1.
@@ -399,7 +535,7 @@ interface OperationMethods {
    */
   'restoreSnapshot'(
     parameters?: Parameters<Paths.V1Snapshots$IdRestore.PathParameters> | null,
-    data?: any,
+    data?: Paths.RestoreSnapshot.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.RestoreSnapshot.Responses.$202>
   /**
@@ -481,6 +617,28 @@ interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.ListSnapshots.Responses.$200>
   }
+  ['/v1/snapshots:capture-org']: {
+    /**
+     * 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`.
+     * 
+     * Sensitive types (`access_token`, `environment_variable`), types with no
+     * engine adapter, and any `excluded_types` are dropped from the capture and
+     * recorded in the snapshot's coverage report.
+     * 
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.CaptureOrgSnapshot.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.CaptureOrgSnapshot.Responses.$202>
+  }
   ['/v1/snapshots/{id}']: {
     /**
      * getSnapshot - getSnapshot
@@ -509,7 +667,7 @@ interface PathsDictionary {
      * 
      * Restore a snapshot to the org. Async — returns immediately; client polls
      * `getSnapshot` until the latest entry in `restores` moves from
-     * `in_progress` to `completed` or `failed`.
+     * `in_progress` to one of `completed | partial | failed`.
      * 
      * v1: full restore only. Cherry-pick (`resources?` body filter) is an open
      * question — see RFC OQ #1.
@@ -517,7 +675,7 @@ interface PathsDictionary {
      */
     'post'(
       parameters?: Parameters<Paths.V1Snapshots$IdRestore.PathParameters> | null,
-      data?: any,
+      data?: Paths.RestoreSnapshot.RequestBody,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.RestoreSnapshot.Responses.$202>
   }
@@ -577,15 +735,19 @@ type Client = OpenAPIClient<OperationMethods, PathsDictionary>
 
 
 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 ResourceRef = Components.Schemas.ResourceRef;
+type RestoreSnapshotRequest = Components.Schemas.RestoreSnapshotRequest;
 type RestoreSnapshotResponse = Components.Schemas.RestoreSnapshotResponse;
+type SkippedResource = Components.Schemas.SkippedResource;
 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 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 CreateSnapshotRequest as d, type CreateSnapshotResponse as e, type Operation as f, type RestoreSnapshotResponse as g, type SnapshotResourceDetail as h, type SnapshotResourceList as i, type SnapshotResourceSummary as j };
+export { type Client as C, type EmptyInventoryError as E, type OperationMethods as O, Paths as P, type ResourceRef as R, type SkippedResource 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 Snapshot as k, type SnapshotResourceDetail as l, type SnapshotResourceList as m, type SnapshotResourceSummary as n };