@hubspot/app-connect-sdk 1.0.0-alpha.2 → 1.0.0-alpha.20

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.
Files changed (721) hide show
  1. package/.turbo/turbo-format$colon$check.log +1 -1
  2. package/.turbo/turbo-test.log +93 -52
  3. package/.turbo/turbo-tsdown.log +475 -472
  4. package/build/tsconfig.browser.tsbuildinfo +1 -1
  5. package/build/tsconfig.server.tsbuildinfo +1 -1
  6. package/dist/browser/{HubSpotAppConnect-BW45gyDs.js → HubSpotAppConnect-DFe9b90e.js} +4 -3
  7. package/dist/browser/HubSpotAppConnect-DFe9b90e.js.map +1 -0
  8. package/dist/browser/{create-vctOhpX9.js → create-BNQazCF-.js} +277 -86
  9. package/dist/browser/create-BNQazCF-.js.map +1 -0
  10. package/dist/browser/index.d.ts +2 -2
  11. package/dist/browser/index.js +1 -1
  12. package/dist/browser/react/lovable.d.ts +9 -2
  13. package/dist/browser/react/lovable.js +7 -4
  14. package/dist/browser/react/lovable.js.map +1 -1
  15. package/dist/browser/react.d.ts +2 -3
  16. package/dist/browser/react.js +1 -1
  17. package/dist/browser/{types-rTQw6A54.d.ts → types-DkAmHcZt.d.ts} +22 -7
  18. package/dist/server/api-client-core/apis/account/account-info-types.generated.d.ts +73 -85
  19. package/dist/server/api-client-core/apis/account/account-info.generated.d.ts +3 -3
  20. package/dist/server/api-client-core/apis/account/account-info.generated.js +4 -3
  21. package/dist/server/api-client-core/apis/account/account-info.generated.js.map +1 -1
  22. package/dist/server/api-client-core/apis/account/audit-logs-types.generated.d.ts +203 -215
  23. package/dist/server/api-client-core/apis/account/audit-logs.generated.d.ts +3 -3
  24. package/dist/server/api-client-core/apis/account/audit-logs.generated.js +4 -3
  25. package/dist/server/api-client-core/apis/account/audit-logs.generated.js.map +1 -1
  26. package/dist/server/api-client-core/apis/auth/oauth-types.generated.d.ts +78 -90
  27. package/dist/server/api-client-core/apis/auth/oauth.generated.d.ts +1 -1
  28. package/dist/server/api-client-core/apis/auth/oauth.generated.js +3 -2
  29. package/dist/server/api-client-core/apis/auth/oauth.generated.js.map +1 -1
  30. package/dist/server/api-client-core/apis/automation/actions-types.generated.d.ts +779 -794
  31. package/dist/server/api-client-core/apis/automation/actions.generated.d.ts +6 -3
  32. package/dist/server/api-client-core/apis/automation/actions.generated.js +101 -102
  33. package/dist/server/api-client-core/apis/automation/actions.generated.js.map +1 -1
  34. package/dist/server/api-client-core/apis/automation/sequences-types.generated.d.ts +370 -382
  35. package/dist/server/api-client-core/apis/automation/sequences.generated.d.ts +1 -1
  36. package/dist/server/api-client-core/apis/automation/sequences.generated.js +3 -2
  37. package/dist/server/api-client-core/apis/automation/sequences.generated.js.map +1 -1
  38. package/dist/server/api-client-core/apis/business-units-types.generated.d.ts +43 -55
  39. package/dist/server/api-client-core/apis/business-units.generated.d.ts +3 -3
  40. package/dist/server/api-client-core/apis/business-units.generated.js +4 -3
  41. package/dist/server/api-client-core/apis/business-units.generated.js.map +1 -1
  42. package/dist/server/api-client-core/apis/cms/authors-types.generated.d.ts +420 -445
  43. package/dist/server/api-client-core/apis/cms/authors.generated.d.ts +4 -3
  44. package/dist/server/api-client-core/apis/cms/authors.generated.js +155 -158
  45. package/dist/server/api-client-core/apis/cms/authors.generated.js.map +1 -1
  46. package/dist/server/api-client-core/apis/cms/blog-settings-types.generated.d.ts +270 -295
  47. package/dist/server/api-client-core/apis/cms/blog-settings.generated.d.ts +4 -3
  48. package/dist/server/api-client-core/apis/cms/blog-settings.generated.js +35 -38
  49. package/dist/server/api-client-core/apis/cms/blog-settings.generated.js.map +1 -1
  50. package/dist/server/api-client-core/apis/cms/cms-content-audit-types.generated.d.ts +107 -131
  51. package/dist/server/api-client-core/apis/cms/cms-content-audit.generated.d.ts +3 -3
  52. package/dist/server/api-client-core/apis/cms/cms-content-audit.generated.js +6 -5
  53. package/dist/server/api-client-core/apis/cms/cms-content-audit.generated.js.map +1 -1
  54. package/dist/server/api-client-core/apis/cms/domains-types.generated.d.ts +155 -167
  55. package/dist/server/api-client-core/apis/cms/domains.generated.d.ts +2 -2
  56. package/dist/server/api-client-core/apis/cms/domains.generated.js +3 -2
  57. package/dist/server/api-client-core/apis/cms/domains.generated.js.map +1 -1
  58. package/dist/server/api-client-core/apis/cms/hubdb-types.generated.d.ts +876 -889
  59. package/dist/server/api-client-core/apis/cms/hubdb.generated.d.ts +4 -3
  60. package/dist/server/api-client-core/apis/cms/hubdb.generated.js +184 -185
  61. package/dist/server/api-client-core/apis/cms/hubdb.generated.js.map +1 -1
  62. package/dist/server/api-client-core/apis/cms/media-bridge-types.generated.d.ts +1550 -1575
  63. package/dist/server/api-client-core/apis/cms/media-bridge.generated.d.ts +4 -3
  64. package/dist/server/api-client-core/apis/cms/media-bridge.generated.js +161 -164
  65. package/dist/server/api-client-core/apis/cms/media-bridge.generated.js.map +1 -1
  66. package/dist/server/api-client-core/apis/cms/pages-types.generated.d.ts +1583 -1547
  67. package/dist/server/api-client-core/apis/cms/pages.generated.d.ts +15 -3
  68. package/dist/server/api-client-core/apis/cms/pages.generated.js +335 -326
  69. package/dist/server/api-client-core/apis/cms/pages.generated.js.map +1 -1
  70. package/dist/server/api-client-core/apis/cms/posts-types.generated.d.ts +900 -904
  71. package/dist/server/api-client-core/apis/cms/posts.generated.d.ts +7 -3
  72. package/dist/server/api-client-core/apis/cms/posts.generated.js +197 -196
  73. package/dist/server/api-client-core/apis/cms/posts.generated.js.map +1 -1
  74. package/dist/server/api-client-core/apis/cms/site-search-types.generated.d.ts +162 -174
  75. package/dist/server/api-client-core/apis/cms/site-search.generated.d.ts +3 -3
  76. package/dist/server/api-client-core/apis/cms/site-search.generated.js +4 -3
  77. package/dist/server/api-client-core/apis/cms/site-search.generated.js.map +1 -1
  78. package/dist/server/api-client-core/apis/cms/source-code-types.generated.d.ts +148 -172
  79. package/dist/server/api-client-core/apis/cms/source-code.generated.d.ts +3 -3
  80. package/dist/server/api-client-core/apis/cms/source-code.generated.js +40 -43
  81. package/dist/server/api-client-core/apis/cms/source-code.generated.js.map +1 -1
  82. package/dist/server/api-client-core/apis/cms/tags-types.generated.d.ts +406 -420
  83. package/dist/server/api-client-core/apis/cms/tags.generated.d.ts +5 -3
  84. package/dist/server/api-client-core/apis/cms/tags.generated.js +157 -158
  85. package/dist/server/api-client-core/apis/cms/tags.generated.js.map +1 -1
  86. package/dist/server/api-client-core/apis/cms/url-mappings-types.generated.d.ts +127 -139
  87. package/dist/server/api-client-core/apis/cms/url-mappings.generated.d.ts +3 -3
  88. package/dist/server/api-client-core/apis/cms/url-mappings.generated.js +4 -3
  89. package/dist/server/api-client-core/apis/cms/url-mappings.generated.js.map +1 -1
  90. package/dist/server/api-client-core/apis/cms/url-redirects-types.generated.d.ts +170 -182
  91. package/dist/server/api-client-core/apis/cms/url-redirects.generated.d.ts +3 -3
  92. package/dist/server/api-client-core/apis/cms/url-redirects.generated.js +4 -3
  93. package/dist/server/api-client-core/apis/cms/url-redirects.generated.js.map +1 -1
  94. package/dist/server/api-client-core/apis/communication-preferences/subscriptions-types.generated.d.ts +728 -742
  95. package/dist/server/api-client-core/apis/communication-preferences/subscriptions.generated.d.ts +5 -3
  96. package/dist/server/api-client-core/apis/communication-preferences/subscriptions.generated.js +66 -69
  97. package/dist/server/api-client-core/apis/communication-preferences/subscriptions.generated.js.map +1 -1
  98. package/dist/server/api-client-core/apis/conversations/custom-channels-types.generated.d.ts +445 -471
  99. package/dist/server/api-client-core/apis/conversations/custom-channels.generated.d.ts +5 -3
  100. package/dist/server/api-client-core/apis/conversations/custom-channels.generated.js +70 -73
  101. package/dist/server/api-client-core/apis/conversations/custom-channels.generated.js.map +1 -1
  102. package/dist/server/api-client-core/apis/conversations/visitor-identification-types.generated.d.ts +28 -40
  103. package/dist/server/api-client-core/apis/conversations/visitor-identification.generated.d.ts +3 -3
  104. package/dist/server/api-client-core/apis/conversations/visitor-identification.generated.js +3 -2
  105. package/dist/server/api-client-core/apis/conversations/visitor-identification.generated.js.map +1 -1
  106. package/dist/server/api-client-core/apis/conversations-types.generated.d.ts +768 -781
  107. package/dist/server/api-client-core/apis/conversations.generated.d.ts +4 -3
  108. package/dist/server/api-client-core/apis/conversations.generated.js +101 -102
  109. package/dist/server/api-client-core/apis/conversations.generated.js.map +1 -1
  110. package/dist/server/api-client-core/apis/crm/app-uninstalls-types.generated.d.ts +8 -19
  111. package/dist/server/api-client-core/apis/crm/app-uninstalls.generated.d.ts +3 -3
  112. package/dist/server/api-client-core/apis/crm/app-uninstalls.generated.js +3 -2
  113. package/dist/server/api-client-core/apis/crm/app-uninstalls.generated.js.map +1 -1
  114. package/dist/server/api-client-core/apis/crm/appointments-types.generated.d.ts +887 -891
  115. package/dist/server/api-client-core/apis/crm/appointments.generated.d.ts +7 -3
  116. package/dist/server/api-client-core/apis/crm/appointments.generated.js +105 -106
  117. package/dist/server/api-client-core/apis/crm/appointments.generated.js.map +1 -1
  118. package/dist/server/api-client-core/apis/crm/associations-schema-types.generated.d.ts +247 -260
  119. package/dist/server/api-client-core/apis/crm/associations-schema.generated.d.ts +4 -3
  120. package/dist/server/api-client-core/apis/crm/associations-schema.generated.js +48 -49
  121. package/dist/server/api-client-core/apis/crm/associations-schema.generated.js.map +1 -1
  122. package/dist/server/api-client-core/apis/crm/associations-types.generated.d.ts +576 -590
  123. package/dist/server/api-client-core/apis/crm/associations.generated.d.ts +5 -3
  124. package/dist/server/api-client-core/apis/crm/associations.generated.js +71 -72
  125. package/dist/server/api-client-core/apis/crm/associations.generated.js.map +1 -1
  126. package/dist/server/api-client-core/apis/crm/calling-extensions-types.generated.d.ts +355 -379
  127. package/dist/server/api-client-core/apis/crm/calling-extensions.generated.d.ts +3 -3
  128. package/dist/server/api-client-core/apis/crm/calling-extensions.generated.js +34 -37
  129. package/dist/server/api-client-core/apis/crm/calling-extensions.generated.js.map +1 -1
  130. package/dist/server/api-client-core/apis/crm/calls-types.generated.d.ts +755 -769
  131. package/dist/server/api-client-core/apis/crm/calls.generated.d.ts +5 -3
  132. package/dist/server/api-client-core/apis/crm/calls.generated.js +58 -57
  133. package/dist/server/api-client-core/apis/crm/calls.generated.js.map +1 -1
  134. package/dist/server/api-client-core/apis/crm/carts-types.generated.d.ts +755 -769
  135. package/dist/server/api-client-core/apis/crm/carts.generated.d.ts +5 -3
  136. package/dist/server/api-client-core/apis/crm/carts.generated.js +58 -57
  137. package/dist/server/api-client-core/apis/crm/carts.generated.js.map +1 -1
  138. package/dist/server/api-client-core/apis/crm/commerce-payments-types.generated.d.ts +755 -769
  139. package/dist/server/api-client-core/apis/crm/commerce-payments.generated.d.ts +5 -3
  140. package/dist/server/api-client-core/apis/crm/commerce-payments.generated.js +58 -57
  141. package/dist/server/api-client-core/apis/crm/commerce-payments.generated.js.map +1 -1
  142. package/dist/server/api-client-core/apis/crm/commerce-subscriptions-types.generated.d.ts +752 -766
  143. package/dist/server/api-client-core/apis/crm/commerce-subscriptions.generated.d.ts +5 -3
  144. package/dist/server/api-client-core/apis/crm/commerce-subscriptions.generated.js +58 -57
  145. package/dist/server/api-client-core/apis/crm/commerce-subscriptions.generated.js.map +1 -1
  146. package/dist/server/api-client-core/apis/crm/communications-types.generated.d.ts +755 -769
  147. package/dist/server/api-client-core/apis/crm/communications.generated.d.ts +5 -3
  148. package/dist/server/api-client-core/apis/crm/communications.generated.js +58 -57
  149. package/dist/server/api-client-core/apis/crm/communications.generated.js.map +1 -1
  150. package/dist/server/api-client-core/apis/crm/companies-types.generated.d.ts +769 -795
  151. package/dist/server/api-client-core/apis/crm/companies.generated.d.ts +5 -3
  152. package/dist/server/api-client-core/apis/crm/companies.generated.js +59 -58
  153. package/dist/server/api-client-core/apis/crm/companies.generated.js.map +1 -1
  154. package/dist/server/api-client-core/apis/crm/contacts-types.generated.d.ts +786 -812
  155. package/dist/server/api-client-core/apis/crm/contacts.generated.d.ts +5 -3
  156. package/dist/server/api-client-core/apis/crm/contacts.generated.js +60 -61
  157. package/dist/server/api-client-core/apis/crm/contacts.generated.js.map +1 -1
  158. package/dist/server/api-client-core/apis/crm/contracts-types.generated.d.ts +796 -777
  159. package/dist/server/api-client-core/apis/crm/contracts.generated.d.ts +8 -3
  160. package/dist/server/api-client-core/apis/crm/contracts.generated.js +60 -57
  161. package/dist/server/api-client-core/apis/crm/contracts.generated.js.map +1 -1
  162. package/dist/server/api-client-core/apis/crm/courses-types.generated.d.ts +758 -772
  163. package/dist/server/api-client-core/apis/crm/courses.generated.d.ts +5 -3
  164. package/dist/server/api-client-core/apis/crm/courses.generated.js +58 -57
  165. package/dist/server/api-client-core/apis/crm/courses.generated.js.map +1 -1
  166. package/dist/server/api-client-core/apis/crm/crm-owners-types.generated.d.ts +103 -115
  167. package/dist/server/api-client-core/apis/crm/crm-owners.generated.d.ts +3 -3
  168. package/dist/server/api-client-core/apis/crm/crm-owners.generated.js +4 -3
  169. package/dist/server/api-client-core/apis/crm/crm-owners.generated.js.map +1 -1
  170. package/dist/server/api-client-core/apis/crm/custom-objects-types.generated.d.ts +833 -848
  171. package/dist/server/api-client-core/apis/crm/custom-objects.generated.d.ts +6 -3
  172. package/dist/server/api-client-core/apis/crm/custom-objects.generated.js +91 -90
  173. package/dist/server/api-client-core/apis/crm/custom-objects.generated.js.map +1 -1
  174. package/dist/server/api-client-core/apis/crm/deal-splits-types.generated.d.ts +158 -170
  175. package/dist/server/api-client-core/apis/crm/deal-splits.generated.d.ts +3 -3
  176. package/dist/server/api-client-core/apis/crm/deal-splits.generated.js +4 -3
  177. package/dist/server/api-client-core/apis/crm/deal-splits.generated.js.map +1 -1
  178. package/dist/server/api-client-core/apis/crm/deals-types.generated.d.ts +771 -785
  179. package/dist/server/api-client-core/apis/crm/deals.generated.d.ts +5 -3
  180. package/dist/server/api-client-core/apis/crm/deals.generated.js +59 -58
  181. package/dist/server/api-client-core/apis/crm/deals.generated.js.map +1 -1
  182. package/dist/server/api-client-core/apis/crm/discounts-types.generated.d.ts +754 -768
  183. package/dist/server/api-client-core/apis/crm/discounts.generated.d.ts +5 -3
  184. package/dist/server/api-client-core/apis/crm/discounts.generated.js +58 -57
  185. package/dist/server/api-client-core/apis/crm/discounts.generated.js.map +1 -1
  186. package/dist/server/api-client-core/apis/crm/emails-types.generated.d.ts +755 -769
  187. package/dist/server/api-client-core/apis/crm/emails.generated.d.ts +5 -3
  188. package/dist/server/api-client-core/apis/crm/emails.generated.js +58 -57
  189. package/dist/server/api-client-core/apis/crm/emails.generated.js.map +1 -1
  190. package/dist/server/api-client-core/apis/crm/exports-types.generated.d.ts +227 -251
  191. package/dist/server/api-client-core/apis/crm/exports.generated.d.ts +2 -2
  192. package/dist/server/api-client-core/apis/crm/exports.generated.js +4 -5
  193. package/dist/server/api-client-core/apis/crm/exports.generated.js.map +1 -1
  194. package/dist/server/api-client-core/apis/crm/feedback-submissions-types.generated.d.ts +551 -565
  195. package/dist/server/api-client-core/apis/crm/feedback-submissions.generated.d.ts +5 -3
  196. package/dist/server/api-client-core/apis/crm/feedback-submissions.generated.js +45 -46
  197. package/dist/server/api-client-core/apis/crm/feedback-submissions.generated.js.map +1 -1
  198. package/dist/server/api-client-core/apis/crm/fees-types.generated.d.ts +755 -769
  199. package/dist/server/api-client-core/apis/crm/fees.generated.d.ts +5 -3
  200. package/dist/server/api-client-core/apis/crm/fees.generated.js +58 -57
  201. package/dist/server/api-client-core/apis/crm/fees.generated.js.map +1 -1
  202. package/dist/server/api-client-core/apis/crm/goal-targets-types.generated.d.ts +755 -769
  203. package/dist/server/api-client-core/apis/crm/goal-targets.generated.d.ts +5 -3
  204. package/dist/server/api-client-core/apis/crm/goal-targets.generated.js +58 -57
  205. package/dist/server/api-client-core/apis/crm/goal-targets.generated.js.map +1 -1
  206. package/dist/server/api-client-core/apis/crm/imports-types.generated.d.ts +305 -329
  207. package/dist/server/api-client-core/apis/crm/imports.generated.d.ts +2 -2
  208. package/dist/server/api-client-core/apis/crm/imports.generated.js +20 -23
  209. package/dist/server/api-client-core/apis/crm/imports.generated.js.map +1 -1
  210. package/dist/server/api-client-core/apis/crm/invoices-types.generated.d.ts +755 -769
  211. package/dist/server/api-client-core/apis/crm/invoices.generated.d.ts +5 -3
  212. package/dist/server/api-client-core/apis/crm/invoices.generated.js +58 -57
  213. package/dist/server/api-client-core/apis/crm/invoices.generated.js.map +1 -1
  214. package/dist/server/api-client-core/apis/crm/leads-types.generated.d.ts +755 -769
  215. package/dist/server/api-client-core/apis/crm/leads.generated.d.ts +5 -3
  216. package/dist/server/api-client-core/apis/crm/leads.generated.js +58 -57
  217. package/dist/server/api-client-core/apis/crm/leads.generated.js.map +1 -1
  218. package/dist/server/api-client-core/apis/crm/limits-tracking-types.generated.d.ts +251 -263
  219. package/dist/server/api-client-core/apis/crm/limits-tracking.generated.d.ts +3 -3
  220. package/dist/server/api-client-core/apis/crm/limits-tracking.generated.js +4 -3
  221. package/dist/server/api-client-core/apis/crm/limits-tracking.generated.js.map +1 -1
  222. package/dist/server/api-client-core/apis/crm/line-items-types.generated.d.ts +755 -769
  223. package/dist/server/api-client-core/apis/crm/line-items.generated.d.ts +5 -3
  224. package/dist/server/api-client-core/apis/crm/line-items.generated.js +58 -57
  225. package/dist/server/api-client-core/apis/crm/line-items.generated.js.map +1 -1
  226. package/dist/server/api-client-core/apis/crm/listings-types.generated.d.ts +758 -772
  227. package/dist/server/api-client-core/apis/crm/listings.generated.d.ts +5 -3
  228. package/dist/server/api-client-core/apis/crm/listings.generated.js +58 -57
  229. package/dist/server/api-client-core/apis/crm/listings.generated.js.map +1 -1
  230. package/dist/server/api-client-core/apis/crm/lists-types.generated.d.ts +2075 -2111
  231. package/dist/server/api-client-core/apis/crm/lists.generated.d.ts +2 -2
  232. package/dist/server/api-client-core/apis/crm/lists.generated.js +97 -98
  233. package/dist/server/api-client-core/apis/crm/lists.generated.js.map +1 -1
  234. package/dist/server/api-client-core/apis/crm/meetings-types.generated.d.ts +755 -769
  235. package/dist/server/api-client-core/apis/crm/meetings.generated.d.ts +5 -3
  236. package/dist/server/api-client-core/apis/crm/meetings.generated.js +58 -57
  237. package/dist/server/api-client-core/apis/crm/meetings.generated.js.map +1 -1
  238. package/dist/server/api-client-core/apis/crm/notes-types.generated.d.ts +755 -769
  239. package/dist/server/api-client-core/apis/crm/notes.generated.d.ts +5 -3
  240. package/dist/server/api-client-core/apis/crm/notes.generated.js +58 -57
  241. package/dist/server/api-client-core/apis/crm/notes.generated.js.map +1 -1
  242. package/dist/server/api-client-core/apis/crm/object-library-types.generated.d.ts +24 -36
  243. package/dist/server/api-client-core/apis/crm/object-library.generated.d.ts +3 -3
  244. package/dist/server/api-client-core/apis/crm/object-library.generated.js +4 -3
  245. package/dist/server/api-client-core/apis/crm/object-library.generated.js.map +1 -1
  246. package/dist/server/api-client-core/apis/crm/objects-types.generated.d.ts +620 -645
  247. package/dist/server/api-client-core/apis/crm/objects.generated.d.ts +4 -3
  248. package/dist/server/api-client-core/apis/crm/objects.generated.js +66 -67
  249. package/dist/server/api-client-core/apis/crm/objects.generated.js.map +1 -1
  250. package/dist/server/api-client-core/apis/crm/orders-types.generated.d.ts +747 -761
  251. package/dist/server/api-client-core/apis/crm/orders.generated.d.ts +5 -3
  252. package/dist/server/api-client-core/apis/crm/orders.generated.js +58 -57
  253. package/dist/server/api-client-core/apis/crm/orders.generated.js.map +1 -1
  254. package/dist/server/api-client-core/apis/crm/partner-clients-types.generated.d.ts +646 -660
  255. package/dist/server/api-client-core/apis/crm/partner-clients.generated.d.ts +5 -3
  256. package/dist/server/api-client-core/apis/crm/partner-clients.generated.js +63 -62
  257. package/dist/server/api-client-core/apis/crm/partner-clients.generated.js.map +1 -1
  258. package/dist/server/api-client-core/apis/crm/partner-services-types.generated.d.ts +646 -660
  259. package/dist/server/api-client-core/apis/crm/partner-services.generated.d.ts +5 -3
  260. package/dist/server/api-client-core/apis/crm/partner-services.generated.js +63 -62
  261. package/dist/server/api-client-core/apis/crm/partner-services.generated.js.map +1 -1
  262. package/dist/server/api-client-core/apis/crm/pipelines-types.generated.d.ts +320 -332
  263. package/dist/server/api-client-core/apis/crm/pipelines.generated.d.ts +2 -2
  264. package/dist/server/api-client-core/apis/crm/pipelines.generated.js +3 -2
  265. package/dist/server/api-client-core/apis/crm/pipelines.generated.js.map +1 -1
  266. package/dist/server/api-client-core/apis/crm/postal-mail-types.generated.d.ts +744 -758
  267. package/dist/server/api-client-core/apis/crm/postal-mail.generated.d.ts +5 -3
  268. package/dist/server/api-client-core/apis/crm/postal-mail.generated.js +58 -57
  269. package/dist/server/api-client-core/apis/crm/postal-mail.generated.js.map +1 -1
  270. package/dist/server/api-client-core/apis/crm/products-types.generated.d.ts +747 -761
  271. package/dist/server/api-client-core/apis/crm/products.generated.d.ts +5 -3
  272. package/dist/server/api-client-core/apis/crm/products.generated.js +58 -57
  273. package/dist/server/api-client-core/apis/crm/products.generated.js.map +1 -1
  274. package/dist/server/api-client-core/apis/crm/projects-types.generated.d.ts +761 -787
  275. package/dist/server/api-client-core/apis/crm/projects.generated.d.ts +5 -3
  276. package/dist/server/api-client-core/apis/crm/projects.generated.js +59 -58
  277. package/dist/server/api-client-core/apis/crm/projects.generated.js.map +1 -1
  278. package/dist/server/api-client-core/apis/crm/properties-types.generated.d.ts +526 -528
  279. package/dist/server/api-client-core/apis/crm/properties.generated.d.ts +5 -3
  280. package/dist/server/api-client-core/apis/crm/properties.generated.js +79 -78
  281. package/dist/server/api-client-core/apis/crm/properties.generated.js.map +1 -1
  282. package/dist/server/api-client-core/apis/crm/property-validations-types.generated.d.ts +71 -83
  283. package/dist/server/api-client-core/apis/crm/property-validations.generated.d.ts +3 -3
  284. package/dist/server/api-client-core/apis/crm/property-validations.generated.js +4 -3
  285. package/dist/server/api-client-core/apis/crm/property-validations.generated.js.map +1 -1
  286. package/dist/server/api-client-core/apis/crm/public-app-crm-cards-types.generated.d.ts +409 -433
  287. package/dist/server/api-client-core/apis/crm/public-app-crm-cards.generated.d.ts +3 -3
  288. package/dist/server/api-client-core/apis/crm/public-app-crm-cards.generated.js +24 -25
  289. package/dist/server/api-client-core/apis/crm/public-app-crm-cards.generated.js.map +1 -1
  290. package/dist/server/api-client-core/apis/crm/public-app-feature-flags-types.generated.d.ts +156 -169
  291. package/dist/server/api-client-core/apis/crm/public-app-feature-flags.generated.d.ts +4 -3
  292. package/dist/server/api-client-core/apis/crm/public-app-feature-flags.generated.js +55 -56
  293. package/dist/server/api-client-core/apis/crm/public-app-feature-flags.generated.js.map +1 -1
  294. package/dist/server/api-client-core/apis/crm/quotes-types.generated.d.ts +747 -761
  295. package/dist/server/api-client-core/apis/crm/quotes.generated.d.ts +5 -3
  296. package/dist/server/api-client-core/apis/crm/quotes.generated.js +58 -57
  297. package/dist/server/api-client-core/apis/crm/quotes.generated.js.map +1 -1
  298. package/dist/server/api-client-core/apis/crm/schemas-types.generated.d.ts +575 -600
  299. package/dist/server/api-client-core/apis/crm/schemas.generated.d.ts +4 -3
  300. package/dist/server/api-client-core/apis/crm/schemas.generated.js +33 -34
  301. package/dist/server/api-client-core/apis/crm/schemas.generated.js.map +1 -1
  302. package/dist/server/api-client-core/apis/crm/services-types.generated.d.ts +750 -764
  303. package/dist/server/api-client-core/apis/crm/services.generated.d.ts +5 -3
  304. package/dist/server/api-client-core/apis/crm/services.generated.js +58 -57
  305. package/dist/server/api-client-core/apis/crm/services.generated.js.map +1 -1
  306. package/dist/server/api-client-core/apis/crm/tasks-types.generated.d.ts +747 -761
  307. package/dist/server/api-client-core/apis/crm/tasks.generated.d.ts +5 -3
  308. package/dist/server/api-client-core/apis/crm/tasks.generated.js +58 -57
  309. package/dist/server/api-client-core/apis/crm/tasks.generated.js.map +1 -1
  310. package/dist/server/api-client-core/apis/crm/taxes-types.generated.d.ts +747 -761
  311. package/dist/server/api-client-core/apis/crm/taxes.generated.d.ts +5 -3
  312. package/dist/server/api-client-core/apis/crm/taxes.generated.js +58 -57
  313. package/dist/server/api-client-core/apis/crm/taxes.generated.js.map +1 -1
  314. package/dist/server/api-client-core/apis/crm/tickets-types.generated.d.ts +764 -790
  315. package/dist/server/api-client-core/apis/crm/tickets.generated.d.ts +5 -3
  316. package/dist/server/api-client-core/apis/crm/tickets.generated.js +59 -58
  317. package/dist/server/api-client-core/apis/crm/tickets.generated.js.map +1 -1
  318. package/dist/server/api-client-core/apis/crm/timeline-types.generated.d.ts +136 -149
  319. package/dist/server/api-client-core/apis/crm/timeline.generated.d.ts +4 -3
  320. package/dist/server/api-client-core/apis/crm/timeline.generated.js +5 -6
  321. package/dist/server/api-client-core/apis/crm/timeline.generated.js.map +1 -1
  322. package/dist/server/api-client-core/apis/crm/transcriptions-types.generated.d.ts +104 -117
  323. package/dist/server/api-client-core/apis/crm/transcriptions.generated.d.ts +4 -3
  324. package/dist/server/api-client-core/apis/crm/transcriptions.generated.js +7 -10
  325. package/dist/server/api-client-core/apis/crm/transcriptions.generated.js.map +1 -1
  326. package/dist/server/api-client-core/apis/crm/users-types.generated.d.ts +747 -761
  327. package/dist/server/api-client-core/apis/crm/users.generated.d.ts +5 -3
  328. package/dist/server/api-client-core/apis/crm/users.generated.js +58 -57
  329. package/dist/server/api-client-core/apis/crm/users.generated.js.map +1 -1
  330. package/dist/server/api-client-core/apis/crm/video-conferencing-extension-types.generated.d.ts +28 -40
  331. package/dist/server/api-client-core/apis/crm/video-conferencing-extension.generated.d.ts +3 -3
  332. package/dist/server/api-client-core/apis/crm/video-conferencing-extension.generated.js +4 -3
  333. package/dist/server/api-client-core/apis/crm/video-conferencing-extension.generated.js.map +1 -1
  334. package/dist/server/api-client-core/apis/events/manage-event-definitions-types.generated.d.ts +909 -945
  335. package/dist/server/api-client-core/apis/events/manage-event-definitions.generated.d.ts +3 -3
  336. package/dist/server/api-client-core/apis/events/manage-event-definitions.generated.js +29 -30
  337. package/dist/server/api-client-core/apis/events/manage-event-definitions.generated.js.map +1 -1
  338. package/dist/server/api-client-core/apis/events/send-event-completions-types.generated.d.ts +49 -62
  339. package/dist/server/api-client-core/apis/events/send-event-completions.generated.d.ts +4 -3
  340. package/dist/server/api-client-core/apis/events/send-event-completions.generated.js +4 -5
  341. package/dist/server/api-client-core/apis/events/send-event-completions.generated.js.map +1 -1
  342. package/dist/server/api-client-core/apis/events-types.generated.d.ts +99 -111
  343. package/dist/server/api-client-core/apis/events.generated.d.ts +3 -3
  344. package/dist/server/api-client-core/apis/events.generated.js +4 -3
  345. package/dist/server/api-client-core/apis/events.generated.js.map +1 -1
  346. package/dist/server/api-client-core/apis/files-types.generated.d.ts +636 -649
  347. package/dist/server/api-client-core/apis/files.generated.d.ts +4 -3
  348. package/dist/server/api-client-core/apis/files.generated.js +112 -113
  349. package/dist/server/api-client-core/apis/files.generated.js.map +1 -1
  350. package/dist/server/api-client-core/apis/marketing/campaigns-public-api-types.generated.d.ts +799 -816
  351. package/dist/server/api-client-core/apis/marketing/campaigns-public-api.generated.d.ts +8 -3
  352. package/dist/server/api-client-core/apis/marketing/campaigns-public-api.generated.js +126 -127
  353. package/dist/server/api-client-core/apis/marketing/campaigns-public-api.generated.js.map +1 -1
  354. package/dist/server/api-client-core/apis/marketing/marketing-emails-types.generated.d.ts +745 -769
  355. package/dist/server/api-client-core/apis/marketing/marketing-emails.generated.d.ts +3 -3
  356. package/dist/server/api-client-core/apis/marketing/marketing-emails.generated.js +100 -103
  357. package/dist/server/api-client-core/apis/marketing/marketing-emails.generated.js.map +1 -1
  358. package/dist/server/api-client-core/apis/marketing/marketing-events-types.generated.d.ts +1504 -1546
  359. package/dist/server/api-client-core/apis/marketing/marketing-events.generated.d.ts +9 -3
  360. package/dist/server/api-client-core/apis/marketing/marketing-events.generated.js +162 -167
  361. package/dist/server/api-client-core/apis/marketing/marketing-events.generated.js.map +1 -1
  362. package/dist/server/api-client-core/apis/marketing/single-send-types.generated.d.ts +91 -103
  363. package/dist/server/api-client-core/apis/marketing/single-send.generated.d.ts +3 -3
  364. package/dist/server/api-client-core/apis/marketing/single-send.generated.js +3 -2
  365. package/dist/server/api-client-core/apis/marketing/single-send.generated.js.map +1 -1
  366. package/dist/server/api-client-core/apis/marketing/transactional-single-send-types.generated.d.ts +187 -200
  367. package/dist/server/api-client-core/apis/marketing/transactional-single-send.generated.d.ts +4 -3
  368. package/dist/server/api-client-core/apis/marketing/transactional-single-send.generated.js +14 -15
  369. package/dist/server/api-client-core/apis/marketing/transactional-single-send.generated.js.map +1 -1
  370. package/dist/server/api-client-core/apis/meta/origins-types.generated.d.ts +41 -53
  371. package/dist/server/api-client-core/apis/meta/origins.generated.d.ts +3 -3
  372. package/dist/server/api-client-core/apis/meta/origins.generated.js +4 -3
  373. package/dist/server/api-client-core/apis/meta/origins.generated.js.map +1 -1
  374. package/dist/server/api-client-core/apis/scheduler/meetings-types.generated.d.ts +850 -863
  375. package/dist/server/api-client-core/apis/scheduler/meetings.generated.d.ts +4 -3
  376. package/dist/server/api-client-core/apis/scheduler/meetings.generated.js +28 -29
  377. package/dist/server/api-client-core/apis/scheduler/meetings.generated.js.map +1 -1
  378. package/dist/server/api-client-core/apis/settings/multicurrency-types.generated.d.ts +281 -296
  379. package/dist/server/api-client-core/apis/settings/multicurrency.generated.d.ts +6 -3
  380. package/dist/server/api-client-core/apis/settings/multicurrency.generated.js +32 -33
  381. package/dist/server/api-client-core/apis/settings/multicurrency.generated.js.map +1 -1
  382. package/dist/server/api-client-core/apis/settings/tax-rates-types.generated.d.ts +71 -83
  383. package/dist/server/api-client-core/apis/settings/tax-rates.generated.d.ts +3 -3
  384. package/dist/server/api-client-core/apis/settings/tax-rates.generated.js +4 -3
  385. package/dist/server/api-client-core/apis/settings/tax-rates.generated.js.map +1 -1
  386. package/dist/server/api-client-core/apis/settings/user-provisioning-types.generated.d.ts +202 -250
  387. package/dist/server/api-client-core/apis/settings/user-provisioning.generated.d.ts +3 -3
  388. package/dist/server/api-client-core/apis/settings/user-provisioning.generated.js +23 -26
  389. package/dist/server/api-client-core/apis/settings/user-provisioning.generated.js.map +1 -1
  390. package/dist/server/api-client-core/apis/webhooks-journal-types.generated.d.ts +490 -526
  391. package/dist/server/api-client-core/apis/webhooks-journal.generated.d.ts +3 -3
  392. package/dist/server/api-client-core/apis/webhooks-journal.generated.js +65 -70
  393. package/dist/server/api-client-core/apis/webhooks-journal.generated.js.map +1 -1
  394. package/dist/server/api-client-core/apis/webhooks-types.generated.d.ts +816 -852
  395. package/dist/server/api-client-core/apis/webhooks.generated.d.ts +3 -3
  396. package/dist/server/api-client-core/apis/webhooks.generated.js +93 -98
  397. package/dist/server/api-client-core/apis/webhooks.generated.js.map +1 -1
  398. package/dist/server/api-client-core/binary-data.js.map +1 -1
  399. package/dist/server/api-client-core/client.js +5 -1
  400. package/dist/server/api-client-core/client.js.map +1 -1
  401. package/dist/server/api-client-core/codegen-helpers/file-op-wrappers.js.map +1 -1
  402. package/dist/server/api-client-core/errors.js.map +1 -1
  403. package/dist/server/api-client-core/op.js.map +1 -1
  404. package/dist/server/api-client-core/pagination.d.ts +2 -2
  405. package/dist/server/api-client-core/pagination.js +2 -2
  406. package/dist/server/api-client-core/pagination.js.map +1 -1
  407. package/dist/server/api-client-core/plugins/fetch-transport.js +33 -9
  408. package/dist/server/api-client-core/plugins/fetch-transport.js.map +1 -1
  409. package/dist/server/api-client-core/types.d.ts +1 -1
  410. package/dist/server/api-client.d.ts +184 -184
  411. package/dist/server/api-client.js +89 -89
  412. package/dist/server/constants.js +33 -6
  413. package/dist/server/constants.js.map +1 -1
  414. package/dist/server/deno/start.js.map +1 -1
  415. package/dist/server/hono/hono-request-handler.js +32 -23
  416. package/dist/server/hono/hono-request-handler.js.map +1 -1
  417. package/dist/server/hono/hubspot-connect-routes/auth-complete.js +155 -0
  418. package/dist/server/hono/hubspot-connect-routes/auth-complete.js.map +1 -0
  419. package/dist/server/hono/hubspot-connect-routes/auth-init-session.js +25 -12
  420. package/dist/server/hono/hubspot-connect-routes/auth-init-session.js.map +1 -1
  421. package/dist/server/hono/hubspot-connect-routes/auth-logout.js +32 -9
  422. package/dist/server/hono/hubspot-connect-routes/auth-logout.js.map +1 -1
  423. package/dist/server/hono/hubspot-connect-routes/auth-refresh.js +32 -18
  424. package/dist/server/hono/hubspot-connect-routes/auth-refresh.js.map +1 -1
  425. package/dist/server/hono/hubspot-connect-routes/cimd-client-metadata-types.js.map +1 -1
  426. package/dist/server/hono/hubspot-connect-routes/cimd-public-routes.js +4 -1
  427. package/dist/server/hono/hubspot-connect-routes/cimd-public-routes.js.map +1 -1
  428. package/dist/server/hono/hubspot-connect-routes/fetch-hubspot-client-metadata.js.map +1 -1
  429. package/dist/server/hono/hubspot-connect-routes/hubspot-connect-routes.js +4 -2
  430. package/dist/server/hono/hubspot-connect-routes/hubspot-connect-routes.js.map +1 -1
  431. package/dist/server/hono/hubspot-connect-routes/load-hubspot-connect-routes-env.js +5 -5
  432. package/dist/server/hono/hubspot-connect-routes/load-hubspot-connect-routes-env.js.map +1 -1
  433. package/dist/server/hono/hubspot-connect-routes/oauth-client.js.map +1 -1
  434. package/dist/server/hono/hubspot-connect-routes/utils.js +53 -6
  435. package/dist/server/hono/hubspot-connect-routes/utils.js.map +1 -1
  436. package/dist/server/hono/types.d.ts +9 -10
  437. package/dist/server/hono/utils/cookie-utils.js +2 -1
  438. package/dist/server/hono/utils/cookie-utils.js.map +1 -1
  439. package/dist/server/hono/utils/cors-middleware.js +85 -0
  440. package/dist/server/hono/utils/cors-middleware.js.map +1 -0
  441. package/dist/server/import-app-keys.js.map +1 -1
  442. package/dist/server/lovable/create-app-function-start.d.ts +1 -1
  443. package/dist/server/lovable/create-app-function-start.js +4 -6
  444. package/dist/server/lovable/create-app-function-start.js.map +1 -1
  445. package/dist/server/lovable/hubspot-connect/index.js.map +1 -1
  446. package/dist/server/lovable/hubspot-connect/run-hubspot-connect-lovable-server.js +14 -15
  447. package/dist/server/lovable/hubspot-connect/run-hubspot-connect-lovable-server.js.map +1 -1
  448. package/dist/server/sanitize-request.js +14 -11
  449. package/dist/server/sanitize-request.js.map +1 -1
  450. package/dist/server/secure-start-core.js +4 -5
  451. package/dist/server/secure-start-core.js.map +1 -1
  452. package/dist/server/shared/constants.js +22 -9
  453. package/dist/server/shared/constants.js.map +1 -1
  454. package/dist/server/shared/encoding/base64.js.map +1 -1
  455. package/dist/server/shared/encoding/sha256.js.map +1 -1
  456. package/dist/server/shared/logger.js.map +1 -1
  457. package/dist/server/types.d.ts +1 -35
  458. package/dist/server/utils/cookie-utils.js.map +1 -1
  459. package/dist/server/utils/dpop-utils.js.map +1 -1
  460. package/dist/server/utils/env-utils.js +60 -7
  461. package/dist/server/utils/env-utils.js.map +1 -1
  462. package/dist/server/utils/hubspot-dpop-auth-headers.js +38 -0
  463. package/dist/server/utils/hubspot-dpop-auth-headers.js.map +1 -0
  464. package/dist/server/utils/jwk-utils.js.map +1 -1
  465. package/dist/server/utils/jwt-utils.js.map +1 -1
  466. package/package.json +16 -22
  467. package/src/browser/app-connect-controller/README.md +5 -2
  468. package/src/browser/app-connect-controller/connect-start.test.ts +156 -0
  469. package/src/browser/app-connect-controller/connect-start.ts +18 -3
  470. package/src/browser/app-connect-controller/disconnect.ts +4 -7
  471. package/src/browser/app-connect-controller/init.test.ts +260 -0
  472. package/src/browser/app-connect-controller/init.ts +44 -19
  473. package/src/browser/app-connect-controller/oauth-complete.test.ts +106 -0
  474. package/src/browser/app-connect-controller/oauth-complete.ts +53 -0
  475. package/src/browser/app-connect-controller/oauth-popup.test.ts +238 -0
  476. package/src/browser/app-connect-controller/oauth-popup.ts +160 -0
  477. package/src/browser/app-connect-controller/utils/iframe-utils.ts +12 -0
  478. package/src/browser/app-connect-controller/utils/resolve-oauth-connect-mode.test.ts +35 -0
  479. package/src/browser/app-connect-controller/utils/resolve-oauth-connect-mode.ts +21 -0
  480. package/src/browser/index.ts +1 -0
  481. package/src/browser/react/components/AppConnectHeader/AppConnectHeader.tsx +3 -5
  482. package/src/browser/react/components/ConnectButton/ConnectButton.tsx +1 -1
  483. package/src/browser/react/lovable/LovableHubSpotAppConnect.tsx +12 -2
  484. package/src/browser/types.ts +21 -5
  485. package/src/server/api-client-core/__tests__/errors.test.ts +309 -0
  486. package/src/server/api-client-core/__tests__/operation-headers.test.ts +251 -0
  487. package/src/server/api-client-core/apis/account/account-info-types.generated.ts +74 -88
  488. package/src/server/api-client-core/apis/account/account-info.generated.ts +2 -4
  489. package/src/server/api-client-core/apis/account/audit-logs-types.generated.ts +346 -360
  490. package/src/server/api-client-core/apis/account/audit-logs.generated.ts +2 -4
  491. package/src/server/api-client-core/apis/auth/oauth-types.generated.ts +81 -99
  492. package/src/server/api-client-core/apis/auth/oauth.generated.ts +1 -3
  493. package/src/server/api-client-core/apis/automation/actions-types.generated.ts +1162 -1188
  494. package/src/server/api-client-core/apis/automation/actions.generated.ts +10 -12
  495. package/src/server/api-client-core/apis/automation/sequences-types.generated.ts +379 -393
  496. package/src/server/api-client-core/apis/automation/sequences.generated.ts +1 -3
  497. package/src/server/api-client-core/apis/business-units-types.generated.ts +43 -59
  498. package/src/server/api-client-core/apis/business-units.generated.ts +9 -10
  499. package/src/server/api-client-core/apis/cms/authors-types.generated.ts +3823 -3853
  500. package/src/server/api-client-core/apis/cms/authors.generated.ts +31 -37
  501. package/src/server/api-client-core/apis/cms/blog-settings-types.generated.ts +3667 -3696
  502. package/src/server/api-client-core/apis/cms/blog-settings.generated.ts +46 -51
  503. package/src/server/api-client-core/apis/cms/cms-content-audit-types.generated.ts +138 -163
  504. package/src/server/api-client-core/apis/cms/cms-content-audit.generated.ts +2 -10
  505. package/src/server/api-client-core/apis/cms/domains-types.generated.ts +153 -167
  506. package/src/server/api-client-core/apis/cms/domains.generated.ts +2 -4
  507. package/src/server/api-client-core/apis/cms/hubdb-types.generated.ts +1013 -1063
  508. package/src/server/api-client-core/apis/cms/hubdb.generated.ts +3 -5
  509. package/src/server/api-client-core/apis/cms/media-bridge-types.generated.ts +8623 -8657
  510. package/src/server/api-client-core/apis/cms/media-bridge.generated.ts +16 -22
  511. package/src/server/api-client-core/apis/cms/pages-types.generated.ts +5259 -5272
  512. package/src/server/api-client-core/apis/cms/pages.generated.ts +262 -226
  513. package/src/server/api-client-core/apis/cms/posts-types.generated.ts +4420 -4438
  514. package/src/server/api-client-core/apis/cms/posts.generated.ts +108 -106
  515. package/src/server/api-client-core/apis/cms/site-search-types.generated.ts +1867 -1881
  516. package/src/server/api-client-core/apis/cms/site-search.generated.ts +2 -4
  517. package/src/server/api-client-core/apis/cms/source-code-types.generated.ts +144 -177
  518. package/src/server/api-client-core/apis/cms/source-code.generated.ts +15 -23
  519. package/src/server/api-client-core/apis/cms/tags-types.generated.ts +3820 -3845
  520. package/src/server/api-client-core/apis/cms/tags.generated.ts +80 -82
  521. package/src/server/api-client-core/apis/cms/url-mappings-types.generated.ts +188 -202
  522. package/src/server/api-client-core/apis/cms/url-mappings.generated.ts +2 -4
  523. package/src/server/api-client-core/apis/cms/url-redirects-types.generated.ts +182 -196
  524. package/src/server/api-client-core/apis/cms/url-redirects.generated.ts +2 -4
  525. package/src/server/api-client-core/apis/communication-preferences/subscriptions-types.generated.ts +810 -828
  526. package/src/server/api-client-core/apis/communication-preferences/subscriptions.generated.ts +66 -63
  527. package/src/server/api-client-core/apis/conversations/custom-channels-types.generated.ts +564 -601
  528. package/src/server/api-client-core/apis/conversations/custom-channels.generated.ts +90 -86
  529. package/src/server/api-client-core/apis/conversations/visitor-identification-types.generated.ts +31 -44
  530. package/src/server/api-client-core/apis/conversations/visitor-identification.generated.ts +6 -8
  531. package/src/server/api-client-core/apis/conversations-types.generated.ts +955 -991
  532. package/src/server/api-client-core/apis/conversations.generated.ts +6 -5
  533. package/src/server/api-client-core/apis/crm/app-uninstalls-types.generated.ts +7 -19
  534. package/src/server/api-client-core/apis/crm/app-uninstalls.generated.ts +2 -4
  535. package/src/server/api-client-core/apis/crm/appointments-types.generated.ts +965 -969
  536. package/src/server/api-client-core/apis/crm/appointments.generated.ts +143 -137
  537. package/src/server/api-client-core/apis/crm/associations-schema-types.generated.ts +292 -322
  538. package/src/server/api-client-core/apis/crm/associations-schema.generated.ts +17 -19
  539. package/src/server/api-client-core/apis/crm/associations-types.generated.ts +657 -675
  540. package/src/server/api-client-core/apis/crm/associations.generated.ts +70 -70
  541. package/src/server/api-client-core/apis/crm/calling-extensions-types.generated.ts +417 -441
  542. package/src/server/api-client-core/apis/crm/calling-extensions.generated.ts +62 -69
  543. package/src/server/api-client-core/apis/crm/calls-types.generated.ts +839 -856
  544. package/src/server/api-client-core/apis/crm/calls.generated.ts +42 -44
  545. package/src/server/api-client-core/apis/crm/carts-types.generated.ts +839 -856
  546. package/src/server/api-client-core/apis/crm/carts.generated.ts +42 -44
  547. package/src/server/api-client-core/apis/crm/commerce-payments-types.generated.ts +847 -856
  548. package/src/server/api-client-core/apis/crm/commerce-payments.generated.ts +73 -73
  549. package/src/server/api-client-core/apis/crm/commerce-subscriptions-types.generated.ts +844 -853
  550. package/src/server/api-client-core/apis/crm/commerce-subscriptions.generated.ts +50 -51
  551. package/src/server/api-client-core/apis/crm/communications-types.generated.ts +846 -856
  552. package/src/server/api-client-core/apis/crm/communications.generated.ts +73 -73
  553. package/src/server/api-client-core/apis/crm/companies-types.generated.ts +859 -885
  554. package/src/server/api-client-core/apis/crm/companies.generated.ts +44 -50
  555. package/src/server/api-client-core/apis/crm/contacts-types.generated.ts +875 -907
  556. package/src/server/api-client-core/apis/crm/contacts.generated.ts +46 -52
  557. package/src/server/api-client-core/apis/crm/contracts-types.generated.ts +894 -862
  558. package/src/server/api-client-core/apis/crm/contracts.generated.ts +66 -56
  559. package/src/server/api-client-core/apis/crm/courses-types.generated.ts +842 -859
  560. package/src/server/api-client-core/apis/crm/courses.generated.ts +42 -44
  561. package/src/server/api-client-core/apis/crm/crm-owners-types.generated.ts +102 -115
  562. package/src/server/api-client-core/apis/crm/crm-owners.generated.ts +2 -4
  563. package/src/server/api-client-core/apis/crm/custom-objects-types.generated.ts +900 -915
  564. package/src/server/api-client-core/apis/crm/custom-objects.generated.ts +128 -126
  565. package/src/server/api-client-core/apis/crm/deal-splits-types.generated.ts +157 -170
  566. package/src/server/api-client-core/apis/crm/deal-splits.generated.ts +2 -4
  567. package/src/server/api-client-core/apis/crm/deals-types.generated.ts +858 -875
  568. package/src/server/api-client-core/apis/crm/deals.generated.ts +42 -44
  569. package/src/server/api-client-core/apis/crm/discounts-types.generated.ts +842 -855
  570. package/src/server/api-client-core/apis/crm/discounts.generated.ts +42 -44
  571. package/src/server/api-client-core/apis/crm/emails-types.generated.ts +839 -856
  572. package/src/server/api-client-core/apis/crm/emails.generated.ts +42 -44
  573. package/src/server/api-client-core/apis/crm/exports-types.generated.ts +284 -314
  574. package/src/server/api-client-core/apis/crm/exports.generated.ts +6 -11
  575. package/src/server/api-client-core/apis/crm/feedback-submissions-types.generated.ts +607 -622
  576. package/src/server/api-client-core/apis/crm/feedback-submissions.generated.ts +84 -80
  577. package/src/server/api-client-core/apis/crm/fees-types.generated.ts +839 -856
  578. package/src/server/api-client-core/apis/crm/fees.generated.ts +42 -44
  579. package/src/server/api-client-core/apis/crm/goal-targets-types.generated.ts +845 -856
  580. package/src/server/api-client-core/apis/crm/goal-targets.generated.ts +50 -51
  581. package/src/server/api-client-core/apis/crm/imports-types.generated.ts +663 -692
  582. package/src/server/api-client-core/apis/crm/imports.generated.ts +2 -7
  583. package/src/server/api-client-core/apis/crm/invoices-types.generated.ts +839 -856
  584. package/src/server/api-client-core/apis/crm/invoices.generated.ts +42 -44
  585. package/src/server/api-client-core/apis/crm/leads-types.generated.ts +839 -856
  586. package/src/server/api-client-core/apis/crm/leads.generated.ts +42 -44
  587. package/src/server/api-client-core/apis/crm/limits-tracking-types.generated.ts +263 -275
  588. package/src/server/api-client-core/apis/crm/limits-tracking.generated.ts +2 -4
  589. package/src/server/api-client-core/apis/crm/line-items-types.generated.ts +843 -856
  590. package/src/server/api-client-core/apis/crm/line-items.generated.ts +42 -44
  591. package/src/server/api-client-core/apis/crm/listings-types.generated.ts +842 -859
  592. package/src/server/api-client-core/apis/crm/listings.generated.ts +42 -44
  593. package/src/server/api-client-core/apis/crm/lists-types.generated.ts +2794 -2845
  594. package/src/server/api-client-core/apis/crm/lists.generated.ts +8 -20
  595. package/src/server/api-client-core/apis/crm/meetings-types.generated.ts +839 -856
  596. package/src/server/api-client-core/apis/crm/meetings.generated.ts +42 -44
  597. package/src/server/api-client-core/apis/crm/notes-types.generated.ts +839 -856
  598. package/src/server/api-client-core/apis/crm/notes.generated.ts +42 -44
  599. package/src/server/api-client-core/apis/crm/object-library-types.generated.ts +26 -39
  600. package/src/server/api-client-core/apis/crm/object-library.generated.ts +2 -4
  601. package/src/server/api-client-core/apis/crm/objects-types.generated.ts +688 -716
  602. package/src/server/api-client-core/apis/crm/objects.generated.ts +79 -83
  603. package/src/server/api-client-core/apis/crm/orders-types.generated.ts +829 -846
  604. package/src/server/api-client-core/apis/crm/orders.generated.ts +45 -47
  605. package/src/server/api-client-core/apis/crm/partner-clients-types.generated.ts +721 -735
  606. package/src/server/api-client-core/apis/crm/partner-clients.generated.ts +60 -60
  607. package/src/server/api-client-core/apis/crm/partner-services-types.generated.ts +720 -734
  608. package/src/server/api-client-core/apis/crm/partner-services.generated.ts +60 -60
  609. package/src/server/api-client-core/apis/crm/pipelines-types.generated.ts +366 -388
  610. package/src/server/api-client-core/apis/crm/pipelines.generated.ts +2 -4
  611. package/src/server/api-client-core/apis/crm/postal-mail-types.generated.ts +830 -843
  612. package/src/server/api-client-core/apis/crm/postal-mail.generated.ts +45 -47
  613. package/src/server/api-client-core/apis/crm/products-types.generated.ts +829 -846
  614. package/src/server/api-client-core/apis/crm/products.generated.ts +45 -47
  615. package/src/server/api-client-core/apis/crm/projects-types.generated.ts +845 -875
  616. package/src/server/api-client-core/apis/crm/projects.generated.ts +47 -53
  617. package/src/server/api-client-core/apis/crm/properties-types.generated.ts +623 -626
  618. package/src/server/api-client-core/apis/crm/properties.generated.ts +33 -28
  619. package/src/server/api-client-core/apis/crm/property-validations-types.generated.ts +160 -174
  620. package/src/server/api-client-core/apis/crm/property-validations.generated.ts +2 -6
  621. package/src/server/api-client-core/apis/crm/public-app-crm-cards-types.generated.ts +467 -494
  622. package/src/server/api-client-core/apis/crm/public-app-crm-cards.generated.ts +7 -15
  623. package/src/server/api-client-core/apis/crm/public-app-feature-flags-types.generated.ts +166 -177
  624. package/src/server/api-client-core/apis/crm/public-app-feature-flags.generated.ts +6 -8
  625. package/src/server/api-client-core/apis/crm/quotes-types.generated.ts +829 -846
  626. package/src/server/api-client-core/apis/crm/quotes.generated.ts +45 -47
  627. package/src/server/api-client-core/apis/crm/schemas-types.generated.ts +613 -640
  628. package/src/server/api-client-core/apis/crm/schemas.generated.ts +8 -14
  629. package/src/server/api-client-core/apis/crm/services-types.generated.ts +832 -849
  630. package/src/server/api-client-core/apis/crm/services.generated.ts +45 -47
  631. package/src/server/api-client-core/apis/crm/tasks-types.generated.ts +829 -846
  632. package/src/server/api-client-core/apis/crm/tasks.generated.ts +45 -47
  633. package/src/server/api-client-core/apis/crm/taxes-types.generated.ts +829 -846
  634. package/src/server/api-client-core/apis/crm/taxes.generated.ts +45 -47
  635. package/src/server/api-client-core/apis/crm/tickets-types.generated.ts +848 -878
  636. package/src/server/api-client-core/apis/crm/tickets.generated.ts +47 -53
  637. package/src/server/api-client-core/apis/crm/timeline-types.generated.ts +144 -161
  638. package/src/server/api-client-core/apis/crm/timeline.generated.ts +6 -8
  639. package/src/server/api-client-core/apis/crm/transcriptions-types.generated.ts +149 -164
  640. package/src/server/api-client-core/apis/crm/transcriptions.generated.ts +22 -22
  641. package/src/server/api-client-core/apis/crm/users-types.generated.ts +829 -846
  642. package/src/server/api-client-core/apis/crm/users.generated.ts +45 -47
  643. package/src/server/api-client-core/apis/crm/video-conferencing-extension-types.generated.ts +29 -42
  644. package/src/server/api-client-core/apis/crm/video-conferencing-extension.generated.ts +17 -19
  645. package/src/server/api-client-core/apis/events/manage-event-definitions-types.generated.ts +1509 -1558
  646. package/src/server/api-client-core/apis/events/manage-event-definitions.generated.ts +55 -65
  647. package/src/server/api-client-core/apis/events/send-event-completions-types.generated.ts +51 -68
  648. package/src/server/api-client-core/apis/events/send-event-completions.generated.ts +10 -10
  649. package/src/server/api-client-core/apis/events-types.generated.ts +97 -110
  650. package/src/server/api-client-core/apis/events.generated.ts +2 -4
  651. package/src/server/api-client-core/apis/files-types.generated.ts +727 -757
  652. package/src/server/api-client-core/apis/files.generated.ts +3 -5
  653. package/src/server/api-client-core/apis/marketing/campaigns-public-api-types.generated.ts +1221 -1234
  654. package/src/server/api-client-core/apis/marketing/campaigns-public-api.generated.ts +45 -47
  655. package/src/server/api-client-core/apis/marketing/marketing-emails-types.generated.ts +3704 -3733
  656. package/src/server/api-client-core/apis/marketing/marketing-emails.generated.ts +44 -52
  657. package/src/server/api-client-core/apis/marketing/marketing-events-types.generated.ts +1787 -1848
  658. package/src/server/api-client-core/apis/marketing/marketing-events.generated.ts +236 -241
  659. package/src/server/api-client-core/apis/marketing/single-send-types.generated.ts +142 -155
  660. package/src/server/api-client-core/apis/marketing/single-send.generated.ts +2 -6
  661. package/src/server/api-client-core/apis/marketing/transactional-single-send-types.generated.ts +253 -269
  662. package/src/server/api-client-core/apis/marketing/transactional-single-send.generated.ts +32 -31
  663. package/src/server/api-client-core/apis/meta/origins-types.generated.ts +40 -56
  664. package/src/server/api-client-core/apis/meta/origins.generated.ts +2 -4
  665. package/src/server/api-client-core/apis/scheduler/meetings-types.generated.ts +1001 -1014
  666. package/src/server/api-client-core/apis/scheduler/meetings.generated.ts +6 -8
  667. package/src/server/api-client-core/apis/settings/multicurrency-types.generated.ts +1906 -1912
  668. package/src/server/api-client-core/apis/settings/multicurrency.generated.ts +64 -63
  669. package/src/server/api-client-core/apis/settings/tax-rates-types.generated.ts +71 -85
  670. package/src/server/api-client-core/apis/settings/tax-rates.generated.ts +2 -4
  671. package/src/server/api-client-core/apis/settings/user-provisioning-types.generated.ts +207 -257
  672. package/src/server/api-client-core/apis/settings/user-provisioning.generated.ts +8 -24
  673. package/src/server/api-client-core/apis/webhooks-journal-types.generated.ts +740 -771
  674. package/src/server/api-client-core/apis/webhooks-journal.generated.ts +47 -59
  675. package/src/server/api-client-core/apis/webhooks-types.generated.ts +1194 -1228
  676. package/src/server/api-client-core/apis/webhooks.generated.ts +52 -64
  677. package/src/server/api-client-core/client.ts +5 -1
  678. package/src/server/api-client-core/pagination.ts +2 -2
  679. package/src/server/api-client-core/plugins/fetch-transport.ts +70 -12
  680. package/src/server/api-client-core/types.ts +1 -1
  681. package/src/server/constants.ts +29 -4
  682. package/src/server/hono/hono-request-handler.ts +68 -27
  683. package/src/server/hono/hubspot-connect-routes/auth-complete.test.ts +285 -0
  684. package/src/server/hono/hubspot-connect-routes/{auth-callback.ts → auth-complete.ts} +74 -30
  685. package/src/server/hono/hubspot-connect-routes/auth-init-session.test.ts +114 -30
  686. package/src/server/hono/hubspot-connect-routes/auth-init-session.ts +35 -10
  687. package/src/server/hono/hubspot-connect-routes/auth-logout.test.ts +13 -0
  688. package/src/server/hono/hubspot-connect-routes/auth-logout.ts +39 -10
  689. package/src/server/hono/hubspot-connect-routes/auth-refresh.test.ts +6 -0
  690. package/src/server/hono/hubspot-connect-routes/auth-refresh.ts +24 -9
  691. package/src/server/hono/hubspot-connect-routes/cimd-public-routes.test.ts +7 -6
  692. package/src/server/hono/hubspot-connect-routes/cimd-public-routes.ts +5 -1
  693. package/src/server/hono/hubspot-connect-routes/hubspot-connect-routes.ts +11 -3
  694. package/src/server/hono/hubspot-connect-routes/load-hubspot-connect-routes-env.test.ts +17 -24
  695. package/src/server/hono/hubspot-connect-routes/load-hubspot-connect-routes-env.ts +8 -8
  696. package/src/server/hono/hubspot-connect-routes/utils.test.ts +16 -46
  697. package/src/server/hono/hubspot-connect-routes/utils.ts +61 -5
  698. package/src/server/hono/types.ts +11 -10
  699. package/src/server/hono/utils/cookie-utils.ts +27 -2
  700. package/src/server/hono/utils/cors-middleware.test.ts +80 -0
  701. package/src/server/hono/utils/cors-middleware.ts +95 -0
  702. package/src/server/lovable/create-app-function-start.ts +4 -7
  703. package/src/server/lovable/hubspot-connect/run-hubspot-connect-lovable-server.ts +21 -16
  704. package/src/server/sanitize-request.ts +15 -12
  705. package/src/server/secure-start-core.ts +7 -6
  706. package/src/server/types.ts +2 -38
  707. package/src/server/utils/env-utils.test.ts +140 -12
  708. package/src/server/utils/env-utils.ts +80 -6
  709. package/src/server/utils/hubspot-dpop-auth-headers.test.ts +43 -0
  710. package/src/server/utils/hubspot-dpop-auth-headers.ts +48 -0
  711. package/src/shared/constants.ts +40 -3
  712. package/src/shared/wire-types.ts +19 -0
  713. package/dist/browser/HubSpotAppConnect-BW45gyDs.js.map +0 -1
  714. package/dist/browser/create-vctOhpX9.js.map +0 -1
  715. package/dist/server/hono/hubspot-connect-routes/auth-callback.js +0 -125
  716. package/dist/server/hono/hubspot-connect-routes/auth-callback.js.map +0 -1
  717. package/dist/server/proxy.js +0 -68
  718. package/dist/server/proxy.js.map +0 -1
  719. package/src/server/hono/hubspot-connect-routes/auth-callback.test.ts +0 -225
  720. package/src/server/proxy.test.ts +0 -80
  721. package/src/server/proxy.ts +0 -116
