stytch 10.12.0 → 10.14.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: bf56b5f84215fe5c357877d73fcd3b69eb84c10486c5db48b61df77a36e5f933
4
- data.tar.gz: 28e17420434a5ddc840ac9e74b4297dcb1172a3c792348b0e9433ccfd6c2f2a9
3
+ metadata.gz: '09692cd9afc6b9103557dc91a5d3021e6fc5e7b07c0c626a753fc7c6585a4239'
4
+ data.tar.gz: 07f93206b46b79e8c070c96dd2cc1a0222dbf65509c635a995c5c58b7bb96e23
5
5
  SHA512:
6
- metadata.gz: 9a0ccf2a56a4309265418258a142aed473078ad68d20847d02aa5c74b93403c60534d95047b2686b3d13bfa0851897c081bbac51971ddb4dc48ad89ebaf7cbb0
7
- data.tar.gz: 86c9ad1d1d1720dee6690d7c21d46b240a60c803138bfa57e4835de681078dcd31f13afc492543dea0c9879d0ed1c7c7693900aa0d69066062e567e227566fae
6
+ metadata.gz: 3119b2371f1740ab28270e9c712b40f8dd07747130365497666a399594b8d4f1c8d46d48fc4e884210d0a830e76bbb1b5b60e39fc7167bd436f29aa21d772ddd
7
+ data.tar.gz: e69b459e676cd6586a3e53a34c5eccbbac8590c934004a24a5c29daa9ebf3a39200f6b7ee37c63909529814f6fc452b4a82c53ecdd147694706d7ac3f059a9b9
@@ -213,11 +213,17 @@ module StytchB2B
213
213
  # locale::
214
214
  # Used to determine which language to use when sending the user this delivery method. Parameter is a [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`.
215
215
  #
216
- # Currently supported languages are English (`"en"`), Spanish (`"es"`), and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
216
+ # Currently supported languages are English (`"en"`), Spanish (`"es"`), French (`"fr"`) and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
217
217
  #
218
218
  # Request support for additional languages [here](https://docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link")!
219
219
  #
220
220
  # The type of this field is nilable +LoginOrSignupRequestLocale+ (string enum).
221
+ # login_expiration_minutes::
222
+ # The expiration time, in minutes, for a login Email Magic Link. If not authenticated within this time frame, the email will need to be resent. Defaults to 60 (1 hour) with a minimum of 5 and a maximum of 10080 (1 week).
223
+ # The type of this field is nilable +Integer+.
224
+ # signup_expiration_minutes::
225
+ # The expiration time, in minutes, for a signup Email Magic Link. If not authenticated within this time frame, the email will need to be resent. Defaults to 60 (1 hour) with a minimum of 5 and a maximum of 10080 (1 week).
226
+ # The type of this field is nilable +Integer+.
221
227
  #
222
228
  # == Returns:
223
229
  # An object with the following fields:
@@ -247,7 +253,9 @@ module StytchB2B
247
253
  pkce_code_challenge: nil,
248
254
  login_template_id: nil,
249
255
  signup_template_id: nil,
250
- locale: nil
256
+ locale: nil,
257
+ login_expiration_minutes: nil,
258
+ signup_expiration_minutes: nil
251
259
  )
252
260
  headers = {}
