@palmetto/users-sdk 0.2.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/dist/__generated__/schema.d.ts +808 -97
  2. package/dist/client.d.ts +501 -83
  3. package/dist/client.js +55 -69
  4. package/package.json +5 -4
package/dist/__generated__/schema.d.ts CHANGED
@@ -22,12 +22,14 @@ export interface paths {
22
22
  path?: never;
23
23
  cookie?: never;
24
24
  };
25
+ /** Get Current User */
25
26
  get: operations["UsersController_getMe"];
26
27
  put?: never;
27
28
  post?: never;
28
29
  delete?: never;
29
30
  options?: never;
30
31
  head?: never;
32
+ /** Update Current User */
31
33
  patch: operations["UsersController_updateMe"];
32
34
  trace?: never;
33
35
  };
@@ -38,8 +40,10 @@ export interface paths {
38
40
  path?: never;
39
41
  cookie?: never;
40
42
  };
43
+ /** Find Users */
41
44
  get: operations["UsersController_findAll"];
42
45
  put?: never;
46
+ /** Create User */
43
47
  post: operations["UsersController_create"];
44
48
  delete?: never;
45
49
  options?: never;
@@ -54,12 +58,15 @@ export interface paths {
54
58
  path?: never;
55
59
  cookie?: never;
56
60
  };
61
+ /** Find User By ID */
57
62
  get: operations["UsersController_get"];
58
63
  put?: never;
59
64
  post?: never;
65
+ /** Deactivate user */
60
66
  delete: operations["UsersController_delete"];
61
67
  options?: never;
62
68
  head?: never;
69
+ /** Update User */
63
70
  patch: operations["UsersController_update"];
64
71
  trace?: never;
65
72
  };
@@ -72,6 +79,7 @@ export interface paths {
72
79
  };
73
80
  get?: never;
74
81
  put?: never;
82
+ /** Create Personal Access Token */
75
83
  post: operations["UsersController_getPersonalAccessToken"];
76
84
  delete?: never;
77
85
  options?: never;
@@ -88,7 +96,9 @@ export interface paths {
88
96
  };
89
97
  get?: never;
90
98
  put?: never;
99
+ /** Create Grant For User */
91
100
  post: operations["UsersController_addGrant"];
101
+ /** Remove Grant From User */
92
102
  delete: operations["UsersController_removeGrant"];
93
103
  options?: never;
94
104
  head?: never;
@@ -102,12 +112,14 @@ export interface paths {
102
112
  path?: never;
103
113
  cookie?: never;
104
114
  };
115
+ /** Get Organization By ID */
105
116
  get: operations["OrganizationsController_getOrganization"];
106
117
  put?: never;
107
118
  post?: never;
108
119
  delete?: never;
109
120
  options?: never;
110
121
  head?: never;
122
+ /** Update Organization By ID */
111
123
  patch: operations["OrganizationsController_update"];
112
124
  trace?: never;
113
125
  };
@@ -120,6 +132,7 @@ export interface paths {
120
132
  };
121
133
  get?: never;
122
134
  put?: never;
135
+ /** Create Organization */
123
136
  post: operations["OrganizationsController_create"];
124
137
  delete?: never;
125
138
  options?: never;
@@ -136,6 +149,7 @@ export interface paths {
136
149
  };
137
150
  get?: never;
138
151
  put?: never;
152
+ /** Get Auth Token */
139
153
  post: operations["AuthController_generateToken"];
140
154
  delete?: never;
141
155
  options?: never;
@@ -150,10 +164,10 @@ export interface paths {
150
164
  path?: never;
151
165
  cookie?: never;
152
166
  };
153
- /** Get pending sign ups */
167
+ /** Get pending sign-ups */
154
168
  get: operations["SignUpsController_findAll"];
155
169
  put?: never;
156
- /** Create Sign Up */
170
+ /** Create sign-up */
157
171
  post: operations["SignUpsController_create"];
158
172
  delete?: never;
159
173
  options?: never;
@@ -168,15 +182,14 @@ export interface paths {
168
182
  path?: never;
169
183
  cookie?: never;
170
184
  };
171
- /** Find Sign Up By Token */
185
+ /** Find sign-up */
172
186
  get: operations["SignUpsController_findOne"];
173
187
  put?: never;
174
188
  post?: never;
175
189
  delete?: never;
176
190
  options?: never;
177
191
  head?: never;
178
- /** Update Sign Up By Token */
179
- patch: operations["SignUpsController_update"];
192
+ patch?: never;
180
193
  trace?: never;
181
194
  };
