@epilot/sdk 2.9.0 → 2.9.1

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.
Files changed (215) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +1 -0
  3. package/definitions/access-token-runtime.json +1 -1
  4. package/definitions/access-token.json +155 -1
  5. package/definitions/automation.json +120 -0
  6. package/definitions/blueprint-manifest-runtime.json +1 -1
  7. package/definitions/blueprint-manifest.json +571 -1
  8. package/definitions/journey.json +19 -2
  9. package/definitions/snapshot-runtime.json +1 -0
  10. package/definitions/snapshot.json +935 -0
  11. package/definitions/targeting.json +5 -4
  12. package/definitions/user-runtime.json +1 -1
  13. package/definitions/user.json +441 -0
  14. package/dist/README-NBWAQWQS.js +7 -0
  15. package/dist/README-XCIDDEAE.cjs +7 -0
  16. package/dist/{_index-DB2VV4PQ.cjs → _index-D5TTZP5F.cjs} +4 -1
  17. package/dist/{_index-5FB6F5YY.js → _index-UY46ZN47.js} +3 -0
  18. package/dist/access-token-GD6REL4U.js +7 -0
  19. package/dist/access-token-NQ5BLMOW.cjs +7 -0
  20. package/dist/{access-token-runtime-KCKGT4O7.js → access-token-runtime-2PSLN2U3.js} +1 -1
  21. package/dist/{access-token-runtime-NZWZJPWV.cjs → access-token-runtime-B6Z7JLUS.cjs} +2 -2
  22. package/dist/{access-token.d-CnmUTOlq.d.cts → access-token.d-CegaQmrK.d.cts} +165 -5
  23. package/dist/{access-token.d-CnmUTOlq.d.ts → access-token.d-CegaQmrK.d.ts} +165 -5
  24. package/dist/{ai-agents.d-OkXfr2bz.d.cts → ai-agents.d-CC5IjXrs.d.cts} +0 -2
  25. package/dist/{ai-agents.d-OkXfr2bz.d.ts → ai-agents.d-CC5IjXrs.d.ts} +0 -2
  26. package/dist/apis/access-token.cjs +8 -8
  27. package/dist/apis/access-token.d.cts +2 -2
  28. package/dist/apis/access-token.d.ts +2 -2
  29. package/dist/apis/access-token.js +2 -2
  30. package/dist/apis/address-suggestions.cjs +6 -6
  31. package/dist/apis/address-suggestions.js +1 -1
  32. package/dist/apis/address.cjs +6 -6
  33. package/dist/apis/address.js +1 -1
  34. package/dist/apis/ai-agents.cjs +6 -6
  35. package/dist/apis/ai-agents.d.cts +2 -2
  36. package/dist/apis/ai-agents.d.ts +2 -2
  37. package/dist/apis/ai-agents.js +1 -1
  38. package/dist/apis/app.cjs +6 -6
  39. package/dist/apis/app.js +1 -1
  40. package/dist/apis/audit-logs.cjs +6 -6
  41. package/dist/apis/audit-logs.js +1 -1
  42. package/dist/apis/automation.cjs +6 -6
  43. package/dist/apis/automation.d.cts +2 -2
  44. package/dist/apis/automation.d.ts +2 -2
  45. package/dist/apis/automation.js +1 -1
  46. package/dist/apis/billing.cjs +6 -6
  47. package/dist/apis/billing.js +1 -1
  48. package/dist/apis/blueprint-manifest.cjs +8 -8
  49. package/dist/apis/blueprint-manifest.d.cts +2 -2
  50. package/dist/apis/blueprint-manifest.d.ts +2 -2
  51. package/dist/apis/blueprint-manifest.js +2 -2
  52. package/dist/apis/calendar.cjs +6 -6
  53. package/dist/apis/calendar.js +1 -1
  54. package/dist/apis/configuration-hub.cjs +6 -6
  55. package/dist/apis/configuration-hub.js +1 -1
  56. package/dist/apis/consent.cjs +6 -6
  57. package/dist/apis/consent.js +1 -1
  58. package/dist/apis/customer-portal.cjs +6 -6
  59. package/dist/apis/customer-portal.js +1 -1
  60. package/dist/apis/dashboard.cjs +6 -6
  61. package/dist/apis/dashboard.js +1 -1
  62. package/dist/apis/data-governance.cjs +6 -6
  63. package/dist/apis/data-governance.js +1 -1
  64. package/dist/apis/deduplication.cjs +6 -6
  65. package/dist/apis/deduplication.js +1 -1
  66. package/dist/apis/design.cjs +6 -6
  67. package/dist/apis/design.js +1 -1
  68. package/dist/apis/document.cjs +6 -6
  69. package/dist/apis/document.js +1 -1
  70. package/dist/apis/email-settings.cjs +6 -6
  71. package/dist/apis/email-settings.js +1 -1
  72. package/dist/apis/email-template.cjs +6 -6
  73. package/dist/apis/email-template.js +1 -1
  74. package/dist/apis/entity-mapping.cjs +6 -6
  75. package/dist/apis/entity-mapping.js +1 -1
  76. package/dist/apis/entity.cjs +6 -6
  77. package/dist/apis/entity.js +1 -1
  78. package/dist/apis/environments.cjs +6 -6
  79. package/dist/apis/environments.js +1 -1
  80. package/dist/apis/event-catalog.cjs +6 -6
  81. package/dist/apis/event-catalog.js +1 -1
  82. package/dist/apis/file.cjs +6 -6
  83. package/dist/apis/file.js +1 -1
  84. package/dist/apis/iban.cjs +6 -6
  85. package/dist/apis/iban.js +1 -1
  86. package/dist/apis/integration-toolkit.cjs +6 -6
  87. package/dist/apis/integration-toolkit.js +1 -1
  88. package/dist/apis/journey.cjs +6 -6
  89. package/dist/apis/journey.d.cts +2 -2
  90. package/dist/apis/journey.d.ts +2 -2
  91. package/dist/apis/journey.js +1 -1
  92. package/dist/apis/kanban.cjs +6 -6
  93. package/dist/apis/kanban.js +1 -1
  94. package/dist/apis/message.cjs +6 -6
  95. package/dist/apis/message.js +1 -1
  96. package/dist/apis/metering.cjs +6 -6
  97. package/dist/apis/metering.js +1 -1
  98. package/dist/apis/notes.cjs +6 -6
  99. package/dist/apis/notes.js +1 -1
  100. package/dist/apis/notification.cjs +6 -6
  101. package/dist/apis/notification.js +1 -1
  102. package/dist/apis/organization.cjs +6 -6
  103. package/dist/apis/organization.js +1 -1
  104. package/dist/apis/partner-directory.cjs +6 -6
  105. package/dist/apis/partner-directory.js +1 -1
  106. package/dist/apis/permissions.cjs +6 -6
  107. package/dist/apis/permissions.js +1 -1
  108. package/dist/apis/pricing-tier.cjs +6 -6
  109. package/dist/apis/pricing-tier.js +1 -1
  110. package/dist/apis/pricing.cjs +6 -6
  111. package/dist/apis/pricing.js +1 -1
  112. package/dist/apis/purpose.cjs +6 -6
  113. package/dist/apis/purpose.js +1 -1
  114. package/dist/apis/query.cjs +6 -6
  115. package/dist/apis/query.js +1 -1
  116. package/dist/apis/sandbox.cjs +6 -6
  117. package/dist/apis/sandbox.js +1 -1
  118. package/dist/apis/sharing.cjs +6 -6
  119. package/dist/apis/sharing.js +1 -1
  120. package/dist/apis/snapshot.cjs +38 -0
  121. package/dist/apis/snapshot.d.cts +18 -0
  122. package/dist/apis/snapshot.d.ts +18 -0
  123. package/dist/apis/snapshot.js +38 -0
  124. package/dist/apis/submission.cjs +6 -6
  125. package/dist/apis/submission.js +1 -1
  126. package/dist/apis/target.cjs +6 -6
  127. package/dist/apis/target.js +1 -1
  128. package/dist/apis/targeting.cjs +6 -6
  129. package/dist/apis/targeting.d.cts +2 -2
  130. package/dist/apis/targeting.d.ts +2 -2
  131. package/dist/apis/targeting.js +1 -1
  132. package/dist/apis/template-variables.cjs +6 -6
  133. package/dist/apis/template-variables.js +1 -1
  134. package/dist/apis/user.cjs +8 -8
  135. package/dist/apis/user.d.cts +2 -2
  136. package/dist/apis/user.d.ts +2 -2
  137. package/dist/apis/user.js +2 -2
  138. package/dist/apis/validation-rules.cjs +6 -6
  139. package/dist/apis/validation-rules.js +1 -1
  140. package/dist/apis/webhooks.cjs +6 -6
  141. package/dist/apis/webhooks.js +1 -1
  142. package/dist/apis/workflow-definition.cjs +6 -6
  143. package/dist/apis/workflow-definition.js +1 -1
  144. package/dist/apis/workflow.cjs +6 -6
  145. package/dist/apis/workflow.js +1 -1
  146. package/dist/automation-S6NFS5KU.cjs +7 -0
  147. package/dist/automation-W75XZG7B.js +7 -0
  148. package/dist/{automation.d-Du6-uiz5.d.cts → automation.d-DS_YXDE8.d.cts} +300 -1
  149. package/dist/{automation.d-Du6-uiz5.d.ts → automation.d-DS_YXDE8.d.ts} +300 -1
  150. package/dist/blueprint-manifest-WHYSBU66.cjs +7 -0
  151. package/dist/blueprint-manifest-WZVBTKUL.js +7 -0
  152. package/dist/{blueprint-manifest-runtime-FRLU3ZSF.js → blueprint-manifest-runtime-2344IUIE.js} +1 -1
  153. package/dist/{blueprint-manifest-runtime-EIDOROIQ.cjs → blueprint-manifest-runtime-WU5MWPVT.cjs} +2 -2
  154. package/dist/{blueprint-manifest.d-B8yDxagC.d.cts → blueprint-manifest.d-2-TORV8o.d.cts} +926 -4
  155. package/dist/{blueprint-manifest.d-B8yDxagC.d.ts → blueprint-manifest.d-2-TORV8o.d.ts} +926 -4
  156. package/dist/chunk-54QNWEPZ.js +14 -0
  157. package/dist/{chunk-CULH5PIN.cjs → chunk-6V3NYADA.cjs} +13 -11
  158. package/dist/chunk-NFIYEMMM.js +14 -0
  159. package/dist/{chunk-XSE4CFSM.js → chunk-OHHHS4HH.js} +1 -1
  160. package/dist/chunk-OWXEZ56F.cjs +14 -0
  161. package/dist/{chunk-RZ4ABDOF.js → chunk-QGP5WMHK.js} +13 -11
  162. package/dist/{chunk-OXJOO2YF.cjs → chunk-S5HBBTKM.cjs} +1 -1
  163. package/dist/{chunk-NGHCQ2FA.cjs → chunk-T57MT6J5.cjs} +1 -1
  164. package/dist/{chunk-4YBWMDFP.js → chunk-UWGWRGGB.js} +1 -1
  165. package/dist/chunk-YXJ4PBFQ.cjs +14 -0
  166. package/dist/index.cjs +24 -16
  167. package/dist/index.d.cts +23 -21
  168. package/dist/index.d.ts +23 -21
  169. package/dist/index.js +14 -6
  170. package/dist/journey-LHVSSVTG.cjs +7 -0
  171. package/dist/journey-NXL264XW.js +7 -0
  172. package/dist/{journey.d-BenIUWaO.d.ts → journey.d-B1sOeMHw.d.cts} +16 -3
  173. package/dist/{journey.d-BenIUWaO.d.cts → journey.d-B1sOeMHw.d.ts} +16 -3
  174. package/dist/js-yaml-DLCVPJ7G.js +0 -0
  175. package/dist/snapshot-2HFERXRQ.js +7 -0
  176. package/dist/snapshot-UHCQAT4R.cjs +7 -0
  177. package/dist/snapshot-runtime-6DV42FVY.cjs +5 -0
  178. package/dist/snapshot-runtime-IW57MINC.js +5 -0
  179. package/dist/snapshot.d-CqefmvuB.d.cts +724 -0
  180. package/dist/snapshot.d-CqefmvuB.d.ts +724 -0
  181. package/dist/{targeting-DAFJBPIZ.cjs → targeting-WC62BBZN.cjs} +1 -1
  182. package/dist/{targeting-TGPCRRI6.js → targeting-X4Y2ODBT.js} +1 -1
  183. package/dist/{targeting.d-DxHQbn7-.d.cts → targeting.d-0rNF7ErD.d.cts} +11 -4
  184. package/dist/{targeting.d-DxHQbn7-.d.ts → targeting.d-0rNF7ErD.d.ts} +11 -4
  185. package/dist/user-3SLAEEVD.cjs +7 -0
  186. package/dist/user-PRUYBXQV.js +7 -0
  187. package/dist/{user-runtime-U4HYUWJU.js → user-runtime-6ICV2Y73.js} +1 -1
  188. package/dist/user-runtime-Y3227ETX.cjs +5 -0
  189. package/dist/{user.d-D18fe97W.d.cts → user.d-L-C7_K84.d.cts} +421 -1
  190. package/dist/{user.d-D18fe97W.d.ts → user.d-L-C7_K84.d.ts} +421 -1
  191. package/docs/access-token.md +111 -3
  192. package/docs/automation.md +180 -37
  193. package/docs/blueprint-manifest.md +421 -95
  194. package/docs/journey.md +28 -8
  195. package/docs/snapshot.md +607 -0
  196. package/docs/targeting.md +6 -3
  197. package/docs/user.md +321 -8
  198. package/package.json +20 -12
  199. package/definitions/focus-pocus-runtime.json +0 -1
  200. package/definitions/focus-pocus.json +0 -757
  201. package/dist/README-46VYEGGW.js +0 -7
  202. package/dist/README-IVBISSWB.cjs +0 -7
  203. package/dist/access-token-6BJDZSFE.cjs +0 -7
  204. package/dist/access-token-GSQZLDXR.js +0 -7
  205. package/dist/automation-BMO7ZFTN.cjs +0 -7
  206. package/dist/automation-MEZTSUR3.js +0 -7
  207. package/dist/blueprint-manifest-6DEYW5MW.js +0 -7
  208. package/dist/blueprint-manifest-GCV7H74X.cjs +0 -7
  209. package/dist/chunk-3XKBB5AE.js +0 -14
  210. package/dist/chunk-Z5TVWG3I.cjs +0 -14
  211. package/dist/journey-4DIIPRU4.js +0 -7
  212. package/dist/journey-ATC3Y5AW.cjs +0 -7
  213. package/dist/user-7ZN2XO7G.cjs +0 -7
  214. package/dist/user-ZK7BK6VY.js +0 -7
  215. package/dist/user-runtime-7O2HLFVQ.cjs +0 -5
