zapsmtp 0.1.0 → 0.1.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.
- checksums.yaml +4 -4
- data/lib/zapsmtp/generated/models.rb +5 -2
- data/lib/zapsmtp/generated/resources.rb +24 -19
- data/lib/zapsmtp/version.rb +1 -1
- 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: ffeb0ccc9ba40e716b7af928e48c78e746458789aa1b74999f38f196baa98eb5
|
|
4
|
+
data.tar.gz: 79d61ce77cefcdc2d7d693dca7aab0e2d812f41a36bc056fc0fa785c765a01bc
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 0c0aeee2b8a09d4b7b9bb357e37c6e53e9ba27c2bdcc15a86b54e39d50a5e84fde3e7acfe8f2f607e3676d7fb2fb82417e86395a04a4de4e6d16198f377e9ef8
|
|
7
|
+
data.tar.gz: f948e7505c1cb2a8fcd57ef63e0a3346abc0cc512e65aa10c612035e604dafa0134a141b3c77bd9a176b17f77d86f12880120362c7baa25e31a9200a59d4a045
|
|
@@ -1569,6 +1569,9 @@ module ZapSMTP
|
|
|
1569
1569
|
# SendBatchResponseData, as the API answers it. Fields not listed here are kept too: read them with #[] or
|
|
1570
1570
|
# #to_h.
|
|
1571
1571
|
class SendBatchResponseData < Model
|
|
1572
|
+
# @!attribute [r] failed_recipients
|
|
1573
|
+
# @return [Array<String>, nil]
|
|
1574
|
+
attribute :failed_recipients
|
|
1572
1575
|
# @!attribute [r] id
|
|
1573
1576
|
# @return [String]
|
|
1574
1577
|
attribute :id
|
|
@@ -2061,7 +2064,7 @@ module ZapSMTP
|
|
|
2061
2064
|
# @return [Array<ZapSMTP::Models::TemplateVariableSchema>, nil]
|
|
2062
2065
|
attribute :variable_schema, [:array, "TemplateVariableSchema"]
|
|
2063
2066
|
# @!attribute [r] variables
|
|
2064
|
-
# @return [Hash{String =>
|
|
2067
|
+
# @return [Hash{String => Object}, nil]
|
|
2065
2068
|
attribute :variables
|
|
2066
2069
|
end
|
|
2067
2070
|
|
|
@@ -2262,7 +2265,7 @@ module ZapSMTP
|
|
|
2262
2265
|
# @return [Integer]
|
|
2263
2266
|
attribute :inbound_count
|
|
2264
2267
|
# @!attribute [r] last_inbound_at
|
|
2265
|
-
# @return [String]
|
|
2268
|
+
# @return [String, nil]
|
|
2266
2269
|
attribute :last_inbound_at
|
|
2267
2270
|
# @!attribute [r] last_message
|
|
2268
2271
|
# @return [ZapSMTP::Models::ThreadLastMessage]
|
|
@@ -20,7 +20,8 @@ module ZapSMTP
|
|
|
20
20
|
#
|
|
21
21
|
# @param id [String] Received email id
|
|
22
22
|
# @param params [Hash] the parameters below, also accepted as keyword arguments
|
|
23
|
-
# @option params [Integer] :limit 1-100; when omitted
|
|
23
|
+
# @option params [Integer] :limit 1-100; when omitted all attachments are returned. Limits: 422
|
|
24
|
+
# invalid_parameter otherwise.
|
|
24
25
|
# @option params [String] :after Attachment id; returns attachments after it (ignored if unknown).
|
|
25
26
|
# @option params [String] :before Attachment id; returns attachments before it (used only when after is
|
|
26
27
|
# absent).
|
|
@@ -73,7 +74,7 @@ module ZapSMTP
|
|
|
73
74
|
# you sent through ZapSMTP.
|
|
74
75
|
#
|
|
75
76
|
# @param params [Hash] the parameters below, also accepted as keyword arguments
|
|
76
|
-
# @option params [Integer] :limit 1-100
|
|
77
|
+
# @option params [Integer] :limit 1-100. Limits: 422 invalid_parameter otherwise. Default: 20.
|
|
77
78
|
# @option params [String] :before Cursor: an email id or RFC 3339 time; returns messages received before
|
|
78
79
|
# it. An email id gives an exact page boundary. Limits: 422 invalid_parameter "before must be an email
|
|
79
80
|
# id or RFC 3339 time"
|
|
@@ -106,7 +107,10 @@ module ZapSMTP
|
|
|
106
107
|
# status notification), out_of_office, auto_reply, auto_generated (notifications, null sender) or bulk
|
|
107
108
|
# (mailing lists). Detected from Auto-Submitted, X-Autoreply, Precedence, List-Id, multipart/report and
|
|
108
109
|
# well-known subjects; reason names the evidence. tls: the TLS version the sending server used (e.g.
|
|
109
|
-
# TLSv1_3); empty when the message was not encrypted.
|
|
110
|
+
# TLSv1_3); empty when the message was not encrypted. A message refused at SMTP (status: rejected: spam
|
|
111
|
+
# or a reject route) is listed but its content was never kept: it returns the listing fields, with html,
|
|
112
|
+
# text and raw null and headers empty. Its attachments, redelivery, spam reports and replies are 404;
|
|
113
|
+
# DELETE erases it.
|
|
110
114
|
#
|
|
111
115
|
# @param id [String] Received email id
|
|
112
116
|
# @param params [Hash] the parameters below, also accepted as keyword arguments
|
|
@@ -429,7 +433,7 @@ module ZapSMTP
|
|
|
429
433
|
# value.
|
|
430
434
|
#
|
|
431
435
|
# @param params [Hash] the parameters below, also accepted as keyword arguments
|
|
432
|
-
# @option params [Integer] :limit 1-100
|
|
436
|
+
# @option params [Integer] :limit 1-100. Limits: 422 invalid_parameter otherwise. Default: 20.
|
|
433
437
|
# @option params [String] :before Cursor: an email id (UUIDv7) or RFC 3339 time; returns emails accepted
|
|
434
438
|
# before it. An email id gives an exact page boundary. Limits: 422 invalid_parameter "before must be an
|
|
435
439
|
# email id or RFC 3339 time"
|
|
@@ -437,14 +441,14 @@ module ZapSMTP
|
|
|
437
441
|
# first). Limits: 422 invalid_parameter "after must be an email id or RFC 3339 time"
|
|
438
442
|
# @option params [String] :status Filter by latest status. status=scheduled lists pending scheduled
|
|
439
443
|
# sends instead (different item shape, ordered by scheduled time ascending, has_more always false, other
|
|
440
|
-
# filters/cursors ignored). One of: queued, delivered, delivery_delayed,
|
|
441
|
-
# opened, clicked, replied, suppressed, scheduled.
|
|
444
|
+
# filters/cursors ignored, though they must be valid). One of: queued, delivered, delivery_delayed,
|
|
445
|
+
# bounced, complained, failed, opened, clicked, replied, suppressed, scheduled.
|
|
442
446
|
# @option params [String] :q Case-insensitive substring of a recipient or subject, or an exact email id.
|
|
443
|
-
# @option params [Integer] :days Look-back window in days, 1-90
|
|
444
|
-
#
|
|
447
|
+
# @option params [Integer] :days Look-back window in days, 1-90. Always capped by the plan's log
|
|
448
|
+
# retention. Limits: 422 invalid_parameter otherwise. Default: 30.
|
|
445
449
|
# @option params [String] :stream One of: transactional, broadcast.
|
|
446
|
-
# @option params [String] :mode Filter live or test-mode (sandbox) traffic
|
|
447
|
-
# of: live, test.
|
|
450
|
+
# @option params [String] :mode Filter live or test-mode (sandbox) traffic. Limits: 422
|
|
451
|
+
# invalid_parameter for other values. One of: live, test.
|
|
448
452
|
# @option params [Hash{String => String}] :metadata Exact match on a metadata value, e.g.
|
|
449
453
|
# metadata[order_id]=A-1042. Repeatable for several keys.
|
|
450
454
|
# @param request_options [Hash] :idempotency_key, :headers, :timeout and :max_retries for this call
|
|
@@ -617,14 +621,15 @@ module ZapSMTP
|
|
|
617
621
|
# first email) is counted once the customer answers it.
|
|
618
622
|
#
|
|
619
623
|
# @param params [Hash] the parameters below, also accepted as keyword arguments
|
|
620
|
-
# @option params [Integer] :limit 1-100
|
|
624
|
+
# @option params [Integer] :limit 1-100. Limits: 422 invalid_parameter otherwise. Default: 20.
|
|
621
625
|
# @option params [String] :before Cursor: the last_message_at of the last conversation you have (RFC
|
|
622
626
|
# 3339). Limits: 422 invalid_parameter otherwise.
|
|
623
627
|
# @option params [String] :before_id With before: the id of the last conversation you have, so
|
|
624
628
|
# conversations active at the same instant are neither skipped nor repeated.
|
|
625
629
|
# @option params [Boolean] :awaiting_reply true: only conversations whose last human email came in.
|
|
630
|
+
# Limits: 422 invalid_parameter unless true or false.
|
|
626
631
|
# @option params [Boolean] :unread true: only conversations with an email received after their read
|
|
627
|
-
# mark.
|
|
632
|
+
# mark. Limits: 422 invalid_parameter unless true or false.
|
|
628
633
|
# @option params [String] :participant Only conversations this address took part in (case-insensitive).
|
|
629
634
|
# @param request_options [Hash] :idempotency_key, :headers, :timeout and :max_retries for this call
|
|
630
635
|
# @return [ZapSMTP::Page<ZapSMTP::Models::Thread>]
|
|
@@ -1102,7 +1107,7 @@ module ZapSMTP
|
|
|
1102
1107
|
# events (not unique emails), ordered by status name; test-mode traffic excluded.
|
|
1103
1108
|
#
|
|
1104
1109
|
# @param params [Hash] the parameters below, also accepted as keyword arguments
|
|
1105
|
-
# @option params [Integer] :hours 1-720
|
|
1110
|
+
# @option params [Integer] :hours 1-720. Limits: 422 invalid_parameter otherwise. Default: 24.
|
|
1106
1111
|
# @param request_options [Hash] :idempotency_key, :headers, :timeout and :max_retries for this call
|
|
1107
1112
|
# @return [ZapSMTP::Models::Stats]
|
|
1108
1113
|
def get(params = {}, request_options: {}, **kwargs)
|
|
@@ -1121,8 +1126,8 @@ module ZapSMTP
|
|
|
1121
1126
|
# empty buckets are not emitted. Test-mode traffic excluded.
|
|
1122
1127
|
#
|
|
1123
1128
|
# @param params [Hash] the parameters below, also accepted as keyword arguments
|
|
1124
|
-
# @option params [Integer] :hours 1-720
|
|
1125
|
-
# 300 s, <=24h → 1800 s, <=168h → 10800 s, otherwise 43200 s. Default: 24.
|
|
1129
|
+
# @option params [Integer] :hours 1-720 (422 invalid_parameter otherwise). Bucket size: <=1h → 60 s,
|
|
1130
|
+
# <=6h → 300 s, <=24h → 1800 s, <=168h → 10800 s, otherwise 43200 s. Default: 24.
|
|
1126
1131
|
# @param request_options [Hash] :idempotency_key, :headers, :timeout and :max_retries for this call
|
|
1127
1132
|
# @return [ZapSMTP::Models::StatsTimeseries]
|
|
1128
1133
|
def timeseries(params = {}, request_options: {}, **kwargs)
|
|
@@ -1142,7 +1147,7 @@ module ZapSMTP
|
|
|
1142
1147
|
# least once.
|
|
1143
1148
|
#
|
|
1144
1149
|
# @param params [Hash] the parameters below, also accepted as keyword arguments
|
|
1145
|
-
# @option params [Integer] :hours 1-720
|
|
1150
|
+
# @option params [Integer] :hours 1-720. Limits: 422 invalid_parameter otherwise. Default: 24.
|
|
1146
1151
|
# @param request_options [Hash] :idempotency_key, :headers, :timeout and :max_retries for this call
|
|
1147
1152
|
# @return [ZapSMTP::Models::StatsBreakdown]
|
|
1148
1153
|
def breakdown(params = {}, request_options: {}, **kwargs)
|
|
@@ -1334,7 +1339,7 @@ module ZapSMTP
|
|
|
1334
1339
|
#
|
|
1335
1340
|
# @param id [String] Domain id.
|
|
1336
1341
|
# @param params [Hash] the parameters below, also accepted as keyword arguments
|
|
1337
|
-
# @option params [Integer] :days 1-180
|
|
1342
|
+
# @option params [Integer] :days 1-180. Limits: 422 invalid_parameter otherwise. Default: 30.
|
|
1338
1343
|
# @param request_options [Hash] :idempotency_key, :headers, :timeout and :max_retries for this call
|
|
1339
1344
|
# @return [ZapSMTP::Models::DmarcSummary]
|
|
1340
1345
|
def get_dmarc(id, params = {}, request_options: {}, **kwargs)
|
|
@@ -2174,7 +2179,7 @@ module ZapSMTP
|
|
|
2174
2179
|
# it.
|
|
2175
2180
|
#
|
|
2176
2181
|
# @param params [Hash] the parameters below, also accepted as keyword arguments
|
|
2177
|
-
# @option params [Integer] :limit 1-1000
|
|
2182
|
+
# @option params [Integer] :limit 1-1000. Limits: 422 invalid_parameter otherwise. Default: 100.
|
|
2178
2183
|
# @option params [String] :after Opaque cursor from next_cursor. Limits: 422 invalid_parameter "invalid
|
|
2179
2184
|
# after cursor"
|
|
2180
2185
|
# @option params [String] :before Legacy: RFC 3339 timestamp; returns entries created before it. Ignored
|
|
@@ -2335,7 +2340,7 @@ module ZapSMTP
|
|
|
2335
2340
|
# is the id of its log entry.
|
|
2336
2341
|
#
|
|
2337
2342
|
# @param params [Hash] the parameters below, also accepted as keyword arguments
|
|
2338
|
-
# @option params [Integer] :limit 1–100. Default: 20.
|
|
2343
|
+
# @option params [Integer] :limit 1–100. Limits: 422 invalid_parameter otherwise. Default: 20.
|
|
2339
2344
|
# @option params [String] :before A log id: return older entries.
|
|
2340
2345
|
# @option params [String] :after A log id: return newer entries.
|
|
2341
2346
|
# @option params [String] :status An exact status (422) or a class: 2xx, 4xx, 5xx.
|
data/lib/zapsmtp/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: zapsmtp
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.1.
|
|
4
|
+
version: 0.1.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- ZapSMTP
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-10-
|
|
11
|
+
date: 2026-10-31 00:00:00.000000000 Z
|
|
12
12
|
dependencies: []
|
|
13
13
|
description: 'Send, receive and track email with ZapSMTP: every API operation, safe
|
|
14
14
|
retries with idempotency keys, paging over every list, webhook signature verification
|