@emilgroup/tenant-sdk 1.42.1-beta.35 → 1.42.1-beta.37

package/.openapi-generator/FILES

@@ -72,6 +72,7 @@ models/data-report-filter-dto.ts
 models/data-report-filter-single-value-dto.ts
 models/data-report-filter-value-dto.ts
 models/dbconfig-dto.ts
+models/delete-by-code-response-class.ts
 models/delete-response-class.ts
 models/delete-tenant-request-dto.ts
 models/disable-users-request-dto.ts
@@ -93,6 +94,7 @@ models/get-report-schedule-response-class.ts
 models/get-settings-response-class.ts
 models/get-sso-connection-response-class.ts
 models/get-sso-connection-setup-response-class.ts
+models/get-sso-idp-group-response-class.ts
 models/get-user-group-response-class.ts
 models/get-user-response-class.ts
 models/index.ts
@@ -118,6 +120,7 @@ models/list-organizations-response-class.ts
 models/list-report-schedule-logs-response-class.ts
 models/list-report-schedules-response-class.ts
 models/list-roles-response-class.ts
+models/list-sso-idp-groups-response-class.ts
 models/list-user-group-members-response-class.ts
 models/list-user-groups-response-class.ts
 models/list-users-response-class.ts

package/README.md

@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
 Navigate to the folder of your consuming project and run one of the following commands:
 
 ```
-npm install @emilgroup/tenant-sdk@1.42.1-beta.35 --save
+npm install @emilgroup/tenant-sdk@1.42.1-beta.37 --save
 ```
 or 
 ```
-yarn add @emilgroup/tenant-sdk@1.42.1-beta.35
+yarn add @emilgroup/tenant-sdk@1.42.1-beta.37
 ```
 
 And then you can import `UsersApi`.

package/api/ssoid-pgroups-api.ts

@@ -25,6 +25,12 @@ import { CreateSsoIdpGroupRequestDto } from '../models';
 // @ts-ignore
 import { CreateSsoIdpGroupResponseClass } from '../models';
 // @ts-ignore
+import { DeleteByCodeResponseClass } from '../models';
+// @ts-ignore
+import { GetSsoIdpGroupResponseClass } from '../models';
+// @ts-ignore
+import { ListSsoIdpGroupsResponseClass } from '../models';
+// @ts-ignore
 import { UpdateSsoIdpGroupBodyDto } from '../models';
 // @ts-ignore
 import { UpdateSsoIdpGroupResponseClass } from '../models';
