@hubspot/app-connect-sdk 1.0.0-alpha.2 → 1.0.0-alpha.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.turbo/turbo-format$colon$check.log +1 -1
- package/.turbo/turbo-test.log +101 -57
- package/.turbo/turbo-tsdown.log +474 -469
- package/build/tsconfig.browser.tsbuildinfo +1 -1
- package/build/tsconfig.server.tsbuildinfo +1 -1
- package/dist/browser/{HubSpotAppConnect-BW45gyDs.js → HubSpotAppConnect-721kYr9d.js} +17 -23
- package/dist/browser/HubSpotAppConnect-721kYr9d.js.map +1 -0
- package/dist/browser/{create-vctOhpX9.js → create-DxEyGG-k.js} +336 -100
- package/dist/browser/create-DxEyGG-k.js.map +1 -0
- package/dist/browser/index.d.ts +2 -2
- package/dist/browser/index.js +1 -1
- package/dist/browser/react/lovable.d.ts +9 -2
- package/dist/browser/react/lovable.js +7 -4
- package/dist/browser/react/lovable.js.map +1 -1
- package/dist/browser/react.d.ts +2 -3
- package/dist/browser/react.js +1 -1
- package/dist/browser/{types-rTQw6A54.d.ts → types-C3wed8dU.d.ts} +52 -7
- package/dist/server/api-client-core/apis/account/account-info-types.generated.d.ts +73 -85
- package/dist/server/api-client-core/apis/account/account-info.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/account/account-info.generated.js +4 -3
- package/dist/server/api-client-core/apis/account/account-info.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/account/audit-logs-types.generated.d.ts +203 -215
- package/dist/server/api-client-core/apis/account/audit-logs.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/account/audit-logs.generated.js +4 -3
- package/dist/server/api-client-core/apis/account/audit-logs.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/auth/oauth-types.generated.d.ts +78 -90
- package/dist/server/api-client-core/apis/auth/oauth.generated.d.ts +1 -1
- package/dist/server/api-client-core/apis/auth/oauth.generated.js +3 -2
- package/dist/server/api-client-core/apis/auth/oauth.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/automation/actions-types.generated.d.ts +779 -794
- package/dist/server/api-client-core/apis/automation/actions.generated.d.ts +6 -3
- package/dist/server/api-client-core/apis/automation/actions.generated.js +101 -102
- package/dist/server/api-client-core/apis/automation/actions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/automation/sequences-types.generated.d.ts +370 -382
- package/dist/server/api-client-core/apis/automation/sequences.generated.d.ts +1 -1
- package/dist/server/api-client-core/apis/automation/sequences.generated.js +3 -2
- package/dist/server/api-client-core/apis/automation/sequences.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/business-units-types.generated.d.ts +43 -55
- package/dist/server/api-client-core/apis/business-units.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/business-units.generated.js +4 -3
- package/dist/server/api-client-core/apis/business-units.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/authors-types.generated.d.ts +420 -445
- package/dist/server/api-client-core/apis/cms/authors.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/cms/authors.generated.js +155 -158
- package/dist/server/api-client-core/apis/cms/authors.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/blog-settings-types.generated.d.ts +270 -295
- package/dist/server/api-client-core/apis/cms/blog-settings.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/cms/blog-settings.generated.js +35 -38
- package/dist/server/api-client-core/apis/cms/blog-settings.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/cms-content-audit-types.generated.d.ts +107 -131
- package/dist/server/api-client-core/apis/cms/cms-content-audit.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/cms/cms-content-audit.generated.js +6 -5
- package/dist/server/api-client-core/apis/cms/cms-content-audit.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/domains-types.generated.d.ts +155 -167
- package/dist/server/api-client-core/apis/cms/domains.generated.d.ts +2 -2
- package/dist/server/api-client-core/apis/cms/domains.generated.js +3 -2
- package/dist/server/api-client-core/apis/cms/domains.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/hubdb-types.generated.d.ts +876 -889
- package/dist/server/api-client-core/apis/cms/hubdb.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/cms/hubdb.generated.js +184 -185
- package/dist/server/api-client-core/apis/cms/hubdb.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/media-bridge-types.generated.d.ts +1550 -1575
- package/dist/server/api-client-core/apis/cms/media-bridge.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/cms/media-bridge.generated.js +161 -164
- package/dist/server/api-client-core/apis/cms/media-bridge.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/pages-types.generated.d.ts +1583 -1547
- package/dist/server/api-client-core/apis/cms/pages.generated.d.ts +15 -3
- package/dist/server/api-client-core/apis/cms/pages.generated.js +335 -326
- package/dist/server/api-client-core/apis/cms/pages.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/posts-types.generated.d.ts +900 -904
- package/dist/server/api-client-core/apis/cms/posts.generated.d.ts +7 -3
- package/dist/server/api-client-core/apis/cms/posts.generated.js +197 -196
- package/dist/server/api-client-core/apis/cms/posts.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/site-search-types.generated.d.ts +162 -174
- package/dist/server/api-client-core/apis/cms/site-search.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/cms/site-search.generated.js +4 -3
- package/dist/server/api-client-core/apis/cms/site-search.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/source-code-types.generated.d.ts +148 -172
- package/dist/server/api-client-core/apis/cms/source-code.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/cms/source-code.generated.js +40 -43
- package/dist/server/api-client-core/apis/cms/source-code.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/tags-types.generated.d.ts +406 -420
- package/dist/server/api-client-core/apis/cms/tags.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/cms/tags.generated.js +157 -158
- package/dist/server/api-client-core/apis/cms/tags.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/url-mappings-types.generated.d.ts +127 -139
- package/dist/server/api-client-core/apis/cms/url-mappings.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/cms/url-mappings.generated.js +4 -3
- package/dist/server/api-client-core/apis/cms/url-mappings.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/url-redirects-types.generated.d.ts +170 -182
- package/dist/server/api-client-core/apis/cms/url-redirects.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/cms/url-redirects.generated.js +4 -3
- package/dist/server/api-client-core/apis/cms/url-redirects.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/communication-preferences/subscriptions-types.generated.d.ts +728 -742
- package/dist/server/api-client-core/apis/communication-preferences/subscriptions.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/communication-preferences/subscriptions.generated.js +66 -69
- package/dist/server/api-client-core/apis/communication-preferences/subscriptions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/conversations/custom-channels-types.generated.d.ts +445 -471
- package/dist/server/api-client-core/apis/conversations/custom-channels.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/conversations/custom-channels.generated.js +70 -73
- package/dist/server/api-client-core/apis/conversations/custom-channels.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/conversations/visitor-identification-types.generated.d.ts +28 -40
- package/dist/server/api-client-core/apis/conversations/visitor-identification.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/conversations/visitor-identification.generated.js +3 -2
- package/dist/server/api-client-core/apis/conversations/visitor-identification.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/conversations-types.generated.d.ts +768 -781
- package/dist/server/api-client-core/apis/conversations.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/conversations.generated.js +101 -102
- package/dist/server/api-client-core/apis/conversations.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/app-uninstalls-types.generated.d.ts +8 -19
- package/dist/server/api-client-core/apis/crm/app-uninstalls.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/app-uninstalls.generated.js +3 -2
- package/dist/server/api-client-core/apis/crm/app-uninstalls.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/appointments-types.generated.d.ts +887 -891
- package/dist/server/api-client-core/apis/crm/appointments.generated.d.ts +7 -3
- package/dist/server/api-client-core/apis/crm/appointments.generated.js +105 -106
- package/dist/server/api-client-core/apis/crm/appointments.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/associations-schema-types.generated.d.ts +247 -260
- package/dist/server/api-client-core/apis/crm/associations-schema.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/crm/associations-schema.generated.js +48 -49
- package/dist/server/api-client-core/apis/crm/associations-schema.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/associations-types.generated.d.ts +576 -590
- package/dist/server/api-client-core/apis/crm/associations.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/associations.generated.js +71 -72
- package/dist/server/api-client-core/apis/crm/associations.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/calling-extensions-types.generated.d.ts +355 -379
- package/dist/server/api-client-core/apis/crm/calling-extensions.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/calling-extensions.generated.js +34 -37
- package/dist/server/api-client-core/apis/crm/calling-extensions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/calls-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/calls.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/calls.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/calls.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/carts-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/carts.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/carts.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/carts.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/commerce-payments-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/commerce-payments.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/commerce-payments.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/commerce-payments.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/commerce-subscriptions-types.generated.d.ts +752 -766
- package/dist/server/api-client-core/apis/crm/commerce-subscriptions.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/commerce-subscriptions.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/commerce-subscriptions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/communications-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/communications.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/communications.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/communications.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/companies-types.generated.d.ts +769 -795
- package/dist/server/api-client-core/apis/crm/companies.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/companies.generated.js +59 -58
- package/dist/server/api-client-core/apis/crm/companies.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/contacts-types.generated.d.ts +786 -812
- package/dist/server/api-client-core/apis/crm/contacts.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/contacts.generated.js +60 -61
- package/dist/server/api-client-core/apis/crm/contacts.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/contracts-types.generated.d.ts +796 -777
- package/dist/server/api-client-core/apis/crm/contracts.generated.d.ts +8 -3
- package/dist/server/api-client-core/apis/crm/contracts.generated.js +60 -57
- package/dist/server/api-client-core/apis/crm/contracts.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/courses-types.generated.d.ts +758 -772
- package/dist/server/api-client-core/apis/crm/courses.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/courses.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/courses.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/crm-owners-types.generated.d.ts +103 -115
- package/dist/server/api-client-core/apis/crm/crm-owners.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/crm-owners.generated.js +4 -3
- package/dist/server/api-client-core/apis/crm/crm-owners.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/custom-objects-types.generated.d.ts +833 -848
- package/dist/server/api-client-core/apis/crm/custom-objects.generated.d.ts +6 -3
- package/dist/server/api-client-core/apis/crm/custom-objects.generated.js +91 -90
- package/dist/server/api-client-core/apis/crm/custom-objects.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/deal-splits-types.generated.d.ts +158 -170
- package/dist/server/api-client-core/apis/crm/deal-splits.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/deal-splits.generated.js +4 -3
- package/dist/server/api-client-core/apis/crm/deal-splits.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/deals-types.generated.d.ts +771 -785
- package/dist/server/api-client-core/apis/crm/deals.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/deals.generated.js +59 -58
- package/dist/server/api-client-core/apis/crm/deals.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/discounts-types.generated.d.ts +754 -768
- package/dist/server/api-client-core/apis/crm/discounts.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/discounts.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/discounts.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/emails-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/emails.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/emails.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/emails.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/exports-types.generated.d.ts +227 -251
- package/dist/server/api-client-core/apis/crm/exports.generated.d.ts +2 -2
- package/dist/server/api-client-core/apis/crm/exports.generated.js +4 -5
- package/dist/server/api-client-core/apis/crm/exports.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/feedback-submissions-types.generated.d.ts +551 -565
- package/dist/server/api-client-core/apis/crm/feedback-submissions.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/feedback-submissions.generated.js +45 -46
- package/dist/server/api-client-core/apis/crm/feedback-submissions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/fees-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/fees.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/fees.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/fees.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/goal-targets-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/goal-targets.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/goal-targets.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/goal-targets.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/imports-types.generated.d.ts +305 -329
- package/dist/server/api-client-core/apis/crm/imports.generated.d.ts +2 -2
- package/dist/server/api-client-core/apis/crm/imports.generated.js +20 -23
- package/dist/server/api-client-core/apis/crm/imports.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/invoices-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/invoices.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/invoices.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/invoices.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/leads-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/leads.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/leads.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/leads.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/limits-tracking-types.generated.d.ts +251 -263
- package/dist/server/api-client-core/apis/crm/limits-tracking.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/limits-tracking.generated.js +4 -3
- package/dist/server/api-client-core/apis/crm/limits-tracking.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/line-items-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/line-items.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/line-items.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/line-items.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/listings-types.generated.d.ts +758 -772
- package/dist/server/api-client-core/apis/crm/listings.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/listings.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/listings.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/lists-types.generated.d.ts +2075 -2111
- package/dist/server/api-client-core/apis/crm/lists.generated.d.ts +2 -2
- package/dist/server/api-client-core/apis/crm/lists.generated.js +97 -98
- package/dist/server/api-client-core/apis/crm/lists.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/meetings-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/meetings.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/meetings.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/meetings.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/notes-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/notes.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/notes.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/notes.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/object-library-types.generated.d.ts +24 -36
- package/dist/server/api-client-core/apis/crm/object-library.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/object-library.generated.js +4 -3
- package/dist/server/api-client-core/apis/crm/object-library.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/objects-types.generated.d.ts +620 -645
- package/dist/server/api-client-core/apis/crm/objects.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/crm/objects.generated.js +66 -67
- package/dist/server/api-client-core/apis/crm/objects.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/orders-types.generated.d.ts +747 -761
- package/dist/server/api-client-core/apis/crm/orders.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/orders.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/orders.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/partner-clients-types.generated.d.ts +646 -660
- package/dist/server/api-client-core/apis/crm/partner-clients.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/partner-clients.generated.js +63 -62
- package/dist/server/api-client-core/apis/crm/partner-clients.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/partner-services-types.generated.d.ts +646 -660
- package/dist/server/api-client-core/apis/crm/partner-services.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/partner-services.generated.js +63 -62
- package/dist/server/api-client-core/apis/crm/partner-services.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/pipelines-types.generated.d.ts +320 -332
- package/dist/server/api-client-core/apis/crm/pipelines.generated.d.ts +2 -2
- package/dist/server/api-client-core/apis/crm/pipelines.generated.js +3 -2
- package/dist/server/api-client-core/apis/crm/pipelines.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/postal-mail-types.generated.d.ts +744 -758
- package/dist/server/api-client-core/apis/crm/postal-mail.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/postal-mail.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/postal-mail.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/products-types.generated.d.ts +747 -761
- package/dist/server/api-client-core/apis/crm/products.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/products.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/products.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/projects-types.generated.d.ts +761 -787
- package/dist/server/api-client-core/apis/crm/projects.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/projects.generated.js +59 -58
- package/dist/server/api-client-core/apis/crm/projects.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/properties-types.generated.d.ts +526 -528
- package/dist/server/api-client-core/apis/crm/properties.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/properties.generated.js +79 -78
- package/dist/server/api-client-core/apis/crm/properties.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/property-validations-types.generated.d.ts +71 -83
- package/dist/server/api-client-core/apis/crm/property-validations.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/property-validations.generated.js +4 -3
- package/dist/server/api-client-core/apis/crm/property-validations.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/public-app-crm-cards-types.generated.d.ts +409 -433
- package/dist/server/api-client-core/apis/crm/public-app-crm-cards.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/public-app-crm-cards.generated.js +24 -25
- package/dist/server/api-client-core/apis/crm/public-app-crm-cards.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/public-app-feature-flags-types.generated.d.ts +156 -169
- package/dist/server/api-client-core/apis/crm/public-app-feature-flags.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/crm/public-app-feature-flags.generated.js +55 -56
- package/dist/server/api-client-core/apis/crm/public-app-feature-flags.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/quotes-types.generated.d.ts +747 -761
- package/dist/server/api-client-core/apis/crm/quotes.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/quotes.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/quotes.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/schemas-types.generated.d.ts +575 -600
- package/dist/server/api-client-core/apis/crm/schemas.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/crm/schemas.generated.js +33 -34
- package/dist/server/api-client-core/apis/crm/schemas.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/services-types.generated.d.ts +750 -764
- package/dist/server/api-client-core/apis/crm/services.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/services.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/services.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/tasks-types.generated.d.ts +747 -761
- package/dist/server/api-client-core/apis/crm/tasks.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/tasks.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/tasks.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/taxes-types.generated.d.ts +747 -761
- package/dist/server/api-client-core/apis/crm/taxes.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/taxes.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/taxes.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/tickets-types.generated.d.ts +764 -790
- package/dist/server/api-client-core/apis/crm/tickets.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/tickets.generated.js +59 -58
- package/dist/server/api-client-core/apis/crm/tickets.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/timeline-types.generated.d.ts +136 -149
- package/dist/server/api-client-core/apis/crm/timeline.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/crm/timeline.generated.js +5 -6
- package/dist/server/api-client-core/apis/crm/timeline.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/transcriptions-types.generated.d.ts +104 -117
- package/dist/server/api-client-core/apis/crm/transcriptions.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/crm/transcriptions.generated.js +7 -10
- package/dist/server/api-client-core/apis/crm/transcriptions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/users-types.generated.d.ts +747 -761
- package/dist/server/api-client-core/apis/crm/users.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/users.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/users.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/video-conferencing-extension-types.generated.d.ts +28 -40
- package/dist/server/api-client-core/apis/crm/video-conferencing-extension.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/video-conferencing-extension.generated.js +4 -3
- package/dist/server/api-client-core/apis/crm/video-conferencing-extension.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/events/manage-event-definitions-types.generated.d.ts +909 -945
- package/dist/server/api-client-core/apis/events/manage-event-definitions.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/events/manage-event-definitions.generated.js +29 -30
- package/dist/server/api-client-core/apis/events/manage-event-definitions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/events/send-event-completions-types.generated.d.ts +49 -62
- package/dist/server/api-client-core/apis/events/send-event-completions.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/events/send-event-completions.generated.js +4 -5
- package/dist/server/api-client-core/apis/events/send-event-completions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/events-types.generated.d.ts +99 -111
- package/dist/server/api-client-core/apis/events.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/events.generated.js +4 -3
- package/dist/server/api-client-core/apis/events.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/files-types.generated.d.ts +636 -649
- package/dist/server/api-client-core/apis/files.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/files.generated.js +112 -113
- package/dist/server/api-client-core/apis/files.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/marketing/campaigns-public-api-types.generated.d.ts +799 -816
- package/dist/server/api-client-core/apis/marketing/campaigns-public-api.generated.d.ts +8 -3
- package/dist/server/api-client-core/apis/marketing/campaigns-public-api.generated.js +126 -127
- package/dist/server/api-client-core/apis/marketing/campaigns-public-api.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/marketing/marketing-emails-types.generated.d.ts +745 -769
- package/dist/server/api-client-core/apis/marketing/marketing-emails.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/marketing/marketing-emails.generated.js +100 -103
- package/dist/server/api-client-core/apis/marketing/marketing-emails.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/marketing/marketing-events-types.generated.d.ts +1504 -1546
- package/dist/server/api-client-core/apis/marketing/marketing-events.generated.d.ts +9 -3
- package/dist/server/api-client-core/apis/marketing/marketing-events.generated.js +162 -167
- package/dist/server/api-client-core/apis/marketing/marketing-events.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/marketing/single-send-types.generated.d.ts +91 -103
- package/dist/server/api-client-core/apis/marketing/single-send.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/marketing/single-send.generated.js +3 -2
- package/dist/server/api-client-core/apis/marketing/single-send.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/marketing/transactional-single-send-types.generated.d.ts +187 -200
- package/dist/server/api-client-core/apis/marketing/transactional-single-send.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/marketing/transactional-single-send.generated.js +14 -15
- package/dist/server/api-client-core/apis/marketing/transactional-single-send.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/meta/origins-types.generated.d.ts +41 -53
- package/dist/server/api-client-core/apis/meta/origins.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/meta/origins.generated.js +4 -3
- package/dist/server/api-client-core/apis/meta/origins.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/scheduler/meetings-types.generated.d.ts +850 -863
- package/dist/server/api-client-core/apis/scheduler/meetings.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/scheduler/meetings.generated.js +28 -29
- package/dist/server/api-client-core/apis/scheduler/meetings.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/settings/multicurrency-types.generated.d.ts +281 -296
- package/dist/server/api-client-core/apis/settings/multicurrency.generated.d.ts +6 -3
- package/dist/server/api-client-core/apis/settings/multicurrency.generated.js +32 -33
- package/dist/server/api-client-core/apis/settings/multicurrency.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/settings/tax-rates-types.generated.d.ts +71 -83
- package/dist/server/api-client-core/apis/settings/tax-rates.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/settings/tax-rates.generated.js +4 -3
- package/dist/server/api-client-core/apis/settings/tax-rates.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/settings/user-provisioning-types.generated.d.ts +202 -250
- package/dist/server/api-client-core/apis/settings/user-provisioning.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/settings/user-provisioning.generated.js +23 -26
- package/dist/server/api-client-core/apis/settings/user-provisioning.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/webhooks-journal-types.generated.d.ts +490 -526
- package/dist/server/api-client-core/apis/webhooks-journal.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/webhooks-journal.generated.js +65 -70
- package/dist/server/api-client-core/apis/webhooks-journal.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/webhooks-types.generated.d.ts +816 -852
- package/dist/server/api-client-core/apis/webhooks.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/webhooks.generated.js +93 -98
- package/dist/server/api-client-core/apis/webhooks.generated.js.map +1 -1
- package/dist/server/api-client-core/binary-data.js.map +1 -1
- package/dist/server/api-client-core/client.js +5 -1
- package/dist/server/api-client-core/client.js.map +1 -1
- package/dist/server/api-client-core/codegen-helpers/file-op-wrappers.js.map +1 -1
- package/dist/server/api-client-core/errors.js.map +1 -1
- package/dist/server/api-client-core/op.js.map +1 -1
- package/dist/server/api-client-core/pagination.d.ts +2 -2
- package/dist/server/api-client-core/pagination.js +2 -2
- package/dist/server/api-client-core/pagination.js.map +1 -1
- package/dist/server/api-client-core/plugins/fetch-transport.js +33 -9
- package/dist/server/api-client-core/plugins/fetch-transport.js.map +1 -1
- package/dist/server/api-client-core/types.d.ts +1 -1
- package/dist/server/api-client.d.ts +184 -184
- package/dist/server/api-client.js +89 -89
- package/dist/server/constants.js +33 -6
- package/dist/server/constants.js.map +1 -1
- package/dist/server/deno/start.js.map +1 -1
- package/dist/server/hono/hono-request-handler.js +32 -23
- package/dist/server/hono/hono-request-handler.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/auth-complete.js +158 -0
- package/dist/server/hono/hubspot-connect-routes/auth-complete.js.map +1 -0
- package/dist/server/hono/hubspot-connect-routes/auth-init-session.js +25 -12
- package/dist/server/hono/hubspot-connect-routes/auth-init-session.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/auth-logout.js +32 -9
- package/dist/server/hono/hubspot-connect-routes/auth-logout.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/auth-refresh.js +32 -18
- package/dist/server/hono/hubspot-connect-routes/auth-refresh.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/cimd-client-metadata-types.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/cimd-public-routes.js +4 -1
- package/dist/server/hono/hubspot-connect-routes/cimd-public-routes.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/fetch-hubspot-client-metadata.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/hubspot-connect-routes.js +4 -2
- package/dist/server/hono/hubspot-connect-routes/hubspot-connect-routes.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/load-hubspot-connect-routes-env.js +5 -5
- package/dist/server/hono/hubspot-connect-routes/load-hubspot-connect-routes-env.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/oauth-client.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/utils.js +53 -6
- package/dist/server/hono/hubspot-connect-routes/utils.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/whoami.js +51 -0
- package/dist/server/hono/hubspot-connect-routes/whoami.js.map +1 -0
- package/dist/server/hono/types.d.ts +9 -10
- package/dist/server/hono/utils/cookie-utils.js +2 -1
- package/dist/server/hono/utils/cookie-utils.js.map +1 -1
- package/dist/server/hono/utils/cors-middleware.js +85 -0
- package/dist/server/hono/utils/cors-middleware.js.map +1 -0
- package/dist/server/import-app-keys.js.map +1 -1
- package/dist/server/lovable/create-app-function-start.d.ts +1 -1
- package/dist/server/lovable/create-app-function-start.js +4 -6
- package/dist/server/lovable/create-app-function-start.js.map +1 -1
- package/dist/server/lovable/hubspot-connect/index.js.map +1 -1
- package/dist/server/lovable/hubspot-connect/run-hubspot-connect-lovable-server.js +14 -15
- package/dist/server/lovable/hubspot-connect/run-hubspot-connect-lovable-server.js.map +1 -1
- package/dist/server/sanitize-request.js +14 -11
- package/dist/server/sanitize-request.js.map +1 -1
- package/dist/server/secure-start-core.js +4 -5
- package/dist/server/secure-start-core.js.map +1 -1
- package/dist/server/shared/constants.js +22 -9
- package/dist/server/shared/constants.js.map +1 -1
- package/dist/server/shared/encoding/base64.js.map +1 -1
- package/dist/server/shared/encoding/sha256.js.map +1 -1
- package/dist/server/shared/logger.js.map +1 -1
- package/dist/server/types.d.ts +1 -35
- package/dist/server/utils/cookie-utils.js.map +1 -1
- package/dist/server/utils/dpop-utils.js.map +1 -1
- package/dist/server/utils/env-utils.js +60 -7
- package/dist/server/utils/env-utils.js.map +1 -1
- package/dist/server/utils/hubspot-dpop-auth-headers.js +38 -0
- package/dist/server/utils/hubspot-dpop-auth-headers.js.map +1 -0
- package/dist/server/utils/jwk-utils.js.map +1 -1
- package/dist/server/utils/jwt-utils.js.map +1 -1
- package/package.json +15 -21
- package/src/browser/app-connect-controller/README.md +5 -2
- package/src/browser/app-connect-controller/connect-start.test.ts +157 -0
- package/src/browser/app-connect-controller/connect-start.ts +18 -3
- package/src/browser/app-connect-controller/constants.ts +6 -4
- package/src/browser/app-connect-controller/create.ts +8 -2
- package/src/browser/app-connect-controller/disconnect.ts +5 -7
- package/src/browser/app-connect-controller/init.test.ts +275 -0
- package/src/browser/app-connect-controller/init.ts +44 -19
- package/src/browser/app-connect-controller/oauth-complete.test.ts +110 -0
- package/src/browser/app-connect-controller/oauth-complete.ts +53 -0
- package/src/browser/app-connect-controller/oauth-popup.test.ts +239 -0
- package/src/browser/app-connect-controller/oauth-popup.ts +160 -0
- package/src/browser/app-connect-controller/types.ts +3 -0
- package/src/browser/app-connect-controller/utils/iframe-utils.ts +12 -0
- package/src/browser/app-connect-controller/utils/resolve-oauth-connect-mode.test.ts +35 -0
- package/src/browser/app-connect-controller/utils/resolve-oauth-connect-mode.ts +21 -0
- package/src/browser/app-connect-controller/utils/session-utils.test.ts +73 -22
- package/src/browser/app-connect-controller/utils/session-utils.ts +74 -33
- package/src/browser/app-connect-controller/view-state.test.ts +1 -0
- package/src/browser/app-connect-controller/view-state.ts +1 -0
- package/src/browser/index.ts +1 -0
- package/src/browser/react/components/AppConnectHeader/AppConnectHeader.tsx +21 -34
- package/src/browser/react/components/ConnectButton/ConnectButton.tsx +1 -1
- package/src/browser/react/lovable/LovableHubSpotAppConnect.tsx +12 -2
- package/src/browser/types.ts +30 -5
- package/src/server/api-client-core/__tests__/errors.test.ts +309 -0
- package/src/server/api-client-core/__tests__/operation-headers.test.ts +251 -0
- package/src/server/api-client-core/apis/account/account-info-types.generated.ts +74 -88
- package/src/server/api-client-core/apis/account/account-info.generated.ts +2 -4
- package/src/server/api-client-core/apis/account/audit-logs-types.generated.ts +346 -360
- package/src/server/api-client-core/apis/account/audit-logs.generated.ts +2 -4
- package/src/server/api-client-core/apis/auth/oauth-types.generated.ts +81 -99
- package/src/server/api-client-core/apis/auth/oauth.generated.ts +1 -3
- package/src/server/api-client-core/apis/automation/actions-types.generated.ts +1162 -1188
- package/src/server/api-client-core/apis/automation/actions.generated.ts +10 -12
- package/src/server/api-client-core/apis/automation/sequences-types.generated.ts +379 -393
- package/src/server/api-client-core/apis/automation/sequences.generated.ts +1 -3
- package/src/server/api-client-core/apis/business-units-types.generated.ts +43 -59
- package/src/server/api-client-core/apis/business-units.generated.ts +9 -10
- package/src/server/api-client-core/apis/cms/authors-types.generated.ts +3823 -3853
- package/src/server/api-client-core/apis/cms/authors.generated.ts +31 -37
- package/src/server/api-client-core/apis/cms/blog-settings-types.generated.ts +3667 -3696
- package/src/server/api-client-core/apis/cms/blog-settings.generated.ts +46 -51
- package/src/server/api-client-core/apis/cms/cms-content-audit-types.generated.ts +138 -163
- package/src/server/api-client-core/apis/cms/cms-content-audit.generated.ts +2 -10
- package/src/server/api-client-core/apis/cms/domains-types.generated.ts +153 -167
- package/src/server/api-client-core/apis/cms/domains.generated.ts +2 -4
- package/src/server/api-client-core/apis/cms/hubdb-types.generated.ts +1013 -1063
- package/src/server/api-client-core/apis/cms/hubdb.generated.ts +3 -5
- package/src/server/api-client-core/apis/cms/media-bridge-types.generated.ts +8623 -8657
- package/src/server/api-client-core/apis/cms/media-bridge.generated.ts +16 -22
- package/src/server/api-client-core/apis/cms/pages-types.generated.ts +5259 -5272
- package/src/server/api-client-core/apis/cms/pages.generated.ts +262 -226
- package/src/server/api-client-core/apis/cms/posts-types.generated.ts +4420 -4438
- package/src/server/api-client-core/apis/cms/posts.generated.ts +108 -106
- package/src/server/api-client-core/apis/cms/site-search-types.generated.ts +1867 -1881
- package/src/server/api-client-core/apis/cms/site-search.generated.ts +2 -4
- package/src/server/api-client-core/apis/cms/source-code-types.generated.ts +144 -177
- package/src/server/api-client-core/apis/cms/source-code.generated.ts +15 -23
- package/src/server/api-client-core/apis/cms/tags-types.generated.ts +3820 -3845
- package/src/server/api-client-core/apis/cms/tags.generated.ts +80 -82
- package/src/server/api-client-core/apis/cms/url-mappings-types.generated.ts +188 -202
- package/src/server/api-client-core/apis/cms/url-mappings.generated.ts +2 -4
- package/src/server/api-client-core/apis/cms/url-redirects-types.generated.ts +182 -196
- package/src/server/api-client-core/apis/cms/url-redirects.generated.ts +2 -4
- package/src/server/api-client-core/apis/communication-preferences/subscriptions-types.generated.ts +810 -828
- package/src/server/api-client-core/apis/communication-preferences/subscriptions.generated.ts +66 -63
- package/src/server/api-client-core/apis/conversations/custom-channels-types.generated.ts +564 -601
- package/src/server/api-client-core/apis/conversations/custom-channels.generated.ts +90 -86
- package/src/server/api-client-core/apis/conversations/visitor-identification-types.generated.ts +31 -44
- package/src/server/api-client-core/apis/conversations/visitor-identification.generated.ts +6 -8
- package/src/server/api-client-core/apis/conversations-types.generated.ts +955 -991
- package/src/server/api-client-core/apis/conversations.generated.ts +6 -5
- package/src/server/api-client-core/apis/crm/app-uninstalls-types.generated.ts +7 -19
- package/src/server/api-client-core/apis/crm/app-uninstalls.generated.ts +2 -4
- package/src/server/api-client-core/apis/crm/appointments-types.generated.ts +965 -969
- package/src/server/api-client-core/apis/crm/appointments.generated.ts +143 -137
- package/src/server/api-client-core/apis/crm/associations-schema-types.generated.ts +292 -322
- package/src/server/api-client-core/apis/crm/associations-schema.generated.ts +17 -19
- package/src/server/api-client-core/apis/crm/associations-types.generated.ts +657 -675
- package/src/server/api-client-core/apis/crm/associations.generated.ts +70 -70
- package/src/server/api-client-core/apis/crm/calling-extensions-types.generated.ts +417 -441
- package/src/server/api-client-core/apis/crm/calling-extensions.generated.ts +62 -69
- package/src/server/api-client-core/apis/crm/calls-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/calls.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/carts-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/carts.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/commerce-payments-types.generated.ts +847 -856
- package/src/server/api-client-core/apis/crm/commerce-payments.generated.ts +73 -73
- package/src/server/api-client-core/apis/crm/commerce-subscriptions-types.generated.ts +844 -853
- package/src/server/api-client-core/apis/crm/commerce-subscriptions.generated.ts +50 -51
- package/src/server/api-client-core/apis/crm/communications-types.generated.ts +846 -856
- package/src/server/api-client-core/apis/crm/communications.generated.ts +73 -73
- package/src/server/api-client-core/apis/crm/companies-types.generated.ts +859 -885
- package/src/server/api-client-core/apis/crm/companies.generated.ts +44 -50
- package/src/server/api-client-core/apis/crm/contacts-types.generated.ts +875 -907
- package/src/server/api-client-core/apis/crm/contacts.generated.ts +46 -52
- package/src/server/api-client-core/apis/crm/contracts-types.generated.ts +894 -862
- package/src/server/api-client-core/apis/crm/contracts.generated.ts +66 -56
- package/src/server/api-client-core/apis/crm/courses-types.generated.ts +842 -859
- package/src/server/api-client-core/apis/crm/courses.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/crm-owners-types.generated.ts +102 -115
- package/src/server/api-client-core/apis/crm/crm-owners.generated.ts +2 -4
- package/src/server/api-client-core/apis/crm/custom-objects-types.generated.ts +900 -915
- package/src/server/api-client-core/apis/crm/custom-objects.generated.ts +128 -126
- package/src/server/api-client-core/apis/crm/deal-splits-types.generated.ts +157 -170
- package/src/server/api-client-core/apis/crm/deal-splits.generated.ts +2 -4
- package/src/server/api-client-core/apis/crm/deals-types.generated.ts +858 -875
- package/src/server/api-client-core/apis/crm/deals.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/discounts-types.generated.ts +842 -855
- package/src/server/api-client-core/apis/crm/discounts.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/emails-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/emails.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/exports-types.generated.ts +284 -314
- package/src/server/api-client-core/apis/crm/exports.generated.ts +6 -11
- package/src/server/api-client-core/apis/crm/feedback-submissions-types.generated.ts +607 -622
- package/src/server/api-client-core/apis/crm/feedback-submissions.generated.ts +84 -80
- package/src/server/api-client-core/apis/crm/fees-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/fees.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/goal-targets-types.generated.ts +845 -856
- package/src/server/api-client-core/apis/crm/goal-targets.generated.ts +50 -51
- package/src/server/api-client-core/apis/crm/imports-types.generated.ts +663 -692
- package/src/server/api-client-core/apis/crm/imports.generated.ts +2 -7
- package/src/server/api-client-core/apis/crm/invoices-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/invoices.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/leads-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/leads.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/limits-tracking-types.generated.ts +263 -275
- package/src/server/api-client-core/apis/crm/limits-tracking.generated.ts +2 -4
- package/src/server/api-client-core/apis/crm/line-items-types.generated.ts +843 -856
- package/src/server/api-client-core/apis/crm/line-items.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/listings-types.generated.ts +842 -859
- package/src/server/api-client-core/apis/crm/listings.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/lists-types.generated.ts +2794 -2845
- package/src/server/api-client-core/apis/crm/lists.generated.ts +8 -20
- package/src/server/api-client-core/apis/crm/meetings-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/meetings.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/notes-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/notes.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/object-library-types.generated.ts +26 -39
- package/src/server/api-client-core/apis/crm/object-library.generated.ts +2 -4
- package/src/server/api-client-core/apis/crm/objects-types.generated.ts +688 -716
- package/src/server/api-client-core/apis/crm/objects.generated.ts +79 -83
- package/src/server/api-client-core/apis/crm/orders-types.generated.ts +829 -846
- package/src/server/api-client-core/apis/crm/orders.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/partner-clients-types.generated.ts +721 -735
- package/src/server/api-client-core/apis/crm/partner-clients.generated.ts +60 -60
- package/src/server/api-client-core/apis/crm/partner-services-types.generated.ts +720 -734
- package/src/server/api-client-core/apis/crm/partner-services.generated.ts +60 -60
- package/src/server/api-client-core/apis/crm/pipelines-types.generated.ts +366 -388
- package/src/server/api-client-core/apis/crm/pipelines.generated.ts +2 -4
- package/src/server/api-client-core/apis/crm/postal-mail-types.generated.ts +830 -843
- package/src/server/api-client-core/apis/crm/postal-mail.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/products-types.generated.ts +829 -846
- package/src/server/api-client-core/apis/crm/products.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/projects-types.generated.ts +845 -875
- package/src/server/api-client-core/apis/crm/projects.generated.ts +47 -53
- package/src/server/api-client-core/apis/crm/properties-types.generated.ts +623 -626
- package/src/server/api-client-core/apis/crm/properties.generated.ts +33 -28
- package/src/server/api-client-core/apis/crm/property-validations-types.generated.ts +160 -174
- package/src/server/api-client-core/apis/crm/property-validations.generated.ts +2 -6
- package/src/server/api-client-core/apis/crm/public-app-crm-cards-types.generated.ts +467 -494
- package/src/server/api-client-core/apis/crm/public-app-crm-cards.generated.ts +7 -15
- package/src/server/api-client-core/apis/crm/public-app-feature-flags-types.generated.ts +166 -177
- package/src/server/api-client-core/apis/crm/public-app-feature-flags.generated.ts +6 -8
- package/src/server/api-client-core/apis/crm/quotes-types.generated.ts +829 -846
- package/src/server/api-client-core/apis/crm/quotes.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/schemas-types.generated.ts +613 -640
- package/src/server/api-client-core/apis/crm/schemas.generated.ts +8 -14
- package/src/server/api-client-core/apis/crm/services-types.generated.ts +832 -849
- package/src/server/api-client-core/apis/crm/services.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/tasks-types.generated.ts +829 -846
- package/src/server/api-client-core/apis/crm/tasks.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/taxes-types.generated.ts +829 -846
- package/src/server/api-client-core/apis/crm/taxes.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/tickets-types.generated.ts +848 -878
- package/src/server/api-client-core/apis/crm/tickets.generated.ts +47 -53
- package/src/server/api-client-core/apis/crm/timeline-types.generated.ts +144 -161
- package/src/server/api-client-core/apis/crm/timeline.generated.ts +6 -8
- package/src/server/api-client-core/apis/crm/transcriptions-types.generated.ts +149 -164
- package/src/server/api-client-core/apis/crm/transcriptions.generated.ts +22 -22
- package/src/server/api-client-core/apis/crm/users-types.generated.ts +829 -846
- package/src/server/api-client-core/apis/crm/users.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/video-conferencing-extension-types.generated.ts +29 -42
- package/src/server/api-client-core/apis/crm/video-conferencing-extension.generated.ts +17 -19
- package/src/server/api-client-core/apis/events/manage-event-definitions-types.generated.ts +1509 -1558
- package/src/server/api-client-core/apis/events/manage-event-definitions.generated.ts +55 -65
- package/src/server/api-client-core/apis/events/send-event-completions-types.generated.ts +51 -68
- package/src/server/api-client-core/apis/events/send-event-completions.generated.ts +10 -10
- package/src/server/api-client-core/apis/events-types.generated.ts +97 -110
- package/src/server/api-client-core/apis/events.generated.ts +2 -4
- package/src/server/api-client-core/apis/files-types.generated.ts +727 -757
- package/src/server/api-client-core/apis/files.generated.ts +3 -5
- package/src/server/api-client-core/apis/marketing/campaigns-public-api-types.generated.ts +1221 -1234
- package/src/server/api-client-core/apis/marketing/campaigns-public-api.generated.ts +45 -47
- package/src/server/api-client-core/apis/marketing/marketing-emails-types.generated.ts +3704 -3733
- package/src/server/api-client-core/apis/marketing/marketing-emails.generated.ts +44 -52
- package/src/server/api-client-core/apis/marketing/marketing-events-types.generated.ts +1787 -1848
- package/src/server/api-client-core/apis/marketing/marketing-events.generated.ts +236 -241
- package/src/server/api-client-core/apis/marketing/single-send-types.generated.ts +142 -155
- package/src/server/api-client-core/apis/marketing/single-send.generated.ts +2 -6
- package/src/server/api-client-core/apis/marketing/transactional-single-send-types.generated.ts +253 -269
- package/src/server/api-client-core/apis/marketing/transactional-single-send.generated.ts +32 -31
- package/src/server/api-client-core/apis/meta/origins-types.generated.ts +40 -56
- package/src/server/api-client-core/apis/meta/origins.generated.ts +2 -4
- package/src/server/api-client-core/apis/scheduler/meetings-types.generated.ts +1001 -1014
- package/src/server/api-client-core/apis/scheduler/meetings.generated.ts +6 -8
- package/src/server/api-client-core/apis/settings/multicurrency-types.generated.ts +1906 -1912
- package/src/server/api-client-core/apis/settings/multicurrency.generated.ts +64 -63
- package/src/server/api-client-core/apis/settings/tax-rates-types.generated.ts +71 -85
- package/src/server/api-client-core/apis/settings/tax-rates.generated.ts +2 -4
- package/src/server/api-client-core/apis/settings/user-provisioning-types.generated.ts +207 -257
- package/src/server/api-client-core/apis/settings/user-provisioning.generated.ts +8 -24
- package/src/server/api-client-core/apis/webhooks-journal-types.generated.ts +740 -771
- package/src/server/api-client-core/apis/webhooks-journal.generated.ts +47 -59
- package/src/server/api-client-core/apis/webhooks-types.generated.ts +1194 -1228
- package/src/server/api-client-core/apis/webhooks.generated.ts +52 -64
- package/src/server/api-client-core/client.ts +5 -1
- package/src/server/api-client-core/pagination.ts +2 -2
- package/src/server/api-client-core/plugins/fetch-transport.ts +70 -12
- package/src/server/api-client-core/types.ts +1 -1
- package/src/server/constants.ts +29 -4
- package/src/server/hono/hono-request-handler.ts +68 -27
- package/src/server/hono/hubspot-connect-routes/auth-complete.test.ts +394 -0
- package/src/server/hono/hubspot-connect-routes/{auth-callback.ts → auth-complete.ts} +81 -30
- package/src/server/hono/hubspot-connect-routes/auth-init-session.test.ts +114 -30
- package/src/server/hono/hubspot-connect-routes/auth-init-session.ts +35 -10
- package/src/server/hono/hubspot-connect-routes/auth-logout.test.ts +13 -0
- package/src/server/hono/hubspot-connect-routes/auth-logout.ts +39 -10
- package/src/server/hono/hubspot-connect-routes/auth-refresh.test.ts +6 -0
- package/src/server/hono/hubspot-connect-routes/auth-refresh.ts +24 -9
- package/src/server/hono/hubspot-connect-routes/cimd-public-routes.test.ts +7 -6
- package/src/server/hono/hubspot-connect-routes/cimd-public-routes.ts +5 -1
- package/src/server/hono/hubspot-connect-routes/hubspot-connect-routes.ts +11 -3
- package/src/server/hono/hubspot-connect-routes/load-hubspot-connect-routes-env.test.ts +17 -24
- package/src/server/hono/hubspot-connect-routes/load-hubspot-connect-routes-env.ts +8 -8
- package/src/server/hono/hubspot-connect-routes/utils.test.ts +16 -46
- package/src/server/hono/hubspot-connect-routes/utils.ts +61 -5
- package/src/server/hono/hubspot-connect-routes/whoami.ts +74 -0
- package/src/server/hono/types.ts +11 -10
- package/src/server/hono/utils/cookie-utils.ts +27 -2
- package/src/server/hono/utils/cors-middleware.test.ts +80 -0
- package/src/server/hono/utils/cors-middleware.ts +95 -0
- package/src/server/lovable/create-app-function-start.ts +4 -7
- package/src/server/lovable/hubspot-connect/run-hubspot-connect-lovable-server.ts +21 -16
- package/src/server/sanitize-request.ts +15 -12
- package/src/server/secure-start-core.ts +7 -6
- package/src/server/types.ts +2 -38
- package/src/server/utils/env-utils.test.ts +140 -12
- package/src/server/utils/env-utils.ts +80 -6
- package/src/server/utils/hubspot-dpop-auth-headers.test.ts +43 -0
- package/src/server/utils/hubspot-dpop-auth-headers.ts +48 -0
- package/src/shared/constants.ts +40 -3
- package/src/shared/wire-types.ts +49 -0
- package/dist/browser/HubSpotAppConnect-BW45gyDs.js.map +0 -1
- package/dist/browser/create-vctOhpX9.js.map +0 -1
- package/dist/server/hono/hubspot-connect-routes/auth-callback.js +0 -125
- package/dist/server/hono/hubspot-connect-routes/auth-callback.js.map +0 -1
- package/dist/server/proxy.js +0 -68
- package/dist/server/proxy.js.map +0 -1
- package/src/server/hono/hubspot-connect-routes/auth-callback.test.ts +0 -225
- package/src/server/proxy.test.ts +0 -80
- package/src/server/proxy.ts +0 -116
package/dist/server/api-client-core/apis/events/manage-event-definitions-types.generated.d.ts
CHANGED
|
@@ -1,1005 +1,969 @@
|
|
|
1
1
|
import { Operation } from "../../types.js";
|
|
2
2
|
|
|
3
3
|
//#region src/server/api-client-core/apis/events/manage-event-definitions-types.generated.d.ts
|
|
4
|
-
declare namespace
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
type
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
/**
|
|
30
|
-
* The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
|
|
31
|
-
*/
|
|
32
|
-
after?: string;
|
|
33
|
-
includeProperties?: boolean;
|
|
34
|
-
/**
|
|
35
|
-
* The maximum number of results to display per page.
|
|
36
|
-
*/
|
|
37
|
-
limit?: number;
|
|
38
|
-
searchString?: string;
|
|
39
|
-
sortOrder?: string;
|
|
40
|
-
}
|
|
41
|
-
type ListOutput = Schemas.CollectionResponseWithTotalExternalBehavioralEventTypeDefinition;
|
|
42
|
-
interface UpdateInput {
|
|
43
|
-
data: Schemas.ExternalBehavioralEventTypeDefinitionPatch;
|
|
44
|
-
eventName: string;
|
|
45
|
-
}
|
|
46
|
-
type UpdateOutput = Schemas.ExternalBehavioralEventTypeDefinition;
|
|
47
|
-
interface UpdatePropertyInput {
|
|
48
|
-
data: Schemas.ExternalBehavioralEventPropertyDefinitionPatch;
|
|
49
|
-
eventName: string;
|
|
50
|
-
propertyName: string;
|
|
51
|
-
}
|
|
52
|
-
type UpdatePropertyOutput = Schemas.Property;
|
|
53
|
-
}
|
|
54
|
-
namespace Batch {
|
|
55
|
-
type SendBatchInput = Schemas.BatchedBehavioralEventHttpCompletionRequest;
|
|
56
|
-
type SendBatchOutput = void;
|
|
57
|
-
}
|
|
58
|
-
namespace Schemas {
|
|
59
|
-
interface AbsoluteComparativeTimestampRefineBy {
|
|
60
|
-
comparison: 'AFTER' | 'BEFORE';
|
|
61
|
-
timestamp: number;
|
|
62
|
-
type: 'AbsoluteComparativeTimestampRefineBy';
|
|
63
|
-
}
|
|
64
|
-
interface AbsoluteRangedTimestampRefineBy {
|
|
65
|
-
lowerTimestamp: number;
|
|
66
|
-
rangeType: 'BETWEEN' | 'NOT_BETWEEN';
|
|
67
|
-
type: 'AbsoluteRangedTimestampRefineBy';
|
|
68
|
-
upperTimestamp: number;
|
|
69
|
-
}
|
|
70
|
-
interface AllHistoryRefineBy {
|
|
71
|
-
type: 'AllHistoryRefineBy';
|
|
72
|
-
}
|
|
73
|
-
interface AllPropertyTypesOperation {
|
|
74
|
-
coalescingRefineBy: Schemas.NumOccurrencesRefineBy | Schemas.SetOccurrencesRefineBy;
|
|
75
|
-
defaultValue?: string;
|
|
76
|
-
includeObjectsWithNoValueSet: boolean;
|
|
77
|
-
operationType: string;
|
|
78
|
-
operator: 'IS_BLANK' | 'IS_KNOWN' | 'IS_NOT_BLANK' | 'IS_UNKNOWN';
|
|
79
|
-
operatorName: string;
|
|
80
|
-
propertyType: 'alltypes';
|
|
81
|
-
pruningRefineBy?: Schemas.RelativeComparativeTimestampRefineBy | Schemas.RelativeRangedTimestampRefineBy | Schemas.AbsoluteComparativeTimestampRefineBy | Schemas.AbsoluteRangedTimestampRefineBy | Schemas.AllHistoryRefineBy | Schemas.TimePointOperation | Schemas.RangedTimeOperation;
|
|
82
|
-
renderSpec?: string;
|
|
83
|
-
}
|
|
84
|
-
/**
|
|
85
|
-
* The definition of an association
|
|
86
|
-
*/
|
|
87
|
-
interface AssociationDefinition {
|
|
88
|
-
/**
|
|
89
|
-
* Whether custom labels can be used in the association.
|
|
90
|
-
*/
|
|
91
|
-
allowsCustomLabels: boolean;
|
|
92
|
-
/**
|
|
93
|
-
* The cardinality from the source object's perspective, either "ONE_TO_ONE" or "ONE_TO_MANY".
|
|
94
|
-
*/
|
|
95
|
-
cardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE';
|
|
96
|
-
/**
|
|
97
|
-
* The error category
|
|
98
|
-
*/
|
|
99
|
-
category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK';
|
|
100
|
-
/**
|
|
101
|
-
* The name of the source object type (e.g,. "DEAL" or "QUOTE").
|
|
102
|
-
*/
|
|
103
|
-
fromObjectType?: 'ABANDONED_CART' | 'ACCEPTANCE_TEST' | 'AD' | 'AD_ACCOUNT' | 'AD_CAMPAIGN' | 'AD_GROUP' | 'AI_FORECAST' | 'ALL_PAGES' | 'APPROVAL' | 'APPROVAL_STEP' | 'ATTRIBUTION' | 'AUDIENCE' | 'AUTOMATION_JOURNEY' | 'AUTOMATION_PLATFORM_FLOW' | 'AUTOMATION_PLATFORM_FLOW_ACTION' | 'BET_ALERT' | 'BET_DELIVERABLE_SERVICE' | 'BLOG_LISTING_PAGE' | 'BLOG_POST' | 'CALL' | 'CAMPAIGN' | 'CAMPAIGN_BUDGET_ITEM' | 'CAMPAIGN_SPEND_ITEM' | 'CAMPAIGN_STEP' | 'CAMPAIGN_TEMPLATE' | 'CAMPAIGN_TEMPLATE_STEP' | 'CART' | 'CASE_STUDY' | 'CHATFLOW' | 'CLIP' | 'CMS_URL' | 'COMBO_EVENT_CONFIGURATION' | 'COMMERCE_PAYMENT' | 'COMMUNICATION' | 'COMPANY' | 'CONTACT' | 'CONTACT_CREATE_ATTRIBUTION' | 'CONTENT' | 'CONTENT_AUDIT' | 'CONTENT_AUDIT_PAGE' | 'CONVERSATION' | 'CONVERSATION_INBOX' | 'CONVERSATION_SESSION' | 'CRM_OBJECTS_DUMMY_TYPE' | 'CRM_PIPELINES_DUMMY_TYPE' | 'CTA' | 'CTA_VARIANT' | 'DATA_PRIVACY_CONSENT' | 'DATA_SYNC_STATE' | 'DEAL' | 'DEAL_CREATE_ATTRIBUTION' | 'DEAL_REGISTRATION' | 'DEAL_SPLIT' | 'DISCOUNT' | 'DISCOUNT_CODE' | 'DISCOUNT_TEMPLATE' | 'EMAIL' | 'ENGAGEMENT' | 'EXPORT' | 'EXTERNAL_WEB_URL' | 'FEE' | 'FEEDBACK_SUBMISSION' | 'FEEDBACK_SURVEY' | 'FILE_MANAGER_FILE' | 'FILE_MANAGER_FOLDER' | 'FOLDER' | 'FORECAST' | 'FORM' | 'FORM_SUBMISSION_INBOUNDDB' | 'GOAL_TARGET' | 'GOAL_TARGET_GROUP' | 'GOAL_TEMPLATE' | 'GSC_PROPERTY' | 'HUB' | 'IMPORT' | 'INVOICE' | 'KEYWORD' | 'KNOWLEDGE_ARTICLE' | 'LANDING_PAGE' | 'LEAD' | 'LINE_ITEM' | 'MARKETING_CALENDAR' | 'MARKETING_CAMPAIGN_UTM' | 'MARKETING_EMAIL' | 'MARKETING_EVENT' | 'MARKETING_EVENT_ATTENDANCE' | 'MARKETING_SMS' | 'MEDIA_BRIDGE' | 'MEETING_EVENT' | 'MIC' | 'NOTE' | 'OBJECT_LIST' | 'ORDER' | 'OWNER' | 'PARTNER_ACCOUNT' | 'PARTNER_CLIENT' | 'PARTNER_CLIENT_REVENUE' | 'PARTNER_SERVICE' | 'PAYMENT_LINK' | 'PAYMENT_SCHEDULE' | 'PAYMENT_SCHEDULE_INSTALLMENT' | 'PERMISSIONS_TESTING' | 'PLAYBOOK' | 'PLAYBOOK_QUESTION' | 'PLAYBOOK_SUBMISSION' | 'PLAYBOOK_SUBMISSION_ANSWER' | 'PLAYLIST' | 'PLAYLIST_FOLDER' | 'PODCAST_EPISODE' | 'PORTAL' | 'PORTAL_OBJECT_SYNC_MESSAGE' | 'POSTAL_MAIL' | 'PRIVACY_SCANNER_COOKIE' | 'PRODUCT' | 'PRODUCT_OR_FOLDER' | 'PROPERTY_INFO' | 'PROSPECTING_AGENT_CONTACT_ASSIGNMENT' | 'PUBLISHING_TASK' | 'QUARANTINED_SUBMISSION' | 'QUOTA' | 'QUOTE' | 'QUOTE_FIELD' | 'QUOTE_MODULE' | 'QUOTE_MODULE_FIELD' | 'QUOTE_TEMPLATE' | 'RESTORABLE_CRM_OBJECT' | 'ROSTER' | 'ROSTER_MEMBER' | 'SALES_DOCUMENT' | 'SALES_TASK' | 'SALES_WORKLOAD' | 'SALESFORCE_SYNC_ERROR' | 'SCHEDULING_PAGE' | 'SCHEMAS_BACKEND_TEST' | 'SCORE_CONFIGURATION' | 'SEQUENCE' | 'SEQUENCE_ENROLLMENT' | 'SEQUENCE_STEP' | 'SEQUENCE_STEP_ENROLLMENT' | 'SERVICE' | 'SITE_PAGE' | 'SNIPPET' | 'SOCIAL_BROADCAST' | 'SOCIAL_CHANNEL' | 'SOCIAL_POST' | 'SOCIAL_PROFILE' | 'SOX_PROTECTED_DUMMY_TYPE' | 'SOX_PROTECTED_TEST_TYPE' | 'SUBMISSION_TAG' | 'SUBSCRIPTION' | 'TASK' | 'TASK_TEMPLATE' | 'TAX' | 'TEMPLATE' | 'TICKET' | 'UNKNOWN' | 'UNSUBSCRIBE' | 'USER' | 'VIEW' | 'VIEW_BLOCK' | 'WEB_INTERACTIVE';
|
|
104
|
-
/**
|
|
105
|
-
* The ID of the source object type (e.g., 0-1 for contacts).
|
|
106
|
-
*/
|
|
107
|
-
fromObjectTypeId: string;
|
|
108
|
-
/**
|
|
109
|
-
* Whether all potential linked objects are included in the association
|
|
110
|
-
*/
|
|
111
|
-
hasAllAssociatedObjects: boolean;
|
|
112
|
-
/**
|
|
113
|
-
* Whether deletions in the association should cause cascading deletes to linked objects.
|
|
114
|
-
*/
|
|
115
|
-
hasCascadingDeletes: boolean;
|
|
116
|
-
/**
|
|
117
|
-
* Whether a user has set a limit for the number of source objects.
|
|
118
|
-
*/
|
|
119
|
-
hasUserEnforcedMaxFromObjectIds: boolean;
|
|
120
|
-
/**
|
|
121
|
-
* Whether a user has set a limit for the number of destination objects.
|
|
122
|
-
*/
|
|
123
|
-
hasUserEnforcedMaxToObjectIds: boolean;
|
|
124
|
-
/**
|
|
125
|
-
* Whether the association is hidden or not.
|
|
126
|
-
*/
|
|
127
|
-
hidden: boolean;
|
|
128
|
-
hiddenReason?: 'DEFAULT' | 'INTERNAL' | 'USER_CONFIGURED';
|
|
129
|
-
/**
|
|
130
|
-
* The unique ID of the associated object (e.g., a contact ID).
|
|
131
|
-
*/
|
|
132
|
-
id: number;
|
|
133
|
-
/**
|
|
134
|
-
* Whether the reverse association can also support custom labels.
|
|
135
|
-
*/
|
|
136
|
-
inverseAllowsCustomLabels: boolean;
|
|
137
|
-
/**
|
|
138
|
-
* The cardinality from the destination object's perspective, either "ONE_TO_ONE" or "ONE_TO_MANY".
|
|
139
|
-
*/
|
|
140
|
-
inverseCardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE';
|
|
141
|
-
/**
|
|
142
|
-
* Whether all potential reverse linked objects are included in the association.
|
|
143
|
-
*/
|
|
144
|
-
inverseHasAllAssociatedObjects: boolean;
|
|
145
|
-
/**
|
|
146
|
-
* The unique ID for the inverse side of the association.
|
|
147
|
-
*/
|
|
148
|
-
inverseId: number;
|
|
149
|
-
/**
|
|
150
|
-
* The label used to describe the reverse relationship in an association.
|
|
151
|
-
*/
|
|
152
|
-
inverseLabel?: string;
|
|
153
|
-
/**
|
|
154
|
-
* The name used to describe the inverse relationship in this association
|
|
155
|
-
*/
|
|
156
|
-
inverseName: string;
|
|
157
|
-
isDefault: boolean;
|
|
158
|
-
/**
|
|
159
|
-
* Whether the inverse association is considered primary.
|
|
160
|
-
*/
|
|
161
|
-
isInversePrimary: boolean;
|
|
162
|
-
/**
|
|
163
|
-
* Whether the association is the primary link between the entities involved.
|
|
164
|
-
*/
|
|
165
|
-
isPrimary: boolean;
|
|
166
|
-
/**
|
|
167
|
-
* The label given to an association.
|
|
168
|
-
*/
|
|
169
|
-
label?: string;
|
|
170
|
-
/**
|
|
171
|
-
* The maximum number of source object IDs allowed in the association.
|
|
172
|
-
*/
|
|
173
|
-
maxFromObjectIds: number;
|
|
174
|
-
/**
|
|
175
|
-
* The maximum number of destination object IDs allowed in the association.
|
|
176
|
-
*/
|
|
177
|
-
maxToObjectIds: number;
|
|
178
|
-
/**
|
|
179
|
-
* For labeled association types, the internal name of the association.
|
|
180
|
-
*/
|
|
181
|
-
name: string;
|
|
182
|
-
/**
|
|
183
|
-
* A unique across-portal ID applied to the association.
|
|
184
|
-
*/
|
|
185
|
-
portalUniqueIdentifier: string;
|
|
186
|
-
readOnly: boolean;
|
|
187
|
-
/**
|
|
188
|
-
* The name of the destination object type (e.g,. "DEAL" or "QUOTE").
|
|
189
|
-
*/
|
|
190
|
-
toObjectType?: 'ABANDONED_CART' | 'ACCEPTANCE_TEST' | 'AD' | 'AD_ACCOUNT' | 'AD_CAMPAIGN' | 'AD_GROUP' | 'AI_FORECAST' | 'ALL_PAGES' | 'APPROVAL' | 'APPROVAL_STEP' | 'ATTRIBUTION' | 'AUDIENCE' | 'AUTOMATION_JOURNEY' | 'AUTOMATION_PLATFORM_FLOW' | 'AUTOMATION_PLATFORM_FLOW_ACTION' | 'BET_ALERT' | 'BET_DELIVERABLE_SERVICE' | 'BLOG_LISTING_PAGE' | 'BLOG_POST' | 'CALL' | 'CAMPAIGN' | 'CAMPAIGN_BUDGET_ITEM' | 'CAMPAIGN_SPEND_ITEM' | 'CAMPAIGN_STEP' | 'CAMPAIGN_TEMPLATE' | 'CAMPAIGN_TEMPLATE_STEP' | 'CART' | 'CASE_STUDY' | 'CHATFLOW' | 'CLIP' | 'CMS_URL' | 'COMBO_EVENT_CONFIGURATION' | 'COMMERCE_PAYMENT' | 'COMMUNICATION' | 'COMPANY' | 'CONTACT' | 'CONTACT_CREATE_ATTRIBUTION' | 'CONTENT' | 'CONTENT_AUDIT' | 'CONTENT_AUDIT_PAGE' | 'CONVERSATION' | 'CONVERSATION_INBOX' | 'CONVERSATION_SESSION' | 'CRM_OBJECTS_DUMMY_TYPE' | 'CRM_PIPELINES_DUMMY_TYPE' | 'CTA' | 'CTA_VARIANT' | 'DATA_PRIVACY_CONSENT' | 'DATA_SYNC_STATE' | 'DEAL' | 'DEAL_CREATE_ATTRIBUTION' | 'DEAL_REGISTRATION' | 'DEAL_SPLIT' | 'DISCOUNT' | 'DISCOUNT_CODE' | 'DISCOUNT_TEMPLATE' | 'EMAIL' | 'ENGAGEMENT' | 'EXPORT' | 'EXTERNAL_WEB_URL' | 'FEE' | 'FEEDBACK_SUBMISSION' | 'FEEDBACK_SURVEY' | 'FILE_MANAGER_FILE' | 'FILE_MANAGER_FOLDER' | 'FOLDER' | 'FORECAST' | 'FORM' | 'FORM_SUBMISSION_INBOUNDDB' | 'GOAL_TARGET' | 'GOAL_TARGET_GROUP' | 'GOAL_TEMPLATE' | 'GSC_PROPERTY' | 'HUB' | 'IMPORT' | 'INVOICE' | 'KEYWORD' | 'KNOWLEDGE_ARTICLE' | 'LANDING_PAGE' | 'LEAD' | 'LINE_ITEM' | 'MARKETING_CALENDAR' | 'MARKETING_CAMPAIGN_UTM' | 'MARKETING_EMAIL' | 'MARKETING_EVENT' | 'MARKETING_EVENT_ATTENDANCE' | 'MARKETING_SMS' | 'MEDIA_BRIDGE' | 'MEETING_EVENT' | 'MIC' | 'NOTE' | 'OBJECT_LIST' | 'ORDER' | 'OWNER' | 'PARTNER_ACCOUNT' | 'PARTNER_CLIENT' | 'PARTNER_CLIENT_REVENUE' | 'PARTNER_SERVICE' | 'PAYMENT_LINK' | 'PAYMENT_SCHEDULE' | 'PAYMENT_SCHEDULE_INSTALLMENT' | 'PERMISSIONS_TESTING' | 'PLAYBOOK' | 'PLAYBOOK_QUESTION' | 'PLAYBOOK_SUBMISSION' | 'PLAYBOOK_SUBMISSION_ANSWER' | 'PLAYLIST' | 'PLAYLIST_FOLDER' | 'PODCAST_EPISODE' | 'PORTAL' | 'PORTAL_OBJECT_SYNC_MESSAGE' | 'POSTAL_MAIL' | 'PRIVACY_SCANNER_COOKIE' | 'PRODUCT' | 'PRODUCT_OR_FOLDER' | 'PROPERTY_INFO' | 'PROSPECTING_AGENT_CONTACT_ASSIGNMENT' | 'PUBLISHING_TASK' | 'QUARANTINED_SUBMISSION' | 'QUOTA' | 'QUOTE' | 'QUOTE_FIELD' | 'QUOTE_MODULE' | 'QUOTE_MODULE_FIELD' | 'QUOTE_TEMPLATE' | 'RESTORABLE_CRM_OBJECT' | 'ROSTER' | 'ROSTER_MEMBER' | 'SALES_DOCUMENT' | 'SALES_TASK' | 'SALES_WORKLOAD' | 'SALESFORCE_SYNC_ERROR' | 'SCHEDULING_PAGE' | 'SCHEMAS_BACKEND_TEST' | 'SCORE_CONFIGURATION' | 'SEQUENCE' | 'SEQUENCE_ENROLLMENT' | 'SEQUENCE_STEP' | 'SEQUENCE_STEP_ENROLLMENT' | 'SERVICE' | 'SITE_PAGE' | 'SNIPPET' | 'SOCIAL_BROADCAST' | 'SOCIAL_CHANNEL' | 'SOCIAL_POST' | 'SOCIAL_PROFILE' | 'SOX_PROTECTED_DUMMY_TYPE' | 'SOX_PROTECTED_TEST_TYPE' | 'SUBMISSION_TAG' | 'SUBSCRIPTION' | 'TASK' | 'TASK_TEMPLATE' | 'TAX' | 'TEMPLATE' | 'TICKET' | 'UNKNOWN' | 'UNSUBSCRIBE' | 'USER' | 'VIEW' | 'VIEW_BLOCK' | 'WEB_INTERACTIVE';
|
|
191
|
-
/**
|
|
192
|
-
* The ID of the destination object type (e.g., 0-3 for deals).
|
|
193
|
-
*/
|
|
194
|
-
toObjectTypeId: string;
|
|
195
|
-
}
|
|
196
|
-
interface BatchedBehavioralEventHttpCompletionRequest {
|
|
197
|
-
inputs: Schemas.BehavioralEventHttpCompletionRequest[];
|
|
198
|
-
}
|
|
199
|
-
interface BehavioralEventHttpCompletionRequest {
|
|
200
|
-
/**
|
|
201
|
-
* Email of visitor
|
|
202
|
-
*/
|
|
203
|
-
email?: string;
|
|
204
|
-
/**
|
|
205
|
-
* Internal name of the event-type to trigger
|
|
206
|
-
*/
|
|
207
|
-
eventName: string;
|
|
208
|
-
/**
|
|
209
|
-
* The object id that this event occurred on. Could be a contact id or a visitor id.
|
|
210
|
-
*/
|
|
211
|
-
objectId?: string;
|
|
212
|
-
/**
|
|
213
|
-
* The time when this event occurred (if any). If this isn't set, the current time will be used
|
|
214
|
-
*/
|
|
215
|
-
occurredAt?: string;
|
|
216
|
-
/**
|
|
217
|
-
* Map of properties for the event in the format property internal name - property value
|
|
218
|
-
*/
|
|
219
|
-
properties: Record<string, string>;
|
|
220
|
-
/**
|
|
221
|
-
* User token
|
|
222
|
-
*/
|
|
223
|
-
utk?: string;
|
|
224
|
-
uuid?: string;
|
|
225
|
-
}
|
|
226
|
-
interface BehavioralEventTypeDefinitionLabels {
|
|
227
|
-
plural?: string;
|
|
228
|
-
singular: string;
|
|
229
|
-
}
|
|
230
|
-
interface BoolPropertyOperation {
|
|
231
|
-
defaultValue?: string;
|
|
232
|
-
includeObjectsWithNoValueSet: boolean;
|
|
233
|
-
operationType: string;
|
|
234
|
-
operator: 'HAS_EVER_BEEN_EQUAL_TO' | 'HAS_NEVER_BEEN_EQUAL_TO' | 'IS_EQUAL_TO' | 'IS_NOT_EQUAL_TO';
|
|
235
|
-
operatorName: string;
|
|
236
|
-
propertyType: 'bool';
|
|
237
|
-
renderSpec?: string;
|
|
238
|
-
value: boolean;
|
|
239
|
-
}
|
|
240
|
-
interface CalendarDatePropertyOperation {
|
|
241
|
-
defaultValue?: string;
|
|
242
|
-
fiscalYearStart?: 'APRIL' | 'AUGUST' | 'DECEMBER' | 'FEBRUARY' | 'JANUARY' | 'JULY' | 'JUNE' | 'MARCH' | 'MAY' | 'NOVEMBER' | 'OCTOBER' | 'SEPTEMBER';
|
|
243
|
-
includeObjectsWithNoValueSet: boolean;
|
|
244
|
-
operationType: string;
|
|
245
|
-
operator: 'IN_LAST_TIME_UNIT' | 'IN_NEXT_TIME_UNIT' | 'IN_THIS_TIME_UNIT' | 'IN_THIS_TIME_UNIT_SO_FAR';
|
|
246
|
-
operatorName: string;
|
|
247
|
-
propertyType: 'calendar-date';
|
|
248
|
-
renderSpec?: string;
|
|
249
|
-
timeUnit: 'DAY' | 'MONTH' | 'QUARTER' | 'WEEK' | 'YEAR';
|
|
250
|
-
timeUnitCount: number;
|
|
251
|
-
useFiscalYear: boolean;
|
|
252
|
-
}
|
|
253
|
-
interface CollectionResponseWithTotalExternalBehavioralEventTypeDefinition {
|
|
254
|
-
paging?: Schemas.Paging;
|
|
255
|
-
results: Schemas.ExternalBehavioralEventTypeDefinition[];
|
|
256
|
-
total: number;
|
|
257
|
-
}
|
|
258
|
-
interface ComboEventRule {
|
|
259
|
-
count: number;
|
|
260
|
-
eventTypeId: string;
|
|
261
|
-
lookbackWindowDays?: number;
|
|
262
|
-
propertyFilters: Schemas.PropertyFilter[];
|
|
263
|
-
}
|
|
264
|
-
interface ComboEventRuleBranch {
|
|
265
|
-
composingRules: Schemas.ComboEventRule[];
|
|
266
|
-
operationType: 'AND' | 'OR';
|
|
267
|
-
ruleBranches: Schemas.ComboEventRuleBranch[];
|
|
268
|
-
}
|
|
269
|
-
interface ComparativeBoolPropertyOperation {
|
|
270
|
-
comparisonPropertyName: string;
|
|
271
|
-
defaultValue?: string;
|
|
272
|
-
includeObjectsWithNoValueSet: boolean;
|
|
273
|
-
operationType: string;
|
|
274
|
-
operator: 'IS_EQUAL_TO' | 'IS_NOT_EQUAL_TO';
|
|
275
|
-
operatorName: string;
|
|
276
|
-
propertyType: 'bool-comparative';
|
|
277
|
-
renderSpec?: string;
|
|
278
|
-
}
|
|
279
|
-
interface ComparativeDatePropertyOperation {
|
|
280
|
-
comparisonPropertyName: string;
|
|
281
|
-
defaultComparisonValue?: string;
|
|
282
|
-
defaultValue?: string;
|
|
283
|
-
includeObjectsWithNoValueSet: boolean;
|
|
284
|
-
operationType: string;
|
|
285
|
-
operator: 'IS_AFTER' | 'IS_BEFORE';
|
|
286
|
-
operatorName: string;
|
|
287
|
-
propertyType: 'datetime-comparative';
|
|
288
|
-
renderSpec?: string;
|
|
289
|
-
}
|
|
290
|
-
interface ComparativeNumberPropertyOperation {
|
|
291
|
-
comparisonPropertyName: string;
|
|
292
|
-
defaultValue?: string;
|
|
293
|
-
includeObjectsWithNoValueSet: boolean;
|
|
294
|
-
operationType: string;
|
|
295
|
-
operator: 'IS_EQUAL_TO' | 'IS_GREATER_THAN' | 'IS_GREATER_THAN_OR_EQUAL_TO' | 'IS_LESS_THAN' | 'IS_LESS_THAN_OR_EQUAL_TO' | 'IS_NOT_EQUAL_TO';
|
|
296
|
-
operatorName: string;
|
|
297
|
-
propertyType: 'number-comparative';
|
|
298
|
-
renderSpec?: string;
|
|
299
|
-
}
|
|
300
|
-
interface ComparativePropertyUpdatedOperation {
|
|
301
|
-
comparisonPropertyName: string;
|
|
302
|
-
defaultComparisonValue?: string;
|
|
303
|
-
defaultValue?: string;
|
|
304
|
-
includeObjectsWithNoValueSet: boolean;
|
|
305
|
-
operationType: string;
|
|
306
|
-
operator: 'IS_AFTER' | 'IS_BEFORE';
|
|
307
|
-
operatorName: string;
|
|
308
|
-
propertyType: 'property-updated-comparative';
|
|
309
|
-
renderSpec?: string;
|
|
310
|
-
}
|
|
311
|
-
interface ComparativeStringPropertyOperation {
|
|
312
|
-
comparisonPropertyName: string;
|
|
313
|
-
defaultValue?: string;
|
|
314
|
-
includeObjectsWithNoValueSet: boolean;
|
|
315
|
-
operationType: string;
|
|
316
|
-
operator: 'CONTAINS' | 'DOES_NOT_CONTAIN' | 'ENDS_WITH' | 'IS_EQUAL_TO' | 'IS_NOT_EQUAL_TO' | 'STARTS_WITH';
|
|
317
|
-
operatorName: string;
|
|
318
|
-
propertyType: 'string-comparative';
|
|
319
|
-
renderSpec?: string;
|
|
320
|
-
}
|
|
321
|
-
interface DatePoint {
|
|
322
|
-
day: number;
|
|
323
|
-
hour?: number;
|
|
324
|
-
millisecond?: number;
|
|
325
|
-
minute?: number;
|
|
326
|
-
month: number;
|
|
327
|
-
second?: number;
|
|
328
|
-
timeType: 'DATE';
|
|
329
|
-
timezoneSource: 'CUSTOM' | 'PORTAL' | 'USER';
|
|
330
|
-
year: number;
|
|
331
|
-
zoneId: string;
|
|
332
|
-
}
|
|
333
|
-
interface DatePropertyOperation {
|
|
334
|
-
day: number;
|
|
335
|
-
defaultValue?: string;
|
|
336
|
-
includeObjectsWithNoValueSet: boolean;
|
|
337
|
-
month: 'APR' | 'AUG' | 'DEC' | 'FEB' | 'JAN' | 'JUL' | 'JUN' | 'MAR' | 'MAY' | 'NOV' | 'OCT' | 'SEP';
|
|
338
|
-
operationType: string;
|
|
339
|
-
operator: 'AFTER' | 'BEFORE' | 'EQUAL';
|
|
340
|
-
operatorName: string;
|
|
341
|
-
propertyType: 'date';
|
|
342
|
-
renderSpec?: string;
|
|
343
|
-
year: number;
|
|
344
|
-
}
|
|
345
|
-
interface DateTimePropertyOperation {
|
|
346
|
-
defaultValue?: string;
|
|
347
|
-
includeObjectsWithNoValueSet: boolean;
|
|
348
|
-
operationType: string;
|
|
349
|
-
operator: 'IS_AFTER' | 'IS_AFTER_DATE' | 'IS_BEFORE' | 'IS_BEFORE_DATE' | 'IS_EQUAL_TO';
|
|
350
|
-
operatorName: string;
|
|
351
|
-
propertyType: 'datetime';
|
|
352
|
-
renderSpec?: string;
|
|
353
|
-
requiresTimeZoneConversion: boolean;
|
|
354
|
-
timestamp: number;
|
|
355
|
-
}
|
|
356
|
-
interface EnumerationPropertyOperation {
|
|
357
|
-
defaultValue?: string;
|
|
358
|
-
includeObjectsWithNoValueSet: boolean;
|
|
359
|
-
operationType: string;
|
|
360
|
-
operator: 'CONTAINS_ALL' | 'DOES_NOT_CONTAIN_ALL' | 'HAS_EVER_BEEN_ANY_OF' | 'HAS_EVER_BEEN_EXACTLY' | 'HAS_EVER_CONTAINED_ALL' | 'HAS_NEVER_BEEN_ANY_OF' | 'HAS_NEVER_BEEN_EXACTLY' | 'HAS_NEVER_CONTAINED_ALL' | 'IS_ANY_OF' | 'IS_EXACTLY' | 'IS_NONE_OF' | 'IS_NOT_EXACTLY';
|
|
361
|
-
operatorName: string;
|
|
362
|
-
propertyType: 'enumeration';
|
|
363
|
-
renderSpec?: string;
|
|
364
|
-
values: string[];
|
|
365
|
-
}
|
|
366
|
-
interface ExternalBehavioralEventPropertyCreate {
|
|
367
|
-
/**
|
|
368
|
-
* A description of the property that will be shown as help text in HubSpot.
|
|
369
|
-
*/
|
|
370
|
-
description?: string;
|
|
371
|
-
/**
|
|
372
|
-
* Human readable label for the property. Used in HubSpot UI
|
|
373
|
-
*/
|
|
374
|
-
label: string;
|
|
375
|
-
/**
|
|
376
|
-
* Internal property name, which must be used when referencing the property from the API
|
|
377
|
-
*/
|
|
378
|
-
name?: string;
|
|
379
|
-
/**
|
|
380
|
-
* A list of available options for the property if it is an enumeration. NOTE: This field is only applicable for enumerated properties.
|
|
381
|
-
*/
|
|
382
|
-
options?: Schemas.OptionInput[];
|
|
383
|
-
/**
|
|
384
|
-
* The data type of the property. Can be one of the following: [string, number, enumeration, datetime]
|
|
385
|
-
*/
|
|
386
|
-
type: string;
|
|
387
|
-
}
|
|
388
|
-
interface ExternalBehavioralEventPropertyDefinitionPatch {
|
|
389
|
-
/**
|
|
390
|
-
* A description of the property that will be shown as help text in HubSpot.
|
|
391
|
-
*/
|
|
392
|
-
description?: string;
|
|
393
|
-
/**
|
|
394
|
-
* Human readable label for the property. Used in HubSpot UI
|
|
395
|
-
*/
|
|
396
|
-
label?: string;
|
|
397
|
-
/**
|
|
398
|
-
* A list of available options for the property if it is an enumeration. NOTE: This field is only applicable for enumerated properties.
|
|
399
|
-
*/
|
|
400
|
-
options?: Schemas.OptionInput[];
|
|
401
|
-
}
|
|
402
|
-
interface ExternalBehavioralEventTypeDefinition {
|
|
403
|
-
archived: boolean;
|
|
404
|
-
associations: Schemas.AssociationDefinition[];
|
|
405
|
-
comboEventRules?: Schemas.ComboEventRuleBranch;
|
|
406
|
-
createdAt?: string;
|
|
407
|
-
createdUserId?: number;
|
|
408
|
-
customMatchingId?: Schemas.ExternalObjectResolutionMappingResponse;
|
|
409
|
-
description?: string;
|
|
410
|
-
detailTemplate?: string;
|
|
411
|
-
fullyQualifiedName: string;
|
|
412
|
-
headerTemplate?: string;
|
|
413
|
-
id: string;
|
|
414
|
-
labels: Schemas.BehavioralEventTypeDefinitionLabels;
|
|
415
|
-
name: string;
|
|
416
|
-
objectTypeId: string;
|
|
417
|
-
primaryObject?: string;
|
|
418
|
-
primaryObjectId?: string;
|
|
419
|
-
properties: Schemas.Property[];
|
|
420
|
-
trackingType?: 'APP_EVENT' | 'AUTOCAPTURE_EVENT' | 'CLICKED_ELEMENT' | 'COMBO_EVENT' | 'CUSTOM_SCRIPT' | 'CUSTOM_SIGNAL' | 'IMPORT' | 'MANUAL' | 'PROPERTY_CHANGE' | 'VISITED_URL' | 'WEBHOOK';
|
|
421
|
-
updatedAt?: string;
|
|
422
|
-
updatedUserId?: number;
|
|
423
|
-
}
|
|
424
|
-
interface ExternalBehavioralEventTypeDefinitionEgg {
|
|
425
|
-
customMatchingId?: Schemas.ExternalObjectResolutionMappingRequest;
|
|
426
|
-
/**
|
|
427
|
-
* A description of the event that will be shown as help text in HubSpot.
|
|
428
|
-
*/
|
|
429
|
-
description?: string;
|
|
430
|
-
includeDefaultProperties: boolean;
|
|
431
|
-
/**
|
|
432
|
-
* Human readable label for the event. Used in HubSpot UI
|
|
433
|
-
*/
|
|
434
|
-
label: string;
|
|
435
|
-
/**
|
|
436
|
-
* Internal event name, which must be used when referencing the event from this event definitions API. If a name is not supplied, one will be generated based on the label. The `name` value will also be used to automatically generate a `fullyQualifiedName` for the event definition, which you'll use when sending event completions to this event.
|
|
437
|
-
*/
|
|
438
|
-
name?: string;
|
|
439
|
-
/**
|
|
440
|
-
* The object type to associate this event to. Can be one of CONTACT, COMPANY, DEAL, TICKET. If no primaryObject is supplied, we will default to associating the event to CONTACT objects.
|
|
441
|
-
*/
|
|
442
|
-
primaryObject?: string;
|
|
443
|
-
/**
|
|
444
|
-
* List of custom properties on event
|
|
445
|
-
*/
|
|
446
|
-
propertyDefinitions: Schemas.ExternalBehavioralEventPropertyCreate[];
|
|
447
|
-
}
|
|
448
|
-
interface ExternalBehavioralEventTypeDefinitionPatch {
|
|
449
|
-
/**
|
|
450
|
-
* A description of the event that will be shown as help text in HubSpot.
|
|
451
|
-
*/
|
|
452
|
-
description?: string;
|
|
453
|
-
/**
|
|
454
|
-
* Human readable label for the event. Used in HubSpot UI
|
|
455
|
-
*/
|
|
456
|
-
label?: string;
|
|
457
|
-
}
|
|
458
|
-
interface ExternalObjectResolutionMappingRequest {
|
|
459
|
-
primaryObjectRule: Schemas.ExternalPrimaryObjectResolutionRule;
|
|
460
|
-
}
|
|
461
|
-
interface ExternalObjectResolutionMappingResponse {
|
|
462
|
-
primaryObjectRule: Schemas.ExternalPrimaryObjectResolutionRule;
|
|
463
|
-
}
|
|
464
|
-
interface ExternalPrimaryObjectResolutionRule {
|
|
465
|
-
eventPropertyName: string;
|
|
466
|
-
targetObjectPropertyName: string;
|
|
467
|
-
}
|
|
468
|
-
interface FiscalQuarter {
|
|
469
|
-
day: number;
|
|
470
|
-
hour?: number;
|
|
471
|
-
millisecond?: number;
|
|
472
|
-
minute?: number;
|
|
473
|
-
month: number;
|
|
474
|
-
referenceType: 'FISCAL_QUARTER';
|
|
475
|
-
second?: number;
|
|
476
|
-
}
|
|
477
|
-
interface FiscalYear {
|
|
478
|
-
day: number;
|
|
479
|
-
hour?: number;
|
|
480
|
-
millisecond?: number;
|
|
481
|
-
minute?: number;
|
|
482
|
-
month: number;
|
|
483
|
-
referenceType: 'FISCAL_YEAR';
|
|
484
|
-
second?: number;
|
|
485
|
-
}
|
|
486
|
-
interface IndexedTimePoint {
|
|
487
|
-
indexReference: Schemas.NowReference | Schemas.TodayReference | Schemas.WeekReference | Schemas.MonthReference | Schemas.QuarterReference | Schemas.FiscalQuarter | Schemas.YearReference | Schemas.FiscalYear;
|
|
488
|
-
offset?: Schemas.IndexOffset;
|
|
489
|
-
shouldGenerateRefreshTime?: boolean;
|
|
490
|
-
timeType: 'INDEXED';
|
|
491
|
-
timezoneSource: 'CUSTOM' | 'PORTAL' | 'USER';
|
|
492
|
-
zoneId: string;
|
|
493
|
-
}
|
|
494
|
-
interface IndexOffset {
|
|
495
|
-
days?: number;
|
|
496
|
-
hours?: number;
|
|
497
|
-
milliseconds?: number;
|
|
498
|
-
minutes?: number;
|
|
499
|
-
months?: number;
|
|
500
|
-
quarters?: number;
|
|
501
|
-
seconds?: number;
|
|
502
|
-
weeks?: number;
|
|
503
|
-
years?: number;
|
|
504
|
-
}
|
|
505
|
-
interface MonthReference {
|
|
506
|
-
day: number;
|
|
507
|
-
hour?: number;
|
|
508
|
-
millisecond?: number;
|
|
509
|
-
minute?: number;
|
|
510
|
-
referenceType: 'MONTH';
|
|
511
|
-
second?: number;
|
|
512
|
-
}
|
|
513
|
-
interface MultiStringPropertyOperation {
|
|
514
|
-
coalescingRefineBy: Schemas.NumOccurrencesRefineBy | Schemas.SetOccurrencesRefineBy;
|
|
515
|
-
defaultValue?: string;
|
|
516
|
-
includeObjectsWithNoValueSet: boolean;
|
|
517
|
-
operationType: string;
|
|
518
|
-
operator: 'CONTAINS' | 'CONTAINS_EXACTLY' | 'DOES_NOT_CONTAIN' | 'DOES_NOT_CONTAIN_EXACTLY' | 'ENDS_WITH' | 'IS_EQUAL_TO' | 'IS_NOT_EQUAL_TO' | 'STARTS_WITH';
|
|
519
|
-
operatorName: string;
|
|
520
|
-
propertyType: 'multistring';
|
|
521
|
-
pruningRefineBy?: Schemas.RelativeComparativeTimestampRefineBy | Schemas.RelativeRangedTimestampRefineBy | Schemas.AbsoluteComparativeTimestampRefineBy | Schemas.AbsoluteRangedTimestampRefineBy | Schemas.AllHistoryRefineBy | Schemas.TimePointOperation | Schemas.RangedTimeOperation;
|
|
522
|
-
renderSpec?: string;
|
|
523
|
-
values: string[];
|
|
524
|
-
}
|
|
525
|
-
/**
|
|
526
|
-
* Specifies the paging information needed to retrieve the next set of results in a paginated API response
|
|
527
|
-
*/
|
|
528
|
-
interface NextPage {
|
|
529
|
-
/**
|
|
530
|
-
* A paging cursor token for retrieving subsequent pages.
|
|
531
|
-
*/
|
|
532
|
-
after: string;
|
|
533
|
-
/**
|
|
534
|
-
* A URL that can be used to retrieve the next page results.
|
|
535
|
-
*/
|
|
536
|
-
link?: string;
|
|
537
|
-
}
|
|
538
|
-
interface NowReference {
|
|
539
|
-
hour?: number;
|
|
540
|
-
millisecond?: number;
|
|
541
|
-
minute?: number;
|
|
542
|
-
referenceType: 'NOW';
|
|
543
|
-
second?: number;
|
|
544
|
-
}
|
|
545
|
-
interface NumberPropertyOperation {
|
|
546
|
-
defaultValue?: string;
|
|
547
|
-
includeObjectsWithNoValueSet: boolean;
|
|
548
|
-
operationType: string;
|
|
549
|
-
operator: 'HAS_EVER_BEEN_EQUAL_TO' | 'HAS_NEVER_BEEN_EQUAL_TO' | 'IS_EQUAL_TO' | 'IS_GREATER_THAN' | 'IS_GREATER_THAN_OR_EQUAL_TO' | 'IS_LESS_THAN' | 'IS_LESS_THAN_OR_EQUAL_TO' | 'IS_NOT_EQUAL_TO';
|
|
550
|
-
operatorName: string;
|
|
551
|
-
propertyType: 'number';
|
|
552
|
-
renderSpec?: string;
|
|
553
|
-
value: number;
|
|
554
|
-
}
|
|
555
|
-
interface NumOccurrencesRefineBy {
|
|
556
|
-
maxOccurrences?: number;
|
|
557
|
-
minOccurrences?: number;
|
|
558
|
-
type: 'NumOccurrencesRefineBy';
|
|
559
|
-
}
|
|
560
|
-
/**
|
|
561
|
-
* A HubSpot property option
|
|
562
|
-
*/
|
|
563
|
-
interface Option {
|
|
564
|
-
/**
|
|
565
|
-
* A description of the option.
|
|
566
|
-
*/
|
|
567
|
-
description?: string;
|
|
568
|
-
/**
|
|
569
|
-
* The position of the item relative to others in the list.
|
|
570
|
-
*/
|
|
571
|
-
displayOrder?: number;
|
|
572
|
-
/**
|
|
573
|
-
* Whether the option is displayed in HubSpot's UI.
|
|
574
|
-
*/
|
|
575
|
-
hidden: boolean;
|
|
576
|
-
/**
|
|
577
|
-
* A user-friendly label that identifies the option.
|
|
578
|
-
*/
|
|
579
|
-
label: string;
|
|
580
|
-
/**
|
|
581
|
-
* The actual value of the option.
|
|
582
|
-
*/
|
|
583
|
-
value: string;
|
|
584
|
-
}
|
|
585
|
-
interface OptionInput {
|
|
586
|
-
/**
|
|
587
|
-
* null
|
|
588
|
-
*/
|
|
589
|
-
description?: string;
|
|
590
|
-
displayOrder: number;
|
|
591
|
-
hidden: boolean;
|
|
592
|
-
/**
|
|
593
|
-
* null
|
|
594
|
-
*/
|
|
595
|
-
label: string;
|
|
596
|
-
/**
|
|
597
|
-
* null
|
|
598
|
-
*/
|
|
599
|
-
value: string;
|
|
600
|
-
}
|
|
601
|
-
interface Paging {
|
|
602
|
-
next?: Schemas.NextPage;
|
|
603
|
-
prev?: Schemas.PreviousPage;
|
|
604
|
-
}
|
|
605
|
-
/**
|
|
606
|
-
* specifies the paging information needed to retrieve the previous set of results in a paginated API response
|
|
607
|
-
*/
|
|
608
|
-
interface PreviousPage {
|
|
609
|
-
/**
|
|
610
|
-
* A paging cursor token for retrieving previous pages.
|
|
611
|
-
*/
|
|
612
|
-
before: string;
|
|
613
|
-
/**
|
|
614
|
-
* A URL that can be used to retrieve the previous pages' results.
|
|
615
|
-
*/
|
|
616
|
-
link?: string;
|
|
617
|
-
}
|
|
618
|
-
/**
|
|
619
|
-
* A HubSpot property
|
|
620
|
-
*/
|
|
621
|
-
interface Property {
|
|
622
|
-
/**
|
|
623
|
-
* Whether the property is archived.
|
|
624
|
-
*/
|
|
625
|
-
archived?: boolean;
|
|
626
|
-
/**
|
|
627
|
-
* The timestamp when the property was archived, in ISO 8601 format.
|
|
628
|
-
*/
|
|
629
|
-
archivedAt?: string;
|
|
630
|
-
/**
|
|
631
|
-
* Whether the property is a calculated field.
|
|
632
|
-
*/
|
|
633
|
-
calculated?: boolean;
|
|
634
|
-
/**
|
|
635
|
-
* The formula used for calculated properties.
|
|
636
|
-
*/
|
|
637
|
-
calculationFormula?: string;
|
|
638
|
-
/**
|
|
639
|
-
* The timestamp when the property was created, in ISO 8601 format.
|
|
640
|
-
*/
|
|
641
|
-
createdAt?: string;
|
|
642
|
-
/**
|
|
643
|
-
* The ID of the user who created the property.
|
|
644
|
-
*/
|
|
645
|
-
createdUserId?: string;
|
|
646
|
-
/**
|
|
647
|
-
* The name of the related currency property.
|
|
648
|
-
*/
|
|
649
|
-
currencyPropertyName?: string;
|
|
650
|
-
/**
|
|
651
|
-
* Indicates the sensitivity level of the property, such as "non_sensitive", "sensitive", or "highly_sensitive".
|
|
652
|
-
*/
|
|
653
|
-
dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive';
|
|
654
|
-
dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until';
|
|
655
|
-
/**
|
|
656
|
-
* A summary of the property's purpose.
|
|
657
|
-
*/
|
|
658
|
-
description: string;
|
|
659
|
-
/**
|
|
660
|
-
* The position of the item relative to others in the list.
|
|
661
|
-
*/
|
|
662
|
-
displayOrder?: number;
|
|
663
|
-
/**
|
|
664
|
-
* Applicable only for enumeration type properties. Should be set to true with a 'referencedObjectType' of 'OWNER'. Otherwise false.
|
|
665
|
-
*/
|
|
666
|
-
externalOptions?: boolean;
|
|
667
|
-
/**
|
|
668
|
-
* Determines how the property will appear in HubSpot's UI or on a form. Learn more in the properties API guide.
|
|
669
|
-
*/
|
|
670
|
-
fieldType: string;
|
|
671
|
-
/**
|
|
672
|
-
* Whether the property can appear on forms.
|
|
673
|
-
*/
|
|
674
|
-
formField?: boolean;
|
|
675
|
-
/**
|
|
676
|
-
* The name of the group to which the property is assigned.
|
|
677
|
-
*/
|
|
678
|
-
groupName: string;
|
|
679
|
-
/**
|
|
680
|
-
* Whether the property is a unique identifier property.
|
|
681
|
-
*/
|
|
682
|
-
hasUniqueValue?: boolean;
|
|
683
|
-
/**
|
|
684
|
-
* Whether or not the property will be hidden from the HubSpot UI. It's recommended that this be set to false for custom properties.
|
|
685
|
-
*/
|
|
686
|
-
hidden?: boolean;
|
|
687
|
-
/**
|
|
688
|
-
* A boolean value set to true for HubSpot default properties.
|
|
689
|
-
*/
|
|
690
|
-
hubspotDefined?: boolean;
|
|
691
|
-
/**
|
|
692
|
-
* The display label for the property.
|
|
693
|
-
*/
|
|
694
|
-
label: string;
|
|
695
|
-
modificationMetadata?: Schemas.PropertyModificationMetadata;
|
|
696
|
-
/**
|
|
697
|
-
* The internal name for the property.
|
|
698
|
-
*/
|
|
699
|
-
name: string;
|
|
700
|
-
/**
|
|
701
|
-
* Hint for how a number property is displayed and validated in HubSpot's UI. Can be: "unformatted", "formatted", "currency", "percentage", "duration", or "probability".
|
|
702
|
-
*/
|
|
703
|
-
numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted';
|
|
704
|
-
/**
|
|
705
|
-
* A list of valid options for the property. This field is required for enumerated properties.
|
|
706
|
-
*/
|
|
707
|
-
options: Schemas.Option[];
|
|
708
|
-
/**
|
|
709
|
-
* Deprecated. Use externalOptionsReferenceType instead.
|
|
710
|
-
*/
|
|
711
|
-
referencedObjectType?: string;
|
|
712
|
-
/**
|
|
713
|
-
* When sensitiveData is true, lists the type of sensitive data contained in the property (e.g., "HIPAA").
|
|
714
|
-
*/
|
|
715
|
-
sensitiveDataCategories?: string[];
|
|
716
|
-
/**
|
|
717
|
-
* Whether to show the currency symbol in HubSpot's UI.
|
|
718
|
-
*/
|
|
719
|
-
showCurrencySymbol?: boolean;
|
|
720
|
-
/**
|
|
721
|
-
* The data type of the property, such as string or number.
|
|
722
|
-
*/
|
|
723
|
-
type: string;
|
|
724
|
-
/**
|
|
725
|
-
* The timestamp when the property was last updated, in ISO 8601 format.
|
|
726
|
-
*/
|
|
727
|
-
updatedAt?: string;
|
|
728
|
-
updatedUserId?: string;
|
|
729
|
-
}
|
|
730
|
-
interface PropertyFilter {
|
|
731
|
-
context?: Schemas.PropertyFilterContext;
|
|
732
|
-
filterInsightsId?: number;
|
|
733
|
-
filterType: 'PROPERTY';
|
|
734
|
-
frameworkFilterId?: number;
|
|
735
|
-
operation: Schemas.BoolPropertyOperation | Schemas.NumberPropertyOperation | Schemas.StringPropertyOperation | Schemas.DateTimePropertyOperation | Schemas.RangedDatePropertyOperation | Schemas.ComparativeDatePropertyOperation | Schemas.ComparativeBoolPropertyOperation | Schemas.ComparativeNumberPropertyOperation | Schemas.ComparativeStringPropertyOperation | Schemas.ComparativePropertyUpdatedOperation | Schemas.RollingDateRangePropertyOperation | Schemas.RollingPropertyUpdatedOperation | Schemas.EnumerationPropertyOperation | Schemas.AllPropertyTypesOperation | Schemas.RangedNumberPropertyOperation | Schemas.MultiStringPropertyOperation | Schemas.DatePropertyOperation | Schemas.CalendarDatePropertyOperation | Schemas.TimePointOperation | Schemas.RangedTimeOperation | Schemas.RegexPropertyOperation;
|
|
736
|
-
property: string;
|
|
737
|
-
}
|
|
738
|
-
interface PropertyFilterContext {
|
|
739
|
-
objectTypeId: string;
|
|
740
|
-
}
|
|
741
|
-
interface PropertyModificationMetadata {
|
|
742
|
-
archivable: boolean;
|
|
743
|
-
readOnlyDefinition: boolean;
|
|
744
|
-
readOnlyOptions?: boolean;
|
|
745
|
-
readOnlyValue: boolean;
|
|
746
|
-
}
|
|
747
|
-
interface PropertyReferencedTime {
|
|
748
|
-
property: string;
|
|
749
|
-
referenceType: 'ANNIVERSARY' | 'ANNIVERSARY_WITH_ZONE_SAME_LOCAL_CONVERSION' | 'UPDATED_AT' | 'VALUE' | 'VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION';
|
|
750
|
-
timeType: 'PROPERTY_REFERENCED';
|
|
751
|
-
timezoneSource: 'CUSTOM' | 'PORTAL' | 'USER';
|
|
752
|
-
zoneId: string;
|
|
753
|
-
}
|
|
754
|
-
interface QuarterReference {
|
|
755
|
-
day: number;
|
|
756
|
-
hour?: number;
|
|
757
|
-
millisecond?: number;
|
|
758
|
-
minute?: number;
|
|
759
|
-
month: number;
|
|
760
|
-
referenceType: 'QUARTER';
|
|
761
|
-
second?: number;
|
|
762
|
-
}
|
|
763
|
-
interface RangedDatePropertyOperation {
|
|
764
|
-
defaultValue?: string;
|
|
765
|
-
includeObjectsWithNoValueSet: boolean;
|
|
766
|
-
lowerBoundTimestamp: number;
|
|
767
|
-
operationType: string;
|
|
768
|
-
operator: 'IS_BETWEEN' | 'IS_NOT_BETWEEN';
|
|
769
|
-
operatorName: string;
|
|
770
|
-
propertyType: 'datetime-ranged';
|
|
771
|
-
renderSpec?: string;
|
|
772
|
-
requiresTimeZoneConversion: boolean;
|
|
773
|
-
upperBoundTimestamp: number;
|
|
774
|
-
}
|
|
775
|
-
interface RangedNumberPropertyOperation {
|
|
776
|
-
defaultValue?: string;
|
|
777
|
-
includeObjectsWithNoValueSet: boolean;
|
|
778
|
-
lowerBound: number;
|
|
779
|
-
operationType: string;
|
|
780
|
-
operator: 'IS_BETWEEN' | 'IS_NOT_BETWEEN';
|
|
781
|
-
operatorName: string;
|
|
782
|
-
propertyType: 'number-ranged';
|
|
783
|
-
renderSpec?: string;
|
|
784
|
-
upperBound: number;
|
|
785
|
-
}
|
|
786
|
-
interface RangedTimeOperation {
|
|
787
|
-
defaultValue?: string;
|
|
788
|
-
includeObjectsWithNoValueSet: boolean;
|
|
789
|
-
lowerBoundEndpointBehavior: 'EXCLUSIVE' | 'INCLUSIVE';
|
|
790
|
-
lowerBoundTimePoint: Schemas.DatePoint | Schemas.IndexedTimePoint | Schemas.PropertyReferencedTime;
|
|
791
|
-
operationType: string;
|
|
792
|
-
operator: 'IS_BETWEEN' | 'IS_NOT_BETWEEN';
|
|
793
|
-
operatorName: string;
|
|
794
|
-
propertyParser: 'ANNIVERSARY' | 'ANNIVERSARY_WITH_ZONE_SAME_LOCAL_CONVERSION' | 'UPDATED_AT' | 'VALUE' | 'VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION';
|
|
795
|
-
propertyType: 'rangedtime';
|
|
796
|
-
renderSpec?: string;
|
|
797
|
-
type: string;
|
|
798
|
-
upperBoundEndpointBehavior: 'EXCLUSIVE' | 'INCLUSIVE';
|
|
799
|
-
upperBoundTimePoint: Schemas.DatePoint | Schemas.IndexedTimePoint | Schemas.PropertyReferencedTime;
|
|
800
|
-
}
|
|
801
|
-
interface RegexPropertyOperation {
|
|
802
|
-
caseSensitive: boolean;
|
|
803
|
-
defaultValue?: string;
|
|
804
|
-
includeObjectsWithNoValueSet: boolean;
|
|
805
|
-
operationType: string;
|
|
806
|
-
operator: 'DOES_NOT_MATCH_REGEX' | 'MATCHES_REGEX';
|
|
807
|
-
operatorName: string;
|
|
808
|
-
pattern: string;
|
|
809
|
-
propertyType: 'regex';
|
|
810
|
-
renderSpec?: string;
|
|
811
|
-
}
|
|
812
|
-
interface RelativeComparativeTimestampRefineBy {
|
|
813
|
-
comparison: 'AFTER' | 'BEFORE';
|
|
814
|
-
timeOffset: Schemas.TimeOffset;
|
|
815
|
-
type: 'RelativeComparativeTimestampRefineBy';
|
|
816
|
-
}
|
|
817
|
-
interface RelativeRangedTimestampRefineBy {
|
|
818
|
-
lowerBoundOffset: Schemas.TimeOffset;
|
|
819
|
-
rangeType: 'BETWEEN' | 'NOT_BETWEEN';
|
|
820
|
-
type: 'RelativeRangedTimestampRefineBy';
|
|
821
|
-
upperBoundOffset: Schemas.TimeOffset;
|
|
822
|
-
}
|
|
823
|
-
interface RollingDateRangePropertyOperation {
|
|
824
|
-
defaultValue?: string;
|
|
825
|
-
includeObjectsWithNoValueSet: boolean;
|
|
826
|
-
numberOfDays: number;
|
|
827
|
-
operationType: string;
|
|
828
|
-
operator: 'IS_LESS_THAN_X_DAYS_AGO' | 'IS_LESS_THAN_X_DAYS_FROM_NOW' | 'IS_MORE_THAN_X_DAYS_AGO' | 'IS_MORE_THAN_X_DAYS_FROM_NOW';
|
|
829
|
-
operatorName: string;
|
|
830
|
-
propertyType: 'datetime-rolling';
|
|
831
|
-
renderSpec?: string;
|
|
832
|
-
requiresTimeZoneConversion: boolean;
|
|
833
|
-
}
|
|
834
|
-
interface RollingPropertyUpdatedOperation {
|
|
835
|
-
defaultValue?: string;
|
|
836
|
-
includeObjectsWithNoValueSet: boolean;
|
|
837
|
-
numberOfDays: number;
|
|
838
|
-
operationType: string;
|
|
839
|
-
operator: 'NOT_UPDATED_IN_LAST_X_DAYS' | 'UPDATED_IN_LAST_X_DAYS';
|
|
840
|
-
operatorName: string;
|
|
841
|
-
propertyType: 'rolling-property-updated';
|
|
842
|
-
renderSpec?: string;
|
|
843
|
-
}
|
|
844
|
-
interface SetOccurrencesRefineBy {
|
|
845
|
-
setType: 'ALL' | 'ALL_INCLUDE_EMPTY' | 'ANY' | 'ANY_INCLUDE_EMPTY' | 'NONE' | 'NONE_EXCLUDE_EMPTY';
|
|
846
|
-
type: 'SetOccurrencesRefineBy';
|
|
847
|
-
}
|
|
848
|
-
interface StringPropertyOperation {
|
|
849
|
-
defaultValue?: string;
|
|
850
|
-
includeObjectsWithNoValueSet: boolean;
|
|
851
|
-
operationType: string;
|
|
852
|
-
operator: 'CONTAINS' | 'DOES_NOT_CONTAIN' | 'ENDS_WITH' | 'HAS_EVER_BEEN_EQUAL_TO' | 'HAS_EVER_CONTAINED' | 'HAS_NEVER_BEEN_EQUAL_TO' | 'HAS_NEVER_CONTAINED' | 'IS_EQUAL_TO' | 'IS_NOT_EQUAL_TO' | 'STARTS_WITH';
|
|
853
|
-
operatorName: string;
|
|
854
|
-
propertyType: 'string';
|
|
855
|
-
renderSpec?: string;
|
|
856
|
-
value: string;
|
|
857
|
-
}
|
|
858
|
-
interface TimeOffset {
|
|
859
|
-
amount: number;
|
|
860
|
-
offsetDirection: 'FUTURE' | 'PAST';
|
|
861
|
-
timeUnit: 'DAYS' | 'HOURS' | 'MINUTES' | 'WEEKS';
|
|
862
|
-
}
|
|
863
|
-
interface TimePointOperation {
|
|
864
|
-
defaultValue?: string;
|
|
865
|
-
endpointBehavior: 'EXCLUSIVE' | 'INCLUSIVE';
|
|
866
|
-
includeObjectsWithNoValueSet: boolean;
|
|
867
|
-
operationType: string;
|
|
868
|
-
operator: 'IS_AFTER' | 'IS_BEFORE';
|
|
869
|
-
operatorName: string;
|
|
870
|
-
propertyParser: 'ANNIVERSARY' | 'ANNIVERSARY_WITH_ZONE_SAME_LOCAL_CONVERSION' | 'UPDATED_AT' | 'VALUE' | 'VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION';
|
|
871
|
-
propertyType: 'timepoint';
|
|
872
|
-
renderSpec?: string;
|
|
873
|
-
timePoint: Schemas.DatePoint | Schemas.IndexedTimePoint | Schemas.PropertyReferencedTime;
|
|
874
|
-
type: string;
|
|
875
|
-
}
|
|
876
|
-
interface TodayReference {
|
|
877
|
-
hour?: number;
|
|
878
|
-
millisecond?: number;
|
|
879
|
-
minute?: number;
|
|
880
|
-
referenceType: 'TODAY';
|
|
881
|
-
second?: number;
|
|
882
|
-
}
|
|
883
|
-
interface WeekReference {
|
|
884
|
-
dayOfWeek: 'FRIDAY' | 'MONDAY' | 'SATURDAY' | 'SUNDAY' | 'THURSDAY' | 'TUESDAY' | 'WEDNESDAY';
|
|
885
|
-
hour?: number;
|
|
886
|
-
millisecond?: number;
|
|
887
|
-
minute?: number;
|
|
888
|
-
referenceType: 'WEEK';
|
|
889
|
-
second?: number;
|
|
890
|
-
}
|
|
891
|
-
interface YearReference {
|
|
892
|
-
day: number;
|
|
893
|
-
hour?: number;
|
|
894
|
-
millisecond?: number;
|
|
895
|
-
minute?: number;
|
|
896
|
-
month: number;
|
|
897
|
-
referenceType: 'YEAR';
|
|
898
|
-
second?: number;
|
|
899
|
-
}
|
|
4
|
+
declare namespace EventsManageEventDefinitionsSchemas {
|
|
5
|
+
interface AbsoluteComparativeTimestampRefineBy {
|
|
6
|
+
comparison: 'AFTER' | 'BEFORE';
|
|
7
|
+
timestamp: number;
|
|
8
|
+
type: 'AbsoluteComparativeTimestampRefineBy';
|
|
9
|
+
}
|
|
10
|
+
interface AbsoluteRangedTimestampRefineBy {
|
|
11
|
+
lowerTimestamp: number;
|
|
12
|
+
rangeType: 'BETWEEN' | 'NOT_BETWEEN';
|
|
13
|
+
type: 'AbsoluteRangedTimestampRefineBy';
|
|
14
|
+
upperTimestamp: number;
|
|
15
|
+
}
|
|
16
|
+
interface AllHistoryRefineBy {
|
|
17
|
+
type: 'AllHistoryRefineBy';
|
|
18
|
+
}
|
|
19
|
+
interface AllPropertyTypesOperation {
|
|
20
|
+
coalescingRefineBy: NumOccurrencesRefineBy | SetOccurrencesRefineBy;
|
|
21
|
+
defaultValue?: string;
|
|
22
|
+
includeObjectsWithNoValueSet: boolean;
|
|
23
|
+
operationType: string;
|
|
24
|
+
operator: 'IS_BLANK' | 'IS_KNOWN' | 'IS_NOT_BLANK' | 'IS_UNKNOWN';
|
|
25
|
+
operatorName: string;
|
|
26
|
+
propertyType: 'alltypes';
|
|
27
|
+
pruningRefineBy?: RelativeComparativeTimestampRefineBy | RelativeRangedTimestampRefineBy | AbsoluteComparativeTimestampRefineBy | AbsoluteRangedTimestampRefineBy | AllHistoryRefineBy | TimePointOperation | RangedTimeOperation;
|
|
28
|
+
renderSpec?: string;
|
|
900
29
|
}
|
|
901
30
|
/**
|
|
902
|
-
*
|
|
903
|
-
* ```ts
|
|
904
|
-
* import { eventsManageEventDefinitions } from '@hubspot/api-client-core';
|
|
905
|
-
* client.send(eventsManageEventDefinitions.advanced.createProperty(input));
|
|
906
|
-
* ```
|
|
31
|
+
* The definition of an association
|
|
907
32
|
*/
|
|
908
|
-
interface
|
|
33
|
+
interface AssociationDefinition {
|
|
909
34
|
/**
|
|
910
|
-
*
|
|
911
|
-
|
|
912
|
-
|
|
913
|
-
|
|
35
|
+
* Whether custom labels can be used in the association.
|
|
36
|
+
*/
|
|
37
|
+
allowsCustomLabels: boolean;
|
|
38
|
+
/**
|
|
39
|
+
* The cardinality from the source object's perspective, either "ONE_TO_ONE" or "ONE_TO_MANY".
|
|
40
|
+
*/
|
|
41
|
+
cardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE';
|
|
42
|
+
/**
|
|
43
|
+
* The error category
|
|
44
|
+
*/
|
|
45
|
+
category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK';
|
|
46
|
+
/**
|
|
47
|
+
* The name of the source object type (e.g,. "DEAL" or "QUOTE").
|
|
48
|
+
*/
|
|
49
|
+
fromObjectType?: 'ABANDONED_CART' | 'ACCEPTANCE_TEST' | 'AD' | 'AD_ACCOUNT' | 'AD_CAMPAIGN' | 'AD_GROUP' | 'AI_FORECAST' | 'ALL_PAGES' | 'APPROVAL' | 'APPROVAL_STEP' | 'ATTRIBUTION' | 'AUDIENCE' | 'AUTOMATION_JOURNEY' | 'AUTOMATION_PLATFORM_FLOW' | 'AUTOMATION_PLATFORM_FLOW_ACTION' | 'BET_ALERT' | 'BET_DELIVERABLE_SERVICE' | 'BLOG_LISTING_PAGE' | 'BLOG_POST' | 'CALL' | 'CAMPAIGN' | 'CAMPAIGN_BUDGET_ITEM' | 'CAMPAIGN_SPEND_ITEM' | 'CAMPAIGN_STEP' | 'CAMPAIGN_TEMPLATE' | 'CAMPAIGN_TEMPLATE_STEP' | 'CART' | 'CASE_STUDY' | 'CHATFLOW' | 'CLIP' | 'CMS_URL' | 'COMBO_EVENT_CONFIGURATION' | 'COMMERCE_PAYMENT' | 'COMMUNICATION' | 'COMPANY' | 'CONTACT' | 'CONTACT_CREATE_ATTRIBUTION' | 'CONTENT' | 'CONTENT_AUDIT' | 'CONTENT_AUDIT_PAGE' | 'CONVERSATION' | 'CONVERSATION_INBOX' | 'CONVERSATION_SESSION' | 'CRM_OBJECTS_DUMMY_TYPE' | 'CRM_PIPELINES_DUMMY_TYPE' | 'CTA' | 'CTA_VARIANT' | 'DATA_PRIVACY_CONSENT' | 'DATA_SYNC_STATE' | 'DEAL' | 'DEAL_CREATE_ATTRIBUTION' | 'DEAL_REGISTRATION' | 'DEAL_SPLIT' | 'DISCOUNT' | 'DISCOUNT_CODE' | 'DISCOUNT_TEMPLATE' | 'EMAIL' | 'ENGAGEMENT' | 'EXPORT' | 'EXTERNAL_WEB_URL' | 'FEE' | 'FEEDBACK_SUBMISSION' | 'FEEDBACK_SURVEY' | 'FILE_MANAGER_FILE' | 'FILE_MANAGER_FOLDER' | 'FOLDER' | 'FORECAST' | 'FORM' | 'FORM_SUBMISSION_INBOUNDDB' | 'GOAL_TARGET' | 'GOAL_TARGET_GROUP' | 'GOAL_TEMPLATE' | 'GSC_PROPERTY' | 'HUB' | 'IMPORT' | 'INVOICE' | 'KEYWORD' | 'KNOWLEDGE_ARTICLE' | 'LANDING_PAGE' | 'LEAD' | 'LINE_ITEM' | 'MARKETING_CALENDAR' | 'MARKETING_CAMPAIGN_UTM' | 'MARKETING_EMAIL' | 'MARKETING_EVENT' | 'MARKETING_EVENT_ATTENDANCE' | 'MARKETING_SMS' | 'MEDIA_BRIDGE' | 'MEETING_EVENT' | 'MIC' | 'NOTE' | 'OBJECT_LIST' | 'ORDER' | 'OWNER' | 'PARTNER_ACCOUNT' | 'PARTNER_CLIENT' | 'PARTNER_CLIENT_REVENUE' | 'PARTNER_SERVICE' | 'PAYMENT_LINK' | 'PAYMENT_SCHEDULE' | 'PAYMENT_SCHEDULE_INSTALLMENT' | 'PERMISSIONS_TESTING' | 'PLAYBOOK' | 'PLAYBOOK_QUESTION' | 'PLAYBOOK_SUBMISSION' | 'PLAYBOOK_SUBMISSION_ANSWER' | 'PLAYLIST' | 'PLAYLIST_FOLDER' | 'PODCAST_EPISODE' | 'PORTAL' | 'PORTAL_OBJECT_SYNC_MESSAGE' | 'POSTAL_MAIL' | 'PRIVACY_SCANNER_COOKIE' | 'PRODUCT' | 'PRODUCT_OR_FOLDER' | 'PROPERTY_INFO' | 'PROSPECTING_AGENT_CONTACT_ASSIGNMENT' | 'PUBLISHING_TASK' | 'QUARANTINED_SUBMISSION' | 'QUOTA' | 'QUOTE' | 'QUOTE_FIELD' | 'QUOTE_MODULE' | 'QUOTE_MODULE_FIELD' | 'QUOTE_TEMPLATE' | 'RESTORABLE_CRM_OBJECT' | 'ROSTER' | 'ROSTER_MEMBER' | 'SALES_DOCUMENT' | 'SALES_TASK' | 'SALES_WORKLOAD' | 'SALESFORCE_SYNC_ERROR' | 'SCHEDULING_PAGE' | 'SCHEMAS_BACKEND_TEST' | 'SCORE_CONFIGURATION' | 'SEQUENCE' | 'SEQUENCE_ENROLLMENT' | 'SEQUENCE_STEP' | 'SEQUENCE_STEP_ENROLLMENT' | 'SERVICE' | 'SITE_PAGE' | 'SNIPPET' | 'SOCIAL_BROADCAST' | 'SOCIAL_CHANNEL' | 'SOCIAL_POST' | 'SOCIAL_PROFILE' | 'SOX_PROTECTED_DUMMY_TYPE' | 'SOX_PROTECTED_TEST_TYPE' | 'SUBMISSION_TAG' | 'SUBSCRIPTION' | 'TASK' | 'TASK_TEMPLATE' | 'TAX' | 'TEMPLATE' | 'TICKET' | 'UNKNOWN' | 'UNSUBSCRIBE' | 'USER' | 'VIEW' | 'VIEW_BLOCK' | 'WEB_INTERACTIVE';
|
|
50
|
+
/**
|
|
51
|
+
* The ID of the source object type (e.g., 0-1 for contacts).
|
|
52
|
+
*/
|
|
53
|
+
fromObjectTypeId: string;
|
|
54
|
+
/**
|
|
55
|
+
* Whether all potential linked objects are included in the association
|
|
56
|
+
*/
|
|
57
|
+
hasAllAssociatedObjects: boolean;
|
|
58
|
+
/**
|
|
59
|
+
* Whether deletions in the association should cause cascading deletes to linked objects.
|
|
60
|
+
*/
|
|
61
|
+
hasCascadingDeletes: boolean;
|
|
62
|
+
/**
|
|
63
|
+
* Whether a user has set a limit for the number of source objects.
|
|
64
|
+
*/
|
|
65
|
+
hasUserEnforcedMaxFromObjectIds: boolean;
|
|
66
|
+
/**
|
|
67
|
+
* Whether a user has set a limit for the number of destination objects.
|
|
68
|
+
*/
|
|
69
|
+
hasUserEnforcedMaxToObjectIds: boolean;
|
|
70
|
+
/**
|
|
71
|
+
* Whether the association is hidden or not.
|
|
72
|
+
*/
|
|
73
|
+
hidden: boolean;
|
|
74
|
+
hiddenReason?: 'DEFAULT' | 'INTERNAL' | 'USER_CONFIGURED';
|
|
75
|
+
/**
|
|
76
|
+
* The unique ID of the associated object (e.g., a contact ID).
|
|
77
|
+
*/
|
|
78
|
+
id: number;
|
|
79
|
+
/**
|
|
80
|
+
* Whether the reverse association can also support custom labels.
|
|
81
|
+
*/
|
|
82
|
+
inverseAllowsCustomLabels: boolean;
|
|
83
|
+
/**
|
|
84
|
+
* The cardinality from the destination object's perspective, either "ONE_TO_ONE" or "ONE_TO_MANY".
|
|
85
|
+
*/
|
|
86
|
+
inverseCardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE';
|
|
87
|
+
/**
|
|
88
|
+
* Whether all potential reverse linked objects are included in the association.
|
|
89
|
+
*/
|
|
90
|
+
inverseHasAllAssociatedObjects: boolean;
|
|
91
|
+
/**
|
|
92
|
+
* The unique ID for the inverse side of the association.
|
|
93
|
+
*/
|
|
94
|
+
inverseId: number;
|
|
95
|
+
/**
|
|
96
|
+
* The label used to describe the reverse relationship in an association.
|
|
97
|
+
*/
|
|
98
|
+
inverseLabel?: string;
|
|
99
|
+
/**
|
|
100
|
+
* The name used to describe the inverse relationship in this association
|
|
101
|
+
*/
|
|
102
|
+
inverseName: string;
|
|
103
|
+
isDefault: boolean;
|
|
104
|
+
/**
|
|
105
|
+
* Whether the inverse association is considered primary.
|
|
106
|
+
*/
|
|
107
|
+
isInversePrimary: boolean;
|
|
108
|
+
/**
|
|
109
|
+
* Whether the association is the primary link between the entities involved.
|
|
110
|
+
*/
|
|
111
|
+
isPrimary: boolean;
|
|
112
|
+
/**
|
|
113
|
+
* The label given to an association.
|
|
114
|
+
*/
|
|
115
|
+
label?: string;
|
|
116
|
+
/**
|
|
117
|
+
* The maximum number of source object IDs allowed in the association.
|
|
118
|
+
*/
|
|
119
|
+
maxFromObjectIds: number;
|
|
120
|
+
/**
|
|
121
|
+
* The maximum number of destination object IDs allowed in the association.
|
|
122
|
+
*/
|
|
123
|
+
maxToObjectIds: number;
|
|
124
|
+
/**
|
|
125
|
+
* For labeled association types, the internal name of the association.
|
|
126
|
+
*/
|
|
127
|
+
name: string;
|
|
128
|
+
/**
|
|
129
|
+
* A unique across-portal ID applied to the association.
|
|
130
|
+
*/
|
|
131
|
+
portalUniqueIdentifier: string;
|
|
132
|
+
readOnly: boolean;
|
|
133
|
+
/**
|
|
134
|
+
* The name of the destination object type (e.g,. "DEAL" or "QUOTE").
|
|
135
|
+
*/
|
|
136
|
+
toObjectType?: 'ABANDONED_CART' | 'ACCEPTANCE_TEST' | 'AD' | 'AD_ACCOUNT' | 'AD_CAMPAIGN' | 'AD_GROUP' | 'AI_FORECAST' | 'ALL_PAGES' | 'APPROVAL' | 'APPROVAL_STEP' | 'ATTRIBUTION' | 'AUDIENCE' | 'AUTOMATION_JOURNEY' | 'AUTOMATION_PLATFORM_FLOW' | 'AUTOMATION_PLATFORM_FLOW_ACTION' | 'BET_ALERT' | 'BET_DELIVERABLE_SERVICE' | 'BLOG_LISTING_PAGE' | 'BLOG_POST' | 'CALL' | 'CAMPAIGN' | 'CAMPAIGN_BUDGET_ITEM' | 'CAMPAIGN_SPEND_ITEM' | 'CAMPAIGN_STEP' | 'CAMPAIGN_TEMPLATE' | 'CAMPAIGN_TEMPLATE_STEP' | 'CART' | 'CASE_STUDY' | 'CHATFLOW' | 'CLIP' | 'CMS_URL' | 'COMBO_EVENT_CONFIGURATION' | 'COMMERCE_PAYMENT' | 'COMMUNICATION' | 'COMPANY' | 'CONTACT' | 'CONTACT_CREATE_ATTRIBUTION' | 'CONTENT' | 'CONTENT_AUDIT' | 'CONTENT_AUDIT_PAGE' | 'CONVERSATION' | 'CONVERSATION_INBOX' | 'CONVERSATION_SESSION' | 'CRM_OBJECTS_DUMMY_TYPE' | 'CRM_PIPELINES_DUMMY_TYPE' | 'CTA' | 'CTA_VARIANT' | 'DATA_PRIVACY_CONSENT' | 'DATA_SYNC_STATE' | 'DEAL' | 'DEAL_CREATE_ATTRIBUTION' | 'DEAL_REGISTRATION' | 'DEAL_SPLIT' | 'DISCOUNT' | 'DISCOUNT_CODE' | 'DISCOUNT_TEMPLATE' | 'EMAIL' | 'ENGAGEMENT' | 'EXPORT' | 'EXTERNAL_WEB_URL' | 'FEE' | 'FEEDBACK_SUBMISSION' | 'FEEDBACK_SURVEY' | 'FILE_MANAGER_FILE' | 'FILE_MANAGER_FOLDER' | 'FOLDER' | 'FORECAST' | 'FORM' | 'FORM_SUBMISSION_INBOUNDDB' | 'GOAL_TARGET' | 'GOAL_TARGET_GROUP' | 'GOAL_TEMPLATE' | 'GSC_PROPERTY' | 'HUB' | 'IMPORT' | 'INVOICE' | 'KEYWORD' | 'KNOWLEDGE_ARTICLE' | 'LANDING_PAGE' | 'LEAD' | 'LINE_ITEM' | 'MARKETING_CALENDAR' | 'MARKETING_CAMPAIGN_UTM' | 'MARKETING_EMAIL' | 'MARKETING_EVENT' | 'MARKETING_EVENT_ATTENDANCE' | 'MARKETING_SMS' | 'MEDIA_BRIDGE' | 'MEETING_EVENT' | 'MIC' | 'NOTE' | 'OBJECT_LIST' | 'ORDER' | 'OWNER' | 'PARTNER_ACCOUNT' | 'PARTNER_CLIENT' | 'PARTNER_CLIENT_REVENUE' | 'PARTNER_SERVICE' | 'PAYMENT_LINK' | 'PAYMENT_SCHEDULE' | 'PAYMENT_SCHEDULE_INSTALLMENT' | 'PERMISSIONS_TESTING' | 'PLAYBOOK' | 'PLAYBOOK_QUESTION' | 'PLAYBOOK_SUBMISSION' | 'PLAYBOOK_SUBMISSION_ANSWER' | 'PLAYLIST' | 'PLAYLIST_FOLDER' | 'PODCAST_EPISODE' | 'PORTAL' | 'PORTAL_OBJECT_SYNC_MESSAGE' | 'POSTAL_MAIL' | 'PRIVACY_SCANNER_COOKIE' | 'PRODUCT' | 'PRODUCT_OR_FOLDER' | 'PROPERTY_INFO' | 'PROSPECTING_AGENT_CONTACT_ASSIGNMENT' | 'PUBLISHING_TASK' | 'QUARANTINED_SUBMISSION' | 'QUOTA' | 'QUOTE' | 'QUOTE_FIELD' | 'QUOTE_MODULE' | 'QUOTE_MODULE_FIELD' | 'QUOTE_TEMPLATE' | 'RESTORABLE_CRM_OBJECT' | 'ROSTER' | 'ROSTER_MEMBER' | 'SALES_DOCUMENT' | 'SALES_TASK' | 'SALES_WORKLOAD' | 'SALESFORCE_SYNC_ERROR' | 'SCHEDULING_PAGE' | 'SCHEMAS_BACKEND_TEST' | 'SCORE_CONFIGURATION' | 'SEQUENCE' | 'SEQUENCE_ENROLLMENT' | 'SEQUENCE_STEP' | 'SEQUENCE_STEP_ENROLLMENT' | 'SERVICE' | 'SITE_PAGE' | 'SNIPPET' | 'SOCIAL_BROADCAST' | 'SOCIAL_CHANNEL' | 'SOCIAL_POST' | 'SOCIAL_PROFILE' | 'SOX_PROTECTED_DUMMY_TYPE' | 'SOX_PROTECTED_TEST_TYPE' | 'SUBMISSION_TAG' | 'SUBSCRIPTION' | 'TASK' | 'TASK_TEMPLATE' | 'TAX' | 'TEMPLATE' | 'TICKET' | 'UNKNOWN' | 'UNSUBSCRIBE' | 'USER' | 'VIEW' | 'VIEW_BLOCK' | 'WEB_INTERACTIVE';
|
|
137
|
+
/**
|
|
138
|
+
* The ID of the destination object type (e.g., 0-3 for deals).
|
|
139
|
+
*/
|
|
140
|
+
toObjectTypeId: string;
|
|
141
|
+
}
|
|
142
|
+
interface BatchedBehavioralEventHttpCompletionRequest {
|
|
143
|
+
inputs: BehavioralEventHttpCompletionRequest[];
|
|
144
|
+
}
|
|
145
|
+
interface BehavioralEventHttpCompletionRequest {
|
|
146
|
+
/**
|
|
147
|
+
* Email of visitor
|
|
148
|
+
*/
|
|
149
|
+
email?: string;
|
|
150
|
+
/**
|
|
151
|
+
* Internal name of the event-type to trigger
|
|
152
|
+
*/
|
|
153
|
+
eventName: string;
|
|
154
|
+
/**
|
|
155
|
+
* The object id that this event occurred on. Could be a contact id or a visitor id.
|
|
156
|
+
*/
|
|
157
|
+
objectId?: string;
|
|
158
|
+
/**
|
|
159
|
+
* The time when this event occurred (if any). If this isn't set, the current time will be used
|
|
160
|
+
*/
|
|
161
|
+
occurredAt?: string;
|
|
162
|
+
/**
|
|
163
|
+
* Map of properties for the event in the format property internal name - property value
|
|
164
|
+
*/
|
|
165
|
+
properties: Record<string, string>;
|
|
166
|
+
/**
|
|
167
|
+
* User token
|
|
168
|
+
*/
|
|
169
|
+
utk?: string;
|
|
170
|
+
uuid?: string;
|
|
171
|
+
}
|
|
172
|
+
interface BehavioralEventTypeDefinitionLabels {
|
|
173
|
+
plural?: string;
|
|
174
|
+
singular: string;
|
|
175
|
+
}
|
|
176
|
+
interface BoolPropertyOperation {
|
|
177
|
+
defaultValue?: string;
|
|
178
|
+
includeObjectsWithNoValueSet: boolean;
|
|
179
|
+
operationType: string;
|
|
180
|
+
operator: 'HAS_EVER_BEEN_EQUAL_TO' | 'HAS_NEVER_BEEN_EQUAL_TO' | 'IS_EQUAL_TO' | 'IS_NOT_EQUAL_TO';
|
|
181
|
+
operatorName: string;
|
|
182
|
+
propertyType: 'bool';
|
|
183
|
+
renderSpec?: string;
|
|
184
|
+
value: boolean;
|
|
185
|
+
}
|
|
186
|
+
interface CalendarDatePropertyOperation {
|
|
187
|
+
defaultValue?: string;
|
|
188
|
+
fiscalYearStart?: 'APRIL' | 'AUGUST' | 'DECEMBER' | 'FEBRUARY' | 'JANUARY' | 'JULY' | 'JUNE' | 'MARCH' | 'MAY' | 'NOVEMBER' | 'OCTOBER' | 'SEPTEMBER';
|
|
189
|
+
includeObjectsWithNoValueSet: boolean;
|
|
190
|
+
operationType: string;
|
|
191
|
+
operator: 'IN_LAST_TIME_UNIT' | 'IN_NEXT_TIME_UNIT' | 'IN_THIS_TIME_UNIT' | 'IN_THIS_TIME_UNIT_SO_FAR';
|
|
192
|
+
operatorName: string;
|
|
193
|
+
propertyType: 'calendar-date';
|
|
194
|
+
renderSpec?: string;
|
|
195
|
+
timeUnit: 'DAY' | 'MONTH' | 'QUARTER' | 'WEEK' | 'YEAR';
|
|
196
|
+
timeUnitCount: number;
|
|
197
|
+
useFiscalYear: boolean;
|
|
198
|
+
}
|
|
199
|
+
interface CollectionResponseWithTotalExternalBehavioralEventTypeDefinition {
|
|
200
|
+
paging?: Paging;
|
|
201
|
+
results: ExternalBehavioralEventTypeDefinition[];
|
|
202
|
+
total: number;
|
|
203
|
+
}
|
|
204
|
+
interface ComboEventRule {
|
|
205
|
+
count: number;
|
|
206
|
+
eventTypeId: string;
|
|
207
|
+
lookbackWindowDays?: number;
|
|
208
|
+
propertyFilters: PropertyFilter[];
|
|
209
|
+
}
|
|
210
|
+
interface ComboEventRuleBranch {
|
|
211
|
+
composingRules: ComboEventRule[];
|
|
212
|
+
operationType: 'AND' | 'OR';
|
|
213
|
+
ruleBranches: ComboEventRuleBranch[];
|
|
214
|
+
}
|
|
215
|
+
interface ComparativeBoolPropertyOperation {
|
|
216
|
+
comparisonPropertyName: string;
|
|
217
|
+
defaultValue?: string;
|
|
218
|
+
includeObjectsWithNoValueSet: boolean;
|
|
219
|
+
operationType: string;
|
|
220
|
+
operator: 'IS_EQUAL_TO' | 'IS_NOT_EQUAL_TO';
|
|
221
|
+
operatorName: string;
|
|
222
|
+
propertyType: 'bool-comparative';
|
|
223
|
+
renderSpec?: string;
|
|
224
|
+
}
|
|
225
|
+
interface ComparativeDatePropertyOperation {
|
|
226
|
+
comparisonPropertyName: string;
|
|
227
|
+
defaultComparisonValue?: string;
|
|
228
|
+
defaultValue?: string;
|
|
229
|
+
includeObjectsWithNoValueSet: boolean;
|
|
230
|
+
operationType: string;
|
|
231
|
+
operator: 'IS_AFTER' | 'IS_BEFORE';
|
|
232
|
+
operatorName: string;
|
|
233
|
+
propertyType: 'datetime-comparative';
|
|
234
|
+
renderSpec?: string;
|
|
235
|
+
}
|
|
236
|
+
interface ComparativeNumberPropertyOperation {
|
|
237
|
+
comparisonPropertyName: string;
|
|
238
|
+
defaultValue?: string;
|
|
239
|
+
includeObjectsWithNoValueSet: boolean;
|
|
240
|
+
operationType: string;
|
|
241
|
+
operator: 'IS_EQUAL_TO' | 'IS_GREATER_THAN' | 'IS_GREATER_THAN_OR_EQUAL_TO' | 'IS_LESS_THAN' | 'IS_LESS_THAN_OR_EQUAL_TO' | 'IS_NOT_EQUAL_TO';
|
|
242
|
+
operatorName: string;
|
|
243
|
+
propertyType: 'number-comparative';
|
|
244
|
+
renderSpec?: string;
|
|
245
|
+
}
|
|
246
|
+
interface ComparativePropertyUpdatedOperation {
|
|
247
|
+
comparisonPropertyName: string;
|
|
248
|
+
defaultComparisonValue?: string;
|
|
249
|
+
defaultValue?: string;
|
|
250
|
+
includeObjectsWithNoValueSet: boolean;
|
|
251
|
+
operationType: string;
|
|
252
|
+
operator: 'IS_AFTER' | 'IS_BEFORE';
|
|
253
|
+
operatorName: string;
|
|
254
|
+
propertyType: 'property-updated-comparative';
|
|
255
|
+
renderSpec?: string;
|
|
256
|
+
}
|
|
257
|
+
interface ComparativeStringPropertyOperation {
|
|
258
|
+
comparisonPropertyName: string;
|
|
259
|
+
defaultValue?: string;
|
|
260
|
+
includeObjectsWithNoValueSet: boolean;
|
|
261
|
+
operationType: string;
|
|
262
|
+
operator: 'CONTAINS' | 'DOES_NOT_CONTAIN' | 'ENDS_WITH' | 'IS_EQUAL_TO' | 'IS_NOT_EQUAL_TO' | 'STARTS_WITH';
|
|
263
|
+
operatorName: string;
|
|
264
|
+
propertyType: 'string-comparative';
|
|
265
|
+
renderSpec?: string;
|
|
266
|
+
}
|
|
267
|
+
interface DatePoint {
|
|
268
|
+
day: number;
|
|
269
|
+
hour?: number;
|
|
270
|
+
millisecond?: number;
|
|
271
|
+
minute?: number;
|
|
272
|
+
month: number;
|
|
273
|
+
second?: number;
|
|
274
|
+
timeType: 'DATE';
|
|
275
|
+
timezoneSource: 'CUSTOM' | 'PORTAL' | 'USER';
|
|
276
|
+
year: number;
|
|
277
|
+
zoneId: string;
|
|
278
|
+
}
|
|
279
|
+
interface DatePropertyOperation {
|
|
280
|
+
day: number;
|
|
281
|
+
defaultValue?: string;
|
|
282
|
+
includeObjectsWithNoValueSet: boolean;
|
|
283
|
+
month: 'APR' | 'AUG' | 'DEC' | 'FEB' | 'JAN' | 'JUL' | 'JUN' | 'MAR' | 'MAY' | 'NOV' | 'OCT' | 'SEP';
|
|
284
|
+
operationType: string;
|
|
285
|
+
operator: 'AFTER' | 'BEFORE' | 'EQUAL';
|
|
286
|
+
operatorName: string;
|
|
287
|
+
propertyType: 'date';
|
|
288
|
+
renderSpec?: string;
|
|
289
|
+
year: number;
|
|
290
|
+
}
|
|
291
|
+
interface DateTimePropertyOperation {
|
|
292
|
+
defaultValue?: string;
|
|
293
|
+
includeObjectsWithNoValueSet: boolean;
|
|
294
|
+
operationType: string;
|
|
295
|
+
operator: 'IS_AFTER' | 'IS_AFTER_DATE' | 'IS_BEFORE' | 'IS_BEFORE_DATE' | 'IS_EQUAL_TO';
|
|
296
|
+
operatorName: string;
|
|
297
|
+
propertyType: 'datetime';
|
|
298
|
+
renderSpec?: string;
|
|
299
|
+
requiresTimeZoneConversion: boolean;
|
|
300
|
+
timestamp: number;
|
|
301
|
+
}
|
|
302
|
+
interface EnumerationPropertyOperation {
|
|
303
|
+
defaultValue?: string;
|
|
304
|
+
includeObjectsWithNoValueSet: boolean;
|
|
305
|
+
operationType: string;
|
|
306
|
+
operator: 'CONTAINS_ALL' | 'DOES_NOT_CONTAIN_ALL' | 'HAS_EVER_BEEN_ANY_OF' | 'HAS_EVER_BEEN_EXACTLY' | 'HAS_EVER_CONTAINED_ALL' | 'HAS_NEVER_BEEN_ANY_OF' | 'HAS_NEVER_BEEN_EXACTLY' | 'HAS_NEVER_CONTAINED_ALL' | 'IS_ANY_OF' | 'IS_EXACTLY' | 'IS_NONE_OF' | 'IS_NOT_EXACTLY';
|
|
307
|
+
operatorName: string;
|
|
308
|
+
propertyType: 'enumeration';
|
|
309
|
+
renderSpec?: string;
|
|
310
|
+
values: string[];
|
|
311
|
+
}
|
|
312
|
+
interface ExternalBehavioralEventPropertyCreate {
|
|
313
|
+
/**
|
|
314
|
+
* A description of the property that will be shown as help text in HubSpot.
|
|
315
|
+
*/
|
|
316
|
+
description?: string;
|
|
317
|
+
/**
|
|
318
|
+
* Human readable label for the property. Used in HubSpot UI
|
|
319
|
+
*/
|
|
320
|
+
label: string;
|
|
321
|
+
/**
|
|
322
|
+
* Internal property name, which must be used when referencing the property from the API
|
|
323
|
+
*/
|
|
324
|
+
name?: string;
|
|
325
|
+
/**
|
|
326
|
+
* A list of available options for the property if it is an enumeration. NOTE: This field is only applicable for enumerated properties.
|
|
327
|
+
*/
|
|
328
|
+
options?: OptionInput[];
|
|
329
|
+
/**
|
|
330
|
+
* The data type of the property. Can be one of the following: [string, number, enumeration, datetime]
|
|
331
|
+
*/
|
|
332
|
+
type: string;
|
|
333
|
+
}
|
|
334
|
+
interface ExternalBehavioralEventPropertyDefinitionPatch {
|
|
335
|
+
/**
|
|
336
|
+
* A description of the property that will be shown as help text in HubSpot.
|
|
337
|
+
*/
|
|
338
|
+
description?: string;
|
|
339
|
+
/**
|
|
340
|
+
* Human readable label for the property. Used in HubSpot UI
|
|
341
|
+
*/
|
|
342
|
+
label?: string;
|
|
343
|
+
/**
|
|
344
|
+
* A list of available options for the property if it is an enumeration. NOTE: This field is only applicable for enumerated properties.
|
|
345
|
+
*/
|
|
346
|
+
options?: OptionInput[];
|
|
347
|
+
}
|
|
348
|
+
interface ExternalBehavioralEventTypeDefinition {
|
|
349
|
+
archived: boolean;
|
|
350
|
+
associations: AssociationDefinition[];
|
|
351
|
+
comboEventRules?: ComboEventRuleBranch;
|
|
352
|
+
createdAt?: string;
|
|
353
|
+
createdUserId?: number;
|
|
354
|
+
customMatchingId?: ExternalObjectResolutionMappingResponse;
|
|
355
|
+
description?: string;
|
|
356
|
+
detailTemplate?: string;
|
|
357
|
+
fullyQualifiedName: string;
|
|
358
|
+
headerTemplate?: string;
|
|
359
|
+
id: string;
|
|
360
|
+
labels: BehavioralEventTypeDefinitionLabels;
|
|
361
|
+
name: string;
|
|
362
|
+
objectTypeId: string;
|
|
363
|
+
primaryObject?: string;
|
|
364
|
+
primaryObjectId?: string;
|
|
365
|
+
properties: Property[];
|
|
366
|
+
trackingType?: 'APP_EVENT' | 'AUTOCAPTURE_EVENT' | 'CLICKED_ELEMENT' | 'COMBO_EVENT' | 'CUSTOM_SCRIPT' | 'CUSTOM_SIGNAL' | 'IMPORT' | 'MANUAL' | 'PROPERTY_CHANGE' | 'VISITED_URL' | 'WEBHOOK';
|
|
367
|
+
updatedAt?: string;
|
|
368
|
+
updatedUserId?: number;
|
|
369
|
+
}
|
|
370
|
+
interface ExternalBehavioralEventTypeDefinitionEgg {
|
|
371
|
+
customMatchingId?: ExternalObjectResolutionMappingRequest;
|
|
372
|
+
/**
|
|
373
|
+
* A description of the event that will be shown as help text in HubSpot.
|
|
374
|
+
*/
|
|
375
|
+
description?: string;
|
|
376
|
+
includeDefaultProperties: boolean;
|
|
377
|
+
/**
|
|
378
|
+
* Human readable label for the event. Used in HubSpot UI
|
|
379
|
+
*/
|
|
380
|
+
label: string;
|
|
381
|
+
/**
|
|
382
|
+
* Internal event name, which must be used when referencing the event from this event definitions API. If a name is not supplied, one will be generated based on the label. The `name` value will also be used to automatically generate a `fullyQualifiedName` for the event definition, which you'll use when sending event completions to this event.
|
|
383
|
+
*/
|
|
384
|
+
name?: string;
|
|
385
|
+
/**
|
|
386
|
+
* The object type to associate this event to. Can be one of CONTACT, COMPANY, DEAL, TICKET. If no primaryObject is supplied, we will default to associating the event to CONTACT objects.
|
|
387
|
+
*/
|
|
388
|
+
primaryObject?: string;
|
|
389
|
+
/**
|
|
390
|
+
* List of custom properties on event
|
|
391
|
+
*/
|
|
392
|
+
propertyDefinitions: ExternalBehavioralEventPropertyCreate[];
|
|
393
|
+
}
|
|
394
|
+
interface ExternalBehavioralEventTypeDefinitionPatch {
|
|
395
|
+
/**
|
|
396
|
+
* A description of the event that will be shown as help text in HubSpot.
|
|
397
|
+
*/
|
|
398
|
+
description?: string;
|
|
399
|
+
/**
|
|
400
|
+
* Human readable label for the event. Used in HubSpot UI
|
|
401
|
+
*/
|
|
402
|
+
label?: string;
|
|
403
|
+
}
|
|
404
|
+
interface ExternalObjectResolutionMappingRequest {
|
|
405
|
+
primaryObjectRule: ExternalPrimaryObjectResolutionRule;
|
|
406
|
+
}
|
|
407
|
+
interface ExternalObjectResolutionMappingResponse {
|
|
408
|
+
primaryObjectRule: ExternalPrimaryObjectResolutionRule;
|
|
409
|
+
}
|
|
410
|
+
interface ExternalPrimaryObjectResolutionRule {
|
|
411
|
+
eventPropertyName: string;
|
|
412
|
+
targetObjectPropertyName: string;
|
|
413
|
+
}
|
|
414
|
+
interface FiscalQuarter {
|
|
415
|
+
day: number;
|
|
416
|
+
hour?: number;
|
|
417
|
+
millisecond?: number;
|
|
418
|
+
minute?: number;
|
|
419
|
+
month: number;
|
|
420
|
+
referenceType: 'FISCAL_QUARTER';
|
|
421
|
+
second?: number;
|
|
422
|
+
}
|
|
423
|
+
interface FiscalYear {
|
|
424
|
+
day: number;
|
|
425
|
+
hour?: number;
|
|
426
|
+
millisecond?: number;
|
|
427
|
+
minute?: number;
|
|
428
|
+
month: number;
|
|
429
|
+
referenceType: 'FISCAL_YEAR';
|
|
430
|
+
second?: number;
|
|
431
|
+
}
|
|
432
|
+
interface IndexedTimePoint {
|
|
433
|
+
indexReference: NowReference | TodayReference | WeekReference | MonthReference | QuarterReference | FiscalQuarter | YearReference | FiscalYear;
|
|
434
|
+
offset?: IndexOffset;
|
|
435
|
+
shouldGenerateRefreshTime?: boolean;
|
|
436
|
+
timeType: 'INDEXED';
|
|
437
|
+
timezoneSource: 'CUSTOM' | 'PORTAL' | 'USER';
|
|
438
|
+
zoneId: string;
|
|
439
|
+
}
|
|
440
|
+
interface IndexOffset {
|
|
441
|
+
days?: number;
|
|
442
|
+
hours?: number;
|
|
443
|
+
milliseconds?: number;
|
|
444
|
+
minutes?: number;
|
|
445
|
+
months?: number;
|
|
446
|
+
quarters?: number;
|
|
447
|
+
seconds?: number;
|
|
448
|
+
weeks?: number;
|
|
449
|
+
years?: number;
|
|
450
|
+
}
|
|
451
|
+
interface MonthReference {
|
|
452
|
+
day: number;
|
|
453
|
+
hour?: number;
|
|
454
|
+
millisecond?: number;
|
|
455
|
+
minute?: number;
|
|
456
|
+
referenceType: 'MONTH';
|
|
457
|
+
second?: number;
|
|
458
|
+
}
|
|
459
|
+
interface MultiStringPropertyOperation {
|
|
460
|
+
coalescingRefineBy: NumOccurrencesRefineBy | SetOccurrencesRefineBy;
|
|
461
|
+
defaultValue?: string;
|
|
462
|
+
includeObjectsWithNoValueSet: boolean;
|
|
463
|
+
operationType: string;
|
|
464
|
+
operator: 'CONTAINS' | 'CONTAINS_EXACTLY' | 'DOES_NOT_CONTAIN' | 'DOES_NOT_CONTAIN_EXACTLY' | 'ENDS_WITH' | 'IS_EQUAL_TO' | 'IS_NOT_EQUAL_TO' | 'STARTS_WITH';
|
|
465
|
+
operatorName: string;
|
|
466
|
+
propertyType: 'multistring';
|
|
467
|
+
pruningRefineBy?: RelativeComparativeTimestampRefineBy | RelativeRangedTimestampRefineBy | AbsoluteComparativeTimestampRefineBy | AbsoluteRangedTimestampRefineBy | AllHistoryRefineBy | TimePointOperation | RangedTimeOperation;
|
|
468
|
+
renderSpec?: string;
|
|
469
|
+
values: string[];
|
|
470
|
+
}
|
|
471
|
+
/**
|
|
472
|
+
* Specifies the paging information needed to retrieve the next set of results in a paginated API response
|
|
473
|
+
*/
|
|
474
|
+
interface NextPage {
|
|
475
|
+
/**
|
|
476
|
+
* A paging cursor token for retrieving subsequent pages.
|
|
477
|
+
*/
|
|
478
|
+
after: string;
|
|
479
|
+
/**
|
|
480
|
+
* A URL that can be used to retrieve the next page results.
|
|
481
|
+
*/
|
|
482
|
+
link?: string;
|
|
483
|
+
}
|
|
484
|
+
interface NowReference {
|
|
485
|
+
hour?: number;
|
|
486
|
+
millisecond?: number;
|
|
487
|
+
minute?: number;
|
|
488
|
+
referenceType: 'NOW';
|
|
489
|
+
second?: number;
|
|
490
|
+
}
|
|
491
|
+
interface NumberPropertyOperation {
|
|
492
|
+
defaultValue?: string;
|
|
493
|
+
includeObjectsWithNoValueSet: boolean;
|
|
494
|
+
operationType: string;
|
|
495
|
+
operator: 'HAS_EVER_BEEN_EQUAL_TO' | 'HAS_NEVER_BEEN_EQUAL_TO' | 'IS_EQUAL_TO' | 'IS_GREATER_THAN' | 'IS_GREATER_THAN_OR_EQUAL_TO' | 'IS_LESS_THAN' | 'IS_LESS_THAN_OR_EQUAL_TO' | 'IS_NOT_EQUAL_TO';
|
|
496
|
+
operatorName: string;
|
|
497
|
+
propertyType: 'number';
|
|
498
|
+
renderSpec?: string;
|
|
499
|
+
value: number;
|
|
500
|
+
}
|
|
501
|
+
interface NumOccurrencesRefineBy {
|
|
502
|
+
maxOccurrences?: number;
|
|
503
|
+
minOccurrences?: number;
|
|
504
|
+
type: 'NumOccurrencesRefineBy';
|
|
505
|
+
}
|
|
506
|
+
/**
|
|
507
|
+
* A HubSpot property option
|
|
508
|
+
*/
|
|
509
|
+
interface Option {
|
|
510
|
+
/**
|
|
511
|
+
* A description of the option.
|
|
512
|
+
*/
|
|
513
|
+
description?: string;
|
|
514
|
+
/**
|
|
515
|
+
* The position of the item relative to others in the list.
|
|
516
|
+
*/
|
|
517
|
+
displayOrder?: number;
|
|
518
|
+
/**
|
|
519
|
+
* Whether the option is displayed in HubSpot's UI.
|
|
520
|
+
*/
|
|
521
|
+
hidden: boolean;
|
|
522
|
+
/**
|
|
523
|
+
* A user-friendly label that identifies the option.
|
|
524
|
+
*/
|
|
525
|
+
label: string;
|
|
526
|
+
/**
|
|
527
|
+
* The actual value of the option.
|
|
528
|
+
*/
|
|
529
|
+
value: string;
|
|
530
|
+
}
|
|
531
|
+
interface OptionInput {
|
|
532
|
+
/**
|
|
533
|
+
* null
|
|
534
|
+
*/
|
|
535
|
+
description?: string;
|
|
536
|
+
displayOrder: number;
|
|
537
|
+
hidden: boolean;
|
|
538
|
+
/**
|
|
539
|
+
* null
|
|
540
|
+
*/
|
|
541
|
+
label: string;
|
|
542
|
+
/**
|
|
543
|
+
* null
|
|
544
|
+
*/
|
|
545
|
+
value: string;
|
|
546
|
+
}
|
|
547
|
+
interface Paging {
|
|
548
|
+
next?: NextPage;
|
|
549
|
+
prev?: PreviousPage;
|
|
550
|
+
}
|
|
551
|
+
/**
|
|
552
|
+
* specifies the paging information needed to retrieve the previous set of results in a paginated API response
|
|
553
|
+
*/
|
|
554
|
+
interface PreviousPage {
|
|
555
|
+
/**
|
|
556
|
+
* A paging cursor token for retrieving previous pages.
|
|
557
|
+
*/
|
|
558
|
+
before: string;
|
|
559
|
+
/**
|
|
560
|
+
* A URL that can be used to retrieve the previous pages' results.
|
|
561
|
+
*/
|
|
562
|
+
link?: string;
|
|
563
|
+
}
|
|
564
|
+
/**
|
|
565
|
+
* A HubSpot property
|
|
566
|
+
*/
|
|
567
|
+
interface Property {
|
|
568
|
+
/**
|
|
569
|
+
* Whether the property is archived.
|
|
570
|
+
*/
|
|
571
|
+
archived?: boolean;
|
|
572
|
+
/**
|
|
573
|
+
* The timestamp when the property was archived, in ISO 8601 format.
|
|
574
|
+
*/
|
|
575
|
+
archivedAt?: string;
|
|
576
|
+
/**
|
|
577
|
+
* Whether the property is a calculated field.
|
|
578
|
+
*/
|
|
579
|
+
calculated?: boolean;
|
|
580
|
+
/**
|
|
581
|
+
* The formula used for calculated properties.
|
|
582
|
+
*/
|
|
583
|
+
calculationFormula?: string;
|
|
584
|
+
/**
|
|
585
|
+
* The timestamp when the property was created, in ISO 8601 format.
|
|
586
|
+
*/
|
|
587
|
+
createdAt?: string;
|
|
588
|
+
/**
|
|
589
|
+
* The ID of the user who created the property.
|
|
590
|
+
*/
|
|
591
|
+
createdUserId?: string;
|
|
592
|
+
/**
|
|
593
|
+
* The name of the related currency property.
|
|
594
|
+
*/
|
|
595
|
+
currencyPropertyName?: string;
|
|
596
|
+
/**
|
|
597
|
+
* Indicates the sensitivity level of the property, such as "non_sensitive", "sensitive", or "highly_sensitive".
|
|
598
|
+
*/
|
|
599
|
+
dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive';
|
|
600
|
+
dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until';
|
|
601
|
+
/**
|
|
602
|
+
* A summary of the property's purpose.
|
|
603
|
+
*/
|
|
604
|
+
description: string;
|
|
605
|
+
/**
|
|
606
|
+
* The position of the item relative to others in the list.
|
|
607
|
+
*/
|
|
608
|
+
displayOrder?: number;
|
|
609
|
+
/**
|
|
610
|
+
* Applicable only for enumeration type properties. Should be set to true with a 'referencedObjectType' of 'OWNER'. Otherwise false.
|
|
611
|
+
*/
|
|
612
|
+
externalOptions?: boolean;
|
|
613
|
+
/**
|
|
614
|
+
* Determines how the property will appear in HubSpot's UI or on a form. Learn more in the properties API guide.
|
|
615
|
+
*/
|
|
616
|
+
fieldType: string;
|
|
617
|
+
/**
|
|
618
|
+
* Whether the property can appear on forms.
|
|
619
|
+
*/
|
|
620
|
+
formField?: boolean;
|
|
621
|
+
/**
|
|
622
|
+
* The name of the group to which the property is assigned.
|
|
623
|
+
*/
|
|
624
|
+
groupName: string;
|
|
625
|
+
/**
|
|
626
|
+
* Whether the property is a unique identifier property.
|
|
627
|
+
*/
|
|
628
|
+
hasUniqueValue?: boolean;
|
|
629
|
+
/**
|
|
630
|
+
* Whether or not the property will be hidden from the HubSpot UI. It's recommended that this be set to false for custom properties.
|
|
631
|
+
*/
|
|
632
|
+
hidden?: boolean;
|
|
633
|
+
/**
|
|
634
|
+
* A boolean value set to true for HubSpot default properties.
|
|
635
|
+
*/
|
|
636
|
+
hubspotDefined?: boolean;
|
|
637
|
+
/**
|
|
638
|
+
* The display label for the property.
|
|
639
|
+
*/
|
|
640
|
+
label: string;
|
|
641
|
+
modificationMetadata?: PropertyModificationMetadata;
|
|
642
|
+
/**
|
|
643
|
+
* The internal name for the property.
|
|
644
|
+
*/
|
|
645
|
+
name: string;
|
|
646
|
+
/**
|
|
647
|
+
* Hint for how a number property is displayed and validated in HubSpot's UI. Can be: "unformatted", "formatted", "currency", "percentage", "duration", or "probability".
|
|
648
|
+
*/
|
|
649
|
+
numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted';
|
|
650
|
+
/**
|
|
651
|
+
* A list of valid options for the property. This field is required for enumerated properties.
|
|
914
652
|
*/
|
|
915
|
-
|
|
653
|
+
options: Option[];
|
|
654
|
+
/**
|
|
655
|
+
* Deprecated. Use externalOptionsReferenceType instead.
|
|
656
|
+
*/
|
|
657
|
+
referencedObjectType?: string;
|
|
658
|
+
/**
|
|
659
|
+
* When sensitiveData is true, lists the type of sensitive data contained in the property (e.g., "HIPAA").
|
|
660
|
+
*/
|
|
661
|
+
sensitiveDataCategories?: string[];
|
|
662
|
+
/**
|
|
663
|
+
* Whether to show the currency symbol in HubSpot's UI.
|
|
664
|
+
*/
|
|
665
|
+
showCurrencySymbol?: boolean;
|
|
666
|
+
/**
|
|
667
|
+
* The data type of the property, such as string or number.
|
|
668
|
+
*/
|
|
669
|
+
type: string;
|
|
670
|
+
/**
|
|
671
|
+
* The timestamp when the property was last updated, in ISO 8601 format.
|
|
672
|
+
*/
|
|
673
|
+
updatedAt?: string;
|
|
674
|
+
updatedUserId?: string;
|
|
675
|
+
}
|
|
676
|
+
interface PropertyFilter {
|
|
677
|
+
context?: PropertyFilterContext;
|
|
678
|
+
filterInsightsId?: number;
|
|
679
|
+
filterType: 'PROPERTY';
|
|
680
|
+
frameworkFilterId?: number;
|
|
681
|
+
operation: BoolPropertyOperation | NumberPropertyOperation | StringPropertyOperation | DateTimePropertyOperation | RangedDatePropertyOperation | ComparativeDatePropertyOperation | ComparativeBoolPropertyOperation | ComparativeNumberPropertyOperation | ComparativeStringPropertyOperation | ComparativePropertyUpdatedOperation | RollingDateRangePropertyOperation | RollingPropertyUpdatedOperation | EnumerationPropertyOperation | AllPropertyTypesOperation | RangedNumberPropertyOperation | MultiStringPropertyOperation | DatePropertyOperation | CalendarDatePropertyOperation | TimePointOperation | RangedTimeOperation | RegexPropertyOperation;
|
|
682
|
+
property: string;
|
|
683
|
+
}
|
|
684
|
+
interface PropertyFilterContext {
|
|
685
|
+
objectTypeId: string;
|
|
686
|
+
}
|
|
687
|
+
interface PropertyModificationMetadata {
|
|
688
|
+
archivable: boolean;
|
|
689
|
+
readOnlyDefinition: boolean;
|
|
690
|
+
readOnlyOptions?: boolean;
|
|
691
|
+
readOnlyValue: boolean;
|
|
692
|
+
}
|
|
693
|
+
interface PropertyReferencedTime {
|
|
694
|
+
property: string;
|
|
695
|
+
referenceType: 'ANNIVERSARY' | 'ANNIVERSARY_WITH_ZONE_SAME_LOCAL_CONVERSION' | 'UPDATED_AT' | 'VALUE' | 'VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION';
|
|
696
|
+
timeType: 'PROPERTY_REFERENCED';
|
|
697
|
+
timezoneSource: 'CUSTOM' | 'PORTAL' | 'USER';
|
|
698
|
+
zoneId: string;
|
|
699
|
+
}
|
|
700
|
+
interface QuarterReference {
|
|
701
|
+
day: number;
|
|
702
|
+
hour?: number;
|
|
703
|
+
millisecond?: number;
|
|
704
|
+
minute?: number;
|
|
705
|
+
month: number;
|
|
706
|
+
referenceType: 'QUARTER';
|
|
707
|
+
second?: number;
|
|
708
|
+
}
|
|
709
|
+
interface RangedDatePropertyOperation {
|
|
710
|
+
defaultValue?: string;
|
|
711
|
+
includeObjectsWithNoValueSet: boolean;
|
|
712
|
+
lowerBoundTimestamp: number;
|
|
713
|
+
operationType: string;
|
|
714
|
+
operator: 'IS_BETWEEN' | 'IS_NOT_BETWEEN';
|
|
715
|
+
operatorName: string;
|
|
716
|
+
propertyType: 'datetime-ranged';
|
|
717
|
+
renderSpec?: string;
|
|
718
|
+
requiresTimeZoneConversion: boolean;
|
|
719
|
+
upperBoundTimestamp: number;
|
|
720
|
+
}
|
|
721
|
+
interface RangedNumberPropertyOperation {
|
|
722
|
+
defaultValue?: string;
|
|
723
|
+
includeObjectsWithNoValueSet: boolean;
|
|
724
|
+
lowerBound: number;
|
|
725
|
+
operationType: string;
|
|
726
|
+
operator: 'IS_BETWEEN' | 'IS_NOT_BETWEEN';
|
|
727
|
+
operatorName: string;
|
|
728
|
+
propertyType: 'number-ranged';
|
|
729
|
+
renderSpec?: string;
|
|
730
|
+
upperBound: number;
|
|
731
|
+
}
|
|
732
|
+
interface RangedTimeOperation {
|
|
733
|
+
defaultValue?: string;
|
|
734
|
+
includeObjectsWithNoValueSet: boolean;
|
|
735
|
+
lowerBoundEndpointBehavior: 'EXCLUSIVE' | 'INCLUSIVE';
|
|
736
|
+
lowerBoundTimePoint: DatePoint | IndexedTimePoint | PropertyReferencedTime;
|
|
737
|
+
operationType: string;
|
|
738
|
+
operator: 'IS_BETWEEN' | 'IS_NOT_BETWEEN';
|
|
739
|
+
operatorName: string;
|
|
740
|
+
propertyParser: 'ANNIVERSARY' | 'ANNIVERSARY_WITH_ZONE_SAME_LOCAL_CONVERSION' | 'UPDATED_AT' | 'VALUE' | 'VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION';
|
|
741
|
+
propertyType: 'rangedtime';
|
|
742
|
+
renderSpec?: string;
|
|
743
|
+
type: string;
|
|
744
|
+
upperBoundEndpointBehavior: 'EXCLUSIVE' | 'INCLUSIVE';
|
|
745
|
+
upperBoundTimePoint: DatePoint | IndexedTimePoint | PropertyReferencedTime;
|
|
746
|
+
}
|
|
747
|
+
interface RegexPropertyOperation {
|
|
748
|
+
caseSensitive: boolean;
|
|
749
|
+
defaultValue?: string;
|
|
750
|
+
includeObjectsWithNoValueSet: boolean;
|
|
751
|
+
operationType: string;
|
|
752
|
+
operator: 'DOES_NOT_MATCH_REGEX' | 'MATCHES_REGEX';
|
|
753
|
+
operatorName: string;
|
|
754
|
+
pattern: string;
|
|
755
|
+
propertyType: 'regex';
|
|
756
|
+
renderSpec?: string;
|
|
757
|
+
}
|
|
758
|
+
interface RelativeComparativeTimestampRefineBy {
|
|
759
|
+
comparison: 'AFTER' | 'BEFORE';
|
|
760
|
+
timeOffset: TimeOffset;
|
|
761
|
+
type: 'RelativeComparativeTimestampRefineBy';
|
|
762
|
+
}
|
|
763
|
+
interface RelativeRangedTimestampRefineBy {
|
|
764
|
+
lowerBoundOffset: TimeOffset;
|
|
765
|
+
rangeType: 'BETWEEN' | 'NOT_BETWEEN';
|
|
766
|
+
type: 'RelativeRangedTimestampRefineBy';
|
|
767
|
+
upperBoundOffset: TimeOffset;
|
|
768
|
+
}
|
|
769
|
+
interface RollingDateRangePropertyOperation {
|
|
770
|
+
defaultValue?: string;
|
|
771
|
+
includeObjectsWithNoValueSet: boolean;
|
|
772
|
+
numberOfDays: number;
|
|
773
|
+
operationType: string;
|
|
774
|
+
operator: 'IS_LESS_THAN_X_DAYS_AGO' | 'IS_LESS_THAN_X_DAYS_FROM_NOW' | 'IS_MORE_THAN_X_DAYS_AGO' | 'IS_MORE_THAN_X_DAYS_FROM_NOW';
|
|
775
|
+
operatorName: string;
|
|
776
|
+
propertyType: 'datetime-rolling';
|
|
777
|
+
renderSpec?: string;
|
|
778
|
+
requiresTimeZoneConversion: boolean;
|
|
779
|
+
}
|
|
780
|
+
interface RollingPropertyUpdatedOperation {
|
|
781
|
+
defaultValue?: string;
|
|
782
|
+
includeObjectsWithNoValueSet: boolean;
|
|
783
|
+
numberOfDays: number;
|
|
784
|
+
operationType: string;
|
|
785
|
+
operator: 'NOT_UPDATED_IN_LAST_X_DAYS' | 'UPDATED_IN_LAST_X_DAYS';
|
|
786
|
+
operatorName: string;
|
|
787
|
+
propertyType: 'rolling-property-updated';
|
|
788
|
+
renderSpec?: string;
|
|
789
|
+
}
|
|
790
|
+
interface SetOccurrencesRefineBy {
|
|
791
|
+
setType: 'ALL' | 'ALL_INCLUDE_EMPTY' | 'ANY' | 'ANY_INCLUDE_EMPTY' | 'NONE' | 'NONE_EXCLUDE_EMPTY';
|
|
792
|
+
type: 'SetOccurrencesRefineBy';
|
|
793
|
+
}
|
|
794
|
+
interface StringPropertyOperation {
|
|
795
|
+
defaultValue?: string;
|
|
796
|
+
includeObjectsWithNoValueSet: boolean;
|
|
797
|
+
operationType: string;
|
|
798
|
+
operator: 'CONTAINS' | 'DOES_NOT_CONTAIN' | 'ENDS_WITH' | 'HAS_EVER_BEEN_EQUAL_TO' | 'HAS_EVER_CONTAINED' | 'HAS_NEVER_BEEN_EQUAL_TO' | 'HAS_NEVER_CONTAINED' | 'IS_EQUAL_TO' | 'IS_NOT_EQUAL_TO' | 'STARTS_WITH';
|
|
799
|
+
operatorName: string;
|
|
800
|
+
propertyType: 'string';
|
|
801
|
+
renderSpec?: string;
|
|
802
|
+
value: string;
|
|
803
|
+
}
|
|
804
|
+
interface TimeOffset {
|
|
805
|
+
amount: number;
|
|
806
|
+
offsetDirection: 'FUTURE' | 'PAST';
|
|
807
|
+
timeUnit: 'DAYS' | 'HOURS' | 'MINUTES' | 'WEEKS';
|
|
808
|
+
}
|
|
809
|
+
interface TimePointOperation {
|
|
810
|
+
defaultValue?: string;
|
|
811
|
+
endpointBehavior: 'EXCLUSIVE' | 'INCLUSIVE';
|
|
812
|
+
includeObjectsWithNoValueSet: boolean;
|
|
813
|
+
operationType: string;
|
|
814
|
+
operator: 'IS_AFTER' | 'IS_BEFORE';
|
|
815
|
+
operatorName: string;
|
|
816
|
+
propertyParser: 'ANNIVERSARY' | 'ANNIVERSARY_WITH_ZONE_SAME_LOCAL_CONVERSION' | 'UPDATED_AT' | 'VALUE' | 'VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION';
|
|
817
|
+
propertyType: 'timepoint';
|
|
818
|
+
renderSpec?: string;
|
|
819
|
+
timePoint: DatePoint | IndexedTimePoint | PropertyReferencedTime;
|
|
820
|
+
type: string;
|
|
821
|
+
}
|
|
822
|
+
interface TodayReference {
|
|
823
|
+
hour?: number;
|
|
824
|
+
millisecond?: number;
|
|
825
|
+
minute?: number;
|
|
826
|
+
referenceType: 'TODAY';
|
|
827
|
+
second?: number;
|
|
828
|
+
}
|
|
829
|
+
interface WeekReference {
|
|
830
|
+
dayOfWeek: 'FRIDAY' | 'MONDAY' | 'SATURDAY' | 'SUNDAY' | 'THURSDAY' | 'TUESDAY' | 'WEDNESDAY';
|
|
831
|
+
hour?: number;
|
|
832
|
+
millisecond?: number;
|
|
833
|
+
minute?: number;
|
|
834
|
+
referenceType: 'WEEK';
|
|
835
|
+
second?: number;
|
|
836
|
+
}
|
|
837
|
+
interface YearReference {
|
|
838
|
+
day: number;
|
|
839
|
+
hour?: number;
|
|
840
|
+
millisecond?: number;
|
|
841
|
+
minute?: number;
|
|
842
|
+
month: number;
|
|
843
|
+
referenceType: 'YEAR';
|
|
844
|
+
second?: number;
|
|
845
|
+
}
|
|
846
|
+
}
|
|
847
|
+
declare namespace EventsManageEventDefinitionsEventsDefinitions {
|
|
848
|
+
type CreateInput = EventsManageEventDefinitionsSchemas.ExternalBehavioralEventTypeDefinitionEgg;
|
|
849
|
+
type CreateOutput = EventsManageEventDefinitionsSchemas.ExternalBehavioralEventTypeDefinition;
|
|
850
|
+
interface CreatePropertyInput {
|
|
851
|
+
data: EventsManageEventDefinitionsSchemas.ExternalBehavioralEventPropertyCreate;
|
|
852
|
+
eventName: string;
|
|
853
|
+
}
|
|
854
|
+
type CreatePropertyOutput = EventsManageEventDefinitionsSchemas.Property;
|
|
855
|
+
interface DeleteInput {
|
|
856
|
+
eventName: string;
|
|
857
|
+
}
|
|
858
|
+
type DeleteOutput = void;
|
|
859
|
+
interface DeletePropertyInput {
|
|
860
|
+
eventName: string;
|
|
861
|
+
propertyName: string;
|
|
862
|
+
}
|
|
863
|
+
type DeletePropertyOutput = void;
|
|
864
|
+
interface GetInput {
|
|
865
|
+
eventName: string;
|
|
866
|
+
}
|
|
867
|
+
type GetOutput = EventsManageEventDefinitionsSchemas.ExternalBehavioralEventTypeDefinition;
|
|
868
|
+
interface ListInput {
|
|
869
|
+
/**
|
|
870
|
+
* The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
|
|
871
|
+
*/
|
|
872
|
+
after?: string;
|
|
873
|
+
includeProperties?: boolean;
|
|
874
|
+
/**
|
|
875
|
+
* The maximum number of results to display per page.
|
|
876
|
+
*/
|
|
877
|
+
limit?: number;
|
|
878
|
+
searchString?: string;
|
|
879
|
+
sortOrder?: string;
|
|
880
|
+
}
|
|
881
|
+
type ListOutput = EventsManageEventDefinitionsSchemas.CollectionResponseWithTotalExternalBehavioralEventTypeDefinition;
|
|
882
|
+
type SendBatchInput = EventsManageEventDefinitionsSchemas.BatchedBehavioralEventHttpCompletionRequest;
|
|
883
|
+
type SendBatchOutput = void;
|
|
884
|
+
interface UpdateInput {
|
|
885
|
+
data: EventsManageEventDefinitionsSchemas.ExternalBehavioralEventTypeDefinitionPatch;
|
|
886
|
+
eventName: string;
|
|
916
887
|
}
|
|
888
|
+
type UpdateOutput = EventsManageEventDefinitionsSchemas.ExternalBehavioralEventTypeDefinition;
|
|
889
|
+
interface UpdatePropertyInput {
|
|
890
|
+
data: EventsManageEventDefinitionsSchemas.ExternalBehavioralEventPropertyDefinitionPatch;
|
|
891
|
+
eventName: string;
|
|
892
|
+
propertyName: string;
|
|
893
|
+
}
|
|
894
|
+
type UpdatePropertyOutput = EventsManageEventDefinitionsSchemas.Property;
|
|
917
895
|
/**
|
|
918
896
|
* Usage example:
|
|
919
897
|
* ```ts
|
|
920
|
-
* import {
|
|
921
|
-
* client.send(
|
|
898
|
+
* import { eventsManageEventDefinitionsEventsDefinitions } from '@hubspot/api-client-core';
|
|
899
|
+
* client.send(eventsManageEventDefinitionsEventsDefinitions.create(input));
|
|
922
900
|
* ```
|
|
923
901
|
*/
|
|
924
|
-
interface
|
|
902
|
+
interface API {
|
|
925
903
|
/**
|
|
926
904
|
* Create custom event definition
|
|
927
905
|
* @apiPath /events/2026-03/event-definitions
|
|
928
906
|
* @apiMethod POST
|
|
929
907
|
* @requiredScopes behavioral-events-external-api
|
|
930
908
|
*/
|
|
931
|
-
create: (input:
|
|
909
|
+
create: (input: CreateInput) => Operation<CreateOutput>;
|
|
910
|
+
/**
|
|
911
|
+
* Create a property for an event definition
|
|
912
|
+
* @apiPath /events/2026-03/event-definitions/{eventName}/property
|
|
913
|
+
* @apiMethod POST
|
|
914
|
+
* @requiredScopes behavioral-events-external-api
|
|
915
|
+
*/
|
|
916
|
+
createProperty: (input: CreatePropertyInput) => Operation<CreatePropertyOutput>;
|
|
932
917
|
/**
|
|
933
918
|
* Delete an event definition
|
|
934
919
|
* @apiPath /events/2026-03/event-definitions/{eventName}
|
|
935
920
|
* @apiMethod DELETE
|
|
936
921
|
* @requiredScopes behavioral-events-external-api
|
|
937
922
|
*/
|
|
938
|
-
delete: (input:
|
|
923
|
+
delete: (input: DeleteInput) => Operation<DeleteOutput>;
|
|
939
924
|
/**
|
|
940
925
|
* Delete a property from a custom event definition
|
|
941
926
|
* @apiPath /events/2026-03/event-definitions/{eventName}/property/{propertyName}
|
|
942
927
|
* @apiMethod DELETE
|
|
943
928
|
* @requiredScopes behavioral-events-external-api
|
|
944
929
|
*/
|
|
945
|
-
deleteProperty: (input:
|
|
930
|
+
deleteProperty: (input: DeletePropertyInput) => Operation<DeletePropertyOutput>;
|
|
946
931
|
/**
|
|
947
932
|
* Retrieve a custom event definition
|
|
948
933
|
* @apiPath /events/2026-03/event-definitions/{eventName}
|
|
949
934
|
* @apiMethod GET
|
|
950
935
|
* @requiredScopes behavioral-events-external-api
|
|
951
936
|
*/
|
|
952
|
-
get: (input:
|
|
937
|
+
get: (input: GetInput) => Operation<GetOutput>;
|
|
953
938
|
/**
|
|
954
939
|
* Retrieve event definitions
|
|
955
940
|
* @apiPath /events/2026-03/event-definitions
|
|
956
941
|
* @apiMethod GET
|
|
957
942
|
* @requiredScopes behavioral-events-external-api
|
|
958
943
|
*/
|
|
959
|
-
list: (input?:
|
|
944
|
+
list: (input?: ListInput) => Operation<ListOutput>;
|
|
945
|
+
/**
|
|
946
|
+
* @apiPath /events/2026-03/send/batch
|
|
947
|
+
* @apiMethod POST
|
|
948
|
+
* @requiredScopes behavioral-events-ingestion
|
|
949
|
+
*/
|
|
950
|
+
sendBatch: (input: SendBatchInput) => Operation<SendBatchOutput>;
|
|
960
951
|
/**
|
|
961
952
|
* Update a custom event definition
|
|
962
953
|
* @apiPath /events/2026-03/event-definitions/{eventName}
|
|
963
954
|
* @apiMethod PATCH
|
|
964
955
|
* @requiredScopes behavioral-events-external-api
|
|
965
956
|
*/
|
|
966
|
-
update: (input:
|
|
957
|
+
update: (input: UpdateInput) => Operation<UpdateOutput>;
|
|
967
958
|
/**
|
|
968
959
|
* Update an existing custom event property
|
|
969
960
|
* @apiPath /events/2026-03/event-definitions/{eventName}/property/{propertyName}
|
|
970
961
|
* @apiMethod PATCH
|
|
971
962
|
* @requiredScopes behavioral-events-external-api
|
|
972
963
|
*/
|
|
973
|
-
updateProperty: (input:
|
|
974
|
-
}
|
|
975
|
-
/**
|
|
976
|
-
* Usage example:
|
|
977
|
-
* ```ts
|
|
978
|
-
* import { eventsManageEventDefinitions } from '@hubspot/api-client-core';
|
|
979
|
-
* client.send(eventsManageEventDefinitions.batch.sendBatch(input));
|
|
980
|
-
* ```
|
|
981
|
-
*/
|
|
982
|
-
interface BatchAPI {
|
|
983
|
-
/**
|
|
984
|
-
* @apiPath /events/2026-03/send/batch
|
|
985
|
-
* @apiMethod POST
|
|
986
|
-
* @requiredScopes behavioral-events-ingestion
|
|
987
|
-
*/
|
|
988
|
-
sendBatch: (input: Batch.SendBatchInput) => Operation<Batch.SendBatchOutput>;
|
|
989
|
-
}
|
|
990
|
-
/**
|
|
991
|
-
* Usage example:
|
|
992
|
-
* ```ts
|
|
993
|
-
* import { eventsManageEventDefinitions } from '@hubspot/api-client-core';
|
|
994
|
-
* client.send(eventsManageEventDefinitions.advanced.createProperty(input));
|
|
995
|
-
* ```
|
|
996
|
-
*/
|
|
997
|
-
interface API {
|
|
998
|
-
advanced: AdvancedAPI;
|
|
999
|
-
basic: BasicAPI;
|
|
1000
|
-
batch: BatchAPI;
|
|
964
|
+
updateProperty: (input: UpdatePropertyInput) => Operation<UpdatePropertyOutput>;
|
|
1001
965
|
}
|
|
1002
966
|
}
|
|
1003
967
|
//#endregion
|
|
1004
|
-
export {
|
|
968
|
+
export { EventsManageEventDefinitionsEventsDefinitions, EventsManageEventDefinitionsSchemas };
|
|
1005
969
|
//# sourceMappingURL=manage-event-definitions-types.generated.d.ts.map
|