@hubspot/app-connect-sdk 1.0.0-alpha.2 → 1.0.0-alpha.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.turbo/turbo-format$colon$check.log +1 -1
- package/.turbo/turbo-test.log +101 -57
- package/.turbo/turbo-tsdown.log +474 -469
- package/build/tsconfig.browser.tsbuildinfo +1 -1
- package/build/tsconfig.server.tsbuildinfo +1 -1
- package/dist/browser/{HubSpotAppConnect-BW45gyDs.js → HubSpotAppConnect-721kYr9d.js} +17 -23
- package/dist/browser/HubSpotAppConnect-721kYr9d.js.map +1 -0
- package/dist/browser/{create-vctOhpX9.js → create-DxEyGG-k.js} +336 -100
- package/dist/browser/create-DxEyGG-k.js.map +1 -0
- package/dist/browser/index.d.ts +2 -2
- package/dist/browser/index.js +1 -1
- package/dist/browser/react/lovable.d.ts +9 -2
- package/dist/browser/react/lovable.js +7 -4
- package/dist/browser/react/lovable.js.map +1 -1
- package/dist/browser/react.d.ts +2 -3
- package/dist/browser/react.js +1 -1
- package/dist/browser/{types-rTQw6A54.d.ts → types-C3wed8dU.d.ts} +52 -7
- package/dist/server/api-client-core/apis/account/account-info-types.generated.d.ts +73 -85
- package/dist/server/api-client-core/apis/account/account-info.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/account/account-info.generated.js +4 -3
- package/dist/server/api-client-core/apis/account/account-info.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/account/audit-logs-types.generated.d.ts +203 -215
- package/dist/server/api-client-core/apis/account/audit-logs.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/account/audit-logs.generated.js +4 -3
- package/dist/server/api-client-core/apis/account/audit-logs.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/auth/oauth-types.generated.d.ts +78 -90
- package/dist/server/api-client-core/apis/auth/oauth.generated.d.ts +1 -1
- package/dist/server/api-client-core/apis/auth/oauth.generated.js +3 -2
- package/dist/server/api-client-core/apis/auth/oauth.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/automation/actions-types.generated.d.ts +779 -794
- package/dist/server/api-client-core/apis/automation/actions.generated.d.ts +6 -3
- package/dist/server/api-client-core/apis/automation/actions.generated.js +101 -102
- package/dist/server/api-client-core/apis/automation/actions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/automation/sequences-types.generated.d.ts +370 -382
- package/dist/server/api-client-core/apis/automation/sequences.generated.d.ts +1 -1
- package/dist/server/api-client-core/apis/automation/sequences.generated.js +3 -2
- package/dist/server/api-client-core/apis/automation/sequences.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/business-units-types.generated.d.ts +43 -55
- package/dist/server/api-client-core/apis/business-units.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/business-units.generated.js +4 -3
- package/dist/server/api-client-core/apis/business-units.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/authors-types.generated.d.ts +420 -445
- package/dist/server/api-client-core/apis/cms/authors.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/cms/authors.generated.js +155 -158
- package/dist/server/api-client-core/apis/cms/authors.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/blog-settings-types.generated.d.ts +270 -295
- package/dist/server/api-client-core/apis/cms/blog-settings.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/cms/blog-settings.generated.js +35 -38
- package/dist/server/api-client-core/apis/cms/blog-settings.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/cms-content-audit-types.generated.d.ts +107 -131
- package/dist/server/api-client-core/apis/cms/cms-content-audit.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/cms/cms-content-audit.generated.js +6 -5
- package/dist/server/api-client-core/apis/cms/cms-content-audit.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/domains-types.generated.d.ts +155 -167
- package/dist/server/api-client-core/apis/cms/domains.generated.d.ts +2 -2
- package/dist/server/api-client-core/apis/cms/domains.generated.js +3 -2
- package/dist/server/api-client-core/apis/cms/domains.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/hubdb-types.generated.d.ts +876 -889
- package/dist/server/api-client-core/apis/cms/hubdb.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/cms/hubdb.generated.js +184 -185
- package/dist/server/api-client-core/apis/cms/hubdb.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/media-bridge-types.generated.d.ts +1550 -1575
- package/dist/server/api-client-core/apis/cms/media-bridge.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/cms/media-bridge.generated.js +161 -164
- package/dist/server/api-client-core/apis/cms/media-bridge.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/pages-types.generated.d.ts +1583 -1547
- package/dist/server/api-client-core/apis/cms/pages.generated.d.ts +15 -3
- package/dist/server/api-client-core/apis/cms/pages.generated.js +335 -326
- package/dist/server/api-client-core/apis/cms/pages.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/posts-types.generated.d.ts +900 -904
- package/dist/server/api-client-core/apis/cms/posts.generated.d.ts +7 -3
- package/dist/server/api-client-core/apis/cms/posts.generated.js +197 -196
- package/dist/server/api-client-core/apis/cms/posts.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/site-search-types.generated.d.ts +162 -174
- package/dist/server/api-client-core/apis/cms/site-search.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/cms/site-search.generated.js +4 -3
- package/dist/server/api-client-core/apis/cms/site-search.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/source-code-types.generated.d.ts +148 -172
- package/dist/server/api-client-core/apis/cms/source-code.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/cms/source-code.generated.js +40 -43
- package/dist/server/api-client-core/apis/cms/source-code.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/tags-types.generated.d.ts +406 -420
- package/dist/server/api-client-core/apis/cms/tags.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/cms/tags.generated.js +157 -158
- package/dist/server/api-client-core/apis/cms/tags.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/url-mappings-types.generated.d.ts +127 -139
- package/dist/server/api-client-core/apis/cms/url-mappings.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/cms/url-mappings.generated.js +4 -3
- package/dist/server/api-client-core/apis/cms/url-mappings.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/cms/url-redirects-types.generated.d.ts +170 -182
- package/dist/server/api-client-core/apis/cms/url-redirects.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/cms/url-redirects.generated.js +4 -3
- package/dist/server/api-client-core/apis/cms/url-redirects.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/communication-preferences/subscriptions-types.generated.d.ts +728 -742
- package/dist/server/api-client-core/apis/communication-preferences/subscriptions.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/communication-preferences/subscriptions.generated.js +66 -69
- package/dist/server/api-client-core/apis/communication-preferences/subscriptions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/conversations/custom-channels-types.generated.d.ts +445 -471
- package/dist/server/api-client-core/apis/conversations/custom-channels.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/conversations/custom-channels.generated.js +70 -73
- package/dist/server/api-client-core/apis/conversations/custom-channels.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/conversations/visitor-identification-types.generated.d.ts +28 -40
- package/dist/server/api-client-core/apis/conversations/visitor-identification.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/conversations/visitor-identification.generated.js +3 -2
- package/dist/server/api-client-core/apis/conversations/visitor-identification.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/conversations-types.generated.d.ts +768 -781
- package/dist/server/api-client-core/apis/conversations.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/conversations.generated.js +101 -102
- package/dist/server/api-client-core/apis/conversations.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/app-uninstalls-types.generated.d.ts +8 -19
- package/dist/server/api-client-core/apis/crm/app-uninstalls.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/app-uninstalls.generated.js +3 -2
- package/dist/server/api-client-core/apis/crm/app-uninstalls.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/appointments-types.generated.d.ts +887 -891
- package/dist/server/api-client-core/apis/crm/appointments.generated.d.ts +7 -3
- package/dist/server/api-client-core/apis/crm/appointments.generated.js +105 -106
- package/dist/server/api-client-core/apis/crm/appointments.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/associations-schema-types.generated.d.ts +247 -260
- package/dist/server/api-client-core/apis/crm/associations-schema.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/crm/associations-schema.generated.js +48 -49
- package/dist/server/api-client-core/apis/crm/associations-schema.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/associations-types.generated.d.ts +576 -590
- package/dist/server/api-client-core/apis/crm/associations.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/associations.generated.js +71 -72
- package/dist/server/api-client-core/apis/crm/associations.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/calling-extensions-types.generated.d.ts +355 -379
- package/dist/server/api-client-core/apis/crm/calling-extensions.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/calling-extensions.generated.js +34 -37
- package/dist/server/api-client-core/apis/crm/calling-extensions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/calls-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/calls.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/calls.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/calls.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/carts-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/carts.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/carts.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/carts.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/commerce-payments-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/commerce-payments.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/commerce-payments.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/commerce-payments.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/commerce-subscriptions-types.generated.d.ts +752 -766
- package/dist/server/api-client-core/apis/crm/commerce-subscriptions.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/commerce-subscriptions.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/commerce-subscriptions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/communications-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/communications.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/communications.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/communications.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/companies-types.generated.d.ts +769 -795
- package/dist/server/api-client-core/apis/crm/companies.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/companies.generated.js +59 -58
- package/dist/server/api-client-core/apis/crm/companies.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/contacts-types.generated.d.ts +786 -812
- package/dist/server/api-client-core/apis/crm/contacts.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/contacts.generated.js +60 -61
- package/dist/server/api-client-core/apis/crm/contacts.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/contracts-types.generated.d.ts +796 -777
- package/dist/server/api-client-core/apis/crm/contracts.generated.d.ts +8 -3
- package/dist/server/api-client-core/apis/crm/contracts.generated.js +60 -57
- package/dist/server/api-client-core/apis/crm/contracts.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/courses-types.generated.d.ts +758 -772
- package/dist/server/api-client-core/apis/crm/courses.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/courses.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/courses.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/crm-owners-types.generated.d.ts +103 -115
- package/dist/server/api-client-core/apis/crm/crm-owners.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/crm-owners.generated.js +4 -3
- package/dist/server/api-client-core/apis/crm/crm-owners.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/custom-objects-types.generated.d.ts +833 -848
- package/dist/server/api-client-core/apis/crm/custom-objects.generated.d.ts +6 -3
- package/dist/server/api-client-core/apis/crm/custom-objects.generated.js +91 -90
- package/dist/server/api-client-core/apis/crm/custom-objects.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/deal-splits-types.generated.d.ts +158 -170
- package/dist/server/api-client-core/apis/crm/deal-splits.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/deal-splits.generated.js +4 -3
- package/dist/server/api-client-core/apis/crm/deal-splits.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/deals-types.generated.d.ts +771 -785
- package/dist/server/api-client-core/apis/crm/deals.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/deals.generated.js +59 -58
- package/dist/server/api-client-core/apis/crm/deals.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/discounts-types.generated.d.ts +754 -768
- package/dist/server/api-client-core/apis/crm/discounts.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/discounts.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/discounts.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/emails-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/emails.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/emails.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/emails.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/exports-types.generated.d.ts +227 -251
- package/dist/server/api-client-core/apis/crm/exports.generated.d.ts +2 -2
- package/dist/server/api-client-core/apis/crm/exports.generated.js +4 -5
- package/dist/server/api-client-core/apis/crm/exports.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/feedback-submissions-types.generated.d.ts +551 -565
- package/dist/server/api-client-core/apis/crm/feedback-submissions.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/feedback-submissions.generated.js +45 -46
- package/dist/server/api-client-core/apis/crm/feedback-submissions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/fees-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/fees.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/fees.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/fees.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/goal-targets-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/goal-targets.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/goal-targets.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/goal-targets.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/imports-types.generated.d.ts +305 -329
- package/dist/server/api-client-core/apis/crm/imports.generated.d.ts +2 -2
- package/dist/server/api-client-core/apis/crm/imports.generated.js +20 -23
- package/dist/server/api-client-core/apis/crm/imports.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/invoices-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/invoices.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/invoices.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/invoices.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/leads-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/leads.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/leads.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/leads.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/limits-tracking-types.generated.d.ts +251 -263
- package/dist/server/api-client-core/apis/crm/limits-tracking.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/limits-tracking.generated.js +4 -3
- package/dist/server/api-client-core/apis/crm/limits-tracking.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/line-items-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/line-items.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/line-items.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/line-items.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/listings-types.generated.d.ts +758 -772
- package/dist/server/api-client-core/apis/crm/listings.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/listings.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/listings.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/lists-types.generated.d.ts +2075 -2111
- package/dist/server/api-client-core/apis/crm/lists.generated.d.ts +2 -2
- package/dist/server/api-client-core/apis/crm/lists.generated.js +97 -98
- package/dist/server/api-client-core/apis/crm/lists.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/meetings-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/meetings.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/meetings.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/meetings.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/notes-types.generated.d.ts +755 -769
- package/dist/server/api-client-core/apis/crm/notes.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/notes.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/notes.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/object-library-types.generated.d.ts +24 -36
- package/dist/server/api-client-core/apis/crm/object-library.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/object-library.generated.js +4 -3
- package/dist/server/api-client-core/apis/crm/object-library.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/objects-types.generated.d.ts +620 -645
- package/dist/server/api-client-core/apis/crm/objects.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/crm/objects.generated.js +66 -67
- package/dist/server/api-client-core/apis/crm/objects.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/orders-types.generated.d.ts +747 -761
- package/dist/server/api-client-core/apis/crm/orders.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/orders.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/orders.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/partner-clients-types.generated.d.ts +646 -660
- package/dist/server/api-client-core/apis/crm/partner-clients.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/partner-clients.generated.js +63 -62
- package/dist/server/api-client-core/apis/crm/partner-clients.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/partner-services-types.generated.d.ts +646 -660
- package/dist/server/api-client-core/apis/crm/partner-services.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/partner-services.generated.js +63 -62
- package/dist/server/api-client-core/apis/crm/partner-services.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/pipelines-types.generated.d.ts +320 -332
- package/dist/server/api-client-core/apis/crm/pipelines.generated.d.ts +2 -2
- package/dist/server/api-client-core/apis/crm/pipelines.generated.js +3 -2
- package/dist/server/api-client-core/apis/crm/pipelines.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/postal-mail-types.generated.d.ts +744 -758
- package/dist/server/api-client-core/apis/crm/postal-mail.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/postal-mail.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/postal-mail.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/products-types.generated.d.ts +747 -761
- package/dist/server/api-client-core/apis/crm/products.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/products.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/products.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/projects-types.generated.d.ts +761 -787
- package/dist/server/api-client-core/apis/crm/projects.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/projects.generated.js +59 -58
- package/dist/server/api-client-core/apis/crm/projects.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/properties-types.generated.d.ts +526 -528
- package/dist/server/api-client-core/apis/crm/properties.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/properties.generated.js +79 -78
- package/dist/server/api-client-core/apis/crm/properties.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/property-validations-types.generated.d.ts +71 -83
- package/dist/server/api-client-core/apis/crm/property-validations.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/property-validations.generated.js +4 -3
- package/dist/server/api-client-core/apis/crm/property-validations.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/public-app-crm-cards-types.generated.d.ts +409 -433
- package/dist/server/api-client-core/apis/crm/public-app-crm-cards.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/public-app-crm-cards.generated.js +24 -25
- package/dist/server/api-client-core/apis/crm/public-app-crm-cards.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/public-app-feature-flags-types.generated.d.ts +156 -169
- package/dist/server/api-client-core/apis/crm/public-app-feature-flags.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/crm/public-app-feature-flags.generated.js +55 -56
- package/dist/server/api-client-core/apis/crm/public-app-feature-flags.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/quotes-types.generated.d.ts +747 -761
- package/dist/server/api-client-core/apis/crm/quotes.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/quotes.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/quotes.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/schemas-types.generated.d.ts +575 -600
- package/dist/server/api-client-core/apis/crm/schemas.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/crm/schemas.generated.js +33 -34
- package/dist/server/api-client-core/apis/crm/schemas.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/services-types.generated.d.ts +750 -764
- package/dist/server/api-client-core/apis/crm/services.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/services.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/services.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/tasks-types.generated.d.ts +747 -761
- package/dist/server/api-client-core/apis/crm/tasks.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/tasks.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/tasks.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/taxes-types.generated.d.ts +747 -761
- package/dist/server/api-client-core/apis/crm/taxes.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/taxes.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/taxes.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/tickets-types.generated.d.ts +764 -790
- package/dist/server/api-client-core/apis/crm/tickets.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/tickets.generated.js +59 -58
- package/dist/server/api-client-core/apis/crm/tickets.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/timeline-types.generated.d.ts +136 -149
- package/dist/server/api-client-core/apis/crm/timeline.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/crm/timeline.generated.js +5 -6
- package/dist/server/api-client-core/apis/crm/timeline.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/transcriptions-types.generated.d.ts +104 -117
- package/dist/server/api-client-core/apis/crm/transcriptions.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/crm/transcriptions.generated.js +7 -10
- package/dist/server/api-client-core/apis/crm/transcriptions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/users-types.generated.d.ts +747 -761
- package/dist/server/api-client-core/apis/crm/users.generated.d.ts +5 -3
- package/dist/server/api-client-core/apis/crm/users.generated.js +58 -57
- package/dist/server/api-client-core/apis/crm/users.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/crm/video-conferencing-extension-types.generated.d.ts +28 -40
- package/dist/server/api-client-core/apis/crm/video-conferencing-extension.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/crm/video-conferencing-extension.generated.js +4 -3
- package/dist/server/api-client-core/apis/crm/video-conferencing-extension.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/events/manage-event-definitions-types.generated.d.ts +909 -945
- package/dist/server/api-client-core/apis/events/manage-event-definitions.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/events/manage-event-definitions.generated.js +29 -30
- package/dist/server/api-client-core/apis/events/manage-event-definitions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/events/send-event-completions-types.generated.d.ts +49 -62
- package/dist/server/api-client-core/apis/events/send-event-completions.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/events/send-event-completions.generated.js +4 -5
- package/dist/server/api-client-core/apis/events/send-event-completions.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/events-types.generated.d.ts +99 -111
- package/dist/server/api-client-core/apis/events.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/events.generated.js +4 -3
- package/dist/server/api-client-core/apis/events.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/files-types.generated.d.ts +636 -649
- package/dist/server/api-client-core/apis/files.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/files.generated.js +112 -113
- package/dist/server/api-client-core/apis/files.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/marketing/campaigns-public-api-types.generated.d.ts +799 -816
- package/dist/server/api-client-core/apis/marketing/campaigns-public-api.generated.d.ts +8 -3
- package/dist/server/api-client-core/apis/marketing/campaigns-public-api.generated.js +126 -127
- package/dist/server/api-client-core/apis/marketing/campaigns-public-api.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/marketing/marketing-emails-types.generated.d.ts +745 -769
- package/dist/server/api-client-core/apis/marketing/marketing-emails.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/marketing/marketing-emails.generated.js +100 -103
- package/dist/server/api-client-core/apis/marketing/marketing-emails.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/marketing/marketing-events-types.generated.d.ts +1504 -1546
- package/dist/server/api-client-core/apis/marketing/marketing-events.generated.d.ts +9 -3
- package/dist/server/api-client-core/apis/marketing/marketing-events.generated.js +162 -167
- package/dist/server/api-client-core/apis/marketing/marketing-events.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/marketing/single-send-types.generated.d.ts +91 -103
- package/dist/server/api-client-core/apis/marketing/single-send.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/marketing/single-send.generated.js +3 -2
- package/dist/server/api-client-core/apis/marketing/single-send.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/marketing/transactional-single-send-types.generated.d.ts +187 -200
- package/dist/server/api-client-core/apis/marketing/transactional-single-send.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/marketing/transactional-single-send.generated.js +14 -15
- package/dist/server/api-client-core/apis/marketing/transactional-single-send.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/meta/origins-types.generated.d.ts +41 -53
- package/dist/server/api-client-core/apis/meta/origins.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/meta/origins.generated.js +4 -3
- package/dist/server/api-client-core/apis/meta/origins.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/scheduler/meetings-types.generated.d.ts +850 -863
- package/dist/server/api-client-core/apis/scheduler/meetings.generated.d.ts +4 -3
- package/dist/server/api-client-core/apis/scheduler/meetings.generated.js +28 -29
- package/dist/server/api-client-core/apis/scheduler/meetings.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/settings/multicurrency-types.generated.d.ts +281 -296
- package/dist/server/api-client-core/apis/settings/multicurrency.generated.d.ts +6 -3
- package/dist/server/api-client-core/apis/settings/multicurrency.generated.js +32 -33
- package/dist/server/api-client-core/apis/settings/multicurrency.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/settings/tax-rates-types.generated.d.ts +71 -83
- package/dist/server/api-client-core/apis/settings/tax-rates.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/settings/tax-rates.generated.js +4 -3
- package/dist/server/api-client-core/apis/settings/tax-rates.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/settings/user-provisioning-types.generated.d.ts +202 -250
- package/dist/server/api-client-core/apis/settings/user-provisioning.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/settings/user-provisioning.generated.js +23 -26
- package/dist/server/api-client-core/apis/settings/user-provisioning.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/webhooks-journal-types.generated.d.ts +490 -526
- package/dist/server/api-client-core/apis/webhooks-journal.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/webhooks-journal.generated.js +65 -70
- package/dist/server/api-client-core/apis/webhooks-journal.generated.js.map +1 -1
- package/dist/server/api-client-core/apis/webhooks-types.generated.d.ts +816 -852
- package/dist/server/api-client-core/apis/webhooks.generated.d.ts +3 -3
- package/dist/server/api-client-core/apis/webhooks.generated.js +93 -98
- package/dist/server/api-client-core/apis/webhooks.generated.js.map +1 -1
- package/dist/server/api-client-core/binary-data.js.map +1 -1
- package/dist/server/api-client-core/client.js +5 -1
- package/dist/server/api-client-core/client.js.map +1 -1
- package/dist/server/api-client-core/codegen-helpers/file-op-wrappers.js.map +1 -1
- package/dist/server/api-client-core/errors.js.map +1 -1
- package/dist/server/api-client-core/op.js.map +1 -1
- package/dist/server/api-client-core/pagination.d.ts +2 -2
- package/dist/server/api-client-core/pagination.js +2 -2
- package/dist/server/api-client-core/pagination.js.map +1 -1
- package/dist/server/api-client-core/plugins/fetch-transport.js +33 -9
- package/dist/server/api-client-core/plugins/fetch-transport.js.map +1 -1
- package/dist/server/api-client-core/types.d.ts +1 -1
- package/dist/server/api-client.d.ts +184 -184
- package/dist/server/api-client.js +89 -89
- package/dist/server/constants.js +33 -6
- package/dist/server/constants.js.map +1 -1
- package/dist/server/deno/start.js.map +1 -1
- package/dist/server/hono/hono-request-handler.js +32 -23
- package/dist/server/hono/hono-request-handler.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/auth-complete.js +158 -0
- package/dist/server/hono/hubspot-connect-routes/auth-complete.js.map +1 -0
- package/dist/server/hono/hubspot-connect-routes/auth-init-session.js +25 -12
- package/dist/server/hono/hubspot-connect-routes/auth-init-session.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/auth-logout.js +32 -9
- package/dist/server/hono/hubspot-connect-routes/auth-logout.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/auth-refresh.js +32 -18
- package/dist/server/hono/hubspot-connect-routes/auth-refresh.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/cimd-client-metadata-types.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/cimd-public-routes.js +4 -1
- package/dist/server/hono/hubspot-connect-routes/cimd-public-routes.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/fetch-hubspot-client-metadata.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/hubspot-connect-routes.js +4 -2
- package/dist/server/hono/hubspot-connect-routes/hubspot-connect-routes.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/load-hubspot-connect-routes-env.js +5 -5
- package/dist/server/hono/hubspot-connect-routes/load-hubspot-connect-routes-env.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/oauth-client.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/utils.js +53 -6
- package/dist/server/hono/hubspot-connect-routes/utils.js.map +1 -1
- package/dist/server/hono/hubspot-connect-routes/whoami.js +51 -0
- package/dist/server/hono/hubspot-connect-routes/whoami.js.map +1 -0
- package/dist/server/hono/types.d.ts +9 -10
- package/dist/server/hono/utils/cookie-utils.js +2 -1
- package/dist/server/hono/utils/cookie-utils.js.map +1 -1
- package/dist/server/hono/utils/cors-middleware.js +85 -0
- package/dist/server/hono/utils/cors-middleware.js.map +1 -0
- package/dist/server/import-app-keys.js.map +1 -1
- package/dist/server/lovable/create-app-function-start.d.ts +1 -1
- package/dist/server/lovable/create-app-function-start.js +4 -6
- package/dist/server/lovable/create-app-function-start.js.map +1 -1
- package/dist/server/lovable/hubspot-connect/index.js.map +1 -1
- package/dist/server/lovable/hubspot-connect/run-hubspot-connect-lovable-server.js +14 -15
- package/dist/server/lovable/hubspot-connect/run-hubspot-connect-lovable-server.js.map +1 -1
- package/dist/server/sanitize-request.js +14 -11
- package/dist/server/sanitize-request.js.map +1 -1
- package/dist/server/secure-start-core.js +4 -5
- package/dist/server/secure-start-core.js.map +1 -1
- package/dist/server/shared/constants.js +22 -9
- package/dist/server/shared/constants.js.map +1 -1
- package/dist/server/shared/encoding/base64.js.map +1 -1
- package/dist/server/shared/encoding/sha256.js.map +1 -1
- package/dist/server/shared/logger.js.map +1 -1
- package/dist/server/types.d.ts +1 -35
- package/dist/server/utils/cookie-utils.js.map +1 -1
- package/dist/server/utils/dpop-utils.js.map +1 -1
- package/dist/server/utils/env-utils.js +60 -7
- package/dist/server/utils/env-utils.js.map +1 -1
- package/dist/server/utils/hubspot-dpop-auth-headers.js +38 -0
- package/dist/server/utils/hubspot-dpop-auth-headers.js.map +1 -0
- package/dist/server/utils/jwk-utils.js.map +1 -1
- package/dist/server/utils/jwt-utils.js.map +1 -1
- package/package.json +15 -21
- package/src/browser/app-connect-controller/README.md +5 -2
- package/src/browser/app-connect-controller/connect-start.test.ts +157 -0
- package/src/browser/app-connect-controller/connect-start.ts +18 -3
- package/src/browser/app-connect-controller/constants.ts +6 -4
- package/src/browser/app-connect-controller/create.ts +8 -2
- package/src/browser/app-connect-controller/disconnect.ts +5 -7
- package/src/browser/app-connect-controller/init.test.ts +275 -0
- package/src/browser/app-connect-controller/init.ts +44 -19
- package/src/browser/app-connect-controller/oauth-complete.test.ts +110 -0
- package/src/browser/app-connect-controller/oauth-complete.ts +53 -0
- package/src/browser/app-connect-controller/oauth-popup.test.ts +239 -0
- package/src/browser/app-connect-controller/oauth-popup.ts +160 -0
- package/src/browser/app-connect-controller/types.ts +3 -0
- package/src/browser/app-connect-controller/utils/iframe-utils.ts +12 -0
- package/src/browser/app-connect-controller/utils/resolve-oauth-connect-mode.test.ts +35 -0
- package/src/browser/app-connect-controller/utils/resolve-oauth-connect-mode.ts +21 -0
- package/src/browser/app-connect-controller/utils/session-utils.test.ts +73 -22
- package/src/browser/app-connect-controller/utils/session-utils.ts +74 -33
- package/src/browser/app-connect-controller/view-state.test.ts +1 -0
- package/src/browser/app-connect-controller/view-state.ts +1 -0
- package/src/browser/index.ts +1 -0
- package/src/browser/react/components/AppConnectHeader/AppConnectHeader.tsx +21 -34
- package/src/browser/react/components/ConnectButton/ConnectButton.tsx +1 -1
- package/src/browser/react/lovable/LovableHubSpotAppConnect.tsx +12 -2
- package/src/browser/types.ts +30 -5
- package/src/server/api-client-core/__tests__/errors.test.ts +309 -0
- package/src/server/api-client-core/__tests__/operation-headers.test.ts +251 -0
- package/src/server/api-client-core/apis/account/account-info-types.generated.ts +74 -88
- package/src/server/api-client-core/apis/account/account-info.generated.ts +2 -4
- package/src/server/api-client-core/apis/account/audit-logs-types.generated.ts +346 -360
- package/src/server/api-client-core/apis/account/audit-logs.generated.ts +2 -4
- package/src/server/api-client-core/apis/auth/oauth-types.generated.ts +81 -99
- package/src/server/api-client-core/apis/auth/oauth.generated.ts +1 -3
- package/src/server/api-client-core/apis/automation/actions-types.generated.ts +1162 -1188
- package/src/server/api-client-core/apis/automation/actions.generated.ts +10 -12
- package/src/server/api-client-core/apis/automation/sequences-types.generated.ts +379 -393
- package/src/server/api-client-core/apis/automation/sequences.generated.ts +1 -3
- package/src/server/api-client-core/apis/business-units-types.generated.ts +43 -59
- package/src/server/api-client-core/apis/business-units.generated.ts +9 -10
- package/src/server/api-client-core/apis/cms/authors-types.generated.ts +3823 -3853
- package/src/server/api-client-core/apis/cms/authors.generated.ts +31 -37
- package/src/server/api-client-core/apis/cms/blog-settings-types.generated.ts +3667 -3696
- package/src/server/api-client-core/apis/cms/blog-settings.generated.ts +46 -51
- package/src/server/api-client-core/apis/cms/cms-content-audit-types.generated.ts +138 -163
- package/src/server/api-client-core/apis/cms/cms-content-audit.generated.ts +2 -10
- package/src/server/api-client-core/apis/cms/domains-types.generated.ts +153 -167
- package/src/server/api-client-core/apis/cms/domains.generated.ts +2 -4
- package/src/server/api-client-core/apis/cms/hubdb-types.generated.ts +1013 -1063
- package/src/server/api-client-core/apis/cms/hubdb.generated.ts +3 -5
- package/src/server/api-client-core/apis/cms/media-bridge-types.generated.ts +8623 -8657
- package/src/server/api-client-core/apis/cms/media-bridge.generated.ts +16 -22
- package/src/server/api-client-core/apis/cms/pages-types.generated.ts +5259 -5272
- package/src/server/api-client-core/apis/cms/pages.generated.ts +262 -226
- package/src/server/api-client-core/apis/cms/posts-types.generated.ts +4420 -4438
- package/src/server/api-client-core/apis/cms/posts.generated.ts +108 -106
- package/src/server/api-client-core/apis/cms/site-search-types.generated.ts +1867 -1881
- package/src/server/api-client-core/apis/cms/site-search.generated.ts +2 -4
- package/src/server/api-client-core/apis/cms/source-code-types.generated.ts +144 -177
- package/src/server/api-client-core/apis/cms/source-code.generated.ts +15 -23
- package/src/server/api-client-core/apis/cms/tags-types.generated.ts +3820 -3845
- package/src/server/api-client-core/apis/cms/tags.generated.ts +80 -82
- package/src/server/api-client-core/apis/cms/url-mappings-types.generated.ts +188 -202
- package/src/server/api-client-core/apis/cms/url-mappings.generated.ts +2 -4
- package/src/server/api-client-core/apis/cms/url-redirects-types.generated.ts +182 -196
- package/src/server/api-client-core/apis/cms/url-redirects.generated.ts +2 -4
- package/src/server/api-client-core/apis/communication-preferences/subscriptions-types.generated.ts +810 -828
- package/src/server/api-client-core/apis/communication-preferences/subscriptions.generated.ts +66 -63
- package/src/server/api-client-core/apis/conversations/custom-channels-types.generated.ts +564 -601
- package/src/server/api-client-core/apis/conversations/custom-channels.generated.ts +90 -86
- package/src/server/api-client-core/apis/conversations/visitor-identification-types.generated.ts +31 -44
- package/src/server/api-client-core/apis/conversations/visitor-identification.generated.ts +6 -8
- package/src/server/api-client-core/apis/conversations-types.generated.ts +955 -991
- package/src/server/api-client-core/apis/conversations.generated.ts +6 -5
- package/src/server/api-client-core/apis/crm/app-uninstalls-types.generated.ts +7 -19
- package/src/server/api-client-core/apis/crm/app-uninstalls.generated.ts +2 -4
- package/src/server/api-client-core/apis/crm/appointments-types.generated.ts +965 -969
- package/src/server/api-client-core/apis/crm/appointments.generated.ts +143 -137
- package/src/server/api-client-core/apis/crm/associations-schema-types.generated.ts +292 -322
- package/src/server/api-client-core/apis/crm/associations-schema.generated.ts +17 -19
- package/src/server/api-client-core/apis/crm/associations-types.generated.ts +657 -675
- package/src/server/api-client-core/apis/crm/associations.generated.ts +70 -70
- package/src/server/api-client-core/apis/crm/calling-extensions-types.generated.ts +417 -441
- package/src/server/api-client-core/apis/crm/calling-extensions.generated.ts +62 -69
- package/src/server/api-client-core/apis/crm/calls-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/calls.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/carts-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/carts.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/commerce-payments-types.generated.ts +847 -856
- package/src/server/api-client-core/apis/crm/commerce-payments.generated.ts +73 -73
- package/src/server/api-client-core/apis/crm/commerce-subscriptions-types.generated.ts +844 -853
- package/src/server/api-client-core/apis/crm/commerce-subscriptions.generated.ts +50 -51
- package/src/server/api-client-core/apis/crm/communications-types.generated.ts +846 -856
- package/src/server/api-client-core/apis/crm/communications.generated.ts +73 -73
- package/src/server/api-client-core/apis/crm/companies-types.generated.ts +859 -885
- package/src/server/api-client-core/apis/crm/companies.generated.ts +44 -50
- package/src/server/api-client-core/apis/crm/contacts-types.generated.ts +875 -907
- package/src/server/api-client-core/apis/crm/contacts.generated.ts +46 -52
- package/src/server/api-client-core/apis/crm/contracts-types.generated.ts +894 -862
- package/src/server/api-client-core/apis/crm/contracts.generated.ts +66 -56
- package/src/server/api-client-core/apis/crm/courses-types.generated.ts +842 -859
- package/src/server/api-client-core/apis/crm/courses.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/crm-owners-types.generated.ts +102 -115
- package/src/server/api-client-core/apis/crm/crm-owners.generated.ts +2 -4
- package/src/server/api-client-core/apis/crm/custom-objects-types.generated.ts +900 -915
- package/src/server/api-client-core/apis/crm/custom-objects.generated.ts +128 -126
- package/src/server/api-client-core/apis/crm/deal-splits-types.generated.ts +157 -170
- package/src/server/api-client-core/apis/crm/deal-splits.generated.ts +2 -4
- package/src/server/api-client-core/apis/crm/deals-types.generated.ts +858 -875
- package/src/server/api-client-core/apis/crm/deals.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/discounts-types.generated.ts +842 -855
- package/src/server/api-client-core/apis/crm/discounts.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/emails-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/emails.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/exports-types.generated.ts +284 -314
- package/src/server/api-client-core/apis/crm/exports.generated.ts +6 -11
- package/src/server/api-client-core/apis/crm/feedback-submissions-types.generated.ts +607 -622
- package/src/server/api-client-core/apis/crm/feedback-submissions.generated.ts +84 -80
- package/src/server/api-client-core/apis/crm/fees-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/fees.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/goal-targets-types.generated.ts +845 -856
- package/src/server/api-client-core/apis/crm/goal-targets.generated.ts +50 -51
- package/src/server/api-client-core/apis/crm/imports-types.generated.ts +663 -692
- package/src/server/api-client-core/apis/crm/imports.generated.ts +2 -7
- package/src/server/api-client-core/apis/crm/invoices-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/invoices.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/leads-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/leads.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/limits-tracking-types.generated.ts +263 -275
- package/src/server/api-client-core/apis/crm/limits-tracking.generated.ts +2 -4
- package/src/server/api-client-core/apis/crm/line-items-types.generated.ts +843 -856
- package/src/server/api-client-core/apis/crm/line-items.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/listings-types.generated.ts +842 -859
- package/src/server/api-client-core/apis/crm/listings.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/lists-types.generated.ts +2794 -2845
- package/src/server/api-client-core/apis/crm/lists.generated.ts +8 -20
- package/src/server/api-client-core/apis/crm/meetings-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/meetings.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/notes-types.generated.ts +839 -856
- package/src/server/api-client-core/apis/crm/notes.generated.ts +42 -44
- package/src/server/api-client-core/apis/crm/object-library-types.generated.ts +26 -39
- package/src/server/api-client-core/apis/crm/object-library.generated.ts +2 -4
- package/src/server/api-client-core/apis/crm/objects-types.generated.ts +688 -716
- package/src/server/api-client-core/apis/crm/objects.generated.ts +79 -83
- package/src/server/api-client-core/apis/crm/orders-types.generated.ts +829 -846
- package/src/server/api-client-core/apis/crm/orders.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/partner-clients-types.generated.ts +721 -735
- package/src/server/api-client-core/apis/crm/partner-clients.generated.ts +60 -60
- package/src/server/api-client-core/apis/crm/partner-services-types.generated.ts +720 -734
- package/src/server/api-client-core/apis/crm/partner-services.generated.ts +60 -60
- package/src/server/api-client-core/apis/crm/pipelines-types.generated.ts +366 -388
- package/src/server/api-client-core/apis/crm/pipelines.generated.ts +2 -4
- package/src/server/api-client-core/apis/crm/postal-mail-types.generated.ts +830 -843
- package/src/server/api-client-core/apis/crm/postal-mail.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/products-types.generated.ts +829 -846
- package/src/server/api-client-core/apis/crm/products.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/projects-types.generated.ts +845 -875
- package/src/server/api-client-core/apis/crm/projects.generated.ts +47 -53
- package/src/server/api-client-core/apis/crm/properties-types.generated.ts +623 -626
- package/src/server/api-client-core/apis/crm/properties.generated.ts +33 -28
- package/src/server/api-client-core/apis/crm/property-validations-types.generated.ts +160 -174
- package/src/server/api-client-core/apis/crm/property-validations.generated.ts +2 -6
- package/src/server/api-client-core/apis/crm/public-app-crm-cards-types.generated.ts +467 -494
- package/src/server/api-client-core/apis/crm/public-app-crm-cards.generated.ts +7 -15
- package/src/server/api-client-core/apis/crm/public-app-feature-flags-types.generated.ts +166 -177
- package/src/server/api-client-core/apis/crm/public-app-feature-flags.generated.ts +6 -8
- package/src/server/api-client-core/apis/crm/quotes-types.generated.ts +829 -846
- package/src/server/api-client-core/apis/crm/quotes.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/schemas-types.generated.ts +613 -640
- package/src/server/api-client-core/apis/crm/schemas.generated.ts +8 -14
- package/src/server/api-client-core/apis/crm/services-types.generated.ts +832 -849
- package/src/server/api-client-core/apis/crm/services.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/tasks-types.generated.ts +829 -846
- package/src/server/api-client-core/apis/crm/tasks.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/taxes-types.generated.ts +829 -846
- package/src/server/api-client-core/apis/crm/taxes.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/tickets-types.generated.ts +848 -878
- package/src/server/api-client-core/apis/crm/tickets.generated.ts +47 -53
- package/src/server/api-client-core/apis/crm/timeline-types.generated.ts +144 -161
- package/src/server/api-client-core/apis/crm/timeline.generated.ts +6 -8
- package/src/server/api-client-core/apis/crm/transcriptions-types.generated.ts +149 -164
- package/src/server/api-client-core/apis/crm/transcriptions.generated.ts +22 -22
- package/src/server/api-client-core/apis/crm/users-types.generated.ts +829 -846
- package/src/server/api-client-core/apis/crm/users.generated.ts +45 -47
- package/src/server/api-client-core/apis/crm/video-conferencing-extension-types.generated.ts +29 -42
- package/src/server/api-client-core/apis/crm/video-conferencing-extension.generated.ts +17 -19
- package/src/server/api-client-core/apis/events/manage-event-definitions-types.generated.ts +1509 -1558
- package/src/server/api-client-core/apis/events/manage-event-definitions.generated.ts +55 -65
- package/src/server/api-client-core/apis/events/send-event-completions-types.generated.ts +51 -68
- package/src/server/api-client-core/apis/events/send-event-completions.generated.ts +10 -10
- package/src/server/api-client-core/apis/events-types.generated.ts +97 -110
- package/src/server/api-client-core/apis/events.generated.ts +2 -4
- package/src/server/api-client-core/apis/files-types.generated.ts +727 -757
- package/src/server/api-client-core/apis/files.generated.ts +3 -5
- package/src/server/api-client-core/apis/marketing/campaigns-public-api-types.generated.ts +1221 -1234
- package/src/server/api-client-core/apis/marketing/campaigns-public-api.generated.ts +45 -47
- package/src/server/api-client-core/apis/marketing/marketing-emails-types.generated.ts +3704 -3733
- package/src/server/api-client-core/apis/marketing/marketing-emails.generated.ts +44 -52
- package/src/server/api-client-core/apis/marketing/marketing-events-types.generated.ts +1787 -1848
- package/src/server/api-client-core/apis/marketing/marketing-events.generated.ts +236 -241
- package/src/server/api-client-core/apis/marketing/single-send-types.generated.ts +142 -155
- package/src/server/api-client-core/apis/marketing/single-send.generated.ts +2 -6
- package/src/server/api-client-core/apis/marketing/transactional-single-send-types.generated.ts +253 -269
- package/src/server/api-client-core/apis/marketing/transactional-single-send.generated.ts +32 -31
- package/src/server/api-client-core/apis/meta/origins-types.generated.ts +40 -56
- package/src/server/api-client-core/apis/meta/origins.generated.ts +2 -4
- package/src/server/api-client-core/apis/scheduler/meetings-types.generated.ts +1001 -1014
- package/src/server/api-client-core/apis/scheduler/meetings.generated.ts +6 -8
- package/src/server/api-client-core/apis/settings/multicurrency-types.generated.ts +1906 -1912
- package/src/server/api-client-core/apis/settings/multicurrency.generated.ts +64 -63
- package/src/server/api-client-core/apis/settings/tax-rates-types.generated.ts +71 -85
- package/src/server/api-client-core/apis/settings/tax-rates.generated.ts +2 -4
- package/src/server/api-client-core/apis/settings/user-provisioning-types.generated.ts +207 -257
- package/src/server/api-client-core/apis/settings/user-provisioning.generated.ts +8 -24
- package/src/server/api-client-core/apis/webhooks-journal-types.generated.ts +740 -771
- package/src/server/api-client-core/apis/webhooks-journal.generated.ts +47 -59
- package/src/server/api-client-core/apis/webhooks-types.generated.ts +1194 -1228
- package/src/server/api-client-core/apis/webhooks.generated.ts +52 -64
- package/src/server/api-client-core/client.ts +5 -1
- package/src/server/api-client-core/pagination.ts +2 -2
- package/src/server/api-client-core/plugins/fetch-transport.ts +70 -12
- package/src/server/api-client-core/types.ts +1 -1
- package/src/server/constants.ts +29 -4
- package/src/server/hono/hono-request-handler.ts +68 -27
- package/src/server/hono/hubspot-connect-routes/auth-complete.test.ts +394 -0
- package/src/server/hono/hubspot-connect-routes/{auth-callback.ts → auth-complete.ts} +81 -30
- package/src/server/hono/hubspot-connect-routes/auth-init-session.test.ts +114 -30
- package/src/server/hono/hubspot-connect-routes/auth-init-session.ts +35 -10
- package/src/server/hono/hubspot-connect-routes/auth-logout.test.ts +13 -0
- package/src/server/hono/hubspot-connect-routes/auth-logout.ts +39 -10
- package/src/server/hono/hubspot-connect-routes/auth-refresh.test.ts +6 -0
- package/src/server/hono/hubspot-connect-routes/auth-refresh.ts +24 -9
- package/src/server/hono/hubspot-connect-routes/cimd-public-routes.test.ts +7 -6
- package/src/server/hono/hubspot-connect-routes/cimd-public-routes.ts +5 -1
- package/src/server/hono/hubspot-connect-routes/hubspot-connect-routes.ts +11 -3
- package/src/server/hono/hubspot-connect-routes/load-hubspot-connect-routes-env.test.ts +17 -24
- package/src/server/hono/hubspot-connect-routes/load-hubspot-connect-routes-env.ts +8 -8
- package/src/server/hono/hubspot-connect-routes/utils.test.ts +16 -46
- package/src/server/hono/hubspot-connect-routes/utils.ts +61 -5
- package/src/server/hono/hubspot-connect-routes/whoami.ts +74 -0
- package/src/server/hono/types.ts +11 -10
- package/src/server/hono/utils/cookie-utils.ts +27 -2
- package/src/server/hono/utils/cors-middleware.test.ts +80 -0
- package/src/server/hono/utils/cors-middleware.ts +95 -0
- package/src/server/lovable/create-app-function-start.ts +4 -7
- package/src/server/lovable/hubspot-connect/run-hubspot-connect-lovable-server.ts +21 -16
- package/src/server/sanitize-request.ts +15 -12
- package/src/server/secure-start-core.ts +7 -6
- package/src/server/types.ts +2 -38
- package/src/server/utils/env-utils.test.ts +140 -12
- package/src/server/utils/env-utils.ts +80 -6
- package/src/server/utils/hubspot-dpop-auth-headers.test.ts +43 -0
- package/src/server/utils/hubspot-dpop-auth-headers.ts +48 -0
- package/src/shared/constants.ts +40 -3
- package/src/shared/wire-types.ts +49 -0
- package/dist/browser/HubSpotAppConnect-BW45gyDs.js.map +0 -1
- package/dist/browser/create-vctOhpX9.js.map +0 -1
- package/dist/server/hono/hubspot-connect-routes/auth-callback.js +0 -125
- package/dist/server/hono/hubspot-connect-routes/auth-callback.js.map +0 -1
- package/dist/server/proxy.js +0 -68
- package/dist/server/proxy.js.map +0 -1
- package/src/server/hono/hubspot-connect-routes/auth-callback.test.ts +0 -225
- package/src/server/proxy.test.ts +0 -80
- package/src/server/proxy.ts +0 -116
|
@@ -2,1352 +2,1300 @@
|
|
|
2
2
|
|
|
3
3
|
import type { Operation } from '../../types.ts';
|
|
4
4
|
|
|
5
|
-
export namespace
|
|
6
|
-
export
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
*/
|
|
12
|
-
assetId: string;
|
|
13
|
-
/**
|
|
14
|
-
* The type of asset to disassociate, required
|
|
15
|
-
* Example: OBJECT_LIST
|
|
16
|
-
*/
|
|
17
|
-
assetType: string;
|
|
18
|
-
/**
|
|
19
|
-
* The UUID of the campaign, required
|
|
20
|
-
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
21
|
-
*/
|
|
22
|
-
campaignGuid: string;
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
export type DeleteOutput = void;
|
|
26
|
-
|
|
27
|
-
export interface ListInput {
|
|
28
|
-
/**
|
|
29
|
-
* 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.
|
|
30
|
-
*/
|
|
31
|
-
after?: string;
|
|
32
|
-
/**
|
|
33
|
-
* The type of asset to fetch, required
|
|
34
|
-
* Example: MARKETING_EVENT
|
|
35
|
-
*/
|
|
36
|
-
assetType: string;
|
|
37
|
-
/**
|
|
38
|
-
* The UUID of the campaign, required
|
|
39
|
-
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
40
|
-
*/
|
|
41
|
-
campaignGuid: string;
|
|
42
|
-
/**
|
|
43
|
-
* 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.
|
|
44
|
-
* Example: 2024-01-27
|
|
45
|
-
*/
|
|
46
|
-
endDate?: string;
|
|
47
|
-
/**
|
|
48
|
-
* The maximum number of results to display per page.
|
|
49
|
-
*/
|
|
50
|
-
limit?: string;
|
|
51
|
-
/**
|
|
52
|
-
* 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.
|
|
53
|
-
* Example: 2023-01-20
|
|
54
|
-
*/
|
|
55
|
-
startDate?: string;
|
|
56
|
-
}
|
|
57
|
-
|
|
58
|
-
export type ListOutput =
|
|
59
|
-
Schemas.CollectionResponsePublicCampaignAssetForwardPaging;
|
|
60
|
-
|
|
61
|
-
export interface UpdateInput {
|
|
62
|
-
/**
|
|
63
|
-
* The id of asset to disassociate, required
|
|
64
|
-
* Example: 154543
|
|
65
|
-
*/
|
|
66
|
-
assetId: string;
|
|
67
|
-
/**
|
|
68
|
-
* The type of asset to disassociate, required
|
|
69
|
-
* Example: OBJECT_LIST
|
|
70
|
-
*/
|
|
71
|
-
assetType: string;
|
|
72
|
-
/**
|
|
73
|
-
* The UUID of the campaign, required
|
|
74
|
-
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
75
|
-
*/
|
|
76
|
-
campaignGuid: string;
|
|
77
|
-
}
|
|
78
|
-
|
|
79
|
-
export type UpdateOutput = void;
|
|
5
|
+
export namespace MarketingCampaignsPublicApiSchemas {
|
|
6
|
+
export interface BatchInputPublicCampaignBatchUpdateItem {
|
|
7
|
+
/**
|
|
8
|
+
* An array of PublicCampaignBatchUpdateItem objects, each containing the ID and properties to update for a specific campaign.
|
|
9
|
+
*/
|
|
10
|
+
inputs: PublicCampaignBatchUpdateItem[];
|
|
80
11
|
}
|
|
81
12
|
|
|
82
|
-
export
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
export interface DeleteInput {
|
|
88
|
-
/**
|
|
89
|
-
* The UUID of the campaign, required
|
|
90
|
-
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
91
|
-
*/
|
|
92
|
-
campaignGuid: string;
|
|
93
|
-
}
|
|
94
|
-
|
|
95
|
-
export type DeleteOutput = void;
|
|
96
|
-
|
|
97
|
-
export interface GetInput {
|
|
98
|
-
/**
|
|
99
|
-
* The UUID of the campaign, required
|
|
100
|
-
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
101
|
-
*/
|
|
102
|
-
campaignGuid: string;
|
|
103
|
-
/**
|
|
104
|
-
* The end date for fetching asset metrics, in YYYY-MM-DD format.
|
|
105
|
-
* Optional. Example: 2000-01-27
|
|
106
|
-
*/
|
|
107
|
-
endDate?: string;
|
|
108
|
-
/**
|
|
109
|
-
* A comma-separated list of properties to include in the response.
|
|
110
|
-
* Unrecognized properties are ignored. Optional. Example: hs_name,hs_budget, hs_notes
|
|
111
|
-
*/
|
|
112
|
-
properties?: string[];
|
|
113
|
-
/**
|
|
114
|
-
* The start date for fetching asset metrics, in YYYY-MM-DD format.
|
|
115
|
-
* Optional. Example: 2000-01-20
|
|
116
|
-
*/
|
|
117
|
-
startDate?: string;
|
|
118
|
-
}
|
|
119
|
-
|
|
120
|
-
export type GetOutput = Schemas.PublicCampaignWithAssets;
|
|
121
|
-
|
|
122
|
-
export interface ListInput {
|
|
123
|
-
/**
|
|
124
|
-
* 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.
|
|
125
|
-
*/
|
|
126
|
-
after?: string;
|
|
127
|
-
/**
|
|
128
|
-
* The maximum number of results to display per page.
|
|
129
|
-
*/
|
|
130
|
-
limit?: number;
|
|
131
|
-
/**
|
|
132
|
-
* Filter campaigns by name. Optional.
|
|
133
|
-
*/
|
|
134
|
-
name?: string;
|
|
135
|
-
/**
|
|
136
|
-
* A comma-separated list of properties to include in the response.
|
|
137
|
-
* Unrecognized properties are ignored. Optional. Example:
|
|
138
|
-
* hs_name, hs_budget,hs_notes
|
|
139
|
-
*/
|
|
140
|
-
properties?: string[];
|
|
141
|
-
/**
|
|
142
|
-
* The property to sort results by. Optional.
|
|
143
|
-
*/
|
|
144
|
-
sort?: string;
|
|
145
|
-
}
|
|
146
|
-
|
|
147
|
-
export type ListOutput = Schemas.CollectionResponseWithTotalPublicCampaign;
|
|
148
|
-
|
|
149
|
-
export interface UpdateInput {
|
|
150
|
-
/**
|
|
151
|
-
* The UUID of the campaign, required
|
|
152
|
-
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
153
|
-
*/
|
|
154
|
-
campaignGuid: string;
|
|
155
|
-
data: Schemas.PublicCampaignInput;
|
|
156
|
-
}
|
|
157
|
-
|
|
158
|
-
export type UpdateOutput = Schemas.PublicCampaign;
|
|
13
|
+
export interface BatchInputPublicCampaignDeleteInput {
|
|
14
|
+
/**
|
|
15
|
+
* An array of PublicCampaignDeleteInput objects, each specifying a campaign to be deleted. Each object must include the campaign's unique identifier.
|
|
16
|
+
*/
|
|
17
|
+
inputs: PublicCampaignDeleteInput[];
|
|
159
18
|
}
|
|
160
19
|
|
|
161
|
-
export
|
|
162
|
-
|
|
20
|
+
export interface BatchInputPublicCampaignInput {
|
|
21
|
+
/**
|
|
22
|
+
* An array of PublicCampaignInput objects, each representing the properties of a campaign to be created in the batch. This property is required.
|
|
23
|
+
*/
|
|
24
|
+
inputs: PublicCampaignInput[];
|
|
25
|
+
}
|
|
163
26
|
|
|
164
|
-
|
|
27
|
+
export interface BatchInputPublicCampaignReadInput {
|
|
28
|
+
/**
|
|
29
|
+
* An array of PublicCampaignReadInput objects, each containing the ID of a campaign to be read. This property is required.
|
|
30
|
+
*/
|
|
31
|
+
inputs: PublicCampaignReadInput[];
|
|
32
|
+
}
|
|
165
33
|
|
|
166
|
-
|
|
34
|
+
export interface BatchResponsePublicCampaign {
|
|
35
|
+
/**
|
|
36
|
+
* The date and time when the batch operation was completed, formatted as a date-time string.
|
|
37
|
+
*/
|
|
38
|
+
completedAt: string;
|
|
39
|
+
/**
|
|
40
|
+
* A map of related links associated with the batch operation.
|
|
41
|
+
*/
|
|
42
|
+
links?: Record<string, string>;
|
|
43
|
+
/**
|
|
44
|
+
* The date and time when the batch operation was requested, formatted as a date-time string.
|
|
45
|
+
*/
|
|
46
|
+
requestedAt?: string;
|
|
47
|
+
/**
|
|
48
|
+
* An array of results from the batch operation, each item representing a public campaign.
|
|
49
|
+
*/
|
|
50
|
+
results: PublicCampaign[];
|
|
51
|
+
/**
|
|
52
|
+
* The date and time when the batch operation started, formatted as a date-time string.
|
|
53
|
+
*/
|
|
54
|
+
startedAt: string;
|
|
55
|
+
/**
|
|
56
|
+
* The current status of the batch operation, with possible values: CANCELED, COMPLETE, PENDING, PROCESSING.
|
|
57
|
+
*/
|
|
58
|
+
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
export interface BatchResponsePublicCampaignWithAssets {
|
|
62
|
+
/**
|
|
63
|
+
* The timestamp when the batch request processing was completed.
|
|
64
|
+
*/
|
|
65
|
+
completedAt: string;
|
|
66
|
+
/**
|
|
67
|
+
* A collection of URLs linking to related resources or documentation.
|
|
68
|
+
*/
|
|
69
|
+
links?: Record<string, string>;
|
|
70
|
+
/**
|
|
71
|
+
* The timestamp when the batch request was initially made.
|
|
72
|
+
*/
|
|
73
|
+
requestedAt?: string;
|
|
74
|
+
/**
|
|
75
|
+
* An array of results from the batch operation, each representing a public campaign with assets.
|
|
76
|
+
*/
|
|
77
|
+
results: PublicCampaignWithAssets[];
|
|
78
|
+
/**
|
|
79
|
+
* The timestamp when the processing of the batch request began.
|
|
80
|
+
*/
|
|
81
|
+
startedAt: string;
|
|
82
|
+
/**
|
|
83
|
+
* The current processing status of the batch operation, with possible values: CANCELED, COMPLETE, PENDING, PROCESSING.
|
|
84
|
+
*/
|
|
85
|
+
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
86
|
+
}
|
|
167
87
|
|
|
168
|
-
|
|
88
|
+
export interface CollectionResponseContactReferenceForwardPaging {
|
|
89
|
+
paging?: ForwardPaging;
|
|
90
|
+
/**
|
|
91
|
+
* An array of contact references, each containing an identifier for a contact.
|
|
92
|
+
*/
|
|
93
|
+
results: ContactReference[];
|
|
94
|
+
}
|
|
169
95
|
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
/**
|
|
178
|
-
* 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.
|
|
179
|
-
* Example: hs_name, hs_campaign_status, hs_notes
|
|
180
|
-
*/
|
|
181
|
-
properties?: string[];
|
|
182
|
-
/**
|
|
183
|
-
* 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.
|
|
184
|
-
* Example: 2023-01-20
|
|
185
|
-
*/
|
|
186
|
-
startDate?: string;
|
|
187
|
-
}
|
|
96
|
+
export interface CollectionResponsePublicCampaignAsset {
|
|
97
|
+
paging?: Paging;
|
|
98
|
+
/**
|
|
99
|
+
* An array of public campaign assets. Each item in the array is an object representing a campaign asset.
|
|
100
|
+
*/
|
|
101
|
+
results: PublicCampaignAsset[];
|
|
102
|
+
}
|
|
188
103
|
|
|
189
|
-
|
|
104
|
+
export interface CollectionResponsePublicCampaignAssetForwardPaging {
|
|
105
|
+
paging?: ForwardPaging;
|
|
106
|
+
/**
|
|
107
|
+
* An array of public campaign assets. Each item in the array is a reference to a PublicCampaignAsset object.
|
|
108
|
+
*/
|
|
109
|
+
results: PublicCampaignAsset[];
|
|
110
|
+
}
|
|
190
111
|
|
|
191
|
-
|
|
112
|
+
export interface CollectionResponseWithTotalPublicCampaign {
|
|
113
|
+
paging?: Paging;
|
|
114
|
+
/**
|
|
115
|
+
* An array of PublicCampaign objects, each representing a campaign with its associated properties.
|
|
116
|
+
*/
|
|
117
|
+
results: PublicCampaign[];
|
|
118
|
+
/**
|
|
119
|
+
* An integer representing the total number of public campaigns available.
|
|
120
|
+
*/
|
|
121
|
+
total: number;
|
|
122
|
+
}
|
|
192
123
|
|
|
193
|
-
|
|
124
|
+
export interface ContactReference {
|
|
125
|
+
/**
|
|
126
|
+
* Unique identifier for the contact.
|
|
127
|
+
*/
|
|
128
|
+
id: string;
|
|
194
129
|
}
|
|
195
130
|
|
|
196
|
-
export
|
|
197
|
-
|
|
198
|
-
/**
|
|
199
|
-
* The UUID of the campaign, required
|
|
200
|
-
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
201
|
-
*/
|
|
202
|
-
campaignGuid: string;
|
|
203
|
-
data: Schemas.PublicBudgetItemInput;
|
|
204
|
-
}
|
|
205
|
-
|
|
206
|
-
export type CreateOutput = Schemas.PublicBudgetItem;
|
|
207
|
-
|
|
208
|
-
export interface DeleteInput {
|
|
209
|
-
/**
|
|
210
|
-
* The ID of the budget item, required. Example: 352
|
|
211
|
-
*/
|
|
212
|
-
budgetId: number;
|
|
213
|
-
/**
|
|
214
|
-
* The UUID of the campaign, required
|
|
215
|
-
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
216
|
-
*/
|
|
217
|
-
campaignGuid: string;
|
|
218
|
-
}
|
|
219
|
-
|
|
220
|
-
export type DeleteOutput = void;
|
|
221
|
-
|
|
222
|
-
export interface GetInput {
|
|
223
|
-
/**
|
|
224
|
-
* The ID of the budget item, required. Example: 352
|
|
225
|
-
*/
|
|
226
|
-
budgetId: number;
|
|
227
|
-
/**
|
|
228
|
-
* The UUID of the campaign, required
|
|
229
|
-
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
230
|
-
*/
|
|
231
|
-
campaignGuid: string;
|
|
232
|
-
}
|
|
233
|
-
|
|
234
|
-
export type GetOutput = Schemas.PublicBudgetItem;
|
|
235
|
-
|
|
236
|
-
export interface GetTotalsInput {
|
|
237
|
-
/**
|
|
238
|
-
* The UUID of the campaign, required
|
|
239
|
-
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
240
|
-
*/
|
|
241
|
-
campaignGuid: string;
|
|
242
|
-
}
|
|
243
|
-
|
|
244
|
-
export type GetTotalsOutput = Schemas.PublicBudgetTotals;
|
|
245
|
-
|
|
246
|
-
export interface UpdateInput {
|
|
247
|
-
/**
|
|
248
|
-
* The ID of the budget item, required. Example: 352
|
|
249
|
-
*/
|
|
250
|
-
budgetId: number;
|
|
251
|
-
/**
|
|
252
|
-
* The UUID of the campaign, required
|
|
253
|
-
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
254
|
-
*/
|
|
255
|
-
campaignGuid: string;
|
|
256
|
-
data: Schemas.PublicBudgetItemInput;
|
|
257
|
-
}
|
|
258
|
-
|
|
259
|
-
export type UpdateOutput = Schemas.PublicBudgetItem;
|
|
131
|
+
export interface ForwardPaging {
|
|
132
|
+
next?: NextPage;
|
|
260
133
|
}
|
|
261
134
|
|
|
262
|
-
export
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
export type GetAttributionMetricsOutput = Schemas.MetricsCounters;
|
|
281
|
-
|
|
282
|
-
export interface GetRevenueAttributionInput {
|
|
283
|
-
/**
|
|
284
|
-
* 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
|
|
285
|
-
*/
|
|
286
|
-
attributionModel?: string;
|
|
287
|
-
/**
|
|
288
|
-
* The unique identifier of the campaign
|
|
289
|
-
*/
|
|
290
|
-
campaignGuid: string;
|
|
291
|
-
/**
|
|
292
|
-
* End date to fetch attribution data, YYYY-MM-DD
|
|
293
|
-
*/
|
|
294
|
-
endDate?: string;
|
|
295
|
-
/**
|
|
296
|
-
* Start date to fetch attribution data, YYYY-MM-DD
|
|
297
|
-
*/
|
|
298
|
-
startDate?: string;
|
|
299
|
-
}
|
|
300
|
-
|
|
301
|
-
export type GetRevenueAttributionOutput =
|
|
302
|
-
Schemas.RevenueAttributionAggregate;
|
|
303
|
-
|
|
304
|
-
export interface ListContactIdsByTypeInput {
|
|
305
|
-
/**
|
|
306
|
-
* 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.
|
|
307
|
-
*/
|
|
308
|
-
after?: string;
|
|
309
|
-
/**
|
|
310
|
-
* The unique identifier of the campaign
|
|
311
|
-
*/
|
|
312
|
-
campaignGuid: string;
|
|
313
|
-
/**
|
|
314
|
-
* The type of contact to filter the list
|
|
315
|
-
*/
|
|
316
|
-
contactType: string;
|
|
317
|
-
/**
|
|
318
|
-
* The end date for fetching contact data, in YYYY-MM-DD format.
|
|
319
|
-
* Optional. Example: 2000-01-27
|
|
320
|
-
*/
|
|
321
|
-
endDate?: string;
|
|
322
|
-
/**
|
|
323
|
-
* The maximum number of results to display per page.
|
|
324
|
-
*/
|
|
325
|
-
limit?: number;
|
|
326
|
-
/**
|
|
327
|
-
* The start date for fetching contact data, in YYYY-MM-DD format.
|
|
328
|
-
* Optional. Example: 2000-01-20
|
|
329
|
-
*/
|
|
330
|
-
startDate?: string;
|
|
331
|
-
}
|
|
332
|
-
|
|
333
|
-
export type ListContactIdsByTypeOutput =
|
|
334
|
-
Schemas.CollectionResponseContactReferenceForwardPaging;
|
|
135
|
+
export interface MetricsCounters {
|
|
136
|
+
/**
|
|
137
|
+
* The number of contacts influenced by the campaign.
|
|
138
|
+
*/
|
|
139
|
+
influencedContacts: number;
|
|
140
|
+
/**
|
|
141
|
+
* The number of new contacts attributed to the campaign as the first touchpoint.
|
|
142
|
+
*/
|
|
143
|
+
newContactsFirstTouch: number;
|
|
144
|
+
/**
|
|
145
|
+
* The number of new contacts attributed to the campaign as the last touchpoint.
|
|
146
|
+
*/
|
|
147
|
+
newContactsLastTouch: number;
|
|
148
|
+
/**
|
|
149
|
+
* The total number of sessions generated by the campaign.
|
|
150
|
+
*/
|
|
151
|
+
sessions: number;
|
|
335
152
|
}
|
|
336
153
|
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
inputs: Schemas.PublicCampaignDeleteInput[];
|
|
350
|
-
}
|
|
351
|
-
|
|
352
|
-
export interface BatchInputPublicCampaignInput {
|
|
353
|
-
/**
|
|
354
|
-
* An array of PublicCampaignInput objects, each representing the properties of a campaign to be created in the batch. This property is required.
|
|
355
|
-
*/
|
|
356
|
-
inputs: Schemas.PublicCampaignInput[];
|
|
357
|
-
}
|
|
358
|
-
|
|
359
|
-
export interface BatchInputPublicCampaignReadInput {
|
|
360
|
-
/**
|
|
361
|
-
* An array of PublicCampaignReadInput objects, each containing the ID of a campaign to be read. This property is required.
|
|
362
|
-
*/
|
|
363
|
-
inputs: Schemas.PublicCampaignReadInput[];
|
|
364
|
-
}
|
|
365
|
-
|
|
366
|
-
export interface BatchResponsePublicCampaign {
|
|
367
|
-
/**
|
|
368
|
-
* The date and time when the batch operation was completed, formatted as a date-time string.
|
|
369
|
-
*/
|
|
370
|
-
completedAt: string;
|
|
371
|
-
/**
|
|
372
|
-
* A map of related links associated with the batch operation.
|
|
373
|
-
*/
|
|
374
|
-
links?: Record<string, string>;
|
|
375
|
-
/**
|
|
376
|
-
* The date and time when the batch operation was requested, formatted as a date-time string.
|
|
377
|
-
*/
|
|
378
|
-
requestedAt?: string;
|
|
379
|
-
/**
|
|
380
|
-
* An array of results from the batch operation, each item representing a public campaign.
|
|
381
|
-
*/
|
|
382
|
-
results: Schemas.PublicCampaign[];
|
|
383
|
-
/**
|
|
384
|
-
* The date and time when the batch operation started, formatted as a date-time string.
|
|
385
|
-
*/
|
|
386
|
-
startedAt: string;
|
|
387
|
-
/**
|
|
388
|
-
* The current status of the batch operation, with possible values: CANCELED, COMPLETE, PENDING, PROCESSING.
|
|
389
|
-
*/
|
|
390
|
-
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
391
|
-
}
|
|
392
|
-
|
|
393
|
-
export interface BatchResponsePublicCampaignWithAssets {
|
|
394
|
-
/**
|
|
395
|
-
* The timestamp when the batch request processing was completed.
|
|
396
|
-
*/
|
|
397
|
-
completedAt: string;
|
|
398
|
-
/**
|
|
399
|
-
* A collection of URLs linking to related resources or documentation.
|
|
400
|
-
*/
|
|
401
|
-
links?: Record<string, string>;
|
|
402
|
-
/**
|
|
403
|
-
* The timestamp when the batch request was initially made.
|
|
404
|
-
*/
|
|
405
|
-
requestedAt?: string;
|
|
406
|
-
/**
|
|
407
|
-
* An array of results from the batch operation, each representing a public campaign with assets.
|
|
408
|
-
*/
|
|
409
|
-
results: Schemas.PublicCampaignWithAssets[];
|
|
410
|
-
/**
|
|
411
|
-
* The timestamp when the processing of the batch request began.
|
|
412
|
-
*/
|
|
413
|
-
startedAt: string;
|
|
414
|
-
/**
|
|
415
|
-
* The current processing status of the batch operation, with possible values: CANCELED, COMPLETE, PENDING, PROCESSING.
|
|
416
|
-
*/
|
|
417
|
-
status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
|
|
418
|
-
}
|
|
419
|
-
|
|
420
|
-
export interface CollectionResponseContactReferenceForwardPaging {
|
|
421
|
-
paging?: Schemas.ForwardPaging;
|
|
422
|
-
/**
|
|
423
|
-
* An array of contact references, each containing an identifier for a contact.
|
|
424
|
-
*/
|
|
425
|
-
results: Schemas.ContactReference[];
|
|
426
|
-
}
|
|
427
|
-
|
|
428
|
-
export interface CollectionResponsePublicCampaignAsset {
|
|
429
|
-
paging?: Schemas.Paging;
|
|
430
|
-
/**
|
|
431
|
-
* An array of public campaign assets. Each item in the array is an object representing a campaign asset.
|
|
432
|
-
*/
|
|
433
|
-
results: Schemas.PublicCampaignAsset[];
|
|
434
|
-
}
|
|
435
|
-
|
|
436
|
-
export interface CollectionResponsePublicCampaignAssetForwardPaging {
|
|
437
|
-
paging?: Schemas.ForwardPaging;
|
|
438
|
-
/**
|
|
439
|
-
* An array of public campaign assets. Each item in the array is a reference to a PublicCampaignAsset object.
|
|
440
|
-
*/
|
|
441
|
-
results: Schemas.PublicCampaignAsset[];
|
|
442
|
-
}
|
|
443
|
-
|
|
444
|
-
export interface CollectionResponseWithTotalPublicCampaign {
|
|
445
|
-
paging?: Schemas.Paging;
|
|
446
|
-
/**
|
|
447
|
-
* An array of PublicCampaign objects, each representing a campaign with its associated properties.
|
|
448
|
-
*/
|
|
449
|
-
results: Schemas.PublicCampaign[];
|
|
450
|
-
/**
|
|
451
|
-
* An integer representing the total number of public campaigns available.
|
|
452
|
-
*/
|
|
453
|
-
total: number;
|
|
454
|
-
}
|
|
455
|
-
|
|
456
|
-
export interface ContactReference {
|
|
457
|
-
/**
|
|
458
|
-
* Unique identifier for the contact.
|
|
459
|
-
*/
|
|
460
|
-
id: string;
|
|
461
|
-
}
|
|
462
|
-
|
|
463
|
-
export interface ForwardPaging {
|
|
464
|
-
next?: Schemas.NextPage;
|
|
465
|
-
}
|
|
466
|
-
|
|
467
|
-
export interface MetricsCounters {
|
|
468
|
-
/**
|
|
469
|
-
* The number of contacts influenced by the campaign.
|
|
470
|
-
*/
|
|
471
|
-
influencedContacts: number;
|
|
472
|
-
/**
|
|
473
|
-
* The number of new contacts attributed to the campaign as the first touchpoint.
|
|
474
|
-
*/
|
|
475
|
-
newContactsFirstTouch: number;
|
|
476
|
-
/**
|
|
477
|
-
* The number of new contacts attributed to the campaign as the last touchpoint.
|
|
478
|
-
*/
|
|
479
|
-
newContactsLastTouch: number;
|
|
480
|
-
/**
|
|
481
|
-
* The total number of sessions generated by the campaign.
|
|
482
|
-
*/
|
|
483
|
-
sessions: number;
|
|
484
|
-
}
|
|
485
|
-
|
|
486
|
-
/**
|
|
487
|
-
* Specifies the paging information needed to retrieve the next set of results in a paginated API response
|
|
488
|
-
*/
|
|
489
|
-
export interface NextPage {
|
|
490
|
-
/**
|
|
491
|
-
* A string token used as a cursor to retrieve the next page of results.
|
|
492
|
-
*/
|
|
493
|
-
after: string;
|
|
494
|
-
/**
|
|
495
|
-
* A string URL that provides the link to the next page of results.
|
|
496
|
-
*/
|
|
497
|
-
link?: string;
|
|
498
|
-
}
|
|
499
|
-
|
|
500
|
-
export interface Paging {
|
|
501
|
-
next?: Schemas.NextPage;
|
|
502
|
-
prev?: Schemas.PreviousPage;
|
|
503
|
-
}
|
|
504
|
-
|
|
505
|
-
/**
|
|
506
|
-
* specifies the paging information needed to retrieve the previous set of results in a paginated API response
|
|
507
|
-
*/
|
|
508
|
-
export interface PreviousPage {
|
|
509
|
-
/**
|
|
510
|
-
* A string token that indicates the position in the list before the current page of results.
|
|
511
|
-
*/
|
|
512
|
-
before: string;
|
|
513
|
-
/**
|
|
514
|
-
* A string containing the URL link to the previous page of results.
|
|
515
|
-
*/
|
|
516
|
-
link?: string;
|
|
517
|
-
}
|
|
518
|
-
|
|
519
|
-
export interface PublicBudgetItem {
|
|
520
|
-
/**
|
|
521
|
-
* The monetary amount allocated for the budget item.
|
|
522
|
-
*/
|
|
523
|
-
amount: number;
|
|
524
|
-
/**
|
|
525
|
-
* The timestamp when the budget item was created.
|
|
526
|
-
*/
|
|
527
|
-
createdAt: number;
|
|
528
|
-
/**
|
|
529
|
-
* A description of the budget item.
|
|
530
|
-
*/
|
|
531
|
-
description?: string;
|
|
532
|
-
/**
|
|
533
|
-
* The unique identifier for the budget item.
|
|
534
|
-
*/
|
|
535
|
-
id: string;
|
|
536
|
-
/**
|
|
537
|
-
* The name of the budget item.
|
|
538
|
-
*/
|
|
539
|
-
name: string;
|
|
540
|
-
/**
|
|
541
|
-
* The order of the budget item, indicating its sequence based on creation date.
|
|
542
|
-
*/
|
|
543
|
-
order: number;
|
|
544
|
-
/**
|
|
545
|
-
* The timestamp when the budget item was last updated.
|
|
546
|
-
*/
|
|
547
|
-
updatedAt: number;
|
|
548
|
-
}
|
|
549
|
-
|
|
550
|
-
export interface PublicBudgetItemInput {
|
|
551
|
-
/**
|
|
552
|
-
* The monetary value assigned to the budget item.
|
|
553
|
-
*/
|
|
554
|
-
amount: number;
|
|
555
|
-
/**
|
|
556
|
-
* A detailed explanation or notes about the budget item.
|
|
557
|
-
*/
|
|
558
|
-
description?: string;
|
|
559
|
-
/**
|
|
560
|
-
* The name of the budget item.
|
|
561
|
-
*/
|
|
562
|
-
name: string;
|
|
563
|
-
/**
|
|
564
|
-
* The sequence number indicating the order of the budget item.
|
|
565
|
-
*/
|
|
566
|
-
order: number;
|
|
567
|
-
}
|
|
568
|
-
|
|
569
|
-
export interface PublicBudgetTotals {
|
|
570
|
-
/**
|
|
571
|
-
* An array of budget items associated with the campaign. Each item is represented by a PublicBudgetItem object.
|
|
572
|
-
*/
|
|
573
|
-
budgetItems: Schemas.PublicBudgetItem[];
|
|
574
|
-
/**
|
|
575
|
-
* The total budget allocated for the campaign.
|
|
576
|
-
*/
|
|
577
|
-
budgetTotal?: number;
|
|
578
|
-
/**
|
|
579
|
-
* The currency code used for the budget and spend amounts, following ISO 4217 standards.
|
|
580
|
-
*/
|
|
581
|
-
currencyCode:
|
|
582
|
-
| 'AED'
|
|
583
|
-
| 'AFN'
|
|
584
|
-
| 'ALL'
|
|
585
|
-
| 'AMD'
|
|
586
|
-
| 'ANG'
|
|
587
|
-
| 'AOA'
|
|
588
|
-
| 'ARS'
|
|
589
|
-
| 'AUD'
|
|
590
|
-
| 'AWG'
|
|
591
|
-
| 'AZN'
|
|
592
|
-
| 'BAM'
|
|
593
|
-
| 'BBD'
|
|
594
|
-
| 'BDT'
|
|
595
|
-
| 'BGN'
|
|
596
|
-
| 'BHD'
|
|
597
|
-
| 'BIF'
|
|
598
|
-
| 'BMD'
|
|
599
|
-
| 'BND'
|
|
600
|
-
| 'BOB'
|
|
601
|
-
| 'BOV'
|
|
602
|
-
| 'BRL'
|
|
603
|
-
| 'BSD'
|
|
604
|
-
| 'BTN'
|
|
605
|
-
| 'BWP'
|
|
606
|
-
| 'BYN'
|
|
607
|
-
| 'BZD'
|
|
608
|
-
| 'CAD'
|
|
609
|
-
| 'CDF'
|
|
610
|
-
| 'CHE'
|
|
611
|
-
| 'CHF'
|
|
612
|
-
| 'CHW'
|
|
613
|
-
| 'CLF'
|
|
614
|
-
| 'CLP'
|
|
615
|
-
| 'CNY'
|
|
616
|
-
| 'COP'
|
|
617
|
-
| 'COU'
|
|
618
|
-
| 'CRC'
|
|
619
|
-
| 'CUC'
|
|
620
|
-
| 'CUP'
|
|
621
|
-
| 'CVE'
|
|
622
|
-
| 'CZK'
|
|
623
|
-
| 'DJF'
|
|
624
|
-
| 'DKK'
|
|
625
|
-
| 'DOP'
|
|
626
|
-
| 'DZD'
|
|
627
|
-
| 'EGP'
|
|
628
|
-
| 'ERN'
|
|
629
|
-
| 'ETB'
|
|
630
|
-
| 'EUR'
|
|
631
|
-
| 'FJD'
|
|
632
|
-
| 'FKP'
|
|
633
|
-
| 'GBP'
|
|
634
|
-
| 'GEL'
|
|
635
|
-
| 'GHS'
|
|
636
|
-
| 'GIP'
|
|
637
|
-
| 'GMD'
|
|
638
|
-
| 'GNF'
|
|
639
|
-
| 'GTQ'
|
|
640
|
-
| 'GYD'
|
|
641
|
-
| 'HKD'
|
|
642
|
-
| 'HNL'
|
|
643
|
-
| 'HRK'
|
|
644
|
-
| 'HTG'
|
|
645
|
-
| 'HUF'
|
|
646
|
-
| 'IDR'
|
|
647
|
-
| 'ILS'
|
|
648
|
-
| 'INR'
|
|
649
|
-
| 'IQD'
|
|
650
|
-
| 'IRR'
|
|
651
|
-
| 'ISK'
|
|
652
|
-
| 'JMD'
|
|
653
|
-
| 'JOD'
|
|
654
|
-
| 'JPY'
|
|
655
|
-
| 'KES'
|
|
656
|
-
| 'KGS'
|
|
657
|
-
| 'KHR'
|
|
658
|
-
| 'KMF'
|
|
659
|
-
| 'KPW'
|
|
660
|
-
| 'KRW'
|
|
661
|
-
| 'KWD'
|
|
662
|
-
| 'KYD'
|
|
663
|
-
| 'KZT'
|
|
664
|
-
| 'LAK'
|
|
665
|
-
| 'LBP'
|
|
666
|
-
| 'LKR'
|
|
667
|
-
| 'LRD'
|
|
668
|
-
| 'LSL'
|
|
669
|
-
| 'LYD'
|
|
670
|
-
| 'MAD'
|
|
671
|
-
| 'MDL'
|
|
672
|
-
| 'MGA'
|
|
673
|
-
| 'MKD'
|
|
674
|
-
| 'MMK'
|
|
675
|
-
| 'MNT'
|
|
676
|
-
| 'MOP'
|
|
677
|
-
| 'MRU'
|
|
678
|
-
| 'MUR'
|
|
679
|
-
| 'MVR'
|
|
680
|
-
| 'MWK'
|
|
681
|
-
| 'MXN'
|
|
682
|
-
| 'MXV'
|
|
683
|
-
| 'MYR'
|
|
684
|
-
| 'MZN'
|
|
685
|
-
| 'NAD'
|
|
686
|
-
| 'NGN'
|
|
687
|
-
| 'NIO'
|
|
688
|
-
| 'NOK'
|
|
689
|
-
| 'NPR'
|
|
690
|
-
| 'NZD'
|
|
691
|
-
| 'OMR'
|
|
692
|
-
| 'PAB'
|
|
693
|
-
| 'PEN'
|
|
694
|
-
| 'PGK'
|
|
695
|
-
| 'PHP'
|
|
696
|
-
| 'PKR'
|
|
697
|
-
| 'PLN'
|
|
698
|
-
| 'PYG'
|
|
699
|
-
| 'QAR'
|
|
700
|
-
| 'RON'
|
|
701
|
-
| 'RSD'
|
|
702
|
-
| 'RUB'
|
|
703
|
-
| 'RWF'
|
|
704
|
-
| 'SAR'
|
|
705
|
-
| 'SBD'
|
|
706
|
-
| 'SCR'
|
|
707
|
-
| 'SDG'
|
|
708
|
-
| 'SEK'
|
|
709
|
-
| 'SGD'
|
|
710
|
-
| 'SHP'
|
|
711
|
-
| 'SLL'
|
|
712
|
-
| 'SOS'
|
|
713
|
-
| 'SRD'
|
|
714
|
-
| 'SSP'
|
|
715
|
-
| 'STN'
|
|
716
|
-
| 'SVC'
|
|
717
|
-
| 'SYP'
|
|
718
|
-
| 'SZL'
|
|
719
|
-
| 'THB'
|
|
720
|
-
| 'TJS'
|
|
721
|
-
| 'TMT'
|
|
722
|
-
| 'TND'
|
|
723
|
-
| 'TOP'
|
|
724
|
-
| 'TRY'
|
|
725
|
-
| 'TTD'
|
|
726
|
-
| 'TWD'
|
|
727
|
-
| 'TZS'
|
|
728
|
-
| 'UAH'
|
|
729
|
-
| 'UGX'
|
|
730
|
-
| 'USD'
|
|
731
|
-
| 'USN'
|
|
732
|
-
| 'UYI'
|
|
733
|
-
| 'UYU'
|
|
734
|
-
| 'UZS'
|
|
735
|
-
| 'VEF'
|
|
736
|
-
| 'VND'
|
|
737
|
-
| 'VUV'
|
|
738
|
-
| 'WST'
|
|
739
|
-
| 'XAF'
|
|
740
|
-
| 'XAG'
|
|
741
|
-
| 'XAU'
|
|
742
|
-
| 'XBA'
|
|
743
|
-
| 'XBB'
|
|
744
|
-
| 'XBC'
|
|
745
|
-
| 'XBD'
|
|
746
|
-
| 'XCD'
|
|
747
|
-
| 'XDR'
|
|
748
|
-
| 'XOF'
|
|
749
|
-
| 'XPD'
|
|
750
|
-
| 'XPF'
|
|
751
|
-
| 'XPT'
|
|
752
|
-
| 'XSU'
|
|
753
|
-
| 'XUA'
|
|
754
|
-
| 'YER'
|
|
755
|
-
| 'ZAR'
|
|
756
|
-
| 'ZMW'
|
|
757
|
-
| 'ZWL';
|
|
758
|
-
/**
|
|
759
|
-
* The remaining budget available for the campaign after accounting for all spend items.
|
|
760
|
-
*/
|
|
761
|
-
remainingBudget?: number;
|
|
762
|
-
/**
|
|
763
|
-
* An array of spend items associated with the campaign. Each item is represented by a PublicSpendItem object.
|
|
764
|
-
*/
|
|
765
|
-
spendItems: Schemas.PublicSpendItem[];
|
|
766
|
-
/**
|
|
767
|
-
* The total amount spent across all spend items in the campaign.
|
|
768
|
-
*/
|
|
769
|
-
spendTotal?: number;
|
|
770
|
-
}
|
|
771
|
-
|
|
772
|
-
export interface PublicBusinessUnit {
|
|
773
|
-
/**
|
|
774
|
-
* The unique identifier for the business unit, represented as an integer.
|
|
775
|
-
*/
|
|
776
|
-
id: number;
|
|
777
|
-
}
|
|
778
|
-
|
|
779
|
-
export interface PublicCampaign {
|
|
780
|
-
/**
|
|
781
|
-
* An array of business units associated with the campaign, each represented by a PublicBusinessUnit object.
|
|
782
|
-
*/
|
|
783
|
-
businessUnits: Schemas.PublicBusinessUnit[];
|
|
784
|
-
/**
|
|
785
|
-
* The date and time when the campaign was created, formatted as a date-time string.
|
|
786
|
-
*/
|
|
787
|
-
createdAt: string;
|
|
788
|
-
/**
|
|
789
|
-
* The unique identifier for the campaign.
|
|
790
|
-
*/
|
|
791
|
-
id: string;
|
|
792
|
-
/**
|
|
793
|
-
* A collection of key-value pairs representing additional properties of the campaign.
|
|
794
|
-
*/
|
|
795
|
-
properties: Record<string, string>;
|
|
796
|
-
/**
|
|
797
|
-
* The date and time when the campaign was last updated, formatted as a date-time string.
|
|
798
|
-
*/
|
|
799
|
-
updatedAt: string;
|
|
800
|
-
}
|
|
801
|
-
|
|
802
|
-
export interface PublicCampaignAsset {
|
|
803
|
-
/**
|
|
804
|
-
* The unique identifier for the campaign asset.
|
|
805
|
-
*/
|
|
806
|
-
id: string;
|
|
807
|
-
/**
|
|
808
|
-
* A collection of metrics associated with the campaign asset, represented as key-value pairs.
|
|
809
|
-
*/
|
|
810
|
-
metrics?: Record<string, number>;
|
|
811
|
-
/**
|
|
812
|
-
* The name of the campaign asset.
|
|
813
|
-
*/
|
|
814
|
-
name?: string;
|
|
815
|
-
}
|
|
816
|
-
|
|
817
|
-
export interface PublicCampaignBatchUpdateItem {
|
|
818
|
-
/**
|
|
819
|
-
* The unique identifier for the campaign to be updated.
|
|
820
|
-
*/
|
|
821
|
-
id: string;
|
|
822
|
-
/**
|
|
823
|
-
* A set of key-value pairs representing the properties to be updated for the campaign.
|
|
824
|
-
*/
|
|
825
|
-
properties: Record<string, string>;
|
|
826
|
-
}
|
|
827
|
-
|
|
828
|
-
export interface PublicCampaignDeleteInput {
|
|
829
|
-
/**
|
|
830
|
-
* The unique identifier for the campaign to be deleted.
|
|
831
|
-
*/
|
|
832
|
-
id: string;
|
|
833
|
-
}
|
|
834
|
-
|
|
835
|
-
export interface PublicCampaignInput {
|
|
836
|
-
/**
|
|
837
|
-
* 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.
|
|
838
|
-
*/
|
|
839
|
-
properties: Record<string, string>;
|
|
840
|
-
}
|
|
841
|
-
|
|
842
|
-
export interface PublicCampaignReadInput {
|
|
843
|
-
/**
|
|
844
|
-
* The unique identifier for a campaign.
|
|
845
|
-
*/
|
|
846
|
-
id: string;
|
|
847
|
-
}
|
|
848
|
-
|
|
849
|
-
export interface PublicCampaignWithAssets {
|
|
850
|
-
/**
|
|
851
|
-
* Contains the assets associated with the campaign, each represented as a collection of campaign assets.
|
|
852
|
-
*/
|
|
853
|
-
assets: Record<string, Schemas.CollectionResponsePublicCampaignAsset>;
|
|
854
|
-
/**
|
|
855
|
-
* An array of business units associated with the campaign, each represented by a PublicBusinessUnit object.
|
|
856
|
-
*/
|
|
857
|
-
businessUnits: Schemas.PublicBusinessUnit[];
|
|
858
|
-
/**
|
|
859
|
-
* The date and time when the campaign was created, formatted as a date-time string.
|
|
860
|
-
*/
|
|
861
|
-
createdAt: string;
|
|
862
|
-
/**
|
|
863
|
-
* The unique identifier for the campaign.
|
|
864
|
-
*/
|
|
865
|
-
id: string;
|
|
866
|
-
/**
|
|
867
|
-
* A map of key-value pairs representing the properties of the campaign.
|
|
868
|
-
*/
|
|
869
|
-
properties: Record<string, string>;
|
|
870
|
-
/**
|
|
871
|
-
* The date and time when the campaign was last updated, formatted as a date-time string.
|
|
872
|
-
*/
|
|
873
|
-
updatedAt: string;
|
|
874
|
-
}
|
|
875
|
-
|
|
876
|
-
export interface PublicSpendItem {
|
|
877
|
-
/**
|
|
878
|
-
* The monetary value associated with the spend item.
|
|
879
|
-
*/
|
|
880
|
-
amount: number;
|
|
881
|
-
/**
|
|
882
|
-
* The timestamp indicating when the spend item was created.
|
|
883
|
-
*/
|
|
884
|
-
createdAt: number;
|
|
885
|
-
/**
|
|
886
|
-
* A detailed explanation or notes about the spend item.
|
|
887
|
-
*/
|
|
888
|
-
description?: string;
|
|
889
|
-
/**
|
|
890
|
-
* Unique identifier for the spend item.
|
|
891
|
-
*/
|
|
892
|
-
id: string;
|
|
893
|
-
/**
|
|
894
|
-
* The name assigned to the spend item.
|
|
895
|
-
*/
|
|
896
|
-
name: string;
|
|
897
|
-
/**
|
|
898
|
-
* The sequence order of the spend item, where 0 is the oldest.
|
|
899
|
-
*/
|
|
900
|
-
order: number;
|
|
901
|
-
/**
|
|
902
|
-
* The timestamp indicating when the spend item was last updated.
|
|
903
|
-
*/
|
|
904
|
-
updatedAt: number;
|
|
905
|
-
}
|
|
906
|
-
|
|
907
|
-
export interface PublicSpendItemInput {
|
|
908
|
-
/**
|
|
909
|
-
* The monetary value of the spend item.
|
|
910
|
-
*/
|
|
911
|
-
amount: number;
|
|
912
|
-
/**
|
|
913
|
-
* A brief description of the spend item.
|
|
914
|
-
*/
|
|
915
|
-
description?: string;
|
|
916
|
-
/**
|
|
917
|
-
* The name of the spend item.
|
|
918
|
-
*/
|
|
919
|
-
name: string;
|
|
920
|
-
/**
|
|
921
|
-
* The sequence number indicating the order of the spend item.
|
|
922
|
-
*/
|
|
923
|
-
order: number;
|
|
924
|
-
}
|
|
925
|
-
|
|
926
|
-
export interface RevenueAttributionAggregate {
|
|
927
|
-
/**
|
|
928
|
-
* The number of contacts attributed to the campaign.
|
|
929
|
-
*/
|
|
930
|
-
contactsNumber?: number;
|
|
931
|
-
/**
|
|
932
|
-
* The currency code used for the revenue attribution, with accepted values including AED, AFN, ALL, and others.
|
|
933
|
-
*/
|
|
934
|
-
currencyCode?:
|
|
935
|
-
| 'AED'
|
|
936
|
-
| 'AFN'
|
|
937
|
-
| 'ALL'
|
|
938
|
-
| 'AMD'
|
|
939
|
-
| 'ANG'
|
|
940
|
-
| 'AOA'
|
|
941
|
-
| 'ARS'
|
|
942
|
-
| 'AUD'
|
|
943
|
-
| 'AWG'
|
|
944
|
-
| 'AZN'
|
|
945
|
-
| 'BAM'
|
|
946
|
-
| 'BBD'
|
|
947
|
-
| 'BDT'
|
|
948
|
-
| 'BGN'
|
|
949
|
-
| 'BHD'
|
|
950
|
-
| 'BIF'
|
|
951
|
-
| 'BMD'
|
|
952
|
-
| 'BND'
|
|
953
|
-
| 'BOB'
|
|
954
|
-
| 'BOV'
|
|
955
|
-
| 'BRL'
|
|
956
|
-
| 'BSD'
|
|
957
|
-
| 'BTN'
|
|
958
|
-
| 'BWP'
|
|
959
|
-
| 'BYN'
|
|
960
|
-
| 'BZD'
|
|
961
|
-
| 'CAD'
|
|
962
|
-
| 'CDF'
|
|
963
|
-
| 'CHE'
|
|
964
|
-
| 'CHF'
|
|
965
|
-
| 'CHW'
|
|
966
|
-
| 'CLF'
|
|
967
|
-
| 'CLP'
|
|
968
|
-
| 'CNY'
|
|
969
|
-
| 'COP'
|
|
970
|
-
| 'COU'
|
|
971
|
-
| 'CRC'
|
|
972
|
-
| 'CUC'
|
|
973
|
-
| 'CUP'
|
|
974
|
-
| 'CVE'
|
|
975
|
-
| 'CZK'
|
|
976
|
-
| 'DJF'
|
|
977
|
-
| 'DKK'
|
|
978
|
-
| 'DOP'
|
|
979
|
-
| 'DZD'
|
|
980
|
-
| 'EGP'
|
|
981
|
-
| 'ERN'
|
|
982
|
-
| 'ETB'
|
|
983
|
-
| 'EUR'
|
|
984
|
-
| 'FJD'
|
|
985
|
-
| 'FKP'
|
|
986
|
-
| 'GBP'
|
|
987
|
-
| 'GEL'
|
|
988
|
-
| 'GHS'
|
|
989
|
-
| 'GIP'
|
|
990
|
-
| 'GMD'
|
|
991
|
-
| 'GNF'
|
|
992
|
-
| 'GTQ'
|
|
993
|
-
| 'GYD'
|
|
994
|
-
| 'HKD'
|
|
995
|
-
| 'HNL'
|
|
996
|
-
| 'HRK'
|
|
997
|
-
| 'HTG'
|
|
998
|
-
| 'HUF'
|
|
999
|
-
| 'IDR'
|
|
1000
|
-
| 'ILS'
|
|
1001
|
-
| 'INR'
|
|
1002
|
-
| 'IQD'
|
|
1003
|
-
| 'IRR'
|
|
1004
|
-
| 'ISK'
|
|
1005
|
-
| 'JMD'
|
|
1006
|
-
| 'JOD'
|
|
1007
|
-
| 'JPY'
|
|
1008
|
-
| 'KES'
|
|
1009
|
-
| 'KGS'
|
|
1010
|
-
| 'KHR'
|
|
1011
|
-
| 'KMF'
|
|
1012
|
-
| 'KPW'
|
|
1013
|
-
| 'KRW'
|
|
1014
|
-
| 'KWD'
|
|
1015
|
-
| 'KYD'
|
|
1016
|
-
| 'KZT'
|
|
1017
|
-
| 'LAK'
|
|
1018
|
-
| 'LBP'
|
|
1019
|
-
| 'LKR'
|
|
1020
|
-
| 'LRD'
|
|
1021
|
-
| 'LSL'
|
|
1022
|
-
| 'LYD'
|
|
1023
|
-
| 'MAD'
|
|
1024
|
-
| 'MDL'
|
|
1025
|
-
| 'MGA'
|
|
1026
|
-
| 'MKD'
|
|
1027
|
-
| 'MMK'
|
|
1028
|
-
| 'MNT'
|
|
1029
|
-
| 'MOP'
|
|
1030
|
-
| 'MRU'
|
|
1031
|
-
| 'MUR'
|
|
1032
|
-
| 'MVR'
|
|
1033
|
-
| 'MWK'
|
|
1034
|
-
| 'MXN'
|
|
1035
|
-
| 'MXV'
|
|
1036
|
-
| 'MYR'
|
|
1037
|
-
| 'MZN'
|
|
1038
|
-
| 'NAD'
|
|
1039
|
-
| 'NGN'
|
|
1040
|
-
| 'NIO'
|
|
1041
|
-
| 'NOK'
|
|
1042
|
-
| 'NPR'
|
|
1043
|
-
| 'NZD'
|
|
1044
|
-
| 'OMR'
|
|
1045
|
-
| 'PAB'
|
|
1046
|
-
| 'PEN'
|
|
1047
|
-
| 'PGK'
|
|
1048
|
-
| 'PHP'
|
|
1049
|
-
| 'PKR'
|
|
1050
|
-
| 'PLN'
|
|
1051
|
-
| 'PYG'
|
|
1052
|
-
| 'QAR'
|
|
1053
|
-
| 'RON'
|
|
1054
|
-
| 'RSD'
|
|
1055
|
-
| 'RUB'
|
|
1056
|
-
| 'RWF'
|
|
1057
|
-
| 'SAR'
|
|
1058
|
-
| 'SBD'
|
|
1059
|
-
| 'SCR'
|
|
1060
|
-
| 'SDG'
|
|
1061
|
-
| 'SEK'
|
|
1062
|
-
| 'SGD'
|
|
1063
|
-
| 'SHP'
|
|
1064
|
-
| 'SLL'
|
|
1065
|
-
| 'SOS'
|
|
1066
|
-
| 'SRD'
|
|
1067
|
-
| 'SSP'
|
|
1068
|
-
| 'STN'
|
|
1069
|
-
| 'SVC'
|
|
1070
|
-
| 'SYP'
|
|
1071
|
-
| 'SZL'
|
|
1072
|
-
| 'THB'
|
|
1073
|
-
| 'TJS'
|
|
1074
|
-
| 'TMT'
|
|
1075
|
-
| 'TND'
|
|
1076
|
-
| 'TOP'
|
|
1077
|
-
| 'TRY'
|
|
1078
|
-
| 'TTD'
|
|
1079
|
-
| 'TWD'
|
|
1080
|
-
| 'TZS'
|
|
1081
|
-
| 'UAH'
|
|
1082
|
-
| 'UGX'
|
|
1083
|
-
| 'USD'
|
|
1084
|
-
| 'USN'
|
|
1085
|
-
| 'UYI'
|
|
1086
|
-
| 'UYU'
|
|
1087
|
-
| 'UZS'
|
|
1088
|
-
| 'VEF'
|
|
1089
|
-
| 'VND'
|
|
1090
|
-
| 'VUV'
|
|
1091
|
-
| 'WST'
|
|
1092
|
-
| 'XAF'
|
|
1093
|
-
| 'XAG'
|
|
1094
|
-
| 'XAU'
|
|
1095
|
-
| 'XBA'
|
|
1096
|
-
| 'XBB'
|
|
1097
|
-
| 'XBC'
|
|
1098
|
-
| 'XBD'
|
|
1099
|
-
| 'XCD'
|
|
1100
|
-
| 'XDR'
|
|
1101
|
-
| 'XOF'
|
|
1102
|
-
| 'XPD'
|
|
1103
|
-
| 'XPF'
|
|
1104
|
-
| 'XPT'
|
|
1105
|
-
| 'XSU'
|
|
1106
|
-
| 'XUA'
|
|
1107
|
-
| 'YER'
|
|
1108
|
-
| 'ZAR'
|
|
1109
|
-
| 'ZMW'
|
|
1110
|
-
| 'ZWL';
|
|
1111
|
-
/**
|
|
1112
|
-
* The total amount of deals attributed to the campaign.
|
|
1113
|
-
*/
|
|
1114
|
-
dealAmount?: number;
|
|
1115
|
-
/**
|
|
1116
|
-
* The number of deals attributed to the campaign.
|
|
1117
|
-
*/
|
|
1118
|
-
dealsNumber?: number;
|
|
1119
|
-
/**
|
|
1120
|
-
* The total revenue amount attributed to the campaign.
|
|
1121
|
-
*/
|
|
1122
|
-
revenueAmount?: number;
|
|
1123
|
-
}
|
|
154
|
+
/**
|
|
155
|
+
* Specifies the paging information needed to retrieve the next set of results in a paginated API response
|
|
156
|
+
*/
|
|
157
|
+
export interface NextPage {
|
|
158
|
+
/**
|
|
159
|
+
* A string token used as a cursor to retrieve the next page of results.
|
|
160
|
+
*/
|
|
161
|
+
after: string;
|
|
162
|
+
/**
|
|
163
|
+
* A string URL that provides the link to the next page of results.
|
|
164
|
+
*/
|
|
165
|
+
link?: string;
|
|
1124
166
|
}
|
|
1125
167
|
|
|
1126
|
-
export
|
|
1127
|
-
|
|
1128
|
-
|
|
1129
|
-
* The UUID of the campaign, required
|
|
1130
|
-
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
1131
|
-
*/
|
|
1132
|
-
campaignGuid: string;
|
|
1133
|
-
data: Schemas.PublicSpendItemInput;
|
|
1134
|
-
}
|
|
1135
|
-
|
|
1136
|
-
export type CreateOutput = Schemas.PublicSpendItem;
|
|
1137
|
-
|
|
1138
|
-
export interface DeleteInput {
|
|
1139
|
-
/**
|
|
1140
|
-
* The UUID of the campaign, required
|
|
1141
|
-
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
1142
|
-
*/
|
|
1143
|
-
campaignGuid: string;
|
|
1144
|
-
/**
|
|
1145
|
-
* The ID of the spend item, required. Example: 491
|
|
1146
|
-
*/
|
|
1147
|
-
spendId: number;
|
|
1148
|
-
}
|
|
1149
|
-
|
|
1150
|
-
export type DeleteOutput = void;
|
|
1151
|
-
|
|
1152
|
-
export interface GetInput {
|
|
1153
|
-
/**
|
|
1154
|
-
* The UUID of the campaign, required
|
|
1155
|
-
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
1156
|
-
*/
|
|
1157
|
-
campaignGuid: string;
|
|
1158
|
-
/**
|
|
1159
|
-
* The ID of the spend item, required. Example: 491
|
|
1160
|
-
*/
|
|
1161
|
-
spendId: number;
|
|
1162
|
-
}
|
|
1163
|
-
|
|
1164
|
-
export type GetOutput = Schemas.PublicSpendItem;
|
|
1165
|
-
|
|
1166
|
-
export interface UpdateInput {
|
|
1167
|
-
/**
|
|
1168
|
-
* The UUID of the campaign, required
|
|
1169
|
-
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
1170
|
-
*/
|
|
1171
|
-
campaignGuid: string;
|
|
1172
|
-
data: Schemas.PublicSpendItemInput;
|
|
1173
|
-
/**
|
|
1174
|
-
* The ID of the spend item, required. Example: 491
|
|
1175
|
-
*/
|
|
1176
|
-
spendId: number;
|
|
1177
|
-
}
|
|
1178
|
-
|
|
1179
|
-
export type UpdateOutput = Schemas.PublicSpendItem;
|
|
168
|
+
export interface Paging {
|
|
169
|
+
next?: NextPage;
|
|
170
|
+
prev?: PreviousPage;
|
|
1180
171
|
}
|
|
1181
172
|
|
|
1182
173
|
/**
|
|
1183
|
-
*
|
|
1184
|
-
* ```ts
|
|
1185
|
-
* import { marketingCampaignsPublicApi } from '@hubspot/api-client-core';
|
|
1186
|
-
* client.send(marketingCampaignsPublicApi.assets.delete(input));
|
|
1187
|
-
* ```
|
|
174
|
+
* specifies the paging information needed to retrieve the previous set of results in a paginated API response
|
|
1188
175
|
*/
|
|
1189
|
-
export interface
|
|
176
|
+
export interface PreviousPage {
|
|
1190
177
|
/**
|
|
1191
|
-
*
|
|
1192
|
-
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}/assets/{assetType}/{assetId}
|
|
1193
|
-
* @apiMethod DELETE
|
|
1194
|
-
* @requiredScopes campaigns-write
|
|
178
|
+
* A string token that indicates the position in the list before the current page of results.
|
|
1195
179
|
*/
|
|
1196
|
-
|
|
180
|
+
before: string;
|
|
1197
181
|
/**
|
|
1198
|
-
*
|
|
1199
|
-
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}/assets/{assetType}
|
|
1200
|
-
* @apiMethod GET
|
|
1201
|
-
* @requiredScopes campaigns-access
|
|
182
|
+
* A string containing the URL link to the previous page of results.
|
|
1202
183
|
*/
|
|
1203
|
-
|
|
184
|
+
link?: string;
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
export interface PublicBudgetItem {
|
|
1204
188
|
/**
|
|
1205
|
-
*
|
|
1206
|
-
|
|
1207
|
-
|
|
1208
|
-
|
|
189
|
+
* The monetary amount allocated for the budget item.
|
|
190
|
+
*/
|
|
191
|
+
amount: number;
|
|
192
|
+
/**
|
|
193
|
+
* The timestamp when the budget item was created.
|
|
194
|
+
*/
|
|
195
|
+
createdAt: number;
|
|
196
|
+
/**
|
|
197
|
+
* A description of the budget item.
|
|
1209
198
|
*/
|
|
1210
|
-
|
|
199
|
+
description?: string;
|
|
200
|
+
/**
|
|
201
|
+
* The unique identifier for the budget item.
|
|
202
|
+
*/
|
|
203
|
+
id: string;
|
|
204
|
+
/**
|
|
205
|
+
* The name of the budget item.
|
|
206
|
+
*/
|
|
207
|
+
name: string;
|
|
208
|
+
/**
|
|
209
|
+
* The order of the budget item, indicating its sequence based on creation date.
|
|
210
|
+
*/
|
|
211
|
+
order: number;
|
|
212
|
+
/**
|
|
213
|
+
* The timestamp when the budget item was last updated.
|
|
214
|
+
*/
|
|
215
|
+
updatedAt: number;
|
|
1211
216
|
}
|
|
1212
217
|
|
|
218
|
+
export interface PublicBudgetItemInput {
|
|
219
|
+
/**
|
|
220
|
+
* The monetary value assigned to the budget item.
|
|
221
|
+
*/
|
|
222
|
+
amount: number;
|
|
223
|
+
/**
|
|
224
|
+
* A detailed explanation or notes about the budget item.
|
|
225
|
+
*/
|
|
226
|
+
description?: string;
|
|
227
|
+
/**
|
|
228
|
+
* The name of the budget item.
|
|
229
|
+
*/
|
|
230
|
+
name: string;
|
|
231
|
+
/**
|
|
232
|
+
* The sequence number indicating the order of the budget item.
|
|
233
|
+
*/
|
|
234
|
+
order: number;
|
|
235
|
+
}
|
|
236
|
+
|
|
237
|
+
export interface PublicBudgetTotals {
|
|
238
|
+
/**
|
|
239
|
+
* An array of budget items associated with the campaign. Each item is represented by a PublicBudgetItem object.
|
|
240
|
+
*/
|
|
241
|
+
budgetItems: PublicBudgetItem[];
|
|
242
|
+
/**
|
|
243
|
+
* The total budget allocated for the campaign.
|
|
244
|
+
*/
|
|
245
|
+
budgetTotal?: number;
|
|
246
|
+
/**
|
|
247
|
+
* The currency code used for the budget and spend amounts, following ISO 4217 standards.
|
|
248
|
+
*/
|
|
249
|
+
currencyCode:
|
|
250
|
+
| 'AED'
|
|
251
|
+
| 'AFN'
|
|
252
|
+
| 'ALL'
|
|
253
|
+
| 'AMD'
|
|
254
|
+
| 'ANG'
|
|
255
|
+
| 'AOA'
|
|
256
|
+
| 'ARS'
|
|
257
|
+
| 'AUD'
|
|
258
|
+
| 'AWG'
|
|
259
|
+
| 'AZN'
|
|
260
|
+
| 'BAM'
|
|
261
|
+
| 'BBD'
|
|
262
|
+
| 'BDT'
|
|
263
|
+
| 'BGN'
|
|
264
|
+
| 'BHD'
|
|
265
|
+
| 'BIF'
|
|
266
|
+
| 'BMD'
|
|
267
|
+
| 'BND'
|
|
268
|
+
| 'BOB'
|
|
269
|
+
| 'BOV'
|
|
270
|
+
| 'BRL'
|
|
271
|
+
| 'BSD'
|
|
272
|
+
| 'BTN'
|
|
273
|
+
| 'BWP'
|
|
274
|
+
| 'BYN'
|
|
275
|
+
| 'BZD'
|
|
276
|
+
| 'CAD'
|
|
277
|
+
| 'CDF'
|
|
278
|
+
| 'CHE'
|
|
279
|
+
| 'CHF'
|
|
280
|
+
| 'CHW'
|
|
281
|
+
| 'CLF'
|
|
282
|
+
| 'CLP'
|
|
283
|
+
| 'CNY'
|
|
284
|
+
| 'COP'
|
|
285
|
+
| 'COU'
|
|
286
|
+
| 'CRC'
|
|
287
|
+
| 'CUC'
|
|
288
|
+
| 'CUP'
|
|
289
|
+
| 'CVE'
|
|
290
|
+
| 'CZK'
|
|
291
|
+
| 'DJF'
|
|
292
|
+
| 'DKK'
|
|
293
|
+
| 'DOP'
|
|
294
|
+
| 'DZD'
|
|
295
|
+
| 'EGP'
|
|
296
|
+
| 'ERN'
|
|
297
|
+
| 'ETB'
|
|
298
|
+
| 'EUR'
|
|
299
|
+
| 'FJD'
|
|
300
|
+
| 'FKP'
|
|
301
|
+
| 'GBP'
|
|
302
|
+
| 'GEL'
|
|
303
|
+
| 'GHS'
|
|
304
|
+
| 'GIP'
|
|
305
|
+
| 'GMD'
|
|
306
|
+
| 'GNF'
|
|
307
|
+
| 'GTQ'
|
|
308
|
+
| 'GYD'
|
|
309
|
+
| 'HKD'
|
|
310
|
+
| 'HNL'
|
|
311
|
+
| 'HRK'
|
|
312
|
+
| 'HTG'
|
|
313
|
+
| 'HUF'
|
|
314
|
+
| 'IDR'
|
|
315
|
+
| 'ILS'
|
|
316
|
+
| 'INR'
|
|
317
|
+
| 'IQD'
|
|
318
|
+
| 'IRR'
|
|
319
|
+
| 'ISK'
|
|
320
|
+
| 'JMD'
|
|
321
|
+
| 'JOD'
|
|
322
|
+
| 'JPY'
|
|
323
|
+
| 'KES'
|
|
324
|
+
| 'KGS'
|
|
325
|
+
| 'KHR'
|
|
326
|
+
| 'KMF'
|
|
327
|
+
| 'KPW'
|
|
328
|
+
| 'KRW'
|
|
329
|
+
| 'KWD'
|
|
330
|
+
| 'KYD'
|
|
331
|
+
| 'KZT'
|
|
332
|
+
| 'LAK'
|
|
333
|
+
| 'LBP'
|
|
334
|
+
| 'LKR'
|
|
335
|
+
| 'LRD'
|
|
336
|
+
| 'LSL'
|
|
337
|
+
| 'LYD'
|
|
338
|
+
| 'MAD'
|
|
339
|
+
| 'MDL'
|
|
340
|
+
| 'MGA'
|
|
341
|
+
| 'MKD'
|
|
342
|
+
| 'MMK'
|
|
343
|
+
| 'MNT'
|
|
344
|
+
| 'MOP'
|
|
345
|
+
| 'MRU'
|
|
346
|
+
| 'MUR'
|
|
347
|
+
| 'MVR'
|
|
348
|
+
| 'MWK'
|
|
349
|
+
| 'MXN'
|
|
350
|
+
| 'MXV'
|
|
351
|
+
| 'MYR'
|
|
352
|
+
| 'MZN'
|
|
353
|
+
| 'NAD'
|
|
354
|
+
| 'NGN'
|
|
355
|
+
| 'NIO'
|
|
356
|
+
| 'NOK'
|
|
357
|
+
| 'NPR'
|
|
358
|
+
| 'NZD'
|
|
359
|
+
| 'OMR'
|
|
360
|
+
| 'PAB'
|
|
361
|
+
| 'PEN'
|
|
362
|
+
| 'PGK'
|
|
363
|
+
| 'PHP'
|
|
364
|
+
| 'PKR'
|
|
365
|
+
| 'PLN'
|
|
366
|
+
| 'PYG'
|
|
367
|
+
| 'QAR'
|
|
368
|
+
| 'RON'
|
|
369
|
+
| 'RSD'
|
|
370
|
+
| 'RUB'
|
|
371
|
+
| 'RWF'
|
|
372
|
+
| 'SAR'
|
|
373
|
+
| 'SBD'
|
|
374
|
+
| 'SCR'
|
|
375
|
+
| 'SDG'
|
|
376
|
+
| 'SEK'
|
|
377
|
+
| 'SGD'
|
|
378
|
+
| 'SHP'
|
|
379
|
+
| 'SLL'
|
|
380
|
+
| 'SOS'
|
|
381
|
+
| 'SRD'
|
|
382
|
+
| 'SSP'
|
|
383
|
+
| 'STN'
|
|
384
|
+
| 'SVC'
|
|
385
|
+
| 'SYP'
|
|
386
|
+
| 'SZL'
|
|
387
|
+
| 'THB'
|
|
388
|
+
| 'TJS'
|
|
389
|
+
| 'TMT'
|
|
390
|
+
| 'TND'
|
|
391
|
+
| 'TOP'
|
|
392
|
+
| 'TRY'
|
|
393
|
+
| 'TTD'
|
|
394
|
+
| 'TWD'
|
|
395
|
+
| 'TZS'
|
|
396
|
+
| 'UAH'
|
|
397
|
+
| 'UGX'
|
|
398
|
+
| 'USD'
|
|
399
|
+
| 'USN'
|
|
400
|
+
| 'UYI'
|
|
401
|
+
| 'UYU'
|
|
402
|
+
| 'UZS'
|
|
403
|
+
| 'VEF'
|
|
404
|
+
| 'VND'
|
|
405
|
+
| 'VUV'
|
|
406
|
+
| 'WST'
|
|
407
|
+
| 'XAF'
|
|
408
|
+
| 'XAG'
|
|
409
|
+
| 'XAU'
|
|
410
|
+
| 'XBA'
|
|
411
|
+
| 'XBB'
|
|
412
|
+
| 'XBC'
|
|
413
|
+
| 'XBD'
|
|
414
|
+
| 'XCD'
|
|
415
|
+
| 'XDR'
|
|
416
|
+
| 'XOF'
|
|
417
|
+
| 'XPD'
|
|
418
|
+
| 'XPF'
|
|
419
|
+
| 'XPT'
|
|
420
|
+
| 'XSU'
|
|
421
|
+
| 'XUA'
|
|
422
|
+
| 'YER'
|
|
423
|
+
| 'ZAR'
|
|
424
|
+
| 'ZMW'
|
|
425
|
+
| 'ZWL';
|
|
426
|
+
/**
|
|
427
|
+
* The remaining budget available for the campaign after accounting for all spend items.
|
|
428
|
+
*/
|
|
429
|
+
remainingBudget?: number;
|
|
430
|
+
/**
|
|
431
|
+
* An array of spend items associated with the campaign. Each item is represented by a PublicSpendItem object.
|
|
432
|
+
*/
|
|
433
|
+
spendItems: PublicSpendItem[];
|
|
434
|
+
/**
|
|
435
|
+
* The total amount spent across all spend items in the campaign.
|
|
436
|
+
*/
|
|
437
|
+
spendTotal?: number;
|
|
438
|
+
}
|
|
439
|
+
|
|
440
|
+
export interface PublicBusinessUnit {
|
|
441
|
+
/**
|
|
442
|
+
* The unique identifier for the business unit, represented as an integer.
|
|
443
|
+
*/
|
|
444
|
+
id: number;
|
|
445
|
+
}
|
|
446
|
+
|
|
447
|
+
export interface PublicCampaign {
|
|
448
|
+
/**
|
|
449
|
+
* An array of business units associated with the campaign, each represented by a PublicBusinessUnit object.
|
|
450
|
+
*/
|
|
451
|
+
businessUnits: PublicBusinessUnit[];
|
|
452
|
+
/**
|
|
453
|
+
* The date and time when the campaign was created, formatted as a date-time string.
|
|
454
|
+
*/
|
|
455
|
+
createdAt: string;
|
|
456
|
+
/**
|
|
457
|
+
* The unique identifier for the campaign.
|
|
458
|
+
*/
|
|
459
|
+
id: string;
|
|
460
|
+
/**
|
|
461
|
+
* A collection of key-value pairs representing additional properties of the campaign.
|
|
462
|
+
*/
|
|
463
|
+
properties: Record<string, string>;
|
|
464
|
+
/**
|
|
465
|
+
* The date and time when the campaign was last updated, formatted as a date-time string.
|
|
466
|
+
*/
|
|
467
|
+
updatedAt: string;
|
|
468
|
+
}
|
|
469
|
+
|
|
470
|
+
export interface PublicCampaignAsset {
|
|
471
|
+
/**
|
|
472
|
+
* The unique identifier for the campaign asset.
|
|
473
|
+
*/
|
|
474
|
+
id: string;
|
|
475
|
+
/**
|
|
476
|
+
* A collection of metrics associated with the campaign asset, represented as key-value pairs.
|
|
477
|
+
*/
|
|
478
|
+
metrics?: Record<string, number>;
|
|
479
|
+
/**
|
|
480
|
+
* The name of the campaign asset.
|
|
481
|
+
*/
|
|
482
|
+
name?: string;
|
|
483
|
+
}
|
|
484
|
+
|
|
485
|
+
export interface PublicCampaignBatchUpdateItem {
|
|
486
|
+
/**
|
|
487
|
+
* The unique identifier for the campaign to be updated.
|
|
488
|
+
*/
|
|
489
|
+
id: string;
|
|
490
|
+
/**
|
|
491
|
+
* A set of key-value pairs representing the properties to be updated for the campaign.
|
|
492
|
+
*/
|
|
493
|
+
properties: Record<string, string>;
|
|
494
|
+
}
|
|
495
|
+
|
|
496
|
+
export interface PublicCampaignDeleteInput {
|
|
497
|
+
/**
|
|
498
|
+
* The unique identifier for the campaign to be deleted.
|
|
499
|
+
*/
|
|
500
|
+
id: string;
|
|
501
|
+
}
|
|
502
|
+
|
|
503
|
+
export interface PublicCampaignInput {
|
|
504
|
+
/**
|
|
505
|
+
* 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.
|
|
506
|
+
*/
|
|
507
|
+
properties: Record<string, string>;
|
|
508
|
+
}
|
|
509
|
+
|
|
510
|
+
export interface PublicCampaignReadInput {
|
|
511
|
+
/**
|
|
512
|
+
* The unique identifier for a campaign.
|
|
513
|
+
*/
|
|
514
|
+
id: string;
|
|
515
|
+
}
|
|
516
|
+
|
|
517
|
+
export interface PublicCampaignWithAssets {
|
|
518
|
+
/**
|
|
519
|
+
* Contains the assets associated with the campaign, each represented as a collection of campaign assets.
|
|
520
|
+
*/
|
|
521
|
+
assets: Record<string, CollectionResponsePublicCampaignAsset>;
|
|
522
|
+
/**
|
|
523
|
+
* An array of business units associated with the campaign, each represented by a PublicBusinessUnit object.
|
|
524
|
+
*/
|
|
525
|
+
businessUnits: PublicBusinessUnit[];
|
|
526
|
+
/**
|
|
527
|
+
* The date and time when the campaign was created, formatted as a date-time string.
|
|
528
|
+
*/
|
|
529
|
+
createdAt: string;
|
|
530
|
+
/**
|
|
531
|
+
* The unique identifier for the campaign.
|
|
532
|
+
*/
|
|
533
|
+
id: string;
|
|
534
|
+
/**
|
|
535
|
+
* A map of key-value pairs representing the properties of the campaign.
|
|
536
|
+
*/
|
|
537
|
+
properties: Record<string, string>;
|
|
538
|
+
/**
|
|
539
|
+
* The date and time when the campaign was last updated, formatted as a date-time string.
|
|
540
|
+
*/
|
|
541
|
+
updatedAt: string;
|
|
542
|
+
}
|
|
543
|
+
|
|
544
|
+
export interface PublicSpendItem {
|
|
545
|
+
/**
|
|
546
|
+
* The monetary value associated with the spend item.
|
|
547
|
+
*/
|
|
548
|
+
amount: number;
|
|
549
|
+
/**
|
|
550
|
+
* The timestamp indicating when the spend item was created.
|
|
551
|
+
*/
|
|
552
|
+
createdAt: number;
|
|
553
|
+
/**
|
|
554
|
+
* A detailed explanation or notes about the spend item.
|
|
555
|
+
*/
|
|
556
|
+
description?: string;
|
|
557
|
+
/**
|
|
558
|
+
* Unique identifier for the spend item.
|
|
559
|
+
*/
|
|
560
|
+
id: string;
|
|
561
|
+
/**
|
|
562
|
+
* The name assigned to the spend item.
|
|
563
|
+
*/
|
|
564
|
+
name: string;
|
|
565
|
+
/**
|
|
566
|
+
* The sequence order of the spend item, where 0 is the oldest.
|
|
567
|
+
*/
|
|
568
|
+
order: number;
|
|
569
|
+
/**
|
|
570
|
+
* The timestamp indicating when the spend item was last updated.
|
|
571
|
+
*/
|
|
572
|
+
updatedAt: number;
|
|
573
|
+
}
|
|
574
|
+
|
|
575
|
+
export interface PublicSpendItemInput {
|
|
576
|
+
/**
|
|
577
|
+
* The monetary value of the spend item.
|
|
578
|
+
*/
|
|
579
|
+
amount: number;
|
|
580
|
+
/**
|
|
581
|
+
* A brief description of the spend item.
|
|
582
|
+
*/
|
|
583
|
+
description?: string;
|
|
584
|
+
/**
|
|
585
|
+
* The name of the spend item.
|
|
586
|
+
*/
|
|
587
|
+
name: string;
|
|
588
|
+
/**
|
|
589
|
+
* The sequence number indicating the order of the spend item.
|
|
590
|
+
*/
|
|
591
|
+
order: number;
|
|
592
|
+
}
|
|
593
|
+
|
|
594
|
+
export interface RevenueAttributionAggregate {
|
|
595
|
+
/**
|
|
596
|
+
* The number of contacts attributed to the campaign.
|
|
597
|
+
*/
|
|
598
|
+
contactsNumber?: number;
|
|
599
|
+
/**
|
|
600
|
+
* The currency code used for the revenue attribution, with accepted values including AED, AFN, ALL, and others.
|
|
601
|
+
*/
|
|
602
|
+
currencyCode?:
|
|
603
|
+
| 'AED'
|
|
604
|
+
| 'AFN'
|
|
605
|
+
| 'ALL'
|
|
606
|
+
| 'AMD'
|
|
607
|
+
| 'ANG'
|
|
608
|
+
| 'AOA'
|
|
609
|
+
| 'ARS'
|
|
610
|
+
| 'AUD'
|
|
611
|
+
| 'AWG'
|
|
612
|
+
| 'AZN'
|
|
613
|
+
| 'BAM'
|
|
614
|
+
| 'BBD'
|
|
615
|
+
| 'BDT'
|
|
616
|
+
| 'BGN'
|
|
617
|
+
| 'BHD'
|
|
618
|
+
| 'BIF'
|
|
619
|
+
| 'BMD'
|
|
620
|
+
| 'BND'
|
|
621
|
+
| 'BOB'
|
|
622
|
+
| 'BOV'
|
|
623
|
+
| 'BRL'
|
|
624
|
+
| 'BSD'
|
|
625
|
+
| 'BTN'
|
|
626
|
+
| 'BWP'
|
|
627
|
+
| 'BYN'
|
|
628
|
+
| 'BZD'
|
|
629
|
+
| 'CAD'
|
|
630
|
+
| 'CDF'
|
|
631
|
+
| 'CHE'
|
|
632
|
+
| 'CHF'
|
|
633
|
+
| 'CHW'
|
|
634
|
+
| 'CLF'
|
|
635
|
+
| 'CLP'
|
|
636
|
+
| 'CNY'
|
|
637
|
+
| 'COP'
|
|
638
|
+
| 'COU'
|
|
639
|
+
| 'CRC'
|
|
640
|
+
| 'CUC'
|
|
641
|
+
| 'CUP'
|
|
642
|
+
| 'CVE'
|
|
643
|
+
| 'CZK'
|
|
644
|
+
| 'DJF'
|
|
645
|
+
| 'DKK'
|
|
646
|
+
| 'DOP'
|
|
647
|
+
| 'DZD'
|
|
648
|
+
| 'EGP'
|
|
649
|
+
| 'ERN'
|
|
650
|
+
| 'ETB'
|
|
651
|
+
| 'EUR'
|
|
652
|
+
| 'FJD'
|
|
653
|
+
| 'FKP'
|
|
654
|
+
| 'GBP'
|
|
655
|
+
| 'GEL'
|
|
656
|
+
| 'GHS'
|
|
657
|
+
| 'GIP'
|
|
658
|
+
| 'GMD'
|
|
659
|
+
| 'GNF'
|
|
660
|
+
| 'GTQ'
|
|
661
|
+
| 'GYD'
|
|
662
|
+
| 'HKD'
|
|
663
|
+
| 'HNL'
|
|
664
|
+
| 'HRK'
|
|
665
|
+
| 'HTG'
|
|
666
|
+
| 'HUF'
|
|
667
|
+
| 'IDR'
|
|
668
|
+
| 'ILS'
|
|
669
|
+
| 'INR'
|
|
670
|
+
| 'IQD'
|
|
671
|
+
| 'IRR'
|
|
672
|
+
| 'ISK'
|
|
673
|
+
| 'JMD'
|
|
674
|
+
| 'JOD'
|
|
675
|
+
| 'JPY'
|
|
676
|
+
| 'KES'
|
|
677
|
+
| 'KGS'
|
|
678
|
+
| 'KHR'
|
|
679
|
+
| 'KMF'
|
|
680
|
+
| 'KPW'
|
|
681
|
+
| 'KRW'
|
|
682
|
+
| 'KWD'
|
|
683
|
+
| 'KYD'
|
|
684
|
+
| 'KZT'
|
|
685
|
+
| 'LAK'
|
|
686
|
+
| 'LBP'
|
|
687
|
+
| 'LKR'
|
|
688
|
+
| 'LRD'
|
|
689
|
+
| 'LSL'
|
|
690
|
+
| 'LYD'
|
|
691
|
+
| 'MAD'
|
|
692
|
+
| 'MDL'
|
|
693
|
+
| 'MGA'
|
|
694
|
+
| 'MKD'
|
|
695
|
+
| 'MMK'
|
|
696
|
+
| 'MNT'
|
|
697
|
+
| 'MOP'
|
|
698
|
+
| 'MRU'
|
|
699
|
+
| 'MUR'
|
|
700
|
+
| 'MVR'
|
|
701
|
+
| 'MWK'
|
|
702
|
+
| 'MXN'
|
|
703
|
+
| 'MXV'
|
|
704
|
+
| 'MYR'
|
|
705
|
+
| 'MZN'
|
|
706
|
+
| 'NAD'
|
|
707
|
+
| 'NGN'
|
|
708
|
+
| 'NIO'
|
|
709
|
+
| 'NOK'
|
|
710
|
+
| 'NPR'
|
|
711
|
+
| 'NZD'
|
|
712
|
+
| 'OMR'
|
|
713
|
+
| 'PAB'
|
|
714
|
+
| 'PEN'
|
|
715
|
+
| 'PGK'
|
|
716
|
+
| 'PHP'
|
|
717
|
+
| 'PKR'
|
|
718
|
+
| 'PLN'
|
|
719
|
+
| 'PYG'
|
|
720
|
+
| 'QAR'
|
|
721
|
+
| 'RON'
|
|
722
|
+
| 'RSD'
|
|
723
|
+
| 'RUB'
|
|
724
|
+
| 'RWF'
|
|
725
|
+
| 'SAR'
|
|
726
|
+
| 'SBD'
|
|
727
|
+
| 'SCR'
|
|
728
|
+
| 'SDG'
|
|
729
|
+
| 'SEK'
|
|
730
|
+
| 'SGD'
|
|
731
|
+
| 'SHP'
|
|
732
|
+
| 'SLL'
|
|
733
|
+
| 'SOS'
|
|
734
|
+
| 'SRD'
|
|
735
|
+
| 'SSP'
|
|
736
|
+
| 'STN'
|
|
737
|
+
| 'SVC'
|
|
738
|
+
| 'SYP'
|
|
739
|
+
| 'SZL'
|
|
740
|
+
| 'THB'
|
|
741
|
+
| 'TJS'
|
|
742
|
+
| 'TMT'
|
|
743
|
+
| 'TND'
|
|
744
|
+
| 'TOP'
|
|
745
|
+
| 'TRY'
|
|
746
|
+
| 'TTD'
|
|
747
|
+
| 'TWD'
|
|
748
|
+
| 'TZS'
|
|
749
|
+
| 'UAH'
|
|
750
|
+
| 'UGX'
|
|
751
|
+
| 'USD'
|
|
752
|
+
| 'USN'
|
|
753
|
+
| 'UYI'
|
|
754
|
+
| 'UYU'
|
|
755
|
+
| 'UZS'
|
|
756
|
+
| 'VEF'
|
|
757
|
+
| 'VND'
|
|
758
|
+
| 'VUV'
|
|
759
|
+
| 'WST'
|
|
760
|
+
| 'XAF'
|
|
761
|
+
| 'XAG'
|
|
762
|
+
| 'XAU'
|
|
763
|
+
| 'XBA'
|
|
764
|
+
| 'XBB'
|
|
765
|
+
| 'XBC'
|
|
766
|
+
| 'XBD'
|
|
767
|
+
| 'XCD'
|
|
768
|
+
| 'XDR'
|
|
769
|
+
| 'XOF'
|
|
770
|
+
| 'XPD'
|
|
771
|
+
| 'XPF'
|
|
772
|
+
| 'XPT'
|
|
773
|
+
| 'XSU'
|
|
774
|
+
| 'XUA'
|
|
775
|
+
| 'YER'
|
|
776
|
+
| 'ZAR'
|
|
777
|
+
| 'ZMW'
|
|
778
|
+
| 'ZWL';
|
|
779
|
+
/**
|
|
780
|
+
* The total amount of deals attributed to the campaign.
|
|
781
|
+
*/
|
|
782
|
+
dealAmount?: number;
|
|
783
|
+
/**
|
|
784
|
+
* The number of deals attributed to the campaign.
|
|
785
|
+
*/
|
|
786
|
+
dealsNumber?: number;
|
|
787
|
+
/**
|
|
788
|
+
* The total revenue amount attributed to the campaign.
|
|
789
|
+
*/
|
|
790
|
+
revenueAmount?: number;
|
|
791
|
+
}
|
|
792
|
+
}
|
|
793
|
+
|
|
794
|
+
export namespace MarketingCampaigns {
|
|
795
|
+
export type CreateInput =
|
|
796
|
+
MarketingCampaignsPublicApiSchemas.PublicCampaignInput;
|
|
797
|
+
|
|
798
|
+
export type CreateOutput = MarketingCampaignsPublicApiSchemas.PublicCampaign;
|
|
799
|
+
|
|
800
|
+
export interface DeleteInput {
|
|
801
|
+
/**
|
|
802
|
+
* The UUID of the campaign, required
|
|
803
|
+
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
804
|
+
*/
|
|
805
|
+
campaignGuid: string;
|
|
806
|
+
}
|
|
807
|
+
|
|
808
|
+
export type DeleteOutput = void;
|
|
809
|
+
|
|
810
|
+
export interface GetInput {
|
|
811
|
+
/**
|
|
812
|
+
* The UUID of the campaign, required
|
|
813
|
+
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
814
|
+
*/
|
|
815
|
+
campaignGuid: string;
|
|
816
|
+
/**
|
|
817
|
+
* The end date for fetching asset metrics, in YYYY-MM-DD format.
|
|
818
|
+
* Optional. Example: 2000-01-27
|
|
819
|
+
*/
|
|
820
|
+
endDate?: string;
|
|
821
|
+
/**
|
|
822
|
+
* A comma-separated list of properties to include in the response.
|
|
823
|
+
* Unrecognized properties are ignored. Optional. Example: hs_name,hs_budget, hs_notes
|
|
824
|
+
*/
|
|
825
|
+
properties?: string[];
|
|
826
|
+
/**
|
|
827
|
+
* The start date for fetching asset metrics, in YYYY-MM-DD format.
|
|
828
|
+
* Optional. Example: 2000-01-20
|
|
829
|
+
*/
|
|
830
|
+
startDate?: string;
|
|
831
|
+
}
|
|
832
|
+
|
|
833
|
+
export type GetOutput =
|
|
834
|
+
MarketingCampaignsPublicApiSchemas.PublicCampaignWithAssets;
|
|
835
|
+
|
|
836
|
+
export interface ListInput {
|
|
837
|
+
/**
|
|
838
|
+
* 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.
|
|
839
|
+
*/
|
|
840
|
+
after?: string;
|
|
841
|
+
/**
|
|
842
|
+
* The maximum number of results to display per page.
|
|
843
|
+
*/
|
|
844
|
+
limit?: number;
|
|
845
|
+
/**
|
|
846
|
+
* Filter campaigns by name. Optional.
|
|
847
|
+
*/
|
|
848
|
+
name?: string;
|
|
849
|
+
/**
|
|
850
|
+
* A comma-separated list of properties to include in the response.
|
|
851
|
+
* Unrecognized properties are ignored. Optional. Example:
|
|
852
|
+
* hs_name, hs_budget,hs_notes
|
|
853
|
+
*/
|
|
854
|
+
properties?: string[];
|
|
855
|
+
/**
|
|
856
|
+
* The property to sort results by. Optional.
|
|
857
|
+
*/
|
|
858
|
+
sort?: string;
|
|
859
|
+
}
|
|
860
|
+
|
|
861
|
+
export type ListOutput =
|
|
862
|
+
MarketingCampaignsPublicApiSchemas.CollectionResponseWithTotalPublicCampaign;
|
|
863
|
+
|
|
864
|
+
export interface UpdateInput {
|
|
865
|
+
/**
|
|
866
|
+
* The UUID of the campaign, required
|
|
867
|
+
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
868
|
+
*/
|
|
869
|
+
campaignGuid: string;
|
|
870
|
+
data: MarketingCampaignsPublicApiSchemas.PublicCampaignInput;
|
|
871
|
+
}
|
|
872
|
+
|
|
873
|
+
export type UpdateOutput = MarketingCampaignsPublicApiSchemas.PublicCampaign;
|
|
1213
874
|
/**
|
|
1214
875
|
* Usage example:
|
|
1215
876
|
* ```ts
|
|
1216
|
-
* import {
|
|
1217
|
-
* client.send(
|
|
877
|
+
* import { marketingCampaigns } from '@hubspot/api-client-core';
|
|
878
|
+
* client.send(marketingCampaigns.create(input));
|
|
1218
879
|
* ```
|
|
1219
880
|
*/
|
|
1220
|
-
export interface
|
|
881
|
+
export interface API {
|
|
1221
882
|
/**
|
|
1222
883
|
* Create a campaign
|
|
1223
884
|
* @apiPath /marketing/campaigns/2026-03
|
|
1224
885
|
* @apiMethod POST
|
|
1225
886
|
* @requiredScopes campaigns-write
|
|
1226
887
|
*/
|
|
1227
|
-
create: (input:
|
|
888
|
+
create: (input: CreateInput) => Operation<CreateOutput>;
|
|
1228
889
|
/**
|
|
1229
890
|
* Delete campaign
|
|
1230
891
|
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}
|
|
1231
892
|
* @apiMethod DELETE
|
|
1232
893
|
* @requiredScopes campaigns-write
|
|
1233
894
|
*/
|
|
1234
|
-
delete: (input:
|
|
895
|
+
delete: (input: DeleteInput) => Operation<DeleteOutput>;
|
|
1235
896
|
/**
|
|
1236
897
|
* Read a campaign
|
|
1237
898
|
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}
|
|
1238
899
|
* @apiMethod GET
|
|
1239
900
|
* @requiredScopes campaigns-access
|
|
1240
901
|
*/
|
|
1241
|
-
get: (input:
|
|
902
|
+
get: (input: GetInput) => Operation<GetOutput>;
|
|
1242
903
|
/**
|
|
1243
904
|
* Retrieve campaigns
|
|
1244
905
|
* @apiPath /marketing/campaigns/2026-03
|
|
1245
906
|
* @apiMethod GET
|
|
1246
907
|
* @requiredScopes campaigns-access
|
|
1247
908
|
*/
|
|
1248
|
-
list: (input?:
|
|
909
|
+
list: (input?: ListInput) => Operation<ListOutput>;
|
|
1249
910
|
/**
|
|
1250
911
|
* Update campaign
|
|
1251
912
|
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}
|
|
1252
913
|
* @apiMethod PATCH
|
|
1253
914
|
* @requiredScopes campaigns-write
|
|
1254
915
|
*/
|
|
1255
|
-
update: (input:
|
|
916
|
+
update: (input: UpdateInput) => Operation<UpdateOutput>;
|
|
917
|
+
}
|
|
918
|
+
}
|
|
919
|
+
|
|
920
|
+
export namespace MarketingCampaignsAssets {
|
|
921
|
+
export interface DeleteInput {
|
|
922
|
+
/**
|
|
923
|
+
* The id of asset to disassociate, required
|
|
924
|
+
* Example: 154543
|
|
925
|
+
*/
|
|
926
|
+
assetId: string;
|
|
927
|
+
/**
|
|
928
|
+
* The type of asset to disassociate, required
|
|
929
|
+
* Example: OBJECT_LIST
|
|
930
|
+
*/
|
|
931
|
+
assetType: string;
|
|
932
|
+
/**
|
|
933
|
+
* The UUID of the campaign, required
|
|
934
|
+
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
935
|
+
*/
|
|
936
|
+
campaignGuid: string;
|
|
937
|
+
}
|
|
938
|
+
|
|
939
|
+
export type DeleteOutput = void;
|
|
940
|
+
|
|
941
|
+
export interface ListInput {
|
|
942
|
+
/**
|
|
943
|
+
* 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.
|
|
944
|
+
*/
|
|
945
|
+
after?: string;
|
|
946
|
+
/**
|
|
947
|
+
* The type of asset to fetch, required
|
|
948
|
+
* Example: MARKETING_EVENT
|
|
949
|
+
*/
|
|
950
|
+
assetType: string;
|
|
951
|
+
/**
|
|
952
|
+
* The UUID of the campaign, required
|
|
953
|
+
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
954
|
+
*/
|
|
955
|
+
campaignGuid: string;
|
|
956
|
+
/**
|
|
957
|
+
* 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.
|
|
958
|
+
* Example: 2024-01-27
|
|
959
|
+
*/
|
|
960
|
+
endDate?: string;
|
|
961
|
+
/**
|
|
962
|
+
* The maximum number of results to display per page.
|
|
963
|
+
*/
|
|
964
|
+
limit?: string;
|
|
965
|
+
/**
|
|
966
|
+
* 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.
|
|
967
|
+
* Example: 2023-01-20
|
|
968
|
+
*/
|
|
969
|
+
startDate?: string;
|
|
970
|
+
}
|
|
971
|
+
|
|
972
|
+
export type ListOutput =
|
|
973
|
+
MarketingCampaignsPublicApiSchemas.CollectionResponsePublicCampaignAssetForwardPaging;
|
|
974
|
+
|
|
975
|
+
export interface UpdateInput {
|
|
976
|
+
/**
|
|
977
|
+
* The id of asset to disassociate, required
|
|
978
|
+
* Example: 154543
|
|
979
|
+
*/
|
|
980
|
+
assetId: string;
|
|
981
|
+
/**
|
|
982
|
+
* The type of asset to disassociate, required
|
|
983
|
+
* Example: OBJECT_LIST
|
|
984
|
+
*/
|
|
985
|
+
assetType: string;
|
|
986
|
+
/**
|
|
987
|
+
* The UUID of the campaign, required
|
|
988
|
+
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
989
|
+
*/
|
|
990
|
+
campaignGuid: string;
|
|
991
|
+
}
|
|
992
|
+
|
|
993
|
+
export type UpdateOutput = void;
|
|
994
|
+
/**
|
|
995
|
+
* Usage example:
|
|
996
|
+
* ```ts
|
|
997
|
+
* import { marketingCampaignsAssets } from '@hubspot/api-client-core';
|
|
998
|
+
* client.send(marketingCampaignsAssets.delete(input));
|
|
999
|
+
* ```
|
|
1000
|
+
*/
|
|
1001
|
+
export interface API {
|
|
1002
|
+
/**
|
|
1003
|
+
* Remove asset association
|
|
1004
|
+
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}/assets/{assetType}/{assetId}
|
|
1005
|
+
* @apiMethod DELETE
|
|
1006
|
+
* @requiredScopes campaigns-write
|
|
1007
|
+
*/
|
|
1008
|
+
delete: (input: DeleteInput) => Operation<DeleteOutput>;
|
|
1009
|
+
/**
|
|
1010
|
+
* List assets
|
|
1011
|
+
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}/assets/{assetType}
|
|
1012
|
+
* @apiMethod GET
|
|
1013
|
+
* @requiredScopes campaigns-access
|
|
1014
|
+
*/
|
|
1015
|
+
list: (input: ListInput) => Operation<ListOutput>;
|
|
1016
|
+
/**
|
|
1017
|
+
* Add asset association
|
|
1018
|
+
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}/assets/{assetType}/{assetId}
|
|
1019
|
+
* @apiMethod PUT
|
|
1020
|
+
* @requiredScopes campaigns-write
|
|
1021
|
+
*/
|
|
1022
|
+
update: (input: UpdateInput) => Operation<UpdateOutput>;
|
|
1023
|
+
}
|
|
1024
|
+
}
|
|
1025
|
+
|
|
1026
|
+
export namespace MarketingCampaignsBatch {
|
|
1027
|
+
export type CreateInput =
|
|
1028
|
+
MarketingCampaignsPublicApiSchemas.BatchInputPublicCampaignInput;
|
|
1029
|
+
|
|
1030
|
+
export type CreateOutput =
|
|
1031
|
+
MarketingCampaignsPublicApiSchemas.BatchResponsePublicCampaign;
|
|
1032
|
+
|
|
1033
|
+
export type DeleteInput =
|
|
1034
|
+
MarketingCampaignsPublicApiSchemas.BatchInputPublicCampaignDeleteInput;
|
|
1035
|
+
|
|
1036
|
+
export type DeleteOutput = void;
|
|
1037
|
+
|
|
1038
|
+
export interface GetInput {
|
|
1039
|
+
data: MarketingCampaignsPublicApiSchemas.BatchInputPublicCampaignReadInput;
|
|
1040
|
+
/**
|
|
1041
|
+
* 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.
|
|
1042
|
+
* Example: 2024-01-27
|
|
1043
|
+
*/
|
|
1044
|
+
endDate?: string;
|
|
1045
|
+
/**
|
|
1046
|
+
* 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.
|
|
1047
|
+
* Example: hs_name, hs_campaign_status, hs_notes
|
|
1048
|
+
*/
|
|
1049
|
+
properties?: string[];
|
|
1050
|
+
/**
|
|
1051
|
+
* 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.
|
|
1052
|
+
* Example: 2023-01-20
|
|
1053
|
+
*/
|
|
1054
|
+
startDate?: string;
|
|
1256
1055
|
}
|
|
1257
1056
|
|
|
1057
|
+
export type GetOutput =
|
|
1058
|
+
MarketingCampaignsPublicApiSchemas.BatchResponsePublicCampaignWithAssets;
|
|
1059
|
+
|
|
1060
|
+
export type UpdateInput =
|
|
1061
|
+
MarketingCampaignsPublicApiSchemas.BatchInputPublicCampaignBatchUpdateItem;
|
|
1062
|
+
|
|
1063
|
+
export type UpdateOutput =
|
|
1064
|
+
MarketingCampaignsPublicApiSchemas.BatchResponsePublicCampaign;
|
|
1258
1065
|
/**
|
|
1259
1066
|
* Usage example:
|
|
1260
1067
|
* ```ts
|
|
1261
|
-
* import {
|
|
1262
|
-
* client.send(
|
|
1068
|
+
* import { marketingCampaignsBatch } from '@hubspot/api-client-core';
|
|
1069
|
+
* client.send(marketingCampaignsBatch.create(input));
|
|
1263
1070
|
* ```
|
|
1264
1071
|
*/
|
|
1265
|
-
export interface
|
|
1072
|
+
export interface API {
|
|
1266
1073
|
/**
|
|
1267
1074
|
* Create a batch of campaigns
|
|
1268
1075
|
* @apiPath /marketing/campaigns/2026-03/batch/create
|
|
1269
1076
|
* @apiMethod POST
|
|
1270
1077
|
* @requiredScopes campaigns-write
|
|
1271
1078
|
*/
|
|
1272
|
-
create: (input:
|
|
1079
|
+
create: (input: CreateInput) => Operation<CreateOutput>;
|
|
1273
1080
|
/**
|
|
1274
1081
|
* Delete a batch of campaigns
|
|
1275
1082
|
* @apiPath /marketing/campaigns/2026-03/batch/archive
|
|
1276
1083
|
* @apiMethod POST
|
|
1277
1084
|
* @requiredScopes campaigns-write
|
|
1278
1085
|
*/
|
|
1279
|
-
delete: (input:
|
|
1086
|
+
delete: (input: DeleteInput) => Operation<DeleteOutput>;
|
|
1280
1087
|
/**
|
|
1281
1088
|
* Read a batch of campaigns
|
|
1282
1089
|
* @apiPath /marketing/campaigns/2026-03/batch/read
|
|
1283
1090
|
* @apiMethod POST
|
|
1284
1091
|
* @requiredScopes campaigns-access
|
|
1285
1092
|
*/
|
|
1286
|
-
get: (input:
|
|
1093
|
+
get: (input: GetInput) => Operation<GetOutput>;
|
|
1287
1094
|
/**
|
|
1288
1095
|
* Update a batch of campaigns
|
|
1289
1096
|
* @apiPath /marketing/campaigns/2026-03/batch/update
|
|
1290
1097
|
* @apiMethod POST
|
|
1291
1098
|
* @requiredScopes campaigns-write
|
|
1292
1099
|
*/
|
|
1293
|
-
update: (input:
|
|
1100
|
+
update: (input: UpdateInput) => Operation<UpdateOutput>;
|
|
1101
|
+
}
|
|
1102
|
+
}
|
|
1103
|
+
|
|
1104
|
+
export namespace MarketingCampaignsBudget {
|
|
1105
|
+
export interface CreateInput {
|
|
1106
|
+
/**
|
|
1107
|
+
* The UUID of the campaign, required
|
|
1108
|
+
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
1109
|
+
*/
|
|
1110
|
+
campaignGuid: string;
|
|
1111
|
+
data: MarketingCampaignsPublicApiSchemas.PublicBudgetItemInput;
|
|
1112
|
+
}
|
|
1113
|
+
|
|
1114
|
+
export type CreateOutput =
|
|
1115
|
+
MarketingCampaignsPublicApiSchemas.PublicBudgetItem;
|
|
1116
|
+
|
|
1117
|
+
export interface DeleteInput {
|
|
1118
|
+
/**
|
|
1119
|
+
* The ID of the budget item, required. Example: 352
|
|
1120
|
+
*/
|
|
1121
|
+
budgetId: number;
|
|
1122
|
+
/**
|
|
1123
|
+
* The UUID of the campaign, required
|
|
1124
|
+
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
1125
|
+
*/
|
|
1126
|
+
campaignGuid: string;
|
|
1127
|
+
}
|
|
1128
|
+
|
|
1129
|
+
export type DeleteOutput = void;
|
|
1130
|
+
|
|
1131
|
+
export interface GetInput {
|
|
1132
|
+
/**
|
|
1133
|
+
* The ID of the budget item, required. Example: 352
|
|
1134
|
+
*/
|
|
1135
|
+
budgetId: number;
|
|
1136
|
+
/**
|
|
1137
|
+
* The UUID of the campaign, required
|
|
1138
|
+
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
1139
|
+
*/
|
|
1140
|
+
campaignGuid: string;
|
|
1141
|
+
}
|
|
1142
|
+
|
|
1143
|
+
export type GetOutput = MarketingCampaignsPublicApiSchemas.PublicBudgetItem;
|
|
1144
|
+
|
|
1145
|
+
export interface GetTotalsInput {
|
|
1146
|
+
/**
|
|
1147
|
+
* The UUID of the campaign, required
|
|
1148
|
+
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
1149
|
+
*/
|
|
1150
|
+
campaignGuid: string;
|
|
1151
|
+
}
|
|
1152
|
+
|
|
1153
|
+
export type GetTotalsOutput =
|
|
1154
|
+
MarketingCampaignsPublicApiSchemas.PublicBudgetTotals;
|
|
1155
|
+
|
|
1156
|
+
export interface UpdateInput {
|
|
1157
|
+
/**
|
|
1158
|
+
* The ID of the budget item, required. Example: 352
|
|
1159
|
+
*/
|
|
1160
|
+
budgetId: number;
|
|
1161
|
+
/**
|
|
1162
|
+
* The UUID of the campaign, required
|
|
1163
|
+
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
1164
|
+
*/
|
|
1165
|
+
campaignGuid: string;
|
|
1166
|
+
data: MarketingCampaignsPublicApiSchemas.PublicBudgetItemInput;
|
|
1294
1167
|
}
|
|
1295
1168
|
|
|
1169
|
+
export type UpdateOutput =
|
|
1170
|
+
MarketingCampaignsPublicApiSchemas.PublicBudgetItem;
|
|
1296
1171
|
/**
|
|
1297
1172
|
* Usage example:
|
|
1298
1173
|
* ```ts
|
|
1299
|
-
* import {
|
|
1300
|
-
* client.send(
|
|
1174
|
+
* import { marketingCampaignsBudget } from '@hubspot/api-client-core';
|
|
1175
|
+
* client.send(marketingCampaignsBudget.create(input));
|
|
1301
1176
|
* ```
|
|
1302
1177
|
*/
|
|
1303
|
-
export interface
|
|
1178
|
+
export interface API {
|
|
1304
1179
|
/**
|
|
1305
1180
|
* Add budget item
|
|
1306
1181
|
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}/budget
|
|
1307
1182
|
* @apiMethod POST
|
|
1308
1183
|
* @requiredScopes campaigns-write
|
|
1309
1184
|
*/
|
|
1310
|
-
create: (input:
|
|
1185
|
+
create: (input: CreateInput) => Operation<CreateOutput>;
|
|
1311
1186
|
/**
|
|
1312
1187
|
* Delete budget item
|
|
1313
1188
|
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}/budget/{budgetId}
|
|
1314
1189
|
* @apiMethod DELETE
|
|
1315
1190
|
* @requiredScopes campaigns-write
|
|
1316
1191
|
*/
|
|
1317
|
-
delete: (input:
|
|
1192
|
+
delete: (input: DeleteInput) => Operation<DeleteOutput>;
|
|
1318
1193
|
/**
|
|
1319
1194
|
* Get budget item
|
|
1320
1195
|
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}/budget/{budgetId}
|
|
1321
1196
|
* @apiMethod GET
|
|
1322
1197
|
* @requiredScopes campaigns-access
|
|
1323
1198
|
*/
|
|
1324
|
-
get: (input:
|
|
1199
|
+
get: (input: GetInput) => Operation<GetOutput>;
|
|
1325
1200
|
/**
|
|
1326
1201
|
* Read budget
|
|
1327
1202
|
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}/budget/totals
|
|
1328
1203
|
* @apiMethod GET
|
|
1329
1204
|
* @requiredScopes campaigns-access
|
|
1330
1205
|
*/
|
|
1331
|
-
getTotals: (
|
|
1332
|
-
input: Budget.GetTotalsInput
|
|
1333
|
-
) => Operation<Budget.GetTotalsOutput>;
|
|
1206
|
+
getTotals: (input: GetTotalsInput) => Operation<GetTotalsOutput>;
|
|
1334
1207
|
/**
|
|
1335
1208
|
* Update budget item
|
|
1336
1209
|
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}/budget/{budgetId}
|
|
1337
1210
|
* @apiMethod PUT
|
|
1338
1211
|
* @requiredScopes campaigns-write
|
|
1339
1212
|
*/
|
|
1340
|
-
update: (input:
|
|
1213
|
+
update: (input: UpdateInput) => Operation<UpdateOutput>;
|
|
1341
1214
|
}
|
|
1215
|
+
}
|
|
1342
1216
|
|
|
1217
|
+
export namespace MarketingCampaignsMetrics {
|
|
1218
|
+
export interface GetAttributionMetricsInput {
|
|
1219
|
+
/**
|
|
1220
|
+
* The unique identifier of the campaign
|
|
1221
|
+
*/
|
|
1222
|
+
campaignGuid: string;
|
|
1223
|
+
/**
|
|
1224
|
+
* The end date for fetching attribution data, in YYYY-MM-DD format.
|
|
1225
|
+
* Optional. Example: 2000-01-27
|
|
1226
|
+
*/
|
|
1227
|
+
endDate?: string;
|
|
1228
|
+
/**
|
|
1229
|
+
* The start date for fetching attribution data, in YYYY-MM-DD format.
|
|
1230
|
+
* Optional. Example: 2000-01-20
|
|
1231
|
+
*/
|
|
1232
|
+
startDate?: string;
|
|
1233
|
+
}
|
|
1234
|
+
|
|
1235
|
+
export type GetAttributionMetricsOutput =
|
|
1236
|
+
MarketingCampaignsPublicApiSchemas.MetricsCounters;
|
|
1237
|
+
|
|
1238
|
+
export interface GetRevenueAttributionInput {
|
|
1239
|
+
/**
|
|
1240
|
+
* 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
|
|
1241
|
+
*/
|
|
1242
|
+
attributionModel?: string;
|
|
1243
|
+
/**
|
|
1244
|
+
* The unique identifier of the campaign
|
|
1245
|
+
*/
|
|
1246
|
+
campaignGuid: string;
|
|
1247
|
+
/**
|
|
1248
|
+
* End date to fetch attribution data, YYYY-MM-DD
|
|
1249
|
+
*/
|
|
1250
|
+
endDate?: string;
|
|
1251
|
+
/**
|
|
1252
|
+
* Start date to fetch attribution data, YYYY-MM-DD
|
|
1253
|
+
*/
|
|
1254
|
+
startDate?: string;
|
|
1255
|
+
}
|
|
1256
|
+
|
|
1257
|
+
export type GetRevenueAttributionOutput =
|
|
1258
|
+
MarketingCampaignsPublicApiSchemas.RevenueAttributionAggregate;
|
|
1259
|
+
|
|
1260
|
+
export interface ListContactIdsByTypeInput {
|
|
1261
|
+
/**
|
|
1262
|
+
* 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.
|
|
1263
|
+
*/
|
|
1264
|
+
after?: string;
|
|
1265
|
+
/**
|
|
1266
|
+
* The unique identifier of the campaign
|
|
1267
|
+
*/
|
|
1268
|
+
campaignGuid: string;
|
|
1269
|
+
/**
|
|
1270
|
+
* The type of contact to filter the list
|
|
1271
|
+
*/
|
|
1272
|
+
contactType: string;
|
|
1273
|
+
/**
|
|
1274
|
+
* The end date for fetching contact data, in YYYY-MM-DD format.
|
|
1275
|
+
* Optional. Example: 2000-01-27
|
|
1276
|
+
*/
|
|
1277
|
+
endDate?: string;
|
|
1278
|
+
/**
|
|
1279
|
+
* The maximum number of results to display per page.
|
|
1280
|
+
*/
|
|
1281
|
+
limit?: number;
|
|
1282
|
+
/**
|
|
1283
|
+
* The start date for fetching contact data, in YYYY-MM-DD format.
|
|
1284
|
+
* Optional. Example: 2000-01-20
|
|
1285
|
+
*/
|
|
1286
|
+
startDate?: string;
|
|
1287
|
+
}
|
|
1288
|
+
|
|
1289
|
+
export type ListContactIdsByTypeOutput =
|
|
1290
|
+
MarketingCampaignsPublicApiSchemas.CollectionResponseContactReferenceForwardPaging;
|
|
1343
1291
|
/**
|
|
1344
1292
|
* Usage example:
|
|
1345
1293
|
* ```ts
|
|
1346
|
-
* import {
|
|
1347
|
-
* client.send(
|
|
1294
|
+
* import { marketingCampaignsMetrics } from '@hubspot/api-client-core';
|
|
1295
|
+
* client.send(marketingCampaignsMetrics.getAttributionMetrics(input));
|
|
1348
1296
|
* ```
|
|
1349
1297
|
*/
|
|
1350
|
-
export interface
|
|
1298
|
+
export interface API {
|
|
1351
1299
|
/**
|
|
1352
1300
|
* Get Campaign Metrics
|
|
1353
1301
|
*
|
|
@@ -1356,8 +1304,8 @@ export namespace MarketingCampaignsPublicApi {
|
|
|
1356
1304
|
* @requiredScopes campaigns-access
|
|
1357
1305
|
*/
|
|
1358
1306
|
getAttributionMetrics: (
|
|
1359
|
-
input:
|
|
1360
|
-
) => Operation<
|
|
1307
|
+
input: GetAttributionMetricsInput
|
|
1308
|
+
) => Operation<GetAttributionMetricsOutput>;
|
|
1361
1309
|
/**
|
|
1362
1310
|
* Fetch revenue
|
|
1363
1311
|
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}/reports/revenue
|
|
@@ -1365,8 +1313,8 @@ export namespace MarketingCampaignsPublicApi {
|
|
|
1365
1313
|
* @requiredScopes campaigns-revenue-pro, revenue-attribution-read
|
|
1366
1314
|
*/
|
|
1367
1315
|
getRevenueAttribution: (
|
|
1368
|
-
input:
|
|
1369
|
-
) => Operation<
|
|
1316
|
+
input: GetRevenueAttributionInput
|
|
1317
|
+
) => Operation<GetRevenueAttributionOutput>;
|
|
1370
1318
|
/**
|
|
1371
1319
|
* Fetch contact IDs
|
|
1372
1320
|
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}/reports/contacts/{contactType}
|
|
@@ -1374,61 +1322,100 @@ export namespace MarketingCampaignsPublicApi {
|
|
|
1374
1322
|
* @requiredScopes campaigns-access
|
|
1375
1323
|
*/
|
|
1376
1324
|
listContactIdsByType: (
|
|
1377
|
-
input:
|
|
1378
|
-
) => Operation<
|
|
1325
|
+
input: ListContactIdsByTypeInput
|
|
1326
|
+
) => Operation<ListContactIdsByTypeOutput>;
|
|
1379
1327
|
}
|
|
1328
|
+
}
|
|
1380
1329
|
|
|
1330
|
+
export namespace MarketingCampaignsSpend {
|
|
1331
|
+
export interface CreateInput {
|
|
1332
|
+
/**
|
|
1333
|
+
* The UUID of the campaign, required
|
|
1334
|
+
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
1335
|
+
*/
|
|
1336
|
+
campaignGuid: string;
|
|
1337
|
+
data: MarketingCampaignsPublicApiSchemas.PublicSpendItemInput;
|
|
1338
|
+
}
|
|
1339
|
+
|
|
1340
|
+
export type CreateOutput = MarketingCampaignsPublicApiSchemas.PublicSpendItem;
|
|
1341
|
+
|
|
1342
|
+
export interface DeleteInput {
|
|
1343
|
+
/**
|
|
1344
|
+
* The UUID of the campaign, required
|
|
1345
|
+
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
1346
|
+
*/
|
|
1347
|
+
campaignGuid: string;
|
|
1348
|
+
/**
|
|
1349
|
+
* The ID of the spend item, required. Example: 491
|
|
1350
|
+
*/
|
|
1351
|
+
spendId: number;
|
|
1352
|
+
}
|
|
1353
|
+
|
|
1354
|
+
export type DeleteOutput = void;
|
|
1355
|
+
|
|
1356
|
+
export interface GetInput {
|
|
1357
|
+
/**
|
|
1358
|
+
* The UUID of the campaign, required
|
|
1359
|
+
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
1360
|
+
*/
|
|
1361
|
+
campaignGuid: string;
|
|
1362
|
+
/**
|
|
1363
|
+
* The ID of the spend item, required. Example: 491
|
|
1364
|
+
*/
|
|
1365
|
+
spendId: number;
|
|
1366
|
+
}
|
|
1367
|
+
|
|
1368
|
+
export type GetOutput = MarketingCampaignsPublicApiSchemas.PublicSpendItem;
|
|
1369
|
+
|
|
1370
|
+
export interface UpdateInput {
|
|
1371
|
+
/**
|
|
1372
|
+
* The UUID of the campaign, required
|
|
1373
|
+
* Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
|
|
1374
|
+
*/
|
|
1375
|
+
campaignGuid: string;
|
|
1376
|
+
data: MarketingCampaignsPublicApiSchemas.PublicSpendItemInput;
|
|
1377
|
+
/**
|
|
1378
|
+
* The ID of the spend item, required. Example: 491
|
|
1379
|
+
*/
|
|
1380
|
+
spendId: number;
|
|
1381
|
+
}
|
|
1382
|
+
|
|
1383
|
+
export type UpdateOutput = MarketingCampaignsPublicApiSchemas.PublicSpendItem;
|
|
1381
1384
|
/**
|
|
1382
1385
|
* Usage example:
|
|
1383
1386
|
* ```ts
|
|
1384
|
-
* import {
|
|
1385
|
-
* client.send(
|
|
1387
|
+
* import { marketingCampaignsSpend } from '@hubspot/api-client-core';
|
|
1388
|
+
* client.send(marketingCampaignsSpend.create(input));
|
|
1386
1389
|
* ```
|
|
1387
1390
|
*/
|
|
1388
|
-
export interface
|
|
1391
|
+
export interface API {
|
|
1389
1392
|
/**
|
|
1390
1393
|
* Create campaign spend item
|
|
1391
1394
|
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}/spend
|
|
1392
1395
|
* @apiMethod POST
|
|
1393
1396
|
* @requiredScopes campaigns-write
|
|
1394
1397
|
*/
|
|
1395
|
-
create: (input:
|
|
1398
|
+
create: (input: CreateInput) => Operation<CreateOutput>;
|
|
1396
1399
|
/**
|
|
1397
1400
|
* Delete campaign spend item
|
|
1398
1401
|
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}/spend/{spendId}
|
|
1399
1402
|
* @apiMethod DELETE
|
|
1400
1403
|
* @requiredScopes campaigns-write
|
|
1401
1404
|
*/
|
|
1402
|
-
delete: (input:
|
|
1405
|
+
delete: (input: DeleteInput) => Operation<DeleteOutput>;
|
|
1403
1406
|
/**
|
|
1404
1407
|
* Read campaign spend item
|
|
1405
1408
|
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}/spend/{spendId}
|
|
1406
1409
|
* @apiMethod GET
|
|
1407
1410
|
* @requiredScopes campaigns-access
|
|
1408
1411
|
*/
|
|
1409
|
-
get: (input:
|
|
1412
|
+
get: (input: GetInput) => Operation<GetOutput>;
|
|
1410
1413
|
/**
|
|
1411
1414
|
* Update campaign spend item
|
|
1412
1415
|
* @apiPath /marketing/campaigns/2026-03/{campaignGuid}/spend/{spendId}
|
|
1413
1416
|
* @apiMethod PUT
|
|
1414
1417
|
* @requiredScopes campaigns-write
|
|
1415
1418
|
*/
|
|
1416
|
-
update: (input:
|
|
1417
|
-
}
|
|
1418
|
-
|
|
1419
|
-
/**
|
|
1420
|
-
* Usage example:
|
|
1421
|
-
* ```ts
|
|
1422
|
-
* import { marketingCampaignsPublicApi } from '@hubspot/api-client-core';
|
|
1423
|
-
* client.send(marketingCampaignsPublicApi.assets.delete(input));
|
|
1424
|
-
* ```
|
|
1425
|
-
*/
|
|
1426
|
-
export interface API {
|
|
1427
|
-
assets: AssetsAPI;
|
|
1428
|
-
basic: BasicAPI;
|
|
1429
|
-
batch: BatchAPI;
|
|
1430
|
-
budget: BudgetAPI;
|
|
1431
|
-
metrics: MetricsAPI;
|
|
1432
|
-
spend: SpendAPI;
|
|
1419
|
+
update: (input: UpdateInput) => Operation<UpdateOutput>;
|
|
1433
1420
|
}
|
|
1434
1421
|
}
|