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,15 @@
1
+ module ArkEmail
2
+ module Models
3
+ type suppression_delete_params =
4
+ { } & ArkEmail::Internal::Type::request_parameters
5
+
6
+ class SuppressionDeleteParams < 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,40 @@
1
+ module ArkEmail
2
+ module Models
3
+ type suppression_delete_response =
4
+ {
5
+ data: ArkEmail::Models::SuppressionDeleteResponse::Data,
6
+ meta: ArkEmail::APIMeta,
7
+ success: true
8
+ }
9
+
10
+ class SuppressionDeleteResponse < ArkEmail::Internal::Type::BaseModel
11
+ attr_accessor data: ArkEmail::Models::SuppressionDeleteResponse::Data
12
+
13
+ attr_accessor meta: ArkEmail::APIMeta
14
+
15
+ attr_accessor success: true
16
+
17
+ def initialize: (
18
+ data: ArkEmail::Models::SuppressionDeleteResponse::Data,
19
+ meta: ArkEmail::APIMeta,
20
+ ?success: true
21
+ ) -> void
22
+
23
+ def to_hash: -> {
24
+ data: ArkEmail::Models::SuppressionDeleteResponse::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,32 @@
1
+ module ArkEmail
2
+ module Models
3
+ type suppression_list_params =
4
+ { page: Integer, per_page: Integer }
5
+ & ArkEmail::Internal::Type::request_parameters
6
+
7
+ class SuppressionListParams < ArkEmail::Internal::Type::BaseModel
8
+ extend ArkEmail::Internal::Type::RequestParameters::Converter
9
+ include ArkEmail::Internal::Type::RequestParameters
10
+
11
+ attr_reader page: Integer?
12
+
13
+ def page=: (Integer) -> Integer
14
+
15
+ attr_reader per_page: Integer?
16
+
17
+ def per_page=: (Integer) -> Integer
18
+
19
+ def initialize: (
20
+ ?page: Integer,
21
+ ?per_page: Integer,
22
+ ?request_options: ArkEmail::request_opts
23
+ ) -> void
24
+
25
+ def to_hash: -> {
26
+ page: Integer,
27
+ per_page: Integer,
28
+ request_options: ArkEmail::RequestOptions
29
+ }
30
+ end
31
+ end
32
+ end
@@ -0,0 +1,32 @@
1
+ module ArkEmail
2
+ module Models
3
+ type suppression_list_response =
4
+ { id: String, address: String, created_at: Time, reason: String }
5
+
6
+ class SuppressionListResponse < ArkEmail::Internal::Type::BaseModel
7
+ attr_accessor id: String
8
+
9
+ attr_accessor address: String
10
+
11
+ attr_accessor created_at: Time
12
+
13
+ attr_reader reason: String?
14
+
15
+ def reason=: (String) -> String
16
+
17
+ def initialize: (
18
+ id: String,
19
+ address: String,
20
+ created_at: Time,
21
+ ?reason: String
22
+ ) -> void
23
+
24
+ def to_hash: -> {
25
+ id: String,
26
+ address: String,
27
+ created_at: Time,
28
+ reason: String
29
+ }
30
+ end
31
+ end
32
+ end
@@ -0,0 +1,15 @@
1
+ module ArkEmail
2
+ module Models
3
+ type suppression_retrieve_params =
4
+ { } & ArkEmail::Internal::Type::request_parameters
5
+
6
+ class SuppressionRetrieveParams < 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,62 @@
1
+ module ArkEmail
2
+ module Models
3
+ type suppression_retrieve_response =
4
+ {
5
+ data: ArkEmail::Models::SuppressionRetrieveResponse::Data,
6
+ meta: ArkEmail::APIMeta,
7
+ success: true
8
+ }
9
+
10
+ class SuppressionRetrieveResponse < ArkEmail::Internal::Type::BaseModel
11
+ attr_accessor data: ArkEmail::Models::SuppressionRetrieveResponse::Data
12
+
13
+ attr_accessor meta: ArkEmail::APIMeta
14
+
15
+ attr_accessor success: true
16
+
17
+ def initialize: (
18
+ data: ArkEmail::Models::SuppressionRetrieveResponse::Data,
19
+ meta: ArkEmail::APIMeta,
20
+ ?success: true
21
+ ) -> void
22
+
23
+ def to_hash: -> {
24
+ data: ArkEmail::Models::SuppressionRetrieveResponse::Data,
25
+ meta: ArkEmail::APIMeta,
26
+ success: true
27
+ }
28
+
29
+ type data =
30
+ {
31
+ address: String,
32
+ suppressed: bool,
33
+ created_at: Time?,
34
+ reason: String?
35
+ }
36
+
37
+ class Data < ArkEmail::Internal::Type::BaseModel
38
+ attr_accessor address: String
39
+
40
+ attr_accessor suppressed: bool
41
+
42
+ attr_accessor created_at: Time?
43
+
44
+ attr_accessor reason: String?
45
+
46
+ def initialize: (
47
+ address: String,
48
+ suppressed: bool,
49
+ ?created_at: Time?,
50
+ ?reason: String?
51
+ ) -> void
52
+
53
+ def to_hash: -> {
54
+ address: String,
55
+ suppressed: bool,
56
+ created_at: Time?,
57
+ reason: String?
58
+ }
59
+ end
60
+ end
61
+ end
62
+ end
@@ -0,0 +1,122 @@
1
+ module ArkEmail
2
+ module Models
3
+ type track_domain =
4
+ {
5
+ id: String,
6
+ created_at: Time,
7
+ dns_ok: bool,
8
+ domain_id: String,
9
+ full_name: String,
10
+ name: String,
11
+ ssl_enabled: bool,
12
+ track_clicks: bool,
13
+ track_opens: bool,
14
+ dns_checked_at: Time?,
15
+ dns_error: String?,
16
+ dns_record: ArkEmail::TrackDomain::DNSRecord?,
17
+ dns_status: ArkEmail::Models::TrackDomain::dns_status?,
18
+ excluded_click_domains: String?,
19
+ updated_at: Time?
20
+ }
21
+
22
+ class TrackDomain < ArkEmail::Internal::Type::BaseModel
23
+ attr_accessor id: String
24
+
25
+ attr_accessor created_at: Time
26
+
27
+ attr_accessor dns_ok: bool
28
+
29
+ attr_accessor domain_id: String
30
+
31
+ attr_accessor full_name: String
32
+
33
+ attr_accessor name: String
34
+
35
+ attr_accessor ssl_enabled: bool
36
+
37
+ attr_accessor track_clicks: bool
38
+
39
+ attr_accessor track_opens: bool
40
+
41
+ attr_accessor dns_checked_at: Time?
42
+
43
+ attr_accessor dns_error: String?
44
+
45
+ attr_accessor dns_record: ArkEmail::TrackDomain::DNSRecord?
46
+
47
+ attr_accessor dns_status: ArkEmail::Models::TrackDomain::dns_status?
48
+
49
+ attr_accessor excluded_click_domains: String?
50
+
51
+ attr_accessor updated_at: Time?
52
+
53
+ def initialize: (
54
+ id: String,
55
+ created_at: Time,
56
+ dns_ok: bool,
57
+ domain_id: String,
58
+ full_name: String,
59
+ name: String,
60
+ ssl_enabled: bool,
61
+ track_clicks: bool,
62
+ track_opens: bool,
63
+ ?dns_checked_at: Time?,
64
+ ?dns_error: String?,
65
+ ?dns_record: ArkEmail::TrackDomain::DNSRecord?,
66
+ ?dns_status: ArkEmail::Models::TrackDomain::dns_status?,
67
+ ?excluded_click_domains: String?,
68
+ ?updated_at: Time?
69
+ ) -> void
70
+
71
+ def to_hash: -> {
72
+ id: String,
73
+ created_at: Time,
74
+ dns_ok: bool,
75
+ domain_id: String,
76
+ full_name: String,
77
+ name: String,
78
+ ssl_enabled: bool,
79
+ track_clicks: bool,
80
+ track_opens: bool,
81
+ dns_checked_at: Time?,
82
+ dns_error: String?,
83
+ dns_record: ArkEmail::TrackDomain::DNSRecord?,
84
+ dns_status: ArkEmail::Models::TrackDomain::dns_status?,
85
+ excluded_click_domains: String?,
86
+ updated_at: Time?
87
+ }
88
+
89
+ type dns_record = { name: String, type: String, value: String }
90
+
91
+ class DNSRecord < ArkEmail::Internal::Type::BaseModel
92
+ attr_reader name: String?
93
+
94
+ def name=: (String) -> String
95
+
96
+ attr_reader type: String?
97
+
98
+ def type=: (String) -> String
99
+
100
+ attr_reader value: String?
101
+
102
+ def value=: (String) -> String
103
+
104
+ def initialize: (?name: String, ?type: String, ?value: String) -> void
105
+
106
+ def to_hash: -> { name: String, type: String, value: String }
107
+ end
108
+
109
+ type dns_status = :ok | :missing | :invalid
110
+
111
+ module DNSStatus
112
+ extend ArkEmail::Internal::Type::Enum
113
+
114
+ OK: :ok
115
+ MISSING: :missing
116
+ INVALID: :invalid
117
+
118
+ def self?.values: -> ::Array[ArkEmail::Models::TrackDomain::dns_status]
119
+ end
120
+ end
121
+ end
122
+ end
@@ -0,0 +1,52 @@
1
+ module ArkEmail
2
+ module Models
3
+ type tracking_create_params =
4
+ {
5
+ domain_id: String,
6
+ name: String,
7
+ ssl_enabled: bool,
8
+ track_clicks: bool,
9
+ track_opens: bool
10
+ }
11
+ & ArkEmail::Internal::Type::request_parameters
12
+
13
+ class TrackingCreateParams < ArkEmail::Internal::Type::BaseModel
14
+ extend ArkEmail::Internal::Type::RequestParameters::Converter
15
+ include ArkEmail::Internal::Type::RequestParameters
16
+
17
+ attr_accessor domain_id: String
18
+
19
+ attr_accessor name: String
20
+
21
+ attr_reader ssl_enabled: bool?
22
+
23
+ def ssl_enabled=: (bool) -> bool
24
+
25
+ attr_reader track_clicks: bool?
26
+
27
+ def track_clicks=: (bool) -> bool
28
+
29
+ attr_reader track_opens: bool?
30
+
31
+ def track_opens=: (bool) -> bool
32
+
33
+ def initialize: (
34
+ domain_id: String,
35
+ name: String,
36
+ ?ssl_enabled: bool,
37
+ ?track_clicks: bool,
38
+ ?track_opens: bool,
39
+ ?request_options: ArkEmail::request_opts
40
+ ) -> void
41
+
42
+ def to_hash: -> {
43
+ domain_id: String,
44
+ name: String,
45
+ ssl_enabled: bool,
46
+ track_clicks: bool,
47
+ track_opens: bool,
48
+ request_options: ArkEmail::RequestOptions
49
+ }
50
+ end
51
+ end
52
+ end
@@ -0,0 +1,26 @@
1
+ module ArkEmail
2
+ module Models
3
+ type tracking_create_response =
4
+ { data: ArkEmail::TrackDomain, meta: ArkEmail::APIMeta, success: true }
5
+
6
+ class TrackingCreateResponse < ArkEmail::Internal::Type::BaseModel
7
+ attr_accessor data: ArkEmail::TrackDomain
8
+
9
+ attr_accessor meta: ArkEmail::APIMeta
10
+
11
+ attr_accessor success: true
12
+
13
+ def initialize: (
14
+ data: ArkEmail::TrackDomain,
15
+ meta: ArkEmail::APIMeta,
16
+ ?success: true
17
+ ) -> void
18
+
19
+ def to_hash: -> {
20
+ data: ArkEmail::TrackDomain,
21
+ meta: ArkEmail::APIMeta,
22
+ success: true
23
+ }
24
+ end
25
+ end
26
+ end
@@ -0,0 +1,15 @@
1
+ module ArkEmail
2
+ module Models
3
+ type tracking_delete_params =
4
+ { } & ArkEmail::Internal::Type::request_parameters
5
+
6
+ class TrackingDeleteParams < 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,40 @@
1
+ module ArkEmail
2
+ module Models
3
+ type tracking_delete_response =
4
+ {
5
+ data: ArkEmail::Models::TrackingDeleteResponse::Data,
6
+ meta: ArkEmail::APIMeta,
7
+ success: true
8
+ }
9
+
10
+ class TrackingDeleteResponse < ArkEmail::Internal::Type::BaseModel
11
+ attr_accessor data: ArkEmail::Models::TrackingDeleteResponse::Data
12
+
13
+ attr_accessor meta: ArkEmail::APIMeta
14
+
15
+ attr_accessor success: true
16
+
17
+ def initialize: (
18
+ data: ArkEmail::Models::TrackingDeleteResponse::Data,
19
+ meta: ArkEmail::APIMeta,
20
+ ?success: true
21
+ ) -> void
22
+
23
+ def to_hash: -> {
24
+ data: ArkEmail::Models::TrackingDeleteResponse::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,15 @@
1
+ module ArkEmail
2
+ module Models
3
+ type tracking_list_params =
4
+ { } & ArkEmail::Internal::Type::request_parameters
5
+
6
+ class TrackingListParams < 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,40 @@
1
+ module ArkEmail
2
+ module Models
3
+ type tracking_list_response =
4
+ {
5
+ data: ArkEmail::Models::TrackingListResponse::Data,
6
+ meta: ArkEmail::APIMeta,
7
+ success: true
8
+ }
9
+
10
+ class TrackingListResponse < ArkEmail::Internal::Type::BaseModel
11
+ attr_accessor data: ArkEmail::Models::TrackingListResponse::Data
12
+
13
+ attr_accessor meta: ArkEmail::APIMeta
14
+
15
+ attr_accessor success: true
16
+
17
+ def initialize: (
18
+ data: ArkEmail::Models::TrackingListResponse::Data,
19
+ meta: ArkEmail::APIMeta,
20
+ ?success: true
21
+ ) -> void
22
+
23
+ def to_hash: -> {
24
+ data: ArkEmail::Models::TrackingListResponse::Data,
25
+ meta: ArkEmail::APIMeta,
26
+ success: true
27
+ }
28
+
29
+ type data = { track_domains: ::Array[ArkEmail::TrackDomain] }
30
+
31
+ class Data < ArkEmail::Internal::Type::BaseModel
32
+ attr_accessor track_domains: ::Array[ArkEmail::TrackDomain]
33
+
34
+ def initialize: (track_domains: ::Array[ArkEmail::TrackDomain]) -> void
35
+
36
+ def to_hash: -> { track_domains: ::Array[ArkEmail::TrackDomain] }
37
+ end
38
+ end
39
+ end
40
+ end
@@ -0,0 +1,15 @@
1
+ module ArkEmail
2
+ module Models
3
+ type tracking_retrieve_params =
4
+ { } & ArkEmail::Internal::Type::request_parameters
5
+
6
+ class TrackingRetrieveParams < 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,26 @@
1
+ module ArkEmail
2
+ module Models
3
+ type tracking_retrieve_response =
4
+ { data: ArkEmail::TrackDomain, meta: ArkEmail::APIMeta, success: true }
5
+
6
+ class TrackingRetrieveResponse < ArkEmail::Internal::Type::BaseModel
7
+ attr_accessor data: ArkEmail::TrackDomain
8
+
9
+ attr_accessor meta: ArkEmail::APIMeta
10
+
11
+ attr_accessor success: true
12
+
13
+ def initialize: (
14
+ data: ArkEmail::TrackDomain,
15
+ meta: ArkEmail::APIMeta,
16
+ ?success: true
17
+ ) -> void
18
+
19
+ def to_hash: -> {
20
+ data: ArkEmail::TrackDomain,
21
+ meta: ArkEmail::APIMeta,
22
+ success: true
23
+ }
24
+ end
25
+ end
26
+ end
@@ -0,0 +1,49 @@
1
+ module ArkEmail
2
+ module Models
3
+ type tracking_update_params =
4
+ {
5
+ excluded_click_domains: String,
6
+ ssl_enabled: bool,
7
+ track_clicks: bool,
8
+ track_opens: bool
9
+ }
10
+ & ArkEmail::Internal::Type::request_parameters
11
+
12
+ class TrackingUpdateParams < ArkEmail::Internal::Type::BaseModel
13
+ extend ArkEmail::Internal::Type::RequestParameters::Converter
14
+ include ArkEmail::Internal::Type::RequestParameters
15
+
16
+ attr_reader excluded_click_domains: String?
17
+
18
+ def excluded_click_domains=: (String) -> String
19
+
20
+ attr_reader ssl_enabled: bool?
21
+
22
+ def ssl_enabled=: (bool) -> bool
23
+
24
+ attr_reader track_clicks: bool?
25
+
26
+ def track_clicks=: (bool) -> bool
27
+
28
+ attr_reader track_opens: bool?
29
+
30
+ def track_opens=: (bool) -> bool
31
+
32
+ def initialize: (
33
+ ?excluded_click_domains: String,
34
+ ?ssl_enabled: bool,
35
+ ?track_clicks: bool,
36
+ ?track_opens: bool,
37
+ ?request_options: ArkEmail::request_opts
38
+ ) -> void
39
+
40
+ def to_hash: -> {
41
+ excluded_click_domains: String,
42
+ ssl_enabled: bool,
43
+ track_clicks: bool,
44
+ track_opens: bool,
45
+ request_options: ArkEmail::RequestOptions
46
+ }
47
+ end
48
+ end
49
+ end
@@ -0,0 +1,26 @@
1
+ module ArkEmail
2
+ module Models
3
+ type tracking_update_response =
4
+ { data: ArkEmail::TrackDomain, meta: ArkEmail::APIMeta, success: true }
5
+
6
+ class TrackingUpdateResponse < ArkEmail::Internal::Type::BaseModel
7
+ attr_accessor data: ArkEmail::TrackDomain
8
+
9
+ attr_accessor meta: ArkEmail::APIMeta
10
+
11
+ attr_accessor success: true
12
+
13
+ def initialize: (
14
+ data: ArkEmail::TrackDomain,
15
+ meta: ArkEmail::APIMeta,
16
+ ?success: true
17
+ ) -> void
18
+
19
+ def to_hash: -> {
20
+ data: ArkEmail::TrackDomain,
21
+ meta: ArkEmail::APIMeta,
22
+ success: true
23
+ }
24
+ end
25
+ end
26
+ end
@@ -0,0 +1,15 @@
1
+ module ArkEmail
2
+ module Models
3
+ type tracking_verify_params =
4
+ { } & ArkEmail::Internal::Type::request_parameters
5
+
6
+ class TrackingVerifyParams < 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