ark-email 0.5.2 → 0.7.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.
Files changed (44) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +22 -0
  3. data/README.md +3 -3
  4. data/lib/ark_email/models/email_send_batch_params.rb +31 -7
  5. data/lib/ark_email/models/email_send_params.rb +46 -27
  6. data/lib/ark_email/models/email_send_raw_params.rb +9 -1
  7. data/lib/ark_email/models/suppression_bulk_create_params.rb +4 -2
  8. data/lib/ark_email/models/suppression_create_params.rb +3 -3
  9. data/lib/ark_email/models/tracking_create_params.rb +12 -12
  10. data/lib/ark_email/models/tracking_update_params.rb +12 -12
  11. data/lib/ark_email/models/webhook_create_params.rb +26 -23
  12. data/lib/ark_email/models/webhook_update_params.rb +10 -10
  13. data/lib/ark_email/resources/emails.rb +15 -11
  14. data/lib/ark_email/resources/suppressions.rb +1 -1
  15. data/lib/ark_email/resources/tracking.rb +8 -8
  16. data/lib/ark_email/resources/webhooks.rb +10 -10
  17. data/lib/ark_email/version.rb +1 -1
  18. data/rbi/ark_email/models/email_send_batch_params.rbi +42 -19
  19. data/rbi/ark_email/models/email_send_params.rbi +71 -71
  20. data/rbi/ark_email/models/email_send_raw_params.rbi +8 -0
  21. data/rbi/ark_email/models/suppression_bulk_create_params.rbi +11 -7
  22. data/rbi/ark_email/models/suppression_create_params.rbi +5 -8
  23. data/rbi/ark_email/models/tracking_create_params.rbi +18 -27
  24. data/rbi/ark_email/models/tracking_update_params.rbi +20 -32
  25. data/rbi/ark_email/models/webhook_create_params.rbi +40 -36
  26. data/rbi/ark_email/models/webhook_update_params.rbi +15 -30
  27. data/rbi/ark_email/resources/emails.rbi +35 -19
  28. data/rbi/ark_email/resources/suppressions.rbi +2 -2
  29. data/rbi/ark_email/resources/tracking.rbi +15 -15
  30. data/rbi/ark_email/resources/webhooks.rbi +19 -17
  31. data/sig/ark_email/models/email_send_batch_params.rbs +16 -17
  32. data/sig/ark_email/models/email_send_params.rbs +36 -49
  33. data/sig/ark_email/models/email_send_raw_params.rbs +10 -1
  34. data/sig/ark_email/models/suppression_bulk_create_params.rbs +4 -6
  35. data/sig/ark_email/models/suppression_create_params.rbs +4 -6
  36. data/sig/ark_email/models/tracking_create_params.rbs +16 -22
  37. data/sig/ark_email/models/tracking_update_params.rbs +16 -24
  38. data/sig/ark_email/models/webhook_create_params.rbs +12 -16
  39. data/sig/ark_email/models/webhook_update_params.rbs +20 -30
  40. data/sig/ark_email/resources/emails.rbs +10 -8
  41. data/sig/ark_email/resources/suppressions.rbs +1 -1
  42. data/sig/ark_email/resources/tracking.rbs +8 -8
  43. data/sig/ark_email/resources/webhooks.rbs +8 -8
  44. metadata +2 -2
@@ -1,7 +1,7 @@
1
1
  module ArkEmail
2
2
  module Models
3
3
  type suppression_create_params =
4
- { address: String, reason: String }
4
+ { address: String, reason: String? }
5
5
  & ArkEmail::Internal::Type::request_parameters
6
6
 
7
7
  class SuppressionCreateParams < ArkEmail::Internal::Type::BaseModel
@@ -10,19 +10,17 @@ module ArkEmail
10
10
 
11
11
  attr_accessor address: String
12
12
 
13
- attr_reader reason: String?
14
-
15
- def reason=: (String) -> String
13
+ attr_accessor reason: String?
16
14
 
17
15
  def initialize: (
18
16
  address: String,
19
- ?reason: String,
17
+ ?reason: String?,
20
18
  ?request_options: ArkEmail::request_opts
21
19
  ) -> void
22
20
 
23
21
  def to_hash: -> {
24
22
  address: String,
25
- reason: String,
23
+ reason: String?,
26
24
  request_options: ArkEmail::RequestOptions
27
25
  }
28
26
  end
@@ -2,11 +2,11 @@ module ArkEmail
2
2
  module Models
