@hubspot/app-connect-sdk 1.0.0-alpha.2 → 1.0.0-alpha.21
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 +1 -1
- package/.turbo/turbo-test.log +101 -57
- package/.turbo/turbo-tsdown.log +474 -469
- package/build/tsconfig.browser.tsbuildinfo +1 -1
- package/build/tsconfig.server.tsbuildinfo +1 -1
- package/dist/browser/{HubSpotAppConnect-BW45gyDs.js → HubSpotAppConnect-721kYr9d.js} +17 -23
- package/dist/browser/HubSpotAppConnect-721kYr9d.js.map +1 -0
- package/dist/browser/{create-vctOhpX9.js → create-DxEyGG-k.js} +336 -100
- package/dist/browser/create-DxEyGG-k.js.map +1 -0
- package/dist/browser/index.d.ts +2 -2
- package/dist/browser/index.js +1 -1
- package/dist/browser/react/lovable.d.ts +9 -2
- package/dist/browser/react/lovable.js +7 -4
- package/dist/browser/react/lovable.js.map +1 -1
- package/dist/browser/react.d.ts +2 -3
- package/dist/browser/react.js +1 -1
- package/dist/browser/{types-rTQw6A54.d.ts → types-C3wed8dU.d.ts} +52 -7
- package/dist/server/api-client-core/apis/account/account-info-types.generated.d.ts +73 -85
- package/dist/server/api-client-core/apis/account/account-info.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/account/account-info.generated.js +4 -3
- package/dist/server/api-client-core/apis/account/account-info.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/account/audit-logs-types.generated.d.ts +203 -215
- package/dist/server/api-client-core/apis/account/audit-logs.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/account/audit-logs.generated.js +4 -3
- package/dist/server/api-client-core/apis/account/audit-logs.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/auth/oauth-types.generated.d.ts +78 -90
- package/dist/server/api-client-core/apis/auth/oauth.generated.d.ts +1 -1
- package/dist/server/api-client-core/apis/auth/oauth.generated.js +3 -2
- package/dist/server/api-client-core/apis/auth/oauth.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/automation/actions-types.generated.d.ts +779 -794
- package/dist/server/api-client-core/apis/automation/actions.generated.d.ts +6 -3
- package/dist/server/api-client-core/apis/automation/actions.generated.js +101 -102
- package/dist/server/api-client-core/apis/automation/actions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/automation/sequences-types.generated.d.ts +370 -382
- package/dist/server/api-client-core/apis/automation/sequences.generated.d.ts +1 -1
- package/dist/server/api-client-core/apis/automation/sequences.generated.js +3 -2
- package/dist/server/api-client-core/apis/automation/sequences.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/business-units-types.generated.d.ts +43 -55
- package/dist/server/api-client-core/apis/business-units.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/business-units.generated.js +4 -3
- package/dist/server/api-client-core/apis/business-units.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/authors-types.generated.d.ts +420 -445
- package/dist/server/api-client-core/apis/cms/authors.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/cms/authors.generated.js +155 -158
- package/dist/server/api-client-core/apis/cms/authors.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/blog-settings-types.generated.d.ts +270 -295
- package/dist/server/api-client-core/apis/cms/blog-settings.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/cms/blog-settings.generated.js +35 -38
- package/dist/server/api-client-core/apis/cms/blog-settings.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/cms-content-audit-types.generated.d.ts +107 -131
- package/dist/server/api-client-core/apis/cms/cms-content-audit.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/cms/cms-content-audit.generated.js +6 -5
- package/dist/server/api-client-core/apis/cms/cms-content-audit.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/domains-types.generated.d.ts +155 -167
- package/dist/server/api-client-core/apis/cms/domains.generated.d.ts +2 -2
- package/dist/server/api-client-core/apis/cms/domains.generated.js +3 -2
- package/dist/server/api-client-core/apis/cms/domains.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/hubdb-types.generated.d.ts +876 -889
- package/dist/server/api-client-core/apis/cms/hubdb.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/cms/hubdb.generated.js +184 -185
- package/dist/server/api-client-core/apis/cms/hubdb.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/media-bridge-types.generated.d.ts +1550 -1575
- package/dist/server/api-client-core/apis/cms/media-bridge.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/cms/media-bridge.generated.js +161 -164
- package/dist/server/api-client-core/apis/cms/media-bridge.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/pages-types.generated.d.ts +1583 -1547
- package/dist/server/api-client-core/apis/cms/pages.generated.d.ts +15 -3
- package/dist/server/api-client-core/apis/cms/pages.generated.js +335 -326
- package/dist/server/api-client-core/apis/cms/pages.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/posts-types.generated.d.ts +900 -904
- package/dist/server/api-client-core/apis/cms/posts.generated.d.ts +7 -3
- package/dist/server/api-client-core/apis/cms/posts.generated.js +197 -196
- package/dist/server/api-client-core/apis/cms/posts.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/site-search-types.generated.d.ts +162 -174
- package/dist/server/api-client-core/apis/cms/site-search.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/cms/site-search.generated.js +4 -3
- package/dist/server/api-client-core/apis/cms/site-search.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/source-code-types.generated.d.ts +148 -172
- package/dist/server/api-client-core/apis/cms/source-code.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/cms/source-code.generated.js +40 -43
- package/dist/server/api-client-core/apis/cms/source-code.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/tags-types.generated.d.ts +406 -420
- package/dist/server/api-client-core/apis/cms/tags.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/cms/tags.generated.js +157 -158
- package/dist/server/api-client-core/apis/cms/tags.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/url-mappings-types.generated.d.ts +127 -139
- package/dist/server/api-client-core/apis/cms/url-mappings.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/cms/url-mappings.generated.js +4 -3
- package/dist/server/api-client-core/apis/cms/url-mappings.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/url-redirects-types.generated.d.ts +170 -182
- package/dist/server/api-client-core/apis/cms/url-redirects.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/cms/url-redirects.generated.js +4 -3
- package/dist/server/api-client-core/apis/cms/url-redirects.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/communication-preferences/subscriptions-types.generated.d.ts +728 -742
- package/dist/server/api-client-core/apis/communication-preferences/subscriptions.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/communication-preferences/subscriptions.generated.js +66 -69
- package/dist/server/api-client-core/apis/communication-preferences/subscriptions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/conversations/custom-channels-types.generated.d.ts +445 -471
- package/dist/server/api-client-core/apis/conversations/custom-channels.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/conversations/custom-channels.generated.js +70 -73
- package/dist/server/api-client-core/apis/conversations/custom-channels.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/conversations/visitor-identification-types.generated.d.ts +28 -40
- package/dist/server/api-client-core/apis/conversations/visitor-identification.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/conversations/visitor-identification.generated.js +3 -2
- package/dist/server/api-client-core/apis/conversations/visitor-identification.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/conversations-types.generated.d.ts +768 -781
- package/dist/server/api-client-core/apis/conversations.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/conversations.generated.js +101 -102
- package/dist/server/api-client-core/apis/conversations.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/app-uninstalls-types.generated.d.ts +8 -19
- package/dist/server/api-client-core/apis/crm/app-uninstalls.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/app-uninstalls.generated.js +3 -2
- package/dist/server/api-client-core/apis/crm/app-uninstalls.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/appointments-types.generated.d.ts +887 -891
- package/dist/server/api-client-core/apis/crm/appointments.generated.d.ts +7 -3
- package/dist/server/api-client-core/apis/crm/appointments.generated.js +105 -106
- package/dist/server/api-client-core/apis/crm/appointments.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/associations-schema-types.generated.d.ts +247 -260
- package/dist/server/api-client-core/apis/crm/associations-schema.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/crm/associations-schema.generated.js +48 -49
- package/dist/server/api-client-core/apis/crm/associations-schema.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/associations-types.generated.d.ts +576 -590
- package/dist/server/api-client-core/apis/crm/associations.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/associations.generated.js +71 -72
- package/dist/server/api-client-core/apis/crm/associations.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/calling-extensions-types.generated.d.ts +355 -379
- package/dist/server/api-client-core/apis/crm/calling-extensions.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/calling-extensions.generated.js +34 -37
- package/dist/server/api-client-core/apis/crm/calling-extensions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/calls-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/calls.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/calls.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/calls.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/carts-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/carts.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/carts.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/carts.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/commerce-payments-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/commerce-payments.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/commerce-payments.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/commerce-payments.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/commerce-subscriptions-types.generated.d.ts +752 -766
- package/dist/server/api-client-core/apis/crm/commerce-subscriptions.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/commerce-subscriptions.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/commerce-subscriptions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/communications-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/communications.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/communications.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/communications.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/companies-types.generated.d.ts +769 -795
- package/dist/server/api-client-core/apis/crm/companies.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/companies.generated.js +59 -58
- package/dist/server/api-client-core/apis/crm/companies.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/contacts-types.generated.d.ts +786 -812
- package/dist/server/api-client-core/apis/crm/contacts.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/contacts.generated.js +60 -61
- package/dist/server/api-client-core/apis/crm/contacts.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/contracts-types.generated.d.ts +796 -777
- package/dist/server/api-client-core/apis/crm/contracts.generated.d.ts +8 -3
- package/dist/server/api-client-core/apis/crm/contracts.generated.js +60 -57
- package/dist/server/api-client-core/apis/crm/contracts.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/courses-types.generated.d.ts +758 -772
- package/dist/server/api-client-core/apis/crm/courses.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/courses.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/courses.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/crm-owners-types.generated.d.ts +103 -115
- package/dist/server/api-client-core/apis/crm/crm-owners.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/crm-owners.generated.js +4 -3
- package/dist/server/api-client-core/apis/crm/crm-owners.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/custom-objects-types.generated.d.ts +833 -848
- package/dist/server/api-client-core/apis/crm/custom-objects.generated.d.ts +6 -3
- package/dist/server/api-client-core/apis/crm/custom-objects.generated.js +91 -90
- package/dist/server/api-client-core/apis/crm/custom-objects.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/deal-splits-types.generated.d.ts +158 -170
- package/dist/server/api-client-core/apis/crm/deal-splits.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/deal-splits.generated.js +4 -3
- package/dist/server/api-client-core/apis/crm/deal-splits.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/deals-types.generated.d.ts +771 -785
- package/dist/server/api-client-core/apis/crm/deals.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/deals.generated.js +59 -58
- package/dist/server/api-client-core/apis/crm/deals.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/discounts-types.generated.d.ts +754 -768
- package/dist/server/api-client-core/apis/crm/discounts.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/discounts.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/discounts.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/emails-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/emails.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/emails.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/emails.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/exports-types.generated.d.ts +227 -251
- package/dist/server/api-client-core/apis/crm/exports.generated.d.ts +2 -2
- package/dist/server/api-client-core/apis/crm/exports.generated.js +4 -5
- package/dist/server/api-client-core/apis/crm/exports.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/feedback-submissions-types.generated.d.ts +551 -565
- package/dist/server/api-client-core/apis/crm/feedback-submissions.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/feedback-submissions.generated.js +45 -46
- package/dist/server/api-client-core/apis/crm/feedback-submissions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/fees-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/fees.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/fees.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/fees.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/goal-targets-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/goal-targets.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/goal-targets.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/goal-targets.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/imports-types.generated.d.ts +305 -329
- package/dist/server/api-client-core/apis/crm/imports.generated.d.ts +2 -2
- package/dist/server/api-client-core/apis/crm/imports.generated.js +20 -23
- package/dist/server/api-client-core/apis/crm/imports.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/invoices-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/invoices.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/invoices.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/invoices.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/leads-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/leads.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/leads.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/leads.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/limits-tracking-types.generated.d.ts +251 -263
- package/dist/server/api-client-core/apis/crm/limits-tracking.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/limits-tracking.generated.js +4 -3
- package/dist/server/api-client-core/apis/crm/limits-tracking.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/line-items-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/line-items.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/line-items.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/line-items.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/listings-types.generated.d.ts +758 -772
- package/dist/server/api-client-core/apis/crm/listings.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/listings.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/listings.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/lists-types.generated.d.ts +2075 -2111
- package/dist/server/api-client-core/apis/crm/lists.generated.d.ts +2 -2
- package/dist/server/api-client-core/apis/crm/lists.generated.js +97 -98
- package/dist/server/api-client-core/apis/crm/lists.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/meetings-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/meetings.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/meetings.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/meetings.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/notes-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/notes.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/notes.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/notes.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/object-library-types.generated.d.ts +24 -36
- package/dist/server/api-client-core/apis/crm/object-library.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/object-library.generated.js +4 -3
- package/dist/server/api-client-core/apis/crm/object-library.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/objects-types.generated.d.ts +620 -645
- package/dist/server/api-client-core/apis/crm/objects.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/crm/objects.generated.js +66 -67
- package/dist/server/api-client-core/apis/crm/objects.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/orders-types.generated.d.ts +747 -761
- package/dist/server/api-client-core/apis/crm/orders.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/orders.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/orders.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/partner-clients-types.generated.d.ts +646 -660
- package/dist/server/api-client-core/apis/crm/partner-clients.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/partner-clients.generated.js +63 -62
- package/dist/server/api-client-core/apis/crm/partner-clients.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/partner-services-types.generated.d.ts +646 -660
- package/dist/server/api-client-core/apis/crm/partner-services.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/partner-services.generated.js +63 -62
- package/dist/server/api-client-core/apis/crm/partner-services.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/pipelines-types.generated.d.ts +320 -332
- package/dist/server/api-client-core/apis/crm/pipelines.generated.d.ts +2 -2
- package/dist/server/api-client-core/apis/crm/pipelines.generated.js +3 -2
- package/dist/server/api-client-core/apis/crm/pipelines.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/postal-mail-types.generated.d.ts +744 -758
- package/dist/server/api-client-core/apis/crm/postal-mail.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/postal-mail.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/postal-mail.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/products-types.generated.d.ts +747 -761
- package/dist/server/api-client-core/apis/crm/products.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/products.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/products.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/projects-types.generated.d.ts +761 -787
- package/dist/server/api-client-core/apis/crm/projects.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/projects.generated.js +59 -58
- package/dist/server/api-client-core/apis/crm/projects.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/properties-types.generated.d.ts +526 -528
- package/dist/server/api-client-core/apis/crm/properties.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/properties.generated.js +79 -78
- package/dist/server/api-client-core/apis/crm/properties.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/property-validations-types.generated.d.ts +71 -83
- package/dist/server/api-client-core/apis/crm/property-validations.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/property-validations.generated.js +4 -3
- package/dist/server/api-client-core/apis/crm/property-validations.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/public-app-crm-cards-types.generated.d.ts +409 -433
- package/dist/server/api-client-core/apis/crm/public-app-crm-cards.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/public-app-crm-cards.generated.js +24 -25
- package/dist/server/api-client-core/apis/crm/public-app-crm-cards.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/public-app-feature-flags-types.generated.d.ts +156 -169
- package/dist/server/api-client-core/apis/crm/public-app-feature-flags.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/crm/public-app-feature-flags.generated.js +55 -56
- package/dist/server/api-client-core/apis/crm/public-app-feature-flags.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/quotes-types.generated.d.ts +747 -761
- package/dist/server/api-client-core/apis/crm/quotes.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/quotes.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/quotes.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/schemas-types.generated.d.ts +575 -600
- package/dist/server/api-client-core/apis/crm/schemas.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/crm/schemas.generated.js +33 -34
- package/dist/server/api-client-core/apis/crm/schemas.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/services-types.generated.d.ts +750 -764
- package/dist/server/api-client-core/apis/crm/services.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/services.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/services.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/tasks-types.generated.d.ts +747 -761
- package/dist/server/api-client-core/apis/crm/tasks.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/tasks.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/tasks.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/taxes-types.generated.d.ts +747 -761
- package/dist/server/api-client-core/apis/crm/taxes.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/taxes.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/taxes.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/tickets-types.generated.d.ts +764 -790
- package/dist/server/api-client-core/apis/crm/tickets.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/tickets.generated.js +59 -58
- package/dist/server/api-client-core/apis/crm/tickets.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/timeline-types.generated.d.ts +136 -149
- package/dist/server/api-client-core/apis/crm/timeline.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/crm/timeline.generated.js +5 -6
- package/dist/server/api-client-core/apis/crm/timeline.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/transcriptions-types.generated.d.ts +104 -117
- package/dist/server/api-client-core/apis/crm/transcriptions.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/crm/transcriptions.generated.js +7 -10
- package/dist/server/api-client-core/apis/crm/transcriptions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/users-types.generated.d.ts +747 -761
- package/dist/server/api-client-core/apis/crm/users.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/users.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/users.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/video-conferencing-extension-types.generated.d.ts +28 -40
- package/dist/server/api-client-core/apis/crm/video-conferencing-extension.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/video-conferencing-extension.generated.js +4 -3
- package/dist/server/api-client-core/apis/crm/video-conferencing-extension.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/events/manage-event-definitions-types.generated.d.ts +909 -945
- package/dist/server/api-client-core/apis/events/manage-event-definitions.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/events/manage-event-definitions.generated.js +29 -30
- package/dist/server/api-client-core/apis/events/manage-event-definitions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/events/send-event-completions-types.generated.d.ts +49 -62
- package/dist/server/api-client-core/apis/events/send-event-completions.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/events/send-event-completions.generated.js +4 -5
- package/dist/server/api-client-core/apis/events/send-event-completions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/events-types.generated.d.ts +99 -111
- package/dist/server/api-client-core/apis/events.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/events.generated.js +4 -3
- package/dist/server/api-client-core/apis/events.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/files-types.generated.d.ts +636 -649
- package/dist/server/api-client-core/apis/files.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/files.generated.js +112 -113
- package/dist/server/api-client-core/apis/files.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/marketing/campaigns-public-api-types.generated.d.ts +799 -816
- package/dist/server/api-client-core/apis/marketing/campaigns-public-api.generated.d.ts +8 -3
- package/dist/server/api-client-core/apis/marketing/campaigns-public-api.generated.js +126 -127
- package/dist/server/api-client-core/apis/marketing/campaigns-public-api.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/marketing/marketing-emails-types.generated.d.ts +745 -769
- package/dist/server/api-client-core/apis/marketing/marketing-emails.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/marketing/marketing-emails.generated.js +100 -103
- package/dist/server/api-client-core/apis/marketing/marketing-emails.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/marketing/marketing-events-types.generated.d.ts +1504 -1546
- package/dist/server/api-client-core/apis/marketing/marketing-events.generated.d.ts +9 -3
- package/dist/server/api-client-core/apis/marketing/marketing-events.generated.js +162 -167
- package/dist/server/api-client-core/apis/marketing/marketing-events.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/marketing/single-send-types.generated.d.ts +91 -103
- package/dist/server/api-client-core/apis/marketing/single-send.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/marketing/single-send.generated.js +3 -2
- package/dist/server/api-client-core/apis/marketing/single-send.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/marketing/transactional-single-send-types.generated.d.ts +187 -200
- package/dist/server/api-client-core/apis/marketing/transactional-single-send.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/marketing/transactional-single-send.generated.js +14 -15
- package/dist/server/api-client-core/apis/marketing/transactional-single-send.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/meta/origins-types.generated.d.ts +41 -53
- package/dist/server/api-client-core/apis/meta/origins.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/meta/origins.generated.js +4 -3
- package/dist/server/api-client-core/apis/meta/origins.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/scheduler/meetings-types.generated.d.ts +850 -863
- package/dist/server/api-client-core/apis/scheduler/meetings.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/scheduler/meetings.generated.js +28 -29
- package/dist/server/api-client-core/apis/scheduler/meetings.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/settings/multicurrency-types.generated.d.ts +281 -296
- package/dist/server/api-client-core/apis/settings/multicurrency.generated.d.ts +6 -3
- package/dist/server/api-client-core/apis/settings/multicurrency.generated.js +32 -33
- package/dist/server/api-client-core/apis/settings/multicurrency.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/settings/tax-rates-types.generated.d.ts +71 -83
- package/dist/server/api-client-core/apis/settings/tax-rates.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/settings/tax-rates.generated.js +4 -3
- package/dist/server/api-client-core/apis/settings/tax-rates.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/settings/user-provisioning-types.generated.d.ts +202 -250
- package/dist/server/api-client-core/apis/settings/user-provisioning.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/settings/user-provisioning.generated.js +23 -26
- package/dist/server/api-client-core/apis/settings/user-provisioning.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/webhooks-journal-types.generated.d.ts +490 -526
- package/dist/server/api-client-core/apis/webhooks-journal.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/webhooks-journal.generated.js +65 -70
- package/dist/server/api-client-core/apis/webhooks-journal.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/webhooks-types.generated.d.ts +816 -852
- package/dist/server/api-client-core/apis/webhooks.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/webhooks.generated.js +93 -98
- package/dist/server/api-client-core/apis/webhooks.generated.js.map +1 -1
- package/dist/server/api-client-core/binary-data.js.map +1 -1
- package/dist/server/api-client-core/client.js +5 -1
- package/dist/server/api-client-core/client.js.map +1 -1
- package/dist/server/api-client-core/codegen-helpers/file-op-wrappers.js.map +1 -1
- package/dist/server/api-client-core/errors.js.map +1 -1
- package/dist/server/api-client-core/op.js.map +1 -1
- package/dist/server/api-client-core/pagination.d.ts +2 -2
- package/dist/server/api-client-core/pagination.js +2 -2
- package/dist/server/api-client-core/pagination.js.map +1 -1
- package/dist/server/api-client-core/plugins/fetch-transport.js +33 -9
- package/dist/server/api-client-core/plugins/fetch-transport.js.map +1 -1
- package/dist/server/api-client-core/types.d.ts +1 -1
- package/dist/server/api-client.d.ts +184 -184
- package/dist/server/api-client.js +89 -89
- package/dist/server/constants.js +33 -6
- package/dist/server/constants.js.map +1 -1
- package/dist/server/deno/start.js.map +1 -1
- package/dist/server/hono/hono-request-handler.js +32 -23
- package/dist/server/hono/hono-request-handler.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/auth-complete.js +158 -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 +25 -12
- package/dist/server/hono/hubspot-connect-routes/auth-init-session.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/auth-logout.js +32 -9
- package/dist/server/hono/hubspot-connect-routes/auth-logout.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/auth-refresh.js +32 -18
- package/dist/server/hono/hubspot-connect-routes/auth-refresh.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/cimd-client-metadata-types.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/cimd-public-routes.js +4 -1
- package/dist/server/hono/hubspot-connect-routes/cimd-public-routes.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/fetch-hubspot-client-metadata.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/hubspot-connect-routes.js +4 -2
- package/dist/server/hono/hubspot-connect-routes/hubspot-connect-routes.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/load-hubspot-connect-routes-env.js +5 -5
- package/dist/server/hono/hubspot-connect-routes/load-hubspot-connect-routes-env.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/oauth-client.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/utils.js +53 -6
- package/dist/server/hono/hubspot-connect-routes/utils.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/whoami.js +51 -0
- package/dist/server/hono/hubspot-connect-routes/whoami.js.map +1 -0
- package/dist/server/hono/types.d.ts +9 -10
- package/dist/server/hono/utils/cookie-utils.js +2 -1
- package/dist/server/hono/utils/cookie-utils.js.map +1 -1
- 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.map +1 -1
- package/dist/server/lovable/create-app-function-start.d.ts +1 -1
- package/dist/server/lovable/create-app-function-start.js +4 -6
- package/dist/server/lovable/create-app-function-start.js.map +1 -1
- package/dist/server/lovable/hubspot-connect/index.js.map +1 -1
- package/dist/server/lovable/hubspot-connect/run-hubspot-connect-lovable-server.js +14 -15
- package/dist/server/lovable/hubspot-connect/run-hubspot-connect-lovable-server.js.map +1 -1
- package/dist/server/sanitize-request.js +14 -11
- package/dist/server/sanitize-request.js.map +1 -1
- package/dist/server/secure-start-core.js +4 -5
- package/dist/server/secure-start-core.js.map +1 -1
- package/dist/server/shared/constants.js +22 -9
- package/dist/server/shared/constants.js.map +1 -1
- package/dist/server/shared/encoding/base64.js.map +1 -1
- package/dist/server/shared/encoding/sha256.js.map +1 -1
- package/dist/server/shared/logger.js.map +1 -1
- package/dist/server/types.d.ts +1 -35
- package/dist/server/utils/cookie-utils.js.map +1 -1
- package/dist/server/utils/dpop-utils.js.map +1 -1
- package/dist/server/utils/env-utils.js +60 -7
- package/dist/server/utils/env-utils.js.map +1 -1
- package/dist/server/utils/hubspot-dpop-auth-headers.js +38 -0
- package/dist/server/utils/hubspot-dpop-auth-headers.js.map +1 -0
- package/dist/server/utils/jwk-utils.js.map +1 -1
- package/dist/server/utils/jwt-utils.js.map +1 -1
- package/package.json +15 -21
- package/src/browser/app-connect-controller/README.md +5 -2
- package/src/browser/app-connect-controller/connect-start.test.ts +157 -0
- package/src/browser/app-connect-controller/connect-start.ts +18 -3
- package/src/browser/app-connect-controller/constants.ts +6 -4
- package/src/browser/app-connect-controller/create.ts +8 -2
- package/src/browser/app-connect-controller/disconnect.ts +5 -7
- package/src/browser/app-connect-controller/init.test.ts +275 -0
- package/src/browser/app-connect-controller/init.ts +44 -19
- package/src/browser/app-connect-controller/oauth-complete.test.ts +110 -0
- package/src/browser/app-connect-controller/oauth-complete.ts +53 -0
- package/src/browser/app-connect-controller/oauth-popup.test.ts +239 -0
- package/src/browser/app-connect-controller/oauth-popup.ts +160 -0
- package/src/browser/app-connect-controller/types.ts +3 -0
- package/src/browser/app-connect-controller/utils/iframe-utils.ts +12 -0
- package/src/browser/app-connect-controller/utils/resolve-oauth-connect-mode.test.ts +35 -0
- package/src/browser/app-connect-controller/utils/resolve-oauth-connect-mode.ts +21 -0
- package/src/browser/app-connect-controller/utils/session-utils.test.ts +73 -22
- package/src/browser/app-connect-controller/utils/session-utils.ts +74 -33
- package/src/browser/app-connect-controller/view-state.test.ts +1 -0
- package/src/browser/app-connect-controller/view-state.ts +1 -0
- package/src/browser/index.ts +1 -0
- package/src/browser/react/components/AppConnectHeader/AppConnectHeader.tsx +21 -34
- package/src/browser/react/components/ConnectButton/ConnectButton.tsx +1 -1
- package/src/browser/react/lovable/LovableHubSpotAppConnect.tsx +12 -2
- package/src/browser/types.ts +30 -5
- package/src/server/api-client-core/__tests__/errors.test.ts +309 -0
- package/src/server/api-client-core/__tests__/operation-headers.test.ts +251 -0
- package/src/server/api-client-core/apis/account/account-info-types.generated.ts +74 -88
- package/src/server/api-client-core/apis/account/account-info.generated.ts +2 -4
- package/src/server/api-client-core/apis/account/audit-logs-types.generated.ts +346 -360
- package/src/server/api-client-core/apis/account/audit-logs.generated.ts +2 -4
- package/src/server/api-client-core/apis/auth/oauth-types.generated.ts +81 -99
- package/src/server/api-client-core/apis/auth/oauth.generated.ts +1 -3
- package/src/server/api-client-core/apis/automation/actions-types.generated.ts +1162 -1188
- package/src/server/api-client-core/apis/automation/actions.generated.ts +10 -12
- package/src/server/api-client-core/apis/automation/sequences-types.generated.ts +379 -393
- package/src/server/api-client-core/apis/automation/sequences.generated.ts +1 -3
- package/src/server/api-client-core/apis/business-units-types.generated.ts +43 -59
- package/src/server/api-client-core/apis/business-units.generated.ts +9 -10
- package/src/server/api-client-core/apis/cms/authors-types.generated.ts +3823 -3853
- package/src/server/api-client-core/apis/cms/authors.generated.ts +31 -37
- package/src/server/api-client-core/apis/cms/blog-settings-types.generated.ts +3667 -3696
- package/src/server/api-client-core/apis/cms/blog-settings.generated.ts +46 -51
- package/src/server/api-client-core/apis/cms/cms-content-audit-types.generated.ts +138 -163
- package/src/server/api-client-core/apis/cms/cms-content-audit.generated.ts +2 -10
- package/src/server/api-client-core/apis/cms/domains-types.generated.ts +153 -167
- package/src/server/api-client-core/apis/cms/domains.generated.ts +2 -4
- package/src/server/api-client-core/apis/cms/hubdb-types.generated.ts +1013 -1063
- package/src/server/api-client-core/apis/cms/hubdb.generated.ts +3 -5
- package/src/server/api-client-core/apis/cms/media-bridge-types.generated.ts +8623 -8657
- package/src/server/api-client-core/apis/cms/media-bridge.generated.ts +16 -22
- package/src/server/api-client-core/apis/cms/pages-types.generated.ts +5259 -5272
- package/src/server/api-client-core/apis/cms/pages.generated.ts +262 -226
- package/src/server/api-client-core/apis/cms/posts-types.generated.ts +4420 -4438
- package/src/server/api-client-core/apis/cms/posts.generated.ts +108 -106
- package/src/server/api-client-core/apis/cms/site-search-types.generated.ts +1867 -1881
- package/src/server/api-client-core/apis/cms/site-search.generated.ts +2 -4
- package/src/server/api-client-core/apis/cms/source-code-types.generated.ts +144 -177
- package/src/server/api-client-core/apis/cms/source-code.generated.ts +15 -23
- package/src/server/api-client-core/apis/cms/tags-types.generated.ts +3820 -3845
- package/src/server/api-client-core/apis/cms/tags.generated.ts +80 -82
- package/src/server/api-client-core/apis/cms/url-mappings-types.generated.ts +188 -202
- package/src/server/api-client-core/apis/cms/url-mappings.generated.ts +2 -4
- package/src/server/api-client-core/apis/cms/url-redirects-types.generated.ts +182 -196
- package/src/server/api-client-core/apis/cms/url-redirects.generated.ts +2 -4
- package/src/server/api-client-core/apis/communication-preferences/subscriptions-types.generated.ts +810 -828
- package/src/server/api-client-core/apis/communication-preferences/subscriptions.generated.ts +66 -63
- package/src/server/api-client-core/apis/conversations/custom-channels-types.generated.ts +564 -601
- package/src/server/api-client-core/apis/conversations/custom-channels.generated.ts +90 -86
- package/src/server/api-client-core/apis/conversations/visitor-identification-types.generated.ts +31 -44
- package/src/server/api-client-core/apis/conversations/visitor-identification.generated.ts +6 -8
- package/src/server/api-client-core/apis/conversations-types.generated.ts +955 -991
- package/src/server/api-client-core/apis/conversations.generated.ts +6 -5
- package/src/server/api-client-core/apis/crm/app-uninstalls-types.generated.ts +7 -19
- package/src/server/api-client-core/apis/crm/app-uninstalls.generated.ts +2 -4
- package/src/server/api-client-core/apis/crm/appointments-types.generated.ts +965 -969
- package/src/server/api-client-core/apis/crm/appointments.generated.ts +143 -137
- package/src/server/api-client-core/apis/crm/associations-schema-types.generated.ts +292 -322
- package/src/server/api-client-core/apis/crm/associations-schema.generated.ts +17 -19
- package/src/server/api-client-core/apis/crm/associations-types.generated.ts +657 -675
- package/src/server/api-client-core/apis/crm/associations.generated.ts +70 -70
- package/src/server/api-client-core/apis/crm/calling-extensions-types.generated.ts +417 -441
- package/src/server/api-client-core/apis/crm/calling-extensions.generated.ts +62 -69
- package/src/server/api-client-core/apis/crm/calls-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/calls.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/carts-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/carts.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/commerce-payments-types.generated.ts +847 -856
- package/src/server/api-client-core/apis/crm/commerce-payments.generated.ts +73 -73
- package/src/server/api-client-core/apis/crm/commerce-subscriptions-types.generated.ts +844 -853
- package/src/server/api-client-core/apis/crm/commerce-subscriptions.generated.ts +50 -51
- package/src/server/api-client-core/apis/crm/communications-types.generated.ts +846 -856
- package/src/server/api-client-core/apis/crm/communications.generated.ts +73 -73
- package/src/server/api-client-core/apis/crm/companies-types.generated.ts +859 -885
- package/src/server/api-client-core/apis/crm/companies.generated.ts +44 -50
- package/src/server/api-client-core/apis/crm/contacts-types.generated.ts +875 -907
- package/src/server/api-client-core/apis/crm/contacts.generated.ts +46 -52
- package/src/server/api-client-core/apis/crm/contracts-types.generated.ts +894 -862
- package/src/server/api-client-core/apis/crm/contracts.generated.ts +66 -56
- package/src/server/api-client-core/apis/crm/courses-types.generated.ts +842 -859
- package/src/server/api-client-core/apis/crm/courses.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/crm-owners-types.generated.ts +102 -115
- package/src/server/api-client-core/apis/crm/crm-owners.generated.ts +2 -4
- package/src/server/api-client-core/apis/crm/custom-objects-types.generated.ts +900 -915
- package/src/server/api-client-core/apis/crm/custom-objects.generated.ts +128 -126
- package/src/server/api-client-core/apis/crm/deal-splits-types.generated.ts +157 -170
- package/src/server/api-client-core/apis/crm/deal-splits.generated.ts +2 -4
- package/src/server/api-client-core/apis/crm/deals-types.generated.ts +858 -875
- package/src/server/api-client-core/apis/crm/deals.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/discounts-types.generated.ts +842 -855
- package/src/server/api-client-core/apis/crm/discounts.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/emails-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/emails.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/exports-types.generated.ts +284 -314
- package/src/server/api-client-core/apis/crm/exports.generated.ts +6 -11
- package/src/server/api-client-core/apis/crm/feedback-submissions-types.generated.ts +607 -622
- package/src/server/api-client-core/apis/crm/feedback-submissions.generated.ts +84 -80
- package/src/server/api-client-core/apis/crm/fees-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/fees.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/goal-targets-types.generated.ts +845 -856
- package/src/server/api-client-core/apis/crm/goal-targets.generated.ts +50 -51
- package/src/server/api-client-core/apis/crm/imports-types.generated.ts +663 -692
- package/src/server/api-client-core/apis/crm/imports.generated.ts +2 -7
- package/src/server/api-client-core/apis/crm/invoices-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/invoices.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/leads-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/leads.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/limits-tracking-types.generated.ts +263 -275
- package/src/server/api-client-core/apis/crm/limits-tracking.generated.ts +2 -4
- package/src/server/api-client-core/apis/crm/line-items-types.generated.ts +843 -856
- package/src/server/api-client-core/apis/crm/line-items.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/listings-types.generated.ts +842 -859
- package/src/server/api-client-core/apis/crm/listings.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/lists-types.generated.ts +2794 -2845
- package/src/server/api-client-core/apis/crm/lists.generated.ts +8 -20
- package/src/server/api-client-core/apis/crm/meetings-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/meetings.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/notes-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/notes.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/object-library-types.generated.ts +26 -39
- package/src/server/api-client-core/apis/crm/object-library.generated.ts +2 -4
- package/src/server/api-client-core/apis/crm/objects-types.generated.ts +688 -716
- package/src/server/api-client-core/apis/crm/objects.generated.ts +79 -83
- package/src/server/api-client-core/apis/crm/orders-types.generated.ts +829 -846
- package/src/server/api-client-core/apis/crm/orders.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/partner-clients-types.generated.ts +721 -735
- package/src/server/api-client-core/apis/crm/partner-clients.generated.ts +60 -60
- package/src/server/api-client-core/apis/crm/partner-services-types.generated.ts +720 -734
- package/src/server/api-client-core/apis/crm/partner-services.generated.ts +60 -60
- package/src/server/api-client-core/apis/crm/pipelines-types.generated.ts +366 -388
- package/src/server/api-client-core/apis/crm/pipelines.generated.ts +2 -4
- package/src/server/api-client-core/apis/crm/postal-mail-types.generated.ts +830 -843
- package/src/server/api-client-core/apis/crm/postal-mail.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/products-types.generated.ts +829 -846
- package/src/server/api-client-core/apis/crm/products.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/projects-types.generated.ts +845 -875
- package/src/server/api-client-core/apis/crm/projects.generated.ts +47 -53
- package/src/server/api-client-core/apis/crm/properties-types.generated.ts +623 -626
- package/src/server/api-client-core/apis/crm/properties.generated.ts +33 -28
- package/src/server/api-client-core/apis/crm/property-validations-types.generated.ts +160 -174
- package/src/server/api-client-core/apis/crm/property-validations.generated.ts +2 -6
- package/src/server/api-client-core/apis/crm/public-app-crm-cards-types.generated.ts +467 -494
- package/src/server/api-client-core/apis/crm/public-app-crm-cards.generated.ts +7 -15
- package/src/server/api-client-core/apis/crm/public-app-feature-flags-types.generated.ts +166 -177
- package/src/server/api-client-core/apis/crm/public-app-feature-flags.generated.ts +6 -8
- package/src/server/api-client-core/apis/crm/quotes-types.generated.ts +829 -846
- package/src/server/api-client-core/apis/crm/quotes.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/schemas-types.generated.ts +613 -640
- package/src/server/api-client-core/apis/crm/schemas.generated.ts +8 -14
- package/src/server/api-client-core/apis/crm/services-types.generated.ts +832 -849
- package/src/server/api-client-core/apis/crm/services.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/tasks-types.generated.ts +829 -846
- package/src/server/api-client-core/apis/crm/tasks.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/taxes-types.generated.ts +829 -846
- package/src/server/api-client-core/apis/crm/taxes.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/tickets-types.generated.ts +848 -878
- package/src/server/api-client-core/apis/crm/tickets.generated.ts +47 -53
- package/src/server/api-client-core/apis/crm/timeline-types.generated.ts +144 -161
- package/src/server/api-client-core/apis/crm/timeline.generated.ts +6 -8
- package/src/server/api-client-core/apis/crm/transcriptions-types.generated.ts +149 -164
- package/src/server/api-client-core/apis/crm/transcriptions.generated.ts +22 -22
- package/src/server/api-client-core/apis/crm/users-types.generated.ts +829 -846
- package/src/server/api-client-core/apis/crm/users.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/video-conferencing-extension-types.generated.ts +29 -42
- package/src/server/api-client-core/apis/crm/video-conferencing-extension.generated.ts +17 -19
- package/src/server/api-client-core/apis/events/manage-event-definitions-types.generated.ts +1509 -1558
- package/src/server/api-client-core/apis/events/manage-event-definitions.generated.ts +55 -65
- package/src/server/api-client-core/apis/events/send-event-completions-types.generated.ts +51 -68
- package/src/server/api-client-core/apis/events/send-event-completions.generated.ts +10 -10
- package/src/server/api-client-core/apis/events-types.generated.ts +97 -110
- package/src/server/api-client-core/apis/events.generated.ts +2 -4
- package/src/server/api-client-core/apis/files-types.generated.ts +727 -757
- package/src/server/api-client-core/apis/files.generated.ts +3 -5
- package/src/server/api-client-core/apis/marketing/campaigns-public-api-types.generated.ts +1221 -1234
- package/src/server/api-client-core/apis/marketing/campaigns-public-api.generated.ts +45 -47
- package/src/server/api-client-core/apis/marketing/marketing-emails-types.generated.ts +3704 -3733
- package/src/server/api-client-core/apis/marketing/marketing-emails.generated.ts +44 -52
- package/src/server/api-client-core/apis/marketing/marketing-events-types.generated.ts +1787 -1848
- package/src/server/api-client-core/apis/marketing/marketing-events.generated.ts +236 -241
- package/src/server/api-client-core/apis/marketing/single-send-types.generated.ts +142 -155
- package/src/server/api-client-core/apis/marketing/single-send.generated.ts +2 -6
- package/src/server/api-client-core/apis/marketing/transactional-single-send-types.generated.ts +253 -269
- package/src/server/api-client-core/apis/marketing/transactional-single-send.generated.ts +32 -31
- package/src/server/api-client-core/apis/meta/origins-types.generated.ts +40 -56
- package/src/server/api-client-core/apis/meta/origins.generated.ts +2 -4
- package/src/server/api-client-core/apis/scheduler/meetings-types.generated.ts +1001 -1014
- package/src/server/api-client-core/apis/scheduler/meetings.generated.ts +6 -8
- package/src/server/api-client-core/apis/settings/multicurrency-types.generated.ts +1906 -1912
- package/src/server/api-client-core/apis/settings/multicurrency.generated.ts +64 -63
- package/src/server/api-client-core/apis/settings/tax-rates-types.generated.ts +71 -85
- package/src/server/api-client-core/apis/settings/tax-rates.generated.ts +2 -4
- package/src/server/api-client-core/apis/settings/user-provisioning-types.generated.ts +207 -257
- package/src/server/api-client-core/apis/settings/user-provisioning.generated.ts +8 -24
- package/src/server/api-client-core/apis/webhooks-journal-types.generated.ts +740 -771
- package/src/server/api-client-core/apis/webhooks-journal.generated.ts +47 -59
- package/src/server/api-client-core/apis/webhooks-types.generated.ts +1194 -1228
- package/src/server/api-client-core/apis/webhooks.generated.ts +52 -64
- package/src/server/api-client-core/client.ts +5 -1
- package/src/server/api-client-core/pagination.ts +2 -2
- package/src/server/api-client-core/plugins/fetch-transport.ts +70 -12
- package/src/server/api-client-core/types.ts +1 -1
- package/src/server/constants.ts +29 -4
- package/src/server/hono/hono-request-handler.ts +68 -27
- package/src/server/hono/hubspot-connect-routes/auth-complete.test.ts +394 -0
- package/src/server/hono/hubspot-connect-routes/{auth-callback.ts → auth-complete.ts} +81 -30
- package/src/server/hono/hubspot-connect-routes/auth-init-session.test.ts +114 -30
- package/src/server/hono/hubspot-connect-routes/auth-init-session.ts +35 -10
- package/src/server/hono/hubspot-connect-routes/auth-logout.test.ts +13 -0
- package/src/server/hono/hubspot-connect-routes/auth-logout.ts +39 -10
- package/src/server/hono/hubspot-connect-routes/auth-refresh.test.ts +6 -0
- package/src/server/hono/hubspot-connect-routes/auth-refresh.ts +24 -9
- package/src/server/hono/hubspot-connect-routes/cimd-public-routes.test.ts +7 -6
- package/src/server/hono/hubspot-connect-routes/cimd-public-routes.ts +5 -1
- package/src/server/hono/hubspot-connect-routes/hubspot-connect-routes.ts +11 -3
- 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/hono/hubspot-connect-routes/utils.test.ts +16 -46
- package/src/server/hono/hubspot-connect-routes/utils.ts +61 -5
- package/src/server/hono/hubspot-connect-routes/whoami.ts +74 -0
- package/src/server/hono/types.ts +11 -10
- package/src/server/hono/utils/cookie-utils.ts +27 -2
- package/src/server/hono/utils/cors-middleware.test.ts +80 -0
- package/src/server/hono/utils/cors-middleware.ts +95 -0
- package/src/server/lovable/create-app-function-start.ts +4 -7
- package/src/server/lovable/hubspot-connect/run-hubspot-connect-lovable-server.ts +21 -16
- package/src/server/sanitize-request.ts +15 -12
- package/src/server/secure-start-core.ts +7 -6
- package/src/server/types.ts +2 -38
- package/src/server/utils/env-utils.test.ts +140 -12
- package/src/server/utils/env-utils.ts +80 -6
- package/src/server/utils/hubspot-dpop-auth-headers.test.ts +43 -0
- package/src/server/utils/hubspot-dpop-auth-headers.ts +48 -0
- package/src/shared/constants.ts +40 -3
- package/src/shared/wire-types.ts +49 -0
- package/dist/browser/HubSpotAppConnect-BW45gyDs.js.map +0 -1
- package/dist/browser/create-vctOhpX9.js.map +0 -1
- package/dist/server/hono/hubspot-connect-routes/auth-callback.js +0 -125
- package/dist/server/hono/hubspot-connect-routes/auth-callback.js.map +0 -1
- package/dist/server/proxy.js +0 -68
- package/dist/server/proxy.js.map +0 -1
- package/src/server/hono/hubspot-connect-routes/auth-callback.test.ts +0 -225
- package/src/server/proxy.test.ts +0 -80
- package/src/server/proxy.ts +0 -116
|
@@ -2,1726 +2,1445 @@
|
|
|
2
2
|
|
|
3
3
|
import type { Operation } from '../../types.ts';
|
|
4
4
|
|
|
5
|
-
export namespace
|
|
6
|
-
export
|
|
7
|
-
|
|
5
|
+
export namespace MarketingMarketingEventsSchemas {
|
|
6
|
+
export interface AppInfo {
|
|
7
|
+
/**
|
|
8
|
+
* The ID of the application
|
|
9
|
+
*/
|
|
10
|
+
id: string;
|
|
11
|
+
/**
|
|
12
|
+
* The name of the application
|
|
13
|
+
*/
|
|
14
|
+
name: string;
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
export interface AttendanceCounters {
|
|
18
|
+
/**
|
|
19
|
+
* Number of attended contact records of a marketing event
|
|
20
|
+
*/
|
|
21
|
+
attended: number;
|
|
22
|
+
/**
|
|
23
|
+
* Number of cancelled contact records of a marketing event
|
|
24
|
+
*/
|
|
25
|
+
cancelled: number;
|
|
26
|
+
/**
|
|
27
|
+
* Number of no-show contact records of a marketing event
|
|
28
|
+
*/
|
|
29
|
+
noShows: number;
|
|
30
|
+
/**
|
|
31
|
+
* Number of registered contact records of a marketing event
|
|
32
|
+
*/
|
|
33
|
+
registered: number;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
export interface BatchInputMarketingEventCreateRequestParams {
|
|
37
|
+
inputs: MarketingEventCreateRequestParams[];
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
export interface BatchInputMarketingEventEmailSubscriber {
|
|
41
|
+
/**
|
|
42
|
+
* List of marketing event details to create or update
|
|
43
|
+
*/
|
|
44
|
+
inputs: MarketingEventEmailSubscriber[];
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
export interface BatchInputMarketingEventExternalUniqueIdentifier {
|
|
48
|
+
inputs: MarketingEventExternalUniqueIdentifier[];
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
export interface BatchInputMarketingEventPublicObjectIdDeleteRequest {
|
|
52
|
+
inputs: MarketingEventPublicObjectIdDeleteRequest[];
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
export interface BatchInputMarketingEventPublicUpdateRequestFullV2 {
|
|
56
|
+
inputs: MarketingEventPublicUpdateRequestFullV2[];
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
export interface BatchInputMarketingEventSubscriber {
|
|
60
|
+
/**
|
|
61
|
+
* List of HubSpot contacts to subscribe to the marketing event
|
|
62
|
+
*/
|
|
63
|
+
inputs: MarketingEventSubscriber[];
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
export interface BatchResponseMarketingEventPublicDefaultResponse {
|
|
67
|
+
/**
|
|
68
|
+
* Timestamp of when the request was completed.
|
|
69
|
+
*/
|
|
70
|
+
completedAt: string;
|
|
71
|
+
errors?: StandardError[];
|
|
72
|
+
/**
|
|
73
|
+
* Result of the request.
|
|
74
|
+
*/
|
|
75
|
+
links?: Record<string, string>;
|
|
76
|
+
/**
|
|
77
|
+
* The number of errors that occurred during the request.
|
|
78
|
+
*/
|
|
79
|
+
numErrors?: number;
|
|
80
|
+
/**
|
|
81
|
+
* Timestamp of when the request was sent.
|
|
82
|
+
*/
|
|
83
|
+
requestedAt?: string;
|
|
84
|
+
results: MarketingEventPublicDefaultResponse[];
|
|
85
|
+
/**
|
|
86
|
+
* Timestamp of when the request started processing.
|
|
87
|
+
*/
|
|
88
|
+
startedAt: string;
|
|
89
|
+
/**
|
|
90
|
+
* Status of the response.
|
|
91
|
+
*/
|
|
92
|
+
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
export interface BatchResponseMarketingEventPublicDefaultResponseV2 {
|
|
96
|
+
/**
|
|
97
|
+
* Timestamp of when the request was processed.
|
|
98
|
+
*/
|
|
99
|
+
completedAt: string;
|
|
100
|
+
/**
|
|
101
|
+
* Result object of the request.
|
|
102
|
+
*/
|
|
103
|
+
links?: Record<string, string>;
|
|
104
|
+
/**
|
|
105
|
+
* Timestamp of when the request was sent.
|
|
106
|
+
*/
|
|
107
|
+
requestedAt?: string;
|
|
108
|
+
results: MarketingEventPublicDefaultResponseV2[];
|
|
109
|
+
/**
|
|
110
|
+
* Timestamp of when the request started processing.
|
|
111
|
+
*/
|
|
112
|
+
startedAt: string;
|
|
113
|
+
/**
|
|
114
|
+
* The status of the response.
|
|
115
|
+
*/
|
|
116
|
+
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
export interface BatchResponseSubscriberEmailResponse {
|
|
120
|
+
/**
|
|
121
|
+
* Timestamp that represents when the request finished processing
|
|
122
|
+
*/
|
|
123
|
+
completedAt: string;
|
|
124
|
+
errors?: StandardError[];
|
|
125
|
+
/**
|
|
126
|
+
* Result of the request
|
|
127
|
+
*/
|
|
128
|
+
links?: Record<string, string>;
|
|
129
|
+
/**
|
|
130
|
+
* The number of errors that occurred during the processing
|
|
131
|
+
*/
|
|
132
|
+
numErrors?: number;
|
|
133
|
+
/**
|
|
134
|
+
* Timestamp that represents when the request was made
|
|
135
|
+
*/
|
|
136
|
+
requestedAt?: string;
|
|
137
|
+
results: SubscriberEmailResponse[];
|
|
138
|
+
/**
|
|
139
|
+
* Timestamp that represents when the request started processing
|
|
140
|
+
*/
|
|
141
|
+
startedAt: string;
|
|
142
|
+
/**
|
|
143
|
+
* The status of the request processing
|
|
144
|
+
*/
|
|
145
|
+
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
146
|
+
}
|
|
147
|
+
|
|
148
|
+
export interface BatchResponseSubscriberVidResponse {
|
|
149
|
+
/**
|
|
150
|
+
* Timestamp that represents when the request finished processing
|
|
151
|
+
*/
|
|
152
|
+
completedAt: string;
|
|
153
|
+
errors?: StandardError[];
|
|
154
|
+
/**
|
|
155
|
+
* Result of the request
|
|
156
|
+
*/
|
|
157
|
+
links?: Record<string, string>;
|
|
158
|
+
/**
|
|
159
|
+
* The number of errors that occurred during the processing
|
|
160
|
+
*/
|
|
161
|
+
numErrors?: number;
|
|
162
|
+
/**
|
|
163
|
+
* Timestamp that represents when the request was made
|
|
164
|
+
*/
|
|
165
|
+
requestedAt?: string;
|
|
166
|
+
results: SubscriberVidResponse[];
|
|
167
|
+
/**
|
|
168
|
+
* Timestamp that represents when the request started processing
|
|
169
|
+
*/
|
|
170
|
+
startedAt: string;
|
|
171
|
+
/**
|
|
172
|
+
* The status of the request processing
|
|
173
|
+
*/
|
|
174
|
+
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
export interface CollectionResponseMarketingEventPublicReadResponseV2ForwardPaging {
|
|
178
|
+
paging?: ForwardPaging;
|
|
179
|
+
results: MarketingEventPublicReadResponseV2[];
|
|
180
|
+
}
|
|
181
|
+
|
|
182
|
+
export interface CollectionResponseSearchPublicResponseWrapperNoPaging {
|
|
183
|
+
results: SearchPublicResponseWrapper[];
|
|
184
|
+
}
|
|
185
|
+
|
|
186
|
+
export interface CollectionResponseWithTotalMarketingEventIdentifiersResponse {
|
|
187
|
+
paging?: Paging;
|
|
188
|
+
results: MarketingEventIdentifiersResponse[];
|
|
189
|
+
total: number;
|
|
190
|
+
}
|
|
191
|
+
|
|
192
|
+
export interface CollectionResponseWithTotalParticipationBreakdown {
|
|
193
|
+
paging?: Paging;
|
|
194
|
+
results: ParticipationBreakdown[];
|
|
195
|
+
total: number;
|
|
196
|
+
}
|
|
197
|
+
|
|
198
|
+
export interface CollectionResponseWithTotalPublicList {
|
|
199
|
+
paging?: Paging;
|
|
200
|
+
results: PublicList[];
|
|
201
|
+
total: number;
|
|
202
|
+
}
|
|
203
|
+
|
|
204
|
+
export interface ContactAssociation {
|
|
205
|
+
/**
|
|
206
|
+
* The internal ID of the contact in HubSpot
|
|
207
|
+
*/
|
|
208
|
+
contactId: string;
|
|
209
|
+
/**
|
|
210
|
+
* The email of the contact in HubSpot
|
|
211
|
+
*/
|
|
212
|
+
email: string;
|
|
213
|
+
/**
|
|
214
|
+
* The first name of the contact in HubSpot
|
|
215
|
+
*/
|
|
216
|
+
firstname?: string;
|
|
217
|
+
/**
|
|
218
|
+
* The last name of the contact in HubSpot
|
|
219
|
+
*/
|
|
220
|
+
lastname?: string;
|
|
221
|
+
}
|
|
222
|
+
|
|
223
|
+
export interface CrmPropertyWrapper {
|
|
224
|
+
/**
|
|
225
|
+
* The name of the property in the CRM
|
|
226
|
+
*/
|
|
227
|
+
name: string;
|
|
228
|
+
/**
|
|
229
|
+
* The value of the property in the CRM
|
|
230
|
+
*/
|
|
231
|
+
value: string;
|
|
232
|
+
}
|
|
233
|
+
|
|
234
|
+
export interface ErrorDetail {
|
|
235
|
+
/**
|
|
236
|
+
* The status code associated with the error detail
|
|
237
|
+
*/
|
|
238
|
+
code?: string;
|
|
239
|
+
/**
|
|
240
|
+
* Context about the error condition
|
|
241
|
+
*/
|
|
242
|
+
context?: Record<string, string[]>;
|
|
243
|
+
/**
|
|
244
|
+
* The name of the field or parameter in which the error was found.
|
|
245
|
+
*/
|
|
246
|
+
in?: string;
|
|
247
|
+
/**
|
|
248
|
+
* A human readable message describing the error along with remediation steps where appropriate
|
|
249
|
+
*/
|
|
250
|
+
message: string;
|
|
251
|
+
/**
|
|
252
|
+
* A specific category that contains more specific detail about the error
|
|
253
|
+
*/
|
|
254
|
+
subCategory?: string;
|
|
255
|
+
}
|
|
256
|
+
|
|
257
|
+
export interface EventDetailSettings {
|
|
258
|
+
/**
|
|
259
|
+
* The id of the application the settings are for
|
|
260
|
+
*/
|
|
261
|
+
appId: number;
|
|
262
|
+
/**
|
|
263
|
+
* The url that will be used to fetch marketing event details by id
|
|
264
|
+
*/
|
|
265
|
+
eventDetailsUrl: string;
|
|
266
|
+
}
|
|
267
|
+
|
|
268
|
+
export interface EventDetailSettingsUrl {
|
|
269
|
+
/**
|
|
270
|
+
* The url that will be used to fetch marketing event details by id. Must contain a `%s` character sequence that will be substituted with the event id. For example: `https://my.event.app/events/%s`
|
|
271
|
+
*/
|
|
272
|
+
eventDetailsUrl: string;
|
|
273
|
+
}
|
|
274
|
+
|
|
275
|
+
export interface ForwardPaging {
|
|
276
|
+
next?: NextPage;
|
|
277
|
+
}
|
|
278
|
+
|
|
279
|
+
export interface MarketingEventAssociation {
|
|
280
|
+
/**
|
|
281
|
+
* The account ID that is associated with this marketing event in the external event application
|
|
282
|
+
*/
|
|
283
|
+
externalAccountId?: string;
|
|
284
|
+
/**
|
|
285
|
+
* The event ID that is associated with this marketing event in the external event application
|
|
286
|
+
*/
|
|
287
|
+
externalEventId?: string;
|
|
288
|
+
/**
|
|
289
|
+
* The internal ID of the marketing event in HubSpot
|
|
290
|
+
*/
|
|
291
|
+
marketingEventId: string;
|
|
292
|
+
/**
|
|
293
|
+
* The name of the marketing event in HubSpot
|
|
294
|
+
*/
|
|
295
|
+
name: string;
|
|
296
|
+
}
|
|
297
|
+
|
|
298
|
+
export interface MarketingEventCompleteRequestParams {
|
|
299
|
+
/**
|
|
300
|
+
* The end date and time of the marketing event in ISO 8601 format
|
|
301
|
+
*/
|
|
302
|
+
endDateTime: string;
|
|
303
|
+
/**
|
|
304
|
+
* The start date and time of the marketing event in ISO 8601 format
|
|
305
|
+
*/
|
|
306
|
+
startDateTime: string;
|
|
307
|
+
}
|
|
308
|
+
|
|
309
|
+
export interface MarketingEventCreateRequestParams {
|
|
310
|
+
/**
|
|
311
|
+
* A list of PropertyValues. These can be whatever kind of property names and values you want. However, they must already exist on the HubSpot account's definition of the MarketingEvent Object. If they don't they will be filtered out and not set.
|
|
312
|
+
* In order to do this you'll need to create a new PropertyGroup on the HubSpot account's MarketingEvent object for your specific app and create the Custom Property you want to track on that HubSpot account. Do not create any new default properties on the MarketingEvent object as that will apply to all HubSpot accounts.
|
|
313
|
+
*
|
|
314
|
+
*/
|
|
315
|
+
customProperties: PropertyValue[];
|
|
316
|
+
/**
|
|
317
|
+
* The end date and time of the marketing event.
|
|
318
|
+
*/
|
|
319
|
+
endDateTime?: string;
|
|
320
|
+
/**
|
|
321
|
+
* Indicates if the marketing event has been cancelled. Defaults to `false`
|
|
322
|
+
*/
|
|
323
|
+
eventCancelled?: boolean;
|
|
324
|
+
/**
|
|
325
|
+
* Indicates if the marketing event has been completed. Defaults to `false`
|
|
326
|
+
*/
|
|
327
|
+
eventCompleted?: boolean;
|
|
328
|
+
/**
|
|
329
|
+
* The description of the marketing event.
|
|
330
|
+
*/
|
|
331
|
+
eventDescription?: string;
|
|
332
|
+
/**
|
|
333
|
+
* The name of the marketing event.
|
|
334
|
+
*/
|
|
335
|
+
eventName: string;
|
|
336
|
+
/**
|
|
337
|
+
* The name of the organizer of the marketing event.
|
|
338
|
+
*/
|
|
339
|
+
eventOrganizer: string;
|
|
340
|
+
/**
|
|
341
|
+
* Describes what type of event this is. For example: `WEBINAR`, `CONFERENCE`, `WORKSHOP`
|
|
342
|
+
*/
|
|
343
|
+
eventType?: string;
|
|
344
|
+
/**
|
|
345
|
+
* A URL in the external event application where the marketing event can be managed.
|
|
346
|
+
*/
|
|
347
|
+
eventUrl?: string;
|
|
348
|
+
/**
|
|
349
|
+
* The accountId that is associated with this marketing event in the external event application.
|
|
350
|
+
*/
|
|
351
|
+
externalAccountId: string;
|
|
352
|
+
/**
|
|
353
|
+
* The id of the marketing event in the external event application.
|
|
354
|
+
*/
|
|
355
|
+
externalEventId: string;
|
|
356
|
+
/**
|
|
357
|
+
* The start date and time of the marketing event.
|
|
358
|
+
*/
|
|
359
|
+
startDateTime?: string;
|
|
360
|
+
}
|
|
361
|
+
|
|
362
|
+
export interface MarketingEventDefaultResponse {
|
|
363
|
+
/**
|
|
364
|
+
* A list of PropertyValues. These can be whatever kind of property names and values you want. However, they must already exist on the HubSpot account's definition of the MarketingEvent Object. If they don't they will be filtered out and not set.
|
|
365
|
+
* In order to do this you'll need to create a new PropertyGroup on the HubSpot account's MarketingEvent object for your specific app and create the Custom Property you want to track on that HubSpot account. Do not create any new default properties on the MarketingEvent object as that will apply to all HubSpot accounts.
|
|
366
|
+
*
|
|
367
|
+
*/
|
|
368
|
+
customProperties: PropertyValue[];
|
|
369
|
+
/**
|
|
370
|
+
* The end date and time of the marketing event.
|
|
371
|
+
*/
|
|
372
|
+
endDateTime?: string;
|
|
373
|
+
/**
|
|
374
|
+
* Indicates if the marketing event has been cancelled.
|
|
375
|
+
*/
|
|
376
|
+
eventCancelled?: boolean;
|
|
377
|
+
/**
|
|
378
|
+
* Indicates if the marketing event has been completed.
|
|
379
|
+
*/
|
|
380
|
+
eventCompleted?: boolean;
|
|
381
|
+
/**
|
|
382
|
+
* The description of the marketing event.
|
|
383
|
+
*/
|
|
384
|
+
eventDescription?: string;
|
|
385
|
+
/**
|
|
386
|
+
* The name of the marketing event.
|
|
387
|
+
*/
|
|
388
|
+
eventName: string;
|
|
389
|
+
/**
|
|
390
|
+
* The name of the organizer of the marketing event.
|
|
391
|
+
*/
|
|
392
|
+
eventOrganizer: string;
|
|
393
|
+
/**
|
|
394
|
+
* The type of the marketing event.
|
|
395
|
+
*/
|
|
396
|
+
eventType?: string;
|
|
397
|
+
/**
|
|
398
|
+
* The URL in the external event application where the marketing event can be managed.
|
|
399
|
+
*/
|
|
400
|
+
eventUrl?: string;
|
|
401
|
+
/**
|
|
402
|
+
* The ID of the marketing event CRM object
|
|
403
|
+
*/
|
|
404
|
+
objectId?: string;
|
|
405
|
+
/**
|
|
406
|
+
* The start date and time of the marketing event.
|
|
407
|
+
*/
|
|
408
|
+
startDateTime?: string;
|
|
409
|
+
}
|
|
410
|
+
|
|
411
|
+
export interface MarketingEventEmailSubscriber {
|
|
412
|
+
/**
|
|
413
|
+
* The key-value set that contains properties of the contact.
|
|
414
|
+
*/
|
|
415
|
+
contactProperties: Record<string, string>;
|
|
416
|
+
/**
|
|
417
|
+
* The email address of the contact in HubSpot to associate with the event.
|
|
418
|
+
*/
|
|
419
|
+
email: string;
|
|
420
|
+
/**
|
|
421
|
+
* Timestamp in milliseconds at which the contact subscribed to the event.
|
|
422
|
+
*/
|
|
423
|
+
interactionDateTime: number;
|
|
424
|
+
/**
|
|
425
|
+
* The key-value set that contains properties of the marketing event.
|
|
426
|
+
*/
|
|
427
|
+
properties: Record<string, string>;
|
|
428
|
+
}
|
|
429
|
+
|
|
430
|
+
export interface MarketingEventExternalUniqueIdentifier {
|
|
431
|
+
/**
|
|
432
|
+
* The id of the application that created the marketing event in HubSpot.
|
|
433
|
+
*/
|
|
434
|
+
appId: number;
|
|
435
|
+
/**
|
|
436
|
+
* The accountId that is associated with this marketing event in the external event application.
|
|
437
|
+
*/
|
|
438
|
+
externalAccountId: string;
|
|
439
|
+
/**
|
|
440
|
+
* The id of the marketing event in the external event application.
|
|
441
|
+
*/
|
|
442
|
+
externalEventId: string;
|
|
443
|
+
}
|
|
444
|
+
|
|
445
|
+
export interface MarketingEventIdentifiersResponse {
|
|
446
|
+
appInfo?: AppInfo;
|
|
447
|
+
/**
|
|
448
|
+
* The accountId that is associated with this marketing event in the external event application
|
|
449
|
+
*/
|
|
450
|
+
externalAccountId?: string;
|
|
451
|
+
/**
|
|
452
|
+
* The ID that is associated with this marketing event in the external event application
|
|
453
|
+
*/
|
|
454
|
+
externalEventId: string;
|
|
455
|
+
/**
|
|
456
|
+
* The name of the marketing event
|
|
457
|
+
*/
|
|
458
|
+
marketingEventName: string;
|
|
459
|
+
/**
|
|
460
|
+
* The internal ID of the marketing event in HubSpot CRM
|
|
461
|
+
*/
|
|
462
|
+
objectId: string;
|
|
463
|
+
}
|
|
464
|
+
|
|
465
|
+
export interface MarketingEventPublicDefaultResponse {
|
|
466
|
+
/**
|
|
467
|
+
* The creation date and time of the marketing event.
|
|
468
|
+
*/
|
|
469
|
+
createdAt: string;
|
|
470
|
+
/**
|
|
471
|
+
* A list of PropertyValues. These can be whatever kind of property names and values you want. However, they must already exist on the HubSpot account's definition of the MarketingEvent Object. If they don't they will be filtered out and not set.
|
|
472
|
+
* In order to do this you'll need to create a new PropertyGroup on the HubSpot account's MarketingEvent object for your specific app and create the Custom Property you want to track on that HubSpot account. Do not create any new default properties on the MarketingEvent object as that will apply to all HubSpot accounts.
|
|
473
|
+
*
|
|
474
|
+
*/
|
|
475
|
+
customProperties: PropertyValue[];
|
|
476
|
+
/**
|
|
477
|
+
* The end date and time of the marketing event.
|
|
478
|
+
*/
|
|
479
|
+
endDateTime?: string;
|
|
480
|
+
/**
|
|
481
|
+
* Indicates if the marketing event has been cancelled.
|
|
482
|
+
*/
|
|
483
|
+
eventCancelled?: boolean;
|
|
484
|
+
/**
|
|
485
|
+
* Indicates if the marketing event has been completed.
|
|
486
|
+
*/
|
|
487
|
+
eventCompleted?: boolean;
|
|
488
|
+
/**
|
|
489
|
+
* The description of the marketing event.
|
|
490
|
+
*/
|
|
491
|
+
eventDescription?: string;
|
|
492
|
+
/**
|
|
493
|
+
* The name of the marketing event.
|
|
494
|
+
*/
|
|
495
|
+
eventName: string;
|
|
496
|
+
/**
|
|
497
|
+
* The name of the organizer of the marketing event.
|
|
498
|
+
*/
|
|
499
|
+
eventOrganizer: string;
|
|
500
|
+
/**
|
|
501
|
+
* The type of the marketing event.
|
|
502
|
+
*/
|
|
503
|
+
eventType?: string;
|
|
504
|
+
/**
|
|
505
|
+
* A URL in the external event application where the marketing event can be managed.
|
|
506
|
+
*/
|
|
507
|
+
eventUrl?: string;
|
|
508
|
+
/**
|
|
509
|
+
* The ID of the marketing event CRM object.
|
|
510
|
+
*/
|
|
511
|
+
id: string;
|
|
512
|
+
/**
|
|
513
|
+
* The ID of the marketing event CRM object.
|
|
514
|
+
*/
|
|
515
|
+
objectId?: string;
|
|
516
|
+
/**
|
|
517
|
+
* The start date and time of the marketing event.
|
|
518
|
+
*/
|
|
519
|
+
startDateTime?: string;
|
|
520
|
+
/**
|
|
521
|
+
* The update date and time of the marketing event.
|
|
522
|
+
*/
|
|
523
|
+
updatedAt: string;
|
|
524
|
+
}
|
|
525
|
+
|
|
526
|
+
export interface MarketingEventPublicDefaultResponseV2 {
|
|
527
|
+
appInfo?: AppInfo;
|
|
528
|
+
/**
|
|
529
|
+
* The creation date and time of the marketing event
|
|
530
|
+
*/
|
|
531
|
+
createdAt: string;
|
|
532
|
+
customProperties: CrmPropertyWrapper[];
|
|
533
|
+
/**
|
|
534
|
+
* The end date and time of the marketing event
|
|
535
|
+
*/
|
|
536
|
+
endDateTime?: string;
|
|
537
|
+
/**
|
|
538
|
+
* Indicates if the marketing event has been cancelled
|
|
539
|
+
*/
|
|
540
|
+
eventCancelled?: boolean;
|
|
541
|
+
/**
|
|
542
|
+
* Indicates if the marketing event has been completed
|
|
543
|
+
*/
|
|
544
|
+
eventCompleted?: boolean;
|
|
545
|
+
/**
|
|
546
|
+
* The description of the marketing event
|
|
547
|
+
*/
|
|
548
|
+
eventDescription?: string;
|
|
549
|
+
/**
|
|
550
|
+
* The name of the marketing event
|
|
551
|
+
*/
|
|
552
|
+
eventName: string;
|
|
553
|
+
/**
|
|
554
|
+
* The name of the organizer of the marketing event
|
|
555
|
+
*/
|
|
556
|
+
eventOrganizer?: string;
|
|
557
|
+
/**
|
|
558
|
+
* The type of the marketing event
|
|
559
|
+
*/
|
|
560
|
+
eventType?: string;
|
|
561
|
+
/**
|
|
562
|
+
* A URL in the external event application where the marketing event can be managed
|
|
563
|
+
*/
|
|
564
|
+
eventUrl?: string;
|
|
565
|
+
/**
|
|
566
|
+
* The internal ID of the marketing event in HubSpot
|
|
567
|
+
*/
|
|
568
|
+
objectId: string;
|
|
569
|
+
/**
|
|
570
|
+
* The start date and time of the marketing event
|
|
571
|
+
*/
|
|
572
|
+
startDateTime?: string;
|
|
573
|
+
/**
|
|
574
|
+
* The update date and time of the marketing event
|
|
575
|
+
*/
|
|
576
|
+
updatedAt: string;
|
|
577
|
+
}
|
|
578
|
+
|
|
579
|
+
export interface MarketingEventPublicObjectIdDeleteRequest {
|
|
580
|
+
/**
|
|
581
|
+
* The internal ID of the marketing event in HubSpot
|
|
582
|
+
*/
|
|
583
|
+
objectId: string;
|
|
584
|
+
}
|
|
585
|
+
|
|
586
|
+
export interface MarketingEventPublicReadResponse {
|
|
587
|
+
/**
|
|
588
|
+
* The number of HubSpot contacts that attended this marketing event.
|
|
589
|
+
*/
|
|
590
|
+
attendees: number;
|
|
591
|
+
/**
|
|
592
|
+
* The number of HubSpot contacts that registered for this marketing event, but later cancelled their registration.
|
|
593
|
+
*/
|
|
594
|
+
cancellations: number;
|
|
595
|
+
/**
|
|
596
|
+
* The creation date and time of the marketing event.
|
|
597
|
+
*/
|
|
598
|
+
createdAt: string;
|
|
599
|
+
/**
|
|
600
|
+
* A list of PropertyValues. These can be whatever kind of property names and values you want. However, they must already exist on the HubSpot account's definition of the MarketingEvent Object. If they don't they will be filtered out and not set.
|
|
601
|
+
* In order to do this you'll need to create a new PropertyGroup on the HubSpot account's MarketingEvent object for your specific app and create the Custom Property you want to track on that HubSpot account. Do not create any new default properties on the MarketingEvent object as that will apply to all HubSpot accounts.
|
|
602
|
+
*
|
|
603
|
+
*/
|
|
604
|
+
customProperties: PropertyValue[];
|
|
605
|
+
/**
|
|
606
|
+
* The end date and time of the marketing event.
|
|
607
|
+
*/
|
|
608
|
+
endDateTime?: string;
|
|
609
|
+
/**
|
|
610
|
+
* Indicates if the marketing event has been cancelled.
|
|
611
|
+
*/
|
|
612
|
+
eventCancelled?: boolean;
|
|
613
|
+
/**
|
|
614
|
+
* Indicates if the marketing event has been completed.
|
|
615
|
+
*/
|
|
616
|
+
eventCompleted?: boolean;
|
|
617
|
+
/**
|
|
618
|
+
* The description of the marketing event.
|
|
619
|
+
*/
|
|
620
|
+
eventDescription?: string;
|
|
621
|
+
/**
|
|
622
|
+
* The name of the marketing event.
|
|
623
|
+
*/
|
|
624
|
+
eventName: string;
|
|
625
|
+
/**
|
|
626
|
+
* The name of the organizer of the marketing event.
|
|
627
|
+
*/
|
|
628
|
+
eventOrganizer: string;
|
|
629
|
+
/**
|
|
630
|
+
* The type of the marketing event.
|
|
631
|
+
*/
|
|
632
|
+
eventType?: string;
|
|
633
|
+
/**
|
|
634
|
+
* A URL in the external event application where the marketing event can be managed.
|
|
635
|
+
*/
|
|
636
|
+
eventUrl?: string;
|
|
637
|
+
/**
|
|
638
|
+
* The id of the marketing event in the external event application.
|
|
639
|
+
*/
|
|
640
|
+
externalEventId: string;
|
|
641
|
+
/**
|
|
642
|
+
* The ID of the marketing event CRM object.
|
|
643
|
+
*/
|
|
644
|
+
id: string;
|
|
645
|
+
/**
|
|
646
|
+
* The number of HubSpot contacts that registered for this marketing event, but did not attend. This field only had a value when the event is over.
|
|
647
|
+
*/
|
|
648
|
+
noShows: number;
|
|
649
|
+
/**
|
|
650
|
+
* The ID of the marketing event CRM object.
|
|
651
|
+
*/
|
|
652
|
+
objectId?: string;
|
|
653
|
+
/**
|
|
654
|
+
* The number of HubSpot contacts that registered for this marketing event.
|
|
655
|
+
*/
|
|
656
|
+
registrants: number;
|
|
657
|
+
/**
|
|
658
|
+
* The start date and time of the marketing event.
|
|
659
|
+
*/
|
|
660
|
+
startDateTime?: string;
|
|
661
|
+
/**
|
|
662
|
+
* The update date and time of the marketing event.
|
|
663
|
+
*/
|
|
664
|
+
updatedAt: string;
|
|
665
|
+
}
|
|
666
|
+
|
|
667
|
+
export interface MarketingEventPublicReadResponseV2 {
|
|
668
|
+
appInfo?: AppInfo;
|
|
669
|
+
/**
|
|
670
|
+
* Number of attended contact records of a marketing event
|
|
671
|
+
*/
|
|
672
|
+
attendees?: number;
|
|
673
|
+
/**
|
|
674
|
+
* Number of cancelled contact records of a marketing event
|
|
675
|
+
*/
|
|
676
|
+
cancellations?: number;
|
|
677
|
+
/**
|
|
678
|
+
* The creation date and time of the marketing event
|
|
679
|
+
*/
|
|
680
|
+
createdAt: string;
|
|
681
|
+
customProperties: CrmPropertyWrapper[];
|
|
682
|
+
/**
|
|
683
|
+
* The end date and time of the marketing event
|
|
684
|
+
*/
|
|
685
|
+
endDateTime?: string;
|
|
686
|
+
/**
|
|
687
|
+
* Indicates if the marketing event has been cancelled
|
|
688
|
+
*/
|
|
689
|
+
eventCancelled?: boolean;
|
|
690
|
+
/**
|
|
691
|
+
* Indicates if the marketing event has been completed
|
|
692
|
+
*/
|
|
693
|
+
eventCompleted?: boolean;
|
|
694
|
+
/**
|
|
695
|
+
* The description of the marketing event
|
|
696
|
+
*/
|
|
697
|
+
eventDescription?: string;
|
|
698
|
+
/**
|
|
699
|
+
* The name of the marketing event
|
|
700
|
+
*/
|
|
701
|
+
eventName: string;
|
|
702
|
+
/**
|
|
703
|
+
* The name of the organizer of the marketing event
|
|
704
|
+
*/
|
|
705
|
+
eventOrganizer?: string;
|
|
706
|
+
/**
|
|
707
|
+
* The status of the marketing event
|
|
708
|
+
*/
|
|
709
|
+
eventStatus?: string;
|
|
710
|
+
eventStatusV2?: string;
|
|
711
|
+
/**
|
|
712
|
+
* The type of the marketing event
|
|
713
|
+
*/
|
|
714
|
+
eventType?: string;
|
|
715
|
+
/**
|
|
716
|
+
* A URL in the external event application where the marketing event can be managed
|
|
717
|
+
*/
|
|
718
|
+
eventUrl?: string;
|
|
719
|
+
/**
|
|
720
|
+
* The ID that is associated with this marketing event in the external event application
|
|
721
|
+
*/
|
|
722
|
+
externalEventId?: string;
|
|
723
|
+
/**
|
|
724
|
+
* Number of no-show contact records of a marketing event
|
|
725
|
+
*/
|
|
726
|
+
noShows?: number;
|
|
727
|
+
/**
|
|
728
|
+
* The internal ID of the marketing event in HubSpot
|
|
729
|
+
*/
|
|
730
|
+
objectId: string;
|
|
731
|
+
/**
|
|
732
|
+
* Number of registered contact records of a marketing event
|
|
733
|
+
*/
|
|
734
|
+
registrants?: number;
|
|
735
|
+
/**
|
|
736
|
+
* The start date and time of the marketing event
|
|
737
|
+
*/
|
|
738
|
+
startDateTime?: string;
|
|
739
|
+
/**
|
|
740
|
+
* The update date and time of the marketing event
|
|
741
|
+
*/
|
|
742
|
+
updatedAt: string;
|
|
743
|
+
}
|
|
744
|
+
|
|
745
|
+
export interface MarketingEventPublicUpdateRequestFullV2 {
|
|
746
|
+
customProperties: PropertyValue[];
|
|
747
|
+
/**
|
|
748
|
+
* The end date and time of the marketing event
|
|
749
|
+
*/
|
|
750
|
+
endDateTime?: string;
|
|
751
|
+
/**
|
|
752
|
+
* Indicates if the marketing event has been cancelled
|
|
753
|
+
*/
|
|
754
|
+
eventCancelled?: boolean;
|
|
755
|
+
/**
|
|
756
|
+
* The description of the marketing event
|
|
757
|
+
*/
|
|
758
|
+
eventDescription?: string;
|
|
759
|
+
/**
|
|
760
|
+
* The name of the marketing event
|
|
761
|
+
*/
|
|
762
|
+
eventName?: string;
|
|
763
|
+
/**
|
|
764
|
+
* The name of the organizer of the marketing event
|
|
765
|
+
*/
|
|
766
|
+
eventOrganizer?: string;
|
|
767
|
+
/**
|
|
768
|
+
* The type of the marketing event
|
|
769
|
+
*/
|
|
770
|
+
eventType?: string;
|
|
771
|
+
/**
|
|
772
|
+
* A URL in the external event application where the marketing event can be managed
|
|
773
|
+
*/
|
|
774
|
+
eventUrl?: string;
|
|
775
|
+
/**
|
|
776
|
+
* The internal ID of the marketing event in HubSpot
|
|
777
|
+
*/
|
|
778
|
+
objectId: string;
|
|
779
|
+
/**
|
|
780
|
+
* The start date and time of the marketing event
|
|
781
|
+
*/
|
|
782
|
+
startDateTime?: string;
|
|
783
|
+
}
|
|
784
|
+
|
|
785
|
+
export interface MarketingEventPublicUpdateRequestV2 {
|
|
786
|
+
customProperties: PropertyValue[];
|
|
787
|
+
/**
|
|
788
|
+
* The end date and time of the marketing event
|
|
789
|
+
*/
|
|
790
|
+
endDateTime?: string;
|
|
791
|
+
/**
|
|
792
|
+
* Indicates if the marketing event has been cancelled
|
|
793
|
+
*/
|
|
794
|
+
eventCancelled?: boolean;
|
|
795
|
+
/**
|
|
796
|
+
* The description of the marketing event
|
|
797
|
+
*/
|
|
798
|
+
eventDescription?: string;
|
|
799
|
+
/**
|
|
800
|
+
* The name of the marketing event
|
|
801
|
+
*/
|
|
802
|
+
eventName?: string;
|
|
803
|
+
/**
|
|
804
|
+
* The name of the organizer of the marketing event
|
|
805
|
+
*/
|
|
806
|
+
eventOrganizer?: string;
|
|
807
|
+
/**
|
|
808
|
+
* The type of the marketing event
|
|
809
|
+
*/
|
|
810
|
+
eventType?: string;
|
|
811
|
+
/**
|
|
812
|
+
* A URL in the external event application where the marketing event can be managed
|
|
813
|
+
*/
|
|
814
|
+
eventUrl?: string;
|
|
815
|
+
/**
|
|
816
|
+
* The start date and time of the marketing event
|
|
817
|
+
*/
|
|
818
|
+
startDateTime?: string;
|
|
819
|
+
}
|
|
820
|
+
|
|
821
|
+
export interface MarketingEventSubscriber {
|
|
822
|
+
/**
|
|
823
|
+
* Timestamp in milliseconds at which the contact subscribed to the event.
|
|
824
|
+
*/
|
|
825
|
+
interactionDateTime: number;
|
|
826
|
+
/**
|
|
827
|
+
* The key-value set of the properties of the contact
|
|
828
|
+
*/
|
|
829
|
+
properties: Record<string, string>;
|
|
830
|
+
/**
|
|
831
|
+
* The ID of the contact in HubSpot
|
|
832
|
+
*/
|
|
833
|
+
vid: number;
|
|
834
|
+
}
|
|
835
|
+
|
|
836
|
+
export interface MarketingEventUpdateRequestParams {
|
|
837
|
+
/**
|
|
838
|
+
* A list of PropertyValues. These can be whatever kind of property names and values you want. However, they must already exist on the HubSpot account's definition of the MarketingEvent Object. If they don't they will be filtered out and not set.
|
|
839
|
+
* In order to do this you'll need to create a new PropertyGroup on the HubSpot account's MarketingEvent object for your specific app and create the Custom Property you want to track on that HubSpot account. Do not create any new default properties on the MarketingEvent object as that will apply to all HubSpot accounts.
|
|
840
|
+
*
|
|
841
|
+
*/
|
|
842
|
+
customProperties: PropertyValue[];
|
|
843
|
+
/**
|
|
844
|
+
* The end date and time of the marketing event.
|
|
845
|
+
*/
|
|
846
|
+
endDateTime?: string;
|
|
847
|
+
/**
|
|
848
|
+
* Indicates if the marketing event has been cancelled. Defaults to `false`
|
|
849
|
+
*/
|
|
850
|
+
eventCancelled?: boolean;
|
|
851
|
+
/**
|
|
852
|
+
* Indicates if the marketing event has been completed. Defaults to `false`
|
|
853
|
+
*/
|
|
854
|
+
eventCompleted?: boolean;
|
|
855
|
+
/**
|
|
856
|
+
* The description of the marketing event.
|
|
857
|
+
*/
|
|
858
|
+
eventDescription?: string;
|
|
859
|
+
/**
|
|
860
|
+
* The name of the marketing event.
|
|
861
|
+
*/
|
|
862
|
+
eventName?: string;
|
|
863
|
+
/**
|
|
864
|
+
* The name of the organizer of the marketing event.
|
|
865
|
+
*/
|
|
866
|
+
eventOrganizer?: string;
|
|
867
|
+
/**
|
|
868
|
+
* Describes what type of event this is. For example: `WEBINAR`, `CONFERENCE`, `WORKSHOP`
|
|
869
|
+
*/
|
|
870
|
+
eventType?: string;
|
|
871
|
+
/**
|
|
872
|
+
* A URL in the external event application where the marketing event can be managed.
|
|
873
|
+
*/
|
|
874
|
+
eventUrl?: string;
|
|
875
|
+
/**
|
|
876
|
+
* The start date and time of the marketing event.
|
|
877
|
+
*/
|
|
878
|
+
startDateTime?: string;
|
|
879
|
+
}
|
|
880
|
+
|
|
881
|
+
/**
|
|
882
|
+
* Specifies the paging information needed to retrieve the next set of results in a paginated API response
|
|
883
|
+
*/
|
|
884
|
+
export interface NextPage {
|
|
885
|
+
/**
|
|
886
|
+
* The ID element at the start of the page
|
|
887
|
+
*/
|
|
888
|
+
after: string;
|
|
889
|
+
/**
|
|
890
|
+
* Link to the next page
|
|
891
|
+
*/
|
|
892
|
+
link?: string;
|
|
893
|
+
}
|
|
894
|
+
|
|
895
|
+
export interface Paging {
|
|
896
|
+
next?: NextPage;
|
|
897
|
+
prev?: PreviousPage;
|
|
898
|
+
}
|
|
899
|
+
|
|
900
|
+
export interface ParticipationAssociations {
|
|
901
|
+
contact: ContactAssociation;
|
|
902
|
+
marketingEvent: MarketingEventAssociation;
|
|
903
|
+
}
|
|
904
|
+
|
|
905
|
+
export interface ParticipationBreakdown {
|
|
906
|
+
associations: ParticipationAssociations;
|
|
907
|
+
/**
|
|
908
|
+
* The creation time and date of the target marketing event
|
|
909
|
+
*/
|
|
910
|
+
createdAt: string;
|
|
911
|
+
/**
|
|
912
|
+
* The internal ID of the target marketing event
|
|
913
|
+
*/
|
|
914
|
+
id: string;
|
|
915
|
+
properties: ParticipationProperties;
|
|
916
|
+
}
|
|
917
|
+
|
|
918
|
+
export interface ParticipationProperties {
|
|
919
|
+
/**
|
|
920
|
+
* The number of seconds the participation lasted
|
|
921
|
+
*/
|
|
922
|
+
attendanceDurationSeconds?: number;
|
|
923
|
+
/**
|
|
924
|
+
* Percentage of the participation duration relative to the event duration
|
|
925
|
+
*/
|
|
926
|
+
attendancePercentage?: string;
|
|
927
|
+
/**
|
|
928
|
+
* The state of the participation
|
|
929
|
+
*/
|
|
930
|
+
attendanceState:
|
|
931
|
+
| 'ATTENDED'
|
|
932
|
+
| 'CANCELLED'
|
|
933
|
+
| 'EMPTY'
|
|
934
|
+
| 'NO_SHOW'
|
|
935
|
+
| 'REGISTERED';
|
|
936
|
+
/**
|
|
937
|
+
* Timestamp of when the participation occurred
|
|
938
|
+
*/
|
|
939
|
+
occurredAt: number;
|
|
940
|
+
}
|
|
941
|
+
|
|
942
|
+
/**
|
|
943
|
+
* specifies the paging information needed to retrieve the previous set of results in a paginated API response
|
|
944
|
+
*/
|
|
945
|
+
export interface PreviousPage {
|
|
946
|
+
/**
|
|
947
|
+
* A paging cursor token for retrieving previous pages.
|
|
948
|
+
*/
|
|
949
|
+
before: string;
|
|
950
|
+
/**
|
|
951
|
+
* A URL that can be used to retrieve the previous pages' results.
|
|
952
|
+
*/
|
|
953
|
+
link?: string;
|
|
954
|
+
}
|
|
955
|
+
|
|
956
|
+
/**
|
|
957
|
+
* Represents a single custom property of a marketing event, storing its name, value, metadata (like source, timestamp, and sensitivity), and related audit information for tracking changes.
|
|
958
|
+
*/
|
|
959
|
+
export interface PropertyValue {
|
|
960
|
+
/**
|
|
961
|
+
* Level of data sensitivity
|
|
962
|
+
*/
|
|
963
|
+
dataSensitivity: 'high' | 'none' | 'standard';
|
|
964
|
+
/**
|
|
965
|
+
* Indicates whether the property is encrypted
|
|
966
|
+
*/
|
|
967
|
+
isEncrypted: boolean;
|
|
968
|
+
/**
|
|
969
|
+
* Indicates whether the property value is stored as a large value in the storage
|
|
970
|
+
*/
|
|
971
|
+
isLargeValue: boolean;
|
|
972
|
+
/**
|
|
973
|
+
* Name of custom property
|
|
974
|
+
*/
|
|
975
|
+
name: string;
|
|
976
|
+
/**
|
|
977
|
+
* The timestamp that indicates when the value being written is persisted in storage
|
|
978
|
+
*/
|
|
979
|
+
persistenceTimestamp: number;
|
|
980
|
+
/**
|
|
981
|
+
* The ID of the request
|
|
982
|
+
*/
|
|
983
|
+
requestId: string;
|
|
984
|
+
/**
|
|
985
|
+
* Indicates whether the property is selected
|
|
986
|
+
*/
|
|
987
|
+
selectedByUser: boolean;
|
|
988
|
+
/**
|
|
989
|
+
* Timestamp of when the property was selected by the user
|
|
990
|
+
*/
|
|
991
|
+
selectedByUserTimestamp: number;
|
|
992
|
+
/**
|
|
993
|
+
* Source of the property
|
|
994
|
+
*/
|
|
995
|
+
source:
|
|
996
|
+
| 'ACADEMY'
|
|
997
|
+
| 'ACCEPTANCE_TEST'
|
|
998
|
+
| 'ACTIVITY_AUTO_ASSOCIATE'
|
|
999
|
+
| 'ACTIVITY_LOG_REVERT'
|
|
1000
|
+
| 'ADS'
|
|
1001
|
+
| 'AI_GROUP'
|
|
1002
|
+
| 'ANALYTICS'
|
|
1003
|
+
| 'API'
|
|
1004
|
+
| 'APPROVALS'
|
|
1005
|
+
| 'ASSISTS'
|
|
1006
|
+
| 'ASSOCIATIONS'
|
|
1007
|
+
| 'AUTO_ASSOCIATE_BY_DOMAIN'
|
|
1008
|
+
| 'AUTOMATION_JOURNEY'
|
|
1009
|
+
| 'AUTOMATION_PLATFORM'
|
|
1010
|
+
| 'AVATARS_SERVICE'
|
|
1011
|
+
| 'BATCH_UPDATE'
|
|
1012
|
+
| 'BCC_TO_CRM'
|
|
1013
|
+
| 'BEHAVIORAL_EVENTS'
|
|
1014
|
+
| 'BET_ASSIGNMENT'
|
|
1015
|
+
| 'BET_CRM_CONNECTOR'
|
|
1016
|
+
| 'BIDEN'
|
|
1017
|
+
| 'BILLING'
|
|
1018
|
+
| 'BOT'
|
|
1019
|
+
| 'CALCULATED'
|
|
1020
|
+
| 'CENTRAL_EXCHANGE_RATES'
|
|
1021
|
+
| 'CHATSPOT'
|
|
1022
|
+
| 'CLONE_OBJECTS'
|
|
1023
|
+
| 'COMMUNICATOR'
|
|
1024
|
+
| 'COMPANIES'
|
|
1025
|
+
| 'COMPANY_FAMILIES'
|
|
1026
|
+
| 'COMPANY_INSIGHTS'
|
|
1027
|
+
| 'CONNECTED_ACCOUNT'
|
|
1028
|
+
| 'CONTACTS'
|
|
1029
|
+
| 'CONTACTS_WEB'
|
|
1030
|
+
| 'CONTENT_MEMBERSHIP'
|
|
1031
|
+
| 'CONVERSATIONAL_ENRICHMENT'
|
|
1032
|
+
| 'CONVERSATIONS'
|
|
1033
|
+
| 'CRM_PROCESSES_PLATFORM'
|
|
1034
|
+
| 'CRM_UI'
|
|
1035
|
+
| 'CRM_UI_BULK_ACTION'
|
|
1036
|
+
| 'CUSTOMER_AGENT'
|
|
1037
|
+
| 'DATA_ENRICHMENT'
|
|
1038
|
+
| 'DATA_QUALITY'
|
|
1039
|
+
| 'DATASET'
|
|
1040
|
+
| 'DEALS'
|
|
1041
|
+
| 'DEFAULT'
|
|
1042
|
+
| 'DELETE_OBJECTS'
|
|
1043
|
+
| 'EMAIL'
|
|
1044
|
+
| 'EMAIL_INBOX_IMPORT'
|
|
1045
|
+
| 'EMAIL_INTEGRATION'
|
|
1046
|
+
| 'ENGAGEMENTS'
|
|
1047
|
+
| 'EXTENSION'
|
|
1048
|
+
| 'FILE_MANAGER'
|
|
1049
|
+
| 'FLYWHEEL_PRODUCT_DATA_SYNC'
|
|
1050
|
+
| 'FORECASTING'
|
|
1051
|
+
| 'FORM'
|
|
1052
|
+
| 'FORWARD_TO_CRM'
|
|
1053
|
+
| 'GMAIL_INTEGRATION'
|
|
1054
|
+
| 'GOALS'
|
|
1055
|
+
| 'HEISENBERG'
|
|
1056
|
+
| 'HELP_DESK'
|
|
1057
|
+
| 'HELP_DESK_AI'
|
|
1058
|
+
| 'IMPORT'
|
|
1059
|
+
| 'INTEGRATION'
|
|
1060
|
+
| 'INTEGRATIONS_PLATFORM'
|
|
1061
|
+
| 'INTEGRATIONS_SYNC'
|
|
1062
|
+
| 'INTENT'
|
|
1063
|
+
| 'INTERNAL_PROCESSING'
|
|
1064
|
+
| 'LEADIN'
|
|
1065
|
+
| 'LEGAL_BASIS_REMEDIATION'
|
|
1066
|
+
| 'MARKET_SOURCING'
|
|
1067
|
+
| 'MARKETPLACE'
|
|
1068
|
+
| 'MARKETS'
|
|
1069
|
+
| 'MEETINGS'
|
|
1070
|
+
| 'MERGE_COMPANIES'
|
|
1071
|
+
| 'MERGE_CONTACTS'
|
|
1072
|
+
| 'MERGE_OBJECTS'
|
|
1073
|
+
| 'MERGE_REVERT_OBJECTS'
|
|
1074
|
+
| 'MICROAPPS'
|
|
1075
|
+
| 'MIGRATION'
|
|
1076
|
+
| 'MOBILE_ANDROID'
|
|
1077
|
+
| 'MOBILE_IOS'
|
|
1078
|
+
| 'PAYMENTS'
|
|
1079
|
+
| 'PIPELINE_SETTINGS'
|
|
1080
|
+
| 'PLAYBOOKS'
|
|
1081
|
+
| 'PORTAL_OBJECT_SYNC'
|
|
1082
|
+
| 'PORTAL_USER_ASSOCIATOR'
|
|
1083
|
+
| 'PRESENTATIONS'
|
|
1084
|
+
| 'PRIMARY_AUTOMATION'
|
|
1085
|
+
| 'PROPERTY_DEFAULT_VALUE'
|
|
1086
|
+
| 'PROPERTY_RESTORE'
|
|
1087
|
+
| 'PROPERTY_SETTINGS'
|
|
1088
|
+
| 'PROSPECTING_AGENT'
|
|
1089
|
+
| 'QUOTAS'
|
|
1090
|
+
| 'QUOTES'
|
|
1091
|
+
| 'RECYCLING_BIN'
|
|
1092
|
+
| 'RESTORE_OBJECTS'
|
|
1093
|
+
| 'REVENUE_PLATFORM'
|
|
1094
|
+
| 'SALES'
|
|
1095
|
+
| 'SALES_MESSAGES'
|
|
1096
|
+
| 'SALESFORCE'
|
|
1097
|
+
| 'SEQUENCES'
|
|
1098
|
+
| 'SETTINGS'
|
|
1099
|
+
| 'SIDEKICK'
|
|
1100
|
+
| 'SIGNALS'
|
|
1101
|
+
| 'SLACK_INTEGRATION'
|
|
1102
|
+
| 'SMART_DATA_CAPTURE'
|
|
1103
|
+
| 'SOCIAL'
|
|
1104
|
+
| 'SUCCESS'
|
|
1105
|
+
| 'TALLY'
|
|
1106
|
+
| 'TASK'
|
|
1107
|
+
| 'UNKNOWN'
|
|
1108
|
+
| 'WAL_INCREMENTAL'
|
|
1109
|
+
| 'WORK_UI'
|
|
1110
|
+
| 'WORKFLOW_CONTACT_DELETE_ACTION'
|
|
1111
|
+
| 'WORKFLOWS';
|
|
1112
|
+
/**
|
|
1113
|
+
* ID of the source of the property
|
|
1114
|
+
*/
|
|
1115
|
+
sourceId: string;
|
|
1116
|
+
/**
|
|
1117
|
+
* Label of the source of the property
|
|
1118
|
+
*/
|
|
1119
|
+
sourceLabel: string;
|
|
1120
|
+
/**
|
|
1121
|
+
* Source metadata encoded as a base64 string
|
|
1122
|
+
*/
|
|
1123
|
+
sourceMetadata: string;
|
|
1124
|
+
/**
|
|
1125
|
+
* Indicates which upstream service made the property change
|
|
1126
|
+
*/
|
|
1127
|
+
sourceUpstreamDeployable: string;
|
|
1128
|
+
/**
|
|
1129
|
+
* The unique identifier associated with the source.
|
|
1130
|
+
*/
|
|
1131
|
+
sourceVid: number[];
|
|
1132
|
+
/**
|
|
1133
|
+
* Timestamp of the request
|
|
1134
|
+
*/
|
|
1135
|
+
timestamp: number;
|
|
1136
|
+
/**
|
|
1137
|
+
* The unit
|
|
1138
|
+
*/
|
|
1139
|
+
unit: string;
|
|
1140
|
+
/**
|
|
1141
|
+
* The ID of the user who last updated the property
|
|
1142
|
+
*/
|
|
1143
|
+
updatedByUserId: number;
|
|
1144
|
+
/**
|
|
1145
|
+
* Indicates if the persistence timestamp is the same as storage version timestamp
|
|
1146
|
+
*/
|
|
1147
|
+
useTimestampAsPersistenceTimestamp: boolean;
|
|
1148
|
+
/**
|
|
1149
|
+
* Custom property value
|
|
1150
|
+
*/
|
|
1151
|
+
value: string;
|
|
1152
|
+
}
|
|
1153
|
+
|
|
1154
|
+
export interface PublicList {
|
|
1155
|
+
/**
|
|
1156
|
+
* Timestamp of the creation of the list
|
|
1157
|
+
*/
|
|
1158
|
+
createdAt?: string;
|
|
1159
|
+
/**
|
|
1160
|
+
* The ID of the user who created the list
|
|
1161
|
+
*/
|
|
1162
|
+
createdById?: string;
|
|
1163
|
+
/**
|
|
1164
|
+
* Timestamp of the deletion of the list
|
|
1165
|
+
*/
|
|
1166
|
+
deletedAt?: string;
|
|
1167
|
+
/**
|
|
1168
|
+
* Timestamp of the last update of the list filters
|
|
1169
|
+
*/
|
|
1170
|
+
filtersUpdatedAt?: string;
|
|
1171
|
+
/**
|
|
1172
|
+
* An internal ID of the list
|
|
1173
|
+
*/
|
|
1174
|
+
listId: string;
|
|
1175
|
+
/**
|
|
1176
|
+
* A number that represents a version of the list
|
|
1177
|
+
*/
|
|
1178
|
+
listVersion: number;
|
|
1179
|
+
/**
|
|
1180
|
+
* The name of the list
|
|
1181
|
+
*/
|
|
1182
|
+
name: string;
|
|
1183
|
+
/**
|
|
1184
|
+
* The internal ID of the object type of the list
|
|
1185
|
+
*/
|
|
1186
|
+
objectTypeId: string;
|
|
1187
|
+
/**
|
|
1188
|
+
* Represents the current processing status of the list
|
|
1189
|
+
*/
|
|
1190
|
+
processingStatus: string;
|
|
1191
|
+
/**
|
|
1192
|
+
* Processing type of the list
|
|
1193
|
+
*/
|
|
1194
|
+
processingType: string;
|
|
1195
|
+
/**
|
|
1196
|
+
* The size of the result list
|
|
1197
|
+
*/
|
|
1198
|
+
size?: number;
|
|
1199
|
+
/**
|
|
1200
|
+
* Timestamp of the last update of the list
|
|
1201
|
+
*/
|
|
1202
|
+
updatedAt?: string;
|
|
1203
|
+
/**
|
|
1204
|
+
* The ID of the user who last updated the list
|
|
1205
|
+
*/
|
|
1206
|
+
updatedById?: string;
|
|
1207
|
+
}
|
|
1208
|
+
|
|
1209
|
+
export interface SearchPublicResponseWrapper {
|
|
1210
|
+
/**
|
|
1211
|
+
* The ID of the source application of the marketing event
|
|
1212
|
+
*/
|
|
1213
|
+
appId: number;
|
|
1214
|
+
/**
|
|
1215
|
+
* The account ID associated with this marketing event in the external application
|
|
1216
|
+
*/
|
|
1217
|
+
externalAccountId: string;
|
|
1218
|
+
/**
|
|
1219
|
+
* The ID of the marketing event in the external event application
|
|
1220
|
+
*/
|
|
1221
|
+
externalEventId: string;
|
|
1222
|
+
/**
|
|
1223
|
+
* The internal ID of the marketing event in HubSpot
|
|
1224
|
+
*/
|
|
1225
|
+
objectId: string;
|
|
1226
|
+
}
|
|
1227
|
+
|
|
1228
|
+
/**
|
|
1229
|
+
* Ye olde error
|
|
1230
|
+
*/
|
|
1231
|
+
export interface StandardError {
|
|
1232
|
+
/**
|
|
1233
|
+
* The category of the error
|
|
1234
|
+
*/
|
|
1235
|
+
category: string;
|
|
1236
|
+
/**
|
|
1237
|
+
* The object that contains details of the errors
|
|
1238
|
+
*/
|
|
1239
|
+
context: Record<string, string[]>;
|
|
1240
|
+
/**
|
|
1241
|
+
* The detailed error objects.
|
|
1242
|
+
*/
|
|
1243
|
+
errors: ErrorDetail[];
|
|
1244
|
+
/**
|
|
1245
|
+
* The ID of the request
|
|
1246
|
+
*/
|
|
1247
|
+
id?: string;
|
|
1248
|
+
/**
|
|
1249
|
+
* Results of the request
|
|
1250
|
+
*/
|
|
1251
|
+
links: Record<string, string>;
|
|
1252
|
+
/**
|
|
1253
|
+
* A human readable message describing the error along with remediation steps where appropriate
|
|
1254
|
+
*/
|
|
1255
|
+
message: string;
|
|
1256
|
+
/**
|
|
1257
|
+
* Status of the response
|
|
1258
|
+
*/
|
|
1259
|
+
status: string;
|
|
1260
|
+
/**
|
|
1261
|
+
* The Sub-category of the error
|
|
1262
|
+
*/
|
|
1263
|
+
subCategory?: Record<string, never>;
|
|
1264
|
+
}
|
|
1265
|
+
|
|
1266
|
+
export interface SubscriberEmailResponse {
|
|
1267
|
+
/**
|
|
1268
|
+
* The email of the contact
|
|
1269
|
+
*/
|
|
1270
|
+
email: string;
|
|
1271
|
+
/**
|
|
1272
|
+
* The internal ID of the contact
|
|
1273
|
+
*/
|
|
1274
|
+
vid: number;
|
|
1275
|
+
}
|
|
1276
|
+
|
|
1277
|
+
export interface SubscriberVidResponse {
|
|
1278
|
+
/**
|
|
1279
|
+
* The internal ID of the contact
|
|
1280
|
+
*/
|
|
1281
|
+
vid: number;
|
|
1282
|
+
}
|
|
1283
|
+
}
|
|
1284
|
+
|
|
1285
|
+
export namespace MarketingMarketingevents {
|
|
1286
|
+
export type CreateInput =
|
|
1287
|
+
MarketingMarketingEventsSchemas.MarketingEventCreateRequestParams;
|
|
1288
|
+
|
|
1289
|
+
export type CreateOutput =
|
|
1290
|
+
MarketingMarketingEventsSchemas.MarketingEventDefaultResponse;
|
|
1291
|
+
|
|
1292
|
+
export type DeleteBatchByExternalEventIdInput =
|
|
1293
|
+
MarketingMarketingEventsSchemas.BatchInputMarketingEventExternalUniqueIdentifier;
|
|
1294
|
+
|
|
1295
|
+
export type DeleteBatchByExternalEventIdOutput = void;
|
|
1296
|
+
|
|
1297
|
+
export type DeleteBatchInput =
|
|
1298
|
+
MarketingMarketingEventsSchemas.BatchInputMarketingEventPublicObjectIdDeleteRequest;
|
|
1299
|
+
|
|
1300
|
+
export type DeleteBatchOutput = void;
|
|
1301
|
+
|
|
1302
|
+
export interface DeleteByExternalEventIdInput {
|
|
1303
|
+
externalAccountId: string;
|
|
1304
|
+
externalEventId: string;
|
|
1305
|
+
}
|
|
1306
|
+
|
|
1307
|
+
export type DeleteByExternalEventIdOutput = void;
|
|
1308
|
+
|
|
1309
|
+
export interface DeleteInput {
|
|
1310
|
+
/**
|
|
1311
|
+
* The internal id of the marketing event in HubSpot.
|
|
1312
|
+
*/
|
|
1313
|
+
objectId: string;
|
|
1314
|
+
}
|
|
1315
|
+
|
|
1316
|
+
export type DeleteOutput = void;
|
|
1317
|
+
|
|
1318
|
+
export interface GetByExternalEventIdInput {
|
|
1319
|
+
externalAccountId: string;
|
|
1320
|
+
externalEventId: string;
|
|
1321
|
+
}
|
|
1322
|
+
|
|
1323
|
+
export type GetByExternalEventIdOutput =
|
|
1324
|
+
MarketingMarketingEventsSchemas.MarketingEventPublicReadResponse;
|
|
1325
|
+
|
|
1326
|
+
export interface GetInput {
|
|
1327
|
+
/**
|
|
1328
|
+
* The internal id of the marketing event in HubSpot.
|
|
1329
|
+
*/
|
|
1330
|
+
objectId: string;
|
|
1331
|
+
}
|
|
1332
|
+
|
|
1333
|
+
export type GetOutput =
|
|
1334
|
+
MarketingMarketingEventsSchemas.MarketingEventPublicReadResponseV2;
|
|
1335
|
+
|
|
1336
|
+
export interface ListInput {
|
|
1337
|
+
/**
|
|
1338
|
+
* The cursor indicating the position of the last retrieved item.
|
|
1339
|
+
*/
|
|
1340
|
+
after?: string;
|
|
1341
|
+
/**
|
|
1342
|
+
* The limit for response size. The default value is 10, the max number is 100
|
|
1343
|
+
*/
|
|
1344
|
+
limit?: number;
|
|
1345
|
+
}
|
|
1346
|
+
|
|
1347
|
+
export type ListOutput =
|
|
1348
|
+
MarketingMarketingEventsSchemas.CollectionResponseMarketingEventPublicReadResponseV2ForwardPaging;
|
|
8
1349
|
|
|
9
|
-
|
|
1350
|
+
export interface SearchByExternalEventIdInput {
|
|
1351
|
+
q: string;
|
|
1352
|
+
}
|
|
1353
|
+
|
|
1354
|
+
export type SearchByExternalEventIdOutput =
|
|
1355
|
+
MarketingMarketingEventsSchemas.CollectionResponseSearchPublicResponseWrapperNoPaging;
|
|
1356
|
+
|
|
1357
|
+
export interface SearchIdentifiersByExternalEventIdInput {
|
|
1358
|
+
/**
|
|
1359
|
+
* The id of the marketing event in the external event application.
|
|
1360
|
+
*/
|
|
1361
|
+
externalEventId: string;
|
|
1362
|
+
}
|
|
1363
|
+
|
|
1364
|
+
export type SearchIdentifiersByExternalEventIdOutput =
|
|
1365
|
+
MarketingMarketingEventsSchemas.CollectionResponseWithTotalMarketingEventIdentifiersResponse;
|
|
1366
|
+
|
|
1367
|
+
export type UpdateBatchInput =
|
|
1368
|
+
MarketingMarketingEventsSchemas.BatchInputMarketingEventPublicUpdateRequestFullV2;
|
|
1369
|
+
|
|
1370
|
+
export type UpdateBatchOutput =
|
|
1371
|
+
MarketingMarketingEventsSchemas.BatchResponseMarketingEventPublicDefaultResponseV2;
|
|
1372
|
+
|
|
1373
|
+
export interface UpdateByExternalEventIdInput {
|
|
1374
|
+
data: MarketingMarketingEventsSchemas.MarketingEventUpdateRequestParams;
|
|
1375
|
+
externalAccountId: string;
|
|
1376
|
+
externalEventId: string;
|
|
1377
|
+
}
|
|
1378
|
+
|
|
1379
|
+
export type UpdateByExternalEventIdOutput =
|
|
1380
|
+
MarketingMarketingEventsSchemas.MarketingEventPublicDefaultResponse;
|
|
1381
|
+
|
|
1382
|
+
export interface UpdateInput {
|
|
1383
|
+
data: MarketingMarketingEventsSchemas.MarketingEventPublicUpdateRequestV2;
|
|
1384
|
+
/**
|
|
1385
|
+
* The internal id of the marketing event in HubSpot.
|
|
1386
|
+
*/
|
|
1387
|
+
objectId: string;
|
|
1388
|
+
}
|
|
10
1389
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
externalEventId: string;
|
|
14
|
-
}
|
|
1390
|
+
export type UpdateOutput =
|
|
1391
|
+
MarketingMarketingEventsSchemas.MarketingEventPublicDefaultResponseV2;
|
|
15
1392
|
|
|
16
|
-
|
|
1393
|
+
export type UpsertBatchInput =
|
|
1394
|
+
MarketingMarketingEventsSchemas.BatchInputMarketingEventCreateRequestParams;
|
|
17
1395
|
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
* The internal id of the marketing event in HubSpot.
|
|
21
|
-
*/
|
|
22
|
-
objectId: string;
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
export type DeleteOutput = void;
|
|
1396
|
+
export type UpsertBatchOutput =
|
|
1397
|
+
MarketingMarketingEventsSchemas.BatchResponseMarketingEventPublicDefaultResponse;
|
|
26
1398
|
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
}
|
|
31
|
-
|
|
32
|
-
export type GetByExternalEventIdOutput =
|
|
33
|
-
Schemas.MarketingEventPublicReadResponse;
|
|
34
|
-
|
|
35
|
-
export interface GetInput {
|
|
36
|
-
/**
|
|
37
|
-
* The internal id of the marketing event in HubSpot.
|
|
38
|
-
*/
|
|
39
|
-
objectId: string;
|
|
40
|
-
}
|
|
41
|
-
|
|
42
|
-
export type GetOutput = Schemas.MarketingEventPublicReadResponseV2;
|
|
43
|
-
|
|
44
|
-
export interface ListInput {
|
|
45
|
-
/**
|
|
46
|
-
* The cursor indicating the position of the last retrieved item.
|
|
47
|
-
*/
|
|
48
|
-
after?: string;
|
|
49
|
-
/**
|
|
50
|
-
* The limit for response size. The default value is 10, the max number is 100
|
|
51
|
-
*/
|
|
52
|
-
limit?: number;
|
|
53
|
-
}
|
|
54
|
-
|
|
55
|
-
export type ListOutput =
|
|
56
|
-
Schemas.CollectionResponseMarketingEventPublicReadResponseV2ForwardPaging;
|
|
57
|
-
|
|
58
|
-
export interface UpdateByExternalEventIdInput {
|
|
59
|
-
data: Schemas.MarketingEventUpdateRequestParams;
|
|
60
|
-
externalAccountId: string;
|
|
61
|
-
externalEventId: string;
|
|
62
|
-
}
|
|
63
|
-
|
|
64
|
-
export type UpdateByExternalEventIdOutput =
|
|
65
|
-
Schemas.MarketingEventPublicDefaultResponse;
|
|
66
|
-
|
|
67
|
-
export interface UpdateInput {
|
|
68
|
-
data: Schemas.MarketingEventPublicUpdateRequestV2;
|
|
69
|
-
/**
|
|
70
|
-
* The internal id of the marketing event in HubSpot.
|
|
71
|
-
*/
|
|
72
|
-
objectId: string;
|
|
73
|
-
}
|
|
74
|
-
|
|
75
|
-
export type UpdateOutput = Schemas.MarketingEventPublicDefaultResponseV2;
|
|
76
|
-
|
|
77
|
-
export interface UpsertByExternalEventIdInput {
|
|
78
|
-
data: Schemas.MarketingEventCreateRequestParams;
|
|
79
|
-
externalEventId: string;
|
|
80
|
-
}
|
|
81
|
-
|
|
82
|
-
export type UpsertByExternalEventIdOutput =
|
|
83
|
-
Schemas.MarketingEventPublicDefaultResponse;
|
|
84
|
-
}
|
|
85
|
-
|
|
86
|
-
export namespace Batch {
|
|
87
|
-
export type DeleteBatchByExternalEventIdInput =
|
|
88
|
-
Schemas.BatchInputMarketingEventExternalUniqueIdentifier;
|
|
89
|
-
|
|
90
|
-
export type DeleteBatchByExternalEventIdOutput = void;
|
|
91
|
-
|
|
92
|
-
export type DeleteBatchInput =
|
|
93
|
-
Schemas.BatchInputMarketingEventPublicObjectIdDeleteRequest;
|
|
94
|
-
|
|
95
|
-
export type DeleteBatchOutput = void;
|
|
96
|
-
|
|
97
|
-
export type UpdateBatchInput =
|
|
98
|
-
Schemas.BatchInputMarketingEventPublicUpdateRequestFullV2;
|
|
99
|
-
|
|
100
|
-
export type UpdateBatchOutput =
|
|
101
|
-
Schemas.BatchResponseMarketingEventPublicDefaultResponseV2;
|
|
102
|
-
|
|
103
|
-
export type UpsertBatchInput =
|
|
104
|
-
Schemas.BatchInputMarketingEventCreateRequestParams;
|
|
105
|
-
|
|
106
|
-
export type UpsertBatchOutput =
|
|
107
|
-
Schemas.BatchResponseMarketingEventPublicDefaultResponse;
|
|
108
|
-
}
|
|
109
|
-
|
|
110
|
-
export namespace EventAttendees {
|
|
111
|
-
export interface CreateByEventIdAndContactIdInput {
|
|
112
|
-
data: Schemas.BatchInputMarketingEventSubscriber;
|
|
113
|
-
/**
|
|
114
|
-
* The internal id of the marketing event in HubSpot.
|
|
115
|
-
*/
|
|
116
|
-
objectId: string;
|
|
117
|
-
/**
|
|
118
|
-
* The attendance state value. It may be 'register', 'attend' or 'cancel'
|
|
119
|
-
*/
|
|
120
|
-
subscriberState: string;
|
|
121
|
-
}
|
|
122
|
-
|
|
123
|
-
export type CreateByEventIdAndContactIdOutput =
|
|
124
|
-
Schemas.BatchResponseSubscriberVidResponse;
|
|
125
|
-
|
|
126
|
-
export interface CreateByEventIdAndEmailInput {
|
|
127
|
-
data: Schemas.BatchInputMarketingEventEmailSubscriber;
|
|
128
|
-
/**
|
|
129
|
-
* The internal id of the marketing event in HubSpot.
|
|
130
|
-
*/
|
|
131
|
-
objectId: string;
|
|
132
|
-
/**
|
|
133
|
-
* The attendance state value. It may be 'register', 'attend' or 'cancel'
|
|
134
|
-
*/
|
|
135
|
-
subscriberState: string;
|
|
136
|
-
}
|
|
137
|
-
|
|
138
|
-
export type CreateByEventIdAndEmailOutput =
|
|
139
|
-
Schemas.BatchResponseSubscriberEmailResponse;
|
|
140
|
-
|
|
141
|
-
export interface CreateByExternalEventIdAndContactIdInput {
|
|
142
|
-
data: Schemas.BatchInputMarketingEventSubscriber;
|
|
143
|
-
externalAccountId?: string;
|
|
144
|
-
externalEventId: string;
|
|
145
|
-
subscriberState: string;
|
|
146
|
-
}
|
|
147
|
-
|
|
148
|
-
export type CreateByExternalEventIdAndContactIdOutput =
|
|
149
|
-
Schemas.BatchResponseSubscriberVidResponse;
|
|
150
|
-
|
|
151
|
-
export interface CreateByExternalEventIdAndEmailInput {
|
|
152
|
-
data: Schemas.BatchInputMarketingEventEmailSubscriber;
|
|
153
|
-
externalAccountId?: string;
|
|
154
|
-
externalEventId: string;
|
|
155
|
-
subscriberState: string;
|
|
156
|
-
}
|
|
157
|
-
|
|
158
|
-
export type CreateByExternalEventIdAndEmailOutput =
|
|
159
|
-
Schemas.BatchResponseSubscriberEmailResponse;
|
|
160
|
-
}
|
|
161
|
-
|
|
162
|
-
export namespace EventStatus {
|
|
163
|
-
export interface CancelByExternalEventIdInput {
|
|
164
|
-
externalAccountId: string;
|
|
165
|
-
externalEventId: string;
|
|
166
|
-
}
|
|
167
|
-
|
|
168
|
-
export type CancelByExternalEventIdOutput =
|
|
169
|
-
Schemas.MarketingEventDefaultResponse;
|
|
170
|
-
|
|
171
|
-
export interface CompleteByExternalEventIdInput {
|
|
172
|
-
data: Schemas.MarketingEventCompleteRequestParams;
|
|
173
|
-
externalAccountId: string;
|
|
174
|
-
externalEventId: string;
|
|
175
|
-
}
|
|
176
|
-
|
|
177
|
-
export type CompleteByExternalEventIdOutput =
|
|
178
|
-
Schemas.MarketingEventDefaultResponse;
|
|
179
|
-
}
|
|
180
|
-
|
|
181
|
-
export namespace Identifiers {
|
|
182
|
-
export interface SearchByExternalEventIdInput {
|
|
183
|
-
q: string;
|
|
184
|
-
}
|
|
185
|
-
|
|
186
|
-
export type SearchByExternalEventIdOutput =
|
|
187
|
-
Schemas.CollectionResponseSearchPublicResponseWrapperNoPaging;
|
|
188
|
-
|
|
189
|
-
export interface SearchIdentifiersByExternalEventIdInput {
|
|
190
|
-
/**
|
|
191
|
-
* The id of the marketing event in the external event application.
|
|
192
|
-
*/
|
|
193
|
-
externalEventId: string;
|
|
194
|
-
}
|
|
195
|
-
|
|
196
|
-
export type SearchIdentifiersByExternalEventIdOutput =
|
|
197
|
-
Schemas.CollectionResponseWithTotalMarketingEventIdentifiersResponse;
|
|
198
|
-
}
|
|
199
|
-
|
|
200
|
-
export namespace ListAssociations {
|
|
201
|
-
export interface AssociateByExternalAccountInput {
|
|
202
|
-
/**
|
|
203
|
-
* The accountId that is associated with this marketing event in the external event application.
|
|
204
|
-
*/
|
|
205
|
-
externalAccountId: string;
|
|
206
|
-
/**
|
|
207
|
-
* The id of the marketing event in the external event application.
|
|
208
|
-
*/
|
|
209
|
-
externalEventId: string;
|
|
210
|
-
/**
|
|
211
|
-
* The ILS ID of the list.
|
|
212
|
-
*/
|
|
213
|
-
listId: string;
|
|
214
|
-
}
|
|
215
|
-
|
|
216
|
-
export type AssociateByExternalAccountOutput = void;
|
|
217
|
-
|
|
218
|
-
export interface AssociateInput {
|
|
219
|
-
/**
|
|
220
|
-
* The ILS ID of the list.
|
|
221
|
-
*/
|
|
222
|
-
listId: string;
|
|
223
|
-
/**
|
|
224
|
-
* The internal id of the marketing event in HubSpot.
|
|
225
|
-
*/
|
|
226
|
-
marketingEventId: string;
|
|
227
|
-
}
|
|
228
|
-
|
|
229
|
-
export type AssociateOutput = void;
|
|
230
|
-
|
|
231
|
-
export interface DeleteByExternalAccountInput {
|
|
232
|
-
/**
|
|
233
|
-
* The accountId that is associated with this marketing event in the external event application.
|
|
234
|
-
*/
|
|
235
|
-
externalAccountId: string;
|
|
236
|
-
/**
|
|
237
|
-
* The id of the marketing event in the external event application.
|
|
238
|
-
*/
|
|
239
|
-
externalEventId: string;
|
|
240
|
-
/**
|
|
241
|
-
* The ILS ID of the list.
|
|
242
|
-
*/
|
|
243
|
-
listId: string;
|
|
244
|
-
}
|
|
245
|
-
|
|
246
|
-
export type DeleteByExternalAccountOutput = void;
|
|
247
|
-
|
|
248
|
-
export interface DeleteInput {
|
|
249
|
-
/**
|
|
250
|
-
* The ILS ID of the list.
|
|
251
|
-
*/
|
|
252
|
-
listId: string;
|
|
253
|
-
/**
|
|
254
|
-
* The internal id of the marketing event in HubSpot.
|
|
255
|
-
*/
|
|
256
|
-
marketingEventId: string;
|
|
257
|
-
}
|
|
258
|
-
|
|
259
|
-
export type DeleteOutput = void;
|
|
260
|
-
|
|
261
|
-
export interface ListByExternalAccountInput {
|
|
262
|
-
/**
|
|
263
|
-
* The accountId that is associated with this marketing event in the external event application.
|
|
264
|
-
*/
|
|
265
|
-
externalAccountId: string;
|
|
266
|
-
/**
|
|
267
|
-
* The id of the marketing event in the external event application.
|
|
268
|
-
*/
|
|
269
|
-
externalEventId: string;
|
|
270
|
-
}
|
|
271
|
-
|
|
272
|
-
export type ListByExternalAccountOutput =
|
|
273
|
-
Schemas.CollectionResponseWithTotalPublicList;
|
|
274
|
-
|
|
275
|
-
export interface ListInput {
|
|
276
|
-
/**
|
|
277
|
-
* The internal id of the marketing event in HubSpot.
|
|
278
|
-
*/
|
|
279
|
-
marketingEventId: string;
|
|
280
|
-
}
|
|
281
|
-
|
|
282
|
-
export type ListOutput = Schemas.CollectionResponseWithTotalPublicList;
|
|
283
|
-
}
|
|
284
|
-
|
|
285
|
-
export namespace ParticipantState {
|
|
286
|
-
export interface GetByExternalAccountAndEventIdInput {
|
|
287
|
-
/**
|
|
288
|
-
* The accountId that is associated with this marketing event in the external event application.
|
|
289
|
-
*/
|
|
290
|
-
externalAccountId: string;
|
|
291
|
-
/**
|
|
292
|
-
* The id of the marketing event in the external event application.
|
|
293
|
-
*/
|
|
294
|
-
externalEventId: string;
|
|
295
|
-
}
|
|
296
|
-
|
|
297
|
-
export type GetByExternalAccountAndEventIdOutput =
|
|
298
|
-
Schemas.AttendanceCounters;
|
|
299
|
-
|
|
300
|
-
export interface GetByIdInput {
|
|
301
|
-
/**
|
|
302
|
-
* The internal id of the marketing event in HubSpot.
|
|
303
|
-
*/
|
|
304
|
-
marketingEventId: number;
|
|
305
|
-
}
|
|
306
|
-
|
|
307
|
-
export type GetByIdOutput = Schemas.AttendanceCounters;
|
|
308
|
-
|
|
309
|
-
export interface ListBreakdownByContactInput {
|
|
310
|
-
/**
|
|
311
|
-
* The cursor indicating the position of the last retrieved item.
|
|
312
|
-
*/
|
|
313
|
-
after?: string;
|
|
314
|
-
/**
|
|
315
|
-
* The identifier of the Contact. It may be email or internal id.
|
|
316
|
-
*/
|
|
317
|
-
contactIdentifier: string;
|
|
318
|
-
/**
|
|
319
|
-
* The limit for response size. The default value is 10, the max number is 100
|
|
320
|
-
*/
|
|
321
|
-
limit?: number;
|
|
322
|
-
/**
|
|
323
|
-
* The participation state value. It may be REGISTERED, CANCELLED, ATTENDED, NO_SHOW
|
|
324
|
-
*/
|
|
325
|
-
state?: string;
|
|
326
|
-
}
|
|
327
|
-
|
|
328
|
-
export type ListBreakdownByContactOutput =
|
|
329
|
-
Schemas.CollectionResponseWithTotalParticipationBreakdown;
|
|
330
|
-
|
|
331
|
-
export interface ListBreakdownByExternalAccountAndEventIdInput {
|
|
332
|
-
/**
|
|
333
|
-
* The cursor indicating the position of the last retrieved item.
|
|
334
|
-
*/
|
|
335
|
-
after?: string;
|
|
336
|
-
/**
|
|
337
|
-
* The identifier of the Contact. It may be email or internal id.
|
|
338
|
-
*/
|
|
339
|
-
contactIdentifier?: string;
|
|
340
|
-
/**
|
|
341
|
-
* The accountId that is associated with this marketing event in the external event application.
|
|
342
|
-
*/
|
|
343
|
-
externalAccountId: string;
|
|
344
|
-
/**
|
|
345
|
-
* The id of the marketing event in the external event application.
|
|
346
|
-
*/
|
|
347
|
-
externalEventId: string;
|
|
348
|
-
/**
|
|
349
|
-
* The limit for response size. The default value is 10, the max number is 100
|
|
350
|
-
*/
|
|
351
|
-
limit?: number;
|
|
352
|
-
/**
|
|
353
|
-
* The participation state value. It may be REGISTERED, CANCELLED, ATTENDED, NO_SHOW
|
|
354
|
-
*/
|
|
355
|
-
state?: string;
|
|
356
|
-
}
|
|
357
|
-
|
|
358
|
-
export type ListBreakdownByExternalAccountAndEventIdOutput =
|
|
359
|
-
Schemas.CollectionResponseWithTotalParticipationBreakdown;
|
|
360
|
-
|
|
361
|
-
export interface ListBreakdownByIdInput {
|
|
362
|
-
/**
|
|
363
|
-
* The cursor indicating the position of the last retrieved item.
|
|
364
|
-
*/
|
|
365
|
-
after?: string;
|
|
366
|
-
/**
|
|
367
|
-
* The identifier of the Contact. It may be email or internal id.
|
|
368
|
-
*/
|
|
369
|
-
contactIdentifier?: string;
|
|
370
|
-
/**
|
|
371
|
-
* The limit for response size. The default value is 10, the max number is 100
|
|
372
|
-
*/
|
|
373
|
-
limit?: number;
|
|
374
|
-
/**
|
|
375
|
-
* The internal id of the marketing event in HubSpot.
|
|
376
|
-
*/
|
|
377
|
-
marketingEventId: number;
|
|
378
|
-
/**
|
|
379
|
-
* The participation state value. It may be REGISTERED, CANCELLED, ATTENDED, NO_SHOW
|
|
380
|
-
*/
|
|
381
|
-
state?: string;
|
|
382
|
-
}
|
|
383
|
-
|
|
384
|
-
export type ListBreakdownByIdOutput =
|
|
385
|
-
Schemas.CollectionResponseWithTotalParticipationBreakdown;
|
|
386
|
-
}
|
|
387
|
-
|
|
388
|
-
export namespace Schemas {
|
|
389
|
-
export interface AppInfo {
|
|
390
|
-
/**
|
|
391
|
-
* The ID of the application
|
|
392
|
-
*/
|
|
393
|
-
id: string;
|
|
394
|
-
/**
|
|
395
|
-
* The name of the application
|
|
396
|
-
*/
|
|
397
|
-
name: string;
|
|
398
|
-
}
|
|
399
|
-
|
|
400
|
-
export interface AttendanceCounters {
|
|
401
|
-
/**
|
|
402
|
-
* Number of attended contact records of a marketing event
|
|
403
|
-
*/
|
|
404
|
-
attended: number;
|
|
405
|
-
/**
|
|
406
|
-
* Number of cancelled contact records of a marketing event
|
|
407
|
-
*/
|
|
408
|
-
cancelled: number;
|
|
409
|
-
/**
|
|
410
|
-
* Number of no-show contact records of a marketing event
|
|
411
|
-
*/
|
|
412
|
-
noShows: number;
|
|
413
|
-
/**
|
|
414
|
-
* Number of registered contact records of a marketing event
|
|
415
|
-
*/
|
|
416
|
-
registered: number;
|
|
417
|
-
}
|
|
418
|
-
|
|
419
|
-
export interface BatchInputMarketingEventCreateRequestParams {
|
|
420
|
-
inputs: Schemas.MarketingEventCreateRequestParams[];
|
|
421
|
-
}
|
|
422
|
-
|
|
423
|
-
export interface BatchInputMarketingEventEmailSubscriber {
|
|
424
|
-
/**
|
|
425
|
-
* List of marketing event details to create or update
|
|
426
|
-
*/
|
|
427
|
-
inputs: Schemas.MarketingEventEmailSubscriber[];
|
|
428
|
-
}
|
|
429
|
-
|
|
430
|
-
export interface BatchInputMarketingEventExternalUniqueIdentifier {
|
|
431
|
-
inputs: Schemas.MarketingEventExternalUniqueIdentifier[];
|
|
432
|
-
}
|
|
433
|
-
|
|
434
|
-
export interface BatchInputMarketingEventPublicObjectIdDeleteRequest {
|
|
435
|
-
inputs: Schemas.MarketingEventPublicObjectIdDeleteRequest[];
|
|
436
|
-
}
|
|
437
|
-
|
|
438
|
-
export interface BatchInputMarketingEventPublicUpdateRequestFullV2 {
|
|
439
|
-
inputs: Schemas.MarketingEventPublicUpdateRequestFullV2[];
|
|
440
|
-
}
|
|
441
|
-
|
|
442
|
-
export interface BatchInputMarketingEventSubscriber {
|
|
443
|
-
/**
|
|
444
|
-
* List of HubSpot contacts to subscribe to the marketing event
|
|
445
|
-
*/
|
|
446
|
-
inputs: Schemas.MarketingEventSubscriber[];
|
|
447
|
-
}
|
|
448
|
-
|
|
449
|
-
export interface BatchResponseMarketingEventPublicDefaultResponse {
|
|
450
|
-
/**
|
|
451
|
-
* Timestamp of when the request was completed.
|
|
452
|
-
*/
|
|
453
|
-
completedAt: string;
|
|
454
|
-
errors?: Schemas.StandardError[];
|
|
455
|
-
/**
|
|
456
|
-
* Result of the request.
|
|
457
|
-
*/
|
|
458
|
-
links?: Record<string, string>;
|
|
459
|
-
/**
|
|
460
|
-
* The number of errors that occurred during the request.
|
|
461
|
-
*/
|
|
462
|
-
numErrors?: number;
|
|
463
|
-
/**
|
|
464
|
-
* Timestamp of when the request was sent.
|
|
465
|
-
*/
|
|
466
|
-
requestedAt?: string;
|
|
467
|
-
results: Schemas.MarketingEventPublicDefaultResponse[];
|
|
468
|
-
/**
|
|
469
|
-
* Timestamp of when the request started processing.
|
|
470
|
-
*/
|
|
471
|
-
startedAt: string;
|
|
472
|
-
/**
|
|
473
|
-
* Status of the response.
|
|
474
|
-
*/
|
|
475
|
-
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
476
|
-
}
|
|
477
|
-
|
|
478
|
-
export interface BatchResponseMarketingEventPublicDefaultResponseV2 {
|
|
479
|
-
/**
|
|
480
|
-
* Timestamp of when the request was processed.
|
|
481
|
-
*/
|
|
482
|
-
completedAt: string;
|
|
483
|
-
/**
|
|
484
|
-
* Result object of the request.
|
|
485
|
-
*/
|
|
486
|
-
links?: Record<string, string>;
|
|
487
|
-
/**
|
|
488
|
-
* Timestamp of when the request was sent.
|
|
489
|
-
*/
|
|
490
|
-
requestedAt?: string;
|
|
491
|
-
results: Schemas.MarketingEventPublicDefaultResponseV2[];
|
|
492
|
-
/**
|
|
493
|
-
* Timestamp of when the request started processing.
|
|
494
|
-
*/
|
|
495
|
-
startedAt: string;
|
|
496
|
-
/**
|
|
497
|
-
* The status of the response.
|
|
498
|
-
*/
|
|
499
|
-
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
500
|
-
}
|
|
501
|
-
|
|
502
|
-
export interface BatchResponseSubscriberEmailResponse {
|
|
503
|
-
/**
|
|
504
|
-
* Timestamp that represents when the request finished processing
|
|
505
|
-
*/
|
|
506
|
-
completedAt: string;
|
|
507
|
-
errors?: Schemas.StandardError[];
|
|
508
|
-
/**
|
|
509
|
-
* Result of the request
|
|
510
|
-
*/
|
|
511
|
-
links?: Record<string, string>;
|
|
512
|
-
/**
|
|
513
|
-
* The number of errors that occurred during the processing
|
|
514
|
-
*/
|
|
515
|
-
numErrors?: number;
|
|
516
|
-
/**
|
|
517
|
-
* Timestamp that represents when the request was made
|
|
518
|
-
*/
|
|
519
|
-
requestedAt?: string;
|
|
520
|
-
results: Schemas.SubscriberEmailResponse[];
|
|
521
|
-
/**
|
|
522
|
-
* Timestamp that represents when the request started processing
|
|
523
|
-
*/
|
|
524
|
-
startedAt: string;
|
|
525
|
-
/**
|
|
526
|
-
* The status of the request processing
|
|
527
|
-
*/
|
|
528
|
-
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
529
|
-
}
|
|
530
|
-
|
|
531
|
-
export interface BatchResponseSubscriberVidResponse {
|
|
532
|
-
/**
|
|
533
|
-
* Timestamp that represents when the request finished processing
|
|
534
|
-
*/
|
|
535
|
-
completedAt: string;
|
|
536
|
-
errors?: Schemas.StandardError[];
|
|
537
|
-
/**
|
|
538
|
-
* Result of the request
|
|
539
|
-
*/
|
|
540
|
-
links?: Record<string, string>;
|
|
541
|
-
/**
|
|
542
|
-
* The number of errors that occurred during the processing
|
|
543
|
-
*/
|
|
544
|
-
numErrors?: number;
|
|
545
|
-
/**
|
|
546
|
-
* Timestamp that represents when the request was made
|
|
547
|
-
*/
|
|
548
|
-
requestedAt?: string;
|
|
549
|
-
results: Schemas.SubscriberVidResponse[];
|
|
550
|
-
/**
|
|
551
|
-
* Timestamp that represents when the request started processing
|
|
552
|
-
*/
|
|
553
|
-
startedAt: string;
|
|
554
|
-
/**
|
|
555
|
-
* The status of the request processing
|
|
556
|
-
*/
|
|
557
|
-
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
558
|
-
}
|
|
559
|
-
|
|
560
|
-
export interface CollectionResponseMarketingEventPublicReadResponseV2ForwardPaging {
|
|
561
|
-
paging?: Schemas.ForwardPaging;
|
|
562
|
-
results: Schemas.MarketingEventPublicReadResponseV2[];
|
|
563
|
-
}
|
|
564
|
-
|
|
565
|
-
export interface CollectionResponseSearchPublicResponseWrapperNoPaging {
|
|
566
|
-
results: Schemas.SearchPublicResponseWrapper[];
|
|
567
|
-
}
|
|
568
|
-
|
|
569
|
-
export interface CollectionResponseWithTotalMarketingEventIdentifiersResponse {
|
|
570
|
-
paging?: Schemas.Paging;
|
|
571
|
-
results: Schemas.MarketingEventIdentifiersResponse[];
|
|
572
|
-
total: number;
|
|
573
|
-
}
|
|
574
|
-
|
|
575
|
-
export interface CollectionResponseWithTotalParticipationBreakdown {
|
|
576
|
-
paging?: Schemas.Paging;
|
|
577
|
-
results: Schemas.ParticipationBreakdown[];
|
|
578
|
-
total: number;
|
|
579
|
-
}
|
|
580
|
-
|
|
581
|
-
export interface CollectionResponseWithTotalPublicList {
|
|
582
|
-
paging?: Schemas.Paging;
|
|
583
|
-
results: Schemas.PublicList[];
|
|
584
|
-
total: number;
|
|
585
|
-
}
|
|
586
|
-
|
|
587
|
-
export interface ContactAssociation {
|
|
588
|
-
/**
|
|
589
|
-
* The internal ID of the contact in HubSpot
|
|
590
|
-
*/
|
|
591
|
-
contactId: string;
|
|
592
|
-
/**
|
|
593
|
-
* The email of the contact in HubSpot
|
|
594
|
-
*/
|
|
595
|
-
email: string;
|
|
596
|
-
/**
|
|
597
|
-
* The first name of the contact in HubSpot
|
|
598
|
-
*/
|
|
599
|
-
firstname?: string;
|
|
600
|
-
/**
|
|
601
|
-
* The last name of the contact in HubSpot
|
|
602
|
-
*/
|
|
603
|
-
lastname?: string;
|
|
604
|
-
}
|
|
605
|
-
|
|
606
|
-
export interface CrmPropertyWrapper {
|
|
607
|
-
/**
|
|
608
|
-
* The name of the property in the CRM
|
|
609
|
-
*/
|
|
610
|
-
name: string;
|
|
611
|
-
/**
|
|
612
|
-
* The value of the property in the CRM
|
|
613
|
-
*/
|
|
614
|
-
value: string;
|
|
615
|
-
}
|
|
616
|
-
|
|
617
|
-
export interface ErrorDetail {
|
|
618
|
-
/**
|
|
619
|
-
* The status code associated with the error detail
|
|
620
|
-
*/
|
|
621
|
-
code?: string;
|
|
622
|
-
/**
|
|
623
|
-
* Context about the error condition
|
|
624
|
-
*/
|
|
625
|
-
context?: Record<string, string[]>;
|
|
626
|
-
/**
|
|
627
|
-
* The name of the field or parameter in which the error was found.
|
|
628
|
-
*/
|
|
629
|
-
in?: string;
|
|
630
|
-
/**
|
|
631
|
-
* A human readable message describing the error along with remediation steps where appropriate
|
|
632
|
-
*/
|
|
633
|
-
message: string;
|
|
634
|
-
/**
|
|
635
|
-
* A specific category that contains more specific detail about the error
|
|
636
|
-
*/
|
|
637
|
-
subCategory?: string;
|
|
638
|
-
}
|
|
639
|
-
|
|
640
|
-
export interface EventDetailSettings {
|
|
641
|
-
/**
|
|
642
|
-
* The id of the application the settings are for
|
|
643
|
-
*/
|
|
644
|
-
appId: number;
|
|
645
|
-
/**
|
|
646
|
-
* The url that will be used to fetch marketing event details by id
|
|
647
|
-
*/
|
|
648
|
-
eventDetailsUrl: string;
|
|
649
|
-
}
|
|
650
|
-
|
|
651
|
-
export interface EventDetailSettingsUrl {
|
|
652
|
-
/**
|
|
653
|
-
* The url that will be used to fetch marketing event details by id. Must contain a `%s` character sequence that will be substituted with the event id. For example: `https://my.event.app/events/%s`
|
|
654
|
-
*/
|
|
655
|
-
eventDetailsUrl: string;
|
|
656
|
-
}
|
|
657
|
-
|
|
658
|
-
export interface ForwardPaging {
|
|
659
|
-
next?: Schemas.NextPage;
|
|
660
|
-
}
|
|
661
|
-
|
|
662
|
-
export interface MarketingEventAssociation {
|
|
663
|
-
/**
|
|
664
|
-
* The account ID that is associated with this marketing event in the external event application
|
|
665
|
-
*/
|
|
666
|
-
externalAccountId?: string;
|
|
667
|
-
/**
|
|
668
|
-
* The event ID that is associated with this marketing event in the external event application
|
|
669
|
-
*/
|
|
670
|
-
externalEventId?: string;
|
|
671
|
-
/**
|
|
672
|
-
* The internal ID of the marketing event in HubSpot
|
|
673
|
-
*/
|
|
674
|
-
marketingEventId: string;
|
|
675
|
-
/**
|
|
676
|
-
* The name of the marketing event in HubSpot
|
|
677
|
-
*/
|
|
678
|
-
name: string;
|
|
679
|
-
}
|
|
680
|
-
|
|
681
|
-
export interface MarketingEventCompleteRequestParams {
|
|
682
|
-
/**
|
|
683
|
-
* The end date and time of the marketing event in ISO 8601 format
|
|
684
|
-
*/
|
|
685
|
-
endDateTime: string;
|
|
686
|
-
/**
|
|
687
|
-
* The start date and time of the marketing event in ISO 8601 format
|
|
688
|
-
*/
|
|
689
|
-
startDateTime: string;
|
|
690
|
-
}
|
|
691
|
-
|
|
692
|
-
export interface MarketingEventCreateRequestParams {
|
|
693
|
-
/**
|
|
694
|
-
* A list of PropertyValues. These can be whatever kind of property names and values you want. However, they must already exist on the HubSpot account's definition of the MarketingEvent Object. If they don't they will be filtered out and not set.
|
|
695
|
-
* In order to do this you'll need to create a new PropertyGroup on the HubSpot account's MarketingEvent object for your specific app and create the Custom Property you want to track on that HubSpot account. Do not create any new default properties on the MarketingEvent object as that will apply to all HubSpot accounts.
|
|
696
|
-
*
|
|
697
|
-
*/
|
|
698
|
-
customProperties: Schemas.PropertyValue[];
|
|
699
|
-
/**
|
|
700
|
-
* The end date and time of the marketing event.
|
|
701
|
-
*/
|
|
702
|
-
endDateTime?: string;
|
|
703
|
-
/**
|
|
704
|
-
* Indicates if the marketing event has been cancelled. Defaults to `false`
|
|
705
|
-
*/
|
|
706
|
-
eventCancelled?: boolean;
|
|
707
|
-
/**
|
|
708
|
-
* Indicates if the marketing event has been completed. Defaults to `false`
|
|
709
|
-
*/
|
|
710
|
-
eventCompleted?: boolean;
|
|
711
|
-
/**
|
|
712
|
-
* The description of the marketing event.
|
|
713
|
-
*/
|
|
714
|
-
eventDescription?: string;
|
|
715
|
-
/**
|
|
716
|
-
* The name of the marketing event.
|
|
717
|
-
*/
|
|
718
|
-
eventName: string;
|
|
719
|
-
/**
|
|
720
|
-
* The name of the organizer of the marketing event.
|
|
721
|
-
*/
|
|
722
|
-
eventOrganizer: string;
|
|
723
|
-
/**
|
|
724
|
-
* Describes what type of event this is. For example: `WEBINAR`, `CONFERENCE`, `WORKSHOP`
|
|
725
|
-
*/
|
|
726
|
-
eventType?: string;
|
|
727
|
-
/**
|
|
728
|
-
* A URL in the external event application where the marketing event can be managed.
|
|
729
|
-
*/
|
|
730
|
-
eventUrl?: string;
|
|
731
|
-
/**
|
|
732
|
-
* The accountId that is associated with this marketing event in the external event application.
|
|
733
|
-
*/
|
|
734
|
-
externalAccountId: string;
|
|
735
|
-
/**
|
|
736
|
-
* The id of the marketing event in the external event application.
|
|
737
|
-
*/
|
|
738
|
-
externalEventId: string;
|
|
739
|
-
/**
|
|
740
|
-
* The start date and time of the marketing event.
|
|
741
|
-
*/
|
|
742
|
-
startDateTime?: string;
|
|
743
|
-
}
|
|
744
|
-
|
|
745
|
-
export interface MarketingEventDefaultResponse {
|
|
746
|
-
/**
|
|
747
|
-
* A list of PropertyValues. These can be whatever kind of property names and values you want. However, they must already exist on the HubSpot account's definition of the MarketingEvent Object. If they don't they will be filtered out and not set.
|
|
748
|
-
* In order to do this you'll need to create a new PropertyGroup on the HubSpot account's MarketingEvent object for your specific app and create the Custom Property you want to track on that HubSpot account. Do not create any new default properties on the MarketingEvent object as that will apply to all HubSpot accounts.
|
|
749
|
-
*
|
|
750
|
-
*/
|
|
751
|
-
customProperties: Schemas.PropertyValue[];
|
|
752
|
-
/**
|
|
753
|
-
* The end date and time of the marketing event.
|
|
754
|
-
*/
|
|
755
|
-
endDateTime?: string;
|
|
756
|
-
/**
|
|
757
|
-
* Indicates if the marketing event has been cancelled.
|
|
758
|
-
*/
|
|
759
|
-
eventCancelled?: boolean;
|
|
760
|
-
/**
|
|
761
|
-
* Indicates if the marketing event has been completed.
|
|
762
|
-
*/
|
|
763
|
-
eventCompleted?: boolean;
|
|
764
|
-
/**
|
|
765
|
-
* The description of the marketing event.
|
|
766
|
-
*/
|
|
767
|
-
eventDescription?: string;
|
|
768
|
-
/**
|
|
769
|
-
* The name of the marketing event.
|
|
770
|
-
*/
|
|
771
|
-
eventName: string;
|
|
772
|
-
/**
|
|
773
|
-
* The name of the organizer of the marketing event.
|
|
774
|
-
*/
|
|
775
|
-
eventOrganizer: string;
|
|
776
|
-
/**
|
|
777
|
-
* The type of the marketing event.
|
|
778
|
-
*/
|
|
779
|
-
eventType?: string;
|
|
780
|
-
/**
|
|
781
|
-
* The URL in the external event application where the marketing event can be managed.
|
|
782
|
-
*/
|
|
783
|
-
eventUrl?: string;
|
|
784
|
-
/**
|
|
785
|
-
* The ID of the marketing event CRM object
|
|
786
|
-
*/
|
|
787
|
-
objectId?: string;
|
|
788
|
-
/**
|
|
789
|
-
* The start date and time of the marketing event.
|
|
790
|
-
*/
|
|
791
|
-
startDateTime?: string;
|
|
792
|
-
}
|
|
793
|
-
|
|
794
|
-
export interface MarketingEventEmailSubscriber {
|
|
795
|
-
/**
|
|
796
|
-
* The key-value set that contains properties of the contact.
|
|
797
|
-
*/
|
|
798
|
-
contactProperties: Record<string, string>;
|
|
799
|
-
/**
|
|
800
|
-
* The email address of the contact in HubSpot to associate with the event.
|
|
801
|
-
*/
|
|
802
|
-
email: string;
|
|
803
|
-
/**
|
|
804
|
-
* Timestamp in milliseconds at which the contact subscribed to the event.
|
|
805
|
-
*/
|
|
806
|
-
interactionDateTime: number;
|
|
807
|
-
/**
|
|
808
|
-
* The key-value set that contains properties of the marketing event.
|
|
809
|
-
*/
|
|
810
|
-
properties: Record<string, string>;
|
|
811
|
-
}
|
|
812
|
-
|
|
813
|
-
export interface MarketingEventExternalUniqueIdentifier {
|
|
814
|
-
/**
|
|
815
|
-
* The id of the application that created the marketing event in HubSpot.
|
|
816
|
-
*/
|
|
817
|
-
appId: number;
|
|
818
|
-
/**
|
|
819
|
-
* The accountId that is associated with this marketing event in the external event application.
|
|
820
|
-
*/
|
|
821
|
-
externalAccountId: string;
|
|
822
|
-
/**
|
|
823
|
-
* The id of the marketing event in the external event application.
|
|
824
|
-
*/
|
|
825
|
-
externalEventId: string;
|
|
826
|
-
}
|
|
827
|
-
|
|
828
|
-
export interface MarketingEventIdentifiersResponse {
|
|
829
|
-
appInfo?: Schemas.AppInfo;
|
|
830
|
-
/**
|
|
831
|
-
* The accountId that is associated with this marketing event in the external event application
|
|
832
|
-
*/
|
|
833
|
-
externalAccountId?: string;
|
|
834
|
-
/**
|
|
835
|
-
* The ID that is associated with this marketing event in the external event application
|
|
836
|
-
*/
|
|
837
|
-
externalEventId: string;
|
|
838
|
-
/**
|
|
839
|
-
* The name of the marketing event
|
|
840
|
-
*/
|
|
841
|
-
marketingEventName: string;
|
|
842
|
-
/**
|
|
843
|
-
* The internal ID of the marketing event in HubSpot CRM
|
|
844
|
-
*/
|
|
845
|
-
objectId: string;
|
|
846
|
-
}
|
|
847
|
-
|
|
848
|
-
export interface MarketingEventPublicDefaultResponse {
|
|
849
|
-
/**
|
|
850
|
-
* The creation date and time of the marketing event.
|
|
851
|
-
*/
|
|
852
|
-
createdAt: string;
|
|
853
|
-
/**
|
|
854
|
-
* A list of PropertyValues. These can be whatever kind of property names and values you want. However, they must already exist on the HubSpot account's definition of the MarketingEvent Object. If they don't they will be filtered out and not set.
|
|
855
|
-
* In order to do this you'll need to create a new PropertyGroup on the HubSpot account's MarketingEvent object for your specific app and create the Custom Property you want to track on that HubSpot account. Do not create any new default properties on the MarketingEvent object as that will apply to all HubSpot accounts.
|
|
856
|
-
*
|
|
857
|
-
*/
|
|
858
|
-
customProperties: Schemas.PropertyValue[];
|
|
859
|
-
/**
|
|
860
|
-
* The end date and time of the marketing event.
|
|
861
|
-
*/
|
|
862
|
-
endDateTime?: string;
|
|
863
|
-
/**
|
|
864
|
-
* Indicates if the marketing event has been cancelled.
|
|
865
|
-
*/
|
|
866
|
-
eventCancelled?: boolean;
|
|
867
|
-
/**
|
|
868
|
-
* Indicates if the marketing event has been completed.
|
|
869
|
-
*/
|
|
870
|
-
eventCompleted?: boolean;
|
|
871
|
-
/**
|
|
872
|
-
* The description of the marketing event.
|
|
873
|
-
*/
|
|
874
|
-
eventDescription?: string;
|
|
875
|
-
/**
|
|
876
|
-
* The name of the marketing event.
|
|
877
|
-
*/
|
|
878
|
-
eventName: string;
|
|
879
|
-
/**
|
|
880
|
-
* The name of the organizer of the marketing event.
|
|
881
|
-
*/
|
|
882
|
-
eventOrganizer: string;
|
|
883
|
-
/**
|
|
884
|
-
* The type of the marketing event.
|
|
885
|
-
*/
|
|
886
|
-
eventType?: string;
|
|
887
|
-
/**
|
|
888
|
-
* A URL in the external event application where the marketing event can be managed.
|
|
889
|
-
*/
|
|
890
|
-
eventUrl?: string;
|
|
891
|
-
/**
|
|
892
|
-
* The ID of the marketing event CRM object.
|
|
893
|
-
*/
|
|
894
|
-
id: string;
|
|
895
|
-
/**
|
|
896
|
-
* The ID of the marketing event CRM object.
|
|
897
|
-
*/
|
|
898
|
-
objectId?: string;
|
|
899
|
-
/**
|
|
900
|
-
* The start date and time of the marketing event.
|
|
901
|
-
*/
|
|
902
|
-
startDateTime?: string;
|
|
903
|
-
/**
|
|
904
|
-
* The update date and time of the marketing event.
|
|
905
|
-
*/
|
|
906
|
-
updatedAt: string;
|
|
907
|
-
}
|
|
908
|
-
|
|
909
|
-
export interface MarketingEventPublicDefaultResponseV2 {
|
|
910
|
-
appInfo?: Schemas.AppInfo;
|
|
911
|
-
/**
|
|
912
|
-
* The creation date and time of the marketing event
|
|
913
|
-
*/
|
|
914
|
-
createdAt: string;
|
|
915
|
-
customProperties: Schemas.CrmPropertyWrapper[];
|
|
916
|
-
/**
|
|
917
|
-
* The end date and time of the marketing event
|
|
918
|
-
*/
|
|
919
|
-
endDateTime?: string;
|
|
920
|
-
/**
|
|
921
|
-
* Indicates if the marketing event has been cancelled
|
|
922
|
-
*/
|
|
923
|
-
eventCancelled?: boolean;
|
|
924
|
-
/**
|
|
925
|
-
* Indicates if the marketing event has been completed
|
|
926
|
-
*/
|
|
927
|
-
eventCompleted?: boolean;
|
|
928
|
-
/**
|
|
929
|
-
* The description of the marketing event
|
|
930
|
-
*/
|
|
931
|
-
eventDescription?: string;
|
|
932
|
-
/**
|
|
933
|
-
* The name of the marketing event
|
|
934
|
-
*/
|
|
935
|
-
eventName: string;
|
|
936
|
-
/**
|
|
937
|
-
* The name of the organizer of the marketing event
|
|
938
|
-
*/
|
|
939
|
-
eventOrganizer?: string;
|
|
940
|
-
/**
|
|
941
|
-
* The type of the marketing event
|
|
942
|
-
*/
|
|
943
|
-
eventType?: string;
|
|
944
|
-
/**
|
|
945
|
-
* A URL in the external event application where the marketing event can be managed
|
|
946
|
-
*/
|
|
947
|
-
eventUrl?: string;
|
|
948
|
-
/**
|
|
949
|
-
* The internal ID of the marketing event in HubSpot
|
|
950
|
-
*/
|
|
951
|
-
objectId: string;
|
|
952
|
-
/**
|
|
953
|
-
* The start date and time of the marketing event
|
|
954
|
-
*/
|
|
955
|
-
startDateTime?: string;
|
|
956
|
-
/**
|
|
957
|
-
* The update date and time of the marketing event
|
|
958
|
-
*/
|
|
959
|
-
updatedAt: string;
|
|
960
|
-
}
|
|
961
|
-
|
|
962
|
-
export interface MarketingEventPublicObjectIdDeleteRequest {
|
|
963
|
-
/**
|
|
964
|
-
* The internal ID of the marketing event in HubSpot
|
|
965
|
-
*/
|
|
966
|
-
objectId: string;
|
|
967
|
-
}
|
|
968
|
-
|
|
969
|
-
export interface MarketingEventPublicReadResponse {
|
|
970
|
-
/**
|
|
971
|
-
* The number of HubSpot contacts that attended this marketing event.
|
|
972
|
-
*/
|
|
973
|
-
attendees: number;
|
|
974
|
-
/**
|
|
975
|
-
* The number of HubSpot contacts that registered for this marketing event, but later cancelled their registration.
|
|
976
|
-
*/
|
|
977
|
-
cancellations: number;
|
|
978
|
-
/**
|
|
979
|
-
* The creation date and time of the marketing event.
|
|
980
|
-
*/
|
|
981
|
-
createdAt: string;
|
|
982
|
-
/**
|
|
983
|
-
* A list of PropertyValues. These can be whatever kind of property names and values you want. However, they must already exist on the HubSpot account's definition of the MarketingEvent Object. If they don't they will be filtered out and not set.
|
|
984
|
-
* In order to do this you'll need to create a new PropertyGroup on the HubSpot account's MarketingEvent object for your specific app and create the Custom Property you want to track on that HubSpot account. Do not create any new default properties on the MarketingEvent object as that will apply to all HubSpot accounts.
|
|
985
|
-
*
|
|
986
|
-
*/
|
|
987
|
-
customProperties: Schemas.PropertyValue[];
|
|
988
|
-
/**
|
|
989
|
-
* The end date and time of the marketing event.
|
|
990
|
-
*/
|
|
991
|
-
endDateTime?: string;
|
|
992
|
-
/**
|
|
993
|
-
* Indicates if the marketing event has been cancelled.
|
|
994
|
-
*/
|
|
995
|
-
eventCancelled?: boolean;
|
|
996
|
-
/**
|
|
997
|
-
* Indicates if the marketing event has been completed.
|
|
998
|
-
*/
|
|
999
|
-
eventCompleted?: boolean;
|
|
1000
|
-
/**
|
|
1001
|
-
* The description of the marketing event.
|
|
1002
|
-
*/
|
|
1003
|
-
eventDescription?: string;
|
|
1004
|
-
/**
|
|
1005
|
-
* The name of the marketing event.
|
|
1006
|
-
*/
|
|
1007
|
-
eventName: string;
|
|
1008
|
-
/**
|
|
1009
|
-
* The name of the organizer of the marketing event.
|
|
1010
|
-
*/
|
|
1011
|
-
eventOrganizer: string;
|
|
1012
|
-
/**
|
|
1013
|
-
* The type of the marketing event.
|
|
1014
|
-
*/
|
|
1015
|
-
eventType?: string;
|
|
1016
|
-
/**
|
|
1017
|
-
* A URL in the external event application where the marketing event can be managed.
|
|
1018
|
-
*/
|
|
1019
|
-
eventUrl?: string;
|
|
1020
|
-
/**
|
|
1021
|
-
* The id of the marketing event in the external event application.
|
|
1022
|
-
*/
|
|
1023
|
-
externalEventId: string;
|
|
1024
|
-
/**
|
|
1025
|
-
* The ID of the marketing event CRM object.
|
|
1026
|
-
*/
|
|
1027
|
-
id: string;
|
|
1028
|
-
/**
|
|
1029
|
-
* The number of HubSpot contacts that registered for this marketing event, but did not attend. This field only had a value when the event is over.
|
|
1030
|
-
*/
|
|
1031
|
-
noShows: number;
|
|
1032
|
-
/**
|
|
1033
|
-
* The ID of the marketing event CRM object.
|
|
1034
|
-
*/
|
|
1035
|
-
objectId?: string;
|
|
1036
|
-
/**
|
|
1037
|
-
* The number of HubSpot contacts that registered for this marketing event.
|
|
1038
|
-
*/
|
|
1039
|
-
registrants: number;
|
|
1040
|
-
/**
|
|
1041
|
-
* The start date and time of the marketing event.
|
|
1042
|
-
*/
|
|
1043
|
-
startDateTime?: string;
|
|
1044
|
-
/**
|
|
1045
|
-
* The update date and time of the marketing event.
|
|
1046
|
-
*/
|
|
1047
|
-
updatedAt: string;
|
|
1048
|
-
}
|
|
1049
|
-
|
|
1050
|
-
export interface MarketingEventPublicReadResponseV2 {
|
|
1051
|
-
appInfo?: Schemas.AppInfo;
|
|
1052
|
-
/**
|
|
1053
|
-
* Number of attended contact records of a marketing event
|
|
1054
|
-
*/
|
|
1055
|
-
attendees?: number;
|
|
1056
|
-
/**
|
|
1057
|
-
* Number of cancelled contact records of a marketing event
|
|
1058
|
-
*/
|
|
1059
|
-
cancellations?: number;
|
|
1060
|
-
/**
|
|
1061
|
-
* The creation date and time of the marketing event
|
|
1062
|
-
*/
|
|
1063
|
-
createdAt: string;
|
|
1064
|
-
customProperties: Schemas.CrmPropertyWrapper[];
|
|
1065
|
-
/**
|
|
1066
|
-
* The end date and time of the marketing event
|
|
1067
|
-
*/
|
|
1068
|
-
endDateTime?: string;
|
|
1069
|
-
/**
|
|
1070
|
-
* Indicates if the marketing event has been cancelled
|
|
1071
|
-
*/
|
|
1072
|
-
eventCancelled?: boolean;
|
|
1073
|
-
/**
|
|
1074
|
-
* Indicates if the marketing event has been completed
|
|
1075
|
-
*/
|
|
1076
|
-
eventCompleted?: boolean;
|
|
1077
|
-
/**
|
|
1078
|
-
* The description of the marketing event
|
|
1079
|
-
*/
|
|
1080
|
-
eventDescription?: string;
|
|
1081
|
-
/**
|
|
1082
|
-
* The name of the marketing event
|
|
1083
|
-
*/
|
|
1084
|
-
eventName: string;
|
|
1085
|
-
/**
|
|
1086
|
-
* The name of the organizer of the marketing event
|
|
1087
|
-
*/
|
|
1088
|
-
eventOrganizer?: string;
|
|
1089
|
-
/**
|
|
1090
|
-
* The status of the marketing event
|
|
1091
|
-
*/
|
|
1092
|
-
eventStatus?: string;
|
|
1093
|
-
eventStatusV2?: string;
|
|
1094
|
-
/**
|
|
1095
|
-
* The type of the marketing event
|
|
1096
|
-
*/
|
|
1097
|
-
eventType?: string;
|
|
1098
|
-
/**
|
|
1099
|
-
* A URL in the external event application where the marketing event can be managed
|
|
1100
|
-
*/
|
|
1101
|
-
eventUrl?: string;
|
|
1102
|
-
/**
|
|
1103
|
-
* The ID that is associated with this marketing event in the external event application
|
|
1104
|
-
*/
|
|
1105
|
-
externalEventId?: string;
|
|
1106
|
-
/**
|
|
1107
|
-
* Number of no-show contact records of a marketing event
|
|
1108
|
-
*/
|
|
1109
|
-
noShows?: number;
|
|
1110
|
-
/**
|
|
1111
|
-
* The internal ID of the marketing event in HubSpot
|
|
1112
|
-
*/
|
|
1113
|
-
objectId: string;
|
|
1114
|
-
/**
|
|
1115
|
-
* Number of registered contact records of a marketing event
|
|
1116
|
-
*/
|
|
1117
|
-
registrants?: number;
|
|
1118
|
-
/**
|
|
1119
|
-
* The start date and time of the marketing event
|
|
1120
|
-
*/
|
|
1121
|
-
startDateTime?: string;
|
|
1122
|
-
/**
|
|
1123
|
-
* The update date and time of the marketing event
|
|
1124
|
-
*/
|
|
1125
|
-
updatedAt: string;
|
|
1126
|
-
}
|
|
1127
|
-
|
|
1128
|
-
export interface MarketingEventPublicUpdateRequestFullV2 {
|
|
1129
|
-
customProperties: Schemas.PropertyValue[];
|
|
1130
|
-
/**
|
|
1131
|
-
* The end date and time of the marketing event
|
|
1132
|
-
*/
|
|
1133
|
-
endDateTime?: string;
|
|
1134
|
-
/**
|
|
1135
|
-
* Indicates if the marketing event has been cancelled
|
|
1136
|
-
*/
|
|
1137
|
-
eventCancelled?: boolean;
|
|
1138
|
-
/**
|
|
1139
|
-
* The description of the marketing event
|
|
1140
|
-
*/
|
|
1141
|
-
eventDescription?: string;
|
|
1142
|
-
/**
|
|
1143
|
-
* The name of the marketing event
|
|
1144
|
-
*/
|
|
1145
|
-
eventName?: string;
|
|
1146
|
-
/**
|
|
1147
|
-
* The name of the organizer of the marketing event
|
|
1148
|
-
*/
|
|
1149
|
-
eventOrganizer?: string;
|
|
1150
|
-
/**
|
|
1151
|
-
* The type of the marketing event
|
|
1152
|
-
*/
|
|
1153
|
-
eventType?: string;
|
|
1154
|
-
/**
|
|
1155
|
-
* A URL in the external event application where the marketing event can be managed
|
|
1156
|
-
*/
|
|
1157
|
-
eventUrl?: string;
|
|
1158
|
-
/**
|
|
1159
|
-
* The internal ID of the marketing event in HubSpot
|
|
1160
|
-
*/
|
|
1161
|
-
objectId: string;
|
|
1162
|
-
/**
|
|
1163
|
-
* The start date and time of the marketing event
|
|
1164
|
-
*/
|
|
1165
|
-
startDateTime?: string;
|
|
1166
|
-
}
|
|
1167
|
-
|
|
1168
|
-
export interface MarketingEventPublicUpdateRequestV2 {
|
|
1169
|
-
customProperties: Schemas.PropertyValue[];
|
|
1170
|
-
/**
|
|
1171
|
-
* The end date and time of the marketing event
|
|
1172
|
-
*/
|
|
1173
|
-
endDateTime?: string;
|
|
1174
|
-
/**
|
|
1175
|
-
* Indicates if the marketing event has been cancelled
|
|
1176
|
-
*/
|
|
1177
|
-
eventCancelled?: boolean;
|
|
1178
|
-
/**
|
|
1179
|
-
* The description of the marketing event
|
|
1180
|
-
*/
|
|
1181
|
-
eventDescription?: string;
|
|
1182
|
-
/**
|
|
1183
|
-
* The name of the marketing event
|
|
1184
|
-
*/
|
|
1185
|
-
eventName?: string;
|
|
1186
|
-
/**
|
|
1187
|
-
* The name of the organizer of the marketing event
|
|
1188
|
-
*/
|
|
1189
|
-
eventOrganizer?: string;
|
|
1190
|
-
/**
|
|
1191
|
-
* The type of the marketing event
|
|
1192
|
-
*/
|
|
1193
|
-
eventType?: string;
|
|
1194
|
-
/**
|
|
1195
|
-
* A URL in the external event application where the marketing event can be managed
|
|
1196
|
-
*/
|
|
1197
|
-
eventUrl?: string;
|
|
1198
|
-
/**
|
|
1199
|
-
* The start date and time of the marketing event
|
|
1200
|
-
*/
|
|
1201
|
-
startDateTime?: string;
|
|
1202
|
-
}
|
|
1203
|
-
|
|
1204
|
-
export interface MarketingEventSubscriber {
|
|
1205
|
-
/**
|
|
1206
|
-
* Timestamp in milliseconds at which the contact subscribed to the event.
|
|
1207
|
-
*/
|
|
1208
|
-
interactionDateTime: number;
|
|
1209
|
-
/**
|
|
1210
|
-
* The key-value set of the properties of the contact
|
|
1211
|
-
*/
|
|
1212
|
-
properties: Record<string, string>;
|
|
1213
|
-
/**
|
|
1214
|
-
* The ID of the contact in HubSpot
|
|
1215
|
-
*/
|
|
1216
|
-
vid: number;
|
|
1217
|
-
}
|
|
1218
|
-
|
|
1219
|
-
export interface MarketingEventUpdateRequestParams {
|
|
1220
|
-
/**
|
|
1221
|
-
* A list of PropertyValues. These can be whatever kind of property names and values you want. However, they must already exist on the HubSpot account's definition of the MarketingEvent Object. If they don't they will be filtered out and not set.
|
|
1222
|
-
* In order to do this you'll need to create a new PropertyGroup on the HubSpot account's MarketingEvent object for your specific app and create the Custom Property you want to track on that HubSpot account. Do not create any new default properties on the MarketingEvent object as that will apply to all HubSpot accounts.
|
|
1223
|
-
*
|
|
1224
|
-
*/
|
|
1225
|
-
customProperties: Schemas.PropertyValue[];
|
|
1226
|
-
/**
|
|
1227
|
-
* The end date and time of the marketing event.
|
|
1228
|
-
*/
|
|
1229
|
-
endDateTime?: string;
|
|
1230
|
-
/**
|
|
1231
|
-
* Indicates if the marketing event has been cancelled. Defaults to `false`
|
|
1232
|
-
*/
|
|
1233
|
-
eventCancelled?: boolean;
|
|
1234
|
-
/**
|
|
1235
|
-
* Indicates if the marketing event has been completed. Defaults to `false`
|
|
1236
|
-
*/
|
|
1237
|
-
eventCompleted?: boolean;
|
|
1238
|
-
/**
|
|
1239
|
-
* The description of the marketing event.
|
|
1240
|
-
*/
|
|
1241
|
-
eventDescription?: string;
|
|
1242
|
-
/**
|
|
1243
|
-
* The name of the marketing event.
|
|
1244
|
-
*/
|
|
1245
|
-
eventName?: string;
|
|
1246
|
-
/**
|
|
1247
|
-
* The name of the organizer of the marketing event.
|
|
1248
|
-
*/
|
|
1249
|
-
eventOrganizer?: string;
|
|
1250
|
-
/**
|
|
1251
|
-
* Describes what type of event this is. For example: `WEBINAR`, `CONFERENCE`, `WORKSHOP`
|
|
1252
|
-
*/
|
|
1253
|
-
eventType?: string;
|
|
1254
|
-
/**
|
|
1255
|
-
* A URL in the external event application where the marketing event can be managed.
|
|
1256
|
-
*/
|
|
1257
|
-
eventUrl?: string;
|
|
1258
|
-
/**
|
|
1259
|
-
* The start date and time of the marketing event.
|
|
1260
|
-
*/
|
|
1261
|
-
startDateTime?: string;
|
|
1262
|
-
}
|
|
1263
|
-
|
|
1264
|
-
/**
|
|
1265
|
-
* Specifies the paging information needed to retrieve the next set of results in a paginated API response
|
|
1266
|
-
*/
|
|
1267
|
-
export interface NextPage {
|
|
1268
|
-
/**
|
|
1269
|
-
* The ID element at the start of the page
|
|
1270
|
-
*/
|
|
1271
|
-
after: string;
|
|
1272
|
-
/**
|
|
1273
|
-
* Link to the next page
|
|
1274
|
-
*/
|
|
1275
|
-
link?: string;
|
|
1276
|
-
}
|
|
1277
|
-
|
|
1278
|
-
export interface Paging {
|
|
1279
|
-
next?: Schemas.NextPage;
|
|
1280
|
-
prev?: Schemas.PreviousPage;
|
|
1281
|
-
}
|
|
1282
|
-
|
|
1283
|
-
export interface ParticipationAssociations {
|
|
1284
|
-
contact: Schemas.ContactAssociation;
|
|
1285
|
-
marketingEvent: Schemas.MarketingEventAssociation;
|
|
1286
|
-
}
|
|
1287
|
-
|
|
1288
|
-
export interface ParticipationBreakdown {
|
|
1289
|
-
associations: Schemas.ParticipationAssociations;
|
|
1290
|
-
/**
|
|
1291
|
-
* The creation time and date of the target marketing event
|
|
1292
|
-
*/
|
|
1293
|
-
createdAt: string;
|
|
1294
|
-
/**
|
|
1295
|
-
* The internal ID of the target marketing event
|
|
1296
|
-
*/
|
|
1297
|
-
id: string;
|
|
1298
|
-
properties: Schemas.ParticipationProperties;
|
|
1299
|
-
}
|
|
1300
|
-
|
|
1301
|
-
export interface ParticipationProperties {
|
|
1302
|
-
/**
|
|
1303
|
-
* The number of seconds the participation lasted
|
|
1304
|
-
*/
|
|
1305
|
-
attendanceDurationSeconds?: number;
|
|
1306
|
-
/**
|
|
1307
|
-
* Percentage of the participation duration relative to the event duration
|
|
1308
|
-
*/
|
|
1309
|
-
attendancePercentage?: string;
|
|
1310
|
-
/**
|
|
1311
|
-
* The state of the participation
|
|
1312
|
-
*/
|
|
1313
|
-
attendanceState:
|
|
1314
|
-
| 'ATTENDED'
|
|
1315
|
-
| 'CANCELLED'
|
|
1316
|
-
| 'EMPTY'
|
|
1317
|
-
| 'NO_SHOW'
|
|
1318
|
-
| 'REGISTERED';
|
|
1319
|
-
/**
|
|
1320
|
-
* Timestamp of when the participation occurred
|
|
1321
|
-
*/
|
|
1322
|
-
occurredAt: number;
|
|
1323
|
-
}
|
|
1324
|
-
|
|
1325
|
-
/**
|
|
1326
|
-
* specifies the paging information needed to retrieve the previous set of results in a paginated API response
|
|
1327
|
-
*/
|
|
1328
|
-
export interface PreviousPage {
|
|
1329
|
-
/**
|
|
1330
|
-
* A paging cursor token for retrieving previous pages.
|
|
1331
|
-
*/
|
|
1332
|
-
before: string;
|
|
1333
|
-
/**
|
|
1334
|
-
* A URL that can be used to retrieve the previous pages' results.
|
|
1335
|
-
*/
|
|
1336
|
-
link?: string;
|
|
1337
|
-
}
|
|
1338
|
-
|
|
1339
|
-
/**
|
|
1340
|
-
* Represents a single custom property of a marketing event, storing its name, value, metadata (like source, timestamp, and sensitivity), and related audit information for tracking changes.
|
|
1341
|
-
*/
|
|
1342
|
-
export interface PropertyValue {
|
|
1343
|
-
/**
|
|
1344
|
-
* Level of data sensitivity
|
|
1345
|
-
*/
|
|
1346
|
-
dataSensitivity: 'high' | 'none' | 'standard';
|
|
1347
|
-
/**
|
|
1348
|
-
* Indicates whether the property is encrypted
|
|
1349
|
-
*/
|
|
1350
|
-
isEncrypted: boolean;
|
|
1351
|
-
/**
|
|
1352
|
-
* Indicates whether the property value is stored as a large value in the storage
|
|
1353
|
-
*/
|
|
1354
|
-
isLargeValue: boolean;
|
|
1355
|
-
/**
|
|
1356
|
-
* Name of custom property
|
|
1357
|
-
*/
|
|
1358
|
-
name: string;
|
|
1359
|
-
/**
|
|
1360
|
-
* The timestamp that indicates when the value being written is persisted in storage
|
|
1361
|
-
*/
|
|
1362
|
-
persistenceTimestamp: number;
|
|
1363
|
-
/**
|
|
1364
|
-
* The ID of the request
|
|
1365
|
-
*/
|
|
1366
|
-
requestId: string;
|
|
1367
|
-
/**
|
|
1368
|
-
* Indicates whether the property is selected
|
|
1369
|
-
*/
|
|
1370
|
-
selectedByUser: boolean;
|
|
1371
|
-
/**
|
|
1372
|
-
* Timestamp of when the property was selected by the user
|
|
1373
|
-
*/
|
|
1374
|
-
selectedByUserTimestamp: number;
|
|
1375
|
-
/**
|
|
1376
|
-
* Source of the property
|
|
1377
|
-
*/
|
|
1378
|
-
source:
|
|
1379
|
-
| 'ACADEMY'
|
|
1380
|
-
| 'ACCEPTANCE_TEST'
|
|
1381
|
-
| 'ACTIVITY_AUTO_ASSOCIATE'
|
|
1382
|
-
| 'ACTIVITY_LOG_REVERT'
|
|
1383
|
-
| 'ADS'
|
|
1384
|
-
| 'AI_GROUP'
|
|
1385
|
-
| 'ANALYTICS'
|
|
1386
|
-
| 'API'
|
|
1387
|
-
| 'APPROVALS'
|
|
1388
|
-
| 'ASSISTS'
|
|
1389
|
-
| 'ASSOCIATIONS'
|
|
1390
|
-
| 'AUTO_ASSOCIATE_BY_DOMAIN'
|
|
1391
|
-
| 'AUTOMATION_JOURNEY'
|
|
1392
|
-
| 'AUTOMATION_PLATFORM'
|
|
1393
|
-
| 'AVATARS_SERVICE'
|
|
1394
|
-
| 'BATCH_UPDATE'
|
|
1395
|
-
| 'BCC_TO_CRM'
|
|
1396
|
-
| 'BEHAVIORAL_EVENTS'
|
|
1397
|
-
| 'BET_ASSIGNMENT'
|
|
1398
|
-
| 'BET_CRM_CONNECTOR'
|
|
1399
|
-
| 'BIDEN'
|
|
1400
|
-
| 'BILLING'
|
|
1401
|
-
| 'BOT'
|
|
1402
|
-
| 'CALCULATED'
|
|
1403
|
-
| 'CENTRAL_EXCHANGE_RATES'
|
|
1404
|
-
| 'CHATSPOT'
|
|
1405
|
-
| 'CLONE_OBJECTS'
|
|
1406
|
-
| 'COMMUNICATOR'
|
|
1407
|
-
| 'COMPANIES'
|
|
1408
|
-
| 'COMPANY_FAMILIES'
|
|
1409
|
-
| 'COMPANY_INSIGHTS'
|
|
1410
|
-
| 'CONNECTED_ACCOUNT'
|
|
1411
|
-
| 'CONTACTS'
|
|
1412
|
-
| 'CONTACTS_WEB'
|
|
1413
|
-
| 'CONTENT_MEMBERSHIP'
|
|
1414
|
-
| 'CONVERSATIONAL_ENRICHMENT'
|
|
1415
|
-
| 'CONVERSATIONS'
|
|
1416
|
-
| 'CRM_PROCESSES_PLATFORM'
|
|
1417
|
-
| 'CRM_UI'
|
|
1418
|
-
| 'CRM_UI_BULK_ACTION'
|
|
1419
|
-
| 'CUSTOMER_AGENT'
|
|
1420
|
-
| 'DATA_ENRICHMENT'
|
|
1421
|
-
| 'DATA_QUALITY'
|
|
1422
|
-
| 'DATASET'
|
|
1423
|
-
| 'DEALS'
|
|
1424
|
-
| 'DEFAULT'
|
|
1425
|
-
| 'DELETE_OBJECTS'
|
|
1426
|
-
| 'EMAIL'
|
|
1427
|
-
| 'EMAIL_INBOX_IMPORT'
|
|
1428
|
-
| 'EMAIL_INTEGRATION'
|
|
1429
|
-
| 'ENGAGEMENTS'
|
|
1430
|
-
| 'EXTENSION'
|
|
1431
|
-
| 'FILE_MANAGER'
|
|
1432
|
-
| 'FLYWHEEL_PRODUCT_DATA_SYNC'
|
|
1433
|
-
| 'FORECASTING'
|
|
1434
|
-
| 'FORM'
|
|
1435
|
-
| 'FORWARD_TO_CRM'
|
|
1436
|
-
| 'GMAIL_INTEGRATION'
|
|
1437
|
-
| 'GOALS'
|
|
1438
|
-
| 'HEISENBERG'
|
|
1439
|
-
| 'HELP_DESK'
|
|
1440
|
-
| 'HELP_DESK_AI'
|
|
1441
|
-
| 'IMPORT'
|
|
1442
|
-
| 'INTEGRATION'
|
|
1443
|
-
| 'INTEGRATIONS_PLATFORM'
|
|
1444
|
-
| 'INTEGRATIONS_SYNC'
|
|
1445
|
-
| 'INTENT'
|
|
1446
|
-
| 'INTERNAL_PROCESSING'
|
|
1447
|
-
| 'LEADIN'
|
|
1448
|
-
| 'LEGAL_BASIS_REMEDIATION'
|
|
1449
|
-
| 'MARKET_SOURCING'
|
|
1450
|
-
| 'MARKETPLACE'
|
|
1451
|
-
| 'MARKETS'
|
|
1452
|
-
| 'MEETINGS'
|
|
1453
|
-
| 'MERGE_COMPANIES'
|
|
1454
|
-
| 'MERGE_CONTACTS'
|
|
1455
|
-
| 'MERGE_OBJECTS'
|
|
1456
|
-
| 'MERGE_REVERT_OBJECTS'
|
|
1457
|
-
| 'MICROAPPS'
|
|
1458
|
-
| 'MIGRATION'
|
|
1459
|
-
| 'MOBILE_ANDROID'
|
|
1460
|
-
| 'MOBILE_IOS'
|
|
1461
|
-
| 'PAYMENTS'
|
|
1462
|
-
| 'PIPELINE_SETTINGS'
|
|
1463
|
-
| 'PLAYBOOKS'
|
|
1464
|
-
| 'PORTAL_OBJECT_SYNC'
|
|
1465
|
-
| 'PORTAL_USER_ASSOCIATOR'
|
|
1466
|
-
| 'PRESENTATIONS'
|
|
1467
|
-
| 'PRIMARY_AUTOMATION'
|
|
1468
|
-
| 'PROPERTY_DEFAULT_VALUE'
|
|
1469
|
-
| 'PROPERTY_RESTORE'
|
|
1470
|
-
| 'PROPERTY_SETTINGS'
|
|
1471
|
-
| 'PROSPECTING_AGENT'
|
|
1472
|
-
| 'QUOTAS'
|
|
1473
|
-
| 'QUOTES'
|
|
1474
|
-
| 'RECYCLING_BIN'
|
|
1475
|
-
| 'RESTORE_OBJECTS'
|
|
1476
|
-
| 'REVENUE_PLATFORM'
|
|
1477
|
-
| 'SALES'
|
|
1478
|
-
| 'SALES_MESSAGES'
|
|
1479
|
-
| 'SALESFORCE'
|
|
1480
|
-
| 'SEQUENCES'
|
|
1481
|
-
| 'SETTINGS'
|
|
1482
|
-
| 'SIDEKICK'
|
|
1483
|
-
| 'SIGNALS'
|
|
1484
|
-
| 'SLACK_INTEGRATION'
|
|
1485
|
-
| 'SMART_DATA_CAPTURE'
|
|
1486
|
-
| 'SOCIAL'
|
|
1487
|
-
| 'SUCCESS'
|
|
1488
|
-
| 'TALLY'
|
|
1489
|
-
| 'TASK'
|
|
1490
|
-
| 'UNKNOWN'
|
|
1491
|
-
| 'WAL_INCREMENTAL'
|
|
1492
|
-
| 'WORK_UI'
|
|
1493
|
-
| 'WORKFLOW_CONTACT_DELETE_ACTION'
|
|
1494
|
-
| 'WORKFLOWS';
|
|
1495
|
-
/**
|
|
1496
|
-
* ID of the source of the property
|
|
1497
|
-
*/
|
|
1498
|
-
sourceId: string;
|
|
1499
|
-
/**
|
|
1500
|
-
* Label of the source of the property
|
|
1501
|
-
*/
|
|
1502
|
-
sourceLabel: string;
|
|
1503
|
-
/**
|
|
1504
|
-
* Source metadata encoded as a base64 string
|
|
1505
|
-
*/
|
|
1506
|
-
sourceMetadata: string;
|
|
1507
|
-
/**
|
|
1508
|
-
* Indicates which upstream service made the property change
|
|
1509
|
-
*/
|
|
1510
|
-
sourceUpstreamDeployable: string;
|
|
1511
|
-
/**
|
|
1512
|
-
* The unique identifier associated with the source.
|
|
1513
|
-
*/
|
|
1514
|
-
sourceVid: number[];
|
|
1515
|
-
/**
|
|
1516
|
-
* Timestamp of the request
|
|
1517
|
-
*/
|
|
1518
|
-
timestamp: number;
|
|
1519
|
-
/**
|
|
1520
|
-
* The unit
|
|
1521
|
-
*/
|
|
1522
|
-
unit: string;
|
|
1523
|
-
/**
|
|
1524
|
-
* The ID of the user who last updated the property
|
|
1525
|
-
*/
|
|
1526
|
-
updatedByUserId: number;
|
|
1527
|
-
/**
|
|
1528
|
-
* Indicates if the persistence timestamp is the same as storage version timestamp
|
|
1529
|
-
*/
|
|
1530
|
-
useTimestampAsPersistenceTimestamp: boolean;
|
|
1531
|
-
/**
|
|
1532
|
-
* Custom property value
|
|
1533
|
-
*/
|
|
1534
|
-
value: string;
|
|
1535
|
-
}
|
|
1536
|
-
|
|
1537
|
-
export interface PublicList {
|
|
1538
|
-
/**
|
|
1539
|
-
* Timestamp of the creation of the list
|
|
1540
|
-
*/
|
|
1541
|
-
createdAt?: string;
|
|
1542
|
-
/**
|
|
1543
|
-
* The ID of the user who created the list
|
|
1544
|
-
*/
|
|
1545
|
-
createdById?: string;
|
|
1546
|
-
/**
|
|
1547
|
-
* Timestamp of the deletion of the list
|
|
1548
|
-
*/
|
|
1549
|
-
deletedAt?: string;
|
|
1550
|
-
/**
|
|
1551
|
-
* Timestamp of the last update of the list filters
|
|
1552
|
-
*/
|
|
1553
|
-
filtersUpdatedAt?: string;
|
|
1554
|
-
/**
|
|
1555
|
-
* An internal ID of the list
|
|
1556
|
-
*/
|
|
1557
|
-
listId: string;
|
|
1558
|
-
/**
|
|
1559
|
-
* A number that represents a version of the list
|
|
1560
|
-
*/
|
|
1561
|
-
listVersion: number;
|
|
1562
|
-
/**
|
|
1563
|
-
* The name of the list
|
|
1564
|
-
*/
|
|
1565
|
-
name: string;
|
|
1566
|
-
/**
|
|
1567
|
-
* The internal ID of the object type of the list
|
|
1568
|
-
*/
|
|
1569
|
-
objectTypeId: string;
|
|
1570
|
-
/**
|
|
1571
|
-
* Represents the current processing status of the list
|
|
1572
|
-
*/
|
|
1573
|
-
processingStatus: string;
|
|
1574
|
-
/**
|
|
1575
|
-
* Processing type of the list
|
|
1576
|
-
*/
|
|
1577
|
-
processingType: string;
|
|
1578
|
-
/**
|
|
1579
|
-
* The size of the result list
|
|
1580
|
-
*/
|
|
1581
|
-
size?: number;
|
|
1582
|
-
/**
|
|
1583
|
-
* Timestamp of the last update of the list
|
|
1584
|
-
*/
|
|
1585
|
-
updatedAt?: string;
|
|
1586
|
-
/**
|
|
1587
|
-
* The ID of the user who last updated the list
|
|
1588
|
-
*/
|
|
1589
|
-
updatedById?: string;
|
|
1590
|
-
}
|
|
1591
|
-
|
|
1592
|
-
export interface SearchPublicResponseWrapper {
|
|
1593
|
-
/**
|
|
1594
|
-
* The ID of the source application of the marketing event
|
|
1595
|
-
*/
|
|
1596
|
-
appId: number;
|
|
1597
|
-
/**
|
|
1598
|
-
* The account ID associated with this marketing event in the external application
|
|
1599
|
-
*/
|
|
1600
|
-
externalAccountId: string;
|
|
1601
|
-
/**
|
|
1602
|
-
* The ID of the marketing event in the external event application
|
|
1603
|
-
*/
|
|
1604
|
-
externalEventId: string;
|
|
1605
|
-
/**
|
|
1606
|
-
* The internal ID of the marketing event in HubSpot
|
|
1607
|
-
*/
|
|
1608
|
-
objectId: string;
|
|
1609
|
-
}
|
|
1610
|
-
|
|
1611
|
-
/**
|
|
1612
|
-
* Ye olde error
|
|
1613
|
-
*/
|
|
1614
|
-
export interface StandardError {
|
|
1615
|
-
/**
|
|
1616
|
-
* The category of the error
|
|
1617
|
-
*/
|
|
1618
|
-
category: string;
|
|
1619
|
-
/**
|
|
1620
|
-
* The object that contains details of the errors
|
|
1621
|
-
*/
|
|
1622
|
-
context: Record<string, string[]>;
|
|
1623
|
-
/**
|
|
1624
|
-
* The detailed error objects.
|
|
1625
|
-
*/
|
|
1626
|
-
errors: Schemas.ErrorDetail[];
|
|
1627
|
-
/**
|
|
1628
|
-
* The ID of the request
|
|
1629
|
-
*/
|
|
1630
|
-
id?: string;
|
|
1631
|
-
/**
|
|
1632
|
-
* Results of the request
|
|
1633
|
-
*/
|
|
1634
|
-
links: Record<string, string>;
|
|
1635
|
-
/**
|
|
1636
|
-
* A human readable message describing the error along with remediation steps where appropriate
|
|
1637
|
-
*/
|
|
1638
|
-
message: string;
|
|
1639
|
-
/**
|
|
1640
|
-
* Status of the response
|
|
1641
|
-
*/
|
|
1642
|
-
status: string;
|
|
1643
|
-
/**
|
|
1644
|
-
* The Sub-category of the error
|
|
1645
|
-
*/
|
|
1646
|
-
subCategory?: Record<string, never>;
|
|
1647
|
-
}
|
|
1648
|
-
|
|
1649
|
-
export interface SubscriberEmailResponse {
|
|
1650
|
-
/**
|
|
1651
|
-
* The email of the contact
|
|
1652
|
-
*/
|
|
1653
|
-
email: string;
|
|
1654
|
-
/**
|
|
1655
|
-
* The internal ID of the contact
|
|
1656
|
-
*/
|
|
1657
|
-
vid: number;
|
|
1658
|
-
}
|
|
1659
|
-
|
|
1660
|
-
export interface SubscriberVidResponse {
|
|
1661
|
-
/**
|
|
1662
|
-
* The internal ID of the contact
|
|
1663
|
-
*/
|
|
1664
|
-
vid: number;
|
|
1665
|
-
}
|
|
1666
|
-
}
|
|
1667
|
-
|
|
1668
|
-
export namespace Settings {
|
|
1669
|
-
export interface CreateOrUpdateInput {
|
|
1670
|
-
appId: number;
|
|
1671
|
-
data: Schemas.EventDetailSettingsUrl;
|
|
1672
|
-
}
|
|
1673
|
-
|
|
1674
|
-
export type CreateOrUpdateOutput = Schemas.EventDetailSettings;
|
|
1675
|
-
|
|
1676
|
-
export interface GetInput {
|
|
1677
|
-
appId: number;
|
|
1678
|
-
}
|
|
1679
|
-
|
|
1680
|
-
export type GetOutput = Schemas.EventDetailSettings;
|
|
1681
|
-
}
|
|
1682
|
-
|
|
1683
|
-
export namespace SubscriberStateChanges {
|
|
1684
|
-
export interface RecordByEmailInput {
|
|
1685
|
-
data: Schemas.BatchInputMarketingEventEmailSubscriber;
|
|
1686
|
-
externalAccountId: string;
|
|
1687
|
-
externalEventId: string;
|
|
1688
|
-
subscriberState: string;
|
|
1689
|
-
}
|
|
1690
|
-
|
|
1691
|
-
export type RecordByEmailOutput = void;
|
|
1692
|
-
|
|
1693
|
-
export interface RecordByIdInput {
|
|
1694
|
-
data: Schemas.BatchInputMarketingEventSubscriber;
|
|
1695
|
-
externalAccountId: string;
|
|
1696
|
-
externalEventId: string;
|
|
1697
|
-
subscriberState: string;
|
|
1698
|
-
}
|
|
1699
|
-
|
|
1700
|
-
export type RecordByIdOutput = void;
|
|
1399
|
+
export interface UpsertByExternalEventIdInput {
|
|
1400
|
+
data: MarketingMarketingEventsSchemas.MarketingEventCreateRequestParams;
|
|
1401
|
+
externalEventId: string;
|
|
1701
1402
|
}
|
|
1702
1403
|
|
|
1404
|
+
export type UpsertByExternalEventIdOutput =
|
|
1405
|
+
MarketingMarketingEventsSchemas.MarketingEventPublicDefaultResponse;
|
|
1703
1406
|
/**
|
|
1704
1407
|
* Usage example:
|
|
1705
1408
|
* ```ts
|
|
1706
|
-
* import {
|
|
1707
|
-
* client.send(
|
|
1409
|
+
* import { marketingMarketingevents } from '@hubspot/api-client-core';
|
|
1410
|
+
* client.send(marketingMarketingevents.create(input));
|
|
1708
1411
|
* ```
|
|
1709
1412
|
*/
|
|
1710
|
-
export interface
|
|
1413
|
+
export interface API {
|
|
1711
1414
|
/**
|
|
1712
1415
|
* Create a marketing event
|
|
1713
1416
|
* @apiPath /marketing/marketing-events/2026-03/events
|
|
1714
1417
|
* @apiMethod POST
|
|
1715
1418
|
* @requiredScopes marketing-events-write
|
|
1716
1419
|
*/
|
|
1717
|
-
create: (input:
|
|
1420
|
+
create: (input: CreateInput) => Operation<CreateOutput>;
|
|
1718
1421
|
/**
|
|
1719
1422
|
* Delete Marketing Event by objectId
|
|
1720
1423
|
* @apiPath /marketing/marketing-events/2026-03/{objectId}
|
|
1721
1424
|
* @apiMethod DELETE
|
|
1722
1425
|
* @requiredScopes marketing-events-write
|
|
1723
1426
|
*/
|
|
1724
|
-
delete: (input:
|
|
1427
|
+
delete: (input: DeleteInput) => Operation<DeleteOutput>;
|
|
1428
|
+
/**
|
|
1429
|
+
* Delete Multiple Marketing Events by ObjectId
|
|
1430
|
+
* @apiPath /marketing/marketing-events/2026-03/batch/archive
|
|
1431
|
+
* @apiMethod POST
|
|
1432
|
+
* @requiredScopes marketing-events-write
|
|
1433
|
+
*/
|
|
1434
|
+
deleteBatch: (input: DeleteBatchInput) => Operation<DeleteBatchOutput>;
|
|
1435
|
+
/**
|
|
1436
|
+
* Delete Multiple Marketing Events by External Ids
|
|
1437
|
+
* @apiPath /marketing/marketing-events/2026-03/events/delete
|
|
1438
|
+
* @apiMethod POST
|
|
1439
|
+
* @requiredScopes marketing-events-write
|
|
1440
|
+
*/
|
|
1441
|
+
deleteBatchByExternalEventId: (
|
|
1442
|
+
input: DeleteBatchByExternalEventIdInput
|
|
1443
|
+
) => Operation<DeleteBatchByExternalEventIdOutput>;
|
|
1725
1444
|
/**
|
|
1726
1445
|
* Delete Marketing Event by External Ids
|
|
1727
1446
|
* @apiPath /marketing/marketing-events/2026-03/events/{externalEventId}
|
|
@@ -1729,15 +1448,15 @@ export namespace MarketingMarketingEvents {
|
|
|
1729
1448
|
* @requiredScopes marketing-events-write
|
|
1730
1449
|
*/
|
|
1731
1450
|
deleteByExternalEventId: (
|
|
1732
|
-
input:
|
|
1733
|
-
) => Operation<
|
|
1451
|
+
input: DeleteByExternalEventIdInput
|
|
1452
|
+
) => Operation<DeleteByExternalEventIdOutput>;
|
|
1734
1453
|
/**
|
|
1735
1454
|
* Get Marketing Event by objectId
|
|
1736
1455
|
* @apiPath /marketing/marketing-events/2026-03/{objectId}
|
|
1737
1456
|
* @apiMethod GET
|
|
1738
1457
|
* @requiredScopes marketing-events-read
|
|
1739
1458
|
*/
|
|
1740
|
-
get: (input:
|
|
1459
|
+
get: (input: GetInput) => Operation<GetOutput>;
|
|
1741
1460
|
/**
|
|
1742
1461
|
* Get Marketing Event by External IDs
|
|
1743
1462
|
* @apiPath /marketing/marketing-events/2026-03/events/{externalEventId}
|
|
@@ -1745,21 +1464,46 @@ export namespace MarketingMarketingEvents {
|
|
|
1745
1464
|
* @requiredScopes marketing-events-read
|
|
1746
1465
|
*/
|
|
1747
1466
|
getByExternalEventId: (
|
|
1748
|
-
input:
|
|
1749
|
-
) => Operation<
|
|
1467
|
+
input: GetByExternalEventIdInput
|
|
1468
|
+
) => Operation<GetByExternalEventIdOutput>;
|
|
1750
1469
|
/**
|
|
1751
1470
|
* @apiPath /marketing/marketing-events/2026-03
|
|
1752
1471
|
* @apiMethod GET
|
|
1753
1472
|
* @requiredScopes marketing-events-read
|
|
1754
1473
|
*/
|
|
1755
|
-
list: (input?:
|
|
1474
|
+
list: (input?: ListInput) => Operation<ListOutput>;
|
|
1475
|
+
/**
|
|
1476
|
+
* Find App-Specific Marketing Events by External Event Id
|
|
1477
|
+
* @apiPath /marketing/marketing-events/2026-03/events/search
|
|
1478
|
+
* @apiMethod GET
|
|
1479
|
+
* @requiredScopes marketing-events-read
|
|
1480
|
+
*/
|
|
1481
|
+
searchByExternalEventId: (
|
|
1482
|
+
input: SearchByExternalEventIdInput
|
|
1483
|
+
) => Operation<SearchByExternalEventIdOutput>;
|
|
1484
|
+
/**
|
|
1485
|
+
* Find Marketing Events by External Event Id
|
|
1486
|
+
* @apiPath /marketing/marketing-events/2026-03/{externalEventId}/identifiers
|
|
1487
|
+
* @apiMethod GET
|
|
1488
|
+
* @requiredScopes marketing-events-read
|
|
1489
|
+
*/
|
|
1490
|
+
searchIdentifiersByExternalEventId: (
|
|
1491
|
+
input: SearchIdentifiersByExternalEventIdInput
|
|
1492
|
+
) => Operation<SearchIdentifiersByExternalEventIdOutput>;
|
|
1756
1493
|
/**
|
|
1757
1494
|
* Update Marketing Event by objectId
|
|
1758
1495
|
* @apiPath /marketing/marketing-events/2026-03/{objectId}
|
|
1759
1496
|
* @apiMethod PATCH
|
|
1760
1497
|
* @requiredScopes marketing-events-write
|
|
1761
1498
|
*/
|
|
1762
|
-
update: (input:
|
|
1499
|
+
update: (input: UpdateInput) => Operation<UpdateOutput>;
|
|
1500
|
+
/**
|
|
1501
|
+
* Update Multiple Marketing Events by ObjectId
|
|
1502
|
+
* @apiPath /marketing/marketing-events/2026-03/batch/update
|
|
1503
|
+
* @apiMethod POST
|
|
1504
|
+
* @requiredScopes marketing-events-write
|
|
1505
|
+
*/
|
|
1506
|
+
updateBatch: (input: UpdateBatchInput) => Operation<UpdateBatchOutput>;
|
|
1763
1507
|
/**
|
|
1764
1508
|
* Update Marketing Event by External IDs
|
|
1765
1509
|
* @apiPath /marketing/marketing-events/2026-03/events/{externalEventId}
|
|
@@ -1767,8 +1511,15 @@ export namespace MarketingMarketingEvents {
|
|
|
1767
1511
|
* @requiredScopes marketing-events-write
|
|
1768
1512
|
*/
|
|
1769
1513
|
updateByExternalEventId: (
|
|
1770
|
-
input:
|
|
1771
|
-
) => Operation<
|
|
1514
|
+
input: UpdateByExternalEventIdInput
|
|
1515
|
+
) => Operation<UpdateByExternalEventIdOutput>;
|
|
1516
|
+
/**
|
|
1517
|
+
* Create or Update Multiple Marketing Events
|
|
1518
|
+
* @apiPath /marketing/marketing-events/2026-03/events/upsert
|
|
1519
|
+
* @apiMethod POST
|
|
1520
|
+
* @requiredScopes marketing-events-write
|
|
1521
|
+
*/
|
|
1522
|
+
upsertBatch: (input: UpsertBatchInput) => Operation<UpsertBatchOutput>;
|
|
1772
1523
|
/**
|
|
1773
1524
|
* Create or update a marketing event
|
|
1774
1525
|
* @apiPath /marketing/marketing-events/2026-03/events/{externalEventId}
|
|
@@ -1776,64 +1527,69 @@ export namespace MarketingMarketingEvents {
|
|
|
1776
1527
|
* @requiredScopes marketing-events-write
|
|
1777
1528
|
*/
|
|
1778
1529
|
upsertByExternalEventId: (
|
|
1779
|
-
input:
|
|
1780
|
-
) => Operation<
|
|
1530
|
+
input: UpsertByExternalEventIdInput
|
|
1531
|
+
) => Operation<UpsertByExternalEventIdOutput>;
|
|
1781
1532
|
}
|
|
1533
|
+
}
|
|
1782
1534
|
|
|
1783
|
-
|
|
1784
|
-
|
|
1785
|
-
|
|
1786
|
-
* import { marketingMarketingEvents } from '@hubspot/api-client-core';
|
|
1787
|
-
* client.send(marketingMarketingEvents.batch.deleteBatch(input));
|
|
1788
|
-
* ```
|
|
1789
|
-
*/
|
|
1790
|
-
export interface BatchAPI {
|
|
1535
|
+
export namespace MarketingMarketingeventsAttendance {
|
|
1536
|
+
export interface CreateByEventIdAndContactIdInput {
|
|
1537
|
+
data: MarketingMarketingEventsSchemas.BatchInputMarketingEventSubscriber;
|
|
1791
1538
|
/**
|
|
1792
|
-
*
|
|
1793
|
-
* @apiPath /marketing/marketing-events/2026-03/batch/archive
|
|
1794
|
-
* @apiMethod POST
|
|
1795
|
-
* @requiredScopes marketing-events-write
|
|
1539
|
+
* The internal id of the marketing event in HubSpot.
|
|
1796
1540
|
*/
|
|
1797
|
-
|
|
1798
|
-
input: Batch.DeleteBatchInput
|
|
1799
|
-
) => Operation<Batch.DeleteBatchOutput>;
|
|
1541
|
+
objectId: string;
|
|
1800
1542
|
/**
|
|
1801
|
-
*
|
|
1802
|
-
* @apiPath /marketing/marketing-events/2026-03/events/delete
|
|
1803
|
-
* @apiMethod POST
|
|
1804
|
-
* @requiredScopes marketing-events-write
|
|
1543
|
+
* The attendance state value. It may be 'register', 'attend' or 'cancel'
|
|
1805
1544
|
*/
|
|
1806
|
-
|
|
1807
|
-
|
|
1808
|
-
|
|
1545
|
+
subscriberState: string;
|
|
1546
|
+
}
|
|
1547
|
+
|
|
1548
|
+
export type CreateByEventIdAndContactIdOutput =
|
|
1549
|
+
MarketingMarketingEventsSchemas.BatchResponseSubscriberVidResponse;
|
|
1550
|
+
|
|
1551
|
+
export interface CreateByEventIdAndEmailInput {
|
|
1552
|
+
data: MarketingMarketingEventsSchemas.BatchInputMarketingEventEmailSubscriber;
|
|
1809
1553
|
/**
|
|
1810
|
-
*
|
|
1811
|
-
* @apiPath /marketing/marketing-events/2026-03/batch/update
|
|
1812
|
-
* @apiMethod POST
|
|
1813
|
-
* @requiredScopes marketing-events-write
|
|
1554
|
+
* The internal id of the marketing event in HubSpot.
|
|
1814
1555
|
*/
|
|
1815
|
-
|
|
1816
|
-
input: Batch.UpdateBatchInput
|
|
1817
|
-
) => Operation<Batch.UpdateBatchOutput>;
|
|
1556
|
+
objectId: string;
|
|
1818
1557
|
/**
|
|
1819
|
-
*
|
|
1820
|
-
* @apiPath /marketing/marketing-events/2026-03/events/upsert
|
|
1821
|
-
* @apiMethod POST
|
|
1822
|
-
* @requiredScopes marketing-events-write
|
|
1558
|
+
* The attendance state value. It may be 'register', 'attend' or 'cancel'
|
|
1823
1559
|
*/
|
|
1824
|
-
|
|
1825
|
-
|
|
1826
|
-
|
|
1560
|
+
subscriberState: string;
|
|
1561
|
+
}
|
|
1562
|
+
|
|
1563
|
+
export type CreateByEventIdAndEmailOutput =
|
|
1564
|
+
MarketingMarketingEventsSchemas.BatchResponseSubscriberEmailResponse;
|
|
1565
|
+
|
|
1566
|
+
export interface CreateByExternalEventIdAndContactIdInput {
|
|
1567
|
+
data: MarketingMarketingEventsSchemas.BatchInputMarketingEventSubscriber;
|
|
1568
|
+
externalAccountId?: string;
|
|
1569
|
+
externalEventId: string;
|
|
1570
|
+
subscriberState: string;
|
|
1571
|
+
}
|
|
1572
|
+
|
|
1573
|
+
export type CreateByExternalEventIdAndContactIdOutput =
|
|
1574
|
+
MarketingMarketingEventsSchemas.BatchResponseSubscriberVidResponse;
|
|
1575
|
+
|
|
1576
|
+
export interface CreateByExternalEventIdAndEmailInput {
|
|
1577
|
+
data: MarketingMarketingEventsSchemas.BatchInputMarketingEventEmailSubscriber;
|
|
1578
|
+
externalAccountId?: string;
|
|
1579
|
+
externalEventId: string;
|
|
1580
|
+
subscriberState: string;
|
|
1827
1581
|
}
|
|
1828
1582
|
|
|
1583
|
+
export type CreateByExternalEventIdAndEmailOutput =
|
|
1584
|
+
MarketingMarketingEventsSchemas.BatchResponseSubscriberEmailResponse;
|
|
1829
1585
|
/**
|
|
1830
1586
|
* Usage example:
|
|
1831
1587
|
* ```ts
|
|
1832
|
-
* import {
|
|
1833
|
-
* client.send(
|
|
1588
|
+
* import { marketingMarketingeventsAttendance } from '@hubspot/api-client-core';
|
|
1589
|
+
* client.send(marketingMarketingeventsAttendance.createByEventIdAndContactId(input));
|
|
1834
1590
|
* ```
|
|
1835
1591
|
*/
|
|
1836
|
-
export interface
|
|
1592
|
+
export interface API {
|
|
1837
1593
|
/**
|
|
1838
1594
|
* Record Participants by ContactId with Marketing Event Object Id
|
|
1839
1595
|
* @apiPath /marketing/marketing-events/2026-03/{objectId}/attendance/{subscriberState}/create
|
|
@@ -1841,8 +1597,8 @@ export namespace MarketingMarketingEvents {
|
|
|
1841
1597
|
* @requiredScopes marketing-events-write
|
|
1842
1598
|
*/
|
|
1843
1599
|
createByEventIdAndContactId: (
|
|
1844
|
-
input:
|
|
1845
|
-
) => Operation<
|
|
1600
|
+
input: CreateByEventIdAndContactIdInput
|
|
1601
|
+
) => Operation<CreateByEventIdAndContactIdOutput>;
|
|
1846
1602
|
/**
|
|
1847
1603
|
* Record Participants by Email with Marketing Event Object Id
|
|
1848
1604
|
* @apiPath /marketing/marketing-events/2026-03/{objectId}/attendance/{subscriberState}/email-create
|
|
@@ -1850,8 +1606,8 @@ export namespace MarketingMarketingEvents {
|
|
|
1850
1606
|
* @requiredScopes marketing-events-write
|
|
1851
1607
|
*/
|
|
1852
1608
|
createByEventIdAndEmail: (
|
|
1853
|
-
input:
|
|
1854
|
-
) => Operation<
|
|
1609
|
+
input: CreateByEventIdAndEmailInput
|
|
1610
|
+
) => Operation<CreateByEventIdAndEmailOutput>;
|
|
1855
1611
|
/**
|
|
1856
1612
|
* Record Participants by ContactId with Marketing Event External Ids
|
|
1857
1613
|
* @apiPath /marketing/marketing-events/2026-03/attendance/{externalEventId}/{subscriberState}/create
|
|
@@ -1859,8 +1615,8 @@ export namespace MarketingMarketingEvents {
|
|
|
1859
1615
|
* @requiredScopes marketing-events-write
|
|
1860
1616
|
*/
|
|
1861
1617
|
createByExternalEventIdAndContactId: (
|
|
1862
|
-
input:
|
|
1863
|
-
) => Operation<
|
|
1618
|
+
input: CreateByExternalEventIdAndContactIdInput
|
|
1619
|
+
) => Operation<CreateByExternalEventIdAndContactIdOutput>;
|
|
1864
1620
|
/**
|
|
1865
1621
|
* Record Participants by Email with Marketing Event External Ids
|
|
1866
1622
|
* @apiPath /marketing/marketing-events/2026-03/attendance/{externalEventId}/{subscriberState}/email-create
|
|
@@ -1868,18 +1624,36 @@ export namespace MarketingMarketingEvents {
|
|
|
1868
1624
|
* @requiredScopes marketing-events-write
|
|
1869
1625
|
*/
|
|
1870
1626
|
createByExternalEventIdAndEmail: (
|
|
1871
|
-
input:
|
|
1872
|
-
) => Operation<
|
|
1627
|
+
input: CreateByExternalEventIdAndEmailInput
|
|
1628
|
+
) => Operation<CreateByExternalEventIdAndEmailOutput>;
|
|
1629
|
+
}
|
|
1630
|
+
}
|
|
1631
|
+
|
|
1632
|
+
export namespace MarketingMarketingeventsEvents {
|
|
1633
|
+
export interface CancelByExternalEventIdInput {
|
|
1634
|
+
externalAccountId: string;
|
|
1635
|
+
externalEventId: string;
|
|
1873
1636
|
}
|
|
1874
1637
|
|
|
1638
|
+
export type CancelByExternalEventIdOutput =
|
|
1639
|
+
MarketingMarketingEventsSchemas.MarketingEventDefaultResponse;
|
|
1640
|
+
|
|
1641
|
+
export interface CompleteByExternalEventIdInput {
|
|
1642
|
+
data: MarketingMarketingEventsSchemas.MarketingEventCompleteRequestParams;
|
|
1643
|
+
externalAccountId: string;
|
|
1644
|
+
externalEventId: string;
|
|
1645
|
+
}
|
|
1646
|
+
|
|
1647
|
+
export type CompleteByExternalEventIdOutput =
|
|
1648
|
+
MarketingMarketingEventsSchemas.MarketingEventDefaultResponse;
|
|
1875
1649
|
/**
|
|
1876
1650
|
* Usage example:
|
|
1877
1651
|
* ```ts
|
|
1878
|
-
* import {
|
|
1879
|
-
* client.send(
|
|
1652
|
+
* import { marketingMarketingeventsEvents } from '@hubspot/api-client-core';
|
|
1653
|
+
* client.send(marketingMarketingeventsEvents.cancelByExternalEventId(input));
|
|
1880
1654
|
* ```
|
|
1881
1655
|
*/
|
|
1882
|
-
export interface
|
|
1656
|
+
export interface API {
|
|
1883
1657
|
/**
|
|
1884
1658
|
* Mark a marketing event as cancelled
|
|
1885
1659
|
* @apiPath /marketing/marketing-events/2026-03/events/{externalEventId}/cancel
|
|
@@ -1887,8 +1661,8 @@ export namespace MarketingMarketingEvents {
|
|
|
1887
1661
|
* @requiredScopes marketing-events-write
|
|
1888
1662
|
*/
|
|
1889
1663
|
cancelByExternalEventId: (
|
|
1890
|
-
input:
|
|
1891
|
-
) => Operation<
|
|
1664
|
+
input: CancelByExternalEventIdInput
|
|
1665
|
+
) => Operation<CancelByExternalEventIdOutput>;
|
|
1892
1666
|
/**
|
|
1893
1667
|
* Mark a marketing event as completed
|
|
1894
1668
|
* @apiPath /marketing/marketing-events/2026-03/events/{externalEventId}/complete
|
|
@@ -1896,55 +1670,110 @@ export namespace MarketingMarketingEvents {
|
|
|
1896
1670
|
* @requiredScopes marketing-events-write
|
|
1897
1671
|
*/
|
|
1898
1672
|
completeByExternalEventId: (
|
|
1899
|
-
input:
|
|
1900
|
-
) => Operation<
|
|
1673
|
+
input: CompleteByExternalEventIdInput
|
|
1674
|
+
) => Operation<CompleteByExternalEventIdOutput>;
|
|
1901
1675
|
}
|
|
1676
|
+
}
|
|
1902
1677
|
|
|
1903
|
-
|
|
1904
|
-
|
|
1905
|
-
* ```ts
|
|
1906
|
-
* import { marketingMarketingEvents } from '@hubspot/api-client-core';
|
|
1907
|
-
* client.send(marketingMarketingEvents.identifiers.searchByExternalEventId(input));
|
|
1908
|
-
* ```
|
|
1909
|
-
*/
|
|
1910
|
-
export interface IdentifiersAPI {
|
|
1678
|
+
export namespace MarketingMarketingeventsListassociations {
|
|
1679
|
+
export interface AssociateByExternalAccountInput {
|
|
1911
1680
|
/**
|
|
1912
|
-
*
|
|
1913
|
-
* @apiPath /marketing/marketing-events/2026-03/events/search
|
|
1914
|
-
* @apiMethod GET
|
|
1915
|
-
* @requiredScopes marketing-events-read
|
|
1681
|
+
* The accountId that is associated with this marketing event in the external event application.
|
|
1916
1682
|
*/
|
|
1917
|
-
|
|
1918
|
-
input: Identifiers.SearchByExternalEventIdInput
|
|
1919
|
-
) => Operation<Identifiers.SearchByExternalEventIdOutput>;
|
|
1683
|
+
externalAccountId: string;
|
|
1920
1684
|
/**
|
|
1921
|
-
*
|
|
1922
|
-
* @apiPath /marketing/marketing-events/2026-03/{externalEventId}/identifiers
|
|
1923
|
-
* @apiMethod GET
|
|
1924
|
-
* @requiredScopes marketing-events-read
|
|
1685
|
+
* The id of the marketing event in the external event application.
|
|
1925
1686
|
*/
|
|
1926
|
-
|
|
1927
|
-
|
|
1928
|
-
|
|
1687
|
+
externalEventId: string;
|
|
1688
|
+
/**
|
|
1689
|
+
* The ILS ID of the list.
|
|
1690
|
+
*/
|
|
1691
|
+
listId: string;
|
|
1692
|
+
}
|
|
1693
|
+
|
|
1694
|
+
export type AssociateByExternalAccountOutput = void;
|
|
1695
|
+
|
|
1696
|
+
export interface AssociateInput {
|
|
1697
|
+
/**
|
|
1698
|
+
* The ILS ID of the list.
|
|
1699
|
+
*/
|
|
1700
|
+
listId: string;
|
|
1701
|
+
/**
|
|
1702
|
+
* The internal id of the marketing event in HubSpot.
|
|
1703
|
+
*/
|
|
1704
|
+
marketingEventId: string;
|
|
1705
|
+
}
|
|
1706
|
+
|
|
1707
|
+
export type AssociateOutput = void;
|
|
1708
|
+
|
|
1709
|
+
export interface DeleteByExternalAccountInput {
|
|
1710
|
+
/**
|
|
1711
|
+
* The accountId that is associated with this marketing event in the external event application.
|
|
1712
|
+
*/
|
|
1713
|
+
externalAccountId: string;
|
|
1714
|
+
/**
|
|
1715
|
+
* The id of the marketing event in the external event application.
|
|
1716
|
+
*/
|
|
1717
|
+
externalEventId: string;
|
|
1718
|
+
/**
|
|
1719
|
+
* The ILS ID of the list.
|
|
1720
|
+
*/
|
|
1721
|
+
listId: string;
|
|
1722
|
+
}
|
|
1723
|
+
|
|
1724
|
+
export type DeleteByExternalAccountOutput = void;
|
|
1725
|
+
|
|
1726
|
+
export interface DeleteInput {
|
|
1727
|
+
/**
|
|
1728
|
+
* The ILS ID of the list.
|
|
1729
|
+
*/
|
|
1730
|
+
listId: string;
|
|
1731
|
+
/**
|
|
1732
|
+
* The internal id of the marketing event in HubSpot.
|
|
1733
|
+
*/
|
|
1734
|
+
marketingEventId: string;
|
|
1735
|
+
}
|
|
1736
|
+
|
|
1737
|
+
export type DeleteOutput = void;
|
|
1738
|
+
|
|
1739
|
+
export interface ListByExternalAccountInput {
|
|
1740
|
+
/**
|
|
1741
|
+
* The accountId that is associated with this marketing event in the external event application.
|
|
1742
|
+
*/
|
|
1743
|
+
externalAccountId: string;
|
|
1744
|
+
/**
|
|
1745
|
+
* The id of the marketing event in the external event application.
|
|
1746
|
+
*/
|
|
1747
|
+
externalEventId: string;
|
|
1929
1748
|
}
|
|
1930
1749
|
|
|
1750
|
+
export type ListByExternalAccountOutput =
|
|
1751
|
+
MarketingMarketingEventsSchemas.CollectionResponseWithTotalPublicList;
|
|
1752
|
+
|
|
1753
|
+
export interface ListInput {
|
|
1754
|
+
/**
|
|
1755
|
+
* The internal id of the marketing event in HubSpot.
|
|
1756
|
+
*/
|
|
1757
|
+
marketingEventId: string;
|
|
1758
|
+
}
|
|
1759
|
+
|
|
1760
|
+
export type ListOutput =
|
|
1761
|
+
MarketingMarketingEventsSchemas.CollectionResponseWithTotalPublicList;
|
|
1931
1762
|
/**
|
|
1932
1763
|
* Usage example:
|
|
1933
1764
|
* ```ts
|
|
1934
|
-
* import {
|
|
1935
|
-
* client.send(
|
|
1765
|
+
* import { marketingMarketingeventsListassociations } from '@hubspot/api-client-core';
|
|
1766
|
+
* client.send(marketingMarketingeventsListassociations.associate(input));
|
|
1936
1767
|
* ```
|
|
1937
1768
|
*/
|
|
1938
|
-
export interface
|
|
1769
|
+
export interface API {
|
|
1939
1770
|
/**
|
|
1940
1771
|
* Associate a list with a marketing event
|
|
1941
1772
|
* @apiPath /marketing/marketing-events/2026-03/associations/{marketingEventId}/lists/{listId}
|
|
1942
1773
|
* @apiMethod PUT
|
|
1943
1774
|
* @requiredScopes marketing-events-write
|
|
1944
1775
|
*/
|
|
1945
|
-
associate: (
|
|
1946
|
-
input: ListAssociations.AssociateInput
|
|
1947
|
-
) => Operation<ListAssociations.AssociateOutput>;
|
|
1776
|
+
associate: (input: AssociateInput) => Operation<AssociateOutput>;
|
|
1948
1777
|
/**
|
|
1949
1778
|
* Associate a list with a marketing event
|
|
1950
1779
|
* @apiPath /marketing/marketing-events/2026-03/associations/{externalAccountId}/{externalEventId}/lists/{listId}
|
|
@@ -1952,17 +1781,15 @@ export namespace MarketingMarketingEvents {
|
|
|
1952
1781
|
* @requiredScopes marketing-events-write
|
|
1953
1782
|
*/
|
|
1954
1783
|
associateByExternalAccount: (
|
|
1955
|
-
input:
|
|
1956
|
-
) => Operation<
|
|
1784
|
+
input: AssociateByExternalAccountInput
|
|
1785
|
+
) => Operation<AssociateByExternalAccountOutput>;
|
|
1957
1786
|
/**
|
|
1958
1787
|
* Disassociate a list from a marketing event
|
|
1959
1788
|
* @apiPath /marketing/marketing-events/2026-03/associations/{marketingEventId}/lists/{listId}
|
|
1960
1789
|
* @apiMethod DELETE
|
|
1961
1790
|
* @requiredScopes marketing-events-write
|
|
1962
1791
|
*/
|
|
1963
|
-
delete: (
|
|
1964
|
-
input: ListAssociations.DeleteInput
|
|
1965
|
-
) => Operation<ListAssociations.DeleteOutput>;
|
|
1792
|
+
delete: (input: DeleteInput) => Operation<DeleteOutput>;
|
|
1966
1793
|
/**
|
|
1967
1794
|
* Disassociate a list from a marketing event
|
|
1968
1795
|
* @apiPath /marketing/marketing-events/2026-03/associations/{externalAccountId}/{externalEventId}/lists/{listId}
|
|
@@ -1970,17 +1797,15 @@ export namespace MarketingMarketingEvents {
|
|
|
1970
1797
|
* @requiredScopes marketing-events-write
|
|
1971
1798
|
*/
|
|
1972
1799
|
deleteByExternalAccount: (
|
|
1973
|
-
input:
|
|
1974
|
-
) => Operation<
|
|
1800
|
+
input: DeleteByExternalAccountInput
|
|
1801
|
+
) => Operation<DeleteByExternalAccountOutput>;
|
|
1975
1802
|
/**
|
|
1976
1803
|
* Get lists associated with a marketing event
|
|
1977
1804
|
* @apiPath /marketing/marketing-events/2026-03/associations/{marketingEventId}/lists
|
|
1978
1805
|
* @apiMethod GET
|
|
1979
1806
|
* @requiredScopes marketing-events-write
|
|
1980
1807
|
*/
|
|
1981
|
-
list: (
|
|
1982
|
-
input: ListAssociations.ListInput
|
|
1983
|
-
) => Operation<ListAssociations.ListOutput>;
|
|
1808
|
+
list: (input: ListInput) => Operation<ListOutput>;
|
|
1984
1809
|
/**
|
|
1985
1810
|
* Get lists associated with a marketing event
|
|
1986
1811
|
* @apiPath /marketing/marketing-events/2026-03/associations/{externalAccountId}/{externalEventId}/lists
|
|
@@ -1988,18 +1813,121 @@ export namespace MarketingMarketingEvents {
|
|
|
1988
1813
|
* @requiredScopes marketing-events-write
|
|
1989
1814
|
*/
|
|
1990
1815
|
listByExternalAccount: (
|
|
1991
|
-
input:
|
|
1992
|
-
) => Operation<
|
|
1816
|
+
input: ListByExternalAccountInput
|
|
1817
|
+
) => Operation<ListByExternalAccountOutput>;
|
|
1818
|
+
}
|
|
1819
|
+
}
|
|
1820
|
+
|
|
1821
|
+
export namespace MarketingMarketingeventsParticipations {
|
|
1822
|
+
export interface GetByExternalAccountAndEventIdInput {
|
|
1823
|
+
/**
|
|
1824
|
+
* The accountId that is associated with this marketing event in the external event application.
|
|
1825
|
+
*/
|
|
1826
|
+
externalAccountId: string;
|
|
1827
|
+
/**
|
|
1828
|
+
* The id of the marketing event in the external event application.
|
|
1829
|
+
*/
|
|
1830
|
+
externalEventId: string;
|
|
1831
|
+
}
|
|
1832
|
+
|
|
1833
|
+
export type GetByExternalAccountAndEventIdOutput =
|
|
1834
|
+
MarketingMarketingEventsSchemas.AttendanceCounters;
|
|
1835
|
+
|
|
1836
|
+
export interface GetByIdInput {
|
|
1837
|
+
/**
|
|
1838
|
+
* The internal id of the marketing event in HubSpot.
|
|
1839
|
+
*/
|
|
1840
|
+
marketingEventId: number;
|
|
1841
|
+
}
|
|
1842
|
+
|
|
1843
|
+
export type GetByIdOutput =
|
|
1844
|
+
MarketingMarketingEventsSchemas.AttendanceCounters;
|
|
1845
|
+
|
|
1846
|
+
export interface ListBreakdownByContactInput {
|
|
1847
|
+
/**
|
|
1848
|
+
* The cursor indicating the position of the last retrieved item.
|
|
1849
|
+
*/
|
|
1850
|
+
after?: string;
|
|
1851
|
+
/**
|
|
1852
|
+
* The identifier of the Contact. It may be email or internal id.
|
|
1853
|
+
*/
|
|
1854
|
+
contactIdentifier: string;
|
|
1855
|
+
/**
|
|
1856
|
+
* The limit for response size. The default value is 10, the max number is 100
|
|
1857
|
+
*/
|
|
1858
|
+
limit?: number;
|
|
1859
|
+
/**
|
|
1860
|
+
* The participation state value. It may be REGISTERED, CANCELLED, ATTENDED, NO_SHOW
|
|
1861
|
+
*/
|
|
1862
|
+
state?: string;
|
|
1863
|
+
}
|
|
1864
|
+
|
|
1865
|
+
export type ListBreakdownByContactOutput =
|
|
1866
|
+
MarketingMarketingEventsSchemas.CollectionResponseWithTotalParticipationBreakdown;
|
|
1867
|
+
|
|
1868
|
+
export interface ListBreakdownByExternalAccountAndEventIdInput {
|
|
1869
|
+
/**
|
|
1870
|
+
* The cursor indicating the position of the last retrieved item.
|
|
1871
|
+
*/
|
|
1872
|
+
after?: string;
|
|
1873
|
+
/**
|
|
1874
|
+
* The identifier of the Contact. It may be email or internal id.
|
|
1875
|
+
*/
|
|
1876
|
+
contactIdentifier?: string;
|
|
1877
|
+
/**
|
|
1878
|
+
* The accountId that is associated with this marketing event in the external event application.
|
|
1879
|
+
*/
|
|
1880
|
+
externalAccountId: string;
|
|
1881
|
+
/**
|
|
1882
|
+
* The id of the marketing event in the external event application.
|
|
1883
|
+
*/
|
|
1884
|
+
externalEventId: string;
|
|
1885
|
+
/**
|
|
1886
|
+
* The limit for response size. The default value is 10, the max number is 100
|
|
1887
|
+
*/
|
|
1888
|
+
limit?: number;
|
|
1889
|
+
/**
|
|
1890
|
+
* The participation state value. It may be REGISTERED, CANCELLED, ATTENDED, NO_SHOW
|
|
1891
|
+
*/
|
|
1892
|
+
state?: string;
|
|
1893
|
+
}
|
|
1894
|
+
|
|
1895
|
+
export type ListBreakdownByExternalAccountAndEventIdOutput =
|
|
1896
|
+
MarketingMarketingEventsSchemas.CollectionResponseWithTotalParticipationBreakdown;
|
|
1897
|
+
|
|
1898
|
+
export interface ListBreakdownByIdInput {
|
|
1899
|
+
/**
|
|
1900
|
+
* The cursor indicating the position of the last retrieved item.
|
|
1901
|
+
*/
|
|
1902
|
+
after?: string;
|
|
1903
|
+
/**
|
|
1904
|
+
* The identifier of the Contact. It may be email or internal id.
|
|
1905
|
+
*/
|
|
1906
|
+
contactIdentifier?: string;
|
|
1907
|
+
/**
|
|
1908
|
+
* The limit for response size. The default value is 10, the max number is 100
|
|
1909
|
+
*/
|
|
1910
|
+
limit?: number;
|
|
1911
|
+
/**
|
|
1912
|
+
* The internal id of the marketing event in HubSpot.
|
|
1913
|
+
*/
|
|
1914
|
+
marketingEventId: number;
|
|
1915
|
+
/**
|
|
1916
|
+
* The participation state value. It may be REGISTERED, CANCELLED, ATTENDED, NO_SHOW
|
|
1917
|
+
*/
|
|
1918
|
+
state?: string;
|
|
1993
1919
|
}
|
|
1994
1920
|
|
|
1921
|
+
export type ListBreakdownByIdOutput =
|
|
1922
|
+
MarketingMarketingEventsSchemas.CollectionResponseWithTotalParticipationBreakdown;
|
|
1995
1923
|
/**
|
|
1996
1924
|
* Usage example:
|
|
1997
1925
|
* ```ts
|
|
1998
|
-
* import {
|
|
1999
|
-
* client.send(
|
|
1926
|
+
* import { marketingMarketingeventsParticipations } from '@hubspot/api-client-core';
|
|
1927
|
+
* client.send(marketingMarketingeventsParticipations.getByExternalAccountAndEventId(input));
|
|
2000
1928
|
* ```
|
|
2001
1929
|
*/
|
|
2002
|
-
export interface
|
|
1930
|
+
export interface API {
|
|
2003
1931
|
/**
|
|
2004
1932
|
* Read participations counters by Marketing Event external identifier
|
|
2005
1933
|
* @apiPath /marketing/marketing-events/2026-03/participations/{externalAccountId}/{externalEventId}
|
|
@@ -2007,17 +1935,15 @@ export namespace MarketingMarketingEvents {
|
|
|
2007
1935
|
* @requiredScopes marketing-events-read
|
|
2008
1936
|
*/
|
|
2009
1937
|
getByExternalAccountAndEventId: (
|
|
2010
|
-
input:
|
|
2011
|
-
) => Operation<
|
|
1938
|
+
input: GetByExternalAccountAndEventIdInput
|
|
1939
|
+
) => Operation<GetByExternalAccountAndEventIdOutput>;
|
|
2012
1940
|
/**
|
|
2013
1941
|
* Read participations counters by Marketing Event internal identifier
|
|
2014
1942
|
* @apiPath /marketing/marketing-events/2026-03/participations/{marketingEventId}
|
|
2015
1943
|
* @apiMethod GET
|
|
2016
1944
|
* @requiredScopes marketing-events-read
|
|
2017
1945
|
*/
|
|
2018
|
-
getById: (
|
|
2019
|
-
input: ParticipantState.GetByIdInput
|
|
2020
|
-
) => Operation<ParticipantState.GetByIdOutput>;
|
|
1946
|
+
getById: (input: GetByIdInput) => Operation<GetByIdOutput>;
|
|
2021
1947
|
/**
|
|
2022
1948
|
* Read participations breakdown by Contact identifier
|
|
2023
1949
|
* @apiPath /marketing/marketing-events/2026-03/participations/contacts/{contactIdentifier}/breakdown
|
|
@@ -2025,8 +1951,8 @@ export namespace MarketingMarketingEvents {
|
|
|
2025
1951
|
* @requiredScopes marketing-events-read
|
|
2026
1952
|
*/
|
|
2027
1953
|
listBreakdownByContact: (
|
|
2028
|
-
input:
|
|
2029
|
-
) => Operation<
|
|
1954
|
+
input: ListBreakdownByContactInput
|
|
1955
|
+
) => Operation<ListBreakdownByContactOutput>;
|
|
2030
1956
|
/**
|
|
2031
1957
|
* Read participations breakdown by Marketing Event external identifier
|
|
2032
1958
|
* @apiPath /marketing/marketing-events/2026-03/participations/{externalAccountId}/{externalEventId}/breakdown
|
|
@@ -2034,8 +1960,8 @@ export namespace MarketingMarketingEvents {
|
|
|
2034
1960
|
* @requiredScopes marketing-events-read
|
|
2035
1961
|
*/
|
|
2036
1962
|
listBreakdownByExternalAccountAndEventId: (
|
|
2037
|
-
input:
|
|
2038
|
-
) => Operation<
|
|
1963
|
+
input: ListBreakdownByExternalAccountAndEventIdInput
|
|
1964
|
+
) => Operation<ListBreakdownByExternalAccountAndEventIdOutput>;
|
|
2039
1965
|
/**
|
|
2040
1966
|
* Read participations breakdown by Marketing Event internal identifier
|
|
2041
1967
|
* @apiPath /marketing/marketing-events/2026-03/participations/{marketingEventId}/breakdown
|
|
@@ -2043,18 +1969,33 @@ export namespace MarketingMarketingEvents {
|
|
|
2043
1969
|
* @requiredScopes marketing-events-read
|
|
2044
1970
|
*/
|
|
2045
1971
|
listBreakdownById: (
|
|
2046
|
-
input:
|
|
2047
|
-
) => Operation<
|
|
1972
|
+
input: ListBreakdownByIdInput
|
|
1973
|
+
) => Operation<ListBreakdownByIdOutput>;
|
|
1974
|
+
}
|
|
1975
|
+
}
|
|
1976
|
+
|
|
1977
|
+
export namespace MarketingMarketingeventsSettings {
|
|
1978
|
+
export interface CreateOrUpdateInput {
|
|
1979
|
+
appId: number;
|
|
1980
|
+
data: MarketingMarketingEventsSchemas.EventDetailSettingsUrl;
|
|
1981
|
+
}
|
|
1982
|
+
|
|
1983
|
+
export type CreateOrUpdateOutput =
|
|
1984
|
+
MarketingMarketingEventsSchemas.EventDetailSettings;
|
|
1985
|
+
|
|
1986
|
+
export interface GetInput {
|
|
1987
|
+
appId: number;
|
|
2048
1988
|
}
|
|
2049
1989
|
|
|
1990
|
+
export type GetOutput = MarketingMarketingEventsSchemas.EventDetailSettings;
|
|
2050
1991
|
/**
|
|
2051
1992
|
* Usage example:
|
|
2052
1993
|
* ```ts
|
|
2053
|
-
* import {
|
|
2054
|
-
* client.send(
|
|
1994
|
+
* import { marketingMarketingeventsSettings } from '@hubspot/api-client-core';
|
|
1995
|
+
* client.send(marketingMarketingeventsSettings.createOrUpdate(input));
|
|
2055
1996
|
* ```
|
|
2056
1997
|
*/
|
|
2057
|
-
export interface
|
|
1998
|
+
export interface API {
|
|
2058
1999
|
/**
|
|
2059
2000
|
* Update the application settings
|
|
2060
2001
|
* @apiPath /marketing/marketing-events/2026-03/{appId}/settings
|
|
@@ -2062,25 +2003,44 @@ export namespace MarketingMarketingEvents {
|
|
|
2062
2003
|
* @requiredScopes developers-write
|
|
2063
2004
|
*/
|
|
2064
2005
|
createOrUpdate: (
|
|
2065
|
-
input:
|
|
2066
|
-
) => Operation<
|
|
2006
|
+
input: CreateOrUpdateInput
|
|
2007
|
+
) => Operation<CreateOrUpdateOutput>;
|
|
2067
2008
|
/**
|
|
2068
2009
|
* Retrieve the application settings
|
|
2069
2010
|
* @apiPath /marketing/marketing-events/2026-03/{appId}/settings
|
|
2070
2011
|
* @apiMethod GET
|
|
2071
2012
|
* @requiredScopes developers-read
|
|
2072
2013
|
*/
|
|
2073
|
-
get: (input:
|
|
2014
|
+
get: (input: GetInput) => Operation<GetOutput>;
|
|
2015
|
+
}
|
|
2016
|
+
}
|
|
2017
|
+
|
|
2018
|
+
export namespace MarketingMarketingeventsSubscriberstate {
|
|
2019
|
+
export interface RecordByEmailInput {
|
|
2020
|
+
data: MarketingMarketingEventsSchemas.BatchInputMarketingEventEmailSubscriber;
|
|
2021
|
+
externalAccountId: string;
|
|
2022
|
+
externalEventId: string;
|
|
2023
|
+
subscriberState: string;
|
|
2074
2024
|
}
|
|
2075
2025
|
|
|
2026
|
+
export type RecordByEmailOutput = void;
|
|
2027
|
+
|
|
2028
|
+
export interface RecordByIdInput {
|
|
2029
|
+
data: MarketingMarketingEventsSchemas.BatchInputMarketingEventSubscriber;
|
|
2030
|
+
externalAccountId: string;
|
|
2031
|
+
externalEventId: string;
|
|
2032
|
+
subscriberState: string;
|
|
2033
|
+
}
|
|
2034
|
+
|
|
2035
|
+
export type RecordByIdOutput = void;
|
|
2076
2036
|
/**
|
|
2077
2037
|
* Usage example:
|
|
2078
2038
|
* ```ts
|
|
2079
|
-
* import {
|
|
2080
|
-
* client.send(
|
|
2039
|
+
* import { marketingMarketingeventsSubscriberstate } from '@hubspot/api-client-core';
|
|
2040
|
+
* client.send(marketingMarketingeventsSubscriberstate.recordByEmail(input));
|
|
2081
2041
|
* ```
|
|
2082
2042
|
*/
|
|
2083
|
-
export interface
|
|
2043
|
+
export interface API {
|
|
2084
2044
|
/**
|
|
2085
2045
|
* Record a subscriber state by contact email
|
|
2086
2046
|
* @apiPath /marketing/marketing-events/2026-03/events/{externalEventId}/{subscriberState}/email-upsert
|
|
@@ -2088,35 +2048,14 @@ export namespace MarketingMarketingEvents {
|
|
|
2088
2048
|
* @requiredScopes marketing-events-write
|
|
2089
2049
|
*/
|
|
2090
2050
|
recordByEmail: (
|
|
2091
|
-
input:
|
|
2092
|
-
) => Operation<
|
|
2051
|
+
input: RecordByEmailInput
|
|
2052
|
+
) => Operation<RecordByEmailOutput>;
|
|
2093
2053
|
/**
|
|
2094
2054
|
* Record a subscriber state by contact ID
|
|
2095
2055
|
* @apiPath /marketing/marketing-events/2026-03/events/{externalEventId}/{subscriberState}/upsert
|
|
2096
2056
|
* @apiMethod POST
|
|
2097
2057
|
* @requiredScopes marketing-events-write
|
|
2098
2058
|
*/
|
|
2099
|
-
recordById: (
|
|
2100
|
-
input: SubscriberStateChanges.RecordByIdInput
|
|
2101
|
-
) => Operation<SubscriberStateChanges.RecordByIdOutput>;
|
|
2102
|
-
}
|
|
2103
|
-
|
|
2104
|
-
/**
|
|
2105
|
-
* Usage example:
|
|
2106
|
-
* ```ts
|
|
2107
|
-
* import { marketingMarketingEvents } from '@hubspot/api-client-core';
|
|
2108
|
-
* client.send(marketingMarketingEvents.basic.create(input));
|
|
2109
|
-
* ```
|
|
2110
|
-
*/
|
|
2111
|
-
export interface API {
|
|
2112
|
-
basic: BasicAPI;
|
|
2113
|
-
batch: BatchAPI;
|
|
2114
|
-
eventAttendees: EventAttendeesAPI;
|
|
2115
|
-
eventStatus: EventStatusAPI;
|
|
2116
|
-
identifiers: IdentifiersAPI;
|
|
2117
|
-
listAssociations: ListAssociationsAPI;
|
|
2118
|
-
participantState: ParticipantStateAPI;
|
|
2119
|
-
settings: SettingsAPI;
|
|
2120
|
-
subscriberStateChanges: SubscriberStateChangesAPI;
|
|
2059
|
+
recordById: (input: RecordByIdInput) => Operation<RecordByIdOutput>;
|
|
2121
2060
|
}
|
|
2122
2061
|
}
|