@knowledge-stack/ksapi 1.87.1 → 1.88.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (92) hide show
  1. package/.openapi-generator/FILES +18 -0
  2. package/README.md +16 -2
  3. package/dist/apis/AuthApi.d.ts +218 -13
  4. package/dist/apis/AuthApi.js +224 -6
  5. package/dist/esm/apis/AuthApi.d.ts +218 -13
  6. package/dist/esm/apis/AuthApi.js +225 -7
  7. package/dist/esm/models/ChangePhoneNumberRequest.d.ts +53 -0
  8. package/dist/esm/models/ChangePhoneNumberRequest.js +48 -0
  9. package/dist/esm/models/CreatePhonePasswordUserRequest.d.ts +71 -0
  10. package/dist/esm/models/CreatePhonePasswordUserRequest.js +60 -0
  11. package/dist/esm/models/FeaturesResponse.d.ts +6 -0
  12. package/dist/esm/models/FeaturesResponse.js +4 -0
  13. package/dist/esm/models/PasswordResetTokenResponse.d.ts +47 -0
  14. package/dist/esm/models/PasswordResetTokenResponse.js +44 -0
  15. package/dist/esm/models/PasswordResetWithTokenRequest.d.ts +2 -2
  16. package/dist/esm/models/PasswordResetWithTokenRequest.js +3 -3
  17. package/dist/esm/models/PhoneValidationResponse.d.ts +47 -0
  18. package/dist/esm/models/PhoneValidationResponse.js +44 -0
  19. package/dist/esm/models/PhoneVerificationRequest.d.ts +47 -0
  20. package/dist/esm/models/PhoneVerificationRequest.js +44 -0
  21. package/dist/esm/models/RequestPhoneChangeRequest.d.ts +47 -0
  22. package/dist/esm/models/RequestPhoneChangeRequest.js +44 -0
  23. package/dist/esm/models/ResponseSendPwResetEmail.d.ts +53 -0
  24. package/dist/esm/models/ResponseSendPwResetEmail.js +48 -0
  25. package/dist/esm/models/SendPasswordResetRequest.d.ts +67 -0
  26. package/dist/esm/models/SendPasswordResetRequest.js +53 -0
  27. package/dist/esm/models/SignInRequest.d.ts +3 -3
  28. package/dist/esm/models/SignInRequest.js +3 -3
  29. package/dist/esm/models/UserResponse.d.ts +6 -0
  30. package/dist/esm/models/UserResponse.js +2 -0
  31. package/dist/esm/models/ValidateResetCodeRequest.d.ts +53 -0
  32. package/dist/esm/models/ValidateResetCodeRequest.js +48 -0
  33. package/dist/esm/models/index.d.ts +9 -0
  34. package/dist/esm/models/index.js +9 -0
  35. package/dist/models/ChangePhoneNumberRequest.d.ts +53 -0
  36. package/dist/models/ChangePhoneNumberRequest.js +56 -0
  37. package/dist/models/CreatePhonePasswordUserRequest.d.ts +71 -0
  38. package/dist/models/CreatePhonePasswordUserRequest.js +68 -0
  39. package/dist/models/FeaturesResponse.d.ts +6 -0
  40. package/dist/models/FeaturesResponse.js +4 -0
  41. package/dist/models/PasswordResetTokenResponse.d.ts +47 -0
  42. package/dist/models/PasswordResetTokenResponse.js +52 -0
  43. package/dist/models/PasswordResetWithTokenRequest.d.ts +2 -2
  44. package/dist/models/PasswordResetWithTokenRequest.js +3 -3
  45. package/dist/models/PhoneValidationResponse.d.ts +47 -0
  46. package/dist/models/PhoneValidationResponse.js +52 -0
  47. package/dist/models/PhoneVerificationRequest.d.ts +47 -0
  48. package/dist/models/PhoneVerificationRequest.js +52 -0
  49. package/dist/models/RequestPhoneChangeRequest.d.ts +47 -0
  50. package/dist/models/RequestPhoneChangeRequest.js +52 -0
  51. package/dist/models/ResponseSendPwResetEmail.d.ts +53 -0
  52. package/dist/models/ResponseSendPwResetEmail.js +56 -0
  53. package/dist/models/SendPasswordResetRequest.d.ts +67 -0
  54. package/dist/models/SendPasswordResetRequest.js +61 -0
  55. package/dist/models/SignInRequest.d.ts +3 -3
  56. package/dist/models/SignInRequest.js +3 -3
  57. package/dist/models/UserResponse.d.ts +6 -0
  58. package/dist/models/UserResponse.js +2 -0
  59. package/dist/models/ValidateResetCodeRequest.d.ts +53 -0
  60. package/dist/models/ValidateResetCodeRequest.js +56 -0
  61. package/dist/models/index.d.ts +9 -0
  62. package/dist/models/index.js +9 -0
  63. package/docs/AuthApi.md +365 -6
  64. package/docs/ChangePhoneNumberRequest.md +37 -0
  65. package/docs/CreatePhonePasswordUserRequest.md +43 -0
  66. package/docs/FeaturesResponse.md +2 -0
  67. package/docs/PasswordResetTokenResponse.md +34 -0
  68. package/docs/PasswordResetWithTokenRequest.md +2 -2
  69. package/docs/PhoneValidationResponse.md +34 -0
  70. package/docs/PhoneVerificationRequest.md +34 -0
  71. package/docs/RequestPhoneChangeRequest.md +34 -0
  72. package/docs/ResponseSendPwResetEmail.md +36 -0
  73. package/docs/SendPasswordResetRequest.md +38 -0
  74. package/docs/SignInRequest.md +3 -2
  75. package/docs/UserResponse.md +2 -0
  76. package/docs/ValidateResetCodeRequest.md +36 -0
  77. package/package.json +1 -1
  78. package/src/apis/AuthApi.ts +452 -17
  79. package/src/models/ChangePhoneNumberRequest.ts +92 -0
  80. package/src/models/CreatePhonePasswordUserRequest.ts +120 -0
  81. package/src/models/FeaturesResponse.ts +9 -0
  82. package/src/models/PasswordResetTokenResponse.ts +83 -0
  83. package/src/models/PasswordResetWithTokenRequest.ts +5 -5
  84. package/src/models/PhoneValidationResponse.ts +83 -0
  85. package/src/models/PhoneVerificationRequest.ts +83 -0
  86. package/src/models/RequestPhoneChangeRequest.ts +83 -0
  87. package/src/models/ResponseSendPwResetEmail.ts +107 -0
  88. package/src/models/SendPasswordResetRequest.ts +109 -0
  89. package/src/models/SignInRequest.ts +6 -6
  90. package/src/models/UserResponse.ts +8 -0
  91. package/src/models/ValidateResetCodeRequest.ts +92 -0
  92. package/src/models/index.ts +9 -0