3
3
  type tracking_create_params =
4
4
  {
5
- domain_id: String,
5
+ domain_id: Integer,
6
6
  name: String,
7
- ssl_enabled: bool,
8
- track_clicks: bool,
9
- track_opens: bool
7
+ ssl_enabled: bool?,
8
+ track_clicks: bool?,
9
+ track_opens: bool?
10
10
  }
11
11
  & ArkEmail::Internal::Type::request_parameters
12
12
 
@@ -14,37 +14,31 @@ module ArkEmail
14
14
  extend ArkEmail::Internal::Type::RequestParameters::Converter
15
15
  include ArkEmail::Internal::Type::RequestParameters
16
16
 
17
- attr_accessor domain_id: String
17
+ attr_accessor domain_id: Integer
18
18
 
19
19
  attr_accessor name: String
20
20
 
21
- attr_reader ssl_enabled: bool?
21
+ attr_accessor ssl_enabled: bool?
22
22
 
23
- def ssl_enabled=: (bool) -> bool
23
+ attr_accessor track_clicks: bool?
24
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
25
+ attr_accessor track_opens: bool?
32
26
 
33
27
  def initialize: (
34
- domain_id: String,
28
+ domain_id: Integer,
35
29
  name: String,
36
- ?ssl_enabled: bool,
37
- ?track_clicks: bool,
38
- ?track_opens: bool,
30
+ ?ssl_enabled: bool?,
31
+ ?track_clicks: bool?,
32
+ ?track_opens: bool?,
39
33
  ?request_options: ArkEmail::request_opts
40
34
  ) -> void
41
35
 
42
36
  def to_hash: -> {
43
- domain_id: String,
37
+ domain_id: Integer,
44
38
  name: String,
45
- ssl_enabled: bool,
46
- track_clicks: bool,
47
- track_opens: bool,
39
+ ssl_enabled: bool?,
40
+ track_clicks: bool?,
41
+ track_opens: bool?,
48
42
  request_options: ArkEmail::RequestOptions
49
43
  }
50
44
  end
@@ -2,10 +2,10 @@ module ArkEmail
2
2
  module Models
3
3
  type tracking_update_params =
4
4
  {
5
- excluded_click_domains: String,
6
- ssl_enabled: bool,
7
- track_clicks: bool,
8
- track_opens: bool
5
+ excluded_click_domains: String?,
6
+ ssl_enabled: bool?,
7
+ track_clicks: bool?,
8
+ track_opens: bool?
9
9
  }
10
10
  & ArkEmail::Internal::Type::request_parameters
11
11
 
@@ -13,35 +13,27 @@ module ArkEmail
13
13
  extend ArkEmail::Internal::Type::RequestParameters::Converter
14
14
  include ArkEmail::Internal::Type::RequestParameters
15
15
 
16
- attr_reader excluded_click_domains: String?
16
+ attr_accessor excluded_click_domains: String?
17
17
 
18
- def excluded_click_domains=: (String) -> String
18
+ attr_accessor ssl_enabled: bool?
19
19
 
20
- attr_reader ssl_enabled: bool?
20
+ attr_accessor track_clicks: bool?
21
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
22
+ attr_accessor track_opens: bool?
31
23
 
32
24
  def initialize: (
33
- ?excluded_click_domains: String,
34
- ?ssl_enabled: bool,
35
- ?track_clicks: bool,
36
- ?track_opens: bool,
25
+ ?excluded_click_domains: String?,
26
+ ?ssl_enabled: bool?,
27
+ ?track_clicks: bool?,
28
+ ?track_opens: bool?,
37
29
  ?request_options: ArkEmail::request_opts
38
30
  ) -> void
39
31
 
40
32
  def to_hash: -> {
41
- excluded_click_domains: String,
42
- ssl_enabled: bool,
43
- track_clicks: bool,
44
- track_opens: bool,
33
+ excluded_click_domains: String?,
34
+ ssl_enabled: bool?,
35
+ track_clicks: bool?,
36
+ track_opens: bool?,
45
37
  request_options: ArkEmail::RequestOptions
46
38
  }
47
39
  end
@@ -2,11 +2,11 @@ module ArkEmail
2
2
  module Models
3
3
  type webhook_create_params =
4
4
  {
5
- events: ::Array[ArkEmail::Models::WebhookCreateParams::event],
6
5
  name: String,
7
6
  url: String,
8
- all_events: bool,
9
- enabled: bool
7
+ all_events: bool?,
8
+ enabled: bool?,
9
+ events: ::Array[ArkEmail::Models::WebhookCreateParams::event]?
10
10
  }
