@epilot/sdk 2.0.0-alpha.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +294 -0
- package/dist/access-token-MYDOBCIY.cjs +89 -0
- package/dist/access-token-Y5JR7PRG.js +89 -0
- package/dist/access-token.d-C2qnueDV.d.cts +553 -0
- package/dist/access-token.d-C2qnueDV.d.ts +553 -0
- package/dist/address-3RQRG3MK.js +84 -0
- package/dist/address-LQUTDOUA.cjs +84 -0
- package/dist/address-suggestions-PEKSA7B2.cjs +132 -0
- package/dist/address-suggestions-QNK5JWNH.js +132 -0
- package/dist/address-suggestions.d-CewXYNYH.d.cts +340 -0
- package/dist/address-suggestions.d-CewXYNYH.d.ts +340 -0
- package/dist/address.d-DP_aE2ex.d.cts +438 -0
- package/dist/address.d-DP_aE2ex.d.ts +438 -0
- package/dist/ai-agents-MO4PK2RJ.cjs +215 -0
- package/dist/ai-agents-OHP2F243.js +215 -0
- package/dist/ai-agents.d-vG-1utqk.d.cts +1340 -0
- package/dist/ai-agents.d-vG-1utqk.d.ts +1340 -0
- package/dist/apis/access-token.cjs +33 -0
- package/dist/apis/access-token.d.cts +18 -0
- package/dist/apis/access-token.d.ts +18 -0
- package/dist/apis/access-token.js +33 -0
- package/dist/apis/address-suggestions.cjs +33 -0
- package/dist/apis/address-suggestions.d.cts +18 -0
- package/dist/apis/address-suggestions.d.ts +18 -0
- package/dist/apis/address-suggestions.js +33 -0
- package/dist/apis/address.cjs +33 -0
- package/dist/apis/address.d.cts +18 -0
- package/dist/apis/address.d.ts +18 -0
- package/dist/apis/address.js +33 -0
- package/dist/apis/ai-agents.cjs +33 -0
- package/dist/apis/ai-agents.d.cts +18 -0
- package/dist/apis/ai-agents.d.ts +18 -0
- package/dist/apis/ai-agents.js +33 -0
- package/dist/apis/app.cjs +33 -0
- package/dist/apis/app.d.cts +18 -0
- package/dist/apis/app.d.ts +18 -0
- package/dist/apis/app.js +33 -0
- package/dist/apis/audit-logs.cjs +33 -0
- package/dist/apis/audit-logs.d.cts +18 -0
- package/dist/apis/audit-logs.d.ts +18 -0
- package/dist/apis/audit-logs.js +33 -0
- package/dist/apis/automation.cjs +33 -0
- package/dist/apis/automation.d.cts +18 -0
- package/dist/apis/automation.d.ts +18 -0
- package/dist/apis/automation.js +33 -0
- package/dist/apis/billing.cjs +33 -0
- package/dist/apis/billing.d.cts +18 -0
- package/dist/apis/billing.d.ts +18 -0
- package/dist/apis/billing.js +33 -0
- package/dist/apis/blueprint-manifest.cjs +33 -0
- package/dist/apis/blueprint-manifest.d.cts +18 -0
- package/dist/apis/blueprint-manifest.d.ts +18 -0
- package/dist/apis/blueprint-manifest.js +33 -0
- package/dist/apis/consent.cjs +33 -0
- package/dist/apis/consent.d.cts +18 -0
- package/dist/apis/consent.d.ts +18 -0
- package/dist/apis/consent.js +33 -0
- package/dist/apis/customer-portal.cjs +33 -0
- package/dist/apis/customer-portal.d.cts +18 -0
- package/dist/apis/customer-portal.d.ts +18 -0
- package/dist/apis/customer-portal.js +33 -0
- package/dist/apis/data-management.cjs +33 -0
- package/dist/apis/data-management.d.cts +18 -0
- package/dist/apis/data-management.d.ts +18 -0
- package/dist/apis/data-management.js +33 -0
- package/dist/apis/deduplication.cjs +33 -0
- package/dist/apis/deduplication.d.cts +18 -0
- package/dist/apis/deduplication.d.ts +18 -0
- package/dist/apis/deduplication.js +33 -0
- package/dist/apis/design.cjs +33 -0
- package/dist/apis/design.d.cts +18 -0
- package/dist/apis/design.d.ts +18 -0
- package/dist/apis/design.js +33 -0
- package/dist/apis/discussion.cjs +33 -0
- package/dist/apis/discussion.d.cts +18 -0
- package/dist/apis/discussion.d.ts +18 -0
- package/dist/apis/discussion.js +33 -0
- package/dist/apis/document.cjs +33 -0
- package/dist/apis/document.d.cts +18 -0
- package/dist/apis/document.d.ts +18 -0
- package/dist/apis/document.js +33 -0
- package/dist/apis/email-settings.cjs +33 -0
- package/dist/apis/email-settings.d.cts +18 -0
- package/dist/apis/email-settings.d.ts +18 -0
- package/dist/apis/email-settings.js +33 -0
- package/dist/apis/email-template.cjs +33 -0
- package/dist/apis/email-template.d.cts +18 -0
- package/dist/apis/email-template.d.ts +18 -0
- package/dist/apis/email-template.js +33 -0
- package/dist/apis/entity-mapping.cjs +33 -0
- package/dist/apis/entity-mapping.d.cts +18 -0
- package/dist/apis/entity-mapping.d.ts +18 -0
- package/dist/apis/entity-mapping.js +33 -0
- package/dist/apis/entity.cjs +33 -0
- package/dist/apis/entity.d.cts +18 -0
- package/dist/apis/entity.d.ts +18 -0
- package/dist/apis/entity.js +33 -0
- package/dist/apis/environments.cjs +33 -0
- package/dist/apis/environments.d.cts +18 -0
- package/dist/apis/environments.d.ts +18 -0
- package/dist/apis/environments.js +33 -0
- package/dist/apis/erp-integration.cjs +33 -0
- package/dist/apis/erp-integration.d.cts +18 -0
- package/dist/apis/erp-integration.d.ts +18 -0
- package/dist/apis/erp-integration.js +33 -0
- package/dist/apis/event-catalog.cjs +33 -0
- package/dist/apis/event-catalog.d.cts +18 -0
- package/dist/apis/event-catalog.d.ts +18 -0
- package/dist/apis/event-catalog.js +33 -0
- package/dist/apis/file.cjs +33 -0
- package/dist/apis/file.d.cts +18 -0
- package/dist/apis/file.d.ts +18 -0
- package/dist/apis/file.js +33 -0
- package/dist/apis/iban.cjs +33 -0
- package/dist/apis/iban.d.cts +18 -0
- package/dist/apis/iban.d.ts +18 -0
- package/dist/apis/iban.js +33 -0
- package/dist/apis/journey.cjs +33 -0
- package/dist/apis/journey.d.cts +18 -0
- package/dist/apis/journey.d.ts +18 -0
- package/dist/apis/journey.js +33 -0
- package/dist/apis/kanban.cjs +33 -0
- package/dist/apis/kanban.d.cts +18 -0
- package/dist/apis/kanban.d.ts +18 -0
- package/dist/apis/kanban.js +33 -0
- package/dist/apis/message.cjs +33 -0
- package/dist/apis/message.d.cts +18 -0
- package/dist/apis/message.d.ts +18 -0
- package/dist/apis/message.js +33 -0
- package/dist/apis/metering.cjs +33 -0
- package/dist/apis/metering.d.cts +18 -0
- package/dist/apis/metering.d.ts +18 -0
- package/dist/apis/metering.js +33 -0
- package/dist/apis/notes.cjs +33 -0
- package/dist/apis/notes.d.cts +18 -0
- package/dist/apis/notes.d.ts +18 -0
- package/dist/apis/notes.js +33 -0
- package/dist/apis/notification.cjs +33 -0
- package/dist/apis/notification.d.cts +18 -0
- package/dist/apis/notification.d.ts +18 -0
- package/dist/apis/notification.js +33 -0
- package/dist/apis/organization.cjs +33 -0
- package/dist/apis/organization.d.cts +18 -0
- package/dist/apis/organization.d.ts +18 -0
- package/dist/apis/organization.js +33 -0
- package/dist/apis/partner-directory.cjs +33 -0
- package/dist/apis/partner-directory.d.cts +18 -0
- package/dist/apis/partner-directory.d.ts +18 -0
- package/dist/apis/partner-directory.js +33 -0
- package/dist/apis/permissions.cjs +33 -0
- package/dist/apis/permissions.d.cts +18 -0
- package/dist/apis/permissions.d.ts +18 -0
- package/dist/apis/permissions.js +33 -0
- package/dist/apis/pricing-tier.cjs +33 -0
- package/dist/apis/pricing-tier.d.cts +18 -0
- package/dist/apis/pricing-tier.d.ts +18 -0
- package/dist/apis/pricing-tier.js +33 -0
- package/dist/apis/pricing.cjs +33 -0
- package/dist/apis/pricing.d.cts +18 -0
- package/dist/apis/pricing.d.ts +18 -0
- package/dist/apis/pricing.js +33 -0
- package/dist/apis/purpose.cjs +33 -0
- package/dist/apis/purpose.d.cts +18 -0
- package/dist/apis/purpose.d.ts +18 -0
- package/dist/apis/purpose.js +33 -0
- package/dist/apis/sandbox.cjs +33 -0
- package/dist/apis/sandbox.d.cts +18 -0
- package/dist/apis/sandbox.d.ts +18 -0
- package/dist/apis/sandbox.js +33 -0
- package/dist/apis/submission.cjs +33 -0
- package/dist/apis/submission.d.cts +18 -0
- package/dist/apis/submission.d.ts +18 -0
- package/dist/apis/submission.js +33 -0
- package/dist/apis/targeting.cjs +33 -0
- package/dist/apis/targeting.d.cts +18 -0
- package/dist/apis/targeting.d.ts +18 -0
- package/dist/apis/targeting.js +33 -0
- package/dist/apis/template-variables.cjs +33 -0
- package/dist/apis/template-variables.d.cts +18 -0
- package/dist/apis/template-variables.d.ts +18 -0
- package/dist/apis/template-variables.js +33 -0
- package/dist/apis/user.cjs +33 -0
- package/dist/apis/user.d.cts +18 -0
- package/dist/apis/user.d.ts +18 -0
- package/dist/apis/user.js +33 -0
- package/dist/apis/validation-rules.cjs +33 -0
- package/dist/apis/validation-rules.d.cts +18 -0
- package/dist/apis/validation-rules.d.ts +18 -0
- package/dist/apis/validation-rules.js +33 -0
- package/dist/apis/webhooks.cjs +33 -0
- package/dist/apis/webhooks.d.cts +18 -0
- package/dist/apis/webhooks.d.ts +18 -0
- package/dist/apis/webhooks.js +33 -0
- package/dist/apis/workflow-definition.cjs +33 -0
- package/dist/apis/workflow-definition.d.cts +18 -0
- package/dist/apis/workflow-definition.d.ts +18 -0
- package/dist/apis/workflow-definition.js +33 -0
- package/dist/apis/workflow.cjs +33 -0
- package/dist/apis/workflow.d.cts +18 -0
- package/dist/apis/workflow.d.ts +18 -0
- package/dist/apis/workflow.js +33 -0
- package/dist/app-UUTBO3WJ.js +573 -0
- package/dist/app-XJGY6SHO.cjs +573 -0
- package/dist/app.d-Uncn387s.d.cts +3370 -0
- package/dist/app.d-Uncn387s.d.ts +3370 -0
- package/dist/audit-logs-4IJYIOXF.js +55 -0
- package/dist/audit-logs-UWLCPBB4.cjs +55 -0
- package/dist/audit-logs.d-BxZqONu5.d.cts +288 -0
- package/dist/audit-logs.d-BxZqONu5.d.ts +288 -0
- package/dist/automation-4UQADTDO.cjs +282 -0
- package/dist/automation-PVXTQLZX.js +282 -0
- package/dist/automation.d-BteCzeFn.d.cts +4921 -0
- package/dist/automation.d-BteCzeFn.d.ts +4921 -0
- package/dist/billing-FI4V4UX5.cjs +175 -0
- package/dist/billing-OMWNJHGW.js +175 -0
- package/dist/billing.d-BH4__05Y.d.cts +994 -0
- package/dist/billing.d-BH4__05Y.d.ts +994 -0
- package/dist/bin/cli.js +135 -0
- package/dist/blueprint-manifest-CPQAL76N.cjs +504 -0
- package/dist/blueprint-manifest-FIMGDHSH.js +504 -0
- package/dist/blueprint-manifest.d-CU4v09fj.d.cts +3327 -0
- package/dist/blueprint-manifest.d-CU4v09fj.d.ts +3327 -0
- package/dist/chunk-3RG5ZIWI.js +10 -0
- package/dist/chunk-OBGZSXTJ.cjs +10 -0
- package/dist/chunk-UJTFRZMS.js +65 -0
- package/dist/chunk-YLLKMXS3.cjs +65 -0
- package/dist/consent-NHDCDJMK.js +84 -0
- package/dist/consent-R5GU3WCK.cjs +84 -0
- package/dist/consent.d-BETWwU_2.d.cts +266 -0
- package/dist/consent.d-BETWwU_2.d.ts +266 -0
- package/dist/customer-portal-6AV2W43T.cjs +2252 -0
- package/dist/customer-portal-EY57GJYV.js +2252 -0
- package/dist/customer-portal.d-Co_I6psR.d.cts +15255 -0
- package/dist/customer-portal.d-Co_I6psR.d.ts +15255 -0
- package/dist/data-management-ILQUYNTN.cjs +240 -0
- package/dist/data-management-QMXOLOEG.js +240 -0
- package/dist/data-management.d-CkR2E_Pm.d.cts +548 -0
- package/dist/data-management.d-CkR2E_Pm.d.ts +548 -0
- package/dist/deduplication-IVXANO7S.cjs +42 -0
- package/dist/deduplication-WN45DVK3.js +42 -0
- package/dist/deduplication.d-BlHnjhXk.d.cts +114 -0
- package/dist/deduplication.d-BlHnjhXk.d.ts +114 -0
- package/dist/design-ONRLY6XI.cjs +219 -0
- package/dist/design-UHMRO3PG.js +219 -0
- package/dist/design.d-JsNY_cGh.d.cts +834 -0
- package/dist/design.d-JsNY_cGh.d.ts +834 -0
- package/dist/discussion-4CZIG3ZM.cjs +134 -0
- package/dist/discussion-VWMWL2AF.js +134 -0
- package/dist/discussion.d-CxxaYKTf.d.cts +580 -0
- package/dist/discussion.d-CxxaYKTf.d.ts +580 -0
- package/dist/document-CN3JNXFF.js +78 -0
- package/dist/document-PCKNZA4K.cjs +78 -0
- package/dist/document.d-CZ_FGhEn.d.cts +649 -0
- package/dist/document.d-CZ_FGhEn.d.ts +649 -0
- package/dist/email-settings-ANURQMKZ.js +533 -0
- package/dist/email-settings-YE2XB2ZU.cjs +533 -0
- package/dist/email-settings.d-3eXYEyRr.d.cts +2278 -0
- package/dist/email-settings.d-3eXYEyRr.d.ts +2278 -0
- package/dist/email-template-4QI4YS4J.js +122 -0
- package/dist/email-template-BUJBC6HH.cjs +122 -0
- package/dist/email-template.d-C2L0dKqB.d.cts +1175 -0
- package/dist/email-template.d-C2L0dKqB.d.ts +1175 -0
- package/dist/entity-BCFE3UJT.cjs +1600 -0
- package/dist/entity-VEXNQC4Y.js +1600 -0
- package/dist/entity-mapping-PHRLSYP7.cjs +215 -0
- package/dist/entity-mapping-QK7MGNAW.js +215 -0
- package/dist/entity-mapping.d-B3Vyepok.d.cts +1093 -0
- package/dist/entity-mapping.d-B3Vyepok.d.ts +1093 -0
- package/dist/entity.d-DmER_7q5.d.cts +16018 -0
- package/dist/entity.d-DmER_7q5.d.ts +16018 -0
- package/dist/environments-266S44UM.cjs +71 -0
- package/dist/environments-AV7W6SLT.js +71 -0
- package/dist/environments.d-CpILpSNF.d.cts +254 -0
- package/dist/environments.d-CpILpSNF.d.ts +254 -0
- package/dist/erp-integration-5WNBCGWS.cjs +586 -0
- package/dist/erp-integration-EMI5WIWA.js +586 -0
- package/dist/erp-integration.d-DmxUZOUQ.d.cts +4120 -0
- package/dist/erp-integration.d-DmxUZOUQ.d.ts +4120 -0
- package/dist/event-catalog-DBWYKQ6J.cjs +130 -0
- package/dist/event-catalog-KKMXV5LB.js +130 -0
- package/dist/event-catalog.d-B2tq20gn.d.cts +1512 -0
- package/dist/event-catalog.d-B2tq20gn.d.ts +1512 -0
- package/dist/file-3ZLMS6TL.js +573 -0
- package/dist/file-Q66N5XMG.cjs +573 -0
- package/dist/file.d-Bi0EZkNu.d.cts +2993 -0
- package/dist/file.d-Bi0EZkNu.d.ts +2993 -0
- package/dist/iban-HSXVSIFW.cjs +43 -0
- package/dist/iban-Q27INTOC.js +43 -0
- package/dist/iban.d-DP7hl0Qt.d.cts +71 -0
- package/dist/iban.d-DP7hl0Qt.d.ts +71 -0
- package/dist/index.cjs +563 -0
- package/dist/index.d.cts +119 -0
- package/dist/index.d.ts +119 -0
- package/dist/index.js +563 -0
- package/dist/journey-DGKXVWZQ.js +270 -0
- package/dist/journey-T2Y72EBS.cjs +270 -0
- package/dist/journey.d-DxL16X6N.d.cts +1794 -0
- package/dist/journey.d-DxL16X6N.d.ts +1794 -0
- package/dist/kanban-A4B6RCJ2.cjs +164 -0
- package/dist/kanban-PP6WJVT2.js +164 -0
- package/dist/kanban.d-DDrBwr9h.d.cts +631 -0
- package/dist/kanban.d-DDrBwr9h.d.ts +631 -0
- package/dist/message-D6JY4GJH.cjs +673 -0
- package/dist/message-HFX2DDCV.js +673 -0
- package/dist/message.d-BeBH6vof.d.cts +3580 -0
- package/dist/message.d-BeBH6vof.d.ts +3580 -0
- package/dist/metering-63MJFCS2.cjs +399 -0
- package/dist/metering-F63PNFCZ.js +399 -0
- package/dist/metering.d-D5VR4tVa.d.cts +1842 -0
- package/dist/metering.d-D5VR4tVa.d.ts +1842 -0
- package/dist/notes-FTL5H4JE.cjs +219 -0
- package/dist/notes-GMWTQCMB.js +219 -0
- package/dist/notes.d-DZYeVo0I.d.cts +1047 -0
- package/dist/notes.d-DZYeVo0I.d.ts +1047 -0
- package/dist/notification-WXFSOORN.cjs +237 -0
- package/dist/notification-XHG3TIBW.js +237 -0
- package/dist/notification.d-BJwdFZnG.d.cts +1148 -0
- package/dist/notification.d-BJwdFZnG.d.ts +1148 -0
- package/dist/organization-CPXTUDJO.js +118 -0
- package/dist/organization-XIFV7MWP.cjs +118 -0
- package/dist/organization.d-DfUcuwKM.d.cts +629 -0
- package/dist/organization.d-DfUcuwKM.d.ts +629 -0
- package/dist/partner-directory-4WCHPJRO.js +282 -0
- package/dist/partner-directory-FKWPPO7F.cjs +282 -0
- package/dist/partner-directory.d-BRRDHFcz.d.cts +1511 -0
- package/dist/partner-directory.d-BRRDHFcz.d.ts +1511 -0
- package/dist/permissions-5E36GPG3.js +178 -0
- package/dist/permissions-PBTK5CCD.cjs +178 -0
- package/dist/permissions.d-CL7SwMFy.d.cts +1253 -0
- package/dist/permissions.d-CL7SwMFy.d.ts +1253 -0
- package/dist/pricing-FDWEBIQU.js +439 -0
- package/dist/pricing-FZQKL4DW.cjs +439 -0
- package/dist/pricing-tier-34O624R4.js +36 -0
- package/dist/pricing-tier-F4HE6WIM.cjs +36 -0
- package/dist/pricing-tier.d-VuH-NtlR.d.cts +82 -0
- package/dist/pricing-tier.d-VuH-NtlR.d.ts +82 -0
- package/dist/pricing.d-Dd1CaSX_.d.cts +12201 -0
- package/dist/pricing.d-Dd1CaSX_.d.ts +12201 -0
- package/dist/purpose-47HJIG2Q.cjs +180 -0
- package/dist/purpose-MX33NU5H.js +180 -0
- package/dist/purpose.d-D8YCSqt9.d.cts +373 -0
- package/dist/purpose.d-D8YCSqt9.d.ts +373 -0
- package/dist/sandbox-7QNLGFN2.cjs +100 -0
- package/dist/sandbox-TZCXHBJN.js +100 -0
- package/dist/sandbox.d-D1NgPMEc.d.cts +466 -0
- package/dist/sandbox.d-D1NgPMEc.d.ts +466 -0
- package/dist/submission-6LSPBI27.js +55 -0
- package/dist/submission-DBQNDJ4B.cjs +55 -0
- package/dist/submission.d-e9MPrbY1.d.cts +470 -0
- package/dist/submission.d-e9MPrbY1.d.ts +470 -0
- package/dist/targeting-HZRCLNIF.cjs +275 -0
- package/dist/targeting-MTQ6JBCY.js +275 -0
- package/dist/targeting.d-1GW3nh-y.d.cts +2058 -0
- package/dist/targeting.d-1GW3nh-y.d.ts +2058 -0
- package/dist/template-variables-S6IXK7SF.js +159 -0
- package/dist/template-variables-VPNIMC7L.cjs +159 -0
- package/dist/template-variables.d-CqqGe3sd.d.cts +1315 -0
- package/dist/template-variables.d-CqqGe3sd.d.ts +1315 -0
- package/dist/types-C5cGIwtq.d.cts +28 -0
- package/dist/types-C5cGIwtq.d.ts +28 -0
- package/dist/user-BHH4DAA5.cjs +488 -0
- package/dist/user-KBXFVRPI.js +488 -0
- package/dist/user.d-CWBgUia2.d.cts +2199 -0
- package/dist/user.d-CWBgUia2.d.ts +2199 -0
- package/dist/validation-rules-4V7KAWGW.cjs +120 -0
- package/dist/validation-rules-UGQY4ASY.js +120 -0
- package/dist/validation-rules.d-CMSvveua.d.cts +808 -0
- package/dist/validation-rules.d-CMSvveua.d.ts +808 -0
- package/dist/webhooks-JR475VD4.js +252 -0
- package/dist/webhooks-X64U3KCB.cjs +252 -0
- package/dist/webhooks.d-Bzl-u_Zs.d.cts +1201 -0
- package/dist/webhooks.d-Bzl-u_Zs.d.ts +1201 -0
- package/dist/workflow-7ANPQZDP.cjs +402 -0
- package/dist/workflow-DWSAHA5Q.js +402 -0
- package/dist/workflow-definition-2M3JBCUI.cjs +342 -0
- package/dist/workflow-definition-WLPGEU55.js +342 -0
- package/dist/workflow-definition.d-BKmIy2Qp.d.cts +2030 -0
- package/dist/workflow-definition.d-BKmIy2Qp.d.ts +2030 -0
- package/dist/workflow.d-DElz0XoQ.d.cts +3017 -0
- package/dist/workflow.d-DElz0XoQ.d.ts +3017 -0
- package/package.json +289 -0
|
@@ -0,0 +1,2058 @@
|
|
|
1
|
+
import { OpenAPIClient, Parameters, AxiosRequestConfig, OperationResponse, UnknownParamsObject } from 'openapi-client-axios';
|
|
2
|
+
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/* Auto-copied from targeting-client */
|
|
5
|
+
/* eslint-disable */
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
declare namespace Components {
|
|
10
|
+
namespace Parameters {
|
|
11
|
+
export type CampaignIdPathParam = /**
|
|
12
|
+
* example:
|
|
13
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
14
|
+
*/
|
|
15
|
+
Schemas.BaseUUID /* uuid */;
|
|
16
|
+
export type RecipientIdPathParam = /**
|
|
17
|
+
* example:
|
|
18
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
19
|
+
*/
|
|
20
|
+
Schemas.BaseUUID /* uuid */;
|
|
21
|
+
}
|
|
22
|
+
export interface PathParameters {
|
|
23
|
+
CampaignIdPathParam?: Parameters.CampaignIdPathParam;
|
|
24
|
+
RecipientIdPathParam?: Parameters.RecipientIdPathParam;
|
|
25
|
+
}
|
|
26
|
+
namespace Responses {
|
|
27
|
+
export type CampaignPortalsResponse = {
|
|
28
|
+
portal: {
|
|
29
|
+
/**
|
|
30
|
+
* The origin of the portal
|
|
31
|
+
*/
|
|
32
|
+
origin?: string;
|
|
33
|
+
/**
|
|
34
|
+
* The domain of the portal
|
|
35
|
+
*/
|
|
36
|
+
domain?: string;
|
|
37
|
+
/**
|
|
38
|
+
* The name of the portal
|
|
39
|
+
*/
|
|
40
|
+
name?: string;
|
|
41
|
+
};
|
|
42
|
+
widgets: {
|
|
43
|
+
/**
|
|
44
|
+
* The ID of the widget
|
|
45
|
+
*/
|
|
46
|
+
id: string;
|
|
47
|
+
headline?: {
|
|
48
|
+
/**
|
|
49
|
+
* The headline in English
|
|
50
|
+
*/
|
|
51
|
+
en?: string;
|
|
52
|
+
/**
|
|
53
|
+
* The headline in German
|
|
54
|
+
*/
|
|
55
|
+
de?: string;
|
|
56
|
+
};
|
|
57
|
+
}[];
|
|
58
|
+
}[];
|
|
59
|
+
export interface CampaignResponse {
|
|
60
|
+
campaign?: Schemas.Campaign;
|
|
61
|
+
}
|
|
62
|
+
export type ClientErrorResponse = /**
|
|
63
|
+
* Describes the structure of a client error response, which can be one of several types:
|
|
64
|
+
* 1. `MessageError`: Contains a 'message' field for general descriptive errors.
|
|
65
|
+
* 2. `CodeError`: Contains a 'code' field for specific, machine-readable error codes.
|
|
66
|
+
* 3. `StatusedError`: Contains 'error' and 'status' fields.
|
|
67
|
+
* The HTTP status code of the response itself (e.g., 400, 404, 409) will always indicate the overall error category.
|
|
68
|
+
*
|
|
69
|
+
*/
|
|
70
|
+
Schemas.ClientError;
|
|
71
|
+
export interface GetTargetQueriesResponse {
|
|
72
|
+
/**
|
|
73
|
+
* List of target query results.
|
|
74
|
+
*/
|
|
75
|
+
results: Schemas.TargetQueryResult[];
|
|
76
|
+
}
|
|
77
|
+
export type JobStatusResponse = Schemas.JobStatus;
|
|
78
|
+
export interface MatchCampaignsResponse {
|
|
79
|
+
/**
|
|
80
|
+
* Number of matching campaigns.
|
|
81
|
+
*/
|
|
82
|
+
hits?: number;
|
|
83
|
+
/**
|
|
84
|
+
* List of matching campaigns.
|
|
85
|
+
*/
|
|
86
|
+
results?: {
|
|
87
|
+
campaign: Schemas.Campaign;
|
|
88
|
+
}[];
|
|
89
|
+
}
|
|
90
|
+
export interface MatchTargetsResponse {
|
|
91
|
+
/**
|
|
92
|
+
* Number of matching targets.
|
|
93
|
+
*/
|
|
94
|
+
hits?: number;
|
|
95
|
+
/**
|
|
96
|
+
* List of matching targets.
|
|
97
|
+
*/
|
|
98
|
+
results?: {
|
|
99
|
+
target: Schemas.Target;
|
|
100
|
+
}[];
|
|
101
|
+
}
|
|
102
|
+
export type RecipientResponse = Schemas.Recipient;
|
|
103
|
+
export interface RecipientsResponse {
|
|
104
|
+
results?: Schemas.Recipient[];
|
|
105
|
+
/**
|
|
106
|
+
* Cursor for next page of results
|
|
107
|
+
*/
|
|
108
|
+
next?: string | null;
|
|
109
|
+
/**
|
|
110
|
+
* Total number of recipients
|
|
111
|
+
*/
|
|
112
|
+
total?: number;
|
|
113
|
+
}
|
|
114
|
+
export interface RetriggerAutomationsResponse {
|
|
115
|
+
/**
|
|
116
|
+
* A confirmation message indicating the request was received and processed
|
|
117
|
+
*/
|
|
118
|
+
message: string;
|
|
119
|
+
/**
|
|
120
|
+
* List of retriggering results
|
|
121
|
+
*/
|
|
122
|
+
results: Schemas.RetriggerAutomationsResult[];
|
|
123
|
+
}
|
|
124
|
+
export type ServerErrorResponse = Schemas.ServerError;
|
|
125
|
+
}
|
|
126
|
+
namespace Schemas {
|
|
127
|
+
export interface AutomationRecipientPayload {
|
|
128
|
+
automation_status: AutomationStatus;
|
|
129
|
+
automation_execution_id: string;
|
|
130
|
+
}
|
|
131
|
+
export type AutomationStatus = "pending" | "in_progress" | "success" | "failed" | "cancelled";
|
|
132
|
+
/**
|
|
133
|
+
* Access control list (ACL) for an entity. Defines sharing access to external orgs or users.
|
|
134
|
+
*/
|
|
135
|
+
export interface BaseEntityAcl {
|
|
136
|
+
[name: string]: any;
|
|
137
|
+
view?: string[];
|
|
138
|
+
edit?: string[];
|
|
139
|
+
delete?: string[];
|
|
140
|
+
}
|
|
141
|
+
/**
|
|
142
|
+
* The user / organization owning this entity.
|
|
143
|
+
*
|
|
144
|
+
* Note: Owner implicitly has access to the entity regardless of ACLs.
|
|
145
|
+
*
|
|
146
|
+
*/
|
|
147
|
+
export interface BaseEntityOwner {
|
|
148
|
+
/**
|
|
149
|
+
* example:
|
|
150
|
+
* 123
|
|
151
|
+
*/
|
|
152
|
+
org_id: string;
|
|
153
|
+
/**
|
|
154
|
+
* example:
|
|
155
|
+
* 123
|
|
156
|
+
*/
|
|
157
|
+
user_id?: string;
|
|
158
|
+
}
|
|
159
|
+
export interface BaseError {
|
|
160
|
+
/**
|
|
161
|
+
* example:
|
|
162
|
+
* 404
|
|
163
|
+
*/
|
|
164
|
+
status: number;
|
|
165
|
+
/**
|
|
166
|
+
* example:
|
|
167
|
+
* Entity not found
|
|
168
|
+
*/
|
|
169
|
+
message: string;
|
|
170
|
+
}
|
|
171
|
+
/**
|
|
172
|
+
* example:
|
|
173
|
+
* xHcOoJCa07eysJ1GaQeSb
|
|
174
|
+
*/
|
|
175
|
+
export type BaseNanoID = string;
|
|
176
|
+
export interface BaseRecipientPayload {
|
|
177
|
+
entity_id: /**
|
|
178
|
+
* example:
|
|
179
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
180
|
+
*/
|
|
181
|
+
BaseUUID /* uuid */;
|
|
182
|
+
entity_schema: string;
|
|
183
|
+
}
|
|
184
|
+
export interface BaseRelation {
|
|
185
|
+
$relation?: {
|
|
186
|
+
entity_id?: /**
|
|
187
|
+
* example:
|
|
188
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
189
|
+
*/
|
|
190
|
+
BaseUUID /* uuid */;
|
|
191
|
+
_tags?: BaseTags;
|
|
192
|
+
}[];
|
|
193
|
+
}
|
|
194
|
+
export interface BaseSystemFields {
|
|
195
|
+
_id?: /**
|
|
196
|
+
* example:
|
|
197
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
198
|
+
*/
|
|
199
|
+
BaseUUID /* uuid */;
|
|
200
|
+
/**
|
|
201
|
+
* Organization Id the entity belongs to
|
|
202
|
+
*/
|
|
203
|
+
_org?: string;
|
|
204
|
+
_owners?: /**
|
|
205
|
+
* The user / organization owning this entity.
|
|
206
|
+
*
|
|
207
|
+
* Note: Owner implicitly has access to the entity regardless of ACLs.
|
|
208
|
+
*
|
|
209
|
+
*/
|
|
210
|
+
BaseEntityOwner[];
|
|
211
|
+
_schema?: string;
|
|
212
|
+
_title?: string;
|
|
213
|
+
_tags?: BaseTags;
|
|
214
|
+
_created_at?: string; // date-time
|
|
215
|
+
_updated_at?: string; // date-time
|
|
216
|
+
_acl?: /* Access control list (ACL) for an entity. Defines sharing access to external orgs or users. */ BaseEntityAcl;
|
|
217
|
+
}
|
|
218
|
+
export interface BaseSystemFieldsRequired {
|
|
219
|
+
}
|
|
220
|
+
export interface BaseSystemId {
|
|
221
|
+
_id: /**
|
|
222
|
+
* example:
|
|
223
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
224
|
+
*/
|
|
225
|
+
BaseUUID /* uuid */;
|
|
226
|
+
}
|
|
227
|
+
export type BaseTags = string[] | null;
|
|
228
|
+
/**
|
|
229
|
+
* example:
|
|
230
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
231
|
+
*/
|
|
232
|
+
export type BaseUUID = string; // uuid
|
|
233
|
+
export interface Campaign {
|
|
234
|
+
_id?: /**
|
|
235
|
+
* example:
|
|
236
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
237
|
+
*/
|
|
238
|
+
BaseUUID /* uuid */;
|
|
239
|
+
/**
|
|
240
|
+
* Organization Id the entity belongs to
|
|
241
|
+
*/
|
|
242
|
+
_org?: string;
|
|
243
|
+
_owners?: /**
|
|
244
|
+
* The user / organization owning this entity.
|
|
245
|
+
*
|
|
246
|
+
* Note: Owner implicitly has access to the entity regardless of ACLs.
|
|
247
|
+
*
|
|
248
|
+
*/
|
|
249
|
+
BaseEntityOwner[];
|
|
250
|
+
_schema?: string;
|
|
251
|
+
_title?: string;
|
|
252
|
+
_tags?: BaseTags;
|
|
253
|
+
_created_at?: string; // date-time
|
|
254
|
+
_updated_at?: string; // date-time
|
|
255
|
+
_acl?: /* Access control list (ACL) for an entity. Defines sharing access to external orgs or users. */ BaseEntityAcl;
|
|
256
|
+
name?: string;
|
|
257
|
+
goal?: string;
|
|
258
|
+
status?: CampaignStatus;
|
|
259
|
+
start_date?: string; // date
|
|
260
|
+
end_date?: string; // date
|
|
261
|
+
flow_id?: string;
|
|
262
|
+
job_id?: string;
|
|
263
|
+
target?: BaseRelation;
|
|
264
|
+
}
|
|
265
|
+
export type CampaignStatus = "draft" | "activating" | "active" | "inactive";
|
|
266
|
+
/**
|
|
267
|
+
* Describes the structure of a client error response, which can be one of several types:
|
|
268
|
+
* 1. `MessageError`: Contains a 'message' field for general descriptive errors.
|
|
269
|
+
* 2. `CodeError`: Contains a 'code' field for specific, machine-readable error codes.
|
|
270
|
+
* 3. `StatusedError`: Contains 'error' and 'status' fields.
|
|
271
|
+
* The HTTP status code of the response itself (e.g., 400, 404, 409) will always indicate the overall error category.
|
|
272
|
+
*
|
|
273
|
+
*/
|
|
274
|
+
export type ClientError = /**
|
|
275
|
+
* Describes the structure of a client error response, which can be one of several types:
|
|
276
|
+
* 1. `MessageError`: Contains a 'message' field for general descriptive errors.
|
|
277
|
+
* 2. `CodeError`: Contains a 'code' field for specific, machine-readable error codes.
|
|
278
|
+
* 3. `StatusedError`: Contains 'error' and 'status' fields.
|
|
279
|
+
* The HTTP status code of the response itself (e.g., 400, 404, 409) will always indicate the overall error category.
|
|
280
|
+
*
|
|
281
|
+
*/
|
|
282
|
+
{
|
|
283
|
+
/**
|
|
284
|
+
* A descriptive error message.
|
|
285
|
+
* example:
|
|
286
|
+
* The provided input was invalid.
|
|
287
|
+
*/
|
|
288
|
+
message: string;
|
|
289
|
+
} | {
|
|
290
|
+
/**
|
|
291
|
+
* A specific machine-readable error code indicating a known error condition.
|
|
292
|
+
* example:
|
|
293
|
+
* CAMPAIGN_NOT_FOUND
|
|
294
|
+
*/
|
|
295
|
+
code: "CAMPAIGN_NOT_FOUND" | "CAMPAIGN_HAS_NO_TARGET" | "CAMPAIGN_HAS_NO_DELIVERY_METHOD" | "CAMPAIGN_HAS_JOB_IN_PROGRESS" | "CAMPAIGN_HAS_UNEXPECTED_STATUS" | "JOB_TOKEN_MISSING" | "TARGET_WITHOUT_FILTERS";
|
|
296
|
+
} | {
|
|
297
|
+
/**
|
|
298
|
+
* A descriptive error message.
|
|
299
|
+
* example:
|
|
300
|
+
* An unexpected error occurred during processing.
|
|
301
|
+
*/
|
|
302
|
+
error: string;
|
|
303
|
+
/**
|
|
304
|
+
* An explicit status code in the body, often mirroring the HTTP status but provided for programmatic access.
|
|
305
|
+
* example:
|
|
306
|
+
* 400
|
|
307
|
+
*/
|
|
308
|
+
status: number;
|
|
309
|
+
};
|
|
310
|
+
export type CreateRecipientPayload = {
|
|
311
|
+
entity_id: /**
|
|
312
|
+
* example:
|
|
313
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
314
|
+
*/
|
|
315
|
+
BaseUUID /* uuid */;
|
|
316
|
+
entity_schema: string;
|
|
317
|
+
automation_status: AutomationStatus;
|
|
318
|
+
automation_execution_id: string;
|
|
319
|
+
} | {
|
|
320
|
+
entity_id: /**
|
|
321
|
+
* example:
|
|
322
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
323
|
+
*/
|
|
324
|
+
BaseUUID /* uuid */;
|
|
325
|
+
entity_schema: string;
|
|
326
|
+
portal_status: PortalStatus;
|
|
327
|
+
portal_state?: {
|
|
328
|
+
[name: string]: any;
|
|
329
|
+
};
|
|
330
|
+
} | {
|
|
331
|
+
entity_id: /**
|
|
332
|
+
* example:
|
|
333
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
334
|
+
*/
|
|
335
|
+
BaseUUID /* uuid */;
|
|
336
|
+
entity_schema: string;
|
|
337
|
+
automation_status: AutomationStatus;
|
|
338
|
+
automation_execution_id: string;
|
|
339
|
+
portal_status: PortalStatus;
|
|
340
|
+
portal_state?: {
|
|
341
|
+
[name: string]: any;
|
|
342
|
+
};
|
|
343
|
+
};
|
|
344
|
+
export interface ExecutionSummaryItem {
|
|
345
|
+
execution_id?: string;
|
|
346
|
+
execution_status?: string;
|
|
347
|
+
}
|
|
348
|
+
export interface GetTargetQueriesParams {
|
|
349
|
+
/**
|
|
350
|
+
* List of target IDs to transform into queries.
|
|
351
|
+
* example:
|
|
352
|
+
* [
|
|
353
|
+
* "b8c01433-5556-4e2b-aad4-6f5348d1df84"
|
|
354
|
+
* ]
|
|
355
|
+
*/
|
|
356
|
+
target_ids: [
|
|
357
|
+
/**
|
|
358
|
+
* example:
|
|
359
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
360
|
+
*/
|
|
361
|
+
BaseUUID /* uuid */,
|
|
362
|
+
.../**
|
|
363
|
+
* example:
|
|
364
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
365
|
+
*/
|
|
366
|
+
BaseUUID /* uuid */[]
|
|
367
|
+
];
|
|
368
|
+
}
|
|
369
|
+
export interface JobStatus {
|
|
370
|
+
/**
|
|
371
|
+
* The status of the automation job
|
|
372
|
+
*/
|
|
373
|
+
status?: "queued" | "processing" | "finished" | "failed" | "cancelled" | "send_report";
|
|
374
|
+
execution_summary?: ExecutionSummaryItem[];
|
|
375
|
+
}
|
|
376
|
+
export interface MatchCampaignParams {
|
|
377
|
+
/**
|
|
378
|
+
* List of entities (e.g. Contacts or Contracts) that should be part of the campaign target.
|
|
379
|
+
*/
|
|
380
|
+
entity_refs: {
|
|
381
|
+
entity_id: /**
|
|
382
|
+
* example:
|
|
383
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
384
|
+
*/
|
|
385
|
+
BaseUUID /* uuid */;
|
|
386
|
+
entity_schema: string;
|
|
387
|
+
}[];
|
|
388
|
+
/**
|
|
389
|
+
* List of campaign IDs to check.
|
|
390
|
+
* example:
|
|
391
|
+
* [
|
|
392
|
+
* "b8c01433-5556-4e2b-aad4-6f5348d1df84"
|
|
393
|
+
* ]
|
|
394
|
+
*/
|
|
395
|
+
campaign_ids: [
|
|
396
|
+
/**
|
|
397
|
+
* example:
|
|
398
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
399
|
+
*/
|
|
400
|
+
BaseUUID /* uuid */,
|
|
401
|
+
/**
|
|
402
|
+
* example:
|
|
403
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
404
|
+
*/
|
|
405
|
+
BaseUUID /* uuid */?,
|
|
406
|
+
/**
|
|
407
|
+
* example:
|
|
408
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
409
|
+
*/
|
|
410
|
+
BaseUUID /* uuid */?,
|
|
411
|
+
/**
|
|
412
|
+
* example:
|
|
413
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
414
|
+
*/
|
|
415
|
+
BaseUUID /* uuid */?,
|
|
416
|
+
/**
|
|
417
|
+
* example:
|
|
418
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
419
|
+
*/
|
|
420
|
+
BaseUUID /* uuid */?,
|
|
421
|
+
/**
|
|
422
|
+
* example:
|
|
423
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
424
|
+
*/
|
|
425
|
+
BaseUUID /* uuid */?,
|
|
426
|
+
/**
|
|
427
|
+
* example:
|
|
428
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
429
|
+
*/
|
|
430
|
+
BaseUUID /* uuid */?,
|
|
431
|
+
/**
|
|
432
|
+
* example:
|
|
433
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
434
|
+
*/
|
|
435
|
+
BaseUUID /* uuid */?,
|
|
436
|
+
/**
|
|
437
|
+
* example:
|
|
438
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
439
|
+
*/
|
|
440
|
+
BaseUUID /* uuid */?,
|
|
441
|
+
/**
|
|
442
|
+
* example:
|
|
443
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
444
|
+
*/
|
|
445
|
+
BaseUUID /* uuid */?,
|
|
446
|
+
/**
|
|
447
|
+
* example:
|
|
448
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
449
|
+
*/
|
|
450
|
+
BaseUUID /* uuid */?,
|
|
451
|
+
/**
|
|
452
|
+
* example:
|
|
453
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
454
|
+
*/
|
|
455
|
+
BaseUUID /* uuid */?,
|
|
456
|
+
/**
|
|
457
|
+
* example:
|
|
458
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
459
|
+
*/
|
|
460
|
+
BaseUUID /* uuid */?,
|
|
461
|
+
/**
|
|
462
|
+
* example:
|
|
463
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
464
|
+
*/
|
|
465
|
+
BaseUUID /* uuid */?,
|
|
466
|
+
/**
|
|
467
|
+
* example:
|
|
468
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
469
|
+
*/
|
|
470
|
+
BaseUUID /* uuid */?,
|
|
471
|
+
/**
|
|
472
|
+
* example:
|
|
473
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
474
|
+
*/
|
|
475
|
+
BaseUUID /* uuid */?,
|
|
476
|
+
/**
|
|
477
|
+
* example:
|
|
478
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
479
|
+
*/
|
|
480
|
+
BaseUUID /* uuid */?,
|
|
481
|
+
/**
|
|
482
|
+
* example:
|
|
483
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
484
|
+
*/
|
|
485
|
+
BaseUUID /* uuid */?,
|
|
486
|
+
/**
|
|
487
|
+
* example:
|
|
488
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
489
|
+
*/
|
|
490
|
+
BaseUUID /* uuid */?,
|
|
491
|
+
/**
|
|
492
|
+
* example:
|
|
493
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
494
|
+
*/
|
|
495
|
+
BaseUUID /* uuid */?,
|
|
496
|
+
/**
|
|
497
|
+
* example:
|
|
498
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
499
|
+
*/
|
|
500
|
+
BaseUUID /* uuid */?,
|
|
501
|
+
/**
|
|
502
|
+
* example:
|
|
503
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
504
|
+
*/
|
|
505
|
+
BaseUUID /* uuid */?,
|
|
506
|
+
/**
|
|
507
|
+
* example:
|
|
508
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
509
|
+
*/
|
|
510
|
+
BaseUUID /* uuid */?,
|
|
511
|
+
/**
|
|
512
|
+
* example:
|
|
513
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
514
|
+
*/
|
|
515
|
+
BaseUUID /* uuid */?,
|
|
516
|
+
/**
|
|
517
|
+
* example:
|
|
518
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
519
|
+
*/
|
|
520
|
+
BaseUUID /* uuid */?,
|
|
521
|
+
/**
|
|
522
|
+
* example:
|
|
523
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
524
|
+
*/
|
|
525
|
+
BaseUUID /* uuid */?,
|
|
526
|
+
/**
|
|
527
|
+
* example:
|
|
528
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
529
|
+
*/
|
|
530
|
+
BaseUUID /* uuid */?,
|
|
531
|
+
/**
|
|
532
|
+
* example:
|
|
533
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
534
|
+
*/
|
|
535
|
+
BaseUUID /* uuid */?,
|
|
536
|
+
/**
|
|
537
|
+
* example:
|
|
538
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
539
|
+
*/
|
|
540
|
+
BaseUUID /* uuid */?,
|
|
541
|
+
/**
|
|
542
|
+
* example:
|
|
543
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
544
|
+
*/
|
|
545
|
+
BaseUUID /* uuid */?,
|
|
546
|
+
/**
|
|
547
|
+
* example:
|
|
548
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
549
|
+
*/
|
|
550
|
+
BaseUUID /* uuid */?,
|
|
551
|
+
/**
|
|
552
|
+
* example:
|
|
553
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
554
|
+
*/
|
|
555
|
+
BaseUUID /* uuid */?,
|
|
556
|
+
/**
|
|
557
|
+
* example:
|
|
558
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
559
|
+
*/
|
|
560
|
+
BaseUUID /* uuid */?,
|
|
561
|
+
/**
|
|
562
|
+
* example:
|
|
563
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
564
|
+
*/
|
|
565
|
+
BaseUUID /* uuid */?,
|
|
566
|
+
/**
|
|
567
|
+
* example:
|
|
568
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
569
|
+
*/
|
|
570
|
+
BaseUUID /* uuid */?,
|
|
571
|
+
/**
|
|
572
|
+
* example:
|
|
573
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
574
|
+
*/
|
|
575
|
+
BaseUUID /* uuid */?,
|
|
576
|
+
/**
|
|
577
|
+
* example:
|
|
578
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
579
|
+
*/
|
|
580
|
+
BaseUUID /* uuid */?,
|
|
581
|
+
/**
|
|
582
|
+
* example:
|
|
583
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
584
|
+
*/
|
|
585
|
+
BaseUUID /* uuid */?,
|
|
586
|
+
/**
|
|
587
|
+
* example:
|
|
588
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
589
|
+
*/
|
|
590
|
+
BaseUUID /* uuid */?,
|
|
591
|
+
/**
|
|
592
|
+
* example:
|
|
593
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
594
|
+
*/
|
|
595
|
+
BaseUUID /* uuid */?,
|
|
596
|
+
/**
|
|
597
|
+
* example:
|
|
598
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
599
|
+
*/
|
|
600
|
+
BaseUUID /* uuid */?,
|
|
601
|
+
/**
|
|
602
|
+
* example:
|
|
603
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
604
|
+
*/
|
|
605
|
+
BaseUUID /* uuid */?,
|
|
606
|
+
/**
|
|
607
|
+
* example:
|
|
608
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
609
|
+
*/
|
|
610
|
+
BaseUUID /* uuid */?,
|
|
611
|
+
/**
|
|
612
|
+
* example:
|
|
613
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
614
|
+
*/
|
|
615
|
+
BaseUUID /* uuid */?,
|
|
616
|
+
/**
|
|
617
|
+
* example:
|
|
618
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
619
|
+
*/
|
|
620
|
+
BaseUUID /* uuid */?,
|
|
621
|
+
/**
|
|
622
|
+
* example:
|
|
623
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
624
|
+
*/
|
|
625
|
+
BaseUUID /* uuid */?,
|
|
626
|
+
/**
|
|
627
|
+
* example:
|
|
628
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
629
|
+
*/
|
|
630
|
+
BaseUUID /* uuid */?,
|
|
631
|
+
/**
|
|
632
|
+
* example:
|
|
633
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
634
|
+
*/
|
|
635
|
+
BaseUUID /* uuid */?,
|
|
636
|
+
/**
|
|
637
|
+
* example:
|
|
638
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
639
|
+
*/
|
|
640
|
+
BaseUUID /* uuid */?,
|
|
641
|
+
/**
|
|
642
|
+
* example:
|
|
643
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
644
|
+
*/
|
|
645
|
+
BaseUUID /* uuid */?,
|
|
646
|
+
/**
|
|
647
|
+
* example:
|
|
648
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
649
|
+
*/
|
|
650
|
+
BaseUUID /* uuid */?,
|
|
651
|
+
/**
|
|
652
|
+
* example:
|
|
653
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
654
|
+
*/
|
|
655
|
+
BaseUUID /* uuid */?,
|
|
656
|
+
/**
|
|
657
|
+
* example:
|
|
658
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
659
|
+
*/
|
|
660
|
+
BaseUUID /* uuid */?,
|
|
661
|
+
/**
|
|
662
|
+
* example:
|
|
663
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
664
|
+
*/
|
|
665
|
+
BaseUUID /* uuid */?,
|
|
666
|
+
/**
|
|
667
|
+
* example:
|
|
668
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
669
|
+
*/
|
|
670
|
+
BaseUUID /* uuid */?,
|
|
671
|
+
/**
|
|
672
|
+
* example:
|
|
673
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
674
|
+
*/
|
|
675
|
+
BaseUUID /* uuid */?,
|
|
676
|
+
/**
|
|
677
|
+
* example:
|
|
678
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
679
|
+
*/
|
|
680
|
+
BaseUUID /* uuid */?,
|
|
681
|
+
/**
|
|
682
|
+
* example:
|
|
683
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
684
|
+
*/
|
|
685
|
+
BaseUUID /* uuid */?,
|
|
686
|
+
/**
|
|
687
|
+
* example:
|
|
688
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
689
|
+
*/
|
|
690
|
+
BaseUUID /* uuid */?,
|
|
691
|
+
/**
|
|
692
|
+
* example:
|
|
693
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
694
|
+
*/
|
|
695
|
+
BaseUUID /* uuid */?,
|
|
696
|
+
/**
|
|
697
|
+
* example:
|
|
698
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
699
|
+
*/
|
|
700
|
+
BaseUUID /* uuid */?,
|
|
701
|
+
/**
|
|
702
|
+
* example:
|
|
703
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
704
|
+
*/
|
|
705
|
+
BaseUUID /* uuid */?,
|
|
706
|
+
/**
|
|
707
|
+
* example:
|
|
708
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
709
|
+
*/
|
|
710
|
+
BaseUUID /* uuid */?,
|
|
711
|
+
/**
|
|
712
|
+
* example:
|
|
713
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
714
|
+
*/
|
|
715
|
+
BaseUUID /* uuid */?,
|
|
716
|
+
/**
|
|
717
|
+
* example:
|
|
718
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
719
|
+
*/
|
|
720
|
+
BaseUUID /* uuid */?,
|
|
721
|
+
/**
|
|
722
|
+
* example:
|
|
723
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
724
|
+
*/
|
|
725
|
+
BaseUUID /* uuid */?,
|
|
726
|
+
/**
|
|
727
|
+
* example:
|
|
728
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
729
|
+
*/
|
|
730
|
+
BaseUUID /* uuid */?,
|
|
731
|
+
/**
|
|
732
|
+
* example:
|
|
733
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
734
|
+
*/
|
|
735
|
+
BaseUUID /* uuid */?,
|
|
736
|
+
/**
|
|
737
|
+
* example:
|
|
738
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
739
|
+
*/
|
|
740
|
+
BaseUUID /* uuid */?,
|
|
741
|
+
/**
|
|
742
|
+
* example:
|
|
743
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
744
|
+
*/
|
|
745
|
+
BaseUUID /* uuid */?,
|
|
746
|
+
/**
|
|
747
|
+
* example:
|
|
748
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
749
|
+
*/
|
|
750
|
+
BaseUUID /* uuid */?,
|
|
751
|
+
/**
|
|
752
|
+
* example:
|
|
753
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
754
|
+
*/
|
|
755
|
+
BaseUUID /* uuid */?,
|
|
756
|
+
/**
|
|
757
|
+
* example:
|
|
758
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
759
|
+
*/
|
|
760
|
+
BaseUUID /* uuid */?,
|
|
761
|
+
/**
|
|
762
|
+
* example:
|
|
763
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
764
|
+
*/
|
|
765
|
+
BaseUUID /* uuid */?,
|
|
766
|
+
/**
|
|
767
|
+
* example:
|
|
768
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
769
|
+
*/
|
|
770
|
+
BaseUUID /* uuid */?,
|
|
771
|
+
/**
|
|
772
|
+
* example:
|
|
773
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
774
|
+
*/
|
|
775
|
+
BaseUUID /* uuid */?,
|
|
776
|
+
/**
|
|
777
|
+
* example:
|
|
778
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
779
|
+
*/
|
|
780
|
+
BaseUUID /* uuid */?,
|
|
781
|
+
/**
|
|
782
|
+
* example:
|
|
783
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
784
|
+
*/
|
|
785
|
+
BaseUUID /* uuid */?,
|
|
786
|
+
/**
|
|
787
|
+
* example:
|
|
788
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
789
|
+
*/
|
|
790
|
+
BaseUUID /* uuid */?,
|
|
791
|
+
/**
|
|
792
|
+
* example:
|
|
793
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
794
|
+
*/
|
|
795
|
+
BaseUUID /* uuid */?,
|
|
796
|
+
/**
|
|
797
|
+
* example:
|
|
798
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
799
|
+
*/
|
|
800
|
+
BaseUUID /* uuid */?,
|
|
801
|
+
/**
|
|
802
|
+
* example:
|
|
803
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
804
|
+
*/
|
|
805
|
+
BaseUUID /* uuid */?,
|
|
806
|
+
/**
|
|
807
|
+
* example:
|
|
808
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
809
|
+
*/
|
|
810
|
+
BaseUUID /* uuid */?,
|
|
811
|
+
/**
|
|
812
|
+
* example:
|
|
813
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
814
|
+
*/
|
|
815
|
+
BaseUUID /* uuid */?,
|
|
816
|
+
/**
|
|
817
|
+
* example:
|
|
818
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
819
|
+
*/
|
|
820
|
+
BaseUUID /* uuid */?,
|
|
821
|
+
/**
|
|
822
|
+
* example:
|
|
823
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
824
|
+
*/
|
|
825
|
+
BaseUUID /* uuid */?,
|
|
826
|
+
/**
|
|
827
|
+
* example:
|
|
828
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
829
|
+
*/
|
|
830
|
+
BaseUUID /* uuid */?,
|
|
831
|
+
/**
|
|
832
|
+
* example:
|
|
833
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
834
|
+
*/
|
|
835
|
+
BaseUUID /* uuid */?,
|
|
836
|
+
/**
|
|
837
|
+
* example:
|
|
838
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
839
|
+
*/
|
|
840
|
+
BaseUUID /* uuid */?,
|
|
841
|
+
/**
|
|
842
|
+
* example:
|
|
843
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
844
|
+
*/
|
|
845
|
+
BaseUUID /* uuid */?,
|
|
846
|
+
/**
|
|
847
|
+
* example:
|
|
848
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
849
|
+
*/
|
|
850
|
+
BaseUUID /* uuid */?,
|
|
851
|
+
/**
|
|
852
|
+
* example:
|
|
853
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
854
|
+
*/
|
|
855
|
+
BaseUUID /* uuid */?,
|
|
856
|
+
/**
|
|
857
|
+
* example:
|
|
858
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
859
|
+
*/
|
|
860
|
+
BaseUUID /* uuid */?,
|
|
861
|
+
/**
|
|
862
|
+
* example:
|
|
863
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
864
|
+
*/
|
|
865
|
+
BaseUUID /* uuid */?,
|
|
866
|
+
/**
|
|
867
|
+
* example:
|
|
868
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
869
|
+
*/
|
|
870
|
+
BaseUUID /* uuid */?,
|
|
871
|
+
/**
|
|
872
|
+
* example:
|
|
873
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
874
|
+
*/
|
|
875
|
+
BaseUUID /* uuid */?,
|
|
876
|
+
/**
|
|
877
|
+
* example:
|
|
878
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
879
|
+
*/
|
|
880
|
+
BaseUUID /* uuid */?,
|
|
881
|
+
/**
|
|
882
|
+
* example:
|
|
883
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
884
|
+
*/
|
|
885
|
+
BaseUUID /* uuid */?,
|
|
886
|
+
/**
|
|
887
|
+
* example:
|
|
888
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
889
|
+
*/
|
|
890
|
+
BaseUUID /* uuid */?,
|
|
891
|
+
/**
|
|
892
|
+
* example:
|
|
893
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
894
|
+
*/
|
|
895
|
+
BaseUUID /* uuid */?
|
|
896
|
+
];
|
|
897
|
+
}
|
|
898
|
+
export interface MatchTargetParams {
|
|
899
|
+
/**
|
|
900
|
+
* List of entities (e.g. Contacts or Contracts) that should be part of the targets.
|
|
901
|
+
*/
|
|
902
|
+
entity_refs: {
|
|
903
|
+
entity_id: /**
|
|
904
|
+
* example:
|
|
905
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
906
|
+
*/
|
|
907
|
+
BaseUUID /* uuid */;
|
|
908
|
+
entity_schema: string;
|
|
909
|
+
}[];
|
|
910
|
+
/**
|
|
911
|
+
* List of target IDs to check.
|
|
912
|
+
* example:
|
|
913
|
+
* [
|
|
914
|
+
* "b8c01433-5556-4e2b-aad4-6f5348d1df84"
|
|
915
|
+
* ]
|
|
916
|
+
*/
|
|
917
|
+
target_ids: [
|
|
918
|
+
/**
|
|
919
|
+
* example:
|
|
920
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
921
|
+
*/
|
|
922
|
+
BaseUUID /* uuid */,
|
|
923
|
+
/**
|
|
924
|
+
* example:
|
|
925
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
926
|
+
*/
|
|
927
|
+
BaseUUID /* uuid */?,
|
|
928
|
+
/**
|
|
929
|
+
* example:
|
|
930
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
931
|
+
*/
|
|
932
|
+
BaseUUID /* uuid */?,
|
|
933
|
+
/**
|
|
934
|
+
* example:
|
|
935
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
936
|
+
*/
|
|
937
|
+
BaseUUID /* uuid */?,
|
|
938
|
+
/**
|
|
939
|
+
* example:
|
|
940
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
941
|
+
*/
|
|
942
|
+
BaseUUID /* uuid */?,
|
|
943
|
+
/**
|
|
944
|
+
* example:
|
|
945
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
946
|
+
*/
|
|
947
|
+
BaseUUID /* uuid */?,
|
|
948
|
+
/**
|
|
949
|
+
* example:
|
|
950
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
951
|
+
*/
|
|
952
|
+
BaseUUID /* uuid */?,
|
|
953
|
+
/**
|
|
954
|
+
* example:
|
|
955
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
956
|
+
*/
|
|
957
|
+
BaseUUID /* uuid */?,
|
|
958
|
+
/**
|
|
959
|
+
* example:
|
|
960
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
961
|
+
*/
|
|
962
|
+
BaseUUID /* uuid */?,
|
|
963
|
+
/**
|
|
964
|
+
* example:
|
|
965
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
966
|
+
*/
|
|
967
|
+
BaseUUID /* uuid */?,
|
|
968
|
+
/**
|
|
969
|
+
* example:
|
|
970
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
971
|
+
*/
|
|
972
|
+
BaseUUID /* uuid */?,
|
|
973
|
+
/**
|
|
974
|
+
* example:
|
|
975
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
976
|
+
*/
|
|
977
|
+
BaseUUID /* uuid */?,
|
|
978
|
+
/**
|
|
979
|
+
* example:
|
|
980
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
981
|
+
*/
|
|
982
|
+
BaseUUID /* uuid */?,
|
|
983
|
+
/**
|
|
984
|
+
* example:
|
|
985
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
986
|
+
*/
|
|
987
|
+
BaseUUID /* uuid */?,
|
|
988
|
+
/**
|
|
989
|
+
* example:
|
|
990
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
991
|
+
*/
|
|
992
|
+
BaseUUID /* uuid */?,
|
|
993
|
+
/**
|
|
994
|
+
* example:
|
|
995
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
996
|
+
*/
|
|
997
|
+
BaseUUID /* uuid */?,
|
|
998
|
+
/**
|
|
999
|
+
* example:
|
|
1000
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1001
|
+
*/
|
|
1002
|
+
BaseUUID /* uuid */?,
|
|
1003
|
+
/**
|
|
1004
|
+
* example:
|
|
1005
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1006
|
+
*/
|
|
1007
|
+
BaseUUID /* uuid */?,
|
|
1008
|
+
/**
|
|
1009
|
+
* example:
|
|
1010
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1011
|
+
*/
|
|
1012
|
+
BaseUUID /* uuid */?,
|
|
1013
|
+
/**
|
|
1014
|
+
* example:
|
|
1015
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1016
|
+
*/
|
|
1017
|
+
BaseUUID /* uuid */?,
|
|
1018
|
+
/**
|
|
1019
|
+
* example:
|
|
1020
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1021
|
+
*/
|
|
1022
|
+
BaseUUID /* uuid */?,
|
|
1023
|
+
/**
|
|
1024
|
+
* example:
|
|
1025
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1026
|
+
*/
|
|
1027
|
+
BaseUUID /* uuid */?,
|
|
1028
|
+
/**
|
|
1029
|
+
* example:
|
|
1030
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1031
|
+
*/
|
|
1032
|
+
BaseUUID /* uuid */?,
|
|
1033
|
+
/**
|
|
1034
|
+
* example:
|
|
1035
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1036
|
+
*/
|
|
1037
|
+
BaseUUID /* uuid */?,
|
|
1038
|
+
/**
|
|
1039
|
+
* example:
|
|
1040
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1041
|
+
*/
|
|
1042
|
+
BaseUUID /* uuid */?,
|
|
1043
|
+
/**
|
|
1044
|
+
* example:
|
|
1045
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1046
|
+
*/
|
|
1047
|
+
BaseUUID /* uuid */?,
|
|
1048
|
+
/**
|
|
1049
|
+
* example:
|
|
1050
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1051
|
+
*/
|
|
1052
|
+
BaseUUID /* uuid */?,
|
|
1053
|
+
/**
|
|
1054
|
+
* example:
|
|
1055
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1056
|
+
*/
|
|
1057
|
+
BaseUUID /* uuid */?,
|
|
1058
|
+
/**
|
|
1059
|
+
* example:
|
|
1060
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1061
|
+
*/
|
|
1062
|
+
BaseUUID /* uuid */?,
|
|
1063
|
+
/**
|
|
1064
|
+
* example:
|
|
1065
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1066
|
+
*/
|
|
1067
|
+
BaseUUID /* uuid */?,
|
|
1068
|
+
/**
|
|
1069
|
+
* example:
|
|
1070
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1071
|
+
*/
|
|
1072
|
+
BaseUUID /* uuid */?,
|
|
1073
|
+
/**
|
|
1074
|
+
* example:
|
|
1075
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1076
|
+
*/
|
|
1077
|
+
BaseUUID /* uuid */?,
|
|
1078
|
+
/**
|
|
1079
|
+
* example:
|
|
1080
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1081
|
+
*/
|
|
1082
|
+
BaseUUID /* uuid */?,
|
|
1083
|
+
/**
|
|
1084
|
+
* example:
|
|
1085
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1086
|
+
*/
|
|
1087
|
+
BaseUUID /* uuid */?,
|
|
1088
|
+
/**
|
|
1089
|
+
* example:
|
|
1090
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1091
|
+
*/
|
|
1092
|
+
BaseUUID /* uuid */?,
|
|
1093
|
+
/**
|
|
1094
|
+
* example:
|
|
1095
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1096
|
+
*/
|
|
1097
|
+
BaseUUID /* uuid */?,
|
|
1098
|
+
/**
|
|
1099
|
+
* example:
|
|
1100
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1101
|
+
*/
|
|
1102
|
+
BaseUUID /* uuid */?,
|
|
1103
|
+
/**
|
|
1104
|
+
* example:
|
|
1105
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1106
|
+
*/
|
|
1107
|
+
BaseUUID /* uuid */?,
|
|
1108
|
+
/**
|
|
1109
|
+
* example:
|
|
1110
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1111
|
+
*/
|
|
1112
|
+
BaseUUID /* uuid */?,
|
|
1113
|
+
/**
|
|
1114
|
+
* example:
|
|
1115
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1116
|
+
*/
|
|
1117
|
+
BaseUUID /* uuid */?,
|
|
1118
|
+
/**
|
|
1119
|
+
* example:
|
|
1120
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1121
|
+
*/
|
|
1122
|
+
BaseUUID /* uuid */?,
|
|
1123
|
+
/**
|
|
1124
|
+
* example:
|
|
1125
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1126
|
+
*/
|
|
1127
|
+
BaseUUID /* uuid */?,
|
|
1128
|
+
/**
|
|
1129
|
+
* example:
|
|
1130
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1131
|
+
*/
|
|
1132
|
+
BaseUUID /* uuid */?,
|
|
1133
|
+
/**
|
|
1134
|
+
* example:
|
|
1135
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1136
|
+
*/
|
|
1137
|
+
BaseUUID /* uuid */?,
|
|
1138
|
+
/**
|
|
1139
|
+
* example:
|
|
1140
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1141
|
+
*/
|
|
1142
|
+
BaseUUID /* uuid */?,
|
|
1143
|
+
/**
|
|
1144
|
+
* example:
|
|
1145
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1146
|
+
*/
|
|
1147
|
+
BaseUUID /* uuid */?,
|
|
1148
|
+
/**
|
|
1149
|
+
* example:
|
|
1150
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1151
|
+
*/
|
|
1152
|
+
BaseUUID /* uuid */?,
|
|
1153
|
+
/**
|
|
1154
|
+
* example:
|
|
1155
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1156
|
+
*/
|
|
1157
|
+
BaseUUID /* uuid */?,
|
|
1158
|
+
/**
|
|
1159
|
+
* example:
|
|
1160
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1161
|
+
*/
|
|
1162
|
+
BaseUUID /* uuid */?,
|
|
1163
|
+
/**
|
|
1164
|
+
* example:
|
|
1165
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1166
|
+
*/
|
|
1167
|
+
BaseUUID /* uuid */?,
|
|
1168
|
+
/**
|
|
1169
|
+
* example:
|
|
1170
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1171
|
+
*/
|
|
1172
|
+
BaseUUID /* uuid */?,
|
|
1173
|
+
/**
|
|
1174
|
+
* example:
|
|
1175
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1176
|
+
*/
|
|
1177
|
+
BaseUUID /* uuid */?,
|
|
1178
|
+
/**
|
|
1179
|
+
* example:
|
|
1180
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1181
|
+
*/
|
|
1182
|
+
BaseUUID /* uuid */?,
|
|
1183
|
+
/**
|
|
1184
|
+
* example:
|
|
1185
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1186
|
+
*/
|
|
1187
|
+
BaseUUID /* uuid */?,
|
|
1188
|
+
/**
|
|
1189
|
+
* example:
|
|
1190
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1191
|
+
*/
|
|
1192
|
+
BaseUUID /* uuid */?,
|
|
1193
|
+
/**
|
|
1194
|
+
* example:
|
|
1195
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1196
|
+
*/
|
|
1197
|
+
BaseUUID /* uuid */?,
|
|
1198
|
+
/**
|
|
1199
|
+
* example:
|
|
1200
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1201
|
+
*/
|
|
1202
|
+
BaseUUID /* uuid */?,
|
|
1203
|
+
/**
|
|
1204
|
+
* example:
|
|
1205
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1206
|
+
*/
|
|
1207
|
+
BaseUUID /* uuid */?,
|
|
1208
|
+
/**
|
|
1209
|
+
* example:
|
|
1210
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1211
|
+
*/
|
|
1212
|
+
BaseUUID /* uuid */?,
|
|
1213
|
+
/**
|
|
1214
|
+
* example:
|
|
1215
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1216
|
+
*/
|
|
1217
|
+
BaseUUID /* uuid */?,
|
|
1218
|
+
/**
|
|
1219
|
+
* example:
|
|
1220
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1221
|
+
*/
|
|
1222
|
+
BaseUUID /* uuid */?,
|
|
1223
|
+
/**
|
|
1224
|
+
* example:
|
|
1225
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1226
|
+
*/
|
|
1227
|
+
BaseUUID /* uuid */?,
|
|
1228
|
+
/**
|
|
1229
|
+
* example:
|
|
1230
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1231
|
+
*/
|
|
1232
|
+
BaseUUID /* uuid */?,
|
|
1233
|
+
/**
|
|
1234
|
+
* example:
|
|
1235
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1236
|
+
*/
|
|
1237
|
+
BaseUUID /* uuid */?,
|
|
1238
|
+
/**
|
|
1239
|
+
* example:
|
|
1240
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1241
|
+
*/
|
|
1242
|
+
BaseUUID /* uuid */?,
|
|
1243
|
+
/**
|
|
1244
|
+
* example:
|
|
1245
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1246
|
+
*/
|
|
1247
|
+
BaseUUID /* uuid */?,
|
|
1248
|
+
/**
|
|
1249
|
+
* example:
|
|
1250
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1251
|
+
*/
|
|
1252
|
+
BaseUUID /* uuid */?,
|
|
1253
|
+
/**
|
|
1254
|
+
* example:
|
|
1255
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1256
|
+
*/
|
|
1257
|
+
BaseUUID /* uuid */?,
|
|
1258
|
+
/**
|
|
1259
|
+
* example:
|
|
1260
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1261
|
+
*/
|
|
1262
|
+
BaseUUID /* uuid */?,
|
|
1263
|
+
/**
|
|
1264
|
+
* example:
|
|
1265
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1266
|
+
*/
|
|
1267
|
+
BaseUUID /* uuid */?,
|
|
1268
|
+
/**
|
|
1269
|
+
* example:
|
|
1270
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1271
|
+
*/
|
|
1272
|
+
BaseUUID /* uuid */?,
|
|
1273
|
+
/**
|
|
1274
|
+
* example:
|
|
1275
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1276
|
+
*/
|
|
1277
|
+
BaseUUID /* uuid */?,
|
|
1278
|
+
/**
|
|
1279
|
+
* example:
|
|
1280
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1281
|
+
*/
|
|
1282
|
+
BaseUUID /* uuid */?,
|
|
1283
|
+
/**
|
|
1284
|
+
* example:
|
|
1285
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1286
|
+
*/
|
|
1287
|
+
BaseUUID /* uuid */?,
|
|
1288
|
+
/**
|
|
1289
|
+
* example:
|
|
1290
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1291
|
+
*/
|
|
1292
|
+
BaseUUID /* uuid */?,
|
|
1293
|
+
/**
|
|
1294
|
+
* example:
|
|
1295
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1296
|
+
*/
|
|
1297
|
+
BaseUUID /* uuid */?,
|
|
1298
|
+
/**
|
|
1299
|
+
* example:
|
|
1300
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1301
|
+
*/
|
|
1302
|
+
BaseUUID /* uuid */?,
|
|
1303
|
+
/**
|
|
1304
|
+
* example:
|
|
1305
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1306
|
+
*/
|
|
1307
|
+
BaseUUID /* uuid */?,
|
|
1308
|
+
/**
|
|
1309
|
+
* example:
|
|
1310
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1311
|
+
*/
|
|
1312
|
+
BaseUUID /* uuid */?,
|
|
1313
|
+
/**
|
|
1314
|
+
* example:
|
|
1315
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1316
|
+
*/
|
|
1317
|
+
BaseUUID /* uuid */?,
|
|
1318
|
+
/**
|
|
1319
|
+
* example:
|
|
1320
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1321
|
+
*/
|
|
1322
|
+
BaseUUID /* uuid */?,
|
|
1323
|
+
/**
|
|
1324
|
+
* example:
|
|
1325
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1326
|
+
*/
|
|
1327
|
+
BaseUUID /* uuid */?,
|
|
1328
|
+
/**
|
|
1329
|
+
* example:
|
|
1330
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1331
|
+
*/
|
|
1332
|
+
BaseUUID /* uuid */?,
|
|
1333
|
+
/**
|
|
1334
|
+
* example:
|
|
1335
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1336
|
+
*/
|
|
1337
|
+
BaseUUID /* uuid */?,
|
|
1338
|
+
/**
|
|
1339
|
+
* example:
|
|
1340
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1341
|
+
*/
|
|
1342
|
+
BaseUUID /* uuid */?,
|
|
1343
|
+
/**
|
|
1344
|
+
* example:
|
|
1345
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1346
|
+
*/
|
|
1347
|
+
BaseUUID /* uuid */?,
|
|
1348
|
+
/**
|
|
1349
|
+
* example:
|
|
1350
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1351
|
+
*/
|
|
1352
|
+
BaseUUID /* uuid */?,
|
|
1353
|
+
/**
|
|
1354
|
+
* example:
|
|
1355
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1356
|
+
*/
|
|
1357
|
+
BaseUUID /* uuid */?,
|
|
1358
|
+
/**
|
|
1359
|
+
* example:
|
|
1360
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1361
|
+
*/
|
|
1362
|
+
BaseUUID /* uuid */?,
|
|
1363
|
+
/**
|
|
1364
|
+
* example:
|
|
1365
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1366
|
+
*/
|
|
1367
|
+
BaseUUID /* uuid */?,
|
|
1368
|
+
/**
|
|
1369
|
+
* example:
|
|
1370
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1371
|
+
*/
|
|
1372
|
+
BaseUUID /* uuid */?,
|
|
1373
|
+
/**
|
|
1374
|
+
* example:
|
|
1375
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1376
|
+
*/
|
|
1377
|
+
BaseUUID /* uuid */?,
|
|
1378
|
+
/**
|
|
1379
|
+
* example:
|
|
1380
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1381
|
+
*/
|
|
1382
|
+
BaseUUID /* uuid */?,
|
|
1383
|
+
/**
|
|
1384
|
+
* example:
|
|
1385
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1386
|
+
*/
|
|
1387
|
+
BaseUUID /* uuid */?,
|
|
1388
|
+
/**
|
|
1389
|
+
* example:
|
|
1390
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1391
|
+
*/
|
|
1392
|
+
BaseUUID /* uuid */?,
|
|
1393
|
+
/**
|
|
1394
|
+
* example:
|
|
1395
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1396
|
+
*/
|
|
1397
|
+
BaseUUID /* uuid */?,
|
|
1398
|
+
/**
|
|
1399
|
+
* example:
|
|
1400
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1401
|
+
*/
|
|
1402
|
+
BaseUUID /* uuid */?,
|
|
1403
|
+
/**
|
|
1404
|
+
* example:
|
|
1405
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1406
|
+
*/
|
|
1407
|
+
BaseUUID /* uuid */?,
|
|
1408
|
+
/**
|
|
1409
|
+
* example:
|
|
1410
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1411
|
+
*/
|
|
1412
|
+
BaseUUID /* uuid */?,
|
|
1413
|
+
/**
|
|
1414
|
+
* example:
|
|
1415
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1416
|
+
*/
|
|
1417
|
+
BaseUUID /* uuid */?
|
|
1418
|
+
];
|
|
1419
|
+
}
|
|
1420
|
+
export interface PortalRecipientPayload {
|
|
1421
|
+
portal_status: PortalStatus;
|
|
1422
|
+
portal_state?: {
|
|
1423
|
+
[name: string]: any;
|
|
1424
|
+
};
|
|
1425
|
+
}
|
|
1426
|
+
export type PortalStatus = "sent" | "seen" | "dismissed" | "clicked";
|
|
1427
|
+
export interface Recipient {
|
|
1428
|
+
entity_id?: /**
|
|
1429
|
+
* example:
|
|
1430
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1431
|
+
*/
|
|
1432
|
+
BaseUUID /* uuid */;
|
|
1433
|
+
entity_schema?: string;
|
|
1434
|
+
title?: string;
|
|
1435
|
+
automation_status?: AutomationStatus;
|
|
1436
|
+
automation_execution_id?: string;
|
|
1437
|
+
portal_status?: PortalStatus;
|
|
1438
|
+
portal_status_updated_at?: string; // date-time
|
|
1439
|
+
portal_state?: {
|
|
1440
|
+
[name: string]: any;
|
|
1441
|
+
};
|
|
1442
|
+
updated_at?: string; // date-time
|
|
1443
|
+
}
|
|
1444
|
+
export interface RetriggerAutomationsRequest {
|
|
1445
|
+
/**
|
|
1446
|
+
* List of recipient IDs to retrigger automations for
|
|
1447
|
+
*/
|
|
1448
|
+
recipient_ids: string /* uuid */[];
|
|
1449
|
+
}
|
|
1450
|
+
export interface RetriggerAutomationsResult {
|
|
1451
|
+
/**
|
|
1452
|
+
* The ID of the recipient
|
|
1453
|
+
*/
|
|
1454
|
+
recipient_id: string; // uuid
|
|
1455
|
+
/**
|
|
1456
|
+
* The result of the retriggering operation
|
|
1457
|
+
*/
|
|
1458
|
+
result: "success" | "failure" | "not_found" | "invalid_status";
|
|
1459
|
+
/**
|
|
1460
|
+
* The ID of the new automation execution (if successful)
|
|
1461
|
+
*/
|
|
1462
|
+
execution_id?: string;
|
|
1463
|
+
/**
|
|
1464
|
+
* The error message if the operation failed
|
|
1465
|
+
*/
|
|
1466
|
+
error?: string;
|
|
1467
|
+
}
|
|
1468
|
+
export type ServerError = BaseError;
|
|
1469
|
+
export interface Target {
|
|
1470
|
+
_id?: /**
|
|
1471
|
+
* example:
|
|
1472
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1473
|
+
*/
|
|
1474
|
+
BaseUUID /* uuid */;
|
|
1475
|
+
/**
|
|
1476
|
+
* Organization Id the entity belongs to
|
|
1477
|
+
*/
|
|
1478
|
+
_org?: string;
|
|
1479
|
+
_owners?: /**
|
|
1480
|
+
* The user / organization owning this entity.
|
|
1481
|
+
*
|
|
1482
|
+
* Note: Owner implicitly has access to the entity regardless of ACLs.
|
|
1483
|
+
*
|
|
1484
|
+
*/
|
|
1485
|
+
BaseEntityOwner[];
|
|
1486
|
+
_schema?: string;
|
|
1487
|
+
_title?: string;
|
|
1488
|
+
_tags?: BaseTags;
|
|
1489
|
+
_created_at?: string; // date-time
|
|
1490
|
+
_updated_at?: string; // date-time
|
|
1491
|
+
_acl?: /* Access control list (ACL) for an entity. Defines sharing access to external orgs or users. */ BaseEntityAcl;
|
|
1492
|
+
name?: string;
|
|
1493
|
+
description?: string;
|
|
1494
|
+
entity_schema?: string;
|
|
1495
|
+
entity_filters?: {
|
|
1496
|
+
[name: string]: any;
|
|
1497
|
+
};
|
|
1498
|
+
}
|
|
1499
|
+
export interface TargetQueryResult {
|
|
1500
|
+
target_id: /**
|
|
1501
|
+
* example:
|
|
1502
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1503
|
+
*/
|
|
1504
|
+
BaseUUID /* uuid */;
|
|
1505
|
+
/**
|
|
1506
|
+
* Transformed query string, or null if transformation failed.
|
|
1507
|
+
*/
|
|
1508
|
+
query: string | null;
|
|
1509
|
+
/**
|
|
1510
|
+
* Error message if query transformation failed.
|
|
1511
|
+
*/
|
|
1512
|
+
error?: string;
|
|
1513
|
+
}
|
|
1514
|
+
export interface UpdatePortalStatusRequest {
|
|
1515
|
+
status: PortalStatus;
|
|
1516
|
+
}
|
|
1517
|
+
export interface UpdateRecipientPayload {
|
|
1518
|
+
automation_status?: AutomationStatus;
|
|
1519
|
+
automation_execution_id?: string;
|
|
1520
|
+
portal_status?: PortalStatus;
|
|
1521
|
+
portal_state?: {
|
|
1522
|
+
[name: string]: any;
|
|
1523
|
+
};
|
|
1524
|
+
}
|
|
1525
|
+
}
|
|
1526
|
+
}
|
|
1527
|
+
declare namespace Paths {
|
|
1528
|
+
namespace ChangeCampaignStatus {
|
|
1529
|
+
namespace Parameters {
|
|
1530
|
+
export type CampaignId = /**
|
|
1531
|
+
* example:
|
|
1532
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1533
|
+
*/
|
|
1534
|
+
Components.Schemas.BaseUUID /* uuid */;
|
|
1535
|
+
}
|
|
1536
|
+
export interface PathParameters {
|
|
1537
|
+
campaign_id: Parameters.CampaignId;
|
|
1538
|
+
}
|
|
1539
|
+
namespace Responses {
|
|
1540
|
+
export type $200 = Components.Responses.CampaignResponse;
|
|
1541
|
+
export type $400 = Components.Responses.ClientErrorResponse;
|
|
1542
|
+
export type $500 = Components.Responses.ServerErrorResponse;
|
|
1543
|
+
}
|
|
1544
|
+
}
|
|
1545
|
+
namespace CreateRecipient {
|
|
1546
|
+
namespace Parameters {
|
|
1547
|
+
export type CampaignId = /**
|
|
1548
|
+
* example:
|
|
1549
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1550
|
+
*/
|
|
1551
|
+
Components.Schemas.BaseUUID /* uuid */;
|
|
1552
|
+
}
|
|
1553
|
+
export interface PathParameters {
|
|
1554
|
+
campaign_id: Parameters.CampaignId;
|
|
1555
|
+
}
|
|
1556
|
+
export type RequestBody = Components.Schemas.CreateRecipientPayload;
|
|
1557
|
+
namespace Responses {
|
|
1558
|
+
export type $201 = Components.Responses.RecipientResponse;
|
|
1559
|
+
export type $400 = Components.Responses.ClientErrorResponse;
|
|
1560
|
+
export type $500 = Components.Responses.ServerErrorResponse;
|
|
1561
|
+
}
|
|
1562
|
+
}
|
|
1563
|
+
namespace GetCampaignJobStatus {
|
|
1564
|
+
namespace Parameters {
|
|
1565
|
+
export type CampaignId = /**
|
|
1566
|
+
* example:
|
|
1567
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1568
|
+
*/
|
|
1569
|
+
Components.Schemas.BaseUUID /* uuid */;
|
|
1570
|
+
}
|
|
1571
|
+
export interface PathParameters {
|
|
1572
|
+
campaign_id: Parameters.CampaignId;
|
|
1573
|
+
}
|
|
1574
|
+
namespace Responses {
|
|
1575
|
+
export type $200 = Components.Responses.JobStatusResponse;
|
|
1576
|
+
export type $400 = Components.Responses.ClientErrorResponse;
|
|
1577
|
+
export type $500 = Components.Responses.ServerErrorResponse;
|
|
1578
|
+
}
|
|
1579
|
+
}
|
|
1580
|
+
namespace GetCampaignPortals {
|
|
1581
|
+
namespace Parameters {
|
|
1582
|
+
export type CampaignId = /**
|
|
1583
|
+
* example:
|
|
1584
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1585
|
+
*/
|
|
1586
|
+
Components.Schemas.BaseUUID /* uuid */;
|
|
1587
|
+
}
|
|
1588
|
+
export interface PathParameters {
|
|
1589
|
+
campaign_id: Parameters.CampaignId;
|
|
1590
|
+
}
|
|
1591
|
+
namespace Responses {
|
|
1592
|
+
export type $200 = Components.Responses.CampaignPortalsResponse;
|
|
1593
|
+
export type $400 = Components.Responses.ClientErrorResponse;
|
|
1594
|
+
export type $500 = Components.Responses.ServerErrorResponse;
|
|
1595
|
+
}
|
|
1596
|
+
}
|
|
1597
|
+
namespace GetRecipients {
|
|
1598
|
+
namespace Parameters {
|
|
1599
|
+
export type AutomationStatus = Components.Schemas.AutomationStatus;
|
|
1600
|
+
export type CampaignId = /**
|
|
1601
|
+
* example:
|
|
1602
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1603
|
+
*/
|
|
1604
|
+
Components.Schemas.BaseUUID /* uuid */;
|
|
1605
|
+
export type Limit = number;
|
|
1606
|
+
export type Next = string;
|
|
1607
|
+
export type PortalStatus = Components.Schemas.PortalStatus;
|
|
1608
|
+
export type Q = string;
|
|
1609
|
+
}
|
|
1610
|
+
export interface PathParameters {
|
|
1611
|
+
campaign_id: Parameters.CampaignId;
|
|
1612
|
+
}
|
|
1613
|
+
export interface QueryParameters {
|
|
1614
|
+
limit?: Parameters.Limit;
|
|
1615
|
+
next?: Parameters.Next;
|
|
1616
|
+
q?: Parameters.Q;
|
|
1617
|
+
automation_status?: Parameters.AutomationStatus;
|
|
1618
|
+
portal_status?: Parameters.PortalStatus;
|
|
1619
|
+
}
|
|
1620
|
+
namespace Responses {
|
|
1621
|
+
export type $200 = Components.Responses.RecipientsResponse;
|
|
1622
|
+
export type $400 = Components.Responses.ClientErrorResponse;
|
|
1623
|
+
export type $500 = Components.Responses.ServerErrorResponse;
|
|
1624
|
+
}
|
|
1625
|
+
}
|
|
1626
|
+
namespace GetTargetQueries {
|
|
1627
|
+
export type RequestBody = Components.Schemas.GetTargetQueriesParams;
|
|
1628
|
+
namespace Responses {
|
|
1629
|
+
export type $200 = Components.Responses.GetTargetQueriesResponse;
|
|
1630
|
+
export type $400 = Components.Responses.ClientErrorResponse;
|
|
1631
|
+
export type $500 = Components.Responses.ServerErrorResponse;
|
|
1632
|
+
}
|
|
1633
|
+
}
|
|
1634
|
+
namespace MatchCampaigns {
|
|
1635
|
+
export type RequestBody = Components.Schemas.MatchCampaignParams;
|
|
1636
|
+
namespace Responses {
|
|
1637
|
+
export type $200 = Components.Responses.MatchCampaignsResponse;
|
|
1638
|
+
export type $400 = Components.Responses.ClientErrorResponse;
|
|
1639
|
+
export type $500 = Components.Responses.ServerErrorResponse;
|
|
1640
|
+
}
|
|
1641
|
+
}
|
|
1642
|
+
namespace MatchTargets {
|
|
1643
|
+
export type RequestBody = Components.Schemas.MatchTargetParams;
|
|
1644
|
+
namespace Responses {
|
|
1645
|
+
export type $200 = Components.Responses.MatchTargetsResponse;
|
|
1646
|
+
export type $400 = Components.Responses.ClientErrorResponse;
|
|
1647
|
+
export type $500 = Components.Responses.ServerErrorResponse;
|
|
1648
|
+
}
|
|
1649
|
+
}
|
|
1650
|
+
namespace RetriggerCampaignAutomations {
|
|
1651
|
+
namespace Parameters {
|
|
1652
|
+
export type CampaignId = /**
|
|
1653
|
+
* example:
|
|
1654
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1655
|
+
*/
|
|
1656
|
+
Components.Schemas.BaseUUID /* uuid */;
|
|
1657
|
+
}
|
|
1658
|
+
export interface PathParameters {
|
|
1659
|
+
campaign_id: Parameters.CampaignId;
|
|
1660
|
+
}
|
|
1661
|
+
export type RequestBody = Components.Schemas.RetriggerAutomationsRequest;
|
|
1662
|
+
namespace Responses {
|
|
1663
|
+
export type $200 = Components.Responses.RetriggerAutomationsResponse;
|
|
1664
|
+
export type $400 = Components.Responses.ClientErrorResponse;
|
|
1665
|
+
export type $404 = Components.Responses.ServerErrorResponse;
|
|
1666
|
+
export type $500 = Components.Responses.ServerErrorResponse;
|
|
1667
|
+
}
|
|
1668
|
+
}
|
|
1669
|
+
namespace UpdateRecipient {
|
|
1670
|
+
namespace Parameters {
|
|
1671
|
+
export type CampaignId = /**
|
|
1672
|
+
* example:
|
|
1673
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1674
|
+
*/
|
|
1675
|
+
Components.Schemas.BaseUUID /* uuid */;
|
|
1676
|
+
export type RecipientId = /**
|
|
1677
|
+
* example:
|
|
1678
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1679
|
+
*/
|
|
1680
|
+
Components.Schemas.BaseUUID /* uuid */;
|
|
1681
|
+
}
|
|
1682
|
+
export interface PathParameters {
|
|
1683
|
+
campaign_id: Parameters.CampaignId;
|
|
1684
|
+
recipient_id: Parameters.RecipientId;
|
|
1685
|
+
}
|
|
1686
|
+
export type RequestBody = Components.Schemas.UpdateRecipientPayload;
|
|
1687
|
+
namespace Responses {
|
|
1688
|
+
export type $200 = Components.Responses.RecipientResponse;
|
|
1689
|
+
export type $400 = Components.Responses.ClientErrorResponse;
|
|
1690
|
+
export type $500 = Components.Responses.ServerErrorResponse;
|
|
1691
|
+
}
|
|
1692
|
+
}
|
|
1693
|
+
namespace UpdateRecipientPortalStatus {
|
|
1694
|
+
namespace Parameters {
|
|
1695
|
+
export type CampaignId = /**
|
|
1696
|
+
* example:
|
|
1697
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1698
|
+
*/
|
|
1699
|
+
Components.Schemas.BaseUUID /* uuid */;
|
|
1700
|
+
export type RecipientId = /**
|
|
1701
|
+
* example:
|
|
1702
|
+
* b8c01433-5556-4e2b-aad4-6f5348d1df84
|
|
1703
|
+
*/
|
|
1704
|
+
Components.Schemas.BaseUUID /* uuid */;
|
|
1705
|
+
}
|
|
1706
|
+
export interface PathParameters {
|
|
1707
|
+
campaign_id: Parameters.CampaignId;
|
|
1708
|
+
recipient_id: Parameters.RecipientId;
|
|
1709
|
+
}
|
|
1710
|
+
export type RequestBody = Components.Schemas.UpdatePortalStatusRequest;
|
|
1711
|
+
namespace Responses {
|
|
1712
|
+
export type $200 = Components.Responses.RecipientResponse;
|
|
1713
|
+
export type $400 = Components.Responses.ClientErrorResponse;
|
|
1714
|
+
export type $404 = Components.Responses.ClientErrorResponse;
|
|
1715
|
+
export type $409 = Components.Responses.ClientErrorResponse;
|
|
1716
|
+
export type $500 = Components.Responses.ServerErrorResponse;
|
|
1717
|
+
}
|
|
1718
|
+
}
|
|
1719
|
+
}
|
|
1720
|
+
|
|
1721
|
+
|
|
1722
|
+
interface OperationMethods {
|
|
1723
|
+
/**
|
|
1724
|
+
* changeCampaignStatus - Change the status of a campaign
|
|
1725
|
+
*
|
|
1726
|
+
* Change the status of a campaign to a desired status.
|
|
1727
|
+
*
|
|
1728
|
+
* The status can be one of the following: active, inactive.
|
|
1729
|
+
*
|
|
1730
|
+
* Status transition is accompanied by side effects, e.g., automation execution.
|
|
1731
|
+
*
|
|
1732
|
+
*/
|
|
1733
|
+
'changeCampaignStatus'(
|
|
1734
|
+
parameters?: Parameters<Paths.ChangeCampaignStatus.PathParameters> | null,
|
|
1735
|
+
data?: any,
|
|
1736
|
+
config?: AxiosRequestConfig
|
|
1737
|
+
): OperationResponse<Paths.ChangeCampaignStatus.Responses.$200>
|
|
1738
|
+
/**
|
|
1739
|
+
* getCampaignJobStatus - Get the status of a campaign's automation job
|
|
1740
|
+
*
|
|
1741
|
+
* Get the status of a campaign's automation job
|
|
1742
|
+
*/
|
|
1743
|
+
'getCampaignJobStatus'(
|
|
1744
|
+
parameters?: Parameters<Paths.GetCampaignJobStatus.PathParameters> | null,
|
|
1745
|
+
data?: any,
|
|
1746
|
+
config?: AxiosRequestConfig
|
|
1747
|
+
): OperationResponse<Paths.GetCampaignJobStatus.Responses.$200>
|
|
1748
|
+
/**
|
|
1749
|
+
* getCampaignPortals - Get portals usage info for a campaign
|
|
1750
|
+
*
|
|
1751
|
+
* Get the list of portals and its widgets where the campaign is used.
|
|
1752
|
+
*
|
|
1753
|
+
*/
|
|
1754
|
+
'getCampaignPortals'(
|
|
1755
|
+
parameters?: Parameters<Paths.GetCampaignPortals.PathParameters> | null,
|
|
1756
|
+
data?: any,
|
|
1757
|
+
config?: AxiosRequestConfig
|
|
1758
|
+
): OperationResponse<Paths.GetCampaignPortals.Responses.$200>
|
|
1759
|
+
/**
|
|
1760
|
+
* retriggerCampaignAutomations - Retrigger automations for campaign recipients
|
|
1761
|
+
*
|
|
1762
|
+
* Retrigger automation executions for specific campaign recipients that have failed.
|
|
1763
|
+
*
|
|
1764
|
+
* This endpoint starts new automation executions for the specified recipients
|
|
1765
|
+
* using the campaign's associated automation flow. Only recipients with
|
|
1766
|
+
* automation_status 'failed' will be processed. Recipients with other statuses
|
|
1767
|
+
* (success, pending, in_progress, cancelled) will be skipped to prevent
|
|
1768
|
+
* accidentally retriggering successful or ongoing automations.
|
|
1769
|
+
*
|
|
1770
|
+
*/
|
|
1771
|
+
'retriggerCampaignAutomations'(
|
|
1772
|
+
parameters?: Parameters<Paths.RetriggerCampaignAutomations.PathParameters> | null,
|
|
1773
|
+
data?: Paths.RetriggerCampaignAutomations.RequestBody,
|
|
1774
|
+
config?: AxiosRequestConfig
|
|
1775
|
+
): OperationResponse<Paths.RetriggerCampaignAutomations.Responses.$200>
|
|
1776
|
+
/**
|
|
1777
|
+
* matchCampaigns - Match campaigns
|
|
1778
|
+
*
|
|
1779
|
+
* Match campaigns based on target entities.
|
|
1780
|
+
*
|
|
1781
|
+
* This endpoint returns the list of campaigns where the provided entities are part of the target.
|
|
1782
|
+
*
|
|
1783
|
+
*/
|
|
1784
|
+
'matchCampaigns'(
|
|
1785
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1786
|
+
data?: Paths.MatchCampaigns.RequestBody,
|
|
1787
|
+
config?: AxiosRequestConfig
|
|
1788
|
+
): OperationResponse<Paths.MatchCampaigns.Responses.$200>
|
|
1789
|
+
/**
|
|
1790
|
+
* matchTargets - Match targets
|
|
1791
|
+
*
|
|
1792
|
+
* Find targets from the provided list that include the provide entities.
|
|
1793
|
+
*
|
|
1794
|
+
*/
|
|
1795
|
+
'matchTargets'(
|
|
1796
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1797
|
+
data?: Paths.MatchTargets.RequestBody,
|
|
1798
|
+
config?: AxiosRequestConfig
|
|
1799
|
+
): OperationResponse<Paths.MatchTargets.Responses.$200>
|
|
1800
|
+
/**
|
|
1801
|
+
* getTargetQueries - Get target queries
|
|
1802
|
+
*
|
|
1803
|
+
* Transform target filters into Lucene queries for the provided target IDs.
|
|
1804
|
+
* Returns the transformed query string for each target along with any errors encountered.
|
|
1805
|
+
*
|
|
1806
|
+
*/
|
|
1807
|
+
'getTargetQueries'(
|
|
1808
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1809
|
+
data?: Paths.GetTargetQueries.RequestBody,
|
|
1810
|
+
config?: AxiosRequestConfig
|
|
1811
|
+
): OperationResponse<Paths.GetTargetQueries.Responses.$200>
|
|
1812
|
+
/**
|
|
1813
|
+
* createRecipient - Create a recipient associated with a campaign
|
|
1814
|
+
*
|
|
1815
|
+
* Creates a new recipient associated with a campaign.
|
|
1816
|
+
*/
|
|
1817
|
+
'createRecipient'(
|
|
1818
|
+
parameters?: Parameters<Paths.CreateRecipient.PathParameters> | null,
|
|
1819
|
+
data?: Paths.CreateRecipient.RequestBody,
|
|
1820
|
+
config?: AxiosRequestConfig
|
|
1821
|
+
): OperationResponse<Paths.CreateRecipient.Responses.$201>
|
|
1822
|
+
/**
|
|
1823
|
+
* updateRecipient - Update a recipient
|
|
1824
|
+
*
|
|
1825
|
+
* Updates a recipient's attributes.
|
|
1826
|
+
*/
|
|
1827
|
+
'updateRecipient'(
|
|
1828
|
+
parameters?: Parameters<Paths.UpdateRecipient.PathParameters> | null,
|
|
1829
|
+
data?: Paths.UpdateRecipient.RequestBody,
|
|
1830
|
+
config?: AxiosRequestConfig
|
|
1831
|
+
): OperationResponse<Paths.UpdateRecipient.Responses.$200>
|
|
1832
|
+
/**
|
|
1833
|
+
* updateRecipientPortalStatus - Update portal status for a campaign recipient
|
|
1834
|
+
*
|
|
1835
|
+
* Updates the portal status for a specific campaign recipient.
|
|
1836
|
+
* The portal_status_updated_at timestamp is automatically set when the status changes.
|
|
1837
|
+
*
|
|
1838
|
+
* Status transition rules:
|
|
1839
|
+
* - From 'sent': can change to 'seen', 'dismissed', or 'clicked'
|
|
1840
|
+
* - From 'seen': can change to 'dismissed' or 'clicked'
|
|
1841
|
+
* - From 'dismissed' or 'clicked': cannot be changed (final states)
|
|
1842
|
+
*
|
|
1843
|
+
*/
|
|
1844
|
+
'updateRecipientPortalStatus'(
|
|
1845
|
+
parameters?: Parameters<Paths.UpdateRecipientPortalStatus.PathParameters> | null,
|
|
1846
|
+
data?: Paths.UpdateRecipientPortalStatus.RequestBody,
|
|
1847
|
+
config?: AxiosRequestConfig
|
|
1848
|
+
): OperationResponse<Paths.UpdateRecipientPortalStatus.Responses.$200>
|
|
1849
|
+
/**
|
|
1850
|
+
* getRecipients - Get campaign recipients
|
|
1851
|
+
*
|
|
1852
|
+
* Get a paginated list of recipients for a campaign.
|
|
1853
|
+
*/
|
|
1854
|
+
'getRecipients'(
|
|
1855
|
+
parameters?: Parameters<Paths.GetRecipients.QueryParameters & Paths.GetRecipients.PathParameters> | null,
|
|
1856
|
+
data?: any,
|
|
1857
|
+
config?: AxiosRequestConfig
|
|
1858
|
+
): OperationResponse<Paths.GetRecipients.Responses.$200>
|
|
1859
|
+
}
|
|
1860
|
+
|
|
1861
|
+
interface PathsDictionary {
|
|
1862
|
+
['/v1/campaign/{campaign_id}/status']: {
|
|
1863
|
+
/**
|
|
1864
|
+
* changeCampaignStatus - Change the status of a campaign
|
|
1865
|
+
*
|
|
1866
|
+
* Change the status of a campaign to a desired status.
|
|
1867
|
+
*
|
|
1868
|
+
* The status can be one of the following: active, inactive.
|
|
1869
|
+
*
|
|
1870
|
+
* Status transition is accompanied by side effects, e.g., automation execution.
|
|
1871
|
+
*
|
|
1872
|
+
*/
|
|
1873
|
+
'post'(
|
|
1874
|
+
parameters?: Parameters<Paths.ChangeCampaignStatus.PathParameters> | null,
|
|
1875
|
+
data?: any,
|
|
1876
|
+
config?: AxiosRequestConfig
|
|
1877
|
+
): OperationResponse<Paths.ChangeCampaignStatus.Responses.$200>
|
|
1878
|
+
}
|
|
1879
|
+
['/v1/campaign/{campaign_id}/job']: {
|
|
1880
|
+
/**
|
|
1881
|
+
* getCampaignJobStatus - Get the status of a campaign's automation job
|
|
1882
|
+
*
|
|
1883
|
+
* Get the status of a campaign's automation job
|
|
1884
|
+
*/
|
|
1885
|
+
'get'(
|
|
1886
|
+
parameters?: Parameters<Paths.GetCampaignJobStatus.PathParameters> | null,
|
|
1887
|
+
data?: any,
|
|
1888
|
+
config?: AxiosRequestConfig
|
|
1889
|
+
): OperationResponse<Paths.GetCampaignJobStatus.Responses.$200>
|
|
1890
|
+
}
|
|
1891
|
+
['/v1/campaign/{campaign_id}/portals']: {
|
|
1892
|
+
/**
|
|
1893
|
+
* getCampaignPortals - Get portals usage info for a campaign
|
|
1894
|
+
*
|
|
1895
|
+
* Get the list of portals and its widgets where the campaign is used.
|
|
1896
|
+
*
|
|
1897
|
+
*/
|
|
1898
|
+
'get'(
|
|
1899
|
+
parameters?: Parameters<Paths.GetCampaignPortals.PathParameters> | null,
|
|
1900
|
+
data?: any,
|
|
1901
|
+
config?: AxiosRequestConfig
|
|
1902
|
+
): OperationResponse<Paths.GetCampaignPortals.Responses.$200>
|
|
1903
|
+
}
|
|
1904
|
+
['/v1/campaign/{campaign_id}/automations:retrigger']: {
|
|
1905
|
+
/**
|
|
1906
|
+
* retriggerCampaignAutomations - Retrigger automations for campaign recipients
|
|
1907
|
+
*
|
|
1908
|
+
* Retrigger automation executions for specific campaign recipients that have failed.
|
|
1909
|
+
*
|
|
1910
|
+
* This endpoint starts new automation executions for the specified recipients
|
|
1911
|
+
* using the campaign's associated automation flow. Only recipients with
|
|
1912
|
+
* automation_status 'failed' will be processed. Recipients with other statuses
|
|
1913
|
+
* (success, pending, in_progress, cancelled) will be skipped to prevent
|
|
1914
|
+
* accidentally retriggering successful or ongoing automations.
|
|
1915
|
+
*
|
|
1916
|
+
*/
|
|
1917
|
+
'post'(
|
|
1918
|
+
parameters?: Parameters<Paths.RetriggerCampaignAutomations.PathParameters> | null,
|
|
1919
|
+
data?: Paths.RetriggerCampaignAutomations.RequestBody,
|
|
1920
|
+
config?: AxiosRequestConfig
|
|
1921
|
+
): OperationResponse<Paths.RetriggerCampaignAutomations.Responses.$200>
|
|
1922
|
+
}
|
|
1923
|
+
['/v1/campaign:match']: {
|
|
1924
|
+
/**
|
|
1925
|
+
* matchCampaigns - Match campaigns
|
|
1926
|
+
*
|
|
1927
|
+
* Match campaigns based on target entities.
|
|
1928
|
+
*
|
|
1929
|
+
* This endpoint returns the list of campaigns where the provided entities are part of the target.
|
|
1930
|
+
*
|
|
1931
|
+
*/
|
|
1932
|
+
'post'(
|
|
1933
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1934
|
+
data?: Paths.MatchCampaigns.RequestBody,
|
|
1935
|
+
config?: AxiosRequestConfig
|
|
1936
|
+
): OperationResponse<Paths.MatchCampaigns.Responses.$200>
|
|
1937
|
+
}
|
|
1938
|
+
['/v1/target:match']: {
|
|
1939
|
+
/**
|
|
1940
|
+
* matchTargets - Match targets
|
|
1941
|
+
*
|
|
1942
|
+
* Find targets from the provided list that include the provide entities.
|
|
1943
|
+
*
|
|
1944
|
+
*/
|
|
1945
|
+
'post'(
|
|
1946
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1947
|
+
data?: Paths.MatchTargets.RequestBody,
|
|
1948
|
+
config?: AxiosRequestConfig
|
|
1949
|
+
): OperationResponse<Paths.MatchTargets.Responses.$200>
|
|
1950
|
+
}
|
|
1951
|
+
['/v1/target/queries']: {
|
|
1952
|
+
/**
|
|
1953
|
+
* getTargetQueries - Get target queries
|
|
1954
|
+
*
|
|
1955
|
+
* Transform target filters into Lucene queries for the provided target IDs.
|
|
1956
|
+
* Returns the transformed query string for each target along with any errors encountered.
|
|
1957
|
+
*
|
|
1958
|
+
*/
|
|
1959
|
+
'post'(
|
|
1960
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1961
|
+
data?: Paths.GetTargetQueries.RequestBody,
|
|
1962
|
+
config?: AxiosRequestConfig
|
|
1963
|
+
): OperationResponse<Paths.GetTargetQueries.Responses.$200>
|
|
1964
|
+
}
|
|
1965
|
+
['/v1/campaign/{campaign_id}/recipient']: {
|
|
1966
|
+
/**
|
|
1967
|
+
* createRecipient - Create a recipient associated with a campaign
|
|
1968
|
+
*
|
|
1969
|
+
* Creates a new recipient associated with a campaign.
|
|
1970
|
+
*/
|
|
1971
|
+
'post'(
|
|
1972
|
+
parameters?: Parameters<Paths.CreateRecipient.PathParameters> | null,
|
|
1973
|
+
data?: Paths.CreateRecipient.RequestBody,
|
|
1974
|
+
config?: AxiosRequestConfig
|
|
1975
|
+
): OperationResponse<Paths.CreateRecipient.Responses.$201>
|
|
1976
|
+
}
|
|
1977
|
+
['/v1/campaign/{campaign_id}/recipient/{recipient_id}']: {
|
|
1978
|
+
/**
|
|
1979
|
+
* updateRecipient - Update a recipient
|
|
1980
|
+
*
|
|
1981
|
+
* Updates a recipient's attributes.
|
|
1982
|
+
*/
|
|
1983
|
+
'patch'(
|
|
1984
|
+
parameters?: Parameters<Paths.UpdateRecipient.PathParameters> | null,
|
|
1985
|
+
data?: Paths.UpdateRecipient.RequestBody,
|
|
1986
|
+
config?: AxiosRequestConfig
|
|
1987
|
+
): OperationResponse<Paths.UpdateRecipient.Responses.$200>
|
|
1988
|
+
}
|
|
1989
|
+
['/v1/campaign/{campaign_id}/recipient/{recipient_id}/portal:status']: {
|
|
1990
|
+
/**
|
|
1991
|
+
* updateRecipientPortalStatus - Update portal status for a campaign recipient
|
|
1992
|
+
*
|
|
1993
|
+
* Updates the portal status for a specific campaign recipient.
|
|
1994
|
+
* The portal_status_updated_at timestamp is automatically set when the status changes.
|
|
1995
|
+
*
|
|
1996
|
+
* Status transition rules:
|
|
1997
|
+
* - From 'sent': can change to 'seen', 'dismissed', or 'clicked'
|
|
1998
|
+
* - From 'seen': can change to 'dismissed' or 'clicked'
|
|
1999
|
+
* - From 'dismissed' or 'clicked': cannot be changed (final states)
|
|
2000
|
+
*
|
|
2001
|
+
*/
|
|
2002
|
+
'patch'(
|
|
2003
|
+
parameters?: Parameters<Paths.UpdateRecipientPortalStatus.PathParameters> | null,
|
|
2004
|
+
data?: Paths.UpdateRecipientPortalStatus.RequestBody,
|
|
2005
|
+
config?: AxiosRequestConfig
|
|
2006
|
+
): OperationResponse<Paths.UpdateRecipientPortalStatus.Responses.$200>
|
|
2007
|
+
}
|
|
2008
|
+
['/v1/campaign/{campaign_id}/recipients']: {
|
|
2009
|
+
/**
|
|
2010
|
+
* getRecipients - Get campaign recipients
|
|
2011
|
+
*
|
|
2012
|
+
* Get a paginated list of recipients for a campaign.
|
|
2013
|
+
*/
|
|
2014
|
+
'get'(
|
|
2015
|
+
parameters?: Parameters<Paths.GetRecipients.QueryParameters & Paths.GetRecipients.PathParameters> | null,
|
|
2016
|
+
data?: any,
|
|
2017
|
+
config?: AxiosRequestConfig
|
|
2018
|
+
): OperationResponse<Paths.GetRecipients.Responses.$200>
|
|
2019
|
+
}
|
|
2020
|
+
}
|
|
2021
|
+
|
|
2022
|
+
type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
2023
|
+
|
|
2024
|
+
|
|
2025
|
+
type AutomationRecipientPayload = Components.Schemas.AutomationRecipientPayload;
|
|
2026
|
+
type AutomationStatus = Components.Schemas.AutomationStatus;
|
|
2027
|
+
type BaseEntityAcl = Components.Schemas.BaseEntityAcl;
|
|
2028
|
+
type BaseEntityOwner = Components.Schemas.BaseEntityOwner;
|
|
2029
|
+
type BaseError = Components.Schemas.BaseError;
|
|
2030
|
+
type BaseNanoID = Components.Schemas.BaseNanoID;
|
|
2031
|
+
type BaseRecipientPayload = Components.Schemas.BaseRecipientPayload;
|
|
2032
|
+
type BaseRelation = Components.Schemas.BaseRelation;
|
|
2033
|
+
type BaseSystemFields = Components.Schemas.BaseSystemFields;
|
|
2034
|
+
type BaseSystemFieldsRequired = Components.Schemas.BaseSystemFieldsRequired;
|
|
2035
|
+
type BaseSystemId = Components.Schemas.BaseSystemId;
|
|
2036
|
+
type BaseTags = Components.Schemas.BaseTags;
|
|
2037
|
+
type BaseUUID = Components.Schemas.BaseUUID;
|
|
2038
|
+
type Campaign = Components.Schemas.Campaign;
|
|
2039
|
+
type CampaignStatus = Components.Schemas.CampaignStatus;
|
|
2040
|
+
type ClientError = Components.Schemas.ClientError;
|
|
2041
|
+
type CreateRecipientPayload = Components.Schemas.CreateRecipientPayload;
|
|
2042
|
+
type ExecutionSummaryItem = Components.Schemas.ExecutionSummaryItem;
|
|
2043
|
+
type GetTargetQueriesParams = Components.Schemas.GetTargetQueriesParams;
|
|
2044
|
+
type JobStatus = Components.Schemas.JobStatus;
|
|
2045
|
+
type MatchCampaignParams = Components.Schemas.MatchCampaignParams;
|
|
2046
|
+
type MatchTargetParams = Components.Schemas.MatchTargetParams;
|
|
2047
|
+
type PortalRecipientPayload = Components.Schemas.PortalRecipientPayload;
|
|
2048
|
+
type PortalStatus = Components.Schemas.PortalStatus;
|
|
2049
|
+
type Recipient = Components.Schemas.Recipient;
|
|
2050
|
+
type RetriggerAutomationsRequest = Components.Schemas.RetriggerAutomationsRequest;
|
|
2051
|
+
type RetriggerAutomationsResult = Components.Schemas.RetriggerAutomationsResult;
|
|
2052
|
+
type ServerError = Components.Schemas.ServerError;
|
|
2053
|
+
type Target = Components.Schemas.Target;
|
|
2054
|
+
type TargetQueryResult = Components.Schemas.TargetQueryResult;
|
|
2055
|
+
type UpdatePortalStatusRequest = Components.Schemas.UpdatePortalStatusRequest;
|
|
2056
|
+
type UpdateRecipientPayload = Components.Schemas.UpdateRecipientPayload;
|
|
2057
|
+
|
|
2058
|
+
export type { AutomationRecipientPayload as A, BaseEntityAcl as B, Client as C, ExecutionSummaryItem as E, GetTargetQueriesParams as G, JobStatus as J, MatchCampaignParams as M, OperationMethods as O, PathsDictionary as P, Recipient as R, ServerError as S, Target as T, UpdatePortalStatusRequest as U, AutomationStatus as a, BaseEntityOwner as b, BaseError as c, BaseNanoID as d, BaseRecipientPayload as e, BaseRelation as f, BaseSystemFields as g, BaseSystemFieldsRequired as h, BaseSystemId as i, BaseTags as j, BaseUUID as k, Campaign as l, CampaignStatus as m, ClientError as n, CreateRecipientPayload as o, MatchTargetParams as p, PortalRecipientPayload as q, PortalStatus as r, RetriggerAutomationsRequest as s, RetriggerAutomationsResult as t, TargetQueryResult as u, UpdateRecipientPayload as v };
|