prelude-sdk 0.1.0.pre.alpha.3 → 0.1.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 +45 -0
- data/README.md +29 -1
- data/lib/prelude_sdk/client.rb +4 -0
- data/lib/prelude_sdk/errors.rb +25 -11
- data/lib/prelude_sdk/file_part.rb +10 -7
- data/lib/prelude_sdk/internal/transport/base_client.rb +18 -8
- data/lib/prelude_sdk/internal/transport/pooled_net_requester.rb +40 -33
- data/lib/prelude_sdk/internal/type/base_page.rb +1 -1
- data/lib/prelude_sdk/internal/type/file_input.rb +7 -4
- data/lib/prelude_sdk/internal/util.rb +8 -7
- data/lib/prelude_sdk/models/transactional_send_params.rb +37 -1
- data/lib/prelude_sdk/models/verification_create_params.rb +45 -5
- data/lib/prelude_sdk/models/verification_create_response.rb +26 -0
- data/lib/prelude_sdk/models/verification_management_delete_phone_number_params.rb +32 -0
- data/lib/prelude_sdk/models/verification_management_delete_phone_number_response.rb +17 -0
- data/lib/prelude_sdk/models/verification_management_list_phone_numbers_params.rb +24 -0
- data/lib/prelude_sdk/models/verification_management_list_phone_numbers_response.rb +37 -0
- data/lib/prelude_sdk/models/verification_management_list_sender_ids_params.rb +14 -0
- data/lib/prelude_sdk/models/verification_management_list_sender_ids_response.rb +65 -0
- data/lib/prelude_sdk/models/verification_management_set_phone_number_params.rb +32 -0
- data/lib/prelude_sdk/models/verification_management_set_phone_number_response.rb +17 -0
- data/lib/prelude_sdk/models/verification_management_submit_sender_id_params.rb +22 -0
- data/lib/prelude_sdk/models/verification_management_submit_sender_id_response.rb +59 -0
- data/lib/prelude_sdk/models/watch_predict_params.rb +11 -1
- data/lib/prelude_sdk/models/watch_send_feedbacks_params.rb +11 -1
- data/lib/prelude_sdk/models.rb +14 -0
- data/lib/prelude_sdk/resources/transactional.rb +7 -2
- data/lib/prelude_sdk/resources/verification_management.rb +140 -0
- data/lib/prelude_sdk/version.rb +1 -1
- data/lib/prelude_sdk.rb +12 -0
- data/manifest.yaml +1 -0
- data/rbi/prelude_sdk/client.rbi +3 -0
- data/rbi/prelude_sdk/errors.rbi +29 -2
- data/rbi/prelude_sdk/file_part.rbi +1 -1
- data/rbi/prelude_sdk/internal/transport/base_client.rbi +9 -5
- data/rbi/prelude_sdk/internal/transport/pooled_net_requester.rbi +6 -2
- data/rbi/prelude_sdk/internal/type/base_model.rbi +8 -4
- data/rbi/prelude_sdk/internal/type/base_page.rbi +1 -1
- data/rbi/prelude_sdk/internal/util.rbi +1 -1
- data/rbi/prelude_sdk/models/transactional_send_params.rbi +85 -0
- data/rbi/prelude_sdk/models/verification_create_params.rbi +97 -5
- data/rbi/prelude_sdk/models/verification_create_response.rbi +39 -0
- data/rbi/prelude_sdk/models/verification_management_delete_phone_number_params.rbi +77 -0
- data/rbi/prelude_sdk/models/verification_management_delete_phone_number_response.rbi +30 -0
- data/rbi/prelude_sdk/models/verification_management_list_phone_numbers_params.rbi +64 -0
- data/rbi/prelude_sdk/models/verification_management_list_phone_numbers_response.rbi +87 -0
- data/rbi/prelude_sdk/models/verification_management_list_sender_ids_params.rbi +30 -0
- data/rbi/prelude_sdk/models/verification_management_list_sender_ids_response.rbi +175 -0
- data/rbi/prelude_sdk/models/verification_management_set_phone_number_params.rbi +77 -0
- data/rbi/prelude_sdk/models/verification_management_set_phone_number_response.rbi +30 -0
- data/rbi/prelude_sdk/models/verification_management_submit_sender_id_params.rbi +43 -0
- data/rbi/prelude_sdk/models/verification_management_submit_sender_id_response.rbi +117 -0
- data/rbi/prelude_sdk/models/watch_predict_params.rbi +15 -0
- data/rbi/prelude_sdk/models/watch_send_feedbacks_params.rbi +15 -0
- data/rbi/prelude_sdk/models.rbi +15 -0
- data/rbi/prelude_sdk/resources/transactional.rbi +14 -1
- data/rbi/prelude_sdk/resources/verification_management.rbi +112 -0
- data/sig/prelude_sdk/client.rbs +2 -0
- data/sig/prelude_sdk/errors.rbs +7 -0
- data/sig/prelude_sdk/file_part.rbs +1 -1
- data/sig/prelude_sdk/internal/transport/base_client.rbs +2 -0
- data/sig/prelude_sdk/internal/transport/pooled_net_requester.rbs +4 -1
- data/sig/prelude_sdk/models/transactional_send_params.rbs +21 -0
- data/sig/prelude_sdk/models/verification_create_params.rbs +29 -1
- data/sig/prelude_sdk/models/verification_management_delete_phone_number_params.rbs +34 -0
- data/sig/prelude_sdk/models/verification_management_delete_phone_number_response.rbs +14 -0
- data/sig/prelude_sdk/models/verification_management_list_phone_numbers_params.rbs +26 -0
- data/sig/prelude_sdk/models/verification_management_list_phone_numbers_response.rbs +32 -0
- data/sig/prelude_sdk/models/verification_management_list_sender_ids_params.rbs +15 -0
- data/sig/prelude_sdk/models/verification_management_list_sender_ids_response.rbs +64 -0
- data/sig/prelude_sdk/models/verification_management_set_phone_number_params.rbs +34 -0
- data/sig/prelude_sdk/models/verification_management_set_phone_number_response.rbs +14 -0
- data/sig/prelude_sdk/models/verification_management_submit_sender_id_params.rbs +23 -0
- data/sig/prelude_sdk/models/verification_management_submit_sender_id_response.rbs +44 -0
- data/sig/prelude_sdk/models/watch_predict_params.rbs +7 -0
- data/sig/prelude_sdk/models/watch_send_feedbacks_params.rbs +7 -0
- data/sig/prelude_sdk/models.rbs +10 -0
- data/sig/prelude_sdk/resources/transactional.rbs +1 -0
- data/sig/prelude_sdk/resources/verification_management.rbs +33 -0
- metadata +37 -4
|
@@ -140,6 +140,12 @@ module PreludeSDK
|
|
|
140
140
|
# @return [String, nil]
|
|
141
141
|
optional :custom_code, String
|
|
142
142
|
|
|
143
|
+
# @!attribute integration
|
|
144
|
+
# The integration that triggered the verification.
|
|
145
|
+
#
|
|
146
|
+
# @return [Symbol, PreludeSDK::Models::VerificationCreateParams::Options::Integration, nil]
|
|
147
|
+
optional :integration, enum: -> { PreludeSDK::VerificationCreateParams::Options::Integration }
|
|
148
|
+
|
|
143
149
|
# @!attribute locale
|
|
144
150
|
# A BCP-47 formatted locale string with the language the text message will be sent
|
|
145
151
|
# to. If there's no locale set, the language will be determined by the country
|
|
@@ -153,7 +159,10 @@ module PreludeSDK
|
|
|
153
159
|
# The method used for verifying this phone number. The 'voice' option provides an
|
|
154
160
|
# accessible alternative for visually impaired users by delivering the
|
|
155
161
|
# verification code through a phone call rather than a text message. It also
|
|
156
|
-
# allows verification of landline numbers that cannot receive SMS messages.
|
|
162
|
+
# allows verification of landline numbers that cannot receive SMS messages. The
|
|
163
|
+
# 'message' option explicitly requests message delivery (SMS, WhatsApp ...) and
|
|
164
|
+
# skips silent verification, useful for scenarios requiring direct user
|
|
165
|
+
# interaction.
|
|
157
166
|
#
|
|
158
167
|
# @return [Symbol, PreludeSDK::Models::VerificationCreateParams::Options::Method, nil]
|
|
159
168
|
optional :verification_method,
|
|
@@ -186,7 +195,7 @@ module PreludeSDK
|
|
|
186
195
|
# @return [Hash{Symbol=>String}, nil]
|
|
187
196
|
optional :variables, PreludeSDK::Internal::Type::HashOf[String]
|
|
188
197
|
|
|
189
|
-
# @!method initialize(app_realm: nil, callback_url: nil, code_size: nil, custom_code: nil, locale: nil, verification_method: nil, preferred_channel: nil, sender_id: nil, template_id: nil, variables: nil)
|
|
198
|
+
# @!method initialize(app_realm: nil, callback_url: nil, code_size: nil, custom_code: nil, integration: nil, locale: nil, verification_method: nil, preferred_channel: nil, sender_id: nil, template_id: nil, variables: nil)
|
|
190
199
|
# Some parameter documentations has been truncated, see
|
|
191
200
|
# {PreludeSDK::Models::VerificationCreateParams::Options} for more details.
|
|
192
201
|
#
|
|
@@ -200,6 +209,8 @@ module PreludeSDK
|
|
|
200
209
|
#
|
|
201
210
|
# @param custom_code [String] The custom code to use for OTP verification. To use the custom code feature, con
|
|
202
211
|
#
|
|
212
|
+
# @param integration [Symbol, PreludeSDK::Models::VerificationCreateParams::Options::Integration] The integration that triggered the verification.
|
|
213
|
+
#
|
|
203
214
|
# @param locale [String] A BCP-47 formatted locale string with the language the text message will be sent
|
|
204
215
|
#
|
|
205
216
|
# @param verification_method [Symbol, PreludeSDK::Models::VerificationCreateParams::Options::Method] The method used for verifying this phone number. The 'voice' option provides an
|
|
@@ -222,7 +233,9 @@ module PreludeSDK
|
|
|
222
233
|
required :platform, enum: -> { PreludeSDK::VerificationCreateParams::Options::AppRealm::Platform }
|
|
223
234
|
|
|
224
235
|
# @!attribute value
|
|
225
|
-
# The Android SMS Retriever API hash code that identifies your app.
|
|
236
|
+
# The Android SMS Retriever API hash code that identifies your app. For more
|
|
237
|
+
# information, see
|
|
238
|
+
# [Google documentation](https://developers.google.com/identity/sms-retriever/verify#computing_your_apps_hash_string).
|
|
226
239
|
#
|
|
227
240
|
# @return [String]
|
|
228
241
|
required :value, String
|
|
@@ -253,10 +266,26 @@ module PreludeSDK
|
|
|
253
266
|
end
|
|
254
267
|
end
|
|
255
268
|
|
|
269
|
+
# The integration that triggered the verification.
|
|
270
|
+
#
|
|
271
|
+
# @see PreludeSDK::Models::VerificationCreateParams::Options#integration
|
|
272
|
+
module Integration
|
|
273
|
+
extend PreludeSDK::Internal::Type::Enum
|
|
274
|
+
|
|
275
|
+
AUTH0 = :auth0
|
|
276
|
+
SUPABASE = :supabase
|
|
277
|
+
|
|
278
|
+
# @!method self.values
|
|
279
|
+
# @return [Array<Symbol>]
|
|
280
|
+
end
|
|
281
|
+
|
|
256
282
|
# The method used for verifying this phone number. The 'voice' option provides an
|
|
257
283
|
# accessible alternative for visually impaired users by delivering the
|
|
258
284
|
# verification code through a phone call rather than a text message. It also
|
|
259
|
-
# allows verification of landline numbers that cannot receive SMS messages.
|
|
285
|
+
# allows verification of landline numbers that cannot receive SMS messages. The
|
|
286
|
+
# 'message' option explicitly requests message delivery (SMS, WhatsApp ...) and
|
|
287
|
+
# skips silent verification, useful for scenarios requiring direct user
|
|
288
|
+
# interaction.
|
|
260
289
|
#
|
|
261
290
|
# @see PreludeSDK::Models::VerificationCreateParams::Options#verification_method
|
|
262
291
|
module Method
|
|
@@ -264,6 +293,7 @@ module PreludeSDK
|
|
|
264
293
|
|
|
265
294
|
AUTO = :auto
|
|
266
295
|
VOICE = :voice
|
|
296
|
+
MESSAGE = :message
|
|
267
297
|
|
|
268
298
|
# @!method self.values
|
|
269
299
|
# @return [Array<Symbol>]
|
|
@@ -327,6 +357,14 @@ module PreludeSDK
|
|
|
327
357
|
# @return [Boolean, nil]
|
|
328
358
|
optional :is_trusted_user, PreludeSDK::Internal::Type::Boolean
|
|
329
359
|
|
|
360
|
+
# @!attribute ja4_fingerprint
|
|
361
|
+
# The JA4 fingerprint observed for the connection. Prelude will infer it
|
|
362
|
+
# automatically when requests go through our client SDK (which uses Prelude's
|
|
363
|
+
# edge), but you can also provide it explicitly if you terminate TLS yourself.
|
|
364
|
+
#
|
|
365
|
+
# @return [String, nil]
|
|
366
|
+
optional :ja4_fingerprint, String
|
|
367
|
+
|
|
330
368
|
# @!attribute os_version
|
|
331
369
|
# The version of the user's device operating system.
|
|
332
370
|
#
|
|
@@ -341,7 +379,7 @@ module PreludeSDK
|
|
|
341
379
|
# @return [String, nil]
|
|
342
380
|
optional :user_agent, String
|
|
343
381
|
|
|
344
|
-
# @!method initialize(app_version: nil, device_id: nil, device_model: nil, device_platform: nil, ip: nil, is_trusted_user: nil, os_version: nil, user_agent: nil)
|
|
382
|
+
# @!method initialize(app_version: nil, device_id: nil, device_model: nil, device_platform: nil, ip: nil, is_trusted_user: nil, ja4_fingerprint: nil, os_version: nil, user_agent: nil)
|
|
345
383
|
# Some parameter documentations has been truncated, see
|
|
346
384
|
# {PreludeSDK::Models::VerificationCreateParams::Signals} for more details.
|
|
347
385
|
#
|
|
@@ -360,6 +398,8 @@ module PreludeSDK
|
|
|
360
398
|
#
|
|
361
399
|
# @param is_trusted_user [Boolean] This signal should provide a higher level of trust, indicating that the user is
|
|
362
400
|
#
|
|
401
|
+
# @param ja4_fingerprint [String] The JA4 fingerprint observed for the connection. Prelude will infer it automatic
|
|
402
|
+
#
|
|
363
403
|
# @param os_version [String] The version of the user's device operating system.
|
|
364
404
|
#
|
|
365
405
|
# @param user_agent [String] The user agent of the user's device. If the individual fields (os_version, devic
|
|
@@ -41,6 +41,19 @@ module PreludeSDK
|
|
|
41
41
|
# The reason why the verification was blocked. Only present when status is
|
|
42
42
|
# "blocked".
|
|
43
43
|
#
|
|
44
|
+
# - `expired_signature` - The signature of the SDK signals is expired. They should
|
|
45
|
+
# be sent within the hour following their collection.
|
|
46
|
+
# - `in_block_list` - The phone number is part of the configured block list.
|
|
47
|
+
# - `invalid_phone_line` - The phone number is not a valid line number (e.g.
|
|
48
|
+
# landline).
|
|
49
|
+
# - `invalid_phone_number` - The phone number is not a valid phone number (e.g.
|
|
50
|
+
# unallocated range).
|
|
51
|
+
# - `invalid_signature` - The signature of the SDK signals is invalid.
|
|
52
|
+
# - `repeated_attempts` - The phone number has made too many verification
|
|
53
|
+
# attempts.
|
|
54
|
+
# - `suspicious` - The verification attempt was deemed suspicious by the
|
|
55
|
+
# anti-fraud system.
|
|
56
|
+
#
|
|
44
57
|
# @return [Symbol, PreludeSDK::Models::VerificationCreateResponse::Reason, nil]
|
|
45
58
|
optional :reason, enum: -> { PreludeSDK::Models::VerificationCreateResponse::Reason }
|
|
46
59
|
|
|
@@ -141,6 +154,19 @@ module PreludeSDK
|
|
|
141
154
|
# The reason why the verification was blocked. Only present when status is
|
|
142
155
|
# "blocked".
|
|
143
156
|
#
|
|
157
|
+
# - `expired_signature` - The signature of the SDK signals is expired. They should
|
|
158
|
+
# be sent within the hour following their collection.
|
|
159
|
+
# - `in_block_list` - The phone number is part of the configured block list.
|
|
160
|
+
# - `invalid_phone_line` - The phone number is not a valid line number (e.g.
|
|
161
|
+
# landline).
|
|
162
|
+
# - `invalid_phone_number` - The phone number is not a valid phone number (e.g.
|
|
163
|
+
# unallocated range).
|
|
164
|
+
# - `invalid_signature` - The signature of the SDK signals is invalid.
|
|
165
|
+
# - `repeated_attempts` - The phone number has made too many verification
|
|
166
|
+
# attempts.
|
|
167
|
+
# - `suspicious` - The verification attempt was deemed suspicious by the
|
|
168
|
+
# anti-fraud system.
|
|
169
|
+
#
|
|
144
170
|
# @see PreludeSDK::Models::VerificationCreateResponse#reason
|
|
145
171
|
module Reason
|
|
146
172
|
extend PreludeSDK::Internal::Type::Enum
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module PreludeSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see PreludeSDK::Resources::VerificationManagement#delete_phone_number
|
|
6
|
+
class VerificationManagementDeletePhoneNumberParams < PreludeSDK::Internal::Type::BaseModel
|
|
7
|
+
extend PreludeSDK::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include PreludeSDK::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute phone_number
|
|
11
|
+
# An E.164 formatted phone number to remove from the list.
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :phone_number, String
|
|
15
|
+
|
|
16
|
+
# @!method initialize(phone_number:, request_options: {})
|
|
17
|
+
# @param phone_number [String] An E.164 formatted phone number to remove from the list.
|
|
18
|
+
#
|
|
19
|
+
# @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
20
|
+
|
|
21
|
+
module Action
|
|
22
|
+
extend PreludeSDK::Internal::Type::Enum
|
|
23
|
+
|
|
24
|
+
ALLOW = :allow
|
|
25
|
+
BLOCK = :block
|
|
26
|
+
|
|
27
|
+
# @!method self.values
|
|
28
|
+
# @return [Array<Symbol>]
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
end
|
|
32
|
+
end
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module PreludeSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see PreludeSDK::Resources::VerificationManagement#delete_phone_number
|
|
6
|
+
class VerificationManagementDeletePhoneNumberResponse < PreludeSDK::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute phone_number
|
|
8
|
+
# The E.164 formatted phone number that was removed from the list.
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :phone_number, String
|
|
12
|
+
|
|
13
|
+
# @!method initialize(phone_number:)
|
|
14
|
+
# @param phone_number [String] The E.164 formatted phone number that was removed from the list.
|
|
15
|
+
end
|
|
16
|
+
end
|
|
17
|
+
end
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module PreludeSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see PreludeSDK::Resources::VerificationManagement#list_phone_numbers
|
|
6
|
+
class VerificationManagementListPhoneNumbersParams < PreludeSDK::Internal::Type::BaseModel
|
|
7
|
+
extend PreludeSDK::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include PreludeSDK::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!method initialize(request_options: {})
|
|
11
|
+
# @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
12
|
+
|
|
13
|
+
module Action
|
|
14
|
+
extend PreludeSDK::Internal::Type::Enum
|
|
15
|
+
|
|
16
|
+
ALLOW = :allow
|
|
17
|
+
BLOCK = :block
|
|
18
|
+
|
|
19
|
+
# @!method self.values
|
|
20
|
+
# @return [Array<Symbol>]
|
|
21
|
+
end
|
|
22
|
+
end
|
|
23
|
+
end
|
|
24
|
+
end
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module PreludeSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see PreludeSDK::Resources::VerificationManagement#list_phone_numbers
|
|
6
|
+
class VerificationManagementListPhoneNumbersResponse < PreludeSDK::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute phone_numbers
|
|
8
|
+
# A list of phone numbers in the allow or block list.
|
|
9
|
+
#
|
|
10
|
+
# @return [Array<PreludeSDK::Models::VerificationManagementListPhoneNumbersResponse::PhoneNumber>]
|
|
11
|
+
required :phone_numbers,
|
|
12
|
+
-> { PreludeSDK::Internal::Type::ArrayOf[PreludeSDK::Models::VerificationManagementListPhoneNumbersResponse::PhoneNumber] }
|
|
13
|
+
|
|
14
|
+
# @!method initialize(phone_numbers:)
|
|
15
|
+
# @param phone_numbers [Array<PreludeSDK::Models::VerificationManagementListPhoneNumbersResponse::PhoneNumber>] A list of phone numbers in the allow or block list.
|
|
16
|
+
|
|
17
|
+
class PhoneNumber < PreludeSDK::Internal::Type::BaseModel
|
|
18
|
+
# @!attribute created_at
|
|
19
|
+
# The date and time when the phone number was added to the list.
|
|
20
|
+
#
|
|
21
|
+
# @return [Time]
|
|
22
|
+
required :created_at, Time
|
|
23
|
+
|
|
24
|
+
# @!attribute phone_number
|
|
25
|
+
# An E.164 formatted phone number.
|
|
26
|
+
#
|
|
27
|
+
# @return [String]
|
|
28
|
+
required :phone_number, String
|
|
29
|
+
|
|
30
|
+
# @!method initialize(created_at:, phone_number:)
|
|
31
|
+
# @param created_at [Time] The date and time when the phone number was added to the list.
|
|
32
|
+
#
|
|
33
|
+
# @param phone_number [String] An E.164 formatted phone number.
|
|
34
|
+
end
|
|
35
|
+
end
|
|
36
|
+
end
|
|
37
|
+
end
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module PreludeSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see PreludeSDK::Resources::VerificationManagement#list_sender_ids
|
|
6
|
+
class VerificationManagementListSenderIDsParams < PreludeSDK::Internal::Type::BaseModel
|
|
7
|
+
extend PreludeSDK::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include PreludeSDK::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!method initialize(request_options: {})
|
|
11
|
+
# @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
12
|
+
end
|
|
13
|
+
end
|
|
14
|
+
end
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module PreludeSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see PreludeSDK::Resources::VerificationManagement#list_sender_ids
|
|
6
|
+
class VerificationManagementListSenderIDsResponse < PreludeSDK::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute sender_ids
|
|
8
|
+
#
|
|
9
|
+
# @return [Array<PreludeSDK::Models::VerificationManagementListSenderIDsResponse::SenderID>, nil]
|
|
10
|
+
optional :sender_ids,
|
|
11
|
+
-> { PreludeSDK::Internal::Type::ArrayOf[PreludeSDK::Models::VerificationManagementListSenderIDsResponse::SenderID] }
|
|
12
|
+
|
|
13
|
+
# @!method initialize(sender_ids: nil)
|
|
14
|
+
# A list of Sender ID.
|
|
15
|
+
#
|
|
16
|
+
# @param sender_ids [Array<PreludeSDK::Models::VerificationManagementListSenderIDsResponse::SenderID>]
|
|
17
|
+
|
|
18
|
+
class SenderID < PreludeSDK::Internal::Type::BaseModel
|
|
19
|
+
# @!attribute sender_id
|
|
20
|
+
# Value that will be presented as Sender ID
|
|
21
|
+
#
|
|
22
|
+
# @return [String, nil]
|
|
23
|
+
optional :sender_id, String
|
|
24
|
+
|
|
25
|
+
# @!attribute status
|
|
26
|
+
# It indicates the status of the Sender ID. Possible values are:
|
|
27
|
+
#
|
|
28
|
+
# - `approved` - The Sender ID is approved.
|
|
29
|
+
# - `pending` - The Sender ID is pending.
|
|
30
|
+
# - `rejected` - The Sender ID is rejected.
|
|
31
|
+
#
|
|
32
|
+
# @return [Symbol, PreludeSDK::Models::VerificationManagementListSenderIDsResponse::SenderID::Status, nil]
|
|
33
|
+
optional :status,
|
|
34
|
+
enum: -> { PreludeSDK::Models::VerificationManagementListSenderIDsResponse::SenderID::Status }
|
|
35
|
+
|
|
36
|
+
# @!method initialize(sender_id: nil, status: nil)
|
|
37
|
+
# Some parameter documentations has been truncated, see
|
|
38
|
+
# {PreludeSDK::Models::VerificationManagementListSenderIDsResponse::SenderID} for
|
|
39
|
+
# more details.
|
|
40
|
+
#
|
|
41
|
+
# @param sender_id [String] Value that will be presented as Sender ID
|
|
42
|
+
#
|
|
43
|
+
# @param status [Symbol, PreludeSDK::Models::VerificationManagementListSenderIDsResponse::SenderID::Status] It indicates the status of the Sender ID. Possible values are:
|
|
44
|
+
|
|
45
|
+
# It indicates the status of the Sender ID. Possible values are:
|
|
46
|
+
#
|
|
47
|
+
# - `approved` - The Sender ID is approved.
|
|
48
|
+
# - `pending` - The Sender ID is pending.
|
|
49
|
+
# - `rejected` - The Sender ID is rejected.
|
|
50
|
+
#
|
|
51
|
+
# @see PreludeSDK::Models::VerificationManagementListSenderIDsResponse::SenderID#status
|
|
52
|
+
module Status
|
|
53
|
+
extend PreludeSDK::Internal::Type::Enum
|
|
54
|
+
|
|
55
|
+
APPROVED = :approved
|
|
56
|
+
PENDING = :pending
|
|
57
|
+
REJECTED = :rejected
|
|
58
|
+
|
|
59
|
+
# @!method self.values
|
|
60
|
+
# @return [Array<Symbol>]
|
|
61
|
+
end
|
|
62
|
+
end
|
|
63
|
+
end
|
|
64
|
+
end
|
|
65
|
+
end
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module PreludeSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see PreludeSDK::Resources::VerificationManagement#set_phone_number
|
|
6
|
+
class VerificationManagementSetPhoneNumberParams < PreludeSDK::Internal::Type::BaseModel
|
|
7
|
+
extend PreludeSDK::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include PreludeSDK::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute phone_number
|
|
11
|
+
# An E.164 formatted phone number to add to the list.
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :phone_number, String
|
|
15
|
+
|
|
16
|
+
# @!method initialize(phone_number:, request_options: {})
|
|
17
|
+
# @param phone_number [String] An E.164 formatted phone number to add to the list.
|
|
18
|
+
#
|
|
19
|
+
# @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
20
|
+
|
|
21
|
+
module Action
|
|
22
|
+
extend PreludeSDK::Internal::Type::Enum
|
|
23
|
+
|
|
24
|
+
ALLOW = :allow
|
|
25
|
+
BLOCK = :block
|
|
26
|
+
|
|
27
|
+
# @!method self.values
|
|
28
|
+
# @return [Array<Symbol>]
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
end
|
|
32
|
+
end
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module PreludeSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see PreludeSDK::Resources::VerificationManagement#set_phone_number
|
|
6
|
+
class VerificationManagementSetPhoneNumberResponse < PreludeSDK::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute phone_number
|
|
8
|
+
# The E.164 formatted phone number that was added to the list.
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :phone_number, String
|
|
12
|
+
|
|
13
|
+
# @!method initialize(phone_number:)
|
|
14
|
+
# @param phone_number [String] The E.164 formatted phone number that was added to the list.
|
|
15
|
+
end
|
|
16
|
+
end
|
|
17
|
+
end
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module PreludeSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see PreludeSDK::Resources::VerificationManagement#submit_sender_id
|
|
6
|
+
class VerificationManagementSubmitSenderIDParams < PreludeSDK::Internal::Type::BaseModel
|
|
7
|
+
extend PreludeSDK::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include PreludeSDK::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute sender_id
|
|
11
|
+
# The sender ID to add.
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :sender_id, String
|
|
15
|
+
|
|
16
|
+
# @!method initialize(sender_id:, request_options: {})
|
|
17
|
+
# @param sender_id [String] The sender ID to add.
|
|
18
|
+
#
|
|
19
|
+
# @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module PreludeSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see PreludeSDK::Resources::VerificationManagement#submit_sender_id
|
|
6
|
+
class VerificationManagementSubmitSenderIDResponse < PreludeSDK::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute sender_id
|
|
8
|
+
# The sender ID that was added.
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :sender_id, String
|
|
12
|
+
|
|
13
|
+
# @!attribute status
|
|
14
|
+
# It indicates the status of the sender ID. Possible values are:
|
|
15
|
+
#
|
|
16
|
+
# - `approved` - The sender ID is approved.
|
|
17
|
+
# - `pending` - The sender ID is pending.
|
|
18
|
+
# - `rejected` - The sender ID is rejected.
|
|
19
|
+
#
|
|
20
|
+
# @return [Symbol, PreludeSDK::Models::VerificationManagementSubmitSenderIDResponse::Status]
|
|
21
|
+
required :status, enum: -> { PreludeSDK::Models::VerificationManagementSubmitSenderIDResponse::Status }
|
|
22
|
+
|
|
23
|
+
# @!attribute reason
|
|
24
|
+
# The reason why the sender ID was rejected.
|
|
25
|
+
#
|
|
26
|
+
# @return [String, nil]
|
|
27
|
+
optional :reason, String
|
|
28
|
+
|
|
29
|
+
# @!method initialize(sender_id:, status:, reason: nil)
|
|
30
|
+
# Some parameter documentations has been truncated, see
|
|
31
|
+
# {PreludeSDK::Models::VerificationManagementSubmitSenderIDResponse} for more
|
|
32
|
+
# details.
|
|
33
|
+
#
|
|
34
|
+
# @param sender_id [String] The sender ID that was added.
|
|
35
|
+
#
|
|
36
|
+
# @param status [Symbol, PreludeSDK::Models::VerificationManagementSubmitSenderIDResponse::Status] It indicates the status of the sender ID. Possible values are:
|
|
37
|
+
#
|
|
38
|
+
# @param reason [String] The reason why the sender ID was rejected.
|
|
39
|
+
|
|
40
|
+
# It indicates the status of the sender ID. Possible values are:
|
|
41
|
+
#
|
|
42
|
+
# - `approved` - The sender ID is approved.
|
|
43
|
+
# - `pending` - The sender ID is pending.
|
|
44
|
+
# - `rejected` - The sender ID is rejected.
|
|
45
|
+
#
|
|
46
|
+
# @see PreludeSDK::Models::VerificationManagementSubmitSenderIDResponse#status
|
|
47
|
+
module Status
|
|
48
|
+
extend PreludeSDK::Internal::Type::Enum
|
|
49
|
+
|
|
50
|
+
APPROVED = :approved
|
|
51
|
+
PENDING = :pending
|
|
52
|
+
REJECTED = :rejected
|
|
53
|
+
|
|
54
|
+
# @!method self.values
|
|
55
|
+
# @return [Array<Symbol>]
|
|
56
|
+
end
|
|
57
|
+
end
|
|
58
|
+
end
|
|
59
|
+
end
|
|
@@ -137,6 +137,14 @@ module PreludeSDK
|
|
|
137
137
|
# @return [Boolean, nil]
|
|
138
138
|
optional :is_trusted_user, PreludeSDK::Internal::Type::Boolean
|
|
139
139
|
|
|
140
|
+
# @!attribute ja4_fingerprint
|
|
141
|
+
# The JA4 fingerprint observed for the connection. Prelude will infer it
|
|
142
|
+
# automatically when requests go through our client SDK (which uses Prelude's
|
|
143
|
+
# edge), but you can also provide it explicitly if you terminate TLS yourself.
|
|
144
|
+
#
|
|
145
|
+
# @return [String, nil]
|
|
146
|
+
optional :ja4_fingerprint, String
|
|
147
|
+
|
|
140
148
|
# @!attribute os_version
|
|
141
149
|
# The version of the user's device operating system.
|
|
142
150
|
#
|
|
@@ -151,7 +159,7 @@ module PreludeSDK
|
|
|
151
159
|
# @return [String, nil]
|
|
152
160
|
optional :user_agent, String
|
|
153
161
|
|
|
154
|
-
# @!method initialize(app_version: nil, device_id: nil, device_model: nil, device_platform: nil, ip: nil, is_trusted_user: nil, os_version: nil, user_agent: nil)
|
|
162
|
+
# @!method initialize(app_version: nil, device_id: nil, device_model: nil, device_platform: nil, ip: nil, is_trusted_user: nil, ja4_fingerprint: nil, os_version: nil, user_agent: nil)
|
|
155
163
|
# Some parameter documentations has been truncated, see
|
|
156
164
|
# {PreludeSDK::Models::WatchPredictParams::Signals} for more details.
|
|
157
165
|
#
|
|
@@ -170,6 +178,8 @@ module PreludeSDK
|
|
|
170
178
|
#
|
|
171
179
|
# @param is_trusted_user [Boolean] This signal should provide a higher level of trust, indicating that the user is
|
|
172
180
|
#
|
|
181
|
+
# @param ja4_fingerprint [String] The JA4 fingerprint observed for the connection. Prelude will infer it automatic
|
|
182
|
+
#
|
|
173
183
|
# @param os_version [String] The version of the user's device operating system.
|
|
174
184
|
#
|
|
175
185
|
# @param user_agent [String] The user agent of the user's device. If the individual fields (os_version, devic
|
|
@@ -174,6 +174,14 @@ module PreludeSDK
|
|
|
174
174
|
# @return [Boolean, nil]
|
|
175
175
|
optional :is_trusted_user, PreludeSDK::Internal::Type::Boolean
|
|
176
176
|
|
|
177
|
+
# @!attribute ja4_fingerprint
|
|
178
|
+
# The JA4 fingerprint observed for the connection. Prelude will infer it
|
|
179
|
+
# automatically when requests go through our client SDK (which uses Prelude's
|
|
180
|
+
# edge), but you can also provide it explicitly if you terminate TLS yourself.
|
|
181
|
+
#
|
|
182
|
+
# @return [String, nil]
|
|
183
|
+
optional :ja4_fingerprint, String
|
|
184
|
+
|
|
177
185
|
# @!attribute os_version
|
|
178
186
|
# The version of the user's device operating system.
|
|
179
187
|
#
|
|
@@ -188,7 +196,7 @@ module PreludeSDK
|
|
|
188
196
|
# @return [String, nil]
|
|
189
197
|
optional :user_agent, String
|
|
190
198
|
|
|
191
|
-
# @!method initialize(app_version: nil, device_id: nil, device_model: nil, device_platform: nil, ip: nil, is_trusted_user: nil, os_version: nil, user_agent: nil)
|
|
199
|
+
# @!method initialize(app_version: nil, device_id: nil, device_model: nil, device_platform: nil, ip: nil, is_trusted_user: nil, ja4_fingerprint: nil, os_version: nil, user_agent: nil)
|
|
192
200
|
# Some parameter documentations has been truncated, see
|
|
193
201
|
# {PreludeSDK::Models::WatchSendFeedbacksParams::Feedback::Signals} for more
|
|
194
202
|
# details.
|
|
@@ -208,6 +216,8 @@ module PreludeSDK
|
|
|
208
216
|
#
|
|
209
217
|
# @param is_trusted_user [Boolean] This signal should provide a higher level of trust, indicating that the user is
|
|
210
218
|
#
|
|
219
|
+
# @param ja4_fingerprint [String] The JA4 fingerprint observed for the connection. Prelude will infer it automatic
|
|
220
|
+
#
|
|
211
221
|
# @param os_version [String] The version of the user's device operating system.
|
|
212
222
|
#
|
|
213
223
|
# @param user_agent [String] The user agent of the user's device. If the individual fields (os_version, devic
|
data/lib/prelude_sdk/models.rb
CHANGED
|
@@ -47,6 +47,20 @@ module PreludeSDK
|
|
|
47
47
|
|
|
48
48
|
VerificationCreateParams = PreludeSDK::Models::VerificationCreateParams
|
|
49
49
|
|
|
50
|
+
VerificationManagementDeletePhoneNumberParams =
|
|
51
|
+
PreludeSDK::Models::VerificationManagementDeletePhoneNumberParams
|
|
52
|
+
|
|
53
|
+
VerificationManagementListPhoneNumbersParams =
|
|
54
|
+
PreludeSDK::Models::VerificationManagementListPhoneNumbersParams
|
|
55
|
+
|
|
56
|
+
VerificationManagementListSenderIDsParams = PreludeSDK::Models::VerificationManagementListSenderIDsParams
|
|
57
|
+
|
|
58
|
+
VerificationManagementSetPhoneNumberParams =
|
|
59
|
+
PreludeSDK::Models::VerificationManagementSetPhoneNumberParams
|
|
60
|
+
|
|
61
|
+
VerificationManagementSubmitSenderIDParams =
|
|
62
|
+
PreludeSDK::Models::VerificationManagementSubmitSenderIDParams
|
|
63
|
+
|
|
50
64
|
WatchPredictParams = PreludeSDK::Models::WatchPredictParams
|
|
51
65
|
|
|
52
66
|
WatchSendEventsParams = PreludeSDK::Models::WatchSendEventsParams
|
|
@@ -3,12 +3,15 @@
|
|
|
3
3
|
module PreludeSDK
|
|
4
4
|
module Resources
|
|
5
5
|
class Transactional
|
|
6
|
+
# @deprecated
|
|
7
|
+
#
|
|
6
8
|
# Some parameter documentations has been truncated, see
|
|
7
9
|
# {PreludeSDK::Models::TransactionalSendParams} for more details.
|
|
8
10
|
#
|
|
9
|
-
#
|
|
11
|
+
# Legacy route maintained for backward compatibility. Migrate to `/v2/notify`
|
|
12
|
+
# instead.
|
|
10
13
|
#
|
|
11
|
-
# @overload send_(template_id:, to:, callback_url: nil, correlation_id: nil, expires_at: nil, from: nil, locale: nil, variables: nil, request_options: {})
|
|
14
|
+
# @overload send_(template_id:, to:, callback_url: nil, correlation_id: nil, expires_at: nil, from: nil, locale: nil, preferred_channel: nil, variables: nil, request_options: {})
|
|
12
15
|
#
|
|
13
16
|
# @param template_id [String] The template identifier.
|
|
14
17
|
#
|
|
@@ -24,6 +27,8 @@ module PreludeSDK
|
|
|
24
27
|
#
|
|
25
28
|
# @param locale [String] A BCP-47 formatted locale string with the language the text message will be sent
|
|
26
29
|
#
|
|
30
|
+
# @param preferred_channel [Symbol, PreludeSDK::Models::TransactionalSendParams::PreferredChannel] The preferred delivery channel for the message. When specified, the system will
|
|
31
|
+
#
|
|
27
32
|
# @param variables [Hash{Symbol=>String}] The variables to be replaced in the template.
|
|
28
33
|
#
|
|
29
34
|
# @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|