11
11
  & ArkEmail::Internal::Type::request_parameters
12
12
 
@@ -14,35 +14,31 @@ module ArkEmail
14
14
  extend ArkEmail::Internal::Type::RequestParameters::Converter
15
15
  include ArkEmail::Internal::Type::RequestParameters
16
16
 
17
- attr_accessor events: ::Array[ArkEmail::Models::WebhookCreateParams::event]
18
-
19
17
  attr_accessor name: String
20
18
 
21
19
  attr_accessor url: String
22
20
 
23
- attr_reader all_events: bool?
24
-
25
- def all_events=: (bool) -> bool
21
+ attr_accessor all_events: bool?
26
22
 
27
- attr_reader enabled: bool?
23
+ attr_accessor enabled: bool?
28
24
 
29
- def enabled=: (bool) -> bool
25
+ attr_accessor events: ::Array[ArkEmail::Models::WebhookCreateParams::event]?
30
26
 
31
27
  def initialize: (
32
- events: ::Array[ArkEmail::Models::WebhookCreateParams::event],
33
28
  name: String,
34
29
  url: String,
35
- ?all_events: bool,
36
- ?enabled: bool,
30
+ ?all_events: bool?,
31
+ ?enabled: bool?,
32
+ ?events: ::Array[ArkEmail::Models::WebhookCreateParams::event]?,
37
33
  ?request_options: ArkEmail::request_opts
38
34
  ) -> void
39
35
 
40
36
  def to_hash: -> {
41
- events: ::Array[ArkEmail::Models::WebhookCreateParams::event],
42
37
  name: String,
43
38
  url: String,
44
- all_events: bool,
45
- enabled: bool,
39
+ all_events: bool?,
40
+ enabled: bool?,
41
+ events: ::Array[ArkEmail::Models::WebhookCreateParams::event]?,
46
42
  request_options: ArkEmail::RequestOptions
47
43
  }
48
44
 
@@ -2,11 +2,11 @@ module ArkEmail
2
2
  module Models
3
3
  type webhook_update_params =
4
4
  {
5
- all_events: bool,
6
- enabled: bool,
7
- events: ::Array[String],
8
- name: String,
9
- url: String
5
+ all_events: bool?,
6
+ enabled: bool?,
7
+ events: ::Array[String]?,
8
+ name: String?,
9
+ url: String?
10
10
  }
11
11
  & ArkEmail::Internal::Type::request_parameters
12
12
 
@@ -14,41 +14,31 @@ module ArkEmail
14
14
  extend ArkEmail::Internal::Type::RequestParameters::Converter
15
15
  include ArkEmail::Internal::Type::RequestParameters
16
16
 
17
- attr_reader all_events: bool?
17
+ attr_accessor all_events: bool?
18
18
 
19
- def all_events=: (bool) -> bool
19
+ attr_accessor enabled: bool?
20
20
 
21
- attr_reader enabled: bool?
21
+ attr_accessor events: ::Array[String]?
22
22
 
23
- def enabled=: (bool) -> bool
23
+ attr_accessor name: String?
24
24
 
25
- attr_reader events: ::Array[String]?
26
-
27
- def events=: (::Array[String]) -> ::Array[String]
28
-
29
- attr_reader name: String?
30
-
31
- def name=: (String) -> String
32
-
33
- attr_reader url: String?
34
-
35
- def url=: (String) -> String
25
+ attr_accessor url: String?
36
26
 
37
27
  def initialize: (
38
- ?all_events: bool,
39
- ?enabled: bool,
40
- ?events: ::Array[String],
41
- ?name: String,
42
- ?url: String,
28
+ ?all_events: bool?,
29
+ ?enabled: bool?,
30
+ ?events: ::Array[String]?,
31
+ ?name: String?,
32
+ ?url: String?,
43
33
  ?request_options: ArkEmail::request_opts
44
34
  ) -> void
45
35
 
46
36
  def to_hash: -> {
47
- all_events: bool,
48
- enabled: bool,
49
- events: ::Array[String],
50
- name: String,
51
- url: String,
37
+ all_events: bool?,
38
+ enabled: bool?,
39
+ events: ::Array[String]?,
40
+ name: String?,
41
+ url: String?,
52
42
  request_options: ArkEmail::RequestOptions
53
43
  }
54
44
  end
