@hubspot/app-connect-sdk 1.0.0-alpha.2 → 1.0.0-alpha.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.turbo/turbo-format$colon$check.log +1 -1
- package/.turbo/turbo-test.log +101 -57
- package/.turbo/turbo-tsdown.log +474 -469
- package/build/tsconfig.browser.tsbuildinfo +1 -1
- package/build/tsconfig.server.tsbuildinfo +1 -1
- package/dist/browser/{HubSpotAppConnect-BW45gyDs.js → HubSpotAppConnect-721kYr9d.js} +17 -23
- package/dist/browser/HubSpotAppConnect-721kYr9d.js.map +1 -0
- package/dist/browser/{create-vctOhpX9.js → create-DxEyGG-k.js} +336 -100
- package/dist/browser/create-DxEyGG-k.js.map +1 -0
- package/dist/browser/index.d.ts +2 -2
- package/dist/browser/index.js +1 -1
- package/dist/browser/react/lovable.d.ts +9 -2
- package/dist/browser/react/lovable.js +7 -4
- package/dist/browser/react/lovable.js.map +1 -1
- package/dist/browser/react.d.ts +2 -3
- package/dist/browser/react.js +1 -1
- package/dist/browser/{types-rTQw6A54.d.ts → types-C3wed8dU.d.ts} +52 -7
- package/dist/server/api-client-core/apis/account/account-info-types.generated.d.ts +73 -85
- package/dist/server/api-client-core/apis/account/account-info.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/account/account-info.generated.js +4 -3
- package/dist/server/api-client-core/apis/account/account-info.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/account/audit-logs-types.generated.d.ts +203 -215
- package/dist/server/api-client-core/apis/account/audit-logs.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/account/audit-logs.generated.js +4 -3
- package/dist/server/api-client-core/apis/account/audit-logs.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/auth/oauth-types.generated.d.ts +78 -90
- package/dist/server/api-client-core/apis/auth/oauth.generated.d.ts +1 -1
- package/dist/server/api-client-core/apis/auth/oauth.generated.js +3 -2
- package/dist/server/api-client-core/apis/auth/oauth.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/automation/actions-types.generated.d.ts +779 -794
- package/dist/server/api-client-core/apis/automation/actions.generated.d.ts +6 -3
- package/dist/server/api-client-core/apis/automation/actions.generated.js +101 -102
- package/dist/server/api-client-core/apis/automation/actions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/automation/sequences-types.generated.d.ts +370 -382
- package/dist/server/api-client-core/apis/automation/sequences.generated.d.ts +1 -1
- package/dist/server/api-client-core/apis/automation/sequences.generated.js +3 -2
- package/dist/server/api-client-core/apis/automation/sequences.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/business-units-types.generated.d.ts +43 -55
- package/dist/server/api-client-core/apis/business-units.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/business-units.generated.js +4 -3
- package/dist/server/api-client-core/apis/business-units.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/authors-types.generated.d.ts +420 -445
- package/dist/server/api-client-core/apis/cms/authors.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/cms/authors.generated.js +155 -158
- package/dist/server/api-client-core/apis/cms/authors.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/blog-settings-types.generated.d.ts +270 -295
- package/dist/server/api-client-core/apis/cms/blog-settings.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/cms/blog-settings.generated.js +35 -38
- package/dist/server/api-client-core/apis/cms/blog-settings.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/cms-content-audit-types.generated.d.ts +107 -131
- package/dist/server/api-client-core/apis/cms/cms-content-audit.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/cms/cms-content-audit.generated.js +6 -5
- package/dist/server/api-client-core/apis/cms/cms-content-audit.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/domains-types.generated.d.ts +155 -167
- package/dist/server/api-client-core/apis/cms/domains.generated.d.ts +2 -2
- package/dist/server/api-client-core/apis/cms/domains.generated.js +3 -2
- package/dist/server/api-client-core/apis/cms/domains.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/hubdb-types.generated.d.ts +876 -889
- package/dist/server/api-client-core/apis/cms/hubdb.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/cms/hubdb.generated.js +184 -185
- package/dist/server/api-client-core/apis/cms/hubdb.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/media-bridge-types.generated.d.ts +1550 -1575
- package/dist/server/api-client-core/apis/cms/media-bridge.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/cms/media-bridge.generated.js +161 -164
- package/dist/server/api-client-core/apis/cms/media-bridge.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/pages-types.generated.d.ts +1583 -1547
- package/dist/server/api-client-core/apis/cms/pages.generated.d.ts +15 -3
- package/dist/server/api-client-core/apis/cms/pages.generated.js +335 -326
- package/dist/server/api-client-core/apis/cms/pages.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/posts-types.generated.d.ts +900 -904
- package/dist/server/api-client-core/apis/cms/posts.generated.d.ts +7 -3
- package/dist/server/api-client-core/apis/cms/posts.generated.js +197 -196
- package/dist/server/api-client-core/apis/cms/posts.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/site-search-types.generated.d.ts +162 -174
- package/dist/server/api-client-core/apis/cms/site-search.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/cms/site-search.generated.js +4 -3
- package/dist/server/api-client-core/apis/cms/site-search.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/source-code-types.generated.d.ts +148 -172
- package/dist/server/api-client-core/apis/cms/source-code.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/cms/source-code.generated.js +40 -43
- package/dist/server/api-client-core/apis/cms/source-code.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/tags-types.generated.d.ts +406 -420
- package/dist/server/api-client-core/apis/cms/tags.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/cms/tags.generated.js +157 -158
- package/dist/server/api-client-core/apis/cms/tags.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/url-mappings-types.generated.d.ts +127 -139
- package/dist/server/api-client-core/apis/cms/url-mappings.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/cms/url-mappings.generated.js +4 -3
- package/dist/server/api-client-core/apis/cms/url-mappings.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/url-redirects-types.generated.d.ts +170 -182
- package/dist/server/api-client-core/apis/cms/url-redirects.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/cms/url-redirects.generated.js +4 -3
- package/dist/server/api-client-core/apis/cms/url-redirects.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/communication-preferences/subscriptions-types.generated.d.ts +728 -742
- package/dist/server/api-client-core/apis/communication-preferences/subscriptions.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/communication-preferences/subscriptions.generated.js +66 -69
- package/dist/server/api-client-core/apis/communication-preferences/subscriptions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/conversations/custom-channels-types.generated.d.ts +445 -471
- package/dist/server/api-client-core/apis/conversations/custom-channels.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/conversations/custom-channels.generated.js +70 -73
- package/dist/server/api-client-core/apis/conversations/custom-channels.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/conversations/visitor-identification-types.generated.d.ts +28 -40
- package/dist/server/api-client-core/apis/conversations/visitor-identification.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/conversations/visitor-identification.generated.js +3 -2
- package/dist/server/api-client-core/apis/conversations/visitor-identification.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/conversations-types.generated.d.ts +768 -781
- package/dist/server/api-client-core/apis/conversations.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/conversations.generated.js +101 -102
- package/dist/server/api-client-core/apis/conversations.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/app-uninstalls-types.generated.d.ts +8 -19
- package/dist/server/api-client-core/apis/crm/app-uninstalls.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/app-uninstalls.generated.js +3 -2
- package/dist/server/api-client-core/apis/crm/app-uninstalls.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/appointments-types.generated.d.ts +887 -891
- package/dist/server/api-client-core/apis/crm/appointments.generated.d.ts +7 -3
- package/dist/server/api-client-core/apis/crm/appointments.generated.js +105 -106
- package/dist/server/api-client-core/apis/crm/appointments.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/associations-schema-types.generated.d.ts +247 -260
- package/dist/server/api-client-core/apis/crm/associations-schema.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/crm/associations-schema.generated.js +48 -49
- package/dist/server/api-client-core/apis/crm/associations-schema.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/associations-types.generated.d.ts +576 -590
- package/dist/server/api-client-core/apis/crm/associations.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/associations.generated.js +71 -72
- package/dist/server/api-client-core/apis/crm/associations.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/calling-extensions-types.generated.d.ts +355 -379
- package/dist/server/api-client-core/apis/crm/calling-extensions.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/calling-extensions.generated.js +34 -37
- package/dist/server/api-client-core/apis/crm/calling-extensions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/calls-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/calls.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/calls.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/calls.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/carts-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/carts.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/carts.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/carts.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/commerce-payments-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/commerce-payments.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/commerce-payments.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/commerce-payments.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/commerce-subscriptions-types.generated.d.ts +752 -766
- package/dist/server/api-client-core/apis/crm/commerce-subscriptions.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/commerce-subscriptions.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/commerce-subscriptions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/communications-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/communications.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/communications.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/communications.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/companies-types.generated.d.ts +769 -795
- package/dist/server/api-client-core/apis/crm/companies.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/companies.generated.js +59 -58
- package/dist/server/api-client-core/apis/crm/companies.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/contacts-types.generated.d.ts +786 -812
- package/dist/server/api-client-core/apis/crm/contacts.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/contacts.generated.js +60 -61
- package/dist/server/api-client-core/apis/crm/contacts.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/contracts-types.generated.d.ts +796 -777
- package/dist/server/api-client-core/apis/crm/contracts.generated.d.ts +8 -3
- package/dist/server/api-client-core/apis/crm/contracts.generated.js +60 -57
- package/dist/server/api-client-core/apis/crm/contracts.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/courses-types.generated.d.ts +758 -772
- package/dist/server/api-client-core/apis/crm/courses.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/courses.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/courses.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/crm-owners-types.generated.d.ts +103 -115
- package/dist/server/api-client-core/apis/crm/crm-owners.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/crm-owners.generated.js +4 -3
- package/dist/server/api-client-core/apis/crm/crm-owners.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/custom-objects-types.generated.d.ts +833 -848
- package/dist/server/api-client-core/apis/crm/custom-objects.generated.d.ts +6 -3
- package/dist/server/api-client-core/apis/crm/custom-objects.generated.js +91 -90
- package/dist/server/api-client-core/apis/crm/custom-objects.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/deal-splits-types.generated.d.ts +158 -170
- package/dist/server/api-client-core/apis/crm/deal-splits.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/deal-splits.generated.js +4 -3
- package/dist/server/api-client-core/apis/crm/deal-splits.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/deals-types.generated.d.ts +771 -785
- package/dist/server/api-client-core/apis/crm/deals.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/deals.generated.js +59 -58
- package/dist/server/api-client-core/apis/crm/deals.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/discounts-types.generated.d.ts +754 -768
- package/dist/server/api-client-core/apis/crm/discounts.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/discounts.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/discounts.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/emails-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/emails.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/emails.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/emails.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/exports-types.generated.d.ts +227 -251
- package/dist/server/api-client-core/apis/crm/exports.generated.d.ts +2 -2
- package/dist/server/api-client-core/apis/crm/exports.generated.js +4 -5
- package/dist/server/api-client-core/apis/crm/exports.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/feedback-submissions-types.generated.d.ts +551 -565
- package/dist/server/api-client-core/apis/crm/feedback-submissions.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/feedback-submissions.generated.js +45 -46
- package/dist/server/api-client-core/apis/crm/feedback-submissions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/fees-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/fees.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/fees.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/fees.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/goal-targets-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/goal-targets.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/goal-targets.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/goal-targets.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/imports-types.generated.d.ts +305 -329
- package/dist/server/api-client-core/apis/crm/imports.generated.d.ts +2 -2
- package/dist/server/api-client-core/apis/crm/imports.generated.js +20 -23
- package/dist/server/api-client-core/apis/crm/imports.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/invoices-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/invoices.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/invoices.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/invoices.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/leads-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/leads.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/leads.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/leads.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/limits-tracking-types.generated.d.ts +251 -263
- package/dist/server/api-client-core/apis/crm/limits-tracking.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/limits-tracking.generated.js +4 -3
- package/dist/server/api-client-core/apis/crm/limits-tracking.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/line-items-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/line-items.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/line-items.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/line-items.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/listings-types.generated.d.ts +758 -772
- package/dist/server/api-client-core/apis/crm/listings.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/listings.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/listings.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/lists-types.generated.d.ts +2075 -2111
- package/dist/server/api-client-core/apis/crm/lists.generated.d.ts +2 -2
- package/dist/server/api-client-core/apis/crm/lists.generated.js +97 -98
- package/dist/server/api-client-core/apis/crm/lists.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/meetings-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/meetings.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/meetings.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/meetings.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/notes-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/notes.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/notes.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/notes.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/object-library-types.generated.d.ts +24 -36
- package/dist/server/api-client-core/apis/crm/object-library.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/object-library.generated.js +4 -3
- package/dist/server/api-client-core/apis/crm/object-library.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/objects-types.generated.d.ts +620 -645
- package/dist/server/api-client-core/apis/crm/objects.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/crm/objects.generated.js +66 -67
- package/dist/server/api-client-core/apis/crm/objects.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/orders-types.generated.d.ts +747 -761
- package/dist/server/api-client-core/apis/crm/orders.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/orders.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/orders.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/partner-clients-types.generated.d.ts +646 -660
- package/dist/server/api-client-core/apis/crm/partner-clients.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/partner-clients.generated.js +63 -62
- package/dist/server/api-client-core/apis/crm/partner-clients.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/partner-services-types.generated.d.ts +646 -660
- package/dist/server/api-client-core/apis/crm/partner-services.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/partner-services.generated.js +63 -62
- package/dist/server/api-client-core/apis/crm/partner-services.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/pipelines-types.generated.d.ts +320 -332
- package/dist/server/api-client-core/apis/crm/pipelines.generated.d.ts +2 -2
- package/dist/server/api-client-core/apis/crm/pipelines.generated.js +3 -2
- package/dist/server/api-client-core/apis/crm/pipelines.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/postal-mail-types.generated.d.ts +744 -758
- package/dist/server/api-client-core/apis/crm/postal-mail.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/postal-mail.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/postal-mail.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/products-types.generated.d.ts +747 -761
- package/dist/server/api-client-core/apis/crm/products.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/products.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/products.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/projects-types.generated.d.ts +761 -787
- package/dist/server/api-client-core/apis/crm/projects.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/projects.generated.js +59 -58
- package/dist/server/api-client-core/apis/crm/projects.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/properties-types.generated.d.ts +526 -528
- package/dist/server/api-client-core/apis/crm/properties.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/properties.generated.js +79 -78
- package/dist/server/api-client-core/apis/crm/properties.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/property-validations-types.generated.d.ts +71 -83
- package/dist/server/api-client-core/apis/crm/property-validations.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/property-validations.generated.js +4 -3
- package/dist/server/api-client-core/apis/crm/property-validations.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/public-app-crm-cards-types.generated.d.ts +409 -433
- package/dist/server/api-client-core/apis/crm/public-app-crm-cards.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/public-app-crm-cards.generated.js +24 -25
- package/dist/server/api-client-core/apis/crm/public-app-crm-cards.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/public-app-feature-flags-types.generated.d.ts +156 -169
- package/dist/server/api-client-core/apis/crm/public-app-feature-flags.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/crm/public-app-feature-flags.generated.js +55 -56
- package/dist/server/api-client-core/apis/crm/public-app-feature-flags.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/quotes-types.generated.d.ts +747 -761
- package/dist/server/api-client-core/apis/crm/quotes.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/quotes.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/quotes.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/schemas-types.generated.d.ts +575 -600
- package/dist/server/api-client-core/apis/crm/schemas.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/crm/schemas.generated.js +33 -34
- package/dist/server/api-client-core/apis/crm/schemas.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/services-types.generated.d.ts +750 -764
- package/dist/server/api-client-core/apis/crm/services.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/services.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/services.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/tasks-types.generated.d.ts +747 -761
- package/dist/server/api-client-core/apis/crm/tasks.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/tasks.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/tasks.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/taxes-types.generated.d.ts +747 -761
- package/dist/server/api-client-core/apis/crm/taxes.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/taxes.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/taxes.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/tickets-types.generated.d.ts +764 -790
- package/dist/server/api-client-core/apis/crm/tickets.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/tickets.generated.js +59 -58
- package/dist/server/api-client-core/apis/crm/tickets.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/timeline-types.generated.d.ts +136 -149
- package/dist/server/api-client-core/apis/crm/timeline.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/crm/timeline.generated.js +5 -6
- package/dist/server/api-client-core/apis/crm/timeline.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/transcriptions-types.generated.d.ts +104 -117
- package/dist/server/api-client-core/apis/crm/transcriptions.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/crm/transcriptions.generated.js +7 -10
- package/dist/server/api-client-core/apis/crm/transcriptions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/users-types.generated.d.ts +747 -761
- package/dist/server/api-client-core/apis/crm/users.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/users.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/users.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/video-conferencing-extension-types.generated.d.ts +28 -40
- package/dist/server/api-client-core/apis/crm/video-conferencing-extension.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/video-conferencing-extension.generated.js +4 -3
- package/dist/server/api-client-core/apis/crm/video-conferencing-extension.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/events/manage-event-definitions-types.generated.d.ts +909 -945
- package/dist/server/api-client-core/apis/events/manage-event-definitions.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/events/manage-event-definitions.generated.js +29 -30
- package/dist/server/api-client-core/apis/events/manage-event-definitions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/events/send-event-completions-types.generated.d.ts +49 -62
- package/dist/server/api-client-core/apis/events/send-event-completions.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/events/send-event-completions.generated.js +4 -5
- package/dist/server/api-client-core/apis/events/send-event-completions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/events-types.generated.d.ts +99 -111
- package/dist/server/api-client-core/apis/events.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/events.generated.js +4 -3
- package/dist/server/api-client-core/apis/events.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/files-types.generated.d.ts +636 -649
- package/dist/server/api-client-core/apis/files.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/files.generated.js +112 -113
- package/dist/server/api-client-core/apis/files.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/marketing/campaigns-public-api-types.generated.d.ts +799 -816
- package/dist/server/api-client-core/apis/marketing/campaigns-public-api.generated.d.ts +8 -3
- package/dist/server/api-client-core/apis/marketing/campaigns-public-api.generated.js +126 -127
- package/dist/server/api-client-core/apis/marketing/campaigns-public-api.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/marketing/marketing-emails-types.generated.d.ts +745 -769
- package/dist/server/api-client-core/apis/marketing/marketing-emails.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/marketing/marketing-emails.generated.js +100 -103
- package/dist/server/api-client-core/apis/marketing/marketing-emails.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/marketing/marketing-events-types.generated.d.ts +1504 -1546
- package/dist/server/api-client-core/apis/marketing/marketing-events.generated.d.ts +9 -3
- package/dist/server/api-client-core/apis/marketing/marketing-events.generated.js +162 -167
- package/dist/server/api-client-core/apis/marketing/marketing-events.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/marketing/single-send-types.generated.d.ts +91 -103
- package/dist/server/api-client-core/apis/marketing/single-send.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/marketing/single-send.generated.js +3 -2
- package/dist/server/api-client-core/apis/marketing/single-send.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/marketing/transactional-single-send-types.generated.d.ts +187 -200
- package/dist/server/api-client-core/apis/marketing/transactional-single-send.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/marketing/transactional-single-send.generated.js +14 -15
- package/dist/server/api-client-core/apis/marketing/transactional-single-send.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/meta/origins-types.generated.d.ts +41 -53
- package/dist/server/api-client-core/apis/meta/origins.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/meta/origins.generated.js +4 -3
- package/dist/server/api-client-core/apis/meta/origins.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/scheduler/meetings-types.generated.d.ts +850 -863
- package/dist/server/api-client-core/apis/scheduler/meetings.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/scheduler/meetings.generated.js +28 -29
- package/dist/server/api-client-core/apis/scheduler/meetings.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/settings/multicurrency-types.generated.d.ts +281 -296
- package/dist/server/api-client-core/apis/settings/multicurrency.generated.d.ts +6 -3
- package/dist/server/api-client-core/apis/settings/multicurrency.generated.js +32 -33
- package/dist/server/api-client-core/apis/settings/multicurrency.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/settings/tax-rates-types.generated.d.ts +71 -83
- package/dist/server/api-client-core/apis/settings/tax-rates.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/settings/tax-rates.generated.js +4 -3
- package/dist/server/api-client-core/apis/settings/tax-rates.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/settings/user-provisioning-types.generated.d.ts +202 -250
- package/dist/server/api-client-core/apis/settings/user-provisioning.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/settings/user-provisioning.generated.js +23 -26
- package/dist/server/api-client-core/apis/settings/user-provisioning.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/webhooks-journal-types.generated.d.ts +490 -526
- package/dist/server/api-client-core/apis/webhooks-journal.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/webhooks-journal.generated.js +65 -70
- package/dist/server/api-client-core/apis/webhooks-journal.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/webhooks-types.generated.d.ts +816 -852
- package/dist/server/api-client-core/apis/webhooks.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/webhooks.generated.js +93 -98
- package/dist/server/api-client-core/apis/webhooks.generated.js.map +1 -1
- package/dist/server/api-client-core/binary-data.js.map +1 -1
- package/dist/server/api-client-core/client.js +5 -1
- package/dist/server/api-client-core/client.js.map +1 -1
- package/dist/server/api-client-core/codegen-helpers/file-op-wrappers.js.map +1 -1
- package/dist/server/api-client-core/errors.js.map +1 -1
- package/dist/server/api-client-core/op.js.map +1 -1
- package/dist/server/api-client-core/pagination.d.ts +2 -2
- package/dist/server/api-client-core/pagination.js +2 -2
- package/dist/server/api-client-core/pagination.js.map +1 -1
- package/dist/server/api-client-core/plugins/fetch-transport.js +33 -9
- package/dist/server/api-client-core/plugins/fetch-transport.js.map +1 -1
- package/dist/server/api-client-core/types.d.ts +1 -1
- package/dist/server/api-client.d.ts +184 -184
- package/dist/server/api-client.js +89 -89
- package/dist/server/constants.js +33 -6
- package/dist/server/constants.js.map +1 -1
- package/dist/server/deno/start.js.map +1 -1
- package/dist/server/hono/hono-request-handler.js +32 -23
- package/dist/server/hono/hono-request-handler.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/auth-complete.js +158 -0
- package/dist/server/hono/hubspot-connect-routes/auth-complete.js.map +1 -0
- package/dist/server/hono/hubspot-connect-routes/auth-init-session.js +25 -12
- package/dist/server/hono/hubspot-connect-routes/auth-init-session.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/auth-logout.js +32 -9
- package/dist/server/hono/hubspot-connect-routes/auth-logout.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/auth-refresh.js +32 -18
- package/dist/server/hono/hubspot-connect-routes/auth-refresh.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/cimd-client-metadata-types.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/cimd-public-routes.js +4 -1
- package/dist/server/hono/hubspot-connect-routes/cimd-public-routes.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/fetch-hubspot-client-metadata.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/hubspot-connect-routes.js +4 -2
- package/dist/server/hono/hubspot-connect-routes/hubspot-connect-routes.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/load-hubspot-connect-routes-env.js +5 -5
- package/dist/server/hono/hubspot-connect-routes/load-hubspot-connect-routes-env.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/oauth-client.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/utils.js +53 -6
- package/dist/server/hono/hubspot-connect-routes/utils.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/whoami.js +51 -0
- package/dist/server/hono/hubspot-connect-routes/whoami.js.map +1 -0
- package/dist/server/hono/types.d.ts +9 -10
- package/dist/server/hono/utils/cookie-utils.js +2 -1
- package/dist/server/hono/utils/cookie-utils.js.map +1 -1
- package/dist/server/hono/utils/cors-middleware.js +85 -0
- package/dist/server/hono/utils/cors-middleware.js.map +1 -0
- package/dist/server/import-app-keys.js.map +1 -1
- package/dist/server/lovable/create-app-function-start.d.ts +1 -1
- package/dist/server/lovable/create-app-function-start.js +4 -6
- package/dist/server/lovable/create-app-function-start.js.map +1 -1
- package/dist/server/lovable/hubspot-connect/index.js.map +1 -1
- package/dist/server/lovable/hubspot-connect/run-hubspot-connect-lovable-server.js +14 -15
- package/dist/server/lovable/hubspot-connect/run-hubspot-connect-lovable-server.js.map +1 -1
- package/dist/server/sanitize-request.js +14 -11
- package/dist/server/sanitize-request.js.map +1 -1
- package/dist/server/secure-start-core.js +4 -5
- package/dist/server/secure-start-core.js.map +1 -1
- package/dist/server/shared/constants.js +22 -9
- package/dist/server/shared/constants.js.map +1 -1
- package/dist/server/shared/encoding/base64.js.map +1 -1
- package/dist/server/shared/encoding/sha256.js.map +1 -1
- package/dist/server/shared/logger.js.map +1 -1
- package/dist/server/types.d.ts +1 -35
- package/dist/server/utils/cookie-utils.js.map +1 -1
- package/dist/server/utils/dpop-utils.js.map +1 -1
- package/dist/server/utils/env-utils.js +60 -7
- package/dist/server/utils/env-utils.js.map +1 -1
- package/dist/server/utils/hubspot-dpop-auth-headers.js +38 -0
- package/dist/server/utils/hubspot-dpop-auth-headers.js.map +1 -0
- package/dist/server/utils/jwk-utils.js.map +1 -1
- package/dist/server/utils/jwt-utils.js.map +1 -1
- package/package.json +15 -21
- package/src/browser/app-connect-controller/README.md +5 -2
- package/src/browser/app-connect-controller/connect-start.test.ts +157 -0
- package/src/browser/app-connect-controller/connect-start.ts +18 -3
- package/src/browser/app-connect-controller/constants.ts +6 -4
- package/src/browser/app-connect-controller/create.ts +8 -2
- package/src/browser/app-connect-controller/disconnect.ts +5 -7
- package/src/browser/app-connect-controller/init.test.ts +275 -0
- package/src/browser/app-connect-controller/init.ts +44 -19
- package/src/browser/app-connect-controller/oauth-complete.test.ts +110 -0
- package/src/browser/app-connect-controller/oauth-complete.ts +53 -0
- package/src/browser/app-connect-controller/oauth-popup.test.ts +239 -0
- package/src/browser/app-connect-controller/oauth-popup.ts +160 -0
- package/src/browser/app-connect-controller/types.ts +3 -0
- package/src/browser/app-connect-controller/utils/iframe-utils.ts +12 -0
- package/src/browser/app-connect-controller/utils/resolve-oauth-connect-mode.test.ts +35 -0
- package/src/browser/app-connect-controller/utils/resolve-oauth-connect-mode.ts +21 -0
- package/src/browser/app-connect-controller/utils/session-utils.test.ts +73 -22
- package/src/browser/app-connect-controller/utils/session-utils.ts +74 -33
- package/src/browser/app-connect-controller/view-state.test.ts +1 -0
- package/src/browser/app-connect-controller/view-state.ts +1 -0
- package/src/browser/index.ts +1 -0
- package/src/browser/react/components/AppConnectHeader/AppConnectHeader.tsx +21 -34
- package/src/browser/react/components/ConnectButton/ConnectButton.tsx +1 -1
- package/src/browser/react/lovable/LovableHubSpotAppConnect.tsx +12 -2
- package/src/browser/types.ts +30 -5
- package/src/server/api-client-core/__tests__/errors.test.ts +309 -0
- package/src/server/api-client-core/__tests__/operation-headers.test.ts +251 -0
- package/src/server/api-client-core/apis/account/account-info-types.generated.ts +74 -88
- package/src/server/api-client-core/apis/account/account-info.generated.ts +2 -4
- package/src/server/api-client-core/apis/account/audit-logs-types.generated.ts +346 -360
- package/src/server/api-client-core/apis/account/audit-logs.generated.ts +2 -4
- package/src/server/api-client-core/apis/auth/oauth-types.generated.ts +81 -99
- package/src/server/api-client-core/apis/auth/oauth.generated.ts +1 -3
- package/src/server/api-client-core/apis/automation/actions-types.generated.ts +1162 -1188
- package/src/server/api-client-core/apis/automation/actions.generated.ts +10 -12
- package/src/server/api-client-core/apis/automation/sequences-types.generated.ts +379 -393
- package/src/server/api-client-core/apis/automation/sequences.generated.ts +1 -3
- package/src/server/api-client-core/apis/business-units-types.generated.ts +43 -59
- package/src/server/api-client-core/apis/business-units.generated.ts +9 -10
- package/src/server/api-client-core/apis/cms/authors-types.generated.ts +3823 -3853
- package/src/server/api-client-core/apis/cms/authors.generated.ts +31 -37
- package/src/server/api-client-core/apis/cms/blog-settings-types.generated.ts +3667 -3696
- package/src/server/api-client-core/apis/cms/blog-settings.generated.ts +46 -51
- package/src/server/api-client-core/apis/cms/cms-content-audit-types.generated.ts +138 -163
- package/src/server/api-client-core/apis/cms/cms-content-audit.generated.ts +2 -10
- package/src/server/api-client-core/apis/cms/domains-types.generated.ts +153 -167
- package/src/server/api-client-core/apis/cms/domains.generated.ts +2 -4
- package/src/server/api-client-core/apis/cms/hubdb-types.generated.ts +1013 -1063
- package/src/server/api-client-core/apis/cms/hubdb.generated.ts +3 -5
- package/src/server/api-client-core/apis/cms/media-bridge-types.generated.ts +8623 -8657
- package/src/server/api-client-core/apis/cms/media-bridge.generated.ts +16 -22
- package/src/server/api-client-core/apis/cms/pages-types.generated.ts +5259 -5272
- package/src/server/api-client-core/apis/cms/pages.generated.ts +262 -226
- package/src/server/api-client-core/apis/cms/posts-types.generated.ts +4420 -4438
- package/src/server/api-client-core/apis/cms/posts.generated.ts +108 -106
- package/src/server/api-client-core/apis/cms/site-search-types.generated.ts +1867 -1881
- package/src/server/api-client-core/apis/cms/site-search.generated.ts +2 -4
- package/src/server/api-client-core/apis/cms/source-code-types.generated.ts +144 -177
- package/src/server/api-client-core/apis/cms/source-code.generated.ts +15 -23
- package/src/server/api-client-core/apis/cms/tags-types.generated.ts +3820 -3845
- package/src/server/api-client-core/apis/cms/tags.generated.ts +80 -82
- package/src/server/api-client-core/apis/cms/url-mappings-types.generated.ts +188 -202
- package/src/server/api-client-core/apis/cms/url-mappings.generated.ts +2 -4
- package/src/server/api-client-core/apis/cms/url-redirects-types.generated.ts +182 -196
- package/src/server/api-client-core/apis/cms/url-redirects.generated.ts +2 -4
- package/src/server/api-client-core/apis/communication-preferences/subscriptions-types.generated.ts +810 -828
- package/src/server/api-client-core/apis/communication-preferences/subscriptions.generated.ts +66 -63
- package/src/server/api-client-core/apis/conversations/custom-channels-types.generated.ts +564 -601
- package/src/server/api-client-core/apis/conversations/custom-channels.generated.ts +90 -86
- package/src/server/api-client-core/apis/conversations/visitor-identification-types.generated.ts +31 -44
- package/src/server/api-client-core/apis/conversations/visitor-identification.generated.ts +6 -8
- package/src/server/api-client-core/apis/conversations-types.generated.ts +955 -991
- package/src/server/api-client-core/apis/conversations.generated.ts +6 -5
- package/src/server/api-client-core/apis/crm/app-uninstalls-types.generated.ts +7 -19
- package/src/server/api-client-core/apis/crm/app-uninstalls.generated.ts +2 -4
- package/src/server/api-client-core/apis/crm/appointments-types.generated.ts +965 -969
- package/src/server/api-client-core/apis/crm/appointments.generated.ts +143 -137
- package/src/server/api-client-core/apis/crm/associations-schema-types.generated.ts +292 -322
- package/src/server/api-client-core/apis/crm/associations-schema.generated.ts +17 -19
- package/src/server/api-client-core/apis/crm/associations-types.generated.ts +657 -675
- package/src/server/api-client-core/apis/crm/associations.generated.ts +70 -70
- package/src/server/api-client-core/apis/crm/calling-extensions-types.generated.ts +417 -441
- package/src/server/api-client-core/apis/crm/calling-extensions.generated.ts +62 -69
- package/src/server/api-client-core/apis/crm/calls-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/calls.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/carts-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/carts.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/commerce-payments-types.generated.ts +847 -856
- package/src/server/api-client-core/apis/crm/commerce-payments.generated.ts +73 -73
- package/src/server/api-client-core/apis/crm/commerce-subscriptions-types.generated.ts +844 -853
- package/src/server/api-client-core/apis/crm/commerce-subscriptions.generated.ts +50 -51
- package/src/server/api-client-core/apis/crm/communications-types.generated.ts +846 -856
- package/src/server/api-client-core/apis/crm/communications.generated.ts +73 -73
- package/src/server/api-client-core/apis/crm/companies-types.generated.ts +859 -885
- package/src/server/api-client-core/apis/crm/companies.generated.ts +44 -50
- package/src/server/api-client-core/apis/crm/contacts-types.generated.ts +875 -907
- package/src/server/api-client-core/apis/crm/contacts.generated.ts +46 -52
- package/src/server/api-client-core/apis/crm/contracts-types.generated.ts +894 -862
- package/src/server/api-client-core/apis/crm/contracts.generated.ts +66 -56
- package/src/server/api-client-core/apis/crm/courses-types.generated.ts +842 -859
- package/src/server/api-client-core/apis/crm/courses.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/crm-owners-types.generated.ts +102 -115
- package/src/server/api-client-core/apis/crm/crm-owners.generated.ts +2 -4
- package/src/server/api-client-core/apis/crm/custom-objects-types.generated.ts +900 -915
- package/src/server/api-client-core/apis/crm/custom-objects.generated.ts +128 -126
- package/src/server/api-client-core/apis/crm/deal-splits-types.generated.ts +157 -170
- package/src/server/api-client-core/apis/crm/deal-splits.generated.ts +2 -4
- package/src/server/api-client-core/apis/crm/deals-types.generated.ts +858 -875
- package/src/server/api-client-core/apis/crm/deals.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/discounts-types.generated.ts +842 -855
- package/src/server/api-client-core/apis/crm/discounts.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/emails-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/emails.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/exports-types.generated.ts +284 -314
- package/src/server/api-client-core/apis/crm/exports.generated.ts +6 -11
- package/src/server/api-client-core/apis/crm/feedback-submissions-types.generated.ts +607 -622
- package/src/server/api-client-core/apis/crm/feedback-submissions.generated.ts +84 -80
- package/src/server/api-client-core/apis/crm/fees-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/fees.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/goal-targets-types.generated.ts +845 -856
- package/src/server/api-client-core/apis/crm/goal-targets.generated.ts +50 -51
- package/src/server/api-client-core/apis/crm/imports-types.generated.ts +663 -692
- package/src/server/api-client-core/apis/crm/imports.generated.ts +2 -7
- package/src/server/api-client-core/apis/crm/invoices-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/invoices.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/leads-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/leads.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/limits-tracking-types.generated.ts +263 -275
- package/src/server/api-client-core/apis/crm/limits-tracking.generated.ts +2 -4
- package/src/server/api-client-core/apis/crm/line-items-types.generated.ts +843 -856
- package/src/server/api-client-core/apis/crm/line-items.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/listings-types.generated.ts +842 -859
- package/src/server/api-client-core/apis/crm/listings.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/lists-types.generated.ts +2794 -2845
- package/src/server/api-client-core/apis/crm/lists.generated.ts +8 -20
- package/src/server/api-client-core/apis/crm/meetings-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/meetings.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/notes-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/notes.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/object-library-types.generated.ts +26 -39
- package/src/server/api-client-core/apis/crm/object-library.generated.ts +2 -4
- package/src/server/api-client-core/apis/crm/objects-types.generated.ts +688 -716
- package/src/server/api-client-core/apis/crm/objects.generated.ts +79 -83
- package/src/server/api-client-core/apis/crm/orders-types.generated.ts +829 -846
- package/src/server/api-client-core/apis/crm/orders.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/partner-clients-types.generated.ts +721 -735
- package/src/server/api-client-core/apis/crm/partner-clients.generated.ts +60 -60
- package/src/server/api-client-core/apis/crm/partner-services-types.generated.ts +720 -734
- package/src/server/api-client-core/apis/crm/partner-services.generated.ts +60 -60
- package/src/server/api-client-core/apis/crm/pipelines-types.generated.ts +366 -388
- package/src/server/api-client-core/apis/crm/pipelines.generated.ts +2 -4
- package/src/server/api-client-core/apis/crm/postal-mail-types.generated.ts +830 -843
- package/src/server/api-client-core/apis/crm/postal-mail.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/products-types.generated.ts +829 -846
- package/src/server/api-client-core/apis/crm/products.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/projects-types.generated.ts +845 -875
- package/src/server/api-client-core/apis/crm/projects.generated.ts +47 -53
- package/src/server/api-client-core/apis/crm/properties-types.generated.ts +623 -626
- package/src/server/api-client-core/apis/crm/properties.generated.ts +33 -28
- package/src/server/api-client-core/apis/crm/property-validations-types.generated.ts +160 -174
- package/src/server/api-client-core/apis/crm/property-validations.generated.ts +2 -6
- package/src/server/api-client-core/apis/crm/public-app-crm-cards-types.generated.ts +467 -494
- package/src/server/api-client-core/apis/crm/public-app-crm-cards.generated.ts +7 -15
- package/src/server/api-client-core/apis/crm/public-app-feature-flags-types.generated.ts +166 -177
- package/src/server/api-client-core/apis/crm/public-app-feature-flags.generated.ts +6 -8
- package/src/server/api-client-core/apis/crm/quotes-types.generated.ts +829 -846
- package/src/server/api-client-core/apis/crm/quotes.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/schemas-types.generated.ts +613 -640
- package/src/server/api-client-core/apis/crm/schemas.generated.ts +8 -14
- package/src/server/api-client-core/apis/crm/services-types.generated.ts +832 -849
- package/src/server/api-client-core/apis/crm/services.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/tasks-types.generated.ts +829 -846
- package/src/server/api-client-core/apis/crm/tasks.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/taxes-types.generated.ts +829 -846
- package/src/server/api-client-core/apis/crm/taxes.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/tickets-types.generated.ts +848 -878
- package/src/server/api-client-core/apis/crm/tickets.generated.ts +47 -53
- package/src/server/api-client-core/apis/crm/timeline-types.generated.ts +144 -161
- package/src/server/api-client-core/apis/crm/timeline.generated.ts +6 -8
- package/src/server/api-client-core/apis/crm/transcriptions-types.generated.ts +149 -164
- package/src/server/api-client-core/apis/crm/transcriptions.generated.ts +22 -22
- package/src/server/api-client-core/apis/crm/users-types.generated.ts +829 -846
- package/src/server/api-client-core/apis/crm/users.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/video-conferencing-extension-types.generated.ts +29 -42
- package/src/server/api-client-core/apis/crm/video-conferencing-extension.generated.ts +17 -19
- package/src/server/api-client-core/apis/events/manage-event-definitions-types.generated.ts +1509 -1558
- package/src/server/api-client-core/apis/events/manage-event-definitions.generated.ts +55 -65
- package/src/server/api-client-core/apis/events/send-event-completions-types.generated.ts +51 -68
- package/src/server/api-client-core/apis/events/send-event-completions.generated.ts +10 -10
- package/src/server/api-client-core/apis/events-types.generated.ts +97 -110
- package/src/server/api-client-core/apis/events.generated.ts +2 -4
- package/src/server/api-client-core/apis/files-types.generated.ts +727 -757
- package/src/server/api-client-core/apis/files.generated.ts +3 -5
- package/src/server/api-client-core/apis/marketing/campaigns-public-api-types.generated.ts +1221 -1234
- package/src/server/api-client-core/apis/marketing/campaigns-public-api.generated.ts +45 -47
- package/src/server/api-client-core/apis/marketing/marketing-emails-types.generated.ts +3704 -3733
- package/src/server/api-client-core/apis/marketing/marketing-emails.generated.ts +44 -52
- package/src/server/api-client-core/apis/marketing/marketing-events-types.generated.ts +1787 -1848
- package/src/server/api-client-core/apis/marketing/marketing-events.generated.ts +236 -241
- package/src/server/api-client-core/apis/marketing/single-send-types.generated.ts +142 -155
- package/src/server/api-client-core/apis/marketing/single-send.generated.ts +2 -6
- package/src/server/api-client-core/apis/marketing/transactional-single-send-types.generated.ts +253 -269
- package/src/server/api-client-core/apis/marketing/transactional-single-send.generated.ts +32 -31
- package/src/server/api-client-core/apis/meta/origins-types.generated.ts +40 -56
- package/src/server/api-client-core/apis/meta/origins.generated.ts +2 -4
- package/src/server/api-client-core/apis/scheduler/meetings-types.generated.ts +1001 -1014
- package/src/server/api-client-core/apis/scheduler/meetings.generated.ts +6 -8
- package/src/server/api-client-core/apis/settings/multicurrency-types.generated.ts +1906 -1912
- package/src/server/api-client-core/apis/settings/multicurrency.generated.ts +64 -63
- package/src/server/api-client-core/apis/settings/tax-rates-types.generated.ts +71 -85
- package/src/server/api-client-core/apis/settings/tax-rates.generated.ts +2 -4
- package/src/server/api-client-core/apis/settings/user-provisioning-types.generated.ts +207 -257
- package/src/server/api-client-core/apis/settings/user-provisioning.generated.ts +8 -24
- package/src/server/api-client-core/apis/webhooks-journal-types.generated.ts +740 -771
- package/src/server/api-client-core/apis/webhooks-journal.generated.ts +47 -59
- package/src/server/api-client-core/apis/webhooks-types.generated.ts +1194 -1228
- package/src/server/api-client-core/apis/webhooks.generated.ts +52 -64
- package/src/server/api-client-core/client.ts +5 -1
- package/src/server/api-client-core/pagination.ts +2 -2
- package/src/server/api-client-core/plugins/fetch-transport.ts +70 -12
- package/src/server/api-client-core/types.ts +1 -1
- package/src/server/constants.ts +29 -4
- package/src/server/hono/hono-request-handler.ts +68 -27
- package/src/server/hono/hubspot-connect-routes/auth-complete.test.ts +394 -0
- package/src/server/hono/hubspot-connect-routes/{auth-callback.ts → auth-complete.ts} +81 -30
- package/src/server/hono/hubspot-connect-routes/auth-init-session.test.ts +114 -30
- package/src/server/hono/hubspot-connect-routes/auth-init-session.ts +35 -10
- package/src/server/hono/hubspot-connect-routes/auth-logout.test.ts +13 -0
- package/src/server/hono/hubspot-connect-routes/auth-logout.ts +39 -10
- package/src/server/hono/hubspot-connect-routes/auth-refresh.test.ts +6 -0
- package/src/server/hono/hubspot-connect-routes/auth-refresh.ts +24 -9
- package/src/server/hono/hubspot-connect-routes/cimd-public-routes.test.ts +7 -6
- package/src/server/hono/hubspot-connect-routes/cimd-public-routes.ts +5 -1
- package/src/server/hono/hubspot-connect-routes/hubspot-connect-routes.ts +11 -3
- package/src/server/hono/hubspot-connect-routes/load-hubspot-connect-routes-env.test.ts +17 -24
- package/src/server/hono/hubspot-connect-routes/load-hubspot-connect-routes-env.ts +8 -8
- package/src/server/hono/hubspot-connect-routes/utils.test.ts +16 -46
- package/src/server/hono/hubspot-connect-routes/utils.ts +61 -5
- package/src/server/hono/hubspot-connect-routes/whoami.ts +74 -0
- package/src/server/hono/types.ts +11 -10
- package/src/server/hono/utils/cookie-utils.ts +27 -2
- package/src/server/hono/utils/cors-middleware.test.ts +80 -0
- package/src/server/hono/utils/cors-middleware.ts +95 -0
- package/src/server/lovable/create-app-function-start.ts +4 -7
- package/src/server/lovable/hubspot-connect/run-hubspot-connect-lovable-server.ts +21 -16
- package/src/server/sanitize-request.ts +15 -12
- package/src/server/secure-start-core.ts +7 -6
- package/src/server/types.ts +2 -38
- package/src/server/utils/env-utils.test.ts +140 -12
- package/src/server/utils/env-utils.ts +80 -6
- package/src/server/utils/hubspot-dpop-auth-headers.test.ts +43 -0
- package/src/server/utils/hubspot-dpop-auth-headers.ts +48 -0
- package/src/shared/constants.ts +40 -3
- package/src/shared/wire-types.ts +49 -0
- package/dist/browser/HubSpotAppConnect-BW45gyDs.js.map +0 -1
- package/dist/browser/create-vctOhpX9.js.map +0 -1
- package/dist/server/hono/hubspot-connect-routes/auth-callback.js +0 -125
- package/dist/server/hono/hubspot-connect-routes/auth-callback.js.map +0 -1
- package/dist/server/proxy.js +0 -68
- package/dist/server/proxy.js.map +0 -1
- package/src/server/hono/hubspot-connect-routes/auth-callback.test.ts +0 -225
- package/src/server/proxy.test.ts +0 -80
- package/src/server/proxy.ts +0 -116
|
@@ -2,1077 +2,1087 @@
|
|
|
2
2
|
|
|
3
3
|
import type { Operation } from '../types.ts';
|
|
4
4
|
|
|
5
|
-
export namespace
|
|
6
|
-
export
|
|
7
|
-
|
|
5
|
+
export namespace WebhooksSchemas {
|
|
6
|
+
export interface ActionOverrideRequest {
|
|
7
|
+
/**
|
|
8
|
+
* An array of strings, each representing an associated object type ID relevant to the action override.
|
|
9
|
+
*/
|
|
10
|
+
associatedObjectTypeIds?: string[];
|
|
11
|
+
/**
|
|
12
|
+
* An array of integers representing list IDs that are associated with the action override. The integers are in int64 format.
|
|
13
|
+
*/
|
|
14
|
+
listIds?: number[];
|
|
15
|
+
/**
|
|
16
|
+
* An array of integers, each representing an object ID for which the action override is applicable. The integers are in int64 format.
|
|
17
|
+
*/
|
|
18
|
+
objectIds?: number[];
|
|
19
|
+
/**
|
|
20
|
+
* An array of strings representing the properties to be overridden in the action. Each string corresponds to a property name.
|
|
21
|
+
*/
|
|
22
|
+
properties?: string[];
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
export interface AppLifecycleEventSubscriptionUpsertRequest {
|
|
26
|
+
eventTypeId: string;
|
|
27
|
+
properties: string[];
|
|
28
|
+
subscriptionType:
|
|
29
|
+
| 'APP_LIFECYCLE_EVENT'
|
|
30
|
+
| 'ASSOCIATION'
|
|
31
|
+
| 'EVENT'
|
|
32
|
+
| 'GDPR_PRIVACY_DELETION'
|
|
33
|
+
| 'LIST_MEMBERSHIP'
|
|
34
|
+
| 'OBJECT';
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
export interface AssociationSubscriptionUpsertRequest {
|
|
38
|
+
actions: (
|
|
39
|
+
| 'ADDED_TO_LIST'
|
|
40
|
+
| 'APP_INSTALL'
|
|
41
|
+
| 'APP_UNINSTALL'
|
|
42
|
+
| 'ASSOCIATION_ADDED'
|
|
43
|
+
| 'ASSOCIATION_REMOVED'
|
|
44
|
+
| 'CREATE'
|
|
45
|
+
| 'DELETE'
|
|
46
|
+
| 'GDPR_DELETE'
|
|
47
|
+
| 'MERGE'
|
|
48
|
+
| 'REMOVED_FROM_LIST'
|
|
49
|
+
| 'RESTORE'
|
|
50
|
+
| 'SNAPSHOT'
|
|
51
|
+
| 'UPDATE'
|
|
52
|
+
)[];
|
|
53
|
+
associatedObjectTypeIds: string[];
|
|
54
|
+
objectIds: number[];
|
|
55
|
+
objectTypeId: string;
|
|
56
|
+
portalId: number;
|
|
57
|
+
subscriptionType:
|
|
58
|
+
| 'APP_LIFECYCLE_EVENT'
|
|
59
|
+
| 'ASSOCIATION'
|
|
60
|
+
| 'EVENT'
|
|
61
|
+
| 'GDPR_PRIVACY_DELETION'
|
|
62
|
+
| 'LIST_MEMBERSHIP'
|
|
63
|
+
| 'OBJECT';
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
export interface BatchInputString {
|
|
67
|
+
/**
|
|
68
|
+
* An array of strings to be processed. This property is required.
|
|
69
|
+
*/
|
|
70
|
+
inputs: string[];
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
export interface BatchInputSubscriptionBatchUpdateRequest {
|
|
74
|
+
/**
|
|
75
|
+
* An array of SubscriptionBatchUpdateRequest objects, each representing a subscription to be updated. This property is required.
|
|
76
|
+
*/
|
|
77
|
+
inputs: SubscriptionBatchUpdateRequest[];
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
export interface BatchResponseJournalFetchResponse {
|
|
81
|
+
/**
|
|
82
|
+
* The date and time when the batch operation was completed, in ISO 8601 format.
|
|
83
|
+
*/
|
|
84
|
+
completedAt: string;
|
|
85
|
+
/**
|
|
86
|
+
* A map of link names to associated URIs related to the batch operation.
|
|
87
|
+
*/
|
|
88
|
+
links?: Record<string, string>;
|
|
89
|
+
/**
|
|
90
|
+
* The date and time when the batch operation was requested, in ISO 8601 format.
|
|
91
|
+
*/
|
|
92
|
+
requestedAt?: string;
|
|
93
|
+
/**
|
|
94
|
+
* An array of results from the batch operation, each represented as a JournalFetchResponse object.
|
|
95
|
+
*/
|
|
96
|
+
results: JournalFetchResponse[];
|
|
97
|
+
/**
|
|
98
|
+
* The date and time when the batch operation started, in ISO 8601 format.
|
|
99
|
+
*/
|
|
100
|
+
startedAt: string;
|
|
101
|
+
/**
|
|
102
|
+
* The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'.
|
|
103
|
+
*/
|
|
104
|
+
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
export interface BatchResponseSubscriptionResponse {
|
|
108
|
+
/**
|
|
109
|
+
* The date and time when the batch operation was completed, in ISO 8601 format.
|
|
110
|
+
*/
|
|
111
|
+
completedAt: string;
|
|
112
|
+
/**
|
|
113
|
+
* A map of link names to associated URIs providing additional information about the batch operation.
|
|
114
|
+
*/
|
|
115
|
+
links?: Record<string, string>;
|
|
116
|
+
/**
|
|
117
|
+
* The date and time when the batch operation was requested, in ISO 8601 format.
|
|
118
|
+
*/
|
|
119
|
+
requestedAt?: string;
|
|
120
|
+
/**
|
|
121
|
+
* An array containing the results of the batch operation, with each item representing an individual subscription response.
|
|
122
|
+
*/
|
|
123
|
+
results: SubscriptionResponse[];
|
|
124
|
+
/**
|
|
125
|
+
* The date and time when the batch operation started, in ISO 8601 format.
|
|
126
|
+
*/
|
|
127
|
+
startedAt: string;
|
|
128
|
+
/**
|
|
129
|
+
* The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'.
|
|
130
|
+
*/
|
|
131
|
+
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
export interface CollectionResponseSubscriptionResponseNoPaging {
|
|
135
|
+
/**
|
|
136
|
+
* An array of SubscriptionResponse objects, each representing a subscription's details such as actions, appId, createdAt, and other relevant properties.
|
|
137
|
+
*/
|
|
138
|
+
results: SubscriptionResponse_1[];
|
|
139
|
+
}
|
|
140
|
+
|
|
141
|
+
export interface Condition {
|
|
142
|
+
/**
|
|
143
|
+
* A string indicating the type of filter being applied. Valid value is 'CRM_OBJECT_PROPERTY'.
|
|
144
|
+
*/
|
|
145
|
+
filterType: 'CRM_OBJECT_PROPERTY';
|
|
146
|
+
/**
|
|
147
|
+
* A string specifying the operation to be performed in the condition. Valid values include 'EQ', 'N_EQ', 'LT', 'GT', 'LTE', 'GTE', 'CONTAINS', 'STARTS_WITH', 'ENDS_WITH', 'IN', 'NOT_IN', 'IS_EMPTY', and 'IS_NOT_EMPTY'.
|
|
148
|
+
*/
|
|
149
|
+
operator:
|
|
150
|
+
| 'CONTAINS'
|
|
151
|
+
| 'ENDS_WITH'
|
|
152
|
+
| 'EQ'
|
|
153
|
+
| 'GT'
|
|
154
|
+
| 'GTE'
|
|
155
|
+
| 'IN'
|
|
156
|
+
| 'IS_EMPTY'
|
|
157
|
+
| 'IS_NOT_EMPTY'
|
|
158
|
+
| 'LT'
|
|
159
|
+
| 'LTE'
|
|
160
|
+
| 'N_EQ'
|
|
161
|
+
| 'NOT_IN'
|
|
162
|
+
| 'STARTS_WITH';
|
|
163
|
+
/**
|
|
164
|
+
* A string representing the specific property of the CRM object that the condition applies to.
|
|
165
|
+
*/
|
|
166
|
+
property: string;
|
|
167
|
+
/**
|
|
168
|
+
* A string representing the value to be compared against the specified property when using single-value operators.
|
|
169
|
+
*/
|
|
170
|
+
value?: string;
|
|
171
|
+
/**
|
|
172
|
+
* An array of strings used to specify multiple values for comparison when using operators that support multiple values, such as 'IN' or 'NOT_IN'.
|
|
173
|
+
*/
|
|
174
|
+
values?: string[];
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
export interface CrmObjectSnapshotBatchRequest {
|
|
178
|
+
/**
|
|
179
|
+
* An array of CrmObjectSnapshotRequest objects, each representing a request to create a snapshot for a specific CRM object. This property is required.
|
|
180
|
+
*/
|
|
181
|
+
snapshotRequests: CrmObjectSnapshotRequest[];
|
|
182
|
+
}
|
|
183
|
+
|
|
184
|
+
export interface CrmObjectSnapshotBatchResponse {
|
|
185
|
+
/**
|
|
186
|
+
* An array of CrmObjectSnapshotResponse objects, each representing the result of a snapshot operation for a specific CRM object. This property is required.
|
|
187
|
+
*/
|
|
188
|
+
snapshotResponses: CrmObjectSnapshotResponse[];
|
|
189
|
+
}
|
|
190
|
+
|
|
191
|
+
export interface CrmObjectSnapshotRequest {
|
|
192
|
+
/**
|
|
193
|
+
* An integer representing the unique identifier of the CRM object for which the snapshot is requested.
|
|
194
|
+
*/
|
|
195
|
+
objectId: number;
|
|
196
|
+
/**
|
|
197
|
+
* A string representing the type identifier of the CRM object, specifying what kind of object it is within HubSpot.
|
|
198
|
+
*/
|
|
199
|
+
objectTypeId: string;
|
|
200
|
+
/**
|
|
201
|
+
* An integer representing the unique identifier of the HubSpot account (portal) where the CRM object resides.
|
|
202
|
+
*/
|
|
203
|
+
portalId: number;
|
|
204
|
+
/**
|
|
205
|
+
* An array of strings, each representing a property of the CRM object that should be included in the snapshot.
|
|
206
|
+
*/
|
|
207
|
+
properties: string[];
|
|
208
|
+
}
|
|
209
|
+
|
|
210
|
+
export interface CrmObjectSnapshotResponse {
|
|
211
|
+
/**
|
|
212
|
+
* An integer representing the unique identifier of the CRM object for which the snapshot is taken.
|
|
213
|
+
*/
|
|
214
|
+
objectId: number;
|
|
215
|
+
/**
|
|
216
|
+
* A string indicating the type of the CRM object, such as contact, company, or deal.
|
|
217
|
+
*/
|
|
218
|
+
objectTypeId: string;
|
|
219
|
+
/**
|
|
220
|
+
* An integer representing the unique identifier of the HubSpot portal associated with the CRM object.
|
|
221
|
+
*/
|
|
222
|
+
portalId: number;
|
|
223
|
+
/**
|
|
224
|
+
* A UUID string representing the status identifier of the snapshot request, indicating the current state of the snapshot process.
|
|
225
|
+
*/
|
|
226
|
+
snapshotStatusId: string;
|
|
227
|
+
}
|
|
228
|
+
|
|
229
|
+
/**
|
|
230
|
+
* Defines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against.
|
|
231
|
+
*/
|
|
232
|
+
export interface Filter {
|
|
233
|
+
/**
|
|
234
|
+
* An array of conditions that define the criteria for the filter. Each condition specifies a property, an operator, and optionally a value or values.
|
|
235
|
+
*/
|
|
236
|
+
conditions: Condition[];
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
export interface FilterCreateRequest {
|
|
240
|
+
filter: Filter;
|
|
241
|
+
/**
|
|
242
|
+
* The unique identifier of the subscription to which the filter will be applied. It is an integer formatted as int64.
|
|
243
|
+
*/
|
|
244
|
+
subscriptionId: number;
|
|
245
|
+
}
|
|
246
|
+
|
|
247
|
+
export interface FilterCreateResponse {
|
|
248
|
+
/**
|
|
249
|
+
* The unique identifier for the created filter. It is an integer formatted as int64.
|
|
250
|
+
*/
|
|
251
|
+
filterId: number;
|
|
252
|
+
}
|
|
253
|
+
|
|
254
|
+
export interface FilterResponse {
|
|
255
|
+
/**
|
|
256
|
+
* A Unix timestamp in milliseconds indicating when the filter was created.
|
|
257
|
+
*/
|
|
258
|
+
createdAt: number;
|
|
259
|
+
filter: Filter;
|
|
260
|
+
/**
|
|
261
|
+
* The unique identifier for the filter. It is an integer in int64 format.
|
|
262
|
+
*/
|
|
263
|
+
id: number;
|
|
264
|
+
}
|
|
265
|
+
|
|
266
|
+
export interface GdprPrivacyDeletionSubscriptionUpsertRequest {
|
|
267
|
+
actions: (
|
|
268
|
+
| 'ADDED_TO_LIST'
|
|
269
|
+
| 'APP_INSTALL'
|
|
270
|
+
| 'APP_UNINSTALL'
|
|
271
|
+
| 'ASSOCIATION_ADDED'
|
|
272
|
+
| 'ASSOCIATION_REMOVED'
|
|
273
|
+
| 'CREATE'
|
|
274
|
+
| 'DELETE'
|
|
275
|
+
| 'GDPR_DELETE'
|
|
276
|
+
| 'MERGE'
|
|
277
|
+
| 'REMOVED_FROM_LIST'
|
|
278
|
+
| 'RESTORE'
|
|
279
|
+
| 'SNAPSHOT'
|
|
280
|
+
| 'UPDATE'
|
|
281
|
+
)[];
|
|
282
|
+
objectTypeId: string;
|
|
283
|
+
portalId: number;
|
|
284
|
+
subscriptionType:
|
|
285
|
+
| 'APP_LIFECYCLE_EVENT'
|
|
286
|
+
| 'ASSOCIATION'
|
|
287
|
+
| 'EVENT'
|
|
288
|
+
| 'GDPR_PRIVACY_DELETION'
|
|
289
|
+
| 'LIST_MEMBERSHIP'
|
|
290
|
+
| 'OBJECT';
|
|
291
|
+
}
|
|
292
|
+
|
|
293
|
+
export interface JournalFetchResponse {
|
|
294
|
+
/**
|
|
295
|
+
* The unique identifier for the current offset of the journal entry, formatted as a UUID.
|
|
296
|
+
*/
|
|
297
|
+
currentOffset: string;
|
|
298
|
+
/**
|
|
299
|
+
* The date and time when the URL will expire, in ISO 8601 format.
|
|
300
|
+
*/
|
|
301
|
+
expiresAt: string;
|
|
302
|
+
/**
|
|
303
|
+
* The URL where the journal entry can be accessed. It is a string.
|
|
304
|
+
*/
|
|
305
|
+
url: string;
|
|
306
|
+
}
|
|
307
|
+
|
|
308
|
+
export interface ListMembershipSubscriptionUpsertRequest {
|
|
309
|
+
actions: (
|
|
310
|
+
| 'ADDED_TO_LIST'
|
|
311
|
+
| 'APP_INSTALL'
|
|
312
|
+
| 'APP_UNINSTALL'
|
|
313
|
+
| 'ASSOCIATION_ADDED'
|
|
314
|
+
| 'ASSOCIATION_REMOVED'
|
|
315
|
+
| 'CREATE'
|
|
316
|
+
| 'DELETE'
|
|
317
|
+
| 'GDPR_DELETE'
|
|
318
|
+
| 'MERGE'
|
|
319
|
+
| 'REMOVED_FROM_LIST'
|
|
320
|
+
| 'RESTORE'
|
|
321
|
+
| 'SNAPSHOT'
|
|
322
|
+
| 'UPDATE'
|
|
323
|
+
)[];
|
|
324
|
+
listIds: number[];
|
|
325
|
+
objectIds: number[];
|
|
326
|
+
portalId: number;
|
|
327
|
+
subscriptionType:
|
|
328
|
+
| 'APP_LIFECYCLE_EVENT'
|
|
329
|
+
| 'ASSOCIATION'
|
|
330
|
+
| 'EVENT'
|
|
331
|
+
| 'GDPR_PRIVACY_DELETION'
|
|
332
|
+
| 'LIST_MEMBERSHIP'
|
|
333
|
+
| 'OBJECT';
|
|
334
|
+
}
|
|
335
|
+
|
|
336
|
+
export interface ObjectSubscriptionUpsertRequest {
|
|
337
|
+
actions: (
|
|
338
|
+
| 'ADDED_TO_LIST'
|
|
339
|
+
| 'APP_INSTALL'
|
|
340
|
+
| 'APP_UNINSTALL'
|
|
341
|
+
| 'ASSOCIATION_ADDED'
|
|
342
|
+
| 'ASSOCIATION_REMOVED'
|
|
343
|
+
| 'CREATE'
|
|
344
|
+
| 'DELETE'
|
|
345
|
+
| 'GDPR_DELETE'
|
|
346
|
+
| 'MERGE'
|
|
347
|
+
| 'REMOVED_FROM_LIST'
|
|
348
|
+
| 'RESTORE'
|
|
349
|
+
| 'SNAPSHOT'
|
|
350
|
+
| 'UPDATE'
|
|
351
|
+
)[];
|
|
352
|
+
objectIds: number[];
|
|
353
|
+
objectTypeId: string;
|
|
354
|
+
portalId: number;
|
|
355
|
+
properties: string[];
|
|
356
|
+
subscriptionType:
|
|
357
|
+
| 'APP_LIFECYCLE_EVENT'
|
|
358
|
+
| 'ASSOCIATION'
|
|
359
|
+
| 'EVENT'
|
|
360
|
+
| 'GDPR_PRIVACY_DELETION'
|
|
361
|
+
| 'LIST_MEMBERSHIP'
|
|
362
|
+
| 'OBJECT';
|
|
363
|
+
}
|
|
364
|
+
|
|
365
|
+
export interface SettingsChangeRequest {
|
|
366
|
+
/**
|
|
367
|
+
* The URL to which webhook events will be sent. It is a string.
|
|
368
|
+
*/
|
|
369
|
+
targetUrl: string;
|
|
370
|
+
throttling: ThrottlingSettings;
|
|
371
|
+
}
|
|
372
|
+
|
|
373
|
+
export interface SettingsResponse {
|
|
374
|
+
/**
|
|
375
|
+
* The date and time when the webhook settings were created, in ISO 8601 format.
|
|
376
|
+
*/
|
|
377
|
+
createdAt: string;
|
|
378
|
+
/**
|
|
379
|
+
* The URL to which the webhook events will be sent. It is a string.
|
|
380
|
+
*/
|
|
381
|
+
targetUrl: string;
|
|
382
|
+
throttling: ThrottlingSettings;
|
|
383
|
+
/**
|
|
384
|
+
* The date and time when the webhook settings were last updated, in ISO 8601 format.
|
|
385
|
+
*/
|
|
386
|
+
updatedAt?: string;
|
|
387
|
+
}
|
|
388
|
+
|
|
389
|
+
export interface SnapshotStatusResponse {
|
|
390
|
+
/**
|
|
391
|
+
* The timestamp indicating when the snapshot operation was completed, represented as a Unix timestamp in milliseconds.
|
|
392
|
+
*/
|
|
393
|
+
completedAt?: number;
|
|
394
|
+
/**
|
|
395
|
+
* A code representing the error that occurred, if any. Possible values are 'TIMEOUT', 'VALIDATION_ERROR', 'INTERNAL_ERROR', and 'PERMISSION_DENIED'.
|
|
396
|
+
*/
|
|
397
|
+
errorCode?:
|
|
398
|
+
| 'INTERNAL_ERROR'
|
|
399
|
+
| 'PERMISSION_DENIED'
|
|
400
|
+
| 'TIMEOUT'
|
|
401
|
+
| 'VALIDATION_ERROR';
|
|
402
|
+
/**
|
|
403
|
+
* The unique identifier for the snapshot operation, represented as a UUID.
|
|
404
|
+
*/
|
|
405
|
+
id: string;
|
|
406
|
+
/**
|
|
407
|
+
* The timestamp indicating when the snapshot operation was initiated, represented as a Unix timestamp in milliseconds.
|
|
408
|
+
*/
|
|
409
|
+
initiatedAt: number;
|
|
410
|
+
/**
|
|
411
|
+
* A descriptive message providing additional information about the snapshot operation or error.
|
|
412
|
+
*/
|
|
413
|
+
message?: string;
|
|
414
|
+
/**
|
|
415
|
+
* The current status of the snapshot. Valid values include 'PENDING', 'IN_PROGRESS', 'COMPLETED', 'FAILED', and 'EXPIRED'.
|
|
416
|
+
*/
|
|
417
|
+
status: 'COMPLETED' | 'EXPIRED' | 'FAILED' | 'IN_PROGRESS' | 'PENDING';
|
|
418
|
+
}
|
|
419
|
+
|
|
420
|
+
export interface SubscriptionBatchUpdateRequest {
|
|
421
|
+
/**
|
|
422
|
+
* A boolean indicating whether the subscription is active.
|
|
423
|
+
*/
|
|
424
|
+
active: boolean;
|
|
425
|
+
/**
|
|
426
|
+
* The unique identifier for the subscription. It is an integer.
|
|
427
|
+
*/
|
|
428
|
+
id: number;
|
|
429
|
+
}
|
|
430
|
+
|
|
431
|
+
export interface SubscriptionCreateRequest {
|
|
432
|
+
/**
|
|
433
|
+
* A boolean indicating whether the subscription is active.
|
|
434
|
+
*/
|
|
435
|
+
active: boolean;
|
|
436
|
+
/**
|
|
437
|
+
* A string representing the type of event to subscribe to. Valid values include various property changes, creations, deletions, merges, restorations, association changes, and event completions.
|
|
438
|
+
*/
|
|
439
|
+
eventType:
|
|
440
|
+
| 'company.associationChange'
|
|
441
|
+
| 'company.creation'
|
|
442
|
+
| 'company.deletion'
|
|
443
|
+
| 'company.merge'
|
|
444
|
+
| 'company.propertyChange'
|
|
445
|
+
| 'company.restore'
|
|
446
|
+
| 'contact.associationChange'
|
|
447
|
+
| 'contact.creation'
|
|
448
|
+
| 'contact.deletion'
|
|
449
|
+
| 'contact.merge'
|
|
450
|
+
| 'contact.privacyDeletion'
|
|
451
|
+
| 'contact.propertyChange'
|
|
452
|
+
| 'contact.restore'
|
|
453
|
+
| 'conversation.creation'
|
|
454
|
+
| 'conversation.deletion'
|
|
455
|
+
| 'conversation.newMessage'
|
|
456
|
+
| 'conversation.privacyDeletion'
|
|
457
|
+
| 'conversation.propertyChange'
|
|
458
|
+
| 'deal.associationChange'
|
|
459
|
+
| 'deal.creation'
|
|
460
|
+
| 'deal.deletion'
|
|
461
|
+
| 'deal.merge'
|
|
462
|
+
| 'deal.propertyChange'
|
|
463
|
+
| 'deal.restore'
|
|
464
|
+
| 'event.completed'
|
|
465
|
+
| 'line_item.associationChange'
|
|
466
|
+
| 'line_item.creation'
|
|
467
|
+
| 'line_item.deletion'
|
|
468
|
+
| 'line_item.merge'
|
|
469
|
+
| 'line_item.propertyChange'
|
|
470
|
+
| 'line_item.restore'
|
|
471
|
+
| 'object.associationChange'
|
|
472
|
+
| 'object.creation'
|
|
473
|
+
| 'object.deletion'
|
|
474
|
+
| 'object.merge'
|
|
475
|
+
| 'object.propertyChange'
|
|
476
|
+
| 'object.restore'
|
|
477
|
+
| 'product.creation'
|
|
478
|
+
| 'product.deletion'
|
|
479
|
+
| 'product.merge'
|
|
480
|
+
| 'product.propertyChange'
|
|
481
|
+
| 'product.restore'
|
|
482
|
+
| 'ticket.associationChange'
|
|
483
|
+
| 'ticket.creation'
|
|
484
|
+
| 'ticket.deletion'
|
|
485
|
+
| 'ticket.merge'
|
|
486
|
+
| 'ticket.propertyChange'
|
|
487
|
+
| 'ticket.restore';
|
|
488
|
+
/**
|
|
489
|
+
* A string providing a human-readable name for the event type.
|
|
490
|
+
*/
|
|
491
|
+
eventTypeName?: string;
|
|
492
|
+
/**
|
|
493
|
+
* A string representing the ID of the object type associated with the subscription.
|
|
494
|
+
*/
|
|
495
|
+
objectTypeId?: string;
|
|
496
|
+
/**
|
|
497
|
+
* A string indicating the specific property name related to the event type, if applicable.
|
|
498
|
+
*/
|
|
499
|
+
propertyName?: string;
|
|
500
|
+
}
|
|
501
|
+
|
|
502
|
+
export interface SubscriptionListResponse {
|
|
503
|
+
/**
|
|
504
|
+
* An array of subscription responses, each detailing a specific subscription's properties and status.
|
|
505
|
+
*/
|
|
506
|
+
results: SubscriptionResponse[];
|
|
507
|
+
}
|
|
508
|
+
|
|
509
|
+
export interface SubscriptionPatchRequest {
|
|
510
|
+
/**
|
|
511
|
+
* A boolean indicating whether the subscription is active. If true, the subscription is active; if false, it is inactive.
|
|
512
|
+
*/
|
|
513
|
+
active?: boolean;
|
|
514
|
+
}
|
|
515
|
+
|
|
516
|
+
export interface SubscriptionResponse {
|
|
517
|
+
/**
|
|
518
|
+
* A boolean indicating whether the subscription is currently active.
|
|
519
|
+
*/
|
|
520
|
+
active: boolean;
|
|
521
|
+
/**
|
|
522
|
+
* The date and time when the subscription was created, in ISO 8601 format.
|
|
523
|
+
*/
|
|
524
|
+
createdAt: string;
|
|
525
|
+
/**
|
|
526
|
+
* The type of event that triggers the subscription. Valid values include various property changes, creations, deletions, merges, restores, and association changes for different HubSpot objects.
|
|
527
|
+
*/
|
|
528
|
+
eventType:
|
|
529
|
+
| 'company.associationChange'
|
|
530
|
+
| 'company.creation'
|
|
531
|
+
| 'company.deletion'
|
|
532
|
+
| 'company.merge'
|
|
533
|
+
| 'company.propertyChange'
|
|
534
|
+
| 'company.restore'
|
|
535
|
+
| 'contact.associationChange'
|
|
536
|
+
| 'contact.creation'
|
|
537
|
+
| 'contact.deletion'
|
|
538
|
+
| 'contact.merge'
|
|
539
|
+
| 'contact.privacyDeletion'
|
|
540
|
+
| 'contact.propertyChange'
|
|
541
|
+
| 'contact.restore'
|
|
542
|
+
| 'conversation.creation'
|
|
543
|
+
| 'conversation.deletion'
|
|
544
|
+
| 'conversation.newMessage'
|
|
545
|
+
| 'conversation.privacyDeletion'
|
|
546
|
+
| 'conversation.propertyChange'
|
|
547
|
+
| 'deal.associationChange'
|
|
548
|
+
| 'deal.creation'
|
|
549
|
+
| 'deal.deletion'
|
|
550
|
+
| 'deal.merge'
|
|
551
|
+
| 'deal.propertyChange'
|
|
552
|
+
| 'deal.restore'
|
|
553
|
+
| 'event.completed'
|
|
554
|
+
| 'line_item.associationChange'
|
|
555
|
+
| 'line_item.creation'
|
|
556
|
+
| 'line_item.deletion'
|
|
557
|
+
| 'line_item.merge'
|
|
558
|
+
| 'line_item.propertyChange'
|
|
559
|
+
| 'line_item.restore'
|
|
560
|
+
| 'object.associationChange'
|
|
561
|
+
| 'object.creation'
|
|
562
|
+
| 'object.deletion'
|
|
563
|
+
| 'object.merge'
|
|
564
|
+
| 'object.propertyChange'
|
|
565
|
+
| 'object.restore'
|
|
566
|
+
| 'product.creation'
|
|
567
|
+
| 'product.deletion'
|
|
568
|
+
| 'product.merge'
|
|
569
|
+
| 'product.propertyChange'
|
|
570
|
+
| 'product.restore'
|
|
571
|
+
| 'ticket.associationChange'
|
|
572
|
+
| 'ticket.creation'
|
|
573
|
+
| 'ticket.deletion'
|
|
574
|
+
| 'ticket.merge'
|
|
575
|
+
| 'ticket.propertyChange'
|
|
576
|
+
| 'ticket.restore';
|
|
577
|
+
/**
|
|
578
|
+
* The name of the event type for the subscription.
|
|
579
|
+
*/
|
|
580
|
+
eventTypeName?: string;
|
|
581
|
+
/**
|
|
582
|
+
* The unique identifier for the subscription. It is an integer formatted as int64.
|
|
583
|
+
*/
|
|
584
|
+
id: string;
|
|
585
|
+
/**
|
|
586
|
+
* The identifier for the object type associated with the subscription. It is a string.
|
|
587
|
+
*/
|
|
588
|
+
objectTypeId?: string;
|
|
589
|
+
/**
|
|
590
|
+
* The name of the property associated with the subscription event, if applicable.
|
|
591
|
+
*/
|
|
592
|
+
propertyName?: string;
|
|
593
|
+
/**
|
|
594
|
+
* The date and time when the subscription was last updated, in ISO 8601 format.
|
|
595
|
+
*/
|
|
596
|
+
updatedAt?: string;
|
|
597
|
+
}
|
|
598
|
+
|
|
599
|
+
export interface SubscriptionResponse_1 {
|
|
600
|
+
/**
|
|
601
|
+
* An object containing action overrides, where each key is an action and the value is an ActionOverrideRequest object.
|
|
602
|
+
*/
|
|
603
|
+
actionOverrides?: Record<string, ActionOverrideRequest>;
|
|
604
|
+
/**
|
|
605
|
+
* A list of actions that trigger the subscription. Possible values include 'CREATE', 'UPDATE', 'DELETE', 'MERGE', 'RESTORE', 'ASSOCIATION_ADDED', 'ASSOCIATION_REMOVED', 'SNAPSHOT', 'APP_INSTALL', 'APP_UNINSTALL', 'ADDED_TO_LIST', 'REMOVED_FROM_LIST', and 'GDPR_DELETE'.
|
|
606
|
+
*/
|
|
607
|
+
actions: (
|
|
608
|
+
| 'ADDED_TO_LIST'
|
|
609
|
+
| 'APP_INSTALL'
|
|
610
|
+
| 'APP_UNINSTALL'
|
|
611
|
+
| 'ASSOCIATION_ADDED'
|
|
612
|
+
| 'ASSOCIATION_REMOVED'
|
|
613
|
+
| 'CREATE'
|
|
614
|
+
| 'DELETE'
|
|
615
|
+
| 'GDPR_DELETE'
|
|
616
|
+
| 'MERGE'
|
|
617
|
+
| 'REMOVED_FROM_LIST'
|
|
618
|
+
| 'RESTORE'
|
|
619
|
+
| 'SNAPSHOT'
|
|
620
|
+
| 'UPDATE'
|
|
621
|
+
)[];
|
|
622
|
+
/**
|
|
623
|
+
* The unique identifier for the app associated with the subscription. It is an integer formatted as int64.
|
|
624
|
+
*/
|
|
625
|
+
appId: number;
|
|
626
|
+
/**
|
|
627
|
+
* A list of associated object type IDs. Each ID is a string.
|
|
628
|
+
*/
|
|
629
|
+
associatedObjectTypeIds?: string[];
|
|
630
|
+
/**
|
|
631
|
+
* The date and time when the subscription was created, in ISO 8601 format.
|
|
632
|
+
*/
|
|
633
|
+
createdAt: string;
|
|
634
|
+
/**
|
|
635
|
+
* The ID of the user who created the subscription. It is an integer formatted as int64.
|
|
636
|
+
*/
|
|
637
|
+
createdBy?: number;
|
|
638
|
+
/**
|
|
639
|
+
* The date and time when the subscription was deleted, in ISO 8601 format, if applicable.
|
|
640
|
+
*/
|
|
641
|
+
deletedAt?: string;
|
|
642
|
+
/**
|
|
643
|
+
* The unique identifier for the subscription. It is an integer formatted as int64.
|
|
644
|
+
*/
|
|
645
|
+
id: number;
|
|
646
|
+
/**
|
|
647
|
+
* A list of list IDs associated with the subscription. Each ID is an integer formatted as int64.
|
|
648
|
+
*/
|
|
649
|
+
listIds?: number[];
|
|
650
|
+
/**
|
|
651
|
+
* A list of object IDs associated with the subscription. Each ID is an integer formatted as int64.
|
|
652
|
+
*/
|
|
653
|
+
objectIds?: number[];
|
|
654
|
+
/**
|
|
655
|
+
* The identifier for the object type associated with the subscription. It is a string.
|
|
656
|
+
*/
|
|
657
|
+
objectTypeId: string;
|
|
658
|
+
/**
|
|
659
|
+
* The unique identifier for the portal associated with the subscription. It is an integer formatted as int64.
|
|
660
|
+
*/
|
|
661
|
+
portalId?: number;
|
|
662
|
+
/**
|
|
663
|
+
* A list of property names associated with the subscription. Each property is a string.
|
|
664
|
+
*/
|
|
665
|
+
properties?: string[];
|
|
666
|
+
/**
|
|
667
|
+
* The type of subscription, which can be one of the following: 'OBJECT', 'ASSOCIATION', 'EVENT', 'APP_LIFECYCLE_EVENT', 'LIST_MEMBERSHIP', or 'GDPR_PRIVACY_DELETION'.
|
|
668
|
+
*/
|
|
669
|
+
subscriptionType:
|
|
670
|
+
| 'APP_LIFECYCLE_EVENT'
|
|
671
|
+
| 'ASSOCIATION'
|
|
672
|
+
| 'EVENT'
|
|
673
|
+
| 'GDPR_PRIVACY_DELETION'
|
|
674
|
+
| 'LIST_MEMBERSHIP'
|
|
675
|
+
| 'OBJECT';
|
|
676
|
+
/**
|
|
677
|
+
* The date and time when the subscription was last updated, in ISO 8601 format.
|
|
678
|
+
*/
|
|
679
|
+
updatedAt: string;
|
|
680
|
+
}
|
|
681
|
+
|
|
682
|
+
export type SubscriptionUpsertRequest =
|
|
683
|
+
| ObjectSubscriptionUpsertRequest
|
|
684
|
+
| AssociationSubscriptionUpsertRequest
|
|
685
|
+
| AppLifecycleEventSubscriptionUpsertRequest
|
|
686
|
+
| ListMembershipSubscriptionUpsertRequest
|
|
687
|
+
| GdprPrivacyDeletionSubscriptionUpsertRequest;
|
|
688
|
+
|
|
689
|
+
export interface ThrottlingSettings {
|
|
690
|
+
/**
|
|
691
|
+
* The maximum number of concurrent requests allowed. This is an integer value.
|
|
692
|
+
*/
|
|
693
|
+
maxConcurrentRequests: number;
|
|
694
|
+
}
|
|
695
|
+
}
|
|
696
|
+
|
|
697
|
+
export namespace WebhooksWebhooks {
|
|
698
|
+
export interface CreateBatchEventSubscriptionsInput {
|
|
699
|
+
/**
|
|
700
|
+
* The identifier for the app.
|
|
701
|
+
*/
|
|
702
|
+
appId: number;
|
|
703
|
+
data: WebhooksSchemas.BatchInputSubscriptionBatchUpdateRequest;
|
|
704
|
+
}
|
|
705
|
+
|
|
706
|
+
export type CreateBatchEventSubscriptionsOutput =
|
|
707
|
+
WebhooksSchemas.BatchResponseSubscriptionResponse;
|
|
708
|
+
|
|
709
|
+
export type CreateCrmSnapshotsInput =
|
|
710
|
+
WebhooksSchemas.CrmObjectSnapshotBatchRequest;
|
|
711
|
+
|
|
712
|
+
export type CreateCrmSnapshotsOutput =
|
|
713
|
+
WebhooksSchemas.CrmObjectSnapshotBatchResponse;
|
|
714
|
+
|
|
715
|
+
export interface CreateEventSubscriptionInput {
|
|
716
|
+
/**
|
|
717
|
+
* The identifier for the app.
|
|
718
|
+
*/
|
|
719
|
+
appId: number;
|
|
720
|
+
data: WebhooksSchemas.SubscriptionCreateRequest;
|
|
721
|
+
}
|
|
722
|
+
|
|
723
|
+
export type CreateEventSubscriptionOutput =
|
|
724
|
+
WebhooksSchemas.SubscriptionResponse;
|
|
725
|
+
|
|
726
|
+
export type CreateJournalSubscriptionInput =
|
|
727
|
+
WebhooksSchemas.SubscriptionUpsertRequest;
|
|
728
|
+
|
|
729
|
+
export type CreateJournalSubscriptionOutput =
|
|
730
|
+
WebhooksSchemas.SubscriptionResponse_1;
|
|
731
|
+
|
|
732
|
+
export type CreateSubscriptionFilterInput =
|
|
733
|
+
WebhooksSchemas.FilterCreateRequest;
|
|
734
|
+
|
|
735
|
+
export type CreateSubscriptionFilterOutput =
|
|
736
|
+
WebhooksSchemas.FilterCreateResponse;
|
|
737
|
+
|
|
738
|
+
export interface DeleteEventSubscriptionInput {
|
|
739
|
+
/**
|
|
740
|
+
* The identifier for the app.
|
|
741
|
+
*/
|
|
742
|
+
appId: number;
|
|
743
|
+
/**
|
|
744
|
+
* The identifier for the subscription.
|
|
745
|
+
*/
|
|
746
|
+
subscriptionId: number;
|
|
747
|
+
}
|
|
748
|
+
|
|
749
|
+
export type DeleteEventSubscriptionOutput = void;
|
|
750
|
+
|
|
751
|
+
export interface DeleteJournalSubscriptionForPortalInput {
|
|
752
|
+
/**
|
|
753
|
+
* The unique identifier of the portal whose webhook journal subscription is to be deleted.
|
|
754
|
+
*/
|
|
755
|
+
portalId: number;
|
|
756
|
+
}
|
|
757
|
+
|
|
758
|
+
export type DeleteJournalSubscriptionForPortalOutput = void;
|
|
759
|
+
|
|
760
|
+
export interface DeleteJournalSubscriptionInput {
|
|
761
|
+
/**
|
|
762
|
+
* The unique identifier of the subscription to delete.
|
|
763
|
+
*/
|
|
764
|
+
subscriptionId: number;
|
|
765
|
+
}
|
|
766
|
+
|
|
767
|
+
export type DeleteJournalSubscriptionOutput = void;
|
|
768
|
+
|
|
769
|
+
export interface DeleteSettingsInput {
|
|
770
|
+
/**
|
|
771
|
+
* The identifier for the app.
|
|
772
|
+
*/
|
|
773
|
+
appId: number;
|
|
774
|
+
}
|
|
775
|
+
|
|
776
|
+
export type DeleteSettingsOutput = void;
|
|
777
|
+
|
|
778
|
+
export interface DeleteSubscriptionFilterInput {
|
|
779
|
+
/**
|
|
780
|
+
* The unique identifier of the filter to delete.
|
|
781
|
+
*/
|
|
782
|
+
filterId: number;
|
|
783
|
+
}
|
|
784
|
+
|
|
785
|
+
export type DeleteSubscriptionFilterOutput = void;
|
|
786
|
+
|
|
787
|
+
export interface GetEarliestJournalBatchInput {
|
|
788
|
+
/**
|
|
789
|
+
* The maximum number of journal entries to retrieve in the batch. This must be an integer with a minimum value of 1.
|
|
790
|
+
*/
|
|
791
|
+
count: number;
|
|
792
|
+
/**
|
|
793
|
+
* The ID of the portal installation to filter the webhook journal entries by. This is an integer value.
|
|
794
|
+
*/
|
|
795
|
+
installPortalId?: number;
|
|
796
|
+
}
|
|
797
|
+
|
|
798
|
+
export type GetEarliestJournalBatchOutput =
|
|
799
|
+
WebhooksSchemas.BatchResponseJournalFetchResponse;
|
|
800
|
+
|
|
801
|
+
export interface GetEarliestJournalEntryInput {
|
|
802
|
+
/**
|
|
803
|
+
* The ID of the portal installation to filter the journal entries. It is an integer.
|
|
804
|
+
*/
|
|
805
|
+
installPortalId?: number;
|
|
806
|
+
}
|
|
807
|
+
|
|
808
|
+
export type GetEarliestJournalEntryOutput = void;
|
|
809
|
+
|
|
810
|
+
export interface GetEarliestLocalJournalBatchInput {
|
|
811
|
+
/**
|
|
812
|
+
* The number of earliest entries to retrieve from the webhook journal. Must be an integer with a minimum value of 1.
|
|
813
|
+
*/
|
|
814
|
+
count: number;
|
|
815
|
+
/**
|
|
816
|
+
* The ID of the portal where the webhooks are installed. This is an integer value.
|
|
817
|
+
*/
|
|
818
|
+
installPortalId?: number;
|
|
819
|
+
}
|
|
820
|
+
|
|
821
|
+
export type GetEarliestLocalJournalBatchOutput =
|
|
822
|
+
WebhooksSchemas.BatchResponseJournalFetchResponse;
|
|
823
|
+
|
|
824
|
+
export interface GetEarliestLocalJournalEntryInput {
|
|
825
|
+
/**
|
|
826
|
+
* The ID of the portal installation to filter the journal entries by. This parameter is optional and should be an integer.
|
|
827
|
+
*/
|
|
828
|
+
installPortalId?: number;
|
|
829
|
+
}
|
|
830
|
+
|
|
831
|
+
export type GetEarliestLocalJournalEntryOutput = void;
|
|
832
|
+
|
|
833
|
+
export interface GetEventSubscriptionInput {
|
|
834
|
+
/**
|
|
835
|
+
* The identifier for the app.
|
|
836
|
+
*/
|
|
837
|
+
appId: number;
|
|
838
|
+
/**
|
|
839
|
+
* The identifier for the subscription.
|
|
840
|
+
*/
|
|
841
|
+
subscriptionId: number;
|
|
842
|
+
}
|
|
843
|
+
|
|
844
|
+
export type GetEventSubscriptionOutput = WebhooksSchemas.SubscriptionResponse;
|
|
845
|
+
|
|
846
|
+
export interface GetJournalBatchByRequestInput {
|
|
847
|
+
data: WebhooksSchemas.BatchInputString;
|
|
848
|
+
/**
|
|
849
|
+
* The ID of the portal where the webhooks are installed. This is an integer value.
|
|
850
|
+
*/
|
|
851
|
+
installPortalId?: number;
|
|
852
|
+
}
|
|
853
|
+
|
|
854
|
+
export type GetJournalBatchByRequestOutput =
|
|
855
|
+
WebhooksSchemas.BatchResponseJournalFetchResponse;
|
|
856
|
+
|
|
857
|
+
export interface GetJournalBatchFromOffsetInput {
|
|
858
|
+
/**
|
|
859
|
+
* The number of journal entries to fetch in the batch. This is an integer value with a minimum of 1.
|
|
860
|
+
*/
|
|
861
|
+
count: number;
|
|
862
|
+
/**
|
|
863
|
+
* The ID of the portal installation. This is an integer value used to specify the portal context for the request.
|
|
864
|
+
*/
|
|
865
|
+
installPortalId?: number;
|
|
866
|
+
/**
|
|
867
|
+
* The starting point for fetching the next batch of journal entries. This is a string value that indicates the offset position.
|
|
868
|
+
*/
|
|
869
|
+
offset: string;
|
|
870
|
+
}
|
|
871
|
+
|
|
872
|
+
export type GetJournalBatchFromOffsetOutput =
|
|
873
|
+
WebhooksSchemas.BatchResponseJournalFetchResponse;
|
|
874
|
+
|
|
875
|
+
export interface GetJournalStatusInput {
|
|
876
|
+
/**
|
|
877
|
+
* The unique identifier (UUID) of the status to retrieve.
|
|
878
|
+
*/
|
|
879
|
+
statusId: string;
|
|
880
|
+
}
|
|
881
|
+
|
|
882
|
+
export type GetJournalStatusOutput = WebhooksSchemas.SnapshotStatusResponse;
|
|
883
|
+
|
|
884
|
+
export interface GetJournalSubscriptionInput {
|
|
885
|
+
/**
|
|
886
|
+
* The unique identifier of the subscription to retrieve. It must be an integer.
|
|
887
|
+
*/
|
|
888
|
+
subscriptionId: number;
|
|
889
|
+
}
|
|
890
|
+
|
|
891
|
+
export type GetJournalSubscriptionOutput =
|
|
892
|
+
WebhooksSchemas.SubscriptionResponse_1;
|
|
893
|
+
|
|
894
|
+
export interface GetLatestJournalBatchInput {
|
|
895
|
+
/**
|
|
896
|
+
* The number of journal entries to retrieve. This is a required integer parameter with a minimum value of 1.
|
|
897
|
+
*/
|
|
898
|
+
count: number;
|
|
899
|
+
/**
|
|
900
|
+
* The ID of the portal installation. This is an integer value used to identify the specific portal.
|
|
901
|
+
*/
|
|
902
|
+
installPortalId?: number;
|
|
903
|
+
}
|
|
904
|
+
|
|
905
|
+
export type GetLatestJournalBatchOutput =
|
|
906
|
+
WebhooksSchemas.BatchResponseJournalFetchResponse;
|
|
907
|
+
|
|
908
|
+
export interface GetLatestJournalEntryInput {
|
|
909
|
+
/**
|
|
910
|
+
* The ID of the portal installation to filter the journal entries. It is an integer value.
|
|
911
|
+
*/
|
|
912
|
+
installPortalId?: number;
|
|
913
|
+
}
|
|
914
|
+
|
|
915
|
+
export type GetLatestJournalEntryOutput = void;
|
|
916
|
+
|
|
917
|
+
export interface GetLatestLocalJournalBatchInput {
|
|
918
|
+
/**
|
|
919
|
+
* The number of journal entries to retrieve. Must be an integer with a minimum value of 1.
|
|
920
|
+
*/
|
|
921
|
+
count: number;
|
|
922
|
+
/**
|
|
923
|
+
* The ID of the portal installation. This parameter is optional and used to filter the journal entries by a specific portal.
|
|
924
|
+
*/
|
|
925
|
+
installPortalId?: number;
|
|
926
|
+
}
|
|
927
|
+
|
|
928
|
+
export type GetLatestLocalJournalBatchOutput =
|
|
929
|
+
WebhooksSchemas.BatchResponseJournalFetchResponse;
|
|
930
|
+
|
|
931
|
+
export interface GetLatestLocalJournalEntryInput {
|
|
932
|
+
/**
|
|
933
|
+
* The ID of the portal for which to retrieve the latest journal entries. This parameter is optional and should be an integer.
|
|
934
|
+
*/
|
|
935
|
+
installPortalId?: number;
|
|
936
|
+
}
|
|
937
|
+
|
|
938
|
+
export type GetLatestLocalJournalEntryOutput = void;
|
|
939
|
+
|
|
940
|
+
export interface GetLocalJournalBatchByRequestInput {
|
|
941
|
+
data: WebhooksSchemas.BatchInputString;
|
|
942
|
+
/**
|
|
943
|
+
* The ID of the portal where the webhooks are installed. This parameter is optional and is used to specify the target portal.
|
|
944
|
+
*/
|
|
945
|
+
installPortalId?: number;
|
|
946
|
+
}
|
|
947
|
+
|
|
948
|
+
export type GetLocalJournalBatchByRequestOutput =
|
|
949
|
+
WebhooksSchemas.BatchResponseJournalFetchResponse;
|
|
950
|
+
|
|
951
|
+
export interface GetLocalJournalBatchFromOffsetInput {
|
|
952
|
+
/**
|
|
953
|
+
* The number of journal entries to retrieve. This is an integer value with a minimum of 1.
|
|
954
|
+
*/
|
|
955
|
+
count: number;
|
|
956
|
+
/**
|
|
957
|
+
* The ID of the portal installation. This is an integer value used to specify the portal context for the request.
|
|
958
|
+
*/
|
|
959
|
+
installPortalId?: number;
|
|
960
|
+
/**
|
|
961
|
+
* The starting point for fetching the batch of journal entries. This is a string value that indicates the offset position.
|
|
962
|
+
*/
|
|
963
|
+
offset: string;
|
|
964
|
+
}
|
|
965
|
+
|
|
966
|
+
export type GetLocalJournalBatchFromOffsetOutput =
|
|
967
|
+
WebhooksSchemas.BatchResponseJournalFetchResponse;
|
|
968
|
+
|
|
969
|
+
export interface GetLocalJournalStatusInput {
|
|
970
|
+
/**
|
|
971
|
+
* The unique identifier (UUID) of the status to retrieve.
|
|
972
|
+
*/
|
|
973
|
+
statusId: string;
|
|
974
|
+
}
|
|
975
|
+
|
|
976
|
+
export type GetLocalJournalStatusOutput =
|
|
977
|
+
WebhooksSchemas.SnapshotStatusResponse;
|
|
978
|
+
|
|
979
|
+
export interface GetNextJournalEntriesInput {
|
|
980
|
+
/**
|
|
981
|
+
* The ID of the portal installation to filter the webhook journal entries. This is an optional parameter.
|
|
982
|
+
*/
|
|
983
|
+
installPortalId?: number;
|
|
984
|
+
/**
|
|
985
|
+
* The offset from which to start retrieving the next batch of webhook journal entries. This parameter is required and identifies the starting point for the batch retrieval.
|
|
986
|
+
*/
|
|
987
|
+
offset: string;
|
|
988
|
+
}
|
|
989
|
+
|
|
990
|
+
export type GetNextJournalEntriesOutput = void;
|
|
8
991
|
|
|
9
|
-
|
|
10
|
-
|
|
992
|
+
export interface GetNextLocalJournalEntriesInput {
|
|
993
|
+
/**
|
|
994
|
+
* The ID of the portal where the webhook is installed. This is an integer value.
|
|
995
|
+
*/
|
|
996
|
+
installPortalId?: number;
|
|
997
|
+
/**
|
|
998
|
+
* The starting point for retrieving the next set of journal entries. This is a string value.
|
|
999
|
+
*/
|
|
1000
|
+
offset: string;
|
|
1001
|
+
}
|
|
1002
|
+
|
|
1003
|
+
export type GetNextLocalJournalEntriesOutput = void;
|
|
1004
|
+
|
|
1005
|
+
export interface GetSettingsInput {
|
|
1006
|
+
/**
|
|
1007
|
+
* The identifier for the app.
|
|
1008
|
+
*/
|
|
1009
|
+
appId: number;
|
|
1010
|
+
}
|
|
1011
|
+
|
|
1012
|
+
export type GetSettingsOutput = WebhooksSchemas.SettingsResponse;
|
|
1013
|
+
|
|
1014
|
+
export interface GetSubscriptionFilterInput {
|
|
1015
|
+
/**
|
|
1016
|
+
* The unique identifier of the filter to retrieve.
|
|
1017
|
+
*/
|
|
1018
|
+
filterId: number;
|
|
1019
|
+
}
|
|
11
1020
|
|
|
12
|
-
|
|
1021
|
+
export type GetSubscriptionFilterOutput = WebhooksSchemas.FilterResponse;
|
|
13
1022
|
|
|
14
|
-
|
|
1023
|
+
export interface ListEventSubscriptionsInput {
|
|
1024
|
+
/**
|
|
1025
|
+
* The identifier for the app.
|
|
1026
|
+
*/
|
|
1027
|
+
appId: number;
|
|
15
1028
|
}
|
|
16
1029
|
|
|
17
|
-
export
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
export type CreateJournalSubscriptionInput =
|
|
29
|
-
Schemas.SubscriptionUpsertRequest;
|
|
30
|
-
|
|
31
|
-
export type CreateJournalSubscriptionOutput =
|
|
32
|
-
Schemas.SubscriptionResponse_1;
|
|
33
|
-
|
|
34
|
-
export interface DeleteEventSubscriptionInput {
|
|
35
|
-
/**
|
|
36
|
-
* The identifier for the app.
|
|
37
|
-
*/
|
|
38
|
-
appId: number;
|
|
39
|
-
/**
|
|
40
|
-
* The identifier for the subscription.
|
|
41
|
-
*/
|
|
42
|
-
subscriptionId: number;
|
|
43
|
-
}
|
|
44
|
-
|
|
45
|
-
export type DeleteEventSubscriptionOutput = void;
|
|
46
|
-
|
|
47
|
-
export interface DeleteJournalSubscriptionForPortalInput {
|
|
48
|
-
/**
|
|
49
|
-
* The unique identifier of the portal whose webhook journal subscription is to be deleted.
|
|
50
|
-
*/
|
|
51
|
-
portalId: number;
|
|
52
|
-
}
|
|
53
|
-
|
|
54
|
-
export type DeleteJournalSubscriptionForPortalOutput = void;
|
|
55
|
-
|
|
56
|
-
export interface DeleteJournalSubscriptionInput {
|
|
57
|
-
/**
|
|
58
|
-
* The unique identifier of the subscription to delete.
|
|
59
|
-
*/
|
|
60
|
-
subscriptionId: number;
|
|
61
|
-
}
|
|
62
|
-
|
|
63
|
-
export type DeleteJournalSubscriptionOutput = void;
|
|
64
|
-
|
|
65
|
-
export interface DeleteSettingsInput {
|
|
66
|
-
/**
|
|
67
|
-
* The identifier for the app.
|
|
68
|
-
*/
|
|
69
|
-
appId: number;
|
|
70
|
-
}
|
|
71
|
-
|
|
72
|
-
export type DeleteSettingsOutput = void;
|
|
73
|
-
|
|
74
|
-
export interface DeleteSubscriptionFilterInput {
|
|
75
|
-
/**
|
|
76
|
-
* The unique identifier of the filter to delete.
|
|
77
|
-
*/
|
|
78
|
-
filterId: number;
|
|
79
|
-
}
|
|
80
|
-
|
|
81
|
-
export type DeleteSubscriptionFilterOutput = void;
|
|
82
|
-
|
|
83
|
-
export interface GetEarliestJournalEntryInput {
|
|
84
|
-
/**
|
|
85
|
-
* The ID of the portal installation to filter the journal entries. It is an integer.
|
|
86
|
-
*/
|
|
87
|
-
installPortalId?: number;
|
|
88
|
-
}
|
|
89
|
-
|
|
90
|
-
export type GetEarliestJournalEntryOutput = void;
|
|
91
|
-
|
|
92
|
-
export interface GetEarliestLocalJournalEntryInput {
|
|
93
|
-
/**
|
|
94
|
-
* The ID of the portal installation to filter the journal entries by. This parameter is optional and should be an integer.
|
|
95
|
-
*/
|
|
96
|
-
installPortalId?: number;
|
|
97
|
-
}
|
|
98
|
-
|
|
99
|
-
export type GetEarliestLocalJournalEntryOutput = void;
|
|
100
|
-
|
|
101
|
-
export interface GetEventSubscriptionInput {
|
|
102
|
-
/**
|
|
103
|
-
* The identifier for the app.
|
|
104
|
-
*/
|
|
105
|
-
appId: number;
|
|
106
|
-
/**
|
|
107
|
-
* The identifier for the subscription.
|
|
108
|
-
*/
|
|
109
|
-
subscriptionId: number;
|
|
110
|
-
}
|
|
111
|
-
|
|
112
|
-
export type GetEventSubscriptionOutput = Schemas.SubscriptionResponse;
|
|
113
|
-
|
|
114
|
-
export interface GetJournalStatusInput {
|
|
115
|
-
/**
|
|
116
|
-
* The unique identifier (UUID) of the status to retrieve.
|
|
117
|
-
*/
|
|
118
|
-
statusId: string;
|
|
119
|
-
}
|
|
120
|
-
|
|
121
|
-
export type GetJournalStatusOutput = Schemas.SnapshotStatusResponse;
|
|
122
|
-
|
|
123
|
-
export interface GetJournalSubscriptionInput {
|
|
124
|
-
/**
|
|
125
|
-
* The unique identifier of the subscription to retrieve. It must be an integer.
|
|
126
|
-
*/
|
|
127
|
-
subscriptionId: number;
|
|
128
|
-
}
|
|
129
|
-
|
|
130
|
-
export type GetJournalSubscriptionOutput = Schemas.SubscriptionResponse_1;
|
|
131
|
-
|
|
132
|
-
export interface GetLatestJournalEntryInput {
|
|
133
|
-
/**
|
|
134
|
-
* The ID of the portal installation to filter the journal entries. It is an integer value.
|
|
135
|
-
*/
|
|
136
|
-
installPortalId?: number;
|
|
137
|
-
}
|
|
138
|
-
|
|
139
|
-
export type GetLatestJournalEntryOutput = void;
|
|
140
|
-
|
|
141
|
-
export interface GetLatestLocalJournalEntryInput {
|
|
142
|
-
/**
|
|
143
|
-
* The ID of the portal for which to retrieve the latest journal entries. This parameter is optional and should be an integer.
|
|
144
|
-
*/
|
|
145
|
-
installPortalId?: number;
|
|
146
|
-
}
|
|
147
|
-
|
|
148
|
-
export type GetLatestLocalJournalEntryOutput = void;
|
|
149
|
-
|
|
150
|
-
export interface GetLocalJournalStatusInput {
|
|
151
|
-
/**
|
|
152
|
-
* The unique identifier (UUID) of the status to retrieve.
|
|
153
|
-
*/
|
|
154
|
-
statusId: string;
|
|
155
|
-
}
|
|
156
|
-
|
|
157
|
-
export type GetLocalJournalStatusOutput = Schemas.SnapshotStatusResponse;
|
|
158
|
-
|
|
159
|
-
export interface GetNextJournalEntriesInput {
|
|
160
|
-
/**
|
|
161
|
-
* The ID of the portal installation to filter the webhook journal entries. This is an optional parameter.
|
|
162
|
-
*/
|
|
163
|
-
installPortalId?: number;
|
|
164
|
-
/**
|
|
165
|
-
* The offset from which to start retrieving the next batch of webhook journal entries. This parameter is required and identifies the starting point for the batch retrieval.
|
|
166
|
-
*/
|
|
167
|
-
offset: string;
|
|
168
|
-
}
|
|
169
|
-
|
|
170
|
-
export type GetNextJournalEntriesOutput = void;
|
|
171
|
-
|
|
172
|
-
export interface GetNextLocalJournalEntriesInput {
|
|
173
|
-
/**
|
|
174
|
-
* The ID of the portal where the webhook is installed. This is an integer value.
|
|
175
|
-
*/
|
|
176
|
-
installPortalId?: number;
|
|
177
|
-
/**
|
|
178
|
-
* The starting point for retrieving the next set of journal entries. This is a string value.
|
|
179
|
-
*/
|
|
180
|
-
offset: string;
|
|
181
|
-
}
|
|
182
|
-
|
|
183
|
-
export type GetNextLocalJournalEntriesOutput = void;
|
|
184
|
-
|
|
185
|
-
export interface GetSettingsInput {
|
|
186
|
-
/**
|
|
187
|
-
* The identifier for the app.
|
|
188
|
-
*/
|
|
189
|
-
appId: number;
|
|
190
|
-
}
|
|
191
|
-
|
|
192
|
-
export type GetSettingsOutput = Schemas.SettingsResponse;
|
|
193
|
-
|
|
194
|
-
export interface GetSubscriptionFilterInput {
|
|
195
|
-
/**
|
|
196
|
-
* The unique identifier of the filter to retrieve.
|
|
197
|
-
*/
|
|
198
|
-
filterId: number;
|
|
199
|
-
}
|
|
200
|
-
|
|
201
|
-
export type GetSubscriptionFilterOutput = Schemas.FilterResponse;
|
|
202
|
-
|
|
203
|
-
export interface ListEventSubscriptionsInput {
|
|
204
|
-
/**
|
|
205
|
-
* The identifier for the app.
|
|
206
|
-
*/
|
|
207
|
-
appId: number;
|
|
208
|
-
}
|
|
209
|
-
|
|
210
|
-
export type ListEventSubscriptionsOutput = Schemas.SubscriptionListResponse;
|
|
211
|
-
|
|
212
|
-
export type ListJournalSubscriptionsOutput =
|
|
213
|
-
Schemas.CollectionResponseSubscriptionResponseNoPaging;
|
|
214
|
-
|
|
215
|
-
export interface ListSubscriptionFiltersInput {
|
|
216
|
-
/**
|
|
217
|
-
* The unique identifier of the subscription for which to retrieve filters.
|
|
218
|
-
*/
|
|
219
|
-
subscriptionId: number;
|
|
220
|
-
}
|
|
221
|
-
|
|
222
|
-
export type ListSubscriptionFiltersOutput = Schemas.FilterResponse[];
|
|
223
|
-
|
|
224
|
-
export interface UpdateEventSubscriptionInput {
|
|
225
|
-
/**
|
|
226
|
-
* The identifier for the app.
|
|
227
|
-
*/
|
|
228
|
-
appId: number;
|
|
229
|
-
data: Schemas.SubscriptionPatchRequest;
|
|
230
|
-
/**
|
|
231
|
-
* The identifier for the subscription.
|
|
232
|
-
*/
|
|
233
|
-
subscriptionId: number;
|
|
234
|
-
}
|
|
235
|
-
|
|
236
|
-
export type UpdateEventSubscriptionOutput = Schemas.SubscriptionResponse;
|
|
237
|
-
|
|
238
|
-
export interface UpdateSettingsInput {
|
|
239
|
-
/**
|
|
240
|
-
* The identifier for the app.
|
|
241
|
-
*/
|
|
242
|
-
appId: number;
|
|
243
|
-
data: Schemas.SettingsChangeRequest;
|
|
244
|
-
}
|
|
245
|
-
|
|
246
|
-
export type UpdateSettingsOutput = Schemas.SettingsResponse;
|
|
1030
|
+
export type ListEventSubscriptionsOutput =
|
|
1031
|
+
WebhooksSchemas.SubscriptionListResponse;
|
|
1032
|
+
|
|
1033
|
+
export type ListJournalSubscriptionsOutput =
|
|
1034
|
+
WebhooksSchemas.CollectionResponseSubscriptionResponseNoPaging;
|
|
1035
|
+
|
|
1036
|
+
export interface ListSubscriptionFiltersInput {
|
|
1037
|
+
/**
|
|
1038
|
+
* The unique identifier of the subscription for which to retrieve filters.
|
|
1039
|
+
*/
|
|
1040
|
+
subscriptionId: number;
|
|
247
1041
|
}
|
|
248
1042
|
|
|
249
|
-
export
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
export interface GetEarliestJournalBatchInput {
|
|
262
|
-
/**
|
|
263
|
-
* The maximum number of journal entries to retrieve in the batch. This must be an integer with a minimum value of 1.
|
|
264
|
-
*/
|
|
265
|
-
count: number;
|
|
266
|
-
/**
|
|
267
|
-
* The ID of the portal installation to filter the webhook journal entries by. This is an integer value.
|
|
268
|
-
*/
|
|
269
|
-
installPortalId?: number;
|
|
270
|
-
}
|
|
271
|
-
|
|
272
|
-
export type GetEarliestJournalBatchOutput =
|
|
273
|
-
Schemas.BatchResponseJournalFetchResponse;
|
|
274
|
-
|
|
275
|
-
export interface GetEarliestLocalJournalBatchInput {
|
|
276
|
-
/**
|
|
277
|
-
* The number of earliest entries to retrieve from the webhook journal. Must be an integer with a minimum value of 1.
|
|
278
|
-
*/
|
|
279
|
-
count: number;
|
|
280
|
-
/**
|
|
281
|
-
* The ID of the portal where the webhooks are installed. This is an integer value.
|
|
282
|
-
*/
|
|
283
|
-
installPortalId?: number;
|
|
284
|
-
}
|
|
285
|
-
|
|
286
|
-
export type GetEarliestLocalJournalBatchOutput =
|
|
287
|
-
Schemas.BatchResponseJournalFetchResponse;
|
|
288
|
-
|
|
289
|
-
export interface GetJournalBatchByRequestInput {
|
|
290
|
-
data: Schemas.BatchInputString;
|
|
291
|
-
/**
|
|
292
|
-
* The ID of the portal where the webhooks are installed. This is an integer value.
|
|
293
|
-
*/
|
|
294
|
-
installPortalId?: number;
|
|
295
|
-
}
|
|
296
|
-
|
|
297
|
-
export type GetJournalBatchByRequestOutput =
|
|
298
|
-
Schemas.BatchResponseJournalFetchResponse;
|
|
299
|
-
|
|
300
|
-
export interface GetJournalBatchFromOffsetInput {
|
|
301
|
-
/**
|
|
302
|
-
* The number of journal entries to fetch in the batch. This is an integer value with a minimum of 1.
|
|
303
|
-
*/
|
|
304
|
-
count: number;
|
|
305
|
-
/**
|
|
306
|
-
* The ID of the portal installation. This is an integer value used to specify the portal context for the request.
|
|
307
|
-
*/
|
|
308
|
-
installPortalId?: number;
|
|
309
|
-
/**
|
|
310
|
-
* The starting point for fetching the next batch of journal entries. This is a string value that indicates the offset position.
|
|
311
|
-
*/
|
|
312
|
-
offset: string;
|
|
313
|
-
}
|
|
314
|
-
|
|
315
|
-
export type GetJournalBatchFromOffsetOutput =
|
|
316
|
-
Schemas.BatchResponseJournalFetchResponse;
|
|
317
|
-
|
|
318
|
-
export interface GetLatestJournalBatchInput {
|
|
319
|
-
/**
|
|
320
|
-
* The number of journal entries to retrieve. This is a required integer parameter with a minimum value of 1.
|
|
321
|
-
*/
|
|
322
|
-
count: number;
|
|
323
|
-
/**
|
|
324
|
-
* The ID of the portal installation. This is an integer value used to identify the specific portal.
|
|
325
|
-
*/
|
|
326
|
-
installPortalId?: number;
|
|
327
|
-
}
|
|
328
|
-
|
|
329
|
-
export type GetLatestJournalBatchOutput =
|
|
330
|
-
Schemas.BatchResponseJournalFetchResponse;
|
|
331
|
-
|
|
332
|
-
export interface GetLatestLocalJournalBatchInput {
|
|
333
|
-
/**
|
|
334
|
-
* The number of journal entries to retrieve. Must be an integer with a minimum value of 1.
|
|
335
|
-
*/
|
|
336
|
-
count: number;
|
|
337
|
-
/**
|
|
338
|
-
* The ID of the portal installation. This parameter is optional and used to filter the journal entries by a specific portal.
|
|
339
|
-
*/
|
|
340
|
-
installPortalId?: number;
|
|
341
|
-
}
|
|
342
|
-
|
|
343
|
-
export type GetLatestLocalJournalBatchOutput =
|
|
344
|
-
Schemas.BatchResponseJournalFetchResponse;
|
|
345
|
-
|
|
346
|
-
export interface GetLocalJournalBatchByRequestInput {
|
|
347
|
-
data: Schemas.BatchInputString;
|
|
348
|
-
/**
|
|
349
|
-
* The ID of the portal where the webhooks are installed. This parameter is optional and is used to specify the target portal.
|
|
350
|
-
*/
|
|
351
|
-
installPortalId?: number;
|
|
352
|
-
}
|
|
353
|
-
|
|
354
|
-
export type GetLocalJournalBatchByRequestOutput =
|
|
355
|
-
Schemas.BatchResponseJournalFetchResponse;
|
|
356
|
-
|
|
357
|
-
export interface GetLocalJournalBatchFromOffsetInput {
|
|
358
|
-
/**
|
|
359
|
-
* The number of journal entries to retrieve. This is an integer value with a minimum of 1.
|
|
360
|
-
*/
|
|
361
|
-
count: number;
|
|
362
|
-
/**
|
|
363
|
-
* The ID of the portal installation. This is an integer value used to specify the portal context for the request.
|
|
364
|
-
*/
|
|
365
|
-
installPortalId?: number;
|
|
366
|
-
/**
|
|
367
|
-
* The starting point for fetching the batch of journal entries. This is a string value that indicates the offset position.
|
|
368
|
-
*/
|
|
369
|
-
offset: string;
|
|
370
|
-
}
|
|
371
|
-
|
|
372
|
-
export type GetLocalJournalBatchFromOffsetOutput =
|
|
373
|
-
Schemas.BatchResponseJournalFetchResponse;
|
|
1043
|
+
export type ListSubscriptionFiltersOutput = WebhooksSchemas.FilterResponse[];
|
|
1044
|
+
|
|
1045
|
+
export interface UpdateEventSubscriptionInput {
|
|
1046
|
+
/**
|
|
1047
|
+
* The identifier for the app.
|
|
1048
|
+
*/
|
|
1049
|
+
appId: number;
|
|
1050
|
+
data: WebhooksSchemas.SubscriptionPatchRequest;
|
|
1051
|
+
/**
|
|
1052
|
+
* The identifier for the subscription.
|
|
1053
|
+
*/
|
|
1054
|
+
subscriptionId: number;
|
|
374
1055
|
}
|
|
375
1056
|
|
|
376
|
-
export
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
listIds?: number[];
|
|
386
|
-
/**
|
|
387
|
-
* An array of integers, each representing an object ID for which the action override is applicable. The integers are in int64 format.
|
|
388
|
-
*/
|
|
389
|
-
objectIds?: number[];
|
|
390
|
-
/**
|
|
391
|
-
* An array of strings representing the properties to be overridden in the action. Each string corresponds to a property name.
|
|
392
|
-
*/
|
|
393
|
-
properties?: string[];
|
|
394
|
-
}
|
|
395
|
-
|
|
396
|
-
export interface AppLifecycleEventSubscriptionUpsertRequest {
|
|
397
|
-
eventTypeId: string;
|
|
398
|
-
properties: string[];
|
|
399
|
-
subscriptionType:
|
|
400
|
-
| 'APP_LIFECYCLE_EVENT'
|
|
401
|
-
| 'ASSOCIATION'
|
|
402
|
-
| 'EVENT'
|
|
403
|
-
| 'GDPR_PRIVACY_DELETION'
|
|
404
|
-
| 'LIST_MEMBERSHIP'
|
|
405
|
-
| 'OBJECT';
|
|
406
|
-
}
|
|
407
|
-
|
|
408
|
-
export interface AssociationSubscriptionUpsertRequest {
|
|
409
|
-
actions: (
|
|
410
|
-
| 'ADDED_TO_LIST'
|
|
411
|
-
| 'APP_INSTALL'
|
|
412
|
-
| 'APP_UNINSTALL'
|
|
413
|
-
| 'ASSOCIATION_ADDED'
|
|
414
|
-
| 'ASSOCIATION_REMOVED'
|
|
415
|
-
| 'CREATE'
|
|
416
|
-
| 'DELETE'
|
|
417
|
-
| 'GDPR_DELETE'
|
|
418
|
-
| 'MERGE'
|
|
419
|
-
| 'REMOVED_FROM_LIST'
|
|
420
|
-
| 'RESTORE'
|
|
421
|
-
| 'SNAPSHOT'
|
|
422
|
-
| 'UPDATE'
|
|
423
|
-
)[];
|
|
424
|
-
associatedObjectTypeIds: string[];
|
|
425
|
-
objectIds: number[];
|
|
426
|
-
objectTypeId: string;
|
|
427
|
-
portalId: number;
|
|
428
|
-
subscriptionType:
|
|
429
|
-
| 'APP_LIFECYCLE_EVENT'
|
|
430
|
-
| 'ASSOCIATION'
|
|
431
|
-
| 'EVENT'
|
|
432
|
-
| 'GDPR_PRIVACY_DELETION'
|
|
433
|
-
| 'LIST_MEMBERSHIP'
|
|
434
|
-
| 'OBJECT';
|
|
435
|
-
}
|
|
436
|
-
|
|
437
|
-
export interface BatchInputString {
|
|
438
|
-
/**
|
|
439
|
-
* An array of strings to be processed. This property is required.
|
|
440
|
-
*/
|
|
441
|
-
inputs: string[];
|
|
442
|
-
}
|
|
443
|
-
|
|
444
|
-
export interface BatchInputSubscriptionBatchUpdateRequest {
|
|
445
|
-
/**
|
|
446
|
-
* An array of SubscriptionBatchUpdateRequest objects, each representing a subscription to be updated. This property is required.
|
|
447
|
-
*/
|
|
448
|
-
inputs: Schemas.SubscriptionBatchUpdateRequest[];
|
|
449
|
-
}
|
|
450
|
-
|
|
451
|
-
export interface BatchResponseJournalFetchResponse {
|
|
452
|
-
/**
|
|
453
|
-
* The date and time when the batch operation was completed, in ISO 8601 format.
|
|
454
|
-
*/
|
|
455
|
-
completedAt: string;
|
|
456
|
-
/**
|
|
457
|
-
* A map of link names to associated URIs related to the batch operation.
|
|
458
|
-
*/
|
|
459
|
-
links?: Record<string, string>;
|
|
460
|
-
/**
|
|
461
|
-
* The date and time when the batch operation was requested, in ISO 8601 format.
|
|
462
|
-
*/
|
|
463
|
-
requestedAt?: string;
|
|
464
|
-
/**
|
|
465
|
-
* An array of results from the batch operation, each represented as a JournalFetchResponse object.
|
|
466
|
-
*/
|
|
467
|
-
results: Schemas.JournalFetchResponse[];
|
|
468
|
-
/**
|
|
469
|
-
* The date and time when the batch operation started, in ISO 8601 format.
|
|
470
|
-
*/
|
|
471
|
-
startedAt: string;
|
|
472
|
-
/**
|
|
473
|
-
* The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'.
|
|
474
|
-
*/
|
|
475
|
-
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
476
|
-
}
|
|
477
|
-
|
|
478
|
-
export interface BatchResponseSubscriptionResponse {
|
|
479
|
-
/**
|
|
480
|
-
* The date and time when the batch operation was completed, in ISO 8601 format.
|
|
481
|
-
*/
|
|
482
|
-
completedAt: string;
|
|
483
|
-
/**
|
|
484
|
-
* A map of link names to associated URIs providing additional information about the batch operation.
|
|
485
|
-
*/
|
|
486
|
-
links?: Record<string, string>;
|
|
487
|
-
/**
|
|
488
|
-
* The date and time when the batch operation was requested, in ISO 8601 format.
|
|
489
|
-
*/
|
|
490
|
-
requestedAt?: string;
|
|
491
|
-
/**
|
|
492
|
-
* An array containing the results of the batch operation, with each item representing an individual subscription response.
|
|
493
|
-
*/
|
|
494
|
-
results: Schemas.SubscriptionResponse[];
|
|
495
|
-
/**
|
|
496
|
-
* The date and time when the batch operation started, in ISO 8601 format.
|
|
497
|
-
*/
|
|
498
|
-
startedAt: string;
|
|
499
|
-
/**
|
|
500
|
-
* The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'.
|
|
501
|
-
*/
|
|
502
|
-
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
503
|
-
}
|
|
504
|
-
|
|
505
|
-
export interface CollectionResponseSubscriptionResponseNoPaging {
|
|
506
|
-
/**
|
|
507
|
-
* An array of SubscriptionResponse objects, each representing a subscription's details such as actions, appId, createdAt, and other relevant properties.
|
|
508
|
-
*/
|
|
509
|
-
results: Schemas.SubscriptionResponse_1[];
|
|
510
|
-
}
|
|
511
|
-
|
|
512
|
-
export interface Condition {
|
|
513
|
-
/**
|
|
514
|
-
* A string indicating the type of filter being applied. Valid value is 'CRM_OBJECT_PROPERTY'.
|
|
515
|
-
*/
|
|
516
|
-
filterType: 'CRM_OBJECT_PROPERTY';
|
|
517
|
-
/**
|
|
518
|
-
* A string specifying the operation to be performed in the condition. Valid values include 'EQ', 'N_EQ', 'LT', 'GT', 'LTE', 'GTE', 'CONTAINS', 'STARTS_WITH', 'ENDS_WITH', 'IN', 'NOT_IN', 'IS_EMPTY', and 'IS_NOT_EMPTY'.
|
|
519
|
-
*/
|
|
520
|
-
operator:
|
|
521
|
-
| 'CONTAINS'
|
|
522
|
-
| 'ENDS_WITH'
|
|
523
|
-
| 'EQ'
|
|
524
|
-
| 'GT'
|
|
525
|
-
| 'GTE'
|
|
526
|
-
| 'IN'
|
|
527
|
-
| 'IS_EMPTY'
|
|
528
|
-
| 'IS_NOT_EMPTY'
|
|
529
|
-
| 'LT'
|
|
530
|
-
| 'LTE'
|
|
531
|
-
| 'N_EQ'
|
|
532
|
-
| 'NOT_IN'
|
|
533
|
-
| 'STARTS_WITH';
|
|
534
|
-
/**
|
|
535
|
-
* A string representing the specific property of the CRM object that the condition applies to.
|
|
536
|
-
*/
|
|
537
|
-
property: string;
|
|
538
|
-
/**
|
|
539
|
-
* A string representing the value to be compared against the specified property when using single-value operators.
|
|
540
|
-
*/
|
|
541
|
-
value?: string;
|
|
542
|
-
/**
|
|
543
|
-
* An array of strings used to specify multiple values for comparison when using operators that support multiple values, such as 'IN' or 'NOT_IN'.
|
|
544
|
-
*/
|
|
545
|
-
values?: string[];
|
|
546
|
-
}
|
|
547
|
-
|
|
548
|
-
export interface CrmObjectSnapshotBatchRequest {
|
|
549
|
-
/**
|
|
550
|
-
* An array of CrmObjectSnapshotRequest objects, each representing a request to create a snapshot for a specific CRM object. This property is required.
|
|
551
|
-
*/
|
|
552
|
-
snapshotRequests: Schemas.CrmObjectSnapshotRequest[];
|
|
553
|
-
}
|
|
554
|
-
|
|
555
|
-
export interface CrmObjectSnapshotBatchResponse {
|
|
556
|
-
/**
|
|
557
|
-
* An array of CrmObjectSnapshotResponse objects, each representing the result of a snapshot operation for a specific CRM object. This property is required.
|
|
558
|
-
*/
|
|
559
|
-
snapshotResponses: Schemas.CrmObjectSnapshotResponse[];
|
|
560
|
-
}
|
|
561
|
-
|
|
562
|
-
export interface CrmObjectSnapshotRequest {
|
|
563
|
-
/**
|
|
564
|
-
* An integer representing the unique identifier of the CRM object for which the snapshot is requested.
|
|
565
|
-
*/
|
|
566
|
-
objectId: number;
|
|
567
|
-
/**
|
|
568
|
-
* A string representing the type identifier of the CRM object, specifying what kind of object it is within HubSpot.
|
|
569
|
-
*/
|
|
570
|
-
objectTypeId: string;
|
|
571
|
-
/**
|
|
572
|
-
* An integer representing the unique identifier of the HubSpot account (portal) where the CRM object resides.
|
|
573
|
-
*/
|
|
574
|
-
portalId: number;
|
|
575
|
-
/**
|
|
576
|
-
* An array of strings, each representing a property of the CRM object that should be included in the snapshot.
|
|
577
|
-
*/
|
|
578
|
-
properties: string[];
|
|
579
|
-
}
|
|
580
|
-
|
|
581
|
-
export interface CrmObjectSnapshotResponse {
|
|
582
|
-
/**
|
|
583
|
-
* An integer representing the unique identifier of the CRM object for which the snapshot is taken.
|
|
584
|
-
*/
|
|
585
|
-
objectId: number;
|
|
586
|
-
/**
|
|
587
|
-
* A string indicating the type of the CRM object, such as contact, company, or deal.
|
|
588
|
-
*/
|
|
589
|
-
objectTypeId: string;
|
|
590
|
-
/**
|
|
591
|
-
* An integer representing the unique identifier of the HubSpot portal associated with the CRM object.
|
|
592
|
-
*/
|
|
593
|
-
portalId: number;
|
|
594
|
-
/**
|
|
595
|
-
* A UUID string representing the status identifier of the snapshot request, indicating the current state of the snapshot process.
|
|
596
|
-
*/
|
|
597
|
-
snapshotStatusId: string;
|
|
598
|
-
}
|
|
599
|
-
|
|
600
|
-
/**
|
|
601
|
-
* Defines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against.
|
|
602
|
-
*/
|
|
603
|
-
export interface Filter {
|
|
604
|
-
/**
|
|
605
|
-
* An array of conditions that define the criteria for the filter. Each condition specifies a property, an operator, and optionally a value or values.
|
|
606
|
-
*/
|
|
607
|
-
conditions: Schemas.Condition[];
|
|
608
|
-
}
|
|
609
|
-
|
|
610
|
-
export interface FilterCreateRequest {
|
|
611
|
-
filter: Schemas.Filter;
|
|
612
|
-
/**
|
|
613
|
-
* The unique identifier of the subscription to which the filter will be applied. It is an integer formatted as int64.
|
|
614
|
-
*/
|
|
615
|
-
subscriptionId: number;
|
|
616
|
-
}
|
|
617
|
-
|
|
618
|
-
export interface FilterCreateResponse {
|
|
619
|
-
/**
|
|
620
|
-
* The unique identifier for the created filter. It is an integer formatted as int64.
|
|
621
|
-
*/
|
|
622
|
-
filterId: number;
|
|
623
|
-
}
|
|
624
|
-
|
|
625
|
-
export interface FilterResponse {
|
|
626
|
-
/**
|
|
627
|
-
* A Unix timestamp in milliseconds indicating when the filter was created.
|
|
628
|
-
*/
|
|
629
|
-
createdAt: number;
|
|
630
|
-
filter: Schemas.Filter;
|
|
631
|
-
/**
|
|
632
|
-
* The unique identifier for the filter. It is an integer in int64 format.
|
|
633
|
-
*/
|
|
634
|
-
id: number;
|
|
635
|
-
}
|
|
636
|
-
|
|
637
|
-
export interface GdprPrivacyDeletionSubscriptionUpsertRequest {
|
|
638
|
-
actions: (
|
|
639
|
-
| 'ADDED_TO_LIST'
|
|
640
|
-
| 'APP_INSTALL'
|
|
641
|
-
| 'APP_UNINSTALL'
|
|
642
|
-
| 'ASSOCIATION_ADDED'
|
|
643
|
-
| 'ASSOCIATION_REMOVED'
|
|
644
|
-
| 'CREATE'
|
|
645
|
-
| 'DELETE'
|
|
646
|
-
| 'GDPR_DELETE'
|
|
647
|
-
| 'MERGE'
|
|
648
|
-
| 'REMOVED_FROM_LIST'
|
|
649
|
-
| 'RESTORE'
|
|
650
|
-
| 'SNAPSHOT'
|
|
651
|
-
| 'UPDATE'
|
|
652
|
-
)[];
|
|
653
|
-
objectTypeId: string;
|
|
654
|
-
portalId: number;
|
|
655
|
-
subscriptionType:
|
|
656
|
-
| 'APP_LIFECYCLE_EVENT'
|
|
657
|
-
| 'ASSOCIATION'
|
|
658
|
-
| 'EVENT'
|
|
659
|
-
| 'GDPR_PRIVACY_DELETION'
|
|
660
|
-
| 'LIST_MEMBERSHIP'
|
|
661
|
-
| 'OBJECT';
|
|
662
|
-
}
|
|
663
|
-
|
|
664
|
-
export interface JournalFetchResponse {
|
|
665
|
-
/**
|
|
666
|
-
* The unique identifier for the current offset of the journal entry, formatted as a UUID.
|
|
667
|
-
*/
|
|
668
|
-
currentOffset: string;
|
|
669
|
-
/**
|
|
670
|
-
* The date and time when the URL will expire, in ISO 8601 format.
|
|
671
|
-
*/
|
|
672
|
-
expiresAt: string;
|
|
673
|
-
/**
|
|
674
|
-
* The URL where the journal entry can be accessed. It is a string.
|
|
675
|
-
*/
|
|
676
|
-
url: string;
|
|
677
|
-
}
|
|
678
|
-
|
|
679
|
-
export interface ListMembershipSubscriptionUpsertRequest {
|
|
680
|
-
actions: (
|
|
681
|
-
| 'ADDED_TO_LIST'
|
|
682
|
-
| 'APP_INSTALL'
|
|
683
|
-
| 'APP_UNINSTALL'
|
|
684
|
-
| 'ASSOCIATION_ADDED'
|
|
685
|
-
| 'ASSOCIATION_REMOVED'
|
|
686
|
-
| 'CREATE'
|
|
687
|
-
| 'DELETE'
|
|
688
|
-
| 'GDPR_DELETE'
|
|
689
|
-
| 'MERGE'
|
|
690
|
-
| 'REMOVED_FROM_LIST'
|
|
691
|
-
| 'RESTORE'
|
|
692
|
-
| 'SNAPSHOT'
|
|
693
|
-
| 'UPDATE'
|
|
694
|
-
)[];
|
|
695
|
-
listIds: number[];
|
|
696
|
-
objectIds: number[];
|
|
697
|
-
portalId: number;
|
|
698
|
-
subscriptionType:
|
|
699
|
-
| 'APP_LIFECYCLE_EVENT'
|
|
700
|
-
| 'ASSOCIATION'
|
|
701
|
-
| 'EVENT'
|
|
702
|
-
| 'GDPR_PRIVACY_DELETION'
|
|
703
|
-
| 'LIST_MEMBERSHIP'
|
|
704
|
-
| 'OBJECT';
|
|
705
|
-
}
|
|
706
|
-
|
|
707
|
-
export interface ObjectSubscriptionUpsertRequest {
|
|
708
|
-
actions: (
|
|
709
|
-
| 'ADDED_TO_LIST'
|
|
710
|
-
| 'APP_INSTALL'
|
|
711
|
-
| 'APP_UNINSTALL'
|
|
712
|
-
| 'ASSOCIATION_ADDED'
|
|
713
|
-
| 'ASSOCIATION_REMOVED'
|
|
714
|
-
| 'CREATE'
|
|
715
|
-
| 'DELETE'
|
|
716
|
-
| 'GDPR_DELETE'
|
|
717
|
-
| 'MERGE'
|
|
718
|
-
| 'REMOVED_FROM_LIST'
|
|
719
|
-
| 'RESTORE'
|
|
720
|
-
| 'SNAPSHOT'
|
|
721
|
-
| 'UPDATE'
|
|
722
|
-
)[];
|
|
723
|
-
objectIds: number[];
|
|
724
|
-
objectTypeId: string;
|
|
725
|
-
portalId: number;
|
|
726
|
-
properties: string[];
|
|
727
|
-
subscriptionType:
|
|
728
|
-
| 'APP_LIFECYCLE_EVENT'
|
|
729
|
-
| 'ASSOCIATION'
|
|
730
|
-
| 'EVENT'
|
|
731
|
-
| 'GDPR_PRIVACY_DELETION'
|
|
732
|
-
| 'LIST_MEMBERSHIP'
|
|
733
|
-
| 'OBJECT';
|
|
734
|
-
}
|
|
735
|
-
|
|
736
|
-
export interface SettingsChangeRequest {
|
|
737
|
-
/**
|
|
738
|
-
* The URL to which webhook events will be sent. It is a string.
|
|
739
|
-
*/
|
|
740
|
-
targetUrl: string;
|
|
741
|
-
throttling: Schemas.ThrottlingSettings;
|
|
742
|
-
}
|
|
743
|
-
|
|
744
|
-
export interface SettingsResponse {
|
|
745
|
-
/**
|
|
746
|
-
* The date and time when the webhook settings were created, in ISO 8601 format.
|
|
747
|
-
*/
|
|
748
|
-
createdAt: string;
|
|
749
|
-
/**
|
|
750
|
-
* The URL to which the webhook events will be sent. It is a string.
|
|
751
|
-
*/
|
|
752
|
-
targetUrl: string;
|
|
753
|
-
throttling: Schemas.ThrottlingSettings;
|
|
754
|
-
/**
|
|
755
|
-
* The date and time when the webhook settings were last updated, in ISO 8601 format.
|
|
756
|
-
*/
|
|
757
|
-
updatedAt?: string;
|
|
758
|
-
}
|
|
759
|
-
|
|
760
|
-
export interface SnapshotStatusResponse {
|
|
761
|
-
/**
|
|
762
|
-
* The timestamp indicating when the snapshot operation was completed, represented as a Unix timestamp in milliseconds.
|
|
763
|
-
*/
|
|
764
|
-
completedAt?: number;
|
|
765
|
-
/**
|
|
766
|
-
* A code representing the error that occurred, if any. Possible values are 'TIMEOUT', 'VALIDATION_ERROR', 'INTERNAL_ERROR', and 'PERMISSION_DENIED'.
|
|
767
|
-
*/
|
|
768
|
-
errorCode?:
|
|
769
|
-
| 'INTERNAL_ERROR'
|
|
770
|
-
| 'PERMISSION_DENIED'
|
|
771
|
-
| 'TIMEOUT'
|
|
772
|
-
| 'VALIDATION_ERROR';
|
|
773
|
-
/**
|
|
774
|
-
* The unique identifier for the snapshot operation, represented as a UUID.
|
|
775
|
-
*/
|
|
776
|
-
id: string;
|
|
777
|
-
/**
|
|
778
|
-
* The timestamp indicating when the snapshot operation was initiated, represented as a Unix timestamp in milliseconds.
|
|
779
|
-
*/
|
|
780
|
-
initiatedAt: number;
|
|
781
|
-
/**
|
|
782
|
-
* A descriptive message providing additional information about the snapshot operation or error.
|
|
783
|
-
*/
|
|
784
|
-
message?: string;
|
|
785
|
-
/**
|
|
786
|
-
* The current status of the snapshot. Valid values include 'PENDING', 'IN_PROGRESS', 'COMPLETED', 'FAILED', and 'EXPIRED'.
|
|
787
|
-
*/
|
|
788
|
-
status: 'COMPLETED' | 'EXPIRED' | 'FAILED' | 'IN_PROGRESS' | 'PENDING';
|
|
789
|
-
}
|
|
790
|
-
|
|
791
|
-
export interface SubscriptionBatchUpdateRequest {
|
|
792
|
-
/**
|
|
793
|
-
* A boolean indicating whether the subscription is active.
|
|
794
|
-
*/
|
|
795
|
-
active: boolean;
|
|
796
|
-
/**
|
|
797
|
-
* The unique identifier for the subscription. It is an integer.
|
|
798
|
-
*/
|
|
799
|
-
id: number;
|
|
800
|
-
}
|
|
801
|
-
|
|
802
|
-
export interface SubscriptionCreateRequest {
|
|
803
|
-
/**
|
|
804
|
-
* A boolean indicating whether the subscription is active.
|
|
805
|
-
*/
|
|
806
|
-
active: boolean;
|
|
807
|
-
/**
|
|
808
|
-
* A string representing the type of event to subscribe to. Valid values include various property changes, creations, deletions, merges, restorations, association changes, and event completions.
|
|
809
|
-
*/
|
|
810
|
-
eventType:
|
|
811
|
-
| 'company.associationChange'
|
|
812
|
-
| 'company.creation'
|
|
813
|
-
| 'company.deletion'
|
|
814
|
-
| 'company.merge'
|
|
815
|
-
| 'company.propertyChange'
|
|
816
|
-
| 'company.restore'
|
|
817
|
-
| 'contact.associationChange'
|
|
818
|
-
| 'contact.creation'
|
|
819
|
-
| 'contact.deletion'
|
|
820
|
-
| 'contact.merge'
|
|
821
|
-
| 'contact.privacyDeletion'
|
|
822
|
-
| 'contact.propertyChange'
|
|
823
|
-
| 'contact.restore'
|
|
824
|
-
| 'conversation.creation'
|
|
825
|
-
| 'conversation.deletion'
|
|
826
|
-
| 'conversation.newMessage'
|
|
827
|
-
| 'conversation.privacyDeletion'
|
|
828
|
-
| 'conversation.propertyChange'
|
|
829
|
-
| 'deal.associationChange'
|
|
830
|
-
| 'deal.creation'
|
|
831
|
-
| 'deal.deletion'
|
|
832
|
-
| 'deal.merge'
|
|
833
|
-
| 'deal.propertyChange'
|
|
834
|
-
| 'deal.restore'
|
|
835
|
-
| 'event.completed'
|
|
836
|
-
| 'line_item.associationChange'
|
|
837
|
-
| 'line_item.creation'
|
|
838
|
-
| 'line_item.deletion'
|
|
839
|
-
| 'line_item.merge'
|
|
840
|
-
| 'line_item.propertyChange'
|
|
841
|
-
| 'line_item.restore'
|
|
842
|
-
| 'object.associationChange'
|
|
843
|
-
| 'object.creation'
|
|
844
|
-
| 'object.deletion'
|
|
845
|
-
| 'object.merge'
|
|
846
|
-
| 'object.propertyChange'
|
|
847
|
-
| 'object.restore'
|
|
848
|
-
| 'product.creation'
|
|
849
|
-
| 'product.deletion'
|
|
850
|
-
| 'product.merge'
|
|
851
|
-
| 'product.propertyChange'
|
|
852
|
-
| 'product.restore'
|
|
853
|
-
| 'ticket.associationChange'
|
|
854
|
-
| 'ticket.creation'
|
|
855
|
-
| 'ticket.deletion'
|
|
856
|
-
| 'ticket.merge'
|
|
857
|
-
| 'ticket.propertyChange'
|
|
858
|
-
| 'ticket.restore';
|
|
859
|
-
/**
|
|
860
|
-
* A string providing a human-readable name for the event type.
|
|
861
|
-
*/
|
|
862
|
-
eventTypeName?: string;
|
|
863
|
-
/**
|
|
864
|
-
* A string representing the ID of the object type associated with the subscription.
|
|
865
|
-
*/
|
|
866
|
-
objectTypeId?: string;
|
|
867
|
-
/**
|
|
868
|
-
* A string indicating the specific property name related to the event type, if applicable.
|
|
869
|
-
*/
|
|
870
|
-
propertyName?: string;
|
|
871
|
-
}
|
|
872
|
-
|
|
873
|
-
export interface SubscriptionListResponse {
|
|
874
|
-
/**
|
|
875
|
-
* An array of subscription responses, each detailing a specific subscription's properties and status.
|
|
876
|
-
*/
|
|
877
|
-
results: Schemas.SubscriptionResponse[];
|
|
878
|
-
}
|
|
879
|
-
|
|
880
|
-
export interface SubscriptionPatchRequest {
|
|
881
|
-
/**
|
|
882
|
-
* A boolean indicating whether the subscription is active. If true, the subscription is active; if false, it is inactive.
|
|
883
|
-
*/
|
|
884
|
-
active?: boolean;
|
|
885
|
-
}
|
|
886
|
-
|
|
887
|
-
export interface SubscriptionResponse {
|
|
888
|
-
/**
|
|
889
|
-
* A boolean indicating whether the subscription is currently active.
|
|
890
|
-
*/
|
|
891
|
-
active: boolean;
|
|
892
|
-
/**
|
|
893
|
-
* The date and time when the subscription was created, in ISO 8601 format.
|
|
894
|
-
*/
|
|
895
|
-
createdAt: string;
|
|
896
|
-
/**
|
|
897
|
-
* The type of event that triggers the subscription. Valid values include various property changes, creations, deletions, merges, restores, and association changes for different HubSpot objects.
|
|
898
|
-
*/
|
|
899
|
-
eventType:
|
|
900
|
-
| 'company.associationChange'
|
|
901
|
-
| 'company.creation'
|
|
902
|
-
| 'company.deletion'
|
|
903
|
-
| 'company.merge'
|
|
904
|
-
| 'company.propertyChange'
|
|
905
|
-
| 'company.restore'
|
|
906
|
-
| 'contact.associationChange'
|
|
907
|
-
| 'contact.creation'
|
|
908
|
-
| 'contact.deletion'
|
|
909
|
-
| 'contact.merge'
|
|
910
|
-
| 'contact.privacyDeletion'
|
|
911
|
-
| 'contact.propertyChange'
|
|
912
|
-
| 'contact.restore'
|
|
913
|
-
| 'conversation.creation'
|
|
914
|
-
| 'conversation.deletion'
|
|
915
|
-
| 'conversation.newMessage'
|
|
916
|
-
| 'conversation.privacyDeletion'
|
|
917
|
-
| 'conversation.propertyChange'
|
|
918
|
-
| 'deal.associationChange'
|
|
919
|
-
| 'deal.creation'
|
|
920
|
-
| 'deal.deletion'
|
|
921
|
-
| 'deal.merge'
|
|
922
|
-
| 'deal.propertyChange'
|
|
923
|
-
| 'deal.restore'
|
|
924
|
-
| 'event.completed'
|
|
925
|
-
| 'line_item.associationChange'
|
|
926
|
-
| 'line_item.creation'
|
|
927
|
-
| 'line_item.deletion'
|
|
928
|
-
| 'line_item.merge'
|
|
929
|
-
| 'line_item.propertyChange'
|
|
930
|
-
| 'line_item.restore'
|
|
931
|
-
| 'object.associationChange'
|
|
932
|
-
| 'object.creation'
|
|
933
|
-
| 'object.deletion'
|
|
934
|
-
| 'object.merge'
|
|
935
|
-
| 'object.propertyChange'
|
|
936
|
-
| 'object.restore'
|
|
937
|
-
| 'product.creation'
|
|
938
|
-
| 'product.deletion'
|
|
939
|
-
| 'product.merge'
|
|
940
|
-
| 'product.propertyChange'
|
|
941
|
-
| 'product.restore'
|
|
942
|
-
| 'ticket.associationChange'
|
|
943
|
-
| 'ticket.creation'
|
|
944
|
-
| 'ticket.deletion'
|
|
945
|
-
| 'ticket.merge'
|
|
946
|
-
| 'ticket.propertyChange'
|
|
947
|
-
| 'ticket.restore';
|
|
948
|
-
/**
|
|
949
|
-
* The name of the event type for the subscription.
|
|
950
|
-
*/
|
|
951
|
-
eventTypeName?: string;
|
|
952
|
-
/**
|
|
953
|
-
* The unique identifier for the subscription. It is an integer formatted as int64.
|
|
954
|
-
*/
|
|
955
|
-
id: string;
|
|
956
|
-
/**
|
|
957
|
-
* The identifier for the object type associated with the subscription. It is a string.
|
|
958
|
-
*/
|
|
959
|
-
objectTypeId?: string;
|
|
960
|
-
/**
|
|
961
|
-
* The name of the property associated with the subscription event, if applicable.
|
|
962
|
-
*/
|
|
963
|
-
propertyName?: string;
|
|
964
|
-
/**
|
|
965
|
-
* The date and time when the subscription was last updated, in ISO 8601 format.
|
|
966
|
-
*/
|
|
967
|
-
updatedAt?: string;
|
|
968
|
-
}
|
|
969
|
-
|
|
970
|
-
export interface SubscriptionResponse_1 {
|
|
971
|
-
/**
|
|
972
|
-
* An object containing action overrides, where each key is an action and the value is an ActionOverrideRequest object.
|
|
973
|
-
*/
|
|
974
|
-
actionOverrides?: Record<string, Schemas.ActionOverrideRequest>;
|
|
975
|
-
/**
|
|
976
|
-
* A list of actions that trigger the subscription. Possible values include 'CREATE', 'UPDATE', 'DELETE', 'MERGE', 'RESTORE', 'ASSOCIATION_ADDED', 'ASSOCIATION_REMOVED', 'SNAPSHOT', 'APP_INSTALL', 'APP_UNINSTALL', 'ADDED_TO_LIST', 'REMOVED_FROM_LIST', and 'GDPR_DELETE'.
|
|
977
|
-
*/
|
|
978
|
-
actions: (
|
|
979
|
-
| 'ADDED_TO_LIST'
|
|
980
|
-
| 'APP_INSTALL'
|
|
981
|
-
| 'APP_UNINSTALL'
|
|
982
|
-
| 'ASSOCIATION_ADDED'
|
|
983
|
-
| 'ASSOCIATION_REMOVED'
|
|
984
|
-
| 'CREATE'
|
|
985
|
-
| 'DELETE'
|
|
986
|
-
| 'GDPR_DELETE'
|
|
987
|
-
| 'MERGE'
|
|
988
|
-
| 'REMOVED_FROM_LIST'
|
|
989
|
-
| 'RESTORE'
|
|
990
|
-
| 'SNAPSHOT'
|
|
991
|
-
| 'UPDATE'
|
|
992
|
-
)[];
|
|
993
|
-
/**
|
|
994
|
-
* The unique identifier for the app associated with the subscription. It is an integer formatted as int64.
|
|
995
|
-
*/
|
|
996
|
-
appId: number;
|
|
997
|
-
/**
|
|
998
|
-
* A list of associated object type IDs. Each ID is a string.
|
|
999
|
-
*/
|
|
1000
|
-
associatedObjectTypeIds?: string[];
|
|
1001
|
-
/**
|
|
1002
|
-
* The date and time when the subscription was created, in ISO 8601 format.
|
|
1003
|
-
*/
|
|
1004
|
-
createdAt: string;
|
|
1005
|
-
/**
|
|
1006
|
-
* The ID of the user who created the subscription. It is an integer formatted as int64.
|
|
1007
|
-
*/
|
|
1008
|
-
createdBy?: number;
|
|
1009
|
-
/**
|
|
1010
|
-
* The date and time when the subscription was deleted, in ISO 8601 format, if applicable.
|
|
1011
|
-
*/
|
|
1012
|
-
deletedAt?: string;
|
|
1013
|
-
/**
|
|
1014
|
-
* The unique identifier for the subscription. It is an integer formatted as int64.
|
|
1015
|
-
*/
|
|
1016
|
-
id: number;
|
|
1017
|
-
/**
|
|
1018
|
-
* A list of list IDs associated with the subscription. Each ID is an integer formatted as int64.
|
|
1019
|
-
*/
|
|
1020
|
-
listIds?: number[];
|
|
1021
|
-
/**
|
|
1022
|
-
* A list of object IDs associated with the subscription. Each ID is an integer formatted as int64.
|
|
1023
|
-
*/
|
|
1024
|
-
objectIds?: number[];
|
|
1025
|
-
/**
|
|
1026
|
-
* The identifier for the object type associated with the subscription. It is a string.
|
|
1027
|
-
*/
|
|
1028
|
-
objectTypeId: string;
|
|
1029
|
-
/**
|
|
1030
|
-
* The unique identifier for the portal associated with the subscription. It is an integer formatted as int64.
|
|
1031
|
-
*/
|
|
1032
|
-
portalId?: number;
|
|
1033
|
-
/**
|
|
1034
|
-
* A list of property names associated with the subscription. Each property is a string.
|
|
1035
|
-
*/
|
|
1036
|
-
properties?: string[];
|
|
1037
|
-
/**
|
|
1038
|
-
* The type of subscription, which can be one of the following: 'OBJECT', 'ASSOCIATION', 'EVENT', 'APP_LIFECYCLE_EVENT', 'LIST_MEMBERSHIP', or 'GDPR_PRIVACY_DELETION'.
|
|
1039
|
-
*/
|
|
1040
|
-
subscriptionType:
|
|
1041
|
-
| 'APP_LIFECYCLE_EVENT'
|
|
1042
|
-
| 'ASSOCIATION'
|
|
1043
|
-
| 'EVENT'
|
|
1044
|
-
| 'GDPR_PRIVACY_DELETION'
|
|
1045
|
-
| 'LIST_MEMBERSHIP'
|
|
1046
|
-
| 'OBJECT';
|
|
1047
|
-
/**
|
|
1048
|
-
* The date and time when the subscription was last updated, in ISO 8601 format.
|
|
1049
|
-
*/
|
|
1050
|
-
updatedAt: string;
|
|
1051
|
-
}
|
|
1052
|
-
|
|
1053
|
-
export type SubscriptionUpsertRequest =
|
|
1054
|
-
| Schemas.ObjectSubscriptionUpsertRequest
|
|
1055
|
-
| Schemas.AssociationSubscriptionUpsertRequest
|
|
1056
|
-
| Schemas.AppLifecycleEventSubscriptionUpsertRequest
|
|
1057
|
-
| Schemas.ListMembershipSubscriptionUpsertRequest
|
|
1058
|
-
| Schemas.GdprPrivacyDeletionSubscriptionUpsertRequest;
|
|
1059
|
-
|
|
1060
|
-
export interface ThrottlingSettings {
|
|
1061
|
-
/**
|
|
1062
|
-
* The maximum number of concurrent requests allowed. This is an integer value.
|
|
1063
|
-
*/
|
|
1064
|
-
maxConcurrentRequests: number;
|
|
1065
|
-
}
|
|
1057
|
+
export type UpdateEventSubscriptionOutput =
|
|
1058
|
+
WebhooksSchemas.SubscriptionResponse;
|
|
1059
|
+
|
|
1060
|
+
export interface UpdateSettingsInput {
|
|
1061
|
+
/**
|
|
1062
|
+
* The identifier for the app.
|
|
1063
|
+
*/
|
|
1064
|
+
appId: number;
|
|
1065
|
+
data: WebhooksSchemas.SettingsChangeRequest;
|
|
1066
1066
|
}
|
|
1067
1067
|
|
|
1068
|
+
export type UpdateSettingsOutput = WebhooksSchemas.SettingsResponse;
|
|
1068
1069
|
/**
|
|
1069
1070
|
* Usage example:
|
|
1070
1071
|
* ```ts
|
|
1071
|
-
* import {
|
|
1072
|
-
* client.send(
|
|
1072
|
+
* import { webhooksWebhooks } from '@hubspot/api-client-core';
|
|
1073
|
+
* client.send(webhooksWebhooks.createBatchEventSubscriptions(input));
|
|
1073
1074
|
* ```
|
|
1074
1075
|
*/
|
|
1075
|
-
export interface
|
|
1076
|
+
export interface API {
|
|
1077
|
+
/**
|
|
1078
|
+
* Batch create event subscriptions
|
|
1079
|
+
* @apiPath /webhooks/2026-03/{appId}/subscriptions/batch/update
|
|
1080
|
+
* @apiMethod POST
|
|
1081
|
+
* @requiredScopes developers-write, private-apps-write
|
|
1082
|
+
*/
|
|
1083
|
+
createBatchEventSubscriptions: (
|
|
1084
|
+
input: CreateBatchEventSubscriptionsInput
|
|
1085
|
+
) => Operation<CreateBatchEventSubscriptionsOutput>;
|
|
1076
1086
|
/**
|
|
1077
1087
|
* Create Snapshot
|
|
1078
1088
|
* @apiPath /webhooks-journal/snapshots/2026-03/crm
|
|
@@ -1080,27 +1090,8 @@ export namespace Webhooks {
|
|
|
1080
1090
|
* @requiredScopes webhooks-journal-snapshot-management
|
|
1081
1091
|
*/
|
|
1082
1092
|
createCrmSnapshots: (
|
|
1083
|
-
input:
|
|
1084
|
-
) => Operation<
|
|
1085
|
-
/**
|
|
1086
|
-
* Create Filter
|
|
1087
|
-
* @apiPath /webhooks-journal/subscriptions/2026-03/filters
|
|
1088
|
-
* @apiMethod POST
|
|
1089
|
-
* @requiredScopes webhooks-journal-subscription-management
|
|
1090
|
-
*/
|
|
1091
|
-
createSubscriptionFilter: (
|
|
1092
|
-
input: Advanced.CreateSubscriptionFilterInput
|
|
1093
|
-
) => Operation<Advanced.CreateSubscriptionFilterOutput>;
|
|
1094
|
-
}
|
|
1095
|
-
|
|
1096
|
-
/**
|
|
1097
|
-
* Usage example:
|
|
1098
|
-
* ```ts
|
|
1099
|
-
* import { webhooks } from '@hubspot/api-client-core';
|
|
1100
|
-
* client.send(webhooks.basic.createEventSubscription(input));
|
|
1101
|
-
* ```
|
|
1102
|
-
*/
|
|
1103
|
-
export interface BasicAPI {
|
|
1093
|
+
input: CreateCrmSnapshotsInput
|
|
1094
|
+
) => Operation<CreateCrmSnapshotsOutput>;
|
|
1104
1095
|
/**
|
|
1105
1096
|
* Create an event subscription
|
|
1106
1097
|
* @apiPath /webhooks/2026-03/{appId}/subscriptions
|
|
@@ -1108,8 +1099,8 @@ export namespace Webhooks {
|
|
|
1108
1099
|
* @requiredScopes developers-write, private-apps-write
|
|
1109
1100
|
*/
|
|
1110
1101
|
createEventSubscription: (
|
|
1111
|
-
input:
|
|
1112
|
-
) => Operation<
|
|
1102
|
+
input: CreateEventSubscriptionInput
|
|
1103
|
+
) => Operation<CreateEventSubscriptionOutput>;
|
|
1113
1104
|
/**
|
|
1114
1105
|
* Create Subscription
|
|
1115
1106
|
* @apiPath /webhooks-journal/subscriptions/2026-03
|
|
@@ -1117,8 +1108,17 @@ export namespace Webhooks {
|
|
|
1117
1108
|
* @requiredScopes webhooks-journal-subscription-management
|
|
1118
1109
|
*/
|
|
1119
1110
|
createJournalSubscription: (
|
|
1120
|
-
input:
|
|
1121
|
-
) => Operation<
|
|
1111
|
+
input: CreateJournalSubscriptionInput
|
|
1112
|
+
) => Operation<CreateJournalSubscriptionOutput>;
|
|
1113
|
+
/**
|
|
1114
|
+
* Create Filter
|
|
1115
|
+
* @apiPath /webhooks-journal/subscriptions/2026-03/filters
|
|
1116
|
+
* @apiMethod POST
|
|
1117
|
+
* @requiredScopes webhooks-journal-subscription-management
|
|
1118
|
+
*/
|
|
1119
|
+
createSubscriptionFilter: (
|
|
1120
|
+
input: CreateSubscriptionFilterInput
|
|
1121
|
+
) => Operation<CreateSubscriptionFilterOutput>;
|
|
1122
1122
|
/**
|
|
1123
1123
|
* Delete event subscription
|
|
1124
1124
|
* @apiPath /webhooks/2026-03/{appId}/subscriptions/{subscriptionId}
|
|
@@ -1126,8 +1126,8 @@ export namespace Webhooks {
|
|
|
1126
1126
|
* @requiredScopes developers-write, private-apps-write
|
|
1127
1127
|
*/
|
|
1128
1128
|
deleteEventSubscription: (
|
|
1129
|
-
input:
|
|
1130
|
-
) => Operation<
|
|
1129
|
+
input: DeleteEventSubscriptionInput
|
|
1130
|
+
) => Operation<DeleteEventSubscriptionOutput>;
|
|
1131
1131
|
/**
|
|
1132
1132
|
* Delete subscription
|
|
1133
1133
|
* @apiPath /webhooks-journal/subscriptions/2026-03/{subscriptionId}
|
|
@@ -1135,8 +1135,8 @@ export namespace Webhooks {
|
|
|
1135
1135
|
* @requiredScopes webhooks-journal-subscription-management
|
|
1136
1136
|
*/
|
|
1137
1137
|
deleteJournalSubscription: (
|
|
1138
|
-
input:
|
|
1139
|
-
) => Operation<
|
|
1138
|
+
input: DeleteJournalSubscriptionInput
|
|
1139
|
+
) => Operation<DeleteJournalSubscriptionOutput>;
|
|
1140
1140
|
/**
|
|
1141
1141
|
* Delete subscription
|
|
1142
1142
|
* @apiPath /webhooks-journal/subscriptions/2026-03/portals/{portalId}
|
|
@@ -1144,8 +1144,8 @@ export namespace Webhooks {
|
|
|
1144
1144
|
* @requiredScopes webhooks-journal-subscription-management
|
|
1145
1145
|
*/
|
|
1146
1146
|
deleteJournalSubscriptionForPortal: (
|
|
1147
|
-
input:
|
|
1148
|
-
) => Operation<
|
|
1147
|
+
input: DeleteJournalSubscriptionForPortalInput
|
|
1148
|
+
) => Operation<DeleteJournalSubscriptionForPortalOutput>;
|
|
1149
1149
|
/**
|
|
1150
1150
|
* Delete webhook settings
|
|
1151
1151
|
* @apiPath /webhooks/2026-03/{appId}/settings
|
|
@@ -1153,8 +1153,8 @@ export namespace Webhooks {
|
|
|
1153
1153
|
* @requiredScopes developers-write, private-apps-write
|
|
1154
1154
|
*/
|
|
1155
1155
|
deleteSettings: (
|
|
1156
|
-
input:
|
|
1157
|
-
) => Operation<
|
|
1156
|
+
input: DeleteSettingsInput
|
|
1157
|
+
) => Operation<DeleteSettingsOutput>;
|
|
1158
1158
|
/**
|
|
1159
1159
|
* Delete filter
|
|
1160
1160
|
* @apiPath /webhooks-journal/subscriptions/2026-03/filters/{filterId}
|
|
@@ -1162,8 +1162,17 @@ export namespace Webhooks {
|
|
|
1162
1162
|
* @requiredScopes webhooks-journal-subscription-management
|
|
1163
1163
|
*/
|
|
1164
1164
|
deleteSubscriptionFilter: (
|
|
1165
|
-
input:
|
|
1166
|
-
) => Operation<
|
|
1165
|
+
input: DeleteSubscriptionFilterInput
|
|
1166
|
+
) => Operation<DeleteSubscriptionFilterOutput>;
|
|
1167
|
+
/**
|
|
1168
|
+
* Retrieve Batch
|
|
1169
|
+
* @apiPath /webhooks-journal/journal/2026-03/batch/earliest/{count}
|
|
1170
|
+
* @apiMethod GET
|
|
1171
|
+
* @requiredScopes webhooks-journal-data-access
|
|
1172
|
+
*/
|
|
1173
|
+
getEarliestJournalBatch: (
|
|
1174
|
+
input: GetEarliestJournalBatchInput
|
|
1175
|
+
) => Operation<GetEarliestJournalBatchOutput>;
|
|
1167
1176
|
/**
|
|
1168
1177
|
* Retrieve earliest
|
|
1169
1178
|
* @apiPath /webhooks-journal/journal/2026-03/earliest
|
|
@@ -1171,8 +1180,17 @@ export namespace Webhooks {
|
|
|
1171
1180
|
* @requiredScopes webhooks-journal-data-access
|
|
1172
1181
|
*/
|
|
1173
1182
|
getEarliestJournalEntry: (
|
|
1174
|
-
input?:
|
|
1175
|
-
) => Operation<
|
|
1183
|
+
input?: GetEarliestJournalEntryInput
|
|
1184
|
+
) => Operation<GetEarliestJournalEntryOutput>;
|
|
1185
|
+
/**
|
|
1186
|
+
* Retrieve Batch
|
|
1187
|
+
* @apiPath /webhooks-journal/journal-local/2026-03/batch/earliest/{count}
|
|
1188
|
+
* @apiMethod GET
|
|
1189
|
+
* @requiredScopes webhooks-journal-data-access
|
|
1190
|
+
*/
|
|
1191
|
+
getEarliestLocalJournalBatch: (
|
|
1192
|
+
input: GetEarliestLocalJournalBatchInput
|
|
1193
|
+
) => Operation<GetEarliestLocalJournalBatchOutput>;
|
|
1176
1194
|
/**
|
|
1177
1195
|
* Retrieve earliest
|
|
1178
1196
|
* @apiPath /webhooks-journal/journal-local/2026-03/earliest
|
|
@@ -1180,8 +1198,8 @@ export namespace Webhooks {
|
|
|
1180
1198
|
* @requiredScopes webhooks-journal-data-access
|
|
1181
1199
|
*/
|
|
1182
1200
|
getEarliestLocalJournalEntry: (
|
|
1183
|
-
input?:
|
|
1184
|
-
) => Operation<
|
|
1201
|
+
input?: GetEarliestLocalJournalEntryInput
|
|
1202
|
+
) => Operation<GetEarliestLocalJournalEntryOutput>;
|
|
1185
1203
|
/**
|
|
1186
1204
|
* Read an event subscription
|
|
1187
1205
|
* @apiPath /webhooks/2026-03/{appId}/subscriptions/{subscriptionId}
|
|
@@ -1189,8 +1207,26 @@ export namespace Webhooks {
|
|
|
1189
1207
|
* @requiredScopes developers-read, private-apps-read
|
|
1190
1208
|
*/
|
|
1191
1209
|
getEventSubscription: (
|
|
1192
|
-
input:
|
|
1193
|
-
) => Operation<
|
|
1210
|
+
input: GetEventSubscriptionInput
|
|
1211
|
+
) => Operation<GetEventSubscriptionOutput>;
|
|
1212
|
+
/**
|
|
1213
|
+
* Batch read
|
|
1214
|
+
* @apiPath /webhooks-journal/journal/2026-03/batch/read
|
|
1215
|
+
* @apiMethod POST
|
|
1216
|
+
* @requiredScopes webhooks-journal-data-access
|
|
1217
|
+
*/
|
|
1218
|
+
getJournalBatchByRequest: (
|
|
1219
|
+
input: GetJournalBatchByRequestInput
|
|
1220
|
+
) => Operation<GetJournalBatchByRequestOutput>;
|
|
1221
|
+
/**
|
|
1222
|
+
* Fetch Batch Entries
|
|
1223
|
+
* @apiPath /webhooks-journal/journal/2026-03/batch/{offset}/next/{count}
|
|
1224
|
+
* @apiMethod GET
|
|
1225
|
+
* @requiredScopes webhooks-journal-data-access
|
|
1226
|
+
*/
|
|
1227
|
+
getJournalBatchFromOffset: (
|
|
1228
|
+
input: GetJournalBatchFromOffsetInput
|
|
1229
|
+
) => Operation<GetJournalBatchFromOffsetOutput>;
|
|
1194
1230
|
/**
|
|
1195
1231
|
* Retrieve status
|
|
1196
1232
|
* @apiPath /webhooks-journal/journal/2026-03/status/{statusId}
|
|
@@ -1198,8 +1234,8 @@ export namespace Webhooks {
|
|
|
1198
1234
|
* @requiredScopes webhooks-journal-snapshot-management
|
|
1199
1235
|
*/
|
|
1200
1236
|
getJournalStatus: (
|
|
1201
|
-
input:
|
|
1202
|
-
) => Operation<
|
|
1237
|
+
input: GetJournalStatusInput
|
|
1238
|
+
) => Operation<GetJournalStatusOutput>;
|
|
1203
1239
|
/**
|
|
1204
1240
|
* Retrieve subscription
|
|
1205
1241
|
* @apiPath /webhooks-journal/subscriptions/2026-03/{subscriptionId}
|
|
@@ -1207,8 +1243,17 @@ export namespace Webhooks {
|
|
|
1207
1243
|
* @requiredScopes webhooks-journal-subscription-read
|
|
1208
1244
|
*/
|
|
1209
1245
|
getJournalSubscription: (
|
|
1210
|
-
input:
|
|
1211
|
-
) => Operation<
|
|
1246
|
+
input: GetJournalSubscriptionInput
|
|
1247
|
+
) => Operation<GetJournalSubscriptionOutput>;
|
|
1248
|
+
/**
|
|
1249
|
+
* Retrieve latest batch
|
|
1250
|
+
* @apiPath /webhooks-journal/journal/2026-03/batch/latest/{count}
|
|
1251
|
+
* @apiMethod GET
|
|
1252
|
+
* @requiredScopes webhooks-journal-data-access
|
|
1253
|
+
*/
|
|
1254
|
+
getLatestJournalBatch: (
|
|
1255
|
+
input: GetLatestJournalBatchInput
|
|
1256
|
+
) => Operation<GetLatestJournalBatchOutput>;
|
|
1212
1257
|
/**
|
|
1213
1258
|
* Retrieve latest journal
|
|
1214
1259
|
* @apiPath /webhooks-journal/journal/2026-03/latest
|
|
@@ -1216,8 +1261,17 @@ export namespace Webhooks {
|
|
|
1216
1261
|
* @requiredScopes webhooks-journal-data-access
|
|
1217
1262
|
*/
|
|
1218
1263
|
getLatestJournalEntry: (
|
|
1219
|
-
input?:
|
|
1220
|
-
) => Operation<
|
|
1264
|
+
input?: GetLatestJournalEntryInput
|
|
1265
|
+
) => Operation<GetLatestJournalEntryOutput>;
|
|
1266
|
+
/**
|
|
1267
|
+
* Retrieve latest batch
|
|
1268
|
+
* @apiPath /webhooks-journal/journal-local/2026-03/batch/latest/{count}
|
|
1269
|
+
* @apiMethod GET
|
|
1270
|
+
* @requiredScopes webhooks-journal-data-access
|
|
1271
|
+
*/
|
|
1272
|
+
getLatestLocalJournalBatch: (
|
|
1273
|
+
input: GetLatestLocalJournalBatchInput
|
|
1274
|
+
) => Operation<GetLatestLocalJournalBatchOutput>;
|
|
1221
1275
|
/**
|
|
1222
1276
|
* Retrieve latest journal
|
|
1223
1277
|
* @apiPath /webhooks-journal/journal-local/2026-03/latest
|
|
@@ -1225,8 +1279,26 @@ export namespace Webhooks {
|
|
|
1225
1279
|
* @requiredScopes webhooks-journal-data-access
|
|
1226
1280
|
*/
|
|
1227
1281
|
getLatestLocalJournalEntry: (
|
|
1228
|
-
input?:
|
|
1229
|
-
) => Operation<
|
|
1282
|
+
input?: GetLatestLocalJournalEntryInput
|
|
1283
|
+
) => Operation<GetLatestLocalJournalEntryOutput>;
|
|
1284
|
+
/**
|
|
1285
|
+
* Batch read
|
|
1286
|
+
* @apiPath /webhooks-journal/journal-local/2026-03/batch/read
|
|
1287
|
+
* @apiMethod POST
|
|
1288
|
+
* @requiredScopes webhooks-journal-data-access
|
|
1289
|
+
*/
|
|
1290
|
+
getLocalJournalBatchByRequest: (
|
|
1291
|
+
input: GetLocalJournalBatchByRequestInput
|
|
1292
|
+
) => Operation<GetLocalJournalBatchByRequestOutput>;
|
|
1293
|
+
/**
|
|
1294
|
+
* Retrieve batch
|
|
1295
|
+
* @apiPath /webhooks-journal/journal-local/2026-03/batch/{offset}/next/{count}
|
|
1296
|
+
* @apiMethod GET
|
|
1297
|
+
* @requiredScopes webhooks-journal-data-access
|
|
1298
|
+
*/
|
|
1299
|
+
getLocalJournalBatchFromOffset: (
|
|
1300
|
+
input: GetLocalJournalBatchFromOffsetInput
|
|
1301
|
+
) => Operation<GetLocalJournalBatchFromOffsetOutput>;
|
|
1230
1302
|
/**
|
|
1231
1303
|
* Retrieve status
|
|
1232
1304
|
* @apiPath /webhooks-journal/journal-local/2026-03/status/{statusId}
|
|
@@ -1234,8 +1306,8 @@ export namespace Webhooks {
|
|
|
1234
1306
|
* @requiredScopes webhooks-journal-snapshot-management
|
|
1235
1307
|
*/
|
|
1236
1308
|
getLocalJournalStatus: (
|
|
1237
|
-
input:
|
|
1238
|
-
) => Operation<
|
|
1309
|
+
input: GetLocalJournalStatusInput
|
|
1310
|
+
) => Operation<GetLocalJournalStatusOutput>;
|
|
1239
1311
|
/**
|
|
1240
1312
|
* Retrieve Next Batch
|
|
1241
1313
|
* @apiPath /webhooks-journal/journal/2026-03/offset/{offset}/next
|
|
@@ -1243,8 +1315,8 @@ export namespace Webhooks {
|
|
|
1243
1315
|
* @requiredScopes webhooks-journal-data-access
|
|
1244
1316
|
*/
|
|
1245
1317
|
getNextJournalEntries: (
|
|
1246
|
-
input:
|
|
1247
|
-
) => Operation<
|
|
1318
|
+
input: GetNextJournalEntriesInput
|
|
1319
|
+
) => Operation<GetNextJournalEntriesOutput>;
|
|
1248
1320
|
/**
|
|
1249
1321
|
* Retrieve Next Batch
|
|
1250
1322
|
* @apiPath /webhooks-journal/journal-local/2026-03/offset/{offset}/next
|
|
@@ -1252,17 +1324,15 @@ export namespace Webhooks {
|
|
|
1252
1324
|
* @requiredScopes webhooks-journal-data-access
|
|
1253
1325
|
*/
|
|
1254
1326
|
getNextLocalJournalEntries: (
|
|
1255
|
-
input:
|
|
1256
|
-
) => Operation<
|
|
1327
|
+
input: GetNextLocalJournalEntriesInput
|
|
1328
|
+
) => Operation<GetNextLocalJournalEntriesOutput>;
|
|
1257
1329
|
/**
|
|
1258
1330
|
* Read webhook settings
|
|
1259
1331
|
* @apiPath /webhooks/2026-03/{appId}/settings
|
|
1260
1332
|
* @apiMethod GET
|
|
1261
1333
|
* @requiredScopes developers-read, private-apps-read
|
|
1262
1334
|
*/
|
|
1263
|
-
getSettings: (
|
|
1264
|
-
input: Basic.GetSettingsInput
|
|
1265
|
-
) => Operation<Basic.GetSettingsOutput>;
|
|
1335
|
+
getSettings: (input: GetSettingsInput) => Operation<GetSettingsOutput>;
|
|
1266
1336
|
/**
|
|
1267
1337
|
* Retrieve filter
|
|
1268
1338
|
* @apiPath /webhooks-journal/subscriptions/2026-03/filters/{filterId}
|
|
@@ -1270,8 +1340,8 @@ export namespace Webhooks {
|
|
|
1270
1340
|
* @requiredScopes webhooks-journal-subscription-read
|
|
1271
1341
|
*/
|
|
1272
1342
|
getSubscriptionFilter: (
|
|
1273
|
-
input:
|
|
1274
|
-
) => Operation<
|
|
1343
|
+
input: GetSubscriptionFilterInput
|
|
1344
|
+
) => Operation<GetSubscriptionFilterOutput>;
|
|
1275
1345
|
/**
|
|
1276
1346
|
* Read event subscriptions
|
|
1277
1347
|
* @apiPath /webhooks/2026-03/{appId}/subscriptions
|
|
@@ -1279,15 +1349,15 @@ export namespace Webhooks {
|
|
|
1279
1349
|
* @requiredScopes developers-read, private-apps-read
|
|
1280
1350
|
*/
|
|
1281
1351
|
listEventSubscriptions: (
|
|
1282
|
-
input:
|
|
1283
|
-
) => Operation<
|
|
1352
|
+
input: ListEventSubscriptionsInput
|
|
1353
|
+
) => Operation<ListEventSubscriptionsOutput>;
|
|
1284
1354
|
/**
|
|
1285
1355
|
* List subscriptions
|
|
1286
1356
|
* @apiPath /webhooks-journal/subscriptions/2026-03
|
|
1287
1357
|
* @apiMethod GET
|
|
1288
1358
|
* @requiredScopes webhooks-journal-subscription-read
|
|
1289
1359
|
*/
|
|
1290
|
-
listJournalSubscriptions: () => Operation<
|
|
1360
|
+
listJournalSubscriptions: () => Operation<ListJournalSubscriptionsOutput>;
|
|
1291
1361
|
/**
|
|
1292
1362
|
* Retrieve Filters
|
|
1293
1363
|
* @apiPath /webhooks-journal/subscriptions/2026-03/filters/subscription/{subscriptionId}
|
|
@@ -1295,8 +1365,8 @@ export namespace Webhooks {
|
|
|
1295
1365
|
* @requiredScopes webhooks-journal-subscription-read
|
|
1296
1366
|
*/
|
|
1297
1367
|
listSubscriptionFilters: (
|
|
1298
|
-
input:
|
|
1299
|
-
) => Operation<
|
|
1368
|
+
input: ListSubscriptionFiltersInput
|
|
1369
|
+
) => Operation<ListSubscriptionFiltersOutput>;
|
|
1300
1370
|
/**
|
|
1301
1371
|
* Update an event subscription
|
|
1302
1372
|
* @apiPath /webhooks/2026-03/{appId}/subscriptions/{subscriptionId}
|
|
@@ -1304,8 +1374,8 @@ export namespace Webhooks {
|
|
|
1304
1374
|
* @requiredScopes developers-write, private-apps-write
|
|
1305
1375
|
*/
|
|
1306
1376
|
updateEventSubscription: (
|
|
1307
|
-
input:
|
|
1308
|
-
) => Operation<
|
|
1377
|
+
input: UpdateEventSubscriptionInput
|
|
1378
|
+
) => Operation<UpdateEventSubscriptionOutput>;
|
|
1309
1379
|
/**
|
|
1310
1380
|
* Update webhook settings
|
|
1311
1381
|
* @apiPath /webhooks/2026-03/{appId}/settings
|
|
@@ -1313,111 +1383,7 @@ export namespace Webhooks {
|
|
|
1313
1383
|
* @requiredScopes developers-write, private-apps-write
|
|
1314
1384
|
*/
|
|
1315
1385
|
updateSettings: (
|
|
1316
|
-
input:
|
|
1317
|
-
) => Operation<
|
|
1318
|
-
}
|
|
1319
|
-
|
|
1320
|
-
/**
|
|
1321
|
-
* Usage example:
|
|
1322
|
-
* ```ts
|
|
1323
|
-
* import { webhooks } from '@hubspot/api-client-core';
|
|
1324
|
-
* client.send(webhooks.batch.createBatchEventSubscriptions(input));
|
|
1325
|
-
* ```
|
|
1326
|
-
*/
|
|
1327
|
-
export interface BatchAPI {
|
|
1328
|
-
/**
|
|
1329
|
-
* Batch create event subscriptions
|
|
1330
|
-
* @apiPath /webhooks/2026-03/{appId}/subscriptions/batch/update
|
|
1331
|
-
* @apiMethod POST
|
|
1332
|
-
* @requiredScopes developers-write, private-apps-write
|
|
1333
|
-
*/
|
|
1334
|
-
createBatchEventSubscriptions: (
|
|
1335
|
-
input: Batch.CreateBatchEventSubscriptionsInput
|
|
1336
|
-
) => Operation<Batch.CreateBatchEventSubscriptionsOutput>;
|
|
1337
|
-
/**
|
|
1338
|
-
* Retrieve Batch
|
|
1339
|
-
* @apiPath /webhooks-journal/journal/2026-03/batch/earliest/{count}
|
|
1340
|
-
* @apiMethod GET
|
|
1341
|
-
* @requiredScopes webhooks-journal-data-access
|
|
1342
|
-
*/
|
|
1343
|
-
getEarliestJournalBatch: (
|
|
1344
|
-
input: Batch.GetEarliestJournalBatchInput
|
|
1345
|
-
) => Operation<Batch.GetEarliestJournalBatchOutput>;
|
|
1346
|
-
/**
|
|
1347
|
-
* Retrieve Batch
|
|
1348
|
-
* @apiPath /webhooks-journal/journal-local/2026-03/batch/earliest/{count}
|
|
1349
|
-
* @apiMethod GET
|
|
1350
|
-
* @requiredScopes webhooks-journal-data-access
|
|
1351
|
-
*/
|
|
1352
|
-
getEarliestLocalJournalBatch: (
|
|
1353
|
-
input: Batch.GetEarliestLocalJournalBatchInput
|
|
1354
|
-
) => Operation<Batch.GetEarliestLocalJournalBatchOutput>;
|
|
1355
|
-
/**
|
|
1356
|
-
* Batch read
|
|
1357
|
-
* @apiPath /webhooks-journal/journal/2026-03/batch/read
|
|
1358
|
-
* @apiMethod POST
|
|
1359
|
-
* @requiredScopes webhooks-journal-data-access
|
|
1360
|
-
*/
|
|
1361
|
-
getJournalBatchByRequest: (
|
|
1362
|
-
input: Batch.GetJournalBatchByRequestInput
|
|
1363
|
-
) => Operation<Batch.GetJournalBatchByRequestOutput>;
|
|
1364
|
-
/**
|
|
1365
|
-
* Fetch Batch Entries
|
|
1366
|
-
* @apiPath /webhooks-journal/journal/2026-03/batch/{offset}/next/{count}
|
|
1367
|
-
* @apiMethod GET
|
|
1368
|
-
* @requiredScopes webhooks-journal-data-access
|
|
1369
|
-
*/
|
|
1370
|
-
getJournalBatchFromOffset: (
|
|
1371
|
-
input: Batch.GetJournalBatchFromOffsetInput
|
|
1372
|
-
) => Operation<Batch.GetJournalBatchFromOffsetOutput>;
|
|
1373
|
-
/**
|
|
1374
|
-
* Retrieve latest batch
|
|
1375
|
-
* @apiPath /webhooks-journal/journal/2026-03/batch/latest/{count}
|
|
1376
|
-
* @apiMethod GET
|
|
1377
|
-
* @requiredScopes webhooks-journal-data-access
|
|
1378
|
-
*/
|
|
1379
|
-
getLatestJournalBatch: (
|
|
1380
|
-
input: Batch.GetLatestJournalBatchInput
|
|
1381
|
-
) => Operation<Batch.GetLatestJournalBatchOutput>;
|
|
1382
|
-
/**
|
|
1383
|
-
* Retrieve latest batch
|
|
1384
|
-
* @apiPath /webhooks-journal/journal-local/2026-03/batch/latest/{count}
|
|
1385
|
-
* @apiMethod GET
|
|
1386
|
-
* @requiredScopes webhooks-journal-data-access
|
|
1387
|
-
*/
|
|
1388
|
-
getLatestLocalJournalBatch: (
|
|
1389
|
-
input: Batch.GetLatestLocalJournalBatchInput
|
|
1390
|
-
) => Operation<Batch.GetLatestLocalJournalBatchOutput>;
|
|
1391
|
-
/**
|
|
1392
|
-
* Batch read
|
|
1393
|
-
* @apiPath /webhooks-journal/journal-local/2026-03/batch/read
|
|
1394
|
-
* @apiMethod POST
|
|
1395
|
-
* @requiredScopes webhooks-journal-data-access
|
|
1396
|
-
*/
|
|
1397
|
-
getLocalJournalBatchByRequest: (
|
|
1398
|
-
input: Batch.GetLocalJournalBatchByRequestInput
|
|
1399
|
-
) => Operation<Batch.GetLocalJournalBatchByRequestOutput>;
|
|
1400
|
-
/**
|
|
1401
|
-
* Retrieve batch
|
|
1402
|
-
* @apiPath /webhooks-journal/journal-local/2026-03/batch/{offset}/next/{count}
|
|
1403
|
-
* @apiMethod GET
|
|
1404
|
-
* @requiredScopes webhooks-journal-data-access
|
|
1405
|
-
*/
|
|
1406
|
-
getLocalJournalBatchFromOffset: (
|
|
1407
|
-
input: Batch.GetLocalJournalBatchFromOffsetInput
|
|
1408
|
-
) => Operation<Batch.GetLocalJournalBatchFromOffsetOutput>;
|
|
1409
|
-
}
|
|
1410
|
-
|
|
1411
|
-
/**
|
|
1412
|
-
* Usage example:
|
|
1413
|
-
* ```ts
|
|
1414
|
-
* import { webhooks } from '@hubspot/api-client-core';
|
|
1415
|
-
* client.send(webhooks.advanced.createCrmSnapshots(input));
|
|
1416
|
-
* ```
|
|
1417
|
-
*/
|
|
1418
|
-
export interface API {
|
|
1419
|
-
advanced: AdvancedAPI;
|
|
1420
|
-
basic: BasicAPI;
|
|
1421
|
-
batch: BatchAPI;
|
|
1386
|
+
input: UpdateSettingsInput
|
|
1387
|
+
) => Operation<UpdateSettingsOutput>;
|
|
1422
1388
|
}
|
|
1423
1389
|
}
|