/** * EMIL Tenant Service * The EMIL TenantService API description * * The version of the OpenAPI document: 1.0 * Contact: kontakt@emil.de * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; import { Configuration } from '../configuration'; import { RequestArgs, BaseAPI } from '../base'; import { AssignUserRolesRequestDto } from '../models'; import { AssignUserRolesResponseClass } from '../models'; import { BatchDeleteRequestDto } from '../models'; import { BatchDeleteResponseClass } from '../models'; import { DisableUsersRequestDto } from '../models'; import { DisableUsersResponseClass } from '../models'; import { EnableUsersRequestDto } from '../models'; import { EnableUsersResponseClass } from '../models'; import { GetUserResponseClass } from '../models'; import { LinkUserWithPartnerRequestDtoRest } from '../models'; import { LinkUserWithPartnerResponseClass } from '../models'; import { ListUsersResponseClass } from '../models'; /** * UsersApi - axios parameter creator * @export */ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration) => { /** * 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?: AxiosRequestConfig) => Promise; /** * 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?: AxiosRequestConfig) => Promise; /** * 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?: AxiosRequestConfig) => Promise; /** * 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?: AxiosRequestConfig) => Promise; /** * 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?: AxiosRequestConfig) => Promise; /** * 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?: AxiosRequestConfig) => Promise; /** * 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?: AxiosRequestConfig) => Promise; }; /** * UsersApi - functional programming interface * @export */ export declare const UsersApiFp: (configuration?: Configuration) => { /** * 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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * UsersApi - factory interface * @export */ export declare const UsersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * 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; /** * 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; /** * 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; /** * 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; /** * 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; /** * 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; /** * 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; }; /** * 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 declare 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 */ assignUserRoles(requestParameters: UsersApiAssignUserRolesRequest, options?: AxiosRequestConfig): Promise>; /** * undefined **Required Permissions** \"tenant-management.users.delete\" * @param {UsersApiDeleteUsersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ deleteUsers(requestParameters: UsersApiDeleteUsersRequest, options?: AxiosRequestConfig): Promise>; /** * undefined **Required Permissions** \"tenant-management.users.update\" * @param {UsersApiDisableUsersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ disableUsers(requestParameters: UsersApiDisableUsersRequest, options?: AxiosRequestConfig): Promise>; /** * undefined **Required Permissions** \"tenant-management.users.update\" * @param {UsersApiEnableUsersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ enableUsers(requestParameters: UsersApiEnableUsersRequest, options?: AxiosRequestConfig): Promise>; /** * undefined **Required Permissions** \"tenant-management.users.view\" * @param {UsersApiGetUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ getUser(requestParameters: UsersApiGetUserRequest, options?: AxiosRequestConfig): Promise>; /** * undefined **Required Permissions** \"partner-management.partners.update\" * @param {UsersApiLinkUserWithPartnerRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ linkUserWithPartner(requestParameters: UsersApiLinkUserWithPartnerRequest, options?: AxiosRequestConfig): Promise>; /** * 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 */ listUsers(requestParameters?: UsersApiListUsersRequest, options?: AxiosRequestConfig): Promise>; }