@@ -33,14 +33,15 @@ module ArkEmail
33
33
  from: String,
34
34
  subject: String,
35
35
  to: ::Array[String],
36
- ?attachments: ::Array[ArkEmail::EmailSendParams::Attachment],
37
- ?bcc: ::Array[String],
38
- ?cc: ::Array[String],
39
- ?headers: ::Hash[Symbol, String],
40
- ?html: String,
41
- ?reply_to: String,
42
- ?tag: String,
43
- ?text: String,
36
+ ?attachments: ::Array[ArkEmail::EmailSendParams::Attachment]?,
37
+ ?bcc: ::Array[String]?,
38
+ ?cc: ::Array[String]?,
39
+ ?headers: ::Hash[Symbol, String]?,
40
+ ?html: String?,
41
+ ?metadata: ::Hash[Symbol, String]?,
42
+ ?reply_to: String?,
43
+ ?tag: String?,
44
+ ?text: String?,
44
45
  ?idempotency_key: String,
45
46
  ?request_options: ArkEmail::request_opts
46
47
  ) -> ArkEmail::Models::EmailSendResponse
@@ -56,6 +57,7 @@ module ArkEmail
56
57
  data: String,
57
58
  mail_from: String,
58
59
  rcpt_to: ::Array[String],
60
+ ?bounce: bool?,
59
61
  ?request_options: ArkEmail::request_opts
60
62
  ) -> ArkEmail::Models::EmailSendRawResponse
61
63
 
@@ -3,7 +3,7 @@ module ArkEmail
3
3
  class Suppressions
4
4
  def create: (
5
5
  address: String,
6
- ?reason: String,
6
+ ?reason: String?,
7
7
  ?request_options: ArkEmail::request_opts
8
8
  ) -> ArkEmail::Models::SuppressionCreateResponse
9
9
 
@@ -2,11 +2,11 @@ module ArkEmail
2
2
  module Resources
3
3
  class Tracking
4
4
  def create: (
5
- domain_id: String,
5
+ domain_id: Integer,
6
6
  name: String,
7
- ?ssl_enabled: bool,
8
- ?track_clicks: bool,
9
- ?track_opens: bool,
7
+ ?ssl_enabled: bool?,
8
+ ?track_clicks: bool?,
9
+ ?track_opens: bool?,
10
10
  ?request_options: ArkEmail::request_opts
11
11
  ) -> ArkEmail::Models::TrackingCreateResponse
12
12
 
@@ -17,10 +17,10 @@ module ArkEmail
17
17
 
18
18
  def update: (
19
19
  String tracking_id,
20
- ?excluded_click_domains: String,
21
- ?ssl_enabled: bool,
22
- ?track_clicks: bool,
23
- ?track_opens: bool,
20
+ ?excluded_click_domains: String?,
21
+ ?ssl_enabled: bool?,
22
+ ?track_clicks: bool?,
23
+ ?track_opens: bool?,
24
24
  ?request_options: ArkEmail::request_opts
25
25
  ) -> ArkEmail::Models::TrackingUpdateResponse
26
26
 
@@ -2,11 +2,11 @@ module ArkEmail
2
2
  module Resources
3
3
  class Webhooks
4
4
  def create: (
5
- events: ::Array[ArkEmail::Models::WebhookCreateParams::event],
6
5
  name: String,
7
6
  url: String,
8
- ?all_events: bool,
9
- ?enabled: bool,
7
+ ?all_events: bool?,
8
+ ?enabled: bool?,
9
+ ?events: ::Array[ArkEmail::Models::WebhookCreateParams::event]?,
10
10
  ?request_options: ArkEmail::request_opts
11
11
  ) -> ArkEmail::Models::WebhookCreateResponse
12
12
 
@@ -17,11 +17,11 @@ module ArkEmail
17
17
 
18
18
  def update: (
19
19
  String webhook_id,
20
- ?all_events: bool,
21
- ?enabled: bool,
22
- ?events: ::Array[String],
23
- ?name: String,
24
- ?url: String,
20
+ ?all_events: bool?,
21
+ ?enabled: bool?,
22
+ ?events: ::Array[String]?,
23
+ ?name: String?,
24
+ ?url: String?,
25
25
  ?request_options: ArkEmail::request_opts
26
26
  ) -> ArkEmail::Models::WebhookUpdateResponse
27
27
 
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.5.2
4
+ version: 0.7.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-13 00:00:00.000000000 Z
11
+ date: 2026-01-14 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: cgi