182
195
  "/api/sign-ups/{token}/user": {
@@ -188,7 +201,7 @@ export interface paths {
188
201
  };
189
202
  get?: never;
190
203
  put?: never;
191
- /** Create User By Sign Up Token */
204
+ /** Create user with sign-up token */
192
205
  post: operations["SignUpsController_createUser"];
193
206
  delete?: never;
194
207
  options?: never;
@@ -206,7 +219,7 @@ export interface paths {
206
219
  get?: never;
207
220
  put?: never;
208
221
  post?: never;
209
- /** Delete Sign Up */
222
+ /** Delete sign-up */
210
223
  delete: operations["SignUpsController_delete"];
211
224
  options?: never;
212
225
  head?: never;
@@ -234,6 +247,23 @@ export interface paths {
234
247
  export type webhooks = Record<string, never>;
235
248
  export interface components {
236
249
  schemas: {
250
+ /** UnauthorizedError */
251
+ UnauthorizedErrorDto: {
252
+ /**
253
+ * @example Unauthorized
254
+ * @enum {string}
255
+ */
256
+ error: "Unauthorized";
257
+ /**
258
+ * @example 401
259
+ * @enum {number}
260
+ */
261
+ statusCode: 401;
262
+ /** @example You must log in to perform that action */
263
+ message: string;
264
+ /** @example Technical error description */
265
+ reason: string;
266
+ };
237
267
  /** User */
238
268
  UserDto: {
239
269
  /** @example 66e25e72d10dfef2f9f6cc60 */
@@ -256,7 +286,7 @@ export interface components {
256
286
  * @description Auth0 ID
257
287
  * @example auth0|1234567890
258
288
  */
259
- auth0Id: null;
289
+ auth0Id: string | null;
260
290
  /**
261
291
  * Format: email
262
292
  * @description Email
@@ -301,6 +331,23 @@ export interface components {
301
331
  */
302
332
  hasPAT: boolean;
303
333
  };
334
+ /** ForbiddenError */
335
+ ForbiddenErrorDto: {
336
+ /**
337
+ * @example Forbidden
338
+ * @enum {string}
339
+ */
340
+ error: "Forbidden";
341
+ /**
342
+ * @example 403
343
+ * @enum {number}
344
+ */
345
+ statusCode: 403;
346
+ /** @example You are not allowed to perform that action */
347
+ message: string;
348
+ /** @example Technical error description */
349
+ reason: string;
350
+ };
304
351
  /** UpdateUser */
305
352
  UpdateUserDto: {
306
353
  /**
@@ -319,6 +366,107 @@ export interface components {
319
366
  */
320
367
  phoneNumber?: string;
321
368
  };
369
+ /** BadRequestError */
370
+ BadRequestErrorDto: {
371
+ /**
372
+ * @example BadRequest
373
+ * @enum {string}
374
+ */
375
+ error: "BadRequest";
376
+ /**
377
+ * @example 400
378
+ * @enum {number}
379
+ */
380
+ statusCode: 400;
381
+ /** @example Request is invalid */
382
+ message: string;
383
+ /** @example Technical error description */
384
+ reason: string;
385
+ /** @example {
386
+ * "name": [
387
+ * "is required"
388
+ * ],
389
+ * "postalCode": [
390
+ * "must be a string of 5 numbers"
391
+ * ]
392
+ * } */
393
+ validations: {
394
+ [key: string]: string[];
395
+ };
396
+ };
397
+ /** PaginatedList */
398
+ PaginatedListDto: {
399
+ data: unknown[];
400
+ paging: {
401
+ /** @description Limit of records per page */
402
+ limit: number;
403
+ /** @description Current page */
404
+ page: number;
405
+ /** @description Record count this page starts on */
406
+ pageStart: number;
407
+ /** @description Record count this page ends on */
408
+ pageEnd: number;
409
+ /** @description The count of records in total */
410
+ totalRecords: number;
411
+ /** @description The count of pages in total */
412
+ totalPages: number;
413
+ };
414
+ };
415
+ /** ListUser */
416
+ ListUserDto: {
417
+ /** @example 66e25e72d10dfef2f9f6cc60 */
418
+ id: string;
419
+ meta: {
420
+ /**
421
+ * Format: date-time
422
+ * @description Created at timestamp
423
+ * @example 2024-09-11T00:09:06.276+0000
424
+ */
425
+ createdAt: string;
426
+ /**
427
+ * Format: date-time
428
+ * @description Updated at timestamp
429
+ * @example 2024-09-11T00:09:06.276+0000
430
+ */
431
+ updatedAt?: string;
432
+ };
433
+ /**
434
+ * @description Auth0 ID
435
+ * @example auth0|1234567890
436
+ */
437
+ auth0Id: string | null;
438
+ /**
439
+ * Format: email
440
+ * @description Email
441
+ * @example test@test.com
442
+ */
443
+ email: string;
444
+ /**
445
+ * @description First name
446
+ * @example John
447
+ */
448
+ firstName: string;
449
+ /**
450
+ * @description Last name
451
+ * @example Doe
452
+ */
453
+ lastName: string;
454
+ /**
455
+ * @description Phone number
456
+ * @example +18048675309
457
+ */
458
+ phoneNumber: string;
459
+ /**
460
+ * @description Organization ID
461
+ * @example 66e3367b141b81fb54ec4e1f
462
+ */
463
+ organizationId: string;
464
+ /**
465
+ * @description Has Personal Access Token
466
+ * @example false
467
+ */
468
+ hasPAT: boolean;
469
+ };
322
470
  /** CreateUser */
323
471
  CreateUserDto: {
324
472
  /**
@@ -349,7 +497,8 @@ export interface components {
349
497
  phoneNumber: string;
350
498
  /** @example 66e25e72d10dfef2f9f6cc60 */
351
499
  organizationId: string;
352
- grants?: {
500
+ /** @default [] */
501
+ grants: {
353
502
  /**
354
503
  * @description Grant Entity
355
504
  * @example photon:blueprint
@@ -367,6 +516,40 @@ export interface components {
367
516
  deny?: boolean;
368
517
  }[];
369
518
  };
519
+ /** NotFoundError */
520
+ NotFoundErrorDto: {
521
+ /**
522
+ * @example NotFound
523
+ * @enum {string}
524
+ */
525
+ error: "NotFound";
526
+ /**
527
+ * @example 404
528
+ * @enum {number}
529
+ */
530
+ statusCode: 404;
531
+ /** @example The requested entity was not found */
532
+ message: string;
533
+ /** @example Technical error description */
534
+ reason: string;
535
+ };
536
+ /** ConflictError */
537
+ ConflictErrorDto: {
538
+ /**
539
+ * @example Conflict
540
+ * @enum {string}
541
+ */
542
+ error: "Conflict";
543
+ /**
544
+ * @example 409
545
+ * @enum {number}
546
+ */
547
+ statusCode: 409;
548
+ /** @example That action cannot be performed at this time */
549
+ message: string;
550
+ /** @example Technical error description */
551
+ reason: string;
552
+ };
370
553
  /** User Personal Access Token */
371
554
  UserPersonalAccessTokenDto: {
372
555
  /**
@@ -433,8 +616,11 @@ export interface components {
433
616
  * @example Organization Name
434
617
  */
435
618
  name: string;
436
- /** @description Grants */
437
- grants?: {
619
+ /**
620
+ * @description Grants
621
+ * @default []
622
+ */
623
+ grants: {
438
624
  /**
439
625
  * @description Grant Entity
440
626
  * @example photon:blueprint
@@ -501,6 +687,8 @@ export interface components {
501
687
  firstName?: string;
502
688
  lastName?: string;
503
689
  email?: string;
690
+ /** Format: date-time */
691
+ expiresAt: string;
504
692
  };
505
693
  /** SignUp */
506
694
  SignUpDto: {
@@ -512,11 +700,8 @@ export interface components {
512
700
  firstName?: string;
513
701
  lastName?: string;
514
702
  email?: string;
515
- };
516
- /** UpdateSignUp */
517
- UpdateSignUpDto: {
518
- /** @example auth0|6fexxxxxxxxxxxxxxxx */
519
- auth0Id: string;
703
+ /** Format: date-time */
704
+ expiresAt: string;
520
705
  };
521
706
  /** CreateSignUp */
522
707
  CreateSignUpUserDto: {
@@ -553,7 +738,7 @@ export interface components {
553
738
  * @description Auth0 ID
554
739
  * @example auth0|1234567890
555
740
  */
556
- auth0Id: null;
741
+ auth0Id: string | null;
557
742
  /**
558
743
  * Format: email
559
744
  * @description Email
@@ -570,18 +755,6 @@ export interface components {
570
755
  * @example Doe
571
756
  */
572
757
  lastName: string;
573
- /**
574
- * @description User permissions
575
- * @example {
576
- * "photon:blueprint": [
577
- * "read",
578
- * "write"
579
- * ]
580
- * }
581
- */
582
- permissions: {
583
- [key: string]: string[];
584
- };
585
758
  /**
586
759
  * @description Phone number
587
760
  * @example +18048675309
@@ -655,46 +828,6 @@ export interface components {
655
828
  };
656
829
  })[];
657
830
  };
658
- /** PaginatedList */
659
- PaginatedListDto: {
660
- data: unknown[];
661
- paging: {
662
- /** @description Limit of records per page */
663
- limit: number;
664
- /** @description Current page */
665
- page: number;
666
- /** @description Record count this page starts on */
667
- pageStart: number;
668
- /** @description Record count this page ends on */
669
- pageEnd: number;
670
- /** @description The count of records in total */
671
- totalRecords: number;
672
- /** @description The count of pages in total */
673
- totalPages: number;
674
- };
675
- };
676
- /** List */
677
- ListDto: {
678
- data: unknown[];
679
- };
680
- /** Grant */
681
- GrantDto: {
682
- /**
683
- * @description Grant entity
684
- * @example photon:tasks
685
- */
686
- entity: string;
687
- /**
688
- * @description Grant operation
689
- * @example read
690
- */
691
- operation: string;
692
- /**
693
- * @description Deny grant
694
- * @example false
695
- */
696
- deny?: boolean;
697
- };
698
831
  };
699
832
  responses: never;
700
833
  parameters: never;
@@ -738,6 +871,24 @@ export interface operations {
738
871
  "application/json": components["schemas"]["UserDto"];
739
872
  };
740
873
  };
874
+ /** @description When authentication fails */
875
+ 401: {
876
+ headers: {
877
+ [name: string]: unknown;
878
+ };
879
+ content: {
880
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
881
+ };
882
+ };
883
+ /** @description When the user does not have permission to access this resource */
884
+ 403: {
885
+ headers: {
886
+ [name: string]: unknown;
887
+ };
888
+ content: {
889
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
890
+ };
891
+ };
741
892
  };
742
893
  };
743
894
  UsersController_updateMe: {
@@ -761,6 +912,33 @@ export interface operations {
761
912
  "application/json": components["schemas"]["UserDto"];
762
913
  };
763
914
  };
915
+ /** @description When the body request is invalid */
916
+ 400: {
917
+ headers: {
918
+ [name: string]: unknown;
919
+ };
920
+ content: {
921
+ "application/json": components["schemas"]["BadRequestErrorDto"];
922
+ };
923
+ };
924
+ /** @description When authentication fails */
925
+ 401: {
926
+ headers: {
927
+ [name: string]: unknown;
928
+ };
929
+ content: {
930
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
931
+ };
932
+ };
933
+ /** @description When the user does not have permission to access this resource */
934
+ 403: {
935
+ headers: {
936
+ [name: string]: unknown;
937
+ };
938
+ content: {
939
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
940
+ };
941
+ };
764
942
  };
765
943
  };
766
944
  UsersController_findAll: {
@@ -783,10 +961,37 @@ export interface operations {
783
961
  };
784
962
  content: {
785
963
  "application/json": {
786
- data: components["schemas"]["UserDto"][];
964
+ data: components["schemas"]["ListUserDto"][];
787
965
  } & components["schemas"]["PaginatedListDto"];
788
966
  };
789
967
  };
968
+ /** @description When the query request is invalid */
969
+ 400: {
970
+ headers: {
971
+ [name: string]: unknown;
972
+ };
973
+ content: {
974
+ "application/json": components["schemas"]["BadRequestErrorDto"];
975
+ };
976
+ };
977
+ /** @description When authentication fails */
978
+ 401: {
979
+ headers: {
980
+ [name: string]: unknown;
981
+ };
982
+ content: {
983
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
984
+ };
985
+ };
986
+ /** @description When the requesting user is not allowed to perform this action */
987
+ 403: {
988
+ headers: {
989
+ [name: string]: unknown;
990
+ };
991
+ content: {
992
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
993
+ };
994
+ };
790
995
  };
791
996
  };
792
997
  UsersController_create: {
@@ -810,6 +1015,42 @@ export interface operations {
810
1015
  "application/json": components["schemas"]["UserDto"];
811
1016
  };
812
1017
  };
1018
+ /** @description When the request is invalid */
1019
+ 400: {
1020
+ headers: {
1021
+ [name: string]: unknown;
1022
+ };
1023
+ content: {
1024
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1025
+ };
1026
+ };
1027
+ /** @description When authentication fails */
1028
+ 401: {
1029
+ headers: {
1030
+ [name: string]: unknown;
1031
+ };
1032
+ content: {
1033
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1034
+ };
1035
+ };
1036
+ /** @description When the requesting user is not allowed to perform this action */
1037
+ 403: {
1038
+ headers: {
1039
+ [name: string]: unknown;
1040
+ };
1041
+ content: {
1042
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
1043
+ };
1044
+ };
1045
+ /** @description When the organization is not found */
1046
+ 404: {
1047
+ headers: {
1048
+ [name: string]: unknown;
1049
+ };
1050
+ content: {
1051
+ "application/json": components["schemas"]["NotFoundErrorDto"];
1052
+ };
1053
+ };
813
1054
  };
814
1055
  };
815
1056
  UsersController_get: {
@@ -831,6 +1072,42 @@ export interface operations {
831
1072
  "application/json": components["schemas"]["UserDto"];
832
1073
  };
833
1074
  };
1075
+ /** @description When the ID is invalid */
1076
+ 400: {
1077
+ headers: {
1078
+ [name: string]: unknown;
1079
+ };
1080
+ content: {
1081
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1082
+ };
1083
+ };
1084
+ /** @description When authentication fails */
1085
+ 401: {
1086
+ headers: {
1087
+ [name: string]: unknown;
1088
+ };
1089
+ content: {
1090
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1091
+ };
1092
+ };
1093
+ /** @description When the requesting user is not allowed to perform this action */
1094
+ 403: {
1095
+ headers: {
1096
+ [name: string]: unknown;
1097
+ };
1098
+ content: {
1099
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
1100
+ };
1101
+ };
1102
+ /** @description When the user is not found */
1103
+ 404: {
1104
+ headers: {
1105
+ [name: string]: unknown;
1106
+ };
1107
+ content: {
1108
+ "application/json": components["schemas"]["NotFoundErrorDto"];
1109
+ };
1110
+ };
834
1111
  };
835
1112
  };
836
1113
  UsersController_delete: {
@@ -850,16 +1127,61 @@ export interface operations {
850
1127
  };
851
1128
  content?: never;
852
1129
  };
853
- };
854
- };
855
- UsersController_update: {
856
- parameters: {
857
- query?: never;
858
- header?: never;
859
- path: {
860
- id: string;
1130
+ /** @description When the ID is invalid */
1131
+ 400: {
1132
+ headers: {
1133
+ [name: string]: unknown;
1134
+ };
1135
+ content: {
1136
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1137
+ };
861
1138
  };
862
- cookie?: never;
1139
+ /** @description When authentication fails */
1140
+ 401: {
1141
+ headers: {
1142
+ [name: string]: unknown;
1143
+ };
1144
+ content: {
1145
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1146
+ };
1147
+ };
1148
+ /** @description When the requesting user is not allowed to perform this action */
1149
+ 403: {
1150
+ headers: {
1151
+ [name: string]: unknown;
1152
+ };
1153
+ content: {
1154
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
1155
+ };
1156
+ };
1157
+ /** @description When the user is not found */
1158
+ 404: {
1159
+ headers: {
1160
+ [name: string]: unknown;
1161
+ };
1162
+ content: {
1163
+ "application/json": components["schemas"]["NotFoundErrorDto"];
1164
+ };
1165
+ };
1166
+ /** @description When the user is not allowed to be deactivated */
1167
+ 409: {
1168
+ headers: {
1169
+ [name: string]: unknown;
1170
+ };
1171
+ content: {
1172
+ "application/json": components["schemas"]["ConflictErrorDto"];
1173
+ };
1174
+ };
1175
+ };
1176
+ };
1177
+ UsersController_update: {
1178
+ parameters: {
1179
+ query?: never;
1180
+ header?: never;
1181
+ path: {
1182
+ id: string;
1183
+ };
1184
+ cookie?: never;
863
1185
  };
864
1186
  requestBody: {
865
1187
  content: {
@@ -875,6 +1197,42 @@ export interface operations {
875
1197
  "application/json": components["schemas"]["UserDto"];
876
1198
  };
877
1199
  };
1200
+ /** @description When the ID or body request is invalid */
1201
+ 400: {
1202
+ headers: {
1203
+ [name: string]: unknown;
1204
+ };
1205
+ content: {
1206
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1207
+ };
1208
+ };
1209
+ /** @description When authentication fails */
1210
+ 401: {
1211
+ headers: {
1212
+ [name: string]: unknown;
1213
+ };
1214
+ content: {
1215
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1216
+ };
1217
+ };
1218
+ /** @description When the requesting user is not allowed to perform this action */
1219
+ 403: {
1220
+ headers: {
1221
+ [name: string]: unknown;
1222
+ };
1223
+ content: {
1224
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
1225
+ };
1226
+ };
1227
+ /** @description When the user is not found */
1228
+ 404: {
1229
+ headers: {
1230
+ [name: string]: unknown;
1231
+ };
1232
+ content: {
1233
+ "application/json": components["schemas"]["NotFoundErrorDto"];
1234
+ };
1235
+ };
878
1236
  };
879
1237
  };
880
1238
  UsersController_getPersonalAccessToken: {
@@ -896,6 +1254,42 @@ export interface operations {
896
1254
  "application/json": components["schemas"]["UserPersonalAccessTokenDto"];
897
1255
  };
898
1256
  };
1257
+ /** @description When the ID is invalid */
1258
+ 400: {
1259
+ headers: {
1260
+ [name: string]: unknown;
1261
+ };
1262
+ content: {
1263
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1264
+ };
1265
+ };
1266
+ /** @description When authentication fails */
1267
+ 401: {
1268
+ headers: {
1269
+ [name: string]: unknown;
1270
+ };
1271
+ content: {
1272
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1273
+ };
1274
+ };
1275
+ /** @description When the requesting user is not allowed to perform this action */
1276
+ 403: {
1277
+ headers: {
1278
+ [name: string]: unknown;
1279
+ };
1280
+ content: {
1281
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
1282
+ };
1283
+ };
1284
+ /** @description When the user is not found */
1285
+ 404: {
1286
+ headers: {
1287
+ [name: string]: unknown;
1288
+ };
1289
+ content: {
1290
+ "application/json": components["schemas"]["NotFoundErrorDto"];
1291
+ };
1292
+ };
899
1293
  };
