ark-email 0.5.1

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 (272) hide show
  1. checksums.yaml +7 -0
  2. data/.ignore +2 -0
  3. data/CHANGELOG.md +71 -0
  4. data/README.md +303 -0
  5. data/SECURITY.md +27 -0
  6. data/lib/ark_email/client.rb +102 -0
  7. data/lib/ark_email/errors.rb +228 -0
  8. data/lib/ark_email/file_part.rb +58 -0
  9. data/lib/ark_email/internal/page_number_pagination.rb +121 -0
  10. data/lib/ark_email/internal/transport/base_client.rb +573 -0
  11. data/lib/ark_email/internal/transport/pooled_net_requester.rb +210 -0
  12. data/lib/ark_email/internal/type/array_of.rb +168 -0
  13. data/lib/ark_email/internal/type/base_model.rb +529 -0
  14. data/lib/ark_email/internal/type/base_page.rb +55 -0
  15. data/lib/ark_email/internal/type/boolean.rb +77 -0
  16. data/lib/ark_email/internal/type/converter.rb +327 -0
  17. data/lib/ark_email/internal/type/enum.rb +131 -0
  18. data/lib/ark_email/internal/type/file_input.rb +111 -0
  19. data/lib/ark_email/internal/type/hash_of.rb +188 -0
  20. data/lib/ark_email/internal/type/request_parameters.rb +42 -0
  21. data/lib/ark_email/internal/type/union.rb +237 -0
  22. data/lib/ark_email/internal/type/unknown.rb +81 -0
  23. data/lib/ark_email/internal/util.rb +920 -0
  24. data/lib/ark_email/internal.rb +20 -0
  25. data/lib/ark_email/models/api_meta.rb +16 -0
  26. data/lib/ark_email/models/dns_record.rb +81 -0
  27. data/lib/ark_email/models/domain_create_params.rb +22 -0
  28. data/lib/ark_email/models/domain_create_response.rb +110 -0
  29. data/lib/ark_email/models/domain_delete_params.rb +14 -0
  30. data/lib/ark_email/models/domain_delete_response.rb +39 -0
  31. data/lib/ark_email/models/domain_list_params.rb +14 -0
  32. data/lib/ark_email/models/domain_list_response.rb +72 -0
  33. data/lib/ark_email/models/domain_retrieve_params.rb +14 -0
  34. data/lib/ark_email/models/domain_retrieve_response.rb +110 -0
  35. data/lib/ark_email/models/domain_verify_params.rb +14 -0
  36. data/lib/ark_email/models/domain_verify_response.rb +110 -0
  37. data/lib/ark_email/models/email_list_params.rb +110 -0
  38. data/lib/ark_email/models/email_list_response.rb +108 -0
  39. data/lib/ark_email/models/email_retrieve_deliveries_params.rb +14 -0
  40. data/lib/ark_email/models/email_retrieve_deliveries_response.rb +123 -0
  41. data/lib/ark_email/models/email_retrieve_params.rb +30 -0
  42. data/lib/ark_email/models/email_retrieve_response.rb +285 -0
  43. data/lib/ark_email/models/email_retry_params.rb +14 -0
  44. data/lib/ark_email/models/email_retry_response.rb +39 -0
  45. data/lib/ark_email/models/email_send_batch_params.rb +70 -0
  46. data/lib/ark_email/models/email_send_batch_response.rb +83 -0
  47. data/lib/ark_email/models/email_send_params.rb +149 -0
  48. data/lib/ark_email/models/email_send_raw_params.rb +38 -0
  49. data/lib/ark_email/models/email_send_raw_response.rb +77 -0
  50. data/lib/ark_email/models/email_send_response.rb +77 -0
  51. data/lib/ark_email/models/suppression_bulk_create_params.rb +37 -0
  52. data/lib/ark_email/models/suppression_bulk_create_response.rb +64 -0
  53. data/lib/ark_email/models/suppression_create_params.rb +30 -0
  54. data/lib/ark_email/models/suppression_create_response.rb +62 -0
  55. data/lib/ark_email/models/suppression_delete_params.rb +14 -0
  56. data/lib/ark_email/models/suppression_delete_response.rb +39 -0
  57. data/lib/ark_email/models/suppression_list_params.rb +26 -0
  58. data/lib/ark_email/models/suppression_list_response.rb +38 -0
  59. data/lib/ark_email/models/suppression_retrieve_params.rb +14 -0
  60. data/lib/ark_email/models/suppression_retrieve_response.rb +64 -0
  61. data/lib/ark_email/models/track_domain.rb +172 -0
  62. data/lib/ark_email/models/tracking_create_params.rb +54 -0
  63. data/lib/ark_email/models/tracking_create_response.rb +28 -0
  64. data/lib/ark_email/models/tracking_delete_params.rb +14 -0
  65. data/lib/ark_email/models/tracking_delete_response.rb +39 -0
  66. data/lib/ark_email/models/tracking_list_params.rb +14 -0
  67. data/lib/ark_email/models/tracking_list_response.rb +41 -0
  68. data/lib/ark_email/models/tracking_retrieve_params.rb +14 -0
  69. data/lib/ark_email/models/tracking_retrieve_response.rb +28 -0
  70. data/lib/ark_email/models/tracking_update_params.rb +46 -0
  71. data/lib/ark_email/models/tracking_update_response.rb +28 -0
  72. data/lib/ark_email/models/tracking_verify_params.rb +14 -0
  73. data/lib/ark_email/models/tracking_verify_response.rb +133 -0
  74. data/lib/ark_email/models/webhook_create_params.rb +81 -0
  75. data/lib/ark_email/models/webhook_create_response.rb +111 -0
  76. data/lib/ark_email/models/webhook_delete_params.rb +14 -0
  77. data/lib/ark_email/models/webhook_delete_response.rb +39 -0
  78. data/lib/ark_email/models/webhook_list_params.rb +14 -0
  79. data/lib/ark_email/models/webhook_list_response.rb +79 -0
  80. data/lib/ark_email/models/webhook_retrieve_params.rb +14 -0
  81. data/lib/ark_email/models/webhook_retrieve_response.rb +111 -0
  82. data/lib/ark_email/models/webhook_test_params.rb +39 -0
  83. data/lib/ark_email/models/webhook_test_response.rb +80 -0
  84. data/lib/ark_email/models/webhook_update_params.rb +44 -0
  85. data/lib/ark_email/models/webhook_update_response.rb +111 -0
  86. data/lib/ark_email/models.rb +105 -0
  87. data/lib/ark_email/request_options.rb +77 -0
  88. data/lib/ark_email/resources/domains.rb +127 -0
  89. data/lib/ark_email/resources/emails.rb +263 -0
  90. data/lib/ark_email/resources/suppressions.rb +124 -0
  91. data/lib/ark_email/resources/tracking.rb +167 -0
  92. data/lib/ark_email/resources/webhooks.rb +175 -0
  93. data/lib/ark_email/version.rb +5 -0
  94. data/lib/ark_email.rb +122 -0
  95. data/manifest.yaml +17 -0
  96. data/rbi/ark_email/client.rbi +73 -0
  97. data/rbi/ark_email/errors.rbi +205 -0
  98. data/rbi/ark_email/file_part.rbi +37 -0
  99. data/rbi/ark_email/internal/page_number_pagination.rbi +52 -0
  100. data/rbi/ark_email/internal/transport/base_client.rbi +297 -0
  101. data/rbi/ark_email/internal/transport/pooled_net_requester.rbi +83 -0
  102. data/rbi/ark_email/internal/type/array_of.rbi +104 -0
  103. data/rbi/ark_email/internal/type/base_model.rbi +306 -0
  104. data/rbi/ark_email/internal/type/base_page.rbi +42 -0
  105. data/rbi/ark_email/internal/type/boolean.rbi +58 -0
  106. data/rbi/ark_email/internal/type/converter.rbi +216 -0
  107. data/rbi/ark_email/internal/type/enum.rbi +82 -0
  108. data/rbi/ark_email/internal/type/file_input.rbi +59 -0
  109. data/rbi/ark_email/internal/type/hash_of.rbi +104 -0
  110. data/rbi/ark_email/internal/type/request_parameters.rbi +29 -0
  111. data/rbi/ark_email/internal/type/union.rbi +128 -0
  112. data/rbi/ark_email/internal/type/unknown.rbi +58 -0
  113. data/rbi/ark_email/internal/util.rbi +487 -0
  114. data/rbi/ark_email/internal.rbi +16 -0
  115. data/rbi/ark_email/models/api_meta.rbi +25 -0
  116. data/rbi/ark_email/models/dns_record.rbi +111 -0
  117. data/rbi/ark_email/models/domain_create_params.rbi +40 -0
  118. data/rbi/ark_email/models/domain_create_response.rbi +193 -0
  119. data/rbi/ark_email/models/domain_delete_params.rbi +27 -0
  120. data/rbi/ark_email/models/domain_delete_response.rbi +75 -0
  121. data/rbi/ark_email/models/domain_list_params.rbi +27 -0
  122. data/rbi/ark_email/models/domain_list_response.rbi +144 -0
  123. data/rbi/ark_email/models/domain_retrieve_params.rbi +27 -0
  124. data/rbi/ark_email/models/domain_retrieve_response.rbi +195 -0
  125. data/rbi/ark_email/models/domain_verify_params.rbi +27 -0
  126. data/rbi/ark_email/models/domain_verify_response.rbi +193 -0
  127. data/rbi/ark_email/models/email_list_params.rbi +172 -0
  128. data/rbi/ark_email/models/email_list_response.rbi +164 -0
  129. data/rbi/ark_email/models/email_retrieve_deliveries_params.rbi +30 -0
  130. data/rbi/ark_email/models/email_retrieve_deliveries_response.rbi +220 -0
  131. data/rbi/ark_email/models/email_retrieve_params.rbi +53 -0
  132. data/rbi/ark_email/models/email_retrieve_response.rbi +490 -0
  133. data/rbi/ark_email/models/email_retry_params.rbi +27 -0
  134. data/rbi/ark_email/models/email_retry_response.rbi +75 -0
  135. data/rbi/ark_email/models/email_send_batch_params.rbi +118 -0
  136. data/rbi/ark_email/models/email_send_batch_response.rbi +159 -0
  137. data/rbi/ark_email/models/email_send_params.rbi +229 -0
  138. data/rbi/ark_email/models/email_send_raw_params.rbi +59 -0
  139. data/rbi/ark_email/models/email_send_raw_response.rbi +157 -0
  140. data/rbi/ark_email/models/email_send_response.rbi +153 -0
  141. data/rbi/ark_email/models/suppression_bulk_create_params.rbi +76 -0
  142. data/rbi/ark_email/models/suppression_bulk_create_response.rbi +115 -0
  143. data/rbi/ark_email/models/suppression_create_params.rbi +54 -0
  144. data/rbi/ark_email/models/suppression_create_response.rbi +109 -0
  145. data/rbi/ark_email/models/suppression_delete_params.rbi +27 -0
  146. data/rbi/ark_email/models/suppression_delete_response.rbi +77 -0
  147. data/rbi/ark_email/models/suppression_list_params.rbi +49 -0
  148. data/rbi/ark_email/models/suppression_list_response.rbi +56 -0
  149. data/rbi/ark_email/models/suppression_retrieve_params.rbi +30 -0
  150. data/rbi/ark_email/models/suppression_retrieve_response.rbi +115 -0
  151. data/rbi/ark_email/models/track_domain.rbi +228 -0
  152. data/rbi/ark_email/models/tracking_create_params.rbi +84 -0
  153. data/rbi/ark_email/models/tracking_create_response.rbi +52 -0
  154. data/rbi/ark_email/models/tracking_delete_params.rbi +27 -0
  155. data/rbi/ark_email/models/tracking_delete_response.rbi +77 -0
  156. data/rbi/ark_email/models/tracking_list_params.rbi +27 -0
  157. data/rbi/ark_email/models/tracking_list_response.rbi +81 -0
  158. data/rbi/ark_email/models/tracking_retrieve_params.rbi +27 -0
  159. data/rbi/ark_email/models/tracking_retrieve_response.rbi +52 -0
  160. data/rbi/ark_email/models/tracking_update_params.rbi +79 -0
  161. data/rbi/ark_email/models/tracking_update_response.rbi +52 -0
  162. data/rbi/ark_email/models/tracking_verify_params.rbi +27 -0
  163. data/rbi/ark_email/models/tracking_verify_response.rbi +254 -0
  164. data/rbi/ark_email/models/webhook_create_params.rbi +154 -0
  165. data/rbi/ark_email/models/webhook_create_response.rbi +217 -0
  166. data/rbi/ark_email/models/webhook_delete_params.rbi +27 -0
  167. data/rbi/ark_email/models/webhook_delete_response.rbi +75 -0
  168. data/rbi/ark_email/models/webhook_list_params.rbi +27 -0
  169. data/rbi/ark_email/models/webhook_list_response.rbi +152 -0
  170. data/rbi/ark_email/models/webhook_retrieve_params.rbi +27 -0
  171. data/rbi/ark_email/models/webhook_retrieve_response.rbi +219 -0
  172. data/rbi/ark_email/models/webhook_test_params.rbi +95 -0
  173. data/rbi/ark_email/models/webhook_test_response.rbi +129 -0
  174. data/rbi/ark_email/models/webhook_update_params.rbi +80 -0
  175. data/rbi/ark_email/models/webhook_update_response.rbi +217 -0
  176. data/rbi/ark_email/models.rbi +68 -0
  177. data/rbi/ark_email/request_options.rbi +59 -0
  178. data/rbi/ark_email/resources/domains.rbi +84 -0
  179. data/rbi/ark_email/resources/emails.rbi +237 -0
  180. data/rbi/ark_email/resources/suppressions.rbi +84 -0
  181. data/rbi/ark_email/resources/tracking.rbi +130 -0
  182. data/rbi/ark_email/resources/webhooks.rbi +137 -0
  183. data/rbi/ark_email/version.rbi +5 -0
  184. data/sig/ark_email/client.rbs +34 -0
  185. data/sig/ark_email/errors.rbs +117 -0
  186. data/sig/ark_email/file_part.rbs +21 -0
  187. data/sig/ark_email/internal/page_number_pagination.rbs +32 -0
  188. data/sig/ark_email/internal/transport/base_client.rbs +133 -0
  189. data/sig/ark_email/internal/transport/pooled_net_requester.rbs +48 -0
  190. data/sig/ark_email/internal/type/array_of.rbs +48 -0
  191. data/sig/ark_email/internal/type/base_model.rbs +102 -0
  192. data/sig/ark_email/internal/type/base_page.rbs +24 -0
  193. data/sig/ark_email/internal/type/boolean.rbs +26 -0
  194. data/sig/ark_email/internal/type/converter.rbs +79 -0
  195. data/sig/ark_email/internal/type/enum.rbs +32 -0
  196. data/sig/ark_email/internal/type/file_input.rbs +25 -0
  197. data/sig/ark_email/internal/type/hash_of.rbs +48 -0
  198. data/sig/ark_email/internal/type/request_parameters.rbs +17 -0
  199. data/sig/ark_email/internal/type/union.rbs +52 -0
  200. data/sig/ark_email/internal/type/unknown.rbs +26 -0
  201. data/sig/ark_email/internal/util.rbs +185 -0
  202. data/sig/ark_email/internal.rbs +9 -0
  203. data/sig/ark_email/models/api_meta.rbs +13 -0
  204. data/sig/ark_email/models/dns_record.rbs +59 -0
  205. data/sig/ark_email/models/domain_create_params.rbs +23 -0
  206. data/sig/ark_email/models/domain_create_response.rbs +104 -0
  207. data/sig/ark_email/models/domain_delete_params.rbs +15 -0
  208. data/sig/ark_email/models/domain_delete_response.rbs +40 -0
  209. data/sig/ark_email/models/domain_list_params.rbs +15 -0
  210. data/sig/ark_email/models/domain_list_response.rbs +71 -0
  211. data/sig/ark_email/models/domain_retrieve_params.rbs +15 -0
  212. data/sig/ark_email/models/domain_retrieve_response.rbs +104 -0
  213. data/sig/ark_email/models/domain_verify_params.rbs +15 -0
  214. data/sig/ark_email/models/domain_verify_response.rbs +104 -0
  215. data/sig/ark_email/models/email_list_params.rbs +94 -0
  216. data/sig/ark_email/models/email_list_response.rbs +77 -0
  217. data/sig/ark_email/models/email_retrieve_deliveries_params.rbs +15 -0
  218. data/sig/ark_email/models/email_retrieve_deliveries_response.rbs +117 -0
  219. data/sig/ark_email/models/email_retrieve_params.rbs +25 -0
  220. data/sig/ark_email/models/email_retrieve_response.rbs +232 -0
  221. data/sig/ark_email/models/email_retry_params.rbs +15 -0
  222. data/sig/ark_email/models/email_retry_response.rbs +40 -0
  223. data/sig/ark_email/models/email_send_batch_params.rbs +81 -0
  224. data/sig/ark_email/models/email_send_batch_response.rbs +74 -0
  225. data/sig/ark_email/models/email_send_params.rbs +124 -0
  226. data/sig/ark_email/models/email_send_raw_params.rbs +32 -0
  227. data/sig/ark_email/models/email_send_raw_response.rbs +75 -0
  228. data/sig/ark_email/models/email_send_response.rbs +75 -0
  229. data/sig/ark_email/models/suppression_bulk_create_params.rbs +40 -0
  230. data/sig/ark_email/models/suppression_bulk_create_response.rbs +62 -0
  231. data/sig/ark_email/models/suppression_create_params.rbs +30 -0
  232. data/sig/ark_email/models/suppression_create_response.rbs +59 -0
  233. data/sig/ark_email/models/suppression_delete_params.rbs +15 -0
  234. data/sig/ark_email/models/suppression_delete_response.rbs +40 -0
  235. data/sig/ark_email/models/suppression_list_params.rbs +32 -0
  236. data/sig/ark_email/models/suppression_list_response.rbs +32 -0
  237. data/sig/ark_email/models/suppression_retrieve_params.rbs +15 -0
  238. data/sig/ark_email/models/suppression_retrieve_response.rbs +62 -0
  239. data/sig/ark_email/models/track_domain.rbs +122 -0
  240. data/sig/ark_email/models/tracking_create_params.rbs +52 -0
  241. data/sig/ark_email/models/tracking_create_response.rbs +26 -0
  242. data/sig/ark_email/models/tracking_delete_params.rbs +15 -0
  243. data/sig/ark_email/models/tracking_delete_response.rbs +40 -0
  244. data/sig/ark_email/models/tracking_list_params.rbs +15 -0
  245. data/sig/ark_email/models/tracking_list_response.rbs +40 -0
  246. data/sig/ark_email/models/tracking_retrieve_params.rbs +15 -0
  247. data/sig/ark_email/models/tracking_retrieve_response.rbs +26 -0
  248. data/sig/ark_email/models/tracking_update_params.rbs +49 -0
  249. data/sig/ark_email/models/tracking_update_response.rbs +26 -0
  250. data/sig/ark_email/models/tracking_verify_params.rbs +15 -0
  251. data/sig/ark_email/models/tracking_verify_response.rbs +109 -0
  252. data/sig/ark_email/models/webhook_create_params.rbs +75 -0
  253. data/sig/ark_email/models/webhook_create_response.rbs +107 -0
  254. data/sig/ark_email/models/webhook_delete_params.rbs +15 -0
  255. data/sig/ark_email/models/webhook_delete_response.rbs +40 -0
  256. data/sig/ark_email/models/webhook_list_params.rbs +15 -0
  257. data/sig/ark_email/models/webhook_list_response.rbs +84 -0
  258. data/sig/ark_email/models/webhook_retrieve_params.rbs +15 -0
  259. data/sig/ark_email/models/webhook_retrieve_response.rbs +107 -0
  260. data/sig/ark_email/models/webhook_test_params.rbs +49 -0
  261. data/sig/ark_email/models/webhook_test_response.rbs +72 -0
  262. data/sig/ark_email/models/webhook_update_params.rbs +56 -0
  263. data/sig/ark_email/models/webhook_update_response.rbs +107 -0
  264. data/sig/ark_email/models.rbs +65 -0
  265. data/sig/ark_email/request_options.rbs +34 -0
  266. data/sig/ark_email/resources/domains.rbs +31 -0
  267. data/sig/ark_email/resources/emails.rbs +65 -0
  268. data/sig/ark_email/resources/suppressions.rbs +34 -0
  269. data/sig/ark_email/resources/tracking.rbs +44 -0
  270. data/sig/ark_email/resources/webhooks.rbs +46 -0
  271. data/sig/ark_email/version.rbs +3 -0
  272. metadata +343 -0