253
261
  request = {
@@ -260,6 +268,8 @@ module StytchB2B
260
268
  request[:login_template_id] = login_template_id unless login_template_id.nil?
261
269
  request[:signup_template_id] = signup_template_id unless signup_template_id.nil?
262
270
  request[:locale] = locale unless locale.nil?
271
+ request[:login_expiration_minutes] = login_expiration_minutes unless login_expiration_minutes.nil?
272
+ request[:signup_expiration_minutes] = signup_expiration_minutes unless signup_expiration_minutes.nil?
263
273
 
264
274
  post_request('/v1/b2b/magic_links/email/login_or_signup', request, headers)
265
275
  end
@@ -305,7 +315,7 @@ module StytchB2B
305
315
  # locale::
306
316
  # Used to determine which language to use when sending the user this delivery method. Parameter is a [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`.
307
317
  #
308
- # Currently supported languages are English (`"en"`), Spanish (`"es"`), and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
318
+ # Currently supported languages are English (`"en"`), Spanish (`"es"`), French (`"fr"`) and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
309
319
  #
310
320
  # Request support for additional languages [here](https://docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link")!
311
321
  #
@@ -314,6 +324,9 @@ module StytchB2B
314
324
  # Roles to explicitly assign to this Member. See the [RBAC guide](https://stytch.com/docs/b2b/guides/rbac/role-assignment)
315
325
  # for more information about role assignment.
316
326
  # The type of this field is nilable list of +String+.
327
+ # invite_expiration_minutes::
328
+ # The expiration time, in minutes, for an invite email. If not accepted within this time frame, the invite will need to be resent. Defaults to 10080 (1 week) with a minimum of 5 and a maximum of 10080.
329
+ # The type of this field is nilable +Integer+.
317
330
  #
318
331
  # == Returns:
319
332
  # An object with the following fields:
@@ -346,6 +359,7 @@ module StytchB2B
346
359
  invite_template_id: nil,
347
360
  locale: nil,
348
361
  roles: nil,
362
+ invite_expiration_minutes: nil,
349
363
  method_options: nil
350
364
  )
351
365
  headers = {}
@@ -362,6 +376,7 @@ module StytchB2B
362
376
  request[:invite_template_id] = invite_template_id unless invite_template_id.nil?
363
377
  request[:locale] = locale unless locale.nil?
364
378
  request[:roles] = roles unless roles.nil?
379
+ request[:invite_expiration_minutes] = invite_expiration_minutes unless invite_expiration_minutes.nil?
365
380
 
366
381
  post_request('/v1/b2b/magic_links/email/invite', request, headers)
367
382
  end
@@ -394,11 +409,14 @@ module StytchB2B
394
409
  # locale::
395
410
  # Used to determine which language to use when sending the user this delivery method. Parameter is a [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`.
396
411
  #
397
- # Currently supported languages are English (`"en"`), Spanish (`"es"`), and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
412
+ # Currently supported languages are English (`"en"`), Spanish (`"es"`), French (`"fr"`) and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
398
413
  #
399
414
  # Request support for additional languages [here](https://docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link")!
400
415
  #
401
416
  # The type of this field is nilable +SendRequestLocale+ (string enum).
417
+ # discovery_expiration_minutes::
418
+ # The expiration time, in minutes, for an discovery magic link email. If not accepted within this time frame, the email will need to be resent. Defaults to 60 (1 hour) with a minimum of 5 and a maximum of 10080 (1 week).
419
+ # The type of this field is nilable +Integer+.
402
420
  #
403
421
  # == Returns:
404
422
  # An object with the following fields:
@@ -413,7 +431,8 @@ module StytchB2B
413
431
  discovery_redirect_url: nil,
414
432
  pkce_code_challenge: nil,
415
433
  login_template_id: nil,
416
- locale: nil
434
+ locale: nil,
435
+ discovery_expiration_minutes: nil
417
436
  )
418
437
  headers = {}