900
1294
  };
901
1295
  UsersController_addGrant: {
@@ -921,6 +1315,42 @@ export interface operations {
921
1315
  "application/json": components["schemas"]["UserDto"];
922
1316
  };
923
1317
  };
1318
+ /** @description When the ID or body request is invalid */
1319
+ 400: {
1320
+ headers: {
1321
+ [name: string]: unknown;
1322
+ };
1323
+ content: {
1324
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1325
+ };
1326
+ };
1327
+ /** @description When authentication fails */
1328
+ 401: {
1329
+ headers: {
1330
+ [name: string]: unknown;
1331
+ };
1332
+ content: {
1333
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1334
+ };
1335
+ };
1336
+ /** @description When the requesting user is not allowed to perform this action */
1337
+ 403: {
1338
+ headers: {
1339
+ [name: string]: unknown;
1340
+ };
1341
+ content: {
1342
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
1343
+ };
1344
+ };
1345
+ /** @description When the user is not found */
1346
+ 404: {
1347
+ headers: {
1348
+ [name: string]: unknown;
1349
+ };
1350
+ content: {
1351
+ "application/json": components["schemas"]["NotFoundErrorDto"];
1352
+ };
1353
+ };
924
1354
  };
925
1355
  };
926
1356
  UsersController_removeGrant: {
@@ -946,6 +1376,42 @@ export interface operations {
946
1376
  "application/json": components["schemas"]["UserDto"];
947
1377
  };
948
1378
  };
