@rasadov/lumoar-sdk 1.1.6 → 1.1.7
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/.openapi-generator/FILES +5 -0
- package/api.ts +494 -20
- package/dist/api.d.ts +304 -20
- package/dist/api.js +355 -20
- package/docs/ForgotPasswordSchema.md +23 -0
- package/docs/ResendOTPSchema.md +25 -0
- package/docs/ResetPasswordSchema.md +27 -0
- package/docs/SendOTPSchema.md +23 -0
- package/docs/UserApi.md +265 -5
- package/docs/VerifyEmailSchema.md +25 -0
- package/package.json +1 -1
package/docs/UserApi.md
CHANGED
|
@@ -6,14 +6,18 @@ All URIs are relative to *http://localhost*
|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**changePasswordV1UserPasswordChangePatch**](#changepasswordv1userpasswordchangepatch) | **PATCH** /v1/user/password/change | Change Password|
|
|
8
8
|
|[**deleteUserV1UserDeleteDelete**](#deleteuserv1userdeletedelete) | **DELETE** /v1/user/delete | Delete User|
|
|
9
|
+
|[**forgotPasswordV1UserForgotPasswordPost**](#forgotpasswordv1userforgotpasswordpost) | **POST** /v1/user/forgot-password | Forgot Password|
|
|
9
10
|
|[**getUserDashV1UserMeDashGet**](#getuserdashv1usermedashget) | **GET** /v1/user/me/dash | Get User Dash|
|
|
10
11
|
|[**getUserV1UserMeGet**](#getuserv1usermeget) | **GET** /v1/user/me | Get User|
|
|
12
|
+
|[**resendOtpV1UserResendOtpPost**](#resendotpv1userresendotppost) | **POST** /v1/user/resend-otp | Resend Otp|
|
|
13
|
+
|[**resetPasswordV1UserResetPasswordPost**](#resetpasswordv1userresetpasswordpost) | **POST** /v1/user/reset-password | Reset Password|
|
|
14
|
+
|[**sendVerificationEmailV1UserSendVerificationEmailPost**](#sendverificationemailv1usersendverificationemailpost) | **POST** /v1/user/send-verification-email | Send Verification Email|
|
|
11
15
|
|[**updateUserV1UserUpdatePatch**](#updateuserv1userupdatepatch) | **PATCH** /v1/user/update | Update User|
|
|
16
|
+
|[**verifyEmailV1UserVerifyEmailPost**](#verifyemailv1userverifyemailpost) | **POST** /v1/user/verify-email | Verify Email|
|
|
12
17
|
|
|
13
18
|
# **changePasswordV1UserPasswordChangePatch**
|
|
14
19
|
> Details changePasswordV1UserPasswordChangePatch(updatePassword)
|
|
15
20
|
|
|
16
|
-
Change user password
|
|
17
21
|
|
|
18
22
|
### Example
|
|
19
23
|
|
|
@@ -69,7 +73,6 @@ No authorization required
|
|
|
69
73
|
# **deleteUserV1UserDeleteDelete**
|
|
70
74
|
> Details deleteUserV1UserDeleteDelete()
|
|
71
75
|
|
|
72
|
-
Delete user
|
|
73
76
|
|
|
74
77
|
### Example
|
|
75
78
|
|
|
@@ -110,6 +113,58 @@ No authorization required
|
|
|
110
113
|
- **Accept**: application/json
|
|
111
114
|
|
|
112
115
|
|
|
116
|
+
### HTTP response details
|
|
117
|
+
| Status code | Description | Response headers |
|
|
118
|
+
|-------------|-------------|------------------|
|
|
119
|
+
|**200** | Successful Response | - |
|
|
120
|
+
|**422** | Validation Error | - |
|
|
121
|
+
|
|
122
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
123
|
+
|
|
124
|
+
# **forgotPasswordV1UserForgotPasswordPost**
|
|
125
|
+
> Details forgotPasswordV1UserForgotPasswordPost(forgotPasswordSchema)
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
### Example
|
|
129
|
+
|
|
130
|
+
```typescript
|
|
131
|
+
import {
|
|
132
|
+
UserApi,
|
|
133
|
+
Configuration,
|
|
134
|
+
ForgotPasswordSchema
|
|
135
|
+
} from './api';
|
|
136
|
+
|
|
137
|
+
const configuration = new Configuration();
|
|
138
|
+
const apiInstance = new UserApi(configuration);
|
|
139
|
+
|
|
140
|
+
let forgotPasswordSchema: ForgotPasswordSchema; //
|
|
141
|
+
|
|
142
|
+
const { status, data } = await apiInstance.forgotPasswordV1UserForgotPasswordPost(
|
|
143
|
+
forgotPasswordSchema
|
|
144
|
+
);
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
### Parameters
|
|
148
|
+
|
|
149
|
+
|Name | Type | Description | Notes|
|
|
150
|
+
|------------- | ------------- | ------------- | -------------|
|
|
151
|
+
| **forgotPasswordSchema** | **ForgotPasswordSchema**| | |
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
### Return type
|
|
155
|
+
|
|
156
|
+
**Details**
|
|
157
|
+
|
|
158
|
+
### Authorization
|
|
159
|
+
|
|
160
|
+
No authorization required
|
|
161
|
+
|
|
162
|
+
### HTTP request headers
|
|
163
|
+
|
|
164
|
+
- **Content-Type**: application/json
|
|
165
|
+
- **Accept**: application/json
|
|
166
|
+
|
|
167
|
+
|
|
113
168
|
### HTTP response details
|
|
114
169
|
| Status code | Description | Response headers |
|
|
115
170
|
|-------------|-------------|------------------|
|
|
@@ -121,7 +176,6 @@ No authorization required
|
|
|
121
176
|
# **getUserDashV1UserMeDashGet**
|
|
122
177
|
> UserWithRelations getUserDashV1UserMeDashGet()
|
|
123
178
|
|
|
124
|
-
Get current user with relations
|
|
125
179
|
|
|
126
180
|
### Example
|
|
127
181
|
|
|
@@ -173,7 +227,6 @@ No authorization required
|
|
|
173
227
|
# **getUserV1UserMeGet**
|
|
174
228
|
> UserInDBBase getUserV1UserMeGet()
|
|
175
229
|
|
|
176
|
-
Get current user
|
|
177
230
|
|
|
178
231
|
### Example
|
|
179
232
|
|
|
@@ -214,6 +267,162 @@ No authorization required
|
|
|
214
267
|
- **Accept**: application/json
|
|
215
268
|
|
|
216
269
|
|
|
270
|
+
### HTTP response details
|
|
271
|
+
| Status code | Description | Response headers |
|
|
272
|
+
|-------------|-------------|------------------|
|
|
273
|
+
|**200** | Successful Response | - |
|
|
274
|
+
|**422** | Validation Error | - |
|
|
275
|
+
|
|
276
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
277
|
+
|
|
278
|
+
# **resendOtpV1UserResendOtpPost**
|
|
279
|
+
> Details resendOtpV1UserResendOtpPost(resendOTPSchema)
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
### Example
|
|
283
|
+
|
|
284
|
+
```typescript
|
|
285
|
+
import {
|
|
286
|
+
UserApi,
|
|
287
|
+
Configuration,
|
|
288
|
+
ResendOTPSchema
|
|
289
|
+
} from './api';
|
|
290
|
+
|
|
291
|
+
const configuration = new Configuration();
|
|
292
|
+
const apiInstance = new UserApi(configuration);
|
|
293
|
+
|
|
294
|
+
let resendOTPSchema: ResendOTPSchema; //
|
|
295
|
+
|
|
296
|
+
const { status, data } = await apiInstance.resendOtpV1UserResendOtpPost(
|
|
297
|
+
resendOTPSchema
|
|
298
|
+
);
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
### Parameters
|
|
302
|
+
|
|
303
|
+
|Name | Type | Description | Notes|
|
|
304
|
+
|------------- | ------------- | ------------- | -------------|
|
|
305
|
+
| **resendOTPSchema** | **ResendOTPSchema**| | |
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
### Return type
|
|
309
|
+
|
|
310
|
+
**Details**
|
|
311
|
+
|
|
312
|
+
### Authorization
|
|
313
|
+
|
|
314
|
+
No authorization required
|
|
315
|
+
|
|
316
|
+
### HTTP request headers
|
|
317
|
+
|
|
318
|
+
- **Content-Type**: application/json
|
|
319
|
+
- **Accept**: application/json
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
### HTTP response details
|
|
323
|
+
| Status code | Description | Response headers |
|
|
324
|
+
|-------------|-------------|------------------|
|
|
325
|
+
|**200** | Successful Response | - |
|
|
326
|
+
|**422** | Validation Error | - |
|
|
327
|
+
|
|
328
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
329
|
+
|
|
330
|
+
# **resetPasswordV1UserResetPasswordPost**
|
|
331
|
+
> Details resetPasswordV1UserResetPasswordPost(resetPasswordSchema)
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
### Example
|
|
335
|
+
|
|
336
|
+
```typescript
|
|
337
|
+
import {
|
|
338
|
+
UserApi,
|
|
339
|
+
Configuration,
|
|
340
|
+
ResetPasswordSchema
|
|
341
|
+
} from './api';
|
|
342
|
+
|
|
343
|
+
const configuration = new Configuration();
|
|
344
|
+
const apiInstance = new UserApi(configuration);
|
|
345
|
+
|
|
346
|
+
let resetPasswordSchema: ResetPasswordSchema; //
|
|
347
|
+
|
|
348
|
+
const { status, data } = await apiInstance.resetPasswordV1UserResetPasswordPost(
|
|
349
|
+
resetPasswordSchema
|
|
350
|
+
);
|
|
351
|
+
```
|
|
352
|
+
|
|
353
|
+
### Parameters
|
|
354
|
+
|
|
355
|
+
|Name | Type | Description | Notes|
|
|
356
|
+
|------------- | ------------- | ------------- | -------------|
|
|
357
|
+
| **resetPasswordSchema** | **ResetPasswordSchema**| | |
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
### Return type
|
|
361
|
+
|
|
362
|
+
**Details**
|
|
363
|
+
|
|
364
|
+
### Authorization
|
|
365
|
+
|
|
366
|
+
No authorization required
|
|
367
|
+
|
|
368
|
+
### HTTP request headers
|
|
369
|
+
|
|
370
|
+
- **Content-Type**: application/json
|
|
371
|
+
- **Accept**: application/json
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
### HTTP response details
|
|
375
|
+
| Status code | Description | Response headers |
|
|
376
|
+
|-------------|-------------|------------------|
|
|
377
|
+
|**200** | Successful Response | - |
|
|
378
|
+
|**422** | Validation Error | - |
|
|
379
|
+
|
|
380
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
381
|
+
|
|
382
|
+
# **sendVerificationEmailV1UserSendVerificationEmailPost**
|
|
383
|
+
> Details sendVerificationEmailV1UserSendVerificationEmailPost(sendOTPSchema)
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
### Example
|
|
387
|
+
|
|
388
|
+
```typescript
|
|
389
|
+
import {
|
|
390
|
+
UserApi,
|
|
391
|
+
Configuration,
|
|
392
|
+
SendOTPSchema
|
|
393
|
+
} from './api';
|
|
394
|
+
|
|
395
|
+
const configuration = new Configuration();
|
|
396
|
+
const apiInstance = new UserApi(configuration);
|
|
397
|
+
|
|
398
|
+
let sendOTPSchema: SendOTPSchema; //
|
|
399
|
+
|
|
400
|
+
const { status, data } = await apiInstance.sendVerificationEmailV1UserSendVerificationEmailPost(
|
|
401
|
+
sendOTPSchema
|
|
402
|
+
);
|
|
403
|
+
```
|
|
404
|
+
|
|
405
|
+
### Parameters
|
|
406
|
+
|
|
407
|
+
|Name | Type | Description | Notes|
|
|
408
|
+
|------------- | ------------- | ------------- | -------------|
|
|
409
|
+
| **sendOTPSchema** | **SendOTPSchema**| | |
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
### Return type
|
|
413
|
+
|
|
414
|
+
**Details**
|
|
415
|
+
|
|
416
|
+
### Authorization
|
|
417
|
+
|
|
418
|
+
No authorization required
|
|
419
|
+
|
|
420
|
+
### HTTP request headers
|
|
421
|
+
|
|
422
|
+
- **Content-Type**: application/json
|
|
423
|
+
- **Accept**: application/json
|
|
424
|
+
|
|
425
|
+
|
|
217
426
|
### HTTP response details
|
|
218
427
|
| Status code | Description | Response headers |
|
|
219
428
|
|-------------|-------------|------------------|
|
|
@@ -225,7 +434,6 @@ No authorization required
|
|
|
225
434
|
# **updateUserV1UserUpdatePatch**
|
|
226
435
|
> Details updateUserV1UserUpdatePatch(userUpdate)
|
|
227
436
|
|
|
228
|
-
Update user
|
|
229
437
|
|
|
230
438
|
### Example
|
|
231
439
|
|
|
@@ -278,3 +486,55 @@ No authorization required
|
|
|
278
486
|
|
|
279
487
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
280
488
|
|
|
489
|
+
# **verifyEmailV1UserVerifyEmailPost**
|
|
490
|
+
> Details verifyEmailV1UserVerifyEmailPost(verifyEmailSchema)
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
### Example
|
|
494
|
+
|
|
495
|
+
```typescript
|
|
496
|
+
import {
|
|
497
|
+
UserApi,
|
|
498
|
+
Configuration,
|
|
499
|
+
VerifyEmailSchema
|
|
500
|
+
} from './api';
|
|
501
|
+
|
|
502
|
+
const configuration = new Configuration();
|
|
503
|
+
const apiInstance = new UserApi(configuration);
|
|
504
|
+
|
|
505
|
+
let verifyEmailSchema: VerifyEmailSchema; //
|
|
506
|
+
|
|
507
|
+
const { status, data } = await apiInstance.verifyEmailV1UserVerifyEmailPost(
|
|
508
|
+
verifyEmailSchema
|
|
509
|
+
);
|
|
510
|
+
```
|
|
511
|
+
|
|
512
|
+
### Parameters
|
|
513
|
+
|
|
514
|
+
|Name | Type | Description | Notes|
|
|
515
|
+
|------------- | ------------- | ------------- | -------------|
|
|
516
|
+
| **verifyEmailSchema** | **VerifyEmailSchema**| | |
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
### Return type
|
|
520
|
+
|
|
521
|
+
**Details**
|
|
522
|
+
|
|
523
|
+
### Authorization
|
|
524
|
+
|
|
525
|
+
No authorization required
|
|
526
|
+
|
|
527
|
+
### HTTP request headers
|
|
528
|
+
|
|
529
|
+
- **Content-Type**: application/json
|
|
530
|
+
- **Accept**: application/json
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
### HTTP response details
|
|
534
|
+
| Status code | Description | Response headers |
|
|
535
|
+
|-------------|-------------|------------------|
|
|
536
|
+
|**200** | Successful Response | - |
|
|
537
|
+
|**422** | Validation Error | - |
|
|
538
|
+
|
|
539
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
540
|
+
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# VerifyEmailSchema
|
|
2
|
+
|
|
3
|
+
Schema for email verification
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**email** | **string** | | [default to undefined]
|
|
10
|
+
**otp_code** | **string** | | [default to undefined]
|
|
11
|
+
**turnstile_token** | **string** | | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { VerifyEmailSchema } from './api';
|
|
17
|
+
|
|
18
|
+
const instance: VerifyEmailSchema = {
|
|
19
|
+
email,
|
|
20
|
+
otp_code,
|
|
21
|
+
turnstile_token,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|