419
438
  request = {
@@ -423,6 +442,7 @@ module StytchB2B
423
442
  request[:pkce_code_challenge] = pkce_code_challenge unless pkce_code_challenge.nil?
424
443
  request[:login_template_id] = login_template_id unless login_template_id.nil?
425
444
  request[:locale] = locale unless locale.nil?
445
+ request[:discovery_expiration_minutes] = discovery_expiration_minutes unless discovery_expiration_minutes.nil?
426
446
 
427
447
  post_request('/v1/b2b/magic_links/email/discovery/send', request, headers)
428
448
  end
@@ -222,6 +222,9 @@ module StytchB2B
222
222
  # provider_tenant_ids::
223
223
  # All tenant IDs returned by the OAuth provider. These is typically used to identify organizations or groups within the provider's domain. For example, in HubSpot this is a Hub ID, in Slack this is the Workspace ID, and in GitHub this is an organization ID. Some OAuth providers do not return tenant IDs, some providers are guaranteed to return one, and some may return multiple. This field will always be populated if at least one tenant ID was returned from the OAuth provider and developers should prefer this field over `provider_tenant_id`.
224
224
  # The type of this field is list of +String+.
225
+ # full_name::
226
+ # The full name of the authenticated end user, if available.
227
+ # The type of this field is +String+.
225
228
  # status_code::
226
229
  # The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.
227
230
  # The type of this field is +Integer+.
@@ -793,7 +793,7 @@ module StytchB2B
793
793
  # If this field is provided and a session header is passed into the request, the Member Session must have permission to perform the `update.info.email` action on the `stytch.member` Resource. Members cannot update their own email address.
794
794
  # The type of this field is nilable +String+.
795
795
  # external_id::
796
- # An identifier that can be used in API calls wherever a member_id is expected. This is a string consisting of alphanumeric, `.`, `_`, or `-` characters with a maximum length of 128 characters. External IDs must be unique within an organization, but may be reused across different organizations in the same project.
796
+ # An identifier that can be used in API calls wherever a member_id is expected. This is a string consisting of alphanumeric, `.`, `_`, `-`, or `|` characters with a maximum length of 128 characters. External IDs must be unique within an organization, but may be reused across different organizations in the same project.
797
797
  # The type of this field is nilable +String+.
798
798
  #
799
799
  # == Returns:
@@ -1295,6 +1295,9 @@ module StytchB2B
1295
1295
  # Roles to explicitly assign to this Member. See the [RBAC guide](https://stytch.com/docs/b2b/guides/rbac/role-assignment)
1296
1296
  # for more information about role assignment.
1297
1297
  # The type of this field is nilable list of +String+.
1298
+ # external_id::
1299
+ # An identifier that can be used in API calls wherever a member_id is expected. This is a string consisting of alphanumeric, `.`, `_`, `-`, or `|` characters with a maximum length of 128 characters. External IDs must be unique within an organization, but may be reused across different organizations in the same project.
1300
+ # The type of this field is nilable +String+.
1298
1301
  #
1299
1302
  # == Returns:
1300
1303
  # An object with the following fields:
@@ -1327,6 +1330,7 @@ module StytchB2B
1327
1330
  mfa_phone_number: nil,
1328
1331
  mfa_enrolled: nil,
1329
1332
  roles: nil,
1333
+ external_id: nil,
1330
1334
  method_options: nil
1331
1335
  )
1332
1336
  headers = {}
@@ -1342,6 +1346,7 @@ module StytchB2B
1342
1346
  request[:mfa_phone_number] = mfa_phone_number unless mfa_phone_number.nil?
1343
1347
  request[:mfa_enrolled] = mfa_enrolled unless mfa_enrolled.nil?
1344
1348
  request[:roles] = roles unless roles.nil?
1349
+ request[:external_id] = external_id unless external_id.nil?
1345
1350
 
1346
1351
  post_request("/v1/b2b/organizations/#{organization_id}/members", request, headers)
1347
1352
  end
@@ -60,7 +60,7 @@ module StytchB2B
60
60
  # locale::
61
61
  # Used to determine which language to use when sending the user this delivery method. Parameter is a [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`.
62
62
  #
63
- # Currently supported languages are English (`"en"`), Spanish (`"es"`), and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
63
+ # Currently supported languages are English (`"en"`), Spanish (`"es"`), French (`"fr"`) and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
64
64
  #
65
65
  # Request support for additional languages [here](https://docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link")!
66
66
  #
