sequenzy 2.1.10 → 2.1.16

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 (271) hide show
  1. package/dist/cjs/api/resources/analytics/types/GetSequenceMetricsResponse.d.ts +1 -0
  2. package/dist/cjs/api/resources/campaigns/types/CreateForAudienceCampaignsRequestSelectionActivity.d.ts +1 -1
  3. package/dist/cjs/api/resources/campaigns/types/CreateForAudienceCampaignsRequestSelectionActivityBounceType.d.ts +3 -1
  4. package/dist/cjs/api/resources/campaigns/types/CreateForAudienceCampaignsRequestSelectionActivityBounceType.js +3 -1
  5. package/dist/cjs/api/resources/emailSends/client/requests/ListEmailSendsRequest.d.ts +1 -0
  6. package/dist/cjs/api/resources/emailSends/types/ListEmailSendsRequestBounceType.d.ts +2 -0
  7. package/dist/cjs/api/resources/emailSends/types/ListEmailSendsRequestBounceType.js +2 -0
  8. package/dist/cjs/api/resources/integrations/client/Client.d.ts +3 -2
  9. package/dist/cjs/api/resources/integrations/client/Client.js +5 -2
  10. package/dist/cjs/api/resources/integrations/client/requests/ConnectIntegrationsRequest.d.ts +4 -4
  11. package/dist/cjs/api/resources/integrations/client/requests/DisconnectIntegrationsRequest.d.ts +1 -1
  12. package/dist/cjs/api/resources/integrations/types/ConnectIntegrationsRequestProvider.d.ts +1 -0
  13. package/dist/cjs/api/resources/integrations/types/ConnectIntegrationsRequestProvider.js +1 -0
  14. package/dist/cjs/api/resources/integrations/types/ConnectIntegrationsRequestSettings.d.ts +3 -1
  15. package/dist/cjs/api/resources/integrations/types/ConnectIntegrationsResponse.d.ts +3 -1
  16. package/dist/cjs/api/resources/integrations/types/ConnectIntegrationsResponsePublication.d.ts +7 -0
  17. package/dist/cjs/api/resources/integrations/types/ConnectIntegrationsResponsePublication.js +3 -0
  18. package/dist/cjs/api/resources/integrations/types/DisconnectIntegrationsResponse.d.ts +1 -1
  19. package/dist/cjs/api/resources/integrations/types/DisconnectIntegrationsResponseProvider.d.ts +1 -0
  20. package/dist/cjs/api/resources/integrations/types/DisconnectIntegrationsResponseProvider.js +1 -0
  21. package/dist/cjs/api/resources/integrations/types/index.d.ts +1 -0
  22. package/dist/cjs/api/resources/integrations/types/index.js +1 -0
  23. package/dist/cjs/api/resources/sequences/client/Client.d.ts +52 -3
  24. package/dist/cjs/api/resources/sequences/client/Client.js +164 -3
  25. package/dist/cjs/api/resources/sequences/client/requests/ListEnrollmentsSequencesRequest.d.ts +1 -1
  26. package/dist/cjs/api/resources/sequences/client/requests/SequenceEnrollmentCancelRequest.d.ts +1 -1
  27. package/dist/cjs/api/resources/sequences/client/requests/SequenceEnrollmentPauseRequest.d.ts +24 -0
  28. package/dist/cjs/api/resources/sequences/client/requests/SequenceEnrollmentPauseRequest.js +3 -0
  29. package/dist/cjs/api/resources/sequences/client/requests/SequenceEnrollmentResumeRequest.d.ts +15 -0
  30. package/dist/cjs/api/resources/sequences/client/requests/SequenceEnrollmentResumeRequest.js +3 -0
  31. package/dist/cjs/api/resources/sequences/client/requests/index.d.ts +2 -0
  32. package/dist/cjs/api/resources/sequences/types/GetStatsSequencesResponse.d.ts +1 -0
  33. package/dist/cjs/api/resources/websites/client/Client.d.ts +1 -1
  34. package/dist/cjs/api/resources/websites/client/Client.js +1 -1
  35. package/dist/cjs/api/types/BadRequestErrorBody.d.ts +3 -5
  36. package/dist/cjs/api/types/BadRequestErrorBodyPublicationsItem.d.ts +4 -0
  37. package/dist/cjs/api/types/BadRequestErrorBodyPublicationsItem.js +3 -0
  38. package/dist/cjs/api/types/Company.d.ts +1 -1
  39. package/dist/cjs/api/types/SequenceEnrollmentCancelResponse.d.ts +1 -1
  40. package/dist/cjs/api/types/SequenceEnrollmentGetResponseEnrollment.d.ts +6 -1
  41. package/dist/cjs/api/types/SequenceEnrollmentGetResponseEnrollmentStatus.d.ts +2 -0
  42. package/dist/cjs/api/types/SequenceEnrollmentGetResponseEnrollmentStatus.js +2 -0
  43. package/dist/cjs/api/types/SequenceEnrollmentListResponseEnrollmentsItem.d.ts +6 -1
  44. package/dist/cjs/api/types/SequenceEnrollmentListResponseEnrollmentsItemStatus.d.ts +2 -0
  45. package/dist/cjs/api/types/SequenceEnrollmentListResponseEnrollmentsItemStatus.js +2 -0
  46. package/dist/cjs/api/types/SequenceEnrollmentPauseItem.d.ts +16 -0
  47. package/dist/cjs/api/types/SequenceEnrollmentPauseItem.js +3 -0
  48. package/dist/cjs/api/types/SequenceEnrollmentPauseItemOutcome.d.ts +9 -0
  49. package/dist/cjs/api/types/SequenceEnrollmentPauseItemOutcome.js +12 -0
  50. package/dist/cjs/api/types/SequenceEnrollmentPauseItemStatus.d.ts +7 -0
  51. package/dist/cjs/api/types/SequenceEnrollmentPauseItemStatus.js +10 -0
  52. package/dist/cjs/api/types/SequenceEnrollmentPauseResponse.d.ts +9 -0
  53. package/dist/cjs/api/types/SequenceEnrollmentPauseResponse.js +3 -0
  54. package/dist/cjs/api/types/SequenceEnrollmentPauseResultBase.d.ts +11 -0
  55. package/dist/cjs/api/types/SequenceEnrollmentPauseResultBase.js +3 -0
  56. package/dist/cjs/api/types/SequenceEnrollmentPauseResultBaseNotEnrolledItem.d.ts +4 -0
  57. package/dist/cjs/api/types/SequenceEnrollmentPauseResultBaseNotEnrolledItem.js +3 -0
  58. package/dist/cjs/api/types/SequenceEnrollmentPauseResultBaseNotFound.d.ts +4 -0
  59. package/dist/cjs/api/types/SequenceEnrollmentPauseResultBaseNotFound.js +3 -0
  60. package/dist/cjs/api/types/SequenceEnrollmentResumeResponse.d.ts +13 -0
  61. package/dist/cjs/api/types/SequenceEnrollmentResumeResponse.js +3 -0
  62. package/dist/cjs/api/types/SequenceEnrollmentResumeResponseEnqueueErrorsItem.d.ts +4 -0
  63. package/dist/cjs/api/types/SequenceEnrollmentResumeResponseEnqueueErrorsItem.js +3 -0
  64. package/dist/cjs/api/types/SequencePausedEnrollmentCounts.d.ts +10 -0
  65. package/dist/cjs/api/types/SequencePausedEnrollmentCounts.js +3 -0
  66. package/dist/cjs/api/types/SequencePausedEnrollmentCountsByCurrentNodeItem.d.ts +6 -0
  67. package/dist/cjs/api/types/SequencePausedEnrollmentCountsByCurrentNodeItem.js +3 -0
  68. package/dist/cjs/api/types/SubscriberSequenceEnrollment.d.ts +1 -0
  69. package/dist/cjs/api/types/TransactionalMetricsResponseBounceBreakdown.d.ts +3 -0
  70. package/dist/cjs/api/types/index.d.ts +12 -0
  71. package/dist/cjs/api/types/index.js +12 -0
  72. package/dist/cjs/serialization/resources/analytics/types/GetSequenceMetricsResponse.d.ts +2 -0
  73. package/dist/cjs/serialization/resources/analytics/types/GetSequenceMetricsResponse.js +2 -0
  74. package/dist/cjs/serialization/resources/campaigns/types/CreateForAudienceCampaignsRequestSelectionActivityBounceType.d.ts +1 -1
  75. package/dist/cjs/serialization/resources/campaigns/types/CreateForAudienceCampaignsRequestSelectionActivityBounceType.js +1 -1
  76. package/dist/cjs/serialization/resources/emailSends/types/ListEmailSendsRequestBounceType.d.ts +1 -1
  77. package/dist/cjs/serialization/resources/emailSends/types/ListEmailSendsRequestBounceType.js +1 -1
  78. package/dist/cjs/serialization/resources/integrations/types/ConnectIntegrationsRequestProvider.d.ts +1 -1
  79. package/dist/cjs/serialization/resources/integrations/types/ConnectIntegrationsRequestProvider.js +1 -0
  80. package/dist/cjs/serialization/resources/integrations/types/ConnectIntegrationsRequestSettings.d.ts +1 -0
  81. package/dist/cjs/serialization/resources/integrations/types/ConnectIntegrationsRequestSettings.js +1 -0
  82. package/dist/cjs/serialization/resources/integrations/types/ConnectIntegrationsResponse.d.ts +2 -0
  83. package/dist/cjs/serialization/resources/integrations/types/ConnectIntegrationsResponse.js +2 -0
  84. package/dist/cjs/serialization/resources/integrations/types/ConnectIntegrationsResponsePublication.d.ts +10 -0
  85. package/dist/cjs/serialization/resources/integrations/types/ConnectIntegrationsResponsePublication.js +32 -0
  86. package/dist/cjs/serialization/resources/integrations/types/DisconnectIntegrationsResponseProvider.d.ts +1 -1
  87. package/dist/cjs/serialization/resources/integrations/types/DisconnectIntegrationsResponseProvider.js +1 -1
  88. package/dist/cjs/serialization/resources/integrations/types/index.d.ts +1 -0
  89. package/dist/cjs/serialization/resources/integrations/types/index.js +1 -0
  90. package/dist/cjs/serialization/resources/sequences/client/requests/SequenceEnrollmentPauseRequest.d.ts +11 -0
  91. package/dist/cjs/serialization/resources/sequences/client/requests/SequenceEnrollmentPauseRequest.js +33 -0
  92. package/dist/cjs/serialization/resources/sequences/client/requests/SequenceEnrollmentResumeRequest.d.ts +10 -0
  93. package/dist/cjs/serialization/resources/sequences/client/requests/SequenceEnrollmentResumeRequest.js +32 -0
  94. package/dist/cjs/serialization/resources/sequences/client/requests/index.d.ts +2 -0
  95. package/dist/cjs/serialization/resources/sequences/client/requests/index.js +5 -1
  96. package/dist/cjs/serialization/resources/sequences/types/GetStatsSequencesResponse.d.ts +2 -0
  97. package/dist/cjs/serialization/resources/sequences/types/GetStatsSequencesResponse.js +2 -0
  98. package/dist/cjs/serialization/types/BadRequestErrorBody.d.ts +4 -6
  99. package/dist/cjs/serialization/types/BadRequestErrorBody.js +7 -7
  100. package/dist/cjs/serialization/types/BadRequestErrorBodyPublicationsItem.d.ts +10 -0
  101. package/dist/cjs/serialization/types/BadRequestErrorBodyPublicationsItem.js +32 -0
  102. package/dist/cjs/serialization/types/SequenceEnrollmentGetResponseEnrollment.d.ts +2 -0
  103. package/dist/cjs/serialization/types/SequenceEnrollmentGetResponseEnrollment.js +2 -0
  104. package/dist/cjs/serialization/types/SequenceEnrollmentGetResponseEnrollmentStatus.d.ts +1 -1
  105. package/dist/cjs/serialization/types/SequenceEnrollmentGetResponseEnrollmentStatus.js +1 -1
  106. package/dist/cjs/serialization/types/SequenceEnrollmentListResponseEnrollmentsItem.d.ts +2 -0
  107. package/dist/cjs/serialization/types/SequenceEnrollmentListResponseEnrollmentsItem.js +2 -0
  108. package/dist/cjs/serialization/types/SequenceEnrollmentListResponseEnrollmentsItemStatus.d.ts +1 -1
  109. package/dist/cjs/serialization/types/SequenceEnrollmentListResponseEnrollmentsItemStatus.js +1 -1
  110. package/dist/cjs/serialization/types/SequenceEnrollmentPauseItem.d.ts +18 -0
  111. package/dist/cjs/serialization/types/SequenceEnrollmentPauseItem.js +40 -0
  112. package/dist/cjs/serialization/types/SequenceEnrollmentPauseItemOutcome.d.ts +7 -0
  113. package/dist/cjs/serialization/types/SequenceEnrollmentPauseItemOutcome.js +29 -0
  114. package/dist/cjs/serialization/types/SequenceEnrollmentPauseItemStatus.d.ts +7 -0
  115. package/dist/cjs/serialization/types/SequenceEnrollmentPauseItemStatus.js +29 -0
  116. package/dist/cjs/serialization/types/SequenceEnrollmentPauseResponse.d.ts +12 -0
  117. package/dist/cjs/serialization/types/SequenceEnrollmentPauseResponse.js +36 -0
  118. package/dist/cjs/serialization/types/SequenceEnrollmentPauseResultBase.d.ts +17 -0
  119. package/dist/cjs/serialization/types/SequenceEnrollmentPauseResultBase.js +39 -0
  120. package/dist/cjs/serialization/types/SequenceEnrollmentPauseResultBaseNotEnrolledItem.d.ts +10 -0
  121. package/dist/cjs/serialization/types/SequenceEnrollmentPauseResultBaseNotEnrolledItem.js +32 -0
  122. package/dist/cjs/serialization/types/SequenceEnrollmentPauseResultBaseNotFound.d.ts +10 -0
  123. package/dist/cjs/serialization/types/SequenceEnrollmentPauseResultBaseNotFound.js +32 -0
  124. package/dist/cjs/serialization/types/SequenceEnrollmentResumeResponse.d.ts +15 -0
  125. package/dist/cjs/serialization/types/SequenceEnrollmentResumeResponse.js +39 -0
  126. package/dist/cjs/serialization/types/SequenceEnrollmentResumeResponseEnqueueErrorsItem.d.ts +10 -0
  127. package/dist/cjs/serialization/types/SequenceEnrollmentResumeResponseEnqueueErrorsItem.js +32 -0
  128. package/dist/cjs/serialization/types/SequencePausedEnrollmentCounts.d.ts +11 -0
  129. package/dist/cjs/serialization/types/SequencePausedEnrollmentCounts.js +33 -0
  130. package/dist/cjs/serialization/types/SequencePausedEnrollmentCountsByCurrentNodeItem.d.ts +11 -0
  131. package/dist/cjs/serialization/types/SequencePausedEnrollmentCountsByCurrentNodeItem.js +33 -0
  132. package/dist/cjs/serialization/types/TransactionalMetricsResponseBounceBreakdown.d.ts +1 -0
  133. package/dist/cjs/serialization/types/TransactionalMetricsResponseBounceBreakdown.js +1 -0
  134. package/dist/cjs/serialization/types/index.d.ts +12 -0
  135. package/dist/cjs/serialization/types/index.js +12 -0
  136. package/dist/esm/api/resources/analytics/types/GetSequenceMetricsResponse.d.ts +1 -0
  137. package/dist/esm/api/resources/campaigns/types/CreateForAudienceCampaignsRequestSelectionActivity.d.ts +1 -1
  138. package/dist/esm/api/resources/campaigns/types/CreateForAudienceCampaignsRequestSelectionActivityBounceType.d.ts +3 -1
  139. package/dist/esm/api/resources/campaigns/types/CreateForAudienceCampaignsRequestSelectionActivityBounceType.js +3 -1
  140. package/dist/esm/api/resources/emailSends/client/requests/ListEmailSendsRequest.d.ts +1 -0
  141. package/dist/esm/api/resources/emailSends/types/ListEmailSendsRequestBounceType.d.ts +2 -0
  142. package/dist/esm/api/resources/emailSends/types/ListEmailSendsRequestBounceType.js +2 -0
  143. package/dist/esm/api/resources/integrations/client/Client.d.ts +3 -2
  144. package/dist/esm/api/resources/integrations/client/Client.js +5 -2
  145. package/dist/esm/api/resources/integrations/client/requests/ConnectIntegrationsRequest.d.ts +4 -4
  146. package/dist/esm/api/resources/integrations/client/requests/DisconnectIntegrationsRequest.d.ts +1 -1
  147. package/dist/esm/api/resources/integrations/types/ConnectIntegrationsRequestProvider.d.ts +1 -0
  148. package/dist/esm/api/resources/integrations/types/ConnectIntegrationsRequestProvider.js +1 -0
  149. package/dist/esm/api/resources/integrations/types/ConnectIntegrationsRequestSettings.d.ts +3 -1
  150. package/dist/esm/api/resources/integrations/types/ConnectIntegrationsResponse.d.ts +3 -1
  151. package/dist/esm/api/resources/integrations/types/ConnectIntegrationsResponsePublication.d.ts +7 -0
  152. package/dist/esm/api/resources/integrations/types/ConnectIntegrationsResponsePublication.js +2 -0
  153. package/dist/esm/api/resources/integrations/types/DisconnectIntegrationsResponse.d.ts +1 -1
  154. package/dist/esm/api/resources/integrations/types/DisconnectIntegrationsResponseProvider.d.ts +1 -0
  155. package/dist/esm/api/resources/integrations/types/DisconnectIntegrationsResponseProvider.js +1 -0
  156. package/dist/esm/api/resources/integrations/types/index.d.ts +1 -0
  157. package/dist/esm/api/resources/integrations/types/index.js +1 -0
  158. package/dist/esm/api/resources/sequences/client/Client.d.ts +52 -3
  159. package/dist/esm/api/resources/sequences/client/Client.js +164 -3
  160. package/dist/esm/api/resources/sequences/client/requests/ListEnrollmentsSequencesRequest.d.ts +1 -1
  161. package/dist/esm/api/resources/sequences/client/requests/SequenceEnrollmentCancelRequest.d.ts +1 -1
  162. package/dist/esm/api/resources/sequences/client/requests/SequenceEnrollmentPauseRequest.d.ts +24 -0
  163. package/dist/esm/api/resources/sequences/client/requests/SequenceEnrollmentPauseRequest.js +2 -0
  164. package/dist/esm/api/resources/sequences/client/requests/SequenceEnrollmentResumeRequest.d.ts +15 -0
  165. package/dist/esm/api/resources/sequences/client/requests/SequenceEnrollmentResumeRequest.js +2 -0
  166. package/dist/esm/api/resources/sequences/client/requests/index.d.ts +2 -0
  167. package/dist/esm/api/resources/sequences/types/GetStatsSequencesResponse.d.ts +1 -0
  168. package/dist/esm/api/resources/websites/client/Client.d.ts +1 -1
  169. package/dist/esm/api/resources/websites/client/Client.js +1 -1
  170. package/dist/esm/api/types/BadRequestErrorBody.d.ts +3 -5
  171. package/dist/esm/api/types/BadRequestErrorBodyPublicationsItem.d.ts +4 -0
  172. package/dist/esm/api/types/BadRequestErrorBodyPublicationsItem.js +2 -0
  173. package/dist/esm/api/types/Company.d.ts +1 -1
  174. package/dist/esm/api/types/SequenceEnrollmentCancelResponse.d.ts +1 -1
  175. package/dist/esm/api/types/SequenceEnrollmentGetResponseEnrollment.d.ts +6 -1
  176. package/dist/esm/api/types/SequenceEnrollmentGetResponseEnrollmentStatus.d.ts +2 -0
  177. package/dist/esm/api/types/SequenceEnrollmentGetResponseEnrollmentStatus.js +2 -0
  178. package/dist/esm/api/types/SequenceEnrollmentListResponseEnrollmentsItem.d.ts +6 -1
  179. package/dist/esm/api/types/SequenceEnrollmentListResponseEnrollmentsItemStatus.d.ts +2 -0
  180. package/dist/esm/api/types/SequenceEnrollmentListResponseEnrollmentsItemStatus.js +2 -0
  181. package/dist/esm/api/types/SequenceEnrollmentPauseItem.d.ts +16 -0
  182. package/dist/esm/api/types/SequenceEnrollmentPauseItem.js +2 -0
  183. package/dist/esm/api/types/SequenceEnrollmentPauseItemOutcome.d.ts +9 -0
  184. package/dist/esm/api/types/SequenceEnrollmentPauseItemOutcome.js +9 -0
  185. package/dist/esm/api/types/SequenceEnrollmentPauseItemStatus.d.ts +7 -0
  186. package/dist/esm/api/types/SequenceEnrollmentPauseItemStatus.js +7 -0
  187. package/dist/esm/api/types/SequenceEnrollmentPauseResponse.d.ts +9 -0
  188. package/dist/esm/api/types/SequenceEnrollmentPauseResponse.js +2 -0
  189. package/dist/esm/api/types/SequenceEnrollmentPauseResultBase.d.ts +11 -0
  190. package/dist/esm/api/types/SequenceEnrollmentPauseResultBase.js +2 -0
  191. package/dist/esm/api/types/SequenceEnrollmentPauseResultBaseNotEnrolledItem.d.ts +4 -0
  192. package/dist/esm/api/types/SequenceEnrollmentPauseResultBaseNotEnrolledItem.js +2 -0
  193. package/dist/esm/api/types/SequenceEnrollmentPauseResultBaseNotFound.d.ts +4 -0
  194. package/dist/esm/api/types/SequenceEnrollmentPauseResultBaseNotFound.js +2 -0
  195. package/dist/esm/api/types/SequenceEnrollmentResumeResponse.d.ts +13 -0
  196. package/dist/esm/api/types/SequenceEnrollmentResumeResponse.js +2 -0
  197. package/dist/esm/api/types/SequenceEnrollmentResumeResponseEnqueueErrorsItem.d.ts +4 -0
  198. package/dist/esm/api/types/SequenceEnrollmentResumeResponseEnqueueErrorsItem.js +2 -0
  199. package/dist/esm/api/types/SequencePausedEnrollmentCounts.d.ts +10 -0
  200. package/dist/esm/api/types/SequencePausedEnrollmentCounts.js +2 -0
  201. package/dist/esm/api/types/SequencePausedEnrollmentCountsByCurrentNodeItem.d.ts +6 -0
  202. package/dist/esm/api/types/SequencePausedEnrollmentCountsByCurrentNodeItem.js +2 -0
  203. package/dist/esm/api/types/SubscriberSequenceEnrollment.d.ts +1 -0
  204. package/dist/esm/api/types/TransactionalMetricsResponseBounceBreakdown.d.ts +3 -0
  205. package/dist/esm/api/types/index.d.ts +12 -0
  206. package/dist/esm/api/types/index.js +12 -0
  207. package/dist/esm/serialization/resources/analytics/types/GetSequenceMetricsResponse.d.ts +2 -0
  208. package/dist/esm/serialization/resources/analytics/types/GetSequenceMetricsResponse.js +2 -0
  209. package/dist/esm/serialization/resources/campaigns/types/CreateForAudienceCampaignsRequestSelectionActivityBounceType.d.ts +1 -1
  210. package/dist/esm/serialization/resources/campaigns/types/CreateForAudienceCampaignsRequestSelectionActivityBounceType.js +1 -1
  211. package/dist/esm/serialization/resources/emailSends/types/ListEmailSendsRequestBounceType.d.ts +1 -1
  212. package/dist/esm/serialization/resources/emailSends/types/ListEmailSendsRequestBounceType.js +1 -1
  213. package/dist/esm/serialization/resources/integrations/types/ConnectIntegrationsRequestProvider.d.ts +1 -1
  214. package/dist/esm/serialization/resources/integrations/types/ConnectIntegrationsRequestProvider.js +1 -0
  215. package/dist/esm/serialization/resources/integrations/types/ConnectIntegrationsRequestSettings.d.ts +1 -0
  216. package/dist/esm/serialization/resources/integrations/types/ConnectIntegrationsRequestSettings.js +1 -0
  217. package/dist/esm/serialization/resources/integrations/types/ConnectIntegrationsResponse.d.ts +2 -0
  218. package/dist/esm/serialization/resources/integrations/types/ConnectIntegrationsResponse.js +2 -0
  219. package/dist/esm/serialization/resources/integrations/types/ConnectIntegrationsResponsePublication.d.ts +10 -0
  220. package/dist/esm/serialization/resources/integrations/types/ConnectIntegrationsResponsePublication.js +6 -0
  221. package/dist/esm/serialization/resources/integrations/types/DisconnectIntegrationsResponseProvider.d.ts +1 -1
  222. package/dist/esm/serialization/resources/integrations/types/DisconnectIntegrationsResponseProvider.js +1 -1
  223. package/dist/esm/serialization/resources/integrations/types/index.d.ts +1 -0
  224. package/dist/esm/serialization/resources/integrations/types/index.js +1 -0
  225. package/dist/esm/serialization/resources/sequences/client/requests/SequenceEnrollmentPauseRequest.d.ts +11 -0
  226. package/dist/esm/serialization/resources/sequences/client/requests/SequenceEnrollmentPauseRequest.js +7 -0
  227. package/dist/esm/serialization/resources/sequences/client/requests/SequenceEnrollmentResumeRequest.d.ts +10 -0
  228. package/dist/esm/serialization/resources/sequences/client/requests/SequenceEnrollmentResumeRequest.js +6 -0
  229. package/dist/esm/serialization/resources/sequences/client/requests/index.d.ts +2 -0
  230. package/dist/esm/serialization/resources/sequences/client/requests/index.js +2 -0
  231. package/dist/esm/serialization/resources/sequences/types/GetStatsSequencesResponse.d.ts +2 -0
  232. package/dist/esm/serialization/resources/sequences/types/GetStatsSequencesResponse.js +2 -0
  233. package/dist/esm/serialization/types/BadRequestErrorBody.d.ts +4 -6
  234. package/dist/esm/serialization/types/BadRequestErrorBody.js +7 -7
  235. package/dist/esm/serialization/types/BadRequestErrorBodyPublicationsItem.d.ts +10 -0
  236. package/dist/esm/serialization/types/BadRequestErrorBodyPublicationsItem.js +6 -0
  237. package/dist/esm/serialization/types/SequenceEnrollmentGetResponseEnrollment.d.ts +2 -0
  238. package/dist/esm/serialization/types/SequenceEnrollmentGetResponseEnrollment.js +2 -0
  239. package/dist/esm/serialization/types/SequenceEnrollmentGetResponseEnrollmentStatus.d.ts +1 -1
  240. package/dist/esm/serialization/types/SequenceEnrollmentGetResponseEnrollmentStatus.js +1 -1
  241. package/dist/esm/serialization/types/SequenceEnrollmentListResponseEnrollmentsItem.d.ts +2 -0
  242. package/dist/esm/serialization/types/SequenceEnrollmentListResponseEnrollmentsItem.js +2 -0
  243. package/dist/esm/serialization/types/SequenceEnrollmentListResponseEnrollmentsItemStatus.d.ts +1 -1
  244. package/dist/esm/serialization/types/SequenceEnrollmentListResponseEnrollmentsItemStatus.js +1 -1
  245. package/dist/esm/serialization/types/SequenceEnrollmentPauseItem.d.ts +18 -0
  246. package/dist/esm/serialization/types/SequenceEnrollmentPauseItem.js +14 -0
  247. package/dist/esm/serialization/types/SequenceEnrollmentPauseItemOutcome.d.ts +7 -0
  248. package/dist/esm/serialization/types/SequenceEnrollmentPauseItemOutcome.js +3 -0
  249. package/dist/esm/serialization/types/SequenceEnrollmentPauseItemStatus.d.ts +7 -0
  250. package/dist/esm/serialization/types/SequenceEnrollmentPauseItemStatus.js +3 -0
  251. package/dist/esm/serialization/types/SequenceEnrollmentPauseResponse.d.ts +12 -0
  252. package/dist/esm/serialization/types/SequenceEnrollmentPauseResponse.js +10 -0
  253. package/dist/esm/serialization/types/SequenceEnrollmentPauseResultBase.d.ts +17 -0
  254. package/dist/esm/serialization/types/SequenceEnrollmentPauseResultBase.js +13 -0
  255. package/dist/esm/serialization/types/SequenceEnrollmentPauseResultBaseNotEnrolledItem.d.ts +10 -0
  256. package/dist/esm/serialization/types/SequenceEnrollmentPauseResultBaseNotEnrolledItem.js +6 -0
  257. package/dist/esm/serialization/types/SequenceEnrollmentPauseResultBaseNotFound.d.ts +10 -0
  258. package/dist/esm/serialization/types/SequenceEnrollmentPauseResultBaseNotFound.js +6 -0
  259. package/dist/esm/serialization/types/SequenceEnrollmentResumeResponse.d.ts +15 -0
  260. package/dist/esm/serialization/types/SequenceEnrollmentResumeResponse.js +13 -0
  261. package/dist/esm/serialization/types/SequenceEnrollmentResumeResponseEnqueueErrorsItem.d.ts +10 -0
  262. package/dist/esm/serialization/types/SequenceEnrollmentResumeResponseEnqueueErrorsItem.js +6 -0
  263. package/dist/esm/serialization/types/SequencePausedEnrollmentCounts.d.ts +11 -0
  264. package/dist/esm/serialization/types/SequencePausedEnrollmentCounts.js +7 -0
  265. package/dist/esm/serialization/types/SequencePausedEnrollmentCountsByCurrentNodeItem.d.ts +11 -0
  266. package/dist/esm/serialization/types/SequencePausedEnrollmentCountsByCurrentNodeItem.js +7 -0
  267. package/dist/esm/serialization/types/TransactionalMetricsResponseBounceBreakdown.d.ts +1 -0
  268. package/dist/esm/serialization/types/TransactionalMetricsResponseBounceBreakdown.js +1 -0
  269. package/dist/esm/serialization/types/index.d.ts +12 -0
  270. package/dist/esm/serialization/types/index.js +12 -0
  271. package/package.json +1 -1
@@ -15,4 +15,5 @@ export const ConnectIntegrationsRequestProvider = {
15
15
  Segment: "segment",
16
16
  Affonso: "affonso",
17
17
  Attio: "attio",
18
+ Sparkloop: "sparkloop",
18
19
  };
@@ -1,8 +1,10 @@
1
1
  /**
2
- * PostHog and Segment: event delivery scope. Attio: listMap (Sequenzy list id to Attio list id or slug) and syncCompanyFromDomain.
2
+ * PostHog and Segment: event delivery scope. Attio: listMap (Sequenzy list id to Attio list id or slug) and syncCompanyFromDomain. SparkLoop: listIds for new referrals.
3
3
  */
4
4
  export interface ConnectIntegrationsRequestSettings {
5
5
  eventAllowlist?: string[];
6
+ /** SparkLoop only. Lists new referrals join. Omit to keep the current choice (the workspace default lists on a first connect), null to reset to the workspace default lists, or an empty array for none. */
7
+ listIds?: string[] | null;
6
8
  /** Attio only. Sequenzy list id to Attio list UUID or slug. */
7
9
  listMap?: Record<string, string>;
8
10
  syncAllEvents?: boolean;
@@ -5,6 +5,8 @@ export interface ConnectIntegrationsResponse {
5
5
  /** PostHog and Segment only. Outcome of the optional history import request. */
6
6
  history?: Sequenzy.ConnectIntegrationsResponseHistory;
7
7
  integration?: Sequenzy.IntegrationSummary;
8
+ /** SparkLoop only. The publication whose partner referrals this workspace receives. */
9
+ publication?: Sequenzy.ConnectIntegrationsResponsePublication;
8
10
  /** Payment providers only. Whether the initial revenue backfill was queued. */
9
11
  revenueSyncQueued?: boolean;
10
12
  success?: boolean;
@@ -12,6 +14,6 @@ export interface ConnectIntegrationsResponse {
12
14
  testMode?: boolean;
13
15
  /** Lemon Squeezy only. Whether Sequenzy manages the provider webhook. */
14
16
  webhookProvisioning?: Sequenzy.ConnectIntegrationsResponseWebhookProvisioning;
15
- /** Provider webhook URL. Lemon Squeezy managed mode installs it automatically; manual mode uses the supplied secret. Empty for Attio. */
17
+ /** Provider webhook URL. Lemon Squeezy managed mode installs it automatically; manual mode uses the supplied secret. SparkLoop's is already registered in SparkLoop. Empty for Attio. */
16
18
  webhookUrl?: string;
17
19
  }
@@ -0,0 +1,7 @@
1
+ /**
2
+ * SparkLoop only. The publication whose partner referrals this workspace receives.
3
+ */
4
+ export interface ConnectIntegrationsResponsePublication {
5
+ id?: string;
6
+ name?: string;
7
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -1,6 +1,6 @@
1
1
  import type * as Sequenzy from "../../../index.js";
2
2
  export interface DisconnectIntegrationsResponse {
3
- /** Null when cleanup succeeded or no managed webhook exists. Otherwise repeat disconnect to retry provider cleanup. */
3
+ /** Null when cleanup succeeded or no managed webhook exists. Otherwise repeat disconnect to retry Lemon Squeezy cleanup, or delete the SparkLoop webhook in SparkLoop. */
4
4
  cleanupWarning: string | null;
5
5
  integrationId: string;
6
6
  message: string;
@@ -1,4 +1,5 @@
1
1
  export declare const DisconnectIntegrationsResponseProvider: {
2
2
  readonly LemonSqueezy: "lemon_squeezy";
3
+ readonly Sparkloop: "sparkloop";
3
4
  };
4
5
  export type DisconnectIntegrationsResponseProvider = (typeof DisconnectIntegrationsResponseProvider)[keyof typeof DisconnectIntegrationsResponseProvider];
@@ -1,4 +1,5 @@
1
1
  // This file was auto-generated by Fern from our API Definition.
2
2
  export const DisconnectIntegrationsResponseProvider = {
3
3
  LemonSqueezy: "lemon_squeezy",
4
+ Sparkloop: "sparkloop",
4
5
  };
@@ -5,6 +5,7 @@ export * from "./ConnectIntegrationsRequestProvider.js";
5
5
  export * from "./ConnectIntegrationsRequestSettings.js";
6
6
  export * from "./ConnectIntegrationsResponse.js";
7
7
  export * from "./ConnectIntegrationsResponseHistory.js";
8
+ export * from "./ConnectIntegrationsResponsePublication.js";
8
9
  export * from "./ConnectIntegrationsResponseWebhookProvisioning.js";
9
10
  export * from "./DisconnectIntegrationsResponse.js";
10
11
  export * from "./DisconnectIntegrationsResponseProvider.js";
@@ -5,6 +5,7 @@ export * from "./ConnectIntegrationsRequestProvider.js";
5
5
  export * from "./ConnectIntegrationsRequestSettings.js";
6
6
  export * from "./ConnectIntegrationsResponse.js";
7
7
  export * from "./ConnectIntegrationsResponseHistory.js";
8
+ export * from "./ConnectIntegrationsResponsePublication.js";
8
9
  export * from "./ConnectIntegrationsResponseWebhookProvisioning.js";
9
10
  export * from "./DisconnectIntegrationsResponse.js";
10
11
  export * from "./DisconnectIntegrationsResponseProvider.js";
@@ -48,7 +48,7 @@ export declare class SequencesClient {
48
48
  cancelAudienceEnrollment(request: Sequenzy.CancelAudienceEnrollmentSequencesRequest, requestOptions?: SequencesClient.RequestOptions): core.HttpResponsePromise<Sequenzy.CancelAudienceEnrollmentSequencesResponse>;
49
49
  private __cancelAudienceEnrollment;
50
50
  /**
51
- * Cancels active or waiting enrollments in one sequence. Target every enrollment with cancelAll, a batch with subscriberIds, one contact with subscriberId, or matching stored entry event property values with fieldValues. Bulk cancellation is capped at 1000 enrollments per request; repeat the request while remainingCount is above zero.
51
+ * Cancels active, waiting, or paused enrollments in one sequence. Target every enrollment with cancelAll, a batch with subscriberIds, one contact with subscriberId, or matching stored entry event property values with fieldValues. Bulk cancellation is capped at 1000 enrollments per request; repeat the request while remainingCount is above zero.
52
52
  *
53
53
  * @param {Sequenzy.SequenceEnrollmentCancelRequest} request
54
54
  * @param {SequencesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -439,7 +439,7 @@ export declare class SequencesClient {
439
439
  enable(request: Sequenzy.EnableSequencesRequest, requestOptions?: SequencesClient.RequestOptions): core.HttpResponsePromise<Sequenzy.SequenceActionResponse>;
440
440
  private __enable;
441
441
  /**
442
- * Starts a background run that enrolls every active contact matching the audience (everyone, lists, a segment, a filter, or rules) into the sequence, in batches, with no per-request cap. Contacts already active or waiting in the sequence are skipped; one_time sequences also skip contacts who completed or were cancelled before; unsubscribed and bounced contacts are never enrolled. Only one run per sequence can be queued or running at a time. The sequence must be enabled and accepting entrants. This is how a manual-trigger countdown sequence gets its audience; late enrollees skip the steps whose key date already passed.
442
+ * Starts a background run that enrolls every active contact matching the audience (everyone, lists, a segment, a filter, or rules) into the sequence, in batches, with no per-request cap. Contacts already active, waiting, or paused in the sequence are skipped; one_time sequences also skip contacts who completed or were cancelled before; unsubscribed and bounced contacts are never enrolled. Only one run per sequence can be queued or running at a time. The sequence must be enabled and accepting entrants. This is how a manual-trigger countdown sequence gets its audience; late enrollees skip the steps whose key date already passed.
443
443
  *
444
444
  * @param {Sequenzy.EnrollAudienceSequencesRequest} request
445
445
  * @param {SequencesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -748,7 +748,7 @@ export declare class SequencesClient {
748
748
  listEmailVariations(request: Sequenzy.ListEmailVariationsSequencesRequest, requestOptions?: SequencesClient.RequestOptions): core.HttpResponsePromise<Sequenzy.ListEmailVariationsSequencesResponse>;
749
749
  private __listEmailVariations;
750
750
  /**
751
- * Lists the individual contacts enrolled in one sequence, with the node each one is currently sitting on. Defaults to active and waiting enrollments. Use this when sequence stats give you enrollmentCounts and you need the actual subscribers behind a number.
751
+ * Lists the individual contacts enrolled in one sequence, with the node each one is currently sitting on. Defaults to active, waiting, and paused enrollments, which is everyone still in the sequence. Use this when sequence stats give you enrollmentCounts and you need the actual subscribers behind a number.
752
752
  *
753
753
  * @param {Sequenzy.ListEnrollmentsSequencesRequest} request
754
754
  * @param {SequencesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -844,6 +844,34 @@ export declare class SequencesClient {
844
844
  */
845
845
  pauseEnrollments(request: Sequenzy.PauseEnrollmentsSequencesRequest, requestOptions?: SequencesClient.RequestOptions): core.HttpResponsePromise<Sequenzy.SequenceActionResponse>;
846
846
  private __pauseEnrollments;
847
+ /**
848
+ * Holds specific contacts on the sequence step they are on. A paused enrollment gets no further steps, keeps its entry event properties and stop-condition snapshots, and still counts as enrolled, so the same contact cannot enter this sequence again while paused. Unsubscribes, bounces, and enrollment cancellation still end it. A wait-for-event step does not react while paused; an event that arrived meanwhile is picked up on resume. Applies immediately with no dry run. An enrollment whose current step is running at that moment is left alone with outcome in_progress; repeat the request shortly. To stop new contacts entering the whole sequence instead, use POST /sequences/{sequenceId}/pause-enrollments.
849
+ *
850
+ * @param {Sequenzy.SequenceEnrollmentPauseRequest} request
851
+ * @param {SequencesClient.RequestOptions} requestOptions - Request-specific configuration.
852
+ *
853
+ * @throws {@link Sequenzy.BadRequestError}
854
+ * @throws {@link Sequenzy.UnauthorizedError}
855
+ * @throws {@link Sequenzy.ForbiddenError}
856
+ * @throws {@link Sequenzy.NotFoundError}
857
+ * @throws {@link errors.SequenzyError}
858
+ * @throws {@link errors.SequenzyTimeoutError}
859
+ *
860
+ * @example
861
+ * await client.sequences.pauseSubscribers({
862
+ * sequenceId: "sequenceId",
863
+ * emails: ["ada@example.com"],
864
+ * reason: "Project blocked"
865
+ * })
866
+ *
867
+ * @example
868
+ * await client.sequences.pauseSubscribers({
869
+ * sequenceId: "sequenceId",
870
+ * subscriberIds: ["sub_abc123", "sub_def456"]
871
+ * })
872
+ */
873
+ pauseSubscribers(request: Sequenzy.SequenceEnrollmentPauseRequest, requestOptions?: SequencesClient.RequestOptions): core.HttpResponsePromise<Sequenzy.SequenceEnrollmentPauseResponse>;
874
+ private __pauseSubscribers;
847
875
  /**
848
876
  * Rewrites the first 3 emails of a public gallery sequence for your brand, or for another `website`, and returns them without creating anything. Emails that could not be written are counted in `failedEmailCount`; the call fails only when none could be written. Usually takes 10 to 30 seconds. Requires `sequences:write`.
849
877
  *
@@ -940,6 +968,27 @@ export declare class SequencesClient {
940
968
  */
941
969
  resumeEnrollments(request: Sequenzy.ResumeEnrollmentsSequencesRequest, requestOptions?: SequencesClient.RequestOptions): core.HttpResponsePromise<Sequenzy.SequenceActionResponse>;
942
970
  private __resumeEnrollments;
971
+ /**
972
+ * Continues paused contacts from the step they were paused on, with the status they had. Nothing restarts or is skipped. Waits keep their original wall-clock time, like a whole-sequence pause - a wait that ran out while paused continues right away, and one that has not still ends when it would have. Enrollments of the targeted contacts that are not paused are reported with outcome not_paused and left alone. When the sequence itself is disabled, sequenceRunning is false and the resumed contacts continue once it is enabled.
973
+ *
974
+ * @param {Sequenzy.SequenceEnrollmentResumeRequest} request
975
+ * @param {SequencesClient.RequestOptions} requestOptions - Request-specific configuration.
976
+ *
977
+ * @throws {@link Sequenzy.BadRequestError}
978
+ * @throws {@link Sequenzy.UnauthorizedError}
979
+ * @throws {@link Sequenzy.ForbiddenError}
980
+ * @throws {@link Sequenzy.NotFoundError}
981
+ * @throws {@link errors.SequenzyError}
982
+ * @throws {@link errors.SequenzyTimeoutError}
983
+ *
984
+ * @example
985
+ * await client.sequences.resumeSubscribers({
986
+ * sequenceId: "sequenceId",
987
+ * emails: ["ada@example.com"]
988
+ * })
989
+ */
990
+ resumeSubscribers(request: Sequenzy.SequenceEnrollmentResumeRequest, requestOptions?: SequencesClient.RequestOptions): core.HttpResponsePromise<Sequenzy.SequenceEnrollmentResumeResponse>;
991
+ private __resumeSubscribers;
943
992
  /**
944
993
  * Immediately invalidates the previous URL and returns the replacement endpoint.
945
994
  *
@@ -142,7 +142,7 @@ export class SequencesClient {
142
142
  return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/sequences/{sequenceId}/audience-enrollments/{runId}/cancel");
143
143
  }
144
144
  /**
145
- * Cancels active or waiting enrollments in one sequence. Target every enrollment with cancelAll, a batch with subscriberIds, one contact with subscriberId, or matching stored entry event property values with fieldValues. Bulk cancellation is capped at 1000 enrollments per request; repeat the request while remainingCount is above zero.
145
+ * Cancels active, waiting, or paused enrollments in one sequence. Target every enrollment with cancelAll, a batch with subscriberIds, one contact with subscriberId, or matching stored entry event property values with fieldValues. Bulk cancellation is capped at 1000 enrollments per request; repeat the request while remainingCount is above zero.
146
146
  *
147
147
  * @param {Sequenzy.SequenceEnrollmentCancelRequest} request
148
148
  * @param {SequencesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -1231,7 +1231,7 @@ export class SequencesClient {
1231
1231
  return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/sequences/{sequenceId}/enable");
1232
1232
  }
1233
1233
  /**
1234
- * Starts a background run that enrolls every active contact matching the audience (everyone, lists, a segment, a filter, or rules) into the sequence, in batches, with no per-request cap. Contacts already active or waiting in the sequence are skipped; one_time sequences also skip contacts who completed or were cancelled before; unsubscribed and bounced contacts are never enrolled. Only one run per sequence can be queued or running at a time. The sequence must be enabled and accepting entrants. This is how a manual-trigger countdown sequence gets its audience; late enrollees skip the steps whose key date already passed.
1234
+ * Starts a background run that enrolls every active contact matching the audience (everyone, lists, a segment, a filter, or rules) into the sequence, in batches, with no per-request cap. Contacts already active, waiting, or paused in the sequence are skipped; one_time sequences also skip contacts who completed or were cancelled before; unsubscribed and bounced contacts are never enrolled. Only one run per sequence can be queued or running at a time. The sequence must be enabled and accepting entrants. This is how a manual-trigger countdown sequence gets its audience; late enrollees skip the steps whose key date already passed.
1235
1235
  *
1236
1236
  * @param {Sequenzy.EnrollAudienceSequencesRequest} request
1237
1237
  * @param {SequencesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -2350,7 +2350,7 @@ export class SequencesClient {
2350
2350
  return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/sequences/{sequenceId}/emails/{emailId}/variations");
2351
2351
  }
2352
2352
  /**
2353
- * Lists the individual contacts enrolled in one sequence, with the node each one is currently sitting on. Defaults to active and waiting enrollments. Use this when sequence stats give you enrollmentCounts and you need the actual subscribers behind a number.
2353
+ * Lists the individual contacts enrolled in one sequence, with the node each one is currently sitting on. Defaults to active, waiting, and paused enrollments, which is everyone still in the sequence. Use this when sequence stats give you enrollmentCounts and you need the actual subscribers behind a number.
2354
2354
  *
2355
2355
  * @param {Sequenzy.ListEnrollmentsSequencesRequest} request
2356
2356
  * @param {SequencesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -2669,6 +2669,90 @@ export class SequencesClient {
2669
2669
  }
2670
2670
  return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/sequences/{sequenceId}/pause-enrollments");
2671
2671
  }
2672
+ /**
2673
+ * Holds specific contacts on the sequence step they are on. A paused enrollment gets no further steps, keeps its entry event properties and stop-condition snapshots, and still counts as enrolled, so the same contact cannot enter this sequence again while paused. Unsubscribes, bounces, and enrollment cancellation still end it. A wait-for-event step does not react while paused; an event that arrived meanwhile is picked up on resume. Applies immediately with no dry run. An enrollment whose current step is running at that moment is left alone with outcome in_progress; repeat the request shortly. To stop new contacts entering the whole sequence instead, use POST /sequences/{sequenceId}/pause-enrollments.
2674
+ *
2675
+ * @param {Sequenzy.SequenceEnrollmentPauseRequest} request
2676
+ * @param {SequencesClient.RequestOptions} requestOptions - Request-specific configuration.
2677
+ *
2678
+ * @throws {@link Sequenzy.BadRequestError}
2679
+ * @throws {@link Sequenzy.UnauthorizedError}
2680
+ * @throws {@link Sequenzy.ForbiddenError}
2681
+ * @throws {@link Sequenzy.NotFoundError}
2682
+ * @throws {@link errors.SequenzyError}
2683
+ * @throws {@link errors.SequenzyTimeoutError}
2684
+ *
2685
+ * @example
2686
+ * await client.sequences.pauseSubscribers({
2687
+ * sequenceId: "sequenceId",
2688
+ * emails: ["ada@example.com"],
2689
+ * reason: "Project blocked"
2690
+ * })
2691
+ *
2692
+ * @example
2693
+ * await client.sequences.pauseSubscribers({
2694
+ * sequenceId: "sequenceId",
2695
+ * subscriberIds: ["sub_abc123", "sub_def456"]
2696
+ * })
2697
+ */
2698
+ pauseSubscribers(request, requestOptions) {
2699
+ return core.HttpResponsePromise.fromPromise(this.__pauseSubscribers(request, requestOptions));
2700
+ }
2701
+ async __pauseSubscribers(request, requestOptions) {
2702
+ const { sequenceId, ..._body } = request;
2703
+ const _authRequest = await this._options.authProvider.getAuthRequest();
2704
+ const _headers = mergeHeaders(_authRequest.headers, this._options?.headers, requestOptions?.headers);
2705
+ const _response = await core.fetcher({
2706
+ url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
2707
+ (await core.Supplier.get(this._options.environment)) ??
2708
+ environments.SequenzyEnvironment.Default, `sequences/${core.url.encodePathParam(sequenceId)}/enrollments/pause`),
2709
+ method: "POST",
2710
+ headers: _headers,
2711
+ contentType: "application/json",
2712
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
2713
+ requestType: "json",
2714
+ body: mergeAdditionalBodyParameters(serializers.SequenceEnrollmentPauseRequest.jsonOrThrow(_body, {
2715
+ unrecognizedObjectKeys: "strip",
2716
+ omitUndefined: true,
2717
+ }), requestOptions?.additionalBodyParameters),
2718
+ timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
2719
+ maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
2720
+ abortSignal: requestOptions?.abortSignal,
2721
+ fetchFn: this._options?.fetch,
2722
+ logging: this._options.logging,
2723
+ });
2724
+ if (_response.ok) {
2725
+ return {
2726
+ data: serializers.SequenceEnrollmentPauseResponse.parseOrThrow(_response.body, {
2727
+ unrecognizedObjectKeys: "passthrough",
2728
+ allowUnrecognizedUnionMembers: true,
2729
+ allowUnrecognizedEnumValues: true,
2730
+ skipValidation: true,
2731
+ breadcrumbsPrefix: ["response"],
2732
+ }),
2733
+ rawResponse: _response.rawResponse,
2734
+ };
2735
+ }
2736
+ if (_response.error.reason === "status-code") {
2737
+ switch (_response.error.statusCode) {
2738
+ case 400:
2739
+ throw new Sequenzy.BadRequestError(_response.error.body, _response.rawResponse);
2740
+ case 401:
2741
+ throw new Sequenzy.UnauthorizedError(_response.error.body, _response.rawResponse);
2742
+ case 403:
2743
+ throw new Sequenzy.ForbiddenError(_response.error.body, _response.rawResponse);
2744
+ case 404:
2745
+ throw new Sequenzy.NotFoundError(_response.error.body, _response.rawResponse);
2746
+ default:
2747
+ throw new errors.SequenzyError({
2748
+ statusCode: _response.error.statusCode,
2749
+ body: _response.error.body,
2750
+ rawResponse: _response.rawResponse,
2751
+ });
2752
+ }
2753
+ }
2754
+ return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/sequences/{sequenceId}/enrollments/pause");
2755
+ }
2672
2756
  /**
2673
2757
  * Rewrites the first 3 emails of a public gallery sequence for your brand, or for another `website`, and returns them without creating anything. Emails that could not be written are counted in `failedEmailCount`; the call fails only when none could be written. Usually takes 10 to 30 seconds. Requires `sequences:write`.
2674
2758
  *
@@ -2988,6 +3072,83 @@ export class SequencesClient {
2988
3072
  }
2989
3073
  return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/sequences/{sequenceId}/resume-enrollments");
2990
3074
  }
3075
+ /**
3076
+ * Continues paused contacts from the step they were paused on, with the status they had. Nothing restarts or is skipped. Waits keep their original wall-clock time, like a whole-sequence pause - a wait that ran out while paused continues right away, and one that has not still ends when it would have. Enrollments of the targeted contacts that are not paused are reported with outcome not_paused and left alone. When the sequence itself is disabled, sequenceRunning is false and the resumed contacts continue once it is enabled.
3077
+ *
3078
+ * @param {Sequenzy.SequenceEnrollmentResumeRequest} request
3079
+ * @param {SequencesClient.RequestOptions} requestOptions - Request-specific configuration.
3080
+ *
3081
+ * @throws {@link Sequenzy.BadRequestError}
3082
+ * @throws {@link Sequenzy.UnauthorizedError}
3083
+ * @throws {@link Sequenzy.ForbiddenError}
3084
+ * @throws {@link Sequenzy.NotFoundError}
3085
+ * @throws {@link errors.SequenzyError}
3086
+ * @throws {@link errors.SequenzyTimeoutError}
3087
+ *
3088
+ * @example
3089
+ * await client.sequences.resumeSubscribers({
3090
+ * sequenceId: "sequenceId",
3091
+ * emails: ["ada@example.com"]
3092
+ * })
3093
+ */
3094
+ resumeSubscribers(request, requestOptions) {
3095
+ return core.HttpResponsePromise.fromPromise(this.__resumeSubscribers(request, requestOptions));
3096
+ }
3097
+ async __resumeSubscribers(request, requestOptions) {
3098
+ const { sequenceId, ..._body } = request;
3099
+ const _authRequest = await this._options.authProvider.getAuthRequest();
3100
+ const _headers = mergeHeaders(_authRequest.headers, this._options?.headers, requestOptions?.headers);
3101
+ const _response = await core.fetcher({
3102
+ url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
3103
+ (await core.Supplier.get(this._options.environment)) ??
3104
+ environments.SequenzyEnvironment.Default, `sequences/${core.url.encodePathParam(sequenceId)}/enrollments/resume`),
3105
+ method: "POST",
3106
+ headers: _headers,
3107
+ contentType: "application/json",
3108
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
3109
+ requestType: "json",
3110
+ body: mergeAdditionalBodyParameters(serializers.SequenceEnrollmentResumeRequest.jsonOrThrow(_body, {
3111
+ unrecognizedObjectKeys: "strip",
3112
+ omitUndefined: true,
3113
+ }), requestOptions?.additionalBodyParameters),
3114
+ timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
3115
+ maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
3116
+ abortSignal: requestOptions?.abortSignal,
3117
+ fetchFn: this._options?.fetch,
3118
+ logging: this._options.logging,
3119
+ });
3120
+ if (_response.ok) {
3121
+ return {
3122
+ data: serializers.SequenceEnrollmentResumeResponse.parseOrThrow(_response.body, {
3123
+ unrecognizedObjectKeys: "passthrough",
3124
+ allowUnrecognizedUnionMembers: true,
3125
+ allowUnrecognizedEnumValues: true,
3126
+ skipValidation: true,
3127
+ breadcrumbsPrefix: ["response"],
3128
+ }),
3129
+ rawResponse: _response.rawResponse,
3130
+ };
3131
+ }
3132
+ if (_response.error.reason === "status-code") {
3133
+ switch (_response.error.statusCode) {
3134
+ case 400:
3135
+ throw new Sequenzy.BadRequestError(_response.error.body, _response.rawResponse);
3136
+ case 401:
3137
+ throw new Sequenzy.UnauthorizedError(_response.error.body, _response.rawResponse);
3138
+ case 403:
3139
+ throw new Sequenzy.ForbiddenError(_response.error.body, _response.rawResponse);
3140
+ case 404:
3141
+ throw new Sequenzy.NotFoundError(_response.error.body, _response.rawResponse);
3142
+ default:
3143
+ throw new errors.SequenzyError({
3144
+ statusCode: _response.error.statusCode,
3145
+ body: _response.error.body,
3146
+ rawResponse: _response.rawResponse,
3147
+ });
3148
+ }
3149
+ }
3150
+ return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/sequences/{sequenceId}/enrollments/resume");
3151
+ }
2991
3152
  /**
2992
3153
  * Immediately invalidates the previous URL and returns the replacement endpoint.
2993
3154
  *
@@ -22,7 +22,7 @@ export interface ListEnrollmentsSequencesRequest {
22
22
  offset?: number;
23
23
  /** Result order. Defaults to enrolled_at_desc. Enrollments with no scheduled resume sort last under wait_until ordering. */
24
24
  sort?: Sequenzy.ListEnrollmentsSequencesRequestSort;
25
- /** Comma-separated enrollment statuses: active, waiting, completed, failed, cancelled. Defaults to active,waiting. */
25
+ /** Comma-separated enrollment statuses: active, waiting, paused, completed, failed, cancelled. Defaults to active,waiting,paused. */
26
26
  status?: string;
27
27
  /** Annotate each returned active or waiting enrollment with whether the sequence stop condition already matches for that contact right now. Stop conditions are re-evaluated when an enrollment next runs a step, not when their event arrives, so a stopped contact keeps reporting waiting until its delay expires. Use this to confirm a stop event registered without waiting the delay out. Caps the page at 100 regardless of limit. */
28
28
  stopConditionMatch?: boolean;
@@ -33,7 +33,7 @@
33
33
  export interface SequenceEnrollmentCancelRequest {
34
34
  /** Sequence ID */
35
35
  sequenceId: string;
36
- /** Cancel every active or waiting enrollment in the sequence, regardless of how contacts entered it. Use this when segment-triggered enrollments share no entry field value. Defaults to dry run unless dryRun is explicitly false. */
36
+ /** Cancel every active, waiting, or paused enrollment in the sequence, regardless of how contacts entered it. Use this when segment-triggered enrollments share no entry field value. Defaults to dry run unless dryRun is explicitly false. */
37
37
  cancelAll?: boolean;
38
38
  /** When true, returns matching enrollments without cancelling them. cancelAll, subscriberIds, and fieldValues default to dry run unless explicitly false; a single subscriberId cancels immediately. */
39
39
  dryRun?: boolean;
@@ -0,0 +1,24 @@
1
+ /**
2
+ * @example
3
+ * {
4
+ * sequenceId: "sequenceId",
5
+ * emails: ["ada@example.com"],
6
+ * reason: "Project blocked"
7
+ * }
8
+ *
9
+ * @example
10
+ * {
11
+ * sequenceId: "sequenceId",
12
+ * subscriberIds: ["sub_abc123", "sub_def456"]
13
+ * }
14
+ */
15
+ export interface SequenceEnrollmentPauseRequest {
16
+ /** Sequence ID */
17
+ sequenceId: string;
18
+ /** Subscriber emails to pause, matched case-insensitively. Emails that match no contact come back in notFound.emails. */
19
+ emails?: string[];
20
+ /** Note stored on each paused enrollment and returned as pauseReason by list enrollments. */
21
+ reason?: string;
22
+ /** Subscriber IDs to pause. IDs that match no contact come back in notFound.subscriberIds. */
23
+ subscriberIds?: string[];
24
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,15 @@
1
+ /**
2
+ * @example
3
+ * {
4
+ * sequenceId: "sequenceId",
5
+ * emails: ["ada@example.com"]
6
+ * }
7
+ */
8
+ export interface SequenceEnrollmentResumeRequest {
9
+ /** Sequence ID */
10
+ sequenceId: string;
11
+ /** Subscriber emails to resume, matched case-insensitively. */
12
+ emails?: string[];
13
+ /** Subscriber IDs to resume. */
14
+ subscriberIds?: string[];
15
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -37,7 +37,9 @@ export type { SendTestEmailSequencesRequest } from "./SendTestEmailSequencesRequ
37
37
  export type { SequenceCreateRequest } from "./SequenceCreateRequest.js";
38
38
  export type { SequenceEnrollmentCancelRequest } from "./SequenceEnrollmentCancelRequest.js";
39
39
  export type { SequenceEnrollmentMoveRequest } from "./SequenceEnrollmentMoveRequest.js";
40
+ export type { SequenceEnrollmentPauseRequest } from "./SequenceEnrollmentPauseRequest.js";
40
41
  export type { SequenceEnrollmentRealignRequest } from "./SequenceEnrollmentRealignRequest.js";
42
+ export type { SequenceEnrollmentResumeRequest } from "./SequenceEnrollmentResumeRequest.js";
41
43
  export type { SequenceUpdateRequest } from "./SequenceUpdateRequest.js";
42
44
  export type { SimulateSequencesRequest } from "./SimulateSequencesRequest.js";
43
45
  export type { StartTestRunSequencesRequest } from "./StartTestRunSequencesRequest.js";
@@ -3,6 +3,7 @@ export interface GetStatsSequencesResponse {
3
3
  enrollmentCounts?: Sequenzy.SequenceEnrollmentCounts;
4
4
  /** Trigger matches where the contact could not be enrolled because they are unsubscribed or bounced. Defaults to the last 30 days when no explicit time range is provided. */
5
5
  enrollmentSkipped?: Sequenzy.GetStatsSequencesResponseEnrollmentSkipped;
6
+ pausedEnrollments?: Sequenzy.SequencePausedEnrollmentCounts;
6
7
  /** Echoed back when `period` is provided. */
7
8
  period?: string;
8
9
  recommendations?: Sequenzy.RecommendationMetrics;
@@ -93,7 +93,7 @@ export declare class WebsitesClient {
93
93
  list(requestOptions?: WebsitesClient.RequestOptions): core.HttpResponsePromise<Sequenzy.ListWebsitesResponse>;
94
94
  private __list;
95
95
  /**
96
- * Starts moving a verified sending domain onto the current per-domain CNAME record set without removing it. The domain keeps sending on its current records while the upgrade is in progress, and sender profiles, sequences and tracking stay as they are. Publish the CNAMEs in website.dnsUpgrade.records next to your current records; remove nothing yet. About an hour after the required ones (DKIM and the return path) are visible on public DNS (Google and Cloudflare resolvers), the domain switches by itself; the wait lets cached "does not exist" answers expire. Sequenzy prepares the sending setup of the domain separately and switches only once it is confirmed, so sending is normally not interrupted and no emails are held. If that is not possible for a domain, emails sent through Amazon SES can be held for a few minutes while SES confirms the new setup, then they go out. Some domains get a new DKIM key during the upgrade; you still publish the same four CNAMEs. An older SES-only domain needs a working DMARC record first, otherwise the request returns 400. Call POST /websites/{domain}/verify after publishing to check now; it does not skip the wait. After the switch, website.dnsUpgrade lists the old records to delete after deleteOldRecordsAfter; for an older SES-only domain these include the old return path records (MX and TXT at send.<domain>) and the DKIM TXT, and DMARC stays. Requires websites:write.
96
+ * Starts moving a verified sending domain onto the current per-domain CNAME record set without removing it. The domain keeps sending on its current records while the upgrade is in progress, and sender profiles, sequences and tracking stay as they are. Publish the CNAMEs in website.dnsUpgrade.records next to your current records; remove nothing yet. About an hour after the required ones (DKIM and the return path) are visible on public DNS (Google and Cloudflare resolvers), the domain switches by itself; the wait lets cached "does not exist" answers expire. Sequenzy prepares the sending setup of the domain separately and switches only once it is confirmed, so sending is normally not interrupted and no emails are held. If that is not possible for a domain, emails sent through Amazon SES can be held for a few minutes while SES confirms the new setup, then they go out. The domain also gets a new 2048-bit DKIM key; you still publish the same four CNAMEs. An older SES-only domain needs a working DMARC record first, otherwise the request returns 400. Call POST /websites/{domain}/verify after publishing to check now; it does not skip the wait. After the switch, website.dnsUpgrade lists the old records to delete after deleteOldRecordsAfter; for an older SES-only domain these include the old return path records (MX and TXT at send.<domain>) and the DKIM TXT, and DMARC stays. Requires websites:write.
97
97
  *
98
98
  * @param {Sequenzy.StartSendingDomainDnsUpgradeRequest} request
99
99
  * @param {WebsitesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -309,7 +309,7 @@ export class WebsitesClient {
309
309
  return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/websites");
310
310
  }
311
311
  /**
312
- * Starts moving a verified sending domain onto the current per-domain CNAME record set without removing it. The domain keeps sending on its current records while the upgrade is in progress, and sender profiles, sequences and tracking stay as they are. Publish the CNAMEs in website.dnsUpgrade.records next to your current records; remove nothing yet. About an hour after the required ones (DKIM and the return path) are visible on public DNS (Google and Cloudflare resolvers), the domain switches by itself; the wait lets cached "does not exist" answers expire. Sequenzy prepares the sending setup of the domain separately and switches only once it is confirmed, so sending is normally not interrupted and no emails are held. If that is not possible for a domain, emails sent through Amazon SES can be held for a few minutes while SES confirms the new setup, then they go out. Some domains get a new DKIM key during the upgrade; you still publish the same four CNAMEs. An older SES-only domain needs a working DMARC record first, otherwise the request returns 400. Call POST /websites/{domain}/verify after publishing to check now; it does not skip the wait. After the switch, website.dnsUpgrade lists the old records to delete after deleteOldRecordsAfter; for an older SES-only domain these include the old return path records (MX and TXT at send.<domain>) and the DKIM TXT, and DMARC stays. Requires websites:write.
312
+ * Starts moving a verified sending domain onto the current per-domain CNAME record set without removing it. The domain keeps sending on its current records while the upgrade is in progress, and sender profiles, sequences and tracking stay as they are. Publish the CNAMEs in website.dnsUpgrade.records next to your current records; remove nothing yet. About an hour after the required ones (DKIM and the return path) are visible on public DNS (Google and Cloudflare resolvers), the domain switches by itself; the wait lets cached "does not exist" answers expire. Sequenzy prepares the sending setup of the domain separately and switches only once it is confirmed, so sending is normally not interrupted and no emails are held. If that is not possible for a domain, emails sent through Amazon SES can be held for a few minutes while SES confirms the new setup, then they go out. The domain also gets a new 2048-bit DKIM key; you still publish the same four CNAMEs. An older SES-only domain needs a working DMARC record first, otherwise the request returns 400. Call POST /websites/{domain}/verify after publishing to check now; it does not skip the wait. After the switch, website.dnsUpgrade lists the old records to delete after deleteOldRecordsAfter; for an older SES-only domain these include the old return path records (MX and TXT at send.<domain>) and the DKIM TXT, and DMARC stays. Requires websites:write.
313
313
  *
314
314
  * @param {Sequenzy.StartSendingDomainDnsUpgradeRequest} request
315
315
  * @param {WebsitesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -1,7 +1,5 @@
1
1
  import type * as Sequenzy from "../index.js";
2
- export interface BadRequestErrorBody {
3
- code?: string;
4
- error?: string;
5
- issues?: Sequenzy.DesignMdIssue[];
6
- success?: boolean;
2
+ export interface BadRequestErrorBody extends Sequenzy.Error_ {
3
+ /** SparkLoop only, with code sparkloop_publication_required. The publications to pass as providerAccountId. */
4
+ publications?: Sequenzy.BadRequestErrorBodyPublicationsItem[];
7
5
  }
@@ -0,0 +1,4 @@
1
+ export interface BadRequestErrorBodyPublicationsItem {
2
+ id?: string;
3
+ name?: string;
4
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -47,7 +47,7 @@ export interface Company {
47
47
  replyTrackingDomainMode?: Sequenzy.CompanyReplyTrackingDomainMode;
48
48
  /** Whether inbound reply capture is enabled for this company. */
49
49
  replyTrackingEnabled?: boolean;
50
- /** Profile URL per platform. Bare hosts (`x.com/acme`) and mistyped web schemes (`ttps://`, `https:/`) are saved as `https://` URLs. */
50
+ /** Profile URL per platform. Bare hosts (`x.com/acme`) and mistyped web schemes (`ttps://`, `https:/`) are saved as `https://` URLs. Branded footers show an icon for `x` (or `twitter`), `threads`, `bluesky`, `linkedin`, `instagram`, `facebook`, `youtube`, `tiktok`, `pinterest`, `discord`, `reddit`, and the mobile app store listings `appstore` and `googleplay`. Other keys are stored but get no icon. */
51
51
  socialLinks?: Record<string, string | null> | null;
52
52
  status?: string;
53
53
  termsUrl?: string | null;
@@ -5,7 +5,7 @@ export interface SequenceEnrollmentCancelResponse {
5
5
  dryRun?: boolean;
6
6
  enrollments?: Sequenzy.SequenceEnrollmentCancelResponseEnrollmentsItem[];
7
7
  hasMore?: boolean;
8
- /** Active or waiting enrollments matching the target when the request started. */
8
+ /** Active, waiting, or paused enrollments matching the target when the request started. */
9
9
  matchedCount?: number;
10
10
  message?: string;
11
11
  /** Enrollments still matching the target after this request. Repeat the same request while this is above zero. */
@@ -34,7 +34,12 @@ export interface SequenceEnrollmentGetResponseEnrollment {
34
34
  movedFromNodeId?: string | null;
35
35
  /** Note recorded with that release, or null when none was given. */
36
36
  moveReason?: string | null;
37
+ /** When the current pause began, or null when the enrollment is not paused. */
38
+ pausedAt?: Date | null;
39
+ /** Reason given when the enrollment was paused, or null. */
40
+ pauseReason?: string | null;
37
41
  sequenceId?: string;
42
+ /** `paused` means the enrollment is held on its current step by POST /sequences/{sequenceId}/enrollments/pause. */
38
43
  status?: Sequenzy.SequenceEnrollmentGetResponseEnrollmentStatus;
39
44
  /** Whether the sequence stop condition matches for this contact right now. Null when it was not determined - stopConditionMatch was not requested, the sequence has no stop condition, this enrollment is no longer active or waiting, or it fell outside the evaluated window. Null never means "does not match". This is a non-atomic snapshot; the worker re-checks before a future step, but the condition can change and a step already past its stop check may still finish. */
40
45
  stopConditionMatches?: boolean | null;
@@ -42,6 +47,6 @@ export interface SequenceEnrollmentGetResponseEnrollment {
42
47
  stopConditionMatchReason?: string | null;
43
48
  subscriberId?: string;
44
49
  subscriberStatus?: string | null;
45
- /** When a waiting enrollment is scheduled to resume, or null when nothing is scheduled. */
50
+ /** When a waiting enrollment is scheduled to resume, or null when nothing is scheduled. Always null for a paused enrollment, because nothing runs until it is resumed. */
46
51
  waitUntil?: Date | null;
47
52
  }
@@ -1,6 +1,8 @@
1
+ /** `paused` means the enrollment is held on its current step by POST /sequences/{sequenceId}/enrollments/pause. */
1
2
  export declare const SequenceEnrollmentGetResponseEnrollmentStatus: {
2
3
  readonly Active: "active";
3
4
  readonly Waiting: "waiting";
5
+ readonly Paused: "paused";
4
6
  readonly Completed: "completed";
5
7
  readonly Failed: "failed";
6
8
  readonly Cancelled: "cancelled";
@@ -1,7 +1,9 @@
1
1
  // This file was auto-generated by Fern from our API Definition.
2
+ /** `paused` means the enrollment is held on its current step by POST /sequences/{sequenceId}/enrollments/pause. */
2
3
  export const SequenceEnrollmentGetResponseEnrollmentStatus = {
3
4
  Active: "active",
4
5
  Waiting: "waiting",
6
+ Paused: "paused",
5
7
  Completed: "completed",
6
8
  Failed: "failed",
7
9
  Cancelled: "cancelled",
@@ -34,7 +34,12 @@ export interface SequenceEnrollmentListResponseEnrollmentsItem {
34
34
  movedFromNodeId?: string | null;
35
35
  /** Note recorded with that release, or null when none was given. */
36
36
  moveReason?: string | null;
37
+ /** When the current pause began, or null when the enrollment is not paused. */
38
+ pausedAt?: Date | null;
39
+ /** Reason given when the enrollment was paused, or null. */
40
+ pauseReason?: string | null;
37
41
  sequenceId?: string;
42
+ /** `paused` means the enrollment is held on its current step by POST /sequences/{sequenceId}/enrollments/pause. */
38
43
  status?: Sequenzy.SequenceEnrollmentListResponseEnrollmentsItemStatus;
39
44
  /** Whether the sequence stop condition matches for this contact right now. Null when it was not determined - stopConditionMatch was not requested, the sequence has no stop condition, this enrollment is no longer active or waiting, or it fell outside the evaluated window. Null never means "does not match". This is a non-atomic snapshot; the worker re-checks before a future step, but the condition can change and a step already past its stop check may still finish. */
40
45
  stopConditionMatches?: boolean | null;
@@ -42,6 +47,6 @@ export interface SequenceEnrollmentListResponseEnrollmentsItem {
42
47
  stopConditionMatchReason?: string | null;
43
48
  subscriberId?: string;
44
49
  subscriberStatus?: string | null;
45
- /** When a waiting enrollment is scheduled to resume, or null when nothing is scheduled. */
50
+ /** When a waiting enrollment is scheduled to resume, or null when nothing is scheduled. Always null for a paused enrollment, because nothing runs until it is resumed. */
46
51
  waitUntil?: Date | null;
47
52
  }