@emilgroup/tenant-sdk-node 1.34.1-beta.21 → 1.34.1-beta.22

package/dist/api/user-group-api.d.ts

@@ -0,0 +1,603 @@
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+import { RequestArgs, BaseAPI } from '../base';
+import { AddUsersToGroupRequestDto } from '../models';
+import { AddUsersToGroupResponseClass } from '../models';
+import { CreateUserGroupRequestDto } from '../models';
+import { CreateUserGroupResponseClass } from '../models';
+import { DeleteResponseClass } from '../models';
+import { GetUserGroupResponseClass } from '../models';
+import { ListUserGroupMembersResponseClass } from '../models';
+import { ListUserGroupsResponseClass } from '../models';
+import { RemoveUsersFromGroupRequestDto } from '../models';
+import { UpdateUserGroupRequestDto } from '../models';
+import { UpdateUserGroupResponseClass } from '../models';
+/**
+ * UserGroupApi - axios parameter creator
+ * @export
+ */
+export declare const UserGroupApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * undefined  **Required Permissions**  \"identity-management.user-groups.update\"
+     * @param {string} code
+     * @param {AddUsersToGroupRequestDto} addUsersToGroupRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addUsersToGroup: (code: string, addUsersToGroupRequestDto: AddUsersToGroupRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * undefined  **Required Permissions**  \"identity-management.user-groups.create\"
+     * @param {CreateUserGroupRequestDto} createUserGroupRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createUserGroup: (createUserGroupRequestDto: CreateUserGroupRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * undefined  **Required Permissions**  \"identity-management.user-groups.delete\"
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteUserGroup: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * undefined  **Required Permissions**  \"identity-management.user-groups.view\"
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUserGroup: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * undefined  **Required Permissions**  \"identity-management.user-groups.view\"
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {number} [pageSize] Number of items per page.
+     * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
+     * @param {string} [filter] Filter members by one or more fields (in addition to the parent group). Allowed fields are declared in user-group-membership.config.
+     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {string} [order] Sort the response by allowed columns (see paginate config).
+     * @param {string} [expand] Comma-separated list of related objects to embed in each member (e.g. user details).
+     * @param {string} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listUserGroupMembers: (code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * undefined  **Required Permissions**  \"identity-management.user-groups.view\"
+     * @param {string} [authorization] Bearer Token
+     * @param {number} [pageSize] Number of items per page.
+     * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
+     * @param {string} [filter] Filter user groups by one or more fields. Allowed: id, name, slug, createdAt, updatedAt.
+     * @param {string} [search] Free-text search over searchable columns.
+     * @param {string} [order] Sort the response. Allowed columns: id, name, slug, createdAt, updatedAt.
+     * @param {string} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+     * @param {string} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listUserGroups: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * undefined  **Required Permissions**  \"identity-management.user-groups.update\"
+     * @param {string} code
+     * @param {RemoveUsersFromGroupRequestDto} removeUsersFromGroupRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeUsersFromGroup: (code: string, removeUsersFromGroupRequestDto: RemoveUsersFromGroupRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * undefined  **Required Permissions**  \"identity-management.user-groups.update\"
+     * @param {string} code
+     * @param {UpdateUserGroupRequestDto} updateUserGroupRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateUserGroup: (code: string, updateUserGroupRequestDto: UpdateUserGroupRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * UserGroupApi - functional programming interface
+ * @export
+ */
+export declare const UserGroupApiFp: (configuration?: Configuration) => {
+    /**
+     * undefined  **Required Permissions**  \"identity-management.user-groups.update\"
+     * @param {string} code
+     * @param {AddUsersToGroupRequestDto} addUsersToGroupRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addUsersToGroup(code: string, addUsersToGroupRequestDto: AddUsersToGroupRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddUsersToGroupResponseClass>>;
+    /**
+     * undefined  **Required Permissions**  \"identity-management.user-groups.create\"
+     * @param {CreateUserGroupRequestDto} createUserGroupRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createUserGroup(createUserGroupRequestDto: CreateUserGroupRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateUserGroupResponseClass>>;
+    /**
+     * undefined  **Required Permissions**  \"identity-management.user-groups.delete\"
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteUserGroup(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
+    /**
+     * undefined  **Required Permissions**  \"identity-management.user-groups.view\"
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUserGroup(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetUserGroupResponseClass>>;
+    /**
+     * undefined  **Required Permissions**  \"identity-management.user-groups.view\"
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {number} [pageSize] Number of items per page.
+     * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
+     * @param {string} [filter] Filter members by one or more fields (in addition to the parent group). Allowed fields are declared in user-group-membership.config.
+     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {string} [order] Sort the response by allowed columns (see paginate config).
+     * @param {string} [expand] Comma-separated list of related objects to embed in each member (e.g. user details).
+     * @param {string} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listUserGroupMembers(code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListUserGroupMembersResponseClass>>;
+    /**
+     * undefined  **Required Permissions**  \"identity-management.user-groups.view\"
+     * @param {string} [authorization] Bearer Token
+     * @param {number} [pageSize] Number of items per page.
+     * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
+     * @param {string} [filter] Filter user groups by one or more fields. Allowed: id, name, slug, createdAt, updatedAt.
+     * @param {string} [search] Free-text search over searchable columns.
+     * @param {string} [order] Sort the response. Allowed columns: id, name, slug, createdAt, updatedAt.
+     * @param {string} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+     * @param {string} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listUserGroups(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListUserGroupsResponseClass>>;
+    /**
+     * undefined  **Required Permissions**  \"identity-management.user-groups.update\"
+     * @param {string} code
+     * @param {RemoveUsersFromGroupRequestDto} removeUsersFromGroupRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeUsersFromGroup(code: string, removeUsersFromGroupRequestDto: RemoveUsersFromGroupRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
+    /**
+     * undefined  **Required Permissions**  \"identity-management.user-groups.update\"
+     * @param {string} code
+     * @param {UpdateUserGroupRequestDto} updateUserGroupRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateUserGroup(code: string, updateUserGroupRequestDto: UpdateUserGroupRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateUserGroupResponseClass>>;
+};
+/**
+ * UserGroupApi - factory interface
+ * @export
+ */
+export declare const UserGroupApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * undefined  **Required Permissions**  \"identity-management.user-groups.update\"
+     * @param {string} code
+     * @param {AddUsersToGroupRequestDto} addUsersToGroupRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addUsersToGroup(code: string, addUsersToGroupRequestDto: AddUsersToGroupRequestDto, authorization?: string, options?: any): AxiosPromise<AddUsersToGroupResponseClass>;
+    /**
+     * undefined  **Required Permissions**  \"identity-management.user-groups.create\"
+     * @param {CreateUserGroupRequestDto} createUserGroupRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createUserGroup(createUserGroupRequestDto: CreateUserGroupRequestDto, authorization?: string, options?: any): AxiosPromise<CreateUserGroupResponseClass>;
+    /**
+     * undefined  **Required Permissions**  \"identity-management.user-groups.delete\"
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteUserGroup(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
+    /**
+     * undefined  **Required Permissions**  \"identity-management.user-groups.view\"
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUserGroup(code: string, authorization?: string, options?: any): AxiosPromise<GetUserGroupResponseClass>;
+    /**
+     * undefined  **Required Permissions**  \"identity-management.user-groups.view\"
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {number} [pageSize] Number of items per page.
+     * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
+     * @param {string} [filter] Filter members by one or more fields (in addition to the parent group). Allowed fields are declared in user-group-membership.config.
+     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {string} [order] Sort the response by allowed columns (see paginate config).
+     * @param {string} [expand] Comma-separated list of related objects to embed in each member (e.g. user details).
+     * @param {string} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listUserGroupMembers(code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListUserGroupMembersResponseClass>;
+    /**
+     * undefined  **Required Permissions**  \"identity-management.user-groups.view\"
+     * @param {string} [authorization] Bearer Token
+     * @param {number} [pageSize] Number of items per page.
+     * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
+     * @param {string} [filter] Filter user groups by one or more fields. Allowed: id, name, slug, createdAt, updatedAt.
+     * @param {string} [search] Free-text search over searchable columns.
+     * @param {string} [order] Sort the response. Allowed columns: id, name, slug, createdAt, updatedAt.
+     * @param {string} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+     * @param {string} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listUserGroups(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListUserGroupsResponseClass>;
+    /**
+     * undefined  **Required Permissions**  \"identity-management.user-groups.update\"
+     * @param {string} code
+     * @param {RemoveUsersFromGroupRequestDto} removeUsersFromGroupRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeUsersFromGroup(code: string, removeUsersFromGroupRequestDto: RemoveUsersFromGroupRequestDto, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
+    /**
+     * undefined  **Required Permissions**  \"identity-management.user-groups.update\"
+     * @param {string} code
+     * @param {UpdateUserGroupRequestDto} updateUserGroupRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateUserGroup(code: string, updateUserGroupRequestDto: UpdateUserGroupRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateUserGroupResponseClass>;
+};
+/**
+ * Request parameters for addUsersToGroup operation in UserGroupApi.
+ * @export
+ * @interface UserGroupApiAddUsersToGroupRequest
+ */
+export interface UserGroupApiAddUsersToGroupRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof UserGroupApiAddUsersToGroup
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {AddUsersToGroupRequestDto}
+     * @memberof UserGroupApiAddUsersToGroup
+     */
+    readonly addUsersToGroupRequestDto: AddUsersToGroupRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof UserGroupApiAddUsersToGroup
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for createUserGroup operation in UserGroupApi.
+ * @export
+ * @interface UserGroupApiCreateUserGroupRequest
+ */
+export interface UserGroupApiCreateUserGroupRequest {
+    /**
+     *
+     * @type {CreateUserGroupRequestDto}
+     * @memberof UserGroupApiCreateUserGroup
+     */
+    readonly createUserGroupRequestDto: CreateUserGroupRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof UserGroupApiCreateUserGroup
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteUserGroup operation in UserGroupApi.
+ * @export
+ * @interface UserGroupApiDeleteUserGroupRequest
+ */
+export interface UserGroupApiDeleteUserGroupRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof UserGroupApiDeleteUserGroup
+     */
+    readonly code: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof UserGroupApiDeleteUserGroup
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getUserGroup operation in UserGroupApi.
+ * @export
+ * @interface UserGroupApiGetUserGroupRequest
+ */
+export interface UserGroupApiGetUserGroupRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof UserGroupApiGetUserGroup
+     */
+    readonly code: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof UserGroupApiGetUserGroup
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listUserGroupMembers operation in UserGroupApi.
+ * @export
+ * @interface UserGroupApiListUserGroupMembersRequest
+ */
+export interface UserGroupApiListUserGroupMembersRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof UserGroupApiListUserGroupMembers
+     */
+    readonly code: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof UserGroupApiListUserGroupMembers
+     */
+    readonly authorization?: string;
+    /**
+     * Number of items per page.
+     * @type {number}
+     * @memberof UserGroupApiListUserGroupMembers
+     */
+    readonly pageSize?: number;
+    /**
+     * Opaque token for the next page (returned in a previous response).
+     * @type {string}
+     * @memberof UserGroupApiListUserGroupMembers
+     */
+    readonly pageToken?: string;
+    /**
+     * Filter members by one or more fields (in addition to the parent group). Allowed fields are declared in user-group-membership.config.
+     * @type {string}
+     * @memberof UserGroupApiListUserGroupMembers
+     */
+    readonly filter?: string;
+    /**
+     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @type {string}
+     * @memberof UserGroupApiListUserGroupMembers
+     */
+    readonly search?: string;
+    /**
+     * Sort the response by allowed columns (see paginate config).
+     * @type {string}
+     * @memberof UserGroupApiListUserGroupMembers
+     */
+    readonly order?: string;
+    /**
+     * Comma-separated list of related objects to embed in each member (e.g. user details).
+     * @type {string}
+     * @memberof UserGroupApiListUserGroupMembers
+     */
+    readonly expand?: string;
+    /**
+     * Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @type {string}
+     * @memberof UserGroupApiListUserGroupMembers
+     */
+    readonly filters?: string;
+}
+/**
+ * Request parameters for listUserGroups operation in UserGroupApi.
+ * @export
+ * @interface UserGroupApiListUserGroupsRequest
+ */
+export interface UserGroupApiListUserGroupsRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof UserGroupApiListUserGroups
+     */
+    readonly authorization?: string;
+    /**
+     * Number of items per page.
+     * @type {number}
+     * @memberof UserGroupApiListUserGroups
+     */
+    readonly pageSize?: number;
+    /**
+     * Opaque token for the next page (returned in a previous response).
+     * @type {string}
+     * @memberof UserGroupApiListUserGroups
+     */
+    readonly pageToken?: string;
+    /**
+     * Filter user groups by one or more fields. Allowed: id, name, slug, createdAt, updatedAt.
+     * @type {string}
+     * @memberof UserGroupApiListUserGroups
+     */
+    readonly filter?: string;
+    /**
+     * Free-text search over searchable columns.
+     * @type {string}
+     * @memberof UserGroupApiListUserGroups
+     */
+    readonly search?: string;
+    /**
+     * Sort the response. Allowed columns: id, name, slug, createdAt, updatedAt.
+     * @type {string}
+     * @memberof UserGroupApiListUserGroups
+     */
+    readonly order?: string;
+    /**
+     * Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+     * @type {string}
+     * @memberof UserGroupApiListUserGroups
+     */
+    readonly expand?: string;
+    /**
+     * Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @type {string}
+     * @memberof UserGroupApiListUserGroups
+     */
+    readonly filters?: string;
+}
+/**
+ * Request parameters for removeUsersFromGroup operation in UserGroupApi.
+ * @export
+ * @interface UserGroupApiRemoveUsersFromGroupRequest
+ */
+export interface UserGroupApiRemoveUsersFromGroupRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof UserGroupApiRemoveUsersFromGroup
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {RemoveUsersFromGroupRequestDto}
+     * @memberof UserGroupApiRemoveUsersFromGroup
+     */
+    readonly removeUsersFromGroupRequestDto: RemoveUsersFromGroupRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof UserGroupApiRemoveUsersFromGroup
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for updateUserGroup operation in UserGroupApi.
+ * @export
+ * @interface UserGroupApiUpdateUserGroupRequest
+ */
+export interface UserGroupApiUpdateUserGroupRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof UserGroupApiUpdateUserGroup
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {UpdateUserGroupRequestDto}
+     * @memberof UserGroupApiUpdateUserGroup
+     */
+    readonly updateUserGroupRequestDto: UpdateUserGroupRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof UserGroupApiUpdateUserGroup
+     */
+    readonly authorization?: string;
+}
+/**
+ * UserGroupApi - object-oriented interface
+ * @export
+ * @class UserGroupApi
+ * @extends {BaseAPI}
+ */
+export declare class UserGroupApi extends BaseAPI {
+    /**
+     * undefined  **Required Permissions**  \"identity-management.user-groups.update\"
+     * @param {UserGroupApiAddUsersToGroupRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UserGroupApi
+     */
+    addUsersToGroup(requestParameters: UserGroupApiAddUsersToGroupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AddUsersToGroupResponseClass, any, {}>>;
+    /**
+     * undefined  **Required Permissions**  \"identity-management.user-groups.create\"
+     * @param {UserGroupApiCreateUserGroupRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UserGroupApi
+     */
+    createUserGroup(requestParameters: UserGroupApiCreateUserGroupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateUserGroupResponseClass, any, {}>>;
+    /**
+     * undefined  **Required Permissions**  \"identity-management.user-groups.delete\"
+     * @param {UserGroupApiDeleteUserGroupRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UserGroupApi
+     */
+    deleteUserGroup(requestParameters: UserGroupApiDeleteUserGroupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any, {}>>;
+    /**
+     * undefined  **Required Permissions**  \"identity-management.user-groups.view\"
+     * @param {UserGroupApiGetUserGroupRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UserGroupApi
+     */
+    getUserGroup(requestParameters: UserGroupApiGetUserGroupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserGroupResponseClass, any, {}>>;
+    /**
+     * undefined  **Required Permissions**  \"identity-management.user-groups.view\"
+     * @param {UserGroupApiListUserGroupMembersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UserGroupApi
+     */
+    listUserGroupMembers(requestParameters: UserGroupApiListUserGroupMembersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListUserGroupMembersResponseClass, any, {}>>;
+    /**
+     * undefined  **Required Permissions**  \"identity-management.user-groups.view\"
+     * @param {UserGroupApiListUserGroupsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UserGroupApi
+     */
+    listUserGroups(requestParameters?: UserGroupApiListUserGroupsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListUserGroupsResponseClass, any, {}>>;
+    /**
+     * undefined  **Required Permissions**  \"identity-management.user-groups.update\"
+     * @param {UserGroupApiRemoveUsersFromGroupRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UserGroupApi
+     */
+    removeUsersFromGroup(requestParameters: UserGroupApiRemoveUsersFromGroupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any, {}>>;
+    /**
+     * undefined  **Required Permissions**  \"identity-management.user-groups.update\"
+     * @param {UserGroupApiUpdateUserGroupRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UserGroupApi
+     */
+    updateUserGroup(requestParameters: UserGroupApiUpdateUserGroupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateUserGroupResponseClass, any, {}>>;
+}