@epilot/sdk 2.2.7 → 2.3.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 +3 -2
- package/dist/{README-JUWX7KNV.js → README-7R2JR652.js} +1 -1
- package/dist/{README-6OOYWQYJ.cjs → README-Z5AKTGJA.cjs} +1 -1
- package/dist/{_index-NWNYWBIF.js → _index-CLT2KTVS.js} +9 -6
- package/dist/{_index-ONGE545F.cjs → _index-O7JDGRSE.cjs} +8 -5
- 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.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +8 -8
- package/dist/apis/automation.d.cts +2 -2
- package/dist/apis/automation.d.ts +2 -2
- package/dist/apis/automation.js +2 -2
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +8 -8
- package/dist/apis/blueprint-manifest.d.cts +2 -2
- package/dist/apis/blueprint-manifest.d.ts +2 -2
- package/dist/apis/blueprint-manifest.js +2 -2
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- 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 +38 -0
- package/dist/apis/{data-management.d.cts → data-governance.d.cts} +5 -5
- package/dist/apis/{data-management.d.ts → data-governance.d.ts} +5 -5
- package/dist/apis/{data-management.js → data-governance.js} +10 -10
- package/dist/apis/deduplication.cjs +8 -8
- package/dist/apis/deduplication.d.cts +2 -2
- package/dist/apis/deduplication.d.ts +2 -2
- package/dist/apis/deduplication.js +2 -2
- 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 +8 -8
- package/dist/apis/email-settings.d.cts +2 -2
- package/dist/apis/email-settings.d.ts +2 -2
- package/dist/apis/email-settings.js +2 -2
- 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.d.cts +2 -2
- package/dist/apis/entity.d.ts +2 -2
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/erp-integration.cjs +6 -6
- package/dist/apis/erp-integration.d.cts +5755 -3
- package/dist/apis/erp-integration.d.ts +5755 -3
- package/dist/apis/erp-integration.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +38 -0
- package/dist/apis/integration-toolkit.d.cts +18 -0
- package/dist/apis/integration-toolkit.d.ts +18 -0
- package/dist/apis/integration-toolkit.js +38 -0
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.d.cts +2 -2
- package/dist/apis/journey.d.ts +2 -2
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +8 -8
- package/dist/apis/message.d.cts +2 -2
- package/dist/apis/message.d.ts +2 -2
- package/dist/apis/message.js +2 -2
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +38 -0
- package/dist/apis/sharing.d.cts +18 -0
- package/dist/apis/sharing.d.ts +18 -0
- package/dist/apis/sharing.js +38 -0
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.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.d.cts +2 -2
- package/dist/apis/template-variables.d.ts +2 -2
- 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.d.cts +2 -2
- package/dist/apis/workflow-definition.d.ts +2 -2
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +8 -8
- package/dist/apis/workflow.d.cts +2 -2
- package/dist/apis/workflow.d.ts +2 -2
- package/dist/apis/workflow.js +2 -2
- package/dist/automation-GFNNLSIN.js +7 -0
- package/dist/automation-IOCVCTKR.cjs +7 -0
- package/dist/{automation-runtime-YBGGE5PL.cjs → automation-runtime-DO5QSGJJ.cjs} +2 -2
- package/dist/{automation-runtime-L5UKEFLA.js → automation-runtime-VP4M7Z4R.js} +1 -1
- package/dist/{automation.d-D7BzN7Gq.d.cts → automation.d-CzhG2m4L.d.cts} +353 -3
- package/dist/{automation.d-D7BzN7Gq.d.ts → automation.d-CzhG2m4L.d.ts} +353 -3
- package/dist/blueprint-manifest-ELK4SGN7.js +7 -0
- package/dist/blueprint-manifest-VBOWPK52.cjs +7 -0
- package/dist/{blueprint-manifest-runtime-2RTW5C52.js → blueprint-manifest-runtime-E2FN43TB.js} +1 -1
- package/dist/{blueprint-manifest-runtime-AF3FIDVX.cjs → blueprint-manifest-runtime-G4UK5VEX.cjs} +2 -2
- package/dist/{blueprint-manifest.d-DECw6HdM.d.ts → blueprint-manifest.d-BGrGU787.d.cts} +712 -22
- package/dist/{blueprint-manifest.d-DECw6HdM.d.cts → blueprint-manifest.d-BGrGU787.d.ts} +712 -22
- package/dist/chunk-5APJZUIH.cjs +14 -0
- package/dist/chunk-5ED7FB3Q.js +14 -0
- package/dist/{chunk-BN6EJPDC.js → chunk-6AO46HG5.js} +30 -25
- package/dist/{chunk-UNCVJH6J.cjs → chunk-77JS7NDM.cjs} +1 -1
- package/dist/{chunk-6UAS2VVG.js → chunk-DLYPVF4U.js} +1 -1
- package/dist/chunk-DVM27A7E.cjs +14 -0
- package/dist/{chunk-3NLMZLCD.js → chunk-EFWPEVXI.js} +1 -1
- package/dist/chunk-EIIIKDOJ.cjs +14 -0
- package/dist/{chunk-HAZ3WP7V.cjs → chunk-IAHSYVYB.cjs} +1 -1
- package/dist/chunk-JTFWOEZF.cjs +14 -0
- package/dist/{chunk-A67W5WAP.cjs → chunk-KEI3GHDY.cjs} +1 -1
- package/dist/chunk-KIWRGUKM.js +14 -0
- package/dist/{chunk-PSQMDY3B.js → chunk-KQKBSWGI.js} +1 -1
- package/dist/{chunk-VUVWHQMP.cjs → chunk-MHXQX7FS.cjs} +30 -25
- package/dist/chunk-NPDSA7T2.js +14 -0
- package/dist/{chunk-ZI33AJQ5.cjs → chunk-QNZPOA54.cjs} +1 -1
- package/dist/chunk-TZQFJ5GX.cjs +14 -0
- package/dist/chunk-U4PUHKZC.js +14 -0
- package/dist/chunk-VPDA5SAH.js +14 -0
- package/dist/chunk-WT26LFC2.js +14 -0
- package/dist/{chunk-3YSEO476.js → chunk-X2SC4GW5.js} +1 -1
- package/dist/chunk-ZL6KDJFT.cjs +14 -0
- package/dist/data-governance-2U5UU4GM.cjs +7 -0
- package/dist/data-governance-36Y33JVG.js +7 -0
- package/dist/{data-management-W5JQGGGH.js → data-governance-PLS5TJ7Z.js} +3 -3
- package/dist/{data-management-XFSRLFYA.cjs → data-governance-ZJ2K4ZWX.cjs} +3 -3
- package/dist/data-governance-runtime-LITKCNSG.js +5 -0
- package/dist/{data-management-runtime-J5IS7T47.cjs → data-governance-runtime-TDGFG67G.cjs} +2 -2
- package/dist/data-governance.d-BbZ466j5.d.cts +1178 -0
- package/dist/data-governance.d-BbZ466j5.d.ts +1178 -0
- package/dist/deduplication-G2ZY4NMX.js +7 -0
- package/dist/deduplication-PKKTZAEA.cjs +7 -0
- package/dist/{deduplication-runtime-BBHG7MJW.cjs → deduplication-runtime-5QS6I4S7.cjs} +2 -2
- package/dist/{deduplication-runtime-DLGBF4RN.js → deduplication-runtime-VL4R2VIG.js} +1 -1
- package/dist/deduplication.d-D5GYddVu.d.cts +218 -0
- package/dist/deduplication.d-D5GYddVu.d.ts +218 -0
- package/dist/design-NISDHPFD.cjs +7 -0
- package/dist/design-WL4AZIGX.js +7 -0
- package/dist/design-runtime-OXEXKZVG.cjs +5 -0
- package/dist/{design-runtime-3SKJA7QH.js → design-runtime-QMJM4FAF.js} +1 -1
- package/dist/{design.d-eA-irKEX.d.cts → design.d-DTo29S0F.d.cts} +142 -15
- package/dist/{design.d-eA-irKEX.d.ts → design.d-DTo29S0F.d.ts} +142 -15
- package/dist/email-settings-CKFJU4WZ.js +7 -0
- package/dist/email-settings-NQJJKS2P.cjs +7 -0
- package/dist/{email-settings-runtime-Q2HVKJDS.js → email-settings-runtime-EGIJ2AVQ.js} +1 -1
- package/dist/{email-settings-runtime-3NJIAWWI.cjs → email-settings-runtime-WGVLI7N6.cjs} +2 -2
- package/dist/{email-settings.d-DUvmLZMN.d.cts → email-settings.d-B7Q_xT25.d.cts} +29 -2
- package/dist/{email-settings.d-DUvmLZMN.d.ts → email-settings.d-B7Q_xT25.d.ts} +29 -2
- package/dist/entity-CK76MXVN.js +7 -0
- package/dist/entity-TFMH5VTZ.cjs +7 -0
- package/dist/{entity.d-__Tx1Y0J.d.ts → entity.d-ByufVI16.d.cts} +40 -1
- package/dist/{entity.d-__Tx1Y0J.d.cts → entity.d-ByufVI16.d.ts} +40 -1
- package/dist/erp-integration-PAVHSUDM.cjs +7 -0
- package/dist/erp-integration-SBQJ6HEG.js +7 -0
- package/dist/index.cjs +67 -40
- package/dist/index.d.cts +36 -34
- package/dist/index.d.ts +36 -34
- package/dist/index.js +54 -27
- package/dist/integration-toolkit-FRPFOYT2.js +7 -0
- package/dist/integration-toolkit-VNMDI55O.cjs +7 -0
- package/dist/integration-toolkit-runtime-5KG3LGXF.cjs +5 -0
- package/dist/integration-toolkit-runtime-LYHFVIRW.js +5 -0
- package/dist/{erp-integration.d-B4XPU_j-.d.cts → integration-toolkit.d-Ry-KC9ow.d.cts} +69 -3
- package/dist/{erp-integration.d-B4XPU_j-.d.ts → integration-toolkit.d-Ry-KC9ow.d.ts} +69 -3
- package/dist/journey-KDR5EU3W.js +7 -0
- package/dist/journey-REBN4TGQ.cjs +7 -0
- package/dist/{journey.d-BguKXj73.d.cts → journey.d-ClXO0xK8.d.cts} +8 -0
- package/dist/{journey.d-BguKXj73.d.ts → journey.d-ClXO0xK8.d.ts} +8 -0
- package/dist/message-HCA2KSH6.js +7 -0
- package/dist/message-J2SFQJNB.cjs +7 -0
- package/dist/{message-runtime-ITR7MPKT.cjs → message-runtime-CGFCT6FU.cjs} +2 -2
- package/dist/{message-runtime-YMKW2N3R.js → message-runtime-XDCFFLYK.js} +1 -1
- package/dist/{message.d-YEv1kmQd.d.cts → message.d-D3QUkBjg.d.cts} +230 -4
- package/dist/{message.d-YEv1kmQd.d.ts → message.d-D3QUkBjg.d.ts} +230 -4
- package/dist/sharing-KEWK5LNG.js +976 -0
- package/dist/sharing-MNDABPL7.js +7 -0
- package/dist/sharing-MR7ANOST.cjs +7 -0
- package/dist/sharing-WG4L7LH2.cjs +976 -0
- package/dist/sharing-runtime-OZGIZWL3.js +5 -0
- package/dist/sharing-runtime-VOFLBIFW.cjs +5 -0
- package/dist/sharing.d-sOXq-gtz.d.cts +571 -0
- package/dist/sharing.d-sOXq-gtz.d.ts +571 -0
- package/dist/{template-variables-VKDJJZUT.js → template-variables-6CLOG67C.js} +13 -0
- package/dist/{template-variables-OAYS2E3G.cjs → template-variables-I72B5WS6.cjs} +13 -0
- package/dist/{template-variables.d-Ch3H3zYf.d.cts → template-variables.d-Ble9TSBa.d.cts} +8 -2
- package/dist/{template-variables.d-Ch3H3zYf.d.ts → template-variables.d-Ble9TSBa.d.ts} +8 -2
- package/dist/workflow-CQOBZ25C.cjs +7 -0
- package/dist/workflow-G7VFCXY7.js +7 -0
- package/dist/workflow-definition-CVBYKAUY.cjs +7 -0
- package/dist/workflow-definition-GNAKDNG7.js +7 -0
- package/dist/{workflow-definition.d-CtmE-ymB.d.cts → workflow-definition.d-ByCJK9_x.d.cts} +16 -0
- package/dist/{workflow-definition.d-CtmE-ymB.d.ts → workflow-definition.d-ByCJK9_x.d.ts} +16 -0
- package/dist/{workflow-runtime-RLZO2OQB.js → workflow-runtime-DNTQDYPQ.js} +1 -1
- package/dist/{workflow-runtime-WCJ7NRTH.cjs → workflow-runtime-VKFESVFX.cjs} +2 -2
- package/dist/{workflow.d-DvhTpEtU.d.cts → workflow.d-pD8ISOg-.d.cts} +73 -1
- package/dist/{workflow.d-DvhTpEtU.d.ts → workflow.d-pD8ISOg-.d.ts} +73 -1
- package/docs/automation.md +141 -15
- package/docs/blueprint-manifest.md +854 -55
- package/docs/{data-management.md → data-governance.md} +113 -28
- package/docs/deduplication.md +122 -0
- package/docs/design.md +140 -82
- package/docs/email-settings.md +22 -0
- package/docs/entity.md +17 -0
- package/docs/erp-integration.md +21 -6
- package/docs/integration-toolkit.md +6048 -0
- package/docs/journey.md +6 -0
- package/docs/message.md +110 -1
- package/docs/sharing.md +1181 -0
- package/docs/template-variables.md +13 -0
- package/docs/workflow-definition.md +28 -14
- package/docs/workflow.md +231 -30
- package/package.json +29 -17
- package/definitions/access-token-runtime.json +0 -1
- package/definitions/access-token.json +0 -663
- package/definitions/address-runtime.json +0 -1
- package/definitions/address-suggestions-runtime.json +0 -1
- package/definitions/address-suggestions.json +0 -582
- package/definitions/address.json +0 -578
- package/definitions/ai-agents-runtime.json +0 -1
- package/definitions/ai-agents.json +0 -1711
- package/definitions/app-runtime.json +0 -1
- package/definitions/app.json +0 -4493
- package/definitions/audit-logs-runtime.json +0 -1
- package/definitions/audit-logs.json +0 -305
- package/definitions/automation-runtime.json +0 -1
- package/definitions/automation.json +0 -4819
- package/definitions/billing-runtime.json +0 -1
- package/definitions/billing.json +0 -837
- package/definitions/blueprint-manifest-runtime.json +0 -1
- package/definitions/blueprint-manifest.json +0 -3490
- package/definitions/consent-runtime.json +0 -1
- package/definitions/consent.json +0 -344
- package/definitions/customer-portal-runtime.json +0 -1
- package/definitions/customer-portal.json +0 -15676
- package/definitions/dashboard-runtime.json +0 -1
- package/definitions/dashboard.json +0 -484
- package/definitions/data-management-runtime.json +0 -1
- package/definitions/data-management.json +0 -978
- package/definitions/deduplication-runtime.json +0 -1
- package/definitions/deduplication.json +0 -183
- package/definitions/design-runtime.json +0 -1
- package/definitions/design.json +0 -1423
- package/definitions/document-runtime.json +0 -1
- package/definitions/document.json +0 -758
- package/definitions/email-settings-runtime.json +0 -1
- package/definitions/email-settings.json +0 -2748
- package/definitions/email-template-runtime.json +0 -1
- package/definitions/email-template.json +0 -1441
- package/definitions/entity-mapping-runtime.json +0 -1
- package/definitions/entity-mapping.json +0 -1642
- package/definitions/entity-runtime.json +0 -1
- package/definitions/entity.json +0 -10432
- package/definitions/environments-runtime.json +0 -1
- package/definitions/environments.json +0 -363
- package/definitions/erp-integration-runtime.json +0 -1
- package/definitions/erp-integration.json +0 -7927
- package/definitions/event-catalog-runtime.json +0 -1
- package/definitions/event-catalog.json +0 -1051
- package/definitions/file-runtime.json +0 -1
- package/definitions/file.json +0 -2842
- package/definitions/iban-runtime.json +0 -1
- package/definitions/iban.json +0 -132
- package/definitions/journey-runtime.json +0 -1
- package/definitions/journey.json +0 -2594
- package/definitions/kanban-runtime.json +0 -1
- package/definitions/kanban.json +0 -1505
- package/definitions/message-runtime.json +0 -1
- package/definitions/message.json +0 -2660
- package/definitions/metering-runtime.json +0 -1
- package/definitions/metering.json +0 -2321
- package/definitions/notes-runtime.json +0 -1
- package/definitions/notes.json +0 -1531
- package/definitions/notification-runtime.json +0 -1
- package/definitions/notification.json +0 -1425
- package/definitions/organization-runtime.json +0 -1
- package/definitions/organization.json +0 -1192
- package/definitions/partner-directory-runtime.json +0 -1
- package/definitions/partner-directory.json +0 -2284
- package/definitions/permissions-runtime.json +0 -1
- package/definitions/permissions.json +0 -1515
- package/definitions/pricing-runtime.json +0 -1
- package/definitions/pricing-tier-runtime.json +0 -1
- package/definitions/pricing-tier.json +0 -105
- package/definitions/pricing.json +0 -9884
- package/definitions/purpose-runtime.json +0 -1
- package/definitions/purpose.json +0 -524
- package/definitions/sandbox-runtime.json +0 -1
- package/definitions/sandbox.json +0 -453
- package/definitions/submission-runtime.json +0 -1
- package/definitions/submission.json +0 -313
- package/definitions/targeting-runtime.json +0 -1
- package/definitions/targeting.json +0 -1474
- package/definitions/template-variables-runtime.json +0 -1
- package/definitions/template-variables.json +0 -1408
- package/definitions/user-runtime.json +0 -1
- package/definitions/user.json +0 -2408
- package/definitions/validation-rules-runtime.json +0 -1
- package/definitions/validation-rules.json +0 -1491
- package/definitions/webhooks-runtime.json +0 -1
- package/definitions/webhooks.json +0 -1634
- package/definitions/workflow-definition-runtime.json +0 -1
- package/definitions/workflow-definition.json +0 -3288
- package/definitions/workflow-runtime.json +0 -1
- package/definitions/workflow.json +0 -4146
- package/dist/apis/data-management.cjs +0 -38
- package/dist/automation-3HGCK725.cjs +0 -7
- package/dist/automation-72VGEJCY.js +0 -7
- package/dist/blueprint-manifest-CXSCRQ5X.js +0 -7
- package/dist/blueprint-manifest-SHNZPK5O.cjs +0 -7
- package/dist/chunk-4BCQGZJB.cjs +0 -14
- package/dist/chunk-4G6LO3JY.cjs +0 -14
- package/dist/chunk-6GC363VV.js +0 -14
- package/dist/chunk-75ZWZM3L.js +0 -14
- package/dist/chunk-D32L2HMX.cjs +0 -14
- package/dist/chunk-O4JDWMYD.js +0 -14
- package/dist/chunk-RXMOHUBP.cjs +0 -14
- package/dist/chunk-ZKQ573B7.js +0 -14
- package/dist/data-management-3N3A3XBM.js +0 -7
- package/dist/data-management-YXFLQWLV.cjs +0 -7
- package/dist/data-management-runtime-DN7FGK7G.js +0 -5
- package/dist/data-management.d-BXS5jbJY.d.cts +0 -547
- package/dist/data-management.d-BXS5jbJY.d.ts +0 -547
- package/dist/deduplication-ECVAZVVA.cjs +0 -7
- package/dist/deduplication-GYIST22B.js +0 -7
- package/dist/deduplication.d-w_2aJD5f.d.cts +0 -113
- package/dist/deduplication.d-w_2aJD5f.d.ts +0 -113
- package/dist/design-KUVXMFFK.cjs +0 -7
- package/dist/design-YKBXRW5C.js +0 -7
- package/dist/design-runtime-Y3VGTQLP.cjs +0 -5
- package/dist/email-settings-EJ3DCPPN.js +0 -7
- package/dist/email-settings-TALOPLBC.cjs +0 -7
- package/dist/entity-M5F22DSS.cjs +0 -7
- package/dist/entity-RT4YRZDG.js +0 -7
- package/dist/erp-integration-76K5HOGL.js +0 -7
- package/dist/erp-integration-A33WOGPF.cjs +0 -7
- package/dist/journey-HKN7QXCZ.cjs +0 -7
- package/dist/journey-UBZCOJNW.js +0 -7
- package/dist/message-3XZLJR6R.cjs +0 -7
- package/dist/message-ZNMCS5YH.js +0 -7
- package/dist/workflow-3LLURW3H.js +0 -7
- package/dist/workflow-RAGQDYXT.cjs +0 -7
- package/dist/workflow-definition-MBOMPMCG.js +0 -7
- package/dist/workflow-definition-SPAHD3HS.cjs +0 -7
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import "./chunk-YPSWSI3M.js";
|
|
2
|
+
|
|
3
|
+
// src/docs/deduplication.json
|
|
4
|
+
var deduplication_default = '# Deduplication API\n\n- **Base URL:** `https://deduplication.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/deduplication](https://docs.epilot.io/api/deduplication)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.deduplication.deduplicate(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/deduplication\'\n\nconst deduplicationClient = getClient()\nauthorize(deduplicationClient, () => \'<token>\')\nconst { data } = await deduplicationClient.deduplicate(...)\n```\n\n## Operations\n\n- [`deduplicate`](#deduplicate)\n- [`deduplicateAsync`](#deduplicateasync)\n- [`getDeduplicationJob`](#getdeduplicationjob)\n\n**Schemas**\n- [`DeduplicateRequestBody`](#deduplicaterequestbody)\n- [`DeduplicateRequestResponse`](#deduplicaterequestresponse)\n- [`Entity`](#entity)\n- [`DeduplicateAsyncResponse`](#deduplicateasyncresponse)\n- [`JobStatus`](#jobstatus)\n- [`DeduplicationJob`](#deduplicationjob)\n\n### `deduplicate`\n\nDeduplicates Entities\n\n`POST /v1/deduplicate`\n\n```ts\nconst { data } = await client.deduplicate(\n null,\n [\n {\n toKeep: \'string\',\n toDelete: [\'string\']\n }\n ],\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "_id": "string",\n "_org": "string",\n "_schema": "string",\n "_created_at": "1970-01-01T00:00:00.000Z",\n "_updated_at": "1970-01-01T00:00:00.000Z",\n "_created_by": "string",\n "created_by": "string",\n "_tags": ["string"],\n "_acl": {},\n "_owners": [\n {\n "org_id": "string",\n "user_id": "string"\n }\n ],\n "type": "string"\n }\n]\n```\n\n</details>\n\n---\n\n### `deduplicateAsync`\n\nSubmits an async deduplication job. Returns a job ID immediately. Poll GET /v1/deduplicate/jobs/{jobId} for status.\n\n`POST /v1/deduplicate/job`\n\n```ts\nconst { data } = await client.deduplicateAsync(\n null,\n [\n {\n toKeep: \'string\',\n toDelete: [\'string\']\n }\n ],\n)\n```\n\n---\n\n### `getDeduplicationJob`\n\nReturns the current status of an async deduplication job\n\n`GET /v1/deduplicate/jobs/{jobId}`\n\n```ts\nconst { data } = await client.getDeduplicationJob({\n jobId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "jobId": "string",\n "status": "pending",\n "message": "string",\n "result": [\n {\n "_id": "string",\n "_org": "string",\n "_schema": "string",\n "_created_at": "1970-01-01T00:00:00.000Z",\n "_updated_at": "1970-01-01T00:00:00.000Z",\n "_created_by": "string",\n "created_by": "string",\n "_tags": ["string"],\n "_acl": {},\n "_owners": [\n {\n "org_id": "string",\n "user_id": "string"\n }\n ],\n "type": "string"\n }\n ],\n "createdAt": "1970-01-01T00:00:00.000Z",\n "updatedAt": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `DeduplicateRequestBody`\n\n```ts\ntype DeduplicateRequestBody = Array<{\n toKeep: string\n toDelete: string[]\n}>\n```\n\n### `DeduplicateRequestResponse`\n\n```ts\ntype DeduplicateRequestResponse = Array<{\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: string\n user_id: string\n }>\n type?: string\n}>\n```\n\n### `Entity`\n\nBase Entity schema\n\n```ts\ntype Entity = {\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: string\n user_id: string\n }>\n type?: string\n}\n```\n\n### `DeduplicateAsyncResponse`\n\nResponse returned immediately when a deduplication job is submitted\n\n```ts\ntype DeduplicateAsyncResponse = {\n jobId: string\n status: "pending" | "processing" | "completed" | "failed"\n message: string\n}\n```\n\n### `JobStatus`\n\n```ts\ntype JobStatus = "pending" | "processing" | "completed" | "failed"\n```\n\n### `DeduplicationJob`\n\nRepresents an async deduplication job\n\n```ts\ntype DeduplicationJob = {\n jobId: string\n status: "pending" | "processing" | "completed" | "failed"\n message?: string\n result?: Array<{\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: { ... }\n user_id: { ... }\n }>\n type?: string\n }>\n createdAt: string // date-time\n updatedAt: string // date-time\n}\n```\n';
|
|
5
|
+
export {
|
|
6
|
+
deduplication_default as default
|
|
7
|
+
};
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
|
|
2
|
+
|
|
3
|
+
// src/docs/deduplication.json
|
|
4
|
+
var deduplication_default = '# Deduplication API\n\n- **Base URL:** `https://deduplication.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/deduplication](https://docs.epilot.io/api/deduplication)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.deduplication.deduplicate(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/deduplication\'\n\nconst deduplicationClient = getClient()\nauthorize(deduplicationClient, () => \'<token>\')\nconst { data } = await deduplicationClient.deduplicate(...)\n```\n\n## Operations\n\n- [`deduplicate`](#deduplicate)\n- [`deduplicateAsync`](#deduplicateasync)\n- [`getDeduplicationJob`](#getdeduplicationjob)\n\n**Schemas**\n- [`DeduplicateRequestBody`](#deduplicaterequestbody)\n- [`DeduplicateRequestResponse`](#deduplicaterequestresponse)\n- [`Entity`](#entity)\n- [`DeduplicateAsyncResponse`](#deduplicateasyncresponse)\n- [`JobStatus`](#jobstatus)\n- [`DeduplicationJob`](#deduplicationjob)\n\n### `deduplicate`\n\nDeduplicates Entities\n\n`POST /v1/deduplicate`\n\n```ts\nconst { data } = await client.deduplicate(\n null,\n [\n {\n toKeep: \'string\',\n toDelete: [\'string\']\n }\n ],\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "_id": "string",\n "_org": "string",\n "_schema": "string",\n "_created_at": "1970-01-01T00:00:00.000Z",\n "_updated_at": "1970-01-01T00:00:00.000Z",\n "_created_by": "string",\n "created_by": "string",\n "_tags": ["string"],\n "_acl": {},\n "_owners": [\n {\n "org_id": "string",\n "user_id": "string"\n }\n ],\n "type": "string"\n }\n]\n```\n\n</details>\n\n---\n\n### `deduplicateAsync`\n\nSubmits an async deduplication job. Returns a job ID immediately. Poll GET /v1/deduplicate/jobs/{jobId} for status.\n\n`POST /v1/deduplicate/job`\n\n```ts\nconst { data } = await client.deduplicateAsync(\n null,\n [\n {\n toKeep: \'string\',\n toDelete: [\'string\']\n }\n ],\n)\n```\n\n---\n\n### `getDeduplicationJob`\n\nReturns the current status of an async deduplication job\n\n`GET /v1/deduplicate/jobs/{jobId}`\n\n```ts\nconst { data } = await client.getDeduplicationJob({\n jobId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "jobId": "string",\n "status": "pending",\n "message": "string",\n "result": [\n {\n "_id": "string",\n "_org": "string",\n "_schema": "string",\n "_created_at": "1970-01-01T00:00:00.000Z",\n "_updated_at": "1970-01-01T00:00:00.000Z",\n "_created_by": "string",\n "created_by": "string",\n "_tags": ["string"],\n "_acl": {},\n "_owners": [\n {\n "org_id": "string",\n "user_id": "string"\n }\n ],\n "type": "string"\n }\n ],\n "createdAt": "1970-01-01T00:00:00.000Z",\n "updatedAt": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `DeduplicateRequestBody`\n\n```ts\ntype DeduplicateRequestBody = Array<{\n toKeep: string\n toDelete: string[]\n}>\n```\n\n### `DeduplicateRequestResponse`\n\n```ts\ntype DeduplicateRequestResponse = Array<{\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: string\n user_id: string\n }>\n type?: string\n}>\n```\n\n### `Entity`\n\nBase Entity schema\n\n```ts\ntype Entity = {\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: string\n user_id: string\n }>\n type?: string\n}\n```\n\n### `DeduplicateAsyncResponse`\n\nResponse returned immediately when a deduplication job is submitted\n\n```ts\ntype DeduplicateAsyncResponse = {\n jobId: string\n status: "pending" | "processing" | "completed" | "failed"\n message: string\n}\n```\n\n### `JobStatus`\n\n```ts\ntype JobStatus = "pending" | "processing" | "completed" | "failed"\n```\n\n### `DeduplicationJob`\n\nRepresents an async deduplication job\n\n```ts\ntype DeduplicationJob = {\n jobId: string\n status: "pending" | "processing" | "completed" | "failed"\n message?: string\n result?: Array<{\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: { ... }\n user_id: { ... }\n }>\n type?: string\n }>\n createdAt: string // date-time\n updatedAt: string // date-time\n}\n```\n';
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
exports.default = deduplication_default;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
"use strict";Object.defineProperty(exports, "__esModule", {value: true});
|
|
2
2
|
|
|
3
|
-
var
|
|
3
|
+
var _chunkIAHSYVYBcjs = require('./chunk-IAHSYVYB.cjs');
|
|
4
4
|
require('./chunk-NJK5F5TF.cjs');
|
|
5
|
-
exports. default =
|
|
5
|
+
exports. default = _chunkIAHSYVYBcjs.require_deduplication_runtime.call(void 0, );
|
|
@@ -0,0 +1,218 @@
|
|
|
1
|
+
import { OpenAPIClient, Parameters, UnknownParamsObject, AxiosRequestConfig, OperationResponse } from 'openapi-client-axios';
|
|
2
|
+
|
|
3
|
+
/* Auto-copied from deduplication-client */
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
declare namespace Components {
|
|
7
|
+
namespace Schemas {
|
|
8
|
+
/**
|
|
9
|
+
* Response returned immediately when a deduplication job is submitted
|
|
10
|
+
*/
|
|
11
|
+
export interface DeduplicateAsyncResponse {
|
|
12
|
+
/**
|
|
13
|
+
* Job ID to poll for status via GET /v1/deduplicate/jobs/{jobId}
|
|
14
|
+
*/
|
|
15
|
+
jobId: string;
|
|
16
|
+
status: JobStatus;
|
|
17
|
+
/**
|
|
18
|
+
* Initial status message
|
|
19
|
+
*/
|
|
20
|
+
message: string;
|
|
21
|
+
}
|
|
22
|
+
export type DeduplicateRequestBody = {
|
|
23
|
+
toKeep: string;
|
|
24
|
+
toDelete: string[];
|
|
25
|
+
}[];
|
|
26
|
+
export type DeduplicateRequestResponse = /* Base Entity schema */ Entity[];
|
|
27
|
+
/**
|
|
28
|
+
* Represents an async deduplication job
|
|
29
|
+
*/
|
|
30
|
+
export interface DeduplicationJob {
|
|
31
|
+
/**
|
|
32
|
+
* Unique identifier for the deduplication job
|
|
33
|
+
*/
|
|
34
|
+
jobId: string;
|
|
35
|
+
status: JobStatus;
|
|
36
|
+
/**
|
|
37
|
+
* Human-readable status message (e.g. progress info or error details)
|
|
38
|
+
*/
|
|
39
|
+
message?: string;
|
|
40
|
+
/**
|
|
41
|
+
* Array of deduplicated entities, present when status is completed
|
|
42
|
+
*/
|
|
43
|
+
result?: /* Base Entity schema */ Entity[];
|
|
44
|
+
/**
|
|
45
|
+
* ISO 8601 timestamp of job creation
|
|
46
|
+
*/
|
|
47
|
+
createdAt: string; // date-time
|
|
48
|
+
/**
|
|
49
|
+
* ISO 8601 timestamp of last update
|
|
50
|
+
*/
|
|
51
|
+
updatedAt: string; // date-time
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* Base Entity schema
|
|
55
|
+
*/
|
|
56
|
+
export interface Entity {
|
|
57
|
+
/**
|
|
58
|
+
* Entity ID of the Deduplication entry
|
|
59
|
+
*/
|
|
60
|
+
_id: string;
|
|
61
|
+
/**
|
|
62
|
+
* ID of the Organization that owns this Deduplication
|
|
63
|
+
*/
|
|
64
|
+
_org?: string;
|
|
65
|
+
/**
|
|
66
|
+
* The Entity schema of this Deduplication
|
|
67
|
+
*/
|
|
68
|
+
_schema?: string;
|
|
69
|
+
/**
|
|
70
|
+
* The timestamp of when this Deduplication was created
|
|
71
|
+
*/
|
|
72
|
+
_created_at?: string; // date-time
|
|
73
|
+
/**
|
|
74
|
+
* The timestamp of when this Deduplication was last updated
|
|
75
|
+
*/
|
|
76
|
+
_updated_at?: string; // date-time
|
|
77
|
+
/**
|
|
78
|
+
* The Entity ID of the User that created this Deduplication
|
|
79
|
+
*/
|
|
80
|
+
_created_by?: /* The Entity ID of the User that created this Deduplication */ string | number;
|
|
81
|
+
/**
|
|
82
|
+
* The Entity ID of the User that created this Deduplication
|
|
83
|
+
*/
|
|
84
|
+
created_by?: /* The Entity ID of the User that created this Deduplication */ string | number;
|
|
85
|
+
/**
|
|
86
|
+
* Tags associated with this Deduplication
|
|
87
|
+
*/
|
|
88
|
+
_tags?: string[];
|
|
89
|
+
/**
|
|
90
|
+
* Access Control List for this Deduplication entry
|
|
91
|
+
*/
|
|
92
|
+
_acl?: {
|
|
93
|
+
[name: string]: string[];
|
|
94
|
+
};
|
|
95
|
+
_owners?: {
|
|
96
|
+
org_id: string;
|
|
97
|
+
user_id: string;
|
|
98
|
+
}[];
|
|
99
|
+
/**
|
|
100
|
+
* Entity ID of the Deduplication entry
|
|
101
|
+
*/
|
|
102
|
+
type?: string;
|
|
103
|
+
}
|
|
104
|
+
export type JobStatus = "pending" | "processing" | "completed" | "failed";
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
declare namespace Paths {
|
|
108
|
+
namespace Deduplicate {
|
|
109
|
+
export type RequestBody = Components.Schemas.DeduplicateRequestBody;
|
|
110
|
+
namespace Responses {
|
|
111
|
+
export type $200 = Components.Schemas.DeduplicateRequestResponse;
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
namespace DeduplicateAsync {
|
|
115
|
+
export type RequestBody = Components.Schemas.DeduplicateRequestBody;
|
|
116
|
+
namespace Responses {
|
|
117
|
+
export type $202 = /* Response returned immediately when a deduplication job is submitted */ Components.Schemas.DeduplicateAsyncResponse;
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
namespace GetDeduplicationJob {
|
|
121
|
+
namespace Parameters {
|
|
122
|
+
export type JobId = string;
|
|
123
|
+
}
|
|
124
|
+
export interface PathParameters {
|
|
125
|
+
jobId: Parameters.JobId;
|
|
126
|
+
}
|
|
127
|
+
namespace Responses {
|
|
128
|
+
export type $200 = /* Represents an async deduplication job */ Components.Schemas.DeduplicationJob;
|
|
129
|
+
export interface $404 {
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
interface OperationMethods {
|
|
137
|
+
/**
|
|
138
|
+
* deduplicate - deduplicate
|
|
139
|
+
*
|
|
140
|
+
* Deduplicates Entities
|
|
141
|
+
*/
|
|
142
|
+
'deduplicate'(
|
|
143
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
144
|
+
data?: Paths.Deduplicate.RequestBody,
|
|
145
|
+
config?: AxiosRequestConfig
|
|
146
|
+
): OperationResponse<Paths.Deduplicate.Responses.$200>
|
|
147
|
+
/**
|
|
148
|
+
* deduplicateAsync - deduplicateAsync
|
|
149
|
+
*
|
|
150
|
+
* Submits an async deduplication job. Returns a job ID immediately. Poll GET /v1/deduplicate/jobs/{jobId} for status.
|
|
151
|
+
*/
|
|
152
|
+
'deduplicateAsync'(
|
|
153
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
154
|
+
data?: Paths.DeduplicateAsync.RequestBody,
|
|
155
|
+
config?: AxiosRequestConfig
|
|
156
|
+
): OperationResponse<Paths.DeduplicateAsync.Responses.$202>
|
|
157
|
+
/**
|
|
158
|
+
* getDeduplicationJob - getDeduplicationJob
|
|
159
|
+
*
|
|
160
|
+
* Returns the current status of an async deduplication job
|
|
161
|
+
*/
|
|
162
|
+
'getDeduplicationJob'(
|
|
163
|
+
parameters?: Parameters<Paths.GetDeduplicationJob.PathParameters> | null,
|
|
164
|
+
data?: any,
|
|
165
|
+
config?: AxiosRequestConfig
|
|
166
|
+
): OperationResponse<Paths.GetDeduplicationJob.Responses.$200>
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
interface PathsDictionary {
|
|
170
|
+
['/v1/deduplicate']: {
|
|
171
|
+
/**
|
|
172
|
+
* deduplicate - deduplicate
|
|
173
|
+
*
|
|
174
|
+
* Deduplicates Entities
|
|
175
|
+
*/
|
|
176
|
+
'post'(
|
|
177
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
178
|
+
data?: Paths.Deduplicate.RequestBody,
|
|
179
|
+
config?: AxiosRequestConfig
|
|
180
|
+
): OperationResponse<Paths.Deduplicate.Responses.$200>
|
|
181
|
+
}
|
|
182
|
+
['/v1/deduplicate/job']: {
|
|
183
|
+
/**
|
|
184
|
+
* deduplicateAsync - deduplicateAsync
|
|
185
|
+
*
|
|
186
|
+
* Submits an async deduplication job. Returns a job ID immediately. Poll GET /v1/deduplicate/jobs/{jobId} for status.
|
|
187
|
+
*/
|
|
188
|
+
'post'(
|
|
189
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
190
|
+
data?: Paths.DeduplicateAsync.RequestBody,
|
|
191
|
+
config?: AxiosRequestConfig
|
|
192
|
+
): OperationResponse<Paths.DeduplicateAsync.Responses.$202>
|
|
193
|
+
}
|
|
194
|
+
['/v1/deduplicate/jobs/{jobId}']: {
|
|
195
|
+
/**
|
|
196
|
+
* getDeduplicationJob - getDeduplicationJob
|
|
197
|
+
*
|
|
198
|
+
* Returns the current status of an async deduplication job
|
|
199
|
+
*/
|
|
200
|
+
'get'(
|
|
201
|
+
parameters?: Parameters<Paths.GetDeduplicationJob.PathParameters> | null,
|
|
202
|
+
data?: any,
|
|
203
|
+
config?: AxiosRequestConfig
|
|
204
|
+
): OperationResponse<Paths.GetDeduplicationJob.Responses.$200>
|
|
205
|
+
}
|
|
206
|
+
}
|
|
207
|
+
|
|
208
|
+
type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
type DeduplicateAsyncResponse = Components.Schemas.DeduplicateAsyncResponse;
|
|
212
|
+
type DeduplicateRequestBody = Components.Schemas.DeduplicateRequestBody;
|
|
213
|
+
type DeduplicateRequestResponse = Components.Schemas.DeduplicateRequestResponse;
|
|
214
|
+
type DeduplicationJob = Components.Schemas.DeduplicationJob;
|
|
215
|
+
type Entity = Components.Schemas.Entity;
|
|
216
|
+
type JobStatus = Components.Schemas.JobStatus;
|
|
217
|
+
|
|
218
|
+
export { type Client as C, type DeduplicateAsyncResponse as D, type Entity as E, type JobStatus as J, type OperationMethods as O, Paths as P, Components as a, type PathsDictionary as b, type DeduplicateRequestBody as c, type DeduplicateRequestResponse as d, type DeduplicationJob as e };
|
|
@@ -0,0 +1,218 @@
|
|
|
1
|
+
import { OpenAPIClient, Parameters, UnknownParamsObject, AxiosRequestConfig, OperationResponse } from 'openapi-client-axios';
|
|
2
|
+
|
|
3
|
+
/* Auto-copied from deduplication-client */
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
declare namespace Components {
|
|
7
|
+
namespace Schemas {
|
|
8
|
+
/**
|
|
9
|
+
* Response returned immediately when a deduplication job is submitted
|
|
10
|
+
*/
|
|
11
|
+
export interface DeduplicateAsyncResponse {
|
|
12
|
+
/**
|
|
13
|
+
* Job ID to poll for status via GET /v1/deduplicate/jobs/{jobId}
|
|
14
|
+
*/
|
|
15
|
+
jobId: string;
|
|
16
|
+
status: JobStatus;
|
|
17
|
+
/**
|
|
18
|
+
* Initial status message
|
|
19
|
+
*/
|
|
20
|
+
message: string;
|
|
21
|
+
}
|
|
22
|
+
export type DeduplicateRequestBody = {
|
|
23
|
+
toKeep: string;
|
|
24
|
+
toDelete: string[];
|
|
25
|
+
}[];
|
|
26
|
+
export type DeduplicateRequestResponse = /* Base Entity schema */ Entity[];
|
|
27
|
+
/**
|
|
28
|
+
* Represents an async deduplication job
|
|
29
|
+
*/
|
|
30
|
+
export interface DeduplicationJob {
|
|
31
|
+
/**
|
|
32
|
+
* Unique identifier for the deduplication job
|
|
33
|
+
*/
|
|
34
|
+
jobId: string;
|
|
35
|
+
status: JobStatus;
|
|
36
|
+
/**
|
|
37
|
+
* Human-readable status message (e.g. progress info or error details)
|
|
38
|
+
*/
|
|
39
|
+
message?: string;
|
|
40
|
+
/**
|
|
41
|
+
* Array of deduplicated entities, present when status is completed
|
|
42
|
+
*/
|
|
43
|
+
result?: /* Base Entity schema */ Entity[];
|
|
44
|
+
/**
|
|
45
|
+
* ISO 8601 timestamp of job creation
|
|
46
|
+
*/
|
|
47
|
+
createdAt: string; // date-time
|
|
48
|
+
/**
|
|
49
|
+
* ISO 8601 timestamp of last update
|
|
50
|
+
*/
|
|
51
|
+
updatedAt: string; // date-time
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* Base Entity schema
|
|
55
|
+
*/
|
|
56
|
+
export interface Entity {
|
|
57
|
+
/**
|
|
58
|
+
* Entity ID of the Deduplication entry
|
|
59
|
+
*/
|
|
60
|
+
_id: string;
|
|
61
|
+
/**
|
|
62
|
+
* ID of the Organization that owns this Deduplication
|
|
63
|
+
*/
|
|
64
|
+
_org?: string;
|
|
65
|
+
/**
|
|
66
|
+
* The Entity schema of this Deduplication
|
|
67
|
+
*/
|
|
68
|
+
_schema?: string;
|
|
69
|
+
/**
|
|
70
|
+
* The timestamp of when this Deduplication was created
|
|
71
|
+
*/
|
|
72
|
+
_created_at?: string; // date-time
|
|
73
|
+
/**
|
|
74
|
+
* The timestamp of when this Deduplication was last updated
|
|
75
|
+
*/
|
|
76
|
+
_updated_at?: string; // date-time
|
|
77
|
+
/**
|
|
78
|
+
* The Entity ID of the User that created this Deduplication
|
|
79
|
+
*/
|
|
80
|
+
_created_by?: /* The Entity ID of the User that created this Deduplication */ string | number;
|
|
81
|
+
/**
|
|
82
|
+
* The Entity ID of the User that created this Deduplication
|
|
83
|
+
*/
|
|
84
|
+
created_by?: /* The Entity ID of the User that created this Deduplication */ string | number;
|
|
85
|
+
/**
|
|
86
|
+
* Tags associated with this Deduplication
|
|
87
|
+
*/
|
|
88
|
+
_tags?: string[];
|
|
89
|
+
/**
|
|
90
|
+
* Access Control List for this Deduplication entry
|
|
91
|
+
*/
|
|
92
|
+
_acl?: {
|
|
93
|
+
[name: string]: string[];
|
|
94
|
+
};
|
|
95
|
+
_owners?: {
|
|
96
|
+
org_id: string;
|
|
97
|
+
user_id: string;
|
|
98
|
+
}[];
|
|
99
|
+
/**
|
|
100
|
+
* Entity ID of the Deduplication entry
|
|
101
|
+
*/
|
|
102
|
+
type?: string;
|
|
103
|
+
}
|
|
104
|
+
export type JobStatus = "pending" | "processing" | "completed" | "failed";
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
declare namespace Paths {
|
|
108
|
+
namespace Deduplicate {
|
|
109
|
+
export type RequestBody = Components.Schemas.DeduplicateRequestBody;
|
|
110
|
+
namespace Responses {
|
|
111
|
+
export type $200 = Components.Schemas.DeduplicateRequestResponse;
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
namespace DeduplicateAsync {
|
|
115
|
+
export type RequestBody = Components.Schemas.DeduplicateRequestBody;
|
|
116
|
+
namespace Responses {
|
|
117
|
+
export type $202 = /* Response returned immediately when a deduplication job is submitted */ Components.Schemas.DeduplicateAsyncResponse;
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
namespace GetDeduplicationJob {
|
|
121
|
+
namespace Parameters {
|
|
122
|
+
export type JobId = string;
|
|
123
|
+
}
|
|
124
|
+
export interface PathParameters {
|
|
125
|
+
jobId: Parameters.JobId;
|
|
126
|
+
}
|
|
127
|
+
namespace Responses {
|
|
128
|
+
export type $200 = /* Represents an async deduplication job */ Components.Schemas.DeduplicationJob;
|
|
129
|
+
export interface $404 {
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
interface OperationMethods {
|
|
137
|
+
/**
|
|
138
|
+
* deduplicate - deduplicate
|
|
139
|
+
*
|
|
140
|
+
* Deduplicates Entities
|
|
141
|
+
*/
|
|
142
|
+
'deduplicate'(
|
|
143
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
144
|
+
data?: Paths.Deduplicate.RequestBody,
|
|
145
|
+
config?: AxiosRequestConfig
|
|
146
|
+
): OperationResponse<Paths.Deduplicate.Responses.$200>
|
|
147
|
+
/**
|
|
148
|
+
* deduplicateAsync - deduplicateAsync
|
|
149
|
+
*
|
|
150
|
+
* Submits an async deduplication job. Returns a job ID immediately. Poll GET /v1/deduplicate/jobs/{jobId} for status.
|
|
151
|
+
*/
|
|
152
|
+
'deduplicateAsync'(
|
|
153
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
154
|
+
data?: Paths.DeduplicateAsync.RequestBody,
|
|
155
|
+
config?: AxiosRequestConfig
|
|
156
|
+
): OperationResponse<Paths.DeduplicateAsync.Responses.$202>
|
|
157
|
+
/**
|
|
158
|
+
* getDeduplicationJob - getDeduplicationJob
|
|
159
|
+
*
|
|
160
|
+
* Returns the current status of an async deduplication job
|
|
161
|
+
*/
|
|
162
|
+
'getDeduplicationJob'(
|
|
163
|
+
parameters?: Parameters<Paths.GetDeduplicationJob.PathParameters> | null,
|
|
164
|
+
data?: any,
|
|
165
|
+
config?: AxiosRequestConfig
|
|
166
|
+
): OperationResponse<Paths.GetDeduplicationJob.Responses.$200>
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
interface PathsDictionary {
|
|
170
|
+
['/v1/deduplicate']: {
|
|
171
|
+
/**
|
|
172
|
+
* deduplicate - deduplicate
|
|
173
|
+
*
|
|
174
|
+
* Deduplicates Entities
|
|
175
|
+
*/
|
|
176
|
+
'post'(
|
|
177
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
178
|
+
data?: Paths.Deduplicate.RequestBody,
|
|
179
|
+
config?: AxiosRequestConfig
|
|
180
|
+
): OperationResponse<Paths.Deduplicate.Responses.$200>
|
|
181
|
+
}
|
|
182
|
+
['/v1/deduplicate/job']: {
|
|
183
|
+
/**
|
|
184
|
+
* deduplicateAsync - deduplicateAsync
|
|
185
|
+
*
|
|
186
|
+
* Submits an async deduplication job. Returns a job ID immediately. Poll GET /v1/deduplicate/jobs/{jobId} for status.
|
|
187
|
+
*/
|
|
188
|
+
'post'(
|
|
189
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
190
|
+
data?: Paths.DeduplicateAsync.RequestBody,
|
|
191
|
+
config?: AxiosRequestConfig
|
|
192
|
+
): OperationResponse<Paths.DeduplicateAsync.Responses.$202>
|
|
193
|
+
}
|
|
194
|
+
['/v1/deduplicate/jobs/{jobId}']: {
|
|
195
|
+
/**
|
|
196
|
+
* getDeduplicationJob - getDeduplicationJob
|
|
197
|
+
*
|
|
198
|
+
* Returns the current status of an async deduplication job
|
|
199
|
+
*/
|
|
200
|
+
'get'(
|
|
201
|
+
parameters?: Parameters<Paths.GetDeduplicationJob.PathParameters> | null,
|
|
202
|
+
data?: any,
|
|
203
|
+
config?: AxiosRequestConfig
|
|
204
|
+
): OperationResponse<Paths.GetDeduplicationJob.Responses.$200>
|
|
205
|
+
}
|
|
206
|
+
}
|
|
207
|
+
|
|
208
|
+
type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
type DeduplicateAsyncResponse = Components.Schemas.DeduplicateAsyncResponse;
|
|
212
|
+
type DeduplicateRequestBody = Components.Schemas.DeduplicateRequestBody;
|
|
213
|
+
type DeduplicateRequestResponse = Components.Schemas.DeduplicateRequestResponse;
|
|
214
|
+
type DeduplicationJob = Components.Schemas.DeduplicationJob;
|
|
215
|
+
type Entity = Components.Schemas.Entity;
|
|
216
|
+
type JobStatus = Components.Schemas.JobStatus;
|
|
217
|
+
|
|
218
|
+
export { type Client as C, type DeduplicateAsyncResponse as D, type Entity as E, type JobStatus as J, type OperationMethods as O, Paths as P, Components as a, type PathsDictionary as b, type DeduplicateRequestBody as c, type DeduplicateRequestResponse as d, type DeduplicationJob as e };
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
|
|
2
|
+
|
|
3
|
+
// src/docs/design.json
|
|
4
|
+
var design_default = '# Design Builder API v2\n\n- **Base URL:** `https://design-builder-api.{environment}.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\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 "emailaddress": "string",\n "fullname": "string",\n "name": "string",\n "userid": "string"\n },\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 }\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 "shape": {\n "border_radius": 0\n },\n "consumer": {\n "widgets": [\n {\n "id": "string",\n "name": "string"\n }\n ],\n "customer_portals": [\n {\n "id": "string",\n "name": "string"\n }\n ]\n }\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 }\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 main: {\n name: \'string\',\n display_name: \'string\',\n file_type: \'LOGO\',\n s3_object_key: \'string\',\n url: \'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 shape: {\n border_radius: 0\n },\n consumer: {\n widgets: [\n {\n id: \'string\',\n name: \'string\'\n }\n ],\n customer_portals: [\n {\n id: \'string\',\n name: \'string\'\n }\n ]\n }\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 }\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 "main": {\n "name": "string",\n "display_name": "string",\n "file_type": "LOGO",\n "s3_object_key": "string",\n "url": "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 "shape": {\n "border_radius": 0\n },\n "consumer": {\n "widgets": [\n {\n "id": "string",\n "name": "string"\n }\n ],\n "customer_portals": [\n {\n "id": "string",\n "name": "string"\n }\n ]\n }\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 }\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 "main": {\n "name": "string",\n "display_name": "string",\n "file_type": "LOGO",\n "s3_object_key": "string",\n "url": "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 "shape": {\n "border_radius": 0\n },\n "consumer": {\n "widgets": [\n {\n "id": "string",\n "name": "string"\n }\n ],\n "customer_portals": [\n {\n "id": "string",\n "name": "string"\n }\n ]\n }\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 }\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 main: {\n name: \'string\',\n display_name: \'string\',\n file_type: \'LOGO\',\n s3_object_key: \'string\',\n url: \'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 shape: {\n border_radius: 0\n },\n consumer: {\n widgets: [\n {\n id: \'string\',\n name: \'string\'\n }\n ],\n customer_portals: [\n {\n id: \'string\',\n name: \'string\'\n }\n ]\n }\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 }\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```\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}\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 }\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 "main": {\n "name": "string",\n "display_name": "string",\n "file_type": "LOGO",\n "s3_object_key": "string",\n "url": "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 "shape": {\n "border_radius": 0\n },\n "consumer": {\n "widgets": [\n {\n "id": "string",\n "name": "string"\n }\n ],\n "customer_portals": [\n {\n "id": "string",\n "name": "string"\n }\n ]\n }\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 }\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"\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"\n s3_object_key: string\n url: string\n}\n```\n\n### `GetFilesRes`\n\n```ts\ntype GetFilesRes = Array<{\n name: string\n display_name?: string\n file_type?: "LOGO" | "FONT"\n s3_object_key: string\n url: 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 }\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 }\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 }\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 }\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 }\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 }\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"\n s3_object_key: string\n url: 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"\n s3_object_key: string\n url: 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';
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
exports.default = design_default;
|
|
@@ -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.{environment}.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\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 "emailaddress": "string",\n "fullname": "string",\n "name": "string",\n "userid": "string"\n },\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 }\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 "shape": {\n "border_radius": 0\n },\n "consumer": {\n "widgets": [\n {\n "id": "string",\n "name": "string"\n }\n ],\n "customer_portals": [\n {\n "id": "string",\n "name": "string"\n }\n ]\n }\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 }\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 main: {\n name: \'string\',\n display_name: \'string\',\n file_type: \'LOGO\',\n s3_object_key: \'string\',\n url: \'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 shape: {\n border_radius: 0\n },\n consumer: {\n widgets: [\n {\n id: \'string\',\n name: \'string\'\n }\n ],\n customer_portals: [\n {\n id: \'string\',\n name: \'string\'\n }\n ]\n }\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 }\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 "main": {\n "name": "string",\n "display_name": "string",\n "file_type": "LOGO",\n "s3_object_key": "string",\n "url": "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 "shape": {\n "border_radius": 0\n },\n "consumer": {\n "widgets": [\n {\n "id": "string",\n "name": "string"\n }\n ],\n "customer_portals": [\n {\n "id": "string",\n "name": "string"\n }\n ]\n }\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 }\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 "main": {\n "name": "string",\n "display_name": "string",\n "file_type": "LOGO",\n "s3_object_key": "string",\n "url": "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 "shape": {\n "border_radius": 0\n },\n "consumer": {\n "widgets": [\n {\n "id": "string",\n "name": "string"\n }\n ],\n "customer_portals": [\n {\n "id": "string",\n "name": "string"\n }\n ]\n }\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 }\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 main: {\n name: \'string\',\n display_name: \'string\',\n file_type: \'LOGO\',\n s3_object_key: \'string\',\n url: \'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 shape: {\n border_radius: 0\n },\n consumer: {\n widgets: [\n {\n id: \'string\',\n name: \'string\'\n }\n ],\n customer_portals: [\n {\n id: \'string\',\n name: \'string\'\n }\n ]\n }\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 }\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```\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}\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 }\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 "main": {\n "name": "string",\n "display_name": "string",\n "file_type": "LOGO",\n "s3_object_key": "string",\n "url": "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 "shape": {\n "border_radius": 0\n },\n "consumer": {\n "widgets": [\n {\n "id": "string",\n "name": "string"\n }\n ],\n "customer_portals": [\n {\n "id": "string",\n "name": "string"\n }\n ]\n }\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 }\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"\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"\n s3_object_key: string\n url: string\n}\n```\n\n### `GetFilesRes`\n\n```ts\ntype GetFilesRes = Array<{\n name: string\n display_name?: string\n file_type?: "LOGO" | "FONT"\n s3_object_key: string\n url: 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 }\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 }\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 }\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 }\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 }\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 }\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"\n s3_object_key: string\n url: 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"\n s3_object_key: string\n url: 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';
|
|
5
|
+
export {
|
|
6
|
+
design_default as default
|
|
7
|
+
};
|