prelude-sdk 0.4.0 → 0.5.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 +9 -0
- data/README.md +1 -1
- data/lib/prelude_sdk/models/notify_send_params.rb +1 -38
- data/lib/prelude_sdk/models/verification_create_response.rb +11 -4
- data/lib/prelude_sdk/resources/notify.rb +1 -5
- data/lib/prelude_sdk/version.rb +1 -1
- data/rbi/prelude_sdk/models/notify_send_params.rbi +0 -59
- data/rbi/prelude_sdk/models/verification_create_response.rbi +21 -7
- data/rbi/prelude_sdk/resources/notify.rbi +0 -9
- data/sig/prelude_sdk/models/notify_send_params.rbs +0 -26
- data/sig/prelude_sdk/models/verification_create_response.rbs +2 -1
- data/sig/prelude_sdk/resources/notify.rbs +0 -2
- 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: e471ff14576be4e30d555ac095637659799c089243d85e8eb0b1e107d5f72a4d
|
|
4
|
+
data.tar.gz: b7429bca67dc1516c3deaccf43ca63535b4b2ec8e07d36889635893b940cb1ee
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: ad313a26fcd1936dc0b3e66224f7fdf4488c392c85ac3828ee18ff93463791e07ff0113296d5145ef492a3189787601c8481a8ee83fd735af42b985a52cbb148
|
|
7
|
+
data.tar.gz: 2be45dd24a4db7b69cc636e1db2703d69a88721034ebb50bff9f3f79c1b6df2179b4a1f4a08f9681bd6498c7f50f380034e9ff1e6ee895a437433932bbd9d212
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,14 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.5.0 (2026-05-07)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v0.4.0...v0.5.0](https://github.com/prelude-so/ruby-sdk/compare/v0.4.0...v0.5.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** api update ([4a28614](https://github.com/prelude-so/ruby-sdk/commit/4a286145c86c872f859225d1d892e98c640598af))
|
|
10
|
+
* **api:** api update ([7beed1d](https://github.com/prelude-so/ruby-sdk/commit/7beed1dab00a7fd90594bba5f94f53261e22b549))
|
|
11
|
+
|
|
3
12
|
## 0.4.0 (2026-04-30)
|
|
4
13
|
|
|
5
14
|
Full Changelog: [v0.3.0...v0.4.0](https://github.com/prelude-so/ruby-sdk/compare/v0.3.0...v0.4.0)
|
data/README.md
CHANGED
|
@@ -25,13 +25,6 @@ module PreludeSDK
|
|
|
25
25
|
# @return [String, nil]
|
|
26
26
|
optional :callback_url, String
|
|
27
27
|
|
|
28
|
-
# @!attribute context
|
|
29
|
-
# Context for replying to an inbound message. When provided, the message is sent
|
|
30
|
-
# as a WhatsApp reply within the 24-hour conversation window.
|
|
31
|
-
#
|
|
32
|
-
# @return [PreludeSDK::Models::NotifySendParams::Context, nil]
|
|
33
|
-
optional :context, -> { PreludeSDK::NotifySendParams::Context }
|
|
34
|
-
|
|
35
28
|
# @!attribute correlation_id
|
|
36
29
|
# A user-defined identifier to correlate this message with your internal systems.
|
|
37
30
|
# It is returned in the response and any webhook events that refer to this
|
|
@@ -92,21 +85,13 @@ module PreludeSDK
|
|
|
92
85
|
# @return [Time, nil]
|
|
93
86
|
optional :schedule_at, Time
|
|
94
87
|
|
|
95
|
-
# @!attribute text
|
|
96
|
-
# The reply message body. Required when `context.reply_to` is provided. Used for
|
|
97
|
-
# 2-way WhatsApp messaging to send free-form text replies within a conversation
|
|
98
|
-
# window.
|
|
99
|
-
#
|
|
100
|
-
# @return [String, nil]
|
|
101
|
-
optional :text, String
|
|
102
|
-
|
|
103
88
|
# @!attribute variables
|
|
104
89
|
# The variables to be replaced in the template.
|
|
105
90
|
#
|
|
106
91
|
# @return [Hash{Symbol=>String}, nil]
|
|
107
92
|
optional :variables, PreludeSDK::Internal::Type::HashOf[String]
|
|
108
93
|
|
|
109
|
-
# @!method initialize(template_id:, to:, callback_url: nil,
|
|
94
|
+
# @!method initialize(template_id:, to:, callback_url: nil, correlation_id: nil, document: nil, expires_at: nil, from: nil, locale: nil, preferred_channel: nil, schedule_at: nil, variables: nil, request_options: {})
|
|
110
95
|
# Some parameter documentations has been truncated, see
|
|
111
96
|
# {PreludeSDK::Models::NotifySendParams} for more details.
|
|
112
97
|
#
|
|
@@ -116,8 +101,6 @@ module PreludeSDK
|
|
|
116
101
|
#
|
|
117
102
|
# @param callback_url [String] The URL where webhooks will be sent for message delivery events.
|
|
118
103
|
#
|
|
119
|
-
# @param context [PreludeSDK::Models::NotifySendParams::Context] Context for replying to an inbound message. When provided, the message is sent a
|
|
120
|
-
#
|
|
121
104
|
# @param correlation_id [String] A user-defined identifier to correlate this message with your internal systems.
|
|
122
105
|
#
|
|
123
106
|
# @param document [PreludeSDK::Models::NotifySendParams::Document] A media attachment to include in the message header. Supported on
|
|
@@ -132,30 +115,10 @@ module PreludeSDK
|
|
|
132
115
|
#
|
|
133
116
|
# @param schedule_at [Time] Schedule the message for future delivery in RFC3339 format. Marketing messages c
|
|
134
117
|
#
|
|
135
|
-
# @param text [String] The reply message body. Required when `context.reply_to` is provided. Used for 2
|
|
136
|
-
#
|
|
137
118
|
# @param variables [Hash{Symbol=>String}] The variables to be replaced in the template.
|
|
138
119
|
#
|
|
139
120
|
# @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
140
121
|
|
|
141
|
-
class Context < PreludeSDK::Internal::Type::BaseModel
|
|
142
|
-
# @!attribute reply_to
|
|
143
|
-
# The inbound message ID (prefixed with `im_`) to reply to. This ID is provided in
|
|
144
|
-
# the `inbound.message.received` webhook event.
|
|
145
|
-
#
|
|
146
|
-
# @return [String]
|
|
147
|
-
required :reply_to, String
|
|
148
|
-
|
|
149
|
-
# @!method initialize(reply_to:)
|
|
150
|
-
# Some parameter documentations has been truncated, see
|
|
151
|
-
# {PreludeSDK::Models::NotifySendParams::Context} for more details.
|
|
152
|
-
#
|
|
153
|
-
# Context for replying to an inbound message. When provided, the message is sent
|
|
154
|
-
# as a WhatsApp reply within the 24-hour conversation window.
|
|
155
|
-
#
|
|
156
|
-
# @param reply_to [String] The inbound message ID (prefixed with `im_`) to reply to. This ID is provided in
|
|
157
|
-
end
|
|
158
|
-
|
|
159
122
|
class Document < PreludeSDK::Internal::Type::BaseModel
|
|
160
123
|
# @!attribute url
|
|
161
124
|
# HTTPS URL of the media file. The file extension must match the template's
|
|
@@ -27,6 +27,9 @@ module PreludeSDK
|
|
|
27
27
|
# non-voice channels only. This mode must be enabled for your customer account
|
|
28
28
|
# by Prelude support.
|
|
29
29
|
# - `blocked` - The verification was blocked.
|
|
30
|
+
# - `shadow_blocked` - The verification triggered a block rule but the decision
|
|
31
|
+
# was not enforced; this is used to dry-run anti-fraud configuration. This mode
|
|
32
|
+
# must be enabled for your customer account by Prelude support.
|
|
30
33
|
#
|
|
31
34
|
# @return [Symbol, PreludeSDK::Models::VerificationCreateResponse::Status]
|
|
32
35
|
required :status, enum: -> { PreludeSDK::Models::VerificationCreateResponse::Status }
|
|
@@ -46,7 +49,7 @@ module PreludeSDK
|
|
|
46
49
|
|
|
47
50
|
# @!attribute reason
|
|
48
51
|
# The reason why the verification was blocked. Only present when status is
|
|
49
|
-
# "blocked".
|
|
52
|
+
# "blocked" or "shadow_blocked".
|
|
50
53
|
#
|
|
51
54
|
# - `expired_signature` - The signature of the SDK signals is expired. They should
|
|
52
55
|
# be sent within the hour following their collection.
|
|
@@ -71,8 +74,8 @@ module PreludeSDK
|
|
|
71
74
|
|
|
72
75
|
# @!attribute risk_factors
|
|
73
76
|
# The risk factors that contributed to the verification being blocked. Only
|
|
74
|
-
# present when status is "blocked" and the anti-fraud system
|
|
75
|
-
# risk signals.
|
|
77
|
+
# present when status is "blocked" or "shadow_blocked" and the anti-fraud system
|
|
78
|
+
# detected specific risk signals.
|
|
76
79
|
#
|
|
77
80
|
# - `behavioral_pattern` - The phone number past behavior during verification
|
|
78
81
|
# flows exhibits suspicious patterns.
|
|
@@ -150,6 +153,9 @@ module PreludeSDK
|
|
|
150
153
|
# non-voice channels only. This mode must be enabled for your customer account
|
|
151
154
|
# by Prelude support.
|
|
152
155
|
# - `blocked` - The verification was blocked.
|
|
156
|
+
# - `shadow_blocked` - The verification triggered a block rule but the decision
|
|
157
|
+
# was not enforced; this is used to dry-run anti-fraud configuration. This mode
|
|
158
|
+
# must be enabled for your customer account by Prelude support.
|
|
153
159
|
#
|
|
154
160
|
# @see PreludeSDK::Models::VerificationCreateResponse#status
|
|
155
161
|
module Status
|
|
@@ -159,6 +165,7 @@ module PreludeSDK
|
|
|
159
165
|
RETRY = :retry
|
|
160
166
|
CHALLENGED = :challenged
|
|
161
167
|
BLOCKED = :blocked
|
|
168
|
+
SHADOW_BLOCKED = :shadow_blocked
|
|
162
169
|
|
|
163
170
|
# @!method self.values
|
|
164
171
|
# @return [Array<Symbol>]
|
|
@@ -199,7 +206,7 @@ module PreludeSDK
|
|
|
199
206
|
end
|
|
200
207
|
|
|
201
208
|
# The reason why the verification was blocked. Only present when status is
|
|
202
|
-
# "blocked".
|
|
209
|
+
# "blocked" or "shadow_blocked".
|
|
203
210
|
#
|
|
204
211
|
# - `expired_signature` - The signature of the SDK signals is expired. They should
|
|
205
212
|
# be sent within the hour following their collection.
|
|
@@ -159,7 +159,7 @@ module PreludeSDK
|
|
|
159
159
|
# Send transactional and marketing messages to your users via SMS, RCS and
|
|
160
160
|
# WhatsApp with automatic compliance enforcement.
|
|
161
161
|
#
|
|
162
|
-
# @overload send_(template_id:, to:, callback_url: nil,
|
|
162
|
+
# @overload send_(template_id:, to:, callback_url: nil, correlation_id: nil, document: nil, expires_at: nil, from: nil, locale: nil, preferred_channel: nil, schedule_at: nil, variables: nil, request_options: {})
|
|
163
163
|
#
|
|
164
164
|
# @param template_id [String] The template identifier configured by your Customer Success team.
|
|
165
165
|
#
|
|
@@ -167,8 +167,6 @@ module PreludeSDK
|
|
|
167
167
|
#
|
|
168
168
|
# @param callback_url [String] The URL where webhooks will be sent for message delivery events.
|
|
169
169
|
#
|
|
170
|
-
# @param context [PreludeSDK::Models::NotifySendParams::Context] Context for replying to an inbound message. When provided, the message is sent a
|
|
171
|
-
#
|
|
172
170
|
# @param correlation_id [String] A user-defined identifier to correlate this message with your internal systems.
|
|
173
171
|
#
|
|
174
172
|
# @param document [PreludeSDK::Models::NotifySendParams::Document] A media attachment to include in the message header. Supported on
|
|
@@ -183,8 +181,6 @@ module PreludeSDK
|
|
|
183
181
|
#
|
|
184
182
|
# @param schedule_at [Time] Schedule the message for future delivery in RFC3339 format. Marketing messages c
|
|
185
183
|
#
|
|
186
|
-
# @param text [String] The reply message body. Required when `context.reply_to` is provided. Used for 2
|
|
187
|
-
#
|
|
188
184
|
# @param variables [Hash{Symbol=>String}] The variables to be replaced in the template.
|
|
189
185
|
#
|
|
190
186
|
# @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
data/lib/prelude_sdk/version.rb
CHANGED
|
@@ -26,16 +26,6 @@ module PreludeSDK
|
|
|
26
26
|
sig { params(callback_url: String).void }
|
|
27
27
|
attr_writer :callback_url
|
|
28
28
|
|
|
29
|
-
# Context for replying to an inbound message. When provided, the message is sent
|
|
30
|
-
# as a WhatsApp reply within the 24-hour conversation window.
|
|
31
|
-
sig { returns(T.nilable(PreludeSDK::NotifySendParams::Context)) }
|
|
32
|
-
attr_reader :context
|
|
33
|
-
|
|
34
|
-
sig do
|
|
35
|
-
params(context: PreludeSDK::NotifySendParams::Context::OrHash).void
|
|
36
|
-
end
|
|
37
|
-
attr_writer :context
|
|
38
|
-
|
|
39
29
|
# A user-defined identifier to correlate this message with your internal systems.
|
|
40
30
|
# It is returned in the response and any webhook events that refer to this
|
|
41
31
|
# message.
|
|
@@ -114,15 +104,6 @@ module PreludeSDK
|
|
|
114
104
|
sig { params(schedule_at: Time).void }
|
|
115
105
|
attr_writer :schedule_at
|
|
116
106
|
|
|
117
|
-
# The reply message body. Required when `context.reply_to` is provided. Used for
|
|
118
|
-
# 2-way WhatsApp messaging to send free-form text replies within a conversation
|
|
119
|
-
# window.
|
|
120
|
-
sig { returns(T.nilable(String)) }
|
|
121
|
-
attr_reader :text
|
|
122
|
-
|
|
123
|
-
sig { params(text: String).void }
|
|
124
|
-
attr_writer :text
|
|
125
|
-
|
|
126
107
|
# The variables to be replaced in the template.
|
|
127
108
|
sig { returns(T.nilable(T::Hash[Symbol, String])) }
|
|
128
109
|
attr_reader :variables
|
|
@@ -135,7 +116,6 @@ module PreludeSDK
|
|
|
135
116
|
template_id: String,
|
|
136
117
|
to: String,
|
|
137
118
|
callback_url: String,
|
|
138
|
-
context: PreludeSDK::NotifySendParams::Context::OrHash,
|
|
139
119
|
correlation_id: String,
|
|
140
120
|
document: PreludeSDK::NotifySendParams::Document::OrHash,
|
|
141
121
|
expires_at: Time,
|
|
@@ -144,7 +124,6 @@ module PreludeSDK
|
|
|
144
124
|
preferred_channel:
|
|
145
125
|
PreludeSDK::NotifySendParams::PreferredChannel::OrSymbol,
|
|
146
126
|
schedule_at: Time,
|
|
147
|
-
text: String,
|
|
148
127
|
variables: T::Hash[Symbol, String],
|
|
149
128
|
request_options: PreludeSDK::RequestOptions::OrHash
|
|
150
129
|
).returns(T.attached_class)
|
|
@@ -156,9 +135,6 @@ module PreludeSDK
|
|
|
156
135
|
to:,
|
|
157
136
|
# The URL where webhooks will be sent for message delivery events.
|
|
158
137
|
callback_url: nil,
|
|
159
|
-
# Context for replying to an inbound message. When provided, the message is sent
|
|
160
|
-
# as a WhatsApp reply within the 24-hour conversation window.
|
|
161
|
-
context: nil,
|
|
162
138
|
# A user-defined identifier to correlate this message with your internal systems.
|
|
163
139
|
# It is returned in the response and any webhook events that refer to this
|
|
164
140
|
# message.
|
|
@@ -191,10 +167,6 @@ module PreludeSDK
|
|
|
191
167
|
# can be scheduled up to 90 days in advance and will be automatically adjusted for
|
|
192
168
|
# compliance with local time window restrictions.
|
|
193
169
|
schedule_at: nil,
|
|
194
|
-
# The reply message body. Required when `context.reply_to` is provided. Used for
|
|
195
|
-
# 2-way WhatsApp messaging to send free-form text replies within a conversation
|
|
196
|
-
# window.
|
|
197
|
-
text: nil,
|
|
198
170
|
# The variables to be replaced in the template.
|
|
199
171
|
variables: nil,
|
|
200
172
|
request_options: {}
|
|
@@ -207,7 +179,6 @@ module PreludeSDK
|
|
|
207
179
|
template_id: String,
|
|
208
180
|
to: String,
|
|
209
181
|
callback_url: String,
|
|
210
|
-
context: PreludeSDK::NotifySendParams::Context,
|
|
211
182
|
correlation_id: String,
|
|
212
183
|
document: PreludeSDK::NotifySendParams::Document,
|
|
213
184
|
expires_at: Time,
|
|
@@ -216,7 +187,6 @@ module PreludeSDK
|
|
|
216
187
|
preferred_channel:
|
|
217
188
|
PreludeSDK::NotifySendParams::PreferredChannel::OrSymbol,
|
|
218
189
|
schedule_at: Time,
|
|
219
|
-
text: String,
|
|
220
190
|
variables: T::Hash[Symbol, String],
|
|
221
191
|
request_options: PreludeSDK::RequestOptions
|
|
222
192
|
}
|
|
@@ -225,35 +195,6 @@ module PreludeSDK
|
|
|
225
195
|
def to_hash
|
|
226
196
|
end
|
|
227
197
|
|
|
228
|
-
class Context < PreludeSDK::Internal::Type::BaseModel
|
|
229
|
-
OrHash =
|
|
230
|
-
T.type_alias do
|
|
231
|
-
T.any(
|
|
232
|
-
PreludeSDK::NotifySendParams::Context,
|
|
233
|
-
PreludeSDK::Internal::AnyHash
|
|
234
|
-
)
|
|
235
|
-
end
|
|
236
|
-
|
|
237
|
-
# The inbound message ID (prefixed with `im_`) to reply to. This ID is provided in
|
|
238
|
-
# the `inbound.message.received` webhook event.
|
|
239
|
-
sig { returns(String) }
|
|
240
|
-
attr_accessor :reply_to
|
|
241
|
-
|
|
242
|
-
# Context for replying to an inbound message. When provided, the message is sent
|
|
243
|
-
# as a WhatsApp reply within the 24-hour conversation window.
|
|
244
|
-
sig { params(reply_to: String).returns(T.attached_class) }
|
|
245
|
-
def self.new(
|
|
246
|
-
# The inbound message ID (prefixed with `im_`) to reply to. This ID is provided in
|
|
247
|
-
# the `inbound.message.received` webhook event.
|
|
248
|
-
reply_to:
|
|
249
|
-
)
|
|
250
|
-
end
|
|
251
|
-
|
|
252
|
-
sig { override.returns({ reply_to: String }) }
|
|
253
|
-
def to_hash
|
|
254
|
-
end
|
|
255
|
-
end
|
|
256
|
-
|
|
257
198
|
class Document < PreludeSDK::Internal::Type::BaseModel
|
|
258
199
|
OrHash =
|
|
259
200
|
T.type_alias do
|
|
@@ -31,6 +31,9 @@ module PreludeSDK
|
|
|
31
31
|
# non-voice channels only. This mode must be enabled for your customer account
|
|
32
32
|
# by Prelude support.
|
|
33
33
|
# - `blocked` - The verification was blocked.
|
|
34
|
+
# - `shadow_blocked` - The verification triggered a block rule but the decision
|
|
35
|
+
# was not enforced; this is used to dry-run anti-fraud configuration. This mode
|
|
36
|
+
# must be enabled for your customer account by Prelude support.
|
|
34
37
|
sig do
|
|
35
38
|
returns(
|
|
36
39
|
PreludeSDK::Models::VerificationCreateResponse::Status::TaggedSymbol
|
|
@@ -77,7 +80,7 @@ module PreludeSDK
|
|
|
77
80
|
attr_writer :metadata
|
|
78
81
|
|
|
79
82
|
# The reason why the verification was blocked. Only present when status is
|
|
80
|
-
# "blocked".
|
|
83
|
+
# "blocked" or "shadow_blocked".
|
|
81
84
|
#
|
|
82
85
|
# - `expired_signature` - The signature of the SDK signals is expired. They should
|
|
83
86
|
# be sent within the hour following their collection.
|
|
@@ -115,8 +118,8 @@ module PreludeSDK
|
|
|
115
118
|
attr_writer :request_id
|
|
116
119
|
|
|
117
120
|
# The risk factors that contributed to the verification being blocked. Only
|
|
118
|
-
# present when status is "blocked" and the anti-fraud system
|
|
119
|
-
# risk signals.
|
|
121
|
+
# present when status is "blocked" or "shadow_blocked" and the anti-fraud system
|
|
122
|
+
# detected specific risk signals.
|
|
120
123
|
#
|
|
121
124
|
# - `behavioral_pattern` - The phone number past behavior during verification
|
|
122
125
|
# flows exhibits suspicious patterns.
|
|
@@ -210,13 +213,16 @@ module PreludeSDK
|
|
|
210
213
|
# non-voice channels only. This mode must be enabled for your customer account
|
|
211
214
|
# by Prelude support.
|
|
212
215
|
# - `blocked` - The verification was blocked.
|
|
216
|
+
# - `shadow_blocked` - The verification triggered a block rule but the decision
|
|
217
|
+
# was not enforced; this is used to dry-run anti-fraud configuration. This mode
|
|
218
|
+
# must be enabled for your customer account by Prelude support.
|
|
213
219
|
status:,
|
|
214
220
|
# The ordered sequence of channels to be used for verification
|
|
215
221
|
channels: nil,
|
|
216
222
|
# The metadata for this verification.
|
|
217
223
|
metadata: nil,
|
|
218
224
|
# The reason why the verification was blocked. Only present when status is
|
|
219
|
-
# "blocked".
|
|
225
|
+
# "blocked" or "shadow_blocked".
|
|
220
226
|
#
|
|
221
227
|
# - `expired_signature` - The signature of the SDK signals is expired. They should
|
|
222
228
|
# be sent within the hour following their collection.
|
|
@@ -233,8 +239,8 @@ module PreludeSDK
|
|
|
233
239
|
reason: nil,
|
|
234
240
|
request_id: nil,
|
|
235
241
|
# The risk factors that contributed to the verification being blocked. Only
|
|
236
|
-
# present when status is "blocked" and the anti-fraud system
|
|
237
|
-
# risk signals.
|
|
242
|
+
# present when status is "blocked" or "shadow_blocked" and the anti-fraud system
|
|
243
|
+
# detected specific risk signals.
|
|
238
244
|
#
|
|
239
245
|
# - `behavioral_pattern` - The phone number past behavior during verification
|
|
240
246
|
# flows exhibits suspicious patterns.
|
|
@@ -342,6 +348,9 @@ module PreludeSDK
|
|
|
342
348
|
# non-voice channels only. This mode must be enabled for your customer account
|
|
343
349
|
# by Prelude support.
|
|
344
350
|
# - `blocked` - The verification was blocked.
|
|
351
|
+
# - `shadow_blocked` - The verification triggered a block rule but the decision
|
|
352
|
+
# was not enforced; this is used to dry-run anti-fraud configuration. This mode
|
|
353
|
+
# must be enabled for your customer account by Prelude support.
|
|
345
354
|
module Status
|
|
346
355
|
extend PreludeSDK::Internal::Type::Enum
|
|
347
356
|
|
|
@@ -374,6 +383,11 @@ module PreludeSDK
|
|
|
374
383
|
:blocked,
|
|
375
384
|
PreludeSDK::Models::VerificationCreateResponse::Status::TaggedSymbol
|
|
376
385
|
)
|
|
386
|
+
SHADOW_BLOCKED =
|
|
387
|
+
T.let(
|
|
388
|
+
:shadow_blocked,
|
|
389
|
+
PreludeSDK::Models::VerificationCreateResponse::Status::TaggedSymbol
|
|
390
|
+
)
|
|
377
391
|
|
|
378
392
|
sig do
|
|
379
393
|
override.returns(
|
|
@@ -482,7 +496,7 @@ module PreludeSDK
|
|
|
482
496
|
end
|
|
483
497
|
|
|
484
498
|
# The reason why the verification was blocked. Only present when status is
|
|
485
|
-
# "blocked".
|
|
499
|
+
# "blocked" or "shadow_blocked".
|
|
486
500
|
#
|
|
487
501
|
# - `expired_signature` - The signature of the SDK signals is expired. They should
|
|
488
502
|
# be sent within the hour following their collection.
|
|
@@ -121,7 +121,6 @@ module PreludeSDK
|
|
|
121
121
|
template_id: String,
|
|
122
122
|
to: String,
|
|
123
123
|
callback_url: String,
|
|
124
|
-
context: PreludeSDK::NotifySendParams::Context::OrHash,
|
|
125
124
|
correlation_id: String,
|
|
126
125
|
document: PreludeSDK::NotifySendParams::Document::OrHash,
|
|
127
126
|
expires_at: Time,
|
|
@@ -130,7 +129,6 @@ module PreludeSDK
|
|
|
130
129
|
preferred_channel:
|
|
131
130
|
PreludeSDK::NotifySendParams::PreferredChannel::OrSymbol,
|
|
132
131
|
schedule_at: Time,
|
|
133
|
-
text: String,
|
|
134
132
|
variables: T::Hash[Symbol, String],
|
|
135
133
|
request_options: PreludeSDK::RequestOptions::OrHash
|
|
136
134
|
).returns(PreludeSDK::Models::NotifySendResponse)
|
|
@@ -142,9 +140,6 @@ module PreludeSDK
|
|
|
142
140
|
to:,
|
|
143
141
|
# The URL where webhooks will be sent for message delivery events.
|
|
144
142
|
callback_url: nil,
|
|
145
|
-
# Context for replying to an inbound message. When provided, the message is sent
|
|
146
|
-
# as a WhatsApp reply within the 24-hour conversation window.
|
|
147
|
-
context: nil,
|
|
148
143
|
# A user-defined identifier to correlate this message with your internal systems.
|
|
149
144
|
# It is returned in the response and any webhook events that refer to this
|
|
150
145
|
# message.
|
|
@@ -177,10 +172,6 @@ module PreludeSDK
|
|
|
177
172
|
# can be scheduled up to 90 days in advance and will be automatically adjusted for
|
|
178
173
|
# compliance with local time window restrictions.
|
|
179
174
|
schedule_at: nil,
|
|
180
|
-
# The reply message body. Required when `context.reply_to` is provided. Used for
|
|
181
|
-
# 2-way WhatsApp messaging to send free-form text replies within a conversation
|
|
182
|
-
# window.
|
|
183
|
-
text: nil,
|
|
184
175
|
# The variables to be replaced in the template.
|
|
185
176
|
variables: nil,
|
|
186
177
|
request_options: {}
|
|
@@ -5,7 +5,6 @@ module PreludeSDK
|
|
|
5
5
|
template_id: String,
|
|
6
6
|
to: String,
|
|
7
7
|
callback_url: String,
|
|
8
|
-
context: PreludeSDK::NotifySendParams::Context,
|
|
9
8
|
correlation_id: String,
|
|
10
9
|
document: PreludeSDK::NotifySendParams::Document,
|
|
11
10
|
expires_at: Time,
|
|
@@ -13,7 +12,6 @@ module PreludeSDK
|
|
|
13
12
|
locale: String,
|
|
14
13
|
preferred_channel: PreludeSDK::Models::NotifySendParams::preferred_channel,
|
|
15
14
|
schedule_at: Time,
|
|
16
|
-
text: String,
|
|
17
15
|
variables: ::Hash[Symbol, String]
|
|
18
16
|
}
|
|
19
17
|
& PreludeSDK::Internal::Type::request_parameters
|
|
@@ -30,12 +28,6 @@ module PreludeSDK
|
|
|
30
28
|
|
|
31
29
|
def callback_url=: (String) -> String
|
|
32
30
|
|
|
33
|
-
attr_reader context: PreludeSDK::NotifySendParams::Context?
|
|
34
|
-
|
|
35
|
-
def context=: (
|
|
36
|
-
PreludeSDK::NotifySendParams::Context
|
|
37
|
-
) -> PreludeSDK::NotifySendParams::Context
|
|
38
|
-
|
|
39
31
|
attr_reader correlation_id: String?
|
|
40
32
|
|
|
41
33
|
def correlation_id=: (String) -> String
|
|
@@ -68,10 +60,6 @@ module PreludeSDK
|
|
|
68
60
|
|
|
69
61
|
def schedule_at=: (Time) -> Time
|
|
70
62
|
|
|
71
|
-
attr_reader text: String?
|
|
72
|
-
|
|
73
|
-
def text=: (String) -> String
|
|
74
|
-
|
|
75
63
|
attr_reader variables: ::Hash[Symbol, String]?
|
|
76
64
|
|
|
77
65
|
def variables=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
|
|
@@ -80,7 +68,6 @@ module PreludeSDK
|
|
|
80
68
|
template_id: String,
|
|
81
69
|
to: String,
|
|
82
70
|
?callback_url: String,
|
|
83
|
-
?context: PreludeSDK::NotifySendParams::Context,
|
|
84
71
|
?correlation_id: String,
|
|
85
72
|
?document: PreludeSDK::NotifySendParams::Document,
|
|
86
73
|
?expires_at: Time,
|
|
@@ -88,7 +75,6 @@ module PreludeSDK
|
|
|
88
75
|
?locale: String,
|
|
89
76
|
?preferred_channel: PreludeSDK::Models::NotifySendParams::preferred_channel,
|
|
90
77
|
?schedule_at: Time,
|
|
91
|
-
?text: String,
|
|
92
78
|
?variables: ::Hash[Symbol, String],
|
|
93
79
|
?request_options: PreludeSDK::request_opts
|
|
94
80
|
) -> void
|
|
@@ -97,7 +83,6 @@ module PreludeSDK
|
|
|
97
83
|
template_id: String,
|
|
98
84
|
to: String,
|
|
99
85
|
callback_url: String,
|
|
100
|
-
context: PreludeSDK::NotifySendParams::Context,
|
|
101
86
|
correlation_id: String,
|
|
102
87
|
document: PreludeSDK::NotifySendParams::Document,
|
|
103
88
|
expires_at: Time,
|
|
@@ -105,21 +90,10 @@ module PreludeSDK
|
|
|
105
90
|
locale: String,
|
|
106
91
|
preferred_channel: PreludeSDK::Models::NotifySendParams::preferred_channel,
|
|
107
92
|
schedule_at: Time,
|
|
108
|
-
text: String,
|
|
109
93
|
variables: ::Hash[Symbol, String],
|
|
110
94
|
request_options: PreludeSDK::RequestOptions
|
|
111
95
|
}
|
|
112
96
|
|
|
113
|
-
type context = { reply_to: String }
|
|
114
|
-
|
|
115
|
-
class Context < PreludeSDK::Internal::Type::BaseModel
|
|
116
|
-
attr_accessor reply_to: String
|
|
117
|
-
|
|
118
|
-
def initialize: (reply_to: String) -> void
|
|
119
|
-
|
|
120
|
-
def to_hash: -> { reply_to: String }
|
|
121
|
-
end
|
|
122
|
-
|
|
123
97
|
type document = { url: String, filename: String }
|
|
124
98
|
|
|
125
99
|
class Document < PreludeSDK::Internal::Type::BaseModel
|
|
@@ -91,7 +91,7 @@ module PreludeSDK
|
|
|
91
91
|
def self?.values: -> ::Array[PreludeSDK::Models::VerificationCreateResponse::method_]
|
|
92
92
|
end
|
|
93
93
|
|
|
94
|
-
type status = :success | :retry | :challenged | :blocked
|
|
94
|
+
type status = :success | :retry | :challenged | :blocked | :shadow_blocked
|
|
95
95
|
|
|
96
96
|
module Status
|
|
97
97
|
extend PreludeSDK::Internal::Type::Enum
|
|
@@ -100,6 +100,7 @@ module PreludeSDK
|
|
|
100
100
|
RETRY: :retry
|
|
101
101
|
CHALLENGED: :challenged
|
|
102
102
|
BLOCKED: :blocked
|
|
103
|
+
SHADOW_BLOCKED: :shadow_blocked
|
|
103
104
|
|
|
104
105
|
def self?.values: -> ::Array[PreludeSDK::Models::VerificationCreateResponse::status]
|
|
105
106
|
end
|
|
@@ -38,7 +38,6 @@ module PreludeSDK
|
|
|
38
38
|
template_id: String,
|
|
39
39
|
to: String,
|
|
40
40
|
?callback_url: String,
|
|
41
|
-
?context: PreludeSDK::NotifySendParams::Context,
|
|
42
41
|
?correlation_id: String,
|
|
43
42
|
?document: PreludeSDK::NotifySendParams::Document,
|
|
44
43
|
?expires_at: Time,
|
|
@@ -46,7 +45,6 @@ module PreludeSDK
|
|
|
46
45
|
?locale: String,
|
|
47
46
|
?preferred_channel: PreludeSDK::Models::NotifySendParams::preferred_channel,
|
|
48
47
|
?schedule_at: Time,
|
|
49
|
-
?text: String,
|
|
50
48
|
?variables: ::Hash[Symbol, String],
|
|
51
49
|
?request_options: PreludeSDK::request_opts
|
|
52
50
|
) -> PreludeSDK::Models::NotifySendResponse
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: prelude-sdk
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.5.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Prelude
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-05-
|
|
11
|
+
date: 2026-05-07 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: cgi
|