@@ -269,11 +269,17 @@ module StytchB2B
269
269
  # locale::
270
270
  # Used to determine which language to use when sending the user this delivery method. Parameter is a [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`.
271
271
  #
272
- # Currently supported languages are English (`"en"`), Spanish (`"es"`), and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
272
+ # Currently supported languages are English (`"en"`), Spanish (`"es"`), French (`"fr"`) and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
273
273
  #
274
274
  # Request support for additional languages [here](https://docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link")!
275
275
  #
276
276
  # The type of this field is nilable +LoginOrSignupRequestLocale+ (string enum).
277
+ # login_expiration_minutes::
278
+ # The expiration time, in minutes, for a login OTP email to a Member. If not authenticated within this time frame, the OTP will need to be resent. Defaults to 10 with a minimum of 2 and a maximum of 15.
279
+ # The type of this field is nilable +Integer+.
280
+ # signup_expiration_minutes::
281
+ # The expiration time, in minutes, for a signup OTP email to a Member. If not authenticated within this time frame, the OTP will need to be resent. Defaults to 10 with a minimum of 2 and a maximum of 15.
282
+ # The type of this field is nilable +Integer+.
277
283
  #
278
284
  # == Returns:
279
285
  # An object with the following fields:
@@ -300,7 +306,9 @@ module StytchB2B
300
306
  email_address:,
301
307
  login_template_id: nil,
302
308
  signup_template_id: nil,
303
- locale: nil
309
+ locale: nil,
310
+ login_expiration_minutes: nil,
311
+ signup_expiration_minutes: nil
304
312
  )
305
313
  headers = {}
306
314
  request = {
@@ -310,6 +318,8 @@ module StytchB2B
310
318
  request[:login_template_id] = login_template_id unless login_template_id.nil?
311
319
  request[:signup_template_id] = signup_template_id unless signup_template_id.nil?
312
320
  request[:locale] = locale unless locale.nil?
321
+ request[:login_expiration_minutes] = login_expiration_minutes unless login_expiration_minutes.nil?
322
+ request[:signup_expiration_minutes] = signup_expiration_minutes unless signup_expiration_minutes.nil?
313
323
 
314
324
  post_request('/v1/b2b/otps/email/login_or_signup', request, headers)
315
325
  end
@@ -366,7 +376,7 @@ module StytchB2B
366
376
  # locale::
367
377
  # Used to determine which language to use when sending the user this delivery method. Parameter is a [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`.
368
378
  #
369
- # Currently supported languages are English (`"en"`), Spanish (`"es"`), and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
379
+ # Currently supported languages are English (`"en"`), Spanish (`"es"`), French (`"fr"`) and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
370
380
  #
371
381
  # Request support for additional languages [here](https://docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link")!
372
382
  #
@@ -459,11 +469,14 @@ module StytchB2B
459
469
  # locale::
460
470
  # Used to determine which language to use when sending the user this delivery method. Parameter is a [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`.
461
471
  #
462
- # Currently supported languages are English (`"en"`), Spanish (`"es"`), and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
472
+ # Currently supported languages are English (`"en"`), Spanish (`"es"`), French (`"fr"`) and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
463
473
  #
464
474
  # Request support for additional languages [here](https://docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link")!
465
475
  #
466
476
  # The type of this field is nilable +SendRequestLocale+ (string enum).
477
+ # discovery_expiration_minutes::
478
+ # The expiration time, in minutes, for a discovery OTP email. If not accepted within this time frame, the OTP will need to be resent. Defaults to 10 with a minimum of 2 and a maximum of 15.
479
+ # The type of this field is nilable +Integer+.
467
480
  #
468
481
  # == Returns:
469
482
  # An object with the following fields:
@@ -476,7 +489,8 @@ module StytchB2B
476
489
  def send(
477
490
  email_address:,
478
491
  login_template_id: nil,
479
- locale: nil
492
+ locale: nil,
493
+ discovery_expiration_minutes: nil
480
494
  )
481
495
  headers = {}
482
496
  request = {
@@ -484,6 +498,7 @@ module StytchB2B
484
498
  }
485
499
  request[:login_template_id] = login_template_id unless login_template_id.nil?
486
500
  request[:locale] = locale unless locale.nil?
501
+ request[:discovery_expiration_minutes] = discovery_expiration_minutes unless discovery_expiration_minutes.nil?
487
502
 
488
503
  post_request('/v1/b2b/otps/email/discovery/send', request, headers)
489
504
  end
@@ -152,6 +152,9 @@ module StytchB2B
152
152
  # set_phone_number_verified::
153
153
  # (no documentation yet)
154
154
  # The type of this field is nilable +Boolean+.
155
+ # external_id::
156
+ # If a new member is created, this will set an identifier that can be used in API calls wherever a member_id is expected. This is a string consisting of alphanumeric, `.`, `_`, `-`, or `|` characters with a maximum length of 128 characters. External IDs must be unique within an organization, but may be reused across different organizations in the same project. Note that if a member already exists, this field will be ignored.
157
+ # The type of this field is nilable +String+.
155
158
  #
156
159
  # == Returns:
157
160
  # An object with the following fields:
@@ -189,7 +192,8 @@ module StytchB2B
189
192
  roles: nil,
190
193
  preserve_existing_sessions: nil,
191
194
  mfa_phone_number: nil,
192
- set_phone_number_verified: nil
195
+ set_phone_number_verified: nil,
196
+ external_id: nil
193
197
  )
