ark-email 0.18.0 → 0.19.0

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 (505) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +22 -0
  3. data/README.md +9 -9
  4. data/lib/ark_email/client.rb +8 -16
  5. data/lib/ark_email/internal/util.rb +1 -1
  6. data/lib/ark_email/models/email_counts.rb +58 -0
  7. data/lib/ark_email/models/email_rates.rb +26 -0
  8. data/lib/ark_email/models/email_retrieve_deliveries_response.rb +2 -2
  9. data/lib/ark_email/models/{webhook_delete_params.rb → limit_retrieve_params.rb} +2 -2
  10. data/lib/ark_email/models/{tracking_retrieve_response.rb → limit_retrieve_response.rb} +10 -5
  11. data/lib/ark_email/models/limits_data.rb +234 -0
  12. data/lib/ark_email/models/org_usage_summary.rb +93 -0
  13. data/lib/ark_email/models/platform/webhook_create_params.rb +57 -0
  14. data/lib/ark_email/models/platform/webhook_create_response.rb +105 -0
  15. data/lib/ark_email/models/platform/webhook_delete_params.rb +16 -0
  16. data/lib/ark_email/models/platform/webhook_delete_response.rb +41 -0
  17. data/lib/ark_email/models/platform/webhook_list_deliveries_params.rb +97 -0
  18. data/lib/ark_email/models/platform/webhook_list_deliveries_response.rb +112 -0
  19. data/lib/ark_email/models/platform/webhook_list_params.rb +16 -0
  20. data/lib/ark_email/models/platform/webhook_list_response.rb +77 -0
  21. data/lib/ark_email/models/platform/webhook_replay_delivery_params.rb +16 -0
  22. data/lib/ark_email/models/platform/webhook_replay_delivery_response.rb +84 -0
  23. data/lib/ark_email/models/platform/webhook_retrieve_delivery_params.rb +16 -0
  24. data/lib/ark_email/models/platform/webhook_retrieve_delivery_response.rb +182 -0
  25. data/lib/ark_email/models/platform/webhook_retrieve_params.rb +16 -0
  26. data/lib/ark_email/models/platform/webhook_retrieve_response.rb +105 -0
  27. data/lib/ark_email/models/platform/webhook_test_params.rb +41 -0
  28. data/lib/ark_email/models/platform/webhook_test_response.rb +66 -0
  29. data/lib/ark_email/models/platform/webhook_update_params.rb +65 -0
  30. data/lib/ark_email/models/platform/webhook_update_response.rb +105 -0
  31. data/lib/ark_email/models/tenant.rb +2 -2
  32. data/lib/ark_email/models/tenant_usage_item.rb +73 -0
  33. data/lib/ark_email/models/tenants/credential_create_params.rb +53 -0
  34. data/lib/ark_email/models/tenants/credential_create_response.rb +131 -0
  35. data/lib/ark_email/models/tenants/credential_delete_params.rb +22 -0
  36. data/lib/ark_email/models/tenants/credential_delete_response.rb +41 -0
  37. data/lib/ark_email/models/tenants/credential_list_params.rb +51 -0
  38. data/lib/ark_email/models/tenants/credential_list_response.rb +90 -0
  39. data/lib/ark_email/models/tenants/credential_retrieve_params.rb +31 -0
  40. data/lib/ark_email/models/tenants/credential_retrieve_response.rb +133 -0
  41. data/lib/ark_email/models/tenants/credential_update_params.rb +43 -0
  42. data/lib/ark_email/models/tenants/credential_update_response.rb +133 -0
  43. data/lib/ark_email/models/tenants/dns_record.rb +113 -0
  44. data/lib/ark_email/models/tenants/domain_create_params.rb +24 -0
  45. data/lib/ark_email/models/tenants/domain_create_response.rb +221 -0
  46. data/lib/ark_email/models/tenants/domain_delete_params.rb +22 -0
  47. data/lib/ark_email/models/tenants/domain_delete_response.rb +41 -0
  48. data/lib/ark_email/models/tenants/domain_list_params.rb +16 -0
  49. data/lib/ark_email/models/tenants/domain_list_response.rb +89 -0
  50. data/lib/ark_email/models/tenants/domain_retrieve_params.rb +22 -0
  51. data/lib/ark_email/models/tenants/domain_retrieve_response.rb +221 -0
  52. data/lib/ark_email/models/tenants/domain_verify_params.rb +22 -0
  53. data/lib/ark_email/models/tenants/domain_verify_response.rb +221 -0
  54. data/lib/ark_email/models/tenants/suppression_create_params.rb +32 -0
  55. data/lib/ark_email/models/tenants/suppression_create_response.rb +64 -0
  56. data/lib/ark_email/models/tenants/suppression_delete_params.rb +22 -0
  57. data/lib/ark_email/models/tenants/suppression_delete_response.rb +41 -0
  58. data/lib/ark_email/models/tenants/suppression_list_params.rb +28 -0
  59. data/lib/ark_email/models/tenants/suppression_list_response.rb +40 -0
  60. data/lib/ark_email/models/tenants/suppression_retrieve_params.rb +22 -0
  61. data/lib/ark_email/models/tenants/suppression_retrieve_response.rb +66 -0
  62. data/lib/ark_email/models/tenants/tenant_usage.rb +62 -0
  63. data/lib/ark_email/models/tenants/tenant_usage_timeseries.rb +130 -0
  64. data/lib/ark_email/models/tenants/track_domain.rb +186 -0
  65. data/lib/ark_email/models/tenants/tracking_create_params.rb +56 -0
  66. data/lib/ark_email/models/tenants/tracking_create_response.rb +30 -0
  67. data/lib/ark_email/models/tenants/tracking_delete_params.rb +22 -0
  68. data/lib/ark_email/models/tenants/tracking_delete_response.rb +41 -0
  69. data/lib/ark_email/models/tenants/tracking_list_params.rb +16 -0
  70. data/lib/ark_email/models/tenants/tracking_list_response.rb +43 -0
  71. data/lib/ark_email/models/tenants/tracking_retrieve_params.rb +22 -0
  72. data/lib/ark_email/models/tenants/tracking_retrieve_response.rb +30 -0
  73. data/lib/ark_email/models/tenants/tracking_update_params.rb +55 -0
  74. data/lib/ark_email/models/tenants/tracking_update_response.rb +30 -0
  75. data/lib/ark_email/models/tenants/tracking_verify_params.rb +22 -0
  76. data/lib/ark_email/models/tenants/tracking_verify_response.rb +135 -0
  77. data/lib/ark_email/models/tenants/usage_retrieve_params.rb +43 -0
  78. data/lib/ark_email/models/tenants/usage_retrieve_response.rb +35 -0
  79. data/lib/ark_email/models/tenants/usage_retrieve_timeseries_params.rb +53 -0
  80. data/lib/ark_email/models/tenants/usage_retrieve_timeseries_response.rb +35 -0
  81. data/lib/ark_email/models/tenants/webhook_create_params.rb +88 -0
  82. data/lib/ark_email/models/tenants/webhook_create_response.rb +113 -0
  83. data/lib/ark_email/models/tenants/webhook_delete_params.rb +22 -0
  84. data/lib/ark_email/models/tenants/webhook_delete_response.rb +41 -0
  85. data/lib/ark_email/models/tenants/webhook_list_deliveries_params.rb +88 -0
  86. data/lib/ark_email/models/tenants/webhook_list_deliveries_response.rb +156 -0
  87. data/lib/ark_email/models/tenants/webhook_list_params.rb +16 -0
  88. data/lib/ark_email/models/tenants/webhook_list_response.rb +81 -0
  89. data/lib/ark_email/models/tenants/webhook_replay_delivery_params.rb +28 -0
  90. data/lib/ark_email/models/tenants/webhook_replay_delivery_response.rb +84 -0
  91. data/lib/ark_email/models/tenants/webhook_retrieve_delivery_params.rb +28 -0
  92. data/lib/ark_email/models/tenants/webhook_retrieve_delivery_response.rb +200 -0
  93. data/lib/ark_email/models/tenants/webhook_retrieve_params.rb +22 -0
  94. data/lib/ark_email/models/tenants/webhook_retrieve_response.rb +113 -0
  95. data/lib/ark_email/models/tenants/webhook_test_params.rb +48 -0
  96. data/lib/ark_email/models/tenants/webhook_test_response.rb +82 -0
  97. data/lib/ark_email/models/tenants/webhook_update_params.rb +52 -0
  98. data/lib/ark_email/models/tenants/webhook_update_response.rb +113 -0
  99. data/lib/ark_email/models/usage_export_params.rb +86 -0
  100. data/lib/ark_email/models/usage_export_response.rb +123 -0
  101. data/lib/ark_email/models/usage_list_tenants_params.rb +111 -0
  102. data/lib/ark_email/models/usage_period.rb +26 -0
  103. data/lib/ark_email/models/usage_retrieve_params.rb +27 -1
  104. data/lib/ark_email/models.rb +15 -47
  105. data/lib/ark_email/resources/emails.rb +18 -18
  106. data/lib/ark_email/resources/limits.rb +48 -0
  107. data/lib/ark_email/resources/platform/webhooks.rb +289 -0
  108. data/lib/ark_email/resources/platform.rb +18 -0
  109. data/lib/ark_email/resources/tenants/credentials.rb +194 -0
  110. data/lib/ark_email/resources/tenants/domains.rb +159 -0
  111. data/lib/ark_email/resources/tenants/suppressions.rb +126 -0
  112. data/lib/ark_email/resources/tenants/tracking.rb +203 -0
  113. data/lib/ark_email/resources/tenants/usage.rb +107 -0
  114. data/lib/ark_email/resources/tenants/webhooks.rb +363 -0
  115. data/lib/ark_email/resources/tenants.rb +24 -0
  116. data/lib/ark_email/resources/usage.rb +142 -17
  117. data/lib/ark_email/version.rb +1 -1
  118. data/lib/ark_email.rb +104 -57
  119. data/rbi/ark_email/client.rbi +6 -12
  120. data/rbi/ark_email/internal/util.rbi +1 -1
  121. data/rbi/ark_email/models/email_counts.rbi +78 -0
  122. data/rbi/ark_email/models/email_rates.rbi +38 -0
  123. data/rbi/ark_email/models/email_retrieve_deliveries_response.rbi +2 -2
  124. data/rbi/ark_email/models/{webhook_delete_params.rbi → limit_retrieve_params.rbi} +2 -2
  125. data/rbi/ark_email/models/{tracking_update_response.rbi → limit_retrieve_response.rbi} +14 -7
  126. data/rbi/ark_email/models/limits_data.rbi +374 -0
  127. data/rbi/ark_email/models/org_usage_summary.rbi +165 -0
  128. data/rbi/ark_email/models/platform/webhook_create_params.rbi +145 -0
  129. data/rbi/ark_email/models/platform/webhook_create_response.rbi +215 -0
  130. data/rbi/ark_email/models/platform/webhook_delete_params.rbi +32 -0
  131. data/rbi/ark_email/models/platform/webhook_delete_response.rbi +81 -0
  132. data/rbi/ark_email/models/platform/webhook_list_deliveries_params.rbi +206 -0
  133. data/rbi/ark_email/models/platform/webhook_list_deliveries_response.rbi +186 -0
  134. data/rbi/ark_email/models/platform/webhook_list_params.rbi +32 -0
  135. data/rbi/ark_email/models/platform/webhook_list_response.rbi +124 -0
  136. data/rbi/ark_email/models/platform/webhook_replay_delivery_params.rbi +32 -0
  137. data/rbi/ark_email/models/platform/webhook_replay_delivery_response.rbi +141 -0
  138. data/rbi/ark_email/models/platform/webhook_retrieve_delivery_params.rbi +32 -0
  139. data/rbi/ark_email/models/platform/webhook_retrieve_delivery_response.rbi +315 -0
  140. data/rbi/ark_email/models/platform/webhook_retrieve_params.rbi +32 -0
  141. data/rbi/ark_email/models/platform/webhook_retrieve_response.rbi +217 -0
  142. data/rbi/ark_email/models/platform/webhook_test_params.rbi +110 -0
  143. data/rbi/ark_email/models/platform/webhook_test_response.rbi +117 -0
  144. data/rbi/ark_email/models/platform/webhook_update_params.rbi +162 -0
  145. data/rbi/ark_email/models/platform/webhook_update_response.rbi +215 -0
  146. data/rbi/ark_email/models/tenant_usage_item.rbi +107 -0
  147. data/rbi/ark_email/models/tenants/credential_create_params.rbi +101 -0
  148. data/rbi/ark_email/models/tenants/credential_create_response.rbi +220 -0
  149. data/rbi/ark_email/models/tenants/credential_delete_params.rbi +40 -0
  150. data/rbi/ark_email/models/tenants/credential_delete_response.rbi +83 -0
  151. data/rbi/ark_email/models/tenants/credential_list_params.rbi +113 -0
  152. data/rbi/ark_email/models/tenants/credential_list_response.rbi +142 -0
  153. data/rbi/ark_email/models/tenants/credential_retrieve_params.rbi +57 -0
  154. data/rbi/ark_email/models/tenants/credential_retrieve_response.rbi +227 -0
  155. data/rbi/ark_email/models/tenants/credential_update_params.rbi +70 -0
  156. data/rbi/ark_email/models/tenants/credential_update_response.rbi +227 -0
  157. data/rbi/ark_email/models/tenants/dns_record.rbi +161 -0
  158. data/rbi/ark_email/models/tenants/domain_create_params.rbi +45 -0
  159. data/rbi/ark_email/models/tenants/domain_create_response.rbi +388 -0
  160. data/rbi/ark_email/models/tenants/domain_delete_params.rbi +40 -0
  161. data/rbi/ark_email/models/tenants/domain_delete_response.rbi +79 -0
  162. data/rbi/ark_email/models/tenants/domain_list_params.rbi +32 -0
  163. data/rbi/ark_email/models/tenants/domain_list_response.rbi +176 -0
  164. data/rbi/ark_email/models/tenants/domain_retrieve_params.rbi +40 -0
  165. data/rbi/ark_email/models/tenants/domain_retrieve_response.rbi +390 -0
  166. data/rbi/ark_email/models/tenants/domain_verify_params.rbi +40 -0
  167. data/rbi/ark_email/models/tenants/domain_verify_response.rbi +388 -0
  168. data/rbi/ark_email/models/tenants/suppression_create_params.rbi +56 -0
  169. data/rbi/ark_email/models/tenants/suppression_create_response.rbi +115 -0
  170. data/rbi/ark_email/models/tenants/suppression_delete_params.rbi +40 -0
  171. data/rbi/ark_email/models/tenants/suppression_delete_response.rbi +83 -0
  172. data/rbi/ark_email/models/tenants/suppression_list_params.rbi +54 -0
  173. data/rbi/ark_email/models/tenants/suppression_list_response.rbi +58 -0
  174. data/rbi/ark_email/models/tenants/suppression_retrieve_params.rbi +40 -0
  175. data/rbi/ark_email/models/tenants/suppression_retrieve_response.rbi +122 -0
  176. data/rbi/ark_email/models/tenants/tenant_usage.rbi +91 -0
  177. data/rbi/ark_email/models/tenants/tenant_usage_timeseries.rbi +218 -0
  178. data/rbi/ark_email/models/tenants/track_domain.rbi +255 -0
  179. data/rbi/ark_email/models/tenants/tracking_create_params.rbi +80 -0
  180. data/rbi/ark_email/models/tenants/tracking_create_response.rbi +54 -0
  181. data/rbi/ark_email/models/tenants/tracking_delete_params.rbi +40 -0
  182. data/rbi/ark_email/models/tenants/tracking_delete_response.rbi +81 -0
  183. data/rbi/ark_email/models/tenants/tracking_list_params.rbi +32 -0
  184. data/rbi/ark_email/models/tenants/tracking_list_response.rbi +87 -0
  185. data/rbi/ark_email/models/tenants/tracking_retrieve_params.rbi +40 -0
  186. data/rbi/ark_email/models/tenants/tracking_retrieve_response.rbi +54 -0
  187. data/rbi/ark_email/models/tenants/tracking_update_params.rbi +78 -0
  188. data/rbi/ark_email/models/tenants/tracking_update_response.rbi +54 -0
  189. data/rbi/ark_email/models/tenants/tracking_verify_params.rbi +40 -0
  190. data/rbi/ark_email/models/tenants/tracking_verify_response.rbi +260 -0
  191. data/rbi/ark_email/models/tenants/usage_retrieve_params.rbi +78 -0
  192. data/rbi/ark_email/models/tenants/usage_retrieve_response.rbi +61 -0
  193. data/rbi/ark_email/models/tenants/usage_retrieve_timeseries_params.rbi +131 -0
  194. data/rbi/ark_email/models/tenants/usage_retrieve_timeseries_response.rbi +63 -0
  195. data/rbi/ark_email/models/tenants/webhook_create_params.rbi +175 -0
  196. data/rbi/ark_email/models/tenants/webhook_create_response.rbi +222 -0
  197. data/rbi/ark_email/models/tenants/webhook_delete_params.rbi +40 -0
  198. data/rbi/ark_email/models/tenants/webhook_delete_response.rbi +80 -0
  199. data/rbi/ark_email/models/tenants/webhook_list_deliveries_params.rbi +190 -0
  200. data/rbi/ark_email/models/tenants/webhook_list_deliveries_response.rbi +265 -0
  201. data/rbi/ark_email/models/tenants/webhook_list_params.rbi +32 -0
  202. data/rbi/ark_email/models/tenants/webhook_list_response.rbi +160 -0
  203. data/rbi/ark_email/models/tenants/webhook_replay_delivery_params.rbi +48 -0
  204. data/rbi/ark_email/models/tenants/webhook_replay_delivery_response.rbi +141 -0
  205. data/rbi/ark_email/models/tenants/webhook_retrieve_delivery_params.rbi +48 -0
  206. data/rbi/ark_email/models/tenants/webhook_retrieve_delivery_response.rbi +380 -0
  207. data/rbi/ark_email/models/tenants/webhook_retrieve_params.rbi +40 -0
  208. data/rbi/ark_email/models/tenants/webhook_retrieve_response.rbi +225 -0
  209. data/rbi/ark_email/models/tenants/webhook_test_params.rbi +116 -0
  210. data/rbi/ark_email/models/tenants/webhook_test_response.rbi +133 -0
  211. data/rbi/ark_email/models/tenants/webhook_update_params.rbi +76 -0
  212. data/rbi/ark_email/models/tenants/webhook_update_response.rbi +222 -0
  213. data/rbi/ark_email/models/usage_export_params.rbi +148 -0
  214. data/rbi/ark_email/models/usage_export_response.rbi +177 -0
  215. data/rbi/ark_email/models/usage_list_tenants_params.rbi +228 -0
  216. data/rbi/ark_email/models/usage_period.rbi +34 -0
  217. data/rbi/ark_email/models/usage_retrieve_params.rbi +49 -5
  218. data/rbi/ark_email/models.rbi +15 -48
  219. data/rbi/ark_email/resources/emails.rbi +12 -12
  220. data/rbi/ark_email/resources/limits.rbi +37 -0
  221. data/rbi/ark_email/resources/platform/webhooks.rbi +246 -0
  222. data/rbi/ark_email/resources/platform.rbi +15 -0
  223. data/rbi/ark_email/resources/tenants/credentials.rbi +154 -0
  224. data/rbi/ark_email/resources/tenants/domains.rbi +114 -0
  225. data/rbi/ark_email/resources/tenants/suppressions.rbi +93 -0
  226. data/rbi/ark_email/resources/tenants/tracking.rbi +153 -0
  227. data/rbi/ark_email/resources/tenants/usage.rbi +100 -0
  228. data/rbi/ark_email/resources/tenants/webhooks.rbi +295 -0
  229. data/rbi/ark_email/resources/tenants.rbi +18 -0
  230. data/rbi/ark_email/resources/usage.rbi +149 -16
  231. data/sig/ark_email/client.rbs +4 -8
  232. data/sig/ark_email/models/email_counts.rbs +45 -0
  233. data/sig/ark_email/models/email_rates.rbs +15 -0
  234. data/sig/ark_email/models/{webhook_delete_params.rbs → limit_retrieve_params.rbs} +2 -2
  235. data/sig/ark_email/models/{tracking_update_response.rbs → limit_retrieve_response.rbs} +6 -6
  236. data/sig/ark_email/models/limits_data.rbs +185 -0
  237. data/sig/ark_email/models/org_usage_summary.rbs +85 -0
  238. data/sig/ark_email/models/platform/webhook_create_params.rbs +67 -0
  239. data/sig/ark_email/models/platform/webhook_create_response.rbs +104 -0
  240. data/sig/ark_email/models/platform/webhook_delete_params.rbs +17 -0
  241. data/sig/ark_email/models/platform/webhook_delete_response.rbs +42 -0
  242. data/sig/ark_email/models/platform/webhook_list_deliveries_params.rbs +106 -0
  243. data/sig/ark_email/models/{webhook_list_deliveries_response.rbs → platform/webhook_list_deliveries_response.rbs} +13 -48
  244. data/sig/ark_email/models/platform/webhook_list_params.rbs +17 -0
  245. data/sig/ark_email/models/platform/webhook_list_response.rbs +74 -0
  246. data/sig/ark_email/models/platform/webhook_replay_delivery_params.rbs +17 -0
  247. data/sig/ark_email/models/platform/webhook_replay_delivery_response.rbs +74 -0
  248. data/sig/ark_email/models/platform/webhook_retrieve_delivery_params.rbs +17 -0
  249. data/sig/ark_email/models/platform/webhook_retrieve_delivery_response.rbs +146 -0
  250. data/sig/ark_email/models/platform/webhook_retrieve_params.rbs +17 -0
  251. data/sig/ark_email/models/platform/webhook_retrieve_response.rbs +104 -0
  252. data/sig/ark_email/models/platform/webhook_test_params.rbs +51 -0
  253. data/sig/ark_email/models/platform/webhook_test_response.rbs +64 -0
  254. data/sig/ark_email/models/platform/webhook_update_params.rbs +78 -0
  255. data/sig/ark_email/models/platform/webhook_update_response.rbs +104 -0
  256. data/sig/ark_email/models/tenant_usage_item.rbs +57 -0
  257. data/sig/ark_email/models/tenants/credential_create_params.rbs +44 -0
  258. data/sig/ark_email/models/tenants/credential_create_response.rbs +102 -0
  259. data/sig/ark_email/models/tenants/credential_delete_params.rbs +25 -0
  260. data/sig/ark_email/models/tenants/credential_delete_response.rbs +42 -0
  261. data/sig/ark_email/models/tenants/credential_list_params.rbs +57 -0
  262. data/sig/ark_email/models/tenants/credential_list_response.rbs +63 -0
  263. data/sig/ark_email/models/tenants/credential_retrieve_params.rbs +32 -0
  264. data/sig/ark_email/models/tenants/credential_retrieve_response.rbs +104 -0
  265. data/sig/ark_email/models/tenants/credential_update_params.rbs +38 -0
  266. data/sig/ark_email/models/tenants/credential_update_response.rbs +104 -0
  267. data/sig/ark_email/models/tenants/dns_record.rbs +66 -0
  268. data/sig/ark_email/models/tenants/domain_create_params.rbs +25 -0
  269. data/sig/ark_email/models/tenants/domain_create_response.rbs +127 -0
  270. data/sig/ark_email/models/tenants/domain_delete_params.rbs +25 -0
  271. data/sig/ark_email/models/tenants/domain_delete_response.rbs +42 -0
  272. data/sig/ark_email/models/tenants/domain_list_params.rbs +17 -0
  273. data/sig/ark_email/models/tenants/domain_list_response.rbs +90 -0
  274. data/sig/ark_email/models/tenants/domain_retrieve_params.rbs +25 -0
  275. data/sig/ark_email/models/tenants/domain_retrieve_response.rbs +127 -0
  276. data/sig/ark_email/models/tenants/domain_verify_params.rbs +25 -0
  277. data/sig/ark_email/models/tenants/domain_verify_response.rbs +127 -0
  278. data/sig/ark_email/models/tenants/suppression_create_params.rbs +30 -0
  279. data/sig/ark_email/models/tenants/suppression_create_response.rbs +61 -0
  280. data/sig/ark_email/models/tenants/suppression_delete_params.rbs +25 -0
  281. data/sig/ark_email/models/tenants/suppression_delete_response.rbs +42 -0
  282. data/sig/ark_email/models/tenants/suppression_list_params.rbs +34 -0
  283. data/sig/ark_email/models/tenants/suppression_list_response.rbs +34 -0
  284. data/sig/ark_email/models/tenants/suppression_retrieve_params.rbs +25 -0
  285. data/sig/ark_email/models/tenants/suppression_retrieve_response.rbs +64 -0
  286. data/sig/ark_email/models/tenants/tenant_usage.rbs +49 -0
  287. data/sig/ark_email/models/tenants/tenant_usage_timeseries.rbs +104 -0
  288. data/sig/ark_email/models/tenants/track_domain.rbs +124 -0
  289. data/sig/ark_email/models/tenants/tracking_create_params.rbs +48 -0
  290. data/sig/ark_email/models/tenants/tracking_create_response.rbs +32 -0
  291. data/sig/ark_email/models/tenants/tracking_delete_params.rbs +25 -0
  292. data/sig/ark_email/models/tenants/tracking_delete_response.rbs +42 -0
  293. data/sig/ark_email/models/tenants/tracking_list_params.rbs +17 -0
  294. data/sig/ark_email/models/tenants/tracking_list_response.rbs +46 -0
  295. data/sig/ark_email/models/tenants/tracking_retrieve_params.rbs +25 -0
  296. data/sig/ark_email/models/tenants/tracking_retrieve_response.rbs +32 -0
  297. data/sig/ark_email/models/tenants/tracking_update_params.rbs +48 -0
  298. data/sig/ark_email/models/tenants/tracking_update_response.rbs +32 -0
  299. data/sig/ark_email/models/tenants/tracking_verify_params.rbs +25 -0
  300. data/sig/ark_email/models/tenants/tracking_verify_response.rbs +115 -0
  301. data/sig/ark_email/models/tenants/usage_retrieve_params.rbs +34 -0
  302. data/sig/ark_email/models/tenants/usage_retrieve_response.rbs +32 -0
  303. data/sig/ark_email/models/tenants/usage_retrieve_timeseries_params.rbs +59 -0
  304. data/sig/ark_email/models/tenants/usage_retrieve_timeseries_response.rbs +32 -0
  305. data/sig/ark_email/models/tenants/webhook_create_params.rbs +73 -0
  306. data/sig/ark_email/models/tenants/webhook_create_response.rbs +109 -0
  307. data/sig/ark_email/models/tenants/webhook_delete_params.rbs +25 -0
  308. data/sig/ark_email/models/tenants/webhook_delete_response.rbs +42 -0
  309. data/sig/ark_email/models/tenants/webhook_list_deliveries_params.rbs +97 -0
  310. data/sig/ark_email/models/tenants/webhook_list_deliveries_response.rbs +129 -0
  311. data/sig/ark_email/models/tenants/webhook_list_params.rbs +17 -0
  312. data/sig/ark_email/models/tenants/webhook_list_response.rbs +86 -0
  313. data/sig/ark_email/models/tenants/webhook_replay_delivery_params.rbs +30 -0
  314. data/sig/ark_email/models/tenants/webhook_replay_delivery_response.rbs +74 -0
  315. data/sig/ark_email/models/tenants/webhook_retrieve_delivery_params.rbs +30 -0
  316. data/sig/ark_email/models/tenants/webhook_retrieve_delivery_response.rbs +160 -0
  317. data/sig/ark_email/models/tenants/webhook_retrieve_params.rbs +25 -0
  318. data/sig/ark_email/models/tenants/webhook_retrieve_response.rbs +109 -0
  319. data/sig/ark_email/models/tenants/webhook_test_params.rbs +58 -0
  320. data/sig/ark_email/models/tenants/webhook_test_response.rbs +74 -0
  321. data/sig/ark_email/models/tenants/webhook_update_params.rbs +53 -0
  322. data/sig/ark_email/models/tenants/webhook_update_response.rbs +109 -0
  323. data/sig/ark_email/models/usage_export_params.rbs +83 -0
  324. data/sig/ark_email/models/usage_export_response.rbs +92 -0
  325. data/sig/ark_email/models/usage_list_tenants_params.rbs +115 -0
  326. data/sig/ark_email/models/usage_period.rbs +15 -0
  327. data/sig/ark_email/models/usage_retrieve_params.rbs +20 -3
  328. data/sig/ark_email/models.rbs +15 -47
  329. data/sig/ark_email/resources/emails.rbs +3 -3
  330. data/sig/ark_email/resources/limits.rbs +11 -0
  331. data/sig/ark_email/resources/platform/webhooks.rbs +67 -0
  332. data/sig/ark_email/resources/platform.rbs +9 -0
  333. data/sig/ark_email/resources/tenants/credentials.rbs +45 -0
  334. data/sig/ark_email/resources/tenants/domains.rbs +38 -0
  335. data/sig/ark_email/resources/tenants/suppressions.rbs +35 -0
  336. data/sig/ark_email/resources/tenants/tracking.rbs +52 -0
  337. data/sig/ark_email/resources/tenants/usage.rbs +24 -0
  338. data/sig/ark_email/resources/tenants/webhooks.rbs +80 -0
  339. data/sig/ark_email/resources/tenants.rbs +12 -0
  340. data/sig/ark_email/resources/usage.rbs +23 -1
  341. metadata +314 -173
  342. data/lib/ark_email/models/dns_record.rb +0 -111
  343. data/lib/ark_email/models/domain_create_params.rb +0 -22
  344. data/lib/ark_email/models/domain_create_response.rb +0 -202
  345. data/lib/ark_email/models/domain_delete_params.rb +0 -14
  346. data/lib/ark_email/models/domain_delete_response.rb +0 -39
  347. data/lib/ark_email/models/domain_list_params.rb +0 -14
  348. data/lib/ark_email/models/domain_list_response.rb +0 -71
  349. data/lib/ark_email/models/domain_retrieve_params.rb +0 -14
  350. data/lib/ark_email/models/domain_retrieve_response.rb +0 -202
  351. data/lib/ark_email/models/domain_verify_params.rb +0 -14
  352. data/lib/ark_email/models/domain_verify_response.rb +0 -202
  353. data/lib/ark_email/models/suppression_bulk_create_params.rb +0 -39
  354. data/lib/ark_email/models/suppression_bulk_create_response.rb +0 -64
  355. data/lib/ark_email/models/suppression_create_params.rb +0 -30
  356. data/lib/ark_email/models/suppression_create_response.rb +0 -62
  357. data/lib/ark_email/models/suppression_delete_params.rb +0 -14
  358. data/lib/ark_email/models/suppression_delete_response.rb +0 -39
  359. data/lib/ark_email/models/suppression_list_params.rb +0 -26
  360. data/lib/ark_email/models/suppression_list_response.rb +0 -38
  361. data/lib/ark_email/models/suppression_retrieve_params.rb +0 -14
  362. data/lib/ark_email/models/suppression_retrieve_response.rb +0 -64
  363. data/lib/ark_email/models/track_domain.rb +0 -176
  364. data/lib/ark_email/models/tracking_create_params.rb +0 -54
  365. data/lib/ark_email/models/tracking_create_response.rb +0 -28
  366. data/lib/ark_email/models/tracking_delete_params.rb +0 -14
  367. data/lib/ark_email/models/tracking_delete_response.rb +0 -39
  368. data/lib/ark_email/models/tracking_list_params.rb +0 -14
  369. data/lib/ark_email/models/tracking_list_response.rb +0 -41
  370. data/lib/ark_email/models/tracking_retrieve_params.rb +0 -14
  371. data/lib/ark_email/models/tracking_update_params.rb +0 -46
  372. data/lib/ark_email/models/tracking_update_response.rb +0 -28
  373. data/lib/ark_email/models/tracking_verify_params.rb +0 -14
  374. data/lib/ark_email/models/tracking_verify_response.rb +0 -133
  375. data/lib/ark_email/models/usage_retrieve_response.rb +0 -270
  376. data/lib/ark_email/models/webhook_create_params.rb +0 -84
  377. data/lib/ark_email/models/webhook_create_response.rb +0 -111
  378. data/lib/ark_email/models/webhook_delete_response.rb +0 -39
  379. data/lib/ark_email/models/webhook_list_deliveries_params.rb +0 -79
  380. data/lib/ark_email/models/webhook_list_deliveries_response.rb +0 -154
  381. data/lib/ark_email/models/webhook_list_params.rb +0 -14
  382. data/lib/ark_email/models/webhook_list_response.rb +0 -79
  383. data/lib/ark_email/models/webhook_replay_delivery_params.rb +0 -20
  384. data/lib/ark_email/models/webhook_replay_delivery_response.rb +0 -82
  385. data/lib/ark_email/models/webhook_retrieve_delivery_params.rb +0 -20
  386. data/lib/ark_email/models/webhook_retrieve_delivery_response.rb +0 -198
  387. data/lib/ark_email/models/webhook_retrieve_params.rb +0 -14
  388. data/lib/ark_email/models/webhook_retrieve_response.rb +0 -111
  389. data/lib/ark_email/models/webhook_test_params.rb +0 -39
  390. data/lib/ark_email/models/webhook_test_response.rb +0 -80
  391. data/lib/ark_email/models/webhook_update_params.rb +0 -44
  392. data/lib/ark_email/models/webhook_update_response.rb +0 -111
  393. data/lib/ark_email/resources/domains.rb +0 -127
  394. data/lib/ark_email/resources/suppressions.rb +0 -124
  395. data/lib/ark_email/resources/tracking.rb +0 -167
  396. data/lib/ark_email/resources/webhooks.rb +0 -302
  397. data/rbi/ark_email/models/dns_record.rbi +0 -146
  398. data/rbi/ark_email/models/domain_create_params.rbi +0 -40
  399. data/rbi/ark_email/models/domain_create_response.rbi +0 -354
  400. data/rbi/ark_email/models/domain_delete_params.rbi +0 -27
  401. data/rbi/ark_email/models/domain_delete_response.rbi +0 -75
  402. data/rbi/ark_email/models/domain_list_params.rbi +0 -27
  403. data/rbi/ark_email/models/domain_list_response.rbi +0 -138
  404. data/rbi/ark_email/models/domain_retrieve_params.rbi +0 -27
  405. data/rbi/ark_email/models/domain_retrieve_response.rbi +0 -358
  406. data/rbi/ark_email/models/domain_verify_params.rbi +0 -27
  407. data/rbi/ark_email/models/domain_verify_response.rbi +0 -354
  408. data/rbi/ark_email/models/suppression_bulk_create_params.rbi +0 -80
  409. data/rbi/ark_email/models/suppression_bulk_create_response.rbi +0 -115
  410. data/rbi/ark_email/models/suppression_create_params.rbi +0 -51
  411. data/rbi/ark_email/models/suppression_create_response.rbi +0 -109
  412. data/rbi/ark_email/models/suppression_delete_params.rbi +0 -27
  413. data/rbi/ark_email/models/suppression_delete_response.rbi +0 -77
  414. data/rbi/ark_email/models/suppression_list_params.rbi +0 -49
  415. data/rbi/ark_email/models/suppression_list_response.rbi +0 -56
  416. data/rbi/ark_email/models/suppression_retrieve_params.rbi +0 -30
  417. data/rbi/ark_email/models/suppression_retrieve_response.rbi +0 -115
  418. data/rbi/ark_email/models/track_domain.rbi +0 -230
  419. data/rbi/ark_email/models/tracking_create_params.rbi +0 -75
  420. data/rbi/ark_email/models/tracking_create_response.rbi +0 -52
  421. data/rbi/ark_email/models/tracking_delete_params.rbi +0 -27
  422. data/rbi/ark_email/models/tracking_delete_response.rbi +0 -77
  423. data/rbi/ark_email/models/tracking_list_params.rbi +0 -27
  424. data/rbi/ark_email/models/tracking_list_response.rbi +0 -81
  425. data/rbi/ark_email/models/tracking_retrieve_params.rbi +0 -27
  426. data/rbi/ark_email/models/tracking_retrieve_response.rbi +0 -52
  427. data/rbi/ark_email/models/tracking_update_params.rbi +0 -67
  428. data/rbi/ark_email/models/tracking_verify_params.rbi +0 -27
  429. data/rbi/ark_email/models/tracking_verify_response.rbi +0 -254
  430. data/rbi/ark_email/models/usage_retrieve_response.rbi +0 -511
  431. data/rbi/ark_email/models/webhook_create_params.rbi +0 -158
  432. data/rbi/ark_email/models/webhook_create_response.rbi +0 -217
  433. data/rbi/ark_email/models/webhook_delete_response.rbi +0 -75
  434. data/rbi/ark_email/models/webhook_list_deliveries_params.rbi +0 -172
  435. data/rbi/ark_email/models/webhook_list_deliveries_response.rbi +0 -257
  436. data/rbi/ark_email/models/webhook_list_params.rbi +0 -27
  437. data/rbi/ark_email/models/webhook_list_response.rbi +0 -152
  438. data/rbi/ark_email/models/webhook_replay_delivery_params.rbi +0 -38
  439. data/rbi/ark_email/models/webhook_replay_delivery_response.rbi +0 -132
  440. data/rbi/ark_email/models/webhook_retrieve_delivery_params.rbi +0 -38
  441. data/rbi/ark_email/models/webhook_retrieve_delivery_response.rbi +0 -371
  442. data/rbi/ark_email/models/webhook_retrieve_params.rbi +0 -27
  443. data/rbi/ark_email/models/webhook_retrieve_response.rbi +0 -219
  444. data/rbi/ark_email/models/webhook_test_params.rbi +0 -95
  445. data/rbi/ark_email/models/webhook_test_response.rbi +0 -129
  446. data/rbi/ark_email/models/webhook_update_params.rbi +0 -65
  447. data/rbi/ark_email/models/webhook_update_response.rbi +0 -217
  448. data/rbi/ark_email/resources/domains.rbi +0 -84
  449. data/rbi/ark_email/resources/suppressions.rbi +0 -84
  450. data/rbi/ark_email/resources/tracking.rbi +0 -130
  451. data/rbi/ark_email/resources/webhooks.rbi +0 -244
  452. data/sig/ark_email/models/dns_record.rbs +0 -64
  453. data/sig/ark_email/models/domain_create_params.rbs +0 -23
  454. data/sig/ark_email/models/domain_create_response.rbs +0 -111
  455. data/sig/ark_email/models/domain_delete_params.rbs +0 -15
  456. data/sig/ark_email/models/domain_delete_response.rbs +0 -40
  457. data/sig/ark_email/models/domain_list_params.rbs +0 -15
  458. data/sig/ark_email/models/domain_list_response.rbs +0 -59
  459. data/sig/ark_email/models/domain_retrieve_params.rbs +0 -15
  460. data/sig/ark_email/models/domain_retrieve_response.rbs +0 -111
  461. data/sig/ark_email/models/domain_verify_params.rbs +0 -15
  462. data/sig/ark_email/models/domain_verify_response.rbs +0 -111
  463. data/sig/ark_email/models/suppression_bulk_create_params.rbs +0 -38
  464. data/sig/ark_email/models/suppression_bulk_create_response.rbs +0 -62
  465. data/sig/ark_email/models/suppression_create_params.rbs +0 -28
  466. data/sig/ark_email/models/suppression_create_response.rbs +0 -59
  467. data/sig/ark_email/models/suppression_delete_params.rbs +0 -15
  468. data/sig/ark_email/models/suppression_delete_response.rbs +0 -40
  469. data/sig/ark_email/models/suppression_list_params.rbs +0 -32
  470. data/sig/ark_email/models/suppression_list_response.rbs +0 -32
  471. data/sig/ark_email/models/suppression_retrieve_params.rbs +0 -15
  472. data/sig/ark_email/models/suppression_retrieve_response.rbs +0 -62
  473. data/sig/ark_email/models/track_domain.rbs +0 -122
  474. data/sig/ark_email/models/tracking_create_params.rbs +0 -46
  475. data/sig/ark_email/models/tracking_create_response.rbs +0 -26
  476. data/sig/ark_email/models/tracking_delete_params.rbs +0 -15
  477. data/sig/ark_email/models/tracking_delete_response.rbs +0 -40
  478. data/sig/ark_email/models/tracking_list_params.rbs +0 -15
  479. data/sig/ark_email/models/tracking_list_response.rbs +0 -40
  480. data/sig/ark_email/models/tracking_retrieve_params.rbs +0 -15
  481. data/sig/ark_email/models/tracking_retrieve_response.rbs +0 -26
  482. data/sig/ark_email/models/tracking_update_params.rbs +0 -41
  483. data/sig/ark_email/models/tracking_verify_params.rbs +0 -15
  484. data/sig/ark_email/models/tracking_verify_response.rbs +0 -109
  485. data/sig/ark_email/models/usage_retrieve_response.rbs +0 -212
  486. data/sig/ark_email/models/webhook_create_params.rbs +0 -71
  487. data/sig/ark_email/models/webhook_create_response.rbs +0 -107
  488. data/sig/ark_email/models/webhook_delete_response.rbs +0 -40
  489. data/sig/ark_email/models/webhook_list_deliveries_params.rbs +0 -90
  490. data/sig/ark_email/models/webhook_list_params.rbs +0 -15
  491. data/sig/ark_email/models/webhook_list_response.rbs +0 -84
  492. data/sig/ark_email/models/webhook_replay_delivery_params.rbs +0 -23
  493. data/sig/ark_email/models/webhook_replay_delivery_response.rbs +0 -72
  494. data/sig/ark_email/models/webhook_retrieve_delivery_params.rbs +0 -23
  495. data/sig/ark_email/models/webhook_retrieve_delivery_response.rbs +0 -158
  496. data/sig/ark_email/models/webhook_retrieve_params.rbs +0 -15
  497. data/sig/ark_email/models/webhook_retrieve_response.rbs +0 -107
  498. data/sig/ark_email/models/webhook_test_params.rbs +0 -49
  499. data/sig/ark_email/models/webhook_test_response.rbs +0 -72
  500. data/sig/ark_email/models/webhook_update_params.rbs +0 -46
  501. data/sig/ark_email/models/webhook_update_response.rbs +0 -107
  502. data/sig/ark_email/resources/domains.rbs +0 -31
  503. data/sig/ark_email/resources/suppressions.rbs +0 -34
  504. data/sig/ark_email/resources/tracking.rbs +0 -44
  505. data/sig/ark_email/resources/webhooks.rbs +0 -69
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9ad3428e3301ab6c22b19d6447605d4abb3b5a0f73d6cd1ea1b2d02c76b035d7
4
- data.tar.gz: cc21c458f90f3facd542034a35b8a47ce91aa7bbd2343f95f3843b79180c8edb
3
+ metadata.gz: 6255c7791ef262ad25da9374d066c4eeea50052acc0e83258f13a7091a2a2420
4
+ data.tar.gz: 2358b745c8956be0861bbaec0870dd6961aee04c94857b75ac1be0a0c2e88d65
5
5
  SHA512:
6
- metadata.gz: f6411dfd7040c48e15573d99340fb44f7ceead905bba5e49f738e599aec3e9a8b3da56d7e7de8786e39c80b7a2d84e296b3b49e2c99bc6d7f1cafc9522182213
7
- data.tar.gz: 9c2b777d089eba4e1f7c2fc1ec766c9cb37de4aa951e61a43ce7d361cb4051c76b9901ff2cc359ee69bd96a12e9c6325b066d6def183c0e0f3a4345038012fa8
6
+ metadata.gz: 5e2b2d595d3891d689a095f6e57c580796ba0033514c1679d8c6d8f145bd76db7bff8b6c7ced06700b8d3e1aae0cb0dac4aab9316c4d6130ba3c78b5494a9582
7
+ data.tar.gz: 12d2ec03093ce4603a223474bd4ed4939c7cda16dd4546660ff431867c35336836aa282eea11f02a79e138a9b9017bf37984b62fb2ebaa186a576d31418aa6a9
data/CHANGELOG.md CHANGED
@@ -1,5 +1,27 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.19.0 (2026-02-07)
4
+
5
+ Full Changelog: [v0.18.0...v0.19.0](https://github.com/ArkHQ-io/ark-ruby/compare/v0.18.0...v0.19.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** add Credentials endpoint ([e1b4536](https://github.com/ArkHQ-io/ark-ruby/commit/e1b45361e3a4e4cfd9de4648def64e2622baea81))
10
+ * **api:** add Platform webhooks ([56ac161](https://github.com/ArkHQ-io/ark-ruby/commit/56ac1617e16253ec182b5705621159edddb8791c))
11
+ * **api:** endpoint updates ([f492b2e](https://github.com/ArkHQ-io/ark-ruby/commit/f492b2e39082aed03ef6d104a1e3d9695e3d66b6))
12
+ * **api:** standardization improvements ([b187d9b](https://github.com/ArkHQ-io/ark-ruby/commit/b187d9b397de264ac9dbf6d7b882b28e6850ddf6))
13
+ * **api:** tenant usage ([b3aca3d](https://github.com/ArkHQ-io/ark-ruby/commit/b3aca3dfd1957992552c18d94bba4cd6e1db31f3))
14
+
15
+
16
+ ### Bug Fixes
17
+
18
+ * **client:** loosen json header parsing ([209ac67](https://github.com/ArkHQ-io/ark-ruby/commit/209ac6701b972d01b0d83ec8319bb6a36812909d))
19
+
20
+
21
+ ### Chores
22
+
23
+ * **docs:** remove www prefix ([80b201f](https://github.com/ArkHQ-io/ark-ruby/commit/80b201fff6de57f5d2496f488e137ac1535304ef))
24
+
3
25
  ## 0.18.0 (2026-02-03)
4
26
 
5
27
  Full Changelog: [v0.17.0...v0.18.0](https://github.com/ArkHQ-io/ark-ruby/compare/v0.17.0...v0.18.0)
data/README.md CHANGED
@@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
26
26
  <!-- x-release-please-start-version -->
27
27
 
28
28
  ```ruby
29
- gem "ark-email", "~> 0.18.0"
29
+ gem "ark-email", "~> 0.19.0"
30
30
  ```
31
31
 
32
32
  <!-- x-release-please-end -->
@@ -46,7 +46,7 @@ response = ark.emails.send_(
46
46
  subject: "Hello World",
47
47
  to: ["user@example.com"],
48
48
  html: "<h1>Welcome!</h1>",
49
- metadata: {user_id: "usr_123", campaign: "onboarding"},
49
+ metadata: {user_id: "usr_123456", campaign: "onboarding"},
50
50
  tag: "welcome"
51
51
  )
52
52
 
@@ -92,7 +92,7 @@ begin
92
92
  subject: "Hello World",
93
93
  to: ["user@example.com"],
94
94
  html: "<h1>Welcome!</h1>",
95
- metadata: {user_id: "usr_123", campaign: "onboarding"},
95
+ metadata: {user_id: "usr_123456", campaign: "onboarding"},
96
96
  tag: "welcome"
97
97
  )
98
98
  rescue ArkEmail::Errors::APIConnectionError => e
@@ -142,7 +142,7 @@ ark.emails.send_(
142
142
  subject: "Hello World",
143
143
  to: ["user@example.com"],
144
144
  html: "<h1>Welcome!</h1>",
145
- metadata: {user_id: "usr_123", campaign: "onboarding"},
145
+ metadata: {user_id: "usr_123456", campaign: "onboarding"},
146
146
  tag: "welcome",
147
147
  request_options: {max_retries: 5}
148
148
  )
@@ -164,7 +164,7 @@ ark.emails.send_(
164
164
  subject: "Hello World",
165
165
  to: ["user@example.com"],
166
166
  html: "<h1>Welcome!</h1>",
167
- metadata: {user_id: "usr_123", campaign: "onboarding"},
167
+ metadata: {user_id: "usr_123456", campaign: "onboarding"},
168
168
  tag: "welcome",
169
169
  request_options: {timeout: 5}
170
170
  )
@@ -203,7 +203,7 @@ response =
203
203
  subject: "Hello World",
204
204
  to: ["user@example.com"],
205
205
  html: "<h1>Welcome!</h1>",
206
- metadata: {user_id: "usr_123", campaign: "onboarding"},
206
+ metadata: {user_id: "usr_123456", campaign: "onboarding"},
207
207
  tag: "welcome",
208
208
  request_options: {
209
209
  extra_query: {my_query_parameter: value},
@@ -255,7 +255,7 @@ ark.emails.send_(
255
255
  subject: "Hello World",
256
256
  to: ["user@example.com"],
257
257
  html: "<h1>Welcome!</h1>",
258
- metadata: {user_id: "usr_123", campaign: "onboarding"},
258
+ metadata: {user_id: "usr_123456", campaign: "onboarding"},
259
259
  tag: "welcome"
260
260
  )
261
261
  ```
@@ -269,7 +269,7 @@ ark.emails.send_(
269
269
  subject: "Hello World",
270
270
  to: ["user@example.com"],
271
271
  html: "<h1>Welcome!</h1>",
272
- metadata: {user_id: "usr_123", campaign: "onboarding"},
272
+ metadata: {user_id: "usr_123456", campaign: "onboarding"},
273
273
  tag: "welcome"
274
274
  )
275
275
 
@@ -279,7 +279,7 @@ params = ArkEmail::EmailSendParams.new(
279
279
  subject: "Hello World",
280
280
  to: ["user@example.com"],
281
281
  html: "<h1>Welcome!</h1>",
282
- metadata: {user_id: "usr_123", campaign: "onboarding"},
282
+ metadata: {user_id: "usr_123456", campaign: "onboarding"},
283
283
  tag: "welcome"
284
284
  )
285
285
  ark.emails.send_(**params)
@@ -27,27 +27,21 @@ module ArkEmail
27
27
  # @return [ArkEmail::Resources::Emails]
28
28
  attr_reader :emails
29
29
 
30
- # @return [ArkEmail::Resources::Domains]
31
- attr_reader :domains
32
-
33
- # @return [ArkEmail::Resources::Suppressions]
34
- attr_reader :suppressions
35
-
36
- # @return [ArkEmail::Resources::Webhooks]
37
- attr_reader :webhooks
38
-
39
- # @return [ArkEmail::Resources::Tracking]
40
- attr_reader :tracking
41
-
42
30
  # @return [ArkEmail::Resources::Logs]
43
31
  attr_reader :logs
44
32
 
45
33
  # @return [ArkEmail::Resources::Usage]
46
34
  attr_reader :usage
47
35
 
36
+ # @return [ArkEmail::Resources::Limits]
37
+ attr_reader :limits
38
+
48
39
  # @return [ArkEmail::Resources::Tenants]
49
40
  attr_reader :tenants
50
41
 
42
+ # @return [ArkEmail::Resources::Platform]
43
+ attr_reader :platform
44
+
51
45
  # @api private
52
46
  #
53
47
  # @return [Hash{String=>String}]
@@ -102,13 +96,11 @@ module ArkEmail
102
96
  )
103
97
 
104
98
  @emails = ArkEmail::Resources::Emails.new(client: self)
105
- @domains = ArkEmail::Resources::Domains.new(client: self)
106
- @suppressions = ArkEmail::Resources::Suppressions.new(client: self)
107
- @webhooks = ArkEmail::Resources::Webhooks.new(client: self)
108
- @tracking = ArkEmail::Resources::Tracking.new(client: self)
109
99
  @logs = ArkEmail::Resources::Logs.new(client: self)
110
100
  @usage = ArkEmail::Resources::Usage.new(client: self)
101
+ @limits = ArkEmail::Resources::Limits.new(client: self)
111
102
  @tenants = ArkEmail::Resources::Tenants.new(client: self)
103
+ @platform = ArkEmail::Resources::Platform.new(client: self)
112
104
  end
113
105
  end
114
106
  end
@@ -485,7 +485,7 @@ module ArkEmail
485
485
  end
486
486
 
487
487
  # @type [Regexp]
488
- JSON_CONTENT = %r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}
488
+ JSON_CONTENT = %r{^application/(?:[a-zA-Z0-9.-]+\+)?json(?!l)}
489
489
  # @type [Regexp]
490
490
  JSONL_CONTENT = %r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}
491
491
 
@@ -0,0 +1,58 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ArkEmail
4
+ module Models
5
+ class EmailCounts < ArkEmail::Internal::Type::BaseModel
6
+ # @!attribute bounced
7
+ # Emails that bounced
8
+ #
9
+ # @return [Integer]
10
+ required :bounced, Integer
11
+
12
+ # @!attribute delivered
13
+ # Emails successfully delivered
14
+ #
15
+ # @return [Integer]
16
+ required :delivered, Integer
17
+
18
+ # @!attribute hard_failed
19
+ # Emails that hard-failed (permanent failures)
20
+ #
21
+ # @return [Integer]
22
+ required :hard_failed, Integer
23
+
24
+ # @!attribute held
25
+ # Emails currently held for review
26
+ #
27
+ # @return [Integer]
28
+ required :held, Integer
29
+
30
+ # @!attribute sent
31
+ # Total emails sent
32
+ #
33
+ # @return [Integer]
34
+ required :sent, Integer
35
+
36
+ # @!attribute soft_failed
37
+ # Emails that soft-failed (temporary failures, may be retried)
38
+ #
39
+ # @return [Integer]
40
+ required :soft_failed, Integer
41
+
42
+ # @!method initialize(bounced:, delivered:, hard_failed:, held:, sent:, soft_failed:)
43
+ # Email delivery counts
44
+ #
45
+ # @param bounced [Integer] Emails that bounced
46
+ #
47
+ # @param delivered [Integer] Emails successfully delivered
48
+ #
49
+ # @param hard_failed [Integer] Emails that hard-failed (permanent failures)
50
+ #
51
+ # @param held [Integer] Emails currently held for review
52
+ #
53
+ # @param sent [Integer] Total emails sent
54
+ #
55
+ # @param soft_failed [Integer] Emails that soft-failed (temporary failures, may be retried)
56
+ end
57
+ end
58
+ end
@@ -0,0 +1,26 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ArkEmail
4
+ module Models
5
+ class EmailRates < ArkEmail::Internal::Type::BaseModel
6
+ # @!attribute bounce_rate
7
+ # Percentage of sent emails that bounced (0-1)
8
+ #
9
+ # @return [Float]
10
+ required :bounce_rate, Float
11
+
12
+ # @!attribute delivery_rate
13
+ # Percentage of sent emails that were delivered (0-1)
14
+ #
15
+ # @return [Float]
16
+ required :delivery_rate, Float
17
+
18
+ # @!method initialize(bounce_rate:, delivery_rate:)
19
+ # Email delivery rates (as decimals, e.g., 0.95 = 95%)
20
+ #
21
+ # @param bounce_rate [Float] Percentage of sent emails that bounced (0-1)
22
+ #
23
+ # @param delivery_rate [Float] Percentage of sent emails that were delivered (0-1)
24
+ end
25
+ end
26
+ end
@@ -33,7 +33,7 @@ module ArkEmail
33
33
  required :id, String
34
34
 
35
35
  # @!attribute can_retry_manually
36
- # Whether the message can be manually retried via `POST /emails/{id}/retry`.
36
+ # Whether the message can be manually retried via `POST /emails/{emailId}/retry`.
37
37
  # `true` when the raw message content is still available (not expired). Messages
38
38
  # older than the retention period cannot be retried.
39
39
  #
@@ -77,7 +77,7 @@ module ArkEmail
77
77
  #
78
78
  # @param id [String] Message identifier (token)
79
79
  #
80
- # @param can_retry_manually [Boolean] Whether the message can be manually retried via `POST /emails/{id}/retry`.
80
+ # @param can_retry_manually [Boolean] Whether the message can be manually retried via `POST /emails/{emailId}/retry`.
81
81
  #
82
82
  # @param deliveries [Array<ArkEmail::Models::EmailRetrieveDeliveriesResponse::Data::Delivery>] Chronological list of delivery attempts for this message.
83
83
  #
@@ -2,8 +2,8 @@
2
2
 
3
3
  module ArkEmail
4
4
  module Models
5
- # @see ArkEmail::Resources::Webhooks#delete
6
- class WebhookDeleteParams < ArkEmail::Internal::Type::BaseModel
5
+ # @see ArkEmail::Resources::Limits#retrieve
6
+ class LimitRetrieveParams < ArkEmail::Internal::Type::BaseModel
7
7
  extend ArkEmail::Internal::Type::RequestParameters::Converter
8
8
  include ArkEmail::Internal::Type::RequestParameters
9
9
 
@@ -2,12 +2,13 @@
2
2
 
3
3
  module ArkEmail
4
4
  module Models
5
- # @see ArkEmail::Resources::Tracking#retrieve
6
- class TrackingRetrieveResponse < ArkEmail::Internal::Type::BaseModel
5
+ # @see ArkEmail::Resources::Limits#retrieve
6
+ class LimitRetrieveResponse < ArkEmail::Internal::Type::BaseModel
7
7
  # @!attribute data
8
+ # Current usage and limit information
8
9
  #
9
- # @return [ArkEmail::Models::TrackDomain]
10
- required :data, -> { ArkEmail::TrackDomain }
10
+ # @return [ArkEmail::Models::LimitsData]
11
+ required :data, -> { ArkEmail::LimitsData }
11
12
 
12
13
  # @!attribute meta
13
14
  #
@@ -20,8 +21,12 @@ module ArkEmail
20
21
  required :success, const: true
21
22
 
22
23
  # @!method initialize(data:, meta:, success: true)
23
- # @param data [ArkEmail::Models::TrackDomain]
24
+ # Account rate limits and send limits response
25
+ #
26
+ # @param data [ArkEmail::Models::LimitsData] Current usage and limit information
27
+ #
24
28
  # @param meta [ArkEmail::Models::APIMeta]
29
+ #
25
30
  # @param success [Boolean, true]
26
31
  end
27
32
  end
@@ -0,0 +1,234 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ArkEmail
4
+ module Models
5
+ class LimitsData < ArkEmail::Internal::Type::BaseModel
6
+ # @!attribute billing
7
+ # Billing and credit information
8
+ #
9
+ # @return [ArkEmail::Models::LimitsData::Billing, nil]
10
+ required :billing, -> { ArkEmail::LimitsData::Billing }, nil?: true
11
+
12
+ # @!attribute rate_limit
13
+ # API rate limit status
14
+ #
15
+ # @return [ArkEmail::Models::LimitsData::RateLimit]
16
+ required :rate_limit, -> { ArkEmail::LimitsData::RateLimit }, api_name: :rateLimit
17
+
18
+ # @!attribute send_limit
19
+ # Email send limit status (hourly cap)
20
+ #
21
+ # @return [ArkEmail::Models::LimitsData::SendLimit, nil]
22
+ required :send_limit, -> { ArkEmail::LimitsData::SendLimit }, api_name: :sendLimit, nil?: true
23
+
24
+ # @!method initialize(billing:, rate_limit:, send_limit:)
25
+ # Current usage and limit information
26
+ #
27
+ # @param billing [ArkEmail::Models::LimitsData::Billing, nil] Billing and credit information
28
+ #
29
+ # @param rate_limit [ArkEmail::Models::LimitsData::RateLimit] API rate limit status
30
+ #
31
+ # @param send_limit [ArkEmail::Models::LimitsData::SendLimit, nil] Email send limit status (hourly cap)
32
+
33
+ # @see ArkEmail::Models::LimitsData#billing
34
+ class Billing < ArkEmail::Internal::Type::BaseModel
35
+ # @!attribute auto_recharge
36
+ # Auto-recharge configuration
37
+ #
38
+ # @return [ArkEmail::Models::LimitsData::Billing::AutoRecharge]
39
+ required :auto_recharge, -> { ArkEmail::LimitsData::Billing::AutoRecharge }, api_name: :autoRecharge
40
+
41
+ # @!attribute credit_balance
42
+ # Current credit balance as formatted string (e.g., "25.50")
43
+ #
44
+ # @return [String]
45
+ required :credit_balance, String, api_name: :creditBalance
46
+
47
+ # @!attribute credit_balance_cents
48
+ # Current credit balance in cents for precise calculations
49
+ #
50
+ # @return [Integer]
51
+ required :credit_balance_cents, Integer, api_name: :creditBalanceCents
52
+
53
+ # @!attribute has_payment_method
54
+ # Whether a payment method is configured
55
+ #
56
+ # @return [Boolean]
57
+ required :has_payment_method, ArkEmail::Internal::Type::Boolean, api_name: :hasPaymentMethod
58
+
59
+ # @!method initialize(auto_recharge:, credit_balance:, credit_balance_cents:, has_payment_method:)
60
+ # Billing and credit information
61
+ #
62
+ # @param auto_recharge [ArkEmail::Models::LimitsData::Billing::AutoRecharge] Auto-recharge configuration
63
+ #
64
+ # @param credit_balance [String] Current credit balance as formatted string (e.g., "25.50")
65
+ #
66
+ # @param credit_balance_cents [Integer] Current credit balance in cents for precise calculations
67
+ #
68
+ # @param has_payment_method [Boolean] Whether a payment method is configured
69
+
70
+ # @see ArkEmail::Models::LimitsData::Billing#auto_recharge
71
+ class AutoRecharge < ArkEmail::Internal::Type::BaseModel
72
+ # @!attribute amount
73
+ # Amount to recharge when triggered
74
+ #
75
+ # @return [String]
76
+ required :amount, String
77
+
78
+ # @!attribute enabled
79
+ # Whether auto-recharge is enabled
80
+ #
81
+ # @return [Boolean]
82
+ required :enabled, ArkEmail::Internal::Type::Boolean
83
+
84
+ # @!attribute threshold
85
+ # Balance threshold that triggers recharge
86
+ #
87
+ # @return [String]
88
+ required :threshold, String
89
+
90
+ # @!method initialize(amount:, enabled:, threshold:)
91
+ # Auto-recharge configuration
92
+ #
93
+ # @param amount [String] Amount to recharge when triggered
94
+ #
95
+ # @param enabled [Boolean] Whether auto-recharge is enabled
96
+ #
97
+ # @param threshold [String] Balance threshold that triggers recharge
98
+ end
99
+ end
100
+
101
+ # @see ArkEmail::Models::LimitsData#rate_limit
102
+ class RateLimit < ArkEmail::Internal::Type::BaseModel
103
+ # @!attribute limit
104
+ # Maximum requests allowed per period
105
+ #
106
+ # @return [Integer]
107
+ required :limit, Integer
108
+
109
+ # @!attribute period
110
+ # Time period for the limit
111
+ #
112
+ # @return [Symbol, ArkEmail::Models::LimitsData::RateLimit::Period]
113
+ required :period, enum: -> { ArkEmail::LimitsData::RateLimit::Period }
114
+
115
+ # @!attribute remaining
116
+ # Requests remaining in current window
117
+ #
118
+ # @return [Integer]
119
+ required :remaining, Integer
120
+
121
+ # @!attribute reset
122
+ # Unix timestamp when the limit resets
123
+ #
124
+ # @return [Integer]
125
+ required :reset, Integer
126
+
127
+ # @!method initialize(limit:, period:, remaining:, reset:)
128
+ # API rate limit status
129
+ #
130
+ # @param limit [Integer] Maximum requests allowed per period
131
+ #
132
+ # @param period [Symbol, ArkEmail::Models::LimitsData::RateLimit::Period] Time period for the limit
133
+ #
134
+ # @param remaining [Integer] Requests remaining in current window
135
+ #
136
+ # @param reset [Integer] Unix timestamp when the limit resets
137
+
138
+ # Time period for the limit
139
+ #
140
+ # @see ArkEmail::Models::LimitsData::RateLimit#period
141
+ module Period
142
+ extend ArkEmail::Internal::Type::Enum
143
+
144
+ SECOND = :second
145
+
146
+ # @!method self.values
147
+ # @return [Array<Symbol>]
148
+ end
149
+ end
150
+
151
+ # @see ArkEmail::Models::LimitsData#send_limit
152
+ class SendLimit < ArkEmail::Internal::Type::BaseModel
153
+ # @!attribute approaching
154
+ # Whether approaching the limit (>90%)
155
+ #
156
+ # @return [Boolean]
157
+ required :approaching, ArkEmail::Internal::Type::Boolean
158
+
159
+ # @!attribute exceeded
160
+ # Whether the limit has been exceeded
161
+ #
162
+ # @return [Boolean]
163
+ required :exceeded, ArkEmail::Internal::Type::Boolean
164
+
165
+ # @!attribute limit
166
+ # Maximum emails allowed per hour (null = unlimited)
167
+ #
168
+ # @return [Integer, nil]
169
+ required :limit, Integer, nil?: true
170
+
171
+ # @!attribute period
172
+ # Time period for the limit
173
+ #
174
+ # @return [Symbol, ArkEmail::Models::LimitsData::SendLimit::Period]
175
+ required :period, enum: -> { ArkEmail::LimitsData::SendLimit::Period }
176
+
177
+ # @!attribute remaining
178
+ # Emails remaining in current period (null if unlimited)
179
+ #
180
+ # @return [Integer, nil]
181
+ required :remaining, Integer, nil?: true
182
+
183
+ # @!attribute resets_at
184
+ # ISO timestamp when the limit window resets (top of next hour)
185
+ #
186
+ # @return [Time]
187
+ required :resets_at, Time, api_name: :resetsAt
188
+
189
+ # @!attribute usage_percent
190
+ # Usage as a percentage (null if unlimited)
191
+ #
192
+ # @return [Float, nil]
193
+ required :usage_percent, Float, api_name: :usagePercent, nil?: true
194
+
195
+ # @!attribute used
196
+ # Emails sent in current period
197
+ #
198
+ # @return [Integer]
199
+ required :used, Integer
200
+
201
+ # @!method initialize(approaching:, exceeded:, limit:, period:, remaining:, resets_at:, usage_percent:, used:)
202
+ # Email send limit status (hourly cap)
203
+ #
204
+ # @param approaching [Boolean] Whether approaching the limit (>90%)
205
+ #
206
+ # @param exceeded [Boolean] Whether the limit has been exceeded
207
+ #
208
+ # @param limit [Integer, nil] Maximum emails allowed per hour (null = unlimited)
209
+ #
210
+ # @param period [Symbol, ArkEmail::Models::LimitsData::SendLimit::Period] Time period for the limit
211
+ #
212
+ # @param remaining [Integer, nil] Emails remaining in current period (null if unlimited)
213
+ #
214
+ # @param resets_at [Time] ISO timestamp when the limit window resets (top of next hour)
215
+ #
216
+ # @param usage_percent [Float, nil] Usage as a percentage (null if unlimited)
217
+ #
218
+ # @param used [Integer] Emails sent in current period
219
+
220
+ # Time period for the limit
221
+ #
222
+ # @see ArkEmail::Models::LimitsData::SendLimit#period
223
+ module Period
224
+ extend ArkEmail::Internal::Type::Enum
225
+
226
+ HOUR = :hour
227
+
228
+ # @!method self.values
229
+ # @return [Array<Symbol>]
230
+ end
231
+ end
232
+ end
233
+ end
234
+ end
@@ -0,0 +1,93 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ArkEmail
4
+ module Models
5
+ # @see ArkEmail::Resources::Usage#retrieve
6
+ class OrgUsageSummary < ArkEmail::Internal::Type::BaseModel
7
+ # @!attribute data
8
+ #
9
+ # @return [ArkEmail::Models::OrgUsageSummary::Data]
10
+ required :data, -> { ArkEmail::OrgUsageSummary::Data }
11
+
12
+ # @!attribute meta
13
+ #
14
+ # @return [ArkEmail::Models::APIMeta]
15
+ required :meta, -> { ArkEmail::APIMeta }
16
+
17
+ # @!attribute success
18
+ #
19
+ # @return [Boolean, true]
20
+ required :success, const: true
21
+
22
+ # @!method initialize(data:, meta:, success: true)
23
+ # Org-wide usage summary response
24
+ #
25
+ # @param data [ArkEmail::Models::OrgUsageSummary::Data]
26
+ # @param meta [ArkEmail::Models::APIMeta]
27
+ # @param success [Boolean, true]
28
+
29
+ # @see ArkEmail::Models::OrgUsageSummary#data
30
+ class Data < ArkEmail::Internal::Type::BaseModel
31
+ # @!attribute emails
32
+ # Email delivery counts
33
+ #
34
+ # @return [ArkEmail::Models::EmailCounts]
35
+ required :emails, -> { ArkEmail::EmailCounts }
36
+
37
+ # @!attribute period
38
+ # Time period for usage data
39
+ #
40
+ # @return [ArkEmail::Models::UsagePeriod]
41
+ required :period, -> { ArkEmail::UsagePeriod }
42
+
43
+ # @!attribute rates
44
+ # Email delivery rates (as decimals, e.g., 0.95 = 95%)
45
+ #
46
+ # @return [ArkEmail::Models::EmailRates]
47
+ required :rates, -> { ArkEmail::EmailRates }
48
+
49
+ # @!attribute tenants
50
+ #
51
+ # @return [ArkEmail::Models::OrgUsageSummary::Data::Tenants]
52
+ required :tenants, -> { ArkEmail::OrgUsageSummary::Data::Tenants }
53
+
54
+ # @!method initialize(emails:, period:, rates:, tenants:)
55
+ # @param emails [ArkEmail::Models::EmailCounts] Email delivery counts
56
+ #
57
+ # @param period [ArkEmail::Models::UsagePeriod] Time period for usage data
58
+ #
59
+ # @param rates [ArkEmail::Models::EmailRates] Email delivery rates (as decimals, e.g., 0.95 = 95%)
60
+ #
61
+ # @param tenants [ArkEmail::Models::OrgUsageSummary::Data::Tenants]
62
+
63
+ # @see ArkEmail::Models::OrgUsageSummary::Data#tenants
64
+ class Tenants < ArkEmail::Internal::Type::BaseModel
65
+ # @!attribute active
66
+ # Number of active tenants
67
+ #
68
+ # @return [Integer]
69
+ required :active, Integer
70
+
71
+ # @!attribute total
72
+ # Total number of tenants
73
+ #
74
+ # @return [Integer]
75
+ required :total, Integer
76
+
77
+ # @!attribute with_activity
78
+ # Number of tenants with sending activity
79
+ #
80
+ # @return [Integer]
81
+ required :with_activity, Integer, api_name: :withActivity
82
+
83
+ # @!method initialize(active:, total:, with_activity:)
84
+ # @param active [Integer] Number of active tenants
85
+ #
86
+ # @param total [Integer] Total number of tenants
87
+ #
88
+ # @param with_activity [Integer] Number of tenants with sending activity
89
+ end
90
+ end
91
+ end
92
+ end
93
+ end