@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.
- package/.openapi-generator/FILES +12 -2
- package/README.md +10 -3
- package/api/admin-abac-api.ts +18 -5
- package/api/admin-agents-api.ts +50 -5
- package/api/admin-audit-logs-api.ts +15 -15
- package/api/admin-email-api.ts +15 -15
- package/api/admin-groups-api.ts +15 -15
- package/api/admin-mfa-api.ts +10 -10
- package/api/admin-oauth-clients-api.ts +15 -15
- package/api/admin-roles-api.ts +20 -20
- package/api/admin-settings-api.ts +112 -60
- package/api/admin-users-api.ts +320 -31
- package/api/agents-api.ts +5 -5
- package/api/authorization-api.ts +20 -20
- package/api/oauth-api.ts +116 -5
- package/api/ssf-api.ts +10 -10
- package/dist/api/admin-abac-api.d.ts +10 -2
- package/dist/api/admin-abac-api.js +10 -5
- package/dist/api/admin-agents-api.d.ts +37 -2
- package/dist/api/admin-agents-api.js +37 -6
- package/dist/api/admin-audit-logs-api.d.ts +15 -15
- package/dist/api/admin-audit-logs-api.js +12 -12
- package/dist/api/admin-email-api.d.ts +15 -15
- package/dist/api/admin-email-api.js +12 -12
- package/dist/api/admin-groups-api.d.ts +15 -15
- package/dist/api/admin-groups-api.js +12 -12
- package/dist/api/admin-mfa-api.d.ts +10 -10
- package/dist/api/admin-mfa-api.js +8 -8
- package/dist/api/admin-oauth-clients-api.d.ts +15 -15
- package/dist/api/admin-oauth-clients-api.js +12 -12
- package/dist/api/admin-roles-api.d.ts +20 -20
- package/dist/api/admin-roles-api.js +16 -16
- package/dist/api/admin-settings-api.d.ts +82 -48
- package/dist/api/admin-settings-api.js +68 -52
- package/dist/api/admin-users-api.d.ts +201 -22
- package/dist/api/admin-users-api.js +185 -28
- package/dist/api/agents-api.d.ts +5 -5
- package/dist/api/agents-api.js +4 -4
- package/dist/api/authorization-api.d.ts +20 -20
- package/dist/api/authorization-api.js +16 -16
- package/dist/api/oauth-api.d.ts +70 -5
- package/dist/api/oauth-api.js +76 -4
- package/dist/api/ssf-api.d.ts +10 -10
- package/dist/api/ssf-api.js +8 -8
- package/dist/esm/api/admin-abac-api.d.ts +10 -2
- package/dist/esm/api/admin-abac-api.js +10 -5
- package/dist/esm/api/admin-agents-api.d.ts +37 -2
- package/dist/esm/api/admin-agents-api.js +36 -5
- package/dist/esm/api/admin-audit-logs-api.d.ts +15 -15
- package/dist/esm/api/admin-audit-logs-api.js +12 -12
- package/dist/esm/api/admin-email-api.d.ts +15 -15
- package/dist/esm/api/admin-email-api.js +12 -12
- package/dist/esm/api/admin-groups-api.d.ts +15 -15
- package/dist/esm/api/admin-groups-api.js +12 -12
- package/dist/esm/api/admin-mfa-api.d.ts +10 -10
- package/dist/esm/api/admin-mfa-api.js +8 -8
- package/dist/esm/api/admin-oauth-clients-api.d.ts +15 -15
- package/dist/esm/api/admin-oauth-clients-api.js +12 -12
- package/dist/esm/api/admin-roles-api.d.ts +20 -20
- package/dist/esm/api/admin-roles-api.js +16 -16
- package/dist/esm/api/admin-settings-api.d.ts +82 -48
- package/dist/esm/api/admin-settings-api.js +69 -53
- package/dist/esm/api/admin-users-api.d.ts +201 -22
- package/dist/esm/api/admin-users-api.js +184 -27
- package/dist/esm/api/agents-api.d.ts +5 -5
- package/dist/esm/api/agents-api.js +4 -4
- package/dist/esm/api/authorization-api.d.ts +20 -20
- package/dist/esm/api/authorization-api.js +16 -16
- package/dist/esm/api/oauth-api.d.ts +70 -5
- package/dist/esm/api/oauth-api.js +76 -4
- package/dist/esm/api/ssf-api.d.ts +10 -10
- package/dist/esm/api/ssf-api.js +8 -8
- package/dist/esm/models/abac-attribute-definition.d.ts +6 -0
- package/dist/esm/models/abac-policy.d.ts +7 -1
- package/dist/esm/models/admin-analytics-dashboard-response-data-audit.d.ts +1 -1
- package/dist/esm/models/admin-groups-list-response.d.ts +6 -0
- package/dist/esm/models/admin-mcp-servers-list-response.d.ts +8 -3
- package/dist/esm/models/admin-settings-all-response-data-general.d.ts +13 -1
- package/dist/esm/models/admin-settings-all-response-data.d.ts +4 -5
- package/dist/esm/models/admin-settings-email-get-response.d.ts +4 -5
- package/dist/esm/models/admin-settings-general-get-response-data.d.ts +4 -10
- package/dist/esm/models/{admin-mcp-servers-list-response-meta.d.ts → admin-users-restore-response.d.ts} +9 -14
- package/dist/esm/models/ask-response.d.ts +15 -0
- package/dist/esm/models/ask-response.js +10 -1
- package/dist/esm/models/attest-response.d.ts +2 -2
- package/dist/esm/models/authorization-server-metadata.d.ts +8 -2
- package/dist/esm/models/check-email-first-request.d.ts +30 -0
- package/dist/esm/models/check-email-first-request.js +14 -0
- package/dist/esm/models/check-email-first-response.d.ts +42 -0
- package/dist/esm/models/check-email-first-response.js +14 -0
- package/dist/esm/models/email-sender-settings.d.ts +62 -0
- package/dist/esm/models/email-sender-settings.js +22 -0
- package/dist/esm/models/get-me-response.d.ts +18 -0
- package/dist/esm/models/get-server-challenge-response.d.ts +3 -2
- package/dist/esm/models/get-server-challenge-response.js +1 -0
- package/dist/esm/models/index.d.ts +6 -1
- package/dist/esm/models/index.js +6 -1
- package/dist/esm/models/introspect-response.d.ts +6 -0
- package/dist/esm/models/issue-agent-token-request.d.ts +6 -0
- package/dist/esm/models/list-users-response.d.ts +6 -0
- package/dist/esm/models/oauth-scope.d.ts +1 -7
- package/dist/esm/models/open-id-configuration.d.ts +3 -3
- package/dist/esm/models/put-admin-settings-branding-update-response.d.ts +6 -0
- package/dist/esm/models/put-admin-settings-email-update-request.d.ts +36 -0
- package/dist/esm/models/put-admin-settings-email-update-request.js +14 -0
- package/dist/esm/models/put-admin-settings-email-update-response.d.ts +4 -5
- package/dist/esm/models/put-admin-settings-general-update-request.d.ts +30 -0
- package/dist/esm/models/put-admin-settings-general-update-request.js +14 -0
- package/dist/esm/models/put-admin-settings-general-update-response-data.d.ts +1 -7
- package/dist/esm/models/register-client-response.d.ts +0 -24
- package/dist/esm/models/registered-client-metadata.d.ts +0 -24
- package/dist/esm/models/social-login-provider.d.ts +2 -1
- package/dist/esm/models/user.d.ts +12 -0
- package/dist/esm/models/userinfo-response.d.ts +4 -12
- package/dist/esm/models/userinfo-response.js +0 -2
- package/dist/models/abac-attribute-definition.d.ts +6 -0
- package/dist/models/abac-policy.d.ts +7 -1
- package/dist/models/admin-analytics-dashboard-response-data-audit.d.ts +1 -1
- package/dist/models/admin-groups-list-response.d.ts +6 -0
- package/dist/models/admin-mcp-servers-list-response.d.ts +8 -3
- package/dist/models/admin-settings-all-response-data-general.d.ts +13 -1
- package/dist/models/admin-settings-all-response-data.d.ts +4 -5
- package/dist/models/admin-settings-email-get-response.d.ts +4 -5
- package/dist/models/admin-settings-general-get-response-data.d.ts +4 -10
- package/dist/models/{admin-mcp-servers-list-response-meta.d.ts → admin-users-restore-response.d.ts} +9 -14
- package/dist/models/ask-response.d.ts +15 -0
- package/dist/models/ask-response.js +11 -0
- package/dist/models/attest-response.d.ts +2 -2
- package/dist/models/authorization-server-metadata.d.ts +8 -2
- package/dist/models/check-email-first-request.d.ts +30 -0
- package/dist/models/check-email-first-request.js +15 -0
- package/dist/models/check-email-first-response.d.ts +42 -0
- package/dist/models/check-email-first-response.js +15 -0
- package/dist/models/email-sender-settings.d.ts +62 -0
- package/dist/models/email-sender-settings.js +25 -0
- package/dist/models/get-me-response.d.ts +18 -0
- package/dist/models/get-server-challenge-response.d.ts +3 -2
- package/dist/models/get-server-challenge-response.js +1 -0
- package/dist/models/index.d.ts +6 -1
- package/dist/models/index.js +6 -1
- package/dist/models/introspect-response.d.ts +6 -0
- package/dist/models/issue-agent-token-request.d.ts +6 -0
- package/dist/models/list-users-response.d.ts +6 -0
- package/dist/models/oauth-scope.d.ts +1 -7
- package/dist/models/open-id-configuration.d.ts +3 -3
- package/dist/models/put-admin-settings-branding-update-response.d.ts +6 -0
- package/dist/models/put-admin-settings-email-update-request.d.ts +36 -0
- package/dist/models/put-admin-settings-email-update-request.js +15 -0
- package/dist/models/put-admin-settings-email-update-response.d.ts +4 -5
- package/dist/models/put-admin-settings-general-update-request.d.ts +30 -0
- package/dist/models/put-admin-settings-general-update-request.js +15 -0
- package/dist/models/put-admin-settings-general-update-response-data.d.ts +1 -7
- package/dist/models/register-client-response.d.ts +0 -24
- package/dist/models/registered-client-metadata.d.ts +0 -24
- package/dist/models/social-login-provider.d.ts +2 -1
- package/dist/models/user.d.ts +12 -0
- package/dist/models/userinfo-response.d.ts +4 -12
- package/dist/models/userinfo-response.js +0 -2
- package/docs/AbacAttributeDefinition.md +2 -0
- package/docs/AbacPolicy.md +3 -1
- package/docs/AdminAbacApi.md +14 -9
- package/docs/AdminAgentsApi.md +7 -1
- package/docs/AdminAnalyticsDashboardResponseDataAudit.md +1 -1
- package/docs/AdminAuditLogsApi.md +3 -0
- package/docs/AdminEmailApi.md +3 -0
- package/docs/AdminGroupsApi.md +3 -0
- package/docs/AdminGroupsListResponse.md +2 -0
- package/docs/AdminMcpServersListResponse.md +3 -1
- package/docs/AdminMfaApi.md +4 -2
- package/docs/AdminOAuthClientsApi.md +3 -1
- package/docs/AdminOrganizationsApi.md +13 -5
- package/docs/AdminRolesApi.md +10 -0
- package/docs/AdminSettingsAllResponseData.md +1 -1
- package/docs/AdminSettingsAllResponseDataGeneral.md +5 -1
- package/docs/AdminSettingsApi.md +54 -12
- package/docs/AdminSettingsEmailGetResponse.md +1 -1
- package/docs/AdminSettingsGeneralGetResponseData.md +4 -6
- package/docs/AdminUsersApi.md +104 -2
- package/docs/AdminUsersRestoreResponse.md +22 -0
- package/docs/AgentsApi.md +2 -2
- package/docs/AskResponse.md +2 -0
- package/docs/AttestResponse.md +1 -1
- package/docs/AuthorizationApi.md +4 -4
- package/docs/AuthorizationServerMetadata.md +4 -2
- package/docs/CheckEmailFirstRequest.md +22 -0
- package/docs/CheckEmailFirstResponse.md +26 -0
- package/docs/EmailSenderSettings.md +31 -0
- package/docs/GetMeResponse.md +6 -0
- package/docs/GetServerChallengeResponse.md +1 -1
- package/docs/IdentityApi.md +2 -2
- package/docs/IntrospectResponse.md +2 -0
- package/docs/IssueAgentTokenRequest.md +2 -0
- package/docs/ListUsersResponse.md +2 -0
- package/docs/McpApi.md +5 -6
- package/docs/OAuthApi.md +72 -12
- package/docs/OAuthScope.md +1 -3
- package/docs/OIDCApi.md +4 -4
- package/docs/OpenIdConfiguration.md +3 -3
- package/docs/PutAdminSettingsBrandingUpdateResponse.md +2 -0
- package/docs/PutAdminSettingsEmailUpdateRequest.md +24 -0
- package/docs/PutAdminSettingsEmailUpdateResponse.md +1 -1
- package/docs/PutAdminSettingsGeneralUpdateRequest.md +22 -0
- package/docs/PutAdminSettingsGeneralUpdateResponseData.md +1 -3
- package/docs/RegisterClientResponse.md +0 -8
- package/docs/RegisteredClientMetadata.md +0 -8
- package/docs/SocialLoginProvider.md +1 -1
- package/docs/SsfApi.md +2 -0
- package/docs/User.md +4 -0
- package/docs/UserinfoResponse.md +3 -5
- package/docs/WellKnownApi.md +2 -2
- package/models/abac-attribute-definition.ts +6 -0
- package/models/abac-policy.ts +7 -1
- package/models/admin-analytics-dashboard-response-data-audit.ts +1 -1
- package/models/admin-groups-list-response.ts +6 -0
- package/models/admin-mcp-servers-list-response.ts +8 -5
- package/models/admin-settings-all-response-data-general.ts +13 -1
- package/models/admin-settings-all-response-data.ts +6 -3
- package/models/admin-settings-email-get-response.ts +6 -3
- package/models/admin-settings-general-get-response-data.ts +4 -10
- package/models/{admin-mcp-servers-list-response-meta.ts → admin-users-restore-response.ts} +11 -14
- package/models/ask-response.ts +17 -0
- package/models/attest-response.ts +2 -2
- package/models/authorization-server-metadata.ts +8 -2
- package/models/check-email-first-request.ts +36 -0
- package/models/check-email-first-response.ts +48 -0
- package/models/email-sender-settings.ts +70 -0
- package/models/get-me-response.ts +18 -0
- package/models/get-server-challenge-response.ts +3 -2
- package/models/index.ts +6 -1
- package/models/introspect-response.ts +6 -0
- package/models/issue-agent-token-request.ts +6 -0
- package/models/list-users-response.ts +6 -0
- package/models/oauth-scope.ts +1 -7
- package/models/open-id-configuration.ts +3 -3
- package/models/put-admin-settings-branding-update-response.ts +6 -0
- package/models/put-admin-settings-email-update-request.ts +42 -0
- package/models/put-admin-settings-email-update-response.ts +6 -3
- package/models/put-admin-settings-general-update-request.ts +36 -0
- package/models/put-admin-settings-general-update-response-data.ts +1 -7
- package/models/register-client-response.ts +0 -24
- package/models/registered-client-metadata.ts +0 -24
- package/models/social-login-provider.ts +2 -1
- package/models/user.ts +12 -0
- package/models/userinfo-response.ts +4 -12
- package/package.json +1 -1
- package/docs/AdminMcpServersListResponseMeta.md +0 -24
- /package/dist/esm/models/{admin-mcp-servers-list-response-meta.js → admin-users-restore-response.js} +0 -0
- /package/dist/models/{admin-mcp-servers-list-response-meta.js → admin-users-restore-response.js} +0 -0
|
@@ -31,7 +31,7 @@ export declare const AdminAuditLogsApiAxiosParamCreator: (configuration?: Config
|
|
|
31
31
|
*/
|
|
32
32
|
adminAuditLogsActions: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
33
33
|
/**
|
|
34
|
-
*
|
|
34
|
+
* Needs `audit.export` and `audit.view`, as the export on the portal\'s audit log page does.
|
|
35
35
|
* @summary Export audit logs as CSV (default) or JSON
|
|
36
36
|
* @param {string} orgId
|
|
37
37
|
* @param {*} [options] Override http request option.
|
|
@@ -72,7 +72,7 @@ export declare const AdminAuditLogsApiAxiosParamCreator: (configuration?: Config
|
|
|
72
72
|
*/
|
|
73
73
|
adminAuditLogsStats: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
74
74
|
/**
|
|
75
|
-
*
|
|
75
|
+
* Needs `settings.manage` and `gdpr.manage`, as the GDPR settings page in the portal does.
|
|
76
76
|
* @summary Update audit log retention settings
|
|
77
77
|
* @param {string} orgId
|
|
78
78
|
* @param {*} [options] Override http request option.
|
|
@@ -80,7 +80,7 @@ export declare const AdminAuditLogsApiAxiosParamCreator: (configuration?: Config
|
|
|
80
80
|
*/
|
|
81
81
|
patchAdminAuditLogsRetentionUpdate: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82
82
|
/**
|
|
83
|
-
*
|
|
83
|
+
* Needs `settings.manage` and `gdpr.manage`, as the GDPR settings page in the portal does.
|
|
84
84
|
* @summary Update audit log retention settings
|
|
85
85
|
* @param {string} orgId
|
|
86
86
|
* @param {*} [options] Override http request option.
|
|
@@ -102,7 +102,7 @@ export declare const AdminAuditLogsApiFp: (configuration?: Configuration) => {
|
|
|
102
102
|
*/
|
|
103
103
|
adminAuditLogsActions(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAuditLogsActionsResponse>>;
|
|
104
104
|
/**
|
|
105
|
-
*
|
|
105
|
+
* Needs `audit.export` and `audit.view`, as the export on the portal\'s audit log page does.
|
|
106
106
|
* @summary Export audit logs as CSV (default) or JSON
|
|
107
107
|
* @param {string} orgId
|
|
108
108
|
* @param {*} [options] Override http request option.
|
|
@@ -143,7 +143,7 @@ export declare const AdminAuditLogsApiFp: (configuration?: Configuration) => {
|
|
|
143
143
|
*/
|
|
144
144
|
adminAuditLogsStats(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAuditLogsStatsResponse>>;
|
|
145
145
|
/**
|
|
146
|
-
*
|
|
146
|
+
* Needs `settings.manage` and `gdpr.manage`, as the GDPR settings page in the portal does.
|
|
147
147
|
* @summary Update audit log retention settings
|
|
148
148
|
* @param {string} orgId
|
|
149
149
|
* @param {*} [options] Override http request option.
|
|
@@ -151,7 +151,7 @@ export declare const AdminAuditLogsApiFp: (configuration?: Configuration) => {
|
|
|
151
151
|
*/
|
|
152
152
|
patchAdminAuditLogsRetentionUpdate(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAuditLogsRetentionResponse>>;
|
|
153
153
|
/**
|
|
154
|
-
*
|
|
154
|
+
* Needs `settings.manage` and `gdpr.manage`, as the GDPR settings page in the portal does.
|
|
155
155
|
* @summary Update audit log retention settings
|
|
156
156
|
* @param {string} orgId
|
|
157
157
|
* @param {*} [options] Override http request option.
|
|
@@ -173,7 +173,7 @@ export declare const AdminAuditLogsApiFactory: (configuration?: Configuration, b
|
|
|
173
173
|
*/
|
|
174
174
|
adminAuditLogsActions(requestParameters: AdminAuditLogsApiAdminAuditLogsActionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminAuditLogsActionsResponse>;
|
|
175
175
|
/**
|
|
176
|
-
*
|
|
176
|
+
* Needs `audit.export` and `audit.view`, as the export on the portal\'s audit log page does.
|
|
177
177
|
* @summary Export audit logs as CSV (default) or JSON
|
|
178
178
|
* @param {AdminAuditLogsApiAdminAuditLogsExportRequest} requestParameters Request parameters.
|
|
179
179
|
* @param {*} [options] Override http request option.
|
|
@@ -213,7 +213,7 @@ export declare const AdminAuditLogsApiFactory: (configuration?: Configuration, b
|
|
|
213
213
|
*/
|
|
214
214
|
adminAuditLogsStats(requestParameters: AdminAuditLogsApiAdminAuditLogsStatsRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminAuditLogsStatsResponse>;
|
|
215
215
|
/**
|
|
216
|
-
*
|
|
216
|
+
* Needs `settings.manage` and `gdpr.manage`, as the GDPR settings page in the portal does.
|
|
217
217
|
* @summary Update audit log retention settings
|
|
218
218
|
* @param {AdminAuditLogsApiPatchAdminAuditLogsRetentionUpdateRequest} requestParameters Request parameters.
|
|
219
219
|
* @param {*} [options] Override http request option.
|
|
@@ -221,7 +221,7 @@ export declare const AdminAuditLogsApiFactory: (configuration?: Configuration, b
|
|
|
221
221
|
*/
|
|
222
222
|
patchAdminAuditLogsRetentionUpdate(requestParameters: AdminAuditLogsApiPatchAdminAuditLogsRetentionUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminAuditLogsRetentionResponse>;
|
|
223
223
|
/**
|
|
224
|
-
*
|
|
224
|
+
* Needs `settings.manage` and `gdpr.manage`, as the GDPR settings page in the portal does.
|
|
225
225
|
* @summary Update audit log retention settings
|
|
226
226
|
* @param {AdminAuditLogsApiPutAdminAuditLogsRetentionUpdateRequest} requestParameters Request parameters.
|
|
227
227
|
* @param {*} [options] Override http request option.
|
|
@@ -245,7 +245,7 @@ export interface AdminAuditLogsApiInterface {
|
|
|
245
245
|
*/
|
|
246
246
|
adminAuditLogsActions(requestParameters: AdminAuditLogsApiAdminAuditLogsActionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminAuditLogsActionsResponse>;
|
|
247
247
|
/**
|
|
248
|
-
*
|
|
248
|
+
* Needs `audit.export` and `audit.view`, as the export on the portal\'s audit log page does.
|
|
249
249
|
* @summary Export audit logs as CSV (default) or JSON
|
|
250
250
|
* @param {AdminAuditLogsApiAdminAuditLogsExportRequest} requestParameters Request parameters.
|
|
251
251
|
* @param {*} [options] Override http request option.
|
|
@@ -290,7 +290,7 @@ export interface AdminAuditLogsApiInterface {
|
|
|
290
290
|
*/
|
|
291
291
|
adminAuditLogsStats(requestParameters: AdminAuditLogsApiAdminAuditLogsStatsRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminAuditLogsStatsResponse>;
|
|
292
292
|
/**
|
|
293
|
-
*
|
|
293
|
+
* Needs `settings.manage` and `gdpr.manage`, as the GDPR settings page in the portal does.
|
|
294
294
|
* @summary Update audit log retention settings
|
|
295
295
|
* @param {AdminAuditLogsApiPatchAdminAuditLogsRetentionUpdateRequest} requestParameters Request parameters.
|
|
296
296
|
* @param {*} [options] Override http request option.
|
|
@@ -299,7 +299,7 @@ export interface AdminAuditLogsApiInterface {
|
|
|
299
299
|
*/
|
|
300
300
|
patchAdminAuditLogsRetentionUpdate(requestParameters: AdminAuditLogsApiPatchAdminAuditLogsRetentionUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminAuditLogsRetentionResponse>;
|
|
301
301
|
/**
|
|
302
|
-
*
|
|
302
|
+
* Needs `settings.manage` and `gdpr.manage`, as the GDPR settings page in the portal does.
|
|
303
303
|
* @summary Update audit log retention settings
|
|
304
304
|
* @param {AdminAuditLogsApiPutAdminAuditLogsRetentionUpdateRequest} requestParameters Request parameters.
|
|
305
305
|
* @param {*} [options] Override http request option.
|
|
@@ -435,7 +435,7 @@ export declare class AdminAuditLogsApi extends BaseAPI implements AdminAuditLogs
|
|
|
435
435
|
*/
|
|
436
436
|
adminAuditLogsActions(requestParameters: AdminAuditLogsApiAdminAuditLogsActionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAuditLogsActionsResponse, any, {}>>;
|
|
437
437
|
/**
|
|
438
|
-
*
|
|
438
|
+
* Needs `audit.export` and `audit.view`, as the export on the portal\'s audit log page does.
|
|
439
439
|
* @summary Export audit logs as CSV (default) or JSON
|
|
440
440
|
* @param {AdminAuditLogsApiAdminAuditLogsExportRequest} requestParameters Request parameters.
|
|
441
441
|
* @param {*} [options] Override http request option.
|
|
@@ -480,7 +480,7 @@ export declare class AdminAuditLogsApi extends BaseAPI implements AdminAuditLogs
|
|
|
480
480
|
*/
|
|
481
481
|
adminAuditLogsStats(requestParameters: AdminAuditLogsApiAdminAuditLogsStatsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAuditLogsStatsResponse, any, {}>>;
|
|
482
482
|
/**
|
|
483
|
-
*
|
|
483
|
+
* Needs `settings.manage` and `gdpr.manage`, as the GDPR settings page in the portal does.
|
|
484
484
|
* @summary Update audit log retention settings
|
|
485
485
|
* @param {AdminAuditLogsApiPatchAdminAuditLogsRetentionUpdateRequest} requestParameters Request parameters.
|
|
486
486
|
* @param {*} [options] Override http request option.
|
|
@@ -489,7 +489,7 @@ export declare class AdminAuditLogsApi extends BaseAPI implements AdminAuditLogs
|
|
|
489
489
|
*/
|
|
490
490
|
patchAdminAuditLogsRetentionUpdate(requestParameters: AdminAuditLogsApiPatchAdminAuditLogsRetentionUpdateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAuditLogsRetentionResponse, any, {}>>;
|
|
491
491
|
/**
|
|
492
|
-
*
|
|
492
|
+
* Needs `settings.manage` and `gdpr.manage`, as the GDPR settings page in the portal does.
|
|
493
493
|
* @summary Update audit log retention settings
|
|
494
494
|
* @param {AdminAuditLogsApiPutAdminAuditLogsRetentionUpdateRequest} requestParameters Request parameters.
|
|
495
495
|
* @param {*} [options] Override http request option.
|
|
@@ -67,7 +67,7 @@ export const AdminAuditLogsApiAxiosParamCreator = function (configuration) {
|
|
|
67
67
|
};
|
|
68
68
|
}),
|
|
69
69
|
/**
|
|
70
|
-
*
|
|
70
|
+
* Needs `audit.export` and `audit.view`, as the export on the portal\'s audit log page does.
|
|
71
71
|
* @summary Export audit logs as CSV (default) or JSON
|
|
72
72
|
* @param {string} orgId
|
|
73
73
|
* @param {*} [options] Override http request option.
|
|
@@ -241,7 +241,7 @@ export const AdminAuditLogsApiAxiosParamCreator = function (configuration) {
|
|
|
241
241
|
};
|
|
242
242
|
}),
|
|
243
243
|
/**
|
|
244
|
-
*
|
|
244
|
+
* Needs `settings.manage` and `gdpr.manage`, as the GDPR settings page in the portal does.
|
|
245
245
|
* @summary Update audit log retention settings
|
|
246
246
|
* @param {string} orgId
|
|
247
247
|
* @param {*} [options] Override http request option.
|
|
@@ -275,7 +275,7 @@ export const AdminAuditLogsApiAxiosParamCreator = function (configuration) {
|
|
|
275
275
|
};
|
|
276
276
|
}),
|
|
277
277
|
/**
|
|
278
|
-
*
|
|
278
|
+
* Needs `settings.manage` and `gdpr.manage`, as the GDPR settings page in the portal does.
|
|
279
279
|
* @summary Update audit log retention settings
|
|
280
280
|
* @param {string} orgId
|
|
281
281
|
* @param {*} [options] Override http request option.
|
|
@@ -334,7 +334,7 @@ export const AdminAuditLogsApiFp = function (configuration) {
|
|
|
334
334
|
});
|
|
335
335
|
},
|
|
336
336
|
/**
|
|
337
|
-
*
|
|
337
|
+
* Needs `audit.export` and `audit.view`, as the export on the portal\'s audit log page does.
|
|
338
338
|
* @summary Export audit logs as CSV (default) or JSON
|
|
339
339
|
* @param {string} orgId
|
|
340
340
|
* @param {*} [options] Override http request option.
|
|
@@ -415,7 +415,7 @@ export const AdminAuditLogsApiFp = function (configuration) {
|
|
|
415
415
|
});
|
|
416
416
|
},
|
|
417
417
|
/**
|
|
418
|
-
*
|
|
418
|
+
* Needs `settings.manage` and `gdpr.manage`, as the GDPR settings page in the portal does.
|
|
419
419
|
* @summary Update audit log retention settings
|
|
420
420
|
* @param {string} orgId
|
|
421
421
|
* @param {*} [options] Override http request option.
|
|
@@ -431,7 +431,7 @@ export const AdminAuditLogsApiFp = function (configuration) {
|
|
|
431
431
|
});
|
|
432
432
|
},
|
|
433
433
|
/**
|
|
434
|
-
*
|
|
434
|
+
* Needs `settings.manage` and `gdpr.manage`, as the GDPR settings page in the portal does.
|
|
435
435
|
* @summary Update audit log retention settings
|
|
436
436
|
* @param {string} orgId
|
|
437
437
|
* @param {*} [options] Override http request option.
|
|
@@ -466,7 +466,7 @@ export const AdminAuditLogsApiFactory = function (configuration, basePath, axios
|
|
|
466
466
|
return localVarFp.adminAuditLogsActions(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
467
467
|
},
|
|
468
468
|
/**
|
|
469
|
-
*
|
|
469
|
+
* Needs `audit.export` and `audit.view`, as the export on the portal\'s audit log page does.
|
|
470
470
|
* @summary Export audit logs as CSV (default) or JSON
|
|
471
471
|
* @param {AdminAuditLogsApiAdminAuditLogsExportRequest} requestParameters Request parameters.
|
|
472
472
|
* @param {*} [options] Override http request option.
|
|
@@ -516,7 +516,7 @@ export const AdminAuditLogsApiFactory = function (configuration, basePath, axios
|
|
|
516
516
|
return localVarFp.adminAuditLogsStats(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
517
517
|
},
|
|
518
518
|
/**
|
|
519
|
-
*
|
|
519
|
+
* Needs `settings.manage` and `gdpr.manage`, as the GDPR settings page in the portal does.
|
|
520
520
|
* @summary Update audit log retention settings
|
|
521
521
|
* @param {AdminAuditLogsApiPatchAdminAuditLogsRetentionUpdateRequest} requestParameters Request parameters.
|
|
522
522
|
* @param {*} [options] Override http request option.
|
|
@@ -526,7 +526,7 @@ export const AdminAuditLogsApiFactory = function (configuration, basePath, axios
|
|
|
526
526
|
return localVarFp.patchAdminAuditLogsRetentionUpdate(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
527
527
|
},
|
|
528
528
|
/**
|
|
529
|
-
*
|
|
529
|
+
* Needs `settings.manage` and `gdpr.manage`, as the GDPR settings page in the portal does.
|
|
530
530
|
* @summary Update audit log retention settings
|
|
531
531
|
* @param {AdminAuditLogsApiPutAdminAuditLogsRetentionUpdateRequest} requestParameters Request parameters.
|
|
532
532
|
* @param {*} [options] Override http request option.
|
|
@@ -556,7 +556,7 @@ export class AdminAuditLogsApi extends BaseAPI {
|
|
|
556
556
|
return AdminAuditLogsApiFp(this.configuration).adminAuditLogsActions(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
|
|
557
557
|
}
|
|
558
558
|
/**
|
|
559
|
-
*
|
|
559
|
+
* Needs `audit.export` and `audit.view`, as the export on the portal\'s audit log page does.
|
|
560
560
|
* @summary Export audit logs as CSV (default) or JSON
|
|
561
561
|
* @param {AdminAuditLogsApiAdminAuditLogsExportRequest} requestParameters Request parameters.
|
|
562
562
|
* @param {*} [options] Override http request option.
|
|
@@ -611,7 +611,7 @@ export class AdminAuditLogsApi extends BaseAPI {
|
|
|
611
611
|
return AdminAuditLogsApiFp(this.configuration).adminAuditLogsStats(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
|
|
612
612
|
}
|
|
613
613
|
/**
|
|
614
|
-
*
|
|
614
|
+
* Needs `settings.manage` and `gdpr.manage`, as the GDPR settings page in the portal does.
|
|
615
615
|
* @summary Update audit log retention settings
|
|
616
616
|
* @param {AdminAuditLogsApiPatchAdminAuditLogsRetentionUpdateRequest} requestParameters Request parameters.
|
|
617
617
|
* @param {*} [options] Override http request option.
|
|
@@ -622,7 +622,7 @@ export class AdminAuditLogsApi extends BaseAPI {
|
|
|
622
622
|
return AdminAuditLogsApiFp(this.configuration).patchAdminAuditLogsRetentionUpdate(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
|
|
623
623
|
}
|
|
624
624
|
/**
|
|
625
|
-
*
|
|
625
|
+
* Needs `settings.manage` and `gdpr.manage`, as the GDPR settings page in the portal does.
|
|
626
626
|
* @summary Update audit log retention settings
|
|
627
627
|
* @param {AdminAuditLogsApiPutAdminAuditLogsRetentionUpdateRequest} requestParameters Request parameters.
|
|
628
628
|
* @param {*} [options] Override http request option.
|
|
@@ -34,7 +34,7 @@ export declare const AdminEmailApiAxiosParamCreator: (configuration?: Configurat
|
|
|
34
34
|
*/
|
|
35
35
|
adminEmailTemplatesDelete: (orgId: string, type: string, locale?: string, clientId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
36
36
|
/**
|
|
37
|
-
*
|
|
37
|
+
* Needs `settings.manage` and `users.delete`, as the email template pages in the portal do.
|
|
38
38
|
* @summary Get an email template (custom or built-in default)
|
|
39
39
|
* @param {string} orgId
|
|
40
40
|
* @param {string} type
|
|
@@ -45,7 +45,7 @@ export declare const AdminEmailApiAxiosParamCreator: (configuration?: Configurat
|
|
|
45
45
|
*/
|
|
46
46
|
adminEmailTemplatesGet: (orgId: string, type: string, locale?: string, clientId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
47
47
|
/**
|
|
48
|
-
*
|
|
48
|
+
* Needs `settings.manage` and `users.delete`, as the email template pages in the portal do.
|
|
49
49
|
* @summary List every email template type with its current (custom or built-in) template
|
|
50
50
|
* @param {string} orgId
|
|
51
51
|
* @param {*} [options] Override http request option.
|
|
@@ -71,7 +71,7 @@ export declare const AdminEmailApiAxiosParamCreator: (configuration?: Configurat
|
|
|
71
71
|
*/
|
|
72
72
|
adminEmailTemplatesUpsert: (orgId: string, type: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
73
73
|
/**
|
|
74
|
-
*
|
|
74
|
+
* Needs `settings.manage` and `users.delete`, as the email template pages in the portal do.
|
|
75
75
|
* @summary List the placeholders available to an email template type
|
|
76
76
|
* @param {string} orgId
|
|
77
77
|
* @param {string} type
|
|
@@ -97,7 +97,7 @@ export declare const AdminEmailApiFp: (configuration?: Configuration) => {
|
|
|
97
97
|
*/
|
|
98
98
|
adminEmailTemplatesDelete(orgId: string, type: string, locale?: string, clientId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageResponse>>;
|
|
99
99
|
/**
|
|
100
|
-
*
|
|
100
|
+
* Needs `settings.manage` and `users.delete`, as the email template pages in the portal do.
|
|
101
101
|
* @summary Get an email template (custom or built-in default)
|
|
102
102
|
* @param {string} orgId
|
|
103
103
|
* @param {string} type
|
|
@@ -108,7 +108,7 @@ export declare const AdminEmailApiFp: (configuration?: Configuration) => {
|
|
|
108
108
|
*/
|
|
109
109
|
adminEmailTemplatesGet(orgId: string, type: string, locale?: string, clientId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmailTemplate>>;
|
|
110
110
|
/**
|
|
111
|
-
*
|
|
111
|
+
* Needs `settings.manage` and `users.delete`, as the email template pages in the portal do.
|
|
112
112
|
* @summary List every email template type with its current (custom or built-in) template
|
|
113
113
|
* @param {string} orgId
|
|
114
114
|
* @param {*} [options] Override http request option.
|
|
@@ -134,7 +134,7 @@ export declare const AdminEmailApiFp: (configuration?: Configuration) => {
|
|
|
134
134
|
*/
|
|
135
135
|
adminEmailTemplatesUpsert(orgId: string, type: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmailTemplate>>;
|
|
136
136
|
/**
|
|
137
|
-
*
|
|
137
|
+
* Needs `settings.manage` and `users.delete`, as the email template pages in the portal do.
|
|
138
138
|
* @summary List the placeholders available to an email template type
|
|
139
139
|
* @param {string} orgId
|
|
140
140
|
* @param {string} type
|
|
@@ -157,7 +157,7 @@ export declare const AdminEmailApiFactory: (configuration?: Configuration, baseP
|
|
|
157
157
|
*/
|
|
158
158
|
adminEmailTemplatesDelete(requestParameters: AdminEmailApiAdminEmailTemplatesDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponse>;
|
|
159
159
|
/**
|
|
160
|
-
*
|
|
160
|
+
* Needs `settings.manage` and `users.delete`, as the email template pages in the portal do.
|
|
161
161
|
* @summary Get an email template (custom or built-in default)
|
|
162
162
|
* @param {AdminEmailApiAdminEmailTemplatesGetRequest} requestParameters Request parameters.
|
|
163
163
|
* @param {*} [options] Override http request option.
|
|
@@ -165,7 +165,7 @@ export declare const AdminEmailApiFactory: (configuration?: Configuration, baseP
|
|
|
165
165
|
*/
|
|
166
166
|
adminEmailTemplatesGet(requestParameters: AdminEmailApiAdminEmailTemplatesGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<EmailTemplate>;
|
|
167
167
|
/**
|
|
168
|
-
*
|
|
168
|
+
* Needs `settings.manage` and `users.delete`, as the email template pages in the portal do.
|
|
169
169
|
* @summary List every email template type with its current (custom or built-in) template
|
|
170
170
|
* @param {AdminEmailApiAdminEmailTemplatesListRequest} requestParameters Request parameters.
|
|
171
171
|
* @param {*} [options] Override http request option.
|
|
@@ -189,7 +189,7 @@ export declare const AdminEmailApiFactory: (configuration?: Configuration, baseP
|
|
|
189
189
|
*/
|
|
190
190
|
adminEmailTemplatesUpsert(requestParameters: AdminEmailApiAdminEmailTemplatesUpsertRequest, options?: RawAxiosRequestConfig): AxiosPromise<EmailTemplate>;
|
|
191
191
|
/**
|
|
192
|
-
*
|
|
192
|
+
* Needs `settings.manage` and `users.delete`, as the email template pages in the portal do.
|
|
193
193
|
* @summary List the placeholders available to an email template type
|
|
194
194
|
* @param {AdminEmailApiAdminEmailTemplatesVariablesRequest} requestParameters Request parameters.
|
|
195
195
|
* @param {*} [options] Override http request option.
|
|
@@ -213,7 +213,7 @@ export interface AdminEmailApiInterface {
|
|
|
213
213
|
*/
|
|
214
214
|
adminEmailTemplatesDelete(requestParameters: AdminEmailApiAdminEmailTemplatesDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponse>;
|
|
215
215
|
/**
|
|
216
|
-
*
|
|
216
|
+
* Needs `settings.manage` and `users.delete`, as the email template pages in the portal do.
|
|
217
217
|
* @summary Get an email template (custom or built-in default)
|
|
218
218
|
* @param {AdminEmailApiAdminEmailTemplatesGetRequest} requestParameters Request parameters.
|
|
219
219
|
* @param {*} [options] Override http request option.
|
|
@@ -222,7 +222,7 @@ export interface AdminEmailApiInterface {
|
|
|
222
222
|
*/
|
|
223
223
|
adminEmailTemplatesGet(requestParameters: AdminEmailApiAdminEmailTemplatesGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<EmailTemplate>;
|
|
224
224
|
/**
|
|
225
|
-
*
|
|
225
|
+
* Needs `settings.manage` and `users.delete`, as the email template pages in the portal do.
|
|
226
226
|
* @summary List every email template type with its current (custom or built-in) template
|
|
227
227
|
* @param {AdminEmailApiAdminEmailTemplatesListRequest} requestParameters Request parameters.
|
|
228
228
|
* @param {*} [options] Override http request option.
|
|
@@ -249,7 +249,7 @@ export interface AdminEmailApiInterface {
|
|
|
249
249
|
*/
|
|
250
250
|
adminEmailTemplatesUpsert(requestParameters: AdminEmailApiAdminEmailTemplatesUpsertRequest, options?: RawAxiosRequestConfig): AxiosPromise<EmailTemplate>;
|
|
251
251
|
/**
|
|
252
|
-
*
|
|
252
|
+
* Needs `settings.manage` and `users.delete`, as the email template pages in the portal do.
|
|
253
253
|
* @summary List the placeholders available to an email template type
|
|
254
254
|
* @param {AdminEmailApiAdminEmailTemplatesVariablesRequest} requestParameters Request parameters.
|
|
255
255
|
* @param {*} [options] Override http request option.
|
|
@@ -407,7 +407,7 @@ export declare class AdminEmailApi extends BaseAPI implements AdminEmailApiInter
|
|
|
407
407
|
*/
|
|
408
408
|
adminEmailTemplatesDelete(requestParameters: AdminEmailApiAdminEmailTemplatesDeleteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponse, any, {}>>;
|
|
409
409
|
/**
|
|
410
|
-
*
|
|
410
|
+
* Needs `settings.manage` and `users.delete`, as the email template pages in the portal do.
|
|
411
411
|
* @summary Get an email template (custom or built-in default)
|
|
412
412
|
* @param {AdminEmailApiAdminEmailTemplatesGetRequest} requestParameters Request parameters.
|
|
413
413
|
* @param {*} [options] Override http request option.
|
|
@@ -416,7 +416,7 @@ export declare class AdminEmailApi extends BaseAPI implements AdminEmailApiInter
|
|
|
416
416
|
*/
|
|
417
417
|
adminEmailTemplatesGet(requestParameters: AdminEmailApiAdminEmailTemplatesGetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EmailTemplate, any, {}>>;
|
|
418
418
|
/**
|
|
419
|
-
*
|
|
419
|
+
* Needs `settings.manage` and `users.delete`, as the email template pages in the portal do.
|
|
420
420
|
* @summary List every email template type with its current (custom or built-in) template
|
|
421
421
|
* @param {AdminEmailApiAdminEmailTemplatesListRequest} requestParameters Request parameters.
|
|
422
422
|
* @param {*} [options] Override http request option.
|
|
@@ -443,7 +443,7 @@ export declare class AdminEmailApi extends BaseAPI implements AdminEmailApiInter
|
|
|
443
443
|
*/
|
|
444
444
|
adminEmailTemplatesUpsert(requestParameters: AdminEmailApiAdminEmailTemplatesUpsertRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EmailTemplate, any, {}>>;
|
|
445
445
|
/**
|
|
446
|
-
*
|
|
446
|
+
* Needs `settings.manage` and `users.delete`, as the email template pages in the portal do.
|
|
447
447
|
* @summary List the placeholders available to an email template type
|
|
448
448
|
* @param {AdminEmailApiAdminEmailTemplatesVariablesRequest} requestParameters Request parameters.
|
|
449
449
|
* @param {*} [options] Override http request option.
|
|
@@ -79,7 +79,7 @@ export const AdminEmailApiAxiosParamCreator = function (configuration) {
|
|
|
79
79
|
};
|
|
80
80
|
}),
|
|
81
81
|
/**
|
|
82
|
-
*
|
|
82
|
+
* Needs `settings.manage` and `users.delete`, as the email template pages in the portal do.
|
|
83
83
|
* @summary Get an email template (custom or built-in default)
|
|
84
84
|
* @param {string} orgId
|
|
85
85
|
* @param {string} type
|
|
@@ -125,7 +125,7 @@ export const AdminEmailApiAxiosParamCreator = function (configuration) {
|
|
|
125
125
|
};
|
|
126
126
|
}),
|
|
127
127
|
/**
|
|
128
|
-
*
|
|
128
|
+
* Needs `settings.manage` and `users.delete`, as the email template pages in the portal do.
|
|
129
129
|
* @summary List every email template type with its current (custom or built-in) template
|
|
130
130
|
* @param {string} orgId
|
|
131
131
|
* @param {*} [options] Override http request option.
|
|
@@ -235,7 +235,7 @@ export const AdminEmailApiAxiosParamCreator = function (configuration) {
|
|
|
235
235
|
};
|
|
236
236
|
}),
|
|
237
237
|
/**
|
|
238
|
-
*
|
|
238
|
+
* Needs `settings.manage` and `users.delete`, as the email template pages in the portal do.
|
|
239
239
|
* @summary List the placeholders available to an email template type
|
|
240
240
|
* @param {string} orgId
|
|
241
241
|
* @param {string} type
|
|
@@ -301,7 +301,7 @@ export const AdminEmailApiFp = function (configuration) {
|
|
|
301
301
|
});
|
|
302
302
|
},
|
|
303
303
|
/**
|
|
304
|
-
*
|
|
304
|
+
* Needs `settings.manage` and `users.delete`, as the email template pages in the portal do.
|
|
305
305
|
* @summary Get an email template (custom or built-in default)
|
|
306
306
|
* @param {string} orgId
|
|
307
307
|
* @param {string} type
|
|
@@ -320,7 +320,7 @@ export const AdminEmailApiFp = function (configuration) {
|
|
|
320
320
|
});
|
|
321
321
|
},
|
|
322
322
|
/**
|
|
323
|
-
*
|
|
323
|
+
* Needs `settings.manage` and `users.delete`, as the email template pages in the portal do.
|
|
324
324
|
* @summary List every email template type with its current (custom or built-in) template
|
|
325
325
|
* @param {string} orgId
|
|
326
326
|
* @param {*} [options] Override http request option.
|
|
@@ -370,7 +370,7 @@ export const AdminEmailApiFp = function (configuration) {
|
|
|
370
370
|
});
|
|
371
371
|
},
|
|
372
372
|
/**
|
|
373
|
-
*
|
|
373
|
+
* Needs `settings.manage` and `users.delete`, as the email template pages in the portal do.
|
|
374
374
|
* @summary List the placeholders available to an email template type
|
|
375
375
|
* @param {string} orgId
|
|
376
376
|
* @param {string} type
|
|
@@ -406,7 +406,7 @@ export const AdminEmailApiFactory = function (configuration, basePath, axios) {
|
|
|
406
406
|
return localVarFp.adminEmailTemplatesDelete(requestParameters.orgId, requestParameters.type, requestParameters.locale, requestParameters.clientId, options).then((request) => request(axios, basePath));
|
|
407
407
|
},
|
|
408
408
|
/**
|
|
409
|
-
*
|
|
409
|
+
* Needs `settings.manage` and `users.delete`, as the email template pages in the portal do.
|
|
410
410
|
* @summary Get an email template (custom or built-in default)
|
|
411
411
|
* @param {AdminEmailApiAdminEmailTemplatesGetRequest} requestParameters Request parameters.
|
|
412
412
|
* @param {*} [options] Override http request option.
|
|
@@ -416,7 +416,7 @@ export const AdminEmailApiFactory = function (configuration, basePath, axios) {
|
|
|
416
416
|
return localVarFp.adminEmailTemplatesGet(requestParameters.orgId, requestParameters.type, requestParameters.locale, requestParameters.clientId, options).then((request) => request(axios, basePath));
|
|
417
417
|
},
|
|
418
418
|
/**
|
|
419
|
-
*
|
|
419
|
+
* Needs `settings.manage` and `users.delete`, as the email template pages in the portal do.
|
|
420
420
|
* @summary List every email template type with its current (custom or built-in) template
|
|
421
421
|
* @param {AdminEmailApiAdminEmailTemplatesListRequest} requestParameters Request parameters.
|
|
422
422
|
* @param {*} [options] Override http request option.
|
|
@@ -446,7 +446,7 @@ export const AdminEmailApiFactory = function (configuration, basePath, axios) {
|
|
|
446
446
|
return localVarFp.adminEmailTemplatesUpsert(requestParameters.orgId, requestParameters.type, options).then((request) => request(axios, basePath));
|
|
447
447
|
},
|
|
448
448
|
/**
|
|
449
|
-
*
|
|
449
|
+
* Needs `settings.manage` and `users.delete`, as the email template pages in the portal do.
|
|
450
450
|
* @summary List the placeholders available to an email template type
|
|
451
451
|
* @param {AdminEmailApiAdminEmailTemplatesVariablesRequest} requestParameters Request parameters.
|
|
452
452
|
* @param {*} [options] Override http request option.
|
|
@@ -476,7 +476,7 @@ export class AdminEmailApi extends BaseAPI {
|
|
|
476
476
|
return AdminEmailApiFp(this.configuration).adminEmailTemplatesDelete(requestParameters.orgId, requestParameters.type, requestParameters.locale, requestParameters.clientId, options).then((request) => request(this.axios, this.basePath));
|
|
477
477
|
}
|
|
478
478
|
/**
|
|
479
|
-
*
|
|
479
|
+
* Needs `settings.manage` and `users.delete`, as the email template pages in the portal do.
|
|
480
480
|
* @summary Get an email template (custom or built-in default)
|
|
481
481
|
* @param {AdminEmailApiAdminEmailTemplatesGetRequest} requestParameters Request parameters.
|
|
482
482
|
* @param {*} [options] Override http request option.
|
|
@@ -487,7 +487,7 @@ export class AdminEmailApi extends BaseAPI {
|
|
|
487
487
|
return AdminEmailApiFp(this.configuration).adminEmailTemplatesGet(requestParameters.orgId, requestParameters.type, requestParameters.locale, requestParameters.clientId, options).then((request) => request(this.axios, this.basePath));
|
|
488
488
|
}
|
|
489
489
|
/**
|
|
490
|
-
*
|
|
490
|
+
* Needs `settings.manage` and `users.delete`, as the email template pages in the portal do.
|
|
491
491
|
* @summary List every email template type with its current (custom or built-in) template
|
|
492
492
|
* @param {AdminEmailApiAdminEmailTemplatesListRequest} requestParameters Request parameters.
|
|
493
493
|
* @param {*} [options] Override http request option.
|
|
@@ -520,7 +520,7 @@ export class AdminEmailApi extends BaseAPI {
|
|
|
520
520
|
return AdminEmailApiFp(this.configuration).adminEmailTemplatesUpsert(requestParameters.orgId, requestParameters.type, options).then((request) => request(this.axios, this.basePath));
|
|
521
521
|
}
|
|
522
522
|
/**
|
|
523
|
-
*
|
|
523
|
+
* Needs `settings.manage` and `users.delete`, as the email template pages in the portal do.
|
|
524
524
|
* @summary List the placeholders available to an email template type
|
|
525
525
|
* @param {AdminEmailApiAdminEmailTemplatesVariablesRequest} requestParameters Request parameters.
|
|
526
526
|
* @param {*} [options] Override http request option.
|
|
@@ -33,7 +33,7 @@ export declare const AdminGroupsApiAxiosParamCreator: (configuration?: Configura
|
|
|
33
33
|
*/
|
|
34
34
|
adminGroupsAddMembers: (orgId: string, groupId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35
35
|
/**
|
|
36
|
-
*
|
|
36
|
+
* A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left).
|
|
37
37
|
* @summary Add a single role to a group
|
|
38
38
|
* @param {string} orgId
|
|
39
39
|
* @param {string} groupId
|
|
@@ -42,7 +42,7 @@ export declare const AdminGroupsApiAxiosParamCreator: (configuration?: Configura
|
|
|
42
42
|
*/
|
|
43
43
|
adminGroupsAddRole: (orgId: string, groupId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
44
44
|
/**
|
|
45
|
-
*
|
|
45
|
+
* Optional `roles` is a list of role slugs. An unknown slug is 400. A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left).
|
|
46
46
|
* @summary Create a new group
|
|
47
47
|
* @param {string} orgId
|
|
48
48
|
* @param {*} [options] Override http request option.
|
|
@@ -114,7 +114,7 @@ export declare const AdminGroupsApiAxiosParamCreator: (configuration?: Configura
|
|
|
114
114
|
*/
|
|
115
115
|
adminGroupsRemoveRole: (orgId: string, groupId: string, roleId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
116
116
|
/**
|
|
117
|
-
*
|
|
117
|
+
* `roles` is the full list of role slugs. An unknown slug is 400. A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left). Roles already on the group that the caller could not grant stay on it whatever the list says.
|
|
118
118
|
* @summary Update group roles (replaces all existing roles)
|
|
119
119
|
* @param {string} orgId
|
|
120
120
|
* @param {string} groupId
|
|
@@ -156,7 +156,7 @@ export declare const AdminGroupsApiFp: (configuration?: Configuration) => {
|
|
|
156
156
|
*/
|
|
157
157
|
adminGroupsAddMembers(orgId: string, groupId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminGroupsCreateResponse>>;
|
|
158
158
|
/**
|
|
159
|
-
*
|
|
159
|
+
* A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left).
|
|
160
160
|
* @summary Add a single role to a group
|
|
161
161
|
* @param {string} orgId
|
|
162
162
|
* @param {string} groupId
|
|
@@ -165,7 +165,7 @@ export declare const AdminGroupsApiFp: (configuration?: Configuration) => {
|
|
|
165
165
|
*/
|
|
166
166
|
adminGroupsAddRole(orgId: string, groupId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageResponse>>;
|
|
167
167
|
/**
|
|
168
|
-
*
|
|
168
|
+
* Optional `roles` is a list of role slugs. An unknown slug is 400. A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left).
|
|
169
169
|
* @summary Create a new group
|
|
170
170
|
* @param {string} orgId
|
|
171
171
|
* @param {*} [options] Override http request option.
|
|
@@ -237,7 +237,7 @@ export declare const AdminGroupsApiFp: (configuration?: Configuration) => {
|
|
|
237
237
|
*/
|
|
238
238
|
adminGroupsRemoveRole(orgId: string, groupId: string, roleId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageResponse>>;
|
|
239
239
|
/**
|
|
240
|
-
*
|
|
240
|
+
* `roles` is the full list of role slugs. An unknown slug is 400. A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left). Roles already on the group that the caller could not grant stay on it whatever the list says.
|
|
241
241
|
* @summary Update group roles (replaces all existing roles)
|
|
242
242
|
* @param {string} orgId
|
|
243
243
|
* @param {string} groupId
|
|
@@ -278,7 +278,7 @@ export declare const AdminGroupsApiFactory: (configuration?: Configuration, base
|
|
|
278
278
|
*/
|
|
279
279
|
adminGroupsAddMembers(requestParameters: AdminGroupsApiAdminGroupsAddMembersRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminGroupsCreateResponse>;
|
|
280
280
|
/**
|
|
281
|
-
*
|
|
281
|
+
* A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left).
|
|
282
282
|
* @summary Add a single role to a group
|
|
283
283
|
* @param {AdminGroupsApiAdminGroupsAddRoleRequest} requestParameters Request parameters.
|
|
284
284
|
* @param {*} [options] Override http request option.
|
|
@@ -286,7 +286,7 @@ export declare const AdminGroupsApiFactory: (configuration?: Configuration, base
|
|
|
286
286
|
*/
|
|
287
287
|
adminGroupsAddRole(requestParameters: AdminGroupsApiAdminGroupsAddRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponse>;
|
|
288
288
|
/**
|
|
289
|
-
*
|
|
289
|
+
* Optional `roles` is a list of role slugs. An unknown slug is 400. A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left).
|
|
290
290
|
* @summary Create a new group
|
|
291
291
|
* @param {AdminGroupsApiAdminGroupsCreateRequest} requestParameters Request parameters.
|
|
292
292
|
* @param {*} [options] Override http request option.
|
|
@@ -350,7 +350,7 @@ export declare const AdminGroupsApiFactory: (configuration?: Configuration, base
|
|
|
350
350
|
*/
|
|
351
351
|
adminGroupsRemoveRole(requestParameters: AdminGroupsApiAdminGroupsRemoveRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponse>;
|
|
352
352
|
/**
|
|
353
|
-
*
|
|
353
|
+
* `roles` is the full list of role slugs. An unknown slug is 400. A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left). Roles already on the group that the caller could not grant stay on it whatever the list says.
|
|
354
354
|
* @summary Update group roles (replaces all existing roles)
|
|
355
355
|
* @param {AdminGroupsApiAdminGroupsUpdateRolesRequest} requestParameters Request parameters.
|
|
356
356
|
* @param {*} [options] Override http request option.
|
|
@@ -390,7 +390,7 @@ export interface AdminGroupsApiInterface {
|
|
|
390
390
|
*/
|
|
391
391
|
adminGroupsAddMembers(requestParameters: AdminGroupsApiAdminGroupsAddMembersRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminGroupsCreateResponse>;
|
|
392
392
|
/**
|
|
393
|
-
*
|
|
393
|
+
* A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left).
|
|
394
394
|
* @summary Add a single role to a group
|
|
395
395
|
* @param {AdminGroupsApiAdminGroupsAddRoleRequest} requestParameters Request parameters.
|
|
396
396
|
* @param {*} [options] Override http request option.
|
|
@@ -399,7 +399,7 @@ export interface AdminGroupsApiInterface {
|
|
|
399
399
|
*/
|
|
400
400
|
adminGroupsAddRole(requestParameters: AdminGroupsApiAdminGroupsAddRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponse>;
|
|
401
401
|
/**
|
|
402
|
-
*
|
|
402
|
+
* Optional `roles` is a list of role slugs. An unknown slug is 400. A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left).
|
|
403
403
|
* @summary Create a new group
|
|
404
404
|
* @param {AdminGroupsApiAdminGroupsCreateRequest} requestParameters Request parameters.
|
|
405
405
|
* @param {*} [options] Override http request option.
|
|
@@ -471,7 +471,7 @@ export interface AdminGroupsApiInterface {
|
|
|
471
471
|
*/
|
|
472
472
|
adminGroupsRemoveRole(requestParameters: AdminGroupsApiAdminGroupsRemoveRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponse>;
|
|
473
473
|
/**
|
|
474
|
-
*
|
|
474
|
+
* `roles` is the full list of role slugs. An unknown slug is 400. A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left). Roles already on the group that the caller could not grant stay on it whatever the list says.
|
|
475
475
|
* @summary Update group roles (replaces all existing roles)
|
|
476
476
|
* @param {AdminGroupsApiAdminGroupsUpdateRolesRequest} requestParameters Request parameters.
|
|
477
477
|
* @param {*} [options] Override http request option.
|
|
@@ -762,7 +762,7 @@ export declare class AdminGroupsApi extends BaseAPI implements AdminGroupsApiInt
|
|
|
762
762
|
*/
|
|
763
763
|
adminGroupsAddMembers(requestParameters: AdminGroupsApiAdminGroupsAddMembersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminGroupsCreateResponse, any, {}>>;
|
|
764
764
|
/**
|
|
765
|
-
*
|
|
765
|
+
* A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left).
|
|
766
766
|
* @summary Add a single role to a group
|
|
767
767
|
* @param {AdminGroupsApiAdminGroupsAddRoleRequest} requestParameters Request parameters.
|
|
768
768
|
* @param {*} [options] Override http request option.
|
|
@@ -771,7 +771,7 @@ export declare class AdminGroupsApi extends BaseAPI implements AdminGroupsApiInt
|
|
|
771
771
|
*/
|
|
772
772
|
adminGroupsAddRole(requestParameters: AdminGroupsApiAdminGroupsAddRoleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponse, any, {}>>;
|
|
773
773
|
/**
|
|
774
|
-
*
|
|
774
|
+
* Optional `roles` is a list of role slugs. An unknown slug is 400. A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left).
|
|
775
775
|
* @summary Create a new group
|
|
776
776
|
* @param {AdminGroupsApiAdminGroupsCreateRequest} requestParameters Request parameters.
|
|
777
777
|
* @param {*} [options] Override http request option.
|
|
@@ -843,7 +843,7 @@ export declare class AdminGroupsApi extends BaseAPI implements AdminGroupsApiInt
|
|
|
843
843
|
*/
|
|
844
844
|
adminGroupsRemoveRole(requestParameters: AdminGroupsApiAdminGroupsRemoveRoleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponse, any, {}>>;
|
|
845
845
|
/**
|
|
846
|
-
*
|
|
846
|
+
* `roles` is the full list of role slugs. An unknown slug is 400. A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left). Roles already on the group that the caller could not grant stay on it whatever the list says.
|
|
847
847
|
* @summary Update group roles (replaces all existing roles)
|
|
848
848
|
* @param {AdminGroupsApiAdminGroupsUpdateRolesRequest} requestParameters Request parameters.
|
|
849
849
|
* @param {*} [options] Override http request option.
|