/* tslint:disable */ /* eslint-disable */ /** * 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 globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; import { Configuration } from '../configuration'; // Some imports not used depending on template conditions // @ts-ignore import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common'; // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base'; // @ts-ignore import { AddUsersToGroupRequestDto } from '../models'; // @ts-ignore import { AddUsersToGroupResponseClass } from '../models'; // @ts-ignore import { CreateUserGroupRequestDto } from '../models'; // @ts-ignore import { CreateUserGroupResponseClass } from '../models'; // @ts-ignore import { DeleteResponseClass } from '../models'; // @ts-ignore import { GetUserGroupResponseClass } from '../models'; // @ts-ignore import { ListUserGroupMembersResponseClass } from '../models'; // @ts-ignore import { ListUserGroupsResponseClass } from '../models'; // @ts-ignore import { RemoveUsersFromGroupRequestDto } from '../models'; // @ts-ignore import { UpdateUserGroupRequestDto } from '../models'; // @ts-ignore import { UpdateUserGroupResponseClass } from '../models'; // URLSearchParams not necessarily used // @ts-ignore import { URL, URLSearchParams } from 'url'; const FormData = require('form-data'); /** * UserGroupApi - axios parameter creator * @export */ export const UserGroupApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * 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: async (code: string, addUsersToGroupRequestDto: AddUsersToGroupRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'code' is not null or undefined assertParamExists('addUsersToGroup', 'code', code) // verify required parameter 'addUsersToGroupRequestDto' is not null or undefined assertParamExists('addUsersToGroup', 'addUsersToGroupRequestDto', addUsersToGroupRequestDto) const localVarPath = `/tenantservice/v1/user-groups/{code}/members` .replace(`{${"code"}}`, encodeURIComponent(String(code))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; let baseAccessToken; if (configuration) { baseOptions = configuration.baseOptions; baseAccessToken = configuration.accessToken; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication bearer required // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) { localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken); } localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; localVarRequestOptions.data = serializeDataIfNeeded(addUsersToGroupRequestDto, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * 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: async (createUserGroupRequestDto: CreateUserGroupRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'createUserGroupRequestDto' is not null or undefined assertParamExists('createUserGroup', 'createUserGroupRequestDto', createUserGroupRequestDto) const localVarPath = `/tenantservice/v1/user-groups`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; let baseAccessToken; if (configuration) { baseOptions = configuration.baseOptions; baseAccessToken = configuration.accessToken; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication bearer required // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) { localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken); } localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; localVarRequestOptions.data = serializeDataIfNeeded(createUserGroupRequestDto, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * 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: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'code' is not null or undefined assertParamExists('deleteUserGroup', 'code', code) const localVarPath = `/tenantservice/v1/user-groups/{code}` .replace(`{${"code"}}`, encodeURIComponent(String(code))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; let baseAccessToken; if (configuration) { baseOptions = configuration.baseOptions; baseAccessToken = configuration.accessToken; } const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication bearer required // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) { localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * 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: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'code' is not null or undefined assertParamExists('getUserGroup', 'code', code) const localVarPath = `/tenantservice/v1/user-groups/{code}` .replace(`{${"code"}}`, encodeURIComponent(String(code))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; let baseAccessToken; if (configuration) { baseOptions = configuration.baseOptions; baseAccessToken = configuration.accessToken; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication bearer required // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) { localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * 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=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: async (code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'code' is not null or undefined assertParamExists('listUserGroupMembers', 'code', code) const localVarPath = `/tenantservice/v1/user-groups/{code}/members` .replace(`{${"code"}}`, encodeURIComponent(String(code))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; let baseAccessToken; if (configuration) { baseOptions = configuration.baseOptions; baseAccessToken = configuration.accessToken; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication bearer required // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) if (pageSize !== undefined) { localVarQueryParameter['pageSize'] = pageSize; } if (pageToken !== undefined) { localVarQueryParameter['pageToken'] = pageToken; } if (filter !== undefined) { localVarQueryParameter['filter'] = filter; } if (search !== undefined) { localVarQueryParameter['search'] = search; } if (order !== undefined) { localVarQueryParameter['order'] = order; } if (expand !== undefined) { localVarQueryParameter['expand'] = expand; } if (filters !== undefined) { localVarQueryParameter['filters'] = filters; } if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) { localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * 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: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/tenantservice/v1/user-groups`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; let baseAccessToken; if (configuration) { baseOptions = configuration.baseOptions; baseAccessToken = configuration.accessToken; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication bearer required // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) if (pageSize !== undefined) { localVarQueryParameter['pageSize'] = pageSize; } if (pageToken !== undefined) { localVarQueryParameter['pageToken'] = pageToken; } if (filter !== undefined) { localVarQueryParameter['filter'] = filter; } if (search !== undefined) { localVarQueryParameter['search'] = search; } if (order !== undefined) { localVarQueryParameter['order'] = order; } if (expand !== undefined) { localVarQueryParameter['expand'] = expand; } if (filters !== undefined) { localVarQueryParameter['filters'] = filters; } if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) { localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * 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: async (code: string, removeUsersFromGroupRequestDto: RemoveUsersFromGroupRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'code' is not null or undefined assertParamExists('removeUsersFromGroup', 'code', code) // verify required parameter 'removeUsersFromGroupRequestDto' is not null or undefined assertParamExists('removeUsersFromGroup', 'removeUsersFromGroupRequestDto', removeUsersFromGroupRequestDto) const localVarPath = `/tenantservice/v1/user-groups/{code}/members` .replace(`{${"code"}}`, encodeURIComponent(String(code))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; let baseAccessToken; if (configuration) { baseOptions = configuration.baseOptions; baseAccessToken = configuration.accessToken; } const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication bearer required // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) { localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken); } localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; localVarRequestOptions.data = serializeDataIfNeeded(removeUsersFromGroupRequestDto, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * 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: async (code: string, updateUserGroupRequestDto: UpdateUserGroupRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'code' is not null or undefined assertParamExists('updateUserGroup', 'code', code) // verify required parameter 'updateUserGroupRequestDto' is not null or undefined assertParamExists('updateUserGroup', 'updateUserGroupRequestDto', updateUserGroupRequestDto) const localVarPath = `/tenantservice/v1/user-groups/{code}` .replace(`{${"code"}}`, encodeURIComponent(String(code))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; let baseAccessToken; if (configuration) { baseOptions = configuration.baseOptions; baseAccessToken = configuration.accessToken; } const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication bearer required // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) { localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken); } localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; localVarRequestOptions.data = serializeDataIfNeeded(updateUserGroupRequestDto, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, } }; /** * UserGroupApi - functional programming interface * @export */ export const UserGroupApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = UserGroupApiAxiosParamCreator(configuration) return { /** * 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} */ async addUsersToGroup(code: string, addUsersToGroupRequestDto: AddUsersToGroupRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.addUsersToGroup(code, addUsersToGroupRequestDto, authorization, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * undefined **Required Permissions** \"identity-management.user-groups.create\" * @param {CreateUserGroupRequestDto} createUserGroupRequestDto * @param {string} [authorization] Bearer Token * @param {*} [options] Override http request option. * @throws {RequiredError} */ async createUserGroup(createUserGroupRequestDto: CreateUserGroupRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createUserGroup(createUserGroupRequestDto, authorization, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * undefined **Required Permissions** \"identity-management.user-groups.delete\" * @param {string} code * @param {string} [authorization] Bearer Token * @param {*} [options] Override http request option. * @throws {RequiredError} */ async deleteUserGroup(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteUserGroup(code, authorization, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * undefined **Required Permissions** \"identity-management.user-groups.view\" * @param {string} code * @param {string} [authorization] Bearer Token * @param {*} [options] Override http request option. * @throws {RequiredError} */ async getUserGroup(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getUserGroup(code, authorization, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * 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=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} */ async 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> { const localVarAxiosArgs = await localVarAxiosParamCreator.listUserGroupMembers(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * 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} */ async 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> { const localVarAxiosArgs = await localVarAxiosParamCreator.listUserGroups(authorization, pageSize, pageToken, filter, search, order, expand, filters, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * 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} */ async removeUsersFromGroup(code: string, removeUsersFromGroupRequestDto: RemoveUsersFromGroupRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.removeUsersFromGroup(code, removeUsersFromGroupRequestDto, authorization, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * 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} */ async updateUserGroup(code: string, updateUserGroupRequestDto: UpdateUserGroupRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.updateUserGroup(code, updateUserGroupRequestDto, authorization, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, } }; /** * UserGroupApi - factory interface * @export */ export const UserGroupApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = UserGroupApiFp(configuration) return { /** * 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 { return localVarFp.addUsersToGroup(code, addUsersToGroupRequestDto, authorization, options).then((request) => request(axios, basePath)); }, /** * 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 { return localVarFp.createUserGroup(createUserGroupRequestDto, authorization, options).then((request) => request(axios, basePath)); }, /** * 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 { return localVarFp.deleteUserGroup(code, authorization, options).then((request) => request(axios, basePath)); }, /** * 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 { return localVarFp.getUserGroup(code, authorization, options).then((request) => request(axios, basePath)); }, /** * 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=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 { return localVarFp.listUserGroupMembers(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath)); }, /** * 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 { return localVarFp.listUserGroups(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath)); }, /** * 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 { return localVarFp.removeUsersFromGroup(code, removeUsersFromGroupRequestDto, authorization, options).then((request) => request(axios, basePath)); }, /** * 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 { return localVarFp.updateUserGroup(code, updateUserGroupRequestDto, authorization, options).then((request) => request(axios, basePath)); }, }; }; /** * 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=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 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 */ public addUsersToGroup(requestParameters: UserGroupApiAddUsersToGroupRequest, options?: AxiosRequestConfig) { return UserGroupApiFp(this.configuration).addUsersToGroup(requestParameters.code, requestParameters.addUsersToGroupRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath)); } /** * undefined **Required Permissions** \"identity-management.user-groups.create\" * @param {UserGroupApiCreateUserGroupRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserGroupApi */ public createUserGroup(requestParameters: UserGroupApiCreateUserGroupRequest, options?: AxiosRequestConfig) { return UserGroupApiFp(this.configuration).createUserGroup(requestParameters.createUserGroupRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath)); } /** * undefined **Required Permissions** \"identity-management.user-groups.delete\" * @param {UserGroupApiDeleteUserGroupRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserGroupApi */ public deleteUserGroup(requestParameters: UserGroupApiDeleteUserGroupRequest, options?: AxiosRequestConfig) { return UserGroupApiFp(this.configuration).deleteUserGroup(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath)); } /** * undefined **Required Permissions** \"identity-management.user-groups.view\" * @param {UserGroupApiGetUserGroupRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserGroupApi */ public getUserGroup(requestParameters: UserGroupApiGetUserGroupRequest, options?: AxiosRequestConfig) { return UserGroupApiFp(this.configuration).getUserGroup(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath)); } /** * undefined **Required Permissions** \"identity-management.user-groups.view\" * @param {UserGroupApiListUserGroupMembersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserGroupApi */ public listUserGroupMembers(requestParameters: UserGroupApiListUserGroupMembersRequest, options?: AxiosRequestConfig) { return UserGroupApiFp(this.configuration).listUserGroupMembers(requestParameters.code, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath)); } /** * undefined **Required Permissions** \"identity-management.user-groups.view\" * @param {UserGroupApiListUserGroupsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserGroupApi */ public listUserGroups(requestParameters: UserGroupApiListUserGroupsRequest = {}, options?: AxiosRequestConfig) { return UserGroupApiFp(this.configuration).listUserGroups(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath)); } /** * undefined **Required Permissions** \"identity-management.user-groups.update\" * @param {UserGroupApiRemoveUsersFromGroupRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserGroupApi */ public removeUsersFromGroup(requestParameters: UserGroupApiRemoveUsersFromGroupRequest, options?: AxiosRequestConfig) { return UserGroupApiFp(this.configuration).removeUsersFromGroup(requestParameters.code, requestParameters.removeUsersFromGroupRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath)); } /** * undefined **Required Permissions** \"identity-management.user-groups.update\" * @param {UserGroupApiUpdateUserGroupRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserGroupApi */ public updateUserGroup(requestParameters: UserGroupApiUpdateUserGroupRequest, options?: AxiosRequestConfig) { return UserGroupApiFp(this.configuration).updateUserGroup(requestParameters.code, requestParameters.updateUserGroupRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath)); } }