@lumoauth/api-client 1.5.0 → 1.6.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 (248) hide show
  1. package/.openapi-generator/FILES +12 -2
  2. package/README.md +10 -3
  3. package/api/admin-abac-api.ts +18 -5
  4. package/api/admin-agents-api.ts +50 -5
  5. package/api/admin-audit-logs-api.ts +15 -15
  6. package/api/admin-email-api.ts +15 -15
  7. package/api/admin-groups-api.ts +15 -15
  8. package/api/admin-mfa-api.ts +10 -10
  9. package/api/admin-oauth-clients-api.ts +15 -15
  10. package/api/admin-roles-api.ts +20 -20
  11. package/api/admin-settings-api.ts +112 -60
  12. package/api/admin-users-api.ts +320 -31
  13. package/api/agents-api.ts +5 -5
  14. package/api/authorization-api.ts +20 -20
  15. package/api/oauth-api.ts +116 -5
  16. package/api/ssf-api.ts +10 -10
  17. package/dist/api/admin-abac-api.d.ts +10 -2
  18. package/dist/api/admin-abac-api.js +10 -5
  19. package/dist/api/admin-agents-api.d.ts +37 -2
  20. package/dist/api/admin-agents-api.js +37 -6
  21. package/dist/api/admin-audit-logs-api.d.ts +15 -15
  22. package/dist/api/admin-audit-logs-api.js +12 -12
  23. package/dist/api/admin-email-api.d.ts +15 -15
  24. package/dist/api/admin-email-api.js +12 -12
  25. package/dist/api/admin-groups-api.d.ts +15 -15
  26. package/dist/api/admin-groups-api.js +12 -12
  27. package/dist/api/admin-mfa-api.d.ts +10 -10
  28. package/dist/api/admin-mfa-api.js +8 -8
  29. package/dist/api/admin-oauth-clients-api.d.ts +15 -15
  30. package/dist/api/admin-oauth-clients-api.js +12 -12
  31. package/dist/api/admin-roles-api.d.ts +20 -20
  32. package/dist/api/admin-roles-api.js +16 -16
  33. package/dist/api/admin-settings-api.d.ts +82 -48
  34. package/dist/api/admin-settings-api.js +68 -52
  35. package/dist/api/admin-users-api.d.ts +201 -22
  36. package/dist/api/admin-users-api.js +185 -28
  37. package/dist/api/agents-api.d.ts +5 -5
  38. package/dist/api/agents-api.js +4 -4
  39. package/dist/api/authorization-api.d.ts +20 -20
  40. package/dist/api/authorization-api.js +16 -16
  41. package/dist/api/oauth-api.d.ts +70 -5
  42. package/dist/api/oauth-api.js +76 -4
  43. package/dist/api/ssf-api.d.ts +10 -10
  44. package/dist/api/ssf-api.js +8 -8
  45. package/dist/esm/api/admin-abac-api.d.ts +10 -2
  46. package/dist/esm/api/admin-abac-api.js +10 -5
  47. package/dist/esm/api/admin-agents-api.d.ts +37 -2
  48. package/dist/esm/api/admin-agents-api.js +36 -5
  49. package/dist/esm/api/admin-audit-logs-api.d.ts +15 -15
  50. package/dist/esm/api/admin-audit-logs-api.js +12 -12
  51. package/dist/esm/api/admin-email-api.d.ts +15 -15
  52. package/dist/esm/api/admin-email-api.js +12 -12
  53. package/dist/esm/api/admin-groups-api.d.ts +15 -15
  54. package/dist/esm/api/admin-groups-api.js +12 -12
  55. package/dist/esm/api/admin-mfa-api.d.ts +10 -10
  56. package/dist/esm/api/admin-mfa-api.js +8 -8
  57. package/dist/esm/api/admin-oauth-clients-api.d.ts +15 -15
  58. package/dist/esm/api/admin-oauth-clients-api.js +12 -12
  59. package/dist/esm/api/admin-roles-api.d.ts +20 -20
  60. package/dist/esm/api/admin-roles-api.js +16 -16
  61. package/dist/esm/api/admin-settings-api.d.ts +82 -48
  62. package/dist/esm/api/admin-settings-api.js +69 -53
  63. package/dist/esm/api/admin-users-api.d.ts +201 -22
  64. package/dist/esm/api/admin-users-api.js +184 -27
  65. package/dist/esm/api/agents-api.d.ts +5 -5
  66. package/dist/esm/api/agents-api.js +4 -4
  67. package/dist/esm/api/authorization-api.d.ts +20 -20
  68. package/dist/esm/api/authorization-api.js +16 -16
  69. package/dist/esm/api/oauth-api.d.ts +70 -5
  70. package/dist/esm/api/oauth-api.js +76 -4
  71. package/dist/esm/api/ssf-api.d.ts +10 -10
  72. package/dist/esm/api/ssf-api.js +8 -8
  73. package/dist/esm/models/abac-attribute-definition.d.ts +6 -0
  74. package/dist/esm/models/abac-policy.d.ts +7 -1
  75. package/dist/esm/models/admin-analytics-dashboard-response-data-audit.d.ts +1 -1
  76. package/dist/esm/models/admin-groups-list-response.d.ts +6 -0
  77. package/dist/esm/models/admin-mcp-servers-list-response.d.ts +8 -3
  78. package/dist/esm/models/admin-settings-all-response-data-general.d.ts +13 -1
  79. package/dist/esm/models/admin-settings-all-response-data.d.ts +4 -5
  80. package/dist/esm/models/admin-settings-email-get-response.d.ts +4 -5
  81. package/dist/esm/models/admin-settings-general-get-response-data.d.ts +4 -10
  82. package/dist/esm/models/{admin-mcp-servers-list-response-meta.d.ts → admin-users-restore-response.d.ts} +9 -14
  83. package/dist/esm/models/ask-response.d.ts +15 -0
  84. package/dist/esm/models/ask-response.js +10 -1
  85. package/dist/esm/models/attest-response.d.ts +2 -2
  86. package/dist/esm/models/authorization-server-metadata.d.ts +8 -2
  87. package/dist/esm/models/check-email-first-request.d.ts +30 -0
  88. package/dist/esm/models/check-email-first-request.js +14 -0
  89. package/dist/esm/models/check-email-first-response.d.ts +42 -0
  90. package/dist/esm/models/check-email-first-response.js +14 -0
  91. package/dist/esm/models/email-sender-settings.d.ts +62 -0
  92. package/dist/esm/models/email-sender-settings.js +22 -0
  93. package/dist/esm/models/get-me-response.d.ts +18 -0
  94. package/dist/esm/models/get-server-challenge-response.d.ts +3 -2
  95. package/dist/esm/models/get-server-challenge-response.js +1 -0
  96. package/dist/esm/models/index.d.ts +6 -1
  97. package/dist/esm/models/index.js +6 -1
  98. package/dist/esm/models/introspect-response.d.ts +6 -0
  99. package/dist/esm/models/issue-agent-token-request.d.ts +6 -0
  100. package/dist/esm/models/list-users-response.d.ts +6 -0
  101. package/dist/esm/models/oauth-scope.d.ts +1 -7
  102. package/dist/esm/models/open-id-configuration.d.ts +3 -3
  103. package/dist/esm/models/put-admin-settings-branding-update-response.d.ts +6 -0
  104. package/dist/esm/models/put-admin-settings-email-update-request.d.ts +36 -0
  105. package/dist/esm/models/put-admin-settings-email-update-request.js +14 -0
  106. package/dist/esm/models/put-admin-settings-email-update-response.d.ts +4 -5
  107. package/dist/esm/models/put-admin-settings-general-update-request.d.ts +30 -0
  108. package/dist/esm/models/put-admin-settings-general-update-request.js +14 -0
  109. package/dist/esm/models/put-admin-settings-general-update-response-data.d.ts +1 -7
  110. package/dist/esm/models/register-client-response.d.ts +0 -24
  111. package/dist/esm/models/registered-client-metadata.d.ts +0 -24
  112. package/dist/esm/models/social-login-provider.d.ts +2 -1
  113. package/dist/esm/models/user.d.ts +12 -0
  114. package/dist/esm/models/userinfo-response.d.ts +4 -12
  115. package/dist/esm/models/userinfo-response.js +0 -2
  116. package/dist/models/abac-attribute-definition.d.ts +6 -0
  117. package/dist/models/abac-policy.d.ts +7 -1
  118. package/dist/models/admin-analytics-dashboard-response-data-audit.d.ts +1 -1
  119. package/dist/models/admin-groups-list-response.d.ts +6 -0
  120. package/dist/models/admin-mcp-servers-list-response.d.ts +8 -3
  121. package/dist/models/admin-settings-all-response-data-general.d.ts +13 -1
  122. package/dist/models/admin-settings-all-response-data.d.ts +4 -5
  123. package/dist/models/admin-settings-email-get-response.d.ts +4 -5
  124. package/dist/models/admin-settings-general-get-response-data.d.ts +4 -10
  125. package/dist/models/{admin-mcp-servers-list-response-meta.d.ts → admin-users-restore-response.d.ts} +9 -14
  126. package/dist/models/ask-response.d.ts +15 -0
  127. package/dist/models/ask-response.js +11 -0
  128. package/dist/models/attest-response.d.ts +2 -2
  129. package/dist/models/authorization-server-metadata.d.ts +8 -2
  130. package/dist/models/check-email-first-request.d.ts +30 -0
  131. package/dist/models/check-email-first-request.js +15 -0
  132. package/dist/models/check-email-first-response.d.ts +42 -0
  133. package/dist/models/check-email-first-response.js +15 -0
  134. package/dist/models/email-sender-settings.d.ts +62 -0
  135. package/dist/models/email-sender-settings.js +25 -0
  136. package/dist/models/get-me-response.d.ts +18 -0
  137. package/dist/models/get-server-challenge-response.d.ts +3 -2
  138. package/dist/models/get-server-challenge-response.js +1 -0
  139. package/dist/models/index.d.ts +6 -1
  140. package/dist/models/index.js +6 -1
  141. package/dist/models/introspect-response.d.ts +6 -0
  142. package/dist/models/issue-agent-token-request.d.ts +6 -0
  143. package/dist/models/list-users-response.d.ts +6 -0
  144. package/dist/models/oauth-scope.d.ts +1 -7
  145. package/dist/models/open-id-configuration.d.ts +3 -3
  146. package/dist/models/put-admin-settings-branding-update-response.d.ts +6 -0
  147. package/dist/models/put-admin-settings-email-update-request.d.ts +36 -0
  148. package/dist/models/put-admin-settings-email-update-request.js +15 -0
  149. package/dist/models/put-admin-settings-email-update-response.d.ts +4 -5
  150. package/dist/models/put-admin-settings-general-update-request.d.ts +30 -0
  151. package/dist/models/put-admin-settings-general-update-request.js +15 -0
  152. package/dist/models/put-admin-settings-general-update-response-data.d.ts +1 -7
  153. package/dist/models/register-client-response.d.ts +0 -24
  154. package/dist/models/registered-client-metadata.d.ts +0 -24
  155. package/dist/models/social-login-provider.d.ts +2 -1
  156. package/dist/models/user.d.ts +12 -0
  157. package/dist/models/userinfo-response.d.ts +4 -12
  158. package/dist/models/userinfo-response.js +0 -2
  159. package/docs/AbacAttributeDefinition.md +2 -0
  160. package/docs/AbacPolicy.md +3 -1
  161. package/docs/AdminAbacApi.md +14 -9
  162. package/docs/AdminAgentsApi.md +7 -1
  163. package/docs/AdminAnalyticsDashboardResponseDataAudit.md +1 -1
  164. package/docs/AdminAuditLogsApi.md +3 -0
  165. package/docs/AdminEmailApi.md +3 -0
  166. package/docs/AdminGroupsApi.md +3 -0
  167. package/docs/AdminGroupsListResponse.md +2 -0
  168. package/docs/AdminMcpServersListResponse.md +3 -1
  169. package/docs/AdminMfaApi.md +4 -2
  170. package/docs/AdminOAuthClientsApi.md +3 -1
  171. package/docs/AdminOrganizationsApi.md +13 -5
  172. package/docs/AdminRolesApi.md +10 -0
  173. package/docs/AdminSettingsAllResponseData.md +1 -1
  174. package/docs/AdminSettingsAllResponseDataGeneral.md +5 -1
  175. package/docs/AdminSettingsApi.md +54 -12
  176. package/docs/AdminSettingsEmailGetResponse.md +1 -1
  177. package/docs/AdminSettingsGeneralGetResponseData.md +4 -6
  178. package/docs/AdminUsersApi.md +104 -2
  179. package/docs/AdminUsersRestoreResponse.md +22 -0
  180. package/docs/AgentsApi.md +2 -2
  181. package/docs/AskResponse.md +2 -0
  182. package/docs/AttestResponse.md +1 -1
  183. package/docs/AuthorizationApi.md +4 -4
  184. package/docs/AuthorizationServerMetadata.md +4 -2
  185. package/docs/CheckEmailFirstRequest.md +22 -0
  186. package/docs/CheckEmailFirstResponse.md +26 -0
  187. package/docs/EmailSenderSettings.md +31 -0
  188. package/docs/GetMeResponse.md +6 -0
  189. package/docs/GetServerChallengeResponse.md +1 -1
  190. package/docs/IdentityApi.md +2 -2
  191. package/docs/IntrospectResponse.md +2 -0
  192. package/docs/IssueAgentTokenRequest.md +2 -0
  193. package/docs/ListUsersResponse.md +2 -0
  194. package/docs/McpApi.md +5 -6
  195. package/docs/OAuthApi.md +72 -12
  196. package/docs/OAuthScope.md +1 -3
  197. package/docs/OIDCApi.md +4 -4
  198. package/docs/OpenIdConfiguration.md +3 -3
  199. package/docs/PutAdminSettingsBrandingUpdateResponse.md +2 -0
  200. package/docs/PutAdminSettingsEmailUpdateRequest.md +24 -0
  201. package/docs/PutAdminSettingsEmailUpdateResponse.md +1 -1
  202. package/docs/PutAdminSettingsGeneralUpdateRequest.md +22 -0
  203. package/docs/PutAdminSettingsGeneralUpdateResponseData.md +1 -3
  204. package/docs/RegisterClientResponse.md +0 -8
  205. package/docs/RegisteredClientMetadata.md +0 -8
  206. package/docs/SocialLoginProvider.md +1 -1
  207. package/docs/SsfApi.md +2 -0
  208. package/docs/User.md +4 -0
  209. package/docs/UserinfoResponse.md +3 -5
  210. package/docs/WellKnownApi.md +2 -2
  211. package/models/abac-attribute-definition.ts +6 -0
  212. package/models/abac-policy.ts +7 -1
  213. package/models/admin-analytics-dashboard-response-data-audit.ts +1 -1
  214. package/models/admin-groups-list-response.ts +6 -0
  215. package/models/admin-mcp-servers-list-response.ts +8 -5
  216. package/models/admin-settings-all-response-data-general.ts +13 -1
  217. package/models/admin-settings-all-response-data.ts +6 -3
  218. package/models/admin-settings-email-get-response.ts +6 -3
  219. package/models/admin-settings-general-get-response-data.ts +4 -10
  220. package/models/{admin-mcp-servers-list-response-meta.ts → admin-users-restore-response.ts} +11 -14
  221. package/models/ask-response.ts +17 -0
  222. package/models/attest-response.ts +2 -2
  223. package/models/authorization-server-metadata.ts +8 -2
  224. package/models/check-email-first-request.ts +36 -0
  225. package/models/check-email-first-response.ts +48 -0
  226. package/models/email-sender-settings.ts +70 -0
  227. package/models/get-me-response.ts +18 -0
  228. package/models/get-server-challenge-response.ts +3 -2
  229. package/models/index.ts +6 -1
  230. package/models/introspect-response.ts +6 -0
  231. package/models/issue-agent-token-request.ts +6 -0
  232. package/models/list-users-response.ts +6 -0
  233. package/models/oauth-scope.ts +1 -7
  234. package/models/open-id-configuration.ts +3 -3
  235. package/models/put-admin-settings-branding-update-response.ts +6 -0
  236. package/models/put-admin-settings-email-update-request.ts +42 -0
  237. package/models/put-admin-settings-email-update-response.ts +6 -3
  238. package/models/put-admin-settings-general-update-request.ts +36 -0
  239. package/models/put-admin-settings-general-update-response-data.ts +1 -7
  240. package/models/register-client-response.ts +0 -24
  241. package/models/registered-client-metadata.ts +0 -24
  242. package/models/social-login-provider.ts +2 -1
  243. package/models/user.ts +12 -0
  244. package/models/userinfo-response.ts +4 -12
  245. package/package.json +1 -1
  246. package/docs/AdminMcpServersListResponseMeta.md +0 -24
  247. /package/dist/esm/models/{admin-mcp-servers-list-response-meta.js → admin-users-restore-response.js} +0 -0
  248. /package/dist/models/{admin-mcp-servers-list-response-meta.js → admin-users-restore-response.js} +0 -0
