@epilot/sdk 2.4.2 → 2.4.4-alpha.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -0
- package/definitions/app-runtime.json +1 -1
- package/definitions/app.json +346 -10
- package/definitions/automation.json +42 -0
- package/definitions/calendar-runtime.json +1 -0
- package/definitions/calendar.json +675 -0
- package/definitions/customer-portal.json +29 -0
- package/definitions/notes.json +175 -130
- package/definitions/pricing-runtime.json +1 -1
- package/definitions/pricing.json +163 -84
- package/dist/README-46VYEGGW.js +7 -0
- package/dist/README-IVBISSWB.cjs +7 -0
- package/dist/{_index-HE4B6FOA.js → _index-5FB6F5YY.js} +3 -0
- package/dist/{_index-55HAH24D.cjs → _index-DB2VV4PQ.cjs} +4 -1
- package/dist/apis/_registry.d.ts +8 -0
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.d.ts +9 -12
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.d.ts +9 -12
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.d.ts +9 -12
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.d.ts +9 -12
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.d.ts +9 -12
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.d.ts +9 -12
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.d.ts +9 -12
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.d.ts +9 -12
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.d.ts +9 -12
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +38 -0
- package/dist/apis/calendar.d.ts +15 -0
- package/dist/apis/calendar.js +38 -0
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.d.ts +9 -12
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.d.ts +9 -12
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.d.ts +9 -12
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.d.ts +9 -12
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.d.ts +9 -12
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.d.ts +9 -12
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.d.ts +9 -12
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.d.ts +9 -12
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.d.ts +9 -12
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.d.ts +9 -12
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.d.ts +9 -12
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.d.ts +9 -12
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.d.ts +9 -12
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.d.ts +9 -12
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.d.ts +9 -12
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.d.ts +9 -12
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.d.ts +9 -12
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.d.ts +9 -12
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.d.ts +9 -12
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.d.ts +9 -12
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.d.ts +9 -12
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.d.ts +9 -12
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.d.ts +9 -12
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.d.ts +9 -12
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.d.ts +9 -12
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.d.ts +9 -12
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.d.ts +9 -12
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +8 -8
- package/dist/apis/pricing.d.ts +9 -12
- package/dist/apis/pricing.js +2 -2
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.d.ts +9 -12
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.d.ts +9 -12
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.d.ts +9 -12
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.d.ts +9 -12
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.d.ts +9 -12
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.d.ts +9 -591
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.d.ts +9 -12
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.d.ts +9 -12
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.d.ts +9 -12
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.d.ts +9 -12
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.d.ts +9 -12
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.d.ts +9 -12
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.d.ts +9 -12
- package/dist/apis/workflow.js +1 -1
- package/dist/authorize.d.ts +3 -0
- package/dist/automation-BMO7ZFTN.cjs +7 -0
- package/dist/automation-MEZTSUR3.js +7 -0
- package/dist/bin/cli.d.ts +1 -0
- package/dist/bin/cli.js +1 -1
- package/dist/calendar-2YDAYG7S.cjs +7 -0
- package/dist/calendar-ACFIHQ2N.js +7 -0
- package/dist/calendar-runtime-6CMMEQMG.js +5 -0
- package/dist/calendar-runtime-G4SN5PDY.cjs +5 -0
- package/dist/{chunk-MEUS7LCE.js → chunk-63BFJKWV.js} +1 -1
- package/dist/{chunk-YLJD7G7H.cjs → chunk-CD4OX2U6.cjs} +7 -5
- package/dist/chunk-CKLEBO4K.cjs +14 -0
- package/dist/chunk-JNH37UUH.js +14 -0
- package/dist/{chunk-JXJC6WEW.cjs → chunk-KP7H52BF.cjs} +1 -1
- package/dist/{chunk-CQ3AKMIJ.js → chunk-TSV242UN.js} +7 -5
- package/dist/client-factory.d.ts +9 -0
- package/dist/client-map.d.ts +102 -0
- package/dist/compact.d.ts +22 -0
- package/dist/help.d.ts +12 -0
- package/dist/index.cjs +27 -19
- package/dist/index.d.ts +12 -180
- package/dist/index.js +22 -14
- package/dist/{js-yaml-DLCVPJ7G.js → js-yaml-UPZKYVRY.js} +15 -17
- package/dist/large-response.d.ts +9 -0
- package/dist/openapi.d.ts +12 -0
- package/dist/overrides.d.ts +9 -0
- package/dist/pricing-G67CH3XH.js +7 -0
- package/dist/pricing-XAET4G7T.cjs +7 -0
- package/dist/{pricing-runtime-JRR4FWFI.js → pricing-runtime-2YKEJJMZ.js} +1 -1
- package/dist/{pricing-runtime-6XNS4EOF.cjs → pricing-runtime-XDCOKL47.cjs} +2 -2
- package/dist/proxy.d.ts +14 -0
- package/dist/registry.d.ts +19 -0
- package/dist/retry.d.ts +11 -0
- package/dist/sdk.d.ts +29 -0
- package/dist/types.d.ts +53 -0
- package/docs/automation.md +42 -5
- package/docs/calendar.md +441 -0
- package/docs/pricing.md +39 -15
- package/package.json +10 -1
- package/dist/README-6MG272KM.cjs +0 -7
- package/dist/README-7N542PBL.js +0 -7
- package/dist/access-token.d-CnmUTOlq.d.cts +0 -552
- package/dist/access-token.d-CnmUTOlq.d.ts +0 -552
- package/dist/address-suggestions.d-_YwTOR-9.d.cts +0 -339
- package/dist/address-suggestions.d-_YwTOR-9.d.ts +0 -339
- package/dist/address.d-CwAPOVxa.d.cts +0 -437
- package/dist/address.d-CwAPOVxa.d.ts +0 -437
- package/dist/ai-agents.d-OkXfr2bz.d.cts +0 -1339
- package/dist/ai-agents.d-OkXfr2bz.d.ts +0 -1339
- package/dist/apis/access-token.d.cts +0 -18
- package/dist/apis/address-suggestions.d.cts +0 -18
- package/dist/apis/address.d.cts +0 -18
- package/dist/apis/ai-agents.d.cts +0 -18
- package/dist/apis/app.d.cts +0 -18
- package/dist/apis/audit-logs.d.cts +0 -18
- package/dist/apis/automation.d.cts +0 -18
- package/dist/apis/billing.d.cts +0 -18
- package/dist/apis/blueprint-manifest.d.cts +0 -18
- package/dist/apis/configuration-hub.d.cts +0 -18
- package/dist/apis/consent.d.cts +0 -18
- package/dist/apis/customer-portal.d.cts +0 -18
- package/dist/apis/dashboard.d.cts +0 -18
- package/dist/apis/data-governance.d.cts +0 -18
- package/dist/apis/deduplication.d.cts +0 -18
- package/dist/apis/design.d.cts +0 -18
- package/dist/apis/document.d.cts +0 -18
- package/dist/apis/email-settings.d.cts +0 -18
- package/dist/apis/email-template.d.cts +0 -18
- package/dist/apis/entity-mapping.d.cts +0 -18
- package/dist/apis/entity.d.cts +0 -18
- package/dist/apis/environments.d.cts +0 -18
- package/dist/apis/event-catalog.d.cts +0 -18
- package/dist/apis/file.d.cts +0 -18
- package/dist/apis/iban.d.cts +0 -18
- package/dist/apis/integration-toolkit.d.cts +0 -18
- package/dist/apis/journey.d.cts +0 -18
- package/dist/apis/kanban.d.cts +0 -18
- package/dist/apis/message.d.cts +0 -18
- package/dist/apis/metering.d.cts +0 -18
- package/dist/apis/notes.d.cts +0 -18
- package/dist/apis/notification.d.cts +0 -18
- package/dist/apis/organization.d.cts +0 -18
- package/dist/apis/partner-directory.d.cts +0 -18
- package/dist/apis/permissions.d.cts +0 -18
- package/dist/apis/pricing-tier.d.cts +0 -18
- package/dist/apis/pricing.d.cts +0 -18
- package/dist/apis/purpose.d.cts +0 -18
- package/dist/apis/query.d.cts +0 -18
- package/dist/apis/sandbox.d.cts +0 -18
- package/dist/apis/sharing.d.cts +0 -18
- package/dist/apis/submission.d.cts +0 -18
- package/dist/apis/target.d.cts +0 -597
- package/dist/apis/targeting.d.cts +0 -18
- package/dist/apis/template-variables.d.cts +0 -18
- package/dist/apis/user.d.cts +0 -18
- package/dist/apis/validation-rules.d.cts +0 -18
- package/dist/apis/webhooks.d.cts +0 -18
- package/dist/apis/workflow-definition.d.cts +0 -18
- package/dist/apis/workflow.d.cts +0 -18
- package/dist/app.d-u7Dq42kU.d.cts +0 -3391
- package/dist/app.d-u7Dq42kU.d.ts +0 -3391
- package/dist/audit-logs.d-BRToFqeX.d.cts +0 -287
- package/dist/audit-logs.d-BRToFqeX.d.ts +0 -287
- package/dist/automation-GFNNLSIN.js +0 -7
- package/dist/automation-IOCVCTKR.cjs +0 -7
- package/dist/automation.d-CzhG2m4L.d.cts +0 -5252
- package/dist/automation.d-CzhG2m4L.d.ts +0 -5252
- package/dist/billing.d-Bs8Ku9qE.d.cts +0 -993
- package/dist/billing.d-Bs8Ku9qE.d.ts +0 -993
- package/dist/blueprint-manifest.d-BPyzoR0X.d.cts +0 -4343
- package/dist/blueprint-manifest.d-BPyzoR0X.d.ts +0 -4343
- package/dist/configuration-hub.d-Cqaq2F-W.d.cts +0 -478
- package/dist/configuration-hub.d-Cqaq2F-W.d.ts +0 -478
- package/dist/consent.d-C2PROHhX.d.cts +0 -265
- package/dist/consent.d-C2PROHhX.d.ts +0 -265
- package/dist/customer-portal.d-DyZ2n2dW.d.cts +0 -16728
- package/dist/customer-portal.d-DyZ2n2dW.d.ts +0 -16728
- package/dist/dashboard.d-CsGcA74I.d.cts +0 -440
- package/dist/dashboard.d-CsGcA74I.d.ts +0 -440
- package/dist/data-governance.d-BbZ466j5.d.cts +0 -1178
- package/dist/data-governance.d-BbZ466j5.d.ts +0 -1178
- package/dist/deduplication.d-D5GYddVu.d.cts +0 -218
- package/dist/deduplication.d-D5GYddVu.d.ts +0 -218
- package/dist/design.d-BRre8iLg.d.cts +0 -2346
- package/dist/design.d-BRre8iLg.d.ts +0 -2346
- package/dist/document.d-DN37pjdx.d.cts +0 -648
- package/dist/document.d-DN37pjdx.d.ts +0 -648
- package/dist/email-settings.d-B7Q_xT25.d.cts +0 -2417
- package/dist/email-settings.d-B7Q_xT25.d.ts +0 -2417
- package/dist/email-template.d-gtQkdaXM.d.cts +0 -1188
- package/dist/email-template.d-gtQkdaXM.d.ts +0 -1188
- package/dist/entity-mapping.d-DKSW3sfy.d.cts +0 -1092
- package/dist/entity-mapping.d-DKSW3sfy.d.ts +0 -1092
- package/dist/entity.d-BHR9dEon.d.cts +0 -18479
- package/dist/entity.d-BHR9dEon.d.ts +0 -18479
- package/dist/environments.d-BvqvN-PD.d.cts +0 -382
- package/dist/environments.d-BvqvN-PD.d.ts +0 -382
- package/dist/event-catalog.d-ENw6HO-w.d.cts +0 -1511
- package/dist/event-catalog.d-ENw6HO-w.d.ts +0 -1511
- package/dist/file.d-DcTJxjp7.d.cts +0 -2992
- package/dist/file.d-DcTJxjp7.d.ts +0 -2992
- package/dist/iban.d-BwdiGbxi.d.cts +0 -70
- package/dist/iban.d-BwdiGbxi.d.ts +0 -70
- package/dist/index.d.cts +0 -180
- package/dist/integration-toolkit.d-Ry-KC9ow.d.cts +0 -5796
- package/dist/integration-toolkit.d-Ry-KC9ow.d.ts +0 -5796
- package/dist/journey.d-ClXO0xK8.d.cts +0 -1931
- package/dist/journey.d-ClXO0xK8.d.ts +0 -1931
- package/dist/kanban.d-BHnSRCYW.d.cts +0 -760
- package/dist/kanban.d-BHnSRCYW.d.ts +0 -760
- package/dist/message.d-B5UuSqgw.d.cts +0 -3811
- package/dist/message.d-B5UuSqgw.d.ts +0 -3811
- package/dist/metering.d-DvtPv7wk.d.cts +0 -1841
- package/dist/metering.d-DvtPv7wk.d.ts +0 -1841
- package/dist/notes.d-BC-scR42.d.cts +0 -1046
- package/dist/notes.d-BC-scR42.d.ts +0 -1046
- package/dist/notification.d-BfBL3lga.d.cts +0 -1147
- package/dist/notification.d-BfBL3lga.d.ts +0 -1147
- package/dist/organization.d-DqwnNxMg.d.cts +0 -1271
- package/dist/organization.d-DqwnNxMg.d.ts +0 -1271
- package/dist/partner-directory.d-BCIjHoGs.d.cts +0 -2337
- package/dist/partner-directory.d-BCIjHoGs.d.ts +0 -2337
- package/dist/permissions.d-l6AT8SYP.d.cts +0 -1279
- package/dist/permissions.d-l6AT8SYP.d.ts +0 -1279
- package/dist/pricing-4Z4TOETA.cjs +0 -7
- package/dist/pricing-C65DTZSX.js +0 -7
- package/dist/pricing-tier.d-Cg0jl6n_.d.cts +0 -81
- package/dist/pricing-tier.d-Cg0jl6n_.d.ts +0 -81
- package/dist/pricing.d-Cv39plGm.d.cts +0 -12200
- package/dist/pricing.d-Cv39plGm.d.ts +0 -12200
- package/dist/purpose.d-CbIYfTua.d.cts +0 -372
- package/dist/purpose.d-CbIYfTua.d.ts +0 -372
- package/dist/query.d-Cmp78IhZ.d.cts +0 -2375
- package/dist/query.d-Cmp78IhZ.d.ts +0 -2375
- package/dist/sandbox.d-BdbOFzDu.d.cts +0 -465
- package/dist/sandbox.d-BdbOFzDu.d.ts +0 -465
- package/dist/sharing.d-sOXq-gtz.d.cts +0 -571
- package/dist/sharing.d-sOXq-gtz.d.ts +0 -571
- package/dist/submission.d-BamwfhXw.d.cts +0 -469
- package/dist/submission.d-BamwfhXw.d.ts +0 -469
- package/dist/targeting.d-BNmcVsNS.d.cts +0 -2057
- package/dist/targeting.d-BNmcVsNS.d.ts +0 -2057
- package/dist/template-variables.d-Ble9TSBa.d.cts +0 -1320
- package/dist/template-variables.d-Ble9TSBa.d.ts +0 -1320
- package/dist/types-ChU9Acbv.d.cts +0 -37
- package/dist/types-ChU9Acbv.d.ts +0 -37
- package/dist/user.d-D18fe97W.d.cts +0 -2270
- package/dist/user.d-D18fe97W.d.ts +0 -2270
- package/dist/validation-rules.d-Db5c5zTf.d.cts +0 -807
- package/dist/validation-rules.d-Db5c5zTf.d.ts +0 -807
- package/dist/webhooks.d-pLHIL_io.d.cts +0 -1256
- package/dist/webhooks.d-pLHIL_io.d.ts +0 -1256
- package/dist/workflow-definition.d-DOeb0KVV.d.cts +0 -1922
- package/dist/workflow-definition.d-DOeb0KVV.d.ts +0 -1922
- package/dist/workflow.d-CMSKt8oN.d.cts +0 -3151
- package/dist/workflow.d-CMSKt8oN.d.ts +0 -3151
|
@@ -1,4343 +0,0 @@
|
|
|
1
|
-
import { OpenAPIClient, Parameters, AxiosRequestConfig, OperationResponse, UnknownParamsObject } from 'openapi-client-axios';
|
|
2
|
-
|
|
3
|
-
/* Auto-copied from blueprint-manifest-client */
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
declare namespace Components {
|
|
7
|
-
namespace Parameters {
|
|
8
|
-
export type JobID = /**
|
|
9
|
-
* ID of an import or export job (state machine)
|
|
10
|
-
* example:
|
|
11
|
-
* 4854bb2a-94f9-424d-a968-3fb17fb0bf89
|
|
12
|
-
*/
|
|
13
|
-
Schemas.JobID;
|
|
14
|
-
}
|
|
15
|
-
export interface PathParameters {
|
|
16
|
-
JobID?: Parameters.JobID;
|
|
17
|
-
}
|
|
18
|
-
namespace Schemas {
|
|
19
|
-
export interface AppBlueprint {
|
|
20
|
-
id?: /**
|
|
21
|
-
* ID of a blueprint
|
|
22
|
-
* example:
|
|
23
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
24
|
-
*/
|
|
25
|
-
BlueprintID;
|
|
26
|
-
title: string;
|
|
27
|
-
slug?: string;
|
|
28
|
-
description?: {
|
|
29
|
-
/**
|
|
30
|
-
* Markdown content shown before starting to install the blueprint
|
|
31
|
-
* example:
|
|
32
|
-
* This is the content of the preinstall.md file which contains the blueprint description.
|
|
33
|
-
*
|
|
34
|
-
*/
|
|
35
|
-
preinstall?: string;
|
|
36
|
-
/**
|
|
37
|
-
* Markdown content to be displayed when showing the plan to install blueprint
|
|
38
|
-
* example:
|
|
39
|
-
* This is the content of the postinstall.md file
|
|
40
|
-
*
|
|
41
|
-
*/
|
|
42
|
-
postinstall?: string;
|
|
43
|
-
};
|
|
44
|
-
version?: string;
|
|
45
|
-
deployments?: {
|
|
46
|
-
source_org_id?: string;
|
|
47
|
-
source_blueprint_id?: string;
|
|
48
|
-
destination_org_id?: string;
|
|
49
|
-
destination_blueprint_id?: string;
|
|
50
|
-
triggered_at?: string; // date-time
|
|
51
|
-
/**
|
|
52
|
-
* User-provided note about this synchronization
|
|
53
|
-
*/
|
|
54
|
-
note?: string;
|
|
55
|
-
}[];
|
|
56
|
-
/**
|
|
57
|
-
* Whether the blueprint is verified by epilot
|
|
58
|
-
*/
|
|
59
|
-
is_verified?: boolean;
|
|
60
|
-
latest_verification?: LatestBlueprintVerification;
|
|
61
|
-
/**
|
|
62
|
-
* Resource addresses excluded during the latest install/update and ignored by verification.
|
|
63
|
-
*/
|
|
64
|
-
ignored_resource_addresses?: string[];
|
|
65
|
-
installation_status?: "IN_PROGRESS" | "CANCELED" | "PARTIAL" | "SUCCESS" | "FAILED";
|
|
66
|
-
created_at?: string; // date-time
|
|
67
|
-
updated_at?: string; // date-time
|
|
68
|
-
created_by?: CallerIdentity;
|
|
69
|
-
updated_by?: CallerIdentity;
|
|
70
|
-
installation_job_ids?: /**
|
|
71
|
-
* ID of a job
|
|
72
|
-
* example:
|
|
73
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
74
|
-
*/
|
|
75
|
-
BlueprintJobID[];
|
|
76
|
-
/**
|
|
77
|
-
* ID of the blueprint that brought this blueprint to the destination org (deployed or installed)
|
|
78
|
-
* example:
|
|
79
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
80
|
-
*/
|
|
81
|
-
source_blueprint_id?: string;
|
|
82
|
-
/**
|
|
83
|
-
* Whether the blueprint is archived (soft-deleted). Archived blueprints are hidden from the main list.
|
|
84
|
-
*/
|
|
85
|
-
archived?: boolean;
|
|
86
|
-
/**
|
|
87
|
-
* URL to the blueprint documentation
|
|
88
|
-
*/
|
|
89
|
-
docs_url?: string;
|
|
90
|
-
/**
|
|
91
|
-
* List of recommended app IDs for the blueprint
|
|
92
|
-
*/
|
|
93
|
-
recommended_apps?: string[];
|
|
94
|
-
/**
|
|
95
|
-
* Feature constraints for blueprint installation
|
|
96
|
-
*/
|
|
97
|
-
required_features?: {
|
|
98
|
-
/**
|
|
99
|
-
* Features that must be enabled in the target org
|
|
100
|
-
*/
|
|
101
|
-
enabled?: string[];
|
|
102
|
-
/**
|
|
103
|
-
* Features that must be disabled in the target org
|
|
104
|
-
*/
|
|
105
|
-
disabled?: string[];
|
|
106
|
-
};
|
|
107
|
-
/**
|
|
108
|
-
* Custom name for the exported zip file
|
|
109
|
-
*/
|
|
110
|
-
zip_file_name?: string;
|
|
111
|
-
source_type: "app";
|
|
112
|
-
resources?: BlueprintResource[];
|
|
113
|
-
}
|
|
114
|
-
export type Blueprint = CustomBlueprint | FileBlueprint | MarketplaceBlueprint | DeployedBlueprint | AppBlueprint;
|
|
115
|
-
export interface BlueprintDependenciesSyncJob {
|
|
116
|
-
id?: /**
|
|
117
|
-
* ID of a job
|
|
118
|
-
* example:
|
|
119
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
120
|
-
*/
|
|
121
|
-
BlueprintJobID;
|
|
122
|
-
events?: BlueprintJobEvent[];
|
|
123
|
-
triggered_at?: string; // date-time
|
|
124
|
-
created_by?: CallerIdentity;
|
|
125
|
-
blueprint_id?: /**
|
|
126
|
-
* ID of a blueprint
|
|
127
|
-
* example:
|
|
128
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
129
|
-
*/
|
|
130
|
-
BlueprintID;
|
|
131
|
-
status?: "IN_PROGRESS" | "SUCCESS" | "FAILED" | "CANCELED";
|
|
132
|
-
}
|
|
133
|
-
export interface BlueprintExportJob {
|
|
134
|
-
id?: /**
|
|
135
|
-
* ID of a job
|
|
136
|
-
* example:
|
|
137
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
138
|
-
*/
|
|
139
|
-
BlueprintJobID;
|
|
140
|
-
events?: BlueprintJobEvent[];
|
|
141
|
-
triggered_at?: string; // date-time
|
|
142
|
-
created_by?: CallerIdentity;
|
|
143
|
-
blueprint_id?: /**
|
|
144
|
-
* ID of a blueprint
|
|
145
|
-
* example:
|
|
146
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
147
|
-
*/
|
|
148
|
-
BlueprintID;
|
|
149
|
-
status?: "IN_PROGRESS" | "SUCCESS" | "FAILED" | "CANCELED";
|
|
150
|
-
download_file?: S3Reference;
|
|
151
|
-
}
|
|
152
|
-
/**
|
|
153
|
-
* ID of a blueprint
|
|
154
|
-
* example:
|
|
155
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
156
|
-
*/
|
|
157
|
-
export type BlueprintID = string;
|
|
158
|
-
export type BlueprintInstallStatus = "SUCCESS" | "PARTIAL" | "FAILED";
|
|
159
|
-
export interface BlueprintInstallationJob {
|
|
160
|
-
id?: /**
|
|
161
|
-
* ID of a job
|
|
162
|
-
* example:
|
|
163
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
164
|
-
*/
|
|
165
|
-
BlueprintJobID;
|
|
166
|
-
events?: BlueprintJobEvent[];
|
|
167
|
-
triggered_at?: string; // date-time
|
|
168
|
-
created_by?: CallerIdentity;
|
|
169
|
-
source_blueprint_id?: /**
|
|
170
|
-
* ID of a blueprint
|
|
171
|
-
* example:
|
|
172
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
173
|
-
*/
|
|
174
|
-
BlueprintID;
|
|
175
|
-
source_blueprint_type?: "custom" | "file" | "marketplace" | "deploy" | "app";
|
|
176
|
-
source_org_id?: string;
|
|
177
|
-
source_blueprint_file?: string;
|
|
178
|
-
destination_blueprint_id?: /**
|
|
179
|
-
* ID of a blueprint
|
|
180
|
-
* example:
|
|
181
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
182
|
-
*/
|
|
183
|
-
BlueprintID;
|
|
184
|
-
destination_org_id?: string;
|
|
185
|
-
/**
|
|
186
|
-
* Blueprint slug for marketplace blueprints
|
|
187
|
-
*/
|
|
188
|
-
slug?: string;
|
|
189
|
-
status?: "IN_PROGRESS" | "WAITING_USER_ACTION" | "CANCELED" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED";
|
|
190
|
-
}
|
|
191
|
-
export interface BlueprintInstallationJobOptions {
|
|
192
|
-
/**
|
|
193
|
-
* List of resource addresses to ignore changes for. When a resource is marked as create, it will be ignored and not created.
|
|
194
|
-
*/
|
|
195
|
-
resources_to_ignore?: string[];
|
|
196
|
-
}
|
|
197
|
-
export type BlueprintJob = BlueprintExportJob | BlueprintInstallationJob | BlueprintDependenciesSyncJob | BlueprintValidateJob | BlueprintVerificationJob;
|
|
198
|
-
export interface BlueprintJobEvent {
|
|
199
|
-
timestamp?: string; // date-time
|
|
200
|
-
message?: string;
|
|
201
|
-
errors?: FormattedError[];
|
|
202
|
-
level?: "info" | "warning" | "error";
|
|
203
|
-
data?: {
|
|
204
|
-
installed_blueprint_id?: /**
|
|
205
|
-
* ID of a blueprint
|
|
206
|
-
* example:
|
|
207
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
208
|
-
*/
|
|
209
|
-
BlueprintID;
|
|
210
|
-
export_job_id?: /**
|
|
211
|
-
* ID of a job
|
|
212
|
-
* example:
|
|
213
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
214
|
-
*/
|
|
215
|
-
BlueprintJobID;
|
|
216
|
-
resources?: number;
|
|
217
|
-
};
|
|
218
|
-
}
|
|
219
|
-
/**
|
|
220
|
-
* ID of a job
|
|
221
|
-
* example:
|
|
222
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
223
|
-
*/
|
|
224
|
-
export type BlueprintJobID = string;
|
|
225
|
-
/**
|
|
226
|
-
* Preview data for a blueprint before installation. Stored temporarily with TTL.
|
|
227
|
-
*/
|
|
228
|
-
export interface BlueprintPreview {
|
|
229
|
-
/**
|
|
230
|
-
* Unique preview ID
|
|
231
|
-
*/
|
|
232
|
-
id: string;
|
|
233
|
-
/**
|
|
234
|
-
* Organization ID
|
|
235
|
-
*/
|
|
236
|
-
org_id: string;
|
|
237
|
-
title: string;
|
|
238
|
-
description?: {
|
|
239
|
-
preinstall?: string;
|
|
240
|
-
};
|
|
241
|
-
version?: string;
|
|
242
|
-
slug?: string;
|
|
243
|
-
source_type: "marketplace" | "file";
|
|
244
|
-
/**
|
|
245
|
-
* S3 key of the blueprint zip file
|
|
246
|
-
*/
|
|
247
|
-
blueprint_file_s3_key: string;
|
|
248
|
-
is_verified: boolean;
|
|
249
|
-
docs_url?: string;
|
|
250
|
-
recommended_apps?: string[];
|
|
251
|
-
required_features?: {
|
|
252
|
-
enabled?: string[];
|
|
253
|
-
disabled?: string[];
|
|
254
|
-
};
|
|
255
|
-
created_at: string; // date-time
|
|
256
|
-
created_by: CallerIdentity;
|
|
257
|
-
/**
|
|
258
|
-
* Whether the blueprint is updating to the latest version in the marketplace
|
|
259
|
-
*/
|
|
260
|
-
is_updating: boolean;
|
|
261
|
-
resources: BlueprintResource[];
|
|
262
|
-
}
|
|
263
|
-
export interface BlueprintResource {
|
|
264
|
-
id: /**
|
|
265
|
-
* ID of a blueprint resource
|
|
266
|
-
* example:
|
|
267
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
268
|
-
*/
|
|
269
|
-
BlueprintResourceID;
|
|
270
|
-
name?: string;
|
|
271
|
-
type: /* Type of the resource */ ResourceNodeType;
|
|
272
|
-
address?: string;
|
|
273
|
-
/**
|
|
274
|
-
* When a resource is marked as root, we'll be able to keep track of it's dependencies
|
|
275
|
-
*/
|
|
276
|
-
is_root?: boolean;
|
|
277
|
-
/**
|
|
278
|
-
* when editing a blueprint, this indicates if the resource is ready to be exported and when installing a blueprint, this indicates if the resource is ready to be used
|
|
279
|
-
*/
|
|
280
|
-
is_ready?: boolean;
|
|
281
|
-
/**
|
|
282
|
-
* When a resource is marked as hidden, it's used to hide it from the UI
|
|
283
|
-
*/
|
|
284
|
-
is_hidden?: boolean;
|
|
285
|
-
/**
|
|
286
|
-
* When a resource is marked as disabled, it will be skipped during export
|
|
287
|
-
*/
|
|
288
|
-
is_disabled?: boolean;
|
|
289
|
-
hard_dependencies?: /* Type of the resource */ ResourceNodeType[];
|
|
290
|
-
/**
|
|
291
|
-
* Used to automatically remove resources with hard dependencies and to block deletion of resources with hard dependencies
|
|
292
|
-
*/
|
|
293
|
-
parent_resource_ids?: /**
|
|
294
|
-
* ID of a blueprint resource
|
|
295
|
-
* example:
|
|
296
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
297
|
-
*/
|
|
298
|
-
BlueprintResourceID[];
|
|
299
|
-
/**
|
|
300
|
-
* Terraform addresses this resource references (for dependency-aware ignore)
|
|
301
|
-
*/
|
|
302
|
-
depends_on_addresses?: string[];
|
|
303
|
-
impact_on_install?: ("create" | "update" | "internal-update" | "no-op" | "delete" | "ignored")[];
|
|
304
|
-
/**
|
|
305
|
-
* Fields causing the updates / internal updates on a resource install
|
|
306
|
-
*/
|
|
307
|
-
impact_on_install_reason?: string[];
|
|
308
|
-
}
|
|
309
|
-
/**
|
|
310
|
-
* ID of a blueprint resource
|
|
311
|
-
* example:
|
|
312
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
313
|
-
*/
|
|
314
|
-
export type BlueprintResourceID = string;
|
|
315
|
-
export interface BlueprintValidateJob {
|
|
316
|
-
id?: /**
|
|
317
|
-
* ID of a job
|
|
318
|
-
* example:
|
|
319
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
320
|
-
*/
|
|
321
|
-
BlueprintJobID;
|
|
322
|
-
events?: BlueprintJobEvent[];
|
|
323
|
-
triggered_at?: string; // date-time
|
|
324
|
-
created_by?: CallerIdentity;
|
|
325
|
-
blueprint_id?: /**
|
|
326
|
-
* ID of a blueprint
|
|
327
|
-
* example:
|
|
328
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
329
|
-
*/
|
|
330
|
-
BlueprintID;
|
|
331
|
-
status?: "IN_PROGRESS" | "SUCCESS" | "FAILED";
|
|
332
|
-
/**
|
|
333
|
-
* Present when status is SUCCESS or FAILED.
|
|
334
|
-
*/
|
|
335
|
-
valid?: boolean;
|
|
336
|
-
/**
|
|
337
|
-
* Present when valid is false.
|
|
338
|
-
*/
|
|
339
|
-
errors?: FormattedError[];
|
|
340
|
-
}
|
|
341
|
-
export interface BlueprintVerificationJob {
|
|
342
|
-
id?: /**
|
|
343
|
-
* ID of a job
|
|
344
|
-
* example:
|
|
345
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
346
|
-
*/
|
|
347
|
-
BlueprintJobID;
|
|
348
|
-
events?: BlueprintJobEvent[];
|
|
349
|
-
triggered_at?: string; // date-time
|
|
350
|
-
created_by?: CallerIdentity;
|
|
351
|
-
source_org_id?: string;
|
|
352
|
-
source_blueprint_id?: /**
|
|
353
|
-
* ID of a blueprint
|
|
354
|
-
* example:
|
|
355
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
356
|
-
*/
|
|
357
|
-
BlueprintID;
|
|
358
|
-
destination_org_id?: string;
|
|
359
|
-
destination_blueprint_id?: /**
|
|
360
|
-
* ID of a blueprint
|
|
361
|
-
* example:
|
|
362
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
363
|
-
*/
|
|
364
|
-
BlueprintID;
|
|
365
|
-
status?: "IN_PROGRESS" | "SUCCESS" | "FAILED";
|
|
366
|
-
summary?: VerificationSummary;
|
|
367
|
-
resource_results?: ResourceVerificationResult[];
|
|
368
|
-
/**
|
|
369
|
-
* S3 key for detailed results when too large for inline storage.
|
|
370
|
-
*/
|
|
371
|
-
resource_results_s3_key?: string;
|
|
372
|
-
}
|
|
373
|
-
export interface CallerIdentity {
|
|
374
|
-
/**
|
|
375
|
-
* a human readable name of the caller (e.g. user name, token name or email address)
|
|
376
|
-
* example:
|
|
377
|
-
* manifest@epilot.cloud
|
|
378
|
-
*/
|
|
379
|
-
name?: any;
|
|
380
|
-
/**
|
|
381
|
-
* epilot organization id
|
|
382
|
-
* example:
|
|
383
|
-
* 911690
|
|
384
|
-
*/
|
|
385
|
-
org_id: string;
|
|
386
|
-
/**
|
|
387
|
-
* epilot user id, when called by a user
|
|
388
|
-
* example:
|
|
389
|
-
* 11001045
|
|
390
|
-
*/
|
|
391
|
-
user_id?: string;
|
|
392
|
-
/**
|
|
393
|
-
* token id, when called by API token
|
|
394
|
-
* example:
|
|
395
|
-
* api_5ZugdRXasLfWBypHi93Fk
|
|
396
|
-
*/
|
|
397
|
-
token_id?: string;
|
|
398
|
-
}
|
|
399
|
-
export interface CommonBlueprintFields {
|
|
400
|
-
id?: /**
|
|
401
|
-
* ID of a blueprint
|
|
402
|
-
* example:
|
|
403
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
404
|
-
*/
|
|
405
|
-
BlueprintID;
|
|
406
|
-
title: string;
|
|
407
|
-
slug?: string;
|
|
408
|
-
description?: {
|
|
409
|
-
/**
|
|
410
|
-
* Markdown content shown before starting to install the blueprint
|
|
411
|
-
* example:
|
|
412
|
-
* This is the content of the preinstall.md file which contains the blueprint description.
|
|
413
|
-
*
|
|
414
|
-
*/
|
|
415
|
-
preinstall?: string;
|
|
416
|
-
/**
|
|
417
|
-
* Markdown content to be displayed when showing the plan to install blueprint
|
|
418
|
-
* example:
|
|
419
|
-
* This is the content of the postinstall.md file
|
|
420
|
-
*
|
|
421
|
-
*/
|
|
422
|
-
postinstall?: string;
|
|
423
|
-
};
|
|
424
|
-
version?: string;
|
|
425
|
-
deployments?: {
|
|
426
|
-
source_org_id?: string;
|
|
427
|
-
source_blueprint_id?: string;
|
|
428
|
-
destination_org_id?: string;
|
|
429
|
-
destination_blueprint_id?: string;
|
|
430
|
-
triggered_at?: string; // date-time
|
|
431
|
-
/**
|
|
432
|
-
* User-provided note about this synchronization
|
|
433
|
-
*/
|
|
434
|
-
note?: string;
|
|
435
|
-
}[];
|
|
436
|
-
/**
|
|
437
|
-
* Whether the blueprint is verified by epilot
|
|
438
|
-
*/
|
|
439
|
-
is_verified?: boolean;
|
|
440
|
-
latest_verification?: LatestBlueprintVerification;
|
|
441
|
-
/**
|
|
442
|
-
* Resource addresses excluded during the latest install/update and ignored by verification.
|
|
443
|
-
*/
|
|
444
|
-
ignored_resource_addresses?: string[];
|
|
445
|
-
installation_status?: "IN_PROGRESS" | "CANCELED" | "PARTIAL" | "SUCCESS" | "FAILED";
|
|
446
|
-
created_at?: string; // date-time
|
|
447
|
-
updated_at?: string; // date-time
|
|
448
|
-
created_by?: CallerIdentity;
|
|
449
|
-
updated_by?: CallerIdentity;
|
|
450
|
-
installation_job_ids?: /**
|
|
451
|
-
* ID of a job
|
|
452
|
-
* example:
|
|
453
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
454
|
-
*/
|
|
455
|
-
BlueprintJobID[];
|
|
456
|
-
/**
|
|
457
|
-
* ID of the blueprint that brought this blueprint to the destination org (deployed or installed)
|
|
458
|
-
* example:
|
|
459
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
460
|
-
*/
|
|
461
|
-
source_blueprint_id?: string;
|
|
462
|
-
/**
|
|
463
|
-
* Whether the blueprint is archived (soft-deleted). Archived blueprints are hidden from the main list.
|
|
464
|
-
*/
|
|
465
|
-
archived?: boolean;
|
|
466
|
-
/**
|
|
467
|
-
* URL to the blueprint documentation
|
|
468
|
-
*/
|
|
469
|
-
docs_url?: string;
|
|
470
|
-
/**
|
|
471
|
-
* List of recommended app IDs for the blueprint
|
|
472
|
-
*/
|
|
473
|
-
recommended_apps?: string[];
|
|
474
|
-
/**
|
|
475
|
-
* Feature constraints for blueprint installation
|
|
476
|
-
*/
|
|
477
|
-
required_features?: {
|
|
478
|
-
/**
|
|
479
|
-
* Features that must be enabled in the target org
|
|
480
|
-
*/
|
|
481
|
-
enabled?: string[];
|
|
482
|
-
/**
|
|
483
|
-
* Features that must be disabled in the target org
|
|
484
|
-
*/
|
|
485
|
-
disabled?: string[];
|
|
486
|
-
};
|
|
487
|
-
/**
|
|
488
|
-
* Custom name for the exported zip file
|
|
489
|
-
*/
|
|
490
|
-
zip_file_name?: string;
|
|
491
|
-
}
|
|
492
|
-
export interface CommonBlueprintJobFields {
|
|
493
|
-
id?: /**
|
|
494
|
-
* ID of a job
|
|
495
|
-
* example:
|
|
496
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
497
|
-
*/
|
|
498
|
-
BlueprintJobID;
|
|
499
|
-
events?: BlueprintJobEvent[];
|
|
500
|
-
triggered_at?: string; // date-time
|
|
501
|
-
created_by?: CallerIdentity;
|
|
502
|
-
}
|
|
503
|
-
export interface CommonImportFields {
|
|
504
|
-
source_type?: ManifestSource;
|
|
505
|
-
/**
|
|
506
|
-
* An array of tree-like JSON objects or a singular tree-like JSON object representing the resources to import
|
|
507
|
-
*/
|
|
508
|
-
imported_resources?: /* An array of tree-like JSON objects or a singular tree-like JSON object representing the resources to import */ RootResourceNode[] | RootResourceNode;
|
|
509
|
-
/**
|
|
510
|
-
* An URL to download the imported resources when the resources are too large to be included in the response
|
|
511
|
-
* example:
|
|
512
|
-
* https://blueprint-manifest-prod.s3.eu-central-1.amazonaws.com/large.json
|
|
513
|
-
*/
|
|
514
|
-
large_imported_resources_url?: string; // uri
|
|
515
|
-
}
|
|
516
|
-
export interface CommonManifestFields {
|
|
517
|
-
manifest_id?: /**
|
|
518
|
-
* ID of an imported / installed manifest
|
|
519
|
-
* example:
|
|
520
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
521
|
-
*/
|
|
522
|
-
ManifestID;
|
|
523
|
-
source_type?: ManifestSource;
|
|
524
|
-
/**
|
|
525
|
-
* example:
|
|
526
|
-
* Solar B2B
|
|
527
|
-
*/
|
|
528
|
-
source_blueprint_name?: string;
|
|
529
|
-
/**
|
|
530
|
-
* URL slug of a blueprint from the epilot marketplace
|
|
531
|
-
* example:
|
|
532
|
-
* solar-b2b
|
|
533
|
-
*/
|
|
534
|
-
source_blueprint_slug?: string;
|
|
535
|
-
/**
|
|
536
|
-
* Version of the blueprint (semver)
|
|
537
|
-
* example:
|
|
538
|
-
* 1.0.0
|
|
539
|
-
*/
|
|
540
|
-
source_blueprint_version?: string;
|
|
541
|
-
pre_install_requirements?: /**
|
|
542
|
-
* List of feature settings that must be enabled before installing the blueprint
|
|
543
|
-
* example:
|
|
544
|
-
* [
|
|
545
|
-
* "journey_automation",
|
|
546
|
-
* "ticket-entities",
|
|
547
|
-
* "advanced_permissions"
|
|
548
|
-
* ]
|
|
549
|
-
*/
|
|
550
|
-
PreInstallRequirements;
|
|
551
|
-
/**
|
|
552
|
-
* A URL to download the source blueprint file used to import the blueprint
|
|
553
|
-
* example:
|
|
554
|
-
* https://blueprint-manifest-prod.s3.eu-central-1.amazonaws.com/manifest.zip
|
|
555
|
-
*/
|
|
556
|
-
source_blueprint_file?: string;
|
|
557
|
-
/**
|
|
558
|
-
* Link to the blueprint documentation
|
|
559
|
-
* example:
|
|
560
|
-
* https://help.epilot.cloud
|
|
561
|
-
*/
|
|
562
|
-
docs_link?: string;
|
|
563
|
-
source_blueprint_file_ref?: S3Reference;
|
|
564
|
-
install_status?: BlueprintInstallStatus;
|
|
565
|
-
/**
|
|
566
|
-
* example:
|
|
567
|
-
* This blueprint installation resulted in a partial deployment; some resources were created successfully, but failed to complete the full resource setup.
|
|
568
|
-
*/
|
|
569
|
-
install_status_description?: string;
|
|
570
|
-
/**
|
|
571
|
-
* Whether the manifest comes from a trusted source and is signed by epilot
|
|
572
|
-
*/
|
|
573
|
-
is_verified?: boolean;
|
|
574
|
-
created_by?: CallerIdentity;
|
|
575
|
-
updated_by?: CallerIdentity;
|
|
576
|
-
/**
|
|
577
|
-
* Version of the manifest (semver)
|
|
578
|
-
* example:
|
|
579
|
-
* 1.0.0
|
|
580
|
-
*/
|
|
581
|
-
manifest_version?: string;
|
|
582
|
-
/**
|
|
583
|
-
* All the resources that were selected to be exported, used to pre-select the resources when updating a sandbox manifest
|
|
584
|
-
* example:
|
|
585
|
-
* https://blueprint-manifest-prod.s3.eu-central-1.amazonaws.com/selected_resources.json
|
|
586
|
-
*/
|
|
587
|
-
selected_resources_url?: string;
|
|
588
|
-
/**
|
|
589
|
-
* All the resources that were marked as ready by the user
|
|
590
|
-
* example:
|
|
591
|
-
* https://blueprint-manifest-prod.s3.eu-central-1.amazonaws.com/ready_imported_resources.json
|
|
592
|
-
*/
|
|
593
|
-
ready_imported_resources_url?: string;
|
|
594
|
-
/**
|
|
595
|
-
* Information about the manifest that was deployed from, used to update existing deployments instead of always creating new ones
|
|
596
|
-
*/
|
|
597
|
-
deployed_from?: {
|
|
598
|
-
/**
|
|
599
|
-
* ID of the organization that deployed the manifest
|
|
600
|
-
*/
|
|
601
|
-
source_organization_id?: string;
|
|
602
|
-
/**
|
|
603
|
-
* ID of the manifest that was deployed
|
|
604
|
-
*/
|
|
605
|
-
source_manifest_id?: string;
|
|
606
|
-
source_organization_type?: "sandbox" | "production";
|
|
607
|
-
/**
|
|
608
|
-
* When the deployment was last triggered
|
|
609
|
-
*/
|
|
610
|
-
last_triggered_at?: string; // date-time
|
|
611
|
-
};
|
|
612
|
-
/**
|
|
613
|
-
* Information about the manifest that was deployed to, used to update existing deployments instead of always creating new ones
|
|
614
|
-
*/
|
|
615
|
-
deployed_to?: {
|
|
616
|
-
/**
|
|
617
|
-
* ID of the organization that the manifest was deployed to
|
|
618
|
-
*/
|
|
619
|
-
destination_organization_id?: string;
|
|
620
|
-
/**
|
|
621
|
-
* ID of the manifest that was deployed to
|
|
622
|
-
*/
|
|
623
|
-
destination_manifest_id?: string;
|
|
624
|
-
destination_organization_type?: "sandbox" | "production";
|
|
625
|
-
/**
|
|
626
|
-
* When the deployment was last triggered
|
|
627
|
-
*/
|
|
628
|
-
last_triggered_at?: string; // date-time
|
|
629
|
-
}[];
|
|
630
|
-
}
|
|
631
|
-
export interface CommonMarkdownFields {
|
|
632
|
-
/**
|
|
633
|
-
* Markdown content part of a manifest file
|
|
634
|
-
*/
|
|
635
|
-
markdown?: {
|
|
636
|
-
/**
|
|
637
|
-
* Markdown content shown before installing the manifest
|
|
638
|
-
* example:
|
|
639
|
-
* This is the content of the manifest.md file which contains the manifest descripton.
|
|
640
|
-
*
|
|
641
|
-
*/
|
|
642
|
-
manifest?: string;
|
|
643
|
-
/**
|
|
644
|
-
* Markdown content to be displayed when showing the plan to install blueprint
|
|
645
|
-
* example:
|
|
646
|
-
* This is the content of the preinstall.md file
|
|
647
|
-
*
|
|
648
|
-
*/
|
|
649
|
-
preinstall?: string;
|
|
650
|
-
/**
|
|
651
|
-
* Markdown content to be displayed when showing the plan to install blueprint
|
|
652
|
-
* example:
|
|
653
|
-
* This is the content of the postinstall.md file
|
|
654
|
-
*
|
|
655
|
-
*/
|
|
656
|
-
postinstall?: string;
|
|
657
|
-
};
|
|
658
|
-
}
|
|
659
|
-
export interface CommonResourceNode {
|
|
660
|
-
/**
|
|
661
|
-
* ID of the resource
|
|
662
|
-
*/
|
|
663
|
-
id: string;
|
|
664
|
-
type: /* Type of the resource */ ResourceNodeType;
|
|
665
|
-
/**
|
|
666
|
-
* Name of the resource
|
|
667
|
-
*/
|
|
668
|
-
name?: string;
|
|
669
|
-
/**
|
|
670
|
-
* Source ID of the resource
|
|
671
|
-
*/
|
|
672
|
-
source_id?: string;
|
|
673
|
-
/**
|
|
674
|
-
* Whether the resource is virtual
|
|
675
|
-
*/
|
|
676
|
-
is_virtual?: boolean;
|
|
677
|
-
}
|
|
678
|
-
export interface CustomBlueprint {
|
|
679
|
-
id?: /**
|
|
680
|
-
* ID of a blueprint
|
|
681
|
-
* example:
|
|
682
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
683
|
-
*/
|
|
684
|
-
BlueprintID;
|
|
685
|
-
title: string;
|
|
686
|
-
slug?: string;
|
|
687
|
-
description?: {
|
|
688
|
-
/**
|
|
689
|
-
* Markdown content shown before starting to install the blueprint
|
|
690
|
-
* example:
|
|
691
|
-
* This is the content of the preinstall.md file which contains the blueprint description.
|
|
692
|
-
*
|
|
693
|
-
*/
|
|
694
|
-
preinstall?: string;
|
|
695
|
-
/**
|
|
696
|
-
* Markdown content to be displayed when showing the plan to install blueprint
|
|
697
|
-
* example:
|
|
698
|
-
* This is the content of the postinstall.md file
|
|
699
|
-
*
|
|
700
|
-
*/
|
|
701
|
-
postinstall?: string;
|
|
702
|
-
};
|
|
703
|
-
version?: string;
|
|
704
|
-
deployments?: {
|
|
705
|
-
source_org_id?: string;
|
|
706
|
-
source_blueprint_id?: string;
|
|
707
|
-
destination_org_id?: string;
|
|
708
|
-
destination_blueprint_id?: string;
|
|
709
|
-
triggered_at?: string; // date-time
|
|
710
|
-
/**
|
|
711
|
-
* User-provided note about this synchronization
|
|
712
|
-
*/
|
|
713
|
-
note?: string;
|
|
714
|
-
}[];
|
|
715
|
-
/**
|
|
716
|
-
* Whether the blueprint is verified by epilot
|
|
717
|
-
*/
|
|
718
|
-
is_verified?: boolean;
|
|
719
|
-
latest_verification?: LatestBlueprintVerification;
|
|
720
|
-
/**
|
|
721
|
-
* Resource addresses excluded during the latest install/update and ignored by verification.
|
|
722
|
-
*/
|
|
723
|
-
ignored_resource_addresses?: string[];
|
|
724
|
-
installation_status?: "IN_PROGRESS" | "CANCELED" | "PARTIAL" | "SUCCESS" | "FAILED";
|
|
725
|
-
created_at?: string; // date-time
|
|
726
|
-
updated_at?: string; // date-time
|
|
727
|
-
created_by?: CallerIdentity;
|
|
728
|
-
updated_by?: CallerIdentity;
|
|
729
|
-
installation_job_ids?: /**
|
|
730
|
-
* ID of a job
|
|
731
|
-
* example:
|
|
732
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
733
|
-
*/
|
|
734
|
-
BlueprintJobID[];
|
|
735
|
-
/**
|
|
736
|
-
* ID of the blueprint that brought this blueprint to the destination org (deployed or installed)
|
|
737
|
-
* example:
|
|
738
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
739
|
-
*/
|
|
740
|
-
source_blueprint_id?: string;
|
|
741
|
-
/**
|
|
742
|
-
* Whether the blueprint is archived (soft-deleted). Archived blueprints are hidden from the main list.
|
|
743
|
-
*/
|
|
744
|
-
archived?: boolean;
|
|
745
|
-
/**
|
|
746
|
-
* URL to the blueprint documentation
|
|
747
|
-
*/
|
|
748
|
-
docs_url?: string;
|
|
749
|
-
/**
|
|
750
|
-
* List of recommended app IDs for the blueprint
|
|
751
|
-
*/
|
|
752
|
-
recommended_apps?: string[];
|
|
753
|
-
/**
|
|
754
|
-
* Feature constraints for blueprint installation
|
|
755
|
-
*/
|
|
756
|
-
required_features?: {
|
|
757
|
-
/**
|
|
758
|
-
* Features that must be enabled in the target org
|
|
759
|
-
*/
|
|
760
|
-
enabled?: string[];
|
|
761
|
-
/**
|
|
762
|
-
* Features that must be disabled in the target org
|
|
763
|
-
*/
|
|
764
|
-
disabled?: string[];
|
|
765
|
-
};
|
|
766
|
-
/**
|
|
767
|
-
* Custom name for the exported zip file
|
|
768
|
-
*/
|
|
769
|
-
zip_file_name?: string;
|
|
770
|
-
resources?: BlueprintResource[];
|
|
771
|
-
source_type: "custom";
|
|
772
|
-
}
|
|
773
|
-
export interface DeployedBlueprint {
|
|
774
|
-
id?: /**
|
|
775
|
-
* ID of a blueprint
|
|
776
|
-
* example:
|
|
777
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
778
|
-
*/
|
|
779
|
-
BlueprintID;
|
|
780
|
-
title: string;
|
|
781
|
-
slug?: string;
|
|
782
|
-
description?: {
|
|
783
|
-
/**
|
|
784
|
-
* Markdown content shown before starting to install the blueprint
|
|
785
|
-
* example:
|
|
786
|
-
* This is the content of the preinstall.md file which contains the blueprint description.
|
|
787
|
-
*
|
|
788
|
-
*/
|
|
789
|
-
preinstall?: string;
|
|
790
|
-
/**
|
|
791
|
-
* Markdown content to be displayed when showing the plan to install blueprint
|
|
792
|
-
* example:
|
|
793
|
-
* This is the content of the postinstall.md file
|
|
794
|
-
*
|
|
795
|
-
*/
|
|
796
|
-
postinstall?: string;
|
|
797
|
-
};
|
|
798
|
-
version?: string;
|
|
799
|
-
deployments?: {
|
|
800
|
-
source_org_id?: string;
|
|
801
|
-
source_blueprint_id?: string;
|
|
802
|
-
destination_org_id?: string;
|
|
803
|
-
destination_blueprint_id?: string;
|
|
804
|
-
triggered_at?: string; // date-time
|
|
805
|
-
/**
|
|
806
|
-
* User-provided note about this synchronization
|
|
807
|
-
*/
|
|
808
|
-
note?: string;
|
|
809
|
-
}[];
|
|
810
|
-
/**
|
|
811
|
-
* Whether the blueprint is verified by epilot
|
|
812
|
-
*/
|
|
813
|
-
is_verified?: boolean;
|
|
814
|
-
latest_verification?: LatestBlueprintVerification;
|
|
815
|
-
/**
|
|
816
|
-
* Resource addresses excluded during the latest install/update and ignored by verification.
|
|
817
|
-
*/
|
|
818
|
-
ignored_resource_addresses?: string[];
|
|
819
|
-
installation_status?: "IN_PROGRESS" | "CANCELED" | "PARTIAL" | "SUCCESS" | "FAILED";
|
|
820
|
-
created_at?: string; // date-time
|
|
821
|
-
updated_at?: string; // date-time
|
|
822
|
-
created_by?: CallerIdentity;
|
|
823
|
-
updated_by?: CallerIdentity;
|
|
824
|
-
installation_job_ids?: /**
|
|
825
|
-
* ID of a job
|
|
826
|
-
* example:
|
|
827
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
828
|
-
*/
|
|
829
|
-
BlueprintJobID[];
|
|
830
|
-
/**
|
|
831
|
-
* ID of the blueprint that brought this blueprint to the destination org (deployed or installed)
|
|
832
|
-
* example:
|
|
833
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
834
|
-
*/
|
|
835
|
-
source_blueprint_id?: string;
|
|
836
|
-
/**
|
|
837
|
-
* Whether the blueprint is archived (soft-deleted). Archived blueprints are hidden from the main list.
|
|
838
|
-
*/
|
|
839
|
-
archived?: boolean;
|
|
840
|
-
/**
|
|
841
|
-
* URL to the blueprint documentation
|
|
842
|
-
*/
|
|
843
|
-
docs_url?: string;
|
|
844
|
-
/**
|
|
845
|
-
* List of recommended app IDs for the blueprint
|
|
846
|
-
*/
|
|
847
|
-
recommended_apps?: string[];
|
|
848
|
-
/**
|
|
849
|
-
* Feature constraints for blueprint installation
|
|
850
|
-
*/
|
|
851
|
-
required_features?: {
|
|
852
|
-
/**
|
|
853
|
-
* Features that must be enabled in the target org
|
|
854
|
-
*/
|
|
855
|
-
enabled?: string[];
|
|
856
|
-
/**
|
|
857
|
-
* Features that must be disabled in the target org
|
|
858
|
-
*/
|
|
859
|
-
disabled?: string[];
|
|
860
|
-
};
|
|
861
|
-
/**
|
|
862
|
-
* Custom name for the exported zip file
|
|
863
|
-
*/
|
|
864
|
-
zip_file_name?: string;
|
|
865
|
-
source_type: "deploy";
|
|
866
|
-
resources?: BlueprintResource[];
|
|
867
|
-
}
|
|
868
|
-
export interface FieldDiff {
|
|
869
|
-
/**
|
|
870
|
-
* JSON path to the differing field (e.g. "steps[2].name")
|
|
871
|
-
*/
|
|
872
|
-
path?: string;
|
|
873
|
-
source_value?: any;
|
|
874
|
-
destination_value?: any;
|
|
875
|
-
diff_type?: "value_changed" | "field_missing_in_destination" | "field_missing_in_source" | "type_mismatch";
|
|
876
|
-
}
|
|
877
|
-
export interface FileBlueprint {
|
|
878
|
-
id?: /**
|
|
879
|
-
* ID of a blueprint
|
|
880
|
-
* example:
|
|
881
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
882
|
-
*/
|
|
883
|
-
BlueprintID;
|
|
884
|
-
title: string;
|
|
885
|
-
slug?: string;
|
|
886
|
-
description?: {
|
|
887
|
-
/**
|
|
888
|
-
* Markdown content shown before starting to install the blueprint
|
|
889
|
-
* example:
|
|
890
|
-
* This is the content of the preinstall.md file which contains the blueprint description.
|
|
891
|
-
*
|
|
892
|
-
*/
|
|
893
|
-
preinstall?: string;
|
|
894
|
-
/**
|
|
895
|
-
* Markdown content to be displayed when showing the plan to install blueprint
|
|
896
|
-
* example:
|
|
897
|
-
* This is the content of the postinstall.md file
|
|
898
|
-
*
|
|
899
|
-
*/
|
|
900
|
-
postinstall?: string;
|
|
901
|
-
};
|
|
902
|
-
version?: string;
|
|
903
|
-
deployments?: {
|
|
904
|
-
source_org_id?: string;
|
|
905
|
-
source_blueprint_id?: string;
|
|
906
|
-
destination_org_id?: string;
|
|
907
|
-
destination_blueprint_id?: string;
|
|
908
|
-
triggered_at?: string; // date-time
|
|
909
|
-
/**
|
|
910
|
-
* User-provided note about this synchronization
|
|
911
|
-
*/
|
|
912
|
-
note?: string;
|
|
913
|
-
}[];
|
|
914
|
-
/**
|
|
915
|
-
* Whether the blueprint is verified by epilot
|
|
916
|
-
*/
|
|
917
|
-
is_verified?: boolean;
|
|
918
|
-
latest_verification?: LatestBlueprintVerification;
|
|
919
|
-
/**
|
|
920
|
-
* Resource addresses excluded during the latest install/update and ignored by verification.
|
|
921
|
-
*/
|
|
922
|
-
ignored_resource_addresses?: string[];
|
|
923
|
-
installation_status?: "IN_PROGRESS" | "CANCELED" | "PARTIAL" | "SUCCESS" | "FAILED";
|
|
924
|
-
created_at?: string; // date-time
|
|
925
|
-
updated_at?: string; // date-time
|
|
926
|
-
created_by?: CallerIdentity;
|
|
927
|
-
updated_by?: CallerIdentity;
|
|
928
|
-
installation_job_ids?: /**
|
|
929
|
-
* ID of a job
|
|
930
|
-
* example:
|
|
931
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
932
|
-
*/
|
|
933
|
-
BlueprintJobID[];
|
|
934
|
-
/**
|
|
935
|
-
* ID of the blueprint that brought this blueprint to the destination org (deployed or installed)
|
|
936
|
-
* example:
|
|
937
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
938
|
-
*/
|
|
939
|
-
source_blueprint_id?: string;
|
|
940
|
-
/**
|
|
941
|
-
* Whether the blueprint is archived (soft-deleted). Archived blueprints are hidden from the main list.
|
|
942
|
-
*/
|
|
943
|
-
archived?: boolean;
|
|
944
|
-
/**
|
|
945
|
-
* URL to the blueprint documentation
|
|
946
|
-
*/
|
|
947
|
-
docs_url?: string;
|
|
948
|
-
/**
|
|
949
|
-
* List of recommended app IDs for the blueprint
|
|
950
|
-
*/
|
|
951
|
-
recommended_apps?: string[];
|
|
952
|
-
/**
|
|
953
|
-
* Feature constraints for blueprint installation
|
|
954
|
-
*/
|
|
955
|
-
required_features?: {
|
|
956
|
-
/**
|
|
957
|
-
* Features that must be enabled in the target org
|
|
958
|
-
*/
|
|
959
|
-
enabled?: string[];
|
|
960
|
-
/**
|
|
961
|
-
* Features that must be disabled in the target org
|
|
962
|
-
*/
|
|
963
|
-
disabled?: string[];
|
|
964
|
-
};
|
|
965
|
-
/**
|
|
966
|
-
* Custom name for the exported zip file
|
|
967
|
-
*/
|
|
968
|
-
zip_file_name?: string;
|
|
969
|
-
source_type: "file";
|
|
970
|
-
resources?: BlueprintResource[];
|
|
971
|
-
}
|
|
972
|
-
export interface FormattedError {
|
|
973
|
-
error?: string | {
|
|
974
|
-
[key: string]: any;
|
|
975
|
-
};
|
|
976
|
-
code?: FormattedErrorCodes;
|
|
977
|
-
data?: {
|
|
978
|
-
formattedResource?: FormattedErrorData;
|
|
979
|
-
resource?: string;
|
|
980
|
-
resourceDependency?: string;
|
|
981
|
-
resources?: string[];
|
|
982
|
-
addresses?: string[];
|
|
983
|
-
originalError?: string;
|
|
984
|
-
};
|
|
985
|
-
}
|
|
986
|
-
export type FormattedErrorCodes = "dependency_extraction" | "resource_not_found" | "resource_fetch_api_error" | "resource_fetch_unknown_error" | "terraform_cli_process_error" | "terraform_import_block_process_error" | "terraform_init_error" | "terraform_validate_error" | "terraform_plan_error" | "terraform_apply_error" | "terraform_show_error" | "generic_error" | "bad_request" | "forbidden" | "conflict" | "not_found" | "undeclared_resource" | "invalid_readonly_attribute" | "invalid_attribute_value" | "unsupported_attribute" | "self_referential_block" | "circular_dependency" | "state_mismatch" | "import_nonexistent_object" | "provider_install_error" | "stale_blueprint";
|
|
987
|
-
export interface FormattedErrorData {
|
|
988
|
-
id?: string;
|
|
989
|
-
name?: string;
|
|
990
|
-
type?: string;
|
|
991
|
-
}
|
|
992
|
-
/**
|
|
993
|
-
* Summary of an installed marketplace blueprint for version tracking
|
|
994
|
-
*/
|
|
995
|
-
export interface InstalledMarketplaceBlueprintItem {
|
|
996
|
-
id: /**
|
|
997
|
-
* ID of a blueprint
|
|
998
|
-
* example:
|
|
999
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1000
|
-
*/
|
|
1001
|
-
BlueprintID;
|
|
1002
|
-
/**
|
|
1003
|
-
* URL slug of the blueprint from the epilot marketplace
|
|
1004
|
-
* example:
|
|
1005
|
-
* solar-b2b
|
|
1006
|
-
*/
|
|
1007
|
-
slug: string;
|
|
1008
|
-
/**
|
|
1009
|
-
* Version of the installed blueprint
|
|
1010
|
-
* example:
|
|
1011
|
-
* v1.0.0
|
|
1012
|
-
*/
|
|
1013
|
-
version?: string;
|
|
1014
|
-
created_at?: string; // date-time
|
|
1015
|
-
created_by?: CallerIdentity;
|
|
1016
|
-
updated_at?: string; // date-time
|
|
1017
|
-
updated_by?: CallerIdentity;
|
|
1018
|
-
/**
|
|
1019
|
-
* Whether a newer version is available in the marketplace
|
|
1020
|
-
* example:
|
|
1021
|
-
* true
|
|
1022
|
-
*/
|
|
1023
|
-
has_update_available?: boolean;
|
|
1024
|
-
/**
|
|
1025
|
-
* The latest version available in the marketplace
|
|
1026
|
-
* example:
|
|
1027
|
-
* v2.0.0
|
|
1028
|
-
*/
|
|
1029
|
-
latest_marketplace_version?: string;
|
|
1030
|
-
/**
|
|
1031
|
-
* URL to install/update the blueprint from the marketplace
|
|
1032
|
-
*/
|
|
1033
|
-
installation_link?: string;
|
|
1034
|
-
}
|
|
1035
|
-
export interface Job {
|
|
1036
|
-
job_id?: /**
|
|
1037
|
-
* ID of an import or export job (state machine)
|
|
1038
|
-
* example:
|
|
1039
|
-
* 4854bb2a-94f9-424d-a968-3fb17fb0bf89
|
|
1040
|
-
*/
|
|
1041
|
-
JobID;
|
|
1042
|
-
job_status?: JobStatus;
|
|
1043
|
-
/**
|
|
1044
|
-
* The S3 key of the manifest file
|
|
1045
|
-
*/
|
|
1046
|
-
manifest_file_path?: string;
|
|
1047
|
-
message?: string;
|
|
1048
|
-
timestamp?: string; // date-time
|
|
1049
|
-
/**
|
|
1050
|
-
* An URL to download the plan file
|
|
1051
|
-
*/
|
|
1052
|
-
plan_file_content?: string;
|
|
1053
|
-
/**
|
|
1054
|
-
* An array of tree-like JSON objects or a singular tree-like JSON object representing the resources to import
|
|
1055
|
-
*/
|
|
1056
|
-
resources_to_export?: /* An array of tree-like JSON objects or a singular tree-like JSON object representing the resources to import */ RootResourceNode[] | RootResourceNode;
|
|
1057
|
-
/**
|
|
1058
|
-
* An URL to download the resources to export when the resources are too large to be included in the response
|
|
1059
|
-
*/
|
|
1060
|
-
large_resources_to_export_url?: string;
|
|
1061
|
-
/**
|
|
1062
|
-
* An array of tree-like JSON objects or a singular tree-like JSON object representing the resources to import
|
|
1063
|
-
*/
|
|
1064
|
-
resources_to_import?: /* An array of tree-like JSON objects or a singular tree-like JSON object representing the resources to import */ RootResourceNode[] | RootResourceNode;
|
|
1065
|
-
/**
|
|
1066
|
-
* An URL to download the resources to import when the resources are too large to be included in the response
|
|
1067
|
-
*/
|
|
1068
|
-
large_resources_to_import_url?: string;
|
|
1069
|
-
resource_replacements?: ResourceReplacement[];
|
|
1070
|
-
/**
|
|
1071
|
-
* Whether the manifest comes from a trusted source and is signed by epilot
|
|
1072
|
-
*/
|
|
1073
|
-
is_verified?: boolean;
|
|
1074
|
-
errors?: FormattedError[];
|
|
1075
|
-
source_type?: ManifestSource;
|
|
1076
|
-
/**
|
|
1077
|
-
* An array of tree-like JSON objects or a singular tree-like JSON object representing the resources to import
|
|
1078
|
-
*/
|
|
1079
|
-
imported_resources?: /* An array of tree-like JSON objects or a singular tree-like JSON object representing the resources to import */ RootResourceNode[] | RootResourceNode;
|
|
1080
|
-
/**
|
|
1081
|
-
* An URL to download the imported resources when the resources are too large to be included in the response
|
|
1082
|
-
* example:
|
|
1083
|
-
* https://blueprint-manifest-prod.s3.eu-central-1.amazonaws.com/large.json
|
|
1084
|
-
*/
|
|
1085
|
-
large_imported_resources_url?: string; // uri
|
|
1086
|
-
/**
|
|
1087
|
-
* Markdown content part of a manifest file
|
|
1088
|
-
*/
|
|
1089
|
-
markdown?: {
|
|
1090
|
-
/**
|
|
1091
|
-
* Markdown content shown before installing the manifest
|
|
1092
|
-
* example:
|
|
1093
|
-
* This is the content of the manifest.md file which contains the manifest descripton.
|
|
1094
|
-
*
|
|
1095
|
-
*/
|
|
1096
|
-
manifest?: string;
|
|
1097
|
-
/**
|
|
1098
|
-
* Markdown content to be displayed when showing the plan to install blueprint
|
|
1099
|
-
* example:
|
|
1100
|
-
* This is the content of the preinstall.md file
|
|
1101
|
-
*
|
|
1102
|
-
*/
|
|
1103
|
-
preinstall?: string;
|
|
1104
|
-
/**
|
|
1105
|
-
* Markdown content to be displayed when showing the plan to install blueprint
|
|
1106
|
-
* example:
|
|
1107
|
-
* This is the content of the postinstall.md file
|
|
1108
|
-
*
|
|
1109
|
-
*/
|
|
1110
|
-
postinstall?: string;
|
|
1111
|
-
};
|
|
1112
|
-
manifest_id?: /**
|
|
1113
|
-
* ID of an imported / installed manifest
|
|
1114
|
-
* example:
|
|
1115
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1116
|
-
*/
|
|
1117
|
-
ManifestID;
|
|
1118
|
-
/**
|
|
1119
|
-
* example:
|
|
1120
|
-
* Solar B2B
|
|
1121
|
-
*/
|
|
1122
|
-
source_blueprint_name?: string;
|
|
1123
|
-
/**
|
|
1124
|
-
* URL slug of a blueprint from the epilot marketplace
|
|
1125
|
-
* example:
|
|
1126
|
-
* solar-b2b
|
|
1127
|
-
*/
|
|
1128
|
-
source_blueprint_slug?: string;
|
|
1129
|
-
/**
|
|
1130
|
-
* Version of the blueprint (semver)
|
|
1131
|
-
* example:
|
|
1132
|
-
* 1.0.0
|
|
1133
|
-
*/
|
|
1134
|
-
source_blueprint_version?: string;
|
|
1135
|
-
pre_install_requirements?: /**
|
|
1136
|
-
* List of feature settings that must be enabled before installing the blueprint
|
|
1137
|
-
* example:
|
|
1138
|
-
* [
|
|
1139
|
-
* "journey_automation",
|
|
1140
|
-
* "ticket-entities",
|
|
1141
|
-
* "advanced_permissions"
|
|
1142
|
-
* ]
|
|
1143
|
-
*/
|
|
1144
|
-
PreInstallRequirements;
|
|
1145
|
-
/**
|
|
1146
|
-
* A URL to download the source blueprint file used to import the blueprint
|
|
1147
|
-
* example:
|
|
1148
|
-
* https://blueprint-manifest-prod.s3.eu-central-1.amazonaws.com/manifest.zip
|
|
1149
|
-
*/
|
|
1150
|
-
source_blueprint_file?: string;
|
|
1151
|
-
/**
|
|
1152
|
-
* Link to the blueprint documentation
|
|
1153
|
-
* example:
|
|
1154
|
-
* https://help.epilot.cloud
|
|
1155
|
-
*/
|
|
1156
|
-
docs_link?: string;
|
|
1157
|
-
source_blueprint_file_ref?: S3Reference;
|
|
1158
|
-
install_status?: BlueprintInstallStatus;
|
|
1159
|
-
/**
|
|
1160
|
-
* example:
|
|
1161
|
-
* This blueprint installation resulted in a partial deployment; some resources were created successfully, but failed to complete the full resource setup.
|
|
1162
|
-
*/
|
|
1163
|
-
install_status_description?: string;
|
|
1164
|
-
created_by?: CallerIdentity;
|
|
1165
|
-
updated_by?: CallerIdentity;
|
|
1166
|
-
/**
|
|
1167
|
-
* Version of the manifest (semver)
|
|
1168
|
-
* example:
|
|
1169
|
-
* 1.0.0
|
|
1170
|
-
*/
|
|
1171
|
-
manifest_version?: string;
|
|
1172
|
-
/**
|
|
1173
|
-
* All the resources that were selected to be exported, used to pre-select the resources when updating a sandbox manifest
|
|
1174
|
-
* example:
|
|
1175
|
-
* https://blueprint-manifest-prod.s3.eu-central-1.amazonaws.com/selected_resources.json
|
|
1176
|
-
*/
|
|
1177
|
-
selected_resources_url?: string;
|
|
1178
|
-
/**
|
|
1179
|
-
* All the resources that were marked as ready by the user
|
|
1180
|
-
* example:
|
|
1181
|
-
* https://blueprint-manifest-prod.s3.eu-central-1.amazonaws.com/ready_imported_resources.json
|
|
1182
|
-
*/
|
|
1183
|
-
ready_imported_resources_url?: string;
|
|
1184
|
-
/**
|
|
1185
|
-
* Information about the manifest that was deployed from, used to update existing deployments instead of always creating new ones
|
|
1186
|
-
*/
|
|
1187
|
-
deployed_from?: {
|
|
1188
|
-
/**
|
|
1189
|
-
* ID of the organization that deployed the manifest
|
|
1190
|
-
*/
|
|
1191
|
-
source_organization_id?: string;
|
|
1192
|
-
/**
|
|
1193
|
-
* ID of the manifest that was deployed
|
|
1194
|
-
*/
|
|
1195
|
-
source_manifest_id?: string;
|
|
1196
|
-
source_organization_type?: "sandbox" | "production";
|
|
1197
|
-
/**
|
|
1198
|
-
* When the deployment was last triggered
|
|
1199
|
-
*/
|
|
1200
|
-
last_triggered_at?: string; // date-time
|
|
1201
|
-
};
|
|
1202
|
-
/**
|
|
1203
|
-
* Information about the manifest that was deployed to, used to update existing deployments instead of always creating new ones
|
|
1204
|
-
*/
|
|
1205
|
-
deployed_to?: {
|
|
1206
|
-
/**
|
|
1207
|
-
* ID of the organization that the manifest was deployed to
|
|
1208
|
-
*/
|
|
1209
|
-
destination_organization_id?: string;
|
|
1210
|
-
/**
|
|
1211
|
-
* ID of the manifest that was deployed to
|
|
1212
|
-
*/
|
|
1213
|
-
destination_manifest_id?: string;
|
|
1214
|
-
destination_organization_type?: "sandbox" | "production";
|
|
1215
|
-
/**
|
|
1216
|
-
* When the deployment was last triggered
|
|
1217
|
-
*/
|
|
1218
|
-
last_triggered_at?: string; // date-time
|
|
1219
|
-
}[];
|
|
1220
|
-
}
|
|
1221
|
-
/**
|
|
1222
|
-
* ID of an import or export job (state machine)
|
|
1223
|
-
* example:
|
|
1224
|
-
* 4854bb2a-94f9-424d-a968-3fb17fb0bf89
|
|
1225
|
-
*/
|
|
1226
|
-
export type JobID = string;
|
|
1227
|
-
export type JobStatus = "PENDING" | "STARTED" | "WAITING_USER_ACTION" | "CANCELED" | "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED";
|
|
1228
|
-
export interface LatestBlueprintVerification {
|
|
1229
|
-
job_id?: /**
|
|
1230
|
-
* ID of a job
|
|
1231
|
-
* example:
|
|
1232
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1233
|
-
*/
|
|
1234
|
-
BlueprintJobID;
|
|
1235
|
-
status?: "IN_PROGRESS" | "SUCCESS" | "FAILED";
|
|
1236
|
-
triggered_at?: string; // date-time
|
|
1237
|
-
source_org_id?: string;
|
|
1238
|
-
source_blueprint_id?: /**
|
|
1239
|
-
* ID of a blueprint
|
|
1240
|
-
* example:
|
|
1241
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1242
|
-
*/
|
|
1243
|
-
BlueprintID;
|
|
1244
|
-
destination_org_id?: string;
|
|
1245
|
-
destination_blueprint_id?: /**
|
|
1246
|
-
* ID of a blueprint
|
|
1247
|
-
* example:
|
|
1248
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1249
|
-
*/
|
|
1250
|
-
BlueprintID;
|
|
1251
|
-
summary?: VerificationSummary;
|
|
1252
|
-
}
|
|
1253
|
-
export interface LineageEntry {
|
|
1254
|
-
/**
|
|
1255
|
-
* Immutable resource identity across orgs
|
|
1256
|
-
*/
|
|
1257
|
-
lineage_id?: string;
|
|
1258
|
-
/**
|
|
1259
|
-
* Resource ID in the destination org
|
|
1260
|
-
*/
|
|
1261
|
-
target_id?: string;
|
|
1262
|
-
resource_type?: /* Type of the resource */ ResourceNodeType;
|
|
1263
|
-
blueprint_instance_ids?: string[];
|
|
1264
|
-
fidelity?: "full" | "partial";
|
|
1265
|
-
last_synced_at?: string; // date-time
|
|
1266
|
-
}
|
|
1267
|
-
export interface Manifest {
|
|
1268
|
-
import_job_id?: /**
|
|
1269
|
-
* ID of an import or export job (state machine)
|
|
1270
|
-
* example:
|
|
1271
|
-
* 4854bb2a-94f9-424d-a968-3fb17fb0bf89
|
|
1272
|
-
*/
|
|
1273
|
-
JobID;
|
|
1274
|
-
/**
|
|
1275
|
-
* List of job IDs that were used to install the manifest
|
|
1276
|
-
*/
|
|
1277
|
-
previous_jobs_ids?: string[];
|
|
1278
|
-
/**
|
|
1279
|
-
* List of jobs that were used to install the manifest
|
|
1280
|
-
*/
|
|
1281
|
-
previous_jobs?: Job[];
|
|
1282
|
-
manifest_id?: /**
|
|
1283
|
-
* ID of an imported / installed manifest
|
|
1284
|
-
* example:
|
|
1285
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1286
|
-
*/
|
|
1287
|
-
ManifestID;
|
|
1288
|
-
source_type?: ManifestSource;
|
|
1289
|
-
/**
|
|
1290
|
-
* example:
|
|
1291
|
-
* Solar B2B
|
|
1292
|
-
*/
|
|
1293
|
-
source_blueprint_name?: string;
|
|
1294
|
-
/**
|
|
1295
|
-
* URL slug of a blueprint from the epilot marketplace
|
|
1296
|
-
* example:
|
|
1297
|
-
* solar-b2b
|
|
1298
|
-
*/
|
|
1299
|
-
source_blueprint_slug?: string;
|
|
1300
|
-
/**
|
|
1301
|
-
* Version of the blueprint (semver)
|
|
1302
|
-
* example:
|
|
1303
|
-
* 1.0.0
|
|
1304
|
-
*/
|
|
1305
|
-
source_blueprint_version?: string;
|
|
1306
|
-
pre_install_requirements?: /**
|
|
1307
|
-
* List of feature settings that must be enabled before installing the blueprint
|
|
1308
|
-
* example:
|
|
1309
|
-
* [
|
|
1310
|
-
* "journey_automation",
|
|
1311
|
-
* "ticket-entities",
|
|
1312
|
-
* "advanced_permissions"
|
|
1313
|
-
* ]
|
|
1314
|
-
*/
|
|
1315
|
-
PreInstallRequirements;
|
|
1316
|
-
/**
|
|
1317
|
-
* A URL to download the source blueprint file used to import the blueprint
|
|
1318
|
-
* example:
|
|
1319
|
-
* https://blueprint-manifest-prod.s3.eu-central-1.amazonaws.com/manifest.zip
|
|
1320
|
-
*/
|
|
1321
|
-
source_blueprint_file?: string;
|
|
1322
|
-
/**
|
|
1323
|
-
* Link to the blueprint documentation
|
|
1324
|
-
* example:
|
|
1325
|
-
* https://help.epilot.cloud
|
|
1326
|
-
*/
|
|
1327
|
-
docs_link?: string;
|
|
1328
|
-
source_blueprint_file_ref?: S3Reference;
|
|
1329
|
-
install_status?: BlueprintInstallStatus;
|
|
1330
|
-
/**
|
|
1331
|
-
* example:
|
|
1332
|
-
* This blueprint installation resulted in a partial deployment; some resources were created successfully, but failed to complete the full resource setup.
|
|
1333
|
-
*/
|
|
1334
|
-
install_status_description?: string;
|
|
1335
|
-
/**
|
|
1336
|
-
* Whether the manifest comes from a trusted source and is signed by epilot
|
|
1337
|
-
*/
|
|
1338
|
-
is_verified?: boolean;
|
|
1339
|
-
created_by?: CallerIdentity;
|
|
1340
|
-
updated_by?: CallerIdentity;
|
|
1341
|
-
/**
|
|
1342
|
-
* Version of the manifest (semver)
|
|
1343
|
-
* example:
|
|
1344
|
-
* 1.0.0
|
|
1345
|
-
*/
|
|
1346
|
-
manifest_version?: string;
|
|
1347
|
-
/**
|
|
1348
|
-
* All the resources that were selected to be exported, used to pre-select the resources when updating a sandbox manifest
|
|
1349
|
-
* example:
|
|
1350
|
-
* https://blueprint-manifest-prod.s3.eu-central-1.amazonaws.com/selected_resources.json
|
|
1351
|
-
*/
|
|
1352
|
-
selected_resources_url?: string;
|
|
1353
|
-
/**
|
|
1354
|
-
* All the resources that were marked as ready by the user
|
|
1355
|
-
* example:
|
|
1356
|
-
* https://blueprint-manifest-prod.s3.eu-central-1.amazonaws.com/ready_imported_resources.json
|
|
1357
|
-
*/
|
|
1358
|
-
ready_imported_resources_url?: string;
|
|
1359
|
-
/**
|
|
1360
|
-
* Information about the manifest that was deployed from, used to update existing deployments instead of always creating new ones
|
|
1361
|
-
*/
|
|
1362
|
-
deployed_from?: {
|
|
1363
|
-
/**
|
|
1364
|
-
* ID of the organization that deployed the manifest
|
|
1365
|
-
*/
|
|
1366
|
-
source_organization_id?: string;
|
|
1367
|
-
/**
|
|
1368
|
-
* ID of the manifest that was deployed
|
|
1369
|
-
*/
|
|
1370
|
-
source_manifest_id?: string;
|
|
1371
|
-
source_organization_type?: "sandbox" | "production";
|
|
1372
|
-
/**
|
|
1373
|
-
* When the deployment was last triggered
|
|
1374
|
-
*/
|
|
1375
|
-
last_triggered_at?: string; // date-time
|
|
1376
|
-
};
|
|
1377
|
-
/**
|
|
1378
|
-
* Information about the manifest that was deployed to, used to update existing deployments instead of always creating new ones
|
|
1379
|
-
*/
|
|
1380
|
-
deployed_to?: {
|
|
1381
|
-
/**
|
|
1382
|
-
* ID of the organization that the manifest was deployed to
|
|
1383
|
-
*/
|
|
1384
|
-
destination_organization_id?: string;
|
|
1385
|
-
/**
|
|
1386
|
-
* ID of the manifest that was deployed to
|
|
1387
|
-
*/
|
|
1388
|
-
destination_manifest_id?: string;
|
|
1389
|
-
destination_organization_type?: "sandbox" | "production";
|
|
1390
|
-
/**
|
|
1391
|
-
* When the deployment was last triggered
|
|
1392
|
-
*/
|
|
1393
|
-
last_triggered_at?: string; // date-time
|
|
1394
|
-
}[];
|
|
1395
|
-
/**
|
|
1396
|
-
* Markdown content part of a manifest file
|
|
1397
|
-
*/
|
|
1398
|
-
markdown?: {
|
|
1399
|
-
/**
|
|
1400
|
-
* Markdown content shown before installing the manifest
|
|
1401
|
-
* example:
|
|
1402
|
-
* This is the content of the manifest.md file which contains the manifest descripton.
|
|
1403
|
-
*
|
|
1404
|
-
*/
|
|
1405
|
-
manifest?: string;
|
|
1406
|
-
/**
|
|
1407
|
-
* Markdown content to be displayed when showing the plan to install blueprint
|
|
1408
|
-
* example:
|
|
1409
|
-
* This is the content of the preinstall.md file
|
|
1410
|
-
*
|
|
1411
|
-
*/
|
|
1412
|
-
preinstall?: string;
|
|
1413
|
-
/**
|
|
1414
|
-
* Markdown content to be displayed when showing the plan to install blueprint
|
|
1415
|
-
* example:
|
|
1416
|
-
* This is the content of the postinstall.md file
|
|
1417
|
-
*
|
|
1418
|
-
*/
|
|
1419
|
-
postinstall?: string;
|
|
1420
|
-
};
|
|
1421
|
-
/**
|
|
1422
|
-
* An array of tree-like JSON objects or a singular tree-like JSON object representing the resources to import
|
|
1423
|
-
*/
|
|
1424
|
-
imported_resources?: /* An array of tree-like JSON objects or a singular tree-like JSON object representing the resources to import */ RootResourceNode[] | RootResourceNode;
|
|
1425
|
-
/**
|
|
1426
|
-
* An URL to download the imported resources when the resources are too large to be included in the response
|
|
1427
|
-
* example:
|
|
1428
|
-
* https://blueprint-manifest-prod.s3.eu-central-1.amazonaws.com/large.json
|
|
1429
|
-
*/
|
|
1430
|
-
large_imported_resources_url?: string; // uri
|
|
1431
|
-
/**
|
|
1432
|
-
* When the manifest was first installed (applied)
|
|
1433
|
-
*/
|
|
1434
|
-
created_at?: string; // date-time
|
|
1435
|
-
/**
|
|
1436
|
-
* When the manifest was last updated (applied)
|
|
1437
|
-
*/
|
|
1438
|
-
updated_at?: string; // date-time
|
|
1439
|
-
}
|
|
1440
|
-
/**
|
|
1441
|
-
* ID of an imported / installed manifest
|
|
1442
|
-
* example:
|
|
1443
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1444
|
-
*/
|
|
1445
|
-
export type ManifestID = string;
|
|
1446
|
-
export interface ManifestItem {
|
|
1447
|
-
manifest_id?: /**
|
|
1448
|
-
* ID of an imported / installed manifest
|
|
1449
|
-
* example:
|
|
1450
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1451
|
-
*/
|
|
1452
|
-
ManifestID;
|
|
1453
|
-
source_type?: ManifestSource;
|
|
1454
|
-
/**
|
|
1455
|
-
* example:
|
|
1456
|
-
* Solar B2B
|
|
1457
|
-
*/
|
|
1458
|
-
source_blueprint_name?: string;
|
|
1459
|
-
/**
|
|
1460
|
-
* URL slug of a blueprint from the epilot marketplace
|
|
1461
|
-
* example:
|
|
1462
|
-
* solar-b2b
|
|
1463
|
-
*/
|
|
1464
|
-
source_blueprint_slug?: string;
|
|
1465
|
-
/**
|
|
1466
|
-
* Version of the blueprint (semver)
|
|
1467
|
-
* example:
|
|
1468
|
-
* 1.0.0
|
|
1469
|
-
*/
|
|
1470
|
-
source_blueprint_version?: string;
|
|
1471
|
-
pre_install_requirements?: /**
|
|
1472
|
-
* List of feature settings that must be enabled before installing the blueprint
|
|
1473
|
-
* example:
|
|
1474
|
-
* [
|
|
1475
|
-
* "journey_automation",
|
|
1476
|
-
* "ticket-entities",
|
|
1477
|
-
* "advanced_permissions"
|
|
1478
|
-
* ]
|
|
1479
|
-
*/
|
|
1480
|
-
PreInstallRequirements;
|
|
1481
|
-
/**
|
|
1482
|
-
* A URL to download the source blueprint file used to import the blueprint
|
|
1483
|
-
* example:
|
|
1484
|
-
* https://blueprint-manifest-prod.s3.eu-central-1.amazonaws.com/manifest.zip
|
|
1485
|
-
*/
|
|
1486
|
-
source_blueprint_file?: string;
|
|
1487
|
-
/**
|
|
1488
|
-
* Link to the blueprint documentation
|
|
1489
|
-
* example:
|
|
1490
|
-
* https://help.epilot.cloud
|
|
1491
|
-
*/
|
|
1492
|
-
docs_link?: string;
|
|
1493
|
-
source_blueprint_file_ref?: S3Reference;
|
|
1494
|
-
install_status?: BlueprintInstallStatus;
|
|
1495
|
-
/**
|
|
1496
|
-
* example:
|
|
1497
|
-
* This blueprint installation resulted in a partial deployment; some resources were created successfully, but failed to complete the full resource setup.
|
|
1498
|
-
*/
|
|
1499
|
-
install_status_description?: string;
|
|
1500
|
-
/**
|
|
1501
|
-
* Whether the manifest comes from a trusted source and is signed by epilot
|
|
1502
|
-
*/
|
|
1503
|
-
is_verified?: boolean;
|
|
1504
|
-
created_by?: CallerIdentity;
|
|
1505
|
-
updated_by?: CallerIdentity;
|
|
1506
|
-
/**
|
|
1507
|
-
* Version of the manifest (semver)
|
|
1508
|
-
* example:
|
|
1509
|
-
* 1.0.0
|
|
1510
|
-
*/
|
|
1511
|
-
manifest_version?: string;
|
|
1512
|
-
/**
|
|
1513
|
-
* All the resources that were selected to be exported, used to pre-select the resources when updating a sandbox manifest
|
|
1514
|
-
* example:
|
|
1515
|
-
* https://blueprint-manifest-prod.s3.eu-central-1.amazonaws.com/selected_resources.json
|
|
1516
|
-
*/
|
|
1517
|
-
selected_resources_url?: string;
|
|
1518
|
-
/**
|
|
1519
|
-
* All the resources that were marked as ready by the user
|
|
1520
|
-
* example:
|
|
1521
|
-
* https://blueprint-manifest-prod.s3.eu-central-1.amazonaws.com/ready_imported_resources.json
|
|
1522
|
-
*/
|
|
1523
|
-
ready_imported_resources_url?: string;
|
|
1524
|
-
/**
|
|
1525
|
-
* Information about the manifest that was deployed from, used to update existing deployments instead of always creating new ones
|
|
1526
|
-
*/
|
|
1527
|
-
deployed_from?: {
|
|
1528
|
-
/**
|
|
1529
|
-
* ID of the organization that deployed the manifest
|
|
1530
|
-
*/
|
|
1531
|
-
source_organization_id?: string;
|
|
1532
|
-
/**
|
|
1533
|
-
* ID of the manifest that was deployed
|
|
1534
|
-
*/
|
|
1535
|
-
source_manifest_id?: string;
|
|
1536
|
-
source_organization_type?: "sandbox" | "production";
|
|
1537
|
-
/**
|
|
1538
|
-
* When the deployment was last triggered
|
|
1539
|
-
*/
|
|
1540
|
-
last_triggered_at?: string; // date-time
|
|
1541
|
-
};
|
|
1542
|
-
/**
|
|
1543
|
-
* Information about the manifest that was deployed to, used to update existing deployments instead of always creating new ones
|
|
1544
|
-
*/
|
|
1545
|
-
deployed_to?: {
|
|
1546
|
-
/**
|
|
1547
|
-
* ID of the organization that the manifest was deployed to
|
|
1548
|
-
*/
|
|
1549
|
-
destination_organization_id?: string;
|
|
1550
|
-
/**
|
|
1551
|
-
* ID of the manifest that was deployed to
|
|
1552
|
-
*/
|
|
1553
|
-
destination_manifest_id?: string;
|
|
1554
|
-
destination_organization_type?: "sandbox" | "production";
|
|
1555
|
-
/**
|
|
1556
|
-
* When the deployment was last triggered
|
|
1557
|
-
*/
|
|
1558
|
-
last_triggered_at?: string; // date-time
|
|
1559
|
-
}[];
|
|
1560
|
-
/**
|
|
1561
|
-
* When the manifest was first installed (applied)
|
|
1562
|
-
*/
|
|
1563
|
-
created_at?: string; // date-time
|
|
1564
|
-
/**
|
|
1565
|
-
* When the manifest was last updated (applied)
|
|
1566
|
-
*/
|
|
1567
|
-
updated_at?: string; // date-time
|
|
1568
|
-
}
|
|
1569
|
-
export type ManifestSource = "file" | "marketplace" | "sandbox";
|
|
1570
|
-
export interface ManifestTimestampFields {
|
|
1571
|
-
/**
|
|
1572
|
-
* When the manifest was first installed (applied)
|
|
1573
|
-
*/
|
|
1574
|
-
created_at?: string; // date-time
|
|
1575
|
-
/**
|
|
1576
|
-
* When the manifest was last updated (applied)
|
|
1577
|
-
*/
|
|
1578
|
-
updated_at?: string; // date-time
|
|
1579
|
-
}
|
|
1580
|
-
export interface MarketplaceBlueprint {
|
|
1581
|
-
id?: /**
|
|
1582
|
-
* ID of a blueprint
|
|
1583
|
-
* example:
|
|
1584
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1585
|
-
*/
|
|
1586
|
-
BlueprintID;
|
|
1587
|
-
title: string;
|
|
1588
|
-
slug?: string;
|
|
1589
|
-
description?: {
|
|
1590
|
-
/**
|
|
1591
|
-
* Markdown content shown before starting to install the blueprint
|
|
1592
|
-
* example:
|
|
1593
|
-
* This is the content of the preinstall.md file which contains the blueprint description.
|
|
1594
|
-
*
|
|
1595
|
-
*/
|
|
1596
|
-
preinstall?: string;
|
|
1597
|
-
/**
|
|
1598
|
-
* Markdown content to be displayed when showing the plan to install blueprint
|
|
1599
|
-
* example:
|
|
1600
|
-
* This is the content of the postinstall.md file
|
|
1601
|
-
*
|
|
1602
|
-
*/
|
|
1603
|
-
postinstall?: string;
|
|
1604
|
-
};
|
|
1605
|
-
version?: string;
|
|
1606
|
-
deployments?: {
|
|
1607
|
-
source_org_id?: string;
|
|
1608
|
-
source_blueprint_id?: string;
|
|
1609
|
-
destination_org_id?: string;
|
|
1610
|
-
destination_blueprint_id?: string;
|
|
1611
|
-
triggered_at?: string; // date-time
|
|
1612
|
-
/**
|
|
1613
|
-
* User-provided note about this synchronization
|
|
1614
|
-
*/
|
|
1615
|
-
note?: string;
|
|
1616
|
-
}[];
|
|
1617
|
-
/**
|
|
1618
|
-
* Whether the blueprint is verified by epilot
|
|
1619
|
-
*/
|
|
1620
|
-
is_verified?: boolean;
|
|
1621
|
-
latest_verification?: LatestBlueprintVerification;
|
|
1622
|
-
/**
|
|
1623
|
-
* Resource addresses excluded during the latest install/update and ignored by verification.
|
|
1624
|
-
*/
|
|
1625
|
-
ignored_resource_addresses?: string[];
|
|
1626
|
-
installation_status?: "IN_PROGRESS" | "CANCELED" | "PARTIAL" | "SUCCESS" | "FAILED";
|
|
1627
|
-
created_at?: string; // date-time
|
|
1628
|
-
updated_at?: string; // date-time
|
|
1629
|
-
created_by?: CallerIdentity;
|
|
1630
|
-
updated_by?: CallerIdentity;
|
|
1631
|
-
installation_job_ids?: /**
|
|
1632
|
-
* ID of a job
|
|
1633
|
-
* example:
|
|
1634
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1635
|
-
*/
|
|
1636
|
-
BlueprintJobID[];
|
|
1637
|
-
/**
|
|
1638
|
-
* ID of the blueprint that brought this blueprint to the destination org (deployed or installed)
|
|
1639
|
-
* example:
|
|
1640
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1641
|
-
*/
|
|
1642
|
-
source_blueprint_id?: string;
|
|
1643
|
-
/**
|
|
1644
|
-
* Whether the blueprint is archived (soft-deleted). Archived blueprints are hidden from the main list.
|
|
1645
|
-
*/
|
|
1646
|
-
archived?: boolean;
|
|
1647
|
-
/**
|
|
1648
|
-
* URL to the blueprint documentation
|
|
1649
|
-
*/
|
|
1650
|
-
docs_url?: string;
|
|
1651
|
-
/**
|
|
1652
|
-
* List of recommended app IDs for the blueprint
|
|
1653
|
-
*/
|
|
1654
|
-
recommended_apps?: string[];
|
|
1655
|
-
/**
|
|
1656
|
-
* Feature constraints for blueprint installation
|
|
1657
|
-
*/
|
|
1658
|
-
required_features?: {
|
|
1659
|
-
/**
|
|
1660
|
-
* Features that must be enabled in the target org
|
|
1661
|
-
*/
|
|
1662
|
-
enabled?: string[];
|
|
1663
|
-
/**
|
|
1664
|
-
* Features that must be disabled in the target org
|
|
1665
|
-
*/
|
|
1666
|
-
disabled?: string[];
|
|
1667
|
-
};
|
|
1668
|
-
/**
|
|
1669
|
-
* Custom name for the exported zip file
|
|
1670
|
-
*/
|
|
1671
|
-
zip_file_name?: string;
|
|
1672
|
-
source_type: "marketplace";
|
|
1673
|
-
resources?: BlueprintResource[];
|
|
1674
|
-
/**
|
|
1675
|
-
* Whether a newer version is available in the marketplace.
|
|
1676
|
-
*/
|
|
1677
|
-
has_update_available?: boolean;
|
|
1678
|
-
/**
|
|
1679
|
-
* The latest version available in the marketplace.
|
|
1680
|
-
* example:
|
|
1681
|
-
* v2.0.0
|
|
1682
|
-
*/
|
|
1683
|
-
latest_marketplace_version?: string;
|
|
1684
|
-
/**
|
|
1685
|
-
* URL to install/update the blueprint from the marketplace.
|
|
1686
|
-
*/
|
|
1687
|
-
installation_link?: string;
|
|
1688
|
-
}
|
|
1689
|
-
export interface MarketplaceListing {
|
|
1690
|
-
id: string; // uuid
|
|
1691
|
-
blueprint_id: string;
|
|
1692
|
-
name: string;
|
|
1693
|
-
slug: string;
|
|
1694
|
-
logo?: string | null;
|
|
1695
|
-
documentation_url?: string | null;
|
|
1696
|
-
pricing_type?: "free" | "paid" | "freemium" | "contact_us";
|
|
1697
|
-
support_email?: string | null;
|
|
1698
|
-
portal_description?: string | null;
|
|
1699
|
-
teaser_name?: string | null;
|
|
1700
|
-
teaser_short_description?: string | null;
|
|
1701
|
-
teaser_thumbnail?: string | null;
|
|
1702
|
-
details_page_title?: string | null;
|
|
1703
|
-
details_page_description?: string | null;
|
|
1704
|
-
details_page_hero_image?: string | null;
|
|
1705
|
-
details_page_carousel?: string[] | null;
|
|
1706
|
-
resources_section_description?: string | null;
|
|
1707
|
-
resources_section_benefits_title?: string | null;
|
|
1708
|
-
resources_section_benefits_list?: string | null;
|
|
1709
|
-
resources_section_process_details?: string | null;
|
|
1710
|
-
partner?: string | null;
|
|
1711
|
-
partner_subtext?: string | null;
|
|
1712
|
-
partner_logo?: string | null;
|
|
1713
|
-
partner_website_link?: string | null;
|
|
1714
|
-
last_updated_on?: string | null;
|
|
1715
|
-
requires_customer_portal?: boolean | null;
|
|
1716
|
-
process_details_section_title?: string | null;
|
|
1717
|
-
is_new_blueprint?: boolean | null;
|
|
1718
|
-
available_in?: string | null;
|
|
1719
|
-
testimonials?: string[] | null;
|
|
1720
|
-
installation_link?: string | null;
|
|
1721
|
-
installation_slug?: string | null;
|
|
1722
|
-
demo_form_link?: string | null;
|
|
1723
|
-
order?: number | null;
|
|
1724
|
-
categories?: string[] | null;
|
|
1725
|
-
main_category?: string[] | null;
|
|
1726
|
-
status: "draft" | "live" | "archived";
|
|
1727
|
-
created_at?: string; // date-time
|
|
1728
|
-
updated_at?: string; // date-time
|
|
1729
|
-
}
|
|
1730
|
-
export interface MarketplaceListingUpdate {
|
|
1731
|
-
name?: string;
|
|
1732
|
-
slug?: string;
|
|
1733
|
-
logo?: string | null;
|
|
1734
|
-
documentation_url?: string | null;
|
|
1735
|
-
pricing_type?: "free" | "paid" | "freemium" | "contact_us";
|
|
1736
|
-
support_email?: string | null;
|
|
1737
|
-
portal_description?: string | null;
|
|
1738
|
-
teaser_name?: string | null;
|
|
1739
|
-
teaser_short_description?: string | null;
|
|
1740
|
-
teaser_thumbnail?: string | null;
|
|
1741
|
-
details_page_title?: string | null;
|
|
1742
|
-
details_page_description?: string | null;
|
|
1743
|
-
details_page_hero_image?: string | null;
|
|
1744
|
-
details_page_carousel?: string[] | null;
|
|
1745
|
-
resources_section_description?: string | null;
|
|
1746
|
-
resources_section_benefits_title?: string | null;
|
|
1747
|
-
resources_section_benefits_list?: string | null;
|
|
1748
|
-
resources_section_process_details?: string | null;
|
|
1749
|
-
partner?: string | null;
|
|
1750
|
-
partner_subtext?: string | null;
|
|
1751
|
-
partner_logo?: string | null;
|
|
1752
|
-
partner_website_link?: string | null;
|
|
1753
|
-
last_updated_on?: string | null;
|
|
1754
|
-
requires_customer_portal?: boolean | null;
|
|
1755
|
-
process_details_section_title?: string | null;
|
|
1756
|
-
is_new_blueprint?: boolean | null;
|
|
1757
|
-
available_in?: string | null;
|
|
1758
|
-
testimonials?: string[] | null;
|
|
1759
|
-
installation_link?: string | null;
|
|
1760
|
-
installation_slug?: string | null;
|
|
1761
|
-
demo_form_link?: string | null;
|
|
1762
|
-
order?: number | null;
|
|
1763
|
-
categories?: string[] | null;
|
|
1764
|
-
main_category?: string[] | null;
|
|
1765
|
-
}
|
|
1766
|
-
export interface MarketplaceListingVersion {
|
|
1767
|
-
id: string; // uuid
|
|
1768
|
-
listing_id: string;
|
|
1769
|
-
status: "draft" | "published" | "archived";
|
|
1770
|
-
version_name?: string | null;
|
|
1771
|
-
draft_label: string;
|
|
1772
|
-
update_note?: string | null;
|
|
1773
|
-
resources?: {
|
|
1774
|
-
[key: string]: any;
|
|
1775
|
-
}[] | null;
|
|
1776
|
-
required_features?: string[] | null;
|
|
1777
|
-
recommended_apps?: string[] | null;
|
|
1778
|
-
created_at: string; // date-time
|
|
1779
|
-
published_at?: string | null; // date-time
|
|
1780
|
-
}
|
|
1781
|
-
export type PlanChanges = ("create" | "update" | "internal-update" | "no-op" | "delete" | "ignored")[];
|
|
1782
|
-
/**
|
|
1783
|
-
* List of feature settings that must be enabled before installing the blueprint
|
|
1784
|
-
* example:
|
|
1785
|
-
* [
|
|
1786
|
-
* "journey_automation",
|
|
1787
|
-
* "ticket-entities",
|
|
1788
|
-
* "advanced_permissions"
|
|
1789
|
-
* ]
|
|
1790
|
-
*/
|
|
1791
|
-
export type PreInstallRequirements = string[];
|
|
1792
|
-
export interface PutManifestPayload {
|
|
1793
|
-
/**
|
|
1794
|
-
* Name of the source blueprint
|
|
1795
|
-
*/
|
|
1796
|
-
source_blueprint_name?: string;
|
|
1797
|
-
/**
|
|
1798
|
-
* Markdown content of the manifest
|
|
1799
|
-
*/
|
|
1800
|
-
markdown?: string;
|
|
1801
|
-
/**
|
|
1802
|
-
* Array of ids of resources selected to be ready by the user
|
|
1803
|
-
*/
|
|
1804
|
-
ready_resources?: string[];
|
|
1805
|
-
deployed_to?: {
|
|
1806
|
-
/**
|
|
1807
|
-
* ID of the organization that the manifest was deployed to
|
|
1808
|
-
*/
|
|
1809
|
-
destination_organization_id?: string;
|
|
1810
|
-
/**
|
|
1811
|
-
* ID of the manifest that was deployed to
|
|
1812
|
-
*/
|
|
1813
|
-
destination_manifest_id?: string;
|
|
1814
|
-
destination_organization_type?: "sandbox" | "production";
|
|
1815
|
-
last_triggered_at?: string;
|
|
1816
|
-
}[];
|
|
1817
|
-
}
|
|
1818
|
-
export interface ResourceNode {
|
|
1819
|
-
/**
|
|
1820
|
-
* ID of the resource
|
|
1821
|
-
*/
|
|
1822
|
-
id: string;
|
|
1823
|
-
type: /* Type of the resource */ ResourceNodeType;
|
|
1824
|
-
/**
|
|
1825
|
-
* Name of the resource
|
|
1826
|
-
*/
|
|
1827
|
-
name?: string;
|
|
1828
|
-
/**
|
|
1829
|
-
* Original ID of the exported resource
|
|
1830
|
-
*/
|
|
1831
|
-
source_id?: string;
|
|
1832
|
-
/**
|
|
1833
|
-
* Whether the resource is virtual
|
|
1834
|
-
*/
|
|
1835
|
-
is_virtual?: boolean;
|
|
1836
|
-
/**
|
|
1837
|
-
* Terraform address of the resource
|
|
1838
|
-
*/
|
|
1839
|
-
address?: string;
|
|
1840
|
-
/**
|
|
1841
|
-
* Dependencies of the resource
|
|
1842
|
-
*/
|
|
1843
|
-
dependencies?: ResourceNode[] | null;
|
|
1844
|
-
parents?: {
|
|
1845
|
-
id?: string;
|
|
1846
|
-
type?: /* Type of the resource */ ResourceNodeType;
|
|
1847
|
-
}[];
|
|
1848
|
-
changes?: PlanChanges;
|
|
1849
|
-
/**
|
|
1850
|
-
* Fields causing the updates / internal updates on a resource install
|
|
1851
|
-
*/
|
|
1852
|
-
changes_reason?: string[];
|
|
1853
|
-
}
|
|
1854
|
-
/**
|
|
1855
|
-
* Type of the resource
|
|
1856
|
-
*/
|
|
1857
|
-
export 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";
|
|
1858
|
-
export interface ResourceReplacement {
|
|
1859
|
-
/**
|
|
1860
|
-
* Original resource ID to be replaced
|
|
1861
|
-
*/
|
|
1862
|
-
originalAddress: string;
|
|
1863
|
-
/**
|
|
1864
|
-
* ID of the resource that will replace the original
|
|
1865
|
-
*/
|
|
1866
|
-
replacementId: string;
|
|
1867
|
-
/**
|
|
1868
|
-
* Name of the resource that will replace the original
|
|
1869
|
-
*/
|
|
1870
|
-
replacementName?: string;
|
|
1871
|
-
}
|
|
1872
|
-
export interface ResourceVerificationResult {
|
|
1873
|
-
resource_type?: /* Type of the resource */ ResourceNodeType;
|
|
1874
|
-
resource_name?: string;
|
|
1875
|
-
source_resource_id?: string;
|
|
1876
|
-
destination_resource_id?: string;
|
|
1877
|
-
status?: "matched" | "mismatched" | "missing_in_destination" | "fetch_error";
|
|
1878
|
-
field_diffs?: FieldDiff[];
|
|
1879
|
-
error?: string;
|
|
1880
|
-
}
|
|
1881
|
-
export interface RootResourceNode {
|
|
1882
|
-
/**
|
|
1883
|
-
* ID of the resource
|
|
1884
|
-
*/
|
|
1885
|
-
id: string;
|
|
1886
|
-
type: /* Type of the resource */ ResourceNodeType;
|
|
1887
|
-
/**
|
|
1888
|
-
* Name of the resource
|
|
1889
|
-
*/
|
|
1890
|
-
name?: string;
|
|
1891
|
-
/**
|
|
1892
|
-
* Source ID of the resource
|
|
1893
|
-
*/
|
|
1894
|
-
source_id?: string;
|
|
1895
|
-
/**
|
|
1896
|
-
* Whether the resource is virtual
|
|
1897
|
-
*/
|
|
1898
|
-
is_virtual?: boolean;
|
|
1899
|
-
/**
|
|
1900
|
-
* Terraform address of the resource
|
|
1901
|
-
*/
|
|
1902
|
-
address?: string;
|
|
1903
|
-
/**
|
|
1904
|
-
* Dependencies of the resource
|
|
1905
|
-
*/
|
|
1906
|
-
dependencies?: VirtualResourceNodeGroup[] | null;
|
|
1907
|
-
changes?: PlanChanges;
|
|
1908
|
-
/**
|
|
1909
|
-
* Fields causing the updates / internal updates on a resource install
|
|
1910
|
-
*/
|
|
1911
|
-
changes_reason?: string[];
|
|
1912
|
-
}
|
|
1913
|
-
export interface S3Reference {
|
|
1914
|
-
/**
|
|
1915
|
-
* example:
|
|
1916
|
-
* blueprint-manifest-prod-blueprintsv2bucket-sybpsryropzw
|
|
1917
|
-
*/
|
|
1918
|
-
bucket: string;
|
|
1919
|
-
/**
|
|
1920
|
-
* example:
|
|
1921
|
-
* templates/main.tf
|
|
1922
|
-
*/
|
|
1923
|
-
key: string;
|
|
1924
|
-
}
|
|
1925
|
-
export interface SelectedResources {
|
|
1926
|
-
exported_root_resources: {
|
|
1927
|
-
id: string;
|
|
1928
|
-
type: /* Type of the resource */ ResourceNodeType;
|
|
1929
|
-
/**
|
|
1930
|
-
* Terraform address of the resource
|
|
1931
|
-
*/
|
|
1932
|
-
address?: string;
|
|
1933
|
-
}[];
|
|
1934
|
-
selected_resources: string[];
|
|
1935
|
-
/**
|
|
1936
|
-
* Pipeline ID selected when doing the sandbox sync
|
|
1937
|
-
*/
|
|
1938
|
-
pipeline_id?: string;
|
|
1939
|
-
}
|
|
1940
|
-
export interface UploadFilePayload {
|
|
1941
|
-
/**
|
|
1942
|
-
* example:
|
|
1943
|
-
* example.manifest.zip
|
|
1944
|
-
*/
|
|
1945
|
-
filename: string;
|
|
1946
|
-
}
|
|
1947
|
-
export interface VerificationSummary {
|
|
1948
|
-
total_resources?: number;
|
|
1949
|
-
matched?: number;
|
|
1950
|
-
mismatched?: number;
|
|
1951
|
-
missing_in_destination?: number;
|
|
1952
|
-
fetch_errors?: number;
|
|
1953
|
-
}
|
|
1954
|
-
export interface VirtualResourceNodeGroup {
|
|
1955
|
-
/**
|
|
1956
|
-
* ID of the resource
|
|
1957
|
-
*/
|
|
1958
|
-
id: string;
|
|
1959
|
-
type: /* Type of the resource */ ResourceNodeType;
|
|
1960
|
-
/**
|
|
1961
|
-
* Name of the resource
|
|
1962
|
-
*/
|
|
1963
|
-
name?: string;
|
|
1964
|
-
/**
|
|
1965
|
-
* Source ID of the resource
|
|
1966
|
-
*/
|
|
1967
|
-
source_id?: string;
|
|
1968
|
-
/**
|
|
1969
|
-
* Whether the resource is virtual
|
|
1970
|
-
*/
|
|
1971
|
-
is_virtual?: true;
|
|
1972
|
-
dependencies?: ResourceNode[];
|
|
1973
|
-
}
|
|
1974
|
-
}
|
|
1975
|
-
}
|
|
1976
|
-
declare namespace Paths {
|
|
1977
|
-
namespace AddBlueprintResource {
|
|
1978
|
-
namespace Parameters {
|
|
1979
|
-
/**
|
|
1980
|
-
* Whether to add this resource dependencies to the blueprint automatically
|
|
1981
|
-
*/
|
|
1982
|
-
export type AddDependencies = boolean;
|
|
1983
|
-
export type BlueprintId = /**
|
|
1984
|
-
* ID of a blueprint
|
|
1985
|
-
* example:
|
|
1986
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1987
|
-
*/
|
|
1988
|
-
Components.Schemas.BlueprintID;
|
|
1989
|
-
}
|
|
1990
|
-
export interface PathParameters {
|
|
1991
|
-
blueprint_id: Parameters.BlueprintId;
|
|
1992
|
-
}
|
|
1993
|
-
export interface QueryParameters {
|
|
1994
|
-
add_dependencies?: /* Whether to add this resource dependencies to the blueprint automatically */ Parameters.AddDependencies;
|
|
1995
|
-
}
|
|
1996
|
-
export type RequestBody = Components.Schemas.BlueprintResource;
|
|
1997
|
-
namespace Responses {
|
|
1998
|
-
export interface $200 {
|
|
1999
|
-
resources?: Components.Schemas.BlueprintResource[];
|
|
2000
|
-
}
|
|
2001
|
-
}
|
|
2002
|
-
}
|
|
2003
|
-
namespace ApplyPlan {
|
|
2004
|
-
namespace Parameters {
|
|
2005
|
-
export type JobId = /**
|
|
2006
|
-
* ID of an import or export job (state machine)
|
|
2007
|
-
* example:
|
|
2008
|
-
* 4854bb2a-94f9-424d-a968-3fb17fb0bf89
|
|
2009
|
-
*/
|
|
2010
|
-
Components.Schemas.JobID;
|
|
2011
|
-
}
|
|
2012
|
-
export interface PathParameters {
|
|
2013
|
-
job_id: Parameters.JobId;
|
|
2014
|
-
}
|
|
2015
|
-
export interface RequestBody {
|
|
2016
|
-
/**
|
|
2017
|
-
* List of resources to ignore changes for
|
|
2018
|
-
*/
|
|
2019
|
-
resourcesToIgnore?: string[];
|
|
2020
|
-
/**
|
|
2021
|
-
* List of resource replacements to apply during import
|
|
2022
|
-
*/
|
|
2023
|
-
resourceReplacements?: Components.Schemas.ResourceReplacement[];
|
|
2024
|
-
}
|
|
2025
|
-
namespace Responses {
|
|
2026
|
-
export interface $200 {
|
|
2027
|
-
jobId?: /**
|
|
2028
|
-
* ID of an import or export job (state machine)
|
|
2029
|
-
* example:
|
|
2030
|
-
* 4854bb2a-94f9-424d-a968-3fb17fb0bf89
|
|
2031
|
-
*/
|
|
2032
|
-
Components.Schemas.JobID;
|
|
2033
|
-
}
|
|
2034
|
-
}
|
|
2035
|
-
}
|
|
2036
|
-
namespace BulkAddBlueprintResources {
|
|
2037
|
-
namespace Parameters {
|
|
2038
|
-
/**
|
|
2039
|
-
* Whether to add this resource dependencies to the blueprint automatically
|
|
2040
|
-
*/
|
|
2041
|
-
export type AddDependencies = boolean;
|
|
2042
|
-
export type BlueprintId = /**
|
|
2043
|
-
* ID of a blueprint
|
|
2044
|
-
* example:
|
|
2045
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2046
|
-
*/
|
|
2047
|
-
Components.Schemas.BlueprintID;
|
|
2048
|
-
}
|
|
2049
|
-
export interface PathParameters {
|
|
2050
|
-
blueprint_id: Parameters.BlueprintId;
|
|
2051
|
-
}
|
|
2052
|
-
export interface QueryParameters {
|
|
2053
|
-
add_dependencies?: /* Whether to add this resource dependencies to the blueprint automatically */ Parameters.AddDependencies;
|
|
2054
|
-
}
|
|
2055
|
-
export type RequestBody = Components.Schemas.BlueprintResource[];
|
|
2056
|
-
namespace Responses {
|
|
2057
|
-
export interface $200 {
|
|
2058
|
-
resources?: Components.Schemas.BlueprintResource[];
|
|
2059
|
-
}
|
|
2060
|
-
}
|
|
2061
|
-
}
|
|
2062
|
-
namespace BulkDeleteBlueprintResources {
|
|
2063
|
-
namespace Parameters {
|
|
2064
|
-
export type BlueprintId = /**
|
|
2065
|
-
* ID of a blueprint
|
|
2066
|
-
* example:
|
|
2067
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2068
|
-
*/
|
|
2069
|
-
Components.Schemas.BlueprintID;
|
|
2070
|
-
}
|
|
2071
|
-
export interface PathParameters {
|
|
2072
|
-
blueprint_id: Parameters.BlueprintId;
|
|
2073
|
-
}
|
|
2074
|
-
export type RequestBody = /**
|
|
2075
|
-
* ID of a blueprint resource
|
|
2076
|
-
* example:
|
|
2077
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2078
|
-
*/
|
|
2079
|
-
Components.Schemas.BlueprintResourceID[];
|
|
2080
|
-
namespace Responses {
|
|
2081
|
-
export interface $200 {
|
|
2082
|
-
resources?: Components.Schemas.BlueprintResource[];
|
|
2083
|
-
}
|
|
2084
|
-
}
|
|
2085
|
-
}
|
|
2086
|
-
namespace BulkUpdateBlueprintResources {
|
|
2087
|
-
namespace Parameters {
|
|
2088
|
-
export type BlueprintId = /**
|
|
2089
|
-
* ID of a blueprint
|
|
2090
|
-
* example:
|
|
2091
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2092
|
-
*/
|
|
2093
|
-
Components.Schemas.BlueprintID;
|
|
2094
|
-
}
|
|
2095
|
-
export interface PathParameters {
|
|
2096
|
-
blueprint_id: Parameters.BlueprintId;
|
|
2097
|
-
}
|
|
2098
|
-
export type RequestBody = Components.Schemas.BlueprintResource[];
|
|
2099
|
-
namespace Responses {
|
|
2100
|
-
export interface $200 {
|
|
2101
|
-
resources?: Components.Schemas.BlueprintResource[];
|
|
2102
|
-
}
|
|
2103
|
-
}
|
|
2104
|
-
}
|
|
2105
|
-
namespace CancelBlueprintJob {
|
|
2106
|
-
namespace Parameters {
|
|
2107
|
-
export type JobId = /**
|
|
2108
|
-
* ID of a job
|
|
2109
|
-
* example:
|
|
2110
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2111
|
-
*/
|
|
2112
|
-
Components.Schemas.BlueprintJobID;
|
|
2113
|
-
}
|
|
2114
|
-
export interface PathParameters {
|
|
2115
|
-
job_id: Parameters.JobId;
|
|
2116
|
-
}
|
|
2117
|
-
namespace Responses {
|
|
2118
|
-
export type $200 = Components.Schemas.BlueprintJob;
|
|
2119
|
-
}
|
|
2120
|
-
}
|
|
2121
|
-
namespace ContinueInstallationJob {
|
|
2122
|
-
namespace Parameters {
|
|
2123
|
-
export type JobId = /**
|
|
2124
|
-
* ID of a job
|
|
2125
|
-
* example:
|
|
2126
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2127
|
-
*/
|
|
2128
|
-
Components.Schemas.BlueprintJobID;
|
|
2129
|
-
}
|
|
2130
|
-
export interface PathParameters {
|
|
2131
|
-
job_id: Parameters.JobId;
|
|
2132
|
-
}
|
|
2133
|
-
export type RequestBody = Components.Schemas.BlueprintInstallationJobOptions;
|
|
2134
|
-
namespace Responses {
|
|
2135
|
-
export type $200 = Components.Schemas.BlueprintInstallationJob;
|
|
2136
|
-
}
|
|
2137
|
-
}
|
|
2138
|
-
namespace CreateBlueprint {
|
|
2139
|
-
export type RequestBody = Components.Schemas.Blueprint;
|
|
2140
|
-
namespace Responses {
|
|
2141
|
-
export type $200 = Components.Schemas.Blueprint;
|
|
2142
|
-
}
|
|
2143
|
-
}
|
|
2144
|
-
namespace CreateExport {
|
|
2145
|
-
export interface RequestBody {
|
|
2146
|
-
resources: [
|
|
2147
|
-
{
|
|
2148
|
-
type: /* Type of the resource */ Components.Schemas.ResourceNodeType;
|
|
2149
|
-
id: string;
|
|
2150
|
-
},
|
|
2151
|
-
...{
|
|
2152
|
-
type: /* Type of the resource */ Components.Schemas.ResourceNodeType;
|
|
2153
|
-
id: string;
|
|
2154
|
-
}[]
|
|
2155
|
-
];
|
|
2156
|
-
jobId?: /**
|
|
2157
|
-
* ID of an import or export job (state machine)
|
|
2158
|
-
* example:
|
|
2159
|
-
* 4854bb2a-94f9-424d-a968-3fb17fb0bf89
|
|
2160
|
-
*/
|
|
2161
|
-
Components.Schemas.JobID;
|
|
2162
|
-
/**
|
|
2163
|
-
* Temporary flag to indicate if multiple resources are being exported
|
|
2164
|
-
*/
|
|
2165
|
-
isExportingMultipleResources?: boolean;
|
|
2166
|
-
/**
|
|
2167
|
-
* Pipeline ID selected when doing the sandbox sync
|
|
2168
|
-
*/
|
|
2169
|
-
pipelineId?: string;
|
|
2170
|
-
/**
|
|
2171
|
-
* ID of the installed manifest to load the resource addresses from
|
|
2172
|
-
*/
|
|
2173
|
-
manifestId?: string;
|
|
2174
|
-
}
|
|
2175
|
-
namespace Responses {
|
|
2176
|
-
export interface $200 {
|
|
2177
|
-
jobId?: /**
|
|
2178
|
-
* ID of an import or export job (state machine)
|
|
2179
|
-
* example:
|
|
2180
|
-
* 4854bb2a-94f9-424d-a968-3fb17fb0bf89
|
|
2181
|
-
*/
|
|
2182
|
-
Components.Schemas.JobID;
|
|
2183
|
-
}
|
|
2184
|
-
}
|
|
2185
|
-
}
|
|
2186
|
-
namespace CreateMarketplaceListing {
|
|
2187
|
-
namespace Parameters {
|
|
2188
|
-
export type BlueprintId = string;
|
|
2189
|
-
}
|
|
2190
|
-
export interface PathParameters {
|
|
2191
|
-
blueprint_id: Parameters.BlueprintId;
|
|
2192
|
-
}
|
|
2193
|
-
export interface RequestBody {
|
|
2194
|
-
name: string;
|
|
2195
|
-
slug?: string;
|
|
2196
|
-
}
|
|
2197
|
-
namespace Responses {
|
|
2198
|
-
export type $201 = Components.Schemas.MarketplaceListing;
|
|
2199
|
-
export interface $409 {
|
|
2200
|
-
}
|
|
2201
|
-
}
|
|
2202
|
-
}
|
|
2203
|
-
namespace CreateMarketplaceListingVersion {
|
|
2204
|
-
namespace Parameters {
|
|
2205
|
-
export type ListingId = string;
|
|
2206
|
-
}
|
|
2207
|
-
export interface PathParameters {
|
|
2208
|
-
listing_id: Parameters.ListingId;
|
|
2209
|
-
}
|
|
2210
|
-
namespace Responses {
|
|
2211
|
-
export type $201 = Components.Schemas.MarketplaceListingVersion;
|
|
2212
|
-
export interface $404 {
|
|
2213
|
-
}
|
|
2214
|
-
}
|
|
2215
|
-
}
|
|
2216
|
-
namespace CreatePlan {
|
|
2217
|
-
export type RequestBody = {
|
|
2218
|
-
/**
|
|
2219
|
-
* s3ref of manifest file uploaded via `uploadManifest`
|
|
2220
|
-
*/
|
|
2221
|
-
s3ref: {
|
|
2222
|
-
/**
|
|
2223
|
-
* example:
|
|
2224
|
-
* blueprint-manifest-prod-blueprintsv2bucket-sybpsryropzw
|
|
2225
|
-
*/
|
|
2226
|
-
bucket: string;
|
|
2227
|
-
/**
|
|
2228
|
-
* example:
|
|
2229
|
-
* templates/main.tf
|
|
2230
|
-
*/
|
|
2231
|
-
key: string;
|
|
2232
|
-
};
|
|
2233
|
-
/**
|
|
2234
|
-
* ID of an imported / installed manifest
|
|
2235
|
-
* example:
|
|
2236
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2237
|
-
*/
|
|
2238
|
-
manifest_id?: string;
|
|
2239
|
-
/**
|
|
2240
|
-
* ID of an import or export job (state machine)
|
|
2241
|
-
* example:
|
|
2242
|
-
* 4854bb2a-94f9-424d-a968-3fb17fb0bf89
|
|
2243
|
-
*/
|
|
2244
|
-
job_id?: string;
|
|
2245
|
-
/**
|
|
2246
|
-
* Source of the manifest
|
|
2247
|
-
*/
|
|
2248
|
-
source?: "file" | "marketplace" | "sandbox";
|
|
2249
|
-
/**
|
|
2250
|
-
* List of resources to ignore changes for
|
|
2251
|
-
*/
|
|
2252
|
-
resourcesToIgnore?: string[];
|
|
2253
|
-
/**
|
|
2254
|
-
* List of resource replacements to apply during import
|
|
2255
|
-
*/
|
|
2256
|
-
resourceReplacements?: Components.Schemas.ResourceReplacement[];
|
|
2257
|
-
deployedFrom?: {
|
|
2258
|
-
sourceOrganizationId: string;
|
|
2259
|
-
sourceManifestId: string;
|
|
2260
|
-
sourceOrganizationType: "sandbox" | "production";
|
|
2261
|
-
};
|
|
2262
|
-
} | {
|
|
2263
|
-
/**
|
|
2264
|
-
* Manifest s3 key uploaded via `uploadManifest`
|
|
2265
|
-
*/
|
|
2266
|
-
manifestFilePath: string;
|
|
2267
|
-
/**
|
|
2268
|
-
* ID of an imported / installed manifest
|
|
2269
|
-
* example:
|
|
2270
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2271
|
-
*/
|
|
2272
|
-
manifest_id?: string;
|
|
2273
|
-
/**
|
|
2274
|
-
* ID of an import or export job (state machine)
|
|
2275
|
-
* example:
|
|
2276
|
-
* 4854bb2a-94f9-424d-a968-3fb17fb0bf89
|
|
2277
|
-
*/
|
|
2278
|
-
job_id?: string;
|
|
2279
|
-
/**
|
|
2280
|
-
* Source of the manifest
|
|
2281
|
-
*/
|
|
2282
|
-
source?: "file" | "marketplace" | "sandbox";
|
|
2283
|
-
/**
|
|
2284
|
-
* List of resources to ignore changes for
|
|
2285
|
-
*/
|
|
2286
|
-
resourcesToIgnore?: string[];
|
|
2287
|
-
/**
|
|
2288
|
-
* List of resource replacements to apply during import
|
|
2289
|
-
*/
|
|
2290
|
-
resourceReplacements?: Components.Schemas.ResourceReplacement[];
|
|
2291
|
-
deployedFrom?: {
|
|
2292
|
-
sourceOrganizationId: string;
|
|
2293
|
-
sourceManifestId: string;
|
|
2294
|
-
sourceOrganizationType: "sandbox" | "production";
|
|
2295
|
-
};
|
|
2296
|
-
};
|
|
2297
|
-
namespace Responses {
|
|
2298
|
-
export interface $200 {
|
|
2299
|
-
/**
|
|
2300
|
-
* example:
|
|
2301
|
-
* 4854bb2a-94f9-424d-a968-3fb17fb0bf89
|
|
2302
|
-
*/
|
|
2303
|
-
jobId?: string;
|
|
2304
|
-
}
|
|
2305
|
-
}
|
|
2306
|
-
}
|
|
2307
|
-
namespace DeleteBlueprint {
|
|
2308
|
-
namespace Parameters {
|
|
2309
|
-
export type BlueprintId = /**
|
|
2310
|
-
* ID of a blueprint
|
|
2311
|
-
* example:
|
|
2312
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2313
|
-
*/
|
|
2314
|
-
Components.Schemas.BlueprintID;
|
|
2315
|
-
}
|
|
2316
|
-
export interface PathParameters {
|
|
2317
|
-
blueprint_id: Parameters.BlueprintId;
|
|
2318
|
-
}
|
|
2319
|
-
namespace Responses {
|
|
2320
|
-
export type $200 = Components.Schemas.Blueprint;
|
|
2321
|
-
}
|
|
2322
|
-
}
|
|
2323
|
-
namespace DeleteBlueprintResource {
|
|
2324
|
-
namespace Parameters {
|
|
2325
|
-
export type BlueprintId = /**
|
|
2326
|
-
* ID of a blueprint
|
|
2327
|
-
* example:
|
|
2328
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2329
|
-
*/
|
|
2330
|
-
Components.Schemas.BlueprintID;
|
|
2331
|
-
export type ResourceId = /**
|
|
2332
|
-
* ID of a blueprint resource
|
|
2333
|
-
* example:
|
|
2334
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2335
|
-
*/
|
|
2336
|
-
Components.Schemas.BlueprintResourceID;
|
|
2337
|
-
}
|
|
2338
|
-
export interface PathParameters {
|
|
2339
|
-
blueprint_id: Parameters.BlueprintId;
|
|
2340
|
-
resource_id: Parameters.ResourceId;
|
|
2341
|
-
}
|
|
2342
|
-
namespace Responses {
|
|
2343
|
-
export interface $200 {
|
|
2344
|
-
resources?: Components.Schemas.BlueprintResource[];
|
|
2345
|
-
}
|
|
2346
|
-
}
|
|
2347
|
-
}
|
|
2348
|
-
namespace DeleteManifest {
|
|
2349
|
-
namespace Parameters {
|
|
2350
|
-
export type ManifestId = /**
|
|
2351
|
-
* ID of an imported / installed manifest
|
|
2352
|
-
* example:
|
|
2353
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2354
|
-
*/
|
|
2355
|
-
Components.Schemas.ManifestID;
|
|
2356
|
-
}
|
|
2357
|
-
export interface PathParameters {
|
|
2358
|
-
manifest_id: Parameters.ManifestId;
|
|
2359
|
-
}
|
|
2360
|
-
namespace Responses {
|
|
2361
|
-
export type $200 = Components.Schemas.Manifest;
|
|
2362
|
-
}
|
|
2363
|
-
}
|
|
2364
|
-
namespace DeleteMarketplaceListing {
|
|
2365
|
-
namespace Parameters {
|
|
2366
|
-
export type ListingId = string;
|
|
2367
|
-
}
|
|
2368
|
-
export interface PathParameters {
|
|
2369
|
-
listing_id: Parameters.ListingId;
|
|
2370
|
-
}
|
|
2371
|
-
namespace Responses {
|
|
2372
|
-
export interface $204 {
|
|
2373
|
-
}
|
|
2374
|
-
export interface $404 {
|
|
2375
|
-
}
|
|
2376
|
-
}
|
|
2377
|
-
}
|
|
2378
|
-
namespace ExportBlueprint {
|
|
2379
|
-
namespace Parameters {
|
|
2380
|
-
export type BlueprintId = /**
|
|
2381
|
-
* ID of a blueprint
|
|
2382
|
-
* example:
|
|
2383
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2384
|
-
*/
|
|
2385
|
-
Components.Schemas.BlueprintID;
|
|
2386
|
-
}
|
|
2387
|
-
export interface PathParameters {
|
|
2388
|
-
blueprint_id: Parameters.BlueprintId;
|
|
2389
|
-
}
|
|
2390
|
-
export interface RequestBody {
|
|
2391
|
-
destination_org_id?: string;
|
|
2392
|
-
destination_blueprint_id?: string;
|
|
2393
|
-
/**
|
|
2394
|
-
* When true, run terraform validate before creating the export zip. If validation fails, the job will be marked as FAILED with errors.
|
|
2395
|
-
*/
|
|
2396
|
-
validate?: boolean;
|
|
2397
|
-
}
|
|
2398
|
-
namespace Responses {
|
|
2399
|
-
export interface $202 {
|
|
2400
|
-
job_id?: /**
|
|
2401
|
-
* ID of a job
|
|
2402
|
-
* example:
|
|
2403
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2404
|
-
*/
|
|
2405
|
-
Components.Schemas.BlueprintJobID;
|
|
2406
|
-
}
|
|
2407
|
-
}
|
|
2408
|
-
}
|
|
2409
|
-
namespace ExportManifest {
|
|
2410
|
-
namespace Parameters {
|
|
2411
|
-
export type JobId = /**
|
|
2412
|
-
* ID of an import or export job (state machine)
|
|
2413
|
-
* example:
|
|
2414
|
-
* 4854bb2a-94f9-424d-a968-3fb17fb0bf89
|
|
2415
|
-
*/
|
|
2416
|
-
Components.Schemas.JobID;
|
|
2417
|
-
}
|
|
2418
|
-
export interface PathParameters {
|
|
2419
|
-
job_id: Parameters.JobId;
|
|
2420
|
-
}
|
|
2421
|
-
export interface RequestBody {
|
|
2422
|
-
/**
|
|
2423
|
-
* An array of resource IDs to export
|
|
2424
|
-
*/
|
|
2425
|
-
selectedResourceIds: string[];
|
|
2426
|
-
/**
|
|
2427
|
-
* example:
|
|
2428
|
-
* journey_HouseConnectionJourney
|
|
2429
|
-
*/
|
|
2430
|
-
resourceName: string;
|
|
2431
|
-
metadata?: {
|
|
2432
|
-
markdown?: {
|
|
2433
|
-
manifest?: string;
|
|
2434
|
-
preinstall?: string;
|
|
2435
|
-
postinstall?: string;
|
|
2436
|
-
};
|
|
2437
|
-
docs_link?: string;
|
|
2438
|
-
source_blueprint_name?: string;
|
|
2439
|
-
source_blueprint_slug?: string;
|
|
2440
|
-
source_blueprint_version?: string;
|
|
2441
|
-
};
|
|
2442
|
-
/**
|
|
2443
|
-
* Temporary flag to indicate if multiple resources are being exported
|
|
2444
|
-
*/
|
|
2445
|
-
isExportingMultipleResources?: boolean;
|
|
2446
|
-
generateAISummary?: boolean;
|
|
2447
|
-
language?: "en" | "de";
|
|
2448
|
-
}
|
|
2449
|
-
namespace Responses {
|
|
2450
|
-
export interface $200 {
|
|
2451
|
-
jobId?: /**
|
|
2452
|
-
* ID of an import or export job (state machine)
|
|
2453
|
-
* example:
|
|
2454
|
-
* 4854bb2a-94f9-424d-a968-3fb17fb0bf89
|
|
2455
|
-
*/
|
|
2456
|
-
Components.Schemas.JobID;
|
|
2457
|
-
}
|
|
2458
|
-
}
|
|
2459
|
-
}
|
|
2460
|
-
namespace FormatBlueprintDescription {
|
|
2461
|
-
namespace Parameters {
|
|
2462
|
-
export type BlueprintId = /**
|
|
2463
|
-
* ID of a blueprint
|
|
2464
|
-
* example:
|
|
2465
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2466
|
-
*/
|
|
2467
|
-
Components.Schemas.BlueprintID;
|
|
2468
|
-
}
|
|
2469
|
-
export interface PathParameters {
|
|
2470
|
-
blueprint_id: Parameters.BlueprintId;
|
|
2471
|
-
}
|
|
2472
|
-
export interface RequestBody {
|
|
2473
|
-
/**
|
|
2474
|
-
* Plain text to format as markdown
|
|
2475
|
-
*/
|
|
2476
|
-
text: string;
|
|
2477
|
-
}
|
|
2478
|
-
namespace Responses {
|
|
2479
|
-
export interface $200 {
|
|
2480
|
-
/**
|
|
2481
|
-
* AI-formatted markdown content
|
|
2482
|
-
*/
|
|
2483
|
-
markdown?: string;
|
|
2484
|
-
}
|
|
2485
|
-
}
|
|
2486
|
-
}
|
|
2487
|
-
namespace GetBlueprint {
|
|
2488
|
-
namespace Parameters {
|
|
2489
|
-
export type BlueprintId = /**
|
|
2490
|
-
* ID of a blueprint
|
|
2491
|
-
* example:
|
|
2492
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2493
|
-
*/
|
|
2494
|
-
Components.Schemas.BlueprintID;
|
|
2495
|
-
}
|
|
2496
|
-
export interface PathParameters {
|
|
2497
|
-
blueprint_id: Parameters.BlueprintId;
|
|
2498
|
-
}
|
|
2499
|
-
namespace Responses {
|
|
2500
|
-
export type $200 = Components.Schemas.Blueprint;
|
|
2501
|
-
}
|
|
2502
|
-
}
|
|
2503
|
-
namespace GetBlueprintJob {
|
|
2504
|
-
namespace Parameters {
|
|
2505
|
-
export type JobId = /**
|
|
2506
|
-
* ID of a job
|
|
2507
|
-
* example:
|
|
2508
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2509
|
-
*/
|
|
2510
|
-
Components.Schemas.BlueprintJobID;
|
|
2511
|
-
}
|
|
2512
|
-
export interface PathParameters {
|
|
2513
|
-
job_id: Parameters.JobId;
|
|
2514
|
-
}
|
|
2515
|
-
namespace Responses {
|
|
2516
|
-
export type $200 = Components.Schemas.BlueprintJob;
|
|
2517
|
-
}
|
|
2518
|
-
}
|
|
2519
|
-
namespace GetBlueprintLineageV3 {
|
|
2520
|
-
namespace Parameters {
|
|
2521
|
-
export type BlueprintId = /**
|
|
2522
|
-
* ID of a blueprint
|
|
2523
|
-
* example:
|
|
2524
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2525
|
-
*/
|
|
2526
|
-
Components.Schemas.BlueprintID;
|
|
2527
|
-
}
|
|
2528
|
-
export interface PathParameters {
|
|
2529
|
-
blueprint_id: Parameters.BlueprintId;
|
|
2530
|
-
}
|
|
2531
|
-
namespace Responses {
|
|
2532
|
-
export interface $200 {
|
|
2533
|
-
total?: number;
|
|
2534
|
-
entries?: Components.Schemas.LineageEntry[];
|
|
2535
|
-
}
|
|
2536
|
-
}
|
|
2537
|
-
}
|
|
2538
|
-
namespace GetBlueprintPreview {
|
|
2539
|
-
namespace Parameters {
|
|
2540
|
-
export type PreviewId = string;
|
|
2541
|
-
}
|
|
2542
|
-
export interface PathParameters {
|
|
2543
|
-
preview_id: Parameters.PreviewId;
|
|
2544
|
-
}
|
|
2545
|
-
namespace Responses {
|
|
2546
|
-
export type $200 = /* Preview data for a blueprint before installation. Stored temporarily with TTL. */ Components.Schemas.BlueprintPreview;
|
|
2547
|
-
export interface $404 {
|
|
2548
|
-
}
|
|
2549
|
-
}
|
|
2550
|
-
}
|
|
2551
|
-
namespace GetJob {
|
|
2552
|
-
namespace Parameters {
|
|
2553
|
-
export type JobId = /**
|
|
2554
|
-
* ID of an import or export job (state machine)
|
|
2555
|
-
* example:
|
|
2556
|
-
* 4854bb2a-94f9-424d-a968-3fb17fb0bf89
|
|
2557
|
-
*/
|
|
2558
|
-
Components.Schemas.JobID;
|
|
2559
|
-
}
|
|
2560
|
-
export interface PathParameters {
|
|
2561
|
-
job_id: Parameters.JobId;
|
|
2562
|
-
}
|
|
2563
|
-
namespace Responses {
|
|
2564
|
-
export type $200 = Components.Schemas.Job;
|
|
2565
|
-
}
|
|
2566
|
-
}
|
|
2567
|
-
namespace GetManifest {
|
|
2568
|
-
namespace Parameters {
|
|
2569
|
-
export type ManifestId = /**
|
|
2570
|
-
* ID of an imported / installed manifest
|
|
2571
|
-
* example:
|
|
2572
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2573
|
-
*/
|
|
2574
|
-
Components.Schemas.ManifestID;
|
|
2575
|
-
}
|
|
2576
|
-
export interface PathParameters {
|
|
2577
|
-
manifest_id: Parameters.ManifestId;
|
|
2578
|
-
}
|
|
2579
|
-
namespace Responses {
|
|
2580
|
-
export type $200 = Components.Schemas.Manifest;
|
|
2581
|
-
}
|
|
2582
|
-
}
|
|
2583
|
-
namespace GetMarketplaceListing {
|
|
2584
|
-
namespace Parameters {
|
|
2585
|
-
export type BlueprintId = string;
|
|
2586
|
-
}
|
|
2587
|
-
export interface PathParameters {
|
|
2588
|
-
blueprint_id: Parameters.BlueprintId;
|
|
2589
|
-
}
|
|
2590
|
-
namespace Responses {
|
|
2591
|
-
export interface $200 {
|
|
2592
|
-
id: string; // uuid
|
|
2593
|
-
blueprint_id: string;
|
|
2594
|
-
name: string;
|
|
2595
|
-
slug: string;
|
|
2596
|
-
logo?: string | null;
|
|
2597
|
-
documentation_url?: string | null;
|
|
2598
|
-
pricing_type?: "free" | "paid" | "freemium" | "contact_us";
|
|
2599
|
-
support_email?: string | null;
|
|
2600
|
-
portal_description?: string | null;
|
|
2601
|
-
teaser_name?: string | null;
|
|
2602
|
-
teaser_short_description?: string | null;
|
|
2603
|
-
teaser_thumbnail?: string | null;
|
|
2604
|
-
details_page_title?: string | null;
|
|
2605
|
-
details_page_description?: string | null;
|
|
2606
|
-
details_page_hero_image?: string | null;
|
|
2607
|
-
details_page_carousel?: string[] | null;
|
|
2608
|
-
resources_section_description?: string | null;
|
|
2609
|
-
resources_section_benefits_title?: string | null;
|
|
2610
|
-
resources_section_benefits_list?: string | null;
|
|
2611
|
-
resources_section_process_details?: string | null;
|
|
2612
|
-
partner?: string | null;
|
|
2613
|
-
partner_subtext?: string | null;
|
|
2614
|
-
partner_logo?: string | null;
|
|
2615
|
-
partner_website_link?: string | null;
|
|
2616
|
-
last_updated_on?: string | null;
|
|
2617
|
-
requires_customer_portal?: boolean | null;
|
|
2618
|
-
process_details_section_title?: string | null;
|
|
2619
|
-
is_new_blueprint?: boolean | null;
|
|
2620
|
-
available_in?: string | null;
|
|
2621
|
-
testimonials?: string[] | null;
|
|
2622
|
-
installation_link?: string | null;
|
|
2623
|
-
installation_slug?: string | null;
|
|
2624
|
-
demo_form_link?: string | null;
|
|
2625
|
-
order?: number | null;
|
|
2626
|
-
categories?: string[] | null;
|
|
2627
|
-
main_category?: string[] | null;
|
|
2628
|
-
status: "draft" | "live" | "archived";
|
|
2629
|
-
created_at?: string; // date-time
|
|
2630
|
-
updated_at?: string; // date-time
|
|
2631
|
-
versions?: Components.Schemas.MarketplaceListingVersion[];
|
|
2632
|
-
has_publishable_draft?: boolean;
|
|
2633
|
-
}
|
|
2634
|
-
export interface $404 {
|
|
2635
|
-
}
|
|
2636
|
-
}
|
|
2637
|
-
}
|
|
2638
|
-
namespace GetMarketplaceListingById {
|
|
2639
|
-
namespace Parameters {
|
|
2640
|
-
export type ListingId = string;
|
|
2641
|
-
}
|
|
2642
|
-
export interface PathParameters {
|
|
2643
|
-
listing_id: Parameters.ListingId;
|
|
2644
|
-
}
|
|
2645
|
-
namespace Responses {
|
|
2646
|
-
export interface $200 {
|
|
2647
|
-
id: string; // uuid
|
|
2648
|
-
blueprint_id: string;
|
|
2649
|
-
name: string;
|
|
2650
|
-
slug: string;
|
|
2651
|
-
logo?: string | null;
|
|
2652
|
-
documentation_url?: string | null;
|
|
2653
|
-
pricing_type?: "free" | "paid" | "freemium" | "contact_us";
|
|
2654
|
-
support_email?: string | null;
|
|
2655
|
-
portal_description?: string | null;
|
|
2656
|
-
teaser_name?: string | null;
|
|
2657
|
-
teaser_short_description?: string | null;
|
|
2658
|
-
teaser_thumbnail?: string | null;
|
|
2659
|
-
details_page_title?: string | null;
|
|
2660
|
-
details_page_description?: string | null;
|
|
2661
|
-
details_page_hero_image?: string | null;
|
|
2662
|
-
details_page_carousel?: string[] | null;
|
|
2663
|
-
resources_section_description?: string | null;
|
|
2664
|
-
resources_section_benefits_title?: string | null;
|
|
2665
|
-
resources_section_benefits_list?: string | null;
|
|
2666
|
-
resources_section_process_details?: string | null;
|
|
2667
|
-
partner?: string | null;
|
|
2668
|
-
partner_subtext?: string | null;
|
|
2669
|
-
partner_logo?: string | null;
|
|
2670
|
-
partner_website_link?: string | null;
|
|
2671
|
-
last_updated_on?: string | null;
|
|
2672
|
-
requires_customer_portal?: boolean | null;
|
|
2673
|
-
process_details_section_title?: string | null;
|
|
2674
|
-
is_new_blueprint?: boolean | null;
|
|
2675
|
-
available_in?: string | null;
|
|
2676
|
-
testimonials?: string[] | null;
|
|
2677
|
-
installation_link?: string | null;
|
|
2678
|
-
installation_slug?: string | null;
|
|
2679
|
-
demo_form_link?: string | null;
|
|
2680
|
-
order?: number | null;
|
|
2681
|
-
categories?: string[] | null;
|
|
2682
|
-
main_category?: string[] | null;
|
|
2683
|
-
status: "draft" | "live" | "archived";
|
|
2684
|
-
created_at?: string; // date-time
|
|
2685
|
-
updated_at?: string; // date-time
|
|
2686
|
-
versions?: Components.Schemas.MarketplaceListingVersion[];
|
|
2687
|
-
has_publishable_draft?: boolean;
|
|
2688
|
-
}
|
|
2689
|
-
export interface $404 {
|
|
2690
|
-
}
|
|
2691
|
-
}
|
|
2692
|
-
}
|
|
2693
|
-
namespace InstallBlueprint {
|
|
2694
|
-
export interface RequestBody {
|
|
2695
|
-
source_org_id?: string;
|
|
2696
|
-
source_blueprint_id?: /**
|
|
2697
|
-
* ID of a blueprint
|
|
2698
|
-
* example:
|
|
2699
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2700
|
-
*/
|
|
2701
|
-
Components.Schemas.BlueprintID;
|
|
2702
|
-
/**
|
|
2703
|
-
* URL to the blueprint zip file
|
|
2704
|
-
*/
|
|
2705
|
-
source_blueprint_file?: string;
|
|
2706
|
-
destination_org_id?: string;
|
|
2707
|
-
destination_blueprint_id?: /**
|
|
2708
|
-
* ID of a blueprint
|
|
2709
|
-
* example:
|
|
2710
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2711
|
-
*/
|
|
2712
|
-
Components.Schemas.BlueprintID;
|
|
2713
|
-
options?: Components.Schemas.BlueprintInstallationJobOptions;
|
|
2714
|
-
/**
|
|
2715
|
-
* Installation mode
|
|
2716
|
-
*/
|
|
2717
|
-
mode: "simple" | "advanced";
|
|
2718
|
-
source_blueprint_type?: "marketplace";
|
|
2719
|
-
/**
|
|
2720
|
-
* Slug to enforce in this blueprint. Used in marketplace blueprints to keep it consistent with webflow.
|
|
2721
|
-
*/
|
|
2722
|
-
slug?: string;
|
|
2723
|
-
/**
|
|
2724
|
-
* If true, automatically enable required features in the destination org before installing
|
|
2725
|
-
*/
|
|
2726
|
-
auto_enable_features?: boolean;
|
|
2727
|
-
}
|
|
2728
|
-
namespace Responses {
|
|
2729
|
-
export interface $202 {
|
|
2730
|
-
job_id?: /**
|
|
2731
|
-
* ID of a job
|
|
2732
|
-
* example:
|
|
2733
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2734
|
-
*/
|
|
2735
|
-
Components.Schemas.BlueprintJobID;
|
|
2736
|
-
destination_blueprint_id?: /**
|
|
2737
|
-
* ID of a blueprint
|
|
2738
|
-
* example:
|
|
2739
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2740
|
-
*/
|
|
2741
|
-
Components.Schemas.BlueprintID;
|
|
2742
|
-
}
|
|
2743
|
-
}
|
|
2744
|
-
}
|
|
2745
|
-
namespace InstallBlueprintV3 {
|
|
2746
|
-
export interface RequestBody {
|
|
2747
|
-
source_org_id?: string;
|
|
2748
|
-
source_blueprint_id?: /**
|
|
2749
|
-
* ID of a blueprint
|
|
2750
|
-
* example:
|
|
2751
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2752
|
-
*/
|
|
2753
|
-
Components.Schemas.BlueprintID;
|
|
2754
|
-
/**
|
|
2755
|
-
* S3 key to the blueprint zip file
|
|
2756
|
-
*/
|
|
2757
|
-
source_blueprint_file?: string;
|
|
2758
|
-
destination_org_id?: string;
|
|
2759
|
-
destination_blueprint_id?: /**
|
|
2760
|
-
* ID of a blueprint
|
|
2761
|
-
* example:
|
|
2762
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2763
|
-
*/
|
|
2764
|
-
Components.Schemas.BlueprintID;
|
|
2765
|
-
/**
|
|
2766
|
-
* Auth token for the destination org. Required for cross-org installs where the caller's token belongs to the source org. Defaults to the caller's bearer token.
|
|
2767
|
-
*/
|
|
2768
|
-
destination_auth_token?: string;
|
|
2769
|
-
options?: Components.Schemas.BlueprintInstallationJobOptions;
|
|
2770
|
-
/**
|
|
2771
|
-
* Slug for marketplace blueprint consistency
|
|
2772
|
-
*/
|
|
2773
|
-
slug?: string;
|
|
2774
|
-
}
|
|
2775
|
-
namespace Responses {
|
|
2776
|
-
export interface $202 {
|
|
2777
|
-
job_id?: /**
|
|
2778
|
-
* ID of a job
|
|
2779
|
-
* example:
|
|
2780
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2781
|
-
*/
|
|
2782
|
-
Components.Schemas.BlueprintJobID;
|
|
2783
|
-
destination_blueprint_id?: /**
|
|
2784
|
-
* ID of a blueprint
|
|
2785
|
-
* example:
|
|
2786
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2787
|
-
*/
|
|
2788
|
-
Components.Schemas.BlueprintID;
|
|
2789
|
-
}
|
|
2790
|
-
}
|
|
2791
|
-
}
|
|
2792
|
-
namespace ListBlueprintJobs {
|
|
2793
|
-
namespace Responses {
|
|
2794
|
-
export interface $200 {
|
|
2795
|
-
/**
|
|
2796
|
-
* example:
|
|
2797
|
-
* 1
|
|
2798
|
-
*/
|
|
2799
|
-
total?: number;
|
|
2800
|
-
results?: Components.Schemas.BlueprintJob[];
|
|
2801
|
-
}
|
|
2802
|
-
}
|
|
2803
|
-
}
|
|
2804
|
-
namespace ListBlueprints {
|
|
2805
|
-
namespace Parameters {
|
|
2806
|
-
export type Archived = boolean;
|
|
2807
|
-
}
|
|
2808
|
-
export interface QueryParameters {
|
|
2809
|
-
archived?: Parameters.Archived;
|
|
2810
|
-
}
|
|
2811
|
-
namespace Responses {
|
|
2812
|
-
export interface $200 {
|
|
2813
|
-
/**
|
|
2814
|
-
* example:
|
|
2815
|
-
* 1
|
|
2816
|
-
*/
|
|
2817
|
-
total?: number;
|
|
2818
|
-
results?: Components.Schemas.Blueprint[];
|
|
2819
|
-
}
|
|
2820
|
-
}
|
|
2821
|
-
}
|
|
2822
|
-
namespace ListInstalledManifests {
|
|
2823
|
-
namespace Responses {
|
|
2824
|
-
export interface $200 {
|
|
2825
|
-
/**
|
|
2826
|
-
* example:
|
|
2827
|
-
* 1
|
|
2828
|
-
*/
|
|
2829
|
-
total?: number;
|
|
2830
|
-
results?: Components.Schemas.ManifestItem[];
|
|
2831
|
-
}
|
|
2832
|
-
}
|
|
2833
|
-
}
|
|
2834
|
-
namespace ListInstalledMarketplaceBlueprints {
|
|
2835
|
-
namespace Responses {
|
|
2836
|
-
export interface $200 {
|
|
2837
|
-
/**
|
|
2838
|
-
* example:
|
|
2839
|
-
* 1
|
|
2840
|
-
*/
|
|
2841
|
-
total?: number;
|
|
2842
|
-
results?: /* Summary of an installed marketplace blueprint for version tracking */ Components.Schemas.InstalledMarketplaceBlueprintItem[];
|
|
2843
|
-
}
|
|
2844
|
-
}
|
|
2845
|
-
}
|
|
2846
|
-
namespace ListMarketplaceListingVersions {
|
|
2847
|
-
namespace Parameters {
|
|
2848
|
-
export type ListingId = string;
|
|
2849
|
-
}
|
|
2850
|
-
export interface PathParameters {
|
|
2851
|
-
listing_id: Parameters.ListingId;
|
|
2852
|
-
}
|
|
2853
|
-
namespace Responses {
|
|
2854
|
-
export interface $200 {
|
|
2855
|
-
versions?: Components.Schemas.MarketplaceListingVersion[];
|
|
2856
|
-
}
|
|
2857
|
-
}
|
|
2858
|
-
}
|
|
2859
|
-
namespace ListMarketplaceListings {
|
|
2860
|
-
namespace Responses {
|
|
2861
|
-
export interface $200 {
|
|
2862
|
-
listings?: Components.Schemas.MarketplaceListing[];
|
|
2863
|
-
}
|
|
2864
|
-
}
|
|
2865
|
-
}
|
|
2866
|
-
namespace ListMarketplaceSlugs {
|
|
2867
|
-
namespace Responses {
|
|
2868
|
-
export interface $200 {
|
|
2869
|
-
results?: {
|
|
2870
|
-
/**
|
|
2871
|
-
* The installation slug identifier for the blueprint (used for publishing).
|
|
2872
|
-
* example:
|
|
2873
|
-
* wallbox_b2c
|
|
2874
|
-
*/
|
|
2875
|
-
slug?: string;
|
|
2876
|
-
/**
|
|
2877
|
-
* The marketplace page slug for the Webflow CMS item (used for display).
|
|
2878
|
-
* example:
|
|
2879
|
-
* wallbox-b2c
|
|
2880
|
-
*/
|
|
2881
|
-
marketplace_slug?: string;
|
|
2882
|
-
/**
|
|
2883
|
-
* example:
|
|
2884
|
-
* v1.0.0
|
|
2885
|
-
*/
|
|
2886
|
-
version?: string;
|
|
2887
|
-
/**
|
|
2888
|
-
* example:
|
|
2889
|
-
* Wallbox B2C
|
|
2890
|
-
*/
|
|
2891
|
-
name?: string;
|
|
2892
|
-
/**
|
|
2893
|
-
* example:
|
|
2894
|
-
* https://portal.epilot.cloud/app/blueprints/install/marketplace/wallbox_b2c?s3Ref=https://example.com/blueprint.zip
|
|
2895
|
-
*/
|
|
2896
|
-
installation_link?: string;
|
|
2897
|
-
}[];
|
|
2898
|
-
}
|
|
2899
|
-
}
|
|
2900
|
-
}
|
|
2901
|
-
namespace PreInstallBlueprint {
|
|
2902
|
-
export interface RequestBody {
|
|
2903
|
-
/**
|
|
2904
|
-
* URL to the blueprint zip file
|
|
2905
|
-
*/
|
|
2906
|
-
blueprint_file?: string;
|
|
2907
|
-
source_blueprint_type?: "marketplace";
|
|
2908
|
-
/**
|
|
2909
|
-
* Slug to enforce in this blueprint. Used in marketplace blueprints to keep it consistent with webflow.
|
|
2910
|
-
*/
|
|
2911
|
-
slug?: string;
|
|
2912
|
-
}
|
|
2913
|
-
namespace Responses {
|
|
2914
|
-
export type $200 = /* Preview data for a blueprint before installation. Stored temporarily with TTL. */ Components.Schemas.BlueprintPreview;
|
|
2915
|
-
}
|
|
2916
|
-
}
|
|
2917
|
-
namespace PublishBlueprint {
|
|
2918
|
-
export interface RequestBody {
|
|
2919
|
-
blueprint_id: /**
|
|
2920
|
-
* ID of a blueprint
|
|
2921
|
-
* example:
|
|
2922
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2923
|
-
*/
|
|
2924
|
-
Components.Schemas.BlueprintID;
|
|
2925
|
-
/**
|
|
2926
|
-
* The marketplace installation slug for the Webflow CMS item
|
|
2927
|
-
*/
|
|
2928
|
-
slug: string;
|
|
2929
|
-
/**
|
|
2930
|
-
* The version string to set on the marketplace CMS item (e.g. "1.0.0")
|
|
2931
|
-
*/
|
|
2932
|
-
version?: string;
|
|
2933
|
-
/**
|
|
2934
|
-
* The display name for the blueprint on the marketplace CMS item
|
|
2935
|
-
*/
|
|
2936
|
-
name?: string;
|
|
2937
|
-
}
|
|
2938
|
-
namespace Responses {
|
|
2939
|
-
export interface $202 {
|
|
2940
|
-
job_id?: /**
|
|
2941
|
-
* ID of a job
|
|
2942
|
-
* example:
|
|
2943
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2944
|
-
*/
|
|
2945
|
-
Components.Schemas.BlueprintJobID;
|
|
2946
|
-
}
|
|
2947
|
-
}
|
|
2948
|
-
}
|
|
2949
|
-
namespace PublishMarketplaceListingVersion {
|
|
2950
|
-
namespace Parameters {
|
|
2951
|
-
export type ListingId = string;
|
|
2952
|
-
export type VersionId = string;
|
|
2953
|
-
}
|
|
2954
|
-
export interface PathParameters {
|
|
2955
|
-
listing_id: Parameters.ListingId;
|
|
2956
|
-
version_id: Parameters.VersionId;
|
|
2957
|
-
}
|
|
2958
|
-
export interface RequestBody {
|
|
2959
|
-
version_name: string;
|
|
2960
|
-
update_note?: string | null;
|
|
2961
|
-
}
|
|
2962
|
-
namespace Responses {
|
|
2963
|
-
export type $200 = Components.Schemas.MarketplaceListingVersion;
|
|
2964
|
-
export interface $400 {
|
|
2965
|
-
}
|
|
2966
|
-
export interface $404 {
|
|
2967
|
-
}
|
|
2968
|
-
}
|
|
2969
|
-
}
|
|
2970
|
-
namespace SyncDependencies {
|
|
2971
|
-
namespace Parameters {
|
|
2972
|
-
export type BlueprintId = /**
|
|
2973
|
-
* ID of a blueprint
|
|
2974
|
-
* example:
|
|
2975
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2976
|
-
*/
|
|
2977
|
-
Components.Schemas.BlueprintID;
|
|
2978
|
-
}
|
|
2979
|
-
export interface PathParameters {
|
|
2980
|
-
blueprint_id: Parameters.BlueprintId;
|
|
2981
|
-
}
|
|
2982
|
-
namespace Responses {
|
|
2983
|
-
export interface $202 {
|
|
2984
|
-
job_id?: /**
|
|
2985
|
-
* ID of a job
|
|
2986
|
-
* example:
|
|
2987
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2988
|
-
*/
|
|
2989
|
-
Components.Schemas.BlueprintJobID;
|
|
2990
|
-
}
|
|
2991
|
-
}
|
|
2992
|
-
}
|
|
2993
|
-
namespace UpdateBlueprint {
|
|
2994
|
-
namespace Parameters {
|
|
2995
|
-
export type BlueprintId = /**
|
|
2996
|
-
* ID of a blueprint
|
|
2997
|
-
* example:
|
|
2998
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2999
|
-
*/
|
|
3000
|
-
Components.Schemas.BlueprintID;
|
|
3001
|
-
}
|
|
3002
|
-
export interface PathParameters {
|
|
3003
|
-
blueprint_id: Parameters.BlueprintId;
|
|
3004
|
-
}
|
|
3005
|
-
export type RequestBody = Components.Schemas.Blueprint;
|
|
3006
|
-
namespace Responses {
|
|
3007
|
-
export type $200 = Components.Schemas.Blueprint;
|
|
3008
|
-
}
|
|
3009
|
-
}
|
|
3010
|
-
namespace UpdateBlueprintResource {
|
|
3011
|
-
namespace Parameters {
|
|
3012
|
-
export type BlueprintId = /**
|
|
3013
|
-
* ID of a blueprint
|
|
3014
|
-
* example:
|
|
3015
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
3016
|
-
*/
|
|
3017
|
-
Components.Schemas.BlueprintID;
|
|
3018
|
-
export type ResourceId = /**
|
|
3019
|
-
* ID of a blueprint resource
|
|
3020
|
-
* example:
|
|
3021
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
3022
|
-
*/
|
|
3023
|
-
Components.Schemas.BlueprintResourceID;
|
|
3024
|
-
}
|
|
3025
|
-
export interface PathParameters {
|
|
3026
|
-
blueprint_id: Parameters.BlueprintId;
|
|
3027
|
-
resource_id: Parameters.ResourceId;
|
|
3028
|
-
}
|
|
3029
|
-
export type RequestBody = Components.Schemas.BlueprintResource;
|
|
3030
|
-
namespace Responses {
|
|
3031
|
-
export interface $200 {
|
|
3032
|
-
resources?: Components.Schemas.BlueprintResource[];
|
|
3033
|
-
}
|
|
3034
|
-
}
|
|
3035
|
-
}
|
|
3036
|
-
namespace UpdateManifest {
|
|
3037
|
-
namespace Parameters {
|
|
3038
|
-
export type ManifestId = /**
|
|
3039
|
-
* ID of an imported / installed manifest
|
|
3040
|
-
* example:
|
|
3041
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
3042
|
-
*/
|
|
3043
|
-
Components.Schemas.ManifestID;
|
|
3044
|
-
}
|
|
3045
|
-
export interface PathParameters {
|
|
3046
|
-
manifest_id: Parameters.ManifestId;
|
|
3047
|
-
}
|
|
3048
|
-
export type RequestBody = Components.Schemas.PutManifestPayload;
|
|
3049
|
-
namespace Responses {
|
|
3050
|
-
export type $200 = Components.Schemas.Manifest;
|
|
3051
|
-
}
|
|
3052
|
-
}
|
|
3053
|
-
namespace UpdateMarketplaceListing {
|
|
3054
|
-
namespace Parameters {
|
|
3055
|
-
export type ListingId = string;
|
|
3056
|
-
}
|
|
3057
|
-
export interface PathParameters {
|
|
3058
|
-
listing_id: Parameters.ListingId;
|
|
3059
|
-
}
|
|
3060
|
-
export type RequestBody = Components.Schemas.MarketplaceListingUpdate;
|
|
3061
|
-
namespace Responses {
|
|
3062
|
-
export type $200 = Components.Schemas.MarketplaceListing;
|
|
3063
|
-
export interface $404 {
|
|
3064
|
-
}
|
|
3065
|
-
}
|
|
3066
|
-
}
|
|
3067
|
-
namespace UpdateMarketplaceListingVersion {
|
|
3068
|
-
namespace Parameters {
|
|
3069
|
-
export type ListingId = string;
|
|
3070
|
-
export type VersionId = string;
|
|
3071
|
-
}
|
|
3072
|
-
export interface PathParameters {
|
|
3073
|
-
listing_id: Parameters.ListingId;
|
|
3074
|
-
version_id: Parameters.VersionId;
|
|
3075
|
-
}
|
|
3076
|
-
export interface RequestBody {
|
|
3077
|
-
update_note?: string | null;
|
|
3078
|
-
required_features?: string[];
|
|
3079
|
-
recommended_apps?: string[];
|
|
3080
|
-
}
|
|
3081
|
-
namespace Responses {
|
|
3082
|
-
export type $200 = Components.Schemas.MarketplaceListingVersion;
|
|
3083
|
-
export interface $400 {
|
|
3084
|
-
}
|
|
3085
|
-
export interface $404 {
|
|
3086
|
-
}
|
|
3087
|
-
}
|
|
3088
|
-
}
|
|
3089
|
-
namespace UploadManifest {
|
|
3090
|
-
export type RequestBody = Components.Schemas.UploadFilePayload;
|
|
3091
|
-
namespace Responses {
|
|
3092
|
-
export interface $201 {
|
|
3093
|
-
s3ref?: Components.Schemas.S3Reference;
|
|
3094
|
-
/**
|
|
3095
|
-
* example:
|
|
3096
|
-
* https://epilot-dev-blueprints.s3.eu-central-1.amazonaws.com/templates/document.pdf
|
|
3097
|
-
*/
|
|
3098
|
-
upload_url?: string; // url
|
|
3099
|
-
}
|
|
3100
|
-
}
|
|
3101
|
-
}
|
|
3102
|
-
namespace ValidateBlueprint {
|
|
3103
|
-
namespace Parameters {
|
|
3104
|
-
export type BlueprintId = /**
|
|
3105
|
-
* ID of a blueprint
|
|
3106
|
-
* example:
|
|
3107
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
3108
|
-
*/
|
|
3109
|
-
Components.Schemas.BlueprintID;
|
|
3110
|
-
}
|
|
3111
|
-
export interface PathParameters {
|
|
3112
|
-
blueprint_id: Parameters.BlueprintId;
|
|
3113
|
-
}
|
|
3114
|
-
namespace Responses {
|
|
3115
|
-
export interface $202 {
|
|
3116
|
-
job_id?: /**
|
|
3117
|
-
* ID of a job
|
|
3118
|
-
* example:
|
|
3119
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
3120
|
-
*/
|
|
3121
|
-
Components.Schemas.BlueprintJobID;
|
|
3122
|
-
}
|
|
3123
|
-
export interface $404 {
|
|
3124
|
-
}
|
|
3125
|
-
}
|
|
3126
|
-
}
|
|
3127
|
-
namespace VerifyBlueprint {
|
|
3128
|
-
namespace Parameters {
|
|
3129
|
-
export type BlueprintId = /**
|
|
3130
|
-
* ID of a blueprint
|
|
3131
|
-
* example:
|
|
3132
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
3133
|
-
*/
|
|
3134
|
-
Components.Schemas.BlueprintID;
|
|
3135
|
-
}
|
|
3136
|
-
export interface PathParameters {
|
|
3137
|
-
blueprint_id: Parameters.BlueprintId;
|
|
3138
|
-
}
|
|
3139
|
-
export interface RequestBody {
|
|
3140
|
-
/**
|
|
3141
|
-
* Organization ID of the source org
|
|
3142
|
-
*/
|
|
3143
|
-
source_org_id: string;
|
|
3144
|
-
source_blueprint_id: /**
|
|
3145
|
-
* ID of a blueprint
|
|
3146
|
-
* example:
|
|
3147
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
3148
|
-
*/
|
|
3149
|
-
Components.Schemas.BlueprintID;
|
|
3150
|
-
/**
|
|
3151
|
-
* Organization ID of the destination org
|
|
3152
|
-
*/
|
|
3153
|
-
destination_org_id: string;
|
|
3154
|
-
destination_blueprint_id: /**
|
|
3155
|
-
* ID of a blueprint
|
|
3156
|
-
* example:
|
|
3157
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
3158
|
-
*/
|
|
3159
|
-
Components.Schemas.BlueprintID;
|
|
3160
|
-
/**
|
|
3161
|
-
* Auth token with access to the source org (e.g. pipeline token). If not provided, the caller's bearer token is used for both orgs.
|
|
3162
|
-
*/
|
|
3163
|
-
source_auth_token?: string;
|
|
3164
|
-
/**
|
|
3165
|
-
* Auth token with access to the destination org. Required for cross-org verification when the caller token only has access to the source org. If not provided, the caller's bearer token is used for both orgs.
|
|
3166
|
-
*/
|
|
3167
|
-
destination_auth_token?: string;
|
|
3168
|
-
}
|
|
3169
|
-
namespace Responses {
|
|
3170
|
-
export interface $202 {
|
|
3171
|
-
job_id?: /**
|
|
3172
|
-
* ID of a job
|
|
3173
|
-
* example:
|
|
3174
|
-
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
3175
|
-
*/
|
|
3176
|
-
Components.Schemas.BlueprintJobID;
|
|
3177
|
-
}
|
|
3178
|
-
export interface $404 {
|
|
3179
|
-
}
|
|
3180
|
-
}
|
|
3181
|
-
}
|
|
3182
|
-
}
|
|
3183
|
-
|
|
3184
|
-
|
|
3185
|
-
interface OperationMethods {
|
|
3186
|
-
/**
|
|
3187
|
-
* getJob - getJob
|
|
3188
|
-
*
|
|
3189
|
-
* Get the current status of a blueprint (export or import)
|
|
3190
|
-
*/
|
|
3191
|
-
'getJob'(
|
|
3192
|
-
parameters?: Parameters<Paths.GetJob.PathParameters> | null,
|
|
3193
|
-
data?: any,
|
|
3194
|
-
config?: AxiosRequestConfig
|
|
3195
|
-
): OperationResponse<Paths.GetJob.Responses.$200>
|
|
3196
|
-
/**
|
|
3197
|
-
* createExport - createExport
|
|
3198
|
-
*
|
|
3199
|
-
* Creates a new Export Job with a list of available resources to export from the passed root resource.
|
|
3200
|
-
*
|
|
3201
|
-
* Multiple root resources can be added by calling this multiple times with the same jobId
|
|
3202
|
-
*
|
|
3203
|
-
*/
|
|
3204
|
-
'createExport'(
|
|
3205
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3206
|
-
data?: Paths.CreateExport.RequestBody,
|
|
3207
|
-
config?: AxiosRequestConfig
|
|
3208
|
-
): OperationResponse<Paths.CreateExport.Responses.$200>
|
|
3209
|
-
/**
|
|
3210
|
-
* exportManifest - exportManifest
|
|
3211
|
-
*
|
|
3212
|
-
* Triggers exporting a manifest file using selected resoruce ids for a job created with `createExportJob`
|
|
3213
|
-
*/
|
|
3214
|
-
'exportManifest'(
|
|
3215
|
-
parameters?: Parameters<Paths.ExportManifest.PathParameters> | null,
|
|
3216
|
-
data?: Paths.ExportManifest.RequestBody,
|
|
3217
|
-
config?: AxiosRequestConfig
|
|
3218
|
-
): OperationResponse<Paths.ExportManifest.Responses.$200>
|
|
3219
|
-
/**
|
|
3220
|
-
* uploadManifest - uploadManifest
|
|
3221
|
-
*
|
|
3222
|
-
* Create pre-signed S3 URL to upload a manifest file.
|
|
3223
|
-
*
|
|
3224
|
-
*/
|
|
3225
|
-
'uploadManifest'(
|
|
3226
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3227
|
-
data?: Paths.UploadManifest.RequestBody,
|
|
3228
|
-
config?: AxiosRequestConfig
|
|
3229
|
-
): OperationResponse<Paths.UploadManifest.Responses.$201>
|
|
3230
|
-
/**
|
|
3231
|
-
* createPlan - createPlan
|
|
3232
|
-
*
|
|
3233
|
-
* Creates a new import job from an uploaded manifest file and returns the plan.
|
|
3234
|
-
*
|
|
3235
|
-
* Creates an updated plan for an installed manifest when `manifest_id` is passed
|
|
3236
|
-
*
|
|
3237
|
-
*/
|
|
3238
|
-
'createPlan'(
|
|
3239
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3240
|
-
data?: Paths.CreatePlan.RequestBody,
|
|
3241
|
-
config?: AxiosRequestConfig
|
|
3242
|
-
): OperationResponse<Paths.CreatePlan.Responses.$200>
|
|
3243
|
-
/**
|
|
3244
|
-
* applyPlan - applyPlan
|
|
3245
|
-
*
|
|
3246
|
-
* Apply a plan returned by `createPlan`.
|
|
3247
|
-
*/
|
|
3248
|
-
'applyPlan'(
|
|
3249
|
-
parameters?: Parameters<Paths.ApplyPlan.PathParameters> | null,
|
|
3250
|
-
data?: Paths.ApplyPlan.RequestBody,
|
|
3251
|
-
config?: AxiosRequestConfig
|
|
3252
|
-
): OperationResponse<Paths.ApplyPlan.Responses.$200>
|
|
3253
|
-
/**
|
|
3254
|
-
* listInstalledManifests - listInstalledManifests
|
|
3255
|
-
*
|
|
3256
|
-
* List Blueprint Manifests installed to the organization
|
|
3257
|
-
*/
|
|
3258
|
-
'listInstalledManifests'(
|
|
3259
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3260
|
-
data?: any,
|
|
3261
|
-
config?: AxiosRequestConfig
|
|
3262
|
-
): OperationResponse<Paths.ListInstalledManifests.Responses.$200>
|
|
3263
|
-
/**
|
|
3264
|
-
* getManifest - getManifest
|
|
3265
|
-
*
|
|
3266
|
-
* Get installed Manifest by ID
|
|
3267
|
-
*/
|
|
3268
|
-
'getManifest'(
|
|
3269
|
-
parameters?: Parameters<Paths.GetManifest.PathParameters> | null,
|
|
3270
|
-
data?: any,
|
|
3271
|
-
config?: AxiosRequestConfig
|
|
3272
|
-
): OperationResponse<Paths.GetManifest.Responses.$200>
|
|
3273
|
-
/**
|
|
3274
|
-
* updateManifest - updateManifest
|
|
3275
|
-
*
|
|
3276
|
-
* Update an installed manifest
|
|
3277
|
-
*
|
|
3278
|
-
*/
|
|
3279
|
-
'updateManifest'(
|
|
3280
|
-
parameters?: Parameters<Paths.UpdateManifest.PathParameters> | null,
|
|
3281
|
-
data?: Paths.UpdateManifest.RequestBody,
|
|
3282
|
-
config?: AxiosRequestConfig
|
|
3283
|
-
): OperationResponse<Paths.UpdateManifest.Responses.$200>
|
|
3284
|
-
/**
|
|
3285
|
-
* deleteManifest - deleteManifest
|
|
3286
|
-
*
|
|
3287
|
-
* Remove installed manifest from the org
|
|
3288
|
-
*
|
|
3289
|
-
* Note that this does not delete the installed resources of the Manifest!
|
|
3290
|
-
*
|
|
3291
|
-
*/
|
|
3292
|
-
'deleteManifest'(
|
|
3293
|
-
parameters?: Parameters<Paths.DeleteManifest.PathParameters> | null,
|
|
3294
|
-
data?: any,
|
|
3295
|
-
config?: AxiosRequestConfig
|
|
3296
|
-
): OperationResponse<Paths.DeleteManifest.Responses.$200>
|
|
3297
|
-
/**
|
|
3298
|
-
* listBlueprints - listBlueprints
|
|
3299
|
-
*
|
|
3300
|
-
* List Custom and Installed Blueprints
|
|
3301
|
-
*/
|
|
3302
|
-
'listBlueprints'(
|
|
3303
|
-
parameters?: Parameters<Paths.ListBlueprints.QueryParameters> | null,
|
|
3304
|
-
data?: any,
|
|
3305
|
-
config?: AxiosRequestConfig
|
|
3306
|
-
): OperationResponse<Paths.ListBlueprints.Responses.$200>
|
|
3307
|
-
/**
|
|
3308
|
-
* createBlueprint - createBlueprint
|
|
3309
|
-
*
|
|
3310
|
-
* Create a Blueprint
|
|
3311
|
-
*/
|
|
3312
|
-
'createBlueprint'(
|
|
3313
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3314
|
-
data?: Paths.CreateBlueprint.RequestBody,
|
|
3315
|
-
config?: AxiosRequestConfig
|
|
3316
|
-
): OperationResponse<Paths.CreateBlueprint.Responses.$200>
|
|
3317
|
-
/**
|
|
3318
|
-
* listInstalledMarketplaceBlueprints - listInstalledMarketplaceBlueprints
|
|
3319
|
-
*
|
|
3320
|
-
* List installed Marketplace Blueprints for the organization.
|
|
3321
|
-
* When multiple blueprints have the same slug, returns only the most recently created one.
|
|
3322
|
-
*
|
|
3323
|
-
*/
|
|
3324
|
-
'listInstalledMarketplaceBlueprints'(
|
|
3325
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3326
|
-
data?: any,
|
|
3327
|
-
config?: AxiosRequestConfig
|
|
3328
|
-
): OperationResponse<Paths.ListInstalledMarketplaceBlueprints.Responses.$200>
|
|
3329
|
-
/**
|
|
3330
|
-
* preInstallBlueprint - preInstallBlueprint
|
|
3331
|
-
*
|
|
3332
|
-
* Pre-install a Blueprint based on a blueprint file
|
|
3333
|
-
*/
|
|
3334
|
-
'preInstallBlueprint'(
|
|
3335
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3336
|
-
data?: Paths.PreInstallBlueprint.RequestBody,
|
|
3337
|
-
config?: AxiosRequestConfig
|
|
3338
|
-
): OperationResponse<Paths.PreInstallBlueprint.Responses.$200>
|
|
3339
|
-
/**
|
|
3340
|
-
* getBlueprintPreview - getBlueprintPreview
|
|
3341
|
-
*
|
|
3342
|
-
* Get Blueprint Preview by ID
|
|
3343
|
-
*/
|
|
3344
|
-
'getBlueprintPreview'(
|
|
3345
|
-
parameters?: Parameters<Paths.GetBlueprintPreview.PathParameters> | null,
|
|
3346
|
-
data?: any,
|
|
3347
|
-
config?: AxiosRequestConfig
|
|
3348
|
-
): OperationResponse<Paths.GetBlueprintPreview.Responses.$200>
|
|
3349
|
-
/**
|
|
3350
|
-
* installBlueprint - installBlueprint
|
|
3351
|
-
*
|
|
3352
|
-
* Kick off a new blueprint installation job. Returns 202 Accepted with Location header pointing to the job resource
|
|
3353
|
-
*
|
|
3354
|
-
*/
|
|
3355
|
-
'installBlueprint'(
|
|
3356
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3357
|
-
data?: Paths.InstallBlueprint.RequestBody,
|
|
3358
|
-
config?: AxiosRequestConfig
|
|
3359
|
-
): OperationResponse<Paths.InstallBlueprint.Responses.$202>
|
|
3360
|
-
/**
|
|
3361
|
-
* getBlueprint - getBlueprint
|
|
3362
|
-
*
|
|
3363
|
-
* Get Blueprint by ID
|
|
3364
|
-
*/
|
|
3365
|
-
'getBlueprint'(
|
|
3366
|
-
parameters?: Parameters<Paths.GetBlueprint.PathParameters> | null,
|
|
3367
|
-
data?: any,
|
|
3368
|
-
config?: AxiosRequestConfig
|
|
3369
|
-
): OperationResponse<Paths.GetBlueprint.Responses.$200>
|
|
3370
|
-
/**
|
|
3371
|
-
* updateBlueprint - updateBlueprint
|
|
3372
|
-
*
|
|
3373
|
-
* Update a Blueprint
|
|
3374
|
-
*/
|
|
3375
|
-
'updateBlueprint'(
|
|
3376
|
-
parameters?: Parameters<Paths.UpdateBlueprint.PathParameters> | null,
|
|
3377
|
-
data?: Paths.UpdateBlueprint.RequestBody,
|
|
3378
|
-
config?: AxiosRequestConfig
|
|
3379
|
-
): OperationResponse<Paths.UpdateBlueprint.Responses.$200>
|
|
3380
|
-
/**
|
|
3381
|
-
* deleteBlueprint - deleteBlueprint
|
|
3382
|
-
*
|
|
3383
|
-
* Delete a Blueprint
|
|
3384
|
-
*/
|
|
3385
|
-
'deleteBlueprint'(
|
|
3386
|
-
parameters?: Parameters<Paths.DeleteBlueprint.PathParameters> | null,
|
|
3387
|
-
data?: any,
|
|
3388
|
-
config?: AxiosRequestConfig
|
|
3389
|
-
): OperationResponse<Paths.DeleteBlueprint.Responses.$200>
|
|
3390
|
-
/**
|
|
3391
|
-
* validateBlueprint - validateBlueprint
|
|
3392
|
-
*
|
|
3393
|
-
* Start a blueprint validation job. Validates Terraform for the blueprint (all types).
|
|
3394
|
-
* Returns 202 Accepted with job_id. Poll GET /jobs/{job_id} for status, valid, and errors.
|
|
3395
|
-
*
|
|
3396
|
-
*/
|
|
3397
|
-
'validateBlueprint'(
|
|
3398
|
-
parameters?: Parameters<Paths.ValidateBlueprint.PathParameters> | null,
|
|
3399
|
-
data?: any,
|
|
3400
|
-
config?: AxiosRequestConfig
|
|
3401
|
-
): OperationResponse<Paths.ValidateBlueprint.Responses.$202>
|
|
3402
|
-
/**
|
|
3403
|
-
* verifyBlueprint - verifyBlueprint
|
|
3404
|
-
*
|
|
3405
|
-
* Start a blueprint verification job. Compares resource configurations between a source org
|
|
3406
|
-
* and a destination org to verify that a sync/install was successful.
|
|
3407
|
-
* Returns 202 Accepted with job_id. Poll GET /jobs/{job_id} for status, summary, and resource_results.
|
|
3408
|
-
*
|
|
3409
|
-
*/
|
|
3410
|
-
'verifyBlueprint'(
|
|
3411
|
-
parameters?: Parameters<Paths.VerifyBlueprint.PathParameters> | null,
|
|
3412
|
-
data?: Paths.VerifyBlueprint.RequestBody,
|
|
3413
|
-
config?: AxiosRequestConfig
|
|
3414
|
-
): OperationResponse<Paths.VerifyBlueprint.Responses.$202>
|
|
3415
|
-
/**
|
|
3416
|
-
* exportBlueprint - exportBlueprint
|
|
3417
|
-
*
|
|
3418
|
-
* Kick off a new blueprint export job. Returns 202 Accepted with Location header pointing to the job resource.
|
|
3419
|
-
*
|
|
3420
|
-
*/
|
|
3421
|
-
'exportBlueprint'(
|
|
3422
|
-
parameters?: Parameters<Paths.ExportBlueprint.PathParameters> | null,
|
|
3423
|
-
data?: Paths.ExportBlueprint.RequestBody,
|
|
3424
|
-
config?: AxiosRequestConfig
|
|
3425
|
-
): OperationResponse<Paths.ExportBlueprint.Responses.$202>
|
|
3426
|
-
/**
|
|
3427
|
-
* listMarketplaceSlugs - listMarketplaceSlugs
|
|
3428
|
-
*
|
|
3429
|
-
* List all available marketplace blueprint slugs from Webflow CMS.
|
|
3430
|
-
* Returns cached results when available.
|
|
3431
|
-
*
|
|
3432
|
-
*/
|
|
3433
|
-
'listMarketplaceSlugs'(
|
|
3434
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3435
|
-
data?: any,
|
|
3436
|
-
config?: AxiosRequestConfig
|
|
3437
|
-
): OperationResponse<Paths.ListMarketplaceSlugs.Responses.$200>
|
|
3438
|
-
/**
|
|
3439
|
-
* publishBlueprint - publishBlueprint
|
|
3440
|
-
*
|
|
3441
|
-
* Publish a blueprint to the marketplace. Exports the blueprint, uploads it to file-api with public access, and updates the Webflow CMS listing.
|
|
3442
|
-
*
|
|
3443
|
-
*/
|
|
3444
|
-
'publishBlueprint'(
|
|
3445
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3446
|
-
data?: Paths.PublishBlueprint.RequestBody,
|
|
3447
|
-
config?: AxiosRequestConfig
|
|
3448
|
-
): OperationResponse<Paths.PublishBlueprint.Responses.$202>
|
|
3449
|
-
/**
|
|
3450
|
-
* formatBlueprintDescription - formatBlueprintDescription
|
|
3451
|
-
*
|
|
3452
|
-
* Format a blueprint description as markdown using AI.
|
|
3453
|
-
*
|
|
3454
|
-
*/
|
|
3455
|
-
'formatBlueprintDescription'(
|
|
3456
|
-
parameters?: Parameters<Paths.FormatBlueprintDescription.PathParameters> | null,
|
|
3457
|
-
data?: Paths.FormatBlueprintDescription.RequestBody,
|
|
3458
|
-
config?: AxiosRequestConfig
|
|
3459
|
-
): OperationResponse<Paths.FormatBlueprintDescription.Responses.$200>
|
|
3460
|
-
/**
|
|
3461
|
-
* addBlueprintResource - addBlueprintResource
|
|
3462
|
-
*
|
|
3463
|
-
* Add a resource to a Blueprint
|
|
3464
|
-
*/
|
|
3465
|
-
'addBlueprintResource'(
|
|
3466
|
-
parameters?: Parameters<Paths.AddBlueprintResource.QueryParameters & Paths.AddBlueprintResource.PathParameters> | null,
|
|
3467
|
-
data?: Paths.AddBlueprintResource.RequestBody,
|
|
3468
|
-
config?: AxiosRequestConfig
|
|
3469
|
-
): OperationResponse<Paths.AddBlueprintResource.Responses.$200>
|
|
3470
|
-
/**
|
|
3471
|
-
* syncDependencies - syncDependencies
|
|
3472
|
-
*
|
|
3473
|
-
* Sync dependencies of all root resources in a Blueprint
|
|
3474
|
-
*/
|
|
3475
|
-
'syncDependencies'(
|
|
3476
|
-
parameters?: Parameters<Paths.SyncDependencies.PathParameters> | null,
|
|
3477
|
-
data?: any,
|
|
3478
|
-
config?: AxiosRequestConfig
|
|
3479
|
-
): OperationResponse<Paths.SyncDependencies.Responses.$202>
|
|
3480
|
-
/**
|
|
3481
|
-
* bulkUpdateBlueprintResources - bulkUpdateBlueprintResources
|
|
3482
|
-
*
|
|
3483
|
-
* Bulk update resources in a Blueprint
|
|
3484
|
-
*/
|
|
3485
|
-
'bulkUpdateBlueprintResources'(
|
|
3486
|
-
parameters?: Parameters<Paths.BulkUpdateBlueprintResources.PathParameters> | null,
|
|
3487
|
-
data?: Paths.BulkUpdateBlueprintResources.RequestBody,
|
|
3488
|
-
config?: AxiosRequestConfig
|
|
3489
|
-
): OperationResponse<Paths.BulkUpdateBlueprintResources.Responses.$200>
|
|
3490
|
-
/**
|
|
3491
|
-
* bulkAddBlueprintResources - bulkAddBlueprintResources
|
|
3492
|
-
*
|
|
3493
|
-
* Bulk Add resources in a Blueprint
|
|
3494
|
-
*/
|
|
3495
|
-
'bulkAddBlueprintResources'(
|
|
3496
|
-
parameters?: Parameters<Paths.BulkAddBlueprintResources.QueryParameters & Paths.BulkAddBlueprintResources.PathParameters> | null,
|
|
3497
|
-
data?: Paths.BulkAddBlueprintResources.RequestBody,
|
|
3498
|
-
config?: AxiosRequestConfig
|
|
3499
|
-
): OperationResponse<Paths.BulkAddBlueprintResources.Responses.$200>
|
|
3500
|
-
/**
|
|
3501
|
-
* bulkDeleteBlueprintResources - bulkDeleteBlueprintResources
|
|
3502
|
-
*
|
|
3503
|
-
* Bulk delete resources in a Blueprint
|
|
3504
|
-
*/
|
|
3505
|
-
'bulkDeleteBlueprintResources'(
|
|
3506
|
-
parameters?: Parameters<Paths.BulkDeleteBlueprintResources.PathParameters> | null,
|
|
3507
|
-
data?: Paths.BulkDeleteBlueprintResources.RequestBody,
|
|
3508
|
-
config?: AxiosRequestConfig
|
|
3509
|
-
): OperationResponse<Paths.BulkDeleteBlueprintResources.Responses.$200>
|
|
3510
|
-
/**
|
|
3511
|
-
* updateBlueprintResource - updateBlueprintResource
|
|
3512
|
-
*
|
|
3513
|
-
* Update a resource in a Blueprint
|
|
3514
|
-
*/
|
|
3515
|
-
'updateBlueprintResource'(
|
|
3516
|
-
parameters?: Parameters<Paths.UpdateBlueprintResource.PathParameters> | null,
|
|
3517
|
-
data?: Paths.UpdateBlueprintResource.RequestBody,
|
|
3518
|
-
config?: AxiosRequestConfig
|
|
3519
|
-
): OperationResponse<Paths.UpdateBlueprintResource.Responses.$200>
|
|
3520
|
-
/**
|
|
3521
|
-
* deleteBlueprintResource - deleteBlueprintResource
|
|
3522
|
-
*
|
|
3523
|
-
* Delete a resource from a Blueprint
|
|
3524
|
-
*/
|
|
3525
|
-
'deleteBlueprintResource'(
|
|
3526
|
-
parameters?: Parameters<Paths.DeleteBlueprintResource.PathParameters> | null,
|
|
3527
|
-
data?: any,
|
|
3528
|
-
config?: AxiosRequestConfig
|
|
3529
|
-
): OperationResponse<Paths.DeleteBlueprintResource.Responses.$200>
|
|
3530
|
-
/**
|
|
3531
|
-
* listBlueprintJobs - List Blueprint Jobs
|
|
3532
|
-
*
|
|
3533
|
-
* List all blueprint jobs
|
|
3534
|
-
*/
|
|
3535
|
-
'listBlueprintJobs'(
|
|
3536
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3537
|
-
data?: any,
|
|
3538
|
-
config?: AxiosRequestConfig
|
|
3539
|
-
): OperationResponse<Paths.ListBlueprintJobs.Responses.$200>
|
|
3540
|
-
/**
|
|
3541
|
-
* getBlueprintJob - Get Job
|
|
3542
|
-
*
|
|
3543
|
-
* Poll current state of a job.
|
|
3544
|
-
*/
|
|
3545
|
-
'getBlueprintJob'(
|
|
3546
|
-
parameters?: Parameters<Paths.GetBlueprintJob.PathParameters> | null,
|
|
3547
|
-
data?: any,
|
|
3548
|
-
config?: AxiosRequestConfig
|
|
3549
|
-
): OperationResponse<Paths.GetBlueprintJob.Responses.$200>
|
|
3550
|
-
/**
|
|
3551
|
-
* continueInstallationJob - Continue Installation Job
|
|
3552
|
-
*
|
|
3553
|
-
* Continue an installation job if it is waiting for user action.
|
|
3554
|
-
*/
|
|
3555
|
-
'continueInstallationJob'(
|
|
3556
|
-
parameters?: Parameters<Paths.ContinueInstallationJob.PathParameters> | null,
|
|
3557
|
-
data?: Paths.ContinueInstallationJob.RequestBody,
|
|
3558
|
-
config?: AxiosRequestConfig
|
|
3559
|
-
): OperationResponse<Paths.ContinueInstallationJob.Responses.$200>
|
|
3560
|
-
/**
|
|
3561
|
-
* cancelBlueprintJob - Cancel Blueprint Job
|
|
3562
|
-
*
|
|
3563
|
-
* Cancel a blueprint job if it is still running.
|
|
3564
|
-
*/
|
|
3565
|
-
'cancelBlueprintJob'(
|
|
3566
|
-
parameters?: Parameters<Paths.CancelBlueprintJob.PathParameters> | null,
|
|
3567
|
-
data?: any,
|
|
3568
|
-
config?: AxiosRequestConfig
|
|
3569
|
-
): OperationResponse<Paths.CancelBlueprintJob.Responses.$200>
|
|
3570
|
-
/**
|
|
3571
|
-
* getMarketplaceListing - getMarketplaceListing
|
|
3572
|
-
*
|
|
3573
|
-
* Get marketplace listing for a blueprint including all versions
|
|
3574
|
-
*/
|
|
3575
|
-
'getMarketplaceListing'(
|
|
3576
|
-
parameters?: Parameters<Paths.GetMarketplaceListing.PathParameters> | null,
|
|
3577
|
-
data?: any,
|
|
3578
|
-
config?: AxiosRequestConfig
|
|
3579
|
-
): OperationResponse<Paths.GetMarketplaceListing.Responses.$200>
|
|
3580
|
-
/**
|
|
3581
|
-
* createMarketplaceListing - createMarketplaceListing
|
|
3582
|
-
*
|
|
3583
|
-
* Create a marketplace listing for a blueprint. Returns 409 if one already exists.
|
|
3584
|
-
*/
|
|
3585
|
-
'createMarketplaceListing'(
|
|
3586
|
-
parameters?: Parameters<Paths.CreateMarketplaceListing.PathParameters> | null,
|
|
3587
|
-
data?: Paths.CreateMarketplaceListing.RequestBody,
|
|
3588
|
-
config?: AxiosRequestConfig
|
|
3589
|
-
): OperationResponse<Paths.CreateMarketplaceListing.Responses.$201>
|
|
3590
|
-
/**
|
|
3591
|
-
* listMarketplaceListings - listMarketplaceListings
|
|
3592
|
-
*
|
|
3593
|
-
* List all marketplace listings for the authenticated organization
|
|
3594
|
-
*/
|
|
3595
|
-
'listMarketplaceListings'(
|
|
3596
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3597
|
-
data?: any,
|
|
3598
|
-
config?: AxiosRequestConfig
|
|
3599
|
-
): OperationResponse<Paths.ListMarketplaceListings.Responses.$200>
|
|
3600
|
-
/**
|
|
3601
|
-
* getMarketplaceListingById - getMarketplaceListingById
|
|
3602
|
-
*
|
|
3603
|
-
* Get marketplace listing by listing ID including all versions
|
|
3604
|
-
*/
|
|
3605
|
-
'getMarketplaceListingById'(
|
|
3606
|
-
parameters?: Parameters<Paths.GetMarketplaceListingById.PathParameters> | null,
|
|
3607
|
-
data?: any,
|
|
3608
|
-
config?: AxiosRequestConfig
|
|
3609
|
-
): OperationResponse<Paths.GetMarketplaceListingById.Responses.$200>
|
|
3610
|
-
/**
|
|
3611
|
-
* updateMarketplaceListing - updateMarketplaceListing
|
|
3612
|
-
*
|
|
3613
|
-
* Update listing-level fields
|
|
3614
|
-
*/
|
|
3615
|
-
'updateMarketplaceListing'(
|
|
3616
|
-
parameters?: Parameters<Paths.UpdateMarketplaceListing.PathParameters> | null,
|
|
3617
|
-
data?: Paths.UpdateMarketplaceListing.RequestBody,
|
|
3618
|
-
config?: AxiosRequestConfig
|
|
3619
|
-
): OperationResponse<Paths.UpdateMarketplaceListing.Responses.$200>
|
|
3620
|
-
/**
|
|
3621
|
-
* deleteMarketplaceListing - deleteMarketplaceListing
|
|
3622
|
-
*
|
|
3623
|
-
* Delete listing and all versions
|
|
3624
|
-
*/
|
|
3625
|
-
'deleteMarketplaceListing'(
|
|
3626
|
-
parameters?: Parameters<Paths.DeleteMarketplaceListing.PathParameters> | null,
|
|
3627
|
-
data?: any,
|
|
3628
|
-
config?: AxiosRequestConfig
|
|
3629
|
-
): OperationResponse<Paths.DeleteMarketplaceListing.Responses.$204>
|
|
3630
|
-
/**
|
|
3631
|
-
* listMarketplaceListingVersions - listMarketplaceListingVersions
|
|
3632
|
-
*
|
|
3633
|
-
* List all versions for a listing, newest first
|
|
3634
|
-
*/
|
|
3635
|
-
'listMarketplaceListingVersions'(
|
|
3636
|
-
parameters?: Parameters<Paths.ListMarketplaceListingVersions.PathParameters> | null,
|
|
3637
|
-
data?: any,
|
|
3638
|
-
config?: AxiosRequestConfig
|
|
3639
|
-
): OperationResponse<Paths.ListMarketplaceListingVersions.Responses.$200>
|
|
3640
|
-
/**
|
|
3641
|
-
* createMarketplaceListingVersion - createMarketplaceListingVersion
|
|
3642
|
-
*
|
|
3643
|
-
* Create a draft version; auto-snapshots resources, requiredFeatures, recommendedApps from current blueprint
|
|
3644
|
-
*/
|
|
3645
|
-
'createMarketplaceListingVersion'(
|
|
3646
|
-
parameters?: Parameters<Paths.CreateMarketplaceListingVersion.PathParameters> | null,
|
|
3647
|
-
data?: any,
|
|
3648
|
-
config?: AxiosRequestConfig
|
|
3649
|
-
): OperationResponse<Paths.CreateMarketplaceListingVersion.Responses.$201>
|
|
3650
|
-
/**
|
|
3651
|
-
* updateMarketplaceListingVersion - updateMarketplaceListingVersion
|
|
3652
|
-
*
|
|
3653
|
-
* Update updateNote, requiredFeatures, or recommendedApps on a draft version
|
|
3654
|
-
*/
|
|
3655
|
-
'updateMarketplaceListingVersion'(
|
|
3656
|
-
parameters?: Parameters<Paths.UpdateMarketplaceListingVersion.PathParameters> | null,
|
|
3657
|
-
data?: Paths.UpdateMarketplaceListingVersion.RequestBody,
|
|
3658
|
-
config?: AxiosRequestConfig
|
|
3659
|
-
): OperationResponse<Paths.UpdateMarketplaceListingVersion.Responses.$200>
|
|
3660
|
-
/**
|
|
3661
|
-
* publishMarketplaceListingVersion - publishMarketplaceListingVersion
|
|
3662
|
-
*
|
|
3663
|
-
* Publish a draft version; archives the previous live version
|
|
3664
|
-
*/
|
|
3665
|
-
'publishMarketplaceListingVersion'(
|
|
3666
|
-
parameters?: Parameters<Paths.PublishMarketplaceListingVersion.PathParameters> | null,
|
|
3667
|
-
data?: Paths.PublishMarketplaceListingVersion.RequestBody,
|
|
3668
|
-
config?: AxiosRequestConfig
|
|
3669
|
-
): OperationResponse<Paths.PublishMarketplaceListingVersion.Responses.$200>
|
|
3670
|
-
/**
|
|
3671
|
-
* installBlueprintV3 - Install Blueprint V3
|
|
3672
|
-
*
|
|
3673
|
-
* Install a blueprint using the V3 engine (direct API calls, no Terraform).
|
|
3674
|
-
* Creates resources in topological order with global ID replacement.
|
|
3675
|
-
* Supports checkpoint-based resume on failure.
|
|
3676
|
-
*
|
|
3677
|
-
*/
|
|
3678
|
-
'installBlueprintV3'(
|
|
3679
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3680
|
-
data?: Paths.InstallBlueprintV3.RequestBody,
|
|
3681
|
-
config?: AxiosRequestConfig
|
|
3682
|
-
): OperationResponse<Paths.InstallBlueprintV3.Responses.$202>
|
|
3683
|
-
/**
|
|
3684
|
-
* getBlueprintLineageV3 - Get Blueprint Lineage V3
|
|
3685
|
-
*
|
|
3686
|
-
* Returns the lineage registry entries for a blueprint's resources in the current org.
|
|
3687
|
-
* Shows the mapping between source lineage IDs and target resource IDs.
|
|
3688
|
-
*
|
|
3689
|
-
*/
|
|
3690
|
-
'getBlueprintLineageV3'(
|
|
3691
|
-
parameters?: Parameters<Paths.GetBlueprintLineageV3.PathParameters> | null,
|
|
3692
|
-
data?: any,
|
|
3693
|
-
config?: AxiosRequestConfig
|
|
3694
|
-
): OperationResponse<Paths.GetBlueprintLineageV3.Responses.$200>
|
|
3695
|
-
}
|
|
3696
|
-
|
|
3697
|
-
interface PathsDictionary {
|
|
3698
|
-
['/v1/blueprint-manifest/jobs/{job_id}']: {
|
|
3699
|
-
/**
|
|
3700
|
-
* getJob - getJob
|
|
3701
|
-
*
|
|
3702
|
-
* Get the current status of a blueprint (export or import)
|
|
3703
|
-
*/
|
|
3704
|
-
'get'(
|
|
3705
|
-
parameters?: Parameters<Paths.GetJob.PathParameters> | null,
|
|
3706
|
-
data?: any,
|
|
3707
|
-
config?: AxiosRequestConfig
|
|
3708
|
-
): OperationResponse<Paths.GetJob.Responses.$200>
|
|
3709
|
-
}
|
|
3710
|
-
['/v1/blueprint-manifest/jobs:createExport']: {
|
|
3711
|
-
/**
|
|
3712
|
-
* createExport - createExport
|
|
3713
|
-
*
|
|
3714
|
-
* Creates a new Export Job with a list of available resources to export from the passed root resource.
|
|
3715
|
-
*
|
|
3716
|
-
* Multiple root resources can be added by calling this multiple times with the same jobId
|
|
3717
|
-
*
|
|
3718
|
-
*/
|
|
3719
|
-
'post'(
|
|
3720
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3721
|
-
data?: Paths.CreateExport.RequestBody,
|
|
3722
|
-
config?: AxiosRequestConfig
|
|
3723
|
-
): OperationResponse<Paths.CreateExport.Responses.$200>
|
|
3724
|
-
}
|
|
3725
|
-
['/v1/blueprint-manifest/jobs/{job_id}:exportManifest']: {
|
|
3726
|
-
/**
|
|
3727
|
-
* exportManifest - exportManifest
|
|
3728
|
-
*
|
|
3729
|
-
* Triggers exporting a manifest file using selected resoruce ids for a job created with `createExportJob`
|
|
3730
|
-
*/
|
|
3731
|
-
'post'(
|
|
3732
|
-
parameters?: Parameters<Paths.ExportManifest.PathParameters> | null,
|
|
3733
|
-
data?: Paths.ExportManifest.RequestBody,
|
|
3734
|
-
config?: AxiosRequestConfig
|
|
3735
|
-
): OperationResponse<Paths.ExportManifest.Responses.$200>
|
|
3736
|
-
}
|
|
3737
|
-
['/v1/blueprint-manifest:uploadManifest']: {
|
|
3738
|
-
/**
|
|
3739
|
-
* uploadManifest - uploadManifest
|
|
3740
|
-
*
|
|
3741
|
-
* Create pre-signed S3 URL to upload a manifest file.
|
|
3742
|
-
*
|
|
3743
|
-
*/
|
|
3744
|
-
'post'(
|
|
3745
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3746
|
-
data?: Paths.UploadManifest.RequestBody,
|
|
3747
|
-
config?: AxiosRequestConfig
|
|
3748
|
-
): OperationResponse<Paths.UploadManifest.Responses.$201>
|
|
3749
|
-
}
|
|
3750
|
-
['/v1/blueprint-manifest/jobs:createPlan']: {
|
|
3751
|
-
/**
|
|
3752
|
-
* createPlan - createPlan
|
|
3753
|
-
*
|
|
3754
|
-
* Creates a new import job from an uploaded manifest file and returns the plan.
|
|
3755
|
-
*
|
|
3756
|
-
* Creates an updated plan for an installed manifest when `manifest_id` is passed
|
|
3757
|
-
*
|
|
3758
|
-
*/
|
|
3759
|
-
'post'(
|
|
3760
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3761
|
-
data?: Paths.CreatePlan.RequestBody,
|
|
3762
|
-
config?: AxiosRequestConfig
|
|
3763
|
-
): OperationResponse<Paths.CreatePlan.Responses.$200>
|
|
3764
|
-
}
|
|
3765
|
-
['/v1/blueprint-manifest/jobs/{job_id}:applyPlan']: {
|
|
3766
|
-
/**
|
|
3767
|
-
* applyPlan - applyPlan
|
|
3768
|
-
*
|
|
3769
|
-
* Apply a plan returned by `createPlan`.
|
|
3770
|
-
*/
|
|
3771
|
-
'post'(
|
|
3772
|
-
parameters?: Parameters<Paths.ApplyPlan.PathParameters> | null,
|
|
3773
|
-
data?: Paths.ApplyPlan.RequestBody,
|
|
3774
|
-
config?: AxiosRequestConfig
|
|
3775
|
-
): OperationResponse<Paths.ApplyPlan.Responses.$200>
|
|
3776
|
-
}
|
|
3777
|
-
['/v1/blueprint-manifest/manifests']: {
|
|
3778
|
-
/**
|
|
3779
|
-
* listInstalledManifests - listInstalledManifests
|
|
3780
|
-
*
|
|
3781
|
-
* List Blueprint Manifests installed to the organization
|
|
3782
|
-
*/
|
|
3783
|
-
'get'(
|
|
3784
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3785
|
-
data?: any,
|
|
3786
|
-
config?: AxiosRequestConfig
|
|
3787
|
-
): OperationResponse<Paths.ListInstalledManifests.Responses.$200>
|
|
3788
|
-
}
|
|
3789
|
-
['/v1/blueprint-manifest/manifests/{manifest_id}']: {
|
|
3790
|
-
/**
|
|
3791
|
-
* getManifest - getManifest
|
|
3792
|
-
*
|
|
3793
|
-
* Get installed Manifest by ID
|
|
3794
|
-
*/
|
|
3795
|
-
'get'(
|
|
3796
|
-
parameters?: Parameters<Paths.GetManifest.PathParameters> | null,
|
|
3797
|
-
data?: any,
|
|
3798
|
-
config?: AxiosRequestConfig
|
|
3799
|
-
): OperationResponse<Paths.GetManifest.Responses.$200>
|
|
3800
|
-
/**
|
|
3801
|
-
* updateManifest - updateManifest
|
|
3802
|
-
*
|
|
3803
|
-
* Update an installed manifest
|
|
3804
|
-
*
|
|
3805
|
-
*/
|
|
3806
|
-
'put'(
|
|
3807
|
-
parameters?: Parameters<Paths.UpdateManifest.PathParameters> | null,
|
|
3808
|
-
data?: Paths.UpdateManifest.RequestBody,
|
|
3809
|
-
config?: AxiosRequestConfig
|
|
3810
|
-
): OperationResponse<Paths.UpdateManifest.Responses.$200>
|
|
3811
|
-
/**
|
|
3812
|
-
* deleteManifest - deleteManifest
|
|
3813
|
-
*
|
|
3814
|
-
* Remove installed manifest from the org
|
|
3815
|
-
*
|
|
3816
|
-
* Note that this does not delete the installed resources of the Manifest!
|
|
3817
|
-
*
|
|
3818
|
-
*/
|
|
3819
|
-
'delete'(
|
|
3820
|
-
parameters?: Parameters<Paths.DeleteManifest.PathParameters> | null,
|
|
3821
|
-
data?: any,
|
|
3822
|
-
config?: AxiosRequestConfig
|
|
3823
|
-
): OperationResponse<Paths.DeleteManifest.Responses.$200>
|
|
3824
|
-
}
|
|
3825
|
-
['/v2/blueprint-manifest/blueprints']: {
|
|
3826
|
-
/**
|
|
3827
|
-
* listBlueprints - listBlueprints
|
|
3828
|
-
*
|
|
3829
|
-
* List Custom and Installed Blueprints
|
|
3830
|
-
*/
|
|
3831
|
-
'get'(
|
|
3832
|
-
parameters?: Parameters<Paths.ListBlueprints.QueryParameters> | null,
|
|
3833
|
-
data?: any,
|
|
3834
|
-
config?: AxiosRequestConfig
|
|
3835
|
-
): OperationResponse<Paths.ListBlueprints.Responses.$200>
|
|
3836
|
-
/**
|
|
3837
|
-
* createBlueprint - createBlueprint
|
|
3838
|
-
*
|
|
3839
|
-
* Create a Blueprint
|
|
3840
|
-
*/
|
|
3841
|
-
'post'(
|
|
3842
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3843
|
-
data?: Paths.CreateBlueprint.RequestBody,
|
|
3844
|
-
config?: AxiosRequestConfig
|
|
3845
|
-
): OperationResponse<Paths.CreateBlueprint.Responses.$200>
|
|
3846
|
-
}
|
|
3847
|
-
['/v2/blueprint-manifest/blueprints:marketplace']: {
|
|
3848
|
-
/**
|
|
3849
|
-
* listInstalledMarketplaceBlueprints - listInstalledMarketplaceBlueprints
|
|
3850
|
-
*
|
|
3851
|
-
* List installed Marketplace Blueprints for the organization.
|
|
3852
|
-
* When multiple blueprints have the same slug, returns only the most recently created one.
|
|
3853
|
-
*
|
|
3854
|
-
*/
|
|
3855
|
-
'get'(
|
|
3856
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3857
|
-
data?: any,
|
|
3858
|
-
config?: AxiosRequestConfig
|
|
3859
|
-
): OperationResponse<Paths.ListInstalledMarketplaceBlueprints.Responses.$200>
|
|
3860
|
-
}
|
|
3861
|
-
['/v2/blueprint-manifest/blueprints:pre-install']: {
|
|
3862
|
-
/**
|
|
3863
|
-
* preInstallBlueprint - preInstallBlueprint
|
|
3864
|
-
*
|
|
3865
|
-
* Pre-install a Blueprint based on a blueprint file
|
|
3866
|
-
*/
|
|
3867
|
-
'post'(
|
|
3868
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3869
|
-
data?: Paths.PreInstallBlueprint.RequestBody,
|
|
3870
|
-
config?: AxiosRequestConfig
|
|
3871
|
-
): OperationResponse<Paths.PreInstallBlueprint.Responses.$200>
|
|
3872
|
-
}
|
|
3873
|
-
['/v2/blueprint-manifest/blueprints:preview/{preview_id}']: {
|
|
3874
|
-
/**
|
|
3875
|
-
* getBlueprintPreview - getBlueprintPreview
|
|
3876
|
-
*
|
|
3877
|
-
* Get Blueprint Preview by ID
|
|
3878
|
-
*/
|
|
3879
|
-
'get'(
|
|
3880
|
-
parameters?: Parameters<Paths.GetBlueprintPreview.PathParameters> | null,
|
|
3881
|
-
data?: any,
|
|
3882
|
-
config?: AxiosRequestConfig
|
|
3883
|
-
): OperationResponse<Paths.GetBlueprintPreview.Responses.$200>
|
|
3884
|
-
}
|
|
3885
|
-
['/v2/blueprint-manifest/blueprint:install']: {
|
|
3886
|
-
/**
|
|
3887
|
-
* installBlueprint - installBlueprint
|
|
3888
|
-
*
|
|
3889
|
-
* Kick off a new blueprint installation job. Returns 202 Accepted with Location header pointing to the job resource
|
|
3890
|
-
*
|
|
3891
|
-
*/
|
|
3892
|
-
'post'(
|
|
3893
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3894
|
-
data?: Paths.InstallBlueprint.RequestBody,
|
|
3895
|
-
config?: AxiosRequestConfig
|
|
3896
|
-
): OperationResponse<Paths.InstallBlueprint.Responses.$202>
|
|
3897
|
-
}
|
|
3898
|
-
['/v2/blueprint-manifest/blueprints/{blueprint_id}']: {
|
|
3899
|
-
/**
|
|
3900
|
-
* getBlueprint - getBlueprint
|
|
3901
|
-
*
|
|
3902
|
-
* Get Blueprint by ID
|
|
3903
|
-
*/
|
|
3904
|
-
'get'(
|
|
3905
|
-
parameters?: Parameters<Paths.GetBlueprint.PathParameters> | null,
|
|
3906
|
-
data?: any,
|
|
3907
|
-
config?: AxiosRequestConfig
|
|
3908
|
-
): OperationResponse<Paths.GetBlueprint.Responses.$200>
|
|
3909
|
-
/**
|
|
3910
|
-
* updateBlueprint - updateBlueprint
|
|
3911
|
-
*
|
|
3912
|
-
* Update a Blueprint
|
|
3913
|
-
*/
|
|
3914
|
-
'put'(
|
|
3915
|
-
parameters?: Parameters<Paths.UpdateBlueprint.PathParameters> | null,
|
|
3916
|
-
data?: Paths.UpdateBlueprint.RequestBody,
|
|
3917
|
-
config?: AxiosRequestConfig
|
|
3918
|
-
): OperationResponse<Paths.UpdateBlueprint.Responses.$200>
|
|
3919
|
-
/**
|
|
3920
|
-
* deleteBlueprint - deleteBlueprint
|
|
3921
|
-
*
|
|
3922
|
-
* Delete a Blueprint
|
|
3923
|
-
*/
|
|
3924
|
-
'delete'(
|
|
3925
|
-
parameters?: Parameters<Paths.DeleteBlueprint.PathParameters> | null,
|
|
3926
|
-
data?: any,
|
|
3927
|
-
config?: AxiosRequestConfig
|
|
3928
|
-
): OperationResponse<Paths.DeleteBlueprint.Responses.$200>
|
|
3929
|
-
}
|
|
3930
|
-
['/v2/blueprint-manifest/blueprints/{blueprint_id}/validate']: {
|
|
3931
|
-
/**
|
|
3932
|
-
* validateBlueprint - validateBlueprint
|
|
3933
|
-
*
|
|
3934
|
-
* Start a blueprint validation job. Validates Terraform for the blueprint (all types).
|
|
3935
|
-
* Returns 202 Accepted with job_id. Poll GET /jobs/{job_id} for status, valid, and errors.
|
|
3936
|
-
*
|
|
3937
|
-
*/
|
|
3938
|
-
'post'(
|
|
3939
|
-
parameters?: Parameters<Paths.ValidateBlueprint.PathParameters> | null,
|
|
3940
|
-
data?: any,
|
|
3941
|
-
config?: AxiosRequestConfig
|
|
3942
|
-
): OperationResponse<Paths.ValidateBlueprint.Responses.$202>
|
|
3943
|
-
}
|
|
3944
|
-
['/v2/blueprint-manifest/blueprints/{blueprint_id}:verify']: {
|
|
3945
|
-
/**
|
|
3946
|
-
* verifyBlueprint - verifyBlueprint
|
|
3947
|
-
*
|
|
3948
|
-
* Start a blueprint verification job. Compares resource configurations between a source org
|
|
3949
|
-
* and a destination org to verify that a sync/install was successful.
|
|
3950
|
-
* Returns 202 Accepted with job_id. Poll GET /jobs/{job_id} for status, summary, and resource_results.
|
|
3951
|
-
*
|
|
3952
|
-
*/
|
|
3953
|
-
'post'(
|
|
3954
|
-
parameters?: Parameters<Paths.VerifyBlueprint.PathParameters> | null,
|
|
3955
|
-
data?: Paths.VerifyBlueprint.RequestBody,
|
|
3956
|
-
config?: AxiosRequestConfig
|
|
3957
|
-
): OperationResponse<Paths.VerifyBlueprint.Responses.$202>
|
|
3958
|
-
}
|
|
3959
|
-
['/v2/blueprint-manifest/blueprints/{blueprint_id}:export']: {
|
|
3960
|
-
/**
|
|
3961
|
-
* exportBlueprint - exportBlueprint
|
|
3962
|
-
*
|
|
3963
|
-
* Kick off a new blueprint export job. Returns 202 Accepted with Location header pointing to the job resource.
|
|
3964
|
-
*
|
|
3965
|
-
*/
|
|
3966
|
-
'post'(
|
|
3967
|
-
parameters?: Parameters<Paths.ExportBlueprint.PathParameters> | null,
|
|
3968
|
-
data?: Paths.ExportBlueprint.RequestBody,
|
|
3969
|
-
config?: AxiosRequestConfig
|
|
3970
|
-
): OperationResponse<Paths.ExportBlueprint.Responses.$202>
|
|
3971
|
-
}
|
|
3972
|
-
['/v2/blueprint-manifest/marketplace/slugs']: {
|
|
3973
|
-
/**
|
|
3974
|
-
* listMarketplaceSlugs - listMarketplaceSlugs
|
|
3975
|
-
*
|
|
3976
|
-
* List all available marketplace blueprint slugs from Webflow CMS.
|
|
3977
|
-
* Returns cached results when available.
|
|
3978
|
-
*
|
|
3979
|
-
*/
|
|
3980
|
-
'get'(
|
|
3981
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3982
|
-
data?: any,
|
|
3983
|
-
config?: AxiosRequestConfig
|
|
3984
|
-
): OperationResponse<Paths.ListMarketplaceSlugs.Responses.$200>
|
|
3985
|
-
}
|
|
3986
|
-
['/v2/blueprint-manifest/blueprints:publish']: {
|
|
3987
|
-
/**
|
|
3988
|
-
* publishBlueprint - publishBlueprint
|
|
3989
|
-
*
|
|
3990
|
-
* Publish a blueprint to the marketplace. Exports the blueprint, uploads it to file-api with public access, and updates the Webflow CMS listing.
|
|
3991
|
-
*
|
|
3992
|
-
*/
|
|
3993
|
-
'post'(
|
|
3994
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3995
|
-
data?: Paths.PublishBlueprint.RequestBody,
|
|
3996
|
-
config?: AxiosRequestConfig
|
|
3997
|
-
): OperationResponse<Paths.PublishBlueprint.Responses.$202>
|
|
3998
|
-
}
|
|
3999
|
-
['/v2/blueprint-manifest/blueprints/{blueprint_id}:format-description']: {
|
|
4000
|
-
/**
|
|
4001
|
-
* formatBlueprintDescription - formatBlueprintDescription
|
|
4002
|
-
*
|
|
4003
|
-
* Format a blueprint description as markdown using AI.
|
|
4004
|
-
*
|
|
4005
|
-
*/
|
|
4006
|
-
'post'(
|
|
4007
|
-
parameters?: Parameters<Paths.FormatBlueprintDescription.PathParameters> | null,
|
|
4008
|
-
data?: Paths.FormatBlueprintDescription.RequestBody,
|
|
4009
|
-
config?: AxiosRequestConfig
|
|
4010
|
-
): OperationResponse<Paths.FormatBlueprintDescription.Responses.$200>
|
|
4011
|
-
}
|
|
4012
|
-
['/v2/blueprint-manifest/blueprints/{blueprint_id}/resources']: {
|
|
4013
|
-
/**
|
|
4014
|
-
* addBlueprintResource - addBlueprintResource
|
|
4015
|
-
*
|
|
4016
|
-
* Add a resource to a Blueprint
|
|
4017
|
-
*/
|
|
4018
|
-
'post'(
|
|
4019
|
-
parameters?: Parameters<Paths.AddBlueprintResource.QueryParameters & Paths.AddBlueprintResource.PathParameters> | null,
|
|
4020
|
-
data?: Paths.AddBlueprintResource.RequestBody,
|
|
4021
|
-
config?: AxiosRequestConfig
|
|
4022
|
-
): OperationResponse<Paths.AddBlueprintResource.Responses.$200>
|
|
4023
|
-
}
|
|
4024
|
-
['/v2/blueprint-manifest/blueprints/{blueprint_id}/resources:syncDependencies']: {
|
|
4025
|
-
/**
|
|
4026
|
-
* syncDependencies - syncDependencies
|
|
4027
|
-
*
|
|
4028
|
-
* Sync dependencies of all root resources in a Blueprint
|
|
4029
|
-
*/
|
|
4030
|
-
'post'(
|
|
4031
|
-
parameters?: Parameters<Paths.SyncDependencies.PathParameters> | null,
|
|
4032
|
-
data?: any,
|
|
4033
|
-
config?: AxiosRequestConfig
|
|
4034
|
-
): OperationResponse<Paths.SyncDependencies.Responses.$202>
|
|
4035
|
-
}
|
|
4036
|
-
['/v2/blueprint-manifest/blueprints/{blueprint_id}/resources/bulk']: {
|
|
4037
|
-
/**
|
|
4038
|
-
* bulkAddBlueprintResources - bulkAddBlueprintResources
|
|
4039
|
-
*
|
|
4040
|
-
* Bulk Add resources in a Blueprint
|
|
4041
|
-
*/
|
|
4042
|
-
'post'(
|
|
4043
|
-
parameters?: Parameters<Paths.BulkAddBlueprintResources.QueryParameters & Paths.BulkAddBlueprintResources.PathParameters> | null,
|
|
4044
|
-
data?: Paths.BulkAddBlueprintResources.RequestBody,
|
|
4045
|
-
config?: AxiosRequestConfig
|
|
4046
|
-
): OperationResponse<Paths.BulkAddBlueprintResources.Responses.$200>
|
|
4047
|
-
/**
|
|
4048
|
-
* bulkUpdateBlueprintResources - bulkUpdateBlueprintResources
|
|
4049
|
-
*
|
|
4050
|
-
* Bulk update resources in a Blueprint
|
|
4051
|
-
*/
|
|
4052
|
-
'put'(
|
|
4053
|
-
parameters?: Parameters<Paths.BulkUpdateBlueprintResources.PathParameters> | null,
|
|
4054
|
-
data?: Paths.BulkUpdateBlueprintResources.RequestBody,
|
|
4055
|
-
config?: AxiosRequestConfig
|
|
4056
|
-
): OperationResponse<Paths.BulkUpdateBlueprintResources.Responses.$200>
|
|
4057
|
-
/**
|
|
4058
|
-
* bulkDeleteBlueprintResources - bulkDeleteBlueprintResources
|
|
4059
|
-
*
|
|
4060
|
-
* Bulk delete resources in a Blueprint
|
|
4061
|
-
*/
|
|
4062
|
-
'delete'(
|
|
4063
|
-
parameters?: Parameters<Paths.BulkDeleteBlueprintResources.PathParameters> | null,
|
|
4064
|
-
data?: Paths.BulkDeleteBlueprintResources.RequestBody,
|
|
4065
|
-
config?: AxiosRequestConfig
|
|
4066
|
-
): OperationResponse<Paths.BulkDeleteBlueprintResources.Responses.$200>
|
|
4067
|
-
}
|
|
4068
|
-
['/v2/blueprint-manifest/blueprints/{blueprint_id}/resources/{resource_id}']: {
|
|
4069
|
-
/**
|
|
4070
|
-
* updateBlueprintResource - updateBlueprintResource
|
|
4071
|
-
*
|
|
4072
|
-
* Update a resource in a Blueprint
|
|
4073
|
-
*/
|
|
4074
|
-
'put'(
|
|
4075
|
-
parameters?: Parameters<Paths.UpdateBlueprintResource.PathParameters> | null,
|
|
4076
|
-
data?: Paths.UpdateBlueprintResource.RequestBody,
|
|
4077
|
-
config?: AxiosRequestConfig
|
|
4078
|
-
): OperationResponse<Paths.UpdateBlueprintResource.Responses.$200>
|
|
4079
|
-
/**
|
|
4080
|
-
* deleteBlueprintResource - deleteBlueprintResource
|
|
4081
|
-
*
|
|
4082
|
-
* Delete a resource from a Blueprint
|
|
4083
|
-
*/
|
|
4084
|
-
'delete'(
|
|
4085
|
-
parameters?: Parameters<Paths.DeleteBlueprintResource.PathParameters> | null,
|
|
4086
|
-
data?: any,
|
|
4087
|
-
config?: AxiosRequestConfig
|
|
4088
|
-
): OperationResponse<Paths.DeleteBlueprintResource.Responses.$200>
|
|
4089
|
-
}
|
|
4090
|
-
['/v2/blueprint-manifest/jobs']: {
|
|
4091
|
-
/**
|
|
4092
|
-
* listBlueprintJobs - List Blueprint Jobs
|
|
4093
|
-
*
|
|
4094
|
-
* List all blueprint jobs
|
|
4095
|
-
*/
|
|
4096
|
-
'get'(
|
|
4097
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
4098
|
-
data?: any,
|
|
4099
|
-
config?: AxiosRequestConfig
|
|
4100
|
-
): OperationResponse<Paths.ListBlueprintJobs.Responses.$200>
|
|
4101
|
-
}
|
|
4102
|
-
['/v2/blueprint-manifest/jobs/{job_id}']: {
|
|
4103
|
-
/**
|
|
4104
|
-
* getBlueprintJob - Get Job
|
|
4105
|
-
*
|
|
4106
|
-
* Poll current state of a job.
|
|
4107
|
-
*/
|
|
4108
|
-
'get'(
|
|
4109
|
-
parameters?: Parameters<Paths.GetBlueprintJob.PathParameters> | null,
|
|
4110
|
-
data?: any,
|
|
4111
|
-
config?: AxiosRequestConfig
|
|
4112
|
-
): OperationResponse<Paths.GetBlueprintJob.Responses.$200>
|
|
4113
|
-
}
|
|
4114
|
-
['/v2/blueprint-manifest/jobs/{job_id}:continue']: {
|
|
4115
|
-
/**
|
|
4116
|
-
* continueInstallationJob - Continue Installation Job
|
|
4117
|
-
*
|
|
4118
|
-
* Continue an installation job if it is waiting for user action.
|
|
4119
|
-
*/
|
|
4120
|
-
'post'(
|
|
4121
|
-
parameters?: Parameters<Paths.ContinueInstallationJob.PathParameters> | null,
|
|
4122
|
-
data?: Paths.ContinueInstallationJob.RequestBody,
|
|
4123
|
-
config?: AxiosRequestConfig
|
|
4124
|
-
): OperationResponse<Paths.ContinueInstallationJob.Responses.$200>
|
|
4125
|
-
}
|
|
4126
|
-
['/v2/blueprint-manifest/jobs/{job_id}:cancel']: {
|
|
4127
|
-
/**
|
|
4128
|
-
* cancelBlueprintJob - Cancel Blueprint Job
|
|
4129
|
-
*
|
|
4130
|
-
* Cancel a blueprint job if it is still running.
|
|
4131
|
-
*/
|
|
4132
|
-
'post'(
|
|
4133
|
-
parameters?: Parameters<Paths.CancelBlueprintJob.PathParameters> | null,
|
|
4134
|
-
data?: any,
|
|
4135
|
-
config?: AxiosRequestConfig
|
|
4136
|
-
): OperationResponse<Paths.CancelBlueprintJob.Responses.$200>
|
|
4137
|
-
}
|
|
4138
|
-
['/v1/blueprints/{blueprint_id}/marketplace-listing']: {
|
|
4139
|
-
/**
|
|
4140
|
-
* createMarketplaceListing - createMarketplaceListing
|
|
4141
|
-
*
|
|
4142
|
-
* Create a marketplace listing for a blueprint. Returns 409 if one already exists.
|
|
4143
|
-
*/
|
|
4144
|
-
'post'(
|
|
4145
|
-
parameters?: Parameters<Paths.CreateMarketplaceListing.PathParameters> | null,
|
|
4146
|
-
data?: Paths.CreateMarketplaceListing.RequestBody,
|
|
4147
|
-
config?: AxiosRequestConfig
|
|
4148
|
-
): OperationResponse<Paths.CreateMarketplaceListing.Responses.$201>
|
|
4149
|
-
/**
|
|
4150
|
-
* getMarketplaceListing - getMarketplaceListing
|
|
4151
|
-
*
|
|
4152
|
-
* Get marketplace listing for a blueprint including all versions
|
|
4153
|
-
*/
|
|
4154
|
-
'get'(
|
|
4155
|
-
parameters?: Parameters<Paths.GetMarketplaceListing.PathParameters> | null,
|
|
4156
|
-
data?: any,
|
|
4157
|
-
config?: AxiosRequestConfig
|
|
4158
|
-
): OperationResponse<Paths.GetMarketplaceListing.Responses.$200>
|
|
4159
|
-
}
|
|
4160
|
-
['/v1/marketplace-listings']: {
|
|
4161
|
-
/**
|
|
4162
|
-
* listMarketplaceListings - listMarketplaceListings
|
|
4163
|
-
*
|
|
4164
|
-
* List all marketplace listings for the authenticated organization
|
|
4165
|
-
*/
|
|
4166
|
-
'get'(
|
|
4167
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
4168
|
-
data?: any,
|
|
4169
|
-
config?: AxiosRequestConfig
|
|
4170
|
-
): OperationResponse<Paths.ListMarketplaceListings.Responses.$200>
|
|
4171
|
-
}
|
|
4172
|
-
['/v1/marketplace-listings/{listing_id}']: {
|
|
4173
|
-
/**
|
|
4174
|
-
* getMarketplaceListingById - getMarketplaceListingById
|
|
4175
|
-
*
|
|
4176
|
-
* Get marketplace listing by listing ID including all versions
|
|
4177
|
-
*/
|
|
4178
|
-
'get'(
|
|
4179
|
-
parameters?: Parameters<Paths.GetMarketplaceListingById.PathParameters> | null,
|
|
4180
|
-
data?: any,
|
|
4181
|
-
config?: AxiosRequestConfig
|
|
4182
|
-
): OperationResponse<Paths.GetMarketplaceListingById.Responses.$200>
|
|
4183
|
-
/**
|
|
4184
|
-
* updateMarketplaceListing - updateMarketplaceListing
|
|
4185
|
-
*
|
|
4186
|
-
* Update listing-level fields
|
|
4187
|
-
*/
|
|
4188
|
-
'patch'(
|
|
4189
|
-
parameters?: Parameters<Paths.UpdateMarketplaceListing.PathParameters> | null,
|
|
4190
|
-
data?: Paths.UpdateMarketplaceListing.RequestBody,
|
|
4191
|
-
config?: AxiosRequestConfig
|
|
4192
|
-
): OperationResponse<Paths.UpdateMarketplaceListing.Responses.$200>
|
|
4193
|
-
/**
|
|
4194
|
-
* deleteMarketplaceListing - deleteMarketplaceListing
|
|
4195
|
-
*
|
|
4196
|
-
* Delete listing and all versions
|
|
4197
|
-
*/
|
|
4198
|
-
'delete'(
|
|
4199
|
-
parameters?: Parameters<Paths.DeleteMarketplaceListing.PathParameters> | null,
|
|
4200
|
-
data?: any,
|
|
4201
|
-
config?: AxiosRequestConfig
|
|
4202
|
-
): OperationResponse<Paths.DeleteMarketplaceListing.Responses.$204>
|
|
4203
|
-
}
|
|
4204
|
-
['/v1/marketplace-listings/{listing_id}/versions']: {
|
|
4205
|
-
/**
|
|
4206
|
-
* createMarketplaceListingVersion - createMarketplaceListingVersion
|
|
4207
|
-
*
|
|
4208
|
-
* Create a draft version; auto-snapshots resources, requiredFeatures, recommendedApps from current blueprint
|
|
4209
|
-
*/
|
|
4210
|
-
'post'(
|
|
4211
|
-
parameters?: Parameters<Paths.CreateMarketplaceListingVersion.PathParameters> | null,
|
|
4212
|
-
data?: any,
|
|
4213
|
-
config?: AxiosRequestConfig
|
|
4214
|
-
): OperationResponse<Paths.CreateMarketplaceListingVersion.Responses.$201>
|
|
4215
|
-
/**
|
|
4216
|
-
* listMarketplaceListingVersions - listMarketplaceListingVersions
|
|
4217
|
-
*
|
|
4218
|
-
* List all versions for a listing, newest first
|
|
4219
|
-
*/
|
|
4220
|
-
'get'(
|
|
4221
|
-
parameters?: Parameters<Paths.ListMarketplaceListingVersions.PathParameters> | null,
|
|
4222
|
-
data?: any,
|
|
4223
|
-
config?: AxiosRequestConfig
|
|
4224
|
-
): OperationResponse<Paths.ListMarketplaceListingVersions.Responses.$200>
|
|
4225
|
-
}
|
|
4226
|
-
['/v1/marketplace-listings/{listing_id}/versions/{version_id}']: {
|
|
4227
|
-
/**
|
|
4228
|
-
* updateMarketplaceListingVersion - updateMarketplaceListingVersion
|
|
4229
|
-
*
|
|
4230
|
-
* Update updateNote, requiredFeatures, or recommendedApps on a draft version
|
|
4231
|
-
*/
|
|
4232
|
-
'patch'(
|
|
4233
|
-
parameters?: Parameters<Paths.UpdateMarketplaceListingVersion.PathParameters> | null,
|
|
4234
|
-
data?: Paths.UpdateMarketplaceListingVersion.RequestBody,
|
|
4235
|
-
config?: AxiosRequestConfig
|
|
4236
|
-
): OperationResponse<Paths.UpdateMarketplaceListingVersion.Responses.$200>
|
|
4237
|
-
}
|
|
4238
|
-
['/v1/marketplace-listings/{listing_id}/versions/{version_id}/publish']: {
|
|
4239
|
-
/**
|
|
4240
|
-
* publishMarketplaceListingVersion - publishMarketplaceListingVersion
|
|
4241
|
-
*
|
|
4242
|
-
* Publish a draft version; archives the previous live version
|
|
4243
|
-
*/
|
|
4244
|
-
'post'(
|
|
4245
|
-
parameters?: Parameters<Paths.PublishMarketplaceListingVersion.PathParameters> | null,
|
|
4246
|
-
data?: Paths.PublishMarketplaceListingVersion.RequestBody,
|
|
4247
|
-
config?: AxiosRequestConfig
|
|
4248
|
-
): OperationResponse<Paths.PublishMarketplaceListingVersion.Responses.$200>
|
|
4249
|
-
}
|
|
4250
|
-
['/v3/blueprint-manifest/blueprint:install']: {
|
|
4251
|
-
/**
|
|
4252
|
-
* installBlueprintV3 - Install Blueprint V3
|
|
4253
|
-
*
|
|
4254
|
-
* Install a blueprint using the V3 engine (direct API calls, no Terraform).
|
|
4255
|
-
* Creates resources in topological order with global ID replacement.
|
|
4256
|
-
* Supports checkpoint-based resume on failure.
|
|
4257
|
-
*
|
|
4258
|
-
*/
|
|
4259
|
-
'post'(
|
|
4260
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
4261
|
-
data?: Paths.InstallBlueprintV3.RequestBody,
|
|
4262
|
-
config?: AxiosRequestConfig
|
|
4263
|
-
): OperationResponse<Paths.InstallBlueprintV3.Responses.$202>
|
|
4264
|
-
}
|
|
4265
|
-
['/v3/blueprint-manifest/blueprints/{blueprint_id}/lineage']: {
|
|
4266
|
-
/**
|
|
4267
|
-
* getBlueprintLineageV3 - Get Blueprint Lineage V3
|
|
4268
|
-
*
|
|
4269
|
-
* Returns the lineage registry entries for a blueprint's resources in the current org.
|
|
4270
|
-
* Shows the mapping between source lineage IDs and target resource IDs.
|
|
4271
|
-
*
|
|
4272
|
-
*/
|
|
4273
|
-
'get'(
|
|
4274
|
-
parameters?: Parameters<Paths.GetBlueprintLineageV3.PathParameters> | null,
|
|
4275
|
-
data?: any,
|
|
4276
|
-
config?: AxiosRequestConfig
|
|
4277
|
-
): OperationResponse<Paths.GetBlueprintLineageV3.Responses.$200>
|
|
4278
|
-
}
|
|
4279
|
-
}
|
|
4280
|
-
|
|
4281
|
-
type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
4282
|
-
|
|
4283
|
-
|
|
4284
|
-
type AppBlueprint = Components.Schemas.AppBlueprint;
|
|
4285
|
-
type Blueprint = Components.Schemas.Blueprint;
|
|
4286
|
-
type BlueprintDependenciesSyncJob = Components.Schemas.BlueprintDependenciesSyncJob;
|
|
4287
|
-
type BlueprintExportJob = Components.Schemas.BlueprintExportJob;
|
|
4288
|
-
type BlueprintID = Components.Schemas.BlueprintID;
|
|
4289
|
-
type BlueprintInstallStatus = Components.Schemas.BlueprintInstallStatus;
|
|
4290
|
-
type BlueprintInstallationJob = Components.Schemas.BlueprintInstallationJob;
|
|
4291
|
-
type BlueprintInstallationJobOptions = Components.Schemas.BlueprintInstallationJobOptions;
|
|
4292
|
-
type BlueprintJob = Components.Schemas.BlueprintJob;
|
|
4293
|
-
type BlueprintJobEvent = Components.Schemas.BlueprintJobEvent;
|
|
4294
|
-
type BlueprintJobID = Components.Schemas.BlueprintJobID;
|
|
4295
|
-
type BlueprintPreview = Components.Schemas.BlueprintPreview;
|
|
4296
|
-
type BlueprintResource = Components.Schemas.BlueprintResource;
|
|
4297
|
-
type BlueprintResourceID = Components.Schemas.BlueprintResourceID;
|
|
4298
|
-
type BlueprintValidateJob = Components.Schemas.BlueprintValidateJob;
|
|
4299
|
-
type BlueprintVerificationJob = Components.Schemas.BlueprintVerificationJob;
|
|
4300
|
-
type CallerIdentity = Components.Schemas.CallerIdentity;
|
|
4301
|
-
type CommonBlueprintFields = Components.Schemas.CommonBlueprintFields;
|
|
4302
|
-
type CommonBlueprintJobFields = Components.Schemas.CommonBlueprintJobFields;
|
|
4303
|
-
type CommonImportFields = Components.Schemas.CommonImportFields;
|
|
4304
|
-
type CommonManifestFields = Components.Schemas.CommonManifestFields;
|
|
4305
|
-
type CommonMarkdownFields = Components.Schemas.CommonMarkdownFields;
|
|
4306
|
-
type CommonResourceNode = Components.Schemas.CommonResourceNode;
|
|
4307
|
-
type CustomBlueprint = Components.Schemas.CustomBlueprint;
|
|
4308
|
-
type DeployedBlueprint = Components.Schemas.DeployedBlueprint;
|
|
4309
|
-
type FieldDiff = Components.Schemas.FieldDiff;
|
|
4310
|
-
type FileBlueprint = Components.Schemas.FileBlueprint;
|
|
4311
|
-
type FormattedError = Components.Schemas.FormattedError;
|
|
4312
|
-
type FormattedErrorCodes = Components.Schemas.FormattedErrorCodes;
|
|
4313
|
-
type FormattedErrorData = Components.Schemas.FormattedErrorData;
|
|
4314
|
-
type InstalledMarketplaceBlueprintItem = Components.Schemas.InstalledMarketplaceBlueprintItem;
|
|
4315
|
-
type Job = Components.Schemas.Job;
|
|
4316
|
-
type JobID = Components.Schemas.JobID;
|
|
4317
|
-
type JobStatus = Components.Schemas.JobStatus;
|
|
4318
|
-
type LatestBlueprintVerification = Components.Schemas.LatestBlueprintVerification;
|
|
4319
|
-
type LineageEntry = Components.Schemas.LineageEntry;
|
|
4320
|
-
type Manifest = Components.Schemas.Manifest;
|
|
4321
|
-
type ManifestID = Components.Schemas.ManifestID;
|
|
4322
|
-
type ManifestItem = Components.Schemas.ManifestItem;
|
|
4323
|
-
type ManifestSource = Components.Schemas.ManifestSource;
|
|
4324
|
-
type ManifestTimestampFields = Components.Schemas.ManifestTimestampFields;
|
|
4325
|
-
type MarketplaceBlueprint = Components.Schemas.MarketplaceBlueprint;
|
|
4326
|
-
type MarketplaceListing = Components.Schemas.MarketplaceListing;
|
|
4327
|
-
type MarketplaceListingUpdate = Components.Schemas.MarketplaceListingUpdate;
|
|
4328
|
-
type MarketplaceListingVersion = Components.Schemas.MarketplaceListingVersion;
|
|
4329
|
-
type PlanChanges = Components.Schemas.PlanChanges;
|
|
4330
|
-
type PreInstallRequirements = Components.Schemas.PreInstallRequirements;
|
|
4331
|
-
type PutManifestPayload = Components.Schemas.PutManifestPayload;
|
|
4332
|
-
type ResourceNode = Components.Schemas.ResourceNode;
|
|
4333
|
-
type ResourceNodeType = Components.Schemas.ResourceNodeType;
|
|
4334
|
-
type ResourceReplacement = Components.Schemas.ResourceReplacement;
|
|
4335
|
-
type ResourceVerificationResult = Components.Schemas.ResourceVerificationResult;
|
|
4336
|
-
type RootResourceNode = Components.Schemas.RootResourceNode;
|
|
4337
|
-
type S3Reference = Components.Schemas.S3Reference;
|
|
4338
|
-
type SelectedResources = Components.Schemas.SelectedResources;
|
|
4339
|
-
type UploadFilePayload = Components.Schemas.UploadFilePayload;
|
|
4340
|
-
type VerificationSummary = Components.Schemas.VerificationSummary;
|
|
4341
|
-
type VirtualResourceNodeGroup = Components.Schemas.VirtualResourceNodeGroup;
|
|
4342
|
-
|
|
4343
|
-
export { type ResourceNode as $, type AppBlueprint as A, type Blueprint as B, type Client as C, type DeployedBlueprint as D, type FormattedErrorCodes as E, type FieldDiff as F, type FormattedErrorData as G, type JobID as H, type InstalledMarketplaceBlueprintItem as I, type Job as J, type JobStatus as K, type LatestBlueprintVerification as L, type LineageEntry as M, type Manifest as N, type OperationMethods as O, Paths as P, type ManifestID as Q, type ManifestItem as R, type ManifestSource as S, type ManifestTimestampFields as T, type MarketplaceBlueprint as U, type MarketplaceListing as V, type MarketplaceListingUpdate as W, type MarketplaceListingVersion as X, type PlanChanges as Y, type PreInstallRequirements as Z, type PutManifestPayload as _, Components as a, type ResourceNodeType as a0, type ResourceReplacement as a1, type ResourceVerificationResult as a2, type RootResourceNode as a3, type S3Reference as a4, type SelectedResources as a5, type UploadFilePayload as a6, type VerificationSummary as a7, type VirtualResourceNodeGroup as a8, type PathsDictionary as b, type BlueprintDependenciesSyncJob as c, type BlueprintExportJob as d, type BlueprintID as e, type BlueprintInstallStatus as f, type BlueprintInstallationJob as g, type BlueprintInstallationJobOptions as h, type BlueprintJob as i, type BlueprintJobEvent as j, type BlueprintJobID as k, type BlueprintPreview as l, type BlueprintResource as m, type BlueprintResourceID as n, type BlueprintValidateJob as o, type BlueprintVerificationJob as p, type CallerIdentity as q, type CommonBlueprintFields as r, type CommonBlueprintJobFields as s, type CommonImportFields as t, type CommonManifestFields as u, type CommonMarkdownFields as v, type CommonResourceNode as w, type CustomBlueprint as x, type FileBlueprint as y, type FormattedError as z };
|