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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (731) hide show
  1. package/.turbo/turbo-format$colon$check.log +1 -1
  2. package/.turbo/turbo-test.log +101 -57
  3. package/.turbo/turbo-tsdown.log +474 -469
  4. package/build/tsconfig.browser.tsbuildinfo +1 -1
  5. package/build/tsconfig.server.tsbuildinfo +1 -1
  6. package/dist/browser/{HubSpotAppConnect-BW45gyDs.js → HubSpotAppConnect-721kYr9d.js} +17 -23
  7. package/dist/browser/HubSpotAppConnect-721kYr9d.js.map +1 -0
  8. package/dist/browser/{create-vctOhpX9.js → create-DxEyGG-k.js} +336 -100
  9. package/dist/browser/create-DxEyGG-k.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-C3wed8dU.d.ts} +52 -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 +158 -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/hubspot-connect-routes/whoami.js +51 -0
  437. package/dist/server/hono/hubspot-connect-routes/whoami.js.map +1 -0
  438. package/dist/server/hono/types.d.ts +9 -10
  439. package/dist/server/hono/utils/cookie-utils.js +2 -1
  440. package/dist/server/hono/utils/cookie-utils.js.map +1 -1
  441. package/dist/server/hono/utils/cors-middleware.js +85 -0
  442. package/dist/server/hono/utils/cors-middleware.js.map +1 -0
  443. package/dist/server/import-app-keys.js.map +1 -1
  444. package/dist/server/lovable/create-app-function-start.d.ts +1 -1
  445. package/dist/server/lovable/create-app-function-start.js +4 -6
  446. package/dist/server/lovable/create-app-function-start.js.map +1 -1
  447. package/dist/server/lovable/hubspot-connect/index.js.map +1 -1
  448. package/dist/server/lovable/hubspot-connect/run-hubspot-connect-lovable-server.js +14 -15
  449. package/dist/server/lovable/hubspot-connect/run-hubspot-connect-lovable-server.js.map +1 -1
  450. package/dist/server/sanitize-request.js +14 -11
  451. package/dist/server/sanitize-request.js.map +1 -1
  452. package/dist/server/secure-start-core.js +4 -5
  453. package/dist/server/secure-start-core.js.map +1 -1
  454. package/dist/server/shared/constants.js +22 -9
  455. package/dist/server/shared/constants.js.map +1 -1
  456. package/dist/server/shared/encoding/base64.js.map +1 -1
  457. package/dist/server/shared/encoding/sha256.js.map +1 -1
  458. package/dist/server/shared/logger.js.map +1 -1
  459. package/dist/server/types.d.ts +1 -35
  460. package/dist/server/utils/cookie-utils.js.map +1 -1
  461. package/dist/server/utils/dpop-utils.js.map +1 -1
  462. package/dist/server/utils/env-utils.js +60 -7
  463. package/dist/server/utils/env-utils.js.map +1 -1
  464. package/dist/server/utils/hubspot-dpop-auth-headers.js +38 -0
  465. package/dist/server/utils/hubspot-dpop-auth-headers.js.map +1 -0
  466. package/dist/server/utils/jwk-utils.js.map +1 -1
  467. package/dist/server/utils/jwt-utils.js.map +1 -1
  468. package/package.json +15 -21
  469. package/src/browser/app-connect-controller/README.md +5 -2
  470. package/src/browser/app-connect-controller/connect-start.test.ts +157 -0
  471. package/src/browser/app-connect-controller/connect-start.ts +18 -3
  472. package/src/browser/app-connect-controller/constants.ts +6 -4
  473. package/src/browser/app-connect-controller/create.ts +8 -2
  474. package/src/browser/app-connect-controller/disconnect.ts +5 -7
  475. package/src/browser/app-connect-controller/init.test.ts +275 -0
  476. package/src/browser/app-connect-controller/init.ts +44 -19
  477. package/src/browser/app-connect-controller/oauth-complete.test.ts +110 -0
  478. package/src/browser/app-connect-controller/oauth-complete.ts +53 -0
  479. package/src/browser/app-connect-controller/oauth-popup.test.ts +239 -0
  480. package/src/browser/app-connect-controller/oauth-popup.ts +160 -0
  481. package/src/browser/app-connect-controller/types.ts +3 -0
  482. package/src/browser/app-connect-controller/utils/iframe-utils.ts +12 -0
  483. package/src/browser/app-connect-controller/utils/resolve-oauth-connect-mode.test.ts +35 -0
  484. package/src/browser/app-connect-controller/utils/resolve-oauth-connect-mode.ts +21 -0
  485. package/src/browser/app-connect-controller/utils/session-utils.test.ts +73 -22
  486. package/src/browser/app-connect-controller/utils/session-utils.ts +74 -33
  487. package/src/browser/app-connect-controller/view-state.test.ts +1 -0
  488. package/src/browser/app-connect-controller/view-state.ts +1 -0
  489. package/src/browser/index.ts +1 -0
  490. package/src/browser/react/components/AppConnectHeader/AppConnectHeader.tsx +21 -34
  491. package/src/browser/react/components/ConnectButton/ConnectButton.tsx +1 -1
  492. package/src/browser/react/lovable/LovableHubSpotAppConnect.tsx +12 -2
  493. package/src/browser/types.ts +30 -5
  494. package/src/server/api-client-core/__tests__/errors.test.ts +309 -0
  495. package/src/server/api-client-core/__tests__/operation-headers.test.ts +251 -0
  496. package/src/server/api-client-core/apis/account/account-info-types.generated.ts +74 -88
  497. package/src/server/api-client-core/apis/account/account-info.generated.ts +2 -4
  498. package/src/server/api-client-core/apis/account/audit-logs-types.generated.ts +346 -360
  499. package/src/server/api-client-core/apis/account/audit-logs.generated.ts +2 -4
  500. package/src/server/api-client-core/apis/auth/oauth-types.generated.ts +81 -99
  501. package/src/server/api-client-core/apis/auth/oauth.generated.ts +1 -3
  502. package/src/server/api-client-core/apis/automation/actions-types.generated.ts +1162 -1188
  503. package/src/server/api-client-core/apis/automation/actions.generated.ts +10 -12
  504. package/src/server/api-client-core/apis/automation/sequences-types.generated.ts +379 -393
  505. package/src/server/api-client-core/apis/automation/sequences.generated.ts +1 -3
  506. package/src/server/api-client-core/apis/business-units-types.generated.ts +43 -59
  507. package/src/server/api-client-core/apis/business-units.generated.ts +9 -10
  508. package/src/server/api-client-core/apis/cms/authors-types.generated.ts +3823 -3853
  509. package/src/server/api-client-core/apis/cms/authors.generated.ts +31 -37
  510. package/src/server/api-client-core/apis/cms/blog-settings-types.generated.ts +3667 -3696
  511. package/src/server/api-client-core/apis/cms/blog-settings.generated.ts +46 -51
  512. package/src/server/api-client-core/apis/cms/cms-content-audit-types.generated.ts +138 -163
  513. package/src/server/api-client-core/apis/cms/cms-content-audit.generated.ts +2 -10
  514. package/src/server/api-client-core/apis/cms/domains-types.generated.ts +153 -167
  515. package/src/server/api-client-core/apis/cms/domains.generated.ts +2 -4
  516. package/src/server/api-client-core/apis/cms/hubdb-types.generated.ts +1013 -1063
  517. package/src/server/api-client-core/apis/cms/hubdb.generated.ts +3 -5
  518. package/src/server/api-client-core/apis/cms/media-bridge-types.generated.ts +8623 -8657
  519. package/src/server/api-client-core/apis/cms/media-bridge.generated.ts +16 -22
  520. package/src/server/api-client-core/apis/cms/pages-types.generated.ts +5259 -5272
  521. package/src/server/api-client-core/apis/cms/pages.generated.ts +262 -226
  522. package/src/server/api-client-core/apis/cms/posts-types.generated.ts +4420 -4438
  523. package/src/server/api-client-core/apis/cms/posts.generated.ts +108 -106
  524. package/src/server/api-client-core/apis/cms/site-search-types.generated.ts +1867 -1881
  525. package/src/server/api-client-core/apis/cms/site-search.generated.ts +2 -4
  526. package/src/server/api-client-core/apis/cms/source-code-types.generated.ts +144 -177
  527. package/src/server/api-client-core/apis/cms/source-code.generated.ts +15 -23
  528. package/src/server/api-client-core/apis/cms/tags-types.generated.ts +3820 -3845
  529. package/src/server/api-client-core/apis/cms/tags.generated.ts +80 -82
  530. package/src/server/api-client-core/apis/cms/url-mappings-types.generated.ts +188 -202
  531. package/src/server/api-client-core/apis/cms/url-mappings.generated.ts +2 -4
  532. package/src/server/api-client-core/apis/cms/url-redirects-types.generated.ts +182 -196
  533. package/src/server/api-client-core/apis/cms/url-redirects.generated.ts +2 -4
  534. package/src/server/api-client-core/apis/communication-preferences/subscriptions-types.generated.ts +810 -828
  535. package/src/server/api-client-core/apis/communication-preferences/subscriptions.generated.ts +66 -63
  536. package/src/server/api-client-core/apis/conversations/custom-channels-types.generated.ts +564 -601
  537. package/src/server/api-client-core/apis/conversations/custom-channels.generated.ts +90 -86
  538. package/src/server/api-client-core/apis/conversations/visitor-identification-types.generated.ts +31 -44
  539. package/src/server/api-client-core/apis/conversations/visitor-identification.generated.ts +6 -8
  540. package/src/server/api-client-core/apis/conversations-types.generated.ts +955 -991
  541. package/src/server/api-client-core/apis/conversations.generated.ts +6 -5
  542. package/src/server/api-client-core/apis/crm/app-uninstalls-types.generated.ts +7 -19
  543. package/src/server/api-client-core/apis/crm/app-uninstalls.generated.ts +2 -4
  544. package/src/server/api-client-core/apis/crm/appointments-types.generated.ts +965 -969
  545. package/src/server/api-client-core/apis/crm/appointments.generated.ts +143 -137
  546. package/src/server/api-client-core/apis/crm/associations-schema-types.generated.ts +292 -322
  547. package/src/server/api-client-core/apis/crm/associations-schema.generated.ts +17 -19
  548. package/src/server/api-client-core/apis/crm/associations-types.generated.ts +657 -675
  549. package/src/server/api-client-core/apis/crm/associations.generated.ts +70 -70
  550. package/src/server/api-client-core/apis/crm/calling-extensions-types.generated.ts +417 -441
  551. package/src/server/api-client-core/apis/crm/calling-extensions.generated.ts +62 -69
  552. package/src/server/api-client-core/apis/crm/calls-types.generated.ts +839 -856
  553. package/src/server/api-client-core/apis/crm/calls.generated.ts +42 -44
  554. package/src/server/api-client-core/apis/crm/carts-types.generated.ts +839 -856
  555. package/src/server/api-client-core/apis/crm/carts.generated.ts +42 -44
  556. package/src/server/api-client-core/apis/crm/commerce-payments-types.generated.ts +847 -856
  557. package/src/server/api-client-core/apis/crm/commerce-payments.generated.ts +73 -73
  558. package/src/server/api-client-core/apis/crm/commerce-subscriptions-types.generated.ts +844 -853
  559. package/src/server/api-client-core/apis/crm/commerce-subscriptions.generated.ts +50 -51
  560. package/src/server/api-client-core/apis/crm/communications-types.generated.ts +846 -856
  561. package/src/server/api-client-core/apis/crm/communications.generated.ts +73 -73
  562. package/src/server/api-client-core/apis/crm/companies-types.generated.ts +859 -885
  563. package/src/server/api-client-core/apis/crm/companies.generated.ts +44 -50
  564. package/src/server/api-client-core/apis/crm/contacts-types.generated.ts +875 -907
  565. package/src/server/api-client-core/apis/crm/contacts.generated.ts +46 -52
  566. package/src/server/api-client-core/apis/crm/contracts-types.generated.ts +894 -862
  567. package/src/server/api-client-core/apis/crm/contracts.generated.ts +66 -56
  568. package/src/server/api-client-core/apis/crm/courses-types.generated.ts +842 -859
  569. package/src/server/api-client-core/apis/crm/courses.generated.ts +42 -44
  570. package/src/server/api-client-core/apis/crm/crm-owners-types.generated.ts +102 -115
  571. package/src/server/api-client-core/apis/crm/crm-owners.generated.ts +2 -4
  572. package/src/server/api-client-core/apis/crm/custom-objects-types.generated.ts +900 -915
  573. package/src/server/api-client-core/apis/crm/custom-objects.generated.ts +128 -126
  574. package/src/server/api-client-core/apis/crm/deal-splits-types.generated.ts +157 -170
  575. package/src/server/api-client-core/apis/crm/deal-splits.generated.ts +2 -4
  576. package/src/server/api-client-core/apis/crm/deals-types.generated.ts +858 -875
  577. package/src/server/api-client-core/apis/crm/deals.generated.ts +42 -44
  578. package/src/server/api-client-core/apis/crm/discounts-types.generated.ts +842 -855
  579. package/src/server/api-client-core/apis/crm/discounts.generated.ts +42 -44
  580. package/src/server/api-client-core/apis/crm/emails-types.generated.ts +839 -856
  581. package/src/server/api-client-core/apis/crm/emails.generated.ts +42 -44
  582. package/src/server/api-client-core/apis/crm/exports-types.generated.ts +284 -314
  583. package/src/server/api-client-core/apis/crm/exports.generated.ts +6 -11
  584. package/src/server/api-client-core/apis/crm/feedback-submissions-types.generated.ts +607 -622
  585. package/src/server/api-client-core/apis/crm/feedback-submissions.generated.ts +84 -80
  586. package/src/server/api-client-core/apis/crm/fees-types.generated.ts +839 -856
  587. package/src/server/api-client-core/apis/crm/fees.generated.ts +42 -44
  588. package/src/server/api-client-core/apis/crm/goal-targets-types.generated.ts +845 -856
  589. package/src/server/api-client-core/apis/crm/goal-targets.generated.ts +50 -51
  590. package/src/server/api-client-core/apis/crm/imports-types.generated.ts +663 -692
  591. package/src/server/api-client-core/apis/crm/imports.generated.ts +2 -7
  592. package/src/server/api-client-core/apis/crm/invoices-types.generated.ts +839 -856
  593. package/src/server/api-client-core/apis/crm/invoices.generated.ts +42 -44
  594. package/src/server/api-client-core/apis/crm/leads-types.generated.ts +839 -856
  595. package/src/server/api-client-core/apis/crm/leads.generated.ts +42 -44
  596. package/src/server/api-client-core/apis/crm/limits-tracking-types.generated.ts +263 -275
  597. package/src/server/api-client-core/apis/crm/limits-tracking.generated.ts +2 -4
  598. package/src/server/api-client-core/apis/crm/line-items-types.generated.ts +843 -856
  599. package/src/server/api-client-core/apis/crm/line-items.generated.ts +42 -44
  600. package/src/server/api-client-core/apis/crm/listings-types.generated.ts +842 -859
  601. package/src/server/api-client-core/apis/crm/listings.generated.ts +42 -44
  602. package/src/server/api-client-core/apis/crm/lists-types.generated.ts +2794 -2845
  603. package/src/server/api-client-core/apis/crm/lists.generated.ts +8 -20
  604. package/src/server/api-client-core/apis/crm/meetings-types.generated.ts +839 -856
  605. package/src/server/api-client-core/apis/crm/meetings.generated.ts +42 -44
  606. package/src/server/api-client-core/apis/crm/notes-types.generated.ts +839 -856
  607. package/src/server/api-client-core/apis/crm/notes.generated.ts +42 -44
  608. package/src/server/api-client-core/apis/crm/object-library-types.generated.ts +26 -39
  609. package/src/server/api-client-core/apis/crm/object-library.generated.ts +2 -4
  610. package/src/server/api-client-core/apis/crm/objects-types.generated.ts +688 -716
  611. package/src/server/api-client-core/apis/crm/objects.generated.ts +79 -83
  612. package/src/server/api-client-core/apis/crm/orders-types.generated.ts +829 -846
  613. package/src/server/api-client-core/apis/crm/orders.generated.ts +45 -47
  614. package/src/server/api-client-core/apis/crm/partner-clients-types.generated.ts +721 -735
  615. package/src/server/api-client-core/apis/crm/partner-clients.generated.ts +60 -60
  616. package/src/server/api-client-core/apis/crm/partner-services-types.generated.ts +720 -734
  617. package/src/server/api-client-core/apis/crm/partner-services.generated.ts +60 -60
  618. package/src/server/api-client-core/apis/crm/pipelines-types.generated.ts +366 -388
  619. package/src/server/api-client-core/apis/crm/pipelines.generated.ts +2 -4
  620. package/src/server/api-client-core/apis/crm/postal-mail-types.generated.ts +830 -843
  621. package/src/server/api-client-core/apis/crm/postal-mail.generated.ts +45 -47
  622. package/src/server/api-client-core/apis/crm/products-types.generated.ts +829 -846
  623. package/src/server/api-client-core/apis/crm/products.generated.ts +45 -47
  624. package/src/server/api-client-core/apis/crm/projects-types.generated.ts +845 -875
  625. package/src/server/api-client-core/apis/crm/projects.generated.ts +47 -53
  626. package/src/server/api-client-core/apis/crm/properties-types.generated.ts +623 -626
  627. package/src/server/api-client-core/apis/crm/properties.generated.ts +33 -28
  628. package/src/server/api-client-core/apis/crm/property-validations-types.generated.ts +160 -174
  629. package/src/server/api-client-core/apis/crm/property-validations.generated.ts +2 -6
  630. package/src/server/api-client-core/apis/crm/public-app-crm-cards-types.generated.ts +467 -494
  631. package/src/server/api-client-core/apis/crm/public-app-crm-cards.generated.ts +7 -15
  632. package/src/server/api-client-core/apis/crm/public-app-feature-flags-types.generated.ts +166 -177
  633. package/src/server/api-client-core/apis/crm/public-app-feature-flags.generated.ts +6 -8
  634. package/src/server/api-client-core/apis/crm/quotes-types.generated.ts +829 -846
  635. package/src/server/api-client-core/apis/crm/quotes.generated.ts +45 -47
  636. package/src/server/api-client-core/apis/crm/schemas-types.generated.ts +613 -640
  637. package/src/server/api-client-core/apis/crm/schemas.generated.ts +8 -14
  638. package/src/server/api-client-core/apis/crm/services-types.generated.ts +832 -849
  639. package/src/server/api-client-core/apis/crm/services.generated.ts +45 -47
  640. package/src/server/api-client-core/apis/crm/tasks-types.generated.ts +829 -846
  641. package/src/server/api-client-core/apis/crm/tasks.generated.ts +45 -47
  642. package/src/server/api-client-core/apis/crm/taxes-types.generated.ts +829 -846
  643. package/src/server/api-client-core/apis/crm/taxes.generated.ts +45 -47
  644. package/src/server/api-client-core/apis/crm/tickets-types.generated.ts +848 -878
  645. package/src/server/api-client-core/apis/crm/tickets.generated.ts +47 -53
  646. package/src/server/api-client-core/apis/crm/timeline-types.generated.ts +144 -161
  647. package/src/server/api-client-core/apis/crm/timeline.generated.ts +6 -8
  648. package/src/server/api-client-core/apis/crm/transcriptions-types.generated.ts +149 -164
  649. package/src/server/api-client-core/apis/crm/transcriptions.generated.ts +22 -22
  650. package/src/server/api-client-core/apis/crm/users-types.generated.ts +829 -846
  651. package/src/server/api-client-core/apis/crm/users.generated.ts +45 -47
  652. package/src/server/api-client-core/apis/crm/video-conferencing-extension-types.generated.ts +29 -42
  653. package/src/server/api-client-core/apis/crm/video-conferencing-extension.generated.ts +17 -19
  654. package/src/server/api-client-core/apis/events/manage-event-definitions-types.generated.ts +1509 -1558
  655. package/src/server/api-client-core/apis/events/manage-event-definitions.generated.ts +55 -65
  656. package/src/server/api-client-core/apis/events/send-event-completions-types.generated.ts +51 -68
  657. package/src/server/api-client-core/apis/events/send-event-completions.generated.ts +10 -10
  658. package/src/server/api-client-core/apis/events-types.generated.ts +97 -110
  659. package/src/server/api-client-core/apis/events.generated.ts +2 -4
  660. package/src/server/api-client-core/apis/files-types.generated.ts +727 -757
  661. package/src/server/api-client-core/apis/files.generated.ts +3 -5
  662. package/src/server/api-client-core/apis/marketing/campaigns-public-api-types.generated.ts +1221 -1234
  663. package/src/server/api-client-core/apis/marketing/campaigns-public-api.generated.ts +45 -47
  664. package/src/server/api-client-core/apis/marketing/marketing-emails-types.generated.ts +3704 -3733
  665. package/src/server/api-client-core/apis/marketing/marketing-emails.generated.ts +44 -52
  666. package/src/server/api-client-core/apis/marketing/marketing-events-types.generated.ts +1787 -1848
  667. package/src/server/api-client-core/apis/marketing/marketing-events.generated.ts +236 -241
  668. package/src/server/api-client-core/apis/marketing/single-send-types.generated.ts +142 -155
  669. package/src/server/api-client-core/apis/marketing/single-send.generated.ts +2 -6
  670. package/src/server/api-client-core/apis/marketing/transactional-single-send-types.generated.ts +253 -269
  671. package/src/server/api-client-core/apis/marketing/transactional-single-send.generated.ts +32 -31
  672. package/src/server/api-client-core/apis/meta/origins-types.generated.ts +40 -56
  673. package/src/server/api-client-core/apis/meta/origins.generated.ts +2 -4
  674. package/src/server/api-client-core/apis/scheduler/meetings-types.generated.ts +1001 -1014
  675. package/src/server/api-client-core/apis/scheduler/meetings.generated.ts +6 -8
  676. package/src/server/api-client-core/apis/settings/multicurrency-types.generated.ts +1906 -1912
  677. package/src/server/api-client-core/apis/settings/multicurrency.generated.ts +64 -63
  678. package/src/server/api-client-core/apis/settings/tax-rates-types.generated.ts +71 -85
  679. package/src/server/api-client-core/apis/settings/tax-rates.generated.ts +2 -4
  680. package/src/server/api-client-core/apis/settings/user-provisioning-types.generated.ts +207 -257
  681. package/src/server/api-client-core/apis/settings/user-provisioning.generated.ts +8 -24
  682. package/src/server/api-client-core/apis/webhooks-journal-types.generated.ts +740 -771
  683. package/src/server/api-client-core/apis/webhooks-journal.generated.ts +47 -59
  684. package/src/server/api-client-core/apis/webhooks-types.generated.ts +1194 -1228
  685. package/src/server/api-client-core/apis/webhooks.generated.ts +52 -64
  686. package/src/server/api-client-core/client.ts +5 -1
  687. package/src/server/api-client-core/pagination.ts +2 -2
  688. package/src/server/api-client-core/plugins/fetch-transport.ts +70 -12
  689. package/src/server/api-client-core/types.ts +1 -1
  690. package/src/server/constants.ts +29 -4
  691. package/src/server/hono/hono-request-handler.ts +68 -27
  692. package/src/server/hono/hubspot-connect-routes/auth-complete.test.ts +394 -0
  693. package/src/server/hono/hubspot-connect-routes/{auth-callback.ts → auth-complete.ts} +81 -30
  694. package/src/server/hono/hubspot-connect-routes/auth-init-session.test.ts +114 -30
  695. package/src/server/hono/hubspot-connect-routes/auth-init-session.ts +35 -10
  696. package/src/server/hono/hubspot-connect-routes/auth-logout.test.ts +13 -0
  697. package/src/server/hono/hubspot-connect-routes/auth-logout.ts +39 -10
  698. package/src/server/hono/hubspot-connect-routes/auth-refresh.test.ts +6 -0
  699. package/src/server/hono/hubspot-connect-routes/auth-refresh.ts +24 -9
  700. package/src/server/hono/hubspot-connect-routes/cimd-public-routes.test.ts +7 -6
  701. package/src/server/hono/hubspot-connect-routes/cimd-public-routes.ts +5 -1
  702. package/src/server/hono/hubspot-connect-routes/hubspot-connect-routes.ts +11 -3
  703. package/src/server/hono/hubspot-connect-routes/load-hubspot-connect-routes-env.test.ts +17 -24
  704. package/src/server/hono/hubspot-connect-routes/load-hubspot-connect-routes-env.ts +8 -8
  705. package/src/server/hono/hubspot-connect-routes/utils.test.ts +16 -46
  706. package/src/server/hono/hubspot-connect-routes/utils.ts +61 -5
  707. package/src/server/hono/hubspot-connect-routes/whoami.ts +74 -0
  708. package/src/server/hono/types.ts +11 -10
  709. package/src/server/hono/utils/cookie-utils.ts +27 -2
  710. package/src/server/hono/utils/cors-middleware.test.ts +80 -0
  711. package/src/server/hono/utils/cors-middleware.ts +95 -0
  712. package/src/server/lovable/create-app-function-start.ts +4 -7
  713. package/src/server/lovable/hubspot-connect/run-hubspot-connect-lovable-server.ts +21 -16
  714. package/src/server/sanitize-request.ts +15 -12
  715. package/src/server/secure-start-core.ts +7 -6
  716. package/src/server/types.ts +2 -38
  717. package/src/server/utils/env-utils.test.ts +140 -12
  718. package/src/server/utils/env-utils.ts +80 -6
  719. package/src/server/utils/hubspot-dpop-auth-headers.test.ts +43 -0
  720. package/src/server/utils/hubspot-dpop-auth-headers.ts +48 -0
  721. package/src/shared/constants.ts +40 -3
  722. package/src/shared/wire-types.ts +49 -0
  723. package/dist/browser/HubSpotAppConnect-BW45gyDs.js.map +0 -1
  724. package/dist/browser/create-vctOhpX9.js.map +0 -1
  725. package/dist/server/hono/hubspot-connect-routes/auth-callback.js +0 -125
  726. package/dist/server/hono/hubspot-connect-routes/auth-callback.js.map +0 -1
  727. package/dist/server/proxy.js +0 -68
  728. package/dist/server/proxy.js.map +0 -1
  729. package/src/server/hono/hubspot-connect-routes/auth-callback.test.ts +0 -225
  730. package/src/server/proxy.test.ts +0 -80
  731. package/src/server/proxy.ts +0 -116
