/** * 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 { BatchDeleteRequestDto } from '../models'; import { BatchDeleteResponseClass } from '../models'; import { InviteUserRequestDtoRest } from '../models'; import { InviteUserResponseClass } from '../models'; import { InviteUsersRequestDtoRest } from '../models'; import { InviteUsersResponseClass } from '../models'; import { ListInvitesResponseClass } from '../models'; /** * InviteUsersApi - axios parameter creator * @export */ export declare const InviteUsersApiAxiosParamCreator: (configuration?: 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} */ deleteInvites: (batchDeleteRequestDto: BatchDeleteRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise; /** * 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?: AxiosRequestConfig) => Promise; /** * 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?: AxiosRequestConfig) => Promise; /** * 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?: AxiosRequestConfig) => Promise; }; /** * InviteUsersApi - functional programming interface * @export */ export declare const InviteUsersApiFp: (configuration?: 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} */ deleteInvites(batchDeleteRequestDto: BatchDeleteRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * InviteUsersApi - factory interface * @export */ export declare const InviteUsersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * 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; /** * 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; /** * 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; /** * 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; }; /** * Request parameters for deleteInvites operation in InviteUsersApi. * @export * @interface InviteUsersApiDeleteInvitesRequest */ export interface InviteUsersApiDeleteInvitesRequest { /** * * @type {BatchDeleteRequestDto} * @memberof InviteUsersApiDeleteInvites */ readonly batchDeleteRequestDto: BatchDeleteRequestDto; /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof InviteUsersApiDeleteInvites */ readonly authorization?: string; } /** * Request parameters for inviteUser operation in InviteUsersApi. * @export * @interface InviteUsersApiInviteUserRequest */ export interface InviteUsersApiInviteUserRequest { /** * * @type {InviteUserRequestDtoRest} * @memberof InviteUsersApiInviteUser */ readonly inviteUserRequestDtoRest: InviteUserRequestDtoRest; /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof InviteUsersApiInviteUser */ readonly authorization?: string; } /** * Request parameters for inviteUsers operation in InviteUsersApi. * @export * @interface InviteUsersApiInviteUsersRequest */ export interface InviteUsersApiInviteUsersRequest { /** * * @type {InviteUsersRequestDtoRest} * @memberof InviteUsersApiInviteUsers */ readonly inviteUsersRequestDtoRest: InviteUsersRequestDtoRest; /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof InviteUsersApiInviteUsers */ readonly authorization?: string; } /** * Request parameters for listInvites operation in InviteUsersApi. * @export * @interface InviteUsersApiListInvitesRequest */ export interface InviteUsersApiListInvitesRequest { /** * Bearer Token: provided by the login endpoint under the name accessToken. * @type {string} * @memberof InviteUsersApiListInvites */ readonly authorization?: string; /** * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10. * @type {number} * @memberof InviteUsersApiListInvites */ 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 InviteUsersApiListInvites */ 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 InviteUsersApiListInvites */ readonly filter?: string; /** * To search the list by any field, pass search=xxx to fetch the result. * @type {string} * @memberof InviteUsersApiListInvites */ 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 InviteUsersApiListInvites */ 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 InviteUsersApiListInvites */ 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 InviteUsersApiListInvites */ readonly filters?: string; } /** * InviteUsersApi - object-oriented interface * @export * @class InviteUsersApi * @extends {BaseAPI} */ export declare class InviteUsersApi extends BaseAPI { /** * 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 {InviteUsersApiDeleteInvitesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InviteUsersApi */ deleteInvites(requestParameters: InviteUsersApiDeleteInvitesRequest, options?: AxiosRequestConfig): Promise>; /** * This send an email to invite a user with the specific role/roles. **Required Permissions** \"tenant-management.users.create\" * @summary Invite a user * @param {InviteUsersApiInviteUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InviteUsersApi */ inviteUser(requestParameters: InviteUsersApiInviteUserRequest, options?: AxiosRequestConfig): Promise>; /** * This send bulk emails to invite users with the specific role/roles. **Required Permissions** \"tenant-management.users.create\" * @summary Invite batch of users * @param {InviteUsersApiInviteUsersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InviteUsersApi */ inviteUsers(requestParameters: InviteUsersApiInviteUsersRequest, options?: AxiosRequestConfig): Promise>; /** * 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 {InviteUsersApiListInvitesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InviteUsersApi */ listInvites(requestParameters?: InviteUsersApiListInvitesRequest, options?: AxiosRequestConfig): Promise>; }