1379
+ /** @description When the ID or body request is invalid */
1380
+ 400: {
1381
+ headers: {
1382
+ [name: string]: unknown;
1383
+ };
1384
+ content: {
1385
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1386
+ };
1387
+ };
1388
+ /** @description When authentication fails */
1389
+ 401: {
1390
+ headers: {
1391
+ [name: string]: unknown;
1392
+ };
1393
+ content: {
1394
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1395
+ };
1396
+ };
1397
+ /** @description When the requesting user is not allowed to perform this action */
1398
+ 403: {
1399
+ headers: {
1400
+ [name: string]: unknown;
1401
+ };
1402
+ content: {
1403
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
1404
+ };
1405
+ };
1406
+ /** @description When the user is not found */
1407
+ 404: {
1408
+ headers: {
1409
+ [name: string]: unknown;
1410
+ };
1411
+ content: {
1412
+ "application/json": components["schemas"]["NotFoundErrorDto"];
1413
+ };
1414
+ };
949
1415
  };
950
1416
  };
951
1417
  OrganizationsController_getOrganization: {
@@ -967,6 +1433,42 @@ export interface operations {
967
1433
  "application/json": components["schemas"]["OrganizationDto"];
968
1434
  };
969
1435
  };
1436
+ /** @description When the provided ID is invalid */
1437
+ 400: {
1438
+ headers: {
1439
+ [name: string]: unknown;
1440
+ };
1441
+ content: {
1442
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1443
+ };
1444
+ };
1445
+ /** @description When authentication fails */
1446
+ 401: {
1447
+ headers: {
1448
+ [name: string]: unknown;
1449
+ };
1450
+ content: {
1451
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1452
+ };
1453
+ };
1454
+ /** @description When the requesting user is not allowed to perform this action */
1455
+ 403: {
1456
+ headers: {
1457
+ [name: string]: unknown;
1458
+ };
1459
+ content: {
1460
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
1461
+ };
1462
+ };
1463
+ /** @description When the organization is not found */
1464
+ 404: {
1465
+ headers: {
1466
+ [name: string]: unknown;
1467
+ };
1468
+ content: {
1469
+ "application/json": components["schemas"]["NotFoundErrorDto"];
1470
+ };
1471
+ };
970
1472
  };
