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,104 @@
1
+ module ArkEmail
2
+ module Models
3
+ type domain_verify_response =
4
+ {
5
+ data: ArkEmail::Models::DomainVerifyResponse::Data,
6
+ meta: ArkEmail::APIMeta,
7
+ success: true
8
+ }
9
+
10
+ class DomainVerifyResponse < ArkEmail::Internal::Type::BaseModel
11
+ attr_accessor data: ArkEmail::Models::DomainVerifyResponse::Data
12
+
13
+ attr_accessor meta: ArkEmail::APIMeta
14
+
15
+ attr_accessor success: true
16
+
17
+ def initialize: (
18
+ data: ArkEmail::Models::DomainVerifyResponse::Data,
19
+ meta: ArkEmail::APIMeta,
20
+ ?success: true
21
+ ) -> void
22
+
23
+ def to_hash: -> {
24
+ data: ArkEmail::Models::DomainVerifyResponse::Data,
25
+ meta: ArkEmail::APIMeta,
26
+ success: true
27
+ }
28
+
29
+ type data =
30
+ {
31
+ id: String,
32
+ created_at: Time,
33
+ dns_records: ArkEmail::Models::DomainVerifyResponse::Data::DNSRecords,
34
+ name: String,
35
+ uuid: String,
36
+ verified: bool,
37
+ verified_at: Time?
38
+ }
39
+
40
+ class Data < ArkEmail::Internal::Type::BaseModel
41
+ attr_accessor id: String
42
+
43
+ attr_accessor created_at: Time
44
+
45
+ attr_accessor dns_records: ArkEmail::Models::DomainVerifyResponse::Data::DNSRecords
46
+
47
+ attr_accessor name: String
48
+
49
+ attr_accessor uuid: String
50
+
51
+ attr_accessor verified: bool
52
+
53
+ attr_accessor verified_at: Time?
54
+
55
+ def initialize: (
56
+ id: String,
57
+ created_at: Time,
58
+ dns_records: ArkEmail::Models::DomainVerifyResponse::Data::DNSRecords,
59
+ name: String,
60
+ uuid: String,
61
+ verified: bool,
62
+ ?verified_at: Time?
63
+ ) -> void
64
+
65
+ def to_hash: -> {
66
+ id: String,
67
+ created_at: Time,
68
+ dns_records: ArkEmail::Models::DomainVerifyResponse::Data::DNSRecords,
69
+ name: String,
70
+ uuid: String,
71
+ verified: bool,
72
+ verified_at: Time?
73
+ }
74
+
75
+ type dns_records =
76
+ {
77
+ dkim: ArkEmail::DNSRecord,
78
+ return_path: ArkEmail::DNSRecord,
79
+ spf: ArkEmail::DNSRecord
80
+ }
81
+
82
+ class DNSRecords < ArkEmail::Internal::Type::BaseModel
83
+ attr_accessor dkim: ArkEmail::DNSRecord
84
+
85
+ attr_accessor return_path: ArkEmail::DNSRecord
86
+
87
+ attr_accessor spf: ArkEmail::DNSRecord
88
+
89
+ def initialize: (
90
+ dkim: ArkEmail::DNSRecord,
91
+ return_path: ArkEmail::DNSRecord,
92
+ spf: ArkEmail::DNSRecord
93
+ ) -> void
94
+
95
+ def to_hash: -> {
96
+ dkim: ArkEmail::DNSRecord,
97
+ return_path: ArkEmail::DNSRecord,
98
+ spf: ArkEmail::DNSRecord
99
+ }
100
+ end
101
+ end
102
+ end
103
+ end
104
+ end
@@ -0,0 +1,94 @@
1
+ module ArkEmail
2
+ module Models
3
+ type email_list_params =
4
+ {
5
+ after: String,
6
+ before: String,
7
+ from: String,
8
+ page: Integer,
9
+ per_page: Integer,
10
+ status: ArkEmail::Models::EmailListParams::status,
11
+ tag: String,
12
+ to: String
13
+ }
14
+ & ArkEmail::Internal::Type::request_parameters
15
+
16
+ class EmailListParams < ArkEmail::Internal::Type::BaseModel
17
+ extend ArkEmail::Internal::Type::RequestParameters::Converter
18
+ include ArkEmail::Internal::Type::RequestParameters
19
+
20
+ attr_reader after: String?
21
+
22
+ def after=: (String) -> String
23
+
24
+ attr_reader before: String?
25
+
26
+ def before=: (String) -> String
27
+
28
+ attr_reader from: String?
29
+
30
+ def from=: (String) -> String
31
+
32
+ attr_reader page: Integer?
33
+
34
+ def page=: (Integer) -> Integer
35
+
36
+ attr_reader per_page: Integer?
37
+
38
+ def per_page=: (Integer) -> Integer
39
+
40
+ attr_reader status: ArkEmail::Models::EmailListParams::status?
41
+
42
+ def status=: (
43
+ ArkEmail::Models::EmailListParams::status
44
+ ) -> ArkEmail::Models::EmailListParams::status
45
+
46
+ attr_reader tag: String?
47
+
48
+ def tag=: (String) -> String
49
+
50
+ attr_reader to: String?
51
+
52
+ def to=: (String) -> String
53
+
54
+ def initialize: (
55
+ ?after: String,
56
+ ?before: String,
57
+ ?from: String,
58
+ ?page: Integer,
59
+ ?per_page: Integer,
60
+ ?status: ArkEmail::Models::EmailListParams::status,
61
+ ?tag: String,
62
+ ?to: String,
63
+ ?request_options: ArkEmail::request_opts
64
+ ) -> void
65
+
66
+ def to_hash: -> {
67
+ after: String,
68
+ before: String,
69
+ from: String,
70
+ page: Integer,
71
+ per_page: Integer,
72
+ status: ArkEmail::Models::EmailListParams::status,
73
+ tag: String,
74
+ to: String,
75
+ request_options: ArkEmail::RequestOptions
76
+ }
77
+
78
+ type status = :pending | :sent | :softfail | :hardfail | :bounced | :held
79
+
80
+ module Status
81
+ extend ArkEmail::Internal::Type::Enum
82
+
83
+ PENDING: :pending
84
+ SENT: :sent
85
+ SOFTFAIL: :softfail
86
+ HARDFAIL: :hardfail
87
+ BOUNCED: :bounced
88
+ HELD: :held
89
+
90
+ def self?.values: -> ::Array[ArkEmail::Models::EmailListParams::status]
91
+ end
92
+ end
93
+ end
94
+ end
@@ -0,0 +1,77 @@
1
+ module ArkEmail
2
+ module Models
3
+ type email_list_response =
4
+ {
5
+ id: String,
6
+ token: String,
7
+ from: String,
8
+ status: ArkEmail::Models::EmailListResponse::status,
9
+ subject: String,
10
+ timestamp: Float,
11
+ timestamp_iso: Time,
12
+ to: String,
13
+ tag: String
14
+ }
15
+
16
+ class EmailListResponse < ArkEmail::Internal::Type::BaseModel
17
+ attr_accessor id: String
18
+
19
+ attr_accessor token: String
20
+
21
+ attr_accessor from: String
22
+
23
+ attr_accessor status: ArkEmail::Models::EmailListResponse::status
24
+
25
+ attr_accessor subject: String
26
+
27
+ attr_accessor timestamp: Float
28
+
29
+ attr_accessor timestamp_iso: Time
30
+
31
+ attr_accessor to: String
32
+
33
+ attr_reader tag: String?
34
+
35
+ def tag=: (String) -> String
36
+
37
+ def initialize: (
38
+ id: String,
39
+ token: String,
40
+ from: String,
41
+ status: ArkEmail::Models::EmailListResponse::status,
42
+ subject: String,
43
+ timestamp: Float,
44
+ timestamp_iso: Time,
45
+ to: String,
46
+ ?tag: String
47
+ ) -> void
48
+
49
+ def to_hash: -> {
50
+ id: String,
51
+ token: String,
52
+ from: String,
53
+ status: ArkEmail::Models::EmailListResponse::status,
54
+ subject: String,
55
+ timestamp: Float,
56
+ timestamp_iso: Time,
57
+ to: String,
58
+ tag: String
59
+ }
60
+
61
+ type status = :pending | :sent | :softfail | :hardfail | :bounced | :held
62
+
63
+ module Status
64
+ extend ArkEmail::Internal::Type::Enum
65
+
66
+ PENDING: :pending
67
+ SENT: :sent
68
+ SOFTFAIL: :softfail
69
+ HARDFAIL: :hardfail
70
+ BOUNCED: :bounced
71
+ HELD: :held
72
+
73
+ def self?.values: -> ::Array[ArkEmail::Models::EmailListResponse::status]
74
+ end
75
+ end
76
+ end
77
+ end
@@ -0,0 +1,15 @@
1
+ module ArkEmail
2
+ module Models
3
+ type email_retrieve_deliveries_params =
4
+ { } & ArkEmail::Internal::Type::request_parameters
5
+
6
+ class EmailRetrieveDeliveriesParams < ArkEmail::Internal::Type::BaseModel
7
+ extend ArkEmail::Internal::Type::RequestParameters::Converter
8
+ include ArkEmail::Internal::Type::RequestParameters
9
+
10
+ def initialize: (?request_options: ArkEmail::request_opts) -> void
11
+
12
+ def to_hash: -> { request_options: ArkEmail::RequestOptions }
13
+ end
14
+ end
15
+ end
@@ -0,0 +1,117 @@
1
+ module ArkEmail
2
+ module Models
3
+ type email_retrieve_deliveries_response =
4
+ {
5
+ data: ArkEmail::Models::EmailRetrieveDeliveriesResponse::Data,
6
+ meta: ArkEmail::APIMeta,
7
+ success: true
8
+ }
9
+
10
+ class EmailRetrieveDeliveriesResponse < ArkEmail::Internal::Type::BaseModel
11
+ attr_accessor data: ArkEmail::Models::EmailRetrieveDeliveriesResponse::Data
12
+
13
+ attr_accessor meta: ArkEmail::APIMeta
14
+
15
+ attr_accessor success: true
16
+
17
+ def initialize: (
18
+ data: ArkEmail::Models::EmailRetrieveDeliveriesResponse::Data,
19
+ meta: ArkEmail::APIMeta,
20
+ ?success: true
21
+ ) -> void
22
+
23
+ def to_hash: -> {
24
+ data: ArkEmail::Models::EmailRetrieveDeliveriesResponse::Data,
25
+ meta: ArkEmail::APIMeta,
26
+ success: true
27
+ }
28
+
29
+ type data =
30
+ {
31
+ deliveries: ::Array[ArkEmail::Models::EmailRetrieveDeliveriesResponse::Data::Delivery],
32
+ message_id: String,
33
+ message_token: String
34
+ }
35
+
36
+ class Data < ArkEmail::Internal::Type::BaseModel
37
+ attr_accessor deliveries: ::Array[ArkEmail::Models::EmailRetrieveDeliveriesResponse::Data::Delivery]
38
+
39
+ attr_accessor message_id: String
40
+
41
+ attr_accessor message_token: String
42
+
43
+ def initialize: (
44
+ deliveries: ::Array[ArkEmail::Models::EmailRetrieveDeliveriesResponse::Data::Delivery],
45
+ message_id: String,
46
+ message_token: String
47
+ ) -> void
48
+
49
+ def to_hash: -> {
50
+ deliveries: ::Array[ArkEmail::Models::EmailRetrieveDeliveriesResponse::Data::Delivery],
51
+ message_id: String,
52
+ message_token: String
53
+ }
54
+
55
+ type delivery =
56
+ {
57
+ id: String,
58
+ status: String,
59
+ timestamp: Float,
60
+ timestamp_iso: Time,
61
+ code: Integer,
62
+ details: String,
63
+ output: String,
64
+ sent_with_ssl: bool
65
+ }
66
+
67
+ class Delivery < ArkEmail::Internal::Type::BaseModel
68
+ attr_accessor id: String
69
+
70
+ attr_accessor status: String
71
+
72
+ attr_accessor timestamp: Float
73
+
74
+ attr_accessor timestamp_iso: Time
75
+
76
+ attr_reader code: Integer?
77
+
78
+ def code=: (Integer) -> Integer
79
+
80
+ attr_reader details: String?
81
+
82
+ def details=: (String) -> String
83
+
84
+ attr_reader output: String?
85
+
86
+ def output=: (String) -> String
87
+
88
+ attr_reader sent_with_ssl: bool?
89
+
90
+ def sent_with_ssl=: (bool) -> bool
91
+
92
+ def initialize: (
93
+ id: String,
94
+ status: String,
95
+ timestamp: Float,
96
+ timestamp_iso: Time,
97
+ ?code: Integer,
98
+ ?details: String,
99
+ ?output: String,
100
+ ?sent_with_ssl: bool
101
+ ) -> void
102
+
103
+ def to_hash: -> {
104
+ id: String,
105
+ status: String,
106
+ timestamp: Float,
107
+ timestamp_iso: Time,
108
+ code: Integer,
109
+ details: String,
110
+ output: String,
111
+ sent_with_ssl: bool
112
+ }
113
+ end
114
+ end
115
+ end
116
+ end
117
+ end
@@ -0,0 +1,25 @@
1
+ module ArkEmail
2
+ module Models
3
+ type email_retrieve_params =
4
+ { expand: String } & ArkEmail::Internal::Type::request_parameters
5
+
6
+ class EmailRetrieveParams < ArkEmail::Internal::Type::BaseModel
7
+ extend ArkEmail::Internal::Type::RequestParameters::Converter
8
+ include ArkEmail::Internal::Type::RequestParameters
9
+
10
+ attr_reader expand: String?
11
+
12
+ def expand=: (String) -> String
13
+
14
+ def initialize: (
15
+ ?expand: String,
16
+ ?request_options: ArkEmail::request_opts
17
+ ) -> void
18
+
19
+ def to_hash: -> {
20
+ expand: String,
21
+ request_options: ArkEmail::RequestOptions
22
+ }
23
+ end
24
+ end
25
+ end
@@ -0,0 +1,232 @@
1
+ module ArkEmail
2
+ module Models
3
+ type email_retrieve_response =
4
+ {
5
+ data: ArkEmail::Models::EmailRetrieveResponse::Data,
6
+ meta: ArkEmail::APIMeta,
7
+ success: true
8
+ }
9
+
10
+ class EmailRetrieveResponse < ArkEmail::Internal::Type::BaseModel
11
+ attr_accessor data: ArkEmail::Models::EmailRetrieveResponse::Data
12
+
13
+ attr_accessor meta: ArkEmail::APIMeta
14
+
15
+ attr_accessor success: true
16
+
17
+ def initialize: (
18
+ data: ArkEmail::Models::EmailRetrieveResponse::Data,
19
+ meta: ArkEmail::APIMeta,
20
+ ?success: true
21
+ ) -> void
22
+
23
+ def to_hash: -> {
24
+ data: ArkEmail::Models::EmailRetrieveResponse::Data,
25
+ meta: ArkEmail::APIMeta,
26
+ success: true
27
+ }
28
+
29
+ type data =
30
+ {
31
+ id: String,
32
+ token: String,
33
+ from: String,
34
+ scope: ArkEmail::Models::EmailRetrieveResponse::Data::scope,
35
+ status: ArkEmail::Models::EmailRetrieveResponse::Data::status,
36
+ subject: String,
37
+ timestamp: Float,
38
+ timestamp_iso: Time,
39
+ to: String,
40
+ deliveries: ::Array[ArkEmail::Models::EmailRetrieveResponse::Data::Delivery],
41
+ headers: ::Hash[Symbol, String],
42
+ html_body: String,
43
+ message_id: String,
44
+ plain_body: String,
45
+ spam: bool,
46
+ spam_score: Float,
47
+ tag: String
48
+ }
49
+
50
+ class Data < ArkEmail::Internal::Type::BaseModel
51
+ attr_accessor id: String
52
+
53
+ attr_accessor token: String
54
+
55
+ attr_accessor from: String
56
+
57
+ attr_accessor scope: ArkEmail::Models::EmailRetrieveResponse::Data::scope
58
+
59
+ attr_accessor status: ArkEmail::Models::EmailRetrieveResponse::Data::status
60
+
61
+ attr_accessor subject: String
62
+
63
+ attr_accessor timestamp: Float
64
+
65
+ attr_accessor timestamp_iso: Time
66
+
67
+ attr_accessor to: String
68
+
69
+ attr_reader deliveries: ::Array[ArkEmail::Models::EmailRetrieveResponse::Data::Delivery]?
70
+
71
+ def deliveries=: (
72
+ ::Array[ArkEmail::Models::EmailRetrieveResponse::Data::Delivery]
73
+ ) -> ::Array[ArkEmail::Models::EmailRetrieveResponse::Data::Delivery]
74
+
75
+ attr_reader headers: ::Hash[Symbol, String]?
76
+
77
+ def headers=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
78
+
79
+ attr_reader html_body: String?
80
+
81
+ def html_body=: (String) -> String
82
+
83
+ attr_reader message_id: String?
84
+
85
+ def message_id=: (String) -> String
86
+
87
+ attr_reader plain_body: String?
88
+
89
+ def plain_body=: (String) -> String
90
+
91
+ attr_reader spam: bool?
92
+
93
+ def spam=: (bool) -> bool
94
+
95
+ attr_reader spam_score: Float?
96
+
97
+ def spam_score=: (Float) -> Float
98
+
99
+ attr_reader tag: String?
100
+
101
+ def tag=: (String) -> String
102
+
103
+ def initialize: (
104
+ id: String,
105
+ token: String,
106
+ from: String,
107
+ scope: ArkEmail::Models::EmailRetrieveResponse::Data::scope,
108
+ status: ArkEmail::Models::EmailRetrieveResponse::Data::status,
109
+ subject: String,
110
+ timestamp: Float,
111
+ timestamp_iso: Time,
112
+ to: String,
113
+ ?deliveries: ::Array[ArkEmail::Models::EmailRetrieveResponse::Data::Delivery],
114
+ ?headers: ::Hash[Symbol, String],
115
+ ?html_body: String,
116
+ ?message_id: String,
117
+ ?plain_body: String,
118
+ ?spam: bool,
119
+ ?spam_score: Float,
120
+ ?tag: String
121
+ ) -> void
122
+
123
+ def to_hash: -> {
124
+ id: String,
125
+ token: String,
126
+ from: String,
127
+ scope: ArkEmail::Models::EmailRetrieveResponse::Data::scope,
128
+ status: ArkEmail::Models::EmailRetrieveResponse::Data::status,
129
+ subject: String,
130
+ timestamp: Float,
131
+ timestamp_iso: Time,
132
+ to: String,
133
+ deliveries: ::Array[ArkEmail::Models::EmailRetrieveResponse::Data::Delivery],
134
+ headers: ::Hash[Symbol, String],
135
+ html_body: String,
136
+ message_id: String,
137
+ plain_body: String,
138
+ spam: bool,
139
+ spam_score: Float,
140
+ tag: String
141
+ }
142
+
143
+ type scope = :outgoing | :incoming
144
+
145
+ module Scope
146
+ extend ArkEmail::Internal::Type::Enum
147
+
148
+ OUTGOING: :outgoing
149
+ INCOMING: :incoming
150
+
151
+ def self?.values: -> ::Array[ArkEmail::Models::EmailRetrieveResponse::Data::scope]
152
+ end
153
+
154
+ type status =
155
+ :pending | :sent | :softfail | :hardfail | :bounced | :held
156
+
157
+ module Status
158
+ extend ArkEmail::Internal::Type::Enum
159
+
160
+ PENDING: :pending
161
+ SENT: :sent
162
+ SOFTFAIL: :softfail
163
+ HARDFAIL: :hardfail
164
+ BOUNCED: :bounced
165
+ HELD: :held
166
+
167
+ def self?.values: -> ::Array[ArkEmail::Models::EmailRetrieveResponse::Data::status]
168
+ end
169
+
170
+ type delivery =
171
+ {
172
+ id: String,
173
+ status: String,
174
+ timestamp: Float,
175
+ timestamp_iso: Time,
176
+ code: Integer,
177
+ details: String,
178
+ output: String,
179
+ sent_with_ssl: bool
180
+ }
181
+
182
+ class Delivery < ArkEmail::Internal::Type::BaseModel
183
+ attr_accessor id: String
184
+
185
+ attr_accessor status: String
186
+
187
+ attr_accessor timestamp: Float
188
+
189
+ attr_accessor timestamp_iso: Time
190
+
191
+ attr_reader code: Integer?
192
+
193
+ def code=: (Integer) -> Integer
194
+
195
+ attr_reader details: String?
196
+
197
+ def details=: (String) -> String
198
+
199
+ attr_reader output: String?
200
+
201
+ def output=: (String) -> String
202
+
203
+ attr_reader sent_with_ssl: bool?
204
+
205
+ def sent_with_ssl=: (bool) -> bool
206
+
207
+ def initialize: (
208
+ id: String,
209
+ status: String,
210
+ timestamp: Float,
211
+ timestamp_iso: Time,
212
+ ?code: Integer,
213
+ ?details: String,
214
+ ?output: String,
215
+ ?sent_with_ssl: bool
216
+ ) -> void
217
+
218
+ def to_hash: -> {
219
+ id: String,
220
+ status: String,
221
+ timestamp: Float,
222
+ timestamp_iso: Time,
223
+ code: Integer,
224
+ details: String,
225
+ output: String,
226
+ sent_with_ssl: bool
227
+ }
228
+ end
229
+ end
230
+ end
231
+ end
232
+ end
@@ -0,0 +1,15 @@
1
+ module ArkEmail
2
+ module Models
3
+ type email_retry_params =
4
+ { } & ArkEmail::Internal::Type::request_parameters
5
+
6
+ class EmailRetryParams < ArkEmail::Internal::Type::BaseModel
7
+ extend ArkEmail::Internal::Type::RequestParameters::Converter
8
+ include ArkEmail::Internal::Type::RequestParameters
9
+
10
+ def initialize: (?request_options: ArkEmail::request_opts) -> void
11
+
12
+ def to_hash: -> { request_options: ArkEmail::RequestOptions }
13
+ end
14
+ end
15
+ end