/* 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 { AssignUserRolesRequestDto } from '../models'; // @ts-ignore import { AssignUserRolesResponseClass } from '../models'; // @ts-ignore import { BatchDeleteRequestDto } from '../models'; // @ts-ignore import { BatchDeleteResponseClass } from '../models'; // @ts-ignore import { DisableUsersRequestDto } from '../models'; // @ts-ignore import { DisableUsersResponseClass } from '../models'; // @ts-ignore import { EnableUsersRequestDto } from '../models'; // @ts-ignore import { EnableUsersResponseClass } from '../models'; // @ts-ignore import { GetUserResponseClass } from '../models'; // @ts-ignore import { LinkUserWithPartnerRequestDtoRest } from '../models'; // @ts-ignore import { LinkUserWithPartnerResponseClass } from '../models'; // @ts-ignore import { ListUsersResponseClass } from '../models'; // URLSearchParams not necessarily used // @ts-ignore import { URL, URLSearchParams } from 'url'; const FormData = require('form-data'); /** * UsersApi - axios parameter creator * @export */ export const UsersApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * This endpoint is deprecated, please refer to the policy administration service at /policy-administration-service/api. **Required Permissions** \"identity-management.roles.update\" * @param {number} id * @param {AssignUserRolesRequestDto} assignUserRolesRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ assignUserRoles: async (id: number, assignUserRolesRequestDto: AssignUserRolesRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('assignUserRoles', 'id', id) // verify required parameter 'assignUserRolesRequestDto' is not null or undefined assertParamExists('assignUserRoles', 'assignUserRolesRequestDto', assignUserRolesRequestDto) const localVarPath = `/tenantservice/v1/users/{id}/assign-roles` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // 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(assignUserRolesRequestDto, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * undefined **Required Permissions** \"tenant-management.users.delete\" * @param {BatchDeleteRequestDto} batchDeleteRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUsers: async (batchDeleteRequestDto: BatchDeleteRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'batchDeleteRequestDto' is not null or undefined assertParamExists('deleteUsers', 'batchDeleteRequestDto', batchDeleteRequestDto) const localVarPath = `/tenantservice/v1/users/delete-batch`; // 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(batchDeleteRequestDto, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * undefined **Required Permissions** \"tenant-management.users.update\" * @param {DisableUsersRequestDto} disableUsersRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ disableUsers: async (disableUsersRequestDto: DisableUsersRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'disableUsersRequestDto' is not null or undefined assertParamExists('disableUsers', 'disableUsersRequestDto', disableUsersRequestDto) const localVarPath = `/tenantservice/v1/users/disable-batch`; // 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(disableUsersRequestDto, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * undefined **Required Permissions** \"tenant-management.users.update\" * @param {EnableUsersRequestDto} enableUsersRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ enableUsers: async (enableUsersRequestDto: EnableUsersRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'enableUsersRequestDto' is not null or undefined assertParamExists('enableUsers', 'enableUsersRequestDto', enableUsersRequestDto) const localVarPath = `/tenantservice/v1/users/enable-batch`; // 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(enableUsersRequestDto, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * undefined **Required Permissions** \"tenant-management.users.view\" * @param {string} code * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {string} [expand] Fields to expand response by * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUser: async (code: string, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'code' is not null or undefined assertParamExists('getUser', 'code', code) const localVarPath = `/tenantservice/v1/users/{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 (expand !== undefined) { localVarQueryParameter['expand'] = expand; } 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** \"partner-management.partners.update\" * @param {string} code Unique identifier for the object. * @param {LinkUserWithPartnerRequestDtoRest} linkUserWithPartnerRequestDtoRest * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ linkUserWithPartner: async (code: string, linkUserWithPartnerRequestDtoRest: LinkUserWithPartnerRequestDtoRest, authorization?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'code' is not null or undefined assertParamExists('linkUserWithPartner', 'code', code) // verify required parameter 'linkUserWithPartnerRequestDtoRest' is not null or undefined assertParamExists('linkUserWithPartner', 'linkUserWithPartnerRequestDtoRest', linkUserWithPartnerRequestDtoRest) const localVarPath = `/tenantservice/v1/users/{code}/link-partner` .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(linkUserWithPartnerRequestDtoRest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * Returns a list of users you have previously created. The users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.users.view\" * @summary List users * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10. * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list. * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i> * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result. * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email, firstName, lastName</i> * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations<i> * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i> * @param {*} [options] Override http request option. * @throws {RequiredError} */ listUsers: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/tenantservice/v1/users`; // 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, }; }, } }; /** * UsersApi - functional programming interface * @export */ export const UsersApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = UsersApiAxiosParamCreator(configuration) return { /** * This endpoint is deprecated, please refer to the policy administration service at /policy-administration-service/api. **Required Permissions** \"identity-management.roles.update\" * @param {number} id * @param {AssignUserRolesRequestDto} assignUserRolesRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ async assignUserRoles(id: number, assignUserRolesRequestDto: AssignUserRolesRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.assignUserRoles(id, assignUserRolesRequestDto, authorization, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * undefined **Required Permissions** \"tenant-management.users.delete\" * @param {BatchDeleteRequestDto} batchDeleteRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ async deleteUsers(batchDeleteRequestDto: BatchDeleteRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteUsers(batchDeleteRequestDto, authorization, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * undefined **Required Permissions** \"tenant-management.users.update\" * @param {DisableUsersRequestDto} disableUsersRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ async disableUsers(disableUsersRequestDto: DisableUsersRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.disableUsers(disableUsersRequestDto, authorization, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * undefined **Required Permissions** \"tenant-management.users.update\" * @param {EnableUsersRequestDto} enableUsersRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ async enableUsers(enableUsersRequestDto: EnableUsersRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.enableUsers(enableUsersRequestDto, authorization, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * undefined **Required Permissions** \"tenant-management.users.view\" * @param {string} code * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {string} [expand] Fields to expand response by * @param {*} [options] Override http request option. * @throws {RequiredError} */ async getUser(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getUser(code, authorization, expand, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * undefined **Required Permissions** \"partner-management.partners.update\" * @param {string} code Unique identifier for the object. * @param {LinkUserWithPartnerRequestDtoRest} linkUserWithPartnerRequestDtoRest * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ async linkUserWithPartner(code: string, linkUserWithPartnerRequestDtoRest: LinkUserWithPartnerRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.linkUserWithPartner(code, linkUserWithPartnerRequestDtoRest, authorization, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * Returns a list of users you have previously created. The users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.users.view\" * @summary List users * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10. * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list. * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i> * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result. * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email, firstName, lastName</i> * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations<i> * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i> * @param {*} [options] Override http request option. * @throws {RequiredError} */ async listUsers(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.listUsers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, } }; /** * UsersApi - factory interface * @export */ export const UsersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = UsersApiFp(configuration) return { /** * This endpoint is deprecated, please refer to the policy administration service at /policy-administration-service/api. **Required Permissions** \"identity-management.roles.update\" * @param {number} id * @param {AssignUserRolesRequestDto} assignUserRolesRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ assignUserRoles(id: number, assignUserRolesRequestDto: AssignUserRolesRequestDto, authorization?: string, options?: any): AxiosPromise { return localVarFp.assignUserRoles(id, assignUserRolesRequestDto, authorization, options).then((request) => request(axios, basePath)); }, /** * undefined **Required Permissions** \"tenant-management.users.delete\" * @param {BatchDeleteRequestDto} batchDeleteRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUsers(batchDeleteRequestDto: BatchDeleteRequestDto, authorization?: string, options?: any): AxiosPromise { return localVarFp.deleteUsers(batchDeleteRequestDto, authorization, options).then((request) => request(axios, basePath)); }, /** * undefined **Required Permissions** \"tenant-management.users.update\" * @param {DisableUsersRequestDto} disableUsersRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ disableUsers(disableUsersRequestDto: DisableUsersRequestDto, authorization?: string, options?: any): AxiosPromise { return localVarFp.disableUsers(disableUsersRequestDto, authorization, options).then((request) => request(axios, basePath)); }, /** * undefined **Required Permissions** \"tenant-management.users.update\" * @param {EnableUsersRequestDto} enableUsersRequestDto * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ enableUsers(enableUsersRequestDto: EnableUsersRequestDto, authorization?: string, options?: any): AxiosPromise { return localVarFp.enableUsers(enableUsersRequestDto, authorization, options).then((request) => request(axios, basePath)); }, /** * undefined **Required Permissions** \"tenant-management.users.view\" * @param {string} code * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {string} [expand] Fields to expand response by * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUser(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise { return localVarFp.getUser(code, authorization, expand, options).then((request) => request(axios, basePath)); }, /** * undefined **Required Permissions** \"partner-management.partners.update\" * @param {string} code Unique identifier for the object. * @param {LinkUserWithPartnerRequestDtoRest} linkUserWithPartnerRequestDtoRest * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ linkUserWithPartner(code: string, linkUserWithPartnerRequestDtoRest: LinkUserWithPartnerRequestDtoRest, authorization?: string, options?: any): AxiosPromise { return localVarFp.linkUserWithPartner(code, linkUserWithPartnerRequestDtoRest, authorization, options).then((request) => request(axios, basePath)); }, /** * Returns a list of users you have previously created. The users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.users.view\" * @summary List users * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10. * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list. * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i> * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result. * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email, firstName, lastName</i> * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations<i> * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i> * @param {*} [options] Override http request option. * @throws {RequiredError} */ listUsers(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise { return localVarFp.listUsers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath)); }, }; }; /** * Request parameters for assignUserRoles operation in UsersApi. * @export * @interface UsersApiAssignUserRolesRequest */ export interface UsersApiAssignUserRolesRequest { /** * * @type {number} * @memberof UsersApiAssignUserRoles */ readonly id: number /** * * @type {AssignUserRolesRequestDto} * @memberof UsersApiAssignUserRoles */ readonly assignUserRolesRequestDto: AssignUserRolesRequestDto /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof UsersApiAssignUserRoles */ readonly authorization?: string } /** * Request parameters for deleteUsers operation in UsersApi. * @export * @interface UsersApiDeleteUsersRequest */ export interface UsersApiDeleteUsersRequest { /** * * @type {BatchDeleteRequestDto} * @memberof UsersApiDeleteUsers */ readonly batchDeleteRequestDto: BatchDeleteRequestDto /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof UsersApiDeleteUsers */ readonly authorization?: string } /** * Request parameters for disableUsers operation in UsersApi. * @export * @interface UsersApiDisableUsersRequest */ export interface UsersApiDisableUsersRequest { /** * * @type {DisableUsersRequestDto} * @memberof UsersApiDisableUsers */ readonly disableUsersRequestDto: DisableUsersRequestDto /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof UsersApiDisableUsers */ readonly authorization?: string } /** * Request parameters for enableUsers operation in UsersApi. * @export * @interface UsersApiEnableUsersRequest */ export interface UsersApiEnableUsersRequest { /** * * @type {EnableUsersRequestDto} * @memberof UsersApiEnableUsers */ readonly enableUsersRequestDto: EnableUsersRequestDto /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof UsersApiEnableUsers */ readonly authorization?: string } /** * Request parameters for getUser operation in UsersApi. * @export * @interface UsersApiGetUserRequest */ export interface UsersApiGetUserRequest { /** * * @type {string} * @memberof UsersApiGetUser */ readonly code: string /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof UsersApiGetUser */ readonly authorization?: string /** * Fields to expand response by * @type {string} * @memberof UsersApiGetUser */ readonly expand?: string } /** * Request parameters for linkUserWithPartner operation in UsersApi. * @export * @interface UsersApiLinkUserWithPartnerRequest */ export interface UsersApiLinkUserWithPartnerRequest { /** * Unique identifier for the object. * @type {string} * @memberof UsersApiLinkUserWithPartner */ readonly code: string /** * * @type {LinkUserWithPartnerRequestDtoRest} * @memberof UsersApiLinkUserWithPartner */ readonly linkUserWithPartnerRequestDtoRest: LinkUserWithPartnerRequestDtoRest /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof UsersApiLinkUserWithPartner */ readonly authorization?: string } /** * Request parameters for listUsers operation in UsersApi. * @export * @interface UsersApiListUsersRequest */ export interface UsersApiListUsersRequest { /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof UsersApiListUsers */ readonly authorization?: string /** * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10. * @type {number} * @memberof UsersApiListUsers */ readonly pageSize?: number /** * A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list. * @type {string} * @memberof UsersApiListUsers */ readonly pageToken?: string /** * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i> * @type {string} * @memberof UsersApiListUsers */ readonly filter?: string /** * To search the list by any field, pass search=xxx to fetch the result. * @type {string} * @memberof UsersApiListUsers */ readonly search?: string /** * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email, firstName, lastName</i> * @type {string} * @memberof UsersApiListUsers */ readonly order?: string /** * Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations<i> * @type {string} * @memberof UsersApiListUsers */ readonly expand?: string /** * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i> * @type {string} * @memberof UsersApiListUsers */ readonly filters?: string } /** * UsersApi - object-oriented interface * @export * @class UsersApi * @extends {BaseAPI} */ export class UsersApi extends BaseAPI { /** * This endpoint is deprecated, please refer to the policy administration service at /policy-administration-service/api. **Required Permissions** \"identity-management.roles.update\" * @param {UsersApiAssignUserRolesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} * @memberof UsersApi */ public assignUserRoles(requestParameters: UsersApiAssignUserRolesRequest, options?: AxiosRequestConfig) { return UsersApiFp(this.configuration).assignUserRoles(requestParameters.id, requestParameters.assignUserRolesRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath)); } /** * undefined **Required Permissions** \"tenant-management.users.delete\" * @param {UsersApiDeleteUsersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ public deleteUsers(requestParameters: UsersApiDeleteUsersRequest, options?: AxiosRequestConfig) { return UsersApiFp(this.configuration).deleteUsers(requestParameters.batchDeleteRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath)); } /** * undefined **Required Permissions** \"tenant-management.users.update\" * @param {UsersApiDisableUsersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ public disableUsers(requestParameters: UsersApiDisableUsersRequest, options?: AxiosRequestConfig) { return UsersApiFp(this.configuration).disableUsers(requestParameters.disableUsersRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath)); } /** * undefined **Required Permissions** \"tenant-management.users.update\" * @param {UsersApiEnableUsersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ public enableUsers(requestParameters: UsersApiEnableUsersRequest, options?: AxiosRequestConfig) { return UsersApiFp(this.configuration).enableUsers(requestParameters.enableUsersRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath)); } /** * undefined **Required Permissions** \"tenant-management.users.view\" * @param {UsersApiGetUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ public getUser(requestParameters: UsersApiGetUserRequest, options?: AxiosRequestConfig) { return UsersApiFp(this.configuration).getUser(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath)); } /** * undefined **Required Permissions** \"partner-management.partners.update\" * @param {UsersApiLinkUserWithPartnerRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ public linkUserWithPartner(requestParameters: UsersApiLinkUserWithPartnerRequest, options?: AxiosRequestConfig) { return UsersApiFp(this.configuration).linkUserWithPartner(requestParameters.code, requestParameters.linkUserWithPartnerRequestDtoRest, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath)); } /** * Returns a list of users you have previously created. The users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.users.view\" * @summary List users * @param {UsersApiListUsersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ public listUsers(requestParameters: UsersApiListUsersRequest = {}, options?: AxiosRequestConfig) { return UsersApiFp(this.configuration).listUsers(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath)); } }