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