@emilgroup/tenant-sdk 1.0.0

package/dist/api/invite-users-api.d.ts

@@ -0,0 +1,368 @@
+/**
+ * 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 { DeleteResponseClass } from '../models';
+import { InviteUserRequestDto } from '../models';
+import { InviteUserResponseClass } from '../models';
+import { InviteUsersRequestDto } from '../models';
+import { InviteUsersResponseClass } from '../models';
+import { ListInvitesResponseClass } from '../models';
+/**
+ * InviteUsersApi - axios parameter creator
+ * @export
+ */
+export declare const InviteUsersApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Permanently deletes the invited user. Supply the unique id that was returned when you created the invited user and this will delete it.
+     * @summary Delete the invited user
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteInvite: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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.
+     * @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<RequestArgs>;
+    /**
+     * This send an email to invite a user with the specific role/roles.
+     * @summary Invite a user
+     * @param {InviteUserRequestDto} inviteUserRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    inviteUser: (inviteUserRequestDto: InviteUserRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This send bulk emails to invite users with the specific role/roles.
+     * @summary Invite batch of users
+     * @param {InviteUsersRequestDto} inviteUsersRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    inviteUsers: (inviteUsersRequestDto: InviteUsersRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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.
+     * @summary List invited users
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 100. Default: 10.
+     * @param {any} [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&#x3D;1,     your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @param {any} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+     * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
+     * @param {any} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in     addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listInvites: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * InviteUsersApi - functional programming interface
+ * @export
+ */
+export declare const InviteUsersApiFp: (configuration?: Configuration) => {
+    /**
+     * Permanently deletes the invited user. Supply the unique id that was returned when you created the invited user and this will delete it.
+     * @summary Delete the invited user
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteInvite(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
+    /**
+     * 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.
+     * @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<BatchDeleteResponseClass>>;
+    /**
+     * This send an email to invite a user with the specific role/roles.
+     * @summary Invite a user
+     * @param {InviteUserRequestDto} inviteUserRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    inviteUser(inviteUserRequestDto: InviteUserRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InviteUserResponseClass>>;
+    /**
+     * This send bulk emails to invite users with the specific role/roles.
+     * @summary Invite batch of users
+     * @param {InviteUsersRequestDto} inviteUsersRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    inviteUsers(inviteUsersRequestDto: InviteUsersRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InviteUsersResponseClass>>;
+    /**
+     * 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.
+     * @summary List invited users
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 100. Default: 10.
+     * @param {any} [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&#x3D;1,     your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @param {any} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+     * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
+     * @param {any} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in     addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listInvites(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListInvitesResponseClass>>;
+};
+/**
+ * InviteUsersApi - factory interface
+ * @export
+ */
+export declare const InviteUsersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Permanently deletes the invited user. Supply the unique id that was returned when you created the invited user and this will delete it.
+     * @summary Delete the invited user
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteInvite(id: number, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
+    /**
+     * 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.
+     * @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<BatchDeleteResponseClass>;
+    /**
+     * This send an email to invite a user with the specific role/roles.
+     * @summary Invite a user
+     * @param {InviteUserRequestDto} inviteUserRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    inviteUser(inviteUserRequestDto: InviteUserRequestDto, authorization?: string, options?: any): AxiosPromise<InviteUserResponseClass>;
+    /**
+     * This send bulk emails to invite users with the specific role/roles.
+     * @summary Invite batch of users
+     * @param {InviteUsersRequestDto} inviteUsersRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    inviteUsers(inviteUsersRequestDto: InviteUsersRequestDto, authorization?: string, options?: any): AxiosPromise<InviteUsersResponseClass>;
+    /**
+     * 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.
+     * @summary List invited users
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 100. Default: 10.
+     * @param {any} [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&#x3D;1,     your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @param {any} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+     * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
+     * @param {any} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in     addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listInvites(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListInvitesResponseClass>;
+};
+/**
+ * Request parameters for deleteInvite operation in InviteUsersApi.
+ * @export
+ * @interface InviteUsersApiDeleteInviteRequest
+ */
+export interface InviteUsersApiDeleteInviteRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof InviteUsersApiDeleteInvite
+     */
+    readonly id: number;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof InviteUsersApiDeleteInvite
+     */
+    readonly authorization?: string;
+}
+/**
+ * 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 {InviteUserRequestDto}
+     * @memberof InviteUsersApiInviteUser
+     */
+    readonly inviteUserRequestDto: InviteUserRequestDto;
+    /**
+     * 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 {InviteUsersRequestDto}
+     * @memberof InviteUsersApiInviteUsers
+     */
+    readonly inviteUsersRequestDto: InviteUsersRequestDto;
+    /**
+     * 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 100. Default: 10.
+     * @type {any}
+     * @memberof InviteUsersApiListInvites
+     */
+    readonly pageSize?: any;
+    /**
+     * 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&#x3D;1,     your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @type {any}
+     * @memberof InviteUsersApiListInvites
+     */
+    readonly pageToken?: any;
+    /**
+     * Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @type {any}
+     * @memberof InviteUsersApiListInvites
+     */
+    readonly filter?: any;
+    /**
+     * Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+     * @type {any}
+     * @memberof InviteUsersApiListInvites
+     */
+    readonly search?: any;
+    /**
+     * The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
+     * @type {any}
+     * @memberof InviteUsersApiListInvites
+     */
+    readonly order?: any;
+    /**
+     * Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in     addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+     * @type {any}
+     * @memberof InviteUsersApiListInvites
+     */
+    readonly expand?: any;
+}
+/**
+ * InviteUsersApi - object-oriented interface
+ * @export
+ * @class InviteUsersApi
+ * @extends {BaseAPI}
+ */
+export declare class InviteUsersApi extends BaseAPI {
+    /**
+     * Permanently deletes the invited user. Supply the unique id that was returned when you created the invited user and this will delete it.
+     * @summary Delete the invited user
+     * @param {InviteUsersApiDeleteInviteRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof InviteUsersApi
+     */
+    deleteInvite(requestParameters: InviteUsersApiDeleteInviteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
+    /**
+     * 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.
+     * @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<import("axios").AxiosResponse<BatchDeleteResponseClass, any>>;
+    /**
+     * This send an email to invite a user with the specific role/roles.
+     * @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<import("axios").AxiosResponse<InviteUserResponseClass, any>>;
+    /**
+     * This send bulk emails to invite users with the specific role/roles.
+     * @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<import("axios").AxiosResponse<InviteUsersResponseClass, any>>;
+    /**
+     * 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.
+     * @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<import("axios").AxiosResponse<ListInvitesResponseClass, any>>;
+}