@epilot/sdk 2.14.1 → 2.14.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.
- package/definitions/access-token.json +18 -0
- package/definitions/blueprint-manifest-runtime.json +1 -1
- package/definitions/blueprint-manifest.json +648 -11
- package/definitions/customer-portal-runtime.json +1 -1
- package/definitions/customer-portal.json +119 -0
- package/definitions/workflow-definition-runtime.json +1 -1
- package/definitions/workflow-definition.json +6 -2
- package/dist/access-token-7Y2MDFZH.cjs +7 -0
- package/dist/access-token-NWN7UBUP.js +7 -0
- package/dist/{access-token.d-CegaQmrK.d.cts → access-token.d-BhRUc8I-.d.cts} +38 -1
- package/dist/{access-token.d-CegaQmrK.d.ts → access-token.d-BhRUc8I-.d.ts} +38 -1
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.d.cts +2 -2
- package/dist/apis/access-token.d.ts +2 -2
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +8 -8
- package/dist/apis/blueprint-manifest.d.cts +2 -2
- package/dist/apis/blueprint-manifest.d.ts +2 -2
- package/dist/apis/blueprint-manifest.js +2 -2
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +8 -8
- package/dist/apis/customer-portal.d.cts +2 -2
- package/dist/apis/customer-portal.d.ts +2 -2
- package/dist/apis/customer-portal.js +2 -2
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/snapshot.cjs +6 -6
- package/dist/apis/snapshot.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +8 -8
- package/dist/apis/workflow-definition.js +2 -2
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/blueprint-manifest-IWQ2TGMV.js +7 -0
- package/dist/blueprint-manifest-YNNRSATN.cjs +7 -0
- package/dist/{blueprint-manifest-runtime-WU5MWPVT.cjs → blueprint-manifest-runtime-2PQBKBIN.cjs} +2 -2
- package/dist/{blueprint-manifest-runtime-2344IUIE.js → blueprint-manifest-runtime-JYDKG5WQ.js} +1 -1
- package/dist/{blueprint-manifest.d-2-TORV8o.d.cts → blueprint-manifest.d-D2I9nhZa.d.cts} +699 -16
- package/dist/{blueprint-manifest.d-2-TORV8o.d.ts → blueprint-manifest.d-D2I9nhZa.d.ts} +699 -16
- package/dist/{chunk-T57MT6J5.cjs → chunk-ACOAPYGP.cjs} +1 -1
- package/dist/chunk-ADX7IYB3.cjs +14 -0
- package/dist/{chunk-BFMY2X2J.cjs → chunk-DGLXRPNZ.cjs} +1 -1
- package/dist/{chunk-SNERI3PK.cjs → chunk-K5HFQSHG.cjs} +7 -7
- package/dist/chunk-LIWGP5QQ.js +14 -0
- package/dist/{chunk-OJLX6U66.js → chunk-RSW3OGJC.js} +7 -7
- package/dist/chunk-TTU24M3D.js +14 -0
- package/dist/{chunk-6HJ2Y7DZ.js → chunk-Y5YIU6PG.js} +1 -1
- package/dist/{customer-portal-PTVGKDUH.js → customer-portal-6WYH4LMT.js} +1 -1
- package/dist/{customer-portal-6I3G44I4.cjs → customer-portal-JZMXGNRO.cjs} +1 -1
- package/dist/{customer-portal-runtime-4ACQGDNY.cjs → customer-portal-runtime-H7XSAQ6G.cjs} +2 -2
- package/dist/{customer-portal-runtime-E4RI7NYM.js → customer-portal-runtime-JDDF3NWW.js} +1 -1
- package/dist/{customer-portal.d-Bpc-wk9K.d.cts → customer-portal.d-SlKyKhCa.d.cts} +197 -0
- package/dist/{customer-portal.d-Bpc-wk9K.d.ts → customer-portal.d-SlKyKhCa.d.ts} +197 -0
- package/dist/index.cjs +14 -14
- package/dist/index.d.cts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +4 -4
- package/dist/workflow-definition-MSO4JDA3.js +7 -0
- package/dist/workflow-definition-XTWO4RMY.cjs +7 -0
- package/dist/{workflow-definition-runtime-2HQS3RPK.cjs → workflow-definition-runtime-DYKGFYQE.cjs} +2 -2
- package/dist/{workflow-definition-runtime-JUPATIKU.js → workflow-definition-runtime-GYDTSAJL.js} +1 -1
- package/docs/access-token.md +21 -1
- package/docs/blueprint-manifest.md +560 -456
- package/docs/customer-portal.md +139 -0
- package/docs/workflow-definition.md +1 -0
- package/package.json +1 -1
- package/dist/access-token-GD6REL4U.js +0 -7
- package/dist/access-token-NQ5BLMOW.cjs +0 -7
- package/dist/blueprint-manifest-WHYSBU66.cjs +0 -7
- package/dist/blueprint-manifest-WZVBTKUL.js +0 -7
- package/dist/chunk-OSPTVXY4.js +0 -14
- package/dist/chunk-QNSMYDKG.cjs +0 -14
- package/dist/chunk-UWGWRGGB.js +0 -14
- package/dist/workflow-definition-5P3PDJKU.cjs +0 -7
- package/dist/workflow-definition-XSSOSEGF.js +0 -7
|
@@ -33,13 +33,10 @@ const { data } = await blueprintManifestClient.getJob(...)
|
|
|
33
33
|
- [`listInstalledMarketplaceBlueprints`](#listinstalledmarketplaceblueprints)
|
|
34
34
|
- [`preInstallBlueprint`](#preinstallblueprint)
|
|
35
35
|
- [`getBlueprintPreview`](#getblueprintpreview)
|
|
36
|
-
- [`installBlueprint`](#installblueprint)
|
|
37
36
|
- [`getBlueprint`](#getblueprint)
|
|
38
37
|
- [`updateBlueprint`](#updateblueprint)
|
|
39
38
|
- [`deleteBlueprint`](#deleteblueprint)
|
|
40
|
-
- [`validateBlueprint`](#validateblueprint)
|
|
41
39
|
- [`verifyBlueprint`](#verifyblueprint)
|
|
42
|
-
- [`exportBlueprint`](#exportblueprint)
|
|
43
40
|
- [`listMarketplaceSlugs`](#listmarketplaceslugs)
|
|
44
41
|
- [`publishBlueprint`](#publishblueprint)
|
|
45
42
|
- [`formatBlueprintDescription`](#formatblueprintdescription)
|
|
@@ -51,18 +48,15 @@ const { data } = await blueprintManifestClient.getJob(...)
|
|
|
51
48
|
- [`bulkDeleteBlueprintResources`](#bulkdeleteblueprintresources)
|
|
52
49
|
- [`updateBlueprintResource`](#updateblueprintresource)
|
|
53
50
|
- [`deleteBlueprintResource`](#deleteblueprintresource)
|
|
51
|
+
- [`publishBlueprintV3`](#publishblueprintv3)
|
|
54
52
|
- [`installBlueprintV3`](#installblueprintv3)
|
|
55
53
|
- [`restoreBlueprintDeploymentV3`](#restoreblueprintdeploymentv3)
|
|
56
54
|
- [`getRestorePreview`](#getrestorepreview)
|
|
57
55
|
- [`getBlueprintLineageV3`](#getblueprintlineagev3)
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
- [`
|
|
61
|
-
- [`
|
|
62
|
-
- [`listPatches`](#listpatches)
|
|
63
|
-
- [`getPatch`](#getpatch)
|
|
64
|
-
- [`applyPatch`](#applypatch)
|
|
65
|
-
- [`retryPatchOrg`](#retrypatchorg)
|
|
56
|
+
- [`createBulkInstallV3`](#createbulkinstallv3)
|
|
57
|
+
- [`getBulkInstallV3`](#getbulkinstallv3)
|
|
58
|
+
- [`listBulkInstallTargetsV3`](#listbulkinstalltargetsv3)
|
|
59
|
+
- [`retryBulkInstallTargetV3`](#retrybulkinstalltargetv3)
|
|
66
60
|
|
|
67
61
|
**Jobs**
|
|
68
62
|
- [`listBlueprintJobs`](#listblueprintjobs)
|
|
@@ -118,6 +112,13 @@ const { data } = await blueprintManifestClient.getJob(...)
|
|
|
118
112
|
- [`CommonBlueprintJobFields`](#commonblueprintjobfields)
|
|
119
113
|
- [`BlueprintExportJob`](#blueprintexportjob)
|
|
120
114
|
- [`BlueprintInstallationJob`](#blueprintinstallationjob)
|
|
115
|
+
- [`BulkInstallStatus`](#bulkinstallstatus)
|
|
116
|
+
- [`BulkInstallCounts`](#bulkinstallcounts)
|
|
117
|
+
- [`BulkInstall`](#bulkinstall)
|
|
118
|
+
- [`BulkInstallTarget`](#bulkinstalltarget)
|
|
119
|
+
- [`BulkInstallTargetList`](#bulkinstalltargetlist)
|
|
120
|
+
- [`BulkInstallTargetInput`](#bulkinstalltargetinput)
|
|
121
|
+
- [`BulkInstallCreateRequest`](#bulkinstallcreaterequest)
|
|
121
122
|
- [`BlueprintRestoreJob`](#blueprintrestorejob)
|
|
122
123
|
- [`V3ResourceProgressEntry`](#v3resourceprogressentry)
|
|
123
124
|
- [`RestoreOutcomeItem`](#restoreoutcomeitem)
|
|
@@ -293,6 +294,8 @@ const { data } = await client.createBlueprint(
|
|
|
293
294
|
source_blueprint_id: 'c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341',
|
|
294
295
|
destination_org_id: 'string',
|
|
295
296
|
destination_blueprint_id: 'c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341',
|
|
297
|
+
installation_job_id: 'c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341',
|
|
298
|
+
sync_engine: 'terraform',
|
|
296
299
|
summary: {
|
|
297
300
|
total_resources: 0,
|
|
298
301
|
matched: 0,
|
|
@@ -387,6 +390,8 @@ const { data } = await client.createBlueprint(
|
|
|
387
390
|
"source_blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
|
|
388
391
|
"destination_org_id": "string",
|
|
389
392
|
"destination_blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
|
|
393
|
+
"installation_job_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
|
|
394
|
+
"sync_engine": "terraform",
|
|
390
395
|
"summary": {
|
|
391
396
|
"total_resources": 0,
|
|
392
397
|
"matched": 0,
|
|
@@ -631,36 +636,6 @@ const { data } = await client.getBlueprintPreview({
|
|
|
631
636
|
|
|
632
637
|
---
|
|
633
638
|
|
|
634
|
-
### `installBlueprint`
|
|
635
|
-
|
|
636
|
-
Kick off a new blueprint installation job. Returns 202 Accepted with Location header pointing to the job resource
|
|
637
|
-
|
|
638
|
-
`POST /v2/blueprint-manifest/blueprint:install`
|
|
639
|
-
|
|
640
|
-
```ts
|
|
641
|
-
const { data } = await client.installBlueprint(
|
|
642
|
-
null,
|
|
643
|
-
{
|
|
644
|
-
source_org_id: 'string',
|
|
645
|
-
source_blueprint_id: 'c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341',
|
|
646
|
-
source_blueprint_file: 'string',
|
|
647
|
-
destination_org_id: 'string',
|
|
648
|
-
destination_blueprint_id: 'c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341',
|
|
649
|
-
source_auth_token: 'string',
|
|
650
|
-
destination_auth_token: 'string',
|
|
651
|
-
options: {
|
|
652
|
-
resources_to_ignore: ['string']
|
|
653
|
-
},
|
|
654
|
-
mode: 'simple',
|
|
655
|
-
source_blueprint_type: 'marketplace',
|
|
656
|
-
slug: 'string',
|
|
657
|
-
auto_enable_features: true
|
|
658
|
-
},
|
|
659
|
-
)
|
|
660
|
-
```
|
|
661
|
-
|
|
662
|
-
---
|
|
663
|
-
|
|
664
639
|
### `getBlueprint`
|
|
665
640
|
|
|
666
641
|
Get Blueprint by ID
|
|
@@ -711,6 +686,8 @@ const { data } = await client.getBlueprint({
|
|
|
711
686
|
"source_blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
|
|
712
687
|
"destination_org_id": "string",
|
|
713
688
|
"destination_blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
|
|
689
|
+
"installation_job_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
|
|
690
|
+
"sync_engine": "terraform",
|
|
714
691
|
"summary": {
|
|
715
692
|
"total_resources": 0,
|
|
716
693
|
"matched": 0,
|
|
@@ -817,6 +794,8 @@ const { data } = await client.updateBlueprint(
|
|
|
817
794
|
source_blueprint_id: 'c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341',
|
|
818
795
|
destination_org_id: 'string',
|
|
819
796
|
destination_blueprint_id: 'c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341',
|
|
797
|
+
installation_job_id: 'c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341',
|
|
798
|
+
sync_engine: 'terraform',
|
|
820
799
|
summary: {
|
|
821
800
|
total_resources: 0,
|
|
822
801
|
matched: 0,
|
|
@@ -911,6 +890,8 @@ const { data } = await client.updateBlueprint(
|
|
|
911
890
|
"source_blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
|
|
912
891
|
"destination_org_id": "string",
|
|
913
892
|
"destination_blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
|
|
893
|
+
"installation_job_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
|
|
894
|
+
"sync_engine": "terraform",
|
|
914
895
|
"summary": {
|
|
915
896
|
"total_resources": 0,
|
|
916
897
|
"matched": 0,
|
|
@@ -1020,6 +1001,8 @@ const { data } = await client.deleteBlueprint({
|
|
|
1020
1001
|
"source_blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
|
|
1021
1002
|
"destination_org_id": "string",
|
|
1022
1003
|
"destination_blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
|
|
1004
|
+
"installation_job_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
|
|
1005
|
+
"sync_engine": "terraform",
|
|
1023
1006
|
"summary": {
|
|
1024
1007
|
"total_resources": 0,
|
|
1025
1008
|
"matched": 0,
|
|
@@ -1079,21 +1062,6 @@ const { data } = await client.deleteBlueprint({
|
|
|
1079
1062
|
|
|
1080
1063
|
---
|
|
1081
1064
|
|
|
1082
|
-
### `validateBlueprint`
|
|
1083
|
-
|
|
1084
|
-
Start a blueprint validation job. Validates Terraform for the blueprint (all types).
|
|
1085
|
-
Returns 202 Accepted with job_id. Poll GET /jobs/{job_id} for status, valid, and errors.
|
|
1086
|
-
|
|
1087
|
-
`POST /v2/blueprint-manifest/blueprints/{blueprint_id}/validate`
|
|
1088
|
-
|
|
1089
|
-
```ts
|
|
1090
|
-
const { data } = await client.validateBlueprint({
|
|
1091
|
-
blueprint_id: 'example',
|
|
1092
|
-
})
|
|
1093
|
-
```
|
|
1094
|
-
|
|
1095
|
-
---
|
|
1096
|
-
|
|
1097
1065
|
### `verifyBlueprint`
|
|
1098
1066
|
|
|
1099
1067
|
Start a blueprint verification job. Compares resource configurations between a source org
|
|
@@ -1113,387 +1081,9 @@ const { data } = await client.verifyBlueprint(
|
|
|
1113
1081
|
destination_org_id: 'string',
|
|
1114
1082
|
destination_blueprint_id: 'c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341',
|
|
1115
1083
|
source_auth_token: 'string',
|
|
1116
|
-
destination_auth_token: 'string'
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
```
|
|
1120
|
-
|
|
1121
|
-
---
|
|
1122
|
-
|
|
1123
|
-
### `detectPatchChanges`
|
|
1124
|
-
|
|
1125
|
-
Detect changes between the current state of a blueprint's resources and its tfstate baseline.
|
|
1126
|
-
Returns field-level diffs for resources that have been modified since the blueprint was last installed/exp
|
|
1127
|
-
|
|
1128
|
-
`POST /v2/blueprint-manifest/blueprints/{blueprint_id}/patches:detect`
|
|
1129
|
-
|
|
1130
|
-
```ts
|
|
1131
|
-
const { data } = await client.detectPatchChanges(
|
|
1132
|
-
{
|
|
1133
|
-
blueprint_id: 'example',
|
|
1134
|
-
},
|
|
1135
|
-
{
|
|
1136
|
-
source_org_id: 'string',
|
|
1137
|
-
dest_org_id: 'string',
|
|
1138
|
-
dest_blueprint_id: 'string',
|
|
1139
|
-
rollout_id: 'string'
|
|
1140
|
-
},
|
|
1141
|
-
)
|
|
1142
|
-
```
|
|
1143
|
-
|
|
1144
|
-
<details>
|
|
1145
|
-
<summary>Response</summary>
|
|
1146
|
-
|
|
1147
|
-
```json
|
|
1148
|
-
{
|
|
1149
|
-
"resources": [
|
|
1150
|
-
{
|
|
1151
|
-
"type": "string",
|
|
1152
|
-
"source_id": "string",
|
|
1153
|
-
"address": "string",
|
|
1154
|
-
"name": "string",
|
|
1155
|
-
"changes": [
|
|
1156
|
-
{
|
|
1157
|
-
"path": "string",
|
|
1158
|
-
"op": "changed",
|
|
1159
|
-
"baseline_value": {},
|
|
1160
|
-
"current_value": {}
|
|
1161
|
-
}
|
|
1162
|
-
]
|
|
1163
|
-
}
|
|
1164
|
-
]
|
|
1165
|
-
}
|
|
1166
|
-
```
|
|
1167
|
-
|
|
1168
|
-
</details>
|
|
1169
|
-
|
|
1170
|
-
---
|
|
1171
|
-
|
|
1172
|
-
### `createPatch`
|
|
1173
|
-
|
|
1174
|
-
Create a new patch for a blueprint.
|
|
1175
|
-
|
|
1176
|
-
`POST /v2/blueprint-manifest/blueprints/{blueprint_id}/patches`
|
|
1177
|
-
|
|
1178
|
-
```ts
|
|
1179
|
-
const { data } = await client.createPatch(
|
|
1180
|
-
{
|
|
1181
|
-
blueprint_id: 'example',
|
|
1182
|
-
},
|
|
1183
|
-
{
|
|
1184
|
-
blueprint_id: 'c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341',
|
|
1185
|
-
rollout_id: 'string',
|
|
1186
|
-
source_org_id: 'string',
|
|
1187
|
-
name: 'string',
|
|
1188
|
-
description: 'string',
|
|
1189
|
-
resources: [
|
|
1190
|
-
{
|
|
1191
|
-
type: 'string',
|
|
1192
|
-
source_id: 'string',
|
|
1193
|
-
address: 'string',
|
|
1194
|
-
name: 'string',
|
|
1195
|
-
changes: [
|
|
1196
|
-
{
|
|
1197
|
-
path: 'string',
|
|
1198
|
-
op: 'changed',
|
|
1199
|
-
baseline_value: {},
|
|
1200
|
-
current_value: {}
|
|
1201
|
-
}
|
|
1202
|
-
]
|
|
1203
|
-
}
|
|
1204
|
-
],
|
|
1205
|
-
changelog: 'string'
|
|
1206
|
-
},
|
|
1207
|
-
)
|
|
1208
|
-
```
|
|
1209
|
-
|
|
1210
|
-
<details>
|
|
1211
|
-
<summary>Response</summary>
|
|
1212
|
-
|
|
1213
|
-
```json
|
|
1214
|
-
{
|
|
1215
|
-
"patch_id": "string",
|
|
1216
|
-
"version": 0,
|
|
1217
|
-
"blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
|
|
1218
|
-
"rollout_id": "string",
|
|
1219
|
-
"source_org_id": "string",
|
|
1220
|
-
"name": "string",
|
|
1221
|
-
"description": "string",
|
|
1222
|
-
"status": "draft",
|
|
1223
|
-
"resources": [
|
|
1224
|
-
{
|
|
1225
|
-
"type": "string",
|
|
1226
|
-
"source_id": "string",
|
|
1227
|
-
"address": "string",
|
|
1228
|
-
"name": "string",
|
|
1229
|
-
"changes": [
|
|
1230
|
-
{
|
|
1231
|
-
"path": "string",
|
|
1232
|
-
"op": "changed",
|
|
1233
|
-
"baseline_value": {},
|
|
1234
|
-
"current_value": {}
|
|
1235
|
-
}
|
|
1236
|
-
]
|
|
1237
|
-
}
|
|
1238
|
-
],
|
|
1239
|
-
"changelog": "string",
|
|
1240
|
-
"created_by": "string",
|
|
1241
|
-
"created_at": "1970-01-01T00:00:00.000Z",
|
|
1242
|
-
"applied_at": "1970-01-01T00:00:00.000Z"
|
|
1243
|
-
}
|
|
1244
|
-
```
|
|
1245
|
-
|
|
1246
|
-
</details>
|
|
1247
|
-
|
|
1248
|
-
---
|
|
1249
|
-
|
|
1250
|
-
### `listPatches`
|
|
1251
|
-
|
|
1252
|
-
List all patches for a blueprint.
|
|
1253
|
-
|
|
1254
|
-
`GET /v2/blueprint-manifest/blueprints/{blueprint_id}/patches`
|
|
1255
|
-
|
|
1256
|
-
```ts
|
|
1257
|
-
const { data } = await client.listPatches({
|
|
1258
|
-
blueprint_id: 'example',
|
|
1259
|
-
})
|
|
1260
|
-
```
|
|
1261
|
-
|
|
1262
|
-
<details>
|
|
1263
|
-
<summary>Response</summary>
|
|
1264
|
-
|
|
1265
|
-
```json
|
|
1266
|
-
{
|
|
1267
|
-
"total": 0,
|
|
1268
|
-
"results": [
|
|
1269
|
-
{
|
|
1270
|
-
"patch_id": "string",
|
|
1271
|
-
"version": 0,
|
|
1272
|
-
"blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
|
|
1273
|
-
"rollout_id": "string",
|
|
1274
|
-
"source_org_id": "string",
|
|
1275
|
-
"name": "string",
|
|
1276
|
-
"description": "string",
|
|
1277
|
-
"status": "draft",
|
|
1278
|
-
"resources": [
|
|
1279
|
-
{
|
|
1280
|
-
"type": "string",
|
|
1281
|
-
"source_id": "string",
|
|
1282
|
-
"address": "string",
|
|
1283
|
-
"name": "string",
|
|
1284
|
-
"changes": [
|
|
1285
|
-
{
|
|
1286
|
-
"path": "string",
|
|
1287
|
-
"op": "changed",
|
|
1288
|
-
"baseline_value": {},
|
|
1289
|
-
"current_value": {}
|
|
1290
|
-
}
|
|
1291
|
-
]
|
|
1292
|
-
}
|
|
1293
|
-
],
|
|
1294
|
-
"changelog": "string",
|
|
1295
|
-
"created_by": "string",
|
|
1296
|
-
"created_at": "1970-01-01T00:00:00.000Z",
|
|
1297
|
-
"applied_at": "1970-01-01T00:00:00.000Z"
|
|
1298
|
-
}
|
|
1299
|
-
]
|
|
1300
|
-
}
|
|
1301
|
-
```
|
|
1302
|
-
|
|
1303
|
-
</details>
|
|
1304
|
-
|
|
1305
|
-
---
|
|
1306
|
-
|
|
1307
|
-
### `getPatch`
|
|
1308
|
-
|
|
1309
|
-
Get a patch by ID, including per-org execution results.
|
|
1310
|
-
|
|
1311
|
-
`GET /v2/blueprint-manifest/blueprints/{blueprint_id}/patches/{patch_id}`
|
|
1312
|
-
|
|
1313
|
-
```ts
|
|
1314
|
-
const { data } = await client.getPatch({
|
|
1315
|
-
blueprint_id: 'example',
|
|
1316
|
-
patch_id: 'example',
|
|
1317
|
-
})
|
|
1318
|
-
```
|
|
1319
|
-
|
|
1320
|
-
<details>
|
|
1321
|
-
<summary>Response</summary>
|
|
1322
|
-
|
|
1323
|
-
```json
|
|
1324
|
-
{
|
|
1325
|
-
"patch_id": "string",
|
|
1326
|
-
"version": 0,
|
|
1327
|
-
"blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
|
|
1328
|
-
"rollout_id": "string",
|
|
1329
|
-
"source_org_id": "string",
|
|
1330
|
-
"name": "string",
|
|
1331
|
-
"description": "string",
|
|
1332
|
-
"status": "draft",
|
|
1333
|
-
"resources": [
|
|
1334
|
-
{
|
|
1335
|
-
"type": "string",
|
|
1336
|
-
"source_id": "string",
|
|
1337
|
-
"address": "string",
|
|
1338
|
-
"name": "string",
|
|
1339
|
-
"changes": [
|
|
1340
|
-
{
|
|
1341
|
-
"path": "string",
|
|
1342
|
-
"op": "changed",
|
|
1343
|
-
"baseline_value": {},
|
|
1344
|
-
"current_value": {}
|
|
1345
|
-
}
|
|
1346
|
-
]
|
|
1347
|
-
}
|
|
1348
|
-
],
|
|
1349
|
-
"changelog": "string",
|
|
1350
|
-
"created_by": "string",
|
|
1351
|
-
"created_at": "1970-01-01T00:00:00.000Z",
|
|
1352
|
-
"applied_at": "1970-01-01T00:00:00.000Z",
|
|
1353
|
-
"org_results": [
|
|
1354
|
-
{
|
|
1355
|
-
"patch_id": "string",
|
|
1356
|
-
"version": 0,
|
|
1357
|
-
"org_id": "string",
|
|
1358
|
-
"org_name": "string",
|
|
1359
|
-
"dest_blueprint_id": "string",
|
|
1360
|
-
"status": "pending",
|
|
1361
|
-
"error": "string",
|
|
1362
|
-
"applied_at": "1970-01-01T00:00:00.000Z",
|
|
1363
|
-
"retries": 0,
|
|
1364
|
-
"changes_applied": [
|
|
1365
|
-
{
|
|
1366
|
-
"path": "string",
|
|
1367
|
-
"op": "changed",
|
|
1368
|
-
"baseline_value": {},
|
|
1369
|
-
"current_value": {}
|
|
1370
|
-
}
|
|
1371
|
-
]
|
|
1372
|
-
}
|
|
1373
|
-
]
|
|
1374
|
-
}
|
|
1375
|
-
```
|
|
1376
|
-
|
|
1377
|
-
</details>
|
|
1378
|
-
|
|
1379
|
-
---
|
|
1380
|
-
|
|
1381
|
-
### `applyPatch`
|
|
1382
|
-
|
|
1383
|
-
Apply a patch to a single destination org.
|
|
1384
|
-
|
|
1385
|
-
`POST /v2/blueprint-manifest/blueprints/{blueprint_id}/patches/{patch_id}:apply`
|
|
1386
|
-
|
|
1387
|
-
```ts
|
|
1388
|
-
const { data } = await client.applyPatch(
|
|
1389
|
-
{
|
|
1390
|
-
blueprint_id: 'example',
|
|
1391
|
-
patch_id: 'example',
|
|
1392
|
-
},
|
|
1393
|
-
{
|
|
1394
|
-
org_id: 'string',
|
|
1395
|
-
org_name: 'string',
|
|
1396
|
-
dest_blueprint_id: 'string',
|
|
1397
|
-
dest_org_id: 'string',
|
|
1398
|
-
destination_auth_token: 'string'
|
|
1399
|
-
},
|
|
1400
|
-
)
|
|
1401
|
-
```
|
|
1402
|
-
|
|
1403
|
-
<details>
|
|
1404
|
-
<summary>Response</summary>
|
|
1405
|
-
|
|
1406
|
-
```json
|
|
1407
|
-
{
|
|
1408
|
-
"patch_id": "string",
|
|
1409
|
-
"version": 0,
|
|
1410
|
-
"org_id": "string",
|
|
1411
|
-
"org_name": "string",
|
|
1412
|
-
"dest_blueprint_id": "string",
|
|
1413
|
-
"status": "pending",
|
|
1414
|
-
"error": "string",
|
|
1415
|
-
"applied_at": "1970-01-01T00:00:00.000Z",
|
|
1416
|
-
"retries": 0,
|
|
1417
|
-
"changes_applied": [
|
|
1418
|
-
{
|
|
1419
|
-
"path": "string",
|
|
1420
|
-
"op": "changed",
|
|
1421
|
-
"baseline_value": {},
|
|
1422
|
-
"current_value": {}
|
|
1423
|
-
}
|
|
1424
|
-
]
|
|
1425
|
-
}
|
|
1426
|
-
```
|
|
1427
|
-
|
|
1428
|
-
</details>
|
|
1429
|
-
|
|
1430
|
-
---
|
|
1431
|
-
|
|
1432
|
-
### `retryPatchOrg`
|
|
1433
|
-
|
|
1434
|
-
Retry a failed patch execution for a specific org.
|
|
1435
|
-
|
|
1436
|
-
`POST /v2/blueprint-manifest/blueprints/{blueprint_id}/patches/{patch_id}/orgs/{org_id}:retry`
|
|
1437
|
-
|
|
1438
|
-
```ts
|
|
1439
|
-
const { data } = await client.retryPatchOrg(
|
|
1440
|
-
{
|
|
1441
|
-
blueprint_id: 'example',
|
|
1442
|
-
patch_id: 'example',
|
|
1443
|
-
org_id: 'example',
|
|
1444
|
-
},
|
|
1445
|
-
{
|
|
1446
|
-
org_name: 'string',
|
|
1447
|
-
dest_blueprint_id: 'string',
|
|
1448
|
-
destination_auth_token: 'string'
|
|
1449
|
-
},
|
|
1450
|
-
)
|
|
1451
|
-
```
|
|
1452
|
-
|
|
1453
|
-
<details>
|
|
1454
|
-
<summary>Response</summary>
|
|
1455
|
-
|
|
1456
|
-
```json
|
|
1457
|
-
{
|
|
1458
|
-
"patch_id": "string",
|
|
1459
|
-
"version": 0,
|
|
1460
|
-
"org_id": "string",
|
|
1461
|
-
"org_name": "string",
|
|
1462
|
-
"dest_blueprint_id": "string",
|
|
1463
|
-
"status": "pending",
|
|
1464
|
-
"error": "string",
|
|
1465
|
-
"applied_at": "1970-01-01T00:00:00.000Z",
|
|
1466
|
-
"retries": 0,
|
|
1467
|
-
"changes_applied": [
|
|
1468
|
-
{
|
|
1469
|
-
"path": "string",
|
|
1470
|
-
"op": "changed",
|
|
1471
|
-
"baseline_value": {},
|
|
1472
|
-
"current_value": {}
|
|
1473
|
-
}
|
|
1474
|
-
]
|
|
1475
|
-
}
|
|
1476
|
-
```
|
|
1477
|
-
|
|
1478
|
-
</details>
|
|
1479
|
-
|
|
1480
|
-
---
|
|
1481
|
-
|
|
1482
|
-
### `exportBlueprint`
|
|
1483
|
-
|
|
1484
|
-
Kick off a new blueprint export job. Returns 202 Accepted with Location header pointing to the job resource.
|
|
1485
|
-
|
|
1486
|
-
`POST /v2/blueprint-manifest/blueprints/{blueprint_id}:export`
|
|
1487
|
-
|
|
1488
|
-
```ts
|
|
1489
|
-
const { data } = await client.exportBlueprint(
|
|
1490
|
-
{
|
|
1491
|
-
blueprint_id: 'example',
|
|
1492
|
-
},
|
|
1493
|
-
{
|
|
1494
|
-
destination_org_id: 'string',
|
|
1495
|
-
destination_blueprint_id: 'string',
|
|
1496
|
-
validate: true
|
|
1084
|
+
destination_auth_token: 'string',
|
|
1085
|
+
installation_job_id: 'c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341',
|
|
1086
|
+
sync_engine: 'terraform'
|
|
1497
1087
|
},
|
|
1498
1088
|
)
|
|
1499
1089
|
```
|
|
@@ -1698,6 +1288,7 @@ Sync dependencies of all root resources in a Blueprint
|
|
|
1698
1288
|
```ts
|
|
1699
1289
|
const { data } = await client.syncDependencies({
|
|
1700
1290
|
blueprint_id: 'example',
|
|
1291
|
+
trigger: 'example',
|
|
1701
1292
|
})
|
|
1702
1293
|
```
|
|
1703
1294
|
|
|
@@ -2845,6 +2436,20 @@ const { data } = await client.publishMarketplaceListingVersion(
|
|
|
2845
2436
|
|
|
2846
2437
|
---
|
|
2847
2438
|
|
|
2439
|
+
### `publishBlueprintV3`
|
|
2440
|
+
|
|
2441
|
+
Publish Blueprint V3
|
|
2442
|
+
|
|
2443
|
+
`POST /v3/blueprint-manifest/blueprints/{blueprint_id}:publish`
|
|
2444
|
+
|
|
2445
|
+
```ts
|
|
2446
|
+
const { data } = await client.publishBlueprintV3({
|
|
2447
|
+
blueprint_id: 'example',
|
|
2448
|
+
})
|
|
2449
|
+
```
|
|
2450
|
+
|
|
2451
|
+
---
|
|
2452
|
+
|
|
2848
2453
|
### `installBlueprintV3`
|
|
2849
2454
|
|
|
2850
2455
|
Install Blueprint V3
|
|
@@ -2904,9 +2509,17 @@ const { data } = await client.getRestorePreview({
|
|
|
2904
2509
|
"reason": "modified",
|
|
2905
2510
|
"last_synced_at": "1970-01-01T00:00:00.000Z",
|
|
2906
2511
|
"current_updated_at": "1970-01-01T00:00:00.000Z",
|
|
2907
|
-
"error_message": "string"
|
|
2512
|
+
"error_message": "string",
|
|
2513
|
+
"is_hidden": true,
|
|
2514
|
+
"co_owned_by": [
|
|
2515
|
+
{
|
|
2516
|
+
"blueprint_id": "string",
|
|
2517
|
+
"title": "string"
|
|
2518
|
+
}
|
|
2519
|
+
]
|
|
2908
2520
|
}
|
|
2909
|
-
]
|
|
2521
|
+
],
|
|
2522
|
+
"has_effective_changes": true
|
|
2910
2523
|
}
|
|
2911
2524
|
```
|
|
2912
2525
|
|
|
@@ -2949,6 +2562,276 @@ const { data } = await client.getBlueprintLineageV3({
|
|
|
2949
2562
|
|
|
2950
2563
|
---
|
|
2951
2564
|
|
|
2565
|
+
### `createBulkInstallV3`
|
|
2566
|
+
|
|
2567
|
+
Create Bulk Install V3
|
|
2568
|
+
|
|
2569
|
+
`POST /v3/blueprint-manifest/bulk-installs`
|
|
2570
|
+
|
|
2571
|
+
```ts
|
|
2572
|
+
const { data } = await client.createBulkInstallV3(
|
|
2573
|
+
null,
|
|
2574
|
+
{
|
|
2575
|
+
source_org_id: 'string',
|
|
2576
|
+
source_blueprint_id: 'c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341',
|
|
2577
|
+
max_concurrency: 2,
|
|
2578
|
+
slug: 'string',
|
|
2579
|
+
options: {
|
|
2580
|
+
resources_to_ignore: ['string']
|
|
2581
|
+
},
|
|
2582
|
+
targets: [
|
|
2583
|
+
{
|
|
2584
|
+
destination_org_id: 'string',
|
|
2585
|
+
destination_blueprint_id: 'c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341',
|
|
2586
|
+
destination_auth_token: 'string'
|
|
2587
|
+
}
|
|
2588
|
+
]
|
|
2589
|
+
},
|
|
2590
|
+
)
|
|
2591
|
+
```
|
|
2592
|
+
|
|
2593
|
+
---
|
|
2594
|
+
|
|
2595
|
+
### `getBulkInstallV3`
|
|
2596
|
+
|
|
2597
|
+
Get Bulk Install V3
|
|
2598
|
+
|
|
2599
|
+
`GET /v3/blueprint-manifest/bulk-installs/{bulk_job_id}`
|
|
2600
|
+
|
|
2601
|
+
```ts
|
|
2602
|
+
const { data } = await client.getBulkInstallV3({
|
|
2603
|
+
bulk_job_id: 'example',
|
|
2604
|
+
})
|
|
2605
|
+
```
|
|
2606
|
+
|
|
2607
|
+
<details>
|
|
2608
|
+
<summary>Response</summary>
|
|
2609
|
+
|
|
2610
|
+
```json
|
|
2611
|
+
{
|
|
2612
|
+
"bulk_job_id": "string",
|
|
2613
|
+
"source_org_id": "string",
|
|
2614
|
+
"source_blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
|
|
2615
|
+
"status": "QUEUED",
|
|
2616
|
+
"target_count": 0,
|
|
2617
|
+
"max_concurrency": 0,
|
|
2618
|
+
"counts": {
|
|
2619
|
+
"queued": 0,
|
|
2620
|
+
"in_progress": 0,
|
|
2621
|
+
"success": 0,
|
|
2622
|
+
"partial_success": 0,
|
|
2623
|
+
"failed": 0
|
|
2624
|
+
},
|
|
2625
|
+
"slug": "string",
|
|
2626
|
+
"options": {
|
|
2627
|
+
"resources_to_ignore": ["string"]
|
|
2628
|
+
},
|
|
2629
|
+
"created_at": "1970-01-01T00:00:00.000Z",
|
|
2630
|
+
"updated_at": "1970-01-01T00:00:00.000Z"
|
|
2631
|
+
}
|
|
2632
|
+
```
|
|
2633
|
+
|
|
2634
|
+
</details>
|
|
2635
|
+
|
|
2636
|
+
---
|
|
2637
|
+
|
|
2638
|
+
### `listBulkInstallTargetsV3`
|
|
2639
|
+
|
|
2640
|
+
List Bulk Install Targets V3
|
|
2641
|
+
|
|
2642
|
+
`GET /v3/blueprint-manifest/bulk-installs/{bulk_job_id}/targets`
|
|
2643
|
+
|
|
2644
|
+
```ts
|
|
2645
|
+
const { data } = await client.listBulkInstallTargetsV3({
|
|
2646
|
+
bulk_job_id: 'example',
|
|
2647
|
+
limit: 1,
|
|
2648
|
+
cursor: 'example',
|
|
2649
|
+
})
|
|
2650
|
+
```
|
|
2651
|
+
|
|
2652
|
+
<details>
|
|
2653
|
+
<summary>Response</summary>
|
|
2654
|
+
|
|
2655
|
+
```json
|
|
2656
|
+
{
|
|
2657
|
+
"results": [
|
|
2658
|
+
{
|
|
2659
|
+
"bulk_job_id": "string",
|
|
2660
|
+
"destination_org_id": "string",
|
|
2661
|
+
"destination_blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
|
|
2662
|
+
"status": "QUEUED",
|
|
2663
|
+
"job_ids": ["c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341"],
|
|
2664
|
+
"created_at": "1970-01-01T00:00:00.000Z",
|
|
2665
|
+
"updated_at": "1970-01-01T00:00:00.000Z",
|
|
2666
|
+
"job": {
|
|
2667
|
+
"id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
|
|
2668
|
+
"events": [
|
|
2669
|
+
{
|
|
2670
|
+
"timestamp": "1970-01-01T00:00:00.000Z",
|
|
2671
|
+
"message": "string",
|
|
2672
|
+
"errors": [
|
|
2673
|
+
{
|
|
2674
|
+
"error": "string",
|
|
2675
|
+
"code": "dependency_extraction",
|
|
2676
|
+
"data": {
|
|
2677
|
+
"formattedResource": {
|
|
2678
|
+
"id": "string",
|
|
2679
|
+
"name": "string",
|
|
2680
|
+
"type": "string"
|
|
2681
|
+
},
|
|
2682
|
+
"resource": "string",
|
|
2683
|
+
"resourceDependency": "string",
|
|
2684
|
+
"resources": ["string"],
|
|
2685
|
+
"addresses": ["string"],
|
|
2686
|
+
"originalError": "string"
|
|
2687
|
+
}
|
|
2688
|
+
}
|
|
2689
|
+
],
|
|
2690
|
+
"level": "info",
|
|
2691
|
+
"data": {
|
|
2692
|
+
"installed_blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
|
|
2693
|
+
"export_job_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
|
|
2694
|
+
"resources": 0
|
|
2695
|
+
}
|
|
2696
|
+
}
|
|
2697
|
+
],
|
|
2698
|
+
"triggered_at": "1970-01-01T00:00:00.000Z",
|
|
2699
|
+
"created_by": {
|
|
2700
|
+
"name": "manifest@epilot.cloud",
|
|
2701
|
+
"org_id": "911690",
|
|
2702
|
+
"user_id": "11001045",
|
|
2703
|
+
"token_id": "api_5ZugdRXasLfWBypHi93Fk"
|
|
2704
|
+
},
|
|
2705
|
+
"job_type": "install",
|
|
2706
|
+
"source_blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
|
|
2707
|
+
"source_blueprint_type": "custom",
|
|
2708
|
+
"source_org_id": "string",
|
|
2709
|
+
"source_blueprint_file": "string",
|
|
2710
|
+
"destination_blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
|
|
2711
|
+
"destination_org_id": "string",
|
|
2712
|
+
"slug": "string",
|
|
2713
|
+
"sync_engine": "terraform",
|
|
2714
|
+
"resource_progress": [
|
|
2715
|
+
{
|
|
2716
|
+
"lineage_id": "string",
|
|
2717
|
+
"type": "string",
|
|
2718
|
+
"address": "string",
|
|
2719
|
+
"name": "string",
|
|
2720
|
+
"status": "pending",
|
|
2721
|
+
"target_id": "string",
|
|
2722
|
+
"error_message": "string"
|
|
2723
|
+
}
|
|
2724
|
+
],
|
|
2725
|
+
"status": "IN_PROGRESS"
|
|
2726
|
+
}
|
|
2727
|
+
}
|
|
2728
|
+
],
|
|
2729
|
+
"next_cursor": "string"
|
|
2730
|
+
}
|
|
2731
|
+
```
|
|
2732
|
+
|
|
2733
|
+
</details>
|
|
2734
|
+
|
|
2735
|
+
---
|
|
2736
|
+
|
|
2737
|
+
### `retryBulkInstallTargetV3`
|
|
2738
|
+
|
|
2739
|
+
Retry Bulk Install Target V3
|
|
2740
|
+
|
|
2741
|
+
`POST /v3/blueprint-manifest/bulk-installs/{bulk_job_id}/targets/{destination_org_id}:retry`
|
|
2742
|
+
|
|
2743
|
+
```ts
|
|
2744
|
+
const { data } = await client.retryBulkInstallTargetV3(
|
|
2745
|
+
{
|
|
2746
|
+
bulk_job_id: 'example',
|
|
2747
|
+
destination_org_id: 'example',
|
|
2748
|
+
},
|
|
2749
|
+
{
|
|
2750
|
+
destination_auth_token: 'string'
|
|
2751
|
+
},
|
|
2752
|
+
)
|
|
2753
|
+
```
|
|
2754
|
+
|
|
2755
|
+
<details>
|
|
2756
|
+
<summary>Response</summary>
|
|
2757
|
+
|
|
2758
|
+
```json
|
|
2759
|
+
{
|
|
2760
|
+
"bulk_job_id": "string",
|
|
2761
|
+
"destination_org_id": "string",
|
|
2762
|
+
"destination_blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
|
|
2763
|
+
"status": "QUEUED",
|
|
2764
|
+
"job_ids": ["c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341"],
|
|
2765
|
+
"created_at": "1970-01-01T00:00:00.000Z",
|
|
2766
|
+
"updated_at": "1970-01-01T00:00:00.000Z",
|
|
2767
|
+
"job": {
|
|
2768
|
+
"id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
|
|
2769
|
+
"events": [
|
|
2770
|
+
{
|
|
2771
|
+
"timestamp": "1970-01-01T00:00:00.000Z",
|
|
2772
|
+
"message": "string",
|
|
2773
|
+
"errors": [
|
|
2774
|
+
{
|
|
2775
|
+
"error": "string",
|
|
2776
|
+
"code": "dependency_extraction",
|
|
2777
|
+
"data": {
|
|
2778
|
+
"formattedResource": {
|
|
2779
|
+
"id": "string",
|
|
2780
|
+
"name": "string",
|
|
2781
|
+
"type": "string"
|
|
2782
|
+
},
|
|
2783
|
+
"resource": "string",
|
|
2784
|
+
"resourceDependency": "string",
|
|
2785
|
+
"resources": ["string"],
|
|
2786
|
+
"addresses": ["string"],
|
|
2787
|
+
"originalError": "string"
|
|
2788
|
+
}
|
|
2789
|
+
}
|
|
2790
|
+
],
|
|
2791
|
+
"level": "info",
|
|
2792
|
+
"data": {
|
|
2793
|
+
"installed_blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
|
|
2794
|
+
"export_job_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
|
|
2795
|
+
"resources": 0
|
|
2796
|
+
}
|
|
2797
|
+
}
|
|
2798
|
+
],
|
|
2799
|
+
"triggered_at": "1970-01-01T00:00:00.000Z",
|
|
2800
|
+
"created_by": {
|
|
2801
|
+
"name": "manifest@epilot.cloud",
|
|
2802
|
+
"org_id": "911690",
|
|
2803
|
+
"user_id": "11001045",
|
|
2804
|
+
"token_id": "api_5ZugdRXasLfWBypHi93Fk"
|
|
2805
|
+
},
|
|
2806
|
+
"job_type": "install",
|
|
2807
|
+
"source_blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
|
|
2808
|
+
"source_blueprint_type": "custom",
|
|
2809
|
+
"source_org_id": "string",
|
|
2810
|
+
"source_blueprint_file": "string",
|
|
2811
|
+
"destination_blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
|
|
2812
|
+
"destination_org_id": "string",
|
|
2813
|
+
"slug": "string",
|
|
2814
|
+
"sync_engine": "terraform",
|
|
2815
|
+
"resource_progress": [
|
|
2816
|
+
{
|
|
2817
|
+
"lineage_id": "string",
|
|
2818
|
+
"type": "string",
|
|
2819
|
+
"address": "string",
|
|
2820
|
+
"name": "string",
|
|
2821
|
+
"status": "pending",
|
|
2822
|
+
"target_id": "string",
|
|
2823
|
+
"error_message": "string"
|
|
2824
|
+
}
|
|
2825
|
+
],
|
|
2826
|
+
"status": "IN_PROGRESS"
|
|
2827
|
+
}
|
|
2828
|
+
}
|
|
2829
|
+
```
|
|
2830
|
+
|
|
2831
|
+
</details>
|
|
2832
|
+
|
|
2833
|
+
---
|
|
2834
|
+
|
|
2952
2835
|
### `listUniquenessCriteria`
|
|
2953
2836
|
|
|
2954
2837
|
List all custom uniqueness criteria configured for the caller's organization.
|
|
@@ -2971,10 +2854,13 @@ const { data } = await client.listUniquenessCriteria()
|
|
|
2971
2854
|
"org_id": "string",
|
|
2972
2855
|
"resource_type": "emailtemplate",
|
|
2973
2856
|
"fields": ["string"],
|
|
2857
|
+
"propagated_to": ["string"],
|
|
2974
2858
|
"updated_at": "1970-01-01T00:00:00.000Z",
|
|
2975
2859
|
"updated_by": "string"
|
|
2976
2860
|
}
|
|
2977
|
-
]
|
|
2861
|
+
],
|
|
2862
|
+
"defaults": {},
|
|
2863
|
+
"readonly_types": ["string"]
|
|
2978
2864
|
}
|
|
2979
2865
|
```
|
|
2980
2866
|
|
|
@@ -3002,6 +2888,7 @@ const { data } = await client.getUniquenessCriteria({
|
|
|
3002
2888
|
"org_id": "string",
|
|
3003
2889
|
"resource_type": "emailtemplate",
|
|
3004
2890
|
"fields": ["string"],
|
|
2891
|
+
"propagated_to": ["string"],
|
|
3005
2892
|
"updated_at": "1970-01-01T00:00:00.000Z",
|
|
3006
2893
|
"updated_by": "string"
|
|
3007
2894
|
}
|
|
@@ -3025,7 +2912,8 @@ const { data } = await client.putUniquenessCriteria(
|
|
|
3025
2912
|
resource_type: 'example',
|
|
3026
2913
|
},
|
|
3027
2914
|
{
|
|
3028
|
-
fields: ['string']
|
|
2915
|
+
fields: ['string'],
|
|
2916
|
+
propagated_to: ['string']
|
|
3029
2917
|
},
|
|
3030
2918
|
)
|
|
3031
2919
|
```
|
|
@@ -3038,6 +2926,7 @@ const { data } = await client.putUniquenessCriteria(
|
|
|
3038
2926
|
"org_id": "string",
|
|
3039
2927
|
"resource_type": "emailtemplate",
|
|
3040
2928
|
"fields": ["string"],
|
|
2929
|
+
"propagated_to": ["string"],
|
|
3041
2930
|
"updated_at": "1970-01-01T00:00:00.000Z",
|
|
3042
2931
|
"updated_by": "string"
|
|
3043
2932
|
}
|
|
@@ -3068,7 +2957,7 @@ const { data } = await client.deleteUniquenessCriteria({
|
|
|
3068
2957
|
Resource type for which custom uniqueness criteria can be configured.
|
|
3069
2958
|
|
|
3070
2959
|
```ts
|
|
3071
|
-
type UniquenessCriteriaResourceType = "emailtemplate" | "product" | "price" | "tax" | "coupon" | "product_recommendation" | "file" | "document_template" | "
|
|
2960
|
+
type UniquenessCriteriaResourceType = "emailtemplate" | "product" | "price" | "tax" | "coupon" | "product_recommendation" | "file" | "document_template" | "notification_template" | "journey"
|
|
3072
2961
|
```
|
|
3073
2962
|
|
|
3074
2963
|
### `UniquenessCriteria`
|
|
@@ -3076,8 +2965,9 @@ type UniquenessCriteriaResourceType = "emailtemplate" | "product" | "price" | "t
|
|
|
3076
2965
|
```ts
|
|
3077
2966
|
type UniquenessCriteria = {
|
|
3078
2967
|
org_id: string
|
|
3079
|
-
resource_type: "emailtemplate" | "product" | "price" | "tax" | "coupon" | "product_recommendation" | "file" | "document_template" | "
|
|
2968
|
+
resource_type: "emailtemplate" | "product" | "price" | "tax" | "coupon" | "product_recommendation" | "file" | "document_template" | "notification_template" | "journey"
|
|
3080
2969
|
fields: string[]
|
|
2970
|
+
propagated_to?: string[]
|
|
3081
2971
|
updated_at: string // date-time
|
|
3082
2972
|
updated_by?: string
|
|
3083
2973
|
}
|
|
@@ -3302,6 +3192,8 @@ type CommonBlueprintFields = {
|
|
|
3302
3192
|
source_blueprint_id?: string
|
|
3303
3193
|
destination_org_id?: string
|
|
3304
3194
|
destination_blueprint_id?: string
|
|
3195
|
+
installation_job_id?: string
|
|
3196
|
+
sync_engine?: "terraform" | "v3"
|
|
3305
3197
|
summary?: {
|
|
3306
3198
|
total_resources?: { ... }
|
|
3307
3199
|
matched?: { ... }
|
|
@@ -3364,7 +3256,7 @@ type SuggestBlueprintResourcesResponse = {
|
|
|
3364
3256
|
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"[]
|
|
3365
3257
|
parent_resource_ids?: string[]
|
|
3366
3258
|
depends_on_addresses?: string[]
|
|
3367
|
-
impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored"[]
|
|
3259
|
+
impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored" | "error"[]
|
|
3368
3260
|
impact_on_install_reason?: string[]
|
|
3369
3261
|
}>
|
|
3370
3262
|
suggested_blueprint_name?: string
|
|
@@ -3388,7 +3280,7 @@ type BlueprintResource = {
|
|
|
3388
3280
|
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"[]
|
|
3389
3281
|
parent_resource_ids?: string[]
|
|
3390
3282
|
depends_on_addresses?: string[]
|
|
3391
|
-
impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored"[]
|
|
3283
|
+
impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored" | "error"[]
|
|
3392
3284
|
impact_on_install_reason?: string[]
|
|
3393
3285
|
}
|
|
3394
3286
|
```
|
|
@@ -3436,7 +3328,7 @@ type BlueprintPreview = {
|
|
|
3436
3328
|
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"[]
|
|
3437
3329
|
parent_resource_ids?: string[]
|
|
3438
3330
|
depends_on_addresses?: string[]
|
|
3439
|
-
impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored"[]
|
|
3331
|
+
impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored" | "error"[]
|
|
3440
3332
|
impact_on_install_reason?: string[]
|
|
3441
3333
|
}>
|
|
3442
3334
|
}
|
|
@@ -3484,6 +3376,8 @@ type CustomBlueprint = {
|
|
|
3484
3376
|
source_blueprint_id?: string
|
|
3485
3377
|
destination_org_id?: string
|
|
3486
3378
|
destination_blueprint_id?: string
|
|
3379
|
+
installation_job_id?: string
|
|
3380
|
+
sync_engine?: "terraform" | "v3"
|
|
3487
3381
|
summary?: {
|
|
3488
3382
|
total_resources?: { ... }
|
|
3489
3383
|
matched?: { ... }
|
|
@@ -3530,7 +3424,7 @@ type CustomBlueprint = {
|
|
|
3530
3424
|
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"[]
|
|
3531
3425
|
parent_resource_ids?: string[]
|
|
3532
3426
|
depends_on_addresses?: string[]
|
|
3533
|
-
impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored"[]
|
|
3427
|
+
impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored" | "error"[]
|
|
3534
3428
|
impact_on_install_reason?: string[]
|
|
3535
3429
|
}>
|
|
3536
3430
|
source_type?: "custom"
|
|
@@ -3579,6 +3473,8 @@ type FileBlueprint = {
|
|
|
3579
3473
|
source_blueprint_id?: string
|
|
3580
3474
|
destination_org_id?: string
|
|
3581
3475
|
destination_blueprint_id?: string
|
|
3476
|
+
installation_job_id?: string
|
|
3477
|
+
sync_engine?: "terraform" | "v3"
|
|
3582
3478
|
summary?: {
|
|
3583
3479
|
total_resources?: { ... }
|
|
3584
3480
|
matched?: { ... }
|
|
@@ -3626,7 +3522,7 @@ type FileBlueprint = {
|
|
|
3626
3522
|
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"[]
|
|
3627
3523
|
parent_resource_ids?: string[]
|
|
3628
3524
|
depends_on_addresses?: string[]
|
|
3629
|
-
impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored"[]
|
|
3525
|
+
impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored" | "error"[]
|
|
3630
3526
|
impact_on_install_reason?: string[]
|
|
3631
3527
|
}>
|
|
3632
3528
|
}
|
|
@@ -3674,6 +3570,8 @@ type MarketplaceBlueprint = {
|
|
|
3674
3570
|
source_blueprint_id?: string
|
|
3675
3571
|
destination_org_id?: string
|
|
3676
3572
|
destination_blueprint_id?: string
|
|
3573
|
+
installation_job_id?: string
|
|
3574
|
+
sync_engine?: "terraform" | "v3"
|
|
3677
3575
|
summary?: {
|
|
3678
3576
|
total_resources?: { ... }
|
|
3679
3577
|
matched?: { ... }
|
|
@@ -3721,7 +3619,7 @@ type MarketplaceBlueprint = {
|
|
|
3721
3619
|
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"[]
|
|
3722
3620
|
parent_resource_ids?: string[]
|
|
3723
3621
|
depends_on_addresses?: string[]
|
|
3724
|
-
impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored"[]
|
|
3622
|
+
impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored" | "error"[]
|
|
3725
3623
|
impact_on_install_reason?: string[]
|
|
3726
3624
|
}>
|
|
3727
3625
|
has_update_available?: boolean
|
|
@@ -3801,6 +3699,8 @@ type DeployedBlueprint = {
|
|
|
3801
3699
|
source_blueprint_id?: string
|
|
3802
3700
|
destination_org_id?: string
|
|
3803
3701
|
destination_blueprint_id?: string
|
|
3702
|
+
installation_job_id?: string
|
|
3703
|
+
sync_engine?: "terraform" | "v3"
|
|
3804
3704
|
summary?: {
|
|
3805
3705
|
total_resources?: { ... }
|
|
3806
3706
|
matched?: { ... }
|
|
@@ -3848,7 +3748,7 @@ type DeployedBlueprint = {
|
|
|
3848
3748
|
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"[]
|
|
3849
3749
|
parent_resource_ids?: string[]
|
|
3850
3750
|
depends_on_addresses?: string[]
|
|
3851
|
-
impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored"[]
|
|
3751
|
+
impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored" | "error"[]
|
|
3852
3752
|
impact_on_install_reason?: string[]
|
|
3853
3753
|
}>
|
|
3854
3754
|
}
|
|
@@ -3896,6 +3796,8 @@ type AppBlueprint = {
|
|
|
3896
3796
|
source_blueprint_id?: string
|
|
3897
3797
|
destination_org_id?: string
|
|
3898
3798
|
destination_blueprint_id?: string
|
|
3799
|
+
installation_job_id?: string
|
|
3800
|
+
sync_engine?: "terraform" | "v3"
|
|
3899
3801
|
summary?: {
|
|
3900
3802
|
total_resources?: { ... }
|
|
3901
3803
|
matched?: { ... }
|
|
@@ -3943,7 +3845,7 @@ type AppBlueprint = {
|
|
|
3943
3845
|
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"[]
|
|
3944
3846
|
parent_resource_ids?: string[]
|
|
3945
3847
|
depends_on_addresses?: string[]
|
|
3946
|
-
impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored"[]
|
|
3848
|
+
impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored" | "error"[]
|
|
3947
3849
|
impact_on_install_reason?: string[]
|
|
3948
3850
|
}>
|
|
3949
3851
|
}
|
|
@@ -3991,6 +3893,8 @@ type Blueprint = {
|
|
|
3991
3893
|
source_blueprint_id?: string
|
|
3992
3894
|
destination_org_id?: string
|
|
3993
3895
|
destination_blueprint_id?: string
|
|
3896
|
+
installation_job_id?: string
|
|
3897
|
+
sync_engine?: "terraform" | "v3"
|
|
3994
3898
|
summary?: {
|
|
3995
3899
|
total_resources?: { ... }
|
|
3996
3900
|
matched?: { ... }
|
|
@@ -4037,7 +3941,7 @@ type Blueprint = {
|
|
|
4037
3941
|
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"[]
|
|
4038
3942
|
parent_resource_ids?: string[]
|
|
4039
3943
|
depends_on_addresses?: string[]
|
|
4040
|
-
impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored"[]
|
|
3944
|
+
impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored" | "error"[]
|
|
4041
3945
|
impact_on_install_reason?: string[]
|
|
4042
3946
|
}>
|
|
4043
3947
|
source_type?: "custom"
|
|
@@ -4050,8 +3954,6 @@ type Blueprint = {
|
|
|
4050
3954
|
postinstall?: string
|
|
4051
3955
|
}
|
|
4052
3956
|
version?: string
|
|
4053
|
-
deployments?: Array<{
|
|
4054
|
-
source_org_id?: string
|
|
4055
3957
|
// ...
|
|
4056
3958
|
}
|
|
4057
3959
|
```
|
|
@@ -4180,6 +4082,178 @@ type BlueprintInstallationJob = {
|
|
|
4180
4082
|
}
|
|
4181
4083
|
```
|
|
4182
4084
|
|
|
4085
|
+
### `BulkInstallStatus`
|
|
4086
|
+
|
|
4087
|
+
Aggregate status for a bulk install or one of its targets.
|
|
4088
|
+
- `QUEUED`: not started yet
|
|
4089
|
+
- `IN_PROGRESS`: at least one target queued/in-progress, not all done
|
|
4090
|
+
- `SUCCESS`: all targets succeeded
|
|
4091
|
+
- `PARTIAL_SUCCESS`: all targets terminal with a mix of success/partial/failure
|
|
4092
|
+
- `FAILED`: all targets term
|
|
4093
|
+
|
|
4094
|
+
```ts
|
|
4095
|
+
type BulkInstallStatus = "QUEUED" | "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED"
|
|
4096
|
+
```
|
|
4097
|
+
|
|
4098
|
+
### `BulkInstallCounts`
|
|
4099
|
+
|
|
4100
|
+
Tally of target rows by status. Recomputed from target rows on each transition.
|
|
4101
|
+
|
|
4102
|
+
```ts
|
|
4103
|
+
type BulkInstallCounts = {
|
|
4104
|
+
queued?: number
|
|
4105
|
+
in_progress?: number
|
|
4106
|
+
success?: number
|
|
4107
|
+
partial_success?: number
|
|
4108
|
+
failed?: number
|
|
4109
|
+
}
|
|
4110
|
+
```
|
|
4111
|
+
|
|
4112
|
+
### `BulkInstall`
|
|
4113
|
+
|
|
4114
|
+
Bulk install parent. Never carries target auth tokens.
|
|
4115
|
+
|
|
4116
|
+
```ts
|
|
4117
|
+
type BulkInstall = {
|
|
4118
|
+
bulk_job_id?: string
|
|
4119
|
+
source_org_id?: string
|
|
4120
|
+
source_blueprint_id?: string
|
|
4121
|
+
status?: "QUEUED" | "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED"
|
|
4122
|
+
target_count?: number
|
|
4123
|
+
max_concurrency?: number
|
|
4124
|
+
counts?: {
|
|
4125
|
+
queued?: number
|
|
4126
|
+
in_progress?: number
|
|
4127
|
+
success?: number
|
|
4128
|
+
partial_success?: number
|
|
4129
|
+
failed?: number
|
|
4130
|
+
}
|
|
4131
|
+
slug?: string
|
|
4132
|
+
options?: {
|
|
4133
|
+
resources_to_ignore?: string[]
|
|
4134
|
+
}
|
|
4135
|
+
created_at?: string // date-time
|
|
4136
|
+
updated_at?: string // date-time
|
|
4137
|
+
}
|
|
4138
|
+
```
|
|
4139
|
+
|
|
4140
|
+
### `BulkInstallTarget`
|
|
4141
|
+
|
|
4142
|
+
A single destination of a bulk install. `job` is the hydrated latest child
|
|
4143
|
+
install job derived from `job_ids.at(-1)`. Auth tokens are never stored or returned.
|
|
4144
|
+
|
|
4145
|
+
|
|
4146
|
+
```ts
|
|
4147
|
+
type BulkInstallTarget = {
|
|
4148
|
+
bulk_job_id?: string
|
|
4149
|
+
destination_org_id?: string
|
|
4150
|
+
destination_blueprint_id?: string
|
|
4151
|
+
status?: "QUEUED" | "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED"
|
|
4152
|
+
job_ids?: string[]
|
|
4153
|
+
created_at?: string // date-time
|
|
4154
|
+
updated_at?: string // date-time
|
|
4155
|
+
job?: {
|
|
4156
|
+
id?: string
|
|
4157
|
+
events?: Array<{
|
|
4158
|
+
timestamp?: { ... }
|
|
4159
|
+
message?: { ... }
|
|
4160
|
+
errors?: { ... }
|
|
4161
|
+
level?: { ... }
|
|
4162
|
+
data?: { ... }
|
|
4163
|
+
}>
|
|
4164
|
+
triggered_at?: string // date-time
|
|
4165
|
+
created_by?: {
|
|
4166
|
+
name?: { ... }
|
|
4167
|
+
org_id: { ... }
|
|
4168
|
+
user_id?: { ... }
|
|
4169
|
+
token_id?: { ... }
|
|
4170
|
+
}
|
|
4171
|
+
job_type?: "install"
|
|
4172
|
+
source_blueprint_id?: string
|
|
4173
|
+
source_blueprint_type?: "custom" | "file" | "marketplace" | "deploy" | "app"
|
|
4174
|
+
source_org_id?: string
|
|
4175
|
+
source_blueprint_file?: string
|
|
4176
|
+
destination_blueprint_id?: string
|
|
4177
|
+
destination_org_id?: string
|
|
4178
|
+
slug?: string
|
|
4179
|
+
sync_engine?: "terraform" | "v3"
|
|
4180
|
+
resource_progress?: Array<{
|
|
4181
|
+
lineage_id: { ... }
|
|
4182
|
+
type: { ... }
|
|
4183
|
+
address: { ... }
|
|
4184
|
+
name?: { ... }
|
|
4185
|
+
status: { ... }
|
|
4186
|
+
target_id?: { ... }
|
|
4187
|
+
error_message?: { ... }
|
|
4188
|
+
}>
|
|
4189
|
+
status?: "IN_PROGRESS" | "WAITING_USER_ACTION" | "CANCELED" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED"
|
|
4190
|
+
}
|
|
4191
|
+
}
|
|
4192
|
+
```
|
|
4193
|
+
|
|
4194
|
+
### `BulkInstallTargetList`
|
|
4195
|
+
|
|
4196
|
+
```ts
|
|
4197
|
+
type BulkInstallTargetList = {
|
|
4198
|
+
results?: Array<{
|
|
4199
|
+
bulk_job_id?: string
|
|
4200
|
+
destination_org_id?: string
|
|
4201
|
+
destination_blueprint_id?: string
|
|
4202
|
+
status?: "QUEUED" | "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED"
|
|
4203
|
+
job_ids?: string[]
|
|
4204
|
+
created_at?: string // date-time
|
|
4205
|
+
updated_at?: string // date-time
|
|
4206
|
+
job?: {
|
|
4207
|
+
id?: { ... }
|
|
4208
|
+
events?: { ... }
|
|
4209
|
+
triggered_at?: { ... }
|
|
4210
|
+
created_by?: { ... }
|
|
4211
|
+
job_type?: { ... }
|
|
4212
|
+
source_blueprint_id?: { ... }
|
|
4213
|
+
source_blueprint_type?: { ... }
|
|
4214
|
+
source_org_id?: { ... }
|
|
4215
|
+
source_blueprint_file?: { ... }
|
|
4216
|
+
destination_blueprint_id?: { ... }
|
|
4217
|
+
destination_org_id?: { ... }
|
|
4218
|
+
slug?: { ... }
|
|
4219
|
+
sync_engine?: { ... }
|
|
4220
|
+
resource_progress?: { ... }
|
|
4221
|
+
status?: { ... }
|
|
4222
|
+
}
|
|
4223
|
+
}>
|
|
4224
|
+
next_cursor?: string
|
|
4225
|
+
}
|
|
4226
|
+
```
|
|
4227
|
+
|
|
4228
|
+
### `BulkInstallTargetInput`
|
|
4229
|
+
|
|
4230
|
+
```ts
|
|
4231
|
+
type BulkInstallTargetInput = {
|
|
4232
|
+
destination_org_id: string
|
|
4233
|
+
destination_blueprint_id?: string
|
|
4234
|
+
destination_auth_token: string
|
|
4235
|
+
}
|
|
4236
|
+
```
|
|
4237
|
+
|
|
4238
|
+
### `BulkInstallCreateRequest`
|
|
4239
|
+
|
|
4240
|
+
```ts
|
|
4241
|
+
type BulkInstallCreateRequest = {
|
|
4242
|
+
source_org_id?: string
|
|
4243
|
+
source_blueprint_id: string
|
|
4244
|
+
max_concurrency?: number
|
|
4245
|
+
slug?: string
|
|
4246
|
+
options?: {
|
|
4247
|
+
resources_to_ignore?: string[]
|
|
4248
|
+
}
|
|
4249
|
+
targets: Array<{
|
|
4250
|
+
destination_org_id: string
|
|
4251
|
+
destination_blueprint_id?: string
|
|
4252
|
+
destination_auth_token: string
|
|
4253
|
+
}>
|
|
4254
|
+
}
|
|
4255
|
+
```
|
|
4256
|
+
|
|
4183
4257
|
### `BlueprintRestoreJob`
|
|
4184
4258
|
|
|
4185
4259
|
```ts
|
|
@@ -4226,7 +4300,10 @@ type BlueprintRestoreJob = {
|
|
|
4226
4300
|
last_synced_at?: { ... }
|
|
4227
4301
|
current_updated_at?: { ... }
|
|
4228
4302
|
error_message?: { ... }
|
|
4303
|
+
is_hidden?: { ... }
|
|
4304
|
+
co_owned_by?: { ... }
|
|
4229
4305
|
}>
|
|
4306
|
+
has_effective_changes?: boolean
|
|
4230
4307
|
}
|
|
4231
4308
|
}
|
|
4232
4309
|
```
|
|
@@ -4254,10 +4331,15 @@ type RestoreOutcomeItem = {
|
|
|
4254
4331
|
name?: string
|
|
4255
4332
|
target_id?: string
|
|
4256
4333
|
action: "restore" | "delete" | "skip" | "failed"
|
|
4257
|
-
reason?: "modified" | "
|
|
4334
|
+
reason?: "modified" | "delete_unsupported" | "heuristic_match" | "co_owned"
|
|
4258
4335
|
last_synced_at?: string // date-time
|
|
4259
4336
|
current_updated_at?: string // date-time
|
|
4260
4337
|
error_message?: string
|
|
4338
|
+
is_hidden?: boolean
|
|
4339
|
+
co_owned_by?: Array<{
|
|
4340
|
+
blueprint_id: string
|
|
4341
|
+
title?: string
|
|
4342
|
+
}>
|
|
4261
4343
|
}
|
|
4262
4344
|
```
|
|
4263
4345
|
|
|
@@ -4272,11 +4354,17 @@ type RestoreOutcome = {
|
|
|
4272
4354
|
name?: string
|
|
4273
4355
|
target_id?: string
|
|
4274
4356
|
action: "restore" | "delete" | "skip" | "failed"
|
|
4275
|
-
reason?: "modified" | "
|
|
4357
|
+
reason?: "modified" | "delete_unsupported" | "heuristic_match" | "co_owned"
|
|
4276
4358
|
last_synced_at?: string // date-time
|
|
4277
4359
|
current_updated_at?: string // date-time
|
|
4278
4360
|
error_message?: string
|
|
4361
|
+
is_hidden?: boolean
|
|
4362
|
+
co_owned_by?: Array<{
|
|
4363
|
+
blueprint_id: { ... }
|
|
4364
|
+
title?: { ... }
|
|
4365
|
+
}>
|
|
4279
4366
|
}>
|
|
4367
|
+
has_effective_changes?: boolean
|
|
4280
4368
|
}
|
|
4281
4369
|
```
|
|
4282
4370
|
|
|
@@ -4498,6 +4586,8 @@ type BlueprintVerificationJob = {
|
|
|
4498
4586
|
source_blueprint_id?: string
|
|
4499
4587
|
destination_org_id?: string
|
|
4500
4588
|
destination_blueprint_id?: string
|
|
4589
|
+
installation_job_id?: string
|
|
4590
|
+
sync_engine?: "terraform" | "v3"
|
|
4501
4591
|
status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED"
|
|
4502
4592
|
summary?: {
|
|
4503
4593
|
total_resources?: number
|
|
@@ -4510,8 +4600,14 @@ type BlueprintVerificationJob = {
|
|
|
4510
4600
|
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"
|
|
4511
4601
|
resource_name?: string
|
|
4512
4602
|
source_resource_id?: string
|
|
4603
|
+
source_resource_address?: string
|
|
4513
4604
|
destination_resource_id?: string
|
|
4605
|
+
destination_resource_address?: string
|
|
4514
4606
|
status?: "matched" | "mismatched" | "missing_in_destination" | "fetch_error"
|
|
4607
|
+
failure_context?: "depends_on_failed_resource" | "may_be_caused_by_failed_dependency"
|
|
4608
|
+
failed_dependency_resource_ids?: string[]
|
|
4609
|
+
failed_dependency_resource_names?: string[]
|
|
4610
|
+
failed_dependency_addresses?: string[]
|
|
4515
4611
|
field_diffs?: Array<{
|
|
4516
4612
|
path?: { ... }
|
|
4517
4613
|
source_value?: { ... }
|
|
@@ -4535,6 +4631,8 @@ type LatestBlueprintVerification = {
|
|
|
4535
4631
|
source_blueprint_id?: string
|
|
4536
4632
|
destination_org_id?: string
|
|
4537
4633
|
destination_blueprint_id?: string
|
|
4634
|
+
installation_job_id?: string
|
|
4635
|
+
sync_engine?: "terraform" | "v3"
|
|
4538
4636
|
summary?: {
|
|
4539
4637
|
total_resources?: number
|
|
4540
4638
|
matched?: number
|
|
@@ -4564,8 +4662,14 @@ type ResourceVerificationResult = {
|
|
|
4564
4662
|
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"
|
|
4565
4663
|
resource_name?: string
|
|
4566
4664
|
source_resource_id?: string
|
|
4665
|
+
source_resource_address?: string
|
|
4567
4666
|
destination_resource_id?: string
|
|
4667
|
+
destination_resource_address?: string
|
|
4568
4668
|
status?: "matched" | "mismatched" | "missing_in_destination" | "fetch_error"
|
|
4669
|
+
failure_context?: "depends_on_failed_resource" | "may_be_caused_by_failed_dependency"
|
|
4670
|
+
failed_dependency_resource_ids?: string[]
|
|
4671
|
+
failed_dependency_resource_names?: string[]
|
|
4672
|
+
failed_dependency_addresses?: string[]
|
|
4569
4673
|
field_diffs?: Array<{
|
|
4570
4674
|
path?: string
|
|
4571
4675
|
source_value?: unknown
|