@epilot/sdk 2.8.8 → 2.8.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/definitions/snapshot-runtime.json +1 -1
- package/definitions/snapshot.json +30 -14
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/snapshot.cjs +8 -8
- package/dist/apis/snapshot.d.cts +2 -2
- package/dist/apis/snapshot.d.ts +2 -2
- package/dist/apis/snapshot.js +2 -2
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/chunk-54QNWEPZ.js +14 -0
- package/dist/{chunk-IOMSECPW.js → chunk-H5BH4GQQ.js} +2 -2
- package/dist/{chunk-KMTYNC4V.cjs → chunk-OMZ2LWNR.cjs} +2 -2
- package/dist/chunk-YXJ4PBFQ.cjs +14 -0
- package/dist/index.cjs +10 -10
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +2 -2
- package/dist/snapshot-HFVQTHYF.cjs +7 -0
- package/dist/snapshot-Y6A7QUYS.js +7 -0
- package/dist/{snapshot-runtime-5TT575JS.cjs → snapshot-runtime-6DV42FVY.cjs} +2 -2
- package/dist/{snapshot-runtime-KWRGOKF4.js → snapshot-runtime-IW57MINC.js} +1 -1
- package/dist/{snapshot.d-C-n4wkIu.d.cts → snapshot.d-CPTXg4xN.d.cts} +34 -36
- package/dist/{snapshot.d-C-n4wkIu.d.ts → snapshot.d-CPTXg4xN.d.ts} +34 -36
- package/docs/snapshot.md +17 -17
- package/package.json +1 -1
- package/dist/chunk-4SZCKUY2.js +0 -14
- package/dist/chunk-ULKFBO7E.cjs +0 -14
- package/dist/snapshot-GDJOEFJQ.js +0 -7
- package/dist/snapshot-UKV54UQQ.cjs +0 -7
|
@@ -109,18 +109,19 @@ declare namespace Components {
|
|
|
109
109
|
started_at: string; // date-time
|
|
110
110
|
completed_at?: string; // date-time
|
|
111
111
|
/**
|
|
112
|
-
* `partial` indicates the operation completed but
|
|
113
|
-
*
|
|
114
|
-
*
|
|
112
|
+
* `partial` indicates the operation completed but snapshot-api
|
|
113
|
+
* skipped at least one captured resource via its own drift check
|
|
114
|
+
* (see `skipped`).
|
|
115
115
|
*
|
|
116
116
|
*/
|
|
117
117
|
status: "in_progress" | "completed" | "partial" | "failed";
|
|
118
118
|
error?: string;
|
|
119
119
|
triggered_by: CallerIdentity;
|
|
120
120
|
/**
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
*
|
|
121
|
+
* Captured resources snapshot-api elected to skip — currently
|
|
122
|
+
* only drift detections (`preserve_modified: true`). Caller-
|
|
123
|
+
* supplied `exclude_target_ids` skips are NOT echoed here; the
|
|
124
|
+
* caller built the list, the caller knows.
|
|
124
125
|
*
|
|
125
126
|
*/
|
|
126
127
|
skipped?: SkippedResource[];
|
|
@@ -133,45 +134,45 @@ declare namespace Components {
|
|
|
133
134
|
id: string;
|
|
134
135
|
}
|
|
135
136
|
/**
|
|
136
|
-
*
|
|
137
|
-
* Config Hub's manual-restore
|
|
138
|
-
*
|
|
139
|
-
* cross-blueprint contributions survive. Each flag is independent so a
|
|
140
|
-
* caller can preserve edits without preserving co-ownership (or vice
|
|
141
|
-
* versa). Skipped resources surface under `Operation.skipped`.
|
|
137
|
+
* Apply a captured snapshot to its source org. All filters default to the
|
|
138
|
+
* open setting (apply everything), which keeps Config Hub's manual-restore
|
|
139
|
+
* semantics unchanged.
|
|
142
140
|
*
|
|
143
141
|
*/
|
|
144
142
|
export interface RestoreSnapshotRequest {
|
|
145
143
|
/**
|
|
146
|
-
* When `true`, skip captured resources whose live
|
|
147
|
-
*
|
|
148
|
-
*
|
|
144
|
+
* When `true`, skip captured resources whose live payload's content
|
|
145
|
+
* fingerprint diverges from the capture-time fingerprint stored on
|
|
146
|
+
* the manifest entry. snapshot-api fetches the live payload and
|
|
147
|
+
* hashes it itself; no cross-service lookup. Surfaces under
|
|
148
|
+
* `Operation.skipped` with `reason: 'modified'`. Legacy snapshots
|
|
149
|
+
* captured before fingerprints were stored fail open (applied).
|
|
149
150
|
*
|
|
150
151
|
*/
|
|
151
152
|
preserve_modified?: boolean;
|
|
152
153
|
/**
|
|
153
|
-
*
|
|
154
|
-
*
|
|
155
|
-
* `Operation.skipped`
|
|
154
|
+
* Target ids the caller has decided not to restore. snapshot-api
|
|
155
|
+
* applies the manifest minus these ids. Drops are silent — not
|
|
156
|
+
* echoed in `Operation.skipped` — because the caller supplied the
|
|
157
|
+
* list and already knows.
|
|
156
158
|
*
|
|
157
159
|
*/
|
|
158
|
-
|
|
160
|
+
exclude_target_ids?: string[];
|
|
159
161
|
}
|
|
160
162
|
export interface RestoreSnapshotResponse {
|
|
161
163
|
id: string;
|
|
162
164
|
status: "restoring";
|
|
163
165
|
}
|
|
164
166
|
export interface SkippedResource {
|
|
165
|
-
|
|
167
|
+
target_id: string;
|
|
166
168
|
/**
|
|
167
|
-
* - `modified` —
|
|
168
|
-
* from the
|
|
169
|
-
*
|
|
170
|
-
* `
|
|
171
|
-
* another blueprint instance's contribution.
|
|
169
|
+
* - `modified` — live destination payload's content fingerprint
|
|
170
|
+
* differs from the capture-time fingerprint stored on the
|
|
171
|
+
* manifest entry. Only set when the restore was requested with
|
|
172
|
+
* `preserve_modified: true`.
|
|
172
173
|
*
|
|
173
174
|
*/
|
|
174
|
-
reason: "modified"
|
|
175
|
+
reason: "modified";
|
|
175
176
|
}
|
|
176
177
|
export interface Snapshot {
|
|
177
178
|
id: string;
|
|
@@ -280,10 +281,8 @@ declare namespace Components {
|
|
|
280
281
|
*/
|
|
281
282
|
export interface SnapshotResourceSummary {
|
|
282
283
|
/**
|
|
283
|
-
*
|
|
284
|
-
*
|
|
285
|
-
* snapshots. Same as `target_id` for snapshots whose capture
|
|
286
|
-
* doesn't distinguish source vs destination identifiers.
|
|
284
|
+
* Deprecated alias of `target_id`. Always equals `target_id` (the
|
|
285
|
+
* implementation never distinguished them). Use `target_id`.
|
|
287
286
|
*
|
|
288
287
|
*/
|
|
289
288
|
lineage_id: string;
|
|
@@ -376,11 +375,13 @@ declare namespace Paths {
|
|
|
376
375
|
export type Cursor = string;
|
|
377
376
|
export type Resource = string /* ^[^:]+:.+$ */[];
|
|
378
377
|
export type Size = number;
|
|
378
|
+
export type Trigger = "manual" | "sync" | "blueprint_install" | "scheduled";
|
|
379
379
|
}
|
|
380
380
|
export interface QueryParameters {
|
|
381
381
|
cursor?: Parameters.Cursor;
|
|
382
382
|
size?: Parameters.Size;
|
|
383
383
|
resource?: Parameters.Resource;
|
|
384
|
+
trigger?: Parameters.Trigger;
|
|
384
385
|
}
|
|
385
386
|
namespace Responses {
|
|
386
387
|
export interface $200 {
|
|
@@ -399,12 +400,9 @@ declare namespace Paths {
|
|
|
399
400
|
}
|
|
400
401
|
namespace RestoreSnapshot {
|
|
401
402
|
export type RequestBody = /**
|
|
402
|
-
*
|
|
403
|
-
* Config Hub's manual-restore
|
|
404
|
-
*
|
|
405
|
-
* cross-blueprint contributions survive. Each flag is independent so a
|
|
406
|
-
* caller can preserve edits without preserving co-ownership (or vice
|
|
407
|
-
* versa). Skipped resources surface under `Operation.skipped`.
|
|
403
|
+
* Apply a captured snapshot to its source org. All filters default to the
|
|
404
|
+
* open setting (apply everything), which keeps Config Hub's manual-restore
|
|
405
|
+
* semantics unchanged.
|
|
408
406
|
*
|
|
409
407
|
*/
|
|
410
408
|
Components.Schemas.RestoreSnapshotRequest;
|
package/docs/snapshot.md
CHANGED
|
@@ -91,6 +91,7 @@ const { data } = await client.listSnapshots({
|
|
|
91
91
|
cursor: 'example',
|
|
92
92
|
size: 1,
|
|
93
93
|
resource: ['...'],
|
|
94
|
+
trigger: 'example',
|
|
94
95
|
})
|
|
95
96
|
```
|
|
96
97
|
|
|
@@ -123,7 +124,7 @@ const { data } = await client.listSnapshots({
|
|
|
123
124
|
},
|
|
124
125
|
"skipped": [
|
|
125
126
|
{
|
|
126
|
-
"
|
|
127
|
+
"target_id": "string",
|
|
127
128
|
"reason": "modified"
|
|
128
129
|
}
|
|
129
130
|
]
|
|
@@ -142,7 +143,7 @@ const { data } = await client.listSnapshots({
|
|
|
142
143
|
},
|
|
143
144
|
"skipped": [
|
|
144
145
|
{
|
|
145
|
-
"
|
|
146
|
+
"target_id": "string",
|
|
146
147
|
"reason": "modified"
|
|
147
148
|
}
|
|
148
149
|
]
|
|
@@ -227,7 +228,7 @@ const { data } = await client.getSnapshot({
|
|
|
227
228
|
},
|
|
228
229
|
"skipped": [
|
|
229
230
|
{
|
|
230
|
-
"
|
|
231
|
+
"target_id": "string",
|
|
231
232
|
"reason": "modified"
|
|
232
233
|
}
|
|
233
234
|
]
|
|
@@ -246,7 +247,7 @@ const { data } = await client.getSnapshot({
|
|
|
246
247
|
},
|
|
247
248
|
"skipped": [
|
|
248
249
|
{
|
|
249
|
-
"
|
|
250
|
+
"target_id": "string",
|
|
250
251
|
"reason": "modified"
|
|
251
252
|
}
|
|
252
253
|
]
|
|
@@ -297,7 +298,7 @@ const { data } = await client.restoreSnapshot(
|
|
|
297
298
|
},
|
|
298
299
|
{
|
|
299
300
|
preserve_modified: false,
|
|
300
|
-
|
|
301
|
+
exclude_target_ids: ['string']
|
|
301
302
|
},
|
|
302
303
|
)
|
|
303
304
|
```
|
|
@@ -536,16 +537,15 @@ type CreateSnapshotResponse = {
|
|
|
536
537
|
|
|
537
538
|
### `RestoreSnapshotRequest`
|
|
538
539
|
|
|
539
|
-
|
|
540
|
-
Config Hub's manual-restore
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
caller can preserve edits w
|
|
540
|
+
Apply a captured snapshot to its source org. All filters default to the
|
|
541
|
+
open setting (apply everything), which keeps Config Hub's manual-restore
|
|
542
|
+
semantics unchanged.
|
|
543
|
+
|
|
544
544
|
|
|
545
545
|
```ts
|
|
546
546
|
type RestoreSnapshotRequest = {
|
|
547
547
|
preserve_modified?: boolean
|
|
548
|
-
|
|
548
|
+
exclude_target_ids?: string[]
|
|
549
549
|
}
|
|
550
550
|
```
|
|
551
551
|
|
|
@@ -581,7 +581,7 @@ type Snapshot = {
|
|
|
581
581
|
token_id?: { ... }
|
|
582
582
|
}
|
|
583
583
|
skipped?: Array<{
|
|
584
|
-
|
|
584
|
+
target_id: { ... }
|
|
585
585
|
reason: { ... }
|
|
586
586
|
}>
|
|
587
587
|
}
|
|
@@ -597,7 +597,7 @@ type Snapshot = {
|
|
|
597
597
|
token_id?: { ... }
|
|
598
598
|
}
|
|
599
599
|
skipped?: Array<{
|
|
600
|
-
|
|
600
|
+
target_id: { ... }
|
|
601
601
|
reason: { ... }
|
|
602
602
|
}>
|
|
603
603
|
}>
|
|
@@ -628,8 +628,8 @@ type Operation = {
|
|
|
628
628
|
token_id?: string
|
|
629
629
|
}
|
|
630
630
|
skipped?: Array<{
|
|
631
|
-
|
|
632
|
-
reason: "modified"
|
|
631
|
+
target_id: string
|
|
632
|
+
reason: "modified"
|
|
633
633
|
}>
|
|
634
634
|
}
|
|
635
635
|
```
|
|
@@ -638,8 +638,8 @@ type Operation = {
|
|
|
638
638
|
|
|
639
639
|
```ts
|
|
640
640
|
type SkippedResource = {
|
|
641
|
-
|
|
642
|
-
reason: "modified"
|
|
641
|
+
target_id: string
|
|
642
|
+
reason: "modified"
|
|
643
643
|
}
|
|
644
644
|
```
|
|
645
645
|
|
package/package.json
CHANGED
package/dist/chunk-4SZCKUY2.js
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
import {
|
|
2
|
-
__commonJS
|
|
3
|
-
} from "./chunk-YPSWSI3M.js";
|
|
4
|
-
|
|
5
|
-
// src/definitions/snapshot-runtime.json
|
|
6
|
-
var require_snapshot_runtime = __commonJS({
|
|
7
|
-
"src/definitions/snapshot-runtime.json"(exports, module) {
|
|
8
|
-
module.exports = { s: "https://snapshot.sls.epilot.io", o: [["createSnapshot", "post", "/v1/snapshots", null, 1], ["listSnapshots", "get", "/v1/snapshots", [["cursor", "q"], ["size", "q"], ["resource", "q"]]], ["captureOrgSnapshot", "post", "/v1/snapshots:capture-org", null, 1], ["getSnapshot", "get", "/v1/snapshots/{id}"], ["deleteSnapshot", "delete", "/v1/snapshots/{id}"], ["restoreSnapshot", "post", "/v1/snapshots/{id}:restore", null, 1], ["listSnapshotResources", "get", "/v1/snapshots/{id}/resources"], ["getSnapshotResource", "get", "/v1/snapshots/{id}/resources/{lineage_id}"], ["listDependencies", "post", "/v1/snapshots:list-dependencies", null, 1]], v: "3.0.3", pp: { "/v1/snapshots/{id}": [["id", "p", true]], "/v1/snapshots/{id}:restore": [["id", "p", true]], "/v1/snapshots/{id}/resources": [["id", "p", true]], "/v1/snapshots/{id}/resources/{lineage_id}": [["id", "p", true], ["lineage_id", "p", true]] } };
|
|
9
|
-
}
|
|
10
|
-
});
|
|
11
|
-
|
|
12
|
-
export {
|
|
13
|
-
require_snapshot_runtime
|
|
14
|
-
};
|
package/dist/chunk-ULKFBO7E.cjs
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports, "__esModule", {value: true});
|
|
2
|
-
|
|
3
|
-
var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
|
|
4
|
-
|
|
5
|
-
// src/definitions/snapshot-runtime.json
|
|
6
|
-
var require_snapshot_runtime = _chunkNJK5F5TFcjs.__commonJS.call(void 0, {
|
|
7
|
-
"src/definitions/snapshot-runtime.json"(exports, module) {
|
|
8
|
-
module.exports = { s: "https://snapshot.sls.epilot.io", o: [["createSnapshot", "post", "/v1/snapshots", null, 1], ["listSnapshots", "get", "/v1/snapshots", [["cursor", "q"], ["size", "q"], ["resource", "q"]]], ["captureOrgSnapshot", "post", "/v1/snapshots:capture-org", null, 1], ["getSnapshot", "get", "/v1/snapshots/{id}"], ["deleteSnapshot", "delete", "/v1/snapshots/{id}"], ["restoreSnapshot", "post", "/v1/snapshots/{id}:restore", null, 1], ["listSnapshotResources", "get", "/v1/snapshots/{id}/resources"], ["getSnapshotResource", "get", "/v1/snapshots/{id}/resources/{lineage_id}"], ["listDependencies", "post", "/v1/snapshots:list-dependencies", null, 1]], v: "3.0.3", pp: { "/v1/snapshots/{id}": [["id", "p", true]], "/v1/snapshots/{id}:restore": [["id", "p", true]], "/v1/snapshots/{id}/resources": [["id", "p", true]], "/v1/snapshots/{id}/resources/{lineage_id}": [["id", "p", true], ["lineage_id", "p", true]] } };
|
|
9
|
-
}
|
|
10
|
-
});
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
exports.require_snapshot_runtime = require_snapshot_runtime;
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import "./chunk-YPSWSI3M.js";
|
|
2
|
-
|
|
3
|
-
// src/docs/snapshot.json
|
|
4
|
-
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- [`SkippedResource`](#skippedresource)\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})\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 "skipped": [\n {\n "lineage_id": "string",\n "reason": "modified"\n }\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 "skipped": [\n {\n "lineage_id": "string",\n "reason": "modified"\n }\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 "skipped": [\n {\n "lineage_id": "string",\n "reason": "modified"\n }\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 "skipped": [\n {\n "lineage_id": "string",\n "reason": "modified"\n }\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 preserve_modified: false,\n preserve_co_owned: false\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\nBoth flags default to `false`, which restores every captured resource \u2014\nConfig Hub\'s manual-restore semantics. blueprint-manifest-api sets\nboth `true` when reverting a blueprint install so user edits and\ncross-blueprint contributions survive. Each flag is independent so a\ncaller can preserve edits w\n\n```ts\ntype RestoreSnapshotRequest = {\n preserve_modified?: boolean\n preserve_co_owned?: boolean\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 skipped?: Array<{\n lineage_id: { ... }\n reason: { ... }\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 skipped?: Array<{\n lineage_id: { ... }\n reason: { ... }\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 skipped?: Array<{\n lineage_id: string\n reason: "modified" | "co_owned"\n }>\n}\n```\n\n### `SkippedResource`\n\n```ts\ntype SkippedResource = {\n lineage_id: string\n reason: "modified" | "co_owned"\n}\n```\n\n### `CallerIdentity`\n\n```ts\ntype CallerIdentity = {\n name: string\n user_id?: string\n token_id?: string\n}\n```\n';
|
|
5
|
-
export {
|
|
6
|
-
snapshot_default as default
|
|
7
|
-
};
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
|
|
2
|
-
|
|
3
|
-
// src/docs/snapshot.json
|
|
4
|
-
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- [`SkippedResource`](#skippedresource)\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})\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 "skipped": [\n {\n "lineage_id": "string",\n "reason": "modified"\n }\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 "skipped": [\n {\n "lineage_id": "string",\n "reason": "modified"\n }\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 "skipped": [\n {\n "lineage_id": "string",\n "reason": "modified"\n }\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 "skipped": [\n {\n "lineage_id": "string",\n "reason": "modified"\n }\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 preserve_modified: false,\n preserve_co_owned: false\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\nBoth flags default to `false`, which restores every captured resource \u2014\nConfig Hub\'s manual-restore semantics. blueprint-manifest-api sets\nboth `true` when reverting a blueprint install so user edits and\ncross-blueprint contributions survive. Each flag is independent so a\ncaller can preserve edits w\n\n```ts\ntype RestoreSnapshotRequest = {\n preserve_modified?: boolean\n preserve_co_owned?: boolean\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 skipped?: Array<{\n lineage_id: { ... }\n reason: { ... }\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 skipped?: Array<{\n lineage_id: { ... }\n reason: { ... }\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 skipped?: Array<{\n lineage_id: string\n reason: "modified" | "co_owned"\n }>\n}\n```\n\n### `SkippedResource`\n\n```ts\ntype SkippedResource = {\n lineage_id: string\n reason: "modified" | "co_owned"\n}\n```\n\n### `CallerIdentity`\n\n```ts\ntype CallerIdentity = {\n name: string\n user_id?: string\n token_id?: string\n}\n```\n';
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
exports.default = snapshot_default;
|