@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
package/src/server/api-client-core/apis/communication-preferences/subscriptions-types.generated.ts
CHANGED
|
@@ -2,844 +2,702 @@
|
|
|
2
2
|
|
|
3
3
|
import type { Operation } from '../../types.ts';
|
|
4
4
|
|
|
5
|
-
export namespace
|
|
6
|
-
export
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
*/
|
|
40
|
-
businessUnitId?: number;
|
|
41
|
-
/**
|
|
42
|
-
* The communication channel from which subscribers will be unsubscribed. This parameter is required and currently supports only 'EMAIL'.
|
|
43
|
-
*/
|
|
44
|
-
channel: 'EMAIL';
|
|
45
|
-
data: Schemas.BatchInputString;
|
|
46
|
-
/**
|
|
47
|
-
* A boolean indicating whether to include detailed information in the response. Defaults to false.
|
|
48
|
-
*/
|
|
49
|
-
verbose?: boolean;
|
|
50
|
-
}
|
|
51
|
-
|
|
52
|
-
export type UnsubscribeAllOutput =
|
|
53
|
-
Schemas.BatchResponsePublicBulkOptOutFromAllResponse;
|
|
54
|
-
|
|
55
|
-
export type UpdateStatusesInput = Schemas.BatchInputPublicStatusRequest;
|
|
56
|
-
|
|
57
|
-
export type UpdateStatusesOutput = Schemas.BatchResponsePublicStatus;
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
export namespace Definitions {
|
|
61
|
-
export interface ListInput {
|
|
62
|
-
/**
|
|
63
|
-
* An integer representing the ID of the business unit for which to retrieve subscription definitions.
|
|
64
|
-
*/
|
|
65
|
-
businessUnitId?: number;
|
|
66
|
-
/**
|
|
67
|
-
* A boolean indicating whether to include translations of the communication preferences definitions in the response.
|
|
68
|
-
*/
|
|
69
|
-
includeTranslations?: boolean;
|
|
70
|
-
}
|
|
71
|
-
|
|
72
|
-
export type ListOutput =
|
|
73
|
-
Schemas.ActionResponseWithResultsSubscriptionDefinition;
|
|
74
|
-
|
|
75
|
-
export interface UnsubscribeAllInput {
|
|
76
|
-
/**
|
|
77
|
-
* The ID of the business unit associated with the request. This is an optional integer parameter.
|
|
78
|
-
*/
|
|
79
|
-
businessUnitId?: number;
|
|
80
|
-
/**
|
|
81
|
-
* The communication channel to unsubscribe from. Must be 'EMAIL'.
|
|
82
|
-
*/
|
|
83
|
-
channel: 'EMAIL';
|
|
84
|
-
/**
|
|
85
|
-
* The unique identifier of the subscriber to unsubscribe from all communication preferences.
|
|
86
|
-
*/
|
|
87
|
-
subscriberIdString: string;
|
|
88
|
-
/**
|
|
89
|
-
* A boolean indicating whether to include detailed information in the response. Defaults to false.
|
|
90
|
-
*/
|
|
91
|
-
verbose?: boolean;
|
|
92
|
-
}
|
|
93
|
-
|
|
94
|
-
export type UnsubscribeAllOutput =
|
|
95
|
-
Schemas.ActionResponseWithResultsPublicStatus;
|
|
96
|
-
}
|
|
97
|
-
|
|
98
|
-
export namespace Schemas {
|
|
99
|
-
export interface ActionResponseWithResultsPublicStatus {
|
|
100
|
-
/**
|
|
101
|
-
* The date and time when the operation was completed.
|
|
102
|
-
*/
|
|
103
|
-
completedAt: string;
|
|
104
|
-
/**
|
|
105
|
-
* A list of errors that occurred during the operation.
|
|
106
|
-
*/
|
|
107
|
-
errors?: Schemas.StandardError[];
|
|
108
|
-
/**
|
|
109
|
-
* Contains URLs related to the response, such as documentation or resources.
|
|
110
|
-
*/
|
|
111
|
-
links?: Record<string, string>;
|
|
112
|
-
/**
|
|
113
|
-
* The number of errors that occurred during the operation.
|
|
114
|
-
*/
|
|
115
|
-
numErrors?: number;
|
|
116
|
-
/**
|
|
117
|
-
* The date and time when the request was made.
|
|
118
|
-
*/
|
|
119
|
-
requestedAt?: string;
|
|
120
|
-
/**
|
|
121
|
-
* An array of results from the operation.
|
|
122
|
-
*/
|
|
123
|
-
results: Schemas.PublicStatus[];
|
|
124
|
-
/**
|
|
125
|
-
* The date and time when the operation started.
|
|
126
|
-
*/
|
|
127
|
-
startedAt: string;
|
|
128
|
-
/**
|
|
129
|
-
* Indicates the current status of the operation, with possible values: PENDING, PROCESSING, CANCELED, COMPLETE.
|
|
130
|
-
*/
|
|
131
|
-
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
132
|
-
}
|
|
133
|
-
|
|
134
|
-
export interface ActionResponseWithResultsPublicWideStatus {
|
|
135
|
-
/**
|
|
136
|
-
* The date and time when the operation was completed.
|
|
137
|
-
*/
|
|
138
|
-
completedAt: string;
|
|
139
|
-
/**
|
|
140
|
-
* An array of error objects detailing any issues encountered during the operation.
|
|
141
|
-
*/
|
|
142
|
-
errors?: Schemas.StandardError[];
|
|
143
|
-
/**
|
|
144
|
-
* An object containing related links, where each key is a link name and each value is a URL.
|
|
145
|
-
*/
|
|
146
|
-
links?: Record<string, string>;
|
|
147
|
-
/**
|
|
148
|
-
* The number of errors encountered during the operation.
|
|
149
|
-
*/
|
|
150
|
-
numErrors?: number;
|
|
151
|
-
/**
|
|
152
|
-
* The date and time when the request was made.
|
|
153
|
-
*/
|
|
154
|
-
requestedAt?: string;
|
|
155
|
-
/**
|
|
156
|
-
* An array containing the results of the operation.
|
|
157
|
-
*/
|
|
158
|
-
results: Schemas.PublicWideStatus[];
|
|
159
|
-
/**
|
|
160
|
-
* The date and time when the operation started.
|
|
161
|
-
*/
|
|
162
|
-
startedAt: string;
|
|
163
|
-
/**
|
|
164
|
-
* The current status of the operation, which can be PENDING, PROCESSING, CANCELED, or COMPLETE.
|
|
165
|
-
*/
|
|
166
|
-
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
167
|
-
}
|
|
168
|
-
|
|
169
|
-
export interface ActionResponseWithResultsSubscriptionDefinition {
|
|
170
|
-
/**
|
|
171
|
-
* The date and time when the operation was completed.
|
|
172
|
-
*/
|
|
173
|
-
completedAt: string;
|
|
174
|
-
/**
|
|
175
|
-
* An array of errors that occurred during the operation.
|
|
176
|
-
*/
|
|
177
|
-
errors?: Schemas.StandardError[];
|
|
178
|
-
/**
|
|
179
|
-
* A collection of related links associated with the operation.
|
|
180
|
-
*/
|
|
181
|
-
links?: Record<string, string>;
|
|
182
|
-
/**
|
|
183
|
-
* The number of errors encountered during the operation.
|
|
184
|
-
*/
|
|
185
|
-
numErrors?: number;
|
|
186
|
-
/**
|
|
187
|
-
* The date and time when the operation was requested.
|
|
188
|
-
*/
|
|
189
|
-
requestedAt?: string;
|
|
190
|
-
/**
|
|
191
|
-
* An array containing the results of the operation.
|
|
192
|
-
*/
|
|
193
|
-
results: Schemas.SubscriptionDefinition[];
|
|
194
|
-
/**
|
|
195
|
-
* The date and time when the operation started.
|
|
196
|
-
*/
|
|
197
|
-
startedAt: string;
|
|
198
|
-
/**
|
|
199
|
-
* The current status of the operation, which can be PENDING, PROCESSING, CANCELED, or COMPLETE.
|
|
200
|
-
*/
|
|
201
|
-
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
202
|
-
}
|
|
203
|
-
|
|
204
|
-
export interface BatchInputPublicStatusRequest {
|
|
205
|
-
/**
|
|
206
|
-
* An array of PublicStatusRequest objects, each representing a subscription status update request. This property is required.
|
|
207
|
-
*/
|
|
208
|
-
inputs: Schemas.PublicStatusRequest[];
|
|
209
|
-
}
|
|
210
|
-
|
|
211
|
-
export interface BatchInputString {
|
|
212
|
-
/**
|
|
213
|
-
* A list of strings representing the inputs for batch operations.
|
|
214
|
-
*/
|
|
215
|
-
inputs: string[];
|
|
216
|
-
}
|
|
217
|
-
|
|
218
|
-
export interface BatchResponsePublicBulkOptOutFromAllResponse {
|
|
219
|
-
/**
|
|
220
|
-
* The date and time when the bulk opt-out operation was completed.
|
|
221
|
-
*/
|
|
222
|
-
completedAt: string;
|
|
223
|
-
/**
|
|
224
|
-
* An array of error objects detailing any issues encountered during the bulk opt-out operation.
|
|
225
|
-
*/
|
|
226
|
-
errors?: Schemas.StandardError[];
|
|
227
|
-
/**
|
|
228
|
-
* A collection of URLs linking to related resources or documentation.
|
|
229
|
-
*/
|
|
230
|
-
links?: Record<string, string>;
|
|
231
|
-
/**
|
|
232
|
-
* The total number of errors encountered during the bulk opt-out operation.
|
|
233
|
-
*/
|
|
234
|
-
numErrors?: number;
|
|
235
|
-
/**
|
|
236
|
-
* The date and time when the bulk opt-out request was made.
|
|
237
|
-
*/
|
|
238
|
-
requestedAt?: string;
|
|
239
|
-
/**
|
|
240
|
-
* An array containing the results of the bulk opt-out from all communications operation.
|
|
241
|
-
*/
|
|
242
|
-
results: Schemas.PublicBulkOptOutFromAllResponse[];
|
|
243
|
-
/**
|
|
244
|
-
* The date and time when the bulk opt-out operation began.
|
|
245
|
-
*/
|
|
246
|
-
startedAt: string;
|
|
247
|
-
/**
|
|
248
|
-
* The current status of the bulk opt-out operation, which can be PENDING, PROCESSING, CANCELED, or COMPLETE.
|
|
249
|
-
*/
|
|
250
|
-
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
251
|
-
}
|
|
252
|
-
|
|
253
|
-
export interface BatchResponsePublicStatus {
|
|
254
|
-
/**
|
|
255
|
-
* The date and time when the batch operation was completed.
|
|
256
|
-
*/
|
|
257
|
-
completedAt: string;
|
|
258
|
-
/**
|
|
259
|
-
* An array of error objects detailing any issues encountered.
|
|
260
|
-
*/
|
|
261
|
-
errors?: Schemas.StandardError[];
|
|
262
|
-
/**
|
|
263
|
-
* URLs linking to related resources or documentation.
|
|
264
|
-
*/
|
|
265
|
-
links?: Record<string, string>;
|
|
266
|
-
/**
|
|
267
|
-
* The number of errors encountered during the batch operation.
|
|
268
|
-
*/
|
|
269
|
-
numErrors?: number;
|
|
270
|
-
/**
|
|
271
|
-
* The date and time when the request was made.
|
|
272
|
-
*/
|
|
273
|
-
requestedAt?: string;
|
|
274
|
-
/**
|
|
275
|
-
* An array containing the results of the batch operation.
|
|
276
|
-
*/
|
|
277
|
-
results: Schemas.PublicStatus[];
|
|
278
|
-
/**
|
|
279
|
-
* The date and time when the batch operation started.
|
|
280
|
-
*/
|
|
281
|
-
startedAt: string;
|
|
282
|
-
/**
|
|
283
|
-
* The current status of the batch operation, which can be PENDING, PROCESSING, CANCELED, or COMPLETE.
|
|
284
|
-
*/
|
|
285
|
-
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
286
|
-
}
|
|
287
|
-
|
|
288
|
-
export interface BatchResponsePublicStatusBulkResponse {
|
|
289
|
-
/**
|
|
290
|
-
* The date and time when the batch process was completed.
|
|
291
|
-
*/
|
|
292
|
-
completedAt: string;
|
|
293
|
-
/**
|
|
294
|
-
* A collection of related links associated with the batch response.
|
|
295
|
-
*/
|
|
296
|
-
links?: Record<string, string>;
|
|
297
|
-
/**
|
|
298
|
-
* The date and time when the batch request was made.
|
|
299
|
-
*/
|
|
300
|
-
requestedAt?: string;
|
|
301
|
-
/**
|
|
302
|
-
* The array of results from the batch process, each containing subscription status information.
|
|
303
|
-
*/
|
|
304
|
-
results: Schemas.PublicStatusBulkResponse[];
|
|
305
|
-
/**
|
|
306
|
-
* The date and time when the batch process began.
|
|
307
|
-
*/
|
|
308
|
-
startedAt: string;
|
|
309
|
-
/**
|
|
310
|
-
* The current status of the batch process, with possible values: PENDING, PROCESSING, CANCELED, COMPLETE.
|
|
311
|
-
*/
|
|
312
|
-
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
313
|
-
}
|
|
314
|
-
|
|
315
|
-
export interface BatchResponsePublicWideStatusBulkResponse {
|
|
316
|
-
/**
|
|
317
|
-
* The date and time when the batch process was completed.
|
|
318
|
-
*/
|
|
319
|
-
completedAt: string;
|
|
320
|
-
/**
|
|
321
|
-
* A collection of related links associated with the batch response.
|
|
322
|
-
*/
|
|
323
|
-
links?: Record<string, string>;
|
|
324
|
-
/**
|
|
325
|
-
* The date and time when the batch request was made.
|
|
326
|
-
*/
|
|
327
|
-
requestedAt?: string;
|
|
328
|
-
/**
|
|
329
|
-
* The array of results from the batch process, each containing subscription status information.
|
|
330
|
-
*/
|
|
331
|
-
results: Schemas.PublicWideStatusBulkResponse[];
|
|
332
|
-
/**
|
|
333
|
-
* The date and time when the batch process began.
|
|
334
|
-
*/
|
|
335
|
-
startedAt: string;
|
|
336
|
-
/**
|
|
337
|
-
* The current status of the batch process, with possible values: PENDING, PROCESSING, CANCELED, COMPLETE.
|
|
338
|
-
*/
|
|
339
|
-
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
340
|
-
}
|
|
341
|
-
|
|
342
|
-
export interface ErrorDetail {
|
|
343
|
-
/**
|
|
344
|
-
* The status code associated with the error detail
|
|
345
|
-
*/
|
|
346
|
-
code?: string;
|
|
347
|
-
/**
|
|
348
|
-
* Context about the error condition
|
|
349
|
-
*/
|
|
350
|
-
context?: Record<string, string[]>;
|
|
351
|
-
/**
|
|
352
|
-
* The name of the field or parameter in which the error was found.
|
|
353
|
-
*/
|
|
354
|
-
in?: string;
|
|
355
|
-
/**
|
|
356
|
-
* A human readable message describing the error along with remediation steps where appropriate
|
|
357
|
-
*/
|
|
358
|
-
message: string;
|
|
359
|
-
/**
|
|
360
|
-
* A specific category that contains more specific detail about the error
|
|
361
|
-
*/
|
|
362
|
-
subCategory?: string;
|
|
363
|
-
}
|
|
364
|
-
|
|
365
|
-
export interface LinkGenerationRequest {
|
|
366
|
-
/**
|
|
367
|
-
* The language in which the generated link should be presented, represented as a string.
|
|
368
|
-
*/
|
|
369
|
-
language?: string;
|
|
370
|
-
/**
|
|
371
|
-
* A string representing the unique identifier of the subscriber. This property is required.
|
|
372
|
-
*/
|
|
373
|
-
subscriberIdString: string;
|
|
374
|
-
/**
|
|
375
|
-
* The unique identifier for the subscription, represented as an integer in int64 format.
|
|
376
|
-
*/
|
|
377
|
-
subscriptionId?: number;
|
|
378
|
-
}
|
|
379
|
-
|
|
380
|
-
export interface LinkGenerationResponse {
|
|
381
|
-
/**
|
|
382
|
-
* The URL where the subscriber can manage their communication preferences.
|
|
383
|
-
*/
|
|
384
|
-
managePreferencesUrl: string;
|
|
385
|
-
/**
|
|
386
|
-
* A string representing the unique identifier of the subscriber.
|
|
387
|
-
*/
|
|
388
|
-
subscriberIdString: string;
|
|
389
|
-
/**
|
|
390
|
-
* A string containing the URL for unsubscribing the subscriber from all communications.
|
|
391
|
-
*/
|
|
392
|
-
unsubscribeAllUrl: string;
|
|
393
|
-
/**
|
|
394
|
-
* A string containing the URL to unsubscribe the subscriber from a single communication.
|
|
395
|
-
*/
|
|
396
|
-
unsubscribeSingleUrl?: string;
|
|
397
|
-
}
|
|
398
|
-
|
|
399
|
-
export interface PartialPublicStatusRequest {
|
|
400
|
-
/**
|
|
401
|
-
* The type of communication channel, with 'EMAIL' as the only supported option.
|
|
402
|
-
*/
|
|
403
|
-
channel: 'EMAIL';
|
|
404
|
-
/**
|
|
405
|
-
* The legal basis for communication, with options including 'LEGITIMATE_INTEREST_PQL', 'LEGITIMATE_INTEREST_CLIENT', 'PERFORMANCE_OF_CONTRACT', 'CONSENT_WITH_NOTICE', 'NON_GDPR', 'PROCESS_AND_STORE', and 'LEGITIMATE_INTEREST_OTHER'.
|
|
406
|
-
*/
|
|
407
|
-
legalBasis?:
|
|
408
|
-
| 'CONSENT_WITH_NOTICE'
|
|
409
|
-
| 'LEGITIMATE_INTEREST_CLIENT'
|
|
410
|
-
| 'LEGITIMATE_INTEREST_OTHER'
|
|
411
|
-
| 'LEGITIMATE_INTEREST_PQL'
|
|
412
|
-
| 'NON_GDPR'
|
|
413
|
-
| 'PERFORMANCE_OF_CONTRACT'
|
|
414
|
-
| 'PROCESS_AND_STORE';
|
|
415
|
-
/**
|
|
416
|
-
* An explanation for the legal basis used for communication.
|
|
417
|
-
*/
|
|
418
|
-
legalBasisExplanation?: string;
|
|
419
|
-
/**
|
|
420
|
-
* The current subscription status of the contact, which can be 'SUBSCRIBED', 'UNSUBSCRIBED', or 'NOT_SPECIFIED'.
|
|
421
|
-
*/
|
|
422
|
-
statusState: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED';
|
|
423
|
-
/**
|
|
424
|
-
* The unique identifier of the subscription to be updated.
|
|
425
|
-
*/
|
|
426
|
-
subscriptionId: number;
|
|
427
|
-
}
|
|
428
|
-
|
|
429
|
-
export interface PublicBulkOptOutFromAllResponse {
|
|
430
|
-
/**
|
|
431
|
-
* An array of subscription status objects for the contact.
|
|
432
|
-
*/
|
|
433
|
-
statuses?: Schemas.PublicStatus[];
|
|
434
|
-
/**
|
|
435
|
-
* The email address of the contact.
|
|
436
|
-
*/
|
|
437
|
-
subscriberIdString: string;
|
|
438
|
-
}
|
|
439
|
-
|
|
440
|
-
export interface PublicStatus {
|
|
441
|
-
/**
|
|
442
|
-
* The ID of the business unit associated with the subscription.
|
|
443
|
-
*/
|
|
444
|
-
businessUnitId?: number;
|
|
445
|
-
/**
|
|
446
|
-
* The type of communication channel, with 'EMAIL' as the only supported option.
|
|
447
|
-
*/
|
|
448
|
-
channel: 'EMAIL';
|
|
449
|
-
/**
|
|
450
|
-
* The legal basis for communication, with options including 'LEGITIMATE_INTEREST_PQL', 'LEGITIMATE_INTEREST_CLIENT', 'PERFORMANCE_OF_CONTRACT', 'CONSENT_WITH_NOTICE', 'NON_GDPR', 'PROCESS_AND_STORE', and 'LEGITIMATE_INTEREST_OTHER'.
|
|
451
|
-
*/
|
|
452
|
-
legalBasis?:
|
|
453
|
-
| 'CONSENT_WITH_NOTICE'
|
|
454
|
-
| 'LEGITIMATE_INTEREST_CLIENT'
|
|
455
|
-
| 'LEGITIMATE_INTEREST_OTHER'
|
|
456
|
-
| 'LEGITIMATE_INTEREST_PQL'
|
|
457
|
-
| 'NON_GDPR'
|
|
458
|
-
| 'PERFORMANCE_OF_CONTRACT'
|
|
459
|
-
| 'PROCESS_AND_STORE';
|
|
460
|
-
/**
|
|
461
|
-
* An explanation for the legal basis used for communication.
|
|
462
|
-
*/
|
|
463
|
-
legalBasisExplanation?: string;
|
|
464
|
-
/**
|
|
465
|
-
* The reason for the successful change in subscription status, such as 'RESUBSCRIBE_OCCURRED' or 'NO_STATUS_CHANGE'.
|
|
466
|
-
*/
|
|
467
|
-
setStatusSuccessReason?:
|
|
468
|
-
| 'NO_STATUS_CHANGE'
|
|
469
|
-
| 'REQUESTED_CHANGE_OCCURRED'
|
|
470
|
-
| 'RESUBSCRIBE_OCCURRED'
|
|
471
|
-
| 'UNSUBSCRIBE_FROM_ALL_OCCURRED';
|
|
472
|
-
/**
|
|
473
|
-
* The origin or method through which the subscription status was set.
|
|
474
|
-
*/
|
|
475
|
-
source: string;
|
|
476
|
-
/**
|
|
477
|
-
* The current subscription status of the contact, which can be 'SUBSCRIBED', 'UNSUBSCRIBED', or 'NOT_SPECIFIED'.
|
|
478
|
-
*/
|
|
479
|
-
status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED';
|
|
480
|
-
/**
|
|
481
|
-
* The contact's email address.
|
|
482
|
-
*/
|
|
483
|
-
subscriberIdString: string;
|
|
484
|
-
/**
|
|
485
|
-
* The unique identifier of the subscription.
|
|
486
|
-
*/
|
|
487
|
-
subscriptionId: number;
|
|
488
|
-
/**
|
|
489
|
-
* The name of the subscription.
|
|
490
|
-
*/
|
|
491
|
-
subscriptionName?: string;
|
|
492
|
-
/**
|
|
493
|
-
* The date and time when the subscription status was last updated.
|
|
494
|
-
*/
|
|
495
|
-
timestamp: string;
|
|
496
|
-
}
|
|
497
|
-
|
|
498
|
-
export interface PublicStatusBulkResponse {
|
|
499
|
-
/**
|
|
500
|
-
* An array of subscription status objects for the contact.
|
|
501
|
-
*/
|
|
502
|
-
statuses: Schemas.PublicStatus[];
|
|
503
|
-
/**
|
|
504
|
-
* The email address of the contact.
|
|
505
|
-
*/
|
|
506
|
-
subscriberIdString: string;
|
|
507
|
-
}
|
|
508
|
-
|
|
509
|
-
export interface PublicStatusRequest {
|
|
510
|
-
/**
|
|
511
|
-
* The type of communication channel. Currently, only `EMAIL` is supported.
|
|
512
|
-
*/
|
|
513
|
-
channel: 'EMAIL';
|
|
514
|
-
/**
|
|
515
|
-
* The legal basis for communication.
|
|
516
|
-
*/
|
|
517
|
-
legalBasis?:
|
|
518
|
-
| 'CONSENT_WITH_NOTICE'
|
|
519
|
-
| 'LEGITIMATE_INTEREST_CLIENT'
|
|
520
|
-
| 'LEGITIMATE_INTEREST_OTHER'
|
|
521
|
-
| 'LEGITIMATE_INTEREST_PQL'
|
|
522
|
-
| 'NON_GDPR'
|
|
523
|
-
| 'PERFORMANCE_OF_CONTRACT'
|
|
524
|
-
| 'PROCESS_AND_STORE';
|
|
525
|
-
/**
|
|
526
|
-
* The explanation for the legal basis.
|
|
527
|
-
*/
|
|
528
|
-
legalBasisExplanation?: string;
|
|
529
|
-
/**
|
|
530
|
-
* The status of the contact's subscription.
|
|
531
|
-
*/
|
|
532
|
-
statusState: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED';
|
|
533
|
-
/**
|
|
534
|
-
* The contact's email address.
|
|
535
|
-
*/
|
|
536
|
-
subscriberIdString: string;
|
|
537
|
-
/**
|
|
538
|
-
* The ID of the subscription to update.
|
|
539
|
-
*/
|
|
540
|
-
subscriptionId: number;
|
|
541
|
-
}
|
|
542
|
-
|
|
543
|
-
export interface PublicSubscriptionTranslation {
|
|
544
|
-
/**
|
|
545
|
-
* The timestamp indicating when the subscription translation was created.
|
|
546
|
-
*/
|
|
547
|
-
createdAt: number;
|
|
548
|
-
/**
|
|
549
|
-
* A text description of the subscription translation.
|
|
550
|
-
*/
|
|
551
|
-
description: string;
|
|
552
|
-
/**
|
|
553
|
-
* The code representing the language of the subscription translation.
|
|
554
|
-
*/
|
|
555
|
-
languageCode: string;
|
|
556
|
-
/**
|
|
557
|
-
* The name of the subscription translation.
|
|
558
|
-
*/
|
|
559
|
-
name: string;
|
|
560
|
-
/**
|
|
561
|
-
* The unique identifier for the subscription associated with the translation.
|
|
562
|
-
*/
|
|
563
|
-
subscriptionId: number;
|
|
564
|
-
/**
|
|
565
|
-
* The timestamp indicating when the subscription translation was last updated.
|
|
566
|
-
*/
|
|
567
|
-
updatedAt: number;
|
|
568
|
-
}
|
|
569
|
-
|
|
570
|
-
export interface PublicWideStatus {
|
|
571
|
-
/**
|
|
572
|
-
* The ID of the business unit associated with the status.
|
|
573
|
-
*/
|
|
574
|
-
businessUnitId?: number;
|
|
575
|
-
/**
|
|
576
|
-
* The type of communication channel, with 'EMAIL' as the only supported option.
|
|
577
|
-
*/
|
|
578
|
-
channel: 'EMAIL';
|
|
579
|
-
/**
|
|
580
|
-
* The subscription status of the contact, which can be 'SUBSCRIBED', 'UNSUBSCRIBED', or 'NOT_SPECIFIED'.
|
|
581
|
-
*/
|
|
582
|
-
status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED';
|
|
583
|
-
/**
|
|
584
|
-
* The email address of the contact.
|
|
585
|
-
*/
|
|
586
|
-
subscriberIdString: string;
|
|
587
|
-
/**
|
|
588
|
-
* The date and time when the status was recorded.
|
|
589
|
-
*/
|
|
590
|
-
timestamp: string;
|
|
591
|
-
/**
|
|
592
|
-
* The type of wide status, which can be 'PORTAL_WIDE' or 'BUSINESS_UNIT_WIDE'.
|
|
593
|
-
*/
|
|
594
|
-
wideStatusType: 'BUSINESS_UNIT_WIDE' | 'PORTAL_WIDE';
|
|
595
|
-
}
|
|
596
|
-
|
|
597
|
-
export interface PublicWideStatusBulkResponse {
|
|
598
|
-
/**
|
|
599
|
-
* The contact's email address.
|
|
600
|
-
*/
|
|
601
|
-
subscriberIdString: string;
|
|
602
|
-
/**
|
|
603
|
-
* An array containing the wide status results for the operation.
|
|
604
|
-
*/
|
|
605
|
-
wideStatuses: Schemas.PublicWideStatus[];
|
|
606
|
-
}
|
|
607
|
-
|
|
608
|
-
/**
|
|
609
|
-
* Ye olde error
|
|
610
|
-
*/
|
|
611
|
-
export interface StandardError {
|
|
612
|
-
/**
|
|
613
|
-
* A string that categorizes the type of error.
|
|
614
|
-
*/
|
|
615
|
-
category: string;
|
|
616
|
-
/**
|
|
617
|
-
* An object containing additional context about the error condition, with keys as context names and values as arrays of strings.
|
|
618
|
-
*/
|
|
619
|
-
context: Record<string, string[]>;
|
|
620
|
-
/**
|
|
621
|
-
* An array of ErrorDetail objects providing further information about the error.
|
|
622
|
-
*/
|
|
623
|
-
errors: Schemas.ErrorDetail[];
|
|
624
|
-
/**
|
|
625
|
-
* A string representing the unique identifier of the error.
|
|
626
|
-
*/
|
|
627
|
-
id?: string;
|
|
628
|
-
/**
|
|
629
|
-
* An object mapping link names to associated URIs that contain documentation about the error or recommended remediation steps.
|
|
630
|
-
*/
|
|
631
|
-
links: Record<string, string>;
|
|
632
|
-
/**
|
|
633
|
-
* A string containing a human-readable message describing the error.
|
|
634
|
-
*/
|
|
635
|
-
message: string;
|
|
636
|
-
/**
|
|
637
|
-
* A string indicating the status of the error.
|
|
638
|
-
*/
|
|
639
|
-
status: string;
|
|
640
|
-
/**
|
|
641
|
-
* An object providing more specific categorization of the error.
|
|
642
|
-
*/
|
|
643
|
-
subCategory?: Record<string, never>;
|
|
644
|
-
}
|
|
645
|
-
|
|
646
|
-
export interface SubscriptionDefinition {
|
|
647
|
-
/**
|
|
648
|
-
* The ID of the business unit associated with the subscription.
|
|
649
|
-
*/
|
|
650
|
-
businessUnitId?: number;
|
|
651
|
-
/**
|
|
652
|
-
* The method of communication for the subscription.
|
|
653
|
-
*/
|
|
654
|
-
communicationMethod?: string;
|
|
655
|
-
/**
|
|
656
|
-
* The date and time when the subscription was created.
|
|
657
|
-
*/
|
|
658
|
-
createdAt: string;
|
|
659
|
-
/**
|
|
660
|
-
* A description of the subscription.
|
|
661
|
-
*/
|
|
662
|
-
description: string;
|
|
663
|
-
/**
|
|
664
|
-
* The unique identifier for the subscription.
|
|
665
|
-
*/
|
|
666
|
-
id: string;
|
|
667
|
-
/**
|
|
668
|
-
* Indicates whether the subscription is active.
|
|
669
|
-
*/
|
|
670
|
-
isActive: boolean;
|
|
671
|
-
/**
|
|
672
|
-
* Indicates whether the subscription is the default option.
|
|
673
|
-
*/
|
|
674
|
-
isDefault: boolean;
|
|
675
|
-
/**
|
|
676
|
-
* Indicates whether the subscription is internal.
|
|
677
|
-
*/
|
|
678
|
-
isInternal: boolean;
|
|
679
|
-
/**
|
|
680
|
-
* The name of the subscription.
|
|
681
|
-
*/
|
|
682
|
-
name: string;
|
|
683
|
-
/**
|
|
684
|
-
* The purpose of the subscription.
|
|
685
|
-
*/
|
|
686
|
-
purpose?: string;
|
|
687
|
-
/**
|
|
688
|
-
* A list of translations associated with the subscription.
|
|
689
|
-
*/
|
|
690
|
-
subscriptionTranslations?: Schemas.PublicSubscriptionTranslation[];
|
|
691
|
-
/**
|
|
692
|
-
* The date and time when the subscription was last updated.
|
|
693
|
-
*/
|
|
694
|
-
updatedAt: string;
|
|
695
|
-
}
|
|
696
|
-
}
|
|
697
|
-
|
|
698
|
-
export namespace Status {
|
|
699
|
-
export interface GenerateLinksInput {
|
|
700
|
-
/**
|
|
701
|
-
* The identifier of the business unit. Defaults to 0 if not specified.
|
|
702
|
-
*/
|
|
703
|
-
businessUnitId?: number;
|
|
704
|
-
/**
|
|
705
|
-
* The communication channel for which the links are generated. Must be 'EMAIL'.
|
|
706
|
-
*/
|
|
707
|
-
channel: 'EMAIL';
|
|
708
|
-
data: Schemas.LinkGenerationRequest;
|
|
709
|
-
}
|
|
710
|
-
|
|
711
|
-
export type GenerateLinksOutput = Schemas.LinkGenerationResponse;
|
|
712
|
-
|
|
713
|
-
export interface GetStatusesInput {
|
|
714
|
-
/**
|
|
715
|
-
* The ID of the business unit to filter the subscription status by. This is an optional parameter.
|
|
716
|
-
*/
|
|
717
|
-
businessUnitId?: number;
|
|
718
|
-
/**
|
|
719
|
-
* The communication channel for which the subscription status is being retrieved. This parameter is required and currently supports only 'EMAIL'.
|
|
720
|
-
*/
|
|
721
|
-
channel: 'EMAIL';
|
|
722
|
-
/**
|
|
723
|
-
* The unique identifier of the subscriber whose communication preferences status is being retrieved.
|
|
724
|
-
*/
|
|
725
|
-
subscriberIdString: string;
|
|
726
|
-
}
|
|
727
|
-
|
|
728
|
-
export type GetStatusesOutput =
|
|
729
|
-
Schemas.ActionResponseWithResultsPublicStatus;
|
|
730
|
-
|
|
731
|
-
export interface GetUnsubscribeAllStatusInput {
|
|
732
|
-
/**
|
|
733
|
-
* The ID of the business unit to which the subscriber belongs. This is an optional parameter.
|
|
734
|
-
*/
|
|
735
|
-
businessUnitId?: number;
|
|
736
|
-
/**
|
|
737
|
-
* The communication channel from which to unsubscribe the subscriber. This is a required parameter and must be 'EMAIL'.
|
|
738
|
-
*/
|
|
739
|
-
channel: 'EMAIL';
|
|
740
|
-
/**
|
|
741
|
-
* The unique identifier of the subscriber to unsubscribe from all communication preferences.
|
|
742
|
-
*/
|
|
743
|
-
subscriberIdString: string;
|
|
744
|
-
/**
|
|
745
|
-
* A boolean indicating whether to include detailed information in the response. Defaults to false.
|
|
746
|
-
*/
|
|
747
|
-
verbose?: boolean;
|
|
748
|
-
}
|
|
749
|
-
|
|
750
|
-
export type GetUnsubscribeAllStatusOutput =
|
|
751
|
-
Schemas.ActionResponseWithResultsPublicWideStatus;
|
|
752
|
-
|
|
753
|
-
export interface UpdateStatusInput {
|
|
754
|
-
data: Schemas.PartialPublicStatusRequest;
|
|
755
|
-
/**
|
|
756
|
-
* The unique identifier of the subscriber whose communication preferences status is being updated.
|
|
757
|
-
*/
|
|
758
|
-
subscriberIdString: string;
|
|
759
|
-
}
|
|
760
|
-
|
|
761
|
-
export type UpdateStatusOutput =
|
|
762
|
-
Schemas.ActionResponseWithResultsPublicStatus;
|
|
5
|
+
export namespace CommunicationPreferencesSubscriptionsSchemas {
|
|
6
|
+
export interface ActionResponseWithResultsPublicStatus {
|
|
7
|
+
/**
|
|
8
|
+
* The date and time when the operation was completed.
|
|
9
|
+
*/
|
|
10
|
+
completedAt: string;
|
|
11
|
+
/**
|
|
12
|
+
* A list of errors that occurred during the operation.
|
|
13
|
+
*/
|
|
14
|
+
errors?: StandardError[];
|
|
15
|
+
/**
|
|
16
|
+
* Contains URLs related to the response, such as documentation or resources.
|
|
17
|
+
*/
|
|
18
|
+
links?: Record<string, string>;
|
|
19
|
+
/**
|
|
20
|
+
* The number of errors that occurred during the operation.
|
|
21
|
+
*/
|
|
22
|
+
numErrors?: number;
|
|
23
|
+
/**
|
|
24
|
+
* The date and time when the request was made.
|
|
25
|
+
*/
|
|
26
|
+
requestedAt?: string;
|
|
27
|
+
/**
|
|
28
|
+
* An array of results from the operation.
|
|
29
|
+
*/
|
|
30
|
+
results: PublicStatus[];
|
|
31
|
+
/**
|
|
32
|
+
* The date and time when the operation started.
|
|
33
|
+
*/
|
|
34
|
+
startedAt: string;
|
|
35
|
+
/**
|
|
36
|
+
* Indicates the current status of the operation, with possible values: PENDING, PROCESSING, CANCELED, COMPLETE.
|
|
37
|
+
*/
|
|
38
|
+
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
763
39
|
}
|
|
764
40
|
|
|
765
|
-
|
|
766
|
-
* Usage example:
|
|
767
|
-
* ```ts
|
|
768
|
-
* import { communicationPreferencesSubscriptions } from '@hubspot/api-client-core';
|
|
769
|
-
* client.send(communicationPreferencesSubscriptions.batch.getUnsubscribeAllStatuses(input));
|
|
770
|
-
* ```
|
|
771
|
-
*/
|
|
772
|
-
export interface BatchAPI {
|
|
41
|
+
export interface ActionResponseWithResultsPublicWideStatus {
|
|
773
42
|
/**
|
|
774
|
-
*
|
|
775
|
-
* @apiPath /communication-preferences/2026-03/statuses/batch/unsubscribe-all/read
|
|
776
|
-
* @apiMethod POST
|
|
777
|
-
* @requiredScopes subscription-status-batch-read
|
|
43
|
+
* The date and time when the operation was completed.
|
|
778
44
|
*/
|
|
779
|
-
|
|
780
|
-
input: Batch.GetUnsubscribeAllStatusesInput
|
|
781
|
-
) => Operation<Batch.GetUnsubscribeAllStatusesOutput>;
|
|
45
|
+
completedAt: string;
|
|
782
46
|
/**
|
|
783
|
-
*
|
|
784
|
-
* @apiPath /communication-preferences/2026-03/statuses/batch/read
|
|
785
|
-
* @apiMethod POST
|
|
786
|
-
* @requiredScopes subscription-status-batch-read
|
|
47
|
+
* An array of error objects detailing any issues encountered during the operation.
|
|
787
48
|
*/
|
|
788
|
-
|
|
49
|
+
errors?: StandardError[];
|
|
789
50
|
/**
|
|
790
|
-
*
|
|
791
|
-
* @apiPath /communication-preferences/2026-03/statuses/batch/unsubscribe-all
|
|
792
|
-
* @apiMethod POST
|
|
793
|
-
* @requiredScopes subscription-status-batch-write
|
|
51
|
+
* An object containing related links, where each key is a link name and each value is a URL.
|
|
794
52
|
*/
|
|
795
|
-
|
|
796
|
-
input: Batch.UnsubscribeAllInput
|
|
797
|
-
) => Operation<Batch.UnsubscribeAllOutput>;
|
|
53
|
+
links?: Record<string, string>;
|
|
798
54
|
/**
|
|
799
|
-
*
|
|
800
|
-
* @apiPath /communication-preferences/2026-03/statuses/batch/write
|
|
801
|
-
* @apiMethod POST
|
|
802
|
-
* @requiredScopes subscription-status-batch-write
|
|
55
|
+
* The number of errors encountered during the operation.
|
|
803
56
|
*/
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
|
|
57
|
+
numErrors?: number;
|
|
58
|
+
/**
|
|
59
|
+
* The date and time when the request was made.
|
|
60
|
+
*/
|
|
61
|
+
requestedAt?: string;
|
|
62
|
+
/**
|
|
63
|
+
* An array containing the results of the operation.
|
|
64
|
+
*/
|
|
65
|
+
results: PublicWideStatus[];
|
|
66
|
+
/**
|
|
67
|
+
* The date and time when the operation started.
|
|
68
|
+
*/
|
|
69
|
+
startedAt: string;
|
|
70
|
+
/**
|
|
71
|
+
* The current status of the operation, which can be PENDING, PROCESSING, CANCELED, or COMPLETE.
|
|
72
|
+
*/
|
|
73
|
+
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
export interface ActionResponseWithResultsSubscriptionDefinition {
|
|
77
|
+
/**
|
|
78
|
+
* The date and time when the operation was completed.
|
|
79
|
+
*/
|
|
80
|
+
completedAt: string;
|
|
81
|
+
/**
|
|
82
|
+
* An array of errors that occurred during the operation.
|
|
83
|
+
*/
|
|
84
|
+
errors?: StandardError[];
|
|
85
|
+
/**
|
|
86
|
+
* A collection of related links associated with the operation.
|
|
87
|
+
*/
|
|
88
|
+
links?: Record<string, string>;
|
|
89
|
+
/**
|
|
90
|
+
* The number of errors encountered during the operation.
|
|
91
|
+
*/
|
|
92
|
+
numErrors?: number;
|
|
93
|
+
/**
|
|
94
|
+
* The date and time when the operation was requested.
|
|
95
|
+
*/
|
|
96
|
+
requestedAt?: string;
|
|
97
|
+
/**
|
|
98
|
+
* An array containing the results of the operation.
|
|
99
|
+
*/
|
|
100
|
+
results: SubscriptionDefinition[];
|
|
101
|
+
/**
|
|
102
|
+
* The date and time when the operation started.
|
|
103
|
+
*/
|
|
104
|
+
startedAt: string;
|
|
105
|
+
/**
|
|
106
|
+
* The current status of the operation, which can be PENDING, PROCESSING, CANCELED, or COMPLETE.
|
|
107
|
+
*/
|
|
108
|
+
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
export interface BatchInputPublicStatusRequest {
|
|
112
|
+
/**
|
|
113
|
+
* An array of PublicStatusRequest objects, each representing a subscription status update request. This property is required.
|
|
114
|
+
*/
|
|
115
|
+
inputs: PublicStatusRequest[];
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
export interface BatchInputString {
|
|
119
|
+
/**
|
|
120
|
+
* A list of strings representing the inputs for batch operations.
|
|
121
|
+
*/
|
|
122
|
+
inputs: string[];
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
export interface BatchResponsePublicBulkOptOutFromAllResponse {
|
|
126
|
+
/**
|
|
127
|
+
* The date and time when the bulk opt-out operation was completed.
|
|
128
|
+
*/
|
|
129
|
+
completedAt: string;
|
|
130
|
+
/**
|
|
131
|
+
* An array of error objects detailing any issues encountered during the bulk opt-out operation.
|
|
132
|
+
*/
|
|
133
|
+
errors?: StandardError[];
|
|
134
|
+
/**
|
|
135
|
+
* A collection of URLs linking to related resources or documentation.
|
|
136
|
+
*/
|
|
137
|
+
links?: Record<string, string>;
|
|
138
|
+
/**
|
|
139
|
+
* The total number of errors encountered during the bulk opt-out operation.
|
|
140
|
+
*/
|
|
141
|
+
numErrors?: number;
|
|
142
|
+
/**
|
|
143
|
+
* The date and time when the bulk opt-out request was made.
|
|
144
|
+
*/
|
|
145
|
+
requestedAt?: string;
|
|
146
|
+
/**
|
|
147
|
+
* An array containing the results of the bulk opt-out from all communications operation.
|
|
148
|
+
*/
|
|
149
|
+
results: PublicBulkOptOutFromAllResponse[];
|
|
150
|
+
/**
|
|
151
|
+
* The date and time when the bulk opt-out operation began.
|
|
152
|
+
*/
|
|
153
|
+
startedAt: string;
|
|
154
|
+
/**
|
|
155
|
+
* The current status of the bulk opt-out operation, which can be PENDING, PROCESSING, CANCELED, or COMPLETE.
|
|
156
|
+
*/
|
|
157
|
+
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
158
|
+
}
|
|
159
|
+
|
|
160
|
+
export interface BatchResponsePublicStatus {
|
|
161
|
+
/**
|
|
162
|
+
* The date and time when the batch operation was completed.
|
|
163
|
+
*/
|
|
164
|
+
completedAt: string;
|
|
165
|
+
/**
|
|
166
|
+
* An array of error objects detailing any issues encountered.
|
|
167
|
+
*/
|
|
168
|
+
errors?: StandardError[];
|
|
169
|
+
/**
|
|
170
|
+
* URLs linking to related resources or documentation.
|
|
171
|
+
*/
|
|
172
|
+
links?: Record<string, string>;
|
|
173
|
+
/**
|
|
174
|
+
* The number of errors encountered during the batch operation.
|
|
175
|
+
*/
|
|
176
|
+
numErrors?: number;
|
|
177
|
+
/**
|
|
178
|
+
* The date and time when the request was made.
|
|
179
|
+
*/
|
|
180
|
+
requestedAt?: string;
|
|
181
|
+
/**
|
|
182
|
+
* An array containing the results of the batch operation.
|
|
183
|
+
*/
|
|
184
|
+
results: PublicStatus[];
|
|
185
|
+
/**
|
|
186
|
+
* The date and time when the batch operation started.
|
|
187
|
+
*/
|
|
188
|
+
startedAt: string;
|
|
189
|
+
/**
|
|
190
|
+
* The current status of the batch operation, which can be PENDING, PROCESSING, CANCELED, or COMPLETE.
|
|
191
|
+
*/
|
|
192
|
+
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
export interface BatchResponsePublicStatusBulkResponse {
|
|
196
|
+
/**
|
|
197
|
+
* The date and time when the batch process was completed.
|
|
198
|
+
*/
|
|
199
|
+
completedAt: string;
|
|
200
|
+
/**
|
|
201
|
+
* A collection of related links associated with the batch response.
|
|
202
|
+
*/
|
|
203
|
+
links?: Record<string, string>;
|
|
204
|
+
/**
|
|
205
|
+
* The date and time when the batch request was made.
|
|
206
|
+
*/
|
|
207
|
+
requestedAt?: string;
|
|
208
|
+
/**
|
|
209
|
+
* The array of results from the batch process, each containing subscription status information.
|
|
210
|
+
*/
|
|
211
|
+
results: PublicStatusBulkResponse[];
|
|
212
|
+
/**
|
|
213
|
+
* The date and time when the batch process began.
|
|
214
|
+
*/
|
|
215
|
+
startedAt: string;
|
|
216
|
+
/**
|
|
217
|
+
* The current status of the batch process, with possible values: PENDING, PROCESSING, CANCELED, COMPLETE.
|
|
218
|
+
*/
|
|
219
|
+
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
220
|
+
}
|
|
221
|
+
|
|
222
|
+
export interface BatchResponsePublicWideStatusBulkResponse {
|
|
223
|
+
/**
|
|
224
|
+
* The date and time when the batch process was completed.
|
|
225
|
+
*/
|
|
226
|
+
completedAt: string;
|
|
227
|
+
/**
|
|
228
|
+
* A collection of related links associated with the batch response.
|
|
229
|
+
*/
|
|
230
|
+
links?: Record<string, string>;
|
|
231
|
+
/**
|
|
232
|
+
* The date and time when the batch request was made.
|
|
233
|
+
*/
|
|
234
|
+
requestedAt?: string;
|
|
235
|
+
/**
|
|
236
|
+
* The array of results from the batch process, each containing subscription status information.
|
|
237
|
+
*/
|
|
238
|
+
results: PublicWideStatusBulkResponse[];
|
|
239
|
+
/**
|
|
240
|
+
* The date and time when the batch process began.
|
|
241
|
+
*/
|
|
242
|
+
startedAt: string;
|
|
243
|
+
/**
|
|
244
|
+
* The current status of the batch process, with possible values: PENDING, PROCESSING, CANCELED, COMPLETE.
|
|
245
|
+
*/
|
|
246
|
+
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
247
|
+
}
|
|
248
|
+
|
|
249
|
+
export interface ErrorDetail {
|
|
250
|
+
/**
|
|
251
|
+
* The status code associated with the error detail
|
|
252
|
+
*/
|
|
253
|
+
code?: string;
|
|
254
|
+
/**
|
|
255
|
+
* Context about the error condition
|
|
256
|
+
*/
|
|
257
|
+
context?: Record<string, string[]>;
|
|
258
|
+
/**
|
|
259
|
+
* The name of the field or parameter in which the error was found.
|
|
260
|
+
*/
|
|
261
|
+
in?: string;
|
|
262
|
+
/**
|
|
263
|
+
* A human readable message describing the error along with remediation steps where appropriate
|
|
264
|
+
*/
|
|
265
|
+
message: string;
|
|
266
|
+
/**
|
|
267
|
+
* A specific category that contains more specific detail about the error
|
|
268
|
+
*/
|
|
269
|
+
subCategory?: string;
|
|
270
|
+
}
|
|
271
|
+
|
|
272
|
+
export interface LinkGenerationRequest {
|
|
273
|
+
/**
|
|
274
|
+
* The language in which the generated link should be presented, represented as a string.
|
|
275
|
+
*/
|
|
276
|
+
language?: string;
|
|
277
|
+
/**
|
|
278
|
+
* A string representing the unique identifier of the subscriber. This property is required.
|
|
279
|
+
*/
|
|
280
|
+
subscriberIdString: string;
|
|
281
|
+
/**
|
|
282
|
+
* The unique identifier for the subscription, represented as an integer in int64 format.
|
|
283
|
+
*/
|
|
284
|
+
subscriptionId?: number;
|
|
285
|
+
}
|
|
286
|
+
|
|
287
|
+
export interface LinkGenerationResponse {
|
|
288
|
+
/**
|
|
289
|
+
* The URL where the subscriber can manage their communication preferences.
|
|
290
|
+
*/
|
|
291
|
+
managePreferencesUrl: string;
|
|
292
|
+
/**
|
|
293
|
+
* A string representing the unique identifier of the subscriber.
|
|
294
|
+
*/
|
|
295
|
+
subscriberIdString: string;
|
|
296
|
+
/**
|
|
297
|
+
* A string containing the URL for unsubscribing the subscriber from all communications.
|
|
298
|
+
*/
|
|
299
|
+
unsubscribeAllUrl: string;
|
|
300
|
+
/**
|
|
301
|
+
* A string containing the URL to unsubscribe the subscriber from a single communication.
|
|
302
|
+
*/
|
|
303
|
+
unsubscribeSingleUrl?: string;
|
|
304
|
+
}
|
|
305
|
+
|
|
306
|
+
export interface PartialPublicStatusRequest {
|
|
307
|
+
/**
|
|
308
|
+
* The type of communication channel, with 'EMAIL' as the only supported option.
|
|
309
|
+
*/
|
|
310
|
+
channel: 'EMAIL';
|
|
311
|
+
/**
|
|
312
|
+
* The legal basis for communication, with options including 'LEGITIMATE_INTEREST_PQL', 'LEGITIMATE_INTEREST_CLIENT', 'PERFORMANCE_OF_CONTRACT', 'CONSENT_WITH_NOTICE', 'NON_GDPR', 'PROCESS_AND_STORE', and 'LEGITIMATE_INTEREST_OTHER'.
|
|
313
|
+
*/
|
|
314
|
+
legalBasis?:
|
|
315
|
+
| 'CONSENT_WITH_NOTICE'
|
|
316
|
+
| 'LEGITIMATE_INTEREST_CLIENT'
|
|
317
|
+
| 'LEGITIMATE_INTEREST_OTHER'
|
|
318
|
+
| 'LEGITIMATE_INTEREST_PQL'
|
|
319
|
+
| 'NON_GDPR'
|
|
320
|
+
| 'PERFORMANCE_OF_CONTRACT'
|
|
321
|
+
| 'PROCESS_AND_STORE';
|
|
322
|
+
/**
|
|
323
|
+
* An explanation for the legal basis used for communication.
|
|
324
|
+
*/
|
|
325
|
+
legalBasisExplanation?: string;
|
|
326
|
+
/**
|
|
327
|
+
* The current subscription status of the contact, which can be 'SUBSCRIBED', 'UNSUBSCRIBED', or 'NOT_SPECIFIED'.
|
|
328
|
+
*/
|
|
329
|
+
statusState: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED';
|
|
330
|
+
/**
|
|
331
|
+
* The unique identifier of the subscription to be updated.
|
|
332
|
+
*/
|
|
333
|
+
subscriptionId: number;
|
|
334
|
+
}
|
|
335
|
+
|
|
336
|
+
export interface PublicBulkOptOutFromAllResponse {
|
|
337
|
+
/**
|
|
338
|
+
* An array of subscription status objects for the contact.
|
|
339
|
+
*/
|
|
340
|
+
statuses?: PublicStatus[];
|
|
341
|
+
/**
|
|
342
|
+
* The email address of the contact.
|
|
343
|
+
*/
|
|
344
|
+
subscriberIdString: string;
|
|
345
|
+
}
|
|
346
|
+
|
|
347
|
+
export interface PublicStatus {
|
|
348
|
+
/**
|
|
349
|
+
* The ID of the business unit associated with the subscription.
|
|
350
|
+
*/
|
|
351
|
+
businessUnitId?: number;
|
|
352
|
+
/**
|
|
353
|
+
* The type of communication channel, with 'EMAIL' as the only supported option.
|
|
354
|
+
*/
|
|
355
|
+
channel: 'EMAIL';
|
|
356
|
+
/**
|
|
357
|
+
* The legal basis for communication, with options including 'LEGITIMATE_INTEREST_PQL', 'LEGITIMATE_INTEREST_CLIENT', 'PERFORMANCE_OF_CONTRACT', 'CONSENT_WITH_NOTICE', 'NON_GDPR', 'PROCESS_AND_STORE', and 'LEGITIMATE_INTEREST_OTHER'.
|
|
358
|
+
*/
|
|
359
|
+
legalBasis?:
|
|
360
|
+
| 'CONSENT_WITH_NOTICE'
|
|
361
|
+
| 'LEGITIMATE_INTEREST_CLIENT'
|
|
362
|
+
| 'LEGITIMATE_INTEREST_OTHER'
|
|
363
|
+
| 'LEGITIMATE_INTEREST_PQL'
|
|
364
|
+
| 'NON_GDPR'
|
|
365
|
+
| 'PERFORMANCE_OF_CONTRACT'
|
|
366
|
+
| 'PROCESS_AND_STORE';
|
|
367
|
+
/**
|
|
368
|
+
* An explanation for the legal basis used for communication.
|
|
369
|
+
*/
|
|
370
|
+
legalBasisExplanation?: string;
|
|
371
|
+
/**
|
|
372
|
+
* The reason for the successful change in subscription status, such as 'RESUBSCRIBE_OCCURRED' or 'NO_STATUS_CHANGE'.
|
|
373
|
+
*/
|
|
374
|
+
setStatusSuccessReason?:
|
|
375
|
+
| 'NO_STATUS_CHANGE'
|
|
376
|
+
| 'REQUESTED_CHANGE_OCCURRED'
|
|
377
|
+
| 'RESUBSCRIBE_OCCURRED'
|
|
378
|
+
| 'UNSUBSCRIBE_FROM_ALL_OCCURRED';
|
|
379
|
+
/**
|
|
380
|
+
* The origin or method through which the subscription status was set.
|
|
381
|
+
*/
|
|
382
|
+
source: string;
|
|
383
|
+
/**
|
|
384
|
+
* The current subscription status of the contact, which can be 'SUBSCRIBED', 'UNSUBSCRIBED', or 'NOT_SPECIFIED'.
|
|
385
|
+
*/
|
|
386
|
+
status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED';
|
|
387
|
+
/**
|
|
388
|
+
* The contact's email address.
|
|
389
|
+
*/
|
|
390
|
+
subscriberIdString: string;
|
|
391
|
+
/**
|
|
392
|
+
* The unique identifier of the subscription.
|
|
393
|
+
*/
|
|
394
|
+
subscriptionId: number;
|
|
395
|
+
/**
|
|
396
|
+
* The name of the subscription.
|
|
397
|
+
*/
|
|
398
|
+
subscriptionName?: string;
|
|
399
|
+
/**
|
|
400
|
+
* The date and time when the subscription status was last updated.
|
|
401
|
+
*/
|
|
402
|
+
timestamp: string;
|
|
403
|
+
}
|
|
404
|
+
|
|
405
|
+
export interface PublicStatusBulkResponse {
|
|
406
|
+
/**
|
|
407
|
+
* An array of subscription status objects for the contact.
|
|
408
|
+
*/
|
|
409
|
+
statuses: PublicStatus[];
|
|
410
|
+
/**
|
|
411
|
+
* The email address of the contact.
|
|
412
|
+
*/
|
|
413
|
+
subscriberIdString: string;
|
|
414
|
+
}
|
|
415
|
+
|
|
416
|
+
export interface PublicStatusRequest {
|
|
417
|
+
/**
|
|
418
|
+
* The type of communication channel. Currently, only `EMAIL` is supported.
|
|
419
|
+
*/
|
|
420
|
+
channel: 'EMAIL';
|
|
421
|
+
/**
|
|
422
|
+
* The legal basis for communication.
|
|
423
|
+
*/
|
|
424
|
+
legalBasis?:
|
|
425
|
+
| 'CONSENT_WITH_NOTICE'
|
|
426
|
+
| 'LEGITIMATE_INTEREST_CLIENT'
|
|
427
|
+
| 'LEGITIMATE_INTEREST_OTHER'
|
|
428
|
+
| 'LEGITIMATE_INTEREST_PQL'
|
|
429
|
+
| 'NON_GDPR'
|
|
430
|
+
| 'PERFORMANCE_OF_CONTRACT'
|
|
431
|
+
| 'PROCESS_AND_STORE';
|
|
432
|
+
/**
|
|
433
|
+
* The explanation for the legal basis.
|
|
434
|
+
*/
|
|
435
|
+
legalBasisExplanation?: string;
|
|
436
|
+
/**
|
|
437
|
+
* The status of the contact's subscription.
|
|
438
|
+
*/
|
|
439
|
+
statusState: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED';
|
|
440
|
+
/**
|
|
441
|
+
* The contact's email address.
|
|
442
|
+
*/
|
|
443
|
+
subscriberIdString: string;
|
|
444
|
+
/**
|
|
445
|
+
* The ID of the subscription to update.
|
|
446
|
+
*/
|
|
447
|
+
subscriptionId: number;
|
|
448
|
+
}
|
|
449
|
+
|
|
450
|
+
export interface PublicSubscriptionTranslation {
|
|
451
|
+
/**
|
|
452
|
+
* The timestamp indicating when the subscription translation was created.
|
|
453
|
+
*/
|
|
454
|
+
createdAt: number;
|
|
455
|
+
/**
|
|
456
|
+
* A text description of the subscription translation.
|
|
457
|
+
*/
|
|
458
|
+
description: string;
|
|
459
|
+
/**
|
|
460
|
+
* The code representing the language of the subscription translation.
|
|
461
|
+
*/
|
|
462
|
+
languageCode: string;
|
|
463
|
+
/**
|
|
464
|
+
* The name of the subscription translation.
|
|
465
|
+
*/
|
|
466
|
+
name: string;
|
|
467
|
+
/**
|
|
468
|
+
* The unique identifier for the subscription associated with the translation.
|
|
469
|
+
*/
|
|
470
|
+
subscriptionId: number;
|
|
471
|
+
/**
|
|
472
|
+
* The timestamp indicating when the subscription translation was last updated.
|
|
473
|
+
*/
|
|
474
|
+
updatedAt: number;
|
|
475
|
+
}
|
|
476
|
+
|
|
477
|
+
export interface PublicWideStatus {
|
|
478
|
+
/**
|
|
479
|
+
* The ID of the business unit associated with the status.
|
|
480
|
+
*/
|
|
481
|
+
businessUnitId?: number;
|
|
482
|
+
/**
|
|
483
|
+
* The type of communication channel, with 'EMAIL' as the only supported option.
|
|
484
|
+
*/
|
|
485
|
+
channel: 'EMAIL';
|
|
486
|
+
/**
|
|
487
|
+
* The subscription status of the contact, which can be 'SUBSCRIBED', 'UNSUBSCRIBED', or 'NOT_SPECIFIED'.
|
|
488
|
+
*/
|
|
489
|
+
status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED';
|
|
490
|
+
/**
|
|
491
|
+
* The email address of the contact.
|
|
492
|
+
*/
|
|
493
|
+
subscriberIdString: string;
|
|
494
|
+
/**
|
|
495
|
+
* The date and time when the status was recorded.
|
|
496
|
+
*/
|
|
497
|
+
timestamp: string;
|
|
498
|
+
/**
|
|
499
|
+
* The type of wide status, which can be 'PORTAL_WIDE' or 'BUSINESS_UNIT_WIDE'.
|
|
500
|
+
*/
|
|
501
|
+
wideStatusType: 'BUSINESS_UNIT_WIDE' | 'PORTAL_WIDE';
|
|
502
|
+
}
|
|
503
|
+
|
|
504
|
+
export interface PublicWideStatusBulkResponse {
|
|
505
|
+
/**
|
|
506
|
+
* The contact's email address.
|
|
507
|
+
*/
|
|
508
|
+
subscriberIdString: string;
|
|
509
|
+
/**
|
|
510
|
+
* An array containing the wide status results for the operation.
|
|
511
|
+
*/
|
|
512
|
+
wideStatuses: PublicWideStatus[];
|
|
807
513
|
}
|
|
808
514
|
|
|
809
515
|
/**
|
|
810
|
-
*
|
|
811
|
-
* ```ts
|
|
812
|
-
* import { communicationPreferencesSubscriptions } from '@hubspot/api-client-core';
|
|
813
|
-
* client.send(communicationPreferencesSubscriptions.definitions.list(input));
|
|
814
|
-
* ```
|
|
516
|
+
* Ye olde error
|
|
815
517
|
*/
|
|
816
|
-
export interface
|
|
518
|
+
export interface StandardError {
|
|
817
519
|
/**
|
|
818
|
-
*
|
|
819
|
-
* @apiPath /communication-preferences/2026-03/definitions
|
|
820
|
-
* @apiMethod GET
|
|
821
|
-
* @requiredScopes subscriptions-definition-read
|
|
520
|
+
* A string that categorizes the type of error.
|
|
822
521
|
*/
|
|
823
|
-
|
|
522
|
+
category: string;
|
|
824
523
|
/**
|
|
825
|
-
*
|
|
826
|
-
* @apiPath /communication-preferences/2026-03/statuses/{subscriberIdString}/unsubscribe-all
|
|
827
|
-
* @apiMethod POST
|
|
828
|
-
* @requiredScopes subscriptions-status-write
|
|
524
|
+
* An object containing additional context about the error condition, with keys as context names and values as arrays of strings.
|
|
829
525
|
*/
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
526
|
+
context: Record<string, string[]>;
|
|
527
|
+
/**
|
|
528
|
+
* An array of ErrorDetail objects providing further information about the error.
|
|
529
|
+
*/
|
|
530
|
+
errors: ErrorDetail[];
|
|
531
|
+
/**
|
|
532
|
+
* A string representing the unique identifier of the error.
|
|
533
|
+
*/
|
|
534
|
+
id?: string;
|
|
535
|
+
/**
|
|
536
|
+
* An object mapping link names to associated URIs that contain documentation about the error or recommended remediation steps.
|
|
537
|
+
*/
|
|
538
|
+
links: Record<string, string>;
|
|
539
|
+
/**
|
|
540
|
+
* A string containing a human-readable message describing the error.
|
|
541
|
+
*/
|
|
542
|
+
message: string;
|
|
543
|
+
/**
|
|
544
|
+
* A string indicating the status of the error.
|
|
545
|
+
*/
|
|
546
|
+
status: string;
|
|
547
|
+
/**
|
|
548
|
+
* An object providing more specific categorization of the error.
|
|
549
|
+
*/
|
|
550
|
+
subCategory?: Record<string, never>;
|
|
833
551
|
}
|
|
834
552
|
|
|
553
|
+
export interface SubscriptionDefinition {
|
|
554
|
+
/**
|
|
555
|
+
* The ID of the business unit associated with the subscription.
|
|
556
|
+
*/
|
|
557
|
+
businessUnitId?: number;
|
|
558
|
+
/**
|
|
559
|
+
* The method of communication for the subscription.
|
|
560
|
+
*/
|
|
561
|
+
communicationMethod?: string;
|
|
562
|
+
/**
|
|
563
|
+
* The date and time when the subscription was created.
|
|
564
|
+
*/
|
|
565
|
+
createdAt: string;
|
|
566
|
+
/**
|
|
567
|
+
* A description of the subscription.
|
|
568
|
+
*/
|
|
569
|
+
description: string;
|
|
570
|
+
/**
|
|
571
|
+
* The unique identifier for the subscription.
|
|
572
|
+
*/
|
|
573
|
+
id: string;
|
|
574
|
+
/**
|
|
575
|
+
* Indicates whether the subscription is active.
|
|
576
|
+
*/
|
|
577
|
+
isActive: boolean;
|
|
578
|
+
/**
|
|
579
|
+
* Indicates whether the subscription is the default option.
|
|
580
|
+
*/
|
|
581
|
+
isDefault: boolean;
|
|
582
|
+
/**
|
|
583
|
+
* Indicates whether the subscription is internal.
|
|
584
|
+
*/
|
|
585
|
+
isInternal: boolean;
|
|
586
|
+
/**
|
|
587
|
+
* The name of the subscription.
|
|
588
|
+
*/
|
|
589
|
+
name: string;
|
|
590
|
+
/**
|
|
591
|
+
* The purpose of the subscription.
|
|
592
|
+
*/
|
|
593
|
+
purpose?: string;
|
|
594
|
+
/**
|
|
595
|
+
* A list of translations associated with the subscription.
|
|
596
|
+
*/
|
|
597
|
+
subscriptionTranslations?: PublicSubscriptionTranslation[];
|
|
598
|
+
/**
|
|
599
|
+
* The date and time when the subscription was last updated.
|
|
600
|
+
*/
|
|
601
|
+
updatedAt: string;
|
|
602
|
+
}
|
|
603
|
+
}
|
|
604
|
+
|
|
605
|
+
export namespace Communicationpreferences {
|
|
606
|
+
export interface GenerateLinksInput {
|
|
607
|
+
/**
|
|
608
|
+
* The identifier of the business unit. Defaults to 0 if not specified.
|
|
609
|
+
*/
|
|
610
|
+
businessUnitId?: number;
|
|
611
|
+
/**
|
|
612
|
+
* The communication channel for which the links are generated. Must be 'EMAIL'.
|
|
613
|
+
*/
|
|
614
|
+
channel: 'EMAIL';
|
|
615
|
+
data: CommunicationPreferencesSubscriptionsSchemas.LinkGenerationRequest;
|
|
616
|
+
}
|
|
617
|
+
|
|
618
|
+
export type GenerateLinksOutput =
|
|
619
|
+
CommunicationPreferencesSubscriptionsSchemas.LinkGenerationResponse;
|
|
620
|
+
|
|
621
|
+
export interface GetStatusesInput {
|
|
622
|
+
/**
|
|
623
|
+
* The ID of the business unit to filter the subscription status by. This is an optional parameter.
|
|
624
|
+
*/
|
|
625
|
+
businessUnitId?: number;
|
|
626
|
+
/**
|
|
627
|
+
* The communication channel for which the subscription status is being retrieved. This parameter is required and currently supports only 'EMAIL'.
|
|
628
|
+
*/
|
|
629
|
+
channel: 'EMAIL';
|
|
630
|
+
/**
|
|
631
|
+
* The unique identifier of the subscriber whose communication preferences status is being retrieved.
|
|
632
|
+
*/
|
|
633
|
+
subscriberIdString: string;
|
|
634
|
+
}
|
|
635
|
+
|
|
636
|
+
export type GetStatusesOutput =
|
|
637
|
+
CommunicationPreferencesSubscriptionsSchemas.ActionResponseWithResultsPublicStatus;
|
|
638
|
+
|
|
639
|
+
export interface GetUnsubscribeAllStatusInput {
|
|
640
|
+
/**
|
|
641
|
+
* The ID of the business unit to which the subscriber belongs. This is an optional parameter.
|
|
642
|
+
*/
|
|
643
|
+
businessUnitId?: number;
|
|
644
|
+
/**
|
|
645
|
+
* The communication channel from which to unsubscribe the subscriber. This is a required parameter and must be 'EMAIL'.
|
|
646
|
+
*/
|
|
647
|
+
channel: 'EMAIL';
|
|
648
|
+
/**
|
|
649
|
+
* The unique identifier of the subscriber to unsubscribe from all communication preferences.
|
|
650
|
+
*/
|
|
651
|
+
subscriberIdString: string;
|
|
652
|
+
/**
|
|
653
|
+
* A boolean indicating whether to include detailed information in the response. Defaults to false.
|
|
654
|
+
*/
|
|
655
|
+
verbose?: boolean;
|
|
656
|
+
}
|
|
657
|
+
|
|
658
|
+
export type GetUnsubscribeAllStatusOutput =
|
|
659
|
+
CommunicationPreferencesSubscriptionsSchemas.ActionResponseWithResultsPublicWideStatus;
|
|
660
|
+
|
|
661
|
+
export interface UnsubscribeAllInput {
|
|
662
|
+
/**
|
|
663
|
+
* The ID of the business unit associated with the request. This is an optional integer parameter.
|
|
664
|
+
*/
|
|
665
|
+
businessUnitId?: number;
|
|
666
|
+
/**
|
|
667
|
+
* The communication channel to unsubscribe from. Must be 'EMAIL'.
|
|
668
|
+
*/
|
|
669
|
+
channel: 'EMAIL';
|
|
670
|
+
/**
|
|
671
|
+
* The unique identifier of the subscriber to unsubscribe from all communication preferences.
|
|
672
|
+
*/
|
|
673
|
+
subscriberIdString: string;
|
|
674
|
+
/**
|
|
675
|
+
* A boolean indicating whether to include detailed information in the response. Defaults to false.
|
|
676
|
+
*/
|
|
677
|
+
verbose?: boolean;
|
|
678
|
+
}
|
|
679
|
+
|
|
680
|
+
export type UnsubscribeAllOutput =
|
|
681
|
+
CommunicationPreferencesSubscriptionsSchemas.ActionResponseWithResultsPublicStatus;
|
|
682
|
+
|
|
683
|
+
export interface UpdateStatusInput {
|
|
684
|
+
data: CommunicationPreferencesSubscriptionsSchemas.PartialPublicStatusRequest;
|
|
685
|
+
/**
|
|
686
|
+
* The unique identifier of the subscriber whose communication preferences status is being updated.
|
|
687
|
+
*/
|
|
688
|
+
subscriberIdString: string;
|
|
689
|
+
}
|
|
690
|
+
|
|
691
|
+
export type UpdateStatusOutput =
|
|
692
|
+
CommunicationPreferencesSubscriptionsSchemas.ActionResponseWithResultsPublicStatus;
|
|
835
693
|
/**
|
|
836
694
|
* Usage example:
|
|
837
695
|
* ```ts
|
|
838
|
-
* import {
|
|
839
|
-
* client.send(
|
|
696
|
+
* import { communicationpreferences } from '@hubspot/api-client-core';
|
|
697
|
+
* client.send(communicationpreferences.generateLinks(input));
|
|
840
698
|
* ```
|
|
841
699
|
*/
|
|
842
|
-
export interface
|
|
700
|
+
export interface API {
|
|
843
701
|
/**
|
|
844
702
|
* Generate subscription links
|
|
845
703
|
* @apiPath /communication-preferences/2026-03/links/generate
|
|
@@ -847,17 +705,15 @@ export namespace CommunicationPreferencesSubscriptions {
|
|
|
847
705
|
* @requiredScopes subscriptions-status-read, subscriptions-status-write
|
|
848
706
|
*/
|
|
849
707
|
generateLinks: (
|
|
850
|
-
input:
|
|
851
|
-
) => Operation<
|
|
708
|
+
input: GenerateLinksInput
|
|
709
|
+
) => Operation<GenerateLinksOutput>;
|
|
852
710
|
/**
|
|
853
711
|
* Get subscription preferences for a specific contact
|
|
854
712
|
* @apiPath /communication-preferences/2026-03/statuses/{subscriberIdString}
|
|
855
713
|
* @apiMethod GET
|
|
856
714
|
* @requiredScopes subscriptions-status-read
|
|
857
715
|
*/
|
|
858
|
-
getStatuses: (
|
|
859
|
-
input: Status.GetStatusesInput
|
|
860
|
-
) => Operation<Status.GetStatusesOutput>;
|
|
716
|
+
getStatuses: (input: GetStatusesInput) => Operation<GetStatusesOutput>;
|
|
861
717
|
/**
|
|
862
718
|
* Retrieve a contact's unsubscribed status
|
|
863
719
|
* @apiPath /communication-preferences/2026-03/statuses/{subscriberIdString}/unsubscribe-all
|
|
@@ -865,29 +721,155 @@ export namespace CommunicationPreferencesSubscriptions {
|
|
|
865
721
|
* @requiredScopes subscriptions-status-read
|
|
866
722
|
*/
|
|
867
723
|
getUnsubscribeAllStatus: (
|
|
868
|
-
input:
|
|
869
|
-
) => Operation<
|
|
724
|
+
input: GetUnsubscribeAllStatusInput
|
|
725
|
+
) => Operation<GetUnsubscribeAllStatusOutput>;
|
|
726
|
+
/**
|
|
727
|
+
* Unsubscribe a contact from all subscriptions
|
|
728
|
+
* @apiPath /communication-preferences/2026-03/statuses/{subscriberIdString}/unsubscribe-all
|
|
729
|
+
* @apiMethod POST
|
|
730
|
+
* @requiredScopes subscriptions-status-write
|
|
731
|
+
*/
|
|
732
|
+
unsubscribeAll: (
|
|
733
|
+
input: UnsubscribeAllInput
|
|
734
|
+
) => Operation<UnsubscribeAllOutput>;
|
|
870
735
|
/**
|
|
871
736
|
* Update a contact's subscription status
|
|
872
737
|
* @apiPath /communication-preferences/2026-03/statuses/{subscriberIdString}
|
|
873
738
|
* @apiMethod POST
|
|
874
739
|
* @requiredScopes subscriptions-status-write
|
|
875
740
|
*/
|
|
876
|
-
updateStatus: (
|
|
877
|
-
input: Status.UpdateStatusInput
|
|
878
|
-
) => Operation<Status.UpdateStatusOutput>;
|
|
741
|
+
updateStatus: (input: UpdateStatusInput) => Operation<UpdateStatusOutput>;
|
|
879
742
|
}
|
|
743
|
+
}
|
|
880
744
|
|
|
745
|
+
export namespace CommunicationpreferencesDefinitions {
|
|
746
|
+
export interface ListInput {
|
|
747
|
+
/**
|
|
748
|
+
* An integer representing the ID of the business unit for which to retrieve subscription definitions.
|
|
749
|
+
*/
|
|
750
|
+
businessUnitId?: number;
|
|
751
|
+
/**
|
|
752
|
+
* A boolean indicating whether to include translations of the communication preferences definitions in the response.
|
|
753
|
+
*/
|
|
754
|
+
includeTranslations?: boolean;
|
|
755
|
+
}
|
|
756
|
+
|
|
757
|
+
export type ListOutput =
|
|
758
|
+
CommunicationPreferencesSubscriptionsSchemas.ActionResponseWithResultsSubscriptionDefinition;
|
|
881
759
|
/**
|
|
882
760
|
* Usage example:
|
|
883
761
|
* ```ts
|
|
884
|
-
* import {
|
|
885
|
-
* client.send(
|
|
762
|
+
* import { communicationpreferencesDefinitions } from '@hubspot/api-client-core';
|
|
763
|
+
* client.send(communicationpreferencesDefinitions.list(input));
|
|
886
764
|
* ```
|
|
887
765
|
*/
|
|
888
766
|
export interface API {
|
|
889
|
-
|
|
890
|
-
|
|
891
|
-
|
|
767
|
+
/**
|
|
768
|
+
* Retrieve all subscription status definitions
|
|
769
|
+
* @apiPath /communication-preferences/2026-03/definitions
|
|
770
|
+
* @apiMethod GET
|
|
771
|
+
* @requiredScopes subscriptions-definition-read
|
|
772
|
+
*/
|
|
773
|
+
list: (input?: ListInput) => Operation<ListOutput>;
|
|
774
|
+
}
|
|
775
|
+
}
|
|
776
|
+
|
|
777
|
+
export namespace CommunicationpreferencesStatusesBatch {
|
|
778
|
+
export interface GetUnsubscribeAllStatusesInput {
|
|
779
|
+
/**
|
|
780
|
+
* The ID of the business unit to filter the results. This is an optional parameter.
|
|
781
|
+
*/
|
|
782
|
+
businessUnitId?: number;
|
|
783
|
+
/**
|
|
784
|
+
* The communication channel to filter the unsubscribe statuses. This parameter is required and currently supports 'EMAIL' as a valid value.
|
|
785
|
+
*/
|
|
786
|
+
channel: 'EMAIL';
|
|
787
|
+
data: CommunicationPreferencesSubscriptionsSchemas.BatchInputString;
|
|
788
|
+
}
|
|
789
|
+
|
|
790
|
+
export type GetUnsubscribeAllStatusesOutput =
|
|
791
|
+
CommunicationPreferencesSubscriptionsSchemas.BatchResponsePublicWideStatusBulkResponse;
|
|
792
|
+
|
|
793
|
+
export interface ReadInput {
|
|
794
|
+
/**
|
|
795
|
+
* An optional integer representing the business unit ID. This parameter helps to filter the results based on the specific business unit.
|
|
796
|
+
*/
|
|
797
|
+
businessUnitId?: number;
|
|
798
|
+
/**
|
|
799
|
+
* The communication channel to filter the subscription statuses. Must be 'EMAIL'.
|
|
800
|
+
*/
|
|
801
|
+
channel: 'EMAIL';
|
|
802
|
+
data: CommunicationPreferencesSubscriptionsSchemas.BatchInputString;
|
|
803
|
+
}
|
|
804
|
+
|
|
805
|
+
export type ReadOutput =
|
|
806
|
+
CommunicationPreferencesSubscriptionsSchemas.BatchResponsePublicStatusBulkResponse;
|
|
807
|
+
|
|
808
|
+
export interface UnsubscribeAllInput {
|
|
809
|
+
/**
|
|
810
|
+
* An optional integer representing the business unit ID for which the operation is being performed.
|
|
811
|
+
*/
|
|
812
|
+
businessUnitId?: number;
|
|
813
|
+
/**
|
|
814
|
+
* The communication channel from which subscribers will be unsubscribed. This parameter is required and currently supports only 'EMAIL'.
|
|
815
|
+
*/
|
|
816
|
+
channel: 'EMAIL';
|
|
817
|
+
data: CommunicationPreferencesSubscriptionsSchemas.BatchInputString;
|
|
818
|
+
/**
|
|
819
|
+
* A boolean indicating whether to include detailed information in the response. Defaults to false.
|
|
820
|
+
*/
|
|
821
|
+
verbose?: boolean;
|
|
822
|
+
}
|
|
823
|
+
|
|
824
|
+
export type UnsubscribeAllOutput =
|
|
825
|
+
CommunicationPreferencesSubscriptionsSchemas.BatchResponsePublicBulkOptOutFromAllResponse;
|
|
826
|
+
|
|
827
|
+
export type UpdateStatusesInput =
|
|
828
|
+
CommunicationPreferencesSubscriptionsSchemas.BatchInputPublicStatusRequest;
|
|
829
|
+
|
|
830
|
+
export type UpdateStatusesOutput =
|
|
831
|
+
CommunicationPreferencesSubscriptionsSchemas.BatchResponsePublicStatus;
|
|
832
|
+
/**
|
|
833
|
+
* Usage example:
|
|
834
|
+
* ```ts
|
|
835
|
+
* import { communicationpreferencesStatusesBatch } from '@hubspot/api-client-core';
|
|
836
|
+
* client.send(communicationpreferencesStatusesBatch.getUnsubscribeAllStatuses(input));
|
|
837
|
+
* ```
|
|
838
|
+
*/
|
|
839
|
+
export interface API {
|
|
840
|
+
/**
|
|
841
|
+
* Batch retrieve contacts who have opted out of all communications
|
|
842
|
+
* @apiPath /communication-preferences/2026-03/statuses/batch/unsubscribe-all/read
|
|
843
|
+
* @apiMethod POST
|
|
844
|
+
* @requiredScopes subscription-status-batch-read
|
|
845
|
+
*/
|
|
846
|
+
getUnsubscribeAllStatuses: (
|
|
847
|
+
input: GetUnsubscribeAllStatusesInput
|
|
848
|
+
) => Operation<GetUnsubscribeAllStatusesOutput>;
|
|
849
|
+
/**
|
|
850
|
+
* Batch retrieve subscription statuses
|
|
851
|
+
* @apiPath /communication-preferences/2026-03/statuses/batch/read
|
|
852
|
+
* @apiMethod POST
|
|
853
|
+
* @requiredScopes subscription-status-batch-read
|
|
854
|
+
*/
|
|
855
|
+
read: (input: ReadInput) => Operation<ReadOutput>;
|
|
856
|
+
/**
|
|
857
|
+
* Batch unsubscribe contacts from all subscriptions
|
|
858
|
+
* @apiPath /communication-preferences/2026-03/statuses/batch/unsubscribe-all
|
|
859
|
+
* @apiMethod POST
|
|
860
|
+
* @requiredScopes subscription-status-batch-write
|
|
861
|
+
*/
|
|
862
|
+
unsubscribeAll: (
|
|
863
|
+
input: UnsubscribeAllInput
|
|
864
|
+
) => Operation<UnsubscribeAllOutput>;
|
|
865
|
+
/**
|
|
866
|
+
* Batch update subscription status
|
|
867
|
+
* @apiPath /communication-preferences/2026-03/statuses/batch/write
|
|
868
|
+
* @apiMethod POST
|
|
869
|
+
* @requiredScopes subscription-status-batch-write
|
|
870
|
+
*/
|
|
871
|
+
updateStatuses: (
|
|
872
|
+
input: UpdateStatusesInput
|
|
873
|
+
) => Operation<UpdateStatusesOutput>;
|
|
892
874
|
}
|
|
893
875
|
}
|