@blezgo/api-sdk 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.
- package/CHANGELOG.md +6 -0
- package/README.md +27 -0
- package/dist/account/client.d.ts +3 -0
- package/dist/account/client.d.ts.map +1 -0
- package/dist/account/client.js +3 -0
- package/dist/account/client.js.map +1 -0
- package/dist/account/generated.d.ts +2648 -0
- package/dist/account/generated.d.ts.map +1 -0
- package/dist/account/generated.js +6 -0
- package/dist/account/generated.js.map +1 -0
- package/dist/account/index.d.ts +2 -0
- package/dist/account/index.d.ts.map +1 -0
- package/dist/account/index.js +2 -0
- package/dist/account/index.js.map +1 -0
- package/dist/admin/client.d.ts +3 -0
- package/dist/admin/client.d.ts.map +1 -0
- package/dist/admin/client.js +3 -0
- package/dist/admin/client.js.map +1 -0
- package/dist/admin/generated.d.ts +956 -0
- package/dist/admin/generated.d.ts.map +1 -0
- package/dist/admin/generated.js +6 -0
- package/dist/admin/generated.js.map +1 -0
- package/dist/admin/index.d.ts +2 -0
- package/dist/admin/index.d.ts.map +1 -0
- package/dist/admin/index.js +2 -0
- package/dist/admin/index.js.map +1 -0
- package/dist/authentication/client.d.ts +3 -0
- package/dist/authentication/client.d.ts.map +1 -0
- package/dist/authentication/client.js +3 -0
- package/dist/authentication/client.js.map +1 -0
- package/dist/authentication/generated.d.ts +746 -0
- package/dist/authentication/generated.d.ts.map +1 -0
- package/dist/authentication/generated.js +6 -0
- package/dist/authentication/generated.js.map +1 -0
- package/dist/authentication/index.d.ts +2 -0
- package/dist/authentication/index.d.ts.map +1 -0
- package/dist/authentication/index.js +2 -0
- package/dist/authentication/index.js.map +1 -0
- package/dist/cache/client.d.ts +3 -0
- package/dist/cache/client.d.ts.map +1 -0
- package/dist/cache/client.js +3 -0
- package/dist/cache/client.js.map +1 -0
- package/dist/cache/generated.d.ts +3355 -0
- package/dist/cache/generated.d.ts.map +1 -0
- package/dist/cache/generated.js +6 -0
- package/dist/cache/generated.js.map +1 -0
- package/dist/cache/index.d.ts +2 -0
- package/dist/cache/index.d.ts.map +1 -0
- package/dist/cache/index.js +2 -0
- package/dist/cache/index.js.map +1 -0
- package/dist/config/client.d.ts +3 -0
- package/dist/config/client.d.ts.map +1 -0
- package/dist/config/client.js +3 -0
- package/dist/config/client.js.map +1 -0
- package/dist/config/generated.d.ts +1150 -0
- package/dist/config/generated.d.ts.map +1 -0
- package/dist/config/generated.js +6 -0
- package/dist/config/generated.js.map +1 -0
- package/dist/config/index.d.ts +2 -0
- package/dist/config/index.d.ts.map +1 -0
- package/dist/config/index.js +2 -0
- package/dist/config/index.js.map +1 -0
- package/dist/dashboard/client.d.ts +3 -0
- package/dist/dashboard/client.d.ts.map +1 -0
- package/dist/dashboard/client.js +3 -0
- package/dist/dashboard/client.js.map +1 -0
- package/dist/dashboard/generated.d.ts +4831 -0
- package/dist/dashboard/generated.d.ts.map +1 -0
- package/dist/dashboard/generated.js +6 -0
- package/dist/dashboard/generated.js.map +1 -0
- package/dist/dashboard/index.d.ts +2 -0
- package/dist/dashboard/index.d.ts.map +1 -0
- package/dist/dashboard/index.js +2 -0
- package/dist/dashboard/index.js.map +1 -0
- package/dist/errors/client.d.ts +3 -0
- package/dist/errors/client.d.ts.map +1 -0
- package/dist/errors/client.js +3 -0
- package/dist/errors/client.js.map +1 -0
- package/dist/errors/generated.d.ts +340 -0
- package/dist/errors/generated.d.ts.map +1 -0
- package/dist/errors/generated.js +6 -0
- package/dist/errors/generated.js.map +1 -0
- package/dist/errors/index.d.ts +2 -0
- package/dist/errors/index.d.ts.map +1 -0
- package/dist/errors/index.js +2 -0
- package/dist/errors/index.js.map +1 -0
- package/dist/index.d.ts +15 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +19 -0
- package/dist/index.js.map +1 -0
- package/dist/internationalization/client.d.ts +3 -0
- package/dist/internationalization/client.d.ts.map +1 -0
- package/dist/internationalization/client.js +3 -0
- package/dist/internationalization/client.js.map +1 -0
- package/dist/internationalization/generated.d.ts +587 -0
- package/dist/internationalization/generated.d.ts.map +1 -0
- package/dist/internationalization/generated.js +6 -0
- package/dist/internationalization/generated.js.map +1 -0
- package/dist/internationalization/index.d.ts +2 -0
- package/dist/internationalization/index.d.ts.map +1 -0
- package/dist/internationalization/index.js +2 -0
- package/dist/internationalization/index.js.map +1 -0
- package/dist/invitations/client.d.ts +3 -0
- package/dist/invitations/client.d.ts.map +1 -0
- package/dist/invitations/client.js +3 -0
- package/dist/invitations/client.js.map +1 -0
- package/dist/invitations/generated.d.ts +4019 -0
- package/dist/invitations/generated.d.ts.map +1 -0
- package/dist/invitations/generated.js +6 -0
- package/dist/invitations/generated.js.map +1 -0
- package/dist/invitations/index.d.ts +2 -0
- package/dist/invitations/index.d.ts.map +1 -0
- package/dist/invitations/index.js +2 -0
- package/dist/invitations/index.js.map +1 -0
- package/dist/registration/client.d.ts +3 -0
- package/dist/registration/client.d.ts.map +1 -0
- package/dist/registration/client.js +3 -0
- package/dist/registration/client.js.map +1 -0
- package/dist/registration/generated.d.ts +1010 -0
- package/dist/registration/generated.d.ts.map +1 -0
- package/dist/registration/generated.js +6 -0
- package/dist/registration/generated.js.map +1 -0
- package/dist/registration/index.d.ts +2 -0
- package/dist/registration/index.d.ts.map +1 -0
- package/dist/registration/index.js +2 -0
- package/dist/registration/index.js.map +1 -0
- package/dist/role/client.d.ts +3 -0
- package/dist/role/client.d.ts.map +1 -0
- package/dist/role/client.js +3 -0
- package/dist/role/client.js.map +1 -0
- package/dist/role/generated.d.ts +6324 -0
- package/dist/role/generated.d.ts.map +1 -0
- package/dist/role/generated.js +6 -0
- package/dist/role/generated.js.map +1 -0
- package/dist/role/index.d.ts +2 -0
- package/dist/role/index.d.ts.map +1 -0
- package/dist/role/index.js +2 -0
- package/dist/role/index.js.map +1 -0
- package/dist/tenant/client.d.ts +3 -0
- package/dist/tenant/client.d.ts.map +1 -0
- package/dist/tenant/client.js +3 -0
- package/dist/tenant/client.js.map +1 -0
- package/dist/tenant/generated.d.ts +8273 -0
- package/dist/tenant/generated.d.ts.map +1 -0
- package/dist/tenant/generated.js +6 -0
- package/dist/tenant/generated.js.map +1 -0
- package/dist/tenant/index.d.ts +2 -0
- package/dist/tenant/index.d.ts.map +1 -0
- package/dist/tenant/index.js +2 -0
- package/dist/tenant/index.js.map +1 -0
- package/dist/tokens/client.d.ts +3 -0
- package/dist/tokens/client.d.ts.map +1 -0
- package/dist/tokens/client.js +3 -0
- package/dist/tokens/client.js.map +1 -0
- package/dist/tokens/generated.d.ts +528 -0
- package/dist/tokens/generated.d.ts.map +1 -0
- package/dist/tokens/generated.js +6 -0
- package/dist/tokens/generated.js.map +1 -0
- package/dist/tokens/index.d.ts +2 -0
- package/dist/tokens/index.d.ts.map +1 -0
- package/dist/tokens/index.js +2 -0
- package/dist/tokens/index.js.map +1 -0
- package/dist/user/client.d.ts +3 -0
- package/dist/user/client.d.ts.map +1 -0
- package/dist/user/client.js +3 -0
- package/dist/user/client.js.map +1 -0
- package/dist/user/generated.d.ts +4350 -0
- package/dist/user/generated.d.ts.map +1 -0
- package/dist/user/generated.js +6 -0
- package/dist/user/generated.js.map +1 -0
- package/dist/user/index.d.ts +2 -0
- package/dist/user/index.d.ts.map +1 -0
- package/dist/user/index.js +2 -0
- package/dist/user/index.js.map +1 -0
- package/package.json +39 -0
|
@@ -0,0 +1,1010 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by openapi-typescript.
|
|
3
|
+
* Do not make direct changes to the file.
|
|
4
|
+
*/
|
|
5
|
+
export interface paths {
|
|
6
|
+
"/v1/auth/registrations": {
|
|
7
|
+
parameters: {
|
|
8
|
+
query?: never;
|
|
9
|
+
header?: never;
|
|
10
|
+
path?: never;
|
|
11
|
+
cookie?: never;
|
|
12
|
+
};
|
|
13
|
+
get?: never;
|
|
14
|
+
put?: never;
|
|
15
|
+
/**
|
|
16
|
+
* Register User
|
|
17
|
+
* @description Register a new user account.
|
|
18
|
+
*
|
|
19
|
+
* **Authentication**: None (public endpoint)
|
|
20
|
+
* **Rate Limit**: 20 requests per minute
|
|
21
|
+
*
|
|
22
|
+
* ## Request Body Example:
|
|
23
|
+
* ```json
|
|
24
|
+
* {
|
|
25
|
+
* "email": "john.doe@example.com",
|
|
26
|
+
* "username": "johndoe",
|
|
27
|
+
* "mobile_country_code": "+1",
|
|
28
|
+
* "mobile_number": "5551234567",
|
|
29
|
+
* "password": "SecurePass123!",
|
|
30
|
+
* "confirm_password": "SecurePass123!",
|
|
31
|
+
* "space_id": "spc_abc123xyz",
|
|
32
|
+
* "recaptcha_response": "03AGdBq27...",
|
|
33
|
+
*
|
|
34
|
+
* "profile": {
|
|
35
|
+
* "first_name": "John",
|
|
36
|
+
* "last_name": "Doe",
|
|
37
|
+
* "nickname": "Johnny",
|
|
38
|
+
* "date_of_birth": "1990-05-15",
|
|
39
|
+
* "gender": "male",
|
|
40
|
+
* "preferred_language": "en-US",
|
|
41
|
+
* "location": "San Francisco, CA"
|
|
42
|
+
* },
|
|
43
|
+
*
|
|
44
|
+
* "contact": {
|
|
45
|
+
* "secondary_email": "john.backup@example.com",
|
|
46
|
+
* "emergency_contact": "+1-5559876543"
|
|
47
|
+
* },
|
|
48
|
+
*
|
|
49
|
+
* "address": {
|
|
50
|
+
* "address_line_1": "123 Main Street",
|
|
51
|
+
* "address_line_2": "Apt 4B",
|
|
52
|
+
* "city": "San Francisco",
|
|
53
|
+
* "state": "California",
|
|
54
|
+
* "country": "United States",
|
|
55
|
+
* "postal_code": "94102",
|
|
56
|
+
* "nationality": "American"
|
|
57
|
+
* },
|
|
58
|
+
*
|
|
59
|
+
* "preferences": {
|
|
60
|
+
* "timezone": "America/Los_Angeles",
|
|
61
|
+
* "display_timezone": "PST",
|
|
62
|
+
* "locale": "en-US"
|
|
63
|
+
* },
|
|
64
|
+
*
|
|
65
|
+
* "metadata": {
|
|
66
|
+
* "invite_code": "WELCOME2026",
|
|
67
|
+
* "tracking_id": "utm_campaign_abc123"
|
|
68
|
+
* }
|
|
69
|
+
* }
|
|
70
|
+
* ```
|
|
71
|
+
*
|
|
72
|
+
* ## Required Fields:
|
|
73
|
+
* - **Email**: `email` (valid email address)
|
|
74
|
+
* - **Credentials**: `password`, `confirm_password`
|
|
75
|
+
* - **Space**: `space_id` (external ID format: `spc_xxx`)
|
|
76
|
+
*
|
|
77
|
+
* ## Optional Fields:
|
|
78
|
+
* - **Secondary Identifiers**: `username`, (`mobile_country_code` + `mobile_number`)
|
|
79
|
+
* - **Profile**: first_name, last_name, nickname, date_of_birth, gender, preferred_language, location
|
|
80
|
+
* - **Contact**: secondary_email, emergency_contact (format: `+1-5551234567` - one hyphen after country code)
|
|
81
|
+
* - **Address**: address_line_1, address_line_2, city, state, country, postal_code, nationality
|
|
82
|
+
* - **Preferences**: timezone, display_timezone, locale
|
|
83
|
+
* - **Metadata**: invite_code, tracking_id
|
|
84
|
+
* - **reCAPTCHA**: `recaptcha_response` (required if enabled in space config)
|
|
85
|
+
*
|
|
86
|
+
* ## Field Format Notes:
|
|
87
|
+
* - **mobile_country_code**: Must be `+` followed by 1-3 digits (e.g., `+1`, `+91`)
|
|
88
|
+
* - **mobile_number**: Digits only, validated against country format
|
|
89
|
+
* - **emergency_contact**: Format `+<country>-<phone>` (e.g., `+1-5551234567`) - only ONE hyphen
|
|
90
|
+
* - **space_id**: Must start with `spc_` prefix
|
|
91
|
+
* - **preferred_language**: Format `xx-XX` (e.g., `en-US`, `es-ES`)
|
|
92
|
+
* - **locale**: Format `xx-XX` (e.g., `en-US`, `es-ES`)
|
|
93
|
+
* - **timezone**: Valid IANA timezone (e.g., `America/Los_Angeles`, `Asia/Kolkata`)
|
|
94
|
+
*
|
|
95
|
+
* ## Response:
|
|
96
|
+
* Returns user data with `user_id`, `email`, `username`, and verification status.
|
|
97
|
+
* Email verification may be required based on space configuration.
|
|
98
|
+
*
|
|
99
|
+
* **Reference**: See `docs/AUTH_CONFIG_EXAMPLES.md` for complete configuration details.
|
|
100
|
+
*/
|
|
101
|
+
post: operations["createRegistration"];
|
|
102
|
+
delete?: never;
|
|
103
|
+
options?: never;
|
|
104
|
+
head?: never;
|
|
105
|
+
patch?: never;
|
|
106
|
+
trace?: never;
|
|
107
|
+
};
|
|
108
|
+
"/v1/auth/pre-registrations": {
|
|
109
|
+
parameters: {
|
|
110
|
+
query?: never;
|
|
111
|
+
header?: never;
|
|
112
|
+
path?: never;
|
|
113
|
+
cookie?: never;
|
|
114
|
+
};
|
|
115
|
+
get?: never;
|
|
116
|
+
put?: never;
|
|
117
|
+
/**
|
|
118
|
+
* Pre Verify Start
|
|
119
|
+
* @description **Step 1 of the pre-signup verification flow.**
|
|
120
|
+
*
|
|
121
|
+
* Sends an OTP to the supplied email or mobile number *before* account creation.
|
|
122
|
+
* The space must be configured with the appropriate verification timing:
|
|
123
|
+
* - `signup.verification.email.timing = "pre_signup"` for the email channel
|
|
124
|
+
* - `signup.verification.mobile.timing = "pre_signup"` for the sms channel
|
|
125
|
+
*
|
|
126
|
+
* **Flow**:
|
|
127
|
+
* 1. Validate space and confirm pre_signup timing is enabled for the channel
|
|
128
|
+
* 2. Generate a 6-digit OTP and store an anonymous session
|
|
129
|
+
* 3. Dispatch the OTP via email or SMS
|
|
130
|
+
* 4. Return `challenge_id` to use in `POST /v1/auth/pre-registrations/{challenge_id}/confirm`
|
|
131
|
+
*
|
|
132
|
+
* **Channel is auto-detected** from the supplied identity fields — no `channel` field needed:
|
|
133
|
+
* - Provide `email` → email channel
|
|
134
|
+
* - Provide `mobile_country_code` + `mobile_number` → sms channel
|
|
135
|
+
* - Providing both is rejected (ambiguous)
|
|
136
|
+
*
|
|
137
|
+
* **Example Request (email)**:
|
|
138
|
+
* ```json
|
|
139
|
+
* {
|
|
140
|
+
* "space_id": "spc_abc123",
|
|
141
|
+
* "email": "user@example.com"
|
|
142
|
+
* }
|
|
143
|
+
* ```
|
|
144
|
+
*
|
|
145
|
+
* **Example Request (mobile)**:
|
|
146
|
+
* ```json
|
|
147
|
+
* {
|
|
148
|
+
* "space_id": "spc_abc123",
|
|
149
|
+
* "mobile_country_code": "+91",
|
|
150
|
+
* "mobile_number": "9876543210"
|
|
151
|
+
* }
|
|
152
|
+
* ```
|
|
153
|
+
*
|
|
154
|
+
* **Example Response**:
|
|
155
|
+
* ```json
|
|
156
|
+
* {
|
|
157
|
+
* "challenge_id": "abc123...",
|
|
158
|
+
* "channel": "email",
|
|
159
|
+
* "recipient": "us***@example.com",
|
|
160
|
+
* "expires_in_seconds": 300
|
|
161
|
+
* }
|
|
162
|
+
* ```
|
|
163
|
+
*
|
|
164
|
+
* **Authentication**: None (public endpoint)
|
|
165
|
+
* **Rate Limit**: 10 requests per minute
|
|
166
|
+
*
|
|
167
|
+
* **Response Codes**:
|
|
168
|
+
* - 200: OTP sent, challenge_id returned
|
|
169
|
+
* - 400: Space not found, pre_signup timing not configured, or invalid input
|
|
170
|
+
* - 500: OTP dispatch failed
|
|
171
|
+
*/
|
|
172
|
+
post: operations["createPreRegistration"];
|
|
173
|
+
delete?: never;
|
|
174
|
+
options?: never;
|
|
175
|
+
head?: never;
|
|
176
|
+
patch?: never;
|
|
177
|
+
trace?: never;
|
|
178
|
+
};
|
|
179
|
+
"/v1/auth/pre-registrations/{challenge_id}/confirm": {
|
|
180
|
+
parameters: {
|
|
181
|
+
query?: never;
|
|
182
|
+
header?: never;
|
|
183
|
+
path?: never;
|
|
184
|
+
cookie?: never;
|
|
185
|
+
};
|
|
186
|
+
get?: never;
|
|
187
|
+
put?: never;
|
|
188
|
+
/**
|
|
189
|
+
* Pre Verify Confirm
|
|
190
|
+
* @description **Step 2 of the pre-signup verification flow.**
|
|
191
|
+
*
|
|
192
|
+
* Submits the OTP received from `POST /v1/auth/pre-registrations` and exchanges it for
|
|
193
|
+
* a short-lived `pre_verify_token` JWT (valid 15 minutes).
|
|
194
|
+
*
|
|
195
|
+
* Include `pre_verify_token` in the subsequent `POST /v1/auth/registrations` body
|
|
196
|
+
* to skip post-signup verification for the pre-verified channel.
|
|
197
|
+
*
|
|
198
|
+
* **Flow**:
|
|
199
|
+
* 1. Validate space and fetch the anonymous session by `challenge_id`
|
|
200
|
+
* 2. Verify the OTP using HMAC constant-time comparison
|
|
201
|
+
* 3. Transition session from `pending` to `verified`
|
|
202
|
+
* 4. Issue a `pre_verify_token` JWT encoding the verified identity
|
|
203
|
+
*
|
|
204
|
+
* **Example Request**:
|
|
205
|
+
* ```json
|
|
206
|
+
* {
|
|
207
|
+
* "space_id": "spc_abc123",
|
|
208
|
+
* "otp_code": "483921"
|
|
209
|
+
* }
|
|
210
|
+
* ```
|
|
211
|
+
*
|
|
212
|
+
* **Example Response**:
|
|
213
|
+
* ```json
|
|
214
|
+
* {
|
|
215
|
+
* "pre_verify_token": "eyJ...",
|
|
216
|
+
* "expires_in_seconds": 900,
|
|
217
|
+
* "channel": "email",
|
|
218
|
+
* "recipient": "us***@example.com"
|
|
219
|
+
* }
|
|
220
|
+
* ```
|
|
221
|
+
*
|
|
222
|
+
* **Authentication**: None (public endpoint)
|
|
223
|
+
* **Rate Limit**: 10 requests per minute
|
|
224
|
+
*
|
|
225
|
+
* **Response Codes**:
|
|
226
|
+
* - 200: OTP verified, pre_verify_token returned
|
|
227
|
+
* - 400: Invalid/expired OTP, session not found, max attempts exceeded
|
|
228
|
+
* - 500: Server error
|
|
229
|
+
*/
|
|
230
|
+
post: operations["confirmPreRegistration"];
|
|
231
|
+
delete?: never;
|
|
232
|
+
options?: never;
|
|
233
|
+
head?: never;
|
|
234
|
+
patch?: never;
|
|
235
|
+
trace?: never;
|
|
236
|
+
};
|
|
237
|
+
"/v1/auth/email-verifications": {
|
|
238
|
+
parameters: {
|
|
239
|
+
query?: never;
|
|
240
|
+
header?: never;
|
|
241
|
+
path?: never;
|
|
242
|
+
cookie?: never;
|
|
243
|
+
};
|
|
244
|
+
get?: never;
|
|
245
|
+
put?: never;
|
|
246
|
+
/**
|
|
247
|
+
* Verify Email
|
|
248
|
+
* @description Initiate email verification — sends the verification link or OTP to the user's email.
|
|
249
|
+
*
|
|
250
|
+
* Used when the space is configured with `verification.email.method = "email_link"`.
|
|
251
|
+
* The token is supplied by the user clicking the link in their email.
|
|
252
|
+
*
|
|
253
|
+
* **Authentication**: None (public endpoint)
|
|
254
|
+
*
|
|
255
|
+
* **Response Codes**:
|
|
256
|
+
* - 200: Email verified successfully
|
|
257
|
+
* - 400: Invalid or expired token
|
|
258
|
+
* - 500: Server error
|
|
259
|
+
*/
|
|
260
|
+
post: operations["createEmailVerification"];
|
|
261
|
+
delete?: never;
|
|
262
|
+
options?: never;
|
|
263
|
+
head?: never;
|
|
264
|
+
patch?: never;
|
|
265
|
+
trace?: never;
|
|
266
|
+
};
|
|
267
|
+
"/v1/auth/email-verifications/{challenge_id}/confirm": {
|
|
268
|
+
parameters: {
|
|
269
|
+
query?: never;
|
|
270
|
+
header?: never;
|
|
271
|
+
path?: never;
|
|
272
|
+
cookie?: never;
|
|
273
|
+
};
|
|
274
|
+
get?: never;
|
|
275
|
+
put?: never;
|
|
276
|
+
/**
|
|
277
|
+
* Confirm Email Verification
|
|
278
|
+
* @description Confirm email address by submitting the OTP code.
|
|
279
|
+
*
|
|
280
|
+
* Used when the space is configured with `verification.email.method = "email_otp"`.
|
|
281
|
+
* The `challenge_id` is returned in the registration response under `email_verification.challenge_id`.
|
|
282
|
+
*
|
|
283
|
+
* **Authentication**: None (public endpoint)
|
|
284
|
+
* **Rate Limit**: 10 requests per minute
|
|
285
|
+
*
|
|
286
|
+
* ## Request Body:
|
|
287
|
+
* ```json
|
|
288
|
+
* {
|
|
289
|
+
* "otp_code": "483921"
|
|
290
|
+
* }
|
|
291
|
+
* ```
|
|
292
|
+
*
|
|
293
|
+
* **Response Codes**:
|
|
294
|
+
* - 200: Email verified successfully
|
|
295
|
+
* - 400: Invalid or expired OTP code
|
|
296
|
+
* - 500: Server error
|
|
297
|
+
*/
|
|
298
|
+
post: operations["confirmEmailVerification"];
|
|
299
|
+
delete?: never;
|
|
300
|
+
options?: never;
|
|
301
|
+
head?: never;
|
|
302
|
+
patch?: never;
|
|
303
|
+
trace?: never;
|
|
304
|
+
};
|
|
305
|
+
"/v1/auth/email-verifications/{challenge_id}/resend": {
|
|
306
|
+
parameters: {
|
|
307
|
+
query?: never;
|
|
308
|
+
header?: never;
|
|
309
|
+
path?: never;
|
|
310
|
+
cookie?: never;
|
|
311
|
+
};
|
|
312
|
+
get?: never;
|
|
313
|
+
put?: never;
|
|
314
|
+
/**
|
|
315
|
+
* Resend Email Verification
|
|
316
|
+
* @description Resend the email verification link or OTP.
|
|
317
|
+
*
|
|
318
|
+
* **Authentication**: None (public endpoint)
|
|
319
|
+
* **Rate Limit**: 3 requests per hour
|
|
320
|
+
*
|
|
321
|
+
* **Response Codes**:
|
|
322
|
+
* - 200: Verification email resent
|
|
323
|
+
* - 400: Email not found or already verified
|
|
324
|
+
* - 500: Server error
|
|
325
|
+
*/
|
|
326
|
+
post: operations["resendEmailVerification"];
|
|
327
|
+
delete?: never;
|
|
328
|
+
options?: never;
|
|
329
|
+
head?: never;
|
|
330
|
+
patch?: never;
|
|
331
|
+
trace?: never;
|
|
332
|
+
};
|
|
333
|
+
"/v1/auth/mobile-verifications": {
|
|
334
|
+
parameters: {
|
|
335
|
+
query?: never;
|
|
336
|
+
header?: never;
|
|
337
|
+
path?: never;
|
|
338
|
+
cookie?: never;
|
|
339
|
+
};
|
|
340
|
+
get?: never;
|
|
341
|
+
put?: never;
|
|
342
|
+
/**
|
|
343
|
+
* Create Mobile Verification
|
|
344
|
+
* @description Send a mobile number verification OTP to the authenticated user's mobile number.
|
|
345
|
+
*
|
|
346
|
+
* **Authentication**: Required (JWT Bearer token)
|
|
347
|
+
* **Rate Limit**: 5 requests per hour
|
|
348
|
+
*
|
|
349
|
+
* The mobile number is read from the authenticated user's record in the database.
|
|
350
|
+
* If the user has no mobile number on record, returns 400.
|
|
351
|
+
*
|
|
352
|
+
* ## Response:
|
|
353
|
+
* Returns `challenge_id` (format: `otp_xxx`) to use in the confirm step.
|
|
354
|
+
*/
|
|
355
|
+
post: operations["createMobileVerification"];
|
|
356
|
+
delete?: never;
|
|
357
|
+
options?: never;
|
|
358
|
+
head?: never;
|
|
359
|
+
patch?: never;
|
|
360
|
+
trace?: never;
|
|
361
|
+
};
|
|
362
|
+
"/v1/auth/mobile-verifications/{challenge_id}/confirm": {
|
|
363
|
+
parameters: {
|
|
364
|
+
query?: never;
|
|
365
|
+
header?: never;
|
|
366
|
+
path?: never;
|
|
367
|
+
cookie?: never;
|
|
368
|
+
};
|
|
369
|
+
get?: never;
|
|
370
|
+
put?: never;
|
|
371
|
+
/**
|
|
372
|
+
* Confirm Mobile Verification
|
|
373
|
+
* @description Confirm mobile number by submitting the OTP sent via `POST /v1/auth/mobile-verifications`.
|
|
374
|
+
*
|
|
375
|
+
* **Authentication**: Required (JWT Bearer token)
|
|
376
|
+
* **Rate Limit**: 10 requests per hour
|
|
377
|
+
*
|
|
378
|
+
* ## Request Body:
|
|
379
|
+
* - `otp`: 4–8 digit OTP code sent to the user's mobile
|
|
380
|
+
*
|
|
381
|
+
* ## Response:
|
|
382
|
+
* Returns `verified: true` on success. The user's `mobile_verified` flag is updated.
|
|
383
|
+
*/
|
|
384
|
+
post: operations["confirmMobileVerification"];
|
|
385
|
+
delete?: never;
|
|
386
|
+
options?: never;
|
|
387
|
+
head?: never;
|
|
388
|
+
patch?: never;
|
|
389
|
+
trace?: never;
|
|
390
|
+
};
|
|
391
|
+
"/v1/auth/mobile-verifications/{challenge_id}/resend": {
|
|
392
|
+
parameters: {
|
|
393
|
+
query?: never;
|
|
394
|
+
header?: never;
|
|
395
|
+
path?: never;
|
|
396
|
+
cookie?: never;
|
|
397
|
+
};
|
|
398
|
+
get?: never;
|
|
399
|
+
put?: never;
|
|
400
|
+
/**
|
|
401
|
+
* Resend Mobile Verification
|
|
402
|
+
* @description Resend the mobile verification OTP.
|
|
403
|
+
*
|
|
404
|
+
* **Authentication**: Required (JWT Bearer token)
|
|
405
|
+
* **Rate Limit**: 3 requests per hour
|
|
406
|
+
*
|
|
407
|
+
* ## Response:
|
|
408
|
+
* Returns a new `challenge_id` and updated expiry time.
|
|
409
|
+
*/
|
|
410
|
+
post: operations["resendMobileVerification"];
|
|
411
|
+
delete?: never;
|
|
412
|
+
options?: never;
|
|
413
|
+
head?: never;
|
|
414
|
+
patch?: never;
|
|
415
|
+
trace?: never;
|
|
416
|
+
};
|
|
417
|
+
}
|
|
418
|
+
export type webhooks = Record<string, never>;
|
|
419
|
+
export interface components {
|
|
420
|
+
schemas: {
|
|
421
|
+
Extensions: {
|
|
422
|
+
/** @example GENERIC_ERROR */
|
|
423
|
+
message_code?: string;
|
|
424
|
+
/** @example [] */
|
|
425
|
+
invalid_params?: components["schemas"]["InvalidParam"][];
|
|
426
|
+
extra_data?: Record<string, never> | null;
|
|
427
|
+
/** @example Detailed debug information */
|
|
428
|
+
debug?: string | null;
|
|
429
|
+
};
|
|
430
|
+
/** Address */
|
|
431
|
+
Address: {
|
|
432
|
+
/** Address Line 1 */
|
|
433
|
+
address_line_1?: string | null;
|
|
434
|
+
/** Address Line 2 */
|
|
435
|
+
address_line_2?: string | null;
|
|
436
|
+
/** City */
|
|
437
|
+
city?: string | null;
|
|
438
|
+
/** State */
|
|
439
|
+
state?: string | null;
|
|
440
|
+
/** Country */
|
|
441
|
+
country?: string | null;
|
|
442
|
+
/** Postal Code */
|
|
443
|
+
postal_code?: string | null;
|
|
444
|
+
/** Nationality */
|
|
445
|
+
nationality?: string | null;
|
|
446
|
+
};
|
|
447
|
+
/** Contact */
|
|
448
|
+
Contact: {
|
|
449
|
+
/** Secondary Email */
|
|
450
|
+
secondary_email?: string | null;
|
|
451
|
+
/** Emergency Contact */
|
|
452
|
+
emergency_contact?: string | null;
|
|
453
|
+
};
|
|
454
|
+
/** Metadata */
|
|
455
|
+
"Metadata-Input": {
|
|
456
|
+
/** Invite Code */
|
|
457
|
+
invite_code?: string | null;
|
|
458
|
+
/**
|
|
459
|
+
* Invite Token
|
|
460
|
+
* @description Raw invite JWT from the email invitation link. When present, skips email OTP verification (invite email is proof of ownership).
|
|
461
|
+
*/
|
|
462
|
+
invite_token?: string | null;
|
|
463
|
+
/** Tracking Id */
|
|
464
|
+
tracking_id?: string | null;
|
|
465
|
+
/** Return Data */
|
|
466
|
+
return_data?: {
|
|
467
|
+
[key: string]: unknown;
|
|
468
|
+
} | null;
|
|
469
|
+
};
|
|
470
|
+
/**
|
|
471
|
+
* PreVerifyStartRequest
|
|
472
|
+
* @description Initiate a pre-signup OTP verification session.
|
|
473
|
+
*
|
|
474
|
+
* Supply exactly one identity: email OR mobile (not both).
|
|
475
|
+
* The channel is inferred automatically — clients do not send it.
|
|
476
|
+
*/
|
|
477
|
+
PreVerifyStartRequest: {
|
|
478
|
+
/** Space Id */
|
|
479
|
+
space_id: string;
|
|
480
|
+
/** Email */
|
|
481
|
+
email?: string | null;
|
|
482
|
+
/** Mobile Country Code */
|
|
483
|
+
mobile_country_code?: string | null;
|
|
484
|
+
/** Mobile Number */
|
|
485
|
+
mobile_number?: string | null;
|
|
486
|
+
/** Channel */
|
|
487
|
+
channel?: ("email" | "sms") | null;
|
|
488
|
+
};
|
|
489
|
+
/**
|
|
490
|
+
* @example {
|
|
491
|
+
* "status": "success",
|
|
492
|
+
* "message": "Operation successful",
|
|
493
|
+
* "message_code": "api_suc_20001",
|
|
494
|
+
* "data": {},
|
|
495
|
+
* "metadata": {
|
|
496
|
+
* "timestamp": "2026-03-26T10:00:00.000Z",
|
|
497
|
+
* "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
|
|
498
|
+
* "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
|
|
499
|
+
* "version": "v1",
|
|
500
|
+
* "executionTime": 42,
|
|
501
|
+
* "language": "en-US"
|
|
502
|
+
* }
|
|
503
|
+
* }
|
|
504
|
+
*/
|
|
505
|
+
StandardResponse: {
|
|
506
|
+
/** @example success */
|
|
507
|
+
status?: string;
|
|
508
|
+
data?: Record<string, never> | null;
|
|
509
|
+
/** @example Operation successful */
|
|
510
|
+
message?: string | null;
|
|
511
|
+
/** @example api_suc_20001 */
|
|
512
|
+
message_code?: string | null;
|
|
513
|
+
metadata?: Record<string, never> | null;
|
|
514
|
+
error?: components["schemas"]["ErrorResponse"];
|
|
515
|
+
};
|
|
516
|
+
InvalidParam: {
|
|
517
|
+
/** @example items[0].quantity */
|
|
518
|
+
field?: string;
|
|
519
|
+
/** @example Input should be greater than or equal to 1 */
|
|
520
|
+
error?: string;
|
|
521
|
+
};
|
|
522
|
+
ErrorResponse: {
|
|
523
|
+
/** @example about:blank */
|
|
524
|
+
type?: string;
|
|
525
|
+
/** @example GENERIC_ERROR */
|
|
526
|
+
code?: string;
|
|
527
|
+
/** @example Client Error */
|
|
528
|
+
title?: string;
|
|
529
|
+
/** @example 400 */
|
|
530
|
+
status?: number;
|
|
531
|
+
/** @example An error occurred */
|
|
532
|
+
detail?: string;
|
|
533
|
+
/** @example /v1/cart/items */
|
|
534
|
+
instance?: string;
|
|
535
|
+
extensions?: components["schemas"]["Extensions"];
|
|
536
|
+
};
|
|
537
|
+
/** HTTPValidationError */
|
|
538
|
+
HTTPValidationError: {
|
|
539
|
+
/** Detail */
|
|
540
|
+
detail?: components["schemas"]["ValidationError"][];
|
|
541
|
+
};
|
|
542
|
+
/** Consent */
|
|
543
|
+
Consent: {
|
|
544
|
+
/** Terms Accepted */
|
|
545
|
+
terms_accepted?: boolean | null;
|
|
546
|
+
/** Privacy Accepted */
|
|
547
|
+
privacy_accepted?: boolean | null;
|
|
548
|
+
/** Marketing Emails Accepted */
|
|
549
|
+
marketing_emails_accepted?: boolean | null;
|
|
550
|
+
/** Terms Version */
|
|
551
|
+
terms_version?: string | null;
|
|
552
|
+
/** Privacy Version */
|
|
553
|
+
privacy_version?: string | null;
|
|
554
|
+
};
|
|
555
|
+
/** RegisterRequest */
|
|
556
|
+
RegisterRequest: {
|
|
557
|
+
/** Email */
|
|
558
|
+
email?: string | null;
|
|
559
|
+
/** Username */
|
|
560
|
+
username?: string | null;
|
|
561
|
+
/** Password */
|
|
562
|
+
password?: string | null;
|
|
563
|
+
/** Confirm Password */
|
|
564
|
+
confirm_password?: string | null;
|
|
565
|
+
/** Space Id */
|
|
566
|
+
space_id: string;
|
|
567
|
+
/** Mobile Country Code */
|
|
568
|
+
mobile_country_code?: string | null;
|
|
569
|
+
/** Mobile Number */
|
|
570
|
+
mobile_number?: string | null;
|
|
571
|
+
/** Recaptcha Response */
|
|
572
|
+
recaptcha_response?: string | null;
|
|
573
|
+
/** Pre Verify Token */
|
|
574
|
+
pre_verify_token?: string | null;
|
|
575
|
+
profile?: components["schemas"]["Profile"];
|
|
576
|
+
contact?: components["schemas"]["Contact"];
|
|
577
|
+
address?: components["schemas"]["Address"];
|
|
578
|
+
preferences?: components["schemas"]["Preferences"];
|
|
579
|
+
metadata?: components["schemas"]["Metadata-Input"];
|
|
580
|
+
consent?: components["schemas"]["Consent"];
|
|
581
|
+
};
|
|
582
|
+
/** Preferences */
|
|
583
|
+
Preferences: {
|
|
584
|
+
/** Timezone */
|
|
585
|
+
timezone?: string | null;
|
|
586
|
+
/** Display Timezone */
|
|
587
|
+
display_timezone?: string | null;
|
|
588
|
+
/** Locale */
|
|
589
|
+
locale?: string | null;
|
|
590
|
+
};
|
|
591
|
+
/**
|
|
592
|
+
* MobileVerificationResendRequest
|
|
593
|
+
* @description Request to resend a mobile verification OTP.
|
|
594
|
+
*/
|
|
595
|
+
MobileVerificationResendRequest: {
|
|
596
|
+
/** Challenge Id */
|
|
597
|
+
challenge_id: string;
|
|
598
|
+
};
|
|
599
|
+
/**
|
|
600
|
+
* MobileVerificationVerifyRequest
|
|
601
|
+
* @description Request to verify a mobile number using the OTP that was sent.
|
|
602
|
+
*/
|
|
603
|
+
MobileVerificationVerifyRequest: {
|
|
604
|
+
/** Challenge Id */
|
|
605
|
+
challenge_id: string;
|
|
606
|
+
/** Otp */
|
|
607
|
+
otp: string;
|
|
608
|
+
};
|
|
609
|
+
/**
|
|
610
|
+
* PreVerifyConfirmRequest
|
|
611
|
+
* @description Confirm a pre-signup OTP and exchange for a pre_verify_token JWT.
|
|
612
|
+
*
|
|
613
|
+
* The pre_verify_token is short-lived (15 min) and must be included in
|
|
614
|
+
* the subsequent POST /auth/register body to skip post-signup verification
|
|
615
|
+
* for the pre-verified channel.
|
|
616
|
+
*/
|
|
617
|
+
PreVerifyConfirmRequest: {
|
|
618
|
+
/** Space Id */
|
|
619
|
+
space_id: string;
|
|
620
|
+
/** Challenge Id */
|
|
621
|
+
challenge_id: string;
|
|
622
|
+
/** Otp Code */
|
|
623
|
+
otp_code: string;
|
|
624
|
+
};
|
|
625
|
+
/**
|
|
626
|
+
* MobileVerificationSendRequest
|
|
627
|
+
* @description Request to send a mobile verification OTP.
|
|
628
|
+
*
|
|
629
|
+
* No body required — the authenticated user's mobile_isd_code + mobile_no
|
|
630
|
+
* is read from the database. If the user has no mobile on record, returns 400.
|
|
631
|
+
*/
|
|
632
|
+
MobileVerificationSendRequest: Record<string, never>;
|
|
633
|
+
/** ValidationError */
|
|
634
|
+
ValidationError: {
|
|
635
|
+
/** Location */
|
|
636
|
+
loc: (string | number)[];
|
|
637
|
+
/** Message */
|
|
638
|
+
msg: string;
|
|
639
|
+
/** Error Type */
|
|
640
|
+
type: string;
|
|
641
|
+
};
|
|
642
|
+
/** ResendVerificationRequest */
|
|
643
|
+
ResendVerificationRequest: {
|
|
644
|
+
/**
|
|
645
|
+
* Email
|
|
646
|
+
* Format: email
|
|
647
|
+
*/
|
|
648
|
+
email: string;
|
|
649
|
+
};
|
|
650
|
+
/** VerifyEmailRequest */
|
|
651
|
+
VerifyEmailRequest: {
|
|
652
|
+
/** Token */
|
|
653
|
+
token: string;
|
|
654
|
+
};
|
|
655
|
+
/**
|
|
656
|
+
* VerifyEmailOtpRequest
|
|
657
|
+
* @description Request body for POST /verify-email-otp (email_otp verification method).
|
|
658
|
+
*/
|
|
659
|
+
VerifyEmailOtpRequest: {
|
|
660
|
+
/** Challenge Id */
|
|
661
|
+
challenge_id: string;
|
|
662
|
+
/** Otp Code */
|
|
663
|
+
otp_code: string;
|
|
664
|
+
};
|
|
665
|
+
/** Profile */
|
|
666
|
+
Profile: {
|
|
667
|
+
/** First Name */
|
|
668
|
+
first_name?: string | null;
|
|
669
|
+
/** Last Name */
|
|
670
|
+
last_name?: string | null;
|
|
671
|
+
/** Nickname */
|
|
672
|
+
nickname?: string | null;
|
|
673
|
+
/** Date Of Birth */
|
|
674
|
+
date_of_birth?: string | null;
|
|
675
|
+
/** Gender */
|
|
676
|
+
gender?: string | null;
|
|
677
|
+
/** Preferred Language */
|
|
678
|
+
preferred_language?: string | null;
|
|
679
|
+
/** Location */
|
|
680
|
+
location?: string | null;
|
|
681
|
+
};
|
|
682
|
+
};
|
|
683
|
+
responses: never;
|
|
684
|
+
parameters: never;
|
|
685
|
+
requestBodies: never;
|
|
686
|
+
headers: never;
|
|
687
|
+
pathItems: never;
|
|
688
|
+
}
|
|
689
|
+
export type $defs = Record<string, never>;
|
|
690
|
+
export interface operations {
|
|
691
|
+
createRegistration: {
|
|
692
|
+
parameters: {
|
|
693
|
+
query?: never;
|
|
694
|
+
header?: never;
|
|
695
|
+
path?: never;
|
|
696
|
+
cookie?: never;
|
|
697
|
+
};
|
|
698
|
+
requestBody: {
|
|
699
|
+
content: {
|
|
700
|
+
"application/json": components["schemas"]["RegisterRequest"];
|
|
701
|
+
};
|
|
702
|
+
};
|
|
703
|
+
responses: {
|
|
704
|
+
/** @description Successful Response */
|
|
705
|
+
200: {
|
|
706
|
+
headers: {
|
|
707
|
+
[name: string]: unknown;
|
|
708
|
+
};
|
|
709
|
+
content: {
|
|
710
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
711
|
+
};
|
|
712
|
+
};
|
|
713
|
+
/** @description Validation Error */
|
|
714
|
+
422: {
|
|
715
|
+
headers: {
|
|
716
|
+
[name: string]: unknown;
|
|
717
|
+
};
|
|
718
|
+
content: {
|
|
719
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
720
|
+
};
|
|
721
|
+
};
|
|
722
|
+
};
|
|
723
|
+
};
|
|
724
|
+
createPreRegistration: {
|
|
725
|
+
parameters: {
|
|
726
|
+
query?: never;
|
|
727
|
+
header?: never;
|
|
728
|
+
path?: never;
|
|
729
|
+
cookie?: never;
|
|
730
|
+
};
|
|
731
|
+
requestBody: {
|
|
732
|
+
content: {
|
|
733
|
+
"application/json": components["schemas"]["PreVerifyStartRequest"];
|
|
734
|
+
};
|
|
735
|
+
};
|
|
736
|
+
responses: {
|
|
737
|
+
/** @description Successful Response */
|
|
738
|
+
200: {
|
|
739
|
+
headers: {
|
|
740
|
+
[name: string]: unknown;
|
|
741
|
+
};
|
|
742
|
+
content: {
|
|
743
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
744
|
+
};
|
|
745
|
+
};
|
|
746
|
+
/** @description Validation Error */
|
|
747
|
+
422: {
|
|
748
|
+
headers: {
|
|
749
|
+
[name: string]: unknown;
|
|
750
|
+
};
|
|
751
|
+
content: {
|
|
752
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
753
|
+
};
|
|
754
|
+
};
|
|
755
|
+
};
|
|
756
|
+
};
|
|
757
|
+
confirmPreRegistration: {
|
|
758
|
+
parameters: {
|
|
759
|
+
query?: never;
|
|
760
|
+
header?: never;
|
|
761
|
+
path: {
|
|
762
|
+
/** @description Challenge ID returned from POST /v1/auth/pre-registrations */
|
|
763
|
+
challenge_id: string;
|
|
764
|
+
};
|
|
765
|
+
cookie?: never;
|
|
766
|
+
};
|
|
767
|
+
requestBody: {
|
|
768
|
+
content: {
|
|
769
|
+
"application/json": components["schemas"]["PreVerifyConfirmRequest"];
|
|
770
|
+
};
|
|
771
|
+
};
|
|
772
|
+
responses: {
|
|
773
|
+
/** @description Successful Response */
|
|
774
|
+
200: {
|
|
775
|
+
headers: {
|
|
776
|
+
[name: string]: unknown;
|
|
777
|
+
};
|
|
778
|
+
content: {
|
|
779
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
780
|
+
};
|
|
781
|
+
};
|
|
782
|
+
/** @description Validation Error */
|
|
783
|
+
422: {
|
|
784
|
+
headers: {
|
|
785
|
+
[name: string]: unknown;
|
|
786
|
+
};
|
|
787
|
+
content: {
|
|
788
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
789
|
+
};
|
|
790
|
+
};
|
|
791
|
+
};
|
|
792
|
+
};
|
|
793
|
+
createEmailVerification: {
|
|
794
|
+
parameters: {
|
|
795
|
+
query?: never;
|
|
796
|
+
header?: never;
|
|
797
|
+
path?: never;
|
|
798
|
+
cookie?: never;
|
|
799
|
+
};
|
|
800
|
+
requestBody: {
|
|
801
|
+
content: {
|
|
802
|
+
"application/json": components["schemas"]["VerifyEmailRequest"];
|
|
803
|
+
};
|
|
804
|
+
};
|
|
805
|
+
responses: {
|
|
806
|
+
/** @description Successful Response */
|
|
807
|
+
200: {
|
|
808
|
+
headers: {
|
|
809
|
+
[name: string]: unknown;
|
|
810
|
+
};
|
|
811
|
+
content: {
|
|
812
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
813
|
+
};
|
|
814
|
+
};
|
|
815
|
+
/** @description Validation Error */
|
|
816
|
+
422: {
|
|
817
|
+
headers: {
|
|
818
|
+
[name: string]: unknown;
|
|
819
|
+
};
|
|
820
|
+
content: {
|
|
821
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
822
|
+
};
|
|
823
|
+
};
|
|
824
|
+
};
|
|
825
|
+
};
|
|
826
|
+
confirmEmailVerification: {
|
|
827
|
+
parameters: {
|
|
828
|
+
query?: never;
|
|
829
|
+
header?: never;
|
|
830
|
+
path: {
|
|
831
|
+
/** @description Challenge ID returned in the registration response under email_verification.challenge_id */
|
|
832
|
+
challenge_id: string;
|
|
833
|
+
};
|
|
834
|
+
cookie?: never;
|
|
835
|
+
};
|
|
836
|
+
requestBody: {
|
|
837
|
+
content: {
|
|
838
|
+
"application/json": components["schemas"]["VerifyEmailOtpRequest"];
|
|
839
|
+
};
|
|
840
|
+
};
|
|
841
|
+
responses: {
|
|
842
|
+
/** @description Successful Response */
|
|
843
|
+
200: {
|
|
844
|
+
headers: {
|
|
845
|
+
[name: string]: unknown;
|
|
846
|
+
};
|
|
847
|
+
content: {
|
|
848
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
849
|
+
};
|
|
850
|
+
};
|
|
851
|
+
/** @description Validation Error */
|
|
852
|
+
422: {
|
|
853
|
+
headers: {
|
|
854
|
+
[name: string]: unknown;
|
|
855
|
+
};
|
|
856
|
+
content: {
|
|
857
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
858
|
+
};
|
|
859
|
+
};
|
|
860
|
+
};
|
|
861
|
+
};
|
|
862
|
+
resendEmailVerification: {
|
|
863
|
+
parameters: {
|
|
864
|
+
query?: never;
|
|
865
|
+
header?: never;
|
|
866
|
+
path: {
|
|
867
|
+
/** @description Challenge ID from createEmailVerification response */
|
|
868
|
+
challenge_id: string;
|
|
869
|
+
};
|
|
870
|
+
cookie?: never;
|
|
871
|
+
};
|
|
872
|
+
requestBody: {
|
|
873
|
+
content: {
|
|
874
|
+
"application/json": components["schemas"]["ResendVerificationRequest"];
|
|
875
|
+
};
|
|
876
|
+
};
|
|
877
|
+
responses: {
|
|
878
|
+
/** @description Successful Response */
|
|
879
|
+
200: {
|
|
880
|
+
headers: {
|
|
881
|
+
[name: string]: unknown;
|
|
882
|
+
};
|
|
883
|
+
content: {
|
|
884
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
885
|
+
};
|
|
886
|
+
};
|
|
887
|
+
/** @description Validation Error */
|
|
888
|
+
422: {
|
|
889
|
+
headers: {
|
|
890
|
+
[name: string]: unknown;
|
|
891
|
+
};
|
|
892
|
+
content: {
|
|
893
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
894
|
+
};
|
|
895
|
+
};
|
|
896
|
+
};
|
|
897
|
+
};
|
|
898
|
+
createMobileVerification: {
|
|
899
|
+
parameters: {
|
|
900
|
+
query?: never;
|
|
901
|
+
header?: {
|
|
902
|
+
authorization?: string | null;
|
|
903
|
+
};
|
|
904
|
+
path?: never;
|
|
905
|
+
cookie?: never;
|
|
906
|
+
};
|
|
907
|
+
requestBody: {
|
|
908
|
+
content: {
|
|
909
|
+
"application/json": components["schemas"]["MobileVerificationSendRequest"];
|
|
910
|
+
};
|
|
911
|
+
};
|
|
912
|
+
responses: {
|
|
913
|
+
/** @description Successful Response */
|
|
914
|
+
200: {
|
|
915
|
+
headers: {
|
|
916
|
+
[name: string]: unknown;
|
|
917
|
+
};
|
|
918
|
+
content: {
|
|
919
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
920
|
+
};
|
|
921
|
+
};
|
|
922
|
+
/** @description Validation Error */
|
|
923
|
+
422: {
|
|
924
|
+
headers: {
|
|
925
|
+
[name: string]: unknown;
|
|
926
|
+
};
|
|
927
|
+
content: {
|
|
928
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
929
|
+
};
|
|
930
|
+
};
|
|
931
|
+
};
|
|
932
|
+
};
|
|
933
|
+
confirmMobileVerification: {
|
|
934
|
+
parameters: {
|
|
935
|
+
query?: never;
|
|
936
|
+
header?: {
|
|
937
|
+
authorization?: string | null;
|
|
938
|
+
};
|
|
939
|
+
path: {
|
|
940
|
+
/** @description Challenge ID returned from POST /v1/auth/mobile-verifications */
|
|
941
|
+
challenge_id: string;
|
|
942
|
+
};
|
|
943
|
+
cookie?: never;
|
|
944
|
+
};
|
|
945
|
+
requestBody: {
|
|
946
|
+
content: {
|
|
947
|
+
"application/json": components["schemas"]["MobileVerificationVerifyRequest"];
|
|
948
|
+
};
|
|
949
|
+
};
|
|
950
|
+
responses: {
|
|
951
|
+
/** @description Successful Response */
|
|
952
|
+
200: {
|
|
953
|
+
headers: {
|
|
954
|
+
[name: string]: unknown;
|
|
955
|
+
};
|
|
956
|
+
content: {
|
|
957
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
958
|
+
};
|
|
959
|
+
};
|
|
960
|
+
/** @description Validation Error */
|
|
961
|
+
422: {
|
|
962
|
+
headers: {
|
|
963
|
+
[name: string]: unknown;
|
|
964
|
+
};
|
|
965
|
+
content: {
|
|
966
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
967
|
+
};
|
|
968
|
+
};
|
|
969
|
+
};
|
|
970
|
+
};
|
|
971
|
+
resendMobileVerification: {
|
|
972
|
+
parameters: {
|
|
973
|
+
query?: never;
|
|
974
|
+
header?: {
|
|
975
|
+
authorization?: string | null;
|
|
976
|
+
};
|
|
977
|
+
path: {
|
|
978
|
+
/** @description Challenge ID from the original POST /v1/auth/mobile-verifications */
|
|
979
|
+
challenge_id: string;
|
|
980
|
+
};
|
|
981
|
+
cookie?: never;
|
|
982
|
+
};
|
|
983
|
+
requestBody: {
|
|
984
|
+
content: {
|
|
985
|
+
"application/json": components["schemas"]["MobileVerificationResendRequest"];
|
|
986
|
+
};
|
|
987
|
+
};
|
|
988
|
+
responses: {
|
|
989
|
+
/** @description Successful Response */
|
|
990
|
+
200: {
|
|
991
|
+
headers: {
|
|
992
|
+
[name: string]: unknown;
|
|
993
|
+
};
|
|
994
|
+
content: {
|
|
995
|
+
"application/json": components["schemas"]["StandardResponse"];
|
|
996
|
+
};
|
|
997
|
+
};
|
|
998
|
+
/** @description Validation Error */
|
|
999
|
+
422: {
|
|
1000
|
+
headers: {
|
|
1001
|
+
[name: string]: unknown;
|
|
1002
|
+
};
|
|
1003
|
+
content: {
|
|
1004
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
1005
|
+
};
|
|
1006
|
+
};
|
|
1007
|
+
};
|
|
1008
|
+
};
|
|
1009
|
+
}
|
|
1010
|
+
//# sourceMappingURL=generated.d.ts.map
|