@@ -15,21 +15,34 @@
15
15
 
16
16
  import * as runtime from '../runtime';
17
17
  import type {
18
+ ChangePhoneNumberRequest,
18
19
  CreatePasswordUserRequest,
20
+ CreatePhonePasswordUserRequest,
19
21
  DirectorySyncResponse,
20
22
  EmailSentResponse,
21
23
  EmailVerificationRequest,
22
24
  HTTPValidationError,
23
25
  IdpType,
24
26
  PasswordResetRequest,
27
+ PasswordResetTokenResponse,
25
28
  PasswordResetWithTokenRequest,
29
+ PhoneValidationResponse,
30
+ PhoneVerificationRequest,
31
+ RequestPhoneChangeRequest,
32
+ ResponseSendPwResetEmail,
26
33
  SSOInitiateResponse,
34
+ SendPasswordResetRequest,
27
35
  SignInRequest,
28
36
  UserResponse,
37
+ ValidateResetCodeRequest,
29
38
  } from '../models/index';
30
39
  import {
40
+ ChangePhoneNumberRequestFromJSON,
41
+ ChangePhoneNumberRequestToJSON,
31
42
  CreatePasswordUserRequestFromJSON,
32
43
  CreatePasswordUserRequestToJSON,
44
+ CreatePhonePasswordUserRequestFromJSON,
45
+ CreatePhonePasswordUserRequestToJSON,
33
46
  DirectorySyncResponseFromJSON,
34
47
  DirectorySyncResponseToJSON,
35
48
  EmailSentResponseFromJSON,
@@ -42,20 +55,44 @@ import {
42
55
  IdpTypeToJSON,
43
56
  PasswordResetRequestFromJSON,
44
57
  PasswordResetRequestToJSON,
58
+ PasswordResetTokenResponseFromJSON,
59
+ PasswordResetTokenResponseToJSON,
45
60
  PasswordResetWithTokenRequestFromJSON,
46
61
  PasswordResetWithTokenRequestToJSON,
62
+ PhoneValidationResponseFromJSON,
63
+ PhoneValidationResponseToJSON,
64
+ PhoneVerificationRequestFromJSON,
65
+ PhoneVerificationRequestToJSON,
66
+ RequestPhoneChangeRequestFromJSON,
67
+ RequestPhoneChangeRequestToJSON,
68
+ ResponseSendPwResetEmailFromJSON,
69
+ ResponseSendPwResetEmailToJSON,
47
70
  SSOInitiateResponseFromJSON,
48
71
  SSOInitiateResponseToJSON,
72
+ SendPasswordResetRequestFromJSON,
73
+ SendPasswordResetRequestToJSON,
49
74
  SignInRequestFromJSON,
50
75
  SignInRequestToJSON,
51
76
  UserResponseFromJSON,
52
77
  UserResponseToJSON,
78
+ ValidateResetCodeRequestFromJSON,
79
+ ValidateResetCodeRequestToJSON,
53
80
  } from '../models/index';
54
81
 
82
+ export interface ChangePhoneNumberOperationRequest {
83
+ changePhoneNumberRequest: ChangePhoneNumberRequest;
84
+ authorization?: string | null;
85
+ ksUat?: string | null;
86
+ }
87
+
55
88
  export interface CreatePasswordUserOperationRequest {
56
89
  createPasswordUserRequest: CreatePasswordUserRequest;
57
90
  }
58
91
 
92
+ export interface CreatePhonePasswordUserOperationRequest {
93
+ createPhonePasswordUserRequest: CreatePhonePasswordUserRequest;
94
+ }
95
+
59
96
  export interface FanweiDirectorySyncRequest {
60
97
  tenantId: string;
61
98
  authorization?: string | null;
@@ -86,6 +123,10 @@ export interface PwEmailVerificationRequest {
86
123
  emailVerificationRequest: EmailVerificationRequest;
87
124
  }
88
125
 
126
+ export interface PwPhoneVerificationRequest {
127
+ phoneVerificationRequest: PhoneVerificationRequest;
128
+ }
129
+
89
130
  export interface PwSigninRequest {
90
131
  signInRequest: SignInRequest;
91
132
  }
@@ -96,6 +137,12 @@ export interface RefreshUatRequest {
96
137
  ksUat?: string | null;
97
138
  }
98
139
 
140
+ export interface RequestPhoneChangeOperationRequest {
141
+ requestPhoneChangeRequest: RequestPhoneChangeRequest;
142
+ authorization?: string | null;
143
+ ksUat?: string | null;
144
+ }
145
+
99
146
  export interface ResetPasswordRequest {
100
147
  passwordResetRequest: PasswordResetRequest;
101
148
  authorization?: string | null;
@@ -107,7 +154,7 @@ export interface ResetPasswordWithTokenRequest {
107
154
  }
108
155
 
109
156
  export interface SendPwResetEmailRequest {
110
- emailVerificationRequest: EmailVerificationRequest;
157
+ sendPasswordResetRequest: SendPasswordResetRequest;
111
158
  }
112
159
 
113
160
  export interface SsoSigninRequest {
@@ -115,6 +162,10 @@ export interface SsoSigninRequest {
115
162
  redirect?: string;
116
163
  }
117
164
 
165
+ export interface ValidatePwResetCodeRequest {
166
+ validateResetCodeRequest: ValidateResetCodeRequest;
167
+ }
168
+
118
169
  /**
119
170
  * AuthApi - interface
120
171
  *
@@ -122,6 +173,34 @@ export interface SsoSigninRequest {
122
173
  * @interface AuthApiInterface
123
174
  */
124
175
  export interface AuthApiInterface {
176
+ /**
177
+ * Creates request options for changePhoneNumber without sending the request
178
+ * @param {ChangePhoneNumberRequest} changePhoneNumberRequest
179
+ * @param {string} [authorization]
180
+ * @param {string} [ksUat]
181
+ * @throws {RequiredError}
182
+ * @memberof AuthApiInterface
183
+ */
184
+ changePhoneNumberRequestOpts(requestParameters: ChangePhoneNumberOperationRequest): Promise<runtime.RequestOpts>;
185
+
186
+ /**
187
+ * Apply a verified phone-number change to the authenticated user. The new phone is read from the Redis validation record pinned by ``/me/phone_number/verify``.
188
+ * @summary Change Phone Number Handler
189
+ * @param {ChangePhoneNumberRequest} changePhoneNumberRequest
190
+ * @param {string} [authorization]
191
+ * @param {string} [ksUat]
192
+ * @param {*} [options] Override http request option.
193
+ * @throws {RequiredError}
194
+ * @memberof AuthApiInterface
195
+ */
196
+ changePhoneNumberRaw(requestParameters: ChangePhoneNumberOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
197
+
198
+ /**
199
+ * Apply a verified phone-number change to the authenticated user. The new phone is read from the Redis validation record pinned by ``/me/phone_number/verify``.
200
+ * Change Phone Number Handler
201
+ */
202
+ changePhoneNumber(requestParameters: ChangePhoneNumberOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
203
+
125
204
  /**
126
205
  * Creates request options for createPasswordUser without sending the request
127
206
  * @param {CreatePasswordUserRequest} createPasswordUserRequest
@@ -145,6 +224,30 @@ export interface AuthApiInterface {
145
224
  */
146
225
  createPasswordUser(requestParameters: CreatePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
147
226
 
227
+ /**
228
+ * Creates request options for createPhonePasswordUser without sending the request
229
+ * @param {CreatePhonePasswordUserRequest} createPhonePasswordUserRequest
230
+ * @throws {RequiredError}
231
+ * @memberof AuthApiInterface
232
+ */
233
+ createPhonePasswordUserRequestOpts(requestParameters: CreatePhonePasswordUserOperationRequest): Promise<runtime.RequestOpts>;
234
+
235
+ /**
236
+ * Complete phone-based signup using a verified validation code. The phone number is read from the Redis validation record — it was pinned there by ``/phone_verification`` — so the client cannot submit a different phone here than the one it just proved ownership of.
237
+ * @summary Create Phone Password User Handler
238
+ * @param {CreatePhonePasswordUserRequest} createPhonePasswordUserRequest
239
+ * @param {*} [options] Override http request option.
240
+ * @throws {RequiredError}
241
+ * @memberof AuthApiInterface
242
+ */
243
+ createPhonePasswordUserRaw(requestParameters: CreatePhonePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
244
+
245
+ /**
246
+ * Complete phone-based signup using a verified validation code. The phone number is read from the Redis validation record — it was pinned there by ``/phone_verification`` — so the client cannot submit a different phone here than the one it just proved ownership of.
247
+ * Create Phone Password User Handler
248
+ */
249
+ createPhonePasswordUser(requestParameters: CreatePhonePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
250
+
148
251
  /**
149
252
  * Creates request options for fanweiDirectorySync without sending the request
150
253
  * @param {string} tenantId
@@ -285,6 +388,30 @@ export interface AuthApiInterface {
285
388
  */
286
389
  pwEmailVerification(requestParameters: PwEmailVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailSentResponse>;
287
390
 
391
+ /**
392
+ * Creates request options for pwPhoneVerification without sending the request
393
+ * @param {PhoneVerificationRequest} phoneVerificationRequest
394
+ * @throws {RequiredError}
395
+ * @memberof AuthApiInterface
396
+ */
397
+ pwPhoneVerificationRequestOpts(requestParameters: PwPhoneVerificationRequest): Promise<runtime.RequestOpts>;
398
+
399
+ /**
400
+ * Send a 6-digit signup verification code to ``phone_number``. Rejects (409) if a user already exists for this phone — this leaks enumeration but matches the duplicate-signup UX of the email flow.
401
+ * @summary Pw Phone Verification Handler
402
+ * @param {PhoneVerificationRequest} phoneVerificationRequest
403
+ * @param {*} [options] Override http request option.
404
+ * @throws {RequiredError}
405
+ * @memberof AuthApiInterface
406
+ */
407
+ pwPhoneVerificationRaw(requestParameters: PwPhoneVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PhoneValidationResponse>>;
408
+
409
+ /**
410
+ * Send a 6-digit signup verification code to ``phone_number``. Rejects (409) if a user already exists for this phone — this leaks enumeration but matches the duplicate-signup UX of the email flow.
411
+ * Pw Phone Verification Handler
412
+ */
413
+ pwPhoneVerification(requestParameters: PwPhoneVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PhoneValidationResponse>;
414
+
288
415
  /**
289
416
  * Creates request options for pwSignin without sending the request
290
417
  * @param {SignInRequest} signInRequest
@@ -337,6 +464,34 @@ export interface AuthApiInterface {
337
464
  */
338
465
  refreshUat(requestParameters: RefreshUatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
339
466
 
467
+ /**
468
+ * Creates request options for requestPhoneChange without sending the request
469
+ * @param {RequestPhoneChangeRequest} requestPhoneChangeRequest
470
+ * @param {string} [authorization]
471
+ * @param {string} [ksUat]
472
+ * @throws {RequiredError}
473
+ * @memberof AuthApiInterface
474
+ */
475
+ requestPhoneChangeRequestOpts(requestParameters: RequestPhoneChangeOperationRequest): Promise<runtime.RequestOpts>;
476
+
477
+ /**
478
+ * Dispatch an SMS code to authorize a phone-number change. Confirms the new phone isn\'t already taken by *another* user. The caller is identified by their UAT, so authentication is required.
479
+ * @summary Request Phone Change Handler
480
+ * @param {RequestPhoneChangeRequest} requestPhoneChangeRequest
481
+ * @param {string} [authorization]
482
+ * @param {string} [ksUat]
483
+ * @param {*} [options] Override http request option.
484
+ * @throws {RequiredError}
485
+ * @memberof AuthApiInterface
486
+ */
487
+ requestPhoneChangeRaw(requestParameters: RequestPhoneChangeOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PhoneValidationResponse>>;
488
+
489
+ /**
490
+ * Dispatch an SMS code to authorize a phone-number change. Confirms the new phone isn\'t already taken by *another* user. The caller is identified by their UAT, so authentication is required.
491
+ * Request Phone Change Handler
492
+ */
493
+ requestPhoneChange(requestParameters: RequestPhoneChangeOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PhoneValidationResponse>;
494
+
340
495
  /**
341
496
  * Creates request options for resetPassword without sending the request
342
497
  * @param {PasswordResetRequest} passwordResetRequest
@@ -374,7 +529,7 @@ export interface AuthApiInterface {
374
529
  resetPasswordWithTokenRequestOpts(requestParameters: ResetPasswordWithTokenRequest): Promise<runtime.RequestOpts>;
375
530
 
376
531
  /**
377
- * Reset password with email verification token
532
+ * Reset password with a single-use PasswordResetToken JWT
378
533
  * @summary Reset Password With Token Handler
379
534
  * @param {PasswordResetWithTokenRequest} passwordResetWithTokenRequest
380
535
  * @param {*} [options] Override http request option.
@@ -384,33 +539,34 @@ export interface AuthApiInterface {
384
539
  resetPasswordWithTokenRaw(requestParameters: ResetPasswordWithTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
385
540
 
386
541
  /**
387
- * Reset password with email verification token
542
+ * Reset password with a single-use PasswordResetToken JWT
388
543
  * Reset Password With Token Handler
389
544
  */
390
545
  resetPasswordWithToken(requestParameters: ResetPasswordWithTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
391
546
 
392
547
  /**
393
548
  * Creates request options for sendPwResetEmail without sending the request
394
- * @param {EmailVerificationRequest} emailVerificationRequest
549
+ * @param {SendPasswordResetRequest} sendPasswordResetRequest
395
550
  * @throws {RequiredError}
396
551
  * @memberof AuthApiInterface
397
552
  */
398
553
  sendPwResetEmailRequestOpts(requestParameters: SendPwResetEmailRequest): Promise<runtime.RequestOpts>;
399
554
 
400
555
  /**
401
- *
556
+ * Initiate a password reset via the requested ``method``. ``method=EMAIL`` (default) mints a ``PasswordResetToken`` and sends the existing reset email. ``method=SMS`` looks up the user by phone, dispatches an SMS verification code, and the caller must follow up with ``/validate_reset_code``.
402
557
  * @summary Send Pw Reset Email Handler
403
- * @param {EmailVerificationRequest} emailVerificationRequest
558
+ * @param {SendPasswordResetRequest} sendPasswordResetRequest
404
559
  * @param {*} [options] Override http request option.
405
560
  * @throws {RequiredError}
406
561
  * @memberof AuthApiInterface
407
562
  */
408
- sendPwResetEmailRaw(requestParameters: SendPwResetEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailSentResponse>>;
563
+ sendPwResetEmailRaw(requestParameters: SendPwResetEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResponseSendPwResetEmail>>;
409
564
 
410
565
  /**
566
+ * Initiate a password reset via the requested ``method``. ``method=EMAIL`` (default) mints a ``PasswordResetToken`` and sends the existing reset email. ``method=SMS`` looks up the user by phone, dispatches an SMS verification code, and the caller must follow up with ``/validate_reset_code``.
411
567
  * Send Pw Reset Email Handler
412
568
  */
413
- sendPwResetEmail(requestParameters: SendPwResetEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailSentResponse>;
569
+ sendPwResetEmail(requestParameters: SendPwResetEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResponseSendPwResetEmail>;
414
570
 
415
571
  /**
416
572
  * Creates request options for signout without sending the request
@@ -459,6 +615,30 @@ export interface AuthApiInterface {
459
615
  */
460
616
  ssoSignin(requestParameters: SsoSigninRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
461
617
 
618
+ /**
619
+ * Creates request options for validatePwResetCode without sending the request
620
+ * @param {ValidateResetCodeRequest} validateResetCodeRequest
621
+ * @throws {RequiredError}
622
+ * @memberof AuthApiInterface
623
+ */
624
+ validatePwResetCodeRequestOpts(requestParameters: ValidatePwResetCodeRequest): Promise<runtime.RequestOpts>;
625
+
626
+ /**
627
+ * Validate an SMS reset code and return a single-use reset JWT.
628
+ * @summary Validate Reset Code Handler
629
+ * @param {ValidateResetCodeRequest} validateResetCodeRequest
630
+ * @param {*} [options] Override http request option.
631
+ * @throws {RequiredError}
632
+ * @memberof AuthApiInterface
633
+ */
634
+ validatePwResetCodeRaw(requestParameters: ValidatePwResetCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PasswordResetTokenResponse>>;
635
+
636
+ /**
637
+ * Validate an SMS reset code and return a single-use reset JWT.
638
+ * Validate Reset Code Handler
639
+ */
640
+ validatePwResetCode(requestParameters: ValidatePwResetCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PasswordResetTokenResponse>;
641
+
462
642
  }
463
643
 
464
644
  /**
@@ -466,6 +646,59 @@ export interface AuthApiInterface {
466
646
  */
467
647
  export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
468
648
 
649
+ /**
650
+ * Creates request options for changePhoneNumber without sending the request
651
+ */
652
+ async changePhoneNumberRequestOpts(requestParameters: ChangePhoneNumberOperationRequest): Promise<runtime.RequestOpts> {
653
+ if (requestParameters['changePhoneNumberRequest'] == null) {
654
+ throw new runtime.RequiredError(
655
+ 'changePhoneNumberRequest',
656
+ 'Required parameter "changePhoneNumberRequest" was null or undefined when calling changePhoneNumber().'
657
+ );
658
+ }
659
+
660
+ const queryParameters: any = {};
661
+
662
+ const headerParameters: runtime.HTTPHeaders = {};
663
+
664
+ headerParameters['Content-Type'] = 'application/json';
665
+
666
+ if (requestParameters['authorization'] != null) {
667
+ headerParameters['authorization'] = String(requestParameters['authorization']);
668
+ }
669
+
670
+
671
+ let urlPath = `/v1/auth/pw/me/phone_number`;
672
+
673
+ return {
674
+ path: urlPath,
675
+ method: 'PUT',
676
+ headers: headerParameters,
677
+ query: queryParameters,
678
+ body: ChangePhoneNumberRequestToJSON(requestParameters['changePhoneNumberRequest']),
679
+ };
680
+ }
681
+
682
+ /**
683
+ * Apply a verified phone-number change to the authenticated user. The new phone is read from the Redis validation record pinned by ``/me/phone_number/verify``.
684
+ * Change Phone Number Handler
685
+ */
686
+ async changePhoneNumberRaw(requestParameters: ChangePhoneNumberOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>> {
687
+ const requestOptions = await this.changePhoneNumberRequestOpts(requestParameters);
688
+ const response = await this.request(requestOptions, initOverrides);
689
+
690
+ return new runtime.JSONApiResponse(response, (jsonValue) => UserResponseFromJSON(jsonValue));
691
+ }
692
+
693
+ /**
694
+ * Apply a verified phone-number change to the authenticated user. The new phone is read from the Redis validation record pinned by ``/me/phone_number/verify``.
695
+ * Change Phone Number Handler
696
+ */
697
+ async changePhoneNumber(requestParameters: ChangePhoneNumberOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse> {
698
+ const response = await this.changePhoneNumberRaw(requestParameters, initOverrides);
699
+ return await response.value();
700
+ }
701
+
469
702
  /**
470
703
  * Creates request options for createPasswordUser without sending the request
471
704
  */
@@ -513,6 +746,55 @@ export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
513
746
  return await response.value();
514
747
  }
515
748
 
749
+ /**
750
+ * Creates request options for createPhonePasswordUser without sending the request
751
+ */
752
+ async createPhonePasswordUserRequestOpts(requestParameters: CreatePhonePasswordUserOperationRequest): Promise<runtime.RequestOpts> {
753
+ if (requestParameters['createPhonePasswordUserRequest'] == null) {
754
+ throw new runtime.RequiredError(
755
+ 'createPhonePasswordUserRequest',
756
+ 'Required parameter "createPhonePasswordUserRequest" was null or undefined when calling createPhonePasswordUser().'
757
+ );
758
+ }
759
+
760
+ const queryParameters: any = {};
761
+
762
+ const headerParameters: runtime.HTTPHeaders = {};
763
+
764
+ headerParameters['Content-Type'] = 'application/json';
765
+
766
+
767
+ let urlPath = `/v1/auth/pw/phone_user`;
768
+
769
+ return {
770
+ path: urlPath,
771
+ method: 'POST',
772
+ headers: headerParameters,
773
+ query: queryParameters,
774
+ body: CreatePhonePasswordUserRequestToJSON(requestParameters['createPhonePasswordUserRequest']),
775
+ };
776
+ }
777
+
778
+ /**
779
+ * Complete phone-based signup using a verified validation code. The phone number is read from the Redis validation record — it was pinned there by ``/phone_verification`` — so the client cannot submit a different phone here than the one it just proved ownership of.
780
+ * Create Phone Password User Handler
781
+ */
782
+ async createPhonePasswordUserRaw(requestParameters: CreatePhonePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>> {
783
+ const requestOptions = await this.createPhonePasswordUserRequestOpts(requestParameters);
784
+ const response = await this.request(requestOptions, initOverrides);
785
+
786
+ return new runtime.JSONApiResponse(response, (jsonValue) => UserResponseFromJSON(jsonValue));
787
+ }
788
+
789
+ /**
790
+ * Complete phone-based signup using a verified validation code. The phone number is read from the Redis validation record — it was pinned there by ``/phone_verification`` — so the client cannot submit a different phone here than the one it just proved ownership of.
791
+ * Create Phone Password User Handler
792
+ */
793
+ async createPhonePasswordUser(requestParameters: CreatePhonePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse> {
794
+ const response = await this.createPhonePasswordUserRaw(requestParameters, initOverrides);
795
+ return await response.value();
796
+ }
797
+
516
798
  /**
517
799
  * Creates request options for fanweiDirectorySync without sending the request
518
800
  */
@@ -788,6 +1070,55 @@ export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
788
1070
  return await response.value();
789
1071
  }
790
1072
 
1073
+ /**
1074
+ * Creates request options for pwPhoneVerification without sending the request
1075
+ */
1076
+ async pwPhoneVerificationRequestOpts(requestParameters: PwPhoneVerificationRequest): Promise<runtime.RequestOpts> {
1077
+ if (requestParameters['phoneVerificationRequest'] == null) {
1078
+ throw new runtime.RequiredError(
1079
+ 'phoneVerificationRequest',
1080
+ 'Required parameter "phoneVerificationRequest" was null or undefined when calling pwPhoneVerification().'
1081
+ );
1082
+ }
1083
+
1084
+ const queryParameters: any = {};
1085
+
1086
+ const headerParameters: runtime.HTTPHeaders = {};
1087
+
1088
+ headerParameters['Content-Type'] = 'application/json';
1089
+
1090
+
1091
+ let urlPath = `/v1/auth/pw/phone_verification`;
1092
+
1093
+ return {
1094
+ path: urlPath,
1095
+ method: 'POST',
1096
+ headers: headerParameters,
1097
+ query: queryParameters,
1098
+ body: PhoneVerificationRequestToJSON(requestParameters['phoneVerificationRequest']),
1099
+ };
1100
+ }
1101
+
1102
+ /**
1103
+ * Send a 6-digit signup verification code to ``phone_number``. Rejects (409) if a user already exists for this phone — this leaks enumeration but matches the duplicate-signup UX of the email flow.
1104
+ * Pw Phone Verification Handler
1105
+ */
1106
+ async pwPhoneVerificationRaw(requestParameters: PwPhoneVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PhoneValidationResponse>> {
1107
+ const requestOptions = await this.pwPhoneVerificationRequestOpts(requestParameters);
1108
+ const response = await this.request(requestOptions, initOverrides);
1109
+
1110
+ return new runtime.JSONApiResponse(response, (jsonValue) => PhoneValidationResponseFromJSON(jsonValue));
1111
+ }
1112
+
1113
+ /**
1114
+ * Send a 6-digit signup verification code to ``phone_number``. Rejects (409) if a user already exists for this phone — this leaks enumeration but matches the duplicate-signup UX of the email flow.
1115
+ * Pw Phone Verification Handler
1116
+ */
1117
+ async pwPhoneVerification(requestParameters: PwPhoneVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PhoneValidationResponse> {
1118
+ const response = await this.pwPhoneVerificationRaw(requestParameters, initOverrides);
1119
+ return await response.value();
1120
+ }
1121
+
791
1122
  /**
792
1123
  * Creates request options for pwSignin without sending the request
793
1124
  */
@@ -884,6 +1215,59 @@ export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
884
1215
  return await response.value();
885
1216
  }
886
1217
 
1218
+ /**
1219
+ * Creates request options for requestPhoneChange without sending the request
1220
+ */
1221
+ async requestPhoneChangeRequestOpts(requestParameters: RequestPhoneChangeOperationRequest): Promise<runtime.RequestOpts> {
1222
+ if (requestParameters['requestPhoneChangeRequest'] == null) {
1223
+ throw new runtime.RequiredError(
1224
+ 'requestPhoneChangeRequest',
1225
+ 'Required parameter "requestPhoneChangeRequest" was null or undefined when calling requestPhoneChange().'
1226
+ );
1227
+ }
1228
+
1229
+ const queryParameters: any = {};
1230
+
1231
+ const headerParameters: runtime.HTTPHeaders = {};
1232
+
1233
+ headerParameters['Content-Type'] = 'application/json';
1234
+
1235
+ if (requestParameters['authorization'] != null) {
1236
+ headerParameters['authorization'] = String(requestParameters['authorization']);
1237
+ }
1238
+
1239
+
1240
+ let urlPath = `/v1/auth/pw/me/phone_number/verify`;
1241
+
1242
+ return {
1243
+ path: urlPath,
1244
+ method: 'POST',
1245
+ headers: headerParameters,
1246
+ query: queryParameters,
1247
+ body: RequestPhoneChangeRequestToJSON(requestParameters['requestPhoneChangeRequest']),
1248
+ };
1249
+ }
1250
+
1251
+ /**
1252
+ * Dispatch an SMS code to authorize a phone-number change. Confirms the new phone isn\'t already taken by *another* user. The caller is identified by their UAT, so authentication is required.
1253
+ * Request Phone Change Handler
1254
+ */
1255
+ async requestPhoneChangeRaw(requestParameters: RequestPhoneChangeOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PhoneValidationResponse>> {
1256
+ const requestOptions = await this.requestPhoneChangeRequestOpts(requestParameters);
1257
+ const response = await this.request(requestOptions, initOverrides);
1258
+
1259
+ return new runtime.JSONApiResponse(response, (jsonValue) => PhoneValidationResponseFromJSON(jsonValue));
1260
+ }
1261
+
1262
+ /**
1263
+ * Dispatch an SMS code to authorize a phone-number change. Confirms the new phone isn\'t already taken by *another* user. The caller is identified by their UAT, so authentication is required.
1264
+ * Request Phone Change Handler
1265
+ */
1266
+ async requestPhoneChange(requestParameters: RequestPhoneChangeOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PhoneValidationResponse> {
1267
+ const response = await this.requestPhoneChangeRaw(requestParameters, initOverrides);
1268
+ return await response.value();
1269
+ }
1270
+
887
1271
  /**
888
1272
  * Creates request options for resetPassword without sending the request
889
1273
  */
@@ -967,7 +1351,7 @@ export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
967
1351
  }
968
1352
 
969
1353
  /**
970
- * Reset password with email verification token
1354
+ * Reset password with a single-use PasswordResetToken JWT
971
1355
  * Reset Password With Token Handler
972
1356
  */
973
1357
  async resetPasswordWithTokenRaw(requestParameters: ResetPasswordWithTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>> {
@@ -978,7 +1362,7 @@ export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
978
1362
  }
979
1363
 
980
1364
  /**
981
- * Reset password with email verification token
1365
+ * Reset password with a single-use PasswordResetToken JWT
982
1366
  * Reset Password With Token Handler
983
1367
  */
984
1368
  async resetPasswordWithToken(requestParameters: ResetPasswordWithTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse> {
@@ -990,10 +1374,10 @@ export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
990
1374
  * Creates request options for sendPwResetEmail without sending the request
991
1375
  */
992
1376
  async sendPwResetEmailRequestOpts(requestParameters: SendPwResetEmailRequest): Promise<runtime.RequestOpts> {
993
- if (requestParameters['emailVerificationRequest'] == null) {
1377
+ if (requestParameters['sendPasswordResetRequest'] == null) {
994
1378
  throw new runtime.RequiredError(
995
- 'emailVerificationRequest',
996
- 'Required parameter "emailVerificationRequest" was null or undefined when calling sendPwResetEmail().'
1379
+ 'sendPasswordResetRequest',
1380
+ 'Required parameter "sendPasswordResetRequest" was null or undefined when calling sendPwResetEmail().'
997
1381
  );
998
1382
  }
999
1383
 
@@ -1011,24 +1395,26 @@ export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
1011
1395
  method: 'POST',
1012
1396
  headers: headerParameters,
1013
1397
  query: queryParameters,
1014
- body: EmailVerificationRequestToJSON(requestParameters['emailVerificationRequest']),
1398
+ body: SendPasswordResetRequestToJSON(requestParameters['sendPasswordResetRequest']),
1015
1399
  };
1016
1400
  }
1017
1401
 
1018
1402
  /**
1403
+ * Initiate a password reset via the requested ``method``. ``method=EMAIL`` (default) mints a ``PasswordResetToken`` and sends the existing reset email. ``method=SMS`` looks up the user by phone, dispatches an SMS verification code, and the caller must follow up with ``/validate_reset_code``.
1019
1404
  * Send Pw Reset Email Handler
1020
1405
  */
1021
- async sendPwResetEmailRaw(requestParameters: SendPwResetEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailSentResponse>> {
1406
+ async sendPwResetEmailRaw(requestParameters: SendPwResetEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResponseSendPwResetEmail>> {
1022
1407
  const requestOptions = await this.sendPwResetEmailRequestOpts(requestParameters);
1023
1408
  const response = await this.request(requestOptions, initOverrides);
1024
1409
 
1025
- return new runtime.JSONApiResponse(response, (jsonValue) => EmailSentResponseFromJSON(jsonValue));
1410
+ return new runtime.JSONApiResponse(response, (jsonValue) => ResponseSendPwResetEmailFromJSON(jsonValue));
1026
1411
  }
1027
1412
 
1028
1413
  /**
1414
+ * Initiate a password reset via the requested ``method``. ``method=EMAIL`` (default) mints a ``PasswordResetToken`` and sends the existing reset email. ``method=SMS`` looks up the user by phone, dispatches an SMS verification code, and the caller must follow up with ``/validate_reset_code``.
1029
1415
  * Send Pw Reset Email Handler
1030
1416
  */
1031
- async sendPwResetEmail(requestParameters: SendPwResetEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailSentResponse> {
1417
+ async sendPwResetEmail(requestParameters: SendPwResetEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResponseSendPwResetEmail> {
1032
1418
  const response = await this.sendPwResetEmailRaw(requestParameters, initOverrides);
1033
1419
  return await response.value();
1034
1420
  }
@@ -1124,4 +1510,53 @@ export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
1124
1510
  await this.ssoSigninRaw(requestParameters, initOverrides);
1125
1511
  }
1126
1512
 
1513
+ /**
1514
+ * Creates request options for validatePwResetCode without sending the request
1515
+ */
1516
+ async validatePwResetCodeRequestOpts(requestParameters: ValidatePwResetCodeRequest): Promise<runtime.RequestOpts> {
1517
+ if (requestParameters['validateResetCodeRequest'] == null) {
1518
+ throw new runtime.RequiredError(
1519
+ 'validateResetCodeRequest',
1520
+ 'Required parameter "validateResetCodeRequest" was null or undefined when calling validatePwResetCode().'
1521
+ );
1522
+ }
1523
+
1524
+ const queryParameters: any = {};
1525
+
1526
+ const headerParameters: runtime.HTTPHeaders = {};
1527
+
1528
+ headerParameters['Content-Type'] = 'application/json';
1529
+
1530
+
1531
+ let urlPath = `/v1/auth/pw/validate_reset_code`;
1532
+
1533
+ return {
1534
+ path: urlPath,
1535
+ method: 'POST',
1536
+ headers: headerParameters,
1537
+ query: queryParameters,
1538
+ body: ValidateResetCodeRequestToJSON(requestParameters['validateResetCodeRequest']),
1539
+ };
1540
+ }
1541
+
1542
+ /**
1543
+ * Validate an SMS reset code and return a single-use reset JWT.
1544
+ * Validate Reset Code Handler
1545
+ */
1546
+ async validatePwResetCodeRaw(requestParameters: ValidatePwResetCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PasswordResetTokenResponse>> {
1547
+ const requestOptions = await this.validatePwResetCodeRequestOpts(requestParameters);
1548
+ const response = await this.request(requestOptions, initOverrides);
1549
+
1550
+ return new runtime.JSONApiResponse(response, (jsonValue) => PasswordResetTokenResponseFromJSON(jsonValue));
1551
+ }
1552
+
1553
+ /**
1554
+ * Validate an SMS reset code and return a single-use reset JWT.
1555
+ * Validate Reset Code Handler
1556
+ */
1557
+ async validatePwResetCode(requestParameters: ValidatePwResetCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PasswordResetTokenResponse> {
1558
+ const response = await this.validatePwResetCodeRaw(requestParameters, initOverrides);
1559
+ return await response.value();
1560
+ }
1561
+
1127
1562
  }