@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
@@ -180,7 +180,7 @@ const AdminSettingsApiAxiosParamCreator = function (configuration) {
180
180
  };
181
181
  }),
182
182
  /**
183
- *
183
+ * Needs `settings.view`. The `branding` part is returned only to a caller who also holds `branding.view` (for an API key, its creator), as for GET /settings/branding and the portal\'s branding page; without it the key is left out.
184
184
  * @summary Get all settings (combined)
185
185
  * @param {string} orgId
186
186
  * @param {*} [options] Override http request option.
@@ -316,7 +316,7 @@ const AdminSettingsApiAxiosParamCreator = function (configuration) {
316
316
  };
317
317
  }),
318
318
  /**
319
- *
319
+ * Shows who sends the organization\'s mail: its own mail provider (set up in the portal) with the From address, From name and Reply-To stored there, or LumoAuth with LumoAuth\'s sender.
320
320
  * @summary Get email settings
321
321
  * @param {string} orgId
322
322
  * @param {*} [options] Override http request option.
@@ -588,7 +588,7 @@ const AdminSettingsApiAxiosParamCreator = function (configuration) {
588
588
  };
589
589
  }),
590
590
  /**
591
- *
591
+ * Changes the login page settings that are live on the hosted pages. Values go through the same validation as the portal form; keys that the validation does not know are not stored, and the keys whose value it refused are listed in rejected. A change is kept as a published version (restorable in the portal) and recorded in the audit log as branding.login_page_updated. Setting custom_css, custom_html or show_powered_by: false needs a plan that includes it; sending back a stored value, or clearing it, is never refused. A draft that is being edited in the portal is not changed. PUT and PATCH behave the same: keys that are not sent keep their value.
592
592
  * @summary Update branding/login page settings
593
593
  * @param {string} orgId
594
594
  * @param {*} [options] Override http request option.
@@ -622,13 +622,14 @@ const AdminSettingsApiAxiosParamCreator = function (configuration) {
622
622
  };
623
623
  }),
624
624
  /**
625
- *
625
+ * Changes the sender of the mail that the organization\'s own mail provider sends: fromEmail, fromName and replyToEmail. The provider itself (credentials, host, on/off) is set up in the portal. Without a provider the mail is sent by LumoAuth with LumoAuth\'s sender, and a write is refused with 400. PATCH changes the fields sent; PUT replaces the three fields as a set (fromEmail is then required). The caller needs settings.manage and users.delete; an access token must come from a sign-in of the last 10 minutes.
626
626
  * @summary Update email settings
627
627
  * @param {string} orgId
628
+ * @param {PutAdminSettingsEmailUpdateRequest} [putAdminSettingsEmailUpdateRequest]
628
629
  * @param {*} [options] Override http request option.
629
630
  * @throws {RequiredError}
630
631
  */
