ark-email 0.10.0 → 0.12.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 +19 -0
- data/README.md +1 -1
- data/lib/ark_email/models/email_send_raw_params.rb +13 -13
- data/lib/ark_email/models/webhook_create_params.rb +2 -0
- data/lib/ark_email/models/webhook_create_response.rb +2 -0
- data/lib/ark_email/models/webhook_list_deliveries_params.rb +2 -0
- data/lib/ark_email/models/webhook_list_deliveries_response.rb +2 -0
- data/lib/ark_email/models/webhook_retrieve_delivery_response.rb +2 -0
- data/lib/ark_email/models/webhook_retrieve_response.rb +2 -0
- data/lib/ark_email/models/webhook_test_params.rb +2 -0
- data/lib/ark_email/models/webhook_update_response.rb +2 -0
- data/lib/ark_email/resources/emails.rb +5 -5
- data/lib/ark_email/version.rb +1 -1
- data/rbi/ark_email/models/email_send_raw_params.rbi +18 -18
- data/rbi/ark_email/models/webhook_create_params.rbi +10 -0
- data/rbi/ark_email/models/webhook_create_response.rbi +10 -0
- data/rbi/ark_email/models/webhook_list_deliveries_params.rbi +10 -0
- data/rbi/ark_email/models/webhook_list_deliveries_response.rbi +10 -0
- data/rbi/ark_email/models/webhook_retrieve_delivery_response.rbi +10 -0
- data/rbi/ark_email/models/webhook_retrieve_response.rbi +10 -0
- data/rbi/ark_email/models/webhook_test_params.rbi +10 -0
- data/rbi/ark_email/models/webhook_update_response.rbi +10 -0
- data/rbi/ark_email/resources/emails.rbi +10 -10
- data/sig/ark_email/models/email_send_raw_params.rbs +10 -15
- data/sig/ark_email/models/webhook_create_params.rbs +4 -0
- data/sig/ark_email/models/webhook_create_response.rbs +4 -0
- data/sig/ark_email/models/webhook_list_deliveries_params.rbs +4 -0
- data/sig/ark_email/models/webhook_list_deliveries_response.rbs +4 -0
- data/sig/ark_email/models/webhook_retrieve_delivery_response.rbs +4 -0
- data/sig/ark_email/models/webhook_retrieve_response.rbs +4 -0
- data/sig/ark_email/models/webhook_test_params.rbs +4 -0
- data/sig/ark_email/models/webhook_update_response.rbs +4 -0
- data/sig/ark_email/resources/emails.rbs +3 -3
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: c00d08f6dc8c60212e04d6f91c6a2a9224a5719a1e361c7b39467b880f035ba2
|
|
4
|
+
data.tar.gz: 549a5f2e13e0ccbbb47a2c7d66f6bc8cbde7121968a633801113cb9ac074d8a6
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 0404fdb2d9cf3efbcdec7ae804e0f5ef57abd64781ee91c74d070736ad8631e7495168b22123d5eff5c7fdc42202e6148c151fef56146bf04a3566125763d9be
|
|
7
|
+
data.tar.gz: ee1ed6181c4d43550145d9924379cbd21eb36cecd8154f1d35ac0be30f975b9eb4ad9f06ae35ee26e02c0d17c8bc1be1225bea4912c78d6928d1cb47a339062b
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,24 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.12.0 (2026-01-23)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v0.11.0...v0.12.0](https://github.com/ArkHQ-io/ark-ruby/compare/v0.11.0...v0.12.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** improve raw endpoint ([a0862f2](https://github.com/ArkHQ-io/ark-ruby/commit/a0862f2080187dcf8cdc0ab8d802849cdc9174ad))
|
|
10
|
+
|
|
11
|
+
## 0.11.0 (2026-01-22)
|
|
12
|
+
|
|
13
|
+
Full Changelog: [v0.10.0...v0.11.0](https://github.com/ArkHQ-io/ark-ruby/compare/v0.10.0...v0.11.0)
|
|
14
|
+
|
|
15
|
+
### Features
|
|
16
|
+
|
|
17
|
+
* **api:** api update ([451702c](https://github.com/ArkHQ-io/ark-ruby/commit/451702c378dd03df067d91d5a6b86b5c3af6e1d5))
|
|
18
|
+
* **api:** api update ([94327b4](https://github.com/ArkHQ-io/ark-ruby/commit/94327b43c646e4bf7d8ae97a6f9702d8e3768953))
|
|
19
|
+
* **api:** fix incorrect webhook payload examples ([09c481a](https://github.com/ArkHQ-io/ark-ruby/commit/09c481add3ef93c3c494403d0abce3fd09a1083d))
|
|
20
|
+
* **api:** manual updates ([d166dbe](https://github.com/ArkHQ-io/ark-ruby/commit/d166dbebf3aa3218cf3488cabadb957012114d01))
|
|
21
|
+
|
|
3
22
|
## 0.10.0 (2026-01-22)
|
|
4
23
|
|
|
5
24
|
Full Changelog: [v0.9.0...v0.10.0](https://github.com/ArkHQ-io/ark-ruby/compare/v0.9.0...v0.10.0)
|
data/README.md
CHANGED
|
@@ -7,23 +7,23 @@ module ArkEmail
|
|
|
7
7
|
extend ArkEmail::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include ArkEmail::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!attribute
|
|
11
|
-
#
|
|
10
|
+
# @!attribute from
|
|
11
|
+
# Sender email address
|
|
12
12
|
#
|
|
13
13
|
# @return [String]
|
|
14
|
-
required :
|
|
14
|
+
required :from, String
|
|
15
15
|
|
|
16
|
-
# @!attribute
|
|
17
|
-
#
|
|
16
|
+
# @!attribute raw_message
|
|
17
|
+
# Base64-encoded RFC 2822 MIME message
|
|
18
18
|
#
|
|
19
19
|
# @return [String]
|
|
20
|
-
required :
|
|
20
|
+
required :raw_message, String, api_name: :rawMessage
|
|
21
21
|
|
|
22
|
-
# @!attribute
|
|
23
|
-
#
|
|
22
|
+
# @!attribute to
|
|
23
|
+
# Recipient email addresses
|
|
24
24
|
#
|
|
25
25
|
# @return [Array<String>]
|
|
26
|
-
required :
|
|
26
|
+
required :to, ArkEmail::Internal::Type::ArrayOf[String]
|
|
27
27
|
|
|
28
28
|
# @!attribute bounce
|
|
29
29
|
# Whether this is a bounce message (accepts null)
|
|
@@ -31,12 +31,12 @@ module ArkEmail
|
|
|
31
31
|
# @return [Boolean, nil]
|
|
32
32
|
optional :bounce, ArkEmail::Internal::Type::Boolean, nil?: true
|
|
33
33
|
|
|
34
|
-
# @!method initialize(
|
|
35
|
-
# @param
|
|
34
|
+
# @!method initialize(from:, raw_message:, to:, bounce: nil, request_options: {})
|
|
35
|
+
# @param from [String] Sender email address
|
|
36
36
|
#
|
|
37
|
-
# @param
|
|
37
|
+
# @param raw_message [String] Base64-encoded RFC 2822 MIME message
|
|
38
38
|
#
|
|
39
|
-
# @param
|
|
39
|
+
# @param to [Array<String>] Recipient email addresses
|
|
40
40
|
#
|
|
41
41
|
# @param bounce [Boolean, nil] Whether this is a bounce message (accepts null)
|
|
42
42
|
#
|
|
@@ -75,6 +75,8 @@ module ArkEmail
|
|
|
75
75
|
MESSAGE_LINK_CLICKED = :MessageLinkClicked
|
|
76
76
|
MESSAGE_LOADED = :MessageLoaded
|
|
77
77
|
DOMAIN_DNS_ERROR = :DomainDNSError
|
|
78
|
+
SEND_LIMIT_APPROACHING = :SendLimitApproaching
|
|
79
|
+
SEND_LIMIT_EXCEEDED = :SendLimitExceeded
|
|
78
80
|
|
|
79
81
|
# @!method self.values
|
|
80
82
|
# @return [Array<Symbol>]
|
|
@@ -101,6 +101,8 @@ module ArkEmail
|
|
|
101
101
|
MESSAGE_LINK_CLICKED = :MessageLinkClicked
|
|
102
102
|
MESSAGE_LOADED = :MessageLoaded
|
|
103
103
|
DOMAIN_DNS_ERROR = :DomainDNSError
|
|
104
|
+
SEND_LIMIT_APPROACHING = :SendLimitApproaching
|
|
105
|
+
SEND_LIMIT_EXCEEDED = :SendLimitExceeded
|
|
104
106
|
|
|
105
107
|
# @!method self.values
|
|
106
108
|
# @return [Array<Symbol>]
|
|
@@ -70,6 +70,8 @@ module ArkEmail
|
|
|
70
70
|
MESSAGE_LINK_CLICKED = :MessageLinkClicked
|
|
71
71
|
MESSAGE_LOADED = :MessageLoaded
|
|
72
72
|
DOMAIN_DNS_ERROR = :DomainDNSError
|
|
73
|
+
SEND_LIMIT_APPROACHING = :SendLimitApproaching
|
|
74
|
+
SEND_LIMIT_EXCEEDED = :SendLimitExceeded
|
|
73
75
|
|
|
74
76
|
# @!method self.values
|
|
75
77
|
# @return [Array<Symbol>]
|
|
@@ -144,6 +144,8 @@ module ArkEmail
|
|
|
144
144
|
MESSAGE_LINK_CLICKED = :MessageLinkClicked
|
|
145
145
|
MESSAGE_LOADED = :MessageLoaded
|
|
146
146
|
DOMAIN_DNS_ERROR = :DomainDNSError
|
|
147
|
+
SEND_LIMIT_APPROACHING = :SendLimitApproaching
|
|
148
|
+
SEND_LIMIT_EXCEEDED = :SendLimitExceeded
|
|
147
149
|
|
|
148
150
|
# @!method self.values
|
|
149
151
|
# @return [Array<Symbol>]
|
|
@@ -144,6 +144,8 @@ module ArkEmail
|
|
|
144
144
|
MESSAGE_LINK_CLICKED = :MessageLinkClicked
|
|
145
145
|
MESSAGE_LOADED = :MessageLoaded
|
|
146
146
|
DOMAIN_DNS_ERROR = :DomainDNSError
|
|
147
|
+
SEND_LIMIT_APPROACHING = :SendLimitApproaching
|
|
148
|
+
SEND_LIMIT_EXCEEDED = :SendLimitExceeded
|
|
147
149
|
|
|
148
150
|
# @!method self.values
|
|
149
151
|
# @return [Array<Symbol>]
|
|
@@ -101,6 +101,8 @@ module ArkEmail
|
|
|
101
101
|
MESSAGE_LINK_CLICKED = :MessageLinkClicked
|
|
102
102
|
MESSAGE_LOADED = :MessageLoaded
|
|
103
103
|
DOMAIN_DNS_ERROR = :DomainDNSError
|
|
104
|
+
SEND_LIMIT_APPROACHING = :SendLimitApproaching
|
|
105
|
+
SEND_LIMIT_EXCEEDED = :SendLimitExceeded
|
|
104
106
|
|
|
105
107
|
# @!method self.values
|
|
106
108
|
# @return [Array<Symbol>]
|
|
@@ -30,6 +30,8 @@ module ArkEmail
|
|
|
30
30
|
MESSAGE_LINK_CLICKED = :MessageLinkClicked
|
|
31
31
|
MESSAGE_LOADED = :MessageLoaded
|
|
32
32
|
DOMAIN_DNS_ERROR = :DomainDNSError
|
|
33
|
+
SEND_LIMIT_APPROACHING = :SendLimitApproaching
|
|
34
|
+
SEND_LIMIT_EXCEEDED = :SendLimitExceeded
|
|
33
35
|
|
|
34
36
|
# @!method self.values
|
|
35
37
|
# @return [Array<Symbol>]
|
|
@@ -101,6 +101,8 @@ module ArkEmail
|
|
|
101
101
|
MESSAGE_LINK_CLICKED = :MessageLinkClicked
|
|
102
102
|
MESSAGE_LOADED = :MessageLoaded
|
|
103
103
|
DOMAIN_DNS_ERROR = :DomainDNSError
|
|
104
|
+
SEND_LIMIT_APPROACHING = :SendLimitApproaching
|
|
105
|
+
SEND_LIMIT_EXCEEDED = :SendLimitExceeded
|
|
104
106
|
|
|
105
107
|
# @!method self.values
|
|
106
108
|
# @return [Array<Symbol>]
|
|
@@ -266,15 +266,15 @@ module ArkEmail
|
|
|
266
266
|
# Send a pre-formatted RFC 2822 MIME message. Use this for advanced use cases or
|
|
267
267
|
# when migrating from systems that generate raw email content.
|
|
268
268
|
#
|
|
269
|
-
# The `
|
|
269
|
+
# The `rawMessage` field should contain the base64-encoded raw email.
|
|
270
270
|
#
|
|
271
|
-
# @overload send_raw(
|
|
271
|
+
# @overload send_raw(from:, raw_message:, to:, bounce: nil, request_options: {})
|
|
272
272
|
#
|
|
273
|
-
# @param
|
|
273
|
+
# @param from [String] Sender email address
|
|
274
274
|
#
|
|
275
|
-
# @param
|
|
275
|
+
# @param raw_message [String] Base64-encoded RFC 2822 MIME message
|
|
276
276
|
#
|
|
277
|
-
# @param
|
|
277
|
+
# @param to [Array<String>] Recipient email addresses
|
|
278
278
|
#
|
|
279
279
|
# @param bounce [Boolean, nil] Whether this is a bounce message (accepts null)
|
|
280
280
|
#
|
data/lib/ark_email/version.rb
CHANGED
|
@@ -11,17 +11,17 @@ module ArkEmail
|
|
|
11
11
|
T.any(ArkEmail::EmailSendRawParams, ArkEmail::Internal::AnyHash)
|
|
12
12
|
end
|
|
13
13
|
|
|
14
|
-
#
|
|
14
|
+
# Sender email address
|
|
15
15
|
sig { returns(String) }
|
|
16
|
-
attr_accessor :
|
|
16
|
+
attr_accessor :from
|
|
17
17
|
|
|
18
|
-
#
|
|
18
|
+
# Base64-encoded RFC 2822 MIME message
|
|
19
19
|
sig { returns(String) }
|
|
20
|
-
attr_accessor :
|
|
20
|
+
attr_accessor :raw_message
|
|
21
21
|
|
|
22
|
-
#
|
|
22
|
+
# Recipient email addresses
|
|
23
23
|
sig { returns(T::Array[String]) }
|
|
24
|
-
attr_accessor :
|
|
24
|
+
attr_accessor :to
|
|
25
25
|
|
|
26
26
|
# Whether this is a bounce message (accepts null)
|
|
27
27
|
sig { returns(T.nilable(T::Boolean)) }
|
|
@@ -29,20 +29,20 @@ module ArkEmail
|
|
|
29
29
|
|
|
30
30
|
sig do
|
|
31
31
|
params(
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
32
|
+
from: String,
|
|
33
|
+
raw_message: String,
|
|
34
|
+
to: T::Array[String],
|
|
35
35
|
bounce: T.nilable(T::Boolean),
|
|
36
36
|
request_options: ArkEmail::RequestOptions::OrHash
|
|
37
37
|
).returns(T.attached_class)
|
|
38
38
|
end
|
|
39
39
|
def self.new(
|
|
40
|
-
#
|
|
41
|
-
|
|
42
|
-
#
|
|
43
|
-
|
|
44
|
-
#
|
|
45
|
-
|
|
40
|
+
# Sender email address
|
|
41
|
+
from:,
|
|
42
|
+
# Base64-encoded RFC 2822 MIME message
|
|
43
|
+
raw_message:,
|
|
44
|
+
# Recipient email addresses
|
|
45
|
+
to:,
|
|
46
46
|
# Whether this is a bounce message (accepts null)
|
|
47
47
|
bounce: nil,
|
|
48
48
|
request_options: {}
|
|
@@ -52,9 +52,9 @@ module ArkEmail
|
|
|
52
52
|
sig do
|
|
53
53
|
override.returns(
|
|
54
54
|
{
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
55
|
+
from: String,
|
|
56
|
+
raw_message: String,
|
|
57
|
+
to: T::Array[String],
|
|
58
58
|
bounce: T.nilable(T::Boolean),
|
|
59
59
|
request_options: ArkEmail::RequestOptions
|
|
60
60
|
}
|
|
@@ -144,6 +144,16 @@ module ArkEmail
|
|
|
144
144
|
:DomainDNSError,
|
|
145
145
|
ArkEmail::WebhookCreateParams::Event::TaggedSymbol
|
|
146
146
|
)
|
|
147
|
+
SEND_LIMIT_APPROACHING =
|
|
148
|
+
T.let(
|
|
149
|
+
:SendLimitApproaching,
|
|
150
|
+
ArkEmail::WebhookCreateParams::Event::TaggedSymbol
|
|
151
|
+
)
|
|
152
|
+
SEND_LIMIT_EXCEEDED =
|
|
153
|
+
T.let(
|
|
154
|
+
:SendLimitExceeded,
|
|
155
|
+
ArkEmail::WebhookCreateParams::Event::TaggedSymbol
|
|
156
|
+
)
|
|
147
157
|
|
|
148
158
|
sig do
|
|
149
159
|
override.returns(
|
|
@@ -200,6 +200,16 @@ module ArkEmail
|
|
|
200
200
|
:DomainDNSError,
|
|
201
201
|
ArkEmail::Models::WebhookCreateResponse::Data::Event::TaggedSymbol
|
|
202
202
|
)
|
|
203
|
+
SEND_LIMIT_APPROACHING =
|
|
204
|
+
T.let(
|
|
205
|
+
:SendLimitApproaching,
|
|
206
|
+
ArkEmail::Models::WebhookCreateResponse::Data::Event::TaggedSymbol
|
|
207
|
+
)
|
|
208
|
+
SEND_LIMIT_EXCEEDED =
|
|
209
|
+
T.let(
|
|
210
|
+
:SendLimitExceeded,
|
|
211
|
+
ArkEmail::Models::WebhookCreateResponse::Data::Event::TaggedSymbol
|
|
212
|
+
)
|
|
203
213
|
|
|
204
214
|
sig do
|
|
205
215
|
override.returns(
|
|
@@ -158,6 +158,16 @@ module ArkEmail
|
|
|
158
158
|
:DomainDNSError,
|
|
159
159
|
ArkEmail::WebhookListDeliveriesParams::Event::TaggedSymbol
|
|
160
160
|
)
|
|
161
|
+
SEND_LIMIT_APPROACHING =
|
|
162
|
+
T.let(
|
|
163
|
+
:SendLimitApproaching,
|
|
164
|
+
ArkEmail::WebhookListDeliveriesParams::Event::TaggedSymbol
|
|
165
|
+
)
|
|
166
|
+
SEND_LIMIT_EXCEEDED =
|
|
167
|
+
T.let(
|
|
168
|
+
:SendLimitExceeded,
|
|
169
|
+
ArkEmail::WebhookListDeliveriesParams::Event::TaggedSymbol
|
|
170
|
+
)
|
|
161
171
|
|
|
162
172
|
sig do
|
|
163
173
|
override.returns(
|
|
@@ -240,6 +240,16 @@ module ArkEmail
|
|
|
240
240
|
:DomainDNSError,
|
|
241
241
|
ArkEmail::Models::WebhookListDeliveriesResponse::Data::Event::TaggedSymbol
|
|
242
242
|
)
|
|
243
|
+
SEND_LIMIT_APPROACHING =
|
|
244
|
+
T.let(
|
|
245
|
+
:SendLimitApproaching,
|
|
246
|
+
ArkEmail::Models::WebhookListDeliveriesResponse::Data::Event::TaggedSymbol
|
|
247
|
+
)
|
|
248
|
+
SEND_LIMIT_EXCEEDED =
|
|
249
|
+
T.let(
|
|
250
|
+
:SendLimitExceeded,
|
|
251
|
+
ArkEmail::Models::WebhookListDeliveriesResponse::Data::Event::TaggedSymbol
|
|
252
|
+
)
|
|
243
253
|
|
|
244
254
|
sig do
|
|
245
255
|
override.returns(
|
|
@@ -269,6 +269,16 @@ module ArkEmail
|
|
|
269
269
|
:DomainDNSError,
|
|
270
270
|
ArkEmail::Models::WebhookRetrieveDeliveryResponse::Data::Event::TaggedSymbol
|
|
271
271
|
)
|
|
272
|
+
SEND_LIMIT_APPROACHING =
|
|
273
|
+
T.let(
|
|
274
|
+
:SendLimitApproaching,
|
|
275
|
+
ArkEmail::Models::WebhookRetrieveDeliveryResponse::Data::Event::TaggedSymbol
|
|
276
|
+
)
|
|
277
|
+
SEND_LIMIT_EXCEEDED =
|
|
278
|
+
T.let(
|
|
279
|
+
:SendLimitExceeded,
|
|
280
|
+
ArkEmail::Models::WebhookRetrieveDeliveryResponse::Data::Event::TaggedSymbol
|
|
281
|
+
)
|
|
272
282
|
|
|
273
283
|
sig do
|
|
274
284
|
override.returns(
|
|
@@ -202,6 +202,16 @@ module ArkEmail
|
|
|
202
202
|
:DomainDNSError,
|
|
203
203
|
ArkEmail::Models::WebhookRetrieveResponse::Data::Event::TaggedSymbol
|
|
204
204
|
)
|
|
205
|
+
SEND_LIMIT_APPROACHING =
|
|
206
|
+
T.let(
|
|
207
|
+
:SendLimitApproaching,
|
|
208
|
+
ArkEmail::Models::WebhookRetrieveResponse::Data::Event::TaggedSymbol
|
|
209
|
+
)
|
|
210
|
+
SEND_LIMIT_EXCEEDED =
|
|
211
|
+
T.let(
|
|
212
|
+
:SendLimitExceeded,
|
|
213
|
+
ArkEmail::Models::WebhookRetrieveResponse::Data::Event::TaggedSymbol
|
|
214
|
+
)
|
|
205
215
|
|
|
206
216
|
sig do
|
|
207
217
|
override.returns(
|
|
@@ -81,6 +81,16 @@ module ArkEmail
|
|
|
81
81
|
:DomainDNSError,
|
|
82
82
|
ArkEmail::WebhookTestParams::Event::TaggedSymbol
|
|
83
83
|
)
|
|
84
|
+
SEND_LIMIT_APPROACHING =
|
|
85
|
+
T.let(
|
|
86
|
+
:SendLimitApproaching,
|
|
87
|
+
ArkEmail::WebhookTestParams::Event::TaggedSymbol
|
|
88
|
+
)
|
|
89
|
+
SEND_LIMIT_EXCEEDED =
|
|
90
|
+
T.let(
|
|
91
|
+
:SendLimitExceeded,
|
|
92
|
+
ArkEmail::WebhookTestParams::Event::TaggedSymbol
|
|
93
|
+
)
|
|
84
94
|
|
|
85
95
|
sig do
|
|
86
96
|
override.returns(
|
|
@@ -200,6 +200,16 @@ module ArkEmail
|
|
|
200
200
|
:DomainDNSError,
|
|
201
201
|
ArkEmail::Models::WebhookUpdateResponse::Data::Event::TaggedSymbol
|
|
202
202
|
)
|
|
203
|
+
SEND_LIMIT_APPROACHING =
|
|
204
|
+
T.let(
|
|
205
|
+
:SendLimitApproaching,
|
|
206
|
+
ArkEmail::Models::WebhookUpdateResponse::Data::Event::TaggedSymbol
|
|
207
|
+
)
|
|
208
|
+
SEND_LIMIT_EXCEEDED =
|
|
209
|
+
T.let(
|
|
210
|
+
:SendLimitExceeded,
|
|
211
|
+
ArkEmail::Models::WebhookUpdateResponse::Data::Event::TaggedSymbol
|
|
212
|
+
)
|
|
203
213
|
|
|
204
214
|
sig do
|
|
205
215
|
override.returns(
|
|
@@ -276,23 +276,23 @@ module ArkEmail
|
|
|
276
276
|
# Send a pre-formatted RFC 2822 MIME message. Use this for advanced use cases or
|
|
277
277
|
# when migrating from systems that generate raw email content.
|
|
278
278
|
#
|
|
279
|
-
# The `
|
|
279
|
+
# The `rawMessage` field should contain the base64-encoded raw email.
|
|
280
280
|
sig do
|
|
281
281
|
params(
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
282
|
+
from: String,
|
|
283
|
+
raw_message: String,
|
|
284
|
+
to: T::Array[String],
|
|
285
285
|
bounce: T.nilable(T::Boolean),
|
|
286
286
|
request_options: ArkEmail::RequestOptions::OrHash
|
|
287
287
|
).returns(ArkEmail::Models::EmailSendRawResponse)
|
|
288
288
|
end
|
|
289
289
|
def send_raw(
|
|
290
|
-
#
|
|
291
|
-
|
|
292
|
-
#
|
|
293
|
-
|
|
294
|
-
#
|
|
295
|
-
|
|
290
|
+
# Sender email address
|
|
291
|
+
from:,
|
|
292
|
+
# Base64-encoded RFC 2822 MIME message
|
|
293
|
+
raw_message:,
|
|
294
|
+
# Recipient email addresses
|
|
295
|
+
to:,
|
|
296
296
|
# Whether this is a bounce message (accepts null)
|
|
297
297
|
bounce: nil,
|
|
298
298
|
request_options: {}
|
|
@@ -1,38 +1,33 @@
|
|
|
1
1
|
module ArkEmail
|
|
2
2
|
module Models
|
|
3
3
|
type email_send_raw_params =
|
|
4
|
-
{
|
|
5
|
-
data: String,
|
|
6
|
-
mail_from: String,
|
|
7
|
-
rcpt_to: ::Array[String],
|
|
8
|
-
bounce: bool?
|
|
9
|
-
}
|
|
4
|
+
{ from: String, raw_message: String, to: ::Array[String], bounce: bool? }
|
|
10
5
|
& ArkEmail::Internal::Type::request_parameters
|
|
11
6
|
|
|
12
7
|
class EmailSendRawParams < ArkEmail::Internal::Type::BaseModel
|
|
13
8
|
extend ArkEmail::Internal::Type::RequestParameters::Converter
|
|
14
9
|
include ArkEmail::Internal::Type::RequestParameters
|
|
15
10
|
|
|
16
|
-
attr_accessor
|
|
11
|
+
attr_accessor from: String
|
|
17
12
|
|
|
18
|
-
attr_accessor
|
|
13
|
+
attr_accessor raw_message: String
|
|
19
14
|
|
|
20
|
-
attr_accessor
|
|
15
|
+
attr_accessor to: ::Array[String]
|
|
21
16
|
|
|
22
17
|
attr_accessor bounce: bool?
|
|
23
18
|
|
|
24
19
|
def initialize: (
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
20
|
+
from: String,
|
|
21
|
+
raw_message: String,
|
|
22
|
+
to: ::Array[String],
|
|
28
23
|
?bounce: bool?,
|
|
29
24
|
?request_options: ArkEmail::request_opts
|
|
30
25
|
) -> void
|
|
31
26
|
|
|
32
27
|
def to_hash: -> {
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
28
|
+
from: String,
|
|
29
|
+
raw_message: String,
|
|
30
|
+
to: ::Array[String],
|
|
36
31
|
bounce: bool?,
|
|
37
32
|
request_options: ArkEmail::RequestOptions
|
|
38
33
|
}
|
|
@@ -51,6 +51,8 @@ module ArkEmail
|
|
|
51
51
|
| :MessageLinkClicked
|
|
52
52
|
| :MessageLoaded
|
|
53
53
|
| :DomainDNSError
|
|
54
|
+
| :SendLimitApproaching
|
|
55
|
+
| :SendLimitExceeded
|
|
54
56
|
|
|
55
57
|
module Event
|
|
56
58
|
extend ArkEmail::Internal::Type::Enum
|
|
@@ -63,6 +65,8 @@ module ArkEmail
|
|
|
63
65
|
MESSAGE_LINK_CLICKED: :MessageLinkClicked
|
|
64
66
|
MESSAGE_LOADED: :MessageLoaded
|
|
65
67
|
DOMAIN_DNS_ERROR: :DomainDNSError
|
|
68
|
+
SEND_LIMIT_APPROACHING: :SendLimitApproaching
|
|
69
|
+
SEND_LIMIT_EXCEEDED: :SendLimitExceeded
|
|
66
70
|
|
|
67
71
|
def self?.values: -> ::Array[ArkEmail::Models::WebhookCreateParams::event]
|
|
68
72
|
end
|
|
@@ -86,6 +86,8 @@ module ArkEmail
|
|
|
86
86
|
| :MessageLinkClicked
|
|
87
87
|
| :MessageLoaded
|
|
88
88
|
| :DomainDNSError
|
|
89
|
+
| :SendLimitApproaching
|
|
90
|
+
| :SendLimitExceeded
|
|
89
91
|
|
|
90
92
|
module Event
|
|
91
93
|
extend ArkEmail::Internal::Type::Enum
|
|
@@ -98,6 +100,8 @@ module ArkEmail
|
|
|
98
100
|
MESSAGE_LINK_CLICKED: :MessageLinkClicked
|
|
99
101
|
MESSAGE_LOADED: :MessageLoaded
|
|
100
102
|
DOMAIN_DNS_ERROR: :DomainDNSError
|
|
103
|
+
SEND_LIMIT_APPROACHING: :SendLimitApproaching
|
|
104
|
+
SEND_LIMIT_EXCEEDED: :SendLimitExceeded
|
|
101
105
|
|
|
102
106
|
def self?.values: -> ::Array[ArkEmail::Models::WebhookCreateResponse::Data::event]
|
|
103
107
|
end
|
|
@@ -70,6 +70,8 @@ module ArkEmail
|
|
|
70
70
|
| :MessageLinkClicked
|
|
71
71
|
| :MessageLoaded
|
|
72
72
|
| :DomainDNSError
|
|
73
|
+
| :SendLimitApproaching
|
|
74
|
+
| :SendLimitExceeded
|
|
73
75
|
|
|
74
76
|
module Event
|
|
75
77
|
extend ArkEmail::Internal::Type::Enum
|
|
@@ -82,6 +84,8 @@ module ArkEmail
|
|
|
82
84
|
MESSAGE_LINK_CLICKED: :MessageLinkClicked
|
|
83
85
|
MESSAGE_LOADED: :MessageLoaded
|
|
84
86
|
DOMAIN_DNS_ERROR: :DomainDNSError
|
|
87
|
+
SEND_LIMIT_APPROACHING: :SendLimitApproaching
|
|
88
|
+
SEND_LIMIT_EXCEEDED: :SendLimitExceeded
|
|
85
89
|
|
|
86
90
|
def self?.values: -> ::Array[ArkEmail::Models::WebhookListDeliveriesParams::event]
|
|
87
91
|
end
|
|
@@ -106,6 +106,8 @@ module ArkEmail
|
|
|
106
106
|
| :MessageLinkClicked
|
|
107
107
|
| :MessageLoaded
|
|
108
108
|
| :DomainDNSError
|
|
109
|
+
| :SendLimitApproaching
|
|
110
|
+
| :SendLimitExceeded
|
|
109
111
|
|
|
110
112
|
module Event
|
|
111
113
|
extend ArkEmail::Internal::Type::Enum
|
|
@@ -118,6 +120,8 @@ module ArkEmail
|
|
|
118
120
|
MESSAGE_LINK_CLICKED: :MessageLinkClicked
|
|
119
121
|
MESSAGE_LOADED: :MessageLoaded
|
|
120
122
|
DOMAIN_DNS_ERROR: :DomainDNSError
|
|
123
|
+
SEND_LIMIT_APPROACHING: :SendLimitApproaching
|
|
124
|
+
SEND_LIMIT_EXCEEDED: :SendLimitExceeded
|
|
121
125
|
|
|
122
126
|
def self?.values: -> ::Array[ArkEmail::Models::WebhookListDeliveriesResponse::Data::event]
|
|
123
127
|
end
|
|
@@ -106,6 +106,8 @@ module ArkEmail
|
|
|
106
106
|
| :MessageLinkClicked
|
|
107
107
|
| :MessageLoaded
|
|
108
108
|
| :DomainDNSError
|
|
109
|
+
| :SendLimitApproaching
|
|
110
|
+
| :SendLimitExceeded
|
|
109
111
|
|
|
110
112
|
module Event
|
|
111
113
|
extend ArkEmail::Internal::Type::Enum
|
|
@@ -118,6 +120,8 @@ module ArkEmail
|
|
|
118
120
|
MESSAGE_LINK_CLICKED: :MessageLinkClicked
|
|
119
121
|
MESSAGE_LOADED: :MessageLoaded
|
|
120
122
|
DOMAIN_DNS_ERROR: :DomainDNSError
|
|
123
|
+
SEND_LIMIT_APPROACHING: :SendLimitApproaching
|
|
124
|
+
SEND_LIMIT_EXCEEDED: :SendLimitExceeded
|
|
121
125
|
|
|
122
126
|
def self?.values: -> ::Array[ArkEmail::Models::WebhookRetrieveDeliveryResponse::Data::event]
|
|
123
127
|
end
|
|
@@ -86,6 +86,8 @@ module ArkEmail
|
|
|
86
86
|
| :MessageLinkClicked
|
|
87
87
|
| :MessageLoaded
|
|
88
88
|
| :DomainDNSError
|
|
89
|
+
| :SendLimitApproaching
|
|
90
|
+
| :SendLimitExceeded
|
|
89
91
|
|
|
90
92
|
module Event
|
|
91
93
|
extend ArkEmail::Internal::Type::Enum
|
|
@@ -98,6 +100,8 @@ module ArkEmail
|
|
|
98
100
|
MESSAGE_LINK_CLICKED: :MessageLinkClicked
|
|
99
101
|
MESSAGE_LOADED: :MessageLoaded
|
|
100
102
|
DOMAIN_DNS_ERROR: :DomainDNSError
|
|
103
|
+
SEND_LIMIT_APPROACHING: :SendLimitApproaching
|
|
104
|
+
SEND_LIMIT_EXCEEDED: :SendLimitExceeded
|
|
101
105
|
|
|
102
106
|
def self?.values: -> ::Array[ArkEmail::Models::WebhookRetrieveResponse::Data::event]
|
|
103
107
|
end
|
|
@@ -29,6 +29,8 @@ module ArkEmail
|
|
|
29
29
|
| :MessageLinkClicked
|
|
30
30
|
| :MessageLoaded
|
|
31
31
|
| :DomainDNSError
|
|
32
|
+
| :SendLimitApproaching
|
|
33
|
+
| :SendLimitExceeded
|
|
32
34
|
|
|
33
35
|
module Event
|
|
34
36
|
extend ArkEmail::Internal::Type::Enum
|
|
@@ -41,6 +43,8 @@ module ArkEmail
|
|
|
41
43
|
MESSAGE_LINK_CLICKED: :MessageLinkClicked
|
|
42
44
|
MESSAGE_LOADED: :MessageLoaded
|
|
43
45
|
DOMAIN_DNS_ERROR: :DomainDNSError
|
|
46
|
+
SEND_LIMIT_APPROACHING: :SendLimitApproaching
|
|
47
|
+
SEND_LIMIT_EXCEEDED: :SendLimitExceeded
|
|
44
48
|
|
|
45
49
|
def self?.values: -> ::Array[ArkEmail::Models::WebhookTestParams::event]
|
|
46
50
|
end
|
|
@@ -86,6 +86,8 @@ module ArkEmail
|
|
|
86
86
|
| :MessageLinkClicked
|
|
87
87
|
| :MessageLoaded
|
|
88
88
|
| :DomainDNSError
|
|
89
|
+
| :SendLimitApproaching
|
|
90
|
+
| :SendLimitExceeded
|
|
89
91
|
|
|
90
92
|
module Event
|
|
91
93
|
extend ArkEmail::Internal::Type::Enum
|
|
@@ -98,6 +100,8 @@ module ArkEmail
|
|
|
98
100
|
MESSAGE_LINK_CLICKED: :MessageLinkClicked
|
|
99
101
|
MESSAGE_LOADED: :MessageLoaded
|
|
100
102
|
DOMAIN_DNS_ERROR: :DomainDNSError
|
|
103
|
+
SEND_LIMIT_APPROACHING: :SendLimitApproaching
|
|
104
|
+
SEND_LIMIT_EXCEEDED: :SendLimitExceeded
|
|
101
105
|
|
|
102
106
|
def self?.values: -> ::Array[ArkEmail::Models::WebhookUpdateResponse::Data::event]
|
|
103
107
|
end
|
|
@@ -54,9 +54,9 @@ module ArkEmail
|
|
|
54
54
|
) -> ArkEmail::Models::EmailSendBatchResponse
|
|
55
55
|
|
|
56
56
|
def send_raw: (
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
57
|
+
from: String,
|
|
58
|
+
raw_message: String,
|
|
59
|
+
to: ::Array[String],
|
|
60
60
|
?bounce: bool?,
|
|
61
61
|
?request_options: ArkEmail::request_opts
|
|
62
62
|
) -> ArkEmail::Models::EmailSendRawResponse
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: ark-email
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.12.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Ark
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-01-
|
|
11
|
+
date: 2026-01-23 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: cgi
|