@emilgroup/tenant-sdk 1.0.1 → 1.1.0

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

@@ -13,9 +13,12 @@ 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
@@ -25,43 +28,43 @@ export declare const InviteUsersApiAxiosParamCreator: (configuration?: Configura
     /**
      * 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 {string} authorization Bearer Token
      * @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: (authorization: string, id: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    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 {string} authorization Bearer Token
      * @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: (authorization: string, batchDeleteRequestDto: BatchDeleteRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    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 {string} authorization Bearer Token
      * @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: (authorization: string, inviteUserRequestDto: InviteUserRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    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 {string} authorization Bearer Token
      * @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: (authorization: string, inviteUsersRequestDto: InviteUsersRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    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
+     * @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.
@@ -71,7 +74,7 @@ export declare const InviteUsersApiAxiosParamCreator: (configuration?: Configura
      * @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>;
+    listInvites: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * InviteUsersApi - functional programming interface
@@ -81,43 +84,43 @@ 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 {string} authorization Bearer Token
      * @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(authorization: string, id: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+    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 {string} authorization Bearer Token
      * @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(authorization: string, batchDeleteRequestDto: BatchDeleteRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+    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 {string} authorization Bearer Token
      * @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(authorization: string, inviteUserRequestDto: InviteUserRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InviteUserResponseClass>>;
+    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 {string} authorization Bearer Token
      * @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(authorization: string, inviteUsersRequestDto: InviteUsersRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+    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
+     * @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.
@@ -127,7 +130,7 @@ export declare const InviteUsersApiFp: (configuration?: Configuration) => {
      * @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>>;
+    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
@@ -137,43 +140,43 @@ export declare const InviteUsersApiFactory: (configuration?: Configuration, base
     /**
      * 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 {string} authorization Bearer Token
      * @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(authorization: string, id: number, options?: any): AxiosPromise<object>;
+    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 {string} authorization Bearer Token
      * @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(authorization: string, batchDeleteRequestDto: BatchDeleteRequestDto, options?: any): AxiosPromise<object>;
+    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 {string} authorization Bearer Token
      * @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(authorization: string, inviteUserRequestDto: InviteUserRequestDto, options?: any): AxiosPromise<InviteUserResponseClass>;
+    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 {string} authorization Bearer Token
      * @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(authorization: string, inviteUsersRequestDto: InviteUsersRequestDto, options?: any): AxiosPromise<object>;
+    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
+     * @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.
@@ -183,7 +186,7 @@ export declare const InviteUsersApiFactory: (configuration?: Configuration, base
      * @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>;
+    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.
@@ -191,18 +194,18 @@ export declare const InviteUsersApiFactory: (configuration?: Configuration, base
  * @interface InviteUsersApiDeleteInviteRequest
  */
 export interface InviteUsersApiDeleteInviteRequest {
-    /**
-     * Bearer Token
-     * @type {string}
-     * @memberof InviteUsersApiDeleteInvite
-     */
-    readonly authorization: string;
     /**
      *
      * @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.
@@ -210,18 +213,18 @@ export interface InviteUsersApiDeleteInviteRequest {
  * @interface InviteUsersApiDeleteInvitesRequest
  */
 export interface InviteUsersApiDeleteInvitesRequest {
-    /**
-     * Bearer Token
-     * @type {string}
-     * @memberof InviteUsersApiDeleteInvites
-     */
-    readonly authorization: string;
     /**
      *
      * @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.
@@ -229,18 +232,18 @@ export interface InviteUsersApiDeleteInvitesRequest {
  * @interface InviteUsersApiInviteUserRequest
  */
 export interface InviteUsersApiInviteUserRequest {
-    /**
-     * Bearer Token
-     * @type {string}
-     * @memberof InviteUsersApiInviteUser
-     */
-    readonly authorization: string;
     /**
      *
      * @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.
@@ -248,18 +251,18 @@ export interface InviteUsersApiInviteUserRequest {
  * @interface InviteUsersApiInviteUsersRequest
  */
 export interface InviteUsersApiInviteUsersRequest {
-    /**
-     * Bearer Token
-     * @type {string}
-     * @memberof InviteUsersApiInviteUsers
-     */
-    readonly authorization: string;
     /**
      *
      * @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.
@@ -268,11 +271,11 @@ export interface InviteUsersApiInviteUsersRequest {
  */
 export interface InviteUsersApiListInvitesRequest {
     /**
-     * Bearer Token
+     * Bearer Token: provided by the login endpoint under the name accessToken.
      * @type {string}
      * @memberof InviteUsersApiListInvites
      */
-    readonly authorization: string;
+    readonly authorization?: string;
     /**
      * A limit on the number of objects to be returned.     Limit ranges between 1 and 100. Default: 10.
      * @type {any}
@@ -325,7 +328,7 @@ export declare class InviteUsersApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof InviteUsersApi
      */
-    deleteInvite(requestParameters: InviteUsersApiDeleteInviteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
+    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.
@@ -334,7 +337,7 @@ export declare class InviteUsersApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof InviteUsersApi
      */
-    deleteInvites(requestParameters: InviteUsersApiDeleteInvitesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
+    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
@@ -352,7 +355,7 @@ export declare class InviteUsersApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof InviteUsersApi
      */
-    inviteUsers(requestParameters: InviteUsersApiInviteUsersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
+    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
@@ -361,5 +364,5 @@ export declare class InviteUsersApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof InviteUsersApi
      */
-    listInvites(requestParameters: InviteUsersApiListInvitesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListInvitesResponseClass, any>>;
+    listInvites(requestParameters?: InviteUsersApiListInvitesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListInvitesResponseClass, any>>;
 }