/* 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 { InviteUserRequestDtoRest } from '../models'; // @ts-ignore import { InviteUserResponseClass } from '../models'; // @ts-ignore import { InviteUsersRequestDtoRest } from '../models'; // @ts-ignore import { InviteUsersResponseClass } from '../models'; // @ts-ignore import { LinkUserWithPartnerRequestDtoRest } from '../models'; // @ts-ignore import { LinkUserWithPartnerResponseClass } from '../models'; // @ts-ignore import { ListInvitesResponseClass } from '../models'; // @ts-ignore import { ListUsersResponseClass } from '../models'; // URLSearchParams not necessarily used // @ts-ignore import { URL, URLSearchParams } from 'url'; const FormData = require('form-data'); /** * UserControllerRestApi - axios parameter creator * @export */ export const UserControllerRestApiAxiosParamCreator = 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, }; }, /** * This will deletes the users who has been invited. Supply array of ids that were returned when users has been created and this will delete it. **Required Permissions** \"tenant-management.users.delete\" * @summary Delete invited users. * @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} */ deleteInvites: async (batchDeleteRequestDto: BatchDeleteRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'batchDeleteRequestDto' is not null or undefined assertParamExists('deleteInvites', 'batchDeleteRequestDto', batchDeleteRequestDto) const localVarPath = `/tenantservice/v1/users/invites/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.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, }; }, /** * This send an email to invite a user with the specific role/roles. **Required Permissions** \"tenant-management.users.create\" * @summary Invite a user * @param {InviteUserRequestDtoRest} inviteUserRequestDtoRest * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ inviteUser: async (inviteUserRequestDtoRest: InviteUserRequestDtoRest, authorization?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'inviteUserRequestDtoRest' is not null or undefined assertParamExists('inviteUser', 'inviteUserRequestDtoRest', inviteUserRequestDtoRest) const localVarPath = `/tenantservice/v1/users/invites`; // 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(inviteUserRequestDtoRest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * This send bulk emails to invite users with the specific role/roles. **Required Permissions** \"tenant-management.users.create\" * @summary Invite batch of users * @param {InviteUsersRequestDtoRest} inviteUsersRequestDtoRest * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ inviteUsers: async (inviteUsersRequestDtoRest: InviteUsersRequestDtoRest, authorization?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'inviteUsersRequestDtoRest' is not null or undefined assertParamExists('inviteUsers', 'inviteUsersRequestDtoRest', inviteUsersRequestDtoRest) const localVarPath = `/tenantservice/v1/users/invites/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(inviteUsersRequestDtoRest, localVarRequestOptions, configuration) 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 invited users you have previously created. The invited 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 invited 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, email, token, 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, expiresOn</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: 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, email, token, organizationId, ern, partnerCode</i> * @param {*} [options] Override http request option. * @throws {RequiredError} */ listInvites: 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/invites`; // 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, }; }, /** * 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, }; }, } }; /** * UserControllerRestApi - functional programming interface * @export */ export const UserControllerRestApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = UserControllerRestApiAxiosParamCreator(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); }, /** * This will deletes the users who has been invited. Supply array of ids that were returned when users has been created and this will delete it. **Required Permissions** \"tenant-management.users.delete\" * @summary Delete invited users. * @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 deleteInvites(batchDeleteRequestDto: BatchDeleteRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteInvites(batchDeleteRequestDto, 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); }, /** * This send an email to invite a user with the specific role/roles. **Required Permissions** \"tenant-management.users.create\" * @summary Invite a user * @param {InviteUserRequestDtoRest} inviteUserRequestDtoRest * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ async inviteUser(inviteUserRequestDtoRest: InviteUserRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.inviteUser(inviteUserRequestDtoRest, authorization, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * This send bulk emails to invite users with the specific role/roles. **Required Permissions** \"tenant-management.users.create\" * @summary Invite batch of users * @param {InviteUsersRequestDtoRest} inviteUsersRequestDtoRest * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ async inviteUsers(inviteUsersRequestDtoRest: InviteUsersRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.inviteUsers(inviteUsersRequestDtoRest, authorization, 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 invited users you have previously created. The invited 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 invited 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, email, token, 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, expiresOn</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: 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, email, token, organizationId, ern, partnerCode</i> * @param {*} [options] Override http request option. * @throws {RequiredError} */ async listInvites(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.listInvites(authorization, pageSize, pageToken, filter, search, order, expand, filters, 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); }, } }; /** * UserControllerRestApi - factory interface * @export */ export const UserControllerRestApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = UserControllerRestApiFp(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)); }, /** * This will deletes the users who has been invited. Supply array of ids that were returned when users has been created and this will delete it. **Required Permissions** \"tenant-management.users.delete\" * @summary Delete invited users. * @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} */ deleteInvites(batchDeleteRequestDto: BatchDeleteRequestDto, authorization?: string, options?: any): AxiosPromise { return localVarFp.deleteInvites(batchDeleteRequestDto, 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)); }, /** * This send an email to invite a user with the specific role/roles. **Required Permissions** \"tenant-management.users.create\" * @summary Invite a user * @param {InviteUserRequestDtoRest} inviteUserRequestDtoRest * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ inviteUser(inviteUserRequestDtoRest: InviteUserRequestDtoRest, authorization?: string, options?: any): AxiosPromise { return localVarFp.inviteUser(inviteUserRequestDtoRest, authorization, options).then((request) => request(axios, basePath)); }, /** * This send bulk emails to invite users with the specific role/roles. **Required Permissions** \"tenant-management.users.create\" * @summary Invite batch of users * @param {InviteUsersRequestDtoRest} inviteUsersRequestDtoRest * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken. * @param {*} [options] Override http request option. * @throws {RequiredError} */ inviteUsers(inviteUsersRequestDtoRest: InviteUsersRequestDtoRest, authorization?: string, options?: any): AxiosPromise { return localVarFp.inviteUsers(inviteUsersRequestDtoRest, authorization, 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 invited users you have previously created. The invited 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 invited 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, email, token, 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, expiresOn</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: 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, email, token, organizationId, ern, partnerCode</i> * @param {*} [options] Override http request option. * @throws {RequiredError} */ listInvites(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise { return localVarFp.listInvites(authorization, pageSize, pageToken, filter, search, order, expand, filters, 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 UserControllerRestApi. * @export * @interface UserControllerRestApiAssignUserRolesRequest */ export interface UserControllerRestApiAssignUserRolesRequest { /** * * @type {number} * @memberof UserControllerRestApiAssignUserRoles */ readonly id: number /** * * @type {AssignUserRolesRequestDto} * @memberof UserControllerRestApiAssignUserRoles */ readonly assignUserRolesRequestDto: AssignUserRolesRequestDto /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof UserControllerRestApiAssignUserRoles */ readonly authorization?: string } /** * Request parameters for deleteInvites operation in UserControllerRestApi. * @export * @interface UserControllerRestApiDeleteInvitesRequest */ export interface UserControllerRestApiDeleteInvitesRequest { /** * * @type {BatchDeleteRequestDto} * @memberof UserControllerRestApiDeleteInvites */ readonly batchDeleteRequestDto: BatchDeleteRequestDto /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof UserControllerRestApiDeleteInvites */ readonly authorization?: string } /** * Request parameters for deleteUsers operation in UserControllerRestApi. * @export * @interface UserControllerRestApiDeleteUsersRequest */ export interface UserControllerRestApiDeleteUsersRequest { /** * * @type {BatchDeleteRequestDto} * @memberof UserControllerRestApiDeleteUsers */ readonly batchDeleteRequestDto: BatchDeleteRequestDto /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof UserControllerRestApiDeleteUsers */ readonly authorization?: string } /** * Request parameters for disableUsers operation in UserControllerRestApi. * @export * @interface UserControllerRestApiDisableUsersRequest */ export interface UserControllerRestApiDisableUsersRequest { /** * * @type {DisableUsersRequestDto} * @memberof UserControllerRestApiDisableUsers */ readonly disableUsersRequestDto: DisableUsersRequestDto /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof UserControllerRestApiDisableUsers */ readonly authorization?: string } /** * Request parameters for enableUsers operation in UserControllerRestApi. * @export * @interface UserControllerRestApiEnableUsersRequest */ export interface UserControllerRestApiEnableUsersRequest { /** * * @type {EnableUsersRequestDto} * @memberof UserControllerRestApiEnableUsers */ readonly enableUsersRequestDto: EnableUsersRequestDto /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof UserControllerRestApiEnableUsers */ readonly authorization?: string } /** * Request parameters for getUser operation in UserControllerRestApi. * @export * @interface UserControllerRestApiGetUserRequest */ export interface UserControllerRestApiGetUserRequest { /** * * @type {string} * @memberof UserControllerRestApiGetUser */ readonly code: string /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof UserControllerRestApiGetUser */ readonly authorization?: string /** * Fields to expand response by * @type {string} * @memberof UserControllerRestApiGetUser */ readonly expand?: string } /** * Request parameters for inviteUser operation in UserControllerRestApi. * @export * @interface UserControllerRestApiInviteUserRequest */ export interface UserControllerRestApiInviteUserRequest { /** * * @type {InviteUserRequestDtoRest} * @memberof UserControllerRestApiInviteUser */ readonly inviteUserRequestDtoRest: InviteUserRequestDtoRest /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof UserControllerRestApiInviteUser */ readonly authorization?: string } /** * Request parameters for inviteUsers operation in UserControllerRestApi. * @export * @interface UserControllerRestApiInviteUsersRequest */ export interface UserControllerRestApiInviteUsersRequest { /** * * @type {InviteUsersRequestDtoRest} * @memberof UserControllerRestApiInviteUsers */ readonly inviteUsersRequestDtoRest: InviteUsersRequestDtoRest /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof UserControllerRestApiInviteUsers */ readonly authorization?: string } /** * Request parameters for linkUserWithPartner operation in UserControllerRestApi. * @export * @interface UserControllerRestApiLinkUserWithPartnerRequest */ export interface UserControllerRestApiLinkUserWithPartnerRequest { /** * Unique identifier for the object. * @type {string} * @memberof UserControllerRestApiLinkUserWithPartner */ readonly code: string /** * * @type {LinkUserWithPartnerRequestDtoRest} * @memberof UserControllerRestApiLinkUserWithPartner */ readonly linkUserWithPartnerRequestDtoRest: LinkUserWithPartnerRequestDtoRest /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof UserControllerRestApiLinkUserWithPartner */ readonly authorization?: string } /** * Request parameters for listInvites operation in UserControllerRestApi. * @export * @interface UserControllerRestApiListInvitesRequest */ export interface UserControllerRestApiListInvitesRequest { /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof UserControllerRestApiListInvites */ readonly authorization?: string /** * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10. * @type {number} * @memberof UserControllerRestApiListInvites */ 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 UserControllerRestApiListInvites */ 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, email, token, organizationId, ern, partnerCode</i> * @type {string} * @memberof UserControllerRestApiListInvites */ readonly filter?: string /** * To search the list by any field, pass search=xxx to fetch the result. * @type {string} * @memberof UserControllerRestApiListInvites */ 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, expiresOn</i> * @type {string} * @memberof UserControllerRestApiListInvites */ 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: organizations<i> * @type {string} * @memberof UserControllerRestApiListInvites */ 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, email, token, organizationId, ern, partnerCode</i> * @type {string} * @memberof UserControllerRestApiListInvites */ readonly filters?: string } /** * Request parameters for listUsers operation in UserControllerRestApi. * @export * @interface UserControllerRestApiListUsersRequest */ export interface UserControllerRestApiListUsersRequest { /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof UserControllerRestApiListUsers */ readonly authorization?: string /** * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10. * @type {number} * @memberof UserControllerRestApiListUsers */ 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 UserControllerRestApiListUsers */ 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 UserControllerRestApiListUsers */ readonly filter?: string /** * To search the list by any field, pass search=xxx to fetch the result. * @type {string} * @memberof UserControllerRestApiListUsers */ 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 UserControllerRestApiListUsers */ 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 UserControllerRestApiListUsers */ 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 UserControllerRestApiListUsers */ readonly filters?: string } /** * UserControllerRestApi - object-oriented interface * @export * @class UserControllerRestApi * @extends {BaseAPI} */ export class UserControllerRestApi 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 {UserControllerRestApiAssignUserRolesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} * @memberof UserControllerRestApi */ public assignUserRoles(requestParameters: UserControllerRestApiAssignUserRolesRequest, options?: AxiosRequestConfig) { return UserControllerRestApiFp(this.configuration).assignUserRoles(requestParameters.id, requestParameters.assignUserRolesRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath)); } /** * This will deletes the users who has been invited. Supply array of ids that were returned when users has been created and this will delete it. **Required Permissions** \"tenant-management.users.delete\" * @summary Delete invited users. * @param {UserControllerRestApiDeleteInvitesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserControllerRestApi */ public deleteInvites(requestParameters: UserControllerRestApiDeleteInvitesRequest, options?: AxiosRequestConfig) { return UserControllerRestApiFp(this.configuration).deleteInvites(requestParameters.batchDeleteRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath)); } /** * undefined **Required Permissions** \"tenant-management.users.delete\" * @param {UserControllerRestApiDeleteUsersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserControllerRestApi */ public deleteUsers(requestParameters: UserControllerRestApiDeleteUsersRequest, options?: AxiosRequestConfig) { return UserControllerRestApiFp(this.configuration).deleteUsers(requestParameters.batchDeleteRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath)); } /** * undefined **Required Permissions** \"tenant-management.users.update\" * @param {UserControllerRestApiDisableUsersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserControllerRestApi */ public disableUsers(requestParameters: UserControllerRestApiDisableUsersRequest, options?: AxiosRequestConfig) { return UserControllerRestApiFp(this.configuration).disableUsers(requestParameters.disableUsersRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath)); } /** * undefined **Required Permissions** \"tenant-management.users.update\" * @param {UserControllerRestApiEnableUsersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserControllerRestApi */ public enableUsers(requestParameters: UserControllerRestApiEnableUsersRequest, options?: AxiosRequestConfig) { return UserControllerRestApiFp(this.configuration).enableUsers(requestParameters.enableUsersRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath)); } /** * undefined **Required Permissions** \"tenant-management.users.view\" * @param {UserControllerRestApiGetUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserControllerRestApi */ public getUser(requestParameters: UserControllerRestApiGetUserRequest, options?: AxiosRequestConfig) { return UserControllerRestApiFp(this.configuration).getUser(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath)); } /** * This send an email to invite a user with the specific role/roles. **Required Permissions** \"tenant-management.users.create\" * @summary Invite a user * @param {UserControllerRestApiInviteUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserControllerRestApi */ public inviteUser(requestParameters: UserControllerRestApiInviteUserRequest, options?: AxiosRequestConfig) { return UserControllerRestApiFp(this.configuration).inviteUser(requestParameters.inviteUserRequestDtoRest, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath)); } /** * This send bulk emails to invite users with the specific role/roles. **Required Permissions** \"tenant-management.users.create\" * @summary Invite batch of users * @param {UserControllerRestApiInviteUsersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserControllerRestApi */ public inviteUsers(requestParameters: UserControllerRestApiInviteUsersRequest, options?: AxiosRequestConfig) { return UserControllerRestApiFp(this.configuration).inviteUsers(requestParameters.inviteUsersRequestDtoRest, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath)); } /** * undefined **Required Permissions** \"partner-management.partners.update\" * @param {UserControllerRestApiLinkUserWithPartnerRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserControllerRestApi */ public linkUserWithPartner(requestParameters: UserControllerRestApiLinkUserWithPartnerRequest, options?: AxiosRequestConfig) { return UserControllerRestApiFp(this.configuration).linkUserWithPartner(requestParameters.code, requestParameters.linkUserWithPartnerRequestDtoRest, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath)); } /** * Returns a list of invited users you have previously created. The invited 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 invited users * @param {UserControllerRestApiListInvitesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserControllerRestApi */ public listInvites(requestParameters: UserControllerRestApiListInvitesRequest = {}, options?: AxiosRequestConfig) { return UserControllerRestApiFp(this.configuration).listInvites(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, 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 {UserControllerRestApiListUsersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserControllerRestApi */ public listUsers(requestParameters: UserControllerRestApiListUsersRequest = {}, options?: AxiosRequestConfig) { return UserControllerRestApiFp(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)); } }