194
198
  headers = {}
195
199
  request = {
@@ -210,6 +214,7 @@ module StytchB2B
210
214
  request[:preserve_existing_sessions] = preserve_existing_sessions unless preserve_existing_sessions.nil?
211
215
  request[:mfa_phone_number] = mfa_phone_number unless mfa_phone_number.nil?
212
216
  request[:set_phone_number_verified] = set_phone_number_verified unless set_phone_number_verified.nil?
217
+ request[:external_id] = external_id unless external_id.nil?
213
218
 
214
219
  post_request('/v1/b2b/passwords/migrate', request, headers)
215
220
  end
@@ -398,16 +403,17 @@ module StytchB2B
398
403
  # locale::
399
404
  # Used to determine which language to use when sending the user this delivery method. Parameter is a [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`.
400
405
  #
401
- # Currently supported languages are English (`"en"`), Spanish (`"es"`), and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
406
+ # Currently supported languages are English (`"en"`), Spanish (`"es"`), French (`"fr"`) and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
402
407
  #
403
408
  # Request support for additional languages [here](https://docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link")!
404
409
  #
405
410
  # The type of this field is nilable +ResetStartRequestLocale+ (string enum).
406
411
  # reset_password_template_id::
407
- # Use a custom template for reset password emails. By default, it will use your default email template. The template must be a template using our built-in customizations or a custom HTML email for Magic Links - Reset Password.
412
+ # Use a custom template for reset password emails. By default, it will use your default email template. The template must be a template using our built-in customizations or a custom HTML email for Passwords - Reset Password.
408
413
  # The type of this field is nilable +String+.
409
414
  # verify_email_template_id::
410
- # (no documentation yet)
415
+ # Use a custom template for verification emails sent during password reset flows. This template will be used the first time a user sets a password via a
416
+ # password reset flow. By default, it will use your default email template. The template must be a template using our built-in customizations or a custom HTML email for Passwords - Email Verification.
411
417
  # The type of this field is nilable +String+.
412
418
  #
413
419
  # == Returns:
@@ -679,7 +685,7 @@ module StytchB2B
679
685
  # locale::
680
686
  # Used to determine which language to use when sending the user this delivery method. Parameter is a [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`.
681
687
  #
682
- # Currently supported languages are English (`"en"`), Spanish (`"es"`), and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
688
+ # Currently supported languages are English (`"en"`), Spanish (`"es"`), French (`"fr"`) and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
683
689
  #
684
690
  # Request support for additional languages [here](https://docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link")!
685
691
  #
@@ -973,7 +979,7 @@ module StytchB2B
973
979
  # discovery redirect URL that you set in your Dashboard is used. If you have not set a default discovery redirect URL, an error is returned.
974
980
  # The type of this field is nilable +String+.
975
981
  # reset_password_template_id::
976
- # Use a custom template for reset password emails. By default, it will use your default email template. The template must be a template using our built-in customizations or a custom HTML email for Magic Links - Reset Password.
982
+ # Use a custom template for reset password emails. By default, it will use your default email template. The template must be a template using our built-in customizations or a custom HTML email for Passwords - Reset Password.
977
983
  # The type of this field is nilable +String+.
978
984
  # reset_password_expiration_minutes::
979
985
  # Sets a time limit after which the email link to reset the member's password will no longer be valid.
@@ -984,13 +990,14 @@ module StytchB2B
984
990
  # locale::
985
991
  # Used to determine which language to use when sending the user this delivery method. Parameter is a [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`.
986
992
  #
987
- # Currently supported languages are English (`"en"`), Spanish (`"es"`), and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
993
+ # Currently supported languages are English (`"en"`), Spanish (`"es"`), French (`"fr"`) and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
988
994
  #
989
995
  # Request support for additional languages [here](https://docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link")!
990
996
  #
991
997
  # The type of this field is nilable +String+.
992
998
  # verify_email_template_id::
993
- # (no documentation yet)
999
+ # Use a custom template for verification emails sent during password reset flows. This template will be used the first time a user sets a password via a
1000
+ # password reset flow. By default, it will use your default email template. The template must be a template using our built-in customizations or a custom HTML email for Passwords - Email Verification.
994
1001
  # The type of this field is nilable +String+.
995
1002
  #
996
1003
  # == Returns:
@@ -217,7 +217,7 @@ module Stytch
217
217
  # locale::
218
218
  # Used to determine which language to use when sending the user this delivery method. Parameter is a [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`.
219
219
  #
220
- # Currently supported languages are English (`"en"`), Spanish (`"es"`), and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
220
+ # Currently supported languages are English (`"en"`), Spanish (`"es"`), French (`"fr"`) and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
221
221
  #
222
222
  # Request support for additional languages [here](https://docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link")!
223
223
  #
@@ -318,7 +318,7 @@ module Stytch
318
318
  # locale::
319
319
  # Used to determine which language to use when sending the user this delivery method. Parameter is a [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`.
320
320
  #
321
- # Currently supported languages are English (`"en"`), Spanish (`"es"`), and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
321
+ # Currently supported languages are English (`"en"`), Spanish (`"es"`), French (`"fr"`) and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
322
322
  #
323
323
  # Request support for additional languages [here](https://docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link")!
324
324
  #
@@ -399,7 +399,7 @@ module Stytch
399
399
  # locale::
400
400
  # Used to determine which language to use when sending the user this delivery method. Parameter is a [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`.
401
401
  #
402
- # Currently supported languages are English (`"en"`), Spanish (`"es"`), and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
402
+ # Currently supported languages are English (`"en"`), Spanish (`"es"`), French (`"fr"`) and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
403
403
  #
404
404
  # Request support for additional languages [here](https://docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link")!
405
405
  #
data/lib/stytch/otps.rb CHANGED
@@ -155,7 +155,7 @@ module Stytch
155
155
  # locale::
156
156
  # Used to determine which language to use when sending the user this delivery method. Parameter is a [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`.
157
157
  #
158
- # Currently supported languages are English (`"en"`), Spanish (`"es"`), and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
158
+ # Currently supported languages are English (`"en"`), Spanish (`"es"`), French (`"fr"`) and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
159
159
  #
160
160
  # Request support for additional languages [here](https://docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link")!
161
161
  #
@@ -240,7 +240,7 @@ module Stytch
240
240
  # locale::
241
241
  # Used to determine which language to use when sending the user this delivery method. Parameter is a [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`.
242
242
  #
243
- # Currently supported languages are English (`"en"`), Spanish (`"es"`), and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
243
+ # Currently supported languages are English (`"en"`), Spanish (`"es"`), French (`"fr"`) and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
244
244
  #
245
245
  # Request support for additional languages [here](https://docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link")!
246
246
  #
@@ -318,7 +318,7 @@ module Stytch
318
318
  # locale::
319
319
  # Used to determine which language to use when sending the user this delivery method. Parameter is a [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`.
320
320
  #
321
- # Currently supported languages are English (`"en"`), Spanish (`"es"`), and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
321
+ # Currently supported languages are English (`"en"`), Spanish (`"es"`), French (`"fr"`) and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
322
322
  #
323
323
  # Request support for additional languages [here](https://docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link")!
324
324
  #
@@ -399,7 +399,7 @@ module Stytch
399
399
  # locale::
400
400
  # Used to determine which language to use when sending the user this delivery method. Parameter is a [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`.
401
401
  #
402
- # Currently supported languages are English (`"en"`), Spanish (`"es"`), and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
402
+ # Currently supported languages are English (`"en"`), Spanish (`"es"`), French (`"fr"`) and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
403
403
  #
404
404
  # Request support for additional languages [here](https://docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link")!
405
405
  #
@@ -470,7 +470,7 @@ module Stytch
470
470
  # locale::
471
471
  # Used to determine which language to use when sending the user this delivery method. Parameter is a [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`.
472
472
  #
473
- # Currently supported languages are English (`"en"`), Spanish (`"es"`), and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
473
+ # Currently supported languages are English (`"en"`), Spanish (`"es"`), French (`"fr"`) and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
474
474
  #
475
475
  # Request support for additional languages [here](https://docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link")!
476
476
  #
@@ -558,7 +558,7 @@ module Stytch
558
558
  # locale::
559
559
  # Used to determine which language to use when sending the user this delivery method. Parameter is a [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`.
560
560
  #
561
- # Currently supported languages are English (`"en"`), Spanish (`"es"`), and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
561
+ # Currently supported languages are English (`"en"`), Spanish (`"es"`), French (`"fr"`) and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
562
562
  #
563
563
  # Request support for additional languages [here](https://docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link")!
564
564
  #
@@ -307,6 +307,9 @@ module Stytch
307
307
  # Whether to set the user's phone number as verified. This is a dangerous field. This flag should only be set if you can attest that
308
308
  # the user owns the phone number in question. Access to this field is restricted. To enable it, please send us a note at support@stytch.com.
309
309
  # The type of this field is nilable +Boolean+.
310
+ # external_id::
311
+ # If a new user is created, this will set an identifier that can be used in API calls wherever a user_id is expected. This is a string consisting of alphanumeric, `.`, `_`, `-`, or `|` characters with a maximum length of 128 characters. External IDs must be unique within an organization, but may be reused across different organizations in the same project. Note that if a user already exists, this field will be ignored.
312
+ # The type of this field is nilable +String+.
310
313
  #
311
314
  # == Returns:
312
315
  # An object with the following fields:
@@ -342,7 +345,8 @@ module Stytch
342
345
  set_email_verified: nil,
343
346
  name: nil,
344
347
  phone_number: nil,
345
- set_phone_number_verified: nil
348
+ set_phone_number_verified: nil,
349
+ external_id: nil
346
350
  )