@@ -1,2265 +1,2229 @@
1
1
  import { Operation } from "../../types.js";
2
2
 
3
3
  //#region src/server/api-client-core/apis/crm/lists-types.generated.d.ts
4
- declare namespace CRMLists {
5
- namespace Basic {
6
- interface AddAndRemoveMembershipsInput {
7
- data: Schemas.MembershipChangeRequest;
8
- listId: string;
9
- }
10
- type AddAndRemoveMembershipsOutput = Schemas.MembershipsUpdateResponse;
11
- interface AddMembershipsFromInput {
12
- listId: string;
13
- sourceListId: string;
14
- }
15
- type AddMembershipsFromOutput = void;
16
- interface AddMembershipsInput {
17
- data: string[];
18
- listId: string;
19
- }
20
- type AddMembershipsOutput = Schemas.MembershipsUpdateResponse;
21
- type CreateFolderInput = Schemas.ListFolderCreateRequest;
22
- type CreateFolderOutput = Schemas.ListFolderCreateResponse;
23
- type CreateIdMappingInput = string[];
24
- type CreateIdMappingOutput = Schemas.PublicBatchMigrationMapping;
25
- type CreateInput = Schemas.ListCreateRequest;
26
- type CreateOutput = Schemas.ListCreateResponse;
27
- interface DeleteFolderInput {
28
- folderId: string;
29
- }
30
- type DeleteFolderOutput = void;
31
- interface DeleteInput {
32
- listId: string;
33
- }
34
- interface DeleteMembershipsInput {
35
- listId: string;
36
- }
37
- type DeleteMembershipsOutput = void;
38
- type DeleteOutput = void;
39
- interface GetByObjectTypeAndNameInput {
40
- includeFilters?: boolean;
41
- listName: string;
42
- objectTypeId: string;
43
- }
44
- type GetByObjectTypeAndNameOutput = Schemas.ListFetchResponse;
45
- interface GetIdMappingInput {
46
- legacyListId?: string;
47
- }
48
- type GetIdMappingOutput = Schemas.PublicMigrationMapping;
49
- interface GetInput {
50
- includeFilters?: boolean;
51
- listId: string;
52
- }
53
- interface GetMembershipsJoinOrderInput {
54
- /**
55
- * 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.
56
- */
57
- after?: string;
58
- before?: string;
59
- /**
60
- * The maximum number of results to display per page.
61
- */
62
- limit?: number;
63
- listId: string;
64
- }
65
- type GetMembershipsJoinOrderOutput = Schemas.ApiCollectionResponseJoinTimeAndRecordId;
66
- type GetOutput = Schemas.ListFetchResponse;
67
- interface GetRecordMembershipsInput {
68
- objectTypeId: string;
69
- recordId: string;
70
- }
71
- type GetRecordMembershipsOutput = Schemas.ApiCollectionResponseRecordListMembership;
72
- interface GetScheduleConversionInput {
73
- listId: string;
74
- }
75
- type GetScheduleConversionOutput = Schemas.PublicListConversionResponse;
76
- interface GetSizeAndEditsHistoryBetweenInput {
77
- endDate?: string;
78
- listId: string;
79
- startDate?: string;
80
- }
81
- type GetSizeAndEditsHistoryBetweenOutput = Schemas.ListSizeAndEditHistoryResponse;
82
- interface ListFoldersInput {
83
- folderId?: string;
84
- }
85
- type ListFoldersOutput = Schemas.ListFolderFetchResponse;
86
- interface ListInput {
87
- includeFilters?: boolean;
88
- listIds?: string[];
89
- }
90
- interface ListMembershipsInput {
91
- /**
92
- * 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.
93
- */
94
- after?: string;
95
- before?: string;
96
- /**
97
- * The maximum number of results to display per page.
98
- */
99
- limit?: number;
100
- listId: string;
101
- }
102
- type ListMembershipsOutput = Schemas.ApiCollectionResponseJoinTimeAndRecordId;
103
- type ListOutput = Schemas.ListsByIdResponse;
104
- interface MoveFolderInput {
105
- folderId: string;
106
- newParentFolderId: string;
107
- }
108
- type MoveFolderOutput = Schemas.ListFolderFetchResponse;
109
- type MoveListInput = Schemas.ListMoveRequest;
110
- type MoveListOutput = void;
111
- interface RemoveMembershipsInput {
112
- data: string[];
113
- listId: string;
114
- }
115
- type RemoveMembershipsOutput = Schemas.MembershipsUpdateResponse;
116
- interface RenameFolderInput {
117
- folderId: string;
118
- newFolderName?: string;
119
- }
120
- type RenameFolderOutput = Schemas.ListFolderFetchResponse;
121
- interface RestoreInput {
122
- listId: string;
123
- }
124
- type RestoreOutput = void;
125
- interface ScheduleConversionInput {
126
- listId: string;
127
- }
128
- type ScheduleConversionOutput = void;
129
- interface UpdateListFiltersInput {
130
- data: Schemas.ListFilterUpdateRequest;
131
- enrollObjectsInWorkflows?: boolean;
132
- listId: string;
133
- }
134
- type UpdateListFiltersOutput = Schemas.ListUpdateResponse;
135
- interface UpdateListNameInput {
136
- includeFilters?: boolean;
137
- listId: string;
138
- listName?: string;
139
- }
140
- type UpdateListNameOutput = Schemas.ListUpdateResponse;
141
- interface UpdateScheduleConversionInput {
142
- data: Schemas.PublicListConversionTime;
143
- listId: string;
144
- }
145
- type UpdateScheduleConversionOutput = Schemas.PublicListConversionResponse;
146
- }
147
- namespace Batch {
148
- type BatchReadMembershipsInput = Schemas.BatchInputRecordIdInput;
149
- type BatchReadMembershipsOutput = Schemas.BatchResponseRecordIdWithMemberships;
150
- }
151
- namespace Schemas {
152
- interface ApiCollectionResponseJoinTimeAndRecordId {
153
- paging?: Schemas.Paging;
154
- results: Schemas.JoinTimeAndRecordId[];
155
- /**
156
- * The total number of records that match the query.
157
- */
158
- total?: number;
159
- }
160
- interface ApiCollectionResponseRecordListMembership {
161
- paging?: Schemas.Paging;
162
- results: Schemas.RecordListMembership[];
163
- total?: number;
164
- }
165
- interface BatchInputRecordIdInput {
166
- inputs: Schemas.RecordIdInput[];
167
- }
168
- interface BatchResponseRecordIdWithMemberships {
169
- completedAt: string;
170
- links?: Record<string, string>;
171
- requestedAt?: string;
172
- results: Schemas.RecordIdWithMemberships[];
173
- startedAt: string;
174
- status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
175
- }
176
- interface JoinTimeAndRecordId {
177
- /**
178
- * The date and time when the record was added to the list.
179
- */
180
- membershipTimestamp: string;
181
- /**
182
- * The unique identifier of the record.
183
- */
184
- recordId: string;
185
- }
186
- interface ListCreateRequest {
187
- /**
188
- * The list of custom properties to tie to the list. Custom property name is the key, the value is the value.
189
- */
190
- customProperties?: Record<string, string>;
191
- /**
192
- * Filter branch object containing filtering criteria for the list
193
- */
194
- filterBranch?: Schemas.PublicOrFilterBranch | Schemas.PublicAndFilterBranch | Schemas.PublicNotAllFilterBranch | Schemas.PublicNotAnyFilterBranch | Schemas.PublicRestrictedFilterBranch | Schemas.PublicUnifiedEventsFilterBranch | Schemas.PublicPropertyAssociationFilterBranch | Schemas.PublicAssociationFilterBranch;
195
- /**
196
- * The ID of the folder that the list should be created in. If left blank, then the list will be created in the root of the list folder structure.
197
- */
198
- listFolderId?: number;
199
- listPermissions?: Schemas.PublicListPermissions;
200
- membershipSettings?: Schemas.PublicMembershipSettings;
201
- /**
202
- * The name of the list, which must be globally unique across all public lists in the portal.
203
- */
204
- name: string;
205
- /**
206
- * The object type ID of the type of objects that the list will store.
207
- */
208
- objectTypeId: string;
209
- /**
210
- * The processing type of the list. One of: `SNAPSHOT`, `MANUAL`, or `DYNAMIC`.
211
- */
212
- processingType: string;
213
- }
214
- interface ListCreateResponse {
215
- list: Schemas.PublicObjectList;
216
- }
217
- interface ListFetchResponse {
218
- list: Schemas.PublicObjectList;
219
- }
220
- interface ListFilterUpdateRequest {
221
- /**
222
- * Updated filtering criteria for the list
223
- */
224
- filterBranch: Schemas.PublicOrFilterBranch | Schemas.PublicAndFilterBranch | Schemas.PublicNotAllFilterBranch | Schemas.PublicNotAnyFilterBranch | Schemas.PublicRestrictedFilterBranch | Schemas.PublicUnifiedEventsFilterBranch | Schemas.PublicPropertyAssociationFilterBranch | Schemas.PublicAssociationFilterBranch;
225
- }
226
- interface ListFolderCreateRequest {
227
- /**
228
- * The name of the folder to be created.
229
- */
230
- name: string;
231
- /**
232
- * The folder this should be created in, if not specified will be created in the root folder 0.
233
- */
234
- parentFolderId?: string;
235
- }
236
- interface ListFolderCreateResponse {
237
- folder: Schemas.PublicListFolder;
238
- }
239
- interface ListFolderFetchResponse {
240
- folder: Schemas.PublicListFolder;
241
- }
242
- interface ListMoveRequest {
243
- /**
244
- * The Id of the list to move.
245
- */
246
- listId: string;
247
- /**
248
- * The Id of folder to move the list to, the root folder is Id 0.
249
- */
250
- newFolderId: string;
251
- }
252
- interface ListsByIdResponse {
253
- /**
254
- * The object list definitions.
255
- */
256
- lists: Schemas.PublicObjectList[];
257
- }
258
- interface ListSearchRequest {
259
- /**
260
- * The property names of any additional list properties to include in the response. Properties that do not exist or that are empty for a particular list are not included in the response.
261
- *
262
- * By default, all requests will fetch the following properties for each list: `hs_list_size`, `hs_last_record_added_at`, `hs_last_record_removed_at`, `hs_folder_name`, and `hs_list_reference_count`.
263
- */
264
- additionalProperties: string[];
265
- /**
266
- * The number of lists to include in the response. Defaults to `20` if no value is provided. The max `count` is `500`.
267
- */
268
- count?: number;
269
- /**
270
- * ILS list ids to be included in search results. If not specified, all lists matching other criteria will be included
271
- */
272
- listIds: string[];
273
- objectTypeId?: string;
274
- /**
275
- * Value used to paginate through lists. The `offset` provided in the response can be used in the next request to fetch the next page of results. Defaults to `0` if no offset is provided.
276
- */
277
- offset: number;
278
- /**
279
- * List processing types to be included in search results. If not specified, all lists with all processing types will be included.
280
- */
281
- processingTypes: string[];
282
- /**
283
- * The `query` that will be used to search for lists by list name. If no `query` is provided, then the results will include all lists.
284
- */
285
- query?: string;
286
- /**
287
- * Sort field and order
288
- */
289
- sort?: string;
290
- }
291
- interface ListSearchResponse {
292
- /**
293
- * Whether or not there are more results to page through.
294
- */
295
- hasMore: boolean;
296
- /**
297
- * The lists that matched the search criteria.
298
- */
299
- lists: Schemas.PublicObjectListSearchResult[];
300
- /**
301
- * Value to be passed in a future request to paginate through list search results.
302
- */
303
- offset: number;
304
- /**
305
- * The total number of lists that match the search criteria.
306
- */
307
- total: number;
308
- }
309
- interface ListSizeAndEditHistoryResponse {
310
- editHistory: string[];
311
- sizeHistory: Schemas.ListSizeDataPoint[];
312
- }
313
- interface ListSizeDataPoint {
314
- size: number;
315
- timestamp: string;
316
- }
317
- interface ListUpdateResponse {
318
- updatedList?: Schemas.PublicObjectList;
319
- }
320
- interface MembershipChangeRequest {
321
- recordIdsToAdd: string[];
322
- recordIdsToRemove: string[];
323
- }
324
- interface MembershipsUpdateResponse {
325
- /**
326
- * The IDs of the records that were `missing` (e.g. did not exist in the portal) and so were not `added` or `removed`.
327
- */
328
- recordIdsMissing: string[];
329
- /**
330
- * The IDs of the records that were `removed` from the list.
331
- */
332
- recordIdsRemoved: string[];
333
- recordsIdsAdded: string[];
334
- }
335
- /**
336
- * Specifies the paging information needed to retrieve the next set of results in a paginated API response
337
- */
338
- interface NextPage {
339
- /**
340
- * The offset for the next page of records.
341
- */
342
- after: string;
343
- /**
344
- * A direct link to the request for the next page of records.
345
- */
346
- link?: string;
347
- }
348
- interface Paging {
349
- next?: Schemas.NextPage;
350
- prev?: Schemas.PreviousPage;
351
- }
352
- /**
353
- * specifies the paging information needed to retrieve the previous set of results in a paginated API response
354
- */
355
- interface PreviousPage {
356
- /**
357
- * The offset of the previous page of records.
358
- */
359
- before: string;
360
- /**
361
- * A direct link to the request for the previous page of records.
362
- */
363
- link?: string;
364
- }
365
- interface PublicAbsoluteComparativeTimestampRefineBy {
366
- /**
367
- * Timestamp comparison options (BEFORE, AFTER)
368
- */
369
- comparison: string;
370
- /**
371
- * Timestamp to be used in refine by criteria
372
- */
373
- timestamp: number;
374
- /**
375
- * type of refine by criteria (ABSOLUTE_COMPARATIVE)
376
- */
377
- type: 'ABSOLUTE_COMPARATIVE';
378
- }
379
- interface PublicAbsoluteRangedTimestampRefineBy {
380
- /**
381
- * Lower range timestamp of refinement criteria
382
- */
383
- lowerTimestamp: number;
384
- /**
385
- * Type of range of refinement critaria (BETWEEN, NOT_BETWEEN)
386
- */
387
- rangeType: string;
388
- /**
389
- * type of refine by criteria (ABSOLUTE_RANGED)
390
- */
391
- type: 'ABSOLUTE_RANGED';
392
- /**
393
- * Upper range timestamp of refinement criteria
394
- */
395
- upperTimestamp: number;
396
- }
397
- interface PublicAdsSearchFilter {
398
- /**
399
- * Ad network (ADWORDS, FACEBOOK, LINKEDIN, ALL)
400
- */
401
- adNetwork: string;
402
- /**
403
- * Type of ad entity (KEYWORD, ADGROUP, AD, CAMPAIGN)
404
- */
405
- entityType: string;
406
- /**
407
- * Type of the filter (ADS_SEARCH)
408
- */
409
- filterType: 'ADS_SEARCH';
410
- /**
411
- * Operator to be applied (CONTAINS, IS_EQUAL_TO, ENDS_WITH, STARTS_WITH, IS_KNOWN)
412
- */
413
- operator: string;
414
- searchTerms: string[];
415
- /**
416
- * Search term to match an ad
417
- */
418
- searchTermType: string;
419
- }
420
- interface PublicAdsTimeFilter {
421
- /**
422
- * Filter type (ADS_TIME)
423
- */
424
- filterType: 'ADS_TIME';
425
- /**
426
- * Refinement criteria
427
- */
428
- pruningRefineBy: Schemas.PublicNumOccurrencesRefineBy | Schemas.PublicSetOccurrencesRefineBy | Schemas.PublicRelativeComparativeTimestampRefineBy | Schemas.PublicRelativeRangedTimestampRefineBy | Schemas.PublicAbsoluteComparativeTimestampRefineBy | Schemas.PublicAbsoluteRangedTimestampRefineBy | Schemas.PublicAllHistoryRefineBy | Schemas.PublicTimePointOperation | Schemas.PublicRangedTimeOperation;
429
- }
430
- interface PublicAllHistoryRefineBy {
431
- /**
432
- * Type of refine by (ALL_HISTORY)
433
- */
434
- type: 'ALL_HISTORY';
435
- }
436
- interface PublicAllPropertyTypesOperation {
437
- /**
438
- * Indication of whether objects with no value should be included
439
- */
440
- includeObjectsWithNoValueSet: boolean;
441
- /**
442
- * Type of operation (ALL_PROPERTY)
443
- */
444
- operationType: 'ALL_PROPERTY';
445
- /**
446
- * Operator to be applied (IS_KNOWN, IS_UNKNOWN)
447
- */
448
- operator: string;
449
- }
450
- interface PublicAndFilterBranch {
451
- filterBranches: (Schemas.PublicOrFilterBranch | Schemas.PublicAndFilterBranch | Schemas.PublicNotAllFilterBranch | Schemas.PublicNotAnyFilterBranch | Schemas.PublicRestrictedFilterBranch | Schemas.PublicUnifiedEventsFilterBranch | Schemas.PublicPropertyAssociationFilterBranch | Schemas.PublicAssociationFilterBranch)[];
452
- /**
453
- * Filter branch operator (AND)
454
- */
455
- filterBranchOperator: string;
456
- /**
457
- * Type of filter branch (AND)
458
- */
459
- filterBranchType: 'AND';
460
- filters: (Schemas.PublicPropertyFilter | Schemas.PublicAssociationInListFilter | Schemas.PublicPageViewAnalyticsFilter | Schemas.PublicCtaAnalyticsFilter | Schemas.PublicEventAnalyticsFilter | Schemas.PublicFormSubmissionFilter | Schemas.PublicFormSubmissionOnPageFilter | Schemas.PublicIntegrationEventFilter | Schemas.PublicEmailSubscriptionFilter | Schemas.PublicCommunicationSubscriptionFilter | Schemas.PublicCampaignInfluencedFilter | Schemas.PublicSurveyMonkeyFilter | Schemas.PublicSurveyMonkeyValueFilter | Schemas.PublicWebinarFilter | Schemas.PublicEmailEventFilter | Schemas.PublicPrivacyAnalyticsFilter | Schemas.PublicAdsSearchFilter | Schemas.PublicAdsTimeFilter | Schemas.PublicInListFilter | Schemas.PublicNumAssociationsFilter | Schemas.PublicUnifiedEventsFilter | Schemas.PublicPropertyAssociationInListFilter | Schemas.PublicConstantFilter)[];
461
- }
462
- interface PublicAssociationFilterBranch {
463
- /**
464
- * Specifies the category of the association for the filter branch (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK).
465
- */
466
- associationCategory: string;
467
- /**
468
- * Type id of the association
469
- */
470
- associationTypeId: number;
471
- filterBranches: (Schemas.PublicOrFilterBranch | Schemas.PublicAndFilterBranch | Schemas.PublicNotAllFilterBranch | Schemas.PublicNotAnyFilterBranch | Schemas.PublicRestrictedFilterBranch | Schemas.PublicUnifiedEventsFilterBranch | Schemas.PublicPropertyAssociationFilterBranch | Schemas.PublicAssociationFilterBranch)[];
472
- /**
473
- * Filter branch operator (AND)
474
- */
475
- filterBranchOperator: string;
476
- /**
477
- * Type of the filter branch (ASSOCIATION)
478
- */
479
- filterBranchType: 'ASSOCIATION';
480
- filters: (Schemas.PublicPropertyFilter | Schemas.PublicAssociationInListFilter | Schemas.PublicPageViewAnalyticsFilter | Schemas.PublicCtaAnalyticsFilter | Schemas.PublicEventAnalyticsFilter | Schemas.PublicFormSubmissionFilter | Schemas.PublicFormSubmissionOnPageFilter | Schemas.PublicIntegrationEventFilter | Schemas.PublicEmailSubscriptionFilter | Schemas.PublicCommunicationSubscriptionFilter | Schemas.PublicCampaignInfluencedFilter | Schemas.PublicSurveyMonkeyFilter | Schemas.PublicSurveyMonkeyValueFilter | Schemas.PublicWebinarFilter | Schemas.PublicEmailEventFilter | Schemas.PublicPrivacyAnalyticsFilter | Schemas.PublicAdsSearchFilter | Schemas.PublicAdsTimeFilter | Schemas.PublicInListFilter | Schemas.PublicNumAssociationsFilter | Schemas.PublicUnifiedEventsFilter | Schemas.PublicPropertyAssociationInListFilter | Schemas.PublicConstantFilter)[];
481
- /**
482
- * The ID representing the type of object associated with the filter branch.
483
- */
484
- objectTypeId: string;
485
- /**
486
- * Defines the operation to be applied within the filter branch (IN_LIST, NOT_IN_LIST).
487
- */
488
- operator: string;
489
- }
490
- interface PublicAssociationInListFilter {
491
- /**
492
- * Defines the category of the association, such as (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK).
493
- */
494
- associationCategory: string;
495
- /**
496
- * The ID representing the type of association being filtered.
497
- */
498
- associationTypeId: number;
499
- /**
500
- * Specifies the criteria for refining the association filter.
501
- */
502
- coalescingRefineBy: Schemas.PublicNumOccurrencesRefineBy | Schemas.PublicSetOccurrencesRefineBy | Schemas.PublicRelativeComparativeTimestampRefineBy | Schemas.PublicRelativeRangedTimestampRefineBy | Schemas.PublicAbsoluteComparativeTimestampRefineBy | Schemas.PublicAbsoluteRangedTimestampRefineBy | Schemas.PublicAllHistoryRefineBy | Schemas.PublicTimePointOperation | Schemas.PublicRangedTimeOperation;
503
- /**
504
- * Indicates the type of filter being applied, which is 'ASSOCIATION' by default.
505
- */
506
- filterType: 'ASSOCIATION';
507
- /**
508
- * The ID of the list used in the association filter.
509
- */
510
- listId: string;
511
- /**
512
- * Specifies the operation to be performed by the filter, such as 'IN_LIST' or 'NOT_IN_LIST'.
513
- */
514
- operator: string;
515
- /**
516
- * The type of object that the association filter is targeting.
517
- */
518
- toObjectType?: string;
519
- /**
520
- * The ID representing the type of object that the association filter is targeting.
521
- */
522
- toObjectTypeId?: string;
523
- }
524
- interface PublicBatchMigrationMapping {
525
- legacyListIdsToIdsMapping: Schemas.PublicMigrationMapping[];
526
- /**
527
- * A list of legacy list ids that were passed in but not found. It will be empty if no id's are missing
528
- */
529
- missingLegacyListIds: string[];
530
- }
531
- interface PublicBoolPropertyOperation {
532
- /**
533
- * Indicates whether objects with no value set for the property should be included in the operation.
534
- */
535
- includeObjectsWithNoValueSet: boolean;
536
- /**
537
- * Specifies the type of operation (BOOL).
538
- */
539
- operationType: 'BOOL';
540
- /**
541
- * Defines the operation to be applied in the boolean property operation (IS_EQUAL_TO, IS_NOT_EQUAL_TO, HAS_EVER_BEEN_EQUAL_TO, HAS_NEVER_BEEN_EQUAL_TO).
542
- */
543
- operator: string;
544
- /**
545
- * The boolean value to be used in the operation.
546
- */
547
- value: boolean;
548
- }
549
- interface PublicCalendarDatePropertyOperation {
550
- /**
551
- * The month in which the fiscal year starts.
552
- */
553
- fiscalYearStart?: 'APRIL' | 'AUGUST' | 'DECEMBER' | 'FEBRUARY' | 'JANUARY' | 'JULY' | 'JUNE' | 'MARCH' | 'MAY' | 'NOVEMBER' | 'OCTOBER' | 'SEPTEMBER';
554
- /**
555
- * Indicates whether objects with no value set for the property should be included.
556
- */
557
- includeObjectsWithNoValueSet: boolean;
558
- /**
559
- * The type of operation, which is (CALENDAR_DATE).
560
- */
561
- operationType: 'CALENDAR_DATE';
562
- /**
563
- * Defines the operation to be applied to the calendar date property (IN_THIS_TIME_UNIT, IN_THIS_TIME_UNIT_SO_FAR, IN_NEXT_TIME_UNIT, IN_LAST_TIME_UNIT).
564
- */
565
- operator: string;
566
- /**
567
- * The unit of time to be used in the operation (DAY, WEEK, MONTH, QUARTER, YEAR).
568
- */
569
- timeUnit: string;
570
- /**
571
- * The count of time units to be applied in the operation (1).
572
- */
573
- timeUnitCount?: number;
574
- /**
575
- * Specifies whether the fiscal year should be used in the operation.
576
- */
577
- useFiscalYear?: boolean;
578
- }
579
- interface PublicCampaignInfluencedFilter {
580
- /**
581
- * The ID of the campaign that influences the filter.
582
- */
583
- campaignId: string;
584
- /**
585
- * Indicates the type of filter (CAMPAIGN_INFLUENCED).
586
- */
587
- filterType: 'CAMPAIGN_INFLUENCED';
588
- }
589
- interface PublicCommunicationSubscriptionFilter {
590
- acceptedOptStates: string[];
591
- /**
592
- * The ID of the business unit associated with the subscription filter.
593
- */
594
- businessUnitId?: string;
595
- /**
596
- * Specifies the communication channel associated with the subscription filter (EMAIL, WHATSAPP, SMS).
597
- */
598
- channel: string;
599
- /**
600
- * Indicates the type of filter, which is (COMMUNICATION_SUBSCRIPTION)
601
- */
602
- filterType: 'COMMUNICATION_SUBSCRIPTION';
603
- subscriptionIds: string[];
604
- /**
605
- * Defines the type of subscription related to the filter (PORTAL_WIDE, BUSINESS_UNIT_WIDE, INDIVIDUAL_SUBSCRIPTION)
606
- */
607
- subscriptionType: string;
608
- }
609
- interface PublicComparativeDatePropertyOperation {
610
- /**
611
- * The name of the property to compare against in the operation.
612
- */
613
- comparisonPropertyName: string;
614
- /**
615
- * The default value used for comparison if the actual comparison property value is not set.
616
- */
617
- defaultComparisonValue?: string;
618
- /**
619
- * Indicates whether objects with no value set for the property should be included in the operation.
620
- */
621
- includeObjectsWithNoValueSet: boolean;
622
- /**
623
- * The type of operation (COMPARATIVE_DATE).
624
- */
625
- operationType: 'COMPARATIVE_DATE';
626
- /**
627
- * Defines the operation to be applied in the comparative date property operation (IS_BEFORE, IS_AFTER).
628
- */
629
- operator: string;
630
- }
631
- interface PublicComparativePropertyUpdatedOperation {
632
- /**
633
- * The name of the property to compare against in the operation.
634
- */
635
- comparisonPropertyName: string;
636
- /**
637
- * The default value used for comparison if the actual comparison property value is not set.
638
- */
639
- defaultComparisonValue?: string;
640
- /**
641
- * Indicates whether objects with no value set for the property should be included in the operation.
642
- */
643
- includeObjectsWithNoValueSet: boolean;
644
- /**
645
- * Specifies the type of operation (COMPARATIVE_PROPERTY_UPDATED).
646
- */
647
- operationType: 'COMPARATIVE_PROPERTY_UPDATED';
648
- /**
649
- * Defines the operation to be applied, such as comparison operators (IS_BEFORE, IS_AFTER).
650
- */
651
- operator: string;
652
- }
653
- interface PublicConstantFilter {
654
- /**
655
- * Specifies the type of filter, which is (CONSTANT).
656
- */
657
- filterType: 'CONSTANT';
658
- /**
659
- * Indicates whether the filter should accept the condition.
660
- */
661
- shouldAccept: boolean;
662
- /**
663
- * Defines the source of the constant filter.
664
- */
665
- source?: string;
666
- }
667
- interface PublicCtaAnalyticsFilter {
668
- /**
669
- * Specifies the criteria for refining the filter by coalescing.
670
- */
671
- coalescingRefineBy?: Schemas.PublicNumOccurrencesRefineBy | Schemas.PublicSetOccurrencesRefineBy | Schemas.PublicRelativeComparativeTimestampRefineBy | Schemas.PublicRelativeRangedTimestampRefineBy | Schemas.PublicAbsoluteComparativeTimestampRefineBy | Schemas.PublicAbsoluteRangedTimestampRefineBy | Schemas.PublicAllHistoryRefineBy | Schemas.PublicTimePointOperation | Schemas.PublicRangedTimeOperation;
672
- /**
673
- * The name of the Call-to-Action (CTA) to be used in the filter.
674
- */
675
- ctaName: string;
676
- /**
677
- * Indicates the type of filter being applied, which is (CTA).
678
- */
679
- filterType: 'CTA';
680
- /**
681
- * Defines the operation to be applied within the filter (HAS_CLICKED_CTA, HAS_NOT_CLICKED_CTA, HAS_OPENED_CTA, HAS_NOT_OPENED_CTA, HAS_CLICKED_CTA_PLACEMENT, HAS_NOT_CLICKED_CTA_PLACEMENT, HAS_OPENED_CTA_PLACEMENT, HAS_NOT_OPENED_CTA_PLACEMENT).
682
- */
683
- operator: string;
684
- /**
685
- * Specifies the criteria for refining the filter by pruning.
686
- */
687
- pruningRefineBy?: Schemas.PublicNumOccurrencesRefineBy | Schemas.PublicSetOccurrencesRefineBy | Schemas.PublicRelativeComparativeTimestampRefineBy | Schemas.PublicRelativeRangedTimestampRefineBy | Schemas.PublicAbsoluteComparativeTimestampRefineBy | Schemas.PublicAbsoluteRangedTimestampRefineBy | Schemas.PublicAllHistoryRefineBy | Schemas.PublicTimePointOperation | Schemas.PublicRangedTimeOperation;
688
- }
689
- interface PublicDatePoint {
690
- /**
691
- * The day component of the date.
692
- */
693
- day: number;
694
- /**
695
- * The hour component of the time.
696
- */
697
- hour?: number;
698
- /**
699
- * The millisecond component of the time.
700
- */
701
- millisecond?: number;
702
- /**
703
- * The minute component of the time.
704
- */
705
- minute?: number;
706
- /**
707
- * The month component of the date.
708
- */
709
- month: number;
710
- /**
711
- * The second component of the time.
712
- */
713
- second?: number;
714
- /**
715
- * Specifies the type of time (DATE).
716
- */
717
- timeType: 'DATE';
718
- /**
719
- * The source of the time zone information.
720
- */
721
- timezoneSource?: string;
722
- /**
723
- * The year component of the date.
724
- */
725
- year: number;
726
- /**
727
- * The identifier for the time zone.
728
- */
729
- zoneId: string;
730
- }
731
- interface PublicDatePropertyOperation {
732
- /**
733
- * The day of the month for the date operation.
734
- */
735
- day: number;
736
- /**
737
- * Indicates whether objects with no value set for the property should be included.
738
- */
739
- includeObjectsWithNoValueSet: boolean;
740
- /**
741
- * The month for the date operation.
742
- */
743
- month: string;
744
- /**
745
- * Specifies the type of operation (DATE).
746
- */
747
- operationType: 'DATE';
748
- /**
749
- * Defines the operation to be applied in the date property operation (IS_LESS_THAN_X_DAYS_AGO, IS_MORE_THAN_X_DAYS_AGO, IS_LESS_THAN_X_DAYS_FROM_NOW, IS_MORE_THAN_X_DAYS_FROM_NOW).
750
- */
751
- operator: string;
752
- /**
753
- * The year for the date operation.
754
- */
755
- year: number;
756
- }
757
- interface PublicDateTimePropertyOperation {
758
- /**
759
- * Specifies whether objects without a set value should be included in the operation.
760
- */
761
- includeObjectsWithNoValueSet: boolean;
762
- /**
763
- * The type of operation (DATETIME).
764
- */
765
- operationType: 'DATETIME';
766
- /**
767
- * Defines the operation to be applied, such as comparison operators (IS_BEFORE, IS_AFTER).
768
- */
769
- operator: string;
770
- /**
771
- * Indicates whether the timestamp requires conversion to a different time zone.
772
- */
773
- requiresTimeZoneConversion: boolean;
774
- /**
775
- * The specific point in time used in the operation.
776
- */
777
- timestamp: number;
778
- }
779
- interface PublicEmailEventFilter {
780
- /**
781
- * The ID of the application associated with the email event filter.
782
- */
783
- appId: string;
784
- /**
785
- * The URL that was clicked in the email event.
786
- */
787
- clickUrl?: string;
788
- /**
789
- * The ID of the email associated with the event filter.
790
- */
791
- emailId: string;
792
- /**
793
- * Indicates the type of filter (EMAIL_EVENT).
794
- */
795
- filterType: 'EMAIL_EVENT';
796
- /**
797
- * Specifies the level of the email event, such as EMAIL_API_CAMPAIGN_GROUP.
798
- */
799
- level: string;
800
- /**
801
- * Defines the operation to be applied within the filter (BOUNCED, LINK_CLICKED, MARKED_SPAM, OPENED, OPENED_BUT_LINK_NOT_CLICKED, OPENED_BUT_NOT_REPLIED, RECEIVED, RECEIVED_BUT_NOT_OPENED, REPLIED, SENT, SENT_BUT_LINK_NOT_CLICKED, SENT_BUT_NOT_RECEIVED, UNSUBSCRIBED).
802
- */
803
- operator: 'BOUNCED' | 'LINK_CLICKED' | 'MARKED_SPAM' | 'OPENED' | 'OPENED_BUT_LINK_NOT_CLICKED' | 'OPENED_BUT_NOT_REPLIED' | 'RECEIVED' | 'RECEIVED_BUT_NOT_OPENED' | 'REPLIED' | 'SENT' | 'SENT_BUT_LINK_NOT_CLICKED' | 'SENT_BUT_NOT_RECEIVED' | 'UNSUBSCRIBED';
804
- /**
805
- * Specifies the criteria for refining the filter by pruning.
806
- */
807
- pruningRefineBy?: Schemas.PublicNumOccurrencesRefineBy | Schemas.PublicSetOccurrencesRefineBy | Schemas.PublicRelativeComparativeTimestampRefineBy | Schemas.PublicRelativeRangedTimestampRefineBy | Schemas.PublicAbsoluteComparativeTimestampRefineBy | Schemas.PublicAbsoluteRangedTimestampRefineBy | Schemas.PublicAllHistoryRefineBy | Schemas.PublicTimePointOperation | Schemas.PublicRangedTimeOperation;
808
- }
809
- interface PublicEmailSubscriptionFilter {
810
- acceptedStatuses: string[];
811
- /**
812
- * Indicates the type of filter (EMAIL_SUBSCRIPTION).
813
- */
814
- filterType: 'EMAIL_SUBSCRIPTION';
815
- subscriptionIds: string[];
816
- /**
817
- * The type of subscription related to the filter (PORTAL, BRAND, SUBSCRIPTION, HARDBOUNCE, SPAMREPORT).
818
- */
819
- subscriptionType?: string;
820
- }
821
- interface PublicEnumerationPropertyOperation {
822
- /**
823
- * Indicates whether objects with no value set for the property should be included in the operation.
824
- */
825
- includeObjectsWithNoValueSet: boolean;
826
- /**
827
- * Specifies the type of operation (ENUMERATION).
828
- */
829
- operationType: 'ENUMERATION';
830
- /**
831
- * Defines the operation to be applied in the enumeration property operation (IS_ANY_OF, IS_NONE_OF, IS_EXACTLY, IS_NOT_EXACTLY, CONTAINS_ALL, DOES_NOT_CONTAIN_ALL, HAS_EVER_BEEN_ANY_OF, HAS_NEVER_BEEN_ANY_OF, HAS_EVER_BEEN_EXACTLY, HAS_NEVER_BEEN_EXACTLY, HAS_EVER_CONTAINED_ALL, HAS_NEVER_CONTAINED_ALL).
832
- */
833
- operator: string;
834
- values: string[];
835
- }
836
- interface PublicEventAnalyticsFilter {
837
- /**
838
- * Specifies the criteria for refining the event filter by coalescing.
839
- */
840
- coalescingRefineBy?: Schemas.PublicNumOccurrencesRefineBy | Schemas.PublicSetOccurrencesRefineBy | Schemas.PublicRelativeComparativeTimestampRefineBy | Schemas.PublicRelativeRangedTimestampRefineBy | Schemas.PublicAbsoluteComparativeTimestampRefineBy | Schemas.PublicAbsoluteRangedTimestampRefineBy | Schemas.PublicAllHistoryRefineBy | Schemas.PublicTimePointOperation | Schemas.PublicRangedTimeOperation;
841
- /**
842
- * The ID of the event to be used in the filter.
843
- */
844
- eventId: string;
845
- /**
846
- * Indicates the type of filter being applied (EVENT).
847
- */
848
- filterType: 'EVENT';
849
- /**
850
- * Defines the operation to be applied within the event filter (HAS_EVENT, NOT_HAS_EVENT).
851
- */
852
- operator: string;
853
- /**
854
- * Specifies the criteria for refining the event filter by pruning.
855
- */
856
- pruningRefineBy?: Schemas.PublicNumOccurrencesRefineBy | Schemas.PublicSetOccurrencesRefineBy | Schemas.PublicRelativeComparativeTimestampRefineBy | Schemas.PublicRelativeRangedTimestampRefineBy | Schemas.PublicAbsoluteComparativeTimestampRefineBy | Schemas.PublicAbsoluteRangedTimestampRefineBy | Schemas.PublicAllHistoryRefineBy | Schemas.PublicTimePointOperation | Schemas.PublicRangedTimeOperation;
857
- }
858
- interface PublicEventFilterMetadata {
859
- /**
860
- * Defines the operation to be performed on the property
861
- */
862
- operation: Schemas.PublicBoolPropertyOperation | Schemas.PublicNumberPropertyOperation | Schemas.PublicStringPropertyOperation | Schemas.PublicDateTimePropertyOperation | Schemas.PublicRangedDatePropertyOperation | Schemas.PublicComparativePropertyUpdatedOperation | Schemas.PublicComparativeDatePropertyOperation | Schemas.PublicRollingDateRangePropertyOperation | Schemas.PublicRollingPropertyUpdatedOperation | Schemas.PublicEnumerationPropertyOperation | Schemas.PublicAllPropertyTypesOperation | Schemas.PublicRangedNumberPropertyOperation | Schemas.PublicMultiStringPropertyOperation | Schemas.PublicDatePropertyOperation | Schemas.PublicCalendarDatePropertyOperation | Schemas.PublicTimePointOperation | Schemas.PublicRangedTimeOperation;
863
- /**
864
- * Specifies the property on which the operation is to be applied.
865
- */
866
- property: string;
867
- }
868
- interface PublicFiscalQuarterReference {
869
- /**
870
- * The day component of the fiscal quarter reference.
871
- */
872
- day: number;
873
- /**
874
- * The hour component of the fiscal quarter reference.
875
- */
876
- hour?: number;
877
- /**
878
- * The millisecond component of the fiscal quarter reference.
879
- */
880
- millisecond?: number;
881
- /**
882
- * The minute component of the fiscal quarter reference.
883
- */
884
- minute?: number;
885
- /**
886
- * The month component of the fiscal quarter reference.
887
- */
888
- month: number;
889
- /**
890
- * Indicates the type of reference (FISCAL_QUARTER).
891
- */
892
- referenceType: 'FISCAL_QUARTER';
893
- /**
894
- * The second component of the fiscal quarter reference.
895
- */
896
- second?: number;
897
- }
898
- interface PublicFiscalYearReference {
899
- /**
900
- * The day component of the fiscal year reference.
901
- */
902
- day: number;
903
- /**
904
- * The hour component of the fiscal year reference.
905
- */
906
- hour?: number;
907
- /**
908
- * The millisecond component of the fiscal year reference.
909
- */
910
- millisecond?: number;
911
- /**
912
- * The minute component of the fiscal year reference.
913
- */
914
- minute?: number;
915
- /**
916
- * The month component of the fiscal year reference.
917
- */
918
- month: number;
919
- /**
920
- * Indicates the type of reference (FISCAL_YEAR).
921
- */
922
- referenceType: 'FISCAL_YEAR';
923
- /**
924
- * The second component of the fiscal year reference.
925
- */
926
- second?: number;
927
- }
928
- interface PublicFormSubmissionFilter {
929
- /**
930
- * Specifies the criteria for refining the filter by coalescing.
931
- */
932
- coalescingRefineBy?: Schemas.PublicNumOccurrencesRefineBy | Schemas.PublicSetOccurrencesRefineBy | Schemas.PublicRelativeComparativeTimestampRefineBy | Schemas.PublicRelativeRangedTimestampRefineBy | Schemas.PublicAbsoluteComparativeTimestampRefineBy | Schemas.PublicAbsoluteRangedTimestampRefineBy | Schemas.PublicAllHistoryRefineBy | Schemas.PublicTimePointOperation | Schemas.PublicRangedTimeOperation;
933
- /**
934
- * Indicates the type of filter (FORM_SUBMISSION).
935
- */
936
- filterType: 'FORM_SUBMISSION';
937
- /**
938
- * The ID of the form used in the filter.
939
- */
940
- formId?: string;
941
- /**
942
- * Specifies the operation to be performed (FILLED_OUT, NOT_FILLED_OUT).
943
- */
944
- operator: 'FILLED_OUT' | 'NOT_FILLED_OUT';
945
- /**
946
- * Specifies the criteria for refining the filter by pruning.
947
- */
948
- pruningRefineBy?: Schemas.PublicNumOccurrencesRefineBy | Schemas.PublicSetOccurrencesRefineBy | Schemas.PublicRelativeComparativeTimestampRefineBy | Schemas.PublicRelativeRangedTimestampRefineBy | Schemas.PublicAbsoluteComparativeTimestampRefineBy | Schemas.PublicAbsoluteRangedTimestampRefineBy | Schemas.PublicAllHistoryRefineBy | Schemas.PublicTimePointOperation | Schemas.PublicRangedTimeOperation;
949
- }
950
- interface PublicFormSubmissionOnPageFilter {
951
- /**
952
- * Defines the criteria for refining the filter by coalescing.
953
- */
954
- coalescingRefineBy?: Schemas.PublicNumOccurrencesRefineBy | Schemas.PublicSetOccurrencesRefineBy | Schemas.PublicRelativeComparativeTimestampRefineBy | Schemas.PublicRelativeRangedTimestampRefineBy | Schemas.PublicAbsoluteComparativeTimestampRefineBy | Schemas.PublicAbsoluteRangedTimestampRefineBy | Schemas.PublicAllHistoryRefineBy | Schemas.PublicTimePointOperation | Schemas.PublicRangedTimeOperation;
955
- /**
956
- * Indicates the type of filter (FORM_SUBMISSION_ON_PAGE).
957
- */
958
- filterType: 'FORM_SUBMISSION_ON_PAGE';
959
- /**
960
- * The ID of the form associated with the submission filter.
961
- */
962
- formId?: string;
963
- /**
964
- * Specifies the operation to be applied (FILLED_OUT, NOT_FILLED_OUT).
965
- */
966
- operator: 'FILLED_OUT' | 'NOT_FILLED_OUT';
967
- /**
968
- * The ID of the page where the form submission occurred.
969
- */
970
- pageId: string;
971
- /**
972
- * Specifies the criteria for refining the filter by pruning.
973
- */
974
- pruningRefineBy?: Schemas.PublicNumOccurrencesRefineBy | Schemas.PublicSetOccurrencesRefineBy | Schemas.PublicRelativeComparativeTimestampRefineBy | Schemas.PublicRelativeRangedTimestampRefineBy | Schemas.PublicAbsoluteComparativeTimestampRefineBy | Schemas.PublicAbsoluteRangedTimestampRefineBy | Schemas.PublicAllHistoryRefineBy | Schemas.PublicTimePointOperation | Schemas.PublicRangedTimeOperation;
975
- }
976
- interface PublicIndexedTimePoint {
977
- /**
978
- * Specifies the reference point in time for the indexed time point.
979
- */
980
- indexReference: Schemas.PublicNowReference | Schemas.PublicTodayReference | Schemas.PublicWeekReference | Schemas.PublicFiscalQuarterReference | Schemas.PublicFiscalYearReference | Schemas.PublicYearReference | Schemas.PublicQuarterReference | Schemas.PublicMonthReference;
981
- offset?: Schemas.PublicIndexOffset;
982
- /**
983
- * Defines the type of time (INDEXED).
984
- */
985
- timeType: 'INDEXED';
986
- /**
987
- * Specifies the source of the time zone information for the indexed time point (CUSTOM, USER, PORTAL).
988
- */
989
- timezoneSource?: string;
990
- /**
991
- * Indicates the identifier for the time zone associated with the indexed time point.
992
- */
993
- zoneId: string;
994
- }
995
- interface PublicIndexOffset {
996
- /**
997
- * The number of days to offset.
998
- */
999
- days?: number;
1000
- /**
1001
- * The number of hours to offset.
1002
- */
1003
- hours?: number;
1004
- /**
1005
- * The number of milliseconds to offset.
1006
- */
1007
- milliseconds?: number;
1008
- /**
1009
- * The number of minutes to offset.
1010
- */
1011
- minutes?: number;
1012
- /**
1013
- * The number of months to offset.
1014
- */
1015
- months?: number;
1016
- /**
1017
- * The number of quarters to offset.
1018
- */
1019
- quarters?: number;
1020
- /**
1021
- * The number of seconds to offset.
1022
- */
1023
- seconds?: number;
1024
- /**
1025
- * The number of weeks to offset.
1026
- */
1027
- weeks?: number;
1028
- /**
1029
- * The number of years to offset.
1030
- */
1031
- years?: number;
1032
- }
1033
- interface PublicInListFilter {
1034
- /**
1035
- * Indicates the type of filter being applied (IN_LIST).
1036
- */
1037
- filterType: 'IN_LIST';
1038
- /**
1039
- * The ID of the list used in the association filter.
1040
- */
1041
- listId: string;
1042
- metadata?: Schemas.PublicInListFilterMetadata;
1043
- /**
1044
- * Specifies the operation to be performed by the filter (IN_LIST, NOT_IN_LIST).
1045
- */
1046
- operator: string;
1047
- }
1048
- interface PublicInListFilterMetadata {
1049
- /**
1050
- * The identifier for the filter metadata.
1051
- */
1052
- id: string;
1053
- /**
1054
- * Specifies the type of list for the filter (WORKFLOWS_ENROLLMENT, WORKFLOWS_ACTIVE, WORKFLOWS_GOAL, WORKFLOWS_COMPLETED, IMPORT, DATASET, DATASETS).
1055
- */
1056
- inListType: string;
1057
- }
1058
- interface PublicIntegrationEventFilter {
1059
- /**
1060
- * The ID representing the type of event for the integration event filter.
1061
- */
1062
- eventTypeId: number;
1063
- filterLines: Schemas.PublicEventFilterMetadata[];
1064
- /**
1065
- * Indicates the type of filter (INTEGRATION_EVENT).
1066
- */
1067
- filterType: 'INTEGRATION_EVENT';
1068
- }
1069
- interface PublicListConversionDate {
1070
- /**
1071
- * Specifies the type of conversion (CONVERSION_DATE).
1072
- */
1073
- conversionType: 'CONVERSION_DATE';
1074
- /**
1075
- * The day component of the conversion date.
1076
- */
1077
- day: number;
1078
- /**
1079
- * The month component of the conversion date.
1080
- */
1081
- month: number;
1082
- /**
1083
- * The year component of the conversion date.
1084
- */
1085
- year: number;
1086
- }
1087
- interface PublicListConversionInactivity {
1088
- /**
1089
- * Specifies the type of conversion (INACTIVITY).
1090
- */
1091
- conversionType: 'INACTIVITY';
1092
- /**
1093
- * Value used to paginate through lists. The `offset` provided in the response can be used in the next request to fetch the next page of results. Defaults to `0` if no offset is provided.
1094
- */
1095
- offset: number;
1096
- /**
1097
- * The unit of time for the inactivity period, such as (DAY, MONTH, WEEK).
1098
- */
1099
- timeUnit: 'DAY' | 'MONTH' | 'WEEK';
1100
- }
1101
- interface PublicListConversionResponse {
1102
- /**
1103
- * The date and time when the list was converted.
1104
- */
1105
- convertedAt?: string;
1106
- /**
1107
- * The unique identifier of the list for which the conversion details are provided.
1108
- */
1109
- listId: string;
1110
- /**
1111
- * The scheduled time for the list conversion, which can be based on a specific date or inactivity period.
1112
- */
1113
- requestedConversionTime?: Schemas.PublicListConversionDate | Schemas.PublicListConversionInactivity;
1114
- }
1115
- type PublicListConversionTime = Schemas.PublicListConversionDate | Schemas.PublicListConversionInactivity;
1116
- interface PublicListFolder {
1117
- /**
1118
- * An array of list Id's contained in this folder.
1119
- */
1120
- childLists: number[];
1121
- childNodes: Schemas.PublicListFolder[];
1122
- /**
1123
- * The time the folder was created at.
1124
- */
1125
- createdAt?: string;
1126
- /**
1127
- * The Id of the folder.
1128
- */
1129
- id: string;
1130
- /**
1131
- * The name of the folder.
1132
- */
1133
- name?: string;
1134
- /**
1135
- * The Id of the folder this folder is in, the root folder is represented as 0.
1136
- */
1137
- parentFolderId: string;
1138
- /**
1139
- * The time the folder was last updated at.
1140
- */
1141
- updatedAt?: string;
1142
- /**
1143
- * The time that the contents of the folder was last updated at.
1144
- */
1145
- updatedContentsAt?: string;
1146
- /**
1147
- * The user Id of the owner of the folder.
1148
- */
1149
- userId?: number;
1150
- }
1151
- interface PublicListPermissions {
1152
- teamsWithEditAccess: number[];
1153
- usersWithEditAccess: number[];
1154
- }
1155
- interface PublicMembershipSettings {
1156
- /**
1157
- * Indicates whether unassigned memberships should be included.
1158
- */
1159
- includeUnassigned?: boolean;
1160
- /**
1161
- * The ID of the team associated with the membership.
1162
- */
1163
- membershipTeamId?: number;
1164
- }
1165
- interface PublicMigrationMapping {
1166
- /**
1167
- * The legacy list id for the list
1168
- */
1169
- legacyListId: string;
1170
- /**
1171
- * The V3 list id for the list
1172
- */
1173
- listId: string;
1174
- }
1175
- interface PublicMonthReference {
1176
- /**
1177
- * The day component of the month reference.
1178
- */
1179
- day: number;
1180
- /**
1181
- * The hour component of the month reference.
1182
- */
1183
- hour?: number;
1184
- /**
1185
- * The millisecond component of the month reference.
1186
- */
1187
- millisecond?: number;
1188
- /**
1189
- * The minute component of the month reference.
1190
- */
1191
- minute?: number;
1192
- /**
1193
- * Indicates the type of reference, (MONTH).
1194
- */
1195
- referenceType: 'MONTH';
1196
- /**
1197
- * The second component of the month reference.
1198
- */
1199
- second?: number;
1200
- }
1201
- interface PublicMultiStringPropertyOperation {
1202
- /**
1203
- * Indicates whether objects with no value set for the property should be included in the operation.
1204
- */
1205
- includeObjectsWithNoValueSet: boolean;
1206
- /**
1207
- * Specifies the type of operation (MULTISTRING).
1208
- */
1209
- operationType: 'MULTISTRING';
1210
- /**
1211
- * Defines the operation to be applied in the multi-string property operation (IS_EQUAL_TO, IS_NOT_EQUAL_TO, CONTAINS, CONTAINS_EXACTLY, DOES_NOT_CONTAIN, DOES_NOT_CONTAIN_EXACTLY, STARTS_WITH, ENDS_WITH).
1212
- */
1213
- operator: string;
1214
- values: string[];
1215
- }
1216
- interface PublicNotAllFilterBranch {
1217
- filterBranches: (Schemas.PublicOrFilterBranch | Schemas.PublicAndFilterBranch | Schemas.PublicNotAllFilterBranch | Schemas.PublicNotAnyFilterBranch | Schemas.PublicRestrictedFilterBranch | Schemas.PublicUnifiedEventsFilterBranch | Schemas.PublicPropertyAssociationFilterBranch | Schemas.PublicAssociationFilterBranch)[];
1218
- /**
1219
- * The operator used to combine filters within the branch (NOT_ALL).
1220
- */
1221
- filterBranchOperator: string;
1222
- /**
1223
- * The type of the filter branch (NOT_ALL).
1224
- */
1225
- filterBranchType: 'NOT_ALL';
1226
- filters: (Schemas.PublicPropertyFilter | Schemas.PublicAssociationInListFilter | Schemas.PublicPageViewAnalyticsFilter | Schemas.PublicCtaAnalyticsFilter | Schemas.PublicEventAnalyticsFilter | Schemas.PublicFormSubmissionFilter | Schemas.PublicFormSubmissionOnPageFilter | Schemas.PublicIntegrationEventFilter | Schemas.PublicEmailSubscriptionFilter | Schemas.PublicCommunicationSubscriptionFilter | Schemas.PublicCampaignInfluencedFilter | Schemas.PublicSurveyMonkeyFilter | Schemas.PublicSurveyMonkeyValueFilter | Schemas.PublicWebinarFilter | Schemas.PublicEmailEventFilter | Schemas.PublicPrivacyAnalyticsFilter | Schemas.PublicAdsSearchFilter | Schemas.PublicAdsTimeFilter | Schemas.PublicInListFilter | Schemas.PublicNumAssociationsFilter | Schemas.PublicUnifiedEventsFilter | Schemas.PublicPropertyAssociationInListFilter | Schemas.PublicConstantFilter)[];
1227
- }
1228
- interface PublicNotAnyFilterBranch {
1229
- filterBranches: (Schemas.PublicOrFilterBranch | Schemas.PublicAndFilterBranch | Schemas.PublicNotAllFilterBranch | Schemas.PublicNotAnyFilterBranch | Schemas.PublicRestrictedFilterBranch | Schemas.PublicUnifiedEventsFilterBranch | Schemas.PublicPropertyAssociationFilterBranch | Schemas.PublicAssociationFilterBranch)[];
1230
- /**
1231
- * Specifies the logical operator used to combine filters within the branch (NOT_ANY).
1232
- */
1233
- filterBranchOperator: string;
1234
- /**
1235
- * Indicates the type of filter branch (NOT_ANY).
1236
- */
1237
- filterBranchType: 'NOT_ANY';
1238
- filters: (Schemas.PublicPropertyFilter | Schemas.PublicAssociationInListFilter | Schemas.PublicPageViewAnalyticsFilter | Schemas.PublicCtaAnalyticsFilter | Schemas.PublicEventAnalyticsFilter | Schemas.PublicFormSubmissionFilter | Schemas.PublicFormSubmissionOnPageFilter | Schemas.PublicIntegrationEventFilter | Schemas.PublicEmailSubscriptionFilter | Schemas.PublicCommunicationSubscriptionFilter | Schemas.PublicCampaignInfluencedFilter | Schemas.PublicSurveyMonkeyFilter | Schemas.PublicSurveyMonkeyValueFilter | Schemas.PublicWebinarFilter | Schemas.PublicEmailEventFilter | Schemas.PublicPrivacyAnalyticsFilter | Schemas.PublicAdsSearchFilter | Schemas.PublicAdsTimeFilter | Schemas.PublicInListFilter | Schemas.PublicNumAssociationsFilter | Schemas.PublicUnifiedEventsFilter | Schemas.PublicPropertyAssociationInListFilter | Schemas.PublicConstantFilter)[];
1239
- }
1240
- interface PublicNowReference {
1241
- /**
1242
- * The hour component of the current time reference.
1243
- */
1244
- hour?: number;
1245
- /**
1246
- * The millisecond component of the current time reference.
1247
- */
1248
- millisecond?: number;
1249
- /**
1250
- * The minute component of the current time reference.
1251
- */
1252
- minute?: number;
1253
- /**
1254
- * Indicates the type of reference (NOW).
1255
- */
1256
- referenceType: 'NOW';
1257
- /**
1258
- * The second component of the current time reference.
1259
- */
1260
- second?: number;
1261
- }
1262
- interface PublicNumAssociationsFilter {
1263
- /**
1264
- * Defines the category of the association (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK).
1265
- */
1266
- associationCategory: string;
1267
- /**
1268
- * The ID representing the type of association being filtered.
1269
- */
1270
- associationTypeId: number;
1271
- /**
1272
- * Specifies the criteria for refining the association filter.
1273
- */
1274
- coalescingRefineBy: Schemas.PublicNumOccurrencesRefineBy | Schemas.PublicSetOccurrencesRefineBy | Schemas.PublicRelativeComparativeTimestampRefineBy | Schemas.PublicRelativeRangedTimestampRefineBy | Schemas.PublicAbsoluteComparativeTimestampRefineBy | Schemas.PublicAbsoluteRangedTimestampRefineBy | Schemas.PublicAllHistoryRefineBy | Schemas.PublicTimePointOperation | Schemas.PublicRangedTimeOperation;
1275
- /**
1276
- * Indicates the type of filter being applied (NUM_ASSOCIATIONS).
1277
- */
1278
- filterType: 'NUM_ASSOCIATIONS';
1279
- }
1280
- interface PublicNumberPropertyOperation {
1281
- /**
1282
- * Indicates whether objects with no value set for the property should be included in the operation.
1283
- */
1284
- includeObjectsWithNoValueSet: boolean;
1285
- /**
1286
- * Specifies the type of operation (NUMBER).
1287
- */
1288
- operationType: 'NUMBER';
1289
- /**
1290
- * Defines the operation to be applied in the number property operation (IS_EQUAL_TO, IS_NOT_EQUAL_TO, IS_GREATER_THAN, IS_GREATER_THAN_OR_EQUAL_TO, IS_LESS_THAN, IS_LESS_THAN_OR_EQUAL_TO, HAS_EVER_BEEN_EQUAL_TO, HAS_NEVER_BEEN_EQUAL_TO).
1291
- */
1292
- operator: string;
1293
- /**
1294
- * The numeric value to be used in the operation.
1295
- */
1296
- value: number;
1297
- }
1298
- interface PublicNumOccurrencesRefineBy {
1299
- /**
1300
- * The maximum number of occurrences allowed.
1301
- */
1302
- maxOccurrences?: number;
1303
- /**
1304
- * The minimum number of occurrences required.
1305
- */
1306
- minOccurrences?: number;
1307
- /**
1308
- * The type of refinement (NUM_OCCURRENCES).
1309
- */
1310
- type: 'NUM_OCCURRENCES';
1311
- }
1312
- interface PublicObjectList {
1313
- /**
1314
- * The time when the list was created.
1315
- */
1316
- createdAt?: string;
1317
- /**
1318
- * The ID of the user that created the list.
1319
- */
1320
- createdById?: string;
1321
- /**
1322
- * The time when the list was deleted.
1323
- */
1324
- deletedAt?: string;
1325
- /**
1326
- * Defines the filter criteria for the list, allowing for complex logical operations and nested filter branches to determine list membership.
1327
- */
1328
- filterBranch?: Schemas.PublicOrFilterBranch | Schemas.PublicAndFilterBranch | Schemas.PublicNotAllFilterBranch | Schemas.PublicNotAnyFilterBranch | Schemas.PublicRestrictedFilterBranch | Schemas.PublicUnifiedEventsFilterBranch | Schemas.PublicPropertyAssociationFilterBranch | Schemas.PublicAssociationFilterBranch;
1329
- /**
1330
- * The time when the filters for this list were last updated.
1331
- */
1332
- filtersUpdatedAt?: string;
1333
- /**
1334
- * The **ILS ID** of the list.
1335
- */
1336
- listId: string;
1337
- listPermissions?: Schemas.PublicListPermissions;
1338
- /**
1339
- * The version of the list.
1340
- */
1341
- listVersion: number;
1342
- membershipSettings?: Schemas.PublicMembershipSettings;
1343
- /**
1344
- * The name of the list.
1345
- */
1346
- name: string;
1347
- /**
1348
- * The object type of the list.
1349
- */
1350
- objectTypeId: string;
1351
- /**
1352
- * The processing status of the list.
1353
- */
1354
- processingStatus: string;
1355
- /**
1356
- * The processing type of the list.
1357
- */
1358
- processingType: string;
1359
- /**
1360
- * Size of the list
1361
- */
1362
- size?: number;
1363
- /**
1364
- * The time the list was last updated.
1365
- */
1366
- updatedAt?: string;
1367
- /**
1368
- * The ID of the user that last updated the list.
1369
- */
1370
- updatedById?: string;
1371
- }
1372
- interface PublicObjectListSearchResult {
1373
- /**
1374
- * The name and value of any additional properties that exist for this list and that were included in the search request.
1375
- */
1376
- additionalProperties: Record<string, string>;
1377
- /**
1378
- * The time when the list was created.
1379
- */
1380
- createdAt?: string;
1381
- /**
1382
- * The ID of the user that created the list.
1383
- */
1384
- createdById?: string;
1385
- /**
1386
- * The time when the list was deleted.
1387
- */
1388
- deletedAt?: string;
1389
- /**
1390
- * The time when the filters for this list were last updated.
1391
- */
1392
- filtersUpdatedAt?: string;
1393
- /**
1394
- * The **ILS ID** of the list.
1395
- */
1396
- listId: string;
1397
- /**
1398
- * The version of the list.
1399
- */
1400
- listVersion: number;
1401
- /**
1402
- * The name of the list.
1403
- */
1404
- name: string;
1405
- /**
1406
- * The object type of the list.
1407
- */
1408
- objectTypeId: string;
1409
- /**
1410
- * The processing status of the list.
1411
- */
1412
- processingStatus: string;
1413
- /**
1414
- * The processing type of the list.
1415
- */
1416
- processingType: string;
1417
- /**
1418
- * The time the list was last updated.
1419
- */
1420
- updatedAt?: string;
1421
- /**
1422
- * The ID of the user that last updated the list.
1423
- */
1424
- updatedById?: string;
1425
- }
1426
- interface PublicOrFilterBranch {
1427
- filterBranches: (Schemas.PublicOrFilterBranch | Schemas.PublicAndFilterBranch | Schemas.PublicNotAllFilterBranch | Schemas.PublicNotAnyFilterBranch | Schemas.PublicRestrictedFilterBranch | Schemas.PublicUnifiedEventsFilterBranch | Schemas.PublicPropertyAssociationFilterBranch | Schemas.PublicAssociationFilterBranch)[];
1428
- /**
1429
- * The logical operator used to combine the filters within the branch (OR).
1430
- */
1431
- filterBranchOperator: string;
1432
- /**
1433
- * The type of the filter branch (OR).
1434
- */
1435
- filterBranchType: 'OR';
1436
- filters: (Schemas.PublicPropertyFilter | Schemas.PublicAssociationInListFilter | Schemas.PublicPageViewAnalyticsFilter | Schemas.PublicCtaAnalyticsFilter | Schemas.PublicEventAnalyticsFilter | Schemas.PublicFormSubmissionFilter | Schemas.PublicFormSubmissionOnPageFilter | Schemas.PublicIntegrationEventFilter | Schemas.PublicEmailSubscriptionFilter | Schemas.PublicCommunicationSubscriptionFilter | Schemas.PublicCampaignInfluencedFilter | Schemas.PublicSurveyMonkeyFilter | Schemas.PublicSurveyMonkeyValueFilter | Schemas.PublicWebinarFilter | Schemas.PublicEmailEventFilter | Schemas.PublicPrivacyAnalyticsFilter | Schemas.PublicAdsSearchFilter | Schemas.PublicAdsTimeFilter | Schemas.PublicInListFilter | Schemas.PublicNumAssociationsFilter | Schemas.PublicUnifiedEventsFilter | Schemas.PublicPropertyAssociationInListFilter | Schemas.PublicConstantFilter)[];
1437
- }
1438
- interface PublicPageViewAnalyticsFilter {
1439
- /**
1440
- * Specifies the criteria for refining the filter by coalescing.
1441
- */
1442
- coalescingRefineBy?: Schemas.PublicNumOccurrencesRefineBy | Schemas.PublicSetOccurrencesRefineBy | Schemas.PublicRelativeComparativeTimestampRefineBy | Schemas.PublicRelativeRangedTimestampRefineBy | Schemas.PublicAbsoluteComparativeTimestampRefineBy | Schemas.PublicAbsoluteRangedTimestampRefineBy | Schemas.PublicAllHistoryRefineBy | Schemas.PublicTimePointOperation | Schemas.PublicRangedTimeOperation;
1443
- /**
1444
- * Indicates whether tracking is enabled for the page view.
1445
- */
1446
- enableTracking?: boolean;
1447
- /**
1448
- * Indicates the type of filter being applied (PAGE_VIEW).
1449
- */
1450
- filterType: 'PAGE_VIEW';
1451
- /**
1452
- * Defines the operation to be applied within the filter (HAS_PAGEVIEW_EQ, HAS_PAGEVIEW_CONTAINS, HAS_PAGEVIEW_MATCHES_REGEX, NOT_HAS_PAGEVIEW_EQ, NOT_HAS_PAGEVIEW_CONTAINS).
1453
- */
1454
- operator: string;
1455
- /**
1456
- * The URL of the page to be used in the filter.
1457
- */
1458
- pageUrl: string;
1459
- /**
1460
- * Specifies the criteria for refining the filter by pruning.
1461
- */
1462
- pruningRefineBy?: Schemas.PublicNumOccurrencesRefineBy | Schemas.PublicSetOccurrencesRefineBy | Schemas.PublicRelativeComparativeTimestampRefineBy | Schemas.PublicRelativeRangedTimestampRefineBy | Schemas.PublicAbsoluteComparativeTimestampRefineBy | Schemas.PublicAbsoluteRangedTimestampRefineBy | Schemas.PublicAllHistoryRefineBy | Schemas.PublicTimePointOperation | Schemas.PublicRangedTimeOperation;
1463
- }
1464
- interface PublicPrivacyAnalyticsFilter {
1465
- /**
1466
- * Specifies the type of filter (PRIVACY).
1467
- */
1468
- filterType: 'PRIVACY';
1469
- /**
1470
- * Defines the operation to be applied within the filter (PRIVACY_CONSENT_GRANTED, PRIVACY_CONSENT_NOT_GRANTED).
1471
- */
1472
- operator: string;
1473
- /**
1474
- * The name of the privacy setting used in the filter.
1475
- */
1476
- privacyName: string;
1477
- }
1478
- interface PublicPropertyAssociationFilterBranch {
1479
- filterBranches: (Schemas.PublicOrFilterBranch | Schemas.PublicAndFilterBranch | Schemas.PublicNotAllFilterBranch | Schemas.PublicNotAnyFilterBranch | Schemas.PublicRestrictedFilterBranch | Schemas.PublicUnifiedEventsFilterBranch | Schemas.PublicPropertyAssociationFilterBranch | Schemas.PublicAssociationFilterBranch)[];
1480
- /**
1481
- * The logical operator used to combine filters within the branch.
1482
- */
1483
- filterBranchOperator: string;
1484
- /**
1485
- * The type of the filter branch (PROPERTY_ASSOCIATION).
1486
- */
1487
- filterBranchType: 'PROPERTY_ASSOCIATION';
1488
- filters: (Schemas.PublicPropertyFilter | Schemas.PublicAssociationInListFilter | Schemas.PublicPageViewAnalyticsFilter | Schemas.PublicCtaAnalyticsFilter | Schemas.PublicEventAnalyticsFilter | Schemas.PublicFormSubmissionFilter | Schemas.PublicFormSubmissionOnPageFilter | Schemas.PublicIntegrationEventFilter | Schemas.PublicEmailSubscriptionFilter | Schemas.PublicCommunicationSubscriptionFilter | Schemas.PublicCampaignInfluencedFilter | Schemas.PublicSurveyMonkeyFilter | Schemas.PublicSurveyMonkeyValueFilter | Schemas.PublicWebinarFilter | Schemas.PublicEmailEventFilter | Schemas.PublicPrivacyAnalyticsFilter | Schemas.PublicAdsSearchFilter | Schemas.PublicAdsTimeFilter | Schemas.PublicInListFilter | Schemas.PublicNumAssociationsFilter | Schemas.PublicUnifiedEventsFilter | Schemas.PublicPropertyAssociationInListFilter | Schemas.PublicConstantFilter)[];
1489
- /**
1490
- * The ID representing the type of object associated with the filter branch.
1491
- */
1492
- objectTypeId: string;
1493
- /**
1494
- * Defines the operation to be applied within the filter branch (IN_LIST, NOT_IN_LIST).
1495
- */
1496
- operator: string;
1497
- /**
1498
- * The property that is associated with the object ID in the filter branch.
1499
- */
1500
- propertyWithObjectId: string;
1501
- }
1502
- interface PublicPropertyAssociationInListFilter {
1503
- /**
1504
- * Specifies the criteria for refining the filter by coalescing.
1505
- */
1506
- coalescingRefineBy: Schemas.PublicNumOccurrencesRefineBy | Schemas.PublicSetOccurrencesRefineBy | Schemas.PublicRelativeComparativeTimestampRefineBy | Schemas.PublicRelativeRangedTimestampRefineBy | Schemas.PublicAbsoluteComparativeTimestampRefineBy | Schemas.PublicAbsoluteRangedTimestampRefineBy | Schemas.PublicAllHistoryRefineBy | Schemas.PublicTimePointOperation | Schemas.PublicRangedTimeOperation;
1507
- /**
1508
- * Indicates the type of filter being applied (PROPERTY_ASSOCIATION).
1509
- */
1510
- filterType: 'PROPERTY_ASSOCIATION';
1511
- /**
1512
- * The ID of the list used in the property association filter.
1513
- */
1514
- listId: string;
1515
- /**
1516
- * Defines the operation to be applied by the filter (IN_LIST, NOT_IN_LIST).
1517
- */
1518
- operator: string;
1519
- /**
1520
- * The property associated with the object ID in the filter.
1521
- */
1522
- propertyWithObjectId: string;
1523
- /**
1524
- * The ID representing the type of object that the property association filter is targeting.
1525
- */
1526
- toObjectTypeId?: string;
1527
- }
1528
- interface PublicPropertyFilter {
1529
- /**
1530
- * Indicates that the filter (PROPERTY).
1531
- */
1532
- filterType: 'PROPERTY';
1533
- /**
1534
- * Defines the operation to be performed on the property, such as comparison or value matching.
1535
- */
1536
- operation: Schemas.PublicBoolPropertyOperation | Schemas.PublicNumberPropertyOperation | Schemas.PublicStringPropertyOperation | Schemas.PublicDateTimePropertyOperation | Schemas.PublicRangedDatePropertyOperation | Schemas.PublicComparativePropertyUpdatedOperation | Schemas.PublicComparativeDatePropertyOperation | Schemas.PublicRollingDateRangePropertyOperation | Schemas.PublicRollingPropertyUpdatedOperation | Schemas.PublicEnumerationPropertyOperation | Schemas.PublicAllPropertyTypesOperation | Schemas.PublicRangedNumberPropertyOperation | Schemas.PublicMultiStringPropertyOperation | Schemas.PublicDatePropertyOperation | Schemas.PublicCalendarDatePropertyOperation | Schemas.PublicTimePointOperation | Schemas.PublicRangedTimeOperation;
1537
- /**
1538
- * Specifies the name of the property that the filter is applied to.
1539
- */
1540
- property: string;
1541
- }
1542
- interface PublicPropertyReferencedTime {
1543
- /**
1544
- * Specifies the name of the property that the time reference is applied to.
1545
- */
1546
- property: string;
1547
- /**
1548
- * Specifies the type of reference for the property (VALUE, UPDATED_AT, ANNIVERSARY, VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION, ANNIVERSARY_WITH_ZONE_SAME_LOCAL_CONVERSION).
1549
- */
1550
- referenceType: string;
1551
- /**
1552
- * Defines the type of time (PROPERTY_REFERENCED).
1553
- */
1554
- timeType: 'PROPERTY_REFERENCED';
1555
- /**
1556
- * Specifies the source of the time zone information for the property (CUSTOM, USER, PORTAL).
1557
- */
1558
- timezoneSource?: string;
1559
- /**
1560
- * Indicates the identifier for the time zone associated with the property.
1561
- */
1562
- zoneId: string;
1563
- }
1564
- interface PublicQuarterReference {
1565
- /**
1566
- * The day component of the quarter reference.
1567
- */
1568
- day: number;
1569
- /**
1570
- * The hour component of the quarter reference.
1571
- */
1572
- hour?: number;
1573
- /**
1574
- * The millisecond component of the quarter reference.
1575
- */
1576
- millisecond?: number;
1577
- /**
1578
- * The minute component of the quarter reference.
1579
- */
1580
- minute?: number;
1581
- /**
1582
- * The month component of the quarter reference.
1583
- */
1584
- month: number;
1585
- /**
1586
- * Indicates the type of reference (QUARTER).
1587
- */
1588
- referenceType: 'QUARTER';
1589
- /**
1590
- * The second component of the quarter reference.
1591
- */
1592
- second?: number;
1593
- }
1594
- interface PublicRangedDatePropertyOperation {
1595
- /**
1596
- * Specifies whether objects without a set value should be included in the operation.
1597
- */
1598
- includeObjectsWithNoValueSet: boolean;
1599
- /**
1600
- * The lower limit of the date range for the operation.
1601
- */
1602
- lowerBound: number;
1603
- /**
1604
- * Specifies the type of operation (RANGED_DATE).
1605
- */
1606
- operationType: 'RANGED_DATE';
1607
- /**
1608
- * Defines the operation to be applied in the ranged date property operation (IS_BETWEEN, IS_NOT_BETWEEN).
1609
- */
1610
- operator: string;
1611
- /**
1612
- * Indicates whether the operation requires conversion to a different time zone.
1613
- */
1614
- requiresTimeZoneConversion: boolean;
1615
- /**
1616
- * The upper limit of the date range for the operation.
1617
- */
1618
- upperBound: number;
1619
- }
1620
- interface PublicRangedNumberPropertyOperation {
1621
- /**
1622
- * Indicates whether objects with no value set for the property should be included in the operation.
1623
- */
1624
- includeObjectsWithNoValueSet: boolean;
1625
- /**
1626
- * The lower limit of the number range for the operation.
1627
- */
1628
- lowerBound: number;
1629
- /**
1630
- * Specifies the type of operation (NUMBER_RANGED).
1631
- */
1632
- operationType: 'NUMBER_RANGED';
1633
- /**
1634
- * Defines the operation to be applied in the ranged number property operation (IS_BETWEEN, IS_NOT_BETWEEN).
1635
- */
1636
- operator: string;
1637
- /**
1638
- * The upper limit of the number range for the operation.
1639
- */
1640
- upperBound: number;
1641
- }
1642
- interface PublicRangedTimeOperation {
1643
- /**
1644
- * Indicates whether objects with no value set for the property should be included in the operation.
1645
- */
1646
- includeObjectsWithNoValueSet: boolean;
1647
- /**
1648
- * Describes the behavior at the lower bound endpoint of the time range.
1649
- */
1650
- lowerBoundEndpointBehavior?: string;
1651
- /**
1652
- * Defines the lower bound time point for the operation.
1653
- */
1654
- lowerBoundTimePoint: Schemas.PublicDatePoint | Schemas.PublicIndexedTimePoint | Schemas.PublicPropertyReferencedTime;
1655
- /**
1656
- * Specifies the type of operation (TIME_RANGED).
1657
- */
1658
- operationType: string;
1659
- /**
1660
- * Defines the operation to be applied within the time range (IS_BETWEEN, IS_NOT_BETWEEN).
1661
- */
1662
- operator: string;
1663
- /**
1664
- * Specifies the parser used for the property in the operation.
1665
- */
1666
- propertyParser?: string;
1667
- /**
1668
- * Specifies the type of operation (TIME_RANGED).
1669
- */
1670
- type: 'TIME_RANGED';
1671
- /**
1672
- * Describes the behavior at the upper bound endpoint of the time range.
1673
- */
1674
- upperBoundEndpointBehavior?: string;
1675
- /**
1676
- * Defines the upper bound time point for the operation.
1677
- */
1678
- upperBoundTimePoint: Schemas.PublicDatePoint | Schemas.PublicIndexedTimePoint | Schemas.PublicPropertyReferencedTime;
1679
- }
1680
- interface PublicRelativeComparativeTimestampRefineBy {
1681
- /**
1682
- * Defines the comparison operation to be used in the refinement (BEFORE, AFTER).
1683
- */
1684
- comparison: string;
1685
- timeOffset: Schemas.PublicTimeOffset;
1686
- /**
1687
- * Specifies the type of refinement, (RELATIVE_COMPARATIVE).
1688
- */
1689
- type: 'RELATIVE_COMPARATIVE';
1690
- }
1691
- interface PublicRelativeRangedTimestampRefineBy {
1692
- lowerBoundOffset: Schemas.PublicTimeOffset;
1693
- /**
1694
- * Specifies the type of range for the refinement criteria (BETWEEN, NOT_BETWEEN).
1695
- */
1696
- rangeType: string;
1697
- /**
1698
- * Indicates the type of refinement (RELATIVE_RANGED).
1699
- */
1700
- type: 'RELATIVE_RANGED';
1701
- upperBoundOffset: Schemas.PublicTimeOffset;
1702
- }
1703
- interface PublicRestrictedFilterBranch {
1704
- filterBranches: (Schemas.PublicOrFilterBranch | Schemas.PublicAndFilterBranch | Schemas.PublicNotAllFilterBranch | Schemas.PublicNotAnyFilterBranch | Schemas.PublicRestrictedFilterBranch | Schemas.PublicUnifiedEventsFilterBranch | Schemas.PublicPropertyAssociationFilterBranch | Schemas.PublicAssociationFilterBranch)[];
1705
- /**
1706
- * The logical operator used to combine filters within the restricted filter branch.
1707
- */
1708
- filterBranchOperator: string;
1709
- /**
1710
- * Specifies the type of the filter branch (RESTRICTED).
1711
- */
1712
- filterBranchType: 'RESTRICTED';
1713
- filters: (Schemas.PublicPropertyFilter | Schemas.PublicAssociationInListFilter | Schemas.PublicPageViewAnalyticsFilter | Schemas.PublicCtaAnalyticsFilter | Schemas.PublicEventAnalyticsFilter | Schemas.PublicFormSubmissionFilter | Schemas.PublicFormSubmissionOnPageFilter | Schemas.PublicIntegrationEventFilter | Schemas.PublicEmailSubscriptionFilter | Schemas.PublicCommunicationSubscriptionFilter | Schemas.PublicCampaignInfluencedFilter | Schemas.PublicSurveyMonkeyFilter | Schemas.PublicSurveyMonkeyValueFilter | Schemas.PublicWebinarFilter | Schemas.PublicEmailEventFilter | Schemas.PublicPrivacyAnalyticsFilter | Schemas.PublicAdsSearchFilter | Schemas.PublicAdsTimeFilter | Schemas.PublicInListFilter | Schemas.PublicNumAssociationsFilter | Schemas.PublicUnifiedEventsFilter | Schemas.PublicPropertyAssociationInListFilter | Schemas.PublicConstantFilter)[];
1714
- }
1715
- interface PublicRollingDateRangePropertyOperation {
1716
- /**
1717
- * Indicates whether objects with no value set for the property should be included in the operation.
1718
- */
1719
- includeObjectsWithNoValueSet: boolean;
1720
- /**
1721
- * The number of days to be considered in the rolling date range operation.
1722
- */
1723
- numberOfDays: number;
1724
- /**
1725
- * Specifies the type of operation (ROLLING_DATE_RANGE).
1726
- */
1727
- operationType: 'ROLLING_DATE_RANGE';
1728
- /**
1729
- * Defines the operation to be applied within the rolling date range property operation (IS_LESS_THAN_X_DAYS_AGO, IS_MORE_THAN_X_DAYS_AGO, IS_LESS_THAN_X_DAYS_FROM_NOW, IS_MORE_THAN_X_DAYS_FROM_NOW).
1730
- */
1731
- operator: string;
1732
- /**
1733
- * Specifies whether the operation requires conversion to a different time zone.
1734
- */
1735
- requiresTimeZoneConversion: boolean;
1736
- }
1737
- interface PublicRollingPropertyUpdatedOperation {
1738
- /**
1739
- * Indicates whether objects with no value set for the property should be included in the operation.
1740
- */
1741
- includeObjectsWithNoValueSet: boolean;
1742
- /**
1743
- * The number of days to be considered in the rolling property updated operation.
1744
- */
1745
- numberOfDays: number;
1746
- /**
1747
- * Specifies the type of operation (ROLLING_PROPERTY_UPDATED).
1748
- */
1749
- operationType: 'ROLLING_PROPERTY_UPDATED';
1750
- /**
1751
- * Defines the operation to be applied within the rolling property updated operation (UPDATED_IN_LAST_X_DAYS, NOT_UPDATED_IN_LAST_X_DAYS).
1752
- */
1753
- operator: string;
1754
- }
1755
- interface PublicSetOccurrencesRefineBy {
1756
- /**
1757
- * Indicates the specific set type used in the refinement (ALL, ALL_INCLUDE_EMPTY, ANY, NONE, NONE_EXCLUDE_EMPTY, ANY_INCLUDE_EMPTY).
1758
- */
1759
- setType: string;
1760
- /**
1761
- * Specifies the type of refinement (SET_OCCURRENCES).
1762
- */
1763
- type: 'SET_OCCURRENCES';
1764
- }
1765
- interface PublicStringPropertyOperation {
1766
- /**
1767
- * Indicates whether objects with no value set for the property should be included in the operation.
1768
- */
1769
- includeObjectsWithNoValueSet: boolean;
1770
- /**
1771
- * Specifies the type of operation (STRING).
1772
- */
1773
- operationType: 'STRING';
1774
- /**
1775
- * Defines the operation to be applied in the string property operation ()IS_EQUAL_TO, IS_NOT_EQUAL_TO, CONTAINS, DOES_NOT_CONTAIN, STARTS_WITH, ENDS_WITH, HAS_EVER_BEEN_EQUAL_TO, HAS_NEVER_BEEN_EQUAL_TO, HAS_EVER_CONTAINED, HAS_NEVER_CONTAINED).
1776
- */
1777
- operator: string;
1778
- /**
1779
- * The string value to be used in the operation.
1780
- */
1781
- value: string;
1782
- }
1783
- interface PublicSurveyMonkeyFilter {
1784
- /**
1785
- * Indicates the type of filter being applied (SURVEY_MONKEY).
1786
- */
1787
- filterType: 'SURVEY_MONKEY';
1788
- /**
1789
- * Specifies the operation to be performed by the filter (HAS_RESPONDED_TO_SURVEY, HAS_NOT_RESPONDED_TO_SURVEY).
1790
- */
1791
- operator: string;
1792
- /**
1793
- * The ID of the survey associated with the filter.
1794
- */
1795
- surveyId: string;
1796
- }
1797
- interface PublicSurveyMonkeyValueFilter {
1798
- /**
1799
- * Defines the type of filter (SURVEY_MONKEY_VALUE).
1800
- */
1801
- filterType: 'SURVEY_MONKEY_VALUE';
1802
- /**
1803
- * Defines the operation to be applied within the filter (HAS_ANSWERED_SURVEY_QUESTION_WITH_VALUE).
1804
- */
1805
- operator: string;
1806
- /**
1807
- * The column ID of the survey answer used in the filter.
1808
- */
1809
- surveyAnswerColId?: string;
1810
- /**
1811
- * The row ID of the survey answer used in the filter.
1812
- */
1813
- surveyAnswerRowId?: string;
1814
- /**
1815
- * The ID of the survey used in the filter.
1816
- */
1817
- surveyId: string;
1818
- /**
1819
- * The question from the survey used in the filter.
1820
- */
1821
- surveyQuestion: string;
1822
- /**
1823
- * Specifies the operation used to compare the survey answer value.
1824
- */
1825
- valueComparison: Schemas.PublicBoolPropertyOperation | Schemas.PublicNumberPropertyOperation | Schemas.PublicStringPropertyOperation | Schemas.PublicDateTimePropertyOperation | Schemas.PublicRangedDatePropertyOperation | Schemas.PublicComparativePropertyUpdatedOperation | Schemas.PublicComparativeDatePropertyOperation | Schemas.PublicRollingDateRangePropertyOperation | Schemas.PublicRollingPropertyUpdatedOperation | Schemas.PublicEnumerationPropertyOperation | Schemas.PublicAllPropertyTypesOperation | Schemas.PublicRangedNumberPropertyOperation | Schemas.PublicMultiStringPropertyOperation | Schemas.PublicDatePropertyOperation | Schemas.PublicCalendarDatePropertyOperation | Schemas.PublicTimePointOperation | Schemas.PublicRangedTimeOperation;
1826
- }
1827
- interface PublicTimeOffset {
1828
- /**
1829
- * The numerical value representing the quantity of the time offset.
1830
- */
1831
- amount: number;
1832
- /**
1833
- * Indicates the direction of the time offset, such as forward or backward.
1834
- */
1835
- offsetDirection: string;
1836
- /**
1837
- * Specifies the unit of time for the offset, such as days, hours, or minutes.
1838
- */
1839
- timeUnit: string;
1840
- }
1841
- interface PublicTimePointOperation {
1842
- /**
1843
- * Describes the behavior at the endpoint of the time point operation.
1844
- */
1845
- endpointBehavior?: string;
1846
- /**
1847
- * Indicates whether objects with no value set for the property should be included in the operation.
1848
- */
1849
- includeObjectsWithNoValueSet: boolean;
1850
- /**
1851
- * Specifies the type of operation (TIME_POINT).
1852
- */
1853
- operationType: 'TIME_POINT';
1854
- /**
1855
- * Specifies the operation to be applied within the time point operation (IS_BEFORE, IS_AFTER).
1856
- */
1857
- operator: string;
1858
- /**
1859
- * Specifies the parser used for interpreting the property in the operation.
1860
- */
1861
- propertyParser?: string;
1862
- /**
1863
- * Defines the specific point in time for the operation, which can be a date, indexed time, or property-referenced time.
1864
- */
1865
- timePoint: Schemas.PublicDatePoint | Schemas.PublicIndexedTimePoint | Schemas.PublicPropertyReferencedTime;
1866
- /**
1867
- * Defines the type of operation being performed.
1868
- */
1869
- type: string;
1870
- }
1871
- interface PublicTodayReference {
1872
- /**
1873
- * The hour component of the current day reference.
1874
- */
1875
- hour?: number;
1876
- /**
1877
- * The millisecond component of the current day reference.
1878
- */
1879
- millisecond?: number;
1880
- /**
1881
- * The minute component of the current day reference.
1882
- */
1883
- minute?: number;
1884
- /**
1885
- * Indicates the type of reference (TODAY).
1886
- */
1887
- referenceType: 'TODAY';
1888
- /**
1889
- * The second component of the current day reference.
1890
- */
1891
- second?: number;
1892
- }
1893
- interface PublicUnifiedEventsFilter {
1894
- /**
1895
- * Specifies the criteria for refining the filter by coalescing.
1896
- */
1897
- coalescingRefineBy?: Schemas.PublicNumOccurrencesRefineBy | Schemas.PublicSetOccurrencesRefineBy | Schemas.PublicRelativeComparativeTimestampRefineBy | Schemas.PublicRelativeRangedTimestampRefineBy | Schemas.PublicAbsoluteComparativeTimestampRefineBy | Schemas.PublicAbsoluteRangedTimestampRefineBy | Schemas.PublicAllHistoryRefineBy | Schemas.PublicTimePointOperation | Schemas.PublicRangedTimeOperation;
1898
- /**
1899
- * The identifier for the type of event in the unified events filter.
1900
- */
1901
- eventTypeId?: string;
1902
- filterLines: Schemas.PublicEventFilterMetadata[];
1903
- /**
1904
- * Indicates the type of filter being applied (UNIFIED_EVENTS).
1905
- */
1906
- filterType: 'UNIFIED_EVENTS';
1907
- /**
1908
- * Specifies the criteria for refining the filter by pruning.
1909
- */
1910
- pruningRefineBy?: Schemas.PublicNumOccurrencesRefineBy | Schemas.PublicSetOccurrencesRefineBy | Schemas.PublicRelativeComparativeTimestampRefineBy | Schemas.PublicRelativeRangedTimestampRefineBy | Schemas.PublicAbsoluteComparativeTimestampRefineBy | Schemas.PublicAbsoluteRangedTimestampRefineBy | Schemas.PublicAllHistoryRefineBy | Schemas.PublicTimePointOperation | Schemas.PublicRangedTimeOperation;
1911
- }
1912
- interface PublicUnifiedEventsFilterBranch {
1913
- /**
1914
- * Specifies the criteria for refining the filter by coalescing.
1915
- */
1916
- coalescingRefineBy?: Schemas.PublicNumOccurrencesRefineBy | Schemas.PublicSetOccurrencesRefineBy | Schemas.PublicRelativeComparativeTimestampRefineBy | Schemas.PublicRelativeRangedTimestampRefineBy | Schemas.PublicAbsoluteComparativeTimestampRefineBy | Schemas.PublicAbsoluteRangedTimestampRefineBy | Schemas.PublicAllHistoryRefineBy | Schemas.PublicTimePointOperation | Schemas.PublicRangedTimeOperation;
1917
- /**
1918
- * The identifier for the type of event associated with the filter branch.
1919
- */
1920
- eventTypeId: string;
1921
- filterBranches: (Schemas.PublicOrFilterBranch | Schemas.PublicAndFilterBranch | Schemas.PublicNotAllFilterBranch | Schemas.PublicNotAnyFilterBranch | Schemas.PublicRestrictedFilterBranch | Schemas.PublicUnifiedEventsFilterBranch | Schemas.PublicPropertyAssociationFilterBranch | Schemas.PublicAssociationFilterBranch)[];
1922
- /**
1923
- * The logical operator used to combine filters within the branch (AND).
1924
- */
1925
- filterBranchOperator: string;
1926
- /**
1927
- * The type of the filter branch (UNIFIED_EVENTS).
1928
- */
1929
- filterBranchType: 'UNIFIED_EVENTS';
1930
- filters: (Schemas.PublicPropertyFilter | Schemas.PublicAssociationInListFilter | Schemas.PublicPageViewAnalyticsFilter | Schemas.PublicCtaAnalyticsFilter | Schemas.PublicEventAnalyticsFilter | Schemas.PublicFormSubmissionFilter | Schemas.PublicFormSubmissionOnPageFilter | Schemas.PublicIntegrationEventFilter | Schemas.PublicEmailSubscriptionFilter | Schemas.PublicCommunicationSubscriptionFilter | Schemas.PublicCampaignInfluencedFilter | Schemas.PublicSurveyMonkeyFilter | Schemas.PublicSurveyMonkeyValueFilter | Schemas.PublicWebinarFilter | Schemas.PublicEmailEventFilter | Schemas.PublicPrivacyAnalyticsFilter | Schemas.PublicAdsSearchFilter | Schemas.PublicAdsTimeFilter | Schemas.PublicInListFilter | Schemas.PublicNumAssociationsFilter | Schemas.PublicUnifiedEventsFilter | Schemas.PublicPropertyAssociationInListFilter | Schemas.PublicConstantFilter)[];
1931
- /**
1932
- * Defines the operation to be applied within the filter branch (HAS_COMPLETED, HAS_NOT_COMPLETED).
1933
- */
1934
- operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED';
1935
- pruningRefineBy?: Schemas.PublicNumOccurrencesRefineBy | Schemas.PublicSetOccurrencesRefineBy | Schemas.PublicRelativeComparativeTimestampRefineBy | Schemas.PublicRelativeRangedTimestampRefineBy | Schemas.PublicAbsoluteComparativeTimestampRefineBy | Schemas.PublicAbsoluteRangedTimestampRefineBy | Schemas.PublicAllHistoryRefineBy | Schemas.PublicTimePointOperation | Schemas.PublicRangedTimeOperation;
1936
- }
1937
- interface PublicWebinarFilter {
1938
- /**
1939
- * Indicates the type of filter, (WEBINAR).
1940
- */
1941
- filterType: 'WEBINAR';
1942
- /**
1943
- * Specifies the operation to be performed by the filter (HAS_WEBINAR_REGISTRATION, NOT_HAS_WEBINAR_REGISTRATION, HAS_WEBINAR_ATTENDANCE, NOT_HAS_WEBINAR_ATTENDANCE).
1944
- */
1945
- operator: string;
1946
- /**
1947
- * The ID of the webinar associated with the filter.
1948
- */
1949
- webinarId?: string;
1950
- }
1951
- interface PublicWeekReference {
1952
- /**
1953
- * The day of the week (SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY).
1954
- */
1955
- dayOfWeek: 'FRIDAY' | 'MONDAY' | 'SATURDAY' | 'SUNDAY' | 'THURSDAY' | 'TUESDAY' | 'WEDNESDAY';
1956
- /**
1957
- * The hour component of the week reference.
1958
- */
1959
- hour?: number;
1960
- /**
1961
- * The millisecond component of the week reference.
1962
- */
1963
- millisecond?: number;
1964
- /**
1965
- * The minute component of the week reference.
1966
- */
1967
- minute?: number;
1968
- /**
1969
- * Indicates the type of reference (WEEK).
1970
- */
1971
- referenceType: 'WEEK';
1972
- /**
1973
- * The second component of the week reference.
1974
- */
1975
- second?: number;
1976
- }
1977
- interface PublicYearReference {
1978
- /**
1979
- * The day component of the year reference.
1980
- */
1981
- day: number;
1982
- /**
1983
- * The hour component of the year reference.
1984
- */
1985
- hour?: number;
1986
- /**
1987
- * The millisecond component of the year reference.
1988
- */
1989
- millisecond?: number;
1990
- /**
1991
- * The minute component of the year reference.
1992
- */
1993
- minute?: number;
1994
- /**
1995
- * The month component of the year reference.
1996
- */
1997
- month: number;
1998
- /**
1999
- * Indicates the type of reference (YEAR).
2000
- */
2001
- referenceType: 'YEAR';
2002
- /**
2003
- * The second component of the year reference.
2004
- */
2005
- second?: number;
2006
- }
2007
- interface RecordIdInput {
2008
- objectTypeId: string;
2009
- recordId: string;
2010
- }
2011
- interface RecordIdWithMemberships {
2012
- objectTypeId: string;
2013
- recordId: string;
2014
- recordListMemberships: Schemas.RecordListMembership[];
2015
- }
2016
- interface RecordListMembership {
2017
- /**
2018
- * The timestamp when the record was first added to the list.
2019
- */
2020
- firstAddedTimestamp: string;
2021
- /**
2022
- * Indicates whether the list is public.
2023
- */
2024
- isPublicList?: boolean;
2025
- /**
2026
- * The timestamp when the record was last added to the list.
2027
- */
2028
- lastAddedTimestamp: string;
2029
- /**
2030
- * The unique identifier of the list.
2031
- */
2032
- listId: string;
2033
- /**
2034
- * The version number of the list.
2035
- */
2036
- listVersion: number;
2037
- }
2038
- }
2039
- namespace Search {
2040
- type ListBySearchInput = Schemas.ListSearchRequest;
2041
- type ListBySearchOutput = Schemas.ListSearchResponse;
4
+ declare namespace CRMListsSchemas {
5
+ interface ApiCollectionResponseJoinTimeAndRecordId {
6
+ paging?: Paging;
7
+ results: JoinTimeAndRecordId[];
8
+ /**
9
+ * The total number of records that match the query.
10
+ */
11
+ total?: number;
12
+ }
13
+ interface ApiCollectionResponseRecordListMembership {
14
+ paging?: Paging;
15
+ results: RecordListMembership[];
16
+ total?: number;
17
+ }
18
+ interface BatchInputRecordIdInput {
19
+ inputs: RecordIdInput[];
20
+ }
21
+ interface BatchResponseRecordIdWithMemberships {
22
+ completedAt: string;
23
+ links?: Record<string, string>;
24
+ requestedAt?: string;
25
+ results: RecordIdWithMemberships[];
26
+ startedAt: string;
27
+ status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
28
+ }
29
+ interface JoinTimeAndRecordId {
30
+ /**
31
+ * The date and time when the record was added to the list.
32
+ */
33
+ membershipTimestamp: string;
34
+ /**
35
+ * The unique identifier of the record.
36
+ */
37
+ recordId: string;
38
+ }
39
+ interface ListCreateRequest {
40
+ /**
41
+ * The list of custom properties to tie to the list. Custom property name is the key, the value is the value.
42
+ */
43
+ customProperties?: Record<string, string>;
44
+ /**
45
+ * Filter branch object containing filtering criteria for the list
46
+ */
47
+ filterBranch?: PublicOrFilterBranch | PublicAndFilterBranch | PublicNotAllFilterBranch | PublicNotAnyFilterBranch | PublicRestrictedFilterBranch | PublicUnifiedEventsFilterBranch | PublicPropertyAssociationFilterBranch | PublicAssociationFilterBranch;
48
+ /**
49
+ * The ID of the folder that the list should be created in. If left blank, then the list will be created in the root of the list folder structure.
50
+ */
51
+ listFolderId?: number;
52
+ listPermissions?: PublicListPermissions;
53
+ membershipSettings?: PublicMembershipSettings;
54
+ /**
55
+ * The name of the list, which must be globally unique across all public lists in the portal.
56
+ */
57
+ name: string;
58
+ /**
59
+ * The object type ID of the type of objects that the list will store.
60
+ */
61
+ objectTypeId: string;
62
+ /**
63
+ * The processing type of the list. One of: `SNAPSHOT`, `MANUAL`, or `DYNAMIC`.
64
+ */
65
+ processingType: string;
66
+ }
67
+ interface ListCreateResponse {
68
+ list: PublicObjectList;
69
+ }
70
+ interface ListFetchResponse {
71
+ list: PublicObjectList;
72
+ }
73
+ interface ListFilterUpdateRequest {
74
+ /**
75
+ * Updated filtering criteria for the list
76
+ */
77
+ filterBranch: PublicOrFilterBranch | PublicAndFilterBranch | PublicNotAllFilterBranch | PublicNotAnyFilterBranch | PublicRestrictedFilterBranch | PublicUnifiedEventsFilterBranch | PublicPropertyAssociationFilterBranch | PublicAssociationFilterBranch;
78
+ }
79
+ interface ListFolderCreateRequest {
80
+ /**
81
+ * The name of the folder to be created.
82
+ */
83
+ name: string;
84
+ /**
85
+ * The folder this should be created in, if not specified will be created in the root folder 0.
86
+ */
87
+ parentFolderId?: string;
88
+ }
89
+ interface ListFolderCreateResponse {
90
+ folder: PublicListFolder;
91
+ }
92
+ interface ListFolderFetchResponse {
93
+ folder: PublicListFolder;
94
+ }
95
+ interface ListMoveRequest {
96
+ /**
97
+ * The Id of the list to move.
98
+ */
99
+ listId: string;
100
+ /**
101
+ * The Id of folder to move the list to, the root folder is Id 0.
102
+ */
103
+ newFolderId: string;
104
+ }
105
+ interface ListsByIdResponse {
106
+ /**
107
+ * The object list definitions.
108
+ */
109
+ lists: PublicObjectList[];
110
+ }
111
+ interface ListSearchRequest {
112
+ /**
113
+ * The property names of any additional list properties to include in the response. Properties that do not exist or that are empty for a particular list are not included in the response.
114
+ *
115
+ * By default, all requests will fetch the following properties for each list: `hs_list_size`, `hs_last_record_added_at`, `hs_last_record_removed_at`, `hs_folder_name`, and `hs_list_reference_count`.
116
+ */
117
+ additionalProperties: string[];
118
+ /**
119
+ * The number of lists to include in the response. Defaults to `20` if no value is provided. The max `count` is `500`.
120
+ */
121
+ count?: number;
122
+ /**
123
+ * ILS list ids to be included in search results. If not specified, all lists matching other criteria will be included
124
+ */
125
+ listIds: string[];
126
+ objectTypeId?: string;
127
+ /**
128
+ * Value used to paginate through lists. The `offset` provided in the response can be used in the next request to fetch the next page of results. Defaults to `0` if no offset is provided.
129
+ */
130
+ offset: number;
131
+ /**
132
+ * List processing types to be included in search results. If not specified, all lists with all processing types will be included.
133
+ */
134
+ processingTypes: string[];
135
+ /**
136
+ * The `query` that will be used to search for lists by list name. If no `query` is provided, then the results will include all lists.
137
+ */
138
+ query?: string;
139
+ /**
140
+ * Sort field and order
141
+ */
142
+ sort?: string;
143
+ }
144
+ interface ListSearchResponse {
145
+ /**
146
+ * Whether or not there are more results to page through.
147
+ */
148
+ hasMore: boolean;
149
+ /**
150
+ * The lists that matched the search criteria.
151
+ */
152
+ lists: PublicObjectListSearchResult[];
153
+ /**
154
+ * Value to be passed in a future request to paginate through list search results.
155
+ */
156
+ offset: number;
157
+ /**
158
+ * The total number of lists that match the search criteria.
159
+ */
160
+ total: number;
161
+ }
162
+ interface ListSizeAndEditHistoryResponse {
163
+ editHistory: string[];
164
+ sizeHistory: ListSizeDataPoint[];
165
+ }
166
+ interface ListSizeDataPoint {
167
+ size: number;
168
+ timestamp: string;
169
+ }
170
+ interface ListUpdateResponse {
171
+ updatedList?: PublicObjectList;
172
+ }
173
+ interface MembershipChangeRequest {
174
+ recordIdsToAdd: string[];
175
+ recordIdsToRemove: string[];
176
+ }
177
+ interface MembershipsUpdateResponse {
178
+ /**
179
+ * The IDs of the records that were `missing` (e.g. did not exist in the portal) and so were not `added` or `removed`.
180
+ */
181
+ recordIdsMissing: string[];
182
+ /**
183
+ * The IDs of the records that were `removed` from the list.
184
+ */
185
+ recordIdsRemoved: string[];
186
+ recordsIdsAdded: string[];
187
+ }
188
+ /**
189
+ * Specifies the paging information needed to retrieve the next set of results in a paginated API response
190
+ */
191
+ interface NextPage {
192
+ /**
193
+ * The offset for the next page of records.
194
+ */
195
+ after: string;
196
+ /**
197
+ * A direct link to the request for the next page of records.
198
+ */
199
+ link?: string;
200
+ }
201
+ interface Paging {
202
+ next?: NextPage;
203
+ prev?: PreviousPage;
204
+ }
205
+ /**
206
+ * specifies the paging information needed to retrieve the previous set of results in a paginated API response
207
+ */
208
+ interface PreviousPage {
209
+ /**
210
+ * The offset of the previous page of records.
211
+ */
212
+ before: string;
213
+ /**
214
+ * A direct link to the request for the previous page of records.
215
+ */
216
+ link?: string;
217
+ }
218
+ interface PublicAbsoluteComparativeTimestampRefineBy {
219
+ /**
220
+ * Timestamp comparison options (BEFORE, AFTER)
221
+ */
222
+ comparison: string;
223
+ /**
224
+ * Timestamp to be used in refine by criteria
225
+ */
226
+ timestamp: number;
227
+ /**
228
+ * type of refine by criteria (ABSOLUTE_COMPARATIVE)
229
+ */
230
+ type: 'ABSOLUTE_COMPARATIVE';
231
+ }
232
+ interface PublicAbsoluteRangedTimestampRefineBy {
233
+ /**
234
+ * Lower range timestamp of refinement criteria
235
+ */
236
+ lowerTimestamp: number;
237
+ /**
238
+ * Type of range of refinement critaria (BETWEEN, NOT_BETWEEN)
239
+ */
240
+ rangeType: string;
241
+ /**
242
+ * type of refine by criteria (ABSOLUTE_RANGED)
243
+ */
244
+ type: 'ABSOLUTE_RANGED';
245
+ /**
246
+ * Upper range timestamp of refinement criteria
247
+ */
248
+ upperTimestamp: number;
249
+ }
250
+ interface PublicAdsSearchFilter {
251
+ /**
252
+ * Ad network (ADWORDS, FACEBOOK, LINKEDIN, ALL)
253
+ */
254
+ adNetwork: string;
255
+ /**
256
+ * Type of ad entity (KEYWORD, ADGROUP, AD, CAMPAIGN)
257
+ */
258
+ entityType: string;
259
+ /**
260
+ * Type of the filter (ADS_SEARCH)
261
+ */
262
+ filterType: 'ADS_SEARCH';
263
+ /**
264
+ * Operator to be applied (CONTAINS, IS_EQUAL_TO, ENDS_WITH, STARTS_WITH, IS_KNOWN)
265
+ */
266
+ operator: string;
267
+ searchTerms: string[];
268
+ /**
269
+ * Search term to match an ad
270
+ */
271
+ searchTermType: string;
272
+ }
273
+ interface PublicAdsTimeFilter {
274
+ /**
275
+ * Filter type (ADS_TIME)
276
+ */
277
+ filterType: 'ADS_TIME';
278
+ /**
279
+ * Refinement criteria
280
+ */
281
+ pruningRefineBy: PublicNumOccurrencesRefineBy | PublicSetOccurrencesRefineBy | PublicRelativeComparativeTimestampRefineBy | PublicRelativeRangedTimestampRefineBy | PublicAbsoluteComparativeTimestampRefineBy | PublicAbsoluteRangedTimestampRefineBy | PublicAllHistoryRefineBy | PublicTimePointOperation | PublicRangedTimeOperation;
282
+ }
283
+ interface PublicAllHistoryRefineBy {
284
+ /**
285
+ * Type of refine by (ALL_HISTORY)
286
+ */
287
+ type: 'ALL_HISTORY';
288
+ }
289
+ interface PublicAllPropertyTypesOperation {
290
+ /**
291
+ * Indication of whether objects with no value should be included
292
+ */
293
+ includeObjectsWithNoValueSet: boolean;
294
+ /**
295
+ * Type of operation (ALL_PROPERTY)
296
+ */
297
+ operationType: 'ALL_PROPERTY';
298
+ /**
299
+ * Operator to be applied (IS_KNOWN, IS_UNKNOWN)
300
+ */
301
+ operator: string;
302
+ }
303
+ interface PublicAndFilterBranch {
304
+ filterBranches: (PublicOrFilterBranch | PublicAndFilterBranch | PublicNotAllFilterBranch | PublicNotAnyFilterBranch | PublicRestrictedFilterBranch | PublicUnifiedEventsFilterBranch | PublicPropertyAssociationFilterBranch | PublicAssociationFilterBranch)[];
305
+ /**
306
+ * Filter branch operator (AND)
307
+ */
308
+ filterBranchOperator: string;
309
+ /**
310
+ * Type of filter branch (AND)
311
+ */
312
+ filterBranchType: 'AND';
313
+ filters: (PublicPropertyFilter | PublicAssociationInListFilter | PublicPageViewAnalyticsFilter | PublicCtaAnalyticsFilter | PublicEventAnalyticsFilter | PublicFormSubmissionFilter | PublicFormSubmissionOnPageFilter | PublicIntegrationEventFilter | PublicEmailSubscriptionFilter | PublicCommunicationSubscriptionFilter | PublicCampaignInfluencedFilter | PublicSurveyMonkeyFilter | PublicSurveyMonkeyValueFilter | PublicWebinarFilter | PublicEmailEventFilter | PublicPrivacyAnalyticsFilter | PublicAdsSearchFilter | PublicAdsTimeFilter | PublicInListFilter | PublicNumAssociationsFilter | PublicUnifiedEventsFilter | PublicPropertyAssociationInListFilter | PublicConstantFilter)[];
314
+ }
315
+ interface PublicAssociationFilterBranch {
316
+ /**
317
+ * Specifies the category of the association for the filter branch (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK).
318
+ */
319
+ associationCategory: string;
320
+ /**
321
+ * Type id of the association
322
+ */
323
+ associationTypeId: number;
324
+ filterBranches: (PublicOrFilterBranch | PublicAndFilterBranch | PublicNotAllFilterBranch | PublicNotAnyFilterBranch | PublicRestrictedFilterBranch | PublicUnifiedEventsFilterBranch | PublicPropertyAssociationFilterBranch | PublicAssociationFilterBranch)[];
325
+ /**
326
+ * Filter branch operator (AND)
327
+ */
328
+ filterBranchOperator: string;
329
+ /**
330
+ * Type of the filter branch (ASSOCIATION)
331
+ */
332
+ filterBranchType: 'ASSOCIATION';
333
+ filters: (PublicPropertyFilter | PublicAssociationInListFilter | PublicPageViewAnalyticsFilter | PublicCtaAnalyticsFilter | PublicEventAnalyticsFilter | PublicFormSubmissionFilter | PublicFormSubmissionOnPageFilter | PublicIntegrationEventFilter | PublicEmailSubscriptionFilter | PublicCommunicationSubscriptionFilter | PublicCampaignInfluencedFilter | PublicSurveyMonkeyFilter | PublicSurveyMonkeyValueFilter | PublicWebinarFilter | PublicEmailEventFilter | PublicPrivacyAnalyticsFilter | PublicAdsSearchFilter | PublicAdsTimeFilter | PublicInListFilter | PublicNumAssociationsFilter | PublicUnifiedEventsFilter | PublicPropertyAssociationInListFilter | PublicConstantFilter)[];
334
+ /**
335
+ * The ID representing the type of object associated with the filter branch.
336
+ */
337
+ objectTypeId: string;
338
+ /**
339
+ * Defines the operation to be applied within the filter branch (IN_LIST, NOT_IN_LIST).
340
+ */
341
+ operator: string;
342
+ }
343
+ interface PublicAssociationInListFilter {
344
+ /**
345
+ * Defines the category of the association, such as (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK).
346
+ */
347
+ associationCategory: string;
348
+ /**
349
+ * The ID representing the type of association being filtered.
350
+ */
351
+ associationTypeId: number;
352
+ /**
353
+ * Specifies the criteria for refining the association filter.
354
+ */
355
+ coalescingRefineBy: PublicNumOccurrencesRefineBy | PublicSetOccurrencesRefineBy | PublicRelativeComparativeTimestampRefineBy | PublicRelativeRangedTimestampRefineBy | PublicAbsoluteComparativeTimestampRefineBy | PublicAbsoluteRangedTimestampRefineBy | PublicAllHistoryRefineBy | PublicTimePointOperation | PublicRangedTimeOperation;
356
+ /**
357
+ * Indicates the type of filter being applied, which is 'ASSOCIATION' by default.
358
+ */
359
+ filterType: 'ASSOCIATION';
360
+ /**
361
+ * The ID of the list used in the association filter.
362
+ */
363
+ listId: string;
364
+ /**
365
+ * Specifies the operation to be performed by the filter, such as 'IN_LIST' or 'NOT_IN_LIST'.
366
+ */
367
+ operator: string;
368
+ /**
369
+ * The type of object that the association filter is targeting.
370
+ */
371
+ toObjectType?: string;
372
+ /**
373
+ * The ID representing the type of object that the association filter is targeting.
374
+ */
375
+ toObjectTypeId?: string;
376
+ }
377
+ interface PublicBatchMigrationMapping {
378
+ legacyListIdsToIdsMapping: PublicMigrationMapping[];
379
+ /**
380
+ * A list of legacy list ids that were passed in but not found. It will be empty if no id's are missing
381
+ */
382
+ missingLegacyListIds: string[];
383
+ }
384
+ interface PublicBoolPropertyOperation {
385
+ /**
386
+ * Indicates whether objects with no value set for the property should be included in the operation.
387
+ */
388
+ includeObjectsWithNoValueSet: boolean;
389
+ /**
390
+ * Specifies the type of operation (BOOL).
391
+ */
392
+ operationType: 'BOOL';
393
+ /**
394
+ * Defines the operation to be applied in the boolean property operation (IS_EQUAL_TO, IS_NOT_EQUAL_TO, HAS_EVER_BEEN_EQUAL_TO, HAS_NEVER_BEEN_EQUAL_TO).
395
+ */
396
+ operator: string;
397
+ /**
398
+ * The boolean value to be used in the operation.
399
+ */
400
+ value: boolean;
401
+ }
402
+ interface PublicCalendarDatePropertyOperation {
403
+ /**
404
+ * The month in which the fiscal year starts.
405
+ */
406
+ fiscalYearStart?: 'APRIL' | 'AUGUST' | 'DECEMBER' | 'FEBRUARY' | 'JANUARY' | 'JULY' | 'JUNE' | 'MARCH' | 'MAY' | 'NOVEMBER' | 'OCTOBER' | 'SEPTEMBER';
407
+ /**
408
+ * Indicates whether objects with no value set for the property should be included.
409
+ */
410
+ includeObjectsWithNoValueSet: boolean;
411
+ /**
412
+ * The type of operation, which is (CALENDAR_DATE).
413
+ */
414
+ operationType: 'CALENDAR_DATE';
415
+ /**
416
+ * Defines the operation to be applied to the calendar date property (IN_THIS_TIME_UNIT, IN_THIS_TIME_UNIT_SO_FAR, IN_NEXT_TIME_UNIT, IN_LAST_TIME_UNIT).
417
+ */
418
+ operator: string;
419
+ /**
420
+ * The unit of time to be used in the operation (DAY, WEEK, MONTH, QUARTER, YEAR).
421
+ */
422
+ timeUnit: string;
423
+ /**
424
+ * The count of time units to be applied in the operation (1).
425
+ */
426
+ timeUnitCount?: number;
427
+ /**
428
+ * Specifies whether the fiscal year should be used in the operation.
429
+ */
430
+ useFiscalYear?: boolean;
431
+ }
432
+ interface PublicCampaignInfluencedFilter {
433
+ /**
434
+ * The ID of the campaign that influences the filter.
435
+ */
436
+ campaignId: string;
437
+ /**
438
+ * Indicates the type of filter (CAMPAIGN_INFLUENCED).
439
+ */
440
+ filterType: 'CAMPAIGN_INFLUENCED';
441
+ }
442
+ interface PublicCommunicationSubscriptionFilter {
443
+ acceptedOptStates: string[];
444
+ /**
445
+ * The ID of the business unit associated with the subscription filter.
446
+ */
447
+ businessUnitId?: string;
448
+ /**
449
+ * Specifies the communication channel associated with the subscription filter (EMAIL, WHATSAPP, SMS).
450
+ */
451
+ channel: string;
452
+ /**
453
+ * Indicates the type of filter, which is (COMMUNICATION_SUBSCRIPTION)
454
+ */
455
+ filterType: 'COMMUNICATION_SUBSCRIPTION';
456
+ subscriptionIds: string[];
457
+ /**
458
+ * Defines the type of subscription related to the filter (PORTAL_WIDE, BUSINESS_UNIT_WIDE, INDIVIDUAL_SUBSCRIPTION)
459
+ */
460
+ subscriptionType: string;
461
+ }
462
+ interface PublicComparativeDatePropertyOperation {
463
+ /**
464
+ * The name of the property to compare against in the operation.
465
+ */
466
+ comparisonPropertyName: string;
467
+ /**
468
+ * The default value used for comparison if the actual comparison property value is not set.
469
+ */
470
+ defaultComparisonValue?: string;
471
+ /**
472
+ * Indicates whether objects with no value set for the property should be included in the operation.
473
+ */
474
+ includeObjectsWithNoValueSet: boolean;
475
+ /**
476
+ * The type of operation (COMPARATIVE_DATE).
477
+ */
478
+ operationType: 'COMPARATIVE_DATE';
479
+ /**
480
+ * Defines the operation to be applied in the comparative date property operation (IS_BEFORE, IS_AFTER).
481
+ */
482
+ operator: string;
483
+ }
484
+ interface PublicComparativePropertyUpdatedOperation {
485
+ /**
486
+ * The name of the property to compare against in the operation.
487
+ */
488
+ comparisonPropertyName: string;
489
+ /**
490
+ * The default value used for comparison if the actual comparison property value is not set.
491
+ */
492
+ defaultComparisonValue?: string;
493
+ /**
494
+ * Indicates whether objects with no value set for the property should be included in the operation.
495
+ */
496
+ includeObjectsWithNoValueSet: boolean;
497
+ /**
498
+ * Specifies the type of operation (COMPARATIVE_PROPERTY_UPDATED).
499
+ */
500
+ operationType: 'COMPARATIVE_PROPERTY_UPDATED';
501
+ /**
502
+ * Defines the operation to be applied, such as comparison operators (IS_BEFORE, IS_AFTER).
503
+ */
504
+ operator: string;
505
+ }
506
+ interface PublicConstantFilter {
507
+ /**
508
+ * Specifies the type of filter, which is (CONSTANT).
509
+ */
510
+ filterType: 'CONSTANT';
511
+ /**
512
+ * Indicates whether the filter should accept the condition.
513
+ */
514
+ shouldAccept: boolean;
515
+ /**
516
+ * Defines the source of the constant filter.
517
+ */
518
+ source?: string;
519
+ }
520
+ interface PublicCtaAnalyticsFilter {
521
+ /**
522
+ * Specifies the criteria for refining the filter by coalescing.
523
+ */
524
+ coalescingRefineBy?: PublicNumOccurrencesRefineBy | PublicSetOccurrencesRefineBy | PublicRelativeComparativeTimestampRefineBy | PublicRelativeRangedTimestampRefineBy | PublicAbsoluteComparativeTimestampRefineBy | PublicAbsoluteRangedTimestampRefineBy | PublicAllHistoryRefineBy | PublicTimePointOperation | PublicRangedTimeOperation;
525
+ /**
526
+ * The name of the Call-to-Action (CTA) to be used in the filter.
527
+ */
528
+ ctaName: string;
529
+ /**
530
+ * Indicates the type of filter being applied, which is (CTA).
531
+ */
532
+ filterType: 'CTA';
533
+ /**
534
+ * Defines the operation to be applied within the filter (HAS_CLICKED_CTA, HAS_NOT_CLICKED_CTA, HAS_OPENED_CTA, HAS_NOT_OPENED_CTA, HAS_CLICKED_CTA_PLACEMENT, HAS_NOT_CLICKED_CTA_PLACEMENT, HAS_OPENED_CTA_PLACEMENT, HAS_NOT_OPENED_CTA_PLACEMENT).
535
+ */
536
+ operator: string;
537
+ /**
538
+ * Specifies the criteria for refining the filter by pruning.
539
+ */
540
+ pruningRefineBy?: PublicNumOccurrencesRefineBy | PublicSetOccurrencesRefineBy | PublicRelativeComparativeTimestampRefineBy | PublicRelativeRangedTimestampRefineBy | PublicAbsoluteComparativeTimestampRefineBy | PublicAbsoluteRangedTimestampRefineBy | PublicAllHistoryRefineBy | PublicTimePointOperation | PublicRangedTimeOperation;
541
+ }
542
+ interface PublicDatePoint {
543
+ /**
544
+ * The day component of the date.
545
+ */
546
+ day: number;
547
+ /**
548
+ * The hour component of the time.
549
+ */
550
+ hour?: number;
551
+ /**
552
+ * The millisecond component of the time.
553
+ */
554
+ millisecond?: number;
555
+ /**
556
+ * The minute component of the time.
557
+ */
558
+ minute?: number;
559
+ /**
560
+ * The month component of the date.
561
+ */
562
+ month: number;
563
+ /**
564
+ * The second component of the time.
565
+ */
566
+ second?: number;
567
+ /**
568
+ * Specifies the type of time (DATE).
569
+ */
570
+ timeType: 'DATE';
571
+ /**
572
+ * The source of the time zone information.
573
+ */
574
+ timezoneSource?: string;
575
+ /**
576
+ * The year component of the date.
577
+ */
578
+ year: number;
579
+ /**
580
+ * The identifier for the time zone.
581
+ */
582
+ zoneId: string;
583
+ }
584
+ interface PublicDatePropertyOperation {
585
+ /**
586
+ * The day of the month for the date operation.
587
+ */
588
+ day: number;
589
+ /**
590
+ * Indicates whether objects with no value set for the property should be included.
591
+ */
592
+ includeObjectsWithNoValueSet: boolean;
593
+ /**
594
+ * The month for the date operation.
595
+ */
596
+ month: string;
597
+ /**
598
+ * Specifies the type of operation (DATE).
599
+ */
600
+ operationType: 'DATE';
601
+ /**
602
+ * Defines the operation to be applied in the date property operation (IS_LESS_THAN_X_DAYS_AGO, IS_MORE_THAN_X_DAYS_AGO, IS_LESS_THAN_X_DAYS_FROM_NOW, IS_MORE_THAN_X_DAYS_FROM_NOW).
603
+ */
604
+ operator: string;
605
+ /**
606
+ * The year for the date operation.
607
+ */
608
+ year: number;
609
+ }
610
+ interface PublicDateTimePropertyOperation {
611
+ /**
612
+ * Specifies whether objects without a set value should be included in the operation.
613
+ */
614
+ includeObjectsWithNoValueSet: boolean;
615
+ /**
616
+ * The type of operation (DATETIME).
617
+ */
618
+ operationType: 'DATETIME';
619
+ /**
620
+ * Defines the operation to be applied, such as comparison operators (IS_BEFORE, IS_AFTER).
621
+ */
622
+ operator: string;
623
+ /**
624
+ * Indicates whether the timestamp requires conversion to a different time zone.
625
+ */
626
+ requiresTimeZoneConversion: boolean;
627
+ /**
628
+ * The specific point in time used in the operation.
629
+ */
630
+ timestamp: number;
631
+ }
632
+ interface PublicEmailEventFilter {
633
+ /**
634
+ * The ID of the application associated with the email event filter.
635
+ */
636
+ appId: string;
637
+ /**
638
+ * The URL that was clicked in the email event.
639
+ */
640
+ clickUrl?: string;
641
+ /**
642
+ * The ID of the email associated with the event filter.
643
+ */
644
+ emailId: string;
645
+ /**
646
+ * Indicates the type of filter (EMAIL_EVENT).
647
+ */
648
+ filterType: 'EMAIL_EVENT';
649
+ /**
650
+ * Specifies the level of the email event, such as EMAIL_API_CAMPAIGN_GROUP.
651
+ */
652
+ level: string;
653
+ /**
654
+ * Defines the operation to be applied within the filter (BOUNCED, LINK_CLICKED, MARKED_SPAM, OPENED, OPENED_BUT_LINK_NOT_CLICKED, OPENED_BUT_NOT_REPLIED, RECEIVED, RECEIVED_BUT_NOT_OPENED, REPLIED, SENT, SENT_BUT_LINK_NOT_CLICKED, SENT_BUT_NOT_RECEIVED, UNSUBSCRIBED).
655
+ */
656
+ operator: 'BOUNCED' | 'LINK_CLICKED' | 'MARKED_SPAM' | 'OPENED' | 'OPENED_BUT_LINK_NOT_CLICKED' | 'OPENED_BUT_NOT_REPLIED' | 'RECEIVED' | 'RECEIVED_BUT_NOT_OPENED' | 'REPLIED' | 'SENT' | 'SENT_BUT_LINK_NOT_CLICKED' | 'SENT_BUT_NOT_RECEIVED' | 'UNSUBSCRIBED';
657
+ /**
658
+ * Specifies the criteria for refining the filter by pruning.
659
+ */
660
+ pruningRefineBy?: PublicNumOccurrencesRefineBy | PublicSetOccurrencesRefineBy | PublicRelativeComparativeTimestampRefineBy | PublicRelativeRangedTimestampRefineBy | PublicAbsoluteComparativeTimestampRefineBy | PublicAbsoluteRangedTimestampRefineBy | PublicAllHistoryRefineBy | PublicTimePointOperation | PublicRangedTimeOperation;
661
+ }
662
+ interface PublicEmailSubscriptionFilter {
663
+ acceptedStatuses: string[];
664
+ /**
665
+ * Indicates the type of filter (EMAIL_SUBSCRIPTION).
666
+ */
667
+ filterType: 'EMAIL_SUBSCRIPTION';
668
+ subscriptionIds: string[];
669
+ /**
670
+ * The type of subscription related to the filter (PORTAL, BRAND, SUBSCRIPTION, HARDBOUNCE, SPAMREPORT).
671
+ */
672
+ subscriptionType?: string;
673
+ }
674
+ interface PublicEnumerationPropertyOperation {
675
+ /**
676
+ * Indicates whether objects with no value set for the property should be included in the operation.
677
+ */
678
+ includeObjectsWithNoValueSet: boolean;
679
+ /**
680
+ * Specifies the type of operation (ENUMERATION).
681
+ */
682
+ operationType: 'ENUMERATION';
683
+ /**
684
+ * Defines the operation to be applied in the enumeration property operation (IS_ANY_OF, IS_NONE_OF, IS_EXACTLY, IS_NOT_EXACTLY, CONTAINS_ALL, DOES_NOT_CONTAIN_ALL, HAS_EVER_BEEN_ANY_OF, HAS_NEVER_BEEN_ANY_OF, HAS_EVER_BEEN_EXACTLY, HAS_NEVER_BEEN_EXACTLY, HAS_EVER_CONTAINED_ALL, HAS_NEVER_CONTAINED_ALL).
685
+ */
686
+ operator: string;
687
+ values: string[];
688
+ }
689
+ interface PublicEventAnalyticsFilter {
690
+ /**
691
+ * Specifies the criteria for refining the event filter by coalescing.
692
+ */
693
+ coalescingRefineBy?: PublicNumOccurrencesRefineBy | PublicSetOccurrencesRefineBy | PublicRelativeComparativeTimestampRefineBy | PublicRelativeRangedTimestampRefineBy | PublicAbsoluteComparativeTimestampRefineBy | PublicAbsoluteRangedTimestampRefineBy | PublicAllHistoryRefineBy | PublicTimePointOperation | PublicRangedTimeOperation;
694
+ /**
695
+ * The ID of the event to be used in the filter.
696
+ */
697
+ eventId: string;
698
+ /**
699
+ * Indicates the type of filter being applied (EVENT).
700
+ */
701
+ filterType: 'EVENT';
702
+ /**
703
+ * Defines the operation to be applied within the event filter (HAS_EVENT, NOT_HAS_EVENT).
704
+ */
705
+ operator: string;
706
+ /**
707
+ * Specifies the criteria for refining the event filter by pruning.
708
+ */
709
+ pruningRefineBy?: PublicNumOccurrencesRefineBy | PublicSetOccurrencesRefineBy | PublicRelativeComparativeTimestampRefineBy | PublicRelativeRangedTimestampRefineBy | PublicAbsoluteComparativeTimestampRefineBy | PublicAbsoluteRangedTimestampRefineBy | PublicAllHistoryRefineBy | PublicTimePointOperation | PublicRangedTimeOperation;
710
+ }
711
+ interface PublicEventFilterMetadata {
712
+ /**
713
+ * Defines the operation to be performed on the property
714
+ */
715
+ operation: PublicBoolPropertyOperation | PublicNumberPropertyOperation | PublicStringPropertyOperation | PublicDateTimePropertyOperation | PublicRangedDatePropertyOperation | PublicComparativePropertyUpdatedOperation | PublicComparativeDatePropertyOperation | PublicRollingDateRangePropertyOperation | PublicRollingPropertyUpdatedOperation | PublicEnumerationPropertyOperation | PublicAllPropertyTypesOperation | PublicRangedNumberPropertyOperation | PublicMultiStringPropertyOperation | PublicDatePropertyOperation | PublicCalendarDatePropertyOperation | PublicTimePointOperation | PublicRangedTimeOperation;
716
+ /**
717
+ * Specifies the property on which the operation is to be applied.
718
+ */
719
+ property: string;
720
+ }
721
+ interface PublicFiscalQuarterReference {
722
+ /**
723
+ * The day component of the fiscal quarter reference.
724
+ */
725
+ day: number;
726
+ /**
727
+ * The hour component of the fiscal quarter reference.
728
+ */
729
+ hour?: number;
730
+ /**
731
+ * The millisecond component of the fiscal quarter reference.
732
+ */
733
+ millisecond?: number;
734
+ /**
735
+ * The minute component of the fiscal quarter reference.
736
+ */
737
+ minute?: number;
738
+ /**
739
+ * The month component of the fiscal quarter reference.
740
+ */
741
+ month: number;
742
+ /**
743
+ * Indicates the type of reference (FISCAL_QUARTER).
744
+ */
745
+ referenceType: 'FISCAL_QUARTER';
746
+ /**
747
+ * The second component of the fiscal quarter reference.
748
+ */
749
+ second?: number;
750
+ }
751
+ interface PublicFiscalYearReference {
752
+ /**
753
+ * The day component of the fiscal year reference.
754
+ */
755
+ day: number;
756
+ /**
757
+ * The hour component of the fiscal year reference.
758
+ */
759
+ hour?: number;
760
+ /**
761
+ * The millisecond component of the fiscal year reference.
762
+ */
763
+ millisecond?: number;
764
+ /**
765
+ * The minute component of the fiscal year reference.
766
+ */
767
+ minute?: number;
768
+ /**
769
+ * The month component of the fiscal year reference.
770
+ */
771
+ month: number;
772
+ /**
773
+ * Indicates the type of reference (FISCAL_YEAR).
774
+ */
775
+ referenceType: 'FISCAL_YEAR';
776
+ /**
777
+ * The second component of the fiscal year reference.
778
+ */
779
+ second?: number;
780
+ }
781
+ interface PublicFormSubmissionFilter {
782
+ /**
783
+ * Specifies the criteria for refining the filter by coalescing.
784
+ */
785
+ coalescingRefineBy?: PublicNumOccurrencesRefineBy | PublicSetOccurrencesRefineBy | PublicRelativeComparativeTimestampRefineBy | PublicRelativeRangedTimestampRefineBy | PublicAbsoluteComparativeTimestampRefineBy | PublicAbsoluteRangedTimestampRefineBy | PublicAllHistoryRefineBy | PublicTimePointOperation | PublicRangedTimeOperation;
786
+ /**
787
+ * Indicates the type of filter (FORM_SUBMISSION).
788
+ */
789
+ filterType: 'FORM_SUBMISSION';
790
+ /**
791
+ * The ID of the form used in the filter.
792
+ */
793
+ formId?: string;
794
+ /**
795
+ * Specifies the operation to be performed (FILLED_OUT, NOT_FILLED_OUT).
796
+ */
797
+ operator: 'FILLED_OUT' | 'NOT_FILLED_OUT';
798
+ /**
799
+ * Specifies the criteria for refining the filter by pruning.
800
+ */
801
+ pruningRefineBy?: PublicNumOccurrencesRefineBy | PublicSetOccurrencesRefineBy | PublicRelativeComparativeTimestampRefineBy | PublicRelativeRangedTimestampRefineBy | PublicAbsoluteComparativeTimestampRefineBy | PublicAbsoluteRangedTimestampRefineBy | PublicAllHistoryRefineBy | PublicTimePointOperation | PublicRangedTimeOperation;
802
+ }
803
+ interface PublicFormSubmissionOnPageFilter {
804
+ /**
805
+ * Defines the criteria for refining the filter by coalescing.
806
+ */
807
+ coalescingRefineBy?: PublicNumOccurrencesRefineBy | PublicSetOccurrencesRefineBy | PublicRelativeComparativeTimestampRefineBy | PublicRelativeRangedTimestampRefineBy | PublicAbsoluteComparativeTimestampRefineBy | PublicAbsoluteRangedTimestampRefineBy | PublicAllHistoryRefineBy | PublicTimePointOperation | PublicRangedTimeOperation;
808
+ /**
809
+ * Indicates the type of filter (FORM_SUBMISSION_ON_PAGE).
810
+ */
811
+ filterType: 'FORM_SUBMISSION_ON_PAGE';
812
+ /**
813
+ * The ID of the form associated with the submission filter.
814
+ */
815
+ formId?: string;
816
+ /**
817
+ * Specifies the operation to be applied (FILLED_OUT, NOT_FILLED_OUT).
818
+ */
819
+ operator: 'FILLED_OUT' | 'NOT_FILLED_OUT';
820
+ /**
821
+ * The ID of the page where the form submission occurred.
822
+ */
823
+ pageId: string;
824
+ /**
825
+ * Specifies the criteria for refining the filter by pruning.
826
+ */
827
+ pruningRefineBy?: PublicNumOccurrencesRefineBy | PublicSetOccurrencesRefineBy | PublicRelativeComparativeTimestampRefineBy | PublicRelativeRangedTimestampRefineBy | PublicAbsoluteComparativeTimestampRefineBy | PublicAbsoluteRangedTimestampRefineBy | PublicAllHistoryRefineBy | PublicTimePointOperation | PublicRangedTimeOperation;
828
+ }
829
+ interface PublicIndexedTimePoint {
830
+ /**
831
+ * Specifies the reference point in time for the indexed time point.
832
+ */
833
+ indexReference: PublicNowReference | PublicTodayReference | PublicWeekReference | PublicFiscalQuarterReference | PublicFiscalYearReference | PublicYearReference | PublicQuarterReference | PublicMonthReference;
834
+ offset?: PublicIndexOffset;
835
+ /**
836
+ * Defines the type of time (INDEXED).
837
+ */
838
+ timeType: 'INDEXED';
839
+ /**
840
+ * Specifies the source of the time zone information for the indexed time point (CUSTOM, USER, PORTAL).
841
+ */
842
+ timezoneSource?: string;
843
+ /**
844
+ * Indicates the identifier for the time zone associated with the indexed time point.
845
+ */
846
+ zoneId: string;
847
+ }
848
+ interface PublicIndexOffset {
849
+ /**
850
+ * The number of days to offset.
851
+ */
852
+ days?: number;
853
+ /**
854
+ * The number of hours to offset.
855
+ */
856
+ hours?: number;
857
+ /**
858
+ * The number of milliseconds to offset.
859
+ */
860
+ milliseconds?: number;
861
+ /**
862
+ * The number of minutes to offset.
863
+ */
864
+ minutes?: number;
865
+ /**
866
+ * The number of months to offset.
867
+ */
868
+ months?: number;
869
+ /**
870
+ * The number of quarters to offset.
871
+ */
872
+ quarters?: number;
873
+ /**
874
+ * The number of seconds to offset.
875
+ */
876
+ seconds?: number;
877
+ /**
878
+ * The number of weeks to offset.
879
+ */
880
+ weeks?: number;
881
+ /**
882
+ * The number of years to offset.
883
+ */
884
+ years?: number;
885
+ }
886
+ interface PublicInListFilter {
887
+ /**
888
+ * Indicates the type of filter being applied (IN_LIST).
889
+ */
890
+ filterType: 'IN_LIST';
891
+ /**
892
+ * The ID of the list used in the association filter.
893
+ */
894
+ listId: string;
895
+ metadata?: PublicInListFilterMetadata;
896
+ /**
897
+ * Specifies the operation to be performed by the filter (IN_LIST, NOT_IN_LIST).
898
+ */
899
+ operator: string;
900
+ }
901
+ interface PublicInListFilterMetadata {
902
+ /**
903
+ * The identifier for the filter metadata.
904
+ */
905
+ id: string;
906
+ /**
907
+ * Specifies the type of list for the filter (WORKFLOWS_ENROLLMENT, WORKFLOWS_ACTIVE, WORKFLOWS_GOAL, WORKFLOWS_COMPLETED, IMPORT, DATASET, DATASETS).
908
+ */
909
+ inListType: string;
910
+ }
911
+ interface PublicIntegrationEventFilter {
912
+ /**
913
+ * The ID representing the type of event for the integration event filter.
914
+ */
915
+ eventTypeId: number;
916
+ filterLines: PublicEventFilterMetadata[];
917
+ /**
918
+ * Indicates the type of filter (INTEGRATION_EVENT).
919
+ */
920
+ filterType: 'INTEGRATION_EVENT';
921
+ }
922
+ interface PublicListConversionDate {
923
+ /**
924
+ * Specifies the type of conversion (CONVERSION_DATE).
925
+ */
926
+ conversionType: 'CONVERSION_DATE';
927
+ /**
928
+ * The day component of the conversion date.
929
+ */
930
+ day: number;
931
+ /**
932
+ * The month component of the conversion date.
933
+ */
934
+ month: number;
935
+ /**
936
+ * The year component of the conversion date.
937
+ */
938
+ year: number;
939
+ }
940
+ interface PublicListConversionInactivity {
941
+ /**
942
+ * Specifies the type of conversion (INACTIVITY).
943
+ */
944
+ conversionType: 'INACTIVITY';
945
+ /**
946
+ * Value used to paginate through lists. The `offset` provided in the response can be used in the next request to fetch the next page of results. Defaults to `0` if no offset is provided.
947
+ */
948
+ offset: number;
949
+ /**
950
+ * The unit of time for the inactivity period, such as (DAY, MONTH, WEEK).
951
+ */
952
+ timeUnit: 'DAY' | 'MONTH' | 'WEEK';
953
+ }
954
+ interface PublicListConversionResponse {
955
+ /**
956
+ * The date and time when the list was converted.
957
+ */
958
+ convertedAt?: string;
959
+ /**
960
+ * The unique identifier of the list for which the conversion details are provided.
961
+ */
962
+ listId: string;
963
+ /**
964
+ * The scheduled time for the list conversion, which can be based on a specific date or inactivity period.
965
+ */
966
+ requestedConversionTime?: PublicListConversionDate | PublicListConversionInactivity;
967
+ }
968
+ type PublicListConversionTime = PublicListConversionDate | PublicListConversionInactivity;
969
+ interface PublicListFolder {
970
+ /**
971
+ * An array of list Id's contained in this folder.
972
+ */
973
+ childLists: number[];
974
+ childNodes: PublicListFolder[];
975
+ /**
976
+ * The time the folder was created at.
977
+ */
978
+ createdAt?: string;
979
+ /**
980
+ * The Id of the folder.
981
+ */
982
+ id: string;
983
+ /**
984
+ * The name of the folder.
985
+ */
986
+ name?: string;
987
+ /**
988
+ * The Id of the folder this folder is in, the root folder is represented as 0.
989
+ */
990
+ parentFolderId: string;
991
+ /**
992
+ * The time the folder was last updated at.
993
+ */
994
+ updatedAt?: string;
995
+ /**
996
+ * The time that the contents of the folder was last updated at.
997
+ */
998
+ updatedContentsAt?: string;
999
+ /**
1000
+ * The user Id of the owner of the folder.
1001
+ */
1002
+ userId?: number;
1003
+ }
1004
+ interface PublicListPermissions {
1005
+ teamsWithEditAccess: number[];
1006
+ usersWithEditAccess: number[];
1007
+ }
1008
+ interface PublicMembershipSettings {
1009
+ /**
1010
+ * Indicates whether unassigned memberships should be included.
1011
+ */
1012
+ includeUnassigned?: boolean;
1013
+ /**
1014
+ * The ID of the team associated with the membership.
1015
+ */
1016
+ membershipTeamId?: number;
1017
+ }
1018
+ interface PublicMigrationMapping {
1019
+ /**
1020
+ * The legacy list id for the list
1021
+ */
1022
+ legacyListId: string;
1023
+ /**
1024
+ * The V3 list id for the list
1025
+ */
1026
+ listId: string;
1027
+ }
1028
+ interface PublicMonthReference {
1029
+ /**
1030
+ * The day component of the month reference.
1031
+ */
1032
+ day: number;
1033
+ /**
1034
+ * The hour component of the month reference.
1035
+ */
1036
+ hour?: number;
1037
+ /**
1038
+ * The millisecond component of the month reference.
1039
+ */
1040
+ millisecond?: number;
1041
+ /**
1042
+ * The minute component of the month reference.
1043
+ */
1044
+ minute?: number;
1045
+ /**
1046
+ * Indicates the type of reference, (MONTH).
1047
+ */
1048
+ referenceType: 'MONTH';
1049
+ /**
1050
+ * The second component of the month reference.
1051
+ */
1052
+ second?: number;
1053
+ }
1054
+ interface PublicMultiStringPropertyOperation {
1055
+ /**
1056
+ * Indicates whether objects with no value set for the property should be included in the operation.
1057
+ */
1058
+ includeObjectsWithNoValueSet: boolean;
1059
+ /**
1060
+ * Specifies the type of operation (MULTISTRING).
1061
+ */
1062
+ operationType: 'MULTISTRING';
1063
+ /**
1064
+ * Defines the operation to be applied in the multi-string property operation (IS_EQUAL_TO, IS_NOT_EQUAL_TO, CONTAINS, CONTAINS_EXACTLY, DOES_NOT_CONTAIN, DOES_NOT_CONTAIN_EXACTLY, STARTS_WITH, ENDS_WITH).
1065
+ */
1066
+ operator: string;
1067
+ values: string[];
1068
+ }
1069
+ interface PublicNotAllFilterBranch {
1070
+ filterBranches: (PublicOrFilterBranch | PublicAndFilterBranch | PublicNotAllFilterBranch | PublicNotAnyFilterBranch | PublicRestrictedFilterBranch | PublicUnifiedEventsFilterBranch | PublicPropertyAssociationFilterBranch | PublicAssociationFilterBranch)[];
1071
+ /**
1072
+ * The operator used to combine filters within the branch (NOT_ALL).
1073
+ */
1074
+ filterBranchOperator: string;
1075
+ /**
1076
+ * The type of the filter branch (NOT_ALL).
1077
+ */
1078
+ filterBranchType: 'NOT_ALL';
1079
+ filters: (PublicPropertyFilter | PublicAssociationInListFilter | PublicPageViewAnalyticsFilter | PublicCtaAnalyticsFilter | PublicEventAnalyticsFilter | PublicFormSubmissionFilter | PublicFormSubmissionOnPageFilter | PublicIntegrationEventFilter | PublicEmailSubscriptionFilter | PublicCommunicationSubscriptionFilter | PublicCampaignInfluencedFilter | PublicSurveyMonkeyFilter | PublicSurveyMonkeyValueFilter | PublicWebinarFilter | PublicEmailEventFilter | PublicPrivacyAnalyticsFilter | PublicAdsSearchFilter | PublicAdsTimeFilter | PublicInListFilter | PublicNumAssociationsFilter | PublicUnifiedEventsFilter | PublicPropertyAssociationInListFilter | PublicConstantFilter)[];
1080
+ }
1081
+ interface PublicNotAnyFilterBranch {
1082
+ filterBranches: (PublicOrFilterBranch | PublicAndFilterBranch | PublicNotAllFilterBranch | PublicNotAnyFilterBranch | PublicRestrictedFilterBranch | PublicUnifiedEventsFilterBranch | PublicPropertyAssociationFilterBranch | PublicAssociationFilterBranch)[];
1083
+ /**
1084
+ * Specifies the logical operator used to combine filters within the branch (NOT_ANY).
1085
+ */
1086
+ filterBranchOperator: string;
1087
+ /**
1088
+ * Indicates the type of filter branch (NOT_ANY).
1089
+ */
1090
+ filterBranchType: 'NOT_ANY';
1091
+ filters: (PublicPropertyFilter | PublicAssociationInListFilter | PublicPageViewAnalyticsFilter | PublicCtaAnalyticsFilter | PublicEventAnalyticsFilter | PublicFormSubmissionFilter | PublicFormSubmissionOnPageFilter | PublicIntegrationEventFilter | PublicEmailSubscriptionFilter | PublicCommunicationSubscriptionFilter | PublicCampaignInfluencedFilter | PublicSurveyMonkeyFilter | PublicSurveyMonkeyValueFilter | PublicWebinarFilter | PublicEmailEventFilter | PublicPrivacyAnalyticsFilter | PublicAdsSearchFilter | PublicAdsTimeFilter | PublicInListFilter | PublicNumAssociationsFilter | PublicUnifiedEventsFilter | PublicPropertyAssociationInListFilter | PublicConstantFilter)[];
1092
+ }
1093
+ interface PublicNowReference {
1094
+ /**
1095
+ * The hour component of the current time reference.
1096
+ */
1097
+ hour?: number;
1098
+ /**
1099
+ * The millisecond component of the current time reference.
1100
+ */
1101
+ millisecond?: number;
1102
+ /**
1103
+ * The minute component of the current time reference.
1104
+ */
1105
+ minute?: number;
1106
+ /**
1107
+ * Indicates the type of reference (NOW).
1108
+ */
1109
+ referenceType: 'NOW';
1110
+ /**
1111
+ * The second component of the current time reference.
1112
+ */
1113
+ second?: number;
1114
+ }
1115
+ interface PublicNumAssociationsFilter {
1116
+ /**
1117
+ * Defines the category of the association (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK).
1118
+ */
1119
+ associationCategory: string;
1120
+ /**
1121
+ * The ID representing the type of association being filtered.
1122
+ */
1123
+ associationTypeId: number;
1124
+ /**
1125
+ * Specifies the criteria for refining the association filter.
1126
+ */
1127
+ coalescingRefineBy: PublicNumOccurrencesRefineBy | PublicSetOccurrencesRefineBy | PublicRelativeComparativeTimestampRefineBy | PublicRelativeRangedTimestampRefineBy | PublicAbsoluteComparativeTimestampRefineBy | PublicAbsoluteRangedTimestampRefineBy | PublicAllHistoryRefineBy | PublicTimePointOperation | PublicRangedTimeOperation;
1128
+ /**
1129
+ * Indicates the type of filter being applied (NUM_ASSOCIATIONS).
1130
+ */
1131
+ filterType: 'NUM_ASSOCIATIONS';
1132
+ }
1133
+ interface PublicNumberPropertyOperation {
1134
+ /**
1135
+ * Indicates whether objects with no value set for the property should be included in the operation.
1136
+ */
1137
+ includeObjectsWithNoValueSet: boolean;
1138
+ /**
1139
+ * Specifies the type of operation (NUMBER).
1140
+ */
1141
+ operationType: 'NUMBER';
1142
+ /**
1143
+ * Defines the operation to be applied in the number property operation (IS_EQUAL_TO, IS_NOT_EQUAL_TO, IS_GREATER_THAN, IS_GREATER_THAN_OR_EQUAL_TO, IS_LESS_THAN, IS_LESS_THAN_OR_EQUAL_TO, HAS_EVER_BEEN_EQUAL_TO, HAS_NEVER_BEEN_EQUAL_TO).
1144
+ */
1145
+ operator: string;
1146
+ /**
1147
+ * The numeric value to be used in the operation.
1148
+ */
1149
+ value: number;
1150
+ }
1151
+ interface PublicNumOccurrencesRefineBy {
1152
+ /**
1153
+ * The maximum number of occurrences allowed.
1154
+ */
1155
+ maxOccurrences?: number;
1156
+ /**
1157
+ * The minimum number of occurrences required.
1158
+ */
1159
+ minOccurrences?: number;
1160
+ /**
1161
+ * The type of refinement (NUM_OCCURRENCES).
1162
+ */
1163
+ type: 'NUM_OCCURRENCES';
1164
+ }
1165
+ interface PublicObjectList {
1166
+ /**
1167
+ * The time when the list was created.
1168
+ */
1169
+ createdAt?: string;
1170
+ /**
1171
+ * The ID of the user that created the list.
1172
+ */
1173
+ createdById?: string;
1174
+ /**
1175
+ * The time when the list was deleted.
1176
+ */
1177
+ deletedAt?: string;
1178
+ /**
1179
+ * Defines the filter criteria for the list, allowing for complex logical operations and nested filter branches to determine list membership.
1180
+ */
1181
+ filterBranch?: PublicOrFilterBranch | PublicAndFilterBranch | PublicNotAllFilterBranch | PublicNotAnyFilterBranch | PublicRestrictedFilterBranch | PublicUnifiedEventsFilterBranch | PublicPropertyAssociationFilterBranch | PublicAssociationFilterBranch;
1182
+ /**
1183
+ * The time when the filters for this list were last updated.
1184
+ */
1185
+ filtersUpdatedAt?: string;
1186
+ /**
1187
+ * The **ILS ID** of the list.
1188
+ */
1189
+ listId: string;
1190
+ listPermissions?: PublicListPermissions;
1191
+ /**
1192
+ * The version of the list.
1193
+ */
1194
+ listVersion: number;
1195
+ membershipSettings?: PublicMembershipSettings;
1196
+ /**
1197
+ * The name of the list.
1198
+ */
1199
+ name: string;
1200
+ /**
1201
+ * The object type of the list.
1202
+ */
1203
+ objectTypeId: string;
1204
+ /**
1205
+ * The processing status of the list.
1206
+ */
1207
+ processingStatus: string;
1208
+ /**
1209
+ * The processing type of the list.
1210
+ */
1211
+ processingType: string;
1212
+ /**
1213
+ * Size of the list
1214
+ */
1215
+ size?: number;
1216
+ /**
1217
+ * The time the list was last updated.
1218
+ */
1219
+ updatedAt?: string;
1220
+ /**
1221
+ * The ID of the user that last updated the list.
1222
+ */
1223
+ updatedById?: string;
1224
+ }
1225
+ interface PublicObjectListSearchResult {
1226
+ /**
1227
+ * The name and value of any additional properties that exist for this list and that were included in the search request.
1228
+ */
1229
+ additionalProperties: Record<string, string>;
1230
+ /**
1231
+ * The time when the list was created.
1232
+ */
1233
+ createdAt?: string;
1234
+ /**
1235
+ * The ID of the user that created the list.
1236
+ */
1237
+ createdById?: string;
1238
+ /**
1239
+ * The time when the list was deleted.
1240
+ */
1241
+ deletedAt?: string;
1242
+ /**
1243
+ * The time when the filters for this list were last updated.
1244
+ */
1245
+ filtersUpdatedAt?: string;
1246
+ /**
1247
+ * The **ILS ID** of the list.
1248
+ */
1249
+ listId: string;
1250
+ /**
1251
+ * The version of the list.
1252
+ */
1253
+ listVersion: number;
1254
+ /**
1255
+ * The name of the list.
1256
+ */
1257
+ name: string;
1258
+ /**
1259
+ * The object type of the list.
1260
+ */
1261
+ objectTypeId: string;
1262
+ /**
1263
+ * The processing status of the list.
1264
+ */
1265
+ processingStatus: string;
1266
+ /**
1267
+ * The processing type of the list.
1268
+ */
1269
+ processingType: string;
1270
+ /**
1271
+ * The time the list was last updated.
1272
+ */
1273
+ updatedAt?: string;
1274
+ /**
1275
+ * The ID of the user that last updated the list.
1276
+ */
1277
+ updatedById?: string;
1278
+ }
1279
+ interface PublicOrFilterBranch {
1280
+ filterBranches: (PublicOrFilterBranch | PublicAndFilterBranch | PublicNotAllFilterBranch | PublicNotAnyFilterBranch | PublicRestrictedFilterBranch | PublicUnifiedEventsFilterBranch | PublicPropertyAssociationFilterBranch | PublicAssociationFilterBranch)[];
1281
+ /**
1282
+ * The logical operator used to combine the filters within the branch (OR).
1283
+ */
1284
+ filterBranchOperator: string;
1285
+ /**
1286
+ * The type of the filter branch (OR).
1287
+ */
1288
+ filterBranchType: 'OR';
1289
+ filters: (PublicPropertyFilter | PublicAssociationInListFilter | PublicPageViewAnalyticsFilter | PublicCtaAnalyticsFilter | PublicEventAnalyticsFilter | PublicFormSubmissionFilter | PublicFormSubmissionOnPageFilter | PublicIntegrationEventFilter | PublicEmailSubscriptionFilter | PublicCommunicationSubscriptionFilter | PublicCampaignInfluencedFilter | PublicSurveyMonkeyFilter | PublicSurveyMonkeyValueFilter | PublicWebinarFilter | PublicEmailEventFilter | PublicPrivacyAnalyticsFilter | PublicAdsSearchFilter | PublicAdsTimeFilter | PublicInListFilter | PublicNumAssociationsFilter | PublicUnifiedEventsFilter | PublicPropertyAssociationInListFilter | PublicConstantFilter)[];
1290
+ }
1291
+ interface PublicPageViewAnalyticsFilter {
1292
+ /**
1293
+ * Specifies the criteria for refining the filter by coalescing.
1294
+ */
1295
+ coalescingRefineBy?: PublicNumOccurrencesRefineBy | PublicSetOccurrencesRefineBy | PublicRelativeComparativeTimestampRefineBy | PublicRelativeRangedTimestampRefineBy | PublicAbsoluteComparativeTimestampRefineBy | PublicAbsoluteRangedTimestampRefineBy | PublicAllHistoryRefineBy | PublicTimePointOperation | PublicRangedTimeOperation;
1296
+ /**
1297
+ * Indicates whether tracking is enabled for the page view.
1298
+ */
1299
+ enableTracking?: boolean;
1300
+ /**
1301
+ * Indicates the type of filter being applied (PAGE_VIEW).
1302
+ */
1303
+ filterType: 'PAGE_VIEW';
1304
+ /**
1305
+ * Defines the operation to be applied within the filter (HAS_PAGEVIEW_EQ, HAS_PAGEVIEW_CONTAINS, HAS_PAGEVIEW_MATCHES_REGEX, NOT_HAS_PAGEVIEW_EQ, NOT_HAS_PAGEVIEW_CONTAINS).
1306
+ */
1307
+ operator: string;
1308
+ /**
1309
+ * The URL of the page to be used in the filter.
1310
+ */
1311
+ pageUrl: string;
1312
+ /**
1313
+ * Specifies the criteria for refining the filter by pruning.
1314
+ */
1315
+ pruningRefineBy?: PublicNumOccurrencesRefineBy | PublicSetOccurrencesRefineBy | PublicRelativeComparativeTimestampRefineBy | PublicRelativeRangedTimestampRefineBy | PublicAbsoluteComparativeTimestampRefineBy | PublicAbsoluteRangedTimestampRefineBy | PublicAllHistoryRefineBy | PublicTimePointOperation | PublicRangedTimeOperation;
1316
+ }
1317
+ interface PublicPrivacyAnalyticsFilter {
1318
+ /**
1319
+ * Specifies the type of filter (PRIVACY).
1320
+ */
1321
+ filterType: 'PRIVACY';
1322
+ /**
1323
+ * Defines the operation to be applied within the filter (PRIVACY_CONSENT_GRANTED, PRIVACY_CONSENT_NOT_GRANTED).
1324
+ */
1325
+ operator: string;
1326
+ /**
1327
+ * The name of the privacy setting used in the filter.
1328
+ */
1329
+ privacyName: string;
1330
+ }
1331
+ interface PublicPropertyAssociationFilterBranch {
1332
+ filterBranches: (PublicOrFilterBranch | PublicAndFilterBranch | PublicNotAllFilterBranch | PublicNotAnyFilterBranch | PublicRestrictedFilterBranch | PublicUnifiedEventsFilterBranch | PublicPropertyAssociationFilterBranch | PublicAssociationFilterBranch)[];
1333
+ /**
1334
+ * The logical operator used to combine filters within the branch.
1335
+ */
1336
+ filterBranchOperator: string;
1337
+ /**
1338
+ * The type of the filter branch (PROPERTY_ASSOCIATION).
1339
+ */
1340
+ filterBranchType: 'PROPERTY_ASSOCIATION';
1341
+ filters: (PublicPropertyFilter | PublicAssociationInListFilter | PublicPageViewAnalyticsFilter | PublicCtaAnalyticsFilter | PublicEventAnalyticsFilter | PublicFormSubmissionFilter | PublicFormSubmissionOnPageFilter | PublicIntegrationEventFilter | PublicEmailSubscriptionFilter | PublicCommunicationSubscriptionFilter | PublicCampaignInfluencedFilter | PublicSurveyMonkeyFilter | PublicSurveyMonkeyValueFilter | PublicWebinarFilter | PublicEmailEventFilter | PublicPrivacyAnalyticsFilter | PublicAdsSearchFilter | PublicAdsTimeFilter | PublicInListFilter | PublicNumAssociationsFilter | PublicUnifiedEventsFilter | PublicPropertyAssociationInListFilter | PublicConstantFilter)[];
1342
+ /**
1343
+ * The ID representing the type of object associated with the filter branch.
1344
+ */
1345
+ objectTypeId: string;
1346
+ /**
1347
+ * Defines the operation to be applied within the filter branch (IN_LIST, NOT_IN_LIST).
1348
+ */
1349
+ operator: string;
1350
+ /**
1351
+ * The property that is associated with the object ID in the filter branch.
1352
+ */
1353
+ propertyWithObjectId: string;
1354
+ }
1355
+ interface PublicPropertyAssociationInListFilter {
1356
+ /**
1357
+ * Specifies the criteria for refining the filter by coalescing.
1358
+ */
1359
+ coalescingRefineBy: PublicNumOccurrencesRefineBy | PublicSetOccurrencesRefineBy | PublicRelativeComparativeTimestampRefineBy | PublicRelativeRangedTimestampRefineBy | PublicAbsoluteComparativeTimestampRefineBy | PublicAbsoluteRangedTimestampRefineBy | PublicAllHistoryRefineBy | PublicTimePointOperation | PublicRangedTimeOperation;
1360
+ /**
1361
+ * Indicates the type of filter being applied (PROPERTY_ASSOCIATION).
1362
+ */
1363
+ filterType: 'PROPERTY_ASSOCIATION';
1364
+ /**
1365
+ * The ID of the list used in the property association filter.
1366
+ */
1367
+ listId: string;
1368
+ /**
1369
+ * Defines the operation to be applied by the filter (IN_LIST, NOT_IN_LIST).
1370
+ */
1371
+ operator: string;
1372
+ /**
1373
+ * The property associated with the object ID in the filter.
1374
+ */
1375
+ propertyWithObjectId: string;
1376
+ /**
1377
+ * The ID representing the type of object that the property association filter is targeting.
1378
+ */
1379
+ toObjectTypeId?: string;
1380
+ }
1381
+ interface PublicPropertyFilter {
1382
+ /**
1383
+ * Indicates that the filter (PROPERTY).
1384
+ */
1385
+ filterType: 'PROPERTY';
1386
+ /**
1387
+ * Defines the operation to be performed on the property, such as comparison or value matching.
1388
+ */
1389
+ operation: PublicBoolPropertyOperation | PublicNumberPropertyOperation | PublicStringPropertyOperation | PublicDateTimePropertyOperation | PublicRangedDatePropertyOperation | PublicComparativePropertyUpdatedOperation | PublicComparativeDatePropertyOperation | PublicRollingDateRangePropertyOperation | PublicRollingPropertyUpdatedOperation | PublicEnumerationPropertyOperation | PublicAllPropertyTypesOperation | PublicRangedNumberPropertyOperation | PublicMultiStringPropertyOperation | PublicDatePropertyOperation | PublicCalendarDatePropertyOperation | PublicTimePointOperation | PublicRangedTimeOperation;
1390
+ /**
1391
+ * Specifies the name of the property that the filter is applied to.
1392
+ */
1393
+ property: string;
1394
+ }
1395
+ interface PublicPropertyReferencedTime {
1396
+ /**
1397
+ * Specifies the name of the property that the time reference is applied to.
1398
+ */
1399
+ property: string;
1400
+ /**
1401
+ * Specifies the type of reference for the property (VALUE, UPDATED_AT, ANNIVERSARY, VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION, ANNIVERSARY_WITH_ZONE_SAME_LOCAL_CONVERSION).
1402
+ */
1403
+ referenceType: string;
1404
+ /**
1405
+ * Defines the type of time (PROPERTY_REFERENCED).
1406
+ */
1407
+ timeType: 'PROPERTY_REFERENCED';
1408
+ /**
1409
+ * Specifies the source of the time zone information for the property (CUSTOM, USER, PORTAL).
1410
+ */
1411
+ timezoneSource?: string;
1412
+ /**
1413
+ * Indicates the identifier for the time zone associated with the property.
1414
+ */
1415
+ zoneId: string;
1416
+ }
1417
+ interface PublicQuarterReference {
1418
+ /**
1419
+ * The day component of the quarter reference.
1420
+ */
1421
+ day: number;
1422
+ /**
1423
+ * The hour component of the quarter reference.
1424
+ */
1425
+ hour?: number;
1426
+ /**
1427
+ * The millisecond component of the quarter reference.
1428
+ */
1429
+ millisecond?: number;
1430
+ /**
1431
+ * The minute component of the quarter reference.
1432
+ */
1433
+ minute?: number;
1434
+ /**
1435
+ * The month component of the quarter reference.
1436
+ */
1437
+ month: number;
1438
+ /**
1439
+ * Indicates the type of reference (QUARTER).
1440
+ */
1441
+ referenceType: 'QUARTER';
1442
+ /**
1443
+ * The second component of the quarter reference.
1444
+ */
1445
+ second?: number;
1446
+ }
1447
+ interface PublicRangedDatePropertyOperation {
1448
+ /**
1449
+ * Specifies whether objects without a set value should be included in the operation.
1450
+ */
1451
+ includeObjectsWithNoValueSet: boolean;
1452
+ /**
1453
+ * The lower limit of the date range for the operation.
1454
+ */
1455
+ lowerBound: number;
1456
+ /**
1457
+ * Specifies the type of operation (RANGED_DATE).
1458
+ */
1459
+ operationType: 'RANGED_DATE';
1460
+ /**
1461
+ * Defines the operation to be applied in the ranged date property operation (IS_BETWEEN, IS_NOT_BETWEEN).
1462
+ */
1463
+ operator: string;
1464
+ /**
1465
+ * Indicates whether the operation requires conversion to a different time zone.
1466
+ */
1467
+ requiresTimeZoneConversion: boolean;
1468
+ /**
1469
+ * The upper limit of the date range for the operation.
1470
+ */
1471
+ upperBound: number;
1472
+ }
1473
+ interface PublicRangedNumberPropertyOperation {
1474
+ /**
1475
+ * Indicates whether objects with no value set for the property should be included in the operation.
1476
+ */
1477
+ includeObjectsWithNoValueSet: boolean;
1478
+ /**
1479
+ * The lower limit of the number range for the operation.
1480
+ */
1481
+ lowerBound: number;
1482
+ /**
1483
+ * Specifies the type of operation (NUMBER_RANGED).
1484
+ */
1485
+ operationType: 'NUMBER_RANGED';
1486
+ /**
1487
+ * Defines the operation to be applied in the ranged number property operation (IS_BETWEEN, IS_NOT_BETWEEN).
1488
+ */
1489
+ operator: string;
1490
+ /**
1491
+ * The upper limit of the number range for the operation.
1492
+ */
1493
+ upperBound: number;
1494
+ }
1495
+ interface PublicRangedTimeOperation {
1496
+ /**
1497
+ * Indicates whether objects with no value set for the property should be included in the operation.
1498
+ */
1499
+ includeObjectsWithNoValueSet: boolean;
1500
+ /**
1501
+ * Describes the behavior at the lower bound endpoint of the time range.
1502
+ */
1503
+ lowerBoundEndpointBehavior?: string;
1504
+ /**
1505
+ * Defines the lower bound time point for the operation.
1506
+ */
1507
+ lowerBoundTimePoint: PublicDatePoint | PublicIndexedTimePoint | PublicPropertyReferencedTime;
1508
+ /**
1509
+ * Specifies the type of operation (TIME_RANGED).
1510
+ */
1511
+ operationType: string;
1512
+ /**
1513
+ * Defines the operation to be applied within the time range (IS_BETWEEN, IS_NOT_BETWEEN).
1514
+ */
1515
+ operator: string;
1516
+ /**
1517
+ * Specifies the parser used for the property in the operation.
1518
+ */
1519
+ propertyParser?: string;
1520
+ /**
1521
+ * Specifies the type of operation (TIME_RANGED).
1522
+ */
1523
+ type: 'TIME_RANGED';
1524
+ /**
1525
+ * Describes the behavior at the upper bound endpoint of the time range.
1526
+ */
1527
+ upperBoundEndpointBehavior?: string;
1528
+ /**
1529
+ * Defines the upper bound time point for the operation.
1530
+ */
1531
+ upperBoundTimePoint: PublicDatePoint | PublicIndexedTimePoint | PublicPropertyReferencedTime;
1532
+ }
1533
+ interface PublicRelativeComparativeTimestampRefineBy {
1534
+ /**
1535
+ * Defines the comparison operation to be used in the refinement (BEFORE, AFTER).
1536
+ */
1537
+ comparison: string;
1538
+ timeOffset: PublicTimeOffset;
1539
+ /**
1540
+ * Specifies the type of refinement, (RELATIVE_COMPARATIVE).
1541
+ */
1542
+ type: 'RELATIVE_COMPARATIVE';
1543
+ }
1544
+ interface PublicRelativeRangedTimestampRefineBy {
1545
+ lowerBoundOffset: PublicTimeOffset;
1546
+ /**
1547
+ * Specifies the type of range for the refinement criteria (BETWEEN, NOT_BETWEEN).
1548
+ */
1549
+ rangeType: string;
1550
+ /**
1551
+ * Indicates the type of refinement (RELATIVE_RANGED).
1552
+ */
1553
+ type: 'RELATIVE_RANGED';
1554
+ upperBoundOffset: PublicTimeOffset;
1555
+ }
1556
+ interface PublicRestrictedFilterBranch {
1557
+ filterBranches: (PublicOrFilterBranch | PublicAndFilterBranch | PublicNotAllFilterBranch | PublicNotAnyFilterBranch | PublicRestrictedFilterBranch | PublicUnifiedEventsFilterBranch | PublicPropertyAssociationFilterBranch | PublicAssociationFilterBranch)[];
1558
+ /**
1559
+ * The logical operator used to combine filters within the restricted filter branch.
1560
+ */
1561
+ filterBranchOperator: string;
1562
+ /**
1563
+ * Specifies the type of the filter branch (RESTRICTED).
1564
+ */
1565
+ filterBranchType: 'RESTRICTED';
1566
+ filters: (PublicPropertyFilter | PublicAssociationInListFilter | PublicPageViewAnalyticsFilter | PublicCtaAnalyticsFilter | PublicEventAnalyticsFilter | PublicFormSubmissionFilter | PublicFormSubmissionOnPageFilter | PublicIntegrationEventFilter | PublicEmailSubscriptionFilter | PublicCommunicationSubscriptionFilter | PublicCampaignInfluencedFilter | PublicSurveyMonkeyFilter | PublicSurveyMonkeyValueFilter | PublicWebinarFilter | PublicEmailEventFilter | PublicPrivacyAnalyticsFilter | PublicAdsSearchFilter | PublicAdsTimeFilter | PublicInListFilter | PublicNumAssociationsFilter | PublicUnifiedEventsFilter | PublicPropertyAssociationInListFilter | PublicConstantFilter)[];
1567
+ }
1568
+ interface PublicRollingDateRangePropertyOperation {
1569
+ /**
1570
+ * Indicates whether objects with no value set for the property should be included in the operation.
1571
+ */
1572
+ includeObjectsWithNoValueSet: boolean;
1573
+ /**
1574
+ * The number of days to be considered in the rolling date range operation.
1575
+ */
1576
+ numberOfDays: number;
1577
+ /**
1578
+ * Specifies the type of operation (ROLLING_DATE_RANGE).
1579
+ */
1580
+ operationType: 'ROLLING_DATE_RANGE';
1581
+ /**
1582
+ * Defines the operation to be applied within the rolling date range property operation (IS_LESS_THAN_X_DAYS_AGO, IS_MORE_THAN_X_DAYS_AGO, IS_LESS_THAN_X_DAYS_FROM_NOW, IS_MORE_THAN_X_DAYS_FROM_NOW).
1583
+ */
1584
+ operator: string;
1585
+ /**
1586
+ * Specifies whether the operation requires conversion to a different time zone.
1587
+ */
1588
+ requiresTimeZoneConversion: boolean;
1589
+ }
1590
+ interface PublicRollingPropertyUpdatedOperation {
1591
+ /**
1592
+ * Indicates whether objects with no value set for the property should be included in the operation.
1593
+ */
1594
+ includeObjectsWithNoValueSet: boolean;
1595
+ /**
1596
+ * The number of days to be considered in the rolling property updated operation.
1597
+ */
1598
+ numberOfDays: number;
1599
+ /**
1600
+ * Specifies the type of operation (ROLLING_PROPERTY_UPDATED).
1601
+ */
1602
+ operationType: 'ROLLING_PROPERTY_UPDATED';
1603
+ /**
1604
+ * Defines the operation to be applied within the rolling property updated operation (UPDATED_IN_LAST_X_DAYS, NOT_UPDATED_IN_LAST_X_DAYS).
1605
+ */
1606
+ operator: string;
1607
+ }
1608
+ interface PublicSetOccurrencesRefineBy {
1609
+ /**
1610
+ * Indicates the specific set type used in the refinement (ALL, ALL_INCLUDE_EMPTY, ANY, NONE, NONE_EXCLUDE_EMPTY, ANY_INCLUDE_EMPTY).
1611
+ */
1612
+ setType: string;
1613
+ /**
1614
+ * Specifies the type of refinement (SET_OCCURRENCES).
1615
+ */
1616
+ type: 'SET_OCCURRENCES';
1617
+ }
1618
+ interface PublicStringPropertyOperation {
1619
+ /**
1620
+ * Indicates whether objects with no value set for the property should be included in the operation.
1621
+ */
1622
+ includeObjectsWithNoValueSet: boolean;
1623
+ /**
1624
+ * Specifies the type of operation (STRING).
1625
+ */
1626
+ operationType: 'STRING';
1627
+ /**
1628
+ * Defines the operation to be applied in the string property operation ()IS_EQUAL_TO, IS_NOT_EQUAL_TO, CONTAINS, DOES_NOT_CONTAIN, STARTS_WITH, ENDS_WITH, HAS_EVER_BEEN_EQUAL_TO, HAS_NEVER_BEEN_EQUAL_TO, HAS_EVER_CONTAINED, HAS_NEVER_CONTAINED).
1629
+ */
1630
+ operator: string;
1631
+ /**
1632
+ * The string value to be used in the operation.
1633
+ */
1634
+ value: string;
1635
+ }
1636
+ interface PublicSurveyMonkeyFilter {
1637
+ /**
1638
+ * Indicates the type of filter being applied (SURVEY_MONKEY).
1639
+ */
1640
+ filterType: 'SURVEY_MONKEY';
1641
+ /**
1642
+ * Specifies the operation to be performed by the filter (HAS_RESPONDED_TO_SURVEY, HAS_NOT_RESPONDED_TO_SURVEY).
1643
+ */
1644
+ operator: string;
1645
+ /**
1646
+ * The ID of the survey associated with the filter.
1647
+ */
1648
+ surveyId: string;
1649
+ }
1650
+ interface PublicSurveyMonkeyValueFilter {
1651
+ /**
1652
+ * Defines the type of filter (SURVEY_MONKEY_VALUE).
1653
+ */
1654
+ filterType: 'SURVEY_MONKEY_VALUE';
1655
+ /**
1656
+ * Defines the operation to be applied within the filter (HAS_ANSWERED_SURVEY_QUESTION_WITH_VALUE).
1657
+ */
1658
+ operator: string;
1659
+ /**
1660
+ * The column ID of the survey answer used in the filter.
1661
+ */
1662
+ surveyAnswerColId?: string;
1663
+ /**
1664
+ * The row ID of the survey answer used in the filter.
1665
+ */
1666
+ surveyAnswerRowId?: string;
1667
+ /**
1668
+ * The ID of the survey used in the filter.
1669
+ */
1670
+ surveyId: string;
1671
+ /**
1672
+ * The question from the survey used in the filter.
1673
+ */
1674
+ surveyQuestion: string;
1675
+ /**
1676
+ * Specifies the operation used to compare the survey answer value.
1677
+ */
1678
+ valueComparison: PublicBoolPropertyOperation | PublicNumberPropertyOperation | PublicStringPropertyOperation | PublicDateTimePropertyOperation | PublicRangedDatePropertyOperation | PublicComparativePropertyUpdatedOperation | PublicComparativeDatePropertyOperation | PublicRollingDateRangePropertyOperation | PublicRollingPropertyUpdatedOperation | PublicEnumerationPropertyOperation | PublicAllPropertyTypesOperation | PublicRangedNumberPropertyOperation | PublicMultiStringPropertyOperation | PublicDatePropertyOperation | PublicCalendarDatePropertyOperation | PublicTimePointOperation | PublicRangedTimeOperation;
1679
+ }
1680
+ interface PublicTimeOffset {
1681
+ /**
1682
+ * The numerical value representing the quantity of the time offset.
1683
+ */
1684
+ amount: number;
1685
+ /**
1686
+ * Indicates the direction of the time offset, such as forward or backward.
1687
+ */
1688
+ offsetDirection: string;
1689
+ /**
1690
+ * Specifies the unit of time for the offset, such as days, hours, or minutes.
1691
+ */
1692
+ timeUnit: string;
1693
+ }
1694
+ interface PublicTimePointOperation {
1695
+ /**
1696
+ * Describes the behavior at the endpoint of the time point operation.
1697
+ */
1698
+ endpointBehavior?: string;
1699
+ /**
1700
+ * Indicates whether objects with no value set for the property should be included in the operation.
1701
+ */
1702
+ includeObjectsWithNoValueSet: boolean;
1703
+ /**
1704
+ * Specifies the type of operation (TIME_POINT).
1705
+ */
1706
+ operationType: 'TIME_POINT';
1707
+ /**
1708
+ * Specifies the operation to be applied within the time point operation (IS_BEFORE, IS_AFTER).
1709
+ */
1710
+ operator: string;
1711
+ /**
1712
+ * Specifies the parser used for interpreting the property in the operation.
1713
+ */
1714
+ propertyParser?: string;
1715
+ /**
1716
+ * Defines the specific point in time for the operation, which can be a date, indexed time, or property-referenced time.
1717
+ */
1718
+ timePoint: PublicDatePoint | PublicIndexedTimePoint | PublicPropertyReferencedTime;
1719
+ /**
1720
+ * Defines the type of operation being performed.
1721
+ */
1722
+ type: string;
1723
+ }
1724
+ interface PublicTodayReference {
1725
+ /**
1726
+ * The hour component of the current day reference.
1727
+ */
1728
+ hour?: number;
1729
+ /**
1730
+ * The millisecond component of the current day reference.
1731
+ */
1732
+ millisecond?: number;
1733
+ /**
1734
+ * The minute component of the current day reference.
1735
+ */
1736
+ minute?: number;
1737
+ /**
1738
+ * Indicates the type of reference (TODAY).
1739
+ */
1740
+ referenceType: 'TODAY';
1741
+ /**
1742
+ * The second component of the current day reference.
1743
+ */
1744
+ second?: number;
1745
+ }
1746
+ interface PublicUnifiedEventsFilter {
1747
+ /**
1748
+ * Specifies the criteria for refining the filter by coalescing.
1749
+ */
1750
+ coalescingRefineBy?: PublicNumOccurrencesRefineBy | PublicSetOccurrencesRefineBy | PublicRelativeComparativeTimestampRefineBy | PublicRelativeRangedTimestampRefineBy | PublicAbsoluteComparativeTimestampRefineBy | PublicAbsoluteRangedTimestampRefineBy | PublicAllHistoryRefineBy | PublicTimePointOperation | PublicRangedTimeOperation;
1751
+ /**
1752
+ * The identifier for the type of event in the unified events filter.
1753
+ */
1754
+ eventTypeId?: string;
1755
+ filterLines: PublicEventFilterMetadata[];
1756
+ /**
1757
+ * Indicates the type of filter being applied (UNIFIED_EVENTS).
1758
+ */
1759
+ filterType: 'UNIFIED_EVENTS';
1760
+ /**
1761
+ * Specifies the criteria for refining the filter by pruning.
1762
+ */
1763
+ pruningRefineBy?: PublicNumOccurrencesRefineBy | PublicSetOccurrencesRefineBy | PublicRelativeComparativeTimestampRefineBy | PublicRelativeRangedTimestampRefineBy | PublicAbsoluteComparativeTimestampRefineBy | PublicAbsoluteRangedTimestampRefineBy | PublicAllHistoryRefineBy | PublicTimePointOperation | PublicRangedTimeOperation;
1764
+ }
1765
+ interface PublicUnifiedEventsFilterBranch {
1766
+ /**
1767
+ * Specifies the criteria for refining the filter by coalescing.
1768
+ */
1769
+ coalescingRefineBy?: PublicNumOccurrencesRefineBy | PublicSetOccurrencesRefineBy | PublicRelativeComparativeTimestampRefineBy | PublicRelativeRangedTimestampRefineBy | PublicAbsoluteComparativeTimestampRefineBy | PublicAbsoluteRangedTimestampRefineBy | PublicAllHistoryRefineBy | PublicTimePointOperation | PublicRangedTimeOperation;
1770
+ /**
1771
+ * The identifier for the type of event associated with the filter branch.
1772
+ */
1773
+ eventTypeId: string;
1774
+ filterBranches: (PublicOrFilterBranch | PublicAndFilterBranch | PublicNotAllFilterBranch | PublicNotAnyFilterBranch | PublicRestrictedFilterBranch | PublicUnifiedEventsFilterBranch | PublicPropertyAssociationFilterBranch | PublicAssociationFilterBranch)[];
1775
+ /**
1776
+ * The logical operator used to combine filters within the branch (AND).
1777
+ */
1778
+ filterBranchOperator: string;
1779
+ /**
1780
+ * The type of the filter branch (UNIFIED_EVENTS).
1781
+ */
1782
+ filterBranchType: 'UNIFIED_EVENTS';
1783
+ filters: (PublicPropertyFilter | PublicAssociationInListFilter | PublicPageViewAnalyticsFilter | PublicCtaAnalyticsFilter | PublicEventAnalyticsFilter | PublicFormSubmissionFilter | PublicFormSubmissionOnPageFilter | PublicIntegrationEventFilter | PublicEmailSubscriptionFilter | PublicCommunicationSubscriptionFilter | PublicCampaignInfluencedFilter | PublicSurveyMonkeyFilter | PublicSurveyMonkeyValueFilter | PublicWebinarFilter | PublicEmailEventFilter | PublicPrivacyAnalyticsFilter | PublicAdsSearchFilter | PublicAdsTimeFilter | PublicInListFilter | PublicNumAssociationsFilter | PublicUnifiedEventsFilter | PublicPropertyAssociationInListFilter | PublicConstantFilter)[];
1784
+ /**
1785
+ * Defines the operation to be applied within the filter branch (HAS_COMPLETED, HAS_NOT_COMPLETED).
1786
+ */
1787
+ operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED';
1788
+ pruningRefineBy?: PublicNumOccurrencesRefineBy | PublicSetOccurrencesRefineBy | PublicRelativeComparativeTimestampRefineBy | PublicRelativeRangedTimestampRefineBy | PublicAbsoluteComparativeTimestampRefineBy | PublicAbsoluteRangedTimestampRefineBy | PublicAllHistoryRefineBy | PublicTimePointOperation | PublicRangedTimeOperation;
1789
+ }
1790
+ interface PublicWebinarFilter {
1791
+ /**
1792
+ * Indicates the type of filter, (WEBINAR).
1793
+ */
1794
+ filterType: 'WEBINAR';
1795
+ /**
1796
+ * Specifies the operation to be performed by the filter (HAS_WEBINAR_REGISTRATION, NOT_HAS_WEBINAR_REGISTRATION, HAS_WEBINAR_ATTENDANCE, NOT_HAS_WEBINAR_ATTENDANCE).
1797
+ */
1798
+ operator: string;
1799
+ /**
1800
+ * The ID of the webinar associated with the filter.
1801
+ */
1802
+ webinarId?: string;
1803
+ }
1804
+ interface PublicWeekReference {
1805
+ /**
1806
+ * The day of the week (SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY).
1807
+ */
1808
+ dayOfWeek: 'FRIDAY' | 'MONDAY' | 'SATURDAY' | 'SUNDAY' | 'THURSDAY' | 'TUESDAY' | 'WEDNESDAY';
1809
+ /**
1810
+ * The hour component of the week reference.
1811
+ */
1812
+ hour?: number;
1813
+ /**
1814
+ * The millisecond component of the week reference.
1815
+ */
1816
+ millisecond?: number;
1817
+ /**
1818
+ * The minute component of the week reference.
1819
+ */
1820
+ minute?: number;
1821
+ /**
1822
+ * Indicates the type of reference (WEEK).
1823
+ */
1824
+ referenceType: 'WEEK';
1825
+ /**
1826
+ * The second component of the week reference.
1827
+ */
1828
+ second?: number;
1829
+ }
1830
+ interface PublicYearReference {
1831
+ /**
1832
+ * The day component of the year reference.
1833
+ */
1834
+ day: number;
1835
+ /**
1836
+ * The hour component of the year reference.
1837
+ */
1838
+ hour?: number;
1839
+ /**
1840
+ * The millisecond component of the year reference.
1841
+ */
1842
+ millisecond?: number;
1843
+ /**
1844
+ * The minute component of the year reference.
1845
+ */
1846
+ minute?: number;
1847
+ /**
1848
+ * The month component of the year reference.
1849
+ */
1850
+ month: number;
1851
+ /**
1852
+ * Indicates the type of reference (YEAR).
1853
+ */
1854
+ referenceType: 'YEAR';
1855
+ /**
1856
+ * The second component of the year reference.
1857
+ */
1858
+ second?: number;
1859
+ }
1860
+ interface RecordIdInput {
1861
+ objectTypeId: string;
1862
+ recordId: string;
1863
+ }
1864
+ interface RecordIdWithMemberships {
1865
+ objectTypeId: string;
1866
+ recordId: string;
1867
+ recordListMemberships: RecordListMembership[];
1868
+ }
1869
+ interface RecordListMembership {
1870
+ /**
1871
+ * The timestamp when the record was first added to the list.
1872
+ */
1873
+ firstAddedTimestamp: string;
1874
+ /**
1875
+ * Indicates whether the list is public.
1876
+ */
1877
+ isPublicList?: boolean;
1878
+ /**
1879
+ * The timestamp when the record was last added to the list.
1880
+ */
1881
+ lastAddedTimestamp: string;
1882
+ /**
1883
+ * The unique identifier of the list.
1884
+ */
1885
+ listId: string;
1886
+ /**
1887
+ * The version number of the list.
1888
+ */
1889
+ listVersion: number;
1890
+ }
1891
+ }
1892
+ declare namespace CrmLists {
1893
+ interface AddAndRemoveMembershipsInput {
1894
+ data: CRMListsSchemas.MembershipChangeRequest;
1895
+ listId: string;
1896
+ }
1897
+ type AddAndRemoveMembershipsOutput = CRMListsSchemas.MembershipsUpdateResponse;
1898
+ interface AddMembershipsFromInput {
1899
+ listId: string;
1900
+ sourceListId: string;
1901
+ }
1902
+ type AddMembershipsFromOutput = void;
1903
+ interface AddMembershipsInput {
1904
+ data: string[];
1905
+ listId: string;
1906
+ }
1907
+ type AddMembershipsOutput = CRMListsSchemas.MembershipsUpdateResponse;
1908
+ type BatchReadMembershipsInput = CRMListsSchemas.BatchInputRecordIdInput;
1909
+ type BatchReadMembershipsOutput = CRMListsSchemas.BatchResponseRecordIdWithMemberships;
1910
+ type CreateFolderInput = CRMListsSchemas.ListFolderCreateRequest;
1911
+ type CreateFolderOutput = CRMListsSchemas.ListFolderCreateResponse;
1912
+ type CreateIdMappingInput = string[];
1913
+ type CreateIdMappingOutput = CRMListsSchemas.PublicBatchMigrationMapping;
1914
+ type CreateInput = CRMListsSchemas.ListCreateRequest;
1915
+ type CreateOutput = CRMListsSchemas.ListCreateResponse;
1916
+ interface DeleteFolderInput {
1917
+ folderId: string;
1918
+ }
1919
+ type DeleteFolderOutput = void;
1920
+ interface DeleteInput {
1921
+ listId: string;
1922
+ }
1923
+ interface DeleteMembershipsInput {
1924
+ listId: string;
1925
+ }
1926
+ type DeleteMembershipsOutput = void;
1927
+ type DeleteOutput = void;
1928
+ interface GetByObjectTypeAndNameInput {
1929
+ includeFilters?: boolean;
1930
+ listName: string;
1931
+ objectTypeId: string;
1932
+ }
1933
+ type GetByObjectTypeAndNameOutput = CRMListsSchemas.ListFetchResponse;
1934
+ interface GetIdMappingInput {
1935
+ legacyListId?: string;
1936
+ }
1937
+ type GetIdMappingOutput = CRMListsSchemas.PublicMigrationMapping;
1938
+ interface GetInput {
1939
+ includeFilters?: boolean;
1940
+ listId: string;
1941
+ }
1942
+ interface GetMembershipsJoinOrderInput {
1943
+ /**
1944
+ * 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.
1945
+ */
1946
+ after?: string;
1947
+ before?: string;
1948
+ /**
1949
+ * The maximum number of results to display per page.
1950
+ */
1951
+ limit?: number;
1952
+ listId: string;
1953
+ }
1954
+ type GetMembershipsJoinOrderOutput = CRMListsSchemas.ApiCollectionResponseJoinTimeAndRecordId;
1955
+ type GetOutput = CRMListsSchemas.ListFetchResponse;
1956
+ interface GetRecordMembershipsInput {
1957
+ objectTypeId: string;
1958
+ recordId: string;
1959
+ }
1960
+ type GetRecordMembershipsOutput = CRMListsSchemas.ApiCollectionResponseRecordListMembership;
1961
+ interface GetScheduleConversionInput {
1962
+ listId: string;
1963
+ }
1964
+ type GetScheduleConversionOutput = CRMListsSchemas.PublicListConversionResponse;
1965
+ interface GetSizeAndEditsHistoryBetweenInput {
1966
+ endDate?: string;
1967
+ listId: string;
1968
+ startDate?: string;
1969
+ }
1970
+ type GetSizeAndEditsHistoryBetweenOutput = CRMListsSchemas.ListSizeAndEditHistoryResponse;
1971
+ type ListBySearchInput = CRMListsSchemas.ListSearchRequest;
1972
+ type ListBySearchOutput = CRMListsSchemas.ListSearchResponse;
1973
+ interface ListFoldersInput {
1974
+ folderId?: string;
1975
+ }
1976
+ type ListFoldersOutput = CRMListsSchemas.ListFolderFetchResponse;
1977
+ interface ListInput {
1978
+ includeFilters?: boolean;
1979
+ listIds?: string[];
1980
+ }
1981
+ interface ListMembershipsInput {
1982
+ /**
1983
+ * 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.
1984
+ */
1985
+ after?: string;
1986
+ before?: string;
1987
+ /**
1988
+ * The maximum number of results to display per page.
1989
+ */
1990
+ limit?: number;
1991
+ listId: string;
1992
+ }
1993
+ type ListMembershipsOutput = CRMListsSchemas.ApiCollectionResponseJoinTimeAndRecordId;
1994
+ type ListOutput = CRMListsSchemas.ListsByIdResponse;
1995
+ interface MoveFolderInput {
1996
+ folderId: string;
1997
+ newParentFolderId: string;
1998
+ }
1999
+ type MoveFolderOutput = CRMListsSchemas.ListFolderFetchResponse;
2000
+ type MoveListInput = CRMListsSchemas.ListMoveRequest;
2001
+ type MoveListOutput = void;
2002
+ interface RemoveMembershipsInput {
2003
+ data: string[];
2004
+ listId: string;
2005
+ }
2006
+ type RemoveMembershipsOutput = CRMListsSchemas.MembershipsUpdateResponse;
2007
+ interface RenameFolderInput {
2008
+ folderId: string;
2009
+ newFolderName?: string;
2042
2010
  }
2011
+ type RenameFolderOutput = CRMListsSchemas.ListFolderFetchResponse;
2012
+ interface RestoreInput {
2013
+ listId: string;
2014
+ }
2015
+ type RestoreOutput = void;
2016
+ interface ScheduleConversionInput {
2017
+ listId: string;
2018
+ }
2019
+ type ScheduleConversionOutput = void;
2020
+ interface UpdateListFiltersInput {
2021
+ data: CRMListsSchemas.ListFilterUpdateRequest;
2022
+ enrollObjectsInWorkflows?: boolean;
2023
+ listId: string;
2024
+ }
2025
+ type UpdateListFiltersOutput = CRMListsSchemas.ListUpdateResponse;
2026
+ interface UpdateListNameInput {
2027
+ includeFilters?: boolean;
2028
+ listId: string;
2029
+ listName?: string;
2030
+ }
2031
+ type UpdateListNameOutput = CRMListsSchemas.ListUpdateResponse;
2032
+ interface UpdateScheduleConversionInput {
2033
+ data: CRMListsSchemas.PublicListConversionTime;
2034
+ listId: string;
2035
+ }
2036
+ type UpdateScheduleConversionOutput = CRMListsSchemas.PublicListConversionResponse;
2043
2037
  /**
2044
2038
  * Usage example:
2045
2039
  * ```ts
2046
2040
  * import { crmLists } from '@hubspot/api-client-core';
2047
- * client.send(crmLists.basic.addAndRemoveMemberships(input));
2041
+ * client.send(crmLists.addAndRemoveMemberships(input));
2048
2042
  * ```
2049
2043
  */
2050
- interface BasicAPI {
2044
+ interface API {
2051
2045
  /**
2052
2046
  * @apiPath /crm/lists/2026-03/{listId}/memberships/add-and-remove
2053
2047
  * @apiMethod PUT
2054
2048
  * @requiredScopes ils-lists-read, ils-lists-write
2055
2049
  */
2056
- addAndRemoveMemberships: (input: Basic.AddAndRemoveMembershipsInput) => Operation<Basic.AddAndRemoveMembershipsOutput>;
2050
+ addAndRemoveMemberships: (input: AddAndRemoveMembershipsInput) => Operation<AddAndRemoveMembershipsOutput>;
2057
2051
  /**
2058
2052
  * @apiPath /crm/lists/2026-03/{listId}/memberships/add
2059
2053
  * @apiMethod PUT
2060
2054
  * @requiredScopes ils-lists-read, ils-lists-write
2061
2055
  */
2062
- addMemberships: (input: Basic.AddMembershipsInput) => Operation<Basic.AddMembershipsOutput>;
2056
+ addMemberships: (input: AddMembershipsInput) => Operation<AddMembershipsOutput>;
2063
2057
  /**
2064
2058
  * @apiPath /crm/lists/2026-03/{listId}/memberships/add-from/{sourceListId}
2065
2059
  * @apiMethod PUT
2066
2060
  * @requiredScopes ils-lists-read, ils-lists-write
2067
2061
  */
2068
- addMembershipsFrom: (input: Basic.AddMembershipsFromInput) => Operation<Basic.AddMembershipsFromOutput>;
2062
+ addMembershipsFrom: (input: AddMembershipsFromInput) => Operation<AddMembershipsFromOutput>;
2063
+ /**
2064
+ * @apiPath /crm/lists/2026-03/records/memberships/batch/read
2065
+ * @apiMethod POST
2066
+ * @requiredScopes ils-lists-read
2067
+ */
2068
+ batchReadMemberships: (input: BatchReadMembershipsInput) => Operation<BatchReadMembershipsOutput>;
2069
2069
  /**
2070
2070
  * @apiPath /crm/lists/2026-03
2071
2071
  * @apiMethod POST
2072
2072
  * @requiredScopes ils-lists-write
2073
2073
  */
2074
- create: (input: Basic.CreateInput) => Operation<Basic.CreateOutput>;
2074
+ create: (input: CreateInput) => Operation<CreateOutput>;
2075
2075
  /**
2076
2076
  * @apiPath /crm/lists/2026-03/folders
2077
2077
  * @apiMethod POST
2078
2078
  * @requiredScopes ils-lists-read, ils-lists-write
2079
2079
  */
2080
- createFolder: (input: Basic.CreateFolderInput) => Operation<Basic.CreateFolderOutput>;
2080
+ createFolder: (input: CreateFolderInput) => Operation<CreateFolderOutput>;
2081
2081
  /**
2082
2082
  * @apiPath /crm/lists/2026-03/idmapping
2083
2083
  * @apiMethod POST
2084
2084
  * @requiredScopes ils-lists-read
2085
2085
  */
2086
- createIdMapping: (input: Basic.CreateIdMappingInput) => Operation<Basic.CreateIdMappingOutput>;
2086
+ createIdMapping: (input: CreateIdMappingInput) => Operation<CreateIdMappingOutput>;
2087
2087
  /**
2088
2088
  * @apiPath /crm/lists/2026-03/{listId}
2089
2089
  * @apiMethod DELETE
2090
2090
  * @requiredScopes ils-lists-read, ils-lists-write
2091
2091
  */
2092
- delete: (input: Basic.DeleteInput) => Operation<Basic.DeleteOutput>;
2092
+ delete: (input: DeleteInput) => Operation<DeleteOutput>;
2093
2093
  /**
2094
2094
  * @apiPath /crm/lists/2026-03/folders/{folderId}
2095
2095
  * @apiMethod DELETE
2096
2096
  * @requiredScopes ils-lists-read, ils-lists-write
2097
2097
  */
2098
- deleteFolder: (input: Basic.DeleteFolderInput) => Operation<Basic.DeleteFolderOutput>;
2098
+ deleteFolder: (input: DeleteFolderInput) => Operation<DeleteFolderOutput>;
2099
2099
  /**
2100
2100
  * @apiPath /crm/lists/2026-03/{listId}/memberships
2101
2101
  * @apiMethod DELETE
2102
2102
  * @requiredScopes ils-lists-read, ils-lists-write
2103
2103
  */
2104
- deleteMemberships: (input: Basic.DeleteMembershipsInput) => Operation<Basic.DeleteMembershipsOutput>;
2104
+ deleteMemberships: (input: DeleteMembershipsInput) => Operation<DeleteMembershipsOutput>;
2105
2105
  /**
2106
2106
  * @apiPath /crm/lists/2026-03/{listId}
2107
2107
  * @apiMethod GET
2108
2108
  * @requiredScopes ils-lists-read
2109
2109
  */
2110
- get: (input: Basic.GetInput) => Operation<Basic.GetOutput>;
2110
+ get: (input: GetInput) => Operation<GetOutput>;
2111
2111
  /**
2112
2112
  * @apiPath /crm/lists/2026-03/object-type-id/{objectTypeId}/name/{listName}
2113
2113
  * @apiMethod GET
2114
2114
  * @requiredScopes ils-lists-read
2115
2115
  */
2116
- getByObjectTypeAndName: (input: Basic.GetByObjectTypeAndNameInput) => Operation<Basic.GetByObjectTypeAndNameOutput>;
2116
+ getByObjectTypeAndName: (input: GetByObjectTypeAndNameInput) => Operation<GetByObjectTypeAndNameOutput>;
2117
2117
  /**
2118
2118
  * @apiPath /crm/lists/2026-03/idmapping
2119
2119
  * @apiMethod GET
2120
2120
  * @requiredScopes ils-lists-read
2121
2121
  */
2122
- getIdMapping: (input?: Basic.GetIdMappingInput) => Operation<Basic.GetIdMappingOutput>;
2122
+ getIdMapping: (input?: GetIdMappingInput) => Operation<GetIdMappingOutput>;
2123
2123
  /**
2124
2124
  * @apiPath /crm/lists/2026-03/{listId}/memberships/join-order
2125
2125
  * @apiMethod GET
2126
2126
  * @requiredScopes ils-lists-read
2127
2127
  */
2128
- getMembershipsJoinOrder: (input: Basic.GetMembershipsJoinOrderInput) => Operation<Basic.GetMembershipsJoinOrderOutput>;
2128
+ getMembershipsJoinOrder: (input: GetMembershipsJoinOrderInput) => Operation<GetMembershipsJoinOrderOutput>;
2129
2129
  /**
2130
2130
  * @apiPath /crm/lists/2026-03/records/{objectTypeId}/{recordId}/memberships
2131
2131
  * @apiMethod GET
2132
2132
  * @requiredScopes ils-lists-read
2133
2133
  */
2134
- getRecordMemberships: (input: Basic.GetRecordMembershipsInput) => Operation<Basic.GetRecordMembershipsOutput>;
2134
+ getRecordMemberships: (input: GetRecordMembershipsInput) => Operation<GetRecordMembershipsOutput>;
2135
2135
  /**
2136
2136
  * @apiPath /crm/lists/2026-03/{listId}/schedule-conversion
2137
2137
  * @apiMethod GET
2138
2138
  * @requiredScopes ils-lists-read
2139
2139
  */
2140
- getScheduleConversion: (input: Basic.GetScheduleConversionInput) => Operation<Basic.GetScheduleConversionOutput>;
2140
+ getScheduleConversion: (input: GetScheduleConversionInput) => Operation<GetScheduleConversionOutput>;
2141
2141
  /**
2142
2142
  * @apiPath /crm/lists/2026-03/{listId}/size-and-edits-history/between
2143
2143
  * @apiMethod GET
2144
2144
  * @requiredScopes ils-lists-read
2145
2145
  */
2146
- getSizeAndEditsHistoryBetween: (input: Basic.GetSizeAndEditsHistoryBetweenInput) => Operation<Basic.GetSizeAndEditsHistoryBetweenOutput>;
2146
+ getSizeAndEditsHistoryBetween: (input: GetSizeAndEditsHistoryBetweenInput) => Operation<GetSizeAndEditsHistoryBetweenOutput>;
2147
2147
  /**
2148
2148
  * @apiPath /crm/lists/2026-03
2149
2149
  * @apiMethod GET
2150
2150
  * @requiredScopes ils-lists-read
2151
2151
  */
2152
- list: (input?: Basic.ListInput) => Operation<Basic.ListOutput>;
2152
+ list: (input?: ListInput) => Operation<ListOutput>;
2153
+ /**
2154
+ * @apiPath /crm/lists/2026-03/search
2155
+ * @apiMethod POST
2156
+ * @requiredScopes ils-lists-read
2157
+ */
2158
+ listBySearch: (input: ListBySearchInput) => Operation<ListBySearchOutput>;
2153
2159
  /**
2154
2160
  * @apiPath /crm/lists/2026-03/folders
2155
2161
  * @apiMethod GET
2156
2162
  * @requiredScopes ils-lists-read
2157
2163
  */
2158
- listFolders: (input?: Basic.ListFoldersInput) => Operation<Basic.ListFoldersOutput>;
2164
+ listFolders: (input?: ListFoldersInput) => Operation<ListFoldersOutput>;
2159
2165
  /**
2160
2166
  * @apiPath /crm/lists/2026-03/{listId}/memberships
2161
2167
  * @apiMethod GET
2162
2168
  * @requiredScopes ils-lists-read
2163
2169
  */
2164
- listMemberships: (input: Basic.ListMembershipsInput) => Operation<Basic.ListMembershipsOutput>;
2170
+ listMemberships: (input: ListMembershipsInput) => Operation<ListMembershipsOutput>;
2165
2171
  /**
2166
2172
  * @apiPath /crm/lists/2026-03/folders/{folderId}/move/{newParentFolderId}
2167
2173
  * @apiMethod PUT
2168
2174
  * @requiredScopes ils-lists-read, ils-lists-write
2169
2175
  */
2170
- moveFolder: (input: Basic.MoveFolderInput) => Operation<Basic.MoveFolderOutput>;
2176
+ moveFolder: (input: MoveFolderInput) => Operation<MoveFolderOutput>;
2171
2177
  /**
2172
2178
  * @apiPath /crm/lists/2026-03/folders/move-list
2173
2179
  * @apiMethod PUT
2174
2180
  * @requiredScopes ils-lists-read, ils-lists-write
2175
2181
  */
2176
- moveList: (input: Basic.MoveListInput) => Operation<Basic.MoveListOutput>;
2182
+ moveList: (input: MoveListInput) => Operation<MoveListOutput>;
2177
2183
  /**
2178
2184
  * @apiPath /crm/lists/2026-03/{listId}/memberships/remove
2179
2185
  * @apiMethod PUT
2180
2186
  * @requiredScopes ils-lists-read, ils-lists-write
2181
2187
  */
2182
- removeMemberships: (input: Basic.RemoveMembershipsInput) => Operation<Basic.RemoveMembershipsOutput>;
2188
+ removeMemberships: (input: RemoveMembershipsInput) => Operation<RemoveMembershipsOutput>;
2183
2189
  /**
2184
2190
  * @apiPath /crm/lists/2026-03/folders/{folderId}/rename
2185
2191
  * @apiMethod PUT
2186
2192
  * @requiredScopes ils-lists-read, ils-lists-write
2187
2193
  */
2188
- renameFolder: (input: Basic.RenameFolderInput) => Operation<Basic.RenameFolderOutput>;
2194
+ renameFolder: (input: RenameFolderInput) => Operation<RenameFolderOutput>;
2189
2195
  /**
2190
2196
  * @apiPath /crm/lists/2026-03/{listId}/restore
2191
2197
  * @apiMethod PUT
2192
2198
  * @requiredScopes ils-lists-read, ils-lists-write
2193
2199
  */
2194
- restore: (input: Basic.RestoreInput) => Operation<Basic.RestoreOutput>;
2200
+ restore: (input: RestoreInput) => Operation<RestoreOutput>;
2195
2201
  /**
2196
2202
  * @apiPath /crm/lists/2026-03/{listId}/schedule-conversion
2197
2203
  * @apiMethod DELETE
2198
2204
  * @requiredScopes ils-lists-read, ils-lists-write
2199
2205
  */
2200
- scheduleConversion: (input: Basic.ScheduleConversionInput) => Operation<Basic.ScheduleConversionOutput>;
2206
+ scheduleConversion: (input: ScheduleConversionInput) => Operation<ScheduleConversionOutput>;
2201
2207
  /**
2202
2208
  * @apiPath /crm/lists/2026-03/{listId}/update-list-filters
2203
2209
  * @apiMethod PUT
2204
2210
  * @requiredScopes ils-lists-read, ils-lists-write
2205
2211
  */
2206
- updateListFilters: (input: Basic.UpdateListFiltersInput) => Operation<Basic.UpdateListFiltersOutput>;
2212
+ updateListFilters: (input: UpdateListFiltersInput) => Operation<UpdateListFiltersOutput>;
2207
2213
  /**
2208
2214
  * @apiPath /crm/lists/2026-03/{listId}/update-list-name
2209
2215
  * @apiMethod PUT
2210
2216
  * @requiredScopes ils-lists-read, ils-lists-write
2211
2217
  */
2212
- updateListName: (input: Basic.UpdateListNameInput) => Operation<Basic.UpdateListNameOutput>;
2218
+ updateListName: (input: UpdateListNameInput) => Operation<UpdateListNameOutput>;
2213
2219
  /**
2214
2220
  * @apiPath /crm/lists/2026-03/{listId}/schedule-conversion
2215
2221
  * @apiMethod PUT
2216
2222
  * @requiredScopes ils-lists-read, ils-lists-write
2217
2223
  */
2218
- updateScheduleConversion: (input: Basic.UpdateScheduleConversionInput) => Operation<Basic.UpdateScheduleConversionOutput>;
2219
- }
2220
- /**
2221
- * Usage example:
2222
- * ```ts
2223
- * import { crmLists } from '@hubspot/api-client-core';
2224
- * client.send(crmLists.batch.batchReadMemberships(input));
2225
- * ```
2226
- */
2227
- interface BatchAPI {
2228
- /**
2229
- * @apiPath /crm/lists/2026-03/records/memberships/batch/read
2230
- * @apiMethod POST
2231
- * @requiredScopes ils-lists-read
2232
- */
2233
- batchReadMemberships: (input: Batch.BatchReadMembershipsInput) => Operation<Batch.BatchReadMembershipsOutput>;
2234
- }
2235
- /**
2236
- * Usage example:
2237
- * ```ts
2238
- * import { crmLists } from '@hubspot/api-client-core';
2239
- * client.send(crmLists.search.listBySearch(input));
2240
- * ```
2241
- */
2242
- interface SearchAPI {
2243
- /**
2244
- * @apiPath /crm/lists/2026-03/search
2245
- * @apiMethod POST
2246
- * @requiredScopes ils-lists-read
2247
- */
2248
- listBySearch: (input: Search.ListBySearchInput) => Operation<Search.ListBySearchOutput>;
2249
- }
2250
- /**
2251
- * Usage example:
2252
- * ```ts
2253
- * import { crmLists } from '@hubspot/api-client-core';
2254
- * client.send(crmLists.basic.addAndRemoveMemberships(input));
2255
- * ```
2256
- */
2257
- interface API {
2258
- basic: BasicAPI;
2259
- batch: BatchAPI;
2260
- search: SearchAPI;
2224
+ updateScheduleConversion: (input: UpdateScheduleConversionInput) => Operation<UpdateScheduleConversionOutput>;
2261
2225
  }
2262
2226
  }
2263
2227
  //#endregion
2264
- export { CRMLists };
2228
+ export { CRMListsSchemas, CrmLists };
2265
2229
  //# sourceMappingURL=lists-types.generated.d.ts.map