971
1473
  };
972
1474
  OrganizationsController_update: {
@@ -992,6 +1494,42 @@ export interface operations {
992
1494
  "application/json": components["schemas"]["OrganizationDto"];
993
1495
  };
994
1496
  };
1497
+ /** @description When the provided ID or body is invalid */
1498
+ 400: {
1499
+ headers: {
1500
+ [name: string]: unknown;
1501
+ };
1502
+ content: {
1503
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1504
+ };
1505
+ };
1506
+ /** @description When authentication fails */
1507
+ 401: {
1508
+ headers: {
1509
+ [name: string]: unknown;
1510
+ };
1511
+ content: {
1512
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1513
+ };
1514
+ };
1515
+ /** @description When the requesting user is not allowed to perform this action */
1516
+ 403: {
1517
+ headers: {
1518
+ [name: string]: unknown;
1519
+ };
1520
+ content: {
1521
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
1522
+ };
1523
+ };
1524
+ /** @description When the organization is not found */
1525
+ 404: {
1526
+ headers: {
1527
+ [name: string]: unknown;
1528
+ };
1529
+ content: {
1530
+ "application/json": components["schemas"]["NotFoundErrorDto"];
1531
+ };
1532
+ };
995
1533
  };
996
1534
  };
997
1535
  OrganizationsController_create: {
@@ -1015,6 +1553,33 @@ export interface operations {
1015
1553
  "application/json": components["schemas"]["OrganizationDto"];
1016
1554
  };
1017
1555
  };
