@epilot/sdk 2.18.1 → 2.18.3

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 (143) hide show
  1. package/definitions/blueprint-manifest-runtime.json +1 -1
  2. package/definitions/blueprint-manifest.json +219 -20
  3. package/definitions/integration-toolkit-runtime.json +1 -1
  4. package/definitions/integration-toolkit.json +89 -6
  5. package/dist/apis/access-token.cjs +6 -6
  6. package/dist/apis/access-token.js +1 -1
  7. package/dist/apis/address-suggestions.cjs +6 -6
  8. package/dist/apis/address-suggestions.js +1 -1
  9. package/dist/apis/address.cjs +6 -6
  10. package/dist/apis/address.js +1 -1
  11. package/dist/apis/ai-agents.cjs +6 -6
  12. package/dist/apis/ai-agents.js +1 -1
  13. package/dist/apis/app.cjs +6 -6
  14. package/dist/apis/app.js +1 -1
  15. package/dist/apis/audit-logs.cjs +6 -6
  16. package/dist/apis/audit-logs.js +1 -1
  17. package/dist/apis/automation.cjs +6 -6
  18. package/dist/apis/automation.js +1 -1
  19. package/dist/apis/billing.cjs +6 -6
  20. package/dist/apis/billing.js +1 -1
  21. package/dist/apis/blueprint-manifest.cjs +8 -8
  22. package/dist/apis/blueprint-manifest.d.cts +2 -2
  23. package/dist/apis/blueprint-manifest.d.ts +2 -2
  24. package/dist/apis/blueprint-manifest.js +2 -2
  25. package/dist/apis/calendar.cjs +6 -6
  26. package/dist/apis/calendar.js +1 -1
  27. package/dist/apis/configuration-hub.cjs +6 -6
  28. package/dist/apis/configuration-hub.js +1 -1
  29. package/dist/apis/consent.cjs +6 -6
  30. package/dist/apis/consent.js +1 -1
  31. package/dist/apis/customer-portal.cjs +6 -6
  32. package/dist/apis/customer-portal.js +1 -1
  33. package/dist/apis/dashboard.cjs +6 -6
  34. package/dist/apis/dashboard.js +1 -1
  35. package/dist/apis/data-governance.cjs +6 -6
  36. package/dist/apis/data-governance.js +1 -1
  37. package/dist/apis/deduplication.cjs +6 -6
  38. package/dist/apis/deduplication.js +1 -1
  39. package/dist/apis/design.cjs +6 -6
  40. package/dist/apis/design.js +1 -1
  41. package/dist/apis/document.cjs +6 -6
  42. package/dist/apis/document.js +1 -1
  43. package/dist/apis/email-settings.cjs +6 -6
  44. package/dist/apis/email-settings.js +1 -1
  45. package/dist/apis/email-template.cjs +6 -6
  46. package/dist/apis/email-template.js +1 -1
  47. package/dist/apis/entity-mapping.cjs +6 -6
  48. package/dist/apis/entity-mapping.js +1 -1
  49. package/dist/apis/entity.cjs +6 -6
  50. package/dist/apis/entity.js +1 -1
  51. package/dist/apis/environments.cjs +6 -6
  52. package/dist/apis/environments.js +1 -1
  53. package/dist/apis/event-catalog.cjs +6 -6
  54. package/dist/apis/event-catalog.js +1 -1
  55. package/dist/apis/file.cjs +6 -6
  56. package/dist/apis/file.js +1 -1
  57. package/dist/apis/iban.cjs +6 -6
  58. package/dist/apis/iban.js +1 -1
  59. package/dist/apis/integration-toolkit.cjs +8 -8
  60. package/dist/apis/integration-toolkit.d.cts +2 -2
  61. package/dist/apis/integration-toolkit.d.ts +2 -2
  62. package/dist/apis/integration-toolkit.js +2 -2
  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 +6 -6
  94. package/dist/apis/snapshot.js +1 -1
  95. package/dist/apis/submission.cjs +6 -6
  96. package/dist/apis/submission.js +1 -1
  97. package/dist/apis/target.cjs +6 -6
  98. package/dist/apis/target.js +1 -1
  99. package/dist/apis/targeting.cjs +6 -6
  100. package/dist/apis/targeting.js +1 -1
  101. package/dist/apis/template-variables.cjs +6 -6
  102. package/dist/apis/template-variables.js +1 -1
  103. package/dist/apis/user.cjs +6 -6
  104. package/dist/apis/user.js +1 -1
  105. package/dist/apis/validation-rules.cjs +6 -6
  106. package/dist/apis/validation-rules.js +1 -1
  107. package/dist/apis/webhooks.cjs +6 -6
  108. package/dist/apis/webhooks.js +1 -1
  109. package/dist/apis/workflow-definition.cjs +6 -6
  110. package/dist/apis/workflow-definition.js +1 -1
  111. package/dist/apis/workflow.cjs +6 -6
  112. package/dist/apis/workflow.js +1 -1
  113. package/dist/blueprint-manifest-4DD7CUPX.cjs +7 -0
  114. package/dist/blueprint-manifest-IP2AU3F3.js +7 -0
  115. package/dist/{blueprint-manifest-runtime-6MEPQQC5.cjs → blueprint-manifest-runtime-N5EXZB2K.cjs} +2 -2
  116. package/dist/{blueprint-manifest-runtime-SAWWJW2G.js → blueprint-manifest-runtime-W526ROPG.js} +1 -1
  117. package/dist/{blueprint-manifest.d-BiaeSTI3.d.cts → blueprint-manifest.d-CjsI-JqR.d.cts} +400 -62
  118. package/dist/{blueprint-manifest.d-BiaeSTI3.d.ts → blueprint-manifest.d-CjsI-JqR.d.ts} +400 -62
  119. package/dist/chunk-4Z6GRBDK.js +14 -0
  120. package/dist/{chunk-RJHXXGJ3.js → chunk-5OOGTDF2.js} +1 -1
  121. package/dist/{chunk-NCGUD7SQ.cjs → chunk-5RAQKW2K.cjs} +4 -4
  122. package/dist/{chunk-FDNLFLZ5.js → chunk-6XCKLP3T.js} +4 -4
  123. package/dist/{chunk-QXKCYTF3.cjs → chunk-RXFXAZK3.cjs} +1 -1
  124. package/dist/chunk-Z54CI2VS.cjs +14 -0
  125. package/dist/index.cjs +12 -12
  126. package/dist/index.d.cts +2 -2
  127. package/dist/index.d.ts +2 -2
  128. package/dist/index.js +3 -3
  129. package/dist/integration-toolkit-63NIMAHB.js +7 -0
  130. package/dist/integration-toolkit-7NCK7Z5G.cjs +7 -0
  131. package/dist/{integration-toolkit-runtime-VUOXZ6HU.js → integration-toolkit-runtime-2MBB4EOE.js} +1 -1
  132. package/dist/{integration-toolkit-runtime-PI5G3OXL.cjs → integration-toolkit-runtime-VUI4NCRJ.cjs} +2 -2
  133. package/dist/{integration-toolkit.d-D5HZSNUf.d.cts → integration-toolkit.d-E2nrIdIM.d.cts} +43 -6
  134. package/dist/{integration-toolkit.d-D5HZSNUf.d.ts → integration-toolkit.d-E2nrIdIM.d.ts} +43 -6
  135. package/docs/blueprint-manifest.md +258 -95
  136. package/docs/integration-toolkit.md +79 -12
  137. package/package.json +1 -1
  138. package/dist/blueprint-manifest-GU75577F.js +0 -7
  139. package/dist/blueprint-manifest-KTUWFTDX.cjs +0 -7
  140. package/dist/chunk-EZU3MFGV.cjs +0 -14
  141. package/dist/chunk-FUHSA3BV.js +0 -14
  142. package/dist/integration-toolkit-XGP4BIWX.js +0 -7
  143. package/dist/integration-toolkit-ZVBMKUWM.cjs +0 -7