@@ -1,883 +1,859 @@
1
1
  import { Operation } from "../../types.js";
2
2
 
3
3
  //#region src/server/api-client-core/apis/marketing/marketing-emails-types.generated.d.ts
4
- declare namespace MarketingMarketingEmails {
5
- namespace Basic {
6
- type CreateInput = Schemas.EmailCreateRequest;
7
- type CreateOutput = Schemas.PublicEmail;
8
- interface GetHistogramInput {
9
- emailIds?: number[];
10
- endTimestamp?: string;
11
- interval?: 'DAY' | 'HOUR' | 'MINUTE' | 'MONTH' | 'QUARTER' | 'QUARTER_HOUR' | 'SECOND' | 'WEEK' | 'YEAR';
12
- startTimestamp?: string;
13
- }
14
- type GetHistogramOutput = Schemas.CollectionResponseWithTotalEmailStatisticInterval;
15
- interface GetInput {
16
- emailIds?: number[];
17
- endTimestamp?: string;
18
- property?: string;
19
- startTimestamp?: string;
20
- }
21
- type GetOutput = Schemas.AggregateEmailStatistics;
22
- interface ListInput {
23
- /**
24
- * 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.
25
- */
26
- after?: string;
27
- /**
28
- * Whether to return only results that have been archived.
29
- */
30
- archived?: boolean;
31
- campaign?: string;
32
- createdAfter?: string;
33
- createdAt?: string;
34
- createdBefore?: string;
35
- includedProperties?: string[];
36
- includeStats?: boolean;
37
- isPublished?: boolean;
38
- /**
39
- * The maximum number of results to display per page.
40
- */
41
- limit?: number;
42
- marketingCampaignNames?: boolean;
43
- publishedAfter?: string;
44
- publishedAt?: string;
45
- publishedBefore?: string;
46
- sort?: string[];
47
- type?: 'AB_EMAIL' | 'AUTOMATED_AB_EMAIL' | 'AUTOMATED_EMAIL' | 'BATCH_EMAIL' | 'BLOG_EMAIL' | 'BLOG_EMAIL_CHILD' | 'FEEDBACK_CES_EMAIL' | 'FEEDBACK_CUSTOM_EMAIL' | 'FEEDBACK_CUSTOM_SURVEY_EMAIL' | 'FEEDBACK_NPS_EMAIL' | 'FOLLOWUP_EMAIL' | 'LEADFLOW_EMAIL' | 'LOCALTIME_EMAIL' | 'MANAGE_PREFERENCES_EMAIL' | 'MARKETING_SINGLE_SEND_API' | 'MEMBERSHIP_EMAIL_VERIFICATION_EMAIL' | 'MEMBERSHIP_FOLLOW_UP_EMAIL' | 'MEMBERSHIP_OTP_LOGIN_EMAIL' | 'MEMBERSHIP_PASSWORD_RESET_EMAIL' | 'MEMBERSHIP_PASSWORD_SAVED_EMAIL' | 'MEMBERSHIP_PASSWORDLESS_AUTH_EMAIL' | 'MEMBERSHIP_REGISTRATION_EMAIL' | 'MEMBERSHIP_REGISTRATION_FOLLOW_UP_EMAIL' | 'MEMBERSHIP_VERIFICATION_EMAIL' | 'OPTIN_EMAIL' | 'OPTIN_FOLLOWUP_EMAIL' | 'RESUBSCRIBE_EMAIL' | 'RSS_EMAIL' | 'RSS_EMAIL_CHILD' | 'SINGLE_SEND_API' | 'SMTP_TOKEN' | 'TICKET_EMAIL';
48
- updatedAfter?: string;
49
- updatedAt?: string;
50
- updatedBefore?: string;
51
- variantStats?: boolean;
52
- workflowNames?: boolean;
53
- }
54
- type ListOutput = Schemas.CollectionResponseWithTotalPublicEmail;
55
- }
56
- namespace Emails {
57
- type CloneInput = Schemas.EmailCloneRequestVNext;
58
- type CloneOutput = Schemas.PublicEmail;
59
- type CreateAbTestVariationInput = Schemas.AbTestCreateRequestVNext;
60
- type CreateAbTestVariationOutput = Schemas.PublicEmail;
61
- interface DeleteInput {
62
- /**
63
- * Whether to return only results that have been archived.
64
- */
65
- archived?: boolean;
66
- emailId: string;
67
- }
68
- type DeleteOutput = void;
69
- interface GetAbTestVariationInput {
70
- /**
71
- * Whether to return only results that have been archived.
72
- */
73
- archived?: boolean;
74
- emailId: string;
75
- includedProperties?: string[];
76
- includeStats?: boolean;
77
- marketingCampaignNames?: boolean;
78
- variantStats?: boolean;
79
- workflowNames?: boolean;
80
- }
81
- type GetAbTestVariationOutput = Schemas.PublicEmail;
82
- interface GetDraftInput {
83
- emailId: string;
84
- }
85
- type GetDraftOutput = Schemas.PublicEmail;
86
- interface GetInput {
87
- /**
88
- * Whether to return only results that have been archived.
89
- */
90
- archived?: boolean;
91
- emailId: string;
92
- includedProperties?: string[];
93
- includeStats?: boolean;
94
- marketingCampaignNames?: boolean;
95
- variantStats?: boolean;
96
- workflowNames?: boolean;
97
- }
98
- type GetOutput = Schemas.PublicEmail;
99
- interface GetRevisionInput {
100
- emailId: string;
101
- revisionId: string;
102
- }
103
- type GetRevisionOutput = Schemas.PublicEmailVersion;
104
- interface ListRevisionsInput {
105
- /**
106
- * 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.
107
- */
108
- after?: string;
109
- before?: string;
110
- emailId: string;
111
- /**
112
- * The maximum number of results to display per page.
113
- */
114
- limit?: number;
115
- }
116
- type ListRevisionsOutput = Schemas.CollectionResponseWithTotalPublicEmailVersion;
117
- interface PublishInput {
118
- emailId: string;
119
- }
120
- type PublishOutput = void;
121
- interface ResetDraftInput {
122
- emailId: string;
123
- }
124
- type ResetDraftOutput = void;
125
- interface RestoreRevisionInput {
126
- emailId: string;
127
- revisionId: string;
128
- }
129
- type RestoreRevisionOutput = void;
130
- interface RestoreRevisionToDraftInput {
131
- emailId: string;
132
- revisionId: number;
133
- }
134
- type RestoreRevisionToDraftOutput = Schemas.PublicEmail;
135
- interface UnpublishInput {
136
- emailId: string;
137
- }
138
- type UnpublishOutput = void;
139
- interface UpdateDraftInput {
140
- data: Schemas.EmailUpdateRequest;
141
- emailId: string;
142
- }
143
- type UpdateDraftOutput = Schemas.PublicEmail;
144
- interface UpdateInput {
145
- /**
146
- * Whether to return only results that have been archived.
147
- */
148
- archived?: boolean;
149
- data: Schemas.EmailUpdateRequest;
150
- emailId: string;
151
- }
152
- type UpdateOutput = Schemas.PublicEmail;
153
- }
154
- namespace Schemas {
155
- interface AbTestCreateRequestVNext {
156
- /**
157
- * ID of the object to test.
158
- */
159
- contentId: string;
160
- /**
161
- * Name of the variation to be created.
162
- */
163
- variationName: string;
164
- }
165
- interface AggregateEmailStatistics {
166
- aggregate: Schemas.EmailStatisticsData;
167
- /**
168
- * The aggregated statistics per campaign.
169
- */
170
- campaignAggregations: Record<string, Schemas.EmailStatisticsData>;
171
- /**
172
- * List of email IDs that were sent during the time span.
173
- */
174
- emails: number[];
175
- }
176
- interface CollectionResponseWithTotalEmailStatisticInterval {
177
- paging?: Schemas.Paging;
178
- results: Schemas.EmailStatisticInterval[];
179
- total: number;
180
- }
181
- interface CollectionResponseWithTotalPublicEmail {
182
- paging?: Schemas.Paging;
183
- results: Schemas.PublicEmail[];
184
- total: number;
185
- }
186
- interface CollectionResponseWithTotalPublicEmailVersion {
187
- paging?: Schemas.Paging;
188
- results: Schemas.VersionPublicEmail[];
189
- total: number;
190
- }
191
- interface EmailCloneRequestVNext {
192
- /**
193
- * The name to assign to the cloned email.
194
- */
195
- cloneName?: string;
196
- /**
197
- * The email ID.
198
- */
199
- id: string;
200
- /**
201
- * The language code for the cloned email, such as 'en' for English.
202
- */
203
- language?: string;
204
- }
205
- interface EmailCreateRequest {
206
- /**
207
- * The active domain of the email.
208
- */
209
- activeDomain?: string;
210
- /**
211
- * Determines if the email is archived or not.
212
- */
213
- archived?: boolean;
214
- /**
215
- * The ID of the business unit associated with the email.
216
- */
217
- businessUnitId?: number;
218
- /**
219
- * The ID of the campaign this email is associated to.
220
- */
221
- campaign?: string;
222
- content?: Schemas.PublicEmailContent;
223
- /**
224
- * The ID of the feedback survey linked to the email.
225
- */
226
- feedbackSurveyId?: string;
227
- /**
228
- * The ID of the folder where the email will be stored.
229
- */
230
- folderIdV2?: number;
231
- from?: Schemas.PublicEmailFromDetails;
232
- /**
233
- * Determines whether the email send time should be randomized to avoid sending all emails at the exact same time.
234
- */
235
- jitterSendTime?: boolean;
236
- /**
237
- * The language code for the email, such as 'en' for English.
238
- */
239
- language?: 'aa' | 'ab' | 'ae' | 'af' | 'af-na' | 'af-za' | 'agq' | 'agq-cm' | 'ak' | 'ak-gh' | 'am' | 'am-et' | 'an' | 'ann' | 'ann-ng' | 'ar' | 'ar-001' | 'ar-ae' | 'ar-bh' | 'ar-dj' | 'ar-dz' | 'ar-eg' | 'ar-eh' | 'ar-er' | 'ar-il' | 'ar-iq' | 'ar-jo' | 'ar-km' | 'ar-kw' | 'ar-lb' | 'ar-ly' | 'ar-ma' | 'ar-mr' | 'ar-om' | 'ar-ps' | 'ar-qa' | 'ar-sa' | 'ar-sd' | 'ar-so' | 'ar-ss' | 'ar-sy' | 'ar-td' | 'ar-tn' | 'ar-ye' | 'as' | 'as-in' | 'asa' | 'asa-tz' | 'ast' | 'ast-es' | 'av' | 'ay' | 'az' | 'az-az' | 'ba' | 'bas' | 'bas-cm' | 'be' | 'be-by' | 'bem' | 'bem-zm' | 'bez' | 'bez-tz' | 'bg' | 'bg-bg' | 'bgc' | 'bgc-in' | 'bho' | 'bho-in' | 'bi' | 'bm' | 'bm-ml' | 'bn' | 'bn-bd' | 'bn-in' | 'bo' | 'bo-cn' | 'bo-in' | 'br' | 'br-fr' | 'brx' | 'brx-in' | 'bs' | 'bs-ba' | 'ca' | 'ca-ad' | 'ca-es' | 'ca-fr' | 'ca-it' | 'ccp' | 'ccp-bd' | 'ccp-in' | 'ce' | 'ce-ru' | 'ceb' | 'ceb-ph' | 'cgg' | 'cgg-ug' | 'ch' | 'chr' | 'chr-us' | 'ckb' | 'ckb-iq' | 'ckb-ir' | 'co' | 'cr' | 'cs' | 'cs-cz' | 'cu' | 'cu-ru' | 'cv' | 'cv-ru' | 'cy' | 'cy-gb' | 'da' | 'da-dk' | 'da-gl' | 'dav' | 'dav-ke' | 'de' | 'de-at' | 'de-be' | 'de-ch' | 'de-de' | 'de-gr' | 'de-it' | 'de-li' | 'de-lu' | 'dje' | 'dje-ne' | 'doi' | 'doi-in' | 'dsb' | 'dsb-de' | 'dua' | 'dua-cm' | 'dv' | 'dyo' | 'dyo-sn' | 'dz' | 'dz-bt' | 'ebu' | 'ebu-ke' | 'ee' | 'ee-gh' | 'ee-tg' | 'el' | 'el-cy' | 'el-gr' | 'en' | 'en-001' | 'en-150' | 'en-ae' | 'en-ag' | 'en-ai' | 'en-as' | 'en-at' | 'en-au' | 'en-bb' | 'en-be' | 'en-bi' | 'en-bm' | 'en-bs' | 'en-bw' | 'en-bz' | 'en-ca' | 'en-cc' | 'en-ch' | 'en-ck' | 'en-cm' | 'en-cn' | 'en-cx' | 'en-cy' | 'en-de' | 'en-dg' | 'en-dk' | 'en-dm' | 'en-ee' | 'en-eg' | 'en-er' | 'en-es' | 'en-fi' | 'en-fj' | 'en-fk' | 'en-fm' | 'en-fr' | 'en-gb' | 'en-gd' | 'en-gg' | 'en-gh' | 'en-gi' | 'en-gm' | 'en-gu' | 'en-gy' | 'en-hk' | 'en-id' | 'en-ie' | 'en-il' | 'en-im' | 'en-in' | 'en-io' | 'en-je' | 'en-jm' | 'en-ke' | 'en-ki' | 'en-kn' | 'en-ky' | 'en-lc' | 'en-lr' | 'en-ls' | 'en-lu' | 'en-mg' | 'en-mh' | 'en-mo' | 'en-mp' | 'en-ms' | 'en-mt' | 'en-mu' | 'en-mv' | 'en-mw' | 'en-mx' | 'en-my' | 'en-na' | 'en-nf' | 'en-ng' | 'en-nl' | 'en-nr' | 'en-nu' | 'en-nz' | 'en-pg' | 'en-ph' | 'en-pk' | 'en-pn' | 'en-pr' | 'en-pt' | 'en-pw' | 'en-rw' | 'en-sb' | 'en-sc' | 'en-sd' | 'en-se' | 'en-sg' | 'en-sh' | 'en-si' | 'en-sl' | 'en-ss' | 'en-sx' | 'en-sz' | 'en-tc' | 'en-th' | 'en-tk' | 'en-tn' | 'en-to' | 'en-tt' | 'en-tv' | 'en-tz' | 'en-ug' | 'en-um' | 'en-us' | 'en-vc' | 'en-vg' | 'en-vi' | 'en-vn' | 'en-vu' | 'en-ws' | 'en-za' | 'en-zm' | 'en-zw' | 'eo' | 'eo-001' | 'es' | 'es-419' | 'es-ar' | 'es-bo' | 'es-br' | 'es-bz' | 'es-cl' | 'es-co' | 'es-cr' | 'es-cu' | 'es-do' | 'es-ea' | 'es-ec' | 'es-es' | 'es-gq' | 'es-gt' | 'es-hn' | 'es-ic' | 'es-mx' | 'es-ni' | 'es-pa' | 'es-pe' | 'es-ph' | 'es-pr' | 'es-py' | 'es-sv' | 'es-us' | 'es-uy' | 'es-ve' | 'et' | 'et-ee' | 'eu' | 'eu-es' | 'ewo' | 'ewo-cm' | 'fa' | 'fa-af' | 'fa-ir' | 'ff' | 'ff-bf' | 'ff-cm' | 'ff-gh' | 'ff-gm' | 'ff-gn' | 'ff-gw' | 'ff-lr' | 'ff-mr' | 'ff-ne' | 'ff-ng' | 'ff-sl' | 'ff-sn' | 'fi' | 'fi-fi' | 'fil' | 'fil-ph' | 'fj' | 'fo' | 'fo-dk' | 'fo-fo' | 'fr' | 'fr-be' | 'fr-bf' | 'fr-bi' | 'fr-bj' | 'fr-bl' | 'fr-ca' | 'fr-cd' | 'fr-cf' | 'fr-cg' | 'fr-ch' | 'fr-ci' | 'fr-cm' | 'fr-dj' | 'fr-dz' | 'fr-fr' | 'fr-ga' | 'fr-gf' | 'fr-gn' | 'fr-gp' | 'fr-gq' | 'fr-ht' | 'fr-km' | 'fr-lu' | 'fr-ma' | 'fr-mc' | 'fr-mf' | 'fr-mg' | 'fr-ml' | 'fr-mq' | 'fr-mr' | 'fr-mu' | 'fr-nc' | 'fr-ne' | 'fr-pf' | 'fr-pm' | 'fr-re' | 'fr-rw' | 'fr-sc' | 'fr-sn' | 'fr-sy' | 'fr-td' | 'fr-tg' | 'fr-tn' | 'fr-vu' | 'fr-wf' | 'fr-yt' | 'frr' | 'frr-de' | 'fur' | 'fur-it' | 'fy' | 'fy-nl' | 'ga' | 'ga-gb' | 'ga-ie' | 'gd' | 'gd-gb' | 'gl' | 'gl-es' | 'gn' | 'gsw' | 'gsw-ch' | 'gsw-fr' | 'gsw-li' | 'gu' | 'gu-in' | 'guz' | 'guz-ke' | 'gv' | 'gv-im' | 'ha' | 'ha-gh' | 'ha-ne' | 'ha-ng' | 'haw' | 'haw-us' | 'he' | 'he-il' | 'hi' | 'hi-in' | 'hmn' | 'ho' | 'hr' | 'hr-ba' | 'hr-hr' | 'hsb' | 'hsb-de' | 'ht' | 'hu' | 'hu-hu' | 'hy' | 'hy-am' | 'hz' | 'ia' | 'ia-001' | 'id' | 'id-id' | 'ie' | 'ig' | 'ig-ng' | 'ii' | 'ii-cn' | 'ik' | 'io' | 'is' | 'is-is' | 'it' | 'it-ch' | 'it-it' | 'it-sm' | 'it-va' | 'iu' | 'ja' | 'ja-jp' | 'jgo' | 'jgo-cm' | 'jmc' | 'jmc-tz' | 'jv' | 'jv-id' | 'ka' | 'ka-ge' | 'kab' | 'kab-dz' | 'kam' | 'kam-ke' | 'kar' | 'kde' | 'kde-tz' | 'kea' | 'kea-cv' | 'kg' | 'kgp' | 'kgp-br' | 'kh' | 'khq' | 'khq-ml' | 'ki' | 'ki-ke' | 'kj' | 'kk' | 'kk-kz' | 'kkj' | 'kkj-cm' | 'kl' | 'kl-gl' | 'kln' | 'kln-ke' | 'km' | 'km-kh' | 'kn' | 'kn-in' | 'ko' | 'ko-kp' | 'ko-kr' | 'kok' | 'kok-in' | 'kr' | 'ks' | 'ks-in' | 'ksb' | 'ksb-tz' | 'ksf' | 'ksf-cm' | 'ksh' | 'ksh-de' | 'ku' | 'ku-tr' | 'kv' | 'kw' | 'kw-gb' | 'ky' | 'ky-kg' | 'la' | 'lag' | 'lag-tz' | 'lb' | 'lb-lu' | 'lg' | 'lg-ug' | 'li' | 'lkt' | 'lkt-us' | 'ln' | 'ln-ao' | 'ln-cd' | 'ln-cf' | 'ln-cg' | 'lo' | 'lo-la' | 'lrc' | 'lrc-iq' | 'lrc-ir' | 'lt' | 'lt-lt' | 'lu' | 'lu-cd' | 'luo' | 'luo-ke' | 'luy' | 'luy-ke' | 'lv' | 'lv-lv' | 'mai' | 'mai-in' | 'mas' | 'mas-ke' | 'mas-tz' | 'mdf' | 'mdf-ru' | 'mer' | 'mer-ke' | 'mfe' | 'mfe-mu' | 'mg' | 'mg-mg' | 'mgh' | 'mgh-mz' | 'mgo' | 'mgo-cm' | 'mh' | 'mi' | 'mi-nz' | 'mk' | 'mk-mk' | 'ml' | 'ml-in' | 'mn' | 'mn-mn' | 'mni' | 'mni-in' | 'mr' | 'mr-in' | 'ms' | 'ms-bn' | 'ms-id' | 'ms-my' | 'ms-sg' | 'mt' | 'mt-mt' | 'mua' | 'mua-cm' | 'my' | 'my-mm' | 'mzn' | 'mzn-ir' | 'na' | 'naq' | 'naq-na' | 'nb' | 'nb-no' | 'nb-sj' | 'nd' | 'nd-zw' | 'nds' | 'nds-de' | 'nds-nl' | 'ne' | 'ne-in' | 'ne-np' | 'ng' | 'nl' | 'nl-aw' | 'nl-be' | 'nl-bq' | 'nl-ch' | 'nl-cw' | 'nl-lu' | 'nl-nl' | 'nl-sr' | 'nl-sx' | 'nmg' | 'nmg-cm' | 'nn' | 'nn-no' | 'nnh' | 'nnh-cm' | 'no' | 'no-no' | 'nr' | 'nus' | 'nus-ss' | 'nv' | 'ny' | 'nyn' | 'nyn-ug' | 'oc' | 'oc-es' | 'oc-fr' | 'oj' | 'om' | 'om-et' | 'om-ke' | 'or' | 'or-in' | 'os' | 'os-ge' | 'os-ru' | 'pa' | 'pa-in' | 'pa-pk' | 'pcm' | 'pcm-ng' | 'pi' | 'pis' | 'pis-sb' | 'pl' | 'pl-pl' | 'prg' | 'prg-001' | 'ps' | 'ps-af' | 'ps-pk' | 'pt' | 'pt-ao' | 'pt-br' | 'pt-ch' | 'pt-cv' | 'pt-gq' | 'pt-gw' | 'pt-lu' | 'pt-mo' | 'pt-mz' | 'pt-pt' | 'pt-st' | 'pt-tl' | 'qu' | 'qu-bo' | 'qu-ec' | 'qu-pe' | 'raj' | 'raj-in' | 'rm' | 'rm-ch' | 'rn' | 'rn-bi' | 'ro' | 'ro-md' | 'ro-ro' | 'rof' | 'rof-tz' | 'ru' | 'ru-by' | 'ru-kg' | 'ru-kz' | 'ru-md' | 'ru-ru' | 'ru-ua' | 'rw' | 'rw-rw' | 'rwk' | 'rwk-tz' | 'sa' | 'sa-in' | 'sah' | 'sah-ru' | 'saq' | 'saq-ke' | 'sat' | 'sat-in' | 'sbp' | 'sbp-tz' | 'sc' | 'sc-it' | 'sd' | 'sd-in' | 'sd-pk' | 'se' | 'se-fi' | 'se-no' | 'se-se' | 'seh' | 'seh-mz' | 'ses' | 'ses-ml' | 'sg' | 'sg-cf' | 'shi' | 'shi-ma' | 'si' | 'si-lk' | 'sk' | 'sk-sk' | 'sl' | 'sl-si' | 'sm' | 'smn' | 'smn-fi' | 'sms' | 'sms-fi' | 'sn' | 'sn-zw' | 'so' | 'so-dj' | 'so-et' | 'so-ke' | 'so-so' | 'sq' | 'sq-al' | 'sq-mk' | 'sq-xk' | 'sr' | 'sr-ba' | 'sr-cs' | 'sr-me' | 'sr-rs' | 'sr-xk' | 'ss' | 'st' | 'su' | 'su-id' | 'sv' | 'sv-ax' | 'sv-fi' | 'sv-se' | 'sw' | 'sw-cd' | 'sw-ke' | 'sw-tz' | 'sw-ug' | 'sy' | 'ta' | 'ta-in' | 'ta-lk' | 'ta-my' | 'ta-sg' | 'te' | 'te-in' | 'teo' | 'teo-ke' | 'teo-ug' | 'tg' | 'tg-tj' | 'th' | 'th-th' | 'ti' | 'ti-er' | 'ti-et' | 'tk' | 'tk-tm' | 'tl' | 'tn' | 'to' | 'to-to' | 'tok' | 'tok-001' | 'tr' | 'tr-cy' | 'tr-tr' | 'ts' | 'tt' | 'tt-ru' | 'tw' | 'twq' | 'twq-ne' | 'ty' | 'tzm' | 'tzm-ma' | 'ug' | 'ug-cn' | 'uk' | 'uk-ua' | 'ur' | 'ur-in' | 'ur-pk' | 'uz' | 'uz-af' | 'uz-uz' | 'vai' | 'vai-lr' | 've' | 'vi' | 'vi-vn' | 'vo' | 'vo-001' | 'vun' | 'vun-tz' | 'wa' | 'wae' | 'wae-ch' | 'wo' | 'wo-sn' | 'xh' | 'xh-za' | 'xog' | 'xog-ug' | 'yav' | 'yav-cm' | 'yi' | 'yi-001' | 'yo' | 'yo-bj' | 'yo-ng' | 'yrl' | 'yrl-br' | 'yrl-co' | 'yrl-ve' | 'yue' | 'yue-cn' | 'yue-hk' | 'za' | 'zgh' | 'zgh-ma' | 'zh' | 'zh-cn' | 'zh-hans' | 'zh-hant' | 'zh-hk' | 'zh-mo' | 'zh-sg' | 'zh-tw' | 'zu' | 'zu-za';
240
- /**
241
- * The name of the email, as displayed on the email dashboard.
242
- */
243
- name?: string;
244
- /**
245
- * The date and time the email is scheduled for, in ISO8601 representation. This is only used in local time or scheduled emails.
246
- */
247
- publishDate?: string;
248
- rssData?: Schemas.PublicRssEmailDetails;
249
- /**
250
- * Determines whether the email will be sent immediately on publish.
251
- */
252
- sendOnPublish?: boolean;
253
- /**
254
- * The email state.
255
- */
256
- state?: 'AGENT_GENERATED' | 'AUTOMATED' | 'AUTOMATED_AB' | 'AUTOMATED_AB_VARIANT' | 'AUTOMATED_DRAFT' | 'AUTOMATED_DRAFT_AB' | 'AUTOMATED_DRAFT_ABVARIANT' | 'AUTOMATED_FOR_FORM' | 'AUTOMATED_FOR_FORM_BUFFER' | 'AUTOMATED_FOR_FORM_DRAFT' | 'AUTOMATED_FOR_FORM_LEGACY' | 'AUTOMATED_LOSER_ABVARIANT' | 'AUTOMATED_SENDING' | 'BLOG_EMAIL_DRAFT' | 'BLOG_EMAIL_PUBLISHED' | 'DRAFT' | 'DRAFT_AB' | 'DRAFT_AB_VARIANT' | 'ERROR' | 'LOSER_AB_VARIANT' | 'PAGE_STUB' | 'PRE_PROCESSING' | 'PROCESSING' | 'PUBLISHED' | 'PUBLISHED_AB' | 'PUBLISHED_AB_VARIANT' | 'PUBLISHED_OR_SCHEDULED' | 'RSS_TO_EMAIL_DRAFT' | 'RSS_TO_EMAIL_PUBLISHED' | 'SCHEDULED' | 'SCHEDULED_AB' | 'SCHEDULED_OR_PUBLISHED';
257
- /**
258
- * The email subcategory.
259
- */
260
- subcategory?: 'ab_loser_variant' | 'ab_loser_variant_site_page' | 'ab_master' | 'ab_master_site_page' | 'ab_variant' | 'ab_variant_site_page' | 'automated' | 'automated_ab_master' | 'automated_ab_variant' | 'automated_for_crm' | 'automated_for_custom_survey' | 'automated_for_deal' | 'automated_for_feedback_ces' | 'automated_for_feedback_custom' | 'automated_for_feedback_nps' | 'automated_for_form' | 'automated_for_form_buffer' | 'automated_for_form_draft' | 'automated_for_form_legacy' | 'automated_for_leadflow' | 'automated_for_ticket' | 'batch' | 'blog_article_instance_layout' | 'blog_article_listing' | 'blog_author_detail' | 'blog_email' | 'blog_email_child' | 'case_study' | 'case_study_instance_layout' | 'case_study_listing' | 'discardable_stub' | 'imported_blog_post' | 'kb_404_page' | 'kb_article_instance_layout' | 'kb_listing' | 'kb_search_results' | 'kb_support_form' | 'landing_page' | 'legacy_blog_post' | 'legacy_page' | 'localtime' | 'manage_preferences_email' | 'marketing_single_send_api' | 'membership_email_verification' | 'membership_follow_up' | 'membership_otp_login' | 'membership_password_reset' | 'membership_password_saved' | 'membership_passwordless_auth' | 'membership_registration' | 'membership_registration_follow_up' | 'membership_verification' | 'normal_blog_post' | 'optin_email' | 'optin_followup_email' | 'page_instance_layout' | 'page_stub' | 'performable_landing_page' | 'performable_landing_page_cutover' | 'podcast_instance_layout' | 'podcast_listing' | 'portal_content' | 'resubscribe_confirmation_email' | 'resubscribe_email' | 'rss_to_email' | 'rss_to_email_child' | 'scp_instance_layout_page' | 'scp_static_page' | 'single_send_api' | 'site_page' | 'smtp_token' | 'staged_page' | 'ticket_closed_kickback_email' | 'ticket_opened_kickback_email' | 'ticket_pipeline_automated' | 'UNKNOWN' | 'unsubscribe_confirmation_email' | 'web_interactive';
261
- /**
262
- * The subject of the email.
263
- */
264
- subject?: string;
265
- subscriptionDetails?: Schemas.PublicEmailSubscriptionDetails;
266
- testing?: Schemas.PublicEmailTestingDetails;
267
- to?: Schemas.PublicEmailToDetails;
268
- webversion?: Schemas.PublicWebversionDetails;
269
- }
270
- interface EmailStatisticInterval {
271
- aggregations: Schemas.EmailStatisticsData;
272
- interval: Schemas.Interval;
273
- }
274
- interface EmailStatisticsData {
275
- /**
276
- * Counters like number of `sent`, `open` or `delivered`.
277
- */
278
- counters: Record<string, number>;
279
- /**
280
- * Statistics by device.
281
- */
282
- deviceBreakdown: Record<string, Record<string, number>>;
283
- /**
284
- * Number of emails that were dropped and bounced.
285
- */
286
- qualifierStats: Record<string, Record<string, number>>;
287
- /**
288
- * Ratios like `openratio` or `clickratio`
289
- */
290
- ratios: Record<string, number>;
291
- }
292
- interface EmailUpdateRequest {
293
- /**
294
- * The active domain of the email.
295
- */
296
- activeDomain?: string;
297
- /**
298
- * Determines if the email is archived or not.
299
- */
300
- archived?: boolean;
301
- /**
302
- * The ID of the business unit associated with the email.
303
- */
304
- businessUnitId?: number;
305
- /**
306
- * The ID of the campaign this email is associated to.
307
- */
308
- campaign?: string;
309
- content?: Schemas.PublicEmailContent;
310
- /**
311
- * The ID of the folder where the email will be stored.
312
- */
313
- folderIdV2?: number;
314
- from?: Schemas.PublicEmailFromDetails;
315
- /**
316
- * Determines whether the email send time should be randomized to avoid sending all emails at the exact same time.
317
- */
318
- jitterSendTime?: boolean;
319
- /**
320
- * The language code for the email, such as 'en' for English.
321
- */
322
- language?: 'aa' | 'ab' | 'ae' | 'af' | 'af-na' | 'af-za' | 'agq' | 'agq-cm' | 'ak' | 'ak-gh' | 'am' | 'am-et' | 'an' | 'ann' | 'ann-ng' | 'ar' | 'ar-001' | 'ar-ae' | 'ar-bh' | 'ar-dj' | 'ar-dz' | 'ar-eg' | 'ar-eh' | 'ar-er' | 'ar-il' | 'ar-iq' | 'ar-jo' | 'ar-km' | 'ar-kw' | 'ar-lb' | 'ar-ly' | 'ar-ma' | 'ar-mr' | 'ar-om' | 'ar-ps' | 'ar-qa' | 'ar-sa' | 'ar-sd' | 'ar-so' | 'ar-ss' | 'ar-sy' | 'ar-td' | 'ar-tn' | 'ar-ye' | 'as' | 'as-in' | 'asa' | 'asa-tz' | 'ast' | 'ast-es' | 'av' | 'ay' | 'az' | 'az-az' | 'ba' | 'bas' | 'bas-cm' | 'be' | 'be-by' | 'bem' | 'bem-zm' | 'bez' | 'bez-tz' | 'bg' | 'bg-bg' | 'bgc' | 'bgc-in' | 'bho' | 'bho-in' | 'bi' | 'bm' | 'bm-ml' | 'bn' | 'bn-bd' | 'bn-in' | 'bo' | 'bo-cn' | 'bo-in' | 'br' | 'br-fr' | 'brx' | 'brx-in' | 'bs' | 'bs-ba' | 'ca' | 'ca-ad' | 'ca-es' | 'ca-fr' | 'ca-it' | 'ccp' | 'ccp-bd' | 'ccp-in' | 'ce' | 'ce-ru' | 'ceb' | 'ceb-ph' | 'cgg' | 'cgg-ug' | 'ch' | 'chr' | 'chr-us' | 'ckb' | 'ckb-iq' | 'ckb-ir' | 'co' | 'cr' | 'cs' | 'cs-cz' | 'cu' | 'cu-ru' | 'cv' | 'cv-ru' | 'cy' | 'cy-gb' | 'da' | 'da-dk' | 'da-gl' | 'dav' | 'dav-ke' | 'de' | 'de-at' | 'de-be' | 'de-ch' | 'de-de' | 'de-gr' | 'de-it' | 'de-li' | 'de-lu' | 'dje' | 'dje-ne' | 'doi' | 'doi-in' | 'dsb' | 'dsb-de' | 'dua' | 'dua-cm' | 'dv' | 'dyo' | 'dyo-sn' | 'dz' | 'dz-bt' | 'ebu' | 'ebu-ke' | 'ee' | 'ee-gh' | 'ee-tg' | 'el' | 'el-cy' | 'el-gr' | 'en' | 'en-001' | 'en-150' | 'en-ae' | 'en-ag' | 'en-ai' | 'en-as' | 'en-at' | 'en-au' | 'en-bb' | 'en-be' | 'en-bi' | 'en-bm' | 'en-bs' | 'en-bw' | 'en-bz' | 'en-ca' | 'en-cc' | 'en-ch' | 'en-ck' | 'en-cm' | 'en-cn' | 'en-cx' | 'en-cy' | 'en-de' | 'en-dg' | 'en-dk' | 'en-dm' | 'en-ee' | 'en-eg' | 'en-er' | 'en-es' | 'en-fi' | 'en-fj' | 'en-fk' | 'en-fm' | 'en-fr' | 'en-gb' | 'en-gd' | 'en-gg' | 'en-gh' | 'en-gi' | 'en-gm' | 'en-gu' | 'en-gy' | 'en-hk' | 'en-id' | 'en-ie' | 'en-il' | 'en-im' | 'en-in' | 'en-io' | 'en-je' | 'en-jm' | 'en-ke' | 'en-ki' | 'en-kn' | 'en-ky' | 'en-lc' | 'en-lr' | 'en-ls' | 'en-lu' | 'en-mg' | 'en-mh' | 'en-mo' | 'en-mp' | 'en-ms' | 'en-mt' | 'en-mu' | 'en-mv' | 'en-mw' | 'en-mx' | 'en-my' | 'en-na' | 'en-nf' | 'en-ng' | 'en-nl' | 'en-nr' | 'en-nu' | 'en-nz' | 'en-pg' | 'en-ph' | 'en-pk' | 'en-pn' | 'en-pr' | 'en-pt' | 'en-pw' | 'en-rw' | 'en-sb' | 'en-sc' | 'en-sd' | 'en-se' | 'en-sg' | 'en-sh' | 'en-si' | 'en-sl' | 'en-ss' | 'en-sx' | 'en-sz' | 'en-tc' | 'en-th' | 'en-tk' | 'en-tn' | 'en-to' | 'en-tt' | 'en-tv' | 'en-tz' | 'en-ug' | 'en-um' | 'en-us' | 'en-vc' | 'en-vg' | 'en-vi' | 'en-vn' | 'en-vu' | 'en-ws' | 'en-za' | 'en-zm' | 'en-zw' | 'eo' | 'eo-001' | 'es' | 'es-419' | 'es-ar' | 'es-bo' | 'es-br' | 'es-bz' | 'es-cl' | 'es-co' | 'es-cr' | 'es-cu' | 'es-do' | 'es-ea' | 'es-ec' | 'es-es' | 'es-gq' | 'es-gt' | 'es-hn' | 'es-ic' | 'es-mx' | 'es-ni' | 'es-pa' | 'es-pe' | 'es-ph' | 'es-pr' | 'es-py' | 'es-sv' | 'es-us' | 'es-uy' | 'es-ve' | 'et' | 'et-ee' | 'eu' | 'eu-es' | 'ewo' | 'ewo-cm' | 'fa' | 'fa-af' | 'fa-ir' | 'ff' | 'ff-bf' | 'ff-cm' | 'ff-gh' | 'ff-gm' | 'ff-gn' | 'ff-gw' | 'ff-lr' | 'ff-mr' | 'ff-ne' | 'ff-ng' | 'ff-sl' | 'ff-sn' | 'fi' | 'fi-fi' | 'fil' | 'fil-ph' | 'fj' | 'fo' | 'fo-dk' | 'fo-fo' | 'fr' | 'fr-be' | 'fr-bf' | 'fr-bi' | 'fr-bj' | 'fr-bl' | 'fr-ca' | 'fr-cd' | 'fr-cf' | 'fr-cg' | 'fr-ch' | 'fr-ci' | 'fr-cm' | 'fr-dj' | 'fr-dz' | 'fr-fr' | 'fr-ga' | 'fr-gf' | 'fr-gn' | 'fr-gp' | 'fr-gq' | 'fr-ht' | 'fr-km' | 'fr-lu' | 'fr-ma' | 'fr-mc' | 'fr-mf' | 'fr-mg' | 'fr-ml' | 'fr-mq' | 'fr-mr' | 'fr-mu' | 'fr-nc' | 'fr-ne' | 'fr-pf' | 'fr-pm' | 'fr-re' | 'fr-rw' | 'fr-sc' | 'fr-sn' | 'fr-sy' | 'fr-td' | 'fr-tg' | 'fr-tn' | 'fr-vu' | 'fr-wf' | 'fr-yt' | 'frr' | 'frr-de' | 'fur' | 'fur-it' | 'fy' | 'fy-nl' | 'ga' | 'ga-gb' | 'ga-ie' | 'gd' | 'gd-gb' | 'gl' | 'gl-es' | 'gn' | 'gsw' | 'gsw-ch' | 'gsw-fr' | 'gsw-li' | 'gu' | 'gu-in' | 'guz' | 'guz-ke' | 'gv' | 'gv-im' | 'ha' | 'ha-gh' | 'ha-ne' | 'ha-ng' | 'haw' | 'haw-us' | 'he' | 'he-il' | 'hi' | 'hi-in' | 'hmn' | 'ho' | 'hr' | 'hr-ba' | 'hr-hr' | 'hsb' | 'hsb-de' | 'ht' | 'hu' | 'hu-hu' | 'hy' | 'hy-am' | 'hz' | 'ia' | 'ia-001' | 'id' | 'id-id' | 'ie' | 'ig' | 'ig-ng' | 'ii' | 'ii-cn' | 'ik' | 'io' | 'is' | 'is-is' | 'it' | 'it-ch' | 'it-it' | 'it-sm' | 'it-va' | 'iu' | 'ja' | 'ja-jp' | 'jgo' | 'jgo-cm' | 'jmc' | 'jmc-tz' | 'jv' | 'jv-id' | 'ka' | 'ka-ge' | 'kab' | 'kab-dz' | 'kam' | 'kam-ke' | 'kar' | 'kde' | 'kde-tz' | 'kea' | 'kea-cv' | 'kg' | 'kgp' | 'kgp-br' | 'kh' | 'khq' | 'khq-ml' | 'ki' | 'ki-ke' | 'kj' | 'kk' | 'kk-kz' | 'kkj' | 'kkj-cm' | 'kl' | 'kl-gl' | 'kln' | 'kln-ke' | 'km' | 'km-kh' | 'kn' | 'kn-in' | 'ko' | 'ko-kp' | 'ko-kr' | 'kok' | 'kok-in' | 'kr' | 'ks' | 'ks-in' | 'ksb' | 'ksb-tz' | 'ksf' | 'ksf-cm' | 'ksh' | 'ksh-de' | 'ku' | 'ku-tr' | 'kv' | 'kw' | 'kw-gb' | 'ky' | 'ky-kg' | 'la' | 'lag' | 'lag-tz' | 'lb' | 'lb-lu' | 'lg' | 'lg-ug' | 'li' | 'lkt' | 'lkt-us' | 'ln' | 'ln-ao' | 'ln-cd' | 'ln-cf' | 'ln-cg' | 'lo' | 'lo-la' | 'lrc' | 'lrc-iq' | 'lrc-ir' | 'lt' | 'lt-lt' | 'lu' | 'lu-cd' | 'luo' | 'luo-ke' | 'luy' | 'luy-ke' | 'lv' | 'lv-lv' | 'mai' | 'mai-in' | 'mas' | 'mas-ke' | 'mas-tz' | 'mdf' | 'mdf-ru' | 'mer' | 'mer-ke' | 'mfe' | 'mfe-mu' | 'mg' | 'mg-mg' | 'mgh' | 'mgh-mz' | 'mgo' | 'mgo-cm' | 'mh' | 'mi' | 'mi-nz' | 'mk' | 'mk-mk' | 'ml' | 'ml-in' | 'mn' | 'mn-mn' | 'mni' | 'mni-in' | 'mr' | 'mr-in' | 'ms' | 'ms-bn' | 'ms-id' | 'ms-my' | 'ms-sg' | 'mt' | 'mt-mt' | 'mua' | 'mua-cm' | 'my' | 'my-mm' | 'mzn' | 'mzn-ir' | 'na' | 'naq' | 'naq-na' | 'nb' | 'nb-no' | 'nb-sj' | 'nd' | 'nd-zw' | 'nds' | 'nds-de' | 'nds-nl' | 'ne' | 'ne-in' | 'ne-np' | 'ng' | 'nl' | 'nl-aw' | 'nl-be' | 'nl-bq' | 'nl-ch' | 'nl-cw' | 'nl-lu' | 'nl-nl' | 'nl-sr' | 'nl-sx' | 'nmg' | 'nmg-cm' | 'nn' | 'nn-no' | 'nnh' | 'nnh-cm' | 'no' | 'no-no' | 'nr' | 'nus' | 'nus-ss' | 'nv' | 'ny' | 'nyn' | 'nyn-ug' | 'oc' | 'oc-es' | 'oc-fr' | 'oj' | 'om' | 'om-et' | 'om-ke' | 'or' | 'or-in' | 'os' | 'os-ge' | 'os-ru' | 'pa' | 'pa-in' | 'pa-pk' | 'pcm' | 'pcm-ng' | 'pi' | 'pis' | 'pis-sb' | 'pl' | 'pl-pl' | 'prg' | 'prg-001' | 'ps' | 'ps-af' | 'ps-pk' | 'pt' | 'pt-ao' | 'pt-br' | 'pt-ch' | 'pt-cv' | 'pt-gq' | 'pt-gw' | 'pt-lu' | 'pt-mo' | 'pt-mz' | 'pt-pt' | 'pt-st' | 'pt-tl' | 'qu' | 'qu-bo' | 'qu-ec' | 'qu-pe' | 'raj' | 'raj-in' | 'rm' | 'rm-ch' | 'rn' | 'rn-bi' | 'ro' | 'ro-md' | 'ro-ro' | 'rof' | 'rof-tz' | 'ru' | 'ru-by' | 'ru-kg' | 'ru-kz' | 'ru-md' | 'ru-ru' | 'ru-ua' | 'rw' | 'rw-rw' | 'rwk' | 'rwk-tz' | 'sa' | 'sa-in' | 'sah' | 'sah-ru' | 'saq' | 'saq-ke' | 'sat' | 'sat-in' | 'sbp' | 'sbp-tz' | 'sc' | 'sc-it' | 'sd' | 'sd-in' | 'sd-pk' | 'se' | 'se-fi' | 'se-no' | 'se-se' | 'seh' | 'seh-mz' | 'ses' | 'ses-ml' | 'sg' | 'sg-cf' | 'shi' | 'shi-ma' | 'si' | 'si-lk' | 'sk' | 'sk-sk' | 'sl' | 'sl-si' | 'sm' | 'smn' | 'smn-fi' | 'sms' | 'sms-fi' | 'sn' | 'sn-zw' | 'so' | 'so-dj' | 'so-et' | 'so-ke' | 'so-so' | 'sq' | 'sq-al' | 'sq-mk' | 'sq-xk' | 'sr' | 'sr-ba' | 'sr-cs' | 'sr-me' | 'sr-rs' | 'sr-xk' | 'ss' | 'st' | 'su' | 'su-id' | 'sv' | 'sv-ax' | 'sv-fi' | 'sv-se' | 'sw' | 'sw-cd' | 'sw-ke' | 'sw-tz' | 'sw-ug' | 'sy' | 'ta' | 'ta-in' | 'ta-lk' | 'ta-my' | 'ta-sg' | 'te' | 'te-in' | 'teo' | 'teo-ke' | 'teo-ug' | 'tg' | 'tg-tj' | 'th' | 'th-th' | 'ti' | 'ti-er' | 'ti-et' | 'tk' | 'tk-tm' | 'tl' | 'tn' | 'to' | 'to-to' | 'tok' | 'tok-001' | 'tr' | 'tr-cy' | 'tr-tr' | 'ts' | 'tt' | 'tt-ru' | 'tw' | 'twq' | 'twq-ne' | 'ty' | 'tzm' | 'tzm-ma' | 'ug' | 'ug-cn' | 'uk' | 'uk-ua' | 'ur' | 'ur-in' | 'ur-pk' | 'uz' | 'uz-af' | 'uz-uz' | 'vai' | 'vai-lr' | 've' | 'vi' | 'vi-vn' | 'vo' | 'vo-001' | 'vun' | 'vun-tz' | 'wa' | 'wae' | 'wae-ch' | 'wo' | 'wo-sn' | 'xh' | 'xh-za' | 'xog' | 'xog-ug' | 'yav' | 'yav-cm' | 'yi' | 'yi-001' | 'yo' | 'yo-bj' | 'yo-ng' | 'yrl' | 'yrl-br' | 'yrl-co' | 'yrl-ve' | 'yue' | 'yue-cn' | 'yue-hk' | 'za' | 'zgh' | 'zgh-ma' | 'zh' | 'zh-cn' | 'zh-hans' | 'zh-hant' | 'zh-hk' | 'zh-mo' | 'zh-sg' | 'zh-tw' | 'zu' | 'zu-za';
323
- /**
324
- * The name of the email, as displayed on the email dashboard.
325
- */
326
- name?: string;
327
- /**
328
- * The date and time the email is scheduled for, in ISO8601 representation. This is only used in local time or scheduled emails.
329
- */
330
- publishDate?: string;
331
- rssData?: Schemas.PublicRssEmailDetails;
332
- /**
333
- * Determines whether the email will be sent immediately on publish.
334
- */
335
- sendOnPublish?: boolean;
336
- /**
337
- * The email state.
338
- */
339
- state?: 'AGENT_GENERATED' | 'AUTOMATED' | 'AUTOMATED_AB' | 'AUTOMATED_AB_VARIANT' | 'AUTOMATED_DRAFT' | 'AUTOMATED_DRAFT_AB' | 'AUTOMATED_DRAFT_ABVARIANT' | 'AUTOMATED_FOR_FORM' | 'AUTOMATED_FOR_FORM_BUFFER' | 'AUTOMATED_FOR_FORM_DRAFT' | 'AUTOMATED_FOR_FORM_LEGACY' | 'AUTOMATED_LOSER_ABVARIANT' | 'AUTOMATED_SENDING' | 'BLOG_EMAIL_DRAFT' | 'BLOG_EMAIL_PUBLISHED' | 'DRAFT' | 'DRAFT_AB' | 'DRAFT_AB_VARIANT' | 'ERROR' | 'LOSER_AB_VARIANT' | 'PAGE_STUB' | 'PRE_PROCESSING' | 'PROCESSING' | 'PUBLISHED' | 'PUBLISHED_AB' | 'PUBLISHED_AB_VARIANT' | 'PUBLISHED_OR_SCHEDULED' | 'RSS_TO_EMAIL_DRAFT' | 'RSS_TO_EMAIL_PUBLISHED' | 'SCHEDULED' | 'SCHEDULED_AB' | 'SCHEDULED_OR_PUBLISHED';
340
- /**
341
- * The email subcategory.
342
- */
343
- subcategory?: 'ab_loser_variant' | 'ab_loser_variant_site_page' | 'ab_master' | 'ab_master_site_page' | 'ab_variant' | 'ab_variant_site_page' | 'automated' | 'automated_ab_master' | 'automated_ab_variant' | 'automated_for_crm' | 'automated_for_custom_survey' | 'automated_for_deal' | 'automated_for_feedback_ces' | 'automated_for_feedback_custom' | 'automated_for_feedback_nps' | 'automated_for_form' | 'automated_for_form_buffer' | 'automated_for_form_draft' | 'automated_for_form_legacy' | 'automated_for_leadflow' | 'automated_for_ticket' | 'batch' | 'blog_article_instance_layout' | 'blog_article_listing' | 'blog_author_detail' | 'blog_email' | 'blog_email_child' | 'case_study' | 'case_study_instance_layout' | 'case_study_listing' | 'discardable_stub' | 'imported_blog_post' | 'kb_404_page' | 'kb_article_instance_layout' | 'kb_listing' | 'kb_search_results' | 'kb_support_form' | 'landing_page' | 'legacy_blog_post' | 'legacy_page' | 'localtime' | 'manage_preferences_email' | 'marketing_single_send_api' | 'membership_email_verification' | 'membership_follow_up' | 'membership_otp_login' | 'membership_password_reset' | 'membership_password_saved' | 'membership_passwordless_auth' | 'membership_registration' | 'membership_registration_follow_up' | 'membership_verification' | 'normal_blog_post' | 'optin_email' | 'optin_followup_email' | 'page_instance_layout' | 'page_stub' | 'performable_landing_page' | 'performable_landing_page_cutover' | 'podcast_instance_layout' | 'podcast_listing' | 'portal_content' | 'resubscribe_confirmation_email' | 'resubscribe_email' | 'rss_to_email' | 'rss_to_email_child' | 'scp_instance_layout_page' | 'scp_static_page' | 'single_send_api' | 'site_page' | 'smtp_token' | 'staged_page' | 'ticket_closed_kickback_email' | 'ticket_opened_kickback_email' | 'ticket_pipeline_automated' | 'UNKNOWN' | 'unsubscribe_confirmation_email' | 'web_interactive';
344
- /**
345
- * The subject of the email.
346
- */
347
- subject?: string;
348
- subscriptionDetails?: Schemas.PublicEmailSubscriptionDetails;
349
- testing?: Schemas.PublicEmailTestingDetails;
350
- to?: Schemas.PublicEmailToDetails;
351
- webversion?: Schemas.PublicWebversionDetails;
352
- }
353
- interface Interval {
354
- /**
355
- * The end timestamp of the interval, in ISO8601 format.
356
- */
357
- end: string;
358
- /**
359
- * The start timestamp of the interval, in ISO8601 format.
360
- */
361
- start: string;
362
- }
363
- /**
364
- * Specifies the paging information needed to retrieve the next set of results in a paginated API response
365
- */
366
- interface NextPage {
367
- /**
368
- * The cursor token value to get the next set of results. Use this value as query parameter (&after=...) to obtain the next page.
369
- */
370
- after: string;
371
- /**
372
- * The link to the next page.
373
- */
374
- link?: string;
375
- }
376
- interface Paging {
377
- next?: Schemas.NextPage;
378
- prev?: Schemas.PreviousPage;
379
- }
380
- /**
381
- * specifies the paging information needed to retrieve the previous set of results in a paginated API response
382
- */
383
- interface PreviousPage {
384
- /**
385
- * The cursor token value to get the previous set of results. Use this value as query parameter (&before=...) to obtain the previous page.
386
- */
387
- before: string;
388
- /**
389
- * The link to the previous page.
390
- */
391
- link?: string;
392
- }
393
- interface PublicButtonStyleSettings {
394
- backgroundColor?: Record<string, never>;
395
- cornerRadius?: number;
396
- fontStyle?: Schemas.PublicFontStyle;
397
- }
398
- interface PublicDividerStyleSettings {
399
- color?: Record<string, never>;
400
- height?: number;
401
- lineType?: string;
402
- }
403
- interface PublicEmail {
404
- /**
405
- * The active domain of the email.
406
- */
407
- activeDomain?: string;
408
- /**
409
- * List of emailCampaignIds.
410
- */
411
- allEmailCampaignIds?: string[];
412
- /**
413
- * Determines if the email is archived or not.
414
- */
415
- archived?: boolean;
416
- businessUnitId?: string;
417
- /**
418
- * The ID of the campaign this email is associated to.
419
- */
420
- campaign?: string;
421
- /**
422
- * The name of the campaign.
423
- */
424
- campaignName?: string;
425
- campaignUtm?: string;
426
- /**
427
- * The ID of the email this email was cloned from.
428
- */
429
- clonedFrom?: string;
430
- content?: Schemas.PublicEmailContent;
431
- /**
432
- * The date and time of the email's creation, in ISO8601 representation.
433
- */
434
- createdAt?: string;
435
- /**
436
- * The id of the user who created the email.
437
- */
438
- createdById?: string;
439
- /**
440
- * The date and time the email was deleted at, in ISO8601 representation.
441
- */
442
- deletedAt?: string;
443
- emailCampaignGroupId?: string;
444
- emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP';
445
- /**
446
- * The ID of the feedback survey linked to the email.
447
- */
448
- feedbackSurveyId?: string;
449
- folderId?: number;
450
- folderIdV2?: number;
451
- from?: Schemas.PublicEmailFromDetails;
452
- /**
453
- * The email ID.
454
- */
455
- id?: string;
456
- isAb: boolean;
457
- /**
458
- * Returns the published status of the email. This is read only.
459
- */
460
- isPublished?: boolean;
461
- /**
462
- * Returns whether the email is a transactional email or not. This is read only.
463
- */
464
- isTransactional?: boolean;
465
- jitterSendTime?: boolean;
466
- language?: 'aa' | 'ab' | 'ae' | 'af' | 'af-na' | 'af-za' | 'agq' | 'agq-cm' | 'ak' | 'ak-gh' | 'am' | 'am-et' | 'an' | 'ann' | 'ann-ng' | 'ar' | 'ar-001' | 'ar-ae' | 'ar-bh' | 'ar-dj' | 'ar-dz' | 'ar-eg' | 'ar-eh' | 'ar-er' | 'ar-il' | 'ar-iq' | 'ar-jo' | 'ar-km' | 'ar-kw' | 'ar-lb' | 'ar-ly' | 'ar-ma' | 'ar-mr' | 'ar-om' | 'ar-ps' | 'ar-qa' | 'ar-sa' | 'ar-sd' | 'ar-so' | 'ar-ss' | 'ar-sy' | 'ar-td' | 'ar-tn' | 'ar-ye' | 'as' | 'as-in' | 'asa' | 'asa-tz' | 'ast' | 'ast-es' | 'av' | 'ay' | 'az' | 'az-az' | 'ba' | 'bas' | 'bas-cm' | 'be' | 'be-by' | 'bem' | 'bem-zm' | 'bez' | 'bez-tz' | 'bg' | 'bg-bg' | 'bgc' | 'bgc-in' | 'bho' | 'bho-in' | 'bi' | 'bm' | 'bm-ml' | 'bn' | 'bn-bd' | 'bn-in' | 'bo' | 'bo-cn' | 'bo-in' | 'br' | 'br-fr' | 'brx' | 'brx-in' | 'bs' | 'bs-ba' | 'ca' | 'ca-ad' | 'ca-es' | 'ca-fr' | 'ca-it' | 'ccp' | 'ccp-bd' | 'ccp-in' | 'ce' | 'ce-ru' | 'ceb' | 'ceb-ph' | 'cgg' | 'cgg-ug' | 'ch' | 'chr' | 'chr-us' | 'ckb' | 'ckb-iq' | 'ckb-ir' | 'co' | 'cr' | 'cs' | 'cs-cz' | 'cu' | 'cu-ru' | 'cv' | 'cv-ru' | 'cy' | 'cy-gb' | 'da' | 'da-dk' | 'da-gl' | 'dav' | 'dav-ke' | 'de' | 'de-at' | 'de-be' | 'de-ch' | 'de-de' | 'de-gr' | 'de-it' | 'de-li' | 'de-lu' | 'dje' | 'dje-ne' | 'doi' | 'doi-in' | 'dsb' | 'dsb-de' | 'dua' | 'dua-cm' | 'dv' | 'dyo' | 'dyo-sn' | 'dz' | 'dz-bt' | 'ebu' | 'ebu-ke' | 'ee' | 'ee-gh' | 'ee-tg' | 'el' | 'el-cy' | 'el-gr' | 'en' | 'en-001' | 'en-150' | 'en-ae' | 'en-ag' | 'en-ai' | 'en-as' | 'en-at' | 'en-au' | 'en-bb' | 'en-be' | 'en-bi' | 'en-bm' | 'en-bs' | 'en-bw' | 'en-bz' | 'en-ca' | 'en-cc' | 'en-ch' | 'en-ck' | 'en-cm' | 'en-cn' | 'en-cx' | 'en-cy' | 'en-de' | 'en-dg' | 'en-dk' | 'en-dm' | 'en-ee' | 'en-eg' | 'en-er' | 'en-es' | 'en-fi' | 'en-fj' | 'en-fk' | 'en-fm' | 'en-fr' | 'en-gb' | 'en-gd' | 'en-gg' | 'en-gh' | 'en-gi' | 'en-gm' | 'en-gu' | 'en-gy' | 'en-hk' | 'en-id' | 'en-ie' | 'en-il' | 'en-im' | 'en-in' | 'en-io' | 'en-je' | 'en-jm' | 'en-ke' | 'en-ki' | 'en-kn' | 'en-ky' | 'en-lc' | 'en-lr' | 'en-ls' | 'en-lu' | 'en-mg' | 'en-mh' | 'en-mo' | 'en-mp' | 'en-ms' | 'en-mt' | 'en-mu' | 'en-mv' | 'en-mw' | 'en-mx' | 'en-my' | 'en-na' | 'en-nf' | 'en-ng' | 'en-nl' | 'en-nr' | 'en-nu' | 'en-nz' | 'en-pg' | 'en-ph' | 'en-pk' | 'en-pn' | 'en-pr' | 'en-pt' | 'en-pw' | 'en-rw' | 'en-sb' | 'en-sc' | 'en-sd' | 'en-se' | 'en-sg' | 'en-sh' | 'en-si' | 'en-sl' | 'en-ss' | 'en-sx' | 'en-sz' | 'en-tc' | 'en-th' | 'en-tk' | 'en-tn' | 'en-to' | 'en-tt' | 'en-tv' | 'en-tz' | 'en-ug' | 'en-um' | 'en-us' | 'en-vc' | 'en-vg' | 'en-vi' | 'en-vn' | 'en-vu' | 'en-ws' | 'en-za' | 'en-zm' | 'en-zw' | 'eo' | 'eo-001' | 'es' | 'es-419' | 'es-ar' | 'es-bo' | 'es-br' | 'es-bz' | 'es-cl' | 'es-co' | 'es-cr' | 'es-cu' | 'es-do' | 'es-ea' | 'es-ec' | 'es-es' | 'es-gq' | 'es-gt' | 'es-hn' | 'es-ic' | 'es-mx' | 'es-ni' | 'es-pa' | 'es-pe' | 'es-ph' | 'es-pr' | 'es-py' | 'es-sv' | 'es-us' | 'es-uy' | 'es-ve' | 'et' | 'et-ee' | 'eu' | 'eu-es' | 'ewo' | 'ewo-cm' | 'fa' | 'fa-af' | 'fa-ir' | 'ff' | 'ff-bf' | 'ff-cm' | 'ff-gh' | 'ff-gm' | 'ff-gn' | 'ff-gw' | 'ff-lr' | 'ff-mr' | 'ff-ne' | 'ff-ng' | 'ff-sl' | 'ff-sn' | 'fi' | 'fi-fi' | 'fil' | 'fil-ph' | 'fj' | 'fo' | 'fo-dk' | 'fo-fo' | 'fr' | 'fr-be' | 'fr-bf' | 'fr-bi' | 'fr-bj' | 'fr-bl' | 'fr-ca' | 'fr-cd' | 'fr-cf' | 'fr-cg' | 'fr-ch' | 'fr-ci' | 'fr-cm' | 'fr-dj' | 'fr-dz' | 'fr-fr' | 'fr-ga' | 'fr-gf' | 'fr-gn' | 'fr-gp' | 'fr-gq' | 'fr-ht' | 'fr-km' | 'fr-lu' | 'fr-ma' | 'fr-mc' | 'fr-mf' | 'fr-mg' | 'fr-ml' | 'fr-mq' | 'fr-mr' | 'fr-mu' | 'fr-nc' | 'fr-ne' | 'fr-pf' | 'fr-pm' | 'fr-re' | 'fr-rw' | 'fr-sc' | 'fr-sn' | 'fr-sy' | 'fr-td' | 'fr-tg' | 'fr-tn' | 'fr-vu' | 'fr-wf' | 'fr-yt' | 'frr' | 'frr-de' | 'fur' | 'fur-it' | 'fy' | 'fy-nl' | 'ga' | 'ga-gb' | 'ga-ie' | 'gd' | 'gd-gb' | 'gl' | 'gl-es' | 'gn' | 'gsw' | 'gsw-ch' | 'gsw-fr' | 'gsw-li' | 'gu' | 'gu-in' | 'guz' | 'guz-ke' | 'gv' | 'gv-im' | 'ha' | 'ha-gh' | 'ha-ne' | 'ha-ng' | 'haw' | 'haw-us' | 'he' | 'he-il' | 'hi' | 'hi-in' | 'hmn' | 'ho' | 'hr' | 'hr-ba' | 'hr-hr' | 'hsb' | 'hsb-de' | 'ht' | 'hu' | 'hu-hu' | 'hy' | 'hy-am' | 'hz' | 'ia' | 'ia-001' | 'id' | 'id-id' | 'ie' | 'ig' | 'ig-ng' | 'ii' | 'ii-cn' | 'ik' | 'io' | 'is' | 'is-is' | 'it' | 'it-ch' | 'it-it' | 'it-sm' | 'it-va' | 'iu' | 'ja' | 'ja-jp' | 'jgo' | 'jgo-cm' | 'jmc' | 'jmc-tz' | 'jv' | 'jv-id' | 'ka' | 'ka-ge' | 'kab' | 'kab-dz' | 'kam' | 'kam-ke' | 'kar' | 'kde' | 'kde-tz' | 'kea' | 'kea-cv' | 'kg' | 'kgp' | 'kgp-br' | 'kh' | 'khq' | 'khq-ml' | 'ki' | 'ki-ke' | 'kj' | 'kk' | 'kk-kz' | 'kkj' | 'kkj-cm' | 'kl' | 'kl-gl' | 'kln' | 'kln-ke' | 'km' | 'km-kh' | 'kn' | 'kn-in' | 'ko' | 'ko-kp' | 'ko-kr' | 'kok' | 'kok-in' | 'kr' | 'ks' | 'ks-in' | 'ksb' | 'ksb-tz' | 'ksf' | 'ksf-cm' | 'ksh' | 'ksh-de' | 'ku' | 'ku-tr' | 'kv' | 'kw' | 'kw-gb' | 'ky' | 'ky-kg' | 'la' | 'lag' | 'lag-tz' | 'lb' | 'lb-lu' | 'lg' | 'lg-ug' | 'li' | 'lkt' | 'lkt-us' | 'ln' | 'ln-ao' | 'ln-cd' | 'ln-cf' | 'ln-cg' | 'lo' | 'lo-la' | 'lrc' | 'lrc-iq' | 'lrc-ir' | 'lt' | 'lt-lt' | 'lu' | 'lu-cd' | 'luo' | 'luo-ke' | 'luy' | 'luy-ke' | 'lv' | 'lv-lv' | 'mai' | 'mai-in' | 'mas' | 'mas-ke' | 'mas-tz' | 'mdf' | 'mdf-ru' | 'mer' | 'mer-ke' | 'mfe' | 'mfe-mu' | 'mg' | 'mg-mg' | 'mgh' | 'mgh-mz' | 'mgo' | 'mgo-cm' | 'mh' | 'mi' | 'mi-nz' | 'mk' | 'mk-mk' | 'ml' | 'ml-in' | 'mn' | 'mn-mn' | 'mni' | 'mni-in' | 'mr' | 'mr-in' | 'ms' | 'ms-bn' | 'ms-id' | 'ms-my' | 'ms-sg' | 'mt' | 'mt-mt' | 'mua' | 'mua-cm' | 'my' | 'my-mm' | 'mzn' | 'mzn-ir' | 'na' | 'naq' | 'naq-na' | 'nb' | 'nb-no' | 'nb-sj' | 'nd' | 'nd-zw' | 'nds' | 'nds-de' | 'nds-nl' | 'ne' | 'ne-in' | 'ne-np' | 'ng' | 'nl' | 'nl-aw' | 'nl-be' | 'nl-bq' | 'nl-ch' | 'nl-cw' | 'nl-lu' | 'nl-nl' | 'nl-sr' | 'nl-sx' | 'nmg' | 'nmg-cm' | 'nn' | 'nn-no' | 'nnh' | 'nnh-cm' | 'no' | 'no-no' | 'nr' | 'nus' | 'nus-ss' | 'nv' | 'ny' | 'nyn' | 'nyn-ug' | 'oc' | 'oc-es' | 'oc-fr' | 'oj' | 'om' | 'om-et' | 'om-ke' | 'or' | 'or-in' | 'os' | 'os-ge' | 'os-ru' | 'pa' | 'pa-in' | 'pa-pk' | 'pcm' | 'pcm-ng' | 'pi' | 'pis' | 'pis-sb' | 'pl' | 'pl-pl' | 'prg' | 'prg-001' | 'ps' | 'ps-af' | 'ps-pk' | 'pt' | 'pt-ao' | 'pt-br' | 'pt-ch' | 'pt-cv' | 'pt-gq' | 'pt-gw' | 'pt-lu' | 'pt-mo' | 'pt-mz' | 'pt-pt' | 'pt-st' | 'pt-tl' | 'qu' | 'qu-bo' | 'qu-ec' | 'qu-pe' | 'raj' | 'raj-in' | 'rm' | 'rm-ch' | 'rn' | 'rn-bi' | 'ro' | 'ro-md' | 'ro-ro' | 'rof' | 'rof-tz' | 'ru' | 'ru-by' | 'ru-kg' | 'ru-kz' | 'ru-md' | 'ru-ru' | 'ru-ua' | 'rw' | 'rw-rw' | 'rwk' | 'rwk-tz' | 'sa' | 'sa-in' | 'sah' | 'sah-ru' | 'saq' | 'saq-ke' | 'sat' | 'sat-in' | 'sbp' | 'sbp-tz' | 'sc' | 'sc-it' | 'sd' | 'sd-in' | 'sd-pk' | 'se' | 'se-fi' | 'se-no' | 'se-se' | 'seh' | 'seh-mz' | 'ses' | 'ses-ml' | 'sg' | 'sg-cf' | 'shi' | 'shi-ma' | 'si' | 'si-lk' | 'sk' | 'sk-sk' | 'sl' | 'sl-si' | 'sm' | 'smn' | 'smn-fi' | 'sms' | 'sms-fi' | 'sn' | 'sn-zw' | 'so' | 'so-dj' | 'so-et' | 'so-ke' | 'so-so' | 'sq' | 'sq-al' | 'sq-mk' | 'sq-xk' | 'sr' | 'sr-ba' | 'sr-cs' | 'sr-me' | 'sr-rs' | 'sr-xk' | 'ss' | 'st' | 'su' | 'su-id' | 'sv' | 'sv-ax' | 'sv-fi' | 'sv-se' | 'sw' | 'sw-cd' | 'sw-ke' | 'sw-tz' | 'sw-ug' | 'sy' | 'ta' | 'ta-in' | 'ta-lk' | 'ta-my' | 'ta-sg' | 'te' | 'te-in' | 'teo' | 'teo-ke' | 'teo-ug' | 'tg' | 'tg-tj' | 'th' | 'th-th' | 'ti' | 'ti-er' | 'ti-et' | 'tk' | 'tk-tm' | 'tl' | 'tn' | 'to' | 'to-to' | 'tok' | 'tok-001' | 'tr' | 'tr-cy' | 'tr-tr' | 'ts' | 'tt' | 'tt-ru' | 'tw' | 'twq' | 'twq-ne' | 'ty' | 'tzm' | 'tzm-ma' | 'ug' | 'ug-cn' | 'uk' | 'uk-ua' | 'ur' | 'ur-in' | 'ur-pk' | 'uz' | 'uz-af' | 'uz-uz' | 'vai' | 'vai-lr' | 've' | 'vi' | 'vi-vn' | 'vo' | 'vo-001' | 'vun' | 'vun-tz' | 'wa' | 'wae' | 'wae-ch' | 'wo' | 'wo-sn' | 'xh' | 'xh-za' | 'xog' | 'xog-ug' | 'yav' | 'yav-cm' | 'yi' | 'yi-001' | 'yo' | 'yo-bj' | 'yo-ng' | 'yrl' | 'yrl-br' | 'yrl-co' | 'yrl-ve' | 'yue' | 'yue-cn' | 'yue-hk' | 'za' | 'zgh' | 'zgh-ma' | 'zh' | 'zh-cn' | 'zh-hans' | 'zh-hant' | 'zh-hk' | 'zh-mo' | 'zh-sg' | 'zh-tw' | 'zu' | 'zu-za';
467
- /**
468
- * The name of the email, as displayed on the email dashboard.
469
- */
470
- name?: string;
471
- previewKey?: string;
472
- primaryEmailCampaignId?: string;
473
- /**
474
- * The date and time the email is scheduled for, in ISO8601 representation. This is only used in local time or scheduled emails.
475
- */
476
- publishDate?: string;
477
- /**
478
- * The date and time the email was published at, in ISO8601 representation.
479
- */
480
- publishedAt?: string;
481
- /**
482
- * Email of the user who published/sent the email.
483
- */
484
- publishedByEmail?: string;
485
- /**
486
- * The ID of the user who published the email.
487
- */
488
- publishedById?: string;
489
- /**
490
- * Name of the user who published the email.
491
- */
492
- publishedByName?: string;
493
- rssData?: Schemas.PublicRssEmailDetails;
494
- /**
495
- * Determines whether the email will be sent immediately on publish.
496
- */
497
- sendOnPublish?: boolean;
498
- /**
499
- * The email state.
500
- */
501
- state?: 'AGENT_GENERATED' | 'AUTOMATED' | 'AUTOMATED_AB' | 'AUTOMATED_AB_VARIANT' | 'AUTOMATED_DRAFT' | 'AUTOMATED_DRAFT_AB' | 'AUTOMATED_DRAFT_ABVARIANT' | 'AUTOMATED_FOR_FORM' | 'AUTOMATED_FOR_FORM_BUFFER' | 'AUTOMATED_FOR_FORM_DRAFT' | 'AUTOMATED_FOR_FORM_LEGACY' | 'AUTOMATED_LOSER_ABVARIANT' | 'AUTOMATED_SENDING' | 'BLOG_EMAIL_DRAFT' | 'BLOG_EMAIL_PUBLISHED' | 'DRAFT' | 'DRAFT_AB' | 'DRAFT_AB_VARIANT' | 'ERROR' | 'LOSER_AB_VARIANT' | 'PAGE_STUB' | 'PRE_PROCESSING' | 'PROCESSING' | 'PUBLISHED' | 'PUBLISHED_AB' | 'PUBLISHED_AB_VARIANT' | 'PUBLISHED_OR_SCHEDULED' | 'RSS_TO_EMAIL_DRAFT' | 'RSS_TO_EMAIL_PUBLISHED' | 'SCHEDULED' | 'SCHEDULED_AB' | 'SCHEDULED_OR_PUBLISHED';
502
- stats?: Schemas.EmailStatisticsData;
503
- /**
504
- * The email subcategory.
505
- */
506
- subcategory?: string;
507
- /**
508
- * The subject of the email.
509
- */
510
- subject?: string;
511
- subscriptionDetails?: Schemas.PublicEmailSubscriptionDetails;
512
- teamsWithAccess?: string[];
513
- testing?: Schemas.PublicEmailTestingDetails;
514
- to?: Schemas.PublicEmailToDetails;
515
- /**
516
- * The email type, this is derived from other properties on the email such as subcategory.
517
- */
518
- type?: 'AB_EMAIL' | 'AUTOMATED_AB_EMAIL' | 'AUTOMATED_EMAIL' | 'BATCH_EMAIL' | 'BLOG_EMAIL' | 'BLOG_EMAIL_CHILD' | 'FEEDBACK_CES_EMAIL' | 'FEEDBACK_CUSTOM_EMAIL' | 'FEEDBACK_CUSTOM_SURVEY_EMAIL' | 'FEEDBACK_NPS_EMAIL' | 'FOLLOWUP_EMAIL' | 'LEADFLOW_EMAIL' | 'LOCALTIME_EMAIL' | 'MANAGE_PREFERENCES_EMAIL' | 'MARKETING_SINGLE_SEND_API' | 'MEMBERSHIP_EMAIL_VERIFICATION_EMAIL' | 'MEMBERSHIP_FOLLOW_UP_EMAIL' | 'MEMBERSHIP_OTP_LOGIN_EMAIL' | 'MEMBERSHIP_PASSWORD_RESET_EMAIL' | 'MEMBERSHIP_PASSWORD_SAVED_EMAIL' | 'MEMBERSHIP_PASSWORDLESS_AUTH_EMAIL' | 'MEMBERSHIP_REGISTRATION_EMAIL' | 'MEMBERSHIP_REGISTRATION_FOLLOW_UP_EMAIL' | 'MEMBERSHIP_VERIFICATION_EMAIL' | 'OPTIN_EMAIL' | 'OPTIN_FOLLOWUP_EMAIL' | 'RESUBSCRIBE_EMAIL' | 'RSS_EMAIL' | 'RSS_EMAIL_CHILD' | 'SINGLE_SEND_API' | 'SMTP_TOKEN' | 'TICKET_EMAIL';
519
- unpublishedAt?: string;
520
- /**
521
- * The date and time of the last update to the email, in ISO8601 representation.
522
- */
523
- updatedAt?: string;
524
- /**
525
- * The id of the user who last updated the email.
526
- */
527
- updatedById?: string;
528
- usersWithAccess?: string[];
529
- webversion?: Schemas.PublicWebversionDetails;
530
- /**
531
- * Names of workflows in which the email is used within a "send email" action.
532
- */
533
- workflowNames?: string[];
534
- }
535
- interface PublicEmailContent {
536
- flexAreas?: Record<string, Record<string, never>>;
537
- plainTextVersion?: string;
538
- smartFields?: Record<string, Schemas.SmartEmailField>;
539
- styleSettings?: Schemas.PublicEmailStyleSettings;
540
- templatePath?: string;
541
- themeSettingsValues?: Record<string, Record<string, never>>;
542
- widgetContainers?: Record<string, Record<string, never>>;
543
- widgets?: Record<string, Record<string, never>>;
544
- }
545
- interface PublicEmailFromDetails {
546
- /**
547
- * The reply to recipients will see.
548
- */
549
- customReplyTo?: string;
550
- /**
551
- * The name recipients will see.
552
- */
553
- fromName?: string;
554
- /**
555
- * The from address and reply to email address (if no customReplyTo defined) recipients will see.
556
- */
557
- replyTo?: string;
558
- }
559
- interface PublicEmailRecipients {
560
- /**
561
- * Excluded IDs.
562
- */
563
- exclude?: string[];
564
- /**
565
- * Included IDs.
566
- */
567
- include?: string[];
568
- }
569
- interface PublicEmailStyleSettings {
570
- backgroundColor?: string;
571
- backgroundImage?: string;
572
- backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH';
573
- bodyBorderColor?: string;
574
- bodyBorderColorChoice?: string;
575
- bodyBorderWidth?: number;
576
- bodyColor?: string;
577
- buttonStyleSettings?: Schemas.PublicButtonStyleSettings;
578
- colorPickerFavorite1?: string;
579
- colorPickerFavorite2?: string;
580
- colorPickerFavorite3?: string;
581
- colorPickerFavorite4?: string;
582
- colorPickerFavorite5?: string;
583
- colorPickerFavorite6?: string;
584
- dividerStyleSettings?: Schemas.PublicDividerStyleSettings;
585
- emailBodyPadding?: string;
586
- emailBodyWidth?: string;
587
- headingOneFont?: Schemas.PublicFontStyle;
588
- headingTwoFont?: Schemas.PublicFontStyle;
589
- linksFont?: Schemas.PublicFontStyle;
590
- primaryAccentColor?: string;
591
- primaryFont?: string;
592
- primaryFontColor?: string;
593
- primaryFontLineHeight?: string;
594
- primaryFontSize?: number;
595
- secondaryAccentColor?: string;
596
- secondaryFont?: string;
597
- secondaryFontColor?: string;
598
- secondaryFontLineHeight?: string;
599
- secondaryFontSize?: number;
600
- }
601
- interface PublicEmailSubscriptionDetails {
602
- /**
603
- * ID of the selected office location.
604
- */
605
- officeLocationId?: string;
606
- preferencesGroupId?: string;
607
- /**
608
- * ID of the subscription.
609
- */
610
- subscriptionId?: string;
611
- subscriptionName?: string;
612
- }
613
- interface PublicEmailTestingDetails {
614
- /**
615
- * Version of the email that should be sent if there are too few recipients to conduct an AB test.
616
- */
617
- abSampleSizeDefault?: 'automated_loser_variant' | 'automated_master' | 'automated_variant' | 'loser_variant' | 'mab_master' | 'mab_variant' | 'master' | 'variant';
618
- /**
619
- * Version of the email that should be sent if the results are inconclusive after the test period, master or variant.
620
- */
621
- abSamplingDefault?: 'automated_loser_variant' | 'automated_master' | 'automated_variant' | 'loser_variant' | 'mab_master' | 'mab_variant' | 'master' | 'variant';
622
- /**
623
- * Status of the AB test.
624
- */
625
- abStatus?: 'automated_loser_variant' | 'automated_master' | 'automated_variant' | 'loser_variant' | 'mab_master' | 'mab_variant' | 'master' | 'variant';
626
- /**
627
- * Metric to determine the version that will be sent to the remaining contacts.
628
- */
629
- abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED';
630
- /**
631
- * The size of your test group.
632
- */
633
- abTestPercentage?: number;
634
- /**
635
- * Time limit on gathering test results. After this time is up, the winning version will be sent to the remaining contacts.
636
- */
637
- hoursToWait?: number;
638
- isAbVariation: boolean;
639
- /**
640
- * The ID of the AB test.
641
- */
642
- testId?: string;
643
- }
644
- interface PublicEmailToDetails {
645
- contactIds?: Schemas.PublicEmailRecipients;
646
- contactIlsLists?: Schemas.PublicEmailRecipients;
647
- contactLists?: Schemas.PublicEmailRecipients;
648
- limitSendFrequency?: boolean;
649
- /**
650
- * Whether to send to unengaged contacts (false) or not (true).
651
- */
652
- suppressGraymail?: boolean;
653
- }
654
- interface PublicEmailVersion {
655
- id: string;
656
- object: Schemas.PublicEmail;
657
- updatedAt: string;
658
- user: Schemas.VersionUser;
659
- }
660
- interface PublicFontStyle {
661
- bold?: boolean;
662
- color?: string;
663
- font?: string;
664
- italic?: boolean;
665
- size?: number;
666
- underline?: boolean;
667
- }
668
- interface PublicRssEmailDetails {
669
- blogEmailType?: string;
670
- blogImageMaxWidth?: number;
671
- blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE';
672
- hubspotBlogId?: string;
673
- maxEntries?: number;
674
- rssEntryTemplate?: string;
675
- timing?: Record<string, Record<string, never>>;
676
- url?: string;
677
- useHeadlineAsSubject?: boolean;
678
- }
679
- interface PublicWebversionDetails {
680
- domain?: string;
681
- enabled?: boolean;
682
- expiresAt?: string;
683
- isPageRedirected?: boolean;
684
- metaDescription?: string;
685
- pageExpiryEnabled?: boolean;
686
- redirectToPageId?: string;
687
- redirectToUrl?: string;
688
- slug?: string;
689
- title?: string;
690
- url?: string;
691
- }
692
- interface SmartEmailField {}
693
- interface VersionPublicEmail {
694
- /**
695
- * ID of this marketing email version.
696
- */
697
- id: string;
698
- object: Schemas.PublicEmail;
699
- /**
700
- * The date and time of the last update to the email, in ISO8601 representation.
701
- */
702
- updatedAt: string;
703
- user: Schemas.VersionUser;
704
- }
705
- interface VersionUser {
706
- /**
707
- * Email address of the user.
708
- */
709
- email: string;
710
- /**
711
- * First and last name of the user.
712
- */
713
- fullName: string;
714
- /**
715
- * ID of the user.
716
- */
717
- id: string;
718
- }
4
+ declare namespace MarketingMarketingEmailsSchemas {
5
+ interface AbTestCreateRequestVNext {
6
+ /**
7
+ * ID of the object to test.
8
+ */
9
+ contentId: string;
10
+ /**
11
+ * Name of the variation to be created.
12
+ */
13
+ variationName: string;
14
+ }
15
+ interface AggregateEmailStatistics {
16
+ aggregate: EmailStatisticsData;
17
+ /**
18
+ * The aggregated statistics per campaign.
19
+ */
20
+ campaignAggregations: Record<string, EmailStatisticsData>;
21
+ /**
22
+ * List of email IDs that were sent during the time span.
23
+ */
24
+ emails: number[];
25
+ }
26
+ interface CollectionResponseWithTotalEmailStatisticInterval {
27
+ paging?: Paging;
28
+ results: EmailStatisticInterval[];
29
+ total: number;
30
+ }
31
+ interface CollectionResponseWithTotalPublicEmail {
32
+ paging?: Paging;
33
+ results: PublicEmail[];
34
+ total: number;
35
+ }
36
+ interface CollectionResponseWithTotalPublicEmailVersion {
37
+ paging?: Paging;
38
+ results: VersionPublicEmail[];
39
+ total: number;
40
+ }
41
+ interface EmailCloneRequestVNext {
42
+ /**
43
+ * The name to assign to the cloned email.
44
+ */
45
+ cloneName?: string;
46
+ /**
47
+ * The email ID.
48
+ */
49
+ id: string;
50
+ /**
51
+ * The language code for the cloned email, such as 'en' for English.
52
+ */
53
+ language?: string;
54
+ }
55
+ interface EmailCreateRequest {
56
+ /**
57
+ * The active domain of the email.
58
+ */
59
+ activeDomain?: string;
60
+ /**
61
+ * Determines if the email is archived or not.
62
+ */
63
+ archived?: boolean;
64
+ /**
65
+ * The ID of the business unit associated with the email.
66
+ */
67
+ businessUnitId?: number;
68
+ /**
69
+ * The ID of the campaign this email is associated to.
70
+ */
71
+ campaign?: string;
72
+ content?: PublicEmailContent;
73
+ /**
74
+ * The ID of the feedback survey linked to the email.
75
+ */
76
+ feedbackSurveyId?: string;
77
+ /**
78
+ * The ID of the folder where the email will be stored.
79
+ */
80
+ folderIdV2?: number;
81
+ from?: PublicEmailFromDetails;
82
+ /**
83
+ * Determines whether the email send time should be randomized to avoid sending all emails at the exact same time.
84
+ */
85
+ jitterSendTime?: boolean;
86
+ /**
87
+ * The language code for the email, such as 'en' for English.
88
+ */
89
+ language?: 'aa' | 'ab' | 'ae' | 'af' | 'af-na' | 'af-za' | 'agq' | 'agq-cm' | 'ak' | 'ak-gh' | 'am' | 'am-et' | 'an' | 'ann' | 'ann-ng' | 'ar' | 'ar-001' | 'ar-ae' | 'ar-bh' | 'ar-dj' | 'ar-dz' | 'ar-eg' | 'ar-eh' | 'ar-er' | 'ar-il' | 'ar-iq' | 'ar-jo' | 'ar-km' | 'ar-kw' | 'ar-lb' | 'ar-ly' | 'ar-ma' | 'ar-mr' | 'ar-om' | 'ar-ps' | 'ar-qa' | 'ar-sa' | 'ar-sd' | 'ar-so' | 'ar-ss' | 'ar-sy' | 'ar-td' | 'ar-tn' | 'ar-ye' | 'as' | 'as-in' | 'asa' | 'asa-tz' | 'ast' | 'ast-es' | 'av' | 'ay' | 'az' | 'az-az' | 'ba' | 'bas' | 'bas-cm' | 'be' | 'be-by' | 'bem' | 'bem-zm' | 'bez' | 'bez-tz' | 'bg' | 'bg-bg' | 'bgc' | 'bgc-in' | 'bho' | 'bho-in' | 'bi' | 'bm' | 'bm-ml' | 'bn' | 'bn-bd' | 'bn-in' | 'bo' | 'bo-cn' | 'bo-in' | 'br' | 'br-fr' | 'brx' | 'brx-in' | 'bs' | 'bs-ba' | 'ca' | 'ca-ad' | 'ca-es' | 'ca-fr' | 'ca-it' | 'ccp' | 'ccp-bd' | 'ccp-in' | 'ce' | 'ce-ru' | 'ceb' | 'ceb-ph' | 'cgg' | 'cgg-ug' | 'ch' | 'chr' | 'chr-us' | 'ckb' | 'ckb-iq' | 'ckb-ir' | 'co' | 'cr' | 'cs' | 'cs-cz' | 'cu' | 'cu-ru' | 'cv' | 'cv-ru' | 'cy' | 'cy-gb' | 'da' | 'da-dk' | 'da-gl' | 'dav' | 'dav-ke' | 'de' | 'de-at' | 'de-be' | 'de-ch' | 'de-de' | 'de-gr' | 'de-it' | 'de-li' | 'de-lu' | 'dje' | 'dje-ne' | 'doi' | 'doi-in' | 'dsb' | 'dsb-de' | 'dua' | 'dua-cm' | 'dv' | 'dyo' | 'dyo-sn' | 'dz' | 'dz-bt' | 'ebu' | 'ebu-ke' | 'ee' | 'ee-gh' | 'ee-tg' | 'el' | 'el-cy' | 'el-gr' | 'en' | 'en-001' | 'en-150' | 'en-ae' | 'en-ag' | 'en-ai' | 'en-as' | 'en-at' | 'en-au' | 'en-bb' | 'en-be' | 'en-bi' | 'en-bm' | 'en-bs' | 'en-bw' | 'en-bz' | 'en-ca' | 'en-cc' | 'en-ch' | 'en-ck' | 'en-cm' | 'en-cn' | 'en-cx' | 'en-cy' | 'en-de' | 'en-dg' | 'en-dk' | 'en-dm' | 'en-ee' | 'en-eg' | 'en-er' | 'en-es' | 'en-fi' | 'en-fj' | 'en-fk' | 'en-fm' | 'en-fr' | 'en-gb' | 'en-gd' | 'en-gg' | 'en-gh' | 'en-gi' | 'en-gm' | 'en-gu' | 'en-gy' | 'en-hk' | 'en-id' | 'en-ie' | 'en-il' | 'en-im' | 'en-in' | 'en-io' | 'en-je' | 'en-jm' | 'en-ke' | 'en-ki' | 'en-kn' | 'en-ky' | 'en-lc' | 'en-lr' | 'en-ls' | 'en-lu' | 'en-mg' | 'en-mh' | 'en-mo' | 'en-mp' | 'en-ms' | 'en-mt' | 'en-mu' | 'en-mv' | 'en-mw' | 'en-mx' | 'en-my' | 'en-na' | 'en-nf' | 'en-ng' | 'en-nl' | 'en-nr' | 'en-nu' | 'en-nz' | 'en-pg' | 'en-ph' | 'en-pk' | 'en-pn' | 'en-pr' | 'en-pt' | 'en-pw' | 'en-rw' | 'en-sb' | 'en-sc' | 'en-sd' | 'en-se' | 'en-sg' | 'en-sh' | 'en-si' | 'en-sl' | 'en-ss' | 'en-sx' | 'en-sz' | 'en-tc' | 'en-th' | 'en-tk' | 'en-tn' | 'en-to' | 'en-tt' | 'en-tv' | 'en-tz' | 'en-ug' | 'en-um' | 'en-us' | 'en-vc' | 'en-vg' | 'en-vi' | 'en-vn' | 'en-vu' | 'en-ws' | 'en-za' | 'en-zm' | 'en-zw' | 'eo' | 'eo-001' | 'es' | 'es-419' | 'es-ar' | 'es-bo' | 'es-br' | 'es-bz' | 'es-cl' | 'es-co' | 'es-cr' | 'es-cu' | 'es-do' | 'es-ea' | 'es-ec' | 'es-es' | 'es-gq' | 'es-gt' | 'es-hn' | 'es-ic' | 'es-mx' | 'es-ni' | 'es-pa' | 'es-pe' | 'es-ph' | 'es-pr' | 'es-py' | 'es-sv' | 'es-us' | 'es-uy' | 'es-ve' | 'et' | 'et-ee' | 'eu' | 'eu-es' | 'ewo' | 'ewo-cm' | 'fa' | 'fa-af' | 'fa-ir' | 'ff' | 'ff-bf' | 'ff-cm' | 'ff-gh' | 'ff-gm' | 'ff-gn' | 'ff-gw' | 'ff-lr' | 'ff-mr' | 'ff-ne' | 'ff-ng' | 'ff-sl' | 'ff-sn' | 'fi' | 'fi-fi' | 'fil' | 'fil-ph' | 'fj' | 'fo' | 'fo-dk' | 'fo-fo' | 'fr' | 'fr-be' | 'fr-bf' | 'fr-bi' | 'fr-bj' | 'fr-bl' | 'fr-ca' | 'fr-cd' | 'fr-cf' | 'fr-cg' | 'fr-ch' | 'fr-ci' | 'fr-cm' | 'fr-dj' | 'fr-dz' | 'fr-fr' | 'fr-ga' | 'fr-gf' | 'fr-gn' | 'fr-gp' | 'fr-gq' | 'fr-ht' | 'fr-km' | 'fr-lu' | 'fr-ma' | 'fr-mc' | 'fr-mf' | 'fr-mg' | 'fr-ml' | 'fr-mq' | 'fr-mr' | 'fr-mu' | 'fr-nc' | 'fr-ne' | 'fr-pf' | 'fr-pm' | 'fr-re' | 'fr-rw' | 'fr-sc' | 'fr-sn' | 'fr-sy' | 'fr-td' | 'fr-tg' | 'fr-tn' | 'fr-vu' | 'fr-wf' | 'fr-yt' | 'frr' | 'frr-de' | 'fur' | 'fur-it' | 'fy' | 'fy-nl' | 'ga' | 'ga-gb' | 'ga-ie' | 'gd' | 'gd-gb' | 'gl' | 'gl-es' | 'gn' | 'gsw' | 'gsw-ch' | 'gsw-fr' | 'gsw-li' | 'gu' | 'gu-in' | 'guz' | 'guz-ke' | 'gv' | 'gv-im' | 'ha' | 'ha-gh' | 'ha-ne' | 'ha-ng' | 'haw' | 'haw-us' | 'he' | 'he-il' | 'hi' | 'hi-in' | 'hmn' | 'ho' | 'hr' | 'hr-ba' | 'hr-hr' | 'hsb' | 'hsb-de' | 'ht' | 'hu' | 'hu-hu' | 'hy' | 'hy-am' | 'hz' | 'ia' | 'ia-001' | 'id' | 'id-id' | 'ie' | 'ig' | 'ig-ng' | 'ii' | 'ii-cn' | 'ik' | 'io' | 'is' | 'is-is' | 'it' | 'it-ch' | 'it-it' | 'it-sm' | 'it-va' | 'iu' | 'ja' | 'ja-jp' | 'jgo' | 'jgo-cm' | 'jmc' | 'jmc-tz' | 'jv' | 'jv-id' | 'ka' | 'ka-ge' | 'kab' | 'kab-dz' | 'kam' | 'kam-ke' | 'kar' | 'kde' | 'kde-tz' | 'kea' | 'kea-cv' | 'kg' | 'kgp' | 'kgp-br' | 'kh' | 'khq' | 'khq-ml' | 'ki' | 'ki-ke' | 'kj' | 'kk' | 'kk-kz' | 'kkj' | 'kkj-cm' | 'kl' | 'kl-gl' | 'kln' | 'kln-ke' | 'km' | 'km-kh' | 'kn' | 'kn-in' | 'ko' | 'ko-kp' | 'ko-kr' | 'kok' | 'kok-in' | 'kr' | 'ks' | 'ks-in' | 'ksb' | 'ksb-tz' | 'ksf' | 'ksf-cm' | 'ksh' | 'ksh-de' | 'ku' | 'ku-tr' | 'kv' | 'kw' | 'kw-gb' | 'ky' | 'ky-kg' | 'la' | 'lag' | 'lag-tz' | 'lb' | 'lb-lu' | 'lg' | 'lg-ug' | 'li' | 'lkt' | 'lkt-us' | 'ln' | 'ln-ao' | 'ln-cd' | 'ln-cf' | 'ln-cg' | 'lo' | 'lo-la' | 'lrc' | 'lrc-iq' | 'lrc-ir' | 'lt' | 'lt-lt' | 'lu' | 'lu-cd' | 'luo' | 'luo-ke' | 'luy' | 'luy-ke' | 'lv' | 'lv-lv' | 'mai' | 'mai-in' | 'mas' | 'mas-ke' | 'mas-tz' | 'mdf' | 'mdf-ru' | 'mer' | 'mer-ke' | 'mfe' | 'mfe-mu' | 'mg' | 'mg-mg' | 'mgh' | 'mgh-mz' | 'mgo' | 'mgo-cm' | 'mh' | 'mi' | 'mi-nz' | 'mk' | 'mk-mk' | 'ml' | 'ml-in' | 'mn' | 'mn-mn' | 'mni' | 'mni-in' | 'mr' | 'mr-in' | 'ms' | 'ms-bn' | 'ms-id' | 'ms-my' | 'ms-sg' | 'mt' | 'mt-mt' | 'mua' | 'mua-cm' | 'my' | 'my-mm' | 'mzn' | 'mzn-ir' | 'na' | 'naq' | 'naq-na' | 'nb' | 'nb-no' | 'nb-sj' | 'nd' | 'nd-zw' | 'nds' | 'nds-de' | 'nds-nl' | 'ne' | 'ne-in' | 'ne-np' | 'ng' | 'nl' | 'nl-aw' | 'nl-be' | 'nl-bq' | 'nl-ch' | 'nl-cw' | 'nl-lu' | 'nl-nl' | 'nl-sr' | 'nl-sx' | 'nmg' | 'nmg-cm' | 'nn' | 'nn-no' | 'nnh' | 'nnh-cm' | 'no' | 'no-no' | 'nr' | 'nus' | 'nus-ss' | 'nv' | 'ny' | 'nyn' | 'nyn-ug' | 'oc' | 'oc-es' | 'oc-fr' | 'oj' | 'om' | 'om-et' | 'om-ke' | 'or' | 'or-in' | 'os' | 'os-ge' | 'os-ru' | 'pa' | 'pa-in' | 'pa-pk' | 'pcm' | 'pcm-ng' | 'pi' | 'pis' | 'pis-sb' | 'pl' | 'pl-pl' | 'prg' | 'prg-001' | 'ps' | 'ps-af' | 'ps-pk' | 'pt' | 'pt-ao' | 'pt-br' | 'pt-ch' | 'pt-cv' | 'pt-gq' | 'pt-gw' | 'pt-lu' | 'pt-mo' | 'pt-mz' | 'pt-pt' | 'pt-st' | 'pt-tl' | 'qu' | 'qu-bo' | 'qu-ec' | 'qu-pe' | 'raj' | 'raj-in' | 'rm' | 'rm-ch' | 'rn' | 'rn-bi' | 'ro' | 'ro-md' | 'ro-ro' | 'rof' | 'rof-tz' | 'ru' | 'ru-by' | 'ru-kg' | 'ru-kz' | 'ru-md' | 'ru-ru' | 'ru-ua' | 'rw' | 'rw-rw' | 'rwk' | 'rwk-tz' | 'sa' | 'sa-in' | 'sah' | 'sah-ru' | 'saq' | 'saq-ke' | 'sat' | 'sat-in' | 'sbp' | 'sbp-tz' | 'sc' | 'sc-it' | 'sd' | 'sd-in' | 'sd-pk' | 'se' | 'se-fi' | 'se-no' | 'se-se' | 'seh' | 'seh-mz' | 'ses' | 'ses-ml' | 'sg' | 'sg-cf' | 'shi' | 'shi-ma' | 'si' | 'si-lk' | 'sk' | 'sk-sk' | 'sl' | 'sl-si' | 'sm' | 'smn' | 'smn-fi' | 'sms' | 'sms-fi' | 'sn' | 'sn-zw' | 'so' | 'so-dj' | 'so-et' | 'so-ke' | 'so-so' | 'sq' | 'sq-al' | 'sq-mk' | 'sq-xk' | 'sr' | 'sr-ba' | 'sr-cs' | 'sr-me' | 'sr-rs' | 'sr-xk' | 'ss' | 'st' | 'su' | 'su-id' | 'sv' | 'sv-ax' | 'sv-fi' | 'sv-se' | 'sw' | 'sw-cd' | 'sw-ke' | 'sw-tz' | 'sw-ug' | 'sy' | 'ta' | 'ta-in' | 'ta-lk' | 'ta-my' | 'ta-sg' | 'te' | 'te-in' | 'teo' | 'teo-ke' | 'teo-ug' | 'tg' | 'tg-tj' | 'th' | 'th-th' | 'ti' | 'ti-er' | 'ti-et' | 'tk' | 'tk-tm' | 'tl' | 'tn' | 'to' | 'to-to' | 'tok' | 'tok-001' | 'tr' | 'tr-cy' | 'tr-tr' | 'ts' | 'tt' | 'tt-ru' | 'tw' | 'twq' | 'twq-ne' | 'ty' | 'tzm' | 'tzm-ma' | 'ug' | 'ug-cn' | 'uk' | 'uk-ua' | 'ur' | 'ur-in' | 'ur-pk' | 'uz' | 'uz-af' | 'uz-uz' | 'vai' | 'vai-lr' | 've' | 'vi' | 'vi-vn' | 'vo' | 'vo-001' | 'vun' | 'vun-tz' | 'wa' | 'wae' | 'wae-ch' | 'wo' | 'wo-sn' | 'xh' | 'xh-za' | 'xog' | 'xog-ug' | 'yav' | 'yav-cm' | 'yi' | 'yi-001' | 'yo' | 'yo-bj' | 'yo-ng' | 'yrl' | 'yrl-br' | 'yrl-co' | 'yrl-ve' | 'yue' | 'yue-cn' | 'yue-hk' | 'za' | 'zgh' | 'zgh-ma' | 'zh' | 'zh-cn' | 'zh-hans' | 'zh-hant' | 'zh-hk' | 'zh-mo' | 'zh-sg' | 'zh-tw' | 'zu' | 'zu-za';
90
+ /**
91
+ * The name of the email, as displayed on the email dashboard.
92
+ */
93
+ name?: string;
94
+ /**
95
+ * The date and time the email is scheduled for, in ISO8601 representation. This is only used in local time or scheduled emails.
96
+ */
97
+ publishDate?: string;
98
+ rssData?: PublicRssEmailDetails;
99
+ /**
100
+ * Determines whether the email will be sent immediately on publish.
101
+ */
102
+ sendOnPublish?: boolean;
103
+ /**
104
+ * The email state.
105
+ */
106
+ state?: 'AGENT_GENERATED' | 'AUTOMATED' | 'AUTOMATED_AB' | 'AUTOMATED_AB_VARIANT' | 'AUTOMATED_DRAFT' | 'AUTOMATED_DRAFT_AB' | 'AUTOMATED_DRAFT_ABVARIANT' | 'AUTOMATED_FOR_FORM' | 'AUTOMATED_FOR_FORM_BUFFER' | 'AUTOMATED_FOR_FORM_DRAFT' | 'AUTOMATED_FOR_FORM_LEGACY' | 'AUTOMATED_LOSER_ABVARIANT' | 'AUTOMATED_SENDING' | 'BLOG_EMAIL_DRAFT' | 'BLOG_EMAIL_PUBLISHED' | 'DRAFT' | 'DRAFT_AB' | 'DRAFT_AB_VARIANT' | 'ERROR' | 'LOSER_AB_VARIANT' | 'PAGE_STUB' | 'PRE_PROCESSING' | 'PROCESSING' | 'PUBLISHED' | 'PUBLISHED_AB' | 'PUBLISHED_AB_VARIANT' | 'PUBLISHED_OR_SCHEDULED' | 'RSS_TO_EMAIL_DRAFT' | 'RSS_TO_EMAIL_PUBLISHED' | 'SCHEDULED' | 'SCHEDULED_AB' | 'SCHEDULED_OR_PUBLISHED';
107
+ /**
108
+ * The email subcategory.
109
+ */
110
+ subcategory?: 'ab_loser_variant' | 'ab_loser_variant_site_page' | 'ab_master' | 'ab_master_site_page' | 'ab_variant' | 'ab_variant_site_page' | 'automated' | 'automated_ab_master' | 'automated_ab_variant' | 'automated_for_crm' | 'automated_for_custom_survey' | 'automated_for_deal' | 'automated_for_feedback_ces' | 'automated_for_feedback_custom' | 'automated_for_feedback_nps' | 'automated_for_form' | 'automated_for_form_buffer' | 'automated_for_form_draft' | 'automated_for_form_legacy' | 'automated_for_leadflow' | 'automated_for_ticket' | 'batch' | 'blog_article_instance_layout' | 'blog_article_listing' | 'blog_author_detail' | 'blog_email' | 'blog_email_child' | 'case_study' | 'case_study_instance_layout' | 'case_study_listing' | 'discardable_stub' | 'imported_blog_post' | 'kb_404_page' | 'kb_article_instance_layout' | 'kb_listing' | 'kb_search_results' | 'kb_support_form' | 'landing_page' | 'legacy_blog_post' | 'legacy_page' | 'localtime' | 'manage_preferences_email' | 'marketing_single_send_api' | 'membership_email_verification' | 'membership_follow_up' | 'membership_otp_login' | 'membership_password_reset' | 'membership_password_saved' | 'membership_passwordless_auth' | 'membership_registration' | 'membership_registration_follow_up' | 'membership_verification' | 'normal_blog_post' | 'optin_email' | 'optin_followup_email' | 'page_instance_layout' | 'page_stub' | 'performable_landing_page' | 'performable_landing_page_cutover' | 'podcast_instance_layout' | 'podcast_listing' | 'portal_content' | 'resubscribe_confirmation_email' | 'resubscribe_email' | 'rss_to_email' | 'rss_to_email_child' | 'scp_instance_layout_page' | 'scp_static_page' | 'single_send_api' | 'site_page' | 'smtp_token' | 'staged_page' | 'ticket_closed_kickback_email' | 'ticket_opened_kickback_email' | 'ticket_pipeline_automated' | 'UNKNOWN' | 'unsubscribe_confirmation_email' | 'web_interactive';
111
+ /**
112
+ * The subject of the email.
113
+ */
114
+ subject?: string;
115
+ subscriptionDetails?: PublicEmailSubscriptionDetails;
116
+ testing?: PublicEmailTestingDetails;
117
+ to?: PublicEmailToDetails;
118
+ webversion?: PublicWebversionDetails;
119
+ }
120
+ interface EmailStatisticInterval {
121
+ aggregations: EmailStatisticsData;
122
+ interval: Interval;
123
+ }
124
+ interface EmailStatisticsData {
125
+ /**
126
+ * Counters like number of `sent`, `open` or `delivered`.
127
+ */
128
+ counters: Record<string, number>;
129
+ /**
130
+ * Statistics by device.
131
+ */
132
+ deviceBreakdown: Record<string, Record<string, number>>;
133
+ /**
134
+ * Number of emails that were dropped and bounced.
135
+ */
136
+ qualifierStats: Record<string, Record<string, number>>;
137
+ /**
138
+ * Ratios like `openratio` or `clickratio`
139
+ */
140
+ ratios: Record<string, number>;
141
+ }
142
+ interface EmailUpdateRequest {
143
+ /**
144
+ * The active domain of the email.
145
+ */
146
+ activeDomain?: string;
147
+ /**
148
+ * Determines if the email is archived or not.
149
+ */
150
+ archived?: boolean;
151
+ /**
152
+ * The ID of the business unit associated with the email.
153
+ */
154
+ businessUnitId?: number;
155
+ /**
156
+ * The ID of the campaign this email is associated to.
157
+ */
158
+ campaign?: string;
159
+ content?: PublicEmailContent;
160
+ /**
161
+ * The ID of the folder where the email will be stored.
162
+ */
163
+ folderIdV2?: number;
164
+ from?: PublicEmailFromDetails;
165
+ /**
166
+ * Determines whether the email send time should be randomized to avoid sending all emails at the exact same time.
167
+ */
168
+ jitterSendTime?: boolean;
169
+ /**
170
+ * The language code for the email, such as 'en' for English.
171
+ */
172
+ language?: 'aa' | 'ab' | 'ae' | 'af' | 'af-na' | 'af-za' | 'agq' | 'agq-cm' | 'ak' | 'ak-gh' | 'am' | 'am-et' | 'an' | 'ann' | 'ann-ng' | 'ar' | 'ar-001' | 'ar-ae' | 'ar-bh' | 'ar-dj' | 'ar-dz' | 'ar-eg' | 'ar-eh' | 'ar-er' | 'ar-il' | 'ar-iq' | 'ar-jo' | 'ar-km' | 'ar-kw' | 'ar-lb' | 'ar-ly' | 'ar-ma' | 'ar-mr' | 'ar-om' | 'ar-ps' | 'ar-qa' | 'ar-sa' | 'ar-sd' | 'ar-so' | 'ar-ss' | 'ar-sy' | 'ar-td' | 'ar-tn' | 'ar-ye' | 'as' | 'as-in' | 'asa' | 'asa-tz' | 'ast' | 'ast-es' | 'av' | 'ay' | 'az' | 'az-az' | 'ba' | 'bas' | 'bas-cm' | 'be' | 'be-by' | 'bem' | 'bem-zm' | 'bez' | 'bez-tz' | 'bg' | 'bg-bg' | 'bgc' | 'bgc-in' | 'bho' | 'bho-in' | 'bi' | 'bm' | 'bm-ml' | 'bn' | 'bn-bd' | 'bn-in' | 'bo' | 'bo-cn' | 'bo-in' | 'br' | 'br-fr' | 'brx' | 'brx-in' | 'bs' | 'bs-ba' | 'ca' | 'ca-ad' | 'ca-es' | 'ca-fr' | 'ca-it' | 'ccp' | 'ccp-bd' | 'ccp-in' | 'ce' | 'ce-ru' | 'ceb' | 'ceb-ph' | 'cgg' | 'cgg-ug' | 'ch' | 'chr' | 'chr-us' | 'ckb' | 'ckb-iq' | 'ckb-ir' | 'co' | 'cr' | 'cs' | 'cs-cz' | 'cu' | 'cu-ru' | 'cv' | 'cv-ru' | 'cy' | 'cy-gb' | 'da' | 'da-dk' | 'da-gl' | 'dav' | 'dav-ke' | 'de' | 'de-at' | 'de-be' | 'de-ch' | 'de-de' | 'de-gr' | 'de-it' | 'de-li' | 'de-lu' | 'dje' | 'dje-ne' | 'doi' | 'doi-in' | 'dsb' | 'dsb-de' | 'dua' | 'dua-cm' | 'dv' | 'dyo' | 'dyo-sn' | 'dz' | 'dz-bt' | 'ebu' | 'ebu-ke' | 'ee' | 'ee-gh' | 'ee-tg' | 'el' | 'el-cy' | 'el-gr' | 'en' | 'en-001' | 'en-150' | 'en-ae' | 'en-ag' | 'en-ai' | 'en-as' | 'en-at' | 'en-au' | 'en-bb' | 'en-be' | 'en-bi' | 'en-bm' | 'en-bs' | 'en-bw' | 'en-bz' | 'en-ca' | 'en-cc' | 'en-ch' | 'en-ck' | 'en-cm' | 'en-cn' | 'en-cx' | 'en-cy' | 'en-de' | 'en-dg' | 'en-dk' | 'en-dm' | 'en-ee' | 'en-eg' | 'en-er' | 'en-es' | 'en-fi' | 'en-fj' | 'en-fk' | 'en-fm' | 'en-fr' | 'en-gb' | 'en-gd' | 'en-gg' | 'en-gh' | 'en-gi' | 'en-gm' | 'en-gu' | 'en-gy' | 'en-hk' | 'en-id' | 'en-ie' | 'en-il' | 'en-im' | 'en-in' | 'en-io' | 'en-je' | 'en-jm' | 'en-ke' | 'en-ki' | 'en-kn' | 'en-ky' | 'en-lc' | 'en-lr' | 'en-ls' | 'en-lu' | 'en-mg' | 'en-mh' | 'en-mo' | 'en-mp' | 'en-ms' | 'en-mt' | 'en-mu' | 'en-mv' | 'en-mw' | 'en-mx' | 'en-my' | 'en-na' | 'en-nf' | 'en-ng' | 'en-nl' | 'en-nr' | 'en-nu' | 'en-nz' | 'en-pg' | 'en-ph' | 'en-pk' | 'en-pn' | 'en-pr' | 'en-pt' | 'en-pw' | 'en-rw' | 'en-sb' | 'en-sc' | 'en-sd' | 'en-se' | 'en-sg' | 'en-sh' | 'en-si' | 'en-sl' | 'en-ss' | 'en-sx' | 'en-sz' | 'en-tc' | 'en-th' | 'en-tk' | 'en-tn' | 'en-to' | 'en-tt' | 'en-tv' | 'en-tz' | 'en-ug' | 'en-um' | 'en-us' | 'en-vc' | 'en-vg' | 'en-vi' | 'en-vn' | 'en-vu' | 'en-ws' | 'en-za' | 'en-zm' | 'en-zw' | 'eo' | 'eo-001' | 'es' | 'es-419' | 'es-ar' | 'es-bo' | 'es-br' | 'es-bz' | 'es-cl' | 'es-co' | 'es-cr' | 'es-cu' | 'es-do' | 'es-ea' | 'es-ec' | 'es-es' | 'es-gq' | 'es-gt' | 'es-hn' | 'es-ic' | 'es-mx' | 'es-ni' | 'es-pa' | 'es-pe' | 'es-ph' | 'es-pr' | 'es-py' | 'es-sv' | 'es-us' | 'es-uy' | 'es-ve' | 'et' | 'et-ee' | 'eu' | 'eu-es' | 'ewo' | 'ewo-cm' | 'fa' | 'fa-af' | 'fa-ir' | 'ff' | 'ff-bf' | 'ff-cm' | 'ff-gh' | 'ff-gm' | 'ff-gn' | 'ff-gw' | 'ff-lr' | 'ff-mr' | 'ff-ne' | 'ff-ng' | 'ff-sl' | 'ff-sn' | 'fi' | 'fi-fi' | 'fil' | 'fil-ph' | 'fj' | 'fo' | 'fo-dk' | 'fo-fo' | 'fr' | 'fr-be' | 'fr-bf' | 'fr-bi' | 'fr-bj' | 'fr-bl' | 'fr-ca' | 'fr-cd' | 'fr-cf' | 'fr-cg' | 'fr-ch' | 'fr-ci' | 'fr-cm' | 'fr-dj' | 'fr-dz' | 'fr-fr' | 'fr-ga' | 'fr-gf' | 'fr-gn' | 'fr-gp' | 'fr-gq' | 'fr-ht' | 'fr-km' | 'fr-lu' | 'fr-ma' | 'fr-mc' | 'fr-mf' | 'fr-mg' | 'fr-ml' | 'fr-mq' | 'fr-mr' | 'fr-mu' | 'fr-nc' | 'fr-ne' | 'fr-pf' | 'fr-pm' | 'fr-re' | 'fr-rw' | 'fr-sc' | 'fr-sn' | 'fr-sy' | 'fr-td' | 'fr-tg' | 'fr-tn' | 'fr-vu' | 'fr-wf' | 'fr-yt' | 'frr' | 'frr-de' | 'fur' | 'fur-it' | 'fy' | 'fy-nl' | 'ga' | 'ga-gb' | 'ga-ie' | 'gd' | 'gd-gb' | 'gl' | 'gl-es' | 'gn' | 'gsw' | 'gsw-ch' | 'gsw-fr' | 'gsw-li' | 'gu' | 'gu-in' | 'guz' | 'guz-ke' | 'gv' | 'gv-im' | 'ha' | 'ha-gh' | 'ha-ne' | 'ha-ng' | 'haw' | 'haw-us' | 'he' | 'he-il' | 'hi' | 'hi-in' | 'hmn' | 'ho' | 'hr' | 'hr-ba' | 'hr-hr' | 'hsb' | 'hsb-de' | 'ht' | 'hu' | 'hu-hu' | 'hy' | 'hy-am' | 'hz' | 'ia' | 'ia-001' | 'id' | 'id-id' | 'ie' | 'ig' | 'ig-ng' | 'ii' | 'ii-cn' | 'ik' | 'io' | 'is' | 'is-is' | 'it' | 'it-ch' | 'it-it' | 'it-sm' | 'it-va' | 'iu' | 'ja' | 'ja-jp' | 'jgo' | 'jgo-cm' | 'jmc' | 'jmc-tz' | 'jv' | 'jv-id' | 'ka' | 'ka-ge' | 'kab' | 'kab-dz' | 'kam' | 'kam-ke' | 'kar' | 'kde' | 'kde-tz' | 'kea' | 'kea-cv' | 'kg' | 'kgp' | 'kgp-br' | 'kh' | 'khq' | 'khq-ml' | 'ki' | 'ki-ke' | 'kj' | 'kk' | 'kk-kz' | 'kkj' | 'kkj-cm' | 'kl' | 'kl-gl' | 'kln' | 'kln-ke' | 'km' | 'km-kh' | 'kn' | 'kn-in' | 'ko' | 'ko-kp' | 'ko-kr' | 'kok' | 'kok-in' | 'kr' | 'ks' | 'ks-in' | 'ksb' | 'ksb-tz' | 'ksf' | 'ksf-cm' | 'ksh' | 'ksh-de' | 'ku' | 'ku-tr' | 'kv' | 'kw' | 'kw-gb' | 'ky' | 'ky-kg' | 'la' | 'lag' | 'lag-tz' | 'lb' | 'lb-lu' | 'lg' | 'lg-ug' | 'li' | 'lkt' | 'lkt-us' | 'ln' | 'ln-ao' | 'ln-cd' | 'ln-cf' | 'ln-cg' | 'lo' | 'lo-la' | 'lrc' | 'lrc-iq' | 'lrc-ir' | 'lt' | 'lt-lt' | 'lu' | 'lu-cd' | 'luo' | 'luo-ke' | 'luy' | 'luy-ke' | 'lv' | 'lv-lv' | 'mai' | 'mai-in' | 'mas' | 'mas-ke' | 'mas-tz' | 'mdf' | 'mdf-ru' | 'mer' | 'mer-ke' | 'mfe' | 'mfe-mu' | 'mg' | 'mg-mg' | 'mgh' | 'mgh-mz' | 'mgo' | 'mgo-cm' | 'mh' | 'mi' | 'mi-nz' | 'mk' | 'mk-mk' | 'ml' | 'ml-in' | 'mn' | 'mn-mn' | 'mni' | 'mni-in' | 'mr' | 'mr-in' | 'ms' | 'ms-bn' | 'ms-id' | 'ms-my' | 'ms-sg' | 'mt' | 'mt-mt' | 'mua' | 'mua-cm' | 'my' | 'my-mm' | 'mzn' | 'mzn-ir' | 'na' | 'naq' | 'naq-na' | 'nb' | 'nb-no' | 'nb-sj' | 'nd' | 'nd-zw' | 'nds' | 'nds-de' | 'nds-nl' | 'ne' | 'ne-in' | 'ne-np' | 'ng' | 'nl' | 'nl-aw' | 'nl-be' | 'nl-bq' | 'nl-ch' | 'nl-cw' | 'nl-lu' | 'nl-nl' | 'nl-sr' | 'nl-sx' | 'nmg' | 'nmg-cm' | 'nn' | 'nn-no' | 'nnh' | 'nnh-cm' | 'no' | 'no-no' | 'nr' | 'nus' | 'nus-ss' | 'nv' | 'ny' | 'nyn' | 'nyn-ug' | 'oc' | 'oc-es' | 'oc-fr' | 'oj' | 'om' | 'om-et' | 'om-ke' | 'or' | 'or-in' | 'os' | 'os-ge' | 'os-ru' | 'pa' | 'pa-in' | 'pa-pk' | 'pcm' | 'pcm-ng' | 'pi' | 'pis' | 'pis-sb' | 'pl' | 'pl-pl' | 'prg' | 'prg-001' | 'ps' | 'ps-af' | 'ps-pk' | 'pt' | 'pt-ao' | 'pt-br' | 'pt-ch' | 'pt-cv' | 'pt-gq' | 'pt-gw' | 'pt-lu' | 'pt-mo' | 'pt-mz' | 'pt-pt' | 'pt-st' | 'pt-tl' | 'qu' | 'qu-bo' | 'qu-ec' | 'qu-pe' | 'raj' | 'raj-in' | 'rm' | 'rm-ch' | 'rn' | 'rn-bi' | 'ro' | 'ro-md' | 'ro-ro' | 'rof' | 'rof-tz' | 'ru' | 'ru-by' | 'ru-kg' | 'ru-kz' | 'ru-md' | 'ru-ru' | 'ru-ua' | 'rw' | 'rw-rw' | 'rwk' | 'rwk-tz' | 'sa' | 'sa-in' | 'sah' | 'sah-ru' | 'saq' | 'saq-ke' | 'sat' | 'sat-in' | 'sbp' | 'sbp-tz' | 'sc' | 'sc-it' | 'sd' | 'sd-in' | 'sd-pk' | 'se' | 'se-fi' | 'se-no' | 'se-se' | 'seh' | 'seh-mz' | 'ses' | 'ses-ml' | 'sg' | 'sg-cf' | 'shi' | 'shi-ma' | 'si' | 'si-lk' | 'sk' | 'sk-sk' | 'sl' | 'sl-si' | 'sm' | 'smn' | 'smn-fi' | 'sms' | 'sms-fi' | 'sn' | 'sn-zw' | 'so' | 'so-dj' | 'so-et' | 'so-ke' | 'so-so' | 'sq' | 'sq-al' | 'sq-mk' | 'sq-xk' | 'sr' | 'sr-ba' | 'sr-cs' | 'sr-me' | 'sr-rs' | 'sr-xk' | 'ss' | 'st' | 'su' | 'su-id' | 'sv' | 'sv-ax' | 'sv-fi' | 'sv-se' | 'sw' | 'sw-cd' | 'sw-ke' | 'sw-tz' | 'sw-ug' | 'sy' | 'ta' | 'ta-in' | 'ta-lk' | 'ta-my' | 'ta-sg' | 'te' | 'te-in' | 'teo' | 'teo-ke' | 'teo-ug' | 'tg' | 'tg-tj' | 'th' | 'th-th' | 'ti' | 'ti-er' | 'ti-et' | 'tk' | 'tk-tm' | 'tl' | 'tn' | 'to' | 'to-to' | 'tok' | 'tok-001' | 'tr' | 'tr-cy' | 'tr-tr' | 'ts' | 'tt' | 'tt-ru' | 'tw' | 'twq' | 'twq-ne' | 'ty' | 'tzm' | 'tzm-ma' | 'ug' | 'ug-cn' | 'uk' | 'uk-ua' | 'ur' | 'ur-in' | 'ur-pk' | 'uz' | 'uz-af' | 'uz-uz' | 'vai' | 'vai-lr' | 've' | 'vi' | 'vi-vn' | 'vo' | 'vo-001' | 'vun' | 'vun-tz' | 'wa' | 'wae' | 'wae-ch' | 'wo' | 'wo-sn' | 'xh' | 'xh-za' | 'xog' | 'xog-ug' | 'yav' | 'yav-cm' | 'yi' | 'yi-001' | 'yo' | 'yo-bj' | 'yo-ng' | 'yrl' | 'yrl-br' | 'yrl-co' | 'yrl-ve' | 'yue' | 'yue-cn' | 'yue-hk' | 'za' | 'zgh' | 'zgh-ma' | 'zh' | 'zh-cn' | 'zh-hans' | 'zh-hant' | 'zh-hk' | 'zh-mo' | 'zh-sg' | 'zh-tw' | 'zu' | 'zu-za';
173
+ /**
174
+ * The name of the email, as displayed on the email dashboard.
175
+ */
176
+ name?: string;
177
+ /**
178
+ * The date and time the email is scheduled for, in ISO8601 representation. This is only used in local time or scheduled emails.
179
+ */
180
+ publishDate?: string;
181
+ rssData?: PublicRssEmailDetails;
182
+ /**
183
+ * Determines whether the email will be sent immediately on publish.
184
+ */
185
+ sendOnPublish?: boolean;
186
+ /**
187
+ * The email state.
188
+ */
189
+ state?: 'AGENT_GENERATED' | 'AUTOMATED' | 'AUTOMATED_AB' | 'AUTOMATED_AB_VARIANT' | 'AUTOMATED_DRAFT' | 'AUTOMATED_DRAFT_AB' | 'AUTOMATED_DRAFT_ABVARIANT' | 'AUTOMATED_FOR_FORM' | 'AUTOMATED_FOR_FORM_BUFFER' | 'AUTOMATED_FOR_FORM_DRAFT' | 'AUTOMATED_FOR_FORM_LEGACY' | 'AUTOMATED_LOSER_ABVARIANT' | 'AUTOMATED_SENDING' | 'BLOG_EMAIL_DRAFT' | 'BLOG_EMAIL_PUBLISHED' | 'DRAFT' | 'DRAFT_AB' | 'DRAFT_AB_VARIANT' | 'ERROR' | 'LOSER_AB_VARIANT' | 'PAGE_STUB' | 'PRE_PROCESSING' | 'PROCESSING' | 'PUBLISHED' | 'PUBLISHED_AB' | 'PUBLISHED_AB_VARIANT' | 'PUBLISHED_OR_SCHEDULED' | 'RSS_TO_EMAIL_DRAFT' | 'RSS_TO_EMAIL_PUBLISHED' | 'SCHEDULED' | 'SCHEDULED_AB' | 'SCHEDULED_OR_PUBLISHED';
190
+ /**
191
+ * The email subcategory.
192
+ */
193
+ subcategory?: 'ab_loser_variant' | 'ab_loser_variant_site_page' | 'ab_master' | 'ab_master_site_page' | 'ab_variant' | 'ab_variant_site_page' | 'automated' | 'automated_ab_master' | 'automated_ab_variant' | 'automated_for_crm' | 'automated_for_custom_survey' | 'automated_for_deal' | 'automated_for_feedback_ces' | 'automated_for_feedback_custom' | 'automated_for_feedback_nps' | 'automated_for_form' | 'automated_for_form_buffer' | 'automated_for_form_draft' | 'automated_for_form_legacy' | 'automated_for_leadflow' | 'automated_for_ticket' | 'batch' | 'blog_article_instance_layout' | 'blog_article_listing' | 'blog_author_detail' | 'blog_email' | 'blog_email_child' | 'case_study' | 'case_study_instance_layout' | 'case_study_listing' | 'discardable_stub' | 'imported_blog_post' | 'kb_404_page' | 'kb_article_instance_layout' | 'kb_listing' | 'kb_search_results' | 'kb_support_form' | 'landing_page' | 'legacy_blog_post' | 'legacy_page' | 'localtime' | 'manage_preferences_email' | 'marketing_single_send_api' | 'membership_email_verification' | 'membership_follow_up' | 'membership_otp_login' | 'membership_password_reset' | 'membership_password_saved' | 'membership_passwordless_auth' | 'membership_registration' | 'membership_registration_follow_up' | 'membership_verification' | 'normal_blog_post' | 'optin_email' | 'optin_followup_email' | 'page_instance_layout' | 'page_stub' | 'performable_landing_page' | 'performable_landing_page_cutover' | 'podcast_instance_layout' | 'podcast_listing' | 'portal_content' | 'resubscribe_confirmation_email' | 'resubscribe_email' | 'rss_to_email' | 'rss_to_email_child' | 'scp_instance_layout_page' | 'scp_static_page' | 'single_send_api' | 'site_page' | 'smtp_token' | 'staged_page' | 'ticket_closed_kickback_email' | 'ticket_opened_kickback_email' | 'ticket_pipeline_automated' | 'UNKNOWN' | 'unsubscribe_confirmation_email' | 'web_interactive';
194
+ /**
195
+ * The subject of the email.
196
+ */
197
+ subject?: string;
198
+ subscriptionDetails?: PublicEmailSubscriptionDetails;
199
+ testing?: PublicEmailTestingDetails;
200
+ to?: PublicEmailToDetails;
201
+ webversion?: PublicWebversionDetails;
202
+ }
203
+ interface Interval {
204
+ /**
205
+ * The end timestamp of the interval, in ISO8601 format.
206
+ */
207
+ end: string;
208
+ /**
209
+ * The start timestamp of the interval, in ISO8601 format.
210
+ */
211
+ start: string;
719
212
  }
720
213
  /**
721
- * Usage example:
722
- * ```ts
723
- * import { marketingMarketingEmails } from '@hubspot/api-client-core';
724
- * client.send(marketingMarketingEmails.basic.create(input));
725
- * ```
214
+ * Specifies the paging information needed to retrieve the next set of results in a paginated API response
726
215
  */
727
- interface BasicAPI {
216
+ interface NextPage {
728
217
  /**
729
- * @apiPath /marketing/emails/2026-03
730
- * @apiMethod POST
731
- * @requiredScopes content-core-api-access
218
+ * The cursor token value to get the next set of results. Use this value as query parameter (&after=...) to obtain the next page.
732
219
  */
733
- create: (input: Basic.CreateInput) => Operation<Basic.CreateOutput>;
220
+ after: string;
734
221
  /**
735
- * Get aggregated statistics
736
- * @apiPath /marketing/emails/2026-03/statistics/list
737
- * @apiMethod GET
738
- * @requiredScopes content-core-api-access
222
+ * The link to the next page.
739
223
  */
740
- get: (input?: Basic.GetInput) => Operation<Basic.GetOutput>;
224
+ link?: string;
225
+ }
226
+ interface Paging {
227
+ next?: NextPage;
228
+ prev?: PreviousPage;
229
+ }
230
+ /**
231
+ * specifies the paging information needed to retrieve the previous set of results in a paginated API response
232
+ */
233
+ interface PreviousPage {
741
234
  /**
742
- * Get aggregated statistic intervals
743
- * @apiPath /marketing/emails/2026-03/statistics/histogram
744
- * @apiMethod GET
745
- * @requiredScopes content-core-api-access
235
+ * The cursor token value to get the previous set of results. Use this value as query parameter (&before=...) to obtain the previous page.
746
236
  */
747
- getHistogram: (input?: Basic.GetHistogramInput) => Operation<Basic.GetHistogramOutput>;
237
+ before: string;
748
238
  /**
749
- * @apiPath /marketing/emails/2026-03
750
- * @apiMethod GET
751
- * @requiredScopes content-core-api-access
239
+ * The link to the previous page.
240
+ */
241
+ link?: string;
242
+ }
243
+ interface PublicButtonStyleSettings {
244
+ backgroundColor?: Record<string, never>;
245
+ cornerRadius?: number;
246
+ fontStyle?: PublicFontStyle;
247
+ }
248
+ interface PublicDividerStyleSettings {
249
+ color?: Record<string, never>;
250
+ height?: number;
251
+ lineType?: string;
252
+ }
253
+ interface PublicEmail {
254
+ /**
255
+ * The active domain of the email.
256
+ */
257
+ activeDomain?: string;
258
+ /**
259
+ * List of emailCampaignIds.
260
+ */
261
+ allEmailCampaignIds?: string[];
262
+ /**
263
+ * Determines if the email is archived or not.
264
+ */
265
+ archived?: boolean;
266
+ businessUnitId?: string;
267
+ /**
268
+ * The ID of the campaign this email is associated to.
269
+ */
270
+ campaign?: string;
271
+ /**
272
+ * The name of the campaign.
273
+ */
274
+ campaignName?: string;
275
+ campaignUtm?: string;
276
+ /**
277
+ * The ID of the email this email was cloned from.
278
+ */
279
+ clonedFrom?: string;
280
+ content?: PublicEmailContent;
281
+ /**
282
+ * The date and time of the email's creation, in ISO8601 representation.
283
+ */
284
+ createdAt?: string;
285
+ /**
286
+ * The id of the user who created the email.
287
+ */
288
+ createdById?: string;
289
+ /**
290
+ * The date and time the email was deleted at, in ISO8601 representation.
291
+ */
292
+ deletedAt?: string;
293
+ emailCampaignGroupId?: string;
294
+ emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP';
295
+ /**
296
+ * The ID of the feedback survey linked to the email.
297
+ */
298
+ feedbackSurveyId?: string;
299
+ folderId?: number;
300
+ folderIdV2?: number;
301
+ from?: PublicEmailFromDetails;
302
+ /**
303
+ * The email ID.
304
+ */
305
+ id?: string;
306
+ isAb: boolean;
307
+ /**
308
+ * Returns the published status of the email. This is read only.
309
+ */
310
+ isPublished?: boolean;
311
+ /**
312
+ * Returns whether the email is a transactional email or not. This is read only.
313
+ */
314
+ isTransactional?: boolean;
315
+ jitterSendTime?: boolean;
316
+ language?: 'aa' | 'ab' | 'ae' | 'af' | 'af-na' | 'af-za' | 'agq' | 'agq-cm' | 'ak' | 'ak-gh' | 'am' | 'am-et' | 'an' | 'ann' | 'ann-ng' | 'ar' | 'ar-001' | 'ar-ae' | 'ar-bh' | 'ar-dj' | 'ar-dz' | 'ar-eg' | 'ar-eh' | 'ar-er' | 'ar-il' | 'ar-iq' | 'ar-jo' | 'ar-km' | 'ar-kw' | 'ar-lb' | 'ar-ly' | 'ar-ma' | 'ar-mr' | 'ar-om' | 'ar-ps' | 'ar-qa' | 'ar-sa' | 'ar-sd' | 'ar-so' | 'ar-ss' | 'ar-sy' | 'ar-td' | 'ar-tn' | 'ar-ye' | 'as' | 'as-in' | 'asa' | 'asa-tz' | 'ast' | 'ast-es' | 'av' | 'ay' | 'az' | 'az-az' | 'ba' | 'bas' | 'bas-cm' | 'be' | 'be-by' | 'bem' | 'bem-zm' | 'bez' | 'bez-tz' | 'bg' | 'bg-bg' | 'bgc' | 'bgc-in' | 'bho' | 'bho-in' | 'bi' | 'bm' | 'bm-ml' | 'bn' | 'bn-bd' | 'bn-in' | 'bo' | 'bo-cn' | 'bo-in' | 'br' | 'br-fr' | 'brx' | 'brx-in' | 'bs' | 'bs-ba' | 'ca' | 'ca-ad' | 'ca-es' | 'ca-fr' | 'ca-it' | 'ccp' | 'ccp-bd' | 'ccp-in' | 'ce' | 'ce-ru' | 'ceb' | 'ceb-ph' | 'cgg' | 'cgg-ug' | 'ch' | 'chr' | 'chr-us' | 'ckb' | 'ckb-iq' | 'ckb-ir' | 'co' | 'cr' | 'cs' | 'cs-cz' | 'cu' | 'cu-ru' | 'cv' | 'cv-ru' | 'cy' | 'cy-gb' | 'da' | 'da-dk' | 'da-gl' | 'dav' | 'dav-ke' | 'de' | 'de-at' | 'de-be' | 'de-ch' | 'de-de' | 'de-gr' | 'de-it' | 'de-li' | 'de-lu' | 'dje' | 'dje-ne' | 'doi' | 'doi-in' | 'dsb' | 'dsb-de' | 'dua' | 'dua-cm' | 'dv' | 'dyo' | 'dyo-sn' | 'dz' | 'dz-bt' | 'ebu' | 'ebu-ke' | 'ee' | 'ee-gh' | 'ee-tg' | 'el' | 'el-cy' | 'el-gr' | 'en' | 'en-001' | 'en-150' | 'en-ae' | 'en-ag' | 'en-ai' | 'en-as' | 'en-at' | 'en-au' | 'en-bb' | 'en-be' | 'en-bi' | 'en-bm' | 'en-bs' | 'en-bw' | 'en-bz' | 'en-ca' | 'en-cc' | 'en-ch' | 'en-ck' | 'en-cm' | 'en-cn' | 'en-cx' | 'en-cy' | 'en-de' | 'en-dg' | 'en-dk' | 'en-dm' | 'en-ee' | 'en-eg' | 'en-er' | 'en-es' | 'en-fi' | 'en-fj' | 'en-fk' | 'en-fm' | 'en-fr' | 'en-gb' | 'en-gd' | 'en-gg' | 'en-gh' | 'en-gi' | 'en-gm' | 'en-gu' | 'en-gy' | 'en-hk' | 'en-id' | 'en-ie' | 'en-il' | 'en-im' | 'en-in' | 'en-io' | 'en-je' | 'en-jm' | 'en-ke' | 'en-ki' | 'en-kn' | 'en-ky' | 'en-lc' | 'en-lr' | 'en-ls' | 'en-lu' | 'en-mg' | 'en-mh' | 'en-mo' | 'en-mp' | 'en-ms' | 'en-mt' | 'en-mu' | 'en-mv' | 'en-mw' | 'en-mx' | 'en-my' | 'en-na' | 'en-nf' | 'en-ng' | 'en-nl' | 'en-nr' | 'en-nu' | 'en-nz' | 'en-pg' | 'en-ph' | 'en-pk' | 'en-pn' | 'en-pr' | 'en-pt' | 'en-pw' | 'en-rw' | 'en-sb' | 'en-sc' | 'en-sd' | 'en-se' | 'en-sg' | 'en-sh' | 'en-si' | 'en-sl' | 'en-ss' | 'en-sx' | 'en-sz' | 'en-tc' | 'en-th' | 'en-tk' | 'en-tn' | 'en-to' | 'en-tt' | 'en-tv' | 'en-tz' | 'en-ug' | 'en-um' | 'en-us' | 'en-vc' | 'en-vg' | 'en-vi' | 'en-vn' | 'en-vu' | 'en-ws' | 'en-za' | 'en-zm' | 'en-zw' | 'eo' | 'eo-001' | 'es' | 'es-419' | 'es-ar' | 'es-bo' | 'es-br' | 'es-bz' | 'es-cl' | 'es-co' | 'es-cr' | 'es-cu' | 'es-do' | 'es-ea' | 'es-ec' | 'es-es' | 'es-gq' | 'es-gt' | 'es-hn' | 'es-ic' | 'es-mx' | 'es-ni' | 'es-pa' | 'es-pe' | 'es-ph' | 'es-pr' | 'es-py' | 'es-sv' | 'es-us' | 'es-uy' | 'es-ve' | 'et' | 'et-ee' | 'eu' | 'eu-es' | 'ewo' | 'ewo-cm' | 'fa' | 'fa-af' | 'fa-ir' | 'ff' | 'ff-bf' | 'ff-cm' | 'ff-gh' | 'ff-gm' | 'ff-gn' | 'ff-gw' | 'ff-lr' | 'ff-mr' | 'ff-ne' | 'ff-ng' | 'ff-sl' | 'ff-sn' | 'fi' | 'fi-fi' | 'fil' | 'fil-ph' | 'fj' | 'fo' | 'fo-dk' | 'fo-fo' | 'fr' | 'fr-be' | 'fr-bf' | 'fr-bi' | 'fr-bj' | 'fr-bl' | 'fr-ca' | 'fr-cd' | 'fr-cf' | 'fr-cg' | 'fr-ch' | 'fr-ci' | 'fr-cm' | 'fr-dj' | 'fr-dz' | 'fr-fr' | 'fr-ga' | 'fr-gf' | 'fr-gn' | 'fr-gp' | 'fr-gq' | 'fr-ht' | 'fr-km' | 'fr-lu' | 'fr-ma' | 'fr-mc' | 'fr-mf' | 'fr-mg' | 'fr-ml' | 'fr-mq' | 'fr-mr' | 'fr-mu' | 'fr-nc' | 'fr-ne' | 'fr-pf' | 'fr-pm' | 'fr-re' | 'fr-rw' | 'fr-sc' | 'fr-sn' | 'fr-sy' | 'fr-td' | 'fr-tg' | 'fr-tn' | 'fr-vu' | 'fr-wf' | 'fr-yt' | 'frr' | 'frr-de' | 'fur' | 'fur-it' | 'fy' | 'fy-nl' | 'ga' | 'ga-gb' | 'ga-ie' | 'gd' | 'gd-gb' | 'gl' | 'gl-es' | 'gn' | 'gsw' | 'gsw-ch' | 'gsw-fr' | 'gsw-li' | 'gu' | 'gu-in' | 'guz' | 'guz-ke' | 'gv' | 'gv-im' | 'ha' | 'ha-gh' | 'ha-ne' | 'ha-ng' | 'haw' | 'haw-us' | 'he' | 'he-il' | 'hi' | 'hi-in' | 'hmn' | 'ho' | 'hr' | 'hr-ba' | 'hr-hr' | 'hsb' | 'hsb-de' | 'ht' | 'hu' | 'hu-hu' | 'hy' | 'hy-am' | 'hz' | 'ia' | 'ia-001' | 'id' | 'id-id' | 'ie' | 'ig' | 'ig-ng' | 'ii' | 'ii-cn' | 'ik' | 'io' | 'is' | 'is-is' | 'it' | 'it-ch' | 'it-it' | 'it-sm' | 'it-va' | 'iu' | 'ja' | 'ja-jp' | 'jgo' | 'jgo-cm' | 'jmc' | 'jmc-tz' | 'jv' | 'jv-id' | 'ka' | 'ka-ge' | 'kab' | 'kab-dz' | 'kam' | 'kam-ke' | 'kar' | 'kde' | 'kde-tz' | 'kea' | 'kea-cv' | 'kg' | 'kgp' | 'kgp-br' | 'kh' | 'khq' | 'khq-ml' | 'ki' | 'ki-ke' | 'kj' | 'kk' | 'kk-kz' | 'kkj' | 'kkj-cm' | 'kl' | 'kl-gl' | 'kln' | 'kln-ke' | 'km' | 'km-kh' | 'kn' | 'kn-in' | 'ko' | 'ko-kp' | 'ko-kr' | 'kok' | 'kok-in' | 'kr' | 'ks' | 'ks-in' | 'ksb' | 'ksb-tz' | 'ksf' | 'ksf-cm' | 'ksh' | 'ksh-de' | 'ku' | 'ku-tr' | 'kv' | 'kw' | 'kw-gb' | 'ky' | 'ky-kg' | 'la' | 'lag' | 'lag-tz' | 'lb' | 'lb-lu' | 'lg' | 'lg-ug' | 'li' | 'lkt' | 'lkt-us' | 'ln' | 'ln-ao' | 'ln-cd' | 'ln-cf' | 'ln-cg' | 'lo' | 'lo-la' | 'lrc' | 'lrc-iq' | 'lrc-ir' | 'lt' | 'lt-lt' | 'lu' | 'lu-cd' | 'luo' | 'luo-ke' | 'luy' | 'luy-ke' | 'lv' | 'lv-lv' | 'mai' | 'mai-in' | 'mas' | 'mas-ke' | 'mas-tz' | 'mdf' | 'mdf-ru' | 'mer' | 'mer-ke' | 'mfe' | 'mfe-mu' | 'mg' | 'mg-mg' | 'mgh' | 'mgh-mz' | 'mgo' | 'mgo-cm' | 'mh' | 'mi' | 'mi-nz' | 'mk' | 'mk-mk' | 'ml' | 'ml-in' | 'mn' | 'mn-mn' | 'mni' | 'mni-in' | 'mr' | 'mr-in' | 'ms' | 'ms-bn' | 'ms-id' | 'ms-my' | 'ms-sg' | 'mt' | 'mt-mt' | 'mua' | 'mua-cm' | 'my' | 'my-mm' | 'mzn' | 'mzn-ir' | 'na' | 'naq' | 'naq-na' | 'nb' | 'nb-no' | 'nb-sj' | 'nd' | 'nd-zw' | 'nds' | 'nds-de' | 'nds-nl' | 'ne' | 'ne-in' | 'ne-np' | 'ng' | 'nl' | 'nl-aw' | 'nl-be' | 'nl-bq' | 'nl-ch' | 'nl-cw' | 'nl-lu' | 'nl-nl' | 'nl-sr' | 'nl-sx' | 'nmg' | 'nmg-cm' | 'nn' | 'nn-no' | 'nnh' | 'nnh-cm' | 'no' | 'no-no' | 'nr' | 'nus' | 'nus-ss' | 'nv' | 'ny' | 'nyn' | 'nyn-ug' | 'oc' | 'oc-es' | 'oc-fr' | 'oj' | 'om' | 'om-et' | 'om-ke' | 'or' | 'or-in' | 'os' | 'os-ge' | 'os-ru' | 'pa' | 'pa-in' | 'pa-pk' | 'pcm' | 'pcm-ng' | 'pi' | 'pis' | 'pis-sb' | 'pl' | 'pl-pl' | 'prg' | 'prg-001' | 'ps' | 'ps-af' | 'ps-pk' | 'pt' | 'pt-ao' | 'pt-br' | 'pt-ch' | 'pt-cv' | 'pt-gq' | 'pt-gw' | 'pt-lu' | 'pt-mo' | 'pt-mz' | 'pt-pt' | 'pt-st' | 'pt-tl' | 'qu' | 'qu-bo' | 'qu-ec' | 'qu-pe' | 'raj' | 'raj-in' | 'rm' | 'rm-ch' | 'rn' | 'rn-bi' | 'ro' | 'ro-md' | 'ro-ro' | 'rof' | 'rof-tz' | 'ru' | 'ru-by' | 'ru-kg' | 'ru-kz' | 'ru-md' | 'ru-ru' | 'ru-ua' | 'rw' | 'rw-rw' | 'rwk' | 'rwk-tz' | 'sa' | 'sa-in' | 'sah' | 'sah-ru' | 'saq' | 'saq-ke' | 'sat' | 'sat-in' | 'sbp' | 'sbp-tz' | 'sc' | 'sc-it' | 'sd' | 'sd-in' | 'sd-pk' | 'se' | 'se-fi' | 'se-no' | 'se-se' | 'seh' | 'seh-mz' | 'ses' | 'ses-ml' | 'sg' | 'sg-cf' | 'shi' | 'shi-ma' | 'si' | 'si-lk' | 'sk' | 'sk-sk' | 'sl' | 'sl-si' | 'sm' | 'smn' | 'smn-fi' | 'sms' | 'sms-fi' | 'sn' | 'sn-zw' | 'so' | 'so-dj' | 'so-et' | 'so-ke' | 'so-so' | 'sq' | 'sq-al' | 'sq-mk' | 'sq-xk' | 'sr' | 'sr-ba' | 'sr-cs' | 'sr-me' | 'sr-rs' | 'sr-xk' | 'ss' | 'st' | 'su' | 'su-id' | 'sv' | 'sv-ax' | 'sv-fi' | 'sv-se' | 'sw' | 'sw-cd' | 'sw-ke' | 'sw-tz' | 'sw-ug' | 'sy' | 'ta' | 'ta-in' | 'ta-lk' | 'ta-my' | 'ta-sg' | 'te' | 'te-in' | 'teo' | 'teo-ke' | 'teo-ug' | 'tg' | 'tg-tj' | 'th' | 'th-th' | 'ti' | 'ti-er' | 'ti-et' | 'tk' | 'tk-tm' | 'tl' | 'tn' | 'to' | 'to-to' | 'tok' | 'tok-001' | 'tr' | 'tr-cy' | 'tr-tr' | 'ts' | 'tt' | 'tt-ru' | 'tw' | 'twq' | 'twq-ne' | 'ty' | 'tzm' | 'tzm-ma' | 'ug' | 'ug-cn' | 'uk' | 'uk-ua' | 'ur' | 'ur-in' | 'ur-pk' | 'uz' | 'uz-af' | 'uz-uz' | 'vai' | 'vai-lr' | 've' | 'vi' | 'vi-vn' | 'vo' | 'vo-001' | 'vun' | 'vun-tz' | 'wa' | 'wae' | 'wae-ch' | 'wo' | 'wo-sn' | 'xh' | 'xh-za' | 'xog' | 'xog-ug' | 'yav' | 'yav-cm' | 'yi' | 'yi-001' | 'yo' | 'yo-bj' | 'yo-ng' | 'yrl' | 'yrl-br' | 'yrl-co' | 'yrl-ve' | 'yue' | 'yue-cn' | 'yue-hk' | 'za' | 'zgh' | 'zgh-ma' | 'zh' | 'zh-cn' | 'zh-hans' | 'zh-hant' | 'zh-hk' | 'zh-mo' | 'zh-sg' | 'zh-tw' | 'zu' | 'zu-za';
317
+ /**
318
+ * The name of the email, as displayed on the email dashboard.
319
+ */
320
+ name?: string;
321
+ previewKey?: string;
322
+ primaryEmailCampaignId?: string;
323
+ /**
324
+ * The date and time the email is scheduled for, in ISO8601 representation. This is only used in local time or scheduled emails.
325
+ */
326
+ publishDate?: string;
327
+ /**
328
+ * The date and time the email was published at, in ISO8601 representation.
329
+ */
330
+ publishedAt?: string;
331
+ /**
332
+ * Email of the user who published/sent the email.
333
+ */
334
+ publishedByEmail?: string;
335
+ /**
336
+ * The ID of the user who published the email.
337
+ */
338
+ publishedById?: string;
339
+ /**
340
+ * Name of the user who published the email.
341
+ */
342
+ publishedByName?: string;
343
+ rssData?: PublicRssEmailDetails;
344
+ /**
345
+ * Determines whether the email will be sent immediately on publish.
346
+ */
347
+ sendOnPublish?: boolean;
348
+ /**
349
+ * The email state.
350
+ */
351
+ state?: 'AGENT_GENERATED' | 'AUTOMATED' | 'AUTOMATED_AB' | 'AUTOMATED_AB_VARIANT' | 'AUTOMATED_DRAFT' | 'AUTOMATED_DRAFT_AB' | 'AUTOMATED_DRAFT_ABVARIANT' | 'AUTOMATED_FOR_FORM' | 'AUTOMATED_FOR_FORM_BUFFER' | 'AUTOMATED_FOR_FORM_DRAFT' | 'AUTOMATED_FOR_FORM_LEGACY' | 'AUTOMATED_LOSER_ABVARIANT' | 'AUTOMATED_SENDING' | 'BLOG_EMAIL_DRAFT' | 'BLOG_EMAIL_PUBLISHED' | 'DRAFT' | 'DRAFT_AB' | 'DRAFT_AB_VARIANT' | 'ERROR' | 'LOSER_AB_VARIANT' | 'PAGE_STUB' | 'PRE_PROCESSING' | 'PROCESSING' | 'PUBLISHED' | 'PUBLISHED_AB' | 'PUBLISHED_AB_VARIANT' | 'PUBLISHED_OR_SCHEDULED' | 'RSS_TO_EMAIL_DRAFT' | 'RSS_TO_EMAIL_PUBLISHED' | 'SCHEDULED' | 'SCHEDULED_AB' | 'SCHEDULED_OR_PUBLISHED';
352
+ stats?: EmailStatisticsData;
353
+ /**
354
+ * The email subcategory.
355
+ */
356
+ subcategory?: string;
357
+ /**
358
+ * The subject of the email.
359
+ */
360
+ subject?: string;
361
+ subscriptionDetails?: PublicEmailSubscriptionDetails;
362
+ teamsWithAccess?: string[];
363
+ testing?: PublicEmailTestingDetails;
364
+ to?: PublicEmailToDetails;
365
+ /**
366
+ * The email type, this is derived from other properties on the email such as subcategory.
367
+ */
368
+ type?: 'AB_EMAIL' | 'AUTOMATED_AB_EMAIL' | 'AUTOMATED_EMAIL' | 'BATCH_EMAIL' | 'BLOG_EMAIL' | 'BLOG_EMAIL_CHILD' | 'FEEDBACK_CES_EMAIL' | 'FEEDBACK_CUSTOM_EMAIL' | 'FEEDBACK_CUSTOM_SURVEY_EMAIL' | 'FEEDBACK_NPS_EMAIL' | 'FOLLOWUP_EMAIL' | 'LEADFLOW_EMAIL' | 'LOCALTIME_EMAIL' | 'MANAGE_PREFERENCES_EMAIL' | 'MARKETING_SINGLE_SEND_API' | 'MEMBERSHIP_EMAIL_VERIFICATION_EMAIL' | 'MEMBERSHIP_FOLLOW_UP_EMAIL' | 'MEMBERSHIP_OTP_LOGIN_EMAIL' | 'MEMBERSHIP_PASSWORD_RESET_EMAIL' | 'MEMBERSHIP_PASSWORD_SAVED_EMAIL' | 'MEMBERSHIP_PASSWORDLESS_AUTH_EMAIL' | 'MEMBERSHIP_REGISTRATION_EMAIL' | 'MEMBERSHIP_REGISTRATION_FOLLOW_UP_EMAIL' | 'MEMBERSHIP_VERIFICATION_EMAIL' | 'OPTIN_EMAIL' | 'OPTIN_FOLLOWUP_EMAIL' | 'RESUBSCRIBE_EMAIL' | 'RSS_EMAIL' | 'RSS_EMAIL_CHILD' | 'SINGLE_SEND_API' | 'SMTP_TOKEN' | 'TICKET_EMAIL';
369
+ unpublishedAt?: string;
370
+ /**
371
+ * The date and time of the last update to the email, in ISO8601 representation.
372
+ */
373
+ updatedAt?: string;
374
+ /**
375
+ * The id of the user who last updated the email.
376
+ */
377
+ updatedById?: string;
378
+ usersWithAccess?: string[];
379
+ webversion?: PublicWebversionDetails;
380
+ /**
381
+ * Names of workflows in which the email is used within a "send email" action.
382
+ */
383
+ workflowNames?: string[];
384
+ }
385
+ interface PublicEmailContent {
386
+ flexAreas?: Record<string, Record<string, never>>;
387
+ plainTextVersion?: string;
388
+ smartFields?: Record<string, SmartEmailField>;
389
+ styleSettings?: PublicEmailStyleSettings;
390
+ templatePath?: string;
391
+ themeSettingsValues?: Record<string, Record<string, never>>;
392
+ widgetContainers?: Record<string, Record<string, never>>;
393
+ widgets?: Record<string, Record<string, never>>;
394
+ }
395
+ interface PublicEmailFromDetails {
396
+ /**
397
+ * The reply to recipients will see.
398
+ */
399
+ customReplyTo?: string;
400
+ /**
401
+ * The name recipients will see.
402
+ */
403
+ fromName?: string;
404
+ /**
405
+ * The from address and reply to email address (if no customReplyTo defined) recipients will see.
406
+ */
407
+ replyTo?: string;
408
+ }
409
+ interface PublicEmailRecipients {
410
+ /**
411
+ * Excluded IDs.
752
412
  */
753
- list: (input?: Basic.ListInput) => Operation<Basic.ListOutput>;
413
+ exclude?: string[];
414
+ /**
415
+ * Included IDs.
416
+ */
417
+ include?: string[];
418
+ }
419
+ interface PublicEmailStyleSettings {
420
+ backgroundColor?: string;
421
+ backgroundImage?: string;
422
+ backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH';
423
+ bodyBorderColor?: string;
424
+ bodyBorderColorChoice?: string;
425
+ bodyBorderWidth?: number;
426
+ bodyColor?: string;
427
+ buttonStyleSettings?: PublicButtonStyleSettings;
428
+ colorPickerFavorite1?: string;
429
+ colorPickerFavorite2?: string;
430
+ colorPickerFavorite3?: string;
431
+ colorPickerFavorite4?: string;
432
+ colorPickerFavorite5?: string;
433
+ colorPickerFavorite6?: string;
434
+ dividerStyleSettings?: PublicDividerStyleSettings;
435
+ emailBodyPadding?: string;
436
+ emailBodyWidth?: string;
437
+ headingOneFont?: PublicFontStyle;
438
+ headingTwoFont?: PublicFontStyle;
439
+ linksFont?: PublicFontStyle;
440
+ primaryAccentColor?: string;
441
+ primaryFont?: string;
442
+ primaryFontColor?: string;
443
+ primaryFontLineHeight?: string;
444
+ primaryFontSize?: number;
445
+ secondaryAccentColor?: string;
446
+ secondaryFont?: string;
447
+ secondaryFontColor?: string;
448
+ secondaryFontLineHeight?: string;
449
+ secondaryFontSize?: number;
450
+ }
451
+ interface PublicEmailSubscriptionDetails {
452
+ /**
453
+ * ID of the selected office location.
454
+ */
455
+ officeLocationId?: string;
456
+ preferencesGroupId?: string;
457
+ /**
458
+ * ID of the subscription.
459
+ */
460
+ subscriptionId?: string;
461
+ subscriptionName?: string;
462
+ }
463
+ interface PublicEmailTestingDetails {
464
+ /**
465
+ * Version of the email that should be sent if there are too few recipients to conduct an AB test.
466
+ */
467
+ abSampleSizeDefault?: 'automated_loser_variant' | 'automated_master' | 'automated_variant' | 'loser_variant' | 'mab_master' | 'mab_variant' | 'master' | 'variant';
468
+ /**
469
+ * Version of the email that should be sent if the results are inconclusive after the test period, master or variant.
470
+ */
471
+ abSamplingDefault?: 'automated_loser_variant' | 'automated_master' | 'automated_variant' | 'loser_variant' | 'mab_master' | 'mab_variant' | 'master' | 'variant';
472
+ /**
473
+ * Status of the AB test.
474
+ */
475
+ abStatus?: 'automated_loser_variant' | 'automated_master' | 'automated_variant' | 'loser_variant' | 'mab_master' | 'mab_variant' | 'master' | 'variant';
476
+ /**
477
+ * Metric to determine the version that will be sent to the remaining contacts.
478
+ */
479
+ abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED';
480
+ /**
481
+ * The size of your test group.
482
+ */
483
+ abTestPercentage?: number;
484
+ /**
485
+ * Time limit on gathering test results. After this time is up, the winning version will be sent to the remaining contacts.
486
+ */
487
+ hoursToWait?: number;
488
+ isAbVariation: boolean;
489
+ /**
490
+ * The ID of the AB test.
491
+ */
492
+ testId?: string;
493
+ }
494
+ interface PublicEmailToDetails {
495
+ contactIds?: PublicEmailRecipients;
496
+ contactIlsLists?: PublicEmailRecipients;
497
+ contactLists?: PublicEmailRecipients;
498
+ limitSendFrequency?: boolean;
499
+ /**
500
+ * Whether to send to unengaged contacts (false) or not (true).
501
+ */
502
+ suppressGraymail?: boolean;
503
+ }
504
+ interface PublicEmailVersion {
505
+ id: string;
506
+ object: PublicEmail;
507
+ updatedAt: string;
508
+ user: VersionUser;
754
509
  }
510
+ interface PublicFontStyle {
511
+ bold?: boolean;
512
+ color?: string;
513
+ font?: string;
514
+ italic?: boolean;
515
+ size?: number;
516
+ underline?: boolean;
517
+ }
518
+ interface PublicRssEmailDetails {
519
+ blogEmailType?: string;
520
+ blogImageMaxWidth?: number;
521
+ blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE';
522
+ hubspotBlogId?: string;
523
+ maxEntries?: number;
524
+ rssEntryTemplate?: string;
525
+ timing?: Record<string, Record<string, never>>;
526
+ url?: string;
527
+ useHeadlineAsSubject?: boolean;
528
+ }
529
+ interface PublicWebversionDetails {
530
+ domain?: string;
531
+ enabled?: boolean;
532
+ expiresAt?: string;
533
+ isPageRedirected?: boolean;
534
+ metaDescription?: string;
535
+ pageExpiryEnabled?: boolean;
536
+ redirectToPageId?: string;
537
+ redirectToUrl?: string;
538
+ slug?: string;
539
+ title?: string;
540
+ url?: string;
541
+ }
542
+ interface SmartEmailField {}
543
+ interface VersionPublicEmail {
544
+ /**
545
+ * ID of this marketing email version.
546
+ */
547
+ id: string;
548
+ object: PublicEmail;
549
+ /**
550
+ * The date and time of the last update to the email, in ISO8601 representation.
551
+ */
552
+ updatedAt: string;
553
+ user: VersionUser;
554
+ }
555
+ interface VersionUser {
556
+ /**
557
+ * Email address of the user.
558
+ */
559
+ email: string;
560
+ /**
561
+ * First and last name of the user.
562
+ */
563
+ fullName: string;
564
+ /**
565
+ * ID of the user.
566
+ */
567
+ id: string;
568
+ }
569
+ }
570
+ declare namespace MarketingEmails {
571
+ type CloneInput = MarketingMarketingEmailsSchemas.EmailCloneRequestVNext;
572
+ type CloneOutput = MarketingMarketingEmailsSchemas.PublicEmail;
573
+ type CreateAbTestVariationInput = MarketingMarketingEmailsSchemas.AbTestCreateRequestVNext;
574
+ type CreateAbTestVariationOutput = MarketingMarketingEmailsSchemas.PublicEmail;
575
+ type CreateInput = MarketingMarketingEmailsSchemas.EmailCreateRequest;
576
+ type CreateOutput = MarketingMarketingEmailsSchemas.PublicEmail;
577
+ interface DeleteInput {
578
+ /**
579
+ * Whether to return only results that have been archived.
580
+ */
581
+ archived?: boolean;
582
+ emailId: string;
583
+ }
584
+ type DeleteOutput = void;
585
+ interface Get2Input {
586
+ /**
587
+ * Whether to return only results that have been archived.
588
+ */
589
+ archived?: boolean;
590
+ emailId: string;
591
+ includedProperties?: string[];
592
+ includeStats?: boolean;
593
+ marketingCampaignNames?: boolean;
594
+ variantStats?: boolean;
595
+ workflowNames?: boolean;
596
+ }
597
+ type Get2Output = MarketingMarketingEmailsSchemas.PublicEmail;
598
+ interface GetAbTestVariationInput {
599
+ /**
600
+ * Whether to return only results that have been archived.
601
+ */
602
+ archived?: boolean;
603
+ emailId: string;
604
+ includedProperties?: string[];
605
+ includeStats?: boolean;
606
+ marketingCampaignNames?: boolean;
607
+ variantStats?: boolean;
608
+ workflowNames?: boolean;
609
+ }
610
+ type GetAbTestVariationOutput = MarketingMarketingEmailsSchemas.PublicEmail;
611
+ interface GetDraftInput {
612
+ emailId: string;
613
+ }
614
+ type GetDraftOutput = MarketingMarketingEmailsSchemas.PublicEmail;
615
+ interface GetHistogramInput {
616
+ emailIds?: number[];
617
+ endTimestamp?: string;
618
+ interval?: 'DAY' | 'HOUR' | 'MINUTE' | 'MONTH' | 'QUARTER' | 'QUARTER_HOUR' | 'SECOND' | 'WEEK' | 'YEAR';
619
+ startTimestamp?: string;
620
+ }
621
+ type GetHistogramOutput = MarketingMarketingEmailsSchemas.CollectionResponseWithTotalEmailStatisticInterval;
622
+ interface GetInput {
623
+ emailIds?: number[];
624
+ endTimestamp?: string;
625
+ property?: string;
626
+ startTimestamp?: string;
627
+ }
628
+ type GetOutput = MarketingMarketingEmailsSchemas.AggregateEmailStatistics;
629
+ interface GetRevisionInput {
630
+ emailId: string;
631
+ revisionId: string;
632
+ }
633
+ type GetRevisionOutput = MarketingMarketingEmailsSchemas.PublicEmailVersion;
634
+ interface ListInput {
635
+ /**
636
+ * 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.
637
+ */
638
+ after?: string;
639
+ /**
640
+ * Whether to return only results that have been archived.
641
+ */
642
+ archived?: boolean;
643
+ campaign?: string;
644
+ createdAfter?: string;
645
+ createdAt?: string;
646
+ createdBefore?: string;
647
+ includedProperties?: string[];
648
+ includeStats?: boolean;
649
+ isPublished?: boolean;
650
+ /**
651
+ * The maximum number of results to display per page.
652
+ */
653
+ limit?: number;
654
+ marketingCampaignNames?: boolean;
655
+ publishedAfter?: string;
656
+ publishedAt?: string;
657
+ publishedBefore?: string;
658
+ sort?: string[];
659
+ type?: 'AB_EMAIL' | 'AUTOMATED_AB_EMAIL' | 'AUTOMATED_EMAIL' | 'BATCH_EMAIL' | 'BLOG_EMAIL' | 'BLOG_EMAIL_CHILD' | 'FEEDBACK_CES_EMAIL' | 'FEEDBACK_CUSTOM_EMAIL' | 'FEEDBACK_CUSTOM_SURVEY_EMAIL' | 'FEEDBACK_NPS_EMAIL' | 'FOLLOWUP_EMAIL' | 'LEADFLOW_EMAIL' | 'LOCALTIME_EMAIL' | 'MANAGE_PREFERENCES_EMAIL' | 'MARKETING_SINGLE_SEND_API' | 'MEMBERSHIP_EMAIL_VERIFICATION_EMAIL' | 'MEMBERSHIP_FOLLOW_UP_EMAIL' | 'MEMBERSHIP_OTP_LOGIN_EMAIL' | 'MEMBERSHIP_PASSWORD_RESET_EMAIL' | 'MEMBERSHIP_PASSWORD_SAVED_EMAIL' | 'MEMBERSHIP_PASSWORDLESS_AUTH_EMAIL' | 'MEMBERSHIP_REGISTRATION_EMAIL' | 'MEMBERSHIP_REGISTRATION_FOLLOW_UP_EMAIL' | 'MEMBERSHIP_VERIFICATION_EMAIL' | 'OPTIN_EMAIL' | 'OPTIN_FOLLOWUP_EMAIL' | 'RESUBSCRIBE_EMAIL' | 'RSS_EMAIL' | 'RSS_EMAIL_CHILD' | 'SINGLE_SEND_API' | 'SMTP_TOKEN' | 'TICKET_EMAIL';
660
+ updatedAfter?: string;
661
+ updatedAt?: string;
662
+ updatedBefore?: string;
663
+ variantStats?: boolean;
664
+ workflowNames?: boolean;
665
+ }
666
+ type ListOutput = MarketingMarketingEmailsSchemas.CollectionResponseWithTotalPublicEmail;
667
+ interface ListRevisionsInput {
668
+ /**
669
+ * 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.
670
+ */
671
+ after?: string;
672
+ before?: string;
673
+ emailId: string;
674
+ /**
675
+ * The maximum number of results to display per page.
676
+ */
677
+ limit?: number;
678
+ }
679
+ type ListRevisionsOutput = MarketingMarketingEmailsSchemas.CollectionResponseWithTotalPublicEmailVersion;
680
+ interface PublishInput {
681
+ emailId: string;
682
+ }
683
+ type PublishOutput = void;
684
+ interface ResetDraftInput {
685
+ emailId: string;
686
+ }
687
+ type ResetDraftOutput = void;
688
+ interface RestoreRevisionInput {
689
+ emailId: string;
690
+ revisionId: string;
691
+ }
692
+ type RestoreRevisionOutput = void;
693
+ interface RestoreRevisionToDraftInput {
694
+ emailId: string;
695
+ revisionId: number;
696
+ }
697
+ type RestoreRevisionToDraftOutput = MarketingMarketingEmailsSchemas.PublicEmail;
698
+ interface UnpublishInput {
699
+ emailId: string;
700
+ }
701
+ type UnpublishOutput = void;
702
+ interface UpdateDraftInput {
703
+ data: MarketingMarketingEmailsSchemas.EmailUpdateRequest;
704
+ emailId: string;
705
+ }
706
+ type UpdateDraftOutput = MarketingMarketingEmailsSchemas.PublicEmail;
707
+ interface UpdateInput {
708
+ /**
709
+ * Whether to return only results that have been archived.
710
+ */
711
+ archived?: boolean;
712
+ data: MarketingMarketingEmailsSchemas.EmailUpdateRequest;
713
+ emailId: string;
714
+ }
715
+ type UpdateOutput = MarketingMarketingEmailsSchemas.PublicEmail;
755
716
  /**
756
717
  * Usage example:
757
718
  * ```ts
758
- * import { marketingMarketingEmails } from '@hubspot/api-client-core';
759
- * client.send(marketingMarketingEmails.emails.clone(input));
719
+ * import { marketingEmails } from '@hubspot/api-client-core';
720
+ * client.send(marketingEmails.clone(input));
760
721
  * ```
761
722
  */
762
- interface EmailsAPI {
723
+ interface API {
763
724
  /**
764
725
  * Clone a marketing email
765
726
  * @apiPath /marketing/emails/2026-03/clone
766
727
  * @apiMethod POST
767
728
  * @requiredScopes content-core-api-access
768
729
  */
769
- clone: (input: Emails.CloneInput) => Operation<Emails.CloneOutput>;
730
+ clone: (input: CloneInput) => Operation<CloneOutput>;
731
+ /**
732
+ * @apiPath /marketing/emails/2026-03
733
+ * @apiMethod POST
734
+ * @requiredScopes content-core-api-access
735
+ */
736
+ create: (input: CreateInput) => Operation<CreateOutput>;
770
737
  /**
771
738
  * Create an A/B test variation of a marketing email
772
739
  * @apiPath /marketing/emails/2026-03/ab-test/create-variation
773
740
  * @apiMethod POST
774
741
  * @requiredScopes content-core-api-access
775
742
  */
776
- createAbTestVariation: (input: Emails.CreateAbTestVariationInput) => Operation<Emails.CreateAbTestVariationOutput>;
743
+ createAbTestVariation: (input: CreateAbTestVariationInput) => Operation<CreateAbTestVariationOutput>;
777
744
  /**
778
745
  * Delete a marketing email
779
746
  * @apiPath /marketing/emails/2026-03/{emailId}
780
747
  * @apiMethod DELETE
781
748
  * @requiredScopes content-core-api-access
782
749
  */
783
- delete: (input: Emails.DeleteInput) => Operation<Emails.DeleteOutput>;
750
+ delete: (input: DeleteInput) => Operation<DeleteOutput>;
751
+ /**
752
+ * Get aggregated statistics
753
+ * @apiPath /marketing/emails/2026-03/statistics/list
754
+ * @apiMethod GET
755
+ * @requiredScopes content-core-api-access
756
+ */
757
+ get: (input?: GetInput) => Operation<GetOutput>;
784
758
  /**
785
759
  * Get the details of a specified marketing email
786
760
  * @apiPath /marketing/emails/2026-03/{emailId}
787
761
  * @apiMethod GET
788
762
  * @requiredScopes content-core-api-access
789
763
  */
790
- get: (input: Emails.GetInput) => Operation<Emails.GetOutput>;
764
+ get2: (input: Get2Input) => Operation<Get2Output>;
791
765
  /**
792
766
  * Get the variation of a an A/B marketing email
793
767
  * @apiPath /marketing/emails/2026-03/{emailId}/ab-test/get-variation
794
768
  * @apiMethod GET
795
769
  * @requiredScopes content-core-api-access
796
770
  */
797
- getAbTestVariation: (input: Emails.GetAbTestVariationInput) => Operation<Emails.GetAbTestVariationOutput>;
771
+ getAbTestVariation: (input: GetAbTestVariationInput) => Operation<GetAbTestVariationOutput>;
798
772
  /**
799
773
  * Get draft version of a marketing email
800
774
  * @apiPath /marketing/emails/2026-03/{emailId}/draft
801
775
  * @apiMethod GET
802
776
  * @requiredScopes content-core-api-access
803
777
  */
804
- getDraft: (input: Emails.GetDraftInput) => Operation<Emails.GetDraftOutput>;
778
+ getDraft: (input: GetDraftInput) => Operation<GetDraftOutput>;
779
+ /**
780
+ * Get aggregated statistic intervals
781
+ * @apiPath /marketing/emails/2026-03/statistics/histogram
782
+ * @apiMethod GET
783
+ * @requiredScopes content-core-api-access
784
+ */
785
+ getHistogram: (input?: GetHistogramInput) => Operation<GetHistogramOutput>;
805
786
  /**
806
787
  * Get a revision of a marketing email
807
788
  * @apiPath /marketing/emails/2026-03/{emailId}/revisions/{revisionId}
808
789
  * @apiMethod GET
809
790
  * @requiredScopes content-core-api-access
810
791
  */
811
- getRevision: (input: Emails.GetRevisionInput) => Operation<Emails.GetRevisionOutput>;
792
+ getRevision: (input: GetRevisionInput) => Operation<GetRevisionOutput>;
793
+ /**
794
+ * @apiPath /marketing/emails/2026-03
795
+ * @apiMethod GET
796
+ * @requiredScopes content-core-api-access
797
+ */
798
+ list: (input?: ListInput) => Operation<ListOutput>;
812
799
  /**
813
800
  * Get revisions of a marketing email
814
801
  * @apiPath /marketing/emails/2026-03/{emailId}/revisions
815
802
  * @apiMethod GET
816
803
  * @requiredScopes content-core-api-access
817
804
  */
818
- listRevisions: (input: Emails.ListRevisionsInput) => Operation<Emails.ListRevisionsOutput>;
805
+ listRevisions: (input: ListRevisionsInput) => Operation<ListRevisionsOutput>;
819
806
  /**
820
807
  * Publish or send a marketing email
821
808
  * @apiPath /marketing/emails/2026-03/{emailId}/publish
822
809
  * @apiMethod POST
823
810
  * @requiredScopes marketing-email-publish-api-access
824
811
  */
825
- publish: (input: Emails.PublishInput) => Operation<Emails.PublishOutput>;
812
+ publish: (input: PublishInput) => Operation<PublishOutput>;
826
813
  /**
827
814
  * Reset the draft version
828
815
  * @apiPath /marketing/emails/2026-03/{emailId}/draft/reset
829
816
  * @apiMethod POST
830
817
  * @requiredScopes content-core-api-access
831
818
  */
832
- resetDraft: (input: Emails.ResetDraftInput) => Operation<Emails.ResetDraftOutput>;
819
+ resetDraft: (input: ResetDraftInput) => Operation<ResetDraftOutput>;
833
820
  /**
834
821
  * Restore a revision of a marketing email
835
822
  * @apiPath /marketing/emails/2026-03/{emailId}/revisions/{revisionId}/restore
836
823
  * @apiMethod POST
837
824
  * @requiredScopes content-core-api-access
838
825
  */
839
- restoreRevision: (input: Emails.RestoreRevisionInput) => Operation<Emails.RestoreRevisionOutput>;
826
+ restoreRevision: (input: RestoreRevisionInput) => Operation<RestoreRevisionOutput>;
840
827
  /**
841
828
  * Restore a revision of a marketing email to DRAFT state
842
829
  * @apiPath /marketing/emails/2026-03/{emailId}/revisions/{revisionId}/restore-to-draft
843
830
  * @apiMethod POST
844
831
  * @requiredScopes content-core-api-access
845
832
  */
846
- restoreRevisionToDraft: (input: Emails.RestoreRevisionToDraftInput) => Operation<Emails.RestoreRevisionToDraftOutput>;
833
+ restoreRevisionToDraft: (input: RestoreRevisionToDraftInput) => Operation<RestoreRevisionToDraftOutput>;
847
834
  /**
848
835
  * Unpublish or cancel a marketing email
849
836
  * @apiPath /marketing/emails/2026-03/{emailId}/unpublish
850
837
  * @apiMethod POST
851
838
  * @requiredScopes marketing-email-publish-api-access
852
839
  */
853
- unpublish: (input: Emails.UnpublishInput) => Operation<Emails.UnpublishOutput>;
840
+ unpublish: (input: UnpublishInput) => Operation<UnpublishOutput>;
854
841
  /**
855
842
  * Update a marketing email
856
843
  * @apiPath /marketing/emails/2026-03/{emailId}
857
844
  * @apiMethod PATCH
858
845
  * @requiredScopes content-core-api-access
859
846
  */
860
- update: (input: Emails.UpdateInput) => Operation<Emails.UpdateOutput>;
847
+ update: (input: UpdateInput) => Operation<UpdateOutput>;
861
848
  /**
862
849
  * Create or update draft version
863
850
  * @apiPath /marketing/emails/2026-03/{emailId}/draft
864
851
  * @apiMethod PATCH
865
852
  * @requiredScopes content-core-api-access
866
853
  */
867
- updateDraft: (input: Emails.UpdateDraftInput) => Operation<Emails.UpdateDraftOutput>;
868
- }
869
- /**
870
- * Usage example:
871
- * ```ts
872
- * import { marketingMarketingEmails } from '@hubspot/api-client-core';
873
- * client.send(marketingMarketingEmails.basic.create(input));
874
- * ```
875
- */
876
- interface API {
877
- basic: BasicAPI;
878
- emails: EmailsAPI;
854
+ updateDraft: (input: UpdateDraftInput) => Operation<UpdateDraftOutput>;
879
855
  }
880
856
  }
881
857
  //#endregion
882
- export { MarketingMarketingEmails };
858
+ export { MarketingEmails, MarketingMarketingEmailsSchemas };
883
859
  //# sourceMappingURL=marketing-emails-types.generated.d.ts.map