347
351
  headers = {}
348
352
  request = {
@@ -361,6 +365,7 @@ module Stytch
361
365
  request[:name] = name unless name.nil?
362
366
  request[:phone_number] = phone_number unless phone_number.nil?
363
367
  request[:set_phone_number_verified] = set_phone_number_verified unless set_phone_number_verified.nil?
368
+ request[:external_id] = external_id unless external_id.nil?
364
369
 
365
370
  post_request('/v1/passwords/migrate', request, headers)
366
371
  end
@@ -403,7 +408,7 @@ module Stytch
403
408
  # locale::
404
409
  # Used to determine which language to use when sending the user this delivery method. Parameter is a [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`.
405
410
  #
406
- # Currently supported languages are English (`"en"`), Spanish (`"es"`), and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
411
+ # Currently supported languages are English (`"en"`), Spanish (`"es"`), French (`"fr"`) and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
407
412
  #
408
413
  # Request support for additional languages [here](https://docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link")!
409
414
  #
data/lib/stytch/users.rb CHANGED
@@ -44,6 +44,9 @@ module Stytch
44
44
  # untrusted_metadata::
45
45
  # The `untrusted_metadata` field contains an arbitrary JSON object of application-specific data. Untrusted metadata can be edited by end users directly via the SDK, and **cannot be used to store critical information.** See the [Metadata](https://stytch.com/docs/api/metadata) reference for complete field behavior details.
46
46
  # The type of this field is nilable +object+.
47
+ # external_id::
48
+ # An identifier that can be used in API calls wherever a user_id is expected. This is a string consisting of alphanumeric, `.`, `_`, `-`, or `|` characters with a maximum length of 128 characters. External IDs must be unique within an organization, but may be reused across different organizations in the same project.
49
+ # The type of this field is nilable +String+.
47
50
  #
48
51
  # == Returns:
49
52
  # An object with the following fields:
@@ -75,7 +78,8 @@ module Stytch
75
78
  phone_number: nil,
76
79
  create_user_as_pending: nil,
77
80
  trusted_metadata: nil,
78
- untrusted_metadata: nil
81
+ untrusted_metadata: nil,
82
+ external_id: nil
79
83
  )
