@epilot/sdk 2.8.3 → 2.8.5

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 (147) hide show
  1. package/definitions/blueprint-manifest-runtime.json +1 -1
  2. package/definitions/blueprint-manifest.json +571 -1
  3. package/definitions/snapshot-runtime.json +1 -1
  4. package/definitions/snapshot.json +222 -6
  5. package/dist/README-NBWAQWQS.js +7 -0
  6. package/dist/README-XCIDDEAE.cjs +7 -0
  7. package/dist/apis/access-token.cjs +6 -6
  8. package/dist/apis/access-token.js +1 -1
  9. package/dist/apis/address-suggestions.cjs +6 -6
  10. package/dist/apis/address-suggestions.js +1 -1
  11. package/dist/apis/address.cjs +6 -6
  12. package/dist/apis/address.js +1 -1
  13. package/dist/apis/ai-agents.cjs +6 -6
  14. package/dist/apis/ai-agents.js +1 -1
  15. package/dist/apis/app.cjs +6 -6
  16. package/dist/apis/app.js +1 -1
  17. package/dist/apis/audit-logs.cjs +6 -6
  18. package/dist/apis/audit-logs.js +1 -1
  19. package/dist/apis/automation.cjs +6 -6
  20. package/dist/apis/automation.js +1 -1
  21. package/dist/apis/billing.cjs +6 -6
  22. package/dist/apis/billing.js +1 -1
  23. package/dist/apis/blueprint-manifest.cjs +8 -8
  24. package/dist/apis/blueprint-manifest.d.cts +2 -2
  25. package/dist/apis/blueprint-manifest.d.ts +2 -2
  26. package/dist/apis/blueprint-manifest.js +2 -2
  27. package/dist/apis/calendar.cjs +6 -6
  28. package/dist/apis/calendar.js +1 -1
  29. package/dist/apis/configuration-hub.cjs +6 -6
  30. package/dist/apis/configuration-hub.js +1 -1
  31. package/dist/apis/consent.cjs +6 -6
  32. package/dist/apis/consent.js +1 -1
  33. package/dist/apis/customer-portal.cjs +6 -6
  34. package/dist/apis/customer-portal.js +1 -1
  35. package/dist/apis/dashboard.cjs +6 -6
  36. package/dist/apis/dashboard.js +1 -1
  37. package/dist/apis/data-governance.cjs +6 -6
  38. package/dist/apis/data-governance.js +1 -1
  39. package/dist/apis/deduplication.cjs +6 -6
  40. package/dist/apis/deduplication.js +1 -1
  41. package/dist/apis/design.cjs +6 -6
  42. package/dist/apis/design.js +1 -1
  43. package/dist/apis/document.cjs +6 -6
  44. package/dist/apis/document.js +1 -1
  45. package/dist/apis/email-settings.cjs +6 -6
  46. package/dist/apis/email-settings.js +1 -1
  47. package/dist/apis/email-template.cjs +6 -6
  48. package/dist/apis/email-template.js +1 -1
  49. package/dist/apis/entity-mapping.cjs +6 -6
  50. package/dist/apis/entity-mapping.js +1 -1
  51. package/dist/apis/entity.cjs +6 -6
  52. package/dist/apis/entity.js +1 -1
  53. package/dist/apis/environments.cjs +6 -6
  54. package/dist/apis/environments.js +1 -1
  55. package/dist/apis/event-catalog.cjs +6 -6
  56. package/dist/apis/event-catalog.js +1 -1
  57. package/dist/apis/file.cjs +6 -6
  58. package/dist/apis/file.js +1 -1
  59. package/dist/apis/iban.cjs +6 -6
  60. package/dist/apis/iban.js +1 -1
  61. package/dist/apis/integration-toolkit.cjs +6 -6
  62. package/dist/apis/integration-toolkit.js +1 -1
  63. package/dist/apis/journey.cjs +6 -6
  64. package/dist/apis/journey.js +1 -1
  65. package/dist/apis/kanban.cjs +6 -6
  66. package/dist/apis/kanban.js +1 -1
  67. package/dist/apis/message.cjs +6 -6
  68. package/dist/apis/message.js +1 -1
  69. package/dist/apis/metering.cjs +6 -6
  70. package/dist/apis/metering.js +1 -1
  71. package/dist/apis/notes.cjs +6 -6
  72. package/dist/apis/notes.js +1 -1
  73. package/dist/apis/notification.cjs +6 -6
  74. package/dist/apis/notification.js +1 -1
  75. package/dist/apis/organization.cjs +6 -6
  76. package/dist/apis/organization.js +1 -1
  77. package/dist/apis/partner-directory.cjs +6 -6
  78. package/dist/apis/partner-directory.js +1 -1
  79. package/dist/apis/permissions.cjs +6 -6
  80. package/dist/apis/permissions.js +1 -1
  81. package/dist/apis/pricing-tier.cjs +6 -6
  82. package/dist/apis/pricing-tier.js +1 -1
  83. package/dist/apis/pricing.cjs +6 -6
  84. package/dist/apis/pricing.js +1 -1
  85. package/dist/apis/purpose.cjs +6 -6
  86. package/dist/apis/purpose.js +1 -1
  87. package/dist/apis/query.cjs +6 -6
  88. package/dist/apis/query.js +1 -1
  89. package/dist/apis/sandbox.cjs +6 -6
  90. package/dist/apis/sandbox.js +1 -1
  91. package/dist/apis/sharing.cjs +6 -6
  92. package/dist/apis/sharing.js +1 -1
  93. package/dist/apis/snapshot.cjs +8 -8
  94. package/dist/apis/snapshot.d.cts +2 -2
  95. package/dist/apis/snapshot.d.ts +2 -2
  96. package/dist/apis/snapshot.js +2 -2
  97. package/dist/apis/submission.cjs +6 -6
  98. package/dist/apis/submission.js +1 -1
  99. package/dist/apis/target.cjs +6 -6
  100. package/dist/apis/target.js +1 -1
  101. package/dist/apis/targeting.cjs +6 -6
  102. package/dist/apis/targeting.js +1 -1
  103. package/dist/apis/template-variables.cjs +6 -6
  104. package/dist/apis/template-variables.js +1 -1
  105. package/dist/apis/user.cjs +6 -6
  106. package/dist/apis/user.js +1 -1
  107. package/dist/apis/validation-rules.cjs +6 -6
  108. package/dist/apis/validation-rules.js +1 -1
  109. package/dist/apis/webhooks.cjs +6 -6
  110. package/dist/apis/webhooks.js +1 -1
  111. package/dist/apis/workflow-definition.cjs +6 -6
  112. package/dist/apis/workflow-definition.js +1 -1
  113. package/dist/apis/workflow.cjs +6 -6
  114. package/dist/apis/workflow.js +1 -1
  115. package/dist/blueprint-manifest-WHYSBU66.cjs +7 -0
  116. package/dist/blueprint-manifest-WZVBTKUL.js +7 -0
  117. package/dist/{blueprint-manifest-runtime-FRLU3ZSF.js → blueprint-manifest-runtime-2344IUIE.js} +1 -1
  118. package/dist/{blueprint-manifest-runtime-EIDOROIQ.cjs → blueprint-manifest-runtime-WU5MWPVT.cjs} +2 -2
  119. package/dist/{blueprint-manifest.d-B8yDxagC.d.cts → blueprint-manifest.d-2-TORV8o.d.cts} +926 -4
  120. package/dist/{blueprint-manifest.d-B8yDxagC.d.ts → blueprint-manifest.d-2-TORV8o.d.ts} +926 -4
  121. package/dist/chunk-4SZCKUY2.js +14 -0
  122. package/dist/{chunk-76M3RIDP.js → chunk-5FXMXMNX.js} +5 -5
  123. package/dist/{chunk-NGHCQ2FA.cjs → chunk-T57MT6J5.cjs} +1 -1
  124. package/dist/chunk-ULKFBO7E.cjs +14 -0
  125. package/dist/{chunk-4YBWMDFP.js → chunk-UWGWRGGB.js} +1 -1
  126. package/dist/{chunk-FBQ4WDTG.cjs → chunk-XRIEGQXL.cjs} +5 -5
  127. package/dist/index.cjs +12 -12
  128. package/dist/index.d.cts +2 -2
  129. package/dist/index.d.ts +2 -2
  130. package/dist/index.js +3 -3
  131. package/dist/snapshot-GDJOEFJQ.js +7 -0
  132. package/dist/snapshot-UKV54UQQ.cjs +7 -0
  133. package/dist/{snapshot-runtime-NWQYU5UK.cjs → snapshot-runtime-5TT575JS.cjs} +2 -2
  134. package/dist/{snapshot-runtime-ALPJLXVW.js → snapshot-runtime-KWRGOKF4.js} +1 -1
  135. package/dist/{snapshot.d-DvoJ2n-v.d.cts → snapshot.d-C-n4wkIu.d.cts} +224 -62
  136. package/dist/{snapshot.d-DvoJ2n-v.d.ts → snapshot.d-C-n4wkIu.d.ts} +224 -62
  137. package/docs/blueprint-manifest.md +421 -95
  138. package/docs/snapshot.md +168 -15
  139. package/package.json +1 -1
  140. package/dist/README-46VYEGGW.js +0 -7
  141. package/dist/README-IVBISSWB.cjs +0 -7
  142. package/dist/blueprint-manifest-6DEYW5MW.js +0 -7
  143. package/dist/blueprint-manifest-GCV7H74X.cjs +0 -7
  144. package/dist/chunk-BJGLY4Z2.js +0 -14
  145. package/dist/chunk-K2QVMO5M.cjs +0 -14
  146. package/dist/snapshot-427N6KCO.js +0 -7
  147. package/dist/snapshot-NEMUND3M.cjs +0 -7
