@hubspot/app-connect-sdk 1.0.0-alpha.4 → 1.0.0-alpha.7
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/.turbo/turbo-format$colon$check.log +4 -0
- package/.turbo/turbo-lint.log +2 -0
- package/.turbo/turbo-test.log +78 -0
- package/.turbo/turbo-tsdown.log +492 -20
- package/build/tsconfig.browser.tsbuildinfo +1 -1
- package/build/tsconfig.server.tsbuildinfo +1 -1
- package/dist/browser/{create-hzqjIhmO.js → create-crdncXsh.js} +2 -2
- package/dist/browser/create-crdncXsh.js.map +1 -0
- package/dist/browser/index.js +1 -1
- package/dist/browser/react/lovable.js +1 -1
- package/dist/server/api-client-core/apis/account/account-info-types.generated.d.ts +111 -0
- package/dist/server/api-client-core/apis/account/account-info.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/account/account-info.generated.js +9 -0
- package/dist/server/api-client-core/apis/account/account-info.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/account/audit-logs-types.generated.d.ts +247 -0
- package/dist/server/api-client-core/apis/account/audit-logs.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/account/audit-logs.generated.js +28 -0
- package/dist/server/api-client-core/apis/account/audit-logs.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/auth/oauth-types.generated.d.ts +121 -0
- package/dist/server/api-client-core/apis/auth/oauth.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/auth/oauth.generated.js +19 -0
- package/dist/server/api-client-core/apis/auth/oauth.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/automation/actions-types.generated.d.ts +933 -0
- package/dist/server/api-client-core/apis/automation/actions.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/automation/actions.generated.js +121 -0
- package/dist/server/api-client-core/apis/automation/actions.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/automation/sequences-types.generated.d.ts +422 -0
- package/dist/server/api-client-core/apis/automation/sequences.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/automation/sequences.generated.js +22 -0
- package/dist/server/api-client-core/apis/automation/sequences.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/business-units-types.generated.d.ts +75 -0
- package/dist/server/api-client-core/apis/business-units.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/business-units.generated.js +12 -0
- package/dist/server/api-client-core/apis/business-units.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/cms/authors-types.generated.d.ts +551 -0
- package/dist/server/api-client-core/apis/cms/authors.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/cms/authors.generated.js +163 -0
- package/dist/server/api-client-core/apis/cms/authors.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/cms/blog-settings-types.generated.d.ts +366 -0
- package/dist/server/api-client-core/apis/cms/blog-settings.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/cms/blog-settings.generated.js +43 -0
- package/dist/server/api-client-core/apis/cms/blog-settings.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/cms/cms-content-audit-types.generated.d.ts +157 -0
- package/dist/server/api-client-core/apis/cms/cms-content-audit.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/cms/cms-content-audit.generated.js +18 -0
- package/dist/server/api-client-core/apis/cms/cms-content-audit.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/cms/domains-types.generated.d.ts +193 -0
- package/dist/server/api-client-core/apis/cms/domains.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/cms/domains.generated.js +20 -0
- package/dist/server/api-client-core/apis/cms/domains.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/cms/hubdb-types.generated.d.ts +1097 -0
- package/dist/server/api-client-core/apis/cms/hubdb.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/cms/hubdb.generated.js +192 -0
- package/dist/server/api-client-core/apis/cms/hubdb.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/cms/media-bridge-types.generated.d.ts +1780 -0
- package/dist/server/api-client-core/apis/cms/media-bridge.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/cms/media-bridge.generated.js +185 -0
- package/dist/server/api-client-core/apis/cms/media-bridge.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/cms/pages-types.generated.d.ts +1768 -0
- package/dist/server/api-client-core/apis/cms/pages.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/cms/pages.generated.js +331 -0
- package/dist/server/api-client-core/apis/cms/pages.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/cms/posts-types.generated.d.ts +1090 -0
- package/dist/server/api-client-core/apis/cms/posts.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/cms/posts.generated.js +201 -0
- package/dist/server/api-client-core/apis/cms/posts.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/cms/site-search-types.generated.d.ts +200 -0
- package/dist/server/api-client-core/apis/cms/site-search.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/cms/site-search.generated.js +32 -0
- package/dist/server/api-client-core/apis/cms/site-search.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/cms/source-code-types.generated.d.ts +218 -0
- package/dist/server/api-client-core/apis/cms/source-code.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/cms/source-code.generated.js +52 -0
- package/dist/server/api-client-core/apis/cms/source-code.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/cms/tags-types.generated.d.ts +515 -0
- package/dist/server/api-client-core/apis/cms/tags.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/cms/tags.generated.js +163 -0
- package/dist/server/api-client-core/apis/cms/tags.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/cms/url-mappings-types.generated.d.ts +177 -0
- package/dist/server/api-client-core/apis/cms/url-mappings.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/cms/url-mappings.generated.js +14 -0
- package/dist/server/api-client-core/apis/cms/url-mappings.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/cms/url-redirects-types.generated.d.ts +226 -0
- package/dist/server/api-client-core/apis/cms/url-redirects.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/cms/url-redirects.generated.js +26 -0
- package/dist/server/api-client-core/apis/cms/url-redirects.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/communication-preferences/subscriptions-types.generated.d.ts +802 -0
- package/dist/server/api-client-core/apis/communication-preferences/subscriptions.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/communication-preferences/subscriptions.generated.js +74 -0
- package/dist/server/api-client-core/apis/communication-preferences/subscriptions.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/conversations/custom-channels-types.generated.d.ts +551 -0
- package/dist/server/api-client-core/apis/conversations/custom-channels.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/conversations/custom-channels.generated.js +80 -0
- package/dist/server/api-client-core/apis/conversations/custom-channels.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/conversations/visitor-identification-types.generated.d.ts +60 -0
- package/dist/server/api-client-core/apis/conversations/visitor-identification.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/conversations/visitor-identification.generated.js +6 -0
- package/dist/server/api-client-core/apis/conversations/visitor-identification.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/conversations-types.generated.d.ts +908 -0
- package/dist/server/api-client-core/apis/conversations.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/conversations.generated.js +108 -0
- package/dist/server/api-client-core/apis/conversations.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/app-uninstalls-types.generated.d.ts +37 -0
- package/dist/server/api-client-core/apis/crm/app-uninstalls.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/app-uninstalls.generated.js +6 -0
- package/dist/server/api-client-core/apis/crm/app-uninstalls.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/appointments-types.generated.d.ts +989 -0
- package/dist/server/api-client-core/apis/crm/appointments.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/appointments.generated.js +118 -0
- package/dist/server/api-client-core/apis/crm/appointments.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/associations-schema-types.generated.d.ts +329 -0
- package/dist/server/api-client-core/apis/crm/associations-schema.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/associations-schema.generated.js +60 -0
- package/dist/server/api-client-core/apis/crm/associations-schema.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/associations-types.generated.d.ts +661 -0
- package/dist/server/api-client-core/apis/crm/associations.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/associations.generated.js +83 -0
- package/dist/server/api-client-core/apis/crm/associations.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/calling-extensions-types.generated.d.ts +466 -0
- package/dist/server/api-client-core/apis/crm/calling-extensions.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/calling-extensions.generated.js +42 -0
- package/dist/server/api-client-core/apis/crm/calling-extensions.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/calls-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/calls.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/calls.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/calls.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/carts-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/carts.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/carts.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/carts.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/commerce-payments-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/commerce-payments.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/commerce-payments.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/commerce-payments.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/commerce-subscriptions-types.generated.d.ts +847 -0
- package/dist/server/api-client-core/apis/crm/commerce-subscriptions.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/commerce-subscriptions.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/commerce-subscriptions.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/communications-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/communications.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/communications.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/communications.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/companies-types.generated.d.ts +884 -0
- package/dist/server/api-client-core/apis/crm/companies.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/companies.generated.js +67 -0
- package/dist/server/api-client-core/apis/crm/companies.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/contacts-types.generated.d.ts +899 -0
- package/dist/server/api-client-core/apis/crm/contacts.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/contacts.generated.js +70 -0
- package/dist/server/api-client-core/apis/crm/contacts.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/contracts-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/contracts.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/contracts.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/contracts.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/courses-types.generated.d.ts +853 -0
- package/dist/server/api-client-core/apis/crm/courses.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/courses.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/courses.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/crm-owners-types.generated.d.ts +140 -0
- package/dist/server/api-client-core/apis/crm/crm-owners.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/crm-owners.generated.js +20 -0
- package/dist/server/api-client-core/apis/crm/crm-owners.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/custom-objects-types.generated.d.ts +934 -0
- package/dist/server/api-client-core/apis/crm/custom-objects.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/custom-objects.generated.js +101 -0
- package/dist/server/api-client-core/apis/crm/custom-objects.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/deal-splits-types.generated.d.ts +196 -0
- package/dist/server/api-client-core/apis/crm/deal-splits.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/deal-splits.generated.js +9 -0
- package/dist/server/api-client-core/apis/crm/deal-splits.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/deals-types.generated.d.ts +872 -0
- package/dist/server/api-client-core/apis/crm/deals.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/deals.generated.js +67 -0
- package/dist/server/api-client-core/apis/crm/deals.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/discounts-types.generated.d.ts +846 -0
- package/dist/server/api-client-core/apis/crm/discounts.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/discounts.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/discounts.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/emails-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/emails.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/emails.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/emails.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/exports-types.generated.d.ts +281 -0
- package/dist/server/api-client-core/apis/crm/exports.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/exports.generated.js +12 -0
- package/dist/server/api-client-core/apis/crm/exports.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/feedback-submissions-types.generated.d.ts +616 -0
- package/dist/server/api-client-core/apis/crm/feedback-submissions.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/feedback-submissions.generated.js +55 -0
- package/dist/server/api-client-core/apis/crm/feedback-submissions.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/fees-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/fees.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/fees.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/fees.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/goal-targets-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/goal-targets.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/goal-targets.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/goal-targets.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/imports-types.generated.d.ts +371 -0
- package/dist/server/api-client-core/apis/crm/imports.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/imports.generated.js +30 -0
- package/dist/server/api-client-core/apis/crm/imports.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/invoices-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/invoices.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/invoices.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/invoices.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/leads-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/leads.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/leads.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/leads.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/limits-tracking-types.generated.d.ts +331 -0
- package/dist/server/api-client-core/apis/crm/limits-tracking.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/limits-tracking.generated.js +22 -0
- package/dist/server/api-client-core/apis/crm/limits-tracking.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/line-items-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/line-items.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/line-items.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/line-items.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/listings-types.generated.d.ts +853 -0
- package/dist/server/api-client-core/apis/crm/listings.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/listings.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/listings.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/lists-types.generated.d.ts +2265 -0
- package/dist/server/api-client-core/apis/crm/lists.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/lists.generated.js +105 -0
- package/dist/server/api-client-core/apis/crm/lists.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/meetings-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/meetings.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/meetings.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/meetings.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/notes-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/notes.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/notes.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/notes.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/object-library-types.generated.d.ts +60 -0
- package/dist/server/api-client-core/apis/crm/object-library.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/object-library.generated.js +9 -0
- package/dist/server/api-client-core/apis/crm/object-library.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/objects-types.generated.d.ts +712 -0
- package/dist/server/api-client-core/apis/crm/objects.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/objects.generated.js +76 -0
- package/dist/server/api-client-core/apis/crm/objects.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/orders-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/orders.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/orders.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/orders.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/partner-clients-types.generated.d.ts +725 -0
- package/dist/server/api-client-core/apis/crm/partner-clients.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/partner-clients.generated.js +71 -0
- package/dist/server/api-client-core/apis/crm/partner-clients.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/partner-services-types.generated.d.ts +725 -0
- package/dist/server/api-client-core/apis/crm/partner-services.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/partner-services.generated.js +71 -0
- package/dist/server/api-client-core/apis/crm/partner-services.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/pipelines-types.generated.d.ts +430 -0
- package/dist/server/api-client-core/apis/crm/pipelines.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/pipelines.generated.js +94 -0
- package/dist/server/api-client-core/apis/crm/pipelines.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/postal-mail-types.generated.d.ts +844 -0
- package/dist/server/api-client-core/apis/crm/postal-mail.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/postal-mail.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/postal-mail.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/products-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/products.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/products.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/products.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/projects-types.generated.d.ts +881 -0
- package/dist/server/api-client-core/apis/crm/projects.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/projects.generated.js +67 -0
- package/dist/server/api-client-core/apis/crm/projects.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/properties-types.generated.d.ts +603 -0
- package/dist/server/api-client-core/apis/crm/properties.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/properties.generated.js +86 -0
- package/dist/server/api-client-core/apis/crm/properties.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/property-validations-types.generated.d.ts +121 -0
- package/dist/server/api-client-core/apis/crm/property-validations.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/property-validations.generated.js +25 -0
- package/dist/server/api-client-core/apis/crm/property-validations.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/public-app-crm-cards-types.generated.d.ts +486 -0
- package/dist/server/api-client-core/apis/crm/public-app-crm-cards.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/public-app-crm-cards.generated.js +34 -0
- package/dist/server/api-client-core/apis/crm/public-app-crm-cards.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/public-app-feature-flags-types.generated.d.ts +247 -0
- package/dist/server/api-client-core/apis/crm/public-app-feature-flags.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/public-app-feature-flags.generated.js +69 -0
- package/dist/server/api-client-core/apis/crm/public-app-feature-flags.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/quotes-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/quotes.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/quotes.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/quotes.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/schemas-types.generated.d.ts +669 -0
- package/dist/server/api-client-core/apis/crm/schemas.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/schemas.generated.js +41 -0
- package/dist/server/api-client-core/apis/crm/schemas.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/services-types.generated.d.ts +853 -0
- package/dist/server/api-client-core/apis/crm/services.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/services.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/services.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/tasks-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/tasks.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/tasks.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/tasks.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/taxes-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/taxes.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/taxes.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/taxes.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/tickets-types.generated.d.ts +884 -0
- package/dist/server/api-client-core/apis/crm/tickets.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/tickets.generated.js +67 -0
- package/dist/server/api-client-core/apis/crm/tickets.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/timeline-types.generated.d.ts +187 -0
- package/dist/server/api-client-core/apis/crm/timeline.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/timeline.generated.js +12 -0
- package/dist/server/api-client-core/apis/crm/timeline.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/transcriptions-types.generated.d.ts +152 -0
- package/dist/server/api-client-core/apis/crm/transcriptions.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/transcriptions.generated.js +15 -0
- package/dist/server/api-client-core/apis/crm/transcriptions.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/users-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/users.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/users.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/users.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/video-conferencing-extension-types.generated.d.ts +72 -0
- package/dist/server/api-client-core/apis/crm/video-conferencing-extension.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/video-conferencing-extension.generated.js +13 -0
- package/dist/server/api-client-core/apis/crm/video-conferencing-extension.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/events/manage-event-definitions-types.generated.d.ts +1005 -0
- package/dist/server/api-client-core/apis/events/manage-event-definitions.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/events/manage-event-definitions.generated.js +39 -0
- package/dist/server/api-client-core/apis/events/manage-event-definitions.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/events/send-event-completions-types.generated.d.ts +94 -0
- package/dist/server/api-client-core/apis/events/send-event-completions.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/events/send-event-completions.generated.js +9 -0
- package/dist/server/api-client-core/apis/events/send-event-completions.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/events-types.generated.d.ts +137 -0
- package/dist/server/api-client-core/apis/events.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/events.generated.js +23 -0
- package/dist/server/api-client-core/apis/events.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/files-types.generated.d.ts +791 -0
- package/dist/server/api-client-core/apis/files.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/files.generated.js +119 -0
- package/dist/server/api-client-core/apis/files.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/marketing/campaigns-public-api-types.generated.d.ts +989 -0
- package/dist/server/api-client-core/apis/marketing/campaigns-public-api.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/marketing/campaigns-public-api.generated.js +139 -0
- package/dist/server/api-client-core/apis/marketing/campaigns-public-api.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/marketing/marketing-emails-types.generated.d.ts +883 -0
- package/dist/server/api-client-core/apis/marketing/marketing-emails.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/marketing/marketing-emails.generated.js +108 -0
- package/dist/server/api-client-core/apis/marketing/marketing-emails.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/marketing/marketing-events-types.generated.d.ts +1788 -0
- package/dist/server/api-client-core/apis/marketing/marketing-events.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/marketing/marketing-events.generated.js +176 -0
- package/dist/server/api-client-core/apis/marketing/marketing-events.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/marketing/single-send-types.generated.d.ts +123 -0
- package/dist/server/api-client-core/apis/marketing/single-send.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/marketing/single-send.generated.js +6 -0
- package/dist/server/api-client-core/apis/marketing/single-send.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/marketing/transactional-single-send-types.generated.d.ts +257 -0
- package/dist/server/api-client-core/apis/marketing/transactional-single-send.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/marketing/transactional-single-send.generated.js +20 -0
- package/dist/server/api-client-core/apis/marketing/transactional-single-send.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/meta/origins-types.generated.d.ts +77 -0
- package/dist/server/api-client-core/apis/meta/origins.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/meta/origins.generated.js +15 -0
- package/dist/server/api-client-core/apis/meta/origins.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/scheduler/meetings-types.generated.d.ts +913 -0
- package/dist/server/api-client-core/apis/scheduler/meetings.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/scheduler/meetings.generated.js +34 -0
- package/dist/server/api-client-core/apis/scheduler/meetings.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/settings/multicurrency-types.generated.d.ts +404 -0
- package/dist/server/api-client-core/apis/settings/multicurrency.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/settings/multicurrency.generated.js +38 -0
- package/dist/server/api-client-core/apis/settings/multicurrency.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/settings/tax-rates-types.generated.d.ts +111 -0
- package/dist/server/api-client-core/apis/settings/tax-rates.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/settings/tax-rates.generated.js +13 -0
- package/dist/server/api-client-core/apis/settings/tax-rates.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/settings/user-provisioning-types.generated.d.ts +297 -0
- package/dist/server/api-client-core/apis/settings/user-provisioning.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/settings/user-provisioning.generated.js +31 -0
- package/dist/server/api-client-core/apis/settings/user-provisioning.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/webhooks-journal-types.generated.d.ts +643 -0
- package/dist/server/api-client-core/apis/webhooks-journal.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/webhooks-journal.generated.js +75 -0
- package/dist/server/api-client-core/apis/webhooks-journal.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/webhooks-types.generated.d.ts +1016 -0
- package/dist/server/api-client-core/apis/webhooks.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/webhooks.generated.js +105 -0
- package/dist/server/api-client-core/apis/webhooks.generated.js.map +1 -0
- package/dist/server/api-client-core/binary-data.d.ts +33 -0
- package/dist/server/api-client-core/binary-data.js +29 -0
- package/dist/server/api-client-core/binary-data.js.map +1 -0
- package/dist/server/api-client-core/client.d.ts +14 -0
- package/dist/server/{binary-data-BOalJzKu.js → api-client-core/client.js} +3 -58
- package/dist/server/api-client-core/client.js.map +1 -0
- package/dist/server/api-client-core/codegen-helpers/file-op-wrappers.js +25 -0
- package/dist/server/api-client-core/codegen-helpers/file-op-wrappers.js.map +1 -0
- package/dist/server/api-client-core/errors.d.ts +27 -0
- package/dist/server/api-client-core/errors.js +33 -0
- package/dist/server/api-client-core/errors.js.map +1 -0
- package/dist/server/api-client-core/op.d.ts +37 -0
- package/dist/server/api-client-core/op.js +44 -0
- package/dist/server/api-client-core/op.js.map +1 -0
- package/dist/server/api-client-core/pagination.d.ts +60 -0
- package/dist/server/api-client-core/pagination.js +103 -0
- package/dist/server/api-client-core/pagination.js.map +1 -0
- package/dist/server/api-client-core/plugins/fetch-transport.js +76 -0
- package/dist/server/api-client-core/plugins/fetch-transport.js.map +1 -0
- package/dist/server/{types-DEOUH4wE.d.ts → api-client-core/types.d.ts} +2 -2
- package/dist/server/api-client.d.ts +197 -60625
- package/dist/server/api-client.js +100 -5826
- package/dist/server/constants.js +73 -0
- package/dist/server/constants.js.map +1 -0
- package/dist/server/deno/start.d.ts +12 -0
- package/dist/server/deno/start.js +21 -0
- package/dist/server/deno/start.js.map +1 -0
- package/dist/server/hono/hono-request-handler.js +59 -0
- package/dist/server/hono/hono-request-handler.js.map +1 -0
- package/dist/server/hono/hubspot-connect-routes/auth-complete.js +154 -0
- package/dist/server/hono/hubspot-connect-routes/auth-complete.js.map +1 -0
- package/dist/server/hono/hubspot-connect-routes/auth-init-session.js +101 -0
- package/dist/server/hono/hubspot-connect-routes/auth-init-session.js.map +1 -0
- package/dist/server/hono/hubspot-connect-routes/auth-logout.js +114 -0
- package/dist/server/hono/hubspot-connect-routes/auth-logout.js.map +1 -0
- package/dist/server/hono/hubspot-connect-routes/auth-refresh.js +107 -0
- package/dist/server/hono/hubspot-connect-routes/auth-refresh.js.map +1 -0
- package/dist/server/hono/hubspot-connect-routes/cimd-client-metadata-types.d.ts +16 -0
- package/dist/server/hono/hubspot-connect-routes/cimd-client-metadata-types.js +13 -0
- package/dist/server/hono/hubspot-connect-routes/cimd-client-metadata-types.js.map +1 -0
- package/dist/server/hono/hubspot-connect-routes/cimd-public-routes.js +42 -0
- package/dist/server/hono/hubspot-connect-routes/cimd-public-routes.js.map +1 -0
- package/dist/server/hono/hubspot-connect-routes/constants.js +8 -0
- package/dist/server/hono/hubspot-connect-routes/constants.js.map +1 -0
- package/dist/server/hono/hubspot-connect-routes/fetch-hubspot-client-metadata.js +43 -0
- package/dist/server/hono/hubspot-connect-routes/fetch-hubspot-client-metadata.js.map +1 -0
- package/dist/server/hono/hubspot-connect-routes/hubspot-connect-routes.js +37 -0
- package/dist/server/hono/hubspot-connect-routes/hubspot-connect-routes.js.map +1 -0
- package/dist/server/hono/hubspot-connect-routes/load-hubspot-connect-routes-env.js +34 -0
- package/dist/server/hono/hubspot-connect-routes/load-hubspot-connect-routes-env.js.map +1 -0
- package/dist/server/hono/hubspot-connect-routes/oauth-client.js +104 -0
- package/dist/server/hono/hubspot-connect-routes/oauth-client.js.map +1 -0
- package/dist/server/hono/hubspot-connect-routes/utils.js +120 -0
- package/dist/server/hono/hubspot-connect-routes/utils.js.map +1 -0
- package/dist/server/hono/index.js +4 -0
- package/dist/server/hono/types.d.ts +32 -0
- package/dist/server/hono/utils/cookie-utils.js +30 -0
- package/dist/server/hono/utils/cookie-utils.js.map +1 -0
- package/dist/server/hono/utils/cors-middleware.js +85 -0
- package/dist/server/hono/utils/cors-middleware.js.map +1 -0
- package/dist/server/import-app-keys.js +42 -0
- package/dist/server/import-app-keys.js.map +1 -0
- package/dist/server/lovable/create-app-function-start.d.ts +26 -0
- package/dist/server/lovable/create-app-function-start.js +28 -0
- package/dist/server/lovable/create-app-function-start.js.map +1 -0
- package/dist/server/lovable/hubspot-connect/index.d.ts +15 -0
- package/dist/server/lovable/hubspot-connect/index.js +20 -0
- package/dist/server/lovable/hubspot-connect/index.js.map +1 -0
- package/dist/server/lovable/hubspot-connect/run-hubspot-connect-lovable-server.js +27 -0
- package/dist/server/lovable/hubspot-connect/run-hubspot-connect-lovable-server.js.map +1 -0
- package/dist/server/lovable.d.ts +6 -117
- package/dist/server/lovable.js +3 -1458
- package/dist/server/oauth.d.ts +6 -128
- package/dist/server/oauth.js +4 -1
- package/dist/server/proxy.js +68 -0
- package/dist/server/proxy.js.map +1 -0
- package/dist/server/sanitize-request.js +55 -0
- package/dist/server/sanitize-request.js.map +1 -0
- package/dist/server/secure-start-core.d.ts +23 -0
- package/dist/server/secure-start-core.js +27 -0
- package/dist/server/secure-start-core.js.map +1 -0
- package/dist/server/shared/constants.js +30 -0
- package/dist/server/shared/constants.js.map +1 -0
- package/dist/server/shared/encoding/base64.js +45 -0
- package/dist/server/shared/encoding/base64.js.map +1 -0
- package/dist/server/shared/encoding/sha256.d.ts +10 -0
- package/dist/server/shared/encoding/sha256.js +15 -0
- package/dist/server/shared/encoding/sha256.js.map +1 -0
- package/dist/server/shared/logger.d.ts +15 -0
- package/dist/server/shared/logger.js +16 -0
- package/dist/server/shared/logger.js.map +1 -0
- package/dist/server/{types-5gfN91Fq.d.ts → types.d.ts} +4 -4
- package/dist/server/utils/cookie-utils.js +21 -0
- package/dist/server/utils/cookie-utils.js.map +1 -0
- package/dist/server/utils/dpop-utils.d.ts +67 -0
- package/dist/server/utils/dpop-utils.js +75 -0
- package/dist/server/utils/dpop-utils.js.map +1 -0
- package/dist/server/utils/env-utils.js +107 -0
- package/dist/server/utils/env-utils.js.map +1 -0
- package/dist/server/utils/jwk-utils.d.ts +16 -0
- package/dist/server/utils/jwk-utils.js +24 -0
- package/dist/server/utils/jwk-utils.js.map +1 -0
- package/dist/server/utils/jwt-utils.d.ts +39 -0
- package/dist/server/utils/jwt-utils.js +87 -0
- package/dist/server/utils/jwt-utils.js.map +1 -0
- package/package.json +3 -3
- package/src/browser/app-connect-controller/connect-start.ts +1 -2
- package/src/server/hono/hubspot-connect-routes/load-hubspot-connect-routes-env.test.ts +17 -24
- package/src/server/hono/hubspot-connect-routes/load-hubspot-connect-routes-env.ts +8 -8
- package/src/server/lovable/hubspot-connect/run-hubspot-connect-lovable-server.ts +2 -3
- package/src/server/proxy.test.ts +1 -1
- package/src/server/proxy.ts +7 -4
- package/src/server/secure-start-core.ts +7 -6
- package/src/server/types.ts +2 -2
- package/src/server/utils/env-utils.test.ts +140 -12
- package/src/server/utils/env-utils.ts +80 -6
- package/tsdown.config.ts +1 -1
- package/dist/browser/create-hzqjIhmO.js.map +0 -1
- package/dist/server/api-client.js.map +0 -1
- package/dist/server/binary-data-BOalJzKu.js.map +0 -1
- package/dist/server/lovable.js.map +0 -1
- package/dist/server/sha256-B7y8GBFB.js +0 -228
- package/dist/server/sha256-B7y8GBFB.js.map +0 -1
|
@@ -0,0 +1,883 @@
|
|
|
1
|
+
import { Operation } from "../../types.js";
|
|
2
|
+
|
|
3
|
+
//#region src/server/api-client-core/apis/marketing/marketing-emails-types.generated.d.ts
|
|
4
|
+
declare namespace MarketingMarketingEmails {
|
|
5
|
+
namespace Basic {
|
|
6
|
+
type CreateInput = Schemas.EmailCreateRequest;
|
|
7
|
+
type CreateOutput = Schemas.PublicEmail;
|
|
8
|
+
interface GetHistogramInput {
|
|
9
|
+
emailIds?: number[];
|
|
10
|
+
endTimestamp?: string;
|
|
11
|
+
interval?: 'DAY' | 'HOUR' | 'MINUTE' | 'MONTH' | 'QUARTER' | 'QUARTER_HOUR' | 'SECOND' | 'WEEK' | 'YEAR';
|
|
12
|
+
startTimestamp?: string;
|
|
13
|
+
}
|
|
14
|
+
type GetHistogramOutput = Schemas.CollectionResponseWithTotalEmailStatisticInterval;
|
|
15
|
+
interface GetInput {
|
|
16
|
+
emailIds?: number[];
|
|
17
|
+
endTimestamp?: string;
|
|
18
|
+
property?: string;
|
|
19
|
+
startTimestamp?: string;
|
|
20
|
+
}
|
|
21
|
+
type GetOutput = Schemas.AggregateEmailStatistics;
|
|
22
|
+
interface ListInput {
|
|
23
|
+
/**
|
|
24
|
+
* The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
|
|
25
|
+
*/
|
|
26
|
+
after?: string;
|
|
27
|
+
/**
|
|
28
|
+
* Whether to return only results that have been archived.
|
|
29
|
+
*/
|
|
30
|
+
archived?: boolean;
|
|
31
|
+
campaign?: string;
|
|
32
|
+
createdAfter?: string;
|
|
33
|
+
createdAt?: string;
|
|
34
|
+
createdBefore?: string;
|
|
35
|
+
includedProperties?: string[];
|
|
36
|
+
includeStats?: boolean;
|
|
37
|
+
isPublished?: boolean;
|
|
38
|
+
/**
|
|
39
|
+
* The maximum number of results to display per page.
|
|
40
|
+
*/
|
|
41
|
+
limit?: number;
|
|
42
|
+
marketingCampaignNames?: boolean;
|
|
43
|
+
publishedAfter?: string;
|
|
44
|
+
publishedAt?: string;
|
|
45
|
+
publishedBefore?: string;
|
|
46
|
+
sort?: string[];
|
|
47
|
+
type?: 'AB_EMAIL' | 'AUTOMATED_AB_EMAIL' | 'AUTOMATED_EMAIL' | 'BATCH_EMAIL' | 'BLOG_EMAIL' | 'BLOG_EMAIL_CHILD' | 'FEEDBACK_CES_EMAIL' | 'FEEDBACK_CUSTOM_EMAIL' | 'FEEDBACK_CUSTOM_SURVEY_EMAIL' | 'FEEDBACK_NPS_EMAIL' | 'FOLLOWUP_EMAIL' | 'LEADFLOW_EMAIL' | 'LOCALTIME_EMAIL' | 'MANAGE_PREFERENCES_EMAIL' | 'MARKETING_SINGLE_SEND_API' | 'MEMBERSHIP_EMAIL_VERIFICATION_EMAIL' | 'MEMBERSHIP_FOLLOW_UP_EMAIL' | 'MEMBERSHIP_OTP_LOGIN_EMAIL' | 'MEMBERSHIP_PASSWORD_RESET_EMAIL' | 'MEMBERSHIP_PASSWORD_SAVED_EMAIL' | 'MEMBERSHIP_PASSWORDLESS_AUTH_EMAIL' | 'MEMBERSHIP_REGISTRATION_EMAIL' | 'MEMBERSHIP_REGISTRATION_FOLLOW_UP_EMAIL' | 'MEMBERSHIP_VERIFICATION_EMAIL' | 'OPTIN_EMAIL' | 'OPTIN_FOLLOWUP_EMAIL' | 'RESUBSCRIBE_EMAIL' | 'RSS_EMAIL' | 'RSS_EMAIL_CHILD' | 'SINGLE_SEND_API' | 'SMTP_TOKEN' | 'TICKET_EMAIL';
|
|
48
|
+
updatedAfter?: string;
|
|
49
|
+
updatedAt?: string;
|
|
50
|
+
updatedBefore?: string;
|
|
51
|
+
variantStats?: boolean;
|
|
52
|
+
workflowNames?: boolean;
|
|
53
|
+
}
|
|
54
|
+
type ListOutput = Schemas.CollectionResponseWithTotalPublicEmail;
|
|
55
|
+
}
|
|
56
|
+
namespace Emails {
|
|
57
|
+
type CloneInput = Schemas.EmailCloneRequestVNext;
|
|
58
|
+
type CloneOutput = Schemas.PublicEmail;
|
|
59
|
+
type CreateAbTestVariationInput = Schemas.AbTestCreateRequestVNext;
|
|
60
|
+
type CreateAbTestVariationOutput = Schemas.PublicEmail;
|
|
61
|
+
interface DeleteInput {
|
|
62
|
+
/**
|
|
63
|
+
* Whether to return only results that have been archived.
|
|
64
|
+
*/
|
|
65
|
+
archived?: boolean;
|
|
66
|
+
emailId: string;
|
|
67
|
+
}
|
|
68
|
+
type DeleteOutput = void;
|
|
69
|
+
interface GetAbTestVariationInput {
|
|
70
|
+
/**
|
|
71
|
+
* Whether to return only results that have been archived.
|
|
72
|
+
*/
|
|
73
|
+
archived?: boolean;
|
|
74
|
+
emailId: string;
|
|
75
|
+
includedProperties?: string[];
|
|
76
|
+
includeStats?: boolean;
|
|
77
|
+
marketingCampaignNames?: boolean;
|
|
78
|
+
variantStats?: boolean;
|
|
79
|
+
workflowNames?: boolean;
|
|
80
|
+
}
|
|
81
|
+
type GetAbTestVariationOutput = Schemas.PublicEmail;
|
|
82
|
+
interface GetDraftInput {
|
|
83
|
+
emailId: string;
|
|
84
|
+
}
|
|
85
|
+
type GetDraftOutput = Schemas.PublicEmail;
|
|
86
|
+
interface GetInput {
|
|
87
|
+
/**
|
|
88
|
+
* Whether to return only results that have been archived.
|
|
89
|
+
*/
|
|
90
|
+
archived?: boolean;
|
|
91
|
+
emailId: string;
|
|
92
|
+
includedProperties?: string[];
|
|
93
|
+
includeStats?: boolean;
|
|
94
|
+
marketingCampaignNames?: boolean;
|
|
95
|
+
variantStats?: boolean;
|
|
96
|
+
workflowNames?: boolean;
|
|
97
|
+
}
|
|
98
|
+
type GetOutput = Schemas.PublicEmail;
|
|
99
|
+
interface GetRevisionInput {
|
|
100
|
+
emailId: string;
|
|
101
|
+
revisionId: string;
|
|
102
|
+
}
|
|
103
|
+
type GetRevisionOutput = Schemas.PublicEmailVersion;
|
|
104
|
+
interface ListRevisionsInput {
|
|
105
|
+
/**
|
|
106
|
+
* The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
|
|
107
|
+
*/
|
|
108
|
+
after?: string;
|
|
109
|
+
before?: string;
|
|
110
|
+
emailId: string;
|
|
111
|
+
/**
|
|
112
|
+
* The maximum number of results to display per page.
|
|
113
|
+
*/
|
|
114
|
+
limit?: number;
|
|
115
|
+
}
|
|
116
|
+
type ListRevisionsOutput = Schemas.CollectionResponseWithTotalPublicEmailVersion;
|
|
117
|
+
interface PublishInput {
|
|
118
|
+
emailId: string;
|
|
119
|
+
}
|
|
120
|
+
type PublishOutput = void;
|
|
121
|
+
interface ResetDraftInput {
|
|
122
|
+
emailId: string;
|
|
123
|
+
}
|
|
124
|
+
type ResetDraftOutput = void;
|
|
125
|
+
interface RestoreRevisionInput {
|
|
126
|
+
emailId: string;
|
|
127
|
+
revisionId: string;
|
|
128
|
+
}
|
|
129
|
+
type RestoreRevisionOutput = void;
|
|
130
|
+
interface RestoreRevisionToDraftInput {
|
|
131
|
+
emailId: string;
|
|
132
|
+
revisionId: number;
|
|
133
|
+
}
|
|
134
|
+
type RestoreRevisionToDraftOutput = Schemas.PublicEmail;
|
|
135
|
+
interface UnpublishInput {
|
|
136
|
+
emailId: string;
|
|
137
|
+
}
|
|
138
|
+
type UnpublishOutput = void;
|
|
139
|
+
interface UpdateDraftInput {
|
|
140
|
+
data: Schemas.EmailUpdateRequest;
|
|
141
|
+
emailId: string;
|
|
142
|
+
}
|
|
143
|
+
type UpdateDraftOutput = Schemas.PublicEmail;
|
|
144
|
+
interface UpdateInput {
|
|
145
|
+
/**
|
|
146
|
+
* Whether to return only results that have been archived.
|
|
147
|
+
*/
|
|
148
|
+
archived?: boolean;
|
|
149
|
+
data: Schemas.EmailUpdateRequest;
|
|
150
|
+
emailId: string;
|
|
151
|
+
}
|
|
152
|
+
type UpdateOutput = Schemas.PublicEmail;
|
|
153
|
+
}
|
|
154
|
+
namespace Schemas {
|
|
155
|
+
interface AbTestCreateRequestVNext {
|
|
156
|
+
/**
|
|
157
|
+
* ID of the object to test.
|
|
158
|
+
*/
|
|
159
|
+
contentId: string;
|
|
160
|
+
/**
|
|
161
|
+
* Name of the variation to be created.
|
|
162
|
+
*/
|
|
163
|
+
variationName: string;
|
|
164
|
+
}
|
|
165
|
+
interface AggregateEmailStatistics {
|
|
166
|
+
aggregate: Schemas.EmailStatisticsData;
|
|
167
|
+
/**
|
|
168
|
+
* The aggregated statistics per campaign.
|
|
169
|
+
*/
|
|
170
|
+
campaignAggregations: Record<string, Schemas.EmailStatisticsData>;
|
|
171
|
+
/**
|
|
172
|
+
* List of email IDs that were sent during the time span.
|
|
173
|
+
*/
|
|
174
|
+
emails: number[];
|
|
175
|
+
}
|
|
176
|
+
interface CollectionResponseWithTotalEmailStatisticInterval {
|
|
177
|
+
paging?: Schemas.Paging;
|
|
178
|
+
results: Schemas.EmailStatisticInterval[];
|
|
179
|
+
total: number;
|
|
180
|
+
}
|
|
181
|
+
interface CollectionResponseWithTotalPublicEmail {
|
|
182
|
+
paging?: Schemas.Paging;
|
|
183
|
+
results: Schemas.PublicEmail[];
|
|
184
|
+
total: number;
|
|
185
|
+
}
|
|
186
|
+
interface CollectionResponseWithTotalPublicEmailVersion {
|
|
187
|
+
paging?: Schemas.Paging;
|
|
188
|
+
results: Schemas.VersionPublicEmail[];
|
|
189
|
+
total: number;
|
|
190
|
+
}
|
|
191
|
+
interface EmailCloneRequestVNext {
|
|
192
|
+
/**
|
|
193
|
+
* The name to assign to the cloned email.
|
|
194
|
+
*/
|
|
195
|
+
cloneName?: string;
|
|
196
|
+
/**
|
|
197
|
+
* The email ID.
|
|
198
|
+
*/
|
|
199
|
+
id: string;
|
|
200
|
+
/**
|
|
201
|
+
* The language code for the cloned email, such as 'en' for English.
|
|
202
|
+
*/
|
|
203
|
+
language?: string;
|
|
204
|
+
}
|
|
205
|
+
interface EmailCreateRequest {
|
|
206
|
+
/**
|
|
207
|
+
* The active domain of the email.
|
|
208
|
+
*/
|
|
209
|
+
activeDomain?: string;
|
|
210
|
+
/**
|
|
211
|
+
* Determines if the email is archived or not.
|
|
212
|
+
*/
|
|
213
|
+
archived?: boolean;
|
|
214
|
+
/**
|
|
215
|
+
* The ID of the business unit associated with the email.
|
|
216
|
+
*/
|
|
217
|
+
businessUnitId?: number;
|
|
218
|
+
/**
|
|
219
|
+
* The ID of the campaign this email is associated to.
|
|
220
|
+
*/
|
|
221
|
+
campaign?: string;
|
|
222
|
+
content?: Schemas.PublicEmailContent;
|
|
223
|
+
/**
|
|
224
|
+
* The ID of the feedback survey linked to the email.
|
|
225
|
+
*/
|
|
226
|
+
feedbackSurveyId?: string;
|
|
227
|
+
/**
|
|
228
|
+
* The ID of the folder where the email will be stored.
|
|
229
|
+
*/
|
|
230
|
+
folderIdV2?: number;
|
|
231
|
+
from?: Schemas.PublicEmailFromDetails;
|
|
232
|
+
/**
|
|
233
|
+
* Determines whether the email send time should be randomized to avoid sending all emails at the exact same time.
|
|
234
|
+
*/
|
|
235
|
+
jitterSendTime?: boolean;
|
|
236
|
+
/**
|
|
237
|
+
* The language code for the email, such as 'en' for English.
|
|
238
|
+
*/
|
|
239
|
+
language?: 'aa' | 'ab' | 'ae' | 'af' | 'af-na' | 'af-za' | 'agq' | 'agq-cm' | 'ak' | 'ak-gh' | 'am' | 'am-et' | 'an' | 'ann' | 'ann-ng' | 'ar' | 'ar-001' | 'ar-ae' | 'ar-bh' | 'ar-dj' | 'ar-dz' | 'ar-eg' | 'ar-eh' | 'ar-er' | 'ar-il' | 'ar-iq' | 'ar-jo' | 'ar-km' | 'ar-kw' | 'ar-lb' | 'ar-ly' | 'ar-ma' | 'ar-mr' | 'ar-om' | 'ar-ps' | 'ar-qa' | 'ar-sa' | 'ar-sd' | 'ar-so' | 'ar-ss' | 'ar-sy' | 'ar-td' | 'ar-tn' | 'ar-ye' | 'as' | 'as-in' | 'asa' | 'asa-tz' | 'ast' | 'ast-es' | 'av' | 'ay' | 'az' | 'az-az' | 'ba' | 'bas' | 'bas-cm' | 'be' | 'be-by' | 'bem' | 'bem-zm' | 'bez' | 'bez-tz' | 'bg' | 'bg-bg' | 'bgc' | 'bgc-in' | 'bho' | 'bho-in' | 'bi' | 'bm' | 'bm-ml' | 'bn' | 'bn-bd' | 'bn-in' | 'bo' | 'bo-cn' | 'bo-in' | 'br' | 'br-fr' | 'brx' | 'brx-in' | 'bs' | 'bs-ba' | 'ca' | 'ca-ad' | 'ca-es' | 'ca-fr' | 'ca-it' | 'ccp' | 'ccp-bd' | 'ccp-in' | 'ce' | 'ce-ru' | 'ceb' | 'ceb-ph' | 'cgg' | 'cgg-ug' | 'ch' | 'chr' | 'chr-us' | 'ckb' | 'ckb-iq' | 'ckb-ir' | 'co' | 'cr' | 'cs' | 'cs-cz' | 'cu' | 'cu-ru' | 'cv' | 'cv-ru' | 'cy' | 'cy-gb' | 'da' | 'da-dk' | 'da-gl' | 'dav' | 'dav-ke' | 'de' | 'de-at' | 'de-be' | 'de-ch' | 'de-de' | 'de-gr' | 'de-it' | 'de-li' | 'de-lu' | 'dje' | 'dje-ne' | 'doi' | 'doi-in' | 'dsb' | 'dsb-de' | 'dua' | 'dua-cm' | 'dv' | 'dyo' | 'dyo-sn' | 'dz' | 'dz-bt' | 'ebu' | 'ebu-ke' | 'ee' | 'ee-gh' | 'ee-tg' | 'el' | 'el-cy' | 'el-gr' | 'en' | 'en-001' | 'en-150' | 'en-ae' | 'en-ag' | 'en-ai' | 'en-as' | 'en-at' | 'en-au' | 'en-bb' | 'en-be' | 'en-bi' | 'en-bm' | 'en-bs' | 'en-bw' | 'en-bz' | 'en-ca' | 'en-cc' | 'en-ch' | 'en-ck' | 'en-cm' | 'en-cn' | 'en-cx' | 'en-cy' | 'en-de' | 'en-dg' | 'en-dk' | 'en-dm' | 'en-ee' | 'en-eg' | 'en-er' | 'en-es' | 'en-fi' | 'en-fj' | 'en-fk' | 'en-fm' | 'en-fr' | 'en-gb' | 'en-gd' | 'en-gg' | 'en-gh' | 'en-gi' | 'en-gm' | 'en-gu' | 'en-gy' | 'en-hk' | 'en-id' | 'en-ie' | 'en-il' | 'en-im' | 'en-in' | 'en-io' | 'en-je' | 'en-jm' | 'en-ke' | 'en-ki' | 'en-kn' | 'en-ky' | 'en-lc' | 'en-lr' | 'en-ls' | 'en-lu' | 'en-mg' | 'en-mh' | 'en-mo' | 'en-mp' | 'en-ms' | 'en-mt' | 'en-mu' | 'en-mv' | 'en-mw' | 'en-mx' | 'en-my' | 'en-na' | 'en-nf' | 'en-ng' | 'en-nl' | 'en-nr' | 'en-nu' | 'en-nz' | 'en-pg' | 'en-ph' | 'en-pk' | 'en-pn' | 'en-pr' | 'en-pt' | 'en-pw' | 'en-rw' | 'en-sb' | 'en-sc' | 'en-sd' | 'en-se' | 'en-sg' | 'en-sh' | 'en-si' | 'en-sl' | 'en-ss' | 'en-sx' | 'en-sz' | 'en-tc' | 'en-th' | 'en-tk' | 'en-tn' | 'en-to' | 'en-tt' | 'en-tv' | 'en-tz' | 'en-ug' | 'en-um' | 'en-us' | 'en-vc' | 'en-vg' | 'en-vi' | 'en-vn' | 'en-vu' | 'en-ws' | 'en-za' | 'en-zm' | 'en-zw' | 'eo' | 'eo-001' | 'es' | 'es-419' | 'es-ar' | 'es-bo' | 'es-br' | 'es-bz' | 'es-cl' | 'es-co' | 'es-cr' | 'es-cu' | 'es-do' | 'es-ea' | 'es-ec' | 'es-es' | 'es-gq' | 'es-gt' | 'es-hn' | 'es-ic' | 'es-mx' | 'es-ni' | 'es-pa' | 'es-pe' | 'es-ph' | 'es-pr' | 'es-py' | 'es-sv' | 'es-us' | 'es-uy' | 'es-ve' | 'et' | 'et-ee' | 'eu' | 'eu-es' | 'ewo' | 'ewo-cm' | 'fa' | 'fa-af' | 'fa-ir' | 'ff' | 'ff-bf' | 'ff-cm' | 'ff-gh' | 'ff-gm' | 'ff-gn' | 'ff-gw' | 'ff-lr' | 'ff-mr' | 'ff-ne' | 'ff-ng' | 'ff-sl' | 'ff-sn' | 'fi' | 'fi-fi' | 'fil' | 'fil-ph' | 'fj' | 'fo' | 'fo-dk' | 'fo-fo' | 'fr' | 'fr-be' | 'fr-bf' | 'fr-bi' | 'fr-bj' | 'fr-bl' | 'fr-ca' | 'fr-cd' | 'fr-cf' | 'fr-cg' | 'fr-ch' | 'fr-ci' | 'fr-cm' | 'fr-dj' | 'fr-dz' | 'fr-fr' | 'fr-ga' | 'fr-gf' | 'fr-gn' | 'fr-gp' | 'fr-gq' | 'fr-ht' | 'fr-km' | 'fr-lu' | 'fr-ma' | 'fr-mc' | 'fr-mf' | 'fr-mg' | 'fr-ml' | 'fr-mq' | 'fr-mr' | 'fr-mu' | 'fr-nc' | 'fr-ne' | 'fr-pf' | 'fr-pm' | 'fr-re' | 'fr-rw' | 'fr-sc' | 'fr-sn' | 'fr-sy' | 'fr-td' | 'fr-tg' | 'fr-tn' | 'fr-vu' | 'fr-wf' | 'fr-yt' | 'frr' | 'frr-de' | 'fur' | 'fur-it' | 'fy' | 'fy-nl' | 'ga' | 'ga-gb' | 'ga-ie' | 'gd' | 'gd-gb' | 'gl' | 'gl-es' | 'gn' | 'gsw' | 'gsw-ch' | 'gsw-fr' | 'gsw-li' | 'gu' | 'gu-in' | 'guz' | 'guz-ke' | 'gv' | 'gv-im' | 'ha' | 'ha-gh' | 'ha-ne' | 'ha-ng' | 'haw' | 'haw-us' | 'he' | 'he-il' | 'hi' | 'hi-in' | 'hmn' | 'ho' | 'hr' | 'hr-ba' | 'hr-hr' | 'hsb' | 'hsb-de' | 'ht' | 'hu' | 'hu-hu' | 'hy' | 'hy-am' | 'hz' | 'ia' | 'ia-001' | 'id' | 'id-id' | 'ie' | 'ig' | 'ig-ng' | 'ii' | 'ii-cn' | 'ik' | 'io' | 'is' | 'is-is' | 'it' | 'it-ch' | 'it-it' | 'it-sm' | 'it-va' | 'iu' | 'ja' | 'ja-jp' | 'jgo' | 'jgo-cm' | 'jmc' | 'jmc-tz' | 'jv' | 'jv-id' | 'ka' | 'ka-ge' | 'kab' | 'kab-dz' | 'kam' | 'kam-ke' | 'kar' | 'kde' | 'kde-tz' | 'kea' | 'kea-cv' | 'kg' | 'kgp' | 'kgp-br' | 'kh' | 'khq' | 'khq-ml' | 'ki' | 'ki-ke' | 'kj' | 'kk' | 'kk-kz' | 'kkj' | 'kkj-cm' | 'kl' | 'kl-gl' | 'kln' | 'kln-ke' | 'km' | 'km-kh' | 'kn' | 'kn-in' | 'ko' | 'ko-kp' | 'ko-kr' | 'kok' | 'kok-in' | 'kr' | 'ks' | 'ks-in' | 'ksb' | 'ksb-tz' | 'ksf' | 'ksf-cm' | 'ksh' | 'ksh-de' | 'ku' | 'ku-tr' | 'kv' | 'kw' | 'kw-gb' | 'ky' | 'ky-kg' | 'la' | 'lag' | 'lag-tz' | 'lb' | 'lb-lu' | 'lg' | 'lg-ug' | 'li' | 'lkt' | 'lkt-us' | 'ln' | 'ln-ao' | 'ln-cd' | 'ln-cf' | 'ln-cg' | 'lo' | 'lo-la' | 'lrc' | 'lrc-iq' | 'lrc-ir' | 'lt' | 'lt-lt' | 'lu' | 'lu-cd' | 'luo' | 'luo-ke' | 'luy' | 'luy-ke' | 'lv' | 'lv-lv' | 'mai' | 'mai-in' | 'mas' | 'mas-ke' | 'mas-tz' | 'mdf' | 'mdf-ru' | 'mer' | 'mer-ke' | 'mfe' | 'mfe-mu' | 'mg' | 'mg-mg' | 'mgh' | 'mgh-mz' | 'mgo' | 'mgo-cm' | 'mh' | 'mi' | 'mi-nz' | 'mk' | 'mk-mk' | 'ml' | 'ml-in' | 'mn' | 'mn-mn' | 'mni' | 'mni-in' | 'mr' | 'mr-in' | 'ms' | 'ms-bn' | 'ms-id' | 'ms-my' | 'ms-sg' | 'mt' | 'mt-mt' | 'mua' | 'mua-cm' | 'my' | 'my-mm' | 'mzn' | 'mzn-ir' | 'na' | 'naq' | 'naq-na' | 'nb' | 'nb-no' | 'nb-sj' | 'nd' | 'nd-zw' | 'nds' | 'nds-de' | 'nds-nl' | 'ne' | 'ne-in' | 'ne-np' | 'ng' | 'nl' | 'nl-aw' | 'nl-be' | 'nl-bq' | 'nl-ch' | 'nl-cw' | 'nl-lu' | 'nl-nl' | 'nl-sr' | 'nl-sx' | 'nmg' | 'nmg-cm' | 'nn' | 'nn-no' | 'nnh' | 'nnh-cm' | 'no' | 'no-no' | 'nr' | 'nus' | 'nus-ss' | 'nv' | 'ny' | 'nyn' | 'nyn-ug' | 'oc' | 'oc-es' | 'oc-fr' | 'oj' | 'om' | 'om-et' | 'om-ke' | 'or' | 'or-in' | 'os' | 'os-ge' | 'os-ru' | 'pa' | 'pa-in' | 'pa-pk' | 'pcm' | 'pcm-ng' | 'pi' | 'pis' | 'pis-sb' | 'pl' | 'pl-pl' | 'prg' | 'prg-001' | 'ps' | 'ps-af' | 'ps-pk' | 'pt' | 'pt-ao' | 'pt-br' | 'pt-ch' | 'pt-cv' | 'pt-gq' | 'pt-gw' | 'pt-lu' | 'pt-mo' | 'pt-mz' | 'pt-pt' | 'pt-st' | 'pt-tl' | 'qu' | 'qu-bo' | 'qu-ec' | 'qu-pe' | 'raj' | 'raj-in' | 'rm' | 'rm-ch' | 'rn' | 'rn-bi' | 'ro' | 'ro-md' | 'ro-ro' | 'rof' | 'rof-tz' | 'ru' | 'ru-by' | 'ru-kg' | 'ru-kz' | 'ru-md' | 'ru-ru' | 'ru-ua' | 'rw' | 'rw-rw' | 'rwk' | 'rwk-tz' | 'sa' | 'sa-in' | 'sah' | 'sah-ru' | 'saq' | 'saq-ke' | 'sat' | 'sat-in' | 'sbp' | 'sbp-tz' | 'sc' | 'sc-it' | 'sd' | 'sd-in' | 'sd-pk' | 'se' | 'se-fi' | 'se-no' | 'se-se' | 'seh' | 'seh-mz' | 'ses' | 'ses-ml' | 'sg' | 'sg-cf' | 'shi' | 'shi-ma' | 'si' | 'si-lk' | 'sk' | 'sk-sk' | 'sl' | 'sl-si' | 'sm' | 'smn' | 'smn-fi' | 'sms' | 'sms-fi' | 'sn' | 'sn-zw' | 'so' | 'so-dj' | 'so-et' | 'so-ke' | 'so-so' | 'sq' | 'sq-al' | 'sq-mk' | 'sq-xk' | 'sr' | 'sr-ba' | 'sr-cs' | 'sr-me' | 'sr-rs' | 'sr-xk' | 'ss' | 'st' | 'su' | 'su-id' | 'sv' | 'sv-ax' | 'sv-fi' | 'sv-se' | 'sw' | 'sw-cd' | 'sw-ke' | 'sw-tz' | 'sw-ug' | 'sy' | 'ta' | 'ta-in' | 'ta-lk' | 'ta-my' | 'ta-sg' | 'te' | 'te-in' | 'teo' | 'teo-ke' | 'teo-ug' | 'tg' | 'tg-tj' | 'th' | 'th-th' | 'ti' | 'ti-er' | 'ti-et' | 'tk' | 'tk-tm' | 'tl' | 'tn' | 'to' | 'to-to' | 'tok' | 'tok-001' | 'tr' | 'tr-cy' | 'tr-tr' | 'ts' | 'tt' | 'tt-ru' | 'tw' | 'twq' | 'twq-ne' | 'ty' | 'tzm' | 'tzm-ma' | 'ug' | 'ug-cn' | 'uk' | 'uk-ua' | 'ur' | 'ur-in' | 'ur-pk' | 'uz' | 'uz-af' | 'uz-uz' | 'vai' | 'vai-lr' | 've' | 'vi' | 'vi-vn' | 'vo' | 'vo-001' | 'vun' | 'vun-tz' | 'wa' | 'wae' | 'wae-ch' | 'wo' | 'wo-sn' | 'xh' | 'xh-za' | 'xog' | 'xog-ug' | 'yav' | 'yav-cm' | 'yi' | 'yi-001' | 'yo' | 'yo-bj' | 'yo-ng' | 'yrl' | 'yrl-br' | 'yrl-co' | 'yrl-ve' | 'yue' | 'yue-cn' | 'yue-hk' | 'za' | 'zgh' | 'zgh-ma' | 'zh' | 'zh-cn' | 'zh-hans' | 'zh-hant' | 'zh-hk' | 'zh-mo' | 'zh-sg' | 'zh-tw' | 'zu' | 'zu-za';
|
|
240
|
+
/**
|
|
241
|
+
* The name of the email, as displayed on the email dashboard.
|
|
242
|
+
*/
|
|
243
|
+
name?: string;
|
|
244
|
+
/**
|
|
245
|
+
* The date and time the email is scheduled for, in ISO8601 representation. This is only used in local time or scheduled emails.
|
|
246
|
+
*/
|
|
247
|
+
publishDate?: string;
|
|
248
|
+
rssData?: Schemas.PublicRssEmailDetails;
|
|
249
|
+
/**
|
|
250
|
+
* Determines whether the email will be sent immediately on publish.
|
|
251
|
+
*/
|
|
252
|
+
sendOnPublish?: boolean;
|
|
253
|
+
/**
|
|
254
|
+
* The email state.
|
|
255
|
+
*/
|
|
256
|
+
state?: 'AGENT_GENERATED' | 'AUTOMATED' | 'AUTOMATED_AB' | 'AUTOMATED_AB_VARIANT' | 'AUTOMATED_DRAFT' | 'AUTOMATED_DRAFT_AB' | 'AUTOMATED_DRAFT_ABVARIANT' | 'AUTOMATED_FOR_FORM' | 'AUTOMATED_FOR_FORM_BUFFER' | 'AUTOMATED_FOR_FORM_DRAFT' | 'AUTOMATED_FOR_FORM_LEGACY' | 'AUTOMATED_LOSER_ABVARIANT' | 'AUTOMATED_SENDING' | 'BLOG_EMAIL_DRAFT' | 'BLOG_EMAIL_PUBLISHED' | 'DRAFT' | 'DRAFT_AB' | 'DRAFT_AB_VARIANT' | 'ERROR' | 'LOSER_AB_VARIANT' | 'PAGE_STUB' | 'PRE_PROCESSING' | 'PROCESSING' | 'PUBLISHED' | 'PUBLISHED_AB' | 'PUBLISHED_AB_VARIANT' | 'PUBLISHED_OR_SCHEDULED' | 'RSS_TO_EMAIL_DRAFT' | 'RSS_TO_EMAIL_PUBLISHED' | 'SCHEDULED' | 'SCHEDULED_AB' | 'SCHEDULED_OR_PUBLISHED';
|
|
257
|
+
/**
|
|
258
|
+
* The email subcategory.
|
|
259
|
+
*/
|
|
260
|
+
subcategory?: 'ab_loser_variant' | 'ab_loser_variant_site_page' | 'ab_master' | 'ab_master_site_page' | 'ab_variant' | 'ab_variant_site_page' | 'automated' | 'automated_ab_master' | 'automated_ab_variant' | 'automated_for_crm' | 'automated_for_custom_survey' | 'automated_for_deal' | 'automated_for_feedback_ces' | 'automated_for_feedback_custom' | 'automated_for_feedback_nps' | 'automated_for_form' | 'automated_for_form_buffer' | 'automated_for_form_draft' | 'automated_for_form_legacy' | 'automated_for_leadflow' | 'automated_for_ticket' | 'batch' | 'blog_article_instance_layout' | 'blog_article_listing' | 'blog_author_detail' | 'blog_email' | 'blog_email_child' | 'case_study' | 'case_study_instance_layout' | 'case_study_listing' | 'discardable_stub' | 'imported_blog_post' | 'kb_404_page' | 'kb_article_instance_layout' | 'kb_listing' | 'kb_search_results' | 'kb_support_form' | 'landing_page' | 'legacy_blog_post' | 'legacy_page' | 'localtime' | 'manage_preferences_email' | 'marketing_single_send_api' | 'membership_email_verification' | 'membership_follow_up' | 'membership_otp_login' | 'membership_password_reset' | 'membership_password_saved' | 'membership_passwordless_auth' | 'membership_registration' | 'membership_registration_follow_up' | 'membership_verification' | 'normal_blog_post' | 'optin_email' | 'optin_followup_email' | 'page_instance_layout' | 'page_stub' | 'performable_landing_page' | 'performable_landing_page_cutover' | 'podcast_instance_layout' | 'podcast_listing' | 'portal_content' | 'resubscribe_confirmation_email' | 'resubscribe_email' | 'rss_to_email' | 'rss_to_email_child' | 'scp_instance_layout_page' | 'scp_static_page' | 'single_send_api' | 'site_page' | 'smtp_token' | 'staged_page' | 'ticket_closed_kickback_email' | 'ticket_opened_kickback_email' | 'ticket_pipeline_automated' | 'UNKNOWN' | 'unsubscribe_confirmation_email' | 'web_interactive';
|
|
261
|
+
/**
|
|
262
|
+
* The subject of the email.
|
|
263
|
+
*/
|
|
264
|
+
subject?: string;
|
|
265
|
+
subscriptionDetails?: Schemas.PublicEmailSubscriptionDetails;
|
|
266
|
+
testing?: Schemas.PublicEmailTestingDetails;
|
|
267
|
+
to?: Schemas.PublicEmailToDetails;
|
|
268
|
+
webversion?: Schemas.PublicWebversionDetails;
|
|
269
|
+
}
|
|
270
|
+
interface EmailStatisticInterval {
|
|
271
|
+
aggregations: Schemas.EmailStatisticsData;
|
|
272
|
+
interval: Schemas.Interval;
|
|
273
|
+
}
|
|
274
|
+
interface EmailStatisticsData {
|
|
275
|
+
/**
|
|
276
|
+
* Counters like number of `sent`, `open` or `delivered`.
|
|
277
|
+
*/
|
|
278
|
+
counters: Record<string, number>;
|
|
279
|
+
/**
|
|
280
|
+
* Statistics by device.
|
|
281
|
+
*/
|
|
282
|
+
deviceBreakdown: Record<string, Record<string, number>>;
|
|
283
|
+
/**
|
|
284
|
+
* Number of emails that were dropped and bounced.
|
|
285
|
+
*/
|
|
286
|
+
qualifierStats: Record<string, Record<string, number>>;
|
|
287
|
+
/**
|
|
288
|
+
* Ratios like `openratio` or `clickratio`
|
|
289
|
+
*/
|
|
290
|
+
ratios: Record<string, number>;
|
|
291
|
+
}
|
|
292
|
+
interface EmailUpdateRequest {
|
|
293
|
+
/**
|
|
294
|
+
* The active domain of the email.
|
|
295
|
+
*/
|
|
296
|
+
activeDomain?: string;
|
|
297
|
+
/**
|
|
298
|
+
* Determines if the email is archived or not.
|
|
299
|
+
*/
|
|
300
|
+
archived?: boolean;
|
|
301
|
+
/**
|
|
302
|
+
* The ID of the business unit associated with the email.
|
|
303
|
+
*/
|
|
304
|
+
businessUnitId?: number;
|
|
305
|
+
/**
|
|
306
|
+
* The ID of the campaign this email is associated to.
|
|
307
|
+
*/
|
|
308
|
+
campaign?: string;
|
|
309
|
+
content?: Schemas.PublicEmailContent;
|
|
310
|
+
/**
|
|
311
|
+
* The ID of the folder where the email will be stored.
|
|
312
|
+
*/
|
|
313
|
+
folderIdV2?: number;
|
|
314
|
+
from?: Schemas.PublicEmailFromDetails;
|
|
315
|
+
/**
|
|
316
|
+
* Determines whether the email send time should be randomized to avoid sending all emails at the exact same time.
|
|
317
|
+
*/
|
|
318
|
+
jitterSendTime?: boolean;
|
|
319
|
+
/**
|
|
320
|
+
* The language code for the email, such as 'en' for English.
|
|
321
|
+
*/
|
|
322
|
+
language?: 'aa' | 'ab' | 'ae' | 'af' | 'af-na' | 'af-za' | 'agq' | 'agq-cm' | 'ak' | 'ak-gh' | 'am' | 'am-et' | 'an' | 'ann' | 'ann-ng' | 'ar' | 'ar-001' | 'ar-ae' | 'ar-bh' | 'ar-dj' | 'ar-dz' | 'ar-eg' | 'ar-eh' | 'ar-er' | 'ar-il' | 'ar-iq' | 'ar-jo' | 'ar-km' | 'ar-kw' | 'ar-lb' | 'ar-ly' | 'ar-ma' | 'ar-mr' | 'ar-om' | 'ar-ps' | 'ar-qa' | 'ar-sa' | 'ar-sd' | 'ar-so' | 'ar-ss' | 'ar-sy' | 'ar-td' | 'ar-tn' | 'ar-ye' | 'as' | 'as-in' | 'asa' | 'asa-tz' | 'ast' | 'ast-es' | 'av' | 'ay' | 'az' | 'az-az' | 'ba' | 'bas' | 'bas-cm' | 'be' | 'be-by' | 'bem' | 'bem-zm' | 'bez' | 'bez-tz' | 'bg' | 'bg-bg' | 'bgc' | 'bgc-in' | 'bho' | 'bho-in' | 'bi' | 'bm' | 'bm-ml' | 'bn' | 'bn-bd' | 'bn-in' | 'bo' | 'bo-cn' | 'bo-in' | 'br' | 'br-fr' | 'brx' | 'brx-in' | 'bs' | 'bs-ba' | 'ca' | 'ca-ad' | 'ca-es' | 'ca-fr' | 'ca-it' | 'ccp' | 'ccp-bd' | 'ccp-in' | 'ce' | 'ce-ru' | 'ceb' | 'ceb-ph' | 'cgg' | 'cgg-ug' | 'ch' | 'chr' | 'chr-us' | 'ckb' | 'ckb-iq' | 'ckb-ir' | 'co' | 'cr' | 'cs' | 'cs-cz' | 'cu' | 'cu-ru' | 'cv' | 'cv-ru' | 'cy' | 'cy-gb' | 'da' | 'da-dk' | 'da-gl' | 'dav' | 'dav-ke' | 'de' | 'de-at' | 'de-be' | 'de-ch' | 'de-de' | 'de-gr' | 'de-it' | 'de-li' | 'de-lu' | 'dje' | 'dje-ne' | 'doi' | 'doi-in' | 'dsb' | 'dsb-de' | 'dua' | 'dua-cm' | 'dv' | 'dyo' | 'dyo-sn' | 'dz' | 'dz-bt' | 'ebu' | 'ebu-ke' | 'ee' | 'ee-gh' | 'ee-tg' | 'el' | 'el-cy' | 'el-gr' | 'en' | 'en-001' | 'en-150' | 'en-ae' | 'en-ag' | 'en-ai' | 'en-as' | 'en-at' | 'en-au' | 'en-bb' | 'en-be' | 'en-bi' | 'en-bm' | 'en-bs' | 'en-bw' | 'en-bz' | 'en-ca' | 'en-cc' | 'en-ch' | 'en-ck' | 'en-cm' | 'en-cn' | 'en-cx' | 'en-cy' | 'en-de' | 'en-dg' | 'en-dk' | 'en-dm' | 'en-ee' | 'en-eg' | 'en-er' | 'en-es' | 'en-fi' | 'en-fj' | 'en-fk' | 'en-fm' | 'en-fr' | 'en-gb' | 'en-gd' | 'en-gg' | 'en-gh' | 'en-gi' | 'en-gm' | 'en-gu' | 'en-gy' | 'en-hk' | 'en-id' | 'en-ie' | 'en-il' | 'en-im' | 'en-in' | 'en-io' | 'en-je' | 'en-jm' | 'en-ke' | 'en-ki' | 'en-kn' | 'en-ky' | 'en-lc' | 'en-lr' | 'en-ls' | 'en-lu' | 'en-mg' | 'en-mh' | 'en-mo' | 'en-mp' | 'en-ms' | 'en-mt' | 'en-mu' | 'en-mv' | 'en-mw' | 'en-mx' | 'en-my' | 'en-na' | 'en-nf' | 'en-ng' | 'en-nl' | 'en-nr' | 'en-nu' | 'en-nz' | 'en-pg' | 'en-ph' | 'en-pk' | 'en-pn' | 'en-pr' | 'en-pt' | 'en-pw' | 'en-rw' | 'en-sb' | 'en-sc' | 'en-sd' | 'en-se' | 'en-sg' | 'en-sh' | 'en-si' | 'en-sl' | 'en-ss' | 'en-sx' | 'en-sz' | 'en-tc' | 'en-th' | 'en-tk' | 'en-tn' | 'en-to' | 'en-tt' | 'en-tv' | 'en-tz' | 'en-ug' | 'en-um' | 'en-us' | 'en-vc' | 'en-vg' | 'en-vi' | 'en-vn' | 'en-vu' | 'en-ws' | 'en-za' | 'en-zm' | 'en-zw' | 'eo' | 'eo-001' | 'es' | 'es-419' | 'es-ar' | 'es-bo' | 'es-br' | 'es-bz' | 'es-cl' | 'es-co' | 'es-cr' | 'es-cu' | 'es-do' | 'es-ea' | 'es-ec' | 'es-es' | 'es-gq' | 'es-gt' | 'es-hn' | 'es-ic' | 'es-mx' | 'es-ni' | 'es-pa' | 'es-pe' | 'es-ph' | 'es-pr' | 'es-py' | 'es-sv' | 'es-us' | 'es-uy' | 'es-ve' | 'et' | 'et-ee' | 'eu' | 'eu-es' | 'ewo' | 'ewo-cm' | 'fa' | 'fa-af' | 'fa-ir' | 'ff' | 'ff-bf' | 'ff-cm' | 'ff-gh' | 'ff-gm' | 'ff-gn' | 'ff-gw' | 'ff-lr' | 'ff-mr' | 'ff-ne' | 'ff-ng' | 'ff-sl' | 'ff-sn' | 'fi' | 'fi-fi' | 'fil' | 'fil-ph' | 'fj' | 'fo' | 'fo-dk' | 'fo-fo' | 'fr' | 'fr-be' | 'fr-bf' | 'fr-bi' | 'fr-bj' | 'fr-bl' | 'fr-ca' | 'fr-cd' | 'fr-cf' | 'fr-cg' | 'fr-ch' | 'fr-ci' | 'fr-cm' | 'fr-dj' | 'fr-dz' | 'fr-fr' | 'fr-ga' | 'fr-gf' | 'fr-gn' | 'fr-gp' | 'fr-gq' | 'fr-ht' | 'fr-km' | 'fr-lu' | 'fr-ma' | 'fr-mc' | 'fr-mf' | 'fr-mg' | 'fr-ml' | 'fr-mq' | 'fr-mr' | 'fr-mu' | 'fr-nc' | 'fr-ne' | 'fr-pf' | 'fr-pm' | 'fr-re' | 'fr-rw' | 'fr-sc' | 'fr-sn' | 'fr-sy' | 'fr-td' | 'fr-tg' | 'fr-tn' | 'fr-vu' | 'fr-wf' | 'fr-yt' | 'frr' | 'frr-de' | 'fur' | 'fur-it' | 'fy' | 'fy-nl' | 'ga' | 'ga-gb' | 'ga-ie' | 'gd' | 'gd-gb' | 'gl' | 'gl-es' | 'gn' | 'gsw' | 'gsw-ch' | 'gsw-fr' | 'gsw-li' | 'gu' | 'gu-in' | 'guz' | 'guz-ke' | 'gv' | 'gv-im' | 'ha' | 'ha-gh' | 'ha-ne' | 'ha-ng' | 'haw' | 'haw-us' | 'he' | 'he-il' | 'hi' | 'hi-in' | 'hmn' | 'ho' | 'hr' | 'hr-ba' | 'hr-hr' | 'hsb' | 'hsb-de' | 'ht' | 'hu' | 'hu-hu' | 'hy' | 'hy-am' | 'hz' | 'ia' | 'ia-001' | 'id' | 'id-id' | 'ie' | 'ig' | 'ig-ng' | 'ii' | 'ii-cn' | 'ik' | 'io' | 'is' | 'is-is' | 'it' | 'it-ch' | 'it-it' | 'it-sm' | 'it-va' | 'iu' | 'ja' | 'ja-jp' | 'jgo' | 'jgo-cm' | 'jmc' | 'jmc-tz' | 'jv' | 'jv-id' | 'ka' | 'ka-ge' | 'kab' | 'kab-dz' | 'kam' | 'kam-ke' | 'kar' | 'kde' | 'kde-tz' | 'kea' | 'kea-cv' | 'kg' | 'kgp' | 'kgp-br' | 'kh' | 'khq' | 'khq-ml' | 'ki' | 'ki-ke' | 'kj' | 'kk' | 'kk-kz' | 'kkj' | 'kkj-cm' | 'kl' | 'kl-gl' | 'kln' | 'kln-ke' | 'km' | 'km-kh' | 'kn' | 'kn-in' | 'ko' | 'ko-kp' | 'ko-kr' | 'kok' | 'kok-in' | 'kr' | 'ks' | 'ks-in' | 'ksb' | 'ksb-tz' | 'ksf' | 'ksf-cm' | 'ksh' | 'ksh-de' | 'ku' | 'ku-tr' | 'kv' | 'kw' | 'kw-gb' | 'ky' | 'ky-kg' | 'la' | 'lag' | 'lag-tz' | 'lb' | 'lb-lu' | 'lg' | 'lg-ug' | 'li' | 'lkt' | 'lkt-us' | 'ln' | 'ln-ao' | 'ln-cd' | 'ln-cf' | 'ln-cg' | 'lo' | 'lo-la' | 'lrc' | 'lrc-iq' | 'lrc-ir' | 'lt' | 'lt-lt' | 'lu' | 'lu-cd' | 'luo' | 'luo-ke' | 'luy' | 'luy-ke' | 'lv' | 'lv-lv' | 'mai' | 'mai-in' | 'mas' | 'mas-ke' | 'mas-tz' | 'mdf' | 'mdf-ru' | 'mer' | 'mer-ke' | 'mfe' | 'mfe-mu' | 'mg' | 'mg-mg' | 'mgh' | 'mgh-mz' | 'mgo' | 'mgo-cm' | 'mh' | 'mi' | 'mi-nz' | 'mk' | 'mk-mk' | 'ml' | 'ml-in' | 'mn' | 'mn-mn' | 'mni' | 'mni-in' | 'mr' | 'mr-in' | 'ms' | 'ms-bn' | 'ms-id' | 'ms-my' | 'ms-sg' | 'mt' | 'mt-mt' | 'mua' | 'mua-cm' | 'my' | 'my-mm' | 'mzn' | 'mzn-ir' | 'na' | 'naq' | 'naq-na' | 'nb' | 'nb-no' | 'nb-sj' | 'nd' | 'nd-zw' | 'nds' | 'nds-de' | 'nds-nl' | 'ne' | 'ne-in' | 'ne-np' | 'ng' | 'nl' | 'nl-aw' | 'nl-be' | 'nl-bq' | 'nl-ch' | 'nl-cw' | 'nl-lu' | 'nl-nl' | 'nl-sr' | 'nl-sx' | 'nmg' | 'nmg-cm' | 'nn' | 'nn-no' | 'nnh' | 'nnh-cm' | 'no' | 'no-no' | 'nr' | 'nus' | 'nus-ss' | 'nv' | 'ny' | 'nyn' | 'nyn-ug' | 'oc' | 'oc-es' | 'oc-fr' | 'oj' | 'om' | 'om-et' | 'om-ke' | 'or' | 'or-in' | 'os' | 'os-ge' | 'os-ru' | 'pa' | 'pa-in' | 'pa-pk' | 'pcm' | 'pcm-ng' | 'pi' | 'pis' | 'pis-sb' | 'pl' | 'pl-pl' | 'prg' | 'prg-001' | 'ps' | 'ps-af' | 'ps-pk' | 'pt' | 'pt-ao' | 'pt-br' | 'pt-ch' | 'pt-cv' | 'pt-gq' | 'pt-gw' | 'pt-lu' | 'pt-mo' | 'pt-mz' | 'pt-pt' | 'pt-st' | 'pt-tl' | 'qu' | 'qu-bo' | 'qu-ec' | 'qu-pe' | 'raj' | 'raj-in' | 'rm' | 'rm-ch' | 'rn' | 'rn-bi' | 'ro' | 'ro-md' | 'ro-ro' | 'rof' | 'rof-tz' | 'ru' | 'ru-by' | 'ru-kg' | 'ru-kz' | 'ru-md' | 'ru-ru' | 'ru-ua' | 'rw' | 'rw-rw' | 'rwk' | 'rwk-tz' | 'sa' | 'sa-in' | 'sah' | 'sah-ru' | 'saq' | 'saq-ke' | 'sat' | 'sat-in' | 'sbp' | 'sbp-tz' | 'sc' | 'sc-it' | 'sd' | 'sd-in' | 'sd-pk' | 'se' | 'se-fi' | 'se-no' | 'se-se' | 'seh' | 'seh-mz' | 'ses' | 'ses-ml' | 'sg' | 'sg-cf' | 'shi' | 'shi-ma' | 'si' | 'si-lk' | 'sk' | 'sk-sk' | 'sl' | 'sl-si' | 'sm' | 'smn' | 'smn-fi' | 'sms' | 'sms-fi' | 'sn' | 'sn-zw' | 'so' | 'so-dj' | 'so-et' | 'so-ke' | 'so-so' | 'sq' | 'sq-al' | 'sq-mk' | 'sq-xk' | 'sr' | 'sr-ba' | 'sr-cs' | 'sr-me' | 'sr-rs' | 'sr-xk' | 'ss' | 'st' | 'su' | 'su-id' | 'sv' | 'sv-ax' | 'sv-fi' | 'sv-se' | 'sw' | 'sw-cd' | 'sw-ke' | 'sw-tz' | 'sw-ug' | 'sy' | 'ta' | 'ta-in' | 'ta-lk' | 'ta-my' | 'ta-sg' | 'te' | 'te-in' | 'teo' | 'teo-ke' | 'teo-ug' | 'tg' | 'tg-tj' | 'th' | 'th-th' | 'ti' | 'ti-er' | 'ti-et' | 'tk' | 'tk-tm' | 'tl' | 'tn' | 'to' | 'to-to' | 'tok' | 'tok-001' | 'tr' | 'tr-cy' | 'tr-tr' | 'ts' | 'tt' | 'tt-ru' | 'tw' | 'twq' | 'twq-ne' | 'ty' | 'tzm' | 'tzm-ma' | 'ug' | 'ug-cn' | 'uk' | 'uk-ua' | 'ur' | 'ur-in' | 'ur-pk' | 'uz' | 'uz-af' | 'uz-uz' | 'vai' | 'vai-lr' | 've' | 'vi' | 'vi-vn' | 'vo' | 'vo-001' | 'vun' | 'vun-tz' | 'wa' | 'wae' | 'wae-ch' | 'wo' | 'wo-sn' | 'xh' | 'xh-za' | 'xog' | 'xog-ug' | 'yav' | 'yav-cm' | 'yi' | 'yi-001' | 'yo' | 'yo-bj' | 'yo-ng' | 'yrl' | 'yrl-br' | 'yrl-co' | 'yrl-ve' | 'yue' | 'yue-cn' | 'yue-hk' | 'za' | 'zgh' | 'zgh-ma' | 'zh' | 'zh-cn' | 'zh-hans' | 'zh-hant' | 'zh-hk' | 'zh-mo' | 'zh-sg' | 'zh-tw' | 'zu' | 'zu-za';
|
|
323
|
+
/**
|
|
324
|
+
* The name of the email, as displayed on the email dashboard.
|
|
325
|
+
*/
|
|
326
|
+
name?: string;
|
|
327
|
+
/**
|
|
328
|
+
* The date and time the email is scheduled for, in ISO8601 representation. This is only used in local time or scheduled emails.
|
|
329
|
+
*/
|
|
330
|
+
publishDate?: string;
|
|
331
|
+
rssData?: Schemas.PublicRssEmailDetails;
|
|
332
|
+
/**
|
|
333
|
+
* Determines whether the email will be sent immediately on publish.
|
|
334
|
+
*/
|
|
335
|
+
sendOnPublish?: boolean;
|
|
336
|
+
/**
|
|
337
|
+
* The email state.
|
|
338
|
+
*/
|
|
339
|
+
state?: 'AGENT_GENERATED' | 'AUTOMATED' | 'AUTOMATED_AB' | 'AUTOMATED_AB_VARIANT' | 'AUTOMATED_DRAFT' | 'AUTOMATED_DRAFT_AB' | 'AUTOMATED_DRAFT_ABVARIANT' | 'AUTOMATED_FOR_FORM' | 'AUTOMATED_FOR_FORM_BUFFER' | 'AUTOMATED_FOR_FORM_DRAFT' | 'AUTOMATED_FOR_FORM_LEGACY' | 'AUTOMATED_LOSER_ABVARIANT' | 'AUTOMATED_SENDING' | 'BLOG_EMAIL_DRAFT' | 'BLOG_EMAIL_PUBLISHED' | 'DRAFT' | 'DRAFT_AB' | 'DRAFT_AB_VARIANT' | 'ERROR' | 'LOSER_AB_VARIANT' | 'PAGE_STUB' | 'PRE_PROCESSING' | 'PROCESSING' | 'PUBLISHED' | 'PUBLISHED_AB' | 'PUBLISHED_AB_VARIANT' | 'PUBLISHED_OR_SCHEDULED' | 'RSS_TO_EMAIL_DRAFT' | 'RSS_TO_EMAIL_PUBLISHED' | 'SCHEDULED' | 'SCHEDULED_AB' | 'SCHEDULED_OR_PUBLISHED';
|
|
340
|
+
/**
|
|
341
|
+
* The email subcategory.
|
|
342
|
+
*/
|
|
343
|
+
subcategory?: 'ab_loser_variant' | 'ab_loser_variant_site_page' | 'ab_master' | 'ab_master_site_page' | 'ab_variant' | 'ab_variant_site_page' | 'automated' | 'automated_ab_master' | 'automated_ab_variant' | 'automated_for_crm' | 'automated_for_custom_survey' | 'automated_for_deal' | 'automated_for_feedback_ces' | 'automated_for_feedback_custom' | 'automated_for_feedback_nps' | 'automated_for_form' | 'automated_for_form_buffer' | 'automated_for_form_draft' | 'automated_for_form_legacy' | 'automated_for_leadflow' | 'automated_for_ticket' | 'batch' | 'blog_article_instance_layout' | 'blog_article_listing' | 'blog_author_detail' | 'blog_email' | 'blog_email_child' | 'case_study' | 'case_study_instance_layout' | 'case_study_listing' | 'discardable_stub' | 'imported_blog_post' | 'kb_404_page' | 'kb_article_instance_layout' | 'kb_listing' | 'kb_search_results' | 'kb_support_form' | 'landing_page' | 'legacy_blog_post' | 'legacy_page' | 'localtime' | 'manage_preferences_email' | 'marketing_single_send_api' | 'membership_email_verification' | 'membership_follow_up' | 'membership_otp_login' | 'membership_password_reset' | 'membership_password_saved' | 'membership_passwordless_auth' | 'membership_registration' | 'membership_registration_follow_up' | 'membership_verification' | 'normal_blog_post' | 'optin_email' | 'optin_followup_email' | 'page_instance_layout' | 'page_stub' | 'performable_landing_page' | 'performable_landing_page_cutover' | 'podcast_instance_layout' | 'podcast_listing' | 'portal_content' | 'resubscribe_confirmation_email' | 'resubscribe_email' | 'rss_to_email' | 'rss_to_email_child' | 'scp_instance_layout_page' | 'scp_static_page' | 'single_send_api' | 'site_page' | 'smtp_token' | 'staged_page' | 'ticket_closed_kickback_email' | 'ticket_opened_kickback_email' | 'ticket_pipeline_automated' | 'UNKNOWN' | 'unsubscribe_confirmation_email' | 'web_interactive';
|
|
344
|
+
/**
|
|
345
|
+
* The subject of the email.
|
|
346
|
+
*/
|
|
347
|
+
subject?: string;
|
|
348
|
+
subscriptionDetails?: Schemas.PublicEmailSubscriptionDetails;
|
|
349
|
+
testing?: Schemas.PublicEmailTestingDetails;
|
|
350
|
+
to?: Schemas.PublicEmailToDetails;
|
|
351
|
+
webversion?: Schemas.PublicWebversionDetails;
|
|
352
|
+
}
|
|
353
|
+
interface Interval {
|
|
354
|
+
/**
|
|
355
|
+
* The end timestamp of the interval, in ISO8601 format.
|
|
356
|
+
*/
|
|
357
|
+
end: string;
|
|
358
|
+
/**
|
|
359
|
+
* The start timestamp of the interval, in ISO8601 format.
|
|
360
|
+
*/
|
|
361
|
+
start: string;
|
|
362
|
+
}
|
|
363
|
+
/**
|
|
364
|
+
* Specifies the paging information needed to retrieve the next set of results in a paginated API response
|
|
365
|
+
*/
|
|
366
|
+
interface NextPage {
|
|
367
|
+
/**
|
|
368
|
+
* The cursor token value to get the next set of results. Use this value as query parameter (&after=...) to obtain the next page.
|
|
369
|
+
*/
|
|
370
|
+
after: string;
|
|
371
|
+
/**
|
|
372
|
+
* The link to the next page.
|
|
373
|
+
*/
|
|
374
|
+
link?: string;
|
|
375
|
+
}
|
|
376
|
+
interface Paging {
|
|
377
|
+
next?: Schemas.NextPage;
|
|
378
|
+
prev?: Schemas.PreviousPage;
|
|
379
|
+
}
|
|
380
|
+
/**
|
|
381
|
+
* specifies the paging information needed to retrieve the previous set of results in a paginated API response
|
|
382
|
+
*/
|
|
383
|
+
interface PreviousPage {
|
|
384
|
+
/**
|
|
385
|
+
* The cursor token value to get the previous set of results. Use this value as query parameter (&before=...) to obtain the previous page.
|
|
386
|
+
*/
|
|
387
|
+
before: string;
|
|
388
|
+
/**
|
|
389
|
+
* The link to the previous page.
|
|
390
|
+
*/
|
|
391
|
+
link?: string;
|
|
392
|
+
}
|
|
393
|
+
interface PublicButtonStyleSettings {
|
|
394
|
+
backgroundColor?: Record<string, never>;
|
|
395
|
+
cornerRadius?: number;
|
|
396
|
+
fontStyle?: Schemas.PublicFontStyle;
|
|
397
|
+
}
|
|
398
|
+
interface PublicDividerStyleSettings {
|
|
399
|
+
color?: Record<string, never>;
|
|
400
|
+
height?: number;
|
|
401
|
+
lineType?: string;
|
|
402
|
+
}
|
|
403
|
+
interface PublicEmail {
|
|
404
|
+
/**
|
|
405
|
+
* The active domain of the email.
|
|
406
|
+
*/
|
|
407
|
+
activeDomain?: string;
|
|
408
|
+
/**
|
|
409
|
+
* List of emailCampaignIds.
|
|
410
|
+
*/
|
|
411
|
+
allEmailCampaignIds?: string[];
|
|
412
|
+
/**
|
|
413
|
+
* Determines if the email is archived or not.
|
|
414
|
+
*/
|
|
415
|
+
archived?: boolean;
|
|
416
|
+
businessUnitId?: string;
|
|
417
|
+
/**
|
|
418
|
+
* The ID of the campaign this email is associated to.
|
|
419
|
+
*/
|
|
420
|
+
campaign?: string;
|
|
421
|
+
/**
|
|
422
|
+
* The name of the campaign.
|
|
423
|
+
*/
|
|
424
|
+
campaignName?: string;
|
|
425
|
+
campaignUtm?: string;
|
|
426
|
+
/**
|
|
427
|
+
* The ID of the email this email was cloned from.
|
|
428
|
+
*/
|
|
429
|
+
clonedFrom?: string;
|
|
430
|
+
content?: Schemas.PublicEmailContent;
|
|
431
|
+
/**
|
|
432
|
+
* The date and time of the email's creation, in ISO8601 representation.
|
|
433
|
+
*/
|
|
434
|
+
createdAt?: string;
|
|
435
|
+
/**
|
|
436
|
+
* The id of the user who created the email.
|
|
437
|
+
*/
|
|
438
|
+
createdById?: string;
|
|
439
|
+
/**
|
|
440
|
+
* The date and time the email was deleted at, in ISO8601 representation.
|
|
441
|
+
*/
|
|
442
|
+
deletedAt?: string;
|
|
443
|
+
emailCampaignGroupId?: string;
|
|
444
|
+
emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP';
|
|
445
|
+
/**
|
|
446
|
+
* The ID of the feedback survey linked to the email.
|
|
447
|
+
*/
|
|
448
|
+
feedbackSurveyId?: string;
|
|
449
|
+
folderId?: number;
|
|
450
|
+
folderIdV2?: number;
|
|
451
|
+
from?: Schemas.PublicEmailFromDetails;
|
|
452
|
+
/**
|
|
453
|
+
* The email ID.
|
|
454
|
+
*/
|
|
455
|
+
id?: string;
|
|
456
|
+
isAb: boolean;
|
|
457
|
+
/**
|
|
458
|
+
* Returns the published status of the email. This is read only.
|
|
459
|
+
*/
|
|
460
|
+
isPublished?: boolean;
|
|
461
|
+
/**
|
|
462
|
+
* Returns whether the email is a transactional email or not. This is read only.
|
|
463
|
+
*/
|
|
464
|
+
isTransactional?: boolean;
|
|
465
|
+
jitterSendTime?: boolean;
|
|
466
|
+
language?: 'aa' | 'ab' | 'ae' | 'af' | 'af-na' | 'af-za' | 'agq' | 'agq-cm' | 'ak' | 'ak-gh' | 'am' | 'am-et' | 'an' | 'ann' | 'ann-ng' | 'ar' | 'ar-001' | 'ar-ae' | 'ar-bh' | 'ar-dj' | 'ar-dz' | 'ar-eg' | 'ar-eh' | 'ar-er' | 'ar-il' | 'ar-iq' | 'ar-jo' | 'ar-km' | 'ar-kw' | 'ar-lb' | 'ar-ly' | 'ar-ma' | 'ar-mr' | 'ar-om' | 'ar-ps' | 'ar-qa' | 'ar-sa' | 'ar-sd' | 'ar-so' | 'ar-ss' | 'ar-sy' | 'ar-td' | 'ar-tn' | 'ar-ye' | 'as' | 'as-in' | 'asa' | 'asa-tz' | 'ast' | 'ast-es' | 'av' | 'ay' | 'az' | 'az-az' | 'ba' | 'bas' | 'bas-cm' | 'be' | 'be-by' | 'bem' | 'bem-zm' | 'bez' | 'bez-tz' | 'bg' | 'bg-bg' | 'bgc' | 'bgc-in' | 'bho' | 'bho-in' | 'bi' | 'bm' | 'bm-ml' | 'bn' | 'bn-bd' | 'bn-in' | 'bo' | 'bo-cn' | 'bo-in' | 'br' | 'br-fr' | 'brx' | 'brx-in' | 'bs' | 'bs-ba' | 'ca' | 'ca-ad' | 'ca-es' | 'ca-fr' | 'ca-it' | 'ccp' | 'ccp-bd' | 'ccp-in' | 'ce' | 'ce-ru' | 'ceb' | 'ceb-ph' | 'cgg' | 'cgg-ug' | 'ch' | 'chr' | 'chr-us' | 'ckb' | 'ckb-iq' | 'ckb-ir' | 'co' | 'cr' | 'cs' | 'cs-cz' | 'cu' | 'cu-ru' | 'cv' | 'cv-ru' | 'cy' | 'cy-gb' | 'da' | 'da-dk' | 'da-gl' | 'dav' | 'dav-ke' | 'de' | 'de-at' | 'de-be' | 'de-ch' | 'de-de' | 'de-gr' | 'de-it' | 'de-li' | 'de-lu' | 'dje' | 'dje-ne' | 'doi' | 'doi-in' | 'dsb' | 'dsb-de' | 'dua' | 'dua-cm' | 'dv' | 'dyo' | 'dyo-sn' | 'dz' | 'dz-bt' | 'ebu' | 'ebu-ke' | 'ee' | 'ee-gh' | 'ee-tg' | 'el' | 'el-cy' | 'el-gr' | 'en' | 'en-001' | 'en-150' | 'en-ae' | 'en-ag' | 'en-ai' | 'en-as' | 'en-at' | 'en-au' | 'en-bb' | 'en-be' | 'en-bi' | 'en-bm' | 'en-bs' | 'en-bw' | 'en-bz' | 'en-ca' | 'en-cc' | 'en-ch' | 'en-ck' | 'en-cm' | 'en-cn' | 'en-cx' | 'en-cy' | 'en-de' | 'en-dg' | 'en-dk' | 'en-dm' | 'en-ee' | 'en-eg' | 'en-er' | 'en-es' | 'en-fi' | 'en-fj' | 'en-fk' | 'en-fm' | 'en-fr' | 'en-gb' | 'en-gd' | 'en-gg' | 'en-gh' | 'en-gi' | 'en-gm' | 'en-gu' | 'en-gy' | 'en-hk' | 'en-id' | 'en-ie' | 'en-il' | 'en-im' | 'en-in' | 'en-io' | 'en-je' | 'en-jm' | 'en-ke' | 'en-ki' | 'en-kn' | 'en-ky' | 'en-lc' | 'en-lr' | 'en-ls' | 'en-lu' | 'en-mg' | 'en-mh' | 'en-mo' | 'en-mp' | 'en-ms' | 'en-mt' | 'en-mu' | 'en-mv' | 'en-mw' | 'en-mx' | 'en-my' | 'en-na' | 'en-nf' | 'en-ng' | 'en-nl' | 'en-nr' | 'en-nu' | 'en-nz' | 'en-pg' | 'en-ph' | 'en-pk' | 'en-pn' | 'en-pr' | 'en-pt' | 'en-pw' | 'en-rw' | 'en-sb' | 'en-sc' | 'en-sd' | 'en-se' | 'en-sg' | 'en-sh' | 'en-si' | 'en-sl' | 'en-ss' | 'en-sx' | 'en-sz' | 'en-tc' | 'en-th' | 'en-tk' | 'en-tn' | 'en-to' | 'en-tt' | 'en-tv' | 'en-tz' | 'en-ug' | 'en-um' | 'en-us' | 'en-vc' | 'en-vg' | 'en-vi' | 'en-vn' | 'en-vu' | 'en-ws' | 'en-za' | 'en-zm' | 'en-zw' | 'eo' | 'eo-001' | 'es' | 'es-419' | 'es-ar' | 'es-bo' | 'es-br' | 'es-bz' | 'es-cl' | 'es-co' | 'es-cr' | 'es-cu' | 'es-do' | 'es-ea' | 'es-ec' | 'es-es' | 'es-gq' | 'es-gt' | 'es-hn' | 'es-ic' | 'es-mx' | 'es-ni' | 'es-pa' | 'es-pe' | 'es-ph' | 'es-pr' | 'es-py' | 'es-sv' | 'es-us' | 'es-uy' | 'es-ve' | 'et' | 'et-ee' | 'eu' | 'eu-es' | 'ewo' | 'ewo-cm' | 'fa' | 'fa-af' | 'fa-ir' | 'ff' | 'ff-bf' | 'ff-cm' | 'ff-gh' | 'ff-gm' | 'ff-gn' | 'ff-gw' | 'ff-lr' | 'ff-mr' | 'ff-ne' | 'ff-ng' | 'ff-sl' | 'ff-sn' | 'fi' | 'fi-fi' | 'fil' | 'fil-ph' | 'fj' | 'fo' | 'fo-dk' | 'fo-fo' | 'fr' | 'fr-be' | 'fr-bf' | 'fr-bi' | 'fr-bj' | 'fr-bl' | 'fr-ca' | 'fr-cd' | 'fr-cf' | 'fr-cg' | 'fr-ch' | 'fr-ci' | 'fr-cm' | 'fr-dj' | 'fr-dz' | 'fr-fr' | 'fr-ga' | 'fr-gf' | 'fr-gn' | 'fr-gp' | 'fr-gq' | 'fr-ht' | 'fr-km' | 'fr-lu' | 'fr-ma' | 'fr-mc' | 'fr-mf' | 'fr-mg' | 'fr-ml' | 'fr-mq' | 'fr-mr' | 'fr-mu' | 'fr-nc' | 'fr-ne' | 'fr-pf' | 'fr-pm' | 'fr-re' | 'fr-rw' | 'fr-sc' | 'fr-sn' | 'fr-sy' | 'fr-td' | 'fr-tg' | 'fr-tn' | 'fr-vu' | 'fr-wf' | 'fr-yt' | 'frr' | 'frr-de' | 'fur' | 'fur-it' | 'fy' | 'fy-nl' | 'ga' | 'ga-gb' | 'ga-ie' | 'gd' | 'gd-gb' | 'gl' | 'gl-es' | 'gn' | 'gsw' | 'gsw-ch' | 'gsw-fr' | 'gsw-li' | 'gu' | 'gu-in' | 'guz' | 'guz-ke' | 'gv' | 'gv-im' | 'ha' | 'ha-gh' | 'ha-ne' | 'ha-ng' | 'haw' | 'haw-us' | 'he' | 'he-il' | 'hi' | 'hi-in' | 'hmn' | 'ho' | 'hr' | 'hr-ba' | 'hr-hr' | 'hsb' | 'hsb-de' | 'ht' | 'hu' | 'hu-hu' | 'hy' | 'hy-am' | 'hz' | 'ia' | 'ia-001' | 'id' | 'id-id' | 'ie' | 'ig' | 'ig-ng' | 'ii' | 'ii-cn' | 'ik' | 'io' | 'is' | 'is-is' | 'it' | 'it-ch' | 'it-it' | 'it-sm' | 'it-va' | 'iu' | 'ja' | 'ja-jp' | 'jgo' | 'jgo-cm' | 'jmc' | 'jmc-tz' | 'jv' | 'jv-id' | 'ka' | 'ka-ge' | 'kab' | 'kab-dz' | 'kam' | 'kam-ke' | 'kar' | 'kde' | 'kde-tz' | 'kea' | 'kea-cv' | 'kg' | 'kgp' | 'kgp-br' | 'kh' | 'khq' | 'khq-ml' | 'ki' | 'ki-ke' | 'kj' | 'kk' | 'kk-kz' | 'kkj' | 'kkj-cm' | 'kl' | 'kl-gl' | 'kln' | 'kln-ke' | 'km' | 'km-kh' | 'kn' | 'kn-in' | 'ko' | 'ko-kp' | 'ko-kr' | 'kok' | 'kok-in' | 'kr' | 'ks' | 'ks-in' | 'ksb' | 'ksb-tz' | 'ksf' | 'ksf-cm' | 'ksh' | 'ksh-de' | 'ku' | 'ku-tr' | 'kv' | 'kw' | 'kw-gb' | 'ky' | 'ky-kg' | 'la' | 'lag' | 'lag-tz' | 'lb' | 'lb-lu' | 'lg' | 'lg-ug' | 'li' | 'lkt' | 'lkt-us' | 'ln' | 'ln-ao' | 'ln-cd' | 'ln-cf' | 'ln-cg' | 'lo' | 'lo-la' | 'lrc' | 'lrc-iq' | 'lrc-ir' | 'lt' | 'lt-lt' | 'lu' | 'lu-cd' | 'luo' | 'luo-ke' | 'luy' | 'luy-ke' | 'lv' | 'lv-lv' | 'mai' | 'mai-in' | 'mas' | 'mas-ke' | 'mas-tz' | 'mdf' | 'mdf-ru' | 'mer' | 'mer-ke' | 'mfe' | 'mfe-mu' | 'mg' | 'mg-mg' | 'mgh' | 'mgh-mz' | 'mgo' | 'mgo-cm' | 'mh' | 'mi' | 'mi-nz' | 'mk' | 'mk-mk' | 'ml' | 'ml-in' | 'mn' | 'mn-mn' | 'mni' | 'mni-in' | 'mr' | 'mr-in' | 'ms' | 'ms-bn' | 'ms-id' | 'ms-my' | 'ms-sg' | 'mt' | 'mt-mt' | 'mua' | 'mua-cm' | 'my' | 'my-mm' | 'mzn' | 'mzn-ir' | 'na' | 'naq' | 'naq-na' | 'nb' | 'nb-no' | 'nb-sj' | 'nd' | 'nd-zw' | 'nds' | 'nds-de' | 'nds-nl' | 'ne' | 'ne-in' | 'ne-np' | 'ng' | 'nl' | 'nl-aw' | 'nl-be' | 'nl-bq' | 'nl-ch' | 'nl-cw' | 'nl-lu' | 'nl-nl' | 'nl-sr' | 'nl-sx' | 'nmg' | 'nmg-cm' | 'nn' | 'nn-no' | 'nnh' | 'nnh-cm' | 'no' | 'no-no' | 'nr' | 'nus' | 'nus-ss' | 'nv' | 'ny' | 'nyn' | 'nyn-ug' | 'oc' | 'oc-es' | 'oc-fr' | 'oj' | 'om' | 'om-et' | 'om-ke' | 'or' | 'or-in' | 'os' | 'os-ge' | 'os-ru' | 'pa' | 'pa-in' | 'pa-pk' | 'pcm' | 'pcm-ng' | 'pi' | 'pis' | 'pis-sb' | 'pl' | 'pl-pl' | 'prg' | 'prg-001' | 'ps' | 'ps-af' | 'ps-pk' | 'pt' | 'pt-ao' | 'pt-br' | 'pt-ch' | 'pt-cv' | 'pt-gq' | 'pt-gw' | 'pt-lu' | 'pt-mo' | 'pt-mz' | 'pt-pt' | 'pt-st' | 'pt-tl' | 'qu' | 'qu-bo' | 'qu-ec' | 'qu-pe' | 'raj' | 'raj-in' | 'rm' | 'rm-ch' | 'rn' | 'rn-bi' | 'ro' | 'ro-md' | 'ro-ro' | 'rof' | 'rof-tz' | 'ru' | 'ru-by' | 'ru-kg' | 'ru-kz' | 'ru-md' | 'ru-ru' | 'ru-ua' | 'rw' | 'rw-rw' | 'rwk' | 'rwk-tz' | 'sa' | 'sa-in' | 'sah' | 'sah-ru' | 'saq' | 'saq-ke' | 'sat' | 'sat-in' | 'sbp' | 'sbp-tz' | 'sc' | 'sc-it' | 'sd' | 'sd-in' | 'sd-pk' | 'se' | 'se-fi' | 'se-no' | 'se-se' | 'seh' | 'seh-mz' | 'ses' | 'ses-ml' | 'sg' | 'sg-cf' | 'shi' | 'shi-ma' | 'si' | 'si-lk' | 'sk' | 'sk-sk' | 'sl' | 'sl-si' | 'sm' | 'smn' | 'smn-fi' | 'sms' | 'sms-fi' | 'sn' | 'sn-zw' | 'so' | 'so-dj' | 'so-et' | 'so-ke' | 'so-so' | 'sq' | 'sq-al' | 'sq-mk' | 'sq-xk' | 'sr' | 'sr-ba' | 'sr-cs' | 'sr-me' | 'sr-rs' | 'sr-xk' | 'ss' | 'st' | 'su' | 'su-id' | 'sv' | 'sv-ax' | 'sv-fi' | 'sv-se' | 'sw' | 'sw-cd' | 'sw-ke' | 'sw-tz' | 'sw-ug' | 'sy' | 'ta' | 'ta-in' | 'ta-lk' | 'ta-my' | 'ta-sg' | 'te' | 'te-in' | 'teo' | 'teo-ke' | 'teo-ug' | 'tg' | 'tg-tj' | 'th' | 'th-th' | 'ti' | 'ti-er' | 'ti-et' | 'tk' | 'tk-tm' | 'tl' | 'tn' | 'to' | 'to-to' | 'tok' | 'tok-001' | 'tr' | 'tr-cy' | 'tr-tr' | 'ts' | 'tt' | 'tt-ru' | 'tw' | 'twq' | 'twq-ne' | 'ty' | 'tzm' | 'tzm-ma' | 'ug' | 'ug-cn' | 'uk' | 'uk-ua' | 'ur' | 'ur-in' | 'ur-pk' | 'uz' | 'uz-af' | 'uz-uz' | 'vai' | 'vai-lr' | 've' | 'vi' | 'vi-vn' | 'vo' | 'vo-001' | 'vun' | 'vun-tz' | 'wa' | 'wae' | 'wae-ch' | 'wo' | 'wo-sn' | 'xh' | 'xh-za' | 'xog' | 'xog-ug' | 'yav' | 'yav-cm' | 'yi' | 'yi-001' | 'yo' | 'yo-bj' | 'yo-ng' | 'yrl' | 'yrl-br' | 'yrl-co' | 'yrl-ve' | 'yue' | 'yue-cn' | 'yue-hk' | 'za' | 'zgh' | 'zgh-ma' | 'zh' | 'zh-cn' | 'zh-hans' | 'zh-hant' | 'zh-hk' | 'zh-mo' | 'zh-sg' | 'zh-tw' | 'zu' | 'zu-za';
|
|
467
|
+
/**
|
|
468
|
+
* The name of the email, as displayed on the email dashboard.
|
|
469
|
+
*/
|
|
470
|
+
name?: string;
|
|
471
|
+
previewKey?: string;
|
|
472
|
+
primaryEmailCampaignId?: string;
|
|
473
|
+
/**
|
|
474
|
+
* The date and time the email is scheduled for, in ISO8601 representation. This is only used in local time or scheduled emails.
|
|
475
|
+
*/
|
|
476
|
+
publishDate?: string;
|
|
477
|
+
/**
|
|
478
|
+
* The date and time the email was published at, in ISO8601 representation.
|
|
479
|
+
*/
|
|
480
|
+
publishedAt?: string;
|
|
481
|
+
/**
|
|
482
|
+
* Email of the user who published/sent the email.
|
|
483
|
+
*/
|
|
484
|
+
publishedByEmail?: string;
|
|
485
|
+
/**
|
|
486
|
+
* The ID of the user who published the email.
|
|
487
|
+
*/
|
|
488
|
+
publishedById?: string;
|
|
489
|
+
/**
|
|
490
|
+
* Name of the user who published the email.
|
|
491
|
+
*/
|
|
492
|
+
publishedByName?: string;
|
|
493
|
+
rssData?: Schemas.PublicRssEmailDetails;
|
|
494
|
+
/**
|
|
495
|
+
* Determines whether the email will be sent immediately on publish.
|
|
496
|
+
*/
|
|
497
|
+
sendOnPublish?: boolean;
|
|
498
|
+
/**
|
|
499
|
+
* The email state.
|
|
500
|
+
*/
|
|
501
|
+
state?: 'AGENT_GENERATED' | 'AUTOMATED' | 'AUTOMATED_AB' | 'AUTOMATED_AB_VARIANT' | 'AUTOMATED_DRAFT' | 'AUTOMATED_DRAFT_AB' | 'AUTOMATED_DRAFT_ABVARIANT' | 'AUTOMATED_FOR_FORM' | 'AUTOMATED_FOR_FORM_BUFFER' | 'AUTOMATED_FOR_FORM_DRAFT' | 'AUTOMATED_FOR_FORM_LEGACY' | 'AUTOMATED_LOSER_ABVARIANT' | 'AUTOMATED_SENDING' | 'BLOG_EMAIL_DRAFT' | 'BLOG_EMAIL_PUBLISHED' | 'DRAFT' | 'DRAFT_AB' | 'DRAFT_AB_VARIANT' | 'ERROR' | 'LOSER_AB_VARIANT' | 'PAGE_STUB' | 'PRE_PROCESSING' | 'PROCESSING' | 'PUBLISHED' | 'PUBLISHED_AB' | 'PUBLISHED_AB_VARIANT' | 'PUBLISHED_OR_SCHEDULED' | 'RSS_TO_EMAIL_DRAFT' | 'RSS_TO_EMAIL_PUBLISHED' | 'SCHEDULED' | 'SCHEDULED_AB' | 'SCHEDULED_OR_PUBLISHED';
|
|
502
|
+
stats?: Schemas.EmailStatisticsData;
|
|
503
|
+
/**
|
|
504
|
+
* The email subcategory.
|
|
505
|
+
*/
|
|
506
|
+
subcategory?: string;
|
|
507
|
+
/**
|
|
508
|
+
* The subject of the email.
|
|
509
|
+
*/
|
|
510
|
+
subject?: string;
|
|
511
|
+
subscriptionDetails?: Schemas.PublicEmailSubscriptionDetails;
|
|
512
|
+
teamsWithAccess?: string[];
|
|
513
|
+
testing?: Schemas.PublicEmailTestingDetails;
|
|
514
|
+
to?: Schemas.PublicEmailToDetails;
|
|
515
|
+
/**
|
|
516
|
+
* The email type, this is derived from other properties on the email such as subcategory.
|
|
517
|
+
*/
|
|
518
|
+
type?: 'AB_EMAIL' | 'AUTOMATED_AB_EMAIL' | 'AUTOMATED_EMAIL' | 'BATCH_EMAIL' | 'BLOG_EMAIL' | 'BLOG_EMAIL_CHILD' | 'FEEDBACK_CES_EMAIL' | 'FEEDBACK_CUSTOM_EMAIL' | 'FEEDBACK_CUSTOM_SURVEY_EMAIL' | 'FEEDBACK_NPS_EMAIL' | 'FOLLOWUP_EMAIL' | 'LEADFLOW_EMAIL' | 'LOCALTIME_EMAIL' | 'MANAGE_PREFERENCES_EMAIL' | 'MARKETING_SINGLE_SEND_API' | 'MEMBERSHIP_EMAIL_VERIFICATION_EMAIL' | 'MEMBERSHIP_FOLLOW_UP_EMAIL' | 'MEMBERSHIP_OTP_LOGIN_EMAIL' | 'MEMBERSHIP_PASSWORD_RESET_EMAIL' | 'MEMBERSHIP_PASSWORD_SAVED_EMAIL' | 'MEMBERSHIP_PASSWORDLESS_AUTH_EMAIL' | 'MEMBERSHIP_REGISTRATION_EMAIL' | 'MEMBERSHIP_REGISTRATION_FOLLOW_UP_EMAIL' | 'MEMBERSHIP_VERIFICATION_EMAIL' | 'OPTIN_EMAIL' | 'OPTIN_FOLLOWUP_EMAIL' | 'RESUBSCRIBE_EMAIL' | 'RSS_EMAIL' | 'RSS_EMAIL_CHILD' | 'SINGLE_SEND_API' | 'SMTP_TOKEN' | 'TICKET_EMAIL';
|
|
519
|
+
unpublishedAt?: string;
|
|
520
|
+
/**
|
|
521
|
+
* The date and time of the last update to the email, in ISO8601 representation.
|
|
522
|
+
*/
|
|
523
|
+
updatedAt?: string;
|
|
524
|
+
/**
|
|
525
|
+
* The id of the user who last updated the email.
|
|
526
|
+
*/
|
|
527
|
+
updatedById?: string;
|
|
528
|
+
usersWithAccess?: string[];
|
|
529
|
+
webversion?: Schemas.PublicWebversionDetails;
|
|
530
|
+
/**
|
|
531
|
+
* Names of workflows in which the email is used within a "send email" action.
|
|
532
|
+
*/
|
|
533
|
+
workflowNames?: string[];
|
|
534
|
+
}
|
|
535
|
+
interface PublicEmailContent {
|
|
536
|
+
flexAreas?: Record<string, Record<string, never>>;
|
|
537
|
+
plainTextVersion?: string;
|
|
538
|
+
smartFields?: Record<string, Schemas.SmartEmailField>;
|
|
539
|
+
styleSettings?: Schemas.PublicEmailStyleSettings;
|
|
540
|
+
templatePath?: string;
|
|
541
|
+
themeSettingsValues?: Record<string, Record<string, never>>;
|
|
542
|
+
widgetContainers?: Record<string, Record<string, never>>;
|
|
543
|
+
widgets?: Record<string, Record<string, never>>;
|
|
544
|
+
}
|
|
545
|
+
interface PublicEmailFromDetails {
|
|
546
|
+
/**
|
|
547
|
+
* The reply to recipients will see.
|
|
548
|
+
*/
|
|
549
|
+
customReplyTo?: string;
|
|
550
|
+
/**
|
|
551
|
+
* The name recipients will see.
|
|
552
|
+
*/
|
|
553
|
+
fromName?: string;
|
|
554
|
+
/**
|
|
555
|
+
* The from address and reply to email address (if no customReplyTo defined) recipients will see.
|
|
556
|
+
*/
|
|
557
|
+
replyTo?: string;
|
|
558
|
+
}
|
|
559
|
+
interface PublicEmailRecipients {
|
|
560
|
+
/**
|
|
561
|
+
* Excluded IDs.
|
|
562
|
+
*/
|
|
563
|
+
exclude?: string[];
|
|
564
|
+
/**
|
|
565
|
+
* Included IDs.
|
|
566
|
+
*/
|
|
567
|
+
include?: string[];
|
|
568
|
+
}
|
|
569
|
+
interface PublicEmailStyleSettings {
|
|
570
|
+
backgroundColor?: string;
|
|
571
|
+
backgroundImage?: string;
|
|
572
|
+
backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH';
|
|
573
|
+
bodyBorderColor?: string;
|
|
574
|
+
bodyBorderColorChoice?: string;
|
|
575
|
+
bodyBorderWidth?: number;
|
|
576
|
+
bodyColor?: string;
|
|
577
|
+
buttonStyleSettings?: Schemas.PublicButtonStyleSettings;
|
|
578
|
+
colorPickerFavorite1?: string;
|
|
579
|
+
colorPickerFavorite2?: string;
|
|
580
|
+
colorPickerFavorite3?: string;
|
|
581
|
+
colorPickerFavorite4?: string;
|
|
582
|
+
colorPickerFavorite5?: string;
|
|
583
|
+
colorPickerFavorite6?: string;
|
|
584
|
+
dividerStyleSettings?: Schemas.PublicDividerStyleSettings;
|
|
585
|
+
emailBodyPadding?: string;
|
|
586
|
+
emailBodyWidth?: string;
|
|
587
|
+
headingOneFont?: Schemas.PublicFontStyle;
|
|
588
|
+
headingTwoFont?: Schemas.PublicFontStyle;
|
|
589
|
+
linksFont?: Schemas.PublicFontStyle;
|
|
590
|
+
primaryAccentColor?: string;
|
|
591
|
+
primaryFont?: string;
|
|
592
|
+
primaryFontColor?: string;
|
|
593
|
+
primaryFontLineHeight?: string;
|
|
594
|
+
primaryFontSize?: number;
|
|
595
|
+
secondaryAccentColor?: string;
|
|
596
|
+
secondaryFont?: string;
|
|
597
|
+
secondaryFontColor?: string;
|
|
598
|
+
secondaryFontLineHeight?: string;
|
|
599
|
+
secondaryFontSize?: number;
|
|
600
|
+
}
|
|
601
|
+
interface PublicEmailSubscriptionDetails {
|
|
602
|
+
/**
|
|
603
|
+
* ID of the selected office location.
|
|
604
|
+
*/
|
|
605
|
+
officeLocationId?: string;
|
|
606
|
+
preferencesGroupId?: string;
|
|
607
|
+
/**
|
|
608
|
+
* ID of the subscription.
|
|
609
|
+
*/
|
|
610
|
+
subscriptionId?: string;
|
|
611
|
+
subscriptionName?: string;
|
|
612
|
+
}
|
|
613
|
+
interface PublicEmailTestingDetails {
|
|
614
|
+
/**
|
|
615
|
+
* Version of the email that should be sent if there are too few recipients to conduct an AB test.
|
|
616
|
+
*/
|
|
617
|
+
abSampleSizeDefault?: 'automated_loser_variant' | 'automated_master' | 'automated_variant' | 'loser_variant' | 'mab_master' | 'mab_variant' | 'master' | 'variant';
|
|
618
|
+
/**
|
|
619
|
+
* Version of the email that should be sent if the results are inconclusive after the test period, master or variant.
|
|
620
|
+
*/
|
|
621
|
+
abSamplingDefault?: 'automated_loser_variant' | 'automated_master' | 'automated_variant' | 'loser_variant' | 'mab_master' | 'mab_variant' | 'master' | 'variant';
|
|
622
|
+
/**
|
|
623
|
+
* Status of the AB test.
|
|
624
|
+
*/
|
|
625
|
+
abStatus?: 'automated_loser_variant' | 'automated_master' | 'automated_variant' | 'loser_variant' | 'mab_master' | 'mab_variant' | 'master' | 'variant';
|
|
626
|
+
/**
|
|
627
|
+
* Metric to determine the version that will be sent to the remaining contacts.
|
|
628
|
+
*/
|
|
629
|
+
abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED';
|
|
630
|
+
/**
|
|
631
|
+
* The size of your test group.
|
|
632
|
+
*/
|
|
633
|
+
abTestPercentage?: number;
|
|
634
|
+
/**
|
|
635
|
+
* Time limit on gathering test results. After this time is up, the winning version will be sent to the remaining contacts.
|
|
636
|
+
*/
|
|
637
|
+
hoursToWait?: number;
|
|
638
|
+
isAbVariation: boolean;
|
|
639
|
+
/**
|
|
640
|
+
* The ID of the AB test.
|
|
641
|
+
*/
|
|
642
|
+
testId?: string;
|
|
643
|
+
}
|
|
644
|
+
interface PublicEmailToDetails {
|
|
645
|
+
contactIds?: Schemas.PublicEmailRecipients;
|
|
646
|
+
contactIlsLists?: Schemas.PublicEmailRecipients;
|
|
647
|
+
contactLists?: Schemas.PublicEmailRecipients;
|
|
648
|
+
limitSendFrequency?: boolean;
|
|
649
|
+
/**
|
|
650
|
+
* Whether to send to unengaged contacts (false) or not (true).
|
|
651
|
+
*/
|
|
652
|
+
suppressGraymail?: boolean;
|
|
653
|
+
}
|
|
654
|
+
interface PublicEmailVersion {
|
|
655
|
+
id: string;
|
|
656
|
+
object: Schemas.PublicEmail;
|
|
657
|
+
updatedAt: string;
|
|
658
|
+
user: Schemas.VersionUser;
|
|
659
|
+
}
|
|
660
|
+
interface PublicFontStyle {
|
|
661
|
+
bold?: boolean;
|
|
662
|
+
color?: string;
|
|
663
|
+
font?: string;
|
|
664
|
+
italic?: boolean;
|
|
665
|
+
size?: number;
|
|
666
|
+
underline?: boolean;
|
|
667
|
+
}
|
|
668
|
+
interface PublicRssEmailDetails {
|
|
669
|
+
blogEmailType?: string;
|
|
670
|
+
blogImageMaxWidth?: number;
|
|
671
|
+
blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE';
|
|
672
|
+
hubspotBlogId?: string;
|
|
673
|
+
maxEntries?: number;
|
|
674
|
+
rssEntryTemplate?: string;
|
|
675
|
+
timing?: Record<string, Record<string, never>>;
|
|
676
|
+
url?: string;
|
|
677
|
+
useHeadlineAsSubject?: boolean;
|
|
678
|
+
}
|
|
679
|
+
interface PublicWebversionDetails {
|
|
680
|
+
domain?: string;
|
|
681
|
+
enabled?: boolean;
|
|
682
|
+
expiresAt?: string;
|
|
683
|
+
isPageRedirected?: boolean;
|
|
684
|
+
metaDescription?: string;
|
|
685
|
+
pageExpiryEnabled?: boolean;
|
|
686
|
+
redirectToPageId?: string;
|
|
687
|
+
redirectToUrl?: string;
|
|
688
|
+
slug?: string;
|
|
689
|
+
title?: string;
|
|
690
|
+
url?: string;
|
|
691
|
+
}
|
|
692
|
+
interface SmartEmailField {}
|
|
693
|
+
interface VersionPublicEmail {
|
|
694
|
+
/**
|
|
695
|
+
* ID of this marketing email version.
|
|
696
|
+
*/
|
|
697
|
+
id: string;
|
|
698
|
+
object: Schemas.PublicEmail;
|
|
699
|
+
/**
|
|
700
|
+
* The date and time of the last update to the email, in ISO8601 representation.
|
|
701
|
+
*/
|
|
702
|
+
updatedAt: string;
|
|
703
|
+
user: Schemas.VersionUser;
|
|
704
|
+
}
|
|
705
|
+
interface VersionUser {
|
|
706
|
+
/**
|
|
707
|
+
* Email address of the user.
|
|
708
|
+
*/
|
|
709
|
+
email: string;
|
|
710
|
+
/**
|
|
711
|
+
* First and last name of the user.
|
|
712
|
+
*/
|
|
713
|
+
fullName: string;
|
|
714
|
+
/**
|
|
715
|
+
* ID of the user.
|
|
716
|
+
*/
|
|
717
|
+
id: string;
|
|
718
|
+
}
|
|
719
|
+
}
|
|
720
|
+
/**
|
|
721
|
+
* Usage example:
|
|
722
|
+
* ```ts
|
|
723
|
+
* import { marketingMarketingEmails } from '@hubspot/api-client-core';
|
|
724
|
+
* client.send(marketingMarketingEmails.basic.create(input));
|
|
725
|
+
* ```
|
|
726
|
+
*/
|
|
727
|
+
interface BasicAPI {
|
|
728
|
+
/**
|
|
729
|
+
* @apiPath /marketing/emails/2026-03
|
|
730
|
+
* @apiMethod POST
|
|
731
|
+
* @requiredScopes content-core-api-access
|
|
732
|
+
*/
|
|
733
|
+
create: (input: Basic.CreateInput) => Operation<Basic.CreateOutput>;
|
|
734
|
+
/**
|
|
735
|
+
* Get aggregated statistics
|
|
736
|
+
* @apiPath /marketing/emails/2026-03/statistics/list
|
|
737
|
+
* @apiMethod GET
|
|
738
|
+
* @requiredScopes content-core-api-access
|
|
739
|
+
*/
|
|
740
|
+
get: (input?: Basic.GetInput) => Operation<Basic.GetOutput>;
|
|
741
|
+
/**
|
|
742
|
+
* Get aggregated statistic intervals
|
|
743
|
+
* @apiPath /marketing/emails/2026-03/statistics/histogram
|
|
744
|
+
* @apiMethod GET
|
|
745
|
+
* @requiredScopes content-core-api-access
|
|
746
|
+
*/
|
|
747
|
+
getHistogram: (input?: Basic.GetHistogramInput) => Operation<Basic.GetHistogramOutput>;
|
|
748
|
+
/**
|
|
749
|
+
* @apiPath /marketing/emails/2026-03
|
|
750
|
+
* @apiMethod GET
|
|
751
|
+
* @requiredScopes content-core-api-access
|
|
752
|
+
*/
|
|
753
|
+
list: (input?: Basic.ListInput) => Operation<Basic.ListOutput>;
|
|
754
|
+
}
|
|
755
|
+
/**
|
|
756
|
+
* Usage example:
|
|
757
|
+
* ```ts
|
|
758
|
+
* import { marketingMarketingEmails } from '@hubspot/api-client-core';
|
|
759
|
+
* client.send(marketingMarketingEmails.emails.clone(input));
|
|
760
|
+
* ```
|
|
761
|
+
*/
|
|
762
|
+
interface EmailsAPI {
|
|
763
|
+
/**
|
|
764
|
+
* Clone a marketing email
|
|
765
|
+
* @apiPath /marketing/emails/2026-03/clone
|
|
766
|
+
* @apiMethod POST
|
|
767
|
+
* @requiredScopes content-core-api-access
|
|
768
|
+
*/
|
|
769
|
+
clone: (input: Emails.CloneInput) => Operation<Emails.CloneOutput>;
|
|
770
|
+
/**
|
|
771
|
+
* Create an A/B test variation of a marketing email
|
|
772
|
+
* @apiPath /marketing/emails/2026-03/ab-test/create-variation
|
|
773
|
+
* @apiMethod POST
|
|
774
|
+
* @requiredScopes content-core-api-access
|
|
775
|
+
*/
|
|
776
|
+
createAbTestVariation: (input: Emails.CreateAbTestVariationInput) => Operation<Emails.CreateAbTestVariationOutput>;
|
|
777
|
+
/**
|
|
778
|
+
* Delete a marketing email
|
|
779
|
+
* @apiPath /marketing/emails/2026-03/{emailId}
|
|
780
|
+
* @apiMethod DELETE
|
|
781
|
+
* @requiredScopes content-core-api-access
|
|
782
|
+
*/
|
|
783
|
+
delete: (input: Emails.DeleteInput) => Operation<Emails.DeleteOutput>;
|
|
784
|
+
/**
|
|
785
|
+
* Get the details of a specified marketing email
|
|
786
|
+
* @apiPath /marketing/emails/2026-03/{emailId}
|
|
787
|
+
* @apiMethod GET
|
|
788
|
+
* @requiredScopes content-core-api-access
|
|
789
|
+
*/
|
|
790
|
+
get: (input: Emails.GetInput) => Operation<Emails.GetOutput>;
|
|
791
|
+
/**
|
|
792
|
+
* Get the variation of a an A/B marketing email
|
|
793
|
+
* @apiPath /marketing/emails/2026-03/{emailId}/ab-test/get-variation
|
|
794
|
+
* @apiMethod GET
|
|
795
|
+
* @requiredScopes content-core-api-access
|
|
796
|
+
*/
|
|
797
|
+
getAbTestVariation: (input: Emails.GetAbTestVariationInput) => Operation<Emails.GetAbTestVariationOutput>;
|
|
798
|
+
/**
|
|
799
|
+
* Get draft version of a marketing email
|
|
800
|
+
* @apiPath /marketing/emails/2026-03/{emailId}/draft
|
|
801
|
+
* @apiMethod GET
|
|
802
|
+
* @requiredScopes content-core-api-access
|
|
803
|
+
*/
|
|
804
|
+
getDraft: (input: Emails.GetDraftInput) => Operation<Emails.GetDraftOutput>;
|
|
805
|
+
/**
|
|
806
|
+
* Get a revision of a marketing email
|
|
807
|
+
* @apiPath /marketing/emails/2026-03/{emailId}/revisions/{revisionId}
|
|
808
|
+
* @apiMethod GET
|
|
809
|
+
* @requiredScopes content-core-api-access
|
|
810
|
+
*/
|
|
811
|
+
getRevision: (input: Emails.GetRevisionInput) => Operation<Emails.GetRevisionOutput>;
|
|
812
|
+
/**
|
|
813
|
+
* Get revisions of a marketing email
|
|
814
|
+
* @apiPath /marketing/emails/2026-03/{emailId}/revisions
|
|
815
|
+
* @apiMethod GET
|
|
816
|
+
* @requiredScopes content-core-api-access
|
|
817
|
+
*/
|
|
818
|
+
listRevisions: (input: Emails.ListRevisionsInput) => Operation<Emails.ListRevisionsOutput>;
|
|
819
|
+
/**
|
|
820
|
+
* Publish or send a marketing email
|
|
821
|
+
* @apiPath /marketing/emails/2026-03/{emailId}/publish
|
|
822
|
+
* @apiMethod POST
|
|
823
|
+
* @requiredScopes marketing-email-publish-api-access
|
|
824
|
+
*/
|
|
825
|
+
publish: (input: Emails.PublishInput) => Operation<Emails.PublishOutput>;
|
|
826
|
+
/**
|
|
827
|
+
* Reset the draft version
|
|
828
|
+
* @apiPath /marketing/emails/2026-03/{emailId}/draft/reset
|
|
829
|
+
* @apiMethod POST
|
|
830
|
+
* @requiredScopes content-core-api-access
|
|
831
|
+
*/
|
|
832
|
+
resetDraft: (input: Emails.ResetDraftInput) => Operation<Emails.ResetDraftOutput>;
|
|
833
|
+
/**
|
|
834
|
+
* Restore a revision of a marketing email
|
|
835
|
+
* @apiPath /marketing/emails/2026-03/{emailId}/revisions/{revisionId}/restore
|
|
836
|
+
* @apiMethod POST
|
|
837
|
+
* @requiredScopes content-core-api-access
|
|
838
|
+
*/
|
|
839
|
+
restoreRevision: (input: Emails.RestoreRevisionInput) => Operation<Emails.RestoreRevisionOutput>;
|
|
840
|
+
/**
|
|
841
|
+
* Restore a revision of a marketing email to DRAFT state
|
|
842
|
+
* @apiPath /marketing/emails/2026-03/{emailId}/revisions/{revisionId}/restore-to-draft
|
|
843
|
+
* @apiMethod POST
|
|
844
|
+
* @requiredScopes content-core-api-access
|
|
845
|
+
*/
|
|
846
|
+
restoreRevisionToDraft: (input: Emails.RestoreRevisionToDraftInput) => Operation<Emails.RestoreRevisionToDraftOutput>;
|
|
847
|
+
/**
|
|
848
|
+
* Unpublish or cancel a marketing email
|
|
849
|
+
* @apiPath /marketing/emails/2026-03/{emailId}/unpublish
|
|
850
|
+
* @apiMethod POST
|
|
851
|
+
* @requiredScopes marketing-email-publish-api-access
|
|
852
|
+
*/
|
|
853
|
+
unpublish: (input: Emails.UnpublishInput) => Operation<Emails.UnpublishOutput>;
|
|
854
|
+
/**
|
|
855
|
+
* Update a marketing email
|
|
856
|
+
* @apiPath /marketing/emails/2026-03/{emailId}
|
|
857
|
+
* @apiMethod PATCH
|
|
858
|
+
* @requiredScopes content-core-api-access
|
|
859
|
+
*/
|
|
860
|
+
update: (input: Emails.UpdateInput) => Operation<Emails.UpdateOutput>;
|
|
861
|
+
/**
|
|
862
|
+
* Create or update draft version
|
|
863
|
+
* @apiPath /marketing/emails/2026-03/{emailId}/draft
|
|
864
|
+
* @apiMethod PATCH
|
|
865
|
+
* @requiredScopes content-core-api-access
|
|
866
|
+
*/
|
|
867
|
+
updateDraft: (input: Emails.UpdateDraftInput) => Operation<Emails.UpdateDraftOutput>;
|
|
868
|
+
}
|
|
869
|
+
/**
|
|
870
|
+
* Usage example:
|
|
871
|
+
* ```ts
|
|
872
|
+
* import { marketingMarketingEmails } from '@hubspot/api-client-core';
|
|
873
|
+
* client.send(marketingMarketingEmails.basic.create(input));
|
|
874
|
+
* ```
|
|
875
|
+
*/
|
|
876
|
+
interface API {
|
|
877
|
+
basic: BasicAPI;
|
|
878
|
+
emails: EmailsAPI;
|
|
879
|
+
}
|
|
880
|
+
}
|
|
881
|
+
//#endregion
|
|
882
|
+
export { MarketingMarketingEmails };
|
|
883
|
+
//# sourceMappingURL=marketing-emails-types.generated.d.ts.map
|