1556
+ /** @description When the provided body is invalid */
1557
+ 400: {
1558
+ headers: {
1559
+ [name: string]: unknown;
1560
+ };
1561
+ content: {
1562
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1563
+ };
1564
+ };
1565
+ /** @description When authentication fails */
1566
+ 401: {
1567
+ headers: {
1568
+ [name: string]: unknown;
1569
+ };
1570
+ content: {
1571
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1572
+ };
1573
+ };
1574
+ /** @description When the requesting user is not allowed to perform this action */
1575
+ 403: {
1576
+ headers: {
1577
+ [name: string]: unknown;
1578
+ };
1579
+ content: {
1580
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
1581
+ };
1582
+ };
1018
1583
  };
1019
1584
  };
1020
1585
  AuthController_generateToken: {
@@ -1038,6 +1603,15 @@ export interface operations {
1038
1603
  "application/json": components["schemas"]["TokenResponseDto"];
1039
1604
  };
1040
1605
  };
1606
+ /** @description When the provided body is invalid */
1607
+ 400: {
1608
+ headers: {
1609
+ [name: string]: unknown;
1610
+ };
1611
+ content: {
1612
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1613
+ };
1614
+ };
1041
1615
  };
1042
1616
  };
1043
1617
  SignUpsController_findAll: {
@@ -1064,6 +1638,33 @@ export interface operations {
1064
1638
  } & components["schemas"]["PaginatedListDto"];
1065
1639
  };