@@ -81,6 +87,172 @@ export const SSOIdPGroupsApiAxiosParamCreator = function (configuration?: Config
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * undefined  **Required Permissions**  \"tenant-management.settings.delete\"
+         * @summary Delete an IdP group and all of its mappings
+         * @param {string} code IdP group code.
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteSsoIdpGroup: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'code' is not null or undefined
+            assertParamExists('deleteSsoIdpGroup', 'code', code)
+            const localVarPath = `/tenantservice/v1/sso-idp-groups/{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: 'DELETE', ...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);
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * undefined  **Required Permissions**  \"tenant-management.settings.view\"
+         * @summary Get an IdP group by code
+         * @param {string} code IdP group code.
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getSsoIdpGroup: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'code' is not null or undefined
+            assertParamExists('getSsoIdpGroup', 'code', code)
+            const localVarPath = `/tenantservice/v1/sso-idp-groups/{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 (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,
+            };
+        },
+        /**
+         * undefined  **Required Permissions**  \"tenant-management.settings.view\"
+         * @summary List registered IdP groups
+         * @param {string} [authorization] Bearer Token
+         * @param {number} [pageSize] Number of items per page.
+         * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
+         * @param {string} [filter] Filter IdP groups by one or more fields. Allowed: id, code, externalId, name, isActive, userGroup.code, createdAt, updatedAt.
+         * @param {string} [search] Free-text search over searchable columns.
+         * @param {string} [order] Sort the response. Allowed columns: id, code, externalId, name, isActive, createdAt, updatedAt.
+         * @param {string} [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 {string} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listSsoIdpGroups: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/tenantservice/v1/sso-idp-groups`;
+            // 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,
+            };
+        },
         /**
          * externalId is immutable. eisUserGroupCodes is set-replace when present.  **Required Permissions**  \"tenant-management.settings.update\"
          * @summary Update IdP group name and/or EIS mappings
@@ -154,6 +326,48 @@ export const SSOIdPGroupsApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.createSsoIdpGroup(createSsoIdpGroupRequestDto, authorization, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * undefined  **Required Permissions**  \"tenant-management.settings.delete\"
+         * @summary Delete an IdP group and all of its mappings
+         * @param {string} code IdP group code.
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async deleteSsoIdpGroup(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteByCodeResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSsoIdpGroup(code, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * undefined  **Required Permissions**  \"tenant-management.settings.view\"
+         * @summary Get an IdP group by code
+         * @param {string} code IdP group code.
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getSsoIdpGroup(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSsoIdpGroupResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getSsoIdpGroup(code, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * undefined  **Required Permissions**  \"tenant-management.settings.view\"
+         * @summary List registered IdP groups
+         * @param {string} [authorization] Bearer Token
+         * @param {number} [pageSize] Number of items per page.
+         * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
+         * @param {string} [filter] Filter IdP groups by one or more fields. Allowed: id, code, externalId, name, isActive, userGroup.code, createdAt, updatedAt.
+         * @param {string} [search] Free-text search over searchable columns.
+         * @param {string} [order] Sort the response. Allowed columns: id, code, externalId, name, isActive, createdAt, updatedAt.
+         * @param {string} [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 {string} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listSsoIdpGroups(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListSsoIdpGroupsResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listSsoIdpGroups(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * externalId is immutable. eisUserGroupCodes is set-replace when present.  **Required Permissions**  \"tenant-management.settings.update\"
          * @summary Update IdP group name and/or EIS mappings
@@ -188,6 +402,45 @@ export const SSOIdPGroupsApiFactory = function (configuration?: Configuration, b
         createSsoIdpGroup(createSsoIdpGroupRequestDto: CreateSsoIdpGroupRequestDto, authorization?: string, options?: any): AxiosPromise<CreateSsoIdpGroupResponseClass> {
             return localVarFp.createSsoIdpGroup(createSsoIdpGroupRequestDto, authorization, options).then((request) => request(axios, basePath));
         },
+        /**
+         * undefined  **Required Permissions**  \"tenant-management.settings.delete\"
+         * @summary Delete an IdP group and all of its mappings
+         * @param {string} code IdP group code.
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteSsoIdpGroup(code: string, authorization?: string, options?: any): AxiosPromise<DeleteByCodeResponseClass> {
+            return localVarFp.deleteSsoIdpGroup(code, authorization, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * undefined  **Required Permissions**  \"tenant-management.settings.view\"
+         * @summary Get an IdP group by code
+         * @param {string} code IdP group code.
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getSsoIdpGroup(code: string, authorization?: string, options?: any): AxiosPromise<GetSsoIdpGroupResponseClass> {
+            return localVarFp.getSsoIdpGroup(code, authorization, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * undefined  **Required Permissions**  \"tenant-management.settings.view\"
+         * @summary List registered IdP groups
+         * @param {string} [authorization] Bearer Token
+         * @param {number} [pageSize] Number of items per page.
+         * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
+         * @param {string} [filter] Filter IdP groups by one or more fields. Allowed: id, code, externalId, name, isActive, userGroup.code, createdAt, updatedAt.
+         * @param {string} [search] Free-text search over searchable columns.
+         * @param {string} [order] Sort the response. Allowed columns: id, code, externalId, name, isActive, createdAt, updatedAt.
+         * @param {string} [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 {string} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listSsoIdpGroups(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListSsoIdpGroupsResponseClass> {
+            return localVarFp.listSsoIdpGroups(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
+        },
         /**
          * externalId is immutable. eisUserGroupCodes is set-replace when present.  **Required Permissions**  \"tenant-management.settings.update\"
          * @summary Update IdP group name and/or EIS mappings
@@ -224,6 +477,111 @@ export interface SSOIdPGroupsApiCreateSsoIdpGroupRequest {
     readonly authorization?: string
 }
 
+/**
+ * Request parameters for deleteSsoIdpGroup operation in SSOIdPGroupsApi.
+ * @export
+ * @interface SSOIdPGroupsApiDeleteSsoIdpGroupRequest
+ */
+export interface SSOIdPGroupsApiDeleteSsoIdpGroupRequest {
+    /**
+     * IdP group code.
+     * @type {string}
+     * @memberof SSOIdPGroupsApiDeleteSsoIdpGroup
+     */
+    readonly code: string
+
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof SSOIdPGroupsApiDeleteSsoIdpGroup
+     */
+    readonly authorization?: string
+}
+
+/**
+ * Request parameters for getSsoIdpGroup operation in SSOIdPGroupsApi.
+ * @export
+ * @interface SSOIdPGroupsApiGetSsoIdpGroupRequest
+ */
+export interface SSOIdPGroupsApiGetSsoIdpGroupRequest {
+    /**
+     * IdP group code.
+     * @type {string}
+     * @memberof SSOIdPGroupsApiGetSsoIdpGroup
+     */
+    readonly code: string
+
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof SSOIdPGroupsApiGetSsoIdpGroup
+     */
+    readonly authorization?: string
+}
+
+/**
+ * Request parameters for listSsoIdpGroups operation in SSOIdPGroupsApi.
+ * @export
+ * @interface SSOIdPGroupsApiListSsoIdpGroupsRequest
+ */
+export interface SSOIdPGroupsApiListSsoIdpGroupsRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof SSOIdPGroupsApiListSsoIdpGroups
+     */
+    readonly authorization?: string
+
+    /**
+     * Number of items per page.
+     * @type {number}
+     * @memberof SSOIdPGroupsApiListSsoIdpGroups
+     */
+    readonly pageSize?: number
+
+    /**
+     * Opaque token for the next page (returned in a previous response).
+     * @type {string}
+     * @memberof SSOIdPGroupsApiListSsoIdpGroups
+     */
+    readonly pageToken?: string
+
+    /**
+     * Filter IdP groups by one or more fields. Allowed: id, code, externalId, name, isActive, userGroup.code, createdAt, updatedAt.
+     * @type {string}
+     * @memberof SSOIdPGroupsApiListSsoIdpGroups
+     */
+    readonly filter?: string
+
+    /**
+     * Free-text search over searchable columns.
+     * @type {string}
+     * @memberof SSOIdPGroupsApiListSsoIdpGroups
+     */
+    readonly search?: string
+
+    /**
+     * Sort the response. Allowed columns: id, code, externalId, name, isActive, createdAt, updatedAt.
+     * @type {string}
+     * @memberof SSOIdPGroupsApiListSsoIdpGroups
+     */
+    readonly order?: string
+
+    /**
+     * 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 {string}
+     * @memberof SSOIdPGroupsApiListSsoIdpGroups
+     */
+    readonly expand?: string
+
+    /**
+     * Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @type {string}
+     * @memberof SSOIdPGroupsApiListSsoIdpGroups
+     */
+    readonly filters?: string
+}
+
 /**
  * Request parameters for updateSsoIdpGroup operation in SSOIdPGroupsApi.
  * @export
@@ -271,6 +629,42 @@ export class SSOIdPGroupsApi extends BaseAPI {
         return SSOIdPGroupsApiFp(this.configuration).createSsoIdpGroup(requestParameters.createSsoIdpGroupRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.settings.delete\"
+     * @summary Delete an IdP group and all of its mappings
+     * @param {SSOIdPGroupsApiDeleteSsoIdpGroupRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SSOIdPGroupsApi
+     */
+    public deleteSsoIdpGroup(requestParameters: SSOIdPGroupsApiDeleteSsoIdpGroupRequest, options?: AxiosRequestConfig) {
+        return SSOIdPGroupsApiFp(this.configuration).deleteSsoIdpGroup(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.settings.view\"
+     * @summary Get an IdP group by code
+     * @param {SSOIdPGroupsApiGetSsoIdpGroupRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SSOIdPGroupsApi
+     */
+    public getSsoIdpGroup(requestParameters: SSOIdPGroupsApiGetSsoIdpGroupRequest, options?: AxiosRequestConfig) {
+        return SSOIdPGroupsApiFp(this.configuration).getSsoIdpGroup(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.settings.view\"
+     * @summary List registered IdP groups
+     * @param {SSOIdPGroupsApiListSsoIdpGroupsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SSOIdPGroupsApi
+     */
+    public listSsoIdpGroups(requestParameters: SSOIdPGroupsApiListSsoIdpGroupsRequest = {}, options?: AxiosRequestConfig) {
+        return SSOIdPGroupsApiFp(this.configuration).listSsoIdpGroups(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * externalId is immutable. eisUserGroupCodes is set-replace when present.  **Required Permissions**  \"tenant-management.settings.update\"
      * @summary Update IdP group name and/or EIS mappings