@@ -0,0 +1,724 @@
1
+ import { OpenAPIClient, Parameters, AxiosRequestConfig, OperationResponse, UnknownParamsObject } from 'openapi-client-axios';
2
+
3
+ /* Auto-copied from snapshot-client */
4
+
5
+
6
+ declare namespace Components {
7
+ namespace Responses {
8
+ export type BadRequest = Schemas.Error;
9
+ export type NotFound = Schemas.Error;
10
+ export type Unauthorized = Schemas.Error;
11
+ export type UnprocessableEntity = /**
12
+ * Returned (422) when the org inventory contains no capturable resources
13
+ * after filtering out sensitive, unsupported, and excluded types. The
14
+ * `skipped_types` array explains why every type was dropped.
15
+ *
16
+ */
17
+ Schemas.EmptyInventoryError;
18
+ }
19
+ namespace Schemas {
20
+ export interface CallerIdentity {
21
+ name: string;
22
+ user_id?: string;
23
+ token_id?: string;
24
+ }
25
+ /**
26
+ * Request body for `captureOrgSnapshot`. All fields optional — an empty body
27
+ * snapshots the whole org with a default name and the 90-day default TTL.
28
+ *
29
+ */
30
+ export interface CreateOrgSnapshotRequest {
31
+ /**
32
+ * Snapshot name. Defaults to "Org snapshot — <ISO timestamp>".
33
+ */
34
+ name?: string;
35
+ /**
36
+ * Retention window. Converted to an absolute `expires_at` at creation
37
+ * time. Omit for the default 90-day TTL.
38
+ *
39
+ */
40
+ retention?: {
41
+ value: number;
42
+ unit: "days" | "weeks" | "months";
43
+ };
44
+ /**
45
+ * Resource types to exclude from the capture, in addition to the
46
+ * always-excluded sensitive types (`access_token`,
47
+ * `environment_variable`).
48
+ *
49
+ */
50
+ excluded_types?: string[];
51
+ }
52
+ export interface CreateSnapshotRequest {
53
+ name: string;
54
+ description?: string;
55
+ /**
56
+ * What initiated this snapshot. `scheduled` is used for automatic
57
+ * nightly backups triggered by an org's EventBridge schedule
58
+ * (RFC — Scheduled org snapshots).
59
+ *
60
+ */
61
+ trigger?: "manual" | "sync" | "blueprint_install" | "scheduled";
62
+ /**
63
+ * Required iff `trigger === 'blueprint_install'`; forbidden otherwise.
64
+ * Identifies the destination blueprint instance whose install this
65
+ * snapshot covers. Used at restore time as the join key for the
66
+ * lineage-driven delete sweep.
67
+ *
68
+ */
69
+ blueprint_instance_id?: string;
70
+ /**
71
+ * List of resources to capture. Required non-empty for
72
+ * `trigger === 'manual'` or `'sync'`. May be empty when
73
+ * `trigger === 'blueprint_install'` — an install with no
74
+ * resources to overwrite still needs a snapshot row so the
75
+ * blueprint-manifest-api restore endpoint can find it.
76
+ *
77
+ */
78
+ resources: ResourceRef[];
79
+ }
80
+ export interface CreateSnapshotResponse {
81
+ id: string;
82
+ name: string;
83
+ status: "creating";
84
+ created_at: string; // date-time
85
+ }
86
+ /**
87
+ * Returned (422) when the org inventory contains no capturable resources
88
+ * after filtering out sensitive, unsupported, and excluded types. The
89
+ * `skipped_types` array explains why every type was dropped.
90
+ *
91
+ */
92
+ export interface EmptyInventoryError {
93
+ /**
94
+ * example:
95
+ * No capturable resources in the org inventory
96
+ */
97
+ message: string;
98
+ skipped_types: {
99
+ type: string;
100
+ reason: string;
101
+ }[];
102
+ }
103
+ export interface Error {
104
+ status: number;
105
+ error: string;
106
+ }
107
+ export interface Operation {
108
+ type: "create" | "restore";
109
+ started_at: string; // date-time
110
+ completed_at?: string; // date-time
111
+ /**
112
+ * `partial` indicates `engine.apply` reported a partial success
113
+ * (one or more resources failed individually) but the operation
114
+ * as a whole did not fail.
115
+ *
116
+ */
117
+ status: "in_progress" | "completed" | "partial" | "failed";
118
+ error?: string;
119
+ triggered_by: CallerIdentity;
120
+ }
121
+ export interface ResourceRef {
122
+ /**
123
+ * Resource type (e.g., custom_variable, journey, automation_flow)
124
+ */
125
+ type: string;
126
+ id: string;
127
+ }
128
+ /**
129
+ * Apply a captured snapshot to its source org. snapshot-api applies the
130
+ * manifest verbatim minus any target ids the caller pre-decided to skip.
131
+ * Drift detection (skip modified-since-install) is the caller's
132
+ * responsibility — blueprint-manifest-api owns that logic for blueprint
133
+ * restores; Config Hub's manual restore just omits the field.
134
+ *
135
+ */
136
+ export interface RestoreSnapshotRequest {
137
+ /**
138
+ * Target ids the caller has decided not to restore. snapshot-api
139
+ * applies the manifest minus these ids. Drops are silent — the
140
+ * caller supplied the list and already knows.
141
+ *
142
+ */
143
+ exclude_target_ids?: string[];
144
+ }
145
+ export interface RestoreSnapshotResponse {
146
+ id: string;
147
+ status: "restoring";
148
+ }
149
+ export interface Snapshot {
150
+ id: string;
151
+ org_id: string;
152
+ name: string;
153
+ description?: string;
154
+ trigger: "manual" | "sync" | "blueprint_install" | "scheduled";
155
+ /**
156
+ * Set iff `trigger === 'blueprint_install'`. The destination blueprint
157
+ * instance this snapshot covers.
158
+ *
159
+ */
160
+ blueprint_instance_id?: string;
161
+ /**
162
+ * Resource type → count of resources of that type in the snapshot.
163
+ */
164
+ resource_counts: {
165
+ [name: string]: number;
166
+ };
167
+ create: Operation;
168
+ restores: Operation[];
169
+ /**
170
+ * Number of `resource` filter pairs from the request that are
171
+ * contained in this snapshot. Present only on `listSnapshots`
172
+ * responses where the caller passed at least one `resource`
173
+ * filter — absent on `getSnapshot` and on unfiltered list calls.
174
+ * Drives the coverage badge in Config Hub's snapshot picker.
175
+ *
176
+ */
177
+ matched_count?: number;
178
+ /**
179
+ * Capture scope. `selection` (default for manual/sync/blueprint_install)
180
+ * means only the explicitly listed resources were snapshotted.
181
+ * `org` means a full org inventory was discovered and captured
182
+ * (scheduled snapshots set this automatically).
183
+ *
184
+ */
185
+ scope?: "selection" | "org";
186
+ /**
187
+ * ISO-8601 timestamp after which this snapshot will be deleted.
188
+ * Derived from the org's retention setting at capture time for
189
+ * scheduled snapshots; not set for manual snapshots (which use
190
+ * a hardcoded 90-day TTL written directly as a DynamoDB `ttl` epoch).
191
+ *
192
+ */
193
+ expires_at?: string; // date-time
194
+ /**
195
+ * Per-snapshot coverage report set by the capture worker on completion.
196
+ * Records how many resources were attempted, captured, skipped
197
+ * (unsupported type or explicitly excluded), and failed.
198
+ *
199
+ */
200
+ capture_summary?: {
201
+ /**
202
+ * Total resources in the inventory that were attempted.
203
+ */
204
+ total: number;
205
+ /**
206
+ * Resources successfully fetched and written to the manifest.
207
+ */
208
+ captured: number;
209
+ /**
210
+ * Resources skipped — type not supported by config-engine or
211
+ * excluded from capture (e.g. access_token, environment_variable).
212
+ *
213
+ */
214
+ skipped: number;
215
+ /**
216
+ * Resources where the fetch call returned an error.
217
+ */
218
+ failed: number;
219
+ };
220
+ }
221
+ /**
222
+ * A single captured resource with its full payload. The identity fields
223
+ * match `SnapshotResourceSummary`; the `captured` payload is the
224
+ * pre-install state at snapshot time.
225
+ *
226
+ */
227
+ export interface SnapshotResourceDetail {
228
+ lineage_id: string;
229
+ target_id: string;
230
+ type: string;
231
+ name?: string | null;
232
+ /**
233
+ * Full captured payload of the resource at snapshot time.
234
+ */
235
+ captured: {
236
+ [name: string]: any;
237
+ };
238
+ }
239
+ export interface SnapshotResourceList {
240
+ resources: /**
241
+ * Lightweight identity for a captured resource. Returned by
242
+ * `listSnapshotResources`; the full payload is fetched separately via
243
+ * `getSnapshotResource` when needed.
244
+ *
245
+ */
246
+ SnapshotResourceSummary[];
247
+ }
248
+ /**
249
+ * Lightweight identity for a captured resource. Returned by
250
+ * `listSnapshotResources`; the full payload is fetched separately via
251
+ * `getSnapshotResource` when needed.
252
+ *
253
+ */
254
+ export interface SnapshotResourceSummary {
255
+ /**
256
+ * Deprecated alias of `target_id`. Always equals `target_id` (the
257
+ * implementation never distinguished them). Use `target_id`.
258
+ *
259
+ */
260
+ lineage_id: string;
261
+ /**
262
+ * Identifier the resource was captured by (passed in via `ResourceRef.id` on createSnapshot).
263
+ */
264
+ target_id: string;
265
+ type: string;
266
+ /**
267
+ * Best-effort display name extracted from the captured payload
268
+ * (`name` / `title` / `label` / `key` in that order). Null when
269
+ * none of those fields are present.
270
+ *
271
+ */
272
+ name?: string | null;
273
+ }
274
+ }
275
+ }
276
+ declare namespace Paths {
277
+ namespace CaptureOrgSnapshot {
278
+ export type RequestBody = /**
279
+ * Request body for `captureOrgSnapshot`. All fields optional — an empty body
280
+ * snapshots the whole org with a default name and the 90-day default TTL.
281
+ *
282
+ */
283
+ Components.Schemas.CreateOrgSnapshotRequest;
284
+ namespace Responses {
285
+ export type $202 = Components.Schemas.CreateSnapshotResponse;
286
+ export type $401 = Components.Responses.Unauthorized;
287
+ export type $422 = Components.Responses.UnprocessableEntity;
288
+ }
289
+ }
290
+ namespace CreateSnapshot {
291
+ export type RequestBody = Components.Schemas.CreateSnapshotRequest;
292
+ namespace Responses {
293
+ export type $202 = Components.Schemas.CreateSnapshotResponse;
294
+ export type $400 = Components.Responses.BadRequest;
295
+ export type $401 = Components.Responses.Unauthorized;
296
+ }
297
+ }
298
+ namespace DeleteSnapshot {
299
+ namespace Responses {
300
+ export interface $204 {
301
+ }
302
+ export type $401 = Components.Responses.Unauthorized;
303
+ export type $404 = Components.Responses.NotFound;
304
+ }
305
+ }
306
+ namespace GetSnapshot {
307
+ namespace Responses {
308
+ export type $200 = Components.Schemas.Snapshot;
309
+ export type $401 = Components.Responses.Unauthorized;
310
+ export type $404 = Components.Responses.NotFound;
311
+ }
312
+ }
313
+ namespace GetSnapshotResource {
314
+ namespace Responses {
315
+ export type $200 = /**
316
+ * A single captured resource with its full payload. The identity fields
317
+ * match `SnapshotResourceSummary`; the `captured` payload is the
318
+ * pre-install state at snapshot time.
319
+ *
320
+ */
321
+ Components.Schemas.SnapshotResourceDetail;
322
+ export type $401 = Components.Responses.Unauthorized;
323
+ export type $404 = Components.Responses.NotFound;
324
+ }
325
+ }
326
+ namespace ListDependencies {
327
+ export interface RequestBody {
328
+ resources: Components.Schemas.ResourceRef[];
329
+ }
330
+ namespace Responses {
331
+ export interface $200 {
332
+ dependencies: Components.Schemas.ResourceRef[];
333
+ }
334
+ export type $401 = Components.Responses.Unauthorized;
335
+ export type $501 = Components.Schemas.Error;
336
+ }
337
+ }
338
+ namespace ListSnapshotResources {
339
+ namespace Responses {
340
+ export type $200 = Components.Schemas.SnapshotResourceList;
341
+ export type $401 = Components.Responses.Unauthorized;
342
+ export type $404 = Components.Responses.NotFound;
343
+ }
344
+ }
345
+ namespace ListSnapshots {
346
+ namespace Parameters {
347
+ export type Cursor = string;
348
+ export type Resource = string /* ^[^:]+:.+$ */[];
349
+ export type Size = number;
350
+ export type Trigger = "manual" | "sync" | "blueprint_install" | "scheduled";
351
+ }
352
+ export interface QueryParameters {
353
+ cursor?: Parameters.Cursor;
354
+ size?: Parameters.Size;
355
+ resource?: Parameters.Resource;
356
+ trigger?: Parameters.Trigger;
357
+ }
358
+ namespace Responses {
359
+ export interface $200 {
360
+ /**
361
+ * Number of items in this page (not the total across all pages).
362
+ */
363
+ page_size: number;
364
+ /**
365
+ * Pagination cursor; pass to the next request to get the next page.
366
+ */
367
+ cursor?: string;
368
+ results: Components.Schemas.Snapshot[];
369
+ }
370
+ export type $401 = Components.Responses.Unauthorized;
371
+ }
372
+ }
373
+ namespace RestoreSnapshot {
374
+ export type RequestBody = /**
375
+ * Apply a captured snapshot to its source org. snapshot-api applies the
376
+ * manifest verbatim minus any target ids the caller pre-decided to skip.
377
+ * Drift detection (skip modified-since-install) is the caller's
378
+ * responsibility — blueprint-manifest-api owns that logic for blueprint
379
+ * restores; Config Hub's manual restore just omits the field.
380
+ *
381
+ */
382
+ Components.Schemas.RestoreSnapshotRequest;
383
+ namespace Responses {
384
+ export type $202 = Components.Schemas.RestoreSnapshotResponse;
385
+ export type $401 = Components.Responses.Unauthorized;
386
+ export type $404 = Components.Responses.NotFound;
387
+ }
388
+ }
389
+ namespace V1Snapshots$Id {
390
+ namespace Parameters {
391
+ export type Id = string;
392
+ }
393
+ export interface PathParameters {
394
+ id: Parameters.Id;
395
+ }
396
+ }
397
+ namespace V1Snapshots$IdResources {
398
+ namespace Parameters {
399
+ export type Id = string;
400
+ }
401
+ export interface PathParameters {
402
+ id: Parameters.Id;
403
+ }
404
+ }
405
+ namespace V1Snapshots$IdResources$LineageId {
406
+ namespace Parameters {
407
+ export type Id = string;
408
+ export type LineageId = string;
409
+ }
410
+ export interface PathParameters {
411
+ id: Parameters.Id;
412
+ lineage_id: Parameters.LineageId;
413
+ }
414
+ }
415
+ namespace V1Snapshots$IdRestore {
416
+ namespace Parameters {
417
+ export type Id = string;
418
+ }
419
+ export interface PathParameters {
420
+ id: Parameters.Id;
421
+ }
422
+ }
423
+ }
424
+
425
+
426
+ interface OperationMethods {
427
+ /**
428
+ * listSnapshots - listSnapshots
429
+ *
430
+ * List snapshots for the caller's organization, newest first.
431
+ *
432
+ * Pass `resource=<type>:<id>` one or more times to filter to snapshots
433
+ * containing **any** of the listed resources (OR semantics). Each returned
434
+ * snapshot includes a `matched_count` indicating how many of the filter
435
+ * pairs are present in it. Hard cap of 50 filter pairs per request. When
436
+ * filtered, pagination is not applied — the result set is bounded.
437
+ *
438
+ */
439
+ 'listSnapshots'(
440
+ parameters?: Parameters<Paths.ListSnapshots.QueryParameters> | null,
441
+ data?: any,
442
+ config?: AxiosRequestConfig
443
+ ): OperationResponse<Paths.ListSnapshots.Responses.$200>
444
+ /**
445
+ * createSnapshot - createSnapshot
446
+ *
447
+ * Create a new snapshot of the given resources. Async — returns immediately
448
+ * with a snapshot ID; client polls `getSnapshot` until `create.status`
449
+ * moves from `in_progress` to `completed` or `failed`.
450
+ *
451
+ */
452
+ 'createSnapshot'(
453
+ parameters?: Parameters<UnknownParamsObject> | null,
454
+ data?: Paths.CreateSnapshot.RequestBody,
455
+ config?: AxiosRequestConfig
456
+ ): OperationResponse<Paths.CreateSnapshot.Responses.$202>
457
+ /**
458
+ * captureOrgSnapshot - captureOrgSnapshot
459
+ *
460
+ * Snapshot the caller's whole organization now. Fetches a fresh inventory
461
+ * of the org's configuration resources from configuration-hub-api, persists
462
+ * it as an inventory artifact, and starts a `scope: "org"` chunked capture.
463
+ * Async — returns immediately with a snapshot ID; client polls `getSnapshot`
464
+ * and watches `capture_summary` fill in until `create.status` moves from
465
+ * `in_progress` to `completed` or `failed`.
466
+ *
467
+ * Sensitive types (`access_token`, `environment_variable`), types with no
468
+ * engine adapter, and any `excluded_types` are dropped from the capture and
469
+ * recorded in the snapshot's coverage report.
470
+ *
471
+ */
472
+ 'captureOrgSnapshot'(
473
+ parameters?: Parameters<UnknownParamsObject> | null,
474
+ data?: Paths.CaptureOrgSnapshot.RequestBody,
475
+ config?: AxiosRequestConfig
476
+ ): OperationResponse<Paths.CaptureOrgSnapshot.Responses.$202>
477
+ /**
478
+ * getSnapshot - getSnapshot
479
+ *
480
+ * Fetch a snapshot's metadata. Poll this endpoint to track create/restore progress.
481
+ */
482
+ 'getSnapshot'(
483
+ parameters?: Parameters<Paths.V1Snapshots$Id.PathParameters> | null,
484
+ data?: any,
485
+ config?: AxiosRequestConfig
486
+ ): OperationResponse<Paths.GetSnapshot.Responses.$200>
487
+ /**
488
+ * deleteSnapshot - deleteSnapshot
489
+ *
490
+ * Delete a snapshot's metadata and S3 manifest.
491
+ */
492
+ 'deleteSnapshot'(
493
+ parameters?: Parameters<Paths.V1Snapshots$Id.PathParameters> | null,
494
+ data?: any,
495
+ config?: AxiosRequestConfig
496
+ ): OperationResponse<Paths.DeleteSnapshot.Responses.$204>
497
+ /**
498
+ * restoreSnapshot - restoreSnapshot
499
+ *
500
+ * Restore a snapshot to the org. Async — returns immediately; client polls
501
+ * `getSnapshot` until the latest entry in `restores` moves from
502
+ * `in_progress` to one of `completed | partial | failed`.
503
+ *
504
+ * v1: full restore only. Cherry-pick (`resources?` body filter) is an open
505
+ * question — see RFC OQ #1.
506
+ *
507
+ */
508
+ 'restoreSnapshot'(
509
+ parameters?: Parameters<Paths.V1Snapshots$IdRestore.PathParameters> | null,
510
+ data?: Paths.RestoreSnapshot.RequestBody,
511
+ config?: AxiosRequestConfig
512
+ ): OperationResponse<Paths.RestoreSnapshot.Responses.$202>
513
+ /**
514
+ * listSnapshotResources - listSnapshotResources
515
+ *
516
+ * List the resources captured in this snapshot. Returns lightweight
517
+ * identity fields per resource — payloads are fetched via the
518
+ * single-resource endpoint when needed.
519
+ *
520
+ * Used by Config Hub UI to render snapshot contents, and by
521
+ * blueprint-manifest-api to partition lineage rows during a restore
522
+ * sweep (resources in this list are touched; others are net-new).
523
+ *
524
+ */
525
+ 'listSnapshotResources'(
526
+ parameters?: Parameters<Paths.V1Snapshots$IdResources.PathParameters> | null,
527
+ data?: any,
528
+ config?: AxiosRequestConfig
529
+ ): OperationResponse<Paths.ListSnapshotResources.Responses.$200>
530
+ /**
531
+ * getSnapshotResource - getSnapshotResource
532
+ *
533
+ * Fetch one captured resource with its full payload. For UI views
534
+ * that diff the captured state against the current destination.
535
+ *
536
+ */
537
+ 'getSnapshotResource'(
538
+ parameters?: Parameters<Paths.V1Snapshots$IdResources$LineageId.PathParameters> | null,
539
+ data?: any,
540
+ config?: AxiosRequestConfig
541
+ ): OperationResponse<Paths.GetSnapshotResource.Responses.$200>
542
+ /**
543
+ * listDependencies - listDependencies
544
+ *
545
+ * Walk the dependency tree for a set of resources and return the full
546
+ * transitive closure, topologically sorted.
547
+ *
548
+ * **Not implemented in v1.** Returns 501. Callers should pass an explicit
549
+ * resource list to `createSnapshot`. See RFC Phase 5.
550
+ *
551
+ */
552
+ 'listDependencies'(
553
+ parameters?: Parameters<UnknownParamsObject> | null,
554
+ data?: Paths.ListDependencies.RequestBody,
555
+ config?: AxiosRequestConfig
556
+ ): OperationResponse<Paths.ListDependencies.Responses.$200>
557
+ }
558
+
559
+ interface PathsDictionary {
560
+ ['/v1/snapshots']: {
561
+ /**
562
+ * createSnapshot - createSnapshot
563
+ *
564
+ * Create a new snapshot of the given resources. Async — returns immediately
565
+ * with a snapshot ID; client polls `getSnapshot` until `create.status`
566
+ * moves from `in_progress` to `completed` or `failed`.
567
+ *
568
+ */
569
+ 'post'(
570
+ parameters?: Parameters<UnknownParamsObject> | null,
571
+ data?: Paths.CreateSnapshot.RequestBody,
572
+ config?: AxiosRequestConfig
573
+ ): OperationResponse<Paths.CreateSnapshot.Responses.$202>
574
+ /**
575
+ * listSnapshots - listSnapshots
576
+ *
577
+ * List snapshots for the caller's organization, newest first.
578
+ *
579
+ * Pass `resource=<type>:<id>` one or more times to filter to snapshots
580
+ * containing **any** of the listed resources (OR semantics). Each returned
581
+ * snapshot includes a `matched_count` indicating how many of the filter
582
+ * pairs are present in it. Hard cap of 50 filter pairs per request. When
583
+ * filtered, pagination is not applied — the result set is bounded.
584
+ *
585
+ */
586
+ 'get'(
587
+ parameters?: Parameters<Paths.ListSnapshots.QueryParameters> | null,
588
+ data?: any,
589
+ config?: AxiosRequestConfig
590
+ ): OperationResponse<Paths.ListSnapshots.Responses.$200>
591
+ }
592
+ ['/v1/snapshots:capture-org']: {
593
+ /**
594
+ * captureOrgSnapshot - captureOrgSnapshot
595
+ *
596
+ * Snapshot the caller's whole organization now. Fetches a fresh inventory
597
+ * of the org's configuration resources from configuration-hub-api, persists
598
+ * it as an inventory artifact, and starts a `scope: "org"` chunked capture.
599
+ * Async — returns immediately with a snapshot ID; client polls `getSnapshot`
600
+ * and watches `capture_summary` fill in until `create.status` moves from
601
+ * `in_progress` to `completed` or `failed`.
602
+ *
603
+ * Sensitive types (`access_token`, `environment_variable`), types with no
604
+ * engine adapter, and any `excluded_types` are dropped from the capture and
605
+ * recorded in the snapshot's coverage report.
606
+ *
607
+ */
608
+ 'post'(
609
+ parameters?: Parameters<UnknownParamsObject> | null,
610
+ data?: Paths.CaptureOrgSnapshot.RequestBody,
611
+ config?: AxiosRequestConfig
612
+ ): OperationResponse<Paths.CaptureOrgSnapshot.Responses.$202>
613
+ }
614
+ ['/v1/snapshots/{id}']: {
615
+ /**
616
+ * getSnapshot - getSnapshot
617
+ *
618
+ * Fetch a snapshot's metadata. Poll this endpoint to track create/restore progress.
619
+ */
620
+ 'get'(
621
+ parameters?: Parameters<Paths.V1Snapshots$Id.PathParameters> | null,
622
+ data?: any,
623
+ config?: AxiosRequestConfig
624
+ ): OperationResponse<Paths.GetSnapshot.Responses.$200>
625
+ /**
626
+ * deleteSnapshot - deleteSnapshot
627
+ *
628
+ * Delete a snapshot's metadata and S3 manifest.
629
+ */
630
+ 'delete'(
631
+ parameters?: Parameters<Paths.V1Snapshots$Id.PathParameters> | null,
632
+ data?: any,
633
+ config?: AxiosRequestConfig
634
+ ): OperationResponse<Paths.DeleteSnapshot.Responses.$204>
635
+ }
636
+ ['/v1/snapshots/{id}:restore']: {
637
+ /**
638
+ * restoreSnapshot - restoreSnapshot
639
+ *
640
+ * Restore a snapshot to the org. Async — returns immediately; client polls
641
+ * `getSnapshot` until the latest entry in `restores` moves from
642
+ * `in_progress` to one of `completed | partial | failed`.
643
+ *
644
+ * v1: full restore only. Cherry-pick (`resources?` body filter) is an open
645
+ * question — see RFC OQ #1.
646
+ *
647
+ */
648
+ 'post'(
649
+ parameters?: Parameters<Paths.V1Snapshots$IdRestore.PathParameters> | null,
650
+ data?: Paths.RestoreSnapshot.RequestBody,
651
+ config?: AxiosRequestConfig
652
+ ): OperationResponse<Paths.RestoreSnapshot.Responses.$202>
653
+ }
654
+ ['/v1/snapshots/{id}/resources']: {
655
+ /**
656
+ * listSnapshotResources - listSnapshotResources
657
+ *
658
+ * List the resources captured in this snapshot. Returns lightweight
659
+ * identity fields per resource — payloads are fetched via the
660
+ * single-resource endpoint when needed.
661
+ *
662
+ * Used by Config Hub UI to render snapshot contents, and by
663
+ * blueprint-manifest-api to partition lineage rows during a restore
664
+ * sweep (resources in this list are touched; others are net-new).
665
+ *
666
+ */
667
+ 'get'(
668
+ parameters?: Parameters<Paths.V1Snapshots$IdResources.PathParameters> | null,
669
+ data?: any,
670
+ config?: AxiosRequestConfig
671
+ ): OperationResponse<Paths.ListSnapshotResources.Responses.$200>
672
+ }
673
+ ['/v1/snapshots/{id}/resources/{lineage_id}']: {
674
+ /**
675
+ * getSnapshotResource - getSnapshotResource
676
+ *
677
+ * Fetch one captured resource with its full payload. For UI views
678
+ * that diff the captured state against the current destination.
679
+ *
680
+ */
681
+ 'get'(
682
+ parameters?: Parameters<Paths.V1Snapshots$IdResources$LineageId.PathParameters> | null,
683
+ data?: any,
684
+ config?: AxiosRequestConfig
685
+ ): OperationResponse<Paths.GetSnapshotResource.Responses.$200>
686
+ }
687
+ ['/v1/snapshots:list-dependencies']: {
688
+ /**
689
+ * listDependencies - listDependencies
690
+ *
691
+ * Walk the dependency tree for a set of resources and return the full
692
+ * transitive closure, topologically sorted.
693
+ *
694
+ * **Not implemented in v1.** Returns 501. Callers should pass an explicit
695
+ * resource list to `createSnapshot`. See RFC Phase 5.
696
+ *
697
+ */
698
+ 'post'(
699
+ parameters?: Parameters<UnknownParamsObject> | null,
700
+ data?: Paths.ListDependencies.RequestBody,
701
+ config?: AxiosRequestConfig
702
+ ): OperationResponse<Paths.ListDependencies.Responses.$200>
703
+ }
704
+ }
705
+
706
+ type Client = OpenAPIClient<OperationMethods, PathsDictionary>
707
+
708
+
709
+ type CallerIdentity = Components.Schemas.CallerIdentity;
710
+ type CreateOrgSnapshotRequest = Components.Schemas.CreateOrgSnapshotRequest;
711
+ type CreateSnapshotRequest = Components.Schemas.CreateSnapshotRequest;
712
+ type CreateSnapshotResponse = Components.Schemas.CreateSnapshotResponse;
713
+ type EmptyInventoryError = Components.Schemas.EmptyInventoryError;
714
+ type Error = Components.Schemas.Error;
715
+ type Operation = Components.Schemas.Operation;
716
+ type ResourceRef = Components.Schemas.ResourceRef;
717
+ type RestoreSnapshotRequest = Components.Schemas.RestoreSnapshotRequest;
718
+ type RestoreSnapshotResponse = Components.Schemas.RestoreSnapshotResponse;
719
+ type Snapshot = Components.Schemas.Snapshot;
720
+ type SnapshotResourceDetail = Components.Schemas.SnapshotResourceDetail;
721
+ type SnapshotResourceList = Components.Schemas.SnapshotResourceList;
722
+ type SnapshotResourceSummary = Components.Schemas.SnapshotResourceSummary;
723
+
724
+ 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 };