1066
1640
  };
1641
+ /** @description When the sign up query is invalid */
1642
+ 400: {
1643
+ headers: {
1644
+ [name: string]: unknown;
1645
+ };
1646
+ content: {
1647
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1648
+ };
1649
+ };
1650
+ /** @description When authentication fails */
1651
+ 401: {
1652
+ headers: {
1653
+ [name: string]: unknown;
1654
+ };
1655
+ content: {
1656
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1657
+ };
1658
+ };
1659
+ /** @description When the requesting user is not allowed to perform this action */
1660
+ 403: {
1661
+ headers: {
1662
+ [name: string]: unknown;
1663
+ };
1664
+ content: {
1665
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
1666
+ };
1667
+ };
1067
1668
  };
1068
1669
  };
1069
1670
  SignUpsController_create: {
@@ -1087,6 +1688,24 @@ export interface operations {
1087
1688
  "application/json": components["schemas"]["SignUpTokenDto"];
1088
1689
  };
1089
1690
  };
1691
+ /** @description When the sign up request is invalid */
1692
+ 400: {
1693
+ headers: {
1694
+ [name: string]: unknown;
1695
+ };
1696
+ content: {
1697
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1698
+ };
1699
+ };
1700
+ /** @description When authentication fails */
1701
+ 401: {
1702
+ headers: {
1703
+ [name: string]: unknown;
1704
+ };
1705
+ content: {
1706
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1707
+ };
1708
+ };
1090
1709
  };
1091
1710
  };
1092
1711
  SignUpsController_findOne: {
@@ -1108,29 +1727,22 @@ export interface operations {
1108
1727
  "application/json": components["schemas"]["SignUpDto"];
1109
1728
  };
1110
1729
  };
