@hubspot/app-connect-sdk 1.0.0-alpha.2 → 1.0.0-alpha.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.turbo/turbo-format$colon$check.log +1 -1
- package/.turbo/turbo-test.log +101 -57
- package/.turbo/turbo-tsdown.log +474 -469
- package/build/tsconfig.browser.tsbuildinfo +1 -1
- package/build/tsconfig.server.tsbuildinfo +1 -1
- package/dist/browser/{HubSpotAppConnect-BW45gyDs.js → HubSpotAppConnect-721kYr9d.js} +17 -23
- package/dist/browser/HubSpotAppConnect-721kYr9d.js.map +1 -0
- package/dist/browser/{create-vctOhpX9.js → create-DxEyGG-k.js} +336 -100
- package/dist/browser/create-DxEyGG-k.js.map +1 -0
- package/dist/browser/index.d.ts +2 -2
- package/dist/browser/index.js +1 -1
- package/dist/browser/react/lovable.d.ts +9 -2
- package/dist/browser/react/lovable.js +7 -4
- package/dist/browser/react/lovable.js.map +1 -1
- package/dist/browser/react.d.ts +2 -3
- package/dist/browser/react.js +1 -1
- package/dist/browser/{types-rTQw6A54.d.ts → types-C3wed8dU.d.ts} +52 -7
- package/dist/server/api-client-core/apis/account/account-info-types.generated.d.ts +73 -85
- package/dist/server/api-client-core/apis/account/account-info.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/account/account-info.generated.js +4 -3
- package/dist/server/api-client-core/apis/account/account-info.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/account/audit-logs-types.generated.d.ts +203 -215
- package/dist/server/api-client-core/apis/account/audit-logs.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/account/audit-logs.generated.js +4 -3
- package/dist/server/api-client-core/apis/account/audit-logs.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/auth/oauth-types.generated.d.ts +78 -90
- package/dist/server/api-client-core/apis/auth/oauth.generated.d.ts +1 -1
- package/dist/server/api-client-core/apis/auth/oauth.generated.js +3 -2
- package/dist/server/api-client-core/apis/auth/oauth.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/automation/actions-types.generated.d.ts +779 -794
- package/dist/server/api-client-core/apis/automation/actions.generated.d.ts +6 -3
- package/dist/server/api-client-core/apis/automation/actions.generated.js +101 -102
- package/dist/server/api-client-core/apis/automation/actions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/automation/sequences-types.generated.d.ts +370 -382
- package/dist/server/api-client-core/apis/automation/sequences.generated.d.ts +1 -1
- package/dist/server/api-client-core/apis/automation/sequences.generated.js +3 -2
- package/dist/server/api-client-core/apis/automation/sequences.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/business-units-types.generated.d.ts +43 -55
- package/dist/server/api-client-core/apis/business-units.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/business-units.generated.js +4 -3
- package/dist/server/api-client-core/apis/business-units.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/authors-types.generated.d.ts +420 -445
- package/dist/server/api-client-core/apis/cms/authors.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/cms/authors.generated.js +155 -158
- package/dist/server/api-client-core/apis/cms/authors.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/blog-settings-types.generated.d.ts +270 -295
- package/dist/server/api-client-core/apis/cms/blog-settings.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/cms/blog-settings.generated.js +35 -38
- package/dist/server/api-client-core/apis/cms/blog-settings.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/cms-content-audit-types.generated.d.ts +107 -131
- package/dist/server/api-client-core/apis/cms/cms-content-audit.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/cms/cms-content-audit.generated.js +6 -5
- package/dist/server/api-client-core/apis/cms/cms-content-audit.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/domains-types.generated.d.ts +155 -167
- package/dist/server/api-client-core/apis/cms/domains.generated.d.ts +2 -2
- package/dist/server/api-client-core/apis/cms/domains.generated.js +3 -2
- package/dist/server/api-client-core/apis/cms/domains.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/hubdb-types.generated.d.ts +876 -889
- package/dist/server/api-client-core/apis/cms/hubdb.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/cms/hubdb.generated.js +184 -185
- package/dist/server/api-client-core/apis/cms/hubdb.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/media-bridge-types.generated.d.ts +1550 -1575
- package/dist/server/api-client-core/apis/cms/media-bridge.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/cms/media-bridge.generated.js +161 -164
- package/dist/server/api-client-core/apis/cms/media-bridge.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/pages-types.generated.d.ts +1583 -1547
- package/dist/server/api-client-core/apis/cms/pages.generated.d.ts +15 -3
- package/dist/server/api-client-core/apis/cms/pages.generated.js +335 -326
- package/dist/server/api-client-core/apis/cms/pages.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/posts-types.generated.d.ts +900 -904
- package/dist/server/api-client-core/apis/cms/posts.generated.d.ts +7 -3
- package/dist/server/api-client-core/apis/cms/posts.generated.js +197 -196
- package/dist/server/api-client-core/apis/cms/posts.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/site-search-types.generated.d.ts +162 -174
- package/dist/server/api-client-core/apis/cms/site-search.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/cms/site-search.generated.js +4 -3
- package/dist/server/api-client-core/apis/cms/site-search.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/source-code-types.generated.d.ts +148 -172
- package/dist/server/api-client-core/apis/cms/source-code.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/cms/source-code.generated.js +40 -43
- package/dist/server/api-client-core/apis/cms/source-code.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/tags-types.generated.d.ts +406 -420
- package/dist/server/api-client-core/apis/cms/tags.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/cms/tags.generated.js +157 -158
- package/dist/server/api-client-core/apis/cms/tags.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/url-mappings-types.generated.d.ts +127 -139
- package/dist/server/api-client-core/apis/cms/url-mappings.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/cms/url-mappings.generated.js +4 -3
- package/dist/server/api-client-core/apis/cms/url-mappings.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/url-redirects-types.generated.d.ts +170 -182
- package/dist/server/api-client-core/apis/cms/url-redirects.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/cms/url-redirects.generated.js +4 -3
- package/dist/server/api-client-core/apis/cms/url-redirects.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/communication-preferences/subscriptions-types.generated.d.ts +728 -742
- package/dist/server/api-client-core/apis/communication-preferences/subscriptions.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/communication-preferences/subscriptions.generated.js +66 -69
- package/dist/server/api-client-core/apis/communication-preferences/subscriptions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/conversations/custom-channels-types.generated.d.ts +445 -471
- package/dist/server/api-client-core/apis/conversations/custom-channels.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/conversations/custom-channels.generated.js +70 -73
- package/dist/server/api-client-core/apis/conversations/custom-channels.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/conversations/visitor-identification-types.generated.d.ts +28 -40
- package/dist/server/api-client-core/apis/conversations/visitor-identification.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/conversations/visitor-identification.generated.js +3 -2
- package/dist/server/api-client-core/apis/conversations/visitor-identification.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/conversations-types.generated.d.ts +768 -781
- package/dist/server/api-client-core/apis/conversations.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/conversations.generated.js +101 -102
- package/dist/server/api-client-core/apis/conversations.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/app-uninstalls-types.generated.d.ts +8 -19
- package/dist/server/api-client-core/apis/crm/app-uninstalls.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/app-uninstalls.generated.js +3 -2
- package/dist/server/api-client-core/apis/crm/app-uninstalls.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/appointments-types.generated.d.ts +887 -891
- package/dist/server/api-client-core/apis/crm/appointments.generated.d.ts +7 -3
- package/dist/server/api-client-core/apis/crm/appointments.generated.js +105 -106
- package/dist/server/api-client-core/apis/crm/appointments.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/associations-schema-types.generated.d.ts +247 -260
- package/dist/server/api-client-core/apis/crm/associations-schema.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/crm/associations-schema.generated.js +48 -49
- package/dist/server/api-client-core/apis/crm/associations-schema.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/associations-types.generated.d.ts +576 -590
- package/dist/server/api-client-core/apis/crm/associations.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/associations.generated.js +71 -72
- package/dist/server/api-client-core/apis/crm/associations.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/calling-extensions-types.generated.d.ts +355 -379
- package/dist/server/api-client-core/apis/crm/calling-extensions.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/calling-extensions.generated.js +34 -37
- package/dist/server/api-client-core/apis/crm/calling-extensions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/calls-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/calls.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/calls.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/calls.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/carts-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/carts.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/carts.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/carts.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/commerce-payments-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/commerce-payments.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/commerce-payments.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/commerce-payments.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/commerce-subscriptions-types.generated.d.ts +752 -766
- package/dist/server/api-client-core/apis/crm/commerce-subscriptions.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/commerce-subscriptions.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/commerce-subscriptions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/communications-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/communications.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/communications.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/communications.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/companies-types.generated.d.ts +769 -795
- package/dist/server/api-client-core/apis/crm/companies.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/companies.generated.js +59 -58
- package/dist/server/api-client-core/apis/crm/companies.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/contacts-types.generated.d.ts +786 -812
- package/dist/server/api-client-core/apis/crm/contacts.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/contacts.generated.js +60 -61
- package/dist/server/api-client-core/apis/crm/contacts.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/contracts-types.generated.d.ts +796 -777
- package/dist/server/api-client-core/apis/crm/contracts.generated.d.ts +8 -3
- package/dist/server/api-client-core/apis/crm/contracts.generated.js +60 -57
- package/dist/server/api-client-core/apis/crm/contracts.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/courses-types.generated.d.ts +758 -772
- package/dist/server/api-client-core/apis/crm/courses.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/courses.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/courses.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/crm-owners-types.generated.d.ts +103 -115
- package/dist/server/api-client-core/apis/crm/crm-owners.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/crm-owners.generated.js +4 -3
- package/dist/server/api-client-core/apis/crm/crm-owners.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/custom-objects-types.generated.d.ts +833 -848
- package/dist/server/api-client-core/apis/crm/custom-objects.generated.d.ts +6 -3
- package/dist/server/api-client-core/apis/crm/custom-objects.generated.js +91 -90
- package/dist/server/api-client-core/apis/crm/custom-objects.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/deal-splits-types.generated.d.ts +158 -170
- package/dist/server/api-client-core/apis/crm/deal-splits.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/deal-splits.generated.js +4 -3
- package/dist/server/api-client-core/apis/crm/deal-splits.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/deals-types.generated.d.ts +771 -785
- package/dist/server/api-client-core/apis/crm/deals.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/deals.generated.js +59 -58
- package/dist/server/api-client-core/apis/crm/deals.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/discounts-types.generated.d.ts +754 -768
- package/dist/server/api-client-core/apis/crm/discounts.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/discounts.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/discounts.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/emails-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/emails.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/emails.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/emails.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/exports-types.generated.d.ts +227 -251
- package/dist/server/api-client-core/apis/crm/exports.generated.d.ts +2 -2
- package/dist/server/api-client-core/apis/crm/exports.generated.js +4 -5
- package/dist/server/api-client-core/apis/crm/exports.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/feedback-submissions-types.generated.d.ts +551 -565
- package/dist/server/api-client-core/apis/crm/feedback-submissions.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/feedback-submissions.generated.js +45 -46
- package/dist/server/api-client-core/apis/crm/feedback-submissions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/fees-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/fees.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/fees.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/fees.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/goal-targets-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/goal-targets.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/goal-targets.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/goal-targets.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/imports-types.generated.d.ts +305 -329
- package/dist/server/api-client-core/apis/crm/imports.generated.d.ts +2 -2
- package/dist/server/api-client-core/apis/crm/imports.generated.js +20 -23
- package/dist/server/api-client-core/apis/crm/imports.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/invoices-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/invoices.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/invoices.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/invoices.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/leads-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/leads.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/leads.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/leads.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/limits-tracking-types.generated.d.ts +251 -263
- package/dist/server/api-client-core/apis/crm/limits-tracking.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/limits-tracking.generated.js +4 -3
- package/dist/server/api-client-core/apis/crm/limits-tracking.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/line-items-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/line-items.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/line-items.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/line-items.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/listings-types.generated.d.ts +758 -772
- package/dist/server/api-client-core/apis/crm/listings.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/listings.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/listings.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/lists-types.generated.d.ts +2075 -2111
- package/dist/server/api-client-core/apis/crm/lists.generated.d.ts +2 -2
- package/dist/server/api-client-core/apis/crm/lists.generated.js +97 -98
- package/dist/server/api-client-core/apis/crm/lists.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/meetings-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/meetings.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/meetings.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/meetings.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/notes-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/notes.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/notes.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/notes.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/object-library-types.generated.d.ts +24 -36
- package/dist/server/api-client-core/apis/crm/object-library.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/object-library.generated.js +4 -3
- package/dist/server/api-client-core/apis/crm/object-library.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/objects-types.generated.d.ts +620 -645
- package/dist/server/api-client-core/apis/crm/objects.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/crm/objects.generated.js +66 -67
- package/dist/server/api-client-core/apis/crm/objects.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/orders-types.generated.d.ts +747 -761
- package/dist/server/api-client-core/apis/crm/orders.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/orders.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/orders.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/partner-clients-types.generated.d.ts +646 -660
- package/dist/server/api-client-core/apis/crm/partner-clients.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/partner-clients.generated.js +63 -62
- package/dist/server/api-client-core/apis/crm/partner-clients.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/partner-services-types.generated.d.ts +646 -660
- package/dist/server/api-client-core/apis/crm/partner-services.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/partner-services.generated.js +63 -62
- package/dist/server/api-client-core/apis/crm/partner-services.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/pipelines-types.generated.d.ts +320 -332
- package/dist/server/api-client-core/apis/crm/pipelines.generated.d.ts +2 -2
- package/dist/server/api-client-core/apis/crm/pipelines.generated.js +3 -2
- package/dist/server/api-client-core/apis/crm/pipelines.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/postal-mail-types.generated.d.ts +744 -758
- package/dist/server/api-client-core/apis/crm/postal-mail.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/postal-mail.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/postal-mail.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/products-types.generated.d.ts +747 -761
- package/dist/server/api-client-core/apis/crm/products.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/products.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/products.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/projects-types.generated.d.ts +761 -787
- package/dist/server/api-client-core/apis/crm/projects.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/projects.generated.js +59 -58
- package/dist/server/api-client-core/apis/crm/projects.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/properties-types.generated.d.ts +526 -528
- package/dist/server/api-client-core/apis/crm/properties.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/properties.generated.js +79 -78
- package/dist/server/api-client-core/apis/crm/properties.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/property-validations-types.generated.d.ts +71 -83
- package/dist/server/api-client-core/apis/crm/property-validations.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/property-validations.generated.js +4 -3
- package/dist/server/api-client-core/apis/crm/property-validations.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/public-app-crm-cards-types.generated.d.ts +409 -433
- package/dist/server/api-client-core/apis/crm/public-app-crm-cards.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/public-app-crm-cards.generated.js +24 -25
- package/dist/server/api-client-core/apis/crm/public-app-crm-cards.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/public-app-feature-flags-types.generated.d.ts +156 -169
- package/dist/server/api-client-core/apis/crm/public-app-feature-flags.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/crm/public-app-feature-flags.generated.js +55 -56
- package/dist/server/api-client-core/apis/crm/public-app-feature-flags.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/quotes-types.generated.d.ts +747 -761
- package/dist/server/api-client-core/apis/crm/quotes.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/quotes.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/quotes.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/schemas-types.generated.d.ts +575 -600
- package/dist/server/api-client-core/apis/crm/schemas.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/crm/schemas.generated.js +33 -34
- package/dist/server/api-client-core/apis/crm/schemas.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/services-types.generated.d.ts +750 -764
- package/dist/server/api-client-core/apis/crm/services.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/services.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/services.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/tasks-types.generated.d.ts +747 -761
- package/dist/server/api-client-core/apis/crm/tasks.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/tasks.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/tasks.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/taxes-types.generated.d.ts +747 -761
- package/dist/server/api-client-core/apis/crm/taxes.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/taxes.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/taxes.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/tickets-types.generated.d.ts +764 -790
- package/dist/server/api-client-core/apis/crm/tickets.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/tickets.generated.js +59 -58
- package/dist/server/api-client-core/apis/crm/tickets.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/timeline-types.generated.d.ts +136 -149
- package/dist/server/api-client-core/apis/crm/timeline.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/crm/timeline.generated.js +5 -6
- package/dist/server/api-client-core/apis/crm/timeline.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/transcriptions-types.generated.d.ts +104 -117
- package/dist/server/api-client-core/apis/crm/transcriptions.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/crm/transcriptions.generated.js +7 -10
- package/dist/server/api-client-core/apis/crm/transcriptions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/users-types.generated.d.ts +747 -761
- package/dist/server/api-client-core/apis/crm/users.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/users.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/users.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/video-conferencing-extension-types.generated.d.ts +28 -40
- package/dist/server/api-client-core/apis/crm/video-conferencing-extension.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/video-conferencing-extension.generated.js +4 -3
- package/dist/server/api-client-core/apis/crm/video-conferencing-extension.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/events/manage-event-definitions-types.generated.d.ts +909 -945
- package/dist/server/api-client-core/apis/events/manage-event-definitions.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/events/manage-event-definitions.generated.js +29 -30
- package/dist/server/api-client-core/apis/events/manage-event-definitions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/events/send-event-completions-types.generated.d.ts +49 -62
- package/dist/server/api-client-core/apis/events/send-event-completions.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/events/send-event-completions.generated.js +4 -5
- package/dist/server/api-client-core/apis/events/send-event-completions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/events-types.generated.d.ts +99 -111
- package/dist/server/api-client-core/apis/events.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/events.generated.js +4 -3
- package/dist/server/api-client-core/apis/events.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/files-types.generated.d.ts +636 -649
- package/dist/server/api-client-core/apis/files.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/files.generated.js +112 -113
- package/dist/server/api-client-core/apis/files.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/marketing/campaigns-public-api-types.generated.d.ts +799 -816
- package/dist/server/api-client-core/apis/marketing/campaigns-public-api.generated.d.ts +8 -3
- package/dist/server/api-client-core/apis/marketing/campaigns-public-api.generated.js +126 -127
- package/dist/server/api-client-core/apis/marketing/campaigns-public-api.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/marketing/marketing-emails-types.generated.d.ts +745 -769
- package/dist/server/api-client-core/apis/marketing/marketing-emails.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/marketing/marketing-emails.generated.js +100 -103
- package/dist/server/api-client-core/apis/marketing/marketing-emails.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/marketing/marketing-events-types.generated.d.ts +1504 -1546
- package/dist/server/api-client-core/apis/marketing/marketing-events.generated.d.ts +9 -3
- package/dist/server/api-client-core/apis/marketing/marketing-events.generated.js +162 -167
- package/dist/server/api-client-core/apis/marketing/marketing-events.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/marketing/single-send-types.generated.d.ts +91 -103
- package/dist/server/api-client-core/apis/marketing/single-send.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/marketing/single-send.generated.js +3 -2
- package/dist/server/api-client-core/apis/marketing/single-send.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/marketing/transactional-single-send-types.generated.d.ts +187 -200
- package/dist/server/api-client-core/apis/marketing/transactional-single-send.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/marketing/transactional-single-send.generated.js +14 -15
- package/dist/server/api-client-core/apis/marketing/transactional-single-send.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/meta/origins-types.generated.d.ts +41 -53
- package/dist/server/api-client-core/apis/meta/origins.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/meta/origins.generated.js +4 -3
- package/dist/server/api-client-core/apis/meta/origins.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/scheduler/meetings-types.generated.d.ts +850 -863
- package/dist/server/api-client-core/apis/scheduler/meetings.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/scheduler/meetings.generated.js +28 -29
- package/dist/server/api-client-core/apis/scheduler/meetings.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/settings/multicurrency-types.generated.d.ts +281 -296
- package/dist/server/api-client-core/apis/settings/multicurrency.generated.d.ts +6 -3
- package/dist/server/api-client-core/apis/settings/multicurrency.generated.js +32 -33
- package/dist/server/api-client-core/apis/settings/multicurrency.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/settings/tax-rates-types.generated.d.ts +71 -83
- package/dist/server/api-client-core/apis/settings/tax-rates.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/settings/tax-rates.generated.js +4 -3
- package/dist/server/api-client-core/apis/settings/tax-rates.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/settings/user-provisioning-types.generated.d.ts +202 -250
- package/dist/server/api-client-core/apis/settings/user-provisioning.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/settings/user-provisioning.generated.js +23 -26
- package/dist/server/api-client-core/apis/settings/user-provisioning.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/webhooks-journal-types.generated.d.ts +490 -526
- package/dist/server/api-client-core/apis/webhooks-journal.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/webhooks-journal.generated.js +65 -70
- package/dist/server/api-client-core/apis/webhooks-journal.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/webhooks-types.generated.d.ts +816 -852
- package/dist/server/api-client-core/apis/webhooks.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/webhooks.generated.js +93 -98
- package/dist/server/api-client-core/apis/webhooks.generated.js.map +1 -1
- package/dist/server/api-client-core/binary-data.js.map +1 -1
- package/dist/server/api-client-core/client.js +5 -1
- package/dist/server/api-client-core/client.js.map +1 -1
- package/dist/server/api-client-core/codegen-helpers/file-op-wrappers.js.map +1 -1
- package/dist/server/api-client-core/errors.js.map +1 -1
- package/dist/server/api-client-core/op.js.map +1 -1
- package/dist/server/api-client-core/pagination.d.ts +2 -2
- package/dist/server/api-client-core/pagination.js +2 -2
- package/dist/server/api-client-core/pagination.js.map +1 -1
- package/dist/server/api-client-core/plugins/fetch-transport.js +33 -9
- package/dist/server/api-client-core/plugins/fetch-transport.js.map +1 -1
- package/dist/server/api-client-core/types.d.ts +1 -1
- package/dist/server/api-client.d.ts +184 -184
- package/dist/server/api-client.js +89 -89
- package/dist/server/constants.js +33 -6
- package/dist/server/constants.js.map +1 -1
- package/dist/server/deno/start.js.map +1 -1
- package/dist/server/hono/hono-request-handler.js +32 -23
- package/dist/server/hono/hono-request-handler.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/auth-complete.js +158 -0
- package/dist/server/hono/hubspot-connect-routes/auth-complete.js.map +1 -0
- package/dist/server/hono/hubspot-connect-routes/auth-init-session.js +25 -12
- package/dist/server/hono/hubspot-connect-routes/auth-init-session.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/auth-logout.js +32 -9
- package/dist/server/hono/hubspot-connect-routes/auth-logout.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/auth-refresh.js +32 -18
- package/dist/server/hono/hubspot-connect-routes/auth-refresh.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/cimd-client-metadata-types.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/cimd-public-routes.js +4 -1
- package/dist/server/hono/hubspot-connect-routes/cimd-public-routes.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/fetch-hubspot-client-metadata.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/hubspot-connect-routes.js +4 -2
- package/dist/server/hono/hubspot-connect-routes/hubspot-connect-routes.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/load-hubspot-connect-routes-env.js +5 -5
- package/dist/server/hono/hubspot-connect-routes/load-hubspot-connect-routes-env.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/oauth-client.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/utils.js +53 -6
- package/dist/server/hono/hubspot-connect-routes/utils.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/whoami.js +51 -0
- package/dist/server/hono/hubspot-connect-routes/whoami.js.map +1 -0
- package/dist/server/hono/types.d.ts +9 -10
- package/dist/server/hono/utils/cookie-utils.js +2 -1
- package/dist/server/hono/utils/cookie-utils.js.map +1 -1
- package/dist/server/hono/utils/cors-middleware.js +85 -0
- package/dist/server/hono/utils/cors-middleware.js.map +1 -0
- package/dist/server/import-app-keys.js.map +1 -1
- package/dist/server/lovable/create-app-function-start.d.ts +1 -1
- package/dist/server/lovable/create-app-function-start.js +4 -6
- package/dist/server/lovable/create-app-function-start.js.map +1 -1
- package/dist/server/lovable/hubspot-connect/index.js.map +1 -1
- package/dist/server/lovable/hubspot-connect/run-hubspot-connect-lovable-server.js +14 -15
- package/dist/server/lovable/hubspot-connect/run-hubspot-connect-lovable-server.js.map +1 -1
- package/dist/server/sanitize-request.js +14 -11
- package/dist/server/sanitize-request.js.map +1 -1
- package/dist/server/secure-start-core.js +4 -5
- package/dist/server/secure-start-core.js.map +1 -1
- package/dist/server/shared/constants.js +22 -9
- package/dist/server/shared/constants.js.map +1 -1
- package/dist/server/shared/encoding/base64.js.map +1 -1
- package/dist/server/shared/encoding/sha256.js.map +1 -1
- package/dist/server/shared/logger.js.map +1 -1
- package/dist/server/types.d.ts +1 -35
- package/dist/server/utils/cookie-utils.js.map +1 -1
- package/dist/server/utils/dpop-utils.js.map +1 -1
- package/dist/server/utils/env-utils.js +60 -7
- package/dist/server/utils/env-utils.js.map +1 -1
- package/dist/server/utils/hubspot-dpop-auth-headers.js +38 -0
- package/dist/server/utils/hubspot-dpop-auth-headers.js.map +1 -0
- package/dist/server/utils/jwk-utils.js.map +1 -1
- package/dist/server/utils/jwt-utils.js.map +1 -1
- package/package.json +15 -21
- package/src/browser/app-connect-controller/README.md +5 -2
- package/src/browser/app-connect-controller/connect-start.test.ts +157 -0
- package/src/browser/app-connect-controller/connect-start.ts +18 -3
- package/src/browser/app-connect-controller/constants.ts +6 -4
- package/src/browser/app-connect-controller/create.ts +8 -2
- package/src/browser/app-connect-controller/disconnect.ts +5 -7
- package/src/browser/app-connect-controller/init.test.ts +275 -0
- package/src/browser/app-connect-controller/init.ts +44 -19
- package/src/browser/app-connect-controller/oauth-complete.test.ts +110 -0
- package/src/browser/app-connect-controller/oauth-complete.ts +53 -0
- package/src/browser/app-connect-controller/oauth-popup.test.ts +239 -0
- package/src/browser/app-connect-controller/oauth-popup.ts +160 -0
- package/src/browser/app-connect-controller/types.ts +3 -0
- package/src/browser/app-connect-controller/utils/iframe-utils.ts +12 -0
- package/src/browser/app-connect-controller/utils/resolve-oauth-connect-mode.test.ts +35 -0
- package/src/browser/app-connect-controller/utils/resolve-oauth-connect-mode.ts +21 -0
- package/src/browser/app-connect-controller/utils/session-utils.test.ts +73 -22
- package/src/browser/app-connect-controller/utils/session-utils.ts +74 -33
- package/src/browser/app-connect-controller/view-state.test.ts +1 -0
- package/src/browser/app-connect-controller/view-state.ts +1 -0
- package/src/browser/index.ts +1 -0
- package/src/browser/react/components/AppConnectHeader/AppConnectHeader.tsx +21 -34
- package/src/browser/react/components/ConnectButton/ConnectButton.tsx +1 -1
- package/src/browser/react/lovable/LovableHubSpotAppConnect.tsx +12 -2
- package/src/browser/types.ts +30 -5
- package/src/server/api-client-core/__tests__/errors.test.ts +309 -0
- package/src/server/api-client-core/__tests__/operation-headers.test.ts +251 -0
- package/src/server/api-client-core/apis/account/account-info-types.generated.ts +74 -88
- package/src/server/api-client-core/apis/account/account-info.generated.ts +2 -4
- package/src/server/api-client-core/apis/account/audit-logs-types.generated.ts +346 -360
- package/src/server/api-client-core/apis/account/audit-logs.generated.ts +2 -4
- package/src/server/api-client-core/apis/auth/oauth-types.generated.ts +81 -99
- package/src/server/api-client-core/apis/auth/oauth.generated.ts +1 -3
- package/src/server/api-client-core/apis/automation/actions-types.generated.ts +1162 -1188
- package/src/server/api-client-core/apis/automation/actions.generated.ts +10 -12
- package/src/server/api-client-core/apis/automation/sequences-types.generated.ts +379 -393
- package/src/server/api-client-core/apis/automation/sequences.generated.ts +1 -3
- package/src/server/api-client-core/apis/business-units-types.generated.ts +43 -59
- package/src/server/api-client-core/apis/business-units.generated.ts +9 -10
- package/src/server/api-client-core/apis/cms/authors-types.generated.ts +3823 -3853
- package/src/server/api-client-core/apis/cms/authors.generated.ts +31 -37
- package/src/server/api-client-core/apis/cms/blog-settings-types.generated.ts +3667 -3696
- package/src/server/api-client-core/apis/cms/blog-settings.generated.ts +46 -51
- package/src/server/api-client-core/apis/cms/cms-content-audit-types.generated.ts +138 -163
- package/src/server/api-client-core/apis/cms/cms-content-audit.generated.ts +2 -10
- package/src/server/api-client-core/apis/cms/domains-types.generated.ts +153 -167
- package/src/server/api-client-core/apis/cms/domains.generated.ts +2 -4
- package/src/server/api-client-core/apis/cms/hubdb-types.generated.ts +1013 -1063
- package/src/server/api-client-core/apis/cms/hubdb.generated.ts +3 -5
- package/src/server/api-client-core/apis/cms/media-bridge-types.generated.ts +8623 -8657
- package/src/server/api-client-core/apis/cms/media-bridge.generated.ts +16 -22
- package/src/server/api-client-core/apis/cms/pages-types.generated.ts +5259 -5272
- package/src/server/api-client-core/apis/cms/pages.generated.ts +262 -226
- package/src/server/api-client-core/apis/cms/posts-types.generated.ts +4420 -4438
- package/src/server/api-client-core/apis/cms/posts.generated.ts +108 -106
- package/src/server/api-client-core/apis/cms/site-search-types.generated.ts +1867 -1881
- package/src/server/api-client-core/apis/cms/site-search.generated.ts +2 -4
- package/src/server/api-client-core/apis/cms/source-code-types.generated.ts +144 -177
- package/src/server/api-client-core/apis/cms/source-code.generated.ts +15 -23
- package/src/server/api-client-core/apis/cms/tags-types.generated.ts +3820 -3845
- package/src/server/api-client-core/apis/cms/tags.generated.ts +80 -82
- package/src/server/api-client-core/apis/cms/url-mappings-types.generated.ts +188 -202
- package/src/server/api-client-core/apis/cms/url-mappings.generated.ts +2 -4
- package/src/server/api-client-core/apis/cms/url-redirects-types.generated.ts +182 -196
- package/src/server/api-client-core/apis/cms/url-redirects.generated.ts +2 -4
- package/src/server/api-client-core/apis/communication-preferences/subscriptions-types.generated.ts +810 -828
- package/src/server/api-client-core/apis/communication-preferences/subscriptions.generated.ts +66 -63
- package/src/server/api-client-core/apis/conversations/custom-channels-types.generated.ts +564 -601
- package/src/server/api-client-core/apis/conversations/custom-channels.generated.ts +90 -86
- package/src/server/api-client-core/apis/conversations/visitor-identification-types.generated.ts +31 -44
- package/src/server/api-client-core/apis/conversations/visitor-identification.generated.ts +6 -8
- package/src/server/api-client-core/apis/conversations-types.generated.ts +955 -991
- package/src/server/api-client-core/apis/conversations.generated.ts +6 -5
- package/src/server/api-client-core/apis/crm/app-uninstalls-types.generated.ts +7 -19
- package/src/server/api-client-core/apis/crm/app-uninstalls.generated.ts +2 -4
- package/src/server/api-client-core/apis/crm/appointments-types.generated.ts +965 -969
- package/src/server/api-client-core/apis/crm/appointments.generated.ts +143 -137
- package/src/server/api-client-core/apis/crm/associations-schema-types.generated.ts +292 -322
- package/src/server/api-client-core/apis/crm/associations-schema.generated.ts +17 -19
- package/src/server/api-client-core/apis/crm/associations-types.generated.ts +657 -675
- package/src/server/api-client-core/apis/crm/associations.generated.ts +70 -70
- package/src/server/api-client-core/apis/crm/calling-extensions-types.generated.ts +417 -441
- package/src/server/api-client-core/apis/crm/calling-extensions.generated.ts +62 -69
- package/src/server/api-client-core/apis/crm/calls-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/calls.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/carts-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/carts.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/commerce-payments-types.generated.ts +847 -856
- package/src/server/api-client-core/apis/crm/commerce-payments.generated.ts +73 -73
- package/src/server/api-client-core/apis/crm/commerce-subscriptions-types.generated.ts +844 -853
- package/src/server/api-client-core/apis/crm/commerce-subscriptions.generated.ts +50 -51
- package/src/server/api-client-core/apis/crm/communications-types.generated.ts +846 -856
- package/src/server/api-client-core/apis/crm/communications.generated.ts +73 -73
- package/src/server/api-client-core/apis/crm/companies-types.generated.ts +859 -885
- package/src/server/api-client-core/apis/crm/companies.generated.ts +44 -50
- package/src/server/api-client-core/apis/crm/contacts-types.generated.ts +875 -907
- package/src/server/api-client-core/apis/crm/contacts.generated.ts +46 -52
- package/src/server/api-client-core/apis/crm/contracts-types.generated.ts +894 -862
- package/src/server/api-client-core/apis/crm/contracts.generated.ts +66 -56
- package/src/server/api-client-core/apis/crm/courses-types.generated.ts +842 -859
- package/src/server/api-client-core/apis/crm/courses.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/crm-owners-types.generated.ts +102 -115
- package/src/server/api-client-core/apis/crm/crm-owners.generated.ts +2 -4
- package/src/server/api-client-core/apis/crm/custom-objects-types.generated.ts +900 -915
- package/src/server/api-client-core/apis/crm/custom-objects.generated.ts +128 -126
- package/src/server/api-client-core/apis/crm/deal-splits-types.generated.ts +157 -170
- package/src/server/api-client-core/apis/crm/deal-splits.generated.ts +2 -4
- package/src/server/api-client-core/apis/crm/deals-types.generated.ts +858 -875
- package/src/server/api-client-core/apis/crm/deals.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/discounts-types.generated.ts +842 -855
- package/src/server/api-client-core/apis/crm/discounts.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/emails-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/emails.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/exports-types.generated.ts +284 -314
- package/src/server/api-client-core/apis/crm/exports.generated.ts +6 -11
- package/src/server/api-client-core/apis/crm/feedback-submissions-types.generated.ts +607 -622
- package/src/server/api-client-core/apis/crm/feedback-submissions.generated.ts +84 -80
- package/src/server/api-client-core/apis/crm/fees-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/fees.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/goal-targets-types.generated.ts +845 -856
- package/src/server/api-client-core/apis/crm/goal-targets.generated.ts +50 -51
- package/src/server/api-client-core/apis/crm/imports-types.generated.ts +663 -692
- package/src/server/api-client-core/apis/crm/imports.generated.ts +2 -7
- package/src/server/api-client-core/apis/crm/invoices-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/invoices.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/leads-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/leads.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/limits-tracking-types.generated.ts +263 -275
- package/src/server/api-client-core/apis/crm/limits-tracking.generated.ts +2 -4
- package/src/server/api-client-core/apis/crm/line-items-types.generated.ts +843 -856
- package/src/server/api-client-core/apis/crm/line-items.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/listings-types.generated.ts +842 -859
- package/src/server/api-client-core/apis/crm/listings.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/lists-types.generated.ts +2794 -2845
- package/src/server/api-client-core/apis/crm/lists.generated.ts +8 -20
- package/src/server/api-client-core/apis/crm/meetings-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/meetings.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/notes-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/notes.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/object-library-types.generated.ts +26 -39
- package/src/server/api-client-core/apis/crm/object-library.generated.ts +2 -4
- package/src/server/api-client-core/apis/crm/objects-types.generated.ts +688 -716
- package/src/server/api-client-core/apis/crm/objects.generated.ts +79 -83
- package/src/server/api-client-core/apis/crm/orders-types.generated.ts +829 -846
- package/src/server/api-client-core/apis/crm/orders.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/partner-clients-types.generated.ts +721 -735
- package/src/server/api-client-core/apis/crm/partner-clients.generated.ts +60 -60
- package/src/server/api-client-core/apis/crm/partner-services-types.generated.ts +720 -734
- package/src/server/api-client-core/apis/crm/partner-services.generated.ts +60 -60
- package/src/server/api-client-core/apis/crm/pipelines-types.generated.ts +366 -388
- package/src/server/api-client-core/apis/crm/pipelines.generated.ts +2 -4
- package/src/server/api-client-core/apis/crm/postal-mail-types.generated.ts +830 -843
- package/src/server/api-client-core/apis/crm/postal-mail.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/products-types.generated.ts +829 -846
- package/src/server/api-client-core/apis/crm/products.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/projects-types.generated.ts +845 -875
- package/src/server/api-client-core/apis/crm/projects.generated.ts +47 -53
- package/src/server/api-client-core/apis/crm/properties-types.generated.ts +623 -626
- package/src/server/api-client-core/apis/crm/properties.generated.ts +33 -28
- package/src/server/api-client-core/apis/crm/property-validations-types.generated.ts +160 -174
- package/src/server/api-client-core/apis/crm/property-validations.generated.ts +2 -6
- package/src/server/api-client-core/apis/crm/public-app-crm-cards-types.generated.ts +467 -494
- package/src/server/api-client-core/apis/crm/public-app-crm-cards.generated.ts +7 -15
- package/src/server/api-client-core/apis/crm/public-app-feature-flags-types.generated.ts +166 -177
- package/src/server/api-client-core/apis/crm/public-app-feature-flags.generated.ts +6 -8
- package/src/server/api-client-core/apis/crm/quotes-types.generated.ts +829 -846
- package/src/server/api-client-core/apis/crm/quotes.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/schemas-types.generated.ts +613 -640
- package/src/server/api-client-core/apis/crm/schemas.generated.ts +8 -14
- package/src/server/api-client-core/apis/crm/services-types.generated.ts +832 -849
- package/src/server/api-client-core/apis/crm/services.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/tasks-types.generated.ts +829 -846
- package/src/server/api-client-core/apis/crm/tasks.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/taxes-types.generated.ts +829 -846
- package/src/server/api-client-core/apis/crm/taxes.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/tickets-types.generated.ts +848 -878
- package/src/server/api-client-core/apis/crm/tickets.generated.ts +47 -53
- package/src/server/api-client-core/apis/crm/timeline-types.generated.ts +144 -161
- package/src/server/api-client-core/apis/crm/timeline.generated.ts +6 -8
- package/src/server/api-client-core/apis/crm/transcriptions-types.generated.ts +149 -164
- package/src/server/api-client-core/apis/crm/transcriptions.generated.ts +22 -22
- package/src/server/api-client-core/apis/crm/users-types.generated.ts +829 -846
- package/src/server/api-client-core/apis/crm/users.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/video-conferencing-extension-types.generated.ts +29 -42
- package/src/server/api-client-core/apis/crm/video-conferencing-extension.generated.ts +17 -19
- package/src/server/api-client-core/apis/events/manage-event-definitions-types.generated.ts +1509 -1558
- package/src/server/api-client-core/apis/events/manage-event-definitions.generated.ts +55 -65
- package/src/server/api-client-core/apis/events/send-event-completions-types.generated.ts +51 -68
- package/src/server/api-client-core/apis/events/send-event-completions.generated.ts +10 -10
- package/src/server/api-client-core/apis/events-types.generated.ts +97 -110
- package/src/server/api-client-core/apis/events.generated.ts +2 -4
- package/src/server/api-client-core/apis/files-types.generated.ts +727 -757
- package/src/server/api-client-core/apis/files.generated.ts +3 -5
- package/src/server/api-client-core/apis/marketing/campaigns-public-api-types.generated.ts +1221 -1234
- package/src/server/api-client-core/apis/marketing/campaigns-public-api.generated.ts +45 -47
- package/src/server/api-client-core/apis/marketing/marketing-emails-types.generated.ts +3704 -3733
- package/src/server/api-client-core/apis/marketing/marketing-emails.generated.ts +44 -52
- package/src/server/api-client-core/apis/marketing/marketing-events-types.generated.ts +1787 -1848
- package/src/server/api-client-core/apis/marketing/marketing-events.generated.ts +236 -241
- package/src/server/api-client-core/apis/marketing/single-send-types.generated.ts +142 -155
- package/src/server/api-client-core/apis/marketing/single-send.generated.ts +2 -6
- package/src/server/api-client-core/apis/marketing/transactional-single-send-types.generated.ts +253 -269
- package/src/server/api-client-core/apis/marketing/transactional-single-send.generated.ts +32 -31
- package/src/server/api-client-core/apis/meta/origins-types.generated.ts +40 -56
- package/src/server/api-client-core/apis/meta/origins.generated.ts +2 -4
- package/src/server/api-client-core/apis/scheduler/meetings-types.generated.ts +1001 -1014
- package/src/server/api-client-core/apis/scheduler/meetings.generated.ts +6 -8
- package/src/server/api-client-core/apis/settings/multicurrency-types.generated.ts +1906 -1912
- package/src/server/api-client-core/apis/settings/multicurrency.generated.ts +64 -63
- package/src/server/api-client-core/apis/settings/tax-rates-types.generated.ts +71 -85
- package/src/server/api-client-core/apis/settings/tax-rates.generated.ts +2 -4
- package/src/server/api-client-core/apis/settings/user-provisioning-types.generated.ts +207 -257
- package/src/server/api-client-core/apis/settings/user-provisioning.generated.ts +8 -24
- package/src/server/api-client-core/apis/webhooks-journal-types.generated.ts +740 -771
- package/src/server/api-client-core/apis/webhooks-journal.generated.ts +47 -59
- package/src/server/api-client-core/apis/webhooks-types.generated.ts +1194 -1228
- package/src/server/api-client-core/apis/webhooks.generated.ts +52 -64
- package/src/server/api-client-core/client.ts +5 -1
- package/src/server/api-client-core/pagination.ts +2 -2
- package/src/server/api-client-core/plugins/fetch-transport.ts +70 -12
- package/src/server/api-client-core/types.ts +1 -1
- package/src/server/constants.ts +29 -4
- package/src/server/hono/hono-request-handler.ts +68 -27
- package/src/server/hono/hubspot-connect-routes/auth-complete.test.ts +394 -0
- package/src/server/hono/hubspot-connect-routes/{auth-callback.ts → auth-complete.ts} +81 -30
- package/src/server/hono/hubspot-connect-routes/auth-init-session.test.ts +114 -30
- package/src/server/hono/hubspot-connect-routes/auth-init-session.ts +35 -10
- package/src/server/hono/hubspot-connect-routes/auth-logout.test.ts +13 -0
- package/src/server/hono/hubspot-connect-routes/auth-logout.ts +39 -10
- package/src/server/hono/hubspot-connect-routes/auth-refresh.test.ts +6 -0
- package/src/server/hono/hubspot-connect-routes/auth-refresh.ts +24 -9
- package/src/server/hono/hubspot-connect-routes/cimd-public-routes.test.ts +7 -6
- package/src/server/hono/hubspot-connect-routes/cimd-public-routes.ts +5 -1
- package/src/server/hono/hubspot-connect-routes/hubspot-connect-routes.ts +11 -3
- package/src/server/hono/hubspot-connect-routes/load-hubspot-connect-routes-env.test.ts +17 -24
- package/src/server/hono/hubspot-connect-routes/load-hubspot-connect-routes-env.ts +8 -8
- package/src/server/hono/hubspot-connect-routes/utils.test.ts +16 -46
- package/src/server/hono/hubspot-connect-routes/utils.ts +61 -5
- package/src/server/hono/hubspot-connect-routes/whoami.ts +74 -0
- package/src/server/hono/types.ts +11 -10
- package/src/server/hono/utils/cookie-utils.ts +27 -2
- package/src/server/hono/utils/cors-middleware.test.ts +80 -0
- package/src/server/hono/utils/cors-middleware.ts +95 -0
- package/src/server/lovable/create-app-function-start.ts +4 -7
- package/src/server/lovable/hubspot-connect/run-hubspot-connect-lovable-server.ts +21 -16
- package/src/server/sanitize-request.ts +15 -12
- package/src/server/secure-start-core.ts +7 -6
- package/src/server/types.ts +2 -38
- package/src/server/utils/env-utils.test.ts +140 -12
- package/src/server/utils/env-utils.ts +80 -6
- package/src/server/utils/hubspot-dpop-auth-headers.test.ts +43 -0
- package/src/server/utils/hubspot-dpop-auth-headers.ts +48 -0
- package/src/shared/constants.ts +40 -3
- package/src/shared/wire-types.ts +49 -0
- package/dist/browser/HubSpotAppConnect-BW45gyDs.js.map +0 -1
- package/dist/browser/create-vctOhpX9.js.map +0 -1
- package/dist/server/hono/hubspot-connect-routes/auth-callback.js +0 -125
- package/dist/server/hono/hubspot-connect-routes/auth-callback.js.map +0 -1
- package/dist/server/proxy.js +0 -68
- package/dist/server/proxy.js.map +0 -1
- package/src/server/hono/hubspot-connect-routes/auth-callback.test.ts +0 -225
- package/src/server/proxy.test.ts +0 -80
- package/src/server/proxy.ts +0 -116
package/dist/server/api-client-core/apis/marketing/campaigns-public-api-types.generated.d.ts
CHANGED
|
@@ -1,913 +1,863 @@
|
|
|
1
1
|
import { Operation } from "../../types.js";
|
|
2
2
|
|
|
3
3
|
//#region src/server/api-client-core/apis/marketing/campaigns-public-api-types.generated.d.ts
|
|
4
|
-
declare namespace
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
data: Schemas.PublicCampaignInput;
|
|
140
|
-
}
|
|
141
|
-
type UpdateOutput = Schemas.PublicCampaign;
|
|
142
|
-
}
|
|
143
|
-
namespace Batch {
|
|
144
|
-
type CreateInput = Schemas.BatchInputPublicCampaignInput;
|
|
145
|
-
type CreateOutput = Schemas.BatchResponsePublicCampaign;
|
|
146
|
-
type DeleteInput = Schemas.BatchInputPublicCampaignDeleteInput;
|
|
147
|
-
type DeleteOutput = void;
|
|
148
|
-
interface GetInput {
|
|
149
|
-
data: Schemas.BatchInputPublicCampaignReadInput;
|
|
150
|
-
/**
|
|
151
|
-
* End date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period. If not provided, no asset metrics will be fetched.
|
|
152
|
-
* Example: 2024-01-27
|
|
153
|
-
*/
|
|
154
|
-
endDate?: string;
|
|
155
|
-
/**
|
|
156
|
-
* A comma-separated list of the properties to be returned in the response. If any of the specified properties has empty value on the requested object(s), they will be ignored and not returned in response. If this parameter is empty, the response will include an empty properties map.
|
|
157
|
-
* Example: hs_name, hs_campaign_status, hs_notes
|
|
158
|
-
*/
|
|
159
|
-
properties?: string[];
|
|
160
|
-
/**
|
|
161
|
-
* Start date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period. If not provided, no asset metrics will be fetched.
|
|
162
|
-
* Example: 2023-01-20
|
|
163
|
-
*/
|
|
164
|
-
startDate?: string;
|
|
165
|
-
}
|
|
166
|
-
type GetOutput = Schemas.BatchResponsePublicCampaignWithAssets;
|
|
167
|
-
type UpdateInput = Schemas.BatchInputPublicCampaignBatchUpdateItem;
|
|
168
|
-
type UpdateOutput = Schemas.BatchResponsePublicCampaign;
|
|
169
|
-
}
|
|
170
|
-
namespace Budget {
|
|
171
|
-
interface CreateInput {
|
|
172
|
-
/**
|
|
173
|
-
* The UUID of the campaign, required
|
|
174
|
-
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
175
|
-
*/
|
|
176
|
-
campaignGuid: string;
|
|
177
|
-
data: Schemas.PublicBudgetItemInput;
|
|
178
|
-
}
|
|
179
|
-
type CreateOutput = Schemas.PublicBudgetItem;
|
|
180
|
-
interface DeleteInput {
|
|
181
|
-
/**
|
|
182
|
-
* The ID of the budget item, required. Example: 352
|
|
183
|
-
*/
|
|
184
|
-
budgetId: number;
|
|
185
|
-
/**
|
|
186
|
-
* The UUID of the campaign, required
|
|
187
|
-
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
188
|
-
*/
|
|
189
|
-
campaignGuid: string;
|
|
190
|
-
}
|
|
191
|
-
type DeleteOutput = void;
|
|
192
|
-
interface GetInput {
|
|
193
|
-
/**
|
|
194
|
-
* The ID of the budget item, required. Example: 352
|
|
195
|
-
*/
|
|
196
|
-
budgetId: number;
|
|
197
|
-
/**
|
|
198
|
-
* The UUID of the campaign, required
|
|
199
|
-
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
200
|
-
*/
|
|
201
|
-
campaignGuid: string;
|
|
202
|
-
}
|
|
203
|
-
type GetOutput = Schemas.PublicBudgetItem;
|
|
204
|
-
interface GetTotalsInput {
|
|
205
|
-
/**
|
|
206
|
-
* The UUID of the campaign, required
|
|
207
|
-
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
208
|
-
*/
|
|
209
|
-
campaignGuid: string;
|
|
210
|
-
}
|
|
211
|
-
type GetTotalsOutput = Schemas.PublicBudgetTotals;
|
|
212
|
-
interface UpdateInput {
|
|
213
|
-
/**
|
|
214
|
-
* The ID of the budget item, required. Example: 352
|
|
215
|
-
*/
|
|
216
|
-
budgetId: number;
|
|
217
|
-
/**
|
|
218
|
-
* The UUID of the campaign, required
|
|
219
|
-
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
220
|
-
*/
|
|
221
|
-
campaignGuid: string;
|
|
222
|
-
data: Schemas.PublicBudgetItemInput;
|
|
223
|
-
}
|
|
224
|
-
type UpdateOutput = Schemas.PublicBudgetItem;
|
|
225
|
-
}
|
|
226
|
-
namespace Metrics {
|
|
227
|
-
interface GetAttributionMetricsInput {
|
|
228
|
-
/**
|
|
229
|
-
* The unique identifier of the campaign
|
|
230
|
-
*/
|
|
231
|
-
campaignGuid: string;
|
|
232
|
-
/**
|
|
233
|
-
* The end date for fetching attribution data, in YYYY-MM-DD format.
|
|
234
|
-
* Optional. Example: 2000-01-27
|
|
235
|
-
*/
|
|
236
|
-
endDate?: string;
|
|
237
|
-
/**
|
|
238
|
-
* The start date for fetching attribution data, in YYYY-MM-DD format.
|
|
239
|
-
* Optional. Example: 2000-01-20
|
|
240
|
-
*/
|
|
241
|
-
startDate?: string;
|
|
242
|
-
}
|
|
243
|
-
type GetAttributionMetricsOutput = Schemas.MetricsCounters;
|
|
244
|
-
interface GetRevenueAttributionInput {
|
|
245
|
-
/**
|
|
246
|
-
* The revenue attribution model used to calculate deal revenue credit. Defaults to LINEAR if not specified. Enum values: LINEAR, FIRST_INTERACTION, LAST_INTERACTION, FULL_PATH, U_SHAPED, W_SHAPED, TIME_DECAY, J_SHAPED, INVERSE_J_SHAPED
|
|
247
|
-
*/
|
|
248
|
-
attributionModel?: string;
|
|
249
|
-
/**
|
|
250
|
-
* The unique identifier of the campaign
|
|
251
|
-
*/
|
|
252
|
-
campaignGuid: string;
|
|
253
|
-
/**
|
|
254
|
-
* End date to fetch attribution data, YYYY-MM-DD
|
|
255
|
-
*/
|
|
256
|
-
endDate?: string;
|
|
257
|
-
/**
|
|
258
|
-
* Start date to fetch attribution data, YYYY-MM-DD
|
|
259
|
-
*/
|
|
260
|
-
startDate?: string;
|
|
261
|
-
}
|
|
262
|
-
type GetRevenueAttributionOutput = Schemas.RevenueAttributionAggregate;
|
|
263
|
-
interface ListContactIdsByTypeInput {
|
|
264
|
-
/**
|
|
265
|
-
* 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.
|
|
266
|
-
*/
|
|
267
|
-
after?: string;
|
|
268
|
-
/**
|
|
269
|
-
* The unique identifier of the campaign
|
|
270
|
-
*/
|
|
271
|
-
campaignGuid: string;
|
|
272
|
-
/**
|
|
273
|
-
* The type of contact to filter the list
|
|
274
|
-
*/
|
|
275
|
-
contactType: string;
|
|
276
|
-
/**
|
|
277
|
-
* The end date for fetching contact data, in YYYY-MM-DD format.
|
|
278
|
-
* Optional. Example: 2000-01-27
|
|
279
|
-
*/
|
|
280
|
-
endDate?: string;
|
|
281
|
-
/**
|
|
282
|
-
* The maximum number of results to display per page.
|
|
283
|
-
*/
|
|
284
|
-
limit?: number;
|
|
285
|
-
/**
|
|
286
|
-
* The start date for fetching contact data, in YYYY-MM-DD format.
|
|
287
|
-
* Optional. Example: 2000-01-20
|
|
288
|
-
*/
|
|
289
|
-
startDate?: string;
|
|
290
|
-
}
|
|
291
|
-
type ListContactIdsByTypeOutput = Schemas.CollectionResponseContactReferenceForwardPaging;
|
|
292
|
-
}
|
|
293
|
-
namespace Schemas {
|
|
294
|
-
interface BatchInputPublicCampaignBatchUpdateItem {
|
|
295
|
-
/**
|
|
296
|
-
* An array of PublicCampaignBatchUpdateItem objects, each containing the ID and properties to update for a specific campaign.
|
|
297
|
-
*/
|
|
298
|
-
inputs: Schemas.PublicCampaignBatchUpdateItem[];
|
|
299
|
-
}
|
|
300
|
-
interface BatchInputPublicCampaignDeleteInput {
|
|
301
|
-
/**
|
|
302
|
-
* An array of PublicCampaignDeleteInput objects, each specifying a campaign to be deleted. Each object must include the campaign's unique identifier.
|
|
303
|
-
*/
|
|
304
|
-
inputs: Schemas.PublicCampaignDeleteInput[];
|
|
305
|
-
}
|
|
306
|
-
interface BatchInputPublicCampaignInput {
|
|
307
|
-
/**
|
|
308
|
-
* An array of PublicCampaignInput objects, each representing the properties of a campaign to be created in the batch. This property is required.
|
|
309
|
-
*/
|
|
310
|
-
inputs: Schemas.PublicCampaignInput[];
|
|
311
|
-
}
|
|
312
|
-
interface BatchInputPublicCampaignReadInput {
|
|
313
|
-
/**
|
|
314
|
-
* An array of PublicCampaignReadInput objects, each containing the ID of a campaign to be read. This property is required.
|
|
315
|
-
*/
|
|
316
|
-
inputs: Schemas.PublicCampaignReadInput[];
|
|
317
|
-
}
|
|
318
|
-
interface BatchResponsePublicCampaign {
|
|
319
|
-
/**
|
|
320
|
-
* The date and time when the batch operation was completed, formatted as a date-time string.
|
|
321
|
-
*/
|
|
322
|
-
completedAt: string;
|
|
323
|
-
/**
|
|
324
|
-
* A map of related links associated with the batch operation.
|
|
325
|
-
*/
|
|
326
|
-
links?: Record<string, string>;
|
|
327
|
-
/**
|
|
328
|
-
* The date and time when the batch operation was requested, formatted as a date-time string.
|
|
329
|
-
*/
|
|
330
|
-
requestedAt?: string;
|
|
331
|
-
/**
|
|
332
|
-
* An array of results from the batch operation, each item representing a public campaign.
|
|
333
|
-
*/
|
|
334
|
-
results: Schemas.PublicCampaign[];
|
|
335
|
-
/**
|
|
336
|
-
* The date and time when the batch operation started, formatted as a date-time string.
|
|
337
|
-
*/
|
|
338
|
-
startedAt: string;
|
|
339
|
-
/**
|
|
340
|
-
* The current status of the batch operation, with possible values: CANCELED, COMPLETE, PENDING, PROCESSING.
|
|
341
|
-
*/
|
|
342
|
-
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
343
|
-
}
|
|
344
|
-
interface BatchResponsePublicCampaignWithAssets {
|
|
345
|
-
/**
|
|
346
|
-
* The timestamp when the batch request processing was completed.
|
|
347
|
-
*/
|
|
348
|
-
completedAt: string;
|
|
349
|
-
/**
|
|
350
|
-
* A collection of URLs linking to related resources or documentation.
|
|
351
|
-
*/
|
|
352
|
-
links?: Record<string, string>;
|
|
353
|
-
/**
|
|
354
|
-
* The timestamp when the batch request was initially made.
|
|
355
|
-
*/
|
|
356
|
-
requestedAt?: string;
|
|
357
|
-
/**
|
|
358
|
-
* An array of results from the batch operation, each representing a public campaign with assets.
|
|
359
|
-
*/
|
|
360
|
-
results: Schemas.PublicCampaignWithAssets[];
|
|
361
|
-
/**
|
|
362
|
-
* The timestamp when the processing of the batch request began.
|
|
363
|
-
*/
|
|
364
|
-
startedAt: string;
|
|
365
|
-
/**
|
|
366
|
-
* The current processing status of the batch operation, with possible values: CANCELED, COMPLETE, PENDING, PROCESSING.
|
|
367
|
-
*/
|
|
368
|
-
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
369
|
-
}
|
|
370
|
-
interface CollectionResponseContactReferenceForwardPaging {
|
|
371
|
-
paging?: Schemas.ForwardPaging;
|
|
372
|
-
/**
|
|
373
|
-
* An array of contact references, each containing an identifier for a contact.
|
|
374
|
-
*/
|
|
375
|
-
results: Schemas.ContactReference[];
|
|
376
|
-
}
|
|
377
|
-
interface CollectionResponsePublicCampaignAsset {
|
|
378
|
-
paging?: Schemas.Paging;
|
|
379
|
-
/**
|
|
380
|
-
* An array of public campaign assets. Each item in the array is an object representing a campaign asset.
|
|
381
|
-
*/
|
|
382
|
-
results: Schemas.PublicCampaignAsset[];
|
|
383
|
-
}
|
|
384
|
-
interface CollectionResponsePublicCampaignAssetForwardPaging {
|
|
385
|
-
paging?: Schemas.ForwardPaging;
|
|
386
|
-
/**
|
|
387
|
-
* An array of public campaign assets. Each item in the array is a reference to a PublicCampaignAsset object.
|
|
388
|
-
*/
|
|
389
|
-
results: Schemas.PublicCampaignAsset[];
|
|
390
|
-
}
|
|
391
|
-
interface CollectionResponseWithTotalPublicCampaign {
|
|
392
|
-
paging?: Schemas.Paging;
|
|
393
|
-
/**
|
|
394
|
-
* An array of PublicCampaign objects, each representing a campaign with its associated properties.
|
|
395
|
-
*/
|
|
396
|
-
results: Schemas.PublicCampaign[];
|
|
397
|
-
/**
|
|
398
|
-
* An integer representing the total number of public campaigns available.
|
|
399
|
-
*/
|
|
400
|
-
total: number;
|
|
401
|
-
}
|
|
402
|
-
interface ContactReference {
|
|
403
|
-
/**
|
|
404
|
-
* Unique identifier for the contact.
|
|
405
|
-
*/
|
|
406
|
-
id: string;
|
|
407
|
-
}
|
|
408
|
-
interface ForwardPaging {
|
|
409
|
-
next?: Schemas.NextPage;
|
|
410
|
-
}
|
|
411
|
-
interface MetricsCounters {
|
|
412
|
-
/**
|
|
413
|
-
* The number of contacts influenced by the campaign.
|
|
414
|
-
*/
|
|
415
|
-
influencedContacts: number;
|
|
416
|
-
/**
|
|
417
|
-
* The number of new contacts attributed to the campaign as the first touchpoint.
|
|
418
|
-
*/
|
|
419
|
-
newContactsFirstTouch: number;
|
|
420
|
-
/**
|
|
421
|
-
* The number of new contacts attributed to the campaign as the last touchpoint.
|
|
422
|
-
*/
|
|
423
|
-
newContactsLastTouch: number;
|
|
424
|
-
/**
|
|
425
|
-
* The total number of sessions generated by the campaign.
|
|
426
|
-
*/
|
|
427
|
-
sessions: number;
|
|
428
|
-
}
|
|
429
|
-
/**
|
|
430
|
-
* Specifies the paging information needed to retrieve the next set of results in a paginated API response
|
|
431
|
-
*/
|
|
432
|
-
interface NextPage {
|
|
433
|
-
/**
|
|
434
|
-
* A string token used as a cursor to retrieve the next page of results.
|
|
435
|
-
*/
|
|
436
|
-
after: string;
|
|
437
|
-
/**
|
|
438
|
-
* A string URL that provides the link to the next page of results.
|
|
439
|
-
*/
|
|
440
|
-
link?: string;
|
|
441
|
-
}
|
|
442
|
-
interface Paging {
|
|
443
|
-
next?: Schemas.NextPage;
|
|
444
|
-
prev?: Schemas.PreviousPage;
|
|
445
|
-
}
|
|
446
|
-
/**
|
|
447
|
-
* specifies the paging information needed to retrieve the previous set of results in a paginated API response
|
|
448
|
-
*/
|
|
449
|
-
interface PreviousPage {
|
|
450
|
-
/**
|
|
451
|
-
* A string token that indicates the position in the list before the current page of results.
|
|
452
|
-
*/
|
|
453
|
-
before: string;
|
|
454
|
-
/**
|
|
455
|
-
* A string containing the URL link to the previous page of results.
|
|
456
|
-
*/
|
|
457
|
-
link?: string;
|
|
458
|
-
}
|
|
459
|
-
interface PublicBudgetItem {
|
|
460
|
-
/**
|
|
461
|
-
* The monetary amount allocated for the budget item.
|
|
462
|
-
*/
|
|
463
|
-
amount: number;
|
|
464
|
-
/**
|
|
465
|
-
* The timestamp when the budget item was created.
|
|
466
|
-
*/
|
|
467
|
-
createdAt: number;
|
|
468
|
-
/**
|
|
469
|
-
* A description of the budget item.
|
|
470
|
-
*/
|
|
471
|
-
description?: string;
|
|
472
|
-
/**
|
|
473
|
-
* The unique identifier for the budget item.
|
|
474
|
-
*/
|
|
475
|
-
id: string;
|
|
476
|
-
/**
|
|
477
|
-
* The name of the budget item.
|
|
478
|
-
*/
|
|
479
|
-
name: string;
|
|
480
|
-
/**
|
|
481
|
-
* The order of the budget item, indicating its sequence based on creation date.
|
|
482
|
-
*/
|
|
483
|
-
order: number;
|
|
484
|
-
/**
|
|
485
|
-
* The timestamp when the budget item was last updated.
|
|
486
|
-
*/
|
|
487
|
-
updatedAt: number;
|
|
488
|
-
}
|
|
489
|
-
interface PublicBudgetItemInput {
|
|
490
|
-
/**
|
|
491
|
-
* The monetary value assigned to the budget item.
|
|
492
|
-
*/
|
|
493
|
-
amount: number;
|
|
494
|
-
/**
|
|
495
|
-
* A detailed explanation or notes about the budget item.
|
|
496
|
-
*/
|
|
497
|
-
description?: string;
|
|
498
|
-
/**
|
|
499
|
-
* The name of the budget item.
|
|
500
|
-
*/
|
|
501
|
-
name: string;
|
|
502
|
-
/**
|
|
503
|
-
* The sequence number indicating the order of the budget item.
|
|
504
|
-
*/
|
|
505
|
-
order: number;
|
|
506
|
-
}
|
|
507
|
-
interface PublicBudgetTotals {
|
|
508
|
-
/**
|
|
509
|
-
* An array of budget items associated with the campaign. Each item is represented by a PublicBudgetItem object.
|
|
510
|
-
*/
|
|
511
|
-
budgetItems: Schemas.PublicBudgetItem[];
|
|
512
|
-
/**
|
|
513
|
-
* The total budget allocated for the campaign.
|
|
514
|
-
*/
|
|
515
|
-
budgetTotal?: number;
|
|
516
|
-
/**
|
|
517
|
-
* The currency code used for the budget and spend amounts, following ISO 4217 standards.
|
|
518
|
-
*/
|
|
519
|
-
currencyCode: 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XUA' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL';
|
|
520
|
-
/**
|
|
521
|
-
* The remaining budget available for the campaign after accounting for all spend items.
|
|
522
|
-
*/
|
|
523
|
-
remainingBudget?: number;
|
|
524
|
-
/**
|
|
525
|
-
* An array of spend items associated with the campaign. Each item is represented by a PublicSpendItem object.
|
|
526
|
-
*/
|
|
527
|
-
spendItems: Schemas.PublicSpendItem[];
|
|
528
|
-
/**
|
|
529
|
-
* The total amount spent across all spend items in the campaign.
|
|
530
|
-
*/
|
|
531
|
-
spendTotal?: number;
|
|
532
|
-
}
|
|
533
|
-
interface PublicBusinessUnit {
|
|
534
|
-
/**
|
|
535
|
-
* The unique identifier for the business unit, represented as an integer.
|
|
536
|
-
*/
|
|
537
|
-
id: number;
|
|
538
|
-
}
|
|
539
|
-
interface PublicCampaign {
|
|
540
|
-
/**
|
|
541
|
-
* An array of business units associated with the campaign, each represented by a PublicBusinessUnit object.
|
|
542
|
-
*/
|
|
543
|
-
businessUnits: Schemas.PublicBusinessUnit[];
|
|
544
|
-
/**
|
|
545
|
-
* The date and time when the campaign was created, formatted as a date-time string.
|
|
546
|
-
*/
|
|
547
|
-
createdAt: string;
|
|
548
|
-
/**
|
|
549
|
-
* The unique identifier for the campaign.
|
|
550
|
-
*/
|
|
551
|
-
id: string;
|
|
552
|
-
/**
|
|
553
|
-
* A collection of key-value pairs representing additional properties of the campaign.
|
|
554
|
-
*/
|
|
555
|
-
properties: Record<string, string>;
|
|
556
|
-
/**
|
|
557
|
-
* The date and time when the campaign was last updated, formatted as a date-time string.
|
|
558
|
-
*/
|
|
559
|
-
updatedAt: string;
|
|
560
|
-
}
|
|
561
|
-
interface PublicCampaignAsset {
|
|
562
|
-
/**
|
|
563
|
-
* The unique identifier for the campaign asset.
|
|
564
|
-
*/
|
|
565
|
-
id: string;
|
|
566
|
-
/**
|
|
567
|
-
* A collection of metrics associated with the campaign asset, represented as key-value pairs.
|
|
568
|
-
*/
|
|
569
|
-
metrics?: Record<string, number>;
|
|
570
|
-
/**
|
|
571
|
-
* The name of the campaign asset.
|
|
572
|
-
*/
|
|
573
|
-
name?: string;
|
|
574
|
-
}
|
|
575
|
-
interface PublicCampaignBatchUpdateItem {
|
|
576
|
-
/**
|
|
577
|
-
* The unique identifier for the campaign to be updated.
|
|
578
|
-
*/
|
|
579
|
-
id: string;
|
|
580
|
-
/**
|
|
581
|
-
* A set of key-value pairs representing the properties to be updated for the campaign.
|
|
582
|
-
*/
|
|
583
|
-
properties: Record<string, string>;
|
|
584
|
-
}
|
|
585
|
-
interface PublicCampaignDeleteInput {
|
|
586
|
-
/**
|
|
587
|
-
* The unique identifier for the campaign to be deleted.
|
|
588
|
-
*/
|
|
589
|
-
id: string;
|
|
590
|
-
}
|
|
591
|
-
interface PublicCampaignInput {
|
|
592
|
-
/**
|
|
593
|
-
* A collection of key-value pairs representing the properties of the campaign. Each key is a property name, and the corresponding value is the property's value.
|
|
594
|
-
*/
|
|
595
|
-
properties: Record<string, string>;
|
|
596
|
-
}
|
|
597
|
-
interface PublicCampaignReadInput {
|
|
598
|
-
/**
|
|
599
|
-
* The unique identifier for a campaign.
|
|
600
|
-
*/
|
|
601
|
-
id: string;
|
|
602
|
-
}
|
|
603
|
-
interface PublicCampaignWithAssets {
|
|
604
|
-
/**
|
|
605
|
-
* Contains the assets associated with the campaign, each represented as a collection of campaign assets.
|
|
606
|
-
*/
|
|
607
|
-
assets: Record<string, Schemas.CollectionResponsePublicCampaignAsset>;
|
|
608
|
-
/**
|
|
609
|
-
* An array of business units associated with the campaign, each represented by a PublicBusinessUnit object.
|
|
610
|
-
*/
|
|
611
|
-
businessUnits: Schemas.PublicBusinessUnit[];
|
|
612
|
-
/**
|
|
613
|
-
* The date and time when the campaign was created, formatted as a date-time string.
|
|
614
|
-
*/
|
|
615
|
-
createdAt: string;
|
|
616
|
-
/**
|
|
617
|
-
* The unique identifier for the campaign.
|
|
618
|
-
*/
|
|
619
|
-
id: string;
|
|
620
|
-
/**
|
|
621
|
-
* A map of key-value pairs representing the properties of the campaign.
|
|
622
|
-
*/
|
|
623
|
-
properties: Record<string, string>;
|
|
624
|
-
/**
|
|
625
|
-
* The date and time when the campaign was last updated, formatted as a date-time string.
|
|
626
|
-
*/
|
|
627
|
-
updatedAt: string;
|
|
628
|
-
}
|
|
629
|
-
interface PublicSpendItem {
|
|
630
|
-
/**
|
|
631
|
-
* The monetary value associated with the spend item.
|
|
632
|
-
*/
|
|
633
|
-
amount: number;
|
|
634
|
-
/**
|
|
635
|
-
* The timestamp indicating when the spend item was created.
|
|
636
|
-
*/
|
|
637
|
-
createdAt: number;
|
|
638
|
-
/**
|
|
639
|
-
* A detailed explanation or notes about the spend item.
|
|
640
|
-
*/
|
|
641
|
-
description?: string;
|
|
642
|
-
/**
|
|
643
|
-
* Unique identifier for the spend item.
|
|
644
|
-
*/
|
|
645
|
-
id: string;
|
|
646
|
-
/**
|
|
647
|
-
* The name assigned to the spend item.
|
|
648
|
-
*/
|
|
649
|
-
name: string;
|
|
650
|
-
/**
|
|
651
|
-
* The sequence order of the spend item, where 0 is the oldest.
|
|
652
|
-
*/
|
|
653
|
-
order: number;
|
|
654
|
-
/**
|
|
655
|
-
* The timestamp indicating when the spend item was last updated.
|
|
656
|
-
*/
|
|
657
|
-
updatedAt: number;
|
|
658
|
-
}
|
|
659
|
-
interface PublicSpendItemInput {
|
|
660
|
-
/**
|
|
661
|
-
* The monetary value of the spend item.
|
|
662
|
-
*/
|
|
663
|
-
amount: number;
|
|
664
|
-
/**
|
|
665
|
-
* A brief description of the spend item.
|
|
666
|
-
*/
|
|
667
|
-
description?: string;
|
|
668
|
-
/**
|
|
669
|
-
* The name of the spend item.
|
|
670
|
-
*/
|
|
671
|
-
name: string;
|
|
672
|
-
/**
|
|
673
|
-
* The sequence number indicating the order of the spend item.
|
|
674
|
-
*/
|
|
675
|
-
order: number;
|
|
676
|
-
}
|
|
677
|
-
interface RevenueAttributionAggregate {
|
|
678
|
-
/**
|
|
679
|
-
* The number of contacts attributed to the campaign.
|
|
680
|
-
*/
|
|
681
|
-
contactsNumber?: number;
|
|
682
|
-
/**
|
|
683
|
-
* The currency code used for the revenue attribution, with accepted values including AED, AFN, ALL, and others.
|
|
684
|
-
*/
|
|
685
|
-
currencyCode?: 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XUA' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL';
|
|
686
|
-
/**
|
|
687
|
-
* The total amount of deals attributed to the campaign.
|
|
688
|
-
*/
|
|
689
|
-
dealAmount?: number;
|
|
690
|
-
/**
|
|
691
|
-
* The number of deals attributed to the campaign.
|
|
692
|
-
*/
|
|
693
|
-
dealsNumber?: number;
|
|
694
|
-
/**
|
|
695
|
-
* The total revenue amount attributed to the campaign.
|
|
696
|
-
*/
|
|
697
|
-
revenueAmount?: number;
|
|
698
|
-
}
|
|
699
|
-
}
|
|
700
|
-
namespace Spend {
|
|
701
|
-
interface CreateInput {
|
|
702
|
-
/**
|
|
703
|
-
* The UUID of the campaign, required
|
|
704
|
-
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
705
|
-
*/
|
|
706
|
-
campaignGuid: string;
|
|
707
|
-
data: Schemas.PublicSpendItemInput;
|
|
708
|
-
}
|
|
709
|
-
type CreateOutput = Schemas.PublicSpendItem;
|
|
710
|
-
interface DeleteInput {
|
|
711
|
-
/**
|
|
712
|
-
* The UUID of the campaign, required
|
|
713
|
-
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
714
|
-
*/
|
|
715
|
-
campaignGuid: string;
|
|
716
|
-
/**
|
|
717
|
-
* The ID of the spend item, required. Example: 491
|
|
718
|
-
*/
|
|
719
|
-
spendId: number;
|
|
720
|
-
}
|
|
721
|
-
type DeleteOutput = void;
|
|
722
|
-
interface GetInput {
|
|
723
|
-
/**
|
|
724
|
-
* The UUID of the campaign, required
|
|
725
|
-
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
726
|
-
*/
|
|
727
|
-
campaignGuid: string;
|
|
728
|
-
/**
|
|
729
|
-
* The ID of the spend item, required. Example: 491
|
|
730
|
-
*/
|
|
731
|
-
spendId: number;
|
|
732
|
-
}
|
|
733
|
-
type GetOutput = Schemas.PublicSpendItem;
|
|
734
|
-
interface UpdateInput {
|
|
735
|
-
/**
|
|
736
|
-
* The UUID of the campaign, required
|
|
737
|
-
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
738
|
-
*/
|
|
739
|
-
campaignGuid: string;
|
|
740
|
-
data: Schemas.PublicSpendItemInput;
|
|
741
|
-
/**
|
|
742
|
-
* The ID of the spend item, required. Example: 491
|
|
743
|
-
*/
|
|
744
|
-
spendId: number;
|
|
745
|
-
}
|
|
746
|
-
type UpdateOutput = Schemas.PublicSpendItem;
|
|
4
|
+
declare namespace MarketingCampaignsPublicApiSchemas {
|
|
5
|
+
interface BatchInputPublicCampaignBatchUpdateItem {
|
|
6
|
+
/**
|
|
7
|
+
* An array of PublicCampaignBatchUpdateItem objects, each containing the ID and properties to update for a specific campaign.
|
|
8
|
+
*/
|
|
9
|
+
inputs: PublicCampaignBatchUpdateItem[];
|
|
10
|
+
}
|
|
11
|
+
interface BatchInputPublicCampaignDeleteInput {
|
|
12
|
+
/**
|
|
13
|
+
* An array of PublicCampaignDeleteInput objects, each specifying a campaign to be deleted. Each object must include the campaign's unique identifier.
|
|
14
|
+
*/
|
|
15
|
+
inputs: PublicCampaignDeleteInput[];
|
|
16
|
+
}
|
|
17
|
+
interface BatchInputPublicCampaignInput {
|
|
18
|
+
/**
|
|
19
|
+
* An array of PublicCampaignInput objects, each representing the properties of a campaign to be created in the batch. This property is required.
|
|
20
|
+
*/
|
|
21
|
+
inputs: PublicCampaignInput[];
|
|
22
|
+
}
|
|
23
|
+
interface BatchInputPublicCampaignReadInput {
|
|
24
|
+
/**
|
|
25
|
+
* An array of PublicCampaignReadInput objects, each containing the ID of a campaign to be read. This property is required.
|
|
26
|
+
*/
|
|
27
|
+
inputs: PublicCampaignReadInput[];
|
|
28
|
+
}
|
|
29
|
+
interface BatchResponsePublicCampaign {
|
|
30
|
+
/**
|
|
31
|
+
* The date and time when the batch operation was completed, formatted as a date-time string.
|
|
32
|
+
*/
|
|
33
|
+
completedAt: string;
|
|
34
|
+
/**
|
|
35
|
+
* A map of related links associated with the batch operation.
|
|
36
|
+
*/
|
|
37
|
+
links?: Record<string, string>;
|
|
38
|
+
/**
|
|
39
|
+
* The date and time when the batch operation was requested, formatted as a date-time string.
|
|
40
|
+
*/
|
|
41
|
+
requestedAt?: string;
|
|
42
|
+
/**
|
|
43
|
+
* An array of results from the batch operation, each item representing a public campaign.
|
|
44
|
+
*/
|
|
45
|
+
results: PublicCampaign[];
|
|
46
|
+
/**
|
|
47
|
+
* The date and time when the batch operation started, formatted as a date-time string.
|
|
48
|
+
*/
|
|
49
|
+
startedAt: string;
|
|
50
|
+
/**
|
|
51
|
+
* The current status of the batch operation, with possible values: CANCELED, COMPLETE, PENDING, PROCESSING.
|
|
52
|
+
*/
|
|
53
|
+
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
54
|
+
}
|
|
55
|
+
interface BatchResponsePublicCampaignWithAssets {
|
|
56
|
+
/**
|
|
57
|
+
* The timestamp when the batch request processing was completed.
|
|
58
|
+
*/
|
|
59
|
+
completedAt: string;
|
|
60
|
+
/**
|
|
61
|
+
* A collection of URLs linking to related resources or documentation.
|
|
62
|
+
*/
|
|
63
|
+
links?: Record<string, string>;
|
|
64
|
+
/**
|
|
65
|
+
* The timestamp when the batch request was initially made.
|
|
66
|
+
*/
|
|
67
|
+
requestedAt?: string;
|
|
68
|
+
/**
|
|
69
|
+
* An array of results from the batch operation, each representing a public campaign with assets.
|
|
70
|
+
*/
|
|
71
|
+
results: PublicCampaignWithAssets[];
|
|
72
|
+
/**
|
|
73
|
+
* The timestamp when the processing of the batch request began.
|
|
74
|
+
*/
|
|
75
|
+
startedAt: string;
|
|
76
|
+
/**
|
|
77
|
+
* The current processing status of the batch operation, with possible values: CANCELED, COMPLETE, PENDING, PROCESSING.
|
|
78
|
+
*/
|
|
79
|
+
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
80
|
+
}
|
|
81
|
+
interface CollectionResponseContactReferenceForwardPaging {
|
|
82
|
+
paging?: ForwardPaging;
|
|
83
|
+
/**
|
|
84
|
+
* An array of contact references, each containing an identifier for a contact.
|
|
85
|
+
*/
|
|
86
|
+
results: ContactReference[];
|
|
87
|
+
}
|
|
88
|
+
interface CollectionResponsePublicCampaignAsset {
|
|
89
|
+
paging?: Paging;
|
|
90
|
+
/**
|
|
91
|
+
* An array of public campaign assets. Each item in the array is an object representing a campaign asset.
|
|
92
|
+
*/
|
|
93
|
+
results: PublicCampaignAsset[];
|
|
94
|
+
}
|
|
95
|
+
interface CollectionResponsePublicCampaignAssetForwardPaging {
|
|
96
|
+
paging?: ForwardPaging;
|
|
97
|
+
/**
|
|
98
|
+
* An array of public campaign assets. Each item in the array is a reference to a PublicCampaignAsset object.
|
|
99
|
+
*/
|
|
100
|
+
results: PublicCampaignAsset[];
|
|
101
|
+
}
|
|
102
|
+
interface CollectionResponseWithTotalPublicCampaign {
|
|
103
|
+
paging?: Paging;
|
|
104
|
+
/**
|
|
105
|
+
* An array of PublicCampaign objects, each representing a campaign with its associated properties.
|
|
106
|
+
*/
|
|
107
|
+
results: PublicCampaign[];
|
|
108
|
+
/**
|
|
109
|
+
* An integer representing the total number of public campaigns available.
|
|
110
|
+
*/
|
|
111
|
+
total: number;
|
|
112
|
+
}
|
|
113
|
+
interface ContactReference {
|
|
114
|
+
/**
|
|
115
|
+
* Unique identifier for the contact.
|
|
116
|
+
*/
|
|
117
|
+
id: string;
|
|
118
|
+
}
|
|
119
|
+
interface ForwardPaging {
|
|
120
|
+
next?: NextPage;
|
|
121
|
+
}
|
|
122
|
+
interface MetricsCounters {
|
|
123
|
+
/**
|
|
124
|
+
* The number of contacts influenced by the campaign.
|
|
125
|
+
*/
|
|
126
|
+
influencedContacts: number;
|
|
127
|
+
/**
|
|
128
|
+
* The number of new contacts attributed to the campaign as the first touchpoint.
|
|
129
|
+
*/
|
|
130
|
+
newContactsFirstTouch: number;
|
|
131
|
+
/**
|
|
132
|
+
* The number of new contacts attributed to the campaign as the last touchpoint.
|
|
133
|
+
*/
|
|
134
|
+
newContactsLastTouch: number;
|
|
135
|
+
/**
|
|
136
|
+
* The total number of sessions generated by the campaign.
|
|
137
|
+
*/
|
|
138
|
+
sessions: number;
|
|
747
139
|
}
|
|
748
140
|
/**
|
|
749
|
-
*
|
|
750
|
-
* ```ts
|
|
751
|
-
* import { marketingCampaignsPublicApi } from '@hubspot/api-client-core';
|
|
752
|
-
* client.send(marketingCampaignsPublicApi.assets.delete(input));
|
|
753
|
-
* ```
|
|
141
|
+
* Specifies the paging information needed to retrieve the next set of results in a paginated API response
|
|
754
142
|
*/
|
|
755
|
-
interface
|
|
143
|
+
interface NextPage {
|
|
756
144
|
/**
|
|
757
|
-
*
|
|
758
|
-
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}/assets/{assetType}/{assetId}
|
|
759
|
-
* @apiMethod DELETE
|
|
760
|
-
* @requiredScopes campaigns-write
|
|
145
|
+
* A string token used as a cursor to retrieve the next page of results.
|
|
761
146
|
*/
|
|
762
|
-
|
|
147
|
+
after: string;
|
|
763
148
|
/**
|
|
764
|
-
*
|
|
765
|
-
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}/assets/{assetType}
|
|
766
|
-
* @apiMethod GET
|
|
767
|
-
* @requiredScopes campaigns-access
|
|
149
|
+
* A string URL that provides the link to the next page of results.
|
|
768
150
|
*/
|
|
769
|
-
|
|
151
|
+
link?: string;
|
|
152
|
+
}
|
|
153
|
+
interface Paging {
|
|
154
|
+
next?: NextPage;
|
|
155
|
+
prev?: PreviousPage;
|
|
156
|
+
}
|
|
157
|
+
/**
|
|
158
|
+
* specifies the paging information needed to retrieve the previous set of results in a paginated API response
|
|
159
|
+
*/
|
|
160
|
+
interface PreviousPage {
|
|
770
161
|
/**
|
|
771
|
-
*
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
162
|
+
* A string token that indicates the position in the list before the current page of results.
|
|
163
|
+
*/
|
|
164
|
+
before: string;
|
|
165
|
+
/**
|
|
166
|
+
* A string containing the URL link to the previous page of results.
|
|
167
|
+
*/
|
|
168
|
+
link?: string;
|
|
169
|
+
}
|
|
170
|
+
interface PublicBudgetItem {
|
|
171
|
+
/**
|
|
172
|
+
* The monetary amount allocated for the budget item.
|
|
173
|
+
*/
|
|
174
|
+
amount: number;
|
|
175
|
+
/**
|
|
176
|
+
* The timestamp when the budget item was created.
|
|
177
|
+
*/
|
|
178
|
+
createdAt: number;
|
|
179
|
+
/**
|
|
180
|
+
* A description of the budget item.
|
|
181
|
+
*/
|
|
182
|
+
description?: string;
|
|
183
|
+
/**
|
|
184
|
+
* The unique identifier for the budget item.
|
|
185
|
+
*/
|
|
186
|
+
id: string;
|
|
187
|
+
/**
|
|
188
|
+
* The name of the budget item.
|
|
189
|
+
*/
|
|
190
|
+
name: string;
|
|
191
|
+
/**
|
|
192
|
+
* The order of the budget item, indicating its sequence based on creation date.
|
|
193
|
+
*/
|
|
194
|
+
order: number;
|
|
195
|
+
/**
|
|
196
|
+
* The timestamp when the budget item was last updated.
|
|
197
|
+
*/
|
|
198
|
+
updatedAt: number;
|
|
199
|
+
}
|
|
200
|
+
interface PublicBudgetItemInput {
|
|
201
|
+
/**
|
|
202
|
+
* The monetary value assigned to the budget item.
|
|
203
|
+
*/
|
|
204
|
+
amount: number;
|
|
205
|
+
/**
|
|
206
|
+
* A detailed explanation or notes about the budget item.
|
|
207
|
+
*/
|
|
208
|
+
description?: string;
|
|
209
|
+
/**
|
|
210
|
+
* The name of the budget item.
|
|
211
|
+
*/
|
|
212
|
+
name: string;
|
|
213
|
+
/**
|
|
214
|
+
* The sequence number indicating the order of the budget item.
|
|
215
|
+
*/
|
|
216
|
+
order: number;
|
|
217
|
+
}
|
|
218
|
+
interface PublicBudgetTotals {
|
|
219
|
+
/**
|
|
220
|
+
* An array of budget items associated with the campaign. Each item is represented by a PublicBudgetItem object.
|
|
221
|
+
*/
|
|
222
|
+
budgetItems: PublicBudgetItem[];
|
|
223
|
+
/**
|
|
224
|
+
* The total budget allocated for the campaign.
|
|
225
|
+
*/
|
|
226
|
+
budgetTotal?: number;
|
|
227
|
+
/**
|
|
228
|
+
* The currency code used for the budget and spend amounts, following ISO 4217 standards.
|
|
229
|
+
*/
|
|
230
|
+
currencyCode: 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XUA' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL';
|
|
231
|
+
/**
|
|
232
|
+
* The remaining budget available for the campaign after accounting for all spend items.
|
|
233
|
+
*/
|
|
234
|
+
remainingBudget?: number;
|
|
235
|
+
/**
|
|
236
|
+
* An array of spend items associated with the campaign. Each item is represented by a PublicSpendItem object.
|
|
237
|
+
*/
|
|
238
|
+
spendItems: PublicSpendItem[];
|
|
239
|
+
/**
|
|
240
|
+
* The total amount spent across all spend items in the campaign.
|
|
241
|
+
*/
|
|
242
|
+
spendTotal?: number;
|
|
243
|
+
}
|
|
244
|
+
interface PublicBusinessUnit {
|
|
245
|
+
/**
|
|
246
|
+
* The unique identifier for the business unit, represented as an integer.
|
|
247
|
+
*/
|
|
248
|
+
id: number;
|
|
249
|
+
}
|
|
250
|
+
interface PublicCampaign {
|
|
251
|
+
/**
|
|
252
|
+
* An array of business units associated with the campaign, each represented by a PublicBusinessUnit object.
|
|
253
|
+
*/
|
|
254
|
+
businessUnits: PublicBusinessUnit[];
|
|
255
|
+
/**
|
|
256
|
+
* The date and time when the campaign was created, formatted as a date-time string.
|
|
257
|
+
*/
|
|
258
|
+
createdAt: string;
|
|
259
|
+
/**
|
|
260
|
+
* The unique identifier for the campaign.
|
|
261
|
+
*/
|
|
262
|
+
id: string;
|
|
263
|
+
/**
|
|
264
|
+
* A collection of key-value pairs representing additional properties of the campaign.
|
|
265
|
+
*/
|
|
266
|
+
properties: Record<string, string>;
|
|
267
|
+
/**
|
|
268
|
+
* The date and time when the campaign was last updated, formatted as a date-time string.
|
|
269
|
+
*/
|
|
270
|
+
updatedAt: string;
|
|
271
|
+
}
|
|
272
|
+
interface PublicCampaignAsset {
|
|
273
|
+
/**
|
|
274
|
+
* The unique identifier for the campaign asset.
|
|
275
|
+
*/
|
|
276
|
+
id: string;
|
|
277
|
+
/**
|
|
278
|
+
* A collection of metrics associated with the campaign asset, represented as key-value pairs.
|
|
279
|
+
*/
|
|
280
|
+
metrics?: Record<string, number>;
|
|
281
|
+
/**
|
|
282
|
+
* The name of the campaign asset.
|
|
283
|
+
*/
|
|
284
|
+
name?: string;
|
|
285
|
+
}
|
|
286
|
+
interface PublicCampaignBatchUpdateItem {
|
|
287
|
+
/**
|
|
288
|
+
* The unique identifier for the campaign to be updated.
|
|
289
|
+
*/
|
|
290
|
+
id: string;
|
|
291
|
+
/**
|
|
292
|
+
* A set of key-value pairs representing the properties to be updated for the campaign.
|
|
293
|
+
*/
|
|
294
|
+
properties: Record<string, string>;
|
|
295
|
+
}
|
|
296
|
+
interface PublicCampaignDeleteInput {
|
|
297
|
+
/**
|
|
298
|
+
* The unique identifier for the campaign to be deleted.
|
|
299
|
+
*/
|
|
300
|
+
id: string;
|
|
301
|
+
}
|
|
302
|
+
interface PublicCampaignInput {
|
|
303
|
+
/**
|
|
304
|
+
* A collection of key-value pairs representing the properties of the campaign. Each key is a property name, and the corresponding value is the property's value.
|
|
305
|
+
*/
|
|
306
|
+
properties: Record<string, string>;
|
|
307
|
+
}
|
|
308
|
+
interface PublicCampaignReadInput {
|
|
309
|
+
/**
|
|
310
|
+
* The unique identifier for a campaign.
|
|
311
|
+
*/
|
|
312
|
+
id: string;
|
|
313
|
+
}
|
|
314
|
+
interface PublicCampaignWithAssets {
|
|
315
|
+
/**
|
|
316
|
+
* Contains the assets associated with the campaign, each represented as a collection of campaign assets.
|
|
317
|
+
*/
|
|
318
|
+
assets: Record<string, CollectionResponsePublicCampaignAsset>;
|
|
319
|
+
/**
|
|
320
|
+
* An array of business units associated with the campaign, each represented by a PublicBusinessUnit object.
|
|
321
|
+
*/
|
|
322
|
+
businessUnits: PublicBusinessUnit[];
|
|
323
|
+
/**
|
|
324
|
+
* The date and time when the campaign was created, formatted as a date-time string.
|
|
325
|
+
*/
|
|
326
|
+
createdAt: string;
|
|
327
|
+
/**
|
|
328
|
+
* The unique identifier for the campaign.
|
|
329
|
+
*/
|
|
330
|
+
id: string;
|
|
331
|
+
/**
|
|
332
|
+
* A map of key-value pairs representing the properties of the campaign.
|
|
333
|
+
*/
|
|
334
|
+
properties: Record<string, string>;
|
|
335
|
+
/**
|
|
336
|
+
* The date and time when the campaign was last updated, formatted as a date-time string.
|
|
337
|
+
*/
|
|
338
|
+
updatedAt: string;
|
|
339
|
+
}
|
|
340
|
+
interface PublicSpendItem {
|
|
341
|
+
/**
|
|
342
|
+
* The monetary value associated with the spend item.
|
|
343
|
+
*/
|
|
344
|
+
amount: number;
|
|
345
|
+
/**
|
|
346
|
+
* The timestamp indicating when the spend item was created.
|
|
347
|
+
*/
|
|
348
|
+
createdAt: number;
|
|
349
|
+
/**
|
|
350
|
+
* A detailed explanation or notes about the spend item.
|
|
351
|
+
*/
|
|
352
|
+
description?: string;
|
|
353
|
+
/**
|
|
354
|
+
* Unique identifier for the spend item.
|
|
355
|
+
*/
|
|
356
|
+
id: string;
|
|
357
|
+
/**
|
|
358
|
+
* The name assigned to the spend item.
|
|
359
|
+
*/
|
|
360
|
+
name: string;
|
|
361
|
+
/**
|
|
362
|
+
* The sequence order of the spend item, where 0 is the oldest.
|
|
363
|
+
*/
|
|
364
|
+
order: number;
|
|
365
|
+
/**
|
|
366
|
+
* The timestamp indicating when the spend item was last updated.
|
|
367
|
+
*/
|
|
368
|
+
updatedAt: number;
|
|
369
|
+
}
|
|
370
|
+
interface PublicSpendItemInput {
|
|
371
|
+
/**
|
|
372
|
+
* The monetary value of the spend item.
|
|
775
373
|
*/
|
|
776
|
-
|
|
374
|
+
amount: number;
|
|
375
|
+
/**
|
|
376
|
+
* A brief description of the spend item.
|
|
377
|
+
*/
|
|
378
|
+
description?: string;
|
|
379
|
+
/**
|
|
380
|
+
* The name of the spend item.
|
|
381
|
+
*/
|
|
382
|
+
name: string;
|
|
383
|
+
/**
|
|
384
|
+
* The sequence number indicating the order of the spend item.
|
|
385
|
+
*/
|
|
386
|
+
order: number;
|
|
387
|
+
}
|
|
388
|
+
interface RevenueAttributionAggregate {
|
|
389
|
+
/**
|
|
390
|
+
* The number of contacts attributed to the campaign.
|
|
391
|
+
*/
|
|
392
|
+
contactsNumber?: number;
|
|
393
|
+
/**
|
|
394
|
+
* The currency code used for the revenue attribution, with accepted values including AED, AFN, ALL, and others.
|
|
395
|
+
*/
|
|
396
|
+
currencyCode?: 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XUA' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL';
|
|
397
|
+
/**
|
|
398
|
+
* The total amount of deals attributed to the campaign.
|
|
399
|
+
*/
|
|
400
|
+
dealAmount?: number;
|
|
401
|
+
/**
|
|
402
|
+
* The number of deals attributed to the campaign.
|
|
403
|
+
*/
|
|
404
|
+
dealsNumber?: number;
|
|
405
|
+
/**
|
|
406
|
+
* The total revenue amount attributed to the campaign.
|
|
407
|
+
*/
|
|
408
|
+
revenueAmount?: number;
|
|
409
|
+
}
|
|
410
|
+
}
|
|
411
|
+
declare namespace MarketingCampaigns {
|
|
412
|
+
type CreateInput = MarketingCampaignsPublicApiSchemas.PublicCampaignInput;
|
|
413
|
+
type CreateOutput = MarketingCampaignsPublicApiSchemas.PublicCampaign;
|
|
414
|
+
interface DeleteInput {
|
|
415
|
+
/**
|
|
416
|
+
* The UUID of the campaign, required
|
|
417
|
+
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
418
|
+
*/
|
|
419
|
+
campaignGuid: string;
|
|
777
420
|
}
|
|
421
|
+
type DeleteOutput = void;
|
|
422
|
+
interface GetInput {
|
|
423
|
+
/**
|
|
424
|
+
* The UUID of the campaign, required
|
|
425
|
+
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
426
|
+
*/
|
|
427
|
+
campaignGuid: string;
|
|
428
|
+
/**
|
|
429
|
+
* The end date for fetching asset metrics, in YYYY-MM-DD format.
|
|
430
|
+
* Optional. Example: 2000-01-27
|
|
431
|
+
*/
|
|
432
|
+
endDate?: string;
|
|
433
|
+
/**
|
|
434
|
+
* A comma-separated list of properties to include in the response.
|
|
435
|
+
* Unrecognized properties are ignored. Optional. Example: hs_name,hs_budget, hs_notes
|
|
436
|
+
*/
|
|
437
|
+
properties?: string[];
|
|
438
|
+
/**
|
|
439
|
+
* The start date for fetching asset metrics, in YYYY-MM-DD format.
|
|
440
|
+
* Optional. Example: 2000-01-20
|
|
441
|
+
*/
|
|
442
|
+
startDate?: string;
|
|
443
|
+
}
|
|
444
|
+
type GetOutput = MarketingCampaignsPublicApiSchemas.PublicCampaignWithAssets;
|
|
445
|
+
interface ListInput {
|
|
446
|
+
/**
|
|
447
|
+
* 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.
|
|
448
|
+
*/
|
|
449
|
+
after?: string;
|
|
450
|
+
/**
|
|
451
|
+
* The maximum number of results to display per page.
|
|
452
|
+
*/
|
|
453
|
+
limit?: number;
|
|
454
|
+
/**
|
|
455
|
+
* Filter campaigns by name. Optional.
|
|
456
|
+
*/
|
|
457
|
+
name?: string;
|
|
458
|
+
/**
|
|
459
|
+
* A comma-separated list of properties to include in the response.
|
|
460
|
+
* Unrecognized properties are ignored. Optional. Example:
|
|
461
|
+
* hs_name, hs_budget,hs_notes
|
|
462
|
+
*/
|
|
463
|
+
properties?: string[];
|
|
464
|
+
/**
|
|
465
|
+
* The property to sort results by. Optional.
|
|
466
|
+
*/
|
|
467
|
+
sort?: string;
|
|
468
|
+
}
|
|
469
|
+
type ListOutput = MarketingCampaignsPublicApiSchemas.CollectionResponseWithTotalPublicCampaign;
|
|
470
|
+
interface UpdateInput {
|
|
471
|
+
/**
|
|
472
|
+
* The UUID of the campaign, required
|
|
473
|
+
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
474
|
+
*/
|
|
475
|
+
campaignGuid: string;
|
|
476
|
+
data: MarketingCampaignsPublicApiSchemas.PublicCampaignInput;
|
|
477
|
+
}
|
|
478
|
+
type UpdateOutput = MarketingCampaignsPublicApiSchemas.PublicCampaign;
|
|
778
479
|
/**
|
|
779
480
|
* Usage example:
|
|
780
481
|
* ```ts
|
|
781
|
-
* import {
|
|
782
|
-
* client.send(
|
|
482
|
+
* import { marketingCampaigns } from '@hubspot/api-client-core';
|
|
483
|
+
* client.send(marketingCampaigns.create(input));
|
|
783
484
|
* ```
|
|
784
485
|
*/
|
|
785
|
-
interface
|
|
486
|
+
interface API {
|
|
786
487
|
/**
|
|
787
488
|
* Create a campaign
|
|
788
489
|
* @apiPath /marketing/campaigns/2026-03
|
|
789
490
|
* @apiMethod POST
|
|
790
491
|
* @requiredScopes campaigns-write
|
|
791
492
|
*/
|
|
792
|
-
create: (input:
|
|
493
|
+
create: (input: CreateInput) => Operation<CreateOutput>;
|
|
793
494
|
/**
|
|
794
495
|
* Delete campaign
|
|
795
496
|
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}
|
|
796
497
|
* @apiMethod DELETE
|
|
797
498
|
* @requiredScopes campaigns-write
|
|
798
499
|
*/
|
|
799
|
-
delete: (input:
|
|
500
|
+
delete: (input: DeleteInput) => Operation<DeleteOutput>;
|
|
800
501
|
/**
|
|
801
502
|
* Read a campaign
|
|
802
503
|
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}
|
|
803
504
|
* @apiMethod GET
|
|
804
505
|
* @requiredScopes campaigns-access
|
|
805
506
|
*/
|
|
806
|
-
get: (input:
|
|
507
|
+
get: (input: GetInput) => Operation<GetOutput>;
|
|
807
508
|
/**
|
|
808
509
|
* Retrieve campaigns
|
|
809
510
|
* @apiPath /marketing/campaigns/2026-03
|
|
810
511
|
* @apiMethod GET
|
|
811
512
|
* @requiredScopes campaigns-access
|
|
812
513
|
*/
|
|
813
|
-
list: (input?:
|
|
514
|
+
list: (input?: ListInput) => Operation<ListOutput>;
|
|
814
515
|
/**
|
|
815
516
|
* Update campaign
|
|
816
517
|
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}
|
|
817
518
|
* @apiMethod PATCH
|
|
818
519
|
* @requiredScopes campaigns-write
|
|
819
520
|
*/
|
|
820
|
-
update: (input:
|
|
521
|
+
update: (input: UpdateInput) => Operation<UpdateOutput>;
|
|
522
|
+
}
|
|
523
|
+
}
|
|
524
|
+
declare namespace MarketingCampaignsAssets {
|
|
525
|
+
interface DeleteInput {
|
|
526
|
+
/**
|
|
527
|
+
* The id of asset to disassociate, required
|
|
528
|
+
* Example: 154543
|
|
529
|
+
*/
|
|
530
|
+
assetId: string;
|
|
531
|
+
/**
|
|
532
|
+
* The type of asset to disassociate, required
|
|
533
|
+
* Example: OBJECT_LIST
|
|
534
|
+
*/
|
|
535
|
+
assetType: string;
|
|
536
|
+
/**
|
|
537
|
+
* The UUID of the campaign, required
|
|
538
|
+
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
539
|
+
*/
|
|
540
|
+
campaignGuid: string;
|
|
541
|
+
}
|
|
542
|
+
type DeleteOutput = void;
|
|
543
|
+
interface ListInput {
|
|
544
|
+
/**
|
|
545
|
+
* 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.
|
|
546
|
+
*/
|
|
547
|
+
after?: string;
|
|
548
|
+
/**
|
|
549
|
+
* The type of asset to fetch, required
|
|
550
|
+
* Example: MARKETING_EVENT
|
|
551
|
+
*/
|
|
552
|
+
assetType: string;
|
|
553
|
+
/**
|
|
554
|
+
* The UUID of the campaign, required
|
|
555
|
+
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
556
|
+
*/
|
|
557
|
+
campaignGuid: string;
|
|
558
|
+
/**
|
|
559
|
+
* End date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period. If not provided, no asset metrics will be fetched.
|
|
560
|
+
* Example: 2024-01-27
|
|
561
|
+
*/
|
|
562
|
+
endDate?: string;
|
|
563
|
+
/**
|
|
564
|
+
* The maximum number of results to display per page.
|
|
565
|
+
*/
|
|
566
|
+
limit?: string;
|
|
567
|
+
/**
|
|
568
|
+
* Start date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period. If not provided, no asset metrics will be fetched.
|
|
569
|
+
* Example: 2023-01-20
|
|
570
|
+
*/
|
|
571
|
+
startDate?: string;
|
|
572
|
+
}
|
|
573
|
+
type ListOutput = MarketingCampaignsPublicApiSchemas.CollectionResponsePublicCampaignAssetForwardPaging;
|
|
574
|
+
interface UpdateInput {
|
|
575
|
+
/**
|
|
576
|
+
* The id of asset to disassociate, required
|
|
577
|
+
* Example: 154543
|
|
578
|
+
*/
|
|
579
|
+
assetId: string;
|
|
580
|
+
/**
|
|
581
|
+
* The type of asset to disassociate, required
|
|
582
|
+
* Example: OBJECT_LIST
|
|
583
|
+
*/
|
|
584
|
+
assetType: string;
|
|
585
|
+
/**
|
|
586
|
+
* The UUID of the campaign, required
|
|
587
|
+
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
588
|
+
*/
|
|
589
|
+
campaignGuid: string;
|
|
590
|
+
}
|
|
591
|
+
type UpdateOutput = void;
|
|
592
|
+
/**
|
|
593
|
+
* Usage example:
|
|
594
|
+
* ```ts
|
|
595
|
+
* import { marketingCampaignsAssets } from '@hubspot/api-client-core';
|
|
596
|
+
* client.send(marketingCampaignsAssets.delete(input));
|
|
597
|
+
* ```
|
|
598
|
+
*/
|
|
599
|
+
interface API {
|
|
600
|
+
/**
|
|
601
|
+
* Remove asset association
|
|
602
|
+
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}/assets/{assetType}/{assetId}
|
|
603
|
+
* @apiMethod DELETE
|
|
604
|
+
* @requiredScopes campaigns-write
|
|
605
|
+
*/
|
|
606
|
+
delete: (input: DeleteInput) => Operation<DeleteOutput>;
|
|
607
|
+
/**
|
|
608
|
+
* List assets
|
|
609
|
+
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}/assets/{assetType}
|
|
610
|
+
* @apiMethod GET
|
|
611
|
+
* @requiredScopes campaigns-access
|
|
612
|
+
*/
|
|
613
|
+
list: (input: ListInput) => Operation<ListOutput>;
|
|
614
|
+
/**
|
|
615
|
+
* Add asset association
|
|
616
|
+
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}/assets/{assetType}/{assetId}
|
|
617
|
+
* @apiMethod PUT
|
|
618
|
+
* @requiredScopes campaigns-write
|
|
619
|
+
*/
|
|
620
|
+
update: (input: UpdateInput) => Operation<UpdateOutput>;
|
|
621
|
+
}
|
|
622
|
+
}
|
|
623
|
+
declare namespace MarketingCampaignsBatch {
|
|
624
|
+
type CreateInput = MarketingCampaignsPublicApiSchemas.BatchInputPublicCampaignInput;
|
|
625
|
+
type CreateOutput = MarketingCampaignsPublicApiSchemas.BatchResponsePublicCampaign;
|
|
626
|
+
type DeleteInput = MarketingCampaignsPublicApiSchemas.BatchInputPublicCampaignDeleteInput;
|
|
627
|
+
type DeleteOutput = void;
|
|
628
|
+
interface GetInput {
|
|
629
|
+
data: MarketingCampaignsPublicApiSchemas.BatchInputPublicCampaignReadInput;
|
|
630
|
+
/**
|
|
631
|
+
* End date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period. If not provided, no asset metrics will be fetched.
|
|
632
|
+
* Example: 2024-01-27
|
|
633
|
+
*/
|
|
634
|
+
endDate?: string;
|
|
635
|
+
/**
|
|
636
|
+
* A comma-separated list of the properties to be returned in the response. If any of the specified properties has empty value on the requested object(s), they will be ignored and not returned in response. If this parameter is empty, the response will include an empty properties map.
|
|
637
|
+
* Example: hs_name, hs_campaign_status, hs_notes
|
|
638
|
+
*/
|
|
639
|
+
properties?: string[];
|
|
640
|
+
/**
|
|
641
|
+
* Start date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period. If not provided, no asset metrics will be fetched.
|
|
642
|
+
* Example: 2023-01-20
|
|
643
|
+
*/
|
|
644
|
+
startDate?: string;
|
|
821
645
|
}
|
|
646
|
+
type GetOutput = MarketingCampaignsPublicApiSchemas.BatchResponsePublicCampaignWithAssets;
|
|
647
|
+
type UpdateInput = MarketingCampaignsPublicApiSchemas.BatchInputPublicCampaignBatchUpdateItem;
|
|
648
|
+
type UpdateOutput = MarketingCampaignsPublicApiSchemas.BatchResponsePublicCampaign;
|
|
822
649
|
/**
|
|
823
650
|
* Usage example:
|
|
824
651
|
* ```ts
|
|
825
|
-
* import {
|
|
826
|
-
* client.send(
|
|
652
|
+
* import { marketingCampaignsBatch } from '@hubspot/api-client-core';
|
|
653
|
+
* client.send(marketingCampaignsBatch.create(input));
|
|
827
654
|
* ```
|
|
828
655
|
*/
|
|
829
|
-
interface
|
|
656
|
+
interface API {
|
|
830
657
|
/**
|
|
831
658
|
* Create a batch of campaigns
|
|
832
659
|
* @apiPath /marketing/campaigns/2026-03/batch/create
|
|
833
660
|
* @apiMethod POST
|
|
834
661
|
* @requiredScopes campaigns-write
|
|
835
662
|
*/
|
|
836
|
-
create: (input:
|
|
663
|
+
create: (input: CreateInput) => Operation<CreateOutput>;
|
|
837
664
|
/**
|
|
838
665
|
* Delete a batch of campaigns
|
|
839
666
|
* @apiPath /marketing/campaigns/2026-03/batch/archive
|
|
840
667
|
* @apiMethod POST
|
|
841
668
|
* @requiredScopes campaigns-write
|
|
842
669
|
*/
|
|
843
|
-
delete: (input:
|
|
670
|
+
delete: (input: DeleteInput) => Operation<DeleteOutput>;
|
|
844
671
|
/**
|
|
845
672
|
* Read a batch of campaigns
|
|
846
673
|
* @apiPath /marketing/campaigns/2026-03/batch/read
|
|
847
674
|
* @apiMethod POST
|
|
848
675
|
* @requiredScopes campaigns-access
|
|
849
676
|
*/
|
|
850
|
-
get: (input:
|
|
677
|
+
get: (input: GetInput) => Operation<GetOutput>;
|
|
851
678
|
/**
|
|
852
679
|
* Update a batch of campaigns
|
|
853
680
|
* @apiPath /marketing/campaigns/2026-03/batch/update
|
|
854
681
|
* @apiMethod POST
|
|
855
682
|
* @requiredScopes campaigns-write
|
|
856
683
|
*/
|
|
857
|
-
update: (input:
|
|
684
|
+
update: (input: UpdateInput) => Operation<UpdateOutput>;
|
|
685
|
+
}
|
|
686
|
+
}
|
|
687
|
+
declare namespace MarketingCampaignsBudget {
|
|
688
|
+
interface CreateInput {
|
|
689
|
+
/**
|
|
690
|
+
* The UUID of the campaign, required
|
|
691
|
+
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
692
|
+
*/
|
|
693
|
+
campaignGuid: string;
|
|
694
|
+
data: MarketingCampaignsPublicApiSchemas.PublicBudgetItemInput;
|
|
695
|
+
}
|
|
696
|
+
type CreateOutput = MarketingCampaignsPublicApiSchemas.PublicBudgetItem;
|
|
697
|
+
interface DeleteInput {
|
|
698
|
+
/**
|
|
699
|
+
* The ID of the budget item, required. Example: 352
|
|
700
|
+
*/
|
|
701
|
+
budgetId: number;
|
|
702
|
+
/**
|
|
703
|
+
* The UUID of the campaign, required
|
|
704
|
+
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
705
|
+
*/
|
|
706
|
+
campaignGuid: string;
|
|
858
707
|
}
|
|
708
|
+
type DeleteOutput = void;
|
|
709
|
+
interface GetInput {
|
|
710
|
+
/**
|
|
711
|
+
* The ID of the budget item, required. Example: 352
|
|
712
|
+
*/
|
|
713
|
+
budgetId: number;
|
|
714
|
+
/**
|
|
715
|
+
* The UUID of the campaign, required
|
|
716
|
+
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
717
|
+
*/
|
|
718
|
+
campaignGuid: string;
|
|
719
|
+
}
|
|
720
|
+
type GetOutput = MarketingCampaignsPublicApiSchemas.PublicBudgetItem;
|
|
721
|
+
interface GetTotalsInput {
|
|
722
|
+
/**
|
|
723
|
+
* The UUID of the campaign, required
|
|
724
|
+
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
725
|
+
*/
|
|
726
|
+
campaignGuid: string;
|
|
727
|
+
}
|
|
728
|
+
type GetTotalsOutput = MarketingCampaignsPublicApiSchemas.PublicBudgetTotals;
|
|
729
|
+
interface UpdateInput {
|
|
730
|
+
/**
|
|
731
|
+
* The ID of the budget item, required. Example: 352
|
|
732
|
+
*/
|
|
733
|
+
budgetId: number;
|
|
734
|
+
/**
|
|
735
|
+
* The UUID of the campaign, required
|
|
736
|
+
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
737
|
+
*/
|
|
738
|
+
campaignGuid: string;
|
|
739
|
+
data: MarketingCampaignsPublicApiSchemas.PublicBudgetItemInput;
|
|
740
|
+
}
|
|
741
|
+
type UpdateOutput = MarketingCampaignsPublicApiSchemas.PublicBudgetItem;
|
|
859
742
|
/**
|
|
860
743
|
* Usage example:
|
|
861
744
|
* ```ts
|
|
862
|
-
* import {
|
|
863
|
-
* client.send(
|
|
745
|
+
* import { marketingCampaignsBudget } from '@hubspot/api-client-core';
|
|
746
|
+
* client.send(marketingCampaignsBudget.create(input));
|
|
864
747
|
* ```
|
|
865
748
|
*/
|
|
866
|
-
interface
|
|
749
|
+
interface API {
|
|
867
750
|
/**
|
|
868
751
|
* Add budget item
|
|
869
752
|
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}/budget
|
|
870
753
|
* @apiMethod POST
|
|
871
754
|
* @requiredScopes campaigns-write
|
|
872
755
|
*/
|
|
873
|
-
create: (input:
|
|
756
|
+
create: (input: CreateInput) => Operation<CreateOutput>;
|
|
874
757
|
/**
|
|
875
758
|
* Delete budget item
|
|
876
759
|
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}/budget/{budgetId}
|
|
877
760
|
* @apiMethod DELETE
|
|
878
761
|
* @requiredScopes campaigns-write
|
|
879
762
|
*/
|
|
880
|
-
delete: (input:
|
|
763
|
+
delete: (input: DeleteInput) => Operation<DeleteOutput>;
|
|
881
764
|
/**
|
|
882
765
|
* Get budget item
|
|
883
766
|
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}/budget/{budgetId}
|
|
884
767
|
* @apiMethod GET
|
|
885
768
|
* @requiredScopes campaigns-access
|
|
886
769
|
*/
|
|
887
|
-
get: (input:
|
|
770
|
+
get: (input: GetInput) => Operation<GetOutput>;
|
|
888
771
|
/**
|
|
889
772
|
* Read budget
|
|
890
773
|
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}/budget/totals
|
|
891
774
|
* @apiMethod GET
|
|
892
775
|
* @requiredScopes campaigns-access
|
|
893
776
|
*/
|
|
894
|
-
getTotals: (input:
|
|
777
|
+
getTotals: (input: GetTotalsInput) => Operation<GetTotalsOutput>;
|
|
895
778
|
/**
|
|
896
779
|
* Update budget item
|
|
897
780
|
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}/budget/{budgetId}
|
|
898
781
|
* @apiMethod PUT
|
|
899
782
|
* @requiredScopes campaigns-write
|
|
900
783
|
*/
|
|
901
|
-
update: (input:
|
|
784
|
+
update: (input: UpdateInput) => Operation<UpdateOutput>;
|
|
785
|
+
}
|
|
786
|
+
}
|
|
787
|
+
declare namespace MarketingCampaignsMetrics {
|
|
788
|
+
interface GetAttributionMetricsInput {
|
|
789
|
+
/**
|
|
790
|
+
* The unique identifier of the campaign
|
|
791
|
+
*/
|
|
792
|
+
campaignGuid: string;
|
|
793
|
+
/**
|
|
794
|
+
* The end date for fetching attribution data, in YYYY-MM-DD format.
|
|
795
|
+
* Optional. Example: 2000-01-27
|
|
796
|
+
*/
|
|
797
|
+
endDate?: string;
|
|
798
|
+
/**
|
|
799
|
+
* The start date for fetching attribution data, in YYYY-MM-DD format.
|
|
800
|
+
* Optional. Example: 2000-01-20
|
|
801
|
+
*/
|
|
802
|
+
startDate?: string;
|
|
803
|
+
}
|
|
804
|
+
type GetAttributionMetricsOutput = MarketingCampaignsPublicApiSchemas.MetricsCounters;
|
|
805
|
+
interface GetRevenueAttributionInput {
|
|
806
|
+
/**
|
|
807
|
+
* The revenue attribution model used to calculate deal revenue credit. Defaults to LINEAR if not specified. Enum values: LINEAR, FIRST_INTERACTION, LAST_INTERACTION, FULL_PATH, U_SHAPED, W_SHAPED, TIME_DECAY, J_SHAPED, INVERSE_J_SHAPED
|
|
808
|
+
*/
|
|
809
|
+
attributionModel?: string;
|
|
810
|
+
/**
|
|
811
|
+
* The unique identifier of the campaign
|
|
812
|
+
*/
|
|
813
|
+
campaignGuid: string;
|
|
814
|
+
/**
|
|
815
|
+
* End date to fetch attribution data, YYYY-MM-DD
|
|
816
|
+
*/
|
|
817
|
+
endDate?: string;
|
|
818
|
+
/**
|
|
819
|
+
* Start date to fetch attribution data, YYYY-MM-DD
|
|
820
|
+
*/
|
|
821
|
+
startDate?: string;
|
|
822
|
+
}
|
|
823
|
+
type GetRevenueAttributionOutput = MarketingCampaignsPublicApiSchemas.RevenueAttributionAggregate;
|
|
824
|
+
interface ListContactIdsByTypeInput {
|
|
825
|
+
/**
|
|
826
|
+
* 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.
|
|
827
|
+
*/
|
|
828
|
+
after?: string;
|
|
829
|
+
/**
|
|
830
|
+
* The unique identifier of the campaign
|
|
831
|
+
*/
|
|
832
|
+
campaignGuid: string;
|
|
833
|
+
/**
|
|
834
|
+
* The type of contact to filter the list
|
|
835
|
+
*/
|
|
836
|
+
contactType: string;
|
|
837
|
+
/**
|
|
838
|
+
* The end date for fetching contact data, in YYYY-MM-DD format.
|
|
839
|
+
* Optional. Example: 2000-01-27
|
|
840
|
+
*/
|
|
841
|
+
endDate?: string;
|
|
842
|
+
/**
|
|
843
|
+
* The maximum number of results to display per page.
|
|
844
|
+
*/
|
|
845
|
+
limit?: number;
|
|
846
|
+
/**
|
|
847
|
+
* The start date for fetching contact data, in YYYY-MM-DD format.
|
|
848
|
+
* Optional. Example: 2000-01-20
|
|
849
|
+
*/
|
|
850
|
+
startDate?: string;
|
|
902
851
|
}
|
|
852
|
+
type ListContactIdsByTypeOutput = MarketingCampaignsPublicApiSchemas.CollectionResponseContactReferenceForwardPaging;
|
|
903
853
|
/**
|
|
904
854
|
* Usage example:
|
|
905
855
|
* ```ts
|
|
906
|
-
* import {
|
|
907
|
-
* client.send(
|
|
856
|
+
* import { marketingCampaignsMetrics } from '@hubspot/api-client-core';
|
|
857
|
+
* client.send(marketingCampaignsMetrics.getAttributionMetrics(input));
|
|
908
858
|
* ```
|
|
909
859
|
*/
|
|
910
|
-
interface
|
|
860
|
+
interface API {
|
|
911
861
|
/**
|
|
912
862
|
* Get Campaign Metrics
|
|
913
863
|
*
|
|
@@ -915,75 +865,108 @@ declare namespace MarketingCampaignsPublicApi {
|
|
|
915
865
|
* @apiMethod GET
|
|
916
866
|
* @requiredScopes campaigns-access
|
|
917
867
|
*/
|
|
918
|
-
getAttributionMetrics: (input:
|
|
868
|
+
getAttributionMetrics: (input: GetAttributionMetricsInput) => Operation<GetAttributionMetricsOutput>;
|
|
919
869
|
/**
|
|
920
870
|
* Fetch revenue
|
|
921
871
|
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}/reports/revenue
|
|
922
872
|
* @apiMethod GET
|
|
923
873
|
* @requiredScopes campaigns-revenue-pro, revenue-attribution-read
|
|
924
874
|
*/
|
|
925
|
-
getRevenueAttribution: (input:
|
|
875
|
+
getRevenueAttribution: (input: GetRevenueAttributionInput) => Operation<GetRevenueAttributionOutput>;
|
|
926
876
|
/**
|
|
927
877
|
* Fetch contact IDs
|
|
928
878
|
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}/reports/contacts/{contactType}
|
|
929
879
|
* @apiMethod GET
|
|
930
880
|
* @requiredScopes campaigns-access
|
|
931
881
|
*/
|
|
932
|
-
listContactIdsByType: (input:
|
|
882
|
+
listContactIdsByType: (input: ListContactIdsByTypeInput) => Operation<ListContactIdsByTypeOutput>;
|
|
883
|
+
}
|
|
884
|
+
}
|
|
885
|
+
declare namespace MarketingCampaignsSpend {
|
|
886
|
+
interface CreateInput {
|
|
887
|
+
/**
|
|
888
|
+
* The UUID of the campaign, required
|
|
889
|
+
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
890
|
+
*/
|
|
891
|
+
campaignGuid: string;
|
|
892
|
+
data: MarketingCampaignsPublicApiSchemas.PublicSpendItemInput;
|
|
933
893
|
}
|
|
894
|
+
type CreateOutput = MarketingCampaignsPublicApiSchemas.PublicSpendItem;
|
|
895
|
+
interface DeleteInput {
|
|
896
|
+
/**
|
|
897
|
+
* The UUID of the campaign, required
|
|
898
|
+
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
899
|
+
*/
|
|
900
|
+
campaignGuid: string;
|
|
901
|
+
/**
|
|
902
|
+
* The ID of the spend item, required. Example: 491
|
|
903
|
+
*/
|
|
904
|
+
spendId: number;
|
|
905
|
+
}
|
|
906
|
+
type DeleteOutput = void;
|
|
907
|
+
interface GetInput {
|
|
908
|
+
/**
|
|
909
|
+
* The UUID of the campaign, required
|
|
910
|
+
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
911
|
+
*/
|
|
912
|
+
campaignGuid: string;
|
|
913
|
+
/**
|
|
914
|
+
* The ID of the spend item, required. Example: 491
|
|
915
|
+
*/
|
|
916
|
+
spendId: number;
|
|
917
|
+
}
|
|
918
|
+
type GetOutput = MarketingCampaignsPublicApiSchemas.PublicSpendItem;
|
|
919
|
+
interface UpdateInput {
|
|
920
|
+
/**
|
|
921
|
+
* The UUID of the campaign, required
|
|
922
|
+
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
923
|
+
*/
|
|
924
|
+
campaignGuid: string;
|
|
925
|
+
data: MarketingCampaignsPublicApiSchemas.PublicSpendItemInput;
|
|
926
|
+
/**
|
|
927
|
+
* The ID of the spend item, required. Example: 491
|
|
928
|
+
*/
|
|
929
|
+
spendId: number;
|
|
930
|
+
}
|
|
931
|
+
type UpdateOutput = MarketingCampaignsPublicApiSchemas.PublicSpendItem;
|
|
934
932
|
/**
|
|
935
933
|
* Usage example:
|
|
936
934
|
* ```ts
|
|
937
|
-
* import {
|
|
938
|
-
* client.send(
|
|
935
|
+
* import { marketingCampaignsSpend } from '@hubspot/api-client-core';
|
|
936
|
+
* client.send(marketingCampaignsSpend.create(input));
|
|
939
937
|
* ```
|
|
940
938
|
*/
|
|
941
|
-
interface
|
|
939
|
+
interface API {
|
|
942
940
|
/**
|
|
943
941
|
* Create campaign spend item
|
|
944
942
|
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}/spend
|
|
945
943
|
* @apiMethod POST
|
|
946
944
|
* @requiredScopes campaigns-write
|
|
947
945
|
*/
|
|
948
|
-
create: (input:
|
|
946
|
+
create: (input: CreateInput) => Operation<CreateOutput>;
|
|
949
947
|
/**
|
|
950
948
|
* Delete campaign spend item
|
|
951
949
|
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}/spend/{spendId}
|
|
952
950
|
* @apiMethod DELETE
|
|
953
951
|
* @requiredScopes campaigns-write
|
|
954
952
|
*/
|
|
955
|
-
delete: (input:
|
|
953
|
+
delete: (input: DeleteInput) => Operation<DeleteOutput>;
|
|
956
954
|
/**
|
|
957
955
|
* Read campaign spend item
|
|
958
956
|
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}/spend/{spendId}
|
|
959
957
|
* @apiMethod GET
|
|
960
958
|
* @requiredScopes campaigns-access
|
|
961
959
|
*/
|
|
962
|
-
get: (input:
|
|
960
|
+
get: (input: GetInput) => Operation<GetOutput>;
|
|
963
961
|
/**
|
|
964
962
|
* Update campaign spend item
|
|
965
963
|
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}/spend/{spendId}
|
|
966
964
|
* @apiMethod PUT
|
|
967
965
|
* @requiredScopes campaigns-write
|
|
968
966
|
*/
|
|
969
|
-
update: (input:
|
|
970
|
-
}
|
|
971
|
-
/**
|
|
972
|
-
* Usage example:
|
|
973
|
-
* ```ts
|
|
974
|
-
* import { marketingCampaignsPublicApi } from '@hubspot/api-client-core';
|
|
975
|
-
* client.send(marketingCampaignsPublicApi.assets.delete(input));
|
|
976
|
-
* ```
|
|
977
|
-
*/
|
|
978
|
-
interface API {
|
|
979
|
-
assets: AssetsAPI;
|
|
980
|
-
basic: BasicAPI;
|
|
981
|
-
batch: BatchAPI;
|
|
982
|
-
budget: BudgetAPI;
|
|
983
|
-
metrics: MetricsAPI;
|
|
984
|
-
spend: SpendAPI;
|
|
967
|
+
update: (input: UpdateInput) => Operation<UpdateOutput>;
|
|
985
968
|
}
|
|
986
969
|
}
|
|
987
970
|
//#endregion
|
|
988
|
-
export {
|
|
971
|
+
export { MarketingCampaigns, MarketingCampaignsAssets, MarketingCampaignsBatch, MarketingCampaignsBudget, MarketingCampaignsMetrics, MarketingCampaignsPublicApiSchemas, MarketingCampaignsSpend };
|
|
989
972
|
//# sourceMappingURL=campaigns-public-api-types.generated.d.ts.map
|