@@ -75,7 +75,7 @@ const AdminOAuthClientsApiAxiosParamCreator = function (configuration) {
75
75
  };
76
76
  }),
77
77
  /**
78
- * Login settings use the same keys as the organization branding settings (GET /settings/branding); a missing or null value means \"same as the organization\".
78
+ * Needs `branding.view` and `clients.view`. Login settings use the same keys as the organization branding settings (GET /settings/branding); a missing or null value means \"same as the organization\".
79
79
  * @summary Get an OAuth client\'s login and consent page branding
80
80
  * @param {string} orgId
81
81
  * @param {string} clientId
@@ -371,7 +371,7 @@ const AdminOAuthClientsApiAxiosParamCreator = function (configuration) {
371
371
  };
372
372
  }),
373
373
  /**
374
- *
374
+ * Needs `branding.edit` and `clients.edit`, as the Branding tab of the application in the portal does.
375
375
  * @summary Change keys of an OAuth client\'s login and/or consent page branding
376
376
  * @param {string} orgId
377
377
  * @param {string} clientId
@@ -450,7 +450,7 @@ const AdminOAuthClientsApiAxiosParamCreator = function (configuration) {
450
450
  };
451
451
  }),
452
452
  /**
453
- *
453
+ * Needs `branding.edit` and `clients.edit`, as the Branding tab of the application in the portal does.
454
454
  * @summary Replace an OAuth client\'s login and/or consent page branding
455
455
  * @param {string} orgId
456
456
  * @param {string} clientId
@@ -632,7 +632,7 @@ const AdminOAuthClientsApiFp = function (configuration) {
632
632
  });
633
633
  },
634
634
  /**
635
- * Login settings use the same keys as the organization branding settings (GET /settings/branding); a missing or null value means \"same as the organization\".
635
+ * Needs `branding.view` and `clients.view`. Login settings use the same keys as the organization branding settings (GET /settings/branding); a missing or null value means \"same as the organization\".
636
636
  * @summary Get an OAuth client\'s login and consent page branding
637
637
  * @param {string} orgId
638
638
  * @param {string} clientId
@@ -766,7 +766,7 @@ const AdminOAuthClientsApiFp = function (configuration) {
766
766
  });
767
767
  },
768
768
  /**
769
- *
769
+ * Needs `branding.edit` and `clients.edit`, as the Branding tab of the application in the portal does.
770
770
  * @summary Change keys of an OAuth client\'s login and/or consent page branding
771
771
  * @param {string} orgId
772
772
  * @param {string} clientId
@@ -801,7 +801,7 @@ const AdminOAuthClientsApiFp = function (configuration) {
801
801
  });
802
802
  },
803
803
  /**
804
- *
804
+ * Needs `branding.edit` and `clients.edit`, as the Branding tab of the application in the portal does.
805
805
  * @summary Replace an OAuth client\'s login and/or consent page branding
806
806
  * @param {string} orgId
807
807
  * @param {string} clientId
@@ -890,7 +890,7 @@ const AdminOAuthClientsApiFactory = function (configuration, basePath, axios) {
890
890
  return localVarFp.adminClientsCimdCheck(requestParameters.orgId, requestParameters.adminClientsCimdCheckRequest, options).then((request) => request(axios, basePath));
891
891
  },
892
892
  /**
893
- * Login settings use the same keys as the organization branding settings (GET /settings/branding); a missing or null value means \"same as the organization\".
893
+ * Needs `branding.view` and `clients.view`. Login settings use the same keys as the organization branding settings (GET /settings/branding); a missing or null value means \"same as the organization\".
894
894
  * @summary Get an OAuth client\'s login and consent page branding
895
895
  * @param {AdminOAuthClientsApiAdminClientsGetBrandingRequest} requestParameters Request parameters.
896
896
  * @param {*} [options] Override http request option.
@@ -970,7 +970,7 @@ const AdminOAuthClientsApiFactory = function (configuration, basePath, axios) {
970
970
  return localVarFp.listClients(requestParameters.orgId, options).then((request) => request(axios, basePath));
971
971
  },
972
972
  /**
973
- *
973
+ * Needs `branding.edit` and `clients.edit`, as the Branding tab of the application in the portal does.
974
974
  * @summary Change keys of an OAuth client\'s login and/or consent page branding
975
975
  * @param {AdminOAuthClientsApiPatchAdminClientsUpdateBrandingRequest} requestParameters Request parameters.
976
976
  * @param {*} [options] Override http request option.
@@ -990,7 +990,7 @@ const AdminOAuthClientsApiFactory = function (configuration, basePath, axios) {
990
990
  return localVarFp.patchClient(requestParameters.orgId, requestParameters.clientId, options).then((request) => request(axios, basePath));
991
991
  },
992
992
  /**
993
- *
993
+ * Needs `branding.edit` and `clients.edit`, as the Branding tab of the application in the portal does.
994
994
  * @summary Replace an OAuth client\'s login and/or consent page branding
995
995
  * @param {AdminOAuthClientsApiPutAdminClientsUpdateBrandingRequest} requestParameters Request parameters.
996
996
  * @param {*} [options] Override http request option.
@@ -1051,7 +1051,7 @@ class AdminOAuthClientsApi extends base_1.BaseAPI {
1051
1051
  return (0, exports.AdminOAuthClientsApiFp)(this.configuration).adminClientsCimdCheck(requestParameters.orgId, requestParameters.adminClientsCimdCheckRequest, options).then((request) => request(this.axios, this.basePath));
1052
1052
  }
1053
1053
  /**
1054
- * Login settings use the same keys as the organization branding settings (GET /settings/branding); a missing or null value means \"same as the organization\".
1054
+ * Needs `branding.view` and `clients.view`. Login settings use the same keys as the organization branding settings (GET /settings/branding); a missing or null value means \"same as the organization\".
1055
1055
  * @summary Get an OAuth client\'s login and consent page branding
1056
1056
  * @param {AdminOAuthClientsApiAdminClientsGetBrandingRequest} requestParameters Request parameters.
1057
1057
  * @param {*} [options] Override http request option.
@@ -1139,7 +1139,7 @@ class AdminOAuthClientsApi extends base_1.BaseAPI {
1139
1139
  return (0, exports.AdminOAuthClientsApiFp)(this.configuration).listClients(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
1140
1140
  }
1141
1141
  /**
1142
- *
1142
+ * Needs `branding.edit` and `clients.edit`, as the Branding tab of the application in the portal does.
1143
1143
  * @summary Change keys of an OAuth client\'s login and/or consent page branding
1144
1144
  * @param {AdminOAuthClientsApiPatchAdminClientsUpdateBrandingRequest} requestParameters Request parameters.
1145
1145
  * @param {*} [options] Override http request option.
@@ -1161,7 +1161,7 @@ class AdminOAuthClientsApi extends base_1.BaseAPI {
1161
1161
  return (0, exports.AdminOAuthClientsApiFp)(this.configuration).patchClient(requestParameters.orgId, requestParameters.clientId, options).then((request) => request(this.axios, this.basePath));
1162
1162
  }
1163
1163
  /**
1164
- *
1164
+ * Needs `branding.edit` and `clients.edit`, as the Branding tab of the application in the portal does.
1165
1165
  * @summary Replace an OAuth client\'s login and/or consent page branding
1166
1166
  * @param {AdminOAuthClientsApiPutAdminClientsUpdateBrandingRequest} requestParameters Request parameters.
1167
1167
  * @param {*} [options] Override http request option.
@@ -24,7 +24,7 @@ import type { MessageResponse } from '../models';
24
24
  */
