@palmetto/users-sdk 1.1.0 → 1.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/dist/__generated__/schema.d.ts +752 -59
  2. package/dist/client.d.ts +70 -134
  3. package/dist/client.js +24 -11
  4. package/dist/main.d.ts +4 -2
  5. package/dist/main.js +2 -1
  6. package/dist/scopes.d.ts +11 -0
  7. package/dist/scopes.js +50 -0
  8. package/package.json +1 -1
package/dist/__generated__/schema.d.ts CHANGED
@@ -22,14 +22,20 @@ export interface paths {
22
22
  path?: never;
23
23
  cookie?: never;
24
24
  };
25
- /** Get Current User */
25
+ /**
26
+ * Get Current User
27
+ * @deprecated
28
+ */
26
29
  get: operations["UsersController_getMe"];
27
30
  put?: never;
28
31
  post?: never;
29
32
  delete?: never;
30
33
  options?: never;
31
34
  head?: never;
32
- /** Update Current User */
35
+ /**
36
+ * Update Current User
37
+ * @deprecated
38
+ */
33
39
  patch: operations["UsersController_updateMe"];
34
40
  trace?: never;
35
41
  };
@@ -87,6 +93,41 @@ export interface paths {
87
93
  patch?: never;
88
94
  trace?: never;
89
95
  };
96
+ "/api/users/{id}/roles": {
97
+ parameters: {
98
+ query?: never;
99
+ header?: never;
100
+ path?: never;
101
+ cookie?: never;
102
+ };
103
+ /** Get roles */
104
+ get: operations["UsersController_getRoles"];
105
+ put?: never;
106
+ post?: never;
107
+ delete?: never;
108
+ options?: never;
109
+ head?: never;
110
+ patch?: never;
111
+ trace?: never;
112
+ };
113
+ "/api/users/{id}/roles/{roleId}": {
114
+ parameters: {
115
+ query?: never;
116
+ header?: never;
117
+ path?: never;
118
+ cookie?: never;
119
+ };
120
+ get?: never;
121
+ put?: never;
122
+ /** Add role to user */
123
+ post: operations["UsersController_addRole"];
124
+ /** Remove role from user */
125
+ delete: operations["UsersController_removeRole"];
126
+ options?: never;
127
+ head?: never;
128
+ patch?: never;
129
+ trace?: never;
130
+ };
90
131
  "/api/users/{id}/grants": {
91
132
  parameters: {
92
133
  query?: never;
@@ -105,6 +146,24 @@ export interface paths {
105
146
  patch?: never;
106
147
  trace?: never;
107
148
  };
149
+ "/api/v2/users/me": {
150
+ parameters: {
151
+ query?: never;
152
+ header?: never;
153
+ path?: never;
154
+ cookie?: never;
155
+ };
156
+ /** Get Current User */
157
+ get: operations["UsersV2Controller_getMe"];
158
+ put?: never;
159
+ post?: never;
160
+ delete?: never;
161
+ options?: never;
162
+ head?: never;
163
+ /** Update Current User */
164
+ patch: operations["UsersV2Controller_updateMe"];
165
+ trace?: never;
166
+ };
108
167
  "/api/organizations/{id}": {
109
168
  parameters: {
110
169
  query?: never;
@@ -140,6 +199,41 @@ export interface paths {
140
199
  patch?: never;
141
200
  trace?: never;
142
201
  };
202
+ "/api/roles": {
203
+ parameters: {
204
+ query?: never;
205
+ header?: never;
206
+ path?: never;
207
+ cookie?: never;
208
+ };
209
+ /** Get roles */
210
+ get: operations["RolesController_findAll"];
211
+ put?: never;
212
+ /** Create a new role */
213
+ post: operations["RolesController_create"];
214
+ delete?: never;
215
+ options?: never;
216
+ head?: never;
217
+ patch?: never;
218
+ trace?: never;
219
+ };
220
+ "/api/roles/{id}": {
221
+ parameters: {
222
+ query?: never;
223
+ header?: never;
224
+ path?: never;
225
+ cookie?: never;
226
+ };
227
+ /** Find role */
228
+ get: operations["RolesController_findOne"];
229
+ put?: never;
230
+ post?: never;
231
+ delete?: never;
232
+ options?: never;
233
+ head?: never;
234
+ patch?: never;
235
+ trace?: never;
236
+ };
143
237
  "/api/auth/token": {
144
238
  parameters: {
145
239
  query?: never;
@@ -283,7 +377,8 @@ export interface components {
283
377
  updatedAt?: string;
284
378
  };
285
379
  /**
286
- * @description Auth0 ID
380
+ * @deprecated
381
+ * @description Internal auth id
287
382
  * @example auth0|1234567890
288
383
  */
289
384
  auth0Id: string | null;
@@ -304,6 +399,7 @@ export interface components {
304
399
  */
305
400
  lastName: string;
306
401
  /**
402
+ * @deprecated
307
403
  * @description User permissions
308
404
  * @example {
309
405
  * "photon:blueprint": [
@@ -431,7 +527,8 @@ export interface components {
431
527
  updatedAt?: string;
432
528
  };
433
529
  /**
434
- * @description Auth0 ID
530
+ * @deprecated
531
+ * @description Internal auth id
435
532
  * @example auth0|1234567890
436
533
  */
437
534
  auth0Id: string | null;
@@ -500,21 +597,30 @@ export interface components {
500
597
  /** @default [] */
501
598
  grants: {
502
599
  /**
503
- * @description Grant Entity
600
+ * @description The entity to grant access to
504
601
  * @example photon:blueprint
505
602
  */
506
603
  entity: string;
507
604
  /**
508
- * @description Operation
605
+ * @description The operation on the entity to grant access to
509
606
  * @example read
510
607
  */
511
608
  operation: string;
512
609
  /**
513
- * @description Deny
610
+ * @description The scope to apply to this grant to
611
+ * @default @self
612
+ * @enum {string}
613
+ */
614
+ scope: "@deny" | "@self" | "@org" | "@admin";
615
+ /**
616
+ * @deprecated
617
+ * @description Deny this operation instead of granting it. Use scope = -1 instead of using this field.
514
618
  * @example false
515
619
  */
516
620
  deny?: boolean;
517
621
  }[];
622
+ /** @default [] */
623
+ roleIds: string[];
518
624
  };
519
625
  /** NotFoundError */
520
626
  NotFoundErrorDto: {
@@ -560,19 +666,154 @@ export interface components {
560
666
  /** @description Personal access token */
561
667
  personalAccessToken?: string;
562
668
  };
563
- /** GrantInput */
564
- GrantInputDto: {
669
+ /** List */
670
+ ListDto: {
671
+ data: unknown[];
672
+ };
673
+ /** Role */
674
+ RoleDto: {
675
+ organizationId?: string;
676
+ name: string;
677
+ /** @enum {string} */
678
+ requiredScope: "@org" | "@admin";
679
+ grants: {
680
+ /**
681
+ * @description Grant entity
682
+ * @example photon:tasks
683
+ */
684
+ entity: string;
685
+ /**
686
+ * @description Grant operation
687
+ * @example read
688
+ */
689
+ operation: string;
690
+ /**
691
+ * @example @self
692
+ * @enum {string}
693
+ */
694
+ scope: "@deny" | "@self" | "@org" | "@admin";
695
+ /**
696
+ * @deprecated
697
+ * @example false
698
+ */
699
+ deny?: boolean;
700
+ }[];
701
+ meta: {
702
+ /**
703
+ * Format: date-time
704
+ * @description Created at timestamp
705
+ * @example 2024-09-11T00:09:06.276+0000
706
+ */
707
+ createdAt: string;
708
+ /**
709
+ * Format: date-time
710
+ * @description Updated at timestamp
711
+ * @example 2024-09-11T00:09:06.276+0000
712
+ */
713
+ updatedAt?: string;
714
+ };
715
+ };
716
+ /** CreateGrant */
717
+ CreateGrantDto: {
718
+ /**
719
+ * @description The entity to grant access to
720
+ * @example photon:blueprint
721
+ */
722
+ entity: string;
723
+ /**
724
+ * @description The operation on the entity to grant access to
725
+ * @example read
726
+ */
727
+ operation: string;
728
+ /**
729
+ * @description The scope to apply to this grant to
730
+ * @default @self
731
+ * @enum {string}
732
+ */
733
+ scope: "@deny" | "@self" | "@org" | "@admin";
734
+ /**
735
+ * @deprecated
736
+ * @description Deny this operation instead of granting it. Use scope = -1 instead of using this field.
737
+ * @example false
738
+ */
739
+ deny?: boolean;
740
+ };
741
+ /** RemoveGrantInput */
742
+ RemoveGrantInputDto: {
565
743
  /**
566
- * @description Grant Entity
744
+ * @description The entity to grant access to
567
745
  * @example photon:blueprint
568
746
  */
569
747
  entity: string;
570
748
  /**
571
- * @description Operation
749
+ * @description The operation on the entity to grant access to
572
750
  * @example read
573
751
  */
574
752
  operation: string;
575
753
  };
754
+ /** Me */
755
+ MeDto: {
756
+ /** @example 66e25e72d10dfef2f9f6cc60 */
757
+ id: string;
758
+ meta: {
759
+ /**
760
+ * Format: date-time
761
+ * @description Created at timestamp
762
+ * @example 2024-09-11T00:09:06.276+0000
763
+ */
764
+ createdAt: string;
765
+ /**
766
+ * Format: date-time
767
+ * @description Updated at timestamp
768
+ * @example 2024-09-11T00:09:06.276+0000
769
+ */
770
+ updatedAt?: string;
771
+ };
772
+ /**
773
+ * Format: email
774
+ * @description Email
775
+ * @example test@test.com
776
+ */
777
+ email: string;
778
+ /**
779
+ * @description First name
780
+ * @example John
781
+ */
782
+ firstName: string;
783
+ /**
784
+ * @description Last name
785
+ * @example Doe
786
+ */
787
+ lastName: string;
788
+ /**
789
+ * @description Phone number
790
+ * @example +18048675309
791
+ */
792
+ phoneNumber: string;
793
+ /**
794
+ * @description Organization ID
795
+ * @example 66e3367b141b81fb54ec4e1f
796
+ */
797
+ organizationId: string;
798
+ /**
799
+ * @description Has Personal Access Token
800
+ * @example false
801
+ */
802
+ hasPAT: boolean;
803
+ /**
804
+ * @description Permissions mapped to scopes
805
+ * @example {
806
+ * "lux:quote": {
807
+ * "read": "@org"
808
+ * }
809
+ * }
810
+ */
811
+ permissions: {
812
+ [key: string]: {
813
+ [key: string]: "@deny" | "@self" | "@org" | "@admin";
814
+ };
815
+ };
816
+ };
576
817
  /** Organization */
577
818
  OrganizationDto: {
578
819
  /** @example 66e25e72d10dfef2f9f6cc60 */
@@ -597,6 +838,7 @@ export interface components {
597
838
  */
598
839
  name: string;
599
840
  /**
841
+ * @deprecated
600
842
  * @description Organization permissions
601
843
  * @example {
602
844
  * "photon:blueprint": [
@@ -622,17 +864,24 @@ export interface components {
622
864
  */
623
865
  grants: {
624
866
  /**
625
- * @description Grant Entity
867
+ * @description The entity to grant access to
626
868
  * @example photon:blueprint
627
869
  */
628
870
  entity: string;
629
871
  /**
630
- * @description Operation
872
+ * @description The operation on the entity to grant access to
631
873
  * @example read
632
874
  */
633
875
  operation: string;
634
876
  /**
635
- * @description Deny
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.
636
885
  * @example false
637
886
  */
638
887
  deny?: boolean;
@@ -646,11 +895,41 @@ export interface components {
646
895
  */
647
896
  name: string;
648
897
  };
898
+ /** CreateRole */
899
+ CreateRoleDto: {
900
+ /** @example 66e25e72d10dfef2f9f6cc60 */
901
+ organizationId?: string;
902
+ name: string;
903
+ /**
904
+ * @default @org
905
+ * @enum {string}
906
+ */
907
+ requiredScope: "@org" | "@admin";
908
+ grants: {
909
+ /**
910
+ * @description The entity to grant access to
911
+ * @example photon:blueprint
912
+ */
913
+ entity: string;
914
+ /**
915
+ * @description The operation on the entity to grant access to
916
+ * @example read
917
+ */
918
+ operation: string;
919
+ /** @enum {string} */
920
+ scope: "@self" | "@org" | "@admin";
921
+ }[];
922
+ };
649
923
  /** TokenInput */
650
924
  TokenInputDto: {
651
925
  /** @enum {string} */
652
926
  grant_type: "authorization_code";
653
927
  code: string;
928
+ /**
929
+ * @deprecated
930
+ * @description Obtain access tokens without verifying that the user exists
931
+ */
932
+ skip_user_verification?: boolean;
654
933
  } | {
655
934
  /** @enum {string} */
656
935
  grant_type: "refresh_token";
@@ -735,7 +1014,8 @@ export interface components {
735
1014
  updatedAt?: string;
736
1015
  };
737
1016
  /**
738
- * @description Auth0 ID
1017
+ * @deprecated
1018
+ * @description Internal auth id
739
1019
  * @example auth0|1234567890
740
1020
  */
741
1021
  auth0Id: string | null;
@@ -1272,15 +1552,6 @@ export interface operations {
1272
1552
  "application/json": components["schemas"]["UnauthorizedErrorDto"];
1273
1553
  };
1274
1554
  };
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
1555
  /** @description When the user is not found */
1285
1556
  404: {
1286
1557
  headers: {
@@ -1292,7 +1563,7 @@ export interface operations {
1292
1563
  };
1293
1564
  };
1294
1565
  };
1295
- UsersController_addGrant: {
1566
+ UsersController_getRoles: {
1296
1567
  parameters: {
1297
1568
  query?: never;
1298
1569
  header?: never;
@@ -1301,21 +1572,19 @@ export interface operations {
1301
1572
  };
1302
1573
  cookie?: never;
1303
1574
  };
1304
- requestBody: {
1305
- content: {
1306
- "application/json": components["schemas"]["GrantInputDto"];
1307
- };
1308
- };
1575
+ requestBody?: never;
1309
1576
  responses: {
1310
- 201: {
1577
+ 200: {
1311
1578
  headers: {
1312
1579
  [name: string]: unknown;
1313
1580
  };
1314
1581
  content: {
1315
- "application/json": components["schemas"]["UserDto"];
1582
+ "application/json": {
1583
+ data: components["schemas"]["RoleDto"][];
1584
+ };
1316
1585
  };
1317
1586
  };
1318
- /** @description When the ID or body request is invalid */
1587
+ /** @description When the request is invalid */
1319
1588
  400: {
1320
1589
  headers: {
1321
1590
  [name: string]: unknown;
@@ -1342,33 +1611,21 @@ export interface operations {
1342
1611
  "application/json": components["schemas"]["ForbiddenErrorDto"];
1343
1612
  };
1344
1613
  };
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
- };
1354
1614
  };
1355
1615
  };
1356
- UsersController_removeGrant: {
1616
+ UsersController_addRole: {
1357
1617
  parameters: {
1358
1618
  query?: never;
1359
1619
  header?: never;
1360
1620
  path: {
1361
1621
  id: string;
1622
+ roleId: string;
1362
1623
  };
1363
1624
  cookie?: never;
1364
1625
  };
1365
- requestBody: {
1366
- content: {
1367
- "application/json": components["schemas"]["GrantInputDto"];
1368
- };
1369
- };
1626
+ requestBody?: never;
1370
1627
  responses: {
1371
- 200: {
1628
+ 201: {
1372
1629
  headers: {
1373
1630
  [name: string]: unknown;
1374
1631
  };
@@ -1376,7 +1633,7 @@ export interface operations {
1376
1633
  "application/json": components["schemas"]["UserDto"];
1377
1634
  };
1378
1635
  };
1379
- /** @description When the ID or body request is invalid */
1636
+ /** @description When the request is invalid */
1380
1637
  400: {
1381
1638
  headers: {
1382
1639
  [name: string]: unknown;
@@ -1403,7 +1660,7 @@ export interface operations {
1403
1660
  "application/json": components["schemas"]["ForbiddenErrorDto"];
1404
1661
  };
1405
1662
  };
1406
- /** @description When the user is not found */
1663
+ /** @description When the user or role is not found */
1407
1664
  404: {
1408
1665
  headers: {
1409
1666
  [name: string]: unknown;
@@ -1414,12 +1671,13 @@ export interface operations {
1414
1671
  };
1415
1672
  };
1416
1673
  };
1417
- OrganizationsController_getOrganization: {
1674
+ UsersController_removeRole: {
1418
1675
  parameters: {
1419
1676
  query?: never;
1420
1677
  header?: never;
1421
1678
  path: {
1422
1679
  id: string;
1680
+ roleId: string;
1423
1681
  };
1424
1682
  cookie?: never;
1425
1683
  };
@@ -1430,10 +1688,10 @@ export interface operations {
1430
1688
  [name: string]: unknown;
1431
1689
  };
1432
1690
  content: {
1433
- "application/json": components["schemas"]["OrganizationDto"];
1691
+ "application/json": components["schemas"]["UserDto"];
1434
1692
  };
1435
1693
  };
1436
- /** @description When the provided ID is invalid */
1694
+ /** @description When the request is invalid */
1437
1695
  400: {
1438
1696
  headers: {
1439
1697
  [name: string]: unknown;
@@ -1460,7 +1718,7 @@ export interface operations {
1460
1718
  "application/json": components["schemas"]["ForbiddenErrorDto"];
1461
1719
  };
1462
1720
  };
1463
- /** @description When the organization is not found */
1721
+ /** @description When the user is not found */
1464
1722
  404: {
1465
1723
  headers: {
1466
1724
  [name: string]: unknown;
@@ -1471,7 +1729,7 @@ export interface operations {
1471
1729
  };
1472
1730
  };
1473
1731
  };
1474
- OrganizationsController_update: {
1732
+ UsersController_addGrant: {
1475
1733
  parameters: {
1476
1734
  query?: never;
1477
1735
  header?: never;
@@ -1482,7 +1740,264 @@ export interface operations {
1482
1740
  };
1483
1741
  requestBody: {
1484
1742
  content: {
1485
- "application/json": components["schemas"]["UpdateOrganizationDto"];
1743
+ "application/json": components["schemas"]["CreateGrantDto"];
1744
+ };
1745
+ };
1746
+ responses: {
1747
+ 201: {
1748
+ headers: {
1749
+ [name: string]: unknown;
1750
+ };
1751
+ content: {
1752
+ "application/json": components["schemas"]["UserDto"];
1753
+ };
1754
+ };
1755
+ /** @description When the ID or body request is invalid */
1756
+ 400: {
1757
+ headers: {
1758
+ [name: string]: unknown;
1759
+ };
1760
+ content: {
1761
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1762
+ };
1763
+ };
1764
+ /** @description When authentication fails */
1765
+ 401: {
1766
+ headers: {
1767
+ [name: string]: unknown;
1768
+ };
1769
+ content: {
1770
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1771
+ };
1772
+ };
1773
+ /** @description When the requesting user is not allowed to perform this action */
1774
+ 403: {
1775
+ headers: {
1776
+ [name: string]: unknown;
1777
+ };
1778
+ content: {
1779
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
1780
+ };
1781
+ };
1782
+ /** @description When the user is not found */
1783
+ 404: {
1784
+ headers: {
1785
+ [name: string]: unknown;
1786
+ };
1787
+ content: {
1788
+ "application/json": components["schemas"]["NotFoundErrorDto"];
1789
+ };
1790
+ };
1791
+ };
1792
+ };
1793
+ UsersController_removeGrant: {
1794
+ parameters: {
1795
+ query?: never;
1796
+ header?: never;
1797
+ path: {
1798
+ id: string;
1799
+ };
1800
+ cookie?: never;
1801
+ };
1802
+ requestBody: {
1803
+ content: {
1804
+ "application/json": components["schemas"]["RemoveGrantInputDto"];
1805
+ };
1806
+ };
1807
+ responses: {
1808
+ 200: {
1809
+ headers: {
1810
+ [name: string]: unknown;
1811
+ };
1812
+ content: {
1813
+ "application/json": components["schemas"]["UserDto"];
1814
+ };
1815
+ };
1816
+ /** @description When the ID or body request is invalid */
1817
+ 400: {
1818
+ headers: {
1819
+ [name: string]: unknown;
1820
+ };
1821
+ content: {
1822
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1823
+ };
1824
+ };
1825
+ /** @description When authentication fails */
1826
+ 401: {
1827
+ headers: {
1828
+ [name: string]: unknown;
1829
+ };
1830
+ content: {
1831
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1832
+ };
1833
+ };
1834
+ /** @description When the requesting user is not allowed to perform this action */
1835
+ 403: {
1836
+ headers: {
1837
+ [name: string]: unknown;
1838
+ };
1839
+ content: {
1840
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
1841
+ };
1842
+ };
1843
+ /** @description When the user is not found */
1844
+ 404: {
1845
+ headers: {
1846
+ [name: string]: unknown;
1847
+ };
1848
+ content: {
1849
+ "application/json": components["schemas"]["NotFoundErrorDto"];
1850
+ };
1851
+ };
1852
+ };
1853
+ };
1854
+ UsersV2Controller_getMe: {
1855
+ parameters: {
1856
+ query?: never;
1857
+ header?: never;
1858
+ path?: never;
1859
+ cookie?: never;
1860
+ };
1861
+ requestBody?: never;
1862
+ responses: {
1863
+ 200: {
1864
+ headers: {
1865
+ [name: string]: unknown;
1866
+ };
1867
+ content: {
1868
+ "application/json": components["schemas"]["MeDto"];
1869
+ };
1870
+ };
1871
+ /** @description When authentication fails */
1872
+ 401: {
1873
+ headers: {
1874
+ [name: string]: unknown;
1875
+ };
1876
+ content: {
1877
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1878
+ };
1879
+ };
1880
+ /** @description When the user does not have permission to access this resource */
1881
+ 403: {
1882
+ headers: {
1883
+ [name: string]: unknown;
1884
+ };
1885
+ content: {
1886
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
1887
+ };
1888
+ };
1889
+ };
1890
+ };
1891
+ UsersV2Controller_updateMe: {
1892
+ parameters: {
1893
+ query?: never;
1894
+ header?: never;
1895
+ path?: never;
1896
+ cookie?: never;
1897
+ };
1898
+ requestBody: {
1899
+ content: {
1900
+ "application/json": components["schemas"]["UpdateUserDto"];
1901
+ };
1902
+ };
1903
+ responses: {
1904
+ 200: {
1905
+ headers: {
1906
+ [name: string]: unknown;
1907
+ };
1908
+ content: {
1909
+ "application/json": components["schemas"]["MeDto"];
1910
+ };
1911
+ };
1912
+ /** @description When the body request is invalid */
1913
+ 400: {
1914
+ headers: {
1915
+ [name: string]: unknown;
1916
+ };
1917
+ content: {
1918
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1919
+ };
1920
+ };
1921
+ /** @description When authentication fails */
1922
+ 401: {
1923
+ headers: {
1924
+ [name: string]: unknown;
1925
+ };
1926
+ content: {
1927
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1928
+ };
1929
+ };
1930
+ };
1931
+ };
1932
+ OrganizationsController_getOrganization: {
1933
+ parameters: {
1934
+ query?: never;
1935
+ header?: never;
1936
+ path: {
1937
+ id: string;
1938
+ };
1939
+ cookie?: never;
1940
+ };
1941
+ requestBody?: never;
1942
+ responses: {
1943
+ 200: {
1944
+ headers: {
1945
+ [name: string]: unknown;
1946
+ };
1947
+ content: {
1948
+ "application/json": components["schemas"]["OrganizationDto"];
1949
+ };
1950
+ };
1951
+ /** @description When the provided ID is invalid */
1952
+ 400: {
1953
+ headers: {
1954
+ [name: string]: unknown;
1955
+ };
1956
+ content: {
1957
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1958
+ };
1959
+ };
1960
+ /** @description When authentication fails */
1961
+ 401: {
1962
+ headers: {
1963
+ [name: string]: unknown;
1964
+ };
1965
+ content: {
1966
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1967
+ };
1968
+ };
1969
+ /** @description When the requesting user is not allowed to perform this action */
1970
+ 403: {
1971
+ headers: {
1972
+ [name: string]: unknown;
1973
+ };
1974
+ content: {
1975
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
1976
+ };
1977
+ };
1978
+ /** @description When the organization is not found */
1979
+ 404: {
1980
+ headers: {
1981
+ [name: string]: unknown;
1982
+ };
1983
+ content: {
1984
+ "application/json": components["schemas"]["NotFoundErrorDto"];
1985
+ };
1986
+ };
1987
+ };
1988
+ };
1989
+ OrganizationsController_update: {
1990
+ parameters: {
1991
+ query?: never;
1992
+ header?: never;
1993
+ path: {
1994
+ id: string;
1995
+ };
1996
+ cookie?: never;
1997
+ };
1998
+ requestBody: {
1999
+ content: {
2000
+ "application/json": components["schemas"]["UpdateOrganizationDto"];
1486
2001
  };
1487
2002
  };
1488
2003
  responses: {
@@ -1582,6 +2097,166 @@ export interface operations {
1582
2097
  };
1583
2098
  };
1584
2099
  };
2100
+ RolesController_findAll: {
2101
+ parameters: {
2102
+ query?: {
2103
+ page?: number;
2104
+ limit?: number;
2105
+ /** @example 66e25e72d10dfef2f9f6cc60 */
2106
+ organizationId?: string;
2107
+ };
2108
+ header?: never;
2109
+ path?: never;
2110
+ cookie?: never;
2111
+ };
2112
+ requestBody?: never;
2113
+ responses: {
2114
+ 200: {
2115
+ headers: {
2116
+ [name: string]: unknown;
2117
+ };
2118
+ content: {
2119
+ "application/json": {
2120
+ data: components["schemas"]["RoleDto"][];
2121
+ } & components["schemas"]["PaginatedListDto"];
2122
+ };
2123
+ };
2124
+ /** @description When the request is invalid */
2125
+ 400: {
2126
+ headers: {
2127
+ [name: string]: unknown;
2128
+ };
2129
+ content: {
2130
+ "application/json": components["schemas"]["BadRequestErrorDto"];
2131
+ };
2132
+ };
2133
+ /** @description When authentication fails */
2134
+ 401: {
2135
+ headers: {
2136
+ [name: string]: unknown;
2137
+ };
2138
+ content: {
2139
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
2140
+ };
2141
+ };
2142
+ /** @description When the requesting user is not allowed to perform this action */
2143
+ 403: {
2144
+ headers: {
2145
+ [name: string]: unknown;
2146
+ };
2147
+ content: {
2148
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
2149
+ };
2150
+ };
2151
+ };
2152
+ };
2153
+ RolesController_create: {
2154
+ parameters: {
2155
+ query?: never;
2156
+ header?: never;
2157
+ path?: never;
2158
+ cookie?: never;
2159
+ };
2160
+ requestBody: {
2161
+ content: {
2162
+ "application/json": components["schemas"]["CreateRoleDto"];
2163
+ };
2164
+ };
2165
+ responses: {
2166
+ 201: {
2167
+ headers: {
2168
+ [name: string]: unknown;
2169
+ };
2170
+ content: {
2171
+ "application/json": components["schemas"]["RoleDto"];
2172
+ };
2173
+ };
2174
+ /** @description When the request is invalid */
2175
+ 400: {
2176
+ headers: {
2177
+ [name: string]: unknown;
2178
+ };
2179
+ content: {
2180
+ "application/json": components["schemas"]["BadRequestErrorDto"];
2181
+ };
2182
+ };
2183
+ /** @description When authentication fails */
2184
+ 401: {
2185
+ headers: {
2186
+ [name: string]: unknown;
2187
+ };
2188
+ content: {
2189
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
2190
+ };
2191
+ };
2192
+ /** @description When the requesting user is not allowed to perform this action */
2193
+ 403: {
2194
+ headers: {
2195
+ [name: string]: unknown;
2196
+ };
2197
+ content: {
2198
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
2199
+ };
2200
+ };
2201
+ };
2202
+ };
2203
+ RolesController_findOne: {
2204
+ parameters: {
2205
+ query?: never;
2206
+ header?: never;
2207
+ path: {
2208
+ id: string;
2209
+ };
2210
+ cookie?: never;
2211
+ };
2212
+ requestBody?: never;
2213
+ responses: {
2214
+ 200: {
2215
+ headers: {
2216
+ [name: string]: unknown;
2217
+ };
2218
+ content: {
2219
+ "application/json": components["schemas"]["RoleDto"];
2220
+ };
2221
+ };
2222
+ /** @description When the request is invalid */
2223
+ 400: {
2224
+ headers: {
2225
+ [name: string]: unknown;
2226
+ };
2227
+ content: {
2228
+ "application/json": components["schemas"]["BadRequestErrorDto"];
2229
+ };
2230
+ };
2231
+ /** @description When authentication fails */
2232
+ 401: {
2233
+ headers: {
2234
+ [name: string]: unknown;
2235
+ };
2236
+ content: {
2237
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
2238
+ };
2239
+ };
2240
+ /** @description When the requesting user is not allowed to perform this action */
2241
+ 403: {
2242
+ headers: {
2243
+ [name: string]: unknown;
2244
+ };
2245
+ content: {
2246
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
2247
+ };
2248
+ };
2249
+ /** @description When the Role is not found */
2250
+ 404: {
2251
+ headers: {
2252
+ [name: string]: unknown;
2253
+ };
2254
+ content: {
2255
+ "application/json": components["schemas"]["NotFoundErrorDto"];
2256
+ };
2257
+ };
2258
+ };
2259
+ };
1585
2260
  AuthController_generateToken: {
1586
2261
  parameters: {
1587
2262
  query?: never;
@@ -1612,6 +2287,15 @@ export interface operations {
1612
2287
  "application/json": components["schemas"]["BadRequestErrorDto"];
1613
2288
  };
1614
2289
  };
2290
+ /** @description When the user does not exist for the exchange token */
2291
+ 404: {
2292
+ headers: {
2293
+ [name: string]: unknown;
2294
+ };
2295
+ content: {
2296
+ "application/json": components["schemas"]["NotFoundErrorDto"];
2297
+ };
2298
+ };
1615
2299
  };
1616
2300
  };
1617
2301
  SignUpsController_findAll: {
@@ -1680,7 +2364,7 @@ export interface operations {
1680
2364
  };
1681
2365
  };
1682
2366
  responses: {
1683
- 200: {
2367
+ 201: {
1684
2368
  headers: {
1685
2369
  [name: string]: unknown;
1686
2370
  };
@@ -1706,6 +2390,15 @@ export interface operations {
1706
2390
  "application/json": components["schemas"]["UnauthorizedErrorDto"];
1707
2391
  };
1708
2392
  };
2393
+ /** @description When the requesting user is not allowed to perform this action */
2394
+ 403: {
2395
+ headers: {
2396
+ [name: string]: unknown;
2397
+ };
2398
+ content: {
2399
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
2400
+ };
2401
+ };
1709
2402
  };
1710
2403
  };
1711
2404
  SignUpsController_findOne: {
@@ -1826,7 +2519,7 @@ export interface operations {
1826
2519
  };
1827
2520
  content?: never;
1828
2521
  };
1829
- /** @description When the sign up ID is invalid */
2522
+ /** @description When the request is invalid */
1830
2523
  400: {
1831
2524
  headers: {
1832
2525
  [name: string]: unknown;