@@ -52,6 +52,8 @@ const { data } = await blueprintManifestClient.getJob(...)
52
52
  - [`updateBlueprintResource`](#updateblueprintresource)
53
53
  - [`deleteBlueprintResource`](#deleteblueprintresource)
54
54
  - [`installBlueprintV3`](#installblueprintv3)
55
+ - [`restoreBlueprintDeploymentV3`](#restoreblueprintdeploymentv3)
56
+ - [`getRestorePreview`](#getrestorepreview)
55
57
  - [`getBlueprintLineageV3`](#getblueprintlineagev3)
56
58
 
57
59
  **Patches**
@@ -82,7 +84,15 @@ const { data } = await blueprintManifestClient.getJob(...)
82
84
  - [`updateMarketplaceListingVersion`](#updatemarketplacelistingversion)
83
85
  - [`publishMarketplaceListingVersion`](#publishmarketplacelistingversion)
84
86
 
87
+ **Uniqueness Criteria**
88
+ - [`listUniquenessCriteria`](#listuniquenesscriteria)
89
+ - [`getUniquenessCriteria`](#getuniquenesscriteria)
90
+ - [`putUniquenessCriteria`](#putuniquenesscriteria)
91
+ - [`deleteUniquenessCriteria`](#deleteuniquenesscriteria)
92
+
85
93
  **Schemas**
94
+ - [`UniquenessCriteriaResourceType`](#uniquenesscriteriaresourcetype)
95
+ - [`UniquenessCriteria`](#uniquenesscriteria)
86
96
  - [`LineageEntry`](#lineageentry)
87
97
  - [`PatchFieldDiff`](#patchfielddiff)
88
98
  - [`PatchResourceDiff`](#patchresourcediff)
@@ -108,7 +118,10 @@ const { data } = await blueprintManifestClient.getJob(...)
108
118
  - [`CommonBlueprintJobFields`](#commonblueprintjobfields)
109
119
  - [`BlueprintExportJob`](#blueprintexportjob)
110
120
  - [`BlueprintInstallationJob`](#blueprintinstallationjob)
121
+ - [`BlueprintRestoreJob`](#blueprintrestorejob)
111
122
  - [`V3ResourceProgressEntry`](#v3resourceprogressentry)
123
+ - [`RestoreOutcomeItem`](#restoreoutcomeitem)
124
+ - [`RestoreOutcome`](#restoreoutcome)
112
125
  - [`BlueprintJob`](#blueprintjob)
113
126
  - [`BlueprintDependenciesSyncJob`](#blueprintdependenciessyncjob)
114
127
  - [`BlueprintValidateJob`](#blueprintvalidatejob)
@@ -206,83 +219,25 @@ const { data } = await client.listBlueprints({
206
219
  "id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
207
220
  "title": "string",
208
221
  "slug": "string",
209
- "description": {
210
- "preinstall": "This is the content of the preinstall.md file which contains the blueprint description.\n",
211
- "postinstall": "This is the content of the postinstall.md file\n"
212
- },
222
+ "description": {},
213
223
  "version": "string",
214
- "deployments": [
215
- {
216
- "source_org_id": "string",
217
- "source_blueprint_id": "string",
218
- "destination_org_id": "string",
219
- "destination_blueprint_id": "string",
220
- "job_id": "string",
221
- "triggered_at": "1970-01-01T00:00:00.000Z",
222
- "note": "string",
223
- "status": "IN_PROGRESS"
224
- }
225
- ],
224
+ "deployments": [],
226
225
  "is_verified": true,
227
- "latest_verification": {
228
- "job_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
229
- "status": "IN_PROGRESS",
230
- "triggered_at": "1970-01-01T00:00:00.000Z",
231
- "source_org_id": "string",
232
- "source_blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
233
- "destination_org_id": "string",
234
- "destination_blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
235
- "summary": {
236
- "total_resources": 0,
237
- "matched": 0,
238
- "mismatched": 0,
239
- "missing_in_destination": 0,
240
- "fetch_errors": 0
241
- }
242
- },
226
+ "latest_verification": {},
243
227
  "ignored_resource_addresses": ["string"],
244
228
  "installation_status": "IN_PROGRESS",
245
229
  "created_at": "1970-01-01T00:00:00.000Z",
246
230
  "updated_at": "1970-01-01T00:00:00.000Z",
247
- "created_by": {
248
- "name": "manifest@epilot.cloud",
249
- "org_id": "911690",
250
- "user_id": "11001045",
251
- "token_id": "api_5ZugdRXasLfWBypHi93Fk"
252
- },
253
- "updated_by": {
254
- "name": "manifest@epilot.cloud",
255
- "org_id": "911690",
256
- "user_id": "11001045",
257
- "token_id": "api_5ZugdRXasLfWBypHi93Fk"
258
- },
231
+ "created_by": {},
232
+ "updated_by": {},
259
233
  "installation_job_ids": ["c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341"],
260
234
  "source_blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
261
235
  "archived": false,
262
236
  "docs_url": "string",
263
237
  "recommended_apps": ["string"],
264
- "required_features": {
265
- "enabled": ["string"],
266
- "disabled": ["string"]
267
- },
238
+ "required_features": {},
268
239
  "zip_file_name": "string",
269
- "resources": [
270
- {
271
- "id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
272
- "name": "string",
273
- "type": "designbuilder",
274
- "address": "string",
275
- "is_root": true,
276
- "is_ready": true,
277
- "is_hidden": true,
278
- "is_disabled": false,
279
- "hard_dependencies": ["designbuilder"],
280
- "parent_resource_ids": ["c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341"],
281
- "depends_on_addresses": ["string"],
282
- "impact_on_install": ["create"],
283
- "impact_on_install_reason": ["string"]
284
- }
285
- ],
240
+ "resources": [],
286
241
  "source_type": "custom"
287
242
  }
288
243
  ]
@@ -322,7 +277,11 @@ const { data } = await client.createBlueprint(
322
277
  job_id: 'string',
323
278
  triggered_at: '1970-01-01T00:00:00.000Z',
324
279
  note: 'string',
325
- status: 'IN_PROGRESS'
280
+ status: 'IN_PROGRESS',
281
+ restore_details: { /* ... */ },
282
+ has_revertible_changes: true,
283
+ last_restore_job_id: 'string',
284
+ restore_status: 'available'
326
285
  }
327
286
  ],
328
287
  is_verified: true,
@@ -412,7 +371,11 @@ const { data } = await client.createBlueprint(
412
371
  "job_id": "string",
413
372
  "triggered_at": "1970-01-01T00:00:00.000Z",
414
373
  "note": "string",
415
- "status": "IN_PROGRESS"
374
+ "status": "IN_PROGRESS",
375
+ "restore_details": {},
376
+ "has_revertible_changes": true,
377
+ "last_restore_job_id": "string",
378
+ "restore_status": "available"
416
379
  }
417
380
  ],
418
381
  "is_verified": true,
@@ -732,7 +695,11 @@ const { data } = await client.getBlueprint({
732
695
  "job_id": "string",
733
696
  "triggered_at": "1970-01-01T00:00:00.000Z",
734
697
  "note": "string",
735
- "status": "IN_PROGRESS"
698
+ "status": "IN_PROGRESS",
699
+ "restore_details": {},
700
+ "has_revertible_changes": true,
701
+ "last_restore_job_id": "string",
702
+ "restore_status": "available"
736
703
  }
737
704
  ],
738
705
  "is_verified": true,
@@ -834,7 +801,11 @@ const { data } = await client.updateBlueprint(
834
801
  job_id: 'string',
835
802
  triggered_at: '1970-01-01T00:00:00.000Z',
836
803
  note: 'string',
837
- status: 'IN_PROGRESS'
804
+ status: 'IN_PROGRESS',
805
+ restore_details: { /* ... */ },
806
+ has_revertible_changes: true,
807
+ last_restore_job_id: 'string',
808
+ restore_status: 'available'
838
809
  }
839
810
  ],
840
811
  is_verified: true,
@@ -924,7 +895,11 @@ const { data } = await client.updateBlueprint(
924
895
  "job_id": "string",
925
896
  "triggered_at": "1970-01-01T00:00:00.000Z",
926
897
  "note": "string",
927
- "status": "IN_PROGRESS"
898
+ "status": "IN_PROGRESS",
899
+ "restore_details": {},
900
+ "has_revertible_changes": true,
901
+ "last_restore_job_id": "string",
902
+ "restore_status": "available"
928
903
  }
929
904
  ],
930
905
  "is_verified": true,
@@ -1029,7 +1004,11 @@ const { data } = await client.deleteBlueprint({
1029
1004
  "job_id": "string",
1030
1005
  "triggered_at": "1970-01-01T00:00:00.000Z",
1031
1006
  "note": "string",
1032
- "status": "IN_PROGRESS"
1007
+ "status": "IN_PROGRESS",
1008
+ "restore_details": {},
1009
+ "has_revertible_changes": true,
1010
+ "last_restore_job_id": "string",
1011
+ "restore_status": "available"
1033
1012
  }
1034
1013
  ],
1035
1014
  "is_verified": true,
@@ -2046,6 +2025,7 @@ const { data } = await client.listBlueprintJobs()
2046
2025
  "user_id": "11001045",
2047
2026
  "token_id": "api_5ZugdRXasLfWBypHi93Fk"
2048
2027
  },
2028
+ "job_type": "export",
2049
2029
  "blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
2050
2030
  "status": "IN_PROGRESS",
2051
2031
  "download_file": {
@@ -2116,6 +2096,7 @@ const { data } = await client.getBlueprintJob({
2116
2096
  "user_id": "11001045",
2117
2097
  "token_id": "api_5ZugdRXasLfWBypHi93Fk"
2118
2098
  },
2099
+ "job_type": "export",
2119
2100
  "blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
2120
2101
  "status": "IN_PROGRESS",
2121
2102
  "download_file": {
@@ -2189,6 +2170,7 @@ const { data } = await client.continueInstallationJob(
2189
2170
  "user_id": "11001045",
2190
2171
  "token_id": "api_5ZugdRXasLfWBypHi93Fk"
2191
2172
  },
2173
+ "job_type": "install",
2192
2174
  "source_blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
2193
2175
  "source_blueprint_type": "custom",
2194
2176
  "source_org_id": "string",
@@ -2271,6 +2253,7 @@ const { data } = await client.cancelBlueprintJob({
2271
2253
  "user_id": "11001045",
2272
2254
  "token_id": "api_5ZugdRXasLfWBypHi93Fk"
2273
2255
  },
2256
+ "job_type": "export",
2274
2257
  "blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
2275
2258
  "status": "IN_PROGRESS",
2276
2259
  "download_file": {
@@ -2877,6 +2860,60 @@ const { data } = await client.installBlueprintV3(
2877
2860
 
2878
2861
  ---
2879
2862
 
2863
+ ### `restoreBlueprintDeploymentV3`
2864
+
2865
+ Restore a specific deployment by job_id
2866
+
2867
+ `POST /v3/blueprint-manifest/blueprints/{blueprint_id}/deployments/{job_id}:restore`
2868
+
2869
+ ```ts
2870
+ const { data } = await client.restoreBlueprintDeploymentV3({
2871
+ blueprint_id: 'example',
2872
+ job_id: 'example',
2873
+ })
2874
+ ```
2875
+
2876
+ ---
2877
+
2878
+ ### `getRestorePreview`
2879
+
2880
+ Predicted outcome of reverting a deployment
2881
+
2882
+ `GET /v3/blueprint-manifest/blueprints/{blueprint_id}/deployments/{job_id}/restore-preview`
2883
+
2884
+ ```ts
2885
+ const { data } = await client.getRestorePreview({
2886
+ blueprint_id: 'example',
2887
+ job_id: 'example',
2888
+ })
2889
+ ```
2890
+
2891
+ <details>
2892
+ <summary>Response</summary>
2893
+
2894
+ ```json
2895
+ {
2896
+ "snapshot_id": "string",
2897
+ "resources": [
2898
+ {
2899
+ "lineage_id": "string",
2900
+ "type": "string",
2901
+ "name": "string",
2902
+ "target_id": "string",
2903
+ "action": "restore",
2904
+ "reason": "modified",
2905
+ "last_synced_at": "1970-01-01T00:00:00.000Z",
2906
+ "current_updated_at": "1970-01-01T00:00:00.000Z",
2907
+ "error_message": "string"
2908
+ }
2909
+ ]
2910
+ }
2911
+ ```
2912
+
2913
+ </details>
2914
+
2915
+ ---
2916
+
2880
2917
  ### `getBlueprintLineageV3`
2881
2918
 
2882
2919
  Get Blueprint Lineage V3
@@ -2912,8 +2949,140 @@ const { data } = await client.getBlueprintLineageV3({
2912
2949
 
2913
2950
  ---
2914
2951
 
2952
+ ### `listUniquenessCriteria`
2953
+
2954
+ List all custom uniqueness criteria configured for the caller's organization.
2955
+ These overrides are applied during install (V2 and V3) when matching incoming
2956
+ resources against existing ones in the desti
2957
+
2958
+ `GET /v1/blueprint-manifest/uniqueness-criteria`
2959
+
2960
+ ```ts
2961
+ const { data } = await client.listUniquenessCriteria()
2962
+ ```
2963
+
2964
+ <details>
2965
+ <summary>Response</summary>
2966
+
2967
+ ```json
2968
+ {
2969
+ "results": [
2970
+ {
2971
+ "org_id": "string",
2972
+ "resource_type": "emailtemplate",
2973
+ "fields": ["string"],
2974
+ "updated_at": "1970-01-01T00:00:00.000Z",
2975
+ "updated_by": "string"
2976
+ }
2977
+ ]
2978
+ }
2979
+ ```
2980
+
2981
+ </details>
2982
+
2983
+ ---
2984
+
2985
+ ### `getUniquenessCriteria`
2986
+
2987
+ Get the configured uniqueness criteria for a specific resource type, if any.
2988
+
2989
+ `GET /v1/blueprint-manifest/uniqueness-criteria/{resource_type}`
2990
+
2991
+ ```ts
2992
+ const { data } = await client.getUniquenessCriteria({
2993
+ resource_type: 'example',
2994
+ })
2995
+ ```
2996
+
2997
+ <details>
2998
+ <summary>Response</summary>
2999
+
3000
+ ```json
3001
+ {
3002
+ "org_id": "string",
3003
+ "resource_type": "emailtemplate",
3004
+ "fields": ["string"],
3005
+ "updated_at": "1970-01-01T00:00:00.000Z",
3006
+ "updated_by": "string"
3007
+ }
3008
+ ```
3009
+
3010
+ </details>
3011
+
3012
+ ---
3013
+
3014
+ ### `putUniquenessCriteria`
3015
+
3016
+ Set or replace the uniqueness criteria for a resource type. The provided fields
3017
+ must be valid attributes on the resource's schema (the UI typically loads the
3018
+ schema to populate options). All listed fi
3019
+
3020
+ `PUT /v1/blueprint-manifest/uniqueness-criteria/{resource_type}`
3021
+
3022
+ ```ts
3023
+ const { data } = await client.putUniquenessCriteria(
3024
+ {
3025
+ resource_type: 'example',
3026
+ },
3027
+ {
3028
+ fields: ['string']
3029
+ },
3030
+ )
3031
+ ```
3032
+
3033
+ <details>
3034
+ <summary>Response</summary>
3035
+
3036
+ ```json
3037
+ {
3038
+ "org_id": "string",
3039
+ "resource_type": "emailtemplate",
3040
+ "fields": ["string"],
3041
+ "updated_at": "1970-01-01T00:00:00.000Z",
3042
+ "updated_by": "string"
3043
+ }
3044
+ ```
3045
+
3046
+ </details>
3047
+
3048
+ ---
3049
+
3050
+ ### `deleteUniquenessCriteria`
3051
+
3052
+ Remove the custom criteria for a resource type, reverting to the default fields.
3053
+
3054
+ `DELETE /v1/blueprint-manifest/uniqueness-criteria/{resource_type}`
3055
+
3056
+ ```ts
3057
+ const { data } = await client.deleteUniquenessCriteria({
3058
+ resource_type: 'example',
3059
+ })
3060
+ ```
3061
+
3062
+ ---
3063
+
2915
3064
  ## Schemas
2916
3065
 
3066
+ ### `UniquenessCriteriaResourceType`
3067
+
3068
+ Resource type for which custom uniqueness criteria can be configured.
3069
+
3070
+ ```ts
3071
+ type UniquenessCriteriaResourceType = "emailtemplate" | "product" | "price" | "tax" | "coupon" | "product_recommendation" | "file" | "document_template" | "schema" | "taxonomy" | "notification_template" | "family" | "permission" | "journey"
3072
+ ```
3073
+
3074
+ ### `UniquenessCriteria`
3075
+
3076
+ ```ts
3077
+ type UniquenessCriteria = {
3078
+ org_id: string
3079
+ resource_type: "emailtemplate" | "product" | "price" | "tax" | "coupon" | "product_recommendation" | "file" | "document_template" | "schema" | "taxonomy" | "notification_template" | "family" | "permission" | "journey"
3080
+ fields: string[]
3081
+ updated_at: string // date-time
3082
+ updated_by?: string
3083
+ }
3084
+ ```
3085
+
2917
3086
  ### `LineageEntry`
2918
3087
 
2919
3088
  ```ts
@@ -3112,11 +3281,22 @@ type CommonBlueprintFields = {
3112
3281
  triggered_at?: string // date-time
3113
3282
  note?: string
3114
3283
  status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED"
3284
+ restore_details?: {
3285
+ has_revertible_changes?: { ... }
3286
+ resource_impact_summary?: { ... }
3287
+ last_restore_job_id?: { ... }
3288
+ last_restore_at?: { ... }
3289
+ last_restored_by?: { ... }
3290
+ status?: { ... }
3291
+ }
3292
+ has_revertible_changes?: boolean
3293
+ last_restore_job_id?: string
3294
+ restore_status?: "available" | "in_progress" | "restored" | "partially_restored" | "restore_failed" | "unavailable"
3115
3295
  }>
3116
3296
  is_verified?: boolean
3117
3297
  latest_verification?: {
3118
3298
  job_id?: string
3119
- status?: "IN_PROGRESS" | "SUCCESS" | "FAILED"
3299
+ status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED"
3120
3300
  triggered_at?: string // date-time
3121
3301
  source_org_id?: string
3122
3302
  source_blueprint_id?: string
@@ -3283,11 +3463,22 @@ type CustomBlueprint = {
3283
3463
  triggered_at?: string // date-time
3284
3464
  note?: string
3285
3465
  status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED"
3466
+ restore_details?: {
3467
+ has_revertible_changes?: { ... }
3468
+ resource_impact_summary?: { ... }
3469
+ last_restore_job_id?: { ... }
3470
+ last_restore_at?: { ... }
3471
+ last_restored_by?: { ... }
3472
+ status?: { ... }
3473
+ }
3474
+ has_revertible_changes?: boolean
3475
+ last_restore_job_id?: string
3476
+ restore_status?: "available" | "in_progress" | "restored" | "partially_restored" | "restore_failed" | "unavailable"
3286
3477
  }>
3287
3478
  is_verified?: boolean
3288
3479
  latest_verification?: {
3289
3480
  job_id?: string
3290
- status?: "IN_PROGRESS" | "SUCCESS" | "FAILED"
3481
+ status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED"
3291
3482
  triggered_at?: string // date-time
3292
3483
  source_org_id?: string
3293
3484
  source_blueprint_id?: string
@@ -3367,11 +3558,22 @@ type FileBlueprint = {
3367
3558
  triggered_at?: string // date-time
3368
3559
  note?: string
3369
3560
  status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED"
3561
+ restore_details?: {
3562
+ has_revertible_changes?: { ... }
3563
+ resource_impact_summary?: { ... }
3564
+ last_restore_job_id?: { ... }
3565
+ last_restore_at?: { ... }
3566
+ last_restored_by?: { ... }
3567
+ status?: { ... }
3568
+ }
3569
+ has_revertible_changes?: boolean
3570
+ last_restore_job_id?: string
3571
+ restore_status?: "available" | "in_progress" | "restored" | "partially_restored" | "restore_failed" | "unavailable"
3370
3572
  }>
3371
3573
  is_verified?: boolean
3372
3574
  latest_verification?: {
3373
3575
  job_id?: string
3374
- status?: "IN_PROGRESS" | "SUCCESS" | "FAILED"
3576
+ status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED"
3375
3577
  triggered_at?: string // date-time
3376
3578
  source_org_id?: string
3377
3579
  source_blueprint_id?: string
@@ -3451,11 +3653,22 @@ type MarketplaceBlueprint = {
3451
3653
  triggered_at?: string // date-time
3452
3654
  note?: string
3453
3655
  status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED"
3656
+ restore_details?: {
3657
+ has_revertible_changes?: { ... }
3658
+ resource_impact_summary?: { ... }
3659
+ last_restore_job_id?: { ... }
3660
+ last_restore_at?: { ... }
3661
+ last_restored_by?: { ... }
3662
+ status?: { ... }
3663
+ }
3664
+ has_revertible_changes?: boolean
3665
+ last_restore_job_id?: string
3666
+ restore_status?: "available" | "in_progress" | "restored" | "partially_restored" | "restore_failed" | "unavailable"
3454
3667
  }>
3455
3668
  is_verified?: boolean
3456
3669
  latest_verification?: {
3457
3670
  job_id?: string
3458
- status?: "IN_PROGRESS" | "SUCCESS" | "FAILED"
3671
+ status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED"
3459
3672
  triggered_at?: string // date-time
3460
3673
  source_org_id?: string
3461
3674
  source_blueprint_id?: string
@@ -3567,11 +3780,22 @@ type DeployedBlueprint = {
3567
3780
  triggered_at?: string // date-time
3568
3781
  note?: string
3569
3782
  status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED"
3783
+ restore_details?: {
3784
+ has_revertible_changes?: { ... }
3785
+ resource_impact_summary?: { ... }
3786
+ last_restore_job_id?: { ... }
3787
+ last_restore_at?: { ... }
3788
+ last_restored_by?: { ... }
3789
+ status?: { ... }
3790
+ }
3791
+ has_revertible_changes?: boolean
3792
+ last_restore_job_id?: string
3793
+ restore_status?: "available" | "in_progress" | "restored" | "partially_restored" | "restore_failed" | "unavailable"
3570
3794
  }>
3571
3795
  is_verified?: boolean
3572
3796
  latest_verification?: {
3573
3797
  job_id?: string
3574
- status?: "IN_PROGRESS" | "SUCCESS" | "FAILED"
3798
+ status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED"
3575
3799
  triggered_at?: string // date-time
3576
3800
  source_org_id?: string
3577
3801
  source_blueprint_id?: string
@@ -3651,11 +3875,22 @@ type AppBlueprint = {
3651
3875
  triggered_at?: string // date-time
3652
3876
  note?: string
3653
3877
  status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED"
3878
+ restore_details?: {
3879
+ has_revertible_changes?: { ... }
3880
+ resource_impact_summary?: { ... }
3881
+ last_restore_job_id?: { ... }
3882
+ last_restore_at?: { ... }
3883
+ last_restored_by?: { ... }
3884
+ status?: { ... }
3885
+ }
3886
+ has_revertible_changes?: boolean
3887
+ last_restore_job_id?: string
3888
+ restore_status?: "available" | "in_progress" | "restored" | "partially_restored" | "restore_failed" | "unavailable"
3654
3889
  }>
3655
3890
  is_verified?: boolean
3656
3891
  latest_verification?: {
3657
3892
  job_id?: string
3658
- status?: "IN_PROGRESS" | "SUCCESS" | "FAILED"
3893
+ status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED"
3659
3894
  triggered_at?: string // date-time
3660
3895
  source_org_id?: string
3661
3896
  source_blueprint_id?: string
@@ -3735,11 +3970,22 @@ type Blueprint = {
3735
3970
  triggered_at?: string // date-time
3736
3971
  note?: string
3737
3972
  status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED"
3973
+ restore_details?: {
3974
+ has_revertible_changes?: { ... }
3975
+ resource_impact_summary?: { ... }
3976
+ last_restore_job_id?: { ... }
3977
+ last_restore_at?: { ... }
3978
+ last_restored_by?: { ... }
3979
+ status?: { ... }
3980
+ }
3981
+ has_revertible_changes?: boolean
3982
+ last_restore_job_id?: string
3983
+ restore_status?: "available" | "in_progress" | "restored" | "partially_restored" | "restore_failed" | "unavailable"
3738
3984
  }>
3739
3985
  is_verified?: boolean
3740
3986
  latest_verification?: {
3741
3987
  job_id?: string
3742
- status?: "IN_PROGRESS" | "SUCCESS" | "FAILED"
3988
+ status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED"
3743
3989
  triggered_at?: string // date-time
3744
3990
  source_org_id?: string
3745
3991
  source_blueprint_id?: string
@@ -3806,17 +4052,6 @@ type Blueprint = {
3806
4052
  version?: string
3807
4053
  deployments?: Array<{
3808
4054
  source_org_id?: string
3809
- source_blueprint_id?: string
3810
- destination_org_id?: string
3811
- destination_blueprint_id?: string
3812
- job_id?: string
3813
- triggered_at?: string // date-time
3814
- note?: string
3815
- status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED"
3816
- }>
3817
- is_verified?: boolean
3818
- latest_verification?: {
3819
- job_id?: string
3820
4055
  // ...
3821
4056
  }
3822
4057
  ```
@@ -3886,6 +4121,7 @@ type BlueprintExportJob = {
3886
4121
  user_id?: string
3887
4122
  token_id?: string
3888
4123
  }
4124
+ job_type?: "export"
3889
4125
  blueprint_id?: string
3890
4126
  status?: "IN_PROGRESS" | "SUCCESS" | "FAILED" | "CANCELED"
3891
4127
  download_file?: {
@@ -3922,6 +4158,7 @@ type BlueprintInstallationJob = {
3922
4158
  user_id?: string
3923
4159
  token_id?: string
3924
4160
  }
4161
+ job_type?: "install"
3925
4162
  source_blueprint_id?: string
3926
4163
  source_blueprint_type?: "custom" | "file" | "marketplace" | "deploy" | "app"
3927
4164
  source_org_id?: string
@@ -3943,6 +4180,57 @@ type BlueprintInstallationJob = {
3943
4180
  }
3944
4181
  ```
3945
4182
 
4183
+ ### `BlueprintRestoreJob`
4184
+
4185
+ ```ts
4186
+ type BlueprintRestoreJob = {
4187
+ id?: string
4188
+ events?: Array<{
4189
+ timestamp?: string // date-time
4190
+ message?: string
4191
+ errors?: Array<{
4192
+ error?: { ... }
4193
+ code?: { ... }
4194
+ data?: { ... }
4195
+ }>
4196
+ level?: "info" | "warning" | "error"
4197
+ data?: {
4198
+ installed_blueprint_id?: { ... }
4199
+ export_job_id?: { ... }
4200
+ resources?: { ... }
4201
+ }
4202
+ }>
4203
+ triggered_at?: string // date-time
4204
+ created_by?: {
4205
+ name?: unknown
4206
+ org_id: string
4207
+ user_id?: string
4208
+ token_id?: string
4209
+ }
4210
+ job_type?: "restore"
4211
+ destination_blueprint_id?: string
4212
+ destination_org_id?: string
4213
+ install_job_id?: string
4214
+ snapshot_id?: string
4215
+ sync_engine?: "v3"
4216
+ status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED"
4217
+ restore_result?: {
4218
+ snapshot_id?: string
4219
+ resources?: Array<{
4220
+ lineage_id: { ... }
4221
+ type: { ... }
4222
+ name?: { ... }
4223
+ target_id?: { ... }
4224
+ action: { ... }
4225
+ reason?: { ... }
4226
+ last_synced_at?: { ... }
4227
+ current_updated_at?: { ... }
4228
+ error_message?: { ... }
4229
+ }>
4230
+ }
4231
+ }
4232
+ ```
4233
+
3946
4234
  ### `V3ResourceProgressEntry`
3947
4235
 
3948
4236
  ```ts
@@ -3957,6 +4245,41 @@ type V3ResourceProgressEntry = {
3957
4245
  }
3958
4246
  ```
3959
4247
 
4248
+ ### `RestoreOutcomeItem`
4249
+
4250
+ ```ts
4251
+ type RestoreOutcomeItem = {
4252
+ lineage_id: string
4253
+ type: string
4254
+ name?: string
4255
+ target_id?: string
4256
+ action: "restore" | "delete" | "skip" | "failed"
4257
+ reason?: "modified" | "co_owned" | "delete_unsupported" | "heuristic_match"
4258
+ last_synced_at?: string // date-time
4259
+ current_updated_at?: string // date-time
4260
+ error_message?: string
4261
+ }
4262
+ ```
4263
+
4264
+ ### `RestoreOutcome`
4265
+
4266
+ ```ts
4267
+ type RestoreOutcome = {
4268
+ snapshot_id?: string
4269
+ resources?: Array<{
4270
+ lineage_id: string
4271
+ type: string
4272
+ name?: string
4273
+ target_id?: string
4274
+ action: "restore" | "delete" | "skip" | "failed"
4275
+ reason?: "modified" | "co_owned" | "delete_unsupported" | "heuristic_match"
4276
+ last_synced_at?: string // date-time
4277
+ current_updated_at?: string // date-time
4278
+ error_message?: string
4279
+ }>
4280
+ }
4281
+ ```
4282
+
3960
4283
  ### `BlueprintJob`
3961
4284
 
3962
4285
  ```ts
@@ -3984,6 +4307,7 @@ type BlueprintJob = {
3984
4307
  user_id?: string
3985
4308
  token_id?: string
3986
4309
  }
4310
+ job_type?: "export"
3987
4311
  blueprint_id?: string
3988
4312
  status?: "IN_PROGRESS" | "SUCCESS" | "FAILED" | "CANCELED"
3989
4313
  download_file?: {
@@ -4014,6 +4338,7 @@ type BlueprintJob = {
4014
4338
  user_id?: string
4015
4339
  token_id?: string
4016
4340
  }
4341
+ job_type?: "install"
4017
4342
  source_blueprint_id?: string
4018
4343
  source_blueprint_type?: "custom" | "file" | "marketplace" | "deploy" | "app"
4019
4344
  source_org_id?: string
@@ -4056,10 +4381,8 @@ type BlueprintJob = {
4056
4381
  user_id?: string
4057
4382
  token_id?: string
4058
4383
  }
4059
- blueprint_id?: string
4060
- status?: "IN_PROGRESS" | "SUCCESS" | "FAILED" | "CANCELED"
4061
- } | {
4062
- id?: string
4384
+ job_type?: "restore"
4385
+ destination_blueprint_id?: string
4063
4386
  // ...
4064
4387
  }
4065
4388
  ```
@@ -4091,6 +4414,7 @@ type BlueprintDependenciesSyncJob = {
4091
4414
  user_id?: string
4092
4415
  token_id?: string
4093
4416
  }
4417
+ job_type?: "dependencies_sync"
4094
4418
  blueprint_id?: string
4095
4419
  status?: "IN_PROGRESS" | "SUCCESS" | "FAILED" | "CANCELED"
4096
4420
  }
@@ -4123,6 +4447,7 @@ type BlueprintValidateJob = {
4123
4447
  user_id?: string
4124
4448
  token_id?: string
4125
4449
  }
4450
+ job_type?: "validate"
4126
4451
  blueprint_id?: string
4127
4452
  status?: "IN_PROGRESS" | "SUCCESS" | "FAILED"
4128
4453
  valid?: boolean
@@ -4168,11 +4493,12 @@ type BlueprintVerificationJob = {
4168
4493
  user_id?: string
4169
4494
  token_id?: string
4170
4495
  }
4496
+ job_type?: "verification"
4171
4497
  source_org_id?: string
4172
4498
  source_blueprint_id?: string
4173
4499
  destination_org_id?: string
4174
4500
  destination_blueprint_id?: string
4175
- status?: "IN_PROGRESS" | "SUCCESS" | "FAILED"
4501
+ status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED"
4176
4502
  summary?: {
4177
4503
  total_resources?: number
4178
4504
  matched?: number
@@ -4203,7 +4529,7 @@ type BlueprintVerificationJob = {
4203
4529
  ```ts
4204
4530
  type LatestBlueprintVerification = {
4205
4531
  job_id?: string
4206
- status?: "IN_PROGRESS" | "SUCCESS" | "FAILED"
4532
+ status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED"
4207
4533
  triggered_at?: string // date-time
4208
4534
  source_org_id?: string
4209
4535
  source_blueprint_id?: string