80
84
  headers = {}
81
85
  request = {}
@@ -86,6 +90,7 @@ module Stytch
86
90
  request[:create_user_as_pending] = create_user_as_pending unless create_user_as_pending.nil?
87
91
  request[:trusted_metadata] = trusted_metadata unless trusted_metadata.nil?
88
92
  request[:untrusted_metadata] = untrusted_metadata unless untrusted_metadata.nil?
93
+ request[:external_id] = external_id unless external_id.nil?
89
94
 
90
95
  post_request('/v1/users', request, headers)
91
96
  end
@@ -229,7 +234,7 @@ module Stytch
229
234
  # The `untrusted_metadata` field contains an arbitrary JSON object of application-specific data. Untrusted metadata can be edited by end users directly via the SDK, and **cannot be used to store critical information.** See the [Metadata](https://stytch.com/docs/api/metadata) reference for complete field behavior details.
230
235
  # The type of this field is nilable +object+.
231
236
  # external_id::
232
- # An identifier that can be used in API calls wherever a user_id is expected. This is a string consisting of alphanumeric, `.`, `_`, or `-` characters with a maximum length of 128 characters. External IDs must be unique within an organization, but may be reused across different organizations in the same project.
237
+ # An identifier that can be used in API calls wherever a user_id is expected. This is a string consisting of alphanumeric, `.`, `_`, `-`, or `|` characters with a maximum length of 128 characters. External IDs must be unique within an organization, but may be reused across different organizations in the same project.
233
238
  # The type of this field is nilable +String+.
234
239
  #
235
240
  # == Returns:
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Stytch
4
- VERSION = '10.12.0'
4
+ VERSION = '10.14.0'
5
5
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: stytch
3
3
  version: !ruby/object:Gem::Version
4
- version: 10.12.0
4
+ version: 10.14.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - stytch
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2025-04-02 00:00:00.000000000 Z
11
+ date: 2025-04-14 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday