sequenzy 2.1.16 → 2.1.29

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 (279) hide show
  1. package/dist/cjs/api/resources/abTests/client/requests/CreateAbTestsRequest.d.ts +5 -1
  2. package/dist/cjs/api/resources/abTests/client/requests/UpdateAbTestsRequest.d.ts +7 -1
  3. package/dist/cjs/api/resources/abTests/types/CreateAbTestsRequestWinnerCriteria.d.ts +4 -1
  4. package/dist/cjs/api/resources/abTests/types/CreateAbTestsRequestWinnerCriteria.js +4 -1
  5. package/dist/cjs/api/resources/abTests/types/GetStatsAbTestsResponseVariantsItem.d.ts +3 -0
  6. package/dist/cjs/api/resources/abTests/types/GetStatsAbTestsResponseVariantsItemOutcome.d.ts +13 -0
  7. package/dist/cjs/api/resources/abTests/types/GetStatsAbTestsResponseVariantsItemOutcome.js +3 -0
  8. package/dist/cjs/api/resources/abTests/types/UpdateAbTestsRequestWinnerCriteria.d.ts +4 -1
  9. package/dist/cjs/api/resources/abTests/types/UpdateAbTestsRequestWinnerCriteria.js +4 -1
  10. package/dist/cjs/api/resources/abTests/types/index.d.ts +1 -0
  11. package/dist/cjs/api/resources/abTests/types/index.js +1 -0
  12. package/dist/cjs/api/resources/accounts/client/Client.d.ts +1 -1
  13. package/dist/cjs/api/resources/accounts/client/Client.js +1 -1
  14. package/dist/cjs/api/resources/analytics/client/Client.d.ts +20 -0
  15. package/dist/cjs/api/resources/analytics/client/Client.js +108 -1
  16. package/dist/cjs/api/resources/analytics/client/requests/GetMetricsBreakdownRequest.d.ts +27 -0
  17. package/dist/cjs/api/resources/analytics/client/requests/GetMetricsBreakdownRequest.js +3 -0
  18. package/dist/cjs/api/resources/analytics/client/requests/GetMetricsRequest.d.ts +4 -0
  19. package/dist/cjs/api/resources/analytics/client/requests/index.d.ts +1 -0
  20. package/dist/cjs/api/resources/analytics/types/GetMetricsBreakdownRequestBy.d.ts +8 -0
  21. package/dist/cjs/api/resources/analytics/types/GetMetricsBreakdownRequestBy.js +11 -0
  22. package/dist/cjs/api/resources/analytics/types/GetMetricsBreakdownRequestEmailType.d.ts +6 -0
  23. package/dist/cjs/api/resources/analytics/types/GetMetricsBreakdownRequestEmailType.js +9 -0
  24. package/dist/cjs/api/resources/analytics/types/GetMetricsBreakdownRequestPeriod.d.ts +8 -0
  25. package/dist/cjs/api/resources/analytics/types/GetMetricsBreakdownRequestPeriod.js +11 -0
  26. package/dist/cjs/api/resources/analytics/types/GetMetricsBreakdownResponse.d.ts +14 -0
  27. package/dist/cjs/api/resources/analytics/types/GetMetricsBreakdownResponse.js +3 -0
  28. package/dist/cjs/api/resources/analytics/types/GetMetricsBreakdownResponseRowsItem.d.ts +30 -0
  29. package/dist/cjs/api/resources/analytics/types/GetMetricsBreakdownResponseRowsItem.js +3 -0
  30. package/dist/cjs/api/resources/analytics/types/GetMetricsResponse.d.ts +4 -0
  31. package/dist/cjs/api/resources/analytics/types/index.d.ts +5 -0
  32. package/dist/cjs/api/resources/analytics/types/index.js +5 -0
  33. package/dist/cjs/api/resources/integrations/client/Client.d.ts +17 -0
  34. package/dist/cjs/api/resources/integrations/client/Client.js +66 -0
  35. package/dist/cjs/api/resources/integrations/client/requests/ConnectIntegrationsRequest.d.ts +1 -1
  36. package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponse.d.ts +12 -0
  37. package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponse.js +3 -0
  38. package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProviders.d.ts +11 -0
  39. package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProviders.js +3 -0
  40. package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem.d.ts +4 -0
  41. package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem.js +3 -0
  42. package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersReason.d.ts +4 -0
  43. package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersReason.js +7 -0
  44. package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItem.d.ts +10 -0
  45. package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItem.js +3 -0
  46. package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemEvidence.d.ts +7 -0
  47. package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemEvidence.js +10 -0
  48. package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemProvider.d.ts +12 -0
  49. package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemProvider.js +15 -0
  50. package/dist/cjs/api/resources/integrations/types/index.d.ts +7 -0
  51. package/dist/cjs/api/resources/integrations/types/index.js +7 -0
  52. package/dist/cjs/api/resources/sequences/client/requests/SequenceCreateRequest.d.ts +2 -0
  53. package/dist/cjs/api/resources/sequences/client/requests/SequenceUpdateRequest.d.ts +2 -0
  54. package/dist/cjs/api/resources/subscribers/client/requests/UpdateByExternalIdPathSubscribersRequest.d.ts +1 -1
  55. package/dist/cjs/api/resources/subscribers/client/requests/UpdateByExternalIdSubscribersRequest.d.ts +1 -1
  56. package/dist/cjs/api/resources/subscribers/client/requests/UpdateSubscribersRequest.d.ts +1 -1
  57. package/dist/cjs/api/resources/subscribers/types/UpdateByExternalIdPathSubscribersRequestStatus.d.ts +2 -1
  58. package/dist/cjs/api/resources/subscribers/types/UpdateByExternalIdPathSubscribersRequestStatus.js +2 -1
  59. package/dist/cjs/api/resources/subscribers/types/UpdateByExternalIdSubscribersRequestStatus.d.ts +2 -1
  60. package/dist/cjs/api/resources/subscribers/types/UpdateByExternalIdSubscribersRequestStatus.js +2 -1
  61. package/dist/cjs/api/resources/subscribers/types/UpdateSubscribersRequestStatus.d.ts +2 -1
  62. package/dist/cjs/api/resources/subscribers/types/UpdateSubscribersRequestStatus.js +2 -1
  63. package/dist/cjs/api/types/AbTest.d.ts +6 -2
  64. package/dist/cjs/api/types/AbTestSignificance.d.ts +1 -1
  65. package/dist/cjs/api/types/AbTestSignificanceMetric.d.ts +4 -1
  66. package/dist/cjs/api/types/AbTestSignificanceMetric.js +4 -1
  67. package/dist/cjs/api/types/AbTestWinnerCriteria.d.ts +8 -0
  68. package/dist/cjs/api/types/AbTestWinnerCriteria.js +11 -0
  69. package/dist/cjs/api/types/AccountHealthInsight.d.ts +1 -1
  70. package/dist/cjs/api/types/SequenceCreateResponseSequence.d.ts +2 -0
  71. package/dist/cjs/api/types/SequenceSummary.d.ts +2 -0
  72. package/dist/cjs/api/types/index.d.ts +1 -0
  73. package/dist/cjs/api/types/index.js +1 -0
  74. package/dist/cjs/serialization/resources/abTests/client/requests/CreateAbTestsRequest.d.ts +2 -0
  75. package/dist/cjs/serialization/resources/abTests/client/requests/CreateAbTestsRequest.js +2 -0
  76. package/dist/cjs/serialization/resources/abTests/client/requests/UpdateAbTestsRequest.d.ts +3 -0
  77. package/dist/cjs/serialization/resources/abTests/client/requests/UpdateAbTestsRequest.js +3 -0
  78. package/dist/cjs/serialization/resources/abTests/types/CreateAbTestsRequestWinnerCriteria.d.ts +1 -1
  79. package/dist/cjs/serialization/resources/abTests/types/CreateAbTestsRequestWinnerCriteria.js +1 -1
  80. package/dist/cjs/serialization/resources/abTests/types/GetStatsAbTestsResponseVariantsItem.d.ts +2 -0
  81. package/dist/cjs/serialization/resources/abTests/types/GetStatsAbTestsResponseVariantsItem.js +2 -0
  82. package/dist/cjs/serialization/resources/abTests/types/GetStatsAbTestsResponseVariantsItemOutcome.d.ts +13 -0
  83. package/dist/cjs/serialization/resources/abTests/types/GetStatsAbTestsResponseVariantsItemOutcome.js +35 -0
  84. package/dist/cjs/serialization/resources/abTests/types/UpdateAbTestsRequestWinnerCriteria.d.ts +1 -1
  85. package/dist/cjs/serialization/resources/abTests/types/UpdateAbTestsRequestWinnerCriteria.js +1 -1
  86. package/dist/cjs/serialization/resources/abTests/types/index.d.ts +1 -0
  87. package/dist/cjs/serialization/resources/abTests/types/index.js +1 -0
  88. package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownRequestBy.d.ts +7 -0
  89. package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownRequestBy.js +29 -0
  90. package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownRequestEmailType.d.ts +7 -0
  91. package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownRequestEmailType.js +29 -0
  92. package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownRequestPeriod.d.ts +7 -0
  93. package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownRequestPeriod.js +29 -0
  94. package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownResponse.d.ts +19 -0
  95. package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownResponse.js +41 -0
  96. package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownResponseRowsItem.d.ts +26 -0
  97. package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownResponseRowsItem.js +48 -0
  98. package/dist/cjs/serialization/resources/analytics/types/GetMetricsResponse.d.ts +2 -0
  99. package/dist/cjs/serialization/resources/analytics/types/GetMetricsResponse.js +2 -0
  100. package/dist/cjs/serialization/resources/analytics/types/index.d.ts +5 -0
  101. package/dist/cjs/serialization/resources/analytics/types/index.js +5 -0
  102. package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponse.d.ts +15 -0
  103. package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponse.js +37 -0
  104. package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProviders.d.ts +13 -0
  105. package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProviders.js +35 -0
  106. package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem.d.ts +10 -0
  107. package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem.js +32 -0
  108. package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersReason.d.ts +7 -0
  109. package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersReason.js +29 -0
  110. package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItem.d.ts +15 -0
  111. package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItem.js +37 -0
  112. package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemEvidence.d.ts +7 -0
  113. package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemEvidence.js +29 -0
  114. package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemProvider.d.ts +7 -0
  115. package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemProvider.js +39 -0
  116. package/dist/cjs/serialization/resources/integrations/types/index.d.ts +7 -0
  117. package/dist/cjs/serialization/resources/integrations/types/index.js +7 -0
  118. package/dist/cjs/serialization/resources/sequences/client/requests/SequenceCreateRequest.d.ts +1 -0
  119. package/dist/cjs/serialization/resources/sequences/client/requests/SequenceCreateRequest.js +1 -0
  120. package/dist/cjs/serialization/resources/sequences/client/requests/SequenceUpdateRequest.d.ts +1 -0
  121. package/dist/cjs/serialization/resources/sequences/client/requests/SequenceUpdateRequest.js +1 -0
  122. package/dist/cjs/serialization/resources/subscribers/types/UpdateByExternalIdPathSubscribersRequestStatus.d.ts +1 -1
  123. package/dist/cjs/serialization/resources/subscribers/types/UpdateByExternalIdPathSubscribersRequestStatus.js +1 -1
  124. package/dist/cjs/serialization/resources/subscribers/types/UpdateByExternalIdSubscribersRequestStatus.d.ts +1 -1
  125. package/dist/cjs/serialization/resources/subscribers/types/UpdateByExternalIdSubscribersRequestStatus.js +1 -1
  126. package/dist/cjs/serialization/resources/subscribers/types/UpdateSubscribersRequestStatus.d.ts +1 -1
  127. package/dist/cjs/serialization/resources/subscribers/types/UpdateSubscribersRequestStatus.js +1 -1
  128. package/dist/cjs/serialization/types/AbTest.d.ts +4 -1
  129. package/dist/cjs/serialization/types/AbTest.js +4 -1
  130. package/dist/cjs/serialization/types/AbTestSignificanceMetric.d.ts +1 -1
  131. package/dist/cjs/serialization/types/AbTestSignificanceMetric.js +1 -1
  132. package/dist/cjs/serialization/types/AbTestWinnerCriteria.d.ts +7 -0
  133. package/dist/cjs/serialization/types/AbTestWinnerCriteria.js +29 -0
  134. package/dist/cjs/serialization/types/SequenceCreateResponseSequence.d.ts +1 -0
  135. package/dist/cjs/serialization/types/SequenceCreateResponseSequence.js +1 -0
  136. package/dist/cjs/serialization/types/SequenceSummary.d.ts +1 -0
  137. package/dist/cjs/serialization/types/SequenceSummary.js +1 -0
  138. package/dist/cjs/serialization/types/index.d.ts +1 -0
  139. package/dist/cjs/serialization/types/index.js +1 -0
  140. package/dist/esm/api/resources/abTests/client/requests/CreateAbTestsRequest.d.ts +5 -1
  141. package/dist/esm/api/resources/abTests/client/requests/UpdateAbTestsRequest.d.ts +7 -1
  142. package/dist/esm/api/resources/abTests/types/CreateAbTestsRequestWinnerCriteria.d.ts +4 -1
  143. package/dist/esm/api/resources/abTests/types/CreateAbTestsRequestWinnerCriteria.js +4 -1
  144. package/dist/esm/api/resources/abTests/types/GetStatsAbTestsResponseVariantsItem.d.ts +3 -0
  145. package/dist/esm/api/resources/abTests/types/GetStatsAbTestsResponseVariantsItemOutcome.d.ts +13 -0
  146. package/dist/esm/api/resources/abTests/types/GetStatsAbTestsResponseVariantsItemOutcome.js +2 -0
  147. package/dist/esm/api/resources/abTests/types/UpdateAbTestsRequestWinnerCriteria.d.ts +4 -1
  148. package/dist/esm/api/resources/abTests/types/UpdateAbTestsRequestWinnerCriteria.js +4 -1
  149. package/dist/esm/api/resources/abTests/types/index.d.ts +1 -0
  150. package/dist/esm/api/resources/abTests/types/index.js +1 -0
  151. package/dist/esm/api/resources/accounts/client/Client.d.ts +1 -1
  152. package/dist/esm/api/resources/accounts/client/Client.js +1 -1
  153. package/dist/esm/api/resources/analytics/client/Client.d.ts +20 -0
  154. package/dist/esm/api/resources/analytics/client/Client.js +108 -1
  155. package/dist/esm/api/resources/analytics/client/requests/GetMetricsBreakdownRequest.d.ts +27 -0
  156. package/dist/esm/api/resources/analytics/client/requests/GetMetricsBreakdownRequest.js +2 -0
  157. package/dist/esm/api/resources/analytics/client/requests/GetMetricsRequest.d.ts +4 -0
  158. package/dist/esm/api/resources/analytics/client/requests/index.d.ts +1 -0
  159. package/dist/esm/api/resources/analytics/types/GetMetricsBreakdownRequestBy.d.ts +8 -0
  160. package/dist/esm/api/resources/analytics/types/GetMetricsBreakdownRequestBy.js +8 -0
  161. package/dist/esm/api/resources/analytics/types/GetMetricsBreakdownRequestEmailType.d.ts +6 -0
  162. package/dist/esm/api/resources/analytics/types/GetMetricsBreakdownRequestEmailType.js +6 -0
  163. package/dist/esm/api/resources/analytics/types/GetMetricsBreakdownRequestPeriod.d.ts +8 -0
  164. package/dist/esm/api/resources/analytics/types/GetMetricsBreakdownRequestPeriod.js +8 -0
  165. package/dist/esm/api/resources/analytics/types/GetMetricsBreakdownResponse.d.ts +14 -0
  166. package/dist/esm/api/resources/analytics/types/GetMetricsBreakdownResponse.js +2 -0
  167. package/dist/esm/api/resources/analytics/types/GetMetricsBreakdownResponseRowsItem.d.ts +30 -0
  168. package/dist/esm/api/resources/analytics/types/GetMetricsBreakdownResponseRowsItem.js +2 -0
  169. package/dist/esm/api/resources/analytics/types/GetMetricsResponse.d.ts +4 -0
  170. package/dist/esm/api/resources/analytics/types/index.d.ts +5 -0
  171. package/dist/esm/api/resources/analytics/types/index.js +5 -0
  172. package/dist/esm/api/resources/integrations/client/Client.d.ts +17 -0
  173. package/dist/esm/api/resources/integrations/client/Client.js +66 -0
  174. package/dist/esm/api/resources/integrations/client/requests/ConnectIntegrationsRequest.d.ts +1 -1
  175. package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponse.d.ts +12 -0
  176. package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponse.js +2 -0
  177. package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProviders.d.ts +11 -0
  178. package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProviders.js +2 -0
  179. package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem.d.ts +4 -0
  180. package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem.js +2 -0
  181. package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersReason.d.ts +4 -0
  182. package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersReason.js +4 -0
  183. package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItem.d.ts +10 -0
  184. package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItem.js +2 -0
  185. package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemEvidence.d.ts +7 -0
  186. package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemEvidence.js +7 -0
  187. package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemProvider.d.ts +12 -0
  188. package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemProvider.js +12 -0
  189. package/dist/esm/api/resources/integrations/types/index.d.ts +7 -0
  190. package/dist/esm/api/resources/integrations/types/index.js +7 -0
  191. package/dist/esm/api/resources/sequences/client/requests/SequenceCreateRequest.d.ts +2 -0
  192. package/dist/esm/api/resources/sequences/client/requests/SequenceUpdateRequest.d.ts +2 -0
  193. package/dist/esm/api/resources/subscribers/client/requests/UpdateByExternalIdPathSubscribersRequest.d.ts +1 -1
  194. package/dist/esm/api/resources/subscribers/client/requests/UpdateByExternalIdSubscribersRequest.d.ts +1 -1
  195. package/dist/esm/api/resources/subscribers/client/requests/UpdateSubscribersRequest.d.ts +1 -1
  196. package/dist/esm/api/resources/subscribers/types/UpdateByExternalIdPathSubscribersRequestStatus.d.ts +2 -1
  197. package/dist/esm/api/resources/subscribers/types/UpdateByExternalIdPathSubscribersRequestStatus.js +2 -1
  198. package/dist/esm/api/resources/subscribers/types/UpdateByExternalIdSubscribersRequestStatus.d.ts +2 -1
  199. package/dist/esm/api/resources/subscribers/types/UpdateByExternalIdSubscribersRequestStatus.js +2 -1
  200. package/dist/esm/api/resources/subscribers/types/UpdateSubscribersRequestStatus.d.ts +2 -1
  201. package/dist/esm/api/resources/subscribers/types/UpdateSubscribersRequestStatus.js +2 -1
  202. package/dist/esm/api/types/AbTest.d.ts +6 -2
  203. package/dist/esm/api/types/AbTestSignificance.d.ts +1 -1
  204. package/dist/esm/api/types/AbTestSignificanceMetric.d.ts +4 -1
  205. package/dist/esm/api/types/AbTestSignificanceMetric.js +4 -1
  206. package/dist/esm/api/types/AbTestWinnerCriteria.d.ts +8 -0
  207. package/dist/esm/api/types/AbTestWinnerCriteria.js +8 -0
  208. package/dist/esm/api/types/AccountHealthInsight.d.ts +1 -1
  209. package/dist/esm/api/types/SequenceCreateResponseSequence.d.ts +2 -0
  210. package/dist/esm/api/types/SequenceSummary.d.ts +2 -0
  211. package/dist/esm/api/types/index.d.ts +1 -0
  212. package/dist/esm/api/types/index.js +1 -0
  213. package/dist/esm/serialization/resources/abTests/client/requests/CreateAbTestsRequest.d.ts +2 -0
  214. package/dist/esm/serialization/resources/abTests/client/requests/CreateAbTestsRequest.js +2 -0
  215. package/dist/esm/serialization/resources/abTests/client/requests/UpdateAbTestsRequest.d.ts +3 -0
  216. package/dist/esm/serialization/resources/abTests/client/requests/UpdateAbTestsRequest.js +3 -0
  217. package/dist/esm/serialization/resources/abTests/types/CreateAbTestsRequestWinnerCriteria.d.ts +1 -1
  218. package/dist/esm/serialization/resources/abTests/types/CreateAbTestsRequestWinnerCriteria.js +1 -1
  219. package/dist/esm/serialization/resources/abTests/types/GetStatsAbTestsResponseVariantsItem.d.ts +2 -0
  220. package/dist/esm/serialization/resources/abTests/types/GetStatsAbTestsResponseVariantsItem.js +2 -0
  221. package/dist/esm/serialization/resources/abTests/types/GetStatsAbTestsResponseVariantsItemOutcome.d.ts +13 -0
  222. package/dist/esm/serialization/resources/abTests/types/GetStatsAbTestsResponseVariantsItemOutcome.js +9 -0
  223. package/dist/esm/serialization/resources/abTests/types/UpdateAbTestsRequestWinnerCriteria.d.ts +1 -1
  224. package/dist/esm/serialization/resources/abTests/types/UpdateAbTestsRequestWinnerCriteria.js +1 -1
  225. package/dist/esm/serialization/resources/abTests/types/index.d.ts +1 -0
  226. package/dist/esm/serialization/resources/abTests/types/index.js +1 -0
  227. package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownRequestBy.d.ts +7 -0
  228. package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownRequestBy.js +3 -0
  229. package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownRequestEmailType.d.ts +7 -0
  230. package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownRequestEmailType.js +3 -0
  231. package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownRequestPeriod.d.ts +7 -0
  232. package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownRequestPeriod.js +3 -0
  233. package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownResponse.d.ts +19 -0
  234. package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownResponse.js +15 -0
  235. package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownResponseRowsItem.d.ts +26 -0
  236. package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownResponseRowsItem.js +22 -0
  237. package/dist/esm/serialization/resources/analytics/types/GetMetricsResponse.d.ts +2 -0
  238. package/dist/esm/serialization/resources/analytics/types/GetMetricsResponse.js +2 -0
  239. package/dist/esm/serialization/resources/analytics/types/index.d.ts +5 -0
  240. package/dist/esm/serialization/resources/analytics/types/index.js +5 -0
  241. package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponse.d.ts +15 -0
  242. package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponse.js +11 -0
  243. package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProviders.d.ts +13 -0
  244. package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProviders.js +9 -0
  245. package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem.d.ts +10 -0
  246. package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem.js +6 -0
  247. package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersReason.d.ts +7 -0
  248. package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersReason.js +3 -0
  249. package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItem.d.ts +15 -0
  250. package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItem.js +11 -0
  251. package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemEvidence.d.ts +7 -0
  252. package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemEvidence.js +3 -0
  253. package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemProvider.d.ts +7 -0
  254. package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemProvider.js +13 -0
  255. package/dist/esm/serialization/resources/integrations/types/index.d.ts +7 -0
  256. package/dist/esm/serialization/resources/integrations/types/index.js +7 -0
  257. package/dist/esm/serialization/resources/sequences/client/requests/SequenceCreateRequest.d.ts +1 -0
  258. package/dist/esm/serialization/resources/sequences/client/requests/SequenceCreateRequest.js +1 -0
  259. package/dist/esm/serialization/resources/sequences/client/requests/SequenceUpdateRequest.d.ts +1 -0
  260. package/dist/esm/serialization/resources/sequences/client/requests/SequenceUpdateRequest.js +1 -0
  261. package/dist/esm/serialization/resources/subscribers/types/UpdateByExternalIdPathSubscribersRequestStatus.d.ts +1 -1
  262. package/dist/esm/serialization/resources/subscribers/types/UpdateByExternalIdPathSubscribersRequestStatus.js +1 -1
  263. package/dist/esm/serialization/resources/subscribers/types/UpdateByExternalIdSubscribersRequestStatus.d.ts +1 -1
  264. package/dist/esm/serialization/resources/subscribers/types/UpdateByExternalIdSubscribersRequestStatus.js +1 -1
  265. package/dist/esm/serialization/resources/subscribers/types/UpdateSubscribersRequestStatus.d.ts +1 -1
  266. package/dist/esm/serialization/resources/subscribers/types/UpdateSubscribersRequestStatus.js +1 -1
  267. package/dist/esm/serialization/types/AbTest.d.ts +4 -1
  268. package/dist/esm/serialization/types/AbTest.js +4 -1
  269. package/dist/esm/serialization/types/AbTestSignificanceMetric.d.ts +1 -1
  270. package/dist/esm/serialization/types/AbTestSignificanceMetric.js +1 -1
  271. package/dist/esm/serialization/types/AbTestWinnerCriteria.d.ts +7 -0
  272. package/dist/esm/serialization/types/AbTestWinnerCriteria.js +3 -0
  273. package/dist/esm/serialization/types/SequenceCreateResponseSequence.d.ts +1 -0
  274. package/dist/esm/serialization/types/SequenceCreateResponseSequence.js +1 -0
  275. package/dist/esm/serialization/types/SequenceSummary.d.ts +1 -0
  276. package/dist/esm/serialization/types/SequenceSummary.js +1 -0
  277. package/dist/esm/serialization/types/index.d.ts +1 -0
  278. package/dist/esm/serialization/types/index.js +1 -0
  279. package/package.json +1 -1
