@epilot/sdk 2.7.1 → 2.7.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/definitions/app.json +101 -8
- package/definitions/configuration-hub-runtime.json +1 -1
- package/definitions/configuration-hub.json +623 -0
- package/definitions/customer-portal.json +72 -58
- package/definitions/design-runtime.json +1 -1
- package/definitions/design.json +52 -12
- package/definitions/file-runtime.json +1 -1
- package/definitions/file.json +88 -4
- package/definitions/journey-runtime.json +1 -1
- package/definitions/journey.json +21 -1
- package/definitions/notes-runtime.json +1 -1
- package/definitions/notes.json +123 -1
- package/definitions/pricing.json +149 -404
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.d.cts +2 -2
- package/dist/apis/app.d.ts +2 -2
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/configuration-hub.cjs +8 -8
- package/dist/apis/configuration-hub.d.cts +2 -2
- package/dist/apis/configuration-hub.d.ts +2 -2
- package/dist/apis/configuration-hub.js +2 -2
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.d.cts +2 -2
- package/dist/apis/customer-portal.d.ts +2 -2
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +8 -8
- package/dist/apis/design.d.cts +2 -2
- package/dist/apis/design.d.ts +2 -2
- package/dist/apis/design.js +2 -2
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +8 -8
- package/dist/apis/file.d.cts +2 -2
- package/dist/apis/file.d.ts +2 -2
- package/dist/apis/file.js +2 -2
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +8 -8
- package/dist/apis/journey.d.cts +2 -2
- package/dist/apis/journey.d.ts +2 -2
- package/dist/apis/journey.js +2 -2
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +8 -8
- package/dist/apis/notes.d.cts +2 -2
- package/dist/apis/notes.d.ts +2 -2
- package/dist/apis/notes.js +2 -2
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.d.cts +2 -2
- package/dist/apis/pricing.d.ts +2 -2
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/{app-SSF545U7.cjs → app-74LECFMK.cjs} +1 -1
- package/dist/{app-34OBBTA4.js → app-GNUHCGPO.js} +1 -1
- package/dist/{app.d--5n0FQQ4.d.cts → app.d-BOR23dso.d.cts} +104 -4
- package/dist/{app.d--5n0FQQ4.d.ts → app.d-BOR23dso.d.ts} +104 -4
- package/dist/bin/cli.js +1 -1
- package/dist/{chunk-SCMAZ73K.js → chunk-2FJMQLXE.js} +28 -19
- package/dist/chunk-4M5V6BIT.cjs +14 -0
- package/dist/chunk-JOUTFBLN.js +14 -0
- package/dist/chunk-LAWKCWVU.cjs +14 -0
- package/dist/{chunk-ZSONBZIF.cjs → chunk-MOLFG5L4.cjs} +1 -1
- package/dist/chunk-P4NA7NWG.js +14 -0
- package/dist/{chunk-R7XDTILZ.cjs → chunk-QNMDISUR.cjs} +28 -19
- package/dist/chunk-RDVFQOCQ.js +14 -0
- package/dist/chunk-WHXYES2D.cjs +14 -0
- package/dist/{chunk-RW5JOHG7.js → chunk-WIQXF7DD.js} +1 -1
- package/dist/{chunk-ONOGGR6Q.js → chunk-WW6DVKJR.js} +1 -1
- package/dist/{chunk-M2SSGV7K.cjs → chunk-ZOQUGWQL.cjs} +1 -1
- package/dist/configuration-hub-E7S4JB2T.js +7 -0
- package/dist/configuration-hub-Q5JBYB52.cjs +7 -0
- package/dist/{configuration-hub-runtime-L6IOERSP.js → configuration-hub-runtime-CXME7TCX.js} +1 -1
- package/dist/{configuration-hub-runtime-I5Y67CXD.cjs → configuration-hub-runtime-QVLJKEZD.cjs} +2 -2
- package/dist/configuration-hub.d-CbSJDa7k.d.cts +1096 -0
- package/dist/configuration-hub.d-CbSJDa7k.d.ts +1096 -0
- package/dist/customer-portal-IBM3K2EZ.cjs +7 -0
- package/dist/customer-portal-XPYKMIIA.js +7 -0
- package/dist/{customer-portal.d-C7ZCbjiY.d.cts → customer-portal.d-CTTCBAZI.d.cts} +217 -61
- package/dist/{customer-portal.d-C7ZCbjiY.d.ts → customer-portal.d-CTTCBAZI.d.ts} +217 -61
- package/dist/design-DUFBH5ZB.js +7 -0
- package/dist/design-W3D3UPGB.cjs +7 -0
- package/dist/design-runtime-3RHYNHUV.cjs +5 -0
- package/dist/{design-runtime-QMJM4FAF.js → design-runtime-DLMA4EHQ.js} +1 -1
- package/dist/{design.d-BRre8iLg.d.cts → design.d-DzSDu8cy.d.cts} +41 -3
- package/dist/{design.d-BRre8iLg.d.ts → design.d-DzSDu8cy.d.ts} +41 -3
- package/dist/file-BGJVE7QG.cjs +7 -0
- package/dist/file-DRLPMLFW.js +7 -0
- package/dist/file-runtime-7AWKNQU6.cjs +5 -0
- package/dist/{file-runtime-BIRMXYRH.js → file-runtime-DKGFS44O.js} +1 -1
- package/dist/{file.d-DTlrbI40.d.cts → file.d-Rq_mbdOo.d.cts} +145 -5
- package/dist/{file.d-DTlrbI40.d.ts → file.d-Rq_mbdOo.d.ts} +145 -5
- package/dist/index.cjs +18 -18
- package/dist/index.d.cts +8 -8
- package/dist/index.d.ts +8 -8
- package/dist/index.js +6 -6
- package/dist/journey-4DIIPRU4.js +7 -0
- package/dist/journey-ATC3Y5AW.cjs +7 -0
- package/dist/{journey-runtime-SPBL3F32.cjs → journey-runtime-G2O5C3N2.cjs} +2 -2
- package/dist/{journey-runtime-YXIAOTMD.js → journey-runtime-RI2LJO5S.js} +1 -1
- package/dist/{journey.d-ClXO0xK8.d.cts → journey.d-BenIUWaO.d.cts} +9 -3
- package/dist/{journey.d-ClXO0xK8.d.ts → journey.d-BenIUWaO.d.ts} +9 -3
- package/dist/{js-yaml-UPZKYVRY.js → js-yaml-DLCVPJ7G.js} +17 -15
- package/dist/notes-6JESMRLW.js +7 -0
- package/dist/notes-SLEUSNP4.cjs +7 -0
- package/dist/{notes-runtime-CVNAVKPP.js → notes-runtime-I4SWR3PZ.js} +1 -1
- package/dist/notes-runtime-YWTRRNH5.cjs +5 -0
- package/dist/{notes.d-BcV_m5fe.d.cts → notes.d-rbcyHfiB.d.cts} +101 -3
- package/dist/{notes.d-BcV_m5fe.d.ts → notes.d-rbcyHfiB.d.ts} +101 -3
- package/dist/pricing-F7HQ6BWC.cjs +7 -0
- package/dist/pricing-YCD4EUGI.js +7 -0
- package/dist/{pricing.d-BHpMU4KU.d.cts → pricing.d-exMaGWm1.d.cts} +140 -280
- package/dist/{pricing.d-BHpMU4KU.d.ts → pricing.d-exMaGWm1.d.ts} +140 -280
- package/docs/app.md +34 -10
- package/docs/configuration-hub.md +660 -0
- package/docs/customer-portal.md +221 -159
- package/docs/design.md +81 -4
- package/docs/file.md +81 -0
- package/docs/journey.md +2 -0
- package/docs/notes.md +47 -1
- package/docs/pricing.md +269 -218
- package/package.json +1 -1
- package/dist/chunk-3APTSPY4.js +0 -14
- package/dist/chunk-EIIIKDOJ.cjs +0 -14
- package/dist/chunk-KIWRGUKM.js +0 -14
- package/dist/chunk-MB6NKETA.cjs +0 -14
- package/dist/chunk-OPXGJKZR.cjs +0 -14
- package/dist/chunk-VSZEOCIE.js +0 -14
- package/dist/configuration-hub-A3S6ND6R.cjs +0 -7
- package/dist/configuration-hub-PMAW44U5.js +0 -7
- package/dist/configuration-hub.d-Cqaq2F-W.d.cts +0 -478
- package/dist/configuration-hub.d-Cqaq2F-W.d.ts +0 -478
- package/dist/customer-portal-7HYSBH7H.cjs +0 -7
- package/dist/customer-portal-X4LJX6AU.js +0 -7
- package/dist/design-DROLIWS3.js +0 -7
- package/dist/design-XZKOZLTR.cjs +0 -7
- package/dist/design-runtime-OXEXKZVG.cjs +0 -5
- package/dist/file-P2FUUER2.js +0 -7
- package/dist/file-XTY74SIX.cjs +0 -7
- package/dist/file-runtime-24S3QPA7.cjs +0 -5
- package/dist/journey-KDR5EU3W.js +0 -7
- package/dist/journey-REBN4TGQ.cjs +0 -7
- package/dist/notes-K2IIFCX3.cjs +0 -7
- package/dist/notes-Q7JGS7O3.js +0 -7
- package/dist/notes-runtime-E3YYF74V.cjs +0 -5
- package/dist/pricing-FODHQFCB.cjs +0 -7
- package/dist/pricing-XRIDVZFC.js +0 -7
|
@@ -3384,6 +3384,14 @@ declare namespace Components {
|
|
|
3384
3384
|
* Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level.
|
|
3385
3385
|
*/
|
|
3386
3386
|
dataPath?: string;
|
|
3387
|
+
/**
|
|
3388
|
+
* Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
|
|
3389
|
+
* If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
|
|
3390
|
+
*
|
|
3391
|
+
* example:
|
|
3392
|
+
* error.message
|
|
3393
|
+
*/
|
|
3394
|
+
errorMessagePath?: string;
|
|
3387
3395
|
};
|
|
3388
3396
|
/**
|
|
3389
3397
|
* Deprecated. Prefer `secure_proxy` instead.
|
|
@@ -3513,6 +3521,14 @@ declare namespace Components {
|
|
|
3513
3521
|
* Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level.
|
|
3514
3522
|
*/
|
|
3515
3523
|
dataPath?: string;
|
|
3524
|
+
/**
|
|
3525
|
+
* Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
|
|
3526
|
+
* If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
|
|
3527
|
+
*
|
|
3528
|
+
* example:
|
|
3529
|
+
* error.message
|
|
3530
|
+
*/
|
|
3531
|
+
errorMessagePath?: string;
|
|
3516
3532
|
};
|
|
3517
3533
|
/**
|
|
3518
3534
|
* Deprecated. Prefer `secure_proxy` instead.
|
|
@@ -3566,6 +3582,16 @@ declare namespace Components {
|
|
|
3566
3582
|
[name: string]: string;
|
|
3567
3583
|
};
|
|
3568
3584
|
};
|
|
3585
|
+
resolved?: {
|
|
3586
|
+
/**
|
|
3587
|
+
* Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
|
|
3588
|
+
* If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
|
|
3589
|
+
*
|
|
3590
|
+
* example:
|
|
3591
|
+
* error.message
|
|
3592
|
+
*/
|
|
3593
|
+
errorMessagePath?: string;
|
|
3594
|
+
};
|
|
3569
3595
|
/**
|
|
3570
3596
|
* Deprecated. Prefer `secure_proxy` instead.
|
|
3571
3597
|
* If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
|
|
@@ -3659,6 +3685,14 @@ declare namespace Components {
|
|
|
3659
3685
|
* {{CallResponse.data.lower_limit}}
|
|
3660
3686
|
*/
|
|
3661
3687
|
lower_limit?: string;
|
|
3688
|
+
/**
|
|
3689
|
+
* Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
|
|
3690
|
+
* If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
|
|
3691
|
+
*
|
|
3692
|
+
* example:
|
|
3693
|
+
* error.message
|
|
3694
|
+
*/
|
|
3695
|
+
errorMessagePath?: string;
|
|
3662
3696
|
};
|
|
3663
3697
|
/**
|
|
3664
3698
|
* Deprecated. Prefer `secure_proxy` instead.
|
|
@@ -3709,6 +3743,14 @@ declare namespace Components {
|
|
|
3709
3743
|
* Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level.
|
|
3710
3744
|
*/
|
|
3711
3745
|
dataPath?: string;
|
|
3746
|
+
/**
|
|
3747
|
+
* Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
|
|
3748
|
+
* If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
|
|
3749
|
+
*
|
|
3750
|
+
* example:
|
|
3751
|
+
* error.message
|
|
3752
|
+
*/
|
|
3753
|
+
errorMessagePath?: string;
|
|
3712
3754
|
};
|
|
3713
3755
|
/**
|
|
3714
3756
|
* Deprecated. Prefer `secure_proxy` instead.
|
|
@@ -3821,6 +3863,14 @@ declare namespace Components {
|
|
|
3821
3863
|
* Optional path to the metadata object in the response. If omitted, the metadata is assumed to be on the top level.
|
|
3822
3864
|
*/
|
|
3823
3865
|
dataPath?: string;
|
|
3866
|
+
/**
|
|
3867
|
+
* Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
|
|
3868
|
+
* If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
|
|
3869
|
+
*
|
|
3870
|
+
* example:
|
|
3871
|
+
* error.message
|
|
3872
|
+
*/
|
|
3873
|
+
errorMessagePath?: string;
|
|
3824
3874
|
};
|
|
3825
3875
|
/**
|
|
3826
3876
|
* Deprecated. Prefer `secure_proxy` instead.
|
|
@@ -4561,8 +4611,9 @@ declare namespace Components {
|
|
|
4561
4611
|
schema?: string;
|
|
4562
4612
|
}
|
|
4563
4613
|
/**
|
|
4564
|
-
* Mobile OIDC configuration.
|
|
4565
|
-
*
|
|
4614
|
+
* Mobile OIDC configuration. Values are resolved at SSO invocation time, so the
|
|
4615
|
+
* fields below may reference org env vars via mustache-like templates, e.g.
|
|
4616
|
+
* `{{ env.MOBILE_CLIENT_SECRET }}`.
|
|
4566
4617
|
*
|
|
4567
4618
|
*/
|
|
4568
4619
|
export interface MoblieOIDCConfig {
|
|
@@ -4582,8 +4633,12 @@ declare namespace Components {
|
|
|
4582
4633
|
client_secret?: string;
|
|
4583
4634
|
}
|
|
4584
4635
|
/**
|
|
4585
|
-
* OIDC provider configuration.
|
|
4586
|
-
* (
|
|
4636
|
+
* OIDC provider configuration. Values are resolved at SSO invocation time
|
|
4637
|
+
* (login / callback), so the fields below may reference org env vars via
|
|
4638
|
+
* mustache-like templates, e.g. `{{ env.MY_PROVIDER_CLIENT_SECRET }}`.
|
|
4639
|
+
*
|
|
4640
|
+
* Fields used to render the SSO buttons up-front (`ProviderConfig.slug`,
|
|
4641
|
+
* `ProviderConfig.display_name`) are NOT interpolated and must be literal.
|
|
4587
4642
|
*
|
|
4588
4643
|
*/
|
|
4589
4644
|
export interface OIDCProviderConfig {
|
|
@@ -4631,6 +4686,10 @@ declare namespace Components {
|
|
|
4631
4686
|
prompt?: "login" | "select_account" | "consent";
|
|
4632
4687
|
}
|
|
4633
4688
|
export interface OIDCProviderMetadata {
|
|
4689
|
+
/**
|
|
4690
|
+
* Response modes the provider accepts (e.g. `form_post` for Apple)
|
|
4691
|
+
*/
|
|
4692
|
+
response_modes_supported?: ("form_post" | "fragment" | "query")[];
|
|
4634
4693
|
/**
|
|
4635
4694
|
* URL of the authorization endpoint
|
|
4636
4695
|
* example:
|
|
@@ -4686,47 +4745,6 @@ declare namespace Components {
|
|
|
4686
4745
|
*/
|
|
4687
4746
|
test_auth_password?: string;
|
|
4688
4747
|
}
|
|
4689
|
-
/**
|
|
4690
|
-
* Public OIDC provider configuration. Same as OIDCProviderConfig but never includes
|
|
4691
|
-
* the `client_secret` field — it is kept server-side and only used to exchange the
|
|
4692
|
-
* authorization code at the SSO callback. String fields are returned with env var
|
|
4693
|
-
* placeholders already resolved when fetched via `GET /v2/portal/public/sso/providers/{provider_slug}`.
|
|
4694
|
-
*
|
|
4695
|
-
*/
|
|
4696
|
-
export interface OIDCProviderPublicConfig {
|
|
4697
|
-
type?: "authorization_code" | "implicit";
|
|
4698
|
-
/**
|
|
4699
|
-
* Issuing Authority URL
|
|
4700
|
-
* example:
|
|
4701
|
-
* https://login.microsoftonline.com/33d4f3e5-3df2-421e-b92e-a63cfa680a88/v2.0
|
|
4702
|
-
*/
|
|
4703
|
-
oidc_issuer: string;
|
|
4704
|
-
/**
|
|
4705
|
-
* Redirect URI for the OIDC flow
|
|
4706
|
-
* example:
|
|
4707
|
-
* https://customer-portal.com/login
|
|
4708
|
-
*/
|
|
4709
|
-
redirect_uri?: string;
|
|
4710
|
-
/**
|
|
4711
|
-
* example:
|
|
4712
|
-
* ab81daf8-8b1f-42d6-94ca-c51621054c75
|
|
4713
|
-
*/
|
|
4714
|
-
client_id: string;
|
|
4715
|
-
/**
|
|
4716
|
-
* Whether the client secret is present (the value itself is kept server-side)
|
|
4717
|
-
* example:
|
|
4718
|
-
* true
|
|
4719
|
-
*/
|
|
4720
|
-
has_client_secret?: boolean;
|
|
4721
|
-
/**
|
|
4722
|
-
* Space-separated list of OAuth 2.0 scopes to request from OpenID Connect
|
|
4723
|
-
* example:
|
|
4724
|
-
* openid email
|
|
4725
|
-
*/
|
|
4726
|
-
scope: string;
|
|
4727
|
-
metadata?: OIDCProviderMetadata;
|
|
4728
|
-
prompt?: "login" | "select_account" | "consent";
|
|
4729
|
-
}
|
|
4730
4748
|
/**
|
|
4731
4749
|
* The opportunity entity
|
|
4732
4750
|
*/
|
|
@@ -5797,6 +5815,18 @@ declare namespace Components {
|
|
|
5797
5815
|
*/
|
|
5798
5816
|
onPendingUser?: AdminUser[];
|
|
5799
5817
|
};
|
|
5818
|
+
/**
|
|
5819
|
+
* SSO identity providers for the portal. When sent on a portal save (PUT/POST),
|
|
5820
|
+
* the list is fully synced — incoming providers are upserted and any existing
|
|
5821
|
+
* providers not in the list are deleted. Omit the field to leave SSO
|
|
5822
|
+
* configuration unchanged; send an empty array to remove all providers.
|
|
5823
|
+
*
|
|
5824
|
+
* Each provider is persisted verbatim — `oidc_config.client_secret` is stored
|
|
5825
|
+
* as sent. Customers are encouraged to reference an org env secret via
|
|
5826
|
+
* `{{ env.VAR }}` rather than embed raw values.
|
|
5827
|
+
*
|
|
5828
|
+
*/
|
|
5829
|
+
identity_providers?: ProviderPublicConfig[];
|
|
5800
5830
|
/**
|
|
5801
5831
|
* Enable/Disable the portal access
|
|
5802
5832
|
*/
|
|
@@ -6270,7 +6300,6 @@ declare namespace Components {
|
|
|
6270
6300
|
* Permissions granted to a portal user while accessing entities
|
|
6271
6301
|
*/
|
|
6272
6302
|
grants?: Grant[];
|
|
6273
|
-
identity_providers?: ProviderPublicConfig[];
|
|
6274
6303
|
pages?: Page[];
|
|
6275
6304
|
}
|
|
6276
6305
|
/**
|
|
@@ -6474,14 +6503,19 @@ declare namespace Components {
|
|
|
6474
6503
|
attribute_mappings?: /* Dictionary of epilot user attributes to claims */ AttributeMappingConfig;
|
|
6475
6504
|
entity_matching?: /* Configuration for matching existing entities during SSO login using token claims */ EntityMatchingConfig;
|
|
6476
6505
|
oidc_config?: /**
|
|
6477
|
-
* OIDC provider configuration.
|
|
6478
|
-
* (
|
|
6506
|
+
* OIDC provider configuration. Values are resolved at SSO invocation time
|
|
6507
|
+
* (login / callback), so the fields below may reference org env vars via
|
|
6508
|
+
* mustache-like templates, e.g. `{{ env.MY_PROVIDER_CLIENT_SECRET }}`.
|
|
6509
|
+
*
|
|
6510
|
+
* Fields used to render the SSO buttons up-front (`ProviderConfig.slug`,
|
|
6511
|
+
* `ProviderConfig.display_name`) are NOT interpolated and must be literal.
|
|
6479
6512
|
*
|
|
6480
6513
|
*/
|
|
6481
6514
|
OIDCProviderConfig;
|
|
6482
6515
|
mobile_oidc_config?: /**
|
|
6483
|
-
* Mobile OIDC configuration.
|
|
6484
|
-
*
|
|
6516
|
+
* Mobile OIDC configuration. Values are resolved at SSO invocation time, so the
|
|
6517
|
+
* fields below may reference org env vars via mustache-like templates, e.g.
|
|
6518
|
+
* `{{ env.MOBILE_CLIENT_SECRET }}`.
|
|
6485
6519
|
*
|
|
6486
6520
|
*/
|
|
6487
6521
|
MoblieOIDCConfig;
|
|
@@ -6506,16 +6540,19 @@ declare namespace Components {
|
|
|
6506
6540
|
*/
|
|
6507
6541
|
ProviderDisplayName;
|
|
6508
6542
|
oidc_config?: /**
|
|
6509
|
-
*
|
|
6510
|
-
*
|
|
6511
|
-
*
|
|
6512
|
-
*
|
|
6543
|
+
* OIDC provider configuration. Values are resolved at SSO invocation time
|
|
6544
|
+
* (login / callback), so the fields below may reference org env vars via
|
|
6545
|
+
* mustache-like templates, e.g. `{{ env.MY_PROVIDER_CLIENT_SECRET }}`.
|
|
6546
|
+
*
|
|
6547
|
+
* Fields used to render the SSO buttons up-front (`ProviderConfig.slug`,
|
|
6548
|
+
* `ProviderConfig.display_name`) are NOT interpolated and must be literal.
|
|
6513
6549
|
*
|
|
6514
6550
|
*/
|
|
6515
|
-
|
|
6551
|
+
OIDCProviderConfig;
|
|
6516
6552
|
mobile_oidc_config?: /**
|
|
6517
|
-
* Mobile OIDC configuration.
|
|
6518
|
-
*
|
|
6553
|
+
* Mobile OIDC configuration. Values are resolved at SSO invocation time, so the
|
|
6554
|
+
* fields below may reference org env vars via mustache-like templates, e.g.
|
|
6555
|
+
* `{{ env.MOBILE_CLIENT_SECRET }}`.
|
|
6519
6556
|
*
|
|
6520
6557
|
*/
|
|
6521
6558
|
MoblieOIDCConfig;
|
|
@@ -7052,6 +7089,32 @@ declare namespace Components {
|
|
|
7052
7089
|
*/
|
|
7053
7090
|
onPendingUser?: AdminUser[];
|
|
7054
7091
|
};
|
|
7092
|
+
/**
|
|
7093
|
+
* SSO identity providers for the portal. When sent on a portal save (PUT/POST),
|
|
7094
|
+
* the list is fully synced — incoming providers are upserted and any existing
|
|
7095
|
+
* providers not in the list are deleted. Omit the field to leave SSO
|
|
7096
|
+
* configuration unchanged; send an empty array to remove all providers.
|
|
7097
|
+
*
|
|
7098
|
+
* Each provider is persisted verbatim — `oidc_config.client_secret` is stored
|
|
7099
|
+
* as sent. Customers are encouraged to reference an org env secret via
|
|
7100
|
+
* `{{ env.VAR }}` rather than embed raw values.
|
|
7101
|
+
*
|
|
7102
|
+
*/
|
|
7103
|
+
identity_providers?: /**
|
|
7104
|
+
* SSO identity provider configuration.
|
|
7105
|
+
*
|
|
7106
|
+
* Env var interpolation: only string fields under `oidc_config` and
|
|
7107
|
+
* `mobile_oidc_config` (incl. their nested `metadata`) are passed through
|
|
7108
|
+
* Liquid templating, so they may contain `{{ env.VAR }}` placeholders that
|
|
7109
|
+
* get resolved at runtime against the organization's environment.
|
|
7110
|
+
*
|
|
7111
|
+
* The following fields are used as literal values and MUST NOT contain
|
|
7112
|
+
* template syntax: `slug`, `display_name`, `provider_type`, all keys and
|
|
7113
|
+
* values under `attribute_mappings` (used as JSONPath-like accessors into
|
|
7114
|
+
* token claims), and all keys and values under `entity_matching`.
|
|
7115
|
+
*
|
|
7116
|
+
*/
|
|
7117
|
+
ProviderConfig[];
|
|
7055
7118
|
}
|
|
7056
7119
|
export interface UpsertPortalConfig {
|
|
7057
7120
|
/**
|
|
@@ -7094,6 +7157,32 @@ declare namespace Components {
|
|
|
7094
7157
|
*/
|
|
7095
7158
|
onPendingUser?: AdminUser[];
|
|
7096
7159
|
};
|
|
7160
|
+
/**
|
|
7161
|
+
* SSO identity providers for the portal. When sent on a portal save (PUT/POST),
|
|
7162
|
+
* the list is fully synced — incoming providers are upserted and any existing
|
|
7163
|
+
* providers not in the list are deleted. Omit the field to leave SSO
|
|
7164
|
+
* configuration unchanged; send an empty array to remove all providers.
|
|
7165
|
+
*
|
|
7166
|
+
* Each provider is persisted verbatim — `oidc_config.client_secret` is stored
|
|
7167
|
+
* as sent. Customers are encouraged to reference an org env secret via
|
|
7168
|
+
* `{{ env.VAR }}` rather than embed raw values.
|
|
7169
|
+
*
|
|
7170
|
+
*/
|
|
7171
|
+
identity_providers?: /**
|
|
7172
|
+
* SSO identity provider configuration.
|
|
7173
|
+
*
|
|
7174
|
+
* Env var interpolation: only string fields under `oidc_config` and
|
|
7175
|
+
* `mobile_oidc_config` (incl. their nested `metadata`) are passed through
|
|
7176
|
+
* Liquid templating, so they may contain `{{ env.VAR }}` placeholders that
|
|
7177
|
+
* get resolved at runtime against the organization's environment.
|
|
7178
|
+
*
|
|
7179
|
+
* The following fields are used as literal values and MUST NOT contain
|
|
7180
|
+
* template syntax: `slug`, `display_name`, `provider_type`, all keys and
|
|
7181
|
+
* values under `attribute_mappings` (used as JSONPath-like accessors into
|
|
7182
|
+
* token claims), and all keys and values under `entity_matching`.
|
|
7183
|
+
*
|
|
7184
|
+
*/
|
|
7185
|
+
ProviderConfig[];
|
|
7097
7186
|
/**
|
|
7098
7187
|
* Enable/Disable the portal access
|
|
7099
7188
|
*/
|
|
@@ -7573,6 +7662,32 @@ declare namespace Components {
|
|
|
7573
7662
|
*/
|
|
7574
7663
|
onPendingUser?: AdminUser[];
|
|
7575
7664
|
};
|
|
7665
|
+
/**
|
|
7666
|
+
* SSO identity providers for the portal. When sent on a portal save (PUT/POST),
|
|
7667
|
+
* the list is fully synced — incoming providers are upserted and any existing
|
|
7668
|
+
* providers not in the list are deleted. Omit the field to leave SSO
|
|
7669
|
+
* configuration unchanged; send an empty array to remove all providers.
|
|
7670
|
+
*
|
|
7671
|
+
* Each provider is persisted verbatim — `oidc_config.client_secret` is stored
|
|
7672
|
+
* as sent. Customers are encouraged to reference an org env secret via
|
|
7673
|
+
* `{{ env.VAR }}` rather than embed raw values.
|
|
7674
|
+
*
|
|
7675
|
+
*/
|
|
7676
|
+
identity_providers?: /**
|
|
7677
|
+
* SSO identity provider configuration.
|
|
7678
|
+
*
|
|
7679
|
+
* Env var interpolation: only string fields under `oidc_config` and
|
|
7680
|
+
* `mobile_oidc_config` (incl. their nested `metadata`) are passed through
|
|
7681
|
+
* Liquid templating, so they may contain `{{ env.VAR }}` placeholders that
|
|
7682
|
+
* get resolved at runtime against the organization's environment.
|
|
7683
|
+
*
|
|
7684
|
+
* The following fields are used as literal values and MUST NOT contain
|
|
7685
|
+
* template syntax: `slug`, `display_name`, `provider_type`, all keys and
|
|
7686
|
+
* values under `attribute_mappings` (used as JSONPath-like accessors into
|
|
7687
|
+
* token claims), and all keys and values under `entity_matching`.
|
|
7688
|
+
*
|
|
7689
|
+
*/
|
|
7690
|
+
ProviderConfig[];
|
|
7576
7691
|
/**
|
|
7577
7692
|
* Enable/Disable the portal access
|
|
7578
7693
|
*/
|
|
@@ -10908,7 +11023,28 @@ declare namespace Paths {
|
|
|
10908
11023
|
* Permissions granted to a portal user while accessing entities
|
|
10909
11024
|
*/
|
|
10910
11025
|
grants?: Components.Schemas.Grant[];
|
|
10911
|
-
|
|
11026
|
+
/**
|
|
11027
|
+
* SSO identity providers configured for the portal. Includes raw
|
|
11028
|
+
* `oidc_config.client_secret` values so the admin UI can round-trip
|
|
11029
|
+
* them. Customers are encouraged to reference secrets via env
|
|
11030
|
+
* templates (`{{ env.VAR }}`) rather than embed raw values.
|
|
11031
|
+
*
|
|
11032
|
+
*/
|
|
11033
|
+
identity_providers?: /**
|
|
11034
|
+
* SSO identity provider configuration.
|
|
11035
|
+
*
|
|
11036
|
+
* Env var interpolation: only string fields under `oidc_config` and
|
|
11037
|
+
* `mobile_oidc_config` (incl. their nested `metadata`) are passed through
|
|
11038
|
+
* Liquid templating, so they may contain `{{ env.VAR }}` placeholders that
|
|
11039
|
+
* get resolved at runtime against the organization's environment.
|
|
11040
|
+
*
|
|
11041
|
+
* The following fields are used as literal values and MUST NOT contain
|
|
11042
|
+
* template syntax: `slug`, `display_name`, `provider_type`, all keys and
|
|
11043
|
+
* values under `attribute_mappings` (used as JSONPath-like accessors into
|
|
11044
|
+
* token claims), and all keys and values under `entity_matching`.
|
|
11045
|
+
*
|
|
11046
|
+
*/
|
|
11047
|
+
Components.Schemas.ProviderConfig[];
|
|
10912
11048
|
certificate_details?: {
|
|
10913
11049
|
/**
|
|
10914
11050
|
* Status of the certificate
|
|
@@ -11423,7 +11559,28 @@ declare namespace Paths {
|
|
|
11423
11559
|
* Permissions granted to a portal user while accessing entities
|
|
11424
11560
|
*/
|
|
11425
11561
|
grants?: Components.Schemas.Grant[];
|
|
11426
|
-
|
|
11562
|
+
/**
|
|
11563
|
+
* SSO identity providers configured for the portal. Includes raw
|
|
11564
|
+
* `oidc_config.client_secret` values so the admin UI can round-trip
|
|
11565
|
+
* them. Customers are encouraged to reference secrets via env
|
|
11566
|
+
* templates (`{{ env.VAR }}`) rather than embed raw values.
|
|
11567
|
+
*
|
|
11568
|
+
*/
|
|
11569
|
+
identity_providers?: /**
|
|
11570
|
+
* SSO identity provider configuration.
|
|
11571
|
+
*
|
|
11572
|
+
* Env var interpolation: only string fields under `oidc_config` and
|
|
11573
|
+
* `mobile_oidc_config` (incl. their nested `metadata`) are passed through
|
|
11574
|
+
* Liquid templating, so they may contain `{{ env.VAR }}` placeholders that
|
|
11575
|
+
* get resolved at runtime against the organization's environment.
|
|
11576
|
+
*
|
|
11577
|
+
* The following fields are used as literal values and MUST NOT contain
|
|
11578
|
+
* template syntax: `slug`, `display_name`, `provider_type`, all keys and
|
|
11579
|
+
* values under `attribute_mappings` (used as JSONPath-like accessors into
|
|
11580
|
+
* token claims), and all keys and values under `entity_matching`.
|
|
11581
|
+
*
|
|
11582
|
+
*/
|
|
11583
|
+
Components.Schemas.ProviderConfig[];
|
|
11427
11584
|
certificate_details?: {
|
|
11428
11585
|
/**
|
|
11429
11586
|
* Status of the certificate
|
|
@@ -17644,7 +17801,6 @@ type MeterReadingWidget = Components.Schemas.MeterReadingWidget;
|
|
|
17644
17801
|
type MoblieOIDCConfig = Components.Schemas.MoblieOIDCConfig;
|
|
17645
17802
|
type OIDCProviderConfig = Components.Schemas.OIDCProviderConfig;
|
|
17646
17803
|
type OIDCProviderMetadata = Components.Schemas.OIDCProviderMetadata;
|
|
17647
|
-
type OIDCProviderPublicConfig = Components.Schemas.OIDCProviderPublicConfig;
|
|
17648
17804
|
type Opportunity = Components.Schemas.Opportunity;
|
|
17649
17805
|
type Order = Components.Schemas.Order;
|
|
17650
17806
|
type OrganizationSettings = Components.Schemas.OrganizationSettings;
|
|
@@ -17704,4 +17860,4 @@ type WorfklowIdentifier = Components.Schemas.WorfklowIdentifier;
|
|
|
17704
17860
|
type WorkflowExecution = Components.Schemas.WorkflowExecution;
|
|
17705
17861
|
type WorkflowStep = Components.Schemas.WorkflowStep;
|
|
17706
17862
|
|
|
17707
|
-
export { type EntityMatchingConfig as $, type AcceptanceDecision as A, type Balance as B, type Client as C, type Contact as D, type ContactCountRequest as E, type ContactExistsRequest as F, type ContentWidget as G, type ContextEntities as H, type ContextEntity as I, type Contract as J, type ContractIdentifier as K, type CreateUserRequest as L, type Currency as M, type DataRetrievalItem as N, type OperationMethods as O, Paths as P, DeleteEntityFile as Q, type Direction as R, type DocumentWidget as S, type DomainSettings as T, type EmailTemplates as U, type Entity as V, type EntityEditRule as W, type EntityFileCount as X, type EntityGetParams as Y, type EntityId as Z, type EntityItem as _, Components as a, type
|
|
17863
|
+
export { type EntityMatchingConfig as $, type AcceptanceDecision as A, type Balance as B, type Client as C, type Contact as D, type ContactCountRequest as E, type ContactExistsRequest as F, type ContentWidget as G, type ContextEntities as H, type ContextEntity as I, type Contract as J, type ContractIdentifier as K, type CreateUserRequest as L, type Currency as M, type DataRetrievalItem as N, type OperationMethods as O, Paths as P, DeleteEntityFile as Q, type Direction as R, type DocumentWidget as S, type DomainSettings as T, type EmailTemplates as U, type Entity as V, type EntityEditRule as W, type EntityFileCount as X, type EntityGetParams as Y, type EntityId as Z, type EntityItem as _, Components as a, type PublicContractIdentificationDetails as a$, type EntityResponse as a0, type EntityResponseGroupedWithHits as a1, type EntityResponseWithHits as a2, type EntitySearchParams as a3, type EntitySlug as a4, type EntitySlugConfig as a5, type EntityTemplates as a6, type EntityWidget as a7, type ErrorResp as a8, type Exists as a9, type MeterReading as aA, type MeterReadingPhoto as aB, type MeterReadingPhotoData as aC, type MeterReadingWidget as aD, type MoblieOIDCConfig as aE, type OIDCProviderConfig as aF, type OIDCProviderMetadata as aG, type Opportunity as aH, type Order as aI, type OrganizationSettings as aJ, type Origin as aK, type Page as aL, type PageRequest as aM, type PaymentWidget as aN, type PortalConfig as aO, type PortalConfigV3 as aP, type PortalId as aQ, type PortalUser as aR, type PortalUserRegistrationStatus as aS, type PortalWidget as aT, type Product as aU, type ProductRecommendationsWidget as aV, type ProviderConfig as aW, type ProviderDisplayName as aX, type ProviderPublicConfig as aY, type ProviderSlug as aZ, type PublicAppDetails as a_, type Extension as aa, type ExtensionAuthBlock as ab, type ExtensionConfig as ac, type ExtensionHook as ad, type ExtensionHookConsumptionDataRetrieval as ae, type ExtensionHookContractIdentification as af, type ExtensionHookCostDataRetrieval as ag, type ExtensionHookDataExport as ah, type ExtensionHookMeterReadingPlausibilityCheck as ai, type ExtensionHookPriceDataRetrieval as aj, type ExtensionHookRegistrationIdentifiersCheck as ak, type ExtensionHookSelection as al, type ExtensionHookVisualizationMetadata as am, type ExtensionSeamlessLink as an, type ExternalLink as ao, type ExtraSchemaAttributes as ap, type FailedRuleErrorResp as aq, type File as ar, type FileItem as as, type Grant as at, type IdentifierAttribute as au, type InstallmentEvent as av, type JourneyActions as aw, type JuiceSettings as ax, type Meter as ay, type MeterChartWidget as az, type PathsDictionary as b, type PublicDataRetrievalHookDetails as b0, type PublicExtensionCapabilities as b1, type PublicExtensionDetails as b2, type PublicMeterReadingPlausibilityCheckDetails as b3, type ReadBy as b4, type ReadingStatus as b5, type Reason as b6, type RegistrationIdentifier as b7, type ReimbursementEvent as b8, type Rule as b9, type WorkflowStep as bA, type SAMLProviderConfig as ba, type SSOCallbackRequest as bb, type SSOCallbackResponse as bc, type SSOLoginToken as bd, SaveEntityFile as be, type SavePortalFile as bf, type Schema as bg, type SearchIncludes as bh, type SecureProxyConfig as bi, type Source as bj, type SwappableConfig as bk, type TariffType as bl, type TeaserWidget as bm, type TriggerPortalFlow as bn, type UpdateOnlyPortalConfigAttributes as bo, type UpsertPortalConfig as bp, type UpsertPortalConfigV3 as bq, UpsertPortalWidget as br, type UserRequest as bs, type VisualizationDataRange as bt, type VisualizationMetadata as bu, type VisualizationTypeOption as bv, type WidgetAction as bw, type WidgetBase as bx, type WorfklowIdentifier as by, type WorkflowExecution as bz, type AccountExistsRequest as c, type ActionLabel as d, type ActionWidget as e, type Activity as f, type ActivityCallerContext as g, type ActivityId as h, type ActivityItem as i, type AdminUser as j, type AllowedFileExtensions as k, type AttributeMappingConfig as l, type AuthConfig as m, type BaseBillingEvent as n, type BaseEntity as o, type BillingAccount as p, type BillingEvent as q, type Block as r, type BlockId as s, type BlockProps as t, type BlockRequest as u, type BlockType as v, type BusinessPartnerItem as w, type CampaignWidget as x, type CommonConfigAttributes as y, type CommonConfigAttributesV3 as z };
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import "./chunk-YPSWSI3M.js";
|
|
2
|
+
|
|
3
|
+
// src/docs/design.json
|
|
4
|
+
var design_default = '# Design Builder API v2\n\n- **Base URL:** `https://design-builder-api.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/design](https://docs.epilot.io/api/design)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.design.getAllDesigns(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/design\'\n\nconst designClient = getClient()\nauthorize(designClient, () => \'<token>\')\nconst { data } = await designClient.getAllDesigns(...)\n```\n\n## Operations\n\n**design-builder**\n- [`getAllDesigns`](#getalldesigns)\n- [`addDesign`](#adddesign)\n- [`getDesign`](#getdesign)\n- [`deleteDesign`](#deletedesign)\n- [`updateDesign`](#updatedesign)\n- [`getThemeFromDesign`](#getthemefromdesign)\n- [`uploadFile`](#uploadfile)\n- [`getFiles`](#getfiles)\n- [`getConsumerDesign`](#getconsumerdesign)\n- [`addConsumer`](#addconsumer)\n- [`removeConsumer`](#removeconsumer)\n\n**Schemas**\n- [`UploadFileReq`](#uploadfilereq)\n- [`UploadFileRes`](#uploadfileres)\n- [`GetFilesRes`](#getfilesres)\n- [`GetAllDesignsRes`](#getalldesignsres)\n- [`GetBrandsRes`](#getbrandsres)\n- [`AddDesignReq`](#adddesignreq)\n- [`AddDesignRes`](#adddesignres)\n- [`GetDesignRes`](#getdesignres)\n- [`UpdateDesignReq`](#updatedesignreq)\n- [`ItemMetada`](#itemmetada)\n- [`AddConsumerReq`](#addconsumerreq)\n- [`RemoveConsumerReq`](#removeconsumerreq)\n- [`DesignItem`](#designitem)\n- [`BrandItem`](#branditem)\n- [`Custom_Style`](#custom_style)\n- [`Journey`](#journey)\n- [`ConsumerData`](#consumerdata)\n- [`WidgetData`](#widgetdata)\n- [`CustomerPortalData`](#customerportaldata)\n- [`LogoData`](#logodata)\n- [`PaletteData`](#palettedata)\n- [`TypographyData`](#typographydata)\n- [`ShapeData`](#shapedata)\n- [`FontData`](#fontdata)\n- [`FontResponseUrl`](#fontresponseurl)\n- [`WidgetPortalData`](#widgetportaldata)\n- [`ErrorResp`](#errorresp)\n- [`FileData`](#filedata)\n- [`DesignId`](#designid)\n- [`Theme`](#theme)\n- [`Application`](#application)\n- [`DesignParameters`](#designparameters)\n- [`ParseThemeFromDesignResp`](#parsethemefromdesignresp)\n\n### `getAllDesigns`\n\nScan all designs linked to a organization, based in orgId attribute from JWT auth token\n\n`GET /v1/designs`\n\n```ts\nconst { data } = await client.getAllDesigns()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "designs": [\n {\n "id": "string",\n "created_at": "2021-01-30T08:30:00Z",\n "created_by": "string",\n "edited": true,\n "last_modified_at": "string",\n "brand_id": "string",\n "brand_name": "string",\n "user": {},\n "style_name": "string",\n "style": {},\n "is_default": true,\n "_manifest": ["string"],\n "custom_theme": "string",\n "use_custom_theme": true,\n "design_tokens": {}\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `addDesign`\n\nCreate a brand new design linked to a organization, based in orgId attribute from JWT auth token\n\n`POST /v1/designs`\n\n```ts\nconst { data } = await client.addDesign(\n null,\n {\n design: {\n brand_id: \'string\',\n brand_name: \'string\',\n user: {\n emailaddress: \'string\',\n fullname: \'string\',\n name: \'string\',\n userid: \'string\'\n },\n style_name: \'string\',\n style: {\n logo: { /* ... */ },\n palette: { /* ... */ },\n typography: { /* ... */ },\n shape: { /* ... */ },\n consumer: { /* ... */ }\n },\n is_default: true,\n _manifest: [\'string\'],\n custom_theme: \'string\',\n use_custom_theme: true,\n design_tokens: {\n coupon: \'string\',\n cashback: \'string\',\n custom_css: \'string\',\n accent_color: \'string\',\n outline_color: \'string\',\n divider_color: \'string\',\n link_color: \'string\',\n link_hover_color: \'string\',\n font_size_scale: \'xs\',\n topbar_height: 0,\n topbar_logo_alignment: \'flex-start\',\n logo_size: 0,\n input_background: \'string\',\n input_border_color: \'string\',\n input_text_color: \'string\',\n input_label_color: \'string\',\n input_border_radius: 0,\n input_height: 0,\n input_variant: \'outlined\',\n button_primary_bg: \'string\',\n button_primary_text: \'string\',\n button_primary_hover_bg: \'string\',\n button_primary_hover_text: \'string\',\n button_outlined_border: \'string\',\n button_outlined_text: \'string\',\n button_outlined_hover_bg: \'string\',\n button_outlined_hover_text: \'string\',\n button_ghost_bg: \'string\',\n button_ghost_text: \'string\',\n button_ghost_hover_bg: \'string\',\n button_ghost_hover_text: \'string\',\n button_border_radius: 0,\n button_height: 0,\n card_background: \'string\',\n card_border_color: \'string\',\n card_variant: \'shadow\',\n summary_card_background: \'string\',\n toggle_selected_bg: \'string\',\n toggle_selected_text: \'string\',\n toggle_hover_bg: \'string\',\n toggle_hover_text: \'string\',\n toggle_border_color: \'string\',\n dropdown_hover_bg: \'string\',\n dropdown_hover_text: \'string\',\n dropdown_selected_bg: \'string\',\n dropdown_selected_text: \'string\',\n switch_unchecked_color: \'string\',\n switch_unchecked_bg: \'string\',\n switch_border_radius: 0,\n checkbox_unchecked_color: \'string\',\n checkbox_label_color: \'string\',\n radio_unchecked_color: \'string\',\n radio_label_color: \'string\',\n datepicker_selected_bg: \'string\',\n datepicker_selected_color: \'string\',\n datepicker_border_radius: 0,\n chip_background: \'string\',\n chip_hover_background: \'string\',\n chip_text_color: \'string\',\n chip_hover_text_color: \'string\'\n }\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "design": {\n "id": "string",\n "created_at": "2021-01-30T08:30:00Z",\n "created_by": "string",\n "edited": true,\n "last_modified_at": "string",\n "brand_id": "string",\n "brand_name": "string",\n "user": {\n "emailaddress": "string",\n "fullname": "string",\n "name": "string",\n "userid": "string"\n },\n "style_name": "string",\n "style": {\n "logo": {},\n "palette": {},\n "typography": {},\n "shape": {},\n "consumer": {}\n },\n "is_default": true,\n "_manifest": ["string"],\n "custom_theme": "string",\n "use_custom_theme": true,\n "design_tokens": {\n "coupon": "string",\n "cashback": "string",\n "custom_css": "string",\n "accent_color": "string",\n "outline_color": "string",\n "divider_color": "string",\n "link_color": "string",\n "link_hover_color": "string",\n "font_size_scale": "xs",\n "topbar_height": 0,\n "topbar_logo_alignment": "flex-start",\n "logo_size": 0,\n "input_background": "string",\n "input_border_color": "string",\n "input_text_color": "string",\n "input_label_color": "string",\n "input_border_radius": 0,\n "input_height": 0,\n "input_variant": "outlined",\n "button_primary_bg": "string",\n "button_primary_text": "string",\n "button_primary_hover_bg": "string",\n "button_primary_hover_text": "string",\n "button_outlined_border": "string",\n "button_outlined_text": "string",\n "button_outlined_hover_bg": "string",\n "button_outlined_hover_text": "string",\n "button_ghost_bg": "string",\n "button_ghost_text": "string",\n "button_ghost_hover_bg": "string",\n "button_ghost_hover_text": "string",\n "button_border_radius": 0,\n "button_height": 0,\n "card_background": "string",\n "card_border_color": "string",\n "card_variant": "shadow",\n "summary_card_background": "string",\n "toggle_selected_bg": "string",\n "toggle_selected_text": "string",\n "toggle_hover_bg": "string",\n "toggle_hover_text": "string",\n "toggle_border_color": "string",\n "dropdown_hover_bg": "string",\n "dropdown_hover_text": "string",\n "dropdown_selected_bg": "string",\n "dropdown_selected_text": "string",\n "switch_unchecked_color": "string",\n "switch_unchecked_bg": "string",\n "switch_border_radius": 0,\n "checkbox_unchecked_color": "string",\n "checkbox_label_color": "string",\n "radio_unchecked_color": "string",\n "radio_label_color": "string",\n "datepicker_selected_bg": "string",\n "datepicker_selected_color": "string",\n "datepicker_border_radius": 0,\n "chip_background": "string",\n "chip_hover_background": "string",\n "chip_text_color": "string",\n "chip_hover_text_color": "string"\n }\n }\n}\n```\n\n</details>\n\n---\n\n### `getDesign`\n\nSearch for a especific design owned by user organization\n\n`GET /v1/designs/{designId}`\n\n```ts\nconst { data } = await client.getDesign({\n designId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "design": {\n "id": "string",\n "created_at": "2021-01-30T08:30:00Z",\n "created_by": "string",\n "edited": true,\n "last_modified_at": "string",\n "brand_id": "string",\n "brand_name": "string",\n "user": {\n "emailaddress": "string",\n "fullname": "string",\n "name": "string",\n "userid": "string"\n },\n "style_name": "string",\n "style": {\n "logo": {},\n "palette": {},\n "typography": {},\n "shape": {},\n "consumer": {}\n },\n "is_default": true,\n "_manifest": ["string"],\n "custom_theme": "string",\n "use_custom_theme": true,\n "design_tokens": {\n "coupon": "string",\n "cashback": "string",\n "custom_css": "string",\n "accent_color": "string",\n "outline_color": "string",\n "divider_color": "string",\n "link_color": "string",\n "link_hover_color": "string",\n "font_size_scale": "xs",\n "topbar_height": 0,\n "topbar_logo_alignment": "flex-start",\n "logo_size": 0,\n "input_background": "string",\n "input_border_color": "string",\n "input_text_color": "string",\n "input_label_color": "string",\n "input_border_radius": 0,\n "input_height": 0,\n "input_variant": "outlined",\n "button_primary_bg": "string",\n "button_primary_text": "string",\n "button_primary_hover_bg": "string",\n "button_primary_hover_text": "string",\n "button_outlined_border": "string",\n "button_outlined_text": "string",\n "button_outlined_hover_bg": "string",\n "button_outlined_hover_text": "string",\n "button_ghost_bg": "string",\n "button_ghost_text": "string",\n "button_ghost_hover_bg": "string",\n "button_ghost_hover_text": "string",\n "button_border_radius": 0,\n "button_height": 0,\n "card_background": "string",\n "card_border_color": "string",\n "card_variant": "shadow",\n "summary_card_background": "string",\n "toggle_selected_bg": "string",\n "toggle_selected_text": "string",\n "toggle_hover_bg": "string",\n "toggle_hover_text": "string",\n "toggle_border_color": "string",\n "dropdown_hover_bg": "string",\n "dropdown_hover_text": "string",\n "dropdown_selected_bg": "string",\n "dropdown_selected_text": "string",\n "switch_unchecked_color": "string",\n "switch_unchecked_bg": "string",\n "switch_border_radius": 0,\n "checkbox_unchecked_color": "string",\n "checkbox_label_color": "string",\n "radio_unchecked_color": "string",\n "radio_label_color": "string",\n "datepicker_selected_bg": "string",\n "datepicker_selected_color": "string",\n "datepicker_border_radius": 0,\n "chip_background": "string",\n "chip_hover_background": "string",\n "chip_text_color": "string",\n "chip_hover_text_color": "string"\n }\n }\n}\n```\n\n</details>\n\n---\n\n### `deleteDesign`\n\nSearch and delete for a especific design owned by user organization\n\n`DELETE /v1/designs/{designId}`\n\n```ts\nconst { data } = await client.deleteDesign({\n designId: \'example\',\n})\n```\n\n---\n\n### `updateDesign`\n\nUpdate a especific design owned by user organization\n\n`PUT /v1/designs/{designId}`\n\n```ts\nconst { data } = await client.updateDesign(\n {\n designId: \'example\',\n },\n {\n design: {\n brand_id: \'string\',\n brand_name: \'string\',\n user: {\n emailaddress: \'string\',\n fullname: \'string\',\n name: \'string\',\n userid: \'string\'\n },\n style_name: \'string\',\n style: {\n logo: { /* ... */ },\n palette: { /* ... */ },\n typography: { /* ... */ },\n shape: { /* ... */ },\n consumer: { /* ... */ }\n },\n is_default: true,\n _manifest: [\'string\'],\n custom_theme: \'string\',\n use_custom_theme: true,\n design_tokens: {\n coupon: \'string\',\n cashback: \'string\',\n custom_css: \'string\',\n accent_color: \'string\',\n outline_color: \'string\',\n divider_color: \'string\',\n link_color: \'string\',\n link_hover_color: \'string\',\n font_size_scale: \'xs\',\n topbar_height: 0,\n topbar_logo_alignment: \'flex-start\',\n logo_size: 0,\n input_background: \'string\',\n input_border_color: \'string\',\n input_text_color: \'string\',\n input_label_color: \'string\',\n input_border_radius: 0,\n input_height: 0,\n input_variant: \'outlined\',\n button_primary_bg: \'string\',\n button_primary_text: \'string\',\n button_primary_hover_bg: \'string\',\n button_primary_hover_text: \'string\',\n button_outlined_border: \'string\',\n button_outlined_text: \'string\',\n button_outlined_hover_bg: \'string\',\n button_outlined_hover_text: \'string\',\n button_ghost_bg: \'string\',\n button_ghost_text: \'string\',\n button_ghost_hover_bg: \'string\',\n button_ghost_hover_text: \'string\',\n button_border_radius: 0,\n button_height: 0,\n card_background: \'string\',\n card_border_color: \'string\',\n card_variant: \'shadow\',\n summary_card_background: \'string\',\n toggle_selected_bg: \'string\',\n toggle_selected_text: \'string\',\n toggle_hover_bg: \'string\',\n toggle_hover_text: \'string\',\n toggle_border_color: \'string\',\n dropdown_hover_bg: \'string\',\n dropdown_hover_text: \'string\',\n dropdown_selected_bg: \'string\',\n dropdown_selected_text: \'string\',\n switch_unchecked_color: \'string\',\n switch_unchecked_bg: \'string\',\n switch_border_radius: 0,\n checkbox_unchecked_color: \'string\',\n checkbox_label_color: \'string\',\n radio_unchecked_color: \'string\',\n radio_label_color: \'string\',\n datepicker_selected_bg: \'string\',\n datepicker_selected_color: \'string\',\n datepicker_border_radius: 0,\n chip_background: \'string\',\n chip_hover_background: \'string\',\n chip_text_color: \'string\',\n chip_hover_text_color: \'string\'\n }\n }\n },\n)\n```\n\n---\n\n### `getThemeFromDesign`\n\nSearch for a especific design owned by user organization and parse them to a new or old theme\n\n`GET /v1/designs/{designId}/parse`\n\n```ts\nconst { data } = await client.getThemeFromDesign({\n designId: \'example\',\n orgId: \'example\',\n theme: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "theme": "NEW",\n "design": {\n "id": "string",\n "last_modified_at": "string",\n "style_name": "string",\n "style": {\n "logo": {\n "main": {\n "name": "string",\n "display_name": "string",\n "file_type": "LOGO",\n "s3_object_key": "string",\n "url": "string",\n "file_id": "string"\n }\n },\n "palette": {\n "primary": "string",\n "secondary": "string",\n "error": "string",\n "background": "string",\n "paper": "string",\n "navbar": "string",\n "portal_login_background": "string"\n },\n "typography": {\n "font": {\n "font_id": "string",\n "font_name": "string",\n "font_family": "string",\n "font_weight_regular": "string",\n "font_weight_medium": "string",\n "font_weight_bold": "string",\n "urls": [\n {\n "type": "WOFF2",\n "url": "string"\n }\n ]\n },\n "primary": "string",\n "secondary": "string"\n }\n },\n "custom_theme": "string",\n "use_custom_theme": true,\n "journey_design_tokens": {}\n }\n}\n```\n\n</details>\n\n---\n\n### `uploadFile`\n\nUpload a new file for the user organization bucket\n\n`POST /v1/designs/files`\n\n```ts\nconst { data } = await client.uploadFile()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "name": "string",\n "display_name": "string",\n "file_type": "LOGO",\n "s3_object_key": "string",\n "url": "string",\n "file_id": "string"\n}\n```\n\n</details>\n\n---\n\n### `getFiles`\n\nList all files for the user organization bucket\n\n`GET /v1/designs/files`\n\n```ts\nconst { data } = await client.getFiles({\n type: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "name": "string",\n "display_name": "string",\n "file_type": "LOGO",\n "s3_object_key": "string",\n "url": "string",\n "file_id": "string"\n }\n]\n```\n\n</details>\n\n---\n\n### `getConsumerDesign`\n\nSearch for a especific design owned by user organization\n\n`GET /v1/designs/consumer/{application}/{consumerId}`\n\n```ts\nconst { data } = await client.getConsumerDesign({\n consumerId: \'example\',\n application: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "design": {\n "id": "string",\n "created_at": "2021-01-30T08:30:00Z",\n "created_by": "string",\n "edited": true,\n "last_modified_at": "string",\n "brand_id": "string",\n "brand_name": "string",\n "user": {\n "emailaddress": "string",\n "fullname": "string",\n "name": "string",\n "userid": "string"\n },\n "style_name": "string",\n "style": {\n "logo": {},\n "palette": {},\n "typography": {},\n "shape": {},\n "consumer": {}\n },\n "is_default": true,\n "_manifest": ["string"],\n "custom_theme": "string",\n "use_custom_theme": true,\n "design_tokens": {\n "coupon": "string",\n "cashback": "string",\n "custom_css": "string",\n "accent_color": "string",\n "outline_color": "string",\n "divider_color": "string",\n "link_color": "string",\n "link_hover_color": "string",\n "font_size_scale": "xs",\n "topbar_height": 0,\n "topbar_logo_alignment": "flex-start",\n "logo_size": 0,\n "input_background": "string",\n "input_border_color": "string",\n "input_text_color": "string",\n "input_label_color": "string",\n "input_border_radius": 0,\n "input_height": 0,\n "input_variant": "outlined",\n "button_primary_bg": "string",\n "button_primary_text": "string",\n "button_primary_hover_bg": "string",\n "button_primary_hover_text": "string",\n "button_outlined_border": "string",\n "button_outlined_text": "string",\n "button_outlined_hover_bg": "string",\n "button_outlined_hover_text": "string",\n "button_ghost_bg": "string",\n "button_ghost_text": "string",\n "button_ghost_hover_bg": "string",\n "button_ghost_hover_text": "string",\n "button_border_radius": 0,\n "button_height": 0,\n "card_background": "string",\n "card_border_color": "string",\n "card_variant": "shadow",\n "summary_card_background": "string",\n "toggle_selected_bg": "string",\n "toggle_selected_text": "string",\n "toggle_hover_bg": "string",\n "toggle_hover_text": "string",\n "toggle_border_color": "string",\n "dropdown_hover_bg": "string",\n "dropdown_hover_text": "string",\n "dropdown_selected_bg": "string",\n "dropdown_selected_text": "string",\n "switch_unchecked_color": "string",\n "switch_unchecked_bg": "string",\n "switch_border_radius": 0,\n "checkbox_unchecked_color": "string",\n "checkbox_label_color": "string",\n "radio_unchecked_color": "string",\n "radio_label_color": "string",\n "datepicker_selected_bg": "string",\n "datepicker_selected_color": "string",\n "datepicker_border_radius": 0,\n "chip_background": "string",\n "chip_hover_background": "string",\n "chip_text_color": "string",\n "chip_hover_text_color": "string"\n }\n }\n}\n```\n\n</details>\n\n---\n\n### `addConsumer`\n\nAdd a consumer that uses a specific design\n\n`PUT /v1/designs/addConsumer/{application}/{designId}`\n\n```ts\nconst { data } = await client.addConsumer(\n {\n designId: \'example\',\n application: \'example\',\n },\n {\n consumer_id: \'4a062990-a6a3-11eb-9828-4f3da7d4935a\',\n consumer_name: \'string\',\n should_delete: \'string\'\n },\n)\n```\n\n---\n\n### `removeConsumer`\n\nRemove a consumer that uses a specific design\n\n`PUT /v1/designs/removeConsumer/{application}/{designId}`\n\n```ts\nconst { data } = await client.removeConsumer(\n {\n designId: \'example\',\n application: \'example\',\n },\n {\n consumer_id: \'4a062990-a6a3-11eb-9828-4f3da7d4935a\',\n should_delete: \'string\'\n },\n)\n```\n\n---\n\n## Schemas\n\n### `UploadFileReq`\n\n```ts\ntype UploadFileReq = {\n file_type: "LOGO" | "FONT" | "IMAGE"\n file_data: string // base64\n display_name?: string\n file_name: string\n}\n```\n\n### `UploadFileRes`\n\n```ts\ntype UploadFileRes = {\n name: string\n display_name?: string\n file_type?: "LOGO" | "FONT" | "IMAGE"\n s3_object_key: string\n url: string\n file_id?: string\n}\n```\n\n### `GetFilesRes`\n\n```ts\ntype GetFilesRes = Array<{\n name: string\n display_name?: string\n file_type?: "LOGO" | "FONT" | "IMAGE"\n s3_object_key: string\n url: string\n file_id?: string\n}>\n```\n\n### `GetAllDesignsRes`\n\n```ts\ntype GetAllDesignsRes = {\n designs?: Array<{\n id?: string\n created_at?: string\n created_by?: string\n edited: boolean\n last_modified_at?: string\n brand_id?: string\n brand_name?: string\n user?: {\n emailaddress?: { ... }\n fullname?: { ... }\n name?: { ... }\n userid?: { ... }\n }\n style_name: string\n style: {\n logo?: { ... }\n palette: { ... }\n typography: { ... }\n shape?: { ... }\n consumer: { ... }\n }\n is_default?: boolean\n _manifest?: string[]\n custom_theme?: string\n use_custom_theme?: boolean\n design_tokens?: {\n coupon?: { ... }\n cashback?: { ... }\n custom_css?: { ... }\n accent_color?: { ... }\n outline_color?: { ... }\n divider_color?: { ... }\n link_color?: { ... }\n link_hover_color?: { ... }\n font_size_scale?: { ... }\n topbar_height?: { ... }\n topbar_logo_alignment?: { ... }\n logo_size?: { ... }\n input_background?: { ... }\n input_border_color?: { ... }\n input_text_color?: { ... }\n input_label_color?: { ... }\n input_border_radius?: { ... }\n input_height?: { ... }\n input_variant?: { ... }\n button_primary_bg?: { ... }\n button_primary_text?: { ... }\n button_primary_hover_bg?: { ... }\n button_primary_hover_text?: { ... }\n button_outlined_border?: { ... }\n button_outlined_text?: { ... }\n button_outlined_hover_bg?: { ... }\n button_outlined_hover_text?: { ... }\n button_ghost_bg?: { ... }\n button_ghost_text?: { ... }\n button_ghost_hover_bg?: { ... }\n button_ghost_hover_text?: { ... }\n button_border_radius?: { ... }\n button_height?: { ... }\n card_background?: { ... }\n card_border_color?: { ... }\n card_variant?: { ... }\n summary_card_background?: { ... }\n toggle_selected_bg?: { ... }\n toggle_selected_text?: { ... }\n toggle_hover_bg?: { ... }\n toggle_hover_text?: { ... }\n toggle_border_color?: { ... }\n dropdown_hover_bg?: { ... }\n dropdown_hover_text?: { ... }\n dropdown_selected_bg?: { ... }\n dropdown_selected_text?: { ... }\n switch_unchecked_color?: { ... }\n switch_unchecked_bg?: { ... }\n switch_border_radius?: { ... }\n checkbox_unchecked_color?: { ... }\n checkbox_label_color?: { ... }\n radio_unchecked_color?: { ... }\n radio_label_color?: { ... }\n datepicker_selected_bg?: { ... }\n datepicker_selected_color?: { ... }\n datepicker_border_radius?: { ... }\n chip_background?: { ... }\n chip_hover_background?: { ... }\n chip_text_color?: { ... }\n chip_hover_text_color?: { ... }\n }\n }>\n}\n```\n\n### `GetBrandsRes`\n\n```ts\ntype GetBrandsRes = {\n brands?: Array<{\n id: string\n name: string\n created_by?: string\n created_date?: string\n main_brand?: string\n organization_id?: string\n updated_date?: string\n updated_by?: string\n status?: string\n }>\n}\n```\n\n### `AddDesignReq`\n\n```ts\ntype AddDesignReq = {\n design: {\n brand_id?: string\n brand_name?: string\n user?: {\n emailaddress?: { ... }\n fullname?: { ... }\n name?: { ... }\n userid?: { ... }\n }\n style_name: string\n style: {\n logo?: { ... }\n palette: { ... }\n typography: { ... }\n shape?: { ... }\n consumer: { ... }\n }\n is_default?: boolean\n _manifest?: string[]\n custom_theme?: string\n use_custom_theme?: boolean\n design_tokens?: {\n coupon?: { ... }\n cashback?: { ... }\n custom_css?: { ... }\n accent_color?: { ... }\n outline_color?: { ... }\n divider_color?: { ... }\n link_color?: { ... }\n link_hover_color?: { ... }\n font_size_scale?: { ... }\n topbar_height?: { ... }\n topbar_logo_alignment?: { ... }\n logo_size?: { ... }\n input_background?: { ... }\n input_border_color?: { ... }\n input_text_color?: { ... }\n input_label_color?: { ... }\n input_border_radius?: { ... }\n input_height?: { ... }\n input_variant?: { ... }\n button_primary_bg?: { ... }\n button_primary_text?: { ... }\n button_primary_hover_bg?: { ... }\n button_primary_hover_text?: { ... }\n button_outlined_border?: { ... }\n button_outlined_text?: { ... }\n button_outlined_hover_bg?: { ... }\n button_outlined_hover_text?: { ... }\n button_ghost_bg?: { ... }\n button_ghost_text?: { ... }\n button_ghost_hover_bg?: { ... }\n button_ghost_hover_text?: { ... }\n button_border_radius?: { ... }\n button_height?: { ... }\n card_background?: { ... }\n card_border_color?: { ... }\n card_variant?: { ... }\n summary_card_background?: { ... }\n toggle_selected_bg?: { ... }\n toggle_selected_text?: { ... }\n toggle_hover_bg?: { ... }\n toggle_hover_text?: { ... }\n toggle_border_color?: { ... }\n dropdown_hover_bg?: { ... }\n dropdown_hover_text?: { ... }\n dropdown_selected_bg?: { ... }\n dropdown_selected_text?: { ... }\n switch_unchecked_color?: { ... }\n switch_unchecked_bg?: { ... }\n switch_border_radius?: { ... }\n checkbox_unchecked_color?: { ... }\n checkbox_label_color?: { ... }\n radio_unchecked_color?: { ... }\n radio_label_color?: { ... }\n datepicker_selected_bg?: { ... }\n datepicker_selected_color?: { ... }\n datepicker_border_radius?: { ... }\n chip_background?: { ... }\n chip_hover_background?: { ... }\n chip_text_color?: { ... }\n chip_hover_text_color?: { ... }\n }\n }\n}\n```\n\n### `AddDesignRes`\n\n```ts\ntype AddDesignRes = {\n design?: {\n id?: string\n created_at?: string\n created_by?: string\n edited: boolean\n last_modified_at?: string\n brand_id?: string\n brand_name?: string\n user?: {\n emailaddress?: { ... }\n fullname?: { ... }\n name?: { ... }\n userid?: { ... }\n }\n style_name: string\n style: {\n logo?: { ... }\n palette: { ... }\n typography: { ... }\n shape?: { ... }\n consumer: { ... }\n }\n is_default?: boolean\n _manifest?: string[]\n custom_theme?: string\n use_custom_theme?: boolean\n design_tokens?: {\n coupon?: { ... }\n cashback?: { ... }\n custom_css?: { ... }\n accent_color?: { ... }\n outline_color?: { ... }\n divider_color?: { ... }\n link_color?: { ... }\n link_hover_color?: { ... }\n font_size_scale?: { ... }\n topbar_height?: { ... }\n topbar_logo_alignment?: { ... }\n logo_size?: { ... }\n input_background?: { ... }\n input_border_color?: { ... }\n input_text_color?: { ... }\n input_label_color?: { ... }\n input_border_radius?: { ... }\n input_height?: { ... }\n input_variant?: { ... }\n button_primary_bg?: { ... }\n button_primary_text?: { ... }\n button_primary_hover_bg?: { ... }\n button_primary_hover_text?: { ... }\n button_outlined_border?: { ... }\n button_outlined_text?: { ... }\n button_outlined_hover_bg?: { ... }\n button_outlined_hover_text?: { ... }\n button_ghost_bg?: { ... }\n button_ghost_text?: { ... }\n button_ghost_hover_bg?: { ... }\n button_ghost_hover_text?: { ... }\n button_border_radius?: { ... }\n button_height?: { ... }\n card_background?: { ... }\n card_border_color?: { ... }\n card_variant?: { ... }\n summary_card_background?: { ... }\n toggle_selected_bg?: { ... }\n toggle_selected_text?: { ... }\n toggle_hover_bg?: { ... }\n toggle_hover_text?: { ... }\n toggle_border_color?: { ... }\n dropdown_hover_bg?: { ... }\n dropdown_hover_text?: { ... }\n dropdown_selected_bg?: { ... }\n dropdown_selected_text?: { ... }\n switch_unchecked_color?: { ... }\n switch_unchecked_bg?: { ... }\n switch_border_radius?: { ... }\n checkbox_unchecked_color?: { ... }\n checkbox_label_color?: { ... }\n radio_unchecked_color?: { ... }\n radio_label_color?: { ... }\n datepicker_selected_bg?: { ... }\n datepicker_selected_color?: { ... }\n datepicker_border_radius?: { ... }\n chip_background?: { ... }\n chip_hover_background?: { ... }\n chip_text_color?: { ... }\n chip_hover_text_color?: { ... }\n }\n }\n}\n```\n\n### `GetDesignRes`\n\n```ts\ntype GetDesignRes = {\n design?: {\n id?: string\n created_at?: string\n created_by?: string\n edited: boolean\n last_modified_at?: string\n brand_id?: string\n brand_name?: string\n user?: {\n emailaddress?: { ... }\n fullname?: { ... }\n name?: { ... }\n userid?: { ... }\n }\n style_name: string\n style: {\n logo?: { ... }\n palette: { ... }\n typography: { ... }\n shape?: { ... }\n consumer: { ... }\n }\n is_default?: boolean\n _manifest?: string[]\n custom_theme?: string\n use_custom_theme?: boolean\n design_tokens?: {\n coupon?: { ... }\n cashback?: { ... }\n custom_css?: { ... }\n accent_color?: { ... }\n outline_color?: { ... }\n divider_color?: { ... }\n link_color?: { ... }\n link_hover_color?: { ... }\n font_size_scale?: { ... }\n topbar_height?: { ... }\n topbar_logo_alignment?: { ... }\n logo_size?: { ... }\n input_background?: { ... }\n input_border_color?: { ... }\n input_text_color?: { ... }\n input_label_color?: { ... }\n input_border_radius?: { ... }\n input_height?: { ... }\n input_variant?: { ... }\n button_primary_bg?: { ... }\n button_primary_text?: { ... }\n button_primary_hover_bg?: { ... }\n button_primary_hover_text?: { ... }\n button_outlined_border?: { ... }\n button_outlined_text?: { ... }\n button_outlined_hover_bg?: { ... }\n button_outlined_hover_text?: { ... }\n button_ghost_bg?: { ... }\n button_ghost_text?: { ... }\n button_ghost_hover_bg?: { ... }\n button_ghost_hover_text?: { ... }\n button_border_radius?: { ... }\n button_height?: { ... }\n card_background?: { ... }\n card_border_color?: { ... }\n card_variant?: { ... }\n summary_card_background?: { ... }\n toggle_selected_bg?: { ... }\n toggle_selected_text?: { ... }\n toggle_hover_bg?: { ... }\n toggle_hover_text?: { ... }\n toggle_border_color?: { ... }\n dropdown_hover_bg?: { ... }\n dropdown_hover_text?: { ... }\n dropdown_selected_bg?: { ... }\n dropdown_selected_text?: { ... }\n switch_unchecked_color?: { ... }\n switch_unchecked_bg?: { ... }\n switch_border_radius?: { ... }\n checkbox_unchecked_color?: { ... }\n checkbox_label_color?: { ... }\n radio_unchecked_color?: { ... }\n radio_label_color?: { ... }\n datepicker_selected_bg?: { ... }\n datepicker_selected_color?: { ... }\n datepicker_border_radius?: { ... }\n chip_background?: { ... }\n chip_hover_background?: { ... }\n chip_text_color?: { ... }\n chip_hover_text_color?: { ... }\n }\n }\n}\n```\n\n### `UpdateDesignReq`\n\n```ts\ntype UpdateDesignReq = {\n design: {\n brand_id?: string\n brand_name?: string\n user?: {\n emailaddress?: { ... }\n fullname?: { ... }\n name?: { ... }\n userid?: { ... }\n }\n style_name: string\n style: {\n logo?: { ... }\n palette: { ... }\n typography: { ... }\n shape?: { ... }\n consumer: { ... }\n }\n is_default?: boolean\n _manifest?: string[]\n custom_theme?: string\n use_custom_theme?: boolean\n design_tokens?: {\n coupon?: { ... }\n cashback?: { ... }\n custom_css?: { ... }\n accent_color?: { ... }\n outline_color?: { ... }\n divider_color?: { ... }\n link_color?: { ... }\n link_hover_color?: { ... }\n font_size_scale?: { ... }\n topbar_height?: { ... }\n topbar_logo_alignment?: { ... }\n logo_size?: { ... }\n input_background?: { ... }\n input_border_color?: { ... }\n input_text_color?: { ... }\n input_label_color?: { ... }\n input_border_radius?: { ... }\n input_height?: { ... }\n input_variant?: { ... }\n button_primary_bg?: { ... }\n button_primary_text?: { ... }\n button_primary_hover_bg?: { ... }\n button_primary_hover_text?: { ... }\n button_outlined_border?: { ... }\n button_outlined_text?: { ... }\n button_outlined_hover_bg?: { ... }\n button_outlined_hover_text?: { ... }\n button_ghost_bg?: { ... }\n button_ghost_text?: { ... }\n button_ghost_hover_bg?: { ... }\n button_ghost_hover_text?: { ... }\n button_border_radius?: { ... }\n button_height?: { ... }\n card_background?: { ... }\n card_border_color?: { ... }\n card_variant?: { ... }\n summary_card_background?: { ... }\n toggle_selected_bg?: { ... }\n toggle_selected_text?: { ... }\n toggle_hover_bg?: { ... }\n toggle_hover_text?: { ... }\n toggle_border_color?: { ... }\n dropdown_hover_bg?: { ... }\n dropdown_hover_text?: { ... }\n dropdown_selected_bg?: { ... }\n dropdown_selected_text?: { ... }\n switch_unchecked_color?: { ... }\n switch_unchecked_bg?: { ... }\n switch_border_radius?: { ... }\n checkbox_unchecked_color?: { ... }\n checkbox_label_color?: { ... }\n radio_unchecked_color?: { ... }\n radio_label_color?: { ... }\n datepicker_selected_bg?: { ... }\n datepicker_selected_color?: { ... }\n datepicker_border_radius?: { ... }\n chip_background?: { ... }\n chip_hover_background?: { ... }\n chip_text_color?: { ... }\n chip_hover_text_color?: { ... }\n }\n }\n}\n```\n\n### `ItemMetada`\n\n```ts\ntype ItemMetada = {\n id?: string\n created_at?: string\n created_by?: string\n edited?: boolean\n last_modified_at?: string\n}\n```\n\n### `AddConsumerReq`\n\n```ts\ntype AddConsumerReq = {\n consumer_id: string\n consumer_name: string\n should_delete?: string\n}\n```\n\n### `RemoveConsumerReq`\n\n```ts\ntype RemoveConsumerReq = {\n consumer_id: string\n should_delete?: string\n}\n```\n\n### `DesignItem`\n\n```ts\ntype DesignItem = {\n brand_id?: string\n brand_name?: string\n user?: {\n emailaddress?: string\n fullname?: string\n name?: string\n userid?: string\n }\n style_name: string\n style: {\n logo?: {\n main?: { ... }\n }\n palette: {\n primary: { ... }\n secondary: { ... }\n error: { ... }\n background: { ... }\n paper: { ... }\n navbar: { ... }\n portal_login_background?: { ... }\n }\n typography: {\n font: { ... }\n primary: { ... }\n secondary: { ... }\n }\n shape?: {\n border_radius?: { ... }\n }\n consumer: {\n widgets: { ... }\n customer_portals: { ... }\n }\n }\n is_default?: boolean\n _manifest?: string[]\n}\n```\n\n### `BrandItem`\n\n```ts\ntype BrandItem = {\n id: string\n name: string\n created_by?: string\n created_date?: string\n main_brand?: string\n organization_id?: string\n updated_date?: string\n updated_by?: string\n status?: string\n}\n```\n\n### `Custom_Style`\n\n```ts\ntype Custom_Style = {\n custom_theme?: string\n use_custom_theme?: boolean\n}\n```\n\n### `Journey`\n\n```ts\ntype Journey = {\n design_tokens?: {\n coupon?: string\n cashback?: string\n custom_css?: string\n accent_color?: string\n outline_color?: string\n divider_color?: string\n link_color?: string\n link_hover_color?: string\n font_size_scale?: "xs" | "sm" | "md" | "lg" | "xl"\n topbar_height?: number\n topbar_logo_alignment?: "flex-start" | "center" | "flex-end"\n logo_size?: number\n input_background?: string\n input_border_color?: string\n input_text_color?: string\n input_label_color?: string\n input_border_radius?: number\n input_height?: number\n input_variant?: "outlined" | "filled" | "underlined"\n button_primary_bg?: string\n button_primary_text?: string\n button_primary_hover_bg?: string\n button_primary_hover_text?: string\n button_outlined_border?: string\n button_outlined_text?: string\n button_outlined_hover_bg?: string\n button_outlined_hover_text?: string\n button_ghost_bg?: string\n button_ghost_text?: string\n button_ghost_hover_bg?: string\n button_ghost_hover_text?: string\n button_border_radius?: number\n button_height?: number\n card_background?: string\n card_border_color?: string\n card_variant?: "shadow" | "outlined"\n summary_card_background?: string\n toggle_selected_bg?: string\n toggle_selected_text?: string\n toggle_hover_bg?: string\n toggle_hover_text?: string\n toggle_border_color?: string\n dropdown_hover_bg?: string\n dropdown_hover_text?: string\n dropdown_selected_bg?: string\n dropdown_selected_text?: string\n switch_unchecked_color?: string\n switch_unchecked_bg?: string\n switch_border_radius?: number\n checkbox_unchecked_color?: string\n checkbox_label_color?: string\n radio_unchecked_color?: string\n radio_label_color?: string\n datepicker_selected_bg?: string\n datepicker_selected_color?: string\n datepicker_border_radius?: number\n chip_background?: string\n chip_hover_background?: string\n chip_text_color?: string\n chip_hover_text_color?: string\n }\n}\n```\n\n### `ConsumerData`\n\n```ts\ntype ConsumerData = {\n widgets: Array<{\n id: string\n name: string\n }>\n customer_portals: Array<{\n id: string\n name: string\n }>\n}\n```\n\n### `WidgetData`\n\n```ts\ntype WidgetData = {\n id: string\n name: string\n}\n```\n\n### `CustomerPortalData`\n\n```ts\ntype CustomerPortalData = {\n id: string\n name: string\n}\n```\n\n### `LogoData`\n\n```ts\ntype LogoData = {\n main?: {\n name: string\n display_name?: string\n file_type?: "LOGO" | "FONT" | "IMAGE"\n s3_object_key: string\n url: string\n file_id?: string\n }\n}\n```\n\n### `PaletteData`\n\n```ts\ntype PaletteData = {\n primary: string\n secondary: string\n error: string\n background: string\n paper: string\n navbar: string\n portal_login_background?: string\n}\n```\n\n### `TypographyData`\n\n```ts\ntype TypographyData = {\n font: {\n font_id: string\n font_name: string\n font_family?: string\n font_weight_regular?: string\n font_weight_medium?: string\n font_weight_bold?: string\n urls: Array<{\n type?: { ... }\n url?: { ... }\n }>\n }\n primary: string\n secondary: string\n}\n```\n\n### `ShapeData`\n\n```ts\ntype ShapeData = {\n border_radius?: number\n}\n```\n\n### `FontData`\n\n```ts\ntype FontData = {\n font_id: string\n font_name: string\n font_family?: string\n font_weight_regular?: string\n font_weight_medium?: string\n font_weight_bold?: string\n urls: Array<{\n type?: "WOFF2" | "WOFF" | "TTF" | "EOT"\n url?: string\n }>\n}\n```\n\n### `FontResponseUrl`\n\n```ts\ntype FontResponseUrl = {\n type?: "WOFF2" | "WOFF" | "TTF" | "EOT"\n url?: string\n}\n```\n\n### `WidgetPortalData`\n\n```ts\ntype WidgetPortalData = {\n id: string\n name: string\n}\n```\n\n### `ErrorResp`\n\n```ts\ntype ErrorResp = {\n message?: string\n error?: object\n}\n```\n\n### `FileData`\n\n```ts\ntype FileData = {\n name: string\n display_name?: string\n file_type?: "LOGO" | "FONT" | "IMAGE"\n s3_object_key: string\n url: string\n file_id?: string\n}\n```\n\n### `DesignId`\n\nId of the design\n\n```ts\ntype DesignId = string\n```\n\n### `Theme`\n\nType of theme to be parsed and returned\n\n```ts\ntype Theme = "NEW" | "OLD"\n```\n\n### `Application`\n\nType of application that uses the design\n\n```ts\ntype Application = string\n```\n\n### `DesignParameters`\n\n```ts\ntype DesignParameters = {\n designId?: string\n theme?: "NEW" | "OLD"\n application?: string\n}\n```\n\n### `ParseThemeFromDesignResp`\n\n```ts\ntype ParseThemeFromDesignResp = {\n theme?: "NEW" | "OLD"\n design?: {\n id?: string\n last_modified_at?: string\n style_name?: string\n style?: {\n logo?: { ... }\n palette?: { ... }\n typography?: { ... }\n }\n custom_theme?: string\n use_custom_theme?: boolean\n journey_design_tokens?: object\n }\n}\n```\n';
|
|
5
|
+
export {
|
|
6
|
+
design_default as default
|
|
7
|
+
};
|