@palmetto/users-sdk 1.3.0 → 1.5.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/dist/__generated__/schema.d.ts +1154 -424
- package/dist/client.d.ts +108 -541
- package/dist/client.js +204 -5
- package/package.json +8 -8
|
@@ -1,17 +1,72 @@
|
|
|
1
1
|
export interface paths {
|
|
2
|
-
"/api/
|
|
2
|
+
"/api/auth/token": {
|
|
3
3
|
parameters: {
|
|
4
4
|
query?: never;
|
|
5
5
|
header?: never;
|
|
6
6
|
path?: never;
|
|
7
7
|
cookie?: never;
|
|
8
8
|
};
|
|
9
|
-
get
|
|
9
|
+
get?: never;
|
|
10
|
+
put?: never;
|
|
11
|
+
/** Get Auth Token */
|
|
12
|
+
post: operations["AuthController_generateToken"];
|
|
13
|
+
delete?: never;
|
|
14
|
+
options?: never;
|
|
15
|
+
head?: never;
|
|
16
|
+
patch?: never;
|
|
17
|
+
trace?: never;
|
|
18
|
+
};
|
|
19
|
+
"/api/organizations/{id}": {
|
|
20
|
+
parameters: {
|
|
21
|
+
query?: never;
|
|
22
|
+
header?: never;
|
|
23
|
+
path?: never;
|
|
24
|
+
cookie?: never;
|
|
25
|
+
};
|
|
26
|
+
/** Get Organization By ID */
|
|
27
|
+
get: operations["OrganizationsController_getOrganization"];
|
|
10
28
|
put?: never;
|
|
11
29
|
post?: never;
|
|
12
30
|
delete?: never;
|
|
13
31
|
options?: never;
|
|
14
32
|
head?: never;
|
|
33
|
+
/** Update Organization By ID */
|
|
34
|
+
patch: operations["OrganizationsController_update"];
|
|
35
|
+
trace?: never;
|
|
36
|
+
};
|
|
37
|
+
"/api/organizations": {
|
|
38
|
+
parameters: {
|
|
39
|
+
query?: never;
|
|
40
|
+
header?: never;
|
|
41
|
+
path?: never;
|
|
42
|
+
cookie?: never;
|
|
43
|
+
};
|
|
44
|
+
get?: never;
|
|
45
|
+
put?: never;
|
|
46
|
+
/** Create Organization */
|
|
47
|
+
post: operations["OrganizationsController_create"];
|
|
48
|
+
delete?: never;
|
|
49
|
+
options?: never;
|
|
50
|
+
head?: never;
|
|
51
|
+
patch?: never;
|
|
52
|
+
trace?: never;
|
|
53
|
+
};
|
|
54
|
+
"/api/organizations/{id}/grants": {
|
|
55
|
+
parameters: {
|
|
56
|
+
query?: never;
|
|
57
|
+
header?: never;
|
|
58
|
+
path?: never;
|
|
59
|
+
cookie?: never;
|
|
60
|
+
};
|
|
61
|
+
/** Get Organization Grants By ID */
|
|
62
|
+
get: operations["OrganizationsController_getOrganizationGrants"];
|
|
63
|
+
put?: never;
|
|
64
|
+
/** Create Grant For Organization */
|
|
65
|
+
post: operations["OrganizationsController_addGrant"];
|
|
66
|
+
/** Remove Grant From Organization */
|
|
67
|
+
delete: operations["OrganizationsController_removeGrant"];
|
|
68
|
+
options?: never;
|
|
69
|
+
head?: never;
|
|
15
70
|
patch?: never;
|
|
16
71
|
trace?: never;
|
|
17
72
|
};
|
|
@@ -135,7 +190,8 @@ export interface paths {
|
|
|
135
190
|
path?: never;
|
|
136
191
|
cookie?: never;
|
|
137
192
|
};
|
|
138
|
-
|
|
193
|
+
/** Get grants */
|
|
194
|
+
get: operations["UsersController_getGrants"];
|
|
139
195
|
put?: never;
|
|
140
196
|
/** Create Grant For User */
|
|
141
197
|
post: operations["UsersController_addGrant"];
|
|
@@ -164,68 +220,84 @@ export interface paths {
|
|
|
164
220
|
patch: operations["UsersV2Controller_updateMe"];
|
|
165
221
|
trace?: never;
|
|
166
222
|
};
|
|
167
|
-
"/api/
|
|
223
|
+
"/api/roles": {
|
|
168
224
|
parameters: {
|
|
169
225
|
query?: never;
|
|
170
226
|
header?: never;
|
|
171
227
|
path?: never;
|
|
172
228
|
cookie?: never;
|
|
173
229
|
};
|
|
174
|
-
/** Get
|
|
175
|
-
get: operations["
|
|
230
|
+
/** Get roles */
|
|
231
|
+
get: operations["RolesController_findAll"];
|
|
232
|
+
put?: never;
|
|
233
|
+
/** Create a new role */
|
|
234
|
+
post: operations["RolesController_create"];
|
|
235
|
+
delete?: never;
|
|
236
|
+
options?: never;
|
|
237
|
+
head?: never;
|
|
238
|
+
patch?: never;
|
|
239
|
+
trace?: never;
|
|
240
|
+
};
|
|
241
|
+
"/api/roles/{id}": {
|
|
242
|
+
parameters: {
|
|
243
|
+
query?: never;
|
|
244
|
+
header?: never;
|
|
245
|
+
path?: never;
|
|
246
|
+
cookie?: never;
|
|
247
|
+
};
|
|
248
|
+
/** Find role */
|
|
249
|
+
get: operations["RolesController_findOne"];
|
|
176
250
|
put?: never;
|
|
177
251
|
post?: never;
|
|
178
252
|
delete?: never;
|
|
179
253
|
options?: never;
|
|
180
254
|
head?: never;
|
|
181
|
-
|
|
182
|
-
patch: operations["OrganizationsController_update"];
|
|
255
|
+
patch?: never;
|
|
183
256
|
trace?: never;
|
|
184
257
|
};
|
|
185
|
-
"/api/
|
|
258
|
+
"/api/health": {
|
|
186
259
|
parameters: {
|
|
187
260
|
query?: never;
|
|
188
261
|
header?: never;
|
|
189
262
|
path?: never;
|
|
190
263
|
cookie?: never;
|
|
191
264
|
};
|
|
192
|
-
get
|
|
265
|
+
get: operations["HealthController_getHealth"];
|
|
193
266
|
put?: never;
|
|
194
|
-
|
|
195
|
-
post: operations["OrganizationsController_create"];
|
|
267
|
+
post?: never;
|
|
196
268
|
delete?: never;
|
|
197
269
|
options?: never;
|
|
198
270
|
head?: never;
|
|
199
271
|
patch?: never;
|
|
200
272
|
trace?: never;
|
|
201
273
|
};
|
|
202
|
-
"/api/
|
|
274
|
+
"/api/sign-ups": {
|
|
203
275
|
parameters: {
|
|
204
276
|
query?: never;
|
|
205
277
|
header?: never;
|
|
206
278
|
path?: never;
|
|
207
279
|
cookie?: never;
|
|
208
280
|
};
|
|
209
|
-
/** Get
|
|
210
|
-
get: operations["
|
|
281
|
+
/** Get pending sign-ups */
|
|
282
|
+
get: operations["SignUpsController_findAll"];
|
|
211
283
|
put?: never;
|
|
212
|
-
/** Create
|
|
213
|
-
post: operations["
|
|
284
|
+
/** Create sign-up */
|
|
285
|
+
post: operations["SignUpsController_create"];
|
|
214
286
|
delete?: never;
|
|
215
287
|
options?: never;
|
|
216
288
|
head?: never;
|
|
217
289
|
patch?: never;
|
|
218
290
|
trace?: never;
|
|
219
291
|
};
|
|
220
|
-
"/api/
|
|
292
|
+
"/api/sign-ups/{token}": {
|
|
221
293
|
parameters: {
|
|
222
294
|
query?: never;
|
|
223
295
|
header?: never;
|
|
224
296
|
path?: never;
|
|
225
297
|
cookie?: never;
|
|
226
298
|
};
|
|
227
|
-
/** Find
|
|
228
|
-
get: operations["
|
|
299
|
+
/** Find sign-up */
|
|
300
|
+
get: operations["SignUpsController_findOne"];
|
|
229
301
|
put?: never;
|
|
230
302
|
post?: never;
|
|
231
303
|
delete?: never;
|
|
@@ -234,7 +306,7 @@ export interface paths {
|
|
|
234
306
|
patch?: never;
|
|
235
307
|
trace?: never;
|
|
236
308
|
};
|
|
237
|
-
"/api/
|
|
309
|
+
"/api/sign-ups/{token}/user": {
|
|
238
310
|
parameters: {
|
|
239
311
|
query?: never;
|
|
240
312
|
header?: never;
|
|
@@ -243,41 +315,58 @@ export interface paths {
|
|
|
243
315
|
};
|
|
244
316
|
get?: never;
|
|
245
317
|
put?: never;
|
|
246
|
-
/**
|
|
247
|
-
post: operations["
|
|
318
|
+
/** Create user with sign-up token */
|
|
319
|
+
post: operations["SignUpsController_createUser"];
|
|
248
320
|
delete?: never;
|
|
249
321
|
options?: never;
|
|
250
322
|
head?: never;
|
|
251
323
|
patch?: never;
|
|
252
324
|
trace?: never;
|
|
253
325
|
};
|
|
254
|
-
"/api/sign-ups": {
|
|
326
|
+
"/api/sign-ups/{id}": {
|
|
255
327
|
parameters: {
|
|
256
328
|
query?: never;
|
|
257
329
|
header?: never;
|
|
258
330
|
path?: never;
|
|
259
331
|
cookie?: never;
|
|
260
332
|
};
|
|
261
|
-
|
|
262
|
-
get: operations["SignUpsController_findAll"];
|
|
333
|
+
get?: never;
|
|
263
334
|
put?: never;
|
|
264
|
-
|
|
265
|
-
|
|
335
|
+
post?: never;
|
|
336
|
+
/** Delete sign-up */
|
|
337
|
+
delete: operations["SignUpsController_delete"];
|
|
338
|
+
options?: never;
|
|
339
|
+
head?: never;
|
|
340
|
+
patch?: never;
|
|
341
|
+
trace?: never;
|
|
342
|
+
};
|
|
343
|
+
"/api/services": {
|
|
344
|
+
parameters: {
|
|
345
|
+
query?: never;
|
|
346
|
+
header?: never;
|
|
347
|
+
path?: never;
|
|
348
|
+
cookie?: never;
|
|
349
|
+
};
|
|
350
|
+
/** Get all services */
|
|
351
|
+
get: operations["ServicesController_findAll"];
|
|
352
|
+
put?: never;
|
|
353
|
+
/** Create a new service */
|
|
354
|
+
post: operations["ServicesController_create"];
|
|
266
355
|
delete?: never;
|
|
267
356
|
options?: never;
|
|
268
357
|
head?: never;
|
|
269
358
|
patch?: never;
|
|
270
359
|
trace?: never;
|
|
271
360
|
};
|
|
272
|
-
"/api/
|
|
361
|
+
"/api/services/{key}": {
|
|
273
362
|
parameters: {
|
|
274
363
|
query?: never;
|
|
275
364
|
header?: never;
|
|
276
365
|
path?: never;
|
|
277
366
|
cookie?: never;
|
|
278
367
|
};
|
|
279
|
-
/**
|
|
280
|
-
get: operations["
|
|
368
|
+
/** Get a service */
|
|
369
|
+
get: operations["ServicesController_findOne"];
|
|
281
370
|
put?: never;
|
|
282
371
|
post?: never;
|
|
283
372
|
delete?: never;
|
|
@@ -286,7 +375,7 @@ export interface paths {
|
|
|
286
375
|
patch?: never;
|
|
287
376
|
trace?: never;
|
|
288
377
|
};
|
|
289
|
-
"/api/
|
|
378
|
+
"/api/services/{key}/entities": {
|
|
290
379
|
parameters: {
|
|
291
380
|
query?: never;
|
|
292
381
|
header?: never;
|
|
@@ -295,15 +384,15 @@ export interface paths {
|
|
|
295
384
|
};
|
|
296
385
|
get?: never;
|
|
297
386
|
put?: never;
|
|
298
|
-
/**
|
|
299
|
-
post: operations["
|
|
387
|
+
/** Add an entity to a service */
|
|
388
|
+
post: operations["ServicesController_createServiceEntity"];
|
|
300
389
|
delete?: never;
|
|
301
390
|
options?: never;
|
|
302
391
|
head?: never;
|
|
303
392
|
patch?: never;
|
|
304
393
|
trace?: never;
|
|
305
394
|
};
|
|
306
|
-
"/api/
|
|
395
|
+
"/api/services/{key}/entities/{entityKey}": {
|
|
307
396
|
parameters: {
|
|
308
397
|
query?: never;
|
|
309
398
|
header?: never;
|
|
@@ -312,9 +401,9 @@ export interface paths {
|
|
|
312
401
|
};
|
|
313
402
|
get?: never;
|
|
314
403
|
put?: never;
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
delete
|
|
404
|
+
/** Add an operation to a service entity */
|
|
405
|
+
post: operations["ServicesController_createServiceEntityOperation"];
|
|
406
|
+
delete?: never;
|
|
318
407
|
options?: never;
|
|
319
408
|
head?: never;
|
|
320
409
|
patch?: never;
|
|
@@ -341,6 +430,73 @@ export interface paths {
|
|
|
341
430
|
export type webhooks = Record<string, never>;
|
|
342
431
|
export interface components {
|
|
343
432
|
schemas: {
|
|
433
|
+
/** TokenInput */
|
|
434
|
+
TokenInputDto: {
|
|
435
|
+
/** @enum {string} */
|
|
436
|
+
grant_type: "authorization_code";
|
|
437
|
+
code: string;
|
|
438
|
+
/**
|
|
439
|
+
* @deprecated
|
|
440
|
+
* @description Obtain access tokens without verifying that the user exists
|
|
441
|
+
*/
|
|
442
|
+
skip_user_verification?: boolean;
|
|
443
|
+
} | {
|
|
444
|
+
/** @enum {string} */
|
|
445
|
+
grant_type: "refresh_token";
|
|
446
|
+
refresh_token: string;
|
|
447
|
+
};
|
|
448
|
+
/** TokenResponse */
|
|
449
|
+
TokenResponseDto: {
|
|
450
|
+
access_token: string;
|
|
451
|
+
id_token: string;
|
|
452
|
+
refresh_token: string;
|
|
453
|
+
expires_in: number;
|
|
454
|
+
};
|
|
455
|
+
/** BadRequestError */
|
|
456
|
+
BadRequestErrorDto: {
|
|
457
|
+
/**
|
|
458
|
+
* @example BadRequest
|
|
459
|
+
* @enum {string}
|
|
460
|
+
*/
|
|
461
|
+
error: "BadRequest";
|
|
462
|
+
/**
|
|
463
|
+
* @example 400
|
|
464
|
+
* @enum {number}
|
|
465
|
+
*/
|
|
466
|
+
statusCode: 400;
|
|
467
|
+
/** @example Request is invalid */
|
|
468
|
+
message: string;
|
|
469
|
+
/** @example Technical error description */
|
|
470
|
+
reason: string;
|
|
471
|
+
/** @example {
|
|
472
|
+
* "name": [
|
|
473
|
+
* "is required"
|
|
474
|
+
* ],
|
|
475
|
+
* "postalCode": [
|
|
476
|
+
* "must be a string of 5 numbers"
|
|
477
|
+
* ]
|
|
478
|
+
* } */
|
|
479
|
+
validations: {
|
|
480
|
+
[key: string]: string[];
|
|
481
|
+
};
|
|
482
|
+
};
|
|
483
|
+
/** NotFoundError */
|
|
484
|
+
NotFoundErrorDto: {
|
|
485
|
+
/**
|
|
486
|
+
* @example NotFound
|
|
487
|
+
* @enum {string}
|
|
488
|
+
*/
|
|
489
|
+
error: "NotFound";
|
|
490
|
+
/**
|
|
491
|
+
* @example 404
|
|
492
|
+
* @enum {number}
|
|
493
|
+
*/
|
|
494
|
+
statusCode: 404;
|
|
495
|
+
/** @example The requested entity was not found */
|
|
496
|
+
message: string;
|
|
497
|
+
/** @example Technical error description */
|
|
498
|
+
reason: string;
|
|
499
|
+
};
|
|
344
500
|
/** UnauthorizedError */
|
|
345
501
|
UnauthorizedErrorDto: {
|
|
346
502
|
/**
|
|
@@ -358,8 +514,8 @@ export interface components {
|
|
|
358
514
|
/** @example Technical error description */
|
|
359
515
|
reason: string;
|
|
360
516
|
};
|
|
361
|
-
/**
|
|
362
|
-
|
|
517
|
+
/** Organization */
|
|
518
|
+
OrganizationDto: {
|
|
363
519
|
/** @example 66e25e72d10dfef2f9f6cc60 */
|
|
364
520
|
id: string;
|
|
365
521
|
meta: {
|
|
@@ -377,30 +533,13 @@ export interface components {
|
|
|
377
533
|
updatedAt?: string;
|
|
378
534
|
};
|
|
379
535
|
/**
|
|
380
|
-
* @
|
|
381
|
-
* @
|
|
382
|
-
* @example auth0|1234567890
|
|
383
|
-
*/
|
|
384
|
-
auth0Id: string | null;
|
|
385
|
-
/**
|
|
386
|
-
* Format: email
|
|
387
|
-
* @description Email
|
|
388
|
-
* @example test@test.com
|
|
389
|
-
*/
|
|
390
|
-
email: string;
|
|
391
|
-
/**
|
|
392
|
-
* @description First name
|
|
393
|
-
* @example John
|
|
394
|
-
*/
|
|
395
|
-
firstName: string;
|
|
396
|
-
/**
|
|
397
|
-
* @description Last name
|
|
398
|
-
* @example Doe
|
|
536
|
+
* @description Name
|
|
537
|
+
* @example Palmetto
|
|
399
538
|
*/
|
|
400
|
-
|
|
539
|
+
name: string;
|
|
401
540
|
/**
|
|
402
541
|
* @deprecated
|
|
403
|
-
* @description
|
|
542
|
+
* @description Organization permissions
|
|
404
543
|
* @example {
|
|
405
544
|
* "photon:blueprint": [
|
|
406
545
|
* "read",
|
|
@@ -411,21 +550,6 @@ export interface components {
|
|
|
411
550
|
permissions: {
|
|
412
551
|
[key: string]: string[];
|
|
413
552
|
};
|
|
414
|
-
/**
|
|
415
|
-
* @description Phone number
|
|
416
|
-
* @example +18048675309
|
|
417
|
-
*/
|
|
418
|
-
phoneNumber: string;
|
|
419
|
-
/**
|
|
420
|
-
* @description Organization ID
|
|
421
|
-
* @example 66e3367b141b81fb54ec4e1f
|
|
422
|
-
*/
|
|
423
|
-
organizationId: string;
|
|
424
|
-
/**
|
|
425
|
-
* @description Has Personal Access Token
|
|
426
|
-
* @example false
|
|
427
|
-
*/
|
|
428
|
-
hasPAT: boolean;
|
|
429
553
|
};
|
|
430
554
|
/** ForbiddenError */
|
|
431
555
|
ForbiddenErrorDto: {
|
|
@@ -444,51 +568,201 @@ export interface components {
|
|
|
444
568
|
/** @example Technical error description */
|
|
445
569
|
reason: string;
|
|
446
570
|
};
|
|
447
|
-
/**
|
|
448
|
-
|
|
449
|
-
/**
|
|
571
|
+
/** CreateOrganization */
|
|
572
|
+
CreateOrganizationDto: {
|
|
573
|
+
/**
|
|
574
|
+
* @description Name
|
|
575
|
+
* @example Organization Name
|
|
576
|
+
*/
|
|
577
|
+
name: string;
|
|
578
|
+
/**
|
|
579
|
+
* @description Grants
|
|
580
|
+
* @default []
|
|
581
|
+
*/
|
|
582
|
+
grants: {
|
|
583
|
+
/**
|
|
584
|
+
* @description The entity to grant access to
|
|
585
|
+
* @example photon:blueprint
|
|
586
|
+
*/
|
|
587
|
+
entity: string;
|
|
588
|
+
/**
|
|
589
|
+
* @description The operation on the entity to grant access to
|
|
590
|
+
* @example read
|
|
591
|
+
*/
|
|
592
|
+
operation: string;
|
|
593
|
+
/**
|
|
594
|
+
* @description The scope to apply to this grant to
|
|
595
|
+
* @default @self
|
|
596
|
+
* @enum {string}
|
|
597
|
+
*/
|
|
598
|
+
scope: "@deny" | "@self" | "@org" | "@admin";
|
|
599
|
+
/**
|
|
600
|
+
* @deprecated
|
|
601
|
+
* @description Deny this operation instead of granting it. Use scope = -1 instead of using this field.
|
|
602
|
+
* @example false
|
|
603
|
+
*/
|
|
604
|
+
deny?: boolean;
|
|
605
|
+
}[];
|
|
606
|
+
};
|
|
607
|
+
/** UpdateOrganization */
|
|
608
|
+
UpdateOrganizationDto: {
|
|
609
|
+
/**
|
|
610
|
+
* @description Organization name
|
|
611
|
+
* @example Updated Organization Name
|
|
612
|
+
*/
|
|
613
|
+
name: string;
|
|
614
|
+
};
|
|
615
|
+
/** List */
|
|
616
|
+
ListDto: {
|
|
617
|
+
data: unknown[];
|
|
618
|
+
};
|
|
619
|
+
/** Grant */
|
|
620
|
+
GrantDto: {
|
|
621
|
+
/**
|
|
622
|
+
* @description Grant entity
|
|
623
|
+
* @example photon:tasks
|
|
624
|
+
*/
|
|
625
|
+
entity: string;
|
|
626
|
+
/**
|
|
627
|
+
* @description Grant operation
|
|
628
|
+
* @example read
|
|
629
|
+
*/
|
|
630
|
+
operation: string;
|
|
631
|
+
/**
|
|
632
|
+
* @example @self
|
|
633
|
+
* @enum {string}
|
|
634
|
+
*/
|
|
635
|
+
scope: "@deny" | "@self" | "@org" | "@admin";
|
|
636
|
+
/**
|
|
637
|
+
* @deprecated
|
|
638
|
+
* @example false
|
|
639
|
+
*/
|
|
640
|
+
deny?: boolean;
|
|
641
|
+
};
|
|
642
|
+
/** CreateGrant */
|
|
643
|
+
CreateGrantDto: {
|
|
644
|
+
/**
|
|
645
|
+
* @description The entity to grant access to
|
|
646
|
+
* @example photon:blueprint
|
|
647
|
+
*/
|
|
648
|
+
entity: string;
|
|
649
|
+
/**
|
|
650
|
+
* @description The operation on the entity to grant access to
|
|
651
|
+
* @example read
|
|
652
|
+
*/
|
|
653
|
+
operation: string;
|
|
654
|
+
/**
|
|
655
|
+
* @description The scope to apply to this grant to
|
|
656
|
+
* @default @self
|
|
657
|
+
* @enum {string}
|
|
658
|
+
*/
|
|
659
|
+
scope: "@deny" | "@self" | "@org" | "@admin";
|
|
660
|
+
/**
|
|
661
|
+
* @deprecated
|
|
662
|
+
* @description Deny this operation instead of granting it. Use scope = -1 instead of using this field.
|
|
663
|
+
* @example false
|
|
664
|
+
*/
|
|
665
|
+
deny?: boolean;
|
|
666
|
+
};
|
|
667
|
+
/** RemoveGrantInput */
|
|
668
|
+
RemoveGrantInputDto: {
|
|
669
|
+
/**
|
|
670
|
+
* @description The entity to grant access to
|
|
671
|
+
* @example photon:blueprint
|
|
672
|
+
*/
|
|
673
|
+
entity: string;
|
|
674
|
+
/**
|
|
675
|
+
* @description The operation on the entity to grant access to
|
|
676
|
+
* @example read
|
|
677
|
+
*/
|
|
678
|
+
operation: string;
|
|
679
|
+
};
|
|
680
|
+
/** User */
|
|
681
|
+
UserDto: {
|
|
682
|
+
/** @example 66e25e72d10dfef2f9f6cc60 */
|
|
683
|
+
id: string;
|
|
684
|
+
meta: {
|
|
685
|
+
/**
|
|
686
|
+
* Format: date-time
|
|
687
|
+
* @description Created at timestamp
|
|
688
|
+
* @example 2024-09-11T00:09:06.276+0000
|
|
689
|
+
*/
|
|
690
|
+
createdAt: string;
|
|
691
|
+
/**
|
|
692
|
+
* Format: date-time
|
|
693
|
+
* @description Updated at timestamp
|
|
694
|
+
* @example 2024-09-11T00:09:06.276+0000
|
|
695
|
+
*/
|
|
696
|
+
updatedAt?: string;
|
|
697
|
+
};
|
|
698
|
+
/**
|
|
699
|
+
* @deprecated
|
|
700
|
+
* @description Internal auth id
|
|
701
|
+
* @example auth0|1234567890
|
|
702
|
+
*/
|
|
703
|
+
auth0Id: string | null;
|
|
704
|
+
/**
|
|
705
|
+
* Format: email
|
|
706
|
+
* @description Email
|
|
707
|
+
* @example test@test.com
|
|
708
|
+
*/
|
|
709
|
+
email: string;
|
|
710
|
+
/**
|
|
450
711
|
* @description First name
|
|
451
712
|
* @example John
|
|
452
713
|
*/
|
|
453
|
-
firstName
|
|
714
|
+
firstName: string;
|
|
454
715
|
/**
|
|
455
716
|
* @description Last name
|
|
456
717
|
* @example Doe
|
|
457
718
|
*/
|
|
458
|
-
lastName
|
|
719
|
+
lastName: string;
|
|
720
|
+
/**
|
|
721
|
+
* @deprecated
|
|
722
|
+
* @description User permissions
|
|
723
|
+
* @example {
|
|
724
|
+
* "photon:blueprint": [
|
|
725
|
+
* "read",
|
|
726
|
+
* "write"
|
|
727
|
+
* ]
|
|
728
|
+
* }
|
|
729
|
+
*/
|
|
730
|
+
permissions: {
|
|
731
|
+
[key: string]: string[];
|
|
732
|
+
};
|
|
459
733
|
/**
|
|
460
734
|
* @description Phone number
|
|
461
735
|
* @example +18048675309
|
|
462
736
|
*/
|
|
463
|
-
phoneNumber
|
|
737
|
+
phoneNumber: string;
|
|
738
|
+
/**
|
|
739
|
+
* @description Organization ID
|
|
740
|
+
* @example 66e3367b141b81fb54ec4e1f
|
|
741
|
+
*/
|
|
742
|
+
organizationId: string;
|
|
743
|
+
/**
|
|
744
|
+
* @description Has Personal Access Token
|
|
745
|
+
* @example false
|
|
746
|
+
*/
|
|
747
|
+
hasPAT: boolean;
|
|
464
748
|
};
|
|
465
|
-
/**
|
|
466
|
-
|
|
749
|
+
/** UpdateUser */
|
|
750
|
+
UpdateUserDto: {
|
|
467
751
|
/**
|
|
468
|
-
* @
|
|
469
|
-
* @
|
|
752
|
+
* @description First name
|
|
753
|
+
* @example John
|
|
470
754
|
*/
|
|
471
|
-
|
|
755
|
+
firstName?: string;
|
|
472
756
|
/**
|
|
473
|
-
* @
|
|
474
|
-
* @
|
|
757
|
+
* @description Last name
|
|
758
|
+
* @example Doe
|
|
475
759
|
*/
|
|
476
|
-
|
|
477
|
-
/**
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
* "name": [
|
|
483
|
-
* "is required"
|
|
484
|
-
* ],
|
|
485
|
-
* "postalCode": [
|
|
486
|
-
* "must be a string of 5 numbers"
|
|
487
|
-
* ]
|
|
488
|
-
* } */
|
|
489
|
-
validations: {
|
|
490
|
-
[key: string]: string[];
|
|
491
|
-
};
|
|
760
|
+
lastName?: string;
|
|
761
|
+
/**
|
|
762
|
+
* @description Phone number
|
|
763
|
+
* @example +18048675309
|
|
764
|
+
*/
|
|
765
|
+
phoneNumber?: string;
|
|
492
766
|
};
|
|
493
767
|
/** PaginatedList */
|
|
494
768
|
PaginatedListDto: {
|
|
@@ -622,23 +896,6 @@ export interface components {
|
|
|
622
896
|
/** @default [] */
|
|
623
897
|
roleIds: string[];
|
|
624
898
|
};
|
|
625
|
-
/** NotFoundError */
|
|
626
|
-
NotFoundErrorDto: {
|
|
627
|
-
/**
|
|
628
|
-
* @example NotFound
|
|
629
|
-
* @enum {string}
|
|
630
|
-
*/
|
|
631
|
-
error: "NotFound";
|
|
632
|
-
/**
|
|
633
|
-
* @example 404
|
|
634
|
-
* @enum {number}
|
|
635
|
-
*/
|
|
636
|
-
statusCode: 404;
|
|
637
|
-
/** @example The requested entity was not found */
|
|
638
|
-
message: string;
|
|
639
|
-
/** @example Technical error description */
|
|
640
|
-
reason: string;
|
|
641
|
-
};
|
|
642
899
|
/** ConflictError */
|
|
643
900
|
ConflictErrorDto: {
|
|
644
901
|
/**
|
|
@@ -666,12 +923,9 @@ export interface components {
|
|
|
666
923
|
/** @description Personal access token */
|
|
667
924
|
personalAccessToken?: string;
|
|
668
925
|
};
|
|
669
|
-
/** List */
|
|
670
|
-
ListDto: {
|
|
671
|
-
data: unknown[];
|
|
672
|
-
};
|
|
673
926
|
/** Role */
|
|
674
927
|
RoleDto: {
|
|
928
|
+
id: string;
|
|
675
929
|
organizationId?: string;
|
|
676
930
|
name: string;
|
|
677
931
|
/** @enum {string} */
|
|
@@ -713,43 +967,34 @@ export interface components {
|
|
|
713
967
|
updatedAt?: string;
|
|
714
968
|
};
|
|
715
969
|
};
|
|
716
|
-
/**
|
|
717
|
-
|
|
970
|
+
/** GrantWithSource */
|
|
971
|
+
GrantWithSourceDto: {
|
|
718
972
|
/**
|
|
719
|
-
* @description
|
|
720
|
-
* @example photon:
|
|
973
|
+
* @description Grant entity
|
|
974
|
+
* @example photon:tasks
|
|
721
975
|
*/
|
|
722
976
|
entity: string;
|
|
723
977
|
/**
|
|
724
|
-
* @description
|
|
978
|
+
* @description Grant operation
|
|
725
979
|
* @example read
|
|
726
980
|
*/
|
|
727
981
|
operation: string;
|
|
728
982
|
/**
|
|
729
|
-
* @
|
|
730
|
-
* @default @self
|
|
983
|
+
* @example @self
|
|
731
984
|
* @enum {string}
|
|
732
985
|
*/
|
|
733
986
|
scope: "@deny" | "@self" | "@org" | "@admin";
|
|
734
987
|
/**
|
|
735
988
|
* @deprecated
|
|
736
|
-
* @description Deny this operation instead of granting it. Use scope = -1 instead of using this field.
|
|
737
989
|
* @example false
|
|
738
990
|
*/
|
|
739
991
|
deny?: boolean;
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
*/
|
|
747
|
-
entity: string;
|
|
748
|
-
/**
|
|
749
|
-
* @description The operation on the entity to grant access to
|
|
750
|
-
* @example read
|
|
751
|
-
*/
|
|
752
|
-
operation: string;
|
|
992
|
+
source: {
|
|
993
|
+
id: string;
|
|
994
|
+
name: string;
|
|
995
|
+
/** @enum {string} */
|
|
996
|
+
type: "organization" | "role" | "user";
|
|
997
|
+
};
|
|
753
998
|
};
|
|
754
999
|
/** Me */
|
|
755
1000
|
MeDto: {
|
|
@@ -814,89 +1059,8 @@ export interface components {
|
|
|
814
1059
|
};
|
|
815
1060
|
};
|
|
816
1061
|
};
|
|
817
|
-
/**
|
|
818
|
-
|
|
819
|
-
/** @example 66e25e72d10dfef2f9f6cc60 */
|
|
820
|
-
id: string;
|
|
821
|
-
meta: {
|
|
822
|
-
/**
|
|
823
|
-
* Format: date-time
|
|
824
|
-
* @description Created at timestamp
|
|
825
|
-
* @example 2024-09-11T00:09:06.276+0000
|
|
826
|
-
*/
|
|
827
|
-
createdAt: string;
|
|
828
|
-
/**
|
|
829
|
-
* Format: date-time
|
|
830
|
-
* @description Updated at timestamp
|
|
831
|
-
* @example 2024-09-11T00:09:06.276+0000
|
|
832
|
-
*/
|
|
833
|
-
updatedAt?: string;
|
|
834
|
-
};
|
|
835
|
-
/**
|
|
836
|
-
* @description Name
|
|
837
|
-
* @example Palmetto
|
|
838
|
-
*/
|
|
839
|
-
name: string;
|
|
840
|
-
/**
|
|
841
|
-
* @deprecated
|
|
842
|
-
* @description Organization permissions
|
|
843
|
-
* @example {
|
|
844
|
-
* "photon:blueprint": [
|
|
845
|
-
* "read",
|
|
846
|
-
* "write"
|
|
847
|
-
* ]
|
|
848
|
-
* }
|
|
849
|
-
*/
|
|
850
|
-
permissions: {
|
|
851
|
-
[key: string]: string[];
|
|
852
|
-
};
|
|
853
|
-
};
|
|
854
|
-
/** CreateOrganization */
|
|
855
|
-
CreateOrganizationDto: {
|
|
856
|
-
/**
|
|
857
|
-
* @description Name
|
|
858
|
-
* @example Organization Name
|
|
859
|
-
*/
|
|
860
|
-
name: string;
|
|
861
|
-
/**
|
|
862
|
-
* @description Grants
|
|
863
|
-
* @default []
|
|
864
|
-
*/
|
|
865
|
-
grants: {
|
|
866
|
-
/**
|
|
867
|
-
* @description The entity to grant access to
|
|
868
|
-
* @example photon:blueprint
|
|
869
|
-
*/
|
|
870
|
-
entity: string;
|
|
871
|
-
/**
|
|
872
|
-
* @description The operation on the entity to grant access to
|
|
873
|
-
* @example read
|
|
874
|
-
*/
|
|
875
|
-
operation: string;
|
|
876
|
-
/**
|
|
877
|
-
* @description The scope to apply to this grant to
|
|
878
|
-
* @default @self
|
|
879
|
-
* @enum {string}
|
|
880
|
-
*/
|
|
881
|
-
scope: "@deny" | "@self" | "@org" | "@admin";
|
|
882
|
-
/**
|
|
883
|
-
* @deprecated
|
|
884
|
-
* @description Deny this operation instead of granting it. Use scope = -1 instead of using this field.
|
|
885
|
-
* @example false
|
|
886
|
-
*/
|
|
887
|
-
deny?: boolean;
|
|
888
|
-
}[];
|
|
889
|
-
};
|
|
890
|
-
/** UpdateOrganization */
|
|
891
|
-
UpdateOrganizationDto: {
|
|
892
|
-
/**
|
|
893
|
-
* @description Organization name
|
|
894
|
-
* @example Updated Organization Name
|
|
895
|
-
*/
|
|
896
|
-
name: string;
|
|
897
|
-
};
|
|
898
|
-
/** CreateRole */
|
|
899
|
-
CreateRoleDto: {
|
|
1062
|
+
/** CreateRole */
|
|
1063
|
+
CreateRoleDto: {
|
|
900
1064
|
/** @example 66e25e72d10dfef2f9f6cc60 */
|
|
901
1065
|
organizationId?: string;
|
|
902
1066
|
name: string;
|
|
@@ -920,28 +1084,6 @@ export interface components {
|
|
|
920
1084
|
scope: "@self" | "@org" | "@admin";
|
|
921
1085
|
}[];
|
|
922
1086
|
};
|
|
923
|
-
/** TokenInput */
|
|
924
|
-
TokenInputDto: {
|
|
925
|
-
/** @enum {string} */
|
|
926
|
-
grant_type: "authorization_code";
|
|
927
|
-
code: string;
|
|
928
|
-
/**
|
|
929
|
-
* @deprecated
|
|
930
|
-
* @description Obtain access tokens without verifying that the user exists
|
|
931
|
-
*/
|
|
932
|
-
skip_user_verification?: boolean;
|
|
933
|
-
} | {
|
|
934
|
-
/** @enum {string} */
|
|
935
|
-
grant_type: "refresh_token";
|
|
936
|
-
refresh_token: string;
|
|
937
|
-
};
|
|
938
|
-
/** TokenResponse */
|
|
939
|
-
TokenResponseDto: {
|
|
940
|
-
access_token: string;
|
|
941
|
-
id_token: string;
|
|
942
|
-
refresh_token: string;
|
|
943
|
-
expires_in: number;
|
|
944
|
-
};
|
|
945
1087
|
/** CreateSignUp */
|
|
946
1088
|
CreateSignUpDto: {
|
|
947
1089
|
/** Format: uri */
|
|
@@ -996,6 +1138,97 @@ export interface components {
|
|
|
996
1138
|
name: string;
|
|
997
1139
|
};
|
|
998
1140
|
};
|
|
1141
|
+
/** Service */
|
|
1142
|
+
ServiceDto: {
|
|
1143
|
+
/** @example 66e25e72d10dfef2f9f6cc60 */
|
|
1144
|
+
id: string;
|
|
1145
|
+
meta: {
|
|
1146
|
+
/**
|
|
1147
|
+
* Format: date-time
|
|
1148
|
+
* @description Created at timestamp
|
|
1149
|
+
* @example 2024-09-11T00:09:06.276+0000
|
|
1150
|
+
*/
|
|
1151
|
+
createdAt: string;
|
|
1152
|
+
/**
|
|
1153
|
+
* Format: date-time
|
|
1154
|
+
* @description Updated at timestamp
|
|
1155
|
+
* @example 2024-09-11T00:09:06.276+0000
|
|
1156
|
+
*/
|
|
1157
|
+
updatedAt?: string;
|
|
1158
|
+
};
|
|
1159
|
+
key: string;
|
|
1160
|
+
name: string;
|
|
1161
|
+
entities: {
|
|
1162
|
+
key: string;
|
|
1163
|
+
name: string;
|
|
1164
|
+
operations: {
|
|
1165
|
+
key: string;
|
|
1166
|
+
name: string;
|
|
1167
|
+
allowedScopes?: ("@self" | "@org" | "@admin")[];
|
|
1168
|
+
}[];
|
|
1169
|
+
}[];
|
|
1170
|
+
};
|
|
1171
|
+
/** CreateService */
|
|
1172
|
+
CreateServiceDto: {
|
|
1173
|
+
/** @example lower-kebab-case */
|
|
1174
|
+
key: string;
|
|
1175
|
+
name: string;
|
|
1176
|
+
/**
|
|
1177
|
+
* @default []
|
|
1178
|
+
* @example [
|
|
1179
|
+
* {
|
|
1180
|
+
* "key": "account",
|
|
1181
|
+
* "name": "Customer account",
|
|
1182
|
+
* "operations": [
|
|
1183
|
+
* {
|
|
1184
|
+
* "key": "read",
|
|
1185
|
+
* "name": "Read"
|
|
1186
|
+
* },
|
|
1187
|
+
* {
|
|
1188
|
+
* "key": "write",
|
|
1189
|
+
* "name": "Write"
|
|
1190
|
+
* },
|
|
1191
|
+
* {
|
|
1192
|
+
* "key": "all",
|
|
1193
|
+
* "name": "All operations"
|
|
1194
|
+
* }
|
|
1195
|
+
* ]
|
|
1196
|
+
* }
|
|
1197
|
+
* ]
|
|
1198
|
+
*/
|
|
1199
|
+
entities: {
|
|
1200
|
+
/** @example lower-kebab-case */
|
|
1201
|
+
key: string;
|
|
1202
|
+
name: string;
|
|
1203
|
+
/** @default [] */
|
|
1204
|
+
operations: {
|
|
1205
|
+
/** @example all */
|
|
1206
|
+
key: string;
|
|
1207
|
+
name: string;
|
|
1208
|
+
allowedScopes?: ("@self" | "@org" | "@admin")[];
|
|
1209
|
+
}[];
|
|
1210
|
+
}[];
|
|
1211
|
+
};
|
|
1212
|
+
/** CreateServiceEntity */
|
|
1213
|
+
CreateServiceEntityDto: {
|
|
1214
|
+
/** @example lower-kebab-case */
|
|
1215
|
+
key: string;
|
|
1216
|
+
name: string;
|
|
1217
|
+
/** @default [] */
|
|
1218
|
+
operations: {
|
|
1219
|
+
/** @example all */
|
|
1220
|
+
key: string;
|
|
1221
|
+
name: string;
|
|
1222
|
+
allowedScopes?: ("@self" | "@org" | "@admin")[];
|
|
1223
|
+
}[];
|
|
1224
|
+
};
|
|
1225
|
+
/** CreateServiceEntityOperation */
|
|
1226
|
+
CreateServiceEntityOperationDto: {
|
|
1227
|
+
/** @example all */
|
|
1228
|
+
key: string;
|
|
1229
|
+
name: string;
|
|
1230
|
+
allowedScopes?: ("@self" | "@org" | "@admin")[];
|
|
1231
|
+
};
|
|
999
1232
|
/** SearchUser */
|
|
1000
1233
|
SearchUserDto: {
|
|
1001
1234
|
/** @example 66e25e72d10dfef2f9f6cc60 */
|
|
@@ -1083,55 +1316,428 @@ export interface components {
|
|
|
1083
1316
|
/** @default false */
|
|
1084
1317
|
inverse: boolean;
|
|
1085
1318
|
};
|
|
1086
|
-
} | {
|
|
1087
|
-
/** @enum {string} */
|
|
1088
|
-
filter: "email";
|
|
1089
|
-
operation: {
|
|
1090
|
-
equals: string;
|
|
1091
|
-
/** @default false */
|
|
1092
|
-
inverse: boolean;
|
|
1319
|
+
} | {
|
|
1320
|
+
/** @enum {string} */
|
|
1321
|
+
filter: "email";
|
|
1322
|
+
operation: {
|
|
1323
|
+
equals: string;
|
|
1324
|
+
/** @default false */
|
|
1325
|
+
inverse: boolean;
|
|
1326
|
+
};
|
|
1327
|
+
} | {
|
|
1328
|
+
/** @enum {string} */
|
|
1329
|
+
filter: "firstName";
|
|
1330
|
+
operation: {
|
|
1331
|
+
equals: string;
|
|
1332
|
+
/** @default false */
|
|
1333
|
+
inverse: boolean;
|
|
1334
|
+
};
|
|
1335
|
+
} | {
|
|
1336
|
+
/** @enum {string} */
|
|
1337
|
+
filter: "lastName";
|
|
1338
|
+
operation: {
|
|
1339
|
+
equals: string;
|
|
1340
|
+
/** @default false */
|
|
1341
|
+
inverse: boolean;
|
|
1342
|
+
};
|
|
1343
|
+
})[];
|
|
1344
|
+
};
|
|
1345
|
+
};
|
|
1346
|
+
responses: never;
|
|
1347
|
+
parameters: never;
|
|
1348
|
+
requestBodies: never;
|
|
1349
|
+
headers: never;
|
|
1350
|
+
pathItems: never;
|
|
1351
|
+
}
|
|
1352
|
+
export type $defs = Record<string, never>;
|
|
1353
|
+
export interface operations {
|
|
1354
|
+
AuthController_generateToken: {
|
|
1355
|
+
parameters: {
|
|
1356
|
+
query?: never;
|
|
1357
|
+
header?: never;
|
|
1358
|
+
path?: never;
|
|
1359
|
+
cookie?: never;
|
|
1360
|
+
};
|
|
1361
|
+
requestBody: {
|
|
1362
|
+
content: {
|
|
1363
|
+
"application/json": components["schemas"]["TokenInputDto"];
|
|
1364
|
+
};
|
|
1365
|
+
};
|
|
1366
|
+
responses: {
|
|
1367
|
+
200: {
|
|
1368
|
+
headers: {
|
|
1369
|
+
[name: string]: unknown;
|
|
1370
|
+
};
|
|
1371
|
+
content: {
|
|
1372
|
+
"application/json": components["schemas"]["TokenResponseDto"];
|
|
1373
|
+
};
|
|
1374
|
+
};
|
|
1375
|
+
/** @description When the provided body is invalid */
|
|
1376
|
+
400: {
|
|
1377
|
+
headers: {
|
|
1378
|
+
[name: string]: unknown;
|
|
1379
|
+
};
|
|
1380
|
+
content: {
|
|
1381
|
+
"application/json": components["schemas"]["BadRequestErrorDto"];
|
|
1382
|
+
};
|
|
1383
|
+
};
|
|
1384
|
+
/** @description When the user does not exist for the exchange token */
|
|
1385
|
+
404: {
|
|
1386
|
+
headers: {
|
|
1387
|
+
[name: string]: unknown;
|
|
1388
|
+
};
|
|
1389
|
+
content: {
|
|
1390
|
+
"application/json": components["schemas"]["NotFoundErrorDto"];
|
|
1391
|
+
};
|
|
1392
|
+
};
|
|
1393
|
+
};
|
|
1394
|
+
};
|
|
1395
|
+
OrganizationsController_getOrganization: {
|
|
1396
|
+
parameters: {
|
|
1397
|
+
query?: never;
|
|
1398
|
+
header?: never;
|
|
1399
|
+
path: {
|
|
1400
|
+
id: string;
|
|
1401
|
+
};
|
|
1402
|
+
cookie?: never;
|
|
1403
|
+
};
|
|
1404
|
+
requestBody?: never;
|
|
1405
|
+
responses: {
|
|
1406
|
+
200: {
|
|
1407
|
+
headers: {
|
|
1408
|
+
[name: string]: unknown;
|
|
1409
|
+
};
|
|
1410
|
+
content: {
|
|
1411
|
+
"application/json": components["schemas"]["OrganizationDto"];
|
|
1412
|
+
};
|
|
1413
|
+
};
|
|
1414
|
+
/** @description When the provided ID is invalid */
|
|
1415
|
+
400: {
|
|
1416
|
+
headers: {
|
|
1417
|
+
[name: string]: unknown;
|
|
1418
|
+
};
|
|
1419
|
+
content: {
|
|
1420
|
+
"application/json": components["schemas"]["BadRequestErrorDto"];
|
|
1421
|
+
};
|
|
1422
|
+
};
|
|
1423
|
+
/** @description When authentication fails */
|
|
1424
|
+
401: {
|
|
1425
|
+
headers: {
|
|
1426
|
+
[name: string]: unknown;
|
|
1427
|
+
};
|
|
1428
|
+
content: {
|
|
1429
|
+
"application/json": components["schemas"]["UnauthorizedErrorDto"];
|
|
1430
|
+
};
|
|
1431
|
+
};
|
|
1432
|
+
/** @description When the requesting user is not allowed to perform this action */
|
|
1433
|
+
403: {
|
|
1434
|
+
headers: {
|
|
1435
|
+
[name: string]: unknown;
|
|
1436
|
+
};
|
|
1437
|
+
content: {
|
|
1438
|
+
"application/json": components["schemas"]["ForbiddenErrorDto"];
|
|
1439
|
+
};
|
|
1440
|
+
};
|
|
1441
|
+
/** @description When the organization is not found */
|
|
1442
|
+
404: {
|
|
1443
|
+
headers: {
|
|
1444
|
+
[name: string]: unknown;
|
|
1445
|
+
};
|
|
1446
|
+
content: {
|
|
1447
|
+
"application/json": components["schemas"]["NotFoundErrorDto"];
|
|
1448
|
+
};
|
|
1449
|
+
};
|
|
1450
|
+
};
|
|
1451
|
+
};
|
|
1452
|
+
OrganizationsController_update: {
|
|
1453
|
+
parameters: {
|
|
1454
|
+
query?: never;
|
|
1455
|
+
header?: never;
|
|
1456
|
+
path: {
|
|
1457
|
+
id: string;
|
|
1458
|
+
};
|
|
1459
|
+
cookie?: never;
|
|
1460
|
+
};
|
|
1461
|
+
requestBody: {
|
|
1462
|
+
content: {
|
|
1463
|
+
"application/json": components["schemas"]["UpdateOrganizationDto"];
|
|
1464
|
+
};
|
|
1465
|
+
};
|
|
1466
|
+
responses: {
|
|
1467
|
+
200: {
|
|
1468
|
+
headers: {
|
|
1469
|
+
[name: string]: unknown;
|
|
1470
|
+
};
|
|
1471
|
+
content: {
|
|
1472
|
+
"application/json": components["schemas"]["OrganizationDto"];
|
|
1473
|
+
};
|
|
1474
|
+
};
|
|
1475
|
+
/** @description When the provided ID or body is invalid */
|
|
1476
|
+
400: {
|
|
1477
|
+
headers: {
|
|
1478
|
+
[name: string]: unknown;
|
|
1479
|
+
};
|
|
1480
|
+
content: {
|
|
1481
|
+
"application/json": components["schemas"]["BadRequestErrorDto"];
|
|
1482
|
+
};
|
|
1483
|
+
};
|
|
1484
|
+
/** @description When authentication fails */
|
|
1485
|
+
401: {
|
|
1486
|
+
headers: {
|
|
1487
|
+
[name: string]: unknown;
|
|
1488
|
+
};
|
|
1489
|
+
content: {
|
|
1490
|
+
"application/json": components["schemas"]["UnauthorizedErrorDto"];
|
|
1491
|
+
};
|
|
1492
|
+
};
|
|
1493
|
+
/** @description When the requesting user is not allowed to perform this action */
|
|
1494
|
+
403: {
|
|
1495
|
+
headers: {
|
|
1496
|
+
[name: string]: unknown;
|
|
1497
|
+
};
|
|
1498
|
+
content: {
|
|
1499
|
+
"application/json": components["schemas"]["ForbiddenErrorDto"];
|
|
1500
|
+
};
|
|
1501
|
+
};
|
|
1502
|
+
/** @description When the organization is not found */
|
|
1503
|
+
404: {
|
|
1504
|
+
headers: {
|
|
1505
|
+
[name: string]: unknown;
|
|
1506
|
+
};
|
|
1507
|
+
content: {
|
|
1508
|
+
"application/json": components["schemas"]["NotFoundErrorDto"];
|
|
1509
|
+
};
|
|
1510
|
+
};
|
|
1511
|
+
};
|
|
1512
|
+
};
|
|
1513
|
+
OrganizationsController_create: {
|
|
1514
|
+
parameters: {
|
|
1515
|
+
query?: never;
|
|
1516
|
+
header?: never;
|
|
1517
|
+
path?: never;
|
|
1518
|
+
cookie?: never;
|
|
1519
|
+
};
|
|
1520
|
+
requestBody: {
|
|
1521
|
+
content: {
|
|
1522
|
+
"application/json": components["schemas"]["CreateOrganizationDto"];
|
|
1523
|
+
};
|
|
1524
|
+
};
|
|
1525
|
+
responses: {
|
|
1526
|
+
200: {
|
|
1527
|
+
headers: {
|
|
1528
|
+
[name: string]: unknown;
|
|
1529
|
+
};
|
|
1530
|
+
content: {
|
|
1531
|
+
"application/json": components["schemas"]["OrganizationDto"];
|
|
1532
|
+
};
|
|
1533
|
+
};
|
|
1534
|
+
/** @description When the provided body is invalid */
|
|
1535
|
+
400: {
|
|
1536
|
+
headers: {
|
|
1537
|
+
[name: string]: unknown;
|
|
1538
|
+
};
|
|
1539
|
+
content: {
|
|
1540
|
+
"application/json": components["schemas"]["BadRequestErrorDto"];
|
|
1541
|
+
};
|
|
1542
|
+
};
|
|
1543
|
+
/** @description When authentication fails */
|
|
1544
|
+
401: {
|
|
1545
|
+
headers: {
|
|
1546
|
+
[name: string]: unknown;
|
|
1547
|
+
};
|
|
1548
|
+
content: {
|
|
1549
|
+
"application/json": components["schemas"]["UnauthorizedErrorDto"];
|
|
1550
|
+
};
|
|
1551
|
+
};
|
|
1552
|
+
/** @description When the requesting user is not allowed to perform this action */
|
|
1553
|
+
403: {
|
|
1554
|
+
headers: {
|
|
1555
|
+
[name: string]: unknown;
|
|
1556
|
+
};
|
|
1557
|
+
content: {
|
|
1558
|
+
"application/json": components["schemas"]["ForbiddenErrorDto"];
|
|
1559
|
+
};
|
|
1560
|
+
};
|
|
1561
|
+
};
|
|
1562
|
+
};
|
|
1563
|
+
OrganizationsController_getOrganizationGrants: {
|
|
1564
|
+
parameters: {
|
|
1565
|
+
query?: never;
|
|
1566
|
+
header?: never;
|
|
1567
|
+
path: {
|
|
1568
|
+
id: string;
|
|
1569
|
+
};
|
|
1570
|
+
cookie?: never;
|
|
1571
|
+
};
|
|
1572
|
+
requestBody?: never;
|
|
1573
|
+
responses: {
|
|
1574
|
+
200: {
|
|
1575
|
+
headers: {
|
|
1576
|
+
[name: string]: unknown;
|
|
1577
|
+
};
|
|
1578
|
+
content: {
|
|
1579
|
+
"application/json": {
|
|
1580
|
+
data: components["schemas"]["GrantDto"][];
|
|
1581
|
+
};
|
|
1582
|
+
};
|
|
1583
|
+
};
|
|
1584
|
+
/** @description When the provided ID is invalid */
|
|
1585
|
+
400: {
|
|
1586
|
+
headers: {
|
|
1587
|
+
[name: string]: unknown;
|
|
1588
|
+
};
|
|
1589
|
+
content: {
|
|
1590
|
+
"application/json": components["schemas"]["BadRequestErrorDto"];
|
|
1591
|
+
};
|
|
1592
|
+
};
|
|
1593
|
+
/** @description When authentication fails */
|
|
1594
|
+
401: {
|
|
1595
|
+
headers: {
|
|
1596
|
+
[name: string]: unknown;
|
|
1597
|
+
};
|
|
1598
|
+
content: {
|
|
1599
|
+
"application/json": components["schemas"]["UnauthorizedErrorDto"];
|
|
1600
|
+
};
|
|
1601
|
+
};
|
|
1602
|
+
/** @description When the requesting user is not allowed to perform this action */
|
|
1603
|
+
403: {
|
|
1604
|
+
headers: {
|
|
1605
|
+
[name: string]: unknown;
|
|
1606
|
+
};
|
|
1607
|
+
content: {
|
|
1608
|
+
"application/json": components["schemas"]["ForbiddenErrorDto"];
|
|
1609
|
+
};
|
|
1610
|
+
};
|
|
1611
|
+
/** @description When the organization is not found */
|
|
1612
|
+
404: {
|
|
1613
|
+
headers: {
|
|
1614
|
+
[name: string]: unknown;
|
|
1615
|
+
};
|
|
1616
|
+
content: {
|
|
1617
|
+
"application/json": components["schemas"]["NotFoundErrorDto"];
|
|
1618
|
+
};
|
|
1619
|
+
};
|
|
1620
|
+
};
|
|
1621
|
+
};
|
|
1622
|
+
OrganizationsController_addGrant: {
|
|
1623
|
+
parameters: {
|
|
1624
|
+
query?: never;
|
|
1625
|
+
header?: never;
|
|
1626
|
+
path: {
|
|
1627
|
+
id: string;
|
|
1628
|
+
};
|
|
1629
|
+
cookie?: never;
|
|
1630
|
+
};
|
|
1631
|
+
requestBody: {
|
|
1632
|
+
content: {
|
|
1633
|
+
"application/json": components["schemas"]["CreateGrantDto"];
|
|
1634
|
+
};
|
|
1635
|
+
};
|
|
1636
|
+
responses: {
|
|
1637
|
+
201: {
|
|
1638
|
+
headers: {
|
|
1639
|
+
[name: string]: unknown;
|
|
1093
1640
|
};
|
|
1094
|
-
|
|
1095
|
-
|
|
1096
|
-
filter: "firstName";
|
|
1097
|
-
operation: {
|
|
1098
|
-
equals: string;
|
|
1099
|
-
/** @default false */
|
|
1100
|
-
inverse: boolean;
|
|
1641
|
+
content: {
|
|
1642
|
+
"application/json": components["schemas"]["OrganizationDto"];
|
|
1101
1643
|
};
|
|
1102
|
-
}
|
|
1103
|
-
|
|
1104
|
-
|
|
1105
|
-
|
|
1106
|
-
|
|
1107
|
-
/** @default false */
|
|
1108
|
-
inverse: boolean;
|
|
1644
|
+
};
|
|
1645
|
+
/** @description When the ID or body request is invalid */
|
|
1646
|
+
400: {
|
|
1647
|
+
headers: {
|
|
1648
|
+
[name: string]: unknown;
|
|
1109
1649
|
};
|
|
1110
|
-
|
|
1650
|
+
content: {
|
|
1651
|
+
"application/json": components["schemas"]["BadRequestErrorDto"];
|
|
1652
|
+
};
|
|
1653
|
+
};
|
|
1654
|
+
/** @description When authentication fails */
|
|
1655
|
+
401: {
|
|
1656
|
+
headers: {
|
|
1657
|
+
[name: string]: unknown;
|
|
1658
|
+
};
|
|
1659
|
+
content: {
|
|
1660
|
+
"application/json": components["schemas"]["UnauthorizedErrorDto"];
|
|
1661
|
+
};
|
|
1662
|
+
};
|
|
1663
|
+
/** @description When the requesting user is not allowed to perform this action */
|
|
1664
|
+
403: {
|
|
1665
|
+
headers: {
|
|
1666
|
+
[name: string]: unknown;
|
|
1667
|
+
};
|
|
1668
|
+
content: {
|
|
1669
|
+
"application/json": components["schemas"]["ForbiddenErrorDto"];
|
|
1670
|
+
};
|
|
1671
|
+
};
|
|
1672
|
+
/** @description When the organization is not found */
|
|
1673
|
+
404: {
|
|
1674
|
+
headers: {
|
|
1675
|
+
[name: string]: unknown;
|
|
1676
|
+
};
|
|
1677
|
+
content: {
|
|
1678
|
+
"application/json": components["schemas"]["NotFoundErrorDto"];
|
|
1679
|
+
};
|
|
1680
|
+
};
|
|
1111
1681
|
};
|
|
1112
1682
|
};
|
|
1113
|
-
|
|
1114
|
-
parameters: never;
|
|
1115
|
-
requestBodies: never;
|
|
1116
|
-
headers: never;
|
|
1117
|
-
pathItems: never;
|
|
1118
|
-
}
|
|
1119
|
-
export type $defs = Record<string, never>;
|
|
1120
|
-
export interface operations {
|
|
1121
|
-
HealthController_getHealth: {
|
|
1683
|
+
OrganizationsController_removeGrant: {
|
|
1122
1684
|
parameters: {
|
|
1123
1685
|
query?: never;
|
|
1124
1686
|
header?: never;
|
|
1125
|
-
path
|
|
1687
|
+
path: {
|
|
1688
|
+
id: string;
|
|
1689
|
+
};
|
|
1126
1690
|
cookie?: never;
|
|
1127
1691
|
};
|
|
1128
|
-
requestBody
|
|
1692
|
+
requestBody: {
|
|
1693
|
+
content: {
|
|
1694
|
+
"application/json": components["schemas"]["RemoveGrantInputDto"];
|
|
1695
|
+
};
|
|
1696
|
+
};
|
|
1129
1697
|
responses: {
|
|
1130
1698
|
200: {
|
|
1131
1699
|
headers: {
|
|
1132
1700
|
[name: string]: unknown;
|
|
1133
1701
|
};
|
|
1134
|
-
content
|
|
1702
|
+
content: {
|
|
1703
|
+
"application/json": components["schemas"]["OrganizationDto"];
|
|
1704
|
+
};
|
|
1705
|
+
};
|
|
1706
|
+
/** @description When the ID or body request is invalid */
|
|
1707
|
+
400: {
|
|
1708
|
+
headers: {
|
|
1709
|
+
[name: string]: unknown;
|
|
1710
|
+
};
|
|
1711
|
+
content: {
|
|
1712
|
+
"application/json": components["schemas"]["BadRequestErrorDto"];
|
|
1713
|
+
};
|
|
1714
|
+
};
|
|
1715
|
+
/** @description When authentication fails */
|
|
1716
|
+
401: {
|
|
1717
|
+
headers: {
|
|
1718
|
+
[name: string]: unknown;
|
|
1719
|
+
};
|
|
1720
|
+
content: {
|
|
1721
|
+
"application/json": components["schemas"]["UnauthorizedErrorDto"];
|
|
1722
|
+
};
|
|
1723
|
+
};
|
|
1724
|
+
/** @description When the requesting user is not allowed to perform this action */
|
|
1725
|
+
403: {
|
|
1726
|
+
headers: {
|
|
1727
|
+
[name: string]: unknown;
|
|
1728
|
+
};
|
|
1729
|
+
content: {
|
|
1730
|
+
"application/json": components["schemas"]["ForbiddenErrorDto"];
|
|
1731
|
+
};
|
|
1732
|
+
};
|
|
1733
|
+
/** @description When the organization is not found */
|
|
1734
|
+
404: {
|
|
1735
|
+
headers: {
|
|
1736
|
+
[name: string]: unknown;
|
|
1737
|
+
};
|
|
1738
|
+
content: {
|
|
1739
|
+
"application/json": components["schemas"]["NotFoundErrorDto"];
|
|
1740
|
+
};
|
|
1135
1741
|
};
|
|
1136
1742
|
};
|
|
1137
1743
|
};
|
|
@@ -1227,7 +1833,6 @@ export interface operations {
|
|
|
1227
1833
|
query?: {
|
|
1228
1834
|
page?: number;
|
|
1229
1835
|
limit?: number;
|
|
1230
|
-
/** @example 66e25e72d10dfef2f9f6cc60 */
|
|
1231
1836
|
organizationId?: string;
|
|
1232
1837
|
};
|
|
1233
1838
|
header?: never;
|
|
@@ -1332,6 +1937,15 @@ export interface operations {
|
|
|
1332
1937
|
"application/json": components["schemas"]["NotFoundErrorDto"];
|
|
1333
1938
|
};
|
|
1334
1939
|
};
|
|
1940
|
+
/** @description When the user is not unique */
|
|
1941
|
+
409: {
|
|
1942
|
+
headers: {
|
|
1943
|
+
[name: string]: unknown;
|
|
1944
|
+
};
|
|
1945
|
+
content: {
|
|
1946
|
+
"application/json": components["schemas"]["ConflictErrorDto"];
|
|
1947
|
+
};
|
|
1948
|
+
};
|
|
1335
1949
|
};
|
|
1336
1950
|
};
|
|
1337
1951
|
UsersController_get: {
|
|
@@ -1730,6 +2344,56 @@ export interface operations {
|
|
|
1730
2344
|
};
|
|
1731
2345
|
};
|
|
1732
2346
|
};
|
|
2347
|
+
UsersController_getGrants: {
|
|
2348
|
+
parameters: {
|
|
2349
|
+
query?: never;
|
|
2350
|
+
header?: never;
|
|
2351
|
+
path: {
|
|
2352
|
+
id: string;
|
|
2353
|
+
};
|
|
2354
|
+
cookie?: never;
|
|
2355
|
+
};
|
|
2356
|
+
requestBody?: never;
|
|
2357
|
+
responses: {
|
|
2358
|
+
200: {
|
|
2359
|
+
headers: {
|
|
2360
|
+
[name: string]: unknown;
|
|
2361
|
+
};
|
|
2362
|
+
content: {
|
|
2363
|
+
"application/json": {
|
|
2364
|
+
data: components["schemas"]["GrantWithSourceDto"][];
|
|
2365
|
+
};
|
|
2366
|
+
};
|
|
2367
|
+
};
|
|
2368
|
+
/** @description When the request is invalid */
|
|
2369
|
+
400: {
|
|
2370
|
+
headers: {
|
|
2371
|
+
[name: string]: unknown;
|
|
2372
|
+
};
|
|
2373
|
+
content: {
|
|
2374
|
+
"application/json": components["schemas"]["BadRequestErrorDto"];
|
|
2375
|
+
};
|
|
2376
|
+
};
|
|
2377
|
+
/** @description When authentication fails */
|
|
2378
|
+
401: {
|
|
2379
|
+
headers: {
|
|
2380
|
+
[name: string]: unknown;
|
|
2381
|
+
};
|
|
2382
|
+
content: {
|
|
2383
|
+
"application/json": components["schemas"]["UnauthorizedErrorDto"];
|
|
2384
|
+
};
|
|
2385
|
+
};
|
|
2386
|
+
/** @description When the requesting user is not allowed to perform this action */
|
|
2387
|
+
403: {
|
|
2388
|
+
headers: {
|
|
2389
|
+
[name: string]: unknown;
|
|
2390
|
+
};
|
|
2391
|
+
content: {
|
|
2392
|
+
"application/json": components["schemas"]["ForbiddenErrorDto"];
|
|
2393
|
+
};
|
|
2394
|
+
};
|
|
2395
|
+
};
|
|
2396
|
+
};
|
|
1733
2397
|
UsersController_addGrant: {
|
|
1734
2398
|
parameters: {
|
|
1735
2399
|
query?: never;
|
|
@@ -1930,13 +2594,15 @@ export interface operations {
|
|
|
1930
2594
|
};
|
|
1931
2595
|
};
|
|
1932
2596
|
};
|
|
1933
|
-
|
|
2597
|
+
RolesController_findAll: {
|
|
1934
2598
|
parameters: {
|
|
1935
|
-
query?:
|
|
1936
|
-
|
|
1937
|
-
|
|
1938
|
-
|
|
2599
|
+
query?: {
|
|
2600
|
+
page?: number;
|
|
2601
|
+
limit?: number;
|
|
2602
|
+
organizationId?: string;
|
|
1939
2603
|
};
|
|
2604
|
+
header?: never;
|
|
2605
|
+
path?: never;
|
|
1940
2606
|
cookie?: never;
|
|
1941
2607
|
};
|
|
1942
2608
|
requestBody?: never;
|
|
@@ -1946,10 +2612,12 @@ export interface operations {
|
|
|
1946
2612
|
[name: string]: unknown;
|
|
1947
2613
|
};
|
|
1948
2614
|
content: {
|
|
1949
|
-
"application/json":
|
|
2615
|
+
"application/json": {
|
|
2616
|
+
data: components["schemas"]["RoleDto"][];
|
|
2617
|
+
} & components["schemas"]["PaginatedListDto"];
|
|
1950
2618
|
};
|
|
1951
2619
|
};
|
|
1952
|
-
/** @description When the
|
|
2620
|
+
/** @description When the request is invalid */
|
|
1953
2621
|
400: {
|
|
1954
2622
|
headers: {
|
|
1955
2623
|
[name: string]: unknown;
|
|
@@ -1976,41 +2644,30 @@ export interface operations {
|
|
|
1976
2644
|
"application/json": components["schemas"]["ForbiddenErrorDto"];
|
|
1977
2645
|
};
|
|
1978
2646
|
};
|
|
1979
|
-
/** @description When the organization is not found */
|
|
1980
|
-
404: {
|
|
1981
|
-
headers: {
|
|
1982
|
-
[name: string]: unknown;
|
|
1983
|
-
};
|
|
1984
|
-
content: {
|
|
1985
|
-
"application/json": components["schemas"]["NotFoundErrorDto"];
|
|
1986
|
-
};
|
|
1987
|
-
};
|
|
1988
2647
|
};
|
|
1989
2648
|
};
|
|
1990
|
-
|
|
2649
|
+
RolesController_create: {
|
|
1991
2650
|
parameters: {
|
|
1992
2651
|
query?: never;
|
|
1993
2652
|
header?: never;
|
|
1994
|
-
path
|
|
1995
|
-
id: string;
|
|
1996
|
-
};
|
|
2653
|
+
path?: never;
|
|
1997
2654
|
cookie?: never;
|
|
1998
2655
|
};
|
|
1999
2656
|
requestBody: {
|
|
2000
2657
|
content: {
|
|
2001
|
-
"application/json": components["schemas"]["
|
|
2658
|
+
"application/json": components["schemas"]["CreateRoleDto"];
|
|
2002
2659
|
};
|
|
2003
2660
|
};
|
|
2004
2661
|
responses: {
|
|
2005
|
-
|
|
2662
|
+
201: {
|
|
2006
2663
|
headers: {
|
|
2007
2664
|
[name: string]: unknown;
|
|
2008
2665
|
};
|
|
2009
2666
|
content: {
|
|
2010
|
-
"application/json": components["schemas"]["
|
|
2667
|
+
"application/json": components["schemas"]["RoleDto"];
|
|
2011
2668
|
};
|
|
2012
2669
|
};
|
|
2013
|
-
/** @description When the
|
|
2670
|
+
/** @description When the request is invalid */
|
|
2014
2671
|
400: {
|
|
2015
2672
|
headers: {
|
|
2016
2673
|
[name: string]: unknown;
|
|
@@ -2037,39 +2694,28 @@ export interface operations {
|
|
|
2037
2694
|
"application/json": components["schemas"]["ForbiddenErrorDto"];
|
|
2038
2695
|
};
|
|
2039
2696
|
};
|
|
2040
|
-
/** @description When the organization is not found */
|
|
2041
|
-
404: {
|
|
2042
|
-
headers: {
|
|
2043
|
-
[name: string]: unknown;
|
|
2044
|
-
};
|
|
2045
|
-
content: {
|
|
2046
|
-
"application/json": components["schemas"]["NotFoundErrorDto"];
|
|
2047
|
-
};
|
|
2048
|
-
};
|
|
2049
2697
|
};
|
|
2050
2698
|
};
|
|
2051
|
-
|
|
2699
|
+
RolesController_findOne: {
|
|
2052
2700
|
parameters: {
|
|
2053
2701
|
query?: never;
|
|
2054
2702
|
header?: never;
|
|
2055
|
-
path
|
|
2056
|
-
|
|
2057
|
-
};
|
|
2058
|
-
requestBody: {
|
|
2059
|
-
content: {
|
|
2060
|
-
"application/json": components["schemas"]["CreateOrganizationDto"];
|
|
2703
|
+
path: {
|
|
2704
|
+
id: string;
|
|
2061
2705
|
};
|
|
2706
|
+
cookie?: never;
|
|
2062
2707
|
};
|
|
2708
|
+
requestBody?: never;
|
|
2063
2709
|
responses: {
|
|
2064
2710
|
200: {
|
|
2065
2711
|
headers: {
|
|
2066
2712
|
[name: string]: unknown;
|
|
2067
2713
|
};
|
|
2068
2714
|
content: {
|
|
2069
|
-
"application/json": components["schemas"]["
|
|
2715
|
+
"application/json": components["schemas"]["RoleDto"];
|
|
2070
2716
|
};
|
|
2071
2717
|
};
|
|
2072
|
-
/** @description When the
|
|
2718
|
+
/** @description When the request is invalid */
|
|
2073
2719
|
400: {
|
|
2074
2720
|
headers: {
|
|
2075
2721
|
[name: string]: unknown;
|
|
@@ -2096,14 +2742,39 @@ export interface operations {
|
|
|
2096
2742
|
"application/json": components["schemas"]["ForbiddenErrorDto"];
|
|
2097
2743
|
};
|
|
2098
2744
|
};
|
|
2745
|
+
/** @description When the Role is not found */
|
|
2746
|
+
404: {
|
|
2747
|
+
headers: {
|
|
2748
|
+
[name: string]: unknown;
|
|
2749
|
+
};
|
|
2750
|
+
content: {
|
|
2751
|
+
"application/json": components["schemas"]["NotFoundErrorDto"];
|
|
2752
|
+
};
|
|
2753
|
+
};
|
|
2099
2754
|
};
|
|
2100
2755
|
};
|
|
2101
|
-
|
|
2756
|
+
HealthController_getHealth: {
|
|
2757
|
+
parameters: {
|
|
2758
|
+
query?: never;
|
|
2759
|
+
header?: never;
|
|
2760
|
+
path?: never;
|
|
2761
|
+
cookie?: never;
|
|
2762
|
+
};
|
|
2763
|
+
requestBody?: never;
|
|
2764
|
+
responses: {
|
|
2765
|
+
200: {
|
|
2766
|
+
headers: {
|
|
2767
|
+
[name: string]: unknown;
|
|
2768
|
+
};
|
|
2769
|
+
content?: never;
|
|
2770
|
+
};
|
|
2771
|
+
};
|
|
2772
|
+
};
|
|
2773
|
+
SignUpsController_findAll: {
|
|
2102
2774
|
parameters: {
|
|
2103
2775
|
query?: {
|
|
2104
2776
|
page?: number;
|
|
2105
2777
|
limit?: number;
|
|
2106
|
-
/** @example 66e25e72d10dfef2f9f6cc60 */
|
|
2107
2778
|
organizationId?: string;
|
|
2108
2779
|
};
|
|
2109
2780
|
header?: never;
|
|
@@ -2118,11 +2789,11 @@ export interface operations {
|
|
|
2118
2789
|
};
|
|
2119
2790
|
content: {
|
|
2120
2791
|
"application/json": {
|
|
2121
|
-
data: components["schemas"]["
|
|
2792
|
+
data: components["schemas"]["SignUpAdminDto"][];
|
|
2122
2793
|
} & components["schemas"]["PaginatedListDto"];
|
|
2123
2794
|
};
|
|
2124
2795
|
};
|
|
2125
|
-
/** @description When the
|
|
2796
|
+
/** @description When the sign up query is invalid */
|
|
2126
2797
|
400: {
|
|
2127
2798
|
headers: {
|
|
2128
2799
|
[name: string]: unknown;
|
|
@@ -2151,7 +2822,7 @@ export interface operations {
|
|
|
2151
2822
|
};
|
|
2152
2823
|
};
|
|
2153
2824
|
};
|
|
2154
|
-
|
|
2825
|
+
SignUpsController_create: {
|
|
2155
2826
|
parameters: {
|
|
2156
2827
|
query?: never;
|
|
2157
2828
|
header?: never;
|
|
@@ -2160,7 +2831,7 @@ export interface operations {
|
|
|
2160
2831
|
};
|
|
2161
2832
|
requestBody: {
|
|
2162
2833
|
content: {
|
|
2163
|
-
"application/json": components["schemas"]["
|
|
2834
|
+
"application/json": components["schemas"]["CreateSignUpDto"];
|
|
2164
2835
|
};
|
|
2165
2836
|
};
|
|
2166
2837
|
responses: {
|
|
@@ -2169,10 +2840,10 @@ export interface operations {
|
|
|
2169
2840
|
[name: string]: unknown;
|
|
2170
2841
|
};
|
|
2171
2842
|
content: {
|
|
2172
|
-
"application/json": components["schemas"]["
|
|
2843
|
+
"application/json": components["schemas"]["SignUpTokenDto"];
|
|
2173
2844
|
};
|
|
2174
2845
|
};
|
|
2175
|
-
/** @description When the request is invalid */
|
|
2846
|
+
/** @description When the sign up request is invalid */
|
|
2176
2847
|
400: {
|
|
2177
2848
|
headers: {
|
|
2178
2849
|
[name: string]: unknown;
|
|
@@ -2201,12 +2872,12 @@ export interface operations {
|
|
|
2201
2872
|
};
|
|
2202
2873
|
};
|
|
2203
2874
|
};
|
|
2204
|
-
|
|
2875
|
+
SignUpsController_findOne: {
|
|
2205
2876
|
parameters: {
|
|
2206
2877
|
query?: never;
|
|
2207
2878
|
header?: never;
|
|
2208
2879
|
path: {
|
|
2209
|
-
|
|
2880
|
+
token: string;
|
|
2210
2881
|
};
|
|
2211
2882
|
cookie?: never;
|
|
2212
2883
|
};
|
|
@@ -2217,10 +2888,53 @@ export interface operations {
|
|
|
2217
2888
|
[name: string]: unknown;
|
|
2218
2889
|
};
|
|
2219
2890
|
content: {
|
|
2220
|
-
"application/json": components["schemas"]["
|
|
2891
|
+
"application/json": components["schemas"]["SignUpDto"];
|
|
2221
2892
|
};
|
|
2222
2893
|
};
|
|
2223
|
-
/** @description When the
|
|
2894
|
+
/** @description When the sign up token is invalid */
|
|
2895
|
+
400: {
|
|
2896
|
+
headers: {
|
|
2897
|
+
[name: string]: unknown;
|
|
2898
|
+
};
|
|
2899
|
+
content: {
|
|
2900
|
+
"application/json": components["schemas"]["BadRequestErrorDto"];
|
|
2901
|
+
};
|
|
2902
|
+
};
|
|
2903
|
+
/** @description When the sign up is not found */
|
|
2904
|
+
404: {
|
|
2905
|
+
headers: {
|
|
2906
|
+
[name: string]: unknown;
|
|
2907
|
+
};
|
|
2908
|
+
content: {
|
|
2909
|
+
"application/json": components["schemas"]["NotFoundErrorDto"];
|
|
2910
|
+
};
|
|
2911
|
+
};
|
|
2912
|
+
};
|
|
2913
|
+
};
|
|
2914
|
+
SignUpsController_createUser: {
|
|
2915
|
+
parameters: {
|
|
2916
|
+
query?: never;
|
|
2917
|
+
header?: never;
|
|
2918
|
+
path: {
|
|
2919
|
+
token: string;
|
|
2920
|
+
};
|
|
2921
|
+
cookie?: never;
|
|
2922
|
+
};
|
|
2923
|
+
requestBody: {
|
|
2924
|
+
content: {
|
|
2925
|
+
"application/json": components["schemas"]["CreateSignUpUserDto"];
|
|
2926
|
+
};
|
|
2927
|
+
};
|
|
2928
|
+
responses: {
|
|
2929
|
+
200: {
|
|
2930
|
+
headers: {
|
|
2931
|
+
[name: string]: unknown;
|
|
2932
|
+
};
|
|
2933
|
+
content: {
|
|
2934
|
+
"application/json": components["schemas"]["SignUpDto"];
|
|
2935
|
+
};
|
|
2936
|
+
};
|
|
2937
|
+
/** @description When the sign up token or body is invalid */
|
|
2224
2938
|
400: {
|
|
2225
2939
|
headers: {
|
|
2226
2940
|
[name: string]: unknown;
|
|
@@ -2238,48 +2952,45 @@ export interface operations {
|
|
|
2238
2952
|
"application/json": components["schemas"]["UnauthorizedErrorDto"];
|
|
2239
2953
|
};
|
|
2240
2954
|
};
|
|
2241
|
-
/** @description When the
|
|
2242
|
-
|
|
2955
|
+
/** @description When the sign up is not found */
|
|
2956
|
+
404: {
|
|
2243
2957
|
headers: {
|
|
2244
2958
|
[name: string]: unknown;
|
|
2245
2959
|
};
|
|
2246
2960
|
content: {
|
|
2247
|
-
"application/json": components["schemas"]["
|
|
2961
|
+
"application/json": components["schemas"]["NotFoundErrorDto"];
|
|
2248
2962
|
};
|
|
2249
2963
|
};
|
|
2250
|
-
/** @description When the
|
|
2251
|
-
|
|
2964
|
+
/** @description When the sign up already has an userId or does not have an auth0Id, email, or organizationId */
|
|
2965
|
+
409: {
|
|
2252
2966
|
headers: {
|
|
2253
2967
|
[name: string]: unknown;
|
|
2254
2968
|
};
|
|
2255
2969
|
content: {
|
|
2256
|
-
"application/json": components["schemas"]["
|
|
2970
|
+
"application/json": components["schemas"]["ConflictErrorDto"];
|
|
2257
2971
|
};
|
|
2258
2972
|
};
|
|
2259
2973
|
};
|
|
2260
2974
|
};
|
|
2261
|
-
|
|
2975
|
+
SignUpsController_delete: {
|
|
2262
2976
|
parameters: {
|
|
2263
2977
|
query?: never;
|
|
2264
2978
|
header?: never;
|
|
2265
|
-
path
|
|
2266
|
-
|
|
2267
|
-
};
|
|
2268
|
-
requestBody: {
|
|
2269
|
-
content: {
|
|
2270
|
-
"application/json": components["schemas"]["TokenInputDto"];
|
|
2979
|
+
path: {
|
|
2980
|
+
id: string;
|
|
2271
2981
|
};
|
|
2982
|
+
cookie?: never;
|
|
2272
2983
|
};
|
|
2984
|
+
requestBody?: never;
|
|
2273
2985
|
responses: {
|
|
2274
|
-
|
|
2986
|
+
/** @description Successfully removed */
|
|
2987
|
+
204: {
|
|
2275
2988
|
headers: {
|
|
2276
2989
|
[name: string]: unknown;
|
|
2277
2990
|
};
|
|
2278
|
-
content
|
|
2279
|
-
"application/json": components["schemas"]["TokenResponseDto"];
|
|
2280
|
-
};
|
|
2991
|
+
content?: never;
|
|
2281
2992
|
};
|
|
2282
|
-
/** @description When the
|
|
2993
|
+
/** @description When the request is invalid */
|
|
2283
2994
|
400: {
|
|
2284
2995
|
headers: {
|
|
2285
2996
|
[name: string]: unknown;
|
|
@@ -2288,7 +2999,25 @@ export interface operations {
|
|
|
2288
2999
|
"application/json": components["schemas"]["BadRequestErrorDto"];
|
|
2289
3000
|
};
|
|
2290
3001
|
};
|
|
2291
|
-
/** @description When
|
|
3002
|
+
/** @description When authentication fails */
|
|
3003
|
+
401: {
|
|
3004
|
+
headers: {
|
|
3005
|
+
[name: string]: unknown;
|
|
3006
|
+
};
|
|
3007
|
+
content: {
|
|
3008
|
+
"application/json": components["schemas"]["UnauthorizedErrorDto"];
|
|
3009
|
+
};
|
|
3010
|
+
};
|
|
3011
|
+
/** @description When the requesting user is not allowed to perform this action */
|
|
3012
|
+
403: {
|
|
3013
|
+
headers: {
|
|
3014
|
+
[name: string]: unknown;
|
|
3015
|
+
};
|
|
3016
|
+
content: {
|
|
3017
|
+
"application/json": components["schemas"]["ForbiddenErrorDto"];
|
|
3018
|
+
};
|
|
3019
|
+
};
|
|
3020
|
+
/** @description When the sign up is not found */
|
|
2292
3021
|
404: {
|
|
2293
3022
|
headers: {
|
|
2294
3023
|
[name: string]: unknown;
|
|
@@ -2299,14 +3028,9 @@ export interface operations {
|
|
|
2299
3028
|
};
|
|
2300
3029
|
};
|
|
2301
3030
|
};
|
|
2302
|
-
|
|
3031
|
+
ServicesController_findAll: {
|
|
2303
3032
|
parameters: {
|
|
2304
|
-
query?:
|
|
2305
|
-
page?: number;
|
|
2306
|
-
limit?: number;
|
|
2307
|
-
/** @example 66e25e72d10dfef2f9f6cc60 */
|
|
2308
|
-
organizationId?: string;
|
|
2309
|
-
};
|
|
3033
|
+
query?: never;
|
|
2310
3034
|
header?: never;
|
|
2311
3035
|
path?: never;
|
|
2312
3036
|
cookie?: never;
|
|
@@ -2319,17 +3043,8 @@ export interface operations {
|
|
|
2319
3043
|
};
|
|
2320
3044
|
content: {
|
|
2321
3045
|
"application/json": {
|
|
2322
|
-
data: components["schemas"]["
|
|
2323
|
-
}
|
|
2324
|
-
};
|
|
2325
|
-
};
|
|
2326
|
-
/** @description When the sign up query is invalid */
|
|
2327
|
-
400: {
|
|
2328
|
-
headers: {
|
|
2329
|
-
[name: string]: unknown;
|
|
2330
|
-
};
|
|
2331
|
-
content: {
|
|
2332
|
-
"application/json": components["schemas"]["BadRequestErrorDto"];
|
|
3046
|
+
data: components["schemas"]["ServiceDto"][];
|
|
3047
|
+
};
|
|
2333
3048
|
};
|
|
2334
3049
|
};
|
|
2335
3050
|
/** @description When authentication fails */
|
|
@@ -2352,7 +3067,7 @@ export interface operations {
|
|
|
2352
3067
|
};
|
|
2353
3068
|
};
|
|
2354
3069
|
};
|
|
2355
|
-
|
|
3070
|
+
ServicesController_create: {
|
|
2356
3071
|
parameters: {
|
|
2357
3072
|
query?: never;
|
|
2358
3073
|
header?: never;
|
|
@@ -2361,7 +3076,7 @@ export interface operations {
|
|
|
2361
3076
|
};
|
|
2362
3077
|
requestBody: {
|
|
2363
3078
|
content: {
|
|
2364
|
-
"application/json": components["schemas"]["
|
|
3079
|
+
"application/json": components["schemas"]["CreateServiceDto"];
|
|
2365
3080
|
};
|
|
2366
3081
|
};
|
|
2367
3082
|
responses: {
|
|
@@ -2370,16 +3085,7 @@ export interface operations {
|
|
|
2370
3085
|
[name: string]: unknown;
|
|
2371
3086
|
};
|
|
2372
3087
|
content: {
|
|
2373
|
-
"application/json": components["schemas"]["
|
|
2374
|
-
};
|
|
2375
|
-
};
|
|
2376
|
-
/** @description When the sign up request is invalid */
|
|
2377
|
-
400: {
|
|
2378
|
-
headers: {
|
|
2379
|
-
[name: string]: unknown;
|
|
2380
|
-
};
|
|
2381
|
-
content: {
|
|
2382
|
-
"application/json": components["schemas"]["BadRequestErrorDto"];
|
|
3088
|
+
"application/json": components["schemas"]["ServiceDto"];
|
|
2383
3089
|
};
|
|
2384
3090
|
};
|
|
2385
3091
|
/** @description When authentication fails */
|
|
@@ -2400,14 +3106,23 @@ export interface operations {
|
|
|
2400
3106
|
"application/json": components["schemas"]["ForbiddenErrorDto"];
|
|
2401
3107
|
};
|
|
2402
3108
|
};
|
|
3109
|
+
/** @description When a service already exists for the given key */
|
|
3110
|
+
409: {
|
|
3111
|
+
headers: {
|
|
3112
|
+
[name: string]: unknown;
|
|
3113
|
+
};
|
|
3114
|
+
content: {
|
|
3115
|
+
"application/json": components["schemas"]["ConflictErrorDto"];
|
|
3116
|
+
};
|
|
3117
|
+
};
|
|
2403
3118
|
};
|
|
2404
3119
|
};
|
|
2405
|
-
|
|
3120
|
+
ServicesController_findOne: {
|
|
2406
3121
|
parameters: {
|
|
2407
3122
|
query?: never;
|
|
2408
3123
|
header?: never;
|
|
2409
3124
|
path: {
|
|
2410
|
-
|
|
3125
|
+
key: string;
|
|
2411
3126
|
};
|
|
2412
3127
|
cookie?: never;
|
|
2413
3128
|
};
|
|
@@ -2418,19 +3133,28 @@ export interface operations {
|
|
|
2418
3133
|
[name: string]: unknown;
|
|
2419
3134
|
};
|
|
2420
3135
|
content: {
|
|
2421
|
-
"application/json": components["schemas"]["
|
|
3136
|
+
"application/json": components["schemas"]["ServiceDto"];
|
|
2422
3137
|
};
|
|
2423
3138
|
};
|
|
2424
|
-
/** @description When
|
|
2425
|
-
|
|
3139
|
+
/** @description When authentication fails */
|
|
3140
|
+
401: {
|
|
2426
3141
|
headers: {
|
|
2427
3142
|
[name: string]: unknown;
|
|
2428
3143
|
};
|
|
2429
3144
|
content: {
|
|
2430
|
-
"application/json": components["schemas"]["
|
|
3145
|
+
"application/json": components["schemas"]["UnauthorizedErrorDto"];
|
|
2431
3146
|
};
|
|
2432
3147
|
};
|
|
2433
|
-
/** @description When the
|
|
3148
|
+
/** @description When the requesting user is not allowed to perform this action */
|
|
3149
|
+
403: {
|
|
3150
|
+
headers: {
|
|
3151
|
+
[name: string]: unknown;
|
|
3152
|
+
};
|
|
3153
|
+
content: {
|
|
3154
|
+
"application/json": components["schemas"]["ForbiddenErrorDto"];
|
|
3155
|
+
};
|
|
3156
|
+
};
|
|
3157
|
+
/** @description When the service is not found by key */
|
|
2434
3158
|
404: {
|
|
2435
3159
|
headers: {
|
|
2436
3160
|
[name: string]: unknown;
|
|
@@ -2441,48 +3165,48 @@ export interface operations {
|
|
|
2441
3165
|
};
|
|
2442
3166
|
};
|
|
2443
3167
|
};
|
|
2444
|
-
|
|
3168
|
+
ServicesController_createServiceEntity: {
|
|
2445
3169
|
parameters: {
|
|
2446
3170
|
query?: never;
|
|
2447
3171
|
header?: never;
|
|
2448
3172
|
path: {
|
|
2449
|
-
|
|
3173
|
+
key: string;
|
|
2450
3174
|
};
|
|
2451
3175
|
cookie?: never;
|
|
2452
3176
|
};
|
|
2453
3177
|
requestBody: {
|
|
2454
3178
|
content: {
|
|
2455
|
-
"application/json": components["schemas"]["
|
|
3179
|
+
"application/json": components["schemas"]["CreateServiceEntityDto"];
|
|
2456
3180
|
};
|
|
2457
3181
|
};
|
|
2458
3182
|
responses: {
|
|
2459
|
-
|
|
3183
|
+
201: {
|
|
2460
3184
|
headers: {
|
|
2461
3185
|
[name: string]: unknown;
|
|
2462
3186
|
};
|
|
2463
3187
|
content: {
|
|
2464
|
-
"application/json": components["schemas"]["
|
|
3188
|
+
"application/json": components["schemas"]["ServiceDto"];
|
|
2465
3189
|
};
|
|
2466
3190
|
};
|
|
2467
|
-
/** @description When
|
|
2468
|
-
|
|
3191
|
+
/** @description When authentication fails */
|
|
3192
|
+
401: {
|
|
2469
3193
|
headers: {
|
|
2470
3194
|
[name: string]: unknown;
|
|
2471
3195
|
};
|
|
2472
3196
|
content: {
|
|
2473
|
-
"application/json": components["schemas"]["
|
|
3197
|
+
"application/json": components["schemas"]["UnauthorizedErrorDto"];
|
|
2474
3198
|
};
|
|
2475
3199
|
};
|
|
2476
|
-
/** @description When
|
|
2477
|
-
|
|
3200
|
+
/** @description When the requesting user is not allowed to perform this action */
|
|
3201
|
+
403: {
|
|
2478
3202
|
headers: {
|
|
2479
3203
|
[name: string]: unknown;
|
|
2480
3204
|
};
|
|
2481
3205
|
content: {
|
|
2482
|
-
"application/json": components["schemas"]["
|
|
3206
|
+
"application/json": components["schemas"]["ForbiddenErrorDto"];
|
|
2483
3207
|
};
|
|
2484
3208
|
};
|
|
2485
|
-
/** @description When the
|
|
3209
|
+
/** @description When the service is not found by key */
|
|
2486
3210
|
404: {
|
|
2487
3211
|
headers: {
|
|
2488
3212
|
[name: string]: unknown;
|
|
@@ -2491,7 +3215,7 @@ export interface operations {
|
|
|
2491
3215
|
"application/json": components["schemas"]["NotFoundErrorDto"];
|
|
2492
3216
|
};
|
|
2493
3217
|
};
|
|
2494
|
-
/** @description When
|
|
3218
|
+
/** @description When an entity with the same key already exists */
|
|
2495
3219
|
409: {
|
|
2496
3220
|
headers: {
|
|
2497
3221
|
[name: string]: unknown;
|
|
@@ -2502,31 +3226,28 @@ export interface operations {
|
|
|
2502
3226
|
};
|
|
2503
3227
|
};
|
|
2504
3228
|
};
|
|
2505
|
-
|
|
3229
|
+
ServicesController_createServiceEntityOperation: {
|
|
2506
3230
|
parameters: {
|
|
2507
3231
|
query?: never;
|
|
2508
3232
|
header?: never;
|
|
2509
3233
|
path: {
|
|
2510
|
-
|
|
3234
|
+
key: string;
|
|
3235
|
+
entityKey: string;
|
|
2511
3236
|
};
|
|
2512
3237
|
cookie?: never;
|
|
2513
3238
|
};
|
|
2514
|
-
requestBody
|
|
2515
|
-
|
|
2516
|
-
|
|
2517
|
-
204: {
|
|
2518
|
-
headers: {
|
|
2519
|
-
[name: string]: unknown;
|
|
2520
|
-
};
|
|
2521
|
-
content?: never;
|
|
3239
|
+
requestBody: {
|
|
3240
|
+
content: {
|
|
3241
|
+
"application/json": components["schemas"]["CreateServiceEntityOperationDto"];
|
|
2522
3242
|
};
|
|
2523
|
-
|
|
2524
|
-
|
|
3243
|
+
};
|
|
3244
|
+
responses: {
|
|
3245
|
+
201: {
|
|
2525
3246
|
headers: {
|
|
2526
3247
|
[name: string]: unknown;
|
|
2527
3248
|
};
|
|
2528
3249
|
content: {
|
|
2529
|
-
"application/json": components["schemas"]["
|
|
3250
|
+
"application/json": components["schemas"]["ServiceDto"];
|
|
2530
3251
|
};
|
|
2531
3252
|
};
|
|
2532
3253
|
/** @description When authentication fails */
|
|
@@ -2547,7 +3268,7 @@ export interface operations {
|
|
|
2547
3268
|
"application/json": components["schemas"]["ForbiddenErrorDto"];
|
|
2548
3269
|
};
|
|
2549
3270
|
};
|
|
2550
|
-
/** @description When the
|
|
3271
|
+
/** @description When the service or entity is not found by key */
|
|
2551
3272
|
404: {
|
|
2552
3273
|
headers: {
|
|
2553
3274
|
[name: string]: unknown;
|
|
@@ -2556,6 +3277,15 @@ export interface operations {
|
|
|
2556
3277
|
"application/json": components["schemas"]["NotFoundErrorDto"];
|
|
2557
3278
|
};
|
|
2558
3279
|
};
|
|
3280
|
+
/** @description When an operation with the same key already exists */
|
|
3281
|
+
409: {
|
|
3282
|
+
headers: {
|
|
3283
|
+
[name: string]: unknown;
|
|
3284
|
+
};
|
|
3285
|
+
content: {
|
|
3286
|
+
"application/json": components["schemas"]["ConflictErrorDto"];
|
|
3287
|
+
};
|
|
3288
|
+
};
|
|
2559
3289
|
};
|
|
2560
3290
|
};
|
|
2561
3291
|
SearchUsersController_search: {
|