@@ -20,8 +20,12 @@ export interface CreateAbTestsRequest {
20
20
  testType?: Sequenzy.CreateAbTestsRequestTestType;
21
21
  /** Extra variants beyond the control. Required (min 1) when converting with automationNodeId. Total variants cannot exceed 5. */
22
22
  variants?: Sequenzy.CreateAbTestsRequestVariantsItem[];
23
- /** Metric used to pick the winner. For sequence tests, an explicit value overrides the testType default. */
23
+ /** Metric used to pick the winner. For sequence tests, an explicit value overrides the testType default. `goal_conversion_rate` picks the variant whose recipients convert on `winnerGoalId` most often per delivered email, `goal_value` the one with the most goal value per delivered email, and `event_rate` the one whose recipients most often fire `winnerEventName` after receiving it. Goal conversions count when attributed to the email (an open or click within the goal's attribution window; for campaigns, revenue and campaign goals also credit a recipient who received the email in that window). When no variant converts, campaign tests fall back to click rate and sequence tests keep splitting contacts. */
24
24
  winnerCriteria?: Sequenzy.CreateAbTestsRequestWinnerCriteria;
25
+ /** Required for `event_rate`. The event a recipient must fire after receiving the variant. */
26
+ winnerEventName?: string | null;
27
+ /** Required for `goal_conversion_rate` and `goal_value`. A goal ID that is active and company-wide or scoped to this campaign or sequence, or `default-revenue` for built-in purchase revenue (SaaS purchases and commerce orders, in cents). Other goals return 400. */
28
+ winnerGoalId?: string | null;
25
29
  /** Number of sequence recipients in the test sample. */
26
30
  winnerThreshold?: number;
27
31
  }