631
- patchAdminSettingsEmailUpdate: (orgId_1, ...args_1) => __awaiter(this, [orgId_1, ...args_1], void 0, function* (orgId, options = {}) {
632
+ patchAdminSettingsEmailUpdate: (orgId_1, putAdminSettingsEmailUpdateRequest_1, ...args_1) => __awaiter(this, [orgId_1, putAdminSettingsEmailUpdateRequest_1, ...args_1], void 0, function* (orgId, putAdminSettingsEmailUpdateRequest, options = {}) {
632
633
  // verify required parameter 'orgId' is not null or undefined
633
634
  (0, common_1.assertParamExists)('patchAdminSettingsEmailUpdate', 'orgId', orgId);
634
635
  const localVarPath = `/orgs/{orgId}/api/v1/admin/settings/email`
@@ -647,22 +648,25 @@ const AdminSettingsApiAxiosParamCreator = function (configuration) {
647
648
  // authentication BearerAuth required
648
649
  // http bearer authentication required
649
650
  yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
651
+ localVarHeaderParameter['Content-Type'] = 'application/json';
650
652
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
651
653
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
652
654
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
655
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(putAdminSettingsEmailUpdateRequest, localVarRequestOptions, configuration);
653
656
  return {
654
657
  url: (0, common_1.toPathString)(localVarUrlObj),
655
658
  options: localVarRequestOptions,
656
659
  };
657
660
  }),
658
661
  /**
659
- *
662
+ * Changes the name of the organization and the default language of the hosted pages. name, tenantName, display_name and displayName are four spellings of the one name: send one of them, or the same text in each. timezone is not a setting (dates are shown in UTC) and is refused with 400. Other keys are ignored. PUT and PATCH behave the same. The caller needs settings.manage, as for PATCH /admin/organization, which changes the same name; changing locale also needs branding.edit.
660
663
  * @summary Update general settings
661
664
  * @param {string} orgId
665
+ * @param {PutAdminSettingsGeneralUpdateRequest} [putAdminSettingsGeneralUpdateRequest]
662
666
  * @param {*} [options] Override http request option.
663
667
  * @throws {RequiredError}
664
668
  */
665
- patchAdminSettingsGeneralUpdate: (orgId_1, ...args_1) => __awaiter(this, [orgId_1, ...args_1], void 0, function* (orgId, options = {}) {
669
+ patchAdminSettingsGeneralUpdate: (orgId_1, putAdminSettingsGeneralUpdateRequest_1, ...args_1) => __awaiter(this, [orgId_1, putAdminSettingsGeneralUpdateRequest_1, ...args_1], void 0, function* (orgId, putAdminSettingsGeneralUpdateRequest, options = {}) {
666
670
  // verify required parameter 'orgId' is not null or undefined
667
671
  (0, common_1.assertParamExists)('patchAdminSettingsGeneralUpdate', 'orgId', orgId);
668
672
  const localVarPath = `/orgs/{orgId}/api/v1/admin/settings/general`
@@ -681,9 +685,11 @@ const AdminSettingsApiAxiosParamCreator = function (configuration) {
681
685
  // authentication BearerAuth required
682
686
  // http bearer authentication required
683
687
  yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
688
+ localVarHeaderParameter['Content-Type'] = 'application/json';
684
689
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
685
690
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
686
691
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
692
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(putAdminSettingsGeneralUpdateRequest, localVarRequestOptions, configuration);
687
693
  return {
688
694
  url: (0, common_1.toPathString)(localVarUrlObj),
689
695
  options: localVarRequestOptions,
@@ -894,7 +900,7 @@ const AdminSettingsApiAxiosParamCreator = function (configuration) {
894
900
  };
895
901
  }),
896
902
  /**
897
- *
903
+ * Changes the login page settings that are live on the hosted pages. Values go through the same validation as the portal form; keys that the validation does not know are not stored, and the keys whose value it refused are listed in rejected. A change is kept as a published version (restorable in the portal) and recorded in the audit log as branding.login_page_updated. Setting custom_css, custom_html or show_powered_by: false needs a plan that includes it; sending back a stored value, or clearing it, is never refused. A draft that is being edited in the portal is not changed. PUT and PATCH behave the same: keys that are not sent keep their value.
898
904
  * @summary Update branding/login page settings
899
905
  * @param {string} orgId
900
906
  * @param {*} [options] Override http request option.
@@ -928,13 +934,14 @@ const AdminSettingsApiAxiosParamCreator = function (configuration) {
928
934
  };
929
935
  }),
930
936
  /**
931
- *
937
+ * Changes the sender of the mail that the organization\'s own mail provider sends: fromEmail, fromName and replyToEmail. The provider itself (credentials, host, on/off) is set up in the portal. Without a provider the mail is sent by LumoAuth with LumoAuth\'s sender, and a write is refused with 400. PATCH changes the fields sent; PUT replaces the three fields as a set (fromEmail is then required). The caller needs settings.manage and users.delete; an access token must come from a sign-in of the last 10 minutes.
932
938
  * @summary Update email settings
933
939
  * @param {string} orgId
940
+ * @param {PutAdminSettingsEmailUpdateRequest} [putAdminSettingsEmailUpdateRequest]
934
941
  * @param {*} [options] Override http request option.
935
942
  * @throws {RequiredError}
936
943
  */
937
- putAdminSettingsEmailUpdate: (orgId_1, ...args_1) => __awaiter(this, [orgId_1, ...args_1], void 0, function* (orgId, options = {}) {
944
+ putAdminSettingsEmailUpdate: (orgId_1, putAdminSettingsEmailUpdateRequest_1, ...args_1) => __awaiter(this, [orgId_1, putAdminSettingsEmailUpdateRequest_1, ...args_1], void 0, function* (orgId, putAdminSettingsEmailUpdateRequest, options = {}) {
938
945
  // verify required parameter 'orgId' is not null or undefined
939
946
  (0, common_1.assertParamExists)('putAdminSettingsEmailUpdate', 'orgId', orgId);
940
947
  const localVarPath = `/orgs/{orgId}/api/v1/admin/settings/email`
@@ -953,22 +960,25 @@ const AdminSettingsApiAxiosParamCreator = function (configuration) {
953
960
  // authentication BearerAuth required
954
961
  // http bearer authentication required
955
962
  yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
963
+ localVarHeaderParameter['Content-Type'] = 'application/json';
956
964
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
957
965
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
958
966
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
967
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(putAdminSettingsEmailUpdateRequest, localVarRequestOptions, configuration);
959
968
  return {
960
969
  url: (0, common_1.toPathString)(localVarUrlObj),
961
970
  options: localVarRequestOptions,
962
971
  };
963
972
  }),
964
973
  /**
965
- *
974
+ * Changes the name of the organization and the default language of the hosted pages. name, tenantName, display_name and displayName are four spellings of the one name: send one of them, or the same text in each. timezone is not a setting (dates are shown in UTC) and is refused with 400. Other keys are ignored. PUT and PATCH behave the same. The caller needs settings.manage, as for PATCH /admin/organization, which changes the same name; changing locale also needs branding.edit.
966
975
  * @summary Update general settings
967
976
  * @param {string} orgId
977
+ * @param {PutAdminSettingsGeneralUpdateRequest} [putAdminSettingsGeneralUpdateRequest]
968
978
  * @param {*} [options] Override http request option.
969
979
  * @throws {RequiredError}
970
980
  */
971
- putAdminSettingsGeneralUpdate: (orgId_1, ...args_1) => __awaiter(this, [orgId_1, ...args_1], void 0, function* (orgId, options = {}) {
981
+ putAdminSettingsGeneralUpdate: (orgId_1, putAdminSettingsGeneralUpdateRequest_1, ...args_1) => __awaiter(this, [orgId_1, putAdminSettingsGeneralUpdateRequest_1, ...args_1], void 0, function* (orgId, putAdminSettingsGeneralUpdateRequest, options = {}) {
972
982
  // verify required parameter 'orgId' is not null or undefined
973
983
  (0, common_1.assertParamExists)('putAdminSettingsGeneralUpdate', 'orgId', orgId);
974
984
  const localVarPath = `/orgs/{orgId}/api/v1/admin/settings/general`
@@ -987,9 +997,11 @@ const AdminSettingsApiAxiosParamCreator = function (configuration) {
987
997
  // authentication BearerAuth required
988
998
  // http bearer authentication required
989
999
  yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
1000
+ localVarHeaderParameter['Content-Type'] = 'application/json';
990
1001
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
991
1002
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
992
1003
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1004
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(putAdminSettingsGeneralUpdateRequest, localVarRequestOptions, configuration);
993
1005
  return {
994
1006
  url: (0, common_1.toPathString)(localVarUrlObj),
995
1007
  options: localVarRequestOptions,
@@ -1174,7 +1186,7 @@ const AdminSettingsApiFp = function (configuration) {
1174
1186
  });
1175
1187
  },
1176
1188
  /**
1177
- *
1189
+ * Needs `settings.view`. The `branding` part is returned only to a caller who also holds `branding.view` (for an API key, its creator), as for GET /settings/branding and the portal\'s branding page; without it the key is left out.
1178
1190
  * @summary Get all settings (combined)
1179
1191
  * @param {string} orgId
1180
1192
  * @param {*} [options] Override http request option.
@@ -1238,7 +1250,7 @@ const AdminSettingsApiFp = function (configuration) {
1238
1250
  });
1239
1251
  },
1240
1252
  /**
1241
- *
1253
+ * Shows who sends the organization\'s mail: its own mail provider (set up in the portal) with the From address, From name and Reply-To stored there, or LumoAuth with LumoAuth\'s sender.
1242
1254
  * @summary Get email settings
1243
1255
  * @param {string} orgId
1244
1256
  * @param {*} [options] Override http request option.
@@ -1366,7 +1378,7 @@ const AdminSettingsApiFp = function (configuration) {
1366
1378
  });
1367
1379
  },
1368
1380
  /**
1369
- *
1381
+ * Changes the login page settings that are live on the hosted pages. Values go through the same validation as the portal form; keys that the validation does not know are not stored, and the keys whose value it refused are listed in rejected. A change is kept as a published version (restorable in the portal) and recorded in the audit log as branding.login_page_updated. Setting custom_css, custom_html or show_powered_by: false needs a plan that includes it; sending back a stored value, or clearing it, is never refused. A draft that is being edited in the portal is not changed. PUT and PATCH behave the same: keys that are not sent keep their value.
1370
1382
  * @summary Update branding/login page settings
1371
1383
  * @param {string} orgId
1372
1384
  * @param {*} [options] Override http request option.
@@ -1382,32 +1394,34 @@ const AdminSettingsApiFp = function (configuration) {
1382
1394
  });
1383
1395
  },
1384
1396
  /**
1385
- *
1397
+ * Changes the sender of the mail that the organization\'s own mail provider sends: fromEmail, fromName and replyToEmail. The provider itself (credentials, host, on/off) is set up in the portal. Without a provider the mail is sent by LumoAuth with LumoAuth\'s sender, and a write is refused with 400. PATCH changes the fields sent; PUT replaces the three fields as a set (fromEmail is then required). The caller needs settings.manage and users.delete; an access token must come from a sign-in of the last 10 minutes.
1386
1398
  * @summary Update email settings
1387
1399
  * @param {string} orgId
1400
+ * @param {PutAdminSettingsEmailUpdateRequest} [putAdminSettingsEmailUpdateRequest]
1388
1401
  * @param {*} [options] Override http request option.
1389
1402
  * @throws {RequiredError}
1390
1403
  */
1391
- patchAdminSettingsEmailUpdate(orgId, options) {
1404
+ patchAdminSettingsEmailUpdate(orgId, putAdminSettingsEmailUpdateRequest, options) {
1392
1405
  return __awaiter(this, void 0, void 0, function* () {
1393
1406
  var _a, _b, _c;
1394
- const localVarAxiosArgs = yield localVarAxiosParamCreator.patchAdminSettingsEmailUpdate(orgId, options);
1407
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.patchAdminSettingsEmailUpdate(orgId, putAdminSettingsEmailUpdateRequest, options);
1395
1408
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1396
1409
  const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AdminSettingsApi.patchAdminSettingsEmailUpdate']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1397
1410
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1398
1411
  });
1399
1412
  },
1400
1413
  /**
1401
- *
1414
+ * Changes the name of the organization and the default language of the hosted pages. name, tenantName, display_name and displayName are four spellings of the one name: send one of them, or the same text in each. timezone is not a setting (dates are shown in UTC) and is refused with 400. Other keys are ignored. PUT and PATCH behave the same. The caller needs settings.manage, as for PATCH /admin/organization, which changes the same name; changing locale also needs branding.edit.
1402
1415
  * @summary Update general settings
1403
1416
  * @param {string} orgId
1417
+ * @param {PutAdminSettingsGeneralUpdateRequest} [putAdminSettingsGeneralUpdateRequest]
1404
1418
  * @param {*} [options] Override http request option.
1405
1419
  * @throws {RequiredError}
1406
1420
  */
1407
- patchAdminSettingsGeneralUpdate(orgId, options) {
1421
+ patchAdminSettingsGeneralUpdate(orgId, putAdminSettingsGeneralUpdateRequest, options) {
1408
1422
  return __awaiter(this, void 0, void 0, function* () {
1409
1423
  var _a, _b, _c;
1410
- const localVarAxiosArgs = yield localVarAxiosParamCreator.patchAdminSettingsGeneralUpdate(orgId, options);
1424
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.patchAdminSettingsGeneralUpdate(orgId, putAdminSettingsGeneralUpdateRequest, options);
1411
1425
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1412
1426
  const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AdminSettingsApi.patchAdminSettingsGeneralUpdate']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1413
1427
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -1510,7 +1524,7 @@ const AdminSettingsApiFp = function (configuration) {
1510
1524
  });
1511
1525
  },
1512
1526
  /**
1513
- *
1527
+ * Changes the login page settings that are live on the hosted pages. Values go through the same validation as the portal form; keys that the validation does not know are not stored, and the keys whose value it refused are listed in rejected. A change is kept as a published version (restorable in the portal) and recorded in the audit log as branding.login_page_updated. Setting custom_css, custom_html or show_powered_by: false needs a plan that includes it; sending back a stored value, or clearing it, is never refused. A draft that is being edited in the portal is not changed. PUT and PATCH behave the same: keys that are not sent keep their value.
1514
1528
  * @summary Update branding/login page settings
1515
1529
  * @param {string} orgId
1516
1530
  * @param {*} [options] Override http request option.
@@ -1526,32 +1540,34 @@ const AdminSettingsApiFp = function (configuration) {
1526
1540
  });
1527
1541
  },
1528
1542
  /**
1529
- *
1543
+ * Changes the sender of the mail that the organization\'s own mail provider sends: fromEmail, fromName and replyToEmail. The provider itself (credentials, host, on/off) is set up in the portal. Without a provider the mail is sent by LumoAuth with LumoAuth\'s sender, and a write is refused with 400. PATCH changes the fields sent; PUT replaces the three fields as a set (fromEmail is then required). The caller needs settings.manage and users.delete; an access token must come from a sign-in of the last 10 minutes.
1530
1544
  * @summary Update email settings
1531
1545
  * @param {string} orgId
1546
+ * @param {PutAdminSettingsEmailUpdateRequest} [putAdminSettingsEmailUpdateRequest]
1532
1547
  * @param {*} [options] Override http request option.
1533
1548
  * @throws {RequiredError}
1534
1549
  */
1535
- putAdminSettingsEmailUpdate(orgId, options) {
1550
+ putAdminSettingsEmailUpdate(orgId, putAdminSettingsEmailUpdateRequest, options) {
1536
1551
  return __awaiter(this, void 0, void 0, function* () {
1537
1552
  var _a, _b, _c;
1538
- const localVarAxiosArgs = yield localVarAxiosParamCreator.putAdminSettingsEmailUpdate(orgId, options);
1553
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.putAdminSettingsEmailUpdate(orgId, putAdminSettingsEmailUpdateRequest, options);
1539
1554
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1540
1555
  const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AdminSettingsApi.putAdminSettingsEmailUpdate']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1541
1556
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1542
1557
  });
1543
1558
  },
1544
1559
  /**
1545
- *
1560
+ * Changes the name of the organization and the default language of the hosted pages. name, tenantName, display_name and displayName are four spellings of the one name: send one of them, or the same text in each. timezone is not a setting (dates are shown in UTC) and is refused with 400. Other keys are ignored. PUT and PATCH behave the same. The caller needs settings.manage, as for PATCH /admin/organization, which changes the same name; changing locale also needs branding.edit.
1546
1561
  * @summary Update general settings
1547
1562
  * @param {string} orgId
1563
+ * @param {PutAdminSettingsGeneralUpdateRequest} [putAdminSettingsGeneralUpdateRequest]
1548
1564
  * @param {*} [options] Override http request option.
1549
1565
  * @throws {RequiredError}
1550
1566
  */
1551
- putAdminSettingsGeneralUpdate(orgId, options) {
1567
+ putAdminSettingsGeneralUpdate(orgId, putAdminSettingsGeneralUpdateRequest, options) {
1552
1568
  return __awaiter(this, void 0, void 0, function* () {
1553
1569
  var _a, _b, _c;
1554
- const localVarAxiosArgs = yield localVarAxiosParamCreator.putAdminSettingsGeneralUpdate(orgId, options);
1570
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.putAdminSettingsGeneralUpdate(orgId, putAdminSettingsGeneralUpdateRequest, options);
1555
1571
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1556
1572
  const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AdminSettingsApi.putAdminSettingsGeneralUpdate']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1557
1573
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -1656,7 +1672,7 @@ const AdminSettingsApiFactory = function (configuration, basePath, axios) {
1656
1672
  return localVarFp.adminOrganizationGet(requestParameters.orgId, options).then((request) => request(axios, basePath));
1657
1673
  },
1658
1674
  /**
1659
- *
1675
+ * Needs `settings.view`. The `branding` part is returned only to a caller who also holds `branding.view` (for an API key, its creator), as for GET /settings/branding and the portal\'s branding page; without it the key is left out.
1660
1676
  * @summary Get all settings (combined)
1661
1677
  * @param {AdminSettingsApiAdminSettingsAllRequest} requestParameters Request parameters.
1662
1678
  * @param {*} [options] Override http request option.
@@ -1696,7 +1712,7 @@ const AdminSettingsApiFactory = function (configuration, basePath, axios) {
1696
1712
  return localVarFp.adminSettingsBrandingGet(requestParameters.orgId, options).then((request) => request(axios, basePath));
1697
1713
  },
1698
1714
  /**
1699
- *
1715
+ * Shows who sends the organization\'s mail: its own mail provider (set up in the portal) with the From address, From name and Reply-To stored there, or LumoAuth with LumoAuth\'s sender.
1700
1716
  * @summary Get email settings
1701
1717
  * @param {AdminSettingsApiAdminSettingsEmailGetRequest} requestParameters Request parameters.
1702
1718
  * @param {*} [options] Override http request option.
@@ -1776,7 +1792,7 @@ const AdminSettingsApiFactory = function (configuration, basePath, axios) {
1776
1792
  return localVarFp.patchAdminSettingsAuthenticationUpdate(requestParameters.orgId, options).then((request) => request(axios, basePath));
1777
1793
  },
1778
1794
  /**
1779
- *
1795
+ * Changes the login page settings that are live on the hosted pages. Values go through the same validation as the portal form; keys that the validation does not know are not stored, and the keys whose value it refused are listed in rejected. A change is kept as a published version (restorable in the portal) and recorded in the audit log as branding.login_page_updated. Setting custom_css, custom_html or show_powered_by: false needs a plan that includes it; sending back a stored value, or clearing it, is never refused. A draft that is being edited in the portal is not changed. PUT and PATCH behave the same: keys that are not sent keep their value.
1780
1796
  * @summary Update branding/login page settings
1781
1797
  * @param {AdminSettingsApiPatchAdminSettingsBrandingUpdateRequest} requestParameters Request parameters.
1782
1798
  * @param {*} [options] Override http request option.
@@ -1786,24 +1802,24 @@ const AdminSettingsApiFactory = function (configuration, basePath, axios) {
1786
1802
  return localVarFp.patchAdminSettingsBrandingUpdate(requestParameters.orgId, options).then((request) => request(axios, basePath));
1787
1803
  },
1788
1804
  /**
1789
- *
1805
+ * Changes the sender of the mail that the organization\'s own mail provider sends: fromEmail, fromName and replyToEmail. The provider itself (credentials, host, on/off) is set up in the portal. Without a provider the mail is sent by LumoAuth with LumoAuth\'s sender, and a write is refused with 400. PATCH changes the fields sent; PUT replaces the three fields as a set (fromEmail is then required). The caller needs settings.manage and users.delete; an access token must come from a sign-in of the last 10 minutes.
1790
1806
  * @summary Update email settings
1791
1807
  * @param {AdminSettingsApiPatchAdminSettingsEmailUpdateRequest} requestParameters Request parameters.
1792
1808
  * @param {*} [options] Override http request option.
1793
1809
  * @throws {RequiredError}
1794
1810
  */
1795
1811
  patchAdminSettingsEmailUpdate(requestParameters, options) {
1796
- return localVarFp.patchAdminSettingsEmailUpdate(requestParameters.orgId, options).then((request) => request(axios, basePath));
1812
+ return localVarFp.patchAdminSettingsEmailUpdate(requestParameters.orgId, requestParameters.putAdminSettingsEmailUpdateRequest, options).then((request) => request(axios, basePath));
1797
1813
  },
1798
1814
  /**
1799
- *
1815
+ * Changes the name of the organization and the default language of the hosted pages. name, tenantName, display_name and displayName are four spellings of the one name: send one of them, or the same text in each. timezone is not a setting (dates are shown in UTC) and is refused with 400. Other keys are ignored. PUT and PATCH behave the same. The caller needs settings.manage, as for PATCH /admin/organization, which changes the same name; changing locale also needs branding.edit.
1800
1816
  * @summary Update general settings
1801
1817
  * @param {AdminSettingsApiPatchAdminSettingsGeneralUpdateRequest} requestParameters Request parameters.
1802
1818
  * @param {*} [options] Override http request option.
1803
1819
  * @throws {RequiredError}
1804
1820
  */
1805
1821
  patchAdminSettingsGeneralUpdate(requestParameters, options) {
1806
- return localVarFp.patchAdminSettingsGeneralUpdate(requestParameters.orgId, options).then((request) => request(axios, basePath));
1822
+ return localVarFp.patchAdminSettingsGeneralUpdate(requestParameters.orgId, requestParameters.putAdminSettingsGeneralUpdateRequest, options).then((request) => request(axios, basePath));
1807
1823
  },
1808
1824
  /**
1809
1825
  *
@@ -1866,7 +1882,7 @@ const AdminSettingsApiFactory = function (configuration, basePath, axios) {
1866
1882
  return localVarFp.putAdminSettingsAuthenticationUpdate(requestParameters.orgId, options).then((request) => request(axios, basePath));
1867
1883
  },
1868
1884
  /**
1869
- *
1885
+ * Changes the login page settings that are live on the hosted pages. Values go through the same validation as the portal form; keys that the validation does not know are not stored, and the keys whose value it refused are listed in rejected. A change is kept as a published version (restorable in the portal) and recorded in the audit log as branding.login_page_updated. Setting custom_css, custom_html or show_powered_by: false needs a plan that includes it; sending back a stored value, or clearing it, is never refused. A draft that is being edited in the portal is not changed. PUT and PATCH behave the same: keys that are not sent keep their value.
1870
1886
  * @summary Update branding/login page settings
1871
1887
  * @param {AdminSettingsApiPutAdminSettingsBrandingUpdateRequest} requestParameters Request parameters.
1872
1888
  * @param {*} [options] Override http request option.
@@ -1876,24 +1892,24 @@ const AdminSettingsApiFactory = function (configuration, basePath, axios) {
1876
1892
  return localVarFp.putAdminSettingsBrandingUpdate(requestParameters.orgId, options).then((request) => request(axios, basePath));
1877
1893
  },
1878
1894
  /**
1879
- *
1895
+ * Changes the sender of the mail that the organization\'s own mail provider sends: fromEmail, fromName and replyToEmail. The provider itself (credentials, host, on/off) is set up in the portal. Without a provider the mail is sent by LumoAuth with LumoAuth\'s sender, and a write is refused with 400. PATCH changes the fields sent; PUT replaces the three fields as a set (fromEmail is then required). The caller needs settings.manage and users.delete; an access token must come from a sign-in of the last 10 minutes.
1880
1896
  * @summary Update email settings
1881
1897
  * @param {AdminSettingsApiPutAdminSettingsEmailUpdateRequest} requestParameters Request parameters.
1882
1898
  * @param {*} [options] Override http request option.
1883
1899
  * @throws {RequiredError}
1884
1900
  */
1885
1901
  putAdminSettingsEmailUpdate(requestParameters, options) {
1886
- return localVarFp.putAdminSettingsEmailUpdate(requestParameters.orgId, options).then((request) => request(axios, basePath));
1902
+ return localVarFp.putAdminSettingsEmailUpdate(requestParameters.orgId, requestParameters.putAdminSettingsEmailUpdateRequest, options).then((request) => request(axios, basePath));
1887
1903
  },
1888
1904
  /**
1889
- *
1905
+ * Changes the name of the organization and the default language of the hosted pages. name, tenantName, display_name and displayName are four spellings of the one name: send one of them, or the same text in each. timezone is not a setting (dates are shown in UTC) and is refused with 400. Other keys are ignored. PUT and PATCH behave the same. The caller needs settings.manage, as for PATCH /admin/organization, which changes the same name; changing locale also needs branding.edit.
1890
1906
  * @summary Update general settings
1891
1907
  * @param {AdminSettingsApiPutAdminSettingsGeneralUpdateRequest} requestParameters Request parameters.
1892
1908
  * @param {*} [options] Override http request option.
1893
1909
  * @throws {RequiredError}
1894
1910
  */
1895
1911
  putAdminSettingsGeneralUpdate(requestParameters, options) {
1896
- return localVarFp.putAdminSettingsGeneralUpdate(requestParameters.orgId, options).then((request) => request(axios, basePath));
1912
+ return localVarFp.putAdminSettingsGeneralUpdate(requestParameters.orgId, requestParameters.putAdminSettingsGeneralUpdateRequest, options).then((request) => request(axios, basePath));
1897
1913
  },
1898
1914
  /**
1899
1915
  *
@@ -1980,7 +1996,7 @@ class AdminSettingsApi extends base_1.BaseAPI {
1980
1996
  return (0, exports.AdminSettingsApiFp)(this.configuration).adminOrganizationGet(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
1981
1997
  }
1982
1998
  /**
1983
- *
1999
+ * Needs `settings.view`. The `branding` part is returned only to a caller who also holds `branding.view` (for an API key, its creator), as for GET /settings/branding and the portal\'s branding page; without it the key is left out.
1984
2000
  * @summary Get all settings (combined)
1985
2001
  * @param {AdminSettingsApiAdminSettingsAllRequest} requestParameters Request parameters.
1986
2002
  * @param {*} [options] Override http request option.
@@ -2024,7 +2040,7 @@ class AdminSettingsApi extends base_1.BaseAPI {
2024
2040
  return (0, exports.AdminSettingsApiFp)(this.configuration).adminSettingsBrandingGet(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
2025
2041
  }
2026
2042
  /**
2027
- *
2043
+ * Shows who sends the organization\'s mail: its own mail provider (set up in the portal) with the From address, From name and Reply-To stored there, or LumoAuth with LumoAuth\'s sender.
2028
2044
  * @summary Get email settings
2029
2045
  * @param {AdminSettingsApiAdminSettingsEmailGetRequest} requestParameters Request parameters.
2030
2046
  * @param {*} [options] Override http request option.
@@ -2112,7 +2128,7 @@ class AdminSettingsApi extends base_1.BaseAPI {
2112
2128
  return (0, exports.AdminSettingsApiFp)(this.configuration).patchAdminSettingsAuthenticationUpdate(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
2113
2129
  }
2114
2130
  /**
2115
- *
2131
+ * Changes the login page settings that are live on the hosted pages. Values go through the same validation as the portal form; keys that the validation does not know are not stored, and the keys whose value it refused are listed in rejected. A change is kept as a published version (restorable in the portal) and recorded in the audit log as branding.login_page_updated. Setting custom_css, custom_html or show_powered_by: false needs a plan that includes it; sending back a stored value, or clearing it, is never refused. A draft that is being edited in the portal is not changed. PUT and PATCH behave the same: keys that are not sent keep their value.
2116
2132
  * @summary Update branding/login page settings
2117
2133
  * @param {AdminSettingsApiPatchAdminSettingsBrandingUpdateRequest} requestParameters Request parameters.
2118
2134
  * @param {*} [options] Override http request option.
@@ -2123,7 +2139,7 @@ class AdminSettingsApi extends base_1.BaseAPI {
2123
2139
  return (0, exports.AdminSettingsApiFp)(this.configuration).patchAdminSettingsBrandingUpdate(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
2124
2140
  }
2125
2141
  /**
2126
- *
2142
+ * Changes the sender of the mail that the organization\'s own mail provider sends: fromEmail, fromName and replyToEmail. The provider itself (credentials, host, on/off) is set up in the portal. Without a provider the mail is sent by LumoAuth with LumoAuth\'s sender, and a write is refused with 400. PATCH changes the fields sent; PUT replaces the three fields as a set (fromEmail is then required). The caller needs settings.manage and users.delete; an access token must come from a sign-in of the last 10 minutes.
2127
2143
  * @summary Update email settings
2128
2144
  * @param {AdminSettingsApiPatchAdminSettingsEmailUpdateRequest} requestParameters Request parameters.
2129
2145
  * @param {*} [options] Override http request option.
@@ -2131,10 +2147,10 @@ class AdminSettingsApi extends base_1.BaseAPI {
2131
2147
  * @memberof AdminSettingsApi
2132
2148
  */
2133
2149
  patchAdminSettingsEmailUpdate(requestParameters, options) {
2134
- return (0, exports.AdminSettingsApiFp)(this.configuration).patchAdminSettingsEmailUpdate(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
2150
+ return (0, exports.AdminSettingsApiFp)(this.configuration).patchAdminSettingsEmailUpdate(requestParameters.orgId, requestParameters.putAdminSettingsEmailUpdateRequest, options).then((request) => request(this.axios, this.basePath));
2135
2151
  }
2136
2152
  /**
2137
- *
2153
+ * Changes the name of the organization and the default language of the hosted pages. name, tenantName, display_name and displayName are four spellings of the one name: send one of them, or the same text in each. timezone is not a setting (dates are shown in UTC) and is refused with 400. Other keys are ignored. PUT and PATCH behave the same. The caller needs settings.manage, as for PATCH /admin/organization, which changes the same name; changing locale also needs branding.edit.
2138
2154
  * @summary Update general settings
2139
2155
  * @param {AdminSettingsApiPatchAdminSettingsGeneralUpdateRequest} requestParameters Request parameters.
2140
2156
  * @param {*} [options] Override http request option.
@@ -2142,7 +2158,7 @@ class AdminSettingsApi extends base_1.BaseAPI {
2142
2158
  * @memberof AdminSettingsApi
2143
2159
  */
2144
2160
  patchAdminSettingsGeneralUpdate(requestParameters, options) {
2145
- return (0, exports.AdminSettingsApiFp)(this.configuration).patchAdminSettingsGeneralUpdate(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
2161
+ return (0, exports.AdminSettingsApiFp)(this.configuration).patchAdminSettingsGeneralUpdate(requestParameters.orgId, requestParameters.putAdminSettingsGeneralUpdateRequest, options).then((request) => request(this.axios, this.basePath));
2146
2162
  }
2147
2163
  /**
2148
2164
  *
@@ -2211,7 +2227,7 @@ class AdminSettingsApi extends base_1.BaseAPI {
2211
2227
  return (0, exports.AdminSettingsApiFp)(this.configuration).putAdminSettingsAuthenticationUpdate(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
2212
2228
  }
2213
2229
  /**
2214
- *
2230
+ * Changes the login page settings that are live on the hosted pages. Values go through the same validation as the portal form; keys that the validation does not know are not stored, and the keys whose value it refused are listed in rejected. A change is kept as a published version (restorable in the portal) and recorded in the audit log as branding.login_page_updated. Setting custom_css, custom_html or show_powered_by: false needs a plan that includes it; sending back a stored value, or clearing it, is never refused. A draft that is being edited in the portal is not changed. PUT and PATCH behave the same: keys that are not sent keep their value.
2215
2231
  * @summary Update branding/login page settings
2216
2232
  * @param {AdminSettingsApiPutAdminSettingsBrandingUpdateRequest} requestParameters Request parameters.
2217
2233
  * @param {*} [options] Override http request option.
@@ -2222,7 +2238,7 @@ class AdminSettingsApi extends base_1.BaseAPI {
2222
2238
  return (0, exports.AdminSettingsApiFp)(this.configuration).putAdminSettingsBrandingUpdate(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
2223
2239
  }
2224
2240
  /**
2225
- *
2241
+ * Changes the sender of the mail that the organization\'s own mail provider sends: fromEmail, fromName and replyToEmail. The provider itself (credentials, host, on/off) is set up in the portal. Without a provider the mail is sent by LumoAuth with LumoAuth\'s sender, and a write is refused with 400. PATCH changes the fields sent; PUT replaces the three fields as a set (fromEmail is then required). The caller needs settings.manage and users.delete; an access token must come from a sign-in of the last 10 minutes.
2226
2242
  * @summary Update email settings
2227
2243
  * @param {AdminSettingsApiPutAdminSettingsEmailUpdateRequest} requestParameters Request parameters.
2228
2244
  * @param {*} [options] Override http request option.
@@ -2230,10 +2246,10 @@ class AdminSettingsApi extends base_1.BaseAPI {
2230
2246
  * @memberof AdminSettingsApi
2231
2247
  */
2232
2248
  putAdminSettingsEmailUpdate(requestParameters, options) {
2233
- return (0, exports.AdminSettingsApiFp)(this.configuration).putAdminSettingsEmailUpdate(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
2249
+ return (0, exports.AdminSettingsApiFp)(this.configuration).putAdminSettingsEmailUpdate(requestParameters.orgId, requestParameters.putAdminSettingsEmailUpdateRequest, options).then((request) => request(this.axios, this.basePath));
2234
2250
  }
2235
2251
  /**
2236
- *
2252
+ * Changes the name of the organization and the default language of the hosted pages. name, tenantName, display_name and displayName are four spellings of the one name: send one of them, or the same text in each. timezone is not a setting (dates are shown in UTC) and is refused with 400. Other keys are ignored. PUT and PATCH behave the same. The caller needs settings.manage, as for PATCH /admin/organization, which changes the same name; changing locale also needs branding.edit.
2237
2253
  * @summary Update general settings
2238
2254
  * @param {AdminSettingsApiPutAdminSettingsGeneralUpdateRequest} requestParameters Request parameters.
2239
2255
  * @param {*} [options] Override http request option.
@@ -2241,7 +2257,7 @@ class AdminSettingsApi extends base_1.BaseAPI {
2241
2257
  * @memberof AdminSettingsApi
2242
2258
  */
2243
2259
  putAdminSettingsGeneralUpdate(requestParameters, options) {
2244
- return (0, exports.AdminSettingsApiFp)(this.configuration).putAdminSettingsGeneralUpdate(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
2260
+ return (0, exports.AdminSettingsApiFp)(this.configuration).putAdminSettingsGeneralUpdate(requestParameters.orgId, requestParameters.putAdminSettingsGeneralUpdateRequest, options).then((request) => request(this.axios, this.basePath));
2245
2261
  }
2246
2262
  /**
2247
2263
  *