@rasadov/lumoar-sdk 1.0.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.
- package/.openapi-generator/FILES +60 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/api.ts +5133 -0
- package/base.ts +86 -0
- package/common.ts +150 -0
- package/configuration.ts +228 -0
- package/dist/api.d.ts +3329 -0
- package/dist/api.js +3498 -0
- package/dist/base.d.ts +66 -0
- package/dist/base.js +60 -0
- package/dist/common.d.ts +65 -0
- package/dist/common.js +149 -0
- package/dist/configuration.d.ts +125 -0
- package/dist/configuration.js +124 -0
- package/dist/index.d.ts +13 -0
- package/dist/index.js +15 -0
- package/docs/AuthApi.md +560 -0
- package/docs/AuthenticationSuccess.md +25 -0
- package/docs/CheckoutSessionResponse.md +22 -0
- package/docs/CompanyApi.md +363 -0
- package/docs/CompanyCreate.md +44 -0
- package/docs/CompanyInDBBase.md +48 -0
- package/docs/CompanyUpdate.md +42 -0
- package/docs/CompanyWithControls.md +50 -0
- package/docs/CompanyWithRoles.md +50 -0
- package/docs/ComplianceGoal.md +8 -0
- package/docs/ControlStatus.md +18 -0
- package/docs/ControlWithEvidences.md +30 -0
- package/docs/ControlWithRelationships.md +32 -0
- package/docs/ControlsApi.md +124 -0
- package/docs/CustomerDoesNotExist.md +20 -0
- package/docs/CustomerPortalSession.md +20 -0
- package/docs/DefaultApi.md +183 -0
- package/docs/Details.md +20 -0
- package/docs/EvidenceApi.md +309 -0
- package/docs/EvidenceBase.md +40 -0
- package/docs/EvidenceFileSchema.md +32 -0
- package/docs/EvidenceTextSchema.md +24 -0
- package/docs/FileDownload.md +26 -0
- package/docs/FrameworkControlsBase.md +26 -0
- package/docs/GetControl.md +22 -0
- package/docs/HTTPValidationError.md +20 -0
- package/docs/InviteToCompany.md +24 -0
- package/docs/LoginSchema.md +25 -0
- package/docs/PaymentsApi.md +164 -0
- package/docs/PermissionType.md +14 -0
- package/docs/PoliciesApi.md +302 -0
- package/docs/PolicyCreate.md +26 -0
- package/docs/PolicyRead.md +32 -0
- package/docs/PolicyUpdate.md +24 -0
- package/docs/RegisterSchema.md +31 -0
- package/docs/RemoveFromCompany.md +22 -0
- package/docs/ResponseGetCheckoutSessionPaymentsCheckoutGet.md +24 -0
- package/docs/ResponseGetCustomerManagementSessionPaymentsCustomerManagementGet.md +22 -0
- package/docs/RolesApi.md +127 -0
- package/docs/RolesWithUser.md +22 -0
- package/docs/UpdateControlSchema.md +24 -0
- package/docs/UpdatePassword.md +22 -0
- package/docs/UserApi.md +280 -0
- package/docs/UserBase.md +24 -0
- package/docs/UserInDBBase.md +30 -0
- package/docs/UserPermissionsWithCompany.md +22 -0
- package/docs/UserRole.md +20 -0
- package/docs/UserUpdate.md +24 -0
- package/docs/UserWithRelations.md +28 -0
- package/docs/ValidationError.md +24 -0
- package/docs/ValidationErrorLocInner.md +18 -0
- package/git_push.sh +57 -0
- package/index.ts +18 -0
- package/openapitools.json +7 -0
- package/package.json +33 -0
- package/tsconfig.json +14 -0
package/docs/AuthApi.md
ADDED
|
@@ -0,0 +1,560 @@
|
|
|
1
|
+
# AuthApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**deleteSessionV1AuthSessionDelete**](#deletesessionv1authsessiondelete) | **DELETE** /v1/auth/session | Delete Session|
|
|
8
|
+
|[**deleteSessionsV1AuthSessionsDelete**](#deletesessionsv1authsessionsdelete) | **DELETE** /v1/auth/sessions | Delete Sessions|
|
|
9
|
+
|[**getSessionsV1AuthSessionsGet**](#getsessionsv1authsessionsget) | **GET** /v1/auth/sessions | Get Sessions|
|
|
10
|
+
|[**githubCallbackV1AuthGithubCallbackPost**](#githubcallbackv1authgithubcallbackpost) | **POST** /v1/auth/github/callback | Github Callback|
|
|
11
|
+
|[**githubLoginV1AuthGithubLoginGet**](#githubloginv1authgithubloginget) | **GET** /v1/auth/github/login | Github Login|
|
|
12
|
+
|[**googleCallbackV1AuthGoogleCallbackPost**](#googlecallbackv1authgooglecallbackpost) | **POST** /v1/auth/google/callback | Google Callback|
|
|
13
|
+
|[**googleLoginV1AuthGoogleLoginGet**](#googleloginv1authgoogleloginget) | **GET** /v1/auth/google/login | Google Login|
|
|
14
|
+
|[**loginV1AuthLoginPost**](#loginv1authloginpost) | **POST** /v1/auth/login | Login|
|
|
15
|
+
|[**logoutV1AuthLogoutPost**](#logoutv1authlogoutpost) | **POST** /v1/auth/logout | Logout|
|
|
16
|
+
|[**registerV1AuthRegisterPost**](#registerv1authregisterpost) | **POST** /v1/auth/register | Register|
|
|
17
|
+
|
|
18
|
+
# **deleteSessionV1AuthSessionDelete**
|
|
19
|
+
> Details deleteSessionV1AuthSessionDelete()
|
|
20
|
+
|
|
21
|
+
Delete user session
|
|
22
|
+
|
|
23
|
+
### Example
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
import {
|
|
27
|
+
AuthApi,
|
|
28
|
+
Configuration
|
|
29
|
+
} from './api';
|
|
30
|
+
|
|
31
|
+
const configuration = new Configuration();
|
|
32
|
+
const apiInstance = new AuthApi(configuration);
|
|
33
|
+
|
|
34
|
+
let sessionIdToDelete: string; // (optional) (default to undefined)
|
|
35
|
+
let sessionId: string; // (optional) (default to undefined)
|
|
36
|
+
|
|
37
|
+
const { status, data } = await apiInstance.deleteSessionV1AuthSessionDelete(
|
|
38
|
+
sessionIdToDelete,
|
|
39
|
+
sessionId
|
|
40
|
+
);
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### Parameters
|
|
44
|
+
|
|
45
|
+
|Name | Type | Description | Notes|
|
|
46
|
+
|------------- | ------------- | ------------- | -------------|
|
|
47
|
+
| **sessionIdToDelete** | [**string**] | | (optional) defaults to undefined|
|
|
48
|
+
| **sessionId** | [**string**] | | (optional) defaults to undefined|
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
### Return type
|
|
52
|
+
|
|
53
|
+
**Details**
|
|
54
|
+
|
|
55
|
+
### Authorization
|
|
56
|
+
|
|
57
|
+
No authorization required
|
|
58
|
+
|
|
59
|
+
### HTTP request headers
|
|
60
|
+
|
|
61
|
+
- **Content-Type**: Not defined
|
|
62
|
+
- **Accept**: application/json
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
### HTTP response details
|
|
66
|
+
| Status code | Description | Response headers |
|
|
67
|
+
|-------------|-------------|------------------|
|
|
68
|
+
|**200** | Successful Response | - |
|
|
69
|
+
|**422** | Validation Error | - |
|
|
70
|
+
|
|
71
|
+
[[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)
|
|
72
|
+
|
|
73
|
+
# **deleteSessionsV1AuthSessionsDelete**
|
|
74
|
+
> Details deleteSessionsV1AuthSessionsDelete()
|
|
75
|
+
|
|
76
|
+
Delete user sessions
|
|
77
|
+
|
|
78
|
+
### Example
|
|
79
|
+
|
|
80
|
+
```typescript
|
|
81
|
+
import {
|
|
82
|
+
AuthApi,
|
|
83
|
+
Configuration
|
|
84
|
+
} from './api';
|
|
85
|
+
|
|
86
|
+
const configuration = new Configuration();
|
|
87
|
+
const apiInstance = new AuthApi(configuration);
|
|
88
|
+
|
|
89
|
+
let sessionId: string; // (optional) (default to undefined)
|
|
90
|
+
|
|
91
|
+
const { status, data } = await apiInstance.deleteSessionsV1AuthSessionsDelete(
|
|
92
|
+
sessionId
|
|
93
|
+
);
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### Parameters
|
|
97
|
+
|
|
98
|
+
|Name | Type | Description | Notes|
|
|
99
|
+
|------------- | ------------- | ------------- | -------------|
|
|
100
|
+
| **sessionId** | [**string**] | | (optional) defaults to undefined|
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
### Return type
|
|
104
|
+
|
|
105
|
+
**Details**
|
|
106
|
+
|
|
107
|
+
### Authorization
|
|
108
|
+
|
|
109
|
+
No authorization required
|
|
110
|
+
|
|
111
|
+
### HTTP request headers
|
|
112
|
+
|
|
113
|
+
- **Content-Type**: Not defined
|
|
114
|
+
- **Accept**: application/json
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
### HTTP response details
|
|
118
|
+
| Status code | Description | Response headers |
|
|
119
|
+
|-------------|-------------|------------------|
|
|
120
|
+
|**200** | Successful Response | - |
|
|
121
|
+
|**422** | Validation Error | - |
|
|
122
|
+
|
|
123
|
+
[[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)
|
|
124
|
+
|
|
125
|
+
# **getSessionsV1AuthSessionsGet**
|
|
126
|
+
> Array<{ [key: string]: string | null; }> getSessionsV1AuthSessionsGet()
|
|
127
|
+
|
|
128
|
+
Get user sessions
|
|
129
|
+
|
|
130
|
+
### Example
|
|
131
|
+
|
|
132
|
+
```typescript
|
|
133
|
+
import {
|
|
134
|
+
AuthApi,
|
|
135
|
+
Configuration
|
|
136
|
+
} from './api';
|
|
137
|
+
|
|
138
|
+
const configuration = new Configuration();
|
|
139
|
+
const apiInstance = new AuthApi(configuration);
|
|
140
|
+
|
|
141
|
+
let sessionId: string; // (optional) (default to undefined)
|
|
142
|
+
|
|
143
|
+
const { status, data } = await apiInstance.getSessionsV1AuthSessionsGet(
|
|
144
|
+
sessionId
|
|
145
|
+
);
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
### Parameters
|
|
149
|
+
|
|
150
|
+
|Name | Type | Description | Notes|
|
|
151
|
+
|------------- | ------------- | ------------- | -------------|
|
|
152
|
+
| **sessionId** | [**string**] | | (optional) defaults to undefined|
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
### Return type
|
|
156
|
+
|
|
157
|
+
**Array<{ [key: string]: string | null; }>**
|
|
158
|
+
|
|
159
|
+
### Authorization
|
|
160
|
+
|
|
161
|
+
No authorization required
|
|
162
|
+
|
|
163
|
+
### HTTP request headers
|
|
164
|
+
|
|
165
|
+
- **Content-Type**: Not defined
|
|
166
|
+
- **Accept**: application/json
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
### HTTP response details
|
|
170
|
+
| Status code | Description | Response headers |
|
|
171
|
+
|-------------|-------------|------------------|
|
|
172
|
+
|**200** | Successful Response | - |
|
|
173
|
+
|**422** | Validation Error | - |
|
|
174
|
+
|
|
175
|
+
[[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)
|
|
176
|
+
|
|
177
|
+
# **githubCallbackV1AuthGithubCallbackPost**
|
|
178
|
+
> any githubCallbackV1AuthGithubCallbackPost()
|
|
179
|
+
|
|
180
|
+
Handles the callback from GitHub OAuth.
|
|
181
|
+
|
|
182
|
+
### Example
|
|
183
|
+
|
|
184
|
+
```typescript
|
|
185
|
+
import {
|
|
186
|
+
AuthApi,
|
|
187
|
+
Configuration
|
|
188
|
+
} from './api';
|
|
189
|
+
|
|
190
|
+
const configuration = new Configuration();
|
|
191
|
+
const apiInstance = new AuthApi(configuration);
|
|
192
|
+
|
|
193
|
+
let code: string; // (default to undefined)
|
|
194
|
+
let userAgent: string; // (optional) (default to undefined)
|
|
195
|
+
let cFConnectingIP: string; // (optional) (default to undefined)
|
|
196
|
+
let cFIPCountry: string; // (optional) (default to undefined)
|
|
197
|
+
|
|
198
|
+
const { status, data } = await apiInstance.githubCallbackV1AuthGithubCallbackPost(
|
|
199
|
+
code,
|
|
200
|
+
userAgent,
|
|
201
|
+
cFConnectingIP,
|
|
202
|
+
cFIPCountry
|
|
203
|
+
);
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
### Parameters
|
|
207
|
+
|
|
208
|
+
|Name | Type | Description | Notes|
|
|
209
|
+
|------------- | ------------- | ------------- | -------------|
|
|
210
|
+
| **code** | [**string**] | | defaults to undefined|
|
|
211
|
+
| **userAgent** | [**string**] | | (optional) defaults to undefined|
|
|
212
|
+
| **cFConnectingIP** | [**string**] | | (optional) defaults to undefined|
|
|
213
|
+
| **cFIPCountry** | [**string**] | | (optional) defaults to undefined|
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
### Return type
|
|
217
|
+
|
|
218
|
+
**any**
|
|
219
|
+
|
|
220
|
+
### Authorization
|
|
221
|
+
|
|
222
|
+
No authorization required
|
|
223
|
+
|
|
224
|
+
### HTTP request headers
|
|
225
|
+
|
|
226
|
+
- **Content-Type**: Not defined
|
|
227
|
+
- **Accept**: application/json
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
### HTTP response details
|
|
231
|
+
| Status code | Description | Response headers |
|
|
232
|
+
|-------------|-------------|------------------|
|
|
233
|
+
|**200** | Successful Response | - |
|
|
234
|
+
|**422** | Validation Error | - |
|
|
235
|
+
|
|
236
|
+
[[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)
|
|
237
|
+
|
|
238
|
+
# **githubLoginV1AuthGithubLoginGet**
|
|
239
|
+
> any githubLoginV1AuthGithubLoginGet()
|
|
240
|
+
|
|
241
|
+
Redirects to GitHub\'s OAuth consent screen.
|
|
242
|
+
|
|
243
|
+
### Example
|
|
244
|
+
|
|
245
|
+
```typescript
|
|
246
|
+
import {
|
|
247
|
+
AuthApi,
|
|
248
|
+
Configuration
|
|
249
|
+
} from './api';
|
|
250
|
+
|
|
251
|
+
const configuration = new Configuration();
|
|
252
|
+
const apiInstance = new AuthApi(configuration);
|
|
253
|
+
|
|
254
|
+
const { status, data } = await apiInstance.githubLoginV1AuthGithubLoginGet();
|
|
255
|
+
```
|
|
256
|
+
|
|
257
|
+
### Parameters
|
|
258
|
+
This endpoint does not have any parameters.
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
### Return type
|
|
262
|
+
|
|
263
|
+
**any**
|
|
264
|
+
|
|
265
|
+
### Authorization
|
|
266
|
+
|
|
267
|
+
No authorization required
|
|
268
|
+
|
|
269
|
+
### HTTP request headers
|
|
270
|
+
|
|
271
|
+
- **Content-Type**: Not defined
|
|
272
|
+
- **Accept**: application/json
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
### HTTP response details
|
|
276
|
+
| Status code | Description | Response headers |
|
|
277
|
+
|-------------|-------------|------------------|
|
|
278
|
+
|**200** | Successful Response | - |
|
|
279
|
+
|
|
280
|
+
[[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)
|
|
281
|
+
|
|
282
|
+
# **googleCallbackV1AuthGoogleCallbackPost**
|
|
283
|
+
> any googleCallbackV1AuthGoogleCallbackPost()
|
|
284
|
+
|
|
285
|
+
Handles the callback from Google OAuth.
|
|
286
|
+
|
|
287
|
+
### Example
|
|
288
|
+
|
|
289
|
+
```typescript
|
|
290
|
+
import {
|
|
291
|
+
AuthApi,
|
|
292
|
+
Configuration
|
|
293
|
+
} from './api';
|
|
294
|
+
|
|
295
|
+
const configuration = new Configuration();
|
|
296
|
+
const apiInstance = new AuthApi(configuration);
|
|
297
|
+
|
|
298
|
+
let code: string; // (default to undefined)
|
|
299
|
+
let userAgent: string; // (optional) (default to undefined)
|
|
300
|
+
let cFConnectingIP: string; // (optional) (default to undefined)
|
|
301
|
+
let cFIPCountry: string; // (optional) (default to undefined)
|
|
302
|
+
|
|
303
|
+
const { status, data } = await apiInstance.googleCallbackV1AuthGoogleCallbackPost(
|
|
304
|
+
code,
|
|
305
|
+
userAgent,
|
|
306
|
+
cFConnectingIP,
|
|
307
|
+
cFIPCountry
|
|
308
|
+
);
|
|
309
|
+
```
|
|
310
|
+
|
|
311
|
+
### Parameters
|
|
312
|
+
|
|
313
|
+
|Name | Type | Description | Notes|
|
|
314
|
+
|------------- | ------------- | ------------- | -------------|
|
|
315
|
+
| **code** | [**string**] | | defaults to undefined|
|
|
316
|
+
| **userAgent** | [**string**] | | (optional) defaults to undefined|
|
|
317
|
+
| **cFConnectingIP** | [**string**] | | (optional) defaults to undefined|
|
|
318
|
+
| **cFIPCountry** | [**string**] | | (optional) defaults to undefined|
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
### Return type
|
|
322
|
+
|
|
323
|
+
**any**
|
|
324
|
+
|
|
325
|
+
### Authorization
|
|
326
|
+
|
|
327
|
+
No authorization required
|
|
328
|
+
|
|
329
|
+
### HTTP request headers
|
|
330
|
+
|
|
331
|
+
- **Content-Type**: Not defined
|
|
332
|
+
- **Accept**: application/json
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
### HTTP response details
|
|
336
|
+
| Status code | Description | Response headers |
|
|
337
|
+
|-------------|-------------|------------------|
|
|
338
|
+
|**200** | Successful Response | - |
|
|
339
|
+
|**422** | Validation Error | - |
|
|
340
|
+
|
|
341
|
+
[[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)
|
|
342
|
+
|
|
343
|
+
# **googleLoginV1AuthGoogleLoginGet**
|
|
344
|
+
> any googleLoginV1AuthGoogleLoginGet()
|
|
345
|
+
|
|
346
|
+
Redirects to Google\'s OAuth consent screen.
|
|
347
|
+
|
|
348
|
+
### Example
|
|
349
|
+
|
|
350
|
+
```typescript
|
|
351
|
+
import {
|
|
352
|
+
AuthApi,
|
|
353
|
+
Configuration
|
|
354
|
+
} from './api';
|
|
355
|
+
|
|
356
|
+
const configuration = new Configuration();
|
|
357
|
+
const apiInstance = new AuthApi(configuration);
|
|
358
|
+
|
|
359
|
+
const { status, data } = await apiInstance.googleLoginV1AuthGoogleLoginGet();
|
|
360
|
+
```
|
|
361
|
+
|
|
362
|
+
### Parameters
|
|
363
|
+
This endpoint does not have any parameters.
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
### Return type
|
|
367
|
+
|
|
368
|
+
**any**
|
|
369
|
+
|
|
370
|
+
### Authorization
|
|
371
|
+
|
|
372
|
+
No authorization required
|
|
373
|
+
|
|
374
|
+
### HTTP request headers
|
|
375
|
+
|
|
376
|
+
- **Content-Type**: Not defined
|
|
377
|
+
- **Accept**: application/json
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
### HTTP response details
|
|
381
|
+
| Status code | Description | Response headers |
|
|
382
|
+
|-------------|-------------|------------------|
|
|
383
|
+
|**200** | Successful Response | - |
|
|
384
|
+
|
|
385
|
+
[[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)
|
|
386
|
+
|
|
387
|
+
# **loginV1AuthLoginPost**
|
|
388
|
+
> AuthenticationSuccess loginV1AuthLoginPost(loginSchema)
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
### Example
|
|
392
|
+
|
|
393
|
+
```typescript
|
|
394
|
+
import {
|
|
395
|
+
AuthApi,
|
|
396
|
+
Configuration,
|
|
397
|
+
LoginSchema
|
|
398
|
+
} from './api';
|
|
399
|
+
|
|
400
|
+
const configuration = new Configuration();
|
|
401
|
+
const apiInstance = new AuthApi(configuration);
|
|
402
|
+
|
|
403
|
+
let loginSchema: LoginSchema; //
|
|
404
|
+
let userAgent: string; // (optional) (default to undefined)
|
|
405
|
+
let cFConnectingIP: string; // (optional) (default to undefined)
|
|
406
|
+
let cFIPCountry: string; // (optional) (default to undefined)
|
|
407
|
+
|
|
408
|
+
const { status, data } = await apiInstance.loginV1AuthLoginPost(
|
|
409
|
+
loginSchema,
|
|
410
|
+
userAgent,
|
|
411
|
+
cFConnectingIP,
|
|
412
|
+
cFIPCountry
|
|
413
|
+
);
|
|
414
|
+
```
|
|
415
|
+
|
|
416
|
+
### Parameters
|
|
417
|
+
|
|
418
|
+
|Name | Type | Description | Notes|
|
|
419
|
+
|------------- | ------------- | ------------- | -------------|
|
|
420
|
+
| **loginSchema** | **LoginSchema**| | |
|
|
421
|
+
| **userAgent** | [**string**] | | (optional) defaults to undefined|
|
|
422
|
+
| **cFConnectingIP** | [**string**] | | (optional) defaults to undefined|
|
|
423
|
+
| **cFIPCountry** | [**string**] | | (optional) defaults to undefined|
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
### Return type
|
|
427
|
+
|
|
428
|
+
**AuthenticationSuccess**
|
|
429
|
+
|
|
430
|
+
### Authorization
|
|
431
|
+
|
|
432
|
+
No authorization required
|
|
433
|
+
|
|
434
|
+
### HTTP request headers
|
|
435
|
+
|
|
436
|
+
- **Content-Type**: application/json
|
|
437
|
+
- **Accept**: application/json
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
### HTTP response details
|
|
441
|
+
| Status code | Description | Response headers |
|
|
442
|
+
|-------------|-------------|------------------|
|
|
443
|
+
|**200** | Successful Response | - |
|
|
444
|
+
|**422** | Validation Error | - |
|
|
445
|
+
|
|
446
|
+
[[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)
|
|
447
|
+
|
|
448
|
+
# **logoutV1AuthLogoutPost**
|
|
449
|
+
> Details logoutV1AuthLogoutPost()
|
|
450
|
+
|
|
451
|
+
Logout user
|
|
452
|
+
|
|
453
|
+
### Example
|
|
454
|
+
|
|
455
|
+
```typescript
|
|
456
|
+
import {
|
|
457
|
+
AuthApi,
|
|
458
|
+
Configuration
|
|
459
|
+
} from './api';
|
|
460
|
+
|
|
461
|
+
const configuration = new Configuration();
|
|
462
|
+
const apiInstance = new AuthApi(configuration);
|
|
463
|
+
|
|
464
|
+
let sessionId: string; // (optional) (default to undefined)
|
|
465
|
+
|
|
466
|
+
const { status, data } = await apiInstance.logoutV1AuthLogoutPost(
|
|
467
|
+
sessionId
|
|
468
|
+
);
|
|
469
|
+
```
|
|
470
|
+
|
|
471
|
+
### Parameters
|
|
472
|
+
|
|
473
|
+
|Name | Type | Description | Notes|
|
|
474
|
+
|------------- | ------------- | ------------- | -------------|
|
|
475
|
+
| **sessionId** | [**string**] | | (optional) defaults to undefined|
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
### Return type
|
|
479
|
+
|
|
480
|
+
**Details**
|
|
481
|
+
|
|
482
|
+
### Authorization
|
|
483
|
+
|
|
484
|
+
No authorization required
|
|
485
|
+
|
|
486
|
+
### HTTP request headers
|
|
487
|
+
|
|
488
|
+
- **Content-Type**: Not defined
|
|
489
|
+
- **Accept**: application/json
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
### HTTP response details
|
|
493
|
+
| Status code | Description | Response headers |
|
|
494
|
+
|-------------|-------------|------------------|
|
|
495
|
+
|**200** | Successful Response | - |
|
|
496
|
+
|**422** | Validation Error | - |
|
|
497
|
+
|
|
498
|
+
[[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)
|
|
499
|
+
|
|
500
|
+
# **registerV1AuthRegisterPost**
|
|
501
|
+
> AuthenticationSuccess registerV1AuthRegisterPost(registerSchema)
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
### Example
|
|
505
|
+
|
|
506
|
+
```typescript
|
|
507
|
+
import {
|
|
508
|
+
AuthApi,
|
|
509
|
+
Configuration,
|
|
510
|
+
RegisterSchema
|
|
511
|
+
} from './api';
|
|
512
|
+
|
|
513
|
+
const configuration = new Configuration();
|
|
514
|
+
const apiInstance = new AuthApi(configuration);
|
|
515
|
+
|
|
516
|
+
let registerSchema: RegisterSchema; //
|
|
517
|
+
let userAgent: string; // (optional) (default to undefined)
|
|
518
|
+
let cFConnectingIP: string; // (optional) (default to undefined)
|
|
519
|
+
let cFIPCountry: string; // (optional) (default to undefined)
|
|
520
|
+
|
|
521
|
+
const { status, data } = await apiInstance.registerV1AuthRegisterPost(
|
|
522
|
+
registerSchema,
|
|
523
|
+
userAgent,
|
|
524
|
+
cFConnectingIP,
|
|
525
|
+
cFIPCountry
|
|
526
|
+
);
|
|
527
|
+
```
|
|
528
|
+
|
|
529
|
+
### Parameters
|
|
530
|
+
|
|
531
|
+
|Name | Type | Description | Notes|
|
|
532
|
+
|------------- | ------------- | ------------- | -------------|
|
|
533
|
+
| **registerSchema** | **RegisterSchema**| | |
|
|
534
|
+
| **userAgent** | [**string**] | | (optional) defaults to undefined|
|
|
535
|
+
| **cFConnectingIP** | [**string**] | | (optional) defaults to undefined|
|
|
536
|
+
| **cFIPCountry** | [**string**] | | (optional) defaults to undefined|
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
### Return type
|
|
540
|
+
|
|
541
|
+
**AuthenticationSuccess**
|
|
542
|
+
|
|
543
|
+
### Authorization
|
|
544
|
+
|
|
545
|
+
No authorization required
|
|
546
|
+
|
|
547
|
+
### HTTP request headers
|
|
548
|
+
|
|
549
|
+
- **Content-Type**: application/json
|
|
550
|
+
- **Accept**: application/json
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
### HTTP response details
|
|
554
|
+
| Status code | Description | Response headers |
|
|
555
|
+
|-------------|-------------|------------------|
|
|
556
|
+
|**200** | Successful Response | - |
|
|
557
|
+
|**422** | Validation Error | - |
|
|
558
|
+
|
|
559
|
+
[[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)
|
|
560
|
+
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# AuthenticationSuccess
|
|
2
|
+
|
|
3
|
+
Authentication success response schema. Attributes: - access_token: str - token_type: str - user_id: str - role: str
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**detail** | **{ [key: string]: string; }** | | [default to undefined]
|
|
10
|
+
**access_token** | **string** | | [default to undefined]
|
|
11
|
+
**user** | [**UserInDBBase**](UserInDBBase.md) | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { AuthenticationSuccess } from './api';
|
|
17
|
+
|
|
18
|
+
const instance: AuthenticationSuccess = {
|
|
19
|
+
detail,
|
|
20
|
+
access_token,
|
|
21
|
+
user,
|
|
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)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# CheckoutSessionResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**checkout_url** | **string** | | [default to undefined]
|
|
9
|
+
**session_id** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { CheckoutSessionResponse } from './api';
|
|
15
|
+
|
|
16
|
+
const instance: CheckoutSessionResponse = {
|
|
17
|
+
checkout_url,
|
|
18
|
+
session_id,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|