1111
- };
1112
- };
1113
- SignUpsController_update: {
1114
- parameters: {
1115
- query?: never;
1116
- header?: never;
1117
- path: {
1118
- token: string;
1119
- };
1120
- cookie?: never;
1121
- };
1122
- requestBody: {
1123
- content: {
1124
- "application/json": components["schemas"]["UpdateSignUpDto"];
1730
+ /** @description When the sign up token is invalid */
1731
+ 400: {
1732
+ headers: {
1733
+ [name: string]: unknown;
1734
+ };
1735
+ content: {
1736
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1737
+ };
1125
1738
  };
1126
- };
1127
- responses: {
1128
- 200: {
1739
+ /** @description When the sign up is not found */
1740
+ 404: {
1129
1741
  headers: {
1130
1742
  [name: string]: unknown;
1131
1743
  };
1132
1744
  content: {
1133
- "application/json": components["schemas"]["SignUpDto"];
1745
+ "application/json": components["schemas"]["NotFoundErrorDto"];
1134
1746
  };
1135
1747
  };
1136
1748
  };
@@ -1158,6 +1770,42 @@ export interface operations {
1158
1770
  "application/json": components["schemas"]["SignUpDto"];
1159
1771
  };
1160
1772
  };
1773
+ /** @description When the sign up token or body is invalid */
1774
+ 400: {
1775
+ headers: {
1776
+ [name: string]: unknown;
1777
+ };
1778
+ content: {
1779
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1780
+ };
1781
+ };
1782
+ /** @description When authentication fails */
1783
+ 401: {
1784
+ headers: {
1785
+ [name: string]: unknown;
1786
+ };
1787
+ content: {
1788
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1789
+ };
1790
+ };
1791
+ /** @description When the sign up is not found */
1792
+ 404: {
1793
+ headers: {
1794
+ [name: string]: unknown;
1795
+ };
1796
+ content: {
1797
+ "application/json": components["schemas"]["NotFoundErrorDto"];
1798
+ };
1799
+ };
1800
+ /** @description When the sign up already has an userId or does not have an auth0Id, email, or organizationId */
1801
+ 409: {
1802
+ headers: {
1803
+ [name: string]: unknown;
1804
+ };
1805
+ content: {
1806
+ "application/json": components["schemas"]["ConflictErrorDto"];
1807
+ };
1808
+ };
1161
1809
  };
1162
1810
  };
1163
1811
  SignUpsController_delete: {
@@ -1178,6 +1826,42 @@ export interface operations {
1178
1826
  };
1179
1827
  content?: never;
1180
1828
  };
1829
+ /** @description When the sign up ID is invalid */
1830
+ 400: {
1831
+ headers: {
1832
+ [name: string]: unknown;
1833
+ };
1834
+ content: {
1835
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1836
+ };
1837
+ };
1838
+ /** @description When authentication fails */
1839
+ 401: {
1840
+ headers: {
1841
+ [name: string]: unknown;
1842
+ };
1843
+ content: {
1844
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1845
+ };
1846
+ };
1847
+ /** @description When the requesting user is not allowed to perform this action */
1848
+ 403: {
1849
+ headers: {
1850
+ [name: string]: unknown;
1851
+ };
1852
+ content: {
1853
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
1854
+ };
1855
+ };
1856
+ /** @description When the sign up is not found */
1857
+ 404: {
1858
+ headers: {
1859
+ [name: string]: unknown;
1860
+ };
1861
+ content: {
1862
+ "application/json": components["schemas"]["NotFoundErrorDto"];
1863
+ };
1864
+ };
1181
1865
  };
1182
1866
  };
1183
1867
  SearchUsersController_search: {
@@ -1203,6 +1887,33 @@ export interface operations {
1203
1887
  } & components["schemas"]["PaginatedListDto"];
1204
1888
  };
1205
1889
  };
1890
+ /** @description When the search request is invalid */
1891
+ 400: {
1892
+ headers: {
1893
+ [name: string]: unknown;
1894
+ };
1895
+ content: {
1896
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1897
+ };
1898
+ };
1899
+ /** @description When authentication fails */
1900
+ 401: {
1901
+ headers: {
1902
+ [name: string]: unknown;
1903
+ };
1904
+ content: {
1905
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1906
+ };
1907
+ };
1908
+ /** @description When the requesting user is not allowed to perform this action */
1909
+ 403: {
1910
+ headers: {
1911
+ [name: string]: unknown;
1912
+ };
1913
+ content: {
1914
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
1915
+ };
1916
+ };
1206
1917
  };
1207
1918
  };
1208
1919
  }