25
25
  export declare const AdminRolesApiAxiosParamCreator: (configuration?: Configuration) => {
26
26
  /**
27
- *
27
+ * Needs `roles.assign-permissions` and `roles.edit`. Takes `permissionId` or a list `permissionIds`. Every id is judged before anything changes: an unknown id is 400 (`Unknown permission: <id>`), and a permission that the caller does not hold is 403. Either refusal adds nothing. A permission that the role already holds is left as it is. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole request with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
28
28
  * @summary Add permission(s) to a role
29
29
  * @param {string} orgId
30
30
  * @param {string} roleId
@@ -42,7 +42,7 @@ export declare const AdminRolesApiAxiosParamCreator: (configuration?: Configurat
42
42
  */
43
43
  adminRolesAddUser: (orgId: string, roleId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
44
44
  /**
45
- *
45
+ * Optional `permissions` is a list of permission slugs. Giving it needs `roles.assign-permissions` as well as `roles.create`, and every permission must be one that the caller holds; otherwise the answer is 403 and no role is created. An unknown slug is 400.
46
46
  * @summary Create a new role
47
47
  * @param {string} orgId
48
48
  * @param {*} [options] Override http request option.
@@ -94,7 +94,7 @@ export declare const AdminRolesApiAxiosParamCreator: (configuration?: Configurat
94
94
  */
95
95
  adminRolesList: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
96
96
  /**
97
- *
97
+ * Needs `roles.assign-permissions` and `roles.edit`.
98
98
  * @summary Remove a permission from a role
99
99
  * @param {string} orgId
100
100
  * @param {string} roleId
@@ -114,7 +114,7 @@ export declare const AdminRolesApiAxiosParamCreator: (configuration?: Configurat
114
114
  */
115
115
  adminRolesRemoveUser: (orgId: string, roleId: string, userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
116
116
  /**
117
- *
117
+ * Needs `roles.assign-permissions` and `roles.edit`. `permissions` is the full list of permission slugs that the role should grant. The whole list is judged before anything changes: an unknown slug is 400 (`Unknown permission: <slug>`), and a permission that the role does not hold yet must be one that the caller holds, otherwise 403. Either refusal changes nothing. Permissions on the role that the caller does not hold are kept, whether or not the list names them. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole change with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
118
118
  * @summary Update role permissions (replaces all)
119
119
  * @param {string} orgId
120
120
  * @param {string} roleId
@@ -147,7 +147,7 @@ export declare const AdminRolesApiAxiosParamCreator: (configuration?: Configurat
147
147
  */
148
148
  export declare const AdminRolesApiFp: (configuration?: Configuration) => {
149
149
  /**
150
- *
150
+ * Needs `roles.assign-permissions` and `roles.edit`. Takes `permissionId` or a list `permissionIds`. Every id is judged before anything changes: an unknown id is 400 (`Unknown permission: <id>`), and a permission that the caller does not hold is 403. Either refusal adds nothing. A permission that the role already holds is left as it is. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole request with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
151
151
  * @summary Add permission(s) to a role
152
152
  * @param {string} orgId
153
153
  * @param {string} roleId
@@ -165,7 +165,7 @@ export declare const AdminRolesApiFp: (configuration?: Configuration) => {
165
165
  */
166
166
  adminRolesAddUser(orgId: string, roleId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageResponse>>;
167
167
  /**
168
- *
168
+ * Optional `permissions` is a list of permission slugs. Giving it needs `roles.assign-permissions` as well as `roles.create`, and every permission must be one that the caller holds; otherwise the answer is 403 and no role is created. An unknown slug is 400.
169
169
  * @summary Create a new role
170
170
  * @param {string} orgId
171
171
  * @param {*} [options] Override http request option.
@@ -217,7 +217,7 @@ export declare const AdminRolesApiFp: (configuration?: Configuration) => {
217
217
  */
218
218
  adminRolesList(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminRolesListResponse>>;
219
219
  /**
220
- *
220
+ * Needs `roles.assign-permissions` and `roles.edit`.
221
221
  * @summary Remove a permission from a role
222
222
  * @param {string} orgId
223
223
  * @param {string} roleId
@@ -237,7 +237,7 @@ export declare const AdminRolesApiFp: (configuration?: Configuration) => {
237
237
  */
238
238
  adminRolesRemoveUser(orgId: string, roleId: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageResponse>>;
239
239
  /**
240
- *
240
+ * Needs `roles.assign-permissions` and `roles.edit`. `permissions` is the full list of permission slugs that the role should grant. The whole list is judged before anything changes: an unknown slug is 400 (`Unknown permission: <slug>`), and a permission that the role does not hold yet must be one that the caller holds, otherwise 403. Either refusal changes nothing. Permissions on the role that the caller does not hold are kept, whether or not the list names them. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole change with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
241
241
  * @summary Update role permissions (replaces all)
242
242
  * @param {string} orgId
243
243
  * @param {string} roleId
@@ -270,7 +270,7 @@ export declare const AdminRolesApiFp: (configuration?: Configuration) => {
270
270
  */
271
271
  export declare const AdminRolesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
272
272
  /**
273
- *
273
+ * Needs `roles.assign-permissions` and `roles.edit`. Takes `permissionId` or a list `permissionIds`. Every id is judged before anything changes: an unknown id is 400 (`Unknown permission: <id>`), and a permission that the caller does not hold is 403. Either refusal adds nothing. A permission that the role already holds is left as it is. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole request with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
274
274
  * @summary Add permission(s) to a role
275
275
  * @param {AdminRolesApiAdminRolesAddPermissionsRequest} requestParameters Request parameters.
276
276
  * @param {*} [options] Override http request option.
@@ -286,7 +286,7 @@ export declare const AdminRolesApiFactory: (configuration?: Configuration, baseP
286
286
  */
287
287
  adminRolesAddUser(requestParameters: AdminRolesApiAdminRolesAddUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponse>;
288
288
  /**
289
- *
289
+ * Optional `permissions` is a list of permission slugs. Giving it needs `roles.assign-permissions` as well as `roles.create`, and every permission must be one that the caller holds; otherwise the answer is 403 and no role is created. An unknown slug is 400.
290
290
  * @summary Create a new role
291
291
  * @param {AdminRolesApiAdminRolesCreateRequest} requestParameters Request parameters.
292
292
  * @param {*} [options] Override http request option.
@@ -334,7 +334,7 @@ export declare const AdminRolesApiFactory: (configuration?: Configuration, baseP
334
334
  */
335
335
  adminRolesList(requestParameters: AdminRolesApiAdminRolesListRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminRolesListResponse>;
336
336
  /**
337
- *
337
+ * Needs `roles.assign-permissions` and `roles.edit`.
338
338
  * @summary Remove a permission from a role
339
339
  * @param {AdminRolesApiAdminRolesRemovePermissionRequest} requestParameters Request parameters.
340
340
  * @param {*} [options] Override http request option.
@@ -350,7 +350,7 @@ export declare const AdminRolesApiFactory: (configuration?: Configuration, baseP
350
350
  */
351
351
  adminRolesRemoveUser(requestParameters: AdminRolesApiAdminRolesRemoveUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponse>;
352
352
  /**
353
- *
353
+ * Needs `roles.assign-permissions` and `roles.edit`. `permissions` is the full list of permission slugs that the role should grant. The whole list is judged before anything changes: an unknown slug is 400 (`Unknown permission: <slug>`), and a permission that the role does not hold yet must be one that the caller holds, otherwise 403. Either refusal changes nothing. Permissions on the role that the caller does not hold are kept, whether or not the list names them. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole change with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
354
354
  * @summary Update role permissions (replaces all)
355
355
  * @param {AdminRolesApiAdminRolesUpdatePermissionsRequest} requestParameters Request parameters.
356
356
  * @param {*} [options] Override http request option.
@@ -381,7 +381,7 @@ export declare const AdminRolesApiFactory: (configuration?: Configuration, baseP
381
381
  */
382
382
  export interface AdminRolesApiInterface {
383
383
  /**
384
- *
384
+ * Needs `roles.assign-permissions` and `roles.edit`. Takes `permissionId` or a list `permissionIds`. Every id is judged before anything changes: an unknown id is 400 (`Unknown permission: <id>`), and a permission that the caller does not hold is 403. Either refusal adds nothing. A permission that the role already holds is left as it is. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole request with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
385
385
  * @summary Add permission(s) to a role
386
386
  * @param {AdminRolesApiAdminRolesAddPermissionsRequest} requestParameters Request parameters.
387
387
  * @param {*} [options] Override http request option.
@@ -399,7 +399,7 @@ export interface AdminRolesApiInterface {
399
399
  */
400
400
  adminRolesAddUser(requestParameters: AdminRolesApiAdminRolesAddUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponse>;
401
401
  /**
402
- *
402
+ * Optional `permissions` is a list of permission slugs. Giving it needs `roles.assign-permissions` as well as `roles.create`, and every permission must be one that the caller holds; otherwise the answer is 403 and no role is created. An unknown slug is 400.
403
403
  * @summary Create a new role
404
404
  * @param {AdminRolesApiAdminRolesCreateRequest} requestParameters Request parameters.
405
405
  * @param {*} [options] Override http request option.
@@ -453,7 +453,7 @@ export interface AdminRolesApiInterface {
453
453
  */
454
454
  adminRolesList(requestParameters: AdminRolesApiAdminRolesListRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminRolesListResponse>;
455
455
  /**
456
- *
456
+ * Needs `roles.assign-permissions` and `roles.edit`.
457
457
  * @summary Remove a permission from a role
458
458
  * @param {AdminRolesApiAdminRolesRemovePermissionRequest} requestParameters Request parameters.
459
459
  * @param {*} [options] Override http request option.
@@ -471,7 +471,7 @@ export interface AdminRolesApiInterface {
471
471
  */
472
472
  adminRolesRemoveUser(requestParameters: AdminRolesApiAdminRolesRemoveUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponse>;
473
473
  /**
474
- *
474
+ * Needs `roles.assign-permissions` and `roles.edit`. `permissions` is the full list of permission slugs that the role should grant. The whole list is judged before anything changes: an unknown slug is 400 (`Unknown permission: <slug>`), and a permission that the role does not hold yet must be one that the caller holds, otherwise 403. Either refusal changes nothing. Permissions on the role that the caller does not hold are kept, whether or not the list names them. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole change with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
475
475
  * @summary Update role permissions (replaces all)
476
476
  * @param {AdminRolesApiAdminRolesUpdatePermissionsRequest} requestParameters Request parameters.
477
477
  * @param {*} [options] Override http request option.
@@ -753,7 +753,7 @@ export interface AdminRolesApiPutAdminRolesUpdateRequest {
753
753
  */
754
754
  export declare class AdminRolesApi extends BaseAPI implements AdminRolesApiInterface {
755
755
  /**
756
- *
756
+ * Needs `roles.assign-permissions` and `roles.edit`. Takes `permissionId` or a list `permissionIds`. Every id is judged before anything changes: an unknown id is 400 (`Unknown permission: <id>`), and a permission that the caller does not hold is 403. Either refusal adds nothing. A permission that the role already holds is left as it is. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole request with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
757
757
  * @summary Add permission(s) to a role
758
758
  * @param {AdminRolesApiAdminRolesAddPermissionsRequest} requestParameters Request parameters.
759
759
  * @param {*} [options] Override http request option.
@@ -771,7 +771,7 @@ export declare class AdminRolesApi extends BaseAPI implements AdminRolesApiInter
771
771
  */
772
772
  adminRolesAddUser(requestParameters: AdminRolesApiAdminRolesAddUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponse, any, {}>>;
773
773
  /**
774
- *
774
+ * Optional `permissions` is a list of permission slugs. Giving it needs `roles.assign-permissions` as well as `roles.create`, and every permission must be one that the caller holds; otherwise the answer is 403 and no role is created. An unknown slug is 400.
775
775
  * @summary Create a new role
776
776
  * @param {AdminRolesApiAdminRolesCreateRequest} requestParameters Request parameters.
777
777
  * @param {*} [options] Override http request option.
@@ -825,7 +825,7 @@ export declare class AdminRolesApi extends BaseAPI implements AdminRolesApiInter
825
825
  */
826
826
  adminRolesList(requestParameters: AdminRolesApiAdminRolesListRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminRolesListResponse, any, {}>>;
827
827
  /**
828
- *
828
+ * Needs `roles.assign-permissions` and `roles.edit`.
829
829
  * @summary Remove a permission from a role
830
830
  * @param {AdminRolesApiAdminRolesRemovePermissionRequest} requestParameters Request parameters.
831
831
  * @param {*} [options] Override http request option.
@@ -843,7 +843,7 @@ export declare class AdminRolesApi extends BaseAPI implements AdminRolesApiInter
843
843
  */
844
844
  adminRolesRemoveUser(requestParameters: AdminRolesApiAdminRolesRemoveUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponse, any, {}>>;
845
845
  /**
846
- *
846
+ * Needs `roles.assign-permissions` and `roles.edit`. `permissions` is the full list of permission slugs that the role should grant. The whole list is judged before anything changes: an unknown slug is 400 (`Unknown permission: <slug>`), and a permission that the role does not hold yet must be one that the caller holds, otherwise 403. Either refusal changes nothing. Permissions on the role that the caller does not hold are kept, whether or not the list names them. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole change with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
847
847
  * @summary Update role permissions (replaces all)
848
848
  * @param {AdminRolesApiAdminRolesUpdatePermissionsRequest} requestParameters Request parameters.
849
849
  * @param {*} [options] Override http request option.
@@ -36,7 +36,7 @@ const base_1 = require("../base");
36
36
  const AdminRolesApiAxiosParamCreator = function (configuration) {
37
37
  return {
38
38
  /**
39
- *
39
+ * Needs `roles.assign-permissions` and `roles.edit`. Takes `permissionId` or a list `permissionIds`. Every id is judged before anything changes: an unknown id is 400 (`Unknown permission: <id>`), and a permission that the caller does not hold is 403. Either refusal adds nothing. A permission that the role already holds is left as it is. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole request with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
40
40
  * @summary Add permission(s) to a role
41
41
  * @param {string} orgId
42
42
  * @param {string} roleId
@@ -112,7 +112,7 @@ const AdminRolesApiAxiosParamCreator = function (configuration) {
112
112
  };
113
113
  }),
114
114
  /**
115
- *
115
+ * Optional `permissions` is a list of permission slugs. Giving it needs `roles.assign-permissions` as well as `roles.create`, and every permission must be one that the caller holds; otherwise the answer is 403 and no role is created. An unknown slug is 400.
116
116
  * @summary Create a new role
117
117
  * @param {string} orgId
118
118
  * @param {*} [options] Override http request option.
@@ -332,7 +332,7 @@ const AdminRolesApiAxiosParamCreator = function (configuration) {
332
332
  };
333
333
  }),
334
334
  /**
335
- *
335
+ * Needs `roles.assign-permissions` and `roles.edit`.
336
336
  * @summary Remove a permission from a role
337
337
  * @param {string} orgId
338
338
  * @param {string} roleId
@@ -416,7 +416,7 @@ const AdminRolesApiAxiosParamCreator = function (configuration) {
416
416
  };
417
417
  }),
418
418
  /**
419
- *
419
+ * Needs `roles.assign-permissions` and `roles.edit`. `permissions` is the full list of permission slugs that the role should grant. The whole list is judged before anything changes: an unknown slug is 400 (`Unknown permission: <slug>`), and a permission that the role does not hold yet must be one that the caller holds, otherwise 403. Either refusal changes nothing. Permissions on the role that the caller does not hold are kept, whether or not the list names them. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole change with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
420
420
  * @summary Update role permissions (replaces all)
421
421
  * @param {string} orgId
422
422
  * @param {string} roleId
@@ -540,7 +540,7 @@ const AdminRolesApiFp = function (configuration) {
540
540
  const localVarAxiosParamCreator = (0, exports.AdminRolesApiAxiosParamCreator)(configuration);
541
541
  return {
542
542
  /**
543
- *
543
+ * Needs `roles.assign-permissions` and `roles.edit`. Takes `permissionId` or a list `permissionIds`. Every id is judged before anything changes: an unknown id is 400 (`Unknown permission: <id>`), and a permission that the caller does not hold is 403. Either refusal adds nothing. A permission that the role already holds is left as it is. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole request with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
544
544
  * @summary Add permission(s) to a role
545
545
  * @param {string} orgId
546
546
  * @param {string} roleId
@@ -574,7 +574,7 @@ const AdminRolesApiFp = function (configuration) {
574
574
  });
575
575
  },
576
576
  /**
577
- *
577
+ * Optional `permissions` is a list of permission slugs. Giving it needs `roles.assign-permissions` as well as `roles.create`, and every permission must be one that the caller holds; otherwise the answer is 403 and no role is created. An unknown slug is 400.
578
578
  * @summary Create a new role
579
579
  * @param {string} orgId
580
580
  * @param {*} [options] Override http request option.
@@ -674,7 +674,7 @@ const AdminRolesApiFp = function (configuration) {
674
674
  });
675
675
  },
676
676
  /**
677
- *
677
+ * Needs `roles.assign-permissions` and `roles.edit`.
678
678
  * @summary Remove a permission from a role
679
679
  * @param {string} orgId
680
680
  * @param {string} roleId
@@ -710,7 +710,7 @@ const AdminRolesApiFp = function (configuration) {
710
710
  });
711
711
  },
712
712
  /**
713
- *
713
+ * Needs `roles.assign-permissions` and `roles.edit`. `permissions` is the full list of permission slugs that the role should grant. The whole list is judged before anything changes: an unknown slug is 400 (`Unknown permission: <slug>`), and a permission that the role does not hold yet must be one that the caller holds, otherwise 403. Either refusal changes nothing. Permissions on the role that the caller does not hold are kept, whether or not the list names them. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole change with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
714
714
  * @summary Update role permissions (replaces all)
715
715
  * @param {string} orgId
716
716
  * @param {string} roleId
@@ -771,7 +771,7 @@ const AdminRolesApiFactory = function (configuration, basePath, axios) {
771
771
  const localVarFp = (0, exports.AdminRolesApiFp)(configuration);
772
772
  return {
773
773
  /**
774
- *
774
+ * Needs `roles.assign-permissions` and `roles.edit`. Takes `permissionId` or a list `permissionIds`. Every id is judged before anything changes: an unknown id is 400 (`Unknown permission: <id>`), and a permission that the caller does not hold is 403. Either refusal adds nothing. A permission that the role already holds is left as it is. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole request with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
775
775
  * @summary Add permission(s) to a role
776
776
  * @param {AdminRolesApiAdminRolesAddPermissionsRequest} requestParameters Request parameters.
777
777
  * @param {*} [options] Override http request option.
@@ -791,7 +791,7 @@ const AdminRolesApiFactory = function (configuration, basePath, axios) {
791
791
  return localVarFp.adminRolesAddUser(requestParameters.orgId, requestParameters.roleId, options).then((request) => request(axios, basePath));
792
792
  },
793
793
  /**
794
- *
794
+ * Optional `permissions` is a list of permission slugs. Giving it needs `roles.assign-permissions` as well as `roles.create`, and every permission must be one that the caller holds; otherwise the answer is 403 and no role is created. An unknown slug is 400.
795
795
  * @summary Create a new role
796
796
  * @param {AdminRolesApiAdminRolesCreateRequest} requestParameters Request parameters.
797
797
  * @param {*} [options] Override http request option.
@@ -851,7 +851,7 @@ const AdminRolesApiFactory = function (configuration, basePath, axios) {
851
851
  return localVarFp.adminRolesList(requestParameters.orgId, options).then((request) => request(axios, basePath));
852
852
  },
853
853
  /**
854
- *
854
+ * Needs `roles.assign-permissions` and `roles.edit`.
855
855
  * @summary Remove a permission from a role
856
856
  * @param {AdminRolesApiAdminRolesRemovePermissionRequest} requestParameters Request parameters.
857
857
  * @param {*} [options] Override http request option.
@@ -871,7 +871,7 @@ const AdminRolesApiFactory = function (configuration, basePath, axios) {
871
871
  return localVarFp.adminRolesRemoveUser(requestParameters.orgId, requestParameters.roleId, requestParameters.userId, options).then((request) => request(axios, basePath));
872
872
  },
873
873
  /**
874
- *
874
+ * Needs `roles.assign-permissions` and `roles.edit`. `permissions` is the full list of permission slugs that the role should grant. The whole list is judged before anything changes: an unknown slug is 400 (`Unknown permission: <slug>`), and a permission that the role does not hold yet must be one that the caller holds, otherwise 403. Either refusal changes nothing. Permissions on the role that the caller does not hold are kept, whether or not the list names them. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole change with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
875
875
  * @summary Update role permissions (replaces all)
876
876
  * @param {AdminRolesApiAdminRolesUpdatePermissionsRequest} requestParameters Request parameters.
877
877
  * @param {*} [options] Override http request option.
@@ -911,7 +911,7 @@ exports.AdminRolesApiFactory = AdminRolesApiFactory;
911
911
  */
912
912
  class AdminRolesApi extends base_1.BaseAPI {
913
913
  /**
914
- *
914
+ * Needs `roles.assign-permissions` and `roles.edit`. Takes `permissionId` or a list `permissionIds`. Every id is judged before anything changes: an unknown id is 400 (`Unknown permission: <id>`), and a permission that the caller does not hold is 403. Either refusal adds nothing. A permission that the role already holds is left as it is. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole request with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
915
915
  * @summary Add permission(s) to a role
916
916
  * @param {AdminRolesApiAdminRolesAddPermissionsRequest} requestParameters Request parameters.
917
917
  * @param {*} [options] Override http request option.
@@ -933,7 +933,7 @@ class AdminRolesApi extends base_1.BaseAPI {
933
933
  return (0, exports.AdminRolesApiFp)(this.configuration).adminRolesAddUser(requestParameters.orgId, requestParameters.roleId, options).then((request) => request(this.axios, this.basePath));
934
934
  }
935
935
  /**
936
- *
936
+ * Optional `permissions` is a list of permission slugs. Giving it needs `roles.assign-permissions` as well as `roles.create`, and every permission must be one that the caller holds; otherwise the answer is 403 and no role is created. An unknown slug is 400.
937
937
  * @summary Create a new role
938
938
  * @param {AdminRolesApiAdminRolesCreateRequest} requestParameters Request parameters.
939
939
  * @param {*} [options] Override http request option.
@@ -999,7 +999,7 @@ class AdminRolesApi extends base_1.BaseAPI {
999
999
  return (0, exports.AdminRolesApiFp)(this.configuration).adminRolesList(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
1000
1000
  }
1001
1001
  /**
1002
- *
1002
+ * Needs `roles.assign-permissions` and `roles.edit`.
1003
1003
  * @summary Remove a permission from a role
1004
1004
  * @param {AdminRolesApiAdminRolesRemovePermissionRequest} requestParameters Request parameters.
1005
1005
  * @param {*} [options] Override http request option.
@@ -1021,7 +1021,7 @@ class AdminRolesApi extends base_1.BaseAPI {
1021
1021
  return (0, exports.AdminRolesApiFp)(this.configuration).adminRolesRemoveUser(requestParameters.orgId, requestParameters.roleId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
1022
1022
  }
1023
1023
  /**
1024
- *
1024
+ * Needs `roles.assign-permissions` and `roles.edit`. `permissions` is the full list of permission slugs that the role should grant. The whole list is judged before anything changes: an unknown slug is 400 (`Unknown permission: <slug>`), and a permission that the role does not hold yet must be one that the caller holds, otherwise 403. Either refusal changes nothing. Permissions on the role that the caller does not hold are kept, whether or not the list names them. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole change with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
1025
1025
  * @summary Update role permissions (replaces all)
1026
1026
  * @param {AdminRolesApiAdminRolesUpdatePermissionsRequest} requestParameters Request parameters.
1027
1027
  * @param {*} [options] Override http request option.