@@ -37,6 +37,7 @@ const { data } = await blueprintManifestClient.getJob(...)
37
37
  - [`updateBlueprint`](#updateblueprint)
38
38
  - [`deleteBlueprint`](#deleteblueprint)
39
39
  - [`addBlueprintNote`](#addblueprintnote)
40
+ - [`updateBlueprintNote`](#updateblueprintnote)
40
41
  - [`deleteBlueprintNote`](#deleteblueprintnote)
41
42
  - [`verifyBlueprint`](#verifyblueprint)
42
43
  - [`listMarketplaceSlugs`](#listmarketplaceslugs)
@@ -105,6 +106,7 @@ const { data } = await blueprintManifestClient.getJob(...)
105
106
  - [`CommonBlueprintFields`](#commonblueprintfields)
106
107
  - [`SuggestBlueprintResourcesRequest`](#suggestblueprintresourcesrequest)
107
108
  - [`SuggestBlueprintResourcesResponse`](#suggestblueprintresourcesresponse)
109
+ - [`SkippedBlueprintResource`](#skippedblueprintresource)
108
110
  - [`BlueprintResource`](#blueprintresource)
109
111
  - [`BlueprintPreview`](#blueprintpreview)
110
112
  - [`CustomBlueprint`](#customblueprint)
@@ -285,6 +287,7 @@ const { data } = await client.createBlueprint(
285
287
  id: '3f1c9b0e-2f3a-4a1f-9a3e-6f2b8c7d1e40',
286
288
  text: 'Adjusted the meter-reading journey for the §14a rollout.',
287
289
  created_at: '1970-01-01T00:00:00.000Z',
290
+ updated_at: '1970-01-01T00:00:00.000Z',
288
291
  created_by: { /* ... */ }
289
292
  }
290
293
  ],
@@ -297,6 +300,7 @@ const { data } = await client.createBlueprint(
297
300
  destination_blueprint_id: 'string',
298
301
  job_id: 'string',
299
302
  triggered_at: '1970-01-01T00:00:00.000Z',
303
+ performed_by: { /* ... */ },
300
304
  note: 'string',
301
305
  status: 'IN_PROGRESS',
302
306
  restore_details: { /* ... */ },
@@ -389,6 +393,7 @@ const { data } = await client.createBlueprint(
389
393
  "id": "3f1c9b0e-2f3a-4a1f-9a3e-6f2b8c7d1e40",
390
394
  "text": "Adjusted the meter-reading journey for the §14a rollout.",
391
395
  "created_at": "1970-01-01T00:00:00.000Z",
396
+ "updated_at": "1970-01-01T00:00:00.000Z",
392
397
  "created_by": {}
393
398
  }
394
399
  ],
@@ -401,6 +406,7 @@ const { data } = await client.createBlueprint(
401
406
  "destination_blueprint_id": "string",
402
407
  "job_id": "string",
403
408
  "triggered_at": "1970-01-01T00:00:00.000Z",
409
+ "performed_by": {},
404
410
  "note": "string",
405
411
  "status": "IN_PROGRESS",
406
412
  "restore_details": {},
@@ -529,7 +535,7 @@ const { data } = await client.listInstalledMarketplaceBlueprints()
529
535
 
530
536
  ### `preInstallBlueprint`
531
537
 
532
- Pre-install a Blueprint based on a blueprint file
538
+ Pre-install a Blueprint based on a blueprint file. Format-agnostic: the engine is detected from the uploaded archive, so this endpoint accepts both Terraform exports and signed V3 packages. The return
533
539
 
534
540
  `POST /v2/blueprint-manifest/blueprints:pre-install`
535
541
 
@@ -558,6 +564,7 @@ const { data } = await client.preInstallBlueprint(
558
564
  "version": "string",
559
565
  "slug": "string",
560
566
  "source_type": "marketplace",
567
+ "sync_engine": "terraform",
561
568
  "blueprint_file_s3_key": "string",
562
569
  "is_verified": true,
563
570
  "docs_url": "string",
@@ -624,6 +631,7 @@ const { data } = await client.getBlueprintPreview({
624
631
  "version": "string",
625
632
  "slug": "string",
626
633
  "source_type": "marketplace",
634
+ "sync_engine": "terraform",
627
635
  "blueprint_file_s3_key": "string",
628
636
  "is_verified": true,
629
637
  "docs_url": "string",
@@ -693,6 +701,7 @@ const { data } = await client.getBlueprint({
693
701
  "id": "3f1c9b0e-2f3a-4a1f-9a3e-6f2b8c7d1e40",
694
702
  "text": "Adjusted the meter-reading journey for the §14a rollout.",
695
703
  "created_at": "1970-01-01T00:00:00.000Z",
704
+ "updated_at": "1970-01-01T00:00:00.000Z",
696
705
  "created_by": {}
697
706
  }
698
707
  ],
@@ -705,6 +714,7 @@ const { data } = await client.getBlueprint({
705
714
  "destination_blueprint_id": "string",
706
715
  "job_id": "string",
707
716
  "triggered_at": "1970-01-01T00:00:00.000Z",
717
+ "performed_by": {},
708
718
  "note": "string",
709
719
  "status": "IN_PROGRESS",
710
720
  "restore_details": {},
@@ -809,6 +819,7 @@ const { data } = await client.updateBlueprint(
809
819
  id: '3f1c9b0e-2f3a-4a1f-9a3e-6f2b8c7d1e40',
810
820
  text: 'Adjusted the meter-reading journey for the §14a rollout.',
811
821
  created_at: '1970-01-01T00:00:00.000Z',
822
+ updated_at: '1970-01-01T00:00:00.000Z',
812
823
  created_by: { /* ... */ }
813
824
  }
814
825
  ],
@@ -821,6 +832,7 @@ const { data } = await client.updateBlueprint(
821
832
  destination_blueprint_id: 'string',
822
833
  job_id: 'string',
823
834
  triggered_at: '1970-01-01T00:00:00.000Z',
835
+ performed_by: { /* ... */ },
824
836
  note: 'string',
825
837
  status: 'IN_PROGRESS',
826
838
  restore_details: { /* ... */ },
@@ -913,6 +925,7 @@ const { data } = await client.updateBlueprint(
913
925
  "id": "3f1c9b0e-2f3a-4a1f-9a3e-6f2b8c7d1e40",
914
926
  "text": "Adjusted the meter-reading journey for the §14a rollout.",
915
927
  "created_at": "1970-01-01T00:00:00.000Z",
928
+ "updated_at": "1970-01-01T00:00:00.000Z",
916
929
  "created_by": {}
917
930
  }
918
931
  ],
@@ -925,6 +938,7 @@ const { data } = await client.updateBlueprint(
925
938
  "destination_blueprint_id": "string",
926
939
  "job_id": "string",
927
940
  "triggered_at": "1970-01-01T00:00:00.000Z",
941
+ "performed_by": {},
928
942
  "note": "string",
929
943
  "status": "IN_PROGRESS",
930
944
  "restore_details": {},
@@ -1032,6 +1046,7 @@ const { data } = await client.deleteBlueprint({
1032
1046
  "id": "3f1c9b0e-2f3a-4a1f-9a3e-6f2b8c7d1e40",
1033
1047
  "text": "Adjusted the meter-reading journey for the §14a rollout.",
1034
1048
  "created_at": "1970-01-01T00:00:00.000Z",
1049
+ "updated_at": "1970-01-01T00:00:00.000Z",
1035
1050
  "created_by": {}
1036
1051
  }
1037
1052
  ],
@@ -1044,6 +1059,7 @@ const { data } = await client.deleteBlueprint({
1044
1059
  "destination_blueprint_id": "string",
1045
1060
  "job_id": "string",
1046
1061
  "triggered_at": "1970-01-01T00:00:00.000Z",
1062
+ "performed_by": {},
1047
1063
  "note": "string",
1048
1064
  "status": "IN_PROGRESS",
1049
1065
  "restore_details": {},
@@ -1149,6 +1165,49 @@ const { data } = await client.addBlueprintNote(
1149
1165
  "id": "3f1c9b0e-2f3a-4a1f-9a3e-6f2b8c7d1e40",
1150
1166
  "text": "Adjusted the meter-reading journey for the §14a rollout.",
1151
1167
  "created_at": "1970-01-01T00:00:00.000Z",
1168
+ "updated_at": "1970-01-01T00:00:00.000Z",
1169
+ "created_by": {
1170
+ "name": "manifest@epilot.cloud",
1171
+ "org_id": "911690",
1172
+ "user_id": "11001045",
1173
+ "token_id": "api_5ZugdRXasLfWBypHi93Fk"
1174
+ }
1175
+ }
1176
+ ```
1177
+
1178
+ </details>
1179
+
1180
+ ---
1181
+
1182
+ ### `updateBlueprintNote`
1183
+
1184
+ Rewrite the text of an existing internal note. The note keeps its position in
1185
+ the list along with `created_at` and `created_by`, so an edit cannot reassign
1186
+ authorship; `updated_at` is stamped server-s
1187
+
1188
+ `PATCH /v2/blueprint-manifest/blueprints/{blueprint_id}/notes/{note_id}`
1189
+
1190
+ ```ts
1191
+ const { data } = await client.updateBlueprintNote(
1192
+ {
1193
+ blueprint_id: 'example',
1194
+ note_id: 'example',
1195
+ },
1196
+ {
1197
+ text: 'string'
1198
+ },
1199
+ )
1200
+ ```
1201
+
1202
+ <details>
1203
+ <summary>Response</summary>
1204
+
1205
+ ```json
1206
+ {
1207
+ "id": "3f1c9b0e-2f3a-4a1f-9a3e-6f2b8c7d1e40",
1208
+ "text": "Adjusted the meter-reading journey for the §14a rollout.",
1209
+ "created_at": "1970-01-01T00:00:00.000Z",
1210
+ "updated_at": "1970-01-01T00:00:00.000Z",
1152
1211
  "created_by": {
1153
1212
  "name": "manifest@epilot.cloud",
1154
1213
  "org_id": "911690",
@@ -1185,6 +1244,7 @@ const { data } = await client.deleteBlueprintNote({
1185
1244
  "id": "3f1c9b0e-2f3a-4a1f-9a3e-6f2b8c7d1e40",
1186
1245
  "text": "Adjusted the meter-reading journey for the §14a rollout.",
1187
1246
  "created_at": "1970-01-01T00:00:00.000Z",
1247
+ "updated_at": "1970-01-01T00:00:00.000Z",
1188
1248
  "created_by": {
1189
1249
  "name": "manifest@epilot.cloud",
1190
1250
  "org_id": "911690",
@@ -1409,7 +1469,34 @@ const { data } = await client.addBlueprintResource(
1409
1469
  "impact_on_install": ["create"],
1410
1470
  "impact_on_install_reason": ["string"]
1411
1471
  }
1412
- ]
1472
+ ],
1473
+ "skipped": [
1474
+ {
1475
+ "id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
1476
+ "type": "designbuilder",
1477
+ "reason": "not_found"
1478
+ }
1479
+ ],
1480
+ "errors": [
1481
+ {
1482
+ "error": "string",
1483
+ "code": "dependency_extraction",
1484
+ "data": {
1485
+ "formattedResource": {
1486
+ "id": "string",
1487
+ "name": "string",
1488
+ "type": "string"
1489
+ },
1490
+ "resource": "string",
1491
+ "resourceDependency": "string",
1492
+ "resources": ["string"],
1493
+ "addresses": ["string"],
1494
+ "originalError": "string"
1495
+ }
1496
+ }
1497
+ ],
1498
+ "total_errors": 0,
1499
+ "errors_truncated": true
1413
1500
  }
1414
1501
  ```
1415
1502
 
@@ -1485,7 +1572,34 @@ const { data } = await client.bulkAddBlueprintResources(
1485
1572
  "impact_on_install": ["create"],
1486
1573
  "impact_on_install_reason": ["string"]
1487
1574
  }
1488
- ]
1575
+ ],
1576
+ "skipped": [
1577
+ {
1578
+ "id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
1579
+ "type": "designbuilder",
1580
+ "reason": "not_found"
1581
+ }
1582
+ ],
1583
+ "errors": [
1584
+ {
1585
+ "error": "string",
1586
+ "code": "dependency_extraction",
1587
+ "data": {
1588
+ "formattedResource": {
1589
+ "id": "string",
1590
+ "name": "string",
1591
+ "type": "string"
1592
+ },
1593
+ "resource": "string",
1594
+ "resourceDependency": "string",
1595
+ "resources": ["string"],
1596
+ "addresses": ["string"],
1597
+ "originalError": "string"
1598
+ }
1599
+ }
1600
+ ],
1601
+ "total_errors": 0,
1602
+ "errors_truncated": true
1489
1603
  }
1490
1604
  ```
1491
1605
 
@@ -1700,7 +1814,7 @@ const { data } = await client.deleteBlueprintResource({
1700
1814
 
1701
1815
  ### `listBlueprintJobs`
1702
1816
 
1703
- List Blueprint Jobs
1817
+ List all blueprint jobs
1704
1818
 
1705
1819
  `GET /v2/blueprint-manifest/jobs`
1706
1820
 
@@ -1772,7 +1886,9 @@ const { data } = await client.listBlueprintJobs()
1772
1886
 
1773
1887
  ### `getBlueprintJob`
1774
1888
 
1775
- Get Job
1889
+ Poll the current state of a job. Serves both Terraform (v2) and V3-engine jobs —
1890
+ check `sync_engine` (`terraform` | `v3`) to tell them apart. V3 jobs additionally
1891
+ expose live `resource_progress[]`. V3
1776
1892
 
1777
1893
  `GET /v2/blueprint-manifest/jobs/{job_id}`
1778
1894
 
@@ -1841,7 +1957,9 @@ const { data } = await client.getBlueprintJob({
1841
1957
 
1842
1958
  ### `continueInstallationJob`
1843
1959
 
1844
- Continue Installation Job
1960
+ Resume an installation job that is paused at `status: "WAITING_USER_ACTION"` after
1961
+ planning. Works for both Terraform and V3 jobs. Not needed for V3 installs created
1962
+ with `auto_apply: true` (including
1845
1963
 
1846
1964
  `POST /v2/blueprint-manifest/jobs/{job_id}:continue`
1847
1965
 
@@ -1930,7 +2048,7 @@ const { data } = await client.continueInstallationJob(
1930
2048
 
1931
2049
  ### `cancelBlueprintJob`
1932
2050
 
1933
- Cancel Blueprint Job
2051
+ Cancel a blueprint job if it is still running.
1934
2052
 
1935
2053
  `POST /v2/blueprint-manifest/jobs/{job_id}:cancel`
1936
2054
 
@@ -2577,21 +2695,26 @@ const { data } = await client.publishMarketplaceListingVersion(
2577
2695
 
2578
2696
  ### `publishBlueprintV3`
2579
2697
 
2580
- Publish Blueprint V3
2698
+ Starts an asynchronous V3 publication. The result is a signed, portable package; poll the existing blueprint job endpoint for completion.
2581
2699
 
2582
2700
  `POST /v3/blueprint-manifest/blueprints/{blueprint_id}:publish`
2583
2701
 
2584
2702
  ```ts
2585
- const { data } = await client.publishBlueprintV3({
2586
- blueprint_id: 'example',
2587
- })
2703
+ const { data } = await client.publishBlueprintV3(
2704
+ {
2705
+ blueprint_id: 'example',
2706
+ },
2707
+ {
2708
+ publish_to_marketplace: false
2709
+ },
2710
+ )
2588
2711
  ```
2589
2712
 
2590
2713
  ---
2591
2714
 
2592
2715
  ### `preInstallBlueprintV3`
2593
2716
 
2594
- Preview a V3 blueprint package before installation
2717
+ Validates a signed V3 package and returns the destination-specific resource plan used by the install UI.
2595
2718
 
2596
2719
  `POST /v3/blueprint-manifest/blueprints:pre-install`
2597
2720
 
@@ -2620,6 +2743,7 @@ const { data } = await client.preInstallBlueprintV3(
2620
2743
  "version": "string",
2621
2744
  "slug": "string",
2622
2745
  "source_type": "marketplace",
2746
+ "sync_engine": "terraform",
2623
2747
  "blueprint_file_s3_key": "string",
2624
2748
  "is_verified": true,
2625
2749
  "docs_url": "string",
@@ -2662,7 +2786,9 @@ const { data } = await client.preInstallBlueprintV3(
2662
2786
 
2663
2787
  ### `installBlueprintV3`
2664
2788
 
2665
- Install Blueprint V3
2789
+ Install a blueprint into a single destination org using the V3 engine (direct API
2790
+ calls, no Terraform). Creates resources in topological order with global ID
2791
+ replacement and supports checkpoint-based
2666
2792
 
2667
2793
  `POST /v3/blueprint-manifest/blueprint:install`
2668
2794
 
@@ -2677,7 +2803,7 @@ const { data } = await client.installBlueprintV3(
2677
2803
 
2678
2804
  ### `restoreBlueprintDeploymentV3`
2679
2805
 
2680
- Restore a specific deployment by job_id
2806
+ Roll a deployment back to its pre-install state. Two phases:
2681
2807
 
2682
2808
  `POST /v3/blueprint-manifest/blueprints/{blueprint_id}/deployments/{job_id}:restore`
2683
2809
 
@@ -2692,7 +2818,9 @@ const { data } = await client.restoreBlueprintDeploymentV3({
2692
2818
 
2693
2819
  ### `getRestorePreview`
2694
2820
 
2695
- Predicted outcome of reverting a deployment
2821
+ Computes what would happen if the user triggered a restore on this
2822
+ deployment, without performing any writes. The forecast uses the
2823
+ snapshot's captured resources (when present) plus the current lineag
2696
2824
 
2697
2825
  `GET /v3/blueprint-manifest/blueprints/{blueprint_id}/deployments/{job_id}/restore-preview`
2698
2826
 
@@ -2739,7 +2867,9 @@ const { data } = await client.getRestorePreview({
2739
2867
 
2740
2868
  ### `triggerDeploymentHealthCheckV3`
2741
2869
 
2742
- Run a health check on a deployment
2870
+ Starts a read-only health scan of the resources this deployment's
2871
+ blueprint instance tracks in the destination org (see
2872
+ docs/rfcs/RFC-org-health-check.md, Phase 0). Checks:
2743
2873
 
2744
2874
  `POST /v3/blueprint-manifest/blueprints/{blueprint_id}/deployments/{job_id}:health-check`
2745
2875
 
@@ -2760,7 +2890,8 @@ const { data } = await client.triggerDeploymentHealthCheckV3(
2760
2890
 
2761
2891
  ### `getDeploymentHealthReportV3`
2762
2892
 
2763
- Get the latest health report of a deployment
2893
+ Returns the most recent health report produced for this deployment
2894
+ by the `:health-check` endpoint. Idempotent and side-effect free.
2764
2895
 
2765
2896
  `GET /v3/blueprint-manifest/blueprints/{blueprint_id}/deployments/{job_id}/health-report`
2766
2897
 
@@ -2848,7 +2979,8 @@ const { data } = await client.getDeploymentHealthReportV3({
2848
2979
 
2849
2980
  ### `getBlueprintLineageV3`
2850
2981
 
2851
- Get Blueprint Lineage V3
2982
+ Returns the lineage registry entries for a blueprint's resources in the current org.
2983
+ Shows the mapping between source lineage IDs and target resource IDs.
2852
2984
 
2853
2985
  `GET /v3/blueprint-manifest/blueprints/{blueprint_id}/lineage`
2854
2986
 
@@ -2883,7 +3015,9 @@ const { data } = await client.getBlueprintLineageV3({
2883
3015
 
2884
3016
  ### `createBulkInstallV3`
2885
3017
 
2886
- Create Bulk Install V3
3018
+ Install one source blueprint into many destination organizations in a single
3019
+ request. The server schedules child V3 installs with `auto_apply=true` and caps
3020
+ active installs at `max_concurrency`. Per-t
2887
3021
 
2888
3022
  `POST /v3/blueprint-manifest/bulk-installs`
2889
3023
 
@@ -2914,7 +3048,9 @@ const { data } = await client.createBulkInstallV3(
2914
3048
 
2915
3049
  ### `getBulkInstallV3`
2916
3050
 
2917
- Get Bulk Install V3
3051
+ Returns the bulk install parent with aggregate status and counts. Scoped by the
3052
+ caller org as `source_org_id`. Target rows are not included — use the targets
3053
+ endpoint to page through them.
2918
3054
 
2919
3055
  `GET /v3/blueprint-manifest/bulk-installs/{bulk_job_id}`
2920
3056
 
@@ -2958,7 +3094,9 @@ const { data } = await client.getBulkInstallV3({
2958
3094
 
2959
3095
  ### `listBulkInstallTargetsV3`
2960
3096
 
2961
- List Bulk Install Targets V3
3097
+ Pages through the bulk install's target rows. Each row hydrates its latest child
3098
+ install job (`job_ids.at(-1)`) with the standard V3 job shape (`events[]`,
3099
+ `resource_progress[]`) so callers can inspec
2962
3100
 
2963
3101
  `GET /v3/blueprint-manifest/bulk-installs/{bulk_job_id}/targets`
2964
3102
 
@@ -3057,7 +3195,9 @@ const { data } = await client.listBulkInstallTargetsV3({
3057
3195
 
3058
3196
  ### `retryBulkInstallTargetV3`
3059
3197
 
3060
- Retry Bulk Install Target V3
3198
+ Retries a single failed target. Allowed only for `FAILED` and `PARTIAL_SUCCESS`
3199
+ targets. Starts a new child install with `auto_apply=true`, appends its job id to
3200
+ `job_ids`, and reuses the same target
3061
3201
 
3062
3202
  `POST /v3/blueprint-manifest/bulk-installs/{bulk_job_id}/targets/{destination_org_id}:retry`
3063
3203
 
@@ -3300,7 +3440,7 @@ type UniquenessCriteria = {
3300
3440
  type LineageEntry = {
3301
3441
  lineage_id?: string
3302
3442
  target_id?: string
3303
- resource_type?: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
3443
+ resource_type?: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "insight" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
3304
3444
  blueprint_instance_ids?: string[]
3305
3445
  fidelity?: "full" | "partial"
3306
3446
  last_synced_at?: string // date-time
@@ -3464,6 +3604,7 @@ type BlueprintNote = {
3464
3604
  id: string
3465
3605
  text: string
3466
3606
  created_at: string // date-time
3607
+ updated_at?: string // date-time
3467
3608
  created_by?: {
3468
3609
  name?: unknown
3469
3610
  org_id: string
@@ -3504,6 +3645,7 @@ type CommonBlueprintFields = {
3504
3645
  id: string
3505
3646
  text: string
3506
3647
  created_at: string // date-time
3648
+ updated_at?: string // date-time
3507
3649
  created_by?: {
3508
3650
  name?: { ... }
3509
3651
  org_id: { ... }
@@ -3519,6 +3661,12 @@ type CommonBlueprintFields = {
3519
3661
  destination_blueprint_id?: string
3520
3662
  job_id?: string
3521
3663
  triggered_at?: string // date-time
3664
+ performed_by?: {
3665
+ name?: { ... }
3666
+ org_id: { ... }
3667
+ user_id?: { ... }
3668
+ token_id?: { ... }
3669
+ }
3522
3670
  note?: string
3523
3671
  status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED"
3524
3672
  restore_details?: {
@@ -3597,13 +3745,13 @@ type SuggestBlueprintResourcesResponse = {
3597
3745
  resources: Array<{
3598
3746
  id: string
3599
3747
  name?: string
3600
- type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
3748
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "insight" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
3601
3749
  address?: string
3602
3750
  is_root?: boolean
3603
3751
  is_ready?: boolean
3604
3752
  is_hidden?: boolean
3605
3753
  is_disabled?: boolean
3606
- hard_dependencies?: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"[]
3754
+ hard_dependencies?: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "insight" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"[]
3607
3755
  parent_resource_ids?: string[]
3608
3756
  depends_on_addresses?: string[]
3609
3757
  impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored" | "error"[]
@@ -3615,19 +3763,33 @@ type SuggestBlueprintResourcesResponse = {
3615
3763
  }
3616
3764
  ```
3617
3765
 
3766
+ ### `SkippedBlueprintResource`
3767
+
3768
+ A resource that was requested (or discovered as a dependency) but was not
3769
+ added to the Blueprint. Reasons are stable machine-readable codes.
3770
+
3771
+
3772
+ ```ts
3773
+ type SkippedBlueprintResource = {
3774
+ id: string
3775
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "insight" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
3776
+ reason: "not_found" | "source_validation_failed" | "enrichment_failed"
3777
+ }
3778
+ ```
3779
+
3618
3780
  ### `BlueprintResource`
3619
3781
 
3620
3782
  ```ts
3621
3783
  type BlueprintResource = {
3622
3784
  id: string
3623
3785
  name?: string
3624
- type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
3786
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "insight" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
3625
3787
  address?: string
3626
3788
  is_root?: boolean
3627
3789
  is_ready?: boolean
3628
3790
  is_hidden?: boolean
3629
3791
  is_disabled?: boolean
3630
- hard_dependencies?: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"[]
3792
+ hard_dependencies?: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "insight" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"[]
3631
3793
  parent_resource_ids?: string[]
3632
3794
  depends_on_addresses?: string[]
3633
3795
  impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored" | "error"[]
@@ -3650,6 +3812,7 @@ type BlueprintPreview = {
3650
3812
  version?: string
3651
3813
  slug?: string
3652
3814
  source_type: "marketplace" | "file"
3815
+ sync_engine?: "terraform" | "v3"
3653
3816
  blueprint_file_s3_key: string
3654
3817
  is_verified: boolean
3655
3818
  docs_url?: string
@@ -3669,13 +3832,13 @@ type BlueprintPreview = {
3669
3832
  resources: Array<{
3670
3833
  id: string
3671
3834
  name?: string
3672
- type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
3835
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "insight" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
3673
3836
  address?: string
3674
3837
  is_root?: boolean
3675
3838
  is_ready?: boolean
3676
3839
  is_hidden?: boolean
3677
3840
  is_disabled?: boolean
3678
- hard_dependencies?: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"[]
3841
+ hard_dependencies?: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "insight" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"[]
3679
3842
  parent_resource_ids?: string[]
3680
3843
  depends_on_addresses?: string[]
3681
3844
  impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored" | "error"[]
@@ -3699,6 +3862,7 @@ type CustomBlueprint = {
3699
3862
  id: string
3700
3863
  text: string
3701
3864
  created_at: string // date-time
3865
+ updated_at?: string // date-time
3702
3866
  created_by?: {
3703
3867
  name?: { ... }
3704
3868
  org_id: { ... }
@@ -3714,6 +3878,12 @@ type CustomBlueprint = {
3714
3878
  destination_blueprint_id?: string
3715
3879
  job_id?: string
3716
3880
  triggered_at?: string // date-time
3881
+ performed_by?: {
3882
+ name?: { ... }
3883
+ org_id: { ... }
3884
+ user_id?: { ... }
3885
+ token_id?: { ... }
3886
+ }
3717
3887
  note?: string
3718
3888
  status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED"
3719
3889
  restore_details?: {
@@ -3776,17 +3946,10 @@ type CustomBlueprint = {
3776
3946
  resources?: Array<{
3777
3947
  id: string
3778
3948
  name?: string
3779
- type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
3949
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "insight" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
3780
3950
  address?: string
3781
3951
  is_root?: boolean
3782
3952
  is_ready?: boolean
3783
- is_hidden?: boolean
3784
- is_disabled?: boolean
3785
- hard_dependencies?: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"[]
3786
- parent_resource_ids?: string[]
3787
- depends_on_addresses?: string[]
3788
- impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored" | "error"[]
3789
- impact_on_install_reason?: string[]
3790
3953
  // ...
3791
3954
  }
3792
3955
  ```
@@ -3806,6 +3969,7 @@ type FileBlueprint = {
3806
3969
  id: string
3807
3970
  text: string
3808
3971
  created_at: string // date-time
3972
+ updated_at?: string // date-time
3809
3973
  created_by?: {
3810
3974
  name?: { ... }
3811
3975
  org_id: { ... }
@@ -3821,6 +3985,12 @@ type FileBlueprint = {
3821
3985
  destination_blueprint_id?: string
3822
3986
  job_id?: string
3823
3987
  triggered_at?: string // date-time
3988
+ performed_by?: {
3989
+ name?: { ... }
3990
+ org_id: { ... }
3991
+ user_id?: { ... }
3992
+ token_id?: { ... }
3993
+ }
3824
3994
  note?: string
3825
3995
  status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED"
3826
3996
  restore_details?: {
@@ -3884,16 +4054,9 @@ type FileBlueprint = {
3884
4054
  resources?: Array<{
3885
4055
  id: string
3886
4056
  name?: string
3887
- type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
4057
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "insight" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
3888
4058
  address?: string
3889
4059
  is_root?: boolean
3890
- is_ready?: boolean
3891
- is_hidden?: boolean
3892
- is_disabled?: boolean
3893
- hard_dependencies?: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"[]
3894
- parent_resource_ids?: string[]
3895
- depends_on_addresses?: string[]
3896
- impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored" | "error"[]
3897
4060
  // ...
3898
4061
  }
3899
4062
  ```
@@ -3913,6 +4076,7 @@ type MarketplaceBlueprint = {
3913
4076
  id: string
3914
4077
  text: string
3915
4078
  created_at: string // date-time
4079
+ updated_at?: string // date-time
3916
4080
  created_by?: {
3917
4081
  name?: { ... }
3918
4082
  org_id: { ... }
@@ -3928,6 +4092,12 @@ type MarketplaceBlueprint = {
3928
4092
  destination_blueprint_id?: string
3929
4093
  job_id?: string
3930
4094
  triggered_at?: string // date-time
4095
+ performed_by?: {
4096
+ name?: { ... }
4097
+ org_id: { ... }
4098
+ user_id?: { ... }
4099
+ token_id?: { ... }
4100
+ }
3931
4101
  note?: string
3932
4102
  status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED"
3933
4103
  restore_details?: {
@@ -3991,16 +4161,9 @@ type MarketplaceBlueprint = {
3991
4161
  resources?: Array<{
3992
4162
  id: string
3993
4163
  name?: string
3994
- type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
4164
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "insight" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
3995
4165
  address?: string
3996
4166
  is_root?: boolean
3997
- is_ready?: boolean
3998
- is_hidden?: boolean
3999
- is_disabled?: boolean
4000
- hard_dependencies?: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"[]
4001
- parent_resource_ids?: string[]
4002
- depends_on_addresses?: string[]
4003
- impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored" | "error"[]
4004
4167
  // ...
4005
4168
  }
4006
4169
  ```
@@ -4049,6 +4212,7 @@ type DeployedBlueprint = {
4049
4212
  id: string
4050
4213
  text: string
4051
4214
  created_at: string // date-time
4215
+ updated_at?: string // date-time
4052
4216
  created_by?: {
4053
4217
  name?: { ... }
4054
4218
  org_id: { ... }
@@ -4064,6 +4228,12 @@ type DeployedBlueprint = {
4064
4228
  destination_blueprint_id?: string
4065
4229
  job_id?: string
4066
4230
  triggered_at?: string // date-time
4231
+ performed_by?: {
4232
+ name?: { ... }
4233
+ org_id: { ... }
4234
+ user_id?: { ... }
4235
+ token_id?: { ... }
4236
+ }
4067
4237
  note?: string
4068
4238
  status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED"
4069
4239
  restore_details?: {
@@ -4127,16 +4297,9 @@ type DeployedBlueprint = {
4127
4297
  resources?: Array<{
4128
4298
  id: string
4129
4299
  name?: string
4130
- type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
4300
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "insight" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
4131
4301
  address?: string
4132
4302
  is_root?: boolean
4133
- is_ready?: boolean
4134
- is_hidden?: boolean
4135
- is_disabled?: boolean
4136
- hard_dependencies?: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"[]
4137
- parent_resource_ids?: string[]
4138
- depends_on_addresses?: string[]
4139
- impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored" | "error"[]
4140
4303
  // ...
4141
4304
  }
4142
4305
  ```
@@ -4156,6 +4319,7 @@ type AppBlueprint = {
4156
4319
  id: string
4157
4320
  text: string
4158
4321
  created_at: string // date-time
4322
+ updated_at?: string // date-time
4159
4323
  created_by?: {
4160
4324
  name?: { ... }
4161
4325
  org_id: { ... }
@@ -4171,6 +4335,12 @@ type AppBlueprint = {
4171
4335
  destination_blueprint_id?: string
4172
4336
  job_id?: string
4173
4337
  triggered_at?: string // date-time
4338
+ performed_by?: {
4339
+ name?: { ... }
4340
+ org_id: { ... }
4341
+ user_id?: { ... }
4342
+ token_id?: { ... }
4343
+ }
4174
4344
  note?: string
4175
4345
  status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED"
4176
4346
  restore_details?: {
@@ -4234,16 +4404,9 @@ type AppBlueprint = {
4234
4404
  resources?: Array<{
4235
4405
  id: string
4236
4406
  name?: string
4237
- type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
4407
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "insight" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
4238
4408
  address?: string
4239
4409
  is_root?: boolean
4240
- is_ready?: boolean
4241
- is_hidden?: boolean
4242
- is_disabled?: boolean
4243
- hard_dependencies?: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"[]
4244
- parent_resource_ids?: string[]
4245
- depends_on_addresses?: string[]
4246
- impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored" | "error"[]
4247
4410
  // ...
4248
4411
  }
4249
4412
  ```
@@ -4263,6 +4426,7 @@ type Blueprint = {
4263
4426
  id: string
4264
4427
  text: string
4265
4428
  created_at: string // date-time
4429
+ updated_at?: string // date-time
4266
4430
  created_by?: {
4267
4431
  name?: { ... }
4268
4432
  org_id: { ... }
@@ -4278,6 +4442,12 @@ type Blueprint = {
4278
4442
  destination_blueprint_id?: string
4279
4443
  job_id?: string
4280
4444
  triggered_at?: string // date-time
4445
+ performed_by?: {
4446
+ name?: { ... }
4447
+ org_id: { ... }
4448
+ user_id?: { ... }
4449
+ token_id?: { ... }
4450
+ }
4281
4451
  note?: string
4282
4452
  status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED"
4283
4453
  restore_details?: {
@@ -4340,17 +4510,10 @@ type Blueprint = {
4340
4510
  resources?: Array<{
4341
4511
  id: string
4342
4512
  name?: string
4343
- type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
4513
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "insight" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
4344
4514
  address?: string
4345
4515
  is_root?: boolean
4346
4516
  is_ready?: boolean
4347
- is_hidden?: boolean
4348
- is_disabled?: boolean
4349
- hard_dependencies?: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"[]
4350
- parent_resource_ids?: string[]
4351
- depends_on_addresses?: string[]
4352
- impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored" | "error"[]
4353
- impact_on_install_reason?: string[]
4354
4517
  // ...
4355
4518
  }
4356
4519
  ```
@@ -5140,7 +5303,7 @@ type BlueprintVerificationJob = {
5140
5303
  fetch_errors?: number
5141
5304
  }
5142
5305
  resource_results?: Array<{
5143
- resource_type?: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5306
+ resource_type?: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "insight" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5144
5307
  resource_name?: string
5145
5308
  source_resource_id?: string
5146
5309
  source_resource_address?: string
@@ -5202,7 +5365,7 @@ type VerificationSummary = {
5202
5365
 
5203
5366
  ```ts
5204
5367
  type ResourceVerificationResult = {
5205
- resource_type?: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5368
+ resource_type?: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "insight" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5206
5369
  resource_name?: string
5207
5370
  source_resource_id?: string
5208
5371
  source_resource_address?: string
@@ -5461,7 +5624,7 @@ type JobStatus = "PENDING" | "STARTED" | "WAITING_USER_ACTION" | "CANCELED" | "I
5461
5624
  Type of the resource
5462
5625
 
5463
5626
  ```ts
5464
- type ResourceNodeType = "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5627
+ type ResourceNodeType = "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "insight" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5465
5628
  ```
5466
5629
 
5467
5630
  ### `PlanChanges`
@@ -5475,7 +5638,7 @@ type PlanChanges = "create" | "update" | "internal-update" | "no-op" | "delete"
5475
5638
  ```ts
5476
5639
  type CommonResourceNode = {
5477
5640
  id: string
5478
- type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5641
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "insight" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5479
5642
  name?: string
5480
5643
  source_id?: string
5481
5644
  is_virtual?: boolean
@@ -5487,14 +5650,14 @@ type CommonResourceNode = {
5487
5650
  ```ts
5488
5651
  type RootResourceNode = {
5489
5652
  id: string
5490
- type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5653
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "insight" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5491
5654
  name?: string
5492
5655
  source_id?: string
5493
5656
  is_virtual?: boolean
5494
5657
  address?: string
5495
5658
  dependencies?: Array<{
5496
5659
  id: string
5497
- type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5660
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "insight" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5498
5661
  name?: string
5499
5662
  source_id?: string
5500
5663
  is_virtual?: true
@@ -5521,13 +5684,13 @@ type RootResourceNode = {
5521
5684
  ```ts
5522
5685
  type VirtualResourceNodeGroup = {
5523
5686
  id: string
5524
- type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5687
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "insight" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5525
5688
  name?: string
5526
5689
  source_id?: string
5527
5690
  is_virtual?: true
5528
5691
  dependencies?: Array<{
5529
5692
  id: string
5530
- type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5693
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "insight" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5531
5694
  name?: string
5532
5695
  source_id?: string
5533
5696
  is_virtual?: boolean
@@ -5559,14 +5722,14 @@ type VirtualResourceNodeGroup = {
5559
5722
  ```ts
5560
5723
  type ResourceNode = {
5561
5724
  id: string
5562
- type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5725
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "insight" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5563
5726
  name?: string
5564
5727
  source_id?: string
5565
5728
  is_virtual?: boolean
5566
5729
  address?: string
5567
5730
  dependencies?: Array<{
5568
5731
  id: string
5569
- type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5732
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "insight" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5570
5733
  name?: string
5571
5734
  source_id?: string
5572
5735
  is_virtual?: boolean
@@ -5592,7 +5755,7 @@ type ResourceNode = {
5592
5755
  }>
5593
5756
  parents?: Array<{
5594
5757
  id?: string
5595
- type?: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5758
+ type?: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "insight" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5596
5759
  }>
5597
5760
  changes?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored"[]
5598
5761
  changes_reason?: string[]
@@ -5611,7 +5774,7 @@ type Job = {
5611
5774
  plan_file_content?: string
5612
5775
  resources_to_export?: Array<{
5613
5776
  id: string
5614
- type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5777
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "insight" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5615
5778
  name?: string
5616
5779
  source_id?: string
5617
5780
  is_virtual?: boolean
@@ -5628,7 +5791,7 @@ type Job = {
5628
5791
  changes_reason?: string[]
5629
5792
  }> | {
5630
5793
  id: string
5631
- type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5794
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "insight" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5632
5795
  name?: string
5633
5796
  source_id?: string
5634
5797
  is_virtual?: boolean
@@ -5647,7 +5810,7 @@ type Job = {
5647
5810
  large_resources_to_export_url?: string
5648
5811
  resources_to_import?: Array<{
5649
5812
  id: string
5650
- type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5813
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "insight" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5651
5814
  name?: string
5652
5815
  source_id?: string
5653
5816
  is_virtual?: boolean
@@ -5664,7 +5827,7 @@ type Job = {
5664
5827
  changes_reason?: string[]
5665
5828
  }> | {
5666
5829
  id: string
5667
- type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5830
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "insight" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5668
5831
  name?: string
5669
5832
  source_id?: string
5670
5833
  is_virtual?: boolean
@@ -5788,7 +5951,7 @@ type CommonImportFields = {
5788
5951
  source_type?: "file" | "marketplace" | "sandbox"
5789
5952
  imported_resources?: Array<{
5790
5953
  id: string
5791
- type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5954
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "insight" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5792
5955
  name?: string
5793
5956
  source_id?: string
5794
5957
  is_virtual?: boolean
@@ -5805,7 +5968,7 @@ type CommonImportFields = {
5805
5968
  changes_reason?: string[]
5806
5969
  }> | {
5807
5970
  id: string
5808
- type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5971
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "insight" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5809
5972
  name?: string
5810
5973
  source_id?: string
5811
5974
  is_virtual?: boolean
@@ -5905,7 +6068,7 @@ type CallerIdentity = {
5905
6068
  type SelectedResources = {
5906
6069
  exported_root_resources: Array<{
5907
6070
  id: string
5908
- type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
6071
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "insight" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission"
5909
6072
  address?: string
5910
6073
  }>
5911
6074
  selected_resources: string[]