@@ -0,0 +1,40 @@
1
+ module ArkEmail
2
+ module Models
3
+ type email_retry_response =
4
+ {
5
+ data: ArkEmail::Models::EmailRetryResponse::Data,
6
+ meta: ArkEmail::APIMeta,
7
+ success: true
8
+ }
9
+
10
+ class EmailRetryResponse < ArkEmail::Internal::Type::BaseModel
11
+ attr_accessor data: ArkEmail::Models::EmailRetryResponse::Data
12
+
13
+ attr_accessor meta: ArkEmail::APIMeta
14
+
15
+ attr_accessor success: true
16
+
17
+ def initialize: (
18
+ data: ArkEmail::Models::EmailRetryResponse::Data,
19
+ meta: ArkEmail::APIMeta,
20
+ ?success: true
21
+ ) -> void
22
+
23
+ def to_hash: -> {
24
+ data: ArkEmail::Models::EmailRetryResponse::Data,
25
+ meta: ArkEmail::APIMeta,
26
+ success: true
27
+ }
28
+
29
+ type data = { message: String }
30
+
31
+ class Data < ArkEmail::Internal::Type::BaseModel
32
+ attr_accessor message: String
33
+
34
+ def initialize: (message: String) -> void
35
+
36
+ def to_hash: -> { message: String }
37
+ end
38
+ end
39
+ end
40
+ end
@@ -0,0 +1,81 @@
1
+ module ArkEmail
2
+ module Models
3
+ type email_send_batch_params =
4
+ {
5
+ emails: ::Array[ArkEmail::EmailSendBatchParams::Email],
6
+ from: String,
7
+ idempotency_key: String
8
+ }
9
+ & ArkEmail::Internal::Type::request_parameters
10
+
11
+ class EmailSendBatchParams < ArkEmail::Internal::Type::BaseModel
12
+ extend ArkEmail::Internal::Type::RequestParameters::Converter
13
+ include ArkEmail::Internal::Type::RequestParameters
14
+
15
+ attr_accessor emails: ::Array[ArkEmail::EmailSendBatchParams::Email]
16
+
17
+ attr_accessor from: String
18
+
19
+ attr_reader idempotency_key: String?
20
+
21
+ def idempotency_key=: (String) -> String
22
+
23
+ def initialize: (
24
+ emails: ::Array[ArkEmail::EmailSendBatchParams::Email],
25
+ from: String,
26
+ ?idempotency_key: String,
27
+ ?request_options: ArkEmail::request_opts
28
+ ) -> void
29
+
30
+ def to_hash: -> {
31
+ emails: ::Array[ArkEmail::EmailSendBatchParams::Email],
32
+ from: String,
33
+ idempotency_key: String,
34
+ request_options: ArkEmail::RequestOptions
35
+ }
36
+
37
+ type email =
38
+ {
39
+ subject: String,
40
+ to: ::Array[String],
41
+ html: String,
42
+ tag: String,
43
+ text: String
44
+ }
45
+
46
+ class Email < ArkEmail::Internal::Type::BaseModel
47
+ attr_accessor subject: String
48
+
49
+ attr_accessor to: ::Array[String]
50
+
51
+ attr_reader html: String?
52
+
53
+ def html=: (String) -> String
54
+
55
+ attr_reader tag: String?
56
+
57
+ def tag=: (String) -> String
58
+
59
+ attr_reader text: String?
60
+
61
+ def text=: (String) -> String
62
+
63
+ def initialize: (
64
+ subject: String,
65
+ to: ::Array[String],
66
+ ?html: String,
67
+ ?tag: String,
68
+ ?text: String
69
+ ) -> void
70
+
71
+ def to_hash: -> {
72
+ subject: String,
73
+ to: ::Array[String],
74
+ html: String,
75
+ tag: String,
76
+ text: String
77
+ }
78
+ end
79
+ end
80
+ end
81
+ end
@@ -0,0 +1,74 @@
1
+ module ArkEmail
2
+ module Models
3
+ type email_send_batch_response =
4
+ {
5
+ data: ArkEmail::Models::EmailSendBatchResponse::Data,
6
+ meta: ArkEmail::APIMeta,
7
+ success: true
8
+ }
9
+
10
+ class EmailSendBatchResponse < ArkEmail::Internal::Type::BaseModel
11
+ attr_accessor data: ArkEmail::Models::EmailSendBatchResponse::Data
12
+
13
+ attr_accessor meta: ArkEmail::APIMeta
14
+
15
+ attr_accessor success: true
16
+
17
+ def initialize: (
18
+ data: ArkEmail::Models::EmailSendBatchResponse::Data,
19
+ meta: ArkEmail::APIMeta,
20
+ ?success: true
21
+ ) -> void
22
+
23
+ def to_hash: -> {
24
+ data: ArkEmail::Models::EmailSendBatchResponse::Data,
25
+ meta: ArkEmail::APIMeta,
26
+ success: true
27
+ }
28
+
29
+ type data =
30
+ {
31
+ accepted: Integer,
32
+ failed: Integer,
33
+ messages: ::Hash[Symbol, ArkEmail::Models::EmailSendBatchResponse::Data::Message],
34
+ total: Integer
35
+ }
36
+
37
+ class Data < ArkEmail::Internal::Type::BaseModel
38
+ attr_accessor accepted: Integer
39
+
40
+ attr_accessor failed: Integer
41
+
42
+ attr_accessor messages: ::Hash[Symbol, ArkEmail::Models::EmailSendBatchResponse::Data::Message]
43
+
44
+ attr_accessor total: Integer
45
+
46
+ def initialize: (
47
+ accepted: Integer,
48
+ failed: Integer,
49
+ messages: ::Hash[Symbol, ArkEmail::Models::EmailSendBatchResponse::Data::Message],
50
+ total: Integer
51
+ ) -> void
52
+
53
+ def to_hash: -> {
54
+ accepted: Integer,
55
+ failed: Integer,
56
+ messages: ::Hash[Symbol, ArkEmail::Models::EmailSendBatchResponse::Data::Message],
57
+ total: Integer
58
+ }
59
+
60
+ type message = { id: String, token: String }
61
+
62
+ class Message < ArkEmail::Internal::Type::BaseModel
63
+ attr_accessor id: String
64
+
65
+ attr_accessor token: String
66
+
67
+ def initialize: (id: String, token: String) -> void
68
+
69
+ def to_hash: -> { id: String, token: String }
70
+ end
71
+ end
72
+ end
73
+ end
74
+ end
@@ -0,0 +1,124 @@
1
+ module ArkEmail
2
+ module Models
3
+ type email_send_params =
4
+ {
5
+ from: String,
6
+ subject: String,
7
+ to: ::Array[String],
8
+ attachments: ::Array[ArkEmail::EmailSendParams::Attachment],
9
+ bcc: ::Array[String],
10
+ cc: ::Array[String],
11
+ headers: ::Hash[Symbol, String],
12
+ html: String,
13
+ reply_to: String,
14
+ tag: String,
15
+ text: String,
16
+ idempotency_key: String
17
+ }
18
+ & ArkEmail::Internal::Type::request_parameters
19
+
20
+ class EmailSendParams < ArkEmail::Internal::Type::BaseModel
21
+ extend ArkEmail::Internal::Type::RequestParameters::Converter
22
+ include ArkEmail::Internal::Type::RequestParameters
23
+
24
+ attr_accessor from: String
25
+
26
+ attr_accessor subject: String
27
+
28
+ attr_accessor to: ::Array[String]
29
+
30
+ attr_reader attachments: ::Array[ArkEmail::EmailSendParams::Attachment]?
31
+
32
+ def attachments=: (
33
+ ::Array[ArkEmail::EmailSendParams::Attachment]
34
+ ) -> ::Array[ArkEmail::EmailSendParams::Attachment]
35
+
36
+ attr_reader bcc: ::Array[String]?
37
+
38
+ def bcc=: (::Array[String]) -> ::Array[String]
39
+
40
+ attr_reader cc: ::Array[String]?
41
+
42
+ def cc=: (::Array[String]) -> ::Array[String]
43
+
44
+ attr_reader headers: ::Hash[Symbol, String]?
45
+
46
+ def headers=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
47
+
48
+ attr_reader html: String?
49
+
50
+ def html=: (String) -> String
51
+
52
+ attr_reader reply_to: String?
53
+
54
+ def reply_to=: (String) -> String
55
+
56
+ attr_reader tag: String?
57
+
58
+ def tag=: (String) -> String
59
+
60
+ attr_reader text: String?
61
+
62
+ def text=: (String) -> String
63
+
64
+ attr_reader idempotency_key: String?
65
+
66
+ def idempotency_key=: (String) -> String
67
+
68
+ def initialize: (
69
+ from: String,
70
+ subject: String,
71
+ to: ::Array[String],
72
+ ?attachments: ::Array[ArkEmail::EmailSendParams::Attachment],
73
+ ?bcc: ::Array[String],
74
+ ?cc: ::Array[String],
75
+ ?headers: ::Hash[Symbol, String],
76
+ ?html: String,
77
+ ?reply_to: String,
78
+ ?tag: String,
79
+ ?text: String,
80
+ ?idempotency_key: String,
81
+ ?request_options: ArkEmail::request_opts
82
+ ) -> void
83
+
84
+ def to_hash: -> {
85
+ from: String,
86
+ subject: String,
87
+ to: ::Array[String],
88
+ attachments: ::Array[ArkEmail::EmailSendParams::Attachment],
89
+ bcc: ::Array[String],
90
+ cc: ::Array[String],
91
+ headers: ::Hash[Symbol, String],
92
+ html: String,
93
+ reply_to: String,
94
+ tag: String,
95
+ text: String,
96
+ idempotency_key: String,
97
+ request_options: ArkEmail::RequestOptions
98
+ }
99
+
100
+ type attachment =
101
+ { content: String, content_type: String, filename: String }
102
+
103
+ class Attachment < ArkEmail::Internal::Type::BaseModel
104
+ attr_accessor content: String
105
+
106
+ attr_accessor content_type: String
107
+
108
+ attr_accessor filename: String
109
+
110
+ def initialize: (
111
+ content: String,
112
+ content_type: String,
113
+ filename: String
114
+ ) -> void
115
+
116
+ def to_hash: -> {
117
+ content: String,
118
+ content_type: String,
119
+ filename: String
120
+ }
121
+ end
122
+ end
123
+ end
124
+ end
@@ -0,0 +1,32 @@
1
+ module ArkEmail
2
+ module Models
3
+ type email_send_raw_params =
4
+ { data: String, mail_from: String, rcpt_to: ::Array[String] }
5
+ & ArkEmail::Internal::Type::request_parameters
6
+
7
+ class EmailSendRawParams < ArkEmail::Internal::Type::BaseModel
8
+ extend ArkEmail::Internal::Type::RequestParameters::Converter
9
+ include ArkEmail::Internal::Type::RequestParameters
10
+
11
+ attr_accessor data: String
12
+
13
+ attr_accessor mail_from: String
14
+
15
+ attr_accessor rcpt_to: ::Array[String]
16
+
17
+ def initialize: (
18
+ data: String,
19
+ mail_from: String,
20
+ rcpt_to: ::Array[String],
21
+ ?request_options: ArkEmail::request_opts
22
+ ) -> void
23
+
24
+ def to_hash: -> {
25
+ data: String,
26
+ mail_from: String,
27
+ rcpt_to: ::Array[String],
28
+ request_options: ArkEmail::RequestOptions
29
+ }
30
+ end
31
+ end
32
+ end
@@ -0,0 +1,75 @@
1
+ module ArkEmail
2
+ module Models
3
+ type email_send_raw_response =
4
+ {
5
+ data: ArkEmail::Models::EmailSendRawResponse::Data,
6
+ meta: ArkEmail::APIMeta,
7
+ success: true
8
+ }
9
+
10
+ class EmailSendRawResponse < ArkEmail::Internal::Type::BaseModel
11
+ attr_accessor data: ArkEmail::Models::EmailSendRawResponse::Data
12
+
13
+ attr_accessor meta: ArkEmail::APIMeta
14
+
15
+ attr_accessor success: true
16
+
17
+ def initialize: (
18
+ data: ArkEmail::Models::EmailSendRawResponse::Data,
19
+ meta: ArkEmail::APIMeta,
20
+ ?success: true
21
+ ) -> void
22
+
23
+ def to_hash: -> {
24
+ data: ArkEmail::Models::EmailSendRawResponse::Data,
25
+ meta: ArkEmail::APIMeta,
26
+ success: true
27
+ }
28
+
29
+ type data =
30
+ {
31
+ id: String,
32
+ status: ArkEmail::Models::EmailSendRawResponse::Data::status,
33
+ to: ::Array[String],
34
+ message_id: String
35
+ }
36
+
37
+ class Data < ArkEmail::Internal::Type::BaseModel
38
+ attr_accessor id: String
39
+
40
+ attr_accessor status: ArkEmail::Models::EmailSendRawResponse::Data::status
41
+
42
+ attr_accessor to: ::Array[String]
43
+
44
+ attr_reader message_id: String?
45
+
46
+ def message_id=: (String) -> String
47
+
48
+ def initialize: (
49
+ id: String,
50
+ status: ArkEmail::Models::EmailSendRawResponse::Data::status,
51
+ to: ::Array[String],
52
+ ?message_id: String
53
+ ) -> void
54
+
55
+ def to_hash: -> {
56
+ id: String,
57
+ status: ArkEmail::Models::EmailSendRawResponse::Data::status,
58
+ to: ::Array[String],
59
+ message_id: String
60
+ }
61
+
62
+ type status = :pending | :sent
63
+
64
+ module Status
65
+ extend ArkEmail::Internal::Type::Enum
66
+
67
+ PENDING: :pending
68
+ SENT: :sent
69
+
70
+ def self?.values: -> ::Array[ArkEmail::Models::EmailSendRawResponse::Data::status]
71
+ end
72
+ end
73
+ end
74
+ end
75
+ end
@@ -0,0 +1,75 @@
1
+ module ArkEmail
2
+ module Models
3
+ type email_send_response =
4
+ {
5
+ data: ArkEmail::Models::EmailSendResponse::Data,
6
+ meta: ArkEmail::APIMeta,
7
+ success: true
8
+ }
9
+
10
+ class EmailSendResponse < ArkEmail::Internal::Type::BaseModel
11
+ attr_accessor data: ArkEmail::Models::EmailSendResponse::Data
12
+
13
+ attr_accessor meta: ArkEmail::APIMeta
14
+
15
+ attr_accessor success: true
16
+
17
+ def initialize: (
18
+ data: ArkEmail::Models::EmailSendResponse::Data,
19
+ meta: ArkEmail::APIMeta,
20
+ ?success: true
21
+ ) -> void
22
+
23
+ def to_hash: -> {
24
+ data: ArkEmail::Models::EmailSendResponse::Data,
25
+ meta: ArkEmail::APIMeta,
26
+ success: true
27
+ }
28
+
29
+ type data =
30
+ {
31
+ id: String,
32
+ status: ArkEmail::Models::EmailSendResponse::Data::status,
33
+ to: ::Array[String],
34
+ message_id: String
35
+ }
36
+
37
+ class Data < ArkEmail::Internal::Type::BaseModel
38
+ attr_accessor id: String
39
+
40
+ attr_accessor status: ArkEmail::Models::EmailSendResponse::Data::status
41
+
42
+ attr_accessor to: ::Array[String]
43
+
44
+ attr_reader message_id: String?
45
+
46
+ def message_id=: (String) -> String
47
+
48
+ def initialize: (
49
+ id: String,
50
+ status: ArkEmail::Models::EmailSendResponse::Data::status,
51
+ to: ::Array[String],
52
+ ?message_id: String
53
+ ) -> void
54
+
55
+ def to_hash: -> {
56
+ id: String,
57
+ status: ArkEmail::Models::EmailSendResponse::Data::status,
58
+ to: ::Array[String],
59
+ message_id: String
60
+ }
61
+
62
+ type status = :pending | :sent
63
+
64
+ module Status
65
+ extend ArkEmail::Internal::Type::Enum
66
+
67
+ PENDING: :pending
68
+ SENT: :sent
69
+
70
+ def self?.values: -> ::Array[ArkEmail::Models::EmailSendResponse::Data::status]
71
+ end
72
+ end
73
+ end
74
+ end
75
+ end
@@ -0,0 +1,40 @@
1
+ module ArkEmail
2
+ module Models
3
+ type suppression_bulk_create_params =
4
+ {
5
+ suppressions: ::Array[ArkEmail::SuppressionBulkCreateParams::Suppression]
6
+ }
7
+ & ArkEmail::Internal::Type::request_parameters
8
+
9
+ class SuppressionBulkCreateParams < ArkEmail::Internal::Type::BaseModel
10
+ extend ArkEmail::Internal::Type::RequestParameters::Converter
11
+ include ArkEmail::Internal::Type::RequestParameters
12
+
13
+ attr_accessor suppressions: ::Array[ArkEmail::SuppressionBulkCreateParams::Suppression]
14
+
15
+ def initialize: (
16
+ suppressions: ::Array[ArkEmail::SuppressionBulkCreateParams::Suppression],
17
+ ?request_options: ArkEmail::request_opts
18
+ ) -> void
19
+
20
+ def to_hash: -> {
21
+ suppressions: ::Array[ArkEmail::SuppressionBulkCreateParams::Suppression],
22
+ request_options: ArkEmail::RequestOptions
23
+ }
24
+
25
+ type suppression = { address: String, reason: String }
26
+
27
+ class Suppression < ArkEmail::Internal::Type::BaseModel
28
+ attr_accessor address: String
29
+
30
+ attr_reader reason: String?
31
+
32
+ def reason=: (String) -> String
33
+
34
+ def initialize: (address: String, ?reason: String) -> void
35
+
36
+ def to_hash: -> { address: String, reason: String }
37
+ end
38
+ end
39
+ end
40
+ end
@@ -0,0 +1,62 @@
1
+ module ArkEmail
2
+ module Models
3
+ type suppression_bulk_create_response =
4
+ {
5
+ data: ArkEmail::Models::SuppressionBulkCreateResponse::Data,
6
+ meta: ArkEmail::APIMeta,
7
+ success: true
8
+ }
9
+
10
+ class SuppressionBulkCreateResponse < ArkEmail::Internal::Type::BaseModel
11
+ attr_accessor data: ArkEmail::Models::SuppressionBulkCreateResponse::Data
12
+
13
+ attr_accessor meta: ArkEmail::APIMeta
14
+
15
+ attr_accessor success: true
16
+
17
+ def initialize: (
18
+ data: ArkEmail::Models::SuppressionBulkCreateResponse::Data,
19
+ meta: ArkEmail::APIMeta,
20
+ ?success: true
21
+ ) -> void
22
+
23
+ def to_hash: -> {
24
+ data: ArkEmail::Models::SuppressionBulkCreateResponse::Data,
25
+ meta: ArkEmail::APIMeta,
26
+ success: true
27
+ }
28
+
29
+ type data =
30
+ {
31
+ added: Integer,
32
+ failed: Integer,
33
+ total_requested: Integer,
34
+ updated: Integer
35
+ }
36
+
37
+ class Data < ArkEmail::Internal::Type::BaseModel
38
+ attr_accessor added: Integer
39
+
40
+ attr_accessor failed: Integer
41
+
42
+ attr_accessor total_requested: Integer
43
+
44
+ attr_accessor updated: Integer
45
+
46
+ def initialize: (
47
+ added: Integer,
48
+ failed: Integer,
49
+ total_requested: Integer,
50
+ updated: Integer
51
+ ) -> void
52
+
53
+ def to_hash: -> {
54
+ added: Integer,
55
+ failed: Integer,
56
+ total_requested: Integer,
57
+ updated: Integer
58
+ }
59
+ end
60
+ end
61
+ end
62
+ end
@@ -0,0 +1,30 @@
1
+ module ArkEmail
2
+ module Models
3
+ type suppression_create_params =
4
+ { address: String, reason: String }
5
+ & ArkEmail::Internal::Type::request_parameters
6
+
7
+ class SuppressionCreateParams < ArkEmail::Internal::Type::BaseModel
8
+ extend ArkEmail::Internal::Type::RequestParameters::Converter
9
+ include ArkEmail::Internal::Type::RequestParameters
10
+
11
+ attr_accessor address: String
12
+
13
+ attr_reader reason: String?
14
+
15
+ def reason=: (String) -> String
16
+
17
+ def initialize: (
18
+ address: String,
19
+ ?reason: String,
20
+ ?request_options: ArkEmail::request_opts
21
+ ) -> void
22
+
23
+ def to_hash: -> {
24
+ address: String,
25
+ reason: String,
26
+ request_options: ArkEmail::RequestOptions
27
+ }
28
+ end
29
+ end
30
+ end
@@ -0,0 +1,59 @@
1
+ module ArkEmail
2
+ module Models
3
+ type suppression_create_response =
4
+ {
5
+ data: ArkEmail::Models::SuppressionCreateResponse::Data,
6
+ meta: ArkEmail::APIMeta,
7
+ success: true
8
+ }
9
+
10
+ class SuppressionCreateResponse < ArkEmail::Internal::Type::BaseModel
11
+ attr_accessor data: ArkEmail::Models::SuppressionCreateResponse::Data
12
+
13
+ attr_accessor meta: ArkEmail::APIMeta
14
+
15
+ attr_accessor success: true
16
+
17
+ def initialize: (
18
+ data: ArkEmail::Models::SuppressionCreateResponse::Data,
19
+ meta: ArkEmail::APIMeta,
20
+ ?success: true
21
+ ) -> void
22
+
23
+ def to_hash: -> {
24
+ data: ArkEmail::Models::SuppressionCreateResponse::Data,
25
+ meta: ArkEmail::APIMeta,
26
+ success: true
27
+ }
28
+
29
+ type data =
30
+ { id: String, address: String, created_at: Time, reason: String }
31
+
32
+ class Data < ArkEmail::Internal::Type::BaseModel
33
+ attr_accessor id: String
34
+
35
+ attr_accessor address: String
36
+
37
+ attr_accessor created_at: Time
38
+
39
+ attr_reader reason: String?
40
+
41
+ def reason=: (String) -> String
42
+
43
+ def initialize: (
44
+ id: String,
45
+ address: String,
46
+ created_at: Time,
47
+ ?reason: String
48
+ ) -> void
49
+
50
+ def to_hash: -> {
51
+ id: String,
52
+ address: String,
53
+ created_at: Time,
54
+ reason: String
55
+ }
56
+ end
57
+ end
58
+ end
59
+ end