@hubspot/app-connect-sdk 1.0.0-alpha.1
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 +4 -0
- package/.turbo/turbo-lint.log +2 -0
- package/.turbo/turbo-test.log +76 -0
- package/.turbo/turbo-tsc.log +2 -0
- package/.turbo/turbo-tsdown.log +521 -0
- package/README.md +5 -0
- package/build/tsconfig.browser.tsbuildinfo +1 -0
- package/build/tsconfig.server.tsbuildinfo +1 -0
- package/dist/browser/HubSpotAppConnect-BW45gyDs.js +489 -0
- package/dist/browser/HubSpotAppConnect-BW45gyDs.js.map +1 -0
- package/dist/browser/assets/src/browser/react/components/AppConnectHeader/AppConnectHeader.css.ts.vanilla-DpJ0aBGF.css +211 -0
- package/dist/browser/assets/src/browser/react/components/Button/Button.css.ts.vanilla-Df16gUKx.css +42 -0
- package/dist/browser/assets/src/browser/react/components/ConnectButton/ConnectButton.css.ts.vanilla-BXXMQqfA.css +66 -0
- package/dist/browser/assets/src/browser/react/components/DisconnectedBody/DisconnectedBody.css.ts.vanilla-DLvostZL.css +19 -0
- package/dist/browser/assets/src/browser/react/components/HubSpotAppConnect/HubSpotAppConnect.css.ts.vanilla-Boi40eip.css +17 -0
- package/dist/browser/assets/src/browser/react/components/LoadingIndicator/LoadingIndicator.css.ts.vanilla-RVWGi6Ny.css +25 -0
- package/dist/browser/assets/src/browser/react/components/ShareButton/ShareButton.css.ts.vanilla-CY8SC-0T.css +40 -0
- package/dist/browser/assets/src/browser/theme-tokens.generated.css.ts.vanilla-C8Rjb8NH.css +220 -0
- package/dist/browser/assets/src/browser/theme.css.ts.vanilla-D_GBwEeI.css +12 -0
- package/dist/browser/create-vctOhpX9.js +517 -0
- package/dist/browser/create-vctOhpX9.js.map +1 -0
- package/dist/browser/index.d.ts +465 -0
- package/dist/browser/index.js +3 -0
- package/dist/browser/react/lovable.d.ts +30 -0
- package/dist/browser/react/lovable.js +23 -0
- package/dist/browser/react/lovable.js.map +1 -0
- package/dist/browser/react.d.ts +47 -0
- package/dist/browser/react.js +2 -0
- package/dist/browser/theme.css-CJbxi5hC.js +368 -0
- package/dist/browser/theme.css-CJbxi5hC.js.map +1 -0
- package/dist/browser/types-rTQw6A54.d.ts +79 -0
- package/dist/server/api-client-core/apis/account/account-info-types.generated.d.ts +111 -0
- package/dist/server/api-client-core/apis/account/account-info.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/account/account-info.generated.js +9 -0
- package/dist/server/api-client-core/apis/account/account-info.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/account/audit-logs-types.generated.d.ts +247 -0
- package/dist/server/api-client-core/apis/account/audit-logs.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/account/audit-logs.generated.js +28 -0
- package/dist/server/api-client-core/apis/account/audit-logs.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/auth/oauth-types.generated.d.ts +121 -0
- package/dist/server/api-client-core/apis/auth/oauth.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/auth/oauth.generated.js +19 -0
- package/dist/server/api-client-core/apis/auth/oauth.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/automation/actions-types.generated.d.ts +933 -0
- package/dist/server/api-client-core/apis/automation/actions.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/automation/actions.generated.js +121 -0
- package/dist/server/api-client-core/apis/automation/actions.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/automation/sequences-types.generated.d.ts +422 -0
- package/dist/server/api-client-core/apis/automation/sequences.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/automation/sequences.generated.js +22 -0
- package/dist/server/api-client-core/apis/automation/sequences.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/business-units-types.generated.d.ts +75 -0
- package/dist/server/api-client-core/apis/business-units.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/business-units.generated.js +12 -0
- package/dist/server/api-client-core/apis/business-units.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/cms/authors-types.generated.d.ts +551 -0
- package/dist/server/api-client-core/apis/cms/authors.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/cms/authors.generated.js +163 -0
- package/dist/server/api-client-core/apis/cms/authors.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/cms/blog-settings-types.generated.d.ts +366 -0
- package/dist/server/api-client-core/apis/cms/blog-settings.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/cms/blog-settings.generated.js +43 -0
- package/dist/server/api-client-core/apis/cms/blog-settings.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/cms/cms-content-audit-types.generated.d.ts +157 -0
- package/dist/server/api-client-core/apis/cms/cms-content-audit.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/cms/cms-content-audit.generated.js +18 -0
- package/dist/server/api-client-core/apis/cms/cms-content-audit.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/cms/domains-types.generated.d.ts +193 -0
- package/dist/server/api-client-core/apis/cms/domains.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/cms/domains.generated.js +20 -0
- package/dist/server/api-client-core/apis/cms/domains.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/cms/hubdb-types.generated.d.ts +1097 -0
- package/dist/server/api-client-core/apis/cms/hubdb.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/cms/hubdb.generated.js +192 -0
- package/dist/server/api-client-core/apis/cms/hubdb.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/cms/media-bridge-types.generated.d.ts +1780 -0
- package/dist/server/api-client-core/apis/cms/media-bridge.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/cms/media-bridge.generated.js +185 -0
- package/dist/server/api-client-core/apis/cms/media-bridge.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/cms/pages-types.generated.d.ts +1768 -0
- package/dist/server/api-client-core/apis/cms/pages.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/cms/pages.generated.js +331 -0
- package/dist/server/api-client-core/apis/cms/pages.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/cms/posts-types.generated.d.ts +1090 -0
- package/dist/server/api-client-core/apis/cms/posts.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/cms/posts.generated.js +201 -0
- package/dist/server/api-client-core/apis/cms/posts.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/cms/site-search-types.generated.d.ts +200 -0
- package/dist/server/api-client-core/apis/cms/site-search.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/cms/site-search.generated.js +32 -0
- package/dist/server/api-client-core/apis/cms/site-search.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/cms/source-code-types.generated.d.ts +218 -0
- package/dist/server/api-client-core/apis/cms/source-code.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/cms/source-code.generated.js +52 -0
- package/dist/server/api-client-core/apis/cms/source-code.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/cms/tags-types.generated.d.ts +515 -0
- package/dist/server/api-client-core/apis/cms/tags.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/cms/tags.generated.js +163 -0
- package/dist/server/api-client-core/apis/cms/tags.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/cms/url-mappings-types.generated.d.ts +177 -0
- package/dist/server/api-client-core/apis/cms/url-mappings.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/cms/url-mappings.generated.js +14 -0
- package/dist/server/api-client-core/apis/cms/url-mappings.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/cms/url-redirects-types.generated.d.ts +226 -0
- package/dist/server/api-client-core/apis/cms/url-redirects.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/cms/url-redirects.generated.js +26 -0
- package/dist/server/api-client-core/apis/cms/url-redirects.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/communication-preferences/subscriptions-types.generated.d.ts +802 -0
- package/dist/server/api-client-core/apis/communication-preferences/subscriptions.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/communication-preferences/subscriptions.generated.js +74 -0
- package/dist/server/api-client-core/apis/communication-preferences/subscriptions.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/conversations/custom-channels-types.generated.d.ts +551 -0
- package/dist/server/api-client-core/apis/conversations/custom-channels.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/conversations/custom-channels.generated.js +80 -0
- package/dist/server/api-client-core/apis/conversations/custom-channels.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/conversations/visitor-identification-types.generated.d.ts +60 -0
- package/dist/server/api-client-core/apis/conversations/visitor-identification.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/conversations/visitor-identification.generated.js +6 -0
- package/dist/server/api-client-core/apis/conversations/visitor-identification.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/conversations-types.generated.d.ts +908 -0
- package/dist/server/api-client-core/apis/conversations.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/conversations.generated.js +108 -0
- package/dist/server/api-client-core/apis/conversations.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/app-uninstalls-types.generated.d.ts +37 -0
- package/dist/server/api-client-core/apis/crm/app-uninstalls.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/app-uninstalls.generated.js +6 -0
- package/dist/server/api-client-core/apis/crm/app-uninstalls.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/appointments-types.generated.d.ts +989 -0
- package/dist/server/api-client-core/apis/crm/appointments.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/appointments.generated.js +118 -0
- package/dist/server/api-client-core/apis/crm/appointments.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/associations-schema-types.generated.d.ts +329 -0
- package/dist/server/api-client-core/apis/crm/associations-schema.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/associations-schema.generated.js +60 -0
- package/dist/server/api-client-core/apis/crm/associations-schema.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/associations-types.generated.d.ts +661 -0
- package/dist/server/api-client-core/apis/crm/associations.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/associations.generated.js +83 -0
- package/dist/server/api-client-core/apis/crm/associations.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/calling-extensions-types.generated.d.ts +466 -0
- package/dist/server/api-client-core/apis/crm/calling-extensions.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/calling-extensions.generated.js +42 -0
- package/dist/server/api-client-core/apis/crm/calling-extensions.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/calls-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/calls.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/calls.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/calls.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/carts-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/carts.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/carts.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/carts.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/commerce-payments-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/commerce-payments.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/commerce-payments.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/commerce-payments.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/commerce-subscriptions-types.generated.d.ts +847 -0
- package/dist/server/api-client-core/apis/crm/commerce-subscriptions.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/commerce-subscriptions.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/commerce-subscriptions.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/communications-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/communications.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/communications.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/communications.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/companies-types.generated.d.ts +884 -0
- package/dist/server/api-client-core/apis/crm/companies.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/companies.generated.js +67 -0
- package/dist/server/api-client-core/apis/crm/companies.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/contacts-types.generated.d.ts +899 -0
- package/dist/server/api-client-core/apis/crm/contacts.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/contacts.generated.js +70 -0
- package/dist/server/api-client-core/apis/crm/contacts.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/contracts-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/contracts.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/contracts.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/contracts.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/courses-types.generated.d.ts +853 -0
- package/dist/server/api-client-core/apis/crm/courses.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/courses.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/courses.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/crm-owners-types.generated.d.ts +140 -0
- package/dist/server/api-client-core/apis/crm/crm-owners.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/crm-owners.generated.js +20 -0
- package/dist/server/api-client-core/apis/crm/crm-owners.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/custom-objects-types.generated.d.ts +934 -0
- package/dist/server/api-client-core/apis/crm/custom-objects.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/custom-objects.generated.js +101 -0
- package/dist/server/api-client-core/apis/crm/custom-objects.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/deal-splits-types.generated.d.ts +196 -0
- package/dist/server/api-client-core/apis/crm/deal-splits.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/deal-splits.generated.js +9 -0
- package/dist/server/api-client-core/apis/crm/deal-splits.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/deals-types.generated.d.ts +872 -0
- package/dist/server/api-client-core/apis/crm/deals.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/deals.generated.js +67 -0
- package/dist/server/api-client-core/apis/crm/deals.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/discounts-types.generated.d.ts +846 -0
- package/dist/server/api-client-core/apis/crm/discounts.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/discounts.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/discounts.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/emails-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/emails.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/emails.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/emails.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/exports-types.generated.d.ts +281 -0
- package/dist/server/api-client-core/apis/crm/exports.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/exports.generated.js +12 -0
- package/dist/server/api-client-core/apis/crm/exports.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/feedback-submissions-types.generated.d.ts +616 -0
- package/dist/server/api-client-core/apis/crm/feedback-submissions.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/feedback-submissions.generated.js +55 -0
- package/dist/server/api-client-core/apis/crm/feedback-submissions.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/fees-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/fees.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/fees.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/fees.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/goal-targets-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/goal-targets.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/goal-targets.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/goal-targets.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/imports-types.generated.d.ts +371 -0
- package/dist/server/api-client-core/apis/crm/imports.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/imports.generated.js +30 -0
- package/dist/server/api-client-core/apis/crm/imports.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/invoices-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/invoices.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/invoices.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/invoices.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/leads-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/leads.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/leads.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/leads.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/limits-tracking-types.generated.d.ts +331 -0
- package/dist/server/api-client-core/apis/crm/limits-tracking.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/limits-tracking.generated.js +22 -0
- package/dist/server/api-client-core/apis/crm/limits-tracking.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/line-items-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/line-items.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/line-items.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/line-items.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/listings-types.generated.d.ts +853 -0
- package/dist/server/api-client-core/apis/crm/listings.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/listings.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/listings.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/lists-types.generated.d.ts +2265 -0
- package/dist/server/api-client-core/apis/crm/lists.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/lists.generated.js +105 -0
- package/dist/server/api-client-core/apis/crm/lists.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/meetings-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/meetings.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/meetings.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/meetings.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/notes-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/notes.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/notes.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/notes.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/object-library-types.generated.d.ts +60 -0
- package/dist/server/api-client-core/apis/crm/object-library.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/object-library.generated.js +9 -0
- package/dist/server/api-client-core/apis/crm/object-library.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/objects-types.generated.d.ts +712 -0
- package/dist/server/api-client-core/apis/crm/objects.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/objects.generated.js +76 -0
- package/dist/server/api-client-core/apis/crm/objects.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/orders-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/orders.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/orders.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/orders.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/partner-clients-types.generated.d.ts +725 -0
- package/dist/server/api-client-core/apis/crm/partner-clients.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/partner-clients.generated.js +71 -0
- package/dist/server/api-client-core/apis/crm/partner-clients.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/partner-services-types.generated.d.ts +725 -0
- package/dist/server/api-client-core/apis/crm/partner-services.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/partner-services.generated.js +71 -0
- package/dist/server/api-client-core/apis/crm/partner-services.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/pipelines-types.generated.d.ts +430 -0
- package/dist/server/api-client-core/apis/crm/pipelines.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/pipelines.generated.js +94 -0
- package/dist/server/api-client-core/apis/crm/pipelines.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/postal-mail-types.generated.d.ts +844 -0
- package/dist/server/api-client-core/apis/crm/postal-mail.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/postal-mail.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/postal-mail.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/products-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/products.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/products.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/products.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/projects-types.generated.d.ts +881 -0
- package/dist/server/api-client-core/apis/crm/projects.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/projects.generated.js +67 -0
- package/dist/server/api-client-core/apis/crm/projects.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/properties-types.generated.d.ts +603 -0
- package/dist/server/api-client-core/apis/crm/properties.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/properties.generated.js +86 -0
- package/dist/server/api-client-core/apis/crm/properties.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/property-validations-types.generated.d.ts +121 -0
- package/dist/server/api-client-core/apis/crm/property-validations.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/property-validations.generated.js +25 -0
- package/dist/server/api-client-core/apis/crm/property-validations.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/public-app-crm-cards-types.generated.d.ts +486 -0
- package/dist/server/api-client-core/apis/crm/public-app-crm-cards.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/public-app-crm-cards.generated.js +34 -0
- package/dist/server/api-client-core/apis/crm/public-app-crm-cards.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/public-app-feature-flags-types.generated.d.ts +247 -0
- package/dist/server/api-client-core/apis/crm/public-app-feature-flags.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/public-app-feature-flags.generated.js +69 -0
- package/dist/server/api-client-core/apis/crm/public-app-feature-flags.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/quotes-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/quotes.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/quotes.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/quotes.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/schemas-types.generated.d.ts +669 -0
- package/dist/server/api-client-core/apis/crm/schemas.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/schemas.generated.js +41 -0
- package/dist/server/api-client-core/apis/crm/schemas.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/services-types.generated.d.ts +853 -0
- package/dist/server/api-client-core/apis/crm/services.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/services.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/services.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/tasks-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/tasks.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/tasks.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/tasks.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/taxes-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/taxes.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/taxes.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/taxes.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/tickets-types.generated.d.ts +884 -0
- package/dist/server/api-client-core/apis/crm/tickets.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/tickets.generated.js +67 -0
- package/dist/server/api-client-core/apis/crm/tickets.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/timeline-types.generated.d.ts +187 -0
- package/dist/server/api-client-core/apis/crm/timeline.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/timeline.generated.js +12 -0
- package/dist/server/api-client-core/apis/crm/timeline.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/transcriptions-types.generated.d.ts +152 -0
- package/dist/server/api-client-core/apis/crm/transcriptions.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/transcriptions.generated.js +15 -0
- package/dist/server/api-client-core/apis/crm/transcriptions.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/users-types.generated.d.ts +850 -0
- package/dist/server/api-client-core/apis/crm/users.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/users.generated.js +66 -0
- package/dist/server/api-client-core/apis/crm/users.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/crm/video-conferencing-extension-types.generated.d.ts +72 -0
- package/dist/server/api-client-core/apis/crm/video-conferencing-extension.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/crm/video-conferencing-extension.generated.js +13 -0
- package/dist/server/api-client-core/apis/crm/video-conferencing-extension.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/events/manage-event-definitions-types.generated.d.ts +1005 -0
- package/dist/server/api-client-core/apis/events/manage-event-definitions.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/events/manage-event-definitions.generated.js +39 -0
- package/dist/server/api-client-core/apis/events/manage-event-definitions.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/events/send-event-completions-types.generated.d.ts +94 -0
- package/dist/server/api-client-core/apis/events/send-event-completions.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/events/send-event-completions.generated.js +9 -0
- package/dist/server/api-client-core/apis/events/send-event-completions.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/events-types.generated.d.ts +137 -0
- package/dist/server/api-client-core/apis/events.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/events.generated.js +23 -0
- package/dist/server/api-client-core/apis/events.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/files-types.generated.d.ts +791 -0
- package/dist/server/api-client-core/apis/files.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/files.generated.js +119 -0
- package/dist/server/api-client-core/apis/files.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/marketing/campaigns-public-api-types.generated.d.ts +989 -0
- package/dist/server/api-client-core/apis/marketing/campaigns-public-api.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/marketing/campaigns-public-api.generated.js +139 -0
- package/dist/server/api-client-core/apis/marketing/campaigns-public-api.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/marketing/marketing-emails-types.generated.d.ts +883 -0
- package/dist/server/api-client-core/apis/marketing/marketing-emails.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/marketing/marketing-emails.generated.js +108 -0
- package/dist/server/api-client-core/apis/marketing/marketing-emails.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/marketing/marketing-events-types.generated.d.ts +1788 -0
- package/dist/server/api-client-core/apis/marketing/marketing-events.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/marketing/marketing-events.generated.js +176 -0
- package/dist/server/api-client-core/apis/marketing/marketing-events.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/marketing/single-send-types.generated.d.ts +123 -0
- package/dist/server/api-client-core/apis/marketing/single-send.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/marketing/single-send.generated.js +6 -0
- package/dist/server/api-client-core/apis/marketing/single-send.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/marketing/transactional-single-send-types.generated.d.ts +257 -0
- package/dist/server/api-client-core/apis/marketing/transactional-single-send.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/marketing/transactional-single-send.generated.js +20 -0
- package/dist/server/api-client-core/apis/marketing/transactional-single-send.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/meta/origins-types.generated.d.ts +77 -0
- package/dist/server/api-client-core/apis/meta/origins.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/meta/origins.generated.js +15 -0
- package/dist/server/api-client-core/apis/meta/origins.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/scheduler/meetings-types.generated.d.ts +913 -0
- package/dist/server/api-client-core/apis/scheduler/meetings.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/scheduler/meetings.generated.js +34 -0
- package/dist/server/api-client-core/apis/scheduler/meetings.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/settings/multicurrency-types.generated.d.ts +404 -0
- package/dist/server/api-client-core/apis/settings/multicurrency.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/settings/multicurrency.generated.js +38 -0
- package/dist/server/api-client-core/apis/settings/multicurrency.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/settings/tax-rates-types.generated.d.ts +111 -0
- package/dist/server/api-client-core/apis/settings/tax-rates.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/settings/tax-rates.generated.js +13 -0
- package/dist/server/api-client-core/apis/settings/tax-rates.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/settings/user-provisioning-types.generated.d.ts +297 -0
- package/dist/server/api-client-core/apis/settings/user-provisioning.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/settings/user-provisioning.generated.js +31 -0
- package/dist/server/api-client-core/apis/settings/user-provisioning.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/webhooks-journal-types.generated.d.ts +643 -0
- package/dist/server/api-client-core/apis/webhooks-journal.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/webhooks-journal.generated.js +75 -0
- package/dist/server/api-client-core/apis/webhooks-journal.generated.js.map +1 -0
- package/dist/server/api-client-core/apis/webhooks-types.generated.d.ts +1016 -0
- package/dist/server/api-client-core/apis/webhooks.generated.d.ts +7 -0
- package/dist/server/api-client-core/apis/webhooks.generated.js +105 -0
- package/dist/server/api-client-core/apis/webhooks.generated.js.map +1 -0
- package/dist/server/api-client-core/binary-data.d.ts +33 -0
- package/dist/server/api-client-core/binary-data.js +29 -0
- package/dist/server/api-client-core/binary-data.js.map +1 -0
- package/dist/server/api-client-core/client.d.ts +14 -0
- package/dist/server/api-client-core/client.js +75 -0
- package/dist/server/api-client-core/client.js.map +1 -0
- package/dist/server/api-client-core/codegen-helpers/file-op-wrappers.js +25 -0
- package/dist/server/api-client-core/codegen-helpers/file-op-wrappers.js.map +1 -0
- package/dist/server/api-client-core/errors.d.ts +27 -0
- package/dist/server/api-client-core/errors.js +33 -0
- package/dist/server/api-client-core/errors.js.map +1 -0
- package/dist/server/api-client-core/op.d.ts +37 -0
- package/dist/server/api-client-core/op.js +44 -0
- package/dist/server/api-client-core/op.js.map +1 -0
- package/dist/server/api-client-core/pagination.d.ts +60 -0
- package/dist/server/api-client-core/pagination.js +103 -0
- package/dist/server/api-client-core/pagination.js.map +1 -0
- package/dist/server/api-client-core/plugins/fetch-transport.js +72 -0
- package/dist/server/api-client-core/plugins/fetch-transport.js.map +1 -0
- package/dist/server/api-client-core/types.d.ts +135 -0
- package/dist/server/api-client.d.ts +197 -0
- package/dist/server/api-client.js +101 -0
- package/dist/server/constants.js +46 -0
- package/dist/server/constants.js.map +1 -0
- package/dist/server/deno/start.d.ts +12 -0
- package/dist/server/deno/start.js +21 -0
- package/dist/server/deno/start.js.map +1 -0
- package/dist/server/hono/hono-request-handler.js +54 -0
- package/dist/server/hono/hono-request-handler.js.map +1 -0
- package/dist/server/hono/hubspot-connect-routes/auth-callback.js +125 -0
- package/dist/server/hono/hubspot-connect-routes/auth-callback.js.map +1 -0
- package/dist/server/hono/hubspot-connect-routes/auth-init-session.js +90 -0
- package/dist/server/hono/hubspot-connect-routes/auth-init-session.js.map +1 -0
- package/dist/server/hono/hubspot-connect-routes/auth-logout.js +97 -0
- package/dist/server/hono/hubspot-connect-routes/auth-logout.js.map +1 -0
- package/dist/server/hono/hubspot-connect-routes/auth-refresh.js +101 -0
- package/dist/server/hono/hubspot-connect-routes/auth-refresh.js.map +1 -0
- package/dist/server/hono/hubspot-connect-routes/cimd-client-metadata-types.d.ts +16 -0
- package/dist/server/hono/hubspot-connect-routes/cimd-client-metadata-types.js +13 -0
- package/dist/server/hono/hubspot-connect-routes/cimd-client-metadata-types.js.map +1 -0
- package/dist/server/hono/hubspot-connect-routes/cimd-public-routes.js +42 -0
- package/dist/server/hono/hubspot-connect-routes/cimd-public-routes.js.map +1 -0
- package/dist/server/hono/hubspot-connect-routes/constants.js +8 -0
- package/dist/server/hono/hubspot-connect-routes/constants.js.map +1 -0
- package/dist/server/hono/hubspot-connect-routes/fetch-hubspot-client-metadata.js +43 -0
- package/dist/server/hono/hubspot-connect-routes/fetch-hubspot-client-metadata.js.map +1 -0
- package/dist/server/hono/hubspot-connect-routes/hubspot-connect-routes.js +35 -0
- package/dist/server/hono/hubspot-connect-routes/hubspot-connect-routes.js.map +1 -0
- package/dist/server/hono/hubspot-connect-routes/load-hubspot-connect-routes-env.js +34 -0
- package/dist/server/hono/hubspot-connect-routes/load-hubspot-connect-routes-env.js.map +1 -0
- package/dist/server/hono/hubspot-connect-routes/oauth-client.js +104 -0
- package/dist/server/hono/hubspot-connect-routes/oauth-client.js.map +1 -0
- package/dist/server/hono/hubspot-connect-routes/utils.js +73 -0
- package/dist/server/hono/hubspot-connect-routes/utils.js.map +1 -0
- package/dist/server/hono/index.js +4 -0
- package/dist/server/hono/types.d.ts +28 -0
- package/dist/server/hono/utils/cookie-utils.js +29 -0
- package/dist/server/hono/utils/cookie-utils.js.map +1 -0
- package/dist/server/import-app-keys.js +42 -0
- package/dist/server/import-app-keys.js.map +1 -0
- package/dist/server/lovable/create-app-function-start.d.ts +26 -0
- package/dist/server/lovable/create-app-function-start.js +28 -0
- package/dist/server/lovable/create-app-function-start.js.map +1 -0
- package/dist/server/lovable/hubspot-connect/index.d.ts +15 -0
- package/dist/server/lovable/hubspot-connect/index.js +20 -0
- package/dist/server/lovable/hubspot-connect/index.js.map +1 -0
- package/dist/server/lovable/hubspot-connect/run-hubspot-connect-lovable-server.js +29 -0
- package/dist/server/lovable/hubspot-connect/run-hubspot-connect-lovable-server.js.map +1 -0
- package/dist/server/lovable.d.ts +6 -0
- package/dist/server/lovable.js +4 -0
- package/dist/server/oauth.d.ts +6 -0
- package/dist/server/oauth.js +5 -0
- package/dist/server/proxy.js +68 -0
- package/dist/server/proxy.js.map +1 -0
- package/dist/server/sanitize-request.js +41 -0
- package/dist/server/sanitize-request.js.map +1 -0
- package/dist/server/secure-start-core.d.ts +23 -0
- package/dist/server/secure-start-core.js +28 -0
- package/dist/server/secure-start-core.js.map +1 -0
- package/dist/server/shared/constants.js +17 -0
- package/dist/server/shared/constants.js.map +1 -0
- package/dist/server/shared/encoding/base64.js +45 -0
- package/dist/server/shared/encoding/base64.js.map +1 -0
- package/dist/server/shared/encoding/sha256.d.ts +10 -0
- package/dist/server/shared/encoding/sha256.js +15 -0
- package/dist/server/shared/encoding/sha256.js.map +1 -0
- package/dist/server/shared/logger.d.ts +15 -0
- package/dist/server/shared/logger.js +16 -0
- package/dist/server/shared/logger.js.map +1 -0
- package/dist/server/types.d.ts +56 -0
- package/dist/server/utils/cookie-utils.js +21 -0
- package/dist/server/utils/cookie-utils.js.map +1 -0
- package/dist/server/utils/dpop-utils.d.ts +67 -0
- package/dist/server/utils/dpop-utils.js +75 -0
- package/dist/server/utils/dpop-utils.js.map +1 -0
- package/dist/server/utils/env-utils.js +54 -0
- package/dist/server/utils/env-utils.js.map +1 -0
- package/dist/server/utils/jwk-utils.d.ts +16 -0
- package/dist/server/utils/jwk-utils.js +24 -0
- package/dist/server/utils/jwk-utils.js.map +1 -0
- package/dist/server/utils/jwt-utils.d.ts +39 -0
- package/dist/server/utils/jwt-utils.js +87 -0
- package/dist/server/utils/jwt-utils.js.map +1 -0
- package/eslint.config.js +5 -0
- package/package.json +68 -0
- package/src/browser/app-connect-controller/README.md +92 -0
- package/src/browser/app-connect-controller/connect-start.ts +45 -0
- package/src/browser/app-connect-controller/constants.ts +15 -0
- package/src/browser/app-connect-controller/create.ts +137 -0
- package/src/browser/app-connect-controller/default-session-storage.ts +21 -0
- package/src/browser/app-connect-controller/disconnect.ts +54 -0
- package/src/browser/app-connect-controller/init.ts +35 -0
- package/src/browser/app-connect-controller/refresh.ts +124 -0
- package/src/browser/app-connect-controller/types.ts +48 -0
- package/src/browser/app-connect-controller/utils/crypto-utils.ts +1 -0
- package/src/browser/app-connect-controller/utils/encode-utils.ts +1 -0
- package/src/browser/app-connect-controller/utils/memoize-utils.test.ts +48 -0
- package/src/browser/app-connect-controller/utils/memoize-utils.ts +26 -0
- package/src/browser/app-connect-controller/utils/session-utils.test.ts +127 -0
- package/src/browser/app-connect-controller/utils/session-utils.ts +58 -0
- package/src/browser/app-connect-controller/utils/store-utils.test.ts +102 -0
- package/src/browser/app-connect-controller/utils/store-utils.ts +119 -0
- package/src/browser/app-connect-controller/utils/timeout-utils.ts +8 -0
- package/src/browser/app-connect-controller/view-state.test.ts +70 -0
- package/src/browser/app-connect-controller/view-state.ts +40 -0
- package/src/browser/index.ts +13 -0
- package/src/browser/react/components/AppConnectHeader/AppConnectHeader.css.ts +231 -0
- package/src/browser/react/components/AppConnectHeader/AppConnectHeader.tsx +124 -0
- package/src/browser/react/components/Button/Button.css.ts +59 -0
- package/src/browser/react/components/Button/Button.tsx +38 -0
- package/src/browser/react/components/ConnectButton/ConnectButton.css.ts +73 -0
- package/src/browser/react/components/ConnectButton/ConnectButton.tsx +43 -0
- package/src/browser/react/components/DisconnectedBody/DisconnectedBody.css.ts +25 -0
- package/src/browser/react/components/DisconnectedBody/DisconnectedBody.tsx +25 -0
- package/src/browser/react/components/HubSpotAppConnect/HubSpotAppConnect.css.ts +23 -0
- package/src/browser/react/components/HubSpotAppConnect/HubSpotAppConnect.tsx +90 -0
- package/src/browser/react/components/LoadingIndicator/LoadingIndicator.css.ts +28 -0
- package/src/browser/react/components/LoadingIndicator/LoadingIndicator.tsx +9 -0
- package/src/browser/react/components/ShareButton/ShareButton.css.ts +52 -0
- package/src/browser/react/components/ShareButton/ShareButton.tsx +43 -0
- package/src/browser/react/components/icons/ChevronDownIcon.tsx +23 -0
- package/src/browser/react/components/icons/ExternalLinkIcon.tsx +23 -0
- package/src/browser/react/components/icons/HubSpotDataSourceIcon.tsx +33 -0
- package/src/browser/react/components/icons/LogoutIcon.tsx +37 -0
- package/src/browser/react/components/icons/ShareIcon.tsx +31 -0
- package/src/browser/react/context.ts +12 -0
- package/src/browser/react/hooks.ts +28 -0
- package/src/browser/react/index.ts +6 -0
- package/src/browser/react/lovable/LovableHubSpotAppConnect.tsx +37 -0
- package/src/browser/react/lovable/index.ts +4 -0
- package/src/browser/theme-tokens.generated.css.ts +424 -0
- package/src/browser/theme.css.ts +21 -0
- package/src/browser/types.ts +83 -0
- package/src/server/api-client-core/apis/account/account-info-types.generated.ts +116 -0
- package/src/server/api-client-core/apis/account/account-info.generated.ts +14 -0
- package/src/server/api-client-core/apis/account/audit-logs-types.generated.ts +409 -0
- package/src/server/api-client-core/apis/account/audit-logs.generated.ts +41 -0
- package/src/server/api-client-core/apis/auth/oauth-types.generated.ts +138 -0
- package/src/server/api-client-core/apis/auth/oauth.generated.ts +26 -0
- package/src/server/api-client-core/apis/automation/actions-types.generated.ts +1337 -0
- package/src/server/api-client-core/apis/automation/actions.generated.ts +166 -0
- package/src/server/api-client-core/apis/automation/sequences-types.generated.ts +456 -0
- package/src/server/api-client-core/apis/automation/sequences.generated.ts +34 -0
- package/src/server/api-client-core/apis/business-units-types.generated.ts +82 -0
- package/src/server/api-client-core/apis/business-units.generated.ts +16 -0
- package/src/server/api-client-core/apis/cms/authors-types.generated.ts +4003 -0
- package/src/server/api-client-core/apis/cms/authors.generated.ts +199 -0
- package/src/server/api-client-core/apis/cms/blog-settings-types.generated.ts +3795 -0
- package/src/server/api-client-core/apis/cms/blog-settings.generated.ts +79 -0
- package/src/server/api-client-core/apis/cms/cms-content-audit-types.generated.ts +198 -0
- package/src/server/api-client-core/apis/cms/cms-content-audit.generated.ts +31 -0
- package/src/server/api-client-core/apis/cms/domains-types.generated.ts +201 -0
- package/src/server/api-client-core/apis/cms/domains.generated.ts +30 -0
- package/src/server/api-client-core/apis/cms/hubdb-types.generated.ts +1276 -0
- package/src/server/api-client-core/apis/cms/hubdb.generated.ts +220 -0
- package/src/server/api-client-core/apis/cms/media-bridge-types.generated.ts +8928 -0
- package/src/server/api-client-core/apis/cms/media-bridge.generated.ts +244 -0
- package/src/server/api-client-core/apis/cms/pages-types.generated.ts +5548 -0
- package/src/server/api-client-core/apis/cms/pages.generated.ts +423 -0
- package/src/server/api-client-core/apis/cms/posts-types.generated.ts +4682 -0
- package/src/server/api-client-core/apis/cms/posts.generated.ts +254 -0
- package/src/server/api-client-core/apis/cms/site-search-types.generated.ts +1914 -0
- package/src/server/api-client-core/apis/cms/site-search.generated.ts +40 -0
- package/src/server/api-client-core/apis/cms/source-code-types.generated.ts +240 -0
- package/src/server/api-client-core/apis/cms/source-code.generated.ts +54 -0
- package/src/server/api-client-core/apis/cms/tags-types.generated.ts +3969 -0
- package/src/server/api-client-core/apis/cms/tags.generated.ts +199 -0
- package/src/server/api-client-core/apis/cms/url-mappings-types.generated.ts +245 -0
- package/src/server/api-client-core/apis/cms/url-mappings.generated.ts +25 -0
- package/src/server/api-client-core/apis/cms/url-redirects-types.generated.ts +241 -0
- package/src/server/api-client-core/apis/cms/url-redirects.generated.ts +40 -0
- package/src/server/api-client-core/apis/communication-preferences/subscriptions-types.generated.ts +893 -0
- package/src/server/api-client-core/apis/communication-preferences/subscriptions.generated.ts +108 -0
- package/src/server/api-client-core/apis/conversations/custom-channels-types.generated.ts +687 -0
- package/src/server/api-client-core/apis/conversations/custom-channels.generated.ts +121 -0
- package/src/server/api-client-core/apis/conversations/visitor-identification-types.generated.ts +66 -0
- package/src/server/api-client-core/apis/conversations/visitor-identification.generated.ts +14 -0
- package/src/server/api-client-core/apis/conversations-types.generated.ts +1126 -0
- package/src/server/api-client-core/apis/conversations.generated.ts +152 -0
- package/src/server/api-client-core/apis/crm/app-uninstalls-types.generated.ts +37 -0
- package/src/server/api-client-core/apis/crm/app-uninstalls.generated.ts +12 -0
- package/src/server/api-client-core/apis/crm/appointments-types.generated.ts +1094 -0
- package/src/server/api-client-core/apis/crm/appointments.generated.ts +153 -0
- package/src/server/api-client-core/apis/crm/associations-schema-types.generated.ts +403 -0
- package/src/server/api-client-core/apis/crm/associations-schema.generated.ts +99 -0
- package/src/server/api-client-core/apis/crm/associations-types.generated.ts +750 -0
- package/src/server/api-client-core/apis/crm/associations.generated.ts +134 -0
- package/src/server/api-client-core/apis/crm/calling-extensions-types.generated.ts +565 -0
- package/src/server/api-client-core/apis/crm/calling-extensions.generated.ts +75 -0
- package/src/server/api-client-core/apis/crm/calls-types.generated.ts +938 -0
- package/src/server/api-client-core/apis/crm/calls.generated.ts +106 -0
- package/src/server/api-client-core/apis/crm/carts-types.generated.ts +938 -0
- package/src/server/api-client-core/apis/crm/carts.generated.ts +106 -0
- package/src/server/api-client-core/apis/crm/commerce-payments-types.generated.ts +938 -0
- package/src/server/api-client-core/apis/crm/commerce-payments.generated.ts +115 -0
- package/src/server/api-client-core/apis/crm/commerce-subscriptions-types.generated.ts +935 -0
- package/src/server/api-client-core/apis/crm/commerce-subscriptions.generated.ts +109 -0
- package/src/server/api-client-core/apis/crm/communications-types.generated.ts +938 -0
- package/src/server/api-client-core/apis/crm/communications.generated.ts +115 -0
- package/src/server/api-client-core/apis/crm/companies-types.generated.ts +976 -0
- package/src/server/api-client-core/apis/crm/companies.generated.ts +112 -0
- package/src/server/api-client-core/apis/crm/contacts-types.generated.ts +996 -0
- package/src/server/api-client-core/apis/crm/contacts.generated.ts +114 -0
- package/src/server/api-client-core/apis/crm/contracts-types.generated.ts +938 -0
- package/src/server/api-client-core/apis/crm/contracts.generated.ts +106 -0
- package/src/server/api-client-core/apis/crm/courses-types.generated.ts +941 -0
- package/src/server/api-client-core/apis/crm/courses.generated.ts +106 -0
- package/src/server/api-client-core/apis/crm/crm-owners-types.generated.ts +148 -0
- package/src/server/api-client-core/apis/crm/crm-owners.generated.ts +25 -0
- package/src/server/api-client-core/apis/crm/custom-objects-types.generated.ts +1024 -0
- package/src/server/api-client-core/apis/crm/custom-objects.generated.ts +136 -0
- package/src/server/api-client-core/apis/crm/deal-splits-types.generated.ts +208 -0
- package/src/server/api-client-core/apis/crm/deal-splits.generated.ts +14 -0
- package/src/server/api-client-core/apis/crm/deals-types.generated.ts +963 -0
- package/src/server/api-client-core/apis/crm/deals.generated.ts +107 -0
- package/src/server/api-client-core/apis/crm/discounts-types.generated.ts +934 -0
- package/src/server/api-client-core/apis/crm/discounts.generated.ts +106 -0
- package/src/server/api-client-core/apis/crm/emails-types.generated.ts +938 -0
- package/src/server/api-client-core/apis/crm/emails.generated.ts +106 -0
- package/src/server/api-client-core/apis/crm/exports-types.generated.ts +360 -0
- package/src/server/api-client-core/apis/crm/exports.generated.ts +24 -0
- package/src/server/api-client-core/apis/crm/feedback-submissions-types.generated.ts +676 -0
- package/src/server/api-client-core/apis/crm/feedback-submissions.generated.ts +89 -0
- package/src/server/api-client-core/apis/crm/fees-types.generated.ts +938 -0
- package/src/server/api-client-core/apis/crm/fees.generated.ts +106 -0
- package/src/server/api-client-core/apis/crm/goal-targets-types.generated.ts +938 -0
- package/src/server/api-client-core/apis/crm/goal-targets.generated.ts +107 -0
- package/src/server/api-client-core/apis/crm/imports-types.generated.ts +754 -0
- package/src/server/api-client-core/apis/crm/imports.generated.ts +41 -0
- package/src/server/api-client-core/apis/crm/invoices-types.generated.ts +938 -0
- package/src/server/api-client-core/apis/crm/invoices.generated.ts +106 -0
- package/src/server/api-client-core/apis/crm/leads-types.generated.ts +938 -0
- package/src/server/api-client-core/apis/crm/leads.generated.ts +106 -0
- package/src/server/api-client-core/apis/crm/limits-tracking-types.generated.ts +371 -0
- package/src/server/api-client-core/apis/crm/limits-tracking.generated.ts +42 -0
- package/src/server/api-client-core/apis/crm/line-items-types.generated.ts +938 -0
- package/src/server/api-client-core/apis/crm/line-items.generated.ts +107 -0
- package/src/server/api-client-core/apis/crm/listings-types.generated.ts +941 -0
- package/src/server/api-client-core/apis/crm/listings.generated.ts +106 -0
- package/src/server/api-client-core/apis/crm/lists-types.generated.ts +3053 -0
- package/src/server/api-client-core/apis/crm/lists.generated.ts +166 -0
- package/src/server/api-client-core/apis/crm/meetings-types.generated.ts +938 -0
- package/src/server/api-client-core/apis/crm/meetings.generated.ts +106 -0
- package/src/server/api-client-core/apis/crm/notes-types.generated.ts +938 -0
- package/src/server/api-client-core/apis/crm/notes.generated.ts +106 -0
- package/src/server/api-client-core/apis/crm/object-library-types.generated.ts +67 -0
- package/src/server/api-client-core/apis/crm/object-library.generated.ts +16 -0
- package/src/server/api-client-core/apis/crm/objects-types.generated.ts +785 -0
- package/src/server/api-client-core/apis/crm/objects.generated.ts +90 -0
- package/src/server/api-client-core/apis/crm/orders-types.generated.ts +938 -0
- package/src/server/api-client-core/apis/crm/orders.generated.ts +106 -0
- package/src/server/api-client-core/apis/crm/partner-clients-types.generated.ts +804 -0
- package/src/server/api-client-core/apis/crm/partner-clients.generated.ts +108 -0
- package/src/server/api-client-core/apis/crm/partner-services-types.generated.ts +802 -0
- package/src/server/api-client-core/apis/crm/partner-services.generated.ts +108 -0
- package/src/server/api-client-core/apis/crm/pipelines-types.generated.ts +491 -0
- package/src/server/api-client-core/apis/crm/pipelines.generated.ts +144 -0
- package/src/server/api-client-core/apis/crm/postal-mail-types.generated.ts +932 -0
- package/src/server/api-client-core/apis/crm/postal-mail.generated.ts +107 -0
- package/src/server/api-client-core/apis/crm/products-types.generated.ts +938 -0
- package/src/server/api-client-core/apis/crm/products.generated.ts +106 -0
- package/src/server/api-client-core/apis/crm/projects-types.generated.ts +973 -0
- package/src/server/api-client-core/apis/crm/projects.generated.ts +112 -0
- package/src/server/api-client-core/apis/crm/properties-types.generated.ts +705 -0
- package/src/server/api-client-core/apis/crm/properties.generated.ts +97 -0
- package/src/server/api-client-core/apis/crm/property-validations-types.generated.ts +225 -0
- package/src/server/api-client-core/apis/crm/property-validations.generated.ts +47 -0
- package/src/server/api-client-core/apis/crm/public-app-crm-cards-types.generated.ts +550 -0
- package/src/server/api-client-core/apis/crm/public-app-crm-cards.generated.ts +46 -0
- package/src/server/api-client-core/apis/crm/public-app-feature-flags-types.generated.ts +284 -0
- package/src/server/api-client-core/apis/crm/public-app-feature-flags.generated.ts +89 -0
- package/src/server/api-client-core/apis/crm/quotes-types.generated.ts +938 -0
- package/src/server/api-client-core/apis/crm/quotes.generated.ts +106 -0
- package/src/server/api-client-core/apis/crm/schemas-types.generated.ts +735 -0
- package/src/server/api-client-core/apis/crm/schemas.generated.ts +68 -0
- package/src/server/api-client-core/apis/crm/services-types.generated.ts +941 -0
- package/src/server/api-client-core/apis/crm/services.generated.ts +106 -0
- package/src/server/api-client-core/apis/crm/tasks-types.generated.ts +938 -0
- package/src/server/api-client-core/apis/crm/tasks.generated.ts +106 -0
- package/src/server/api-client-core/apis/crm/taxes-types.generated.ts +938 -0
- package/src/server/api-client-core/apis/crm/taxes.generated.ts +106 -0
- package/src/server/api-client-core/apis/crm/tickets-types.generated.ts +976 -0
- package/src/server/api-client-core/apis/crm/tickets.generated.ts +112 -0
- package/src/server/api-client-core/apis/crm/timeline-types.generated.ts +207 -0
- package/src/server/api-client-core/apis/crm/timeline.generated.ts +23 -0
- package/src/server/api-client-core/apis/crm/transcriptions-types.generated.ts +200 -0
- package/src/server/api-client-core/apis/crm/transcriptions.generated.ts +29 -0
- package/src/server/api-client-core/apis/crm/users-types.generated.ts +938 -0
- package/src/server/api-client-core/apis/crm/users.generated.ts +106 -0
- package/src/server/api-client-core/apis/crm/video-conferencing-extension-types.generated.ts +78 -0
- package/src/server/api-client-core/apis/crm/video-conferencing-extension.generated.ts +25 -0
- package/src/server/api-client-core/apis/events/manage-event-definitions-types.generated.ts +1621 -0
- package/src/server/api-client-core/apis/events/manage-event-definitions.generated.ts +73 -0
- package/src/server/api-client-core/apis/events/send-event-completions-types.generated.ts +103 -0
- package/src/server/api-client-core/apis/events/send-event-completions.generated.ts +19 -0
- package/src/server/api-client-core/apis/events-types.generated.ts +145 -0
- package/src/server/api-client-core/apis/events.generated.ts +30 -0
- package/src/server/api-client-core/apis/files-types.generated.ts +904 -0
- package/src/server/api-client-core/apis/files.generated.ts +164 -0
- package/src/server/api-client-core/apis/index.generated.ts +97 -0
- package/src/server/api-client-core/apis/marketing/campaigns-public-api-types.generated.ts +1434 -0
- package/src/server/api-client-core/apis/marketing/campaigns-public-api.generated.ts +191 -0
- package/src/server/api-client-core/apis/marketing/marketing-emails-types.generated.ts +3858 -0
- package/src/server/api-client-core/apis/marketing/marketing-emails.generated.ts +146 -0
- package/src/server/api-client-core/apis/marketing/marketing-events-types.generated.ts +2122 -0
- package/src/server/api-client-core/apis/marketing/marketing-events.generated.ts +320 -0
- package/src/server/api-client-core/apis/marketing/single-send-types.generated.ts +178 -0
- package/src/server/api-client-core/apis/marketing/single-send.generated.ts +15 -0
- package/src/server/api-client-core/apis/marketing/transactional-single-send-types.generated.ts +337 -0
- package/src/server/api-client-core/apis/marketing/transactional-single-send.generated.ts +44 -0
- package/src/server/api-client-core/apis/meta/origins-types.generated.ts +84 -0
- package/src/server/api-client-core/apis/meta/origins.generated.ts +19 -0
- package/src/server/api-client-core/apis/scheduler/meetings-types.generated.ts +1110 -0
- package/src/server/api-client-core/apis/scheduler/meetings.generated.ts +50 -0
- package/src/server/api-client-core/apis/settings/multicurrency-types.generated.ts +2054 -0
- package/src/server/api-client-core/apis/settings/multicurrency.generated.ts +78 -0
- package/src/server/api-client-core/apis/settings/tax-rates-types.generated.ts +119 -0
- package/src/server/api-client-core/apis/settings/tax-rates.generated.ts +23 -0
- package/src/server/api-client-core/apis/settings/user-provisioning-types.generated.ts +322 -0
- package/src/server/api-client-core/apis/settings/user-provisioning.generated.ts +48 -0
- package/src/server/api-client-core/apis/webhooks-journal-types.generated.ts +906 -0
- package/src/server/api-client-core/apis/webhooks-journal.generated.ts +131 -0
- package/src/server/api-client-core/apis/webhooks-types.generated.ts +1423 -0
- package/src/server/api-client-core/apis/webhooks.generated.ts +171 -0
- package/src/server/api-client-core/binary-data.ts +38 -0
- package/src/server/api-client-core/client.ts +115 -0
- package/src/server/api-client-core/codegen-helpers/file-op-wrappers.ts +25 -0
- package/src/server/api-client-core/errors.ts +31 -0
- package/src/server/api-client-core/index.ts +49 -0
- package/src/server/api-client-core/op.ts +61 -0
- package/src/server/api-client-core/pagination.ts +106 -0
- package/src/server/api-client-core/plugins/fetch-transport.ts +115 -0
- package/src/server/api-client-core/plugins/index.ts +10 -0
- package/src/server/api-client-core/types.ts +148 -0
- package/src/server/api-client.ts +1 -0
- package/src/server/constants.ts +53 -0
- package/src/server/deno/index.ts +1 -0
- package/src/server/deno/start.ts +25 -0
- package/src/server/hono/hono-request-handler.ts +106 -0
- package/src/server/hono/hubspot-connect-routes/auth-callback.test.ts +225 -0
- package/src/server/hono/hubspot-connect-routes/auth-callback.ts +198 -0
- package/src/server/hono/hubspot-connect-routes/auth-init-session.test.ts +144 -0
- package/src/server/hono/hubspot-connect-routes/auth-init-session.ts +126 -0
- package/src/server/hono/hubspot-connect-routes/auth-logout.test.ts +124 -0
- package/src/server/hono/hubspot-connect-routes/auth-logout.ts +140 -0
- package/src/server/hono/hubspot-connect-routes/auth-refresh.test.ts +224 -0
- package/src/server/hono/hubspot-connect-routes/auth-refresh.ts +171 -0
- package/src/server/hono/hubspot-connect-routes/cimd-client-metadata-types.ts +54 -0
- package/src/server/hono/hubspot-connect-routes/cimd-public-routes.test.ts +128 -0
- package/src/server/hono/hubspot-connect-routes/cimd-public-routes.ts +72 -0
- package/src/server/hono/hubspot-connect-routes/constants.ts +3 -0
- package/src/server/hono/hubspot-connect-routes/fetch-hubspot-client-metadata.test.ts +75 -0
- package/src/server/hono/hubspot-connect-routes/fetch-hubspot-client-metadata.ts +73 -0
- package/src/server/hono/hubspot-connect-routes/hubspot-connect-routes.ts +95 -0
- package/src/server/hono/hubspot-connect-routes/load-hubspot-connect-routes-env.test.ts +145 -0
- package/src/server/hono/hubspot-connect-routes/load-hubspot-connect-routes-env.ts +67 -0
- package/src/server/hono/hubspot-connect-routes/oauth-client.ts +181 -0
- package/src/server/hono/hubspot-connect-routes/types.ts +36 -0
- package/src/server/hono/hubspot-connect-routes/utils.test.ts +132 -0
- package/src/server/hono/hubspot-connect-routes/utils.ts +138 -0
- package/src/server/hono/index.ts +6 -0
- package/src/server/hono/types.ts +25 -0
- package/src/server/hono/utils/cookie-utils.ts +55 -0
- package/src/server/import-app-keys.ts +55 -0
- package/src/server/lovable/create-app-function-start.ts +55 -0
- package/src/server/lovable/hubspot-connect/index.ts +28 -0
- package/src/server/lovable/hubspot-connect/run-hubspot-connect-lovable-server.ts +40 -0
- package/src/server/lovable/index.ts +16 -0
- package/src/server/node/index.ts +1 -0
- package/src/server/node/start.ts +25 -0
- package/src/server/oauth.ts +6 -0
- package/src/server/proxy.test.ts +80 -0
- package/src/server/proxy.ts +116 -0
- package/src/server/sanitize-request.test.ts +65 -0
- package/src/server/sanitize-request.ts +52 -0
- package/src/server/secure-start-core.ts +67 -0
- package/src/server/types.ts +62 -0
- package/src/server/utils/base64-utils.ts +5 -0
- package/src/server/utils/cookie-utils.test.ts +48 -0
- package/src/server/utils/cookie-utils.ts +26 -0
- package/src/server/utils/crypto-utils.ts +1 -0
- package/src/server/utils/dpop-utils.test.ts +102 -0
- package/src/server/utils/dpop-utils.ts +161 -0
- package/src/server/utils/env-utils.test.ts +92 -0
- package/src/server/utils/env-utils.ts +65 -0
- package/src/server/utils/jwk-utils.test.ts +34 -0
- package/src/server/utils/jwk-utils.ts +30 -0
- package/src/server/utils/jwt-utils.test.ts +81 -0
- package/src/server/utils/jwt-utils.ts +141 -0
- package/src/server/utils/test-fixtures.ts +32 -0
- package/src/shared/constants.ts +13 -0
- package/src/shared/encoding/base64.test.ts +57 -0
- package/src/shared/encoding/base64.ts +50 -0
- package/src/shared/encoding/sha256.test.ts +25 -0
- package/src/shared/encoding/sha256.ts +14 -0
- package/src/shared/logger.ts +50 -0
- package/src/shared/wire-types.ts +40 -0
- package/tsconfig.browser.json +10 -0
- package/tsconfig.json +8 -0
- package/tsconfig.server.json +12 -0
- package/tsdown.config.ts +38 -0
- package/vitest.config.ts +9 -0
|
@@ -0,0 +1,3053 @@
|
|
|
1
|
+
// DO NOT MODIFY - This code was generated by @hubspot/api-client-next-generator
|
|
2
|
+
|
|
3
|
+
import type { Operation } from '../../types.ts';
|
|
4
|
+
|
|
5
|
+
export namespace CRMLists {
|
|
6
|
+
export namespace Basic {
|
|
7
|
+
export interface AddAndRemoveMembershipsInput {
|
|
8
|
+
data: Schemas.MembershipChangeRequest;
|
|
9
|
+
listId: string;
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
export type AddAndRemoveMembershipsOutput =
|
|
13
|
+
Schemas.MembershipsUpdateResponse;
|
|
14
|
+
|
|
15
|
+
export interface AddMembershipsFromInput {
|
|
16
|
+
listId: string;
|
|
17
|
+
sourceListId: string;
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
export type AddMembershipsFromOutput = void;
|
|
21
|
+
|
|
22
|
+
export interface AddMembershipsInput {
|
|
23
|
+
data: string[];
|
|
24
|
+
listId: string;
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
export type AddMembershipsOutput = Schemas.MembershipsUpdateResponse;
|
|
28
|
+
|
|
29
|
+
export type CreateFolderInput = Schemas.ListFolderCreateRequest;
|
|
30
|
+
|
|
31
|
+
export type CreateFolderOutput = Schemas.ListFolderCreateResponse;
|
|
32
|
+
|
|
33
|
+
export type CreateIdMappingInput = string[];
|
|
34
|
+
|
|
35
|
+
export type CreateIdMappingOutput = Schemas.PublicBatchMigrationMapping;
|
|
36
|
+
|
|
37
|
+
export type CreateInput = Schemas.ListCreateRequest;
|
|
38
|
+
|
|
39
|
+
export type CreateOutput = Schemas.ListCreateResponse;
|
|
40
|
+
|
|
41
|
+
export interface DeleteFolderInput {
|
|
42
|
+
folderId: string;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
export type DeleteFolderOutput = void;
|
|
46
|
+
|
|
47
|
+
export interface DeleteInput {
|
|
48
|
+
listId: string;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
export interface DeleteMembershipsInput {
|
|
52
|
+
listId: string;
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
export type DeleteMembershipsOutput = void;
|
|
56
|
+
|
|
57
|
+
export type DeleteOutput = void;
|
|
58
|
+
|
|
59
|
+
export interface GetByObjectTypeAndNameInput {
|
|
60
|
+
includeFilters?: boolean;
|
|
61
|
+
listName: string;
|
|
62
|
+
objectTypeId: string;
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
export type GetByObjectTypeAndNameOutput = Schemas.ListFetchResponse;
|
|
66
|
+
|
|
67
|
+
export interface GetIdMappingInput {
|
|
68
|
+
legacyListId?: string;
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
export type GetIdMappingOutput = Schemas.PublicMigrationMapping;
|
|
72
|
+
|
|
73
|
+
export interface GetInput {
|
|
74
|
+
includeFilters?: boolean;
|
|
75
|
+
listId: string;
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
export interface GetMembershipsJoinOrderInput {
|
|
79
|
+
/**
|
|
80
|
+
* 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.
|
|
81
|
+
*/
|
|
82
|
+
after?: string;
|
|
83
|
+
before?: string;
|
|
84
|
+
/**
|
|
85
|
+
* The maximum number of results to display per page.
|
|
86
|
+
*/
|
|
87
|
+
limit?: number;
|
|
88
|
+
listId: string;
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
export type GetMembershipsJoinOrderOutput =
|
|
92
|
+
Schemas.ApiCollectionResponseJoinTimeAndRecordId;
|
|
93
|
+
|
|
94
|
+
export type GetOutput = Schemas.ListFetchResponse;
|
|
95
|
+
|
|
96
|
+
export interface GetRecordMembershipsInput {
|
|
97
|
+
objectTypeId: string;
|
|
98
|
+
recordId: string;
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
export type GetRecordMembershipsOutput =
|
|
102
|
+
Schemas.ApiCollectionResponseRecordListMembership;
|
|
103
|
+
|
|
104
|
+
export interface GetScheduleConversionInput {
|
|
105
|
+
listId: string;
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
export type GetScheduleConversionOutput =
|
|
109
|
+
Schemas.PublicListConversionResponse;
|
|
110
|
+
|
|
111
|
+
export interface GetSizeAndEditsHistoryBetweenInput {
|
|
112
|
+
endDate?: string;
|
|
113
|
+
listId: string;
|
|
114
|
+
startDate?: string;
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
export type GetSizeAndEditsHistoryBetweenOutput =
|
|
118
|
+
Schemas.ListSizeAndEditHistoryResponse;
|
|
119
|
+
|
|
120
|
+
export interface ListFoldersInput {
|
|
121
|
+
folderId?: string;
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
export type ListFoldersOutput = Schemas.ListFolderFetchResponse;
|
|
125
|
+
|
|
126
|
+
export interface ListInput {
|
|
127
|
+
includeFilters?: boolean;
|
|
128
|
+
listIds?: string[];
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
export interface ListMembershipsInput {
|
|
132
|
+
/**
|
|
133
|
+
* 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.
|
|
134
|
+
*/
|
|
135
|
+
after?: string;
|
|
136
|
+
before?: string;
|
|
137
|
+
/**
|
|
138
|
+
* The maximum number of results to display per page.
|
|
139
|
+
*/
|
|
140
|
+
limit?: number;
|
|
141
|
+
listId: string;
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
export type ListMembershipsOutput =
|
|
145
|
+
Schemas.ApiCollectionResponseJoinTimeAndRecordId;
|
|
146
|
+
|
|
147
|
+
export type ListOutput = Schemas.ListsByIdResponse;
|
|
148
|
+
|
|
149
|
+
export interface MoveFolderInput {
|
|
150
|
+
folderId: string;
|
|
151
|
+
newParentFolderId: string;
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
export type MoveFolderOutput = Schemas.ListFolderFetchResponse;
|
|
155
|
+
|
|
156
|
+
export type MoveListInput = Schemas.ListMoveRequest;
|
|
157
|
+
|
|
158
|
+
export type MoveListOutput = void;
|
|
159
|
+
|
|
160
|
+
export interface RemoveMembershipsInput {
|
|
161
|
+
data: string[];
|
|
162
|
+
listId: string;
|
|
163
|
+
}
|
|
164
|
+
|
|
165
|
+
export type RemoveMembershipsOutput = Schemas.MembershipsUpdateResponse;
|
|
166
|
+
|
|
167
|
+
export interface RenameFolderInput {
|
|
168
|
+
folderId: string;
|
|
169
|
+
newFolderName?: string;
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
export type RenameFolderOutput = Schemas.ListFolderFetchResponse;
|
|
173
|
+
|
|
174
|
+
export interface RestoreInput {
|
|
175
|
+
listId: string;
|
|
176
|
+
}
|
|
177
|
+
|
|
178
|
+
export type RestoreOutput = void;
|
|
179
|
+
|
|
180
|
+
export interface ScheduleConversionInput {
|
|
181
|
+
listId: string;
|
|
182
|
+
}
|
|
183
|
+
|
|
184
|
+
export type ScheduleConversionOutput = void;
|
|
185
|
+
|
|
186
|
+
export interface UpdateListFiltersInput {
|
|
187
|
+
data: Schemas.ListFilterUpdateRequest;
|
|
188
|
+
enrollObjectsInWorkflows?: boolean;
|
|
189
|
+
listId: string;
|
|
190
|
+
}
|
|
191
|
+
|
|
192
|
+
export type UpdateListFiltersOutput = Schemas.ListUpdateResponse;
|
|
193
|
+
|
|
194
|
+
export interface UpdateListNameInput {
|
|
195
|
+
includeFilters?: boolean;
|
|
196
|
+
listId: string;
|
|
197
|
+
listName?: string;
|
|
198
|
+
}
|
|
199
|
+
|
|
200
|
+
export type UpdateListNameOutput = Schemas.ListUpdateResponse;
|
|
201
|
+
|
|
202
|
+
export interface UpdateScheduleConversionInput {
|
|
203
|
+
data: Schemas.PublicListConversionTime;
|
|
204
|
+
listId: string;
|
|
205
|
+
}
|
|
206
|
+
|
|
207
|
+
export type UpdateScheduleConversionOutput =
|
|
208
|
+
Schemas.PublicListConversionResponse;
|
|
209
|
+
}
|
|
210
|
+
|
|
211
|
+
export namespace Batch {
|
|
212
|
+
export type BatchReadMembershipsInput = Schemas.BatchInputRecordIdInput;
|
|
213
|
+
|
|
214
|
+
export type BatchReadMembershipsOutput =
|
|
215
|
+
Schemas.BatchResponseRecordIdWithMemberships;
|
|
216
|
+
}
|
|
217
|
+
|
|
218
|
+
export namespace Schemas {
|
|
219
|
+
export interface ApiCollectionResponseJoinTimeAndRecordId {
|
|
220
|
+
paging?: Schemas.Paging;
|
|
221
|
+
results: Schemas.JoinTimeAndRecordId[];
|
|
222
|
+
/**
|
|
223
|
+
* The total number of records that match the query.
|
|
224
|
+
*/
|
|
225
|
+
total?: number;
|
|
226
|
+
}
|
|
227
|
+
|
|
228
|
+
export interface ApiCollectionResponseRecordListMembership {
|
|
229
|
+
paging?: Schemas.Paging;
|
|
230
|
+
results: Schemas.RecordListMembership[];
|
|
231
|
+
total?: number;
|
|
232
|
+
}
|
|
233
|
+
|
|
234
|
+
export interface BatchInputRecordIdInput {
|
|
235
|
+
inputs: Schemas.RecordIdInput[];
|
|
236
|
+
}
|
|
237
|
+
|
|
238
|
+
export interface BatchResponseRecordIdWithMemberships {
|
|
239
|
+
completedAt: string;
|
|
240
|
+
links?: Record<string, string>;
|
|
241
|
+
requestedAt?: string;
|
|
242
|
+
results: Schemas.RecordIdWithMemberships[];
|
|
243
|
+
startedAt: string;
|
|
244
|
+
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
245
|
+
}
|
|
246
|
+
|
|
247
|
+
export interface JoinTimeAndRecordId {
|
|
248
|
+
/**
|
|
249
|
+
* The date and time when the record was added to the list.
|
|
250
|
+
*/
|
|
251
|
+
membershipTimestamp: string;
|
|
252
|
+
/**
|
|
253
|
+
* The unique identifier of the record.
|
|
254
|
+
*/
|
|
255
|
+
recordId: string;
|
|
256
|
+
}
|
|
257
|
+
|
|
258
|
+
export interface ListCreateRequest {
|
|
259
|
+
/**
|
|
260
|
+
* The list of custom properties to tie to the list. Custom property name is the key, the value is the value.
|
|
261
|
+
*/
|
|
262
|
+
customProperties?: Record<string, string>;
|
|
263
|
+
/**
|
|
264
|
+
* Filter branch object containing filtering criteria for the list
|
|
265
|
+
*/
|
|
266
|
+
filterBranch?:
|
|
267
|
+
| Schemas.PublicOrFilterBranch
|
|
268
|
+
| Schemas.PublicAndFilterBranch
|
|
269
|
+
| Schemas.PublicNotAllFilterBranch
|
|
270
|
+
| Schemas.PublicNotAnyFilterBranch
|
|
271
|
+
| Schemas.PublicRestrictedFilterBranch
|
|
272
|
+
| Schemas.PublicUnifiedEventsFilterBranch
|
|
273
|
+
| Schemas.PublicPropertyAssociationFilterBranch
|
|
274
|
+
| Schemas.PublicAssociationFilterBranch;
|
|
275
|
+
/**
|
|
276
|
+
* The ID of the folder that the list should be created in. If left blank, then the list will be created in the root of the list folder structure.
|
|
277
|
+
*/
|
|
278
|
+
listFolderId?: number;
|
|
279
|
+
listPermissions?: Schemas.PublicListPermissions;
|
|
280
|
+
membershipSettings?: Schemas.PublicMembershipSettings;
|
|
281
|
+
/**
|
|
282
|
+
* The name of the list, which must be globally unique across all public lists in the portal.
|
|
283
|
+
*/
|
|
284
|
+
name: string;
|
|
285
|
+
/**
|
|
286
|
+
* The object type ID of the type of objects that the list will store.
|
|
287
|
+
*/
|
|
288
|
+
objectTypeId: string;
|
|
289
|
+
/**
|
|
290
|
+
* The processing type of the list. One of: `SNAPSHOT`, `MANUAL`, or `DYNAMIC`.
|
|
291
|
+
*/
|
|
292
|
+
processingType: string;
|
|
293
|
+
}
|
|
294
|
+
|
|
295
|
+
export interface ListCreateResponse {
|
|
296
|
+
list: Schemas.PublicObjectList;
|
|
297
|
+
}
|
|
298
|
+
|
|
299
|
+
export interface ListFetchResponse {
|
|
300
|
+
list: Schemas.PublicObjectList;
|
|
301
|
+
}
|
|
302
|
+
|
|
303
|
+
export interface ListFilterUpdateRequest {
|
|
304
|
+
/**
|
|
305
|
+
* Updated filtering criteria for the list
|
|
306
|
+
*/
|
|
307
|
+
filterBranch:
|
|
308
|
+
| Schemas.PublicOrFilterBranch
|
|
309
|
+
| Schemas.PublicAndFilterBranch
|
|
310
|
+
| Schemas.PublicNotAllFilterBranch
|
|
311
|
+
| Schemas.PublicNotAnyFilterBranch
|
|
312
|
+
| Schemas.PublicRestrictedFilterBranch
|
|
313
|
+
| Schemas.PublicUnifiedEventsFilterBranch
|
|
314
|
+
| Schemas.PublicPropertyAssociationFilterBranch
|
|
315
|
+
| Schemas.PublicAssociationFilterBranch;
|
|
316
|
+
}
|
|
317
|
+
|
|
318
|
+
export interface ListFolderCreateRequest {
|
|
319
|
+
/**
|
|
320
|
+
* The name of the folder to be created.
|
|
321
|
+
*/
|
|
322
|
+
name: string;
|
|
323
|
+
/**
|
|
324
|
+
* The folder this should be created in, if not specified will be created in the root folder 0.
|
|
325
|
+
*/
|
|
326
|
+
parentFolderId?: string;
|
|
327
|
+
}
|
|
328
|
+
|
|
329
|
+
export interface ListFolderCreateResponse {
|
|
330
|
+
folder: Schemas.PublicListFolder;
|
|
331
|
+
}
|
|
332
|
+
|
|
333
|
+
export interface ListFolderFetchResponse {
|
|
334
|
+
folder: Schemas.PublicListFolder;
|
|
335
|
+
}
|
|
336
|
+
|
|
337
|
+
export interface ListMoveRequest {
|
|
338
|
+
/**
|
|
339
|
+
* The Id of the list to move.
|
|
340
|
+
*/
|
|
341
|
+
listId: string;
|
|
342
|
+
/**
|
|
343
|
+
* The Id of folder to move the list to, the root folder is Id 0.
|
|
344
|
+
*/
|
|
345
|
+
newFolderId: string;
|
|
346
|
+
}
|
|
347
|
+
|
|
348
|
+
export interface ListsByIdResponse {
|
|
349
|
+
/**
|
|
350
|
+
* The object list definitions.
|
|
351
|
+
*/
|
|
352
|
+
lists: Schemas.PublicObjectList[];
|
|
353
|
+
}
|
|
354
|
+
|
|
355
|
+
export interface ListSearchRequest {
|
|
356
|
+
/**
|
|
357
|
+
* The property names of any additional list properties to include in the response. Properties that do not exist or that are empty for a particular list are not included in the response.
|
|
358
|
+
*
|
|
359
|
+
* By default, all requests will fetch the following properties for each list: `hs_list_size`, `hs_last_record_added_at`, `hs_last_record_removed_at`, `hs_folder_name`, and `hs_list_reference_count`.
|
|
360
|
+
*/
|
|
361
|
+
additionalProperties: string[];
|
|
362
|
+
/**
|
|
363
|
+
* The number of lists to include in the response. Defaults to `20` if no value is provided. The max `count` is `500`.
|
|
364
|
+
*/
|
|
365
|
+
count?: number;
|
|
366
|
+
/**
|
|
367
|
+
* ILS list ids to be included in search results. If not specified, all lists matching other criteria will be included
|
|
368
|
+
*/
|
|
369
|
+
listIds: string[];
|
|
370
|
+
objectTypeId?: string;
|
|
371
|
+
/**
|
|
372
|
+
* Value used to paginate through lists. The `offset` provided in the response can be used in the next request to fetch the next page of results. Defaults to `0` if no offset is provided.
|
|
373
|
+
*/
|
|
374
|
+
offset: number;
|
|
375
|
+
/**
|
|
376
|
+
* List processing types to be included in search results. If not specified, all lists with all processing types will be included.
|
|
377
|
+
*/
|
|
378
|
+
processingTypes: string[];
|
|
379
|
+
/**
|
|
380
|
+
* The `query` that will be used to search for lists by list name. If no `query` is provided, then the results will include all lists.
|
|
381
|
+
*/
|
|
382
|
+
query?: string;
|
|
383
|
+
/**
|
|
384
|
+
* Sort field and order
|
|
385
|
+
*/
|
|
386
|
+
sort?: string;
|
|
387
|
+
}
|
|
388
|
+
|
|
389
|
+
export interface ListSearchResponse {
|
|
390
|
+
/**
|
|
391
|
+
* Whether or not there are more results to page through.
|
|
392
|
+
*/
|
|
393
|
+
hasMore: boolean;
|
|
394
|
+
/**
|
|
395
|
+
* The lists that matched the search criteria.
|
|
396
|
+
*/
|
|
397
|
+
lists: Schemas.PublicObjectListSearchResult[];
|
|
398
|
+
/**
|
|
399
|
+
* Value to be passed in a future request to paginate through list search results.
|
|
400
|
+
*/
|
|
401
|
+
offset: number;
|
|
402
|
+
/**
|
|
403
|
+
* The total number of lists that match the search criteria.
|
|
404
|
+
*/
|
|
405
|
+
total: number;
|
|
406
|
+
}
|
|
407
|
+
|
|
408
|
+
export interface ListSizeAndEditHistoryResponse {
|
|
409
|
+
editHistory: string[];
|
|
410
|
+
sizeHistory: Schemas.ListSizeDataPoint[];
|
|
411
|
+
}
|
|
412
|
+
|
|
413
|
+
export interface ListSizeDataPoint {
|
|
414
|
+
size: number;
|
|
415
|
+
timestamp: string;
|
|
416
|
+
}
|
|
417
|
+
|
|
418
|
+
export interface ListUpdateResponse {
|
|
419
|
+
updatedList?: Schemas.PublicObjectList;
|
|
420
|
+
}
|
|
421
|
+
|
|
422
|
+
export interface MembershipChangeRequest {
|
|
423
|
+
recordIdsToAdd: string[];
|
|
424
|
+
recordIdsToRemove: string[];
|
|
425
|
+
}
|
|
426
|
+
|
|
427
|
+
export interface MembershipsUpdateResponse {
|
|
428
|
+
/**
|
|
429
|
+
* The IDs of the records that were `missing` (e.g. did not exist in the portal) and so were not `added` or `removed`.
|
|
430
|
+
*/
|
|
431
|
+
recordIdsMissing: string[];
|
|
432
|
+
/**
|
|
433
|
+
* The IDs of the records that were `removed` from the list.
|
|
434
|
+
*/
|
|
435
|
+
recordIdsRemoved: string[];
|
|
436
|
+
recordsIdsAdded: string[];
|
|
437
|
+
}
|
|
438
|
+
|
|
439
|
+
/**
|
|
440
|
+
* Specifies the paging information needed to retrieve the next set of results in a paginated API response
|
|
441
|
+
*/
|
|
442
|
+
export interface NextPage {
|
|
443
|
+
/**
|
|
444
|
+
* The offset for the next page of records.
|
|
445
|
+
*/
|
|
446
|
+
after: string;
|
|
447
|
+
/**
|
|
448
|
+
* A direct link to the request for the next page of records.
|
|
449
|
+
*/
|
|
450
|
+
link?: string;
|
|
451
|
+
}
|
|
452
|
+
|
|
453
|
+
export interface Paging {
|
|
454
|
+
next?: Schemas.NextPage;
|
|
455
|
+
prev?: Schemas.PreviousPage;
|
|
456
|
+
}
|
|
457
|
+
|
|
458
|
+
/**
|
|
459
|
+
* specifies the paging information needed to retrieve the previous set of results in a paginated API response
|
|
460
|
+
*/
|
|
461
|
+
export interface PreviousPage {
|
|
462
|
+
/**
|
|
463
|
+
* The offset of the previous page of records.
|
|
464
|
+
*/
|
|
465
|
+
before: string;
|
|
466
|
+
/**
|
|
467
|
+
* A direct link to the request for the previous page of records.
|
|
468
|
+
*/
|
|
469
|
+
link?: string;
|
|
470
|
+
}
|
|
471
|
+
|
|
472
|
+
export interface PublicAbsoluteComparativeTimestampRefineBy {
|
|
473
|
+
/**
|
|
474
|
+
* Timestamp comparison options (BEFORE, AFTER)
|
|
475
|
+
*/
|
|
476
|
+
comparison: string;
|
|
477
|
+
/**
|
|
478
|
+
* Timestamp to be used in refine by criteria
|
|
479
|
+
*/
|
|
480
|
+
timestamp: number;
|
|
481
|
+
/**
|
|
482
|
+
* type of refine by criteria (ABSOLUTE_COMPARATIVE)
|
|
483
|
+
*/
|
|
484
|
+
type: 'ABSOLUTE_COMPARATIVE';
|
|
485
|
+
}
|
|
486
|
+
|
|
487
|
+
export interface PublicAbsoluteRangedTimestampRefineBy {
|
|
488
|
+
/**
|
|
489
|
+
* Lower range timestamp of refinement criteria
|
|
490
|
+
*/
|
|
491
|
+
lowerTimestamp: number;
|
|
492
|
+
/**
|
|
493
|
+
* Type of range of refinement critaria (BETWEEN, NOT_BETWEEN)
|
|
494
|
+
*/
|
|
495
|
+
rangeType: string;
|
|
496
|
+
/**
|
|
497
|
+
* type of refine by criteria (ABSOLUTE_RANGED)
|
|
498
|
+
*/
|
|
499
|
+
type: 'ABSOLUTE_RANGED';
|
|
500
|
+
/**
|
|
501
|
+
* Upper range timestamp of refinement criteria
|
|
502
|
+
*/
|
|
503
|
+
upperTimestamp: number;
|
|
504
|
+
}
|
|
505
|
+
|
|
506
|
+
export interface PublicAdsSearchFilter {
|
|
507
|
+
/**
|
|
508
|
+
* Ad network (ADWORDS, FACEBOOK, LINKEDIN, ALL)
|
|
509
|
+
*/
|
|
510
|
+
adNetwork: string;
|
|
511
|
+
/**
|
|
512
|
+
* Type of ad entity (KEYWORD, ADGROUP, AD, CAMPAIGN)
|
|
513
|
+
*/
|
|
514
|
+
entityType: string;
|
|
515
|
+
/**
|
|
516
|
+
* Type of the filter (ADS_SEARCH)
|
|
517
|
+
*/
|
|
518
|
+
filterType: 'ADS_SEARCH';
|
|
519
|
+
/**
|
|
520
|
+
* Operator to be applied (CONTAINS, IS_EQUAL_TO, ENDS_WITH, STARTS_WITH, IS_KNOWN)
|
|
521
|
+
*/
|
|
522
|
+
operator: string;
|
|
523
|
+
searchTerms: string[];
|
|
524
|
+
/**
|
|
525
|
+
* Search term to match an ad
|
|
526
|
+
*/
|
|
527
|
+
searchTermType: string;
|
|
528
|
+
}
|
|
529
|
+
|
|
530
|
+
export interface PublicAdsTimeFilter {
|
|
531
|
+
/**
|
|
532
|
+
* Filter type (ADS_TIME)
|
|
533
|
+
*/
|
|
534
|
+
filterType: 'ADS_TIME';
|
|
535
|
+
/**
|
|
536
|
+
* Refinement criteria
|
|
537
|
+
*/
|
|
538
|
+
pruningRefineBy:
|
|
539
|
+
| Schemas.PublicNumOccurrencesRefineBy
|
|
540
|
+
| Schemas.PublicSetOccurrencesRefineBy
|
|
541
|
+
| Schemas.PublicRelativeComparativeTimestampRefineBy
|
|
542
|
+
| Schemas.PublicRelativeRangedTimestampRefineBy
|
|
543
|
+
| Schemas.PublicAbsoluteComparativeTimestampRefineBy
|
|
544
|
+
| Schemas.PublicAbsoluteRangedTimestampRefineBy
|
|
545
|
+
| Schemas.PublicAllHistoryRefineBy
|
|
546
|
+
| Schemas.PublicTimePointOperation
|
|
547
|
+
| Schemas.PublicRangedTimeOperation;
|
|
548
|
+
}
|
|
549
|
+
|
|
550
|
+
export interface PublicAllHistoryRefineBy {
|
|
551
|
+
/**
|
|
552
|
+
* Type of refine by (ALL_HISTORY)
|
|
553
|
+
*/
|
|
554
|
+
type: 'ALL_HISTORY';
|
|
555
|
+
}
|
|
556
|
+
|
|
557
|
+
export interface PublicAllPropertyTypesOperation {
|
|
558
|
+
/**
|
|
559
|
+
* Indication of whether objects with no value should be included
|
|
560
|
+
*/
|
|
561
|
+
includeObjectsWithNoValueSet: boolean;
|
|
562
|
+
/**
|
|
563
|
+
* Type of operation (ALL_PROPERTY)
|
|
564
|
+
*/
|
|
565
|
+
operationType: 'ALL_PROPERTY';
|
|
566
|
+
/**
|
|
567
|
+
* Operator to be applied (IS_KNOWN, IS_UNKNOWN)
|
|
568
|
+
*/
|
|
569
|
+
operator: string;
|
|
570
|
+
}
|
|
571
|
+
|
|
572
|
+
export interface PublicAndFilterBranch {
|
|
573
|
+
filterBranches: (
|
|
574
|
+
| Schemas.PublicOrFilterBranch
|
|
575
|
+
| Schemas.PublicAndFilterBranch
|
|
576
|
+
| Schemas.PublicNotAllFilterBranch
|
|
577
|
+
| Schemas.PublicNotAnyFilterBranch
|
|
578
|
+
| Schemas.PublicRestrictedFilterBranch
|
|
579
|
+
| Schemas.PublicUnifiedEventsFilterBranch
|
|
580
|
+
| Schemas.PublicPropertyAssociationFilterBranch
|
|
581
|
+
| Schemas.PublicAssociationFilterBranch
|
|
582
|
+
)[];
|
|
583
|
+
/**
|
|
584
|
+
* Filter branch operator (AND)
|
|
585
|
+
*/
|
|
586
|
+
filterBranchOperator: string;
|
|
587
|
+
/**
|
|
588
|
+
* Type of filter branch (AND)
|
|
589
|
+
*/
|
|
590
|
+
filterBranchType: 'AND';
|
|
591
|
+
filters: (
|
|
592
|
+
| Schemas.PublicPropertyFilter
|
|
593
|
+
| Schemas.PublicAssociationInListFilter
|
|
594
|
+
| Schemas.PublicPageViewAnalyticsFilter
|
|
595
|
+
| Schemas.PublicCtaAnalyticsFilter
|
|
596
|
+
| Schemas.PublicEventAnalyticsFilter
|
|
597
|
+
| Schemas.PublicFormSubmissionFilter
|
|
598
|
+
| Schemas.PublicFormSubmissionOnPageFilter
|
|
599
|
+
| Schemas.PublicIntegrationEventFilter
|
|
600
|
+
| Schemas.PublicEmailSubscriptionFilter
|
|
601
|
+
| Schemas.PublicCommunicationSubscriptionFilter
|
|
602
|
+
| Schemas.PublicCampaignInfluencedFilter
|
|
603
|
+
| Schemas.PublicSurveyMonkeyFilter
|
|
604
|
+
| Schemas.PublicSurveyMonkeyValueFilter
|
|
605
|
+
| Schemas.PublicWebinarFilter
|
|
606
|
+
| Schemas.PublicEmailEventFilter
|
|
607
|
+
| Schemas.PublicPrivacyAnalyticsFilter
|
|
608
|
+
| Schemas.PublicAdsSearchFilter
|
|
609
|
+
| Schemas.PublicAdsTimeFilter
|
|
610
|
+
| Schemas.PublicInListFilter
|
|
611
|
+
| Schemas.PublicNumAssociationsFilter
|
|
612
|
+
| Schemas.PublicUnifiedEventsFilter
|
|
613
|
+
| Schemas.PublicPropertyAssociationInListFilter
|
|
614
|
+
| Schemas.PublicConstantFilter
|
|
615
|
+
)[];
|
|
616
|
+
}
|
|
617
|
+
|
|
618
|
+
export interface PublicAssociationFilterBranch {
|
|
619
|
+
/**
|
|
620
|
+
* Specifies the category of the association for the filter branch (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK).
|
|
621
|
+
*/
|
|
622
|
+
associationCategory: string;
|
|
623
|
+
/**
|
|
624
|
+
* Type id of the association
|
|
625
|
+
*/
|
|
626
|
+
associationTypeId: number;
|
|
627
|
+
filterBranches: (
|
|
628
|
+
| Schemas.PublicOrFilterBranch
|
|
629
|
+
| Schemas.PublicAndFilterBranch
|
|
630
|
+
| Schemas.PublicNotAllFilterBranch
|
|
631
|
+
| Schemas.PublicNotAnyFilterBranch
|
|
632
|
+
| Schemas.PublicRestrictedFilterBranch
|
|
633
|
+
| Schemas.PublicUnifiedEventsFilterBranch
|
|
634
|
+
| Schemas.PublicPropertyAssociationFilterBranch
|
|
635
|
+
| Schemas.PublicAssociationFilterBranch
|
|
636
|
+
)[];
|
|
637
|
+
/**
|
|
638
|
+
* Filter branch operator (AND)
|
|
639
|
+
*/
|
|
640
|
+
filterBranchOperator: string;
|
|
641
|
+
/**
|
|
642
|
+
* Type of the filter branch (ASSOCIATION)
|
|
643
|
+
*/
|
|
644
|
+
filterBranchType: 'ASSOCIATION';
|
|
645
|
+
filters: (
|
|
646
|
+
| Schemas.PublicPropertyFilter
|
|
647
|
+
| Schemas.PublicAssociationInListFilter
|
|
648
|
+
| Schemas.PublicPageViewAnalyticsFilter
|
|
649
|
+
| Schemas.PublicCtaAnalyticsFilter
|
|
650
|
+
| Schemas.PublicEventAnalyticsFilter
|
|
651
|
+
| Schemas.PublicFormSubmissionFilter
|
|
652
|
+
| Schemas.PublicFormSubmissionOnPageFilter
|
|
653
|
+
| Schemas.PublicIntegrationEventFilter
|
|
654
|
+
| Schemas.PublicEmailSubscriptionFilter
|
|
655
|
+
| Schemas.PublicCommunicationSubscriptionFilter
|
|
656
|
+
| Schemas.PublicCampaignInfluencedFilter
|
|
657
|
+
| Schemas.PublicSurveyMonkeyFilter
|
|
658
|
+
| Schemas.PublicSurveyMonkeyValueFilter
|
|
659
|
+
| Schemas.PublicWebinarFilter
|
|
660
|
+
| Schemas.PublicEmailEventFilter
|
|
661
|
+
| Schemas.PublicPrivacyAnalyticsFilter
|
|
662
|
+
| Schemas.PublicAdsSearchFilter
|
|
663
|
+
| Schemas.PublicAdsTimeFilter
|
|
664
|
+
| Schemas.PublicInListFilter
|
|
665
|
+
| Schemas.PublicNumAssociationsFilter
|
|
666
|
+
| Schemas.PublicUnifiedEventsFilter
|
|
667
|
+
| Schemas.PublicPropertyAssociationInListFilter
|
|
668
|
+
| Schemas.PublicConstantFilter
|
|
669
|
+
)[];
|
|
670
|
+
/**
|
|
671
|
+
* The ID representing the type of object associated with the filter branch.
|
|
672
|
+
*/
|
|
673
|
+
objectTypeId: string;
|
|
674
|
+
/**
|
|
675
|
+
* Defines the operation to be applied within the filter branch (IN_LIST, NOT_IN_LIST).
|
|
676
|
+
*/
|
|
677
|
+
operator: string;
|
|
678
|
+
}
|
|
679
|
+
|
|
680
|
+
export interface PublicAssociationInListFilter {
|
|
681
|
+
/**
|
|
682
|
+
* Defines the category of the association, such as (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK).
|
|
683
|
+
*/
|
|
684
|
+
associationCategory: string;
|
|
685
|
+
/**
|
|
686
|
+
* The ID representing the type of association being filtered.
|
|
687
|
+
*/
|
|
688
|
+
associationTypeId: number;
|
|
689
|
+
/**
|
|
690
|
+
* Specifies the criteria for refining the association filter.
|
|
691
|
+
*/
|
|
692
|
+
coalescingRefineBy:
|
|
693
|
+
| Schemas.PublicNumOccurrencesRefineBy
|
|
694
|
+
| Schemas.PublicSetOccurrencesRefineBy
|
|
695
|
+
| Schemas.PublicRelativeComparativeTimestampRefineBy
|
|
696
|
+
| Schemas.PublicRelativeRangedTimestampRefineBy
|
|
697
|
+
| Schemas.PublicAbsoluteComparativeTimestampRefineBy
|
|
698
|
+
| Schemas.PublicAbsoluteRangedTimestampRefineBy
|
|
699
|
+
| Schemas.PublicAllHistoryRefineBy
|
|
700
|
+
| Schemas.PublicTimePointOperation
|
|
701
|
+
| Schemas.PublicRangedTimeOperation;
|
|
702
|
+
/**
|
|
703
|
+
* Indicates the type of filter being applied, which is 'ASSOCIATION' by default.
|
|
704
|
+
*/
|
|
705
|
+
filterType: 'ASSOCIATION';
|
|
706
|
+
/**
|
|
707
|
+
* The ID of the list used in the association filter.
|
|
708
|
+
*/
|
|
709
|
+
listId: string;
|
|
710
|
+
/**
|
|
711
|
+
* Specifies the operation to be performed by the filter, such as 'IN_LIST' or 'NOT_IN_LIST'.
|
|
712
|
+
*/
|
|
713
|
+
operator: string;
|
|
714
|
+
/**
|
|
715
|
+
* The type of object that the association filter is targeting.
|
|
716
|
+
*/
|
|
717
|
+
toObjectType?: string;
|
|
718
|
+
/**
|
|
719
|
+
* The ID representing the type of object that the association filter is targeting.
|
|
720
|
+
*/
|
|
721
|
+
toObjectTypeId?: string;
|
|
722
|
+
}
|
|
723
|
+
|
|
724
|
+
export interface PublicBatchMigrationMapping {
|
|
725
|
+
legacyListIdsToIdsMapping: Schemas.PublicMigrationMapping[];
|
|
726
|
+
/**
|
|
727
|
+
* A list of legacy list ids that were passed in but not found. It will be empty if no id's are missing
|
|
728
|
+
*/
|
|
729
|
+
missingLegacyListIds: string[];
|
|
730
|
+
}
|
|
731
|
+
|
|
732
|
+
export interface PublicBoolPropertyOperation {
|
|
733
|
+
/**
|
|
734
|
+
* Indicates whether objects with no value set for the property should be included in the operation.
|
|
735
|
+
*/
|
|
736
|
+
includeObjectsWithNoValueSet: boolean;
|
|
737
|
+
/**
|
|
738
|
+
* Specifies the type of operation (BOOL).
|
|
739
|
+
*/
|
|
740
|
+
operationType: 'BOOL';
|
|
741
|
+
/**
|
|
742
|
+
* Defines the operation to be applied in the boolean property operation (IS_EQUAL_TO, IS_NOT_EQUAL_TO, HAS_EVER_BEEN_EQUAL_TO, HAS_NEVER_BEEN_EQUAL_TO).
|
|
743
|
+
*/
|
|
744
|
+
operator: string;
|
|
745
|
+
/**
|
|
746
|
+
* The boolean value to be used in the operation.
|
|
747
|
+
*/
|
|
748
|
+
value: boolean;
|
|
749
|
+
}
|
|
750
|
+
|
|
751
|
+
export interface PublicCalendarDatePropertyOperation {
|
|
752
|
+
/**
|
|
753
|
+
* The month in which the fiscal year starts.
|
|
754
|
+
*/
|
|
755
|
+
fiscalYearStart?:
|
|
756
|
+
| 'APRIL'
|
|
757
|
+
| 'AUGUST'
|
|
758
|
+
| 'DECEMBER'
|
|
759
|
+
| 'FEBRUARY'
|
|
760
|
+
| 'JANUARY'
|
|
761
|
+
| 'JULY'
|
|
762
|
+
| 'JUNE'
|
|
763
|
+
| 'MARCH'
|
|
764
|
+
| 'MAY'
|
|
765
|
+
| 'NOVEMBER'
|
|
766
|
+
| 'OCTOBER'
|
|
767
|
+
| 'SEPTEMBER';
|
|
768
|
+
/**
|
|
769
|
+
* Indicates whether objects with no value set for the property should be included.
|
|
770
|
+
*/
|
|
771
|
+
includeObjectsWithNoValueSet: boolean;
|
|
772
|
+
/**
|
|
773
|
+
* The type of operation, which is (CALENDAR_DATE).
|
|
774
|
+
*/
|
|
775
|
+
operationType: 'CALENDAR_DATE';
|
|
776
|
+
/**
|
|
777
|
+
* Defines the operation to be applied to the calendar date property (IN_THIS_TIME_UNIT, IN_THIS_TIME_UNIT_SO_FAR, IN_NEXT_TIME_UNIT, IN_LAST_TIME_UNIT).
|
|
778
|
+
*/
|
|
779
|
+
operator: string;
|
|
780
|
+
/**
|
|
781
|
+
* The unit of time to be used in the operation (DAY, WEEK, MONTH, QUARTER, YEAR).
|
|
782
|
+
*/
|
|
783
|
+
timeUnit: string;
|
|
784
|
+
/**
|
|
785
|
+
* The count of time units to be applied in the operation (1).
|
|
786
|
+
*/
|
|
787
|
+
timeUnitCount?: number;
|
|
788
|
+
/**
|
|
789
|
+
* Specifies whether the fiscal year should be used in the operation.
|
|
790
|
+
*/
|
|
791
|
+
useFiscalYear?: boolean;
|
|
792
|
+
}
|
|
793
|
+
|
|
794
|
+
export interface PublicCampaignInfluencedFilter {
|
|
795
|
+
/**
|
|
796
|
+
* The ID of the campaign that influences the filter.
|
|
797
|
+
*/
|
|
798
|
+
campaignId: string;
|
|
799
|
+
/**
|
|
800
|
+
* Indicates the type of filter (CAMPAIGN_INFLUENCED).
|
|
801
|
+
*/
|
|
802
|
+
filterType: 'CAMPAIGN_INFLUENCED';
|
|
803
|
+
}
|
|
804
|
+
|
|
805
|
+
export interface PublicCommunicationSubscriptionFilter {
|
|
806
|
+
acceptedOptStates: string[];
|
|
807
|
+
/**
|
|
808
|
+
* The ID of the business unit associated with the subscription filter.
|
|
809
|
+
*/
|
|
810
|
+
businessUnitId?: string;
|
|
811
|
+
/**
|
|
812
|
+
* Specifies the communication channel associated with the subscription filter (EMAIL, WHATSAPP, SMS).
|
|
813
|
+
*/
|
|
814
|
+
channel: string;
|
|
815
|
+
/**
|
|
816
|
+
* Indicates the type of filter, which is (COMMUNICATION_SUBSCRIPTION)
|
|
817
|
+
*/
|
|
818
|
+
filterType: 'COMMUNICATION_SUBSCRIPTION';
|
|
819
|
+
subscriptionIds: string[];
|
|
820
|
+
/**
|
|
821
|
+
* Defines the type of subscription related to the filter (PORTAL_WIDE, BUSINESS_UNIT_WIDE, INDIVIDUAL_SUBSCRIPTION)
|
|
822
|
+
*/
|
|
823
|
+
subscriptionType: string;
|
|
824
|
+
}
|
|
825
|
+
|
|
826
|
+
export interface PublicComparativeDatePropertyOperation {
|
|
827
|
+
/**
|
|
828
|
+
* The name of the property to compare against in the operation.
|
|
829
|
+
*/
|
|
830
|
+
comparisonPropertyName: string;
|
|
831
|
+
/**
|
|
832
|
+
* The default value used for comparison if the actual comparison property value is not set.
|
|
833
|
+
*/
|
|
834
|
+
defaultComparisonValue?: string;
|
|
835
|
+
/**
|
|
836
|
+
* Indicates whether objects with no value set for the property should be included in the operation.
|
|
837
|
+
*/
|
|
838
|
+
includeObjectsWithNoValueSet: boolean;
|
|
839
|
+
/**
|
|
840
|
+
* The type of operation (COMPARATIVE_DATE).
|
|
841
|
+
*/
|
|
842
|
+
operationType: 'COMPARATIVE_DATE';
|
|
843
|
+
/**
|
|
844
|
+
* Defines the operation to be applied in the comparative date property operation (IS_BEFORE, IS_AFTER).
|
|
845
|
+
*/
|
|
846
|
+
operator: string;
|
|
847
|
+
}
|
|
848
|
+
|
|
849
|
+
export interface PublicComparativePropertyUpdatedOperation {
|
|
850
|
+
/**
|
|
851
|
+
* The name of the property to compare against in the operation.
|
|
852
|
+
*/
|
|
853
|
+
comparisonPropertyName: string;
|
|
854
|
+
/**
|
|
855
|
+
* The default value used for comparison if the actual comparison property value is not set.
|
|
856
|
+
*/
|
|
857
|
+
defaultComparisonValue?: string;
|
|
858
|
+
/**
|
|
859
|
+
* Indicates whether objects with no value set for the property should be included in the operation.
|
|
860
|
+
*/
|
|
861
|
+
includeObjectsWithNoValueSet: boolean;
|
|
862
|
+
/**
|
|
863
|
+
* Specifies the type of operation (COMPARATIVE_PROPERTY_UPDATED).
|
|
864
|
+
*/
|
|
865
|
+
operationType: 'COMPARATIVE_PROPERTY_UPDATED';
|
|
866
|
+
/**
|
|
867
|
+
* Defines the operation to be applied, such as comparison operators (IS_BEFORE, IS_AFTER).
|
|
868
|
+
*/
|
|
869
|
+
operator: string;
|
|
870
|
+
}
|
|
871
|
+
|
|
872
|
+
export interface PublicConstantFilter {
|
|
873
|
+
/**
|
|
874
|
+
* Specifies the type of filter, which is (CONSTANT).
|
|
875
|
+
*/
|
|
876
|
+
filterType: 'CONSTANT';
|
|
877
|
+
/**
|
|
878
|
+
* Indicates whether the filter should accept the condition.
|
|
879
|
+
*/
|
|
880
|
+
shouldAccept: boolean;
|
|
881
|
+
/**
|
|
882
|
+
* Defines the source of the constant filter.
|
|
883
|
+
*/
|
|
884
|
+
source?: string;
|
|
885
|
+
}
|
|
886
|
+
|
|
887
|
+
export interface PublicCtaAnalyticsFilter {
|
|
888
|
+
/**
|
|
889
|
+
* Specifies the criteria for refining the filter by coalescing.
|
|
890
|
+
*/
|
|
891
|
+
coalescingRefineBy?:
|
|
892
|
+
| Schemas.PublicNumOccurrencesRefineBy
|
|
893
|
+
| Schemas.PublicSetOccurrencesRefineBy
|
|
894
|
+
| Schemas.PublicRelativeComparativeTimestampRefineBy
|
|
895
|
+
| Schemas.PublicRelativeRangedTimestampRefineBy
|
|
896
|
+
| Schemas.PublicAbsoluteComparativeTimestampRefineBy
|
|
897
|
+
| Schemas.PublicAbsoluteRangedTimestampRefineBy
|
|
898
|
+
| Schemas.PublicAllHistoryRefineBy
|
|
899
|
+
| Schemas.PublicTimePointOperation
|
|
900
|
+
| Schemas.PublicRangedTimeOperation;
|
|
901
|
+
/**
|
|
902
|
+
* The name of the Call-to-Action (CTA) to be used in the filter.
|
|
903
|
+
*/
|
|
904
|
+
ctaName: string;
|
|
905
|
+
/**
|
|
906
|
+
* Indicates the type of filter being applied, which is (CTA).
|
|
907
|
+
*/
|
|
908
|
+
filterType: 'CTA';
|
|
909
|
+
/**
|
|
910
|
+
* Defines the operation to be applied within the filter (HAS_CLICKED_CTA, HAS_NOT_CLICKED_CTA, HAS_OPENED_CTA, HAS_NOT_OPENED_CTA, HAS_CLICKED_CTA_PLACEMENT, HAS_NOT_CLICKED_CTA_PLACEMENT, HAS_OPENED_CTA_PLACEMENT, HAS_NOT_OPENED_CTA_PLACEMENT).
|
|
911
|
+
*/
|
|
912
|
+
operator: string;
|
|
913
|
+
/**
|
|
914
|
+
* Specifies the criteria for refining the filter by pruning.
|
|
915
|
+
*/
|
|
916
|
+
pruningRefineBy?:
|
|
917
|
+
| Schemas.PublicNumOccurrencesRefineBy
|
|
918
|
+
| Schemas.PublicSetOccurrencesRefineBy
|
|
919
|
+
| Schemas.PublicRelativeComparativeTimestampRefineBy
|
|
920
|
+
| Schemas.PublicRelativeRangedTimestampRefineBy
|
|
921
|
+
| Schemas.PublicAbsoluteComparativeTimestampRefineBy
|
|
922
|
+
| Schemas.PublicAbsoluteRangedTimestampRefineBy
|
|
923
|
+
| Schemas.PublicAllHistoryRefineBy
|
|
924
|
+
| Schemas.PublicTimePointOperation
|
|
925
|
+
| Schemas.PublicRangedTimeOperation;
|
|
926
|
+
}
|
|
927
|
+
|
|
928
|
+
export interface PublicDatePoint {
|
|
929
|
+
/**
|
|
930
|
+
* The day component of the date.
|
|
931
|
+
*/
|
|
932
|
+
day: number;
|
|
933
|
+
/**
|
|
934
|
+
* The hour component of the time.
|
|
935
|
+
*/
|
|
936
|
+
hour?: number;
|
|
937
|
+
/**
|
|
938
|
+
* The millisecond component of the time.
|
|
939
|
+
*/
|
|
940
|
+
millisecond?: number;
|
|
941
|
+
/**
|
|
942
|
+
* The minute component of the time.
|
|
943
|
+
*/
|
|
944
|
+
minute?: number;
|
|
945
|
+
/**
|
|
946
|
+
* The month component of the date.
|
|
947
|
+
*/
|
|
948
|
+
month: number;
|
|
949
|
+
/**
|
|
950
|
+
* The second component of the time.
|
|
951
|
+
*/
|
|
952
|
+
second?: number;
|
|
953
|
+
/**
|
|
954
|
+
* Specifies the type of time (DATE).
|
|
955
|
+
*/
|
|
956
|
+
timeType: 'DATE';
|
|
957
|
+
/**
|
|
958
|
+
* The source of the time zone information.
|
|
959
|
+
*/
|
|
960
|
+
timezoneSource?: string;
|
|
961
|
+
/**
|
|
962
|
+
* The year component of the date.
|
|
963
|
+
*/
|
|
964
|
+
year: number;
|
|
965
|
+
/**
|
|
966
|
+
* The identifier for the time zone.
|
|
967
|
+
*/
|
|
968
|
+
zoneId: string;
|
|
969
|
+
}
|
|
970
|
+
|
|
971
|
+
export interface PublicDatePropertyOperation {
|
|
972
|
+
/**
|
|
973
|
+
* The day of the month for the date operation.
|
|
974
|
+
*/
|
|
975
|
+
day: number;
|
|
976
|
+
/**
|
|
977
|
+
* Indicates whether objects with no value set for the property should be included.
|
|
978
|
+
*/
|
|
979
|
+
includeObjectsWithNoValueSet: boolean;
|
|
980
|
+
/**
|
|
981
|
+
* The month for the date operation.
|
|
982
|
+
*/
|
|
983
|
+
month: string;
|
|
984
|
+
/**
|
|
985
|
+
* Specifies the type of operation (DATE).
|
|
986
|
+
*/
|
|
987
|
+
operationType: 'DATE';
|
|
988
|
+
/**
|
|
989
|
+
* Defines the operation to be applied in the date property operation (IS_LESS_THAN_X_DAYS_AGO, IS_MORE_THAN_X_DAYS_AGO, IS_LESS_THAN_X_DAYS_FROM_NOW, IS_MORE_THAN_X_DAYS_FROM_NOW).
|
|
990
|
+
*/
|
|
991
|
+
operator: string;
|
|
992
|
+
/**
|
|
993
|
+
* The year for the date operation.
|
|
994
|
+
*/
|
|
995
|
+
year: number;
|
|
996
|
+
}
|
|
997
|
+
|
|
998
|
+
export interface PublicDateTimePropertyOperation {
|
|
999
|
+
/**
|
|
1000
|
+
* Specifies whether objects without a set value should be included in the operation.
|
|
1001
|
+
*/
|
|
1002
|
+
includeObjectsWithNoValueSet: boolean;
|
|
1003
|
+
/**
|
|
1004
|
+
* The type of operation (DATETIME).
|
|
1005
|
+
*/
|
|
1006
|
+
operationType: 'DATETIME';
|
|
1007
|
+
/**
|
|
1008
|
+
* Defines the operation to be applied, such as comparison operators (IS_BEFORE, IS_AFTER).
|
|
1009
|
+
*/
|
|
1010
|
+
operator: string;
|
|
1011
|
+
/**
|
|
1012
|
+
* Indicates whether the timestamp requires conversion to a different time zone.
|
|
1013
|
+
*/
|
|
1014
|
+
requiresTimeZoneConversion: boolean;
|
|
1015
|
+
/**
|
|
1016
|
+
* The specific point in time used in the operation.
|
|
1017
|
+
*/
|
|
1018
|
+
timestamp: number;
|
|
1019
|
+
}
|
|
1020
|
+
|
|
1021
|
+
export interface PublicEmailEventFilter {
|
|
1022
|
+
/**
|
|
1023
|
+
* The ID of the application associated with the email event filter.
|
|
1024
|
+
*/
|
|
1025
|
+
appId: string;
|
|
1026
|
+
/**
|
|
1027
|
+
* The URL that was clicked in the email event.
|
|
1028
|
+
*/
|
|
1029
|
+
clickUrl?: string;
|
|
1030
|
+
/**
|
|
1031
|
+
* The ID of the email associated with the event filter.
|
|
1032
|
+
*/
|
|
1033
|
+
emailId: string;
|
|
1034
|
+
/**
|
|
1035
|
+
* Indicates the type of filter (EMAIL_EVENT).
|
|
1036
|
+
*/
|
|
1037
|
+
filterType: 'EMAIL_EVENT';
|
|
1038
|
+
/**
|
|
1039
|
+
* Specifies the level of the email event, such as EMAIL_API_CAMPAIGN_GROUP.
|
|
1040
|
+
*/
|
|
1041
|
+
level: string;
|
|
1042
|
+
/**
|
|
1043
|
+
* Defines the operation to be applied within the filter (BOUNCED, LINK_CLICKED, MARKED_SPAM, OPENED, OPENED_BUT_LINK_NOT_CLICKED, OPENED_BUT_NOT_REPLIED, RECEIVED, RECEIVED_BUT_NOT_OPENED, REPLIED, SENT, SENT_BUT_LINK_NOT_CLICKED, SENT_BUT_NOT_RECEIVED, UNSUBSCRIBED).
|
|
1044
|
+
*/
|
|
1045
|
+
operator:
|
|
1046
|
+
| 'BOUNCED'
|
|
1047
|
+
| 'LINK_CLICKED'
|
|
1048
|
+
| 'MARKED_SPAM'
|
|
1049
|
+
| 'OPENED'
|
|
1050
|
+
| 'OPENED_BUT_LINK_NOT_CLICKED'
|
|
1051
|
+
| 'OPENED_BUT_NOT_REPLIED'
|
|
1052
|
+
| 'RECEIVED'
|
|
1053
|
+
| 'RECEIVED_BUT_NOT_OPENED'
|
|
1054
|
+
| 'REPLIED'
|
|
1055
|
+
| 'SENT'
|
|
1056
|
+
| 'SENT_BUT_LINK_NOT_CLICKED'
|
|
1057
|
+
| 'SENT_BUT_NOT_RECEIVED'
|
|
1058
|
+
| 'UNSUBSCRIBED';
|
|
1059
|
+
/**
|
|
1060
|
+
* Specifies the criteria for refining the filter by pruning.
|
|
1061
|
+
*/
|
|
1062
|
+
pruningRefineBy?:
|
|
1063
|
+
| Schemas.PublicNumOccurrencesRefineBy
|
|
1064
|
+
| Schemas.PublicSetOccurrencesRefineBy
|
|
1065
|
+
| Schemas.PublicRelativeComparativeTimestampRefineBy
|
|
1066
|
+
| Schemas.PublicRelativeRangedTimestampRefineBy
|
|
1067
|
+
| Schemas.PublicAbsoluteComparativeTimestampRefineBy
|
|
1068
|
+
| Schemas.PublicAbsoluteRangedTimestampRefineBy
|
|
1069
|
+
| Schemas.PublicAllHistoryRefineBy
|
|
1070
|
+
| Schemas.PublicTimePointOperation
|
|
1071
|
+
| Schemas.PublicRangedTimeOperation;
|
|
1072
|
+
}
|
|
1073
|
+
|
|
1074
|
+
export interface PublicEmailSubscriptionFilter {
|
|
1075
|
+
acceptedStatuses: string[];
|
|
1076
|
+
/**
|
|
1077
|
+
* Indicates the type of filter (EMAIL_SUBSCRIPTION).
|
|
1078
|
+
*/
|
|
1079
|
+
filterType: 'EMAIL_SUBSCRIPTION';
|
|
1080
|
+
subscriptionIds: string[];
|
|
1081
|
+
/**
|
|
1082
|
+
* The type of subscription related to the filter (PORTAL, BRAND, SUBSCRIPTION, HARDBOUNCE, SPAMREPORT).
|
|
1083
|
+
*/
|
|
1084
|
+
subscriptionType?: string;
|
|
1085
|
+
}
|
|
1086
|
+
|
|
1087
|
+
export interface PublicEnumerationPropertyOperation {
|
|
1088
|
+
/**
|
|
1089
|
+
* Indicates whether objects with no value set for the property should be included in the operation.
|
|
1090
|
+
*/
|
|
1091
|
+
includeObjectsWithNoValueSet: boolean;
|
|
1092
|
+
/**
|
|
1093
|
+
* Specifies the type of operation (ENUMERATION).
|
|
1094
|
+
*/
|
|
1095
|
+
operationType: 'ENUMERATION';
|
|
1096
|
+
/**
|
|
1097
|
+
* Defines the operation to be applied in the enumeration property operation (IS_ANY_OF, IS_NONE_OF, IS_EXACTLY, IS_NOT_EXACTLY, CONTAINS_ALL, DOES_NOT_CONTAIN_ALL, HAS_EVER_BEEN_ANY_OF, HAS_NEVER_BEEN_ANY_OF, HAS_EVER_BEEN_EXACTLY, HAS_NEVER_BEEN_EXACTLY, HAS_EVER_CONTAINED_ALL, HAS_NEVER_CONTAINED_ALL).
|
|
1098
|
+
*/
|
|
1099
|
+
operator: string;
|
|
1100
|
+
values: string[];
|
|
1101
|
+
}
|
|
1102
|
+
|
|
1103
|
+
export interface PublicEventAnalyticsFilter {
|
|
1104
|
+
/**
|
|
1105
|
+
* Specifies the criteria for refining the event filter by coalescing.
|
|
1106
|
+
*/
|
|
1107
|
+
coalescingRefineBy?:
|
|
1108
|
+
| Schemas.PublicNumOccurrencesRefineBy
|
|
1109
|
+
| Schemas.PublicSetOccurrencesRefineBy
|
|
1110
|
+
| Schemas.PublicRelativeComparativeTimestampRefineBy
|
|
1111
|
+
| Schemas.PublicRelativeRangedTimestampRefineBy
|
|
1112
|
+
| Schemas.PublicAbsoluteComparativeTimestampRefineBy
|
|
1113
|
+
| Schemas.PublicAbsoluteRangedTimestampRefineBy
|
|
1114
|
+
| Schemas.PublicAllHistoryRefineBy
|
|
1115
|
+
| Schemas.PublicTimePointOperation
|
|
1116
|
+
| Schemas.PublicRangedTimeOperation;
|
|
1117
|
+
/**
|
|
1118
|
+
* The ID of the event to be used in the filter.
|
|
1119
|
+
*/
|
|
1120
|
+
eventId: string;
|
|
1121
|
+
/**
|
|
1122
|
+
* Indicates the type of filter being applied (EVENT).
|
|
1123
|
+
*/
|
|
1124
|
+
filterType: 'EVENT';
|
|
1125
|
+
/**
|
|
1126
|
+
* Defines the operation to be applied within the event filter (HAS_EVENT, NOT_HAS_EVENT).
|
|
1127
|
+
*/
|
|
1128
|
+
operator: string;
|
|
1129
|
+
/**
|
|
1130
|
+
* Specifies the criteria for refining the event filter by pruning.
|
|
1131
|
+
*/
|
|
1132
|
+
pruningRefineBy?:
|
|
1133
|
+
| Schemas.PublicNumOccurrencesRefineBy
|
|
1134
|
+
| Schemas.PublicSetOccurrencesRefineBy
|
|
1135
|
+
| Schemas.PublicRelativeComparativeTimestampRefineBy
|
|
1136
|
+
| Schemas.PublicRelativeRangedTimestampRefineBy
|
|
1137
|
+
| Schemas.PublicAbsoluteComparativeTimestampRefineBy
|
|
1138
|
+
| Schemas.PublicAbsoluteRangedTimestampRefineBy
|
|
1139
|
+
| Schemas.PublicAllHistoryRefineBy
|
|
1140
|
+
| Schemas.PublicTimePointOperation
|
|
1141
|
+
| Schemas.PublicRangedTimeOperation;
|
|
1142
|
+
}
|
|
1143
|
+
|
|
1144
|
+
export interface PublicEventFilterMetadata {
|
|
1145
|
+
/**
|
|
1146
|
+
* Defines the operation to be performed on the property
|
|
1147
|
+
*/
|
|
1148
|
+
operation:
|
|
1149
|
+
| Schemas.PublicBoolPropertyOperation
|
|
1150
|
+
| Schemas.PublicNumberPropertyOperation
|
|
1151
|
+
| Schemas.PublicStringPropertyOperation
|
|
1152
|
+
| Schemas.PublicDateTimePropertyOperation
|
|
1153
|
+
| Schemas.PublicRangedDatePropertyOperation
|
|
1154
|
+
| Schemas.PublicComparativePropertyUpdatedOperation
|
|
1155
|
+
| Schemas.PublicComparativeDatePropertyOperation
|
|
1156
|
+
| Schemas.PublicRollingDateRangePropertyOperation
|
|
1157
|
+
| Schemas.PublicRollingPropertyUpdatedOperation
|
|
1158
|
+
| Schemas.PublicEnumerationPropertyOperation
|
|
1159
|
+
| Schemas.PublicAllPropertyTypesOperation
|
|
1160
|
+
| Schemas.PublicRangedNumberPropertyOperation
|
|
1161
|
+
| Schemas.PublicMultiStringPropertyOperation
|
|
1162
|
+
| Schemas.PublicDatePropertyOperation
|
|
1163
|
+
| Schemas.PublicCalendarDatePropertyOperation
|
|
1164
|
+
| Schemas.PublicTimePointOperation
|
|
1165
|
+
| Schemas.PublicRangedTimeOperation;
|
|
1166
|
+
/**
|
|
1167
|
+
* Specifies the property on which the operation is to be applied.
|
|
1168
|
+
*/
|
|
1169
|
+
property: string;
|
|
1170
|
+
}
|
|
1171
|
+
|
|
1172
|
+
export interface PublicFiscalQuarterReference {
|
|
1173
|
+
/**
|
|
1174
|
+
* The day component of the fiscal quarter reference.
|
|
1175
|
+
*/
|
|
1176
|
+
day: number;
|
|
1177
|
+
/**
|
|
1178
|
+
* The hour component of the fiscal quarter reference.
|
|
1179
|
+
*/
|
|
1180
|
+
hour?: number;
|
|
1181
|
+
/**
|
|
1182
|
+
* The millisecond component of the fiscal quarter reference.
|
|
1183
|
+
*/
|
|
1184
|
+
millisecond?: number;
|
|
1185
|
+
/**
|
|
1186
|
+
* The minute component of the fiscal quarter reference.
|
|
1187
|
+
*/
|
|
1188
|
+
minute?: number;
|
|
1189
|
+
/**
|
|
1190
|
+
* The month component of the fiscal quarter reference.
|
|
1191
|
+
*/
|
|
1192
|
+
month: number;
|
|
1193
|
+
/**
|
|
1194
|
+
* Indicates the type of reference (FISCAL_QUARTER).
|
|
1195
|
+
*/
|
|
1196
|
+
referenceType: 'FISCAL_QUARTER';
|
|
1197
|
+
/**
|
|
1198
|
+
* The second component of the fiscal quarter reference.
|
|
1199
|
+
*/
|
|
1200
|
+
second?: number;
|
|
1201
|
+
}
|
|
1202
|
+
|
|
1203
|
+
export interface PublicFiscalYearReference {
|
|
1204
|
+
/**
|
|
1205
|
+
* The day component of the fiscal year reference.
|
|
1206
|
+
*/
|
|
1207
|
+
day: number;
|
|
1208
|
+
/**
|
|
1209
|
+
* The hour component of the fiscal year reference.
|
|
1210
|
+
*/
|
|
1211
|
+
hour?: number;
|
|
1212
|
+
/**
|
|
1213
|
+
* The millisecond component of the fiscal year reference.
|
|
1214
|
+
*/
|
|
1215
|
+
millisecond?: number;
|
|
1216
|
+
/**
|
|
1217
|
+
* The minute component of the fiscal year reference.
|
|
1218
|
+
*/
|
|
1219
|
+
minute?: number;
|
|
1220
|
+
/**
|
|
1221
|
+
* The month component of the fiscal year reference.
|
|
1222
|
+
*/
|
|
1223
|
+
month: number;
|
|
1224
|
+
/**
|
|
1225
|
+
* Indicates the type of reference (FISCAL_YEAR).
|
|
1226
|
+
*/
|
|
1227
|
+
referenceType: 'FISCAL_YEAR';
|
|
1228
|
+
/**
|
|
1229
|
+
* The second component of the fiscal year reference.
|
|
1230
|
+
*/
|
|
1231
|
+
second?: number;
|
|
1232
|
+
}
|
|
1233
|
+
|
|
1234
|
+
export interface PublicFormSubmissionFilter {
|
|
1235
|
+
/**
|
|
1236
|
+
* Specifies the criteria for refining the filter by coalescing.
|
|
1237
|
+
*/
|
|
1238
|
+
coalescingRefineBy?:
|
|
1239
|
+
| Schemas.PublicNumOccurrencesRefineBy
|
|
1240
|
+
| Schemas.PublicSetOccurrencesRefineBy
|
|
1241
|
+
| Schemas.PublicRelativeComparativeTimestampRefineBy
|
|
1242
|
+
| Schemas.PublicRelativeRangedTimestampRefineBy
|
|
1243
|
+
| Schemas.PublicAbsoluteComparativeTimestampRefineBy
|
|
1244
|
+
| Schemas.PublicAbsoluteRangedTimestampRefineBy
|
|
1245
|
+
| Schemas.PublicAllHistoryRefineBy
|
|
1246
|
+
| Schemas.PublicTimePointOperation
|
|
1247
|
+
| Schemas.PublicRangedTimeOperation;
|
|
1248
|
+
/**
|
|
1249
|
+
* Indicates the type of filter (FORM_SUBMISSION).
|
|
1250
|
+
*/
|
|
1251
|
+
filterType: 'FORM_SUBMISSION';
|
|
1252
|
+
/**
|
|
1253
|
+
* The ID of the form used in the filter.
|
|
1254
|
+
*/
|
|
1255
|
+
formId?: string;
|
|
1256
|
+
/**
|
|
1257
|
+
* Specifies the operation to be performed (FILLED_OUT, NOT_FILLED_OUT).
|
|
1258
|
+
*/
|
|
1259
|
+
operator: 'FILLED_OUT' | 'NOT_FILLED_OUT';
|
|
1260
|
+
/**
|
|
1261
|
+
* Specifies the criteria for refining the filter by pruning.
|
|
1262
|
+
*/
|
|
1263
|
+
pruningRefineBy?:
|
|
1264
|
+
| Schemas.PublicNumOccurrencesRefineBy
|
|
1265
|
+
| Schemas.PublicSetOccurrencesRefineBy
|
|
1266
|
+
| Schemas.PublicRelativeComparativeTimestampRefineBy
|
|
1267
|
+
| Schemas.PublicRelativeRangedTimestampRefineBy
|
|
1268
|
+
| Schemas.PublicAbsoluteComparativeTimestampRefineBy
|
|
1269
|
+
| Schemas.PublicAbsoluteRangedTimestampRefineBy
|
|
1270
|
+
| Schemas.PublicAllHistoryRefineBy
|
|
1271
|
+
| Schemas.PublicTimePointOperation
|
|
1272
|
+
| Schemas.PublicRangedTimeOperation;
|
|
1273
|
+
}
|
|
1274
|
+
|
|
1275
|
+
export interface PublicFormSubmissionOnPageFilter {
|
|
1276
|
+
/**
|
|
1277
|
+
* Defines the criteria for refining the filter by coalescing.
|
|
1278
|
+
*/
|
|
1279
|
+
coalescingRefineBy?:
|
|
1280
|
+
| Schemas.PublicNumOccurrencesRefineBy
|
|
1281
|
+
| Schemas.PublicSetOccurrencesRefineBy
|
|
1282
|
+
| Schemas.PublicRelativeComparativeTimestampRefineBy
|
|
1283
|
+
| Schemas.PublicRelativeRangedTimestampRefineBy
|
|
1284
|
+
| Schemas.PublicAbsoluteComparativeTimestampRefineBy
|
|
1285
|
+
| Schemas.PublicAbsoluteRangedTimestampRefineBy
|
|
1286
|
+
| Schemas.PublicAllHistoryRefineBy
|
|
1287
|
+
| Schemas.PublicTimePointOperation
|
|
1288
|
+
| Schemas.PublicRangedTimeOperation;
|
|
1289
|
+
/**
|
|
1290
|
+
* Indicates the type of filter (FORM_SUBMISSION_ON_PAGE).
|
|
1291
|
+
*/
|
|
1292
|
+
filterType: 'FORM_SUBMISSION_ON_PAGE';
|
|
1293
|
+
/**
|
|
1294
|
+
* The ID of the form associated with the submission filter.
|
|
1295
|
+
*/
|
|
1296
|
+
formId?: string;
|
|
1297
|
+
/**
|
|
1298
|
+
* Specifies the operation to be applied (FILLED_OUT, NOT_FILLED_OUT).
|
|
1299
|
+
*/
|
|
1300
|
+
operator: 'FILLED_OUT' | 'NOT_FILLED_OUT';
|
|
1301
|
+
/**
|
|
1302
|
+
* The ID of the page where the form submission occurred.
|
|
1303
|
+
*/
|
|
1304
|
+
pageId: string;
|
|
1305
|
+
/**
|
|
1306
|
+
* Specifies the criteria for refining the filter by pruning.
|
|
1307
|
+
*/
|
|
1308
|
+
pruningRefineBy?:
|
|
1309
|
+
| Schemas.PublicNumOccurrencesRefineBy
|
|
1310
|
+
| Schemas.PublicSetOccurrencesRefineBy
|
|
1311
|
+
| Schemas.PublicRelativeComparativeTimestampRefineBy
|
|
1312
|
+
| Schemas.PublicRelativeRangedTimestampRefineBy
|
|
1313
|
+
| Schemas.PublicAbsoluteComparativeTimestampRefineBy
|
|
1314
|
+
| Schemas.PublicAbsoluteRangedTimestampRefineBy
|
|
1315
|
+
| Schemas.PublicAllHistoryRefineBy
|
|
1316
|
+
| Schemas.PublicTimePointOperation
|
|
1317
|
+
| Schemas.PublicRangedTimeOperation;
|
|
1318
|
+
}
|
|
1319
|
+
|
|
1320
|
+
export interface PublicIndexedTimePoint {
|
|
1321
|
+
/**
|
|
1322
|
+
* Specifies the reference point in time for the indexed time point.
|
|
1323
|
+
*/
|
|
1324
|
+
indexReference:
|
|
1325
|
+
| Schemas.PublicNowReference
|
|
1326
|
+
| Schemas.PublicTodayReference
|
|
1327
|
+
| Schemas.PublicWeekReference
|
|
1328
|
+
| Schemas.PublicFiscalQuarterReference
|
|
1329
|
+
| Schemas.PublicFiscalYearReference
|
|
1330
|
+
| Schemas.PublicYearReference
|
|
1331
|
+
| Schemas.PublicQuarterReference
|
|
1332
|
+
| Schemas.PublicMonthReference;
|
|
1333
|
+
offset?: Schemas.PublicIndexOffset;
|
|
1334
|
+
/**
|
|
1335
|
+
* Defines the type of time (INDEXED).
|
|
1336
|
+
*/
|
|
1337
|
+
timeType: 'INDEXED';
|
|
1338
|
+
/**
|
|
1339
|
+
* Specifies the source of the time zone information for the indexed time point (CUSTOM, USER, PORTAL).
|
|
1340
|
+
*/
|
|
1341
|
+
timezoneSource?: string;
|
|
1342
|
+
/**
|
|
1343
|
+
* Indicates the identifier for the time zone associated with the indexed time point.
|
|
1344
|
+
*/
|
|
1345
|
+
zoneId: string;
|
|
1346
|
+
}
|
|
1347
|
+
|
|
1348
|
+
export interface PublicIndexOffset {
|
|
1349
|
+
/**
|
|
1350
|
+
* The number of days to offset.
|
|
1351
|
+
*/
|
|
1352
|
+
days?: number;
|
|
1353
|
+
/**
|
|
1354
|
+
* The number of hours to offset.
|
|
1355
|
+
*/
|
|
1356
|
+
hours?: number;
|
|
1357
|
+
/**
|
|
1358
|
+
* The number of milliseconds to offset.
|
|
1359
|
+
*/
|
|
1360
|
+
milliseconds?: number;
|
|
1361
|
+
/**
|
|
1362
|
+
* The number of minutes to offset.
|
|
1363
|
+
*/
|
|
1364
|
+
minutes?: number;
|
|
1365
|
+
/**
|
|
1366
|
+
* The number of months to offset.
|
|
1367
|
+
*/
|
|
1368
|
+
months?: number;
|
|
1369
|
+
/**
|
|
1370
|
+
* The number of quarters to offset.
|
|
1371
|
+
*/
|
|
1372
|
+
quarters?: number;
|
|
1373
|
+
/**
|
|
1374
|
+
* The number of seconds to offset.
|
|
1375
|
+
*/
|
|
1376
|
+
seconds?: number;
|
|
1377
|
+
/**
|
|
1378
|
+
* The number of weeks to offset.
|
|
1379
|
+
*/
|
|
1380
|
+
weeks?: number;
|
|
1381
|
+
/**
|
|
1382
|
+
* The number of years to offset.
|
|
1383
|
+
*/
|
|
1384
|
+
years?: number;
|
|
1385
|
+
}
|
|
1386
|
+
|
|
1387
|
+
export interface PublicInListFilter {
|
|
1388
|
+
/**
|
|
1389
|
+
* Indicates the type of filter being applied (IN_LIST).
|
|
1390
|
+
*/
|
|
1391
|
+
filterType: 'IN_LIST';
|
|
1392
|
+
/**
|
|
1393
|
+
* The ID of the list used in the association filter.
|
|
1394
|
+
*/
|
|
1395
|
+
listId: string;
|
|
1396
|
+
metadata?: Schemas.PublicInListFilterMetadata;
|
|
1397
|
+
/**
|
|
1398
|
+
* Specifies the operation to be performed by the filter (IN_LIST, NOT_IN_LIST).
|
|
1399
|
+
*/
|
|
1400
|
+
operator: string;
|
|
1401
|
+
}
|
|
1402
|
+
|
|
1403
|
+
export interface PublicInListFilterMetadata {
|
|
1404
|
+
/**
|
|
1405
|
+
* The identifier for the filter metadata.
|
|
1406
|
+
*/
|
|
1407
|
+
id: string;
|
|
1408
|
+
/**
|
|
1409
|
+
* Specifies the type of list for the filter (WORKFLOWS_ENROLLMENT, WORKFLOWS_ACTIVE, WORKFLOWS_GOAL, WORKFLOWS_COMPLETED, IMPORT, DATASET, DATASETS).
|
|
1410
|
+
*/
|
|
1411
|
+
inListType: string;
|
|
1412
|
+
}
|
|
1413
|
+
|
|
1414
|
+
export interface PublicIntegrationEventFilter {
|
|
1415
|
+
/**
|
|
1416
|
+
* The ID representing the type of event for the integration event filter.
|
|
1417
|
+
*/
|
|
1418
|
+
eventTypeId: number;
|
|
1419
|
+
filterLines: Schemas.PublicEventFilterMetadata[];
|
|
1420
|
+
/**
|
|
1421
|
+
* Indicates the type of filter (INTEGRATION_EVENT).
|
|
1422
|
+
*/
|
|
1423
|
+
filterType: 'INTEGRATION_EVENT';
|
|
1424
|
+
}
|
|
1425
|
+
|
|
1426
|
+
export interface PublicListConversionDate {
|
|
1427
|
+
/**
|
|
1428
|
+
* Specifies the type of conversion (CONVERSION_DATE).
|
|
1429
|
+
*/
|
|
1430
|
+
conversionType: 'CONVERSION_DATE';
|
|
1431
|
+
/**
|
|
1432
|
+
* The day component of the conversion date.
|
|
1433
|
+
*/
|
|
1434
|
+
day: number;
|
|
1435
|
+
/**
|
|
1436
|
+
* The month component of the conversion date.
|
|
1437
|
+
*/
|
|
1438
|
+
month: number;
|
|
1439
|
+
/**
|
|
1440
|
+
* The year component of the conversion date.
|
|
1441
|
+
*/
|
|
1442
|
+
year: number;
|
|
1443
|
+
}
|
|
1444
|
+
|
|
1445
|
+
export interface PublicListConversionInactivity {
|
|
1446
|
+
/**
|
|
1447
|
+
* Specifies the type of conversion (INACTIVITY).
|
|
1448
|
+
*/
|
|
1449
|
+
conversionType: 'INACTIVITY';
|
|
1450
|
+
/**
|
|
1451
|
+
* Value used to paginate through lists. The `offset` provided in the response can be used in the next request to fetch the next page of results. Defaults to `0` if no offset is provided.
|
|
1452
|
+
*/
|
|
1453
|
+
offset: number;
|
|
1454
|
+
/**
|
|
1455
|
+
* The unit of time for the inactivity period, such as (DAY, MONTH, WEEK).
|
|
1456
|
+
*/
|
|
1457
|
+
timeUnit: 'DAY' | 'MONTH' | 'WEEK';
|
|
1458
|
+
}
|
|
1459
|
+
|
|
1460
|
+
export interface PublicListConversionResponse {
|
|
1461
|
+
/**
|
|
1462
|
+
* The date and time when the list was converted.
|
|
1463
|
+
*/
|
|
1464
|
+
convertedAt?: string;
|
|
1465
|
+
/**
|
|
1466
|
+
* The unique identifier of the list for which the conversion details are provided.
|
|
1467
|
+
*/
|
|
1468
|
+
listId: string;
|
|
1469
|
+
/**
|
|
1470
|
+
* The scheduled time for the list conversion, which can be based on a specific date or inactivity period.
|
|
1471
|
+
*/
|
|
1472
|
+
requestedConversionTime?:
|
|
1473
|
+
| Schemas.PublicListConversionDate
|
|
1474
|
+
| Schemas.PublicListConversionInactivity;
|
|
1475
|
+
}
|
|
1476
|
+
|
|
1477
|
+
export type PublicListConversionTime =
|
|
1478
|
+
| Schemas.PublicListConversionDate
|
|
1479
|
+
| Schemas.PublicListConversionInactivity;
|
|
1480
|
+
|
|
1481
|
+
export interface PublicListFolder {
|
|
1482
|
+
/**
|
|
1483
|
+
* An array of list Id's contained in this folder.
|
|
1484
|
+
*/
|
|
1485
|
+
childLists: number[];
|
|
1486
|
+
childNodes: Schemas.PublicListFolder[];
|
|
1487
|
+
/**
|
|
1488
|
+
* The time the folder was created at.
|
|
1489
|
+
*/
|
|
1490
|
+
createdAt?: string;
|
|
1491
|
+
/**
|
|
1492
|
+
* The Id of the folder.
|
|
1493
|
+
*/
|
|
1494
|
+
id: string;
|
|
1495
|
+
/**
|
|
1496
|
+
* The name of the folder.
|
|
1497
|
+
*/
|
|
1498
|
+
name?: string;
|
|
1499
|
+
/**
|
|
1500
|
+
* The Id of the folder this folder is in, the root folder is represented as 0.
|
|
1501
|
+
*/
|
|
1502
|
+
parentFolderId: string;
|
|
1503
|
+
/**
|
|
1504
|
+
* The time the folder was last updated at.
|
|
1505
|
+
*/
|
|
1506
|
+
updatedAt?: string;
|
|
1507
|
+
/**
|
|
1508
|
+
* The time that the contents of the folder was last updated at.
|
|
1509
|
+
*/
|
|
1510
|
+
updatedContentsAt?: string;
|
|
1511
|
+
/**
|
|
1512
|
+
* The user Id of the owner of the folder.
|
|
1513
|
+
*/
|
|
1514
|
+
userId?: number;
|
|
1515
|
+
}
|
|
1516
|
+
|
|
1517
|
+
export interface PublicListPermissions {
|
|
1518
|
+
teamsWithEditAccess: number[];
|
|
1519
|
+
usersWithEditAccess: number[];
|
|
1520
|
+
}
|
|
1521
|
+
|
|
1522
|
+
export interface PublicMembershipSettings {
|
|
1523
|
+
/**
|
|
1524
|
+
* Indicates whether unassigned memberships should be included.
|
|
1525
|
+
*/
|
|
1526
|
+
includeUnassigned?: boolean;
|
|
1527
|
+
/**
|
|
1528
|
+
* The ID of the team associated with the membership.
|
|
1529
|
+
*/
|
|
1530
|
+
membershipTeamId?: number;
|
|
1531
|
+
}
|
|
1532
|
+
|
|
1533
|
+
export interface PublicMigrationMapping {
|
|
1534
|
+
/**
|
|
1535
|
+
* The legacy list id for the list
|
|
1536
|
+
*/
|
|
1537
|
+
legacyListId: string;
|
|
1538
|
+
/**
|
|
1539
|
+
* The V3 list id for the list
|
|
1540
|
+
*/
|
|
1541
|
+
listId: string;
|
|
1542
|
+
}
|
|
1543
|
+
|
|
1544
|
+
export interface PublicMonthReference {
|
|
1545
|
+
/**
|
|
1546
|
+
* The day component of the month reference.
|
|
1547
|
+
*/
|
|
1548
|
+
day: number;
|
|
1549
|
+
/**
|
|
1550
|
+
* The hour component of the month reference.
|
|
1551
|
+
*/
|
|
1552
|
+
hour?: number;
|
|
1553
|
+
/**
|
|
1554
|
+
* The millisecond component of the month reference.
|
|
1555
|
+
*/
|
|
1556
|
+
millisecond?: number;
|
|
1557
|
+
/**
|
|
1558
|
+
* The minute component of the month reference.
|
|
1559
|
+
*/
|
|
1560
|
+
minute?: number;
|
|
1561
|
+
/**
|
|
1562
|
+
* Indicates the type of reference, (MONTH).
|
|
1563
|
+
*/
|
|
1564
|
+
referenceType: 'MONTH';
|
|
1565
|
+
/**
|
|
1566
|
+
* The second component of the month reference.
|
|
1567
|
+
*/
|
|
1568
|
+
second?: number;
|
|
1569
|
+
}
|
|
1570
|
+
|
|
1571
|
+
export interface PublicMultiStringPropertyOperation {
|
|
1572
|
+
/**
|
|
1573
|
+
* Indicates whether objects with no value set for the property should be included in the operation.
|
|
1574
|
+
*/
|
|
1575
|
+
includeObjectsWithNoValueSet: boolean;
|
|
1576
|
+
/**
|
|
1577
|
+
* Specifies the type of operation (MULTISTRING).
|
|
1578
|
+
*/
|
|
1579
|
+
operationType: 'MULTISTRING';
|
|
1580
|
+
/**
|
|
1581
|
+
* Defines the operation to be applied in the multi-string property operation (IS_EQUAL_TO, IS_NOT_EQUAL_TO, CONTAINS, CONTAINS_EXACTLY, DOES_NOT_CONTAIN, DOES_NOT_CONTAIN_EXACTLY, STARTS_WITH, ENDS_WITH).
|
|
1582
|
+
*/
|
|
1583
|
+
operator: string;
|
|
1584
|
+
values: string[];
|
|
1585
|
+
}
|
|
1586
|
+
|
|
1587
|
+
export interface PublicNotAllFilterBranch {
|
|
1588
|
+
filterBranches: (
|
|
1589
|
+
| Schemas.PublicOrFilterBranch
|
|
1590
|
+
| Schemas.PublicAndFilterBranch
|
|
1591
|
+
| Schemas.PublicNotAllFilterBranch
|
|
1592
|
+
| Schemas.PublicNotAnyFilterBranch
|
|
1593
|
+
| Schemas.PublicRestrictedFilterBranch
|
|
1594
|
+
| Schemas.PublicUnifiedEventsFilterBranch
|
|
1595
|
+
| Schemas.PublicPropertyAssociationFilterBranch
|
|
1596
|
+
| Schemas.PublicAssociationFilterBranch
|
|
1597
|
+
)[];
|
|
1598
|
+
/**
|
|
1599
|
+
* The operator used to combine filters within the branch (NOT_ALL).
|
|
1600
|
+
*/
|
|
1601
|
+
filterBranchOperator: string;
|
|
1602
|
+
/**
|
|
1603
|
+
* The type of the filter branch (NOT_ALL).
|
|
1604
|
+
*/
|
|
1605
|
+
filterBranchType: 'NOT_ALL';
|
|
1606
|
+
filters: (
|
|
1607
|
+
| Schemas.PublicPropertyFilter
|
|
1608
|
+
| Schemas.PublicAssociationInListFilter
|
|
1609
|
+
| Schemas.PublicPageViewAnalyticsFilter
|
|
1610
|
+
| Schemas.PublicCtaAnalyticsFilter
|
|
1611
|
+
| Schemas.PublicEventAnalyticsFilter
|
|
1612
|
+
| Schemas.PublicFormSubmissionFilter
|
|
1613
|
+
| Schemas.PublicFormSubmissionOnPageFilter
|
|
1614
|
+
| Schemas.PublicIntegrationEventFilter
|
|
1615
|
+
| Schemas.PublicEmailSubscriptionFilter
|
|
1616
|
+
| Schemas.PublicCommunicationSubscriptionFilter
|
|
1617
|
+
| Schemas.PublicCampaignInfluencedFilter
|
|
1618
|
+
| Schemas.PublicSurveyMonkeyFilter
|
|
1619
|
+
| Schemas.PublicSurveyMonkeyValueFilter
|
|
1620
|
+
| Schemas.PublicWebinarFilter
|
|
1621
|
+
| Schemas.PublicEmailEventFilter
|
|
1622
|
+
| Schemas.PublicPrivacyAnalyticsFilter
|
|
1623
|
+
| Schemas.PublicAdsSearchFilter
|
|
1624
|
+
| Schemas.PublicAdsTimeFilter
|
|
1625
|
+
| Schemas.PublicInListFilter
|
|
1626
|
+
| Schemas.PublicNumAssociationsFilter
|
|
1627
|
+
| Schemas.PublicUnifiedEventsFilter
|
|
1628
|
+
| Schemas.PublicPropertyAssociationInListFilter
|
|
1629
|
+
| Schemas.PublicConstantFilter
|
|
1630
|
+
)[];
|
|
1631
|
+
}
|
|
1632
|
+
|
|
1633
|
+
export interface PublicNotAnyFilterBranch {
|
|
1634
|
+
filterBranches: (
|
|
1635
|
+
| Schemas.PublicOrFilterBranch
|
|
1636
|
+
| Schemas.PublicAndFilterBranch
|
|
1637
|
+
| Schemas.PublicNotAllFilterBranch
|
|
1638
|
+
| Schemas.PublicNotAnyFilterBranch
|
|
1639
|
+
| Schemas.PublicRestrictedFilterBranch
|
|
1640
|
+
| Schemas.PublicUnifiedEventsFilterBranch
|
|
1641
|
+
| Schemas.PublicPropertyAssociationFilterBranch
|
|
1642
|
+
| Schemas.PublicAssociationFilterBranch
|
|
1643
|
+
)[];
|
|
1644
|
+
/**
|
|
1645
|
+
* Specifies the logical operator used to combine filters within the branch (NOT_ANY).
|
|
1646
|
+
*/
|
|
1647
|
+
filterBranchOperator: string;
|
|
1648
|
+
/**
|
|
1649
|
+
* Indicates the type of filter branch (NOT_ANY).
|
|
1650
|
+
*/
|
|
1651
|
+
filterBranchType: 'NOT_ANY';
|
|
1652
|
+
filters: (
|
|
1653
|
+
| Schemas.PublicPropertyFilter
|
|
1654
|
+
| Schemas.PublicAssociationInListFilter
|
|
1655
|
+
| Schemas.PublicPageViewAnalyticsFilter
|
|
1656
|
+
| Schemas.PublicCtaAnalyticsFilter
|
|
1657
|
+
| Schemas.PublicEventAnalyticsFilter
|
|
1658
|
+
| Schemas.PublicFormSubmissionFilter
|
|
1659
|
+
| Schemas.PublicFormSubmissionOnPageFilter
|
|
1660
|
+
| Schemas.PublicIntegrationEventFilter
|
|
1661
|
+
| Schemas.PublicEmailSubscriptionFilter
|
|
1662
|
+
| Schemas.PublicCommunicationSubscriptionFilter
|
|
1663
|
+
| Schemas.PublicCampaignInfluencedFilter
|
|
1664
|
+
| Schemas.PublicSurveyMonkeyFilter
|
|
1665
|
+
| Schemas.PublicSurveyMonkeyValueFilter
|
|
1666
|
+
| Schemas.PublicWebinarFilter
|
|
1667
|
+
| Schemas.PublicEmailEventFilter
|
|
1668
|
+
| Schemas.PublicPrivacyAnalyticsFilter
|
|
1669
|
+
| Schemas.PublicAdsSearchFilter
|
|
1670
|
+
| Schemas.PublicAdsTimeFilter
|
|
1671
|
+
| Schemas.PublicInListFilter
|
|
1672
|
+
| Schemas.PublicNumAssociationsFilter
|
|
1673
|
+
| Schemas.PublicUnifiedEventsFilter
|
|
1674
|
+
| Schemas.PublicPropertyAssociationInListFilter
|
|
1675
|
+
| Schemas.PublicConstantFilter
|
|
1676
|
+
)[];
|
|
1677
|
+
}
|
|
1678
|
+
|
|
1679
|
+
export interface PublicNowReference {
|
|
1680
|
+
/**
|
|
1681
|
+
* The hour component of the current time reference.
|
|
1682
|
+
*/
|
|
1683
|
+
hour?: number;
|
|
1684
|
+
/**
|
|
1685
|
+
* The millisecond component of the current time reference.
|
|
1686
|
+
*/
|
|
1687
|
+
millisecond?: number;
|
|
1688
|
+
/**
|
|
1689
|
+
* The minute component of the current time reference.
|
|
1690
|
+
*/
|
|
1691
|
+
minute?: number;
|
|
1692
|
+
/**
|
|
1693
|
+
* Indicates the type of reference (NOW).
|
|
1694
|
+
*/
|
|
1695
|
+
referenceType: 'NOW';
|
|
1696
|
+
/**
|
|
1697
|
+
* The second component of the current time reference.
|
|
1698
|
+
*/
|
|
1699
|
+
second?: number;
|
|
1700
|
+
}
|
|
1701
|
+
|
|
1702
|
+
export interface PublicNumAssociationsFilter {
|
|
1703
|
+
/**
|
|
1704
|
+
* Defines the category of the association (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK).
|
|
1705
|
+
*/
|
|
1706
|
+
associationCategory: string;
|
|
1707
|
+
/**
|
|
1708
|
+
* The ID representing the type of association being filtered.
|
|
1709
|
+
*/
|
|
1710
|
+
associationTypeId: number;
|
|
1711
|
+
/**
|
|
1712
|
+
* Specifies the criteria for refining the association filter.
|
|
1713
|
+
*/
|
|
1714
|
+
coalescingRefineBy:
|
|
1715
|
+
| Schemas.PublicNumOccurrencesRefineBy
|
|
1716
|
+
| Schemas.PublicSetOccurrencesRefineBy
|
|
1717
|
+
| Schemas.PublicRelativeComparativeTimestampRefineBy
|
|
1718
|
+
| Schemas.PublicRelativeRangedTimestampRefineBy
|
|
1719
|
+
| Schemas.PublicAbsoluteComparativeTimestampRefineBy
|
|
1720
|
+
| Schemas.PublicAbsoluteRangedTimestampRefineBy
|
|
1721
|
+
| Schemas.PublicAllHistoryRefineBy
|
|
1722
|
+
| Schemas.PublicTimePointOperation
|
|
1723
|
+
| Schemas.PublicRangedTimeOperation;
|
|
1724
|
+
/**
|
|
1725
|
+
* Indicates the type of filter being applied (NUM_ASSOCIATIONS).
|
|
1726
|
+
*/
|
|
1727
|
+
filterType: 'NUM_ASSOCIATIONS';
|
|
1728
|
+
}
|
|
1729
|
+
|
|
1730
|
+
export interface PublicNumberPropertyOperation {
|
|
1731
|
+
/**
|
|
1732
|
+
* Indicates whether objects with no value set for the property should be included in the operation.
|
|
1733
|
+
*/
|
|
1734
|
+
includeObjectsWithNoValueSet: boolean;
|
|
1735
|
+
/**
|
|
1736
|
+
* Specifies the type of operation (NUMBER).
|
|
1737
|
+
*/
|
|
1738
|
+
operationType: 'NUMBER';
|
|
1739
|
+
/**
|
|
1740
|
+
* Defines the operation to be applied in the number property operation (IS_EQUAL_TO, IS_NOT_EQUAL_TO, IS_GREATER_THAN, IS_GREATER_THAN_OR_EQUAL_TO, IS_LESS_THAN, IS_LESS_THAN_OR_EQUAL_TO, HAS_EVER_BEEN_EQUAL_TO, HAS_NEVER_BEEN_EQUAL_TO).
|
|
1741
|
+
*/
|
|
1742
|
+
operator: string;
|
|
1743
|
+
/**
|
|
1744
|
+
* The numeric value to be used in the operation.
|
|
1745
|
+
*/
|
|
1746
|
+
value: number;
|
|
1747
|
+
}
|
|
1748
|
+
|
|
1749
|
+
export interface PublicNumOccurrencesRefineBy {
|
|
1750
|
+
/**
|
|
1751
|
+
* The maximum number of occurrences allowed.
|
|
1752
|
+
*/
|
|
1753
|
+
maxOccurrences?: number;
|
|
1754
|
+
/**
|
|
1755
|
+
* The minimum number of occurrences required.
|
|
1756
|
+
*/
|
|
1757
|
+
minOccurrences?: number;
|
|
1758
|
+
/**
|
|
1759
|
+
* The type of refinement (NUM_OCCURRENCES).
|
|
1760
|
+
*/
|
|
1761
|
+
type: 'NUM_OCCURRENCES';
|
|
1762
|
+
}
|
|
1763
|
+
|
|
1764
|
+
export interface PublicObjectList {
|
|
1765
|
+
/**
|
|
1766
|
+
* The time when the list was created.
|
|
1767
|
+
*/
|
|
1768
|
+
createdAt?: string;
|
|
1769
|
+
/**
|
|
1770
|
+
* The ID of the user that created the list.
|
|
1771
|
+
*/
|
|
1772
|
+
createdById?: string;
|
|
1773
|
+
/**
|
|
1774
|
+
* The time when the list was deleted.
|
|
1775
|
+
*/
|
|
1776
|
+
deletedAt?: string;
|
|
1777
|
+
/**
|
|
1778
|
+
* Defines the filter criteria for the list, allowing for complex logical operations and nested filter branches to determine list membership.
|
|
1779
|
+
*/
|
|
1780
|
+
filterBranch?:
|
|
1781
|
+
| Schemas.PublicOrFilterBranch
|
|
1782
|
+
| Schemas.PublicAndFilterBranch
|
|
1783
|
+
| Schemas.PublicNotAllFilterBranch
|
|
1784
|
+
| Schemas.PublicNotAnyFilterBranch
|
|
1785
|
+
| Schemas.PublicRestrictedFilterBranch
|
|
1786
|
+
| Schemas.PublicUnifiedEventsFilterBranch
|
|
1787
|
+
| Schemas.PublicPropertyAssociationFilterBranch
|
|
1788
|
+
| Schemas.PublicAssociationFilterBranch;
|
|
1789
|
+
/**
|
|
1790
|
+
* The time when the filters for this list were last updated.
|
|
1791
|
+
*/
|
|
1792
|
+
filtersUpdatedAt?: string;
|
|
1793
|
+
/**
|
|
1794
|
+
* The **ILS ID** of the list.
|
|
1795
|
+
*/
|
|
1796
|
+
listId: string;
|
|
1797
|
+
listPermissions?: Schemas.PublicListPermissions;
|
|
1798
|
+
/**
|
|
1799
|
+
* The version of the list.
|
|
1800
|
+
*/
|
|
1801
|
+
listVersion: number;
|
|
1802
|
+
membershipSettings?: Schemas.PublicMembershipSettings;
|
|
1803
|
+
/**
|
|
1804
|
+
* The name of the list.
|
|
1805
|
+
*/
|
|
1806
|
+
name: string;
|
|
1807
|
+
/**
|
|
1808
|
+
* The object type of the list.
|
|
1809
|
+
*/
|
|
1810
|
+
objectTypeId: string;
|
|
1811
|
+
/**
|
|
1812
|
+
* The processing status of the list.
|
|
1813
|
+
*/
|
|
1814
|
+
processingStatus: string;
|
|
1815
|
+
/**
|
|
1816
|
+
* The processing type of the list.
|
|
1817
|
+
*/
|
|
1818
|
+
processingType: string;
|
|
1819
|
+
/**
|
|
1820
|
+
* Size of the list
|
|
1821
|
+
*/
|
|
1822
|
+
size?: number;
|
|
1823
|
+
/**
|
|
1824
|
+
* The time the list was last updated.
|
|
1825
|
+
*/
|
|
1826
|
+
updatedAt?: string;
|
|
1827
|
+
/**
|
|
1828
|
+
* The ID of the user that last updated the list.
|
|
1829
|
+
*/
|
|
1830
|
+
updatedById?: string;
|
|
1831
|
+
}
|
|
1832
|
+
|
|
1833
|
+
export interface PublicObjectListSearchResult {
|
|
1834
|
+
/**
|
|
1835
|
+
* The name and value of any additional properties that exist for this list and that were included in the search request.
|
|
1836
|
+
*/
|
|
1837
|
+
additionalProperties: Record<string, string>;
|
|
1838
|
+
/**
|
|
1839
|
+
* The time when the list was created.
|
|
1840
|
+
*/
|
|
1841
|
+
createdAt?: string;
|
|
1842
|
+
/**
|
|
1843
|
+
* The ID of the user that created the list.
|
|
1844
|
+
*/
|
|
1845
|
+
createdById?: string;
|
|
1846
|
+
/**
|
|
1847
|
+
* The time when the list was deleted.
|
|
1848
|
+
*/
|
|
1849
|
+
deletedAt?: string;
|
|
1850
|
+
/**
|
|
1851
|
+
* The time when the filters for this list were last updated.
|
|
1852
|
+
*/
|
|
1853
|
+
filtersUpdatedAt?: string;
|
|
1854
|
+
/**
|
|
1855
|
+
* The **ILS ID** of the list.
|
|
1856
|
+
*/
|
|
1857
|
+
listId: string;
|
|
1858
|
+
/**
|
|
1859
|
+
* The version of the list.
|
|
1860
|
+
*/
|
|
1861
|
+
listVersion: number;
|
|
1862
|
+
/**
|
|
1863
|
+
* The name of the list.
|
|
1864
|
+
*/
|
|
1865
|
+
name: string;
|
|
1866
|
+
/**
|
|
1867
|
+
* The object type of the list.
|
|
1868
|
+
*/
|
|
1869
|
+
objectTypeId: string;
|
|
1870
|
+
/**
|
|
1871
|
+
* The processing status of the list.
|
|
1872
|
+
*/
|
|
1873
|
+
processingStatus: string;
|
|
1874
|
+
/**
|
|
1875
|
+
* The processing type of the list.
|
|
1876
|
+
*/
|
|
1877
|
+
processingType: string;
|
|
1878
|
+
/**
|
|
1879
|
+
* The time the list was last updated.
|
|
1880
|
+
*/
|
|
1881
|
+
updatedAt?: string;
|
|
1882
|
+
/**
|
|
1883
|
+
* The ID of the user that last updated the list.
|
|
1884
|
+
*/
|
|
1885
|
+
updatedById?: string;
|
|
1886
|
+
}
|
|
1887
|
+
|
|
1888
|
+
export interface PublicOrFilterBranch {
|
|
1889
|
+
filterBranches: (
|
|
1890
|
+
| Schemas.PublicOrFilterBranch
|
|
1891
|
+
| Schemas.PublicAndFilterBranch
|
|
1892
|
+
| Schemas.PublicNotAllFilterBranch
|
|
1893
|
+
| Schemas.PublicNotAnyFilterBranch
|
|
1894
|
+
| Schemas.PublicRestrictedFilterBranch
|
|
1895
|
+
| Schemas.PublicUnifiedEventsFilterBranch
|
|
1896
|
+
| Schemas.PublicPropertyAssociationFilterBranch
|
|
1897
|
+
| Schemas.PublicAssociationFilterBranch
|
|
1898
|
+
)[];
|
|
1899
|
+
/**
|
|
1900
|
+
* The logical operator used to combine the filters within the branch (OR).
|
|
1901
|
+
*/
|
|
1902
|
+
filterBranchOperator: string;
|
|
1903
|
+
/**
|
|
1904
|
+
* The type of the filter branch (OR).
|
|
1905
|
+
*/
|
|
1906
|
+
filterBranchType: 'OR';
|
|
1907
|
+
filters: (
|
|
1908
|
+
| Schemas.PublicPropertyFilter
|
|
1909
|
+
| Schemas.PublicAssociationInListFilter
|
|
1910
|
+
| Schemas.PublicPageViewAnalyticsFilter
|
|
1911
|
+
| Schemas.PublicCtaAnalyticsFilter
|
|
1912
|
+
| Schemas.PublicEventAnalyticsFilter
|
|
1913
|
+
| Schemas.PublicFormSubmissionFilter
|
|
1914
|
+
| Schemas.PublicFormSubmissionOnPageFilter
|
|
1915
|
+
| Schemas.PublicIntegrationEventFilter
|
|
1916
|
+
| Schemas.PublicEmailSubscriptionFilter
|
|
1917
|
+
| Schemas.PublicCommunicationSubscriptionFilter
|
|
1918
|
+
| Schemas.PublicCampaignInfluencedFilter
|
|
1919
|
+
| Schemas.PublicSurveyMonkeyFilter
|
|
1920
|
+
| Schemas.PublicSurveyMonkeyValueFilter
|
|
1921
|
+
| Schemas.PublicWebinarFilter
|
|
1922
|
+
| Schemas.PublicEmailEventFilter
|
|
1923
|
+
| Schemas.PublicPrivacyAnalyticsFilter
|
|
1924
|
+
| Schemas.PublicAdsSearchFilter
|
|
1925
|
+
| Schemas.PublicAdsTimeFilter
|
|
1926
|
+
| Schemas.PublicInListFilter
|
|
1927
|
+
| Schemas.PublicNumAssociationsFilter
|
|
1928
|
+
| Schemas.PublicUnifiedEventsFilter
|
|
1929
|
+
| Schemas.PublicPropertyAssociationInListFilter
|
|
1930
|
+
| Schemas.PublicConstantFilter
|
|
1931
|
+
)[];
|
|
1932
|
+
}
|
|
1933
|
+
|
|
1934
|
+
export interface PublicPageViewAnalyticsFilter {
|
|
1935
|
+
/**
|
|
1936
|
+
* Specifies the criteria for refining the filter by coalescing.
|
|
1937
|
+
*/
|
|
1938
|
+
coalescingRefineBy?:
|
|
1939
|
+
| Schemas.PublicNumOccurrencesRefineBy
|
|
1940
|
+
| Schemas.PublicSetOccurrencesRefineBy
|
|
1941
|
+
| Schemas.PublicRelativeComparativeTimestampRefineBy
|
|
1942
|
+
| Schemas.PublicRelativeRangedTimestampRefineBy
|
|
1943
|
+
| Schemas.PublicAbsoluteComparativeTimestampRefineBy
|
|
1944
|
+
| Schemas.PublicAbsoluteRangedTimestampRefineBy
|
|
1945
|
+
| Schemas.PublicAllHistoryRefineBy
|
|
1946
|
+
| Schemas.PublicTimePointOperation
|
|
1947
|
+
| Schemas.PublicRangedTimeOperation;
|
|
1948
|
+
/**
|
|
1949
|
+
* Indicates whether tracking is enabled for the page view.
|
|
1950
|
+
*/
|
|
1951
|
+
enableTracking?: boolean;
|
|
1952
|
+
/**
|
|
1953
|
+
* Indicates the type of filter being applied (PAGE_VIEW).
|
|
1954
|
+
*/
|
|
1955
|
+
filterType: 'PAGE_VIEW';
|
|
1956
|
+
/**
|
|
1957
|
+
* Defines the operation to be applied within the filter (HAS_PAGEVIEW_EQ, HAS_PAGEVIEW_CONTAINS, HAS_PAGEVIEW_MATCHES_REGEX, NOT_HAS_PAGEVIEW_EQ, NOT_HAS_PAGEVIEW_CONTAINS).
|
|
1958
|
+
*/
|
|
1959
|
+
operator: string;
|
|
1960
|
+
/**
|
|
1961
|
+
* The URL of the page to be used in the filter.
|
|
1962
|
+
*/
|
|
1963
|
+
pageUrl: string;
|
|
1964
|
+
/**
|
|
1965
|
+
* Specifies the criteria for refining the filter by pruning.
|
|
1966
|
+
*/
|
|
1967
|
+
pruningRefineBy?:
|
|
1968
|
+
| Schemas.PublicNumOccurrencesRefineBy
|
|
1969
|
+
| Schemas.PublicSetOccurrencesRefineBy
|
|
1970
|
+
| Schemas.PublicRelativeComparativeTimestampRefineBy
|
|
1971
|
+
| Schemas.PublicRelativeRangedTimestampRefineBy
|
|
1972
|
+
| Schemas.PublicAbsoluteComparativeTimestampRefineBy
|
|
1973
|
+
| Schemas.PublicAbsoluteRangedTimestampRefineBy
|
|
1974
|
+
| Schemas.PublicAllHistoryRefineBy
|
|
1975
|
+
| Schemas.PublicTimePointOperation
|
|
1976
|
+
| Schemas.PublicRangedTimeOperation;
|
|
1977
|
+
}
|
|
1978
|
+
|
|
1979
|
+
export interface PublicPrivacyAnalyticsFilter {
|
|
1980
|
+
/**
|
|
1981
|
+
* Specifies the type of filter (PRIVACY).
|
|
1982
|
+
*/
|
|
1983
|
+
filterType: 'PRIVACY';
|
|
1984
|
+
/**
|
|
1985
|
+
* Defines the operation to be applied within the filter (PRIVACY_CONSENT_GRANTED, PRIVACY_CONSENT_NOT_GRANTED).
|
|
1986
|
+
*/
|
|
1987
|
+
operator: string;
|
|
1988
|
+
/**
|
|
1989
|
+
* The name of the privacy setting used in the filter.
|
|
1990
|
+
*/
|
|
1991
|
+
privacyName: string;
|
|
1992
|
+
}
|
|
1993
|
+
|
|
1994
|
+
export interface PublicPropertyAssociationFilterBranch {
|
|
1995
|
+
filterBranches: (
|
|
1996
|
+
| Schemas.PublicOrFilterBranch
|
|
1997
|
+
| Schemas.PublicAndFilterBranch
|
|
1998
|
+
| Schemas.PublicNotAllFilterBranch
|
|
1999
|
+
| Schemas.PublicNotAnyFilterBranch
|
|
2000
|
+
| Schemas.PublicRestrictedFilterBranch
|
|
2001
|
+
| Schemas.PublicUnifiedEventsFilterBranch
|
|
2002
|
+
| Schemas.PublicPropertyAssociationFilterBranch
|
|
2003
|
+
| Schemas.PublicAssociationFilterBranch
|
|
2004
|
+
)[];
|
|
2005
|
+
/**
|
|
2006
|
+
* The logical operator used to combine filters within the branch.
|
|
2007
|
+
*/
|
|
2008
|
+
filterBranchOperator: string;
|
|
2009
|
+
/**
|
|
2010
|
+
* The type of the filter branch (PROPERTY_ASSOCIATION).
|
|
2011
|
+
*/
|
|
2012
|
+
filterBranchType: 'PROPERTY_ASSOCIATION';
|
|
2013
|
+
filters: (
|
|
2014
|
+
| Schemas.PublicPropertyFilter
|
|
2015
|
+
| Schemas.PublicAssociationInListFilter
|
|
2016
|
+
| Schemas.PublicPageViewAnalyticsFilter
|
|
2017
|
+
| Schemas.PublicCtaAnalyticsFilter
|
|
2018
|
+
| Schemas.PublicEventAnalyticsFilter
|
|
2019
|
+
| Schemas.PublicFormSubmissionFilter
|
|
2020
|
+
| Schemas.PublicFormSubmissionOnPageFilter
|
|
2021
|
+
| Schemas.PublicIntegrationEventFilter
|
|
2022
|
+
| Schemas.PublicEmailSubscriptionFilter
|
|
2023
|
+
| Schemas.PublicCommunicationSubscriptionFilter
|
|
2024
|
+
| Schemas.PublicCampaignInfluencedFilter
|
|
2025
|
+
| Schemas.PublicSurveyMonkeyFilter
|
|
2026
|
+
| Schemas.PublicSurveyMonkeyValueFilter
|
|
2027
|
+
| Schemas.PublicWebinarFilter
|
|
2028
|
+
| Schemas.PublicEmailEventFilter
|
|
2029
|
+
| Schemas.PublicPrivacyAnalyticsFilter
|
|
2030
|
+
| Schemas.PublicAdsSearchFilter
|
|
2031
|
+
| Schemas.PublicAdsTimeFilter
|
|
2032
|
+
| Schemas.PublicInListFilter
|
|
2033
|
+
| Schemas.PublicNumAssociationsFilter
|
|
2034
|
+
| Schemas.PublicUnifiedEventsFilter
|
|
2035
|
+
| Schemas.PublicPropertyAssociationInListFilter
|
|
2036
|
+
| Schemas.PublicConstantFilter
|
|
2037
|
+
)[];
|
|
2038
|
+
/**
|
|
2039
|
+
* The ID representing the type of object associated with the filter branch.
|
|
2040
|
+
*/
|
|
2041
|
+
objectTypeId: string;
|
|
2042
|
+
/**
|
|
2043
|
+
* Defines the operation to be applied within the filter branch (IN_LIST, NOT_IN_LIST).
|
|
2044
|
+
*/
|
|
2045
|
+
operator: string;
|
|
2046
|
+
/**
|
|
2047
|
+
* The property that is associated with the object ID in the filter branch.
|
|
2048
|
+
*/
|
|
2049
|
+
propertyWithObjectId: string;
|
|
2050
|
+
}
|
|
2051
|
+
|
|
2052
|
+
export interface PublicPropertyAssociationInListFilter {
|
|
2053
|
+
/**
|
|
2054
|
+
* Specifies the criteria for refining the filter by coalescing.
|
|
2055
|
+
*/
|
|
2056
|
+
coalescingRefineBy:
|
|
2057
|
+
| Schemas.PublicNumOccurrencesRefineBy
|
|
2058
|
+
| Schemas.PublicSetOccurrencesRefineBy
|
|
2059
|
+
| Schemas.PublicRelativeComparativeTimestampRefineBy
|
|
2060
|
+
| Schemas.PublicRelativeRangedTimestampRefineBy
|
|
2061
|
+
| Schemas.PublicAbsoluteComparativeTimestampRefineBy
|
|
2062
|
+
| Schemas.PublicAbsoluteRangedTimestampRefineBy
|
|
2063
|
+
| Schemas.PublicAllHistoryRefineBy
|
|
2064
|
+
| Schemas.PublicTimePointOperation
|
|
2065
|
+
| Schemas.PublicRangedTimeOperation;
|
|
2066
|
+
/**
|
|
2067
|
+
* Indicates the type of filter being applied (PROPERTY_ASSOCIATION).
|
|
2068
|
+
*/
|
|
2069
|
+
filterType: 'PROPERTY_ASSOCIATION';
|
|
2070
|
+
/**
|
|
2071
|
+
* The ID of the list used in the property association filter.
|
|
2072
|
+
*/
|
|
2073
|
+
listId: string;
|
|
2074
|
+
/**
|
|
2075
|
+
* Defines the operation to be applied by the filter (IN_LIST, NOT_IN_LIST).
|
|
2076
|
+
*/
|
|
2077
|
+
operator: string;
|
|
2078
|
+
/**
|
|
2079
|
+
* The property associated with the object ID in the filter.
|
|
2080
|
+
*/
|
|
2081
|
+
propertyWithObjectId: string;
|
|
2082
|
+
/**
|
|
2083
|
+
* The ID representing the type of object that the property association filter is targeting.
|
|
2084
|
+
*/
|
|
2085
|
+
toObjectTypeId?: string;
|
|
2086
|
+
}
|
|
2087
|
+
|
|
2088
|
+
export interface PublicPropertyFilter {
|
|
2089
|
+
/**
|
|
2090
|
+
* Indicates that the filter (PROPERTY).
|
|
2091
|
+
*/
|
|
2092
|
+
filterType: 'PROPERTY';
|
|
2093
|
+
/**
|
|
2094
|
+
* Defines the operation to be performed on the property, such as comparison or value matching.
|
|
2095
|
+
*/
|
|
2096
|
+
operation:
|
|
2097
|
+
| Schemas.PublicBoolPropertyOperation
|
|
2098
|
+
| Schemas.PublicNumberPropertyOperation
|
|
2099
|
+
| Schemas.PublicStringPropertyOperation
|
|
2100
|
+
| Schemas.PublicDateTimePropertyOperation
|
|
2101
|
+
| Schemas.PublicRangedDatePropertyOperation
|
|
2102
|
+
| Schemas.PublicComparativePropertyUpdatedOperation
|
|
2103
|
+
| Schemas.PublicComparativeDatePropertyOperation
|
|
2104
|
+
| Schemas.PublicRollingDateRangePropertyOperation
|
|
2105
|
+
| Schemas.PublicRollingPropertyUpdatedOperation
|
|
2106
|
+
| Schemas.PublicEnumerationPropertyOperation
|
|
2107
|
+
| Schemas.PublicAllPropertyTypesOperation
|
|
2108
|
+
| Schemas.PublicRangedNumberPropertyOperation
|
|
2109
|
+
| Schemas.PublicMultiStringPropertyOperation
|
|
2110
|
+
| Schemas.PublicDatePropertyOperation
|
|
2111
|
+
| Schemas.PublicCalendarDatePropertyOperation
|
|
2112
|
+
| Schemas.PublicTimePointOperation
|
|
2113
|
+
| Schemas.PublicRangedTimeOperation;
|
|
2114
|
+
/**
|
|
2115
|
+
* Specifies the name of the property that the filter is applied to.
|
|
2116
|
+
*/
|
|
2117
|
+
property: string;
|
|
2118
|
+
}
|
|
2119
|
+
|
|
2120
|
+
export interface PublicPropertyReferencedTime {
|
|
2121
|
+
/**
|
|
2122
|
+
* Specifies the name of the property that the time reference is applied to.
|
|
2123
|
+
*/
|
|
2124
|
+
property: string;
|
|
2125
|
+
/**
|
|
2126
|
+
* Specifies the type of reference for the property (VALUE, UPDATED_AT, ANNIVERSARY, VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION, ANNIVERSARY_WITH_ZONE_SAME_LOCAL_CONVERSION).
|
|
2127
|
+
*/
|
|
2128
|
+
referenceType: string;
|
|
2129
|
+
/**
|
|
2130
|
+
* Defines the type of time (PROPERTY_REFERENCED).
|
|
2131
|
+
*/
|
|
2132
|
+
timeType: 'PROPERTY_REFERENCED';
|
|
2133
|
+
/**
|
|
2134
|
+
* Specifies the source of the time zone information for the property (CUSTOM, USER, PORTAL).
|
|
2135
|
+
*/
|
|
2136
|
+
timezoneSource?: string;
|
|
2137
|
+
/**
|
|
2138
|
+
* Indicates the identifier for the time zone associated with the property.
|
|
2139
|
+
*/
|
|
2140
|
+
zoneId: string;
|
|
2141
|
+
}
|
|
2142
|
+
|
|
2143
|
+
export interface PublicQuarterReference {
|
|
2144
|
+
/**
|
|
2145
|
+
* The day component of the quarter reference.
|
|
2146
|
+
*/
|
|
2147
|
+
day: number;
|
|
2148
|
+
/**
|
|
2149
|
+
* The hour component of the quarter reference.
|
|
2150
|
+
*/
|
|
2151
|
+
hour?: number;
|
|
2152
|
+
/**
|
|
2153
|
+
* The millisecond component of the quarter reference.
|
|
2154
|
+
*/
|
|
2155
|
+
millisecond?: number;
|
|
2156
|
+
/**
|
|
2157
|
+
* The minute component of the quarter reference.
|
|
2158
|
+
*/
|
|
2159
|
+
minute?: number;
|
|
2160
|
+
/**
|
|
2161
|
+
* The month component of the quarter reference.
|
|
2162
|
+
*/
|
|
2163
|
+
month: number;
|
|
2164
|
+
/**
|
|
2165
|
+
* Indicates the type of reference (QUARTER).
|
|
2166
|
+
*/
|
|
2167
|
+
referenceType: 'QUARTER';
|
|
2168
|
+
/**
|
|
2169
|
+
* The second component of the quarter reference.
|
|
2170
|
+
*/
|
|
2171
|
+
second?: number;
|
|
2172
|
+
}
|
|
2173
|
+
|
|
2174
|
+
export interface PublicRangedDatePropertyOperation {
|
|
2175
|
+
/**
|
|
2176
|
+
* Specifies whether objects without a set value should be included in the operation.
|
|
2177
|
+
*/
|
|
2178
|
+
includeObjectsWithNoValueSet: boolean;
|
|
2179
|
+
/**
|
|
2180
|
+
* The lower limit of the date range for the operation.
|
|
2181
|
+
*/
|
|
2182
|
+
lowerBound: number;
|
|
2183
|
+
/**
|
|
2184
|
+
* Specifies the type of operation (RANGED_DATE).
|
|
2185
|
+
*/
|
|
2186
|
+
operationType: 'RANGED_DATE';
|
|
2187
|
+
/**
|
|
2188
|
+
* Defines the operation to be applied in the ranged date property operation (IS_BETWEEN, IS_NOT_BETWEEN).
|
|
2189
|
+
*/
|
|
2190
|
+
operator: string;
|
|
2191
|
+
/**
|
|
2192
|
+
* Indicates whether the operation requires conversion to a different time zone.
|
|
2193
|
+
*/
|
|
2194
|
+
requiresTimeZoneConversion: boolean;
|
|
2195
|
+
/**
|
|
2196
|
+
* The upper limit of the date range for the operation.
|
|
2197
|
+
*/
|
|
2198
|
+
upperBound: number;
|
|
2199
|
+
}
|
|
2200
|
+
|
|
2201
|
+
export interface PublicRangedNumberPropertyOperation {
|
|
2202
|
+
/**
|
|
2203
|
+
* Indicates whether objects with no value set for the property should be included in the operation.
|
|
2204
|
+
*/
|
|
2205
|
+
includeObjectsWithNoValueSet: boolean;
|
|
2206
|
+
/**
|
|
2207
|
+
* The lower limit of the number range for the operation.
|
|
2208
|
+
*/
|
|
2209
|
+
lowerBound: number;
|
|
2210
|
+
/**
|
|
2211
|
+
* Specifies the type of operation (NUMBER_RANGED).
|
|
2212
|
+
*/
|
|
2213
|
+
operationType: 'NUMBER_RANGED';
|
|
2214
|
+
/**
|
|
2215
|
+
* Defines the operation to be applied in the ranged number property operation (IS_BETWEEN, IS_NOT_BETWEEN).
|
|
2216
|
+
*/
|
|
2217
|
+
operator: string;
|
|
2218
|
+
/**
|
|
2219
|
+
* The upper limit of the number range for the operation.
|
|
2220
|
+
*/
|
|
2221
|
+
upperBound: number;
|
|
2222
|
+
}
|
|
2223
|
+
|
|
2224
|
+
export interface PublicRangedTimeOperation {
|
|
2225
|
+
/**
|
|
2226
|
+
* Indicates whether objects with no value set for the property should be included in the operation.
|
|
2227
|
+
*/
|
|
2228
|
+
includeObjectsWithNoValueSet: boolean;
|
|
2229
|
+
/**
|
|
2230
|
+
* Describes the behavior at the lower bound endpoint of the time range.
|
|
2231
|
+
*/
|
|
2232
|
+
lowerBoundEndpointBehavior?: string;
|
|
2233
|
+
/**
|
|
2234
|
+
* Defines the lower bound time point for the operation.
|
|
2235
|
+
*/
|
|
2236
|
+
lowerBoundTimePoint:
|
|
2237
|
+
| Schemas.PublicDatePoint
|
|
2238
|
+
| Schemas.PublicIndexedTimePoint
|
|
2239
|
+
| Schemas.PublicPropertyReferencedTime;
|
|
2240
|
+
/**
|
|
2241
|
+
* Specifies the type of operation (TIME_RANGED).
|
|
2242
|
+
*/
|
|
2243
|
+
operationType: string;
|
|
2244
|
+
/**
|
|
2245
|
+
* Defines the operation to be applied within the time range (IS_BETWEEN, IS_NOT_BETWEEN).
|
|
2246
|
+
*/
|
|
2247
|
+
operator: string;
|
|
2248
|
+
/**
|
|
2249
|
+
* Specifies the parser used for the property in the operation.
|
|
2250
|
+
*/
|
|
2251
|
+
propertyParser?: string;
|
|
2252
|
+
/**
|
|
2253
|
+
* Specifies the type of operation (TIME_RANGED).
|
|
2254
|
+
*/
|
|
2255
|
+
type: 'TIME_RANGED';
|
|
2256
|
+
/**
|
|
2257
|
+
* Describes the behavior at the upper bound endpoint of the time range.
|
|
2258
|
+
*/
|
|
2259
|
+
upperBoundEndpointBehavior?: string;
|
|
2260
|
+
/**
|
|
2261
|
+
* Defines the upper bound time point for the operation.
|
|
2262
|
+
*/
|
|
2263
|
+
upperBoundTimePoint:
|
|
2264
|
+
| Schemas.PublicDatePoint
|
|
2265
|
+
| Schemas.PublicIndexedTimePoint
|
|
2266
|
+
| Schemas.PublicPropertyReferencedTime;
|
|
2267
|
+
}
|
|
2268
|
+
|
|
2269
|
+
export interface PublicRelativeComparativeTimestampRefineBy {
|
|
2270
|
+
/**
|
|
2271
|
+
* Defines the comparison operation to be used in the refinement (BEFORE, AFTER).
|
|
2272
|
+
*/
|
|
2273
|
+
comparison: string;
|
|
2274
|
+
timeOffset: Schemas.PublicTimeOffset;
|
|
2275
|
+
/**
|
|
2276
|
+
* Specifies the type of refinement, (RELATIVE_COMPARATIVE).
|
|
2277
|
+
*/
|
|
2278
|
+
type: 'RELATIVE_COMPARATIVE';
|
|
2279
|
+
}
|
|
2280
|
+
|
|
2281
|
+
export interface PublicRelativeRangedTimestampRefineBy {
|
|
2282
|
+
lowerBoundOffset: Schemas.PublicTimeOffset;
|
|
2283
|
+
/**
|
|
2284
|
+
* Specifies the type of range for the refinement criteria (BETWEEN, NOT_BETWEEN).
|
|
2285
|
+
*/
|
|
2286
|
+
rangeType: string;
|
|
2287
|
+
/**
|
|
2288
|
+
* Indicates the type of refinement (RELATIVE_RANGED).
|
|
2289
|
+
*/
|
|
2290
|
+
type: 'RELATIVE_RANGED';
|
|
2291
|
+
upperBoundOffset: Schemas.PublicTimeOffset;
|
|
2292
|
+
}
|
|
2293
|
+
|
|
2294
|
+
export interface PublicRestrictedFilterBranch {
|
|
2295
|
+
filterBranches: (
|
|
2296
|
+
| Schemas.PublicOrFilterBranch
|
|
2297
|
+
| Schemas.PublicAndFilterBranch
|
|
2298
|
+
| Schemas.PublicNotAllFilterBranch
|
|
2299
|
+
| Schemas.PublicNotAnyFilterBranch
|
|
2300
|
+
| Schemas.PublicRestrictedFilterBranch
|
|
2301
|
+
| Schemas.PublicUnifiedEventsFilterBranch
|
|
2302
|
+
| Schemas.PublicPropertyAssociationFilterBranch
|
|
2303
|
+
| Schemas.PublicAssociationFilterBranch
|
|
2304
|
+
)[];
|
|
2305
|
+
/**
|
|
2306
|
+
* The logical operator used to combine filters within the restricted filter branch.
|
|
2307
|
+
*/
|
|
2308
|
+
filterBranchOperator: string;
|
|
2309
|
+
/**
|
|
2310
|
+
* Specifies the type of the filter branch (RESTRICTED).
|
|
2311
|
+
*/
|
|
2312
|
+
filterBranchType: 'RESTRICTED';
|
|
2313
|
+
filters: (
|
|
2314
|
+
| Schemas.PublicPropertyFilter
|
|
2315
|
+
| Schemas.PublicAssociationInListFilter
|
|
2316
|
+
| Schemas.PublicPageViewAnalyticsFilter
|
|
2317
|
+
| Schemas.PublicCtaAnalyticsFilter
|
|
2318
|
+
| Schemas.PublicEventAnalyticsFilter
|
|
2319
|
+
| Schemas.PublicFormSubmissionFilter
|
|
2320
|
+
| Schemas.PublicFormSubmissionOnPageFilter
|
|
2321
|
+
| Schemas.PublicIntegrationEventFilter
|
|
2322
|
+
| Schemas.PublicEmailSubscriptionFilter
|
|
2323
|
+
| Schemas.PublicCommunicationSubscriptionFilter
|
|
2324
|
+
| Schemas.PublicCampaignInfluencedFilter
|
|
2325
|
+
| Schemas.PublicSurveyMonkeyFilter
|
|
2326
|
+
| Schemas.PublicSurveyMonkeyValueFilter
|
|
2327
|
+
| Schemas.PublicWebinarFilter
|
|
2328
|
+
| Schemas.PublicEmailEventFilter
|
|
2329
|
+
| Schemas.PublicPrivacyAnalyticsFilter
|
|
2330
|
+
| Schemas.PublicAdsSearchFilter
|
|
2331
|
+
| Schemas.PublicAdsTimeFilter
|
|
2332
|
+
| Schemas.PublicInListFilter
|
|
2333
|
+
| Schemas.PublicNumAssociationsFilter
|
|
2334
|
+
| Schemas.PublicUnifiedEventsFilter
|
|
2335
|
+
| Schemas.PublicPropertyAssociationInListFilter
|
|
2336
|
+
| Schemas.PublicConstantFilter
|
|
2337
|
+
)[];
|
|
2338
|
+
}
|
|
2339
|
+
|
|
2340
|
+
export interface PublicRollingDateRangePropertyOperation {
|
|
2341
|
+
/**
|
|
2342
|
+
* Indicates whether objects with no value set for the property should be included in the operation.
|
|
2343
|
+
*/
|
|
2344
|
+
includeObjectsWithNoValueSet: boolean;
|
|
2345
|
+
/**
|
|
2346
|
+
* The number of days to be considered in the rolling date range operation.
|
|
2347
|
+
*/
|
|
2348
|
+
numberOfDays: number;
|
|
2349
|
+
/**
|
|
2350
|
+
* Specifies the type of operation (ROLLING_DATE_RANGE).
|
|
2351
|
+
*/
|
|
2352
|
+
operationType: 'ROLLING_DATE_RANGE';
|
|
2353
|
+
/**
|
|
2354
|
+
* Defines the operation to be applied within the rolling date range property operation (IS_LESS_THAN_X_DAYS_AGO, IS_MORE_THAN_X_DAYS_AGO, IS_LESS_THAN_X_DAYS_FROM_NOW, IS_MORE_THAN_X_DAYS_FROM_NOW).
|
|
2355
|
+
*/
|
|
2356
|
+
operator: string;
|
|
2357
|
+
/**
|
|
2358
|
+
* Specifies whether the operation requires conversion to a different time zone.
|
|
2359
|
+
*/
|
|
2360
|
+
requiresTimeZoneConversion: boolean;
|
|
2361
|
+
}
|
|
2362
|
+
|
|
2363
|
+
export interface PublicRollingPropertyUpdatedOperation {
|
|
2364
|
+
/**
|
|
2365
|
+
* Indicates whether objects with no value set for the property should be included in the operation.
|
|
2366
|
+
*/
|
|
2367
|
+
includeObjectsWithNoValueSet: boolean;
|
|
2368
|
+
/**
|
|
2369
|
+
* The number of days to be considered in the rolling property updated operation.
|
|
2370
|
+
*/
|
|
2371
|
+
numberOfDays: number;
|
|
2372
|
+
/**
|
|
2373
|
+
* Specifies the type of operation (ROLLING_PROPERTY_UPDATED).
|
|
2374
|
+
*/
|
|
2375
|
+
operationType: 'ROLLING_PROPERTY_UPDATED';
|
|
2376
|
+
/**
|
|
2377
|
+
* Defines the operation to be applied within the rolling property updated operation (UPDATED_IN_LAST_X_DAYS, NOT_UPDATED_IN_LAST_X_DAYS).
|
|
2378
|
+
*/
|
|
2379
|
+
operator: string;
|
|
2380
|
+
}
|
|
2381
|
+
|
|
2382
|
+
export interface PublicSetOccurrencesRefineBy {
|
|
2383
|
+
/**
|
|
2384
|
+
* Indicates the specific set type used in the refinement (ALL, ALL_INCLUDE_EMPTY, ANY, NONE, NONE_EXCLUDE_EMPTY, ANY_INCLUDE_EMPTY).
|
|
2385
|
+
*/
|
|
2386
|
+
setType: string;
|
|
2387
|
+
/**
|
|
2388
|
+
* Specifies the type of refinement (SET_OCCURRENCES).
|
|
2389
|
+
*/
|
|
2390
|
+
type: 'SET_OCCURRENCES';
|
|
2391
|
+
}
|
|
2392
|
+
|
|
2393
|
+
export interface PublicStringPropertyOperation {
|
|
2394
|
+
/**
|
|
2395
|
+
* Indicates whether objects with no value set for the property should be included in the operation.
|
|
2396
|
+
*/
|
|
2397
|
+
includeObjectsWithNoValueSet: boolean;
|
|
2398
|
+
/**
|
|
2399
|
+
* Specifies the type of operation (STRING).
|
|
2400
|
+
*/
|
|
2401
|
+
operationType: 'STRING';
|
|
2402
|
+
/**
|
|
2403
|
+
* Defines the operation to be applied in the string property operation ()IS_EQUAL_TO, IS_NOT_EQUAL_TO, CONTAINS, DOES_NOT_CONTAIN, STARTS_WITH, ENDS_WITH, HAS_EVER_BEEN_EQUAL_TO, HAS_NEVER_BEEN_EQUAL_TO, HAS_EVER_CONTAINED, HAS_NEVER_CONTAINED).
|
|
2404
|
+
*/
|
|
2405
|
+
operator: string;
|
|
2406
|
+
/**
|
|
2407
|
+
* The string value to be used in the operation.
|
|
2408
|
+
*/
|
|
2409
|
+
value: string;
|
|
2410
|
+
}
|
|
2411
|
+
|
|
2412
|
+
export interface PublicSurveyMonkeyFilter {
|
|
2413
|
+
/**
|
|
2414
|
+
* Indicates the type of filter being applied (SURVEY_MONKEY).
|
|
2415
|
+
*/
|
|
2416
|
+
filterType: 'SURVEY_MONKEY';
|
|
2417
|
+
/**
|
|
2418
|
+
* Specifies the operation to be performed by the filter (HAS_RESPONDED_TO_SURVEY, HAS_NOT_RESPONDED_TO_SURVEY).
|
|
2419
|
+
*/
|
|
2420
|
+
operator: string;
|
|
2421
|
+
/**
|
|
2422
|
+
* The ID of the survey associated with the filter.
|
|
2423
|
+
*/
|
|
2424
|
+
surveyId: string;
|
|
2425
|
+
}
|
|
2426
|
+
|
|
2427
|
+
export interface PublicSurveyMonkeyValueFilter {
|
|
2428
|
+
/**
|
|
2429
|
+
* Defines the type of filter (SURVEY_MONKEY_VALUE).
|
|
2430
|
+
*/
|
|
2431
|
+
filterType: 'SURVEY_MONKEY_VALUE';
|
|
2432
|
+
/**
|
|
2433
|
+
* Defines the operation to be applied within the filter (HAS_ANSWERED_SURVEY_QUESTION_WITH_VALUE).
|
|
2434
|
+
*/
|
|
2435
|
+
operator: string;
|
|
2436
|
+
/**
|
|
2437
|
+
* The column ID of the survey answer used in the filter.
|
|
2438
|
+
*/
|
|
2439
|
+
surveyAnswerColId?: string;
|
|
2440
|
+
/**
|
|
2441
|
+
* The row ID of the survey answer used in the filter.
|
|
2442
|
+
*/
|
|
2443
|
+
surveyAnswerRowId?: string;
|
|
2444
|
+
/**
|
|
2445
|
+
* The ID of the survey used in the filter.
|
|
2446
|
+
*/
|
|
2447
|
+
surveyId: string;
|
|
2448
|
+
/**
|
|
2449
|
+
* The question from the survey used in the filter.
|
|
2450
|
+
*/
|
|
2451
|
+
surveyQuestion: string;
|
|
2452
|
+
/**
|
|
2453
|
+
* Specifies the operation used to compare the survey answer value.
|
|
2454
|
+
*/
|
|
2455
|
+
valueComparison:
|
|
2456
|
+
| Schemas.PublicBoolPropertyOperation
|
|
2457
|
+
| Schemas.PublicNumberPropertyOperation
|
|
2458
|
+
| Schemas.PublicStringPropertyOperation
|
|
2459
|
+
| Schemas.PublicDateTimePropertyOperation
|
|
2460
|
+
| Schemas.PublicRangedDatePropertyOperation
|
|
2461
|
+
| Schemas.PublicComparativePropertyUpdatedOperation
|
|
2462
|
+
| Schemas.PublicComparativeDatePropertyOperation
|
|
2463
|
+
| Schemas.PublicRollingDateRangePropertyOperation
|
|
2464
|
+
| Schemas.PublicRollingPropertyUpdatedOperation
|
|
2465
|
+
| Schemas.PublicEnumerationPropertyOperation
|
|
2466
|
+
| Schemas.PublicAllPropertyTypesOperation
|
|
2467
|
+
| Schemas.PublicRangedNumberPropertyOperation
|
|
2468
|
+
| Schemas.PublicMultiStringPropertyOperation
|
|
2469
|
+
| Schemas.PublicDatePropertyOperation
|
|
2470
|
+
| Schemas.PublicCalendarDatePropertyOperation
|
|
2471
|
+
| Schemas.PublicTimePointOperation
|
|
2472
|
+
| Schemas.PublicRangedTimeOperation;
|
|
2473
|
+
}
|
|
2474
|
+
|
|
2475
|
+
export interface PublicTimeOffset {
|
|
2476
|
+
/**
|
|
2477
|
+
* The numerical value representing the quantity of the time offset.
|
|
2478
|
+
*/
|
|
2479
|
+
amount: number;
|
|
2480
|
+
/**
|
|
2481
|
+
* Indicates the direction of the time offset, such as forward or backward.
|
|
2482
|
+
*/
|
|
2483
|
+
offsetDirection: string;
|
|
2484
|
+
/**
|
|
2485
|
+
* Specifies the unit of time for the offset, such as days, hours, or minutes.
|
|
2486
|
+
*/
|
|
2487
|
+
timeUnit: string;
|
|
2488
|
+
}
|
|
2489
|
+
|
|
2490
|
+
export interface PublicTimePointOperation {
|
|
2491
|
+
/**
|
|
2492
|
+
* Describes the behavior at the endpoint of the time point operation.
|
|
2493
|
+
*/
|
|
2494
|
+
endpointBehavior?: string;
|
|
2495
|
+
/**
|
|
2496
|
+
* Indicates whether objects with no value set for the property should be included in the operation.
|
|
2497
|
+
*/
|
|
2498
|
+
includeObjectsWithNoValueSet: boolean;
|
|
2499
|
+
/**
|
|
2500
|
+
* Specifies the type of operation (TIME_POINT).
|
|
2501
|
+
*/
|
|
2502
|
+
operationType: 'TIME_POINT';
|
|
2503
|
+
/**
|
|
2504
|
+
* Specifies the operation to be applied within the time point operation (IS_BEFORE, IS_AFTER).
|
|
2505
|
+
*/
|
|
2506
|
+
operator: string;
|
|
2507
|
+
/**
|
|
2508
|
+
* Specifies the parser used for interpreting the property in the operation.
|
|
2509
|
+
*/
|
|
2510
|
+
propertyParser?: string;
|
|
2511
|
+
/**
|
|
2512
|
+
* Defines the specific point in time for the operation, which can be a date, indexed time, or property-referenced time.
|
|
2513
|
+
*/
|
|
2514
|
+
timePoint:
|
|
2515
|
+
| Schemas.PublicDatePoint
|
|
2516
|
+
| Schemas.PublicIndexedTimePoint
|
|
2517
|
+
| Schemas.PublicPropertyReferencedTime;
|
|
2518
|
+
/**
|
|
2519
|
+
* Defines the type of operation being performed.
|
|
2520
|
+
*/
|
|
2521
|
+
type: string;
|
|
2522
|
+
}
|
|
2523
|
+
|
|
2524
|
+
export interface PublicTodayReference {
|
|
2525
|
+
/**
|
|
2526
|
+
* The hour component of the current day reference.
|
|
2527
|
+
*/
|
|
2528
|
+
hour?: number;
|
|
2529
|
+
/**
|
|
2530
|
+
* The millisecond component of the current day reference.
|
|
2531
|
+
*/
|
|
2532
|
+
millisecond?: number;
|
|
2533
|
+
/**
|
|
2534
|
+
* The minute component of the current day reference.
|
|
2535
|
+
*/
|
|
2536
|
+
minute?: number;
|
|
2537
|
+
/**
|
|
2538
|
+
* Indicates the type of reference (TODAY).
|
|
2539
|
+
*/
|
|
2540
|
+
referenceType: 'TODAY';
|
|
2541
|
+
/**
|
|
2542
|
+
* The second component of the current day reference.
|
|
2543
|
+
*/
|
|
2544
|
+
second?: number;
|
|
2545
|
+
}
|
|
2546
|
+
|
|
2547
|
+
export interface PublicUnifiedEventsFilter {
|
|
2548
|
+
/**
|
|
2549
|
+
* Specifies the criteria for refining the filter by coalescing.
|
|
2550
|
+
*/
|
|
2551
|
+
coalescingRefineBy?:
|
|
2552
|
+
| Schemas.PublicNumOccurrencesRefineBy
|
|
2553
|
+
| Schemas.PublicSetOccurrencesRefineBy
|
|
2554
|
+
| Schemas.PublicRelativeComparativeTimestampRefineBy
|
|
2555
|
+
| Schemas.PublicRelativeRangedTimestampRefineBy
|
|
2556
|
+
| Schemas.PublicAbsoluteComparativeTimestampRefineBy
|
|
2557
|
+
| Schemas.PublicAbsoluteRangedTimestampRefineBy
|
|
2558
|
+
| Schemas.PublicAllHistoryRefineBy
|
|
2559
|
+
| Schemas.PublicTimePointOperation
|
|
2560
|
+
| Schemas.PublicRangedTimeOperation;
|
|
2561
|
+
/**
|
|
2562
|
+
* The identifier for the type of event in the unified events filter.
|
|
2563
|
+
*/
|
|
2564
|
+
eventTypeId?: string;
|
|
2565
|
+
filterLines: Schemas.PublicEventFilterMetadata[];
|
|
2566
|
+
/**
|
|
2567
|
+
* Indicates the type of filter being applied (UNIFIED_EVENTS).
|
|
2568
|
+
*/
|
|
2569
|
+
filterType: 'UNIFIED_EVENTS';
|
|
2570
|
+
/**
|
|
2571
|
+
* Specifies the criteria for refining the filter by pruning.
|
|
2572
|
+
*/
|
|
2573
|
+
pruningRefineBy?:
|
|
2574
|
+
| Schemas.PublicNumOccurrencesRefineBy
|
|
2575
|
+
| Schemas.PublicSetOccurrencesRefineBy
|
|
2576
|
+
| Schemas.PublicRelativeComparativeTimestampRefineBy
|
|
2577
|
+
| Schemas.PublicRelativeRangedTimestampRefineBy
|
|
2578
|
+
| Schemas.PublicAbsoluteComparativeTimestampRefineBy
|
|
2579
|
+
| Schemas.PublicAbsoluteRangedTimestampRefineBy
|
|
2580
|
+
| Schemas.PublicAllHistoryRefineBy
|
|
2581
|
+
| Schemas.PublicTimePointOperation
|
|
2582
|
+
| Schemas.PublicRangedTimeOperation;
|
|
2583
|
+
}
|
|
2584
|
+
|
|
2585
|
+
export interface PublicUnifiedEventsFilterBranch {
|
|
2586
|
+
/**
|
|
2587
|
+
* Specifies the criteria for refining the filter by coalescing.
|
|
2588
|
+
*/
|
|
2589
|
+
coalescingRefineBy?:
|
|
2590
|
+
| Schemas.PublicNumOccurrencesRefineBy
|
|
2591
|
+
| Schemas.PublicSetOccurrencesRefineBy
|
|
2592
|
+
| Schemas.PublicRelativeComparativeTimestampRefineBy
|
|
2593
|
+
| Schemas.PublicRelativeRangedTimestampRefineBy
|
|
2594
|
+
| Schemas.PublicAbsoluteComparativeTimestampRefineBy
|
|
2595
|
+
| Schemas.PublicAbsoluteRangedTimestampRefineBy
|
|
2596
|
+
| Schemas.PublicAllHistoryRefineBy
|
|
2597
|
+
| Schemas.PublicTimePointOperation
|
|
2598
|
+
| Schemas.PublicRangedTimeOperation;
|
|
2599
|
+
/**
|
|
2600
|
+
* The identifier for the type of event associated with the filter branch.
|
|
2601
|
+
*/
|
|
2602
|
+
eventTypeId: string;
|
|
2603
|
+
filterBranches: (
|
|
2604
|
+
| Schemas.PublicOrFilterBranch
|
|
2605
|
+
| Schemas.PublicAndFilterBranch
|
|
2606
|
+
| Schemas.PublicNotAllFilterBranch
|
|
2607
|
+
| Schemas.PublicNotAnyFilterBranch
|
|
2608
|
+
| Schemas.PublicRestrictedFilterBranch
|
|
2609
|
+
| Schemas.PublicUnifiedEventsFilterBranch
|
|
2610
|
+
| Schemas.PublicPropertyAssociationFilterBranch
|
|
2611
|
+
| Schemas.PublicAssociationFilterBranch
|
|
2612
|
+
)[];
|
|
2613
|
+
/**
|
|
2614
|
+
* The logical operator used to combine filters within the branch (AND).
|
|
2615
|
+
*/
|
|
2616
|
+
filterBranchOperator: string;
|
|
2617
|
+
/**
|
|
2618
|
+
* The type of the filter branch (UNIFIED_EVENTS).
|
|
2619
|
+
*/
|
|
2620
|
+
filterBranchType: 'UNIFIED_EVENTS';
|
|
2621
|
+
filters: (
|
|
2622
|
+
| Schemas.PublicPropertyFilter
|
|
2623
|
+
| Schemas.PublicAssociationInListFilter
|
|
2624
|
+
| Schemas.PublicPageViewAnalyticsFilter
|
|
2625
|
+
| Schemas.PublicCtaAnalyticsFilter
|
|
2626
|
+
| Schemas.PublicEventAnalyticsFilter
|
|
2627
|
+
| Schemas.PublicFormSubmissionFilter
|
|
2628
|
+
| Schemas.PublicFormSubmissionOnPageFilter
|
|
2629
|
+
| Schemas.PublicIntegrationEventFilter
|
|
2630
|
+
| Schemas.PublicEmailSubscriptionFilter
|
|
2631
|
+
| Schemas.PublicCommunicationSubscriptionFilter
|
|
2632
|
+
| Schemas.PublicCampaignInfluencedFilter
|
|
2633
|
+
| Schemas.PublicSurveyMonkeyFilter
|
|
2634
|
+
| Schemas.PublicSurveyMonkeyValueFilter
|
|
2635
|
+
| Schemas.PublicWebinarFilter
|
|
2636
|
+
| Schemas.PublicEmailEventFilter
|
|
2637
|
+
| Schemas.PublicPrivacyAnalyticsFilter
|
|
2638
|
+
| Schemas.PublicAdsSearchFilter
|
|
2639
|
+
| Schemas.PublicAdsTimeFilter
|
|
2640
|
+
| Schemas.PublicInListFilter
|
|
2641
|
+
| Schemas.PublicNumAssociationsFilter
|
|
2642
|
+
| Schemas.PublicUnifiedEventsFilter
|
|
2643
|
+
| Schemas.PublicPropertyAssociationInListFilter
|
|
2644
|
+
| Schemas.PublicConstantFilter
|
|
2645
|
+
)[];
|
|
2646
|
+
/**
|
|
2647
|
+
* Defines the operation to be applied within the filter branch (HAS_COMPLETED, HAS_NOT_COMPLETED).
|
|
2648
|
+
*/
|
|
2649
|
+
operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED';
|
|
2650
|
+
pruningRefineBy?:
|
|
2651
|
+
| Schemas.PublicNumOccurrencesRefineBy
|
|
2652
|
+
| Schemas.PublicSetOccurrencesRefineBy
|
|
2653
|
+
| Schemas.PublicRelativeComparativeTimestampRefineBy
|
|
2654
|
+
| Schemas.PublicRelativeRangedTimestampRefineBy
|
|
2655
|
+
| Schemas.PublicAbsoluteComparativeTimestampRefineBy
|
|
2656
|
+
| Schemas.PublicAbsoluteRangedTimestampRefineBy
|
|
2657
|
+
| Schemas.PublicAllHistoryRefineBy
|
|
2658
|
+
| Schemas.PublicTimePointOperation
|
|
2659
|
+
| Schemas.PublicRangedTimeOperation;
|
|
2660
|
+
}
|
|
2661
|
+
|
|
2662
|
+
export interface PublicWebinarFilter {
|
|
2663
|
+
/**
|
|
2664
|
+
* Indicates the type of filter, (WEBINAR).
|
|
2665
|
+
*/
|
|
2666
|
+
filterType: 'WEBINAR';
|
|
2667
|
+
/**
|
|
2668
|
+
* Specifies the operation to be performed by the filter (HAS_WEBINAR_REGISTRATION, NOT_HAS_WEBINAR_REGISTRATION, HAS_WEBINAR_ATTENDANCE, NOT_HAS_WEBINAR_ATTENDANCE).
|
|
2669
|
+
*/
|
|
2670
|
+
operator: string;
|
|
2671
|
+
/**
|
|
2672
|
+
* The ID of the webinar associated with the filter.
|
|
2673
|
+
*/
|
|
2674
|
+
webinarId?: string;
|
|
2675
|
+
}
|
|
2676
|
+
|
|
2677
|
+
export interface PublicWeekReference {
|
|
2678
|
+
/**
|
|
2679
|
+
* The day of the week (SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY).
|
|
2680
|
+
*/
|
|
2681
|
+
dayOfWeek:
|
|
2682
|
+
| 'FRIDAY'
|
|
2683
|
+
| 'MONDAY'
|
|
2684
|
+
| 'SATURDAY'
|
|
2685
|
+
| 'SUNDAY'
|
|
2686
|
+
| 'THURSDAY'
|
|
2687
|
+
| 'TUESDAY'
|
|
2688
|
+
| 'WEDNESDAY';
|
|
2689
|
+
/**
|
|
2690
|
+
* The hour component of the week reference.
|
|
2691
|
+
*/
|
|
2692
|
+
hour?: number;
|
|
2693
|
+
/**
|
|
2694
|
+
* The millisecond component of the week reference.
|
|
2695
|
+
*/
|
|
2696
|
+
millisecond?: number;
|
|
2697
|
+
/**
|
|
2698
|
+
* The minute component of the week reference.
|
|
2699
|
+
*/
|
|
2700
|
+
minute?: number;
|
|
2701
|
+
/**
|
|
2702
|
+
* Indicates the type of reference (WEEK).
|
|
2703
|
+
*/
|
|
2704
|
+
referenceType: 'WEEK';
|
|
2705
|
+
/**
|
|
2706
|
+
* The second component of the week reference.
|
|
2707
|
+
*/
|
|
2708
|
+
second?: number;
|
|
2709
|
+
}
|
|
2710
|
+
|
|
2711
|
+
export interface PublicYearReference {
|
|
2712
|
+
/**
|
|
2713
|
+
* The day component of the year reference.
|
|
2714
|
+
*/
|
|
2715
|
+
day: number;
|
|
2716
|
+
/**
|
|
2717
|
+
* The hour component of the year reference.
|
|
2718
|
+
*/
|
|
2719
|
+
hour?: number;
|
|
2720
|
+
/**
|
|
2721
|
+
* The millisecond component of the year reference.
|
|
2722
|
+
*/
|
|
2723
|
+
millisecond?: number;
|
|
2724
|
+
/**
|
|
2725
|
+
* The minute component of the year reference.
|
|
2726
|
+
*/
|
|
2727
|
+
minute?: number;
|
|
2728
|
+
/**
|
|
2729
|
+
* The month component of the year reference.
|
|
2730
|
+
*/
|
|
2731
|
+
month: number;
|
|
2732
|
+
/**
|
|
2733
|
+
* Indicates the type of reference (YEAR).
|
|
2734
|
+
*/
|
|
2735
|
+
referenceType: 'YEAR';
|
|
2736
|
+
/**
|
|
2737
|
+
* The second component of the year reference.
|
|
2738
|
+
*/
|
|
2739
|
+
second?: number;
|
|
2740
|
+
}
|
|
2741
|
+
|
|
2742
|
+
export interface RecordIdInput {
|
|
2743
|
+
objectTypeId: string;
|
|
2744
|
+
recordId: string;
|
|
2745
|
+
}
|
|
2746
|
+
|
|
2747
|
+
export interface RecordIdWithMemberships {
|
|
2748
|
+
objectTypeId: string;
|
|
2749
|
+
recordId: string;
|
|
2750
|
+
recordListMemberships: Schemas.RecordListMembership[];
|
|
2751
|
+
}
|
|
2752
|
+
|
|
2753
|
+
export interface RecordListMembership {
|
|
2754
|
+
/**
|
|
2755
|
+
* The timestamp when the record was first added to the list.
|
|
2756
|
+
*/
|
|
2757
|
+
firstAddedTimestamp: string;
|
|
2758
|
+
/**
|
|
2759
|
+
* Indicates whether the list is public.
|
|
2760
|
+
*/
|
|
2761
|
+
isPublicList?: boolean;
|
|
2762
|
+
/**
|
|
2763
|
+
* The timestamp when the record was last added to the list.
|
|
2764
|
+
*/
|
|
2765
|
+
lastAddedTimestamp: string;
|
|
2766
|
+
/**
|
|
2767
|
+
* The unique identifier of the list.
|
|
2768
|
+
*/
|
|
2769
|
+
listId: string;
|
|
2770
|
+
/**
|
|
2771
|
+
* The version number of the list.
|
|
2772
|
+
*/
|
|
2773
|
+
listVersion: number;
|
|
2774
|
+
}
|
|
2775
|
+
}
|
|
2776
|
+
|
|
2777
|
+
export namespace Search {
|
|
2778
|
+
export type ListBySearchInput = Schemas.ListSearchRequest;
|
|
2779
|
+
|
|
2780
|
+
export type ListBySearchOutput = Schemas.ListSearchResponse;
|
|
2781
|
+
}
|
|
2782
|
+
|
|
2783
|
+
/**
|
|
2784
|
+
* Usage example:
|
|
2785
|
+
* ```ts
|
|
2786
|
+
* import { crmLists } from '@hubspot/api-client-core';
|
|
2787
|
+
* client.send(crmLists.basic.addAndRemoveMemberships(input));
|
|
2788
|
+
* ```
|
|
2789
|
+
*/
|
|
2790
|
+
export interface BasicAPI {
|
|
2791
|
+
/**
|
|
2792
|
+
* @apiPath /crm/lists/2026-03/{listId}/memberships/add-and-remove
|
|
2793
|
+
* @apiMethod PUT
|
|
2794
|
+
* @requiredScopes ils-lists-read, ils-lists-write
|
|
2795
|
+
*/
|
|
2796
|
+
addAndRemoveMemberships: (
|
|
2797
|
+
input: Basic.AddAndRemoveMembershipsInput
|
|
2798
|
+
) => Operation<Basic.AddAndRemoveMembershipsOutput>;
|
|
2799
|
+
/**
|
|
2800
|
+
* @apiPath /crm/lists/2026-03/{listId}/memberships/add
|
|
2801
|
+
* @apiMethod PUT
|
|
2802
|
+
* @requiredScopes ils-lists-read, ils-lists-write
|
|
2803
|
+
*/
|
|
2804
|
+
addMemberships: (
|
|
2805
|
+
input: Basic.AddMembershipsInput
|
|
2806
|
+
) => Operation<Basic.AddMembershipsOutput>;
|
|
2807
|
+
/**
|
|
2808
|
+
* @apiPath /crm/lists/2026-03/{listId}/memberships/add-from/{sourceListId}
|
|
2809
|
+
* @apiMethod PUT
|
|
2810
|
+
* @requiredScopes ils-lists-read, ils-lists-write
|
|
2811
|
+
*/
|
|
2812
|
+
addMembershipsFrom: (
|
|
2813
|
+
input: Basic.AddMembershipsFromInput
|
|
2814
|
+
) => Operation<Basic.AddMembershipsFromOutput>;
|
|
2815
|
+
/**
|
|
2816
|
+
* @apiPath /crm/lists/2026-03
|
|
2817
|
+
* @apiMethod POST
|
|
2818
|
+
* @requiredScopes ils-lists-write
|
|
2819
|
+
*/
|
|
2820
|
+
create: (input: Basic.CreateInput) => Operation<Basic.CreateOutput>;
|
|
2821
|
+
/**
|
|
2822
|
+
* @apiPath /crm/lists/2026-03/folders
|
|
2823
|
+
* @apiMethod POST
|
|
2824
|
+
* @requiredScopes ils-lists-read, ils-lists-write
|
|
2825
|
+
*/
|
|
2826
|
+
createFolder: (
|
|
2827
|
+
input: Basic.CreateFolderInput
|
|
2828
|
+
) => Operation<Basic.CreateFolderOutput>;
|
|
2829
|
+
/**
|
|
2830
|
+
* @apiPath /crm/lists/2026-03/idmapping
|
|
2831
|
+
* @apiMethod POST
|
|
2832
|
+
* @requiredScopes ils-lists-read
|
|
2833
|
+
*/
|
|
2834
|
+
createIdMapping: (
|
|
2835
|
+
input: Basic.CreateIdMappingInput
|
|
2836
|
+
) => Operation<Basic.CreateIdMappingOutput>;
|
|
2837
|
+
/**
|
|
2838
|
+
* @apiPath /crm/lists/2026-03/{listId}
|
|
2839
|
+
* @apiMethod DELETE
|
|
2840
|
+
* @requiredScopes ils-lists-read, ils-lists-write
|
|
2841
|
+
*/
|
|
2842
|
+
delete: (input: Basic.DeleteInput) => Operation<Basic.DeleteOutput>;
|
|
2843
|
+
/**
|
|
2844
|
+
* @apiPath /crm/lists/2026-03/folders/{folderId}
|
|
2845
|
+
* @apiMethod DELETE
|
|
2846
|
+
* @requiredScopes ils-lists-read, ils-lists-write
|
|
2847
|
+
*/
|
|
2848
|
+
deleteFolder: (
|
|
2849
|
+
input: Basic.DeleteFolderInput
|
|
2850
|
+
) => Operation<Basic.DeleteFolderOutput>;
|
|
2851
|
+
/**
|
|
2852
|
+
* @apiPath /crm/lists/2026-03/{listId}/memberships
|
|
2853
|
+
* @apiMethod DELETE
|
|
2854
|
+
* @requiredScopes ils-lists-read, ils-lists-write
|
|
2855
|
+
*/
|
|
2856
|
+
deleteMemberships: (
|
|
2857
|
+
input: Basic.DeleteMembershipsInput
|
|
2858
|
+
) => Operation<Basic.DeleteMembershipsOutput>;
|
|
2859
|
+
/**
|
|
2860
|
+
* @apiPath /crm/lists/2026-03/{listId}
|
|
2861
|
+
* @apiMethod GET
|
|
2862
|
+
* @requiredScopes ils-lists-read
|
|
2863
|
+
*/
|
|
2864
|
+
get: (input: Basic.GetInput) => Operation<Basic.GetOutput>;
|
|
2865
|
+
/**
|
|
2866
|
+
* @apiPath /crm/lists/2026-03/object-type-id/{objectTypeId}/name/{listName}
|
|
2867
|
+
* @apiMethod GET
|
|
2868
|
+
* @requiredScopes ils-lists-read
|
|
2869
|
+
*/
|
|
2870
|
+
getByObjectTypeAndName: (
|
|
2871
|
+
input: Basic.GetByObjectTypeAndNameInput
|
|
2872
|
+
) => Operation<Basic.GetByObjectTypeAndNameOutput>;
|
|
2873
|
+
/**
|
|
2874
|
+
* @apiPath /crm/lists/2026-03/idmapping
|
|
2875
|
+
* @apiMethod GET
|
|
2876
|
+
* @requiredScopes ils-lists-read
|
|
2877
|
+
*/
|
|
2878
|
+
getIdMapping: (
|
|
2879
|
+
input?: Basic.GetIdMappingInput
|
|
2880
|
+
) => Operation<Basic.GetIdMappingOutput>;
|
|
2881
|
+
/**
|
|
2882
|
+
* @apiPath /crm/lists/2026-03/{listId}/memberships/join-order
|
|
2883
|
+
* @apiMethod GET
|
|
2884
|
+
* @requiredScopes ils-lists-read
|
|
2885
|
+
*/
|
|
2886
|
+
getMembershipsJoinOrder: (
|
|
2887
|
+
input: Basic.GetMembershipsJoinOrderInput
|
|
2888
|
+
) => Operation<Basic.GetMembershipsJoinOrderOutput>;
|
|
2889
|
+
/**
|
|
2890
|
+
* @apiPath /crm/lists/2026-03/records/{objectTypeId}/{recordId}/memberships
|
|
2891
|
+
* @apiMethod GET
|
|
2892
|
+
* @requiredScopes ils-lists-read
|
|
2893
|
+
*/
|
|
2894
|
+
getRecordMemberships: (
|
|
2895
|
+
input: Basic.GetRecordMembershipsInput
|
|
2896
|
+
) => Operation<Basic.GetRecordMembershipsOutput>;
|
|
2897
|
+
/**
|
|
2898
|
+
* @apiPath /crm/lists/2026-03/{listId}/schedule-conversion
|
|
2899
|
+
* @apiMethod GET
|
|
2900
|
+
* @requiredScopes ils-lists-read
|
|
2901
|
+
*/
|
|
2902
|
+
getScheduleConversion: (
|
|
2903
|
+
input: Basic.GetScheduleConversionInput
|
|
2904
|
+
) => Operation<Basic.GetScheduleConversionOutput>;
|
|
2905
|
+
/**
|
|
2906
|
+
* @apiPath /crm/lists/2026-03/{listId}/size-and-edits-history/between
|
|
2907
|
+
* @apiMethod GET
|
|
2908
|
+
* @requiredScopes ils-lists-read
|
|
2909
|
+
*/
|
|
2910
|
+
getSizeAndEditsHistoryBetween: (
|
|
2911
|
+
input: Basic.GetSizeAndEditsHistoryBetweenInput
|
|
2912
|
+
) => Operation<Basic.GetSizeAndEditsHistoryBetweenOutput>;
|
|
2913
|
+
/**
|
|
2914
|
+
* @apiPath /crm/lists/2026-03
|
|
2915
|
+
* @apiMethod GET
|
|
2916
|
+
* @requiredScopes ils-lists-read
|
|
2917
|
+
*/
|
|
2918
|
+
list: (input?: Basic.ListInput) => Operation<Basic.ListOutput>;
|
|
2919
|
+
/**
|
|
2920
|
+
* @apiPath /crm/lists/2026-03/folders
|
|
2921
|
+
* @apiMethod GET
|
|
2922
|
+
* @requiredScopes ils-lists-read
|
|
2923
|
+
*/
|
|
2924
|
+
listFolders: (
|
|
2925
|
+
input?: Basic.ListFoldersInput
|
|
2926
|
+
) => Operation<Basic.ListFoldersOutput>;
|
|
2927
|
+
/**
|
|
2928
|
+
* @apiPath /crm/lists/2026-03/{listId}/memberships
|
|
2929
|
+
* @apiMethod GET
|
|
2930
|
+
* @requiredScopes ils-lists-read
|
|
2931
|
+
*/
|
|
2932
|
+
listMemberships: (
|
|
2933
|
+
input: Basic.ListMembershipsInput
|
|
2934
|
+
) => Operation<Basic.ListMembershipsOutput>;
|
|
2935
|
+
/**
|
|
2936
|
+
* @apiPath /crm/lists/2026-03/folders/{folderId}/move/{newParentFolderId}
|
|
2937
|
+
* @apiMethod PUT
|
|
2938
|
+
* @requiredScopes ils-lists-read, ils-lists-write
|
|
2939
|
+
*/
|
|
2940
|
+
moveFolder: (
|
|
2941
|
+
input: Basic.MoveFolderInput
|
|
2942
|
+
) => Operation<Basic.MoveFolderOutput>;
|
|
2943
|
+
/**
|
|
2944
|
+
* @apiPath /crm/lists/2026-03/folders/move-list
|
|
2945
|
+
* @apiMethod PUT
|
|
2946
|
+
* @requiredScopes ils-lists-read, ils-lists-write
|
|
2947
|
+
*/
|
|
2948
|
+
moveList: (input: Basic.MoveListInput) => Operation<Basic.MoveListOutput>;
|
|
2949
|
+
/**
|
|
2950
|
+
* @apiPath /crm/lists/2026-03/{listId}/memberships/remove
|
|
2951
|
+
* @apiMethod PUT
|
|
2952
|
+
* @requiredScopes ils-lists-read, ils-lists-write
|
|
2953
|
+
*/
|
|
2954
|
+
removeMemberships: (
|
|
2955
|
+
input: Basic.RemoveMembershipsInput
|
|
2956
|
+
) => Operation<Basic.RemoveMembershipsOutput>;
|
|
2957
|
+
/**
|
|
2958
|
+
* @apiPath /crm/lists/2026-03/folders/{folderId}/rename
|
|
2959
|
+
* @apiMethod PUT
|
|
2960
|
+
* @requiredScopes ils-lists-read, ils-lists-write
|
|
2961
|
+
*/
|
|
2962
|
+
renameFolder: (
|
|
2963
|
+
input: Basic.RenameFolderInput
|
|
2964
|
+
) => Operation<Basic.RenameFolderOutput>;
|
|
2965
|
+
/**
|
|
2966
|
+
* @apiPath /crm/lists/2026-03/{listId}/restore
|
|
2967
|
+
* @apiMethod PUT
|
|
2968
|
+
* @requiredScopes ils-lists-read, ils-lists-write
|
|
2969
|
+
*/
|
|
2970
|
+
restore: (input: Basic.RestoreInput) => Operation<Basic.RestoreOutput>;
|
|
2971
|
+
/**
|
|
2972
|
+
* @apiPath /crm/lists/2026-03/{listId}/schedule-conversion
|
|
2973
|
+
* @apiMethod DELETE
|
|
2974
|
+
* @requiredScopes ils-lists-read, ils-lists-write
|
|
2975
|
+
*/
|
|
2976
|
+
scheduleConversion: (
|
|
2977
|
+
input: Basic.ScheduleConversionInput
|
|
2978
|
+
) => Operation<Basic.ScheduleConversionOutput>;
|
|
2979
|
+
/**
|
|
2980
|
+
* @apiPath /crm/lists/2026-03/{listId}/update-list-filters
|
|
2981
|
+
* @apiMethod PUT
|
|
2982
|
+
* @requiredScopes ils-lists-read, ils-lists-write
|
|
2983
|
+
*/
|
|
2984
|
+
updateListFilters: (
|
|
2985
|
+
input: Basic.UpdateListFiltersInput
|
|
2986
|
+
) => Operation<Basic.UpdateListFiltersOutput>;
|
|
2987
|
+
/**
|
|
2988
|
+
* @apiPath /crm/lists/2026-03/{listId}/update-list-name
|
|
2989
|
+
* @apiMethod PUT
|
|
2990
|
+
* @requiredScopes ils-lists-read, ils-lists-write
|
|
2991
|
+
*/
|
|
2992
|
+
updateListName: (
|
|
2993
|
+
input: Basic.UpdateListNameInput
|
|
2994
|
+
) => Operation<Basic.UpdateListNameOutput>;
|
|
2995
|
+
/**
|
|
2996
|
+
* @apiPath /crm/lists/2026-03/{listId}/schedule-conversion
|
|
2997
|
+
* @apiMethod PUT
|
|
2998
|
+
* @requiredScopes ils-lists-read, ils-lists-write
|
|
2999
|
+
*/
|
|
3000
|
+
updateScheduleConversion: (
|
|
3001
|
+
input: Basic.UpdateScheduleConversionInput
|
|
3002
|
+
) => Operation<Basic.UpdateScheduleConversionOutput>;
|
|
3003
|
+
}
|
|
3004
|
+
|
|
3005
|
+
/**
|
|
3006
|
+
* Usage example:
|
|
3007
|
+
* ```ts
|
|
3008
|
+
* import { crmLists } from '@hubspot/api-client-core';
|
|
3009
|
+
* client.send(crmLists.batch.batchReadMemberships(input));
|
|
3010
|
+
* ```
|
|
3011
|
+
*/
|
|
3012
|
+
export interface BatchAPI {
|
|
3013
|
+
/**
|
|
3014
|
+
* @apiPath /crm/lists/2026-03/records/memberships/batch/read
|
|
3015
|
+
* @apiMethod POST
|
|
3016
|
+
* @requiredScopes ils-lists-read
|
|
3017
|
+
*/
|
|
3018
|
+
batchReadMemberships: (
|
|
3019
|
+
input: Batch.BatchReadMembershipsInput
|
|
3020
|
+
) => Operation<Batch.BatchReadMembershipsOutput>;
|
|
3021
|
+
}
|
|
3022
|
+
|
|
3023
|
+
/**
|
|
3024
|
+
* Usage example:
|
|
3025
|
+
* ```ts
|
|
3026
|
+
* import { crmLists } from '@hubspot/api-client-core';
|
|
3027
|
+
* client.send(crmLists.search.listBySearch(input));
|
|
3028
|
+
* ```
|
|
3029
|
+
*/
|
|
3030
|
+
export interface SearchAPI {
|
|
3031
|
+
/**
|
|
3032
|
+
* @apiPath /crm/lists/2026-03/search
|
|
3033
|
+
* @apiMethod POST
|
|
3034
|
+
* @requiredScopes ils-lists-read
|
|
3035
|
+
*/
|
|
3036
|
+
listBySearch: (
|
|
3037
|
+
input: Search.ListBySearchInput
|
|
3038
|
+
) => Operation<Search.ListBySearchOutput>;
|
|
3039
|
+
}
|
|
3040
|
+
|
|
3041
|
+
/**
|
|
3042
|
+
* Usage example:
|
|
3043
|
+
* ```ts
|
|
3044
|
+
* import { crmLists } from '@hubspot/api-client-core';
|
|
3045
|
+
* client.send(crmLists.basic.addAndRemoveMemberships(input));
|
|
3046
|
+
* ```
|
|
3047
|
+
*/
|
|
3048
|
+
export interface API {
|
|
3049
|
+
basic: BasicAPI;
|
|
3050
|
+
batch: BatchAPI;
|
|
3051
|
+
search: SearchAPI;
|
|
3052
|
+
}
|
|
3053
|
+
}
|