@epilot/sdk 2.8.10 → 2.9.0

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