@@ -14,6 +14,8 @@ export interface UpdateAbTestsRequest {
14
14
  cancelSampleUpdate?: boolean;
15
15
  /** Required when sequence settings affect an active test or a test with recorded activity. */
16
16
  confirmLiveChange?: boolean;
17
+ /** Campaign-only. End a running test now: the winner is picked by winnerCriteria from the results so far and sent to the remaining audience. Requires campaigns:send. Cannot be combined with testDurationMinutes; returns 400 for tests that are not running and 409 while a sample change is pending. */
18
+ endTestNow?: boolean;
17
19
  /** Optional campaign revision from GET; stale values return 409. Omit to preserve existing unconditional update behavior. */
18
20
  expectedUpdatedAt?: Date;
19
21
  name?: string;
@@ -23,8 +25,12 @@ export interface UpdateAbTestsRequest {
23
25
  testPercentage?: number;
24
26
  /** Sequence-only variant strategy. */
25
27
  testType?: Sequenzy.UpdateAbTestsRequestTestType;
26
- /** Winner metric for campaign or sequence tests; immutable once campaign testing starts. */
28
+ /** Winner metric for campaign or sequence tests; immutable once campaign testing starts, together with winnerGoalId and winnerEventName. Changing the criterion clears a goal or event the new criterion does not use. */
27
29
  winnerCriteria?: Sequenzy.UpdateAbTestsRequestWinnerCriteria;
30
+ /** Required for `event_rate`. The event a recipient must fire after receiving the variant. */
31
+ winnerEventName?: string | null;
32
+ /** Required for `goal_conversion_rate` and `goal_value`. A goal ID that is active and company-wide or scoped to this campaign or sequence, or `default-revenue` for built-in purchase revenue (SaaS purchases and commerce orders, in cents). Other goals return 400. */
33
+ winnerGoalId?: string | null;
28
34
  /** Sequence-only recipient threshold. */
29
35
  winnerThreshold?: number;
30
36
  }
@@ -1,6 +1,9 @@
1
- /** Metric used to pick the winner. For sequence tests, an explicit value overrides the testType default. */
1
+ /** Metric used to pick the winner. For sequence tests, an explicit value overrides the testType default. `goal_conversion_rate` picks the variant whose recipients convert on `winnerGoalId` most often per delivered email, `goal_value` the one with the most goal value per delivered email, and `event_rate` the one whose recipients most often fire `winnerEventName` after receiving it. Goal conversions count when attributed to the email (an open or click within the goal's attribution window; for campaigns, revenue and campaign goals also credit a recipient who received the email in that window). When no variant converts, campaign tests fall back to click rate and sequence tests keep splitting contacts. */
2
2
  export declare const CreateAbTestsRequestWinnerCriteria: {
3
3
  readonly OpenRate: "open_rate";
4
4
  readonly ClickRate: "click_rate";
5
+ readonly GoalConversionRate: "goal_conversion_rate";
6
+ readonly GoalValue: "goal_value";
7
+ readonly EventRate: "event_rate";
5
8
  };
6
9
  export type CreateAbTestsRequestWinnerCriteria = (typeof CreateAbTestsRequestWinnerCriteria)[keyof typeof CreateAbTestsRequestWinnerCriteria];
@@ -2,8 +2,11 @@
2
2
  // This file was auto-generated by Fern from our API Definition.
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.CreateAbTestsRequestWinnerCriteria = void 0;
5
- /** Metric used to pick the winner. For sequence tests, an explicit value overrides the testType default. */
5
+ /** Metric used to pick the winner. For sequence tests, an explicit value overrides the testType default. `goal_conversion_rate` picks the variant whose recipients convert on `winnerGoalId` most often per delivered email, `goal_value` the one with the most goal value per delivered email, and `event_rate` the one whose recipients most often fire `winnerEventName` after receiving it. Goal conversions count when attributed to the email (an open or click within the goal's attribution window; for campaigns, revenue and campaign goals also credit a recipient who received the email in that window). When no variant converts, campaign tests fall back to click rate and sequence tests keep splitting contacts. */
6
6
  exports.CreateAbTestsRequestWinnerCriteria = {
7
7
  OpenRate: "open_rate",
8
8
  ClickRate: "click_rate",
9
+ GoalConversionRate: "goal_conversion_rate",
10
+ GoalValue: "goal_value",
11
+ EventRate: "event_rate",
9
12
  };
@@ -1,7 +1,10 @@
1
+ import type * as Sequenzy from "../../../index.js";
1
2
  export interface GetStatsAbTestsResponseVariantsItem {
2
3
  id?: string;
3
4
  isWinner?: boolean;
4
5
  label?: string;
6
+ /** Present when the test is judged on a goal or event. Covers every send of the test, whatever the requested period. */
7
+ outcome?: Sequenzy.GetStatsAbTestsResponseVariantsItemOutcome;
5
8
  stats?: Record<string, unknown>;
6
9
  subject?: string;
7
10
  }
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Present when the test is judged on a goal or event. Covers every send of the test, whatever the requested period.
3
+ */
4
+ export interface GetStatsAbTestsResponseVariantsItemOutcome {
5
+ /** convertedRecipients per delivered email, as a percentage. */
6
+ conversionRate?: number;
7
+ /** Recipients with an attributed goal conversion, or who fired the event after their send. */
8
+ convertedRecipients?: number;
9
+ deliveries?: number;
10
+ /** Summed tracked goal value, such as revenue in cents. Refunds lower it. 0 for events. */
11
+ value?: number;
12
+ valuePerDelivery?: number;
13
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,6 +1,9 @@
1
- /** Winner metric for campaign or sequence tests; immutable once campaign testing starts. */
1
+ /** Winner metric for campaign or sequence tests; immutable once campaign testing starts, together with winnerGoalId and winnerEventName. Changing the criterion clears a goal or event the new criterion does not use. */
2
2
  export declare const UpdateAbTestsRequestWinnerCriteria: {
3
3
  readonly OpenRate: "open_rate";
4
4
  readonly ClickRate: "click_rate";
5
+ readonly GoalConversionRate: "goal_conversion_rate";
6
+ readonly GoalValue: "goal_value";
7
+ readonly EventRate: "event_rate";
5
8
  };
6
9
  export type UpdateAbTestsRequestWinnerCriteria = (typeof UpdateAbTestsRequestWinnerCriteria)[keyof typeof UpdateAbTestsRequestWinnerCriteria];
@@ -2,8 +2,11 @@
2
2
  // This file was auto-generated by Fern from our API Definition.
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.UpdateAbTestsRequestWinnerCriteria = void 0;
5
- /** Winner metric for campaign or sequence tests; immutable once campaign testing starts. */
5
+ /** Winner metric for campaign or sequence tests; immutable once campaign testing starts, together with winnerGoalId and winnerEventName. Changing the criterion clears a goal or event the new criterion does not use. */
6
6
  exports.UpdateAbTestsRequestWinnerCriteria = {
7
7
  OpenRate: "open_rate",
8
8
  ClickRate: "click_rate",
9
+ GoalConversionRate: "goal_conversion_rate",
10
+ GoalValue: "goal_value",
11
+ EventRate: "event_rate",
9
12
  };
@@ -9,6 +9,7 @@ export * from "./GetAbTestsResponse.js";
9
9
  export * from "./GetStatsAbTestsRequestPeriod.js";
10
10
  export * from "./GetStatsAbTestsResponse.js";
11
11
  export * from "./GetStatsAbTestsResponseVariantsItem.js";
12
+ export * from "./GetStatsAbTestsResponseVariantsItemOutcome.js";
12
13
  export * from "./ListAbTestsResponse.js";
13
14
  export * from "./RestartAbTestsRequestTestType.js";
14
15
  export * from "./RestartAbTestsResponse.js";
@@ -25,6 +25,7 @@ __exportStar(require("./GetAbTestsResponse.js"), exports);
25
25
  __exportStar(require("./GetStatsAbTestsRequestPeriod.js"), exports);
26
26
  __exportStar(require("./GetStatsAbTestsResponse.js"), exports);
27
27
  __exportStar(require("./GetStatsAbTestsResponseVariantsItem.js"), exports);
28
+ __exportStar(require("./GetStatsAbTestsResponseVariantsItemOutcome.js"), exports);
28
29
  __exportStar(require("./ListAbTestsResponse.js"), exports);
29
30
  __exportStar(require("./RestartAbTestsRequestTestType.js"), exports);
30
31
  __exportStar(require("./RestartAbTestsResponse.js"), exports);
@@ -143,7 +143,7 @@ export declare class AccountsClient {
143
143
  getOrganizationIdJob(request: Sequenzy.GetOrganizationIdJobAccountsRequest, requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<Sequenzy.GetOrganizationIdJobAccountsResponse>;
144
144
  private __getOrganizationIdJob;
145
145
  /**
146
- * Lists the B2B accounts (organizations) in the workspace. Search matches name, external ID and domain. Sort with `sort` (updatedAt, createdAt, name, memberCount, lastEventAt) and `order` (asc, desc). `withoutEventRecipients=true` keeps accounts with members but no owner or admin.
146
+ * Lists the B2B accounts (organizations) in the workspace. Search matches name, external ID and domain. Sort with `sort` (updatedAt, createdAt, name, memberCount, lastEventAt) and `order` (asc, desc). `withoutEventRecipients=true` keeps accounts with members but no owner or admin. Organizations is the dashboard name for accounts, and every `/accounts` path also works as `/organizations`, and `/account-suggestions` as `/organization-suggestions`.
147
147
  *
148
148
  * @param {Sequenzy.ListAccountsRequest} request
149
149
  * @param {AccountsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -520,7 +520,7 @@ class AccountsClient {
520
520
  return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/account-suggestions/organization-ids/jobs/{jobId}");
521
521
  }
522
522
  /**
523
- * Lists the B2B accounts (organizations) in the workspace. Search matches name, external ID and domain. Sort with `sort` (updatedAt, createdAt, name, memberCount, lastEventAt) and `order` (asc, desc). `withoutEventRecipients=true` keeps accounts with members but no owner or admin.
523
+ * Lists the B2B accounts (organizations) in the workspace. Search matches name, external ID and domain. Sort with `sort` (updatedAt, createdAt, name, memberCount, lastEventAt) and `order` (asc, desc). `withoutEventRecipients=true` keeps accounts with members but no owner or admin. Organizations is the dashboard name for accounts, and every `/accounts` path also works as `/organizations`, and `/account-suggestions` as `/organization-suggestions`.
524
524
  *
525
525
  * @param {Sequenzy.ListAccountsRequest} request
526
526
  * @param {AccountsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -115,6 +115,7 @@ export declare class AnalyticsClient {
115
115
  *
116
116
  * @throws {@link Sequenzy.BadRequestError}
117
117
  * @throws {@link Sequenzy.UnauthorizedError}
118
+ * @throws {@link Sequenzy.NotFoundError}
118
119
  * @throws {@link Sequenzy.ServiceUnavailableError}
119
120
  * @throws {@link errors.SequenzyError}
120
121
  * @throws {@link errors.SequenzyTimeoutError}
@@ -124,6 +125,25 @@ export declare class AnalyticsClient {
124
125
  */
125
126
  getMetrics(request?: Sequenzy.GetMetricsRequest, requestOptions?: AnalyticsClient.RequestOptions): core.HttpResponsePromise<Sequenzy.GetMetricsResponse>;
126
127
  private __getMetrics;
128
+ /**
129
+ * Returns the delivery funnel for each value of one dimension, most sends first, so you can find the email, sequence, provider or domain behind a number and drill into it. Rows count the sends made in the window and the engagement they earned. Defaults to the last 30 days and 25 rows.
130
+ *
131
+ * @param {Sequenzy.GetMetricsBreakdownRequest} request
132
+ * @param {AnalyticsClient.RequestOptions} requestOptions - Request-specific configuration.
133
+ *
134
+ * @throws {@link Sequenzy.BadRequestError}
135
+ * @throws {@link Sequenzy.UnauthorizedError}
136
+ * @throws {@link Sequenzy.ForbiddenError}
137
+ * @throws {@link Sequenzy.NotFoundError}
138
+ * @throws {@link Sequenzy.InternalServerError}
139
+ * @throws {@link errors.SequenzyError}
140
+ * @throws {@link errors.SequenzyTimeoutError}
141
+ *
142
+ * @example
143
+ * await client.analytics.getMetricsBreakdown()
144
+ */
145
+ getMetricsBreakdown(request?: Sequenzy.GetMetricsBreakdownRequest, requestOptions?: AnalyticsClient.RequestOptions): core.HttpResponsePromise<Sequenzy.GetMetricsBreakdownResponse>;
146
+ private __getMetricsBreakdown;
127
147
  /**
128
148
  * Returns a paginated list of recipients with their open, click, and unsubscribe events. Use this to sync engagement data to your own database.
129
149
  *
@@ -473,6 +473,7 @@ class AnalyticsClient {
473
473
  *
474
474
  * @throws {@link Sequenzy.BadRequestError}
475
475
  * @throws {@link Sequenzy.UnauthorizedError}
476
+ * @throws {@link Sequenzy.NotFoundError}
476
477
  * @throws {@link Sequenzy.ServiceUnavailableError}
477
478
  * @throws {@link errors.SequenzyError}
478
479
  * @throws {@link errors.SequenzyTimeoutError}
@@ -484,7 +485,7 @@ class AnalyticsClient {
484
485
  return core.HttpResponsePromise.fromPromise(this.__getMetrics(request, requestOptions));
485
486
  }
486
487
  async __getMetrics(request = {}, requestOptions) {
487
- const { emailType, end, includeMachineEngagement, mailboxProvider, period, start } = request;
488
+ const { emailType, end, includeMachineEngagement, mailboxProvider, period, recipientDomain, source, start } = request;
488
489
  const _queryParams = {
489
490
  emailType: emailType != null
490
491
  ? serializers.GetMetricsRequestEmailType.jsonOrThrow(emailType, {
@@ -501,6 +502,8 @@ class AnalyticsClient {
501
502
  omitUndefined: true,
502
503
  })
503
504
  : undefined,
505
+ recipientDomain,
506
+ source,
504
507
  start: start != null ? start?.toISOString() : undefined,
505
508
  };
506
509
  const _authRequest = await this._options.authProvider.getAuthRequest();
@@ -540,6 +543,8 @@ class AnalyticsClient {
540
543
  throw new Sequenzy.BadRequestError(_response.error.body, _response.rawResponse);
541
544
  case 401:
542
545
  throw new Sequenzy.UnauthorizedError(_response.error.body, _response.rawResponse);
546
+ case 404:
547
+ throw new Sequenzy.NotFoundError(_response.error.body, _response.rawResponse);
543
548
  case 503:
544
549
  throw new Sequenzy.ServiceUnavailableError(_response.error.body, _response.rawResponse);
545
550
  default:
@@ -552,6 +557,108 @@ class AnalyticsClient {
552
557
  }
553
558
  return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/metrics");
554
559
  }
560
+ /**
561
+ * Returns the delivery funnel for each value of one dimension, most sends first, so you can find the email, sequence, provider or domain behind a number and drill into it. Rows count the sends made in the window and the engagement they earned. Defaults to the last 30 days and 25 rows.
562
+ *
563
+ * @param {Sequenzy.GetMetricsBreakdownRequest} request
564
+ * @param {AnalyticsClient.RequestOptions} requestOptions - Request-specific configuration.
565
+ *
566
+ * @throws {@link Sequenzy.BadRequestError}
567
+ * @throws {@link Sequenzy.UnauthorizedError}
568
+ * @throws {@link Sequenzy.ForbiddenError}
569
+ * @throws {@link Sequenzy.NotFoundError}
570
+ * @throws {@link Sequenzy.InternalServerError}
571
+ * @throws {@link errors.SequenzyError}
572
+ * @throws {@link errors.SequenzyTimeoutError}
573
+ *
574
+ * @example
575
+ * await client.analytics.getMetricsBreakdown()
576
+ */
577
+ getMetricsBreakdown(request = {}, requestOptions) {
578
+ return core.HttpResponsePromise.fromPromise(this.__getMetricsBreakdown(request, requestOptions));
579
+ }
580
+ async __getMetricsBreakdown(request = {}, requestOptions) {
581
+ const { by, emailType, end, includeMachineEngagement, limit, mailboxProvider, period, recipientDomain, source, start, } = request;
582
+ const _queryParams = {
583
+ by: by != null
584
+ ? serializers.GetMetricsBreakdownRequestBy.jsonOrThrow(by, {
585
+ unrecognizedObjectKeys: "strip",
586
+ omitUndefined: true,
587
+ })
588
+ : undefined,
589
+ emailType: emailType != null
590
+ ? serializers.GetMetricsBreakdownRequestEmailType.jsonOrThrow(emailType, {
591
+ unrecognizedObjectKeys: "strip",
592
+ omitUndefined: true,
593
+ })
594
+ : undefined,
595
+ end: end != null ? end?.toISOString() : undefined,
596
+ includeMachineEngagement,
597
+ limit,
598
+ mailboxProvider,
599
+ period: period != null
600
+ ? serializers.GetMetricsBreakdownRequestPeriod.jsonOrThrow(period, {
601
+ unrecognizedObjectKeys: "strip",
602
+ omitUndefined: true,
603
+ })
604
+ : undefined,
605
+ recipientDomain,
606
+ source,
607
+ start: start != null ? start?.toISOString() : undefined,
608
+ };
609
+ const _authRequest = await this._options.authProvider.getAuthRequest();
610
+ const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, this._options?.headers, requestOptions?.headers);
611
+ const _response = await core.fetcher({
612
+ url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
613
+ (await core.Supplier.get(this._options.environment)) ??
614
+ environments.SequenzyEnvironment.Default, "metrics/breakdown"),
615
+ method: "GET",
616
+ headers: _headers,
617
+ queryString: core.url
618
+ .queryBuilder()
619
+ .addMany(_queryParams)
620
+ .mergeAdditional(requestOptions?.queryParams)
621
+ .build(),
622
+ timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
623
+ maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
624
+ abortSignal: requestOptions?.abortSignal,
625
+ fetchFn: this._options?.fetch,
626
+ logging: this._options.logging,
627
+ });
628
+ if (_response.ok) {
629
+ return {
630
+ data: serializers.GetMetricsBreakdownResponse.parseOrThrow(_response.body, {
631
+ unrecognizedObjectKeys: "passthrough",
632
+ allowUnrecognizedUnionMembers: true,
633
+ allowUnrecognizedEnumValues: true,
634
+ skipValidation: true,
635
+ breadcrumbsPrefix: ["response"],
636
+ }),
637
+ rawResponse: _response.rawResponse,
638
+ };
639
+ }
640
+ if (_response.error.reason === "status-code") {
641
+ switch (_response.error.statusCode) {
642
+ case 400:
643
+ throw new Sequenzy.BadRequestError(_response.error.body, _response.rawResponse);
644
+ case 401:
645
+ throw new Sequenzy.UnauthorizedError(_response.error.body, _response.rawResponse);
646
+ case 403:
647
+ throw new Sequenzy.ForbiddenError(_response.error.body, _response.rawResponse);
648
+ case 404:
649
+ throw new Sequenzy.NotFoundError(_response.error.body, _response.rawResponse);
650
+ case 500:
651
+ throw new Sequenzy.InternalServerError(_response.error.body, _response.rawResponse);
652
+ default:
653
+ throw new errors.SequenzyError({
654
+ statusCode: _response.error.statusCode,
655
+ body: _response.error.body,
656
+ rawResponse: _response.rawResponse,
657
+ });
658
+ }
659
+ }
660
+ return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/metrics/breakdown");
661
+ }
555
662
  /**
556
663
  * Returns a paginated list of recipients with their open, click, and unsubscribe events. Use this to sync engagement data to your own database.
557
664
  *
@@ -0,0 +1,27 @@
1
+ import type * as Sequenzy from "../../../../index.js";
2
+ /**
3
+ * @example
4
+ * {}
5
+ */
6
+ export interface GetMetricsBreakdownRequest {
7
+ /** Dimension to group by. `email` has one row per campaign, sequence email step and transactional template. */
8
+ by?: Sequenzy.GetMetricsBreakdownRequestBy;
9
+ /** Structural email type filter. Marketer-role personal keys only see the emails their role can open and cannot request transactional. */
10
+ emailType?: Sequenzy.GetMetricsBreakdownRequestEmailType;
11
+ /** End of custom time range (ISO 8601). Must be used with `start`. Max range: 90 days. */
12
+ end?: Date;
13
+ /** Include detected scanner, preview, and tracked asset open/click events. */
14
+ includeMachineEngagement?: boolean;
15
+ /** Number of rows to return. */
16
+ limit?: number;
17
+ /** Recipient mailbox provider filter (e.g. gmail, microsoft, yahoo, icloud). */
18
+ mailboxProvider?: string;
19
+ /** Sliding window over send times. Ignored when start/end are provided. */
20
+ period?: Sequenzy.GetMetricsBreakdownRequestPeriod;
21
+ /** Recipient domain filter (e.g. gmail.com). Case-insensitive. */
22
+ recipientDomain?: string;
23
+ /** Email source filter as `<type>:<id>`: `campaign:<campaignId>`, `sequence:<sequenceId>`, `sequence_step:<email step id>` or `transactional:<transactional email id>`. Returns 404 when the source is not in the company or not visible to the key. */
24
+ source?: string;
25
+ /** Start of custom time range (ISO 8601). Must be used with `end`. */
26
+ start?: Date;
27
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -14,6 +14,10 @@ export interface GetMetricsRequest {
14
14
  mailboxProvider?: string;
15
15
  /** Sliding time window. Ignored when start/end are provided. */
16
16
  period?: Sequenzy.GetMetricsRequestPeriod;
17
+ /** Recipient domain filter (e.g. gmail.com). Case-insensitive. */
18
+ recipientDomain?: string;
19
+ /** Email source filter as `<type>:<id>`: `campaign:<campaignId>`, `sequence:<sequenceId>`, `sequence_step:<email step id>` or `transactional:<transactional email id>`. Responses filtered by recipientDomain or source report replies as 0 and omit the commerce forecast. Returns 404 when the source is not in the company or not visible to the key. */
20
+ source?: string;
17
21
  /** Start of custom time range (ISO 8601). Must be used with `end`. */
18
22
  start?: Date;
19
23
  }
@@ -3,6 +3,7 @@ export type { GetCampaignMetricsRequest } from "./GetCampaignMetricsRequest.js";
3
3
  export type { GetCampaignStatsLegacyRequest } from "./GetCampaignStatsLegacyRequest.js";
4
4
  export type { GetEmailClientMetricsRequest } from "./GetEmailClientMetricsRequest.js";
5
5
  export type { GetLinkClickMetricsRequest } from "./GetLinkClickMetricsRequest.js";
6
+ export type { GetMetricsBreakdownRequest } from "./GetMetricsBreakdownRequest.js";
6
7
  export type { GetMetricsRequest } from "./GetMetricsRequest.js";
7
8
  export type { GetRecipientsRequest } from "./GetRecipientsRequest.js";
8
9
  export type { GetSequenceMetricsRequest } from "./GetSequenceMetricsRequest.js";
@@ -0,0 +1,8 @@
1
+ export declare const GetMetricsBreakdownRequestBy: {
2
+ readonly Email: "email";
3
+ readonly Sequence: "sequence";
4
+ readonly EmailType: "email_type";
5
+ readonly MailboxProvider: "mailbox_provider";
6
+ readonly RecipientDomain: "recipient_domain";
7
+ };
8
+ export type GetMetricsBreakdownRequestBy = (typeof GetMetricsBreakdownRequestBy)[keyof typeof GetMetricsBreakdownRequestBy];
@@ -0,0 +1,11 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.GetMetricsBreakdownRequestBy = void 0;
5
+ exports.GetMetricsBreakdownRequestBy = {
6
+ Email: "email",
7
+ Sequence: "sequence",
8
+ EmailType: "email_type",
9
+ MailboxProvider: "mailbox_provider",
10
+ RecipientDomain: "recipient_domain",
11
+ };
@@ -0,0 +1,6 @@
1
+ export declare const GetMetricsBreakdownRequestEmailType: {
2
+ readonly Campaign: "campaign";
3
+ readonly Transactional: "transactional";
4
+ readonly Sequence: "sequence";
5
+ };
6
+ export type GetMetricsBreakdownRequestEmailType = (typeof GetMetricsBreakdownRequestEmailType)[keyof typeof GetMetricsBreakdownRequestEmailType];
@@ -0,0 +1,9 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.GetMetricsBreakdownRequestEmailType = void 0;
5
+ exports.GetMetricsBreakdownRequestEmailType = {
6
+ Campaign: "campaign",
7
+ Transactional: "transactional",
8
+ Sequence: "sequence",
9
+ };
@@ -0,0 +1,8 @@
1
+ export declare const GetMetricsBreakdownRequestPeriod: {
2
+ readonly OneH: "1h";
3
+ readonly TwentyFourH: "24h";
4
+ readonly SevenD: "7d";
5
+ readonly ThirtyD: "30d";
6
+ readonly NinetyD: "90d";
7
+ };
8
+ export type GetMetricsBreakdownRequestPeriod = (typeof GetMetricsBreakdownRequestPeriod)[keyof typeof GetMetricsBreakdownRequestPeriod];
@@ -0,0 +1,11 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.GetMetricsBreakdownRequestPeriod = void 0;
5
+ exports.GetMetricsBreakdownRequestPeriod = {
6
+ OneH: "1h",
7
+ TwentyFourH: "24h",
8
+ SevenD: "7d",
9
+ ThirtyD: "30d",
10
+ NinetyD: "90d",
11
+ };
@@ -0,0 +1,14 @@
1
+ import type * as Sequenzy from "../../../index.js";
2
+ export interface GetMetricsBreakdownResponse {
3
+ by: string;
4
+ emailType?: string;
5
+ end: Date;
6
+ mailboxProvider?: string;
7
+ /** Applied period, or `custom` when start/end were provided. */
8
+ period?: string;
9
+ recipientDomain?: string;
10
+ rows: Sequenzy.GetMetricsBreakdownResponseRowsItem[];
11
+ source?: string;
12
+ start: Date;
13
+ success: boolean;
14
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,30 @@
1
+ export interface GetMetricsBreakdownResponseRowsItem {
2
+ bounced: number;
3
+ /** Percentage of sent. */
4
+ bounceRate: number;
5
+ clicked: number;
6
+ /** Percentage of delivered. */
7
+ clickRate: number;
8
+ complained: number;
9
+ /** Attributed goal conversions. Provider and domain come from the send each conversion is attributed to. */
10
+ conversions?: number;
11
+ delivered: number;
12
+ /** Percentage of sent. */
13
+ deliveryRate: number;
14
+ /** Secondary label, such as the sequence an email step belongs to. */
15
+ detail?: string | null;
16
+ /** The filter that narrows a later request to this row: `{kind: "source", source: {type, id}}` (pass as `source=<type>:<id>`), `{kind: "email_type", emailType}`, `{kind: "mailbox_provider", mailboxProvider}` or `{kind: "recipient_domain", recipientDomain}`. Null when the row cannot be drilled into. */
17
+ filter?: Record<string, unknown> | null;
18
+ /** Dimension value (an id, email type, provider or domain). Empty when the events predate the column. */
19
+ key: string;
20
+ label: string;
21
+ opened: number;
22
+ /** Percentage of delivered. */
23
+ openRate: number;
24
+ /** Attributed revenue in currency units. */
25
+ revenue?: number;
26
+ sent: number;
27
+ unsubscribed: number;
28
+ /** Percentage of delivered. */
29
+ unsubscribeRate: number;
30
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -8,6 +8,10 @@ export interface GetMetricsResponse {
8
8
  /** Echoed back when `mailboxProvider` is provided. */
9
9
  mailboxProvider?: string;
10
10
  period?: string;
11
+ /** Echoed back, lowercased, when `recipientDomain` is provided. */
12
+ recipientDomain?: string;
13
+ /** Echoed back when `source` is provided. */
14
+ source?: string;
11
15
  stats?: Sequenzy.EngagementStats;
12
16
  /** Live count of every stored contact in the company. Independent of the requested period. */
13
17
  subscriberCount?: number;
@@ -11,6 +11,11 @@ export * from "./GetLinkClickMetricsRequestEmailType.js";
11
11
  export * from "./GetLinkClickMetricsRequestPeriod.js";
12
12
  export * from "./GetLinkClickMetricsResponse.js";
13
13
  export * from "./GetLinkClickMetricsResponseEmailType.js";
14
+ export * from "./GetMetricsBreakdownRequestBy.js";
15
+ export * from "./GetMetricsBreakdownRequestEmailType.js";
16
+ export * from "./GetMetricsBreakdownRequestPeriod.js";
17
+ export * from "./GetMetricsBreakdownResponse.js";
18
+ export * from "./GetMetricsBreakdownResponseRowsItem.js";
14
19
  export * from "./GetMetricsRequestEmailType.js";
15
20
  export * from "./GetMetricsRequestPeriod.js";
16
21
  export * from "./GetMetricsResponse.js";
@@ -27,6 +27,11 @@ __exportStar(require("./GetLinkClickMetricsRequestEmailType.js"), exports);
27
27
  __exportStar(require("./GetLinkClickMetricsRequestPeriod.js"), exports);
28
28
  __exportStar(require("./GetLinkClickMetricsResponse.js"), exports);
29
29
  __exportStar(require("./GetLinkClickMetricsResponseEmailType.js"), exports);
30
+ __exportStar(require("./GetMetricsBreakdownRequestBy.js"), exports);
31
+ __exportStar(require("./GetMetricsBreakdownRequestEmailType.js"), exports);
32
+ __exportStar(require("./GetMetricsBreakdownRequestPeriod.js"), exports);
33
+ __exportStar(require("./GetMetricsBreakdownResponse.js"), exports);
34
+ __exportStar(require("./GetMetricsBreakdownResponseRowsItem.js"), exports);
30
35
  __exportStar(require("./GetMetricsRequestEmailType.js"), exports);
31
36
  __exportStar(require("./GetMetricsRequestPeriod.js"), exports);
32
37
  __exportStar(require("./GetMetricsResponse.js"), exports);
@@ -182,6 +182,23 @@ export declare class IntegrationsClient {
182
182
  */
183
183
  listCapabilities(request?: Sequenzy.ListCapabilitiesIntegrationsRequest, requestOptions?: IntegrationsClient.RequestOptions): core.HttpResponsePromise<Sequenzy.ListCapabilitiesIntegrationsResponse>;
184
184
  private __listCapabilities;
185
+ /**
186
+ * Suggests integrations to connect next, from what Sequenzy found on the company's website during onboarding: tools on the homepage or on the sign-in page it links to (Clerk, Supabase, PostHog, Segment, Webflow, Wix, WordPress, WooCommerce) or a Shopify storefront. Connected providers are left out. Payment providers are never guessed from the site: when it lists pricing and no payment or commerce integration is connected, paymentProviders lists every payment provider. Requires the account:read scope.
187
+ *
188
+ * @param {IntegrationsClient.RequestOptions} requestOptions - Request-specific configuration.
189
+ *
190
+ * @throws {@link Sequenzy.UnauthorizedError}
191
+ * @throws {@link Sequenzy.ForbiddenError}
192
+ * @throws {@link Sequenzy.NotFoundError}
193
+ * @throws {@link Sequenzy.ServiceUnavailableError}
194
+ * @throws {@link errors.SequenzyError}
195
+ * @throws {@link errors.SequenzyTimeoutError}
196
+ *
197
+ * @example
198
+ * await client.integrations.listSuggestions()
199
+ */
200
+ listSuggestions(requestOptions?: IntegrationsClient.RequestOptions): core.HttpResponsePromise<Sequenzy.ListSuggestionsIntegrationsResponse>;
201
+ private __listSuggestions;
185
202
  /**
186
203
  * Queues a manual re-sync for a connected integration - customers and revenue for a payment provider (Stripe, Polar, Paddle, Dodo, Lemon Squeezy, Creem, Chargebee, Whop), the user backfill for Supabase, or the event-history import for PostHog and Segment. The Supabase sync reads the project, schema, and table already configured for the integration and returns 400 when none is configured. PostHog and Segment re-run their event-history imports with credentials stored at connect time and are the supported retry path for failed imports; each restarts from the beginning, already-imported events dedupe, and returns 409 while queued or syncing. Segment requires a saved Unify space ID and Profile API token and covers the most recent 14 days served by the Profile API. Terminal BullMQ failures release imports for retry. Returns immediately; poll the integration to watch syncStatus. Other providers re-sync from the dashboard. Requires the integrations:manage scope.
187
204
  *