ark-email 0.13.0 → 0.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +24 -0
- data/README.md +3 -3
- data/lib/ark_email/client.rb +8 -0
- data/lib/ark_email/models/dns_record.rb +49 -19
- data/lib/ark_email/models/domain_create_response.rb +117 -25
- data/lib/ark_email/models/domain_list_response.rb +12 -13
- data/lib/ark_email/models/domain_retrieve_response.rb +117 -25
- data/lib/ark_email/models/domain_verify_response.rb +117 -25
- data/lib/ark_email/models/email_retrieve_params.rb +4 -1
- data/lib/ark_email/models/email_retrieve_response.rb +177 -1
- data/lib/ark_email/models/log_entry.rb +298 -0
- data/lib/ark_email/models/log_entry_detail.rb +102 -0
- data/lib/ark_email/models/log_list_params.rb +106 -0
- data/lib/ark_email/models/log_retrieve_params.rb +14 -0
- data/lib/ark_email/models/log_retrieve_response.rb +33 -0
- data/lib/ark_email/models/track_domain.rb +6 -2
- data/lib/ark_email/models/usage_retrieve_params.rb +14 -0
- data/lib/ark_email/models/usage_retrieve_response.rb +270 -0
- data/lib/ark_email/models/webhook_create_params.rb +0 -2
- data/lib/ark_email/models/webhook_create_response.rb +0 -2
- data/lib/ark_email/models/webhook_list_deliveries_params.rb +0 -2
- data/lib/ark_email/models/webhook_list_deliveries_response.rb +0 -2
- data/lib/ark_email/models/webhook_retrieve_delivery_response.rb +0 -2
- data/lib/ark_email/models/webhook_retrieve_response.rb +0 -2
- data/lib/ark_email/models/webhook_test_params.rb +0 -2
- data/lib/ark_email/models/webhook_update_response.rb +0 -2
- data/lib/ark_email/models.rb +10 -0
- data/lib/ark_email/resources/logs.rb +120 -0
- data/lib/ark_email/resources/usage.rb +51 -0
- data/lib/ark_email/version.rb +1 -1
- data/lib/ark_email.rb +9 -0
- data/rbi/ark_email/client.rbi +6 -0
- data/rbi/ark_email/models/dns_record.rbi +57 -22
- data/rbi/ark_email/models/domain_create_response.rbi +189 -28
- data/rbi/ark_email/models/domain_list_response.rbi +13 -19
- data/rbi/ark_email/models/domain_retrieve_response.rbi +191 -28
- data/rbi/ark_email/models/domain_verify_response.rbi +189 -28
- data/rbi/ark_email/models/email_retrieve_params.rbi +8 -2
- data/rbi/ark_email/models/email_retrieve_response.rbi +379 -0
- data/rbi/ark_email/models/log_entry.rbi +431 -0
- data/rbi/ark_email/models/log_entry_detail.rbi +192 -0
- data/rbi/ark_email/models/log_list_params.rbi +163 -0
- data/rbi/ark_email/models/log_retrieve_params.rbi +27 -0
- data/rbi/ark_email/models/log_retrieve_response.rbi +59 -0
- data/rbi/ark_email/models/track_domain.rbi +4 -2
- data/rbi/ark_email/models/usage_retrieve_params.rbi +27 -0
- data/rbi/ark_email/models/usage_retrieve_response.rbi +511 -0
- data/rbi/ark_email/models/webhook_create_params.rbi +0 -10
- data/rbi/ark_email/models/webhook_create_response.rbi +0 -10
- data/rbi/ark_email/models/webhook_list_deliveries_params.rbi +0 -10
- data/rbi/ark_email/models/webhook_list_deliveries_response.rbi +0 -10
- data/rbi/ark_email/models/webhook_retrieve_delivery_response.rbi +0 -10
- data/rbi/ark_email/models/webhook_retrieve_response.rbi +0 -10
- data/rbi/ark_email/models/webhook_test_params.rbi +0 -10
- data/rbi/ark_email/models/webhook_update_response.rbi +0 -10
- data/rbi/ark_email/models.rbi +10 -0
- data/rbi/ark_email/resources/emails.rbi +4 -1
- data/rbi/ark_email/resources/logs.rbi +104 -0
- data/rbi/ark_email/resources/usage.rbi +40 -0
- data/sig/ark_email/client.rbs +4 -0
- data/sig/ark_email/models/dns_record.rbs +5 -0
- data/sig/ark_email/models/domain_create_response.rbs +27 -20
- data/sig/ark_email/models/domain_list_response.rbs +4 -16
- data/sig/ark_email/models/domain_retrieve_response.rbs +27 -20
- data/sig/ark_email/models/domain_verify_response.rbs +27 -20
- data/sig/ark_email/models/email_retrieve_response.rbs +179 -0
- data/sig/ark_email/models/log_entry.rbs +209 -0
- data/sig/ark_email/models/log_entry_detail.rbs +97 -0
- data/sig/ark_email/models/log_list_params.rbs +97 -0
- data/sig/ark_email/models/log_retrieve_params.rbs +15 -0
- data/sig/ark_email/models/log_retrieve_response.rbs +26 -0
- data/sig/ark_email/models/usage_retrieve_params.rbs +15 -0
- data/sig/ark_email/models/usage_retrieve_response.rbs +212 -0
- data/sig/ark_email/models/webhook_create_params.rbs +0 -4
- data/sig/ark_email/models/webhook_create_response.rbs +0 -4
- data/sig/ark_email/models/webhook_list_deliveries_params.rbs +0 -4
- data/sig/ark_email/models/webhook_list_deliveries_response.rbs +0 -4
- data/sig/ark_email/models/webhook_retrieve_delivery_response.rbs +0 -4
- data/sig/ark_email/models/webhook_retrieve_response.rbs +0 -4
- data/sig/ark_email/models/webhook_test_params.rbs +0 -4
- data/sig/ark_email/models/webhook_update_response.rbs +0 -4
- data/sig/ark_email/models.rbs +10 -0
- data/sig/ark_email/resources/logs.rbs +25 -0
- data/sig/ark_email/resources/usage.rbs +11 -0
- metadata +29 -2
|
@@ -37,11 +37,14 @@ module ArkEmail
|
|
|
37
37
|
timestamp: Float,
|
|
38
38
|
timestamp_iso: Time,
|
|
39
39
|
to: String,
|
|
40
|
+
activity: ArkEmail::Models::EmailRetrieveResponse::Data::Activity,
|
|
41
|
+
attachments: ::Array[ArkEmail::Models::EmailRetrieveResponse::Data::Attachment],
|
|
40
42
|
deliveries: ::Array[ArkEmail::Models::EmailRetrieveResponse::Data::Delivery],
|
|
41
43
|
headers: ::Hash[Symbol, String],
|
|
42
44
|
html_body: String,
|
|
43
45
|
message_id: String,
|
|
44
46
|
plain_body: String,
|
|
47
|
+
raw_message: String,
|
|
45
48
|
spam: bool,
|
|
46
49
|
spam_score: Float,
|
|
47
50
|
tag: String
|
|
@@ -66,6 +69,18 @@ module ArkEmail
|
|
|
66
69
|
|
|
67
70
|
attr_accessor to: String
|
|
68
71
|
|
|
72
|
+
attr_reader activity: ArkEmail::Models::EmailRetrieveResponse::Data::Activity?
|
|
73
|
+
|
|
74
|
+
def activity=: (
|
|
75
|
+
ArkEmail::Models::EmailRetrieveResponse::Data::Activity
|
|
76
|
+
) -> ArkEmail::Models::EmailRetrieveResponse::Data::Activity
|
|
77
|
+
|
|
78
|
+
attr_reader attachments: ::Array[ArkEmail::Models::EmailRetrieveResponse::Data::Attachment]?
|
|
79
|
+
|
|
80
|
+
def attachments=: (
|
|
81
|
+
::Array[ArkEmail::Models::EmailRetrieveResponse::Data::Attachment]
|
|
82
|
+
) -> ::Array[ArkEmail::Models::EmailRetrieveResponse::Data::Attachment]
|
|
83
|
+
|
|
69
84
|
attr_reader deliveries: ::Array[ArkEmail::Models::EmailRetrieveResponse::Data::Delivery]?
|
|
70
85
|
|
|
71
86
|
def deliveries=: (
|
|
@@ -88,6 +103,10 @@ module ArkEmail
|
|
|
88
103
|
|
|
89
104
|
def plain_body=: (String) -> String
|
|
90
105
|
|
|
106
|
+
attr_reader raw_message: String?
|
|
107
|
+
|
|
108
|
+
def raw_message=: (String) -> String
|
|
109
|
+
|
|
91
110
|
attr_reader spam: bool?
|
|
92
111
|
|
|
93
112
|
def spam=: (bool) -> bool
|
|
@@ -110,11 +129,14 @@ module ArkEmail
|
|
|
110
129
|
timestamp: Float,
|
|
111
130
|
timestamp_iso: Time,
|
|
112
131
|
to: String,
|
|
132
|
+
?activity: ArkEmail::Models::EmailRetrieveResponse::Data::Activity,
|
|
133
|
+
?attachments: ::Array[ArkEmail::Models::EmailRetrieveResponse::Data::Attachment],
|
|
113
134
|
?deliveries: ::Array[ArkEmail::Models::EmailRetrieveResponse::Data::Delivery],
|
|
114
135
|
?headers: ::Hash[Symbol, String],
|
|
115
136
|
?html_body: String,
|
|
116
137
|
?message_id: String,
|
|
117
138
|
?plain_body: String,
|
|
139
|
+
?raw_message: String,
|
|
118
140
|
?spam: bool,
|
|
119
141
|
?spam_score: Float,
|
|
120
142
|
?tag: String
|
|
@@ -130,11 +152,14 @@ module ArkEmail
|
|
|
130
152
|
timestamp: Float,
|
|
131
153
|
timestamp_iso: Time,
|
|
132
154
|
to: String,
|
|
155
|
+
activity: ArkEmail::Models::EmailRetrieveResponse::Data::Activity,
|
|
156
|
+
attachments: ::Array[ArkEmail::Models::EmailRetrieveResponse::Data::Attachment],
|
|
133
157
|
deliveries: ::Array[ArkEmail::Models::EmailRetrieveResponse::Data::Delivery],
|
|
134
158
|
headers: ::Hash[Symbol, String],
|
|
135
159
|
html_body: String,
|
|
136
160
|
message_id: String,
|
|
137
161
|
plain_body: String,
|
|
162
|
+
raw_message: String,
|
|
138
163
|
spam: bool,
|
|
139
164
|
spam_score: Float,
|
|
140
165
|
tag: String
|
|
@@ -167,6 +192,160 @@ module ArkEmail
|
|
|
167
192
|
def self?.values: -> ::Array[ArkEmail::Models::EmailRetrieveResponse::Data::status]
|
|
168
193
|
end
|
|
169
194
|
|
|
195
|
+
type activity =
|
|
196
|
+
{
|
|
197
|
+
clicks: ::Array[ArkEmail::Models::EmailRetrieveResponse::Data::Activity::Click],
|
|
198
|
+
opens: ::Array[ArkEmail::Models::EmailRetrieveResponse::Data::Activity::Open]
|
|
199
|
+
}
|
|
200
|
+
|
|
201
|
+
class Activity < ArkEmail::Internal::Type::BaseModel
|
|
202
|
+
attr_reader clicks: ::Array[ArkEmail::Models::EmailRetrieveResponse::Data::Activity::Click]?
|
|
203
|
+
|
|
204
|
+
def clicks=: (
|
|
205
|
+
::Array[ArkEmail::Models::EmailRetrieveResponse::Data::Activity::Click]
|
|
206
|
+
) -> ::Array[ArkEmail::Models::EmailRetrieveResponse::Data::Activity::Click]
|
|
207
|
+
|
|
208
|
+
attr_reader opens: ::Array[ArkEmail::Models::EmailRetrieveResponse::Data::Activity::Open]?
|
|
209
|
+
|
|
210
|
+
def opens=: (
|
|
211
|
+
::Array[ArkEmail::Models::EmailRetrieveResponse::Data::Activity::Open]
|
|
212
|
+
) -> ::Array[ArkEmail::Models::EmailRetrieveResponse::Data::Activity::Open]
|
|
213
|
+
|
|
214
|
+
def initialize: (
|
|
215
|
+
?clicks: ::Array[ArkEmail::Models::EmailRetrieveResponse::Data::Activity::Click],
|
|
216
|
+
?opens: ::Array[ArkEmail::Models::EmailRetrieveResponse::Data::Activity::Open]
|
|
217
|
+
) -> void
|
|
218
|
+
|
|
219
|
+
def to_hash: -> {
|
|
220
|
+
clicks: ::Array[ArkEmail::Models::EmailRetrieveResponse::Data::Activity::Click],
|
|
221
|
+
opens: ::Array[ArkEmail::Models::EmailRetrieveResponse::Data::Activity::Open]
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
type click =
|
|
225
|
+
{
|
|
226
|
+
ip_address: String,
|
|
227
|
+
timestamp: Float,
|
|
228
|
+
timestamp_iso: Time,
|
|
229
|
+
url: String,
|
|
230
|
+
user_agent: String
|
|
231
|
+
}
|
|
232
|
+
|
|
233
|
+
class Click < ArkEmail::Internal::Type::BaseModel
|
|
234
|
+
attr_reader ip_address: String?
|
|
235
|
+
|
|
236
|
+
def ip_address=: (String) -> String
|
|
237
|
+
|
|
238
|
+
attr_reader timestamp: Float?
|
|
239
|
+
|
|
240
|
+
def timestamp=: (Float) -> Float
|
|
241
|
+
|
|
242
|
+
attr_reader timestamp_iso: Time?
|
|
243
|
+
|
|
244
|
+
def timestamp_iso=: (Time) -> Time
|
|
245
|
+
|
|
246
|
+
attr_reader url: String?
|
|
247
|
+
|
|
248
|
+
def url=: (String) -> String
|
|
249
|
+
|
|
250
|
+
attr_reader user_agent: String?
|
|
251
|
+
|
|
252
|
+
def user_agent=: (String) -> String
|
|
253
|
+
|
|
254
|
+
def initialize: (
|
|
255
|
+
?ip_address: String,
|
|
256
|
+
?timestamp: Float,
|
|
257
|
+
?timestamp_iso: Time,
|
|
258
|
+
?url: String,
|
|
259
|
+
?user_agent: String
|
|
260
|
+
) -> void
|
|
261
|
+
|
|
262
|
+
def to_hash: -> {
|
|
263
|
+
ip_address: String,
|
|
264
|
+
timestamp: Float,
|
|
265
|
+
timestamp_iso: Time,
|
|
266
|
+
url: String,
|
|
267
|
+
user_agent: String
|
|
268
|
+
}
|
|
269
|
+
end
|
|
270
|
+
|
|
271
|
+
type open_ =
|
|
272
|
+
{
|
|
273
|
+
ip_address: String,
|
|
274
|
+
timestamp: Float,
|
|
275
|
+
timestamp_iso: Time,
|
|
276
|
+
user_agent: String
|
|
277
|
+
}
|
|
278
|
+
|
|
279
|
+
class Open < ArkEmail::Internal::Type::BaseModel
|
|
280
|
+
attr_reader ip_address: String?
|
|
281
|
+
|
|
282
|
+
def ip_address=: (String) -> String
|
|
283
|
+
|
|
284
|
+
attr_reader timestamp: Float?
|
|
285
|
+
|
|
286
|
+
def timestamp=: (Float) -> Float
|
|
287
|
+
|
|
288
|
+
attr_reader timestamp_iso: Time?
|
|
289
|
+
|
|
290
|
+
def timestamp_iso=: (Time) -> Time
|
|
291
|
+
|
|
292
|
+
attr_reader user_agent: String?
|
|
293
|
+
|
|
294
|
+
def user_agent=: (String) -> String
|
|
295
|
+
|
|
296
|
+
def initialize: (
|
|
297
|
+
?ip_address: String,
|
|
298
|
+
?timestamp: Float,
|
|
299
|
+
?timestamp_iso: Time,
|
|
300
|
+
?user_agent: String
|
|
301
|
+
) -> void
|
|
302
|
+
|
|
303
|
+
def to_hash: -> {
|
|
304
|
+
ip_address: String,
|
|
305
|
+
timestamp: Float,
|
|
306
|
+
timestamp_iso: Time,
|
|
307
|
+
user_agent: String
|
|
308
|
+
}
|
|
309
|
+
end
|
|
310
|
+
end
|
|
311
|
+
|
|
312
|
+
type attachment =
|
|
313
|
+
{
|
|
314
|
+
content_type: String,
|
|
315
|
+
data: String,
|
|
316
|
+
filename: String,
|
|
317
|
+
hash_: String,
|
|
318
|
+
size: Integer
|
|
319
|
+
}
|
|
320
|
+
|
|
321
|
+
class Attachment < ArkEmail::Internal::Type::BaseModel
|
|
322
|
+
attr_accessor content_type: String
|
|
323
|
+
|
|
324
|
+
attr_accessor data: String
|
|
325
|
+
|
|
326
|
+
attr_accessor filename: String
|
|
327
|
+
|
|
328
|
+
attr_accessor hash_: String
|
|
329
|
+
|
|
330
|
+
attr_accessor size: Integer
|
|
331
|
+
|
|
332
|
+
def initialize: (
|
|
333
|
+
content_type: String,
|
|
334
|
+
data: String,
|
|
335
|
+
filename: String,
|
|
336
|
+
hash_: String,
|
|
337
|
+
size: Integer
|
|
338
|
+
) -> void
|
|
339
|
+
|
|
340
|
+
def to_hash: -> {
|
|
341
|
+
content_type: String,
|
|
342
|
+
data: String,
|
|
343
|
+
filename: String,
|
|
344
|
+
hash_: String,
|
|
345
|
+
size: Integer
|
|
346
|
+
}
|
|
347
|
+
end
|
|
348
|
+
|
|
170
349
|
type delivery =
|
|
171
350
|
{
|
|
172
351
|
id: String,
|
|
@@ -0,0 +1,209 @@
|
|
|
1
|
+
module ArkEmail
|
|
2
|
+
module Models
|
|
3
|
+
type log_entry =
|
|
4
|
+
{
|
|
5
|
+
context: ArkEmail::LogEntry::Context,
|
|
6
|
+
credential: ArkEmail::LogEntry::Credential,
|
|
7
|
+
duration_ms: Integer,
|
|
8
|
+
endpoint: String,
|
|
9
|
+
method_: ArkEmail::Models::LogEntry::method_,
|
|
10
|
+
path: String,
|
|
11
|
+
rate_limit: ArkEmail::LogEntry::RateLimit,
|
|
12
|
+
request_id: String,
|
|
13
|
+
status_code: Integer,
|
|
14
|
+
timestamp: Time,
|
|
15
|
+
email: ArkEmail::LogEntry::Email?,
|
|
16
|
+
error: ArkEmail::LogEntry::Error?,
|
|
17
|
+
sdk: ArkEmail::LogEntry::SDK?
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
class LogEntry < ArkEmail::Internal::Type::BaseModel
|
|
21
|
+
attr_accessor context: ArkEmail::LogEntry::Context
|
|
22
|
+
|
|
23
|
+
attr_accessor credential: ArkEmail::LogEntry::Credential
|
|
24
|
+
|
|
25
|
+
attr_accessor duration_ms: Integer
|
|
26
|
+
|
|
27
|
+
attr_accessor endpoint: String
|
|
28
|
+
|
|
29
|
+
attr_accessor method_: ArkEmail::Models::LogEntry::method_
|
|
30
|
+
|
|
31
|
+
attr_accessor path: String
|
|
32
|
+
|
|
33
|
+
attr_accessor rate_limit: ArkEmail::LogEntry::RateLimit
|
|
34
|
+
|
|
35
|
+
attr_accessor request_id: String
|
|
36
|
+
|
|
37
|
+
attr_accessor status_code: Integer
|
|
38
|
+
|
|
39
|
+
attr_accessor timestamp: Time
|
|
40
|
+
|
|
41
|
+
attr_accessor email: ArkEmail::LogEntry::Email?
|
|
42
|
+
|
|
43
|
+
attr_accessor error: ArkEmail::LogEntry::Error?
|
|
44
|
+
|
|
45
|
+
attr_accessor sdk: ArkEmail::LogEntry::SDK?
|
|
46
|
+
|
|
47
|
+
def initialize: (
|
|
48
|
+
context: ArkEmail::LogEntry::Context,
|
|
49
|
+
credential: ArkEmail::LogEntry::Credential,
|
|
50
|
+
duration_ms: Integer,
|
|
51
|
+
endpoint: String,
|
|
52
|
+
method_: ArkEmail::Models::LogEntry::method_,
|
|
53
|
+
path: String,
|
|
54
|
+
rate_limit: ArkEmail::LogEntry::RateLimit,
|
|
55
|
+
request_id: String,
|
|
56
|
+
status_code: Integer,
|
|
57
|
+
timestamp: Time,
|
|
58
|
+
?email: ArkEmail::LogEntry::Email?,
|
|
59
|
+
?error: ArkEmail::LogEntry::Error?,
|
|
60
|
+
?sdk: ArkEmail::LogEntry::SDK?
|
|
61
|
+
) -> void
|
|
62
|
+
|
|
63
|
+
def to_hash: -> {
|
|
64
|
+
context: ArkEmail::LogEntry::Context,
|
|
65
|
+
credential: ArkEmail::LogEntry::Credential,
|
|
66
|
+
duration_ms: Integer,
|
|
67
|
+
endpoint: String,
|
|
68
|
+
method_: ArkEmail::Models::LogEntry::method_,
|
|
69
|
+
path: String,
|
|
70
|
+
rate_limit: ArkEmail::LogEntry::RateLimit,
|
|
71
|
+
request_id: String,
|
|
72
|
+
status_code: Integer,
|
|
73
|
+
timestamp: Time,
|
|
74
|
+
email: ArkEmail::LogEntry::Email?,
|
|
75
|
+
error: ArkEmail::LogEntry::Error?,
|
|
76
|
+
sdk: ArkEmail::LogEntry::SDK?
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
type context =
|
|
80
|
+
{
|
|
81
|
+
idempotency_key: String?,
|
|
82
|
+
ip_address: String?,
|
|
83
|
+
query_params: ::Hash[Symbol, top]?,
|
|
84
|
+
user_agent: String?
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
class Context < ArkEmail::Internal::Type::BaseModel
|
|
88
|
+
attr_accessor idempotency_key: String?
|
|
89
|
+
|
|
90
|
+
attr_accessor ip_address: String?
|
|
91
|
+
|
|
92
|
+
attr_accessor query_params: ::Hash[Symbol, top]?
|
|
93
|
+
|
|
94
|
+
attr_accessor user_agent: String?
|
|
95
|
+
|
|
96
|
+
def initialize: (
|
|
97
|
+
?idempotency_key: String?,
|
|
98
|
+
?ip_address: String?,
|
|
99
|
+
?query_params: ::Hash[Symbol, top]?,
|
|
100
|
+
?user_agent: String?
|
|
101
|
+
) -> void
|
|
102
|
+
|
|
103
|
+
def to_hash: -> {
|
|
104
|
+
idempotency_key: String?,
|
|
105
|
+
ip_address: String?,
|
|
106
|
+
query_params: ::Hash[Symbol, top]?,
|
|
107
|
+
user_agent: String?
|
|
108
|
+
}
|
|
109
|
+
end
|
|
110
|
+
|
|
111
|
+
type credential = { id: String, key_prefix: String? }
|
|
112
|
+
|
|
113
|
+
class Credential < ArkEmail::Internal::Type::BaseModel
|
|
114
|
+
attr_accessor id: String
|
|
115
|
+
|
|
116
|
+
attr_accessor key_prefix: String?
|
|
117
|
+
|
|
118
|
+
def initialize: (id: String, ?key_prefix: String?) -> void
|
|
119
|
+
|
|
120
|
+
def to_hash: -> { id: String, key_prefix: String? }
|
|
121
|
+
end
|
|
122
|
+
|
|
123
|
+
type method_ = :GET | :POST | :PUT | :PATCH | :DELETE
|
|
124
|
+
|
|
125
|
+
module Method
|
|
126
|
+
extend ArkEmail::Internal::Type::Enum
|
|
127
|
+
|
|
128
|
+
GET: :GET
|
|
129
|
+
POST: :POST
|
|
130
|
+
PUT: :PUT
|
|
131
|
+
PATCH: :PATCH
|
|
132
|
+
DELETE: :DELETE
|
|
133
|
+
|
|
134
|
+
def self?.values: -> ::Array[ArkEmail::Models::LogEntry::method_]
|
|
135
|
+
end
|
|
136
|
+
|
|
137
|
+
type rate_limit =
|
|
138
|
+
{ limit: Integer?, limited: bool, remaining: Integer?, reset: Integer? }
|
|
139
|
+
|
|
140
|
+
class RateLimit < ArkEmail::Internal::Type::BaseModel
|
|
141
|
+
attr_accessor limit: Integer?
|
|
142
|
+
|
|
143
|
+
attr_reader limited: bool?
|
|
144
|
+
|
|
145
|
+
def limited=: (bool) -> bool
|
|
146
|
+
|
|
147
|
+
attr_accessor remaining: Integer?
|
|
148
|
+
|
|
149
|
+
attr_accessor reset: Integer?
|
|
150
|
+
|
|
151
|
+
def initialize: (
|
|
152
|
+
?limit: Integer?,
|
|
153
|
+
?limited: bool,
|
|
154
|
+
?remaining: Integer?,
|
|
155
|
+
?reset: Integer?
|
|
156
|
+
) -> void
|
|
157
|
+
|
|
158
|
+
def to_hash: -> {
|
|
159
|
+
limit: Integer?,
|
|
160
|
+
limited: bool,
|
|
161
|
+
remaining: Integer?,
|
|
162
|
+
reset: Integer?
|
|
163
|
+
}
|
|
164
|
+
end
|
|
165
|
+
|
|
166
|
+
type email = { id: String, recipient_count: Integer? }
|
|
167
|
+
|
|
168
|
+
class Email < ArkEmail::Internal::Type::BaseModel
|
|
169
|
+
attr_reader id: String?
|
|
170
|
+
|
|
171
|
+
def id=: (String) -> String
|
|
172
|
+
|
|
173
|
+
attr_accessor recipient_count: Integer?
|
|
174
|
+
|
|
175
|
+
def initialize: (?id: String, ?recipient_count: Integer?) -> void
|
|
176
|
+
|
|
177
|
+
def to_hash: -> { id: String, recipient_count: Integer? }
|
|
178
|
+
end
|
|
179
|
+
|
|
180
|
+
type error = { code: String, message: String? }
|
|
181
|
+
|
|
182
|
+
class Error < ArkEmail::Internal::Type::BaseModel
|
|
183
|
+
attr_reader code: String?
|
|
184
|
+
|
|
185
|
+
def code=: (String) -> String
|
|
186
|
+
|
|
187
|
+
attr_accessor message: String?
|
|
188
|
+
|
|
189
|
+
def initialize: (?code: String, ?message: String?) -> void
|
|
190
|
+
|
|
191
|
+
def to_hash: -> { code: String, message: String? }
|
|
192
|
+
end
|
|
193
|
+
|
|
194
|
+
type sdk = { name: String, version: String? }
|
|
195
|
+
|
|
196
|
+
class SDK < ArkEmail::Internal::Type::BaseModel
|
|
197
|
+
attr_reader name: String?
|
|
198
|
+
|
|
199
|
+
def name=: (String) -> String
|
|
200
|
+
|
|
201
|
+
attr_accessor version: String?
|
|
202
|
+
|
|
203
|
+
def initialize: (?name: String, ?version: String?) -> void
|
|
204
|
+
|
|
205
|
+
def to_hash: -> { name: String, version: String? }
|
|
206
|
+
end
|
|
207
|
+
end
|
|
208
|
+
end
|
|
209
|
+
end
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
module ArkEmail
|
|
2
|
+
module Models
|
|
3
|
+
type log_entry_detail =
|
|
4
|
+
{
|
|
5
|
+
request: ArkEmail::LogEntryDetail::Request,
|
|
6
|
+
response: ArkEmail::LogEntryDetail::Response
|
|
7
|
+
}
|
|
8
|
+
|
|
9
|
+
class LogEntryDetail < ArkEmail::Models::LogEntry
|
|
10
|
+
def request: -> ArkEmail::LogEntryDetail::Request?
|
|
11
|
+
|
|
12
|
+
def request=: (
|
|
13
|
+
ArkEmail::LogEntryDetail::Request _
|
|
14
|
+
) -> ArkEmail::LogEntryDetail::Request
|
|
15
|
+
|
|
16
|
+
def response: -> ArkEmail::LogEntryDetail::Response?
|
|
17
|
+
|
|
18
|
+
def response=: (
|
|
19
|
+
ArkEmail::LogEntryDetail::Response _
|
|
20
|
+
) -> ArkEmail::LogEntryDetail::Response
|
|
21
|
+
|
|
22
|
+
def initialize: (
|
|
23
|
+
?request: ArkEmail::LogEntryDetail::Request,
|
|
24
|
+
?response: ArkEmail::LogEntryDetail::Response
|
|
25
|
+
) -> void
|
|
26
|
+
|
|
27
|
+
def to_hash: -> {
|
|
28
|
+
request: ArkEmail::LogEntryDetail::Request,
|
|
29
|
+
response: ArkEmail::LogEntryDetail::Response
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
type request =
|
|
33
|
+
{
|
|
34
|
+
body: ArkEmail::Models::LogEntryDetail::Request::body?,
|
|
35
|
+
body_size: Integer?
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
class Request < ArkEmail::Internal::Type::BaseModel
|
|
39
|
+
attr_accessor body: ArkEmail::Models::LogEntryDetail::Request::body?
|
|
40
|
+
|
|
41
|
+
attr_accessor body_size: Integer?
|
|
42
|
+
|
|
43
|
+
def initialize: (
|
|
44
|
+
?body: ArkEmail::Models::LogEntryDetail::Request::body?,
|
|
45
|
+
?body_size: Integer?
|
|
46
|
+
) -> void
|
|
47
|
+
|
|
48
|
+
def to_hash: -> {
|
|
49
|
+
body: ArkEmail::Models::LogEntryDetail::Request::body?,
|
|
50
|
+
body_size: Integer?
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
type body = ::Hash[Symbol, top] | String
|
|
54
|
+
|
|
55
|
+
module Body
|
|
56
|
+
extend ArkEmail::Internal::Type::Union
|
|
57
|
+
|
|
58
|
+
def self?.variants: -> ::Array[ArkEmail::Models::LogEntryDetail::Request::body]
|
|
59
|
+
|
|
60
|
+
UnionMember0Map: ArkEmail::Internal::Type::Converter
|
|
61
|
+
end
|
|
62
|
+
end
|
|
63
|
+
|
|
64
|
+
type response =
|
|
65
|
+
{
|
|
66
|
+
body: ArkEmail::Models::LogEntryDetail::Response::body?,
|
|
67
|
+
body_size: Integer?
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
class Response < ArkEmail::Internal::Type::BaseModel
|
|
71
|
+
attr_accessor body: ArkEmail::Models::LogEntryDetail::Response::body?
|
|
72
|
+
|
|
73
|
+
attr_accessor body_size: Integer?
|
|
74
|
+
|
|
75
|
+
def initialize: (
|
|
76
|
+
?body: ArkEmail::Models::LogEntryDetail::Response::body?,
|
|
77
|
+
?body_size: Integer?
|
|
78
|
+
) -> void
|
|
79
|
+
|
|
80
|
+
def to_hash: -> {
|
|
81
|
+
body: ArkEmail::Models::LogEntryDetail::Response::body?,
|
|
82
|
+
body_size: Integer?
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
type body = ::Hash[Symbol, top] | String
|
|
86
|
+
|
|
87
|
+
module Body
|
|
88
|
+
extend ArkEmail::Internal::Type::Union
|
|
89
|
+
|
|
90
|
+
def self?.variants: -> ::Array[ArkEmail::Models::LogEntryDetail::Response::body]
|
|
91
|
+
|
|
92
|
+
UnionMember0Map: ArkEmail::Internal::Type::Converter
|
|
93
|
+
end
|
|
94
|
+
end
|
|
95
|
+
end
|
|
96
|
+
end
|
|
97
|
+
end
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
module ArkEmail
|
|
2
|
+
module Models
|
|
3
|
+
type log_list_params =
|
|
4
|
+
{
|
|
5
|
+
credential_id: String,
|
|
6
|
+
end_date: Time,
|
|
7
|
+
endpoint: String,
|
|
8
|
+
page: Integer,
|
|
9
|
+
per_page: Integer,
|
|
10
|
+
request_id: String,
|
|
11
|
+
start_date: Time,
|
|
12
|
+
status: ArkEmail::Models::LogListParams::status,
|
|
13
|
+
status_code: Integer
|
|
14
|
+
}
|
|
15
|
+
& ArkEmail::Internal::Type::request_parameters
|
|
16
|
+
|
|
17
|
+
class LogListParams < ArkEmail::Internal::Type::BaseModel
|
|
18
|
+
extend ArkEmail::Internal::Type::RequestParameters::Converter
|
|
19
|
+
include ArkEmail::Internal::Type::RequestParameters
|
|
20
|
+
|
|
21
|
+
attr_reader credential_id: String?
|
|
22
|
+
|
|
23
|
+
def credential_id=: (String) -> String
|
|
24
|
+
|
|
25
|
+
attr_reader end_date: Time?
|
|
26
|
+
|
|
27
|
+
def end_date=: (Time) -> Time
|
|
28
|
+
|
|
29
|
+
attr_reader endpoint: String?
|
|
30
|
+
|
|
31
|
+
def endpoint=: (String) -> String
|
|
32
|
+
|
|
33
|
+
attr_reader page: Integer?
|
|
34
|
+
|
|
35
|
+
def page=: (Integer) -> Integer
|
|
36
|
+
|
|
37
|
+
attr_reader per_page: Integer?
|
|
38
|
+
|
|
39
|
+
def per_page=: (Integer) -> Integer
|
|
40
|
+
|
|
41
|
+
attr_reader request_id: String?
|
|
42
|
+
|
|
43
|
+
def request_id=: (String) -> String
|
|
44
|
+
|
|
45
|
+
attr_reader start_date: Time?
|
|
46
|
+
|
|
47
|
+
def start_date=: (Time) -> Time
|
|
48
|
+
|
|
49
|
+
attr_reader status: ArkEmail::Models::LogListParams::status?
|
|
50
|
+
|
|
51
|
+
def status=: (
|
|
52
|
+
ArkEmail::Models::LogListParams::status
|
|
53
|
+
) -> ArkEmail::Models::LogListParams::status
|
|
54
|
+
|
|
55
|
+
attr_reader status_code: Integer?
|
|
56
|
+
|
|
57
|
+
def status_code=: (Integer) -> Integer
|
|
58
|
+
|
|
59
|
+
def initialize: (
|
|
60
|
+
?credential_id: String,
|
|
61
|
+
?end_date: Time,
|
|
62
|
+
?endpoint: String,
|
|
63
|
+
?page: Integer,
|
|
64
|
+
?per_page: Integer,
|
|
65
|
+
?request_id: String,
|
|
66
|
+
?start_date: Time,
|
|
67
|
+
?status: ArkEmail::Models::LogListParams::status,
|
|
68
|
+
?status_code: Integer,
|
|
69
|
+
?request_options: ArkEmail::request_opts
|
|
70
|
+
) -> void
|
|
71
|
+
|
|
72
|
+
def to_hash: -> {
|
|
73
|
+
credential_id: String,
|
|
74
|
+
end_date: Time,
|
|
75
|
+
endpoint: String,
|
|
76
|
+
page: Integer,
|
|
77
|
+
per_page: Integer,
|
|
78
|
+
request_id: String,
|
|
79
|
+
start_date: Time,
|
|
80
|
+
status: ArkEmail::Models::LogListParams::status,
|
|
81
|
+
status_code: Integer,
|
|
82
|
+
request_options: ArkEmail::RequestOptions
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
type status = :success | :error
|
|
86
|
+
|
|
87
|
+
module Status
|
|
88
|
+
extend ArkEmail::Internal::Type::Enum
|
|
89
|
+
|
|
90
|
+
SUCCESS: :success
|
|
91
|
+
ERROR: :error
|
|
92
|
+
|
|
93
|
+
def self?.values: -> ::Array[ArkEmail::Models::LogListParams::status]
|
|
94
|
+
end
|
|
95
|
+
end
|
|
96
|
+
end
|
|
97
|
+
end
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
module ArkEmail
|
|
2
|
+
module Models
|
|
3
|
+
type log_retrieve_params =
|
|
4
|
+
{ } & ArkEmail::Internal::Type::request_parameters
|
|
5
|
+
|
|
6
|
+
class LogRetrieveParams < 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 log_retrieve_response =
|
|
4
|
+
{ data: ArkEmail::LogEntryDetail, meta: ArkEmail::APIMeta, success: true }
|
|
5
|
+
|
|
6
|
+
class LogRetrieveResponse < ArkEmail::Internal::Type::BaseModel
|
|
7
|
+
attr_accessor data: ArkEmail::LogEntryDetail
|
|
8
|
+
|
|
9
|
+
attr_accessor meta: ArkEmail::APIMeta
|
|
10
|
+
|
|
11
|
+
attr_accessor success: true
|
|
12
|
+
|
|
13
|
+
def initialize: (
|
|
14
|
+
data: ArkEmail::LogEntryDetail,
|
|
15
|
+
meta: ArkEmail::APIMeta,
|
|
16
|
+
?success: true
|
|
17
|
+
) -> void
|
|
18
|
+
|
|
19
|
+
def to_hash: -> {
|
|
20
|
+
data: ArkEmail::LogEntryDetail,
|
|
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 usage_retrieve_params =
|
|
4
|
+
{ } & ArkEmail::Internal::Type::request_parameters
|
|
5
|
+
|
|
6
|
+
class UsageRetrieveParams < 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
|